skedyul 0.3.19 → 1.0.1

package/README.md

@@ -2,6 +2,10 @@
 
 The official Node.js SDK for building Skedyul integration apps. This package provides everything you need to create MCP (Model Context Protocol) servers, handle webhooks, manage lifecycle events, and interact with the Skedyul platform.
 
+## Version 1.0.0
+
+This release introduces a modular, file-based configuration system with improved type safety and developer experience.
+
 ## Features
 
 - **MCP Server**: Build tools that AI agents can invoke via the Model Context Protocol
@@ -9,6 +13,7 @@ The official Node.js SDK for building Skedyul integration apps. This package pro
 - **Lifecycle Hooks**: Handle app installation, provisioning, and cleanup
 - **Core API Client**: Interact with Skedyul resources (workplaces, channels, instances)
 - **CLI**: Develop and test locally with hot-reload and tunneling
+- **Modular Config**: File-based configuration with auto-discovery patterns
 
 ## Installation
 
@@ -25,17 +30,76 @@ pnpm add skedyul
 ```ts
 // skedyul.config.ts
 import { defineConfig } from 'skedyul'
+import pkg from './package.json'
 
 export default defineConfig({
-  name: 'my-integration',
-  version: '1.0.0',
+  name: 'My Integration',
+  version: pkg.version,
+  description: 'Description of what this app does',
   computeLayer: 'serverless',
-  tools: import('./src/tools/registry'),
-  webhooks: import('./src/webhooks/registry'),
+
+  tools: import('./src/registries'),
+  webhooks: import('./src/registries'),
+  provision: import('./provision'),
 })
 ```
 
-### 2. Define a tool
+### 2. Define your provision config
+
+```ts
+// provision.ts
+import type { ProvisionConfig } from 'skedyul'
+
+import env from './env'
+import { models, relationships } from './crm'
+import * as channels from './channels'
+import * as pages from './pages'
+import navigation from './pages/navigation'
+
+const config: ProvisionConfig = {
+  env,
+  navigation,
+  models: Object.values(models),
+  channels: Object.values(channels),
+  pages: Object.values(pages),
+  relationships,
+}
+
+export default config
+```
+
+### 3. Define a model
+
+```ts
+// crm/models/contact.ts
+import { defineModel } from 'skedyul'
+
+export default defineModel({
+  handle: 'contact',
+  label: 'Contact',
+  labelPlural: 'Contacts',
+  scope: 'shared',
+
+  fields: [
+    {
+      handle: 'name',
+      label: 'Name',
+      type: 'string',
+      required: true,
+      owner: 'workplace',
+    },
+    {
+      handle: 'email',
+      label: 'Email',
+      type: 'string',
+      required: false,
+      owner: 'workplace',
+    },
+  ],
+})
+```
+
+### 4. Define a tool
 
 ```ts
 // src/tools/hello.ts
@@ -65,7 +129,7 @@ export const helloTool: ToolDefinition<Input, Output> = {
 }
 ```
 
-### 3. Start the server
+### 5. Start the server
 
 ```ts
 // src/server.ts
@@ -95,6 +159,33 @@ await mcpServer.listen(3000)
 | [Configuration](./docs/configuration.md) | skedyul.config.ts reference |
 | [Errors](./docs/errors.md) | Error types and handling patterns |
 
+## Project Structure
+
+The recommended project structure uses modular, file-based configuration:
+
+```
+my-app/
+├── skedyul.config.ts          # App metadata + imports
+├── provision.ts               # Aggregates all modular configs
+├── env.ts                     # Environment variables
+├── crm/
+│   ├── index.ts               # Re-exports models + relationships
+│   ├── relationships.ts       # Model relationships
+│   └── models/
+│       ├── index.ts
+│       └── contact.ts
+├── channels/
+│   ├── index.ts
+│   └── phone.ts
+├── pages/
+│   ├── index.ts
+│   ├── navigation.ts          # Root navigation
+│   └── settings/
+│       └── page.ts
+└── src/
+    └── registries.ts          # Tools and webhooks
+```
+
 ## Server Modes
 
 ### Dedicated (Docker/ECS)

package/dist/.build-stamp

@@ -1 +1 @@
-1771899916059
+1771903579449

package/dist/config/index.d.ts

@@ -2,7 +2,7 @@
  * Config module - re-exports all config types and utilities.
  *
  * NAMING CONVENTIONS:
- * - All type literals use lowercase (e.g., 'string', 'internal', 'one-to-many')
+ * - All type literals use lowercase (e.g., 'string', 'internal', 'one_to_many')
  * - Use `handle` for unique identifiers (snake_case)
  * - Use `label` for display names (human-readable)
  * - Use `description` for optional explanatory text

package/dist/config/index.js

@@ -3,7 +3,7 @@
  * Config module - re-exports all config types and utilities.
  *
  * NAMING CONVENTIONS:
- * - All type literals use lowercase (e.g., 'string', 'internal', 'one-to-many')
+ * - All type literals use lowercase (e.g., 'string', 'internal', 'one_to_many')
  * - Use `handle` for unique identifiers (snake_case)
  * - Use `label` for display names (human-readable)
  * - Use `description` for optional explanatory text

package/dist/config/types/base.d.ts

@@ -4,7 +4,7 @@
  * ## NAMING CONVENTIONS
  *
  * ### Type Literals
- * All type literals use **lowercase** (e.g., 'string', 'internal', 'one-to-many').
+ * All type literals use **lowercase** (e.g., 'string', 'internal', 'one_to_many').
  * This is more modern, aligns with TypeScript conventions, and is easier to type.
  *
  * ### Identifiers

package/dist/config/types/base.js

@@ -5,7 +5,7 @@
  * ## NAMING CONVENTIONS
  *
  * ### Type Literals
- * All type literals use **lowercase** (e.g., 'string', 'internal', 'one-to-many').
+ * All type literals use **lowercase** (e.g., 'string', 'internal', 'one_to_many').
  * This is more modern, aligns with TypeScript conventions, and is easier to type.
  *
  * ### Identifiers

package/dist/config/types/form.d.ts

@@ -351,7 +351,7 @@ export interface ListBlock {
  * Model mapper block definition - for mapping SHARED models to workspace models.
  */
 export interface ModelMapperBlock {
-    type: 'model-mapper';
+    type: 'model_mapper';
     /** The SHARED model handle from provision config */
     model: string;
 }

package/dist/config/types/model.d.ts

@@ -25,7 +25,7 @@ export type FieldType = 'string' | 'text' | 'number' | 'boolean' | 'date' | 'dat
 /**
  * Relationship cardinality between models.
  */
-export type Cardinality = 'one-to-one' | 'one-to-many' | 'many-to-one' | 'many-to-many';
+export type Cardinality = 'one_to_one' | 'one_to_many' | 'many_to_one' | 'many_to_many';
 /**
  * Behavior when a related record is deleted.
  * - 'none': No action (orphan the reference)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skedyul",
-  "version": "0.3.19",
+  "version": "1.0.1",
   "description": "The Skedyul SDK for Node.js",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",