mirror of
https://github.com/Start9Labs/start-os.git
synced 2026-03-27 02:41:53 +00:00
Compare commits
1 Commits
fix/wifi-s
...
chore/sdk-
| Author | SHA1 | Date | |
|---|---|---|---|
|
9519684185 |
@@ -1,5 +0,0 @@
|
||||
{
|
||||
"attribution": {
|
||||
"commit": ""
|
||||
}
|
||||
}
|
||||
4
.gitignore
vendored
4
.gitignore
vendored
@@ -19,6 +19,4 @@ secrets.db
|
||||
/compiled.tar
|
||||
/compiled-*.tar
|
||||
/build/lib/firmware
|
||||
tmp
|
||||
web/.i18n-checked
|
||||
agents/USER.md
|
||||
tmp
|
||||
146
CLAUDE.md
146
CLAUDE.md
@@ -1,146 +0,0 @@
|
||||
# CLAUDE.md
|
||||
|
||||
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
||||
|
||||
## Project Overview
|
||||
|
||||
StartOS is an open-source Linux distribution for running personal servers. It manages discovery, installation, network configuration, backups, and health monitoring of self-hosted services.
|
||||
|
||||
**Tech Stack:**
|
||||
- Backend: Rust (async/Tokio, Axum web framework)
|
||||
- Frontend: Angular 20 + TypeScript + TaigaUI
|
||||
- Container runtime: Node.js/TypeScript with LXC
|
||||
- Database/State: Patch-DB (git submodule) - storage layer with reactive frontend sync
|
||||
- API: JSON-RPC via rpc-toolkit (see `agents/rpc-toolkit.md`)
|
||||
- Auth: Password + session cookie, public/private key signatures, local authcookie (see `core/src/middleware/auth/`)
|
||||
|
||||
## Build & Development
|
||||
|
||||
See [CONTRIBUTING.md](CONTRIBUTING.md) for:
|
||||
- Environment setup and requirements
|
||||
- Build commands and make targets
|
||||
- Testing and formatting commands
|
||||
- Environment variables
|
||||
|
||||
**Quick reference:**
|
||||
```bash
|
||||
. ./devmode.sh # Enable dev mode
|
||||
make update-startbox REMOTE=start9@<ip> # Fastest iteration (binary + UI)
|
||||
make test-core # Run Rust tests
|
||||
```
|
||||
|
||||
## Architecture
|
||||
|
||||
### Core (`/core`)
|
||||
The Rust backend daemon. Main binaries:
|
||||
- `startbox` - Main daemon (runs as `startd`)
|
||||
- `start-cli` - CLI interface
|
||||
- `start-container` - Runs inside LXC containers; communicates with host and manages subcontainers
|
||||
- `registrybox` - Registry daemon
|
||||
- `tunnelbox` - VPN/tunnel daemon
|
||||
|
||||
**Key modules:**
|
||||
- `src/context/` - Context types (RpcContext, CliContext, InitContext, DiagnosticContext)
|
||||
- `src/service/` - Service lifecycle management with actor pattern (`service_actor.rs`)
|
||||
- `src/db/model/` - Patch-DB models (`public.rs` synced to frontend, `private.rs` backend-only)
|
||||
- `src/net/` - Networking (DNS, ACME, WiFi, Tor via Arti, WireGuard)
|
||||
- `src/s9pk/` - S9PK package format (merkle archive)
|
||||
- `src/registry/` - Package registry management
|
||||
|
||||
**RPC Pattern:** See `agents/rpc-toolkit.md`
|
||||
|
||||
### Web (`/web`)
|
||||
Angular projects sharing common code:
|
||||
- `projects/ui/` - Main admin interface
|
||||
- `projects/setup-wizard/` - Initial setup
|
||||
- `projects/start-tunnel/` - VPN management UI
|
||||
- `projects/shared/` - Common library (API clients, components)
|
||||
- `projects/marketplace/` - Service discovery
|
||||
|
||||
**Development:**
|
||||
```bash
|
||||
cd web
|
||||
npm ci
|
||||
npm run start:ui # Dev server with mocks
|
||||
npm run build:ui # Production build
|
||||
npm run check # Type check all projects
|
||||
```
|
||||
|
||||
### Container Runtime (`/container-runtime`)
|
||||
Node.js runtime that manages service containers via RPC. See `RPCSpec.md` for protocol.
|
||||
|
||||
**Container Architecture:**
|
||||
```
|
||||
LXC Container (uniform base for all services)
|
||||
└── systemd
|
||||
└── container-runtime.service
|
||||
└── Loads /usr/lib/startos/package/index.js (from s9pk javascript.squashfs)
|
||||
└── Package JS launches subcontainers (from images in s9pk)
|
||||
```
|
||||
|
||||
The container runtime communicates with the host via JSON-RPC over Unix socket. Package JavaScript must export functions conforming to the `ABI` type defined in `sdk/base/lib/types.ts`.
|
||||
|
||||
**`/media/startos/` directory (mounted by host into container):**
|
||||
|
||||
| Path | Description |
|
||||
|------|-------------|
|
||||
| `volumes/<name>/` | Package data volumes (id-mapped, persistent) |
|
||||
| `assets/` | Read-only assets from s9pk `assets.squashfs` |
|
||||
| `images/<name>/` | Container images (squashfs, used for subcontainers) |
|
||||
| `images/<name>.env` | Environment variables for image |
|
||||
| `images/<name>.json` | Image metadata |
|
||||
| `backup/` | Backup mount point (mounted during backup operations) |
|
||||
| `rpc/service.sock` | RPC socket (container runtime listens here) |
|
||||
| `rpc/host.sock` | Host RPC socket (for effects callbacks to host) |
|
||||
|
||||
**S9PK Structure:** See `agents/s9pk-structure.md`
|
||||
|
||||
### SDK (`/sdk`)
|
||||
TypeScript SDK for packaging services (`@start9labs/start-sdk`).
|
||||
|
||||
- `base/` - Core types, ABI definitions, effects interface (`@start9labs/start-sdk-base`)
|
||||
- `package/` - Full SDK for package developers, re-exports base
|
||||
|
||||
### Patch-DB (`/patch-db`)
|
||||
Git submodule providing diff-based state synchronization. Changes to `db/model/public.rs` automatically sync to the frontend.
|
||||
|
||||
**Key patterns:**
|
||||
- `db.peek().await` - Get a read-only snapshot of the database state
|
||||
- `db.mutate(|db| { ... }).await` - Apply mutations atomically, returns `MutateResult`
|
||||
- `#[derive(HasModel)]` - Derive macro for types stored in the database, generates typed accessors
|
||||
|
||||
**Generated accessor types** (from `HasModel` derive):
|
||||
- `as_field()` - Immutable reference: `&Model<T>`
|
||||
- `as_field_mut()` - Mutable reference: `&mut Model<T>`
|
||||
- `into_field()` - Owned value: `Model<T>`
|
||||
|
||||
**`Model<T>` APIs** (from `db/prelude.rs`):
|
||||
- `.de()` - Deserialize to `T`
|
||||
- `.ser(&value)` - Serialize from `T`
|
||||
- `.mutate(|v| ...)` - Deserialize, mutate, reserialize
|
||||
- For maps: `.keys()`, `.as_idx(&key)`, `.as_idx_mut(&key)`, `.insert()`, `.remove()`, `.contains_key()`
|
||||
|
||||
## Supplementary Documentation
|
||||
|
||||
The `agents/` directory contains detailed documentation for AI assistants:
|
||||
|
||||
- `TODO.md` - Pending tasks for AI agents (check this first, remove items when completed)
|
||||
- `USER.md` - Current user identifier (gitignored, see below)
|
||||
- `rpc-toolkit.md` - JSON-RPC patterns and handler configuration
|
||||
- `core-rust-patterns.md` - Common utilities and patterns for Rust code in `/core` (guard pattern, mount guards, etc.)
|
||||
- `s9pk-structure.md` - S9PK package format structure
|
||||
- `i18n-patterns.md` - Internationalization key conventions and usage in `/core`
|
||||
|
||||
### Session Startup
|
||||
|
||||
On startup:
|
||||
|
||||
1. **Check for `agents/USER.md`** - If it doesn't exist, prompt the user for their name/identifier and create it. This file is gitignored since it varies per developer.
|
||||
|
||||
2. **Check `agents/TODO.md` for relevant tasks** - Show TODOs that either:
|
||||
- Have no `@username` tag (relevant to everyone)
|
||||
- Are tagged with the current user's identifier
|
||||
|
||||
Skip TODOs tagged with a different user.
|
||||
|
||||
3. **Ask "What would you like to do today?"** - Offer options for each relevant TODO item, plus "Something else" for other requests.
|
||||
259
CONTRIBUTING.md
259
CONTRIBUTING.md
@@ -11,190 +11,123 @@ This guide is for contributing to the StartOS. If you are interested in packagin
|
||||
|
||||
```bash
|
||||
/
|
||||
├── assets/ # Screenshots for README
|
||||
├── build/ # Auxiliary files and scripts for deployed images
|
||||
├── container-runtime/ # Node.js program managing package containers
|
||||
├── core/ # Rust backend: API, daemon (startd), CLI (start-cli)
|
||||
├── debian/ # Debian package maintainer scripts
|
||||
├── image-recipe/ # Scripts for building StartOS images
|
||||
├── patch-db/ # (submodule) Diff-based data store for frontend sync
|
||||
├── sdk/ # TypeScript SDK for building StartOS packages
|
||||
└── web/ # Web UIs (Angular)
|
||||
├── assets/
|
||||
├── container-runtime/
|
||||
├── core/
|
||||
├── build/
|
||||
├── debian/
|
||||
├── web/
|
||||
├── image-recipe/
|
||||
├── patch-db
|
||||
└── sdk/
|
||||
```
|
||||
|
||||
See component READMEs for details:
|
||||
- [`core`](core/README.md)
|
||||
- [`web`](web/README.md)
|
||||
- [`build`](build/README.md)
|
||||
- [`patch-db`](https://github.com/Start9Labs/patch-db)
|
||||
#### assets
|
||||
|
||||
screenshots for the StartOS README
|
||||
|
||||
#### container-runtime
|
||||
|
||||
A NodeJS program that dynamically loads maintainer scripts and communicates with the OS to manage packages
|
||||
|
||||
#### core
|
||||
|
||||
An API, daemon (startd), and CLI (start-cli) that together provide the core functionality of StartOS.
|
||||
|
||||
#### build
|
||||
|
||||
Auxiliary files and scripts to include in deployed StartOS images
|
||||
|
||||
#### debian
|
||||
|
||||
Maintainer scripts for the StartOS Debian package
|
||||
|
||||
#### web
|
||||
|
||||
Web UIs served under various conditions and used to interact with StartOS APIs.
|
||||
|
||||
#### image-recipe
|
||||
|
||||
Scripts for building StartOS images
|
||||
|
||||
#### patch-db (submodule)
|
||||
|
||||
A diff based data store used to synchronize data between the web interfaces and server.
|
||||
|
||||
#### sdk
|
||||
|
||||
A typescript sdk for building start-os packages
|
||||
|
||||
## Environment Setup
|
||||
|
||||
#### Clone the StartOS repository
|
||||
|
||||
```sh
|
||||
git clone https://github.com/Start9Labs/start-os.git --recurse-submodules
|
||||
cd start-os
|
||||
```
|
||||
|
||||
### Development Mode
|
||||
#### Continue to your project of interest for additional instructions:
|
||||
|
||||
For faster iteration during development:
|
||||
|
||||
```sh
|
||||
. ./devmode.sh
|
||||
```
|
||||
|
||||
This sets `ENVIRONMENT=dev` and `GIT_BRANCH_AS_HASH=1` to prevent rebuilds on every commit.
|
||||
- [`core`](core/README.md)
|
||||
- [`web-interfaces`](web-interfaces/README.md)
|
||||
- [`build`](build/README.md)
|
||||
- [`patch-db`](https://github.com/Start9Labs/patch-db)
|
||||
|
||||
## Building
|
||||
|
||||
All builds can be performed on any operating system that can run Docker.
|
||||
|
||||
This project uses [GNU Make](https://www.gnu.org/software/make/) to build its components.
|
||||
This project uses [GNU Make](https://www.gnu.org/software/make/) to build its components. To build any specific component, simply run `make <TARGET>` replacing `<TARGET>` with the name of the target you'd like to build
|
||||
|
||||
### Requirements
|
||||
|
||||
- [GNU Make](https://www.gnu.org/software/make/)
|
||||
- [Docker](https://docs.docker.com/get-docker/) or [Podman](https://podman.io/)
|
||||
- [Docker](https://docs.docker.com/get-docker/)
|
||||
- [NodeJS v20.16.0](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
|
||||
- [Rust](https://rustup.rs/) (nightly for formatting)
|
||||
- [sed](https://www.gnu.org/software/sed/), [grep](https://www.gnu.org/software/grep/), [awk](https://www.gnu.org/software/gawk/)
|
||||
- [sed](https://www.gnu.org/software/sed/)
|
||||
- [grep](https://www.gnu.org/software/grep/)
|
||||
- [awk](https://www.gnu.org/software/gawk/)
|
||||
- [jq](https://jqlang.github.io/jq/)
|
||||
- [gzip](https://www.gnu.org/software/gzip/), [brotli](https://github.com/google/brotli)
|
||||
- [gzip](https://www.gnu.org/software/gzip/)
|
||||
- [brotli](https://github.com/google/brotli)
|
||||
|
||||
### Environment Variables
|
||||
### Environment variables
|
||||
|
||||
| Variable | Description |
|
||||
|----------|-------------|
|
||||
| `PLATFORM` | Target platform: `x86_64`, `x86_64-nonfree`, `aarch64`, `aarch64-nonfree`, `riscv64`, `raspberrypi` |
|
||||
| `ENVIRONMENT` | Hyphen-separated feature flags (see below) |
|
||||
| `PROFILE` | Build profile: `release` (default) or `dev` |
|
||||
| `GIT_BRANCH_AS_HASH` | Set to `1` to use git branch name as version hash (avoids rebuilds) |
|
||||
- `PLATFORM`: which platform you would like to build for. Must be one of `x86_64`, `x86_64-nonfree`, `aarch64`, `aarch64-nonfree`, `raspberrypi`
|
||||
- NOTE: `nonfree` images are for including `nonfree` firmware packages in the built ISO
|
||||
- `ENVIRONMENT`: a hyphen separated set of feature flags to enable
|
||||
- `dev`: enables password ssh (INSECURE!) and does not compress frontends
|
||||
- `unstable`: enables assertions that will cause errors on unexpected inconsistencies that are undesirable in production use either for performance or reliability reasons
|
||||
- `docker`: use `docker` instead of `podman`
|
||||
- `GIT_BRANCH_AS_HASH`: set to `1` to use the current git branch name as the git hash so that the project does not need to be rebuilt on each commit
|
||||
|
||||
**ENVIRONMENT flags:**
|
||||
- `dev` - Enables password SSH before setup, skips frontend compression
|
||||
- `unstable` - Enables assertions and debugging with performance penalty
|
||||
- `console` - Enables tokio-console for async debugging
|
||||
|
||||
**Platform notes:**
|
||||
- `-nonfree` variants include proprietary firmware and drivers
|
||||
- `raspberrypi` includes non-free components by necessity
|
||||
- Platform is remembered between builds if not specified
|
||||
|
||||
### Make Targets
|
||||
|
||||
#### Building
|
||||
|
||||
| Target | Description |
|
||||
|--------|-------------|
|
||||
| `iso` | Create full `.iso` image (not for raspberrypi) |
|
||||
| `img` | Create full `.img` image (raspberrypi only) |
|
||||
| `deb` | Build Debian package |
|
||||
| `all` | Build all Rust binaries |
|
||||
| `uis` | Build all web UIs |
|
||||
| `ui` | Build main UI only |
|
||||
| `ts-bindings` | Generate TypeScript bindings from Rust types |
|
||||
|
||||
#### Deploying to Device
|
||||
|
||||
For devices on the same network:
|
||||
|
||||
| Target | Description |
|
||||
|--------|-------------|
|
||||
| `update-startbox REMOTE=start9@<ip>` | Deploy binary + UI only (fastest) |
|
||||
| `update-deb REMOTE=start9@<ip>` | Deploy full Debian package |
|
||||
| `update REMOTE=start9@<ip>` | OTA-style update |
|
||||
| `reflash REMOTE=start9@<ip>` | Reflash as if using live ISO |
|
||||
| `update-overlay REMOTE=start9@<ip>` | Deploy to in-memory overlay (reverts on reboot) |
|
||||
|
||||
For devices on different networks (uses [magic-wormhole](https://github.com/magic-wormhole/magic-wormhole)):
|
||||
|
||||
| Target | Description |
|
||||
|--------|-------------|
|
||||
| `wormhole` | Send startbox binary |
|
||||
| `wormhole-deb` | Send Debian package |
|
||||
| `wormhole-squashfs` | Send squashfs image |
|
||||
|
||||
#### Other
|
||||
|
||||
| Target | Description |
|
||||
|--------|-------------|
|
||||
| `format` | Run code formatting (Rust nightly required) |
|
||||
| `test` | Run all automated tests |
|
||||
| `test-core` | Run Rust tests |
|
||||
| `test-sdk` | Run SDK tests |
|
||||
| `test-container-runtime` | Run container runtime tests |
|
||||
| `clean` | Delete all compiled artifacts |
|
||||
|
||||
## Testing
|
||||
|
||||
```bash
|
||||
make test # All tests
|
||||
make test-core # Rust tests (via ./core/run-tests.sh)
|
||||
make test-sdk # SDK tests
|
||||
make test-container-runtime # Container runtime tests
|
||||
|
||||
# Run specific Rust test
|
||||
cd core && cargo test <test_name> --features=test
|
||||
```
|
||||
|
||||
## Code Formatting
|
||||
|
||||
```bash
|
||||
# Rust (requires nightly)
|
||||
make format
|
||||
|
||||
# TypeScript/HTML/SCSS (web)
|
||||
cd web && npm run format
|
||||
```
|
||||
|
||||
## Code Style Guidelines
|
||||
|
||||
### Formatting
|
||||
|
||||
Run the formatters before committing. Configuration is handled by `rustfmt.toml` (Rust) and prettier configs (TypeScript).
|
||||
|
||||
### Documentation & Comments
|
||||
|
||||
**Rust:**
|
||||
- Add doc comments (`///`) to public APIs, structs, and non-obvious functions
|
||||
- Use `//` comments sparingly for complex logic that isn't self-evident
|
||||
- Prefer self-documenting code (clear naming, small functions) over comments
|
||||
|
||||
**TypeScript:**
|
||||
- Document exported functions and complex types with JSDoc
|
||||
- Keep comments focused on "why" rather than "what"
|
||||
|
||||
**General:**
|
||||
- Don't add comments that just restate the code
|
||||
- Update or remove comments when code changes
|
||||
- TODOs should include context: `// TODO(username): reason`
|
||||
|
||||
### Commit Messages
|
||||
|
||||
Use [Conventional Commits](https://www.conventionalcommits.org/):
|
||||
|
||||
```
|
||||
<type>(<scope>): <description>
|
||||
|
||||
[optional body]
|
||||
|
||||
[optional footer]
|
||||
```
|
||||
|
||||
**Types:**
|
||||
- `feat` - New feature
|
||||
- `fix` - Bug fix
|
||||
- `docs` - Documentation only
|
||||
- `style` - Formatting, no code change
|
||||
- `refactor` - Code change that neither fixes a bug nor adds a feature
|
||||
- `test` - Adding or updating tests
|
||||
- `chore` - Build process, dependencies, etc.
|
||||
|
||||
**Examples:**
|
||||
```
|
||||
feat(web): add dark mode toggle
|
||||
fix(core): resolve race condition in service startup
|
||||
docs: update CONTRIBUTING.md with style guidelines
|
||||
refactor(sdk): simplify package validation logic
|
||||
```
|
||||
### Useful Make Targets
|
||||
|
||||
- `iso`: Create a full `.iso` image
|
||||
- Only possible from Debian
|
||||
- Not available for `PLATFORM=raspberrypi`
|
||||
- Additional Requirements:
|
||||
- [debspawn](https://github.com/lkhq/debspawn)
|
||||
- `img`: Create a full `.img` image
|
||||
- Only possible from Debian
|
||||
- Only available for `PLATFORM=raspberrypi`
|
||||
- Additional Requirements:
|
||||
- [debspawn](https://github.com/lkhq/debspawn)
|
||||
- `format`: Run automatic code formatting for the project
|
||||
- Additional Requirements:
|
||||
- [rust](https://rustup.rs/)
|
||||
- `test`: Run automated tests for the project
|
||||
- Additional Requirements:
|
||||
- [rust](https://rustup.rs/)
|
||||
- `update`: Deploy the current working project to a device over ssh as if through an over-the-air update
|
||||
- Requires an argument `REMOTE` which is the ssh address of the device, i.e. `start9@192.168.122.2`
|
||||
- `reflash`: Deploy the current working project to a device over ssh as if using a live `iso` image to reflash it
|
||||
- Requires an argument `REMOTE` which is the ssh address of the device, i.e. `start9@192.168.122.2`
|
||||
- `update-overlay`: Deploy the current working project to a device over ssh to the in-memory overlay without restarting it
|
||||
- WARNING: changes will be reverted after the device is rebooted
|
||||
- WARNING: changes to `init` will not take effect as the device is already initialized
|
||||
- Requires an argument `REMOTE` which is the ssh address of the device, i.e. `start9@192.168.122.2`
|
||||
- `wormhole`: Deploy the `startbox` to a device using [magic-wormhole](https://github.com/magic-wormhole/magic-wormhole)
|
||||
- When the build it complete will emit a command to paste into the shell of the device to upgrade it
|
||||
- Additional Requirements:
|
||||
- [magic-wormhole](https://github.com/magic-wormhole/magic-wormhole)
|
||||
- `clean`: Delete all compiled artifacts
|
||||
|
||||
@@ -1,9 +0,0 @@
|
||||
# AI Agent TODOs
|
||||
|
||||
Pending tasks for AI agents. Remove items when completed.
|
||||
|
||||
## Unreviewed CLAUDE.md Sections
|
||||
|
||||
- [ ] Architecture - Web (`/web`) - @MattDHill
|
||||
|
||||
|
||||
@@ -1,249 +0,0 @@
|
||||
# Utilities & Patterns
|
||||
|
||||
This document covers common utilities and patterns used throughout the StartOS codebase.
|
||||
|
||||
## Util Module (`core/src/util/`)
|
||||
|
||||
The `util` module contains reusable utilities. Key submodules:
|
||||
|
||||
| Module | Purpose |
|
||||
|--------|---------|
|
||||
| `actor/` | Actor pattern implementation for concurrent state management |
|
||||
| `collections/` | Custom collection types |
|
||||
| `crypto.rs` | Cryptographic utilities (encryption, hashing) |
|
||||
| `future.rs` | Future/async utilities |
|
||||
| `io.rs` | File I/O helpers (create_file, canonicalize, etc.) |
|
||||
| `iter.rs` | Iterator extensions |
|
||||
| `net.rs` | Network utilities |
|
||||
| `rpc.rs` | RPC helpers |
|
||||
| `rpc_client.rs` | RPC client utilities |
|
||||
| `serde.rs` | Serialization helpers (Base64, display/fromstr, etc.) |
|
||||
| `sync.rs` | Synchronization primitives (SyncMutex, etc.) |
|
||||
|
||||
## Command Invocation (`Invoke` trait)
|
||||
|
||||
The `Invoke` trait provides a clean way to run external commands with error handling:
|
||||
|
||||
```rust
|
||||
use crate::util::Invoke;
|
||||
|
||||
// Simple invocation
|
||||
tokio::process::Command::new("ls")
|
||||
.arg("-la")
|
||||
.invoke(ErrorKind::Filesystem)
|
||||
.await?;
|
||||
|
||||
// With timeout
|
||||
tokio::process::Command::new("slow-command")
|
||||
.timeout(Some(Duration::from_secs(30)))
|
||||
.invoke(ErrorKind::Timeout)
|
||||
.await?;
|
||||
|
||||
// With input
|
||||
let mut input = Cursor::new(b"input data");
|
||||
tokio::process::Command::new("cat")
|
||||
.input(Some(&mut input))
|
||||
.invoke(ErrorKind::Filesystem)
|
||||
.await?;
|
||||
|
||||
// Piped commands
|
||||
tokio::process::Command::new("cat")
|
||||
.arg("file.txt")
|
||||
.pipe(&mut tokio::process::Command::new("grep").arg("pattern"))
|
||||
.invoke(ErrorKind::Filesystem)
|
||||
.await?;
|
||||
```
|
||||
|
||||
## Guard Pattern
|
||||
|
||||
Guards ensure cleanup happens when they go out of scope.
|
||||
|
||||
### `GeneralGuard` / `GeneralBoxedGuard`
|
||||
|
||||
For arbitrary cleanup actions:
|
||||
|
||||
```rust
|
||||
use crate::util::GeneralGuard;
|
||||
|
||||
let guard = GeneralGuard::new(|| {
|
||||
println!("Cleanup runs on drop");
|
||||
});
|
||||
|
||||
// Do work...
|
||||
|
||||
// Explicit drop with action
|
||||
guard.drop();
|
||||
|
||||
// Or skip the action
|
||||
// guard.drop_without_action();
|
||||
```
|
||||
|
||||
### `FileLock`
|
||||
|
||||
File-based locking with automatic unlock:
|
||||
|
||||
```rust
|
||||
use crate::util::FileLock;
|
||||
|
||||
let lock = FileLock::new("/path/to/lockfile", true).await?; // blocking=true
|
||||
// Lock held until dropped or explicitly unlocked
|
||||
lock.unlock().await?;
|
||||
```
|
||||
|
||||
## Mount Guard Pattern (`core/src/disk/mount/guard.rs`)
|
||||
|
||||
RAII guards for filesystem mounts. Ensures filesystems are unmounted when guards are dropped.
|
||||
|
||||
### `MountGuard`
|
||||
|
||||
Basic mount guard:
|
||||
|
||||
```rust
|
||||
use crate::disk::mount::guard::MountGuard;
|
||||
use crate::disk::mount::filesystem::{MountType, ReadOnly};
|
||||
|
||||
let guard = MountGuard::mount(&filesystem, "/mnt/target", ReadOnly).await?;
|
||||
|
||||
// Use the mounted filesystem at guard.path()
|
||||
do_something(guard.path()).await?;
|
||||
|
||||
// Explicit unmount (or auto-unmounts on drop)
|
||||
guard.unmount(false).await?; // false = don't delete mountpoint
|
||||
```
|
||||
|
||||
### `TmpMountGuard`
|
||||
|
||||
Reference-counted temporary mount (mounts to `/media/startos/tmp/`):
|
||||
|
||||
```rust
|
||||
use crate::disk::mount::guard::TmpMountGuard;
|
||||
use crate::disk::mount::filesystem::ReadOnly;
|
||||
|
||||
// Multiple clones share the same mount
|
||||
let guard1 = TmpMountGuard::mount(&filesystem, ReadOnly).await?;
|
||||
let guard2 = guard1.clone();
|
||||
|
||||
// Mount stays alive while any guard exists
|
||||
// Auto-unmounts when last guard is dropped
|
||||
```
|
||||
|
||||
### `GenericMountGuard` trait
|
||||
|
||||
All mount guards implement this trait:
|
||||
|
||||
```rust
|
||||
pub trait GenericMountGuard: std::fmt::Debug + Send + Sync + 'static {
|
||||
fn path(&self) -> &Path;
|
||||
fn unmount(self) -> impl Future<Output = Result<(), Error>> + Send;
|
||||
}
|
||||
```
|
||||
|
||||
### `SubPath`
|
||||
|
||||
Wraps a mount guard to point to a subdirectory:
|
||||
|
||||
```rust
|
||||
use crate::disk::mount::guard::SubPath;
|
||||
|
||||
let mount = TmpMountGuard::mount(&filesystem, ReadOnly).await?;
|
||||
let subdir = SubPath::new(mount, "data/subdir");
|
||||
|
||||
// subdir.path() returns the full path including subdirectory
|
||||
```
|
||||
|
||||
## FileSystem Implementations (`core/src/disk/mount/filesystem/`)
|
||||
|
||||
Various filesystem types that can be mounted:
|
||||
|
||||
| Type | Description |
|
||||
|------|-------------|
|
||||
| `bind.rs` | Bind mounts |
|
||||
| `block_dev.rs` | Block device mounts |
|
||||
| `cifs.rs` | CIFS/SMB network shares |
|
||||
| `ecryptfs.rs` | Encrypted filesystem |
|
||||
| `efivarfs.rs` | EFI variables |
|
||||
| `httpdirfs.rs` | HTTP directory as filesystem |
|
||||
| `idmapped.rs` | ID-mapped mounts |
|
||||
| `label.rs` | Mount by label |
|
||||
| `loop_dev.rs` | Loop device mounts |
|
||||
| `overlayfs.rs` | Overlay filesystem |
|
||||
|
||||
## Other Useful Utilities
|
||||
|
||||
### `Apply` / `ApplyRef` traits
|
||||
|
||||
Fluent method chaining:
|
||||
|
||||
```rust
|
||||
use crate::util::Apply;
|
||||
|
||||
let result = some_value
|
||||
.apply(|v| transform(v))
|
||||
.apply(|v| another_transform(v));
|
||||
```
|
||||
|
||||
### `Container<T>`
|
||||
|
||||
Async-safe optional container:
|
||||
|
||||
```rust
|
||||
use crate::util::Container;
|
||||
|
||||
let container = Container::new(None);
|
||||
container.set(value).await;
|
||||
let taken = container.take().await;
|
||||
```
|
||||
|
||||
### `HashWriter<H, W>`
|
||||
|
||||
Write data while computing hash:
|
||||
|
||||
```rust
|
||||
use crate::util::HashWriter;
|
||||
use sha2::Sha256;
|
||||
|
||||
let writer = HashWriter::new(Sha256::new(), file);
|
||||
// Write data...
|
||||
let (hasher, file) = writer.finish();
|
||||
let hash = hasher.finalize();
|
||||
```
|
||||
|
||||
### `Never` type
|
||||
|
||||
Uninhabited type for impossible cases:
|
||||
|
||||
```rust
|
||||
use crate::util::Never;
|
||||
|
||||
fn impossible() -> Never {
|
||||
// This function can never return
|
||||
}
|
||||
|
||||
let never: Never = impossible();
|
||||
never.absurd::<String>() // Can convert to any type
|
||||
```
|
||||
|
||||
### `MaybeOwned<'a, T>`
|
||||
|
||||
Either borrowed or owned data:
|
||||
|
||||
```rust
|
||||
use crate::util::MaybeOwned;
|
||||
|
||||
fn accept_either(data: MaybeOwned<'_, String>) {
|
||||
// Use &*data to access the value
|
||||
}
|
||||
|
||||
accept_either(MaybeOwned::from(&existing_string));
|
||||
accept_either(MaybeOwned::from(owned_string));
|
||||
```
|
||||
|
||||
### `new_guid()`
|
||||
|
||||
Generate a random GUID:
|
||||
|
||||
```rust
|
||||
use crate::util::new_guid;
|
||||
|
||||
let guid = new_guid(); // Returns InternedString
|
||||
```
|
||||
301
agents/exver.md
301
agents/exver.md
@@ -1,301 +0,0 @@
|
||||
# exver — Extended Versioning
|
||||
|
||||
Extended semver supporting **downstream versioning** (wrapper updates independent of upstream) and **flavors** (package fork variants).
|
||||
|
||||
Two implementations exist:
|
||||
- **Rust crate** (`exver`) — used in `core/`. Source: https://github.com/Start9Labs/exver-rs
|
||||
- **TypeScript** (`sdk/base/lib/exver/index.ts`) — used in `sdk/` and `web/`
|
||||
|
||||
Both parse the same string format and agree on `satisfies` semantics.
|
||||
|
||||
## Version Format
|
||||
|
||||
An **ExtendedVersion** string looks like:
|
||||
|
||||
```
|
||||
[#flavor:]upstream:downstream
|
||||
```
|
||||
|
||||
- **upstream** — the original package version (semver-style: `1.2.3`, `1.2.3-beta.1`)
|
||||
- **downstream** — the StartOS wrapper version (incremented independently)
|
||||
- **flavor** — optional lowercase ASCII prefix for fork variants
|
||||
|
||||
Examples:
|
||||
- `1.2.3:0` — upstream 1.2.3, first downstream release
|
||||
- `1.2.3:2` — upstream 1.2.3, third downstream release
|
||||
- `#bitcoin:21.0:1` — bitcoin flavor, upstream 21.0, downstream 1
|
||||
- `1.0.0-rc.1:0` — upstream with prerelease tag
|
||||
|
||||
## Core Types
|
||||
|
||||
### `Version`
|
||||
|
||||
A semver-style version with arbitrary digit segments and optional prerelease.
|
||||
|
||||
**Rust:**
|
||||
```rust
|
||||
use exver::Version;
|
||||
|
||||
let v = Version::new([1, 2, 3], []); // 1.2.3
|
||||
let v = Version::new([1, 0], ["beta".into()]); // 1.0-beta
|
||||
let v: Version = "1.2.3".parse().unwrap();
|
||||
|
||||
v.number() // &[1, 2, 3]
|
||||
v.prerelease() // &[]
|
||||
```
|
||||
|
||||
**TypeScript:**
|
||||
```typescript
|
||||
const v = new Version([1, 2, 3], [])
|
||||
const v = Version.parse("1.2.3")
|
||||
|
||||
v.number // number[]
|
||||
v.prerelease // (string | number)[]
|
||||
v.compare(other) // 'greater' | 'equal' | 'less'
|
||||
v.compareForSort(other) // -1 | 0 | 1
|
||||
```
|
||||
|
||||
Default: `0`
|
||||
|
||||
### `ExtendedVersion`
|
||||
|
||||
The primary version type. Wraps upstream + downstream `Version` plus an optional flavor.
|
||||
|
||||
**Rust:**
|
||||
```rust
|
||||
use exver::ExtendedVersion;
|
||||
|
||||
let ev = ExtendedVersion::new(
|
||||
Version::new([1, 2, 3], []),
|
||||
Version::default(), // downstream = 0
|
||||
);
|
||||
let ev: ExtendedVersion = "1.2.3:0".parse().unwrap();
|
||||
|
||||
ev.flavor() // Option<&str>
|
||||
ev.upstream() // &Version
|
||||
ev.downstream() // &Version
|
||||
|
||||
// Builder methods (consuming):
|
||||
ev.with_flavor("bitcoin")
|
||||
ev.without_flavor()
|
||||
ev.map_upstream(|v| ...)
|
||||
ev.map_downstream(|v| ...)
|
||||
```
|
||||
|
||||
**TypeScript:**
|
||||
```typescript
|
||||
const ev = new ExtendedVersion(null, upstream, downstream)
|
||||
const ev = ExtendedVersion.parse("1.2.3:0")
|
||||
const ev = ExtendedVersion.parseEmver("1.2.3.4") // emver compat
|
||||
|
||||
ev.flavor // string | null
|
||||
ev.upstream // Version
|
||||
ev.downstream // Version
|
||||
|
||||
ev.compare(other) // 'greater' | 'equal' | 'less' | null
|
||||
ev.equals(other) // boolean
|
||||
ev.greaterThan(other) // boolean
|
||||
ev.lessThan(other) // boolean
|
||||
ev.incrementMajor() // new ExtendedVersion
|
||||
ev.incrementMinor() // new ExtendedVersion
|
||||
```
|
||||
|
||||
**Ordering:** Versions with different flavors are **not comparable** (`PartialOrd`/`compare` returns `None`/`null`).
|
||||
|
||||
Default: `0:0`
|
||||
|
||||
### `VersionString` (Rust only, StartOS wrapper)
|
||||
|
||||
Defined in `core/src/util/version.rs`. Caches the original string representation alongside the parsed `ExtendedVersion`. Used as the key type in registry version maps.
|
||||
|
||||
```rust
|
||||
use crate::util::VersionString;
|
||||
|
||||
let vs: VersionString = "1.2.3:0".parse().unwrap();
|
||||
let vs = VersionString::from(extended_version);
|
||||
|
||||
// Deref to ExtendedVersion:
|
||||
vs.satisfies(&range);
|
||||
vs.upstream();
|
||||
|
||||
// String access:
|
||||
vs.as_str(); // &str
|
||||
AsRef::<str>::as_ref(&vs);
|
||||
```
|
||||
|
||||
`Ord` is implemented with a total ordering — versions with different flavors are ordered by flavor name (unflavored sorts last).
|
||||
|
||||
### `VersionRange`
|
||||
|
||||
A predicate over `ExtendedVersion`. Supports comparison operators, boolean logic, and flavor constraints.
|
||||
|
||||
**Rust:**
|
||||
```rust
|
||||
use exver::VersionRange;
|
||||
|
||||
// Constructors:
|
||||
VersionRange::any() // matches everything
|
||||
VersionRange::none() // matches nothing
|
||||
VersionRange::exactly(ev) // = ev
|
||||
VersionRange::anchor(GTE, ev) // >= ev
|
||||
VersionRange::caret(ev) // ^ev (compatible changes)
|
||||
VersionRange::tilde(ev) // ~ev (patch-level changes)
|
||||
|
||||
// Combinators (smart — eagerly simplify):
|
||||
VersionRange::and(a, b) // a && b
|
||||
VersionRange::or(a, b) // a || b
|
||||
VersionRange::not(a) // !a
|
||||
|
||||
// Parsing:
|
||||
let r: VersionRange = ">=1.0.0:0".parse().unwrap();
|
||||
let r: VersionRange = "^1.2.3:0".parse().unwrap();
|
||||
let r: VersionRange = ">=1.0.0 <2.0.0".parse().unwrap(); // implicit AND
|
||||
let r: VersionRange = ">=1.0.0 || >=2.0.0".parse().unwrap();
|
||||
let r: VersionRange = "#bitcoin".parse().unwrap(); // flavor match
|
||||
let r: VersionRange = "*".parse().unwrap(); // any
|
||||
|
||||
// Monoid wrappers for folding:
|
||||
AnyRange // fold with or, empty = None
|
||||
AllRange // fold with and, empty = Any
|
||||
```
|
||||
|
||||
**TypeScript:**
|
||||
```typescript
|
||||
// Constructors:
|
||||
VersionRange.any()
|
||||
VersionRange.none()
|
||||
VersionRange.anchor('=', ev)
|
||||
VersionRange.anchor('>=', ev)
|
||||
VersionRange.anchor('^', ev) // ^ and ~ are first-class operators
|
||||
VersionRange.anchor('~', ev)
|
||||
VersionRange.flavor(null) // match unflavored versions
|
||||
VersionRange.flavor("bitcoin") // match #bitcoin versions
|
||||
|
||||
// Combinators — static (smart, variadic):
|
||||
VersionRange.and(a, b, c, ...)
|
||||
VersionRange.or(a, b, c, ...)
|
||||
|
||||
// Combinators — instance (not smart, just wrap):
|
||||
range.and(other)
|
||||
range.or(other)
|
||||
range.not()
|
||||
|
||||
// Parsing:
|
||||
VersionRange.parse(">=1.0.0:0")
|
||||
VersionRange.parseEmver(">=1.2.3.4") // emver compat
|
||||
|
||||
// Analysis (TS only):
|
||||
range.normalize() // canonical form (see below)
|
||||
range.satisfiable() // boolean
|
||||
range.intersects(other) // boolean
|
||||
```
|
||||
|
||||
**Checking satisfaction:**
|
||||
|
||||
```rust
|
||||
// Rust:
|
||||
version.satisfies(&range) // bool
|
||||
```
|
||||
```typescript
|
||||
// TypeScript:
|
||||
version.satisfies(range) // boolean
|
||||
range.satisfiedBy(version) // boolean (convenience)
|
||||
```
|
||||
|
||||
Also available on `Version` (wraps in `ExtendedVersion` with downstream=0).
|
||||
|
||||
When no operator is specified in a range string, `^` (caret) is the default.
|
||||
|
||||
## Operators
|
||||
|
||||
| Syntax | Rust | TS | Meaning |
|
||||
|--------|------|----|---------|
|
||||
| `=` | `EQ` | `'='` | Equal |
|
||||
| `!=` | `NEQ` | `'!='` | Not equal |
|
||||
| `>` | `GT` | `'>'` | Greater than |
|
||||
| `>=` | `GTE` | `'>='` | Greater than or equal |
|
||||
| `<` | `LT` | `'<'` | Less than |
|
||||
| `<=` | `LTE` | `'<='` | Less than or equal |
|
||||
| `^` | expanded to `And(GTE, LT)` | `'^'` | Compatible (first non-zero digit unchanged) |
|
||||
| `~` | expanded to `And(GTE, LT)` | `'~'` | Patch-level (minor unchanged) |
|
||||
|
||||
## Flavor Rules
|
||||
|
||||
- Versions with **different flavors** never satisfy comparison operators (except `!=`, which returns true)
|
||||
- `VersionRange::Flavor(Some("bitcoin"))` matches only `#bitcoin:*` versions
|
||||
- `VersionRange::Flavor(None)` matches only unflavored versions
|
||||
- Flavor constraints compose with `and`/`or`/`not` like any other range
|
||||
|
||||
## Reduction and Normalization
|
||||
|
||||
### Rust: `reduce()` (shallow)
|
||||
|
||||
`VersionRange::reduce(self) -> Self` re-applies smart constructor rules to one level of the AST. Useful for simplifying a node that was constructed directly (e.g. deserialized) rather than through the smart constructors.
|
||||
|
||||
**Smart constructor rules applied by `and`, `or`, `not`, and `reduce`:**
|
||||
|
||||
`and`:
|
||||
- `and(Any, b) → b`, `and(a, Any) → a`
|
||||
- `and(None, _) → None`, `and(_, None) → None`
|
||||
|
||||
`or`:
|
||||
- `or(Any, _) → Any`, `or(_, Any) → Any`
|
||||
- `or(None, b) → b`, `or(a, None) → a`
|
||||
|
||||
`not`:
|
||||
- `not(=v) → !=v`, `not(!=v) → =v`
|
||||
- `not(and(a, b)) → or(not(a), not(b))` (De Morgan)
|
||||
- `not(or(a, b)) → and(not(a), not(b))` (De Morgan)
|
||||
- `not(not(a)) → a`
|
||||
- `not(Any) → None`, `not(None) → Any`
|
||||
|
||||
### TypeScript: `normalize()` (deep, canonical)
|
||||
|
||||
`VersionRange.normalize(): VersionRange` in `sdk/base/lib/exver/index.ts` performs full normalization by converting the range AST into a canonical form. This is a deep operation that produces a semantically equivalent but simplified range.
|
||||
|
||||
**How it works:**
|
||||
|
||||
1. **`tables()`** — Converts the VersionRange AST into truth tables (`VersionRangeTable`). Each table is a number line split at version boundary points, with boolean values for each segment indicating whether versions in that segment satisfy the range. Separate tables are maintained per flavor (and for flavor negations).
|
||||
|
||||
2. **`VersionRangeTable.zip(a, b, func)`** — Merges two tables by walking their boundary points in sorted order and applying a boolean function (`&&` or `||`) to combine segment values. Adjacent segments with the same boolean value are collapsed automatically.
|
||||
|
||||
3. **`VersionRangeTable.and/or/not`** — Table-level boolean operations. `and` computes the cross-product of flavor tables (since `#a && #b` for different flavors is unsatisfiable). `not` inverts all segment values.
|
||||
|
||||
4. **`VersionRangeTable.collapse()`** — Checks if a table is uniformly true or false across all flavors and segments. Returns `true`, `false`, or `null` (mixed).
|
||||
|
||||
5. **`VersionRangeTable.minterms()`** — Converts truth tables back into a VersionRange AST in [sum-of-products](https://en.wikipedia.org/wiki/Canonical_normal_form#Minterms) canonical form. Each `true` segment becomes a product term (conjunction of boundary constraints), and all terms are joined with `or`. Adjacent boundary points collapse into `=` anchors.
|
||||
|
||||
**Example:** `normalize` can simplify:
|
||||
- `>=1.0.0:0 && <=1.0.0:0` → `=1.0.0:0`
|
||||
- `>=2.0.0:0 || >=1.0.0:0` → `>=1.0.0:0`
|
||||
- `!(!>=1.0.0:0)` → `>=1.0.0:0`
|
||||
|
||||
**Also exposes:**
|
||||
- `satisfiable(): boolean` — returns `true` if there exists any version satisfying the range (checks if `collapse(tables())` is not `false`)
|
||||
- `intersects(other): boolean` — returns `true` if `and(this, other)` is satisfiable
|
||||
|
||||
## API Differences Between Rust and TypeScript
|
||||
|
||||
| | Rust | TypeScript |
|
||||
|-|------|------------|
|
||||
| **`^` / `~`** | Expanded at construction to `And(GTE, LT)` | First-class operator on `Anchor` |
|
||||
| **`not()`** | Static, eagerly simplifies (De Morgan, double negation) | Instance method, just wraps |
|
||||
| **`and()`/`or()`** | Binary static | Both binary instance and variadic static |
|
||||
| **Normalization** | `reduce()` — shallow, one AST level | `normalize()` — deep canonical form via truth tables |
|
||||
| **Satisfiability** | Not available | `satisfiable()` and `intersects(other)` |
|
||||
| **ExtendedVersion helpers** | `with_flavor()`, `without_flavor()`, `map_upstream()`, `map_downstream()` | `incrementMajor()`, `incrementMinor()`, `greaterThan()`, `lessThan()`, `equals()`, etc. |
|
||||
| **Monoid wrappers** | `AnyRange` (fold with `or`) and `AllRange` (fold with `and`) | Not present — use variadic static methods |
|
||||
| **`VersionString`** | Wrapper caching parsed + string form | Not present |
|
||||
| **Emver compat** | `From<emver::Version>` for `ExtendedVersion` | `ExtendedVersion.parseEmver()`, `VersionRange.parseEmver()` |
|
||||
|
||||
## Serde
|
||||
|
||||
All types serialize/deserialize as strings (requires `serde` feature, enabled in StartOS):
|
||||
|
||||
```json
|
||||
{
|
||||
"version": "1.2.3:0",
|
||||
"targetVersion": ">=1.0.0:0 <2.0.0:0",
|
||||
"sourceVersion": "^0.3.0:0"
|
||||
}
|
||||
```
|
||||
@@ -1,100 +0,0 @@
|
||||
# i18n Patterns in `core/`
|
||||
|
||||
## Library & Setup
|
||||
|
||||
**Crate:** [`rust-i18n`](https://crates.io/crates/rust-i18n) v3.1.5 (`core/Cargo.toml`)
|
||||
|
||||
**Initialization** (`core/src/lib.rs:3`):
|
||||
```rust
|
||||
rust_i18n::i18n!("locales", fallback = ["en_US"]);
|
||||
```
|
||||
This macro scans `core/locales/` at compile time and embeds all translations as constants.
|
||||
|
||||
**Prelude re-export** (`core/src/prelude.rs:4`):
|
||||
```rust
|
||||
pub use rust_i18n::t;
|
||||
```
|
||||
Most modules import `t!` via the prelude.
|
||||
|
||||
## Translation File
|
||||
|
||||
**Location:** `core/locales/i18n.yaml`
|
||||
**Format:** YAML v2 (~755 keys)
|
||||
|
||||
**Supported languages:** `en_US`, `de_DE`, `es_ES`, `fr_FR`, `pl_PL`
|
||||
|
||||
**Entry structure:**
|
||||
```yaml
|
||||
namespace.sub.key-name:
|
||||
en_US: "English text with %{param}"
|
||||
de_DE: "German text with %{param}"
|
||||
# ...
|
||||
```
|
||||
|
||||
## Using `t!()`
|
||||
|
||||
```rust
|
||||
// Simple key
|
||||
t!("error.unknown")
|
||||
|
||||
// With parameter interpolation (%{name} in YAML)
|
||||
t!("bins.deprecated.renamed", old = old_name, new = new_name)
|
||||
```
|
||||
|
||||
## Key Naming Conventions
|
||||
|
||||
Keys use **dot-separated hierarchical namespaces** with **kebab-case** for multi-word segments:
|
||||
|
||||
```
|
||||
<module>.<submodule>.<descriptive-name>
|
||||
```
|
||||
|
||||
Examples:
|
||||
- `error.incorrect-password` — error kind label
|
||||
- `bins.start-init.updating-firmware` — startup phase message
|
||||
- `backup.bulk.complete-title` — backup notification title
|
||||
- `help.arg.acme-contact` — CLI help text for an argument
|
||||
- `context.diagnostic.starting-diagnostic-ui` — diagnostic context status
|
||||
|
||||
### Top-Level Namespaces
|
||||
|
||||
| Namespace | Purpose |
|
||||
|-----------|---------|
|
||||
| `error.*` | `ErrorKind` display strings (see `src/error.rs`) |
|
||||
| `bins.*` | CLI binary messages (deprecated, start-init, startd, etc.) |
|
||||
| `init.*` | Initialization phase labels |
|
||||
| `setup.*` | First-run setup messages |
|
||||
| `context.*` | Context startup messages (diagnostic, setup, CLI) |
|
||||
| `service.*` | Service lifecycle messages |
|
||||
| `backup.*` | Backup/restore operation messages |
|
||||
| `registry.*` | Package registry messages |
|
||||
| `net.*` | Network-related messages |
|
||||
| `middleware.*` | Request middleware messages (auth, etc.) |
|
||||
| `disk.*` | Disk operation messages |
|
||||
| `lxc.*` | Container management messages |
|
||||
| `system.*` | System monitoring/metrics messages |
|
||||
| `notifications.*` | User-facing notification messages |
|
||||
| `update.*` | OS update messages |
|
||||
| `util.*` | Utility messages (TUI, RPC) |
|
||||
| `ssh.*` | SSH operation messages |
|
||||
| `shutdown.*` | Shutdown-related messages |
|
||||
| `logs.*` | Log-related messages |
|
||||
| `auth.*` | Authentication messages |
|
||||
| `help.*` | CLI help text (`help.arg.<arg-name>`) |
|
||||
| `about.*` | CLI command descriptions |
|
||||
|
||||
## Locale Selection
|
||||
|
||||
`core/src/bins/mod.rs:15-36` — `set_locale_from_env()`:
|
||||
|
||||
1. Reads `LANG` environment variable
|
||||
2. Strips `.UTF-8` suffix
|
||||
3. Exact-matches against available locales, falls back to language-prefix match (e.g. `en_GB` matches `en_US`)
|
||||
|
||||
## Adding New Keys
|
||||
|
||||
1. Add the key to `core/locales/i18n.yaml` with all 5 language translations
|
||||
2. Use the `t!("your.key.name")` macro in Rust code
|
||||
3. Follow existing namespace conventions — match the module path where the key is used
|
||||
4. Use kebab-case for multi-word segments
|
||||
5. Translations are validated at compile time
|
||||
@@ -1,226 +0,0 @@
|
||||
# rpc-toolkit
|
||||
|
||||
StartOS uses [rpc-toolkit](https://github.com/Start9Labs/rpc-toolkit) for its JSON-RPC API. This document covers the patterns used in this codebase.
|
||||
|
||||
## Overview
|
||||
|
||||
The API is JSON-RPC (not REST). All endpoints are RPC methods organized in a hierarchical command structure.
|
||||
|
||||
## Handler Functions
|
||||
|
||||
There are four types of handler functions, chosen based on the function's characteristics:
|
||||
|
||||
### `from_fn_async` - Async handlers
|
||||
For standard async functions. Most handlers use this.
|
||||
|
||||
```rust
|
||||
pub async fn my_handler(ctx: RpcContext, params: MyParams) -> Result<MyResponse, Error> {
|
||||
// Can use .await
|
||||
}
|
||||
|
||||
from_fn_async(my_handler)
|
||||
```
|
||||
|
||||
### `from_fn_async_local` - Non-thread-safe async handlers
|
||||
For async functions that are not `Send` (cannot be safely moved between threads). Use when working with non-thread-safe types.
|
||||
|
||||
```rust
|
||||
pub async fn cli_download(ctx: CliContext, params: Params) -> Result<(), Error> {
|
||||
// Non-Send async operations
|
||||
}
|
||||
|
||||
from_fn_async_local(cli_download)
|
||||
```
|
||||
|
||||
### `from_fn_blocking` - Sync blocking handlers
|
||||
For synchronous functions that perform blocking I/O or long computations.
|
||||
|
||||
```rust
|
||||
pub fn query_dns(ctx: RpcContext, params: DnsParams) -> Result<DnsResponse, Error> {
|
||||
// Blocking operations (file I/O, DNS lookup, etc.)
|
||||
}
|
||||
|
||||
from_fn_blocking(query_dns)
|
||||
```
|
||||
|
||||
### `from_fn` - Sync non-blocking handlers
|
||||
For pure functions or quick synchronous operations with no I/O.
|
||||
|
||||
```rust
|
||||
pub fn echo(ctx: RpcContext, params: EchoParams) -> Result<String, Error> {
|
||||
Ok(params.message)
|
||||
}
|
||||
|
||||
from_fn(echo)
|
||||
```
|
||||
|
||||
## ParentHandler
|
||||
|
||||
Groups related RPC methods into a hierarchy:
|
||||
|
||||
```rust
|
||||
use rpc_toolkit::{Context, HandlerExt, ParentHandler, from_fn_async};
|
||||
|
||||
pub fn my_api<C: Context>() -> ParentHandler<C> {
|
||||
ParentHandler::new()
|
||||
.subcommand("list", from_fn_async(list_handler).with_call_remote::<CliContext>())
|
||||
.subcommand("create", from_fn_async(create_handler).with_call_remote::<CliContext>())
|
||||
}
|
||||
```
|
||||
|
||||
## Handler Extensions
|
||||
|
||||
Chain methods to configure handler behavior.
|
||||
|
||||
**Ordering rules:**
|
||||
1. `with_about()` must come AFTER other CLI modifiers (`no_display()`, `with_custom_display_fn()`, etc.)
|
||||
2. `with_call_remote()` must be the LAST adapter in the chain
|
||||
|
||||
| Method | Purpose |
|
||||
|--------|---------|
|
||||
| `.with_metadata("key", Value)` | Attach metadata for middleware |
|
||||
| `.no_cli()` | RPC-only, not available via CLI |
|
||||
| `.no_display()` | No CLI output |
|
||||
| `.with_display_serializable()` | Default JSON/YAML output for CLI |
|
||||
| `.with_custom_display_fn(\|_, res\| ...)` | Custom CLI output formatting |
|
||||
| `.with_about("about.description")` | Add help text (i18n key) - **after CLI modifiers** |
|
||||
| `.with_call_remote::<CliContext>()` | Enable CLI to call remotely - **must be last** |
|
||||
|
||||
### Correct ordering example:
|
||||
```rust
|
||||
from_fn_async(my_handler)
|
||||
.with_metadata("sync_db", Value::Bool(true)) // metadata early
|
||||
.no_display() // CLI modifier
|
||||
.with_about("about.my-handler") // after CLI modifiers
|
||||
.with_call_remote::<CliContext>() // always last
|
||||
```
|
||||
|
||||
## Metadata by Middleware
|
||||
|
||||
Metadata tags are processed by different middleware. Group them logically:
|
||||
|
||||
### Auth Middleware (`middleware/auth/mod.rs`)
|
||||
|
||||
| Metadata | Default | Description |
|
||||
|----------|---------|-------------|
|
||||
| `authenticated` | `true` | Whether endpoint requires authentication. Set to `false` for public endpoints. |
|
||||
|
||||
### Session Auth Middleware (`middleware/auth/session.rs`)
|
||||
|
||||
| Metadata | Default | Description |
|
||||
|----------|---------|-------------|
|
||||
| `login` | `false` | Special handling for login endpoints (rate limiting, cookie setting) |
|
||||
| `get_session` | `false` | Inject session ID into params as `__Auth_session` |
|
||||
|
||||
### Signature Auth Middleware (`middleware/auth/signature.rs`)
|
||||
|
||||
| Metadata | Default | Description |
|
||||
|----------|---------|-------------|
|
||||
| `get_signer` | `false` | Inject signer public key into params as `__Auth_signer` |
|
||||
|
||||
### Registry Auth (extends Signature Auth)
|
||||
|
||||
| Metadata | Default | Description |
|
||||
|----------|---------|-------------|
|
||||
| `admin` | `false` | Require admin privileges (signer must be in admin list) |
|
||||
| `get_device_info` | `false` | Inject device info header for hardware filtering |
|
||||
|
||||
### Database Middleware (`middleware/db.rs`)
|
||||
|
||||
| Metadata | Default | Description |
|
||||
|----------|---------|-------------|
|
||||
| `sync_db` | `false` | Sync database after mutation, add `X-Patch-Sequence` header |
|
||||
|
||||
## Context Types
|
||||
|
||||
Different contexts for different execution environments:
|
||||
|
||||
- `RpcContext` - Web/RPC requests with full service access
|
||||
- `CliContext` - CLI operations, calls remote RPC
|
||||
- `InitContext` - During system initialization
|
||||
- `DiagnosticContext` - Diagnostic/recovery mode
|
||||
- `RegistryContext` - Registry daemon context
|
||||
- `EffectContext` - Service effects context (container-to-host calls)
|
||||
|
||||
## Parameter Structs
|
||||
|
||||
Parameters use derive macros for JSON-RPC, CLI parsing, and TypeScript generation:
|
||||
|
||||
```rust
|
||||
#[derive(Deserialize, Serialize, Parser, TS)]
|
||||
#[serde(rename_all = "camelCase")] // JSON-RPC uses camelCase
|
||||
#[command(rename_all = "kebab-case")] // CLI uses kebab-case
|
||||
#[ts(export)] // Generate TypeScript types
|
||||
pub struct MyParams {
|
||||
pub package_id: PackageId,
|
||||
}
|
||||
```
|
||||
|
||||
### Middleware Injection
|
||||
|
||||
Auth middleware can inject values into params using special field names:
|
||||
|
||||
```rust
|
||||
#[derive(Deserialize, Serialize, Parser, TS)]
|
||||
pub struct MyParams {
|
||||
#[ts(skip)]
|
||||
#[serde(rename = "__Auth_session")] // Injected by session auth
|
||||
session: InternedString,
|
||||
|
||||
#[ts(skip)]
|
||||
#[serde(rename = "__Auth_signer")] // Injected by signature auth
|
||||
signer: AnyVerifyingKey,
|
||||
|
||||
#[ts(skip)]
|
||||
#[serde(rename = "__Auth_userAgent")] // Injected during login
|
||||
user_agent: Option<String>,
|
||||
}
|
||||
```
|
||||
|
||||
## Common Patterns
|
||||
|
||||
### Adding a New RPC Endpoint
|
||||
|
||||
1. Define params struct with `Deserialize, Serialize, Parser, TS`
|
||||
2. Choose handler type based on sync/async and thread-safety
|
||||
3. Write handler function taking `(Context, Params) -> Result<Response, Error>`
|
||||
4. Add to parent handler with appropriate extensions (display modifiers before `with_about`)
|
||||
5. TypeScript types auto-generated via `make ts-bindings`
|
||||
|
||||
### Public (Unauthenticated) Endpoint
|
||||
|
||||
```rust
|
||||
from_fn_async(get_info)
|
||||
.with_metadata("authenticated", Value::Bool(false))
|
||||
.with_display_serializable()
|
||||
.with_about("about.get-info")
|
||||
.with_call_remote::<CliContext>() // last
|
||||
```
|
||||
|
||||
### Mutating Endpoint with DB Sync
|
||||
|
||||
```rust
|
||||
from_fn_async(update_config)
|
||||
.with_metadata("sync_db", Value::Bool(true))
|
||||
.no_display()
|
||||
.with_about("about.update-config")
|
||||
.with_call_remote::<CliContext>() // last
|
||||
```
|
||||
|
||||
### Session-Aware Endpoint
|
||||
|
||||
```rust
|
||||
from_fn_async(logout)
|
||||
.with_metadata("get_session", Value::Bool(true))
|
||||
.no_display()
|
||||
.with_about("about.logout")
|
||||
.with_call_remote::<CliContext>() // last
|
||||
```
|
||||
|
||||
## File Locations
|
||||
|
||||
- Handler definitions: Throughout `core/src/` modules
|
||||
- Main API tree: `core/src/lib.rs` (`main_api()`, `server()`, `package()`)
|
||||
- Auth middleware: `core/src/middleware/auth/`
|
||||
- DB middleware: `core/src/middleware/db.rs`
|
||||
- Context types: `core/src/context/`
|
||||
@@ -1,122 +0,0 @@
|
||||
# S9PK Package Format
|
||||
|
||||
S9PK is the package format for StartOS services. Version 2 uses a merkle archive structure for efficient downloading and cryptographic verification.
|
||||
|
||||
## File Format
|
||||
|
||||
S9PK files begin with a 3-byte header: `0x3b 0x3b 0x02` (magic bytes + version 2).
|
||||
|
||||
The archive is cryptographically signed using Ed25519 with prehashed content (SHA-512 over blake3 merkle root hash).
|
||||
|
||||
## Archive Structure
|
||||
|
||||
```
|
||||
/
|
||||
├── manifest.json # Package metadata (required)
|
||||
├── icon.<ext> # Package icon - any image/* format (required)
|
||||
├── LICENSE.md # License text (required)
|
||||
├── dependencies/ # Dependency metadata (optional)
|
||||
│ └── <package-id>/
|
||||
│ ├── metadata.json # DependencyMetadata
|
||||
│ └── icon.<ext> # Dependency icon
|
||||
├── javascript.squashfs # Package JavaScript code (required)
|
||||
├── assets.squashfs # Static assets (optional, legacy: assets/ directory)
|
||||
└── images/ # Container images by architecture
|
||||
└── <arch>/ # e.g., x86_64, aarch64, riscv64
|
||||
├── <image-id>.squashfs # Container filesystem
|
||||
├── <image-id>.json # Image metadata
|
||||
└── <image-id>.env # Environment variables
|
||||
```
|
||||
|
||||
## Components
|
||||
|
||||
### manifest.json
|
||||
|
||||
The package manifest contains all metadata:
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| `id` | string | Package identifier (e.g., `bitcoind`) |
|
||||
| `title` | string | Display name |
|
||||
| `version` | string | Extended version string |
|
||||
| `satisfies` | string[] | Version ranges this version satisfies |
|
||||
| `releaseNotes` | string/object | Release notes (localized) |
|
||||
| `canMigrateTo` | string | Version range for forward migration |
|
||||
| `canMigrateFrom` | string | Version range for backward migration |
|
||||
| `license` | string | License type |
|
||||
| `wrapperRepo` | string | StartOS wrapper repository URL |
|
||||
| `upstreamRepo` | string | Upstream project URL |
|
||||
| `supportSite` | string | Support site URL |
|
||||
| `marketingSite` | string | Marketing site URL |
|
||||
| `donationUrl` | string? | Optional donation URL |
|
||||
| `docsUrl` | string? | Optional documentation URL |
|
||||
| `description` | object | Short and long descriptions (localized) |
|
||||
| `images` | object | Image configurations by image ID |
|
||||
| `volumes` | string[] | Volume IDs for persistent data |
|
||||
| `alerts` | object | User alerts for lifecycle events |
|
||||
| `dependencies` | object | Package dependencies |
|
||||
| `hardwareRequirements` | object | Hardware requirements (arch, RAM, devices) |
|
||||
| `hardwareAcceleration` | boolean | Whether package uses hardware acceleration |
|
||||
| `gitHash` | string? | Git commit hash |
|
||||
| `osVersion` | string | Minimum StartOS version |
|
||||
| `sdkVersion` | string? | SDK version used to build |
|
||||
|
||||
### javascript.squashfs
|
||||
|
||||
Contains the package JavaScript that implements the `ABI` interface from `@start9labs/start-sdk-base`. This code runs in the container runtime and manages the package lifecycle.
|
||||
|
||||
The squashfs is mounted at `/usr/lib/startos/package/` and the runtime loads `index.js`.
|
||||
|
||||
### images/
|
||||
|
||||
Container images organized by architecture:
|
||||
|
||||
- **`<image-id>.squashfs`** - Container root filesystem
|
||||
- **`<image-id>.json`** - Image metadata (entrypoint, user, workdir, etc.)
|
||||
- **`<image-id>.env`** - Environment variables for the container
|
||||
|
||||
Images are built from Docker/Podman and converted to squashfs. The `ImageConfig` in manifest specifies:
|
||||
- `arch` - Supported architectures
|
||||
- `emulateMissingAs` - Fallback architecture for emulation
|
||||
- `nvidiaContainer` - Whether to enable NVIDIA container support
|
||||
|
||||
### assets.squashfs
|
||||
|
||||
Static assets accessible to the package, mounted read-only at `/media/startos/assets/` in the container.
|
||||
|
||||
### dependencies/
|
||||
|
||||
Metadata for dependencies displayed in the UI:
|
||||
- `metadata.json` - Just title for now
|
||||
- `icon.<ext>` - Icon for the dependency
|
||||
|
||||
## Merkle Archive
|
||||
|
||||
The S9PK uses a merkle tree structure where each file and directory has a blake3 hash. This enables:
|
||||
|
||||
1. **Partial downloads** - Download and verify individual files
|
||||
2. **Integrity verification** - Verify any subset of the archive
|
||||
3. **Efficient updates** - Only download changed portions
|
||||
4. **DOS protection** - Size limits enforced before downloading content
|
||||
|
||||
Files are sorted by priority for streaming (manifest first, then icon, license, dependencies, javascript, assets, images).
|
||||
|
||||
## Building S9PK
|
||||
|
||||
Use `start-cli s9pk pack` to build packages:
|
||||
|
||||
```bash
|
||||
start-cli s9pk pack <manifest-path> -o <output.s9pk>
|
||||
```
|
||||
|
||||
Images can be sourced from:
|
||||
- Docker/Podman build (`--docker-build`)
|
||||
- Existing Docker tag (`--docker-tag`)
|
||||
- Pre-built squashfs files
|
||||
|
||||
## Related Code
|
||||
|
||||
- `core/src/s9pk/v2/mod.rs` - S9pk struct and serialization
|
||||
- `core/src/s9pk/v2/manifest.rs` - Manifest types
|
||||
- `core/src/s9pk/v2/pack.rs` - Packing logic
|
||||
- `core/src/s9pk/merkle_archive/` - Merkle archive implementation
|
||||
@@ -111,6 +111,6 @@ if [ "$CHROOT_RES" -eq 0 ]; then
|
||||
reboot
|
||||
fi
|
||||
|
||||
umount /media/startos/next
|
||||
umount -R /media/startos/next
|
||||
umount /media/startos/upper
|
||||
rm -rf /media/startos/upper /media/startos/next
|
||||
@@ -1,21 +1,16 @@
|
||||
# Container RPC Server Specification
|
||||
|
||||
The container runtime exposes a JSON-RPC server over a Unix socket at `/media/startos/rpc/service.sock`.
|
||||
# Container RPC SERVER Specification
|
||||
|
||||
## Methods
|
||||
|
||||
### init
|
||||
|
||||
Initialize the runtime and system.
|
||||
initialize runtime (mount `/proc`, `/sys`, `/dev`, and `/run` to each image in `/media/images`)
|
||||
|
||||
#### params
|
||||
called after os has mounted js and images to the container
|
||||
|
||||
```ts
|
||||
{
|
||||
id: string,
|
||||
kind: "install" | "update" | "restore" | null,
|
||||
}
|
||||
```
|
||||
#### args
|
||||
|
||||
`[]`
|
||||
|
||||
#### response
|
||||
|
||||
@@ -23,16 +18,11 @@ Initialize the runtime and system.
|
||||
|
||||
### exit
|
||||
|
||||
Shutdown runtime and optionally run exit hooks for a target version.
|
||||
shutdown runtime
|
||||
|
||||
#### params
|
||||
#### args
|
||||
|
||||
```ts
|
||||
{
|
||||
id: string,
|
||||
target: string | null, // ExtendedVersion or VersionRange
|
||||
}
|
||||
```
|
||||
`[]`
|
||||
|
||||
#### response
|
||||
|
||||
@@ -40,11 +30,11 @@ Shutdown runtime and optionally run exit hooks for a target version.
|
||||
|
||||
### start
|
||||
|
||||
Run main method if not already running.
|
||||
run main method if not already running
|
||||
|
||||
#### params
|
||||
#### args
|
||||
|
||||
None
|
||||
`[]`
|
||||
|
||||
#### response
|
||||
|
||||
@@ -52,11 +42,11 @@ None
|
||||
|
||||
### stop
|
||||
|
||||
Stop main method by sending SIGTERM to child processes, and SIGKILL after timeout.
|
||||
stop main method by sending SIGTERM to child processes, and SIGKILL after timeout
|
||||
|
||||
#### params
|
||||
#### args
|
||||
|
||||
None
|
||||
`{ timeout: millis }`
|
||||
|
||||
#### response
|
||||
|
||||
@@ -64,16 +54,15 @@ None
|
||||
|
||||
### execute
|
||||
|
||||
Run a specific package procedure.
|
||||
run a specific package procedure
|
||||
|
||||
#### params
|
||||
#### args
|
||||
|
||||
```ts
|
||||
{
|
||||
id: string, // event ID
|
||||
procedure: string, // JSON path (e.g., "/backup/create", "/actions/{name}/run")
|
||||
input: any,
|
||||
timeout: number | null,
|
||||
procedure: JsonPath,
|
||||
input: any,
|
||||
timeout: millis,
|
||||
}
|
||||
```
|
||||
|
||||
@@ -83,64 +72,18 @@ Run a specific package procedure.
|
||||
|
||||
### sandbox
|
||||
|
||||
Run a specific package procedure in sandbox mode. Same interface as `execute`.
|
||||
run a specific package procedure in sandbox mode
|
||||
|
||||
UNIMPLEMENTED: this feature is planned but does not exist
|
||||
|
||||
#### params
|
||||
#### args
|
||||
|
||||
```ts
|
||||
{
|
||||
id: string,
|
||||
procedure: string,
|
||||
input: any,
|
||||
timeout: number | null,
|
||||
procedure: JsonPath,
|
||||
input: any,
|
||||
timeout: millis,
|
||||
}
|
||||
```
|
||||
|
||||
#### response
|
||||
|
||||
`any`
|
||||
|
||||
### callback
|
||||
|
||||
Handle a callback from an effect.
|
||||
|
||||
#### params
|
||||
|
||||
```ts
|
||||
{
|
||||
id: number,
|
||||
args: any[],
|
||||
}
|
||||
```
|
||||
|
||||
#### response
|
||||
|
||||
`null` (no response sent)
|
||||
|
||||
### eval
|
||||
|
||||
Evaluate a script in the runtime context. Used for debugging.
|
||||
|
||||
#### params
|
||||
|
||||
```ts
|
||||
{
|
||||
script: string,
|
||||
}
|
||||
```
|
||||
|
||||
#### response
|
||||
|
||||
`any`
|
||||
|
||||
## Procedures
|
||||
|
||||
The `execute` and `sandbox` methods route to procedures based on the `procedure` path:
|
||||
|
||||
| Procedure | Description |
|
||||
|-----------|-------------|
|
||||
| `/backup/create` | Create a backup |
|
||||
| `/actions/{name}/getInput` | Get input spec for an action |
|
||||
| `/actions/{name}/run` | Run an action with input |
|
||||
|
||||
@@ -508,10 +508,8 @@ impl From<Error> for RpcError {
|
||||
}
|
||||
impl From<RpcError> for Error {
|
||||
fn from(e: RpcError) -> Self {
|
||||
let data = ErrorData::from(&e);
|
||||
let info = data.info.clone();
|
||||
Error::new(
|
||||
data,
|
||||
ErrorData::from(&e),
|
||||
if let Ok(kind) = e.code.try_into() {
|
||||
kind
|
||||
} else if e.code == METHOD_NOT_FOUND_ERROR.code {
|
||||
@@ -525,7 +523,6 @@ impl From<RpcError> for Error {
|
||||
ErrorKind::Unknown
|
||||
},
|
||||
)
|
||||
.with_info(info)
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -137,7 +137,6 @@ pub async fn install(
|
||||
json!({
|
||||
"id": id,
|
||||
"targetVersion": VersionRange::exactly(version.deref().clone()),
|
||||
"otherVersions": "none",
|
||||
}),
|
||||
RegistryUrlParams {
|
||||
registry: registry.clone(),
|
||||
@@ -485,7 +484,7 @@ pub async fn cli_install(
|
||||
let mut packages: GetPackageResponse = from_value(
|
||||
ctx.call_remote::<RegistryContext>(
|
||||
"package.get",
|
||||
json!({ "id": &id, "targetVersion": version, "sourceVersion": source_version, "otherVersions": "none" }),
|
||||
json!({ "id": &id, "targetVersion": version, "sourceVersion": source_version }),
|
||||
)
|
||||
.await?,
|
||||
)?;
|
||||
|
||||
@@ -15,7 +15,6 @@ use crate::progress::{FullProgressTracker, ProgressUnits};
|
||||
use crate::registry::context::RegistryContext;
|
||||
use crate::registry::device_info::DeviceInfo;
|
||||
use crate::registry::package::index::{PackageIndex, PackageVersionInfo};
|
||||
use crate::s9pk::manifest::LocaleString;
|
||||
use crate::s9pk::merkle_archive::source::ArchiveSource;
|
||||
use crate::s9pk::v2::SIG_CONTEXT;
|
||||
use crate::util::VersionString;
|
||||
@@ -39,11 +38,11 @@ impl Default for PackageDetailLevel {
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Clone, Debug, Deserialize, Serialize, TS)]
|
||||
#[derive(Debug, Deserialize, Serialize, TS)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
#[ts(export)]
|
||||
pub struct PackageInfoShort {
|
||||
pub release_notes: LocaleString,
|
||||
pub release_notes: String,
|
||||
}
|
||||
|
||||
#[derive(Debug, Deserialize, Serialize, TS, Parser, HasModel)]
|
||||
@@ -90,20 +89,17 @@ impl GetPackageResponse {
|
||||
|
||||
let lesser_versions: BTreeMap<_, _> = self
|
||||
.other_versions
|
||||
.clone()
|
||||
.as_ref()
|
||||
.into_iter()
|
||||
.flatten()
|
||||
.filter(|(v, _)| **v < *version)
|
||||
.filter(|(v, _)| ***v < *version)
|
||||
.collect();
|
||||
|
||||
if !lesser_versions.is_empty() {
|
||||
table.add_row(row![bc => "OLDER VERSIONS"]);
|
||||
table.add_row(row![bc => "VERSION", "RELEASE NOTES"]);
|
||||
for (version, info) in lesser_versions {
|
||||
table.add_row(row![
|
||||
AsRef::<str>::as_ref(&version),
|
||||
&info.release_notes.localized()
|
||||
]);
|
||||
table.add_row(row![AsRef::<str>::as_ref(version), &info.release_notes]);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -151,7 +147,6 @@ fn get_matching_models(
|
||||
id,
|
||||
source_version,
|
||||
device_info,
|
||||
target_version,
|
||||
..
|
||||
}: &GetPackageParams,
|
||||
) -> Result<Vec<(PackageId, ExtendedVersion, Model<PackageVersionInfo>)>, Error> {
|
||||
@@ -170,29 +165,26 @@ fn get_matching_models(
|
||||
.as_entries()?
|
||||
.into_iter()
|
||||
.map(|(v, info)| {
|
||||
let ev = ExtendedVersion::from(v);
|
||||
Ok::<_, Error>(
|
||||
if target_version.as_ref().map_or(true, |tv| ev.satisfies(tv))
|
||||
&& source_version.as_ref().map_or(Ok(true), |source_version| {
|
||||
Ok::<_, Error>(
|
||||
source_version.satisfies(
|
||||
&info
|
||||
.as_source_version()
|
||||
.de()?
|
||||
.unwrap_or(VersionRange::any()),
|
||||
),
|
||||
)
|
||||
})?
|
||||
{
|
||||
if source_version.as_ref().map_or(Ok(true), |source_version| {
|
||||
Ok::<_, Error>(
|
||||
source_version.satisfies(
|
||||
&info
|
||||
.as_source_version()
|
||||
.de()?
|
||||
.unwrap_or(VersionRange::any()),
|
||||
),
|
||||
)
|
||||
})? {
|
||||
let mut info = info.clone();
|
||||
if let Some(device_info) = &device_info {
|
||||
if info.for_device(device_info)? {
|
||||
Some((k.clone(), ev, info))
|
||||
Some((k.clone(), ExtendedVersion::from(v), info))
|
||||
} else {
|
||||
None
|
||||
}
|
||||
} else {
|
||||
Some((k.clone(), ev, info))
|
||||
Some((k.clone(), ExtendedVersion::from(v), info))
|
||||
}
|
||||
} else {
|
||||
None
|
||||
@@ -215,7 +207,12 @@ pub async fn get_package(ctx: RegistryContext, params: GetPackageParams) -> Resu
|
||||
for (id, version, info) in get_matching_models(&peek.as_index().as_package(), ¶ms)? {
|
||||
let package_best = best.entry(id.clone()).or_default();
|
||||
let package_other = other.entry(id.clone()).or_default();
|
||||
if package_best.keys().all(|k| !(**k > version)) {
|
||||
if params
|
||||
.target_version
|
||||
.as_ref()
|
||||
.map_or(true, |v| version.satisfies(v))
|
||||
&& package_best.keys().all(|k| !(**k > version))
|
||||
{
|
||||
for worse_version in package_best
|
||||
.keys()
|
||||
.filter(|k| ***k < version)
|
||||
@@ -572,42 +569,3 @@ pub async fn cli_download(
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn check_matching_info_short() {
|
||||
use crate::registry::package::index::PackageMetadata;
|
||||
use crate::s9pk::manifest::{Alerts, Description};
|
||||
use crate::util::DataUrl;
|
||||
|
||||
let lang_map = |s: &str| {
|
||||
LocaleString::LanguageMap([("en".into(), s.into())].into_iter().collect())
|
||||
};
|
||||
|
||||
let info = PackageVersionInfo {
|
||||
metadata: PackageMetadata {
|
||||
title: "Test Package".into(),
|
||||
icon: DataUrl::from_vec("image/png", vec![]),
|
||||
description: Description {
|
||||
short: lang_map("A short description"),
|
||||
long: lang_map("A longer description of the test package"),
|
||||
},
|
||||
release_notes: lang_map("Initial release"),
|
||||
git_hash: None,
|
||||
license: "MIT".into(),
|
||||
wrapper_repo: "https://github.com/example/wrapper".parse().unwrap(),
|
||||
upstream_repo: "https://github.com/example/upstream".parse().unwrap(),
|
||||
support_site: "https://example.com/support".parse().unwrap(),
|
||||
marketing_site: "https://example.com".parse().unwrap(),
|
||||
donation_url: None,
|
||||
docs_url: None,
|
||||
alerts: Alerts::default(),
|
||||
dependency_metadata: BTreeMap::new(),
|
||||
os_version: exver::Version::new([0, 3, 6], []),
|
||||
sdk_version: None,
|
||||
hardware_acceleration: false,
|
||||
},
|
||||
source_version: None,
|
||||
s9pks: Vec::new(),
|
||||
};
|
||||
from_value::<PackageInfoShort>(to_value(&info).unwrap()).unwrap();
|
||||
}
|
||||
|
||||
@@ -524,26 +524,26 @@ pub async fn init_web(ctx: CliContext) -> Result<(), Error> {
|
||||
"To access your Web URL securely, trust your Root CA (displayed above) on your client device(s):\n",
|
||||
" - MacOS\n",
|
||||
" 1. Open the Terminal app\n",
|
||||
" 2. Paste the following command (**DO NOT** click Return): pbcopy < ~/Desktop/ca.crt\n",
|
||||
" 2. Paste the following command (**DO NOTt** click Return): pbcopy < ~/Desktop/ca.crt\n",
|
||||
" 3. Copy your Root CA (including -----BEGIN CERTIFICATE----- and -----END CERTIFICATE-----)\n",
|
||||
" 4. Back in Terminal, click Return. ca.crt is saved to your Desktop\n",
|
||||
" 5. Complete by trusting your Root CA: https://staging.docs.start9.com/device-guides/mac/ca.html\n",
|
||||
" 5. Complete by trusting your Root CA: https://https://staging.docs.start9.com/device-guides/mac/ca.html\n",
|
||||
" - Linux\n",
|
||||
" 1. Open gedit, nano, or any editor\n",
|
||||
" 2. Copy/paste your Root CA (including -----BEGIN CERTIFICATE----- and -----END CERTIFICATE-----)\n",
|
||||
" 3. Name the file ca.crt and save as plaintext\n",
|
||||
" 5. Complete by trusting your Root CA: https://staging.docs.start9.com/device-guides/linux/ca.html\n",
|
||||
" 5. Complete by trusting your Root CA: https://https://staging.docs.start9.com/device-guides/linux/ca.html\n",
|
||||
" - Windows\n",
|
||||
" 1. Open the Notepad app\n",
|
||||
" 2. Copy/paste your Root CA (including -----BEGIN CERTIFICATE----- and -----END CERTIFICATE-----)\n",
|
||||
" 3. Name the file ca.crt and save as plaintext\n",
|
||||
" 5. Complete by trusting your Root CA: https://staging.docs.start9.com/device-guides/windows/ca.html\n",
|
||||
" 5. Complete by trusting your Root CA: https://https://staging.docs.start9.com/device-guides/windows/ca.html\n",
|
||||
" - Android/Graphene\n",
|
||||
" 1. Send the ca.crt file (created above) to yourself\n",
|
||||
" 2. Complete by trusting your Root CA: https://staging.docs.start9.com/device-guides/android/ca.html\n",
|
||||
" 2. Complete by trusting your Root CA: https://https://staging.docs.start9.com/device-guides/android/ca.html\n",
|
||||
" - iOS\n",
|
||||
" 1. Send the ca.crt file (created above) to yourself\n",
|
||||
" 2. Complete by trusting your Root CA: https://staging.docs.start9.com/device-guides/ios/ca.html\n",
|
||||
" 2. Complete by trusting your Root CA: https://https://staging.docs.start9.com/device-guides/ios/ca.html\n",
|
||||
));
|
||||
|
||||
return Ok(());
|
||||
|
||||
@@ -16,160 +16,569 @@ import {
|
||||
MountParams,
|
||||
StatusInfo,
|
||||
Manifest,
|
||||
} from './osBindings'
|
||||
} from "./osBindings"
|
||||
import {
|
||||
PackageId,
|
||||
Dependencies,
|
||||
ServiceInterfaceId,
|
||||
SmtpValue,
|
||||
ActionResult,
|
||||
} from './types'
|
||||
|
||||
/** Used to reach out from the pure js runtime */
|
||||
} from "./types"
|
||||
|
||||
/**
|
||||
* The Effects interface is the primary mechanism for a StartOS service to interact
|
||||
* with the host operating system. All system operations—file I/O, networking,
|
||||
* health reporting, dependency management, and more—are performed through Effects.
|
||||
*
|
||||
* Effects are passed to all lifecycle functions (main, init, uninit, actions, etc.)
|
||||
* and provide a controlled, sandboxed API for service operations.
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* export const main = sdk.setupMain(async ({ effects }) => {
|
||||
* // Use effects to interact with the system
|
||||
* const smtp = await effects.getSystemSmtp({})
|
||||
* await effects.setHealth({ name: 'server', result: { result: 'success' } })
|
||||
* })
|
||||
* ```
|
||||
*/
|
||||
export type Effects = {
|
||||
/**
|
||||
* A unique identifier for the current event/request context.
|
||||
* Returns null when not executing within an event context.
|
||||
* Useful for correlating logs and tracking request flows.
|
||||
*/
|
||||
readonly eventId: string | null
|
||||
|
||||
/**
|
||||
* Creates a child Effects context with a namespaced identifier.
|
||||
* Child contexts inherit the parent's capabilities but have their own
|
||||
* event tracking namespace, useful for organizing complex operations.
|
||||
*
|
||||
* @param name - The name to append to the context namespace
|
||||
* @returns A new Effects instance scoped to the child context
|
||||
*/
|
||||
child: (name: string) => Effects
|
||||
|
||||
/**
|
||||
* Internal retry mechanism for `.const()` operations.
|
||||
* Called automatically when a const operation needs to be retried
|
||||
* due to dependency changes. Not typically used directly by service developers.
|
||||
*/
|
||||
constRetry?: () => void
|
||||
|
||||
/**
|
||||
* Indicates whether the Effects instance is currently within a valid execution context.
|
||||
* Returns false if the context has been destroyed or left.
|
||||
*/
|
||||
isInContext: boolean
|
||||
|
||||
/**
|
||||
* Registers a cleanup callback to be invoked when leaving the current context.
|
||||
* Use this to clean up resources, close connections, or perform other teardown
|
||||
* operations when the service or action completes.
|
||||
*
|
||||
* @param fn - Cleanup function to execute on context exit. Can return void, null, or undefined.
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* effects.onLeaveContext(() => {
|
||||
* socket.close()
|
||||
* clearInterval(healthCheckInterval)
|
||||
* })
|
||||
* ```
|
||||
*/
|
||||
onLeaveContext: (fn: () => void | null | undefined) => void
|
||||
|
||||
/**
|
||||
* Clears registered callbacks by their internal IDs.
|
||||
* Used for cleanup when callbacks are no longer needed.
|
||||
*
|
||||
* @param options - Either `{ only: number[] }` to clear specific callbacks,
|
||||
* or `{ except: number[] }` to clear all except the specified ones
|
||||
* @returns Promise resolving to null on completion
|
||||
*/
|
||||
clearCallbacks: (
|
||||
options: { only: number[] } | { except: number[] },
|
||||
) => Promise<null>
|
||||
|
||||
// action
|
||||
/**
|
||||
* Action-related methods for defining, invoking, and managing user-callable operations.
|
||||
* Actions appear in the StartOS UI and can be triggered by users or other services.
|
||||
*/
|
||||
action: {
|
||||
/** Define an action that can be invoked by a user or service */
|
||||
/**
|
||||
* Exports an action to make it available in the StartOS UI.
|
||||
* Call this during initialization to register actions that users can invoke.
|
||||
*
|
||||
* @param options.id - Unique identifier for the action
|
||||
* @param options.metadata - Action configuration including name, description, input spec, and visibility
|
||||
* @returns Promise resolving to null on success
|
||||
*/
|
||||
export(options: { id: ActionId; metadata: ActionMetadata }): Promise<null>
|
||||
/** Remove all exported actions */
|
||||
|
||||
/**
|
||||
* Removes all exported actions except those specified.
|
||||
* Typically called during initialization before re-registering current actions.
|
||||
*
|
||||
* @param options.except - Array of action IDs to keep (not remove)
|
||||
* @returns Promise resolving to null on success
|
||||
*/
|
||||
clear(options: { except: ActionId[] }): Promise<null>
|
||||
|
||||
/**
|
||||
* Retrieves the previously submitted input for an action.
|
||||
* Useful for pre-filling forms with the last-used values.
|
||||
*
|
||||
* @param options.packageId - Package ID (defaults to current package if omitted)
|
||||
* @param options.actionId - The action whose input to retrieve
|
||||
* @returns Promise resolving to the stored input, or null if none exists
|
||||
*/
|
||||
getInput(options: {
|
||||
packageId?: PackageId
|
||||
actionId: ActionId
|
||||
}): Promise<ActionInput | null>
|
||||
|
||||
/**
|
||||
* Programmatically invokes an action on this or another service.
|
||||
* Enables service-to-service communication and automation.
|
||||
*
|
||||
* @param options.packageId - Target package ID (defaults to current package if omitted)
|
||||
* @param options.actionId - The action to invoke
|
||||
* @param options.input - Input data matching the action's input specification
|
||||
* @returns Promise resolving to the action result, or null if the action doesn't exist
|
||||
*/
|
||||
run<Input extends Record<string, unknown>>(options: {
|
||||
packageId?: PackageId
|
||||
actionId: ActionId
|
||||
input?: Input
|
||||
}): Promise<ActionResult | null>
|
||||
|
||||
/**
|
||||
* Creates a task that appears in the StartOS UI task list.
|
||||
* Tasks are used for long-running operations or required setup steps
|
||||
* that need user attention (e.g., "Create admin user", "Configure backup").
|
||||
*
|
||||
* @param options - Task configuration including ID, name, description, and completion criteria
|
||||
* @returns Promise resolving to null on success
|
||||
*/
|
||||
createTask(options: CreateTaskParams): Promise<null>
|
||||
|
||||
/**
|
||||
* Removes tasks from the UI task list.
|
||||
*
|
||||
* @param options - Either `{ only: string[] }` to remove specific tasks,
|
||||
* or `{ except: string[] }` to remove all except specified tasks
|
||||
* @returns Promise resolving to null on success
|
||||
*/
|
||||
clearTasks(
|
||||
options: { only: string[] } | { except: string[] },
|
||||
): Promise<null>
|
||||
}
|
||||
|
||||
// control
|
||||
/** restart this service's main function */
|
||||
// ─────────────────────────────────────────────────────────────────────────────
|
||||
// Control Methods - Manage service lifecycle
|
||||
// ─────────────────────────────────────────────────────────────────────────────
|
||||
|
||||
/**
|
||||
* Restarts this service's main function.
|
||||
* The current main process will be terminated and a new one started.
|
||||
* Use this after configuration changes that require a restart to take effect.
|
||||
*
|
||||
* @returns Promise resolving to null when the restart has been initiated
|
||||
*/
|
||||
restart(): Promise<null>
|
||||
/** stop this service's main function */
|
||||
|
||||
/**
|
||||
* Gracefully stops this service's main function.
|
||||
* The daemon will receive a termination signal and be given time to clean up.
|
||||
*
|
||||
* @returns Promise resolving to null when shutdown has been initiated
|
||||
*/
|
||||
shutdown(): Promise<null>
|
||||
/** ask the host os what the service's current status is */
|
||||
|
||||
/**
|
||||
* Queries the current status of a service from the host OS.
|
||||
*
|
||||
* @param options.packageId - Package to query (defaults to current package if omitted)
|
||||
* @param options.callback - Optional callback invoked when status changes (for reactive updates)
|
||||
* @returns Promise resolving to the service's current status information
|
||||
*/
|
||||
getStatus(options: {
|
||||
packageId?: PackageId
|
||||
callback?: () => void
|
||||
}): Promise<StatusInfo>
|
||||
/** DEPRECATED: indicate to the host os what runstate the service is in */
|
||||
|
||||
/**
|
||||
* @deprecated This method is deprecated and should not be used.
|
||||
* Health status is now managed through the health check system.
|
||||
*
|
||||
* Previously used to manually indicate the service's run state to the host OS.
|
||||
*/
|
||||
setMainStatus(options: SetMainStatus): Promise<null>
|
||||
|
||||
// dependency
|
||||
/** Set the dependencies of what the service needs, usually run during the inputSpec action as a best practice */
|
||||
// ─────────────────────────────────────────────────────────────────────────────
|
||||
// Dependency Methods - Manage service dependencies and inter-service communication
|
||||
// ─────────────────────────────────────────────────────────────────────────────
|
||||
|
||||
/**
|
||||
* Declares the runtime dependencies this service requires.
|
||||
* Dependencies can be marked as "running" (must be actively running) or "exists" (must be installed).
|
||||
* Call this during initialization to ensure dependencies are satisfied before the service starts.
|
||||
*
|
||||
* @param options.dependencies - Array of dependency requirements with package IDs, version ranges, and dependency kind
|
||||
* @returns Promise resolving to null on success
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* await effects.setDependencies({
|
||||
* dependencies: [
|
||||
* { packageId: 'bitcoind', versionRange: '>=25.0.0', kind: 'running' },
|
||||
* { packageId: 'lnd', versionRange: '>=0.16.0', kind: 'exists' }
|
||||
* ]
|
||||
* })
|
||||
* ```
|
||||
*/
|
||||
setDependencies(options: { dependencies: Dependencies }): Promise<null>
|
||||
/** Get the list of the dependencies, both the dynamic set by the effect of setDependencies and the end result any required in the manifest */
|
||||
|
||||
/**
|
||||
* Retrieves the complete list of dependencies for this service.
|
||||
* Includes both statically declared dependencies from the manifest
|
||||
* and dynamically set dependencies from setDependencies().
|
||||
*
|
||||
* @returns Promise resolving to array of all dependency requirements
|
||||
*/
|
||||
getDependencies(): Promise<DependencyRequirement[]>
|
||||
/** Test whether current dependency requirements are satisfied */
|
||||
|
||||
/**
|
||||
* Tests whether the specified or all dependencies are currently satisfied.
|
||||
* Use this to verify dependencies are met before performing operations that require them.
|
||||
*
|
||||
* @param options.packageIds - Specific packages to check (checks all dependencies if omitted)
|
||||
* @returns Promise resolving to array of check results indicating satisfaction status
|
||||
*/
|
||||
checkDependencies(options: {
|
||||
packageIds?: PackageId[]
|
||||
}): Promise<CheckDependenciesResult[]>
|
||||
/** mount a volume of a dependency */
|
||||
|
||||
/**
|
||||
* Mounts a volume from a dependency service into this service's filesystem.
|
||||
* Enables read-only or read-write access to another service's data.
|
||||
*
|
||||
* @param options - Mount configuration including dependency ID, volume ID, mountpoint, and access mode
|
||||
* @returns Promise resolving to the mount path
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* // Mount bitcoind's data directory for read access
|
||||
* const mountPath = await effects.mount({
|
||||
* dependencyId: 'bitcoind',
|
||||
* volumeId: 'main',
|
||||
* mountpoint: '/mnt/bitcoin',
|
||||
* readonly: true
|
||||
* })
|
||||
* ```
|
||||
*/
|
||||
mount(options: MountParams): Promise<string>
|
||||
/** Returns a list of the ids of all installed packages */
|
||||
|
||||
/**
|
||||
* Returns the package IDs of all services currently installed on the system.
|
||||
* Useful for discovering available services for optional integrations.
|
||||
*
|
||||
* @returns Promise resolving to array of installed package IDs
|
||||
*/
|
||||
getInstalledPackages(): Promise<string[]>
|
||||
/** Returns the manifest of a service */
|
||||
|
||||
/**
|
||||
* Retrieves the manifest of another installed service.
|
||||
* Use this to inspect another service's metadata, version, or capabilities.
|
||||
*
|
||||
* @param options.packageId - The package ID to retrieve the manifest for
|
||||
* @param options.callback - Optional callback invoked when the manifest changes (for reactive updates)
|
||||
* @returns Promise resolving to the service's manifest
|
||||
*/
|
||||
getServiceManifest(options: {
|
||||
packageId: PackageId
|
||||
callback?: () => void
|
||||
}): Promise<Manifest>
|
||||
|
||||
// health
|
||||
/** sets the result of a health check */
|
||||
// ─────────────────────────────────────────────────────────────────────────────
|
||||
// Health Methods - Report service health status
|
||||
// ─────────────────────────────────────────────────────────────────────────────
|
||||
|
||||
/**
|
||||
* Reports the result of a health check to the StartOS UI.
|
||||
* Health checks appear in the service's status panel and indicate operational status.
|
||||
*
|
||||
* @param o - Health check result including the check name and result status (success/failure/starting)
|
||||
* @returns Promise resolving to null on success
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* await effects.setHealth({
|
||||
* name: 'web-interface',
|
||||
* result: { result: 'success', message: 'Web UI is accessible' }
|
||||
* })
|
||||
* ```
|
||||
*/
|
||||
setHealth(o: SetHealth): Promise<null>
|
||||
|
||||
// subcontainer
|
||||
// ─────────────────────────────────────────────────────────────────────────────
|
||||
// Subcontainer Methods - Low-level container filesystem management
|
||||
// ─────────────────────────────────────────────────────────────────────────────
|
||||
|
||||
/**
|
||||
* Low-level APIs for managing subcontainer filesystems.
|
||||
* These are typically used internally by the SubContainer class.
|
||||
* Service developers should use `sdk.SubContainer.of()` instead.
|
||||
*/
|
||||
subcontainer: {
|
||||
/** A low level api used by SubContainer */
|
||||
/**
|
||||
* Creates a new container filesystem from a Docker image.
|
||||
* This is a low-level API - prefer using `sdk.SubContainer.of()` for most use cases.
|
||||
*
|
||||
* @param options.imageId - The Docker image ID to create the filesystem from
|
||||
* @param options.name - Optional name for the container (null for anonymous)
|
||||
* @returns Promise resolving to a tuple of [guid, rootPath] for the created filesystem
|
||||
*/
|
||||
createFs(options: {
|
||||
imageId: string
|
||||
name: string | null
|
||||
}): Promise<[string, string]>
|
||||
/** A low level api used by SubContainer */
|
||||
|
||||
/**
|
||||
* Destroys a container filesystem and cleans up its resources.
|
||||
* This is a low-level API - SubContainer handles cleanup automatically.
|
||||
*
|
||||
* @param options.guid - The unique identifier of the filesystem to destroy
|
||||
* @returns Promise resolving to null on success
|
||||
*/
|
||||
destroyFs(options: { guid: string }): Promise<null>
|
||||
}
|
||||
|
||||
// net
|
||||
// bind
|
||||
/** Creates a host connected to the specified port with the provided options */
|
||||
// ─────────────────────────────────────────────────────────────────────────────
|
||||
// Network Methods - Port binding, host info, and network configuration
|
||||
// ─────────────────────────────────────────────────────────────────────────────
|
||||
|
||||
/**
|
||||
* Binds a network port and creates a host entry for the service.
|
||||
* This makes the port accessible via the StartOS networking layer (Tor, LAN, etc.).
|
||||
*
|
||||
* @param options - Binding configuration including host ID, port, protocol, and network options
|
||||
* @returns Promise resolving to null on success
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* await effects.bind({
|
||||
* id: 'webui',
|
||||
* internalPort: 8080,
|
||||
* protocol: 'http'
|
||||
* })
|
||||
* ```
|
||||
*/
|
||||
bind(options: BindParams): Promise<null>
|
||||
/** Get the port address for a service */
|
||||
|
||||
/**
|
||||
* Gets the network address information for accessing a service's port.
|
||||
* Use this to discover how to connect to another service's exposed port.
|
||||
*
|
||||
* @param options.packageId - Target package (defaults to current package if omitted)
|
||||
* @param options.hostId - The host identifier for the binding
|
||||
* @param options.internalPort - The internal port number
|
||||
* @returns Promise resolving to network info including addresses and ports
|
||||
*/
|
||||
getServicePortForward(options: {
|
||||
packageId?: PackageId
|
||||
hostId: HostId
|
||||
internalPort: number
|
||||
}): Promise<NetInfo>
|
||||
/** Removes all network bindings, called in the setupInputSpec */
|
||||
|
||||
/**
|
||||
* Removes all network bindings except those specified.
|
||||
* Typically called during initialization to clean up stale bindings before re-registering.
|
||||
*
|
||||
* @param options.except - Array of bindings to preserve (by host ID and port)
|
||||
* @returns Promise resolving to null on success
|
||||
*/
|
||||
clearBindings(options: {
|
||||
except: { id: HostId; internalPort: number }[]
|
||||
}): Promise<null>
|
||||
// host
|
||||
/** Returns information about the specified host, if it exists */
|
||||
|
||||
// ─────────────────────────────────────────────────────────────────────────────
|
||||
// Host Info Methods - Query network host and address information
|
||||
// ─────────────────────────────────────────────────────────────────────────────
|
||||
|
||||
/**
|
||||
* Retrieves detailed information about a network host binding.
|
||||
*
|
||||
* @param options.packageId - Target package (defaults to current package if omitted)
|
||||
* @param options.hostId - The host identifier to query
|
||||
* @param options.callback - Optional callback invoked when host info changes (for reactive updates)
|
||||
* @returns Promise resolving to host information, or null if the host doesn't exist
|
||||
*/
|
||||
getHostInfo(options: {
|
||||
packageId?: PackageId
|
||||
hostId: HostId
|
||||
callback?: () => void
|
||||
}): Promise<Host | null>
|
||||
/** Returns the IP address of the container */
|
||||
|
||||
/**
|
||||
* Returns the internal IP address of the service's container.
|
||||
* Useful for configuring services that need to know their own network address.
|
||||
*
|
||||
* @param options.packageId - Target package (defaults to current package if omitted)
|
||||
* @param options.callback - Optional callback invoked when the IP changes
|
||||
* @returns Promise resolving to the container's IP address string
|
||||
*/
|
||||
getContainerIp(options: {
|
||||
packageId?: PackageId
|
||||
callback?: () => void
|
||||
}): Promise<string>
|
||||
/** Returns the IP address of StartOS */
|
||||
|
||||
/**
|
||||
* Returns the IP address of the StartOS host system.
|
||||
* Useful for services that need to communicate with the host or other system services.
|
||||
*
|
||||
* @returns Promise resolving to the StartOS IP address string
|
||||
*/
|
||||
getOsIp(): Promise<string>
|
||||
// interface
|
||||
/** Creates an interface bound to a specific host and port to show to the user */
|
||||
|
||||
// ─────────────────────────────────────────────────────────────────────────────
|
||||
// Service Interface Methods - Expose and discover service endpoints
|
||||
// ─────────────────────────────────────────────────────────────────────────────
|
||||
|
||||
/**
|
||||
* Exports a service interface that appears in the StartOS UI.
|
||||
* Service interfaces are the user-visible endpoints (web UIs, APIs, etc.) that users
|
||||
* can click to access the service.
|
||||
*
|
||||
* @param options - Interface configuration including ID, name, description, type, and associated host/port
|
||||
* @returns Promise resolving to null on success
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* await effects.exportServiceInterface({
|
||||
* id: 'webui',
|
||||
* name: 'Web Interface',
|
||||
* description: 'Access the web dashboard',
|
||||
* type: 'ui',
|
||||
* hostId: 'main',
|
||||
* internalPort: 8080
|
||||
* })
|
||||
* ```
|
||||
*/
|
||||
exportServiceInterface(options: ExportServiceInterfaceParams): Promise<null>
|
||||
/** Returns an exported service interface */
|
||||
|
||||
/**
|
||||
* Retrieves information about an exported service interface.
|
||||
*
|
||||
* @param options.packageId - Target package (defaults to current package if omitted)
|
||||
* @param options.serviceInterfaceId - The interface identifier to query
|
||||
* @param options.callback - Optional callback invoked when the interface changes
|
||||
* @returns Promise resolving to the interface info, or null if it doesn't exist
|
||||
*/
|
||||
getServiceInterface(options: {
|
||||
packageId?: PackageId
|
||||
serviceInterfaceId: ServiceInterfaceId
|
||||
callback?: () => void
|
||||
}): Promise<ServiceInterface | null>
|
||||
/** Returns all exported service interfaces for a package */
|
||||
|
||||
/**
|
||||
* Lists all exported service interfaces for a package.
|
||||
* Useful for discovering what endpoints another service exposes.
|
||||
*
|
||||
* @param options.packageId - Target package (defaults to current package if omitted)
|
||||
* @param options.callback - Optional callback invoked when any interface changes
|
||||
* @returns Promise resolving to a record mapping interface IDs to their configurations
|
||||
*/
|
||||
listServiceInterfaces(options: {
|
||||
packageId?: PackageId
|
||||
callback?: () => void
|
||||
}): Promise<Record<ServiceInterfaceId, ServiceInterface>>
|
||||
/** Removes all service interfaces */
|
||||
|
||||
/**
|
||||
* Removes all service interfaces except those specified.
|
||||
* Typically called during initialization to clean up stale interfaces before re-registering.
|
||||
*
|
||||
* @param options.except - Array of interface IDs to preserve
|
||||
* @returns Promise resolving to null on success
|
||||
*/
|
||||
clearServiceInterfaces(options: {
|
||||
except: ServiceInterfaceId[]
|
||||
}): Promise<null>
|
||||
// ssl
|
||||
/** Returns a PEM encoded fullchain for the hostnames specified */
|
||||
|
||||
// ─────────────────────────────────────────────────────────────────────────────
|
||||
// SSL Methods - Manage TLS certificates
|
||||
// ─────────────────────────────────────────────────────────────────────────────
|
||||
|
||||
/**
|
||||
* Retrieves a PEM-encoded SSL certificate chain for the specified hostnames.
|
||||
* StartOS automatically manages certificate generation and renewal.
|
||||
*
|
||||
* @param options.hostnames - Array of hostnames the certificate should cover
|
||||
* @param options.algorithm - Signing algorithm: "ecdsa" (default) or "ed25519"
|
||||
* @param options.callback - Optional callback invoked when the certificate is renewed
|
||||
* @returns Promise resolving to a tuple of [certificate, chain, fullchain] PEM strings
|
||||
*/
|
||||
getSslCertificate: (options: {
|
||||
hostnames: string[]
|
||||
algorithm?: 'ecdsa' | 'ed25519'
|
||||
algorithm?: "ecdsa" | "ed25519"
|
||||
callback?: () => void
|
||||
}) => Promise<[string, string, string]>
|
||||
/** Returns a PEM encoded private key corresponding to the certificate for the hostnames specified */
|
||||
|
||||
/**
|
||||
* Retrieves the PEM-encoded private key corresponding to the SSL certificate.
|
||||
*
|
||||
* @param options.hostnames - Array of hostnames (must match a previous getSslCertificate call)
|
||||
* @param options.algorithm - Signing algorithm: "ecdsa" (default) or "ed25519"
|
||||
* @returns Promise resolving to the private key PEM string
|
||||
*/
|
||||
getSslKey: (options: {
|
||||
hostnames: string[]
|
||||
algorithm?: 'ecdsa' | 'ed25519'
|
||||
algorithm?: "ecdsa" | "ed25519"
|
||||
}) => Promise<string>
|
||||
|
||||
/** sets the version that this service's data has been migrated to */
|
||||
// ─────────────────────────────────────────────────────────────────────────────
|
||||
// Data Version Methods - Track data migration state
|
||||
// ─────────────────────────────────────────────────────────────────────────────
|
||||
|
||||
/**
|
||||
* Sets the version that this service's data has been migrated to.
|
||||
* Used by the version migration system to track which migrations have been applied.
|
||||
* Service developers typically don't call this directly - it's managed by the version graph.
|
||||
*
|
||||
* @param options.version - The version string to record, or null to clear
|
||||
* @returns Promise resolving to null on success
|
||||
*/
|
||||
setDataVersion(options: { version: string | null }): Promise<null>
|
||||
/** returns the version that this service's data has been migrated to */
|
||||
|
||||
/**
|
||||
* Returns the version that this service's data has been migrated to.
|
||||
* Used to determine which migrations need to be applied during updates.
|
||||
*
|
||||
* @returns Promise resolving to the current data version string, or null if not set
|
||||
*/
|
||||
getDataVersion(): Promise<string | null>
|
||||
|
||||
// system
|
||||
/** Returns globally configured SMTP settings, if they exist */
|
||||
// ─────────────────────────────────────────────────────────────────────────────
|
||||
// System Methods - Access system-wide configuration
|
||||
// ─────────────────────────────────────────────────────────────────────────────
|
||||
|
||||
/**
|
||||
* Retrieves the globally configured SMTP settings from StartOS.
|
||||
* Users can configure SMTP in the StartOS settings for services to use for sending emails.
|
||||
*
|
||||
* @param options.callback - Optional callback invoked when SMTP settings change (for reactive updates)
|
||||
* @returns Promise resolving to SMTP configuration, or null if not configured
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* const smtp = await effects.getSystemSmtp({})
|
||||
* if (smtp) {
|
||||
* console.log(`SMTP server: ${smtp.server}:${smtp.port}`)
|
||||
* console.log(`From address: ${smtp.from}`)
|
||||
* }
|
||||
* ```
|
||||
*/
|
||||
getSystemSmtp(options: { callback?: () => void }): Promise<SmtpValue | null>
|
||||
}
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
import * as T from '../types'
|
||||
import * as IST from '../actions/input/inputSpecTypes'
|
||||
import { Action, ActionInfo } from './setupActions'
|
||||
import { ExtractInputSpecType } from './input/builder/inputSpec'
|
||||
import * as T from "../types"
|
||||
import * as IST from "../actions/input/inputSpecTypes"
|
||||
import { Action, ActionInfo } from "./setupActions"
|
||||
import { ExtractInputSpecType } from "./input/builder/inputSpec"
|
||||
|
||||
export type RunActionInput<Input> =
|
||||
| Input
|
||||
@@ -53,17 +53,17 @@ type TaskBase = {
|
||||
replayId?: string
|
||||
}
|
||||
type TaskInput<T extends ActionInfo<T.ActionId, any>> = {
|
||||
kind: 'partial'
|
||||
kind: "partial"
|
||||
value: T.DeepPartial<GetActionInputType<T>>
|
||||
}
|
||||
export type TaskOptions<T extends ActionInfo<T.ActionId, any>> = TaskBase &
|
||||
(
|
||||
| {
|
||||
when?: Exclude<T.TaskTrigger, { condition: 'input-not-matches' }>
|
||||
when?: Exclude<T.TaskTrigger, { condition: "input-not-matches" }>
|
||||
input?: TaskInput<T>
|
||||
}
|
||||
| {
|
||||
when: T.TaskTrigger & { condition: 'input-not-matches' }
|
||||
when: T.TaskTrigger & { condition: "input-not-matches" }
|
||||
input: TaskInput<T>
|
||||
}
|
||||
)
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import { InputSpec } from './inputSpec'
|
||||
import { List } from './list'
|
||||
import { Value } from './value'
|
||||
import { Variants } from './variants'
|
||||
import { InputSpec } from "./inputSpec"
|
||||
import { List } from "./list"
|
||||
import { Value } from "./value"
|
||||
import { Variants } from "./variants"
|
||||
|
||||
export { InputSpec as InputSpec, List, Value, Variants }
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
import { ValueSpec } from '../inputSpecTypes'
|
||||
import { Value } from './value'
|
||||
import { _ } from '../../../util'
|
||||
import { Effects } from '../../../Effects'
|
||||
import { Parser, object } from 'ts-matches'
|
||||
import { DeepPartial } from '../../../types'
|
||||
import { ValueSpec } from "../inputSpecTypes"
|
||||
import { Value } from "./value"
|
||||
import { _ } from "../../../util"
|
||||
import { Effects } from "../../../Effects"
|
||||
import { Parser, object } from "ts-matches"
|
||||
import { DeepPartial } from "../../../types"
|
||||
|
||||
export type LazyBuildOptions = {
|
||||
effects: Effects
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { InputSpec, LazyBuild } from './inputSpec'
|
||||
import { InputSpec, LazyBuild } from "./inputSpec"
|
||||
import {
|
||||
ListValueSpecText,
|
||||
Pattern,
|
||||
@@ -6,8 +6,8 @@ import {
|
||||
UniqueBy,
|
||||
ValueSpecList,
|
||||
ValueSpecListOf,
|
||||
} from '../inputSpecTypes'
|
||||
import { Parser, arrayOf, string } from 'ts-matches'
|
||||
} from "../inputSpecTypes"
|
||||
import { Parser, arrayOf, string } from "ts-matches"
|
||||
|
||||
export class List<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
private constructor(
|
||||
@@ -55,7 +55,7 @@ export class List<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
* @description Informs the browser how to behave and which keyboard to display on mobile
|
||||
* @default "text"
|
||||
*/
|
||||
inputmode?: ListValueSpecText['inputmode']
|
||||
inputmode?: ListValueSpecText["inputmode"]
|
||||
/**
|
||||
* @description Displays a button that will generate a random string according to the provided charset and len attributes.
|
||||
*/
|
||||
@@ -65,21 +65,21 @@ export class List<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
const validator = arrayOf(string)
|
||||
return new List<string[]>(() => {
|
||||
const spec = {
|
||||
type: 'text' as const,
|
||||
type: "text" as const,
|
||||
placeholder: null,
|
||||
minLength: null,
|
||||
maxLength: null,
|
||||
masked: false,
|
||||
inputmode: 'text' as const,
|
||||
inputmode: "text" as const,
|
||||
generate: null,
|
||||
patterns: aSpec.patterns || [],
|
||||
...aSpec,
|
||||
}
|
||||
const built: ValueSpecListOf<'text'> = {
|
||||
const built: ValueSpecListOf<"text"> = {
|
||||
description: null,
|
||||
warning: null,
|
||||
default: [],
|
||||
type: 'list' as const,
|
||||
type: "list" as const,
|
||||
minLength: null,
|
||||
maxLength: null,
|
||||
disabled: false,
|
||||
@@ -106,7 +106,7 @@ export class List<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
minLength?: number | null
|
||||
maxLength?: number | null
|
||||
patterns?: Pattern[]
|
||||
inputmode?: ListValueSpecText['inputmode']
|
||||
inputmode?: ListValueSpecText["inputmode"]
|
||||
}
|
||||
}>,
|
||||
) {
|
||||
@@ -114,21 +114,21 @@ export class List<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
return new List<string[]>(async (options) => {
|
||||
const { spec: aSpec, ...a } = await getA(options)
|
||||
const spec = {
|
||||
type: 'text' as const,
|
||||
type: "text" as const,
|
||||
placeholder: null,
|
||||
minLength: null,
|
||||
maxLength: null,
|
||||
masked: false,
|
||||
inputmode: 'text' as const,
|
||||
inputmode: "text" as const,
|
||||
generate: null,
|
||||
patterns: aSpec.patterns || [],
|
||||
...aSpec,
|
||||
}
|
||||
const built: ValueSpecListOf<'text'> = {
|
||||
const built: ValueSpecListOf<"text"> = {
|
||||
description: null,
|
||||
warning: null,
|
||||
default: [],
|
||||
type: 'list' as const,
|
||||
type: "list" as const,
|
||||
minLength: null,
|
||||
maxLength: null,
|
||||
disabled: false,
|
||||
@@ -162,7 +162,7 @@ export class List<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
const { spec: previousSpecSpec, ...restSpec } = aSpec
|
||||
const built = await previousSpecSpec.build(options)
|
||||
const spec = {
|
||||
type: 'object' as const,
|
||||
type: "object" as const,
|
||||
displayAs: null,
|
||||
uniqueBy: null,
|
||||
...restSpec,
|
||||
@@ -179,7 +179,7 @@ export class List<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
warning: null,
|
||||
minLength: null,
|
||||
maxLength: null,
|
||||
type: 'list' as const,
|
||||
type: "list" as const,
|
||||
disabled: false,
|
||||
...value,
|
||||
},
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import { InputSpec, LazyBuild } from './inputSpec'
|
||||
import { List } from './list'
|
||||
import { UnionRes, UnionResStaticValidatedAs, Variants } from './variants'
|
||||
import { InputSpec, LazyBuild } from "./inputSpec"
|
||||
import { List } from "./list"
|
||||
import { UnionRes, UnionResStaticValidatedAs, Variants } from "./variants"
|
||||
import {
|
||||
Pattern,
|
||||
RandomString,
|
||||
@@ -9,9 +9,9 @@ import {
|
||||
ValueSpecHidden,
|
||||
ValueSpecText,
|
||||
ValueSpecTextarea,
|
||||
} from '../inputSpecTypes'
|
||||
import { DefaultString } from '../inputSpecTypes'
|
||||
import { _, once } from '../../../util'
|
||||
} from "../inputSpecTypes"
|
||||
import { DefaultString } from "../inputSpecTypes"
|
||||
import { _, once } from "../../../util"
|
||||
import {
|
||||
Parser,
|
||||
any,
|
||||
@@ -23,8 +23,8 @@ import {
|
||||
number,
|
||||
object,
|
||||
string,
|
||||
} from 'ts-matches'
|
||||
import { DeepPartial } from '../../../types'
|
||||
} from "ts-matches"
|
||||
import { DeepPartial } from "../../../types"
|
||||
|
||||
export const fileInfoParser = object({
|
||||
path: string,
|
||||
@@ -42,7 +42,7 @@ const testForAsRequiredParser = once(
|
||||
function asRequiredParser<Type, Input extends { required: boolean }>(
|
||||
parser: Parser<unknown, Type>,
|
||||
input: Input,
|
||||
): Parser<unknown, AsRequired<Type, Input['required']>> {
|
||||
): Parser<unknown, AsRequired<Type, Input["required"]>> {
|
||||
if (testForAsRequiredParser()(input)) return parser as any
|
||||
return parser.nullable() as any
|
||||
}
|
||||
@@ -92,7 +92,7 @@ export class Value<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
spec: {
|
||||
description: null,
|
||||
warning: null,
|
||||
type: 'toggle' as const,
|
||||
type: "toggle" as const,
|
||||
disabled: false,
|
||||
immutable: a.immutable ?? false,
|
||||
...a,
|
||||
@@ -117,7 +117,7 @@ export class Value<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
spec: {
|
||||
description: null,
|
||||
warning: null,
|
||||
type: 'toggle' as const,
|
||||
type: "toggle" as const,
|
||||
disabled: false,
|
||||
immutable: false,
|
||||
...(await a(options)),
|
||||
@@ -191,7 +191,7 @@ export class Value<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
* @description Informs the browser how to behave and which keyboard to display on mobile
|
||||
* @default "text"
|
||||
*/
|
||||
inputmode?: ValueSpecText['inputmode']
|
||||
inputmode?: ValueSpecText["inputmode"]
|
||||
/**
|
||||
* @description Once set, the value can never be changed.
|
||||
* @default false
|
||||
@@ -206,7 +206,7 @@ export class Value<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
return new Value<AsRequired<string, Required>>(
|
||||
async () => ({
|
||||
spec: {
|
||||
type: 'text' as const,
|
||||
type: "text" as const,
|
||||
description: null,
|
||||
warning: null,
|
||||
masked: false,
|
||||
@@ -214,7 +214,7 @@ export class Value<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
minLength: null,
|
||||
maxLength: null,
|
||||
patterns: [],
|
||||
inputmode: 'text',
|
||||
inputmode: "text",
|
||||
disabled: false,
|
||||
immutable: a.immutable ?? false,
|
||||
generate: a.generate ?? null,
|
||||
@@ -237,7 +237,7 @@ export class Value<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
minLength?: number | null
|
||||
maxLength?: number | null
|
||||
patterns?: Pattern[]
|
||||
inputmode?: ValueSpecText['inputmode']
|
||||
inputmode?: ValueSpecText["inputmode"]
|
||||
disabled?: string | false
|
||||
generate?: null | RandomString
|
||||
}>,
|
||||
@@ -247,7 +247,7 @@ export class Value<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
const a = await getA(options)
|
||||
return {
|
||||
spec: {
|
||||
type: 'text' as const,
|
||||
type: "text" as const,
|
||||
description: null,
|
||||
warning: null,
|
||||
masked: false,
|
||||
@@ -255,7 +255,7 @@ export class Value<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
minLength: null,
|
||||
maxLength: null,
|
||||
patterns: [],
|
||||
inputmode: 'text',
|
||||
inputmode: "text",
|
||||
disabled: false,
|
||||
immutable: false,
|
||||
generate: a.generate ?? null,
|
||||
@@ -334,7 +334,7 @@ export class Value<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
minRows: 3,
|
||||
maxRows: 6,
|
||||
placeholder: null,
|
||||
type: 'textarea' as const,
|
||||
type: "textarea" as const,
|
||||
disabled: false,
|
||||
immutable: a.immutable ?? false,
|
||||
...a,
|
||||
@@ -371,7 +371,7 @@ export class Value<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
minRows: 3,
|
||||
maxRows: 6,
|
||||
placeholder: null,
|
||||
type: 'textarea' as const,
|
||||
type: "textarea" as const,
|
||||
disabled: false,
|
||||
immutable: false,
|
||||
...a,
|
||||
@@ -444,7 +444,7 @@ export class Value<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
return new Value<AsRequired<number, Required>>(
|
||||
() => ({
|
||||
spec: {
|
||||
type: 'number' as const,
|
||||
type: "number" as const,
|
||||
description: null,
|
||||
warning: null,
|
||||
min: null,
|
||||
@@ -482,7 +482,7 @@ export class Value<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
const a = await getA(options)
|
||||
return {
|
||||
spec: {
|
||||
type: 'number' as const,
|
||||
type: "number" as const,
|
||||
description: null,
|
||||
warning: null,
|
||||
min: null,
|
||||
@@ -540,7 +540,7 @@ export class Value<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
return new Value<AsRequired<string, Required>>(
|
||||
() => ({
|
||||
spec: {
|
||||
type: 'color' as const,
|
||||
type: "color" as const,
|
||||
description: null,
|
||||
warning: null,
|
||||
disabled: false,
|
||||
@@ -568,7 +568,7 @@ export class Value<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
const a = await getA(options)
|
||||
return {
|
||||
spec: {
|
||||
type: 'color' as const,
|
||||
type: "color" as const,
|
||||
description: null,
|
||||
warning: null,
|
||||
disabled: false,
|
||||
@@ -618,7 +618,7 @@ export class Value<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
* @description Informs the browser how to behave and which date/time component to display.
|
||||
* @default "datetime-local"
|
||||
*/
|
||||
inputmode?: ValueSpecDatetime['inputmode']
|
||||
inputmode?: ValueSpecDatetime["inputmode"]
|
||||
min?: string | null
|
||||
max?: string | null
|
||||
/**
|
||||
@@ -631,10 +631,10 @@ export class Value<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
return new Value<AsRequired<string, Required>>(
|
||||
() => ({
|
||||
spec: {
|
||||
type: 'datetime' as const,
|
||||
type: "datetime" as const,
|
||||
description: null,
|
||||
warning: null,
|
||||
inputmode: 'datetime-local',
|
||||
inputmode: "datetime-local",
|
||||
min: null,
|
||||
max: null,
|
||||
step: null,
|
||||
@@ -654,7 +654,7 @@ export class Value<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
warning?: string | null
|
||||
default: string | null
|
||||
required: Required
|
||||
inputmode?: ValueSpecDatetime['inputmode']
|
||||
inputmode?: ValueSpecDatetime["inputmode"]
|
||||
min?: string | null
|
||||
max?: string | null
|
||||
disabled?: false | string
|
||||
@@ -665,10 +665,10 @@ export class Value<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
const a = await getA(options)
|
||||
return {
|
||||
spec: {
|
||||
type: 'datetime' as const,
|
||||
type: "datetime" as const,
|
||||
description: null,
|
||||
warning: null,
|
||||
inputmode: 'datetime-local',
|
||||
inputmode: "datetime-local",
|
||||
min: null,
|
||||
max: null,
|
||||
disabled: false,
|
||||
@@ -740,7 +740,7 @@ export class Value<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
spec: {
|
||||
description: null,
|
||||
warning: null,
|
||||
type: 'select' as const,
|
||||
type: "select" as const,
|
||||
disabled: false,
|
||||
immutable: a.immutable ?? false,
|
||||
...a,
|
||||
@@ -766,7 +766,7 @@ export class Value<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
spec: {
|
||||
description: null,
|
||||
warning: null,
|
||||
type: 'select' as const,
|
||||
type: "select" as const,
|
||||
disabled: false,
|
||||
immutable: false,
|
||||
...a,
|
||||
@@ -837,7 +837,7 @@ export class Value<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
return new Value<(keyof Values & string)[]>(
|
||||
() => ({
|
||||
spec: {
|
||||
type: 'multiselect' as const,
|
||||
type: "multiselect" as const,
|
||||
minLength: null,
|
||||
maxLength: null,
|
||||
warning: null,
|
||||
@@ -867,7 +867,7 @@ export class Value<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
const a = await getA(options)
|
||||
return {
|
||||
spec: {
|
||||
type: 'multiselect' as const,
|
||||
type: "multiselect" as const,
|
||||
minLength: null,
|
||||
maxLength: null,
|
||||
warning: null,
|
||||
@@ -915,7 +915,7 @@ export class Value<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
const built = await spec.build(options as any)
|
||||
return {
|
||||
spec: {
|
||||
type: 'object' as const,
|
||||
type: "object" as const,
|
||||
description: null,
|
||||
warning: null,
|
||||
...a,
|
||||
@@ -933,7 +933,7 @@ export class Value<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
required: Required
|
||||
}) {
|
||||
const buildValue = {
|
||||
type: 'file' as const,
|
||||
type: "file" as const,
|
||||
description: null,
|
||||
warning: null,
|
||||
...a,
|
||||
@@ -960,7 +960,7 @@ export class Value<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
return new Value<AsRequired<FileInfo, Required>, FileInfo | null>(
|
||||
async (options) => {
|
||||
const spec = {
|
||||
type: 'file' as const,
|
||||
type: "file" as const,
|
||||
description: null,
|
||||
warning: null,
|
||||
...(await a(options)),
|
||||
@@ -1034,7 +1034,7 @@ export class Value<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
const built = await a.variants.build(options as any)
|
||||
return {
|
||||
spec: {
|
||||
type: 'union' as const,
|
||||
type: "union" as const,
|
||||
description: null,
|
||||
warning: null,
|
||||
disabled: false,
|
||||
@@ -1109,7 +1109,7 @@ export class Value<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
const built = await newValues.variants.build(options as any)
|
||||
return {
|
||||
spec: {
|
||||
type: 'union' as const,
|
||||
type: "union" as const,
|
||||
description: null,
|
||||
warning: null,
|
||||
...newValues,
|
||||
@@ -1202,7 +1202,7 @@ export class Value<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
return new Value<T, typeof parser._TYPE>(async () => {
|
||||
return {
|
||||
spec: {
|
||||
type: 'hidden' as const,
|
||||
type: "hidden" as const,
|
||||
} as ValueSpecHidden,
|
||||
validator: parser,
|
||||
}
|
||||
@@ -1221,7 +1221,7 @@ export class Value<Type extends StaticValidatedAs, StaticValidatedAs = Type> {
|
||||
const validator = await getParser(options)
|
||||
return {
|
||||
spec: {
|
||||
type: 'hidden' as const,
|
||||
type: "hidden" as const,
|
||||
} as ValueSpecHidden,
|
||||
validator,
|
||||
}
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
import { DeepPartial } from '../../../types'
|
||||
import { ValueSpec, ValueSpecUnion } from '../inputSpecTypes'
|
||||
import { DeepPartial } from "../../../types"
|
||||
import { ValueSpec, ValueSpecUnion } from "../inputSpecTypes"
|
||||
import {
|
||||
LazyBuild,
|
||||
InputSpec,
|
||||
ExtractInputSpecType,
|
||||
ExtractInputSpecStaticValidatedAs,
|
||||
} from './inputSpec'
|
||||
import { Parser, any, anyOf, literal, object } from 'ts-matches'
|
||||
} from "./inputSpec"
|
||||
import { Parser, any, anyOf, literal, object } from "ts-matches"
|
||||
|
||||
export type UnionRes<
|
||||
VariantValues extends {
|
||||
@@ -19,10 +19,10 @@ export type UnionRes<
|
||||
> = {
|
||||
[key in keyof VariantValues]: {
|
||||
selection: key
|
||||
value: ExtractInputSpecType<VariantValues[key]['spec']>
|
||||
value: ExtractInputSpecType<VariantValues[key]["spec"]>
|
||||
other?: {
|
||||
[key2 in Exclude<keyof VariantValues & string, key>]?: DeepPartial<
|
||||
ExtractInputSpecType<VariantValues[key2]['spec']>
|
||||
ExtractInputSpecType<VariantValues[key2]["spec"]>
|
||||
>
|
||||
}
|
||||
}
|
||||
@@ -39,10 +39,10 @@ export type UnionResStaticValidatedAs<
|
||||
> = {
|
||||
[key in keyof VariantValues]: {
|
||||
selection: key
|
||||
value: ExtractInputSpecStaticValidatedAs<VariantValues[key]['spec']>
|
||||
value: ExtractInputSpecStaticValidatedAs<VariantValues[key]["spec"]>
|
||||
other?: {
|
||||
[key2 in Exclude<keyof VariantValues & string, key>]?: DeepPartial<
|
||||
ExtractInputSpecStaticValidatedAs<VariantValues[key2]['spec']>
|
||||
ExtractInputSpecStaticValidatedAs<VariantValues[key2]["spec"]>
|
||||
>
|
||||
}
|
||||
}
|
||||
@@ -106,7 +106,7 @@ export class Variants<
|
||||
> {
|
||||
private constructor(
|
||||
public build: LazyBuild<{
|
||||
spec: ValueSpecUnion['variants']
|
||||
spec: ValueSpecUnion["variants"]
|
||||
validator: Parser<unknown, UnionRes<VariantValues>>
|
||||
}>,
|
||||
public readonly validator: Parser<
|
||||
@@ -126,7 +126,7 @@ export class Variants<
|
||||
const staticValidators = {} as {
|
||||
[K in keyof VariantValues]: Parser<
|
||||
unknown,
|
||||
ExtractInputSpecStaticValidatedAs<VariantValues[K]['spec']>
|
||||
ExtractInputSpecStaticValidatedAs<VariantValues[K]["spec"]>
|
||||
>
|
||||
}
|
||||
for (const key in a) {
|
||||
@@ -143,7 +143,7 @@ export class Variants<
|
||||
const validators = {} as {
|
||||
[K in keyof VariantValues]: Parser<
|
||||
unknown,
|
||||
ExtractInputSpecType<VariantValues[K]['spec']>
|
||||
ExtractInputSpecType<VariantValues[K]["spec"]>
|
||||
>
|
||||
}
|
||||
const variants = {} as {
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
export * as constants from './inputSpecConstants'
|
||||
export * as types from './inputSpecTypes'
|
||||
export * as builder from './builder'
|
||||
export * as constants from "./inputSpecConstants"
|
||||
export * as types from "./inputSpecTypes"
|
||||
export * as builder from "./builder"
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
import { SmtpValue } from '../../types'
|
||||
import { GetSystemSmtp, Patterns } from '../../util'
|
||||
import { InputSpec, InputSpecOf } from './builder/inputSpec'
|
||||
import { Value } from './builder/value'
|
||||
import { Variants } from './builder/variants'
|
||||
import { SmtpValue } from "../../types"
|
||||
import { GetSystemSmtp, Patterns } from "../../util"
|
||||
import { InputSpec, InputSpecOf } from "./builder/inputSpec"
|
||||
import { Value } from "./builder/value"
|
||||
import { Variants } from "./builder/variants"
|
||||
|
||||
/**
|
||||
* Base SMTP settings, to be used by StartOS for system wide SMTP
|
||||
@@ -11,12 +11,12 @@ export const customSmtp: InputSpec<SmtpValue> = InputSpec.of<
|
||||
InputSpecOf<SmtpValue>
|
||||
>({
|
||||
server: Value.text({
|
||||
name: 'SMTP Server',
|
||||
name: "SMTP Server",
|
||||
required: true,
|
||||
default: null,
|
||||
}),
|
||||
port: Value.number({
|
||||
name: 'Port',
|
||||
name: "Port",
|
||||
required: true,
|
||||
default: 587,
|
||||
min: 1,
|
||||
@@ -24,20 +24,20 @@ export const customSmtp: InputSpec<SmtpValue> = InputSpec.of<
|
||||
integer: true,
|
||||
}),
|
||||
from: Value.text({
|
||||
name: 'From Address',
|
||||
name: "From Address",
|
||||
required: true,
|
||||
default: null,
|
||||
placeholder: 'Example Name <test@example.com>',
|
||||
inputmode: 'email',
|
||||
placeholder: "Example Name <test@example.com>",
|
||||
inputmode: "email",
|
||||
patterns: [Patterns.emailWithName],
|
||||
}),
|
||||
login: Value.text({
|
||||
name: 'Login',
|
||||
name: "Login",
|
||||
required: true,
|
||||
default: null,
|
||||
}),
|
||||
password: Value.text({
|
||||
name: 'Password',
|
||||
name: "Password",
|
||||
required: false,
|
||||
default: null,
|
||||
masked: true,
|
||||
@@ -45,24 +45,24 @@ export const customSmtp: InputSpec<SmtpValue> = InputSpec.of<
|
||||
})
|
||||
|
||||
const smtpVariants = Variants.of({
|
||||
disabled: { name: 'Disabled', spec: InputSpec.of({}) },
|
||||
disabled: { name: "Disabled", spec: InputSpec.of({}) },
|
||||
system: {
|
||||
name: 'System Credentials',
|
||||
name: "System Credentials",
|
||||
spec: InputSpec.of({
|
||||
customFrom: Value.text({
|
||||
name: 'Custom From Address',
|
||||
name: "Custom From Address",
|
||||
description:
|
||||
'A custom from address for this service. If not provided, the system from address will be used.',
|
||||
"A custom from address for this service. If not provided, the system from address will be used.",
|
||||
required: false,
|
||||
default: null,
|
||||
placeholder: '<name>test@example.com',
|
||||
inputmode: 'email',
|
||||
placeholder: "<name>test@example.com",
|
||||
inputmode: "email",
|
||||
patterns: [Patterns.email],
|
||||
}),
|
||||
}),
|
||||
},
|
||||
custom: {
|
||||
name: 'Custom Credentials',
|
||||
name: "Custom Credentials",
|
||||
spec: customSmtp,
|
||||
},
|
||||
})
|
||||
@@ -71,11 +71,11 @@ const smtpVariants = Variants.of({
|
||||
*/
|
||||
export const smtpInputSpec = Value.dynamicUnion(async ({ effects }) => {
|
||||
const smtp = await new GetSystemSmtp(effects).once()
|
||||
const disabled = smtp ? [] : ['system']
|
||||
const disabled = smtp ? [] : ["system"]
|
||||
return {
|
||||
name: 'SMTP',
|
||||
description: 'Optionally provide an SMTP server for sending emails',
|
||||
default: 'disabled',
|
||||
name: "SMTP",
|
||||
description: "Optionally provide an SMTP server for sending emails",
|
||||
default: "disabled",
|
||||
disabled,
|
||||
variants: smtpVariants,
|
||||
}
|
||||
|
||||
@@ -1,200 +1,417 @@
|
||||
/**
|
||||
* @module inputSpecTypes
|
||||
*
|
||||
* This module defines the type specifications for action input form fields.
|
||||
* These types describe the shape of form fields that appear in the StartOS UI
|
||||
* when users interact with service actions.
|
||||
*
|
||||
* Developers typically don't create these types directly - instead, use the
|
||||
* `Value` class methods (e.g., `Value.text()`, `Value.select()`) which generate
|
||||
* these specifications with proper defaults and validation.
|
||||
*
|
||||
* @see {@link Value} for the builder API
|
||||
*/
|
||||
|
||||
/**
|
||||
* A complete input specification - a record mapping field names to their specifications.
|
||||
* This is the top-level type for an action's input form.
|
||||
*/
|
||||
export type InputSpec = Record<string, ValueSpec>
|
||||
|
||||
/**
|
||||
* All available input field types.
|
||||
*
|
||||
* - `text` - Single-line text input
|
||||
* - `textarea` - Multi-line text input
|
||||
* - `number` - Numeric input with optional min/max/step
|
||||
* - `color` - Color picker
|
||||
* - `datetime` - Date and/or time picker
|
||||
* - `toggle` - Boolean on/off switch
|
||||
* - `select` - Single-selection dropdown/radio
|
||||
* - `multiselect` - Multiple-selection checkboxes
|
||||
* - `list` - Dynamic list of items (text or objects)
|
||||
* - `object` - Nested group of fields (sub-form)
|
||||
* - `file` - File upload
|
||||
* - `union` - Conditional fields based on selection (discriminated union)
|
||||
* - `hidden` - Hidden field (not displayed to user)
|
||||
*/
|
||||
export type ValueType =
|
||||
| 'text'
|
||||
| 'textarea'
|
||||
| 'number'
|
||||
| 'color'
|
||||
| 'datetime'
|
||||
| 'toggle'
|
||||
| 'select'
|
||||
| 'multiselect'
|
||||
| 'list'
|
||||
| 'object'
|
||||
| 'file'
|
||||
| 'union'
|
||||
| 'hidden'
|
||||
| "text"
|
||||
| "textarea"
|
||||
| "number"
|
||||
| "color"
|
||||
| "datetime"
|
||||
| "toggle"
|
||||
| "select"
|
||||
| "multiselect"
|
||||
| "list"
|
||||
| "object"
|
||||
| "file"
|
||||
| "union"
|
||||
| "hidden"
|
||||
|
||||
/** Union type of all possible value specifications */
|
||||
export type ValueSpec = ValueSpecOf<ValueType>
|
||||
/** core spec types. These types provide the metadata for performing validations */
|
||||
|
||||
/**
|
||||
* Maps a ValueType to its corresponding specification type.
|
||||
* Core spec types that provide metadata for validation and UI rendering.
|
||||
*/
|
||||
// prettier-ignore
|
||||
export type ValueSpecOf<T extends ValueType> =
|
||||
T extends "text" ? ValueSpecText :
|
||||
T extends "textarea" ? ValueSpecTextarea :
|
||||
T extends "number" ? ValueSpecNumber :
|
||||
T extends "color" ? ValueSpecColor :
|
||||
T extends "datetime" ? ValueSpecDatetime :
|
||||
T extends "toggle" ? ValueSpecToggle :
|
||||
T extends "select" ? ValueSpecSelect :
|
||||
T extends "multiselect" ? ValueSpecMultiselect :
|
||||
T extends "list" ? ValueSpecList :
|
||||
T extends "object" ? ValueSpecObject :
|
||||
T extends "file" ? ValueSpecFile :
|
||||
T extends "union" ? ValueSpecUnion :
|
||||
export type ValueSpecOf<T extends ValueType> =
|
||||
T extends "text" ? ValueSpecText :
|
||||
T extends "textarea" ? ValueSpecTextarea :
|
||||
T extends "number" ? ValueSpecNumber :
|
||||
T extends "color" ? ValueSpecColor :
|
||||
T extends "datetime" ? ValueSpecDatetime :
|
||||
T extends "toggle" ? ValueSpecToggle :
|
||||
T extends "select" ? ValueSpecSelect :
|
||||
T extends "multiselect" ? ValueSpecMultiselect :
|
||||
T extends "list" ? ValueSpecList :
|
||||
T extends "object" ? ValueSpecObject :
|
||||
T extends "file" ? ValueSpecFile :
|
||||
T extends "union" ? ValueSpecUnion :
|
||||
T extends "hidden" ? ValueSpecHidden :
|
||||
never
|
||||
|
||||
/**
|
||||
* Specification for a single-line text input field.
|
||||
* Use `Value.text()` to create this specification.
|
||||
*/
|
||||
export type ValueSpecText = {
|
||||
/** Display label for the field */
|
||||
name: string
|
||||
/** Help text shown below the field */
|
||||
description: string | null
|
||||
/** Warning message shown when the value changes (requires user confirmation) */
|
||||
warning: string | null
|
||||
|
||||
type: 'text'
|
||||
type: "text"
|
||||
/** Regex patterns the value must match, with descriptions for validation errors */
|
||||
patterns: Pattern[]
|
||||
/** Minimum character length */
|
||||
minLength: number | null
|
||||
/** Maximum character length */
|
||||
maxLength: number | null
|
||||
/** If true, displays input as dots (●●●) for sensitive data like passwords */
|
||||
masked: boolean
|
||||
|
||||
inputmode: 'text' | 'email' | 'tel' | 'url'
|
||||
/** Browser input mode hint for mobile keyboards */
|
||||
inputmode: "text" | "email" | "tel" | "url"
|
||||
/** Placeholder text shown when the field is empty */
|
||||
placeholder: string | null
|
||||
|
||||
/** If true, the field cannot be left empty */
|
||||
required: boolean
|
||||
/** Default value (can be a string or random string generator) */
|
||||
default: DefaultString | null
|
||||
/** If string, the field is disabled with this message explaining why */
|
||||
disabled: false | string
|
||||
/** Configuration for "Generate" button that creates random strings */
|
||||
generate: null | RandomString
|
||||
/** If true, the value cannot be changed after initial set */
|
||||
immutable: boolean
|
||||
}
|
||||
|
||||
/**
|
||||
* Specification for a multi-line text area input field.
|
||||
* Use `Value.textarea()` to create this specification.
|
||||
*/
|
||||
export type ValueSpecTextarea = {
|
||||
/** Display label for the field */
|
||||
name: string
|
||||
/** Help text shown below the field */
|
||||
description: string | null
|
||||
/** Warning message shown when the value changes */
|
||||
warning: string | null
|
||||
|
||||
type: 'textarea'
|
||||
type: "textarea"
|
||||
/** Regex patterns the value must match */
|
||||
patterns: Pattern[]
|
||||
/** Placeholder text shown when the field is empty */
|
||||
placeholder: string | null
|
||||
/** Minimum character length */
|
||||
minLength: number | null
|
||||
/** Maximum character length */
|
||||
maxLength: number | null
|
||||
/** Minimum visible rows before scrolling */
|
||||
minRows: number
|
||||
/** Maximum visible rows before scrolling */
|
||||
maxRows: number
|
||||
/** If true, the field cannot be left empty */
|
||||
required: boolean
|
||||
/** Default value */
|
||||
default: string | null
|
||||
/** If string, the field is disabled with this message */
|
||||
disabled: false | string
|
||||
/** If true, the value cannot be changed after initial set */
|
||||
immutable: boolean
|
||||
}
|
||||
|
||||
/**
|
||||
* Specification for a numeric input field.
|
||||
* Use `Value.number()` to create this specification.
|
||||
*/
|
||||
export type ValueSpecNumber = {
|
||||
type: 'number'
|
||||
type: "number"
|
||||
/** Minimum allowed value */
|
||||
min: number | null
|
||||
/** Maximum allowed value */
|
||||
max: number | null
|
||||
/** If true, only whole numbers are allowed */
|
||||
integer: boolean
|
||||
/** Increment/decrement step for arrow controls */
|
||||
step: number | null
|
||||
/** Unit label displayed after the input (e.g., "MB", "seconds") */
|
||||
units: string | null
|
||||
/** Placeholder text shown when the field is empty */
|
||||
placeholder: string | null
|
||||
/** Display label for the field */
|
||||
name: string
|
||||
/** Help text shown below the field */
|
||||
description: string | null
|
||||
/** Warning message shown when the value changes */
|
||||
warning: string | null
|
||||
/** If true, the field cannot be left empty */
|
||||
required: boolean
|
||||
/** Default value */
|
||||
default: number | null
|
||||
/** If string, the field is disabled with this message */
|
||||
disabled: false | string
|
||||
/** If true, the value cannot be changed after initial set */
|
||||
immutable: boolean
|
||||
}
|
||||
|
||||
/**
|
||||
* Specification for a color picker field.
|
||||
* Use `Value.color()` to create this specification.
|
||||
*/
|
||||
export type ValueSpecColor = {
|
||||
/** Display label for the field */
|
||||
name: string
|
||||
/** Help text shown below the field */
|
||||
description: string | null
|
||||
/** Warning message shown when the value changes */
|
||||
warning: string | null
|
||||
|
||||
type: 'color'
|
||||
type: "color"
|
||||
/** If true, a color must be selected */
|
||||
required: boolean
|
||||
/** Default color value (hex format, e.g., "ffffff") */
|
||||
default: string | null
|
||||
/** If string, the field is disabled with this message */
|
||||
disabled: false | string
|
||||
/** If true, the value cannot be changed after initial set */
|
||||
immutable: boolean
|
||||
}
|
||||
|
||||
/**
|
||||
* Specification for a date/time picker field.
|
||||
* Use `Value.datetime()` to create this specification.
|
||||
*/
|
||||
export type ValueSpecDatetime = {
|
||||
/** Display label for the field */
|
||||
name: string
|
||||
/** Help text shown below the field */
|
||||
description: string | null
|
||||
/** Warning message shown when the value changes */
|
||||
warning: string | null
|
||||
type: 'datetime'
|
||||
type: "datetime"
|
||||
/** If true, the field cannot be left empty */
|
||||
required: boolean
|
||||
inputmode: 'date' | 'time' | 'datetime-local'
|
||||
/** Type of datetime picker to display */
|
||||
inputmode: "date" | "time" | "datetime-local"
|
||||
/** Minimum allowed date/time */
|
||||
min: string | null
|
||||
/** Maximum allowed date/time */
|
||||
max: string | null
|
||||
/** Default value */
|
||||
default: string | null
|
||||
/** If string, the field is disabled with this message */
|
||||
disabled: false | string
|
||||
/** If true, the value cannot be changed after initial set */
|
||||
immutable: boolean
|
||||
}
|
||||
|
||||
/**
|
||||
* Specification for a single-selection dropdown or radio button group.
|
||||
* Use `Value.select()` to create this specification.
|
||||
*/
|
||||
export type ValueSpecSelect = {
|
||||
/** Map of option values to their display labels */
|
||||
values: Record<string, string>
|
||||
/** Display label for the field */
|
||||
name: string
|
||||
/** Help text shown below the field */
|
||||
description: string | null
|
||||
/** Warning message shown when the value changes */
|
||||
warning: string | null
|
||||
type: 'select'
|
||||
type: "select"
|
||||
/** Default selected option key */
|
||||
default: string | null
|
||||
/** Disabled state: false=enabled, string=disabled with message, string[]=specific options disabled */
|
||||
disabled: false | string | string[]
|
||||
/** If true, the value cannot be changed after initial set */
|
||||
immutable: boolean
|
||||
}
|
||||
|
||||
/**
|
||||
* Specification for a multiple-selection checkbox group.
|
||||
* Use `Value.multiselect()` to create this specification.
|
||||
*/
|
||||
export type ValueSpecMultiselect = {
|
||||
/** Map of option values to their display labels */
|
||||
values: Record<string, string>
|
||||
|
||||
/** Display label for the field */
|
||||
name: string
|
||||
/** Help text shown below the field */
|
||||
description: string | null
|
||||
/** Warning message shown when the value changes */
|
||||
warning: string | null
|
||||
|
||||
type: 'multiselect'
|
||||
type: "multiselect"
|
||||
/** Minimum number of selections required */
|
||||
minLength: number | null
|
||||
/** Maximum number of selections allowed */
|
||||
maxLength: number | null
|
||||
/** Disabled state: false=enabled, string=disabled with message, string[]=specific options disabled */
|
||||
disabled: false | string | string[]
|
||||
/** Default selected option keys */
|
||||
default: string[]
|
||||
/** If true, the value cannot be changed after initial set */
|
||||
immutable: boolean
|
||||
}
|
||||
|
||||
/**
|
||||
* Specification for a boolean toggle switch.
|
||||
* Use `Value.toggle()` to create this specification.
|
||||
*/
|
||||
export type ValueSpecToggle = {
|
||||
/** Display label for the field */
|
||||
name: string
|
||||
/** Help text shown below the field */
|
||||
description: string | null
|
||||
/** Warning message shown when the value changes */
|
||||
warning: string | null
|
||||
|
||||
type: 'toggle'
|
||||
type: "toggle"
|
||||
/** Default value (on/off) */
|
||||
default: boolean | null
|
||||
/** If string, the field is disabled with this message */
|
||||
disabled: false | string
|
||||
/** If true, the value cannot be changed after initial set */
|
||||
immutable: boolean
|
||||
}
|
||||
/**
|
||||
* Specification for a discriminated union field (conditional sub-forms).
|
||||
* Shows different fields based on which variant is selected.
|
||||
* Use `Value.union()` with `Variants.of()` to create this specification.
|
||||
*/
|
||||
export type ValueSpecUnion = {
|
||||
/** Display label for the field */
|
||||
name: string
|
||||
/** Help text shown below the field */
|
||||
description: string | null
|
||||
/** Warning message shown when the value changes */
|
||||
warning: string | null
|
||||
|
||||
type: 'union'
|
||||
type: "union"
|
||||
/** Map of variant keys to their display names and nested field specifications */
|
||||
variants: Record<
|
||||
string,
|
||||
{
|
||||
/** Display name for this variant option */
|
||||
name: string
|
||||
/** Fields to show when this variant is selected */
|
||||
spec: InputSpec
|
||||
}
|
||||
>
|
||||
/** Disabled state: false=enabled, string=disabled with message, string[]=specific variants disabled */
|
||||
disabled: false | string | string[]
|
||||
/** Default selected variant key */
|
||||
default: string | null
|
||||
/** If true, the value cannot be changed after initial set */
|
||||
immutable: boolean
|
||||
}
|
||||
|
||||
/**
|
||||
* Specification for a file upload field.
|
||||
* Use `Value.file()` to create this specification.
|
||||
*/
|
||||
export type ValueSpecFile = {
|
||||
/** Display label for the field */
|
||||
name: string
|
||||
/** Help text shown below the field */
|
||||
description: string | null
|
||||
/** Warning message shown when the value changes */
|
||||
warning: string | null
|
||||
type: 'file'
|
||||
type: "file"
|
||||
/** Allowed file extensions (e.g., [".json", ".yaml"]) */
|
||||
extensions: string[]
|
||||
/** If true, a file must be uploaded */
|
||||
required: boolean
|
||||
}
|
||||
|
||||
/**
|
||||
* Specification for a nested object (sub-form / field group).
|
||||
* Use `Value.object()` to create this specification.
|
||||
*/
|
||||
export type ValueSpecObject = {
|
||||
/** Display label for the field group */
|
||||
name: string
|
||||
/** Help text shown below the field group */
|
||||
description: string | null
|
||||
/** Warning message (not typically used for objects) */
|
||||
warning: string | null
|
||||
type: 'object'
|
||||
type: "object"
|
||||
/** Nested field specifications */
|
||||
spec: InputSpec
|
||||
}
|
||||
|
||||
/**
|
||||
* Specification for a hidden field (not displayed in the UI).
|
||||
* Use `Value.hidden()` to create this specification.
|
||||
* Useful for storing internal state that shouldn't be user-editable.
|
||||
*/
|
||||
export type ValueSpecHidden = {
|
||||
type: 'hidden'
|
||||
type: "hidden"
|
||||
}
|
||||
export type ListValueSpecType = 'text' | 'object'
|
||||
|
||||
/** Types of items that can appear in a list */
|
||||
export type ListValueSpecType = "text" | "object"
|
||||
|
||||
/** Maps a list item type to its specification */
|
||||
// prettier-ignore
|
||||
export type ListValueSpecOf<T extends ListValueSpecType> =
|
||||
export type ListValueSpecOf<T extends ListValueSpecType> =
|
||||
T extends "text" ? ListValueSpecText :
|
||||
T extends "object" ? ListValueSpecObject :
|
||||
never
|
||||
|
||||
/** Union of all list specification types */
|
||||
export type ValueSpecList = ValueSpecListOf<ListValueSpecType>
|
||||
|
||||
/**
|
||||
* Specification for a dynamic list of items.
|
||||
* Use `Value.list()` with `List.text()` or `List.obj()` to create this specification.
|
||||
*/
|
||||
export type ValueSpecListOf<T extends ListValueSpecType> = {
|
||||
/** Display label for the list field */
|
||||
name: string
|
||||
/** Help text shown below the list */
|
||||
description: string | null
|
||||
/** Warning message shown when items change */
|
||||
warning: string | null
|
||||
type: 'list'
|
||||
type: "list"
|
||||
/** Specification for individual list items */
|
||||
spec: ListValueSpecOf<T>
|
||||
/** Minimum number of items required */
|
||||
minLength: number | null
|
||||
/** Maximum number of items allowed */
|
||||
maxLength: number | null
|
||||
/** If string, the list is disabled with this message */
|
||||
disabled: false | string
|
||||
/** Default list items */
|
||||
default:
|
||||
| string[]
|
||||
| DefaultString[]
|
||||
@@ -203,28 +420,62 @@ export type ValueSpecListOf<T extends ListValueSpecType> = {
|
||||
| readonly DefaultString[]
|
||||
| readonly Record<string, unknown>[]
|
||||
}
|
||||
|
||||
/**
|
||||
* A validation pattern with a regex and human-readable description.
|
||||
* Used to validate text input and provide meaningful error messages.
|
||||
*/
|
||||
export type Pattern = {
|
||||
/** Regular expression pattern (as a string) */
|
||||
regex: string
|
||||
/** Human-readable description shown when validation fails */
|
||||
description: string
|
||||
}
|
||||
|
||||
/**
|
||||
* Specification for text items within a list.
|
||||
* Created via `List.text()`.
|
||||
*/
|
||||
export type ListValueSpecText = {
|
||||
type: 'text'
|
||||
type: "text"
|
||||
/** Regex patterns each item must match */
|
||||
patterns: Pattern[]
|
||||
/** Minimum character length per item */
|
||||
minLength: number | null
|
||||
/** Maximum character length per item */
|
||||
maxLength: number | null
|
||||
/** If true, displays items as dots (●●●) */
|
||||
masked: boolean
|
||||
|
||||
/** Configuration for "Generate" button */
|
||||
generate: null | RandomString
|
||||
inputmode: 'text' | 'email' | 'tel' | 'url'
|
||||
/** Browser input mode hint */
|
||||
inputmode: "text" | "email" | "tel" | "url"
|
||||
/** Placeholder text for each item */
|
||||
placeholder: string | null
|
||||
}
|
||||
|
||||
/**
|
||||
* Specification for object items within a list.
|
||||
* Created via `List.obj()`.
|
||||
*/
|
||||
export type ListValueSpecObject = {
|
||||
type: 'object'
|
||||
type: "object"
|
||||
/** Field specification for each object in the list */
|
||||
spec: InputSpec
|
||||
/** Constraint for ensuring unique items in the list */
|
||||
uniqueBy: UniqueBy
|
||||
/** Template string for how to display each item in the list (e.g., "{name} - {email}") */
|
||||
displayAs: string | null
|
||||
}
|
||||
|
||||
/**
|
||||
* Defines how to determine uniqueness for list items.
|
||||
* - `null` - No uniqueness constraint
|
||||
* - `string` - Field name that must be unique (e.g., "email")
|
||||
* - `{ any: UniqueBy[] }` - Any of the specified constraints must be unique
|
||||
* - `{ all: UniqueBy[] }` - All of the specified constraints combined must be unique
|
||||
*/
|
||||
export type UniqueBy =
|
||||
| null
|
||||
| string
|
||||
@@ -234,15 +485,33 @@ export type UniqueBy =
|
||||
| {
|
||||
all: readonly UniqueBy[] | UniqueBy[]
|
||||
}
|
||||
|
||||
/**
|
||||
* Default value for a text field - either a literal string or a random string generator.
|
||||
*/
|
||||
export type DefaultString = string | RandomString
|
||||
|
||||
/**
|
||||
* Configuration for generating random strings (e.g., passwords, tokens).
|
||||
* Used with `Value.text({ generate: ... })` to show a "Generate" button.
|
||||
*/
|
||||
export type RandomString = {
|
||||
/** Characters to use when generating (e.g., "abcdefghijklmnopqrstuvwxyz0123456789") */
|
||||
charset: string
|
||||
/** Length of the generated string */
|
||||
len: number
|
||||
}
|
||||
// sometimes the type checker needs just a little bit of help
|
||||
|
||||
/**
|
||||
* Type guard to check if a ValueSpec is a list of a specific item type.
|
||||
*
|
||||
* @param t - The value specification to check
|
||||
* @param s - The expected list item type ("text" or "object")
|
||||
* @returns True if the spec is a list of the specified type
|
||||
*/
|
||||
export function isValueSpecListOf<S extends ListValueSpecType>(
|
||||
t: ValueSpec,
|
||||
s: S,
|
||||
): t is ValueSpecListOf<S> & { spec: ListValueSpecOf<S> } {
|
||||
return 'spec' in t && t.spec.type === s
|
||||
return "spec" in t && t.spec.type === s
|
||||
}
|
||||
|
||||
@@ -1,20 +1,86 @@
|
||||
import { InputSpec } from './input/builder'
|
||||
import { ExtractInputSpecType } from './input/builder/inputSpec'
|
||||
import * as T from '../types'
|
||||
import { once } from '../util'
|
||||
import { InitScript } from '../inits'
|
||||
import { Parser } from 'ts-matches'
|
||||
/**
|
||||
* @module setupActions
|
||||
*
|
||||
* This module provides the Action and Actions classes for defining user-callable
|
||||
* operations in StartOS services. Actions appear in the StartOS UI and can be
|
||||
* triggered by users or programmatically by other services.
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* import { Action, Actions, InputSpec, Value } from '@start9labs/start-sdk'
|
||||
*
|
||||
* const resetPasswordAction = Action.withInput(
|
||||
* 'reset-password',
|
||||
* { name: 'Reset Password', description: 'Reset the admin password' },
|
||||
* InputSpec.of({
|
||||
* username: Value.text({ name: 'Username', required: true, default: null })
|
||||
* }),
|
||||
* async ({ effects }) => ({ username: 'admin' }), // Pre-fill form
|
||||
* async ({ effects, input }) => {
|
||||
* // Perform the password reset
|
||||
* return { result: { type: 'single', value: 'Password reset successfully' } }
|
||||
* }
|
||||
* )
|
||||
*
|
||||
* export const actions = Actions.of().addAction(resetPasswordAction)
|
||||
* ```
|
||||
*/
|
||||
|
||||
import { InputSpec } from "./input/builder"
|
||||
import { ExtractInputSpecType } from "./input/builder/inputSpec"
|
||||
import * as T from "../types"
|
||||
import { once } from "../util"
|
||||
import { InitScript } from "../inits"
|
||||
import { Parser } from "ts-matches"
|
||||
|
||||
/** @internal Input spec type or null if the action has no input */
|
||||
type MaybeInputSpec<Type> = {} extends Type ? null : InputSpec<Type>
|
||||
|
||||
/**
|
||||
* Function signature for executing an action.
|
||||
*
|
||||
* @typeParam A - The type of the validated input object
|
||||
* @param options.effects - Effects instance for system operations
|
||||
* @param options.input - The validated user input
|
||||
* @param options.spec - The input specification used to generate the form
|
||||
* @returns Promise resolving to an ActionResult to display to the user, or null/void for no result
|
||||
*/
|
||||
export type Run<A extends Record<string, any>> = (options: {
|
||||
effects: T.Effects
|
||||
input: A
|
||||
spec: T.inputSpecTypes.InputSpec
|
||||
}) => Promise<(T.ActionResult & { version: '1' }) | null | void | undefined>
|
||||
}) => Promise<(T.ActionResult & { version: "1" }) | null | void | undefined>
|
||||
|
||||
/**
|
||||
* Function signature for pre-filling action input forms.
|
||||
* Called before displaying the input form to populate default values.
|
||||
*
|
||||
* @typeParam A - The type of the input object
|
||||
* @param options.effects - Effects instance for system operations
|
||||
* @returns Promise resolving to partial input values to pre-fill, or null for no pre-fill
|
||||
*/
|
||||
export type GetInput<A extends Record<string, any>> = (options: {
|
||||
effects: T.Effects
|
||||
}) => Promise<null | void | undefined | T.DeepPartial<A>>
|
||||
|
||||
/**
|
||||
* A value that can either be static or computed dynamically from Effects.
|
||||
* Used for action metadata that may need to change based on service state.
|
||||
*
|
||||
* @typeParam T - The type of the value
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* // Static metadata
|
||||
* const metadata: MaybeFn<ActionMetadata> = { name: 'My Action' }
|
||||
*
|
||||
* // Dynamic metadata based on service state
|
||||
* const dynamicMetadata: MaybeFn<ActionMetadata> = async ({ effects }) => {
|
||||
* const isEnabled = await checkSomething(effects)
|
||||
* return { name: isEnabled ? 'Disable Feature' : 'Enable Feature' }
|
||||
* }
|
||||
* ```
|
||||
*/
|
||||
export type MaybeFn<T> = T | ((options: { effects: T.Effects }) => Promise<T>)
|
||||
function callMaybeFn<T>(
|
||||
maybeFn: MaybeFn<T>,
|
||||
@@ -37,35 +103,82 @@ function mapMaybeFn<T, U>(
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Type information interface for an Action.
|
||||
* Used for type inference in the Actions collection.
|
||||
*
|
||||
* @typeParam Id - The action's unique identifier type
|
||||
* @typeParam Type - The action's input type
|
||||
*/
|
||||
export interface ActionInfo<
|
||||
Id extends T.ActionId,
|
||||
Type extends Record<string, any>,
|
||||
> {
|
||||
/** The unique identifier for this action */
|
||||
readonly id: Id
|
||||
/** @internal Type brand for input type inference */
|
||||
readonly _INPUT: Type
|
||||
}
|
||||
|
||||
/**
|
||||
* Represents a user-callable action in a StartOS service.
|
||||
*
|
||||
* Exposed via `sdk.Action`. Actions are operations that users can trigger
|
||||
* from the StartOS UI or that can be invoked programmatically. Each action has:
|
||||
* - A unique ID
|
||||
* - Metadata (name, description, visibility, etc.)
|
||||
* - Optional input specification (form fields)
|
||||
* - A run function that executes the action
|
||||
*
|
||||
* Use `sdk.Action.withInput()` for actions that require user input, or
|
||||
* `sdk.Action.withoutInput()` for actions that run immediately.
|
||||
*
|
||||
* See the SDK documentation for detailed examples.
|
||||
*
|
||||
* @typeParam Id - The action's unique identifier type
|
||||
* @typeParam Type - The action's input type (empty object {} for no input)
|
||||
*/
|
||||
export class Action<Id extends T.ActionId, Type extends Record<string, any>>
|
||||
implements ActionInfo<Id, Type>
|
||||
{
|
||||
/** @internal Type brand for input type inference */
|
||||
readonly _INPUT: Type = null as any as Type
|
||||
|
||||
/** @internal Cache of built input specs by event ID */
|
||||
private prevInputSpec: Record<
|
||||
string,
|
||||
{ spec: T.inputSpecTypes.InputSpec; validator: Parser<unknown, Type> }
|
||||
> = {}
|
||||
|
||||
private constructor(
|
||||
/** The unique identifier for this action */
|
||||
readonly id: Id,
|
||||
private readonly metadataFn: MaybeFn<T.ActionMetadata>,
|
||||
private readonly inputSpec: MaybeInputSpec<Type>,
|
||||
private readonly getInputFn: GetInput<Type>,
|
||||
private readonly runFn: Run<Type>,
|
||||
) {}
|
||||
|
||||
/**
|
||||
* Creates an action that requires user input before execution.
|
||||
* The input form is defined by an InputSpec.
|
||||
*
|
||||
* @typeParam Id - The action ID type
|
||||
* @typeParam InputSpecType - The input specification type
|
||||
*
|
||||
* @param id - Unique identifier for the action (used in URLs and API calls)
|
||||
* @param metadata - Action metadata (name, description, visibility, etc.) - can be static or dynamic
|
||||
* @param inputSpec - Specification for the input form fields
|
||||
* @param getInput - Function to pre-populate the form with default/previous values
|
||||
* @param run - Function to execute when the action is submitted
|
||||
* @returns A new Action instance
|
||||
*/
|
||||
static withInput<
|
||||
Id extends T.ActionId,
|
||||
InputSpecType extends InputSpec<Record<string, any>>,
|
||||
>(
|
||||
id: Id,
|
||||
metadata: MaybeFn<Omit<T.ActionMetadata, 'hasInput'>>,
|
||||
metadata: MaybeFn<Omit<T.ActionMetadata, "hasInput">>,
|
||||
inputSpec: InputSpecType,
|
||||
getInput: GetInput<ExtractInputSpecType<InputSpecType>>,
|
||||
run: Run<ExtractInputSpecType<InputSpecType>>,
|
||||
@@ -78,9 +191,21 @@ export class Action<Id extends T.ActionId, Type extends Record<string, any>>
|
||||
run,
|
||||
)
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates an action that executes immediately without requiring user input.
|
||||
* Use this for simple operations like toggles, restarts, or status checks.
|
||||
*
|
||||
* @typeParam Id - The action ID type
|
||||
*
|
||||
* @param id - Unique identifier for the action
|
||||
* @param metadata - Action metadata (name, description, visibility, etc.) - can be static or dynamic
|
||||
* @param run - Function to execute when the action is triggered
|
||||
* @returns A new Action instance with no input
|
||||
*/
|
||||
static withoutInput<Id extends T.ActionId>(
|
||||
id: Id,
|
||||
metadata: MaybeFn<Omit<T.ActionMetadata, 'hasInput'>>,
|
||||
metadata: MaybeFn<Omit<T.ActionMetadata, "hasInput">>,
|
||||
run: Run<{}>,
|
||||
): Action<Id, {}> {
|
||||
return new Action(
|
||||
@@ -91,6 +216,14 @@ export class Action<Id extends T.ActionId, Type extends Record<string, any>>
|
||||
run,
|
||||
)
|
||||
}
|
||||
/**
|
||||
* Exports the action's metadata to StartOS, making it visible in the UI.
|
||||
* Called automatically during initialization by the Actions collection.
|
||||
*
|
||||
* @param options.effects - Effects instance for system operations
|
||||
* @returns Promise resolving to the exported metadata
|
||||
* @internal
|
||||
*/
|
||||
async exportMetadata(options: {
|
||||
effects: T.Effects
|
||||
}): Promise<T.ActionMetadata> {
|
||||
@@ -104,6 +237,15 @@ export class Action<Id extends T.ActionId, Type extends Record<string, any>>
|
||||
await options.effects.action.export({ id: this.id, metadata })
|
||||
return metadata
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds and returns the input specification and pre-filled values for this action.
|
||||
* Called by StartOS when a user clicks on the action to display the input form.
|
||||
*
|
||||
* @param options.effects - Effects instance for system operations
|
||||
* @returns Promise resolving to the input specification and pre-filled values
|
||||
* @internal
|
||||
*/
|
||||
async getInput(options: { effects: T.Effects }): Promise<T.ActionInput> {
|
||||
let spec = {}
|
||||
if (this.inputSpec) {
|
||||
@@ -121,6 +263,16 @@ export class Action<Id extends T.ActionId, Type extends Record<string, any>>
|
||||
| undefined) || null,
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Executes the action with the provided input.
|
||||
* Called by StartOS when a user submits the action form.
|
||||
*
|
||||
* @param options.effects - Effects instance for system operations
|
||||
* @param options.input - The user-provided input (validated against the input spec)
|
||||
* @returns Promise resolving to the action result to display, or null for no result
|
||||
* @internal
|
||||
*/
|
||||
async run(options: {
|
||||
effects: T.Effects
|
||||
input: Type
|
||||
@@ -146,19 +298,77 @@ export class Action<Id extends T.ActionId, Type extends Record<string, any>>
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* A collection of actions for a StartOS service.
|
||||
*
|
||||
* Exposed via `sdk.Actions`. The Actions class manages the registration and
|
||||
* lifecycle of all actions in a service. It implements InitScript so it can
|
||||
* be included in the initialization pipeline to automatically register actions
|
||||
* with StartOS.
|
||||
*
|
||||
* @typeParam AllActions - Record type mapping action IDs to Action instances
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* // Create an actions collection
|
||||
* export const actions = sdk.Actions.of()
|
||||
* .addAction(createUserAction)
|
||||
* .addAction(resetPasswordAction)
|
||||
* .addAction(restartAction)
|
||||
*
|
||||
* // Include in init pipeline
|
||||
* export const init = sdk.setupInit(
|
||||
* versionGraph,
|
||||
* setInterfaces,
|
||||
* actions, // Actions are registered here
|
||||
* )
|
||||
* ```
|
||||
*/
|
||||
export class Actions<
|
||||
AllActions extends Record<T.ActionId, Action<T.ActionId, any>>,
|
||||
> implements InitScript
|
||||
{
|
||||
private constructor(private readonly actions: AllActions) {}
|
||||
|
||||
/**
|
||||
* Creates a new empty Actions collection.
|
||||
* Use `addAction()` to add actions to the collection.
|
||||
*
|
||||
* @returns A new empty Actions instance
|
||||
*/
|
||||
static of(): Actions<{}> {
|
||||
return new Actions({})
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds an action to the collection.
|
||||
* Returns a new Actions instance with the action included (immutable pattern).
|
||||
*
|
||||
* @typeParam A - The action type being added
|
||||
* @param action - The action to add
|
||||
* @returns A new Actions instance containing all previous actions plus the new one
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* const actions = Actions.of()
|
||||
* .addAction(action1)
|
||||
* .addAction(action2)
|
||||
* ```
|
||||
*/
|
||||
addAction<A extends Action<T.ActionId, any>>(
|
||||
action: A, // TODO: prevent duplicates
|
||||
): Actions<AllActions & { [id in A['id']]: A }> {
|
||||
): Actions<AllActions & { [id in A["id"]]: A }> {
|
||||
return new Actions({ ...this.actions, [action.id]: action })
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes all actions by exporting their metadata to StartOS.
|
||||
* Called automatically when included in the init pipeline.
|
||||
* Also clears any previously registered actions that are no longer in the collection.
|
||||
*
|
||||
* @param effects - Effects instance for system operations
|
||||
* @internal
|
||||
*/
|
||||
async init(effects: T.Effects): Promise<void> {
|
||||
for (let action of Object.values(this.actions)) {
|
||||
const fn = async () => {
|
||||
@@ -180,6 +390,15 @@ export class Actions<
|
||||
}
|
||||
await effects.action.clear({ except: Object.keys(this.actions) })
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves an action from the collection by its ID.
|
||||
* Useful for programmatically invoking actions or inspecting their configuration.
|
||||
*
|
||||
* @typeParam Id - The action ID type
|
||||
* @param actionId - The ID of the action to retrieve
|
||||
* @returns The action instance
|
||||
*/
|
||||
get<Id extends T.ActionId>(actionId: Id): AllActions[Id] {
|
||||
return this.actions[actionId]
|
||||
}
|
||||
|
||||
@@ -1,38 +1,181 @@
|
||||
import { ExtendedVersion, VersionRange } from '../exver'
|
||||
/**
|
||||
* @module dependencies
|
||||
*
|
||||
* This module provides utilities for checking whether service dependencies are satisfied.
|
||||
* Use `checkDependencies()` to get a helper object with methods for querying and
|
||||
* validating dependency status.
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* const deps = await checkDependencies(effects, ['bitcoind', 'lnd'])
|
||||
*
|
||||
* // Check if all dependencies are satisfied
|
||||
* if (deps.satisfied()) {
|
||||
* // All good, proceed
|
||||
* }
|
||||
*
|
||||
* // Or throw an error with details if not satisfied
|
||||
* deps.throwIfNotSatisfied()
|
||||
*
|
||||
* // Check specific aspects
|
||||
* if (deps.installedSatisfied('bitcoind') && deps.runningSatisfied('bitcoind')) {
|
||||
* // bitcoind is installed and running
|
||||
* }
|
||||
* ```
|
||||
*/
|
||||
|
||||
import { ExtendedVersion, VersionRange } from "../exver"
|
||||
import {
|
||||
PackageId,
|
||||
HealthCheckId,
|
||||
DependencyRequirement,
|
||||
CheckDependenciesResult,
|
||||
} from '../types'
|
||||
import { Effects } from '../Effects'
|
||||
} from "../types"
|
||||
import { Effects } from "../Effects"
|
||||
|
||||
/**
|
||||
* Interface providing methods to check and validate dependency satisfaction.
|
||||
* Returned by `checkDependencies()`.
|
||||
*
|
||||
* @typeParam DependencyId - The type of package IDs being checked
|
||||
*/
|
||||
export type CheckDependencies<DependencyId extends PackageId = PackageId> = {
|
||||
/**
|
||||
* Gets the requirement and current result for a specific dependency.
|
||||
* @param packageId - The package ID to query
|
||||
* @returns Object containing the requirement spec and check result
|
||||
* @throws Error if the packageId is not a known dependency
|
||||
*/
|
||||
infoFor: (packageId: DependencyId) => {
|
||||
requirement: DependencyRequirement
|
||||
result: CheckDependenciesResult
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if a dependency is installed (regardless of version).
|
||||
* @param packageId - The package ID to check
|
||||
* @returns True if the package is installed
|
||||
*/
|
||||
installedSatisfied: (packageId: DependencyId) => boolean
|
||||
|
||||
/**
|
||||
* Checks if a dependency is installed with a satisfying version.
|
||||
* @param packageId - The package ID to check
|
||||
* @returns True if the installed version satisfies the version range requirement
|
||||
*/
|
||||
installedVersionSatisfied: (packageId: DependencyId) => boolean
|
||||
|
||||
/**
|
||||
* Checks if a "running" dependency is actually running.
|
||||
* Always returns true for "exists" dependencies.
|
||||
* @param packageId - The package ID to check
|
||||
* @returns True if the dependency is running (or only needs to exist)
|
||||
*/
|
||||
runningSatisfied: (packageId: DependencyId) => boolean
|
||||
|
||||
/**
|
||||
* Checks if all critical tasks for a dependency have been completed.
|
||||
* @param packageId - The package ID to check
|
||||
* @returns True if no critical tasks are pending
|
||||
*/
|
||||
tasksSatisfied: (packageId: DependencyId) => boolean
|
||||
|
||||
/**
|
||||
* Checks if specified health checks are passing for a dependency.
|
||||
* @param packageId - The package ID to check
|
||||
* @param healthCheckId - Specific health check to verify (optional - checks all if omitted)
|
||||
* @returns True if the health check(s) are passing
|
||||
*/
|
||||
healthCheckSatisfied: (
|
||||
packageId: DependencyId,
|
||||
healthCheckId: HealthCheckId,
|
||||
) => boolean
|
||||
|
||||
/**
|
||||
* Checks if all dependencies are fully satisfied.
|
||||
* @returns True if all dependencies meet all requirements
|
||||
*/
|
||||
satisfied: () => boolean
|
||||
|
||||
/**
|
||||
* Throws an error if the dependency is not installed.
|
||||
* @param packageId - The package ID to check
|
||||
* @throws Error with message if not installed
|
||||
*/
|
||||
throwIfInstalledNotSatisfied: (packageId: DependencyId) => null
|
||||
|
||||
/**
|
||||
* Throws an error if the installed version doesn't satisfy requirements.
|
||||
* @param packageId - The package ID to check
|
||||
* @throws Error with version mismatch details if not satisfied
|
||||
*/
|
||||
throwIfInstalledVersionNotSatisfied: (packageId: DependencyId) => null
|
||||
|
||||
/**
|
||||
* Throws an error if a "running" dependency is not running.
|
||||
* @param packageId - The package ID to check
|
||||
* @throws Error if the dependency should be running but isn't
|
||||
*/
|
||||
throwIfRunningNotSatisfied: (packageId: DependencyId) => null
|
||||
|
||||
/**
|
||||
* Throws an error if critical tasks are pending for the dependency.
|
||||
* @param packageId - The package ID to check
|
||||
* @throws Error listing pending critical tasks
|
||||
*/
|
||||
throwIfTasksNotSatisfied: (packageId: DependencyId) => null
|
||||
|
||||
/**
|
||||
* Throws an error if health checks are failing for the dependency.
|
||||
* @param packageId - The package ID to check
|
||||
* @param healthCheckId - Specific health check (optional - checks all if omitted)
|
||||
* @throws Error with health check failure details
|
||||
*/
|
||||
throwIfHealthNotSatisfied: (
|
||||
packageId: DependencyId,
|
||||
healthCheckId?: HealthCheckId,
|
||||
) => null
|
||||
|
||||
/**
|
||||
* Throws an error if any requirements are not satisfied.
|
||||
* @param packageId - Specific package to check (optional - checks all if omitted)
|
||||
* @throws Error with detailed message about what's not satisfied
|
||||
*/
|
||||
throwIfNotSatisfied: (packageId?: DependencyId) => null
|
||||
}
|
||||
/**
|
||||
* Checks the satisfaction status of service dependencies.
|
||||
* Returns a helper object with methods to query and validate dependency status.
|
||||
*
|
||||
* This is useful for:
|
||||
* - Verifying dependencies before starting operations that require them
|
||||
* - Providing detailed error messages about unsatisfied dependencies
|
||||
* - Conditionally enabling features based on dependency availability
|
||||
*
|
||||
* @typeParam DependencyId - The type of package IDs (defaults to string)
|
||||
*
|
||||
* @param effects - Effects instance for system operations
|
||||
* @param packageIds - Optional array of specific dependencies to check (checks all if omitted)
|
||||
* @returns Promise resolving to a CheckDependencies helper object
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* // Check all dependencies
|
||||
* const deps = await checkDependencies(effects)
|
||||
* deps.throwIfNotSatisfied() // Throws if any dependency isn't met
|
||||
*
|
||||
* // Check specific dependencies
|
||||
* const deps = await checkDependencies(effects, ['bitcoind'])
|
||||
* if (deps.runningSatisfied('bitcoind') && deps.healthCheckSatisfied('bitcoind', 'rpc')) {
|
||||
* // Safe to make RPC calls to bitcoind
|
||||
* }
|
||||
*
|
||||
* // Get detailed info
|
||||
* const info = deps.infoFor('bitcoind')
|
||||
* console.log(`Installed: ${info.result.installedVersion}`)
|
||||
* console.log(`Running: ${info.result.isRunning}`)
|
||||
* ```
|
||||
*/
|
||||
export async function checkDependencies<
|
||||
DependencyId extends PackageId = PackageId,
|
||||
>(
|
||||
@@ -73,11 +216,11 @@ export async function checkDependencies<
|
||||
}
|
||||
const runningSatisfied = (packageId: DependencyId) => {
|
||||
const dep = infoFor(packageId)
|
||||
return dep.requirement.kind !== 'running' || dep.result.isRunning
|
||||
return dep.requirement.kind !== "running" || dep.result.isRunning
|
||||
}
|
||||
const tasksSatisfied = (packageId: DependencyId) =>
|
||||
Object.entries(infoFor(packageId).result.tasks).filter(
|
||||
([_, t]) => t?.active && t.task.severity === 'critical',
|
||||
([_, t]) => t?.active && t.task.severity === "critical",
|
||||
).length === 0
|
||||
const healthCheckSatisfied = (
|
||||
packageId: DependencyId,
|
||||
@@ -86,17 +229,17 @@ export async function checkDependencies<
|
||||
const dep = infoFor(packageId)
|
||||
if (
|
||||
healthCheckId &&
|
||||
(dep.requirement.kind !== 'running' ||
|
||||
(dep.requirement.kind !== "running" ||
|
||||
!dep.requirement.healthChecks.includes(healthCheckId))
|
||||
) {
|
||||
throw new Error(`Unknown HealthCheckId ${healthCheckId}`)
|
||||
}
|
||||
const errors =
|
||||
dep.requirement.kind === 'running'
|
||||
dep.requirement.kind === "running"
|
||||
? dep.requirement.healthChecks
|
||||
.map((id) => [id, dep.result.healthChecks[id] ?? null] as const)
|
||||
.filter(([id, _]) => (healthCheckId ? id === healthCheckId : true))
|
||||
.filter(([_, res]) => res?.result !== 'success')
|
||||
.filter(([_, res]) => res?.result !== "success")
|
||||
: []
|
||||
return errors.length === 0
|
||||
}
|
||||
@@ -138,7 +281,7 @@ export async function checkDependencies<
|
||||
}
|
||||
const throwIfRunningNotSatisfied = (packageId: DependencyId) => {
|
||||
const dep = infoFor(packageId)
|
||||
if (dep.requirement.kind === 'running' && !dep.result.isRunning) {
|
||||
if (dep.requirement.kind === "running" && !dep.result.isRunning) {
|
||||
throw new Error(`${dep.result.title || packageId} is not running`)
|
||||
}
|
||||
return null
|
||||
@@ -146,11 +289,11 @@ export async function checkDependencies<
|
||||
const throwIfTasksNotSatisfied = (packageId: DependencyId) => {
|
||||
const dep = infoFor(packageId)
|
||||
const reqs = Object.entries(dep.result.tasks)
|
||||
.filter(([_, t]) => t?.active && t.task.severity === 'critical')
|
||||
.filter(([_, t]) => t?.active && t.task.severity === "critical")
|
||||
.map(([id, _]) => id)
|
||||
if (reqs.length) {
|
||||
throw new Error(
|
||||
`The following action requests have not been fulfilled: ${reqs.join(', ')}`,
|
||||
`The following action requests have not been fulfilled: ${reqs.join(", ")}`,
|
||||
)
|
||||
}
|
||||
return null
|
||||
@@ -162,27 +305,27 @@ export async function checkDependencies<
|
||||
const dep = infoFor(packageId)
|
||||
if (
|
||||
healthCheckId &&
|
||||
(dep.requirement.kind !== 'running' ||
|
||||
(dep.requirement.kind !== "running" ||
|
||||
!dep.requirement.healthChecks.includes(healthCheckId))
|
||||
) {
|
||||
throw new Error(`Unknown HealthCheckId ${healthCheckId}`)
|
||||
}
|
||||
const errors =
|
||||
dep.requirement.kind === 'running'
|
||||
dep.requirement.kind === "running"
|
||||
? dep.requirement.healthChecks
|
||||
.map((id) => [id, dep.result.healthChecks[id] ?? null] as const)
|
||||
.filter(([id, _]) => (healthCheckId ? id === healthCheckId : true))
|
||||
.filter(([_, res]) => res?.result !== 'success')
|
||||
.filter(([_, res]) => res?.result !== "success")
|
||||
: []
|
||||
if (errors.length) {
|
||||
throw new Error(
|
||||
errors
|
||||
.map(([id, e]) =>
|
||||
e
|
||||
? `Health Check ${e.name} of ${dep.result.title || packageId} failed with status ${e.result}${e.message ? `: ${e.message}` : ''}`
|
||||
? `Health Check ${e.name} of ${dep.result.title || packageId} failed with status ${e.result}${e.message ? `: ${e.message}` : ""}`
|
||||
: `Health Check ${id} of ${dep.result.title} does not exist`,
|
||||
)
|
||||
.join('; '),
|
||||
.join("; "),
|
||||
)
|
||||
}
|
||||
return null
|
||||
@@ -209,7 +352,7 @@ export async function checkDependencies<
|
||||
return []
|
||||
})
|
||||
if (err.length) {
|
||||
throw new Error(err.join('; '))
|
||||
throw new Error(err.join("; "))
|
||||
}
|
||||
return null
|
||||
})()
|
||||
|
||||
@@ -1,41 +1,118 @@
|
||||
import * as T from '../types'
|
||||
import { once } from '../util'
|
||||
/**
|
||||
* @module setupDependencies
|
||||
*
|
||||
* This module provides utilities for declaring and managing service dependencies.
|
||||
* Dependencies allow services to declare that they require other services to be
|
||||
* installed and/or running before they can function properly.
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* // In dependencies.ts
|
||||
* export const setDependencies = sdk.setupDependencies(async ({ effects }) => {
|
||||
* const config = await store.read(s => s.mediaSource).const(effects)
|
||||
*
|
||||
* return {
|
||||
* // Required dependency - must be running with passing health checks
|
||||
* bitcoind: {
|
||||
* kind: 'running',
|
||||
* versionRange: '>=25.0.0',
|
||||
* healthChecks: ['rpc']
|
||||
* },
|
||||
* // Optional dependency - only required if feature is enabled
|
||||
* ...(config === 'nextcloud' ? {
|
||||
* nextcloud: { kind: 'exists', versionRange: '>=28.0.0' }
|
||||
* } : {})
|
||||
* }
|
||||
* })
|
||||
* ```
|
||||
*/
|
||||
|
||||
import * as T from "../types"
|
||||
import { once } from "../util"
|
||||
|
||||
/**
|
||||
* Extracts the package IDs of required (non-optional) dependencies from a manifest.
|
||||
* Used for type-safe dependency declarations.
|
||||
*
|
||||
* @typeParam Manifest - The service manifest type
|
||||
*/
|
||||
export type RequiredDependenciesOf<Manifest extends T.SDKManifest> = {
|
||||
[K in keyof Manifest['dependencies']]: Exclude<
|
||||
Manifest['dependencies'][K],
|
||||
[K in keyof Manifest["dependencies"]]: Exclude<
|
||||
Manifest["dependencies"][K],
|
||||
undefined
|
||||
>['optional'] extends false
|
||||
>["optional"] extends false
|
||||
? K
|
||||
: never
|
||||
}[keyof Manifest['dependencies']]
|
||||
}[keyof Manifest["dependencies"]]
|
||||
|
||||
/**
|
||||
* Extracts the package IDs of optional dependencies from a manifest.
|
||||
* These dependencies are declared in the manifest but marked as optional.
|
||||
*
|
||||
* @typeParam Manifest - The service manifest type
|
||||
*/
|
||||
export type OptionalDependenciesOf<Manifest extends T.SDKManifest> = Exclude<
|
||||
keyof Manifest['dependencies'],
|
||||
keyof Manifest["dependencies"],
|
||||
RequiredDependenciesOf<Manifest>
|
||||
>
|
||||
|
||||
/**
|
||||
* Specifies the requirements for a single dependency.
|
||||
*
|
||||
* - `kind: "running"` - The dependency must be installed AND actively running
|
||||
* with the specified health checks passing
|
||||
* - `kind: "exists"` - The dependency only needs to be installed (not necessarily running)
|
||||
*/
|
||||
type DependencyRequirement =
|
||||
| {
|
||||
kind: 'running'
|
||||
/** The dependency must be running */
|
||||
kind: "running"
|
||||
/** Health check IDs that must be passing */
|
||||
healthChecks: Array<T.HealthCheckId>
|
||||
/** Semantic version range the dependency must satisfy (e.g., ">=1.0.0") */
|
||||
versionRange: string
|
||||
}
|
||||
| {
|
||||
kind: 'exists'
|
||||
/** The dependency only needs to be installed */
|
||||
kind: "exists"
|
||||
/** Semantic version range the dependency must satisfy */
|
||||
versionRange: string
|
||||
}
|
||||
|
||||
/** @internal Type checking helper */
|
||||
type Matches<T, U> = T extends U ? (U extends T ? null : never) : never
|
||||
const _checkType: Matches<
|
||||
DependencyRequirement & { id: T.PackageId },
|
||||
T.DependencyRequirement
|
||||
> = null
|
||||
|
||||
/**
|
||||
* The return type for dependency declarations.
|
||||
* Required dependencies must always be specified; optional dependencies may be omitted.
|
||||
*
|
||||
* @typeParam Manifest - The service manifest type
|
||||
*/
|
||||
export type CurrentDependenciesResult<Manifest extends T.SDKManifest> = {
|
||||
[K in RequiredDependenciesOf<Manifest>]: DependencyRequirement
|
||||
} & {
|
||||
[K in OptionalDependenciesOf<Manifest>]?: DependencyRequirement
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a dependency setup function for use in the initialization pipeline.
|
||||
*
|
||||
* **Note:** This is exposed via `sdk.setupDependencies`. See the SDK documentation
|
||||
* for usage examples.
|
||||
*
|
||||
* The function you provide will be called during init to determine the current
|
||||
* dependency requirements, which may vary based on service configuration.
|
||||
*
|
||||
* @typeParam Manifest - The service manifest type (inferred from SDK)
|
||||
* @param fn - Async function that returns the current dependency requirements
|
||||
* @returns An init-compatible function that sets dependencies via Effects
|
||||
*
|
||||
* @see sdk.setupDependencies for usage documentation
|
||||
*/
|
||||
export function setupDependencies<Manifest extends T.SDKManifest>(
|
||||
fn: (options: {
|
||||
effects: T.Effects
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,5 +1,5 @@
|
||||
import { DeepMap } from 'deep-equality-data-structures'
|
||||
import * as P from './exver'
|
||||
import { DeepMap } from "deep-equality-data-structures"
|
||||
import * as P from "./exver"
|
||||
|
||||
// prettier-ignore
|
||||
export type ValidateVersion<T extends String> =
|
||||
@@ -22,35 +22,35 @@ export type ValidateExVers<T> =
|
||||
never[]
|
||||
|
||||
type Anchor = {
|
||||
type: 'Anchor'
|
||||
type: "Anchor"
|
||||
operator: P.CmpOp
|
||||
version: ExtendedVersion
|
||||
}
|
||||
|
||||
type And = {
|
||||
type: 'And'
|
||||
type: "And"
|
||||
left: VersionRange
|
||||
right: VersionRange
|
||||
}
|
||||
|
||||
type Or = {
|
||||
type: 'Or'
|
||||
type: "Or"
|
||||
left: VersionRange
|
||||
right: VersionRange
|
||||
}
|
||||
|
||||
type Not = {
|
||||
type: 'Not'
|
||||
type: "Not"
|
||||
value: VersionRange
|
||||
}
|
||||
|
||||
type Flavor = {
|
||||
type: 'Flavor'
|
||||
type: "Flavor"
|
||||
flavor: string | null
|
||||
}
|
||||
|
||||
type FlavorNot = {
|
||||
type: 'FlavorNot'
|
||||
type: "FlavorNot"
|
||||
flavors: Set<string | null>
|
||||
}
|
||||
|
||||
@@ -107,8 +107,8 @@ function adjacentVersionRangePoints(
|
||||
}
|
||||
|
||||
function flavorAnd(a: FlavorAtom, b: FlavorAtom): FlavorAtom | null {
|
||||
if (a.type == 'Flavor') {
|
||||
if (b.type == 'Flavor') {
|
||||
if (a.type == "Flavor") {
|
||||
if (b.type == "Flavor") {
|
||||
if (a.flavor == b.flavor) {
|
||||
return a
|
||||
} else {
|
||||
@@ -122,7 +122,7 @@ function flavorAnd(a: FlavorAtom, b: FlavorAtom): FlavorAtom | null {
|
||||
}
|
||||
}
|
||||
} else {
|
||||
if (b.type == 'Flavor') {
|
||||
if (b.type == "Flavor") {
|
||||
if (a.flavors.has(b.flavor)) {
|
||||
return null
|
||||
} else {
|
||||
@@ -131,7 +131,7 @@ function flavorAnd(a: FlavorAtom, b: FlavorAtom): FlavorAtom | null {
|
||||
} else {
|
||||
// TODO: use Set.union if targeting esnext or later
|
||||
return {
|
||||
type: 'FlavorNot',
|
||||
type: "FlavorNot",
|
||||
flavors: new Set([...a.flavors, ...b.flavors]),
|
||||
}
|
||||
}
|
||||
@@ -218,12 +218,12 @@ class VersionRangeTable {
|
||||
static eqFlavor(flavor: string | null): VersionRangeTables {
|
||||
return new DeepMap([
|
||||
[
|
||||
{ type: 'Flavor', flavor } as FlavorAtom,
|
||||
{ type: "Flavor", flavor } as FlavorAtom,
|
||||
new VersionRangeTable([], [true]),
|
||||
],
|
||||
// make sure the truth table is exhaustive, or `not` will not work properly.
|
||||
[
|
||||
{ type: 'FlavorNot', flavors: new Set([flavor]) } as FlavorAtom,
|
||||
{ type: "FlavorNot", flavors: new Set([flavor]) } as FlavorAtom,
|
||||
new VersionRangeTable([], [false]),
|
||||
],
|
||||
])
|
||||
@@ -241,12 +241,12 @@ class VersionRangeTable {
|
||||
): VersionRangeTables {
|
||||
return new DeepMap([
|
||||
[
|
||||
{ type: 'Flavor', flavor } as FlavorAtom,
|
||||
{ type: "Flavor", flavor } as FlavorAtom,
|
||||
new VersionRangeTable([point], [left, right]),
|
||||
],
|
||||
// make sure the truth table is exhaustive, or `not` will not work properly.
|
||||
[
|
||||
{ type: 'FlavorNot', flavors: new Set([flavor]) } as FlavorAtom,
|
||||
{ type: "FlavorNot", flavors: new Set([flavor]) } as FlavorAtom,
|
||||
new VersionRangeTable([], [false]),
|
||||
],
|
||||
])
|
||||
@@ -383,7 +383,7 @@ class VersionRangeTable {
|
||||
let sum_terms: VersionRange[] = []
|
||||
for (let [flavor, table] of tables) {
|
||||
let cmp_flavor = null
|
||||
if (flavor.type == 'Flavor') {
|
||||
if (flavor.type == "Flavor") {
|
||||
cmp_flavor = flavor.flavor
|
||||
}
|
||||
for (let i = 0; i < table.values.length; i++) {
|
||||
@@ -392,7 +392,7 @@ class VersionRangeTable {
|
||||
continue
|
||||
}
|
||||
|
||||
if (flavor.type == 'FlavorNot') {
|
||||
if (flavor.type == "FlavorNot") {
|
||||
for (let not_flavor of flavor.flavors) {
|
||||
term.push(VersionRange.flavor(not_flavor).not())
|
||||
}
|
||||
@@ -410,7 +410,7 @@ class VersionRangeTable {
|
||||
if (p != null && q != null && adjacentVersionRangePoints(p, q)) {
|
||||
term.push(
|
||||
VersionRange.anchor(
|
||||
'=',
|
||||
"=",
|
||||
new ExtendedVersion(cmp_flavor, p.upstream, p.downstream),
|
||||
),
|
||||
)
|
||||
@@ -418,7 +418,7 @@ class VersionRangeTable {
|
||||
if (p != null && p.side < 0) {
|
||||
term.push(
|
||||
VersionRange.anchor(
|
||||
'>=',
|
||||
">=",
|
||||
new ExtendedVersion(cmp_flavor, p.upstream, p.downstream),
|
||||
),
|
||||
)
|
||||
@@ -426,7 +426,7 @@ class VersionRangeTable {
|
||||
if (p != null && p.side >= 0) {
|
||||
term.push(
|
||||
VersionRange.anchor(
|
||||
'>',
|
||||
">",
|
||||
new ExtendedVersion(cmp_flavor, p.upstream, p.downstream),
|
||||
),
|
||||
)
|
||||
@@ -434,7 +434,7 @@ class VersionRangeTable {
|
||||
if (q != null && q.side < 0) {
|
||||
term.push(
|
||||
VersionRange.anchor(
|
||||
'<',
|
||||
"<",
|
||||
new ExtendedVersion(cmp_flavor, q.upstream, q.downstream),
|
||||
),
|
||||
)
|
||||
@@ -442,7 +442,7 @@ class VersionRangeTable {
|
||||
if (q != null && q.side >= 0) {
|
||||
term.push(
|
||||
VersionRange.anchor(
|
||||
'<=',
|
||||
"<=",
|
||||
new ExtendedVersion(cmp_flavor, q.upstream, q.downstream),
|
||||
),
|
||||
)
|
||||
@@ -463,26 +463,26 @@ class VersionRangeTable {
|
||||
export class VersionRange {
|
||||
constructor(public atom: Anchor | And | Or | Not | P.Any | P.None | Flavor) {}
|
||||
|
||||
toStringParens(parent: 'And' | 'Or' | 'Not') {
|
||||
toStringParens(parent: "And" | "Or" | "Not") {
|
||||
let needs = true
|
||||
switch (this.atom.type) {
|
||||
case 'And':
|
||||
case 'Or':
|
||||
case "And":
|
||||
case "Or":
|
||||
needs = parent != this.atom.type
|
||||
break
|
||||
case 'Anchor':
|
||||
case 'Any':
|
||||
case 'None':
|
||||
needs = parent == 'Not'
|
||||
case "Anchor":
|
||||
case "Any":
|
||||
case "None":
|
||||
needs = parent == "Not"
|
||||
break
|
||||
case 'Not':
|
||||
case 'Flavor':
|
||||
case "Not":
|
||||
case "Flavor":
|
||||
needs = false
|
||||
break
|
||||
}
|
||||
|
||||
if (needs) {
|
||||
return '(' + this.toString() + ')'
|
||||
return "(" + this.toString() + ")"
|
||||
} else {
|
||||
return this.toString()
|
||||
}
|
||||
@@ -490,36 +490,36 @@ export class VersionRange {
|
||||
|
||||
toString(): string {
|
||||
switch (this.atom.type) {
|
||||
case 'Anchor':
|
||||
case "Anchor":
|
||||
return `${this.atom.operator}${this.atom.version}`
|
||||
case 'And':
|
||||
case "And":
|
||||
return `${this.atom.left.toStringParens(this.atom.type)} && ${this.atom.right.toStringParens(this.atom.type)}`
|
||||
case 'Or':
|
||||
case "Or":
|
||||
return `${this.atom.left.toStringParens(this.atom.type)} || ${this.atom.right.toStringParens(this.atom.type)}`
|
||||
case 'Not':
|
||||
case "Not":
|
||||
return `!${this.atom.value.toStringParens(this.atom.type)}`
|
||||
case 'Flavor':
|
||||
case "Flavor":
|
||||
return this.atom.flavor == null ? `#` : `#${this.atom.flavor}`
|
||||
case 'Any':
|
||||
return '*'
|
||||
case 'None':
|
||||
return '!'
|
||||
case "Any":
|
||||
return "*"
|
||||
case "None":
|
||||
return "!"
|
||||
}
|
||||
}
|
||||
|
||||
private static parseAtom(atom: P.VersionRangeAtom): VersionRange {
|
||||
switch (atom.type) {
|
||||
case 'Not':
|
||||
case "Not":
|
||||
return new VersionRange({
|
||||
type: 'Not',
|
||||
type: "Not",
|
||||
value: VersionRange.parseAtom(atom.value),
|
||||
})
|
||||
case 'Parens':
|
||||
case "Parens":
|
||||
return VersionRange.parseRange(atom.expr)
|
||||
case 'Anchor':
|
||||
case "Anchor":
|
||||
return new VersionRange({
|
||||
type: 'Anchor',
|
||||
operator: atom.operator || '^',
|
||||
type: "Anchor",
|
||||
operator: atom.operator || "^",
|
||||
version: new ExtendedVersion(
|
||||
atom.version.flavor,
|
||||
new Version(
|
||||
@@ -532,7 +532,7 @@ export class VersionRange {
|
||||
),
|
||||
),
|
||||
})
|
||||
case 'Flavor':
|
||||
case "Flavor":
|
||||
return VersionRange.flavor(atom.flavor)
|
||||
default:
|
||||
return new VersionRange(atom)
|
||||
@@ -543,17 +543,17 @@ export class VersionRange {
|
||||
let result = VersionRange.parseAtom(range[0])
|
||||
for (const next of range[1]) {
|
||||
switch (next[1]?.[0]) {
|
||||
case '||':
|
||||
case "||":
|
||||
result = new VersionRange({
|
||||
type: 'Or',
|
||||
type: "Or",
|
||||
left: result,
|
||||
right: VersionRange.parseAtom(next[2]),
|
||||
})
|
||||
break
|
||||
case '&&':
|
||||
case "&&":
|
||||
default:
|
||||
result = new VersionRange({
|
||||
type: 'And',
|
||||
type: "And",
|
||||
left: result,
|
||||
right: VersionRange.parseAtom(next[2]),
|
||||
})
|
||||
@@ -565,49 +565,49 @@ export class VersionRange {
|
||||
|
||||
static parse(range: string): VersionRange {
|
||||
return VersionRange.parseRange(
|
||||
P.parse(range, { startRule: 'VersionRange' }),
|
||||
P.parse(range, { startRule: "VersionRange" }),
|
||||
)
|
||||
}
|
||||
|
||||
static anchor(operator: P.CmpOp, version: ExtendedVersion) {
|
||||
return new VersionRange({ type: 'Anchor', operator, version })
|
||||
return new VersionRange({ type: "Anchor", operator, version })
|
||||
}
|
||||
|
||||
static flavor(flavor: string | null) {
|
||||
return new VersionRange({ type: 'Flavor', flavor })
|
||||
return new VersionRange({ type: "Flavor", flavor })
|
||||
}
|
||||
|
||||
static parseEmver(range: string): VersionRange {
|
||||
return VersionRange.parseRange(
|
||||
P.parse(range, { startRule: 'EmverVersionRange' }),
|
||||
P.parse(range, { startRule: "EmverVersionRange" }),
|
||||
)
|
||||
}
|
||||
|
||||
and(right: VersionRange) {
|
||||
return new VersionRange({ type: 'And', left: this, right })
|
||||
return new VersionRange({ type: "And", left: this, right })
|
||||
}
|
||||
|
||||
or(right: VersionRange) {
|
||||
return new VersionRange({ type: 'Or', left: this, right })
|
||||
return new VersionRange({ type: "Or", left: this, right })
|
||||
}
|
||||
|
||||
not() {
|
||||
return new VersionRange({ type: 'Not', value: this })
|
||||
return new VersionRange({ type: "Not", value: this })
|
||||
}
|
||||
|
||||
static and(...xs: Array<VersionRange>) {
|
||||
let y = VersionRange.any()
|
||||
for (let x of xs) {
|
||||
if (x.atom.type == 'Any') {
|
||||
if (x.atom.type == "Any") {
|
||||
continue
|
||||
}
|
||||
if (x.atom.type == 'None') {
|
||||
if (x.atom.type == "None") {
|
||||
return x
|
||||
}
|
||||
if (y.atom.type == 'Any') {
|
||||
if (y.atom.type == "Any") {
|
||||
y = x
|
||||
} else {
|
||||
y = new VersionRange({ type: 'And', left: y, right: x })
|
||||
y = new VersionRange({ type: "And", left: y, right: x })
|
||||
}
|
||||
}
|
||||
return y
|
||||
@@ -616,27 +616,27 @@ export class VersionRange {
|
||||
static or(...xs: Array<VersionRange>) {
|
||||
let y = VersionRange.none()
|
||||
for (let x of xs) {
|
||||
if (x.atom.type == 'None') {
|
||||
if (x.atom.type == "None") {
|
||||
continue
|
||||
}
|
||||
if (x.atom.type == 'Any') {
|
||||
if (x.atom.type == "Any") {
|
||||
return x
|
||||
}
|
||||
if (y.atom.type == 'None') {
|
||||
if (y.atom.type == "None") {
|
||||
y = x
|
||||
} else {
|
||||
y = new VersionRange({ type: 'Or', left: y, right: x })
|
||||
y = new VersionRange({ type: "Or", left: y, right: x })
|
||||
}
|
||||
}
|
||||
return y
|
||||
}
|
||||
|
||||
static any() {
|
||||
return new VersionRange({ type: 'Any' })
|
||||
return new VersionRange({ type: "Any" })
|
||||
}
|
||||
|
||||
static none() {
|
||||
return new VersionRange({ type: 'None' })
|
||||
return new VersionRange({ type: "None" })
|
||||
}
|
||||
|
||||
satisfiedBy(version: Version | ExtendedVersion) {
|
||||
@@ -645,23 +645,23 @@ export class VersionRange {
|
||||
|
||||
tables(): VersionRangeTables {
|
||||
switch (this.atom.type) {
|
||||
case 'Anchor':
|
||||
case "Anchor":
|
||||
switch (this.atom.operator) {
|
||||
case '=':
|
||||
case "=":
|
||||
// `=1.2.3` is equivalent to `>=1.2.3 && <=1.2.4 && #flavor`
|
||||
return VersionRangeTable.and(
|
||||
VersionRangeTable.cmp(this.atom.version, -1, false, true),
|
||||
VersionRangeTable.cmp(this.atom.version, 1, true, false),
|
||||
)
|
||||
case '>':
|
||||
case ">":
|
||||
return VersionRangeTable.cmp(this.atom.version, 1, false, true)
|
||||
case '<':
|
||||
case "<":
|
||||
return VersionRangeTable.cmp(this.atom.version, -1, true, false)
|
||||
case '>=':
|
||||
case ">=":
|
||||
return VersionRangeTable.cmp(this.atom.version, -1, false, true)
|
||||
case '<=':
|
||||
case "<=":
|
||||
return VersionRangeTable.cmp(this.atom.version, 1, true, false)
|
||||
case '!=':
|
||||
case "!=":
|
||||
// `!=1.2.3` is equivalent to `!(>=1.2.3 && <=1.2.3 && #flavor)`
|
||||
// **not** equivalent to `(<1.2.3 || >1.2.3) && #flavor`
|
||||
return VersionRangeTable.not(
|
||||
@@ -670,7 +670,7 @@ export class VersionRange {
|
||||
VersionRangeTable.cmp(this.atom.version, 1, true, false),
|
||||
),
|
||||
)
|
||||
case '^':
|
||||
case "^":
|
||||
// `^1.2.3` is equivalent to `>=1.2.3 && <2.0.0 && #flavor`
|
||||
return VersionRangeTable.and(
|
||||
VersionRangeTable.cmp(this.atom.version, -1, false, true),
|
||||
@@ -681,7 +681,7 @@ export class VersionRange {
|
||||
false,
|
||||
),
|
||||
)
|
||||
case '~':
|
||||
case "~":
|
||||
// `~1.2.3` is equivalent to `>=1.2.3 && <1.3.0 && #flavor`
|
||||
return VersionRangeTable.and(
|
||||
VersionRangeTable.cmp(this.atom.version, -1, false, true),
|
||||
@@ -693,23 +693,23 @@ export class VersionRange {
|
||||
),
|
||||
)
|
||||
}
|
||||
case 'Flavor':
|
||||
case "Flavor":
|
||||
return VersionRangeTable.eqFlavor(this.atom.flavor)
|
||||
case 'Not':
|
||||
case "Not":
|
||||
return VersionRangeTable.not(this.atom.value.tables())
|
||||
case 'And':
|
||||
case "And":
|
||||
return VersionRangeTable.and(
|
||||
this.atom.left.tables(),
|
||||
this.atom.right.tables(),
|
||||
)
|
||||
case 'Or':
|
||||
case "Or":
|
||||
return VersionRangeTable.or(
|
||||
this.atom.left.tables(),
|
||||
this.atom.right.tables(),
|
||||
)
|
||||
case 'Any':
|
||||
case "Any":
|
||||
return true
|
||||
case 'None':
|
||||
case "None":
|
||||
return false
|
||||
}
|
||||
}
|
||||
@@ -734,23 +734,23 @@ export class Version {
|
||||
) {}
|
||||
|
||||
toString(): string {
|
||||
return `${this.number.join('.')}${this.prerelease.length > 0 ? `-${this.prerelease.join('.')}` : ''}`
|
||||
return `${this.number.join(".")}${this.prerelease.length > 0 ? `-${this.prerelease.join(".")}` : ""}`
|
||||
}
|
||||
|
||||
compare(other: Version): 'greater' | 'equal' | 'less' {
|
||||
compare(other: Version): "greater" | "equal" | "less" {
|
||||
const numLen = Math.max(this.number.length, other.number.length)
|
||||
for (let i = 0; i < numLen; i++) {
|
||||
if ((this.number[i] || 0) > (other.number[i] || 0)) {
|
||||
return 'greater'
|
||||
return "greater"
|
||||
} else if ((this.number[i] || 0) < (other.number[i] || 0)) {
|
||||
return 'less'
|
||||
return "less"
|
||||
}
|
||||
}
|
||||
|
||||
if (this.prerelease.length === 0 && other.prerelease.length !== 0) {
|
||||
return 'greater'
|
||||
return "greater"
|
||||
} else if (this.prerelease.length !== 0 && other.prerelease.length === 0) {
|
||||
return 'less'
|
||||
return "less"
|
||||
}
|
||||
|
||||
const prereleaseLen = Math.max(
|
||||
@@ -760,42 +760,42 @@ export class Version {
|
||||
for (let i = 0; i < prereleaseLen; i++) {
|
||||
if (typeof this.prerelease[i] === typeof other.prerelease[i]) {
|
||||
if (this.prerelease[i] > other.prerelease[i]) {
|
||||
return 'greater'
|
||||
return "greater"
|
||||
} else if (this.prerelease[i] < other.prerelease[i]) {
|
||||
return 'less'
|
||||
return "less"
|
||||
}
|
||||
} else {
|
||||
switch (`${typeof this.prerelease[1]}:${typeof other.prerelease[i]}`) {
|
||||
case 'number:string':
|
||||
return 'less'
|
||||
case 'string:number':
|
||||
return 'greater'
|
||||
case 'number:undefined':
|
||||
case 'string:undefined':
|
||||
return 'greater'
|
||||
case 'undefined:number':
|
||||
case 'undefined:string':
|
||||
return 'less'
|
||||
case "number:string":
|
||||
return "less"
|
||||
case "string:number":
|
||||
return "greater"
|
||||
case "number:undefined":
|
||||
case "string:undefined":
|
||||
return "greater"
|
||||
case "undefined:number":
|
||||
case "undefined:string":
|
||||
return "less"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return 'equal'
|
||||
return "equal"
|
||||
}
|
||||
|
||||
compareForSort(other: Version): -1 | 0 | 1 {
|
||||
switch (this.compare(other)) {
|
||||
case 'greater':
|
||||
case "greater":
|
||||
return 1
|
||||
case 'equal':
|
||||
case "equal":
|
||||
return 0
|
||||
case 'less':
|
||||
case "less":
|
||||
return -1
|
||||
}
|
||||
}
|
||||
|
||||
static parse(version: string): Version {
|
||||
const parsed = P.parse(version, { startRule: 'Version' })
|
||||
const parsed = P.parse(version, { startRule: "Version" })
|
||||
return new Version(parsed.number, parsed.prerelease)
|
||||
}
|
||||
|
||||
@@ -815,25 +815,25 @@ export class ExtendedVersion {
|
||||
) {}
|
||||
|
||||
toString(): string {
|
||||
return `${this.flavor ? `#${this.flavor}:` : ''}${this.upstream.toString()}:${this.downstream.toString()}`
|
||||
return `${this.flavor ? `#${this.flavor}:` : ""}${this.upstream.toString()}:${this.downstream.toString()}`
|
||||
}
|
||||
|
||||
compare(other: ExtendedVersion): 'greater' | 'equal' | 'less' | null {
|
||||
compare(other: ExtendedVersion): "greater" | "equal" | "less" | null {
|
||||
if (this.flavor !== other.flavor) {
|
||||
return null
|
||||
}
|
||||
const upstreamCmp = this.upstream.compare(other.upstream)
|
||||
if (upstreamCmp !== 'equal') {
|
||||
if (upstreamCmp !== "equal") {
|
||||
return upstreamCmp
|
||||
}
|
||||
return this.downstream.compare(other.downstream)
|
||||
}
|
||||
|
||||
compareLexicographic(other: ExtendedVersion): 'greater' | 'equal' | 'less' {
|
||||
if ((this.flavor || '') > (other.flavor || '')) {
|
||||
return 'greater'
|
||||
} else if ((this.flavor || '') > (other.flavor || '')) {
|
||||
return 'less'
|
||||
compareLexicographic(other: ExtendedVersion): "greater" | "equal" | "less" {
|
||||
if ((this.flavor || "") > (other.flavor || "")) {
|
||||
return "greater"
|
||||
} else if ((this.flavor || "") > (other.flavor || "")) {
|
||||
return "less"
|
||||
} else {
|
||||
return this.compare(other)!
|
||||
}
|
||||
@@ -841,37 +841,37 @@ export class ExtendedVersion {
|
||||
|
||||
compareForSort(other: ExtendedVersion): 1 | 0 | -1 {
|
||||
switch (this.compareLexicographic(other)) {
|
||||
case 'greater':
|
||||
case "greater":
|
||||
return 1
|
||||
case 'equal':
|
||||
case "equal":
|
||||
return 0
|
||||
case 'less':
|
||||
case "less":
|
||||
return -1
|
||||
}
|
||||
}
|
||||
|
||||
greaterThan(other: ExtendedVersion): boolean {
|
||||
return this.compare(other) === 'greater'
|
||||
return this.compare(other) === "greater"
|
||||
}
|
||||
|
||||
greaterThanOrEqual(other: ExtendedVersion): boolean {
|
||||
return ['greater', 'equal'].includes(this.compare(other) as string)
|
||||
return ["greater", "equal"].includes(this.compare(other) as string)
|
||||
}
|
||||
|
||||
equals(other: ExtendedVersion): boolean {
|
||||
return this.compare(other) === 'equal'
|
||||
return this.compare(other) === "equal"
|
||||
}
|
||||
|
||||
lessThan(other: ExtendedVersion): boolean {
|
||||
return this.compare(other) === 'less'
|
||||
return this.compare(other) === "less"
|
||||
}
|
||||
|
||||
lessThanOrEqual(other: ExtendedVersion): boolean {
|
||||
return ['less', 'equal'].includes(this.compare(other) as string)
|
||||
return ["less", "equal"].includes(this.compare(other) as string)
|
||||
}
|
||||
|
||||
static parse(extendedVersion: string): ExtendedVersion {
|
||||
const parsed = P.parse(extendedVersion, { startRule: 'ExtendedVersion' })
|
||||
const parsed = P.parse(extendedVersion, { startRule: "ExtendedVersion" })
|
||||
return new ExtendedVersion(
|
||||
parsed.flavor || null,
|
||||
new Version(parsed.upstream.number, parsed.upstream.prerelease),
|
||||
@@ -881,7 +881,7 @@ export class ExtendedVersion {
|
||||
|
||||
static parseEmver(extendedVersion: string): ExtendedVersion {
|
||||
try {
|
||||
const parsed = P.parse(extendedVersion, { startRule: 'Emver' })
|
||||
const parsed = P.parse(extendedVersion, { startRule: "Emver" })
|
||||
return new ExtendedVersion(
|
||||
parsed.flavor || null,
|
||||
new Version(parsed.upstream.number, parsed.upstream.prerelease),
|
||||
@@ -956,22 +956,22 @@ export class ExtendedVersion {
|
||||
*/
|
||||
satisfies(versionRange: VersionRange): boolean {
|
||||
switch (versionRange.atom.type) {
|
||||
case 'Anchor':
|
||||
case "Anchor":
|
||||
const otherVersion = versionRange.atom.version
|
||||
switch (versionRange.atom.operator) {
|
||||
case '=':
|
||||
case "=":
|
||||
return this.equals(otherVersion)
|
||||
case '>':
|
||||
case ">":
|
||||
return this.greaterThan(otherVersion)
|
||||
case '<':
|
||||
case "<":
|
||||
return this.lessThan(otherVersion)
|
||||
case '>=':
|
||||
case ">=":
|
||||
return this.greaterThanOrEqual(otherVersion)
|
||||
case '<=':
|
||||
case "<=":
|
||||
return this.lessThanOrEqual(otherVersion)
|
||||
case '!=':
|
||||
case "!=":
|
||||
return !this.equals(otherVersion)
|
||||
case '^':
|
||||
case "^":
|
||||
const nextMajor = versionRange.atom.version.incrementMajor()
|
||||
if (
|
||||
this.greaterThanOrEqual(otherVersion) &&
|
||||
@@ -981,7 +981,7 @@ export class ExtendedVersion {
|
||||
} else {
|
||||
return false
|
||||
}
|
||||
case '~':
|
||||
case "~":
|
||||
const nextMinor = versionRange.atom.version.incrementMinor()
|
||||
if (
|
||||
this.greaterThanOrEqual(otherVersion) &&
|
||||
@@ -992,23 +992,23 @@ export class ExtendedVersion {
|
||||
return false
|
||||
}
|
||||
}
|
||||
case 'Flavor':
|
||||
case "Flavor":
|
||||
return versionRange.atom.flavor == this.flavor
|
||||
case 'And':
|
||||
case "And":
|
||||
return (
|
||||
this.satisfies(versionRange.atom.left) &&
|
||||
this.satisfies(versionRange.atom.right)
|
||||
)
|
||||
case 'Or':
|
||||
case "Or":
|
||||
return (
|
||||
this.satisfies(versionRange.atom.left) ||
|
||||
this.satisfies(versionRange.atom.right)
|
||||
)
|
||||
case 'Not':
|
||||
case "Not":
|
||||
return !this.satisfies(versionRange.atom.value)
|
||||
case 'Any':
|
||||
case "Any":
|
||||
return true
|
||||
case 'None':
|
||||
case "None":
|
||||
return false
|
||||
}
|
||||
}
|
||||
@@ -1020,34 +1020,34 @@ export const testTypeVersion = <T extends string>(t: T & ValidateVersion<T>) =>
|
||||
t
|
||||
|
||||
function tests() {
|
||||
testTypeVersion('1.2.3')
|
||||
testTypeVersion('1')
|
||||
testTypeVersion('12.34.56')
|
||||
testTypeVersion('1.2-3')
|
||||
testTypeVersion('1-3')
|
||||
testTypeVersion('1-alpha')
|
||||
testTypeVersion("1.2.3")
|
||||
testTypeVersion("1")
|
||||
testTypeVersion("12.34.56")
|
||||
testTypeVersion("1.2-3")
|
||||
testTypeVersion("1-3")
|
||||
testTypeVersion("1-alpha")
|
||||
// @ts-expect-error
|
||||
testTypeVersion('-3')
|
||||
testTypeVersion("-3")
|
||||
// @ts-expect-error
|
||||
testTypeVersion('1.2.3:1')
|
||||
testTypeVersion("1.2.3:1")
|
||||
// @ts-expect-error
|
||||
testTypeVersion('#cat:1:1')
|
||||
testTypeVersion("#cat:1:1")
|
||||
|
||||
testTypeExVer('1.2.3:1.2.3')
|
||||
testTypeExVer('1.2.3.4.5.6.7.8.9.0:1')
|
||||
testTypeExVer('100:1')
|
||||
testTypeExVer('#cat:1:1')
|
||||
testTypeExVer('1.2.3.4.5.6.7.8.9.11.22.33:1')
|
||||
testTypeExVer('1-0:1')
|
||||
testTypeExVer('1-0:1')
|
||||
testTypeExVer("1.2.3:1.2.3")
|
||||
testTypeExVer("1.2.3.4.5.6.7.8.9.0:1")
|
||||
testTypeExVer("100:1")
|
||||
testTypeExVer("#cat:1:1")
|
||||
testTypeExVer("1.2.3.4.5.6.7.8.9.11.22.33:1")
|
||||
testTypeExVer("1-0:1")
|
||||
testTypeExVer("1-0:1")
|
||||
// @ts-expect-error
|
||||
testTypeExVer('1.2-3')
|
||||
testTypeExVer("1.2-3")
|
||||
// @ts-expect-error
|
||||
testTypeExVer('1-3')
|
||||
testTypeExVer("1-3")
|
||||
// @ts-expect-error
|
||||
testTypeExVer('1.2.3.4.5.6.7.8.9.0.10:1' as string)
|
||||
testTypeExVer("1.2.3.4.5.6.7.8.9.0.10:1" as string)
|
||||
// @ts-expect-error
|
||||
testTypeExVer('1.-2:1')
|
||||
testTypeExVer("1.-2:1")
|
||||
// @ts-expect-error
|
||||
testTypeExVer('1..2.3:3')
|
||||
testTypeExVer("1..2.3:3")
|
||||
}
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
export { S9pk } from './s9pk'
|
||||
export { VersionRange, ExtendedVersion, Version } from './exver'
|
||||
export { S9pk } from "./s9pk"
|
||||
export { VersionRange, ExtendedVersion, Version } from "./exver"
|
||||
|
||||
export * as inputSpec from './actions/input'
|
||||
export * as ISB from './actions/input/builder'
|
||||
export * as IST from './actions/input/inputSpecTypes'
|
||||
export * as types from './types'
|
||||
export * as T from './types'
|
||||
export * as yaml from 'yaml'
|
||||
export * as inits from './inits'
|
||||
export * as matches from 'ts-matches'
|
||||
export * as inputSpec from "./actions/input"
|
||||
export * as ISB from "./actions/input/builder"
|
||||
export * as IST from "./actions/input/inputSpecTypes"
|
||||
export * as types from "./types"
|
||||
export * as T from "./types"
|
||||
export * as yaml from "yaml"
|
||||
export * as inits from "./inits"
|
||||
export * as matches from "ts-matches"
|
||||
|
||||
export * as utils from './util'
|
||||
export * as utils from "./util"
|
||||
|
||||
@@ -1,2 +1,2 @@
|
||||
export * from './setupInit'
|
||||
export * from './setupUninit'
|
||||
export * from "./setupInit"
|
||||
export * from "./setupUninit"
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
import { VersionRange } from '../../../base/lib/exver'
|
||||
import * as T from '../../../base/lib/types'
|
||||
import { once } from '../util'
|
||||
import { VersionRange } from "../../../base/lib/exver"
|
||||
import * as T from "../../../base/lib/types"
|
||||
import { once } from "../util"
|
||||
|
||||
export type InitKind = 'install' | 'update' | 'restore' | null
|
||||
export type InitKind = "install" | "update" | "restore" | null
|
||||
|
||||
export type InitFn<Kind extends InitKind = InitKind> = (
|
||||
effects: T.Effects,
|
||||
@@ -31,7 +31,7 @@ export function setupInit(...inits: InitScriptOrFn[]): T.ExpectedExports.init {
|
||||
complete.then(() => fn()).catch(console.error),
|
||||
)
|
||||
try {
|
||||
if ('init' in init) await init.init(e, opts.kind)
|
||||
if ("init" in init) await init.init(e, opts.kind)
|
||||
else await init(e, opts.kind)
|
||||
} finally {
|
||||
res()
|
||||
@@ -43,7 +43,7 @@ export function setupInit(...inits: InitScriptOrFn[]): T.ExpectedExports.init {
|
||||
}
|
||||
|
||||
export function setupOnInit(onInit: InitScriptOrFn): InitScript {
|
||||
return 'init' in onInit
|
||||
return "init" in onInit
|
||||
? onInit
|
||||
: {
|
||||
init: async (effects, kind) => {
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import { ExtendedVersion, VersionRange } from '../../../base/lib/exver'
|
||||
import * as T from '../../../base/lib/types'
|
||||
import { ExtendedVersion, VersionRange } from "../../../base/lib/exver"
|
||||
import * as T from "../../../base/lib/types"
|
||||
|
||||
export type UninitFn = (
|
||||
effects: T.Effects,
|
||||
@@ -34,14 +34,14 @@ export function setupUninit(
|
||||
): T.ExpectedExports.uninit {
|
||||
return async (opts) => {
|
||||
for (const uninit of uninits) {
|
||||
if ('uninit' in uninit) await uninit.uninit(opts.effects, opts.target)
|
||||
if ("uninit" in uninit) await uninit.uninit(opts.effects, opts.target)
|
||||
else await uninit(opts.effects, opts.target)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export function setupOnUninit(onUninit: UninitScriptOrFn): UninitScript {
|
||||
return 'uninit' in onUninit
|
||||
return "uninit" in onUninit
|
||||
? onUninit
|
||||
: {
|
||||
uninit: async (effects, target) => {
|
||||
|
||||
@@ -1,44 +1,72 @@
|
||||
import { object, string } from 'ts-matches'
|
||||
import { Effects } from '../Effects'
|
||||
import { Origin } from './Origin'
|
||||
import { AddSslOptions, BindParams } from '../osBindings'
|
||||
import { Security } from '../osBindings'
|
||||
import { BindOptions } from '../osBindings'
|
||||
import { AlpnInfo } from '../osBindings'
|
||||
/**
|
||||
* @module Host
|
||||
*
|
||||
* This module provides the MultiHost class for binding network ports and
|
||||
* exposing service interfaces through the StartOS networking layer.
|
||||
*
|
||||
* MultiHost handles the complexity of:
|
||||
* - Port binding with protocol-specific defaults
|
||||
* - Automatic SSL/TLS setup for secure protocols
|
||||
* - Integration with Tor and LAN networking
|
||||
*/
|
||||
|
||||
import { object, string } from "ts-matches"
|
||||
import { Effects } from "../Effects"
|
||||
import { Origin } from "./Origin"
|
||||
import { AddSslOptions, BindParams } from "../osBindings"
|
||||
import { Security } from "../osBindings"
|
||||
import { BindOptions } from "../osBindings"
|
||||
import { AlpnInfo } from "../osBindings"
|
||||
|
||||
export { AddSslOptions, Security, BindOptions }
|
||||
|
||||
/**
|
||||
* Known protocol definitions with their default ports and SSL variants.
|
||||
*
|
||||
* Each protocol includes:
|
||||
* - `secure` - Whether the protocol is inherently secure (SSL/TLS)
|
||||
* - `defaultPort` - Standard port for this protocol
|
||||
* - `withSsl` - The SSL variant of the protocol (if applicable)
|
||||
* - `alpn` - ALPN negotiation info for TLS
|
||||
*/
|
||||
export const knownProtocols = {
|
||||
/** HTTP - plain text web traffic, auto-upgrades to HTTPS */
|
||||
http: {
|
||||
secure: null,
|
||||
defaultPort: 80,
|
||||
withSsl: 'https',
|
||||
alpn: { specified: ['http/1.1'] } as AlpnInfo,
|
||||
withSsl: "https",
|
||||
alpn: { specified: ["http/1.1"] } as AlpnInfo,
|
||||
},
|
||||
/** HTTPS - encrypted web traffic */
|
||||
https: {
|
||||
secure: { ssl: true },
|
||||
defaultPort: 443,
|
||||
},
|
||||
/** WebSocket - plain text, auto-upgrades to WSS */
|
||||
ws: {
|
||||
secure: null,
|
||||
defaultPort: 80,
|
||||
withSsl: 'wss',
|
||||
alpn: { specified: ['http/1.1'] } as AlpnInfo,
|
||||
withSsl: "wss",
|
||||
alpn: { specified: ["http/1.1"] } as AlpnInfo,
|
||||
},
|
||||
/** Secure WebSocket */
|
||||
wss: {
|
||||
secure: { ssl: true },
|
||||
defaultPort: 443,
|
||||
},
|
||||
/** SSH - inherently secure (no SSL wrapper needed) */
|
||||
ssh: {
|
||||
secure: { ssl: false },
|
||||
defaultPort: 22,
|
||||
},
|
||||
/** DNS - domain name service */
|
||||
dns: {
|
||||
secure: { ssl: false },
|
||||
defaultPort: 53,
|
||||
},
|
||||
} as const
|
||||
|
||||
/** Protocol scheme string or null for no scheme */
|
||||
export type Scheme = string | null
|
||||
|
||||
type KnownProtocols = typeof knownProtocols
|
||||
@@ -69,14 +97,47 @@ export type BindOptionsByProtocol =
|
||||
| BindOptionsByKnownProtocol
|
||||
| (BindOptions & { protocol: null })
|
||||
|
||||
/** @internal Helper to detect if protocol is a known protocol string */
|
||||
const hasStringProtocol = object({
|
||||
protocol: string,
|
||||
}).test
|
||||
|
||||
/**
|
||||
* Manages network bindings for a service interface.
|
||||
*
|
||||
* MultiHost is the primary way to expose your service's ports to users.
|
||||
* It handles:
|
||||
* - Port binding with the StartOS networking layer
|
||||
* - Protocol-aware defaults (HTTP uses port 80, HTTPS uses 443, etc.)
|
||||
* - Automatic SSL certificate provisioning for secure protocols
|
||||
* - Creation of Origin objects for exporting service interfaces
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* // Create a host for the web UI
|
||||
* const webHost = sdk.MultiHost.of(effects, 'webui')
|
||||
*
|
||||
* // Bind port 3000 with HTTP (automatically adds HTTPS variant)
|
||||
* const webOrigin = await webHost.bindPort(3000, { protocol: 'http' })
|
||||
*
|
||||
* // Export the interface
|
||||
* await webOrigin.export([
|
||||
* sdk.ServiceInterfaceBuilder.of({
|
||||
* effects,
|
||||
* name: 'Web Interface',
|
||||
* id: 'webui',
|
||||
* description: 'Access the dashboard',
|
||||
* type: 'ui',
|
||||
* })
|
||||
* ])
|
||||
* ```
|
||||
*/
|
||||
export class MultiHost {
|
||||
constructor(
|
||||
readonly options: {
|
||||
/** Effects instance for system operations */
|
||||
effects: Effects
|
||||
/** Unique identifier for this host binding */
|
||||
id: string
|
||||
},
|
||||
) {}
|
||||
@@ -140,8 +201,8 @@ export class MultiHost {
|
||||
addXForwardedHeaders: false,
|
||||
preferredExternalPort: knownProtocols[sslProto].defaultPort,
|
||||
scheme: sslProto,
|
||||
alpn: 'alpn' in protoInfo ? protoInfo.alpn : null,
|
||||
...('addSsl' in options ? options.addSsl : null),
|
||||
alpn: "alpn" in protoInfo ? protoInfo.alpn : null,
|
||||
...("addSsl" in options ? options.addSsl : null),
|
||||
}
|
||||
: options.addSsl
|
||||
? {
|
||||
@@ -149,7 +210,7 @@ export class MultiHost {
|
||||
preferredExternalPort: 443,
|
||||
scheme: sslProto,
|
||||
alpn: null,
|
||||
...('addSsl' in options ? options.addSsl : null),
|
||||
...("addSsl" in options ? options.addSsl : null),
|
||||
}
|
||||
: null
|
||||
|
||||
@@ -169,8 +230,8 @@ export class MultiHost {
|
||||
private getSslProto(options: BindOptionsByKnownProtocol) {
|
||||
const proto = options.protocol
|
||||
const protoInfo = knownProtocols[proto]
|
||||
if (inObject('noAddSsl', options) && options.noAddSsl) return null
|
||||
if ('withSsl' in protoInfo && protoInfo.withSsl) return protoInfo.withSsl
|
||||
if (inObject("noAddSsl", options) && options.noAddSsl) return null
|
||||
if ("withSsl" in protoInfo && protoInfo.withSsl) return protoInfo.withSsl
|
||||
if (protoInfo.secure?.ssl) return proto
|
||||
return null
|
||||
}
|
||||
|
||||
@@ -1,16 +1,66 @@
|
||||
import { AddressInfo } from '../types'
|
||||
import { AddressReceipt } from './AddressReceipt'
|
||||
import { MultiHost, Scheme } from './Host'
|
||||
import { ServiceInterfaceBuilder } from './ServiceInterfaceBuilder'
|
||||
/**
|
||||
* @module Origin
|
||||
*
|
||||
* The Origin class represents a bound network origin (protocol + host + port)
|
||||
* that can be used to export service interfaces.
|
||||
*/
|
||||
|
||||
import { AddressInfo } from "../types"
|
||||
import { AddressReceipt } from "./AddressReceipt"
|
||||
import { MultiHost, Scheme } from "./Host"
|
||||
import { ServiceInterfaceBuilder } from "./ServiceInterfaceBuilder"
|
||||
|
||||
/**
|
||||
* Represents a network origin (protocol://host:port) created from a MultiHost binding.
|
||||
*
|
||||
* Origins are created by calling `MultiHost.bindPort()` and can be used to
|
||||
* export one or more service interfaces that share the same underlying connection.
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* // Create origin from host binding
|
||||
* const origin = await webHost.bindPort(8080, { protocol: 'http' })
|
||||
*
|
||||
* // Export multiple interfaces sharing this origin
|
||||
* await origin.export([
|
||||
* sdk.ServiceInterfaceBuilder.of({
|
||||
* effects,
|
||||
* name: 'Web UI',
|
||||
* id: 'ui',
|
||||
* type: 'ui',
|
||||
* description: 'Main web interface',
|
||||
* }),
|
||||
* sdk.ServiceInterfaceBuilder.of({
|
||||
* effects,
|
||||
* name: 'REST API',
|
||||
* id: 'api',
|
||||
* type: 'api',
|
||||
* description: 'JSON API endpoint',
|
||||
* path: '/api/v1',
|
||||
* }),
|
||||
* ])
|
||||
* ```
|
||||
*/
|
||||
export class Origin {
|
||||
constructor(
|
||||
/** The MultiHost this origin was created from */
|
||||
readonly host: MultiHost,
|
||||
/** The internal port this origin is bound to */
|
||||
readonly internalPort: number,
|
||||
/** The protocol scheme (e.g., "http", "ssh") or null */
|
||||
readonly scheme: string | null,
|
||||
/** The SSL variant scheme (e.g., "https", "wss") or null */
|
||||
readonly sslScheme: string | null,
|
||||
) {}
|
||||
|
||||
/**
|
||||
* Builds an AddressInfo object for this origin with the specified options.
|
||||
* Used internally by `export()` but can be called directly for custom use cases.
|
||||
*
|
||||
* @param options - Build options including path, query params, username, and scheme overrides
|
||||
* @returns AddressInfo object describing the complete address
|
||||
* @internal
|
||||
*/
|
||||
build({
|
||||
username,
|
||||
path,
|
||||
@@ -21,9 +71,9 @@ export class Origin {
|
||||
.map(
|
||||
([key, val]) => `${encodeURIComponent(key)}=${encodeURIComponent(val)}`,
|
||||
)
|
||||
.join('&')
|
||||
.join("&")
|
||||
|
||||
const qp = qpEntries.length ? `?${qpEntries}` : ''
|
||||
const qp = qpEntries.length ? `?${qpEntries}` : ""
|
||||
|
||||
return {
|
||||
hostId: this.host.options.id,
|
||||
@@ -36,12 +86,28 @@ export class Origin {
|
||||
}
|
||||
|
||||
/**
|
||||
* @description A function to register a group of origins (<PROTOCOL> :// <HOSTNAME> : <PORT>) with StartOS
|
||||
* Exports one or more service interfaces for this origin.
|
||||
*
|
||||
* The returned addressReceipt serves as proof that the addresses were registered
|
||||
* Each service interface becomes a clickable link in the StartOS UI.
|
||||
* Multiple interfaces can share the same origin but have different
|
||||
* names, descriptions, types, paths, or query parameters.
|
||||
*
|
||||
* @param addressInfo
|
||||
* @returns
|
||||
* @param serviceInterfaces - Array of ServiceInterfaceBuilder objects to export
|
||||
* @returns Promise resolving to array of AddressInfo with an AddressReceipt
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* await origin.export([
|
||||
* sdk.ServiceInterfaceBuilder.of({
|
||||
* effects,
|
||||
* name: 'Admin Panel',
|
||||
* id: 'admin',
|
||||
* type: 'ui',
|
||||
* description: 'Administrator dashboard',
|
||||
* path: '/admin',
|
||||
* })
|
||||
* ])
|
||||
* ```
|
||||
*/
|
||||
async export(
|
||||
serviceInterfaces: ServiceInterfaceBuilder[],
|
||||
@@ -83,9 +149,17 @@ export class Origin {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Options for building an address from an Origin.
|
||||
* @internal
|
||||
*/
|
||||
type BuildOptions = {
|
||||
/** Override the default schemes for SSL and non-SSL connections */
|
||||
schemeOverride: { ssl: Scheme; noSsl: Scheme } | null
|
||||
/** Optional username for basic auth URLs */
|
||||
username: string | null
|
||||
/** URL path (e.g., "/api/v1") */
|
||||
path: string
|
||||
/** Query parameters to append to the URL */
|
||||
query: Record<string, string>
|
||||
}
|
||||
|
||||
@@ -1,30 +1,86 @@
|
||||
import { ServiceInterfaceType } from '../types'
|
||||
import { Effects } from '../Effects'
|
||||
import { Scheme } from './Host'
|
||||
/**
|
||||
* @module ServiceInterfaceBuilder
|
||||
*
|
||||
* Provides the ServiceInterfaceBuilder class for creating service interface
|
||||
* configurations that are exported to the StartOS UI.
|
||||
*/
|
||||
|
||||
import { ServiceInterfaceType } from "../types"
|
||||
import { Effects } from "../Effects"
|
||||
import { Scheme } from "./Host"
|
||||
|
||||
/**
|
||||
* A helper class for creating a Network Interface
|
||||
* Builder class for creating service interface configurations.
|
||||
*
|
||||
* Network Interfaces are collections of web addresses that expose the same API or other resource,
|
||||
* display to the user with under a common name and description.
|
||||
* A service interface represents a user-visible endpoint in the StartOS UI.
|
||||
* It appears as a clickable link that users can use to access your service's
|
||||
* web UI, API, or other network resources.
|
||||
*
|
||||
* All URIs on an interface inherit the same ui: bool, basic auth credentials, path, and search (query) params
|
||||
* Interfaces are created with this builder and then exported via `Origin.export()`.
|
||||
*
|
||||
* @param options
|
||||
* @returns
|
||||
* @example
|
||||
* ```typescript
|
||||
* // Create a basic web UI interface
|
||||
* const webInterface = sdk.ServiceInterfaceBuilder.of({
|
||||
* effects,
|
||||
* name: 'Web Interface',
|
||||
* id: 'webui',
|
||||
* description: 'Access the main web dashboard',
|
||||
* type: 'ui',
|
||||
* })
|
||||
*
|
||||
* // Create an API interface with a specific path
|
||||
* const apiInterface = sdk.ServiceInterfaceBuilder.of({
|
||||
* effects,
|
||||
* name: 'REST API',
|
||||
* id: 'api',
|
||||
* description: 'JSON API for programmatic access',
|
||||
* type: 'api',
|
||||
* path: '/api/v1',
|
||||
* })
|
||||
*
|
||||
* // Create an interface with basic auth
|
||||
* const protectedInterface = sdk.ServiceInterfaceBuilder.of({
|
||||
* effects,
|
||||
* name: 'Admin Panel',
|
||||
* id: 'admin',
|
||||
* description: 'Protected admin area',
|
||||
* type: 'ui',
|
||||
* username: 'admin',
|
||||
* masked: true, // Hide the URL from casual viewing
|
||||
* })
|
||||
*
|
||||
* // Export all interfaces on the same origin
|
||||
* await origin.export([webInterface, apiInterface, protectedInterface])
|
||||
* ```
|
||||
*/
|
||||
export class ServiceInterfaceBuilder {
|
||||
constructor(
|
||||
readonly options: {
|
||||
/** Effects instance for system operations */
|
||||
effects: Effects
|
||||
/** Display name shown in the StartOS UI */
|
||||
name: string
|
||||
/** Unique identifier for this interface */
|
||||
id: string
|
||||
/** Description shown below the interface name */
|
||||
description: string
|
||||
/**
|
||||
* Type of interface:
|
||||
* - `"ui"` - Web interface (opens in browser)
|
||||
* - `"api"` - API endpoint (for programmatic access)
|
||||
* - `"p2p"` - Peer-to-peer endpoint (e.g., Bitcoin P2P)
|
||||
*/
|
||||
type: ServiceInterfaceType
|
||||
/** Username for basic auth URLs (null for no auth) */
|
||||
username: string | null
|
||||
/** URL path to append (e.g., "/admin", "/api/v1") */
|
||||
path: string
|
||||
/** Query parameters to append to the URL */
|
||||
query: Record<string, string>
|
||||
/** Override default protocol schemes */
|
||||
schemeOverride: { ssl: Scheme; noSsl: Scheme } | null
|
||||
/** If true, the URL is hidden/masked in the UI (for sensitive endpoints) */
|
||||
masked: boolean
|
||||
},
|
||||
) {}
|
||||
|
||||
@@ -1,20 +1,84 @@
|
||||
import * as T from '../types'
|
||||
import { once } from '../util'
|
||||
import { AddressReceipt } from './AddressReceipt'
|
||||
/**
|
||||
* @module setupInterfaces
|
||||
*
|
||||
* This module provides utilities for setting up network interfaces (service endpoints)
|
||||
* that are exposed to users through the StartOS UI.
|
||||
*
|
||||
* Service interfaces are the clickable links users see to access your service's
|
||||
* web UI, API endpoints, or peer-to-peer connections.
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* export const setInterfaces = sdk.setupInterfaces(async ({ effects }) => {
|
||||
* const webHost = sdk.MultiHost.of(effects, 'webui')
|
||||
* const webOrigin = await webHost.bindPort(8080, { protocol: 'http' })
|
||||
*
|
||||
* await webOrigin.export([
|
||||
* sdk.ServiceInterfaceBuilder.of({
|
||||
* effects,
|
||||
* name: 'Web Interface',
|
||||
* id: 'webui',
|
||||
* description: 'Access the web dashboard',
|
||||
* type: 'ui',
|
||||
* })
|
||||
* ])
|
||||
*
|
||||
* return [webOrigin]
|
||||
* })
|
||||
* ```
|
||||
*/
|
||||
|
||||
import * as T from "../types"
|
||||
import { once } from "../util"
|
||||
import { AddressReceipt } from "./AddressReceipt"
|
||||
|
||||
/** @internal Type brand for interface update receipt */
|
||||
declare const UpdateServiceInterfacesProof: unique symbol
|
||||
|
||||
/**
|
||||
* Receipt type proving that service interfaces have been updated.
|
||||
* @internal
|
||||
*/
|
||||
export type UpdateServiceInterfacesReceipt = {
|
||||
[UpdateServiceInterfacesProof]: never
|
||||
}
|
||||
|
||||
/** Array of address info arrays with receipts, representing all exported interfaces */
|
||||
export type ServiceInterfacesReceipt = Array<T.AddressInfo[] & AddressReceipt>
|
||||
|
||||
/**
|
||||
* Function type for setting up service interfaces.
|
||||
* @typeParam Output - The specific receipt type returned
|
||||
*/
|
||||
export type SetServiceInterfaces<Output extends ServiceInterfacesReceipt> =
|
||||
(opts: { effects: T.Effects }) => Promise<Output>
|
||||
|
||||
/** Function type for the init-compatible interface updater */
|
||||
export type UpdateServiceInterfaces = (effects: T.Effects) => Promise<null>
|
||||
|
||||
/** Function type for the setupServiceInterfaces helper */
|
||||
export type SetupServiceInterfaces = <Output extends ServiceInterfacesReceipt>(
|
||||
fn: SetServiceInterfaces<Output>,
|
||||
) => UpdateServiceInterfaces
|
||||
|
||||
/**
|
||||
* Constant indicating no interface changes are needed.
|
||||
* Use this as a return value when interfaces don't need to be updated.
|
||||
*/
|
||||
export const NO_INTERFACE_CHANGES = {} as UpdateServiceInterfacesReceipt
|
||||
|
||||
/**
|
||||
* Creates an interface setup function for use in the initialization pipeline.
|
||||
*
|
||||
* **Note:** This is exposed via `sdk.setupInterfaces`. See the SDK documentation
|
||||
* for full usage examples and parameter descriptions.
|
||||
*
|
||||
* Internally, this wrapper:
|
||||
* - Tracks all bindings and interfaces created during setup
|
||||
* - Automatically cleans up stale bindings/interfaces that weren't recreated
|
||||
*
|
||||
* @see sdk.setupInterfaces for usage documentation
|
||||
*/
|
||||
export const setupServiceInterfaces: SetupServiceInterfaces = <
|
||||
Output extends ServiceInterfacesReceipt,
|
||||
>(
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { AnyVerifyingKey } from './AnyVerifyingKey'
|
||||
import type { AnyVerifyingKey } from "./AnyVerifyingKey"
|
||||
|
||||
export type AcceptSigners =
|
||||
| { signer: AnyVerifyingKey }
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { Guid } from './Guid'
|
||||
import type { Guid } from "./Guid"
|
||||
|
||||
export type ActionInput = {
|
||||
eventId: Guid
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { ActionVisibility } from './ActionVisibility'
|
||||
import type { AllowedStatuses } from './AllowedStatuses'
|
||||
import type { ActionVisibility } from "./ActionVisibility"
|
||||
import type { AllowedStatuses } from "./AllowedStatuses"
|
||||
|
||||
export type ActionMetadata = {
|
||||
/**
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { ActionResultV0 } from './ActionResultV0'
|
||||
import type { ActionResultV1 } from './ActionResultV1'
|
||||
import type { ActionResultV0 } from "./ActionResultV0"
|
||||
import type { ActionResultV1 } from "./ActionResultV1"
|
||||
|
||||
export type ActionResult =
|
||||
| ({ version: '0' } & ActionResultV0)
|
||||
| ({ version: '1' } & ActionResultV1)
|
||||
| ({ version: "0" } & ActionResultV0)
|
||||
| ({ version: "1" } & ActionResultV1)
|
||||
|
||||
@@ -11,7 +11,7 @@ export type ActionResultMember = {
|
||||
description: string | null
|
||||
} & (
|
||||
| {
|
||||
type: 'single'
|
||||
type: "single"
|
||||
/**
|
||||
* The actual string value to display
|
||||
*/
|
||||
@@ -30,7 +30,7 @@ export type ActionResultMember = {
|
||||
masked: boolean
|
||||
}
|
||||
| {
|
||||
type: 'group'
|
||||
type: "group"
|
||||
/**
|
||||
* An new group of nested values, experienced by the user as an accordion dropdown
|
||||
*/
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { ActionResultValue } from './ActionResultValue'
|
||||
import type { ActionResultValue } from "./ActionResultValue"
|
||||
|
||||
export type ActionResultV1 = {
|
||||
/**
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { ActionResultMember } from './ActionResultMember'
|
||||
import type { ActionResultMember } from "./ActionResultMember"
|
||||
|
||||
export type ActionResultValue =
|
||||
| {
|
||||
type: 'single'
|
||||
type: "single"
|
||||
/**
|
||||
* The actual string value to display
|
||||
*/
|
||||
@@ -22,7 +22,7 @@ export type ActionResultValue =
|
||||
masked: boolean
|
||||
}
|
||||
| {
|
||||
type: 'group'
|
||||
type: "group"
|
||||
/**
|
||||
* An new group of nested values, experienced by the user as an accordion dropdown
|
||||
*/
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
|
||||
export type ActionVisibility = 'hidden' | { disabled: string } | 'enabled'
|
||||
export type ActionVisibility = "hidden" | { disabled: string } | "enabled"
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { Guid } from './Guid'
|
||||
import type { Guid } from "./Guid"
|
||||
|
||||
export type AddAdminParams = { signer: Guid }
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { AnySignature } from './AnySignature'
|
||||
import type { Blake3Commitment } from './Blake3Commitment'
|
||||
import type { AnySignature } from "./AnySignature"
|
||||
import type { Blake3Commitment } from "./Blake3Commitment"
|
||||
|
||||
export type AddAssetParams = {
|
||||
version: string
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { LocaleString } from './LocaleString'
|
||||
import type { LocaleString } from "./LocaleString"
|
||||
|
||||
export type AddCategoryParams = { id: string; name: LocaleString }
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { AnySignature } from './AnySignature'
|
||||
import type { MerkleArchiveCommitment } from './MerkleArchiveCommitment'
|
||||
import type { AnySignature } from "./AnySignature"
|
||||
import type { MerkleArchiveCommitment } from "./MerkleArchiveCommitment"
|
||||
|
||||
export type AddMirrorParams = {
|
||||
url: string
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { AnySignature } from './AnySignature'
|
||||
import type { MerkleArchiveCommitment } from './MerkleArchiveCommitment'
|
||||
import type { AnySignature } from "./AnySignature"
|
||||
import type { MerkleArchiveCommitment } from "./MerkleArchiveCommitment"
|
||||
|
||||
export type AddPackageParams = {
|
||||
urls: string[]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { Guid } from './Guid'
|
||||
import type { PackageId } from './PackageId'
|
||||
import type { Guid } from "./Guid"
|
||||
import type { PackageId } from "./PackageId"
|
||||
|
||||
export type AddPackageSignerParams = {
|
||||
id: PackageId
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { PackageId } from './PackageId'
|
||||
import type { PackageId } from "./PackageId"
|
||||
|
||||
export type AddPackageToCategoryParams = { id: string; package: PackageId }
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { AlpnInfo } from './AlpnInfo'
|
||||
import type { AlpnInfo } from "./AlpnInfo"
|
||||
|
||||
export type AddSslOptions = {
|
||||
preferredExternalPort: number
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { HostId } from './HostId'
|
||||
import type { HostId } from "./HostId"
|
||||
|
||||
export type AddressInfo = {
|
||||
username: string | null
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { LocaleString } from './LocaleString'
|
||||
import type { LocaleString } from "./LocaleString"
|
||||
|
||||
export type Alerts = {
|
||||
install: LocaleString | null
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
|
||||
export type Algorithm = 'ecdsa' | 'ed25519'
|
||||
export type Algorithm = "ecdsa" | "ed25519"
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { PackageDataEntry } from './PackageDataEntry'
|
||||
import type { PackageId } from './PackageId'
|
||||
import type { PackageDataEntry } from "./PackageDataEntry"
|
||||
import type { PackageId } from "./PackageId"
|
||||
|
||||
export type AllPackageData = { [key: PackageId]: PackageDataEntry }
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
|
||||
export type AllowedStatuses = 'only-running' | 'only-stopped' | 'any'
|
||||
export type AllowedStatuses = "only-running" | "only-stopped" | "any"
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { MaybeUtf8String } from './MaybeUtf8String'
|
||||
import type { MaybeUtf8String } from "./MaybeUtf8String"
|
||||
|
||||
export type AlpnInfo = 'reflect' | { specified: Array<MaybeUtf8String> }
|
||||
export type AlpnInfo = "reflect" | { specified: Array<MaybeUtf8String> }
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
|
||||
export type ApiState = 'error' | 'initializing' | 'running'
|
||||
export type ApiState = "error" | "initializing" | "running"
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { EncryptedWire } from './EncryptedWire'
|
||||
import type { EncryptedWire } from "./EncryptedWire"
|
||||
|
||||
export type AttachParams = {
|
||||
password: EncryptedWire | null
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { BlockDev } from './BlockDev'
|
||||
import type { Cifs } from './Cifs'
|
||||
import type { BlockDev } from "./BlockDev"
|
||||
import type { Cifs } from "./Cifs"
|
||||
|
||||
export type BackupTargetFS =
|
||||
| ({ type: 'disk' } & BlockDev)
|
||||
| ({ type: 'cifs' } & Cifs)
|
||||
| ({ type: "disk" } & BlockDev)
|
||||
| ({ type: "cifs" } & Cifs)
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { HostId } from './HostId'
|
||||
import type { HostId } from "./HostId"
|
||||
|
||||
export type BindId = { id: HostId; internalPort: number }
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { BindOptions } from './BindOptions'
|
||||
import type { NetInfo } from './NetInfo'
|
||||
import type { BindOptions } from "./BindOptions"
|
||||
import type { NetInfo } from "./NetInfo"
|
||||
|
||||
export type BindInfo = { enabled: boolean; options: BindOptions; net: NetInfo }
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { AddSslOptions } from './AddSslOptions'
|
||||
import type { Security } from './Security'
|
||||
import type { AddSslOptions } from "./AddSslOptions"
|
||||
import type { Security } from "./Security"
|
||||
|
||||
export type BindOptions = {
|
||||
preferredExternalPort: number
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { AddSslOptions } from './AddSslOptions'
|
||||
import type { HostId } from './HostId'
|
||||
import type { Security } from './Security'
|
||||
import type { AddSslOptions } from "./AddSslOptions"
|
||||
import type { HostId } from "./HostId"
|
||||
import type { Security } from "./Security"
|
||||
|
||||
export type BindParams = {
|
||||
id: HostId
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { GatewayId } from './GatewayId'
|
||||
import type { GatewayId } from "./GatewayId"
|
||||
|
||||
export type BindingGatewaySetEnabledParams = {
|
||||
internalPort: number
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { Base64 } from './Base64'
|
||||
import type { Base64 } from "./Base64"
|
||||
|
||||
export type Blake3Commitment = { hash: Base64; size: number }
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { LocaleString } from './LocaleString'
|
||||
import type { LocaleString } from "./LocaleString"
|
||||
|
||||
export type Category = { name: LocaleString }
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { PackageId } from './PackageId'
|
||||
import type { PackageId } from "./PackageId"
|
||||
|
||||
export type CheckDependenciesParam = { packageIds?: Array<PackageId> }
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { HealthCheckId } from './HealthCheckId'
|
||||
import type { NamedHealthCheckResult } from './NamedHealthCheckResult'
|
||||
import type { PackageId } from './PackageId'
|
||||
import type { ReplayId } from './ReplayId'
|
||||
import type { TaskEntry } from './TaskEntry'
|
||||
import type { Version } from './Version'
|
||||
import type { HealthCheckId } from "./HealthCheckId"
|
||||
import type { NamedHealthCheckResult } from "./NamedHealthCheckResult"
|
||||
import type { PackageId } from "./PackageId"
|
||||
import type { ReplayId } from "./ReplayId"
|
||||
import type { TaskEntry } from "./TaskEntry"
|
||||
import type { Version } from "./Version"
|
||||
|
||||
export type CheckDependenciesResult = {
|
||||
packageId: PackageId
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { ActionId } from './ActionId'
|
||||
import type { ActionId } from "./ActionId"
|
||||
|
||||
export type ClearActionsParams = { except: Array<ActionId> }
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { BindId } from './BindId'
|
||||
import type { BindId } from "./BindId"
|
||||
|
||||
export type ClearBindingsParams = { except: Array<BindId> }
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { ServiceInterfaceId } from './ServiceInterfaceId'
|
||||
import type { ServiceInterfaceId } from "./ServiceInterfaceId"
|
||||
|
||||
export type ClearServiceInterfacesParams = { except: Array<ServiceInterfaceId> }
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { ImageId } from './ImageId'
|
||||
import type { ImageId } from "./ImageId"
|
||||
|
||||
export type CreateSubcontainerFsParams = {
|
||||
imageId: ImageId
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { ActionId } from './ActionId'
|
||||
import type { PackageId } from './PackageId'
|
||||
import type { ReplayId } from './ReplayId'
|
||||
import type { TaskInput } from './TaskInput'
|
||||
import type { TaskSeverity } from './TaskSeverity'
|
||||
import type { TaskTrigger } from './TaskTrigger'
|
||||
import type { ActionId } from "./ActionId"
|
||||
import type { PackageId } from "./PackageId"
|
||||
import type { ReplayId } from "./ReplayId"
|
||||
import type { TaskInput } from "./TaskInput"
|
||||
import type { TaskSeverity } from "./TaskSeverity"
|
||||
import type { TaskTrigger } from "./TaskTrigger"
|
||||
|
||||
export type CreateTaskParams = {
|
||||
replayId: ReplayId
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { CurrentDependencyInfo } from './CurrentDependencyInfo'
|
||||
import type { PackageId } from './PackageId'
|
||||
import type { CurrentDependencyInfo } from "./CurrentDependencyInfo"
|
||||
import type { PackageId } from "./PackageId"
|
||||
|
||||
export type CurrentDependencies = { [key: PackageId]: CurrentDependencyInfo }
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { DataUrl } from './DataUrl'
|
||||
import type { LocaleString } from './LocaleString'
|
||||
import type { DataUrl } from "./DataUrl"
|
||||
import type { LocaleString } from "./LocaleString"
|
||||
|
||||
export type CurrentDependencyInfo = {
|
||||
title: LocaleString | null
|
||||
icon: DataUrl | null
|
||||
versionRange: string
|
||||
} & ({ kind: 'exists' } | { kind: 'running'; healthChecks: string[] })
|
||||
} & ({ kind: "exists" } | { kind: "running"; healthChecks: string[] })
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { MetadataSrc } from './MetadataSrc'
|
||||
import type { MetadataSrc } from "./MetadataSrc"
|
||||
|
||||
export type DepInfo = {
|
||||
description: string | null
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { DepInfo } from './DepInfo'
|
||||
import type { PackageId } from './PackageId'
|
||||
import type { DepInfo } from "./DepInfo"
|
||||
import type { PackageId } from "./PackageId"
|
||||
|
||||
export type Dependencies = { [key: PackageId]: DepInfo }
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { DataUrl } from './DataUrl'
|
||||
import type { LocaleString } from './LocaleString'
|
||||
import type { DataUrl } from "./DataUrl"
|
||||
import type { LocaleString } from "./LocaleString"
|
||||
|
||||
export type DependencyMetadata = {
|
||||
title: LocaleString | null
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { HealthCheckId } from './HealthCheckId'
|
||||
import type { PackageId } from './PackageId'
|
||||
import type { HealthCheckId } from "./HealthCheckId"
|
||||
import type { PackageId } from "./PackageId"
|
||||
|
||||
export type DependencyRequirement =
|
||||
| {
|
||||
kind: 'running'
|
||||
kind: "running"
|
||||
id: PackageId
|
||||
healthChecks: Array<HealthCheckId>
|
||||
versionRange: string
|
||||
}
|
||||
| { kind: 'exists'; id: PackageId; versionRange: string }
|
||||
| { kind: "exists"; id: PackageId; versionRange: string }
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { LocaleString } from './LocaleString'
|
||||
import type { LocaleString } from "./LocaleString"
|
||||
|
||||
export type Description = { short: LocaleString; long: LocaleString }
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { StartStop } from './StartStop'
|
||||
import type { StartStop } from "./StartStop"
|
||||
|
||||
export type DesiredStatus =
|
||||
| { main: 'stopped' }
|
||||
| { main: 'restarting' }
|
||||
| { main: 'running' }
|
||||
| { main: 'backing-up'; onComplete: StartStop }
|
||||
| { main: "stopped" }
|
||||
| { main: "restarting" }
|
||||
| { main: "running" }
|
||||
| { main: "backing-up"; onComplete: StartStop }
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { Guid } from './Guid'
|
||||
import type { Guid } from "./Guid"
|
||||
|
||||
export type DestroySubcontainerFsParams = { guid: Guid }
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
export type DeviceFilter = {
|
||||
description: string
|
||||
class: 'processor' | 'display'
|
||||
class: "processor" | "display"
|
||||
product: string | null
|
||||
vendor: string | null
|
||||
capabilities?: Array<string>
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { GatewayId } from './GatewayId'
|
||||
import type { GatewayId } from "./GatewayId"
|
||||
|
||||
export type DomainSettings = { gateway: GatewayId }
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { AnyVerifyingKey } from './AnyVerifyingKey'
|
||||
import type { ContactInfo } from './ContactInfo'
|
||||
import type { Guid } from './Guid'
|
||||
import type { AnyVerifyingKey } from "./AnyVerifyingKey"
|
||||
import type { ContactInfo } from "./ContactInfo"
|
||||
import type { Guid } from "./Guid"
|
||||
|
||||
export type EditSignerParams = {
|
||||
id: Guid
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { Guid } from './Guid'
|
||||
import type { Guid } from "./Guid"
|
||||
|
||||
export type EventId = { eventId: Guid }
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { ActionId } from './ActionId'
|
||||
import type { ActionMetadata } from './ActionMetadata'
|
||||
import type { ActionId } from "./ActionId"
|
||||
import type { ActionMetadata } from "./ActionMetadata"
|
||||
|
||||
export type ExportActionParams = { id: ActionId; metadata: ActionMetadata }
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { AddressInfo } from './AddressInfo'
|
||||
import type { ServiceInterfaceId } from './ServiceInterfaceId'
|
||||
import type { ServiceInterfaceType } from './ServiceInterfaceType'
|
||||
import type { AddressInfo } from "./AddressInfo"
|
||||
import type { ServiceInterfaceId } from "./ServiceInterfaceId"
|
||||
import type { ServiceInterfaceType } from "./ServiceInterfaceType"
|
||||
|
||||
export type ExportServiceInterfaceParams = {
|
||||
id: ServiceInterfaceId
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
|
||||
export type FileType = 'file' | 'directory' | 'infer'
|
||||
export type FileType = "file" | "directory" | "infer"
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { DataUrl } from './DataUrl'
|
||||
import type { Guid } from './Guid'
|
||||
import type { OsIndex } from './OsIndex'
|
||||
import type { PackageIndex } from './PackageIndex'
|
||||
import type { SignerInfo } from './SignerInfo'
|
||||
import type { DataUrl } from "./DataUrl"
|
||||
import type { Guid } from "./Guid"
|
||||
import type { OsIndex } from "./OsIndex"
|
||||
import type { PackageIndex } from "./PackageIndex"
|
||||
import type { SignerInfo } from "./SignerInfo"
|
||||
|
||||
export type FullIndex = {
|
||||
name: string | null
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { NamedProgress } from './NamedProgress'
|
||||
import type { Progress } from './Progress'
|
||||
import type { NamedProgress } from "./NamedProgress"
|
||||
import type { Progress } from "./Progress"
|
||||
|
||||
export type FullProgress = { overall: Progress; phases: Array<NamedProgress> }
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { GatewayId } from './GatewayId'
|
||||
import type { GatewayId } from "./GatewayId"
|
||||
|
||||
export type GatewayInfo = { id: GatewayId; name: string; public: boolean }
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { ActionId } from './ActionId'
|
||||
import type { PackageId } from './PackageId'
|
||||
import type { ActionId } from "./ActionId"
|
||||
import type { PackageId } from "./PackageId"
|
||||
|
||||
export type GetActionInputParams = { packageId?: PackageId; actionId: ActionId }
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { CallbackId } from './CallbackId'
|
||||
import type { PackageId } from './PackageId'
|
||||
import type { CallbackId } from "./CallbackId"
|
||||
import type { PackageId } from "./PackageId"
|
||||
|
||||
export type GetContainerIpParams = {
|
||||
packageId?: PackageId
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
|
||||
import type { CallbackId } from './CallbackId'
|
||||
import type { HostId } from './HostId'
|
||||
import type { PackageId } from './PackageId'
|
||||
import type { CallbackId } from "./CallbackId"
|
||||
import type { HostId } from "./HostId"
|
||||
import type { PackageId } from "./PackageId"
|
||||
|
||||
export type GetHostInfoParams = {
|
||||
hostId: HostId
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user