@viu/emporix-sdk 1.0.0

package/dist/segment.d.cts

@@ -0,0 +1,241 @@
+import { C as ClientContext, b as AuthContext, P as PaginatedItems } from './context-vKgzZ-5f.cjs';
+import { ProductService } from './product.cjs';
+import { CategoryService } from './category.cjs';
+
+type CommonSegment = {
+    /**
+     * Localized name of the customer segment.
+     */
+    name: {
+        [key: string]: string;
+    };
+    /**
+     * Localized description of the customer segment.
+     */
+    description?: {
+        [key: string]: string;
+    };
+    /**
+     * Determines the time frame in which the customer segment is valid.
+     */
+    validity?: {
+        from?: string;
+        to?: string;
+    };
+    /**
+     * Determines whether the customer segment is active or not. If not provided the value is set to `INACTIVE`
+     */
+    status?: 'ACTIVE' | 'INACTIVE';
+    /**
+     * Determines for which site the customer segment is available.
+     */
+    siteCode: string;
+    /**
+     * A key-value map of additional attributes.
+     */
+    mixins?: {
+        [key: string]: unknown;
+    };
+} & {
+    metadata?: MetadataCreate;
+};
+type SegmentUpdate = CommonSegment & {
+    metadata?: MetadataUpdate;
+};
+type SegmentUpdateBulk = {
+    /**
+     * Unique identifier of the customer segment.
+     */
+    id?: string;
+} & SegmentUpdate;
+type SegmentResponse = SegmentUpdateBulk & {
+    metadata?: MetadataResponse;
+};
+type ItemAssignmentUpsert = {
+    /**
+     * A key-value map of additional attributes.
+     */
+    mixins?: {
+        [key: string]: unknown;
+    };
+} & {
+    metadata?: MetadataUpdate;
+};
+type ItemAssignmentResponse = {
+    /**
+     * Unique identifier of the customer segment.
+     */
+    segmentId?: string;
+    item?: {
+        /**
+         * Unique identifier of an existing product/category.
+         */
+        id?: string;
+        /**
+         * Unique code of an existing product/category.
+         */
+        code?: string;
+        /**
+         * Localized name of the product/category
+         */
+        name?: {
+            [key: string]: string;
+        };
+    };
+    /**
+     * Determines whether item is a `PRODUCT` or `CATEGORY`
+     */
+    type?: 'PRODUCT' | 'CATEGORY';
+} & ItemAssignmentUpsert & {
+    metadata?: MetadataResponse;
+};
+type CategoryTreeResponse = Array<{
+    /**
+     * Unique identifier of an existing category.
+     */
+    id: string;
+    /**
+     * Unique code of an existing category.
+     */
+    code: string;
+    /**
+     * Localized name of the category.
+     */
+    name: {
+        [key: string]: string;
+    };
+    /**
+     * Localized description of the category.
+     */
+    localizedDescription?: {
+        [key: string]: string;
+    };
+    /**
+     * Localized category name or code without diacritics for the URL.
+     */
+    localizedSlug?: {
+        [key: string]: string;
+    };
+    /**
+     * List of external category numbers (ECNs) unique for every category.
+     */
+    ecn?: Array<string>;
+    /**
+     * Indicates the time frame in which the category is valid.
+     */
+    validity?: {
+        from?: string;
+        to?: string;
+    };
+    /**
+     * Category's position, set in relation to the categories on the same level (sharing the same parent) in the tree.
+     */
+    position?: number;
+    /**
+     * Indicates whether the category has been published or not.
+     */
+    published?: boolean;
+    /**
+     * Indicates if the category is assigned to any segment.
+     */
+    isSegmentAssigned: boolean;
+    subcategories?: Array<{
+        [key: string]: unknown;
+    }>;
+}>;
+type MetadataCreate = {
+    /**
+     * A key-value map, where key is a mixin name and value is a link to the mixin schema.
+     */
+    mixins?: {
+        [key: string]: unknown;
+    };
+};
+type MetadataUpdate = {
+    /**
+     * The document version number.
+     */
+    version?: number;
+} & MetadataCreate;
+type MetadataResponse = {
+    /**
+     * The creation date.
+     */
+    createdAt?: string;
+    /**
+     * The modification date.
+     */
+    modifiedAt?: string;
+} & MetadataUpdate;
+
+/** Generated segment types (read shapes — storefront `segment_read_own`). */
+type Segment = SegmentResponse;
+type SegmentItem = ItemAssignmentResponse;
+type SegmentCategoryTree = CategoryTreeResponse;
+type SegmentCategoryTreeNode = CategoryTreeResponse[number];
+/** Cross-service hydrate dependencies, injected from `EmporixClient`. */
+interface SegmentServiceDeps {
+    products: ProductService;
+    categories: CategoryService;
+}
+/**
+ * Customer-segment reads. Every method requires a customer/raw
+ * `AuthContext` — the `segment_read_own` scope is on the customer token.
+ * The standard product/category endpoints do **not** auto-filter by
+ * segment; the storefront uses these reads to discover what to fetch.
+ */
+declare class SegmentService {
+    private readonly ctx;
+    private readonly deps;
+    constructor(ctx: ClientContext, deps: SegmentServiceDeps);
+    private base;
+    /** Lists segments the caller belongs to (with `segment_read_own`). */
+    list(query?: {
+        q?: string;
+        pageNumber?: number;
+        pageSize?: number;
+    }, auth?: AuthContext): Promise<Segment[]>;
+    /** Fetches a single segment by id. */
+    get(segmentId: string, auth?: AuthContext): Promise<Segment>;
+    /** Item assignments (PRODUCT + CATEGORY) across all the caller's active segments. */
+    listItems(query?: {
+        q?: string;
+        siteCode?: string;
+        legalEntityId?: string;
+        onlyActive?: boolean;
+        pageNumber?: number;
+        pageSize?: number;
+    }, auth?: AuthContext): Promise<SegmentItem[]>;
+    /** Item assignments of one specific segment. */
+    listSegmentItems(segmentId: string, query?: {
+        q?: string;
+        legalEntityId?: string;
+        pageNumber?: number;
+        pageSize?: number;
+    }, auth?: AuthContext): Promise<SegmentItem[]>;
+    /** Category tree built only from the caller's active segments. */
+    getCategoryTree(query?: {
+        siteCode?: string;
+        legalEntityId?: string;
+    }, auth?: AuthContext): Promise<SegmentCategoryTree>;
+    private pickItemIds;
+    /** Product ids assigned to the caller's active segments. */
+    listMyProductIds(query?: Parameters<SegmentService["listItems"]>[0], auth?: AuthContext): Promise<string[]>;
+    /** Category ids assigned to the caller's active segments. */
+    listMyCategoryIds(query?: Parameters<SegmentService["listItems"]>[0], auth?: AuthContext): Promise<string[]>;
+    /**
+     * Hydrates `listMyProductIds` via `ProductService.get` in parallel.
+     * Resolves in the same order as the id list. Any single failure rejects
+     * the whole batch (`Promise.all`); use the id-list method + your own
+     * tolerance strategy if partial success matters.
+     */
+    listMyProducts(query?: Parameters<SegmentService["listItems"]>[0], auth?: AuthContext): Promise<PaginatedItems<Awaited<ReturnType<ProductService["get"]>>>>;
+    /**
+     * Hydrates a page of the caller's segment CATEGORY assignments into
+     * real categories via one bulk `categories.searchByIds` call. Same
+     * `hasNextPage` semantic as `listMyProducts`.
+     */
+    listMyCategories(query?: Parameters<SegmentService["listItems"]>[0], auth?: AuthContext): Promise<PaginatedItems<Awaited<ReturnType<CategoryService["get"]>>>>;
+}
+
+export { type Segment, type SegmentCategoryTree, type SegmentCategoryTreeNode, type SegmentItem, SegmentService, type SegmentServiceDeps };

package/dist/segment.d.ts

@@ -0,0 +1,241 @@
+import { C as ClientContext, b as AuthContext, P as PaginatedItems } from './context-vKgzZ-5f.js';
+import { ProductService } from './product.js';
+import { CategoryService } from './category.js';
+
+type CommonSegment = {
+    /**
+     * Localized name of the customer segment.
+     */
+    name: {
+        [key: string]: string;
+    };
+    /**
+     * Localized description of the customer segment.
+     */
+    description?: {
+        [key: string]: string;
+    };
+    /**
+     * Determines the time frame in which the customer segment is valid.
+     */
+    validity?: {
+        from?: string;
+        to?: string;
+    };
+    /**
+     * Determines whether the customer segment is active or not. If not provided the value is set to `INACTIVE`
+     */
+    status?: 'ACTIVE' | 'INACTIVE';
+    /**
+     * Determines for which site the customer segment is available.
+     */
+    siteCode: string;
+    /**
+     * A key-value map of additional attributes.
+     */
+    mixins?: {
+        [key: string]: unknown;
+    };
+} & {
+    metadata?: MetadataCreate;
+};
+type SegmentUpdate = CommonSegment & {
+    metadata?: MetadataUpdate;
+};
+type SegmentUpdateBulk = {
+    /**
+     * Unique identifier of the customer segment.
+     */
+    id?: string;
+} & SegmentUpdate;
+type SegmentResponse = SegmentUpdateBulk & {
+    metadata?: MetadataResponse;
+};
+type ItemAssignmentUpsert = {
+    /**
+     * A key-value map of additional attributes.
+     */
+    mixins?: {
+        [key: string]: unknown;
+    };
+} & {
+    metadata?: MetadataUpdate;
+};
+type ItemAssignmentResponse = {
+    /**
+     * Unique identifier of the customer segment.
+     */
+    segmentId?: string;
+    item?: {
+        /**
+         * Unique identifier of an existing product/category.
+         */
+        id?: string;
+        /**
+         * Unique code of an existing product/category.
+         */
+        code?: string;
+        /**
+         * Localized name of the product/category
+         */
+        name?: {
+            [key: string]: string;
+        };
+    };
+    /**
+     * Determines whether item is a `PRODUCT` or `CATEGORY`
+     */
+    type?: 'PRODUCT' | 'CATEGORY';
+} & ItemAssignmentUpsert & {
+    metadata?: MetadataResponse;
+};
+type CategoryTreeResponse = Array<{
+    /**
+     * Unique identifier of an existing category.
+     */
+    id: string;
+    /**
+     * Unique code of an existing category.
+     */
+    code: string;
+    /**
+     * Localized name of the category.
+     */
+    name: {
+        [key: string]: string;
+    };
+    /**
+     * Localized description of the category.
+     */
+    localizedDescription?: {
+        [key: string]: string;
+    };
+    /**
+     * Localized category name or code without diacritics for the URL.
+     */
+    localizedSlug?: {
+        [key: string]: string;
+    };
+    /**
+     * List of external category numbers (ECNs) unique for every category.
+     */
+    ecn?: Array<string>;
+    /**
+     * Indicates the time frame in which the category is valid.
+     */
+    validity?: {
+        from?: string;
+        to?: string;
+    };
+    /**
+     * Category's position, set in relation to the categories on the same level (sharing the same parent) in the tree.
+     */
+    position?: number;
+    /**
+     * Indicates whether the category has been published or not.
+     */
+    published?: boolean;
+    /**
+     * Indicates if the category is assigned to any segment.
+     */
+    isSegmentAssigned: boolean;
+    subcategories?: Array<{
+        [key: string]: unknown;
+    }>;
+}>;
+type MetadataCreate = {
+    /**
+     * A key-value map, where key is a mixin name and value is a link to the mixin schema.
+     */
+    mixins?: {
+        [key: string]: unknown;
+    };
+};
+type MetadataUpdate = {
+    /**
+     * The document version number.
+     */
+    version?: number;
+} & MetadataCreate;
+type MetadataResponse = {
+    /**
+     * The creation date.
+     */
+    createdAt?: string;
+    /**
+     * The modification date.
+     */
+    modifiedAt?: string;
+} & MetadataUpdate;
+
+/** Generated segment types (read shapes — storefront `segment_read_own`). */
+type Segment = SegmentResponse;
+type SegmentItem = ItemAssignmentResponse;
+type SegmentCategoryTree = CategoryTreeResponse;
+type SegmentCategoryTreeNode = CategoryTreeResponse[number];
+/** Cross-service hydrate dependencies, injected from `EmporixClient`. */
+interface SegmentServiceDeps {
+    products: ProductService;
+    categories: CategoryService;
+}
+/**
+ * Customer-segment reads. Every method requires a customer/raw
+ * `AuthContext` — the `segment_read_own` scope is on the customer token.
+ * The standard product/category endpoints do **not** auto-filter by
+ * segment; the storefront uses these reads to discover what to fetch.
+ */
+declare class SegmentService {
+    private readonly ctx;
+    private readonly deps;
+    constructor(ctx: ClientContext, deps: SegmentServiceDeps);
+    private base;
+    /** Lists segments the caller belongs to (with `segment_read_own`). */
+    list(query?: {
+        q?: string;
+        pageNumber?: number;
+        pageSize?: number;
+    }, auth?: AuthContext): Promise<Segment[]>;
+    /** Fetches a single segment by id. */
+    get(segmentId: string, auth?: AuthContext): Promise<Segment>;
+    /** Item assignments (PRODUCT + CATEGORY) across all the caller's active segments. */
+    listItems(query?: {
+        q?: string;
+        siteCode?: string;
+        legalEntityId?: string;
+        onlyActive?: boolean;
+        pageNumber?: number;
+        pageSize?: number;
+    }, auth?: AuthContext): Promise<SegmentItem[]>;
+    /** Item assignments of one specific segment. */
+    listSegmentItems(segmentId: string, query?: {
+        q?: string;
+        legalEntityId?: string;
+        pageNumber?: number;
+        pageSize?: number;
+    }, auth?: AuthContext): Promise<SegmentItem[]>;
+    /** Category tree built only from the caller's active segments. */
+    getCategoryTree(query?: {
+        siteCode?: string;
+        legalEntityId?: string;
+    }, auth?: AuthContext): Promise<SegmentCategoryTree>;
+    private pickItemIds;
+    /** Product ids assigned to the caller's active segments. */
+    listMyProductIds(query?: Parameters<SegmentService["listItems"]>[0], auth?: AuthContext): Promise<string[]>;
+    /** Category ids assigned to the caller's active segments. */
+    listMyCategoryIds(query?: Parameters<SegmentService["listItems"]>[0], auth?: AuthContext): Promise<string[]>;
+    /**
+     * Hydrates `listMyProductIds` via `ProductService.get` in parallel.
+     * Resolves in the same order as the id list. Any single failure rejects
+     * the whole batch (`Promise.all`); use the id-list method + your own
+     * tolerance strategy if partial success matters.
+     */
+    listMyProducts(query?: Parameters<SegmentService["listItems"]>[0], auth?: AuthContext): Promise<PaginatedItems<Awaited<ReturnType<ProductService["get"]>>>>;
+    /**
+     * Hydrates a page of the caller's segment CATEGORY assignments into
+     * real categories via one bulk `categories.searchByIds` call. Same
+     * `hasNextPage` semantic as `listMyProducts`.
+     */
+    listMyCategories(query?: Parameters<SegmentService["listItems"]>[0], auth?: AuthContext): Promise<PaginatedItems<Awaited<ReturnType<CategoryService["get"]>>>>;
+}
+
+export { type Segment, type SegmentCategoryTree, type SegmentCategoryTreeNode, type SegmentItem, SegmentService, type SegmentServiceDeps };

package/dist/segment.js

@@ -0,0 +1,5 @@
+export { SegmentService } from './chunk-Z6PNI5VT.js';
+import './chunk-BFQ732VZ.js';
+import './chunk-KTODT6DV.js';
+//# sourceMappingURL=segment.js.map
+//# sourceMappingURL=segment.js.map

package/dist/segment.js.map

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

package/dist/types.gen-D1QuqPLs.d.cts

@@ -0,0 +1,166 @@
+/**
+ * Hand-written mirror of the Customer Management Service OpenAPI 0.0.1
+ * schemas. The shapes below are taken directly from the documented API
+ * (Legal Entities, Contact Assignments, Locations endpoints).
+ *
+ * **Not generated.** When the OpenAPI input file lands in the repo, this
+ * file is replaced by codegen output. Keep the exported names stable so the
+ * façade re-exports don't churn.
+ */
+type LegalEntityType = "COMPANY" | "SUBSIDIARY";
+interface AccountLimit {
+    currency?: string;
+    value?: number;
+}
+interface LegalInfo {
+    legalName?: string;
+    registrationDate?: string;
+    taxRegistrationNumber?: string;
+    registrationAgency?: string;
+    countryOfRegistration?: string;
+    registrationId?: string;
+}
+interface CustomerGroupRef {
+    id: string;
+    name?: Record<string, string>;
+    role?: string;
+}
+interface ResourceId {
+    id: string;
+}
+interface Metadata {
+    version?: number;
+    createdAt?: string;
+    modifiedAt?: string;
+    mixins?: Record<string, unknown>;
+}
+interface LegalEntity {
+    id: string;
+    name: string;
+    type: LegalEntityType;
+    parentId?: string;
+    accountLimit?: AccountLimit;
+    legalInfo?: LegalInfo;
+    customerGroups?: CustomerGroupRef[];
+    entitiesAddresses?: ResourceId[];
+    approvalGroup?: ResourceId[];
+    restrictions?: string[];
+    metadata?: Metadata;
+    mixins?: Record<string, unknown>;
+}
+interface LegalEntityCreate {
+    id?: string;
+    name: string;
+    type?: LegalEntityType;
+    parentId?: string;
+    accountLimit?: AccountLimit;
+    legalInfo?: LegalInfo;
+    customerGroups?: CustomerGroupRef[];
+    entitiesAddresses?: ResourceId[];
+    approvalGroup?: ResourceId[];
+    restrictions?: string[];
+    metadata?: {
+        mixins?: Record<string, unknown>;
+    };
+    mixins?: Record<string, unknown>;
+}
+interface LegalEntityUpdate {
+    name?: string;
+    parentId?: string;
+    accountLimit?: AccountLimit;
+    legalInfo?: LegalInfo;
+    customerGroups?: CustomerGroupRef[];
+    entitiesAddresses?: ResourceId[];
+    approvalGroup?: ResourceId[];
+    restrictions?: string[];
+    metadata?: {
+        version: number;
+        mixins?: Record<string, unknown>;
+    };
+    mixins?: Record<string, unknown>;
+}
+type ContactAssignmentType = "PRIMARY" | "BILLING" | "LOGISTICS" | "CONTACT";
+interface ContactAssignment {
+    id: string;
+    legalEntity?: LegalEntity | {
+        id: string;
+    };
+    customer?: {
+        id: string;
+        name?: string;
+        surname?: string;
+        email?: string;
+        phone?: string;
+    };
+    type?: ContactAssignmentType;
+    primary?: boolean;
+    metadata?: Metadata;
+    mixins?: Record<string, unknown>;
+}
+interface ContactAssignmentCreate {
+    id?: string;
+    legalEntity: {
+        id: string;
+    };
+    customer: {
+        id: string;
+    };
+    type?: ContactAssignmentType;
+    primary?: boolean;
+    metadata?: {
+        mixins?: Record<string, unknown>;
+    };
+    mixins?: Record<string, unknown>;
+}
+interface ContactAssignmentUpdate {
+    type?: ContactAssignmentType;
+    primary?: boolean;
+    metadata?: {
+        version: number;
+        mixins?: Record<string, unknown>;
+    };
+    mixins?: Record<string, unknown>;
+}
+type LocationType = "HEADQUARTER" | "WAREHOUSE" | "OFFICE";
+interface ContactDetails {
+    emails?: string[];
+    phones?: string[];
+    addressLine1?: string;
+    addressLine2?: string;
+    city?: string;
+    state?: string;
+    postcode?: string;
+    countryCode?: string;
+    tags?: string[];
+}
+interface Location {
+    id: string;
+    name: string;
+    type: LocationType;
+    contactDetails?: ContactDetails;
+    metadata?: Metadata;
+    mixins?: Record<string, unknown>;
+}
+interface LocationCreate {
+    id?: string;
+    legalEntityId: string;
+    name: string;
+    type: LocationType;
+    contactDetails?: ContactDetails;
+    metadata?: {
+        mixins?: Record<string, unknown>;
+    };
+    mixins?: Record<string, unknown>;
+}
+interface LocationUpdate {
+    name?: string;
+    type?: LocationType;
+    contactDetails?: ContactDetails;
+    metadata?: {
+        version: number;
+        mixins?: Record<string, unknown>;
+    };
+    mixins?: Record<string, unknown>;
+}
+
+export type { AccountLimit as A, ContactAssignment as C, LegalEntity as L, ContactAssignmentCreate as a, ContactAssignmentType as b, ContactAssignmentUpdate as c, ContactDetails as d, CustomerGroupRef as e, LegalEntityCreate as f, LegalEntityType as g, LegalEntityUpdate as h, LegalInfo as i, Location as j, LocationCreate as k, LocationType as l, LocationUpdate as m };