@toshicloud/sdk 0.0.0-stage → 0.2.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,202 @@
-# Temporary Holding Version
+# toshi-ts
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A TypeScript client for the Toshi Workspace API, `toshi.workspace.v1`,
+published as ES modules with type declarations.
+
+```sh
+npm install @toshicloud/sdk @connectrpc/connect @connectrpc/connect-node
+```
+
+Versions up to 0.1.2 were published as `@toshicloud/toshi-ts`.
+
+## Using the client
+
+`createToshiClient` takes one set of options. The transport belongs to
+the caller: the client hands its interceptors to the `transport`
+function, and that function builds a transport with them. Every call then
+gets the same token, scope and retries: the helpers below and the
+generated clients alike.
+
+In Node, with `@connectrpc/connect-node`:
+
+```ts
+import { readFileSync } from "node:fs";
+import { createConnectTransport } from "@connectrpc/connect-node";
+import { createToshiClient } from "@toshicloud/sdk";
+
+const toshi = createToshiClient({
+  transport: (interceptors) =>
+    createConnectTransport({
+      baseUrl: "https://toshi.example.com",
+      httpVersion: "2",
+      interceptors,
+      // Only for a server whose certificate a private CA signed.
+      nodeOptions: { ca: readFileSync("ca.pem") },
+    }),
+  token: process.env.TOSHI_TOKEN,
+  project: "default",
+});
+
+const { projects } = await toshi.projects.listProjects({});
+```
+
+In a browser, with `@connectrpc/connect-web`:
+
+```ts
+import { createConnectTransport } from "@connectrpc/connect-web";
+import { createToshiClient } from "@toshicloud/sdk";
+
+const toshi = createToshiClient({
+  transport: (interceptors) =>
+    createConnectTransport({ baseUrl: "https://toshi.example.com", interceptors }),
+  token,
+  project: "default",
+});
+```
+
+To add interceptors of your own, put them before the client's:
+`interceptors: [...mine, ...interceptors]`.
+
+The package reads no environment variable and no file. The token, the
+server and any CA come from the caller.
+
+### Options
+
+- `token`: sent as `Authorization: Bearer <token>` on every call.
+- `project`, `environment`: fill the request's `project` and
+  `environment` fields when they are empty. A value in the request wins.
+  `environment` is left empty on a request with `shared: true`.
+- `retry`: `{ maxAttempts, initialBackoffMs, maxBackoffMs }`, by default
+  5, 200 ms and 10 s, with full jitter. `retry: false` turns off retries
+  and watch reconnects.
+
+### Retries
+
+The client retries a read, and a write that carries a request key, when
+the connection fails: a `ConnectError` with code `Unavailable`, a
+connection reset or destroyed stream that `@connectrpc/connect-node`
+reports, or a stream the server refused before reading it
+(`REFUSED_STREAM`). A write that takes a request key gets a random one when the
+request has none, so the server applies a retried write once. Other
+writes are never retried. An error the server sends, including
+`Aborted`, `InvalidArgument` and `ResourceExhausted`, reaches the caller
+unchanged. So does any connection failure the client cannot tell apart
+from a server error.
+
+### Waiting and watching
+
+- `waitWorkload(req)` and `waitOperation(req)` ask again until the
+  workload reaches the state or the operation is done.
+- `watchWorkloads(req)`, `watchEvents(req)` and `watchOutput(req)`
+  resolve to a watch you read with `for await`. A watch opens its stream
+  when you start reading and reconnects after a connection failure from
+  where it stopped: `cursor` for workloads and events, `offsets` (bytes,
+  as `bigint`) for output. With no cursor, `watchWorkloads` lists the
+  workloads first, and `snapshot` holds them once its promise resolves;
+  `watchEvents` yields the past events page by page before the live ones.
+  `close()` or leaving the loop ends the stream. The output watch ends at
+  the output's end.
+
+```ts
+const watch = await toshi.watchEvents({ workloadId: id });
+for await (const event of watch) {
+  console.log(event.name);
+}
+// watch.cursor resumes a later watch after the last event read.
+```
+
+Every helper takes `{ signal }`, an `AbortSignal` that ends it.
+
+### Running a command
+
+`execute(start)` runs a command and resolves once the server has started
+it. The process is one stream of output chunks, `{ stream: "stdout" |
+"stderr", data: Uint8Array }`. `write` sends standard input in frames of
+at most 64 KiB and resolves once the stream has taken the last one; await
+it before the next `write`, which is refused while one is pending, so the
+client holds at most one buffer of input. `closeStdin` ends standard input
+after a pending write, and a later `write` is refused. `wait` settles when
+the command ends.
+
+```ts
+const proc = await toshi.execute({ workloadId: id, command: { argv: ["cat"] } });
+await proc.write("hello\n");
+await proc.closeStdin();
+for await (const chunk of proc) {
+  process[chunk.stream].write(chunk.data);
+}
+await proc.wait(); // rejects with ExitError on a non-zero exit
+```
+
+Without a loop, `wait()` reads and drops the output itself. It rejects
+with `ExitError` when the command fails, is cancelled or ends without an
+exit status, and with `StreamLostError` when the stream ends first. The
+client never runs a command again by itself. Standard input cannot be
+replayed, so the caller decides whether to start again with the same
+`requestKey`. Leaving the loop early cancels the stream, and `wait()`
+then rejects with a `Canceled` error.
+
+Execute needs a bidirectional stream: `@connectrpc/connect-node` with
+`httpVersion: "2"`. In a browser, `execute` rejects at once and makes no
+call. Over a transport without HTTP/2, the call fails with the
+transport's or the server's error.
+
+## Generated code
+
+`src/gen/toshi/workspace/v1/` is generated by
+[`protoc-gen-es`](https://github.com/bufbuild/protobuf-es) from the protos
+in `proto/toshi/workspace/v1` of the
+[toshi-api](https://github.com/toshicloud/toshi-api) repository, one
+`*_pb.ts` file per proto. The generated code is committed and imports
+only `@bufbuild/protobuf`, so installing the package needs no generator.
+
+`pin.env` names the toshi-api commit (or, once one exists, the release
+tag) the code is generated from. `mise.toml` pins the versions of Node,
+pnpm, `buf` and `protoc-gen-es`.
+
+To regenerate:
+
+```sh
+mise install
+mise exec -- scripts/generate.sh
+```
+
+Moving to another commit or tag is one pull request that changes
+`pin.env` and `src/gen/` together. CI regenerates the code from `pin.env`
+and fails if the result differs from what is committed
+(`scripts/check-generated.sh`).
+
+## Versions
+
+The package's major version follows the API's: `1.x` will serve
+`toshi.workspace.v1`, and a `toshi.workspace.v2` gets a new major
+version. Until a Toshi release serves the API, the package stays at
+`0.x` and is generated from a pinned commit.
+
+## Publishing
+
+Releases are published to npm by the publish workflow
+(`.github/workflows/publish.yml`) through npm trusted publishing: the
+workflow authenticates with its GitHub OIDC token, and no npm token
+exists. It runs on a `vX.Y.Z` tag that matches the version in
+`package.json`. A new version is a commit on `main` that sets the version
+in `package.json`, followed by its tag.
+
+## Integration test
+
+`test/integration/` runs the client against a real `toshi serve` over
+HTTPS with a test CA it mints itself. `TOSHI_INTEGRATION_BIN` names the
+`toshi` binary it runs; when `TOSHI_INTEGRATION_EXPECT_COMMIT` is set, the
+binary must report that commit:
+
+```sh
+TOSHI_INTEGRATION_BIN=/path/to/toshi mise exec -- pnpm vitest run test/integration
+```
+
+The Toshi server's CI runs it against each server change. Without
+`TOSHI_INTEGRATION_BIN`, `pnpm test` skips the integration test and says
+why.
+
+## Licence
+
+Apache License 2.0, see LICENSE.

package/dist/client.d.ts

@@ -0,0 +1,78 @@
+import type { MessageInitShape } from "@bufbuild/protobuf";
+import type { Client, Interceptor, Transport } from "@connectrpc/connect";
+import { DisplayService } from "./gen/toshi/workspace/v1/display_pb.js";
+import { ExecuteStartSchema, WaitOperationRequestSchema, WaitWorkloadRequestSchema, WatchEventsRequestSchema, WatchOutputRequestSchema, WatchWorkloadsRequestSchema, WorkspaceService } from "./gen/toshi/workspace/v1/workspace_pb.js";
+import type { Event, Operation, WaitWorkloadResponse, WatchOutputResponse, WatchWorkloadsResponse, Workload } from "./gen/toshi/workspace/v1/workspace_pb.js";
+import { ProjectService } from "./gen/toshi/workspace/v1/projects_pb.js";
+import { SecretService } from "./gen/toshi/workspace/v1/secrets_pb.js";
+import { WebhookService } from "./gen/toshi/workspace/v1/webhook_pb.js";
+import type { RetryPolicy } from "./retry.js";
+/** How the client is configured; the caller builds the transport. */
+export interface ToshiOptions {
+    /** Builds the caller's transport (connect-node or connect-web) with the client's interceptors. */
+    transport: (interceptors: Interceptor[]) => Transport;
+    token?: string;
+    project?: string;
+    environment?: string;
+    /** false turns off retries and watch reconnects. */
+    retry?: Partial<RetryPolicy> | false;
+}
+/** Per-call options. */
+export interface CallOptions {
+    signal?: AbortSignal;
+}
+/** The five generated clients plus the helpers that live on top of them. */
+export interface ToshiClient {
+    readonly workspace: Client<typeof WorkspaceService>;
+    readonly projects: Client<typeof ProjectService>;
+    readonly secrets: Client<typeof SecretService>;
+    readonly webhooks: Client<typeof WebhookService>;
+    readonly displays: Client<typeof DisplayService>;
+    waitWorkload(req: MessageInitShape<typeof WaitWorkloadRequestSchema>, opts?: CallOptions): Promise<WaitWorkloadResponse>;
+    waitOperation(req: MessageInitShape<typeof WaitOperationRequestSchema>, opts?: CallOptions): Promise<Operation>;
+    watchWorkloads(req: MessageInitShape<typeof WatchWorkloadsRequestSchema>, opts?: CallOptions): Promise<WorkloadWatch>;
+    watchEvents(req: MessageInitShape<typeof WatchEventsRequestSchema>, opts?: CallOptions): Promise<EventWatch>;
+    watchOutput(req: MessageInitShape<typeof WatchOutputRequestSchema>, opts?: CallOptions): Promise<OutputWatch>;
+    execute(start: MessageInitShape<typeof ExecuteStartSchema>, opts?: CallOptions): Promise<Process>;
+}
+/** A live stream of workload changes (watch.go:40-60). */
+export interface WorkloadWatch extends AsyncIterable<WatchWorkloadsResponse> {
+    readonly cursor: string;
+    readonly snapshot: Workload[] | undefined;
+    close(): void;
+}
+/** A live stream of events (watch.go:261-460). */
+export interface EventWatch extends AsyncIterable<Event> {
+    readonly cursor: string;
+    close(): void;
+}
+/** A live stream of a job's output (output.go). */
+export interface OutputWatch extends AsyncIterable<WatchOutputResponse> {
+    readonly offsets: {
+        readonly stdout: bigint;
+        readonly stderr: bigint;
+    };
+    close(): void;
+}
+/** One chunk of an execution's output. */
+export type OutputChunk = {
+    stream: "stdout";
+    data: Uint8Array;
+} | {
+    stream: "stderr";
+    data: Uint8Array;
+};
+/** A running execution (execute.go). */
+export interface Process extends AsyncIterable<OutputChunk> {
+    readonly executionId: string;
+    readonly requestKey: string;
+    write(data: Uint8Array | string): Promise<void>;
+    closeStdin(): Promise<void>;
+    wait(): Promise<void>;
+}
+/**
+ * Creates the client: one normalized retry setting, the auth, scope, key and
+ * retry interceptors (auth outermost, retry innermost), one transport for every
+ * client and helper (client.go:40-93).
+ */
+export declare function createToshiClient(options: ToshiOptions): ToshiClient;

package/dist/client.js

@@ -0,0 +1,42 @@
+import { create } from "@bufbuild/protobuf";
+import { createClient } from "@connectrpc/connect";
+import { executeCommand } from "./execute.js";
+import { DisplayService } from "./gen/toshi/workspace/v1/display_pb.js";
+import { ExecuteStartSchema, WaitOperationRequestSchema, WaitWorkloadRequestSchema, WatchEventsRequestSchema, WatchOutputRequestSchema, WatchWorkloadsRequestSchema, WorkspaceService, } from "./gen/toshi/workspace/v1/workspace_pb.js";
+import { ProjectService } from "./gen/toshi/workspace/v1/projects_pb.js";
+import { SecretService } from "./gen/toshi/workspace/v1/secrets_pb.js";
+import { WebhookService } from "./gen/toshi/workspace/v1/webhook_pb.js";
+import { openOutputWatch } from "./output.js";
+import { authInterceptor, keyInterceptor, retryInterceptor, scopeInterceptor } from "./interceptors.js";
+import { normalizeRetry } from "./retry.js";
+import { openEventWatch, openWorkloadWatch } from "./watch.js";
+import { waitOperation, waitWorkload } from "./wait.js";
+/**
+ * Creates the client: one normalized retry setting, the auth, scope, key and
+ * retry interceptors (auth outermost, retry innermost), one transport for every
+ * client and helper (client.go:40-93).
+ */
+export function createToshiClient(options) {
+    const retry = normalizeRetry(options.retry);
+    const interceptors = [
+        authInterceptor(options.token ?? ""),
+        scopeInterceptor(options.project ?? "", options.environment ?? ""),
+        keyInterceptor(),
+        retryInterceptor(retry),
+    ];
+    const transport = options.transport(interceptors);
+    const workspace = createClient(WorkspaceService, transport);
+    return {
+        workspace,
+        projects: createClient(ProjectService, transport),
+        secrets: createClient(SecretService, transport),
+        webhooks: createClient(WebhookService, transport),
+        displays: createClient(DisplayService, transport),
+        waitWorkload: (req, opts) => waitWorkload(workspace, create(WaitWorkloadRequestSchema, req), opts),
+        waitOperation: (req, opts) => waitOperation(workspace, create(WaitOperationRequestSchema, req), opts),
+        watchWorkloads: (req, opts) => openWorkloadWatch(workspace, retry, create(WatchWorkloadsRequestSchema, req), opts),
+        watchEvents: (req, opts) => openEventWatch(workspace, retry, create(WatchEventsRequestSchema, req), opts),
+        watchOutput: (req, opts) => openOutputWatch(workspace, retry, create(WatchOutputRequestSchema, req), opts),
+        execute: (start, opts) => executeCommand(workspace, start, opts),
+    };
+}

package/dist/errors.d.ts

@@ -0,0 +1,20 @@
+import type { ExecutionExit } from "./gen/toshi/workspace/v1/workspace_pb.js";
+/** A command that ended non-zero, or was cancelled before it had a status (errors.go:9-26). */
+export declare class ExitError extends Error {
+    /** The execution the exit belongs to. */
+    readonly executionId: string;
+    /** The execution's exit message. */
+    readonly exit: ExecutionExit;
+    constructor(executionId: string, exit: ExecutionExit);
+}
+/**
+ * An Execute stream that ended before its exit message; stdin cannot be replayed
+ * (errors.go:28-49). The cause is the error that ended the stream.
+ */
+export declare class StreamLostError extends Error {
+    /** Empty when the stream was lost before the start was acknowledged. */
+    readonly executionId: string;
+    /** The request key of the start, so the caller may start again deliberately. */
+    readonly requestKey: string;
+    constructor(executionId: string, requestKey: string, cause?: unknown);
+}

package/dist/errors.js

@@ -0,0 +1,55 @@
+/** A command that ended non-zero, or was cancelled before it had a status (errors.go:9-26). */
+export class ExitError extends Error {
+    /** The execution the exit belongs to. */
+    executionId;
+    /** The execution's exit message. */
+    exit;
+    constructor(executionId, exit) {
+        super(exitMessage(executionId, exit));
+        this.name = "ExitError";
+        this.executionId = executionId;
+        this.exit = exit;
+    }
+}
+function exitMessage(executionId, exit) {
+    if (exit.cancelled) {
+        return `toshi: execution ${executionId} was cancelled`;
+    }
+    if (exit.exitCode === undefined) {
+        return `toshi: execution ${executionId} ended without an exit status`;
+    }
+    return `toshi: execution ${executionId} exited with status ${exit.exitCode}`;
+}
+/**
+ * An Execute stream that ended before its exit message; stdin cannot be replayed
+ * (errors.go:28-49). The cause is the error that ended the stream.
+ */
+export class StreamLostError extends Error {
+    /** Empty when the stream was lost before the start was acknowledged. */
+    executionId;
+    /** The request key of the start, so the caller may start again deliberately. */
+    requestKey;
+    constructor(executionId, requestKey, cause) {
+        super(lostMessage(executionId, requestKey, cause), cause === undefined ? undefined : { cause });
+        this.name = "StreamLostError";
+        this.executionId = executionId;
+        this.requestKey = requestKey;
+    }
+}
+function lostMessage(executionId, requestKey, cause) {
+    const detail = cause === undefined ? "" : `: ${describe(cause)}`;
+    if (executionId === "") {
+        return `toshi: execution stream lost before the start was acknowledged (request key ${requestKey})${detail}`;
+    }
+    return `toshi: execution ${executionId} stream lost (request key ${requestKey})${detail}`;
+}
+// The way Go's %v would print it, without stringifying an object as [object Object].
+function describe(cause) {
+    if (cause instanceof Error) {
+        return cause.message;
+    }
+    if (typeof cause === "string" || typeof cause === "number" || typeof cause === "boolean") {
+        return String(cause);
+    }
+    return "the stream ended";
+}

package/dist/execute.d.ts

@@ -0,0 +1,6 @@
+import type { MessageInitShape } from "@bufbuild/protobuf";
+import type { Client } from "@connectrpc/connect";
+import type { CallOptions, Process } from "./client.js";
+import { ExecuteStartSchema, WorkspaceService } from "./gen/toshi/workspace/v1/workspace_pb.js";
+/** Starts a command and returns its process; the only export of this module. */
+export declare function executeCommand(workspace: Client<typeof WorkspaceService>, start: MessageInitShape<typeof ExecuteStartSchema> | undefined, opts?: CallOptions): Promise<Process>;