@elevasis/sdk 1.0.2 → 1.1.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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@elevasis/sdk",
3
- "version": "1.0.2",
3
+ "version": "1.1.0",
4
4
  "description": "SDK for building Elevasis organization resources",
5
5
  "type": "module",
6
6
  "bin": {
@@ -14,10 +14,6 @@
14
14
  "./worker": {
15
15
  "types": "./dist/types/worker/index.d.ts",
16
16
  "import": "./dist/worker/index.js"
17
- },
18
- "./templates": {
19
- "types": "./dist/types/templates.d.ts",
20
- "import": "./dist/templates.js"
21
17
  }
22
18
  },
23
19
  "files": [
@@ -28,8 +24,6 @@
28
24
  "dist/types/worker/platform.d.ts",
29
25
  "dist/types/worker/adapters/",
30
26
  "dist/cli.cjs",
31
- "dist/templates.js",
32
- "dist/types/templates.d.ts",
33
27
  "reference/"
34
28
  ],
35
29
  "dependencies": {
@@ -8,7 +8,7 @@ All paths are relative to `node_modules/@elevasis/sdk/reference/`.
8
8
 
9
9
  | Resource | Location | Description | When to Load |
10
10
  | --- | --- | --- | --- |
11
- | CLI Reference | `cli.mdx` | Full reference for every elevasis-sdk CLI command -- scaffold, validate, deploy, execute, and inspect resources | Running CLI operations |
11
+ | CLI Reference | `cli.mdx` | Full reference for every elevasis-sdk CLI command -- validate, deploy, execute, and inspect resources | Running CLI operations |
12
12
  | Concepts Reference | `concepts.mdx` | Plain-English explanations of Elevasis SDK concepts -- glossary, workflow analogies, Zod schemas, execution model, platform tools, common errors, and design decisions | User asks what is or needs conceptual grounding |
13
13
  | Getting Started | `getting-started.mdx` | Install the Elevasis SDK, scaffold a project, and run your first deployment | Setting up a new project or onboarding |
14
14
  | Elevasis SDK | `index.mdx` | Build and deploy workflows, agents, and resources with the Elevasis SDK | First session or new to the SDK |
package/reference/cli.mdx CHANGED
@@ -1,10 +1,10 @@
1
1
  ---
2
2
  title: CLI Reference
3
- description: Full reference for every elevasis-sdk CLI command -- scaffold, validate, deploy, execute, and inspect resources
3
+ description: Full reference for every elevasis-sdk CLI command -- validate, deploy, execute, and inspect resources
4
4
  loadWhen: "Running CLI operations"
5
5
  ---
6
6
 
7
- The `elevasis-sdk` CLI is the primary interface for working with your Elevasis SDK project. Install it as part of `@elevasis/sdk` and use it to scaffold projects, validate resource definitions, deploy to the platform, and inspect execution history.
7
+ The `elevasis-sdk` CLI is the primary interface for working with your Elevasis SDK project. Install it as part of `@elevasis/sdk` and use it to validate resource definitions, deploy to the platform, and inspect execution history.
8
8
 
9
9
  **Installation:**
10
10
 
@@ -16,117 +16,6 @@ After installation, the `elevasis-sdk` binary is available in your project's `no
16
16
 
17
17
  ---
18
18
 
19
- ## elevasis-sdk init
20
-
21
- Scaffold a new Elevasis SDK project in the specified directory.
22
-
23
- **Synopsis:**
24
-
25
- ```
26
- elevasis-sdk init [directory]
27
- ```
28
-
29
- **Behavior:**
30
-
31
- - Derives the organization slug from the directory name
32
- - Checks for file conflicts before writing any files
33
- - Scaffolds project structure including `src/index.ts`, `elevasis.config.ts`, `package.json`, `tsconfig.json`, and a `CLAUDE.md` with CLI reference and SDK patterns
34
- - Non-interactive: all values are derived automatically
35
-
36
- **Flags:**
37
-
38
- | Flag | Description |
39
- | ------ | ------------------------------------------------- |
40
- | (none) | Uses current directory if no argument is provided |
41
-
42
- **Example:**
43
-
44
- ```bash
45
- elevasis-sdk init my-project
46
- ```
47
-
48
- You can also run `init` without a global install using `pnpm dlx`:
49
-
50
- ```bash
51
- pnpm dlx @elevasis/sdk init my-project
52
- ```
53
-
54
- ```
55
- Scaffolding my-project/...
56
-
57
- Created 30 files.
58
-
59
- Next steps:
60
- cd my-project
61
- pnpm install
62
- elevasis-sdk check
63
- ```
64
-
65
- ---
66
-
67
- ## elevasis-sdk update
68
-
69
- Update managed project files to the latest template version.
70
-
71
- **Synopsis:**
72
-
73
- ```
74
- elevasis-sdk update [--ui]
75
- ```
76
-
77
- **Behavior:**
78
-
79
- - Reads `elevasis.config.ts` to get the current `templateVersion` and compares it against the latest template version
80
- - If already up to date (and no `--ui` flag), exits early with a success message
81
- - For each managed file:
82
- - Missing files are written directly
83
- - `.gitignore` uses append-only merge -- new entries are added, existing entries are never removed
84
- - `elevasis.config.ts` gets only its `templateVersion` field updated
85
- - `CLAUDE.md` uses section-aware merge -- SDK-owned sections are replaced with the latest template, user-added sections are preserved
86
- - All other managed files are compared against the template and flagged for review if they differ
87
- - Pass `--ui` to scaffold a Vite + React UI app in `ui/` (can be combined with a version update or run independently)
88
-
89
- **Flags:**
90
-
91
- | Flag | Description |
92
- | ------ | --------------------------------------- |
93
- | `--ui` | Add a Vite + React UI scaffold in `ui/` |
94
-
95
- **Example output (version update):**
96
-
97
- ```
98
- $ elevasis-sdk update
99
-
100
- Updated @elevasis/sdk template v24 -> v27
101
-
102
- Added:
103
- .env.example
104
-
105
- Appended to .gitignore:
106
- ui/dist
107
-
108
- Needs agent review:
109
- tsconfig.json (differs from template)
110
-
111
- CLAUDE.md sections:
112
- updated: Commands
113
- updated: Skills
114
- preserved: Custom Workflows
115
-
116
- Run /meta update in Claude Code to merge flagged files.
117
- Or run /meta fix to verify and repair the full framework.
118
- ```
119
-
120
- **Example output (already up to date):**
121
-
122
- ```
123
- $ elevasis-sdk update
124
-
125
- Project is up to date (template version 27)
126
- ```
127
-
128
- ---
129
-
130
19
  ## elevasis-sdk check
131
20
 
132
21
  Validate all resource definitions in your project without deploying.
@@ -107,7 +107,7 @@ The CLI also accepts a `--api-url` flag on every command, which takes priority o
107
107
  ELEVASIS_PLATFORM_KEY=sk_***
108
108
  ```
109
109
 
110
- Place `.env` in your project root. The CLI reads it automatically. Never commit this file.
110
+ Place `.env` in your project root. The CLI walks up directories to find it, so running from subdirectories like `operations/` works automatically. Never commit this file.
111
111
 
112
112
  ---
113
113
 
@@ -179,4 +179,14 @@ Section templates by doc type:
179
179
 
180
180
  ---
181
181
 
182
+ ## Documentation
183
+
184
+ - [Project Structure](project-structure.mdx) - File-by-file walkthrough of every scaffolded file and its purpose
185
+ - [Agent System](agent.mdx) - CLAUDE.md sections, slash commands, developer profile, and adaptive guidance tiers
186
+ - [Memory System](memory.mdx) - Architecture, error tracking format, scaling rules, and maintenance guidelines
187
+ - [Interaction Guidance](interaction-guidance.mdx) - Dimensional adaptation rules per skill axis with growth tracking protocol
188
+ - [Tutorial System](tutorial-system.mdx) - 21-item tutorial menu, skill-adaptive lesson variants, and progress tracking
189
+
190
+ ---
191
+
182
192
  **Last Updated:** 2026-03-06
@@ -48,19 +48,18 @@ Cross-domain shared types and utilities. This directory starts empty (`.gitkeep`
48
48
 
49
49
  ### `elevasis.config.ts`
50
50
 
51
- Project-level configuration. The scaffolded file includes `templateVersion`, which tracks which template generation your project uses, plus commented-out options (`defaultStatus`, `dev.port`) so you can discover available settings without looking them up:
51
+ Project-level configuration. The scaffolded file includes commented-out options (`defaultStatus`, `dev.port`) so you can discover available settings without looking them up:
52
52
 
53
53
  ```ts
54
54
  import type { ElevasConfig } from '@elevasis/sdk'
55
55
 
56
56
  export default {
57
- templateVersion: 28,
58
57
  // defaultStatus: 'dev', // Default status for new resources ('dev' | 'prod')
59
58
  // dev: { port: 5170 }, // Local API port (internal development only)
60
59
  } satisfies ElevasConfig
61
60
  ```
62
61
 
63
- Leave this file minimal -- the platform provides sensible defaults. Do not remove `templateVersion`; it is read by `elevasis-sdk update` to determine which template changes need to be applied to your project.
62
+ Leave this file minimal -- the platform provides sensible defaults.
64
63
 
65
64
  ---
66
65
 
@@ -3,7 +3,7 @@ title: Tutorial System
3
3
  description: Reference for the SDK tutorial system -- 21-item menu across 4 sections, skill-level adaptation rules, progress tracking format, and per-lesson module contents
4
4
  ---
5
5
 
6
- The tutorial system is available via the `/tutorial` slash command in Claude Code. It is scaffolded by `elevasis-sdk init` and updated by `elevasis-sdk update`.
6
+ The tutorial system is available via the `/tutorial` slash command in Claude Code. It is included in the external template project scaffold.
7
7
 
8
8
  ---
9
9
 
@@ -179,7 +179,7 @@ Modules are available any time -- no core path prerequisite. After completing a
179
179
 
180
180
  - `none` -- "SDK releases automatically update your workspace." Explain `/meta fix` as the update command.
181
181
  - `low-code` -- Explain MANAGED vs INIT_ONLY file types. Show how `/meta fix` handles conflicts.
182
- - `custom` -- Full template lifecycle: init (writes all files), update (applies MANAGED changes, flags conflicts, preserves INIT_ONLY), fix (drift repair + SDK upgrade offer). Conflict resolution reads current + template from `@elevasis/sdk/templates`, merges preserving customizations.
182
+ - `custom` -- Full template lifecycle: the external template handles initial project creation. `/meta fix` performs drift repair and SDK upgrade. Conflict resolution merges current files against the template, preserving customizations in INIT_ONLY files.
183
183
 
184
184
  ---
185
185
 
@@ -57,7 +57,7 @@ my-project/
57
57
  │ ├── index.mdx # Starter documentation page
58
58
  │ └── in-progress/
59
59
  │ └── .gitkeep # Work-in-progress docs directory
60
- ├── elevasis.config.ts # Config with templateVersion and options
60
+ ├── elevasis.config.ts # Config with workspace options
61
61
  ├── package.json # check-types + deploy scripts
62
62
  ├── tsconfig.json # TypeScript config (app-focused)
63
63
  ├── pnpm-workspace.yaml # Standalone project workspace
@@ -66,16 +66,6 @@ my-project/
66
66
  └── .gitignore # Excludes worker temp file, claude files
67
67
  ```
68
68
 
69
- The scaffolded `elevasis.config.ts` includes a `templateVersion` field that tracks which template generation your project uses. Leave it as-is -- it is managed automatically by `elevasis-sdk update`:
70
-
71
- ```ts
72
- import type { ElevasConfig } from '@elevasis/sdk'
73
-
74
- export default {
75
- templateVersion: 27,
76
- } satisfies ElevasConfig
77
- ```
78
-
79
69
  ### Set Up Your API Key
80
70
 
81
71
  Open `.env` and set your API key:
@@ -8,6 +8,8 @@ loadWhen: "First session or new to the SDK"
8
8
 
9
9
  Workflows are step-based automations with typed inputs and outputs. Agents are autonomous AI resources with access to platform tools. Both are defined in TypeScript, exported from a single entry point, and deployed with `elevasis-sdk deploy`. Resources appear in AI Studio immediately after a successful deploy.
10
10
 
11
+ The SDK ships with a full CLI (`elevasis-sdk`) for validation, deployment, execution, and inspection. Platform tools expose 70+ integrations across 12 adapters -- Gmail, Stripe, Google Sheets, Attio, and more -- with credentials managed server-side so API keys never cross the execution boundary.
12
+
11
13
  ## Quick Start
12
14
 
13
15
  ```bash
@@ -75,9 +77,22 @@ See [Platform Tools](platform-tools/index.mdx) for the full catalog.
75
77
  ### Framework
76
78
 
77
79
  - [Development Framework](framework/index.mdx) - How Claude Code helps you build: project structure, agent integration, memory, and documentation
80
+ - [Project Structure](framework/project-structure.mdx) - Scaffolded file layout, domain barrels, src/index.ts entry point, and config files
81
+ - [Agent Configuration](framework/agent.mdx) - Agent capabilities, tool access, model config, and Claude Code integration patterns
82
+ - [Memory](framework/memory.mdx) - Agent memory system, session state, developer profiles, and workspace conventions
78
83
  - [Interaction Guidance](framework/interaction-guidance.mdx) - Skill dimension adaptation rules for platform navigation, API integration, and automation concepts
79
84
  - [Tutorial System](framework/tutorial-system.mdx) - 21-item tutorial menu, skill-adaptive lesson variants, progress tracking, and module contents
80
85
 
86
+ ### Resources Subpages
87
+
88
+ - [SDK Types](resources/types.mdx) - Complete type reference for `@elevasis/sdk` exports, config fields, and step handler context
89
+ - [Common Patterns](resources/patterns.mdx) - Sequential steps, conditional branching, error handling, and resource status patterns
90
+
91
+ ### Deployment Subpages
92
+
93
+ - [Command Center](deployment/command-center.mdx) - Resource graph, relationships, node types, and post-deployment UI reference
94
+ - [Execution API](deployment/api.mdx) - REST endpoints for executing resources and managing deployments
95
+
81
96
  ### More
82
97
 
83
98
  - [Troubleshooting](troubleshooting.mdx) - Static error catalog for CLI, deployment, schema, and runtime failures
@@ -85,4 +100,4 @@ See [Platform Tools](platform-tools/index.mdx) for the full catalog.
85
100
 
86
101
  ---
87
102
 
88
- **Last Updated:** 2026-03-19
103
+ **Last Updated:** 2026-04-05
@@ -40,7 +40,7 @@ Both patterns return a Promise that resolves with the tool result or rejects wit
40
40
 
41
41
  ## Integration Adapters
42
42
 
43
- Twelve integration adapters give you access to 58+ tool methods covering third-party APIs. Pass the credential name once at adapter creation. Supabase is listed separately under [Database Access](#database-access) below.
43
+ Ten integration adapters give you access to 50+ tool methods covering third-party APIs. Pass the credential name once at adapter creation. Supabase is listed separately under [Database Access](#database-access) below.
44
44
 
45
45
  | Adapter | Tools | Credential Shape |
46
46
  | ------------- | ----------------------------- | ------------------------ |
@@ -54,7 +54,6 @@ Twelve integration adapters give you access to 58+ tool methods covering third-p
54
54
  | Resend | 2 (send/get email) | `{ apiKey }` |
55
55
  | Dropbox | 2 (upload/folder) | `{ accessToken }` |
56
56
  | Apify | 1 (run actor) | `{ token }` |
57
- | Mailso | 1 (verify email) | `{ apiKey }` |
58
57
 
59
58
  ## Credential Security
60
59
 
@@ -209,8 +208,9 @@ const qualified = await platform.call({
209
208
 
210
209
  ## Documentation
211
210
 
212
- - [Integration Adapters](adapters-integration.mdx) - All 12 integration adapters with method tables and code examples
211
+ - [Integration Adapters](adapters-integration.mdx) - All 10 integration adapters with method tables and code examples
213
212
  - [Platform Adapters](adapters-platform.mdx) - All 9 platform service adapters with method tables and code examples
213
+ - [Adapter Type Safety](type-safety.mdx) - Required fields, discriminated unions, and intentionally loose adapter types
214
214
 
215
215
  ---
216
216
 
@@ -25,9 +25,9 @@ await llm.generate({
25
25
  })
26
26
  ```
27
27
 
28
- ### Email Adapter — `domain` (AnyMailFinder)
28
+ ### Tomba Adapter — `domain` and `email`
29
29
 
30
- `domain` is required on `FindCompanyEmailParams` and `FindPersonEmailParams`. Previously all params were optional, allowing `findCompanyEmail({})` to compile but fail at runtime. The type change enforces the one field that is always necessary for email discovery.
30
+ `domain` is required on `TombaDomainSearchParams` and `TombaEmailFinderParams`. `email` is required on `TombaEmailVerifierParams`. Previously all params were optional, allowing calls to compile but fail at runtime. The type change enforces the fields that are always necessary for email discovery and verification.
31
31
 
32
32
  ---
33
33
 
@@ -11,17 +11,17 @@ All templates are available for any organization. Credentials specific to each t
11
11
 
12
12
  ## Documentation
13
13
 
14
- ### Data Collection
14
+ ### Data Collection & Processing
15
15
 
16
16
  - [Web Scraper](web-scraper.mdx) - Apify actor runs web scrape, stores structured results in Supabase table
17
17
  - [Data Enrichment](data-enrichment.mdx) - Reads Supabase records, enriches each with LLM, writes results back; supports batching
18
18
 
19
- ### Communication
19
+ ### Communication & CRM
20
20
 
21
21
  - [Email Sender](email-sender.mdx) - Transactional email via Resend with plain text and HTML support, single or multiple recipients
22
22
  - [Lead Scorer](lead-scorer.mdx) - Multi-criteria LLM lead scoring with configurable rubric and Supabase result storage
23
23
 
24
- ### Documents
24
+ ### Documents & AI
25
25
 
26
26
  - [PDF Generator](pdf-generator.mdx) - Renders structured data to PDF, uploads to platform storage, returns signed download URL
27
27
  - [Text Classifier](text-classifier.mdx) - Multi-label text classification via LLM structured output, configurable categories and confidence scoring
@@ -1,6 +1,6 @@
1
1
  ---
2
- title: "Common Errors"
3
- description: "Static SDK-level error catalog -- CLI errors, deployment errors, schema validation, platform tool failures, and runtime errors with diagnostic steps"
2
+ title: Common Errors
3
+ description: Static SDK-level error catalog -- CLI errors, deployment errors, schema validation, platform tool failures, and runtime errors with diagnostic steps
4
4
  loadWhen: "Debugging an unknown error not found in workspace memory"
5
5
  ---
6
6
 
@@ -16,9 +16,9 @@ This is the static SDK-level error catalog. Check `.claude/memory/errors/` first
16
16
 
17
17
  **Fix:**
18
18
 
19
- 1. Check that `.env` exists in the workspace root
19
+ 1. Check that `.env` exists in the project root (or any parent directory)
20
20
  2. Confirm it contains `ELEVASIS_PLATFORM_KEY=sk_...`
21
- 3. Make sure you are running the CLI from the workspace directory (where `.env` is located)
21
+ 3. The CLI walks up directories to find `.env`, so running from subdirectories like `operations/` works automatically
22
22
  4. If the file exists with the right content, run `elevasis-sdk check` again
23
23
 
24
24
  ### Cannot connect to API