@synap-core/workspace-templates 0.9.3 → 0.9.4

package/dist/index.d.ts

@@ -5,13 +5,13 @@
  * YAML source files validate against these types.
  * Every consumer (browser, backend, CLI, marketplace) imports from here.
  */
-type TemplateAppKind = 'native' | 'stored' | 'url';
+type TemplateAppKind = "native" | "stored" | "url";
 interface TemplateAppRef {
     kind: TemplateAppKind;
     /** For kind='native': the appId registered in the browser manifest */
     appId?: string;
     /** For kind='native': how the platform renders the app */
-    rendererType?: 'native' | 'external' | 'iframe-srcdoc';
+    rendererType?: "native" | "external" | "iframe-srcdoc";
     /** For kind='stored': the cell key registered in the cell registry */
     cellKey?: string;
     /** For kind='stored': default props passed to the cell */
@@ -25,25 +25,34 @@ type WorkspaceJsonValue = string | number | boolean | null | WorkspaceJsonValue[
     [key: string]: WorkspaceJsonValue;
 };
 type WorkspacePrimarySurface = {
-    kind: 'app';
+    kind: "app";
     appId: string;
-    rendererType: 'native';
+    rendererType: "native";
     title?: string;
     props?: Record<string, WorkspaceJsonValue>;
 } | {
-    kind: 'app';
+    kind: "app";
     appId: string;
-    rendererType: 'external';
+    rendererType: "external";
     url: string;
     title?: string;
     props?: Record<string, WorkspaceJsonValue>;
 } | {
-    kind: 'cell';
+    kind: "cell";
     cellKey: string;
     title?: string;
     props?: Record<string, WorkspaceJsonValue>;
 } | {
-    kind: 'view';
+    /**
+     * Ordinary website. Unlike an external `app`, this has no trusted app
+     * identity and is always opened through the Browser's unprivileged URL
+     * surface.
+     */
+    kind: "url";
+    url: string;
+    title?: string;
+} | {
+    kind: "view";
     viewId: string;
     title?: string;
 };
@@ -53,12 +62,12 @@ type WorkspacePrimarySurface = {
  * slug. The pod resolves this to `WorkspacePrimarySurface` before persistence.
  */
 type WorkspacePrimarySurfaceViewReference = {
-    kind: 'view';
+    kind: "view";
     viewName: string;
     viewSlug?: string;
     title?: string;
 } | {
-    kind: 'view';
+    kind: "view";
     viewName?: string;
     viewSlug: string;
     title?: string;
@@ -102,11 +111,11 @@ interface TemplateProfile {
      * `entity_scope` of an existing profile (a divergence is reported as an
      * advisory `scopeConflict` and the live row is left alone).
      */
-    entityScope?: 'pod' | 'workspace';
+    entityScope?: "pod" | "workspace";
     /** Semantic slug for system profiles. */
     semanticSlug?: string;
     /** Kind vs role profile. Omit for default ('kind'). */
-    profileKind?: 'kind' | 'role';
+    profileKind?: "kind" | "role";
     /** For profileKind='role': which base-kind profile slugs this role can attach to. */
     applicableKinds?: string[];
     properties: TemplateProperty[];
@@ -159,21 +168,21 @@ interface TemplateDisplayTemplate {
     config: Record<string, unknown>;
 }
 interface TemplateSidebarSurface {
-    kind: 'cell' | 'view' | 'entity' | 'document' | 'channel' | 'app' | 'url';
+    kind: "cell" | "view" | "entity" | "document" | "channel" | "app" | "url";
     cellKey?: string;
     viewId?: string;
     viewName?: string;
     appId?: string;
     url?: string;
-    rendererType?: 'native' | 'external' | 'iframe-srcdoc';
-    placement?: 'main' | 'side' | 'floating' | 'modal' | 'popover' | 'embed';
-    displayMode?: 'compact' | 'medium' | 'full';
+    rendererType?: "native" | "external" | "iframe-srcdoc";
+    placement?: "main" | "side" | "floating" | "modal" | "popover" | "embed";
+    displayMode?: "compact" | "medium" | "full";
     props?: Record<string, unknown>;
     title?: string;
     meta?: Record<string, unknown>;
 }
 interface TemplateSidebarItem {
-    kind: 'app' | 'view' | 'profile' | 'external' | 'cell';
+    kind: "app" | "view" | "profile" | "external" | "cell";
     appId?: string;
     viewName?: string;
     viewId?: string;
@@ -204,7 +213,7 @@ interface TemplateLayoutConfig {
     sidebarItems?: TemplateSidebarItem[];
 }
 interface TemplateBentoBlock {
-    kind: 'view' | 'widget';
+    kind: "view" | "widget";
     viewName?: string;
     widgetType?: string;
     pos: {
@@ -222,7 +231,7 @@ interface TemplateProfileEntityBentoTemplates {
     };
 }
 /** Mirrors `WorkspaceSourceRole` in synap-backend `schema/workspaces.ts`. */
-type TemplateSourceRole = 'provider' | 'consumer' | 'provider-consumer';
+type TemplateSourceRole = "provider" | "consumer" | "provider-consumer";
 /** Mirrors `WorkspaceDefaultSource` in synap-backend `schema/workspaces.ts`. */
 interface TemplateDefaultSource {
     /** The workspace id that supplies this capability domain. */
@@ -240,7 +249,7 @@ interface TemplateOnboardingCollectTarget {
     /** Human description of what to capture for this target. */
     what: string;
     /** Roughly how many to expect — guides interview depth. */
-    cardinality?: 'one' | 'few' | 'several';
+    cardinality?: "one" | "few" | "several";
     /** Key fields the agent should make sure to fill. */
     keyFields?: string[];
 }
@@ -280,7 +289,7 @@ interface TemplateOnboarding {
 }
 interface TemplatePlaybookParam {
     name: string;
-    type: 'text' | 'number' | 'entity' | 'choice' | 'boolean';
+    type: "text" | "number" | "entity" | "choice" | "boolean";
     label?: string;
     required?: boolean;
     defaultValue?: unknown;
@@ -290,12 +299,12 @@ interface TemplatePlaybook {
     description?: string;
     goalTemplate: string;
     params?: TemplatePlaybookParam[];
-    executor?: 'is-agent' | 'external-agent' | 'hybrid';
-    inputStrategy?: 'none' | 'static' | 'rotating' | 'query';
+    executor?: "is-agent" | "external-agent" | "hybrid";
+    inputStrategy?: "none" | "static" | "rotating" | "query";
     channelSpec?: {
-        type: 'GROUP' | 'AGENT_COLLAB' | 'THREAD';
+        type: "GROUP" | "AGENT_COLLAB" | "THREAD";
         members?: string[];
-        aiReactionMode?: 'on_mention' | 'always' | 'never';
+        aiReactionMode?: "on_mention" | "always" | "never";
     };
     /**
      * A cron schedule that maintains ONE backing cron automation (a single
@@ -327,29 +336,29 @@ interface TemplatePlaybook {
         profileSlug: string;
         filter?: Record<string, unknown>;
     };
-    status?: 'draft' | 'active' | 'paused';
+    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';
+    triggerType: "event" | "cron" | "webhook" | "manual";
     triggerConfig?: Record<string, unknown>;
     flow: {
         nodes: unknown[];
         edges: unknown[];
         precondition?: string;
     };
-    status?: 'draft' | 'active' | 'paused';
+    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;
+    surface: "entity-detail" | string;
     /** What the action does when clicked. */
-    kind: 'capability' | 'playbook' | 'automation';
+    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).
@@ -381,7 +390,7 @@ interface TemplateIntegration {
     /** Override default params with {{var}} interpolation. */
     params?: Record<string, string>;
     /** "apply" (create+update) or "install" (create only). */
-    mode?: 'apply' | 'install';
+    mode?: "apply" | "install";
 }
 interface TemplateExtendsRef {
     source: string;
@@ -465,7 +474,7 @@ interface TemplateDependency {
      * - `'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';
+    relation?: "compose" | "require";
     /**
      * Short human reason shown in the install-time "this also installs…" prompt.
      */
@@ -502,7 +511,7 @@ interface WorkspaceYaml {
          * Workspace classifier — consumed by createFromDefinition (settings.workspaceType,
          * creator-role + agent-workspace behavior). Mirrors the backend union.
          */
-        workspaceType?: 'personal' | 'agent' | 'project' | 'operational';
+        workspaceType?: "personal" | "agent" | "project" | "operational";
         visibility?: string;
         /** Capabilities this workspace provides (e.g. "brand.library", "content.pipeline") */
         capabilities?: string[];

package/dist/index.js

@@ -10658,6 +10658,66 @@ var DATA = {
         "type": "linked_to_deal"
       }
     ],
+    "onboarding": {
+      "goal": "Turn the user's real commercial motion into a usable pipeline \u2014 the right companies and people, their active opportunities, and an explicit next step for every deal \u2014 so CRM becomes the place sales work moves forward.\n",
+      "framing": "THE REVENUE OPERATOR: Act as a pragmatic sales lead setting up a CRM people will actually maintain. Start from the user's existing motion, vocabulary, and active conversations. Resolve before creating so imported or Pod-wide people are reused rather than duplicated. Push for a concrete next step and date; never invent revenue, probability, or contact details.\n",
+      "expertise": {
+        "starters": [
+          "A useful first pipeline is deliberately small. Start with the few stages that change how the team acts \u2014 contacted, qualifying, proposal, negotiating, won, and lost \u2014 and keep the template's default stages unless the user's real process needs a different view.\n",
+          "Populate the workspace with live work, not a perfect historical archive: propose the three to five opportunities the user is actively trying to move, then add the companies and people needed to understand those deals.\n",
+          'Every active deal needs one observable next step with a date. If the next step is "follow up" or "keep warm", help turn it into a specific action such as "send the revised proposal Thursday" before capturing it.\n'
+        ],
+        "blindSpots": [
+          "A deal without a real person is usually an account-shaped hope. If an opportunity has no stakeholder, surface the gap instead of fabricating a placeholder contact.\n",
+          "Pipelines become fiction when stages describe confidence rather than an event the buyer completed. Ask what evidence moves a deal into its current stage, especially around proposal and negotiation.\n",
+          "More fields do not create better sales hygiene. Prioritize stage, value when known, expected close date, and next step; leave unverifiable fields empty and offer enrichment separately.\n"
+        ],
+        "bar": "A sales lead can open the pipeline and immediately see the few live opportunities, the real company and stakeholder behind each one, its evidence-based stage, and the dated next action \u2014 with no duplicate people and no invented commercial data.\n"
+      },
+      "collect": [
+        {
+          "profileSlug": "company",
+          "what": "The real prospect organisations behind current conversations.",
+          "cardinality": "few",
+          "keyFields": [
+            "website",
+            "industry",
+            "companySize",
+            "source",
+            "nextStep"
+          ]
+        },
+        {
+          "profileSlug": "person",
+          "what": "The known stakeholders for those organisations and opportunities.",
+          "cardinality": "few",
+          "keyFields": [
+            "email",
+            "jobTitle",
+            "company",
+            "source",
+            "nextFollowUpDate"
+          ]
+        },
+        {
+          "profileSlug": "deal",
+          "what": "The live opportunities worth actively moving through the pipeline.",
+          "cardinality": "few",
+          "keyFields": [
+            "dealStage",
+            "value",
+            "closeDate",
+            "nextStep"
+          ]
+        }
+      ],
+      "openingQuestions": [
+        "Which three to five opportunities are you actively trying to move right now?",
+        "For the most important one, which company and real stakeholder are involved?",
+        "What has the buyer actually done so far, and what is the next dated action?"
+      ],
+      "doneWhen": "At least one real opportunity is linked to its company or stakeholder and has an evidence-based stage plus a concrete next step; the user can see how to add or import the rest without duplicating existing people.\n"
+    },
     "playbooks": [
       {
         "name": "Enrich Lead/Company",
@@ -29398,7 +29458,8 @@ function validateTemplate(tpl, opts = {}) {
   if (!tpl.meta) add("meta-required", "meta", "Missing required field: meta");
   else {
     for (const f of REQUIRED_META_FIELDS) {
-      if (!tpl.meta[f]) add("meta-field-required", `meta.${f}`, `meta.${f} is required`);
+      if (!tpl.meta[f])
+        add("meta-field-required", `meta.${f}`, `meta.${f} is required`);
     }
   }
   if (!tpl.workspace)
@@ -29539,7 +29600,85 @@ function validateTemplate(tpl, opts = {}) {
       );
     }
   }
-  for (const c of tpl.onboarding?.collect || []) {
+  const onboarding = tpl.onboarding;
+  if (onboarding) {
+    if (typeof onboarding.goal !== "string" || onboarding.goal.trim() === "") {
+      add(
+        "onboarding-goal-empty",
+        "onboarding.goal",
+        "onboarding.goal must be a non-empty string"
+      );
+    }
+    if (typeof onboarding.framing !== "string" || onboarding.framing.trim() === "") {
+      add(
+        "onboarding-framing-empty",
+        "onboarding.framing",
+        "onboarding.framing must be a non-empty string"
+      );
+    }
+    if (!Array.isArray(onboarding.collect) || onboarding.collect.length === 0) {
+      add(
+        "onboarding-collect-empty",
+        "onboarding.collect",
+        "onboarding.collect must contain at least one structured target"
+      );
+    }
+    const expertise = onboarding.expertise;
+    for (const [field, values] of [
+      ["starters", expertise?.starters],
+      ["blindSpots", expertise?.blindSpots]
+    ]) {
+      if (values !== void 0 && (!Array.isArray(values) || values.some(
+        (value) => typeof value !== "string" || value.trim() === ""
+      ))) {
+        add(
+          "onboarding-expertise-invalid",
+          `onboarding.expertise.${field}`,
+          `onboarding.expertise.${field} must contain only non-empty strings`
+        );
+      }
+    }
+    if (expertise?.bar !== void 0 && (typeof expertise.bar !== "string" || expertise.bar.trim() === "")) {
+      add(
+        "onboarding-expertise-invalid",
+        "onboarding.expertise.bar",
+        "onboarding.expertise.bar must be a non-empty string"
+      );
+    }
+    if (onboarding.openingQuestions !== void 0 && (!Array.isArray(onboarding.openingQuestions) || onboarding.openingQuestions.some(
+      (question) => typeof question !== "string" || question.trim() === ""
+    ))) {
+      add(
+        "onboarding-opening-questions-invalid",
+        "onboarding.openingQuestions",
+        "onboarding.openingQuestions must contain only non-empty strings"
+      );
+    }
+    if (onboarding.doneWhen !== void 0 && (typeof onboarding.doneWhen !== "string" || onboarding.doneWhen.trim() === "")) {
+      add(
+        "onboarding-done-when-invalid",
+        "onboarding.doneWhen",
+        "onboarding.doneWhen must be a non-empty string"
+      );
+    }
+  }
+  for (const c of onboarding?.collect || []) {
+    if (typeof c.what !== "string" || c.what.trim() === "") {
+      add(
+        "onboarding-collect-what-empty",
+        `onboarding.collect.${c.profileSlug}.what`,
+        `onboarding.collect target "${c.profileSlug}" must describe what to capture`
+      );
+    }
+    if (c.keyFields !== void 0 && (!Array.isArray(c.keyFields) || c.keyFields.some(
+      (field) => typeof field !== "string" || field.trim() === ""
+    ))) {
+      add(
+        "onboarding-collect-key-fields-invalid",
+        `onboarding.collect.${c.profileSlug}.keyFields`,
+        `onboarding.collect target "${c.profileSlug}" keyFields must contain only non-empty strings`
+      );
+    }
     if (!known(c.profileSlug))
       add(
         "onboarding-ref-unknown",
@@ -29572,9 +29711,7 @@ function validateTemplate(tpl, opts = {}) {
         );
     const flow = a.flow ?? a.flowDefinition;
     if (flow != null) {
-      const {
-        errors: flowErrors
-      } = validateFlowDefinition(flow);
+      const { errors: flowErrors } = validateFlowDefinition(flow);
       for (const fe of flowErrors) {
         const loc = fe.nodeId ? `automation "${a.name}".flow.node "${fe.nodeId}"` : fe.edgeId ? `automation "${a.name}".flow.edge "${fe.edgeId}"` : `automation "${a.name}".flow`;
         add(`automation-flow-${fe.code}`, loc, `${loc}: ${fe.message}`);