skedyul 0.3.0 → 0.3.2

package/dist/.build-stamp

@@ -1 +1 @@
-1771192319210
+1771312334989

package/dist/config/app-config.d.ts

@@ -0,0 +1,73 @@
+import type { ToolRegistry, WebhookRegistry, ToolMetadata, WebhookMetadata } from '../types';
+import type { EnvSchema, ComputeLayerType, ModelDefinition, RelationshipDefinition, ChannelDefinition, WorkflowDefinition, PageDefinition, NavigationConfig, AgentDefinition } from './types';
+export type { InstallHandlerContext, InstallHandlerResult, InstallHandler, InstallHandlerResponseOAuth, InstallHandlerResponseStandard, HasOAuthCallback, ServerHooksWithOAuth, ServerHooksWithoutOAuth, ProvisionHandlerContext, ProvisionHandlerResult, ProvisionHandler, ServerHooks, } from '../types';
+/**
+ * Install configuration - defines per-install env vars.
+ */
+export interface InstallConfig {
+    /** Per-install environment variables (collected from user during install, passed at runtime) */
+    env?: EnvSchema;
+}
+/** Provision-level configuration - auto-synced when app version is deployed */
+export interface ProvisionConfig {
+    /** Global environment variables (developer-level, shared across all installs) */
+    env?: EnvSchema;
+    /** Model definitions (INTERNAL + SHARED) */
+    models?: ModelDefinition[];
+    /** Relationship definitions between models */
+    relationships?: RelationshipDefinition[];
+    /** Communication channel definitions */
+    channels?: ChannelDefinition[];
+    /** Workflow definitions */
+    workflows?: WorkflowDefinition[];
+    /** Base navigation configuration for all pages (can be overridden per page) */
+    navigation?: NavigationConfig;
+    /** Page definitions for app UI */
+    pages?: PageDefinition[];
+}
+export interface SkedyulConfig {
+    /** App name */
+    name: string;
+    /** App version (semver) */
+    version?: string;
+    /** App description */
+    description?: string;
+    /** Compute layer: 'serverless' (Lambda) or 'dedicated' (ECS/Docker) */
+    computeLayer?: ComputeLayerType;
+    /** Tool registry - direct object or dynamic import */
+    tools?: ToolRegistry | Promise<{
+        toolRegistry: ToolRegistry;
+    }>;
+    /** Webhook registry - direct object or dynamic import */
+    webhooks?: WebhookRegistry | Promise<{
+        webhookRegistry: WebhookRegistry;
+    }>;
+    /** Provision configuration - direct object or dynamic import */
+    provision?: ProvisionConfig | Promise<{
+        default: ProvisionConfig;
+    }>;
+    /** Install configuration - hooks for install/uninstall lifecycle */
+    install?: InstallConfig | Promise<{
+        default: InstallConfig;
+    }>;
+    /** Agent definitions - multi-tenant agents with tool bindings */
+    agents?: AgentDefinition[];
+}
+export interface SerializableSkedyulConfig {
+    name: string;
+    version?: string;
+    description?: string;
+    computeLayer?: ComputeLayerType;
+    /** Tool metadata (serialized from ToolRegistry) */
+    tools?: ToolMetadata[];
+    /** Webhook metadata (serialized from WebhookRegistry) */
+    webhooks?: WebhookMetadata[];
+    /** Provision config (fully resolved) */
+    provision?: ProvisionConfig;
+    /** Agent definitions (stored as-is) */
+    agents?: AgentDefinition[];
+}
+/**
+ * Define a Skedyul app configuration with full type safety.
+ */
+export declare function defineConfig(config: SkedyulConfig): SkedyulConfig;

package/dist/config/app-config.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defineConfig = defineConfig;
+// ─────────────────────────────────────────────────────────────────────────────
+// Helper Function
+// ─────────────────────────────────────────────────────────────────────────────
+/**
+ * Define a Skedyul app configuration with full type safety.
+ */
+function defineConfig(config) {
+    return config;
+}

package/dist/config/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Config module - re-exports all config types and utilities
+ */
+export * from './types';
+export type { InstallConfig, ProvisionConfig, SkedyulConfig, SerializableSkedyulConfig, } from './app-config';
+export { defineConfig } from './app-config';
+export type { InstallHandlerContext, InstallHandlerResult, InstallHandler, InstallHandlerResponseOAuth, InstallHandlerResponseStandard, HasOAuthCallback, ServerHooksWithOAuth, ServerHooksWithoutOAuth, ProvisionHandlerContext, ProvisionHandlerResult, ProvisionHandler, ServerHooks, } from './app-config';
+export { CONFIG_FILE_NAMES, loadConfig, validateConfig } from './loader';
+export { getAllEnvKeys, getRequiredInstallEnvKeys } from './utils';

package/dist/config/index.js

@@ -0,0 +1,33 @@
+"use strict";
+/**
+ * Config module - re-exports all config types and utilities
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRequiredInstallEnvKeys = exports.getAllEnvKeys = exports.validateConfig = exports.loadConfig = exports.CONFIG_FILE_NAMES = exports.defineConfig = void 0;
+// Re-export all types
+__exportStar(require("./types"), exports);
+var app_config_1 = require("./app-config");
+Object.defineProperty(exports, "defineConfig", { enumerable: true, get: function () { return app_config_1.defineConfig; } });
+// Re-export loader utilities
+var loader_1 = require("./loader");
+Object.defineProperty(exports, "CONFIG_FILE_NAMES", { enumerable: true, get: function () { return loader_1.CONFIG_FILE_NAMES; } });
+Object.defineProperty(exports, "loadConfig", { enumerable: true, get: function () { return loader_1.loadConfig; } });
+Object.defineProperty(exports, "validateConfig", { enumerable: true, get: function () { return loader_1.validateConfig; } });
+// Re-export helper utilities
+var utils_1 = require("./utils");
+Object.defineProperty(exports, "getAllEnvKeys", { enumerable: true, get: function () { return utils_1.getAllEnvKeys; } });
+Object.defineProperty(exports, "getRequiredInstallEnvKeys", { enumerable: true, get: function () { return utils_1.getRequiredInstallEnvKeys; } });

package/dist/config/loader.d.ts

@@ -0,0 +1,7 @@
+import type { SkedyulConfig } from './app-config';
+export declare const CONFIG_FILE_NAMES: string[];
+export declare function loadConfig(configPath: string): Promise<SkedyulConfig>;
+export declare function validateConfig(config: SkedyulConfig): {
+    valid: boolean;
+    errors: string[];
+};

package/dist/config/loader.js

@@ -0,0 +1,119 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CONFIG_FILE_NAMES = void 0;
+exports.loadConfig = loadConfig;
+exports.validateConfig = validateConfig;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const os = __importStar(require("os"));
+// ─────────────────────────────────────────────────────────────────────────────
+// Config Loading Utilities
+// ─────────────────────────────────────────────────────────────────────────────
+exports.CONFIG_FILE_NAMES = [
+    'skedyul.config.ts',
+    'skedyul.config.js',
+    'skedyul.config.mjs',
+    'skedyul.config.cjs',
+];
+async function transpileTypeScript(filePath) {
+    const content = fs.readFileSync(filePath, 'utf-8');
+    let transpiled = content
+        .replace(/import\s+type\s+\{[^}]+\}\s+from\s+['"][^'"]+['"]\s*;?\n?/g, '')
+        .replace(/import\s+\{\s*defineConfig\s*\}\s+from\s+['"]skedyul['"]\s*;?\n?/g, '')
+        .replace(/:\s*SkedyulConfig/g, '')
+        .replace(/export\s+default\s+/, 'module.exports = ')
+        .replace(/defineConfig\s*\(\s*\{/, '{')
+        .replace(/\}\s*\)\s*;?\s*$/, '}');
+    return transpiled;
+}
+async function loadConfig(configPath) {
+    const absolutePath = path.resolve(configPath);
+    if (!fs.existsSync(absolutePath)) {
+        throw new Error(`Config file not found: ${absolutePath}`);
+    }
+    const isTypeScript = absolutePath.endsWith('.ts');
+    try {
+        let moduleToLoad = absolutePath;
+        if (isTypeScript) {
+            const transpiled = await transpileTypeScript(absolutePath);
+            const tempDir = os.tmpdir();
+            const tempFile = path.join(tempDir, `skedyul-config-${Date.now()}.js`);
+            fs.writeFileSync(tempFile, transpiled);
+            moduleToLoad = tempFile;
+            try {
+                const module = require(moduleToLoad);
+                const config = module.default || module;
+                if (!config || typeof config !== 'object') {
+                    throw new Error('Config file must export a configuration object');
+                }
+                if (!config.name || typeof config.name !== 'string') {
+                    throw new Error('Config must have a "name" property');
+                }
+                return config;
+            }
+            finally {
+                try {
+                    fs.unlinkSync(tempFile);
+                }
+                catch {
+                    // Ignore cleanup errors
+                }
+            }
+        }
+        const module = await Promise.resolve(`${moduleToLoad}`).then(s => __importStar(require(s)));
+        const config = module.default || module;
+        if (!config || typeof config !== 'object') {
+            throw new Error('Config file must export a configuration object');
+        }
+        if (!config.name || typeof config.name !== 'string') {
+            throw new Error('Config must have a "name" property');
+        }
+        return config;
+    }
+    catch (error) {
+        throw new Error(`Failed to load config from ${configPath}: ${error instanceof Error ? error.message : String(error)}`);
+    }
+}
+function validateConfig(config) {
+    const errors = [];
+    if (!config.name) {
+        errors.push('Missing required field: name');
+    }
+    if (config.computeLayer && !['serverless', 'dedicated'].includes(config.computeLayer)) {
+        errors.push(`Invalid computeLayer: ${config.computeLayer}. Must be 'serverless' or 'dedicated'`);
+    }
+    return { valid: errors.length === 0, errors };
+}

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

@@ -0,0 +1,29 @@
+/**
+ * Definition for an app-provided agent.
+ * Agents are created globally during provisioning and become available
+ * to workplaces that install the app.
+ */
+export interface AgentDefinition {
+    /** Unique identifier within the app (used for upserts) */
+    handle: string;
+    /** Display name */
+    name: string;
+    /** Description of what the agent does */
+    description: string;
+    /** System prompt (static, no templating) */
+    system: string;
+    /** Tool names to bind (must exist in this app's tools) */
+    tools: string[];
+    /** Optional LLM model override (defaults to workspace default) */
+    llmModelId?: string;
+    /**
+     * Parent agent that can call this agent.
+     * Creates an AGENT-type tool and binds it to the parent.
+     *
+     * Values:
+     * - 'composer' - Bind to the workspace's Composer agent
+     * - '<handle>' - Bind to another agent in this app (by handle)
+     * - undefined  - Standalone agent (not callable by other agents)
+     */
+    parentAgent?: string;
+}

package/dist/config/types/agent.js

@@ -0,0 +1,5 @@
+"use strict";
+// ─────────────────────────────────────────────────────────────────────────────
+// Agent Definition
+// ─────────────────────────────────────────────────────────────────────────────
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,46 @@
+import type { AppFieldVisibility } from './model';
+/** Standard capability types for communication channels */
+export type ChannelCapabilityType = 'messaging' | 'voice' | 'video';
+/** Capability definition with display info and handler references */
+export interface ChannelCapability {
+    /** Display name: "SMS", "WhatsApp Messages" */
+    name: string;
+    /** Lucide icon name */
+    icon?: string;
+    /** Inbound webhook handler */
+    receive?: string;
+    /** Outbound tool handle */
+    send?: string;
+}
+export interface ChannelFieldPermissions {
+    read?: boolean;
+    write?: boolean;
+}
+/**
+ * Field definition for channel field mappings.
+ * One field should have identifier: true to mark it as the channel identifier.
+ */
+export interface ChannelFieldDefinition {
+    handle: string;
+    label: string;
+    definition: {
+        handle: string;
+    };
+    /** Marks this field as the identifier field for the channel */
+    identifier?: boolean;
+    required?: boolean;
+    defaultValue?: {
+        value: unknown;
+    };
+    visibility?: AppFieldVisibility;
+    permissions?: ChannelFieldPermissions;
+}
+export interface ChannelDefinition {
+    handle: string;
+    name: string;
+    icon?: string;
+    /** Field definitions for channel. One field must have identifier: true. */
+    fields: ChannelFieldDefinition[];
+    /** Capabilities keyed by standard type (messaging, voice, video) */
+    capabilities: Partial<Record<ChannelCapabilityType, ChannelCapability>>;
+}

package/dist/config/types/channel.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1 @@
+export type ComputeLayerType = 'serverless' | 'dedicated';

package/dist/config/types/compute.js

@@ -0,0 +1,5 @@
+"use strict";
+// ─────────────────────────────────────────────────────────────────────────────
+// Compute Layer
+// ─────────────────────────────────────────────────────────────────────────────
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,16 @@
+export type EnvVisibility = 'visible' | 'encrypted';
+export interface EnvVariableDefinition {
+    /** Human-readable label for the variable */
+    label: string;
+    /** Whether this variable is required */
+    required?: boolean;
+    /** Visibility setting (encrypted values are hidden in UI) */
+    visibility?: EnvVisibility;
+    /** Default value if not provided */
+    default?: string;
+    /** Description/help text */
+    description?: string;
+    /** Placeholder text for input fields */
+    placeholder?: string;
+}
+export type EnvSchema = Record<string, EnvVariableDefinition>;

package/dist/config/types/env.js

@@ -0,0 +1,5 @@
+"use strict";
+// ─────────────────────────────────────────────────────────────────────────────
+// Env Variable Definition
+// ─────────────────────────────────────────────────────────────────────────────
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,9 @@
+export * from './env';
+export * from './compute';
+export * from './resource';
+export * from './model';
+export * from './channel';
+export * from './workflow';
+export * from './page';
+export * from './webhook';
+export * from './agent';

package/dist/config/types/index.js

@@ -0,0 +1,26 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Re-export all config types
+__exportStar(require("./env"), exports);
+__exportStar(require("./compute"), exports);
+__exportStar(require("./resource"), exports);
+__exportStar(require("./model"), exports);
+__exportStar(require("./channel"), exports);
+__exportStar(require("./workflow"), exports);
+__exportStar(require("./page"), exports);
+__exportStar(require("./webhook"), exports);
+__exportStar(require("./agent"), exports);

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

@@ -0,0 +1,62 @@
+import type { ResourceScope, FieldOwner, ResourceDependency } from './resource';
+export type InternalFieldDataType = 'LONG_STRING' | 'STRING' | 'NUMBER' | 'BOOLEAN' | 'DATE' | 'DATE_TIME' | 'TIME' | 'FILE' | 'IMAGE' | 'RELATION' | 'OBJECT';
+export interface FieldOption {
+    label: string;
+    value: string;
+    color?: string;
+}
+export interface InlineFieldDefinition {
+    limitChoices?: number;
+    options?: FieldOption[];
+    minLength?: number;
+    maxLength?: number;
+    min?: number;
+    max?: number;
+    relatedModel?: string;
+    pattern?: string;
+}
+export interface AppFieldVisibility {
+    data?: boolean;
+    list?: boolean;
+    filters?: boolean;
+}
+export interface ModelFieldDefinition {
+    handle: string;
+    label: string;
+    type?: InternalFieldDataType;
+    definitionHandle?: string;
+    definition?: InlineFieldDefinition;
+    required?: boolean;
+    unique?: boolean;
+    system?: boolean;
+    isList?: boolean;
+    defaultValue?: {
+        value: unknown;
+    };
+    description?: string;
+    visibility?: AppFieldVisibility;
+    owner?: FieldOwner;
+}
+export interface ModelDefinition {
+    handle: string;
+    name: string;
+    namePlural?: string;
+    scope: ResourceScope;
+    labelTemplate?: string;
+    description?: string;
+    fields: ModelFieldDefinition[];
+    requires?: ResourceDependency[];
+}
+export type RelationshipCardinality = 'ONE_TO_ONE' | 'ONE_TO_MANY' | 'MANY_TO_ONE' | 'MANY_TO_MANY';
+export type OnDeleteBehavior = 'NONE' | 'CASCADE' | 'RESTRICT';
+export interface RelationshipLink {
+    model: string;
+    field: string;
+    label: string;
+    cardinality: RelationshipCardinality;
+    onDelete?: OnDeleteBehavior;
+}
+export interface RelationshipDefinition {
+    source: RelationshipLink;
+    target: RelationshipLink;
+}

package/dist/config/types/model.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });