@slates/provider 1.0.0-rc.16 → 1.0.0-rc.17

package/dist/index.cjs

@@ -46,26 +46,49 @@ __export(index_exports, {
   anyOf: () => anyOf,
   auth: () => auth,
   axios: () => axios,
+  buildApiServiceError: () => buildApiServiceError,
+  collectApiErrorDetails: () => collectApiErrorDetails,
   config: () => config,
+  createApiServiceError: () => createApiServiceError,
+  createAuthenticatedAxios: () => createAuthenticatedAxios,
   createAxios: () => createAxios,
   createBase64Attachment: () => createBase64Attachment,
+  createHmacSignature: () => createHmacSignature,
   createSlateError: () => createSlateError,
   createTextAttachment: () => createTextAttachment,
   createUrlAttachment: () => createUrlAttachment,
+  extractApiErrorMessage: () => extractApiErrorMessage,
+  getApiErrorResponse: () => getApiErrorResponse,
+  getApiErrorStatus: () => getApiErrorStatus,
+  getBase64ByteLength: () => getBase64ByteLength,
   getCurrentContext: () => getCurrentContext,
+  getGraphWebhookValidationResponse: () => getGraphWebhookValidationResponse,
+  getMetaWebhookVerificationResponse: () => getMetaWebhookVerificationResponse,
+  getOAuthExpiresAtFromExpiresIn: () => getOAuthExpiresAtFromExpiresIn,
+  getResponseHeaderValue: () => getResponseHeaderValue,
   getServiceErrorData: () => getServiceErrorData,
+  graphWebhookHttp: () => graphWebhookHttp,
   inferSlateErrorFromAxios: () => inferSlateErrorFromAxios,
+  isApiErrorRecord: () => isApiErrorRecord,
   isAxiosErrorLike: () => isAxiosErrorLike,
   isServiceErrorData: () => isServiceErrorData,
   mapServiceErrorCode: () => mapServiceErrorCode,
   mapServiceErrorToSlateErrorInput: () => mapServiceErrorToSlateErrorInput,
   mergeScopes: () => mergeScopes,
+  metaWebhookHttp: () => metaWebhookHttp,
+  normalizeOAuthTokenResponse: () => normalizeOAuthTokenResponse,
+  pickDefined: () => pickDefined,
+  requestAxios: () => requestAxios,
+  requestAxiosData: () => requestAxiosData,
   runWithContext: () => runWithContext,
   scopeClause: () => scopeClause,
+  setIfDefined: () => setIfDefined,
   spec: () => spec,
+  statusLabelForApiError: () => statusLabelForApiError,
   tool: () => tool,
   trigger: () => trigger,
-  validateScopes: () => validateScopes
+  validateScopes: () => validateScopes,
+  verifyHmacSignature: () => verifyHmacSignature
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -127,6 +150,124 @@ var SlateAction = class {
   }
 };
 
+// src/error/api.ts
+var import_error = require("@lowerdeck/error");
+var DEFAULT_DETAIL_KEYS = ["message", "detail", "error", "error_description", "code"];
+var DEFAULT_NESTED_KEYS = ["errors"];
+var isApiErrorRecord = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
+var pushDetail = (details, value, options = {}) => {
+  if (typeof value !== "string" && (options.includeNumbers === false || typeof value !== "number")) {
+    return;
+  }
+  let detail = String(value).trim();
+  if (detail && !details.includes(detail)) {
+    details.push(detail);
+  }
+};
+var collectApiErrorDetails = (value, details, options = {}) => {
+  if (Array.isArray(value)) {
+    for (let item of value) {
+      collectApiErrorDetails(item, details, options);
+    }
+    return;
+  }
+  if (!isApiErrorRecord(value)) {
+    pushDetail(details, value, options);
+    return;
+  }
+  for (let key of options.detailKeys ?? DEFAULT_DETAIL_KEYS) {
+    pushDetail(details, value[key], options);
+  }
+  for (let key of options.nestedKeys ?? DEFAULT_NESTED_KEYS) {
+    collectApiErrorDetails(value[key], details, options);
+  }
+};
+var getSlateErrorResponse = (error) => {
+  if (error.name !== "SlateError" || !isApiErrorRecord(error.data)) {
+    return void 0;
+  }
+  let data = error.data;
+  let upstream = isApiErrorRecord(data.upstream) ? data.upstream : void 0;
+  let status = upstream?.status ?? data.status;
+  return typeof status === "number" || typeof status === "string" ? { status } : void 0;
+};
+var getApiErrorResponse = (error) => {
+  if (!isApiErrorRecord(error)) {
+    return void 0;
+  }
+  if (!isApiErrorRecord(error.response)) {
+    return getSlateErrorResponse(error);
+  }
+  let response = error.response;
+  return {
+    status: typeof response.status === "number" || typeof response.status === "string" ? response.status : void 0,
+    statusText: typeof response.statusText === "string" ? response.statusText : void 0,
+    data: response.data
+  };
+};
+var getApiErrorStatus = (error) => getApiErrorResponse(error)?.status;
+var statusLabelForApiError = (status, statusText) => status !== void 0 ? `HTTP ${status}${statusText ? ` ${statusText}` : ""}: ` : "";
+var extractApiErrorMessage = (error, options = {}) => {
+  let details = [];
+  let response = options.response ?? getApiErrorResponse(error);
+  collectApiErrorDetails(response?.data, details, options);
+  if (details.length > 0) {
+    return details.join(options.separator ?? " - ");
+  }
+  if (error instanceof Error && error.message) {
+    return error.message;
+  }
+  return options.fallbackMessage ?? "Unknown error";
+};
+var createApiServiceError = (message, options = {}) => {
+  let error = new import_error.ServiceError((0, import_error.badRequestError)({ message }));
+  if (options.reason !== void 0) {
+    error.data.reason = options.reason;
+  }
+  if ("upstreamStatus" in options) {
+    error.data.upstreamStatus = options.upstreamStatus;
+  }
+  if ("upstreamCode" in options) {
+    error.data.upstreamCode = options.upstreamCode;
+  }
+  if (options.parent instanceof Error) {
+    error.setParent(options.parent);
+  }
+  return error;
+};
+var helpers = {
+  collectDetails: collectApiErrorDetails,
+  extractMessage: extractApiErrorMessage,
+  getResponse: getApiErrorResponse,
+  getStatus: getApiErrorStatus,
+  isRecord: isApiErrorRecord,
+  statusLabelFor: statusLabelForApiError
+};
+var buildApiServiceError = (error, options) => {
+  if (error instanceof import_error.ServiceError) {
+    return error;
+  }
+  let operation = options.operation ?? "request";
+  let response = options.extractResponse?.(error, helpers) ?? getApiErrorResponse(error);
+  let status = options.extractStatus?.(error, response, helpers) ?? response?.status;
+  let message = options.extractMessage?.(error, helpers) ?? extractApiErrorMessage(error, { ...options, response });
+  let statusLabel = statusLabelForApiError(status, response?.statusText);
+  let fullMessage = options.formatMessage?.({
+    providerLabel: options.providerLabel,
+    operation,
+    statusLabel,
+    message,
+    response,
+    status
+  }) ?? `${options.providerLabel} API ${operation} failed: ${statusLabel}${message}`;
+  return createApiServiceError(fullMessage, {
+    reason: options.reason,
+    upstreamStatus: status,
+    upstreamCode: options.extractUpstreamCode?.(error, response, helpers),
+    parent: options.parent ?? error
+  });
+};
+
 // src/error/axios.ts
 var import_axios = require("axios");
 
@@ -468,7 +609,7 @@ var inferSlateErrorFromAxios = (error, options = {}) => {
 };
 
 // src/error/service.ts
-var import_error = require("@lowerdeck/error");
+var import_error2 = require("@lowerdeck/error");
 var SERVICE_ERROR_DATA_RESERVED_KEYS = /* @__PURE__ */ new Set([
   "status",
   "code",
@@ -535,7 +676,7 @@ var getServiceErrorBaggage = (data) => {
 var mapServiceErrorCode = (code, status) => SERVICE_ERROR_CODE_MAP[code] ?? mapServiceErrorCodeByStatus(status);
 var isServiceErrorData = (value) => isRecord(value) && typeof value.status === "number" && typeof value.code === "string" && typeof value.message === "string" && !("config" in value) && !("request" in value) && !("response" in value) && !("isAxiosError" in value);
 var getServiceErrorData = (error) => {
-  if ((0, import_error.isServiceError)(error)) {
+  if ((0, import_error2.isServiceError)(error)) {
     return isServiceErrorData(error.data) ? error.data : null;
   }
   if (isServiceErrorData(error)) {
@@ -816,7 +957,8 @@ var SlateActionBuilder = class {
       handleEvent: props.handleEvent,
       handleRequest: props.handleRequest,
       autoRegisterWebhook: props.autoRegisterWebhook,
-      autoUnregisterWebhook: props.autoUnregisterWebhook
+      autoUnregisterWebhook: props.autoUnregisterWebhook,
+      http: props.http
     };
     return this;
   }
@@ -891,6 +1033,7 @@ var SlateTrigger = class _SlateTrigger extends SlateAction {
   #polling;
   #handleEvent;
   #handleRequest;
+  #http;
   #pollEvents;
   #autoRegisterWebhook;
   #autoUnregisterWebhook;
@@ -902,6 +1045,7 @@ var SlateTrigger = class _SlateTrigger extends SlateAction {
     };
     this.#handleEvent = params.handleEvent;
     this.#handleRequest = params.handleRequest;
+    this.#http = params.http;
     this.#pollEvents = params.pollEvents;
     this.#autoRegisterWebhook = params.autoRegisterWebhook;
     this.#autoUnregisterWebhook = params.autoUnregisterWebhook;
@@ -924,6 +1068,9 @@ var SlateTrigger = class _SlateTrigger extends SlateAction {
   get handleRequest() {
     return this.#handleRequest;
   }
+  get http() {
+    return this.#http;
+  }
   get pollEvents() {
     return this.#pollEvents;
   }
@@ -1018,6 +1165,90 @@ var SlateAuth = class _SlateAuth {
 };
 var auth = () => SlateAuth.create();
 
+// src/auth/oauth.ts
+var isOAuthTokenResponse = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
+var formatOAuthTokenResponseMessage = (fieldLabel, providerLabel = "OAuth provider", operation = "token response") => `${providerLabel} OAuth ${operation} did not return ${fieldLabel}.`;
+var getOAuthExpiresAtFromExpiresIn = (expiresIn, options = {}) => {
+  let {
+    nowMs = Date.now(),
+    providerLabel,
+    operation,
+    required = false,
+    expiresInType = "numberLike",
+    message
+  } = options;
+  if (expiresIn === void 0 || expiresIn === null || expiresIn === "") {
+    if (required) {
+      throw createApiServiceError(
+        message ?? formatOAuthTokenResponseMessage(
+          "a valid expires_in value",
+          providerLabel,
+          operation
+        ),
+        { reason: "oauth_token_response" }
+      );
+    }
+    return void 0;
+  }
+  let seconds = typeof expiresIn === "number" ? expiresIn : expiresInType === "numberLike" && typeof expiresIn === "string" ? Number(expiresIn) : Number.NaN;
+  if (!Number.isFinite(seconds)) {
+    throw createApiServiceError(
+      message ?? formatOAuthTokenResponseMessage("a valid expires_in value", providerLabel, operation),
+      { reason: "oauth_token_response" }
+    );
+  }
+  return new Date(nowMs + seconds * 1e3).toISOString();
+};
+var getRefreshToken = (refreshToken, previousRefreshToken, fallbackMode) => {
+  if (typeof refreshToken === "string") {
+    if (fallbackMode === "falsy" && !refreshToken) {
+      return previousRefreshToken;
+    }
+    return refreshToken;
+  }
+  if (fallbackMode === "falsy" && !refreshToken) {
+    return previousRefreshToken;
+  }
+  return refreshToken === void 0 || refreshToken === null ? previousRefreshToken : void 0;
+};
+var normalizeOAuthTokenResponse = (data, options = {}) => {
+  let {
+    providerLabel,
+    operation,
+    previousRefreshToken,
+    refreshTokenFallbackMode = "nullish",
+    accessTokenMessage,
+    expiresInMessage,
+    ...expiresAtOptions
+  } = options;
+  if (!isOAuthTokenResponse(data)) {
+    throw createApiServiceError(
+      accessTokenMessage ?? formatOAuthTokenResponseMessage("a token response object", providerLabel, operation),
+      { reason: "oauth_token_response" }
+    );
+  }
+  if (typeof data.access_token !== "string" || !data.access_token) {
+    throw createApiServiceError(
+      accessTokenMessage ?? formatOAuthTokenResponseMessage("an access token", providerLabel, operation),
+      { reason: "oauth_token_response" }
+    );
+  }
+  return {
+    token: data.access_token,
+    refreshToken: getRefreshToken(
+      data.refresh_token,
+      previousRefreshToken,
+      refreshTokenFallbackMode
+    ),
+    expiresAt: getOAuthExpiresAtFromExpiresIn(data.expires_in, {
+      ...expiresAtOptions,
+      providerLabel,
+      operation,
+      message: expiresInMessage
+    })
+  };
+};
+
 // src/axios/index.ts
 var import_axios3 = __toESM(require("axios"), 1);
 
@@ -1601,6 +1832,35 @@ var createAxios = (config2) => {
   applySlateInterceptors(instance, errorMapping);
   return instance;
 };
+var createAuthenticatedAxios = (config2) => {
+  let { authHeader, contentType = "application/json", errorAdapter, ...axiosConfig } = config2;
+  let instance = createAxios({
+    ...axiosConfig,
+    headers: {
+      ...contentType === false ? {} : { "Content-Type": contentType },
+      ...authHeader ? { [authHeader.name ?? "Authorization"]: authHeader.value } : {},
+      ...axiosConfig.headers
+    }
+  });
+  if (errorAdapter) {
+    instance.interceptors.response.use(
+      (response) => response,
+      (error) => Promise.reject(errorAdapter(error))
+    );
+  }
+  return instance;
+};
+var requestAxios = async (operation, request, errorAdapter) => {
+  try {
+    return await request();
+  } catch (error) {
+    throw errorAdapter(error, operation);
+  }
+};
+var requestAxiosData = async (operation, request, errorAdapter) => {
+  let response = await requestAxios(operation, request, errorAdapter);
+  return response.data;
+};
 var axios = createAxios();
 
 // src/config/config.ts
@@ -1679,6 +1939,11 @@ var SlateContext = class {
   get request() {
     return Object.freeze(this.#input.request);
   }
+  get registrationDetails() {
+    return Object.freeze(
+      this.#input.registrationDetails
+    );
+  }
   get auth() {
     return Object.freeze(this.#auth);
   }
@@ -1717,6 +1982,45 @@ var SlateContext = class {
   }
 };
 
+// src/crypto/hmac.ts
+var import_crypto = require("crypto");
+var createHmacSignature = ({
+  secret,
+  payload,
+  algorithm = "sha256",
+  digest,
+  prefix = ""
+}) => `${prefix}${(0, import_crypto.createHmac)(algorithm, secret).update(payload).digest(digest)}`;
+var verifyHmacSignature = (options) => {
+  let expected = createHmacSignature(options);
+  let expectedBytes = Buffer.from(expected);
+  let signatureBytes = Buffer.from(options.signature);
+  let lengthsMatch = signatureBytes.length === expectedBytes.length;
+  let comparableSignature = lengthsMatch ? signatureBytes : Buffer.alloc(expectedBytes.length);
+  return (0, import_crypto.timingSafeEqual)(comparableSignature, expectedBytes) && lengthsMatch;
+};
+
+// src/file/index.ts
+var getResponseHeaderValue = (headers, name) => {
+  if (!headers) return void 0;
+  if (typeof headers.get === "function") {
+    let value = headers.get(name);
+    return typeof value === "string" ? value : void 0;
+  }
+  if (typeof headers !== "object") return void 0;
+  let lowerName = name.toLowerCase();
+  for (let [headerName, value] of Object.entries(headers)) {
+    if (headerName.toLowerCase() !== lowerName) continue;
+    if (Array.isArray(value)) {
+      let first = value.find((item) => typeof item === "string");
+      return typeof first === "string" ? first : void 0;
+    }
+    return typeof value === "string" ? value : void 0;
+  }
+  return void 0;
+};
+var getBase64ByteLength = (contentBase64) => Buffer.from(contentBase64, "base64").byteLength;
+
 // src/logger/logger.ts
 var import_toon = require("@toon-format/toon");
 var isRecord3 = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
@@ -1812,6 +2116,17 @@ var SlateLogger = class {
   }
 };
 
+// src/object/index.ts
+var pickDefined = (value) => Object.fromEntries(
+  Object.entries(value).filter(([, child]) => child !== void 0)
+);
+var setIfDefined = (target, key, value) => {
+  if (value !== void 0) {
+    target[key] = value;
+  }
+  return target;
+};
+
 // src/specification/slate.ts
 var Slate = class _Slate {
   constructor(_spec, _actions) {
@@ -1874,6 +2189,59 @@ var SlateSpecification = class _SlateSpecification {
   }
 };
 var spec = (params) => SlateSpecification.create(params);
+
+// src/webhook/graph.ts
+var graphWebhookHttp = {
+  methods: ["POST"],
+  sync: {
+    mode: "match",
+    match: [{ hasQueryParam: "validationToken" }]
+  }
+};
+var getGraphWebhookValidationResponse = (request) => {
+  let validationToken = new URL(request.url).searchParams.get("validationToken");
+  if (validationToken === null) return null;
+  return {
+    status: 200,
+    headers: { "content-type": "text/plain" },
+    body: validationToken
+  };
+};
+
+// src/webhook/meta.ts
+var metaWebhookHttp = {
+  methods: ["GET", "POST"],
+  sync: {
+    mode: "match",
+    match: [{ method: "GET", hasQueryParam: "hub.mode" }]
+  }
+};
+var getMetaWebhookVerificationResponse = (request, expectedVerifyToken) => {
+  if (request.method !== "GET") return null;
+  let url = new URL(request.url);
+  let mode = url.searchParams.get("hub.mode");
+  let verifyToken = url.searchParams.get("hub.verify_token");
+  let challenge = url.searchParams.get("hub.challenge");
+  if (mode !== "subscribe" || challenge === null) {
+    return {
+      status: 400,
+      headers: { "content-type": "text/plain" },
+      body: "invalid webhook verification request"
+    };
+  }
+  if (expectedVerifyToken !== void 0 && verifyToken !== expectedVerifyToken) {
+    return {
+      status: 403,
+      headers: { "content-type": "text/plain" },
+      body: "invalid verify token"
+    };
+  }
+  return {
+    status: 200,
+    headers: { "content-type": "text/plain" },
+    body: challenge
+  };
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   Slate,
@@ -1892,24 +2260,47 @@ var spec = (params) => SlateSpecification.create(params);
   anyOf,
   auth,
   axios,
+  buildApiServiceError,
+  collectApiErrorDetails,
   config,
+  createApiServiceError,
+  createAuthenticatedAxios,
   createAxios,
   createBase64Attachment,
+  createHmacSignature,
   createSlateError,
   createTextAttachment,
   createUrlAttachment,
+  extractApiErrorMessage,
+  getApiErrorResponse,
+  getApiErrorStatus,
+  getBase64ByteLength,
   getCurrentContext,
+  getGraphWebhookValidationResponse,
+  getMetaWebhookVerificationResponse,
+  getOAuthExpiresAtFromExpiresIn,
+  getResponseHeaderValue,
   getServiceErrorData,
+  graphWebhookHttp,
   inferSlateErrorFromAxios,
+  isApiErrorRecord,
   isAxiosErrorLike,
   isServiceErrorData,
   mapServiceErrorCode,
   mapServiceErrorToSlateErrorInput,
   mergeScopes,
+  metaWebhookHttp,
+  normalizeOAuthTokenResponse,
+  pickDefined,
+  requestAxios,
+  requestAxiosData,
   runWithContext,
   scopeClause,
+  setIfDefined,
   spec,
+  statusLabelForApiError,
   tool,
   trigger,
-  validateScopes
+  validateScopes,
+  verifyHmacSignature
 });