@viu/emporix-sdk 1.0.0

package/dist/index.d.cts

@@ -0,0 +1,218 @@
+import { C as ClientContext, b as AuthContext, T as TokenProvider, l as ResolvedConfig, E as EmporixConfig, h as LogLevel, m as ServiceName } from './context-vKgzZ-5f.cjs';
+export { A as AnonymousSession, a as AnonymousSessionStore, c as AuthKind, D as DEFAULT_HOST, d as DefaultTokenProvider, H as HttpClient, e as HttpClientOptions, L as LEVEL, f as LevelResolver, g as LogFields, i as Logger, j as LoggerConfig, k as LoggerObjectConfig, P as PaginatedItems, R as RequestOptions, S as ServiceCredentials, n as StorefrontCredentials, o as auth, p as createConsoleLogger, q as createNoopLogger, r as iterateAll, s as redact, t as resolveToken, v as validateConfig } from './context-vKgzZ-5f.cjs';
+import { CustomerService } from './customer.cjs';
+export { Address, AddressCreateInput, AddressUpdateInput, Customer, CustomerSession, CustomerSignupInput, CustomerUpdateInput, PasswordChangeInput, PasswordResetConfirmInput, PasswordResetRequestInput } from './customer.cjs';
+import { ProductService } from './product.cjs';
+export { Media, Product } from './product.cjs';
+import { CategoryService } from './category.cjs';
+export { Category, CategoryNode } from './category.cjs';
+import { CartService } from './cart.cjs';
+export { Cart, CartAddress, CartCreated, CartItemInput, CartItemUpdate, CreateCartInput } from './cart.cjs';
+import { CheckoutService } from './checkout.cjs';
+export { CheckoutInput, CheckoutOptions, CheckoutResult, QuoteCheckoutInput } from './checkout.cjs';
+import { PaymentGatewayService } from './payment.cjs';
+export { AuthorizePaymentInput, AuthorizePaymentResult, PaymentMode } from './payment.cjs';
+import { PriceService } from './price.cjs';
+export { PriceMatch, PriceMatchByContextInput, PriceMatchInput } from './price.cjs';
+import { MediaService } from './media.cjs';
+export { Asset, AssetCreateBlobInput, AssetCreateLinkInput, AssetRefId, AssetUpdateInput } from './media.cjs';
+import { SegmentService } from './segment.cjs';
+export { Segment, SegmentCategoryTree, SegmentCategoryTreeNode, SegmentItem, SegmentServiceDeps } from './segment.cjs';
+import { CompaniesService } from './companies.cjs';
+import { ContactsService } from './contacts.cjs';
+import { LocationsService } from './locations.cjs';
+import { CustomerGroupsService } from './customer-groups.cjs';
+export { IamGroup, IamGroupB2B } from './customer-groups.cjs';
+import { OrdersService, SalesOrdersService } from './orders.cjs';
+export { GetOrderOptions, ListMyOrdersOptions, Order, OrderAddress, OrderCustomer, OrderDelivery, OrderItem, OrderMetadata, OrderMoney, OrderPayment, OrderStatus, OrderTaxLine, OrderTransition, OrderTransitionOptions, SalesOrderPatch, UpdateSalesOrderOptions } from './orders.cjs';
+export { A as AccountLimit, C as ContactAssignment, a as ContactAssignmentCreate, b as ContactAssignmentType, c as ContactAssignmentUpdate, d as ContactDetails, e as CustomerGroupRef, L as LegalEntity, f as LegalEntityCreate, g as LegalEntityType, h as LegalEntityUpdate, i as LegalInfo, j as Location, k as LocationCreate, l as LocationType, m as LocationUpdate } from './types.gen-D1QuqPLs.cjs';
+
+/** Base class for every error thrown by the SDK. */
+declare class EmporixError extends Error {
+    readonly status: number | undefined;
+    readonly body: unknown;
+    constructor(message: string, status?: number, body?: unknown);
+    /** Safe serialisation — token-like body fields are redacted. */
+    toJSON(): Record<string, unknown>;
+}
+/** 401 — authentication failed or token expired. */
+declare class EmporixAuthError extends EmporixError {
+}
+/** 403 — authenticated but not permitted. */
+declare class EmporixForbiddenError extends EmporixError {
+}
+/** 404 — resource not found. */
+declare class EmporixNotFoundError extends EmporixError {
+}
+/** 400/422 — request validation failed. */
+declare class EmporixValidationError extends EmporixError {
+}
+/** 5xx — server-side failure. */
+declare class EmporixServerError extends EmporixError {
+}
+/**
+ * 403 with a `missing scope: <name>` hint in the body's `details` array.
+ * Subclasses {@link EmporixForbiddenError} so existing 403 catches still work.
+ */
+declare class EmporixInsufficientScopeError extends EmporixForbiddenError {
+    readonly requiredScope: string | undefined;
+    constructor(message: string, status: number, body: unknown, requiredScope?: string);
+}
+/** Maps an HTTP status to the matching {@link EmporixError} subclass. */
+declare function errorFromResponse(status: number, message: string, body: unknown): EmporixError;
+
+/**
+ * One site as returned by the Site Settings Service. Mirrors the public
+ * SiteDto schema with the fields a storefront actually consumes.
+ */
+interface Site {
+    code: string;
+    name: string;
+    active: boolean;
+    default: boolean;
+    includesTax?: boolean;
+    defaultLanguage: string;
+    languages: string[];
+    currency: string;
+    availableCurrencies?: string[];
+    homeBase: {
+        address: {
+            country: string;
+            zipCode: string;
+            street?: string;
+            city?: string;
+            state?: string;
+        };
+        timezone?: string;
+    };
+    shipToCountries: string[];
+    cartCalculationScale?: number;
+    metadata?: {
+        version?: number;
+    };
+}
+/**
+ * Read-only access to the tenant's site catalog. List returns active sites
+ * visible to the storefront context (the `site_manage` scope is only needed
+ * to read inactive sites).
+ */
+declare class SiteService {
+    private readonly ctx;
+    constructor(ctx: ClientContext);
+    /** Lists active sites. */
+    list(authCtx?: AuthContext): Promise<Site[]>;
+    /** Retrieves one site by code. */
+    get(code: string, authCtx?: AuthContext): Promise<Site>;
+    /**
+     * Returns the tenant's default site (the one with `default: true`).
+     * Throws if no default is configured — a tenant should always have one.
+     */
+    current(authCtx?: AuthContext): Promise<Site>;
+}
+
+/**
+ * One session context as returned by `GET /session-context/{tenant}/me/context`.
+ * Created server-side when the user creates a cart. Until then, the server
+ * returns 404 and {@link SessionContextService.get} resolves to `null`.
+ */
+interface SessionContext {
+    sessionId: string;
+    customerId?: string;
+    siteCode?: string;
+    currency?: string;
+    cartId?: string;
+    targetLocation?: string;
+    language?: string;
+    context?: Record<string, unknown>;
+    metadata?: {
+        version?: number;
+        createdAt?: string;
+        modifiedAt?: string;
+    };
+}
+/**
+ * Input for {@link SessionContextService.patch}. Only the listed fields are
+ * accepted by the server; everything else is ignored.
+ *
+ * If `version` is omitted, the service fetches the current version via GET
+ * before PATCHing (one extra round-trip). Pass it explicitly when you already
+ * know it (e.g. after a `get()` call earlier in the same flow).
+ */
+interface SessionContextPatch {
+    siteCode?: string;
+    currency?: string;
+    targetLocation?: string;
+    language?: string;
+    context?: Record<string, unknown>;
+    /** Override for optimistic-locking version. If omitted, GET resolves it. */
+    version?: number;
+}
+/**
+ * Session-context binding for the current storefront session. Both endpoints
+ * resolve the session-id from the `Authorization` token — no path/query
+ * parameter required.
+ */
+declare class SessionContextService {
+    private readonly ctx;
+    constructor(ctx: ClientContext);
+    /**
+     * Retrieves the current session context, or `null` when the server returns
+     * 404 (no session exists yet — the session-context is created server-side
+     * only after the user creates a cart).
+     */
+    get(authCtx?: AuthContext): Promise<SessionContext | null>;
+    /**
+     * Partially updates the current session context. Returns `true` when the
+     * PATCH was applied, `false` when there is no session context yet (the
+     * server returned 404 on the version-lookup GET, so there is nothing to
+     * update). Non-404 errors propagate.
+     */
+    patch(input: SessionContextPatch, authCtx?: AuthContext): Promise<boolean>;
+}
+
+/** The Emporix SDK entry point. One instance safely serves many concurrent shoppers. */
+declare class EmporixClient {
+    readonly customers: CustomerService;
+    readonly products: ProductService;
+    readonly categories: CategoryService;
+    readonly carts: CartService;
+    readonly checkout: CheckoutService;
+    readonly payments: PaymentGatewayService;
+    readonly prices: PriceService;
+    readonly media: MediaService;
+    readonly segments: SegmentService;
+    readonly sites: SiteService;
+    readonly sessionContext: SessionContextService;
+    readonly companies: CompaniesService;
+    readonly contacts: ContactsService;
+    readonly locations: LocationsService;
+    readonly customerGroups: CustomerGroupsService;
+    readonly orders: OrdersService;
+    readonly salesOrders: SalesOrdersService;
+    /** The validated tenant this client is bound to. */
+    readonly tenant: string;
+    /**
+     * The token provider in use by this client. Exposed so React/Next hosts can
+     * call `attachAnonymousStore` to wire session persistence. Treat as
+     * read-only — replacing it after construction is not supported.
+     */
+    readonly tokenProvider: TokenProvider;
+    /**
+     * The validated config used to construct this client. Exposed so React /
+     * Next hosts can read static settings such as `credentials.storefront.context`
+     * (siteCode, currency, targetLocation) without re-plumbing them through the
+     * Provider tree. Treat as read-only.
+     */
+    readonly config: ResolvedConfig;
+    private readonly resolver;
+    constructor(config: EmporixConfig);
+    /** Sets the runtime log level globally or for one service. */
+    setLogLevel(level: LogLevel, opts?: {
+        service?: ServiceName;
+        force?: boolean;
+    }): void;
+    /** Returns the effective log level for a service. */
+    getLogLevel(service: ServiceName): LogLevel;
+}
+
+export { AuthContext, CartService, CategoryService, CheckoutService, ClientContext, CompaniesService, ContactsService, CustomerGroupsService, CustomerService, EmporixAuthError, EmporixClient, EmporixConfig, EmporixError, EmporixForbiddenError, EmporixInsufficientScopeError, EmporixNotFoundError, EmporixServerError, EmporixValidationError, LocationsService, LogLevel, MediaService, OrdersService, PaymentGatewayService, PriceService, ProductService, ResolvedConfig, SalesOrdersService, SegmentService, ServiceName, type SessionContext, type SessionContextPatch, SessionContextService, type Site, SiteService, TokenProvider, errorFromResponse };

package/dist/index.d.ts

@@ -0,0 +1,218 @@
+import { C as ClientContext, b as AuthContext, T as TokenProvider, l as ResolvedConfig, E as EmporixConfig, h as LogLevel, m as ServiceName } from './context-vKgzZ-5f.js';
+export { A as AnonymousSession, a as AnonymousSessionStore, c as AuthKind, D as DEFAULT_HOST, d as DefaultTokenProvider, H as HttpClient, e as HttpClientOptions, L as LEVEL, f as LevelResolver, g as LogFields, i as Logger, j as LoggerConfig, k as LoggerObjectConfig, P as PaginatedItems, R as RequestOptions, S as ServiceCredentials, n as StorefrontCredentials, o as auth, p as createConsoleLogger, q as createNoopLogger, r as iterateAll, s as redact, t as resolveToken, v as validateConfig } from './context-vKgzZ-5f.js';
+import { CustomerService } from './customer.js';
+export { Address, AddressCreateInput, AddressUpdateInput, Customer, CustomerSession, CustomerSignupInput, CustomerUpdateInput, PasswordChangeInput, PasswordResetConfirmInput, PasswordResetRequestInput } from './customer.js';
+import { ProductService } from './product.js';
+export { Media, Product } from './product.js';
+import { CategoryService } from './category.js';
+export { Category, CategoryNode } from './category.js';
+import { CartService } from './cart.js';
+export { Cart, CartAddress, CartCreated, CartItemInput, CartItemUpdate, CreateCartInput } from './cart.js';
+import { CheckoutService } from './checkout.js';
+export { CheckoutInput, CheckoutOptions, CheckoutResult, QuoteCheckoutInput } from './checkout.js';
+import { PaymentGatewayService } from './payment.js';
+export { AuthorizePaymentInput, AuthorizePaymentResult, PaymentMode } from './payment.js';
+import { PriceService } from './price.js';
+export { PriceMatch, PriceMatchByContextInput, PriceMatchInput } from './price.js';
+import { MediaService } from './media.js';
+export { Asset, AssetCreateBlobInput, AssetCreateLinkInput, AssetRefId, AssetUpdateInput } from './media.js';
+import { SegmentService } from './segment.js';
+export { Segment, SegmentCategoryTree, SegmentCategoryTreeNode, SegmentItem, SegmentServiceDeps } from './segment.js';
+import { CompaniesService } from './companies.js';
+import { ContactsService } from './contacts.js';
+import { LocationsService } from './locations.js';
+import { CustomerGroupsService } from './customer-groups.js';
+export { IamGroup, IamGroupB2B } from './customer-groups.js';
+import { OrdersService, SalesOrdersService } from './orders.js';
+export { GetOrderOptions, ListMyOrdersOptions, Order, OrderAddress, OrderCustomer, OrderDelivery, OrderItem, OrderMetadata, OrderMoney, OrderPayment, OrderStatus, OrderTaxLine, OrderTransition, OrderTransitionOptions, SalesOrderPatch, UpdateSalesOrderOptions } from './orders.js';
+export { A as AccountLimit, C as ContactAssignment, a as ContactAssignmentCreate, b as ContactAssignmentType, c as ContactAssignmentUpdate, d as ContactDetails, e as CustomerGroupRef, L as LegalEntity, f as LegalEntityCreate, g as LegalEntityType, h as LegalEntityUpdate, i as LegalInfo, j as Location, k as LocationCreate, l as LocationType, m as LocationUpdate } from './types.gen-D1QuqPLs.js';
+
+/** Base class for every error thrown by the SDK. */
+declare class EmporixError extends Error {
+    readonly status: number | undefined;
+    readonly body: unknown;
+    constructor(message: string, status?: number, body?: unknown);
+    /** Safe serialisation — token-like body fields are redacted. */
+    toJSON(): Record<string, unknown>;
+}
+/** 401 — authentication failed or token expired. */
+declare class EmporixAuthError extends EmporixError {
+}
+/** 403 — authenticated but not permitted. */
+declare class EmporixForbiddenError extends EmporixError {
+}
+/** 404 — resource not found. */
+declare class EmporixNotFoundError extends EmporixError {
+}
+/** 400/422 — request validation failed. */
+declare class EmporixValidationError extends EmporixError {
+}
+/** 5xx — server-side failure. */
+declare class EmporixServerError extends EmporixError {
+}
+/**
+ * 403 with a `missing scope: <name>` hint in the body's `details` array.
+ * Subclasses {@link EmporixForbiddenError} so existing 403 catches still work.
+ */
+declare class EmporixInsufficientScopeError extends EmporixForbiddenError {
+    readonly requiredScope: string | undefined;
+    constructor(message: string, status: number, body: unknown, requiredScope?: string);
+}
+/** Maps an HTTP status to the matching {@link EmporixError} subclass. */
+declare function errorFromResponse(status: number, message: string, body: unknown): EmporixError;
+
+/**
+ * One site as returned by the Site Settings Service. Mirrors the public
+ * SiteDto schema with the fields a storefront actually consumes.
+ */
+interface Site {
+    code: string;
+    name: string;
+    active: boolean;
+    default: boolean;
+    includesTax?: boolean;
+    defaultLanguage: string;
+    languages: string[];
+    currency: string;
+    availableCurrencies?: string[];
+    homeBase: {
+        address: {
+            country: string;
+            zipCode: string;
+            street?: string;
+            city?: string;
+            state?: string;
+        };
+        timezone?: string;
+    };
+    shipToCountries: string[];
+    cartCalculationScale?: number;
+    metadata?: {
+        version?: number;
+    };
+}
+/**
+ * Read-only access to the tenant's site catalog. List returns active sites
+ * visible to the storefront context (the `site_manage` scope is only needed
+ * to read inactive sites).
+ */
+declare class SiteService {
+    private readonly ctx;
+    constructor(ctx: ClientContext);
+    /** Lists active sites. */
+    list(authCtx?: AuthContext): Promise<Site[]>;
+    /** Retrieves one site by code. */
+    get(code: string, authCtx?: AuthContext): Promise<Site>;
+    /**
+     * Returns the tenant's default site (the one with `default: true`).
+     * Throws if no default is configured — a tenant should always have one.
+     */
+    current(authCtx?: AuthContext): Promise<Site>;
+}
+
+/**
+ * One session context as returned by `GET /session-context/{tenant}/me/context`.
+ * Created server-side when the user creates a cart. Until then, the server
+ * returns 404 and {@link SessionContextService.get} resolves to `null`.
+ */
+interface SessionContext {
+    sessionId: string;
+    customerId?: string;
+    siteCode?: string;
+    currency?: string;
+    cartId?: string;
+    targetLocation?: string;
+    language?: string;
+    context?: Record<string, unknown>;
+    metadata?: {
+        version?: number;
+        createdAt?: string;
+        modifiedAt?: string;
+    };
+}
+/**
+ * Input for {@link SessionContextService.patch}. Only the listed fields are
+ * accepted by the server; everything else is ignored.
+ *
+ * If `version` is omitted, the service fetches the current version via GET
+ * before PATCHing (one extra round-trip). Pass it explicitly when you already
+ * know it (e.g. after a `get()` call earlier in the same flow).
+ */
+interface SessionContextPatch {
+    siteCode?: string;
+    currency?: string;
+    targetLocation?: string;
+    language?: string;
+    context?: Record<string, unknown>;
+    /** Override for optimistic-locking version. If omitted, GET resolves it. */
+    version?: number;
+}
+/**
+ * Session-context binding for the current storefront session. Both endpoints
+ * resolve the session-id from the `Authorization` token — no path/query
+ * parameter required.
+ */
+declare class SessionContextService {
+    private readonly ctx;
+    constructor(ctx: ClientContext);
+    /**
+     * Retrieves the current session context, or `null` when the server returns
+     * 404 (no session exists yet — the session-context is created server-side
+     * only after the user creates a cart).
+     */
+    get(authCtx?: AuthContext): Promise<SessionContext | null>;
+    /**
+     * Partially updates the current session context. Returns `true` when the
+     * PATCH was applied, `false` when there is no session context yet (the
+     * server returned 404 on the version-lookup GET, so there is nothing to
+     * update). Non-404 errors propagate.
+     */
+    patch(input: SessionContextPatch, authCtx?: AuthContext): Promise<boolean>;
+}
+
+/** The Emporix SDK entry point. One instance safely serves many concurrent shoppers. */
+declare class EmporixClient {
+    readonly customers: CustomerService;
+    readonly products: ProductService;
+    readonly categories: CategoryService;
+    readonly carts: CartService;
+    readonly checkout: CheckoutService;
+    readonly payments: PaymentGatewayService;
+    readonly prices: PriceService;
+    readonly media: MediaService;
+    readonly segments: SegmentService;
+    readonly sites: SiteService;
+    readonly sessionContext: SessionContextService;
+    readonly companies: CompaniesService;
+    readonly contacts: ContactsService;
+    readonly locations: LocationsService;
+    readonly customerGroups: CustomerGroupsService;
+    readonly orders: OrdersService;
+    readonly salesOrders: SalesOrdersService;
+    /** The validated tenant this client is bound to. */
+    readonly tenant: string;
+    /**
+     * The token provider in use by this client. Exposed so React/Next hosts can
+     * call `attachAnonymousStore` to wire session persistence. Treat as
+     * read-only — replacing it after construction is not supported.
+     */
+    readonly tokenProvider: TokenProvider;
+    /**
+     * The validated config used to construct this client. Exposed so React /
+     * Next hosts can read static settings such as `credentials.storefront.context`
+     * (siteCode, currency, targetLocation) without re-plumbing them through the
+     * Provider tree. Treat as read-only.
+     */
+    readonly config: ResolvedConfig;
+    private readonly resolver;
+    constructor(config: EmporixConfig);
+    /** Sets the runtime log level globally or for one service. */
+    setLogLevel(level: LogLevel, opts?: {
+        service?: ServiceName;
+        force?: boolean;
+    }): void;
+    /** Returns the effective log level for a service. */
+    getLogLevel(service: ServiceName): LogLevel;
+}
+
+export { AuthContext, CartService, CategoryService, CheckoutService, ClientContext, CompaniesService, ContactsService, CustomerGroupsService, CustomerService, EmporixAuthError, EmporixClient, EmporixConfig, EmporixError, EmporixForbiddenError, EmporixInsufficientScopeError, EmporixNotFoundError, EmporixServerError, EmporixValidationError, LocationsService, LogLevel, MediaService, OrdersService, PaymentGatewayService, PriceService, ProductService, ResolvedConfig, SalesOrdersService, SegmentService, ServiceName, type SessionContext, type SessionContextPatch, SessionContextService, type Site, SiteService, TokenProvider, errorFromResponse };