@toshicloud/sdk 0.5.1 → 0.7.0

package/dist/test/alarms.js

@@ -0,0 +1,144 @@
+import { clone, create } from "@bufbuild/protobuf";
+import { DurationSchema, TimestampSchema } from "@bufbuild/protobuf/wkt";
+import { Code, ConnectError } from "@connectrpc/connect";
+import { DeleteServiceAlarmResponseSchema, GetServiceAlarmResponseSchema, ListServiceAlarmsResponseSchema, PauseServiceAlarmResponseSchema, ResumeServiceAlarmResponseSchema, RunServiceAlarmNowResponseSchema, ServiceAlarmMisfire, ServiceAlarmOccurrenceSchema, ServiceAlarmSchema, SetServiceAlarmResponseSchema, } from "../gen/toshi/workspace/v1/workloads_pb.js";
+/** How late a missed instant may be published when SetServiceAlarm names no deadline. */
+const defaultStartingDeadline = create(DurationSchema, { seconds: 600n });
+/** How many occurrences GetServiceAlarm returns. */
+const maxOccurrences = 20;
+/**
+ * The alarms the fake keeps for any service ID: the fake holds no services. It
+ * has no clock, so an alarm publishes nothing on its own and a cron alarm has
+ * no next instant.
+ */
+export class AlarmStore {
+    alarms = new Map();
+    runs = new Map();
+    /** Creates the alarm at generation 1, or replaces it at the next generation, resumed. */
+    set(request) {
+        const alarm = create(ServiceAlarmSchema, {
+            name: request.name,
+            timezone: request.timezone,
+            endpoint: request.endpoint,
+            event: request.event,
+            data: request.data.slice(),
+            misfire: request.misfire,
+            startingDeadline: clone(DurationSchema, request.startingDeadline ?? defaultStartingDeadline),
+            generation: 1n,
+        });
+        switch (request.schedule.case) {
+            case "cron":
+                alarm.schedule = { case: "cron", value: request.schedule.value };
+                break;
+            case "at":
+                alarm.schedule = { case: "at", value: clone(TimestampSchema, request.schedule.value) };
+                alarm.nextAt = clone(TimestampSchema, request.schedule.value);
+                break;
+        }
+        if (alarm.misfire === ServiceAlarmMisfire.UNSPECIFIED) {
+            alarm.misfire = ServiceAlarmMisfire.COALESCE;
+        }
+        const key = alarmKey(request.serviceId, request.name);
+        const held = this.alarms.get(key);
+        if (held === undefined) {
+            this.alarms.set(key, {
+                serviceId: request.serviceId,
+                name: request.name,
+                alarm,
+                occurrences: [],
+            });
+        }
+        else {
+            alarm.generation = held.alarm.generation + 1n;
+            held.alarm = alarm;
+        }
+        return create(SetServiceAlarmResponseSchema, { alarm: clone(ServiceAlarmSchema, alarm) });
+    }
+    /** Returns the alarm and its most recent occurrences, newest first. */
+    get(request) {
+        const record = this.alarm(request.serviceId, request.name);
+        return create(GetServiceAlarmResponseSchema, {
+            alarm: clone(ServiceAlarmSchema, record.alarm),
+            occurrences: record.occurrences
+                .slice(0, maxOccurrences)
+                .map((occurrence) => clone(ServiceAlarmOccurrenceSchema, occurrence)),
+        });
+    }
+    /** Returns every alarm of the service, by name. */
+    list(request) {
+        const alarms = [];
+        for (const record of this.alarms.values()) {
+            if (record.serviceId === request.serviceId) {
+                alarms.push(clone(ServiceAlarmSchema, record.alarm));
+            }
+        }
+        alarms.sort((a, b) => compareNames(a.name, b.name));
+        return create(ListServiceAlarmsResponseSchema, { alarms });
+    }
+    /** Removes an alarm and its occurrences. */
+    delete(request) {
+        this.alarm(request.serviceId, request.name);
+        this.alarms.delete(alarmKey(request.serviceId, request.name));
+        return create(DeleteServiceAlarmResponseSchema, {});
+    }
+    /** Pauses an alarm; pausing a paused alarm changes nothing. */
+    pause(request) {
+        const record = this.alarm(request.serviceId, request.name);
+        record.alarm.paused = true;
+        return create(PauseServiceAlarmResponseSchema, { alarm: clone(ServiceAlarmSchema, record.alarm) });
+    }
+    /** Resumes an alarm; resuming a running alarm changes nothing. */
+    resume(request) {
+        const record = this.alarm(request.serviceId, request.name);
+        record.alarm.paused = false;
+        return create(ResumeServiceAlarmResponseSchema, { alarm: clone(ServiceAlarmSchema, record.alarm) });
+    }
+    /**
+     * Records a manual occurrence at the alarm's generation. A request key the
+     * fake has already answered returns the same occurrence.
+     */
+    runNow(request) {
+        if (request.requestKey !== "") {
+            const answered = this.runs.get(request.requestKey);
+            if (answered !== undefined) {
+                return create(RunServiceAlarmNowResponseSchema, {
+                    occurrence: clone(ServiceAlarmOccurrenceSchema, answered),
+                });
+            }
+        }
+        const record = this.alarm(request.serviceId, request.name);
+        const occurrence = create(ServiceAlarmOccurrenceSchema, {
+            generation: record.alarm.generation,
+            manual: true,
+        });
+        record.occurrences.unshift(occurrence);
+        if (request.requestKey !== "") {
+            this.runs.set(request.requestKey, occurrence);
+        }
+        return create(RunServiceAlarmNowResponseSchema, { occurrence: clone(ServiceAlarmOccurrenceSchema, occurrence) });
+    }
+    /** Returns the alarm of a service with this name. */
+    alarm(serviceId, name) {
+        const record = this.alarms.get(alarmKey(serviceId, name));
+        if (record === undefined) {
+            throw new ConnectError(`toshi: no alarm "${serviceId}/${name}"`, Code.NotFound);
+        }
+        return record;
+    }
+}
+/** The map key of one alarm: its service and its name. */
+function alarmKey(serviceId, name) {
+    return JSON.stringify([serviceId, name]);
+}
+/** Compares two names by the bytes of their UTF-8 encoding, as Go's strings.Compare does. */
+function compareNames(a, b) {
+    const left = new TextEncoder().encode(a);
+    const right = new TextEncoder().encode(b);
+    const shared = Math.min(left.length, right.length);
+    for (let index = 0; index < shared; index += 1) {
+        if (left[index] !== right[index]) {
+            return left[index] < right[index] ? -1 : 1;
+        }
+    }
+    return left.length - right.length;
+}

package/dist/test/fake.js

@@ -3,6 +3,7 @@ import { Code, ConnectError, createRouterTransport } from "@connectrpc/connect";
 import { createToshiClient } from "../client.js";
 import { CancelJobResponseSchema, CreateJobResponseSchema, CreateSandboxResponseSchema, GetJobResponseSchema, GetSandboxResponseSchema, ListJobsResponseSchema, ListSandboxesResponseSchema, WaitJobResponseSchema, WaitSandboxResponseSchema, WatchJobsResponseSchema, WatchSandboxesResponseSchema, WorkloadService, } from "../gen/toshi/workspace/v1/workloads_pb.js";
 import { EndReason, EventType, ExecuteResponseSchema, ExecutionExitSchema, ExecutionStartedSchema, JobSchema, JobState, JobStatusSchema, OutputEndSchema, RecordingPolicy, SandboxSchema, SandboxState, SandboxStatusSchema, WatchOutputResponseSchema, } from "../gen/toshi/workspace/v1/workspace_pb.js";
+import { AlarmStore } from "./alarms.js";
 import { apiMethods, apiPackage, hookOnly as hookOnlyMethods, isApiMethod, procedurePath } from "./procedures.js";
 /** The token `client` sends. */
 export const testToken = "test-token";
@@ -93,6 +94,34 @@ const builtinTable = [
             run: (requests) => fake.executeAnswer(requests),
         }),
     ],
+    [
+        workloadMethod("setServiceAlarm"),
+        (fake) => ({ kind: "unary", run: (request) => fake.alarms.set(request) }),
+    ],
+    [
+        workloadMethod("getServiceAlarm"),
+        (fake) => ({ kind: "unary", run: (request) => fake.alarms.get(request) }),
+    ],
+    [
+        workloadMethod("listServiceAlarms"),
+        (fake) => ({ kind: "unary", run: (request) => fake.alarms.list(request) }),
+    ],
+    [
+        workloadMethod("deleteServiceAlarm"),
+        (fake) => ({ kind: "unary", run: (request) => fake.alarms.delete(request) }),
+    ],
+    [
+        workloadMethod("pauseServiceAlarm"),
+        (fake) => ({ kind: "unary", run: (request) => fake.alarms.pause(request) }),
+    ],
+    [
+        workloadMethod("resumeServiceAlarm"),
+        (fake) => ({ kind: "unary", run: (request) => fake.alarms.resume(request) }),
+    ],
+    [
+        workloadMethod("runServiceAlarmNow"),
+        (fake) => ({ kind: "unary", run: (request) => fake.alarms.runNow(request) }),
+    ],
 ];
 /** The procedures the state machine answers. The coverage test holds it against the API. */
 export const answeredProcedures = builtinTable.map(([method]) => method);
@@ -122,6 +151,8 @@ class FakeToshi {
     nextSandbox = 0;
     executions = new Map();
     nextExecution = 0;
+    /** The service alarms the fake holds; `builtinTable` answers from it. */
+    alarms = new AlarmStore();
     constructor() {
         for (const [method, make] of builtinTable) {
             this.builtin.set(procedurePath(method), make(this));

package/dist/test/index.d.ts

@@ -19,8 +19,8 @@
  * # What the fake answers
  *
  * The fake holds one workspace and has no clock: every call answers at once
- * with what the test set. It knows the job and the sandbox lifecycle and
- * nothing else.
+ * with what the test set. It knows the job and the sandbox lifecycle and a
+ * service's alarms, and nothing else.
  *
  * - `job`, `sandbox` and `execute` set what the fake answers: a job's or a
  *   sandbox's state, and the standard output, the standard error and the exit
@@ -46,6 +46,16 @@
  * - Execute answers the start message with an execution id, the standard
  *   output, the standard error and the exit code the test set for the sandbox.
  *   It does not read standard input.
+ * - SetServiceAlarm, GetServiceAlarm, ListServiceAlarms, DeleteServiceAlarm,
+ *   PauseServiceAlarm, ResumeServiceAlarm and RunServiceAlarmNow keep alarms
+ *   for any service ID: the fake holds no services. A set creates an alarm at
+ *   generation 1, or replaces it at the next generation and resumes it.
+ *   RunServiceAlarmNow records a manual occurrence, which GetServiceAlarm
+ *   returns newest first; a run whose request key the fake has already
+ *   answered returns the same occurrence. With no clock an alarm publishes
+ *   nothing on its own, a cron alarm has no next instant, and the fake sets no
+ *   time of its own: an alarm set at an instant has that instant as its next
+ *   one. An unknown alarm is NOT_FOUND.
  *
  * Every other procedure is hook-only. An unhooked procedure the state machine
  * does not cover answers UNIMPLEMENTED, naming the procedure and the `on` call

package/dist/test/index.js

@@ -19,8 +19,8 @@
  * # What the fake answers
  *
  * The fake holds one workspace and has no clock: every call answers at once
- * with what the test set. It knows the job and the sandbox lifecycle and
- * nothing else.
+ * with what the test set. It knows the job and the sandbox lifecycle and a
+ * service's alarms, and nothing else.
  *
  * - `job`, `sandbox` and `execute` set what the fake answers: a job's or a
  *   sandbox's state, and the standard output, the standard error and the exit
@@ -46,6 +46,16 @@
  * - Execute answers the start message with an execution id, the standard
  *   output, the standard error and the exit code the test set for the sandbox.
  *   It does not read standard input.
+ * - SetServiceAlarm, GetServiceAlarm, ListServiceAlarms, DeleteServiceAlarm,
+ *   PauseServiceAlarm, ResumeServiceAlarm and RunServiceAlarmNow keep alarms
+ *   for any service ID: the fake holds no services. A set creates an alarm at
+ *   generation 1, or replaces it at the next generation and resumes it.
+ *   RunServiceAlarmNow records a manual occurrence, which GetServiceAlarm
+ *   returns newest first; a run whose request key the fake has already
+ *   answered returns the same occurrence. With no clock an alarm publishes
+ *   nothing on its own, a cron alarm has no next instant, and the fake sets no
+ *   time of its own: an alarm set at an instant has that instant as its next
+ *   one. An unknown alarm is NOT_FOUND.
  *
  * Every other procedure is hook-only. An unhooked procedure the state machine
  * does not cover answers UNIMPLEMENTED, naming the procedure and the `on` call

package/dist/test/procedures.js

@@ -1,7 +1,7 @@
 import { AccountService } from "../gen/toshi/workspace/v1/account_pb.js";
 import { ArtifactService, ArtifactUploadService } from "../gen/toshi/workspace/v1/artifacts_pb.js";
 import { AuditEventService } from "../gen/toshi/workspace/v1/audit_events_pb.js";
-import { ChannelService } from "../gen/toshi/workspace/v1/channels_pb.js";
+import { EndpointService } from "../gen/toshi/workspace/v1/endpoints_pb.js";
 import { DisplayService } from "../gen/toshi/workspace/v1/display_pb.js";
 import { DomainService } from "../gen/toshi/workspace/v1/domains_pb.js";
 import { FillerService } from "../gen/toshi/workspace/v1/fillers_pb.js";
@@ -9,6 +9,7 @@ import { GrantService } from "../gen/toshi/workspace/v1/grants_pb.js";
 import { HostJobService } from "../gen/toshi/workspace/v1/hostjobs_pb.js";
 import { HostService } from "../gen/toshi/workspace/v1/hosts_pb.js";
 import { ImageService } from "../gen/toshi/workspace/v1/images_pb.js";
+import { ModelCredentialService } from "../gen/toshi/workspace/v1/model_credentials_pb.js";
 import { ProductService } from "../gen/toshi/workspace/v1/products_pb.js";
 import { ProjectService } from "../gen/toshi/workspace/v1/projects_pb.js";
 import { RecordingService } from "../gen/toshi/workspace/v1/recordings_pb.js";
@@ -28,7 +29,7 @@ export const apiServices = [
     ProjectService,
     WebhookService,
     DisplayService,
-    ChannelService,
+    EndpointService,
     RecordingService,
     VolumeService,
     ArtifactService,
@@ -45,6 +46,7 @@ export const apiServices = [
     ImageService,
     ProductService,
     DomainService,
+    ModelCredentialService,
 ];
 /** The path a client calls a method by, for example `/toshi.workspace.v1.WorkloadService/CreateJob`. */
 export function procedurePath(method) {
@@ -87,6 +89,8 @@ export const hookOnly = [
     ProductService.method.listProducts,
     ProductService.method.updateProduct,
     // WorkloadService
+    WorkloadService.method.getWorkloadUsage,
+    WorkloadService.method.listWorkloadUsages,
     WorkloadService.method.updateJob,
     WorkloadService.method.deleteJob,
     WorkloadService.method.updateSandbox,
@@ -116,6 +120,9 @@ export const hookOnly = [
     WorkloadService.method.stopService,
     WorkloadService.method.setServiceMode,
     WorkloadService.method.wakeService,
+    // The fake holds no workloads: the operator's holds are answered by hooks.
+    WorkloadService.method.holdWorkload,
+    WorkloadService.method.releaseWorkload,
     WorkloadService.method.holdService,
     WorkloadService.method.releaseService,
     WorkloadService.method.listServiceRevisions,
@@ -127,15 +134,7 @@ export const hookOnly = [
     WorkloadService.method.watchEvents,
     WorkloadService.method.getOperation,
     WorkloadService.method.waitOperation,
-    // The fake holds no services: their alarms and sign-ins are answered by
-    // hooks.
-    WorkloadService.method.setServiceAlarm,
-    WorkloadService.method.getServiceAlarm,
-    WorkloadService.method.listServiceAlarms,
-    WorkloadService.method.deleteServiceAlarm,
-    WorkloadService.method.pauseServiceAlarm,
-    WorkloadService.method.resumeServiceAlarm,
-    WorkloadService.method.runServiceAlarmNow,
+    // The fake holds no services: their sign-ins are answered by hooks.
     WorkloadService.method.startServiceSignIn,
     WorkloadService.method.answerServiceSignIn,
     WorkloadService.method.cancelServiceSignIn,
@@ -180,12 +179,12 @@ export const hookOnly = [
     ProjectService.method.setEnvironmentRetention,
     ProjectService.method.setEnvironmentVolumes,
     // WebhookService
-    WebhookService.method.createWebhookEndpoint,
-    WebhookService.method.getWebhookEndpoint,
-    WebhookService.method.listWebhookEndpoints,
-    WebhookService.method.updateWebhookEndpoint,
-    WebhookService.method.deleteWebhookEndpoint,
-    WebhookService.method.rotateWebhookEndpointSecret,
+    WebhookService.method.createWebhook,
+    WebhookService.method.getWebhook,
+    WebhookService.method.listWebhooks,
+    WebhookService.method.updateWebhook,
+    WebhookService.method.deleteWebhook,
+    WebhookService.method.rotateWebhookSecret,
     WebhookService.method.listWebhookDeliveries,
     WebhookService.method.replayWebhookEvents,
     // DisplayService
@@ -197,23 +196,23 @@ export const hookOnly = [
     DisplayService.method.sendDisplayPointer,
     DisplayService.method.setDisplayClipboard,
     DisplayService.method.takeDisplayScreenshot,
-    // ChannelService
-    ChannelService.method.createChannel,
-    ChannelService.method.listChannels,
-    ChannelService.method.getChannel,
-    ChannelService.method.getChannelPolicy,
-    ChannelService.method.setChannelPolicy,
-    ChannelService.method.listChannelRequests,
-    ChannelService.method.getChannelRequest,
-    ChannelService.method.exportChannelLog,
-    ChannelService.method.createChannelConnectToken,
-    ChannelService.method.revokeChannelConnectToken,
-    ChannelService.method.deleteChannel,
-    ChannelService.method.listForwards,
-    ChannelService.method.getLink,
-    ChannelService.method.sendChannelMessage,
-    ChannelService.method.tailChannelMessages,
-    ChannelService.method.replayChannelMessage,
+    // EndpointService
+    EndpointService.method.createEndpoint,
+    EndpointService.method.listEndpoints,
+    EndpointService.method.getEndpoint,
+    EndpointService.method.getEndpointPolicy,
+    EndpointService.method.setEndpointPolicy,
+    EndpointService.method.listEndpointRequests,
+    EndpointService.method.getEndpointRequest,
+    EndpointService.method.exportEndpointLog,
+    EndpointService.method.createEndpointConnectToken,
+    EndpointService.method.revokeEndpointConnectToken,
+    EndpointService.method.deleteEndpoint,
+    EndpointService.method.listForwards,
+    EndpointService.method.getTunnel,
+    EndpointService.method.sendEndpointMessage,
+    EndpointService.method.tailEndpointMessages,
+    EndpointService.method.replayEndpointMessage,
     // RecordingService
     RecordingService.method.listRecordings,
     RecordingService.method.getRecording,
@@ -290,6 +289,7 @@ export const hookOnly = [
     WorkspaceService.method.listWorkspaces,
     WorkspaceService.method.getWorkspaceBilling,
     WorkspaceService.method.getWorkspaceStatement,
+    WorkspaceService.method.getWorkspaceUpcomingInvoice,
     WorkspaceService.method.listEgressIPs,
     WorkspaceService.method.getUsage,
     WorkspaceService.method.getQueueTimes,
@@ -311,4 +311,10 @@ export const hookOnly = [
     DomainService.method.verifyDomain,
     DomainService.method.issueDomain,
     DomainService.method.deleteDomain,
+    // ModelCredentialService
+    ModelCredentialService.method.createModelCredential,
+    ModelCredentialService.method.getModelCredential,
+    ModelCredentialService.method.listModelCredentials,
+    ModelCredentialService.method.updateModelCredential,
+    ModelCredentialService.method.deleteModelCredential,
 ];

package/dist/version.d.ts

@@ -1,2 +1,2 @@
 /** The package version; test/node.test.ts keeps it equal to package.json. */
-export declare const VERSION = "0.5.1";
+export declare const VERSION = "0.7.0";

package/dist/version.js

@@ -1,2 +1,2 @@
 /** The package version; test/node.test.ts keeps it equal to package.json. */
-export const VERSION = "0.5.1";
+export const VERSION = "0.7.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toshicloud/sdk",
-  "version": "0.5.1",
+  "version": "0.7.0",
   "description": "TypeScript client for the Toshi Workspace API",
   "license": "Apache-2.0",
   "packageManager": "pnpm@12.15.0+sha512.b3951d6d6ff4a9f13dc7cf56cd28d2b8eb37dbcc9c68e52e1e1191873ea9f82a017287ab50baadc5ccc494f036c67c0e47eb13608c2fa36f47711b61ea128e61",