@elevasis/core 0.10.0 → 0.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +67 -159
- package/dist/index.js +321 -613
- package/dist/organization-model/index.d.ts +67 -159
- package/dist/organization-model/index.js +321 -613
- package/dist/test-utils/index.d.ts +17 -45
- package/dist/test-utils/index.js +254 -600
- package/package.json +1 -1
- package/src/__tests__/template-core-compatibility.test.ts +73 -91
- package/src/_gen/__tests__/__snapshots__/contracts.md.snap +62 -148
- package/src/organization-model/README.md +101 -97
- package/src/organization-model/__tests__/domains/resource-mappings.test.ts +24 -93
- package/src/organization-model/__tests__/graph.test.ts +82 -894
- package/src/organization-model/__tests__/resolve.test.ts +59 -690
- package/src/organization-model/__tests__/schema.test.ts +83 -407
- package/src/organization-model/defaults.ts +276 -141
- package/src/organization-model/domains/features.ts +31 -22
- package/src/organization-model/foundation.ts +42 -54
- package/src/organization-model/graph/build.ts +42 -217
- package/src/organization-model/graph/index.ts +4 -4
- package/src/organization-model/graph/link.ts +10 -0
- package/src/organization-model/graph/schema.ts +21 -16
- package/src/organization-model/graph/types.ts +10 -10
- package/src/organization-model/helpers.ts +74 -0
- package/src/organization-model/index.ts +7 -7
- package/src/organization-model/organization-graph.mdx +89 -272
- package/src/organization-model/organization-model.mdx +149 -320
- package/src/organization-model/published.ts +15 -15
- package/src/organization-model/resolve.ts +8 -33
- package/src/organization-model/schema.ts +63 -205
- package/src/organization-model/types.ts +12 -11
- package/src/platform/registry/__tests__/command-view.test.ts +6 -5
- package/src/platform/registry/__tests__/resource-link.test.ts +30 -0
- package/src/platform/registry/__tests__/resource-registry.integration.test.ts +15 -15
- package/src/platform/registry/command-view.ts +10 -12
- package/src/platform/registry/index.ts +13 -8
- package/src/platform/registry/resource-link.ts +32 -0
- package/src/platform/registry/resource-registry.ts +12 -10
- package/src/platform/registry/serialization.ts +56 -73
- package/src/platform/registry/serialized-types.ts +17 -12
- package/src/platform/registry/types.ts +14 -43
- package/src/reference/_generated/contracts.md +62 -148
- package/src/reference/glossary.md +71 -105
- package/src/platform/registry/domains.ts +0 -165
|
@@ -45,22 +45,28 @@ export type OrganizationModelProjects = z.infer<typeof OrganizationModelProjects
|
|
|
45
45
|
export type OrganizationModelFeature = z.infer<typeof FeatureSchema>
|
|
46
46
|
```
|
|
47
47
|
|
|
48
|
-
### `
|
|
48
|
+
### `NodeIdPath`
|
|
49
49
|
|
|
50
50
|
```typescript
|
|
51
|
-
export type
|
|
51
|
+
export type NodeIdPath = z.infer<typeof NodeIdPathSchema>
|
|
52
52
|
```
|
|
53
53
|
|
|
54
|
-
### `
|
|
54
|
+
### `NodeIdString`
|
|
55
55
|
|
|
56
56
|
```typescript
|
|
57
|
-
export type
|
|
57
|
+
export type NodeIdString = z.infer<typeof NodeIdStringSchema>
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### `OrganizationModelNavigation`
|
|
61
|
+
|
|
62
|
+
```typescript
|
|
63
|
+
export type OrganizationModelNavigation = z.infer<typeof OrganizationModelNavigationSchema>
|
|
58
64
|
```
|
|
59
65
|
|
|
60
|
-
### `
|
|
66
|
+
### `OrganizationModelSurface`
|
|
61
67
|
|
|
62
68
|
```typescript
|
|
63
|
-
export type
|
|
69
|
+
export type OrganizationModelSurface = z.infer<typeof SurfaceDefinitionSchema>
|
|
64
70
|
```
|
|
65
71
|
|
|
66
72
|
### `OrganizationModelTechStackEntry`
|
|
@@ -179,64 +185,34 @@ export type DeepPartial<T> = T extends Array<infer U> ? Array<DeepPartial<U>> :
|
|
|
179
185
|
|
|
180
186
|
## Feature System
|
|
181
187
|
|
|
182
|
-
### `
|
|
183
|
-
|
|
184
|
-
```typescript
|
|
185
|
-
export interface FeatureNavLink {
|
|
186
|
-
label: string
|
|
187
|
-
link: string
|
|
188
|
-
featureKey?: string
|
|
189
|
-
onClick?: () => void
|
|
190
|
-
links?: FeatureNavLink[]
|
|
191
|
-
}
|
|
192
|
-
```
|
|
193
|
-
|
|
194
|
-
### `FeatureNavEntry`
|
|
188
|
+
### `FeatureSidebarComponent`
|
|
195
189
|
|
|
196
190
|
```typescript
|
|
197
|
-
export
|
|
198
|
-
|
|
199
|
-
icon: ComponentType
|
|
200
|
-
link?: string
|
|
201
|
-
featureKey?: string
|
|
202
|
-
requiresAdmin?: boolean
|
|
203
|
-
dataOnboardingTourId?: string
|
|
204
|
-
links?: FeatureNavLink[]
|
|
205
|
-
}
|
|
191
|
+
export type FeatureSidebarComponent = ComponentType
|
|
192
|
+
export type FeatureIconComponent = ComponentType<{ size?: number;
|
|
206
193
|
```
|
|
207
194
|
|
|
208
|
-
### `
|
|
195
|
+
### `FeatureIconComponent`
|
|
209
196
|
|
|
210
197
|
```typescript
|
|
211
|
-
export type
|
|
198
|
+
export type FeatureIconComponent = ComponentType<{ size?: number;
|
|
212
199
|
```
|
|
213
200
|
|
|
214
201
|
### `FeatureModule`
|
|
215
202
|
|
|
216
203
|
```typescript
|
|
217
204
|
export interface FeatureModule {
|
|
218
|
-
/** Unique stable identifier for this feature
|
|
205
|
+
/** Unique stable identifier for this feature module. */
|
|
219
206
|
key: string
|
|
220
|
-
/**
|
|
207
|
+
/** Organization Model feature id this module presents. */
|
|
221
208
|
featureId: string
|
|
222
|
-
/**
|
|
223
|
-
* Capability identifiers contributed by this feature.
|
|
224
|
-
* Merged into `ResolvedFeatureSemantics.capabilityIds` at resolution time.
|
|
225
|
-
* Not queried at runtime — kept for semantic graph completeness so that
|
|
226
|
-
* capability membership is fully represented in the resolved model even when
|
|
227
|
-
* a surface does not declare it directly.
|
|
228
|
-
*/
|
|
209
|
+
/** Capability identifiers contributed by this feature module. */
|
|
229
210
|
capabilityIds?: string[]
|
|
230
|
-
/**
|
|
231
|
-
|
|
232
|
-
/** Sidebar component rendered when
|
|
211
|
+
/** Icon used when this feature node appears in shell navigation. */
|
|
212
|
+
icon?: FeatureIconComponent
|
|
213
|
+
/** Sidebar component rendered when this feature's subtree route is active. */
|
|
233
214
|
sidebar?: FeatureSidebarComponent
|
|
234
|
-
/**
|
|
235
|
-
subshellRoutes?: string[]
|
|
236
|
-
/**
|
|
237
|
-
* Operations-only bridge surface connecting this feature to the organization graph.
|
|
238
|
-
* Ignored by all other features. Only one manifest in the registry should set this.
|
|
239
|
-
*/
|
|
215
|
+
/** Operations-only bridge connecting this feature to the organization graph node. */
|
|
240
216
|
organizationGraph?: OrganizationGraphFeatureBridge
|
|
241
217
|
}
|
|
242
218
|
```
|
|
@@ -255,8 +231,6 @@ export interface ResolvedFeatureAccess {
|
|
|
255
231
|
```typescript
|
|
256
232
|
export interface ResolvedFeatureSemantics {
|
|
257
233
|
capabilityIds: string[]
|
|
258
|
-
surfaceIds: string[]
|
|
259
|
-
surfaces: OrganizationModelSurface[]
|
|
260
234
|
}
|
|
261
235
|
```
|
|
262
236
|
|
|
@@ -269,25 +243,11 @@ export interface ResolvedFeatureModule extends FeatureModule {
|
|
|
269
243
|
}
|
|
270
244
|
```
|
|
271
245
|
|
|
272
|
-
### `
|
|
273
|
-
|
|
274
|
-
```typescript
|
|
275
|
-
export type ShellNavPlacement = 'primary' | 'bottom'
|
|
276
|
-
```
|
|
277
|
-
|
|
278
|
-
### `ShellNavSource`
|
|
279
|
-
|
|
280
|
-
```typescript
|
|
281
|
-
export type ShellNavSource = 'app' | 'feature'
|
|
282
|
-
```
|
|
283
|
-
|
|
284
|
-
### `ResolvedShellNavItem`
|
|
246
|
+
### `ResolvedShellFeature`
|
|
285
247
|
|
|
286
248
|
```typescript
|
|
287
|
-
export interface
|
|
288
|
-
|
|
289
|
-
source: ShellNavSource
|
|
290
|
-
featureId?: string
|
|
249
|
+
export interface ResolvedShellFeature extends OrganizationModelFeature {
|
|
250
|
+
iconComponent?: FeatureIconComponent
|
|
291
251
|
}
|
|
292
252
|
```
|
|
293
253
|
|
|
@@ -295,16 +255,16 @@ export interface ResolvedShellNavItem extends FeatureNavEntry {
|
|
|
295
255
|
|
|
296
256
|
```typescript
|
|
297
257
|
export interface ResolvedShellModel {
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
258
|
+
features: readonly ResolvedShellFeature[]
|
|
259
|
+
findByPath: (path: string) => ResolvedShellFeature | undefined
|
|
260
|
+
findById: (id: string) => ResolvedShellFeature | undefined
|
|
261
|
+
childrenOf: (id: string) => ResolvedShellFeature[]
|
|
262
|
+
ancestorsOf: (id: string) => ResolvedShellFeature[]
|
|
263
|
+
parentOf: (id: string) => ResolvedShellFeature | undefined
|
|
264
|
+
topLevel: () => ResolvedShellFeature[]
|
|
265
|
+
uiPositionFor: (id: string) => OrganizationModelFeature['uiPosition'] | undefined
|
|
266
|
+
requiresAdminFor: (id: string) => boolean
|
|
267
|
+
devOnlyFor: (id: string) => boolean
|
|
308
268
|
}
|
|
309
269
|
```
|
|
310
270
|
|
|
@@ -321,8 +281,7 @@ export interface ResolvedShellRouteMatch {
|
|
|
321
281
|
status: ShellRouteMatchStatus
|
|
322
282
|
path: string
|
|
323
283
|
feature?: ResolvedFeatureModule
|
|
324
|
-
|
|
325
|
-
navLink?: FeatureNavLink
|
|
284
|
+
node?: ResolvedShellFeature
|
|
326
285
|
}
|
|
327
286
|
```
|
|
328
287
|
|
|
@@ -338,7 +297,7 @@ export interface ShellRuntime {
|
|
|
338
297
|
|
|
339
298
|
```typescript
|
|
340
299
|
export interface OrganizationGraphFeatureBridge {
|
|
341
|
-
|
|
300
|
+
featureId: string
|
|
342
301
|
}
|
|
343
302
|
```
|
|
344
303
|
|
|
@@ -347,10 +306,8 @@ export interface OrganizationGraphFeatureBridge {
|
|
|
347
306
|
```typescript
|
|
348
307
|
export interface OrganizationGraphContextValue {
|
|
349
308
|
available: boolean
|
|
350
|
-
surfaceId?: string
|
|
351
|
-
surfacePath?: string
|
|
352
|
-
surfaceType?: OrganizationModelSurface['surfaceType']
|
|
353
309
|
featureId?: string
|
|
310
|
+
featurePath?: string
|
|
354
311
|
}
|
|
355
312
|
```
|
|
356
313
|
|
|
@@ -360,7 +317,6 @@ export interface OrganizationGraphContextValue {
|
|
|
360
317
|
export interface ElevasisFeaturesProviderProps {
|
|
361
318
|
features: FeatureModule[]
|
|
362
319
|
organizationModel?: OrganizationModel
|
|
363
|
-
appShellOverrides?: AppShellOverrides
|
|
364
320
|
timeRange?: TimeRange
|
|
365
321
|
operationsApiUrl?: string
|
|
366
322
|
operationsSSEManager?: SSEConnectionManagerLike
|
|
@@ -401,8 +357,8 @@ export interface ElevasisFeaturesContextValue {
|
|
|
401
357
|
* Resource Registry type definitions
|
|
402
358
|
*/
|
|
403
359
|
|
|
404
|
-
import type { IntegrationType } from '../../execution/engine/tools/integration'
|
|
405
|
-
import type {
|
|
360
|
+
import type { IntegrationType } from '../../execution/engine/tools/integration'
|
|
361
|
+
import type { ResourceCategory, ResourceLink } from './resource-link'
|
|
406
362
|
|
|
407
363
|
// ============================================================================
|
|
408
364
|
// Core Resource Type Definitions
|
|
@@ -479,8 +435,11 @@ export interface ResourceDefinition {
|
|
|
479
435
|
/** Environment/deployment status */
|
|
480
436
|
status: ResourceStatus
|
|
481
437
|
|
|
482
|
-
/**
|
|
483
|
-
|
|
438
|
+
/** Graph links to Organization Model nodes */
|
|
439
|
+
links?: ResourceLink[]
|
|
440
|
+
|
|
441
|
+
/** Infrastructure category for filtering */
|
|
442
|
+
category?: ResourceCategory
|
|
484
443
|
|
|
485
444
|
/** Whether the agent supports multi-turn sessions (agents only) */
|
|
486
445
|
sessionCapable?: boolean
|
|
@@ -493,7 +452,7 @@ export interface ResourceDefinition {
|
|
|
493
452
|
}
|
|
494
453
|
```
|
|
495
454
|
|
|
496
|
-
### `
|
|
455
|
+
### `ResourceList`
|
|
497
456
|
|
|
498
457
|
```typescript
|
|
499
458
|
/** Unique resource identifier */
|
|
@@ -514,8 +473,11 @@ export interface ResourceDefinition {
|
|
|
514
473
|
/** Environment/deployment status */
|
|
515
474
|
status: ResourceStatus
|
|
516
475
|
|
|
517
|
-
/**
|
|
518
|
-
|
|
476
|
+
/** Graph links to Organization Model nodes */
|
|
477
|
+
links?: ResourceLink[]
|
|
478
|
+
|
|
479
|
+
/** Infrastructure category for filtering */
|
|
480
|
+
category?: ResourceCategory
|
|
519
481
|
|
|
520
482
|
/** Whether the agent supports multi-turn sessions (agents only) */
|
|
521
483
|
sessionCapable?: boolean
|
|
@@ -527,57 +489,9 @@ export interface ResourceDefinition {
|
|
|
527
489
|
archived?: boolean
|
|
528
490
|
}
|
|
529
491
|
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
/**
|
|
535
|
-
* Domain definition for Command View filtering
|
|
536
|
-
*
|
|
537
|
-
* Domains are organizational metadata for UI filtering/grouping.
|
|
538
|
-
* No execution impact - purely for visualization.
|
|
539
|
-
*
|
|
540
|
-
* @example
|
|
541
|
-
* {
|
|
542
|
-
* id: 'support',
|
|
543
|
-
* name: 'Customer Support',
|
|
544
|
-
* description: 'Ticket triage, knowledge base, escalations',
|
|
545
|
-
* color: 'green',
|
|
546
|
-
* icon: 'IconHeadset'
|
|
547
|
-
* }
|
|
548
|
-
*/
|
|
549
|
-
export interface DomainDefinition {
|
|
550
|
-
/** Unique identifier (e.g., 'support') */
|
|
551
|
-
id: string
|
|
552
|
-
/** Display name (e.g., 'Customer Support') */
|
|
553
|
-
name: string
|
|
554
|
-
/** Purpose description */
|
|
555
|
-
description: string
|
|
556
|
-
/** Optional Mantine color for UI (e.g., 'blue', 'green', 'orange') */
|
|
557
|
-
color?: string
|
|
558
|
-
/** Optional Tabler icon name (e.g., 'IconHeadset') */
|
|
559
|
-
icon?: string
|
|
560
|
-
}
|
|
561
|
-
```
|
|
562
|
-
|
|
563
|
-
### `ResourceList`
|
|
564
|
-
|
|
565
|
-
```typescript
|
|
566
|
-
/** Unique identifier (e.g., 'support') */
|
|
567
|
-
id: string
|
|
568
|
-
/** Display name (e.g., 'Customer Support') */
|
|
569
|
-
name: string
|
|
570
|
-
/** Purpose description */
|
|
571
|
-
description: string
|
|
572
|
-
/** Optional Mantine color for UI (e.g., 'blue', 'green', 'orange') */
|
|
573
|
-
color?: string
|
|
574
|
-
/** Optional Tabler icon name (e.g., 'IconHeadset') */
|
|
575
|
-
icon?: string
|
|
576
|
-
}
|
|
577
|
-
|
|
578
|
-
/**
|
|
579
|
-
* Resource list for organization
|
|
580
|
-
* Returns ResourceDefinition metadata (not full definitions)
|
|
492
|
+
/**
|
|
493
|
+
* Resource list for organization
|
|
494
|
+
* Returns ResourceDefinition metadata (not full definitions)
|
|
581
495
|
*/
|
|
582
496
|
export interface ResourceList {
|
|
583
497
|
workflows: ResourceDefinition[]
|
|
@@ -676,7 +590,7 @@ export type TriggerConfig = WebhookTriggerConfig | ScheduleTriggerConfig | Event
|
|
|
676
590
|
* scheduled cron jobs, platform events, or manual user actions.
|
|
677
591
|
*
|
|
678
592
|
* BREAKING CHANGES (2025-11-30):
|
|
679
|
-
* - Now extends ResourceDefinition (inherits: resourceId, name, description, version, type, status,
|
|
593
|
+
* - Now extends ResourceDefinition (inherits: resourceId, name, description, version, type, status, links, category)
|
|
680
594
|
* - Field renames: `id` -> `resourceId` (inherited), `type` -> `triggerType`
|
|
681
595
|
* - Relationship rename: `invokes` -> `triggers` (unified vocabulary)
|
|
682
596
|
* - New required fields: `version` (inherited), `type: 'trigger'` (inherited)
|
|
@@ -712,7 +626,7 @@ export type TriggerConfig = WebhookTriggerConfig | ScheduleTriggerConfig | Event
|
|
|
712
626
|
* scheduled cron jobs, platform events, or manual user actions.
|
|
713
627
|
*
|
|
714
628
|
* BREAKING CHANGES (2025-11-30):
|
|
715
|
-
* - Now extends ResourceDefinition (inherits: resourceId, name, description, version, type, status,
|
|
629
|
+
* - Now extends ResourceDefinition (inherits: resourceId, name, description, version, type, status, links, category)
|
|
716
630
|
* - Field renames: `id` -> `resourceId` (inherited), `type` -> `triggerType`
|
|
717
631
|
* - Relationship rename: `invokes` -> `triggers` (unified vocabulary)
|
|
718
632
|
* - New required fields: `version` (inherited), `type: 'trigger'` (inherited)
|
|
@@ -790,7 +704,7 @@ export interface TriggerDefinition extends ResourceDefinition {
|
|
|
790
704
|
* stored here (queried at runtime from credentials table).
|
|
791
705
|
*
|
|
792
706
|
* BREAKING CHANGES (2025-11-30):
|
|
793
|
-
* - Now extends ResourceDefinition (inherits: resourceId, name, description, version, type, status,
|
|
707
|
+
* - Now extends ResourceDefinition (inherits: resourceId, name, description, version, type, status, links, category)
|
|
794
708
|
* - Field renames: `id` -> `resourceId` (inherited)
|
|
795
709
|
* - New required field: `status` (inherited) - organizations must add status to all integrations
|
|
796
710
|
* - New required field: `version` (inherited) - organizations must add version to all integrations
|
|
@@ -919,7 +833,7 @@ export type ExternalPlatform = 'n8n' | 'make' | 'zapier' | 'other'
|
|
|
919
833
|
* no API integration with external platforms, no status syncing.
|
|
920
834
|
*
|
|
921
835
|
* BREAKING CHANGES (2025-11-30):
|
|
922
|
-
* - Now extends ResourceDefinition (inherits: resourceId, name, description, version, type, status,
|
|
836
|
+
* - Now extends ResourceDefinition (inherits: resourceId, name, description, version, type, status, links, category)
|
|
923
837
|
* - Field renames: `id` -> `resourceId` (inherited)
|
|
924
838
|
* - New required field: `version` (inherited) - organizations must add version to all external resources
|
|
925
839
|
* - New required field: `type: 'external'` (inherited) - resource type discriminator
|
|
@@ -954,7 +868,7 @@ export type ExternalPlatform = 'n8n' | 'make' | 'zapier' | 'other'
|
|
|
954
868
|
* no API integration with external platforms, no status syncing.
|
|
955
869
|
*
|
|
956
870
|
* BREAKING CHANGES (2025-11-30):
|
|
957
|
-
* - Now extends ResourceDefinition (inherits: resourceId, name, description, version, type, status,
|
|
871
|
+
* - Now extends ResourceDefinition (inherits: resourceId, name, description, version, type, status, links, category)
|
|
958
872
|
* - Field renames: `id` -> `resourceId` (inherited)
|
|
959
873
|
* - New required field: `version` (inherited) - organizations must add version to all external resources
|
|
960
874
|
* - New required field: `type: 'external'` (inherited) - resource type discriminator
|
|
@@ -1048,7 +962,7 @@ export interface ExternalResourceDefinition extends ResourceDefinition {
|
|
|
1048
962
|
* Tasks with matching command_queue_group are routed to this checkpoint.
|
|
1049
963
|
*
|
|
1050
964
|
* BREAKING CHANGES (2025-11-30):
|
|
1051
|
-
* - Now extends ResourceDefinition (inherits: resourceId, name, description, version, type, status,
|
|
965
|
+
* - Now extends ResourceDefinition (inherits: resourceId, name, description, version, type, status, links, category)
|
|
1052
966
|
* - Field renames: `id` -> `resourceId` (inherited)
|
|
1053
967
|
* - description is now REQUIRED (was optional) - organizations must add description to all human checkpoints
|
|
1054
968
|
* - New required field: `version` (inherited) - organizations must add version to all human checkpoints
|
|
@@ -1,105 +1,71 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Glossary
|
|
3
|
-
description: Terminology disambiguation for Organization OS concepts used in the template scaffold,
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Glossary
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
**
|
|
17
|
-
|
|
18
|
-
**
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
**
|
|
23
|
-
|
|
24
|
-
**
|
|
25
|
-
|
|
26
|
-
**
|
|
27
|
-
|
|
28
|
-
**
|
|
29
|
-
|
|
30
|
-
**
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
**
|
|
37
|
-
|
|
38
|
-
**
|
|
39
|
-
|
|
40
|
-
**
|
|
41
|
-
|
|
42
|
-
**
|
|
43
|
-
|
|
44
|
-
**
|
|
45
|
-
|
|
46
|
-
**
|
|
47
|
-
|
|
48
|
-
**
|
|
49
|
-
|
|
50
|
-
**
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
**Settings asymmetry** -- `settings` is a valid feature ID (org-level, present in `OrganizationModel.features` with `enabled: true` by default). `MembershipFeatureConfig.features` is now `Record<string, boolean>`, so `settings` can technically be overridden per member, but the convention is still to gate settings visibility via `requiresAdmin` on the nav entry and `AdminGuard` on routes rather than per-member feature overrides.
|
|
73
|
-
|
|
74
|
-
**Subshell / Sidebar** -- the feature-scoped UI region rendered when the current route matches a manifest's `subshellRoutes`. Each `FeatureModule.sidebar` is a `ComponentType`. Consumers customize by composing the feature's published sidebar primitives (`CrmSidebar`, `CrmSidebarMiddle`, etc.) and assigning their component to `manifest.sidebar`.
|
|
75
|
-
|
|
76
|
-
**Surface** -- a navigable view in `OrganizationModel.navigation.surfaces`. Identified by a dotted `id` (e.g., `sales.pipeline`). Has `path`, `surfaceType`, optional `featureId` gate (replaces the former `featureKey` field), and cross-reference arrays (`featureIds`, `entityIds`, `resourceIds`, `capabilityIds`). Distinct from "page": a surface is the org-model declaration; a page is the React component rendered at the route.
|
|
77
|
-
|
|
78
|
-
**Topology** -- resource relationships (`triggers`, `uses`, `approval`) declared in `DeploymentSpec.relationships` and `HumanCheckpointDefinition.routesTo`. Used for Command View graph edges.
|
|
79
|
-
|
|
80
|
-
---
|
|
81
|
-
|
|
82
|
-
## Package-Boundary Cheat Sheet
|
|
83
|
-
|
|
84
|
-
**`@elevasis/core`** (published npm)
|
|
85
|
-
|
|
86
|
-
- `OrganizationModel`, `OrganizationModelFeature`, `OrganizationModelSurface`, `OrganizationModelResourceMapping`
|
|
87
|
-
- `OrganizationModelIdentity`, `OrganizationModelCustomers`, `OrganizationModelOfferings`, `OrganizationModelRoles`, `OrganizationModelGoals`
|
|
88
|
-
- `OrganizationModelStatuses`, `OrganizationModelOperations`
|
|
89
|
-
- `TechStackEntrySchema`, `OrganizationModelTechStackEntry`
|
|
90
|
-
- `resolveOrganizationModel`, `defineOrganizationModel`, `DEFAULT_ORGANIZATION_MODEL`
|
|
91
|
-
- `MembershipFeatureConfig`
|
|
92
|
-
|
|
93
|
-
**`@elevasis/ui`** (published npm)
|
|
94
|
-
|
|
95
|
-
- `FeatureModule`, `FeatureNavEntry`, `FeatureNavLink`
|
|
96
|
-
- `ResolvedFeatureModule`, `ResolvedShellNavItem`
|
|
97
|
-
- `FeatureGuard`, `AdminGuard`, `ProtectedRoute`
|
|
98
|
-
- `ElevasisFeaturesProvider`, `ElevasisCoreProvider`, `useElevasisFeatures`
|
|
99
|
-
- `createFeatureAccessHook`
|
|
100
|
-
|
|
101
|
-
**`foundations/`** (local source package -- not published)
|
|
102
|
-
|
|
103
|
-
- `canonicalOrganizationModel` -- passed to `ElevasisFeaturesProvider`
|
|
104
|
-
- `organizationModel` -- enriched shape for app-local code
|
|
105
|
-
- Workflow I/O schemas (`types/index.ts`)
|
|
1
|
+
---
|
|
2
|
+
title: Glossary
|
|
3
|
+
description: Terminology disambiguation for Organization OS concepts used in the template scaffold, core package, and published packages.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Glossary
|
|
7
|
+
|
|
8
|
+
## Terms
|
|
9
|
+
|
|
10
|
+
**AdminGuard** -- route-level admin wrapper from `@elevasis/ui/features/auth`. Must nest inside `ProtectedRoute`.
|
|
11
|
+
|
|
12
|
+
**Contract** -- the publishable boundary a consumer depends on: Zod schemas, TypeScript types, provider props, resource definitions, or workflow I/O schemas.
|
|
13
|
+
|
|
14
|
+
**DeploymentSpec** -- resource collection for one organization: workflows, agents, triggers, integrations, relationships, external resources, and human checkpoints.
|
|
15
|
+
|
|
16
|
+
**Feature** -- either a platform capability, a shell `FeatureModule`, or an Organization Model feature node. In the current shell contract, Organization Model feature nodes drive sidebar hierarchy and access state.
|
|
17
|
+
|
|
18
|
+
**FeatureGuard** -- route-level feature gate from `@elevasis/ui/features/auth`.
|
|
19
|
+
|
|
20
|
+
**FeatureModule** -- manifest contract a shell feature provides to `ElevasisFeaturesProvider`. Key fields are `key`, `featureId`, optional `capabilityIds`, optional `icon`, optional `sidebar`, and optional graph bridge metadata.
|
|
21
|
+
|
|
22
|
+
**featureId** -- the `FeatureModule` field that must match an `OrganizationModel.features[].id`.
|
|
23
|
+
|
|
24
|
+
**Foundations** -- local adapter layer in external projects that exports `canonicalOrganizationModel`, `organizationModel`, and workflow I/O schemas.
|
|
25
|
+
|
|
26
|
+
**Graph node ID** -- kind-prefixed cross-collection identifier such as `feature:sales.crm`, `integration:instantly`, or `resource:lead-import`.
|
|
27
|
+
|
|
28
|
+
**Manifest** -- a runtime declaration for a feature or resource collection.
|
|
29
|
+
|
|
30
|
+
**MembershipFeatureConfig** -- per-member feature override config: `{ features?: Record<string, boolean> }`.
|
|
31
|
+
|
|
32
|
+
**OrganizationModel** -- top-level semantic contract for an organization. Current primary fields include `features`, `branding`, `navigation`, `sales`, `prospecting`, `projects`, `identity`, `customers`, `offerings`, `roles`, `goals`, `statuses`, and `operations`.
|
|
33
|
+
|
|
34
|
+
**OrganizationModelFeature** -- feature node in `OrganizationModel.features`. Fields include `id`, `label`, `description`, `enabled`, `path`, `icon`, `color`, `uiPosition`, `requiresAdmin`, and `devOnly`.
|
|
35
|
+
|
|
36
|
+
**Provider / ElevasisFeaturesProvider** -- runtime that registers manifests, resolves feature access against the org model, and exposes shell helpers through `useElevasisFeatures()`.
|
|
37
|
+
|
|
38
|
+
**Resource** -- deployable workflow, agent, trigger, integration, external resource, or human checkpoint in a `DeploymentSpec`. Resources bind to the Organization Model graph through metadata `links` and are grouped for operations with `category`.
|
|
39
|
+
|
|
40
|
+
**ResourceCategory** -- resource metadata category: `production`, `diagnostic`, `internal`, or `testing`.
|
|
41
|
+
|
|
42
|
+
**ResourceLink** -- graph binding on resource metadata: `{ nodeId, kind }`.
|
|
43
|
+
|
|
44
|
+
**Settings asymmetry** -- settings is a feature node, but individual access is normally governed by admin checks rather than user-facing feature toggles.
|
|
45
|
+
|
|
46
|
+
**Shell model** -- provider output used by sidebars and breadcrumbs. Includes `features`, `childrenOf`, `ancestorsOf`, `parentOf`, `topLevel`, `findByPath`, `uiPositionFor`, `requiresAdminFor`, and `devOnlyFor`.
|
|
47
|
+
|
|
48
|
+
**Subshell / Sidebar** -- feature-scoped UI region rendered when the current route matches a feature whose manifest supplies a sidebar.
|
|
49
|
+
|
|
50
|
+
**Topology** -- runtime resource relationships declared in `DeploymentSpec.relationships`.
|
|
51
|
+
|
|
52
|
+
## Package Boundary
|
|
53
|
+
|
|
54
|
+
**`@elevasis/core`**
|
|
55
|
+
|
|
56
|
+
- `OrganizationModel`, `OrganizationModelFeature`
|
|
57
|
+
- `resolveOrganizationModel`, `defineOrganizationModel`, `DEFAULT_ORGANIZATION_MODEL`
|
|
58
|
+
- `MembershipFeatureConfig`
|
|
59
|
+
- `DeploymentSpec`, `ResourceLink`, `ResourceCategory`
|
|
60
|
+
|
|
61
|
+
**`@elevasis/ui`**
|
|
62
|
+
|
|
63
|
+
- `FeatureModule`
|
|
64
|
+
- `FeatureGuard`, `AdminGuard`, `ProtectedRoute`
|
|
65
|
+
- `ElevasisFeaturesProvider`, `ElevasisCoreProvider`, `useElevasisFeatures`
|
|
66
|
+
|
|
67
|
+
**External project source**
|
|
68
|
+
|
|
69
|
+
- `canonicalOrganizationModel`
|
|
70
|
+
- `organizationModel`
|
|
71
|
+
- workflow I/O schemas
|