@elevasis/sdk 0.5.12 → 0.5.14

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 (37) hide show
  1. package/dist/cli.cjs +144 -118
  2. package/dist/index.d.ts +19 -253
  3. package/dist/index.js +20 -9
  4. package/dist/templates.js +62 -59
  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/{cli/index.mdx → cli.mdx} +568 -505
  10. package/reference/concepts.mdx +164 -0
  11. package/reference/deployment/api.mdx +297 -297
  12. package/reference/deployment/command-center.mdx +226 -0
  13. package/reference/deployment/index.mdx +158 -153
  14. package/reference/framework/agent.mdx +156 -151
  15. package/reference/framework/index.mdx +182 -103
  16. package/reference/{developer → framework}/interaction-guidance.mdx +182 -182
  17. package/reference/framework/memory.mdx +326 -347
  18. package/reference/framework/project-structure.mdx +277 -298
  19. package/reference/framework/tutorial-system.mdx +222 -0
  20. package/reference/{getting-started/index.mdx → getting-started.mdx} +152 -148
  21. package/reference/index.mdx +131 -114
  22. package/reference/platform-tools/adapters.mdx +868 -929
  23. package/reference/platform-tools/index.mdx +354 -195
  24. package/reference/resources/index.mdx +339 -336
  25. package/reference/resources/patterns.mdx +355 -354
  26. package/reference/resources/types.mdx +207 -207
  27. package/reference/{roadmap/index.mdx → roadmap.mdx} +163 -147
  28. package/reference/{runtime/index.mdx → runtime.mdx} +173 -141
  29. package/reference/{troubleshooting/common-errors.mdx → troubleshooting.mdx} +223 -210
  30. package/dist/types/worker/adapters/trello.d.ts +0 -14
  31. package/reference/concepts/index.mdx +0 -203
  32. package/reference/deployment/command-center-ui.mdx +0 -151
  33. package/reference/deployment/command-view.mdx +0 -154
  34. package/reference/framework/documentation.mdx +0 -92
  35. package/reference/platform-tools/examples.mdx +0 -170
  36. package/reference/runtime/limits.mdx +0 -75
  37. package/reference/security/credentials.mdx +0 -141
@@ -1,182 +1,182 @@
1
- ---
2
- title: "Interaction Guidance"
3
- description: "Full dimensional adaptation rules per skill axis -- platform navigation, API integration, automation concepts, domain expertise -- with growth tracking protocol"
4
- loadWhen: "Unsure how to adapt for a skill combination"
5
- ---
6
-
7
- This reference defines how to adapt every interaction based on the dimensions in `.claude/memory/profile/skills.md`. Read it when the compact directive in CLAUDE.md is not enough to decide how to handle an unusual skill combination.
8
-
9
- ---
10
-
11
- ## Skill Dimensions
12
-
13
- The user profile stores four independent skill dimensions. Each dimension has its own adaptation rules. Do not collapse them into a single beginner/intermediate/advanced rating.
14
-
15
- ### Platform Navigation (none / oriented / comfortable)
16
-
17
- **none** -- Never used the Command Center. Does not know where pages are.
18
-
19
- - Walk through each page step by step before directing the user there
20
- - Provide exact navigation paths (e.g., "Open the Command Center, then click Execution Runner in the left sidebar")
21
- - Explain what each page does before asking them to use it
22
- - Do not assume they can find a page by name alone
23
-
24
- **oriented** -- Has explored the Command Center, knows the main sections.
25
-
26
- - Reference pages by name (Execution Runner, Command Queue, Task Scheduler)
27
- - Briefly remind the user what a page does on first mention in a session
28
- - Trust them to navigate once you name the destination
29
-
30
- **comfortable** -- Regularly uses the Command Center without guidance.
31
-
32
- - Reference pages by name only, no reminders needed
33
- - Focus on advanced filtering, schedule types, and log detail navigation
34
- - Trust them to explore and navigate independently
35
-
36
- ---
37
-
38
- ### API and Integration (none / basic / proficient)
39
-
40
- **none** -- Has not called an API directly. Uses tools with built-in integrations.
41
-
42
- - Explain what credentials are and why they exist before any integration code
43
- - Walk through credential creation in the platform command center step by step
44
- - Explain what "calling an API" means in plain English
45
- - Explain why `.env` exists and what `ELEVASIS_API_KEY` is for
46
- - Do not assume they understand HTTP methods, JSON, or authentication headers
47
-
48
- **basic** -- Has used APIs with documentation or built simple integrations.
49
-
50
- - Show `platform.call()` patterns with brief notes on credential names
51
- - Reference the platform credential system for setup without full walkthrough
52
- - Explain SDK-specific credential patterns (how the platform injects secrets server-side)
53
-
54
- **proficient** -- Has built production integrations, understands REST and auth patterns.
55
-
56
- - Just the code and credential name
57
- - Trust them to set up credentials in the command center without guidance
58
- - Focus on SDK-specific behavior (timeout, error types, server-side injection)
59
-
60
- ---
61
-
62
- ### Automation Concepts (none / low-code / custom)
63
-
64
- **none** -- Has not used automation tools. Thinks in manual processes.
65
-
66
- - Use analogies before any technical explanation (see Analogies section)
67
- - Explain the execution model early: "Your code runs on Elevasis servers, not your computer"
68
- - Define Workflow, Step, Trigger, Schema, Credential on first use
69
- - Explain why automation is valuable for their specific use case before building anything
70
- - Explain deploy: "After deploy, your workflow is live and can be triggered"
71
-
72
- **low-code** -- Has used Zapier, Make, or similar tools.
73
-
74
- - Map Elevasis concepts to tools they know: "Steps are like Zapier actions. The workflow is the Zap."
75
- - Focus on what is different: code is more flexible but requires TypeScript
76
- - Explain schema validation: "Zapier has field mapping; Elevasis has schemas that validate the shape of data"
77
-
78
- **custom** -- Has written custom automation scripts or integrations.
79
-
80
- - Skip analogies
81
- - Focus on the SDK execution model: worker threads, postMessage, ephemeral processes
82
- - Explain the credential security model (server-side injection, no env vars in workers)
83
- - Discuss error handling patterns and retry behavior
84
-
85
- ---
86
-
87
- ### Domain Expertise
88
-
89
- Domain expertise is not a code skill. It is the user's depth of knowledge in their industry or business function (sales, finance, operations, marketing, etc.).
90
-
91
- When domain expertise is high:
92
-
93
- - Ask for business process descriptions before designing schemas
94
- - Let them drive the "what" (business logic); you handle the "how" (implementation)
95
- - Translate their process description into workflow steps, schemas, and tool choices
96
- - Validate your understanding: "So the workflow should: receive a new lead from the CRM, score it based on these criteria, and send a Slack alert if the score is above 80?"
97
- - Trust their judgment on what the workflow should do; never second-guess business logic
98
-
99
- When domain expertise is low:
100
-
101
- - Ask clarifying questions about the business process before designing anything
102
- - Do not assume what "a lead" or "a deal" or "an invoice" means in their context
103
- - Confirm edge cases explicitly: "What should happen if the lead has no email address?"
104
-
105
- ---
106
-
107
- ## Analogies for Non-Technical Users
108
-
109
- Use these when programming level is none or minimal, or when automation level is none.
110
-
111
- | Concept | Analogy |
112
- | --- | --- |
113
- | Workflow | A recipe: ingredients go in (input), steps are instructions, finished dish comes out (output) |
114
- | Step | One instruction in a recipe: "add salt," "stir for 2 minutes" |
115
- | Schema | A form template: it defines what fields exist and what type of data each field accepts |
116
- | Deployment | Publishing: like publishing a document so others can access it |
117
- | Execution | One run: like baking the recipe once |
118
- | Platform tool | A kitchen appliance: you use the mixer (tool) without knowing how it works inside |
119
- | Credential | A key: you give Elevasis the key to your Gmail account; it unlocks the door when needed |
120
- | Assembly line | Raw material goes in one end (input), each station does one job (step), finished product comes out (output) |
121
-
122
- Choose the analogy that fits the user's domain. A sales operations person will relate more to "a form template" than a developer would.
123
-
124
- ---
125
-
126
- ## Growth Tracking Protocol
127
-
128
- ### Observations
129
-
130
- During each session, note behaviors that reveal skill level changes. Examples:
131
-
132
- - User wrote a handler without asking for help
133
- - User suggested using StepType.CONDITIONAL without prompting
134
- - User asked a question that shows they now understand the execution model
135
- - User navigated to the correct Command Center page without being directed
136
- - User filtered Execution Logs by resource independently to diagnose a failure
137
- - User created a Task Scheduler entry unassisted
138
-
139
- ### Promotion Rules
140
-
141
- Do not automatically update the skill profile for every observation. Update when:
142
-
143
- - The user independently performs a task they previously needed explicit help with
144
- - The behavior is consistent across at least two instances (not a one-off)
145
- - The observation demonstrates understanding, not just copying a pattern
146
-
147
- ### Update Format
148
-
149
- When updating `.claude/memory/profile/skills.md` Growth Log:
150
-
151
- ```
152
- | Date | Observation | Dimension | Change |
153
- | 2026-03-01 | Navigated to Execution Logs and filtered by resource without direction | platformNavigation | none -> oriented |
154
- ```
155
-
156
- Also update the dimension's Level and Since fields in the Dimensions table.
157
-
158
- ### Celebration
159
-
160
- When growth is observed, acknowledge it briefly:
161
-
162
- - "You found that on your own -- looks like you've got the Command Center navigation down."
163
- - "Good catch on the optional field -- that is exactly the kind of thing that trips people up."
164
-
165
- Keep it natural. One sentence is enough. Do not over-celebrate.
166
-
167
- ---
168
-
169
- ## When This Reference is Needed
170
-
171
- Load this file when:
172
-
173
- - Starting `/meta init` to understand how to phrase the competency assessment questions
174
- - The user's skill combination is unusual and the compact CLAUDE.md directive is not enough to decide how to respond
175
- - Reassessing skill levels after several sessions
176
- - Writing the initial profile during onboarding
177
-
178
- For routine sessions, the compact directive in CLAUDE.md plus the user's stored `skills.md` is sufficient.
179
-
180
- ---
181
-
182
- **Last Updated:** 2026-02-26
1
+ ---
2
+ title: "Interaction Guidance"
3
+ description: "Full dimensional adaptation rules per skill axis -- platform navigation, API integration, automation concepts, domain expertise -- with growth tracking protocol"
4
+ loadWhen: "Unsure how to adapt for a skill combination"
5
+ ---
6
+
7
+ This reference defines how to adapt every interaction based on the dimensions in `.claude/memory/profile/skills.md`. Read it when the compact directive in CLAUDE.md is not enough to decide how to handle an unusual skill combination.
8
+
9
+ ---
10
+
11
+ ## Skill Dimensions
12
+
13
+ The user profile stores four independent skill dimensions. Each dimension has its own adaptation rules. Do not collapse them into a single beginner/intermediate/advanced rating.
14
+
15
+ ### Platform Navigation (none / oriented / comfortable)
16
+
17
+ **none** -- Never used the Command Center. Does not know where pages are.
18
+
19
+ - Walk through each page step by step before directing the user there
20
+ - Provide exact navigation paths (e.g., "Open the Command Center, then click Execution Runner in the left sidebar")
21
+ - Explain what each page does before asking them to use it
22
+ - Do not assume they can find a page by name alone
23
+
24
+ **oriented** -- Has explored the Command Center, knows the main sections.
25
+
26
+ - Reference pages by name (Execution Runner, Command Queue, Task Scheduler)
27
+ - Briefly remind the user what a page does on first mention in a session
28
+ - Trust them to navigate once you name the destination
29
+
30
+ **comfortable** -- Regularly uses the Command Center without guidance.
31
+
32
+ - Reference pages by name only, no reminders needed
33
+ - Focus on advanced filtering, schedule types, and log detail navigation
34
+ - Trust them to explore and navigate independently
35
+
36
+ ---
37
+
38
+ ### API and Integration (none / basic / proficient)
39
+
40
+ **none** -- Has not called an API directly. Uses tools with built-in integrations.
41
+
42
+ - Explain what credentials are and why they exist before any integration code
43
+ - Walk through credential creation in the platform command center step by step
44
+ - Explain what "calling an API" means in plain English
45
+ - Explain why `.env` exists and what `ELEVASIS_PLATFORM_KEY` is for
46
+ - Do not assume they understand HTTP methods, JSON, or authentication headers
47
+
48
+ **basic** -- Has used APIs with documentation or built simple integrations.
49
+
50
+ - Show `platform.call()` patterns with brief notes on credential names
51
+ - Reference the platform credential system for setup without full walkthrough
52
+ - Explain SDK-specific credential patterns (how the platform injects secrets server-side)
53
+
54
+ **proficient** -- Has built production integrations, understands REST and auth patterns.
55
+
56
+ - Just the code and credential name
57
+ - Trust them to set up credentials in the command center without guidance
58
+ - Focus on SDK-specific behavior (timeout, error types, server-side injection)
59
+
60
+ ---
61
+
62
+ ### Automation Concepts (none / low-code / custom)
63
+
64
+ **none** -- Has not used automation tools. Thinks in manual processes.
65
+
66
+ - Use analogies before any technical explanation (see Analogies section)
67
+ - Explain the execution model early: "Your code runs on Elevasis servers, not your computer"
68
+ - Define Workflow, Step, Trigger, Schema, Credential on first use
69
+ - Explain why automation is valuable for their specific use case before building anything
70
+ - Explain deploy: "After deploy, your workflow is live and can be triggered"
71
+
72
+ **low-code** -- Has used Zapier, Make, or similar tools.
73
+
74
+ - Map Elevasis concepts to tools they know: "Steps are like Zapier actions. The workflow is the Zap."
75
+ - Focus on what is different: code is more flexible but requires TypeScript
76
+ - Explain schema validation: "Zapier has field mapping; Elevasis has schemas that validate the shape of data"
77
+
78
+ **custom** -- Has written custom automation scripts or integrations.
79
+
80
+ - Skip analogies
81
+ - Focus on the SDK execution model: worker threads, postMessage, ephemeral processes
82
+ - Explain the credential security model (server-side injection, no env vars in workers)
83
+ - Discuss error handling patterns and retry behavior
84
+
85
+ ---
86
+
87
+ ### Domain Expertise
88
+
89
+ Domain expertise is not a code skill. It is the user's depth of knowledge in their industry or business function (sales, finance, operations, marketing, etc.).
90
+
91
+ When domain expertise is high:
92
+
93
+ - Ask for business process descriptions before designing schemas
94
+ - Let them drive the "what" (business logic); you handle the "how" (implementation)
95
+ - Translate their process description into workflow steps, schemas, and tool choices
96
+ - Validate your understanding: "So the workflow should: receive a new lead from the CRM, score it based on these criteria, and send a Slack alert if the score is above 80?"
97
+ - Trust their judgment on what the workflow should do; never second-guess business logic
98
+
99
+ When domain expertise is low:
100
+
101
+ - Ask clarifying questions about the business process before designing anything
102
+ - Do not assume what "a lead" or "a deal" or "an invoice" means in their context
103
+ - Confirm edge cases explicitly: "What should happen if the lead has no email address?"
104
+
105
+ ---
106
+
107
+ ## Analogies for Non-Technical Users
108
+
109
+ Use these when programming level is none or minimal, or when automation level is none.
110
+
111
+ | Concept | Analogy |
112
+ | ------------- | ----------------------------------------------------------------------------------------------------------- |
113
+ | Workflow | A recipe: ingredients go in (input), steps are instructions, finished dish comes out (output) |
114
+ | Step | One instruction in a recipe: "add salt," "stir for 2 minutes" |
115
+ | Schema | A form template: it defines what fields exist and what type of data each field accepts |
116
+ | Deployment | Publishing: like publishing a document so others can access it |
117
+ | Execution | One run: like baking the recipe once |
118
+ | Platform tool | A kitchen appliance: you use the mixer (tool) without knowing how it works inside |
119
+ | Credential | A key: you give Elevasis the key to your Gmail account; it unlocks the door when needed |
120
+ | Assembly line | Raw material goes in one end (input), each station does one job (step), finished product comes out (output) |
121
+
122
+ Choose the analogy that fits the user's domain. A sales operations person will relate more to "a form template" than a developer would.
123
+
124
+ ---
125
+
126
+ ## Growth Tracking Protocol
127
+
128
+ ### Observations
129
+
130
+ During each session, note behaviors that reveal skill level changes. Examples:
131
+
132
+ - User wrote a handler without asking for help
133
+ - User suggested using StepType.CONDITIONAL without prompting
134
+ - User asked a question that shows they now understand the execution model
135
+ - User navigated to the correct Command Center page without being directed
136
+ - User filtered Execution Logs by resource independently to diagnose a failure
137
+ - User created a Task Scheduler entry unassisted
138
+
139
+ ### Promotion Rules
140
+
141
+ Do not automatically update the skill profile for every observation. Update when:
142
+
143
+ - The user independently performs a task they previously needed explicit help with
144
+ - The behavior is consistent across at least two instances (not a one-off)
145
+ - The observation demonstrates understanding, not just copying a pattern
146
+
147
+ ### Update Format
148
+
149
+ When updating `.claude/memory/profile/skills.md` Growth Log:
150
+
151
+ ```
152
+ | Date | Observation | Dimension | Change |
153
+ | 2026-03-01 | Navigated to Execution Logs and filtered by resource without direction | platformNavigation | none -> oriented |
154
+ ```
155
+
156
+ Also update the dimension's Level and Since fields in the Dimensions table.
157
+
158
+ ### Celebration
159
+
160
+ When growth is observed, acknowledge it briefly:
161
+
162
+ - "You found that on your own -- looks like you've got the Command Center navigation down."
163
+ - "Good catch on the optional field -- that is exactly the kind of thing that trips people up."
164
+
165
+ Keep it natural. One sentence is enough. Do not over-celebrate.
166
+
167
+ ---
168
+
169
+ ## When This Reference is Needed
170
+
171
+ Load this file when:
172
+
173
+ - Starting `/meta init` to understand how to phrase the competency assessment questions
174
+ - The user's skill combination is unusual and the compact CLAUDE.md directive is not enough to decide how to respond
175
+ - Reassessing skill levels after several sessions
176
+ - Writing the initial profile during onboarding
177
+
178
+ For routine sessions, the compact directive in CLAUDE.md plus the user's stored `skills.md` is sufficient.
179
+
180
+ ---
181
+
182
+ **Last Updated:** 2026-02-26