@slates/provider 1.0.0-rc.14 → 1.0.0-rc.15

package/dist/index.cjs

@@ -119,6 +119,9 @@ var SlateAction = class {
   get scopes() {
     return this._params.scopes;
   }
+  get docs() {
+    return this._params.docs;
+  }
 };
 
 // src/error/axios.ts
@@ -1585,6 +1588,7 @@ var axios = createAxios();
 // src/config/config.ts
 var SlateConfig = class _SlateConfig {
   #configSchema;
+  #docs;
   #configChanged = null;
   #getDefaultConfig = null;
   constructor(schema) {
@@ -1597,6 +1601,10 @@ var SlateConfig = class _SlateConfig {
     this.#configSchema = schema;
     return this;
   }
+  docs(docs) {
+    this.#docs = docs;
+    return this;
+  }
   onConfigChanged(handler) {
     this.#configChanged = handler;
     return this;
@@ -1608,6 +1616,9 @@ var SlateConfig = class _SlateConfig {
   get configSchema() {
     return this.#configSchema;
   }
+  get docsReferences() {
+    return this.#docs;
+  }
   get handlers() {
     return {
       configChanged: this.#configChanged,
@@ -1840,6 +1851,9 @@ var SlateSpecification = class _SlateSpecification {
   get description() {
     return this._params.description;
   }
+  get docs() {
+    return this._params.docs;
+  }
 };
 var spec = (params) => SlateSpecification.create(params);
 // Annotate the CommonJS export names for ESM import in node:

package/dist/index.d.cts

@@ -50,6 +50,18 @@ declare class SlateLogger {
     progress(...message: SlateLogMessageInput[]): void;
 }
 
+interface SlateDocsReference {
+    name: string;
+    url: string;
+}
+interface SlateTypedDocsReference<Type extends string> extends SlateDocsReference {
+    type?: Type;
+}
+type SlateProviderDocsReference = SlateDocsReference;
+type SlateConfigDocsReference = SlateTypedDocsReference<'docs.config.general'>;
+type SlateActionDocsReference = SlateTypedDocsReference<'docs.action.general'>;
+type SlateAuthDocsReference = SlateTypedDocsReference<'docs.auth.oauth' | 'docs.auth.oauth_scopes' | 'docs.auth.token' | 'docs.auth.service_account' | 'docs.auth.custom'>;
+
 type SlateAuthCallbackConfig = Record<string, any>;
 type SlateAuthWithOauth<InputType extends {}, OutputType extends {
     token: string;
@@ -65,10 +77,7 @@ type SlateAuthWithOauth<InputType extends {}, OutputType extends {
         defaultChecked?: boolean;
         scope: string;
     }[];
-    docs?: {
-        oauthDocsLink?: string;
-        oauthScopesLink?: string;
-    };
+    docs?: SlateAuthDocsReference[];
     inputSchema?: z.ZodType<InputType>;
     onInputChanged?: (params: {
         previousInput: InputType | null;
@@ -133,9 +142,7 @@ type SlateAuthWithToken<InputType extends {}, OutputType extends {
     name: string;
     key: string;
     inputSchema?: z.ZodType<InputType>;
-    docs?: {
-        tokenDocsLink?: string;
-    };
+    docs?: SlateAuthDocsReference[];
     getOutput: (ctx: {
         input: InputType;
     }) => Promise<{
@@ -160,9 +167,7 @@ type SlateAuthWithServiceAccount<InputType extends {}, OutputType extends {}> =
     name: string;
     key: string;
     inputSchema?: z.ZodType<InputType>;
-    docs?: {
-        serviceAccountDocsLink?: string;
-    };
+    docs?: SlateAuthDocsReference[];
     getOutput: (ctx: {
         input: InputType;
     }) => Promise<{
@@ -187,9 +192,7 @@ type SlateAuthWithCustomData<InputType extends {}, OutputType extends {}> = {
     name: string;
     key: string;
     inputSchema?: z.ZodType<InputType>;
-    docs?: {
-        customAuthDocsLink?: string;
-    };
+    docs?: SlateAuthDocsReference[];
     getOutput: (ctx: {
         input: InputType;
     }) => Promise<{
@@ -263,6 +266,7 @@ declare class SlateConfig<ConfigType extends {}> {
     private constructor();
     static create<ConfigType extends {}>(schema: z.ZodType<ConfigType>): SlateConfig<ConfigType>;
     config<NewConfigType extends {}>(schema: z.ZodType<NewConfigType>): SlateConfig<NewConfigType>;
+    docs(docs: SlateConfigDocsReference[]): SlateConfig<ConfigType>;
     onConfigChanged(handler: (params: {
         previousConfig: ConfigType | null;
         newConfig: ConfigType;
@@ -271,6 +275,7 @@ declare class SlateConfig<ConfigType extends {}> {
     } | undefined): SlateConfig<ConfigType>;
     getDefaultConfig(getter: () => ConfigType): SlateConfig<ConfigType>;
     get configSchema(): z.ZodType<ConfigType, unknown, z.core.$ZodTypeInternals<ConfigType, unknown>>;
+    get docsReferences(): SlateConfigDocsReference[] | undefined;
     get handlers(): {
         configChanged: ((params: {
             previousConfig: ConfigType | null;
@@ -287,6 +292,7 @@ interface SlateSpecificationParameters {
     key: string;
     name: string;
     description?: string;
+    docs?: SlateProviderDocsReference[];
     metadata?: Record<string, any>;
 }
 interface SlateSpecificationCreateParameters<ConfigType extends {}, AuthType extends {}> extends SlateSpecificationParameters {
@@ -307,6 +313,7 @@ declare class SlateSpecification<ConfigType extends {}, AuthType extends {}> {
     get key(): string;
     get name(): string;
     get description(): string | undefined;
+    get docs(): SlateDocsReference[] | undefined;
 }
 declare let spec: <ConfigType extends {}, AuthType extends {}>(params: SlateSpecificationCreateParameters<ConfigType, AuthType>) => SlateSpecification<ConfigType, AuthType>;
 
@@ -389,6 +396,7 @@ interface SlateActionParameters {
     };
     metadata?: Record<string, any>;
     scopes?: SlateActionScopes;
+    docs?: SlateActionDocsReference[];
 }
 type SlateToolInvocationHandler<ConfigType extends {}, AuthType extends {}, InputType extends {}, OutputType extends {}> = (context: SlateContext<ConfigType, AuthType, InputType>) => Promise<{
     output: OutputType;
@@ -471,6 +479,7 @@ declare abstract class SlateAction<Type extends SlateActionType, ConfigType exte
     get constraints(): string[] | undefined;
     get metadata(): Record<string, any> | undefined;
     get scopes(): SlateActionScopes | undefined;
+    get docs(): SlateActionDocsReference[] | undefined;
 }
 
 declare class SlateActionBuilder<Type extends SlateActionType, ConfigType extends {}, AuthType extends {}, InputType extends {}, OutputType extends {}, Result extends SlateAction<Type, ConfigType, AuthType, any, any>> {
@@ -648,4 +657,4 @@ declare class Slate<ConfigType extends {}, AuthType extends {}> {
     get actions(): (SlateTrigger<ConfigType, AuthType, any, any> | SlateTool<ConfigType, AuthType, any, any>)[];
 }
 
-export { Slate, SlateAction, SlateActionBuilder, type SlateActionCreateParameters, type SlateActionParameters, type SlateActionParametersAny, type SlateActionParametersTool, type SlateActionParametersTrigger, type SlateActionScopeClause, type SlateActionScopeClauseInput, type SlateActionScopeValue, type SlateActionScopes, type SlateActionScopesInput, type SlateActionType, type SlateAttachment, type SlateAttachmentInlineContent, type SlateAttachmentUrlContent, SlateAuth, type SlateAuthType, type SlateAuthWithCustomData, type SlateAuthWithNone, type SlateAuthWithOauth, type SlateAuthWithServiceAccount, type SlateAuthWithToken, type SlateAxiosDefaults, type SlateAxiosErrorOptions, SlateConfig, SlateContext, SlateDeclarationError, SlateDefaultPollingIntervalSeconds, SlateError, type SlateErrorInput, type SlateErrorIssue, type SlateErrorKind, type SlateErrorProviderInfo, type SlateErrorResponse, type SlateErrorUpstreamInfo, type SlateLogEntry, type SlateLogFields, type SlateLogListener, type SlateLogMessageInput, type SlateLogType, SlateLogger, type SlatePollingOptions, type SlateServiceErrorData, SlateSpecification, type SlateSpecificationCreateParameters, type SlateSpecificationParameters, SlateTool, type SlateToolInvocationHandler, type SlateToolParameters, SlateTrigger, type SlateTriggerMappingHandler, type SlateTriggerParameters, type SlateTriggerPollingHandler, type SlateTriggerWebhookAutoRegistrationHandler, type SlateTriggerWebhookAutoUnregistrationHandler, type SlateTriggerWebhookRequestHandler, allOf, anyOf, auth, axios, config, createAxios, createBase64Attachment, createSlateError, createTextAttachment, createUrlAttachment, getCurrentContext, getServiceErrorData, inferSlateErrorFromAxios, isAxiosErrorLike, isServiceErrorData, mapServiceErrorCode, mapServiceErrorToSlateErrorInput, mergeScopes, runWithContext, scopeClause, spec, tool, trigger, validateScopes };
+export { Slate, SlateAction, SlateActionBuilder, type SlateActionCreateParameters, type SlateActionDocsReference, type SlateActionParameters, type SlateActionParametersAny, type SlateActionParametersTool, type SlateActionParametersTrigger, type SlateActionScopeClause, type SlateActionScopeClauseInput, type SlateActionScopeValue, type SlateActionScopes, type SlateActionScopesInput, type SlateActionType, type SlateAttachment, type SlateAttachmentInlineContent, type SlateAttachmentUrlContent, SlateAuth, type SlateAuthDocsReference, type SlateAuthType, type SlateAuthWithCustomData, type SlateAuthWithNone, type SlateAuthWithOauth, type SlateAuthWithServiceAccount, type SlateAuthWithToken, type SlateAxiosDefaults, type SlateAxiosErrorOptions, SlateConfig, type SlateConfigDocsReference, SlateContext, SlateDeclarationError, SlateDefaultPollingIntervalSeconds, type SlateDocsReference, SlateError, type SlateErrorInput, type SlateErrorIssue, type SlateErrorKind, type SlateErrorProviderInfo, type SlateErrorResponse, type SlateErrorUpstreamInfo, type SlateLogEntry, type SlateLogFields, type SlateLogListener, type SlateLogMessageInput, type SlateLogType, SlateLogger, type SlatePollingOptions, type SlateProviderDocsReference, type SlateServiceErrorData, SlateSpecification, type SlateSpecificationCreateParameters, type SlateSpecificationParameters, SlateTool, type SlateToolInvocationHandler, type SlateToolParameters, SlateTrigger, type SlateTriggerMappingHandler, type SlateTriggerParameters, type SlateTriggerPollingHandler, type SlateTriggerWebhookAutoRegistrationHandler, type SlateTriggerWebhookAutoUnregistrationHandler, type SlateTriggerWebhookRequestHandler, type SlateTypedDocsReference, allOf, anyOf, auth, axios, config, createAxios, createBase64Attachment, createSlateError, createTextAttachment, createUrlAttachment, getCurrentContext, getServiceErrorData, inferSlateErrorFromAxios, isAxiosErrorLike, isServiceErrorData, mapServiceErrorCode, mapServiceErrorToSlateErrorInput, mergeScopes, runWithContext, scopeClause, spec, tool, trigger, validateScopes };

package/dist/index.d.ts

@@ -50,6 +50,18 @@ declare class SlateLogger {
     progress(...message: SlateLogMessageInput[]): void;
 }
 
+interface SlateDocsReference {
+    name: string;
+    url: string;
+}
+interface SlateTypedDocsReference<Type extends string> extends SlateDocsReference {
+    type?: Type;
+}
+type SlateProviderDocsReference = SlateDocsReference;
+type SlateConfigDocsReference = SlateTypedDocsReference<'docs.config.general'>;
+type SlateActionDocsReference = SlateTypedDocsReference<'docs.action.general'>;
+type SlateAuthDocsReference = SlateTypedDocsReference<'docs.auth.oauth' | 'docs.auth.oauth_scopes' | 'docs.auth.token' | 'docs.auth.service_account' | 'docs.auth.custom'>;
+
 type SlateAuthCallbackConfig = Record<string, any>;
 type SlateAuthWithOauth<InputType extends {}, OutputType extends {
     token: string;
@@ -65,10 +77,7 @@ type SlateAuthWithOauth<InputType extends {}, OutputType extends {
         defaultChecked?: boolean;
         scope: string;
     }[];
-    docs?: {
-        oauthDocsLink?: string;
-        oauthScopesLink?: string;
-    };
+    docs?: SlateAuthDocsReference[];
     inputSchema?: z.ZodType<InputType>;
     onInputChanged?: (params: {
         previousInput: InputType | null;
@@ -133,9 +142,7 @@ type SlateAuthWithToken<InputType extends {}, OutputType extends {
     name: string;
     key: string;
     inputSchema?: z.ZodType<InputType>;
-    docs?: {
-        tokenDocsLink?: string;
-    };
+    docs?: SlateAuthDocsReference[];
     getOutput: (ctx: {
         input: InputType;
     }) => Promise<{
@@ -160,9 +167,7 @@ type SlateAuthWithServiceAccount<InputType extends {}, OutputType extends {}> =
     name: string;
     key: string;
     inputSchema?: z.ZodType<InputType>;
-    docs?: {
-        serviceAccountDocsLink?: string;
-    };
+    docs?: SlateAuthDocsReference[];
     getOutput: (ctx: {
         input: InputType;
     }) => Promise<{
@@ -187,9 +192,7 @@ type SlateAuthWithCustomData<InputType extends {}, OutputType extends {}> = {
     name: string;
     key: string;
     inputSchema?: z.ZodType<InputType>;
-    docs?: {
-        customAuthDocsLink?: string;
-    };
+    docs?: SlateAuthDocsReference[];
     getOutput: (ctx: {
         input: InputType;
     }) => Promise<{
@@ -263,6 +266,7 @@ declare class SlateConfig<ConfigType extends {}> {
     private constructor();
     static create<ConfigType extends {}>(schema: z.ZodType<ConfigType>): SlateConfig<ConfigType>;
     config<NewConfigType extends {}>(schema: z.ZodType<NewConfigType>): SlateConfig<NewConfigType>;
+    docs(docs: SlateConfigDocsReference[]): SlateConfig<ConfigType>;
     onConfigChanged(handler: (params: {
         previousConfig: ConfigType | null;
         newConfig: ConfigType;
@@ -271,6 +275,7 @@ declare class SlateConfig<ConfigType extends {}> {
     } | undefined): SlateConfig<ConfigType>;
     getDefaultConfig(getter: () => ConfigType): SlateConfig<ConfigType>;
     get configSchema(): z.ZodType<ConfigType, unknown, z.core.$ZodTypeInternals<ConfigType, unknown>>;
+    get docsReferences(): SlateConfigDocsReference[] | undefined;
     get handlers(): {
         configChanged: ((params: {
             previousConfig: ConfigType | null;
@@ -287,6 +292,7 @@ interface SlateSpecificationParameters {
     key: string;
     name: string;
     description?: string;
+    docs?: SlateProviderDocsReference[];
     metadata?: Record<string, any>;
 }
 interface SlateSpecificationCreateParameters<ConfigType extends {}, AuthType extends {}> extends SlateSpecificationParameters {
@@ -307,6 +313,7 @@ declare class SlateSpecification<ConfigType extends {}, AuthType extends {}> {
     get key(): string;
     get name(): string;
     get description(): string | undefined;
+    get docs(): SlateDocsReference[] | undefined;
 }
 declare let spec: <ConfigType extends {}, AuthType extends {}>(params: SlateSpecificationCreateParameters<ConfigType, AuthType>) => SlateSpecification<ConfigType, AuthType>;
 
@@ -389,6 +396,7 @@ interface SlateActionParameters {
     };
     metadata?: Record<string, any>;
     scopes?: SlateActionScopes;
+    docs?: SlateActionDocsReference[];
 }
 type SlateToolInvocationHandler<ConfigType extends {}, AuthType extends {}, InputType extends {}, OutputType extends {}> = (context: SlateContext<ConfigType, AuthType, InputType>) => Promise<{
     output: OutputType;
@@ -471,6 +479,7 @@ declare abstract class SlateAction<Type extends SlateActionType, ConfigType exte
     get constraints(): string[] | undefined;
     get metadata(): Record<string, any> | undefined;
     get scopes(): SlateActionScopes | undefined;
+    get docs(): SlateActionDocsReference[] | undefined;
 }
 
 declare class SlateActionBuilder<Type extends SlateActionType, ConfigType extends {}, AuthType extends {}, InputType extends {}, OutputType extends {}, Result extends SlateAction<Type, ConfigType, AuthType, any, any>> {
@@ -648,4 +657,4 @@ declare class Slate<ConfigType extends {}, AuthType extends {}> {
     get actions(): (SlateTrigger<ConfigType, AuthType, any, any> | SlateTool<ConfigType, AuthType, any, any>)[];
 }
 
-export { Slate, SlateAction, SlateActionBuilder, type SlateActionCreateParameters, type SlateActionParameters, type SlateActionParametersAny, type SlateActionParametersTool, type SlateActionParametersTrigger, type SlateActionScopeClause, type SlateActionScopeClauseInput, type SlateActionScopeValue, type SlateActionScopes, type SlateActionScopesInput, type SlateActionType, type SlateAttachment, type SlateAttachmentInlineContent, type SlateAttachmentUrlContent, SlateAuth, type SlateAuthType, type SlateAuthWithCustomData, type SlateAuthWithNone, type SlateAuthWithOauth, type SlateAuthWithServiceAccount, type SlateAuthWithToken, type SlateAxiosDefaults, type SlateAxiosErrorOptions, SlateConfig, SlateContext, SlateDeclarationError, SlateDefaultPollingIntervalSeconds, SlateError, type SlateErrorInput, type SlateErrorIssue, type SlateErrorKind, type SlateErrorProviderInfo, type SlateErrorResponse, type SlateErrorUpstreamInfo, type SlateLogEntry, type SlateLogFields, type SlateLogListener, type SlateLogMessageInput, type SlateLogType, SlateLogger, type SlatePollingOptions, type SlateServiceErrorData, SlateSpecification, type SlateSpecificationCreateParameters, type SlateSpecificationParameters, SlateTool, type SlateToolInvocationHandler, type SlateToolParameters, SlateTrigger, type SlateTriggerMappingHandler, type SlateTriggerParameters, type SlateTriggerPollingHandler, type SlateTriggerWebhookAutoRegistrationHandler, type SlateTriggerWebhookAutoUnregistrationHandler, type SlateTriggerWebhookRequestHandler, allOf, anyOf, auth, axios, config, createAxios, createBase64Attachment, createSlateError, createTextAttachment, createUrlAttachment, getCurrentContext, getServiceErrorData, inferSlateErrorFromAxios, isAxiosErrorLike, isServiceErrorData, mapServiceErrorCode, mapServiceErrorToSlateErrorInput, mergeScopes, runWithContext, scopeClause, spec, tool, trigger, validateScopes };
+export { Slate, SlateAction, SlateActionBuilder, type SlateActionCreateParameters, type SlateActionDocsReference, type SlateActionParameters, type SlateActionParametersAny, type SlateActionParametersTool, type SlateActionParametersTrigger, type SlateActionScopeClause, type SlateActionScopeClauseInput, type SlateActionScopeValue, type SlateActionScopes, type SlateActionScopesInput, type SlateActionType, type SlateAttachment, type SlateAttachmentInlineContent, type SlateAttachmentUrlContent, SlateAuth, type SlateAuthDocsReference, type SlateAuthType, type SlateAuthWithCustomData, type SlateAuthWithNone, type SlateAuthWithOauth, type SlateAuthWithServiceAccount, type SlateAuthWithToken, type SlateAxiosDefaults, type SlateAxiosErrorOptions, SlateConfig, type SlateConfigDocsReference, SlateContext, SlateDeclarationError, SlateDefaultPollingIntervalSeconds, type SlateDocsReference, SlateError, type SlateErrorInput, type SlateErrorIssue, type SlateErrorKind, type SlateErrorProviderInfo, type SlateErrorResponse, type SlateErrorUpstreamInfo, type SlateLogEntry, type SlateLogFields, type SlateLogListener, type SlateLogMessageInput, type SlateLogType, SlateLogger, type SlatePollingOptions, type SlateProviderDocsReference, type SlateServiceErrorData, SlateSpecification, type SlateSpecificationCreateParameters, type SlateSpecificationParameters, SlateTool, type SlateToolInvocationHandler, type SlateToolParameters, SlateTrigger, type SlateTriggerMappingHandler, type SlateTriggerParameters, type SlateTriggerPollingHandler, type SlateTriggerWebhookAutoRegistrationHandler, type SlateTriggerWebhookAutoUnregistrationHandler, type SlateTriggerWebhookRequestHandler, type SlateTypedDocsReference, allOf, anyOf, auth, axios, config, createAxios, createBase64Attachment, createSlateError, createTextAttachment, createUrlAttachment, getCurrentContext, getServiceErrorData, inferSlateErrorFromAxios, isAxiosErrorLike, isServiceErrorData, mapServiceErrorCode, mapServiceErrorToSlateErrorInput, mergeScopes, runWithContext, scopeClause, spec, tool, trigger, validateScopes };

package/dist/index.module.js

@@ -48,6 +48,9 @@ var SlateAction = class {
   get scopes() {
     return this._params.scopes;
   }
+  get docs() {
+    return this._params.docs;
+  }
 };
 
 // src/error/axios.ts
@@ -1514,6 +1517,7 @@ var axios = createAxios();
 // src/config/config.ts
 var SlateConfig = class _SlateConfig {
   #configSchema;
+  #docs;
   #configChanged = null;
   #getDefaultConfig = null;
   constructor(schema) {
@@ -1526,6 +1530,10 @@ var SlateConfig = class _SlateConfig {
     this.#configSchema = schema;
     return this;
   }
+  docs(docs) {
+    this.#docs = docs;
+    return this;
+  }
   onConfigChanged(handler) {
     this.#configChanged = handler;
     return this;
@@ -1537,6 +1545,9 @@ var SlateConfig = class _SlateConfig {
   get configSchema() {
     return this.#configSchema;
   }
+  get docsReferences() {
+    return this.#docs;
+  }
   get handlers() {
     return {
       configChanged: this.#configChanged,
@@ -1769,6 +1780,9 @@ var SlateSpecification = class _SlateSpecification {
   get description() {
     return this._params.description;
   }
+  get docs() {
+    return this._params.docs;
+  }
 };
 var spec = (params) => SlateSpecification.create(params);
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@slates/provider",
-  "version": "1.0.0-rc.14",
+  "version": "1.0.0-rc.15",
   "publishConfig": {
     "access": "public"
   },

package/src/action/action.ts

@@ -1,5 +1,6 @@
 import type { z } from 'zod';
 import type { SlateContext } from '../context';
+import type { SlateActionDocsReference } from '../docs';
 import type { SlateSpecification } from '../specification/specification';
 import type { SlateAttachment } from './attachment';
 
@@ -26,6 +27,7 @@ export interface SlateActionParameters {
   };
   metadata?: Record<string, any>;
   scopes?: SlateActionScopes;
+  docs?: SlateActionDocsReference[];
 }
 
 export type SlateToolInvocationHandler<
@@ -203,4 +205,8 @@ export abstract class SlateAction<
   get scopes() {
     return this._params.scopes;
   }
+
+  get docs() {
+    return this._params.docs;
+  }
 }

package/src/auth/types.ts

@@ -1,4 +1,5 @@
 import type z from 'zod';
+import type { SlateAuthDocsReference } from '../docs';
 
 type SlateAuthCallbackConfig = Record<string, any>;
 
@@ -22,10 +23,7 @@ export type SlateAuthWithOauth<
     scope: string;
   }[];
 
-  docs?: {
-    oauthDocsLink?: string;
-    oauthScopesLink?: string;
-  };
+  docs?: SlateAuthDocsReference[];
 
   inputSchema?: z.ZodType<InputType>;
 
@@ -97,9 +95,7 @@ export type SlateAuthWithToken<InputType extends {}, OutputType extends { token?
 
   inputSchema?: z.ZodType<InputType>;
 
-  docs?: {
-    tokenDocsLink?: string;
-  };
+  docs?: SlateAuthDocsReference[];
 
   getOutput: (ctx: { input: InputType }) => Promise<{ output: OutputType }>;
 
@@ -123,9 +119,7 @@ export type SlateAuthWithServiceAccount<InputType extends {}, OutputType extends
 
   inputSchema?: z.ZodType<InputType>;
 
-  docs?: {
-    serviceAccountDocsLink?: string;
-  };
+  docs?: SlateAuthDocsReference[];
 
   getOutput: (ctx: { input: InputType }) => Promise<{ output: OutputType }>;
 
@@ -149,9 +143,7 @@ export type SlateAuthWithCustomData<InputType extends {}, OutputType extends {}>
 
   inputSchema?: z.ZodType<InputType>;
 
-  docs?: {
-    customAuthDocsLink?: string;
-  };
+  docs?: SlateAuthDocsReference[];
 
   getOutput: (ctx: { input: InputType }) => Promise<{ output: OutputType }>;
 

package/src/config/config.ts

@@ -1,7 +1,9 @@
 import type z from 'zod';
+import type { SlateConfigDocsReference } from '../docs';
 
 export class SlateConfig<ConfigType extends {}> {
   #configSchema: z.ZodType<ConfigType>;
+  #docs: SlateConfigDocsReference[] | undefined;
   #configChanged:
     | ((params: {
         previousConfig: ConfigType | null;
@@ -25,6 +27,11 @@ export class SlateConfig<ConfigType extends {}> {
     return this as any as SlateConfig<NewConfigType>;
   }
 
+  docs(docs: SlateConfigDocsReference[]): SlateConfig<ConfigType> {
+    this.#docs = docs;
+    return this;
+  }
+
   onConfigChanged(
     handler: (params: {
       previousConfig: ConfigType | null;
@@ -44,6 +51,10 @@ export class SlateConfig<ConfigType extends {}> {
     return this.#configSchema;
   }
 
+  get docsReferences() {
+    return this.#docs;
+  }
+
   get handlers() {
     return {
       configChanged: this.#configChanged,

package/src/docs.ts

@@ -0,0 +1,22 @@
+export interface SlateDocsReference {
+  name: string;
+  url: string;
+}
+
+export interface SlateTypedDocsReference<Type extends string> extends SlateDocsReference {
+  type?: Type;
+}
+
+export type SlateProviderDocsReference = SlateDocsReference;
+
+export type SlateConfigDocsReference = SlateTypedDocsReference<'docs.config.general'>;
+
+export type SlateActionDocsReference = SlateTypedDocsReference<'docs.action.general'>;
+
+export type SlateAuthDocsReference = SlateTypedDocsReference<
+  | 'docs.auth.oauth'
+  | 'docs.auth.oauth_scopes'
+  | 'docs.auth.token'
+  | 'docs.auth.service_account'
+  | 'docs.auth.custom'
+>;

package/src/index.ts

@@ -4,6 +4,7 @@ export * from './auth';
 export * from './axios';
 export * from './config';
 export * from './context';
+export * from './docs';
 export * from './error';
 export * from './logger';
 export * from './specification';

package/src/specification/specification.ts

@@ -1,11 +1,13 @@
 import z from 'zod';
 import type { SlateAuth } from '../auth';
 import type { SlateConfig } from '../config';
+import type { SlateProviderDocsReference } from '../docs';
 
 export interface SlateSpecificationParameters {
   key: string;
   name: string;
   description?: string;
+  docs?: SlateProviderDocsReference[];
   metadata?: Record<string, any>;
 }
 
@@ -61,6 +63,10 @@ export class SlateSpecification<ConfigType extends {}, AuthType extends {}> {
   get description() {
     return this._params.description;
   }
+
+  get docs() {
+    return this._params.docs;
+  }
 }
 
 export let spec = <ConfigType extends {}, AuthType extends {}>(