@slates/provider 1.0.0-rc.31 → 1.0.0-rc.33

package/dist/index.cjs

@@ -86,6 +86,7 @@ __export(index_exports, {
   getMetaWebhookVerificationResponse: () => getMetaWebhookVerificationResponse,
   getOAuthExpiresAtFromExpiresIn: () => getOAuthExpiresAtFromExpiresIn,
   getResponseHeaderValue: () => getResponseHeaderValue,
+  getRuntimeInfo: () => getRuntimeInfo,
   getServiceErrorData: () => getServiceErrorData,
   graphWebhookHttp: () => graphWebhookHttp,
   inferSlateErrorFromAxios: () => inferSlateErrorFromAxios,
@@ -1024,6 +1025,7 @@ var getCurrentContext = () => {
   }
   return context;
 };
+var getRuntimeInfo = () => asyncLocalStorage.getStore()?.runtimeInfo ?? null;
 
 // src/error/defaults.ts
 var DEFAULT_CODE = "internal.unexpected";
@@ -1309,6 +1311,8 @@ var sanitizeForBaggage = (value, options = {}) => {
     return BAGGAGE_UNSERIALIZABLE_VALUE;
   }
 };
+var UPSTREAM_CODE_PATTERN = /^[\w.:-]{1,128}$/;
+var normalizeUpstreamCode = (value) => typeof value === "string" && UPSTREAM_CODE_PATTERN.test(value) ? value : void 0;
 var normalizeSlateErrorInput = (input) => {
   let code = input.code || DEFAULT_CODE;
   return {
@@ -1323,6 +1327,7 @@ var normalizeSlateErrorInput = (input) => {
       ...input.upstream,
       status: input.upstream?.status ?? input.status
     }),
+    upstreamCode: normalizeUpstreamCode(input.upstreamCode) ?? normalizeUpstreamCode(input.upstream?.code),
     baggage: cleanRecord(input.baggage),
     requestTraces: input.requestTraces
   };
@@ -1785,6 +1790,7 @@ var mapServiceErrorToSlateErrorInput = (error, defaults = {}) => {
     issues: defaults.issues ?? normalizeServiceErrorIssues(data.errors),
     provider: defaults.provider,
     upstream: defaults.upstream,
+    upstreamCode: normalizeUpstreamCode(defaults.upstreamCode) ?? normalizeUpstreamCode(data.upstreamCode),
     baggage: cleanRecord({
       ...defaults.baggage ?? {},
       ...getServiceErrorBaggage(data)
@@ -2890,6 +2896,10 @@ var resolveDefaultExport = (value) => {
 var PQueue = resolveDefaultExport(import_p_queue.default);
 
 // src/context/context.ts
+var freezeRuntimeInfo = (runtimeInfo) => Object.freeze({
+  ...runtimeInfo,
+  ...runtimeInfo.metorial ? { metorial: Object.freeze({ ...runtimeInfo.metorial }) } : {}
+});
 var isBufferLike = (value) => value instanceof Uint8Array || value instanceof ArrayBuffer;
 var toUint8Array = (value) => value instanceof ArrayBuffer ? new Uint8Array(value) : value;
 var isReadableStream = (value) => typeof ReadableStream !== "undefined" && value instanceof ReadableStream;
@@ -2906,17 +2916,19 @@ var readStreamToBuffer = async (stream) => {
   return Buffer.concat(chunks);
 };
 var SlatePublicContext = class {
-  constructor(input, spec2, logger, liveInvocation = null) {
+  constructor(input, spec2, logger, liveInvocation = null, runtimeInfo = null) {
     this.spec = spec2;
     this.logger = logger;
     this.#input = input;
     this.#liveInvocation = liveInvocation;
+    this.#runtimeInfo = runtimeInfo && freezeRuntimeInfo(runtimeInfo);
   }
   spec;
   logger;
   #input;
   #httpTraces = [];
   #liveInvocation;
+  #runtimeInfo;
   #attachmentsDisabled = false;
   #attachments = [];
   #pendingUploads = [];
@@ -2927,6 +2939,9 @@ var SlatePublicContext = class {
     }
     return this.#uploadQueue;
   }
+  get runtimeInfo() {
+    return this.#runtimeInfo;
+  }
   get specification() {
     return this.spec;
   }
@@ -3067,8 +3082,8 @@ var SlatePublicContext = class {
 var SlateContext = class extends SlatePublicContext {
   #config;
   #auth;
-  constructor(config2, input, auth2, spec2, logger, liveInvocation = null) {
-    super(input, spec2, logger, liveInvocation);
+  constructor(config2, input, auth2, spec2, logger, liveInvocation = null, runtimeInfo = null) {
+    super(input, spec2, logger, liveInvocation, runtimeInfo);
     this.#config = config2;
     this.#auth = auth2;
   }
@@ -3546,6 +3561,7 @@ var skipWebhook = (reason, response) => ({
   getMetaWebhookVerificationResponse,
   getOAuthExpiresAtFromExpiresIn,
   getResponseHeaderValue,
+  getRuntimeInfo,
   getServiceErrorData,
   graphWebhookHttp,
   inferSlateErrorFromAxios,

package/dist/index.d.cts

@@ -192,6 +192,7 @@ type SlateAuthWithOauth<InputType extends {}, OutputType extends {
     adapters?: string[];
     syncTokensAcrossConnections?: boolean;
     adminSetup?: {
+        required?: boolean;
         getAuthorizationUrl?: (ctx: SlateOauthAuthorizationUrlContext<InputType>) => Promise<SlateOauthAuthorizationUrlResult<InputType>>;
         handleCallback?: (ctx: SlateOauthAdminCallbackContext<InputType>) => Promise<{
             instructions?: string;
@@ -458,6 +459,13 @@ declare class SlateSpecification<ConfigType extends {}, AuthType extends {}> {
 }
 declare let spec: <ConfigType extends {}, AuthType extends {}>(params: SlateSpecificationCreateParameters<ConfigType, AuthType>) => SlateSpecification<ConfigType, AuthType>;
 
+interface SlateRuntimeInfo {
+    metorial?: {
+        apiUrl: string;
+        region?: string | null;
+        environment?: string | null;
+    };
+}
 type SlateAddAttachmentContent = Buffer | Uint8Array | ArrayBuffer | ReadableStream<Uint8Array> | NodeJS.ReadableStream | Response;
 type SlateAddAttachmentInput = {
     type: 'url';
@@ -478,7 +486,8 @@ declare class SlatePublicContext<InputType extends {}> {
     #private;
     private readonly spec;
     private readonly logger;
-    constructor(input: InputType, spec: SlateSpecification<any, any>, logger: SlateLogger, liveInvocation?: SlateLiveInvocationInfo | null);
+    constructor(input: InputType, spec: SlateSpecification<any, any>, logger: SlateLogger, liveInvocation?: SlateLiveInvocationInfo | null, runtimeInfo?: SlateRuntimeInfo | null);
+    get runtimeInfo(): Readonly<SlateRuntimeInfo> | null;
     get specification(): SlateSpecification<any, any>;
     get input(): Readonly<InputType>;
     get event(): Readonly<InputType>;
@@ -516,7 +525,7 @@ declare class SlatePublicContext<InputType extends {}> {
 }
 declare class SlateContext<ConfigType extends {}, AuthType extends {}, InputType extends {}> extends SlatePublicContext<InputType> {
     #private;
-    constructor(config: ConfigType, input: InputType, auth: AuthType, spec: SlateSpecification<ConfigType, AuthType>, logger: SlateLogger, liveInvocation?: SlateLiveInvocationInfo | null);
+    constructor(config: ConfigType, input: InputType, auth: AuthType, spec: SlateSpecification<ConfigType, AuthType>, logger: SlateLogger, liveInvocation?: SlateLiveInvocationInfo | null, runtimeInfo?: SlateRuntimeInfo | null);
     get config(): Readonly<ConfigType>;
     get auth(): Readonly<AuthType>;
     _getAuthConfigForRedaction(): Record<string, unknown> | undefined;
@@ -524,6 +533,7 @@ declare class SlateContext<ConfigType extends {}, AuthType extends {}, InputType
 
 declare let runWithContext: <InputType extends {}, RV>(context: SlatePublicContext<InputType>, fn: () => Promise<RV>) => Promise<RV>;
 declare let getCurrentContext: <ConfigType extends {}, AuthType extends {}, InputType extends {}>() => SlateContext<ConfigType, AuthType, InputType>;
+declare let getRuntimeInfo: () => Readonly<SlateRuntimeInfo> | null;
 
 declare let SlateDefaultPollingIntervalSeconds: number;
 type SlateTriggerRoutingMatcher = Record<string, any>;
@@ -1076,6 +1086,7 @@ interface SlateErrorResponse {
     issues?: SlateErrorIssue[];
     provider?: SlateErrorProviderInfo;
     upstream?: SlateErrorUpstreamInfo;
+    upstreamCode?: string;
     baggage?: Record<string, unknown>;
     requestTraces?: SlateHttpTrace[];
 }
@@ -1204,4 +1215,4 @@ declare let skipWebhook: (reason: string, response?: Response | SlateWebhookHttp
     response: Response | SlateWebhookHttpResponseInit;
 };
 
-export { API_ERROR_MAX_DETAILS, API_ERROR_MAX_MESSAGE_LENGTH, API_ERROR_TRUNCATED_PLACEHOLDER, AUTH_CONFIG_SECRET_PLACEHOLDER_PREFIX, type ApiErrorBuildHelpers, type ApiErrorDetailOptions, type ApiErrorResponse, type ApiErrorStatus, type ApiErrorTextOptions, type ApiServiceError, type AuthConfigSecretFilter, AuthConfigSecretRedactor, type BoundedApiErrorDetailOptions, type BuildApiServiceErrorOptions, type CreateHmacSignatureOptions, type DecodeApiErrorBodyOptions, GET_FILE_URL_TOOL_ID, type GetFileUrlHandler, type GetFileUrlToolInput, type GetFileUrlToolOutput, type NormalizeOAuthTokenResponseOptions, type OAuthExpiresAtOptions, type OAuthRefreshTokenFallbackMode, type OAuthTokenResponse, 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, SlateAdapter, type SlateAdapterCapability, SlateAdapterSpec, type SlateAdapterSpecParameters, type SlateAddAttachmentContent, type SlateAddAttachmentInput, type SlateAttachment, type SlateAttachmentInlineContent, type SlateAttachmentUploadReferenceContent, type SlateAttachmentUrlContent, SlateAuth, type SlateAuthDocsReference, type SlateAuthType, type SlateAuthWithCustomData, type SlateAuthWithNone, type SlateAuthWithOauth, type SlateAuthWithServiceAccount, type SlateAuthWithToken, type SlateAuthenticatedAxiosDefaults, type SlateAxiosDefaults, type SlateAxiosErrorAdapter, type SlateAxiosErrorOptions, SlateConfig, type SlateConfigDocsReference, SlateContext, SlateDeclarationError, SlateDefaultPollingIntervalSeconds, type SlateDirectUploadInput, type SlateDocsReference, SlateError, type SlateErrorInput, type SlateErrorIssue, type SlateErrorKind, type SlateErrorProviderInfo, type SlateErrorResponse, type SlateErrorUpstreamInfo, type SlateGatewayEvent, type SlateLiveInvocationInfo, type SlateLogEntry, type SlateLogFields, type SlateLogListener, type SlateLogMessageInput, type SlateLogType, SlateLogger, type SlateProviderDocsReference, SlatePublicContext, SlatePublicTool, type SlatePublicToolInvocationHandler, type SlatePublicToolParameters, type SlateServiceErrorData, SlateSpecification, type SlateSpecificationCreateParameters, type SlateSpecificationParameters, SlateTool, SlateToolCategory, type SlateToolCategoryParameters, type SlateToolInvocationHandler, type SlateToolParameters, SlateTrigger, SlateTriggerGroup, SlateTriggerGroupBuilder, type SlateTriggerGroupCreateParameters, type SlateTriggerGroupGatewayConnectHandler, type SlateTriggerGroupGatewayParameters, type SlateTriggerGroupGatewayReceiveHandler, type SlateTriggerGroupParameters, type SlateTriggerGroupPollHandler, type SlateTriggerGroupPollingParameters, type SlateTriggerGroupRoutingMatchersHandler, type SlateTriggerGroupWebhookAutoRegistrationParameters, type SlateTriggerGroupWebhookManualRegistrationParameters, type SlateTriggerGroupWebhookParameters, type SlateTriggerMappingHandler, type SlateTriggerMatchesHandler, type SlateTriggerParameters, type SlateTriggerRoutingMatcher, type SlateTypedDocsReference, type SlateWebhookHttpResponseInit, type SlateWebhookManualFinishHandler, type SlateWebhookManualSetupHandler, type SlateWebhookProcessHandler, type SlateWebhookRegisterHandler, type SlateWebhookSkipped, type SlateWebhookTarget, type SlateWebhookTargetListHandler, type SlateWebhookTargetOwnership, type SlateWebhookUnregisterHandler, type VerifyHmacSignatureOptions, adapterSpec, allOf, anyOf, auth, axios, buildApiServiceError, collectApiErrorDetails, config, createApiServiceError, createAuthenticatedAxios, createAxios, createBase64Attachment, createHmacSignature, createSlateError, createTextAttachment, createUrlAttachment, decodeApiErrorBody, extractApiErrorMessage, getApiErrorResponse, getApiErrorResponseWithBody, getApiErrorStatus, getBase64ByteLength, getCurrentContext, getFileUrlTool, getFileUrlToolInputSchema, getFileUrlToolOutputSchema, getGraphWebhookValidationResponse, getMetaWebhookVerificationResponse, getOAuthExpiresAtFromExpiresIn, getResponseHeaderValue, getServiceErrorData, graphWebhookHttp, inferSlateErrorFromAxios, isApiErrorRecord, isAxiosErrorLike, isServiceErrorData, isUrlEmbeddedCredential, looksLikeHtmlErrorBody, mapServiceErrorCode, mapServiceErrorToSlateErrorInput, mergeScopes, metaWebhookHttp, normalizeOAuthTokenResponse, pickDefined, publicTool, pushBoundedApiErrorDetail, readApiErrorText, redactUrlAttachmentSecrets, requestAxios, requestAxiosData, runWithContext, scopeClause, setIfDefined, skipWebhook, spec, statusLabelForApiError, tool, toolCategory, trigger, triggerGroup, truncateApiErrorMessage, uploadAttachmentDirect, validateScopes, verifyHmacSignature };
+export { API_ERROR_MAX_DETAILS, API_ERROR_MAX_MESSAGE_LENGTH, API_ERROR_TRUNCATED_PLACEHOLDER, AUTH_CONFIG_SECRET_PLACEHOLDER_PREFIX, type ApiErrorBuildHelpers, type ApiErrorDetailOptions, type ApiErrorResponse, type ApiErrorStatus, type ApiErrorTextOptions, type ApiServiceError, type AuthConfigSecretFilter, AuthConfigSecretRedactor, type BoundedApiErrorDetailOptions, type BuildApiServiceErrorOptions, type CreateHmacSignatureOptions, type DecodeApiErrorBodyOptions, GET_FILE_URL_TOOL_ID, type GetFileUrlHandler, type GetFileUrlToolInput, type GetFileUrlToolOutput, type NormalizeOAuthTokenResponseOptions, type OAuthExpiresAtOptions, type OAuthRefreshTokenFallbackMode, type OAuthTokenResponse, 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, SlateAdapter, type SlateAdapterCapability, SlateAdapterSpec, type SlateAdapterSpecParameters, type SlateAddAttachmentContent, type SlateAddAttachmentInput, type SlateAttachment, type SlateAttachmentInlineContent, type SlateAttachmentUploadReferenceContent, type SlateAttachmentUrlContent, SlateAuth, type SlateAuthDocsReference, type SlateAuthType, type SlateAuthWithCustomData, type SlateAuthWithNone, type SlateAuthWithOauth, type SlateAuthWithServiceAccount, type SlateAuthWithToken, type SlateAuthenticatedAxiosDefaults, type SlateAxiosDefaults, type SlateAxiosErrorAdapter, type SlateAxiosErrorOptions, SlateConfig, type SlateConfigDocsReference, SlateContext, SlateDeclarationError, SlateDefaultPollingIntervalSeconds, type SlateDirectUploadInput, type SlateDocsReference, SlateError, type SlateErrorInput, type SlateErrorIssue, type SlateErrorKind, type SlateErrorProviderInfo, type SlateErrorResponse, type SlateErrorUpstreamInfo, type SlateGatewayEvent, type SlateLiveInvocationInfo, type SlateLogEntry, type SlateLogFields, type SlateLogListener, type SlateLogMessageInput, type SlateLogType, SlateLogger, type SlateProviderDocsReference, SlatePublicContext, SlatePublicTool, type SlatePublicToolInvocationHandler, type SlatePublicToolParameters, type SlateRuntimeInfo, type SlateServiceErrorData, SlateSpecification, type SlateSpecificationCreateParameters, type SlateSpecificationParameters, SlateTool, SlateToolCategory, type SlateToolCategoryParameters, type SlateToolInvocationHandler, type SlateToolParameters, SlateTrigger, SlateTriggerGroup, SlateTriggerGroupBuilder, type SlateTriggerGroupCreateParameters, type SlateTriggerGroupGatewayConnectHandler, type SlateTriggerGroupGatewayParameters, type SlateTriggerGroupGatewayReceiveHandler, type SlateTriggerGroupParameters, type SlateTriggerGroupPollHandler, type SlateTriggerGroupPollingParameters, type SlateTriggerGroupRoutingMatchersHandler, type SlateTriggerGroupWebhookAutoRegistrationParameters, type SlateTriggerGroupWebhookManualRegistrationParameters, type SlateTriggerGroupWebhookParameters, type SlateTriggerMappingHandler, type SlateTriggerMatchesHandler, type SlateTriggerParameters, type SlateTriggerRoutingMatcher, type SlateTypedDocsReference, type SlateWebhookHttpResponseInit, type SlateWebhookManualFinishHandler, type SlateWebhookManualSetupHandler, type SlateWebhookProcessHandler, type SlateWebhookRegisterHandler, type SlateWebhookSkipped, type SlateWebhookTarget, type SlateWebhookTargetListHandler, type SlateWebhookTargetOwnership, type SlateWebhookUnregisterHandler, type VerifyHmacSignatureOptions, adapterSpec, allOf, anyOf, auth, axios, buildApiServiceError, collectApiErrorDetails, config, createApiServiceError, createAuthenticatedAxios, createAxios, createBase64Attachment, createHmacSignature, createSlateError, createTextAttachment, createUrlAttachment, decodeApiErrorBody, extractApiErrorMessage, getApiErrorResponse, getApiErrorResponseWithBody, getApiErrorStatus, getBase64ByteLength, getCurrentContext, getFileUrlTool, getFileUrlToolInputSchema, getFileUrlToolOutputSchema, getGraphWebhookValidationResponse, getMetaWebhookVerificationResponse, getOAuthExpiresAtFromExpiresIn, getResponseHeaderValue, getRuntimeInfo, getServiceErrorData, graphWebhookHttp, inferSlateErrorFromAxios, isApiErrorRecord, isAxiosErrorLike, isServiceErrorData, isUrlEmbeddedCredential, looksLikeHtmlErrorBody, mapServiceErrorCode, mapServiceErrorToSlateErrorInput, mergeScopes, metaWebhookHttp, normalizeOAuthTokenResponse, pickDefined, publicTool, pushBoundedApiErrorDetail, readApiErrorText, redactUrlAttachmentSecrets, requestAxios, requestAxiosData, runWithContext, scopeClause, setIfDefined, skipWebhook, spec, statusLabelForApiError, tool, toolCategory, trigger, triggerGroup, truncateApiErrorMessage, uploadAttachmentDirect, validateScopes, verifyHmacSignature };

package/dist/index.d.ts

@@ -192,6 +192,7 @@ type SlateAuthWithOauth<InputType extends {}, OutputType extends {
     adapters?: string[];
     syncTokensAcrossConnections?: boolean;
     adminSetup?: {
+        required?: boolean;
         getAuthorizationUrl?: (ctx: SlateOauthAuthorizationUrlContext<InputType>) => Promise<SlateOauthAuthorizationUrlResult<InputType>>;
         handleCallback?: (ctx: SlateOauthAdminCallbackContext<InputType>) => Promise<{
             instructions?: string;
@@ -458,6 +459,13 @@ declare class SlateSpecification<ConfigType extends {}, AuthType extends {}> {
 }
 declare let spec: <ConfigType extends {}, AuthType extends {}>(params: SlateSpecificationCreateParameters<ConfigType, AuthType>) => SlateSpecification<ConfigType, AuthType>;
 
+interface SlateRuntimeInfo {
+    metorial?: {
+        apiUrl: string;
+        region?: string | null;
+        environment?: string | null;
+    };
+}
 type SlateAddAttachmentContent = Buffer | Uint8Array | ArrayBuffer | ReadableStream<Uint8Array> | NodeJS.ReadableStream | Response;
 type SlateAddAttachmentInput = {
     type: 'url';
@@ -478,7 +486,8 @@ declare class SlatePublicContext<InputType extends {}> {
     #private;
     private readonly spec;
     private readonly logger;
-    constructor(input: InputType, spec: SlateSpecification<any, any>, logger: SlateLogger, liveInvocation?: SlateLiveInvocationInfo | null);
+    constructor(input: InputType, spec: SlateSpecification<any, any>, logger: SlateLogger, liveInvocation?: SlateLiveInvocationInfo | null, runtimeInfo?: SlateRuntimeInfo | null);
+    get runtimeInfo(): Readonly<SlateRuntimeInfo> | null;
     get specification(): SlateSpecification<any, any>;
     get input(): Readonly<InputType>;
     get event(): Readonly<InputType>;
@@ -516,7 +525,7 @@ declare class SlatePublicContext<InputType extends {}> {
 }
 declare class SlateContext<ConfigType extends {}, AuthType extends {}, InputType extends {}> extends SlatePublicContext<InputType> {
     #private;
-    constructor(config: ConfigType, input: InputType, auth: AuthType, spec: SlateSpecification<ConfigType, AuthType>, logger: SlateLogger, liveInvocation?: SlateLiveInvocationInfo | null);
+    constructor(config: ConfigType, input: InputType, auth: AuthType, spec: SlateSpecification<ConfigType, AuthType>, logger: SlateLogger, liveInvocation?: SlateLiveInvocationInfo | null, runtimeInfo?: SlateRuntimeInfo | null);
     get config(): Readonly<ConfigType>;
     get auth(): Readonly<AuthType>;
     _getAuthConfigForRedaction(): Record<string, unknown> | undefined;
@@ -524,6 +533,7 @@ declare class SlateContext<ConfigType extends {}, AuthType extends {}, InputType
 
 declare let runWithContext: <InputType extends {}, RV>(context: SlatePublicContext<InputType>, fn: () => Promise<RV>) => Promise<RV>;
 declare let getCurrentContext: <ConfigType extends {}, AuthType extends {}, InputType extends {}>() => SlateContext<ConfigType, AuthType, InputType>;
+declare let getRuntimeInfo: () => Readonly<SlateRuntimeInfo> | null;
 
 declare let SlateDefaultPollingIntervalSeconds: number;
 type SlateTriggerRoutingMatcher = Record<string, any>;
@@ -1076,6 +1086,7 @@ interface SlateErrorResponse {
     issues?: SlateErrorIssue[];
     provider?: SlateErrorProviderInfo;
     upstream?: SlateErrorUpstreamInfo;
+    upstreamCode?: string;
     baggage?: Record<string, unknown>;
     requestTraces?: SlateHttpTrace[];
 }
@@ -1204,4 +1215,4 @@ declare let skipWebhook: (reason: string, response?: Response | SlateWebhookHttp
     response: Response | SlateWebhookHttpResponseInit;
 };
 
-export { API_ERROR_MAX_DETAILS, API_ERROR_MAX_MESSAGE_LENGTH, API_ERROR_TRUNCATED_PLACEHOLDER, AUTH_CONFIG_SECRET_PLACEHOLDER_PREFIX, type ApiErrorBuildHelpers, type ApiErrorDetailOptions, type ApiErrorResponse, type ApiErrorStatus, type ApiErrorTextOptions, type ApiServiceError, type AuthConfigSecretFilter, AuthConfigSecretRedactor, type BoundedApiErrorDetailOptions, type BuildApiServiceErrorOptions, type CreateHmacSignatureOptions, type DecodeApiErrorBodyOptions, GET_FILE_URL_TOOL_ID, type GetFileUrlHandler, type GetFileUrlToolInput, type GetFileUrlToolOutput, type NormalizeOAuthTokenResponseOptions, type OAuthExpiresAtOptions, type OAuthRefreshTokenFallbackMode, type OAuthTokenResponse, 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, SlateAdapter, type SlateAdapterCapability, SlateAdapterSpec, type SlateAdapterSpecParameters, type SlateAddAttachmentContent, type SlateAddAttachmentInput, type SlateAttachment, type SlateAttachmentInlineContent, type SlateAttachmentUploadReferenceContent, type SlateAttachmentUrlContent, SlateAuth, type SlateAuthDocsReference, type SlateAuthType, type SlateAuthWithCustomData, type SlateAuthWithNone, type SlateAuthWithOauth, type SlateAuthWithServiceAccount, type SlateAuthWithToken, type SlateAuthenticatedAxiosDefaults, type SlateAxiosDefaults, type SlateAxiosErrorAdapter, type SlateAxiosErrorOptions, SlateConfig, type SlateConfigDocsReference, SlateContext, SlateDeclarationError, SlateDefaultPollingIntervalSeconds, type SlateDirectUploadInput, type SlateDocsReference, SlateError, type SlateErrorInput, type SlateErrorIssue, type SlateErrorKind, type SlateErrorProviderInfo, type SlateErrorResponse, type SlateErrorUpstreamInfo, type SlateGatewayEvent, type SlateLiveInvocationInfo, type SlateLogEntry, type SlateLogFields, type SlateLogListener, type SlateLogMessageInput, type SlateLogType, SlateLogger, type SlateProviderDocsReference, SlatePublicContext, SlatePublicTool, type SlatePublicToolInvocationHandler, type SlatePublicToolParameters, type SlateServiceErrorData, SlateSpecification, type SlateSpecificationCreateParameters, type SlateSpecificationParameters, SlateTool, SlateToolCategory, type SlateToolCategoryParameters, type SlateToolInvocationHandler, type SlateToolParameters, SlateTrigger, SlateTriggerGroup, SlateTriggerGroupBuilder, type SlateTriggerGroupCreateParameters, type SlateTriggerGroupGatewayConnectHandler, type SlateTriggerGroupGatewayParameters, type SlateTriggerGroupGatewayReceiveHandler, type SlateTriggerGroupParameters, type SlateTriggerGroupPollHandler, type SlateTriggerGroupPollingParameters, type SlateTriggerGroupRoutingMatchersHandler, type SlateTriggerGroupWebhookAutoRegistrationParameters, type SlateTriggerGroupWebhookManualRegistrationParameters, type SlateTriggerGroupWebhookParameters, type SlateTriggerMappingHandler, type SlateTriggerMatchesHandler, type SlateTriggerParameters, type SlateTriggerRoutingMatcher, type SlateTypedDocsReference, type SlateWebhookHttpResponseInit, type SlateWebhookManualFinishHandler, type SlateWebhookManualSetupHandler, type SlateWebhookProcessHandler, type SlateWebhookRegisterHandler, type SlateWebhookSkipped, type SlateWebhookTarget, type SlateWebhookTargetListHandler, type SlateWebhookTargetOwnership, type SlateWebhookUnregisterHandler, type VerifyHmacSignatureOptions, adapterSpec, allOf, anyOf, auth, axios, buildApiServiceError, collectApiErrorDetails, config, createApiServiceError, createAuthenticatedAxios, createAxios, createBase64Attachment, createHmacSignature, createSlateError, createTextAttachment, createUrlAttachment, decodeApiErrorBody, extractApiErrorMessage, getApiErrorResponse, getApiErrorResponseWithBody, getApiErrorStatus, getBase64ByteLength, getCurrentContext, getFileUrlTool, getFileUrlToolInputSchema, getFileUrlToolOutputSchema, getGraphWebhookValidationResponse, getMetaWebhookVerificationResponse, getOAuthExpiresAtFromExpiresIn, getResponseHeaderValue, getServiceErrorData, graphWebhookHttp, inferSlateErrorFromAxios, isApiErrorRecord, isAxiosErrorLike, isServiceErrorData, isUrlEmbeddedCredential, looksLikeHtmlErrorBody, mapServiceErrorCode, mapServiceErrorToSlateErrorInput, mergeScopes, metaWebhookHttp, normalizeOAuthTokenResponse, pickDefined, publicTool, pushBoundedApiErrorDetail, readApiErrorText, redactUrlAttachmentSecrets, requestAxios, requestAxiosData, runWithContext, scopeClause, setIfDefined, skipWebhook, spec, statusLabelForApiError, tool, toolCategory, trigger, triggerGroup, truncateApiErrorMessage, uploadAttachmentDirect, validateScopes, verifyHmacSignature };
+export { API_ERROR_MAX_DETAILS, API_ERROR_MAX_MESSAGE_LENGTH, API_ERROR_TRUNCATED_PLACEHOLDER, AUTH_CONFIG_SECRET_PLACEHOLDER_PREFIX, type ApiErrorBuildHelpers, type ApiErrorDetailOptions, type ApiErrorResponse, type ApiErrorStatus, type ApiErrorTextOptions, type ApiServiceError, type AuthConfigSecretFilter, AuthConfigSecretRedactor, type BoundedApiErrorDetailOptions, type BuildApiServiceErrorOptions, type CreateHmacSignatureOptions, type DecodeApiErrorBodyOptions, GET_FILE_URL_TOOL_ID, type GetFileUrlHandler, type GetFileUrlToolInput, type GetFileUrlToolOutput, type NormalizeOAuthTokenResponseOptions, type OAuthExpiresAtOptions, type OAuthRefreshTokenFallbackMode, type OAuthTokenResponse, 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, SlateAdapter, type SlateAdapterCapability, SlateAdapterSpec, type SlateAdapterSpecParameters, type SlateAddAttachmentContent, type SlateAddAttachmentInput, type SlateAttachment, type SlateAttachmentInlineContent, type SlateAttachmentUploadReferenceContent, type SlateAttachmentUrlContent, SlateAuth, type SlateAuthDocsReference, type SlateAuthType, type SlateAuthWithCustomData, type SlateAuthWithNone, type SlateAuthWithOauth, type SlateAuthWithServiceAccount, type SlateAuthWithToken, type SlateAuthenticatedAxiosDefaults, type SlateAxiosDefaults, type SlateAxiosErrorAdapter, type SlateAxiosErrorOptions, SlateConfig, type SlateConfigDocsReference, SlateContext, SlateDeclarationError, SlateDefaultPollingIntervalSeconds, type SlateDirectUploadInput, type SlateDocsReference, SlateError, type SlateErrorInput, type SlateErrorIssue, type SlateErrorKind, type SlateErrorProviderInfo, type SlateErrorResponse, type SlateErrorUpstreamInfo, type SlateGatewayEvent, type SlateLiveInvocationInfo, type SlateLogEntry, type SlateLogFields, type SlateLogListener, type SlateLogMessageInput, type SlateLogType, SlateLogger, type SlateProviderDocsReference, SlatePublicContext, SlatePublicTool, type SlatePublicToolInvocationHandler, type SlatePublicToolParameters, type SlateRuntimeInfo, type SlateServiceErrorData, SlateSpecification, type SlateSpecificationCreateParameters, type SlateSpecificationParameters, SlateTool, SlateToolCategory, type SlateToolCategoryParameters, type SlateToolInvocationHandler, type SlateToolParameters, SlateTrigger, SlateTriggerGroup, SlateTriggerGroupBuilder, type SlateTriggerGroupCreateParameters, type SlateTriggerGroupGatewayConnectHandler, type SlateTriggerGroupGatewayParameters, type SlateTriggerGroupGatewayReceiveHandler, type SlateTriggerGroupParameters, type SlateTriggerGroupPollHandler, type SlateTriggerGroupPollingParameters, type SlateTriggerGroupRoutingMatchersHandler, type SlateTriggerGroupWebhookAutoRegistrationParameters, type SlateTriggerGroupWebhookManualRegistrationParameters, type SlateTriggerGroupWebhookParameters, type SlateTriggerMappingHandler, type SlateTriggerMatchesHandler, type SlateTriggerParameters, type SlateTriggerRoutingMatcher, type SlateTypedDocsReference, type SlateWebhookHttpResponseInit, type SlateWebhookManualFinishHandler, type SlateWebhookManualSetupHandler, type SlateWebhookProcessHandler, type SlateWebhookRegisterHandler, type SlateWebhookSkipped, type SlateWebhookTarget, type SlateWebhookTargetListHandler, type SlateWebhookTargetOwnership, type SlateWebhookUnregisterHandler, type VerifyHmacSignatureOptions, adapterSpec, allOf, anyOf, auth, axios, buildApiServiceError, collectApiErrorDetails, config, createApiServiceError, createAuthenticatedAxios, createAxios, createBase64Attachment, createHmacSignature, createSlateError, createTextAttachment, createUrlAttachment, decodeApiErrorBody, extractApiErrorMessage, getApiErrorResponse, getApiErrorResponseWithBody, getApiErrorStatus, getBase64ByteLength, getCurrentContext, getFileUrlTool, getFileUrlToolInputSchema, getFileUrlToolOutputSchema, getGraphWebhookValidationResponse, getMetaWebhookVerificationResponse, getOAuthExpiresAtFromExpiresIn, getResponseHeaderValue, getRuntimeInfo, getServiceErrorData, graphWebhookHttp, inferSlateErrorFromAxios, isApiErrorRecord, isAxiosErrorLike, isServiceErrorData, isUrlEmbeddedCredential, looksLikeHtmlErrorBody, mapServiceErrorCode, mapServiceErrorToSlateErrorInput, mergeScopes, metaWebhookHttp, normalizeOAuthTokenResponse, pickDefined, publicTool, pushBoundedApiErrorDetail, readApiErrorText, redactUrlAttachmentSecrets, requestAxios, requestAxiosData, runWithContext, scopeClause, setIfDefined, skipWebhook, spec, statusLabelForApiError, tool, toolCategory, trigger, triggerGroup, truncateApiErrorMessage, uploadAttachmentDirect, validateScopes, verifyHmacSignature };

package/dist/index.module.js

@@ -899,6 +899,7 @@ var getCurrentContext = () => {
   }
   return context;
 };
+var getRuntimeInfo = () => asyncLocalStorage.getStore()?.runtimeInfo ?? null;
 
 // src/error/defaults.ts
 var DEFAULT_CODE = "internal.unexpected";
@@ -1184,6 +1185,8 @@ var sanitizeForBaggage = (value, options = {}) => {
     return BAGGAGE_UNSERIALIZABLE_VALUE;
   }
 };
+var UPSTREAM_CODE_PATTERN = /^[\w.:-]{1,128}$/;
+var normalizeUpstreamCode = (value) => typeof value === "string" && UPSTREAM_CODE_PATTERN.test(value) ? value : void 0;
 var normalizeSlateErrorInput = (input) => {
   let code = input.code || DEFAULT_CODE;
   return {
@@ -1198,6 +1201,7 @@ var normalizeSlateErrorInput = (input) => {
       ...input.upstream,
       status: input.upstream?.status ?? input.status
     }),
+    upstreamCode: normalizeUpstreamCode(input.upstreamCode) ?? normalizeUpstreamCode(input.upstream?.code),
     baggage: cleanRecord(input.baggage),
     requestTraces: input.requestTraces
   };
@@ -1660,6 +1664,7 @@ var mapServiceErrorToSlateErrorInput = (error, defaults = {}) => {
     issues: defaults.issues ?? normalizeServiceErrorIssues(data.errors),
     provider: defaults.provider,
     upstream: defaults.upstream,
+    upstreamCode: normalizeUpstreamCode(defaults.upstreamCode) ?? normalizeUpstreamCode(data.upstreamCode),
     baggage: cleanRecord({
       ...defaults.baggage ?? {},
       ...getServiceErrorBaggage(data)
@@ -2765,6 +2770,10 @@ var resolveDefaultExport = (value) => {
 var PQueue = resolveDefaultExport(PQueueImport);
 
 // src/context/context.ts
+var freezeRuntimeInfo = (runtimeInfo) => Object.freeze({
+  ...runtimeInfo,
+  ...runtimeInfo.metorial ? { metorial: Object.freeze({ ...runtimeInfo.metorial }) } : {}
+});
 var isBufferLike = (value) => value instanceof Uint8Array || value instanceof ArrayBuffer;
 var toUint8Array = (value) => value instanceof ArrayBuffer ? new Uint8Array(value) : value;
 var isReadableStream = (value) => typeof ReadableStream !== "undefined" && value instanceof ReadableStream;
@@ -2781,17 +2790,19 @@ var readStreamToBuffer = async (stream) => {
   return Buffer.concat(chunks);
 };
 var SlatePublicContext = class {
-  constructor(input, spec2, logger, liveInvocation = null) {
+  constructor(input, spec2, logger, liveInvocation = null, runtimeInfo = null) {
     this.spec = spec2;
     this.logger = logger;
     this.#input = input;
     this.#liveInvocation = liveInvocation;
+    this.#runtimeInfo = runtimeInfo && freezeRuntimeInfo(runtimeInfo);
   }
   spec;
   logger;
   #input;
   #httpTraces = [];
   #liveInvocation;
+  #runtimeInfo;
   #attachmentsDisabled = false;
   #attachments = [];
   #pendingUploads = [];
@@ -2802,6 +2813,9 @@ var SlatePublicContext = class {
     }
     return this.#uploadQueue;
   }
+  get runtimeInfo() {
+    return this.#runtimeInfo;
+  }
   get specification() {
     return this.spec;
   }
@@ -2942,8 +2956,8 @@ var SlatePublicContext = class {
 var SlateContext = class extends SlatePublicContext {
   #config;
   #auth;
-  constructor(config2, input, auth2, spec2, logger, liveInvocation = null) {
-    super(input, spec2, logger, liveInvocation);
+  constructor(config2, input, auth2, spec2, logger, liveInvocation = null, runtimeInfo = null) {
+    super(input, spec2, logger, liveInvocation, runtimeInfo);
     this.#config = config2;
     this.#auth = auth2;
   }
@@ -3420,6 +3434,7 @@ export {
   getMetaWebhookVerificationResponse,
   getOAuthExpiresAtFromExpiresIn,
   getResponseHeaderValue,
+  getRuntimeInfo,
   getServiceErrorData,
   graphWebhookHttp,
   inferSlateErrorFromAxios,

package/package.json

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

package/src/auth/types.ts

@@ -65,8 +65,11 @@ export type SlateAuthWithOauth<
   syncTokensAcrossConnections?: boolean;
 
   // Missing hooks fall back to the regular flow (callback output discarded).
-  // Returned instructions are markdown shown to the admin.
+  // Returned instructions are markdown shown to the admin. `required` means users
+  // can't connect until an admin has completed setup; otherwise it is optional.
   adminSetup?: {
+    required?: boolean;
+
     getAuthorizationUrl?: (
       ctx: SlateOauthAuthorizationUrlContext<InputType>
     ) => Promise<SlateOauthAuthorizationUrlResult<InputType>>;

package/src/context/context.ts

@@ -12,6 +12,20 @@ import { PQueue } from './pQueue';
 
 export type { SlateLiveInvocationInfo };
 
+export interface SlateRuntimeInfo {
+  metorial?: {
+    apiUrl: string;
+    region?: string | null;
+    environment?: string | null;
+  };
+}
+
+let freezeRuntimeInfo = (runtimeInfo: SlateRuntimeInfo): Readonly<SlateRuntimeInfo> =>
+  Object.freeze({
+    ...runtimeInfo,
+    ...(runtimeInfo.metorial ? { metorial: Object.freeze({ ...runtimeInfo.metorial }) } : {})
+  });
+
 export type SlateAddAttachmentContent =
   | Buffer
   | Uint8Array
@@ -80,6 +94,7 @@ export class SlatePublicContext<InputType extends {}> {
   #httpTraces: SlateHttpTrace[] = [];
 
   #liveInvocation: SlateLiveInvocationInfo | null;
+  #runtimeInfo: Readonly<SlateRuntimeInfo> | null;
   #attachmentsDisabled = false;
   #attachments: SlateAttachment[] = [];
   #pendingUploads: Promise<void>[] = [];
@@ -96,10 +111,16 @@ export class SlatePublicContext<InputType extends {}> {
     input: InputType,
     private readonly spec: SlateSpecification<any, any>,
     private readonly logger: SlateLogger,
-    liveInvocation: SlateLiveInvocationInfo | null = null
+    liveInvocation: SlateLiveInvocationInfo | null = null,
+    runtimeInfo: SlateRuntimeInfo | null = null
   ) {
     this.#input = input;
     this.#liveInvocation = liveInvocation;
+    this.#runtimeInfo = runtimeInfo && freezeRuntimeInfo(runtimeInfo);
+  }
+
+  get runtimeInfo() {
+    return this.#runtimeInfo;
   }
 
   get specification() {
@@ -294,9 +315,10 @@ export class SlateContext<
     auth: AuthType,
     spec: SlateSpecification<ConfigType, AuthType>,
     logger: SlateLogger,
-    liveInvocation: SlateLiveInvocationInfo | null = null
+    liveInvocation: SlateLiveInvocationInfo | null = null,
+    runtimeInfo: SlateRuntimeInfo | null = null
   ) {
-    super(input, spec, logger, liveInvocation);
+    super(input, spec, logger, liveInvocation, runtimeInfo);
     this.#config = config;
     this.#auth = auth;
   }

package/src/context/hook.ts

@@ -30,3 +30,5 @@ export let getCurrentContext = <
   }
   return context as SlateContext<ConfigType, AuthType, InputType>;
 };
+
+export let getRuntimeInfo = () => asyncLocalStorage.getStore()?.runtimeInfo ?? null;

package/src/error/base.test.ts

@@ -17,6 +17,7 @@ import {
 } from '@lowerdeck/error';
 import { AxiosError, type AxiosResponse, type InternalAxiosRequestConfig } from 'axios';
 import { describe, expect, it } from 'vitest';
+import { createApiServiceError } from './api';
 import { SlateError } from './base';
 
 let createConfig = (overrides: Partial<InternalAxiosRequestConfig> = {}) =>
@@ -175,4 +176,80 @@ describe('SlateError', () => {
       });
     }
   });
+
+  it('exposes the upstream API error code as a top-level upstreamCode', () => {
+    expect(
+      new SlateError({ code: 'upstream.error', message: 'x', upstream: { code: 'E42' } }).data
+        .upstreamCode
+    ).toBe('E42');
+    expect(
+      new SlateError({
+        code: 'upstream.error',
+        message: 'x',
+        upstream: { code: 'nested' },
+        upstreamCode: 'explicit'
+      }).data.upstreamCode
+    ).toBe('explicit');
+    expect(
+      SlateError.fromServiceError(
+        createApiServiceError('x', { upstreamCode: 'card_declined' })
+      ).data.upstreamCode
+    ).toBe('card_declined');
+    expect(new SlateError({ code: 'upstream.error', message: 'x' }).data.upstreamCode).toBe(
+      undefined
+    );
+  });
+
+  it('accepts only code-shaped upstreamCode values', () => {
+    for (let code of [
+      'AADSTS700016',
+      'invalid_grant',
+      'RATE_LIMITED',
+      'request.bad',
+      'a:b-c'
+    ]) {
+      expect(
+        new SlateError({ code: 'upstream.error', message: 'x', upstreamCode: code }).data
+          .upstreamCode
+      ).toBe(code);
+    }
+
+    for (let code of ['', 'x'.repeat(129), 'has space', 'token=abc&x', 'line\nbreak', '`x`']) {
+      expect(
+        new SlateError({ code: 'upstream.error', message: 'x', upstreamCode: code }).data
+          .upstreamCode
+      ).toBe(undefined);
+      expect(
+        SlateError.fromServiceError(createApiServiceError('x', { upstreamCode: code })).data
+          .upstreamCode
+      ).toBe(undefined);
+    }
+
+    expect(
+      SlateError.fromServiceError(
+        createApiServiceError('x', { upstreamCode: { nested: true } as unknown as string })
+      ).data.upstreamCode
+    ).toBe(undefined);
+    expect(
+      new SlateError({ code: 'upstream.error', message: 'x', upstreamCode: 'x'.repeat(128) })
+        .data.upstreamCode
+    ).toBe('x'.repeat(128));
+    expect(
+      new SlateError({
+        code: 'upstream.error',
+        message: 'x',
+        upstreamCode: 'bad value',
+        upstream: { code: 'fallback_code' }
+      }).data.upstreamCode
+    ).toBe('fallback_code');
+  });
+
+  it('also keeps upstreamCode in service error baggage for older hubs', () => {
+    let error = SlateError.fromServiceError(
+      createApiServiceError('x', { upstreamCode: 'card_declined' })
+    );
+    expect(error.data.baggage?.serviceErrorData).toMatchObject({
+      upstreamCode: 'card_declined'
+    });
+  });
 });

package/src/error/service.ts

@@ -7,6 +7,7 @@ import {
   isRecord,
   normalizeKind,
   normalizeRetryable,
+  normalizeUpstreamCode,
   sanitizeForBaggage
 } from './utils';
 
@@ -162,6 +163,8 @@ export let mapServiceErrorToSlateErrorInput = (
     issues: defaults.issues ?? normalizeServiceErrorIssues(data.errors),
     provider: defaults.provider,
     upstream: defaults.upstream,
+    upstreamCode:
+      normalizeUpstreamCode(defaults.upstreamCode) ?? normalizeUpstreamCode(data.upstreamCode),
     baggage: cleanRecord({
       ...(defaults.baggage ?? {}),
       ...getServiceErrorBaggage(data)

package/src/error/types.ts

@@ -45,6 +45,8 @@ export interface SlateErrorResponse {
   issues?: SlateErrorIssue[];
   provider?: SlateErrorProviderInfo;
   upstream?: SlateErrorUpstreamInfo;
+  // The upstream API's own error code, next to the normalized protocol `code`.
+  upstreamCode?: string;
   baggage?: Record<string, unknown>;
   requestTraces?: SlateHttpTrace[];
 }

package/src/error/utils.ts

@@ -389,6 +389,13 @@ export let sanitizeForBaggage = (
   }
 };
 
+let UPSTREAM_CODE_PATTERN = /^[\w.:-]{1,128}$/;
+
+// upstreamCode is copied from untrusted upstream responses to the top level of the
+// error, outside the baggage sanitizer, so anything not code-shaped is dropped.
+export let normalizeUpstreamCode = (value: unknown): string | undefined =>
+  typeof value === 'string' && UPSTREAM_CODE_PATTERN.test(value) ? value : undefined;
+
 export let normalizeSlateErrorInput = (input: SlateErrorInput): SlateErrorResponse => {
   let code = input.code || DEFAULT_CODE;
   return {
@@ -405,6 +412,8 @@ export let normalizeSlateErrorInput = (input: SlateErrorInput): SlateErrorRespon
       ...input.upstream,
       status: input.upstream?.status ?? input.status
     }) as SlateErrorUpstreamInfo | undefined,
+    upstreamCode:
+      normalizeUpstreamCode(input.upstreamCode) ?? normalizeUpstreamCode(input.upstream?.code),
     baggage: cleanRecord(input.baggage),
     requestTraces: input.requestTraces
   };