@slates/client 1.0.0-rc.11 → 1.0.0-rc.13

package/dist/index.d.cts

@@ -54,6 +54,11 @@ declare class SlatesProtocolClient {
         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>;
         description?: string | undefined;
@@ -69,12 +74,18 @@ declare class SlatesProtocolClient {
                 OR: string[];
             }[];
         } | undefined;
+        authMethods?: string[] | undefined;
     }>;
     getTrigger(actionId: string): Promise<{
         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: {
@@ -98,6 +109,7 @@ declare class SlatesProtocolClient {
                 OR: string[];
             }[];
         } | undefined;
+        authMethods?: string[] | undefined;
     }>;
     getConfigSchema(): Promise<SlatesMessageConfigSchemaGetResponse['result']>;
     getDefaultConfig(): Promise<SlatesMessageConfigDefaultGetResponse['result']>;

package/dist/index.d.ts

@@ -54,6 +54,11 @@ declare class SlatesProtocolClient {
         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>;
         description?: string | undefined;
@@ -69,12 +74,18 @@ declare class SlatesProtocolClient {
                 OR: string[];
             }[];
         } | undefined;
+        authMethods?: string[] | undefined;
     }>;
     getTrigger(actionId: string): Promise<{
         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: {
@@ -98,6 +109,7 @@ declare class SlatesProtocolClient {
                 OR: string[];
             }[];
         } | undefined;
+        authMethods?: string[] | undefined;
     }>;
     getConfigSchema(): Promise<SlatesMessageConfigSchemaGetResponse['result']>;
     getDefaultConfig(): Promise<SlatesMessageConfigDefaultGetResponse['result']>;

package/package.json

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

package/src/client.test.ts

@@ -30,9 +30,17 @@ let createDemoSlate = () => {
     z.object({
       prefix: z.string()
     })
-  ).getDefaultConfig(() => ({
-    prefix: 'Hello'
-  }));
+  )
+    .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(
@@ -47,6 +55,13 @@ let createDemoSlate = () => {
       inputSchema: z.object({
         token: z.string()
       }),
+      docs: [
+        {
+          type: 'docs.auth.token',
+          name: 'Demo token auth docs',
+          url: 'https://example.com/docs/auth/token'
+        }
+      ],
       getDefaultInput: async () => ({
         token: 'default-token'
       }),
@@ -58,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: {
@@ -71,13 +87,26 @@ let createDemoSlate = () => {
     key: 'demo-slate',
     name: 'Demo Slate',
     description: 'A tiny test slate',
+    docs: [
+      {
+        name: 'Demo provider docs',
+        url: 'https://example.com/docs/provider'
+      }
+    ],
     config: demoConfig,
     auth: demoAuth
   });
 
   let echoTool = SlateTool.create(spec, {
     key: 'echo',
-    name: 'Echo'
+    name: 'Echo',
+    docs: [
+      {
+        type: 'docs.action.general',
+        name: 'Echo tool docs',
+        url: 'https://example.com/docs/actions/echo'
+      }
+    ]
   })
     .input(
       z.object({
@@ -97,6 +126,7 @@ let createDemoSlate = () => {
         }
       ]
     })
+    .authMethods(['token_auth'])
     .handleInvocation(async ctx => ({
       output: {
         greeting: `${ctx.config.prefix} ${ctx.input.name}`,
@@ -408,10 +438,23 @@ describe('@slates/client local transport', () => {
 
     let provider = await client.identify();
     expect(provider.provider.id).toBe('demo-slate');
+    expect(provider.docs).toEqual([
+      {
+        name: 'Demo provider docs',
+        url: 'https://example.com/docs/provider'
+      }
+    ]);
 
     let actions = await client.listTools();
     expect(actions).toHaveLength(1);
     expect(actions[0]!.id).toBe('echo');
+    expect(actions[0]!.docs).toEqual([
+      {
+        type: 'docs.action.general',
+        name: 'Echo tool docs',
+        url: 'https://example.com/docs/actions/echo'
+      }
+    ]);
     expect(actions[0]!.scopes).toEqual({
       AND: [
         {
@@ -419,9 +462,17 @@ 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');
+    expect(configSchema.docs).toEqual([
+      {
+        type: 'docs.config.general',
+        name: 'Demo config docs',
+        url: 'https://example.com/docs/config'
+      }
+    ]);
 
     let defaultConfig = await client.getDefaultConfig();
     expect(defaultConfig.config).toEqual({ prefix: 'Hello' });
@@ -429,6 +480,13 @@ describe('@slates/client local transport', () => {
     let authMethods = await client.listAuthMethods();
     expect(authMethods.authenticationMethods).toHaveLength(1);
     expect(authMethods.authenticationMethods[0]!.type).toBe('auth.token');
+    expect(authMethods.authenticationMethods[0]!.docs).toEqual([
+      {
+        type: 'docs.auth.token',
+        name: 'Demo token auth docs',
+        url: 'https://example.com/docs/auth/token'
+      }
+    ]);
 
     let defaultInput = await client.getDefaultAuthInput('token_auth');
     expect(defaultInput.input).toEqual({ token: 'default-token' });
@@ -445,6 +503,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({