@medusajs/types 1.11.3 → 1.11.4-next-20231019103251

package/dist/common/common.d.ts

@@ -21,6 +21,22 @@ export interface SoftDeletableEntity extends BaseEntity {
 export type Writable<T> = {
     -readonly [key in keyof T]: T[key] | FindOperator<T[key]> | FindOperator<T[key][]> | FindOperator<string[]>;
 };
+/**
+ * @interface
+ *
+ * An object that is used to configure how an entity is retrieved from the database. It accepts as a typed parameter an `Entity` class,
+ * which provides correct typing of field names in its properties.
+ *
+ * @prop select - An array of strings, each being attribute names of the entity to retrieve in the result.
+ * @prop skip - A number indicating the number of records to skip before retrieving the results.
+ * @prop take - A number indicating the number of records to return in the result.
+ * @prop relations - An array of strings, each being relation names of the entity to retrieve in the result.
+ * @prop order -
+ * An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`
+ * to sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.
+ * @prop withDeleted - A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the
+ * `SoftDeletableEntity` class.
+ */
 export interface FindConfig<Entity> {
     select?: (keyof Entity | string)[];
     skip?: number;

package/dist/dal/index.d.ts

@@ -1,5 +1,13 @@
 import { Dictionary, FilterQuery, Order } from "./utils";
 export { FilterQuery } from "./utils";
+/**
+ * @interface
+ *
+ * An object used to allow specifying flexible queries with and/or conditions.
+ *
+ * @prop $and - An array of filters to apply on the entity, where each item in the array is joined with an "and" condition.
+ * @prop $or - An array of filters to apply on the entity, where each item in the array is joined with an "or" condition.
+ */
 export interface BaseFilterable<T> {
     $and?: (T | BaseFilterable<T>)[];
     $or?: (T | BaseFilterable<T>)[];

package/dist/dal/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/dal/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAuBA,uDAAoC;AACpC,2CAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/dal/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAgCA,uDAAoC;AACpC,2CAAwB"}

package/dist/dal/repository-service.d.ts

@@ -39,9 +39,23 @@ export interface TreeRepositoryService<T = any> extends BaseRepositoryService<T>
     create(data: unknown, context?: Context): Promise<T>;
     delete(id: string, context?: Context): Promise<void>;
 }
+/**
+ * @interface
+ *
+ * An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.
+ *
+ * @prop returnLinkableKeys - An array of strings, each being the ID attribute names of the entity's relations.
+ */
 export type SoftDeleteReturn<TReturnableLinkableKeys = string> = {
     returnLinkableKeys?: TReturnableLinkableKeys[];
 };
+/**
+ * @interface
+ *
+ * An object that is used to specify an entity's related entities that should be restored when the main entity is restored.
+ *
+ * @prop returnLinkableKeys - An array of strings, each being the ID attribute names of the entity's relations.
+ */
 export type RestoreReturn<TReturnableLinkableKeys = string> = {
     returnLinkableKeys?: TReturnableLinkableKeys[];
 };

package/dist/inventory/common.d.ts

@@ -211,19 +211,19 @@ export type FilterableInventoryItemProps = {
     requires_shipping?: boolean;
 };
 export type CreateInventoryItemInput = {
-    sku?: string;
-    origin_country?: string;
-    mid_code?: string;
-    material?: string;
-    weight?: number;
-    length?: number;
-    height?: number;
-    width?: number;
-    title?: string;
-    description?: string;
-    thumbnail?: string;
+    sku?: string | null;
+    origin_country?: string | null;
+    mid_code?: string | null;
+    material?: string | null;
+    weight?: number | null;
+    length?: number | null;
+    height?: number | null;
+    width?: number | null;
+    title?: string | null;
+    description?: string | null;
+    thumbnail?: string | null;
     metadata?: Record<string, unknown> | null;
-    hs_code?: string;
+    hs_code?: string | null;
     requires_shipping?: boolean;
 };
 export type CreateReservationItemInput = {

package/dist/pricing/common/currency.d.ts

@@ -1,22 +1,62 @@
 import { BaseFilterable } from "../../dal";
+/**
+ * @interface
+ *
+ * A currency's data.
+ *
+ * @prop code - The code of the currency.
+ * @prop symbol - The symbol of the currency.
+ * @prop symbol_native -
+ * The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.
+ * @prop name - The name of the currency.
+ */
 export interface CurrencyDTO {
     code: string;
     symbol?: string;
     symbol_native?: string;
     name?: string;
 }
+/**
+ * @interface
+ *
+ * A currency to create.
+ *
+ * @prop code - The code of the currency.
+ * @prop symbol - The symbol of the currency.
+ * @prop symbol_native -
+ * The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.
+ * @prop name - The name of the currency.
+ */
 export interface CreateCurrencyDTO {
     code: string;
     symbol: string;
     symbol_native: string;
     name: string;
 }
+/**
+ * @interface
+ *
+ * The data to update in a currency. The `code` is used to identify which currency to update.
+ *
+ * @prop code - The code of the currency to update.
+ * @prop symbol - The symbol of the currency.
+ * @prop symbol_native -
+ * The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.
+ * @prop name - The name of the currency.
+ */
 export interface UpdateCurrencyDTO {
     code: string;
     symbol?: string;
     symbol_native?: string;
     name?: string;
 }
+/**
+ * @interface
+ *
+ * Filters to apply on a currency.
+ *
+ * @prop code - The codes to filter the currencies by.
+ */
 export interface FilterableCurrencyProps extends BaseFilterable<FilterableCurrencyProps> {
     code?: string[];
 }

package/dist/pricing/common/money-amount.d.ts

@@ -1,5 +1,17 @@
 import { BaseFilterable } from "../../dal";
 import { CreateCurrencyDTO, CurrencyDTO } from "./currency";
+/**
+ * @interface
+ *
+ * A money amount's data. A money amount represents a price.
+ *
+ * @prop id - The ID of the money amount.
+ * @prop currency_code - The currency code of this money amount.
+ * @prop currency - The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.
+ * @prop amount - The price of this money amount.
+ * @prop min_quantity - The minimum quantity required to be purchased for this price to be applied.
+ * @prop max_quantity - The maximum quantity required to be purchased for this price to be applied.
+ */
 export interface MoneyAmountDTO {
     id: string;
     currency_code?: string;
@@ -8,6 +20,18 @@ export interface MoneyAmountDTO {
     min_quantity?: number;
     max_quantity?: number;
 }
+/**
+ * @interface
+ *
+ * The money amount to create.
+ *
+ * @prop id - The ID of the money amount.
+ * @prop currency_code - The currency code of this money amount.
+ * @prop currency - The currency of this money amount.
+ * @prop amount - The amount of this money amount.
+ * @prop min_quantity - The minimum quantity required to be purchased for this money amount to be applied.
+ * @prop max_quantity - The maximum quantity required to be purchased for this money amount to be applied.
+ */
 export interface CreateMoneyAmountDTO {
     id?: string;
     currency_code: string;
@@ -16,6 +40,18 @@ export interface CreateMoneyAmountDTO {
     min_quantity?: number;
     max_quantity?: number;
 }
+/**
+ *  * @interface
+ *
+ * The data to update in a money amount. The `id` is used to identify which money amount to update.
+ *
+ * @prop id - The ID of the money amount to update.
+ * @prop currency_code - The code of the currency to associate with the money amount.
+ * @prop currency - The currency to associte with the money amount.
+ * @prop amount - The price of this money amount.
+ * @prop min_quantity - The minimum quantity required to be purchased for this money amount to be applied.
+ * @prop max_quantity - The maximum quantity required to be purchased for this money amount to be applied.
+ */
 export interface UpdateMoneyAmountDTO {
     id: string;
     currency_code?: string;
@@ -23,6 +59,14 @@ export interface UpdateMoneyAmountDTO {
     min_quantity?: number;
     max_quantity?: number;
 }
+/**
+ * @interface
+ *
+ * Filters to apply on a money amount.
+ *
+ * @prop id - IDs to filter money amounts by.
+ * @prop currency_code - Currency codes to filter money amounts by.
+ */
 export interface FilterableMoneyAmountProps extends BaseFilterable<FilterableMoneyAmountProps> {
     id?: string[];
     currency_code?: string | string[];

package/dist/pricing/common/price-rule.d.ts

@@ -1,38 +1,109 @@
 import { BaseFilterable } from "../../dal";
 import { PriceSetDTO } from "./price-set";
 import { RuleTypeDTO } from "./rule-type";
+/**
+ * @interface
+ *
+ * A price rule's data.
+ *
+ * @prop id - The ID of the price rule.
+ * @prop price_set_id - The ID of the associated price set.
+ * @prop price_set - The associated price set. It may only be available if the relation `price_set` is expanded.
+ * @prop rule_type_id - The ID of the associated rule type.
+ * @prop rule_type - The associated rule type. It may only be available if the relation `rule_type` is expanded.
+ * @prop value - The value of the price rule.
+ * @prop priority - The priority of the price rule in comparison to other applicable price rules.
+ * @prop price_set_money_amount_id - The ID of the associated price set money amount.
+ * @prop price_list_id - The ID of the associated price list.
+ */
 export interface PriceRuleDTO {
     id: string;
     price_set_id: string;
     price_set: PriceSetDTO;
     rule_type_id: string;
     rule_type: RuleTypeDTO;
+    /**
+     * @ignore
+     * @privateRemark
+     *
+     * Behavior behind this property is not implemented yet.
+     */
     is_dynamic: boolean;
     value: string;
     priority: number;
     price_set_money_amount_id: string;
     price_list_id: string;
 }
+/**
+ *
+ * @interface
+ *
+ * A price rule to create.
+ *
+ * @prop id - The ID of the price rule.
+ * @prop price_set_id - The ID of the associated price set.
+ * @prop rule_type_id - The ID of the associated rule type.
+ * @prop value - The value of the price rule.
+ * @prop priority - The priority of the price rule in comparison to other applicable price rules.
+ * @prop price_set_money_amount_id - The ID of the associated price set money amount.
+ * @prop price_list_id - The ID of the associated price list.
+ */
 export interface CreatePriceRuleDTO {
     id: string;
     price_set_id: string;
     rule_type_id: string;
+    /**
+     * @ignore
+     * @privateRemark
+     *
+     * Behavior behind this property is not implemented yet.
+     */
     is_dynamic?: boolean;
     value: string;
     priority?: number;
     price_set_money_amount_id: string;
     price_list_id: string;
 }
+/**
+ *
+ * @interface
+ *
+ * The data to update in a price rule. The `id` is used to identify which money amount to update.
+ *
+ * @prop id - The ID of the price rule to update.
+ * @prop price_set_id - The ID of the associated price set.
+ * @prop rule_type_id - The ID of the associated rule type.
+ * @prop value - The value of the price rule.
+ * @prop priority - The priority of the price rule in comparison to other applicable price rules.
+ * @prop price_set_money_amount_id - The ID of the associated price set money amount.
+ * @prop price_list_id - The ID of the associated price list.
+ */
 export interface UpdatePriceRuleDTO {
     id: string;
     price_set_id?: string;
     rule_type_id?: string;
+    /**
+     * @ignore
+     * @privateRemark
+     *
+     * Behavior behind this property is not implemented yet.
+     */
     is_dynamic?: boolean;
     value?: string;
     priority?: number;
     price_set_money_amount_id?: string;
     price_list_id?: string;
 }
+/**
+ * @interface
+ *
+ * Filters to apply to price rules.
+ *
+ * @prop id - The IDs to filter price rules by.
+ * @prop name - The names to filter price rules by.
+ * @prop price_set_id - The IDs to filter the price rule's associated price set.
+ * @prop rule_type_id - The IDs to filter the price rule's associated rule type.
+ */
 export interface FilterablePriceRuleProps extends BaseFilterable<FilterablePriceRuleProps> {
     id?: string[];
     name?: string[];

package/dist/pricing/common/price-set-money-amount-rules.d.ts

@@ -1,23 +1,62 @@
 import { BaseFilterable } from "../../dal";
 import { PriceSetMoneyAmountDTO } from "./price-set-money-amount";
 import { RuleTypeDTO } from "./rule-type";
+/**
+ * @interface
+ *
+ * A price set money amount rule's data.
+ *
+ * @prop id - The ID of the price set money amount.
+ * @prop price_set_money_amount - The associated price set money amount. It may only be available if the relation `price_set_money_amount` is expanded.
+ * @prop rule_type - The associated rule type. It may only be available if the relation `rule_type` is expanded.
+ * @prop value - The value of the price set money amount rule.
+ */
 export interface PriceSetMoneyAmountRulesDTO {
     id: string;
     price_set_money_amount: PriceSetMoneyAmountDTO;
     rule_type: RuleTypeDTO;
     value: string;
 }
+/**
+ * @interface
+ *
+ * The price set money amount rule to create.
+ *
+ * @prop price_set_money_amount - The ID of a price set money amount.
+ * @prop rule_type - The ID of a rule type.
+ * @prop value - The value of the price set money amount rule.
+ */
 export interface CreatePriceSetMoneyAmountRulesDTO {
     price_set_money_amount: string;
     rule_type: string;
     value: string;
 }
+/**
+ * @interface
+ *
+ * The data to update in a price set money amount rule. The `id` is used to identify which money amount to update.
+ *
+ * @prop id - The ID of the price set money amount rule to update.
+ * @prop price_set_money_amount - The ID of a price set money amount.
+ * @prop rule_type - The ID of a rule type.
+ * @prop value - The value of the price set money amount rule.
+ */
 export interface UpdatePriceSetMoneyAmountRulesDTO {
     id: string;
     price_set_money_amount?: string;
     rule_type?: string;
     value?: string;
 }
+/**
+ * @interface
+ *
+ * Filters to apply on price set money amount rules.
+ *
+ * @prop id - The ID to filter price set money amount rules by.
+ * @prop rule_type_id - The IDs to filter the price set money amount rule's associated rule type.
+ * @prop price_set_money_amount_id - The IDs to filter the price set money amount rule's associated price set money amount.
+ * @prop value - The value to filter price set money amount rules by.
+ */
 export interface FilterablePriceSetMoneyAmountRulesProps extends BaseFilterable<FilterablePriceSetMoneyAmountRulesProps> {
     id?: string[];
     rule_type_id?: string[];

package/dist/pricing/common/price-set-money-amount.d.ts

@@ -1,5 +1,15 @@
 import { MoneyAmountDTO } from "./money-amount";
 import { PriceSetDTO } from "./price-set";
+/**
+ * @interface
+ *
+ * A price set money amount's data.
+ *
+ * @prop id - The ID of a price set money amount.
+ * @prop title - The title of the price set money amount.
+ * @prop price_set - The price set associated with the price set money amount. It may only be available if the relation `price_set` is expanded.
+ * @prop money_amount - The money amount associated with the price set money amount. It may only be available if the relation `money_amount` is expanded.
+ */
 export interface PriceSetMoneyAmountDTO {
     id: string;
     title?: string;

package/dist/pricing/common/price-set.d.ts

@@ -1,17 +1,55 @@
 import { BaseFilterable } from "../../dal";
 import { CreateMoneyAmountDTO, FilterableMoneyAmountProps, MoneyAmountDTO } from "./money-amount";
 import { RuleTypeDTO } from "./rule-type";
+/**
+ * @interface
+ *
+ * The context to calculate prices. For example, you can specify the currency code to calculate prices in.
+ *
+ * @prop context -
+ * an object whose keys are the name of the context attribute. Its value can be a string or a number. For example, you can pass the `currency_code` property with its value being the currency code to calculate the price in.
+ * Another example is passing the `quantity` property to calculate the price for that specified quantity, which finds a price set whose `min_quantity` and `max_quantity` conditions match the specified quantity.
+ *
+ */
 export interface PricingContext {
     context?: Record<string, string | number>;
 }
+/**
+ * @interface
+ *
+ * Filters to apply on prices.
+ *
+ * @prop id - IDs to filter prices.
+ */
 export interface PricingFilters {
     id: string[];
 }
+/**
+ * @interface
+ *
+ * A price set's data.
+ *
+ * @prop id - The ID of the price set.
+ * @prop money_amounts - The prices that belong to this price set.
+ * @prop rule_types - The rule types applied on this price set.
+ *
+ */
 export interface PriceSetDTO {
     id: string;
     money_amounts?: MoneyAmountDTO[];
     rule_types?: RuleTypeDTO[];
 }
+/**
+ * @interface
+ *
+ * A calculated price set's data.
+ *
+ * @prop id - The ID of the price set.
+ * @prop amount - The calculated amount. It can possibly be `null` if there's no price set up for the provided context.
+ * @prop currency_code - The currency code of the calculated price. It can possibly be `null`.
+ * @prop min_quantity - The minimum quantity required to be purchased for this price to apply. It's set if the `quantity` property is provided in the context. Otherwise, its value will be `null`.
+ * @prop max_quantity - The maximum quantity required to be purchased for this price to apply. It's set if the `quantity` property is provided in the context. Otherwise, its value will be `null`.
+ */
 export interface CalculatedPriceSetDTO {
     id: string;
     amount: number | null;
@@ -19,33 +57,86 @@ export interface CalculatedPriceSetDTO {
     min_quantity: number | null;
     max_quantity: number | null;
 }
+/**
+ * @interface
+ *
+ * The rules to add to a price set.
+ *
+ * @prop priceSetId - The ID of the price set to add the rules to.
+ * @prop rules - The rules to add to a price set. The value of `attribute` is the value of the rule's `rule_attribute` attribute.
+ */
 export interface AddRulesDTO {
     priceSetId: string;
     rules: {
         attribute: string;
     }[];
 }
+/**
+ * @interface
+ *
+ * The prices to create part of a price set.
+ *
+ * @prop rules - The rules to add to the price. The object's keys are rule types' `rule_attribute` attribute, and values are the value of that rule associated with this price.
+ */
+export interface CreatePricesDTO extends CreateMoneyAmountDTO {
+    rules: Record<string, string>;
+}
+/**
+ * @interface
+ *
+ * The prices to add to a price set.
+ *
+ * @prop priceSetId - The ID of the price set to add prices to.
+ * @prop prices - The prices to add to the price set.
+ */
 export interface AddPricesDTO {
     priceSetId: string;
-    prices: (CreateMoneyAmountDTO & {
-        rules?: Record<string, string>;
-    })[];
+    prices: CreatePricesDTO[];
 }
+/**
+ * @interface
+ *
+ * The rules to remove from a price set.
+ *
+ * @prop id - The ID of the price set.
+ * @prop rules - The rules to remove. Each string is the `rule_attribute` of a rule to remove.
+ */
 export interface RemovePriceSetRulesDTO {
     id: string;
     rules: string[];
 }
+/**
+ * @interface
+ *
+ * A price set to create.
+ *
+ * @prop rules - The rules to associate with the price set. The value of `attribute` is the value of the rule's `rule_attribute` attribute.
+ * @prop prices -The prices to create and add to this price set.
+ */
 export interface CreatePriceSetDTO {
     rules?: {
         rule_attribute: string;
     }[];
-    prices?: (CreateMoneyAmountDTO & {
-        rules: Record<string, string>;
-    })[];
+    prices?: CreatePricesDTO[];
 }
+/**
+ * @interface
+ *
+ * The data to update in a price set. The `id` is used to identify which price set to update.
+ *
+ * @prop id - A string indicating the ID of the price set to update.
+ */
 export interface UpdatePriceSetDTO {
     id: string;
 }
+/**
+ * @interface
+ *
+ * Filters to apply on price sets.
+ *
+ * @prop id - IDs to filter price sets by.
+ * @prop money_amounts - Filters to apply on a price set's associated money amounts.
+ */
 export interface FilterablePriceSetProps extends BaseFilterable<FilterablePriceSetProps> {
     id?: string[];
     money_amounts?: FilterableMoneyAmountProps;

package/dist/pricing/common/rule-type.d.ts

@@ -1,22 +1,61 @@
 import { BaseFilterable } from "../../dal";
+/**
+ * @interface
+ *
+ * A rule type's data.
+ *
+ * @prop id - The ID of the rule type.
+ * @prop name - The display name of the rule type.
+ * @prop rule_attribute - The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.
+ * @prop default_priority - The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.
+ */
 export interface RuleTypeDTO {
     id: string;
     name: string;
     rule_attribute: string;
     default_priority: number;
 }
+/**
+ * @interface
+ *
+ * The rule type to create.
+ *
+ * @prop id - The ID of the rule type.
+ * @prop name - The display name of the rule type.
+ * @prop rule_attribute - The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.
+ * @prop default_priority - The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.
+ */
 export interface CreateRuleTypeDTO {
     id?: string;
     name: string;
     rule_attribute: string;
     default_priority?: number;
 }
+/**
+ * @interface
+ *
+ * The data to update in a rule type. The `id` is used to identify which price set to update.
+ *
+ * @prop id - The ID of the rule type to update.
+ * @prop name - The display name of the rule type.
+ * @prop rule_attribute - The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.
+ * @prop default_priority - The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.
+ */
 export interface UpdateRuleTypeDTO {
     id: string;
     name?: string;
     rule_attribute?: string;
     default_priority?: number;
 }
+/**
+ * @interface
+ *
+ * Filters to apply on rule types.
+ *
+ * @prop id - The IDs to filter rule types by.
+ * @prop name - The names to filter rule types by.
+ * @prop rule_attribute - The rule attributes to filter rule types by.
+ */
 export interface FilterableRuleTypeProps extends BaseFilterable<FilterableRuleTypeProps> {
     id?: string[];
     name?: string[];