skedyul 0.1.16 → 0.1.18

package/dist/config.d.ts

@@ -118,12 +118,12 @@ export interface WorkflowAction {
     inputs?: WorkflowActionInput[];
 }
 export interface WorkflowDefinition {
-    /** Human-readable label */
-    label: string;
-    /** Workflow handle/key */
-    handle: string;
-    /** Which channel handle this workflow is associated with (optional) */
-    channelHandle?: string;
+    /** Path to external YAML workflow file (relative to config) */
+    path: string;
+    /** Human-readable label (optional when path is provided, inferred from YAML) */
+    label?: string;
+    /** Workflow handle/key (optional when path is provided, inferred from YAML) */
+    handle?: string;
     /** Actions in this workflow */
     actions: WorkflowAction[];
 }

package/dist/config.js

@@ -231,11 +231,15 @@ function validateConfig(config) {
     if (config.workflows) {
         for (let i = 0; i < config.workflows.length; i++) {
             const workflow = config.workflows[i];
-            if (!workflow.handle) {
-                errors.push(`workflows[${i}]: Missing required field 'handle'`);
-            }
-            if (!workflow.label) {
-                errors.push(`workflows[${i}]: Missing required field 'label'`);
+            // When path is provided, handle and label are optional (inferred from YAML)
+            // When path is not provided, handle and label are required
+            if (!workflow.path) {
+                if (!workflow.handle) {
+                    errors.push(`workflows[${i}]: Missing required field 'handle' (required when 'path' is not provided)`);
+                }
+                if (!workflow.label) {
+                    errors.push(`workflows[${i}]: Missing required field 'label' (required when 'path' is not provided)`);
+                }
             }
             if (!workflow.actions || workflow.actions.length === 0) {
                 errors.push(`workflows[${i}]: Must have at least one action`);

package/dist/core/client.d.ts

@@ -1,13 +1,52 @@
 import type { CommunicationChannel, Workplace } from './types';
+type ClientConfig = {
+    /** Base URL for the Skedyul Core API (e.g., "https://app.skedyul.com/api") */
+    baseUrl: string;
+    /** API token (sk_app_* for App API or sk_wkp_* for Workplace API) */
+    apiToken: string;
+};
+/**
+ * Configure the Skedyul client.
+ *
+ * Can be called to override environment variables, or to set config at runtime.
+ *
+ * @example
+ * ```ts
+ * import { configure } from 'skedyul';
+ *
+ * configure({
+ *   baseUrl: 'https://app.skedyul.com/api',
+ *   apiToken: 'sk_app_xxxxx',
+ * });
+ * ```
+ */
+export declare function configure(options: Partial<ClientConfig>): void;
+/**
+ * Get the current client configuration.
+ */
+export declare function getConfig(): Readonly<ClientConfig>;
 type ListArgs = {
     filter?: Record<string, unknown>;
+    limit?: number;
 };
 export declare const workplace: {
     list(args?: ListArgs): Promise<Workplace[]>;
     get(id: string): Promise<Workplace>;
 };
 export declare const communicationChannel: {
-    list(filter?: Record<string, unknown>): Promise<CommunicationChannel[]>;
-    get(id: string): Promise<CommunicationChannel>;
+    /**
+     * List communication channels with optional filters.
+     *
+     * @example
+     * ```ts
+     * // Find channel by phone number
+     * const channels = await communicationChannel.list({
+     *   filter: { identifierValue: '+1234567890' },
+     *   limit: 1,
+     * });
+     * ```
+     */
+    list(args?: ListArgs): Promise<CommunicationChannel[]>;
+    get(id: string): Promise<CommunicationChannel | null>;
 };
 export {};

package/dist/core/client.js

@@ -1,16 +1,60 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.communicationChannel = exports.workplace = void 0;
-const CORE_BASE = process.env.SKEDYUL_NODE_URL ?? '';
+exports.configure = configure;
+exports.getConfig = getConfig;
+let config = {
+    baseUrl: process.env.SKEDYUL_API_URL ?? process.env.SKEDYUL_NODE_URL ?? '',
+    apiToken: process.env.SKEDYUL_API_TOKEN ?? '',
+};
+/**
+ * Configure the Skedyul client.
+ *
+ * Can be called to override environment variables, or to set config at runtime.
+ *
+ * @example
+ * ```ts
+ * import { configure } from 'skedyul';
+ *
+ * configure({
+ *   baseUrl: 'https://app.skedyul.com/api',
+ *   apiToken: 'sk_app_xxxxx',
+ * });
+ * ```
+ */
+function configure(options) {
+    config = {
+        ...config,
+        ...options,
+    };
+}
+/**
+ * Get the current client configuration.
+ */
+function getConfig() {
+    return config;
+}
+// ─────────────────────────────────────────────────────────────────────────────
+// Core API Client
+// ─────────────────────────────────────────────────────────────────────────────
 async function callCore(method, params) {
-    const response = await fetch(`${CORE_BASE}/core`, {
+    const { baseUrl, apiToken } = config;
+    if (!baseUrl) {
+        throw new Error('Skedyul client not configured: missing baseUrl. Set SKEDYUL_API_URL environment variable or call configure().');
+    }
+    if (!apiToken) {
+        throw new Error('Skedyul client not configured: missing apiToken. Set SKEDYUL_API_TOKEN environment variable or call configure().');
+    }
+    const headers = {
+        'Content-Type': 'application/json',
+        Authorization: `Bearer ${apiToken}`,
+    };
+    const response = await fetch(`${baseUrl}/core`, {
         method: 'POST',
-        headers: {
-            'Content-Type': 'application/json',
-        },
+        headers,
         body: JSON.stringify({ method, params }),
     });
-    const payload = await response.json();
+    const payload = (await response.json());
     if (!response.ok) {
         throw new Error(payload?.error?.message ?? `Core API error (${response.status})`);
     }
@@ -18,21 +62,39 @@ async function callCore(method, params) {
 }
 exports.workplace = {
     async list(args) {
-        const payload = await callCore('workplace.list', args?.filter ? { filter: args.filter } : undefined);
+        const payload = (await callCore('workplace.list', {
+            ...(args?.filter ? { filter: args.filter } : {}),
+            ...(args?.limit ? { limit: args.limit } : {}),
+        }));
         return payload.workplaces;
     },
     async get(id) {
-        const payload = await callCore('workplace.get', { id });
+        const payload = (await callCore('workplace.get', { id }));
         return payload.workplace;
     },
 };
 exports.communicationChannel = {
-    async list(filter) {
-        const payload = await callCore('communicationChannel.list', filter ? { filter } : undefined);
+    /**
+     * List communication channels with optional filters.
+     *
+     * @example
+     * ```ts
+     * // Find channel by phone number
+     * const channels = await communicationChannel.list({
+     *   filter: { identifierValue: '+1234567890' },
+     *   limit: 1,
+     * });
+     * ```
+     */
+    async list(args) {
+        const payload = (await callCore('communicationChannel.list', {
+            ...(args?.filter ? { filter: args.filter } : {}),
+            ...(args?.limit ? { limit: args.limit } : {}),
+        }));
         return payload.channels;
     },
     async get(id) {
-        const payload = await callCore('communicationChannel.get', { id });
+        const payload = (await callCore('communicationChannel.get', { id }));
         return payload.channel;
     },
 };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export * from './types';
 export { server } from './server';
-export { workplace, communicationChannel } from './core/client';
+export { workplace, communicationChannel, configure, getConfig } from './core/client';
 export { defineConfig, loadConfig, validateConfig, getRequiredInstallEnvKeys, getAllEnvKeys, CONFIG_FILE_NAMES, } from './config';
 export type { SkedyulConfig, EnvVariableDefinition, EnvSchema, EnvVisibility, InstallConfig, AppModelDefinition, ComputeLayerType, AppFieldVisibility, AppFieldDefinition, ChannelToolBindings, ChannelIdentifierType, ChannelIdentifierValue, CommunicationChannelDefinition, WorkflowActionInput, WorkflowAction, WorkflowDefinition, } from './config';

package/dist/index.js

@@ -14,13 +14,15 @@ 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.CONFIG_FILE_NAMES = exports.getAllEnvKeys = exports.getRequiredInstallEnvKeys = exports.validateConfig = exports.loadConfig = exports.defineConfig = exports.communicationChannel = exports.workplace = exports.server = void 0;
+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);
 var server_1 = require("./server");
 Object.defineProperty(exports, "server", { enumerable: true, get: function () { return server_1.server; } });
 var client_1 = require("./core/client");
 Object.defineProperty(exports, "workplace", { enumerable: true, get: function () { return client_1.workplace; } });
 Object.defineProperty(exports, "communicationChannel", { enumerable: true, get: function () { return client_1.communicationChannel; } });
+Object.defineProperty(exports, "configure", { enumerable: true, get: function () { return client_1.configure; } });
+Object.defineProperty(exports, "getConfig", { enumerable: true, get: function () { return client_1.getConfig; } });
 var config_1 = require("./config");
 Object.defineProperty(exports, "defineConfig", { enumerable: true, get: function () { return config_1.defineConfig; } });
 Object.defineProperty(exports, "loadConfig", { enumerable: true, get: function () { return config_1.loadConfig; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skedyul",
-  "version": "0.1.16",
+  "version": "0.1.18",
   "description": "The Skedyul SDK for Node.js",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -34,5 +34,4 @@
     "@types/node": "^24.10.1",
     "typescript": "^5.5.0"
   }
-}
-
+}