@slates/proto 1.0.0-rc.1 → 1.0.0-rc.10

package/src/messages/config.ts

@@ -1,4 +1,5 @@
 import z from 'zod';
+import { withRequestTraces } from './tracing';
 
 /**
  * Set Config
@@ -47,6 +48,7 @@ export type SlatesMessageConfigSchemaGetResponse = z.infer<
 export let slatesMessageConfigChangedRequest = z.object({
   jsonrpc: z.literal('2.0'),
   method: z.literal('slates/config.changed'),
+  id: z.string(),
   params: z.object({
     previousConfig: z.record(z.string(), z.any()).nullable(),
     newConfig: z.record(z.string(), z.any())
@@ -60,7 +62,7 @@ export type SlatesMessageConfigChangedRequest = z.infer<
 export let slatesMessageConfigChangedResponse = z.object({
   jsonrpc: z.literal('2.0'),
   id: z.string(),
-  result: z.object({
+  result: withRequestTraces({
     success: z.boolean(),
     config: z.record(z.string(), z.any()).optional(),
     errors: z
@@ -96,7 +98,7 @@ export type SlatesMessageConfigDefaultGetRequest = z.infer<
 export let slatesMessageConfigDefaultGetResponse = z.object({
   jsonrpc: z.literal('2.0'),
   id: z.string(),
-  result: z.object({
+  result: withRequestTraces({
     config: z.record(z.string(), z.any()).nullable()
   })
 });

package/src/messages/controlFlow.ts

@@ -1,11 +1,12 @@
 import z from 'zod';
 import { slatesParticipant } from '../types';
+import { SLATES_PROTOCOL_VERSION } from '../version';
 
 export let slatesMessageHelloNotification = z.object({
   jsonrpc: z.literal('2.0'),
   method: z.literal('slates/hello'),
   params: z.object({
-    protocol: z.literal('slates@2026-01-01')
+    protocol: z.literal(SLATES_PROTOCOL_VERSION)
   })
 });
 

package/src/messages/identify.ts

@@ -1,8 +1,10 @@
 import z from 'zod';
+import { SLATES_PROTOCOL_VERSION } from '../version';
 
 export let slatesMessageProviderIdentifyRequest = z.object({
   jsonrpc: z.literal('2.0'),
   method: z.literal('slates/provider.identify'),
+  id: z.string(),
   params: z.object({})
 });
 
@@ -14,8 +16,7 @@ export let slatesMessageProviderIdentifyResponse = z.object({
   jsonrpc: z.literal('2.0'),
   id: z.string(),
   result: z.object({
-    protocol: z.literal('slates@2026-01-01'),
-
+    protocol: z.literal(SLATES_PROTOCOL_VERSION),
     provider: z.object({
       type: z.literal('provider'),
       id: z.string(),

package/src/messages/index.ts

@@ -3,48 +3,46 @@ export * from './auth';
 export * from './config';
 export * from './controlFlow';
 export * from './identify';
-export * from './log';
+export * from './tracing';
 
-import { z } from 'zod';
+import type { z } from 'zod';
 import {
-  SlatesActionRequests,
+  type SlatesActionRequests,
+  type SlatesActionResponses,
   slatesActionRequestsByMethod,
-  SlatesActionResponses,
   slatesActionResponsesByMethod
 } from './action';
 import {
-  SlatesAuthNotifications,
+  type SlatesAuthNotifications,
+  type SlatesAuthRequests,
+  type SlatesAuthResponses,
   slatesAuthNotificationsByMethod,
-  SlatesAuthRequests,
   slatesAuthRequestsByMethod,
-  SlatesAuthResponses,
   slatesAuthResponsesByMethod
 } from './auth';
 import {
-  SlatesConfigNotifications,
+  type SlatesConfigNotifications,
+  type SlatesConfigRequests,
+  type SlatesConfigResponses,
   slatesConfigNotificationsByMethod,
-  SlatesConfigRequests,
   slatesConfigRequestsByMethod,
-  SlatesConfigResponses,
   slatesConfigResponsesByMethod
 } from './config';
 import {
-  SlatesControlFlowNotifications,
+  type SlatesControlFlowNotifications,
   slatesControlFlowNotificationsByMethod
 } from './controlFlow';
 import {
-  SlatesIdentifyRequests,
+  type SlatesIdentifyRequests,
+  type SlatesIdentifyResponses,
   slatesIdentifyRequestsByMethod,
-  SlatesIdentifyResponses,
   slatesIdentifyResponsesByMethod
 } from './identify';
-import { SlatesLogNotifications, slatesLogNotificationsByMethod } from './log';
 
 export type SlatesNotifications =
   | SlatesAuthNotifications
   | SlatesConfigNotifications
-  | SlatesControlFlowNotifications
-  | SlatesLogNotifications;
+  | SlatesControlFlowNotifications;
 
 export type SlatesRequests =
   | SlatesActionRequests
@@ -75,8 +73,7 @@ export let slatesRequestsByMethod = {
 export let slatesNotificationsByMethod = {
   ...slatesAuthNotificationsByMethod,
   ...slatesConfigNotificationsByMethod,
-  ...slatesControlFlowNotificationsByMethod,
-  ...slatesLogNotificationsByMethod
+  ...slatesControlFlowNotificationsByMethod
 };
 
 export type SlatesResponsesByMethod = {

package/src/messages/tracing.ts

@@ -0,0 +1,38 @@
+import z from 'zod';
+
+export let slatesRequestTraceTextBody = z.object({
+  contentType: z.string().optional(),
+  text: z.string(),
+  truncated: z.boolean().optional()
+});
+
+export let slatesRequestTrace = z.object({
+  startedAt: z.string(),
+  durationMs: z.number().nonnegative(),
+  request: z.object({
+    method: z.string(),
+    url: z.string(),
+    headers: z.record(z.string(), z.string()).optional(),
+    body: slatesRequestTraceTextBody.optional()
+  }),
+  response: z
+    .object({
+      status: z.number(),
+      statusText: z.string().optional(),
+      headers: z.record(z.string(), z.string()).optional(),
+      body: slatesRequestTraceTextBody.optional()
+    })
+    .optional(),
+  error: z
+    .object({
+      code: z.string().optional(),
+      message: z.string()
+    })
+    .optional()
+});
+
+export let withRequestTraces = <Shape extends z.ZodRawShape>(shape: Shape) =>
+  z.object({
+    ...shape,
+    requestTraces: z.array(slatesRequestTrace).optional()
+  });

package/src/types/action.ts

@@ -1,5 +1,13 @@
 import z from 'zod';
 
+export let slatesActionScopeClause = z.object({
+  OR: z.array(z.string()).min(1)
+});
+
+export let slatesActionScopes = z.object({
+  AND: z.array(slatesActionScopeClause).min(1)
+});
+
 export let slatesActionBase = z.object({
   id: z.string(),
 
@@ -14,6 +22,7 @@ export let slatesActionBase = z.object({
     })
     .optional(),
   metadata: z.record(z.string(), z.any()).optional(),
+  scopes: slatesActionScopes.optional(),
 
   inputSchema: z.record(z.string(), z.any()),
   outputSchema: z.record(z.string(), z.any())
@@ -31,7 +40,7 @@ export let slatesActionTrigger = slatesActionBase.extend({
   invocation: z.union([
     z.object({
       type: z.literal('polling'),
-      intervalSeconds: z.number().min(15)
+      intervalSeconds: z.number().min(60 * 10)
     }),
     z.object({
       type: z.literal('webhook'),
@@ -46,3 +55,4 @@ export let slatesAction = z.union([slatesActionTool, slatesActionTrigger]);
 export type SlatesAction = z.infer<typeof slatesAction>;
 export type SlatesActionTool = z.infer<typeof slatesActionTool>;
 export type SlatesActionTrigger = z.infer<typeof slatesActionTrigger>;
+export type SlatesActionScopes = z.infer<typeof slatesActionScopes>;

package/src/types/authMethod.ts

@@ -16,7 +16,8 @@ export let slatesAuthenticationMethod = z.object({
       z.object({
         id: z.string(),
         title: z.string(),
-        description: z.string().optional()
+        description: z.string().optional(),
+        defaultChecked: z.boolean().optional()
       })
     )
     .optional(),
@@ -29,7 +30,15 @@ export let slatesAuthenticationMethod = z.object({
     handleChangedInput: z.object({ enabled: z.boolean() }).optional(),
     handleTokenRefresh: z.object({ enabled: z.boolean() }).optional(),
     getProfile: z.object({ enabled: z.boolean() }).optional()
-  })
+  }),
+
+  docs: z.object({
+    oauthDocsLink: z.string().optional(),
+    oauthScopesLink: z.string().optional(),
+    tokenDocsLink: z.string().optional(),
+    serviceAccountDocsLink: z.string().optional(),
+    customAuthDocsLink: z.string().optional()
+  }).optional()
 });
 
 export type SlateAuthenticationMethod = z.infer<typeof slatesAuthenticationMethod>;

package/src/version.ts

@@ -0,0 +1,3 @@
+export const SLATES_PROTOCOL_VERSION = 'slates@2026-01-01' as const;
+
+export type SlatesProtocolVersion = typeof SLATES_PROTOCOL_VERSION;

package/src/messages/log.ts

@@ -1,29 +0,0 @@
-import z from 'zod';
-
-/**
- * Send Log
- */
-export let slatesMessageLogSendNotification = z.object({
-  jsonrpc: z.literal('2.0'),
-  method: z.literal('slates/log.send'),
-  params: z.object({
-    type: z.union([
-      z.literal('info'),
-      z.literal('warning'),
-      z.literal('error'),
-      z.literal('progress')
-    ]),
-    timestamp: z.string(),
-    message: z.string()
-  })
-});
-
-export type SlatesMessageLogSendNotification = z.infer<
-  typeof slatesMessageLogSendNotification
->;
-
-export type SlatesLogNotifications = SlatesMessageLogSendNotification;
-
-export let slatesLogNotificationsByMethod = {
-  'slates/log.send': slatesMessageLogSendNotification
-};

package/tsconfig.json

@@ -1,8 +0,0 @@
-{
-  "$schema": "https://json.schemastore.org/tsconfig",
-  "extends": "@slates/tsconfig/base.json",
-  "exclude": ["dist"],
-  "compilerOptions": {
-    "outDir": "dist"
-  }
-}