@acmekit/types 2.13.1 → 2.13.3

package/dist/fulfillment/mutations/shipping-option.d.ts

@@ -1,183 +0,0 @@
-import { CreateShippingOptionTypeDTO } from "./shipping-option-type";
-import { CartPropsForFulfillment, ShippingOptionPriceType } from "../common";
-import { CreateShippingOptionRuleDTO } from "./shipping-option-rule";
-import { StockLocationDTO } from "../../stock-location";
-/**
- * The shipping option to be created.
- */
-export interface CreateShippingOptionDTO {
-    /**
-     * The name of the shipping option.
-     */
-    name: string;
-    /**
-     * The type of the shipping option's price.
-     */
-    price_type: ShippingOptionPriceType;
-    /**
-     * The associated service zone's ID.
-     */
-    service_zone_id: string;
-    /**
-     * The associated shipping profile's ID.
-     */
-    shipping_profile_id: string;
-    /**
-     * The associated provider's ID.
-     */
-    provider_id: string;
-    /**
-     * The shipping option type associated with the shipping option.
-     */
-    type: CreateShippingOptionTypeDTO | string;
-    /**
-     * The data necessary for the associated fulfillment provider to process the shipping option
-     * and its associated fulfillments.
-     */
-    data?: Record<string, unknown> | null;
-    /**
-     * The shipping option rules associated with the shipping option.
-     */
-    rules?: Omit<CreateShippingOptionRuleDTO, "shipping_option_id">[];
-}
-/**
- * The attributes to update in the shipping option.
- */
-export interface UpdateShippingOptionDTO {
-    /**
-     * The ID of the shipping option.
-     */
-    id?: string;
-    /**
-     * The name of the shipping option.
-     */
-    name?: string;
-    /**
-     * The type of the shipping option's price.
-     */
-    price_type?: ShippingOptionPriceType;
-    /**
-     * The associated service zone's ID.
-     */
-    service_zone_id?: string;
-    /**
-     * The associated shipping profile's ID.
-     */
-    shipping_profile_id?: string;
-    /**
-     * The associated provider's ID.
-     */
-    provider_id?: string;
-    /**
-     * The ID of the shipping option type.
-     */
-    shipping_option_type_id?: string;
-    /**
-     * The ID of the type of shipping option.
-     * Column doesn't exist on the entity -> normalized to `shipping_option_type_id`
-     */
-    type_id?: string;
-    /**
-     * The shipping option type associated with the shipping option.
-     */
-    type?: CreateShippingOptionTypeDTO | string | {
-        /**
-         * The ID of the shipping option type.
-         */
-        id: string;
-    };
-    /**
-     * The data necessary for the associated fulfillment provider to process the shipping option
-     * and its associated fulfillments.
-     */
-    data?: Record<string, unknown> | null;
-    /**
-     * The shipping option rules associated with the shipping option.
-     */
-    rules?: (Omit<CreateShippingOptionRuleDTO, "shipping_option_id"> | {
-        /**
-         * The ID of the shipping option rule.
-         */
-        id: string;
-    })[];
-}
-/**
- * A shipping option to be created or updated.
- */
-export interface UpsertShippingOptionDTO extends UpdateShippingOptionDTO {
-}
-type CalculateShippingItems = {
-    /**
-     * The ID of the order item. Lookup in context.items for the details about variant / product.
-     */
-    id: string;
-    /**
-     * The quantity to ship.
-     */
-    quantity: number;
-};
-export type CalculatedRMAShippingContext = {
-    /**
-     * The ID of the return.
-     */
-    return_id: string;
-    /**
-     * The details of the return's items.
-     */
-    return_items: CalculateShippingItems[];
-} | {
-    /**
-     * The ID of the exchange.
-     */
-    exchange_id: string;
-    /**
-     * The details of the exchange's items.
-     */
-    exchange_items: CalculateShippingItems[];
-} | {
-    /**
-     * The ID of the claim.
-     */
-    claim_id: string;
-    /**
-     * The details of the claim's items.
-     */
-    claim_items: CalculateShippingItems[];
-};
-/**
- * The data needed for the associated fulfillment provider to calculate the price of a shipping option.
- */
-export interface CalculateShippingOptionPriceDTO {
-    /**
-     * The ID of the shipping option.
-     */
-    id: string;
-    /**
-     * The ID of the fulfillment provider.
-     */
-    provider_id: string;
-    /**
-     * The `data` property of the shipping option.
-     */
-    optionData: Record<string, unknown>;
-    /**
-     * The shipping method's `data` property with custom data passed from the frontend.
-     */
-    data: Record<string, unknown>;
-    /**
-     * The calculation context needed for the associated fulfillment provider to calculate the price of a shipping option.
-     */
-    context: CartPropsForFulfillment & {
-        /**
-         * The location that the items will be shipped from (or to if it is a return).
-         */
-        from_location?: StockLocationDTO;
-        [k: string]: unknown;
-    } & CalculatedRMAShippingContext;
-}
-/**
- * The calculation context needed for the associated fulfillment provider to calculate the price of a shipping option.
- */
-export type CalculateShippingOptionPriceContext = CalculateShippingOptionPriceDTO["context"];
-export {};
-//# sourceMappingURL=shipping-option.d.ts.map

package/dist/fulfillment/mutations/shipping-option.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"shipping-option.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/shipping-option.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAA;AACpE,OAAO,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,MAAM,WAAW,CAAA;AAC5E,OAAO,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAA;AACpE,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,UAAU,EAAE,uBAAuB,CAAA;IAEnC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAA;IAE3B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,IAAI,EAAE,2BAA2B,GAAG,MAAM,CAAA;IAE1C;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAErC;;OAEG;IACH,KAAK,CAAC,EAAE,IAAI,CAAC,2BAA2B,EAAE,oBAAoB,CAAC,EAAE,CAAA;CAClE;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,UAAU,CAAC,EAAE,uBAAuB,CAAA;IAEpC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAA;IAEhC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,IAAI,CAAC,EACD,2BAA2B,GAC3B,MAAM,GACN;QACE;;WAEG;QACH,EAAE,EAAE,MAAM,CAAA;KACX,CAAA;IAEL;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAErC;;OAEG;IACH,KAAK,CAAC,EAAE,CACJ,IAAI,CAAC,2BAA2B,EAAE,oBAAoB,CAAC,GACvD;QACE;;WAEG;QACH,EAAE,EAAE,MAAM,CAAA;KACX,CACJ,EAAE,CAAA;CACJ;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,uBAAuB;CAAG;AAE3E,KAAK,sBAAsB,GAAG;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,4BAA4B,GACpC;IACE;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,YAAY,EAAE,sBAAsB,EAAE,CAAA;CACvC,GACD;IACE;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,cAAc,EAAE,sBAAsB,EAAE,CAAA;CACzC,GACD;IACE;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,WAAW,EAAE,sBAAsB,EAAE,CAAA;CACtC,CAAA;AAEL;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAEnC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAE7B;;OAEG;IACH,OAAO,EAAE,uBAAuB,GAAG;QACjC;;WAEG;QACH,aAAa,CAAC,EAAE,gBAAgB,CAAA;QAEhC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;KACrB,GAAG,4BAA4B,CAAA;CACjC;AAED;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAC7C,+BAA+B,CAAC,SAAS,CAAC,CAAA"}

package/dist/fulfillment/mutations/shipping-option.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=shipping-option.js.map

package/dist/fulfillment/mutations/shipping-option.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"shipping-option.js","sourceRoot":"","sources":["../../../src/fulfillment/mutations/shipping-option.ts"],"names":[],"mappings":""}

package/dist/fulfillment/mutations/shipping-profile.d.ts

@@ -1,41 +0,0 @@
-/**
- * The shipping profile to be created.
- */
-export interface CreateShippingProfileDTO {
-    /**
-     * The name of the shipping profile.
-     */
-    name: string;
-    /**
-     * The type of the shipping profile.
-     */
-    type: string;
-    /**
-     * Holds custom data in key-value pairs.
-     */
-    metadata?: Record<string, unknown> | null;
-}
-/**
- * The attributes to update in the shipping profile.
- */
-export interface UpdateShippingProfileDTO {
-    /**
-     * The name of the shipping profile.
-     */
-    name?: string;
-    /**
-     * The type of the shipping profile.
-     */
-    type?: string;
-    /**
-     * Holds custom data in key-value pairs.
-     */
-    metadata?: Record<string, unknown> | null;
-}
-/**
- * The attributes to update in the shipping profile.
- */
-export interface UpsertShippingProfileDTO extends UpdateShippingProfileDTO {
-    id?: string;
-}
-//# sourceMappingURL=shipping-profile.d.ts.map

package/dist/fulfillment/mutations/shipping-profile.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"shipping-profile.d.ts","sourceRoot":"","sources":["../../../src/fulfillment/mutations/shipping-profile.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,wBAAwB;IACxE,EAAE,CAAC,EAAE,MAAM,CAAA;CACZ"}

package/dist/fulfillment/mutations/shipping-profile.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=shipping-profile.js.map

package/dist/fulfillment/mutations/shipping-profile.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"shipping-profile.js","sourceRoot":"","sources":["../../../src/fulfillment/mutations/shipping-profile.ts"],"names":[],"mappings":""}

package/dist/fulfillment/provider.d.ts

@@ -1,131 +0,0 @@
-import { StockLocationDTO } from "../stock-location";
-import { CartPropsForFulfillment, FulfillmentDTO, FulfillmentItemDTO, FulfillmentOrderDTO } from "./common";
-import { CalculateShippingOptionPriceContext, CalculateShippingOptionPriceDTO, CreateShippingOptionDTO } from "./mutations";
-export type FulfillmentOption = {
-    /**
-     * The option's ID. This ID can be an ID in the third-party system relevant
-     * for later processing of fulfillment.
-     *
-     * @example express
-     */
-    id: string;
-    /**
-     * Whether the option can be used to return items.
-     */
-    is_return?: boolean;
-    [k: string]: unknown;
-};
-/**
- * A calculated shipping option price.
- */
-export type CalculatedShippingOptionPrice = {
-    /**
-     * The calculated price.
-     */
-    calculated_amount: number;
-    /**
-     * Whether the calculated price includes taxes. If enabled, AcmeKit will
-     * infer the taxes from the calculated price. If false, AcmeKit will
-     * add taxes to the calculated price.
-     */
-    is_calculated_price_tax_inclusive: boolean;
-};
-/**
- * The context for validating fulfillment data.
- */
-export type ValidateFulfillmentDataContext = CartPropsForFulfillment & {
-    /**
-     * Details about the location that items are being shipped from.
-     */
-    from_location: StockLocationDTO;
-    [k: string]: unknown;
-};
-export type CreateFulfillmentResult = {
-    /**
-     * Additional fulfillment data from provider
-     */
-    data: Record<string, unknown>;
-    labels: {
-        /**
-         * The tracking number of the fulfillment label.
-         */
-        tracking_number: string;
-        /**
-         * The tracking URL of the fulfillment label.
-         */
-        tracking_url: string;
-        /**
-         * The label's URL.
-         */
-        label_url: string;
-    }[];
-};
-export interface IFulfillmentProvider {
-    /**
-     *
-     * Return a unique identifier to retrieve the fulfillment plugin provider
-     * @ignore
-     */
-    getIdentifier(): string;
-    /**
-     *
-     * Return the available fulfillment options for the given data.
-     */
-    getFulfillmentOptions(): Promise<FulfillmentOption[]>;
-    /**
-     *
-     * Validate the given fulfillment data.
-     */
-    validateFulfillmentData(optionData: Record<string, unknown>, data: Record<string, unknown>, context: ValidateFulfillmentDataContext): Promise<any>;
-    /**
-     *
-     * Validate the given option.
-     */
-    validateOption(data: Record<string, unknown>): Promise<boolean>;
-    /**
-     *
-     * Check if the provider can calculate the fulfillment price.
-     */
-    canCalculate(data: CreateShippingOptionDTO): Promise<boolean>;
-    /**
-     *
-     * Calculate the price for the given fulfillment option.
-     */
-    calculatePrice(optionData: CalculateShippingOptionPriceDTO["optionData"], data: CalculateShippingOptionPriceDTO["data"], context: CalculateShippingOptionPriceContext): Promise<CalculatedShippingOptionPrice>;
-    /**
-     *
-     * Create a fulfillment for the given data.
-     */
-    createFulfillment(data: Record<string, unknown>, items: Partial<Omit<FulfillmentItemDTO, "fulfillment">>[], order: Partial<FulfillmentOrderDTO> | undefined, fulfillment: Partial<Omit<FulfillmentDTO, "provider_id" | "data" | "items">>): Promise<CreateFulfillmentResult>;
-    /**
-     *
-     * Cancel the given fulfillment.
-     */
-    cancelFulfillment(fulfillment: Record<string, unknown>): Promise<any>;
-    /**
-     *
-     * Get the documents for the given fulfillment data.
-     */
-    getFulfillmentDocuments(data: Record<string, unknown>): Promise<any>;
-    /**
-     *
-     * Create a return for the given data.
-     */
-    createReturnFulfillment(fromData: Record<string, unknown>): Promise<CreateFulfillmentResult>;
-    /**
-     *
-     * Get the documents for the given return data.
-     */
-    retrieveDocuments(fulfillmentData: Record<string, unknown>, documentType: string): Promise<any>;
-    /**
-     *
-     * Get the documents for the given return data.
-     */
-    getReturnDocuments(data: Record<string, unknown>): Promise<any>;
-    /**
-     *
-     * Get the documents for the given shipment data.
-     */
-    getShipmentDocuments(data: Record<string, unknown>): Promise<any>;
-}
-//# sourceMappingURL=provider.d.ts.map

package/dist/fulfillment/provider.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../src/fulfillment/provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AACpD,OAAO,EACL,uBAAuB,EACvB,cAAc,EACd,kBAAkB,EAClB,mBAAmB,EACpB,MAAM,UAAU,CAAA;AACjB,OAAO,EACL,mCAAmC,EACnC,+BAA+B,EAC/B,uBAAuB,EACxB,MAAM,aAAa,CAAA;AAEpB,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;;;;OAKG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAA;IACzB;;;;OAIG;IACH,iCAAiC,EAAE,OAAO,CAAA;CAC3C,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG,uBAAuB,GAAG;IACrE;;OAEG;IACH,aAAa,EAAE,gBAAgB,CAAA;IAC/B,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC7B,MAAM,EAAE;QACN;;WAEG;QACH,eAAe,EAAE,MAAM,CAAA;QAEvB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAA;QAEpB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAA;KAClB,EAAE,CAAA;CACJ,CAAA;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,aAAa,IAAI,MAAM,CAAA;IACvB;;;OAGG;IACH,qBAAqB,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAA;IACrD;;;OAGG;IACH,uBAAuB,CACrB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACnC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,GAAG,CAAC,CAAA;IACf;;;OAGG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAC/D;;;OAGG;IACH,YAAY,CAAC,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAC7D;;;OAGG;IACH,cAAc,CACZ,UAAU,EAAE,+BAA+B,CAAC,YAAY,CAAC,EACzD,IAAI,EAAE,+BAA+B,CAAC,MAAM,CAAC,EAC7C,OAAO,EAAE,mCAAmC,GAC3C,OAAO,CAAC,6BAA6B,CAAC,CAAA;IACzC;;;OAGG;IACH,iBAAiB,CACf,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,aAAa,CAAC,CAAC,EAAE,EACzD,KAAK,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,SAAS,EAC/C,WAAW,EAAE,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,aAAa,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC,GAC3E,OAAO,CAAC,uBAAuB,CAAC,CAAA;IACnC;;;OAGG;IACH,iBAAiB,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;IACrE;;;OAGG;IACH,uBAAuB,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;IACpE;;;OAGG;IACH,uBAAuB,CACrB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAChC,OAAO,CAAC,uBAAuB,CAAC,CAAA;IACnC;;;OAGG;IACH,iBAAiB,CACf,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACxC,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,GAAG,CAAC,CAAA;IACf;;;OAGG;IACH,kBAAkB,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;IAC/D;;;OAGG;IACH,oBAAoB,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;CAClE"}

package/dist/fulfillment/provider.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=provider.js.map

package/dist/fulfillment/provider.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"provider.js","sourceRoot":"","sources":["../../src/fulfillment/provider.ts"],"names":[],"mappings":""}