@viu/emporix-sdk 1.0.0

package/dist/category.d.ts

@@ -0,0 +1,313 @@
+import { C as ClientContext, b as AuthContext, P as PaginatedItems } from './context-vKgzZ-5f.js';
+import { Product } from './product.js';
+
+/**
+ * Classification mixin defined for a given category.
+ */
+type OwnClassificationMixin = {
+    /**
+     * Name of the mixin.
+     */
+    name: string;
+    /**
+     * URL of the mixin schema.
+     */
+    schemaUrl: string;
+    /**
+     * Indicates whether the mixin is required.
+     */
+    required?: boolean;
+};
+/**
+ * Classification mixin with source category information.
+ */
+type ClassificationMixin = {
+    /**
+     * Name of the mixin
+     */
+    name: string;
+    /**
+     * The mixins path that should be used when defining attributes on a product. It's built based on the following pattern - `class_<sourceCategory.code>_<name>`.
+     */
+    mixinPath?: string;
+    /**
+     * URL of the mixin schema.
+     */
+    schemaUrl: string;
+    /**
+     * Indicates whether the mixin is required.
+     */
+    required?: boolean;
+    /**
+     * Unique identifier of the category from which the mixin comes from. Can be this category ID or one of the parent categories IDs.
+     */
+    sourceCategoryId?: string;
+};
+/**
+ * Definition of category
+ */
+type Category$1 = {
+    /**
+     * Category unique identifier generated when the category is created.
+     */
+    id: string;
+    /**
+     * Unique identifier of the parent category. No parentId in the body indicates that this is a root category.
+     */
+    parentId?: string | null;
+    /**
+     * Localized category name as a map of translations.
+     */
+    localizedName: {
+        [key: string]: string;
+    };
+    /**
+     * Localized category description as a map of translations.
+     */
+    localizedDescription?: {
+        [key: string]: string;
+    };
+    /**
+     * Provides localized category name or code without diacritics for the URL.
+     */
+    localizedSlug?: {
+        [key: string]: string;
+    };
+    /**
+     * Category name in tenant default language.
+     * @deprecated
+     */
+    name?: string;
+    /**
+     * Description in tenant default language.
+     * @deprecated
+     */
+    description?: string;
+    /**
+     * Unique category identifier defined by the tenant.
+     */
+    code?: string;
+    /**
+     * List of external category numbers (ECNs) unique for each category.
+     */
+    ecn?: Array<string>;
+    validity?: Validity;
+    /**
+     * Category position relative to sibling categories.
+     */
+    position: number;
+    /**
+     * Flag indicating whether the category has been published.
+     */
+    published: boolean;
+    /**
+     * IDs of supercategories.
+     */
+    supercategoriesIds?: Array<string>;
+    /**
+     * List of classification mixins defined for this category.
+     */
+    ownClassificationMixins?: Array<OwnClassificationMixin>;
+    /**
+     * Combined list of classification mixins from parent categories and category's ownClassification mixins.
+     */
+    classificationMixins?: Array<ClassificationMixin>;
+    /**
+     * Custom category attributes included directly in the mixins object.
+     */
+    mixins?: {
+        [key: string]: unknown;
+    };
+    metadata: MetadataResponse;
+    media: Array<Media>;
+};
+/**
+ * Definition of category tree
+ */
+type CategoryTree = {
+    /**
+     * Category unique identifier generated when the category is created.
+     */
+    id: string;
+    /**
+     * Category name in tenant default language.
+     * @deprecated
+     */
+    name: string;
+    /**
+     * Description in tenant default language.
+     * @deprecated
+     */
+    description?: string;
+    /**
+     * Unique category identifier defined by the tenant.
+     * @deprecated
+     */
+    code?: string;
+    /**
+     * Localized category name as a map of translations.
+     */
+    localizedName: {
+        [key: string]: string;
+    };
+    /**
+     * Localized category description as a map of translations.
+     */
+    localizedDescription?: {
+        [key: string]: string;
+    };
+    /**
+     * Provides localized category name or code without diacritics for the URL.
+     */
+    localizedSlug?: {
+        [key: string]: string;
+    };
+    validity?: Validity;
+    /**
+     * Category position in relation to sibling categories.
+     */
+    position: number;
+    /**
+     * Flag indicating whether the category has been published.
+     */
+    published: boolean;
+    /**
+     * List of external category numbers (ECNs) unique for each category.
+     */
+    ecn?: Array<string>;
+    /**
+     * Subcategories of this category.
+     */
+    subcategories?: Array<CategoryTree>;
+};
+type Media = {
+    /**
+     * Unique identifier of media.
+     */
+    id?: string;
+    /**
+     * Url of the file.
+     */
+    url?: string;
+    /**
+     * Content type of the file.
+     */
+    contentType?: string;
+    metadata?: MediaMetadataQueryDocument & unknown;
+    customAttributes?: MediaCustomAttributesQueryDocument & unknown;
+};
+/**
+ * Custom attributes of the file.
+ */
+type MediaCustomAttributesQueryDocument = {
+    /**
+     * Unique identifier of media's custom attributes.
+     */
+    id?: string;
+    /**
+     * Height of the media image.
+     */
+    height?: number;
+    /**
+     * Width of the media image.
+     */
+    width?: number;
+    /**
+     * Size in kilobytes of the file.
+     */
+    sizeKB?: number;
+    /**
+     * Mime type of the file.
+     */
+    type?: string;
+    /**
+     * Name of the file.
+     */
+    name?: string;
+};
+/**
+ * Metadata of the file.
+ */
+type MediaMetadataQueryDocument = {
+    /**
+     * Timestamp indicating when the media was created compliant with the ISO 8601 standard.
+     */
+    createdAt?: string;
+    /**
+     * Timestamp indicating when the media was modified compliant with the ISO 8601 standard.
+     */
+    modifiedAt?: string;
+};
+type MetadataCreate = {
+    /**
+     * A key-value map, where key is a mixin name and value is a link to the mixin schema.
+     */
+    mixins?: {
+        [key: string]: string;
+    };
+};
+type MetadataUpdate = {
+    /**
+     * Category version.
+     */
+    version?: number;
+} & MetadataCreate;
+type MetadataResponse = {
+    /**
+     * Timestamp indicating when the category was created compliant with the ISO 8601 standard.
+     */
+    createdAt?: string;
+    /**
+     * Timestamp indicating when the category was last modified compliant with the ISO 8601 standard.
+     */
+    modifiedAt?: string;
+} & MetadataUpdate;
+type Validity = {
+    /**
+     * Date and time from which the category is valid compliant with the ISO 8601 standard.
+     */
+    from?: string;
+    /**
+     * Date and time to which the category is valid compliant with the ISO 8601 standard.
+     */
+    to?: string;
+};
+
+/** A category as returned by the Category service (all generated fields). */
+type Category = Category$1;
+/** The category tree as returned by the Category service. */
+type CategoryNode = CategoryTree;
+/** Category reads. Default auth: anonymous. */
+declare class CategoryService {
+    private readonly ctx;
+    constructor(ctx: ClientContext);
+    /** Fetches one category by id. */
+    get(categoryId: string, auth?: AuthContext): Promise<Category>;
+    /** One page of categories. */
+    list(params?: {
+        pageNumber?: number;
+        pageSize?: number;
+    }, auth?: AuthContext): Promise<PaginatedItems<Category>>;
+    /** Async-iterates every category across pages. */
+    listAll(params?: {
+        pageSize?: number;
+    }, auth?: AuthContext): AsyncIterable<Category>;
+    /** Fetches the category tree, optionally rooted at `rootId`. */
+    tree(rootId?: string, auth?: AuthContext): Promise<CategoryNode>;
+    /** One page of products in a category. */
+    productsIn(categoryId: string, params?: {
+        pageNumber?: number;
+        pageSize?: number;
+    }, auth?: AuthContext): Promise<PaginatedItems<Product>>;
+    /**
+     * Bulk fetch by id. POSTs `/categories/search` with `q="id:(id1,id2,…)"`,
+     * chunking when the list is larger than `options.chunkSize` (default
+     * 100). An empty list short-circuits with no HTTP call. **Order is not
+     * guaranteed** across chunks — re-index by `id` if order matters.
+     */
+    searchByIds(ids: string[], options?: {
+        chunkSize?: number;
+    }, auth?: AuthContext): Promise<Category[]>;
+}
+
+export { type Category, type CategoryNode, CategoryService };

package/dist/category.js

@@ -0,0 +1,4 @@
+export { CategoryService } from './chunk-4BJUCCKJ.js';
+import './chunk-GWJ2U2CP.js';
+//# sourceMappingURL=category.js.map
+//# sourceMappingURL=category.js.map

package/dist/category.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"category.js"}

package/dist/checkout.cjs

@@ -0,0 +1,98 @@
+'use strict';
+
+// src/core/errors.ts
+var REDACTED_BODY_KEYS = /* @__PURE__ */ new Set([
+  "access_token",
+  "refresh_token",
+  "token",
+  "customertoken",
+  "saastoken",
+  "secret",
+  "client_secret",
+  "authorization",
+  "password"
+]);
+function scrub(body) {
+  if (Array.isArray(body)) return body.map(scrub);
+  if (body && typeof body === "object") {
+    const out = {};
+    for (const [k, v] of Object.entries(body)) {
+      out[k] = REDACTED_BODY_KEYS.has(k.toLowerCase()) ? "***redacted***" : scrub(v);
+    }
+    return out;
+  }
+  return body;
+}
+var EmporixError = class extends Error {
+  status;
+  body;
+  constructor(message, status, body) {
+    super(message);
+    this.name = new.target.name;
+    this.status = status;
+    this.body = body;
+    Object.setPrototypeOf(this, new.target.prototype);
+  }
+  /** Safe serialisation — token-like body fields are redacted. */
+  toJSON() {
+    return { name: this.name, message: this.message, status: this.status, body: scrub(this.body) };
+  }
+};
+var EmporixAuthError = class extends EmporixError {
+};
+
+// src/services/checkout.ts
+function isGuest(customer) {
+  return customer?.guest === true;
+}
+function resolveAuth(auth, guest) {
+  if (auth && (auth.kind === "customer" || auth.kind === "raw")) return auth;
+  if (guest && auth && auth.kind === "anonymous") return auth;
+  throw new EmporixAuthError(
+    "checkout requires a customer/raw AuthContext (or anonymous for a guest checkout)"
+  );
+}
+var CheckoutService = class {
+  constructor(ctx) {
+    this.ctx = ctx;
+  }
+  ctx;
+  headers(opts, guest) {
+    if (guest || !opts.saasToken) return void 0;
+    return { "saas-token": opts.saasToken };
+  }
+  query(opts) {
+    return opts.siteCode ? { siteCode: opts.siteCode } : void 0;
+  }
+  /** Checkout from a cart. Requires customer/raw auth (or anonymous for guest). */
+  async placeOrder(input, auth, opts = {}) {
+    const guest = isGuest(input.customer);
+    const headers = this.headers(opts, guest);
+    const query = this.query(opts);
+    return this.ctx.http.request({
+      method: "POST",
+      path: `/checkout/${this.ctx.tenant}/checkouts/order`,
+      auth: resolveAuth(auth, guest),
+      ...query ? { query } : {},
+      ...headers ? { headers } : {},
+      body: input
+    });
+  }
+  /** Checkout from a quote. */
+  async placeOrderFromQuote(input, auth, opts = {}) {
+    const headers = this.headers(opts, false);
+    const query = this.query(opts);
+    return this.ctx.http.request({
+      method: "POST",
+      path: `/checkout/${this.ctx.tenant}/checkouts/order`,
+      auth: resolveAuth(auth, false),
+      ...query ? { query } : {},
+      ...headers ? { headers } : {},
+      body: input
+    });
+  }
+};
+
+exports.CheckoutService = CheckoutService;
+//# sourceMappingURL=checkout.cjs.map
+//# sourceMappingURL=checkout.cjs.map

package/dist/checkout.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/core/errors.ts","../src/services/checkout.ts"],"names":[],"mappings":";;;AACA,IAAM,kBAAA,uBAAyB,GAAA,CAAI;AAAA,EACjC,cAAA;AAAA,EAAgB,eAAA;AAAA,EAAiB,OAAA;AAAA,EAAS,eAAA;AAAA,EAAiB,WAAA;AAAA,EAC3D,QAAA;AAAA,EAAU,eAAA;AAAA,EAAiB,eAAA;AAAA,EAAiB;AAC9C,CAAC,CAAA;AAED,SAAS,MAAM,IAAA,EAAwB;AACrC,EAAA,IAAI,MAAM,OAAA,CAAQ,IAAI,GAAG,OAAO,IAAA,CAAK,IAAI,KAAK,CAAA;AAC9C,EAAA,IAAI,IAAA,IAAQ,OAAO,IAAA,KAAS,QAAA,EAAU;AACpC,IAAA,MAAM,MAA+B,EAAC;AACtC,IAAA,KAAA,MAAW,CAAC,CAAA,EAAG,CAAC,KAAK,MAAA,CAAO,OAAA,CAAQ,IAA+B,CAAA,EAAG;AACpE,MAAA,GAAA,CAAI,CAAC,CAAA,GAAI,kBAAA,CAAmB,GAAA,CAAI,CAAA,CAAE,aAAa,CAAA,GAAI,gBAAA,GAAmB,KAAA,CAAM,CAAC,CAAA;AAAA,IAC/E;AACA,IAAA,OAAO,GAAA;AAAA,EACT;AACA,EAAA,OAAO,IAAA;AACT;AAGO,IAAM,YAAA,GAAN,cAA2B,KAAA,CAAM;AAAA,EAC7B,MAAA;AAAA,EACA,IAAA;AAAA,EACT,WAAA,CAAY,OAAA,EAAiB,MAAA,EAAiB,IAAA,EAAgB;AAC5D,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,OAAO,GAAA,CAAA,MAAA,CAAW,IAAA;AACvB,IAAA,IAAA,CAAK,MAAA,GAAS,MAAA;AACd,IAAA,IAAA,CAAK,IAAA,GAAO,IAAA;AACZ,IAAA,MAAA,CAAO,cAAA,CAAe,IAAA,EAAM,GAAA,CAAA,MAAA,CAAW,SAAS,CAAA;AAAA,EAClD;AAAA;AAAA,EAEA,MAAA,GAAkC;AAChC,IAAA,OAAO,EAAE,IAAA,EAAM,IAAA,CAAK,IAAA,EAAM,SAAS,IAAA,CAAK,OAAA,EAAS,MAAA,EAAQ,IAAA,CAAK,MAAA,EAAQ,IAAA,EAAM,KAAA,CAAM,IAAA,CAAK,IAAI,CAAA,EAAE;AAAA,EAC/F;AACF,CAAA;AAGO,IAAM,gBAAA,GAAN,cAA+B,YAAA,CAAa;AAAC,CAAA;;;ACTpD,SAAS,QAAQ,QAAA,EAA6C;AAC5D,EAAA,OAAO,UAAU,KAAA,KAAU,IAAA;AAC7B;AAEA,SAAS,WAAA,CAAY,MAA+B,KAAA,EAA6B;AAC/E,EAAA,IAAI,SAAS,IAAA,CAAK,IAAA,KAAS,cAAc,IAAA,CAAK,IAAA,KAAS,QAAQ,OAAO,IAAA;AACtE,EAAA,IAAI,KAAA,IAAS,IAAA,IAAQ,IAAA,CAAK,IAAA,KAAS,aAAa,OAAO,IAAA;AACvD,EAAA,MAAM,IAAI,gBAAA;AAAA,IACR;AAAA,GACF;AACF;AAGO,IAAM,kBAAN,MAAsB;AAAA,EAC3B,YAA6B,GAAA,EAAoB;AAApB,IAAA,IAAA,CAAA,GAAA,GAAA,GAAA;AAAA,EAAqB;AAAA,EAArB,GAAA;AAAA,EAErB,OAAA,CAAQ,MAAuB,KAAA,EAAoD;AACzF,IAAA,IAAI,KAAA,IAAS,CAAC,IAAA,CAAK,SAAA,EAAW,OAAO,MAAA;AACrC,IAAA,OAAO,EAAE,YAAA,EAAc,IAAA,CAAK,SAAA,EAAU;AAAA,EACxC;AAAA,EAEQ,MAAM,IAAA,EAA2D;AACvE,IAAA,OAAO,KAAK,QAAA,GAAW,EAAE,QAAA,EAAU,IAAA,CAAK,UAAS,GAAI,MAAA;AAAA,EACvD;AAAA;AAAA,EAGA,MAAM,UAAA,CACJ,KAAA,EACA,IAAA,EACA,IAAA,GAAwB,EAAC,EACA;AACzB,IAAA,MAAM,KAAA,GAAQ,OAAA,CAAQ,KAAA,CAAM,QAAQ,CAAA;AACpC,IAAA,MAAM,OAAA,GAAU,IAAA,CAAK,OAAA,CAAQ,IAAA,EAAM,KAAK,CAAA;AACxC,IAAA,MAAM,KAAA,GAAQ,IAAA,CAAK,KAAA,CAAM,IAAI,CAAA;AAC7B,IAAA,OAAO,IAAA,CAAK,GAAA,CAAI,IAAA,CAAK,OAAA,CAAwB;AAAA,MAC3C,MAAA,EAAQ,MAAA;AAAA,MACR,IAAA,EAAM,CAAA,UAAA,EAAa,IAAA,CAAK,GAAA,CAAI,MAAM,CAAA,gBAAA,CAAA;AAAA,MAClC,IAAA,EAAM,WAAA,CAAY,IAAA,EAAM,KAAK,CAAA;AAAA,MAC7B,GAAI,KAAA,GAAQ,EAAE,KAAA,KAAU,EAAC;AAAA,MACzB,GAAI,OAAA,GAAU,EAAE,OAAA,KAAY,EAAC;AAAA,MAC7B,IAAA,EAAM;AAAA,KACP,CAAA;AAAA,EACH;AAAA;AAAA,EAGA,MAAM,mBAAA,CACJ,KAAA,EACA,IAAA,EACA,IAAA,GAAwB,EAAC,EACA;AACzB,IAAA,MAAM,OAAA,GAAU,IAAA,CAAK,OAAA,CAAQ,IAAA,EAAM,KAAK,CAAA;AACxC,IAAA,MAAM,KAAA,GAAQ,IAAA,CAAK,KAAA,CAAM,IAAI,CAAA;AAC7B,IAAA,OAAO,IAAA,CAAK,GAAA,CAAI,IAAA,CAAK,OAAA,CAAwB;AAAA,MAC3C,MAAA,EAAQ,MAAA;AAAA,MACR,IAAA,EAAM,CAAA,UAAA,EAAa,IAAA,CAAK,GAAA,CAAI,MAAM,CAAA,gBAAA,CAAA;AAAA,MAClC,IAAA,EAAM,WAAA,CAAY,IAAA,EAAM,KAAK,CAAA;AAAA,MAC7B,GAAI,KAAA,GAAQ,EAAE,KAAA,KAAU,EAAC;AAAA,MACzB,GAAI,OAAA,GAAU,EAAE,OAAA,KAAY,EAAC;AAAA,MAC7B,IAAA,EAAM;AAAA,KACP,CAAA;AAAA,EACH;AACF","file":"checkout.cjs","sourcesContent":["/** Keys whose values are stripped from any serialised error body. */\nconst REDACTED_BODY_KEYS = new Set([\n  \"access_token\", \"refresh_token\", \"token\", \"customertoken\", \"saastoken\",\n  \"secret\", \"client_secret\", \"authorization\", \"password\",\n]);\n\nfunction scrub(body: unknown): unknown {\n  if (Array.isArray(body)) return body.map(scrub);\n  if (body && typeof body === \"object\") {\n    const out: Record<string, unknown> = {};\n    for (const [k, v] of Object.entries(body as Record<string, unknown>)) {\n      out[k] = REDACTED_BODY_KEYS.has(k.toLowerCase()) ? \"***redacted***\" : scrub(v);\n    }\n    return out;\n  }\n  return body;\n}\n\n/** Base class for every error thrown by the SDK. */\nexport class EmporixError extends Error {\n  readonly status: number | undefined;\n  readonly body: unknown;\n  constructor(message: string, status?: number, body?: unknown) {\n    super(message);\n    this.name = new.target.name;\n    this.status = status;\n    this.body = body;\n    Object.setPrototypeOf(this, new.target.prototype);\n  }\n  /** Safe serialisation — token-like body fields are redacted. */\n  toJSON(): Record<string, unknown> {\n    return { name: this.name, message: this.message, status: this.status, body: scrub(this.body) };\n  }\n}\n\n/** 401 — authentication failed or token expired. */\nexport class EmporixAuthError extends EmporixError {}\n/** 403 — authenticated but not permitted. */\nexport class EmporixForbiddenError extends EmporixError {}\n/** 404 — resource not found. */\nexport class EmporixNotFoundError extends EmporixError {}\n/** 400/422 — request validation failed. */\nexport class EmporixValidationError extends EmporixError {}\n/** 5xx — server-side failure. */\nexport class EmporixServerError extends EmporixError {}\n\n/**\n * 403 with a `missing scope: <name>` hint in the body's `details` array.\n * Subclasses {@link EmporixForbiddenError} so existing 403 catches still work.\n */\nexport class EmporixInsufficientScopeError extends EmporixForbiddenError {\n  readonly requiredScope: string | undefined;\n  constructor(message: string, status: number, body: unknown, requiredScope?: string) {\n    super(message, status, body);\n    this.requiredScope = requiredScope;\n  }\n}\n\nconst SCOPE_HINT_RE = /missing scope[: ]+([a-z0-9._-]+)/i;\n\nfunction extractRequiredScope(body: unknown): string | undefined {\n  if (body && typeof body === \"object\" && \"details\" in body) {\n    const details = (body as { details?: unknown }).details;\n    if (Array.isArray(details)) {\n      for (const d of details) {\n        if (typeof d === \"string\") {\n          const m = d.match(SCOPE_HINT_RE);\n          if (m) return m[1];\n        }\n      }\n    }\n  }\n  return undefined;\n}\n\n/** Maps an HTTP status to the matching {@link EmporixError} subclass. */\nexport function errorFromResponse(status: number, message: string, body: unknown): EmporixError {\n  if (status === 401) return new EmporixAuthError(message, status, body);\n  if (status === 403) {\n    const scope = extractRequiredScope(body);\n    if (scope) return new EmporixInsufficientScopeError(message, status, body, scope);\n    return new EmporixForbiddenError(message, status, body);\n  }\n  if (status === 404) return new EmporixNotFoundError(message, status, body);\n  if (status === 400 || status === 422) return new EmporixValidationError(message, status, body);\n  if (status >= 500) return new EmporixServerError(message, status, body);\n  return new EmporixError(message, status, body);\n}\n","import type { ClientContext } from \"../core/context\";\nimport type { AuthContext } from \"../core/auth\";\nimport { EmporixAuthError } from \"../core/errors\";\nimport type {\n  ResponseCheckout,\n  RequestCheckout,\n  RequestFromQuoteCheckout,\n  CustomerJson,\n} from \"../generated/checkout\";\n\n/** `requestCheckout` body (cart-based, generated). */\nexport type CheckoutInput = RequestCheckout;\n\n/** `requestFromQuoteCheckout` body (quote-based, generated). */\nexport type QuoteCheckoutInput = RequestFromQuoteCheckout;\n\n/** `responseCheckout` — the full generated checkout response. */\nexport type CheckoutResult = ResponseCheckout;\n\n/** Options for a checkout call. */\nexport interface CheckoutOptions {\n  /** Customer `saasToken` from `customers.login()` — required for logged-in checkout. */\n  saasToken?: string;\n  /** Site code (`?siteCode=`). */\n  siteCode?: string;\n}\n\nfunction isGuest(customer: CustomerJson | undefined): boolean {\n  return customer?.guest === true;\n}\n\nfunction resolveAuth(auth: AuthContext | undefined, guest: boolean): AuthContext {\n  if (auth && (auth.kind === \"customer\" || auth.kind === \"raw\")) return auth;\n  if (guest && auth && auth.kind === \"anonymous\") return auth;\n  throw new EmporixAuthError(\n    \"checkout requires a customer/raw AuthContext (or anonymous for a guest checkout)\",\n  );\n}\n\n/** Triggers Emporix checkout (atomic: validate → order → payment → close cart). */\nexport class CheckoutService {\n  constructor(private readonly ctx: ClientContext) {}\n\n  private headers(opts: CheckoutOptions, guest: boolean): Record<string, string> | undefined {\n    if (guest || !opts.saasToken) return undefined;\n    return { \"saas-token\": opts.saasToken };\n  }\n\n  private query(opts: CheckoutOptions): Record<string, string> | undefined {\n    return opts.siteCode ? { siteCode: opts.siteCode } : undefined;\n  }\n\n  /** Checkout from a cart. Requires customer/raw auth (or anonymous for guest). */\n  async placeOrder(\n    input: CheckoutInput,\n    auth?: AuthContext,\n    opts: CheckoutOptions = {},\n  ): Promise<CheckoutResult> {\n    const guest = isGuest(input.customer);\n    const headers = this.headers(opts, guest);\n    const query = this.query(opts);\n    return this.ctx.http.request<CheckoutResult>({\n      method: \"POST\",\n      path: `/checkout/${this.ctx.tenant}/checkouts/order`,\n      auth: resolveAuth(auth, guest),\n      ...(query ? { query } : {}),\n      ...(headers ? { headers } : {}),\n      body: input,\n    });\n  }\n\n  /** Checkout from a quote. */\n  async placeOrderFromQuote(\n    input: QuoteCheckoutInput,\n    auth?: AuthContext,\n    opts: CheckoutOptions = {},\n  ): Promise<CheckoutResult> {\n    const headers = this.headers(opts, false);\n    const query = this.query(opts);\n    return this.ctx.http.request<CheckoutResult>({\n      method: \"POST\",\n      path: `/checkout/${this.ctx.tenant}/checkouts/order`,\n      auth: resolveAuth(auth, false),\n      ...(query ? { query } : {}),\n      ...(headers ? { headers } : {}),\n      body: input,\n    });\n  }\n}\n"]}

package/dist/checkout.d.cts

@@ -0,0 +1,252 @@
+import { C as ClientContext, b as AuthContext } from './context-vKgzZ-5f.cjs';
+
+/**
+ * Information about the customer's address.
+ */
+type AddressJson = {
+    /**
+     * Contact name
+     */
+    contactName: string;
+    /**
+     * Company name
+     */
+    companyName?: string;
+    /**
+     * Street
+     */
+    street: string;
+    /**
+     * Street number
+     */
+    streetNumber?: string;
+    /**
+     * Street appendix
+     */
+    streetAppendix?: string;
+    /**
+     * zip code
+     */
+    zipCode: string;
+    /**
+     * City
+     */
+    city: string;
+    /**
+     * Country
+     */
+    country: string;
+    /**
+     * State
+     */
+    state?: string;
+    /**
+     * Contact phone
+     */
+    contactPhone?: string;
+    /**
+     * Type of the address data, for example `BILLING` or `SHIPPING`.
+     */
+    type: string;
+    metadata?: MixinMetadataJson;
+    /**
+     * Mixins object
+     */
+    mixins?: {
+        [key: string]: unknown;
+    };
+};
+/**
+ * Information about the customer.
+ */
+type CustomerJson = {
+    /**
+     * Customers’s unique identifier generated when a customer’s account is created. Required only when checkout is done by a logged in customer.
+     */
+    id?: string;
+    /**
+     * Name
+     */
+    name?: string;
+    /**
+     * Title
+     */
+    title?: string;
+    /**
+     * First name. Providing either `firstName` or `lastName` is required.
+     */
+    firstName?: string;
+    /**
+     * Middle name
+     */
+    middleName?: string;
+    /**
+     * Last name. Providing either `firstName` or `lastName` is required.
+     */
+    lastName?: string;
+    /**
+     * Contact phone
+     */
+    contactPhone?: string;
+    /**
+     * Email
+     */
+    email: string;
+    /**
+     * Company name
+     */
+    company?: string;
+    metadata?: MixinMetadataJson;
+    /**
+     * Mixins object
+     */
+    mixins?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Indicates if the checkout is done by an anonymous customer (if true) or logged in customer (if false). Required only for guest checkout.
+     */
+    guest?: boolean;
+};
+type MixinMetadataJson = {
+    mixins?: {
+        [key: string]: unknown;
+    };
+};
+/**
+ * Schema for triggering a checkout.
+ */
+type RequestCheckout = {
+    /**
+     * Customer cart’s unique identifier generated when a cart is created.
+     */
+    cartId: string;
+    /**
+     * Methods chosen to process the payment for the order.
+     */
+    paymentMethods: Array<RequestPaymentMethodJson>;
+    /**
+     * Three-letter currency code, compliant with the ISO 4217 standard.
+     */
+    currency?: string;
+    shipping: ShippingJson;
+    /**
+     * List of addresses associated with the order. There must be at least one address of type `SHIPPING` and one address of type `BILLING`.
+     */
+    addresses: Array<AddressJson>;
+    customer: CustomerJson;
+};
+/**
+ * Schema for triggering a checkout from the quote.
+ */
+type RequestFromQuoteCheckout = {
+    /**
+     * The identifier of the quote.
+     */
+    quoteId: string;
+    /**
+     * Methods chosen to process the payment for the order.
+     */
+    paymentMethods: Array<RequestPaymentMethodJson>;
+    /**
+     * Delivery window's unique identifier.
+     */
+    deliveryWindowId?: string;
+};
+type RequestPaymentMethodJson = {
+    /**
+     * Payment provider, possible values:
+     * * `payment-gateway` - When the Emporix Payment-Gateway service should be used to handle a payment. For details about custom attributes that are required for a particular payment mode, check https://developer.emporix.io/user-guides/system-management/payment-gateway/payments.
+     * * `custom` - When a custom provider is used. In this case the created order has the `IN_CHECKOUT` status.
+     * * `none` - For payment by cash or invoice.
+     *
+     */
+    provider: string;
+    /**
+     * Additional information about the payment method.
+     */
+    customAttributes?: {
+        /**
+         * Payment token used for the tokenized credit card flows. The field is used when provider type is `payment-gateway`. For more details, check https://developer.emporix.io/user-guides/system-management/payment-gateway/payments
+         */
+        token?: string;
+        /**
+         * Identifier of a payment mode. The payment mode has to be configured in the Emporix Payment Gateway service beforehand. For more details, check https://developer.emporix.io/user-guides/system-management/payment-gateway/payments
+         */
+        modeId?: string;
+        /**
+         * Payment type chosen by the customer, for example `paymentByCredit` or `paymentByDebit`.
+         */
+        paymentType?: string;
+    };
+    /**
+     * Payment method chosen by the customer, for example `invoice` or `cash-on-delivery`.
+     */
+    method?: string;
+    /**
+     * Amount to be paid by the customer.
+     */
+    amount?: number;
+};
+type ResponseCheckout = {
+    /**
+     * Order’s unique identifier generated when a checkout is triggered.
+     */
+    orderId?: string;
+    paymentDetails?: {
+        [key: string]: unknown;
+    } | null;
+    checkoutId?: string | null;
+};
+/**
+ * Information about the shipping.
+ */
+type ShippingJson = {
+    /**
+     * Shipping method's unique identifier.
+     */
+    methodId: string;
+    /**
+     * Shipping zone identifier.
+     */
+    zoneId: string;
+    /**
+     * Shipping method chosen by the customer.
+     */
+    methodName: string;
+    /**
+     * Shipping cost.
+     */
+    amount: number;
+    /**
+     * The tax code of the shipping
+     */
+    shippingTaxCode?: string;
+};
+
+/** `requestCheckout` body (cart-based, generated). */
+type CheckoutInput = RequestCheckout;
+/** `requestFromQuoteCheckout` body (quote-based, generated). */
+type QuoteCheckoutInput = RequestFromQuoteCheckout;
+/** `responseCheckout` — the full generated checkout response. */
+type CheckoutResult = ResponseCheckout;
+/** Options for a checkout call. */
+interface CheckoutOptions {
+    /** Customer `saasToken` from `customers.login()` — required for logged-in checkout. */
+    saasToken?: string;
+    /** Site code (`?siteCode=`). */
+    siteCode?: string;
+}
+/** Triggers Emporix checkout (atomic: validate → order → payment → close cart). */
+declare class CheckoutService {
+    private readonly ctx;
+    constructor(ctx: ClientContext);
+    private headers;
+    private query;
+    /** Checkout from a cart. Requires customer/raw auth (or anonymous for guest). */
+    placeOrder(input: CheckoutInput, auth?: AuthContext, opts?: CheckoutOptions): Promise<CheckoutResult>;
+    /** Checkout from a quote. */
+    placeOrderFromQuote(input: QuoteCheckoutInput, auth?: AuthContext, opts?: CheckoutOptions): Promise<CheckoutResult>;
+}
+
+export { type CheckoutInput, type CheckoutOptions, type CheckoutResult, CheckoutService, type QuoteCheckoutInput };