@elevasis/sdk 1.14.1 → 1.15.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.
@@ -1,70 +1,70 @@
1
- ---
2
- title: Scaffold Reference
3
- description: Universal scaffold documentation for Elevasis SDK projects -- recipes, patterns, architecture, and reference materials that apply to all workspaces.
4
- ---
1
+ ---
2
+ title: Scaffold Reference
3
+ description: Universal scaffold documentation for Elevasis SDK projects -- recipes, patterns, architecture, and reference materials that apply to all workspaces.
4
+ ---
5
5
  <!-- @generated by packages/sdk/scripts/copy-reference-docs.mjs -- DO NOT EDIT -->
6
6
  <!-- Regenerate: pnpm scaffold:sync -->
7
7
 
8
-
9
- ## Overview
10
-
11
- This scaffold reference contains universal documentation that applies to all Elevasis SDK projects. Content is organized by package ownership:
12
-
13
- - **recipes/** -- Cross-package pathway recipes (add a feature, add a resource, gating patterns)
14
- - **ui/** -- UI patterns, feature shell architecture, composition, and customization
15
- - **core/** -- Organization model architecture, graph layer, and semantic contracts
16
- - **operations/** -- Workflow authoring patterns and adapter usage
17
- - **reference/** -- Glossary, auto-generated contracts, and feature registry
18
-
19
- ## Quick Navigation
20
-
21
- ### Pathway Recipes
22
-
23
- - [Add a Feature](./recipes/add-a-feature.md) -- end-to-end from org model key through manifest, routes, gating
24
- - [Add a Resource](./recipes/add-a-resource.md) -- author and deploy a workflow or agent
25
- - [Extend a Base Entity](./recipes/extend-a-base-entity.md) -- add project-specific metadata to canonical entity shapes via the TMeta slot
26
- - [Gate by Feature or Admin](./recipes/gate-by-feature-or-admin.md) -- decision table for access control patterns
27
- - [Build and Extend CRM](./recipes/extend-crm.md) -- map CRM UI pages, hooks, actions, workflow adapters, contracts, and org-model boundaries
28
- - [Build and Extend Lead Gen](./recipes/extend-lead-gen.md) -- map lead-gen UI pages, hooks, list/member state, artifacts, touchpoints, workflow adapters, contracts, and org-model boundaries
29
- - [Customize CRM Actions](./recipes/customize-crm-actions.md) -- add, hide, or replace CRM deal actions, use the shared `crmActions` provider path, and understand workflow dispatch constraints
30
-
31
- ### UI Patterns
32
-
33
- - [UI Recipes](./ui/recipes.md) -- copy-paste recipes for pages, nav items, components, theme tokens
34
- - [Feature Flags & Gating](./ui/feature-flags-and-gating.md) -- three-concept model for feature access
35
- - [Customizing Features](./ui/customization.md) -- sidebar composition via manifest overrides
36
- - [Feature Shell & Provider](./ui/feature-shell.mdx) -- FeatureModule manifest contract, provider runtime
37
- - [Composition & Extensibility](./ui/composition-extensibility.mdx) -- layout primitives, router abstraction
38
-
39
- ### Core Architecture
40
-
41
- - [Organization Model](./core/organization-model.mdx) -- semantic contract, schema, authoring helpers
42
- - [Organization Graph](./core/organization-graph.mdx) -- graph derivation, node/edge taxonomy, lenses
43
-
44
- ### Operations
45
-
46
- - [Workflow Recipes](./operations/workflow-recipes.md) -- workflow anatomy, adapter patterns, trigger patterns
47
- - [Propagation Pipeline](./operations/propagation-pipeline.md) -- three-layer sync pipeline, verification checks, integration points
48
- - [Scaffold Maintenance](./operations/scaffold-maintenance.md) -- content placement, auto-generation, adding new scaffold docs
49
-
50
- ### Reference
51
-
52
- - [Glossary](./reference/glossary.md) -- term definitions for Organization OS concepts
53
- - [Contracts](./reference/contracts.md) -- auto-generated TypeScript contract shapes
54
- - [Feature Registry](./reference/feature-registry.md) -- auto-generated feature manifest catalog
55
-
56
- ## Source Locations
57
-
58
- Content is co-located with its owning package and copied here during SDK build:
59
-
60
- | Bundle Path | Source Location | Owner |
61
- | --------------------------------------------- | --------------------------------------------------------- | --------------- |
62
- | `scaffold/recipes/` | `packages/sdk/docs/scaffold/recipes/` | SDK |
63
- | `scaffold/operations/` | `packages/sdk/docs/scaffold/operations/` | SDK |
64
- | `scaffold/operations/propagation-pipeline.md` | `packages/sdk/docs/scaffold/operations/` | SDK |
65
- | `scaffold/operations/scaffold-maintenance.md` | `packages/sdk/docs/scaffold/operations/` | SDK |
66
- | `scaffold/ui/` | `packages/ui/src/scaffold/` | UI |
67
- | `scaffold/core/` | `packages/core/src/organization-model/` | Core |
68
- | `scaffold/reference/glossary.md` | `packages/core/src/reference/glossary.md` | Core |
69
- | `scaffold/reference/contracts.md` | `packages/core/src/reference/_generated/contracts.md` | Core (auto-gen) |
70
- | `scaffold/reference/feature-registry.md` | `packages/ui/src/scaffold/_generated/feature-registry.md` | UI (auto-gen) |
8
+
9
+ ## Overview
10
+
11
+ This scaffold reference contains universal documentation that applies to all Elevasis SDK projects. Content is organized by package ownership:
12
+
13
+ - **recipes/** -- Cross-package pathway recipes (add a feature, add a resource, gating patterns)
14
+ - **ui/** -- UI patterns, feature shell architecture, composition, and customization
15
+ - **core/** -- Organization model architecture, graph layer, and semantic contracts
16
+ - **operations/** -- Workflow authoring patterns and adapter usage
17
+ - **reference/** -- Glossary, auto-generated contracts, and feature registry
18
+
19
+ ## Quick Navigation
20
+
21
+ ### Pathway Recipes
22
+
23
+ - [Add a Feature](./recipes/add-a-feature.md) -- end-to-end from org model key through manifest, routes, gating
24
+ - [Add a Resource](./recipes/add-a-resource.md) -- author and deploy a workflow or agent
25
+ - [Extend a Base Entity](./recipes/extend-a-base-entity.md) -- add project-specific metadata to canonical entity shapes via the TMeta slot
26
+ - [Gate by Feature or Admin](./recipes/gate-by-feature-or-admin.md) -- decision table for access control patterns
27
+ - [Build and Extend CRM](./recipes/extend-crm.md) -- map CRM UI pages, hooks, actions, workflow adapters, contracts, and org-model boundaries
28
+ - [Build and Extend Lead Gen](./recipes/extend-lead-gen.md) -- map lead-gen UI pages, hooks, list/member state, artifacts, workflow adapters, contracts, and org-model boundaries
29
+ - [Customize CRM Actions](./recipes/customize-crm-actions.md) -- add, hide, or replace CRM deal actions, use the shared `crmActions` provider path, and understand workflow dispatch constraints
30
+
31
+ ### UI Patterns
32
+
33
+ - [UI Recipes](./ui/recipes.md) -- copy-paste recipes for pages, nav items, components, theme tokens
34
+ - [Feature Flags & Gating](./ui/feature-flags-and-gating.md) -- three-concept model for feature access
35
+ - [Customizing Features](./ui/customization.md) -- sidebar composition via manifest overrides
36
+ - [Feature Shell & Provider](./ui/feature-shell.mdx) -- FeatureModule manifest contract, provider runtime
37
+ - [Composition & Extensibility](./ui/composition-extensibility.mdx) -- layout primitives, router abstraction
38
+
39
+ ### Core Architecture
40
+
41
+ - [Organization Model](./core/organization-model.mdx) -- semantic contract, schema, authoring helpers
42
+ - [Organization Graph](./core/organization-graph.mdx) -- graph derivation, node/edge taxonomy, lenses
43
+
44
+ ### Operations
45
+
46
+ - [Workflow Recipes](./operations/workflow-recipes.md) -- workflow anatomy, adapter patterns, trigger patterns
47
+ - [Propagation Pipeline](./operations/propagation-pipeline.md) -- three-layer sync pipeline, verification checks, integration points
48
+ - [Scaffold Maintenance](./operations/scaffold-maintenance.md) -- content placement, auto-generation, adding new scaffold docs
49
+
50
+ ### Reference
51
+
52
+ - [Glossary](./reference/glossary.md) -- term definitions for Organization OS concepts
53
+ - [Contracts](./reference/contracts.md) -- auto-generated TypeScript contract shapes
54
+ - [Feature Registry](./reference/feature-registry.md) -- auto-generated feature manifest catalog
55
+
56
+ ## Source Locations
57
+
58
+ Content is co-located with its owning package and copied here during SDK build:
59
+
60
+ | Bundle Path | Source Location | Owner |
61
+ | --------------------------------------------- | --------------------------------------------------------- | --------------- |
62
+ | `scaffold/recipes/` | `packages/sdk/docs/scaffold/recipes/` | SDK |
63
+ | `scaffold/operations/` | `packages/sdk/docs/scaffold/operations/` | SDK |
64
+ | `scaffold/operations/propagation-pipeline.md` | `packages/sdk/docs/scaffold/operations/` | SDK |
65
+ | `scaffold/operations/scaffold-maintenance.md` | `packages/sdk/docs/scaffold/operations/` | SDK |
66
+ | `scaffold/ui/` | `packages/ui/src/scaffold/` | UI |
67
+ | `scaffold/core/` | `packages/core/src/organization-model/` | Core |
68
+ | `scaffold/reference/glossary.md` | `packages/core/src/reference/glossary.md` | Core |
69
+ | `scaffold/reference/contracts.md` | `packages/core/src/reference/_generated/contracts.md` | Core (auto-gen) |
70
+ | `scaffold/reference/feature-registry.md` | `packages/ui/src/scaffold/_generated/feature-registry.md` | UI (auto-gen) |