@elevasis/sdk 1.21.0 → 1.22.0

package/reference/scaffold/recipes/gate-by-feature-or-admin.md

@@ -1,121 +1,121 @@
----
-title: Gate by System or Admin
-description: Decision table and recipes for gating routes, sidebar entries, and UI elements by Organization Model system ID or admin role.
----
+---
+title: Gate by System or Admin
+description: Decision table and recipes for gating routes, sidebar entries, and UI elements by Organization Model system ID or admin role.
+---
 <!-- @generated by packages/sdk/scripts/copy-reference-docs.mjs -- DO NOT EDIT -->
 <!-- Regenerate: pnpm scaffold:sync -->
 
-
-# Gate by System or Admin
-
-System visibility starts in `core/config/organization-model.ts`. Routes still enforce access with guards.
-
-## Decide the gate
-
-| Scenario | Gate to use |
-| --- | --- |
-| Surface can be enabled or disabled per organization/member | `SystemGuard` with the system ID |
-| Surface is always available to members but restricted to admins | `AdminGuard` plus `requiresAdmin: true` on the system node |
-| Surface is both system-gated and admin-only | Both guards, plus `requiresAdmin: true` on the system node |
-
-## System gate in the org model
-
-Add or update the system in the id-keyed `systems` map.
-
-```ts
-systems: {
-  analytics: {
-    id: 'analytics',
-    order: 10,
-    label: 'Analytics',
-    enabled: false,
-    path: '/analytics',
-    icon: 'custom.analytics',
-    uiPosition: 'sidebar-primary'
-  }
-}
-```
-
-Set `enabled: true` to enable it for all members by default. Dotted IDs such as `analytics.reports` inherit system state and shell placement from their ancestors unless they declare their own value.
-
-## Route-level system gate
-
-```tsx
-import { ProtectedRoute } from '@/features/auth'
-import { SystemGuard } from '@elevasis/ui/features/auth'
-import { createFileRoute, Outlet } from '@tanstack/react-router'
-
-export const Route = createFileRoute('/analytics')({ component: AnalyticsLayout })
-
-function AnalyticsLayout() {
-  return (
-    <ProtectedRoute>
-      <SystemGuard systemKey="analytics">
-        <Outlet />
-      </SystemGuard>
-    </ProtectedRoute>
-  )
-}
-```
-
-The sidebar is derived from `OrganizationModel.systems`; hiding a node there is display behavior only. Keep route guards in place for direct URL access.
-
-## Admin-only route
-
-```tsx
-import { ProtectedRoute } from '@/features/auth'
-import { AdminGuard } from '@elevasis/ui/auth'
-import { createFileRoute, Outlet } from '@tanstack/react-router'
-
-export const Route = createFileRoute('/admin')({ component: AdminLayout })
-
-function AdminLayout() {
-  return (
-    <ProtectedRoute>
-      <AdminGuard>
-        <Outlet />
-      </AdminGuard>
-    </ProtectedRoute>
-  )
-}
-```
-
-Pair the route guard with the system node:
-
-```ts
-systems: {
-  admin: {
-    id: 'admin',
-    order: 10,
-    label: 'Admin',
-    enabled: true,
-    path: '/admin',
-    uiPosition: 'sidebar-bottom',
-    requiresAdmin: true
-  }
-}
-```
-
-## Per-member override
-
-Membership config overrides enabled state per member.
-
-```ts
-{
-  systems: { analytics: false }
-}
-```
-
-Settings and admin-only pages should use admin checks, not per-member system flags.
-
-## Verify
-
-Check the state matrix:
-
-| Org system enabled | Member override | Admin | Expected result |
-| --- | --- | --- | --- |
-| true | absent | any | Route accessible, sidebar visible |
-| true | false | any | Route redirects, sidebar hidden |
-| false | absent | any | Route redirects, sidebar hidden |
-| true | absent | non-admin | Admin route redirects, admin sidebar hidden |
-| true | absent | admin | Admin route accessible, admin sidebar visible |
+
+# Gate by System or Admin
+
+System visibility starts in `core/config/organization-model.ts`. Routes still enforce access with guards.
+
+## Decide the gate
+
+| Scenario | Gate to use |
+| --- | --- |
+| Surface can be enabled or disabled per organization/member | `SystemGuard` with the system ID |
+| Surface is always available to members but restricted to admins | `AdminGuard` plus `requiresAdmin: true` on the system node |
+| Surface is both system-gated and admin-only | Both guards, plus `requiresAdmin: true` on the system node |
+
+## System gate in the org model
+
+Add or update the system in the id-keyed `systems` map.
+
+```ts
+systems: {
+  analytics: {
+    id: 'analytics',
+    order: 10,
+    label: 'Analytics',
+    enabled: false,
+    path: '/analytics',
+    icon: 'custom.analytics',
+    uiPosition: 'sidebar-primary'
+  }
+}
+```
+
+Set `enabled: true` to enable it for all members by default. Dotted IDs such as `analytics.reports` inherit system state and shell placement from their ancestors unless they declare their own value.
+
+## Route-level system gate
+
+```tsx
+import { ProtectedRoute } from '@/features/auth'
+import { SystemGuard } from '@elevasis/ui/features/auth'
+import { createFileRoute, Outlet } from '@tanstack/react-router'
+
+export const Route = createFileRoute('/analytics')({ component: AnalyticsLayout })
+
+function AnalyticsLayout() {
+  return (
+    <ProtectedRoute>
+      <SystemGuard systemKey="analytics">
+        <Outlet />
+      </SystemGuard>
+    </ProtectedRoute>
+  )
+}
+```
+
+The sidebar is derived from `OrganizationModel.systems`; hiding a node there is display behavior only. Keep route guards in place for direct URL access.
+
+## Admin-only route
+
+```tsx
+import { ProtectedRoute } from '@/features/auth'
+import { AdminGuard } from '@elevasis/ui/auth'
+import { createFileRoute, Outlet } from '@tanstack/react-router'
+
+export const Route = createFileRoute('/admin')({ component: AdminLayout })
+
+function AdminLayout() {
+  return (
+    <ProtectedRoute>
+      <AdminGuard>
+        <Outlet />
+      </AdminGuard>
+    </ProtectedRoute>
+  )
+}
+```
+
+Pair the route guard with the system node:
+
+```ts
+systems: {
+  admin: {
+    id: 'admin',
+    order: 10,
+    label: 'Admin',
+    enabled: true,
+    path: '/admin',
+    uiPosition: 'sidebar-bottom',
+    requiresAdmin: true
+  }
+}
+```
+
+## Per-member override
+
+Membership config overrides enabled state per member.
+
+```ts
+{
+  systems: { analytics: false }
+}
+```
+
+Settings and admin-only pages should use admin checks, not per-member system flags.
+
+## Verify
+
+Check the state matrix:
+
+| Org system enabled | Member override | Admin | Expected result |
+| --- | --- | --- | --- |
+| true | absent | any | Route accessible, sidebar visible |
+| true | false | any | Route redirects, sidebar hidden |
+| false | absent | any | Route redirects, sidebar hidden |
+| true | absent | non-admin | Admin route redirects, admin sidebar hidden |
+| true | absent | admin | Admin route accessible, admin sidebar visible |

package/reference/scaffold/recipes/index.md

@@ -1,51 +1,51 @@
 <!-- @generated by packages/sdk/scripts/copy-reference-docs.mjs -- DO NOT EDIT -->
 <!-- Regenerate: pnpm scaffold:sync -->
 
----
-title: Pathway Recipes
-description: Terse end-to-end walkthroughs for the three most common authoring tasks -- adding a system, adding a resource, and gating access.
----
-
-# Pathway Recipes
-
-Three sequential walkthroughs for common authoring tasks. Each recipe links into the reference docs rather than duplicating them.
-
-Before starting, read [glossary.md](../reference/glossary.md) to disambiguate overloaded terms (System, Resource, systemId, Settings asymmetry, Topology).
-
----
-
-## Recipes
-
-**[Add a System](add-a-feature.md)**
-You want a new shell system (e.g., `analytics`) with its own nav entry, sidebar, routes, and org-model gate. Covers adding a system object to the org model, `SystemModule` manifest authoring, route creation, and gating.
-
-**[Add a Resource](add-a-resource.md)**
-You want a new workflow or agent deployed to the platform. Covers OM Resource descriptor authoring, descriptor-backed `WorkflowDefinition` binding, `DeploymentSpec` assembly, relationship declarations, and CLI verification.
-
-**[Gate by System or Admin](gate-by-feature-or-admin.md)**
-You want to restrict a route, nav item, or UI element by system flag or admin role. Covers the decision table, `SystemGuard`, `AdminGuard`, nav-entry visibility fields, per-member system overrides, and the settings-asymmetry gotcha.
-
-**[Build and Extend CRM](extend-crm.md)**
-You want to build on the shared CRM without forking it: add CRM routes, compose sidebars/pages, use deal/company/contact hooks, mutate CRM data from workflows, or understand which contracts and adapters form the extension surface.
-
-**[Build and Extend Lead Gen](extend-lead-gen.md)**
-You want to build on the shared lead-gen system without forking it: add lead-gen routes, compose sidebars/pages, use list/company/contact/artifact hooks, mutate list data from workflows, or understand which contracts and adapters form the extension surface.
-
-**[Customize CRM Actions](customize-crm-actions.md)**
-You want to add, hide, or replace CRM deal action buttons, configure the shared `crmActions` provider path, or call a project-owned workflow from custom UI when server-side action dispatch constraints require it. Covers `ActionDef`, `DEFAULT_CRM_ACTIONS`, provider wiring, and the current v1 boundary for custom action dispatch.
-
-**[Customize Knowledge Browser](customize-knowledge-browser.md)**
-You want to mount, extend, or replace the default Knowledge Browser. Covers the three customization tiers (default manifest mount, sidebar composition via `KnowledgeSidebarMiddle` + `KNOWLEDGE_ITEMS`, and direct query access via `@elevasis/core/knowledge`), the one-line `vite.config.ts` plugin add (`knowledgePlugin()` from `@elevasis/ui/vite-plugin-knowledge`), and the CSS import requirement.
-
+---
+title: Pathway Recipes
+description: Terse end-to-end walkthroughs for the three most common authoring tasks -- adding a system, adding a resource, and gating access.
+---
+
+# Pathway Recipes
+
+Three sequential walkthroughs for common authoring tasks. Each recipe links into the reference docs rather than duplicating them.
+
+Before starting, read [glossary.md](../reference/glossary.md) to disambiguate overloaded terms (System, Resource, systemId, Settings asymmetry, Topology).
+
+---
+
+## Recipes
+
+**[Add an OM-Backed System](add-a-feature.md)**
+You want a new system with cohesive Organization Model semantics, executable resources, and optional UI. Covers Systems, System-owned ontology and config, Resource descriptors with `resource.ontology`, `actionKey`, `codeRefs`, runtime assembly, manifests, routes, guards, tests, and compatibility notes for old `System.content` consumers.
+
+**[Add a Resource](add-a-resource.md)**
+You want a new workflow or agent deployed to the platform. Covers OM Resource descriptor authoring, descriptor-backed `WorkflowDefinition` binding, `DeploymentSpec` assembly, relationship declarations, and CLI verification.
+
+**[Gate by System or Admin](gate-by-feature-or-admin.md)**
+You want to restrict a route, nav item, or UI element by system flag or admin role. Covers the decision table, `SystemGuard`, `AdminGuard`, nav-entry visibility fields, per-member system overrides, and the settings-asymmetry gotcha.
+
+**[Build and Extend CRM](extend-crm.md)**
+You want to build on the shared CRM without forking it: add CRM routes, compose sidebars/pages, use deal/company/contact hooks, mutate CRM data from workflows, or understand which contracts and adapters form the extension surface.
+
+**[Build and Extend Lead Gen](extend-lead-gen.md)**
+You want to build on the shared lead-gen system without forking it: add lead-gen routes, compose sidebars/pages, use list/company/contact/artifact hooks, mutate list data from workflows, or understand which contracts and adapters form the extension surface.
+
+**[Customize CRM Actions](customize-crm-actions.md)**
+You want to add, hide, or replace CRM deal action buttons, configure the shared `crmActions` provider path, or call a project-owned workflow from custom UI when server-side action dispatch constraints require it. Covers `ActionDef`, `DEFAULT_CRM_ACTIONS`, provider wiring, and the current v1 boundary for custom action dispatch.
+
+**[Customize Knowledge Browser](customize-knowledge-browser.md)**
+You want to mount, extend, or replace the default Knowledge Browser. Covers the three customization tiers (default manifest mount, sidebar composition via `KnowledgeSidebarMiddle` + `KNOWLEDGE_ITEMS`, and direct query access via `@elevasis/core/knowledge`), the one-line `vite.config.ts` plugin add (`knowledgePlugin()` from `@elevasis/ui/vite-plugin-knowledge`), and the CSS import requirement.
+
 **[Query the Knowledge Graph](query-the-knowledge-graph.md)**
-You want to browse, inspect, or traverse the OrganizationModel knowledge graph from the command line. Covers the three verbs (`knowledge:ls`, `knowledge:cat`, `knowledge:graph`), all five mount axes (`/by-system/`, `/by-kind/`, `/by-owner/`, `/graph/.../governs/`, `/graph/.../governed-by/`), dual-CLI invocation patterns (`elevasis-sdk` for external projects, `elevasis` for the monorepo), and the Windows/MSYS PowerShell gotcha.
-
----
-
-## Reference docs these recipes link into
-
-- [glossary.md](../reference/glossary.md) -- term disambiguation for System, Resource, systemId, Topology, Settings asymmetry
-- [contracts.md](../reference/contracts.md) -- TypeScript shapes: `SystemModule`, `OrganizationModel`, CRM deal types, lead-gen list/member/artifact types, `CrmToolMap`, `LeadToolMap`, `ListToolMap`, `ActionDef`
-- [feature-flags-and-gating.md](../ui/feature-flags-and-gating.md) -- full three-concept gating model
-- [workflow-recipes.md](../operations/workflow-recipes.md) -- workflow anatomy, adapters, trigger patterns
+You want to browse, inspect, or traverse the OrganizationModel knowledge graph from the command line. Covers the three verbs (`knowledge:ls`, `knowledge:cat`, `knowledge:graph`), all six mount axes (`/by-system/`, `/by-ontology/`, `/by-kind/`, `/by-owner/`, `/graph/.../governs/`, `/graph/.../governed-by/`), dual-CLI invocation patterns (`elevasis-sdk` for external projects, `elevasis` for the monorepo), JSON output shapes, and the Windows/MSYS PowerShell gotcha.
+
+---
+
+## Reference docs these recipes link into
+
+- [glossary.md](../reference/glossary.md) -- term disambiguation for System, Resource, systemId, Topology, Settings asymmetry
+- [contracts.md](../reference/contracts.md) -- TypeScript shapes: `SystemModule`, `OrganizationModel`, CRM deal types, lead-gen list/member/artifact types, `CrmToolMap`, `LeadToolMap`, `ListToolMap`, `ActionDef`
+- [feature-flags-and-gating.md](../ui/feature-flags-and-gating.md) -- full three-concept gating model
+- [workflow-recipes.md](../operations/workflow-recipes.md) -- workflow anatomy, adapters, trigger patterns