@elevasis/sdk 0.5.12 → 0.5.13

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.
Files changed (32) hide show
  1. package/dist/cli.cjs +92 -81
  2. package/dist/index.d.ts +11 -253
  3. package/dist/index.js +5 -9
  4. package/dist/templates.js +26 -23
  5. package/dist/types/worker/adapters/index.d.ts +0 -1
  6. package/dist/worker/index.js +47 -53
  7. package/package.json +1 -1
  8. package/reference/_navigation.md +13 -57
  9. package/reference/concepts.mdx +203 -0
  10. package/reference/deployment/{command-center-ui.mdx → command-center.mdx} +229 -151
  11. package/reference/deployment/index.mdx +158 -153
  12. package/reference/framework/agent.mdx +168 -151
  13. package/reference/framework/index.mdx +182 -103
  14. package/reference/framework/memory.mdx +347 -347
  15. package/reference/framework/tutorial-system.mdx +253 -0
  16. package/reference/{getting-started/index.mdx → getting-started.mdx} +4 -4
  17. package/reference/index.mdx +117 -114
  18. package/reference/platform-tools/adapters.mdx +175 -32
  19. package/reference/platform-tools/index.mdx +354 -195
  20. package/reference/resources/index.mdx +5 -0
  21. package/reference/{roadmap/index.mdx → roadmap.mdx} +1 -1
  22. package/reference/{runtime/index.mdx → runtime.mdx} +196 -141
  23. package/dist/types/worker/adapters/trello.d.ts +0 -14
  24. package/reference/concepts/index.mdx +0 -203
  25. package/reference/deployment/command-view.mdx +0 -154
  26. package/reference/framework/documentation.mdx +0 -92
  27. package/reference/platform-tools/examples.mdx +0 -170
  28. package/reference/runtime/limits.mdx +0 -75
  29. package/reference/security/credentials.mdx +0 -141
  30. /package/reference/{cli/index.mdx → cli.mdx} +0 -0
  31. /package/reference/{developer → framework}/interaction-guidance.mdx +0 -0
  32. /package/reference/{troubleshooting/common-errors.mdx → troubleshooting.mdx} +0 -0
@@ -1,151 +1,229 @@
1
- ---
2
- title: Command Center UI
3
- description: Reference for the Elevasis Command Center -- what each page does, when to use it post-deployment, and how SDK concepts map to UI actions
4
- loadWhen: "User asks about the Command Center UI, post-deployment workflow, or monitoring deployed resources"
5
- ---
6
-
7
- The Command Center is the browser UI for interacting with deployed resources. After you run `elevasis-sdk deploy`, this is where you run workflows, monitor executions, manage approvals, schedule tasks, and review logs. This reference covers each page and how it connects to your SDK code.
8
-
9
- ---
10
-
11
- ## Quick Reference
12
-
13
- | Task | Page | Path |
14
- | -------------------------------------------------- | -------------- | ----------------------- |
15
- | Browse deployed resources, view the resource graph | Command View | `/command-view` |
16
- | Approve or reject pending HITL requests | Command Queue | `/queue` |
17
- | Browse deployed documentation | Knowledge Base | `/knowledge-base` |
18
- | Search execution history across all resources | Execution Logs | `/logs` |
19
- | Create API key and OAuth credentials | Credentials | `/settings/credentials` |
20
- | View deployment history and active version | Deployments | `/settings/deployments` |
21
-
22
- ---
23
-
24
- ## Command View
25
-
26
- The Command View is a visual graph of your deployed resources. Each node is a resource (workflow, agent, trigger, integration). Edges are the relationships you declared in `OrganizationResources`.
27
-
28
- **What you can do here:**
29
-
30
- - See all deployed resources at a glance
31
- - Trace data flow between resources via declared relationships
32
- - Identify which resources depend on which integrations
33
- - Click a node to view resource details (ID, status, type)
34
-
35
- **Graph accuracy:** The graph reflects your `relationships` declarations, not runtime behavior. If your handler calls another resource without a declared relationship, the edge is missing from the graph. Keep declarations in sync with your code.
36
-
37
- For the full relationship model and what is enforced vs. decorative, see `reference/deployment/command-view.mdx`.
38
-
39
- > **SDK takeaway:** Declare relationships in `OrganizationResources` to keep the Command View accurate as your system grows.
40
-
41
- ---
42
-
43
- ## Command Queue
44
-
45
- The Command Queue surfaces all pending Human-in-the-Loop (HITL) approval requests from running workflows.
46
-
47
- **What you can do here:**
48
-
49
- - View pending approval requests with context provided by the workflow
50
- - Filter by resource, status, or date
51
- - Approve or reject with an optional comment
52
- - See the history of past decisions
53
-
54
- **How it connects to your code:** Approval requests appear here when a workflow step calls `approval.requestApproval()`. The workflow pauses at that step and waits for a decision before continuing.
55
-
56
- ```typescript
57
- import { approval } from '@elevasis/sdk/worker'
58
-
59
- const result = await approval.requestApproval({
60
- title: 'Approve proposal before sending',
61
- context: { dealId, proposalUrl },
62
- })
63
-
64
- if (result.approved) {
65
- // continue
66
- }
67
- ```
68
-
69
- > **SDK takeaway:** Use `approval.requestApproval()` to create approval gates that surface here. Provide rich `context` so reviewers have what they need to decide.
70
-
71
- ---
72
-
73
- ## Knowledge Base
74
-
75
- The Knowledge Base renders the `docs/` directory of your deployed workspace as browsable documentation.
76
-
77
- **What you can do here:**
78
-
79
- - Browse pages you created in `docs/*.mdx`
80
- - Search across all documentation
81
- - Share links to specific pages with team members
82
-
83
- **How it connects to your code:** Every `.mdx` file in your workspace's `docs/` directory is bundled at deploy time and rendered here. Pages appear in the order defined by their `order` frontmatter field.
84
-
85
- > **SDK takeaway:** Write `docs/*.mdx` pages for your team -- business process docs, schema references, usage guides. They appear here automatically after each deploy.
86
-
87
- ---
88
-
89
- ## Execution Logs
90
-
91
- The Execution Logs page shows the history of all executions across every deployed resource.
92
-
93
- **What you can do here:**
94
-
95
- - Search and filter by resource, status (completed/failed/running), date range
96
- - Click any execution to view full detail: input, output, step-level trace, duration
97
- - Identify failed executions and see error messages with stack traces
98
- - Navigate from a log entry directly to the resource in Command View
99
-
100
- **Filtering tips:**
101
-
102
- - Filter by resource name to debug a specific workflow
103
- - Filter by `failed` status to triage production issues
104
- - Use date range to narrow down incidents
105
-
106
- > **SDK takeaway:** Every `elevasis-sdk exec` and every scheduled run appears here. Use this page to verify behavior after deploy and to diagnose failures before opening code.
107
-
108
- ---
109
-
110
- ## Credentials
111
-
112
- The Credentials page manages encrypted API keys and OAuth tokens used by your workflows at runtime.
113
-
114
- **What you can do here:**
115
-
116
- - Create API key and webhook-secret credentials via a form
117
- - Connect OAuth providers (Notion, Google Sheets, Dropbox) via browser flow
118
- - View existing credentials (values are never shown after creation)
119
- - Delete credentials that are no longer needed
120
-
121
- **Two credential types:**
122
-
123
- | Type | Created via | Notes |
124
- | ------------------------ | -------------------------------------------- | ------------------------------------------------------ |
125
- | API key / webhook secret | CLI (`elevasis-sdk creds create`) or UI form | Either method works |
126
- | OAuth | UI only | Requires browser redirect -- cannot be created via CLI |
127
-
128
- **OAuth credentials require the UI.** When a workflow uses an OAuth-connected service, the user must complete the OAuth flow here first. The CLI `creds` skill handles API keys; redirect OAuth credential setup to this page.
129
-
130
- > **SDK takeaway:** Reference credentials in your code by name (`credential: 'my-cred-name'`). Create API keys via CLI or UI; OAuth credentials require this page.
131
-
132
- ---
133
-
134
- ## Deployments
135
-
136
- The Deployments page shows the history of all deployments for your organization.
137
-
138
- **What you can do here:**
139
-
140
- - View a chronological list of past deployments
141
- - See which resources changed in each deployment
142
- - Identify the currently active version
143
- - Compare resource counts across deployments
144
-
145
- **How it connects to your code:** Each `elevasis-sdk deploy` run creates a new deployment entry. The platform activates the new version atomically -- in-flight executions complete against the previous version while new executions start against the new one.
146
-
147
- > **SDK takeaway:** Check this page after `elevasis-sdk deploy` to confirm your resources are active. If something behaves unexpectedly, look here to confirm the latest version is live.
148
-
149
- ---
150
-
151
- **Last Updated:** 2026-03-03
1
+ ---
2
+ title: Command Center
3
+ description: Post-deployment UI reference -- what each page does, the resource graph model, relationships, validation, and how SDK concepts map to Command Center actions
4
+ loadWhen: "User asks about the Command Center UI, post-deployment workflow, monitoring, or the resource graph"
5
+ ---
6
+
7
+ The Command Center is the browser UI for interacting with deployed resources. After you run `elevasis-sdk deploy`, this is where you run workflows, monitor executions, manage approvals, schedule tasks, and review logs.
8
+
9
+ ---
10
+
11
+ ## Quick Reference
12
+
13
+ | Task | Page | Path |
14
+ | -------------------------------------------------- | -------------- | ----------------------- |
15
+ | Browse deployed resources, view the resource graph | Command View | `/command-view` |
16
+ | Approve or reject pending HITL requests | Command Queue | `/queue` |
17
+ | Browse deployed documentation | Knowledge Base | `/knowledge-base` |
18
+ | Search execution history across all resources | Execution Logs | `/logs` |
19
+ | Create API key and OAuth credentials | Credentials | `/settings/credentials` |
20
+ | View deployment history and active version | Deployments | `/settings/deployments` |
21
+
22
+ ---
23
+
24
+ ## Command View
25
+
26
+ The Command View is a visual graph of your deployed resources. Each node is a resource (workflow, agent, trigger, integration). Edges are the relationships you declared in `OrganizationResources`.
27
+
28
+ **What you can do here:**
29
+
30
+ - See all deployed resources at a glance
31
+ - Trace data flow between resources via declared relationships
32
+ - Identify which resources depend on which integrations
33
+ - Click a node to view resource details (ID, status, type)
34
+
35
+ ### Node Types
36
+
37
+ Every resource you deploy becomes a node in the graph. Some nodes are executable; others are visual-only.
38
+
39
+ **Executable nodes:**
40
+
41
+ | Type | What It Does | Deployed By |
42
+ | -------- | ------------------------------------------------- | --------------------- |
43
+ | Workflow | Runs step handlers in sequence or branching paths | `elevasis-sdk deploy` |
44
+ | Agent | Autonomous LLM-powered resource with tools | `elevasis-sdk deploy` |
45
+
46
+ **Visual-only nodes** (no runtime behavior -- exist for the graph):
47
+
48
+ | Type | What It Represents | Why It Exists |
49
+ | ----------------- | --------------------------------------------------- | --------------------------------------------- |
50
+ | Trigger | A webhook or schedule that starts a workflow | Shows how executions begin |
51
+ | Integration | A credential reference (provider + credential name) | Shows which external services a resource uses |
52
+ | External Resource | A third-party automation (n8n, Make, Zapier) | Documents automations outside the platform |
53
+ | Human Checkpoint | A point where a human makes a decision | Shows where HITL approval gates exist |
54
+
55
+ ### Relationships
56
+
57
+ Relationships are edges in the graph. Declare them in `OrganizationResources`:
58
+
59
+ ```typescript
60
+ const org: OrganizationResources = {
61
+ workflows: {
62
+ 'score-lead': scoreLeadWorkflow,
63
+ 'send-proposal': sendProposalWorkflow,
64
+ },
65
+ relationships: {
66
+ 'score-lead': {
67
+ triggers: {
68
+ workflows: ['send-proposal'],
69
+ },
70
+ uses: {
71
+ integrations: ['attio-integration'],
72
+ },
73
+ },
74
+ },
75
+ };
76
+ ```
77
+
78
+ | Field | Type | Meaning |
79
+ | -------------------- | ---------- | ------------------------------------- |
80
+ | `triggers.workflows` | `string[]` | Workflows this resource starts |
81
+ | `triggers.agents` | `string[]` | Agents this resource starts |
82
+ | `uses.integrations` | `string[]` | Integrations this resource depends on |
83
+
84
+ **Relationships are declarations, not routing.** Declaring that workflow A triggers workflow B does not route A's output to B -- your handler must explicitly invoke B via the `execution` adapter. The graph can drift from reality if declarations don't match code.
85
+
86
+ ### What Is Enforced vs Decorative
87
+
88
+ | Category | Validated at Deploy | Matches Runtime | Status |
89
+ | ---------------------------------------- | ---------------------------- | --------------- | -------------- |
90
+ | Resource IDs unique | Yes | Yes | **Enforced** |
91
+ | Input schema matches execution interface | Yes | Yes | **Enforced** |
92
+ | Relationship targets exist | Yes | No | **Decorative** |
93
+ | Trigger routing | No | No | **Decorative** |
94
+ | Tool availability per agent | No | No | **Decorative** |
95
+ | Model config | Yes (provider + model valid) | No | **Decorative** |
96
+
97
+ Keep relationships in sync with your handler code. When you add an `execution.trigger()` call, add the corresponding relationship declaration.
98
+
99
+ ### Deploy-Time Validation
100
+
101
+ `elevasis-sdk deploy` and `elevasis-sdk check` both validate:
102
+
103
+ - Duplicate resource IDs
104
+ - Relationship targets must exist in the same `OrganizationResources`
105
+ - Agent model params (provider, model name, temperature bounds)
106
+ - Workflow step chains (`next.target` must point to existing step names)
107
+
108
+ **Validation error examples:**
109
+
110
+ ```
111
+ ERROR Relationship target 'send-proposal' not found in organization resources
112
+ ERROR Duplicate resource ID 'score-lead' in organization
113
+ ```
114
+
115
+ ### Graph Serialization
116
+
117
+ The platform converts your definitions into `CommandViewNode` (one per resource) and `CommandViewEdge` (one per relationship) structures. `buildEdges()` reads your `relationships` declarations and produces edges as a pure transformation -- no runtime behavior is inferred.
118
+
119
+ > **SDK takeaway:** Declare relationships in `OrganizationResources` to keep the Command View accurate as your system grows. Update declarations whenever you add or remove `execution.trigger()` calls.
120
+
121
+ ---
122
+
123
+ ## Command Queue
124
+
125
+ The Command Queue surfaces all pending Human-in-the-Loop (HITL) approval requests from running workflows.
126
+
127
+ **What you can do here:**
128
+
129
+ - View pending approval requests with context provided by the workflow
130
+ - Filter by resource, status, or date
131
+ - Approve or reject with an optional comment
132
+ - See the history of past decisions
133
+
134
+ **How it connects to your code:** Approval requests appear when a workflow step calls `approval.requestApproval()`. The workflow pauses at that step and waits for a decision.
135
+
136
+ ```typescript
137
+ import { approval } from '@elevasis/sdk/worker'
138
+
139
+ const result = await approval.requestApproval({
140
+ title: 'Approve proposal before sending',
141
+ context: { dealId, proposalUrl },
142
+ })
143
+
144
+ if (result.approved) {
145
+ // continue
146
+ }
147
+ ```
148
+
149
+ > **SDK takeaway:** Use `approval.requestApproval()` to create approval gates. Provide rich `context` so reviewers have what they need to decide.
150
+
151
+ ---
152
+
153
+ ## Knowledge Base
154
+
155
+ The Knowledge Base renders the `docs/` directory of your deployed workspace as browsable documentation.
156
+
157
+ **What you can do here:**
158
+
159
+ - Browse pages you created in `docs/*.mdx`
160
+ - Search across all documentation
161
+ - Share links to specific pages with team members
162
+
163
+ **How it connects to your code:** Every `.mdx` file in your workspace's `docs/` directory is bundled at deploy time and rendered here.
164
+
165
+ > **SDK takeaway:** Write `docs/*.mdx` pages for your team -- business process docs, schema references, usage guides. They appear here automatically after each deploy.
166
+
167
+ ---
168
+
169
+ ## Execution Logs
170
+
171
+ The Execution Logs page shows the history of all executions across every deployed resource.
172
+
173
+ **What you can do here:**
174
+
175
+ - Search and filter by resource, status (completed/failed/running), date range
176
+ - Click any execution to view full detail: input, output, step-level trace, duration
177
+ - Identify failed executions and see error messages with stack traces
178
+ - Navigate from a log entry directly to the resource in Command View
179
+
180
+ **Filtering tips:**
181
+
182
+ - Filter by resource name to debug a specific workflow
183
+ - Filter by `failed` status to triage production issues
184
+ - Use date range to narrow down incidents
185
+
186
+ > **SDK takeaway:** Every `elevasis-sdk exec` and every scheduled run appears here. Use this page to verify behavior after deploy and to diagnose failures before opening code.
187
+
188
+ ---
189
+
190
+ ## Credentials
191
+
192
+ The Credentials page manages encrypted API keys and OAuth tokens used by your workflows at runtime.
193
+
194
+ **What you can do here:**
195
+
196
+ - Create API key and webhook-secret credentials via a form
197
+ - Connect OAuth providers (Notion, Google Sheets, Dropbox) via browser flow
198
+ - View existing credentials (values are never shown after creation)
199
+ - Delete credentials that are no longer needed
200
+
201
+ **Two credential types:**
202
+
203
+ | Type | Created via | Notes |
204
+ | ------------------------ | -------------------------------------------- | ------------------------------------------------------ |
205
+ | API key / webhook secret | CLI (`elevasis-sdk creds create`) or UI form | Either method works |
206
+ | OAuth | UI only | Requires browser redirect -- cannot be created via CLI |
207
+
208
+ > **SDK takeaway:** Reference credentials in your code by name (`credential: 'my-cred-name'`). Create API keys via CLI or UI; OAuth credentials require this page.
209
+
210
+ ---
211
+
212
+ ## Deployments
213
+
214
+ The Deployments page shows the history of all deployments for your organization.
215
+
216
+ **What you can do here:**
217
+
218
+ - View a chronological list of past deployments
219
+ - See which resources changed in each deployment
220
+ - Identify the currently active version
221
+ - Compare resource counts across deployments
222
+
223
+ **How it connects to your code:** Each `elevasis-sdk deploy` run creates a new deployment entry. The platform activates the new version atomically -- in-flight executions complete against the previous version while new executions start against the new one.
224
+
225
+ > **SDK takeaway:** Check this page after `elevasis-sdk deploy` to confirm your resources are active.
226
+
227
+ ---
228
+
229
+ **Last Updated:** 2026-03-06