@lana-commerce/core 11.0.0

package/types/json/common.d.ts

@@ -0,0 +1,81 @@
+import type { APIError } from "../generated/codes.js";
+export interface Extractor<T> {
+    [key: string]: (v: T) => any;
+}
+export interface Context {
+    [key: string]: any;
+}
+export interface RequestDetails {
+    url: string;
+    path: string;
+    status?: number;
+    uuid?: string;
+    authToken?: string;
+    locale?: string;
+    sessionID?: string;
+    salesChannelID?: string;
+    deviceID?: string;
+}
+export type SystemErrorType = "fetch_not_defined" | "timeout" | "no_status" | "bad_status" | "unrecognized_data_body" | "unrecognized_error_body";
+export type ResponseError = {
+    kind: "error";
+    error: APIError;
+    details: RequestDetails;
+} | {
+    kind: "system_error";
+    type: SystemErrorType;
+    details: RequestDetails;
+} | {
+    kind: "custom_error";
+    text: string;
+};
+export type Response<T> = {
+    kind: "data";
+    data: T;
+    details: RequestDetails;
+} | ResponseError;
+export type Method = "POST" | "GET" | "DELETE";
+export interface MethodAndPath {
+    method: Method;
+    path: string;
+}
+export interface APIRequest {
+    method: string;
+    url: string;
+    request?: any;
+    expansions?: string[];
+}
+export interface APIResponse {
+    status: number;
+    response?: any;
+    error?: APIError;
+}
+export declare function requestErrorPrefix(details: RequestDetails): string;
+export declare function prettyPrintResponseError(err: ResponseError, detailed?: boolean): string;
+declare class RequestBuilder {
+    private _ctx;
+    private _method;
+    private _path;
+    private _params;
+    private _status;
+    private _extract;
+    private _data;
+    private _expansionsSet;
+    constructor(ctx: Context, methodAndPath: string);
+    private expandRecursive;
+    expand(v: any): this;
+    expectStatus(v: number): this;
+    extract(v: Extractor<any>): this;
+    data(v: any): this;
+    clone(): RequestBuilder;
+    send(): Promise<Response<any>>;
+    sendUnwrap(): Promise<any>;
+}
+export declare function requestFunction(ctx: Context, methodAndPath: string): RequestBuilder;
+export declare function isExpanded<T extends {}>(v: T | {
+    id: string;
+} | null | undefined): v is T;
+export declare function assertExpanded<T extends {}>(v: T | {
+    id: string;
+} | null | undefined): T;
+export {};

package/types/json/fetchAllItems.d.ts

@@ -0,0 +1,15 @@
+import { Response, ResponseError } from "./common.js";
+export interface PageFetcher<T> {
+    last_key(v: string): PageFetcher<T>;
+    limit(v: number): PageFetcher<T>;
+    send(): Promise<Response<{
+        items: Array<T> | null;
+        last_key: string;
+    }>>;
+    clone(): PageFetcher<T>;
+}
+export declare function fetchAllItems<T>(fetcher: PageFetcher<T>): Promise<{
+    kind: "data";
+    data: T[];
+} | ResponseError>;
+export declare function iterAllItems<T>(fetcher: PageFetcher<T>): AsyncGenerator<Awaited<T>, void, unknown>;

package/types/json/mutator.d.ts

@@ -0,0 +1,238 @@
+/// <reference types="node" />
+import type { BrandModify, CategoryModify, ContentBlockModify, CouponCreate, CurrencyCreate, FileStorage, GatewayCreate, GatewayModify, MenuCreate, MenuModify, NoteCreate, NoteModify, ProductQuestionCreate, ProductReviewCreate, ProductVariantCreate, ScheduledFulfillmentCreate, ScheduledFulfillmentModify, ShopCreate, ShopModify, ShopSettingsCreate, VariantInventoryCreate } from "./commerceTypes.js";
+import { Context } from "./commerce.js";
+export interface LoggerTree {
+    [k: string]: string | LoggerTree;
+}
+export interface LoggerBar {
+    start(total: number, startValue: number, payload?: object | undefined): void;
+    stop(): void;
+    increment(step?: number | undefined): void;
+}
+export interface Logger<Bar extends LoggerBar> {
+    line(v: string): void;
+    bar(format: string): Bar;
+    tree(tree: LoggerTree): void;
+}
+export declare class NullLogger implements Logger<any> {
+    line(): void;
+    bar(): {
+        start: () => void;
+        stop: () => void;
+        increment: () => void;
+    };
+    tree(): void;
+}
+interface NormalizedName {
+    singular: string;
+    plural: string;
+}
+export declare function deferredJSONObject(value: any): string;
+interface ExecuteContext {
+    enqueue<T>(name: NormalizedName, quantity: number, f: () => Promise<T>): Promise<T>;
+    opts: MutatorOptions;
+}
+type ItemProcessor<T> = (ectx: ExecuteContext, ctx: Context, items: T[], resolvedIDs: Map<string, string>) => Promise<[string, string][]>;
+interface QueueItemCollection {
+    readonly id: string;
+    readonly items: {
+        id: string;
+        deps: string[];
+    }[];
+    readonly processor: ItemProcessor<any>;
+    extractItems(cond: (item: {
+        id: string;
+        deps: string[];
+    }, idx: number) => boolean): QueueItemCollection;
+}
+interface QueueItem<T, ExtraProps = {}> {
+    readonly id: string;
+    readonly deps: string[];
+    readonly item: {
+        req: T;
+    } & ExtraProps;
+}
+declare class GenericQueueItemCollection<T, ExtraProps = {}> implements QueueItemCollection {
+    private _name;
+    private _processor;
+    private _id;
+    private _queue;
+    constructor(_name: string, _processor: ItemProcessor<QueueItem<T, ExtraProps>>);
+    get id(): string;
+    get items(): QueueItem<T, ExtraProps>[];
+    get processor(): ItemProcessor<QueueItem<T, ExtraProps>>;
+    unID(): string;
+    push(id: string, item: {
+        req: T;
+    } & ExtraProps): void;
+    extractItems(cond: (item: {
+        id: string;
+        deps: string[];
+    }, idx: number) => boolean): QueueItemCollection;
+}
+interface Barrier {
+    desc: string;
+    data: any;
+    func: (data: any) => Promise<void>;
+}
+declare class Batch {
+    queues: Map<string, GenericQueueItemCollection<any, any>>;
+    barrier: Barrier | undefined;
+    private get allQueues();
+    topoSort(resolvedIDs?: Iterable<string>): QueueItemCollection[][];
+    numberOfItems(): number;
+}
+export interface ExecutionResult {
+    resolvedIDs: Map<string, string>;
+}
+export interface MutatorOptions {
+    /** Run everything as sequentially as possible. */
+    sequential?: boolean;
+}
+export declare class Mutator {
+    private batches;
+    private opts;
+    constructor(opts?: MutatorOptions);
+    get currentBatch(): Batch;
+    barrier(): void;
+    barrier<T>(desc: string, data: T, func: (data: T) => Promise<void>): void;
+    shop: (req: ShopCreate) => string;
+    shopModify: (shopID: string, req: ShopModify) => void;
+    shopSettings: (shopID: string, req: ShopSettingsCreate) => void;
+    taxRule: (shopID: string, req: import("./commerceTypes.js").TaxRuleCreate) => string;
+    taxRuleModify: (shopID: string, id: string, req: import("./commerceTypes.js").TaxRuleModify) => void;
+    taxRuleDelete: (shopID: string, id: string) => void;
+    taxRulesAddDefault: (shopID: string, country: string) => void;
+    returnReason: (shopID: string, req: import("./commerceTypes.js").ReturnReasonCreate) => string;
+    returnReasonModify: (shopID: string, id: string, req: import("./commerceTypes.js").ReturnReasonModify) => void;
+    returnReasonDelete: (shopID: string, id: string) => void;
+    returnReasonsAddDefault: (shopID: string) => void;
+    returnInspectionsAddDefault: (shopID: string) => void;
+    inventoryLocation: (shopID: string, req: import("./commerceTypes.js").InventoryLocationCreate) => string;
+    inventoryLocationModify: (shopID: string, id: string, req: import("./commerceTypes.js").InventoryLocationModify, locale?: string | undefined) => void;
+    gateway: (shopID: string, req: GatewayCreate) => string;
+    gatewayModify: (shopID: string, id: string, req: GatewayModify, locale?: string | undefined) => void;
+    gatewayDelete: (shopID: string, id: string) => void;
+    webhook: (shopID: string, req: import("./commerceTypes.js").WebhookCreate) => string;
+    webhookModify: (shopID: string, id: string, req: import("./commerceTypes.js").WebhookModify) => void;
+    webhookDelete: (shopID: string, id: string) => void;
+    shippingProvider: (shopID: string, req: import("./commerceTypes.js").ShippingProviderCreate) => string;
+    shippingProviderModify: (shopID: string, id: string, req: import("./commerceTypes.js").ShippingProviderModify, locale?: string | undefined) => void;
+    shippingProviderDelete: (shopID: string, id: string) => void;
+    shippingRule: (shopID: string, req: import("./commerceTypes.js").ShippingRuleCreate) => string;
+    shippingRuleModify: (shopID: string, id: string, req: import("./commerceTypes.js").ShippingRuleModify) => void;
+    shippingRuleDelete: (shopID: string, id: string) => void;
+    promotion: (shopID: string, req: import("./commerceTypes.js").PromotionCreate) => string;
+    promotionModify: (shopID: string, id: string, req: import("./commerceTypes.js").PromotionModify) => void;
+    promotionDelete: (shopID: string, id: string) => void;
+    coupon: (shopID: string, promotionID: string, req: CouponCreate) => string;
+    couponDelete: (shopID: string, id: string) => void;
+    domain: (shopID: string, req: import("./commerceTypes.js").DomainCreate) => string;
+    domainDelete: (shopID: string, id: string) => void;
+    reviewDimension: (shopID: string, req: import("./commerceTypes.js").ReviewDimensionCreate) => string;
+    reviewDimensionModify: (shopID: string, id: string, req: import("./commerceTypes.js").ReviewDimensionModify, locale?: string | undefined) => void;
+    reviewDimensionDelete: (shopID: string, id: string) => void;
+    reviewDimensionSet: (shopID: string, req: import("./commerceTypes.js").ReviewDimensionSetCreate) => string;
+    reviewDimensionSetModify: (shopID: string, id: string, req: import("./commerceTypes.js").ReviewDimensionSetModify) => void;
+    reviewDimensionSetDelete: (shopID: string, id: string) => void;
+    customer: (shopID: string, req: import("./commerceTypes.js").CustomerCreate) => string;
+    customerModify: (shopID: string, id: string, req: import("./commerceTypes.js").CustomerModify) => void;
+    customerDelete: (shopID: string, id: string) => void;
+    category: (shopID: string, req: import("./commerceTypes.js").CategoryCreate) => string;
+    categoryModify: (shopID: string, id: string, req: CategoryModify, locale?: string | undefined) => void;
+    categoryDelete: (shopID: string, id: string) => void;
+    brand: (shopID: string, req: import("./commerceTypes.js").BrandCreate) => string;
+    brandModify: (shopID: string, id: string, req: BrandModify, locale?: string | undefined) => void;
+    brandDelete: (shopID: string, id: string) => void;
+    contentBlock: (shopID: string, req: import("./commerceTypes.js").ContentBlockCreate) => string;
+    contentBlockModify: (shopID: string, id: string, req: ContentBlockModify, locale?: string | undefined) => void;
+    contentBlockDelete: (shopID: string, id: string) => void;
+    contentModel: (shopID: string, req: import("./commerceTypes.js").ContentModelCreate) => string;
+    contentModelModify: (shopID: string, id: string, req: import("./commerceTypes.js").ContentModelModify, locale?: string | undefined) => void;
+    contentModelDelete: (shopID: string, id: string) => void;
+    menu: (shopID: string, req: MenuCreate) => string;
+    menuModify: (shopID: string, id: string, req: MenuModify, locale?: string | undefined) => void;
+    menuDelete: (shopID: string, id: string) => void;
+    option: (shopID: string, req: import("./commerceTypes.js").OptionCreate) => string;
+    optionModify: (shopID: string, id: string, req: import("./commerceTypes.js").OptionModify, locale?: string | undefined) => void;
+    optionDelete: (shopID: string, id: string) => void;
+    surveyQuestion: (shopID: string, req: import("./commerceTypes.js").SurveyQuestionCreate) => string;
+    surveyQuestionModify: (shopID: string, id: string, req: import("./commerceTypes.js").SurveyQuestionModify, locale?: string | undefined) => void;
+    surveyQuestionDelete: (shopID: string, id: string) => void;
+    uploadFile: (shopID: string, name: string, data: Buffer, contentType: string, storage: FileStorage) => string;
+    customerNote: (shopID: string, customerID: string, req: NoteCreate) => string;
+    customerNoteModify: (shopID: string, customerID: string, id: string, req: NoteModify) => void;
+    customerNoteDelete: (shopID: string, customerID: string, id: string) => void;
+    orderNote: (shopID: string, orderID: string, req: NoteCreate) => string;
+    orderNoteModify: (shopID: string, orderID: string, id: string, req: NoteModify) => void;
+    orderNoteDelete: (shopID: string, orderID: string, id: string) => void;
+    purchaseOrderNote: (shopID: string, purchaseOrderID: string, req: NoteCreate) => string;
+    purchaseOrderNoteModify: (shopID: string, purchaseOrderID: string, id: string, req: NoteModify) => void;
+    purchaseOrderNoteDelete: (shopID: string, purchaseOrderID: string, id: string) => void;
+    transferNote: (shopID: string, transferID: string, req: NoteCreate) => string;
+    transferNoteModify: (shopID: string, transferID: string, id: string, req: NoteModify) => void;
+    transferNoteDelete: (shopID: string, transferID: string, id: string) => void;
+    order: (shopID: string, req: import("./commerceTypes.js").OrderCreate) => string;
+    orderModify: (shopID: string, id: string, req: import("./commerceTypes.js").OrderModify) => void;
+    orderDelete: (shopID: string, id: string) => void;
+    purchaseOrder: (shopID: string, req: import("./commerceTypes.js").PurchaseOrderCreate) => string;
+    purchaseOrderModify: (shopID: string, id: string, req: import("./commerceTypes.js").PurchaseOrderModify) => void;
+    purchaseOrderDelete: (shopID: string, id: string) => void;
+    transfer: (shopID: string, req: import("./commerceTypes.js").TransferCreate) => string;
+    transferModify: (shopID: string, id: string, req: import("./commerceTypes.js").TransferModify) => void;
+    transferDelete: (shopID: string, id: string) => void;
+    supplier: (shopID: string, req: import("./commerceTypes.js").SupplierCreate) => string;
+    supplierModify: (shopID: string, id: string, req: import("./commerceTypes.js").SupplierModify) => void;
+    supplierDelete: (shopID: string, id: string) => void;
+    packaging: (shopID: string, req: import("./commerceTypes.js").PackagingCreate) => string;
+    packagingModify: (shopID: string, id: string, req: import("./commerceTypes.js").PackagingModify) => void;
+    packagingDelete: (shopID: string, id: string) => void;
+    invitation: (shopID: string, req: import("./commerceTypes.js").InvitationCreate) => string;
+    invitationDelete: (shopID: string, id: string) => void;
+    buyLink: (shopID: string, req: import("./commerceTypes.js").BuyLinkCreate) => string;
+    buyLinkModify: (shopID: string, id: string, req: import("./commerceTypes.js").BuyLinkModify) => void;
+    buyLinkDelete: (shopID: string, id: string) => void;
+    customerGroup: (shopID: string, req: import("./commerceTypes.js").CustomerGroupCreate) => string;
+    customerGroupModify: (shopID: string, id: string, req: import("./commerceTypes.js").CustomerGroupModify) => void;
+    customerGroupDelete: (shopID: string, id: string) => void;
+    dataFeed: (shopID: string, req: import("./commerceTypes.js").DataFeedCreate) => string;
+    dataFeedModify: (shopID: string, id: string, req: import("./commerceTypes.js").DataFeedModify) => void;
+    dataFeedDelete: (shopID: string, id: string) => void;
+    inventoryRule: (shopID: string, req: import("./commerceTypes.js").InventoryRuleCreate) => string;
+    inventoryRuleModify: (shopID: string, id: string, req: import("./commerceTypes.js").InventoryRuleModify) => void;
+    inventoryRuleDelete: (shopID: string, id: string) => void;
+    returnInspection: (shopID: string, req: import("./commerceTypes.js").ReturnInspectionCreate) => string;
+    returnInspectionModify: (shopID: string, id: string, req: import("./commerceTypes.js").ReturnInspectionModify) => void;
+    returnInspectionDelete: (shopID: string, id: string) => void;
+    scheduledFulfillment: (shopID: string, orderID: string, req: ScheduledFulfillmentCreate) => string;
+    scheduledFulfillmentModify: (shopID: string, orderID: string, id: string, req: ScheduledFulfillmentModify) => void;
+    scheduledFulfillmentDelete: (shopID: string, orderID: string, id: string) => void;
+    role: (shopID: string, req: import("./commerceTypes.js").RoleCreate) => string;
+    roleModify: (shopID: string, id: string, req: import("./commerceTypes.js").RoleModify) => void;
+    roleDelete: (shopID: string, id: string) => void;
+    returnPolicy: (shopID: string, req: import("./commerceTypes.js").ReturnPolicyCreate) => string;
+    returnPolicyModify: (shopID: string, id: string, req: import("./commerceTypes.js").ReturnPolicyModify) => void;
+    returnPolicyDelete: (shopID: string, id: string) => void;
+    optionSet: (shopID: string, req: import("./commerceTypes.js").OptionSetCreate) => string;
+    optionSetModify: (shopID: string, id: string, req: import("./commerceTypes.js").OptionSetModify) => void;
+    optionSetDelete: (shopID: string, id: string) => void;
+    productFieldSet: (shopID: string, req: import("./commerceTypes.js").ProductFieldSetCreate) => string;
+    productFieldSetModify: (shopID: string, id: string, req: import("./commerceTypes.js").ProductFieldSetModify, locale?: string | undefined) => void;
+    productFieldSetDelete: (shopID: string, id: string) => void;
+    key: (shopID: string, req: import("./commerceTypes.js").KeyCreate) => string;
+    keyModify: (shopID: string, id: string, req: import("./commerceTypes.js").KeyModify) => void;
+    keyDelete: (shopID: string, id: string) => void;
+    product: (shopID: string, req: import("./commerceTypes.js").ProductCreate) => string;
+    productModify: (shopID: string, id: string, req: import("./commerceTypes.js").ProductModify, locale?: string | undefined) => void;
+    productDelete: (shopID: string, id: string) => void;
+    variant: (shopID: string, productID: string, req: ProductVariantCreate) => string;
+    variantModify: (shopID: string, id: string, req: import("./commerceTypes.js").ProductVariantModify, locale?: string | undefined) => void;
+    variantDelete: (shopID: string, id: string) => void;
+    currency: (shopID: string, req: CurrencyCreate) => string;
+    review: (shopID: string, req: ProductReviewCreate) => string;
+    question: (shopID: string, req: ProductQuestionCreate) => string;
+    variantInventory: (shopID: string, variantID: string, req: VariantInventoryCreate) => string;
+    private countTotalNumberOfItems;
+    execute(ctx: Context, logger?: Logger<any>): Promise<ExecutionResult>;
+}
+export {};

package/types/json/storefront.d.ts

@@ -0,0 +1,3 @@
+import type { ReqFunction } from "./storefrontTypes.js";
+export { assertExpanded, isExpanded, requestErrorPrefix, prettyPrintResponseError, APIRequest, APIResponse, Context, Extractor, RequestDetails, Response, SystemErrorType, } from "./common";
+export declare const request: ReqFunction;