@elevasis/sdk 1.28.1 → 1.29.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 +4 -2
- package/dist/index.d.ts +18 -0
- package/dist/test-utils/index.d.ts +18 -0
- package/package.json +4 -4
- package/reference/_navigation.md +4 -4
- package/reference/_reference-manifest.json +8 -8
- package/reference/claude-config/hooks/scaffold-registry-reminder.mjs +3 -3
- package/reference/claude-config/skills/tutorial/technical.md +5 -5
- package/reference/claude-config/sync-notes/2026-05-24-platform-invite-router-core-baseline.md +28 -0
- package/reference/core/exports.mdx +16 -0
- package/reference/core/index.mdx +58 -0
- package/reference/index.mdx +36 -67
- package/reference/scaffold/operations/propagation-pipeline.md +152 -152
- package/reference/{cli-management.mdx → sdk/cli-management.mdx} +159 -13
- package/reference/{cli.mdx → sdk/cli.mdx} +68 -12
- package/reference/sdk/exports.mdx +14 -0
- package/reference/sdk/index.mdx +93 -0
- package/reference/sdk/platform-tools/adapters-integration.mdx +25 -0
- package/reference/sdk/platform-tools/adapters-platform.mdx +24 -0
- package/reference/{platform-tools → sdk/platform-tools}/index.mdx +9 -30
- package/reference/{resources → sdk/resources}/patterns.mdx +29 -11
- package/reference/ui/exports.mdx +60 -0
- package/reference/ui/index.mdx +75 -0
- package/reference/platform-tools/adapters-integration.mdx +0 -300
- package/reference/platform-tools/adapters-platform.mdx +0 -552
- /package/reference/{concepts.mdx → sdk/concepts.mdx} +0 -0
- /package/reference/{deployment → sdk/deployment}/command-center.mdx +0 -0
- /package/reference/{deployment → sdk/deployment}/execution-reference.mdx +0 -0
- /package/reference/{deployment → sdk/deployment}/index.mdx +0 -0
- /package/reference/{framework → sdk/framework}/agent.mdx +0 -0
- /package/reference/{framework → sdk/framework}/index.mdx +0 -0
- /package/reference/{framework → sdk/framework}/interaction-guidance.mdx +0 -0
- /package/reference/{framework → sdk/framework}/memory.mdx +0 -0
- /package/reference/{framework → sdk/framework}/project-structure.mdx +0 -0
- /package/reference/{framework → sdk/framework}/resource-documentation.mdx +0 -0
- /package/reference/{framework → sdk/framework}/tutorial-system.mdx +0 -0
- /package/reference/{getting-started.mdx → sdk/getting-started.mdx} +0 -0
- /package/reference/{platform-tools → sdk/platform-tools}/type-safety.mdx +0 -0
- /package/reference/{resources → sdk/resources}/index.mdx +0 -0
- /package/reference/{resources → sdk/resources}/types.mdx +0 -0
- /package/reference/{roadmap.mdx → sdk/roadmap.mdx} +0 -0
- /package/reference/{runtime.mdx → sdk/runtime.mdx} +0 -0
- /package/reference/{templates → sdk/templates}/data-enrichment.mdx +0 -0
- /package/reference/{templates → sdk/templates}/email-sender.mdx +0 -0
- /package/reference/{templates → sdk/templates}/index.mdx +0 -0
- /package/reference/{templates → sdk/templates}/lead-scorer.mdx +0 -0
- /package/reference/{templates → sdk/templates}/pdf-generator.mdx +0 -0
- /package/reference/{templates → sdk/templates}/recurring-job.mdx +0 -0
- /package/reference/{templates → sdk/templates}/text-classifier.mdx +0 -0
- /package/reference/{templates → sdk/templates}/web-scraper.mdx +0 -0
- /package/reference/{troubleshooting.mdx → sdk/troubleshooting.mdx} +0 -0
package/dist/cli.cjs
CHANGED
|
@@ -38925,7 +38925,9 @@ function getAllBuildTemplates(model) {
|
|
|
38925
38925
|
(catalog) => entriesOf(catalog).map(([templateId, templateEntry]) => {
|
|
38926
38926
|
const stepCatalogId = stringValue(templateEntry.stepCatalog);
|
|
38927
38927
|
const stepCatalog = stepCatalogId !== void 0 ? stepCatalogs.get(stepCatalogId) : void 0;
|
|
38928
|
-
const steps = stepCatalog === void 0 ? [] : entriesOf(stepCatalog)
|
|
38928
|
+
const steps = stepCatalog === void 0 ? [] : entriesOf(stepCatalog).sort(
|
|
38929
|
+
([leftId, left], [rightId, right]) => numberValue(left.order, Number.MAX_SAFE_INTEGER) - numberValue(right.order, Number.MAX_SAFE_INTEGER) || leftId.localeCompare(rightId)
|
|
38930
|
+
);
|
|
38929
38931
|
return {
|
|
38930
38932
|
order: numberValue(templateEntry.order, Number.MAX_SAFE_INTEGER),
|
|
38931
38933
|
template: {
|
|
@@ -44712,7 +44714,7 @@ function wrapAction(commandName, fn) {
|
|
|
44712
44714
|
// package.json
|
|
44713
44715
|
var package_default = {
|
|
44714
44716
|
name: "@elevasis/sdk",
|
|
44715
|
-
version: "1.
|
|
44717
|
+
version: "1.29.0",
|
|
44716
44718
|
description: "SDK for building Elevasis organization resources",
|
|
44717
44719
|
type: "module",
|
|
44718
44720
|
bin: {
|
package/dist/index.d.ts
CHANGED
|
@@ -4546,6 +4546,17 @@ type Database = {
|
|
|
4546
4546
|
Args: never;
|
|
4547
4547
|
Returns: undefined;
|
|
4548
4548
|
};
|
|
4549
|
+
repair_membership_role_assignments: {
|
|
4550
|
+
Args: never;
|
|
4551
|
+
Returns: {
|
|
4552
|
+
membership_id: string;
|
|
4553
|
+
organization_id: string;
|
|
4554
|
+
repaired: boolean;
|
|
4555
|
+
role_id: string;
|
|
4556
|
+
role_slug: string;
|
|
4557
|
+
user_id: string;
|
|
4558
|
+
}[];
|
|
4559
|
+
};
|
|
4549
4560
|
sync_all_memberships_with_role: {
|
|
4550
4561
|
Args: {
|
|
4551
4562
|
p_role_id: string;
|
|
@@ -4558,6 +4569,13 @@ type Database = {
|
|
|
4558
4569
|
};
|
|
4559
4570
|
Returns: undefined;
|
|
4560
4571
|
};
|
|
4572
|
+
update_membership_role_assignment: {
|
|
4573
|
+
Args: {
|
|
4574
|
+
p_role_slug: string;
|
|
4575
|
+
p_workos_membership_id: string;
|
|
4576
|
+
};
|
|
4577
|
+
Returns: string;
|
|
4578
|
+
};
|
|
4561
4579
|
upsert_user_profile: {
|
|
4562
4580
|
Args: never;
|
|
4563
4581
|
Returns: {
|
|
@@ -4379,6 +4379,17 @@ type Database = {
|
|
|
4379
4379
|
Args: never;
|
|
4380
4380
|
Returns: undefined;
|
|
4381
4381
|
};
|
|
4382
|
+
repair_membership_role_assignments: {
|
|
4383
|
+
Args: never;
|
|
4384
|
+
Returns: {
|
|
4385
|
+
membership_id: string;
|
|
4386
|
+
organization_id: string;
|
|
4387
|
+
repaired: boolean;
|
|
4388
|
+
role_id: string;
|
|
4389
|
+
role_slug: string;
|
|
4390
|
+
user_id: string;
|
|
4391
|
+
}[];
|
|
4392
|
+
};
|
|
4382
4393
|
sync_all_memberships_with_role: {
|
|
4383
4394
|
Args: {
|
|
4384
4395
|
p_role_id: string;
|
|
@@ -4391,6 +4402,13 @@ type Database = {
|
|
|
4391
4402
|
};
|
|
4392
4403
|
Returns: undefined;
|
|
4393
4404
|
};
|
|
4405
|
+
update_membership_role_assignment: {
|
|
4406
|
+
Args: {
|
|
4407
|
+
p_role_slug: string;
|
|
4408
|
+
p_workos_membership_id: string;
|
|
4409
|
+
};
|
|
4410
|
+
Returns: string;
|
|
4411
|
+
};
|
|
4394
4412
|
upsert_user_profile: {
|
|
4395
4413
|
Args: never;
|
|
4396
4414
|
Returns: {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@elevasis/sdk",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.29.0",
|
|
4
4
|
"description": "SDK for building Elevasis organization resources",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -58,9 +58,9 @@
|
|
|
58
58
|
"tsup": "^8.0.0",
|
|
59
59
|
"typescript": "5.9.2",
|
|
60
60
|
"zod": "^4.1.0",
|
|
61
|
-
"@repo/core": "0.
|
|
62
|
-
"@repo/
|
|
63
|
-
"@repo/
|
|
61
|
+
"@repo/core": "0.36.0",
|
|
62
|
+
"@repo/eslint-config": "0.0.0",
|
|
63
|
+
"@repo/typescript-config": "0.0.0"
|
|
64
64
|
},
|
|
65
65
|
"scripts": {
|
|
66
66
|
"lint": "eslint src --max-warnings 0",
|
package/reference/_navigation.md
CHANGED
|
@@ -46,25 +46,25 @@ Package entries indexed: 60.
|
|
|
46
46
|
|
|
47
47
|
| Resource | Location | Description | When to Load |
|
|
48
48
|
| --- | --- | --- | --- |
|
|
49
|
-
| SDK | `index.mdx` | Root SDK types, config, runtime errors, and registry surface. | (not specified) |
|
|
49
|
+
| SDK | `sdk/index.mdx` | Root SDK types, config, runtime errors, and registry surface. | (not specified) |
|
|
50
50
|
|
|
51
51
|
## @elevasis/sdk / Runtime
|
|
52
52
|
|
|
53
53
|
| Resource | Location | Description | When to Load |
|
|
54
54
|
| --- | --- | --- | --- |
|
|
55
|
-
| Worker Runtime | `runtime.mdx` | Worker runtime entrypoint, adapters, and platform execution surface. | (not specified) |
|
|
55
|
+
| Worker Runtime | `sdk/runtime.mdx` | Worker runtime entrypoint, adapters, and platform execution surface. | (not specified) |
|
|
56
56
|
|
|
57
57
|
## @elevasis/sdk / Testing
|
|
58
58
|
|
|
59
59
|
| Resource | Location | Description | When to Load |
|
|
60
60
|
| --- | --- | --- | --- |
|
|
61
|
-
| Test Utils | `runtime.mdx` | Workflow runner, registry assertion, and typed adapter mocks for SDK consumers. | (not specified) |
|
|
61
|
+
| Test Utils | `sdk/runtime.mdx` | Workflow runner, registry assertion, and typed adapter mocks for SDK consumers. | (not specified) |
|
|
62
62
|
|
|
63
63
|
## @elevasis/sdk / Tooling
|
|
64
64
|
|
|
65
65
|
| Resource | Location | Description | When to Load |
|
|
66
66
|
| --- | --- | --- | --- |
|
|
67
|
-
| Node Build Tooling | `cli.mdx` | Node-only build helpers: knowledge codegen and other fs/path/process utilities. Not browser-safe. | (not specified) |
|
|
67
|
+
| Node Build Tooling | `sdk/cli.mdx` | Node-only build helpers: knowledge codegen and other fs/path/process utilities. Not browser-safe. | (not specified) |
|
|
68
68
|
|
|
69
69
|
## @elevasis/ui / Build
|
|
70
70
|
|
|
@@ -95,8 +95,8 @@
|
|
|
95
95
|
"group": "Getting Started",
|
|
96
96
|
"order": 1,
|
|
97
97
|
"sourcePath": "packages/sdk/src/index.ts",
|
|
98
|
-
"docPath": "apps/docs/content/docs/sdk/index.mdx",
|
|
99
|
-
"referencePath": "index.mdx",
|
|
98
|
+
"docPath": "apps/docs/content/docs/sdk/sdk/index.mdx",
|
|
99
|
+
"referencePath": "sdk/index.mdx",
|
|
100
100
|
"publishedExportPath": "./dist/index.js"
|
|
101
101
|
},
|
|
102
102
|
{
|
|
@@ -109,8 +109,8 @@
|
|
|
109
109
|
"group": "Runtime",
|
|
110
110
|
"order": 1,
|
|
111
111
|
"sourcePath": "packages/sdk/src/worker/index.ts",
|
|
112
|
-
"docPath": "apps/docs/content/docs/sdk/runtime.mdx",
|
|
113
|
-
"referencePath": "runtime.mdx",
|
|
112
|
+
"docPath": "apps/docs/content/docs/sdk/sdk/runtime.mdx",
|
|
113
|
+
"referencePath": "sdk/runtime.mdx",
|
|
114
114
|
"publishedExportPath": "./dist/worker/index.js"
|
|
115
115
|
},
|
|
116
116
|
{
|
|
@@ -123,8 +123,8 @@
|
|
|
123
123
|
"group": "Testing",
|
|
124
124
|
"order": 1,
|
|
125
125
|
"sourcePath": "packages/sdk/src/test-utils/index.ts",
|
|
126
|
-
"docPath": "apps/docs/content/docs/sdk/runtime.mdx",
|
|
127
|
-
"referencePath": "runtime.mdx",
|
|
126
|
+
"docPath": "apps/docs/content/docs/sdk/sdk/runtime.mdx",
|
|
127
|
+
"referencePath": "sdk/runtime.mdx",
|
|
128
128
|
"publishedExportPath": "./dist/test-utils/index.js"
|
|
129
129
|
},
|
|
130
130
|
{
|
|
@@ -137,8 +137,8 @@
|
|
|
137
137
|
"group": "Tooling",
|
|
138
138
|
"order": 1,
|
|
139
139
|
"sourcePath": "packages/sdk/src/node/index.ts",
|
|
140
|
-
"docPath": "apps/docs/content/docs/sdk/cli.mdx",
|
|
141
|
-
"referencePath": "cli.mdx",
|
|
140
|
+
"docPath": "apps/docs/content/docs/sdk/sdk/cli.mdx",
|
|
141
|
+
"referencePath": "sdk/cli.mdx",
|
|
142
142
|
"publishedExportPath": "./dist/node/index.js"
|
|
143
143
|
},
|
|
144
144
|
{
|
|
@@ -16,7 +16,7 @@ const ROOT = process.env.CLAUDE_PROJECT_DIR ?? process.cwd()
|
|
|
16
16
|
const LOG_DIR = join(ROOT, '.claude', 'logs')
|
|
17
17
|
const LOG_FILE = join(LOG_DIR, 'scaffold-registry-reminder.log')
|
|
18
18
|
const STATE_FILE = join(LOG_DIR, 'scaffold-registry-reminder.state.json')
|
|
19
|
-
const REGISTRY_FILE = join(ROOT, '.claude', 'scaffold-registry.compiled.json')
|
|
19
|
+
const REGISTRY_FILE = join(ROOT, '.claude', 'registries', 'scaffold-registry.compiled.json')
|
|
20
20
|
|
|
21
21
|
const DEFAULT_COOLDOWN_MS = 300_000 // 5 minutes
|
|
22
22
|
|
|
@@ -89,7 +89,7 @@ function emitReminder(entry, relFilePath) {
|
|
|
89
89
|
lines.push(formatDependentLine(dep))
|
|
90
90
|
}
|
|
91
91
|
lines.push(
|
|
92
|
-
` If this is a scaffold-sensitive pattern not in the registry, also add an entry to .claude/scaffold-registry.yml.`
|
|
92
|
+
` If this is a scaffold-sensitive pattern not in the registry, also add an entry to .claude/registries/scaffold-registry.yml.`
|
|
93
93
|
)
|
|
94
94
|
return lines.join('\n')
|
|
95
95
|
}
|
|
@@ -98,7 +98,7 @@ function emitMissingEntryHint(relFilePath) {
|
|
|
98
98
|
return [
|
|
99
99
|
`\uD83D\uDD14 Scaffold reminder -- unregistered generated path (${relFilePath})`,
|
|
100
100
|
` This path looks scaffold-generated but has no registry entry.`,
|
|
101
|
-
` If it is scaffold-sensitive, add a new entry to .claude/scaffold-registry.yml`,
|
|
101
|
+
` If it is scaffold-sensitive, add a new entry to .claude/registries/scaffold-registry.yml`,
|
|
102
102
|
` so the reminder hook and /work handoff can track it.`
|
|
103
103
|
].join('\n')
|
|
104
104
|
}
|
|
@@ -494,7 +494,7 @@ how data flows between steps.
|
|
|
494
494
|
**Estimated time:** 25 min
|
|
495
495
|
|
|
496
496
|
**Files referenced:** `node_modules/@elevasis/sdk/reference/scaffold/operations/workflow-recipes.md`,
|
|
497
|
-
`apps/docs/content/docs/sdk/concepts.mdx` (design decisions section)
|
|
497
|
+
`apps/docs/content/docs/sdk/sdk/concepts.mdx` (design decisions section)
|
|
498
498
|
|
|
499
499
|
**Flow:**
|
|
500
500
|
|
|
@@ -1044,7 +1044,7 @@ result) and understands when to use an agent definition vs a workflow definition
|
|
|
1044
1044
|
**Estimated time:** 25 min
|
|
1045
1045
|
|
|
1046
1046
|
**Files referenced:** `node_modules/@elevasis/sdk/reference/scaffold/operations/workflow-recipes.md`,
|
|
1047
|
-
`apps/docs/content/docs/sdk/concepts.mdx` (workflow vs agent section)
|
|
1047
|
+
`apps/docs/content/docs/sdk/sdk/concepts.mdx` (workflow vs agent section)
|
|
1048
1048
|
|
|
1049
1049
|
**Flow:**
|
|
1050
1050
|
|
|
@@ -1076,7 +1076,7 @@ The SDK converts the Zod schema to JSON Schema internally. The LLM is instructed
|
|
|
1076
1076
|
matching that shape. The result is validated and returned as the inferred TypeScript type.
|
|
1077
1077
|
|
|
1078
1078
|
**Agent definition vs workflow definition.** Read the glossary entries from
|
|
1079
|
-
`apps/docs/content/docs/sdk/concepts.mdx`:
|
|
1079
|
+
`apps/docs/content/docs/sdk/sdk/concepts.mdx`:
|
|
1080
1080
|
|
|
1081
1081
|
- **Workflow** -- deterministic, step-by-step, 300s timeout. Use when inputs and outputs are
|
|
1082
1082
|
known and the process is predefined.
|
|
@@ -1171,7 +1171,7 @@ understands the scaffold registry's purpose.
|
|
|
1171
1171
|
**Estimated time:** 20 min
|
|
1172
1172
|
|
|
1173
1173
|
**Files referenced:** `.claude/rules/` (all files), `.claude/memory/` (layout),
|
|
1174
|
-
`.claude/scaffold-registry.yml` (reference, monorepo-side concept)
|
|
1174
|
+
`.claude/registries/scaffold-registry.yml` (reference, monorepo-side concept)
|
|
1175
1175
|
|
|
1176
1176
|
**Flow:**
|
|
1177
1177
|
|
|
@@ -1205,7 +1205,7 @@ glob of files it applies to. The rules system discovers it automatically -- no r
|
|
|
1205
1205
|
Memory files are readable by the agent at session start. The `profile.md` file is particularly
|
|
1206
1206
|
important: it sets the project-wide tone for all sessions after the tutorial track is selected.
|
|
1207
1207
|
|
|
1208
|
-
**Scaffold registry (monorepo-side concept).** `.claude/scaffold-registry.yml` is the
|
|
1208
|
+
**Scaffold registry (monorepo-side concept).** `.claude/registries/scaffold-registry.yml` is the
|
|
1209
1209
|
monorepo's source-of-truth for scaffold dependencies -- it maps source paths to generated or
|
|
1210
1210
|
manual scaffolds that depend on them. It drives the PostToolUse reminder hook and `/work handoff`
|
|
1211
1211
|
preflight in the monorepo. In an external project you are a consumer, not a contributor, of that
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Platform Invite Router Core Baseline
|
|
2
|
+
|
|
3
|
+
## Why this note exists
|
|
4
|
+
|
|
5
|
+
The platform invite router train publishes a new `@elevasis/core` auth schema export for the narrow organization auth-config endpoint used by the backend invite router.
|
|
6
|
+
|
|
7
|
+
## Applies to
|
|
8
|
+
|
|
9
|
+
- Template-derived projects that consume `@elevasis/core`.
|
|
10
|
+
- Project `core/package.json` and `operations/package.json` package baselines after the core release.
|
|
11
|
+
|
|
12
|
+
## Required actions
|
|
13
|
+
|
|
14
|
+
- Accept the `@elevasis/core` dependency baseline update after the core publish stage.
|
|
15
|
+
- Do not add tenant app-origin routing code to template projects from this train; invitation routing remains platform API behavior.
|
|
16
|
+
- Keep tenant app WorkOS login routes accepting `invitation_token` when project-specific launch work has already added that route support.
|
|
17
|
+
|
|
18
|
+
## Verification
|
|
19
|
+
|
|
20
|
+
- Run `pnpm sync:verify` after manifest-scoped external sync.
|
|
21
|
+
- For projects receiving the baseline, run project-local checks required by the sync plan.
|
|
22
|
+
|
|
23
|
+
## Not handled by /git-sync
|
|
24
|
+
|
|
25
|
+
- Publishing `@elevasis/core`.
|
|
26
|
+
- Updating package baselines after publish.
|
|
27
|
+
- WorkOS production application configuration.
|
|
28
|
+
- Per-tenant invitation smoke tests.
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "@elevasis/core Export Catalog"
|
|
3
|
+
description: "Auto-generated catalog of all published @elevasis/core subpath exports, derived from packages/core/reference-manifest.ts."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
{/* @generated by .claude/_gen/sync-sdk-catalog.ts — DO NOT EDIT */}
|
|
7
|
+
{/* Regenerate: pnpm gen:sdk-catalog */}
|
|
8
|
+
|
|
9
|
+
| Import | Title | Group | Description |
|
|
10
|
+
| --- | --- | --- | --- |
|
|
11
|
+
| `@elevasis/core` | Core | Core | Published core wrapper for the curated contract surface. |
|
|
12
|
+
| `@elevasis/core/auth` | Auth | Auth | Published browser-safe auth contracts, AccessKeys, and Access Model primitives. |
|
|
13
|
+
| `@elevasis/core/organization-model` | Organization Model | Organization Model | Published organization-model schema, defaults, resolver, and types. |
|
|
14
|
+
| `@elevasis/core/knowledge` | Knowledge | Knowledge | Published knowledge query layer: bySystem/byKind/byOwner/governs/governedBy queries, parsePath, and output formatters. |
|
|
15
|
+
| `@elevasis/core/entities` | Entities | Entities | Published base entity contracts (Project, Milestone, Task, Deal, Company, Contact) generic over a metadata extension slot. |
|
|
16
|
+
| `@elevasis/core/test-utils` | Test Utilities | Testing | Published test fixtures, mocks, and shared helpers for downstream automated tests. |
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "@elevasis/core"
|
|
3
|
+
description: The shared Zod contract layer for the Elevasis platform — organization model, entity schemas, knowledge graph, auth types, and test utilities. Used by both @elevasis/sdk and @elevasis/ui.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
`@elevasis/core` is the shared contract layer for the Elevasis platform. It exports Zod schemas and TypeScript types that are used by `@elevasis/sdk`, `@elevasis/ui`, and the platform API itself. Installing it gives you the typed contracts without pulling in the full SDK runtime or React dependencies.
|
|
7
|
+
|
|
8
|
+
## Install
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
pnpm add @elevasis/core
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
The default export and most subpaths are browser-safe. No Node.js-specific runtime is required for the schema and type contracts.
|
|
15
|
+
|
|
16
|
+
## Published Subpaths
|
|
17
|
+
|
|
18
|
+
`@elevasis/core` ships six published subpaths:
|
|
19
|
+
|
|
20
|
+
- **`.`** (default) -- base schemas, shared utilities, and the root contract surface. Browser-safe.
|
|
21
|
+
- **`./auth`** -- auth contract types: session shapes, membership, role definitions, and WorkOS integration contracts.
|
|
22
|
+
- **`./organization-model`** -- the organization model (OM) schema: system definitions, resource metadata, and the org-model graph types used by the platform's AI routing layer.
|
|
23
|
+
- **`./entities`** -- entity schemas: typed definitions for leads, clients, deals, contacts, and other CRM-adjacent records.
|
|
24
|
+
- **`./knowledge`** -- knowledge graph schemas: document types, embedding metadata, and retrieval contract types.
|
|
25
|
+
- **`./test-utils`** -- Zod-based test fixtures and factory helpers. Not for production use.
|
|
26
|
+
|
|
27
|
+
Import a subpath directly:
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
import { orgModelSchema } from "@elevasis/core/organization-model";
|
|
31
|
+
import { entitySchema } from "@elevasis/core/entities";
|
|
32
|
+
import { knowledgeDocSchema } from "@elevasis/core/knowledge";
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Browser / Server Split
|
|
36
|
+
|
|
37
|
+
The default export and all named subpaths above are browser-safe -- they contain only Zod schemas, TypeScript types, and pure utility functions. There are no Node.js-specific APIs, filesystem access, or server-side dependencies in the published surface.
|
|
38
|
+
|
|
39
|
+
The broader workspace `exports` (~40 paths in `packages/core`) are internal to the monorepo and not part of the published surface. Only the six subpaths listed above are available to tenant projects.
|
|
40
|
+
|
|
41
|
+
## When To Use @elevasis/core Directly
|
|
42
|
+
|
|
43
|
+
Most tenant projects install `@elevasis/sdk`, which includes `@elevasis/core` as a dependency. You need `@elevasis/core` directly when:
|
|
44
|
+
|
|
45
|
+
- You are building a shared library or utility layer that needs the Elevasis types but not the SDK runtime.
|
|
46
|
+
- You are writing a server-side API that validates Elevasis contracts (entity schemas, org model, auth types) without deploying workflows.
|
|
47
|
+
- You are building a custom UI that needs the typed contracts alongside `@elevasis/ui` without the CLI or worker adapter surface.
|
|
48
|
+
- You need `./test-utils` for fixture generation in tests outside an SDK project.
|
|
49
|
+
|
|
50
|
+
## How It Composes With @elevasis/sdk
|
|
51
|
+
|
|
52
|
+
`@elevasis/sdk` re-exports the core contracts you need for day-to-day workflow and agent development. When you import step types, entity schemas, or org-model references from `@elevasis/sdk`, those types are sourced from `@elevasis/core` internally.
|
|
53
|
+
|
|
54
|
+
For advanced use cases -- writing custom validators, extending the org model, or building a server that enforces the same contracts the platform uses -- import from `@elevasis/core` subpaths directly rather than going through the SDK layer.
|
|
55
|
+
|
|
56
|
+
## Export Catalog
|
|
57
|
+
|
|
58
|
+
See [Export Catalog](exports.mdx) for a generated table of all published subpath exports derived from the reference manifest.
|
package/reference/index.mdx
CHANGED
|
@@ -1,93 +1,62 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Elevasis SDK
|
|
3
|
-
description:
|
|
3
|
+
description: The three published Elevasis packages — @elevasis/sdk, @elevasis/core, and @elevasis/ui — that tenant projects install and compose to build AI workflows and feature-rich applications on the platform.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
The Elevasis SDK is the published surface for building on the Elevasis platform. It ships as three independent npm packages that can be installed together or separately depending on what you are building.
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
- **`@elevasis/sdk`** -- runtime + resource definitions + CLI + worker adapters. The entry point for any tenant project. Install this to write workflows, agents, and resources and deploy them to the platform.
|
|
9
|
+
- **`@elevasis/core`** -- shared Zod schemas, organization model, knowledge graph, entity contracts, and auth types. Install this when you need the typed contracts without the full SDK runtime.
|
|
10
|
+
- **`@elevasis/ui`** -- React 19 feature-shell and manifest-backed feature modules (Lead Gen, CRM, Projects, Operations, Monitoring, Settings, SEO, and more). Install this when you are building a host UI that embeds Elevasis features.
|
|
9
11
|
|
|
10
|
-
|
|
12
|
+
## How They Compose
|
|
11
13
|
|
|
12
|
-
|
|
14
|
+
A typical tenant project installs `@elevasis/sdk` first. The SDK peer-depends on `@elevasis/core` for its shared schemas, so the contracts are always in sync. A tenant UI project adds `@elevasis/ui` on top to embed the shared React feature modules into its own shell.
|
|
13
15
|
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
16
|
+
```
|
|
17
|
+
@elevasis/sdk -- workflows, agents, adapters, CLI, deploy
|
|
18
|
+
|
|
|
19
|
+
uses types from
|
|
20
|
+
|
|
|
21
|
+
@elevasis/core -- Zod schemas, org model, entities, knowledge, auth
|
|
22
|
+
|
|
23
|
+
@elevasis/ui -- React feature-shell (provider + manifest-backed modules)
|
|
24
|
+
|
|
|
25
|
+
uses types from
|
|
26
|
+
|
|
|
27
|
+
@elevasis/core
|
|
19
28
|
```
|
|
20
29
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
## What You Can Build
|
|
24
|
-
|
|
25
|
-
- **Workflows** -- Step-based automation with typed inputs and outputs. Steps can be linear, conditional, or branching. Each step is a plain async function. See [Resources](resources/index.mdx) for the complete definition API.
|
|
26
|
-
- **Agents** -- Autonomous AI resources with access to platform tools. Agents run in the worker runtime with full LLM access and platform tool support. Use `--async` when executing agents to avoid HTTP timeout limits on long-running runs.
|
|
27
|
-
- **Feature-driven apps** -- The published `@elevasis/ui` surface includes manifest-backed shared features for Lead Gen, CRM, Projects, Operations, Monitoring, Settings, and SEO, plus dashboard-oriented compatibility components for host-owned shells. See [Provided Features](deployment/index.mdx#provided-features).
|
|
28
|
-
|
|
29
|
-
## Platform Tools
|
|
30
|
-
|
|
31
|
-
The platform exposes 70+ tools across integration adapters and platform services -- Gmail, Stripe, Google Sheets, Attio, and more. Import typed adapters from `@elevasis/sdk/worker` inside any workflow step or agent. Credentials are managed server-side; API keys never cross the execution boundary.
|
|
32
|
-
|
|
33
|
-
See [Platform Tools](platform-tools/index.mdx) for the full catalog, adapter reference, and credential setup.
|
|
34
|
-
|
|
35
|
-
## Known Limitations
|
|
36
|
-
|
|
37
|
-
- **No streaming logs** -- Execution logs are returned in the response body after completion. Real-time log streaming is not available.
|
|
38
|
-
- **Agent HTTP timeouts** -- Use `elevasis-sdk exec --async` for agent executions. Agents can run for minutes; the synchronous endpoint will time out for long-running runs. The `--async` flag returns an execution ID immediately and polls for the result.
|
|
39
|
-
|
|
40
|
-
## Documentation
|
|
41
|
-
|
|
42
|
-
### Getting Started
|
|
43
|
-
|
|
44
|
-
- [Getting Started](getting-started.mdx) - Installation, authentication, first workflow, and project structure
|
|
30
|
+
You do not need all three packages. A pure automation project needs only `@elevasis/sdk`. A shared-types layer needs only `@elevasis/core`. A UI host without custom workflows can install `@elevasis/ui` alone.
|
|
45
31
|
|
|
46
|
-
|
|
32
|
+
## Packages
|
|
47
33
|
|
|
48
|
-
|
|
49
|
-
- [Platform Tools](platform-tools/index.mdx) - Full catalog of 70+ tools, integration adapters, and credential management
|
|
50
|
-
- [Credential Security](platform-tools/index.mdx#credential-security) - Three-layer credential model, HTTP tool patterns, and credential management
|
|
34
|
+
### @elevasis/sdk (v1.28.1)
|
|
51
35
|
|
|
52
|
-
|
|
36
|
+
The primary developer package. Provides the TypeScript API for defining workflows and agents, the `elevasis-sdk` CLI for validation and deployment, and typed worker adapters for 25 platform and integration tools.
|
|
53
37
|
|
|
54
|
-
|
|
55
|
-
- [Templates](templates/index.mdx) - 7 workflow templates: web-scraper, data-enrichment, email-sender, lead-scorer, and more
|
|
56
|
-
- [CLI Reference](cli.mdx) - Core commands: check, deploy, exec, resources, executions, deployments, describe, creds, and rename
|
|
57
|
-
- [CLI Management Commands](cli-management.mdx) - Management families: project:\*, note:\*, acquisition:\*, client:\*, agent:\*, session:\*, queue:\*, schedule:\*, om:\*, and ui:\*
|
|
58
|
-
- [Deployment](deployment/index.mdx) - Deploy pipeline, versioning, bundle upload, and registry registration
|
|
59
|
-
- [Runtime](runtime.mdx) - Worker execution model, concurrency, timeouts, cancellation, resource limits, and v1 limitations
|
|
38
|
+
**Install:** `pnpm add @elevasis/sdk`
|
|
60
39
|
|
|
61
|
-
|
|
40
|
+
**Published subpaths:** `.` (default), `./worker`, `./test-utils`, `./node`
|
|
62
41
|
|
|
63
|
-
|
|
64
|
-
- [Platform Adapters](platform-tools/adapters-platform.mdx) - All 9 platform service adapters: scheduler, storage, llm, pdf, approval, and more
|
|
42
|
+
See [@elevasis/sdk](sdk/index.mdx) for the full group overview, getting started guide, CLI reference, adapter catalog, and more.
|
|
65
43
|
|
|
66
|
-
###
|
|
44
|
+
### @elevasis/core (v0.35.1)
|
|
67
45
|
|
|
68
|
-
|
|
69
|
-
- [Project Structure](framework/project-structure.mdx) - Scaffolded file layout, domain barrels, src/index.ts entry point, and config files
|
|
70
|
-
- [Agent Configuration](framework/agent.mdx) - Agent capabilities, tool access, model config, and Claude Code integration patterns
|
|
71
|
-
- [Memory](framework/memory.mdx) - Agent memory system, session state, developer profiles, and workspace conventions
|
|
72
|
-
- [Interaction Guidance](framework/interaction-guidance.mdx) - Skill dimension adaptation rules for platform navigation, API integration, and automation concepts
|
|
73
|
-
- [Tutorial System](framework/tutorial-system.mdx) - 21-item tutorial menu, skill-adaptive lesson variants, progress tracking, and module contents
|
|
74
|
-
- [Resource Documentation](framework/resource-documentation.mdx) - Docs directory structure, frontmatter schema, size limits, deploy behavior, and /docs command reference
|
|
46
|
+
The shared contract layer. Exports Zod schemas and TypeScript types that are shared between the SDK, the UI, and the platform API. Useful when you need the typed contracts (organization model, entities, knowledge, auth) in a package that does not pull in the full SDK runtime.
|
|
75
47
|
|
|
76
|
-
|
|
48
|
+
**Install:** `pnpm add @elevasis/core`
|
|
77
49
|
|
|
78
|
-
|
|
79
|
-
- [Common Patterns](resources/patterns.mdx) - Sequential steps, conditional branching, error handling, and resource status patterns
|
|
50
|
+
**Published subpaths:** `.` (default), `./auth`, `./test-utils`, `./organization-model`, `./entities`, `./knowledge`
|
|
80
51
|
|
|
81
|
-
|
|
52
|
+
See [@elevasis/core](core/index.mdx) for subpath details, browser/server split, and when to use it.
|
|
82
53
|
|
|
83
|
-
|
|
84
|
-
- [Execution Reference](deployment/execution-reference.mdx) - REST endpoints for executing resources, managing deployments, and React UI components for custom Run dialogs
|
|
54
|
+
### @elevasis/ui (v2.39.1)
|
|
85
55
|
|
|
86
|
-
|
|
56
|
+
The shared React feature-shell. Provides an `ElevasisProvider` and manifest-backed feature modules that a host UI embeds. Many peer dependencies are optional -- pull only what the features you use require.
|
|
87
57
|
|
|
88
|
-
|
|
89
|
-
- [Roadmap](roadmap.mdx) - Planned features including error taxonomy, retry semantics, circuit breaker, and metrics
|
|
58
|
+
**Install:** `pnpm add @elevasis/ui`
|
|
90
59
|
|
|
91
|
-
|
|
60
|
+
**Peer deps:** React 19, Mantine 8.2.7, TanStack Query, TanStack Router, Zod 4.1, Zustand 5, cytoscape (many optional)
|
|
92
61
|
|
|
93
|
-
|
|
62
|
+
See [@elevasis/ui](ui/index.mdx) for the provider model, feature modules, peer dependency details, and when to use it.
|