@synap-core/workspace-templates 0.6.4 → 0.7.1

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[];
     /**
@@ -695,6 +751,118 @@ declare function isHashVersion(version: string | undefined): boolean;
  */
 declare function computeTemplateUpdates(installed: InstalledTemplate[], catalog: CatalogEntry[], bundleVersion?: string): TemplateUpdateCheck[];
 
+/**
+ * layerTemplateGraph — the KEYSTONE composition-graph engine.
+ * ============================================================
+ *
+ * Today the CLI (`synap-cli/src/commands/market.ts` `buildCompositionTrees`)
+ * renders template composition as a nested TREE: `buildDependencyNode`
+ * rebuilds a fresh `TreeNode` for every OCCURRENCE of a slug on every path, so
+ * a widely-required base (e.g. `foundation`) prints once per branch that
+ * reaches it (6× under a suite like `enterprise-os`). Its "shared" tag is only
+ * top-level-package granularity — there is no true fan-in count.
+ *
+ * This module replaces that with a LAYERED DAG: every node appears EXACTLY
+ * ONCE, positioned at its longest-path depth, with edges converging on it —
+ * so `foundation` sinks to the bedrock row with N inbound edges instead of
+ * being redrawn N times. It is the single source of truth for template
+ * composition; the CLI, browser dialogs, backend boot-ordering, and (later)
+ * the Atlas all consume it.
+ *
+ * PURE + TRANSPORT-AGNOSTIC (same discipline as `catalog.ts`): this is the
+ * ONLY module `synap-cli`, `browser`, `synap-control-plane-api`, and
+ * `synap-backend` can all resolve. No React, no dagre/d3, no fetch, no
+ * Node-only APIs. Pixel layout lives elsewhere (browser-only) — this module
+ * only computes topology (layers + edges + memoized nodes), never coordinates.
+ *
+ * CONSUMES drift, never recomputes it: `installed` / `updates` are read
+ * straight off `catalog.ts`'s `InstalledTemplate`-shaped rows and
+ * `computeTemplateUpdates()` output — this module does no semver comparison
+ * of its own.
+ */
+
+/**
+ * An installed template row, keyed by slug — the shape this engine needs to
+ * mark a node `installed` and populate `workspaceIds`.
+ *
+ * NOTE ON NAMING: `catalog.ts`'s `InstalledTemplate` is `{ slug, version }`
+ * only — it was built for `computeTemplateUpdates`'s narrower need (a version
+ * to diff) and carries no `workspaceId`. `CompositionNode.workspaceIds` is
+ * part of the ratified API and cannot be populated from that shape, so this
+ * is a REAL conflict, not a preference: this module declares its own,
+ * slightly richer row instead of importing `catalog.ts`'s `InstalledTemplate`
+ * under that name. Every field of `catalog.ts`'s `InstalledTemplate` is a
+ * subset of this one, so a caller building `InstalledTemplate[]` for
+ * `computeTemplateUpdates` can build ONE array of `CompositionInstalledEntry`
+ * and pass it to both doors.
+ */
+interface CompositionInstalledEntry {
+    slug: string;
+    workspaceId: string;
+    workspaceName?: string;
+    /** `settings.packageVersion`, when the pod stamped one. Omit when unknown. */
+    version?: string;
+}
+/** One compose-relation dependency, attached to the BASE node it overlays onto. */
+interface CompositionOverlay {
+    slug: string;
+    name: string;
+    installed: boolean;
+}
+/** One edge in the raw dependency graph, exactly as declared (kept even when broken by a cycle). */
+interface CompositionEdge {
+    from: string;
+    to: string;
+    relation: "compose" | "require";
+    depKind?: string;
+}
+interface CompositionNode {
+    slug: string;
+    name: string;
+    /** Longest-path depth: `1 + max(layer of every node that depends on this one)`. Roots = 0, bedrock = max. */
+    layer: number;
+    /** TRUE fan-in — every slug (node or compose-only overlay source) that declares a dependency on this one. */
+    dependents: string[];
+    /** Which of the input `roots` transitively reach this node (self-inclusive for a root). */
+    roots: string[];
+    installed: boolean;
+    workspaceIds: string[];
+    installedVersion?: string;
+    latestVersion?: string | null;
+    updateAvailable: boolean;
+    noVersionInfo: boolean;
+    /** `compose`-relation deps that overlay onto THIS node (see rule 2 — the overlay source itself is never a layer node). */
+    overlays: CompositionOverlay[];
+}
+interface CompositionGraph {
+    nodes: Map<string, CompositionNode>;
+    edges: CompositionEdge[];
+    /** `layers[0]` = roots … `layers[n]` = bedrock. Compose-overlay SOURCES never appear here (rule 2). */
+    layers: CompositionNode[][];
+    /** Broken back-edges `[from, to]` — surfaced, never silently swallowed (rule 4). */
+    cycles: string[][];
+}
+interface LayerTemplateGraphInput {
+    /** Top-level slugs to walk from. Always land at `layer: 0`. */
+    roots: string[];
+    /** INJECTED edge source (rule 5) — never hardcoded to the bundled map. See `bundledEdgesOf`. */
+    edgesOf: (slug: string) => readonly TemplateDependency[];
+    nameOf?: (slug: string) => string | undefined;
+    installed?: CompositionInstalledEntry[];
+    updates?: TemplateUpdateCheck[];
+}
+/**
+ * Default `edgesOf` — reads `dependencies[]` off the BUNDLED template map
+ * only. This is what the current CLI walker is hardcoded to, which is
+ * precisely the live bug rule 5 fixes: a remote/private CP-only package's
+ * `definition.dependencies` are invisible to it, so its subtree silently
+ * renders empty. Callers with a remote catalog entry available should pass
+ * their OWN `edgesOf` that falls back to `entry.remote.definition.dependencies`
+ * (or similar) for slugs this default can't see.
+ */
+declare function bundledEdgesOf(slug: string): readonly TemplateDependency[];
+declare function layerTemplateGraph(input: LayerTemplateGraphInput): CompositionGraph;
+
 /**
  * @synap-core/workspace-templates — Definition adapter
  *
@@ -707,6 +875,25 @@ declare function computeTemplateUpdates(installed: InstalledTemplate[], catalog:
  * 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;
@@ -761,6 +948,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;
@@ -840,6 +1042,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'];
@@ -852,4 +1067,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 InstalledTemplate, 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 TemplateUpdateCheck, type TemplateView, type ToDefinitionResult, WORKSPACE_TEMPLATES, type WorkspaceDefinitionInput, type WorkspaceTemplateSlug, type WorkspaceYaml, assembleCatalog, computeTemplateUpdates, getWorkspaceTemplate, isHashVersion, listPublicTemplates, listWorkspaceTemplates, mergeCatalog, rowToRemoteEntry, splitBentoBlocks, toPackageDefinition, toWorkspaceDefinition };
+export { type AssembleCatalogInput, type BentoViewBlockWire, type BentoWidgetBlockWire, type BundledCatalogEntry, type BundledEntry, type CatalogEntry, type CompositionEdge, type CompositionGraph, type CompositionInstalledEntry, type CompositionNode, type CompositionOverlay, type CpPackageRow, type InstalledTemplate, type LayerTemplateGraphInput, 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, bundledEdgesOf, computeTemplateUpdates, getWorkspaceTemplate, isHashVersion, layerTemplateGraph, listPublicTemplates, listWorkspaceTemplates, mergeCatalog, rowToRemoteEntry, splitBentoBlocks, toPackageDefinition, toWorkspaceDefinition };