@viu/emporix-sdk 1.0.0

package/dist/customer.d.cts

@@ -0,0 +1,386 @@
+import { C as ClientContext, A as AnonymousSession, b as AuthContext } from './context-vKgzZ-5f.cjs';
+
+type AccountId = {
+    /**
+     * Customer email address.
+     */
+    id?: string;
+    /**
+     * Customer account unique identifier generated by an external identity provider.
+     *
+     * **Note**: This field is only applicable if the user has been registered through social login.
+     */
+    providerId?: string;
+};
+/**
+ * Customer address information.
+ */
+type Address$1 = {
+    /**
+     * Customer address' unique identifier generated when the address is added to the customer account.
+     */
+    id?: string;
+    contactName: string;
+    companyName?: string;
+    street?: string;
+    streetNumber?: string;
+    streetAppendix?: string;
+    extraLine1?: string;
+    extraLine2?: string;
+    extraLine3?: string;
+    extraLine4?: string;
+    zipCode?: string;
+    city?: string;
+    country?: string;
+    state?: string;
+    contactPhone?: string;
+    /**
+     * Flag indicating whether the address is the customer default address.
+     */
+    isDefault?: boolean;
+    tags?: Array<string>;
+    metadata?: DefaultDtoMetadata;
+    /**
+     * Customer address' additional properties.
+     */
+    mixins?: {
+        [key: string]: unknown;
+    };
+};
+type AddressCommonDto = AddressCreateDto & {
+    metadata?: DefaultDtoMetadata;
+};
+type AddressCreateDto = {
+    contactName?: string;
+    companyName?: string;
+    street?: string;
+    streetNumber?: string;
+    streetAppendix?: string;
+    extraLine1?: string;
+    extraLine2?: string;
+    extraLine3?: string;
+    extraLine4?: string;
+    zipCode?: string;
+    city?: string;
+    country?: string;
+    state?: string;
+    contactPhone?: string;
+    tags?: Array<string>;
+    metadata?: BasicMetadataDto;
+    /**
+     * Customer address' additional properties.
+     */
+    mixins?: {
+        [key: string]: unknown;
+    };
+};
+type AddressUpdateDto = AddressCommonDto & {
+    /**
+     * Flag indicating whether the address is the customer default address.
+     */
+    isDefault?: boolean;
+};
+/**
+ * Customer profile.
+ */
+type Customer$1 = {
+    /**
+     * Customer unique identifier generated when the customer profile is created.
+     */
+    id?: string;
+    /**
+     * Customer unique number generated when the customer profile is created.
+     */
+    customerNumber?: string;
+    title?: string;
+    firstName?: string;
+    middleName?: string;
+    lastName?: string;
+    contactEmail?: string;
+    contactPhone?: string;
+    company?: string;
+    /**
+     * Customer preferred language.
+     */
+    preferredLanguage?: string;
+    /**
+     * Customer's preferred currency, compliant with the ISO 4217 standard.
+     */
+    preferredCurrency?: string;
+    /**
+     * Customer preferred site.
+     */
+    preferredSite?: string;
+    /**
+     * List of accounts associated with the customer profile.
+     */
+    accounts?: Array<AccountId>;
+    /**
+     * List of customer addresses.
+     */
+    addresses?: Array<Address$1>;
+    defaultAddress?: Address$1;
+    /**
+     * Property indicating business model of customer. When customer is assigned to any company then it is `B2B`. Otherwise it is `B2C`.
+     */
+    businessModel?: 'B2B' | 'B2C';
+    b2b?: B2bGet;
+    /**
+     * Customer account additional properties.
+     */
+    mixins?: {
+        [key: string]: unknown;
+    };
+    metadata?: DefaultDtoMetadata;
+    /**
+     * Customer last login date.
+     */
+    lastLogin?: string;
+};
+type CustomerCommonDto = {
+    title?: string;
+    firstName?: string;
+    middleName?: string;
+    lastName?: string;
+    contactPhone?: string;
+    company?: string;
+    /**
+     * Customer preferred language.
+     */
+    preferredLanguage?: string;
+    /**
+     * Customer's preferred currency, compliant with the ISO 4217 standard.
+     */
+    preferredCurrency?: string;
+    /**
+     * Customer preferred site.
+     */
+    preferredSite?: string;
+    b2b?: B2bCreate;
+    metadata?: DefaultDtoMetadata;
+    /**
+     * Customer account additional properties.
+     */
+    mixins?: {
+        [key: string]: unknown;
+    };
+};
+/**
+ * Additional properties for B2B customer. If the `companyRegistrationId` property is provided, an additional validation for customer details executes - `firstName`, `lastName` and `company` values have to be provided.
+ */
+type B2bCreate = {
+    /**
+     * Registration number of the company.
+     */
+    companyRegistrationId?: string;
+};
+/**
+ * Additional properties for B2B customer. If the `companyRegistrationId` property is provided, an additional validation for customer details executes - `firstName`, `lastName` and `company` values have to be provided.
+ */
+type B2bGet = {
+    /**
+     * Registration number of the company.
+     */
+    companyRegistrationId?: string;
+    legalEntities?: Array<{
+        /**
+         * ID of legal entity.
+         */
+        id?: string;
+        /**
+         * Name of legal entity.
+         */
+        name?: string;
+        /**
+         * ID of contact assignment.
+         */
+        contactAssignmentId?: string;
+    }>;
+};
+type CustomerSignup = {
+    /**
+     * Customer email address.
+     */
+    email: string;
+    /**
+     * Customer account password.
+     */
+    password: string;
+    customerDetails?: CustomerUpdateDto;
+    customerAddress?: Address$1;
+    signup?: PasswordAuthentication;
+};
+type CustomerUpdateDto = CustomerCommonDto & {
+    contactEmail?: string;
+};
+/**
+ * Links to mixin schemas.
+ */
+type BasicMetadataDto = {
+    mixins?: {
+        [key: string]: unknown;
+    };
+};
+type DefaultDtoMetadata = BasicMetadataDto & {
+    version?: number;
+};
+type PasswordAuthentication = {
+    /**
+     * Customer email address.
+     */
+    email: string;
+    /**
+     * Customer account password.
+     */
+    password: string;
+};
+type PasswordChangeDto = {
+    /**
+     * Customer current account password.
+     */
+    currentPassword: string;
+    /**
+     * Customer new account password.
+     */
+    newPassword: string;
+};
+type PasswordResetRequestDto = {
+    /**
+     * Customer email address.
+     */
+    email: string;
+    /**
+     * Site from which password reset request was sent
+     */
+    site?: string;
+};
+type PasswordUpdate = {
+    /**
+     * Token received by the customer through email.
+     */
+    token: string;
+    /**
+     * Customer new account password.
+     */
+    password: string;
+};
+
+/**
+ * Caller-owned customer session. Maps the Emporix `CustomerToken` wire shape to
+ * idiomatic names: `access_token` → `customerToken`, `saas_token` →
+ * `saasToken`. `saasToken` is a JWT required for the checkout (`saas-token`
+ * header). The wire's `*_token` (snake_case) fields are canonical; the
+ * camelCase variants are deprecated in the Emporix spec.
+ */
+interface CustomerSession {
+    customerToken: string;
+    /** JWT required for completing checkout (sent as the `saas-token` header). */
+    saasToken: string;
+    refreshToken: string;
+    /** Same session as the anonymous token — preserves the cart across login. */
+    sessionId: string | undefined;
+    /** Customer access-token lifetime in seconds. */
+    expiresIn: number | undefined;
+    /** Only set by `socialLogin`: the IdP access token echoed by Emporix. */
+    socialAccessToken?: string;
+    /** Only set by `socialLogin`: the IdP ID token echoed by Emporix. */
+    socialIdToken?: string;
+}
+/** Customer profile as returned by the Customer service (all generated fields). */
+type Customer = Customer$1;
+/** A customer address as returned by the Customer service (all generated fields). */
+type Address = Address$1;
+/** Generated request bodies (caller sends the exact wire shape). */
+type CustomerSignupInput = CustomerSignup;
+type CustomerUpdateInput = CustomerUpdateDto;
+type PasswordChangeInput = PasswordChangeDto;
+type PasswordResetRequestInput = PasswordResetRequestDto;
+type PasswordResetConfirmInput = PasswordUpdate;
+type AddressCreateInput = AddressCreateDto;
+type AddressUpdateInput = AddressUpdateDto;
+/** Customer signup, session, profile and addresses. */
+declare class CustomerService {
+    private readonly ctx;
+    constructor(ctx: ClientContext);
+    /** Obtains an anonymous storefront session (accessToken + sessionId + refreshToken). */
+    anonymous(): Promise<AnonymousSession>;
+    /** Registers a customer. Default auth: anonymous. */
+    signup(input: CustomerSignupInput, auth?: AuthContext): Promise<Customer>;
+    /**
+     * Logs a customer in. Threads the anonymous token so the session (and its
+     * cart) survives — losing it silently creates a new session per Emporix docs.
+     * Wire `accessToken` is mapped to `customerToken`.
+     */
+    login(creds: {
+        email: string;
+        password: string;
+    }, opts?: {
+        anonymousToken?: string;
+    }, auth?: AuthContext): Promise<CustomerSession>;
+    /**
+     * Refreshes an authenticated customer session via its refresh token,
+     * preserving the same `sessionId`. Calls
+     * `GET /customer/{tenant}/refreshauthtoken?refreshToken=…`, which **must be
+     * authorized with an anonymous token** (default auth: anonymous) — not the
+     * expired customer token. The refresh response does **not** include a
+     * `saas_token`; pass the original `saasToken` to carry it forward (it has
+     * its own, independent lifetime).
+     */
+    refresh(input: {
+        refreshToken: string;
+        saasToken?: string;
+        legalEntityId?: string;
+    }, auth?: AuthContext): Promise<CustomerSession>;
+    /**
+     * Logs the customer out server-side: `GET /customer/{tenant}/logout?
+     * accessToken=…` authorized with the customer token. Invalidates the
+     * access token (204 No Content). Requires customer/raw auth — the token is
+     * sent both as the bearer and the `accessToken` query param (per Emporix).
+     */
+    logout(auth?: AuthContext): Promise<void>;
+    /**
+     * Authorization-Code SSO: exchanges the IdP `code` for an Emporix customer
+     * session via `POST /customer/{tenant}/socialLogin`. The browser performs
+     * the IdP redirect itself; the SDK only does this Emporix exchange.
+     * Default auth: anonymous (Emporix requires an anonymous Bearer). The
+     * response has no `session_id` and returns `expires_in` as a string —
+     * normalized to a number here.
+     */
+    socialLogin(input: {
+        code: string;
+        redirectUri: string;
+        codeVerifier?: string;
+        sessionId?: string;
+    }, auth?: AuthContext): Promise<CustomerSession>;
+    /**
+     * RFC 8693 token exchange: exchanges an external IdP JWT for an Emporix
+     * customer session via `POST /customer/{tenant}/exchangeauthtoken`.
+     * Emporix uses a proprietary query-param wire (not the RFC form body).
+     * Default auth: anonymous. `config` selects a site-specific IdP config
+     * (multi-site); omit for the tenant default. Returns `session_id` and a
+     * fresh `saas_token`; `expires_in` is an integer (normalized anyway).
+     */
+    exchangeToken(input: {
+        subjectToken: string;
+        config?: string;
+    }, auth?: AuthContext): Promise<CustomerSession>;
+    /** Returns the authenticated customer. Requires customer/raw auth. */
+    me(auth?: AuthContext): Promise<Customer>;
+    /** Updates the authenticated customer. Requires customer/raw auth. */
+    update(patch: CustomerUpdateInput, auth?: AuthContext): Promise<Customer>;
+    /** Changes the password. Requires customer/raw auth. */
+    changePassword(input: PasswordChangeInput, auth?: AuthContext): Promise<void>;
+    /** Requests a password reset email. Default auth: anonymous. */
+    requestPasswordReset(input: PasswordResetRequestInput, auth?: AuthContext): Promise<void>;
+    /** Confirms a password reset. Default auth: anonymous. */
+    confirmPasswordReset(input: PasswordResetConfirmInput, auth?: AuthContext): Promise<void>;
+    /** Address sub-resource. All operations require customer/raw auth. */
+    readonly addresses: {
+        list: (auth?: AuthContext) => Promise<Address[]>;
+        add: (address: AddressCreateInput, auth?: AuthContext) => Promise<Address>;
+        update: (id: string, patch: AddressUpdateInput, auth?: AuthContext) => Promise<Address>;
+        remove: (id: string, auth?: AuthContext) => Promise<void>;
+    };
+}
+
+export { type Address, type AddressCreateInput, type AddressUpdateInput, type Customer, CustomerService, type CustomerSession, type CustomerSignupInput, type CustomerUpdateInput, type PasswordChangeInput, type PasswordResetConfirmInput, type PasswordResetRequestInput };