@elevasis/core 0.22.0 → 0.23.0

package/src/organization-model/domains/navigation.ts

@@ -1,14 +1,9 @@
-import { z } from 'zod'
-import {
-  OPERATIONS_COMMAND_VIEW_SURFACE_ID,
-  PROJECTS_VIEW_CAPABILITY_ID,
-  PROJECTS_FEATURE_ID,
-  PROJECTS_INDEX_SURFACE_ID,
-  SETTINGS_ROLES_SURFACE_ID
-} from '../contracts'
-import { DescriptionSchema, IconNameSchema, LabelSchema, ModelIdSchema, PathSchema, ReferenceIdsSchema } from './shared'
+import { z, type ZodType } from 'zod'
+import { DescriptionSchema, IconNameSchema, LabelSchema, ModelIdSchema, PathSchema } from './shared'
 
-export const SurfaceTypeSchema = z.enum(['page', 'dashboard', 'graph', 'detail', 'list', 'settings'])
+export const SurfaceTypeSchema = z
+  .enum(['page', 'dashboard', 'graph', 'detail', 'list', 'settings'])
+  .meta({ label: 'Surface type', color: 'blue' })
 
 export const SurfaceDefinitionSchema = z.object({
   id: ModelIdSchema,
@@ -19,14 +14,107 @@ export const SurfaceDefinitionSchema = z.object({
   enabled: z.boolean().default(true),
   devOnly: z.boolean().optional(),
   icon: IconNameSchema.optional(),
-  featureId: ModelIdSchema.optional(),
-  featureIds: ReferenceIdsSchema,
-  entityIds: ReferenceIdsSchema,
-  resourceIds: ReferenceIdsSchema,
-  capabilityIds: ReferenceIdsSchema,
-  parentId: ModelIdSchema.optional()
+  systemIds: z.array(ModelIdSchema.meta({ ref: 'system' })).default([]),
+  entityIds: z.array(ModelIdSchema.meta({ ref: 'entity' })).default([]),
+  resourceIds: z.array(ModelIdSchema.meta({ ref: 'resource' })).default([]),
+  actionIds: z.array(ModelIdSchema.meta({ ref: 'action' })).default([]),
+  parentId: ModelIdSchema.meta({ ref: 'surface' }).optional()
 })
 
+export const SidebarSurfaceTargetsSchema = z
+  .object({
+    systems: z.array(ModelIdSchema.meta({ ref: 'system' })).default([]).optional(),
+    entities: z.array(ModelIdSchema.meta({ ref: 'entity' })).default([]).optional(),
+    resources: z.array(ModelIdSchema.meta({ ref: 'resource' })).default([]).optional(),
+    actions: z.array(ModelIdSchema.meta({ ref: 'action' })).default([]).optional()
+  })
+  .default({})
+
+export interface SidebarSurfaceNode {
+  type: 'surface'
+  label: string
+  path: string
+  surfaceType: z.infer<typeof SurfaceTypeSchema>
+  description?: string
+  icon?: string
+  order?: number
+  targets?: {
+    systems?: string[]
+    entities?: string[]
+    resources?: string[]
+    actions?: string[]
+  }
+  devOnly?: boolean
+  requiresAdmin?: boolean
+}
+
+export interface SidebarGroupNode {
+  type: 'group'
+  label: string
+  description?: string
+  icon?: string
+  order?: number
+  children: Record<string, SidebarNode>
+}
+
+export type SidebarNode = SidebarSurfaceNode | SidebarGroupNode
+
+export const SidebarNodeSchema: ZodType<SidebarNode> = z.lazy(() =>
+  z.discriminatedUnion('type', [
+    z.object({
+      type: z.literal('group'),
+      label: LabelSchema,
+      description: DescriptionSchema.optional(),
+      icon: IconNameSchema.optional(),
+      order: z.number().int().optional(),
+      children: z.record(z.string(), SidebarNodeSchema).default({})
+    }),
+    z.object({
+      type: z.literal('surface'),
+      label: LabelSchema,
+      path: PathSchema,
+      surfaceType: SurfaceTypeSchema,
+      description: DescriptionSchema.optional(),
+      icon: IconNameSchema.optional(),
+      order: z.number().int().optional(),
+      targets: SidebarSurfaceTargetsSchema.optional(),
+      devOnly: z.boolean().optional(),
+      requiresAdmin: z.boolean().optional()
+    })
+  ])
+)
+
+export const SidebarSectionSchema = z.record(z.string(), SidebarNodeSchema).default({})
+
+export const SidebarNavigationSchema = z
+  .object({
+    primary: SidebarSectionSchema,
+    bottom: SidebarSectionSchema
+  })
+  .default({ primary: {}, bottom: {} })
+
+export const OrganizationModelNavigationSchema = z
+  .object({
+    sidebar: SidebarNavigationSchema
+  })
+  .default({ sidebar: { primary: {}, bottom: {} } })
+
+export const DEFAULT_ORGANIZATION_MODEL_NAVIGATION: z.infer<typeof OrganizationModelNavigationSchema> = {
+  sidebar: {
+    primary: {},
+    bottom: {}
+  }
+}
+
+export function getSortedSidebarEntries<TNode extends SidebarNode>(
+  nodes: Record<string, TNode>
+): Array<[string, TNode]> {
+  return Object.entries(nodes).sort(([leftId, left], [rightId, right]) => {
+    const orderDelta = (left.order ?? Number.MAX_SAFE_INTEGER) - (right.order ?? Number.MAX_SAFE_INTEGER)
+    return orderDelta === 0 ? leftId.localeCompare(rightId) : orderDelta
+  })
+}
+
 /**
  * Core placement values: 'primary' | 'secondary' | 'bottom'.
  *
@@ -44,373 +132,8 @@ export const NavigationGroupSchema = z.object({
   id: ModelIdSchema,
   label: LabelSchema,
   placement: z.string().trim().min(1).max(50),
-  surfaceIds: z.array(ModelIdSchema).default([])
+  surfaceIds: z.array(ModelIdSchema.meta({ ref: 'surface' })).default([])
 })
 
-export const OrganizationModelNavigationSchema = z.object({
-  defaultSurfaceId: ModelIdSchema.optional(),
-  surfaces: z.array(SurfaceDefinitionSchema).default([]),
-  groups: z.array(NavigationGroupSchema).default([])
-})
-
-export const DEFAULT_ORGANIZATION_MODEL_NAVIGATION: z.infer<typeof OrganizationModelNavigationSchema> = {
-  defaultSurfaceId: 'crm.pipeline',
-  surfaces: [
-    {
-      id: 'crm.pipeline',
-      label: 'Pipeline',
-      path: '/crm/pipeline',
-      surfaceType: 'graph',
-      enabled: true,
-      featureId: 'crm',
-      featureIds: ['crm'],
-      entityIds: ['crm.deal'],
-      resourceIds: [],
-      capabilityIds: ['crm.pipeline.manage']
-    },
-    {
-      id: 'lead-gen.lists',
-      label: 'Lists',
-      path: '/lead-gen/lists',
-      surfaceType: 'list',
-      enabled: true,
-      featureId: 'lead-gen',
-      featureIds: ['lead-gen'],
-      entityIds: ['leadgen.list'],
-      resourceIds: [],
-      capabilityIds: ['leadgen.lists.manage']
-    },
-    {
-      id: PROJECTS_INDEX_SURFACE_ID,
-      label: 'Projects',
-      path: '/projects',
-      surfaceType: 'list',
-      enabled: true,
-      featureId: PROJECTS_FEATURE_ID,
-      featureIds: [PROJECTS_FEATURE_ID],
-      entityIds: ['delivery.project'],
-      resourceIds: [],
-      capabilityIds: [PROJECTS_VIEW_CAPABILITY_ID]
-    },
-    {
-      id: 'knowledge.base',
-      label: 'Knowledge Base',
-      path: '/knowledge',
-      surfaceType: 'page',
-      enabled: true,
-      featureId: 'knowledge',
-      featureIds: ['knowledge'],
-      entityIds: [],
-      resourceIds: [],
-      capabilityIds: []
-    },
-    {
-      id: OPERATIONS_COMMAND_VIEW_SURFACE_ID,
-      label: 'Command View',
-      path: '/knowledge/command-view',
-      surfaceType: 'graph',
-      enabled: true,
-      devOnly: true,
-      featureId: 'knowledge',
-      featureIds: ['knowledge'],
-      entityIds: [],
-      resourceIds: [],
-      capabilityIds: ['knowledge.command-view']
-    },
-    {
-      id: 'operations.overview',
-      label: 'Overview',
-      path: '/operations',
-      surfaceType: 'dashboard',
-      enabled: true,
-      featureId: 'operations',
-      featureIds: ['operations'],
-      entityIds: [],
-      resourceIds: [],
-      capabilityIds: []
-    },
-    {
-      id: 'operations.resources',
-      label: 'Resources',
-      path: '/operations/resources',
-      surfaceType: 'list',
-      enabled: true,
-      featureId: 'operations',
-      featureIds: ['operations'],
-      entityIds: [],
-      resourceIds: [],
-      capabilityIds: []
-    },
-    {
-      id: 'operations.command-queue',
-      label: 'Command Queue',
-      path: '/operations/command-queue',
-      surfaceType: 'list',
-      enabled: true,
-      featureId: 'operations',
-      featureIds: ['operations'],
-      entityIds: [],
-      resourceIds: [],
-      capabilityIds: []
-    },
-    {
-      id: 'operations.sessions',
-      label: 'Sessions',
-      path: '/operations/sessions',
-      surfaceType: 'page',
-      enabled: false,
-      featureId: 'operations',
-      featureIds: ['operations'],
-      entityIds: [],
-      resourceIds: [],
-      capabilityIds: []
-    },
-    {
-      id: 'operations.task-scheduler',
-      label: 'Task Scheduler',
-      path: '/operations/task-scheduler',
-      surfaceType: 'page',
-      enabled: true,
-      featureId: 'operations',
-      featureIds: ['operations'],
-      entityIds: [],
-      resourceIds: [],
-      capabilityIds: []
-    },
-    {
-      id: 'monitoring.activity-log',
-      label: 'Activity Log',
-      path: '/monitoring/activity-log',
-      surfaceType: 'list',
-      enabled: true,
-      featureId: 'monitoring',
-      featureIds: ['monitoring'],
-      entityIds: [],
-      resourceIds: [],
-      capabilityIds: []
-    },
-    {
-      id: 'monitoring.execution-logs',
-      label: 'Execution Logs',
-      path: '/monitoring/execution-logs',
-      surfaceType: 'list',
-      enabled: true,
-      featureId: 'monitoring',
-      featureIds: ['monitoring'],
-      entityIds: [],
-      resourceIds: [],
-      capabilityIds: []
-    },
-    {
-      id: 'monitoring.execution-health',
-      label: 'Execution Health',
-      path: '/monitoring/execution-health',
-      surfaceType: 'dashboard',
-      enabled: true,
-      featureId: 'monitoring',
-      featureIds: ['monitoring'],
-      entityIds: [],
-      resourceIds: [],
-      capabilityIds: []
-    },
-    {
-      id: 'monitoring.cost-analytics',
-      label: 'Cost Analytics',
-      path: '/monitoring/cost-analytics',
-      surfaceType: 'dashboard',
-      enabled: false,
-      featureId: 'monitoring',
-      featureIds: ['monitoring'],
-      entityIds: [],
-      resourceIds: [],
-      capabilityIds: []
-    },
-    {
-      id: 'monitoring.notifications',
-      label: 'Notifications',
-      path: '/monitoring/notifications',
-      surfaceType: 'page',
-      enabled: true,
-      featureId: 'monitoring',
-      featureIds: ['monitoring'],
-      entityIds: [],
-      resourceIds: [],
-      capabilityIds: []
-    },
-    {
-      id: 'submitted-requests.list',
-      label: 'Submitted Requests',
-      path: '/monitoring/requests',
-      surfaceType: 'list',
-      enabled: true,
-      featureId: 'submitted-requests',
-      featureIds: ['submitted-requests'],
-      entityIds: ['reported_request'],
-      resourceIds: [],
-      capabilityIds: []
-    },
-    {
-      id: 'submitted-requests.detail',
-      label: 'Request Detail',
-      path: '/monitoring/requests/:requestId',
-      surfaceType: 'detail',
-      enabled: true,
-      featureId: 'submitted-requests',
-      featureIds: ['submitted-requests'],
-      entityIds: ['reported_request'],
-      resourceIds: [],
-      capabilityIds: []
-    },
-    {
-      id: 'settings.account',
-      label: 'Account',
-      path: '/settings/account',
-      surfaceType: 'settings',
-      enabled: true,
-      featureId: 'settings',
-      featureIds: ['settings'],
-      entityIds: [],
-      resourceIds: [],
-      capabilityIds: []
-    },
-    {
-      id: 'settings.appearance',
-      label: 'Appearance',
-      path: '/settings/appearance',
-      surfaceType: 'settings',
-      enabled: true,
-      featureId: 'settings',
-      featureIds: ['settings'],
-      entityIds: [],
-      resourceIds: [],
-      capabilityIds: []
-    },
-    {
-      id: SETTINGS_ROLES_SURFACE_ID,
-      label: 'My Roles',
-      path: '/settings/roles',
-      surfaceType: 'settings',
-      enabled: true,
-      featureId: 'settings',
-      featureIds: ['settings'],
-      entityIds: [],
-      resourceIds: [],
-      capabilityIds: []
-    },
-    {
-      id: 'settings.organization',
-      label: 'Organization',
-      path: '/settings/organization',
-      surfaceType: 'settings',
-      enabled: true,
-      featureId: 'settings',
-      featureIds: ['settings'],
-      entityIds: [],
-      resourceIds: [],
-      capabilityIds: []
-    },
-    {
-      id: 'settings.credentials',
-      label: 'Credentials',
-      path: '/settings/credentials',
-      surfaceType: 'settings',
-      enabled: true,
-      featureId: 'settings',
-      featureIds: ['settings'],
-      entityIds: [],
-      resourceIds: [],
-      capabilityIds: []
-    },
-    {
-      id: 'settings.api-keys',
-      label: 'API Keys',
-      path: '/settings/api-keys',
-      surfaceType: 'settings',
-      enabled: true,
-      featureId: 'settings',
-      featureIds: ['settings'],
-      entityIds: [],
-      resourceIds: [],
-      capabilityIds: []
-    },
-    {
-      id: 'settings.webhooks',
-      label: 'Webhooks',
-      path: '/settings/webhooks',
-      surfaceType: 'settings',
-      enabled: true,
-      featureId: 'settings',
-      featureIds: ['settings'],
-      entityIds: [],
-      resourceIds: [],
-      capabilityIds: []
-    },
-    {
-      id: 'settings.deployments',
-      label: 'Deployments',
-      path: '/settings/deployments',
-      surfaceType: 'settings',
-      enabled: true,
-      featureId: 'settings',
-      featureIds: ['settings'],
-      entityIds: [],
-      resourceIds: [],
-      capabilityIds: []
-    }
-  ],
-  groups: [
-    {
-      id: 'primary-workspace',
-      label: 'Workspace',
-      placement: 'primary',
-      surfaceIds: ['crm.pipeline', 'lead-gen.lists', PROJECTS_INDEX_SURFACE_ID]
-    },
-    {
-      id: 'primary-operations',
-      label: 'Operations',
-      placement: 'primary',
-      surfaceIds: [
-        'operations.overview',
-        'operations.resources',
-        'operations.command-queue',
-        'operations.sessions',
-        'operations.task-scheduler'
-      ]
-    },
-    {
-      id: 'primary-monitoring',
-      label: 'Monitoring',
-      placement: 'primary',
-      surfaceIds: [
-        'monitoring.activity-log',
-        'monitoring.execution-logs',
-        'monitoring.execution-health',
-        'monitoring.cost-analytics',
-        'monitoring.notifications',
-        'submitted-requests.list',
-        'submitted-requests.detail'
-      ]
-    },
-    {
-      id: 'primary-knowledge',
-      label: 'Knowledge',
-      placement: 'primary',
-      surfaceIds: ['knowledge.base', OPERATIONS_COMMAND_VIEW_SURFACE_ID]
-    },
-    {
-      id: 'primary-settings',
-      label: 'Settings',
-      placement: 'bottom',
-      surfaceIds: [
-        'settings.account',
-        'settings.appearance',
-        SETTINGS_ROLES_SURFACE_ID,
-        'settings.organization',
-        'settings.credentials',
-        'settings.api-keys',
-        'settings.webhooks',
-        'settings.deployments'
-      ]
-    }
-  ]
-}
+// SurfaceDefinitionSchema and NavigationGroupSchema remain for derived DTOs and
+// transitional call sites. They are not authored top-level OrganizationModel fields.

package/src/organization-model/domains/offerings.ts

@@ -1,66 +1,71 @@
-import { z } from 'zod'
-
-// ---------------------------------------------------------------------------
-// Pricing model — the four canonical pricing structures used in B2B SaaS and
-// professional services. "custom" covers bespoke / negotiated pricing.
-// ---------------------------------------------------------------------------
-
-export const PricingModelSchema = z.enum(['one-time', 'subscription', 'usage-based', 'custom'])
-
-// ---------------------------------------------------------------------------
-// Product schema — one entry per distinct offering (product or service).
-// Modeled after Business Model Canvas "Value Propositions" and company profile
-// product/service catalog language. Fields use plain English throughout.
-// ---------------------------------------------------------------------------
-
-export const ProductSchema = z.object({
-  /** Stable unique identifier for the product (e.g. "product-starter-plan"). */
-  id: z.string().trim().min(1).max(100),
-  /** Human-readable name shown to agents and in UI (e.g. "Starter Plan"). */
-  name: z.string().trim().max(200).default(''),
-  /** One or two sentences describing what this product/service delivers. */
-  description: z.string().trim().max(2000).default(''),
-  /**
-   * How this product is priced:
-   * - "one-time" — single purchase (setup fee, project fee)
-   * - "subscription" — recurring (monthly/annual SaaS, retainer)
-   * - "usage-based" — metered by consumption (API calls, seats)
-   * - "custom" — negotiated or bespoke pricing
-   */
-  pricingModel: PricingModelSchema.default('custom'),
-  /** Base price amount (≥ 0). Currency unit defined by `currency`. */
-  price: z.number().min(0).default(0),
-  /**
-   * ISO 4217 currency code (e.g. "USD", "EUR", "GBP").
-   * Free-form string to accommodate any currency; defaults to "USD".
-   */
-  currency: z.string().trim().max(10).default('USD'),
-  /**
-   * IDs of customer segments this product targets.
-   * Each id must reference a declared `customers.segments[].id`.
-   * Cross-reference enforced in `OrganizationModelSchema.superRefine()`.
-   */
-  targetSegmentIds: z.array(z.string().trim().min(1)).default([]),
-  /**
-   * Optional: ID of the platform feature responsible for delivering this product.
-   * When present, must reference a declared `features[].id`.
-   * Cross-reference enforced in `OrganizationModelSchema.superRefine()`.
-   */
-  deliveryFeatureId: z.string().trim().min(1).optional()
-})
-
-// ---------------------------------------------------------------------------
-// Offerings domain schema — a collection of products and services.
-// ---------------------------------------------------------------------------
-
-export const OfferingsDomainSchema = z.object({
-  products: z.array(ProductSchema).default([])
-})
-
-// ---------------------------------------------------------------------------
-// Seed — empty by default; adapters populate with real product definitions.
-// ---------------------------------------------------------------------------
-
-export const DEFAULT_ORGANIZATION_MODEL_OFFERINGS: z.infer<typeof OfferingsDomainSchema> = {
-  products: []
-}
+import { z } from 'zod'
+
+// ---------------------------------------------------------------------------
+// Pricing model — the four canonical pricing structures used in B2B SaaS and
+// professional services. "custom" covers bespoke / negotiated pricing.
+// ---------------------------------------------------------------------------
+
+export const PricingModelSchema = z
+  .enum(['one-time', 'subscription', 'usage-based', 'custom'])
+  .meta({ label: 'Pricing model', color: 'green' })
+
+// ---------------------------------------------------------------------------
+// Product schema — one entry per distinct offering (product or service).
+// Modeled after Business Model Canvas "Value Propositions" and company profile
+// product/service catalog language. Fields use plain English throughout.
+// ---------------------------------------------------------------------------
+
+export const ProductSchema = z.object({
+  /** Stable unique identifier for the product (e.g. "product-starter-plan"). */
+  id: z.string().trim().min(1).max(100),
+  /** Domain-map iteration order. Convention: multiples of 10 (10, 20, 30, ...) to allow easy insertion. */
+  order: z.number(),
+  /** Human-readable name shown to agents and in UI (e.g. "Starter Plan"). */
+  name: z.string().trim().max(200).default(''),
+  /** One or two sentences describing what this product/service delivers. */
+  description: z.string().trim().max(2000).default(''),
+  /**
+   * How this product is priced:
+   * - "one-time" — single purchase (setup fee, project fee)
+   * - "subscription" — recurring (monthly/annual SaaS, retainer)
+   * - "usage-based" — metered by consumption (API calls, seats)
+   * - "custom" — negotiated or bespoke pricing
+   */
+  pricingModel: PricingModelSchema.default('custom'),
+  /** Base price amount (≥ 0). Currency unit defined by `currency`. */
+  price: z.number().min(0).default(0),
+  /**
+   * ISO 4217 currency code (e.g. "USD", "EUR", "GBP").
+   * Free-form string to accommodate any currency; defaults to "USD".
+   */
+  currency: z.string().trim().max(10).default('USD'),
+  /**
+   * IDs of customer segments this product targets.
+   * Each id must reference a declared `customers.segments[].id`.
+   * Cross-reference enforced in `OrganizationModelSchema.superRefine()`.
+   */
+  targetSegmentIds: z.array(z.string().trim().min(1)).default([]),
+  /**
+   * Optional: ID of the platform system responsible for delivering this product.
+   * When present, must reference a declared `systems.systems[].id`.
+   * Cross-reference enforced in `OrganizationModelSchema.superRefine()`.
+   */
+  deliveryFeatureId: z.string().trim().min(1).optional()
+})
+
+// ---------------------------------------------------------------------------
+// Offerings domain schema — id-keyed map of products and services.
+// ---------------------------------------------------------------------------
+
+export const OfferingsDomainSchema = z
+  .record(z.string(), ProductSchema)
+  .refine((record) => Object.entries(record).every(([key, entry]) => entry.id === key), {
+    message: 'Each product entry id must match its map key'
+  })
+  .default({})
+
+// ---------------------------------------------------------------------------
+// Seed — empty by default; adapters populate with real product definitions.
+// ---------------------------------------------------------------------------
+
+export const DEFAULT_ORGANIZATION_MODEL_OFFERINGS: z.infer<typeof OfferingsDomainSchema> = {}