@elevasis/sdk 1.11.0 → 1.12.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/cli.cjs +31 -8
- package/dist/index.d.ts +345 -48
- package/dist/index.js +210 -8
- package/dist/test-utils/index.d.ts +216 -40
- package/dist/test-utils/index.js +4756 -125
- package/dist/types/worker/adapters/llm.d.ts +1 -1
- package/dist/worker/index.js +10 -4
- package/package.json +2 -2
- package/reference/claude-config/rules/agent-start-here.md +14 -14
- package/reference/claude-config/skills/configure/SKILL.md +3 -3
- package/reference/claude-config/skills/setup/SKILL.md +6 -6
- package/reference/claude-config/sync-notes/2026-04-25-auth-role-system-and-settings-roles.md +55 -0
- package/reference/claude-config/sync-notes/2026-04-27-crm-hitl-action-layer-cutover.md +101 -0
- package/reference/cli.mdx +57 -0
- package/reference/examples/organization-model.ts +3 -0
- package/reference/packages/core/src/organization-model/README.md +1 -0
- package/reference/scaffold/core/organization-graph.mdx +5 -2
- package/reference/scaffold/core/organization-model.mdx +6 -0
- package/reference/scaffold/index.mdx +3 -0
- package/reference/scaffold/operations/propagation-pipeline.md +4 -1
- package/reference/scaffold/operations/scaffold-maintenance.md +3 -0
- package/reference/scaffold/operations/workflow-recipes.md +13 -10
- package/reference/scaffold/recipes/add-a-feature.md +3 -0
- package/reference/scaffold/recipes/add-a-resource.md +3 -0
- package/reference/scaffold/recipes/customize-organization-model.md +3 -0
- package/reference/scaffold/recipes/extend-a-base-entity.md +11 -8
- package/reference/scaffold/recipes/gate-by-feature-or-admin.md +3 -0
- package/reference/scaffold/recipes/index.md +3 -0
- package/reference/scaffold/reference/contracts.md +62 -304
- package/reference/scaffold/reference/feature-registry.md +5 -2
- package/reference/scaffold/reference/glossary.md +3 -0
- package/reference/scaffold/ui/composition-extensibility.mdx +3 -0
- package/reference/scaffold/ui/customization.md +3 -0
- package/reference/scaffold/ui/feature-flags-and-gating.md +3 -0
- package/reference/scaffold/ui/feature-shell.mdx +3 -0
- package/reference/scaffold/ui/recipes.md +3 -0
- package/reference/claude-config/logs/pre-edit-vibe-gate.log +0 -40
- package/reference/claude-config/logs/scaffold-registry-reminder.log +0 -38
|
@@ -1,3 +1,6 @@
|
|
|
1
|
+
<!-- @generated by packages/sdk/scripts/copy-reference-docs.mjs -- DO NOT EDIT -->
|
|
2
|
+
<!-- Regenerate: pnpm scaffold:sync -->
|
|
3
|
+
|
|
1
4
|
<!-- @generated by scripts/monorepo/generate-scaffold-contracts.js — DO NOT EDIT -->
|
|
2
5
|
<!-- Regenerate: pnpm scaffold:sync -->
|
|
3
6
|
---
|
|
@@ -180,7 +183,8 @@ export type OrganizationModelKeyResult = z.infer<typeof KeyResultSchema>
|
|
|
180
183
|
### `DeepPartial`
|
|
181
184
|
|
|
182
185
|
```typescript
|
|
183
|
-
export type DeepPartial<T> =
|
|
186
|
+
export type DeepPartial<T> =
|
|
187
|
+
T extends Array<infer U> ? Array<DeepPartial<U>> : T extends object ? { [K in keyof T]?: DeepPartial<T[K]> } : T
|
|
184
188
|
```
|
|
185
189
|
|
|
186
190
|
## Feature System
|
|
@@ -189,13 +193,18 @@ export type DeepPartial<T> = T extends Array<infer U> ? Array<DeepPartial<U>> :
|
|
|
189
193
|
|
|
190
194
|
```typescript
|
|
191
195
|
export type FeatureSidebarComponent = ComponentType
|
|
192
|
-
export type FeatureIconComponent = ComponentType<{ size?: number;
|
|
193
196
|
```
|
|
194
197
|
|
|
195
198
|
### `FeatureIconComponent`
|
|
196
199
|
|
|
197
200
|
```typescript
|
|
198
|
-
export type FeatureIconComponent = ComponentType<{ size?: number;
|
|
201
|
+
export type FeatureIconComponent = ComponentType<{ size?: number; stroke?: number }>
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
### `FeatureSidebarWidthResolver`
|
|
205
|
+
|
|
206
|
+
```typescript
|
|
207
|
+
export type FeatureSidebarWidthResolver = number | ((context: { currentPath: string }) => number)
|
|
199
208
|
```
|
|
200
209
|
|
|
201
210
|
### `FeatureModule`
|
|
@@ -212,6 +221,8 @@ export interface FeatureModule {
|
|
|
212
221
|
icon?: FeatureIconComponent
|
|
213
222
|
/** Sidebar component rendered when this feature's subtree route is active. */
|
|
214
223
|
sidebar?: FeatureSidebarComponent
|
|
224
|
+
/** Optional shell sidebar width override. Defaults to 250px. */
|
|
225
|
+
sidebarWidth?: FeatureSidebarWidthResolver
|
|
215
226
|
/** Operations-only bridge connecting this feature to the organization graph node. */
|
|
216
227
|
organizationGraph?: OrganizationGraphFeatureBridge
|
|
217
228
|
}
|
|
@@ -353,26 +364,10 @@ export interface ElevasisFeaturesContextValue {
|
|
|
353
364
|
### `ResourceStatus`
|
|
354
365
|
|
|
355
366
|
```typescript
|
|
356
|
-
/**
|
|
357
|
-
* Resource Registry type definitions
|
|
358
|
-
*/
|
|
359
|
-
|
|
360
|
-
import type { IntegrationType } from '../../execution/engine/tools/integration'
|
|
361
|
-
import type { ResourceCategory, ResourceLink } from './resource-link'
|
|
362
|
-
|
|
363
|
-
// ============================================================================
|
|
364
|
-
// Core Resource Type Definitions
|
|
365
|
-
// ============================================================================
|
|
366
|
-
|
|
367
367
|
/**
|
|
368
368
|
* Environment/deployment status for resources
|
|
369
|
-
*/
|
|
370
|
-
export type ResourceStatus = 'dev' | 'prod'
|
|
371
|
-
|
|
372
|
-
/**
|
|
373
|
-
* All resource types in the platform
|
|
374
|
-
* Used as the discriminator field in ResourceDefinition
|
|
375
|
-
*/
|
|
369
|
+
*/
|
|
370
|
+
export type ResourceStatus = 'dev' | 'prod'
|
|
376
371
|
```
|
|
377
372
|
|
|
378
373
|
### `ResourceType`
|
|
@@ -381,13 +376,8 @@ export type ResourceStatus = 'dev' | 'prod'
|
|
|
381
376
|
/**
|
|
382
377
|
* All resource types in the platform
|
|
383
378
|
* Used as the discriminator field in ResourceDefinition
|
|
384
|
-
*/
|
|
385
|
-
export type ResourceType = 'agent' | 'workflow' | 'trigger' | 'integration' | 'external' | 'human'
|
|
386
|
-
|
|
387
|
-
/**
|
|
388
|
-
* Executable resource types (subset of ResourceType)
|
|
389
|
-
* These resources can be directly executed by the execution engine
|
|
390
|
-
*/
|
|
379
|
+
*/
|
|
380
|
+
export type ResourceType = 'agent' | 'workflow' | 'trigger' | 'integration' | 'external' | 'human'
|
|
391
381
|
```
|
|
392
382
|
|
|
393
383
|
### `ExecutableResourceType`
|
|
@@ -396,17 +386,8 @@ export type ResourceType = 'agent' | 'workflow' | 'trigger' | 'integration' | 'e
|
|
|
396
386
|
/**
|
|
397
387
|
* Executable resource types (subset of ResourceType)
|
|
398
388
|
* These resources can be directly executed by the execution engine
|
|
399
|
-
*/
|
|
400
|
-
export type ExecutableResourceType = 'workflow' | 'agent'
|
|
401
|
-
|
|
402
|
-
// ============================================================================
|
|
403
|
-
// Base Resource Interface
|
|
404
|
-
// ============================================================================
|
|
405
|
-
|
|
406
|
-
/**
|
|
407
|
-
* Base interface for ALL platform resources
|
|
408
|
-
* Shared by both executable (agents, workflows) and non-executable (triggers, integrations, etc.) resources
|
|
409
|
-
*/
|
|
389
|
+
*/
|
|
390
|
+
export type ExecutableResourceType = 'workflow' | 'agent'
|
|
410
391
|
```
|
|
411
392
|
|
|
412
393
|
### `ResourceDefinition`
|
|
@@ -415,7 +396,7 @@ export type ExecutableResourceType = 'workflow' | 'agent'
|
|
|
415
396
|
/**
|
|
416
397
|
* Base interface for ALL platform resources
|
|
417
398
|
* Shared by both executable (agents, workflows) and non-executable (triggers, integrations, etc.) resources
|
|
418
|
-
*/
|
|
399
|
+
*/
|
|
419
400
|
export interface ResourceDefinition {
|
|
420
401
|
/** Unique resource identifier */
|
|
421
402
|
resourceId: string
|
|
@@ -455,44 +436,10 @@ export interface ResourceDefinition {
|
|
|
455
436
|
### `ResourceList`
|
|
456
437
|
|
|
457
438
|
```typescript
|
|
458
|
-
/** Unique resource identifier */
|
|
459
|
-
resourceId: string
|
|
460
|
-
|
|
461
|
-
/** Display name */
|
|
462
|
-
name: string
|
|
463
|
-
|
|
464
|
-
/** Purpose and functionality description */
|
|
465
|
-
description: string
|
|
466
|
-
|
|
467
|
-
/** Version for change tracking and evolution */
|
|
468
|
-
version: string
|
|
469
|
-
|
|
470
|
-
/** Resource type discriminator */
|
|
471
|
-
type: ResourceType
|
|
472
|
-
|
|
473
|
-
/** Environment/deployment status */
|
|
474
|
-
status: ResourceStatus
|
|
475
|
-
|
|
476
|
-
/** Graph links to Organization Model nodes */
|
|
477
|
-
links?: ResourceLink[]
|
|
478
|
-
|
|
479
|
-
/** Infrastructure category for filtering */
|
|
480
|
-
category?: ResourceCategory
|
|
481
|
-
|
|
482
|
-
/** Whether the agent supports multi-turn sessions (agents only) */
|
|
483
|
-
sessionCapable?: boolean
|
|
484
|
-
|
|
485
|
-
/** Whether the resource is local (monorepo) or remote (externally deployed) */
|
|
486
|
-
origin?: 'local' | 'remote'
|
|
487
|
-
|
|
488
|
-
/** Whether this resource is archived and should be excluded from registration and deployment */
|
|
489
|
-
archived?: boolean
|
|
490
|
-
}
|
|
491
|
-
|
|
492
439
|
/**
|
|
493
440
|
* Resource list for organization
|
|
494
441
|
* Returns ResourceDefinition metadata (not full definitions)
|
|
495
|
-
*/
|
|
442
|
+
*/
|
|
496
443
|
export interface ResourceList {
|
|
497
444
|
workflows: ResourceDefinition[]
|
|
498
445
|
agents: ResourceDefinition[]
|
|
@@ -505,16 +452,14 @@ export interface ResourceList {
|
|
|
505
452
|
### `WebhookProviderType`
|
|
506
453
|
|
|
507
454
|
```typescript
|
|
508
|
-
/** Webhook provider identifiers */
|
|
509
|
-
export type WebhookProviderType = 'cal-com' | 'stripe' | 'signature-api' | 'instantly' | 'apify' | 'test'
|
|
510
|
-
|
|
511
|
-
/** Webhook trigger configuration */
|
|
455
|
+
/** Webhook provider identifiers */
|
|
456
|
+
export type WebhookProviderType = 'cal-com' | 'stripe' | 'signature-api' | 'instantly' | 'apify' | 'test'
|
|
512
457
|
```
|
|
513
458
|
|
|
514
459
|
### `WebhookTriggerConfig`
|
|
515
460
|
|
|
516
461
|
```typescript
|
|
517
|
-
/** Webhook trigger configuration */
|
|
462
|
+
/** Webhook trigger configuration */
|
|
518
463
|
export interface WebhookTriggerConfig {
|
|
519
464
|
/** Provider identifier */
|
|
520
465
|
provider: WebhookProviderType
|
|
@@ -530,17 +475,7 @@ export interface WebhookTriggerConfig {
|
|
|
530
475
|
### `ScheduleTriggerConfig`
|
|
531
476
|
|
|
532
477
|
```typescript
|
|
533
|
-
/**
|
|
534
|
-
provider: WebhookProviderType
|
|
535
|
-
/** Event type for documentation (not used for matching - workflow handles routing) */
|
|
536
|
-
event?: string
|
|
537
|
-
/** Optional filtering (e.g., specific form ID for Fillout) */
|
|
538
|
-
filter?: Record<string, string>
|
|
539
|
-
/** References credential in credentials table for per-org webhook secrets */
|
|
540
|
-
credentialName?: string
|
|
541
|
-
}
|
|
542
|
-
|
|
543
|
-
/** Schedule trigger configuration */
|
|
478
|
+
/** Schedule trigger configuration */
|
|
544
479
|
export interface ScheduleTriggerConfig {
|
|
545
480
|
/** Cron expression (e.g., '0 6 * * *') */
|
|
546
481
|
cron: string
|
|
@@ -552,13 +487,7 @@ export interface ScheduleTriggerConfig {
|
|
|
552
487
|
### `EventTriggerConfig`
|
|
553
488
|
|
|
554
489
|
```typescript
|
|
555
|
-
/**
|
|
556
|
-
cron: string
|
|
557
|
-
/** Optional timezone (default: UTC) */
|
|
558
|
-
timezone?: string
|
|
559
|
-
}
|
|
560
|
-
|
|
561
|
-
/** Event trigger configuration */
|
|
490
|
+
/** Event trigger configuration */
|
|
562
491
|
export interface EventTriggerConfig {
|
|
563
492
|
/** Internal event type */
|
|
564
493
|
eventType: string
|
|
@@ -570,50 +499,8 @@ export interface EventTriggerConfig {
|
|
|
570
499
|
### `TriggerConfig`
|
|
571
500
|
|
|
572
501
|
```typescript
|
|
573
|
-
/**
|
|
574
|
-
|
|
575
|
-
/** Event source */
|
|
576
|
-
source?: string
|
|
577
|
-
}
|
|
578
|
-
|
|
579
|
-
/** Union of all trigger configs */
|
|
580
|
-
export type TriggerConfig = WebhookTriggerConfig | ScheduleTriggerConfig | EventTriggerConfig
|
|
581
|
-
|
|
582
|
-
// ============================================================================
|
|
583
|
-
// Trigger Definition
|
|
584
|
-
// ============================================================================
|
|
585
|
-
|
|
586
|
-
/**
|
|
587
|
-
* Trigger metadata - entry points that initiate resource execution
|
|
588
|
-
*
|
|
589
|
-
* Triggers represent how executions start: webhooks from external services,
|
|
590
|
-
* scheduled cron jobs, platform events, or manual user actions.
|
|
591
|
-
*
|
|
592
|
-
* BREAKING CHANGES (2025-11-30):
|
|
593
|
-
* - Now extends ResourceDefinition (inherits: resourceId, name, description, version, type, status, links, category)
|
|
594
|
-
* - Field renames: `id` -> `resourceId` (inherited), `type` -> `triggerType`
|
|
595
|
-
* - Relationship rename: `invokes` -> `triggers` (unified vocabulary)
|
|
596
|
-
* - New required fields: `version` (inherited), `type: 'trigger'` (inherited)
|
|
597
|
-
* - triggers object now includes `externalResources` option
|
|
598
|
-
*
|
|
599
|
-
* @example
|
|
600
|
-
* // TriggerDefinition - metadata only
|
|
601
|
-
* {
|
|
602
|
-
* resourceId: 'trigger-new-order',
|
|
603
|
-
* type: 'trigger',
|
|
604
|
-
* triggerType: 'webhook',
|
|
605
|
-
* name: 'New Order',
|
|
606
|
-
* description: 'Webhook from Shopify on new orders',
|
|
607
|
-
* version: '1.0.0',
|
|
608
|
-
* status: 'prod',
|
|
609
|
-
* webhookPath: '/webhooks/shopify/orders'
|
|
610
|
-
* }
|
|
611
|
-
*
|
|
612
|
-
* // Relationships declared in ResourceRelationships (not on TriggerDefinition):
|
|
613
|
-
* // relationships: {
|
|
614
|
-
* // 'trigger-new-order': { triggers: { workflows: ['order-fulfillment-workflow'] } }
|
|
615
|
-
* // }
|
|
616
|
-
*/
|
|
502
|
+
/** Union of all trigger configs */
|
|
503
|
+
export type TriggerConfig = WebhookTriggerConfig | ScheduleTriggerConfig | EventTriggerConfig
|
|
617
504
|
```
|
|
618
505
|
|
|
619
506
|
### `TriggerDefinition`
|
|
@@ -649,7 +536,7 @@ export type TriggerConfig = WebhookTriggerConfig | ScheduleTriggerConfig | Event
|
|
|
649
536
|
* // relationships: {
|
|
650
537
|
* // 'trigger-new-order': { triggers: { workflows: ['order-fulfillment-workflow'] } }
|
|
651
538
|
* // }
|
|
652
|
-
*/
|
|
539
|
+
*/
|
|
653
540
|
export interface TriggerDefinition extends ResourceDefinition {
|
|
654
541
|
/** Resource type discriminator (narrowed from base union) */
|
|
655
542
|
type: 'trigger'
|
|
@@ -676,27 +563,6 @@ export interface TriggerDefinition extends ResourceDefinition {
|
|
|
676
563
|
### `IntegrationDefinition`
|
|
677
564
|
|
|
678
565
|
```typescript
|
|
679
|
-
/** Resource type discriminator (narrowed from base union) */
|
|
680
|
-
type: 'trigger'
|
|
681
|
-
|
|
682
|
-
/** Trigger mechanism type (renamed from 'type' to avoid collision with base type discriminator) */
|
|
683
|
-
triggerType: 'webhook' | 'schedule' | 'manual' | 'event'
|
|
684
|
-
|
|
685
|
-
/** Type-specific configuration */
|
|
686
|
-
config?: TriggerConfig
|
|
687
|
-
|
|
688
|
-
// Legacy fields (deprecated, use config instead)
|
|
689
|
-
/** For webhook triggers: path like '/webhooks/shopify/orders' */
|
|
690
|
-
webhookPath?: string
|
|
691
|
-
/** For schedule triggers: cron expression like '0 6 * * *' */
|
|
692
|
-
schedule?: string
|
|
693
|
-
/** For event triggers: event type like 'low-stock-alert' */
|
|
694
|
-
eventType?: string
|
|
695
|
-
|
|
696
|
-
// NOTE: What this trigger starts is declared in ResourceRelationships, not here
|
|
697
|
-
// This prevents duplication - triggers are forward-declared in relationships
|
|
698
|
-
}
|
|
699
|
-
|
|
700
566
|
/**
|
|
701
567
|
* Integration metadata - external service connections
|
|
702
568
|
*
|
|
@@ -721,7 +587,7 @@ export interface TriggerDefinition extends ResourceDefinition {
|
|
|
721
587
|
* version: '1.0.0',
|
|
722
588
|
* status: 'prod'
|
|
723
589
|
* }
|
|
724
|
-
*/
|
|
590
|
+
*/
|
|
725
591
|
export interface IntegrationDefinition extends ResourceDefinition {
|
|
726
592
|
/** Resource type discriminator (narrowed from base union) */
|
|
727
593
|
type: 'integration'
|
|
@@ -736,15 +602,6 @@ export interface IntegrationDefinition extends ResourceDefinition {
|
|
|
736
602
|
### `RelationshipDeclaration`
|
|
737
603
|
|
|
738
604
|
```typescript
|
|
739
|
-
/** Resource type discriminator (narrowed from base union) */
|
|
740
|
-
type: 'integration'
|
|
741
|
-
|
|
742
|
-
/** Integration provider type */
|
|
743
|
-
provider: IntegrationType
|
|
744
|
-
/** References credentials table (e.g., 'shopify-prod', 'zendesk-api') */
|
|
745
|
-
credentialName: string
|
|
746
|
-
}
|
|
747
|
-
|
|
748
605
|
/**
|
|
749
606
|
* Explicit resource relationship declaration
|
|
750
607
|
*
|
|
@@ -756,7 +613,7 @@ export interface IntegrationDefinition extends ResourceDefinition {
|
|
|
756
613
|
* triggers: { workflows: ['order-fulfillment-workflow'] },
|
|
757
614
|
* uses: { integrations: ['integration-shopify-prod', 'integration-postgres'] }
|
|
758
615
|
* }
|
|
759
|
-
*/
|
|
616
|
+
*/
|
|
760
617
|
export interface RelationshipDeclaration {
|
|
761
618
|
/** Resources this resource triggers */
|
|
762
619
|
triggers?: {
|
|
@@ -776,20 +633,6 @@ export interface RelationshipDeclaration {
|
|
|
776
633
|
### `ResourceRelationships`
|
|
777
634
|
|
|
778
635
|
```typescript
|
|
779
|
-
/** Resources this resource triggers */
|
|
780
|
-
triggers?: {
|
|
781
|
-
/** Agent resourceIds this resource triggers */
|
|
782
|
-
agents?: string[]
|
|
783
|
-
/** Workflow resourceIds this resource triggers */
|
|
784
|
-
workflows?: string[]
|
|
785
|
-
}
|
|
786
|
-
/** Integrations this resource uses */
|
|
787
|
-
uses?: {
|
|
788
|
-
/** Integration IDs this resource uses */
|
|
789
|
-
integrations?: string[]
|
|
790
|
-
}
|
|
791
|
-
}
|
|
792
|
-
|
|
793
636
|
/**
|
|
794
637
|
* Resource relationships map
|
|
795
638
|
* Maps resourceId to its relationship declarations
|
|
@@ -801,17 +644,8 @@ export interface RelationshipDeclaration {
|
|
|
801
644
|
* uses: { integrations: ['integration-shopify-prod'] }
|
|
802
645
|
* }
|
|
803
646
|
* }
|
|
804
|
-
*/
|
|
805
|
-
export type ResourceRelationships = Record<string, RelationshipDeclaration>
|
|
806
|
-
|
|
807
|
-
// ============================================================================
|
|
808
|
-
// External Resource Types
|
|
809
|
-
// ============================================================================
|
|
810
|
-
|
|
811
|
-
/**
|
|
812
|
-
* External platform type
|
|
813
|
-
* Supported third-party automation platforms
|
|
814
|
-
*/
|
|
647
|
+
*/
|
|
648
|
+
export type ResourceRelationships = Record<string, RelationshipDeclaration>
|
|
815
649
|
```
|
|
816
650
|
|
|
817
651
|
### `ExternalPlatform`
|
|
@@ -820,39 +654,8 @@ export type ResourceRelationships = Record<string, RelationshipDeclaration>
|
|
|
820
654
|
/**
|
|
821
655
|
* External platform type
|
|
822
656
|
* Supported third-party automation platforms
|
|
823
|
-
*/
|
|
824
|
-
export type ExternalPlatform = 'n8n' | 'make' | 'zapier' | 'other'
|
|
825
|
-
|
|
826
|
-
/**
|
|
827
|
-
* External automation resource metadata
|
|
828
|
-
*
|
|
829
|
-
* Represents workflows/automations running on third-party platforms
|
|
830
|
-
* (n8n, Make, Zapier, etc.) for visualization in Command View.
|
|
831
|
-
*
|
|
832
|
-
* NOTE: This is metadata ONLY for visualization. No execution logic,
|
|
833
|
-
* no API integration with external platforms, no status syncing.
|
|
834
|
-
*
|
|
835
|
-
* BREAKING CHANGES (2025-11-30):
|
|
836
|
-
* - Now extends ResourceDefinition (inherits: resourceId, name, description, version, type, status, links, category)
|
|
837
|
-
* - Field renames: `id` -> `resourceId` (inherited)
|
|
838
|
-
* - New required field: `version` (inherited) - organizations must add version to all external resources
|
|
839
|
-
* - New required field: `type: 'external'` (inherited) - resource type discriminator
|
|
840
|
-
* - REMOVED FIELD: `triggeredBy` - per relationship-consolidation design, all relationships are forward-only declarations
|
|
841
|
-
*
|
|
842
|
-
* @example
|
|
843
|
-
* {
|
|
844
|
-
* resourceId: 'external-n8n-order-sync',
|
|
845
|
-
* type: 'external',
|
|
846
|
-
* version: '1.0.0',
|
|
847
|
-
* platform: 'n8n',
|
|
848
|
-
* name: 'Shopify Order Sync',
|
|
849
|
-
* description: 'Legacy n8n workflow for syncing Shopify orders',
|
|
850
|
-
* status: 'prod',
|
|
851
|
-
* platformUrl: 'https://n8n.client.com/workflow/123',
|
|
852
|
-
* triggers: { workflows: ['order-fulfillment-workflow'] },
|
|
853
|
-
* uses: { integrations: ['integration-shopify-prod'] }
|
|
854
|
-
* }
|
|
855
|
-
*/
|
|
657
|
+
*/
|
|
658
|
+
export type ExternalPlatform = 'n8n' | 'make' | 'zapier' | 'other'
|
|
856
659
|
```
|
|
857
660
|
|
|
858
661
|
### `ExternalResourceDefinition`
|
|
@@ -887,7 +690,7 @@ export type ExternalPlatform = 'n8n' | 'make' | 'zapier' | 'other'
|
|
|
887
690
|
* triggers: { workflows: ['order-fulfillment-workflow'] },
|
|
888
691
|
* uses: { integrations: ['integration-shopify-prod'] }
|
|
889
692
|
* }
|
|
890
|
-
*/
|
|
693
|
+
*/
|
|
891
694
|
export interface ExternalResourceDefinition extends ResourceDefinition {
|
|
892
695
|
/** Resource type discriminator (narrowed from base union) */
|
|
893
696
|
type: 'external'
|
|
@@ -924,37 +727,6 @@ export interface ExternalResourceDefinition extends ResourceDefinition {
|
|
|
924
727
|
### `HumanCheckpointDefinition`
|
|
925
728
|
|
|
926
729
|
```typescript
|
|
927
|
-
/** Resource type discriminator (narrowed from base union) */
|
|
928
|
-
type: 'external'
|
|
929
|
-
|
|
930
|
-
/** Platform type */
|
|
931
|
-
platform: ExternalPlatform
|
|
932
|
-
|
|
933
|
-
// Optional platform-specific metadata
|
|
934
|
-
/** Link to external platform (e.g., n8n workflow editor URL) */
|
|
935
|
-
platformUrl?: string
|
|
936
|
-
/** Platform's internal ID/reference */
|
|
937
|
-
externalId?: string
|
|
938
|
-
|
|
939
|
-
/** What this external resource triggers (external -> internal) */
|
|
940
|
-
triggers?: {
|
|
941
|
-
/** Elevasis workflow resourceIds this external automation triggers */
|
|
942
|
-
workflows?: string[]
|
|
943
|
-
/** Elevasis agent resourceIds this external automation triggers */
|
|
944
|
-
agents?: string[]
|
|
945
|
-
}
|
|
946
|
-
|
|
947
|
-
/** Integrations this external resource uses (shared credentials) */
|
|
948
|
-
uses?: {
|
|
949
|
-
/** Integration IDs this external automation uses */
|
|
950
|
-
integrations?: string[]
|
|
951
|
-
}
|
|
952
|
-
|
|
953
|
-
// NOTE: triggeredBy field removed - per relationship-consolidation design,
|
|
954
|
-
// all relationships are forward-only declarations. Graph edges are built
|
|
955
|
-
// from forward declarations only.
|
|
956
|
-
}
|
|
957
|
-
|
|
958
730
|
/**
|
|
959
731
|
* Human Checkpoint definition - human decision points in automation
|
|
960
732
|
*
|
|
@@ -979,7 +751,7 @@ export interface ExternalResourceDefinition extends ResourceDefinition {
|
|
|
979
751
|
* requestedBy: { agents: ['order-processor-agent'] },
|
|
980
752
|
* routesTo: { agents: ['order-fulfillment-agent'] }
|
|
981
753
|
* }
|
|
982
|
-
*/
|
|
754
|
+
*/
|
|
983
755
|
export interface HumanCheckpointDefinition extends ResourceDefinition {
|
|
984
756
|
/** Resource type discriminator (narrowed from base union) */
|
|
985
757
|
type: 'human'
|
|
@@ -1007,44 +779,30 @@ export interface HumanCheckpointDefinition extends ResourceDefinition {
|
|
|
1007
779
|
### `DeploymentSpec`
|
|
1008
780
|
|
|
1009
781
|
```typescript
|
|
1010
|
-
/**
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
cachedTempPath?: string
|
|
1016
|
-
/** Platform tool name -> credential name mapping */
|
|
1017
|
-
toolCredentials?: Record<string, string>
|
|
1018
|
-
/** SDK version used to deploy this bundle */
|
|
1019
|
-
sdkVersion?: string
|
|
1020
|
-
/** Deployment version (semver) of the deployed bundle */
|
|
1021
|
-
deploymentVersion?: string
|
|
1022
|
-
}
|
|
1023
|
-
|
|
1024
|
-
/**
|
|
1025
|
-
* Organization-specific resource collection
|
|
1026
|
-
*
|
|
1027
|
-
* Complete manifest of all automation resources for an organization.
|
|
1028
|
-
* Used by ResourceRegistry for discovery and Command View for visualization.
|
|
782
|
+
/**
|
|
783
|
+
* Organization-specific resource collection
|
|
784
|
+
*
|
|
785
|
+
* Complete manifest of all automation resources for an organization.
|
|
786
|
+
* Used by ResourceRegistry for discovery and Command View for visualization.
|
|
1029
787
|
*/
|
|
1030
|
-
export interface DeploymentSpec {
|
|
1031
|
-
/** Deployment version (semver) */
|
|
1032
|
-
version: string
|
|
1033
|
-
/** Workflow definitions */
|
|
1034
|
-
workflows?: WorkflowDefinition[]
|
|
1035
|
-
/** Agent definitions */
|
|
1036
|
-
agents?: AgentDefinition[]
|
|
1037
|
-
|
|
1038
|
-
// Resource Manifest fields (optional for backwards compatibility)
|
|
1039
|
-
/** Trigger definitions - entry points that initiate executions */
|
|
1040
|
-
triggers?: TriggerDefinition[]
|
|
1041
|
-
/** Integration definitions - external service connections */
|
|
1042
|
-
integrations?: IntegrationDefinition[]
|
|
1043
|
-
/** Explicit relationship declarations between resources */
|
|
1044
|
-
relationships?: ResourceRelationships
|
|
1045
|
-
/** External automation resources (n8n, Make, Zapier, etc.) */
|
|
1046
|
-
externalResources?: ExternalResourceDefinition[]
|
|
1047
|
-
/** Human checkpoint definitions - human decision points in automation */
|
|
1048
|
-
humanCheckpoints?: HumanCheckpointDefinition[]
|
|
788
|
+
export interface DeploymentSpec {
|
|
789
|
+
/** Deployment version (semver) */
|
|
790
|
+
version: string
|
|
791
|
+
/** Workflow definitions */
|
|
792
|
+
workflows?: WorkflowDefinition[]
|
|
793
|
+
/** Agent definitions */
|
|
794
|
+
agents?: AgentDefinition[]
|
|
795
|
+
|
|
796
|
+
// Resource Manifest fields (optional for backwards compatibility)
|
|
797
|
+
/** Trigger definitions - entry points that initiate executions */
|
|
798
|
+
triggers?: TriggerDefinition[]
|
|
799
|
+
/** Integration definitions - external service connections */
|
|
800
|
+
integrations?: IntegrationDefinition[]
|
|
801
|
+
/** Explicit relationship declarations between resources */
|
|
802
|
+
relationships?: ResourceRelationships
|
|
803
|
+
/** External automation resources (n8n, Make, Zapier, etc.) */
|
|
804
|
+
externalResources?: ExternalResourceDefinition[]
|
|
805
|
+
/** Human checkpoint definitions - human decision points in automation */
|
|
806
|
+
humanCheckpoints?: HumanCheckpointDefinition[]
|
|
1049
807
|
}
|
|
1050
808
|
```
|
|
@@ -1,3 +1,6 @@
|
|
|
1
|
+
<!-- @generated by packages/sdk/scripts/copy-reference-docs.mjs -- DO NOT EDIT -->
|
|
2
|
+
<!-- Regenerate: pnpm scaffold:sync -->
|
|
3
|
+
|
|
1
4
|
<!-- @generated by scripts/monorepo/generate-scaffold-feature-registry.js — DO NOT EDIT -->
|
|
2
5
|
<!-- Regenerate: pnpm scaffold:sync -->
|
|
3
6
|
---
|
|
@@ -12,7 +15,7 @@ description: Auto-generated catalog of registered feature manifests. Do not edit
|
|
|
12
15
|
| Feature Key | Feature ID | Nav Label | Domains | Routes |
|
|
13
16
|
| --- | --- | --- | --- | --- |
|
|
14
17
|
| `crm` | `sales.crm` | — | — | — |
|
|
15
|
-
| `delivery` |
|
|
18
|
+
| `delivery` | `projects` | — | — | — |
|
|
16
19
|
| `lead-gen` | `sales.lead-gen` | — | — | — |
|
|
17
20
|
| `monitoring` | `monitoring` | — | — | — |
|
|
18
21
|
| `operations` | `operations` | — | — | — |
|
|
@@ -27,7 +30,7 @@ Feature IDs defined in `DEFAULT_ORGANIZATION_MODEL.features` (`packages/core/src
|
|
|
27
30
|
|
|
28
31
|
```typescript
|
|
29
32
|
// FeatureSchema: { id, label, enabled, color?, icon?, entityIds, surfaceIds, resourceIds, capabilityIds }
|
|
30
|
-
type DefaultFeatureId = 'dashboard' | 'sales' | 'sales.crm' | 'sales.lead-gen' | 'projects' | 'operations' | 'operations.
|
|
33
|
+
type DefaultFeatureId = 'dashboard' | 'sales' | 'sales.crm' | 'sales.lead-gen' | 'projects' | 'operations' | 'operations.command-view' | 'operations.overview' | 'operations.resources' | 'operations.command-queue' | 'operations.sessions' | 'operations.task-scheduler' | 'monitoring' | 'monitoring.activity-log' | 'monitoring.execution-logs' | 'monitoring.execution-health' | 'monitoring.cost-analytics' | 'monitoring.notifications' | 'monitoring.submitted-requests' | 'settings' | 'settings.account' | 'settings.appearance' | 'settings.roles' | 'settings.organization' | 'settings.credentials' | 'settings.api-keys' | 'settings.webhooks' | 'settings.deployments' | 'admin' | 'admin.system-health' | 'admin.organizations' | 'admin.users' | 'admin.design-showcase' | 'admin.debug' | 'archive' | 'archive.agent-chat' | 'archive.execution-runner' | 'seo'
|
|
31
34
|
```
|
|
32
35
|
|
|
33
36
|
These are the built-in feature IDs. The `featureId` field on a `FeatureModule` manifest must match the `id` of a feature in the organization model to enable access-flag gating.
|
|
@@ -2,6 +2,9 @@
|
|
|
2
2
|
title: Glossary
|
|
3
3
|
description: Terminology disambiguation for Organization OS concepts used in the template scaffold, core package, and published packages.
|
|
4
4
|
---
|
|
5
|
+
<!-- @generated by packages/sdk/scripts/copy-reference-docs.mjs -- DO NOT EDIT -->
|
|
6
|
+
<!-- Regenerate: pnpm scaffold:sync -->
|
|
7
|
+
|
|
5
8
|
|
|
6
9
|
# Glossary
|
|
7
10
|
|
|
@@ -2,6 +2,9 @@
|
|
|
2
2
|
title: Composition & Extensibility
|
|
3
3
|
description: Organization OS Toolkit layer guidance for customizing shared shell features without forking, including exported nav arrays, optional sidebar props, composable layout primitives, and the manifest.sidebar override pattern.
|
|
4
4
|
---
|
|
5
|
+
<!-- @generated by packages/sdk/scripts/copy-reference-docs.mjs -- DO NOT EDIT -->
|
|
6
|
+
<!-- Regenerate: pnpm scaffold:sync -->
|
|
7
|
+
|
|
5
8
|
|
|
6
9
|
## Overview
|
|
7
10
|
|
|
@@ -2,6 +2,9 @@
|
|
|
2
2
|
title: Customizing Features
|
|
3
3
|
description: One pattern for customizing feature sidebars and pages -- set manifest.sidebar to a component composing the feature's published pieces. Decision tree + three worked examples.
|
|
4
4
|
---
|
|
5
|
+
<!-- @generated by packages/sdk/scripts/copy-reference-docs.mjs -- DO NOT EDIT -->
|
|
6
|
+
<!-- Regenerate: pnpm scaffold:sync -->
|
|
7
|
+
|
|
5
8
|
|
|
6
9
|
# Customizing Features
|
|
7
10
|
|
|
@@ -2,6 +2,9 @@
|
|
|
2
2
|
title: Feature Shell & Provider Runtime
|
|
3
3
|
description: Current feature shell contract for flat Organization Model features, manifests, route matching, sidebars, and breadcrumbs.
|
|
4
4
|
---
|
|
5
|
+
<!-- @generated by packages/sdk/scripts/copy-reference-docs.mjs -- DO NOT EDIT -->
|
|
6
|
+
<!-- Regenerate: pnpm scaffold:sync -->
|
|
7
|
+
|
|
5
8
|
|
|
6
9
|
## Overview
|
|
7
10
|
|
|
@@ -2,6 +2,9 @@
|
|
|
2
2
|
title: UI Recipes
|
|
3
3
|
description: Current recipes for adding pages, feature-gated routes, feature components, theme tokens, Organization Model sidebar entries, and executable resources.
|
|
4
4
|
---
|
|
5
|
+
<!-- @generated by packages/sdk/scripts/copy-reference-docs.mjs -- DO NOT EDIT -->
|
|
6
|
+
<!-- Regenerate: pnpm scaffold:sync -->
|
|
7
|
+
|
|
5
8
|
|
|
6
9
|
# UI Recipes
|
|
7
10
|
|