@dataships/sdk 0.0.0-stage → 2.0.1

package/dist/adapters/salesforce/index.js

@@ -0,0 +1,328 @@
+var __typeError = (msg) => {
+  throw TypeError(msg);
+};
+var __accessCheck = (obj, member, msg) => member.has(obj) || __typeError("Cannot " + msg);
+var __privateGet = (obj, member, getter) => (__accessCheck(obj, member, "read from private field"), getter ? getter.call(obj) : member.get(obj));
+var __privateAdd = (obj, member, value) => member.has(obj) ? __typeError("Cannot add the same private member more than once") : member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+var __privateSet = (obj, member, value, setter) => (__accessCheck(obj, member, "write to private field"), member.set(obj, value), value);
+var __privateMethod = (obj, member, method) => (__accessCheck(obj, member, "access private method"), method);
+
+// src/utils/uuid.ts
+var randomUuid = (cryptoObj = globalThis.crypto) => {
+  if (cryptoObj && typeof cryptoObj.randomUUID === "function") {
+    return cryptoObj.randomUUID();
+  }
+  const bytes = new Uint8Array(16);
+  if (cryptoObj && typeof cryptoObj.getRandomValues === "function") {
+    cryptoObj.getRandomValues(bytes);
+  } else {
+    for (let i = 0; i < 16; i++) bytes[i] = Math.floor(Math.random() * 256);
+  }
+  bytes[6] = bytes[6] & 15 | 64;
+  bytes[8] = bytes[8] & 63 | 128;
+  const hex = Array.from(bytes, (b) => b.toString(16).padStart(2, "0"));
+  return hex.slice(0, 4).join("") + "-" + hex.slice(4, 6).join("") + "-" + hex.slice(6, 8).join("") + "-" + hex.slice(8, 10).join("") + "-" + hex.slice(10, 16).join("");
+};
+
+// src/types.ts
+var SUPPORTED_LOCALES = [
+  "en",
+  "es",
+  "de",
+  "pt",
+  "ro",
+  "hr",
+  "da",
+  "fi",
+  "fr",
+  "hu",
+  "it",
+  "nb",
+  "pl",
+  "sk",
+  "sv",
+  "nl",
+  "el",
+  "cs",
+  "zh",
+  "ja",
+  "is"
+];
+
+// src/adapters/salesforce/bootstrap.ts
+var DEFAULT_SELECTOR = "script[data-public-key]";
+var getConfigFromScriptTag = (opts = {}) => {
+  const doc = opts.document ?? document;
+  const selector = opts.scriptSelector ?? DEFAULT_SELECTOR;
+  const element = doc.querySelector(selector);
+  if (!element) {
+    throw new Error(
+      `Dataships SDK: unable to locate the Dataships script tag using selector ${selector}`
+    );
+  }
+  const required = (name) => {
+    const value = element.getAttribute(name);
+    if (!value) {
+      throw new Error(
+        `Dataships SDK: Dataships script tag is missing required attribute ${name}`
+      );
+    }
+    return value;
+  };
+  const optional = (name) => {
+    const value = element.getAttribute(name);
+    return value && value.length > 0 ? value : null;
+  };
+  const bool = (name) => (optional(name) ?? "").toLowerCase() === "true";
+  return {
+    publicKey: required("data-public-key"),
+    token: optional("data-token"),
+    // Default to `local` (the local backend) when `data-env` is omitted. Preview
+    // mode is now a separate concern (see `data-preview-mode`), so an env-less
+    // cartridge no longer implies fake data — a real deploy must still set
+    // `data-env` explicitly to reach staging/production.
+    env: optional("data-env") ?? "local",
+    previewMode: bool("data-preview-mode"),
+    storeIdentifier: required("data-store-identifier"),
+    locale: localeFromSfcc(optional("data-locale")),
+    basketUuid: optional("data-basket-uuid"),
+    email: optional("data-email"),
+    phone: optional("data-phone"),
+    orderId: optional("data-order-id"),
+    orderToken: optional("data-order-token")
+  };
+};
+var localeFromSfcc = (raw) => {
+  if (!raw) return "en";
+  const head = raw.split(/[_-]/)[0]?.toLowerCase() ?? "";
+  return SUPPORTED_LOCALES.includes(head) ? head : "en";
+};
+
+// src/session/previewUpsertResponse.ts
+var DEFAULT_EMAIL_OPT_IN_TEXT = "We would like to email you news and promotions. Tick to opt in.";
+var DEFAULT_EMAIL_OPT_IN_CONSENT_DESCRIPTION = "Click here for an overview of how your personal data is processed for marketing purposes or see our Privacy Policy for further information.";
+var DEFAULT_SMS_OPT_IN_TEXT = "We would like to text you news and promotions. Tick to opt in.";
+var DEFAULT_SMS_OPT_IN_CONSENT_DESCRIPTION = "Based on the channel preferences set above, you agree to receive recurring automated marketing messages (e.g. AI content, cart reminders) from {{COMPANY_NAME}} at the number you provide. Consent is not a condition of purchase. We may share info with service providers per our Privacy Policy. Reply STOP to cancel or click the unsubscribe link (where available). For help reply HELP or email {{PRIVACY_EMAIL}}. Msg frequency varies. Msg & data rates may apply. By proceeding, you also agree to our Terms of Service (incl. arbitration) & Privacy Policy.";
+var fakeEmailUpsertResponse = {
+  consentSessionId: "01HQB3QRZVV0737R0R25BTQBGF",
+  consents: [
+    {
+      channel: "EMAIL",
+      consentType: "OPT_IN",
+      checked: false,
+      widgetConfig: {
+        text: DEFAULT_EMAIL_OPT_IN_TEXT,
+        consentDescription: DEFAULT_EMAIL_OPT_IN_CONSENT_DESCRIPTION,
+        marketingInformation: '<h1>Marketing Information</h1>\n<p>We may send you direct marketing communications, product information and promotional offers. You can withdraw your consent at any time. See our <a href="https://dataships.io/privacy-centre">Privacy Policy</a> or contact us at <a href="mailto:privacy@example.com">privacy@example.com</a> for further information.</p>\n',
+        policyURL: "https://dataships.io/privacy-centre",
+        mobileTermsOfServiceURL: null,
+        privacyEmail: "privacy@example.com",
+        placeholderValues: null
+      }
+    }
+  ],
+  userVerificationRequired: null,
+  lastHeartbeat: "2026-06-17T00:00:00Z",
+  identifier: null
+};
+var fakePhoneUpsertResponse = {
+  consentSessionId: "01HQB3QRZVV0737R0R25BTQBGG",
+  consents: [
+    {
+      channel: "SMS",
+      consentType: "OPT_IN",
+      checked: false,
+      widgetConfig: {
+        text: DEFAULT_SMS_OPT_IN_TEXT,
+        consentDescription: DEFAULT_SMS_OPT_IN_CONSENT_DESCRIPTION,
+        marketingInformation: '<h1>Marketing Information</h1>\n<p>We may send you marketing text messages about products and promotional offers. Message frequency varies. You can withdraw your consent at any time by replying STOP. See our <a href="https://dataships.io/privacy-centre">Privacy Policy</a> or contact us at <a href="mailto:privacy@example.com">privacy@example.com</a> for further information.</p>\n',
+        policyURL: "https://dataships.io/privacy-centre",
+        mobileTermsOfServiceURL: "https://dataships.io/mobile-terms",
+        privacyEmail: "privacy@example.com",
+        placeholderValues: null
+      }
+    }
+  ],
+  userVerificationRequired: false,
+  lastHeartbeat: "2026-06-17T00:00:00Z",
+  identifier: null
+};
+var MARKETING_MODAL_HREF = "#dataships-marketing-modal";
+var CHECKBOX_LABEL_BOLD_PHRASES = ["consent", "object", "opt in", "opt out", "STOP", "HELP"];
+var CONSENT_DESCRIPTION_BOLD_PHRASES = ["STOP", "HELP"];
+var escapeHtml = (text) => text.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;");
+var escapeRegExp = (text) => text.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+var wrapPhrase = (html, phrase, wrap) => html.replace(
+  new RegExp(`${escapeRegExp(escapeHtml(phrase))}(?![^<]*>)(?![^<]*</a>)`, "gi"),
+  wrap
+);
+var toHtmlCopy = (text, widgetConfig, boldPhrases) => {
+  let html = escapeHtml(text);
+  const links = [
+    ["Terms of Service", widgetConfig.mobileTermsOfServiceURL],
+    ["Privacy Policy", widgetConfig.policyURL],
+    ["Click here", MARKETING_MODAL_HREF]
+  ];
+  for (const [phrase, href] of links) {
+    if (!href) continue;
+    html = wrapPhrase(html, phrase, (match) => `<a href="${escapeHtml(href)}">${match}</a>`);
+  }
+  for (const phrase of boldPhrases) {
+    html = wrapPhrase(html, phrase, (match) => `<strong>${match}</strong>`);
+  }
+  return `<p>${html}</p>`;
+};
+var withHtmlCopy = (response) => ({
+  ...response,
+  consents: response.consents.map((consent) => {
+    const { widgetConfig } = consent;
+    return {
+      ...consent,
+      widgetConfig: {
+        ...widgetConfig,
+        text: widgetConfig.text === null ? null : toHtmlCopy(widgetConfig.text, widgetConfig, CHECKBOX_LABEL_BOLD_PHRASES),
+        consentDescription: widgetConfig.consentDescription === null ? null : toHtmlCopy(
+          widgetConfig.consentDescription,
+          widgetConfig,
+          CONSENT_DESCRIPTION_BOLD_PHRASES
+        )
+      }
+    };
+  })
+});
+var previewUpsertResponse = (identifierType, format = "json") => {
+  const response = identifierType === "PHONE" ? fakePhoneUpsertResponse : fakeEmailUpsertResponse;
+  return format === "html" ? withHtmlCopy(response) : response;
+};
+
+// src/adapters/salesforce/index.ts
+var DATASHIPS_ORDER_UUID_KEY_PREFIX = "datashipsOrderUuid:";
+var _window, _SalesforceAdapter_instances, resolveCollectionStep_fn, isCheckoutPath_fn, urlParams_fn, getOrSetOrderUuid_fn, orderUuidKey_fn, readStoredOrderUuid_fn, safeLocalStorage_fn;
+var SalesforceAdapter = class {
+  constructor(opts = {}) {
+    __privateAdd(this, _SalesforceAdapter_instances);
+    this.name = "SalesforceAdapter";
+    this.sessionApi = "consent-session";
+    this.integrationType = "SALESFORCE_SNIPPET";
+    __privateAdd(this, _window);
+    __privateSet(this, _window, opts.window ?? globalThis.window);
+    this.config = opts.config ?? getConfigFromScriptTag({ document: opts.document });
+    this.previewMode = this.config.previewMode;
+  }
+  /** Synthetic upsert response served in {@link previewMode}; email-only at launch. */
+  getPreviewUpsertResponse(identifierType = "EMAIL", format) {
+    return previewUpsertResponse(identifierType, format);
+  }
+  getLocale() {
+    return this.config.locale;
+  }
+  getIdentifier(identifierType) {
+    const identifier = "PHONE" === identifierType ? this.config.phone : this.config.email;
+    return { identifier, identifierType };
+  }
+  async getSessionContext() {
+    const params = __privateMethod(this, _SalesforceAdapter_instances, urlParams_fn).call(this);
+    const orderId = this.config.orderId ?? params.get("ID");
+    const orderToken = this.config.orderToken ?? params.get("token");
+    const collectionStep = __privateMethod(this, _SalesforceAdapter_instances, resolveCollectionStep_fn).call(this, orderId, orderToken);
+    const isThankYou = collectionStep === "THANK_YOU";
+    return {
+      collectionStep,
+      datashipsOrderUuid: __privateMethod(this, _SalesforceAdapter_instances, getOrSetOrderUuid_fn).call(this),
+      basketUuid: isThankYou ? null : this.config.basketUuid,
+      orderId: isThankYou ? orderId : null,
+      orderToken: isThankYou ? orderToken : null
+    };
+  }
+};
+_window = new WeakMap();
+_SalesforceAdapter_instances = new WeakSet();
+/**
+ * Decide the collection step from the data the cartridge already renders: an
+ * order id/token means the order is placed (THANK_YOU); otherwise a basket
+ * means we're mid-checkout (CHECKOUT_INFORMATION). Fall back to path-sniffing
+ * only when neither signal is present (e.g. a checkout page before a basket
+ * exists).
+ */
+resolveCollectionStep_fn = function(orderId, orderToken) {
+  if (orderId || orderToken) return "THANK_YOU";
+  if (this.config.basketUuid) return "CHECKOUT_INFORMATION";
+  return __privateMethod(this, _SalesforceAdapter_instances, isCheckoutPath_fn).call(this) ? "CHECKOUT_INFORMATION" : "THANK_YOU";
+};
+isCheckoutPath_fn = function() {
+  const path = __privateGet(this, _window).location.pathname.toLowerCase();
+  if (path.includes("order-confirm")) return false;
+  return path.includes("checkout");
+};
+urlParams_fn = function() {
+  return new URLSearchParams(__privateGet(this, _window).location.search);
+};
+/**
+ * Resolve the datashipsOrderUuid for this page view.
+ *
+ * Lifecycle:
+ *  - On checkout pages where SFCC has a basket: tie the UUID to that basket.
+ *    Same `basketUuid` across visits → reuse the same UUID; new basket → fresh UUID.
+ *  - On the confirmation page (no current basket but a stored entry exists):
+ *    reuse the stored UUID so the THANK_YOU upsert correlates with the
+ *    CHECKOUT_INFORMATION session backend-side.
+ *  - No prior entry and no basket: generate a UUID for this page view only;
+ *    nothing is persisted (we don't know what basket to associate it with). A
+ *    confirmation reached without a stored entry — cleared storage, a different
+ *    device, or a direct landing — therefore emits a fresh, non-correlating
+ *    UUID. This is best-effort correlation by design.
+ *
+ * The localStorage key is scoped by `storeIdentifier` so multi-site SFCC
+ * instances sharing a hostname don't cross-correlate.
+ */
+getOrSetOrderUuid_fn = function() {
+  const storage = __privateMethod(this, _SalesforceAdapter_instances, safeLocalStorage_fn).call(this);
+  const key = __privateMethod(this, _SalesforceAdapter_instances, orderUuidKey_fn).call(this);
+  const currentBasketUuid = this.config.basketUuid;
+  const stored = storage ? __privateMethod(this, _SalesforceAdapter_instances, readStoredOrderUuid_fn).call(this, storage, key) : null;
+  if (stored) {
+    if (null !== currentBasketUuid && stored.basketUuid === currentBasketUuid) {
+      return stored.uuid;
+    }
+    if (null === currentBasketUuid) {
+      return stored.uuid;
+    }
+  }
+  const fresh = randomUuid(__privateGet(this, _window).crypto);
+  if (storage && null !== currentBasketUuid) {
+    try {
+      storage.setItem(
+        key,
+        JSON.stringify({ uuid: fresh, basketUuid: currentBasketUuid })
+      );
+    } catch {
+    }
+  }
+  return fresh;
+};
+orderUuidKey_fn = function() {
+  return `${DATASHIPS_ORDER_UUID_KEY_PREFIX}${this.config.storeIdentifier}`;
+};
+readStoredOrderUuid_fn = function(storage, key) {
+  const raw = storage.getItem(key);
+  if (!raw) return null;
+  try {
+    const parsed = JSON.parse(raw);
+    if (typeof parsed?.uuid !== "string") return null;
+    const basketUuid = typeof parsed.basketUuid === "string" ? parsed.basketUuid : null;
+    return { uuid: parsed.uuid, basketUuid };
+  } catch {
+    return null;
+  }
+};
+safeLocalStorage_fn = function() {
+  try {
+    return __privateGet(this, _window).localStorage;
+  } catch {
+    return null;
+  }
+};
+
+export { SalesforceAdapter, getConfigFromScriptTag };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/adapters/salesforce/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/utils/uuid.ts","../../../src/types.ts","../../../src/adapters/salesforce/bootstrap.ts","../../../src/session/previewUpsertResponse.ts","../../../src/adapters/salesforce/index.ts"],"names":[],"mappings":";;;;;;;;;;AAUO,IAAM,UAAA,GAAa,CACxB,SAAA,GAAgC,UAAA,CAAW,MAAA,KAChC;AACX,EAAA,IAAI,SAAA,IAAa,OAAO,SAAA,CAAU,UAAA,KAAe,UAAA,EAAY;AAC3D,IAAA,OAAO,UAAU,UAAA,EAAW;AAAA,EAC9B;AAEA,EAAA,MAAM,KAAA,GAAQ,IAAI,UAAA,CAAW,EAAE,CAAA;AAC/B,EAAA,IAAI,SAAA,IAAa,OAAO,SAAA,CAAU,eAAA,KAAoB,UAAA,EAAY;AAChE,IAAA,SAAA,CAAU,gBAAgB,KAAK,CAAA;AAAA,EACjC,CAAA,MAAO;AACL,IAAA,KAAA,IAAS,CAAA,GAAI,CAAA,EAAG,CAAA,GAAI,EAAA,EAAI,CAAA,EAAA,EAAK,KAAA,CAAM,CAAC,CAAA,GAAI,IAAA,CAAK,KAAA,CAAM,IAAA,CAAK,MAAA,KAAW,GAAG,CAAA;AAAA,EACxE;AAGA,EAAA,KAAA,CAAM,CAAC,CAAA,GAAK,KAAA,CAAM,CAAC,IAAK,EAAA,GAAQ,EAAA;AAChC,EAAA,KAAA,CAAM,CAAC,CAAA,GAAK,KAAA,CAAM,CAAC,IAAK,EAAA,GAAQ,GAAA;AAEhC,EAAA,MAAM,GAAA,GAAM,KAAA,CAAM,IAAA,CAAK,KAAA,EAAO,CAAA,CAAA,KAAK,CAAA,CAAE,QAAA,CAAS,EAAE,CAAA,CAAE,QAAA,CAAS,CAAA,EAAG,GAAG,CAAC,CAAA;AAClE,EAAA,OACE,IAAI,KAAA,CAAM,CAAA,EAAG,CAAC,CAAA,CAAE,IAAA,CAAK,EAAE,CAAA,GACvB,GAAA,GACA,IAAI,KAAA,CAAM,CAAA,EAAG,CAAC,CAAA,CAAE,IAAA,CAAK,EAAE,CAAA,GACvB,GAAA,GACA,IAAI,KAAA,CAAM,CAAA,EAAG,CAAC,CAAA,CAAE,KAAK,EAAE,CAAA,GACvB,MACA,GAAA,CAAI,KAAA,CAAM,GAAG,EAAE,CAAA,CAAE,KAAK,EAAE,CAAA,GACxB,MACA,GAAA,CAAI,KAAA,CAAM,IAAI,EAAE,CAAA,CAAE,KAAK,EAAE,CAAA;AAE7B,CAAA;;;AC3BO,IAAM,iBAAA,GAAoB;AAAA,EAC/B,IAAA;AAAA,EACA,IAAA;AAAA,EACA,IAAA;AAAA,EACA,IAAA;AAAA,EACA,IAAA;AAAA,EACA,IAAA;AAAA,EACA,IAAA;AAAA,EACA,IAAA;AAAA,EACA,IAAA;AAAA,EACA,IAAA;AAAA,EACA,IAAA;AAAA,EACA,IAAA;AAAA,EACA,IAAA;AAAA,EACA,IAAA;AAAA,EACA,IAAA;AAAA,EACA,IAAA;AAAA,EACA,IAAA;AAAA,EACA,IAAA;AAAA,EACA,IAAA;AAAA,EACA,IAAA;AAAA,EACA;AACF,CAAA;;;ACHA,IAAM,gBAAA,GAAmB,yBAAA;AAsBlB,IAAM,sBAAA,GAAyB,CACpC,IAAA,GAAsC,EAAC,KAClB;AACrB,EAAA,MAAM,GAAA,GAAM,KAAK,QAAA,IAAY,QAAA;AAC7B,EAAA,MAAM,QAAA,GAAW,KAAK,cAAA,IAAkB,gBAAA;AACxC,EAAA,MAAM,OAAA,GAAU,GAAA,CAAI,aAAA,CAAc,QAAQ,CAAA;AAC1C,EAAA,IAAI,CAAC,OAAA,EAAS;AACZ,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,2EAA2E,QAAQ,CAAA;AAAA,KACrF;AAAA,EACF;AAEA,EAAA,MAAM,QAAA,GAAW,CAAC,IAAA,KAAyB;AACzC,IAAA,MAAM,KAAA,GAAQ,OAAA,CAAQ,YAAA,CAAa,IAAI,CAAA;AACvC,IAAA,IAAI,CAAC,KAAA,EAAO;AACV,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,qEAAqE,IAAI,CAAA;AAAA,OAC3E;AAAA,IACF;AACA,IAAA,OAAO,KAAA;AAAA,EACT,CAAA;AAEA,EAAA,MAAM,QAAA,GAAW,CAAC,IAAA,KAAgC;AAChD,IAAA,MAAM,KAAA,GAAQ,OAAA,CAAQ,YAAA,CAAa,IAAI,CAAA;AACvC,IAAA,OAAO,KAAA,IAAS,KAAA,CAAM,MAAA,GAAS,CAAA,GAAI,KAAA,GAAQ,IAAA;AAAA,EAC7C,CAAA;AAIA,EAAA,MAAM,IAAA,GAAO,CAAC,IAAA,KAAA,CACX,QAAA,CAAS,IAAI,CAAA,IAAK,EAAA,EAAI,aAAY,KAAM,MAAA;AAE3C,EAAA,OAAO;AAAA,IACL,SAAA,EAAW,SAAS,iBAAiB,CAAA;AAAA,IACrC,KAAA,EAAO,SAAS,YAAY,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAK5B,GAAA,EAAM,QAAA,CAAS,UAAU,CAAA,IAAK,OAAA;AAAA,IAC9B,WAAA,EAAa,KAAK,mBAAmB,CAAA;AAAA,IACrC,eAAA,EAAiB,SAAS,uBAAuB,CAAA;AAAA,IACjD,MAAA,EAAQ,cAAA,CAAe,QAAA,CAAS,aAAa,CAAC,CAAA;AAAA,IAC9C,UAAA,EAAY,SAAS,kBAAkB,CAAA;AAAA,IACvC,KAAA,EAAO,SAAS,YAAY,CAAA;AAAA,IAC5B,KAAA,EAAO,SAAS,YAAY,CAAA;AAAA,IAC5B,OAAA,EAAS,SAAS,eAAe,CAAA;AAAA,IACjC,UAAA,EAAY,SAAS,kBAAkB;AAAA,GACzC;AACF;AAEA,IAAM,cAAA,GAAiB,CAAC,GAAA,KAAwC;AAC9D,EAAA,IAAI,CAAC,KAAK,OAAO,IAAA;AACjB,EAAA,MAAM,IAAA,GAAO,IAAI,KAAA,CAAM,MAAM,EAAE,CAAC,CAAA,EAAG,aAAY,IAAK,EAAA;AACpD,EAAA,OAAQ,iBAAA,CAAwC,QAAA,CAAS,IAAI,CAAA,GACxD,IAAA,GACD,IAAA;AACN,CAAA;;;AChGA,IAAM,yBAAA,GACJ,iEAAA;AACF,IAAM,wCAAA,GACJ,6IAAA;AACF,IAAM,uBAAA,GACJ,gEAAA;AACF,IAAM,sCAAA,GACJ,yiBAAA;AAaK,IAAM,uBAAA,GAAiD;AAAA,EAC5D,gBAAA,EAAkB,4BAAA;AAAA,EAClB,QAAA,EAAU;AAAA,IACR;AAAA,MACE,OAAA,EAAS,OAAA;AAAA,MACT,WAAA,EAAa,QAAA;AAAA,MACb,OAAA,EAAS,KAAA;AAAA,MACT,YAAA,EAAc;AAAA,QACZ,IAAA,EAAM,yBAAA;AAAA,QACN,kBAAA,EAAoB,wCAAA;AAAA,QACpB,oBAAA,EACE,kWAAA;AAAA,QACF,SAAA,EAAW,qCAAA;AAAA,QACX,uBAAA,EAAyB,IAAA;AAAA,QACzB,YAAA,EAAc,qBAAA;AAAA,QACd,iBAAA,EAAmB;AAAA;AACrB;AACF,GACF;AAAA,EACA,wBAAA,EAA0B,IAAA;AAAA,EAC1B,aAAA,EAAe,sBAAA;AAAA,EACf,UAAA,EAAY;AACd,CAAA;AAQO,IAAM,uBAAA,GAAiD;AAAA,EAC5D,gBAAA,EAAkB,4BAAA;AAAA,EAClB,QAAA,EAAU;AAAA,IACR;AAAA,MACE,OAAA,EAAS,KAAA;AAAA,MACT,WAAA,EAAa,QAAA;AAAA,MACb,OAAA,EAAS,KAAA;AAAA,MACT,YAAA,EAAc;AAAA,QACZ,IAAA,EAAM,uBAAA;AAAA,QACN,kBAAA,EAAoB,sCAAA;AAAA,QACpB,oBAAA,EACE,+XAAA;AAAA,QACF,SAAA,EAAW,qCAAA;AAAA,QACX,uBAAA,EAAyB,mCAAA;AAAA,QACzB,YAAA,EAAc,qBAAA;AAAA,QACd,iBAAA,EAAmB;AAAA;AACrB;AACF,GACF;AAAA,EACA,wBAAA,EAA0B,KAAA;AAAA,EAC1B,aAAA,EAAe,sBAAA;AAAA,EACf,UAAA,EAAY;AACd,CAAA;AAIA,IAAM,oBAAA,GAAuB,4BAAA;AAC7B,IAAM,8BAA8B,CAAC,SAAA,EAAW,UAAU,QAAA,EAAU,SAAA,EAAW,QAAQ,MAAM,CAAA;AAC7F,IAAM,gCAAA,GAAmC,CAAC,MAAA,EAAQ,MAAM,CAAA;AAExD,IAAM,aAAa,CAAC,IAAA,KAClB,KACG,OAAA,CAAQ,IAAA,EAAM,OAAO,CAAA,CACrB,OAAA,CAAQ,IAAA,EAAM,MAAM,EACpB,OAAA,CAAQ,IAAA,EAAM,MAAM,CAAA,CACpB,OAAA,CAAQ,MAAM,QAAQ,CAAA;AAE3B,IAAM,eAAe,CAAC,IAAA,KAAyB,IAAA,CAAK,OAAA,CAAQ,uBAAuB,MAAM,CAAA;AAGzF,IAAM,UAAA,GAAa,CAAC,IAAA,EAAc,MAAA,EAAgB,SAChD,IAAA,CAAK,OAAA;AAAA,EACH,IAAI,OAAO,CAAA,EAAG,YAAA,CAAa,WAAW,MAAM,CAAC,CAAC,CAAA,uBAAA,CAAA,EAA2B,IAAI,CAAA;AAAA,EAC7E;AACF,CAAA;AAEF,IAAM,UAAA,GAAa,CACjB,IAAA,EACA,YAAA,EACA,WAAA,KACW;AACX,EAAA,IAAI,IAAA,GAAO,WAAW,IAAI,CAAA;AAE1B,EAAA,MAAM,KAAA,GAAwC;AAAA,IAC5C,CAAC,kBAAA,EAAoB,YAAA,CAAa,uBAAuB,CAAA;AAAA,IACzD,CAAC,gBAAA,EAAkB,YAAA,CAAa,SAAS,CAAA;AAAA,IACzC,CAAC,cAAc,oBAAoB;AAAA,GACrC;AACA,EAAA,KAAA,MAAW,CAAC,MAAA,EAAQ,IAAI,CAAA,IAAK,KAAA,EAAO;AAClC,IAAA,IAAI,CAAC,IAAA,EAAM;AACX,IAAA,IAAA,GAAO,UAAA,CAAW,IAAA,EAAM,MAAA,EAAQ,CAAA,KAAA,KAAS,CAAA,SAAA,EAAY,WAAW,IAAI,CAAC,CAAA,EAAA,EAAK,KAAK,CAAA,IAAA,CAAM,CAAA;AAAA,EACvF;AAEA,EAAA,KAAA,MAAW,UAAU,WAAA,EAAa;AAChC,IAAA,IAAA,GAAO,WAAW,IAAA,EAAM,MAAA,EAAQ,CAAA,KAAA,KAAS,CAAA,QAAA,EAAW,KAAK,CAAA,SAAA,CAAW,CAAA;AAAA,EACtE;AAEA,EAAA,OAAO,MAAM,IAAI,CAAA,IAAA,CAAA;AACnB,CAAA;AAGA,IAAM,YAAA,GAAe,CAAC,QAAA,MAA4D;AAAA,EAChF,GAAG,QAAA;AAAA,EACH,QAAA,EAAU,QAAA,CAAS,QAAA,CAAS,GAAA,CAAI,CAAA,OAAA,KAAW;AACzC,IAAA,MAAM,EAAE,cAAa,GAAI,OAAA;AACzB,IAAA,OAAO;AAAA,MACL,GAAG,OAAA;AAAA,MACH,YAAA,EAAc;AAAA,QACZ,GAAG,YAAA;AAAA,QACH,IAAA,EACE,aAAa,IAAA,KAAS,IAAA,GAClB,OACA,UAAA,CAAW,YAAA,CAAa,IAAA,EAAM,YAAA,EAAc,2BAA2B,CAAA;AAAA,QAC7E,kBAAA,EACE,YAAA,CAAa,kBAAA,KAAuB,IAAA,GAChC,IAAA,GACA,UAAA;AAAA,UACE,YAAA,CAAa,kBAAA;AAAA,UACb,YAAA;AAAA,UACA;AAAA;AACF;AACR,KACF;AAAA,EACF,CAAC;AACH,CAAA,CAAA;AAOO,IAAM,qBAAA,GAAwB,CACnC,cAAA,EACA,MAAA,GAA4B,MAAA,KACF;AAC1B,EAAA,MAAM,QAAA,GACJ,cAAA,KAAmB,OAAA,GAAU,uBAAA,GAA0B,uBAAA;AAEzD,EAAA,OAAO,MAAA,KAAW,MAAA,GAAS,YAAA,CAAa,QAAQ,CAAA,GAAI,QAAA;AACtD,CAAA;;;ACjJA,IAAM,+BAAA,GAAkC,qBAAA;AA7BxC,IAAA,OAAA,EAAA,4BAAA,EAAA,wBAAA,EAAA,iBAAA,EAAA,YAAA,EAAA,oBAAA,EAAA,eAAA,EAAA,sBAAA,EAAA,mBAAA;AAoCO,IAAM,oBAAN,MAEP;AAAA,EAkBE,WAAA,CAAY,IAAA,GAAiC,EAAC,EAAG;AApB5C,IAAA,YAAA,CAAA,IAAA,EAAA,4BAAA,CAAA;AAGL,IAAA,IAAA,CAAS,IAAA,GAAe,mBAAA;AACxB,IAAA,IAAA,CAAS,UAAA,GAAa,iBAAA;AACtB,IAAA,IAAA,CAAS,eAAA,GAAkB,oBAAA;AAa3B,IAAA,YAAA,CAAA,IAAA,EAAA,OAAA,CAAA;AAGE,IAAA,YAAA,CAAA,IAAA,EAAK,OAAA,EAAU,IAAA,CAAK,MAAA,IAAU,UAAA,CAAW,MAAA,CAAA;AACzC,IAAA,IAAA,CAAK,MAAA,GACH,KAAK,MAAA,IAAU,sBAAA,CAAuB,EAAE,QAAA,EAAU,IAAA,CAAK,UAAU,CAAA;AACnE,IAAA,IAAA,CAAK,WAAA,GAAc,KAAK,MAAA,CAAO,WAAA;AAAA,EACjC;AAAA;AAAA,EAGA,wBAAA,CACE,cAAA,GAAiC,OAAA,EACjC,MAAA,EACuB;AACvB,IAAA,OAAO,qBAAA,CAAsB,gBAAgB,MAAM,CAAA;AAAA,EACrD;AAAA,EAGA,SAAA,GAA6B;AAC3B,IAAA,OAAO,KAAK,MAAA,CAAO,MAAA;AAAA,EACrB;AAAA,EAEA,cAAc,cAAA,EAA0D;AAKtE,IAAA,MAAM,aACJ,OAAA,KAAY,cAAA,GAAiB,KAAK,MAAA,CAAO,KAAA,GAAQ,KAAK,MAAA,CAAO,KAAA;AAC/D,IAAA,OAAO,EAAE,YAAY,cAAA,EAAe;AAAA,EACtC;AAAA,EAEA,MAAM,iBAAA,GAAuD;AAC3D,IAAA,MAAM,MAAA,GAAS,sBAAK,4BAAA,EAAA,YAAA,CAAA,CAAL,IAAA,CAAA,IAAA,CAAA;AACf,IAAA,MAAM,UAAU,IAAA,CAAK,MAAA,CAAO,OAAA,IAAW,MAAA,CAAO,IAAI,IAAI,CAAA;AACtD,IAAA,MAAM,aAAa,IAAA,CAAK,MAAA,CAAO,UAAA,IAAc,MAAA,CAAO,IAAI,OAAO,CAAA;AAE/D,IAAA,MAAM,cAAA,GAAiB,eAAA,CAAA,IAAA,EAAK,4BAAA,EAAA,wBAAA,CAAA,CAAL,IAAA,CAAA,IAAA,EAA4B,OAAA,EAAS,UAAA,CAAA;AAC5D,IAAA,MAAM,aAAa,cAAA,KAAmB,WAAA;AAEtC,IAAA,OAAO;AAAA,MACL,cAAA;AAAA,MACA,kBAAA,EAAoB,sBAAK,4BAAA,EAAA,oBAAA,CAAA,CAAL,IAAA,CAAA,IAAA,CAAA;AAAA,MACpB,UAAA,EAAY,UAAA,GAAa,IAAA,GAAO,IAAA,CAAK,MAAA,CAAO,UAAA;AAAA,MAC5C,OAAA,EAAS,aAAa,OAAA,GAAU,IAAA;AAAA,MAChC,UAAA,EAAY,aAAa,UAAA,GAAa;AAAA,KACxC;AAAA,EACF;AAwGF;AAvJE,OAAA,GAAA,IAAA,OAAA,EAAA;AAlBK,4BAAA,GAAA,IAAA,OAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AA0EL,wBAAA,GAAsB,SACpB,SACA,UAAA,EAC0B;AAC1B,EAAA,IAAI,OAAA,IAAW,YAAY,OAAO,WAAA;AAClC,EAAA,IAAI,IAAA,CAAK,MAAA,CAAO,UAAA,EAAY,OAAO,sBAAA;AACnC,EAAA,OAAO,eAAA,CAAA,IAAA,EAAK,4BAAA,EAAA,iBAAA,CAAA,CAAL,IAAA,CAAA,IAAA,CAAA,GAAyB,sBAAA,GAAyB,WAAA;AAC3D,CAAA;AAEA,iBAAA,GAAe,WAAY;AACzB,EAAA,MAAM,IAAA,GAAO,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA,CAAQ,QAAA,CAAS,SAAS,WAAA,EAAY;AACxD,EAAA,IAAI,IAAA,CAAK,QAAA,CAAS,eAAe,CAAA,EAAG,OAAO,KAAA;AAC3C,EAAA,OAAO,IAAA,CAAK,SAAS,UAAU,CAAA;AACjC,CAAA;AAEA,YAAA,GAAU,WAAoB;AAC5B,EAAA,OAAO,IAAI,eAAA,CAAgB,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA,CAAQ,SAAS,MAAM,CAAA;AACzD,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAoBA,oBAAA,GAAkB,WAAW;AAC3B,EAAA,MAAM,OAAA,GAAU,sBAAK,4BAAA,EAAA,mBAAA,CAAA,CAAL,IAAA,CAAA,IAAA,CAAA;AAChB,EAAA,MAAM,GAAA,GAAM,sBAAK,4BAAA,EAAA,eAAA,CAAA,CAAL,IAAA,CAAA,IAAA,CAAA;AACZ,EAAA,MAAM,iBAAA,GAAoB,KAAK,MAAA,CAAO,UAAA;AAEtC,EAAA,MAAM,SAAS,OAAA,GAAU,eAAA,CAAA,IAAA,EAAK,4BAAA,EAAA,sBAAA,CAAA,CAAL,IAAA,CAAA,IAAA,EAA0B,SAAS,GAAA,CAAA,GAAO,IAAA;AAEnE,EAAA,IAAI,MAAA,EAAQ;AACV,IAAA,IACE,IAAA,KAAS,iBAAA,IACT,MAAA,CAAO,UAAA,KAAe,iBAAA,EACtB;AACA,MAAA,OAAO,MAAA,CAAO,IAAA;AAAA,IAChB;AACA,IAAA,IAAI,SAAS,iBAAA,EAAmB;AAC9B,MAAA,OAAO,MAAA,CAAO,IAAA;AAAA,IAChB;AAAA,EACF;AAEA,EAAA,MAAM,KAAA,GAAQ,UAAA,CAAW,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA,CAAQ,MAAM,CAAA;AAC5C,EAAA,IAAI,OAAA,IAAW,SAAS,iBAAA,EAAmB;AACzC,IAAA,IAAI;AACF,MAAA,OAAA,CAAQ,OAAA;AAAA,QACN,GAAA;AAAA,QACA,KAAK,SAAA,CAAU,EAAE,MAAM,KAAA,EAAO,UAAA,EAAY,mBAAmB;AAAA,OAC/D;AAAA,IACF,CAAA,CAAA,MAAQ;AAAA,IAER;AAAA,EACF;AACA,EAAA,OAAO,KAAA;AACT,CAAA;AAEA,eAAA,GAAa,WAAW;AACtB,EAAA,OAAO,CAAA,EAAG,+BAA+B,CAAA,EAAG,IAAA,CAAK,OAAO,eAAe,CAAA,CAAA;AACzE,CAAA;AAEA,sBAAA,GAAoB,SAAC,SAAkB,GAAA,EAAqC;AAC1E,EAAA,MAAM,GAAA,GAAM,OAAA,CAAQ,OAAA,CAAQ,GAAG,CAAA;AAC/B,EAAA,IAAI,CAAC,KAAK,OAAO,IAAA;AACjB,EAAA,IAAI;AACF,IAAA,MAAM,MAAA,GAAS,IAAA,CAAK,KAAA,CAAM,GAAG,CAAA;AAC7B,IAAA,IAAI,OAAO,MAAA,EAAQ,IAAA,KAAS,QAAA,EAAU,OAAO,IAAA;AAC7C,IAAA,MAAM,aACJ,OAAO,MAAA,CAAO,UAAA,KAAe,QAAA,GAAW,OAAO,UAAA,GAAa,IAAA;AAC9D,IAAA,OAAO,EAAE,IAAA,EAAM,MAAA,CAAO,IAAA,EAAM,UAAA,EAAW;AAAA,EACzC,CAAA,CAAA,MAAQ;AACN,IAAA,OAAO,IAAA;AAAA,EACT;AACF,CAAA;AAEA,mBAAA,GAAiB,WAAmB;AAClC,EAAA,IAAI;AACF,IAAA,OAAO,mBAAK,OAAA,CAAA,CAAQ,YAAA;AAAA,EACtB,CAAA,CAAA,MAAQ;AACN,IAAA,OAAO,IAAA;AAAA,EACT;AACF,CAAA","file":"index.js"}

package/dist/adapters/shopify-checkout/index.d.ts

@@ -0,0 +1,102 @@
+import { C as ConsentSessionAdapter, I as IdentifierType, a as ConsentCopyFormat, U as UpsertSessionResponse, S as SupportedLocale, b as ConsentSessionIdentifier } from '../../types-vPJjFMJw.js';
+export { c as coerceLocale } from '../../locale-B1o0kX7n.js';
+
+/**
+ * Where in the Shopify checkout the extension renders. Mirrors core-api's
+ * `WidgetType` as accepted by the `SHOPIFY_CHECKOUT` integration:
+ *
+ * - `CHECKOUT_INFORMATION` — the contact / delivery step, before purchase.
+ * - `THANK_YOU` — the order confirmation page right after purchase.
+ */
+type ShopifyCheckoutCollectionStep = "CHECKOUT_INFORMATION" | "THANK_YOU";
+/**
+ * Checkout facts the extension reads from the Shopify checkout API and that
+ * can change while the buyer is on the page (a wallet picked, the order id
+ * appearing on the thank-you page). Absent values are not sent.
+ */
+interface ShopifyCheckoutDetails {
+    /** The order id, once the order exists (thank-you page). */
+    orderId?: string | null;
+    /** `shopify.checkoutToken`. */
+    checkoutToken?: string | null;
+    /** Whether the buyer paid with an accelerated / express wallet. */
+    isAcceleratedPayment?: boolean | null;
+    /** The wallet's name, e.g. `shop_pay`, `apple_pay`. */
+    wallet?: string | null;
+}
+/**
+ * Integration-specific fields the Shopify checkout adapter contributes to the
+ * consent-session envelope, merged under `integration`. The client injects
+ * `type: "SHOPIFY_CHECKOUT"`; the identifier and `locale` travel at the top
+ * level; the shop is identified by the `X-Api-Key` header and the Shopify
+ * session token, never by the body.
+ *
+ * `datashipsOrderUuid` ties the email and SMS extensions and the thank-you page
+ * of one checkout together (the extension stores it as a cart attribute). It
+ * is optional: core-api needs one of it, `checkoutToken` or `orderId`.
+ */
+interface ShopifyCheckoutSessionContext extends ShopifyCheckoutDetails {
+    collectionStep: ShopifyCheckoutCollectionStep;
+    datashipsOrderUuid?: string;
+}
+
+/** `integration.type` discriminator core-api routes to the Shopify checkout lifecycle. */
+declare const SHOPIFY_CHECKOUT_INTEGRATION_TYPE = "SHOPIFY_CHECKOUT";
+
+interface ShopifyCheckoutAdapterOptions extends ShopifyCheckoutDetails {
+    /** Which checkout surface the extension renders on. Change it later with {@link ShopifyCheckoutAdapter.setCollectionStep}. */
+    collectionStep: ShopifyCheckoutCollectionStep;
+    /** The checkout's Dataships order UUID (the extension's cart attribute), when it has one. */
+    datashipsOrderUuid?: string | null;
+    /**
+     * The buyer's language, e.g. `shopify.localization.language.isoCode`. Any
+     * BCP 47 / POSIX style string is accepted; the first segment is used when it
+     * maps to a {@link SupportedLocale}, otherwise `"en"`.
+     */
+    locale?: string;
+    /** Buyer email already known to the checkout. */
+    email?: string | null;
+    /** Buyer E.164 phone already known to the checkout. */
+    phone?: string | null;
+    /**
+     * When true the client never calls the API and serves synthetic email data
+     * instead. Defaults to false.
+     */
+    previewMode?: boolean;
+}
+/**
+ * Consent-session adapter for the Shopify checkout UI extensions. Drives the
+ * `SHOPIFY_CHECKOUT` upsert type on `POST /v1/consent-session`.
+ *
+ * Has no DOM or `window` dependency: checkout UI extensions run in a sandboxed
+ * worker, so every input comes from the Shopify checkout API through the
+ * options and setters. Pair it with `auth: { publicKey, getToken: () =>
+ * shopify.sessionToken.get() }` so each request carries a fresh session token.
+ */
+declare class ShopifyCheckoutAdapter implements ConsentSessionAdapter<ShopifyCheckoutSessionContext> {
+    #private;
+    readonly name: string;
+    readonly sessionApi: "consent-session";
+    readonly integrationType = "SHOPIFY_CHECKOUT";
+    readonly previewMode: boolean;
+    constructor(opts: ShopifyCheckoutAdapterOptions);
+    /** Synthetic upsert response served in {@link previewMode}, matching the requested identifier type. */
+    getPreviewUpsertResponse(identifierType?: IdentifierType, format?: ConsentCopyFormat): UpsertSessionResponse;
+    getLocale(): SupportedLocale;
+    setLocale(locale: string | null | undefined): void;
+    get collectionStep(): ShopifyCheckoutCollectionStep;
+    setCollectionStep(step: ShopifyCheckoutCollectionStep): void;
+    get datashipsOrderUuid(): string | null;
+    /** Merge checkout facts that changed since construction; an explicit `undefined` clears a field. */
+    setCheckoutDetails(details: ShopifyCheckoutDetails): void;
+    /**
+     * Remember an identifier the buyer typed so later calls (a refresh, a
+     * remount) resolve it without the caller passing it again. An explicit
+     * `upsertSession({ identifier })` still takes precedence.
+     */
+    setIdentifier(identifierType: IdentifierType, value: string | null): void;
+    getIdentifier(identifierType: IdentifierType): ConsentSessionIdentifier;
+    getSessionContext(): Promise<ShopifyCheckoutSessionContext>;
+}
+
+export { SHOPIFY_CHECKOUT_INTEGRATION_TYPE, ShopifyCheckoutAdapter, type ShopifyCheckoutAdapterOptions, type ShopifyCheckoutCollectionStep, type ShopifyCheckoutDetails, type ShopifyCheckoutSessionContext };