@slates/client 1.0.0-rc.12 → 1.0.0-rc.14

package/dist/index.cjs

@@ -343,7 +343,8 @@ var SlatesProtocolClient = class {
         encoding: "base64",
         content: encodedBody
       } : null,
-      state: d.state ?? null
+      state: d.state ?? null,
+      registrationDetails: d.registrationDetails ?? null
     });
   }
   async unregisterTriggerWebhook(d) {

package/dist/index.d.cts

@@ -74,6 +74,7 @@ declare class SlatesProtocolClient {
                 OR: string[];
             }[];
         } | undefined;
+        authMethods?: string[] | undefined;
     }>;
     getTrigger(actionId: string): Promise<{
         id: string;
@@ -94,6 +95,26 @@ declare class SlatesProtocolClient {
             type: "webhook";
             autoRegistration: boolean;
             autoUnregistration: boolean;
+            http?: {
+                methods?: ("GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS")[] | undefined;
+                sync?: {
+                    mode: "match" | "never" | "always";
+                    match?: {
+                        method?: string | undefined;
+                        hasQueryParam?: string | undefined;
+                        hasHeader?: string | undefined;
+                        jsonBodyField?: {
+                            path: string;
+                            equals?: string | undefined;
+                        } | undefined;
+                        formBodyField?: {
+                            path: string;
+                            equals?: string | undefined;
+                        } | undefined;
+                    }[] | undefined;
+                    timeoutMs?: number | undefined;
+                } | undefined;
+            } | undefined;
         };
         description?: string | undefined;
         instructions?: string[] | undefined;
@@ -108,6 +129,7 @@ declare class SlatesProtocolClient {
                 OR: string[];
             }[];
         } | undefined;
+        authMethods?: string[] | undefined;
     }>;
     getConfigSchema(): Promise<SlatesMessageConfigSchemaGetResponse['result']>;
     getDefaultConfig(): Promise<SlatesMessageConfigDefaultGetResponse['result']>;
@@ -175,6 +197,7 @@ declare class SlatesProtocolClient {
         headers?: Record<string, string>;
         body?: string | Uint8Array | null;
         state?: any;
+        registrationDetails?: any;
     }): Promise<SlatesMessageActionTriggerWebhookHandleResponse['result']>;
     unregisterTriggerWebhook(d: {
         actionId: string;

package/dist/index.d.ts

@@ -74,6 +74,7 @@ declare class SlatesProtocolClient {
                 OR: string[];
             }[];
         } | undefined;
+        authMethods?: string[] | undefined;
     }>;
     getTrigger(actionId: string): Promise<{
         id: string;
@@ -94,6 +95,26 @@ declare class SlatesProtocolClient {
             type: "webhook";
             autoRegistration: boolean;
             autoUnregistration: boolean;
+            http?: {
+                methods?: ("GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS")[] | undefined;
+                sync?: {
+                    mode: "match" | "never" | "always";
+                    match?: {
+                        method?: string | undefined;
+                        hasQueryParam?: string | undefined;
+                        hasHeader?: string | undefined;
+                        jsonBodyField?: {
+                            path: string;
+                            equals?: string | undefined;
+                        } | undefined;
+                        formBodyField?: {
+                            path: string;
+                            equals?: string | undefined;
+                        } | undefined;
+                    }[] | undefined;
+                    timeoutMs?: number | undefined;
+                } | undefined;
+            } | undefined;
         };
         description?: string | undefined;
         instructions?: string[] | undefined;
@@ -108,6 +129,7 @@ declare class SlatesProtocolClient {
                 OR: string[];
             }[];
         } | undefined;
+        authMethods?: string[] | undefined;
     }>;
     getConfigSchema(): Promise<SlatesMessageConfigSchemaGetResponse['result']>;
     getDefaultConfig(): Promise<SlatesMessageConfigDefaultGetResponse['result']>;
@@ -175,6 +197,7 @@ declare class SlatesProtocolClient {
         headers?: Record<string, string>;
         body?: string | Uint8Array | null;
         state?: any;
+        registrationDetails?: any;
     }): Promise<SlatesMessageActionTriggerWebhookHandleResponse['result']>;
     unregisterTriggerWebhook(d: {
         actionId: string;

package/dist/index.module.js

@@ -316,7 +316,8 @@ var SlatesProtocolClient = class {
         encoding: "base64",
         content: encodedBody
       } : null,
-      state: d.state ?? null
+      state: d.state ?? null,
+      registrationDetails: d.registrationDetails ?? null
     });
   }
   async unregisterTriggerWebhook(d) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@slates/client",
-  "version": "1.0.0-rc.12",
+  "version": "1.0.0-rc.14",
   "publishConfig": {
     "access": "public"
   },
@@ -31,9 +31,9 @@
     "biome:check": "biome check --write src"
   },
   "dependencies": {
-    "@slates/proto": "1.0.0-rc.11",
-    "@slates/provider": "1.0.0-rc.15",
-    "@slates/provider-handler": "1.0.0-rc.17"
+    "@slates/proto": "1.0.0-rc.13",
+    "@slates/provider": "1.0.0-rc.17",
+    "@slates/provider-handler": "1.0.0-rc.19"
   },
   "devDependencies": {
     "@slates/tsconfig": "1.0.0-rc.1",

package/src/client.test.ts

@@ -30,15 +30,17 @@ let createDemoSlate = () => {
     z.object({
       prefix: z.string()
     })
-  ).getDefaultConfig(() => ({
-    prefix: 'Hello'
-  })).docs([
-    {
-      type: 'docs.config.general',
-      name: 'Demo config docs',
-      url: 'https://example.com/docs/config'
-    }
-  ]);
+  )
+    .getDefaultConfig(() => ({
+      prefix: 'Hello'
+    }))
+    .docs([
+      {
+        type: 'docs.config.general',
+        name: 'Demo config docs',
+        url: 'https://example.com/docs/config'
+      }
+    ]);
 
   let demoAuth = SlateAuth.create<{ token: string }>()
     .output(
@@ -71,7 +73,8 @@ let createDemoSlate = () => {
       getOutput: async (ctx: { input: { token: string } }) => ({
         output: {
           token: ctx.input.token
-        }
+        },
+        scopes: [`scope:${ctx.input.token}`]
       }),
       getProfile: async (ctx: { output: { token: string } }) => ({
         profile: {
@@ -123,6 +126,7 @@ let createDemoSlate = () => {
         }
       ]
     })
+    .authMethods(['token_auth'])
     .handleInvocation(async ctx => ({
       output: {
         greeting: `${ctx.config.prefix} ${ctx.input.name}`,
@@ -308,7 +312,14 @@ let createTriggerTraceSlate = () => {
     )
     .webhook({
       handleRequest: async () => ({
-        inputs: [{ id: 'webhook-1' }, { id: 'webhook-2' }]
+        inputs: [{ id: 'webhook-1' }, { id: 'webhook-2' }],
+        response: {
+          status: 202,
+          headers: {
+            'x-trigger-result': 'accepted'
+          },
+          body: 'accepted'
+        }
       }),
       handleEvent: async ctx => ({
         id: ctx.input.id,
@@ -425,6 +436,83 @@ let createOauthConfigSlate = (seenConfig: SeenOAuthConfig) => {
   });
 };
 
+type TokenConfig = {
+  prefix: string;
+};
+
+type SeenTokenConfig = Partial<Record<'output' | 'profile', TokenConfig>>;
+
+let getRequiredTokenConfig = (ctx: { config?: Record<string, unknown> }): TokenConfig => {
+  expect(ctx.config).toBeDefined();
+  return ctx.config as TokenConfig;
+};
+
+type TokenAuthOutputContext = {
+  input: { token: string };
+  config?: Record<string, unknown>;
+};
+
+type TokenAuthProfileContext = {
+  output: { token: string };
+  config?: Record<string, unknown>;
+};
+
+let createTokenConfigSlate = (seenConfig: SeenTokenConfig) => {
+  let config = SlateConfig.create(
+    z.object({
+      prefix: z.string()
+    })
+  );
+
+  let auth = SlateAuth.create<{ token: string }>()
+    .output(
+      z.object({
+        token: z.string()
+      })
+    )
+    .addTokenAuth({
+      type: 'auth.token',
+      key: 'token_auth',
+      name: 'Token Auth',
+      inputSchema: z.object({
+        token: z.string()
+      }),
+      getOutput: async (ctx: TokenAuthOutputContext) => {
+        let currentConfig = getRequiredTokenConfig(ctx);
+        seenConfig.output = currentConfig;
+        return {
+          output: {
+            token: `${currentConfig.prefix}:${ctx.input.token}`
+          }
+        };
+      },
+      getProfile: async (ctx: TokenAuthProfileContext) => {
+        let currentConfig = getRequiredTokenConfig(ctx);
+        seenConfig.profile = currentConfig;
+        return {
+          profile: {
+            prefix: currentConfig.prefix,
+            token: ctx.output.token
+          }
+        };
+      }
+    });
+
+  let spec = SlateSpecification.create({
+    key: 'token-config-slate',
+    name: 'Token Config Slate',
+    description: 'A slate that reads config in token auth hooks',
+    config,
+    auth
+  });
+
+  return Slate.create({
+    spec,
+    tools: [],
+    triggers: []
+  });
+};
+
 describe('@slates/client local transport', () => {
   it('discovers auth/config and invokes tools with session state', async () => {
     let slate = createDemoSlate();
@@ -458,6 +546,7 @@ describe('@slates/client local transport', () => {
         }
       ]
     });
+    expect(actions[0]!.authMethods).toEqual(['token_auth']);
 
     let configSchema = await client.getConfigSchema();
     expect(configSchema.schema.properties.prefix.type).toBe('string');
@@ -498,6 +587,7 @@ describe('@slates/client local transport', () => {
       input: changedInput.input ?? { token: '' }
     });
     expect(authOutput.output).toEqual({ token: 'trimmed-token' });
+    expect(authOutput.scopes).toEqual(['scope:trimmed-token']);
 
     client.setConfig({ prefix: 'Hi' });
     client.setAuth({
@@ -612,7 +702,7 @@ describe('@slates/client local transport', () => {
       state: null
     });
 
-    await client.request('slates/action.trigger.webhook_handle', {
+    let webhookResult = await client.request('slates/action.trigger.webhook_handle', {
       actionId: 'webhook_trigger',
       url: 'https://example.com/webhook',
       method: 'POST',
@@ -622,6 +712,16 @@ describe('@slates/client local transport', () => {
       body: null,
       state: null
     });
+    expect(webhookResult.response).toEqual({
+      status: 202,
+      headers: {
+        'x-trigger-result': 'accepted'
+      },
+      body: {
+        encoding: 'base64',
+        content: Buffer.from('accepted').toString('base64')
+      }
+    });
 
     await waitForLogs();
 
@@ -645,6 +745,7 @@ describe('@slates/client local transport', () => {
             component: 'action',
             functionName: 'handleRequest',
             inputCount: 2,
+            hasResponse: true,
             actionId: 'webhook_trigger'
           })
         })
@@ -726,6 +827,49 @@ describe('@slates/client local transport', () => {
     });
   });
 
+  it('passes current profile config into token auth callbacks', async () => {
+    let seenConfig: SeenTokenConfig = {};
+    let client = createSlatesClient({
+      transport: createLocalSlateTransport({
+        slate: createTokenConfigSlate(seenConfig)
+      }),
+      state: {
+        config: {
+          prefix: 'configured'
+        }
+      }
+    });
+
+    let authOutput = await client.getAuthOutput({
+      authenticationMethodId: 'token_auth',
+      input: {
+        token: 'secret-token'
+      }
+    });
+
+    expect(authOutput.output).toEqual({
+      token: 'configured:secret-token'
+    });
+
+    let profile = await client.getAuthProfile({
+      authenticationMethodId: 'token_auth',
+      output: authOutput.output,
+      input: {
+        token: 'secret-token'
+      },
+      scopes: []
+    });
+
+    expect(profile.profile).toEqual({
+      prefix: 'configured',
+      token: 'configured:secret-token'
+    });
+    expect(seenConfig).toEqual({
+      output: { prefix: 'configured' },
+      profile: { prefix: 'configured' }
+    });
+  });
+
   it('throws structured protocol errors for provider responses', async () => {
     let client = createSlatesClient({
       transport: {

package/src/client.ts

@@ -356,6 +356,7 @@ export class SlatesProtocolClient {
     headers?: Record<string, string>;
     body?: string | Uint8Array | null;
     state?: any;
+    registrationDetails?: any;
   }): Promise<SlatesMessageActionTriggerWebhookHandleResponse['result']> {
     this.ensureSession();
     let encodedBody =
@@ -376,7 +377,8 @@ export class SlatesProtocolClient {
             content: encodedBody
           }
         : null,
-      state: d.state ?? null
+      state: d.state ?? null,
+      registrationDetails: d.registrationDetails ?? null
     });
   }