skedyul 0.1.30 → 0.1.32

package/dist/config.d.ts

@@ -128,6 +128,58 @@ export interface WorkflowDefinition {
     /** Actions in this workflow */
     actions: WorkflowAction[];
 }
+/**
+ * Supported data types for internal model fields.
+ * Matches the DataType enum in the database.
+ */
+export type InternalFieldDataType = 'TEXT' | 'LONG_TEXT' | 'NUMBER' | 'BOOLEAN' | 'DATE' | 'DATETIME' | 'EMAIL' | 'URL' | 'PHONE' | 'SELECT' | 'MULTI_SELECT' | 'JSON';
+/**
+ * Definition of a field within an internal model.
+ * This is a normalized format that can be reused for standard models.
+ */
+export interface InternalFieldDefinition {
+    /** Unique handle for the field (e.g., 'phone', 'forwarding_phone_number') */
+    handle: string;
+    /** Human-readable label */
+    label: string;
+    /** Data type of the field */
+    type: InternalFieldDataType;
+    /** Optional metafield definition handle for validation/normalization */
+    definitionHandle?: string;
+    /** Whether this field is required */
+    required?: boolean;
+    /** Whether values must be unique across instances */
+    unique?: boolean;
+    /** Whether this is a system field (managed by app logic) */
+    system?: boolean;
+    /** Whether this field is a list (array of values) */
+    isList?: boolean;
+    /** Default value for the field */
+    defaultValue?: {
+        value: unknown;
+    };
+    /** Description/help text */
+    description?: string;
+}
+/**
+ * Definition of an internal model owned by an app.
+ * Internal models are created and managed by the app, not by users.
+ * Data is stored in the standard Model/Field/Instance tables.
+ */
+export interface InternalModelDefinition {
+    /** Unique handle for the model (e.g., 'dedicated_phone_number') */
+    handle: string;
+    /** Human-readable singular name */
+    name: string;
+    /** Human-readable plural name */
+    namePlural: string;
+    /** Template for generating instance labels (e.g., '{{phone}}') */
+    labelTemplate: string;
+    /** Description of the model */
+    description?: string;
+    /** Fields in this model */
+    fields: InternalFieldDefinition[];
+}
 export type ComputeLayerType = 'serverless' | 'dedicated';
 export interface SkedyulConfig {
     /** App name */
@@ -188,6 +240,28 @@ export interface SkedyulConfig {
      * Can reference channels via channelHandle.
      */
     workflows?: WorkflowDefinition[];
+    /**
+     * Internal models owned by this app.
+     * These models are created and managed by the app, not by users.
+     * Data is stored in the standard Model/Field/Instance tables but
+     * linked to the AppVersion for ownership tracking.
+     *
+     * @example
+     * ```typescript
+     * internalModels: [
+     *   {
+     *     handle: 'dedicated_phone_number',
+     *     name: 'Dedicated Phone Number',
+     *     namePlural: 'Dedicated Phone Numbers',
+     *     labelTemplate: '{{phone}}',
+     *     fields: [
+     *       { handle: 'phone', label: 'Phone Number', type: 'TEXT', required: true, unique: true },
+     *     ],
+     *   },
+     * ]
+     * ```
+     */
+    internalModels?: InternalModelDefinition[];
 }
 /**
  * Serializable snapshot of SkedyulConfig for database storage.
@@ -220,6 +294,8 @@ export interface SerializableSkedyulConfig {
     communicationChannels?: CommunicationChannelDefinition[];
     /** Workflows this app provides */
     workflows?: WorkflowDefinition[];
+    /** Internal models owned by this app */
+    internalModels?: InternalModelDefinition[];
 }
 /**
  * Define a Skedyul app configuration with full type safety.

package/dist/config.js

@@ -247,6 +247,48 @@ function validateConfig(config) {
             }
         }
     }
+    // Validate internalModels
+    if (config.internalModels) {
+        const validDataTypes = [
+            'TEXT', 'LONG_TEXT', 'NUMBER', 'BOOLEAN', 'DATE', 'DATETIME',
+            'EMAIL', 'URL', 'PHONE', 'SELECT', 'MULTI_SELECT', 'JSON',
+        ];
+        for (let i = 0; i < config.internalModels.length; i++) {
+            const model = config.internalModels[i];
+            if (!model.handle) {
+                errors.push(`internalModels[${i}]: Missing required field 'handle'`);
+            }
+            if (!model.name) {
+                errors.push(`internalModels[${i}]: Missing required field 'name'`);
+            }
+            if (!model.namePlural) {
+                errors.push(`internalModels[${i}]: Missing required field 'namePlural'`);
+            }
+            if (!model.labelTemplate) {
+                errors.push(`internalModels[${i}]: Missing required field 'labelTemplate'`);
+            }
+            if (!model.fields || model.fields.length === 0) {
+                errors.push(`internalModels[${i}]: Must have at least one field`);
+            }
+            else {
+                for (let j = 0; j < model.fields.length; j++) {
+                    const field = model.fields[j];
+                    if (!field.handle) {
+                        errors.push(`internalModels[${i}].fields[${j}]: Missing required field 'handle'`);
+                    }
+                    if (!field.label) {
+                        errors.push(`internalModels[${i}].fields[${j}]: Missing required field 'label'`);
+                    }
+                    if (!field.type) {
+                        errors.push(`internalModels[${i}].fields[${j}]: Missing required field 'type'`);
+                    }
+                    else if (!validDataTypes.includes(field.type)) {
+                        errors.push(`internalModels[${i}].fields[${j}]: Invalid type '${field.type}'`);
+                    }
+                }
+            }
+        }
+    }
     return { valid: errors.length === 0, errors };
 }
 /**

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from './types';
+export * from './schemas';
 export { server } from './server';
 export { workplace, communicationChannel, configure, getConfig } from './core/client';
 export { defineConfig, loadConfig, validateConfig, getRequiredInstallEnvKeys, getAllEnvKeys, CONFIG_FILE_NAMES, } from './config';

package/dist/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CONFIG_FILE_NAMES = exports.getAllEnvKeys = exports.getRequiredInstallEnvKeys = exports.validateConfig = exports.loadConfig = exports.defineConfig = exports.getConfig = exports.configure = exports.communicationChannel = exports.workplace = exports.server = void 0;
 __exportStar(require("./types"), exports);
+__exportStar(require("./schemas"), exports);
 var server_1 = require("./server");
 Object.defineProperty(exports, "server", { enumerable: true, get: function () { return server_1.server; } });
 var client_1 = require("./core/client");

package/dist/schemas.d.ts

@@ -0,0 +1,446 @@
+import { z } from 'zod';
+/**
+ * Schema for environment variable visibility
+ */
+export declare const EnvVisibilitySchema: z.ZodEnum<{
+    visible: "visible";
+    encrypted: "encrypted";
+}>;
+/**
+ * Schema for a single environment variable definition.
+ */
+export declare const EnvVariableDefinitionSchema: z.ZodObject<{
+    label: z.ZodString;
+    required: z.ZodOptional<z.ZodBoolean>;
+    visibility: z.ZodOptional<z.ZodEnum<{
+        visible: "visible";
+        encrypted: "encrypted";
+    }>>;
+    default: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    placeholder: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Schema for a collection of environment variable definitions.
+ */
+export declare const EnvSchemaSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
+    label: z.ZodString;
+    required: z.ZodOptional<z.ZodBoolean>;
+    visibility: z.ZodOptional<z.ZodEnum<{
+        visible: "visible";
+        encrypted: "encrypted";
+    }>>;
+    default: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    placeholder: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>>;
+/**
+ * Schema for app model definition.
+ */
+export declare const AppModelDefinitionSchema: z.ZodObject<{
+    entityHandle: z.ZodString;
+    label: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Schema for install configuration.
+ */
+export declare const InstallConfigSchema: z.ZodObject<{
+    env: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        label: z.ZodString;
+        required: z.ZodOptional<z.ZodBoolean>;
+        visibility: z.ZodOptional<z.ZodEnum<{
+            visible: "visible";
+            encrypted: "encrypted";
+        }>>;
+        default: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+        placeholder: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    appModels: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        entityHandle: z.ZodString;
+        label: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+/**
+ * Schema for app field visibility.
+ */
+export declare const AppFieldVisibilitySchema: z.ZodObject<{
+    data: z.ZodOptional<z.ZodBoolean>;
+    list: z.ZodOptional<z.ZodBoolean>;
+    filters: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+/**
+ * Schema for app field definition (communication channels).
+ */
+export declare const AppFieldDefinitionSchema: z.ZodObject<{
+    label: z.ZodString;
+    fieldHandle: z.ZodString;
+    entityHandle: z.ZodString;
+    definitionHandle: z.ZodString;
+    required: z.ZodOptional<z.ZodBoolean>;
+    system: z.ZodOptional<z.ZodBoolean>;
+    unique: z.ZodOptional<z.ZodBoolean>;
+    defaultValue: z.ZodOptional<z.ZodObject<{
+        value: z.ZodUnknown;
+    }, z.core.$strip>>;
+    visibility: z.ZodOptional<z.ZodObject<{
+        data: z.ZodOptional<z.ZodBoolean>;
+        list: z.ZodOptional<z.ZodBoolean>;
+        filters: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * Schema for channel tool bindings.
+ */
+export declare const ChannelToolBindingsSchema: z.ZodObject<{
+    send_message: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Schema for channel identifier type.
+ */
+export declare const ChannelIdentifierTypeSchema: z.ZodEnum<{
+    DEDICATED_PHONE: "DEDICATED_PHONE";
+    TEXT: "TEXT";
+    EMAIL: "EMAIL";
+}>;
+/**
+ * Schema for channel identifier value.
+ */
+export declare const ChannelIdentifierValueSchema: z.ZodObject<{
+    type: z.ZodEnum<{
+        DEDICATED_PHONE: "DEDICATED_PHONE";
+        TEXT: "TEXT";
+        EMAIL: "EMAIL";
+    }>;
+    definitionHandle: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Schema for communication channel definition.
+ */
+export declare const CommunicationChannelDefinitionSchema: z.ZodObject<{
+    handle: z.ZodString;
+    name: z.ZodString;
+    icon: z.ZodOptional<z.ZodString>;
+    tools: z.ZodObject<{
+        send_message: z.ZodString;
+    }, z.core.$strip>;
+    identifierValue: z.ZodObject<{
+        type: z.ZodEnum<{
+            DEDICATED_PHONE: "DEDICATED_PHONE";
+            TEXT: "TEXT";
+            EMAIL: "EMAIL";
+        }>;
+        definitionHandle: z.ZodString;
+    }, z.core.$strip>;
+    appFields: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        label: z.ZodString;
+        fieldHandle: z.ZodString;
+        entityHandle: z.ZodString;
+        definitionHandle: z.ZodString;
+        required: z.ZodOptional<z.ZodBoolean>;
+        system: z.ZodOptional<z.ZodBoolean>;
+        unique: z.ZodOptional<z.ZodBoolean>;
+        defaultValue: z.ZodOptional<z.ZodObject<{
+            value: z.ZodUnknown;
+        }, z.core.$strip>>;
+        visibility: z.ZodOptional<z.ZodObject<{
+            data: z.ZodOptional<z.ZodBoolean>;
+            list: z.ZodOptional<z.ZodBoolean>;
+            filters: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>>;
+    settings: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
+}, z.core.$strip>;
+/**
+ * Schema for workflow action input.
+ */
+export declare const WorkflowActionInputSchema: z.ZodObject<{
+    key: z.ZodString;
+    label: z.ZodString;
+    fieldRef: z.ZodOptional<z.ZodObject<{
+        fieldHandle: z.ZodString;
+        entityHandle: z.ZodString;
+    }, z.core.$strip>>;
+    template: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Schema for workflow action.
+ */
+export declare const WorkflowActionSchema: z.ZodObject<{
+    label: z.ZodString;
+    handle: z.ZodString;
+    batch: z.ZodOptional<z.ZodBoolean>;
+    entityHandle: z.ZodOptional<z.ZodString>;
+    inputs: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        label: z.ZodString;
+        fieldRef: z.ZodOptional<z.ZodObject<{
+            fieldHandle: z.ZodString;
+            entityHandle: z.ZodString;
+        }, z.core.$strip>>;
+        template: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+/**
+ * Schema for workflow definition.
+ */
+export declare const WorkflowDefinitionSchema: z.ZodObject<{
+    path: z.ZodString;
+    label: z.ZodOptional<z.ZodString>;
+    handle: z.ZodOptional<z.ZodString>;
+    channelHandle: z.ZodOptional<z.ZodString>;
+    actions: z.ZodArray<z.ZodObject<{
+        label: z.ZodString;
+        handle: z.ZodString;
+        batch: z.ZodOptional<z.ZodBoolean>;
+        entityHandle: z.ZodOptional<z.ZodString>;
+        inputs: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            key: z.ZodString;
+            label: z.ZodString;
+            fieldRef: z.ZodOptional<z.ZodObject<{
+                fieldHandle: z.ZodString;
+                entityHandle: z.ZodString;
+            }, z.core.$strip>>;
+            template: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * Schema for compute layer type.
+ */
+export declare const ComputeLayerTypeSchema: z.ZodEnum<{
+    dedicated: "dedicated";
+    serverless: "serverless";
+}>;
+/**
+ * Schema for internal field data types.
+ */
+export declare const InternalFieldDataTypeSchema: z.ZodEnum<{
+    TEXT: "TEXT";
+    EMAIL: "EMAIL";
+    LONG_TEXT: "LONG_TEXT";
+    NUMBER: "NUMBER";
+    BOOLEAN: "BOOLEAN";
+    DATE: "DATE";
+    DATETIME: "DATETIME";
+    URL: "URL";
+    PHONE: "PHONE";
+    SELECT: "SELECT";
+    MULTI_SELECT: "MULTI_SELECT";
+    JSON: "JSON";
+}>;
+/**
+ * Schema for a field within an internal model.
+ */
+export declare const InternalFieldDefinitionSchema: z.ZodObject<{
+    handle: z.ZodString;
+    label: z.ZodString;
+    type: z.ZodEnum<{
+        TEXT: "TEXT";
+        EMAIL: "EMAIL";
+        LONG_TEXT: "LONG_TEXT";
+        NUMBER: "NUMBER";
+        BOOLEAN: "BOOLEAN";
+        DATE: "DATE";
+        DATETIME: "DATETIME";
+        URL: "URL";
+        PHONE: "PHONE";
+        SELECT: "SELECT";
+        MULTI_SELECT: "MULTI_SELECT";
+        JSON: "JSON";
+    }>;
+    definitionHandle: z.ZodOptional<z.ZodString>;
+    required: z.ZodOptional<z.ZodBoolean>;
+    unique: z.ZodOptional<z.ZodBoolean>;
+    system: z.ZodOptional<z.ZodBoolean>;
+    isList: z.ZodOptional<z.ZodBoolean>;
+    defaultValue: z.ZodOptional<z.ZodObject<{
+        value: z.ZodUnknown;
+    }, z.core.$strip>>;
+    description: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Schema for an internal model definition.
+ */
+export declare const InternalModelDefinitionSchema: z.ZodObject<{
+    handle: z.ZodString;
+    name: z.ZodString;
+    namePlural: z.ZodString;
+    labelTemplate: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    fields: z.ZodArray<z.ZodObject<{
+        handle: z.ZodString;
+        label: z.ZodString;
+        type: z.ZodEnum<{
+            TEXT: "TEXT";
+            EMAIL: "EMAIL";
+            LONG_TEXT: "LONG_TEXT";
+            NUMBER: "NUMBER";
+            BOOLEAN: "BOOLEAN";
+            DATE: "DATE";
+            DATETIME: "DATETIME";
+            URL: "URL";
+            PHONE: "PHONE";
+            SELECT: "SELECT";
+            MULTI_SELECT: "MULTI_SELECT";
+            JSON: "JSON";
+        }>;
+        definitionHandle: z.ZodOptional<z.ZodString>;
+        required: z.ZodOptional<z.ZodBoolean>;
+        unique: z.ZodOptional<z.ZodBoolean>;
+        system: z.ZodOptional<z.ZodBoolean>;
+        isList: z.ZodOptional<z.ZodBoolean>;
+        defaultValue: z.ZodOptional<z.ZodObject<{
+            value: z.ZodUnknown;
+        }, z.core.$strip>>;
+        description: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * Schema for the full skedyul.config.ts stored on an Executable.
+ * This is the single source of truth for all app configuration.
+ *
+ * Note: tools and webhooks are stored as null/unknown since they are
+ * dynamic imports that cannot be serialized. Use SerializableSkedyulConfigSchema
+ * for database storage which uses ToolMetadata[] and WebhookMetadata[] instead.
+ */
+export declare const SkedyulConfigSchema: z.ZodObject<{
+    name: z.ZodString;
+    version: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    computeLayer: z.ZodOptional<z.ZodEnum<{
+        dedicated: "dedicated";
+        serverless: "serverless";
+    }>>;
+    tools: z.ZodOptional<z.ZodUnknown>;
+    webhooks: z.ZodOptional<z.ZodUnknown>;
+    workflowsPath: z.ZodOptional<z.ZodString>;
+    env: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        label: z.ZodString;
+        required: z.ZodOptional<z.ZodBoolean>;
+        visibility: z.ZodOptional<z.ZodEnum<{
+            visible: "visible";
+            encrypted: "encrypted";
+        }>>;
+        default: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+        placeholder: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    install: z.ZodOptional<z.ZodObject<{
+        env: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+            label: z.ZodString;
+            required: z.ZodOptional<z.ZodBoolean>;
+            visibility: z.ZodOptional<z.ZodEnum<{
+                visible: "visible";
+                encrypted: "encrypted";
+            }>>;
+            default: z.ZodOptional<z.ZodString>;
+            description: z.ZodOptional<z.ZodString>;
+            placeholder: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+        appModels: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            entityHandle: z.ZodString;
+            label: z.ZodString;
+            description: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+    communicationChannels: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        handle: z.ZodString;
+        name: z.ZodString;
+        icon: z.ZodOptional<z.ZodString>;
+        tools: z.ZodObject<{
+            send_message: z.ZodString;
+        }, z.core.$strip>;
+        identifierValue: z.ZodObject<{
+            type: z.ZodEnum<{
+                DEDICATED_PHONE: "DEDICATED_PHONE";
+                TEXT: "TEXT";
+                EMAIL: "EMAIL";
+            }>;
+            definitionHandle: z.ZodString;
+        }, z.core.$strip>;
+        appFields: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            label: z.ZodString;
+            fieldHandle: z.ZodString;
+            entityHandle: z.ZodString;
+            definitionHandle: z.ZodString;
+            required: z.ZodOptional<z.ZodBoolean>;
+            system: z.ZodOptional<z.ZodBoolean>;
+            unique: z.ZodOptional<z.ZodBoolean>;
+            defaultValue: z.ZodOptional<z.ZodObject<{
+                value: z.ZodUnknown;
+            }, z.core.$strip>>;
+            visibility: z.ZodOptional<z.ZodObject<{
+                data: z.ZodOptional<z.ZodBoolean>;
+                list: z.ZodOptional<z.ZodBoolean>;
+                filters: z.ZodOptional<z.ZodBoolean>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>>;
+        settings: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
+    }, z.core.$strip>>>;
+    workflows: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        path: z.ZodString;
+        label: z.ZodOptional<z.ZodString>;
+        handle: z.ZodOptional<z.ZodString>;
+        channelHandle: z.ZodOptional<z.ZodString>;
+        actions: z.ZodArray<z.ZodObject<{
+            label: z.ZodString;
+            handle: z.ZodString;
+            batch: z.ZodOptional<z.ZodBoolean>;
+            entityHandle: z.ZodOptional<z.ZodString>;
+            inputs: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                key: z.ZodString;
+                label: z.ZodString;
+                fieldRef: z.ZodOptional<z.ZodObject<{
+                    fieldHandle: z.ZodString;
+                    entityHandle: z.ZodString;
+                }, z.core.$strip>>;
+                template: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>>;
+    internalModels: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        handle: z.ZodString;
+        name: z.ZodString;
+        namePlural: z.ZodString;
+        labelTemplate: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        fields: z.ZodArray<z.ZodObject<{
+            handle: z.ZodString;
+            label: z.ZodString;
+            type: z.ZodEnum<{
+                TEXT: "TEXT";
+                EMAIL: "EMAIL";
+                LONG_TEXT: "LONG_TEXT";
+                NUMBER: "NUMBER";
+                BOOLEAN: "BOOLEAN";
+                DATE: "DATE";
+                DATETIME: "DATETIME";
+                URL: "URL";
+                PHONE: "PHONE";
+                SELECT: "SELECT";
+                MULTI_SELECT: "MULTI_SELECT";
+                JSON: "JSON";
+            }>;
+            definitionHandle: z.ZodOptional<z.ZodString>;
+            required: z.ZodOptional<z.ZodBoolean>;
+            unique: z.ZodOptional<z.ZodBoolean>;
+            system: z.ZodOptional<z.ZodBoolean>;
+            isList: z.ZodOptional<z.ZodBoolean>;
+            defaultValue: z.ZodOptional<z.ZodObject<{
+                value: z.ZodUnknown;
+            }, z.core.$strip>>;
+            description: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+/**
+ * Inferred type from SkedyulConfigSchema for runtime-validated configs.
+ */
+export type ParsedSkedyulConfig = z.infer<typeof SkedyulConfigSchema>;
+/**
+ * Safely parse a skedyul config, returning null if invalid.
+ */
+export declare function safeParseConfig(data: unknown): ParsedSkedyulConfig | null;

package/dist/schemas.js

@@ -0,0 +1,218 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SkedyulConfigSchema = exports.InternalModelDefinitionSchema = exports.InternalFieldDefinitionSchema = exports.InternalFieldDataTypeSchema = exports.ComputeLayerTypeSchema = exports.WorkflowDefinitionSchema = exports.WorkflowActionSchema = exports.WorkflowActionInputSchema = exports.CommunicationChannelDefinitionSchema = exports.ChannelIdentifierValueSchema = exports.ChannelIdentifierTypeSchema = exports.ChannelToolBindingsSchema = exports.AppFieldDefinitionSchema = exports.AppFieldVisibilitySchema = exports.InstallConfigSchema = exports.AppModelDefinitionSchema = exports.EnvSchemaSchema = exports.EnvVariableDefinitionSchema = exports.EnvVisibilitySchema = void 0;
+exports.safeParseConfig = safeParseConfig;
+const zod_1 = require("zod");
+// ─────────────────────────────────────────────────────────────────────────────
+// Zod Schemas for SkedyulConfig
+// These schemas are used for runtime validation of config files.
+// TypeScript types in config.ts should match these schemas.
+// ─────────────────────────────────────────────────────────────────────────────
+/**
+ * Schema for environment variable visibility
+ */
+exports.EnvVisibilitySchema = zod_1.z.enum(['visible', 'encrypted']);
+/**
+ * Schema for a single environment variable definition.
+ */
+exports.EnvVariableDefinitionSchema = zod_1.z.object({
+    label: zod_1.z.string(),
+    required: zod_1.z.boolean().optional(),
+    visibility: exports.EnvVisibilitySchema.optional(),
+    default: zod_1.z.string().optional(),
+    description: zod_1.z.string().optional(),
+    placeholder: zod_1.z.string().optional(),
+});
+/**
+ * Schema for a collection of environment variable definitions.
+ */
+exports.EnvSchemaSchema = zod_1.z.record(zod_1.z.string(), exports.EnvVariableDefinitionSchema);
+/**
+ * Schema for app model definition.
+ */
+exports.AppModelDefinitionSchema = zod_1.z.object({
+    entityHandle: zod_1.z.string(),
+    label: zod_1.z.string(),
+    description: zod_1.z.string().optional(),
+});
+/**
+ * Schema for install configuration.
+ */
+exports.InstallConfigSchema = zod_1.z.object({
+    env: exports.EnvSchemaSchema.optional(),
+    appModels: zod_1.z.array(exports.AppModelDefinitionSchema).optional(),
+});
+/**
+ * Schema for app field visibility.
+ */
+exports.AppFieldVisibilitySchema = zod_1.z.object({
+    data: zod_1.z.boolean().optional(),
+    list: zod_1.z.boolean().optional(),
+    filters: zod_1.z.boolean().optional(),
+});
+/**
+ * Schema for app field definition (communication channels).
+ */
+exports.AppFieldDefinitionSchema = zod_1.z.object({
+    label: zod_1.z.string(),
+    fieldHandle: zod_1.z.string(),
+    entityHandle: zod_1.z.string(),
+    definitionHandle: zod_1.z.string(),
+    required: zod_1.z.boolean().optional(),
+    system: zod_1.z.boolean().optional(),
+    unique: zod_1.z.boolean().optional(),
+    defaultValue: zod_1.z.object({ value: zod_1.z.unknown() }).optional(),
+    visibility: exports.AppFieldVisibilitySchema.optional(),
+});
+/**
+ * Schema for channel tool bindings.
+ */
+exports.ChannelToolBindingsSchema = zod_1.z.object({
+    send_message: zod_1.z.string(),
+});
+/**
+ * Schema for channel identifier type.
+ */
+exports.ChannelIdentifierTypeSchema = zod_1.z.enum([
+    'DEDICATED_PHONE',
+    'TEXT',
+    'EMAIL',
+]);
+/**
+ * Schema for channel identifier value.
+ */
+exports.ChannelIdentifierValueSchema = zod_1.z.object({
+    type: exports.ChannelIdentifierTypeSchema,
+    definitionHandle: zod_1.z.string(),
+});
+/**
+ * Schema for communication channel definition.
+ */
+exports.CommunicationChannelDefinitionSchema = zod_1.z.object({
+    handle: zod_1.z.string(),
+    name: zod_1.z.string(),
+    icon: zod_1.z.string().optional(),
+    tools: exports.ChannelToolBindingsSchema,
+    identifierValue: exports.ChannelIdentifierValueSchema,
+    appFields: zod_1.z.array(exports.AppFieldDefinitionSchema).optional(),
+    settings: zod_1.z.array(zod_1.z.unknown()).optional(),
+});
+/**
+ * Schema for workflow action input.
+ */
+exports.WorkflowActionInputSchema = zod_1.z.object({
+    key: zod_1.z.string(),
+    label: zod_1.z.string(),
+    fieldRef: zod_1.z
+        .object({
+        fieldHandle: zod_1.z.string(),
+        entityHandle: zod_1.z.string(),
+    })
+        .optional(),
+    template: zod_1.z.string().optional(),
+});
+/**
+ * Schema for workflow action.
+ */
+exports.WorkflowActionSchema = zod_1.z.object({
+    label: zod_1.z.string(),
+    handle: zod_1.z.string(),
+    batch: zod_1.z.boolean().optional(),
+    entityHandle: zod_1.z.string().optional(),
+    inputs: zod_1.z.array(exports.WorkflowActionInputSchema).optional(),
+});
+/**
+ * Schema for workflow definition.
+ */
+exports.WorkflowDefinitionSchema = zod_1.z.object({
+    /** Path to external YAML workflow file (relative to config) */
+    path: zod_1.z.string(),
+    /** Human-readable label (optional when path is provided, inferred from YAML) */
+    label: zod_1.z.string().optional(),
+    /** Workflow handle/key (optional when path is provided, inferred from YAML) */
+    handle: zod_1.z.string().optional(),
+    /** Channel handle (optional) */
+    channelHandle: zod_1.z.string().optional(),
+    /** Actions in this workflow */
+    actions: zod_1.z.array(exports.WorkflowActionSchema),
+});
+/**
+ * Schema for compute layer type.
+ */
+exports.ComputeLayerTypeSchema = zod_1.z.enum(['serverless', 'dedicated']);
+// ─────────────────────────────────────────────────────────────────────────────
+// Internal Model Schemas (App-owned models)
+// ─────────────────────────────────────────────────────────────────────────────
+/**
+ * Schema for internal field data types.
+ */
+exports.InternalFieldDataTypeSchema = zod_1.z.enum([
+    'TEXT',
+    'LONG_TEXT',
+    'NUMBER',
+    'BOOLEAN',
+    'DATE',
+    'DATETIME',
+    'EMAIL',
+    'URL',
+    'PHONE',
+    'SELECT',
+    'MULTI_SELECT',
+    'JSON',
+]);
+/**
+ * Schema for a field within an internal model.
+ */
+exports.InternalFieldDefinitionSchema = zod_1.z.object({
+    handle: zod_1.z.string(),
+    label: zod_1.z.string(),
+    type: exports.InternalFieldDataTypeSchema,
+    definitionHandle: zod_1.z.string().optional(),
+    required: zod_1.z.boolean().optional(),
+    unique: zod_1.z.boolean().optional(),
+    system: zod_1.z.boolean().optional(),
+    isList: zod_1.z.boolean().optional(),
+    defaultValue: zod_1.z.object({ value: zod_1.z.unknown() }).optional(),
+    description: zod_1.z.string().optional(),
+});
+/**
+ * Schema for an internal model definition.
+ */
+exports.InternalModelDefinitionSchema = zod_1.z.object({
+    handle: zod_1.z.string(),
+    name: zod_1.z.string(),
+    namePlural: zod_1.z.string(),
+    labelTemplate: zod_1.z.string(),
+    description: zod_1.z.string().optional(),
+    fields: zod_1.z.array(exports.InternalFieldDefinitionSchema),
+});
+/**
+ * Schema for the full skedyul.config.ts stored on an Executable.
+ * This is the single source of truth for all app configuration.
+ *
+ * Note: tools and webhooks are stored as null/unknown since they are
+ * dynamic imports that cannot be serialized. Use SerializableSkedyulConfigSchema
+ * for database storage which uses ToolMetadata[] and WebhookMetadata[] instead.
+ */
+exports.SkedyulConfigSchema = zod_1.z.object({
+    name: zod_1.z.string(),
+    version: zod_1.z.string().optional(),
+    description: zod_1.z.string().optional(),
+    computeLayer: exports.ComputeLayerTypeSchema.optional(),
+    // Dynamic imports become null after transpilation
+    tools: zod_1.z.unknown().optional(),
+    webhooks: zod_1.z.unknown().optional(),
+    workflowsPath: zod_1.z.string().optional(),
+    env: exports.EnvSchemaSchema.optional(),
+    install: exports.InstallConfigSchema.optional(),
+    communicationChannels: zod_1.z.array(exports.CommunicationChannelDefinitionSchema).optional(),
+    workflows: zod_1.z.array(exports.WorkflowDefinitionSchema).optional(),
+    internalModels: zod_1.z.array(exports.InternalModelDefinitionSchema).optional(),
+});
+/**
+ * Safely parse a skedyul config, returning null if invalid.
+ */
+function safeParseConfig(data) {
+    const result = exports.SkedyulConfigSchema.safeParse(data);
+    return result.success ? result.data : null;
+}

package/package.json

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