@elevasis/sdk 1.0.2 → 1.2.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 +704 -3568
- package/dist/index.d.ts +316 -135
- package/package.json +1 -7
- package/reference/_navigation.md +1 -1
- package/reference/cli.mdx +2 -113
- package/reference/deployment/index.mdx +1 -1
- package/reference/framework/index.mdx +10 -0
- package/reference/framework/project-structure.mdx +2 -3
- package/reference/framework/tutorial-system.mdx +2 -2
- package/reference/getting-started.mdx +1 -11
- package/reference/index.mdx +16 -1
- package/reference/platform-tools/index.mdx +3 -3
- package/reference/platform-tools/type-safety.mdx +2 -2
- package/reference/templates/index.mdx +3 -3
- package/reference/troubleshooting.mdx +4 -4
- package/dist/templates.js +0 -2253
- package/dist/types/templates.d.ts +0 -2
|
@@ -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
|
|
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.
|
|
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
|
|
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:
|
|
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
|
|
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:
|
package/reference/index.mdx
CHANGED
|
@@ -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-
|
|
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
|
-
|
|
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
|
|
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
|
-
###
|
|
28
|
+
### Tomba Adapter — `domain` and `email`
|
|
29
29
|
|
|
30
|
-
`domain` is required on `
|
|
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:
|
|
3
|
-
description:
|
|
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
|
|
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.
|
|
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
|