skedyul 0.3.0 → 0.3.2

package/dist/types.d.ts

@@ -1,464 +1,7 @@
-import type { CoreApiConfig } from './core/types';
-import { z } from 'zod';
-/** App info - always present in all contexts */
-export interface AppInfo {
-    id: string;
-    versionId: string;
-}
-/** Workplace info - present in runtime contexts */
-export interface WorkplaceInfo {
-    id: string;
-    subdomain: string;
-}
-/** Request info - present in runtime contexts */
-export interface RequestInfo {
-    url: string;
-    params: Record<string, string>;
-    query: Record<string, string>;
-}
-/** Trigger types for tool execution */
-export type ToolTrigger = 'provision' | 'field_change' | 'page_action' | 'form_submit' | 'agent' | 'workflow' | 'page_context';
-/** Base context shared by all tool executions */
-interface BaseToolContext {
-    /** Environment variables */
-    env: Record<string, string | undefined>;
-    /** Execution mode - 'estimate' returns billing info without side effects */
-    mode: 'execute' | 'estimate';
-    /** App info - always present */
-    app: AppInfo;
-}
-/** Provision context - no installation, no workplace */
-export interface ProvisionToolContext extends BaseToolContext {
-    trigger: 'provision';
-}
-/** Runtime base - has installation, workplace, request */
-interface RuntimeToolContext extends BaseToolContext {
-    appInstallationId: string;
-    workplace: WorkplaceInfo;
-    request: RequestInfo;
-}
-/** Field change context */
-export interface FieldChangeToolContext extends RuntimeToolContext {
-    trigger: 'field_change';
-    field: {
-        handle: string;
-        type: string;
-        pageHandle: string;
-        value: unknown;
-        previousValue?: unknown;
-    };
-}
-/** Page action context */
-export interface PageActionToolContext extends RuntimeToolContext {
-    trigger: 'page_action';
-    page: {
-        handle: string;
-        values: Record<string, unknown>;
-    };
-}
-/** Form submit context */
-export interface FormSubmitToolContext extends RuntimeToolContext {
-    trigger: 'form_submit';
-    form: {
-        handle: string;
-        values: Record<string, unknown>;
-    };
-}
-/** Agent-triggered context */
-export interface AgentToolContext extends RuntimeToolContext {
-    trigger: 'agent';
-}
-/** Workflow-triggered context */
-export interface WorkflowToolContext extends RuntimeToolContext {
-    trigger: 'workflow';
-}
-/** Discriminated union of all tool execution contexts */
-export type ToolExecutionContext = ProvisionToolContext | FieldChangeToolContext | PageActionToolContext | FormSubmitToolContext | AgentToolContext | WorkflowToolContext;
-/** Type guard for provision context */
-export declare function isProvisionContext(ctx: ToolExecutionContext): ctx is ProvisionToolContext;
-/** Type guard for runtime context (any non-provision trigger) */
-export declare function isRuntimeContext(ctx: ToolExecutionContext): ctx is FieldChangeToolContext | PageActionToolContext | FormSubmitToolContext | AgentToolContext | WorkflowToolContext;
 /**
- * Input type for Provision lifecycle tools (onProvision, onDeprovision).
- * These tools receive no user input - all data comes from context.
- */
-export type ProvisionToolInput = Record<string, never>;
-export interface BillingInfo {
-    credits: number;
-}
-/**
- * Standardized metadata for tool responses.
- * Provides consistent structure for AI evaluation, logging, and debugging.
- */
-export declare const ToolResponseMetaSchema: z.ZodObject<{
-    success: z.ZodBoolean;
-    message: z.ZodString;
-    toolName: z.ZodString;
-}, z.core.$strip>;
-export type ToolResponseMeta = z.infer<typeof ToolResponseMetaSchema>;
-/**
- * Client-side effects that the tool wants the UI to execute.
- * These are separate from the data output and represent navigation/UI actions.
- */
-export interface ToolEffect {
-    /** URL to navigate to after the tool completes */
-    redirect?: string;
-}
-/**
- * Structured error information for tool execution results.
- * Uses codes for serialization and workflow detection.
- */
-export interface ToolError {
-    code: string;
-    message: string;
-}
-export interface ToolExecutionResult<Output = unknown> {
-    /** Tool-specific output data. Null on error. */
-    output: Output | null;
-    /** Billing information */
-    billing: BillingInfo;
-    /** Standardized response metadata for AI evaluation and debugging */
-    meta: ToolResponseMeta;
-    /** Optional client-side effects to execute */
-    effect?: ToolEffect;
-    /** Structured error information (null/undefined if no error) */
-    error?: ToolError | null;
-}
-export interface ToolSchemaWithJson<Schema extends z.ZodTypeAny = z.ZodTypeAny> {
-    zod: Schema;
-    jsonSchema?: Record<string, unknown>;
-}
-export type ToolSchema<Schema extends z.ZodTypeAny = z.ZodTypeAny> = Schema | ToolSchemaWithJson<Schema>;
-/**
- * Tool handler function signature.
- * Receives tool-specific input as first argument and standardized context as second.
- */
-export type ToolHandler<Input, Output> = (input: Input, context: ToolExecutionContext) => Promise<ToolExecutionResult<Output>> | ToolExecutionResult<Output>;
-export interface ToolDefinition<Input = unknown, Output = unknown, InputSchema extends z.ZodTypeAny = z.ZodType<Input>, OutputSchema extends z.ZodTypeAny = z.ZodType<Output>> {
-    name: string;
-    label?: string;
-    description: string;
-    inputSchema: ToolSchema<InputSchema>;
-    handler: ToolHandler<Input, Output>;
-    outputSchema?: ToolSchema<OutputSchema>;
-    /** Timeout in milliseconds. Defaults to 10000 (10 seconds) if not specified. */
-    timeout?: number;
-    [key: string]: unknown;
-}
-export interface ToolRegistryEntry {
-    name: string;
-    label?: string;
-    description: string;
-    inputSchema: ToolSchema;
-    handler: unknown;
-    outputSchema?: ToolSchema;
-    [key: string]: unknown;
-}
-export type ToolRegistry = Record<string, ToolRegistryEntry>;
-export type ToolName<T extends ToolRegistry> = Extract<keyof T, string>;
-export interface ToolMetadata {
-    name: string;
-    displayName?: string;
-    description: string;
-    inputSchema?: Record<string, unknown>;
-    outputSchema?: Record<string, unknown>;
-    /** Timeout in milliseconds. Defaults to 10000 (10 seconds) if not specified. */
-    timeout?: number;
-}
-export interface HealthStatus {
-    status: 'running';
-    requests: number;
-    maxRequests: number | null;
-    requestsRemaining: number | null;
-    lastRequestTime: number;
-    ttlExtendSeconds: number;
-    runtime: string;
-    tools: string[];
-}
-export type ComputeLayer = 'dedicated' | 'serverless';
-export interface ServerMetadata {
-    name: string;
-    version: string;
-}
-export interface CorsOptions {
-    allowOrigin?: string;
-    allowMethods?: string;
-    allowHeaders?: string;
-}
-/**
- * Base ServerHooks type with common fields
- */
-type BaseServerHooks = {
-    /** Called after app version provisioning to set up version-level resources */
-    provision?: ProvisionHandler | {
-        handler: ProvisionHandler;
-        /** Timeout in milliseconds. Defaults to 300000 (5 minutes) if not specified. */
-        timeout?: number;
-    };
-    /** Called during app uninstallation to clean up external resources */
-    uninstall?: UninstallHandler | {
-        handler: UninstallHandler;
-        /** Timeout in milliseconds. Defaults to 60000 (1 minute) if not specified. */
-        timeout?: number;
-    };
-};
-/**
- * ServerHooks when oauth_callback is present.
- * In this case, install handler MUST return a redirect.
- */
-export type ServerHooksWithOAuth = BaseServerHooks & {
-    /** Called during app installation to validate/normalize env and perform setup */
-    install: InstallHandler<ServerHooksWithOAuth> | {
-        handler: InstallHandler<ServerHooksWithOAuth>;
-        /** Timeout in milliseconds. Defaults to 60000 (1 minute) if not specified. */
-        timeout?: number;
-    };
-    /** Called when OAuth provider redirects back with authorization code */
-    oauth_callback: OAuthCallbackHandler | {
-        handler: OAuthCallbackHandler;
-        /** Timeout in milliseconds. Defaults to 60000 (1 minute) if not specified. */
-        timeout?: number;
-    };
-};
-/**
- * ServerHooks when oauth_callback is not present.
- * In this case, install handler may optionally return a redirect.
- */
-export type ServerHooksWithoutOAuth = BaseServerHooks & {
-    /** Called during app installation to validate/normalize env and perform setup */
-    install?: InstallHandler<ServerHooksWithoutOAuth> | {
-        handler: InstallHandler<ServerHooksWithoutOAuth>;
-        /** Timeout in milliseconds. Defaults to 60000 (1 minute) if not specified. */
-        timeout?: number;
-    };
-    /** Called when OAuth provider redirects back with authorization code */
-    oauth_callback?: never;
-};
-/**
- * Lifecycle hooks for the Skedyul server.
- * These handlers are called during app installation and provisioning.
+ * Types module - re-exports from the types folder
  *
- * If oauth_callback is defined, install handler MUST return a redirect.
- */
-export type ServerHooks = ServerHooksWithOAuth | ServerHooksWithoutOAuth;
-export interface SkedyulServerConfig {
-    computeLayer: ComputeLayer;
-    metadata: ServerMetadata;
-    defaultPort?: number;
-    maxRequests?: number | null;
-    ttlExtendSeconds?: number;
-    cors?: CorsOptions;
-    coreApi?: CoreApiConfig;
-    /** Lifecycle hooks for install and provision handlers */
-    hooks?: ServerHooks;
-}
-export interface InstallHandlerContext {
-    env: Record<string, string>;
-    workplace: {
-        id: string;
-        subdomain: string;
-    };
-    appInstallationId: string;
-    app: {
-        id: string;
-        versionId: string;
-        handle: string;
-        versionHandle: string;
-    };
-}
-export interface InstallHandlerResponseOAuth {
-    env?: Record<string, string>;
-    redirect: string;
-}
-export interface InstallHandlerResponseStandard {
-    env?: Record<string, string>;
-    redirect?: string;
-}
-export type HasOAuthCallback<Hooks extends ServerHooks> = Hooks extends {
-    oauth_callback: any;
-} ? true : false;
-export type InstallHandlerResult<Hooks extends ServerHooks = ServerHooks> = HasOAuthCallback<Hooks> extends true ? InstallHandlerResponseOAuth : InstallHandlerResponseStandard;
-export type InstallHandler<Hooks extends ServerHooks = ServerHooks> = (ctx: InstallHandlerContext) => Promise<InstallHandlerResult<Hooks>>;
-export interface UninstallHandlerContext {
-    env: Record<string, string>;
-    workplace: {
-        id: string;
-        subdomain: string;
-    };
-    appInstallationId: string;
-    app: {
-        id: string;
-        versionId: string;
-        handle: string;
-        versionHandle: string;
-    };
-}
-export interface UninstallHandlerResult {
-    cleanedWebhookIds?: string[];
-}
-export type UninstallHandler = (ctx: UninstallHandlerContext) => Promise<UninstallHandlerResult>;
-export interface OAuthCallbackContext {
-    /** Full HTTP request from the OAuth provider */
-    request: WebhookRequest;
-}
-export interface OAuthCallbackResult {
-    env?: Record<string, string>;
-    appInstallationId?: string;
-}
-export type OAuthCallbackHandler = (ctx: OAuthCallbackContext) => Promise<OAuthCallbackResult>;
-export interface ProvisionHandlerContext {
-    env: Record<string, string>;
-    app: {
-        id: string;
-        versionId: string;
-    };
-}
-export interface ProvisionHandlerResult {
-}
-export type ProvisionHandler = (ctx: ProvisionHandlerContext) => Promise<ProvisionHandlerResult>;
-export interface APIGatewayProxyEvent {
-    body: string | null;
-    headers: Record<string, string>;
-    httpMethod: string;
-    path: string;
-    queryStringParameters: Record<string, string> | null;
-    requestContext: {
-        requestId: string;
-    };
-}
-export interface APIGatewayProxyResult {
-    statusCode: number;
-    headers?: Record<string, string>;
-    body: string;
-}
-export interface ToolCallResponse {
-    output: unknown | null;
-    billing: BillingInfo;
-    meta: ToolResponseMeta;
-    error?: ToolError | null;
-    effect?: ToolEffect;
-}
-export interface DedicatedServerInstance {
-    listen(port?: number): Promise<void>;
-    getHealthStatus(): HealthStatus;
-}
-export interface ServerlessServerInstance {
-    handler(event: APIGatewayProxyEvent): Promise<APIGatewayProxyResult>;
-    getHealthStatus(): HealthStatus;
-}
-export type SkedyulServerInstance = DedicatedServerInstance | ServerlessServerInstance;
-/**
- * Raw HTTP request shape sent over the wire in handler envelopes.
- * This is the wire format used by both webhooks and OAuth callbacks.
- * It gets converted to the rich WebhookRequest type at parse time.
- */
-export interface HandlerRawRequest {
-    method: string;
-    url: string;
-    path: string;
-    headers: Record<string, string>;
-    query: Record<string, string>;
-    body: string;
-}
-/** Raw HTTP request received by webhooks */
-export interface WebhookRequest {
-    method: string;
-    url: string;
-    path: string;
-    headers: Record<string, string | string[] | undefined>;
-    query: Record<string, string>;
-    /** Raw body - could be Buffer, string, or parsed object depending on content type */
-    body: Buffer | string | unknown;
-    /** Original raw body as Buffer if available */
-    rawBody?: Buffer;
-}
-export interface WebhookResponse {
-    status?: number;
-    headers?: Record<string, string>;
-    body?: unknown;
-}
-/** Base webhook context */
-interface BaseWebhookContext {
-    /** Environment variables */
-    env: Record<string, string | undefined>;
-    /** App info */
-    app: AppInfo;
-}
-/** Provision-level webhook context - no installation or workplace */
-export interface ProvisionWebhookContext extends BaseWebhookContext {
-}
-/** Runtime webhook context - has installation and workplace */
-export interface RuntimeWebhookContext extends BaseWebhookContext {
-    appInstallationId: string;
-    workplace: WorkplaceInfo;
-    /** Registration metadata passed when webhook.create() was called */
-    registration?: Record<string, unknown>;
-}
-/** Discriminated union of webhook contexts */
-export type WebhookContext = ProvisionWebhookContext | RuntimeWebhookContext;
-/** Type guard for runtime webhook context */
-export declare function isRuntimeWebhookContext(ctx: WebhookContext): ctx is RuntimeWebhookContext;
-export type WebhookHandler = (request: WebhookRequest, context: WebhookContext) => Promise<WebhookResponse> | WebhookResponse;
-export interface WebhookLifecycleContext {
-    /** The Skedyul-generated webhook URL for this webhook */
-    webhookUrl: string;
-    /** Environment variables available during lifecycle operation */
-    env: Record<string, string | undefined>;
-}
-export interface CommunicationChannelLifecycleContext extends WebhookLifecycleContext {
-    /** The communication channel being configured */
-    communicationChannel: {
-        id: string;
-        /** The identifier value (e.g., phone number like "+15551234567") */
-        identifierValue: string;
-        /** The channel handle (e.g., "sms") */
-        handle: string;
-    };
-}
-export interface WebhookLifecycleResult {
-    /** External ID from the provider (e.g., Twilio phone number SID) */
-    externalId: string;
-    /** Optional message describing what was configured */
-    message?: string;
-    /** Optional metadata from the provider */
-    metadata?: Record<string, unknown>;
-}
-/**
- * Lifecycle hook for webhook operations.
- * Return null if the API doesn't support programmatic management.
- */
-export type WebhookLifecycleHook<TContext = WebhookLifecycleContext> = (context: TContext) => Promise<WebhookLifecycleResult | null | undefined> | WebhookLifecycleResult | null | undefined;
-/**
- * Webhook invocation type - determines how responses are handled.
- * - WEBHOOK: Fire-and-forget. Returns 200 immediately, processes asynchronously.
- * - CALLBACK: Waits for handler response and returns it to the caller (e.g., Twilio TwiML).
+ * This file maintains backward compatibility while the actual type definitions
+ * have been split into smaller, focused modules in the types/ folder.
  */
-export type WebhookType = 'WEBHOOK' | 'CALLBACK';
-export interface WebhookDefinition {
-    name: string;
-    description: string;
-    /** HTTP methods this webhook accepts. Defaults to ['POST'] */
-    methods?: ('GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH')[];
-    /**
-     * Invocation type. Defaults to 'WEBHOOK' (fire-and-forget).
-     * Use 'CALLBACK' when the caller expects the handler's response (e.g., Twilio TwiML).
-     */
-    type?: WebhookType;
-    handler: WebhookHandler;
-    onAppInstalled?: WebhookLifecycleHook;
-    onAppUninstalled?: WebhookLifecycleHook;
-    onAppVersionProvisioned?: WebhookLifecycleHook;
-    onAppVersionDeprovisioned?: WebhookLifecycleHook;
-    onCommunicationChannelCreated?: WebhookLifecycleHook<CommunicationChannelLifecycleContext>;
-    onCommunicationChannelUpdated?: WebhookLifecycleHook<CommunicationChannelLifecycleContext>;
-    onCommunicationChannelDeleted?: WebhookLifecycleHook<CommunicationChannelLifecycleContext>;
-}
-export type WebhookRegistry = Record<string, WebhookDefinition>;
-export type WebhookName<T extends WebhookRegistry> = Extract<keyof T, string>;
-export interface WebhookMetadata {
-    name: string;
-    description: string;
-    methods: string[];
-    type: WebhookType;
-}
-export {};
+export * from './types/index';

package/dist/types.js

@@ -1,34 +1,24 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ToolResponseMetaSchema = void 0;
-exports.isProvisionContext = isProvisionContext;
-exports.isRuntimeContext = isRuntimeContext;
-exports.isRuntimeWebhookContext = isRuntimeWebhookContext;
-const zod_1 = require("zod");
-/** Type guard for provision context */
-function isProvisionContext(ctx) {
-    return ctx.trigger === 'provision';
-}
-/** Type guard for runtime context (any non-provision trigger) */
-function isRuntimeContext(ctx) {
-    return ctx.trigger !== 'provision';
-}
-// ─────────────────────────────────────────────────────────────────────────────
-// Tool Response Meta
-// ─────────────────────────────────────────────────────────────────────────────
 /**
- * Standardized metadata for tool responses.
- * Provides consistent structure for AI evaluation, logging, and debugging.
+ * Types module - re-exports from the types folder
+ *
+ * This file maintains backward compatibility while the actual type definitions
+ * have been split into smaller, focused modules in the types/ folder.
  */
-exports.ToolResponseMetaSchema = zod_1.z.object({
-    /** Whether the tool execution succeeded */
-    success: zod_1.z.boolean(),
-    /** Human-readable message describing the result or error */
-    message: zod_1.z.string(),
-    /** Name of the tool that was executed */
-    toolName: zod_1.z.string(),
-});
-/** Type guard for runtime webhook context */
-function isRuntimeWebhookContext(ctx) {
-    return 'appInstallationId' in ctx && ctx.appInstallationId !== undefined;
-}
+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 everything from the types module
+__exportStar(require("./types/index"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skedyul",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "The Skedyul SDK for Node.js",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -20,7 +20,7 @@
   "scripts": {
     "build": "tsc --build tsconfig.json && tsc --project tsconfig.tests.json && node -e \"require('fs').mkdirSync('dist',{recursive:true}); require('fs').writeFileSync('dist/.build-stamp', String(Date.now()))\"",
     "dev": "npx nodemon --watch src --ext js,ts --exec \"pnpm run build\"",
-    "test": "npm run build && node --test dist-tests/server.test.js"
+    "test": "npm run build && node --test dist-tests/server.test.js dist-tests/cli.test.js"
   },
   "keywords": [
     "mcp",