@slates/test 1.0.0-rc.2 → 1.0.0-rc.21

package/dist/index.d.ts

@@ -1,26 +1,37 @@
-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 { createSlatesClient, SlatesProtocolClientOptions } from '@slates/client';
+import * as vitest from 'vitest';
 import { SlatesProfileRecord } from '@slates/profiles';
+import { z } from 'zod';
 
 interface SlatesRuntimeContext {
     integration: string | null;
     profileId: string | null;
+    authMethodId: string | null;
     profile: SlatesProfileRecord | null;
+    rootDir: string;
     storePath: string;
     cliDir: string;
 }
 type SlatesTestClient = ReturnType<typeof createSlatesClient>;
-type LocalSlate = Parameters<typeof createLocalSlateTransport>[0]['slate'];
+interface LocalSlateLike {
+    readonly spec: unknown;
+    readonly actions: readonly unknown[];
+}
 interface ExpectedSlateAction {
     id: string;
     name?: string;
     description?: string;
     readOnly?: boolean;
     destructive?: boolean;
+}
+interface ExpectedSlateTriggerGroup {
+    id: string;
+    name?: string;
+    description?: string;
     invocationType?: 'polling' | 'webhook';
 }
+declare let getVitestExpect: () => vitest.ExpectStatic;
 declare let loadSlatesRuntimeContext: (opts?: {
     cwd?: string;
     profile?: string | null;
@@ -45,6 +56,25 @@ declare let expectToolCall: (d: {
 }) => Promise<{
     output: Record<string, any>;
     message?: string | undefined;
+    attachments?: {
+        content: {
+            type: "url";
+            url: string;
+            headers?: Record<string, string> | undefined;
+            query?: Record<string, string> | undefined;
+            refreshReference?: unknown;
+            refreshAt?: string | undefined;
+        } | {
+            type: "content";
+            encoding: "utf-8" | "base64";
+            content: string;
+        } | {
+            type: "upload_reference";
+            referenceId: string;
+        };
+        mimeType?: string | undefined;
+        attachmentHash?: string | undefined;
+    }[] | undefined;
     requestTraces?: {
         startedAt: string;
         durationMs: number;
@@ -75,7 +105,7 @@ declare let expectToolCall: (d: {
     }[] | undefined;
 }>;
 declare let createLocalSlateTestClient: (opts: {
-    slate: LocalSlate;
+    slate: LocalSlateLike;
     state?: SlatesProtocolClientOptions["state"];
     participants?: SlatesProtocolClientOptions["participants"];
 }) => _slates_client.SlatesProtocolClient;
@@ -92,8 +122,14 @@ declare let getSlateContract: (client: SlatesTestClient) => Promise<{
         name: string;
         inputSchema: Record<string, any>;
         outputSchema: Record<string, any>;
+        docs: {
+            name: string;
+            url: string;
+            type?: "docs.action.general" | undefined;
+        }[];
         type: "action.tool";
         capabilities: Record<string, never>;
+        isPublic: boolean;
         description?: string | undefined;
         instructions?: string[] | undefined;
         constraints?: string[] | undefined;
@@ -107,21 +143,21 @@ declare let getSlateContract: (client: SlatesTestClient) => Promise<{
                 OR: string[];
             }[];
         } | undefined;
+        authMethods?: string[] | undefined;
+        adapter?: string | null | undefined;
     } | {
         id: string;
         name: string;
         inputSchema: Record<string, any>;
         outputSchema: Record<string, any>;
+        docs: {
+            name: string;
+            url: string;
+            type?: "docs.action.general" | undefined;
+        }[];
         type: "action.trigger";
         capabilities: Record<string, never>;
-        invocation: {
-            type: "polling";
-            intervalSeconds: number;
-        } | {
-            type: "webhook";
-            autoRegistration: boolean;
-            autoUnregistration: boolean;
-        };
+        triggerGroupId: string;
         description?: string | undefined;
         instructions?: string[] | undefined;
         constraints?: string[] | undefined;
@@ -135,14 +171,22 @@ declare let getSlateContract: (client: SlatesTestClient) => Promise<{
                 OR: string[];
             }[];
         } | undefined;
+        authMethods?: string[] | undefined;
+        adapter?: string | null | undefined;
     })[];
     tools: {
         id: string;
         name: string;
         inputSchema: Record<string, any>;
         outputSchema: Record<string, any>;
+        docs: {
+            name: string;
+            url: string;
+            type?: "docs.action.general" | undefined;
+        }[];
         type: "action.tool";
         capabilities: Record<string, never>;
+        isPublic: boolean;
         description?: string | undefined;
         instructions?: string[] | undefined;
         constraints?: string[] | undefined;
@@ -156,22 +200,22 @@ declare let getSlateContract: (client: SlatesTestClient) => Promise<{
                 OR: string[];
             }[];
         } | undefined;
+        authMethods?: string[] | undefined;
+        adapter?: string | null | undefined;
     }[];
     triggers: {
         id: string;
         name: string;
         inputSchema: Record<string, any>;
         outputSchema: Record<string, any>;
+        docs: {
+            name: string;
+            url: string;
+            type?: "docs.action.general" | undefined;
+        }[];
         type: "action.trigger";
         capabilities: Record<string, never>;
-        invocation: {
-            type: "polling";
-            intervalSeconds: number;
-        } | {
-            type: "webhook";
-            autoRegistration: boolean;
-            autoUnregistration: boolean;
-        };
+        triggerGroupId: string;
         description?: string | undefined;
         instructions?: string[] | undefined;
         constraints?: string[] | undefined;
@@ -185,6 +229,27 @@ declare let getSlateContract: (client: SlatesTestClient) => Promise<{
                 OR: string[];
             }[];
         } | undefined;
+        authMethods?: string[] | undefined;
+        adapter?: string | null | undefined;
+    }[];
+    triggerGroups: {
+        id: string;
+        name: string;
+        invocation: {
+            type: "polling";
+            intervalSeconds: number;
+        } | {
+            type: "webhook";
+            registration: {
+                mode: "auto";
+            } | {
+                mode: "manual";
+                userConfigSchema: Record<string, any>;
+                fullConfigSchema: Record<string, any>;
+            };
+        };
+        description?: string | undefined;
+        metadata?: Record<string, any> | undefined;
     }[];
     authMethods: {
         id: string;
@@ -206,11 +271,17 @@ declare let getSlateContract: (client: SlatesTestClient) => Promise<{
                 enabled: boolean;
             } | undefined;
         };
+        docs: {
+            name: string;
+            url: string;
+            type?: "docs.auth.oauth" | "docs.auth.oauth_scopes" | "docs.auth.token" | "docs.auth.service_account" | "docs.auth.custom" | undefined;
+        }[];
         scopes?: {
             id: string;
             title: string;
             description?: string | undefined;
         }[] | undefined;
+        adapters?: string[] | undefined;
     }[];
     configSchema: Record<string, any>;
 }>;
@@ -223,9 +294,11 @@ declare let expectSlateContract: (d: {
     };
     toolIds?: string[];
     triggerIds?: string[];
+    triggerGroupIds?: string[];
     authMethodIds?: string[];
     tools?: ExpectedSlateAction[];
     triggers?: ExpectedSlateAction[];
+    triggerGroups?: ExpectedSlateTriggerGroup[];
 }) => Promise<{
     provider: {
         type: "provider";
@@ -239,8 +312,14 @@ declare let expectSlateContract: (d: {
         name: string;
         inputSchema: Record<string, any>;
         outputSchema: Record<string, any>;
+        docs: {
+            name: string;
+            url: string;
+            type?: "docs.action.general" | undefined;
+        }[];
         type: "action.tool";
         capabilities: Record<string, never>;
+        isPublic: boolean;
         description?: string | undefined;
         instructions?: string[] | undefined;
         constraints?: string[] | undefined;
@@ -254,21 +333,21 @@ declare let expectSlateContract: (d: {
                 OR: string[];
             }[];
         } | undefined;
+        authMethods?: string[] | undefined;
+        adapter?: string | null | undefined;
     } | {
         id: string;
         name: string;
         inputSchema: Record<string, any>;
         outputSchema: Record<string, any>;
+        docs: {
+            name: string;
+            url: string;
+            type?: "docs.action.general" | undefined;
+        }[];
         type: "action.trigger";
         capabilities: Record<string, never>;
-        invocation: {
-            type: "polling";
-            intervalSeconds: number;
-        } | {
-            type: "webhook";
-            autoRegistration: boolean;
-            autoUnregistration: boolean;
-        };
+        triggerGroupId: string;
         description?: string | undefined;
         instructions?: string[] | undefined;
         constraints?: string[] | undefined;
@@ -282,14 +361,22 @@ declare let expectSlateContract: (d: {
                 OR: string[];
             }[];
         } | undefined;
+        authMethods?: string[] | undefined;
+        adapter?: string | null | undefined;
     })[];
     tools: {
         id: string;
         name: string;
         inputSchema: Record<string, any>;
         outputSchema: Record<string, any>;
+        docs: {
+            name: string;
+            url: string;
+            type?: "docs.action.general" | undefined;
+        }[];
         type: "action.tool";
         capabilities: Record<string, never>;
+        isPublic: boolean;
         description?: string | undefined;
         instructions?: string[] | undefined;
         constraints?: string[] | undefined;
@@ -303,22 +390,22 @@ declare let expectSlateContract: (d: {
                 OR: string[];
             }[];
         } | undefined;
+        authMethods?: string[] | undefined;
+        adapter?: string | null | undefined;
     }[];
     triggers: {
         id: string;
         name: string;
         inputSchema: Record<string, any>;
         outputSchema: Record<string, any>;
+        docs: {
+            name: string;
+            url: string;
+            type?: "docs.action.general" | undefined;
+        }[];
         type: "action.trigger";
         capabilities: Record<string, never>;
-        invocation: {
-            type: "polling";
-            intervalSeconds: number;
-        } | {
-            type: "webhook";
-            autoRegistration: boolean;
-            autoUnregistration: boolean;
-        };
+        triggerGroupId: string;
         description?: string | undefined;
         instructions?: string[] | undefined;
         constraints?: string[] | undefined;
@@ -332,6 +419,27 @@ declare let expectSlateContract: (d: {
                 OR: string[];
             }[];
         } | undefined;
+        authMethods?: string[] | undefined;
+        adapter?: string | null | undefined;
+    }[];
+    triggerGroups: {
+        id: string;
+        name: string;
+        invocation: {
+            type: "polling";
+            intervalSeconds: number;
+        } | {
+            type: "webhook";
+            registration: {
+                mode: "auto";
+            } | {
+                mode: "manual";
+                userConfigSchema: Record<string, any>;
+                fullConfigSchema: Record<string, any>;
+            };
+        };
+        description?: string | undefined;
+        metadata?: Record<string, any> | undefined;
     }[];
     authMethods: {
         id: string;
@@ -353,21 +461,69 @@ declare let expectSlateContract: (d: {
                 enabled: boolean;
             } | undefined;
         };
+        docs: {
+            name: string;
+            url: string;
+            type?: "docs.auth.oauth" | "docs.auth.oauth_scopes" | "docs.auth.token" | "docs.auth.service_account" | "docs.auth.custom" | undefined;
+        }[];
         scopes?: {
             id: string;
             title: string;
             description?: string | undefined;
         }[] | undefined;
+        adapters?: string[] | undefined;
     }[];
     configSchema: Record<string, any>;
 }>;
-declare let registerSlateTriggerWebhook: (d: {
+declare let registerSlateTriggerGroupWebhook: (d: {
     client: SlatesTestClient;
-    triggerId: string;
-    webhookBaseUrl: string;
+    triggerGroupId: string;
+    webhookTargetIdentifier: string;
+    webhookTargetPayload: any;
+    webhookUrl: string;
 }) => Promise<{
-    registrationDetails: any;
+    webhookRegistrationIdentifier: string;
+    webhookRegistrationPayload: 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 pollSlateTriggerGroupEvents: (d: {
+    client: SlatesTestClient;
+    triggerGroupId: string;
     state?: any;
+}) => Promise<{
+    events: {
+        payload: Record<string, any>;
+        triggerIds: string[];
+        idempotencyKey?: string | undefined;
+    }[];
+    updatedState?: any;
     requestTraces?: {
         startedAt: string;
         durationMs: number;
@@ -397,17 +553,29 @@ declare let registerSlateTriggerWebhook: (d: {
         } | undefined;
     }[] | undefined;
 }>;
-declare let handleSlateTriggerWebhook: (d: {
+declare let processSlateTriggerGroupWebhook: (d: {
     client: SlatesTestClient;
-    triggerId: string;
+    triggerGroupId: string;
     url: string;
     method?: string;
     headers?: Record<string, string>;
     body?: string | Uint8Array | null;
-    state?: any;
+    webhookRegistrationPayload?: any;
 }) => Promise<{
-    inputs: Record<string, any>[];
-    updatedState?: any;
+    events: {
+        matchers: Record<string, any>[];
+        payload: Record<string, any>;
+        triggerIds: string[];
+        idempotencyKey?: string | undefined;
+    }[];
+    response?: {
+        status: number;
+        headers: Record<string, string>;
+        body: {
+            encoding: "base64";
+            content: string;
+        } | null;
+    } | null | undefined;
     requestTraces?: {
         startedAt: string;
         durationMs: number;
@@ -437,12 +605,11 @@ declare let handleSlateTriggerWebhook: (d: {
         } | undefined;
     }[] | undefined;
 }>;
-declare let unregisterSlateTriggerWebhook: (d: {
+declare let unregisterSlateTriggerGroupWebhook: (d: {
     client: SlatesTestClient;
-    triggerId: string;
-    webhookBaseUrl: string;
-    registrationDetails: any;
-    state?: any;
+    triggerGroupId: string;
+    webhookRegistrationIdentifier: string;
+    webhookRegistrationPayload: any;
 }) => Promise<{
     requestTraces?: {
         startedAt: string;
@@ -513,6 +680,16 @@ declare let mapSlateTriggerEvent: (d: {
     }[] | 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 };
+type ToolSchemaTarget = {
+    key: string;
+    inputSchema: z.ZodType;
+};
+type ToolSchemaSource = readonly unknown[] | {
+    actions: readonly unknown[];
+};
+declare let getMcpCompatibleToolSchemaCases: (source: ToolSchemaSource) => ReadonlyArray<readonly [string, ToolSchemaTarget]>;
+declare let expectMcpCompatibleToolSchema: (tool: ToolSchemaTarget) => void;
+declare let describeMcpCompatibleToolSchemas: (name: string, source: ToolSchemaSource) => void;
+
+export { type ExpectedSlateAction, type ExpectedSlateTriggerGroup, type SlatesRuntimeContext, type SlatesTestClient, createLocalSlateTestClient, createSlatesTestClient, describeMcpCompatibleToolSchemas, expectMcpCompatibleToolSchema, expectSlateContract, expectSlateError, expectToolCall, getMcpCompatibleToolSchemaCases, getSlateContract, getVitestExpect, loadSlatesProfile, loadSlatesRuntimeContext, mapSlateTriggerEvent, pollSlateTriggerGroupEvents, processSlateTriggerGroupWebhook, registerSlateTriggerGroupWebhook, unregisterSlateTriggerGroupWebhook, withSlateProfile };