@sealant/api-contracts-next 0.39.0-next.702 → 0.39.0-next.704

package/dist/core-api/control-plane.d.ts

@@ -1110,6 +1110,17 @@ export declare const ControlPlaneAPI: HttpApi.HttpApi<"sealantControlPlaneApi",
         readonly message: import("effect/Schema").String;
         readonly code: import("effect/Schema").optional<import("effect/Schema").String>;
     }>>;
+    readonly phase: import("effect/Schema").optional<import("effect/Schema").Struct<{
+        readonly name: import("effect/Schema").Literals<readonly ["queued", "image-build", "boot"]>;
+        readonly since: import("effect/Schema").optional<import("effect/Schema").String>;
+        readonly imageBuild: import("effect/Schema").optional<import("effect/Schema").Struct<{
+            readonly step: import("effect/Schema").optional<import("effect/Schema").Int>;
+            readonly steps: import("effect/Schema").optional<import("effect/Schema").Int>;
+            readonly stepName: import("effect/Schema").optional<import("effect/Schema").String>;
+            readonly progressAt: import("effect/Schema").String;
+            readonly stallTimeoutMs: import("effect/Schema").optional<import("effect/Schema").Int>;
+        }>>;
+    }>>;
     readonly createdAt: import("effect/Schema").String;
     readonly updatedAt: import("effect/Schema").String;
     readonly startedAt: import("effect/Schema").optional<import("effect/Schema").String>;
@@ -1396,6 +1407,17 @@ export declare const ControlPlaneAPI: HttpApi.HttpApi<"sealantControlPlaneApi",
             readonly message: import("effect/Schema").String;
             readonly code: import("effect/Schema").optional<import("effect/Schema").String>;
         }>>;
+        readonly phase: import("effect/Schema").optional<import("effect/Schema").Struct<{
+            readonly name: import("effect/Schema").Literals<readonly ["queued", "image-build", "boot"]>;
+            readonly since: import("effect/Schema").optional<import("effect/Schema").String>;
+            readonly imageBuild: import("effect/Schema").optional<import("effect/Schema").Struct<{
+                readonly step: import("effect/Schema").optional<import("effect/Schema").Int>;
+                readonly steps: import("effect/Schema").optional<import("effect/Schema").Int>;
+                readonly stepName: import("effect/Schema").optional<import("effect/Schema").String>;
+                readonly progressAt: import("effect/Schema").String;
+                readonly stallTimeoutMs: import("effect/Schema").optional<import("effect/Schema").Int>;
+            }>>;
+        }>>;
         readonly createdAt: import("effect/Schema").String;
         readonly updatedAt: import("effect/Schema").String;
         readonly startedAt: import("effect/Schema").optional<import("effect/Schema").String>;

package/dist/core-api/workspaces.d.ts

@@ -223,10 +223,10 @@ export declare const applyWorkspaceDotfilesArchiveSchema: Schema.Struct<{
  * order) and the same applier (sealantd's: chezmoi, stow or copy, then each tree's bootstrap).
  *
  * `user` must exist and must not be root or in root's group, and `home` must be its passwd home: an
- * existing directory of the user's, reached without a symbolic link. The clone, chezmoi, stow and the
- * bootstrap run as the user; sealantd's archive staging and `copy` manager still run as root inside
- * the home and follow links the person planted there, until sealantd's fix for it lands (see
- * docs/connected-accounts-design.md §6g). `onBehalfOfUserId` names whose dotfiles they are: it is
+ * existing directory of the user's, reached without a symbolic link. The clone, chezmoi, stow, the
+ * `copy` manager and the bootstrap run as the user, and every file in the home is written as the
+ * user: sealantd unpacks archives outside every home, and a link the person planted is followed only
+ * as them (see docs/connected-accounts-design.md §6g). `onBehalfOfUserId` names whose dotfiles they are: it is
  * recorded on the run, and a home whose logins another person holds is refused (`home-held`). Answered `202` with a run (`harnessId`
  * `dotfiles`) once the archives are staged: the run's first `processStarted` is the bootstrap,
  * started once every file is applied; its output and exit are the run's. The run completes with the
@@ -1047,6 +1047,34 @@ export declare const cancelWorkspaceCreateRequestSchema: Schema.Struct<{
     readonly ownerUserId: Schema.String;
 }>;
 export type CancelWorkspaceCreateRequest = typeof cancelWorkspaceCreateRequestSchema.Type;
+/**
+ * Where a workspace that is not ready yet is in its launch:
+ *
+ *  - `queued`: waiting for a worker to take the launch.
+ *  - `image-build`: building (or finding) the workspace image. `imageBuild` says how far the build
+ *    has got and when it last wrote output, when the builder reports it.
+ *  - `boot`: the image is ready; the executor is starting and its daemon has not answered yet.
+ *
+ * `since` is when the phase started. Absent once the workspace is ready or has ended, and from
+ * control planes that predate it.
+ */
+export declare const workspacePhaseSchema: Schema.Struct<{
+    readonly name: Schema.Literals<readonly ["queued", "image-build", "boot"]>;
+    readonly since: Schema.optional<Schema.String>;
+    readonly imageBuild: Schema.optional<Schema.Struct<{
+        /** The furthest build step reached (1-based). */
+        readonly step: Schema.optional<Schema.Int>;
+        /** How many steps the build has. */
+        readonly steps: Schema.optional<Schema.Int>;
+        /** That step's instruction, shortened (`RUN apt-get update && …`). */
+        readonly stepName: Schema.optional<Schema.String>;
+        /** ISO-8601: when the build last wrote output. */
+        readonly progressAt: Schema.String;
+        /** How long the builder lets the build go without output before it fails it as stalled. */
+        readonly stallTimeoutMs: Schema.optional<Schema.Int>;
+    }>>;
+}>;
+export type WorkspacePhase = typeof workspacePhaseSchema.Type;
 export declare const workspaceSummarySchema: Schema.Struct<{
     readonly workspaceId: Schema.String;
     readonly name: Schema.String;
@@ -1102,6 +1130,23 @@ export declare const workspaceSummarySchema: Schema.Struct<{
         readonly message: Schema.String;
         readonly code: Schema.optional<Schema.String>;
     }>>;
+    /** Where the launch is while the workspace is not ready (see `workspacePhaseSchema`). */
+    readonly phase: Schema.optional<Schema.Struct<{
+        readonly name: Schema.Literals<readonly ["queued", "image-build", "boot"]>;
+        readonly since: Schema.optional<Schema.String>;
+        readonly imageBuild: Schema.optional<Schema.Struct<{
+            /** The furthest build step reached (1-based). */
+            readonly step: Schema.optional<Schema.Int>;
+            /** How many steps the build has. */
+            readonly steps: Schema.optional<Schema.Int>;
+            /** That step's instruction, shortened (`RUN apt-get update && …`). */
+            readonly stepName: Schema.optional<Schema.String>;
+            /** ISO-8601: when the build last wrote output. */
+            readonly progressAt: Schema.String;
+            /** How long the builder lets the build go without output before it fails it as stalled. */
+            readonly stallTimeoutMs: Schema.optional<Schema.Int>;
+        }>>;
+    }>>;
     readonly createdAt: Schema.String;
     readonly updatedAt: Schema.String;
     readonly startedAt: Schema.optional<Schema.String>;
@@ -1244,6 +1289,23 @@ export declare const workspaceDetailsSchema: Schema.Struct<{
         readonly message: Schema.String;
         readonly code: Schema.optional<Schema.String>;
     }>>;
+    /** Where the launch is while the workspace is not ready (see `workspacePhaseSchema`). */
+    readonly phase: Schema.optional<Schema.Struct<{
+        readonly name: Schema.Literals<readonly ["queued", "image-build", "boot"]>;
+        readonly since: Schema.optional<Schema.String>;
+        readonly imageBuild: Schema.optional<Schema.Struct<{
+            /** The furthest build step reached (1-based). */
+            readonly step: Schema.optional<Schema.Int>;
+            /** How many steps the build has. */
+            readonly steps: Schema.optional<Schema.Int>;
+            /** That step's instruction, shortened (`RUN apt-get update && …`). */
+            readonly stepName: Schema.optional<Schema.String>;
+            /** ISO-8601: when the build last wrote output. */
+            readonly progressAt: Schema.String;
+            /** How long the builder lets the build go without output before it fails it as stalled. */
+            readonly stallTimeoutMs: Schema.optional<Schema.Int>;
+        }>>;
+    }>>;
     readonly createdAt: Schema.String;
     readonly updatedAt: Schema.String;
     readonly startedAt: Schema.optional<Schema.String>;
@@ -1387,6 +1449,23 @@ export declare const listWorkspacesResponseSchema: Schema.Struct<{
             readonly message: Schema.String;
             readonly code: Schema.optional<Schema.String>;
         }>>;
+        /** Where the launch is while the workspace is not ready (see `workspacePhaseSchema`). */
+        readonly phase: Schema.optional<Schema.Struct<{
+            readonly name: Schema.Literals<readonly ["queued", "image-build", "boot"]>;
+            readonly since: Schema.optional<Schema.String>;
+            readonly imageBuild: Schema.optional<Schema.Struct<{
+                /** The furthest build step reached (1-based). */
+                readonly step: Schema.optional<Schema.Int>;
+                /** How many steps the build has. */
+                readonly steps: Schema.optional<Schema.Int>;
+                /** That step's instruction, shortened (`RUN apt-get update && …`). */
+                readonly stepName: Schema.optional<Schema.String>;
+                /** ISO-8601: when the build last wrote output. */
+                readonly progressAt: Schema.String;
+                /** How long the builder lets the build go without output before it fails it as stalled. */
+                readonly stallTimeoutMs: Schema.optional<Schema.Int>;
+            }>>;
+        }>>;
         readonly createdAt: Schema.String;
         readonly updatedAt: Schema.String;
         readonly startedAt: Schema.optional<Schema.String>;
@@ -2039,6 +2118,23 @@ export declare const WorkspacesGroup: HttpApiGroup.HttpApiGroup<"workspaces", Ht
         readonly message: Schema.String;
         readonly code: Schema.optional<Schema.String>;
     }>>;
+    /** Where the launch is while the workspace is not ready (see `workspacePhaseSchema`). */
+    readonly phase: Schema.optional<Schema.Struct<{
+        readonly name: Schema.Literals<readonly ["queued", "image-build", "boot"]>;
+        readonly since: Schema.optional<Schema.String>;
+        readonly imageBuild: Schema.optional<Schema.Struct<{
+            /** The furthest build step reached (1-based). */
+            readonly step: Schema.optional<Schema.Int>;
+            /** How many steps the build has. */
+            readonly steps: Schema.optional<Schema.Int>;
+            /** That step's instruction, shortened (`RUN apt-get update && …`). */
+            readonly stepName: Schema.optional<Schema.String>;
+            /** ISO-8601: when the build last wrote output. */
+            readonly progressAt: Schema.String;
+            /** How long the builder lets the build go without output before it fails it as stalled. */
+            readonly stallTimeoutMs: Schema.optional<Schema.Int>;
+        }>>;
+    }>>;
     readonly createdAt: Schema.String;
     readonly updatedAt: Schema.String;
     readonly startedAt: Schema.optional<Schema.String>;
@@ -2493,6 +2589,23 @@ export declare const WorkspacesGroup: HttpApiGroup.HttpApiGroup<"workspaces", Ht
             readonly message: Schema.String;
             readonly code: Schema.optional<Schema.String>;
         }>>;
+        /** Where the launch is while the workspace is not ready (see `workspacePhaseSchema`). */
+        readonly phase: Schema.optional<Schema.Struct<{
+            readonly name: Schema.Literals<readonly ["queued", "image-build", "boot"]>;
+            readonly since: Schema.optional<Schema.String>;
+            readonly imageBuild: Schema.optional<Schema.Struct<{
+                /** The furthest build step reached (1-based). */
+                readonly step: Schema.optional<Schema.Int>;
+                /** How many steps the build has. */
+                readonly steps: Schema.optional<Schema.Int>;
+                /** That step's instruction, shortened (`RUN apt-get update && …`). */
+                readonly stepName: Schema.optional<Schema.String>;
+                /** ISO-8601: when the build last wrote output. */
+                readonly progressAt: Schema.String;
+                /** How long the builder lets the build go without output before it fails it as stalled. */
+                readonly stallTimeoutMs: Schema.optional<Schema.Int>;
+            }>>;
+        }>>;
         readonly createdAt: Schema.String;
         readonly updatedAt: Schema.String;
         readonly startedAt: Schema.optional<Schema.String>;

package/dist/core-api/workspaces.js

@@ -207,10 +207,10 @@ export const applyWorkspaceDotfilesArchiveSchema = Schema.Struct({
  * order) and the same applier (sealantd's: chezmoi, stow or copy, then each tree's bootstrap).
  *
  * `user` must exist and must not be root or in root's group, and `home` must be its passwd home: an
- * existing directory of the user's, reached without a symbolic link. The clone, chezmoi, stow and the
- * bootstrap run as the user; sealantd's archive staging and `copy` manager still run as root inside
- * the home and follow links the person planted there, until sealantd's fix for it lands (see
- * docs/connected-accounts-design.md §6g). `onBehalfOfUserId` names whose dotfiles they are: it is
+ * existing directory of the user's, reached without a symbolic link. The clone, chezmoi, stow, the
+ * `copy` manager and the bootstrap run as the user, and every file in the home is written as the
+ * user: sealantd unpacks archives outside every home, and a link the person planted is followed only
+ * as them (see docs/connected-accounts-design.md §6g). `onBehalfOfUserId` names whose dotfiles they are: it is
  * recorded on the run, and a home whose logins another person holds is refused (`home-held`). Answered `202` with a run (`harnessId`
  * `dotfiles`) once the archives are staged: the run's first `processStarted` is the bootstrap,
  * started once every file is applied; its output and exit are the run's. The run completes with the
@@ -815,6 +815,33 @@ export const getWorkspaceCreateQuerySchema = Schema.Struct({
 export const cancelWorkspaceCreateRequestSchema = Schema.Struct({
     ownerUserId: NonEmptyString,
 });
+/**
+ * Where a workspace that is not ready yet is in its launch:
+ *
+ *  - `queued`: waiting for a worker to take the launch.
+ *  - `image-build`: building (or finding) the workspace image. `imageBuild` says how far the build
+ *    has got and when it last wrote output, when the builder reports it.
+ *  - `boot`: the image is ready; the executor is starting and its daemon has not answered yet.
+ *
+ * `since` is when the phase started. Absent once the workspace is ready or has ended, and from
+ * control planes that predate it.
+ */
+export const workspacePhaseSchema = Schema.Struct({
+    name: Schema.Literals(["queued", "image-build", "boot"]),
+    since: Schema.optional(Schema.String),
+    imageBuild: Schema.optional(Schema.Struct({
+        /** The furthest build step reached (1-based). */
+        step: Schema.optional(Schema.Int),
+        /** How many steps the build has. */
+        steps: Schema.optional(Schema.Int),
+        /** That step's instruction, shortened (`RUN apt-get update && …`). */
+        stepName: Schema.optional(Schema.String),
+        /** ISO-8601: when the build last wrote output. */
+        progressAt: Schema.String,
+        /** How long the builder lets the build go without output before it fails it as stalled. */
+        stallTimeoutMs: Schema.optional(Schema.Int),
+    })),
+});
 export const workspaceSummarySchema = Schema.Struct({
     workspaceId: NonEmptyString,
     name: NonEmptyString,
@@ -826,6 +853,8 @@ export const workspaceSummarySchema = Schema.Struct({
     runtime: Schema.optional(workspaceRuntimeSchema),
     publishedImage: Schema.optional(workspacePublishedImageSchema),
     error: Schema.optional(workspaceErrorSchema),
+    /** Where the launch is while the workspace is not ready (see `workspacePhaseSchema`). */
+    phase: Schema.optional(workspacePhaseSchema),
     createdAt: Schema.String,
     updatedAt: Schema.String,
     startedAt: Schema.optional(Schema.String),
@@ -920,6 +949,8 @@ export const workspaceDetailsSchema = Schema.Struct({
     runtime: Schema.optional(workspaceRuntimeSchema),
     publishedImage: Schema.optional(workspacePublishedImageSchema),
     error: Schema.optional(workspaceErrorSchema),
+    /** Where the launch is while the workspace is not ready (see `workspacePhaseSchema`). */
+    phase: Schema.optional(workspacePhaseSchema),
     createdAt: Schema.String,
     updatedAt: Schema.String,
     startedAt: Schema.optional(Schema.String),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sealant/api-contracts-next",
-  "version": "0.39.0-next.702",
+  "version": "0.39.0-next.704",
   "description": "Contract-first HTTP API definitions for Sealant services",
   "license": "Apache-2.0",
   "repository": {
@@ -32,7 +32,7 @@
   "peerDependencies": {
     "effect": ">=4.0.0-beta.85 <5"
   },
-  "gitHead": "f48e004713495c54c0592f734d0dfb0755628f72",
+  "gitHead": "4cfff680be5ef20c0413f37ba7835ffdd540104f",
   "publishConfig": {
     "access": "public"
   }