@slates/test 1.0.0-rc.2

package/dist/index.d.ts

@@ -0,0 +1,518 @@
+import * as vite from 'vite';
+import * as _slates_client from '@slates/client';
+import { createSlatesClient, createLocalSlateTransport, SlatesProtocolClientOptions } from '@slates/client';
+import { createVitestConfig } from '@lowerdeck/testing-tools';
+import { SlatesProfileRecord } from '@slates/profiles';
+
+interface SlatesRuntimeContext {
+    integration: string | null;
+    profileId: string | null;
+    profile: SlatesProfileRecord | null;
+    storePath: string;
+    cliDir: string;
+}
+type SlatesTestClient = ReturnType<typeof createSlatesClient>;
+type LocalSlate = Parameters<typeof createLocalSlateTransport>[0]['slate'];
+interface ExpectedSlateAction {
+    id: string;
+    name?: string;
+    description?: string;
+    readOnly?: boolean;
+    destructive?: boolean;
+    invocationType?: 'polling' | 'webhook';
+}
+declare let loadSlatesRuntimeContext: (opts?: {
+    cwd?: string;
+    profile?: string | null;
+}) => Promise<SlatesRuntimeContext>;
+declare let loadSlatesProfile: (opts?: {
+    cwd?: string;
+    profile?: string | null;
+}) => Promise<SlatesProfileRecord>;
+declare let createSlatesTestClient: (opts?: {
+    cwd?: string;
+    profile?: string | null;
+}) => Promise<_slates_client.SlatesProtocolClient>;
+declare let withSlateProfile: <T>(profileName: string | null | undefined, cb: (ctx: {
+    profile: SlatesProfileRecord;
+}) => Promise<T>) => Promise<T>;
+declare let expectToolCall: (d: {
+    client?: Awaited<ReturnType<typeof createSlatesTestClient>>;
+    profile?: string | null;
+    toolId: string;
+    input: Record<string, any>;
+    output?: Record<string, any>;
+}) => Promise<{
+    output: Record<string, any>;
+    message?: string | undefined;
+    requestTraces?: {
+        startedAt: string;
+        durationMs: number;
+        request: {
+            method: string;
+            url: string;
+            headers?: Record<string, string> | undefined;
+            body?: {
+                text: string;
+                contentType?: string | undefined;
+                truncated?: boolean | undefined;
+            } | undefined;
+        };
+        response?: {
+            status: number;
+            statusText?: string | undefined;
+            headers?: Record<string, string> | undefined;
+            body?: {
+                text: string;
+                contentType?: string | undefined;
+                truncated?: boolean | undefined;
+            } | undefined;
+        } | undefined;
+        error?: {
+            message: string;
+            code?: string | undefined;
+        } | undefined;
+    }[] | undefined;
+}>;
+declare let createLocalSlateTestClient: (opts: {
+    slate: LocalSlate;
+    state?: SlatesProtocolClientOptions["state"];
+    participants?: SlatesProtocolClientOptions["participants"];
+}) => _slates_client.SlatesProtocolClient;
+declare let getSlateContract: (client: SlatesTestClient) => Promise<{
+    provider: {
+        type: "provider";
+        id: string;
+        name: string;
+        description?: string | undefined;
+        metadata?: Record<string, any> | undefined;
+    };
+    actions: ({
+        id: string;
+        name: string;
+        inputSchema: Record<string, any>;
+        outputSchema: Record<string, any>;
+        type: "action.tool";
+        capabilities: Record<string, never>;
+        description?: string | undefined;
+        instructions?: string[] | undefined;
+        constraints?: string[] | undefined;
+        tags?: {
+            destructive?: boolean | undefined;
+            readOnly?: boolean | undefined;
+        } | undefined;
+        metadata?: Record<string, any> | undefined;
+        scopes?: {
+            AND: {
+                OR: string[];
+            }[];
+        } | undefined;
+    } | {
+        id: string;
+        name: string;
+        inputSchema: Record<string, any>;
+        outputSchema: Record<string, any>;
+        type: "action.trigger";
+        capabilities: Record<string, never>;
+        invocation: {
+            type: "polling";
+            intervalSeconds: number;
+        } | {
+            type: "webhook";
+            autoRegistration: boolean;
+            autoUnregistration: boolean;
+        };
+        description?: string | undefined;
+        instructions?: string[] | undefined;
+        constraints?: string[] | undefined;
+        tags?: {
+            destructive?: boolean | undefined;
+            readOnly?: boolean | undefined;
+        } | undefined;
+        metadata?: Record<string, any> | undefined;
+        scopes?: {
+            AND: {
+                OR: string[];
+            }[];
+        } | undefined;
+    })[];
+    tools: {
+        id: string;
+        name: string;
+        inputSchema: Record<string, any>;
+        outputSchema: Record<string, any>;
+        type: "action.tool";
+        capabilities: Record<string, never>;
+        description?: string | undefined;
+        instructions?: string[] | undefined;
+        constraints?: string[] | undefined;
+        tags?: {
+            destructive?: boolean | undefined;
+            readOnly?: boolean | undefined;
+        } | undefined;
+        metadata?: Record<string, any> | undefined;
+        scopes?: {
+            AND: {
+                OR: string[];
+            }[];
+        } | undefined;
+    }[];
+    triggers: {
+        id: string;
+        name: string;
+        inputSchema: Record<string, any>;
+        outputSchema: Record<string, any>;
+        type: "action.trigger";
+        capabilities: Record<string, never>;
+        invocation: {
+            type: "polling";
+            intervalSeconds: number;
+        } | {
+            type: "webhook";
+            autoRegistration: boolean;
+            autoUnregistration: boolean;
+        };
+        description?: string | undefined;
+        instructions?: string[] | undefined;
+        constraints?: string[] | undefined;
+        tags?: {
+            destructive?: boolean | undefined;
+            readOnly?: boolean | undefined;
+        } | undefined;
+        metadata?: Record<string, any> | undefined;
+        scopes?: {
+            AND: {
+                OR: string[];
+            }[];
+        } | undefined;
+    }[];
+    authMethods: {
+        id: string;
+        name: string;
+        type: "auth.oauth" | "auth.token" | "auth.service_account" | "auth.custom";
+        inputSchema: Record<string, any>;
+        outputSchema: Record<string, any>;
+        capabilities: {
+            getDefaultInput?: {
+                enabled: boolean;
+            } | undefined;
+            handleChangedInput?: {
+                enabled: boolean;
+            } | undefined;
+            handleTokenRefresh?: {
+                enabled: boolean;
+            } | undefined;
+            getProfile?: {
+                enabled: boolean;
+            } | undefined;
+        };
+        scopes?: {
+            id: string;
+            title: string;
+            description?: string | undefined;
+        }[] | undefined;
+    }[];
+    configSchema: Record<string, any>;
+}>;
+declare let expectSlateContract: (d: {
+    client: SlatesTestClient;
+    provider?: {
+        id: string;
+        name?: string;
+        description?: string;
+    };
+    toolIds?: string[];
+    triggerIds?: string[];
+    authMethodIds?: string[];
+    tools?: ExpectedSlateAction[];
+    triggers?: ExpectedSlateAction[];
+}) => Promise<{
+    provider: {
+        type: "provider";
+        id: string;
+        name: string;
+        description?: string | undefined;
+        metadata?: Record<string, any> | undefined;
+    };
+    actions: ({
+        id: string;
+        name: string;
+        inputSchema: Record<string, any>;
+        outputSchema: Record<string, any>;
+        type: "action.tool";
+        capabilities: Record<string, never>;
+        description?: string | undefined;
+        instructions?: string[] | undefined;
+        constraints?: string[] | undefined;
+        tags?: {
+            destructive?: boolean | undefined;
+            readOnly?: boolean | undefined;
+        } | undefined;
+        metadata?: Record<string, any> | undefined;
+        scopes?: {
+            AND: {
+                OR: string[];
+            }[];
+        } | undefined;
+    } | {
+        id: string;
+        name: string;
+        inputSchema: Record<string, any>;
+        outputSchema: Record<string, any>;
+        type: "action.trigger";
+        capabilities: Record<string, never>;
+        invocation: {
+            type: "polling";
+            intervalSeconds: number;
+        } | {
+            type: "webhook";
+            autoRegistration: boolean;
+            autoUnregistration: boolean;
+        };
+        description?: string | undefined;
+        instructions?: string[] | undefined;
+        constraints?: string[] | undefined;
+        tags?: {
+            destructive?: boolean | undefined;
+            readOnly?: boolean | undefined;
+        } | undefined;
+        metadata?: Record<string, any> | undefined;
+        scopes?: {
+            AND: {
+                OR: string[];
+            }[];
+        } | undefined;
+    })[];
+    tools: {
+        id: string;
+        name: string;
+        inputSchema: Record<string, any>;
+        outputSchema: Record<string, any>;
+        type: "action.tool";
+        capabilities: Record<string, never>;
+        description?: string | undefined;
+        instructions?: string[] | undefined;
+        constraints?: string[] | undefined;
+        tags?: {
+            destructive?: boolean | undefined;
+            readOnly?: boolean | undefined;
+        } | undefined;
+        metadata?: Record<string, any> | undefined;
+        scopes?: {
+            AND: {
+                OR: string[];
+            }[];
+        } | undefined;
+    }[];
+    triggers: {
+        id: string;
+        name: string;
+        inputSchema: Record<string, any>;
+        outputSchema: Record<string, any>;
+        type: "action.trigger";
+        capabilities: Record<string, never>;
+        invocation: {
+            type: "polling";
+            intervalSeconds: number;
+        } | {
+            type: "webhook";
+            autoRegistration: boolean;
+            autoUnregistration: boolean;
+        };
+        description?: string | undefined;
+        instructions?: string[] | undefined;
+        constraints?: string[] | undefined;
+        tags?: {
+            destructive?: boolean | undefined;
+            readOnly?: boolean | undefined;
+        } | undefined;
+        metadata?: Record<string, any> | undefined;
+        scopes?: {
+            AND: {
+                OR: string[];
+            }[];
+        } | undefined;
+    }[];
+    authMethods: {
+        id: string;
+        name: string;
+        type: "auth.oauth" | "auth.token" | "auth.service_account" | "auth.custom";
+        inputSchema: Record<string, any>;
+        outputSchema: Record<string, any>;
+        capabilities: {
+            getDefaultInput?: {
+                enabled: boolean;
+            } | undefined;
+            handleChangedInput?: {
+                enabled: boolean;
+            } | undefined;
+            handleTokenRefresh?: {
+                enabled: boolean;
+            } | undefined;
+            getProfile?: {
+                enabled: boolean;
+            } | undefined;
+        };
+        scopes?: {
+            id: string;
+            title: string;
+            description?: string | undefined;
+        }[] | undefined;
+    }[];
+    configSchema: Record<string, any>;
+}>;
+declare let registerSlateTriggerWebhook: (d: {
+    client: SlatesTestClient;
+    triggerId: string;
+    webhookBaseUrl: string;
+}) => Promise<{
+    registrationDetails: any;
+    state?: any;
+    requestTraces?: {
+        startedAt: string;
+        durationMs: number;
+        request: {
+            method: string;
+            url: string;
+            headers?: Record<string, string> | undefined;
+            body?: {
+                text: string;
+                contentType?: string | undefined;
+                truncated?: boolean | undefined;
+            } | undefined;
+        };
+        response?: {
+            status: number;
+            statusText?: string | undefined;
+            headers?: Record<string, string> | undefined;
+            body?: {
+                text: string;
+                contentType?: string | undefined;
+                truncated?: boolean | undefined;
+            } | undefined;
+        } | undefined;
+        error?: {
+            message: string;
+            code?: string | undefined;
+        } | undefined;
+    }[] | undefined;
+}>;
+declare let handleSlateTriggerWebhook: (d: {
+    client: SlatesTestClient;
+    triggerId: string;
+    url: string;
+    method?: string;
+    headers?: Record<string, string>;
+    body?: string | Uint8Array | null;
+    state?: any;
+}) => Promise<{
+    inputs: Record<string, any>[];
+    updatedState?: any;
+    requestTraces?: {
+        startedAt: string;
+        durationMs: number;
+        request: {
+            method: string;
+            url: string;
+            headers?: Record<string, string> | undefined;
+            body?: {
+                text: string;
+                contentType?: string | undefined;
+                truncated?: boolean | undefined;
+            } | undefined;
+        };
+        response?: {
+            status: number;
+            statusText?: string | undefined;
+            headers?: Record<string, string> | undefined;
+            body?: {
+                text: string;
+                contentType?: string | undefined;
+                truncated?: boolean | undefined;
+            } | undefined;
+        } | undefined;
+        error?: {
+            message: string;
+            code?: string | undefined;
+        } | undefined;
+    }[] | undefined;
+}>;
+declare let unregisterSlateTriggerWebhook: (d: {
+    client: SlatesTestClient;
+    triggerId: string;
+    webhookBaseUrl: string;
+    registrationDetails: any;
+    state?: any;
+}) => Promise<{
+    requestTraces?: {
+        startedAt: string;
+        durationMs: number;
+        request: {
+            method: string;
+            url: string;
+            headers?: Record<string, string> | undefined;
+            body?: {
+                text: string;
+                contentType?: string | undefined;
+                truncated?: boolean | undefined;
+            } | undefined;
+        };
+        response?: {
+            status: number;
+            statusText?: string | undefined;
+            headers?: Record<string, string> | undefined;
+            body?: {
+                text: string;
+                contentType?: string | undefined;
+                truncated?: boolean | undefined;
+            } | undefined;
+        } | undefined;
+        error?: {
+            message: string;
+            code?: string | undefined;
+        } | undefined;
+    }[] | undefined;
+}>;
+declare let mapSlateTriggerEvent: (d: {
+    client: SlatesTestClient;
+    triggerId: string;
+    input: Record<string, any>;
+    output?: Record<string, any>;
+    type?: string;
+}) => Promise<{
+    type: string;
+    id: string;
+    output: Record<string, any>;
+    requestTraces?: {
+        startedAt: string;
+        durationMs: number;
+        request: {
+            method: string;
+            url: string;
+            headers?: Record<string, string> | undefined;
+            body?: {
+                text: string;
+                contentType?: string | undefined;
+                truncated?: boolean | undefined;
+            } | undefined;
+        };
+        response?: {
+            status: number;
+            statusText?: string | undefined;
+            headers?: Record<string, string> | undefined;
+            body?: {
+                text: string;
+                contentType?: string | undefined;
+                truncated?: boolean | undefined;
+            } | undefined;
+        } | undefined;
+        error?: {
+            message: string;
+            code?: string | undefined;
+        } | undefined;
+    }[] | undefined;
+}>;
+declare let expectSlateError: (run: Promise<unknown> | (() => Promise<unknown>), expected: Record<string, any> | string | RegExp) => Promise<unknown>;
+declare let createSlatesVitestConfig: (config?: Parameters<typeof createVitestConfig>[0]) => vite.UserConfig;
+
+export { type ExpectedSlateAction, type SlatesRuntimeContext, type SlatesTestClient, createLocalSlateTestClient, createSlatesTestClient, createSlatesVitestConfig, expectSlateContract, expectSlateError, expectToolCall, getSlateContract, handleSlateTriggerWebhook, loadSlatesProfile, loadSlatesRuntimeContext, mapSlateTriggerEvent, registerSlateTriggerWebhook, unregisterSlateTriggerWebhook, withSlateProfile };