botmux 2.111.0 → 2.112.0

package/dist/workflows/v3/library-schema.d.ts

@@ -0,0 +1,138 @@
+/**
+ * Saved Workflow library schema.
+ *
+ * A saved workflow is deliberately separate from a v3 run:
+ *   - metadata.json is the small mutable index (name/scope/pointers/status)
+ *   - revisions/<revisionId>.json is immutable and content addressed
+ *
+ * This module has no dependency on the legacy workflow definition/runtime.
+ * It only reuses the v3 DAG/spec validators, then removes the run-specific
+ * `runId` from the persisted template shape.
+ */
+import type { V3Node } from './dag.js';
+import type { Spec } from './contract.js';
+export { canonicalJsonStringify } from '../../utils/canonical-json.js';
+export declare const SAVED_WORKFLOW_METADATA_SCHEMA_VERSION: 1;
+export declare const SAVED_WORKFLOW_REVISION_SCHEMA_VERSION: 1;
+export declare const SAVED_WORKFLOW_ID_RE: RegExp;
+export declare const SAVED_WORKFLOW_REVISION_ID_RE: RegExp;
+export declare const SAVED_WORKFLOW_CONTENT_HASH_RE: RegExp;
+export declare const SAVED_WORKFLOW_PARAM_NAME_RE: RegExp;
+export type SavedWorkflowScope = {
+    kind: 'chat';
+    chatId: string;
+}
+/** Visible across chats owned by the same Lark app/bot, never across apps. */
+ | {
+    kind: 'global';
+};
+/** open_id is app-scoped, so ownership must retain the app it came from. */
+export interface SavedWorkflowOwner {
+    openId: string;
+    larkAppId: string;
+}
+export type SavedWorkflowStatus = 'draft' | 'active' | 'archived';
+export interface SavedWorkflowMetadata {
+    schemaVersion: typeof SAVED_WORKFLOW_METADATA_SCHEMA_VERSION;
+    workflowId: string;
+    /** User-facing Unicode name. It is never used as a path segment. */
+    displayName: string;
+    aliases: string[];
+    owner: SavedWorkflowOwner;
+    scope: SavedWorkflowScope;
+    status: SavedWorkflowStatus;
+    /** Newest immutable revision, published or not. */
+    latestRevision: string;
+    /** Revision that `run` uses. Missing means this workflow is draft-only. */
+    publishedRevision?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export type SavedWorkflowParamType = 'string' | 'number' | 'boolean' | 'object' | 'array';
+export interface SavedWorkflowParamDef {
+    type: SavedWorkflowParamType;
+    required?: boolean;
+    default?: unknown;
+    description?: string;
+    /** Sensitive inputs may be supplied at run time but never have a stored default. */
+    sensitive?: boolean;
+}
+export type SavedWorkflowBuiltinContextRef = 'chatId' | 'larkAppId' | 'chatType' | 'rootMessageId' | 'initiatorOpenId';
+export interface V3DagTemplate {
+    nodes: V3Node[];
+}
+export type V3SpecTemplate = Omit<Spec, 'runId'>;
+export interface SavedWorkflowSafety {
+    /** Hash of the normalized human gates, protecting against silent gate weakening. */
+    gateDigest: string;
+    sideEffects: Array<{
+        nodeId: string;
+        kind: string;
+    }>;
+}
+export interface SavedWorkflowRevisionPayloadV1 {
+    workflowId: string;
+    humanVersion: number;
+    createdAt: string;
+    createdBy: SavedWorkflowOwner;
+    sourceRunId?: string;
+    inputs: Record<string, SavedWorkflowParamDef>;
+    contextRefs: SavedWorkflowBuiltinContextRef[];
+    specTemplate: V3SpecTemplate;
+    /** DAG is execution truth; this flag makes documentation drift explicit. */
+    specStatus: 'current' | 'stale';
+    dagTemplate: V3DagTemplate;
+    safety: SavedWorkflowSafety;
+}
+/** Fields supplied by a save compiler; identity/version/provenance are allocated by the store. */
+export type SavedWorkflowRevisionDraft = Omit<SavedWorkflowRevisionPayloadV1, 'workflowId' | 'humanVersion' | 'createdAt' | 'createdBy'>;
+export interface StoredSavedWorkflowRevision {
+    schemaVersion: number;
+    revisionId: string;
+    contentHash: string;
+    payload: unknown;
+}
+export interface LoadedSavedWorkflowRevision {
+    revisionId: string;
+    contentHash: string;
+    storedSchemaVersion: number;
+    schemaVersion: typeof SAVED_WORKFLOW_REVISION_SCHEMA_VERSION;
+    payload: SavedWorkflowRevisionPayloadV1;
+    migrated: boolean;
+}
+export declare class SavedWorkflowSchemaError extends Error {
+    readonly problems: string[];
+    constructor(problems: string[]);
+}
+export declare function validateSavedWorkflowMetadata(raw: unknown): SavedWorkflowMetadata;
+export declare function mintSavedWorkflowId(uuid?: string): string;
+/** Lookup normalization affects discovery only; the original Unicode value is preserved. */
+export declare function normalizeSavedWorkflowLookupKey(value: string): string;
+/** Shared by host-owned compilers before they construct an input definition. */
+export declare function isValidSavedWorkflowParamName(name: string): boolean;
+export declare function validateDagTemplate(raw: unknown): V3DagTemplate;
+export declare function validateSpecTemplate(raw: unknown): V3SpecTemplate;
+export declare function computeSavedWorkflowGateDigest(dagTemplate: V3DagTemplate): string;
+export declare function computeSavedWorkflowSideEffects(dagTemplate: V3DagTemplate): Array<{
+    nodeId: string;
+    kind: string;
+}>;
+export declare function validateSavedWorkflowRevisionPayload(raw: unknown): SavedWorkflowRevisionPayloadV1;
+/**
+ * Strict host-owned validation for a revision before the store allocates its
+ * identity/version fields. Unknown identity fields are rejected rather than
+ * allowed to override the store's authority later.
+ */
+export declare function validateSavedWorkflowRevisionDraft(raw: unknown): SavedWorkflowRevisionDraft;
+export declare function computeSavedWorkflowRevisionContentHash(schemaVersion: number, payload: unknown): string;
+export declare function buildSavedWorkflowRevision(payload: unknown): StoredSavedWorkflowRevision;
+export declare function migrateSavedWorkflowRevisionPayload(schemaVersion: number, payload: unknown): {
+    schemaVersion: number;
+    payload: unknown;
+    migrated: boolean;
+};
+export declare function loadSavedWorkflowRevision(raw: unknown, expected?: {
+    workflowId?: string;
+    revisionId?: string;
+}): LoadedSavedWorkflowRevision;
+//# sourceMappingURL=library-schema.d.ts.map

package/dist/workflows/v3/library-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"library-schema.d.ts","sourceRoot":"","sources":["../../../src/workflows/v3/library-schema.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAKH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAM1C,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AAEvE,eAAO,MAAM,sCAAsC,EAAG,CAAU,CAAC;AACjE,eAAO,MAAM,sCAAsC,EAAG,CAAU,CAAC;AAEjE,eAAO,MAAM,oBAAoB,QAAsB,CAAC;AACxD,eAAO,MAAM,6BAA6B,QAAuB,CAAC;AAClE,eAAO,MAAM,8BAA8B,QAA0B,CAAC;AACtE,eAAO,MAAM,4BAA4B,QAAkC,CAAC;AAS5E,MAAM,MAAM,kBAAkB,GAC1B;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE;AAClC,8EAA8E;GAC5E;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC;AAEvB,4EAA4E;AAC5E,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,mBAAmB,GAAG,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAC;AAElE,MAAM,WAAW,qBAAqB;IACpC,aAAa,EAAE,OAAO,sCAAsC,CAAC;IAC7D,UAAU,EAAE,MAAM,CAAC;IACnB,oEAAoE;IACpE,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,KAAK,EAAE,kBAAkB,CAAC;IAC1B,KAAK,EAAE,kBAAkB,CAAC;IAC1B,MAAM,EAAE,mBAAmB,CAAC;IAC5B,mDAAmD;IACnD,cAAc,EAAE,MAAM,CAAC;IACvB,2EAA2E;IAC3E,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,sBAAsB,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,OAAO,CAAC;AAE1F,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,sBAAsB,CAAC;IAC7B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oFAAoF;IACpF,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,MAAM,8BAA8B,GACtC,QAAQ,GACR,WAAW,GACX,UAAU,GACV,eAAe,GACf,iBAAiB,CAAC;AAEtB,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAEjD,MAAM,WAAW,mBAAmB;IAClC,oFAAoF;IACpF,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,KAAK,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACtD;AAED,MAAM,WAAW,8BAA8B;IAC7C,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,kBAAkB,CAAC;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IAC9C,WAAW,EAAE,8BAA8B,EAAE,CAAC;IAC9C,YAAY,EAAE,cAAc,CAAC;IAC7B,4EAA4E;IAC5E,UAAU,EAAE,SAAS,GAAG,OAAO,CAAC;IAChC,WAAW,EAAE,aAAa,CAAC;IAC3B,MAAM,EAAE,mBAAmB,CAAC;CAC7B;AAED,kGAAkG;AAClG,MAAM,MAAM,0BAA0B,GAAG,IAAI,CAC3C,8BAA8B,EAC9B,YAAY,GAAG,cAAc,GAAG,WAAW,GAAG,WAAW,CAC1D,CAAC;AAEF,MAAM,WAAW,2BAA2B;IAC1C,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,2BAA2B;IAC1C,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,aAAa,EAAE,OAAO,sCAAsC,CAAC;IAC7D,OAAO,EAAE,8BAA8B,CAAC;IACxC,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,qBAAa,wBAAyB,SAAQ,KAAK;aACrB,QAAQ,EAAE,MAAM,EAAE;gBAAlB,QAAQ,EAAE,MAAM,EAAE;CAI/C;AAkDD,wBAAgB,6BAA6B,CAAC,GAAG,EAAE,OAAO,GAAG,qBAAqB,CA0EjF;AAED,wBAAgB,mBAAmB,CAAC,IAAI,GAAE,MAAqB,GAAG,MAAM,CAIvE;AAED,4FAA4F;AAC5F,wBAAgB,+BAA+B,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAErE;AAiFD,gFAAgF;AAChF,wBAAgB,6BAA6B,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAGnE;AA0BD,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,OAAO,GAAG,aAAa,CAgB/D;AAmBD,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,OAAO,GAAG,cAAc,CAajE;AAgBD,wBAAgB,8BAA8B,CAAC,WAAW,EAAE,aAAa,GAAG,MAAM,CAEjF;AAED,wBAAgB,+BAA+B,CAC7C,WAAW,EAAE,aAAa,GACzB,KAAK,CAAC;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,CAKzC;AA0CD,wBAAgB,oCAAoC,CAAC,GAAG,EAAE,OAAO,GAAG,8BAA8B,CA8DjG;AAED;;;;GAIG;AACH,wBAAgB,kCAAkC,CAAC,GAAG,EAAE,OAAO,GAAG,0BAA0B,CA2B3F;AAED,wBAAgB,uCAAuC,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,MAAM,CAEvG;AAED,wBAAgB,0BAA0B,CAAC,OAAO,EAAE,OAAO,GAAG,2BAA2B,CAYxF;AAUD,wBAAgB,mCAAmC,CACjD,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,OAAO,GACf;IAAE,aAAa,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,OAAO,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAA;CAAE,CAkBhE;AAED,wBAAgB,yBAAyB,CACvC,GAAG,EAAE,OAAO,EACZ,QAAQ,GAAE;IAAE,UAAU,CAAC,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAA;CAAO,GAC1D,2BAA2B,CAwC7B"}