@dataships/sdk 0.0.0-stage → 2.0.1

package/dist/adapters/custom-platform-signup/index.js

@@ -0,0 +1,338 @@
+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/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/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/adapters/beacon.ts
+var DATASHIPS_SESSION_ID_MAX_LENGTH = 100;
+var _explicitId, _storageKey, _window, _id, _SessionBeacon_instances, safeStorage_fn;
+var SessionBeacon = class {
+  constructor(opts) {
+    __privateAdd(this, _SessionBeacon_instances);
+    __privateAdd(this, _explicitId);
+    __privateAdd(this, _storageKey);
+    __privateAdd(this, _window);
+    __privateAdd(this, _id, null);
+    if (opts.explicitId != null) assertSessionId(opts.explicitId);
+    __privateSet(this, _explicitId, opts.explicitId ?? null);
+    __privateSet(this, _storageKey, opts.storageKey);
+    __privateSet(this, _window, opts.window ?? globalThis.window);
+  }
+  /**
+   * The beacon for this page. On first use a stored id is reused when
+   * `reusable(stored)` says so, otherwise a fresh UUID is minted; the record is
+   * rewritten with `step` every time so the next page knows where it was last
+   * used. Later calls return the same id for the adapter's lifetime.
+   */
+  resolve(step, reusable) {
+    if (__privateGet(this, _explicitId)) return __privateGet(this, _explicitId);
+    const storage = __privateMethod(this, _SessionBeacon_instances, safeStorage_fn).call(this);
+    if (null === __privateGet(this, _id)) {
+      const stored = storage ? readStored(storage, __privateGet(this, _storageKey)) : null;
+      __privateSet(this, _id, stored && reusable(stored) ? stored.id : randomUuid(__privateGet(this, _window)?.crypto));
+    }
+    if (storage) {
+      try {
+        storage.setItem(__privateGet(this, _storageKey), JSON.stringify({ id: __privateGet(this, _id), lastStep: step }));
+      } catch {
+      }
+    }
+    return __privateGet(this, _id);
+  }
+  /** Discard the beacon so the next {@link resolve} mints a fresh one. No-op for an integrator-owned id. */
+  reset() {
+    if (__privateGet(this, _explicitId)) return;
+    __privateSet(this, _id, null);
+    const storage = __privateMethod(this, _SessionBeacon_instances, safeStorage_fn).call(this);
+    if (!storage) return;
+    try {
+      storage.removeItem(__privateGet(this, _storageKey));
+    } catch {
+    }
+  }
+};
+_explicitId = new WeakMap();
+_storageKey = new WeakMap();
+_window = new WeakMap();
+_id = new WeakMap();
+_SessionBeacon_instances = new WeakSet();
+safeStorage_fn = function() {
+  try {
+    return __privateGet(this, _window)?.localStorage ?? null;
+  } catch {
+    return null;
+  }
+};
+var assertSessionId = (id) => {
+  if (typeof id !== "string" || id.length === 0) {
+    throw new Error("datashipsSessionId must be a non-empty string");
+  }
+  if (id.length > DATASHIPS_SESSION_ID_MAX_LENGTH) {
+    throw new Error(
+      `datashipsSessionId must be at most ${DATASHIPS_SESSION_ID_MAX_LENGTH} characters`
+    );
+  }
+};
+var readStored = (storage, key) => {
+  let raw;
+  try {
+    raw = storage.getItem(key);
+  } catch {
+    return null;
+  }
+  if (!raw) return null;
+  try {
+    const parsed = JSON.parse(raw);
+    if (typeof parsed?.id !== "string" || parsed.id.length === 0) return null;
+    return { id: parsed.id, lastStep: typeof parsed.lastStep === "string" ? parsed.lastStep : null };
+  } catch {
+    return null;
+  }
+};
+
+// 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/locale.ts
+var coerceLocale = (raw) => {
+  if (!raw) return "en";
+  const head = raw.split(/[_-]/)[0]?.toLowerCase() ?? "";
+  return SUPPORTED_LOCALES.includes(head) ? head : "en";
+};
+
+// src/adapters/custom-platform-signup/index.ts
+var CUSTOM_PLATFORM_SIGNUP_INTEGRATION_TYPE = "CUSTOM_PLATFORM_SIGNUP";
+var STORAGE_KEY_PREFIX = "datashipsSignupSessionId:";
+var DEFAULT_STORAGE_SCOPE = "default";
+var _locale, _user, _identifiers, _storageScope, _beacon;
+var CustomPlatformSignupAdapter = class {
+  constructor(opts = {}) {
+    this.name = "CustomPlatformSignupAdapter";
+    this.sessionApi = "consent-session";
+    this.integrationType = CUSTOM_PLATFORM_SIGNUP_INTEGRATION_TYPE;
+    __privateAdd(this, _locale);
+    __privateAdd(this, _user);
+    __privateAdd(this, _identifiers, {});
+    __privateAdd(this, _storageScope);
+    __privateAdd(this, _beacon);
+    __privateSet(this, _locale, coerceLocale(opts.locale));
+    __privateSet(this, _user, opts.user ?? {});
+    __privateSet(this, _storageScope, opts.storageScope ?? DEFAULT_STORAGE_SCOPE);
+    try {
+      __privateSet(this, _beacon, new SessionBeacon({
+        explicitId: opts.datashipsSessionId,
+        storageKey: `${STORAGE_KEY_PREFIX}${__privateGet(this, _storageScope)}`,
+        window: opts.window
+      }));
+    } catch (e) {
+      throw new Error(`CustomPlatformSignupAdapter: ${e.message}`);
+    }
+    this.previewMode = opts.previewMode ?? false;
+  }
+  /** Synthetic upsert response served in {@link previewMode}, matching the requested identifier type. */
+  getPreviewUpsertResponse(identifierType = "EMAIL", format) {
+    return previewUpsertResponse(identifierType, format);
+  }
+  getLocale() {
+    return __privateGet(this, _locale);
+  }
+  /** Change the envelope locale, e.g. when the visitor switches language on the form. */
+  setLocale(locale) {
+    __privateSet(this, _locale, coerceLocale(locale));
+  }
+  /**
+   * Remember an identifier the visitor typed so later calls resolve it without
+   * the user resolver. Pass null to fall back to the resolver again. An
+   * explicit `upsertSession({ identifier })` still takes precedence.
+   */
+  setIdentifier(identifierType, value) {
+    if (value === null) delete __privateGet(this, _identifiers)[identifierType];
+    else __privateGet(this, _identifiers)[identifierType] = value;
+  }
+  async getIdentifier(identifierType) {
+    const pinned = __privateGet(this, _identifiers)[identifierType];
+    if (pinned !== void 0) return { identifier: normalise(pinned), identifierType };
+    const user = await this.getUser();
+    const identifier = "PHONE" === identifierType ? user.phone : user.email;
+    return { identifier: normalise(identifier), identifierType };
+  }
+  /** The user as the merchant's form or backend knows them right now, names and contacts trimmed. */
+  async getUser() {
+    const raw = typeof __privateGet(this, _user) === "function" ? await __privateGet(this, _user).call(this) : __privateGet(this, _user);
+    return {
+      firstName: normalise(raw.firstName),
+      lastName: normalise(raw.lastName),
+      email: normalise(raw.email),
+      phone: normalise(raw.phone)
+    };
+  }
+  /** The beacon this form fill is known by; resolved (and persisted) on first use. */
+  getDatashipsSessionId() {
+    return __privateGet(this, _beacon).resolve(null, () => true);
+  }
+  /**
+   * Discard the current beacon so the next call mints a fresh one. Call it once
+   * the form has been submitted, so a second signup on this browser opens a new
+   * session instead of touching the completed one. No-op for an
+   * integrator-owned id.
+   */
+  resetDatashipsSessionId() {
+    __privateGet(this, _beacon).reset();
+  }
+  async getSessionContext() {
+    return { datashipsSessionId: this.getDatashipsSessionId() };
+  }
+};
+_locale = new WeakMap();
+_user = new WeakMap();
+_identifiers = new WeakMap();
+_storageScope = new WeakMap();
+_beacon = new WeakMap();
+var normalise = (value) => {
+  const trimmed = value?.trim();
+  return trimmed ? trimmed : null;
+};
+
+export { CUSTOM_PLATFORM_SIGNUP_INTEGRATION_TYPE, CustomPlatformSignupAdapter, DATASHIPS_SESSION_ID_MAX_LENGTH, coerceLocale };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/adapters/custom-platform-signup/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/session/previewUpsertResponse.ts","../../../src/utils/uuid.ts","../../../src/adapters/beacon.ts","../../../src/types.ts","../../../src/adapters/locale.ts","../../../src/adapters/custom-platform-signup/index.ts"],"names":[],"mappings":";;;;;;;;;;AAeA,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;;;ACpKO,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;;;ACrCO,IAAM,+BAAA,GAAkC;AAH/C,IAAA,WAAA,EAAA,WAAA,EAAA,OAAA,EAAA,GAAA,EAAA,wBAAA,EAAA,cAAA;AA+BO,IAAM,gBAAN,MAAoB;AAAA,EAMzB,YAAY,IAAA,EAA4B;AANnC,IAAA,YAAA,CAAA,IAAA,EAAA,wBAAA,CAAA;AACL,IAAA,YAAA,CAAA,IAAA,EAAS,WAAA,CAAA;AACT,IAAA,YAAA,CAAA,IAAA,EAAS,WAAA,CAAA;AACT,IAAA,YAAA,CAAA,IAAA,EAAS,OAAA,CAAA;AACT,IAAA,YAAA,CAAA,IAAA,EAAA,GAAA,EAAqB,IAAA,CAAA;AAGnB,IAAA,IAAI,IAAA,CAAK,UAAA,IAAc,IAAA,EAAM,eAAA,CAAgB,KAAK,UAAU,CAAA;AAC5D,IAAA,YAAA,CAAA,IAAA,EAAK,WAAA,EAAc,KAAK,UAAA,IAAc,IAAA,CAAA;AACtC,IAAA,YAAA,CAAA,IAAA,EAAK,aAAc,IAAA,CAAK,UAAA,CAAA;AACxB,IAAA,YAAA,CAAA,IAAA,EAAK,OAAA,EAAU,IAAA,CAAK,MAAA,IAAU,UAAA,CAAW,MAAA,CAAA;AAAA,EAC3C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,OAAA,CAAQ,MAAqB,QAAA,EAAqD;AAChF,IAAA,IAAI,YAAA,CAAA,IAAA,EAAK,WAAA,CAAA,EAAa,OAAO,YAAA,CAAA,IAAA,EAAK,WAAA,CAAA;AAElC,IAAA,MAAM,OAAA,GAAU,sBAAK,wBAAA,EAAA,cAAA,CAAA,CAAL,IAAA,CAAA,IAAA,CAAA;AAChB,IAAA,IAAI,IAAA,KAAS,mBAAK,GAAA,CAAA,EAAK;AACrB,MAAA,MAAM,SAAS,OAAA,GAAU,UAAA,CAAW,OAAA,EAAS,YAAA,CAAA,IAAA,EAAK,YAAW,CAAA,GAAI,IAAA;AACjE,MAAA,YAAA,CAAA,IAAA,EAAK,GAAA,EAAM,MAAA,IAAU,QAAA,CAAS,MAAM,CAAA,GAAI,OAAO,EAAA,GAAK,UAAA,CAAW,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA,EAAS,MAAM,CAAA,CAAA;AAAA,IACrF;AACA,IAAA,IAAI,OAAA,EAAS;AACX,MAAA,IAAI;AACF,QAAA,OAAA,CAAQ,OAAA,CAAQ,YAAA,CAAA,IAAA,EAAK,WAAA,CAAA,EAAa,IAAA,CAAK,SAAA,CAAU,EAAE,EAAA,EAAI,YAAA,CAAA,IAAA,EAAK,GAAA,CAAA,EAAK,QAAA,EAAU,IAAA,EAAM,CAAC,CAAA;AAAA,MACpF,CAAA,CAAA,MAAQ;AAAA,MAER;AAAA,IACF;AACA,IAAA,OAAO,YAAA,CAAA,IAAA,EAAK,GAAA,CAAA;AAAA,EACd;AAAA;AAAA,EAGA,KAAA,GAAc;AACZ,IAAA,IAAI,mBAAK,WAAA,CAAA,EAAa;AACtB,IAAA,YAAA,CAAA,IAAA,EAAK,GAAA,EAAM,IAAA,CAAA;AACX,IAAA,MAAM,OAAA,GAAU,sBAAK,wBAAA,EAAA,cAAA,CAAA,CAAL,IAAA,CAAA,IAAA,CAAA;AAChB,IAAA,IAAI,CAAC,OAAA,EAAS;AACd,IAAA,IAAI;AACF,MAAA,OAAA,CAAQ,UAAA,CAAW,mBAAK,WAAA,CAAW,CAAA;AAAA,IACrC,CAAA,CAAA,MAAQ;AAAA,IAER;AAAA,EACF;AASF,CAAA;AAxDW,WAAA,GAAA,IAAA,OAAA,EAAA;AACA,WAAA,GAAA,IAAA,OAAA,EAAA;AACA,OAAA,GAAA,IAAA,OAAA,EAAA;AACT,GAAA,GAAA,IAAA,OAAA,EAAA;AAJK,wBAAA,GAAA,IAAA,OAAA,EAAA;AAkDL,cAAA,GAAY,WAAmB;AAC7B,EAAA,IAAI;AACF,IAAA,OAAO,YAAA,CAAA,IAAA,EAAK,UAAS,YAAA,IAAgB,IAAA;AAAA,EACvC,CAAA,CAAA,MAAQ;AACN,IAAA,OAAO,IAAA;AAAA,EACT;AACF,CAAA;AAGK,IAAM,eAAA,GAAkB,CAAC,EAAA,KAAqB;AACnD,EAAA,IAAI,OAAO,EAAA,KAAO,QAAA,IAAY,EAAA,CAAG,WAAW,CAAA,EAAG;AAC7C,IAAA,MAAM,IAAI,MAAM,+CAA+C,CAAA;AAAA,EACjE;AACA,EAAA,IAAI,EAAA,CAAG,SAAS,+BAAA,EAAiC;AAC/C,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,sCAAsC,+BAA+B,CAAA,WAAA;AAAA,KACvE;AAAA,EACF;AACF,CAAA;AAEA,IAAM,UAAA,GAAa,CAAC,OAAA,EAAkB,GAAA,KAAqC;AACzE,EAAA,IAAI,GAAA;AACJ,EAAA,IAAI;AACF,IAAA,GAAA,GAAM,OAAA,CAAQ,QAAQ,GAAG,CAAA;AAAA,EAC3B,CAAA,CAAA,MAAQ;AACN,IAAA,OAAO,IAAA;AAAA,EACT;AACA,EAAA,IAAI,CAAC,KAAK,OAAO,IAAA;AACjB,EAAA,IAAI;AACF,IAAA,MAAM,MAAA,GAAS,IAAA,CAAK,KAAA,CAAM,GAAG,CAAA;AAC7B,IAAA,IAAI,OAAO,QAAQ,EAAA,KAAO,QAAA,IAAY,OAAO,EAAA,CAAG,MAAA,KAAW,GAAG,OAAO,IAAA;AACrE,IAAA,OAAO,EAAE,EAAA,EAAI,MAAA,CAAO,EAAA,EAAI,QAAA,EAAU,OAAO,MAAA,CAAO,QAAA,KAAa,QAAA,GAAW,MAAA,CAAO,QAAA,GAAW,IAAA,EAAK;AAAA,EACjG,CAAA,CAAA,MAAQ;AACN,IAAA,OAAO,IAAA;AAAA,EACT;AACF,CAAA;;;ACvGO,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;;;AC5BO,IAAM,YAAA,GAAe,CAAC,GAAA,KAAoD;AAC/E,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;;;ACIO,IAAM,uCAAA,GAA0C;AAMvD,IAAM,kBAAA,GAAqB,2BAAA;AAC3B,IAAM,qBAAA,GAAwB,SAAA;AAxB9B,IAAA,OAAA,EAAA,KAAA,EAAA,YAAA,EAAA,aAAA,EAAA,OAAA;AAsFO,IAAM,8BAAN,MAEP;AAAA,EAYE,WAAA,CAAY,IAAA,GAA2C,EAAC,EAAG;AAX3D,IAAA,IAAA,CAAS,IAAA,GAAe,6BAAA;AACxB,IAAA,IAAA,CAAS,UAAA,GAAa,iBAAA;AACtB,IAAA,IAAA,CAAS,eAAA,GAAkB,uCAAA;AAG3B,IAAA,YAAA,CAAA,IAAA,EAAA,OAAA,CAAA;AACA,IAAA,YAAA,CAAA,IAAA,EAAA,KAAA,CAAA;AACA,IAAA,YAAA,CAAA,IAAA,EAAA,YAAA,EAA+D,EAAC,CAAA;AAChE,IAAA,YAAA,CAAA,IAAA,EAAA,aAAA,CAAA;AACA,IAAA,YAAA,CAAA,IAAA,EAAS,OAAA,CAAA;AAGP,IAAA,YAAA,CAAA,IAAA,EAAK,OAAA,EAAU,YAAA,CAAa,IAAA,CAAK,MAAM,CAAA,CAAA;AACvC,IAAA,YAAA,CAAA,IAAA,EAAK,KAAA,EAAQ,IAAA,CAAK,IAAA,IAAQ,EAAC,CAAA;AAC3B,IAAA,YAAA,CAAA,IAAA,EAAK,aAAA,EAAgB,KAAK,YAAA,IAAgB,qBAAA,CAAA;AAC1C,IAAA,IAAI;AACF,MAAA,YAAA,CAAA,IAAA,EAAK,OAAA,EAAU,IAAI,aAAA,CAAc;AAAA,QAC/B,YAAY,IAAA,CAAK,kBAAA;AAAA,QACjB,UAAA,EAAY,CAAA,EAAG,kBAAkB,CAAA,EAAG,mBAAK,aAAA,CAAa,CAAA,CAAA;AAAA,QACtD,QAAQ,IAAA,CAAK;AAAA,OACd,CAAA,CAAA;AAAA,IACH,SAAS,CAAA,EAAG;AACV,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,6BAAA,EAAiC,CAAA,CAAY,OAAO,CAAA,CAAE,CAAA;AAAA,IACxE;AACA,IAAA,IAAA,CAAK,WAAA,GAAc,KAAK,WAAA,IAAe,KAAA;AAAA,EACzC;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,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA;AAAA,EACd;AAAA;AAAA,EAGA,UAAU,MAAA,EAAsB;AAC9B,IAAA,YAAA,CAAA,IAAA,EAAK,OAAA,EAAU,aAAa,MAAM,CAAA,CAAA;AAAA,EACpC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,aAAA,CAAc,gBAAgC,KAAA,EAA4B;AACxE,IAAA,IAAI,KAAA,KAAU,IAAA,EAAM,OAAO,YAAA,CAAA,IAAA,EAAK,cAAa,cAAc,CAAA;AAAA,SACtD,YAAA,CAAA,IAAA,EAAK,YAAA,CAAA,CAAa,cAAc,CAAA,GAAI,KAAA;AAAA,EAC3C;AAAA,EAEA,MAAM,cAAc,cAAA,EAAmE;AACrF,IAAA,MAAM,MAAA,GAAS,YAAA,CAAA,IAAA,EAAK,YAAA,CAAA,CAAa,cAAc,CAAA;AAC/C,IAAA,IAAI,MAAA,KAAW,QAAW,OAAO,EAAE,YAAY,SAAA,CAAU,MAAM,GAAG,cAAA,EAAe;AACjF,IAAA,MAAM,IAAA,GAAO,MAAM,IAAA,CAAK,OAAA,EAAQ;AAChC,IAAA,MAAM,UAAA,GAAa,OAAA,KAAY,cAAA,GAAiB,IAAA,CAAK,QAAQ,IAAA,CAAK,KAAA;AAClE,IAAA,OAAO,EAAE,UAAA,EAAY,SAAA,CAAU,UAAU,GAAG,cAAA,EAAe;AAAA,EAC7D;AAAA;AAAA,EAGA,MAAM,OAAA,GAA6C;AACjD,IAAA,MAAM,GAAA,GAAM,OAAO,YAAA,CAAA,IAAA,EAAK,KAAA,CAAA,KAAU,aAAa,MAAM,YAAA,CAAA,IAAA,EAAK,KAAA,CAAA,CAAL,IAAA,CAAA,IAAA,CAAA,GAAe,YAAA,CAAA,IAAA,EAAK,KAAA,CAAA;AACzE,IAAA,OAAO;AAAA,MACL,SAAA,EAAW,SAAA,CAAU,GAAA,CAAI,SAAS,CAAA;AAAA,MAClC,QAAA,EAAU,SAAA,CAAU,GAAA,CAAI,QAAQ,CAAA;AAAA,MAChC,KAAA,EAAO,SAAA,CAAU,GAAA,CAAI,KAAK,CAAA;AAAA,MAC1B,KAAA,EAAO,SAAA,CAAU,GAAA,CAAI,KAAK;AAAA,KAC5B;AAAA,EACF;AAAA;AAAA,EAGA,qBAAA,GAAgC;AAC9B,IAAA,OAAO,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA,CAAQ,OAAA,CAAQ,IAAA,EAAM,MAAM,IAAI,CAAA;AAAA,EAC9C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,uBAAA,GAAgC;AAC9B,IAAA,YAAA,CAAA,IAAA,EAAK,SAAQ,KAAA,EAAM;AAAA,EACrB;AAAA,EAEA,MAAM,iBAAA,GAAiE;AACrE,IAAA,OAAO,EAAE,kBAAA,EAAoB,IAAA,CAAK,qBAAA,EAAsB,EAAE;AAAA,EAC5D;AACF;AAvFE,OAAA,GAAA,IAAA,OAAA,EAAA;AACA,KAAA,GAAA,IAAA,OAAA,EAAA;AACA,YAAA,GAAA,IAAA,OAAA,EAAA;AACA,aAAA,GAAA,IAAA,OAAA,EAAA;AACS,OAAA,GAAA,IAAA,OAAA,EAAA;AAsFX,IAAM,SAAA,GAAY,CAAC,KAAA,KAAoD;AACrE,EAAA,MAAM,OAAA,GAAU,OAAO,IAAA,EAAK;AAC5B,EAAA,OAAO,UAAU,OAAA,GAAU,IAAA;AAC7B,CAAA","file":"index.js"}

package/dist/adapters/salesforce/index.d.ts

@@ -0,0 +1,100 @@
+import { E as Environment, S as SupportedLocale, C as ConsentSessionAdapter, I as IdentifierType, a as ConsentCopyFormat, U as UpsertSessionResponse, b as ConsentSessionIdentifier } from '../../types-vPJjFMJw.js';
+
+/**
+ * This represents the information sent by the ISML form the backend used in the Thank You page.
+ */
+interface SalesforceConfig {
+    publicKey: string;
+    /**
+     * JWT the cartridge mints at render with the merchant's signing key
+     * (`{ iss: <public key>, iat, exp }`, ES256). Sent verbatim as the Bearer
+     * token; null only when the page rendered none (preview mode).
+     */
+    token: string | null;
+    env: Environment;
+    previewMode: boolean;
+    storeIdentifier: string;
+    locale: SupportedLocale;
+    basketUuid: string | null;
+    email: string | null;
+    phone: string | null;
+    orderId: string | null;
+    orderToken: string | null;
+}
+interface GetConfigFromScriptTagOptions {
+    /** Override the document for tests. */
+    document?: Document;
+    /** Override the selector used to locate the Dataships script tag. */
+    scriptSelector?: string;
+}
+/**
+ * Locate the Dataships SFCC bundle <script> tag and read its `data-*`
+ * attributes into a typed config object. Throws if required attributes
+ * are missing — those are server-rendered by the ISML template so any
+ * absence indicates a misconfigured cartridge or template.
+ *
+ * Optional attributes (`data-basket-uuid`, `data-email`, `data-phone`,
+ * `data-order-id`, `data-order-token`) may be empty on certain pages or for
+ * guest shoppers; they normalise to `null`. The two order-* attributes are
+ * server-rendered from `pdict.order` on confirmation pages and are the
+ * canonical source for the placed order's identifiers — SFRA's Order-Confirm
+ * URL does not reliably expose them as query params.
+ *
+ * `data-public-key` and `data-token` are the merchant credentials: the public
+ * key travels as `X-Api-Key`, the token as `Authorization: Bearer`.
+ * `data-store-identifier` (the SFCC `site@instance` value) is kept for
+ * telemetry only. `data-locale` is an SFCC
+ * locale string like `en_US`; the first segment is returned when it maps to a
+ * `SupportedLocale`, otherwise `"en"`.
+ */
+declare const getConfigFromScriptTag: (opts?: GetConfigFromScriptTagOptions) => SalesforceConfig;
+
+type SalesforceCollectionStep = "CHECKOUT_INFORMATION" | "THANK_YOU";
+/**
+ * Integration-specific fields the Salesforce adapter contributes to the
+ * consent-session envelope, merged under `integration`. The client injects
+ * `type`; the identifier and `locale` travel at the top level; the merchant is
+ * identified by the `X-Api-Key` header.
+ */
+interface SalesforceSessionContext {
+    collectionStep: SalesforceCollectionStep;
+    datashipsOrderUuid: string;
+    basketUuid: string | null;
+    orderId: string | null;
+    orderToken: string | null;
+}
+
+interface SalesforceAdapterOptions {
+    /**
+     * Pre-resolved config. If omitted, the adapter will call
+     * `getConfigFromScriptTag()` on construction.
+     */
+    config?: SalesforceConfig;
+    /** Override the window for tests. Defaults to `globalThis.window`. */
+    window?: Window;
+    /** Override the document for tests when resolving config from the script tag. */
+    document?: Document;
+}
+declare class SalesforceAdapter implements ConsentSessionAdapter<SalesforceSessionContext> {
+    #private;
+    readonly name: string;
+    readonly sessionApi: "consent-session";
+    readonly integrationType = "SALESFORCE_SNIPPET";
+    readonly config: SalesforceConfig;
+    /**
+     * When true we never call the API; instead we serve fake email data so
+     * merchants can style the snippet without a backend. Driven by the
+     * `data-preview-mode` site preference (a Salesforce toggle), independent of
+     * {@link SalesforceConfig.env}: with preview mode off, every env makes live
+     * calls (non-production envs to the client's explicit `baseUrl`).
+     */
+    readonly previewMode: boolean;
+    constructor(opts?: SalesforceAdapterOptions);
+    /** Synthetic upsert response served in {@link previewMode}; email-only at launch. */
+    getPreviewUpsertResponse(identifierType?: IdentifierType, format?: ConsentCopyFormat): UpsertSessionResponse;
+    getLocale(): SupportedLocale;
+    getIdentifier(identifierType: IdentifierType): ConsentSessionIdentifier;
+    getSessionContext(): Promise<SalesforceSessionContext>;
+}
+
+export { type GetConfigFromScriptTagOptions, SalesforceAdapter, type SalesforceAdapterOptions, type SalesforceCollectionStep, type SalesforceConfig, type SalesforceSessionContext, getConfigFromScriptTag };