@elevasis/sdk 1.20.1 → 1.21.0

package/reference/scaffold/recipes/add-a-feature.md

@@ -1,39 +1,40 @@
----
-title: Add a Feature
-description: Add a shell feature using the flat Organization Model feature list, manifest registration, routes, and guards.
----
 <!-- @generated by packages/sdk/scripts/copy-reference-docs.mjs -- DO NOT EDIT -->
 <!-- Regenerate: pnpm scaffold:sync -->
 
+---
+title: Add a System
+description: Add a shell system using the Organization Model system list, manifest registration, routes, and guards.
+---
 
-# Add a Feature
+# Add a System
 
-Shell navigation is derived from `OrganizationModel.features`. Feature manifests attach implementation details to those feature IDs; they do not declare sidebar nav structure.
+Shell navigation is derived from `OrganizationModel.systems`. System manifests attach implementation details to those system IDs; they do not declare sidebar nav structure.
 
-## 1. Add the feature node
+## 1. Add the system node
 
-Edit `core/config/organization-model.ts` and add a feature to the `features` override.
+Edit `core/config/organization-model.ts` and add a system to the id-keyed `systems` override.
 
 ```ts
 const organizationOverride = defineOrganizationModel({
-  features: [
-    {
+  systems: {
+    analytics: {
       id: 'analytics',
+      order: 10,
       label: 'Analytics',
       enabled: true,
       path: '/analytics',
       icon: 'custom.analytics',
       uiPosition: 'sidebar-primary'
     }
-  ]
+  }
 })
 ```
 
 Use dotted IDs for hierarchy:
 
 ```ts
-{ id: 'analytics', label: 'Analytics', enabled: true, uiPosition: 'sidebar-primary' },
-{ id: 'analytics.reports', label: 'Reports', enabled: true, path: '/analytics/reports' }
+analytics: { id: 'analytics', order: 10, label: 'Analytics', enabled: true, uiPosition: 'sidebar-primary' },
+'analytics.reports': { id: 'analytics.reports', order: 20, label: 'Reports', enabled: true, path: '/analytics/reports' }
 ```
 
 Containers omit `path`; leaves provide `path`.
@@ -43,27 +44,27 @@ Containers omit `path`; leaves provide `path`.
 Create `ui/src/features/analytics/manifest.ts`.
 
 ```ts
-import type { FeatureModule } from '@elevasis/ui/provider'
+import type { SystemModule } from '@elevasis/ui/provider'
 import { IconChartBar } from '@tabler/icons-react'
 import { AnalyticsSidebar } from './sidebar'
 
-export const analyticsManifest: FeatureModule = {
+export const analyticsManifest: SystemModule = {
   key: 'analytics',
-  featureId: 'analytics',
+  systemId: 'analytics',
   icon: IconChartBar,
   sidebar: AnalyticsSidebar
 }
 ```
 
-Register it in the `FEATURE_MANIFESTS` array in `ui/src/routes/__root.tsx`.
+Register it in the `SYSTEM_MANIFESTS` array in `ui/src/routes/__root.tsx`.
 
 ## 3. Add routes
 
-Create TanStack routes whose paths match the feature nodes.
+Create TanStack routes whose paths match the system nodes.
 
 ```tsx
 import { createFileRoute, Outlet } from '@tanstack/react-router'
-import { ProtectedRoute, FeatureGuard } from '@elevasis/ui/features/auth'
+import { ProtectedRoute, SystemGuard } from '@elevasis/ui/features/auth'
 
 export const Route = createFileRoute('/analytics')({
   component: AnalyticsLayout
@@ -72,9 +73,9 @@ export const Route = createFileRoute('/analytics')({
 function AnalyticsLayout() {
   return (
     <ProtectedRoute>
-      <FeatureGuard featureKey="analytics">
+      <SystemGuard systemKey="analytics">
         <Outlet />
-      </FeatureGuard>
+      </SystemGuard>
     </ProtectedRoute>
   )
 }
@@ -82,7 +83,7 @@ function AnalyticsLayout() {
 
 ## 4. Add backing resources
 
-For workflows or agents that power the feature, author an OM Resource descriptor first, then derive runtime metadata from it:
+For workflows or agents that power the system, author an OM Resource descriptor first, then derive runtime metadata from it:
 
 ```ts
 // core/config/organization-model.ts
@@ -91,8 +92,9 @@ import { defineResources } from '@elevasis/core/organization-model'
 export const resourceDescriptors = defineResources({
   analyticsRefresh: {
     id: 'analytics-refresh',
+    order: 10,
     kind: 'workflow',
-    systemId: 'sys.analytics',
+    systemId: 'analytics',
     ownerRoleId: 'role-ops-lead',
     status: 'active'
   }
@@ -106,7 +108,6 @@ config: {
   type: resourceDescriptors.analyticsRefresh.kind,
   version: '1.0.0',
   status: 'prod',
-  links: [{ nodeId: 'feature:analytics', kind: 'operates-on' }],
   category: 'production'
 }
 ```
@@ -118,3 +119,4 @@ pnpm -C ui check-types
 pnpm -C ui test
 pnpm -C operations check
 ```
+

package/reference/scaffold/recipes/add-a-resource.md

@@ -1,10 +1,10 @@
----
-title: Add a Resource
-description: Add an OM-owned workflow or agent descriptor, bind executable behavior in operations, and verify descriptor-backed deployment.
----
 <!-- @generated by packages/sdk/scripts/copy-reference-docs.mjs -- DO NOT EDIT -->
 <!-- Regenerate: pnpm scaffold:sync -->
 
+---
+title: Add a Resource
+description: Add an OM-owned workflow or agent descriptor, bind executable behavior in operations, and verify descriptor-backed deployment.
+---
 
 # Add a Resource
 
@@ -22,11 +22,12 @@ import { defineResources } from '@elevasis/core/organization-model'
 export const resourceDescriptors = defineResources({
   myWorkflow: {
     id: 'my-workflow',
+    order: 10,
     kind: 'workflow',
-    systemId: 'sys.operations',
+    systemPath: 'sys.operations',
     ownerRoleId: 'role-ops-lead',
     status: 'active',
-    capabilityKey: 'operations.my-workflow'
+    actionKey: 'operations.my-workflow'
   }
 })
 ```
@@ -35,16 +36,12 @@ Then expose the descriptor catalog through the Organization Model:
 
 ```ts
 export const resourceGovernanceModel = {
-  systems: {
-    systems
-  },
-  resources: {
-    entries: Object.values(resourceDescriptors)
-  }
+  systems,
+  resources: resourceDescriptors
 } as const
 ```
 
-Use `organizationModel.resources.entries` as the Resources descriptor catalog. `links[].nodeId` still uses the kind-prefixed graph grammar, such as `feature:sales.crm`, `integration:instantly`, or `capability:operations.queue.review`, when a runtime resource needs semantic graph binding.
+Use `organizationModel.resources` as the Resources descriptor catalog. Graph references still use kind-prefixed IDs, such as `system:sales.crm`, `resource:lead-import`, or `action:operations.queue.review`, when runtime behavior needs semantic graph binding.
 
 ## 2. Author executable behavior
 
@@ -62,7 +59,6 @@ export const myWorkflow: WorkflowDefinition = {
     type: resourceDescriptors.myWorkflow.kind,
     version: '1.0.0',
     status: 'dev',
-    links: [{ nodeId: 'feature:operations', kind: 'operates-on' }],
     category: 'production'
   },
   contract: {