@acmekit/types 2.13.1 → 2.13.3

package/dist/tax/mutations.d.ts

@@ -1,262 +0,0 @@
-import { MetadataType } from "../common";
-import { BaseFilterable } from "../dal";
-import { OperatorMap } from "../dal";
-import { TaxProviderDTO } from "./common";
-/**
- * The tax rate to be created.
- */
-export interface CreateTaxRateDTO {
-    /**
-     * The associated tax region's ID.
-     */
-    tax_region_id: string;
-    /**
-     * The rate to charge.
-     *
-     * @example
-     * 10
-     */
-    rate?: number | null;
-    /**
-     * The code of the tax rate.
-     */
-    code?: string | null;
-    /**
-     * The name of the tax rate.
-     */
-    name: string;
-    /**
-     * The rules of the tax rate.
-     */
-    rules?: Omit<CreateTaxRateRuleDTO, "tax_rate_id">[];
-    /**
-     * Whether the tax rate is default.
-     */
-    is_default?: boolean;
-    /**
-     * Who created the tax rate. For example, the ID of the user
-     * that created the tax rate.
-     */
-    created_by?: string;
-    /**
-     * Holds custom data in key-value pairs.
-     */
-    metadata?: MetadataType;
-}
-/**
- * The tax provider to be created.
- */
-export interface CreateTaxProviderDTO {
-    /**
-     * The provider's ID.
-     */
-    id: string;
-    /**
-     * Whether the provider is enabled.
-     */
-    is_enabled?: boolean;
-}
-/**
- * The filters to apply on the retrieved tax providers.
- */
-export interface FilterableTaxProviderProps extends BaseFilterable<TaxProviderDTO> {
-    /**
-     * The IDs to filter the tax provider by.
-     */
-    id?: string | string[] | OperatorMap<string | string[]>;
-    /**
-     * Filter by whether the tax provider is enabled.
-     */
-    is_enabled?: boolean;
-}
-/**
- * The attributes in the tax rate to be created or updated.
- */
-export interface UpsertTaxRateDTO {
-    /**
-     * The ID of the tax rate. If not provided, the tax rate
-     * is created.
-     */
-    id?: string;
-    /**
-     * The rate to charge
-     *
-     * @example
-     * 10
-     */
-    rate?: number | null;
-    /**
-     * The code of the tax rate.
-     */
-    code?: string | null;
-    /**
-     * The name of the tax rate.
-     */
-    name?: string;
-    /**
-     * Whether the tax rate is default.
-     */
-    is_default?: boolean;
-    /**
-     * Who created the tax rate. For example, the
-     * ID of the user that created it.
-     */
-    created_by?: string | null;
-    /**
-     * Holds custom data in key-value pairs.
-     */
-    metadata?: MetadataType;
-}
-/**
- * The attributes to update in the tax rate.
- */
-export interface UpdateTaxRateDTO {
-    /**
-     * The rate to charge.
-     *
-     * @example
-     * 10
-     */
-    rate?: number | null;
-    /**
-     * The code of the tax rate.
-     */
-    code?: string | null;
-    /**
-     * The name of the tax rate.
-     */
-    name?: string;
-    /**
-     * The rules of the tax rate.
-     */
-    rules?: Omit<CreateTaxRateRuleDTO, "tax_rate_id">[];
-    /**
-     * Whether the tax rate is default.
-     */
-    is_default?: boolean;
-    /**
-     * Whether the tax rate is combinable.
-     *
-     * Learn more [here](https://docs.acmekit.com/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates).
-     */
-    is_combinable?: boolean;
-    /**
-     * @ignore
-     *
-     * @privateRemarks
-     * This should be `created_by`.
-     */
-    updated_by?: string;
-    /**
-     * Holds custom data in key-value pairs.
-     */
-    metadata?: MetadataType;
-}
-/**
- * The tax region to be created.
- */
-export interface CreateTaxRegionDTO {
-    /**
-     * The ISO 3 character country code of the tax region.
-     */
-    country_code: string;
-    /**
-     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province or state code of the tax region.
-     */
-    province_code?: string | null;
-    /**
-     * The ID of the tax region's parent.
-     */
-    parent_id?: string | null;
-    /**
-     * The ID of the tax provider for the region.
-     */
-    provider_id?: string | null;
-    /**
-     * Holds custom data in key-value pairs.
-     */
-    metadata?: MetadataType;
-    /**
-     * Who created the tax region. For example, the ID of
-     * the user that created the tax region.
-     */
-    created_by?: string;
-    /**
-     * The default tax rate of the tax region.
-     */
-    default_tax_rate?: {
-        /**
-         * The rate to charge.
-         *
-         * @example
-         * 10
-         */
-        rate?: number | null;
-        /**
-         * The code of the tax rate.
-         */
-        code?: string | null;
-        /**
-         * The name of the tax rate.
-         */
-        name: string;
-        /**
-         * Holds custom data in key-value pairs.
-         */
-        metadata?: MetadataType;
-    };
-}
-/**
- * The tax region to be updated.
- */
-export interface UpdateTaxRegionDTO {
-    /**
-     * The id of the tax region to update
-     */
-    id: string;
-    /**
-     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province or state code of the tax region.
-     */
-    province_code?: string | null;
-    /**
-     * The ID of the tax provider for the region.
-     */
-    provider_id?: string | null;
-    /**
-     * Holds custom data in key-value pairs.
-     */
-    metadata?: MetadataType;
-}
-/**
- * The tax rate rule to be created.
- */
-export interface CreateTaxRateRuleDTO {
-    /**
-     * The snake-case name of the data model that the tax rule references.
-     * For example, `product`.
-     *
-     * Learn more in [this guide](https://docs.acmekit.com/resources/commerce-modules/tax/tax-rates-and-rules#override-tax-rates-with-rules).
-     */
-    reference: string;
-    /**
-     * The ID of the record of the data model that the tax rule references.
-     * For example, `prod_123`.
-     *
-     * Learn more in [this guide](https://docs.acmekit.com/resources/commerce-modules/tax/tax-rates-and-rules#override-tax-rates-with-rules).
-     */
-    reference_id: string;
-    /**
-     * The associated tax rate's ID.
-     */
-    tax_rate_id: string;
-    /**
-     * Holds custom data in key-value pairs.
-     */
-    metadata?: MetadataType;
-    /**
-     * Who created the tax rate rule. For example, the ID of the
-     * user that created it.
-     */
-    created_by?: string | null;
-}
-//# sourceMappingURL=mutations.d.ts.map

package/dist/tax/mutations.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"mutations.d.ts","sourceRoot":"","sources":["../../src/tax/mutations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AACxC,OAAO,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAA;AACvC,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAA;AACpC,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAEzC;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,KAAK,CAAC,EAAE,IAAI,CAAC,oBAAoB,EAAE,aAAa,CAAC,EAAE,CAAA;IAEnD;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,0BACf,SAAQ,cAAc,CAAC,cAAc,CAAC;IACtC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAEvD;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,KAAK,CAAC,EAAE,IAAI,CAAC,oBAAoB,EAAE,aAAa,CAAC,EAAE,CAAA;IAEnD;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IAEvB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE7B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAA;IAEvB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,gBAAgB,CAAC,EAAE;QACjB;;;;;WAKG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QAEpB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QAEpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAA;QAEZ;;WAEG;QACH,QAAQ,CAAC,EAAE,YAAY,CAAA;KACxB,CAAA;CACF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAA;IAEvB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC3B"}

package/dist/tax/mutations.js

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

package/dist/tax/mutations.js.map

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

package/dist/tax/provider.d.ts

@@ -1,168 +0,0 @@
-import { ItemTaxLineDTO, ShippingTaxLineDTO, TaxableItemDTO, TaxableShippingDTO, TaxCalculationContext, TaxRateDTO } from "./common";
-/**
- * A shipping method and the tax rates configured to apply to the
- * shipping method.
- */
-export type ShippingTaxCalculationLine = {
-    /**
-     * The shipping method to calculate taxes for.
-     */
-    shipping_line: TaxableShippingDTO;
-    /**
-     * The rates applicable on the shipping method.
-     */
-    rates: TaxRateDTO[];
-};
-/**
- * A line item and the tax rates configured to apply to the
- * product contained in the line item.
- */
-export type ItemTaxCalculationLine = {
-    /**
-     * The line item to calculate taxes for.
-     */
-    line_item: TaxableItemDTO;
-    /**
-     * The rates applicable on the item.
-     */
-    rates: TaxRateDTO[];
-};
-/**
- *
- *
- * ### Identifier Property
- *
- * Each tax provider has a unique identifier defined in its class. The provider's ID
- * will be stored as `tp_{identifier}_{id}`, where `{id}` is the provider's `id`
- * property in the `acmekit-config.ts`.
- *
- * For example:
- *
- * ```ts title="src/modules/my-tax/service.ts"
- * export default class MyTaxProvider implements ITaxProvider {
- *   static identifier = "my-tax"
- *   // ...
- * }
- * ```
- *
- * ### constructor
- *
- * You can use the `constructor` of your Tax Module Provider's service to access the resources registered in the [Module Container](https://docs.acmekit.com/resources/acmekit-container-resources#module-container-resources).
- *
- * You can also use the constructor to initialize your integration with the third-party provider. For example, if you use a client to connect to the third-party provider’s APIs, you can initialize it in the constructor and use it in other methods in the service.
- *
- * Additionally, if you’re creating your tax provider as a plugin or a module provider to be installed in any AcmeKit application and you want to access its options, you can access them in the second parameter of the constructor.
- *
- * For example:
- *
- * ```ts
- * import {
- *   ITaxProvider,
- *   Logger
- * } from "@acmekit/framework/types"
- *
- * type InjectedDependencies = {
- *   logger: Logger
- * }
- *
- * type Options = {
- *   apiKey: string
- * }
- *
- * export default class MyTaxProvider implements ITaxProvider {
- *   static identifier = "my-tax"
- *   protected logger_: Logger
- *   protected options_: Options
- *   // assuming you're initializing a client
- *   protected client
- *
- *   constructor (
- *     { logger }: InjectedDependencies,
- *     options: Options
- *   ) {
- *     this.logger_ = logger
- *     this.options_ = options
- *
- *     // assuming you're initializing a client
- *     this.client = new Client(options)
- *   }
- * }
- * ```
- *
- * ---
- */
-export interface ITaxProvider {
-    /**
-     * This method is used to retrieve the unique identifier of the tax provider.
-     *
-     * @return {string} The unique identifier of the tax provider.
-     *
-     * @example
-     * export default class MyTaxProvider implements ITaxProvider {
-     *   static identifier = "my-tax"
-     *
-     *   getIdentifier(): string {
-     *     return MyTaxProvider.identifier
-     *   }
-     * }
-     */
-    getIdentifier(): string;
-    /**
-     * This method is used to retrieve the tax lines of items and shipping methods. It's used during checkout
-     * when the `getTaxLines` method of the Tax Module's main service is called for a tax
-     * region that uses this tax provider.
-     *
-     * @param {ItemTaxCalculationLine[]} itemLines - The line item lines to calculate taxes for.
-     * @param {ShippingTaxCalculationLine[]} shippingLines - The shipping method lines to calculate taxes for.
-     * @param {TaxCalculationContext} context - The context relevant and useful for the taxes calculation.
-     * @return {Promise<(ItemTaxLineDTO | ShippingTaxLineDTO)[]>} The list of calculated line item and shipping tax lines.
-     * If an item in the array has the `shipping_line_id` property, then it's a shipping tax line. Otherwise, if it has
-     * the `line_item_id` property, then it's a line item tax line.
-     *
-     * @example
-     * An example of how this method is implemented in the `system` provider:
-     *
-     * ```ts
-     * // ...
-     *
-     * export default class SystemTaxService implements ITaxProvider {
-     *   // ...
-     *
-     *   async getTaxLines(
-     *     itemLines: TaxTypes.ItemTaxCalculationLine[],
-     *     shippingLines: TaxTypes.ShippingTaxCalculationLine[],
-     *     _: TaxTypes.TaxCalculationContext
-     *   ): Promise<(TaxTypes.ItemTaxLineDTO | TaxTypes.ShippingTaxLineDTO)[]> {
-     *     let taxLines: (TaxTypes.ItemTaxLineDTO | TaxTypes.ShippingTaxLineDTO)[] =
-     *       itemLines.flatMap((l) => {
-     *         return l.rates.map((r) => ({
-     *           rate_id: r.id, // this is optional. When integrating with a third-party, you don't need to provide it
-     *           rate: r.rate || 0, // For example, 10 for 10%
-     *           name: r.name,
-     *           code: r.code,
-     *           line_item_id: l.line_item.id,
-     *           provider_id: this.getIdentifier(),
-     *         }))
-     *       })
-     *
-     *     taxLines = taxLines.concat(
-     *       shippingLines.flatMap((l) => {
-     *         return l.rates.map((r) => ({
-     *           rate_id: r.id, // this is optional. When integrating with a third-party, you don't need to provide it
-     *           rate: r.rate || 0, // For example, 10 for 10%
-     *           name: r.name,
-     *           code: r.code,
-     *           shipping_line_id: l.shipping_line.id,
-     *           provider_id: this.getIdentifier(),
-     *         }))
-     *       })
-     *     )
-     *
-     *     return taxLines
-     *   }
-     * }
-     * ```
-     */
-    getTaxLines(itemLines: ItemTaxCalculationLine[], shippingLines: ShippingTaxCalculationLine[], context: TaxCalculationContext): Promise<(ItemTaxLineDTO | ShippingTaxLineDTO)[]>;
-}
-//# sourceMappingURL=provider.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../src/tax/provider.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,qBAAqB,EACrB,UAAU,EACX,MAAM,UAAU,CAAA;AAEjB;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,aAAa,EAAE,kBAAkB,CAAA;IACjC;;OAEG;IACH,KAAK,EAAE,UAAU,EAAE,CAAA;CACpB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,SAAS,EAAE,cAAc,CAAA;IACzB;;OAEG;IACH,KAAK,EAAE,UAAU,EAAE,CAAA;CACpB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+DG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;;;;;;;;;OAaG;IACH,aAAa,IAAI,MAAM,CAAA;IAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,WAAW,CACT,SAAS,EAAE,sBAAsB,EAAE,EACnC,aAAa,EAAE,0BAA0B,EAAE,EAC3C,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,CAAC,cAAc,GAAG,kBAAkB,CAAC,EAAE,CAAC,CAAA;CACpD"}

package/dist/tax/provider.js

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

package/dist/tax/provider.js.map

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