@dataships/sdk 0.0.0-stage → 2.0.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 DATASHIPS LIMITED
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,331 @@
-# Temporary Holding Version
+# @dataships/sdk
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Transport and session-lifecycle client for the Dataships consent-session API
+(`/v1/consent-session`).
+
+The SDK is platform-agnostic. It takes a `ConsentSessionAdapter` that knows how
+to read order/customer context from a host environment (Shopify checkout,
+Salesforce, a custom platform, …) and posts the consent-session envelope to the
+Dataships backend.
+
+## Install
+
+The package is published publicly to npm under the `@dataships` scope:
+
+```bash
+npm install @dataships/sdk
+# or
+yarn add @dataships/sdk
+```
+
+## Quickstart (Salesforce SFCC storefront)
+
+```ts
+import { DatashipsClient } from "@dataships/sdk";
+import {
+  SalesforceAdapter,
+  getConfigFromScriptTag,
+} from "@dataships/sdk/adapters/salesforce";
+
+const config = getConfigFromScriptTag();
+
+const client = new DatashipsClient({
+  // Public key + the JWT the cartridge minted at render; both come from the
+  // script tag. The SDK sends the token verbatim and never inspects it.
+  auth: { publicKey: config.publicKey, token: config.token! },
+  // Any env other than "production" also needs a baseUrl; see "Environments".
+  env: config.env,
+  app: "my-sfcc-cartridge",
+  version: "1.0.0",
+  adapter: new SalesforceAdapter({ config }),
+});
+
+const response = await client.upsertSession({ identifierType: "EMAIL" });
+// Render one widget per entry; an empty array means render nothing.
+for (const entry of response.consents) {
+  render(entry.channel, entry.consentType, entry.checked, entry.widgetConfig);
+}
+
+const session = { consentSessionId: response.consentSessionId };
+const stop = client.startHeartbeat(session, {
+  onError: err => console.warn("heartbeat failed", err),
+});
+
+await client.saveConsent({
+  channel: "EMAIL",
+  consent: true,
+  session,
+});
+```
+
+The Salesforce adapter speaks the `consent-session` protocol (see below) and
+reads its config from the cartridge-rendered `data-*` attributes on the
+Dataships `<script>` tag. Rotate the token with `client.setToken(next)` before
+it expires; a missed rotation surfaces as a 401 `DatashipsError` and stops the
+heartbeat.
+
+## Environments
+
+Only production has a built-in API host (`https://api.dataships.io`).
+The package ships no internal hostnames, so `env: "staging"` or `env: "local"`
+without a `baseUrl` throws at construction. Pass the host Dataships gives you
+for a non-production environment:
+
+```ts
+new DatashipsClient({ env: "staging", baseUrl: STAGING_API_URL, ... });
+```
+
+## Script tag (CDN)
+
+For pages without a bundler, `dist/dataships.min.js` is a minified IIFE that
+assigns `window.Dataships` with the browser client, every adapter (not the
+server client) and `version`. `unpkg` and `jsdelivr` serve it for a bare
+package URL.
+
+```html
+<script src="https://sdk.dataships.io/sdk/v2/dataships.min.js"></script>
+<script>
+  const { DatashipsClient, CustomPlatformCheckoutAdapter } = window.Dataships;
+  const client = new DatashipsClient({
+    auth: { publicKey, token },
+    app: "my-storefront",
+    version: "1.0.0",
+    adapter: new CustomPlatformCheckoutAdapter({ collectionStep: "CHECKOUT_INFORMATION" }),
+  });
+</script>
+```
+
+### Versions and CDN URLs
+
+- `https://sdk.dataships.io/sdk/v2/` follows the latest 2.x release and is the
+  URL to use. A new major gets a new alias, so a page never moves majors on its own.
+- `https://sdk.dataships.io/sdk/2.0.0/` is an exact release and never changes.
+- `https://sdk.dataships.io/sdk/next/` follows the latest release candidate.
+
+Every exact release publishes `integrity.json` beside its scripts, with the
+SHA-384 of each one. To use subresource integrity, pin the exact version (an
+alias moves with every release, so its hash would stop matching):
+
+```html
+<script
+  src="https://sdk.dataships.io/sdk/2.0.0/dataships.min.js"
+  integrity="sha384-…"
+  crossorigin="anonymous"></script>
+```
+
+## Quickstart (custom platform / headless storefront)
+
+```ts
+import { DatashipsClient } from "@dataships/sdk";
+import { CustomPlatformCheckoutAdapter } from "@dataships/sdk/adapters/custom-platform-checkout";
+
+const adapter = new CustomPlatformCheckoutAdapter({
+  collectionStep: "CHECKOUT_INFORMATION", // or "THANK_YOU" on the confirmation page
+  locale: navigator.language,             // coerced to a SupportedLocale
+  storageScope: publicKey,                // keys the datashipsSessionId in localStorage
+});
+
+const client = new DatashipsClient({
+  // The merchant's server mints the short-lived ES256 JWT and injects it into the page.
+  auth: { publicKey, token },
+  env: "production",
+  app: "my-storefront",
+  version: "1.0.0",
+  adapter,
+});
+
+// Anonymous first, then again once the shopper types an email.
+let response = await client.upsertSession({ identifierType: "EMAIL" });
+response = await client.upsertSession({ identifierType: "EMAIL", identifier: typedEmail });
+
+const session = { consentSessionId: response.consentSessionId };
+const stop = client.startHeartbeat(session);
+await client.saveConsent({ channel: "EMAIL", consent: true, session });
+```
+
+The adapter posts `integration: { type: "CUSTOM_PLATFORM_CHECKOUT", collectionStep,
+datashipsSessionId, isFastCheckout }`.
+The signup adapter (`CustomPlatformSignupAdapter`, `@dataships/sdk/adapters/custom-platform-signup`)
+posts `integration: { type: "CUSTOM_PLATFORM_SIGNUP", datashipsSessionId }` for a merchant-built
+form: same beacon lifecycle under its own storage key, one id per form fill, `resetDatashipsSessionId()`
+after the form is submitted; identifiers come from a `user` literal or resolver. The `datashipsSessionId` beacon is minted on the
+checkout step, carried to the thank-you page through `localStorage` (scoped by
+`storageScope`), and rotated when a new checkout starts; pass your own
+`datashipsSessionId` to own that lifecycle instead. A thank-you upsert for a checkout
+that already showed the widget answers 204, which the SDK resolves to an empty
+`consents`.
+
+Completing the flow — the placed order landing on every session opened under the
+beacon and processing being queued — is `client.submitSession()`, backed by
+`POST /v1/consent-session/submit`:
+
+```ts
+await client.submitSession({
+  user: { firstName: "Jane", lastName: "Doe" }, // both required; contact details never travel here
+  details: { id: "ORD-1001", total: 149.9, billingCountryCode: "IE", submittedAt: new Date() },
+});
+```
+
+The beacon defaults to the adapter's own and is discarded once the submit is
+accepted; pass `datashipsSessionId` to complete a beacon you carried yourself.
+The identifier is what the widget collected on the upsert; the submit carries
+only the shopper's names, and the SDK refuses a blank one before sending.
+The backend is idempotent and answers 200 even when the beacon matches no
+session. `details` is the flow's payload merged under `integration` next to the
+adapter's `type`: for `CUSTOM_PLATFORM_CHECKOUT` that is the order above
+(`total` as a number in the integration's currency, `billingCountryCode` ISO
+3166-1 alpha-2). The server client exposes the same call with
+`datashipsSessionId` required, for a merchant backend completing from its
+order-created hook.
+
+## Quickstart (Shopify checkout UI extension)
+
+```ts
+import { DatashipsClient } from "@dataships/sdk";
+import { ShopifyCheckoutAdapter } from "@dataships/sdk/adapters/shopify-checkout";
+
+const adapter = new ShopifyCheckoutAdapter({
+  collectionStep: "CHECKOUT_INFORMATION", // or "THANK_YOU"
+  datashipsOrderUuid,                     // the checkout's cart-attribute UUID, when it has one
+  locale: shopify.localization.language.value.isoCode,
+  checkoutToken: shopify.checkoutToken.value,
+});
+
+const client = new DatashipsClient({
+  // Shopify session tokens live about a minute: fetch one per request.
+  auth: { publicKey, getToken: () => shopify.sessionToken.get() },
+  env: "production",
+  app: "my-checkout-extension",
+  version: "1.0.0",
+  adapter,
+});
+
+const response = await client.upsertSession({ identifierType: "EMAIL", identifier: email });
+```
+
+`getToken` is called before every request, retries and heartbeats included,
+and is exclusive with `token` (`setToken()` throws under it). Update facts that
+change on the page with `adapter.setCheckoutDetails({ orderId, wallet, … })`
+and `adapter.setCollectionStep(...)`.
+
+In the checkout editor, run the same flow with no credentials and no network
+call:
+
+```ts
+const client = new DatashipsClient({
+  app: "my-checkout-extension",
+  version: "1.0.0",
+  adapter: new ShopifyCheckoutAdapter({
+    collectionStep: "CHECKOUT_INFORMATION",
+    previewMode: true,
+  }),
+});
+```
+
+## Unsafe: the server key in the browser
+
+A merchant with no server at all cannot mint tokens. As an explicit, accepted-risk
+escape hatch the browser client takes the server key under its own name:
+
+```ts
+const client = new DatashipsClient({
+  auth: { unsafeServerKey: "ds_sk_live_…" }, // UNSAFE: exposed to every visitor
+  env: "production",
+  app: "my-storefront",
+  version: "1.0.0",
+  adapter,
+});
+```
+
+The key is sent alone as `X-Api-Key`. Anyone who views the page source can open
+sessions, save consent and submit orders as that merchant until the key is
+revoked (ask Dataships support to revoke it); revocation is the only remedy. The SDK refuses a public key under this name, warns once in the
+console at construction, appends `unsafe-server-key` to `X-Dataships-App` so the
+backend can tell these calls from genuine server-to-server ones, and `setToken()`
+throws. Prefer `auth: { publicKey, token }` wherever a token can be minted.
+
+## Server-to-server (merchant backend)
+
+The server key never leaves the merchant's servers. A separate entry keeps it
+out of storefront bundles: `@dataships/sdk/server` refuses to construct where
+`window` exists, and the browser client refuses server keys.
+
+```ts
+import { DatashipsServerClient } from "@dataships/sdk/server";
+
+const client = new DatashipsServerClient({
+  auth: { serverKey: process.env.DATASHIPS_SERVER_KEY! },
+  app: "my-backend",
+  version: "1.0.0",
+  adapter, // any consent-session adapter supplying the integration context
+});
+
+// The connection IP is your server's, so the user's IP is mandatory.
+const response = await client.upsertSession({
+  identifierType: "EMAIL",
+  identifier: "user@example.com",
+  userIp: request.ip,
+});
+```
+
+The server client exposes `upsertSession`, `saveConsent`, `heartbeat` (one
+beat; schedule your own cadence), `submitSession` (with an explicit
+`datashipsSessionId`), `triggerVerificationCode` and `submitVerificationCode`,
+with the same responses and `DatashipsError` as the browser client.
+
+## Adapters
+
+| Adapter | Import | Use case |
+| --- | --- | --- |
+| Shopify checkout UI extensions | `@dataships/sdk/adapters/shopify-checkout` | Checkout UI extensions (`SHOPIFY_CHECKOUT`). No DOM: the extension passes the collection step, `datashipsOrderUuid` and checkout details from the Shopify checkout API. Authenticate with `auth: { publicKey, getToken: () => shopify.sessionToken.get() }` so every request carries a fresh session token. Used by the Dataships Shopify app. |
+| Salesforce (SFCC) | `@dataships/sdk/adapters/salesforce` | Reads `data-*` attributes off the SFCC cartridge `<script>` tag. Used by the Dataships SFCC cartridge. |
+| Custom platform checkout | `@dataships/sdk/adapters/custom-platform-checkout` | Bespoke / headless storefronts with no native integration (`CUSTOM_PLATFORM`). Every input comes from the integrator; the adapter owns the per-checkout `datashipsSessionId`. Used by `@dataships/elements`. |
+| Custom platform signup | `@dataships/sdk/adapters/custom-platform-signup` | Merchant-built signup forms (newsletter, account creation) on platforms with no native integration. Posts `CUSTOM_PLATFORM_SIGNUP` with the per-form-fill `datashipsSessionId`; the merchant supplies the user (`email`, `phone`, name) as a literal or a resolver. |
+
+### Consent-session protocol
+
+Every adapter drives `/v1/consent-session`. The client authenticates with
+`auth: { publicKey, token }` or `auth: { publicKey, getToken }` (`X-Api-Key` +
+`Authorization: Bearer`). `upsertSession({ identifierType, identifier?, userIp?, format? })`
+posts the `{ identifier, identifierType, locale, userIp?, format?, integration: { type, … } }`
+envelope to `POST /v1/consent-session` and returns
+`{ consentSessionId, consents[], userVerificationRequired, lastHeartbeat, identifier }`:
+one entry per channel that renders (`channel`, `consentType`, `checked`, and
+`widgetConfig` with the nullable copy fields), plus the identifier the session
+holds so a widget can refill a field it lost. `format` picks how the copy comes
+back: `json` (the API default) for plain strings you format yourself, `html` for
+`text` and `consentDescription` with links and emphasis applied. In `json` copy,
+`{{MARKETING_PREFERENCES}}` is the marketing modal link showing
+`widgetConfig.placeholderValues.MARKETING_PREFERENCES`, which the API resolves
+to the author's text or the served language's "Click here". Save-consent, heartbeat and the
+OTP calls live under `/v1/consent-session/*`. Pass
+`{ consentSessionId: response.consentSessionId }` as the session for
+`startHeartbeat` / `saveConsent`. A 204 No Content on upsert resolves to an
+empty `consents` as well.
+
+In preview mode (`previewMode: true` on the adapter) the client makes no
+network call and needs no `auth`. `upsertSession` returns a synthetic response
+for the requested identifier type, carrying the standard default opt-in
+wording a live widget shows when no custom wording is configured:
+`fakeEmailUpsertResponse` (one EMAIL consent) for EMAIL,
+`fakePhoneUpsertResponse` (one SMS consent, `userVerificationRequired: false`)
+for PHONE. The copy comes back in the `format` the upsert asked for, so a
+widget that renders `html` previews with its links and emphasis applied. The
+other calls resolve without a request: `triggerVerificationCode` reports
+untriggered and `submitVerificationCode` resolves verified.
+
+Errors surface as `DatashipsError { status, code, reason, challenge, body }`.
+401 / 403 are never retried; a 422 `COUNTRY_NOT_FOUND` on upsert resolves to
+an empty `consents` instead of throwing. A 409 is retried when it is a held
+checkout lock (`PESSIMISTIC_LOCK_EXCEPTION`) but not when the session has
+already been processed (`CONSENT_SESSION_ALREADY_PROCESSED`, exposed as
+`error.isSessionProcessed`), which also stops the heartbeat.
+
+## Contributing
+
+See `CONTRIBUTING.md` in the repository for local development, prereleases
+and the release process.
+
+## License
+
+Licensed under the [Apache License, Version 2.0](LICENSE).

package/dist/adapters/custom-platform-checkout/index.d.ts

@@ -0,0 +1,139 @@
+import { C as ConsentSessionAdapter, I as IdentifierType, a as ConsentCopyFormat, U as UpsertSessionResponse, S as SupportedLocale, b as ConsentSessionIdentifier } from '../../types-vPJjFMJw.js';
+export { D as DATASHIPS_SESSION_ID_MAX_LENGTH } from '../../beacon-B8v41O8P.js';
+export { c as coerceLocale } from '../../locale-B1o0kX7n.js';
+
+/**
+ * Where in the checkout the widget is being shown. Mirrors core-api's
+ * `WidgetType` as accepted by the `CUSTOM_PLATFORM_CHECKOUT` integration:
+ *
+ * - `CHECKOUT_INFORMATION` — the pre-purchase step where the shopper enters
+ *   their contact details.
+ * - `THANK_YOU` — the order confirmation page shown right after purchase.
+ * - `ORDER_STATUS` — a later revisit of a placed order (reload of the
+ *   confirmation page, "view your order" link). Never collects consent: the
+ *   API answers 204 and the SDK resolves an empty `consents`.
+ */
+type CustomPlatformCollectionStep = "CHECKOUT_INFORMATION" | "THANK_YOU" | "ORDER_STATUS";
+/**
+ * Integration-specific fields the custom-platform adapter contributes to the
+ * consent-session envelope, merged under `integration`. The client injects
+ * `type: "CUSTOM_PLATFORM_CHECKOUT"`; the identifier and `locale` travel at the
+ * top level; the merchant is identified by the `X-Api-Key` header.
+ *
+ * `datashipsSessionId` is the SDK-generated beacon for one checkout: sent on
+ * every upsert and echoed on order submission, which is how the order is
+ * mapped back onto the EMAIL / PHONE sibling sessions. The order itself never
+ * travels on the upsert.
+ */
+interface CustomPlatformCheckoutSessionContext {
+    collectionStep: CustomPlatformCollectionStep;
+    datashipsSessionId: string;
+    /**
+     * Whether the shopper is in a fast / express checkout (Apple Pay, Shop Pay,
+     * PayPal Express, …) that skips the checkout information step. The backend
+     * then shows the widget on the thank-you page even though a checkout
+     * session already exists.
+     */
+    isFastCheckout: boolean;
+}
+
+/** `integration.type` discriminator core-api routes to the custom-platform checkout lifecycle. */
+declare const CUSTOM_PLATFORM_CHECKOUT_INTEGRATION_TYPE = "CUSTOM_PLATFORM_CHECKOUT";
+
+interface CustomPlatformCheckoutAdapterOptions {
+    /** Which checkout step the page represents. Change it later with {@link CustomPlatformCheckoutAdapter.setCollectionStep}. */
+    collectionStep: CustomPlatformCollectionStep;
+    /**
+     * The shopper's language. Any BCP 47 / POSIX style string is accepted
+     * (`en`, `en-GB`, `de_DE`); the first segment is used when it maps to a
+     * {@link SupportedLocale}, otherwise `"en"`.
+     */
+    locale?: string;
+    /** Server-known email, when the page already has it (order confirmation). */
+    email?: string | null;
+    /** Server-known E.164 phone, when the page already has it. */
+    phone?: string | null;
+    /** See {@link CustomPlatformCheckoutSessionContext.isFastCheckout}. Defaults to false. */
+    isFastCheckout?: boolean;
+    /**
+     * Bring your own checkout beacon. When set the adapter never touches
+     * `localStorage`; the integrator owns the lifecycle (one id per checkout,
+     * echoed on order submission). At most 100 characters.
+     */
+    datashipsSessionId?: string;
+    /**
+     * Scopes the `localStorage` entry that carries the beacon across the
+     * checkout → confirmation navigation, so two merchants (or two stores) on
+     * one origin do not share a checkout. Typically the merchant's public key.
+     */
+    storageScope?: string;
+    /**
+     * When true the client never calls the API and serves synthetic email data
+     * instead, so the widget can be styled without credentials. Defaults to
+     * false.
+     */
+    previewMode?: boolean;
+    /** Override the window for tests. Defaults to `globalThis.window`. */
+    window?: Window;
+}
+/**
+ * Consent-session adapter for merchants on a platform Dataships has no native
+ * integration with (the `CUSTOM_PLATFORM` merchant integration): a bespoke
+ * storefront, a headless build, a platform without an app store. Drives the
+ * `CUSTOM_PLATFORM_CHECKOUT` upsert type on `POST /v1/consent-session`.
+ *
+ * Unlike the Salesforce and Shopify adapters there is no platform surface to
+ * read from, so every input is supplied by the integrator: the checkout step,
+ * the locale, the identifiers the page already knows. The adapter's own job is
+ * the `datashipsSessionId` beacon that ties the checkout-information upsert,
+ * the thank-you upsert and the later order submission together.
+ *
+ * Beacon lifecycle (when {@link CustomPlatformCheckoutAdapterOptions.datashipsSessionId}
+ * is not supplied):
+ *  - First use on `CHECKOUT_INFORMATION`: a fresh UUID, stored under the scope.
+ *  - `THANK_YOU` / `ORDER_STATUS`: the stored id is reused so the backend
+ *    resolves the session opened at checkout (and suppresses the widget when it
+ *    was already asked there). A confirmation reached without a stored entry —
+ *    cleared storage, another device, a fast checkout landing straight on the
+ *    thank-you page — mints a fresh id: best-effort correlation by design.
+ *  - A later `CHECKOUT_INFORMATION` after a `THANK_YOU` / `ORDER_STATUS` use is
+ *    a new checkout: the stored id is discarded and a fresh one minted, so a
+ *    completed (processed) session is never upserted again.
+ *  - {@link resetDatashipsSessionId} forces a fresh id, e.g. right after the
+ *    order was submitted.
+ */
+declare class CustomPlatformCheckoutAdapter implements ConsentSessionAdapter<CustomPlatformCheckoutSessionContext> {
+    #private;
+    readonly name: string;
+    readonly sessionApi: "consent-session";
+    readonly integrationType = "CUSTOM_PLATFORM_CHECKOUT";
+    readonly previewMode: boolean;
+    constructor(opts: CustomPlatformCheckoutAdapterOptions);
+    /** Synthetic upsert response served in {@link previewMode}, matching the requested identifier type. */
+    getPreviewUpsertResponse(identifierType?: IdentifierType, format?: ConsentCopyFormat): UpsertSessionResponse;
+    getLocale(): SupportedLocale;
+    get collectionStep(): CustomPlatformCollectionStep;
+    /** Move the same adapter to another step, e.g. a single-page checkout reaching its confirmation view. */
+    setCollectionStep(step: CustomPlatformCollectionStep): void;
+    get isFastCheckout(): boolean;
+    setFastCheckout(isFastCheckout: boolean): void;
+    /**
+     * Remember an identifier the shopper 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;
+    /** The beacon this checkout is known by; resolved (and persisted) on first use. */
+    getDatashipsSessionId(): string;
+    /**
+     * Discard the current beacon so the next call mints a fresh one. Call it once
+     * the order has been submitted, so the next checkout on this browser opens a
+     * new session instead of touching the processed one. No-op for an
+     * integrator-owned id.
+     */
+    resetDatashipsSessionId(): void;
+    getSessionContext(): Promise<CustomPlatformCheckoutSessionContext>;
+}
+
+export { CUSTOM_PLATFORM_CHECKOUT_INTEGRATION_TYPE, CustomPlatformCheckoutAdapter, type CustomPlatformCheckoutAdapterOptions, type CustomPlatformCheckoutSessionContext, type CustomPlatformCollectionStep };