@synap-core/workspace-templates 0.4.0 → 0.6.0

package/src/types.ts

@@ -53,6 +53,10 @@ export interface TemplateProfile {
   scope?: string;
   /** Semantic slug for system profiles. */
   semanticSlug?: string;
+  /** Kind vs role profile. Omit for default ('kind'). */
+  profileKind?: "kind" | "role";
+  /** For profileKind='role': which base-kind profile slugs this role can attach to. */
+  applicableKinds?: string[];
   properties: TemplateProperty[];
 }
 
@@ -329,6 +333,49 @@ export interface TemplateExtendsRef {
   };
 }
 
+// ============================================================================
+// Dependencies — the template composition graph (base + overlay)
+// ============================================================================
+
+/**
+ * A dependency this template declares on ANOTHER template/package. The install
+ * resolver (backend `POST /api/hub/packages/apply`) reads these to build the
+ * pod's template graph: every dependency is ensured present before this
+ * template is applied — missing ones install first (topologically) — and a
+ * `compose` dependency LAYERS this template's schema additively onto the
+ * dependency's workspace instead of creating a second workspace.
+ *
+ * This is the general composition primitive: a BASE template carries the
+ * agnostic data model; an OVERLAY template `compose`s onto it and adds the
+ * use-case-specific data (e.g. `blockchain-ecosystem` → `ecosystem`,
+ * `grants` → `operations`). Distinct from `extends` (which imports from a live
+ * workspace, tRPC-only) — `dependencies` is template→template.
+ */
+export interface TemplateDependency {
+  /** Slug of the template/package this one depends on. */
+  slug: string;
+  /**
+   * What the dependency is. Default `'workspace'`. Only `'workspace'`
+   * dependencies can be `compose`d; `'capability'`/`'automation'` are always
+   * `require`d present without merging.
+   */
+  kind?: 'workspace' | 'capability' | 'automation';
+  /**
+   * How this template relates to the dependency:
+   * - `'compose'`: this template is an OVERLAY on the dependency's workspace.
+   *   The base is installed first if absent, then this template's profiles /
+   *   roles / relations / views are applied ADDITIVELY onto the base workspace
+   *   — no separate workspace is created for this template.
+   * - `'require'` (default): the dependency must be present on the pod as its
+   *   own artifact, but this template does not merge into it.
+   */
+  relation?: 'compose' | 'require';
+  /**
+   * Short human reason shown in the install-time "this also installs…" prompt.
+   */
+  reason?: string;
+}
+
 // ============================================================================
 // Top-level template definition (YAML shape)
 // ============================================================================
@@ -429,6 +476,14 @@ export interface WorkspaceYaml {
 
   /** Inherit profiles/views from other workspaces */
   extends?: TemplateExtendsRef[];
+
+  /**
+   * Template-composition dependencies — other templates this one needs. The
+   * install resolver installs missing dependencies first and, for a `compose`
+   * dependency, layers this template additively onto the dependency's
+   * workspace. See {@link TemplateDependency}.
+   */
+  dependencies?: TemplateDependency[];
 }
 
 // ============================================================================

package/dist/define.d.ts

@@ -1,97 +0,0 @@
-/**
- * @synap-core/workspace-templates — Definition adapter
- *
- * Converts a YAML template (WorkspaceYaml) into the flat payload shape that
- * the backend `workspaces.createFromDefinition` mutation + Hub REST
- * `/workspaces/from-definition` endpoint expect.
- *
- * This is the single canonical seam: every consumer (browser app, onboarding,
- * CLI, marketplace) provisions a workspace through this function so the wire
- * shape never drifts per call-site.
- */
-import type { WorkspaceYaml } from './types.js';
-/** The flat definition object accepted by createFromDefinition. */
-export interface WorkspaceDefinitionInput {
-    workspaceName: string;
-    description: string;
-    proposalId?: string;
-    profiles: WorkspaceYaml['profiles'];
-    views: NonNullable<WorkspaceYaml['views']>;
-    entityLinks: NonNullable<WorkspaceYaml['entityLinks']>;
-    seedEntities: NonNullable<WorkspaceYaml['seedEntities']>;
-    suggestedRelations?: WorkspaceYaml['suggestedRelations'];
-    displayTemplates?: WorkspaceYaml['displayTemplates'];
-    layoutConfig: WorkspaceYaml['layout'] | undefined;
-    bentoViewName?: string;
-    bentoViewBlocks?: NonNullable<WorkspaceYaml['bento']>['blocks'];
-    profileEntityBentoTemplates?: WorkspaceYaml['profileEntityBentoTemplates'];
-    workspaceSubtype?: string;
-    workspaceType?: NonNullable<WorkspaceYaml['workspace']>['workspaceType'];
-    workspaceVisibility?: string;
-    workspaceCapabilities?: string[];
-    sourceRoles?: NonNullable<WorkspaceYaml['workspace']>['sourceRoles'];
-    defaultSources?: NonNullable<WorkspaceYaml['workspace']>['defaultSources'];
-    /** Per-workspace onboarding context — written to settings.onboarding. */
-    onboarding?: WorkspaceYaml['onboarding'];
-}
-export interface ToDefinitionResult {
-    definition: WorkspaceDefinitionInput;
-    /** Stable idempotency key — the template's proposalId or slug. */
-    proposalId: string;
-    /** Display name for the new workspace. */
-    workspaceName: string;
-    /** Template id for telemetry / dedup. */
-    templateId: string;
-}
-/**
- * Resolve a template (by slug or YAML object) into the createFromDefinition
- * payload. Pass `nameOverride` to rename the workspace at creation time.
- */
-export declare function toWorkspaceDefinition(slugOrYaml: string | WorkspaceYaml, nameOverride?: string): ToDefinitionResult;
-/**
- * The unified `PackageDefinition` shape consumed by `POST /api/hub/packages/apply`
- * (CLI `synap launch`) and the CP package registry seeder. It composes the
- * workspace definition with the capability/playbook/onboarding layers. Mirrors
- * `PackageDefinition` in synap-backend `package-definition.ts`. Typed loosely on
- * the layered fields to avoid a backend import; the wire validation lives in the
- * apply endpoint.
- */
-export interface PackageDefinitionOutput {
-    _meta: {
-        slug: string;
-        icon?: string;
-        color?: string;
-        tags?: string[];
-        isPublic?: boolean;
-        requiredTier?: string | null;
-    };
-    workspaceName: string;
-    description: string;
-    workspaceType?: WorkspaceYaml['workspace']['workspaceType'];
-    workspaceSubtype?: string;
-    workspaceVisibility?: string;
-    workspaceCapabilities?: string[];
-    sourceRoles?: WorkspaceYaml['workspace']['sourceRoles'];
-    defaultSources?: WorkspaceYaml['workspace']['defaultSources'];
-    profiles: WorkspaceYaml['profiles'];
-    views: NonNullable<WorkspaceYaml['views']>;
-    suggestedEntities: NonNullable<WorkspaceYaml['seedEntities']>;
-    suggestedRelations?: WorkspaceYaml['suggestedRelations'];
-    displayTemplates?: WorkspaceYaml['displayTemplates'];
-    entityLinks?: WorkspaceYaml['entityLinks'];
-    bentoLayout?: NonNullable<WorkspaceYaml['bento']>['blocks'];
-    bentoViewName?: string;
-    profileEntityBentoTemplates?: WorkspaceYaml['profileEntityBentoTemplates'];
-    layoutConfig?: WorkspaceYaml['layout'];
-    capabilities?: WorkspaceYaml['integrations'];
-    playbooks?: WorkspaceYaml['playbooks'];
-    onboarding?: WorkspaceYaml['onboarding'];
-}
-/**
- * Resolve a template (by slug or YAML object) into the full `PackageDefinition`
- * accepted by `POST /api/hub/packages/apply` and the CP registry seeder. This is
- * the single seam the CLI and control-plane use so they read from the canonical
- * package instead of disk-stored JSON.
- */
-export declare function toPackageDefinition(slugOrYaml: string | WorkspaceYaml): PackageDefinitionOutput;
-//# sourceMappingURL=define.d.ts.map

package/dist/define.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"define.d.ts","sourceRoot":"","sources":["../src/define.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAGhD,mEAAmE;AACnE,MAAM,WAAW,wBAAwB;IACvC,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;IACpC,KAAK,EAAE,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;IAC3C,WAAW,EAAE,WAAW,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC,CAAC;IACvD,YAAY,EAAE,WAAW,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC,CAAC;IACzD,kBAAkB,CAAC,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAC;IACzD,gBAAgB,CAAC,EAAE,aAAa,CAAC,kBAAkB,CAAC,CAAC;IACrD,YAAY,EAAE,aAAa,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC;IAClD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,eAAe,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;IAChE,2BAA2B,CAAC,EAAE,aAAa,CAAC,6BAA6B,CAAC,CAAC;IAE3E,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,aAAa,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC;IACzE,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;IACjC,WAAW,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC;IACrE,cAAc,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;IAC3E,yEAAyE;IACzE,UAAU,CAAC,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;CAC1C;AAED,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE,wBAAwB,CAAC;IACrC,kEAAkE;IAClE,UAAU,EAAE,MAAM,CAAC;IACnB,0CAA0C;IAC1C,aAAa,EAAE,MAAM,CAAC;IACtB,yCAAyC;IACzC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CACnC,UAAU,EAAE,MAAM,GAAG,aAAa,EAClC,YAAY,CAAC,EAAE,MAAM,GACpB,kBAAkB,CAoCpB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,uBAAuB;IACtC,KAAK,EAAE;QACL,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;QAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC9B,CAAC;IACF,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC,eAAe,CAAC,CAAC;IAC5D,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;IACjC,WAAW,CAAC,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC,aAAa,CAAC,CAAC;IACxD,cAAc,CAAC,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC,gBAAgB,CAAC,CAAC;IAC9D,QAAQ,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;IACpC,KAAK,EAAE,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;IAC3C,iBAAiB,EAAE,WAAW,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC,CAAC;IAC9D,kBAAkB,CAAC,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAC;IACzD,gBAAgB,CAAC,EAAE,aAAa,CAAC,kBAAkB,CAAC,CAAC;IACrD,WAAW,CAAC,EAAE,aAAa,CAAC,aAAa,CAAC,CAAC;IAC3C,WAAW,CAAC,EAAE,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;IAC5D,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,2BAA2B,CAAC,EAAE,aAAa,CAAC,6BAA6B,CAAC,CAAC;IAC3E,YAAY,CAAC,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAC;IACvC,YAAY,CAAC,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;IAC7C,SAAS,CAAC,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC;IACvC,UAAU,CAAC,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;CAC1C;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,UAAU,EAAE,MAAM,GAAG,aAAa,GACjC,uBAAuB,CAuCzB"}

package/dist/define.js

@@ -1,91 +0,0 @@
-/**
- * @synap-core/workspace-templates — Definition adapter
- *
- * Converts a YAML template (WorkspaceYaml) into the flat payload shape that
- * the backend `workspaces.createFromDefinition` mutation + Hub REST
- * `/workspaces/from-definition` endpoint expect.
- *
- * This is the single canonical seam: every consumer (browser app, onboarding,
- * CLI, marketplace) provisions a workspace through this function so the wire
- * shape never drifts per call-site.
- */
-import { getWorkspaceTemplate } from './templates.js';
-/**
- * Resolve a template (by slug or YAML object) into the createFromDefinition
- * payload. Pass `nameOverride` to rename the workspace at creation time.
- */
-export function toWorkspaceDefinition(slugOrYaml, nameOverride) {
-    const tpl = typeof slugOrYaml === 'string' ? getWorkspaceTemplate(slugOrYaml) : slugOrYaml;
-    if (!tpl) {
-        throw new Error(`Workspace template not found: ${String(slugOrYaml)}`);
-    }
-    const ws = tpl.workspace;
-    const name = nameOverride ?? ws.name;
-    const proposalId = ws.proposalId ?? `${tpl.meta.slug}-v1`;
-    const definition = {
-        workspaceName: name,
-        description: ws.description,
-        proposalId,
-        profiles: tpl.profiles,
-        views: tpl.views ?? [],
-        entityLinks: tpl.entityLinks ?? [],
-        seedEntities: tpl.seedEntities ?? [],
-        suggestedRelations: tpl.suggestedRelations,
-        displayTemplates: tpl.displayTemplates,
-        layoutConfig: tpl.layout,
-        bentoViewName: tpl.bento?.viewName,
-        bentoViewBlocks: tpl.bento?.blocks,
-        profileEntityBentoTemplates: tpl.profileEntityBentoTemplates,
-        workspaceSubtype: ws.subtype,
-        workspaceType: ws.workspaceType,
-        workspaceVisibility: ws.visibility,
-        workspaceCapabilities: ws.capabilities,
-        sourceRoles: ws.sourceRoles,
-        defaultSources: ws.defaultSources,
-        onboarding: tpl.onboarding,
-    };
-    return { definition, proposalId, workspaceName: name, templateId: tpl.meta.slug };
-}
-/**
- * Resolve a template (by slug or YAML object) into the full `PackageDefinition`
- * accepted by `POST /api/hub/packages/apply` and the CP registry seeder. This is
- * the single seam the CLI and control-plane use so they read from the canonical
- * package instead of disk-stored JSON.
- */
-export function toPackageDefinition(slugOrYaml) {
-    const tpl = typeof slugOrYaml === 'string' ? getWorkspaceTemplate(slugOrYaml) : slugOrYaml;
-    if (!tpl) {
-        throw new Error(`Workspace template not found: ${String(slugOrYaml)}`);
-    }
-    const ws = tpl.workspace;
-    return {
-        _meta: {
-            slug: tpl.meta.slug,
-            icon: tpl.meta.icon,
-            color: tpl.meta.color,
-            tags: tpl.meta.tags,
-            isPublic: tpl.meta.isPublic ?? true,
-        },
-        workspaceName: ws.name,
-        description: ws.description,
-        workspaceType: ws.workspaceType,
-        workspaceSubtype: ws.subtype,
-        workspaceVisibility: ws.visibility,
-        workspaceCapabilities: ws.capabilities,
-        sourceRoles: ws.sourceRoles,
-        defaultSources: ws.defaultSources,
-        profiles: tpl.profiles,
-        views: tpl.views ?? [],
-        suggestedEntities: tpl.seedEntities ?? [],
-        suggestedRelations: tpl.suggestedRelations,
-        displayTemplates: tpl.displayTemplates,
-        entityLinks: tpl.entityLinks,
-        bentoLayout: tpl.bento?.blocks,
-        bentoViewName: tpl.bento?.viewName,
-        profileEntityBentoTemplates: tpl.profileEntityBentoTemplates,
-        layoutConfig: tpl.layout,
-        capabilities: tpl.integrations,
-        playbooks: tpl.playbooks,
-        onboarding: tpl.onboarding,
-    };
-}

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,YAAY,EACV,aAAa,EACb,YAAY,EACZ,cAAc,EACd,eAAe,EACf,eAAe,EACf,gBAAgB,EAChB,YAAY,EACZ,mBAAmB,EACnB,sBAAsB,EACtB,oBAAoB,EACpB,kBAAkB,EAClB,kBAAkB,EAClB,kBAAkB,EAClB,yBAAyB,EACzB,uBAAuB,EACvB,mBAAmB,EACnB,kBAAkB,EAClB,kBAAkB,EAClB,mCAAmC,EACnC,qBAAqB,EACrB,kBAAkB,EAClB,kBAAkB,EAClB,+BAA+B,EAC/B,gBAAgB,EAChB,qBAAqB,GACtB,MAAM,YAAY,CAAC;AAEpB,OAAO,EACL,mBAAmB,EACnB,oBAAoB,EACpB,sBAAsB,EACtB,mBAAmB,GACpB,MAAM,gBAAgB,CAAC;AAExB,YAAY,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AAE5D,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AACzE,YAAY,EACV,wBAAwB,EACxB,kBAAkB,EAClB,uBAAuB,GACxB,MAAM,aAAa,CAAC"}

package/dist/templates.d.ts

@@ -1,7 +0,0 @@
-import type { WorkspaceYaml } from './types.js';
-export declare const WORKSPACE_TEMPLATES: Record<string, WorkspaceYaml>;
-export type WorkspaceTemplateSlug = keyof typeof WORKSPACE_TEMPLATES;
-export declare function getWorkspaceTemplate(slug: string): WorkspaceYaml | undefined;
-export declare function listWorkspaceTemplates(): WorkspaceYaml[];
-export declare function listPublicTemplates(): WorkspaceYaml[];
-//# sourceMappingURL=templates.d.ts.map

package/dist/templates.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../src/templates.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAgqvBhD,eAAO,MAAM,mBAAmB,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAQ,CAAC;AAEvE,MAAM,MAAM,qBAAqB,GAAG,MAAM,OAAO,mBAAmB,CAAC;AAErE,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAE5E;AAED,wBAAgB,sBAAsB,IAAI,aAAa,EAAE,CAExD;AAED,wBAAgB,mBAAmB,IAAI,aAAa,EAAE,CAErD"}