@slates/provider 1.0.0-rc.12 → 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
@@ -233,7 +236,7 @@ var normalizeRetryable = (code, retryable) => {
   return code === "request.rate_limited" || code === "upstream.rate_limited" || code === "upstream.timeout" || code === "upstream.network_error" || code === "upstream.unavailable" || code === "upstream.error" || code === "transport.invoke_failed" || code === "internal.timeout";
 };
 var getDefaultMessage = (code, message) => {
-  if (message && message.trim()) return message;
+  if (message?.trim()) return message;
   return DEFAULT_MESSAGES[code] ?? DEFAULT_MESSAGES[DEFAULT_CODE];
 };
 var cleanRecord = (value) => {
@@ -510,7 +513,9 @@ var normalizeServiceErrorIssues = (errors) => {
   return issues.length > 0 ? issues : void 0;
 };
 var getServiceErrorBaggage = (data) => {
-  let extraEntries = Object.entries(data).filter(([key]) => !SERVICE_ERROR_DATA_RESERVED_KEYS.has(key));
+  let extraEntries = Object.entries(data).filter(
+    ([key]) => !SERVICE_ERROR_DATA_RESERVED_KEYS.has(key)
+  );
   return cleanRecord({
     serviceError: {
       code: data.code,
@@ -728,7 +733,9 @@ var normalizeClause = (input) => {
 };
 var assertScopeValues = (scopes) => {
   if (scopes.length === 0) {
-    throw new SlateDeclarationError("Each action scope clause must include at least one OR scope");
+    throw new SlateDeclarationError(
+      "Each action scope clause must include at least one OR scope"
+    );
   }
   for (let scope of scopes) {
     if (typeof scope !== "string" || scope.trim().length === 0) {
@@ -1134,15 +1141,9 @@ var CORE_SECRET_KEY_ATOMS = [
   "license[-_.]?key"
 ];
 var URL_FORM_SECRET_KEY_ATOMS = [...CORE_SECRET_KEY_ATOMS, "code"];
-var buildKeyBoundaryPattern = (atoms, flags) => new RegExp(
-  `(?:^|[^A-Za-z0-9])(?:${atoms.join("|")})(?=[^A-Za-z0-9]|$)`,
-  flags
-);
+var buildKeyBoundaryPattern = (atoms, flags) => new RegExp(`(?:^|[^A-Za-z0-9])(?:${atoms.join("|")})(?=[^A-Za-z0-9]|$)`, flags);
 var SECRET_KEY_PATTERN = buildKeyBoundaryPattern(CORE_SECRET_KEY_ATOMS, "i");
-var URL_FORM_SECRET_KEY_PATTERN = buildKeyBoundaryPattern(
-  URL_FORM_SECRET_KEY_ATOMS,
-  "i"
-);
+var URL_FORM_SECRET_KEY_PATTERN = buildKeyBoundaryPattern(URL_FORM_SECRET_KEY_ATOMS, "i");
 var NON_SECRET_KEY_EXACT = /* @__PURE__ */ new Set([
   "token_type",
   "token-type",
@@ -1320,7 +1321,7 @@ var redactStructuredValue = (value, depth = 0) => {
 var maybeParseJson = (text, contentType) => {
   let trimmed = text.trim();
   if (!trimmed) return null;
-  if (!contentType?.includes("json") && !/^[\[{]/.test(trimmed)) {
+  if (!contentType?.includes("json") && !/^[[{]/.test(trimmed)) {
     return null;
   }
   try {
@@ -1380,7 +1381,7 @@ var buildUrl = (baseURL, url) => {
 var REDACTED_ENCODED = encodeURIComponent(REDACTED_VALUE);
 var decodeRedactedMarker = (value) => REDACTED_ENCODED === REDACTED_VALUE ? value : value.split(REDACTED_ENCODED).join(REDACTED_VALUE);
 var redactHashFragment = (hash) => {
-  if (!hash || !hash.includes("=")) return hash;
+  if (!hash?.includes("=")) return hash;
   let withoutHash = hash.startsWith("#") ? hash.slice(1) : hash;
   let redacted = withoutHash.replace(
     /(?<![A-Za-z0-9])([A-Za-z0-9][A-Za-z0-9_\-.]*)=([^&]*)/g,
@@ -1458,7 +1459,7 @@ var takeTraceDraft = (config2) => {
 var clearTraceDraft = (config2, draft) => {
   if (!config2) return;
   if (config2.__slatesHttpTraceDraft === draft) {
-    delete config2.__slatesHttpTraceDraft;
+    config2.__slatesHttpTraceDraft = void 0;
   }
   if (isObjectLike(config2)) {
     traceDraftsByConfig.delete(config2);
@@ -1587,6 +1588,7 @@ var axios = createAxios();
 // src/config/config.ts
 var SlateConfig = class _SlateConfig {
   #configSchema;
+  #docs;
   #configChanged = null;
   #getDefaultConfig = null;
   constructor(schema) {
@@ -1599,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;
@@ -1610,6 +1616,9 @@ var SlateConfig = class _SlateConfig {
   get configSchema() {
     return this.#configSchema;
   }
+  get docsReferences() {
+    return this.#docs;
+  }
   get handlers() {
     return {
       configChanged: this.#configChanged,
@@ -1842,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,19 @@ 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;
     refreshToken?: string;
@@ -64,6 +77,7 @@ type SlateAuthWithOauth<InputType extends {}, OutputType extends {
         defaultChecked?: boolean;
         scope: string;
     }[];
+    docs?: SlateAuthDocsReference[];
     inputSchema?: z.ZodType<InputType>;
     onInputChanged?: (params: {
         previousInput: InputType | null;
@@ -79,6 +93,7 @@ type SlateAuthWithOauth<InputType extends {}, OutputType extends {
         clientId: string;
         clientSecret: string;
         scopes: string[];
+        config?: SlateAuthCallbackConfig;
     }) => Promise<{
         url: string;
         input?: InputType;
@@ -94,6 +109,7 @@ type SlateAuthWithOauth<InputType extends {}, OutputType extends {
         scopes: string[];
         callbackParams?: Record<string, string>;
         callbackState: Record<string, any>;
+        config?: SlateAuthCallbackConfig;
     }) => Promise<{
         output: OutputType;
         input?: InputType;
@@ -105,6 +121,7 @@ type SlateAuthWithOauth<InputType extends {}, OutputType extends {
         clientId: string;
         clientSecret: string;
         scopes: string[];
+        config?: SlateAuthCallbackConfig;
     }) => Promise<{
         output: OutputType;
         input?: InputType;
@@ -113,6 +130,7 @@ type SlateAuthWithOauth<InputType extends {}, OutputType extends {
         output: OutputType;
         input: InputType;
         scopes: string[];
+        config?: SlateAuthCallbackConfig;
     }) => Promise<{
         profile: Record<string, any>;
     }>;
@@ -124,6 +142,7 @@ type SlateAuthWithToken<InputType extends {}, OutputType extends {
     name: string;
     key: string;
     inputSchema?: z.ZodType<InputType>;
+    docs?: SlateAuthDocsReference[];
     getOutput: (ctx: {
         input: InputType;
     }) => Promise<{
@@ -148,6 +167,7 @@ type SlateAuthWithServiceAccount<InputType extends {}, OutputType extends {}> =
     name: string;
     key: string;
     inputSchema?: z.ZodType<InputType>;
+    docs?: SlateAuthDocsReference[];
     getOutput: (ctx: {
         input: InputType;
     }) => Promise<{
@@ -172,6 +192,7 @@ type SlateAuthWithCustomData<InputType extends {}, OutputType extends {}> = {
     name: string;
     key: string;
     inputSchema?: z.ZodType<InputType>;
+    docs?: SlateAuthDocsReference[];
     getOutput: (ctx: {
         input: InputType;
     }) => Promise<{
@@ -245,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;
@@ -253,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;
@@ -269,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 {
@@ -289,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>;
 
@@ -371,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;
@@ -453,17 +479,9 @@ 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;
 }
 
-type SlateActionScopeValue = string;
-type SlateActionScopeClauseInput = SlateActionScopeValue | readonly SlateActionScopeValue[] | SlateActionScopeClause;
-type SlateActionScopesInput = SlateActionScopeClauseInput | SlateActionScopes;
-declare let scopeClause: (...scopes: SlateActionScopeValue[]) => SlateActionScopeClause;
-declare let anyOf: (...scopes: SlateActionScopeValue[]) => SlateActionScopes;
-declare let allOf: (...inputs: SlateActionScopesInput[]) => SlateActionScopes;
-declare let mergeScopes: (...inputs: Array<SlateActionScopes | null | undefined | false>) => SlateActionScopes | undefined;
-declare let validateScopes: (scopes: SlateActionScopes) => SlateActionScopes;
-
 declare class SlateActionBuilder<Type extends SlateActionType, ConfigType extends {}, AuthType extends {}, InputType extends {}, OutputType extends {}, Result extends SlateAction<Type, ConfigType, AuthType, any, any>> {
     #private;
     private readonly type;
@@ -489,6 +507,15 @@ declare class SlateActionBuilder<Type extends SlateActionType, ConfigType extend
     build(): Result;
 }
 
+type SlateActionScopeValue = string;
+type SlateActionScopeClauseInput = SlateActionScopeValue | readonly SlateActionScopeValue[] | SlateActionScopeClause;
+type SlateActionScopesInput = SlateActionScopeClauseInput | SlateActionScopes;
+declare let scopeClause: (...scopes: SlateActionScopeValue[]) => SlateActionScopeClause;
+declare let anyOf: (...scopes: SlateActionScopeValue[]) => SlateActionScopes;
+declare let allOf: (...inputs: SlateActionScopesInput[]) => SlateActionScopes;
+declare let mergeScopes: (...inputs: Array<SlateActionScopes | null | undefined | false>) => SlateActionScopes | undefined;
+declare let validateScopes: (scopes: SlateActionScopes) => SlateActionScopes;
+
 interface SlateToolParameters<ConfigType extends {}, AuthType extends {}, InputType extends {}, OutputType extends {}> extends SlateActionParameters {
     handleInvocation: SlateToolInvocationHandler<ConfigType, AuthType, InputType, OutputType>;
 }
@@ -585,7 +612,7 @@ interface SlateErrorInput extends Omit<SlateErrorResponse, 'kind'> {
 interface SlateAxiosErrorOptions {
     defaults?: Partial<SlateErrorResponse>;
     extractResponseData?: (response: AxiosResponse) => unknown;
-    mapAxiosError?: (error: AxiosError, inferred: SlateErrorResponse) => SlateError | Partial<SlateErrorResponse> | void;
+    mapAxiosError?: (error: AxiosError, inferred: SlateErrorResponse) => SlateError | Partial<SlateErrorResponse> | undefined;
 }
 interface SlateServiceErrorData {
     status: number;
@@ -630,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,19 @@ 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;
     refreshToken?: string;
@@ -64,6 +77,7 @@ type SlateAuthWithOauth<InputType extends {}, OutputType extends {
         defaultChecked?: boolean;
         scope: string;
     }[];
+    docs?: SlateAuthDocsReference[];
     inputSchema?: z.ZodType<InputType>;
     onInputChanged?: (params: {
         previousInput: InputType | null;
@@ -79,6 +93,7 @@ type SlateAuthWithOauth<InputType extends {}, OutputType extends {
         clientId: string;
         clientSecret: string;
         scopes: string[];
+        config?: SlateAuthCallbackConfig;
     }) => Promise<{
         url: string;
         input?: InputType;
@@ -94,6 +109,7 @@ type SlateAuthWithOauth<InputType extends {}, OutputType extends {
         scopes: string[];
         callbackParams?: Record<string, string>;
         callbackState: Record<string, any>;
+        config?: SlateAuthCallbackConfig;
     }) => Promise<{
         output: OutputType;
         input?: InputType;
@@ -105,6 +121,7 @@ type SlateAuthWithOauth<InputType extends {}, OutputType extends {
         clientId: string;
         clientSecret: string;
         scopes: string[];
+        config?: SlateAuthCallbackConfig;
     }) => Promise<{
         output: OutputType;
         input?: InputType;
@@ -113,6 +130,7 @@ type SlateAuthWithOauth<InputType extends {}, OutputType extends {
         output: OutputType;
         input: InputType;
         scopes: string[];
+        config?: SlateAuthCallbackConfig;
     }) => Promise<{
         profile: Record<string, any>;
     }>;
@@ -124,6 +142,7 @@ type SlateAuthWithToken<InputType extends {}, OutputType extends {
     name: string;
     key: string;
     inputSchema?: z.ZodType<InputType>;
+    docs?: SlateAuthDocsReference[];
     getOutput: (ctx: {
         input: InputType;
     }) => Promise<{
@@ -148,6 +167,7 @@ type SlateAuthWithServiceAccount<InputType extends {}, OutputType extends {}> =
     name: string;
     key: string;
     inputSchema?: z.ZodType<InputType>;
+    docs?: SlateAuthDocsReference[];
     getOutput: (ctx: {
         input: InputType;
     }) => Promise<{
@@ -172,6 +192,7 @@ type SlateAuthWithCustomData<InputType extends {}, OutputType extends {}> = {
     name: string;
     key: string;
     inputSchema?: z.ZodType<InputType>;
+    docs?: SlateAuthDocsReference[];
     getOutput: (ctx: {
         input: InputType;
     }) => Promise<{
@@ -245,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;
@@ -253,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;
@@ -269,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 {
@@ -289,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>;
 
@@ -371,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;
@@ -453,17 +479,9 @@ 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;
 }
 
-type SlateActionScopeValue = string;
-type SlateActionScopeClauseInput = SlateActionScopeValue | readonly SlateActionScopeValue[] | SlateActionScopeClause;
-type SlateActionScopesInput = SlateActionScopeClauseInput | SlateActionScopes;
-declare let scopeClause: (...scopes: SlateActionScopeValue[]) => SlateActionScopeClause;
-declare let anyOf: (...scopes: SlateActionScopeValue[]) => SlateActionScopes;
-declare let allOf: (...inputs: SlateActionScopesInput[]) => SlateActionScopes;
-declare let mergeScopes: (...inputs: Array<SlateActionScopes | null | undefined | false>) => SlateActionScopes | undefined;
-declare let validateScopes: (scopes: SlateActionScopes) => SlateActionScopes;
-
 declare class SlateActionBuilder<Type extends SlateActionType, ConfigType extends {}, AuthType extends {}, InputType extends {}, OutputType extends {}, Result extends SlateAction<Type, ConfigType, AuthType, any, any>> {
     #private;
     private readonly type;
@@ -489,6 +507,15 @@ declare class SlateActionBuilder<Type extends SlateActionType, ConfigType extend
     build(): Result;
 }
 
+type SlateActionScopeValue = string;
+type SlateActionScopeClauseInput = SlateActionScopeValue | readonly SlateActionScopeValue[] | SlateActionScopeClause;
+type SlateActionScopesInput = SlateActionScopeClauseInput | SlateActionScopes;
+declare let scopeClause: (...scopes: SlateActionScopeValue[]) => SlateActionScopeClause;
+declare let anyOf: (...scopes: SlateActionScopeValue[]) => SlateActionScopes;
+declare let allOf: (...inputs: SlateActionScopesInput[]) => SlateActionScopes;
+declare let mergeScopes: (...inputs: Array<SlateActionScopes | null | undefined | false>) => SlateActionScopes | undefined;
+declare let validateScopes: (scopes: SlateActionScopes) => SlateActionScopes;
+
 interface SlateToolParameters<ConfigType extends {}, AuthType extends {}, InputType extends {}, OutputType extends {}> extends SlateActionParameters {
     handleInvocation: SlateToolInvocationHandler<ConfigType, AuthType, InputType, OutputType>;
 }
@@ -585,7 +612,7 @@ interface SlateErrorInput extends Omit<SlateErrorResponse, 'kind'> {
 interface SlateAxiosErrorOptions {
     defaults?: Partial<SlateErrorResponse>;
     extractResponseData?: (response: AxiosResponse) => unknown;
-    mapAxiosError?: (error: AxiosError, inferred: SlateErrorResponse) => SlateError | Partial<SlateErrorResponse> | void;
+    mapAxiosError?: (error: AxiosError, inferred: SlateErrorResponse) => SlateError | Partial<SlateErrorResponse> | undefined;
 }
 interface SlateServiceErrorData {
     status: number;
@@ -630,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
@@ -162,7 +165,7 @@ var normalizeRetryable = (code, retryable) => {
   return code === "request.rate_limited" || code === "upstream.rate_limited" || code === "upstream.timeout" || code === "upstream.network_error" || code === "upstream.unavailable" || code === "upstream.error" || code === "transport.invoke_failed" || code === "internal.timeout";
 };
 var getDefaultMessage = (code, message) => {
-  if (message && message.trim()) return message;
+  if (message?.trim()) return message;
   return DEFAULT_MESSAGES[code] ?? DEFAULT_MESSAGES[DEFAULT_CODE];
 };
 var cleanRecord = (value) => {
@@ -439,7 +442,9 @@ var normalizeServiceErrorIssues = (errors) => {
   return issues.length > 0 ? issues : void 0;
 };
 var getServiceErrorBaggage = (data) => {
-  let extraEntries = Object.entries(data).filter(([key]) => !SERVICE_ERROR_DATA_RESERVED_KEYS.has(key));
+  let extraEntries = Object.entries(data).filter(
+    ([key]) => !SERVICE_ERROR_DATA_RESERVED_KEYS.has(key)
+  );
   return cleanRecord({
     serviceError: {
       code: data.code,
@@ -657,7 +662,9 @@ var normalizeClause = (input) => {
 };
 var assertScopeValues = (scopes) => {
   if (scopes.length === 0) {
-    throw new SlateDeclarationError("Each action scope clause must include at least one OR scope");
+    throw new SlateDeclarationError(
+      "Each action scope clause must include at least one OR scope"
+    );
   }
   for (let scope of scopes) {
     if (typeof scope !== "string" || scope.trim().length === 0) {
@@ -1063,15 +1070,9 @@ var CORE_SECRET_KEY_ATOMS = [
   "license[-_.]?key"
 ];
 var URL_FORM_SECRET_KEY_ATOMS = [...CORE_SECRET_KEY_ATOMS, "code"];
-var buildKeyBoundaryPattern = (atoms, flags) => new RegExp(
-  `(?:^|[^A-Za-z0-9])(?:${atoms.join("|")})(?=[^A-Za-z0-9]|$)`,
-  flags
-);
+var buildKeyBoundaryPattern = (atoms, flags) => new RegExp(`(?:^|[^A-Za-z0-9])(?:${atoms.join("|")})(?=[^A-Za-z0-9]|$)`, flags);
 var SECRET_KEY_PATTERN = buildKeyBoundaryPattern(CORE_SECRET_KEY_ATOMS, "i");
-var URL_FORM_SECRET_KEY_PATTERN = buildKeyBoundaryPattern(
-  URL_FORM_SECRET_KEY_ATOMS,
-  "i"
-);
+var URL_FORM_SECRET_KEY_PATTERN = buildKeyBoundaryPattern(URL_FORM_SECRET_KEY_ATOMS, "i");
 var NON_SECRET_KEY_EXACT = /* @__PURE__ */ new Set([
   "token_type",
   "token-type",
@@ -1249,7 +1250,7 @@ var redactStructuredValue = (value, depth = 0) => {
 var maybeParseJson = (text, contentType) => {
   let trimmed = text.trim();
   if (!trimmed) return null;
-  if (!contentType?.includes("json") && !/^[\[{]/.test(trimmed)) {
+  if (!contentType?.includes("json") && !/^[[{]/.test(trimmed)) {
     return null;
   }
   try {
@@ -1309,7 +1310,7 @@ var buildUrl = (baseURL, url) => {
 var REDACTED_ENCODED = encodeURIComponent(REDACTED_VALUE);
 var decodeRedactedMarker = (value) => REDACTED_ENCODED === REDACTED_VALUE ? value : value.split(REDACTED_ENCODED).join(REDACTED_VALUE);
 var redactHashFragment = (hash) => {
-  if (!hash || !hash.includes("=")) return hash;
+  if (!hash?.includes("=")) return hash;
   let withoutHash = hash.startsWith("#") ? hash.slice(1) : hash;
   let redacted = withoutHash.replace(
     /(?<![A-Za-z0-9])([A-Za-z0-9][A-Za-z0-9_\-.]*)=([^&]*)/g,
@@ -1387,7 +1388,7 @@ var takeTraceDraft = (config2) => {
 var clearTraceDraft = (config2, draft) => {
   if (!config2) return;
   if (config2.__slatesHttpTraceDraft === draft) {
-    delete config2.__slatesHttpTraceDraft;
+    config2.__slatesHttpTraceDraft = void 0;
   }
   if (isObjectLike(config2)) {
     traceDraftsByConfig.delete(config2);
@@ -1516,6 +1517,7 @@ var axios = createAxios();
 // src/config/config.ts
 var SlateConfig = class _SlateConfig {
   #configSchema;
+  #docs;
   #configChanged = null;
   #getDefaultConfig = null;
   constructor(schema) {
@@ -1528,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;
@@ -1539,6 +1545,9 @@ var SlateConfig = class _SlateConfig {
   get configSchema() {
     return this.#configSchema;
   }
+  get docsReferences() {
+    return this.#docs;
+  }
   get handlers() {
     return {
       configChanged: this.#configChanged,
@@ -1771,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.12",
+  "version": "1.0.0-rc.15",
   "publishConfig": {
     "access": "public"
   },
@@ -26,9 +26,9 @@
   "unpkg": "./dist/index.module.js",
   "scripts": {
     "test": "vitest run --passWithNoTests",
-    "lint": "prettier src/**/*.ts --check",
     "build": "tsup --config ../../tsup.packages.config.ts --external async_hooks",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "tsc --noEmit",
+    "biome:check": "biome check --write src"
   },
   "dependencies": {
     "@lowerdeck/error": "^1.1.0",

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/action/builder.ts

@@ -4,10 +4,10 @@ import type { SlateSpecification } from '../specification/specification';
 import type {
   SlateAction,
   SlateActionCreateParameters,
-  SlateActionScopes,
   SlateActionParameters,
   SlateActionParametersTool,
   SlateActionParametersTrigger,
+  SlateActionScopes,
   SlateActionType,
   SlatePollingOptions,
   SlateToolInvocationHandler,

package/src/action/index.ts

@@ -1,5 +1,5 @@
 export * from './action';
-export * from './scopes';
 export type * from './builder';
+export * from './scopes';
 export * from './tool';
 export * from './trigger';

package/src/action/scopes.test.ts

@@ -12,10 +12,7 @@ describe('action scope helpers', () => {
     });
 
     expect(allOf(['scope:calendar'], ['scope:sharing', 'scope:sharing:admin'])).toEqual({
-      AND: [
-        { OR: ['scope:calendar'] },
-        { OR: ['scope:sharing', 'scope:sharing:admin'] }
-      ]
+      AND: [{ OR: ['scope:calendar'] }, { OR: ['scope:sharing', 'scope:sharing:admin'] }]
     });
   });
 
@@ -68,7 +65,9 @@ describe('action scope helpers', () => {
   });
 
   it('throws helpful errors for invalid scope definitions', () => {
-    expect(() => scopeClause()).toThrow('Each action scope clause must include at least one OR scope');
+    expect(() => scopeClause()).toThrow(
+      'Each action scope clause must include at least one OR scope'
+    );
     expect(() => scopeClause('')).toThrow('Action scopes must be non-empty strings');
     expect(() => validateScopes({ AND: [] })).toThrow(
       'Action scopes must include at least one AND clause'

package/src/action/scopes.ts

@@ -78,7 +78,9 @@ let normalizeClause = (input: SlateActionScopeClauseInput): SlateActionScopeClau
 
 let assertScopeValues = (scopes: readonly SlateActionScopeValue[]) => {
   if (scopes.length === 0) {
-    throw new SlateDeclarationError('Each action scope clause must include at least one OR scope');
+    throw new SlateDeclarationError(
+      'Each action scope clause must include at least one OR scope'
+    );
   }
 
   for (let scope of scopes) {

package/src/auth/types.ts

@@ -1,4 +1,7 @@
 import type z from 'zod';
+import type { SlateAuthDocsReference } from '../docs';
+
+type SlateAuthCallbackConfig = Record<string, any>;
 
 export type SlateAuthWithOauth<
   InputType extends {},
@@ -20,6 +23,8 @@ export type SlateAuthWithOauth<
     scope: string;
   }[];
 
+  docs?: SlateAuthDocsReference[];
+
   inputSchema?: z.ZodType<InputType>;
 
   onInputChanged?: (params: {
@@ -36,6 +41,7 @@ export type SlateAuthWithOauth<
     clientId: string;
     clientSecret: string;
     scopes: string[];
+    config?: SlateAuthCallbackConfig;
   }) => Promise<{
     url: string;
     input?: InputType;
@@ -52,6 +58,7 @@ export type SlateAuthWithOauth<
     scopes: string[];
     callbackParams?: Record<string, string>;
     callbackState: Record<string, any>;
+    config?: SlateAuthCallbackConfig;
   }) => Promise<{
     output: OutputType;
     input?: InputType;
@@ -64,12 +71,18 @@ export type SlateAuthWithOauth<
     clientId: string;
     clientSecret: string;
     scopes: string[];
+    config?: SlateAuthCallbackConfig;
   }) => Promise<{
     output: OutputType;
     input?: InputType;
   }>;
 
-  getProfile?: (ctx: { output: OutputType; input: InputType; scopes: string[] }) => Promise<{
+  getProfile?: (ctx: {
+    output: OutputType;
+    input: InputType;
+    scopes: string[];
+    config?: SlateAuthCallbackConfig;
+  }) => Promise<{
     profile: Record<string, any>;
   }>;
 };
@@ -82,6 +95,8 @@ export type SlateAuthWithToken<InputType extends {}, OutputType extends { token?
 
   inputSchema?: z.ZodType<InputType>;
 
+  docs?: SlateAuthDocsReference[];
+
   getOutput: (ctx: { input: InputType }) => Promise<{ output: OutputType }>;
 
   onInputChanged?: (params: {
@@ -104,6 +119,8 @@ export type SlateAuthWithServiceAccount<InputType extends {}, OutputType extends
 
   inputSchema?: z.ZodType<InputType>;
 
+  docs?: SlateAuthDocsReference[];
+
   getOutput: (ctx: { input: InputType }) => Promise<{ output: OutputType }>;
 
   onInputChanged?: (params: {
@@ -126,6 +143,8 @@ export type SlateAuthWithCustomData<InputType extends {}, OutputType extends {}>
 
   inputSchema?: z.ZodType<InputType>;
 
+  docs?: SlateAuthDocsReference[];
+
   getOutput: (ctx: { input: InputType }) => Promise<{ output: OutputType }>;
 
   handleTokenRefresh?: (ctx: {

package/src/axios/index.ts

@@ -19,7 +19,7 @@ let applySlateInterceptors = (
 ) => {
   instance.interceptors.request.use(
     request => {
-       // Has to be called in the context of an action execution
+      // Has to be called in the context of an action execution
       let ctx = getCurrentContext();
       let spec = ctx.specification;
       let providerToken = spec.key.replace(/[^A-Za-z0-9!#$%&'*+\-.^_`|~]/g, '-');

package/src/axios/trace.test.ts

@@ -174,7 +174,7 @@ describe('sanitizeFreeText', () => {
   });
 
   it('redacts GitHub tokens', () => {
-    let token = 'ghp_' + 'a'.repeat(40);
+    let token = `ghp_${'a'.repeat(40)}`;
     expect(sanitizeFreeText(token)).toBe('[redacted]');
   });
 
@@ -184,22 +184,22 @@ describe('sanitizeFreeText', () => {
   });
 
   it('redacts Stripe secret keys', () => {
-    let key = 'sk_live_' + 'a'.repeat(24);
+    let key = `sk_live_${'a'.repeat(24)}`;
     expect(sanitizeFreeText(`{"key":"${key}"}`)).not.toContain(key);
   });
 
   it('redacts OpenAI API keys', () => {
-    let key = 'sk-proj-' + 'a'.repeat(40);
+    let key = `sk-proj-${'a'.repeat(40)}`;
     expect(sanitizeFreeText(key)).toBe('[redacted]');
   });
 
   it('redacts Anthropic API keys', () => {
-    let key = 'sk-ant-' + 'a'.repeat(40);
+    let key = `sk-ant-${'a'.repeat(40)}`;
     expect(sanitizeFreeText(key)).toBe('[redacted]');
   });
 
   it('redacts Google API keys', () => {
-    let key = 'AIza' + 'a'.repeat(35);
+    let key = `AIza${'a'.repeat(35)}`;
     expect(sanitizeFreeText(key)).toBe('[redacted]');
   });
 
@@ -265,8 +265,7 @@ describe('sanitizeUrl', () => {
   });
 
   it('redacts secrets embedded in URL fragment (OAuth implicit flow)', () => {
-    let input =
-      'https://example.com/cb#access_token=xyz&token_type=bearer&expires_in=3600';
+    let input = 'https://example.com/cb#access_token=xyz&token_type=bearer&expires_in=3600';
     let out = sanitizeUrl(input);
     expect(out).toContain('access_token=[redacted]');
     expect(out).toContain('token_type=bearer');

package/src/axios/trace.ts

@@ -205,16 +205,10 @@ let CORE_SECRET_KEY_ATOMS = [
 let URL_FORM_SECRET_KEY_ATOMS = [...CORE_SECRET_KEY_ATOMS, 'code'];
 
 let buildKeyBoundaryPattern = (atoms: string[], flags: string) =>
-  new RegExp(
-    `(?:^|[^A-Za-z0-9])(?:${atoms.join('|')})(?=[^A-Za-z0-9]|$)`,
-    flags
-  );
+  new RegExp(`(?:^|[^A-Za-z0-9])(?:${atoms.join('|')})(?=[^A-Za-z0-9]|$)`, flags);
 
 let SECRET_KEY_PATTERN = buildKeyBoundaryPattern(CORE_SECRET_KEY_ATOMS, 'i');
-let URL_FORM_SECRET_KEY_PATTERN = buildKeyBoundaryPattern(
-  URL_FORM_SECRET_KEY_ATOMS,
-  'i'
-);
+let URL_FORM_SECRET_KEY_PATTERN = buildKeyBoundaryPattern(URL_FORM_SECRET_KEY_ATOMS, 'i');
 
 // Explicit non-secret keys that would otherwise trip the patterns above because
 // they embed a secret-sounding token (e.g. `token_type` contains `token`).
@@ -307,7 +301,8 @@ let HTTP_AUTH_SCHEME_PATTERN =
 
 // Generic `key=value` scan; the key is filtered via isUrlFormSecretKeyName at replace time
 // so we can apply a deny-list for compound keys like `token_type` or `grant_type`.
-let GENERIC_KEY_VALUE_PATTERN = /(?<![A-Za-z0-9])([A-Za-z0-9][A-Za-z0-9_\-.]*)(\s*=\s*)([^&#\s;]+)/g;
+let GENERIC_KEY_VALUE_PATTERN =
+  /(?<![A-Za-z0-9])([A-Za-z0-9][A-Za-z0-9_\-.]*)(\s*=\s*)([^&#\s;]+)/g;
 
 // Generic `"key": "value"` scan; the key is filtered via isSecretKeyName at replace time.
 let GENERIC_JSON_KEY_VALUE_PATTERN =
@@ -438,9 +433,7 @@ let redactStructuredValue = (value: unknown, depth = 0): unknown => {
         .slice(0, STRUCTURED_ENTRY_LIMIT)
         .map(([key, entry]) => [
           key,
-          isSecretKeyName(key)
-            ? REDACTED_VALUE
-            : redactStructuredValue(entry, depth + 1)
+          isSecretKeyName(key) ? REDACTED_VALUE : redactStructuredValue(entry, depth + 1)
         ])
     );
   }
@@ -451,7 +444,7 @@ let redactStructuredValue = (value: unknown, depth = 0): unknown => {
 let maybeParseJson = (text: string, contentType?: string) => {
   let trimmed = text.trim();
   if (!trimmed) return null;
-  if (!contentType?.includes('json') && !/^[\[{]/.test(trimmed)) {
+  if (!contentType?.includes('json') && !/^[[{]/.test(trimmed)) {
     return null;
   }
 
@@ -541,7 +534,7 @@ let decodeRedactedMarker = (value: string) =>
     : value.split(REDACTED_ENCODED).join(REDACTED_VALUE);
 
 let redactHashFragment = (hash: string) => {
-  if (!hash || !hash.includes('=')) return hash;
+  if (!hash?.includes('=')) return hash;
   let withoutHash = hash.startsWith('#') ? hash.slice(1) : hash;
   let redacted = withoutHash.replace(
     /(?<![A-Za-z0-9])([A-Za-z0-9][A-Za-z0-9_\-.]*)=([^&]*)/g,
@@ -657,7 +650,7 @@ let clearTraceDraft = (
   if (!config) return;
 
   if (config.__slatesHttpTraceDraft === draft) {
-    delete config.__slatesHttpTraceDraft;
+    config.__slatesHttpTraceDraft = undefined;
   }
 
   if (isObjectLike(config)) {

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/context/hook.test.ts

@@ -6,13 +6,19 @@ describe('slate context hook', () => {
   it('shares context storage across duplicate module instances', async () => {
     // @ts-expect-error Vite treats the query as a distinct module instance.
     let duplicateHook: typeof import('./hook') = await import('./hook?duplicate-instance');
-    let context = new SlateContext({}, {}, {}, {} as any, {
-      debug: () => {},
-      error: () => {},
-      info: () => {},
-      progress: () => {},
-      warn: () => {}
-    } as any);
+    let context = new SlateContext(
+      {},
+      {},
+      {},
+      {} as any,
+      {
+        debug: () => {},
+        error: () => {},
+        info: () => {},
+        progress: () => {},
+        warn: () => {}
+      } as any
+    );
 
     let result = await runWithContext(context, async () => duplicateHook.getCurrentContext());
 

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/error/service.ts

@@ -1,8 +1,14 @@
-import { isServiceError } from '@lowerdeck/error';
 import type { ErrorData, ErrorRecord, ServiceError } from '@lowerdeck/error';
+import { isServiceError } from '@lowerdeck/error';
 import { DEFAULT_CODE, SERVICE_ERROR_CODE_MAP } from './defaults';
 import type { SlateErrorInput, SlateErrorIssue, SlateServiceErrorData } from './types';
-import { cleanRecord, isRecord, normalizeKind, normalizeRetryable, sanitizeForBaggage } from './utils';
+import {
+  cleanRecord,
+  isRecord,
+  normalizeKind,
+  normalizeRetryable,
+  sanitizeForBaggage
+} from './utils';
 
 let SERVICE_ERROR_DATA_RESERVED_KEYS = new Set([
   'status',
@@ -46,9 +52,7 @@ let normalizeServiceErrorIssues = (errors: unknown): SlateErrorIssue[] | undefin
       };
     }
 
-    let path = Array.isArray(error.path)
-      ? error.path.map(entry => String(entry))
-      : undefined;
+    let path = Array.isArray(error.path) ? error.path.map(entry => String(entry)) : undefined;
 
     return {
       ...error,
@@ -67,7 +71,9 @@ let normalizeServiceErrorIssues = (errors: unknown): SlateErrorIssue[] | undefin
 };
 
 let getServiceErrorBaggage = (data: SlateServiceErrorData) => {
-  let extraEntries = Object.entries(data).filter(([key]) => !SERVICE_ERROR_DATA_RESERVED_KEYS.has(key));
+  let extraEntries = Object.entries(data).filter(
+    ([key]) => !SERVICE_ERROR_DATA_RESERVED_KEYS.has(key)
+  );
 
   return cleanRecord({
     serviceError: {
@@ -111,7 +117,11 @@ export let getServiceErrorData = (error: unknown): SlateServiceErrorData | null
     return error.data;
   }
 
-  if (isStructuredValue(error) && 'toResponse' in error && typeof error.toResponse === 'function') {
+  if (
+    isStructuredValue(error) &&
+    'toResponse' in error &&
+    typeof error.toResponse === 'function'
+  ) {
     let response = error.toResponse();
     return isServiceErrorData(response) ? response : null;
   }

package/src/error/types.ts

@@ -60,7 +60,7 @@ export interface SlateAxiosErrorOptions {
   mapAxiosError?: (
     error: AxiosError,
     inferred: SlateErrorResponse
-  ) => SlateError | Partial<SlateErrorResponse> | void;
+  ) => SlateError | Partial<SlateErrorResponse> | undefined;
 }
 
 export interface SlateServiceErrorData {

package/src/error/utils.ts

@@ -62,7 +62,7 @@ export let normalizeRetryable = (code: string, retryable?: boolean) => {
 };
 
 export let getDefaultMessage = (code: string, message?: string) => {
-  if (message && message.trim()) return message;
+  if (message?.trim()) return message;
   return DEFAULT_MESSAGES[code] ?? DEFAULT_MESSAGES[DEFAULT_CODE];
 };
 

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/logger/logger.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest';
-import { SlateLogger, type SlateLogEntry } from './logger';
+import { type SlateLogEntry, SlateLogger } from './logger';
 
 let flushLogs = async () => {
   await new Promise(resolve => setTimeout(resolve, 20));

package/src/specification/specification.ts

@@ -1,18 +1,18 @@
 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>;
 }
 
-export interface SlateSpecificationCreateParameters<
-  ConfigType extends {},
-  AuthType extends {}
-> extends SlateSpecificationParameters {
+export interface SlateSpecificationCreateParameters<ConfigType extends {}, AuthType extends {}>
+  extends SlateSpecificationParameters {
   config: SlateConfig<ConfigType>;
   auth: SlateAuth<AuthType>;
 }
@@ -63,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 {}>(