@synap-core/workspace-templates 0.6.3 → 0.7.0

package/dist/index.d.ts

@@ -243,6 +243,52 @@ interface TemplatePlaybook {
     };
     status?: 'draft' | 'active' | 'paused';
 }
+interface TemplateAutomation {
+    /** Stable local key (unused on the wire today — reserved for dedup/refs). */
+    key?: string;
+    name: string;
+    description?: string;
+    triggerType: 'event' | 'cron' | 'webhook' | 'manual';
+    triggerConfig?: Record<string, unknown>;
+    flow: {
+        nodes: unknown[];
+        edges: unknown[];
+        precondition?: string;
+    };
+    status?: 'draft' | 'active' | 'paused';
+}
+interface TemplateActionPlacement {
+    /** Entity kind whose detail surface this action appears on. */
+    profileSlug: string;
+    /** Where the action renders. Only "entity-detail" is consumed today. */
+    surface: 'entity-detail' | string;
+    /** What the action does when clicked. */
+    kind: 'capability' | 'playbook' | 'automation';
+    /**
+     * Reference to the thing to run: a capability verb key, or a playbook /
+     * automation NAME (resolved to a row id at apply time).
+     */
+    ref: string;
+    /** Human label shown on the action button. */
+    label: string;
+    /** Additional entity-state requirements, evaluated by the rendering surface. */
+    when?: {
+        /** All listed workspace facets must be present on the entity. */
+        requiredFacetSlugs?: string[];
+        /** Entity property values that must equal their configured literal values. */
+        propertyEquals?: Record<string, unknown>;
+        /** Any configured property/value match makes the action applicable. */
+        propertyAnyEquals?: Record<string, unknown[]>;
+        /** Entity property values that must not equal their configured literal values. */
+        propertyNotEquals?: Record<string, unknown>;
+    };
+    /** Explicit intent required before a consequential action is launched. */
+    confirmation?: {
+        title: string;
+        description?: string;
+        confirmLabel?: string;
+    };
+}
 interface TemplateIntegration {
     /** Capability template key to install (matches a capability template). */
     templateKey: string;
@@ -406,6 +452,16 @@ interface WorkspaceYaml {
     profileEntityBentoTemplates?: TemplateProfileEntityBentoTemplates;
     /** Playbooks (session templates) seeded with the workspace */
     playbooks?: TemplatePlaybook[];
+    /**
+     * Flow-based automations (WHEN→THEN triggers) seeded with the workspace.
+     * Applier-only — see {@link TemplateAutomation}.
+     */
+    automations?: TemplateAutomation[];
+    /**
+     * Entity-detail action placements seeded into `settings.actionPlacements`.
+     * See {@link TemplateActionPlacement}.
+     */
+    actionPlacements?: TemplateActionPlacement[];
     /** Capability templates (tools/connectors) to install on provisioning */
     integrations?: TemplateIntegration[];
     /**
@@ -652,6 +708,48 @@ interface AssembleCatalogInput {
  * per-source `isPrivate` control (e.g. keeping browse and `/mine` distinct).
  */
 declare function assembleCatalog(input: AssembleCatalogInput): MergeCatalogResult;
+/** A template a pod has installed — the door reads `settings.packageVersion` off the workspace row. */
+interface InstalledTemplate {
+    slug: string;
+    version: string;
+}
+/** Per-slug verdict: is a newer catalog version available than what's installed? */
+interface TemplateUpdateCheck {
+    slug: string;
+    installedVersion: string;
+    /** `undefined` when the slug has no matching catalog entry, or a bundled winner and no `bundleVersion` was passed. */
+    latestVersion: string | undefined;
+    updateAvailable: boolean;
+    /** Passed through from the winning catalog entry, so callers can route private updates through the authed path. */
+    isPrivate?: boolean;
+}
+/**
+ * `true` when `version` is a CP content-hash stamp (`"h-<hash>"`) rather than semver.
+ * Content-hash versions are NOT semver-comparable — see `computeTemplateUpdates`.
+ */
+declare function isHashVersion(version: string | undefined): boolean;
+/**
+ * Compute, per installed template, whether the CATALOG (bundled + remote,
+ * already merged by `mergeCatalog`/`assembleCatalog`) carries a newer version
+ * than what the pod installed — the shared "update available" check all three
+ * doors (browser, synap-app, CLI) reuse instead of re-deriving it.
+ *
+ * `installed` and `catalog` are BOTH already-fetched/computed by the caller —
+ * this stays PURE, same as the rest of this module (no fetch, no auth).
+ *
+ * The catalog's winning entry carries the latest version signal two ways:
+ *   • `source: "remote"` → `remote.definition?.sourcePackage?.version` (semver
+ *     OR, going forward, a CP content-hash `"h-<hash>"` stamp).
+ *   • `source: "bundled"` → bundled entries carry no version field at all
+ *     (`TemplateMeta` has none); pass `bundleVersion` (this client's compiled
+ *     package version, the same value fed to `mergeCatalog`) to compare against
+ *     it. Omit `bundleVersion` and bundled-backed slugs report `latestVersion:
+ *     undefined, updateAvailable: false` (nothing comparable).
+ *
+ * A slug with no matching catalog entry ⇒ `updateAvailable: false`,
+ * `latestVersion: undefined` — there is nothing to update TO.
+ */
+declare function computeTemplateUpdates(installed: InstalledTemplate[], catalog: CatalogEntry[], bundleVersion?: string): TemplateUpdateCheck[];
 
 /**
  * @synap-core/workspace-templates — Definition adapter
@@ -665,6 +763,25 @@ declare function assembleCatalog(input: AssembleCatalogInput): MergeCatalogResul
  * shape never drifts per call-site.
  */
 
+/**
+ * A `TemplateAutomation` as the apply door expects it: `flowDefinition`, not
+ * the authored `flow` (mirrors `PackagePostWorkspaceBody['automations'][number]`
+ * / the Hub `POST /packages/apply` `AutomationSchema`).
+ */
+interface PackageAutomationWire {
+    /** Stable template identity; names may be edited without orphaning the flow. */
+    key?: string;
+    name: string;
+    description?: string;
+    triggerType: TemplateAutomation['triggerType'];
+    triggerConfig?: Record<string, unknown>;
+    flowDefinition?: {
+        nodes: unknown[];
+        edges: unknown[];
+        precondition?: string;
+    };
+    status?: TemplateAutomation['status'];
+}
 /** A widget block as the wire expects it: `bentoLayout[]`, keyed by `widgetType`. */
 interface BentoWidgetBlockWire {
     widgetType: string;
@@ -719,6 +836,21 @@ interface WorkspaceDefinitionInput {
      * tools/skills/automations silently dropped on that door.
      */
     capabilities?: WorkspaceYaml['integrations'];
+    /** Playbooks normalized to the workspace-create input contract. */
+    playbooks?: Array<Record<string, unknown>>;
+    /**
+     * Entity-detail action placements — forwarded verbatim to
+     * `applyPackagePostWorkspace`, which merges them into
+     * `settings.actionPlacements`. The tRPC door (`createFromDefinition`)
+     * declares `actionPlacements` in its zod input and carries them through the
+     * shared apply door. No shape transform: the authored form IS the wire form.
+     */
+    actionPlacements?: WorkspaceYaml['actionPlacements'];
+    /**
+     * Graph-based automations. Deliberately distinct from the legacy
+     * `automations` loop/playbook-trigger wire shape accepted by this door.
+     */
+    flowAutomations?: PackageAutomationWire[];
     workspaceSubtype?: string;
     workspaceType?: NonNullable<WorkspaceYaml['workspace']>['workspaceType'];
     workspaceVisibility?: string;
@@ -798,6 +930,19 @@ interface PackageDefinitionOutput {
     layoutConfig?: WorkspaceYaml['layout'];
     capabilities?: WorkspaceYaml['integrations'];
     playbooks?: WorkspaceYaml['playbooks'];
+    /** Flow-based automations — mapped to the apply door's `flowDefinition` field. */
+    automations?: PackageAutomationWire[];
+    /**
+     * Entity-detail action placements — carried verbatim (authored form IS the
+     * wire form). NOTE: the Hub `PackageApplySchema` (synap-backend
+     * `hub-protocol/rest/packages.ts`) is a plain `z.object` and does not yet
+     * declare `actionPlacements`, so on the CLI/Hub install path this field is
+     * STRIPPED before `applyPackagePostWorkspace` sees it. The tRPC
+     * `createFromDefinition` door DOES carry it. Named follow-up: add an
+     * `ActionPlacementSchema` field to `PackageApplySchema` to close the Hub half
+     * (out of the T2 fence — flagged in the handoff).
+     */
+    actionPlacements?: WorkspaceYaml['actionPlacements'];
     onboarding?: WorkspaceYaml['onboarding'];
     /** Template-composition dependencies — resolved by the apply endpoint. */
     dependencies?: WorkspaceYaml['dependencies'];
@@ -810,4 +955,4 @@ interface PackageDefinitionOutput {
  */
 declare function toPackageDefinition(slugOrYaml: string | WorkspaceYaml): PackageDefinitionOutput;
 
-export { type AssembleCatalogInput, type BentoViewBlockWire, type BentoWidgetBlockWire, type BundledCatalogEntry, type BundledEntry, type CatalogEntry, type CpPackageRow, type MergeCatalogInput, type MergeCatalogResult, PACKAGE_DEPENDENCY_KINDS, type PackageDefinitionOutput, type PackageDependencyKind, type RemoteCatalogEntry, type RemoteEntry, type RemoteSourceStatus, type SplitBentoBlocks, type TemplateAppKind, type TemplateAppRef, type TemplateBentoBlock, type TemplateDefaultSource, type TemplateDependency, type TemplateDisplayTemplate, type TemplateEntityLink, type TemplateExtendsRef, type TemplateIntegration, type TemplateLayoutConfig, type TemplateMeta, type TemplateOnboarding, type TemplateOnboardingCollectTarget, type TemplatePlaybook, type TemplatePlaybookParam, type TemplateProfile, type TemplateProfileEntityBentoTemplates, type TemplateProperty, type TemplateSeedEntity, type TemplateSidebarItem, type TemplateSidebarSurface, type TemplateSourceRole, type TemplateSuggestedRelation, type TemplateView, type ToDefinitionResult, WORKSPACE_TEMPLATES, type WorkspaceDefinitionInput, type WorkspaceTemplateSlug, type WorkspaceYaml, assembleCatalog, getWorkspaceTemplate, listPublicTemplates, listWorkspaceTemplates, mergeCatalog, rowToRemoteEntry, splitBentoBlocks, toPackageDefinition, toWorkspaceDefinition };
+export { type AssembleCatalogInput, type BentoViewBlockWire, type BentoWidgetBlockWire, type BundledCatalogEntry, type BundledEntry, type CatalogEntry, type CpPackageRow, type InstalledTemplate, type MergeCatalogInput, type MergeCatalogResult, PACKAGE_DEPENDENCY_KINDS, type PackageDefinitionOutput, type PackageDependencyKind, type RemoteCatalogEntry, type RemoteEntry, type RemoteSourceStatus, type SplitBentoBlocks, type TemplateActionPlacement, type TemplateAppKind, type TemplateAppRef, type TemplateAutomation, type TemplateBentoBlock, type TemplateDefaultSource, type TemplateDependency, type TemplateDisplayTemplate, type TemplateEntityLink, type TemplateExtendsRef, type TemplateIntegration, type TemplateLayoutConfig, type TemplateMeta, type TemplateOnboarding, type TemplateOnboardingCollectTarget, type TemplatePlaybook, type TemplatePlaybookParam, type TemplateProfile, type TemplateProfileEntityBentoTemplates, type TemplateProperty, type TemplateSeedEntity, type TemplateSidebarItem, type TemplateSidebarSurface, type TemplateSourceRole, type TemplateSuggestedRelation, type TemplateUpdateCheck, type TemplateView, type ToDefinitionResult, WORKSPACE_TEMPLATES, type WorkspaceDefinitionInput, type WorkspaceTemplateSlug, type WorkspaceYaml, assembleCatalog, computeTemplateUpdates, getWorkspaceTemplate, isHashVersion, listPublicTemplates, listWorkspaceTemplates, mergeCatalog, rowToRemoteEntry, splitBentoBlocks, toPackageDefinition, toWorkspaceDefinition };