@company-semantics/contracts 79.0.0 → 79.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@company-semantics/contracts",
-  "version": "79.0.0",
+  "version": "79.2.0",
   "private": false,
   "repository": {
     "type": "git",

package/src/api/generated-spec-hash.ts

@@ -1,3 +1,3 @@
 // AUTO-GENERATED — do not edit. Run pnpm generate:spec-hash to regenerate.
-export const SPEC_HASH = '554ba5a13882' as const;
-export const SPEC_HASH_FULL = '554ba5a138827be4f4959d0a9d0199be36e129c9caacce47370121ffede938bf' as const;
+export const SPEC_HASH = 'c8b7d9ff0c4f' as const;
+export const SPEC_HASH_FULL = 'c8b7d9ff0c4fda27f5db2cc4afa34e2b80015a930d36e2a6d5106987285b503a' as const;

package/src/api/generated.ts

@@ -1666,6 +1666,46 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/analysis-workflows/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Read one analysis workflow’s generic lifecycle envelope
+         * @description The domain-agnostic projection a client polls: identity, registered type, activity-free lifecycle state, start and completion times, the opaque domain progress and result payloads (null until the domain adapter supplies them), a closed failure class on a failed workflow, and the capabilities the surface may offer — canStop from the generic layer, canContinue as the domain declares it. Org-scoped: a workflow in another workspace answers 404.
+         */
+        get: operations["getAnalysisWorkflow"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/analysis-workflows/{id}/stop": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Request that an analysis workflow stop at its next safe boundary
+         * @description The one generic COMMAND. Records a cooperative stop request and moves a pending or running workflow to draining; nothing is aborted — the worker halts at a boundary the domain chooses. Answers 202 (acknowledged, not landed) when the request was accepted, and 200 with { stopped: false, reason: "not_running" } when the workflow is already draining or already settled, because a retry against a stopped workflow is a success. Runtime posture: intent write, impersonation allow (a stop only reduces spend). Org-scoped: a workflow in another workspace answers 404.
+         */
+        post: operations["stopAnalysisWorkflow"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/company-md/tree": {
         parameters: {
             query?: never;
@@ -4589,6 +4629,30 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/source-sync/settings": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Read whether Source Sync is on for the org
+         * @description The org switch every Source Sync route, job and sweep gates on, and who last changed it and when. Off until an admin turns it on.
+         */
+        get: operations["getSourceSyncSettings"];
+        /**
+         * Switch Source Sync on or off for the org
+         * @description On lets Source Sync search the connected Drive and propose company.md updates for review. Off pauses it: nothing is read or run, and nothing already brought in is deleted. The caller is recorded as the person who changed it.
+         */
+        put: operations["putSourceSyncSettings"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
 }
 export type webhooks = Record<string, never>;
 export interface components {
@@ -6422,6 +6486,35 @@ export interface components {
             fingerprint: string;
             note?: string;
         };
+        AnalysisWorkflowProjectionResponse: {
+            /** Format: uuid */
+            id: string;
+            type: string;
+            /** @enum {string} */
+            state: "pending" | "running" | "draining" | "stopped" | "complete" | "failed";
+            startedAt: string | null;
+            completedAt: string | null;
+            progress: unknown | null;
+            result: unknown | null;
+            error?: string;
+            capabilities: {
+                canStop: boolean;
+                canContinue: boolean;
+            };
+        };
+        StopAnalysisWorkflowResponse: {
+            /** @constant */
+            stopped: true;
+            /** Format: uuid */
+            workflowId: string;
+            /** @constant */
+            state: "draining";
+        } | {
+            /** @constant */
+            stopped: false;
+            /** @constant */
+            reason: "not_running";
+        };
         CompanyMdListResponse: {
             items: {
                 id: string;
@@ -9296,6 +9389,14 @@ export interface components {
             /** @constant */
             confirm: true;
         };
+        SourceSyncSettingsResponse: {
+            enabled: boolean;
+            changedAt: string | null;
+            changedByLabel: string | null;
+        };
+        SourceSyncPutSettingsRequest: {
+            enabled: boolean;
+        };
         /** @description Server-enforced collaboration size limits, published so clients can pre-check. */
         CollabSyncLimits: {
             maxUpdateBytes: number;
@@ -12089,6 +12190,87 @@ export interface operations {
             };
         };
     };
+    getAnalysisWorkflow: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The workflow’s lifecycle envelope with its capabilities */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AnalysisWorkflowProjectionResponse"];
+                };
+            };
+            /** @description The workflow id is not a uuid */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description No such workflow in this workspace */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    stopAnalysisWorkflow: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Nothing to stop: the workflow is not running */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["StopAnalysisWorkflowResponse"];
+                };
+            };
+            /** @description Stop requested; the workflow is draining */
+            202: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["StopAnalysisWorkflowResponse"];
+                };
+            };
+            /** @description The workflow id is not a uuid */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description No such workflow in this workspace */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     getCompanyMdTree: {
         parameters: {
             query?: {
@@ -17248,14 +17430,7 @@ export interface operations {
                     "application/json": components["schemas"]["SourceSyncDiscoveryRunResponse"];
                 };
             };
-            /** @description Source Sync is not enabled */
-            404: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
-            /** @description The org has no active Google Drive connection (SOURCE_SYNC_DRIVE_NOT_CONNECTED), or a discovery run is already running (SOURCE_DISCOVERY_ALREADY_RUNNING) */
+            /** @description Source Sync is off for this org (SOURCE_SYNC_OFF), or The org has no active Google Drive connection (SOURCE_SYNC_DRIVE_NOT_CONNECTED), or a discovery run is already running (SOURCE_DISCOVERY_ALREADY_RUNNING) */
             409: {
                 headers: {
                     [name: string]: unknown;
@@ -17282,13 +17457,20 @@ export interface operations {
                     "application/json": components["schemas"]["SourceSyncCandidateSetResponse"];
                 };
             };
-            /** @description Source Sync is not enabled, or the org has no draft candidate set */
+            /** @description The org has no draft candidate set */
             404: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content?: never;
             };
+            /** @description Source Sync is off for this org (SOURCE_SYNC_OFF) */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
         };
     };
     patchSourceCandidateItem: {
@@ -17330,14 +17512,14 @@ export interface operations {
                 };
                 content?: never;
             };
-            /** @description Source Sync is not enabled, or the set, item or target document is not the org’s */
+            /** @description The set, item or target document is not the org’s */
             404: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content?: never;
             };
-            /** @description The set is no longer a draft (SOURCE_SYNC_CANDIDATE_SET_NOT_DRAFT), or the item’s scope was already approved (SOURCE_SYNC_CANDIDATE_ITEM_FROZEN) */
+            /** @description Source Sync is off for this org (SOURCE_SYNC_OFF), or The set is no longer a draft (SOURCE_SYNC_CANDIDATE_SET_NOT_DRAFT), or the item’s scope was already approved (SOURCE_SYNC_CANDIDATE_ITEM_FROZEN) */
             409: {
                 headers: {
                     [name: string]: unknown;
@@ -17377,14 +17559,14 @@ export interface operations {
                     "application/json": components["schemas"]["SourceSyncCandidateSetResponse"];
                 };
             };
-            /** @description Source Sync is not enabled, or the set, the file or the target document is not the org’s */
+            /** @description The set, the file or the target document is not the org’s */
             404: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content?: never;
             };
-            /** @description No active Google Drive connection (SOURCE_SYNC_DRIVE_NOT_CONNECTED), the set is no longer a draft (SOURCE_SYNC_CANDIDATE_SET_NOT_DRAFT), or the file is already on the list for that document (SOURCE_SYNC_CANDIDATE_ALREADY_IN_SET) */
+            /** @description Source Sync is off for this org (SOURCE_SYNC_OFF), or No active Google Drive connection (SOURCE_SYNC_DRIVE_NOT_CONNECTED), the set is no longer a draft (SOURCE_SYNC_CANDIDATE_SET_NOT_DRAFT), or the file is already on the list for that document (SOURCE_SYNC_CANDIDATE_ALREADY_IN_SET) */
             409: {
                 headers: {
                     [name: string]: unknown;
@@ -17428,14 +17610,14 @@ export interface operations {
                 };
                 content?: never;
             };
-            /** @description Source Sync is not enabled, or the set is not the org’s */
+            /** @description The set is not the org’s */
             404: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content?: never;
             };
-            /** @description Stale revision (SOURCE_SYNC_CANDIDATE_SET_STALE), an unresolved widening (SOURCE_SYNC_TREATMENT_UNRESOLVED), a file with no document (SOURCE_SYNC_TARGET_UNRESOLVED), a scope already approved (SOURCE_SYNC_SCOPE_ALREADY_APPROVED), or a set no longer a draft (SOURCE_SYNC_CANDIDATE_SET_NOT_DRAFT) */
+            /** @description Source Sync is off for this org (SOURCE_SYNC_OFF), or Stale revision (SOURCE_SYNC_CANDIDATE_SET_STALE), an unresolved widening (SOURCE_SYNC_TREATMENT_UNRESOLVED), a file with no document (SOURCE_SYNC_TARGET_UNRESOLVED), a scope already approved (SOURCE_SYNC_SCOPE_ALREADY_APPROVED), or a set no longer a draft (SOURCE_SYNC_CANDIDATE_SET_NOT_DRAFT) */
             409: {
                 headers: {
                     [name: string]: unknown;
@@ -17462,8 +17644,8 @@ export interface operations {
                     "application/json": components["schemas"]["SourceSyncCurrentSynthesisResponse"];
                 };
             };
-            /** @description Source Sync is not enabled */
-            404: {
+            /** @description Source Sync is off for this org (SOURCE_SYNC_OFF) */
+            409: {
                 headers: {
                     [name: string]: unknown;
                 };
@@ -17491,13 +17673,20 @@ export interface operations {
                     "application/json": components["schemas"]["SourceSyncSynthesisResponse"];
                 };
             };
-            /** @description Source Sync is not enabled, or the batch is not the org’s */
+            /** @description The batch is not the org’s */
             404: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content?: never;
             };
+            /** @description Source Sync is off for this org (SOURCE_SYNC_OFF) */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
         };
     };
     applySourceSynthesis: {
@@ -17537,14 +17726,14 @@ export interface operations {
                 };
                 content?: never;
             };
-            /** @description Source Sync is not enabled, or the batch or an included change is not the org’s */
+            /** @description The batch or an included change is not the org’s */
             404: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content?: never;
             };
-            /** @description An included document still has an open question (SOURCE_SYNC_DOC_BLOCKED), or the review or a change is no longer open to apply (SOURCE_SYNC_SYNTHESIS_NOT_OPEN) */
+            /** @description Source Sync is off for this org (SOURCE_SYNC_OFF), or An included document still has an open question (SOURCE_SYNC_DOC_BLOCKED), or the review or a change is no longer open to apply (SOURCE_SYNC_SYNTHESIS_NOT_OPEN) */
             409: {
                 headers: {
                     [name: string]: unknown;
@@ -17571,8 +17760,8 @@ export interface operations {
                     "application/json": components["schemas"]["SourceSyncRulesResponse"];
                 };
             };
-            /** @description Source Sync is not enabled */
-            404: {
+            /** @description Source Sync is off for this org (SOURCE_SYNC_OFF) */
+            409: {
                 headers: {
                     [name: string]: unknown;
                 };
@@ -17609,14 +17798,7 @@ export interface operations {
                 };
                 content?: never;
             };
-            /** @description Source Sync is not enabled */
-            404: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
-            /** @description An active rule already stands for this subject (SOURCE_SYNC_RULE_DUPLICATE); nothing changed */
+            /** @description Source Sync is off for this org (SOURCE_SYNC_OFF), or An active rule already stands for this subject (SOURCE_SYNC_RULE_DUPLICATE); nothing changed */
             409: {
                 headers: {
                     [name: string]: unknown;
@@ -17645,13 +17827,20 @@ export interface operations {
                     "application/json": components["schemas"]["SourceSyncRule"];
                 };
             };
-            /** @description Source Sync is not enabled, or the rule is not the org’s or is already retired */
+            /** @description The rule is not the org’s or is already retired */
             404: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content?: never;
             };
+            /** @description Source Sync is off for this org (SOURCE_SYNC_OFF) */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
         };
     };
     listSourceSyncFindings: {
@@ -17679,8 +17868,8 @@ export interface operations {
                 };
                 content?: never;
             };
-            /** @description Source Sync is not enabled */
-            404: {
+            /** @description Source Sync is off for this org (SOURCE_SYNC_OFF) */
+            409: {
                 headers: {
                     [name: string]: unknown;
                 };
@@ -17726,14 +17915,14 @@ export interface operations {
                 };
                 content?: never;
             };
-            /** @description Source Sync is not enabled, or the finding is not the org’s or names no source */
+            /** @description The finding is not the org’s or names no source */
             404: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content?: never;
             };
-            /** @description The finding already settled on its own (SOURCE_SYNC_FINDING_NOT_OPEN); nothing changed */
+            /** @description Source Sync is off for this org (SOURCE_SYNC_OFF), or The finding already settled on its own (SOURCE_SYNC_FINDING_NOT_OPEN); nothing changed */
             409: {
                 headers: {
                     [name: string]: unknown;
@@ -17767,8 +17956,8 @@ export interface operations {
                 };
                 content?: never;
             };
-            /** @description Source Sync is not enabled */
-            404: {
+            /** @description Source Sync is off for this org (SOURCE_SYNC_OFF) */
+            409: {
                 headers: {
                     [name: string]: unknown;
                 };
@@ -17814,8 +18003,8 @@ export interface operations {
                 };
                 content?: never;
             };
-            /** @description Source Sync is not enabled */
-            404: {
+            /** @description Source Sync is off for this org (SOURCE_SYNC_OFF) */
+            409: {
                 headers: {
                     [name: string]: unknown;
                 };
@@ -17848,8 +18037,8 @@ export interface operations {
                 };
                 content?: never;
             };
-            /** @description Source Sync is not enabled */
-            404: {
+            /** @description Source Sync is off for this org (SOURCE_SYNC_OFF) */
+            409: {
                 headers: {
                     [name: string]: unknown;
                 };
@@ -17893,22 +18082,80 @@ export interface operations {
                 };
                 content?: never;
             };
-            /** @description Source Sync is not enabled */
-            404: {
+            /** @description Source Sync is off for this org (SOURCE_SYNC_OFF), or Workspace-wide access is off or not set up, Drive is not connected or is not a Workspace account, reach is already domain, or Google did not accept the delegation */
+            409: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content?: never;
             };
-            /** @description Workspace-wide access is off or not set up, Drive is not connected or is not a Workspace account, reach is already domain, or Google did not accept the delegation */
-            409: {
+            /** @description Google could not be reached to verify the delegation */
+            502: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content?: never;
             };
-            /** @description Google could not be reached to verify the delegation */
-            502: {
+        };
+    };
+    getSourceSyncSettings: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The org’s Source Sync switch */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SourceSyncSettingsResponse"];
+                };
+            };
+            /** @description The caller may not manage integrations */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    putSourceSyncSettings: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["SourceSyncPutSettingsRequest"];
+            };
+        };
+        responses: {
+            /** @description The switch as it now stands */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SourceSyncSettingsResponse"];
+                };
+            };
+            /** @description Invalid body */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description The caller may not manage integrations */
+            403: {
                 headers: {
                     [name: string]: unknown;
                 };

package/src/generated/openapi-routes.ts

@@ -9,6 +9,8 @@ export const openApiRoutes = {
   '/api/account/deletion-eligibility': ['GET'],
   '/api/account/sessions': ['GET'],
   '/api/account/sessions/{sessionId}': ['DELETE'],
+  '/api/analysis-workflows/{id}': ['GET'],
+  '/api/analysis-workflows/{id}/stop': ['POST'],
   '/api/auth/consent/grant': ['POST'],
   '/api/billing/price-list': ['GET'],
   '/api/capabilities': ['GET'],
@@ -191,6 +193,7 @@ export const openApiRoutes = {
   '/api/source-sync/reach/upgrade': ['POST'],
   '/api/source-sync/rules': ['GET', 'POST'],
   '/api/source-sync/rules/{ruleId}/retire': ['POST'],
+  '/api/source-sync/settings': ['GET', 'PUT'],
   '/api/source-sync/standing-orders': ['GET'],
   '/api/source-sync/standing-orders/{scopeKey}': ['PUT'],
   '/api/source-sync/syntheses/current': ['GET'],