@elevasis/sdk 0.4.5 → 0.4.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elevasis/sdk",
-  "version": "0.4.5",
+  "version": "0.4.7",
   "description": "SDK for building Elevasis organization resources",
   "comment:bin": "IMPORTANT: This package shares the 'elevasis' binary name with @repo/cli. They never conflict because @elevasis/sdk must NEVER be added as a dependency of any workspace package (apps/*, packages/*, organizations/*). Workspace projects use @repo/cli for the 'elevasis' binary. External developers (outside the workspace) get this SDK's binary via npm install.",
   "type": "module",
@@ -16,6 +16,10 @@
     "./worker": {
       "types": "./dist/types/worker/index.d.ts",
       "import": "./dist/worker/index.js"
+    },
+    "./templates": {
+      "types": "./dist/types/templates.d.ts",
+      "import": "./dist/templates.js"
     }
   },
   "files": [
@@ -24,10 +28,13 @@
     "dist/worker/index.js",
     "dist/types/worker/index.d.ts",
     "dist/types/worker/platform.d.ts",
-    "dist/cli.cjs"
+    "dist/cli.cjs",
+    "dist/templates.js",
+    "dist/types/templates.d.ts",
+    "reference/"
   ],
   "scripts": {
-    "build": "node -e \"require('fs').rmSync('dist',{recursive:true,force:true})\" && tsc -p tsconfig.core-dts.json && tsc -p tsconfig.build.json && tsup && rollup -c rollup.dts.config.mjs && esbuild src/cli/index.ts --bundle --platform=node --outfile=dist/cli.cjs --format=cjs --external:esbuild --external:jiti --banner:js=\"#!/usr/bin/env node\"",
+    "build": "node -e \"require('fs').rmSync('dist',{recursive:true,force:true})\" && tsc -p tsconfig.core-dts.json && tsc -p tsconfig.build.json && tsup && rollup -c rollup.dts.config.mjs && esbuild src/cli/index.ts --bundle --platform=node --outfile=dist/cli.cjs --format=cjs --external:esbuild --external:jiti --banner:js=\"#!/usr/bin/env node\" && node scripts/copy-reference-docs.mjs && node scripts/generate-navigation.mjs",
     "check-types": "tsc --noEmit",
     "test:bundle": "pnpm build && vitest run --config vitest.bundle.config.ts"
   },

package/reference/_index.md

@@ -0,0 +1,95 @@
+# SDK Reference Documentation
+
+29 pages bundled from the Elevasis documentation site.
+
+Browse these files for complete SDK reference including platform tools catalog,
+resource types, runtime limits, deployment details, and CLI commands.
+
+## Pages
+
+- **CLI Reference** -- `cli/index.mdx`
+  Full reference for every elevasis CLI command -- scaffold, validate, deploy, execute, and inspect resources
+
+- **Concepts Reference** -- `concepts/index.mdx`
+  Plain-English explanations of Elevasis SDK concepts -- glossary, workflow analogies, Zod schemas, execution model, platform tools, common errors, and design decisions
+
+- **Execution API** -- `deployment/api.mdx`
+  REST endpoints for executing resources, querying execution history, and managing deployments via the Elevasis external API
+
+- **Deploying Resources** -- `deployment/index.mdx`
+  How to deploy your Elevasis SDK resources to the platform using elevasis deploy, including configuration, validation, and environment setup
+
+- **Interaction Guidance** -- `developer/interaction-guidance.mdx`
+  Full dimensional adaptation rules per skill axis -- programming, TypeScript, API integration, automation concepts, domain expertise -- with growth tracking protocol
+
+- **Agent System** -- `framework/agent.mdx`
+  CLAUDE.md drives all agent behavior -- project instructions, slash commands, memory-based developer profile, and three-tier adaptive guidance
+
+- **Resource Documentation** -- `framework/documentation.mdx`
+  Write and deploy MDX documentation alongside your Elevasis resources
+
+- **Development Framework** -- `framework/index.mdx`
+  The SDK scaffolds a complete development environment for Claude Code -- project instructions, slash commands, cross-session memory, and template versioning
+
+- **Memory System** -- `framework/memory.mdx`
+  Cross-session project knowledge stored in .claude/memory/ -- deployment state, environment, decisions, and error patterns that persist between Claude Code sessions
+
+- **Project Structure** -- `framework/project-structure.mdx`
+  Each file scaffolded by elevasis init and its purpose in the development workflow
+
+- **Getting Started** -- `getting-started/index.mdx`
+  Install the Elevasis SDK, scaffold a project, and run your first deployment
+
+- **Elevasis SDK** -- `index.mdx`
+  Build and deploy workflows, agents, and resources with the Elevasis SDK
+
+- **Integration Examples** -- `platform-tools/examples.mdx`
+  Common platform.call() patterns for email, CRM, PDF, LLM inference, resource triggering, and storage
+
+- **Platform Tools** -- `platform-tools/index.mdx`
+  Access 70+ tools across integration adapters and platform services from your SDK workflows via platform.call()
+
+- **Writing Resources** -- `resources/index.mdx`
+  Guide to creating workflows and agents using WorkflowDefinition, AgentDefinition, and OrganizationResources with the Elevasis SDK
+
+- **Common Patterns** -- `resources/patterns.mdx`
+  Common resource patterns for Elevasis SDK developers -- sequential steps, conditional branching, platform tools, error handling, and resource status management
+
+- **SDK Types** -- `resources/types.mdx`
+  Complete type reference for @elevasis/sdk -- package exports, re-exported platform types, ElevasConfig interface, StepHandler context, and runtime values
+
+- **Roadmap** -- `roadmap/index.mdx`
+  Planned SDK features -- error taxonomy, retry semantics, circuit breaker, metrics, alerting, and resource lifecycle extensions
+
+- **Execution Runtime** -- `runtime/index.mdx`
+  How your code runs on the Elevasis platform -- execution lifecycle, concurrency, timeouts, cancellation, error handling, and observability
+
+- **Resource Limits & Quotas** -- `runtime/limits.mdx`
+  Memory limits, execution timeouts, scale quotas, networking constraints, and v1 platform limitations for SDK resources
+
+- **Credential Security** -- `security/credentials.mdx`
+  Three-layer credential model: platform tools (server-side injection), http tool (arbitrary APIs), getCredential() (explicit opt-in raw access) -- .env scope and security boundaries
+
+- **Template: Data Enrichment** -- `templates/data-enrichment.mdx`
+  LLM-powered enrichment of existing database records -- read rows, enrich each with an LLM, write results back to Supabase
+
+- **Template: Email Sender** -- `templates/email-sender.mdx`
+  Transactional email via Resend with template support -- send styled emails to one or multiple recipients
+
+- **Template: Lead Scorer** -- `templates/lead-scorer.mdx`
+  LLM-based lead scoring with Supabase storage -- receive a lead, score it with an LLM, store the result
+
+- **Template: PDF Generator** -- `templates/pdf-generator.mdx`
+  PDF generation from structured data with platform storage upload -- render a PDF from a template and upload to platform storage
+
+- **Template: Recurring Job** -- `templates/recurring-job.mdx`
+  Scheduler-triggered periodic workflow -- run a task on a schedule (daily, weekly, hourly, or custom cron)
+
+- **Template: Text Classifier** -- `templates/text-classifier.mdx`
+  Multi-label text classification with structured output -- classify text into predefined categories using an LLM with JSON output
+
+- **Template: Web Scraper** -- `templates/web-scraper.mdx`
+  Apify-based web scraper that stores results in Supabase -- fetch structured data from any website via Apify actors
+
+- **Common Errors** -- `troubleshooting/common-errors.mdx`
+  Static SDK-level error catalog -- CLI errors, deployment errors, schema validation, platform tool failures, and runtime errors with diagnostic steps

package/reference/_navigation.md

@@ -0,0 +1,104 @@
+# SDK Reference Navigation
+
+Auto-generated from reference file frontmatter. 29 files indexed.
+
+All paths are relative to `node_modules/@elevasis/sdk/reference/`.
+
+## General
+
+| Resource | Location | When to Load |
+| --- | --- | --- |
+| Elevasis SDK | `index.mdx` | First session or new to the SDK |
+
+## Cli
+
+| Resource | Location | When to Load |
+| --- | --- | --- |
+| CLI Reference | `cli/index.mdx` | Running CLI operations |
+
+## Concepts
+
+| Resource | Location | When to Load |
+| --- | --- | --- |
+| Concepts Reference | `concepts/index.mdx` | User asks what is or needs conceptual grounding |
+
+## Deployment
+
+| Resource | Location | When to Load |
+| --- | --- | --- |
+| Execution API | `deployment/api.mdx` | Calling the API directly or debugging API responses |
+| Deploying Resources | `deployment/index.mdx` | Preparing to deploy or debugging deploy failures |
+
+## Developer
+
+| Resource | Location | When to Load |
+| --- | --- | --- |
+| Interaction Guidance | `developer/interaction-guidance.mdx` | Unsure how to adapt for a skill combination |
+
+## Framework
+
+| Resource | Location | When to Load |
+| --- | --- | --- |
+| Agent System | `framework/agent.mdx` | Configuring agent behavior or capabilities |
+| Resource Documentation | `framework/documentation.mdx` | Writing or updating project documentation |
+| Development Framework | `framework/index.mdx` | Understanding the agent framework structure |
+| Memory System | `framework/memory.mdx` | Working with agent memory or session state |
+| Project Structure | `framework/project-structure.mdx` | Understanding scaffolded files or project layout |
+
+## Getting-started
+
+| Resource | Location | When to Load |
+| --- | --- | --- |
+| Getting Started | `getting-started/index.mdx` | Setting up a new project or onboarding |
+
+## Platform-tools
+
+| Resource | Location | When to Load |
+| --- | --- | --- |
+| Integration Examples | `platform-tools/examples.mdx` | Implementing a platform tool call in a workflow step |
+| Platform Tools | `platform-tools/index.mdx` | Connecting to external services |
+
+## Resources
+
+| Resource | Location | When to Load |
+| --- | --- | --- |
+| Writing Resources | `resources/index.mdx` | Building or modifying a workflow |
+| Common Patterns | `resources/patterns.mdx` | Building or modifying a workflow |
+| SDK Types | `resources/types.mdx` | Looking up type signatures or SDK exports |
+
+## Roadmap
+
+| Resource | Location | When to Load |
+| --- | --- | --- |
+| Roadmap | `roadmap/index.mdx` | Asking about future features or planned capabilities |
+
+## Runtime
+
+| Resource | Location | When to Load |
+| --- | --- | --- |
+| Execution Runtime | `runtime/index.mdx` | Debugging execution behavior or understanding the runtime model |
+| Resource Limits & Quotas | `runtime/limits.mdx` | Hitting resource limits or planning for scale |
+
+## Security
+
+| Resource | Location | When to Load |
+| --- | --- | --- |
+| Credential Security | `security/credentials.mdx` | Setting up integrations or configuring tool access |
+
+## Templates
+
+| Resource | Location | When to Load |
+| --- | --- | --- |
+| Template: Data Enrichment | `templates/data-enrichment.mdx` | Applying the data-enrichment workflow template |
+| Template: Email Sender | `templates/email-sender.mdx` | Applying the email-sender workflow template |
+| Template: Lead Scorer | `templates/lead-scorer.mdx` | Applying the lead-scorer workflow template |
+| Template: PDF Generator | `templates/pdf-generator.mdx` | Applying the pdf-generator workflow template |
+| Template: Recurring Job | `templates/recurring-job.mdx` | Applying the recurring-job workflow template |
+| Template: Text Classifier | `templates/text-classifier.mdx` | Applying the text-classifier workflow template |
+| Template: Web Scraper | `templates/web-scraper.mdx` | Applying the web-scraper workflow template |
+
+## Troubleshooting
+
+| Resource | Location | When to Load |
+| --- | --- | --- |
+| Common Errors | `troubleshooting/common-errors.mdx` | Debugging an unknown error not found in workspace memory |