@medusajs/types 2.7.2-snapshot-20250423182346 → 2.7.2-snapshot-20250424113529

package/dist/cart/common.d.ts

@@ -215,7 +215,7 @@ export interface CartAddressDTO {
      */
     country_code?: string;
     /**
-     * The province/state of the address.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province/state of the address.
      */
     province?: string;
     /**

package/dist/cart/mutations.d.ts

@@ -38,7 +38,7 @@ export interface UpsertAddressDTO {
      */
     country_code?: string;
     /**
-     * The province of the address.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province/state of the address.
      */
     province?: string;
     /**

package/dist/cart/workflows.d.ts

@@ -160,7 +160,7 @@ export interface CreateCartAddressDTO {
      */
     country_code?: string;
     /**
-     * The province or state of the address.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province or state of the address.
      */
     province?: string;
     /**

package/dist/customer/common.d.ts

@@ -54,7 +54,7 @@ export interface CustomerAddressDTO {
      */
     country_code?: string;
     /**
-     * The province of the customer address.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province of the customer address.
      */
     province?: string;
     /**
@@ -139,7 +139,7 @@ export interface FilterableCustomerAddressProps extends BaseFilterable<Filterabl
      */
     country_code?: string | OperatorMap<string>;
     /**
-     * Filter addresses by province.
+     * Filter addresses by lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province.
      */
     province?: string | OperatorMap<string>;
     /**

package/dist/customer/mutations.d.ts

@@ -48,7 +48,7 @@ export interface CreateCustomerAddressDTO {
      */
     country_code?: string | null;
     /**
-     * The province.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province of the address.
      */
     province?: string | null;
     /**
@@ -117,7 +117,7 @@ export interface UpdateCustomerAddressDTO {
      */
     country_code?: string | null;
     /**
-     * The province.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province of the address.
      */
     province?: string | null;
     /**

package/dist/fulfillment/common/address.d.ts

@@ -39,7 +39,7 @@ export interface FulfillmentAddressDTO {
      */
     country_code: string | null;
     /**
-     * The province of the address.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province of the address.
      */
     province: string | null;
     /**

package/dist/fulfillment/common/geo-zone.d.ts

@@ -20,7 +20,7 @@ export interface GeoZoneDTO {
      */
     country_code: string;
     /**
-     * The province code of the geo zone.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code of the geo zone.
      */
     province_code: string | null;
     /**
@@ -65,7 +65,7 @@ export interface FilterableGeoZoneProps extends BaseFilterable<FilterableGeoZone
      */
     country_code?: string | string[];
     /**
-     * Filter the geo zones by their province code.
+     * Filter the geo zones by their lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code.
      */
     province_code?: string | string[];
     /**

package/dist/fulfillment/common/order.d.ts

@@ -357,7 +357,7 @@ interface FulfillmentOrderAddressDTO {
      */
     country_code?: string;
     /**
-     * The province/state of the address.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province/state of the address.
      */
     province?: string;
     /**

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

@@ -151,7 +151,7 @@ export interface FilterableShippingOptionForContextProps extends FilterableShipp
          */
         country_code?: string;
         /**
-         * The province code.
+         * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code.
          */
         province_code?: string;
         /**

package/dist/fulfillment/mutations/fulfillment-address.d.ts

@@ -35,7 +35,7 @@ export interface CreateFulfillmentAddressDTO {
      */
     country_code?: string | null;
     /**
-     * The province of the fulfillment address.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province of the fulfillment address.
      */
     province?: string | null;
     /**

package/dist/fulfillment/mutations/geo-zone.d.ts

@@ -40,7 +40,7 @@ export interface CreateProvinceGeoZoneDTO extends CreateGeoZoneBaseDTO {
      */
     type: "province";
     /**
-     * The province code of the geo zone.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code of the geo zone.
      */
     province_code: string;
 }
@@ -54,7 +54,7 @@ export interface CreateCityGeoZoneDTO extends CreateGeoZoneBaseDTO {
      */
     type: "city";
     /**
-     * The province code of the geo zone.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code of the geo zone.
      */
     province_code: string;
     /**
@@ -72,7 +72,7 @@ export interface CreateZipGeoZoneDTO extends CreateGeoZoneBaseDTO {
      */
     type: "zip";
     /**
-     * The province code of the geo zone.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code of the geo zone.
      */
     province_code: string;
     /**
@@ -117,7 +117,7 @@ export interface UpdateProvinceGeoZoneDTO extends UpdateGeoZoneBaseDTO {
      */
     type: "province";
     /**
-     * The province code of the geo zone.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code of the geo zone.
      */
     province_code: string;
 }
@@ -131,7 +131,7 @@ export interface UpdateCityGeoZoneDTO extends UpdateGeoZoneBaseDTO {
      */
     type: "city";
     /**
-     * The province code of the geo zone.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code of the geo zone.
      */
     province_code?: string;
     /**
@@ -149,7 +149,7 @@ export interface UpdateZipGeoZoneDTO extends UpdateGeoZoneBaseDTO {
      */
     type: "zip";
     /**
-     * The province code of the geo zone.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code of the geo zone.
      */
     province_code?: string;
     /**

package/dist/fulfillment/service.d.ts

@@ -709,7 +709,7 @@ export interface IFulfillmentModuleService extends IModuleService {
      *     {
      *       type: "city",
      *       service_zone_id: "serzo_321",
-     *       province_code: "VT",
+     *       province_code: "us-vt",
      *       city: "Vermont",
      *       country_code: "us",
      *     },
@@ -750,7 +750,7 @@ export interface IFulfillmentModuleService extends IModuleService {
      *     {
      *       id: "fgz_321",
      *       type: "city",
-     *       province_code: "VT",
+     *       province_code: "us-vt",
      *     },
      *   ])
      */

package/dist/http/cart/common.d.ts

@@ -205,7 +205,7 @@ export interface BaseCartAddress {
      */
     country_code?: string;
     /**
-     * The province/state of the address.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province/state of the address.
      */
     province?: string;
     /**

package/dist/http/cart/store/payloads.d.ts

@@ -144,7 +144,7 @@ export interface StoreAddAddress {
      */
     country_code?: string;
     /**
-     * The province/state of the address.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province/state of the address.
      */
     province?: string;
     /**

package/dist/http/customer/common.d.ts

@@ -61,7 +61,7 @@ export interface BaseCustomerAddress {
      */
     country_code: string | null;
     /**
-     * The address's province.
+     * The address's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province.
      */
     province: string | null;
     /**
@@ -225,7 +225,7 @@ export interface BaseCustomerAddressFilters extends BaseFilterable<BaseCustomerA
      */
     country_code?: string[] | string;
     /**
-     * Filter by province(s).
+     * Filter by lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code(s).
      */
     province?: string[] | string;
     /**
@@ -318,7 +318,7 @@ export interface BaseCreateCustomerAddress {
      */
     country_code?: string;
     /**
-     * The address's province.
+     * The address's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province.
      */
     province?: string;
     /**
@@ -379,7 +379,7 @@ export interface BaseUpdateCustomerAddress {
      */
     country_code?: string;
     /**
-     * The address's province.
+     * The address's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province.
      */
     province?: string;
     /**

package/dist/http/fulfillment/admin/entitites.d.ts

@@ -96,7 +96,7 @@ export interface AdminFulfillmentAddress {
      */
     country_code: string | null;
     /**
-     * The address's province.
+     * The address's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province.
      */
     province: string | null;
     /**

package/dist/http/fulfillment/admin/payloads.d.ts

@@ -75,7 +75,7 @@ interface AdminFulfillmentDeliveryAddress {
      */
     country_code?: string;
     /**
-     * The address's province.
+     * The address's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province.
      */
     province?: string;
     /**

package/dist/http/fulfillment-set/admin/entities.d.ts

@@ -18,7 +18,7 @@ export interface AdminGeoZone {
      */
     country_code: string;
     /**
-     * The geo zone's province code.
+     * The geo zone's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code.
      */
     province_code: string | null;
     /**

package/dist/http/fulfillment-set/admin/payloads.d.ts

@@ -21,14 +21,14 @@ interface AdminUpsertFulfillmentSetServiceZoneCountry extends AdminUpsertGeoZone
 interface AdminUpsertFulfillmentSetServiceZoneProvince extends AdminUpsertGeoZone {
     type: "province";
     /**
-     * The geo zone's province code.
+     * The geo zone's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code.
      */
     province_code: string;
 }
 interface AdminUpsertFulfillmentSetServiceZoneCity extends AdminUpsertGeoZone {
     type: "city";
     /**
-     * The geo zone's province code.
+     * The geo zone's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code.
      */
     province_code: string;
     /**
@@ -39,7 +39,7 @@ interface AdminUpsertFulfillmentSetServiceZoneCity extends AdminUpsertGeoZone {
 interface AdminUpsertFulfillmentSetServiceZoneZip extends AdminUpsertGeoZone {
     type: "zip";
     /**
-     * The geo zone's province code.
+     * The geo zone's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code.
      */
     province_code: string;
     /**
@@ -75,14 +75,14 @@ interface AdminUpdateFulfillmentSetServiceZoneCountry extends AdminUpdateGeoZone
 interface AdminUpdateFulfillmentSetServiceZoneProvince extends AdminUpdateGeoZone {
     type: "province";
     /**
-     * The geo zone's province code.
+     * The geo zone's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code.
      */
     province_code: string;
 }
 interface AdminUpdateFulfillmentSetServiceZoneCity extends AdminUpdateGeoZone {
     type: "city";
     /**
-     * The geo zone's province code.
+     * The geo zone's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code.
      */
     province_code: string;
     /**
@@ -93,7 +93,7 @@ interface AdminUpdateFulfillmentSetServiceZoneCity extends AdminUpdateGeoZone {
 interface AdminUpdateFulfillmentSetServiceZoneZip extends AdminUpdateGeoZone {
     type: "zip";
     /**
-     * The geo zone's province code.
+     * The geo zone's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province code.
      */
     province_code: string;
     /**

package/dist/http/order/admin/payload.d.ts

@@ -134,7 +134,7 @@ export interface OrderAddress {
      */
     country_code?: string;
     /**
-     * The province/state of the address.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province/state of the address.
      */
     province?: string;
     /**

package/dist/http/order/common.d.ts

@@ -187,7 +187,7 @@ export interface BaseOrderAddress {
      */
     country_code?: string;
     /**
-     * The address's province.
+     * The address's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province.
      */
     province?: string;
     /**

package/dist/http/product/store/queries.d.ts

@@ -14,7 +14,7 @@ export interface StoreProductPricingContext {
      */
     country_code?: string;
     /**
-     * The province, which can be taken from a customer's address. This parameter helps further narrowing down the taxes applied on a the product variant's prices.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province, which can be taken from a customer's address. This parameter helps further narrowing down the taxes applied on a the product variant's prices.
      */
     province?: string;
     /**

package/dist/http/stock-locations/admin/payloads.d.ts

@@ -31,7 +31,7 @@ interface AdminUpsertStockLocationAddress {
      */
     postal_code?: string;
     /**
-     * The province or state of the address.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province or state of the address.
      */
     province?: string;
 }

package/dist/http/tax-region/admin/entities.d.ts

@@ -12,10 +12,10 @@ export interface AdminTaxRegion {
      */
     country_code: string | null;
     /**
-     * The tax region's province or state code.
+     * The tax region's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province or state code.
      *
      * @example
-     * "ca"
+     * "us-ca"
      */
     province_code: string | null;
     /**

package/dist/http/tax-region/admin/payloads.d.ts

@@ -4,7 +4,7 @@ export interface AdminCreateTaxRegion {
      */
     country_code: string;
     /**
-     * The province code of the tax region.
+     * 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;
     /**

package/dist/http/tax-region/admin/queries.d.ts

@@ -18,7 +18,7 @@ export interface AdminTaxRegionListParams extends FindParams, BaseFilterable<Adm
      */
     country_code?: string | string[] | OperatorMap<string | string[]>;
     /**
-     * Filter by the tax region's province code(s).
+     * Filter by the tax region's lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province or state code(s).
      */
     province_code?: string | string[] | OperatorMap<string | string[]>;
     /**

package/dist/index-data/common.d.ts

@@ -26,10 +26,19 @@ export type SchemaObjectEntityRepresentation = {
          * The property the data should be assigned to in the parent
          */
         targetProp: string;
+        /**
+         * The property the parent is assigned to in my side
+         */
+        inverseSideProp: string;
         /**
          * Are the data expected to be a list or not
          */
         isList?: boolean;
+        /**
+         * Whether the entity is the inverse of the link (not the owner.):
+         * e.g: order -> cart, order is the owner, cart is the inverse
+         */
+        isInverse?: boolean;
     }[];
     /**
      * The default fields to query for the type/entity
@@ -58,6 +67,8 @@ export type SchemaPropertiesMap = {
     [key: string]: {
         shortCutOf?: string;
         ref: SchemaObjectEntityRepresentation;
+        isInverse?: boolean;
+        isList?: boolean;
     };
 };
 /**

package/dist/index-data/common.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/index-data/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAA;AAEnD,MAAM,MAAM,gCAAgC,GAAG;IAC7C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;;OAGG;IACH,OAAO,EAAE;QACP;;;WAGG;QACH,GAAG,EAAE,gCAAgC,CAAA;QAErC;;;;;;WAMG;QACH,WAAW,CAAC,EAAE,gCAAgC,CAAA;QAE9C;;WAEG;QACH,UAAU,EAAE,MAAM,CAAA;QAElB;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAA;KACjB,EAAE,CAAA;IAEH;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAA;IAEhB;;;OAGG;IACH,SAAS,EAAE,MAAM,EAAE,CAAA;IAEnB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;;OAGG;IACH,YAAY,EAAE,kBAAkB,CAAA;CACjC,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,CAAC,GAAG,EAAE,MAAM,GAAG,kBAAkB,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,CAAC,GAAG,EAAE,MAAM,GAAG;QACb,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,GAAG,EAAE,gCAAgC,CAAA;KACtC,CAAA;CACF,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAClC;IACE,CAAC,GAAG,EAAE,MAAM,GAAG,gCAAgC,CAAA;CAChD,GACD;IACE,oBAAoB,EAAE,mBAAmB,CAAA;IACzC,2BAA2B,EAAE,yBAAyB,CAAA;CACvD,CAAA"}
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/index-data/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAA;AAEnD,MAAM,MAAM,gCAAgC,GAAG;IAC7C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;;OAGG;IACH,OAAO,EAAE;QACP;;;WAGG;QACH,GAAG,EAAE,gCAAgC,CAAA;QAErC;;;;;;WAMG;QACH,WAAW,CAAC,EAAE,gCAAgC,CAAA;QAE9C;;WAEG;QACH,UAAU,EAAE,MAAM,CAAA;QAElB;;WAEG;QACH,eAAe,EAAE,MAAM,CAAA;QAEvB;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAA;QAEhB;;;WAGG;QACH,SAAS,CAAC,EAAE,OAAO,CAAA;KACpB,EAAE,CAAA;IAEH;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAA;IAEhB;;;OAGG;IACH,SAAS,EAAE,MAAM,EAAE,CAAA;IAEnB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;;OAGG;IACH,YAAY,EAAE,kBAAkB,CAAA;CACjC,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,CAAC,GAAG,EAAE,MAAM,GAAG,kBAAkB,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,CAAC,GAAG,EAAE,MAAM,GAAG;QACb,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,GAAG,EAAE,gCAAgC,CAAA;QACrC,SAAS,CAAC,EAAE,OAAO,CAAA;QACnB,MAAM,CAAC,EAAE,OAAO,CAAA;KACjB,CAAA;CACF,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAClC;IACE,CAAC,GAAG,EAAE,MAAM,GAAG,gCAAgC,CAAA;CAChD,GACD;IACE,oBAAoB,EAAE,mBAAmB,CAAA;IACzC,2BAA2B,EAAE,yBAAyB,CAAA;CACvD,CAAA"}

package/dist/index-data/query-config/query-input-config-fields.d.ts

@@ -7,7 +7,9 @@ type ExpandStarSelector<T extends object, Depth extends number, Exclusion extend
 /**
  * Output an array of strings representing the path to each leaf node in an object
  */
-export type ObjectToIndexFields<MaybeT, Depth extends number = 2, Exclusion extends string[] = [], T = TypeOnly<MaybeT>> = Depth extends never ? never : T extends object ? {
+export type ObjectToIndexFields<MaybeT, Depth extends number = 2, Exclusion extends string[] = [], T = TypeOnly<MaybeT> & {
+    "*": "*";
+}> = Depth extends never ? never : T extends object ? {
     [K in keyof T]: K extends `${RawBigNumberPrefix}${string}` ? Exclude<K, symbol> : K extends ExcludedProps ? never : K extends Exclusion[number] ? never : TypeOnly<T[K]> extends Array<infer R> ? TypeOnly<R> extends Date ? Exclude<K, symbol> : TypeOnly<R> extends {
         __typename: any;
     } ? `${Exclude<K, symbol>}.${ExpandStarSelector<TypeOnly<R>, Marker[Depth], [

package/dist/index-data/query-config/query-input-config-fields.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"query-input-config-fields.d.ts","sourceRoot":"","sources":["../../../src/index-data/query-config/query-input-config-fields.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AAElD,KAAK,MAAM,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;AAEpC,KAAK,kBAAkB,GAAG,MAAM,CAAA;AAEhC,KAAK,kBAAkB,CACrB,CAAC,SAAS,MAAM,EAChB,KAAK,SAAS,MAAM,EACpB,SAAS,SAAS,MAAM,EAAE,IACxB,mBAAmB,CAAC,CAAC,GAAG;IAAE,GAAG,EAAE,GAAG,CAAA;CAAE,EAAE,KAAK,EAAE,SAAS,CAAC,CAAA;AAE3D;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAC7B,MAAM,EACN,KAAK,SAAS,MAAM,GAAG,CAAC,EACxB,SAAS,SAAS,MAAM,EAAE,GAAG,EAAE,EAC/B,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,IAClB,KAAK,SAAS,KAAK,GACnB,KAAK,GACL,CAAC,SAAS,MAAM,GAChB;KACG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,SACjB,GAAG,kBAAkB,GAAG,MAAM,EAAE,GAC5B,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,GAEpB,CAAC,SAAS,aAAa,GACrB,KAAK,GAEP,CAAC,SAAS,SAAS,CAAC,MAAM,CAAC,GACzB,KAAK,GACL,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,GACrC,QAAQ,CAAC,CAAC,CAAC,SAAS,IAAI,GACtB,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,GAClB,QAAQ,CAAC,CAAC,CAAC,SAAS;QAAE,UAAU,EAAE,GAAG,CAAA;KAAE,GACvC,GAAG,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,IAAI,kBAAkB,CACzC,QAAQ,CAAC,CAAC,CAAC,EACX,MAAM,CAAC,KAAK,CAAC,EACb;QAAC,CAAC,GAAG,MAAM;QAAE,GAAG,SAAS;KAAC,CAC3B,EAAE,GACH,QAAQ,CAAC,CAAC,CAAC,SAAS,MAAM,GAC1B,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,GAClB,KAAK,GACP,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,GAC3B,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,GAClB,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;QAAE,UAAU,EAAE,GAAG,CAAA;KAAE,GAC1C,GAAG,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,IAAI,kBAAkB,CACzC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACd,MAAM,CAAC,KAAK,CAAC,EACb;QAAC,CAAC,GAAG,MAAM;QAAE,GAAG,SAAS;KAAC,CAC3B,EAAE,GACH,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GACnB,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,GAClB,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC,MAAM,CAAC,CAAC,GACV,KAAK,CAAA"}
+{"version":3,"file":"query-input-config-fields.d.ts","sourceRoot":"","sources":["../../../src/index-data/query-config/query-input-config-fields.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AAClD,KAAK,MAAM,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;AAEpC,KAAK,kBAAkB,GAAG,MAAM,CAAA;AAEhC,KAAK,kBAAkB,CACrB,CAAC,SAAS,MAAM,EAChB,KAAK,SAAS,MAAM,EACpB,SAAS,SAAS,MAAM,EAAE,IACxB,mBAAmB,CAAC,CAAC,GAAG;IAAE,GAAG,EAAE,GAAG,CAAA;CAAE,EAAE,KAAK,EAAE,SAAS,CAAC,CAAA;AAE3D;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAC7B,MAAM,EACN,KAAK,SAAS,MAAM,GAAG,CAAC,EACxB,SAAS,SAAS,MAAM,EAAE,GAAG,EAAE,EAC/B,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG;IAAE,GAAG,EAAE,GAAG,CAAA;CAAE,IACjC,KAAK,SAAS,KAAK,GACnB,KAAK,GACL,CAAC,SAAS,MAAM,GAChB;KACG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,SACjB,GAAG,kBAAkB,GAAG,MAAM,EAAE,GAC5B,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,GAEpB,CAAC,SAAS,aAAa,GACrB,KAAK,GAEP,CAAC,SAAS,SAAS,CAAC,MAAM,CAAC,GACzB,KAAK,GACL,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,GACrC,QAAQ,CAAC,CAAC,CAAC,SAAS,IAAI,GACtB,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,GAClB,QAAQ,CAAC,CAAC,CAAC,SAAS;QAAE,UAAU,EAAE,GAAG,CAAA;KAAE,GACvC,GAAG,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,IAAI,kBAAkB,CACzC,QAAQ,CAAC,CAAC,CAAC,EACX,MAAM,CAAC,KAAK,CAAC,EACb;QAAC,CAAC,GAAG,MAAM;QAAE,GAAG,SAAS;KAAC,CAC3B,EAAE,GACH,QAAQ,CAAC,CAAC,CAAC,SAAS,MAAM,GAC1B,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,GAClB,KAAK,GACP,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,GAC3B,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,GAClB,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;QAAE,UAAU,EAAE,GAAG,CAAA;KAAE,GAC1C,GAAG,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,IAAI,kBAAkB,CACzC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACd,MAAM,CAAC,KAAK,CAAC,EACb;QAAC,CAAC,GAAG,MAAM;QAAE,GAAG,SAAS;KAAC,CAC3B,EAAE,GACH,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GACnB,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,GAClB,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC,MAAM,CAAC,CAAC,GACV,KAAK,CAAA"}

package/dist/index-data/query-config/query-input-config.d.ts

@@ -1,18 +1,57 @@
-import { RemoteQueryInput } from "../../modules-sdk/remote-query-object-from-string";
 import { IndexServiceEntryPoints } from "../index-service-entry-points";
 import { ObjectToIndexFields } from "./query-input-config-fields";
 import { IndexFilters } from "./query-input-config-filters";
+import { IndexOrderBy } from "./query-input-config-order-by";
+export type IndexQueryInput<TEntry extends string> = {
+    /**
+     * The name of the entity to retrieve. For example, `product`.
+     */
+    entity: TEntry | keyof IndexServiceEntryPoints;
+    /**
+     * The fields and relations to retrieve in the entity.
+     */
+    fields: ObjectToIndexFields<IndexServiceEntryPoints[TEntry & keyof IndexServiceEntryPoints]> extends never ? string[] : ObjectToIndexFields<IndexServiceEntryPoints[TEntry & keyof IndexServiceEntryPoints]>[] | string[];
+    /**
+     * Pagination configurations for the returned list of items.
+     */
+    pagination?: {
+        /**
+         * The number of items to skip before retrieving the returned items.
+         */
+        skip?: number;
+        /**
+         * The maximum number of items to return.
+         */
+        take?: number;
+        /**
+         * Sort by field names in ascending or descending order.
+         */
+        order?: IndexOrderBy<TEntry>;
+    };
+    /**
+     * Filters to apply on the retrieved items.
+     */
+    filters?: IndexFilters<TEntry>;
+    /**
+     * Apply a query context on the retrieved data. For example, to retrieve product prices for a certain context.
+     */
+    context?: any;
+    /**
+     * Apply a `withDeleted` flag on the retrieved data to retrieve soft deleted items.
+     */
+    withDeleted?: boolean;
+};
 export type IndexQueryConfig<TEntry extends string> = {
     fields: ObjectToIndexFields<IndexServiceEntryPoints[TEntry & keyof IndexServiceEntryPoints]> extends never ? string[] : ObjectToIndexFields<IndexServiceEntryPoints[TEntry & keyof IndexServiceEntryPoints]>[];
     filters?: IndexFilters<TEntry>;
     joinFilters?: IndexFilters<TEntry>;
-    pagination?: Partial<RemoteQueryInput<TEntry>["pagination"]>;
+    pagination?: Partial<IndexQueryInput<TEntry>["pagination"]>;
     keepFilteredEntities?: boolean;
 };
 export type QueryFunctionReturnPagination = {
-    skip?: number;
-    take?: number;
-    count?: number;
+    skip: number;
+    take: number;
+    count: number;
 };
 /**
  * The QueryResultSet presents a typed output for the

package/dist/index-data/query-config/query-input-config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"query-input-config.d.ts","sourceRoot":"","sources":["../../../src/index-data/query-config/query-input-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,mDAAmD,CAAA;AACpF,OAAO,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAA;AACvE,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAA;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAE3D,MAAM,MAAM,gBAAgB,CAAC,MAAM,SAAS,MAAM,IAAI;IACpD,MAAM,EAAE,mBAAmB,CACzB,uBAAuB,CAAC,MAAM,GAAG,MAAM,uBAAuB,CAAC,CAChE,SAAS,KAAK,GACX,MAAM,EAAE,GACR,mBAAmB,CACjB,uBAAuB,CAAC,MAAM,GAAG,MAAM,uBAAuB,CAAC,CAChE,EAAE,CAAA;IACP,OAAO,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,CAAA;IAC9B,WAAW,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,CAAA;IAClC,UAAU,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAA;IAC5D,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,6BAA6B,GAAG;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,cAAc,CAAC,MAAM,SAAS,MAAM,IAAI;IAClD,IAAI,EAAE,MAAM,SAAS,MAAM,uBAAuB,GAC9C,uBAAuB,CAAC,MAAM,CAAC,EAAE,GACjC,GAAG,EAAE,CAAA;IACT,QAAQ,CAAC,EAAE,6BAA6B,CAAA;CACzC,CAAA"}
+{"version":3,"file":"query-input-config.d.ts","sourceRoot":"","sources":["../../../src/index-data/query-config/query-input-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAA;AACvE,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAA;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAA;AAE5D,MAAM,MAAM,eAAe,CAAC,MAAM,SAAS,MAAM,IAAI;IAEnD;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,MAAM,uBAAuB,CAAA;IAC9C;;OAEG;IACH,MAAM,EAAE,mBAAmB,CACzB,uBAAuB,CAAC,MAAM,GAAG,MAAM,uBAAuB,CAAC,CAChE,SAAS,KAAK,GACX,MAAM,EAAE,GAEJ,mBAAmB,CACjB,uBAAuB,CAAC,MAAM,GAAG,MAAM,uBAAuB,CAAC,CAChE,EAAE,GACH,MAAM,EAAE,CAAA;IAChB;;OAEG;IACH,UAAU,CAAC,EAAE;QACX;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;QACb;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;QACb;;WAEG;QACH,KAAK,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,CAAA;KAC7B,CAAA;IACD;;OAEG;IACH,OAAO,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,CAAA;IAC9B;;OAEG;IACH,OAAO,CAAC,EAAE,GAAG,CAAA;IACb;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,gBAAgB,CAAC,MAAM,SAAS,MAAM,IAAI;IACpD,MAAM,EAAE,mBAAmB,CACzB,uBAAuB,CAAC,MAAM,GAAG,MAAM,uBAAuB,CAAC,CAChE,SAAS,KAAK,GACX,MAAM,EAAE,GACR,mBAAmB,CACjB,uBAAuB,CAAC,MAAM,GAAG,MAAM,uBAAuB,CAAC,CAChE,EAAE,CAAA;IACP,OAAO,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,CAAA;IAC9B,WAAW,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,CAAA;IAClC,UAAU,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAA;IAC3D,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,6BAA6B,GAAG;IAC1C,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,cAAc,CAAC,MAAM,SAAS,MAAM,IAAI;IAClD,IAAI,EAAE,MAAM,SAAS,MAAM,uBAAuB,GAC9C,uBAAuB,CAAC,MAAM,CAAC,EAAE,GACjC,GAAG,EAAE,CAAA;IACT,QAAQ,CAAC,EAAE,6BAA6B,CAAA;CACzC,CAAA"}

package/dist/joiner/index.d.ts

@@ -20,6 +20,7 @@ export type JoinerRelationship = {
 export interface JoinerServiceConfigAlias {
     name: string | string[];
     entity?: string;
+    filterable?: string[];
     /**
      * Extra arguments to pass to the remoteFetchData callback
      */

package/dist/joiner/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/joiner/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,EAAE,MAAM,CAAA;IACb,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC3B,CAAA;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACvB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC3B;AAED,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,KAAK,CAAC,EAAE,wBAAwB,GAAG,wBAAwB,EAAE,CAAA;IAC7D;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CACjB,MAAM,EACJ,MAAM,GACN;QACE,IAAI,EAAE,MAAM,CAAA;QACZ,sBAAsB,EAAE,MAAM,EAAE,CAAA;KACjC,CACJ,CAAA;IACD,WAAW,EAAE,MAAM,EAAE,CAAA;IACrB,aAAa,CAAC,EAAE,kBAAkB,EAAE,CAAA;IACpC,OAAO,CAAC,EAAE;QACR,WAAW,EAAE,MAAM,CAAA;QACnB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,YAAY,EAAE,kBAAkB,CAAA;KACjC,EAAE,CAAA;IACH;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC3B;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,GAAG,CAAA;CACZ;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,GAAG,CAAA;CACZ;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,KAAK,CAAC;QACd,QAAQ,EAAE,MAAM,CAAA;QAChB,MAAM,EAAE,MAAM,EAAE,CAAA;QAChB,IAAI,CAAC,EAAE,cAAc,EAAE,CAAA;QACvB,UAAU,CAAC,EAAE;YAAE,CAAC,KAAK,EAAE,MAAM,GAAG,eAAe,EAAE,CAAA;SAAE,CAAA;KACpD,CAAC,CAAA;IACF,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB,IAAI,CAAC,EAAE,cAAc,EAAE,CAAA;IACvB,UAAU,CAAC,EAAE;QAAE,CAAC,KAAK,EAAE,MAAM,GAAG,eAAe,EAAE,CAAA;KAAE,CAAA;CACpD;AAED,MAAM,WAAW,mBAAmB;IAClC,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,uBAAuB,CAAC,EAAE,OAAO,GAAG,MAAM,EAAE,CAAA;IAC5C,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CAChC;AAED,MAAM,WAAW,mBAAmB;IAClC,CAAC,GAAG,EAAE,MAAM,GAAG;QACb,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;QACjB,IAAI,CAAC,EAAE,cAAc,EAAE,CAAA;QACvB,OAAO,CAAC,EAAE,mBAAmB,CAAA;KAC9B,CAAA;CACF;AAED,MAAM,MAAM,2BAA2B,GAAG,IAAI,CAC5C,mBAAmB,EACnB,eAAe,CAChB,GAAG;IACF,aAAa,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,kBAAkB,GAAG,kBAAkB,EAAE,CAAC,CAAA;IACtE,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,YAAY,CAAC,EAAE,2BAA2B,CAAA;IAC1C,aAAa,EAAE,2BAA2B,CAAA;IAC1C,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,IAAI,CAAC,EAAE,cAAc,EAAE,CAAA;IACvB,OAAO,CAAC,EAAE,mBAAmB,CAAA;CAC9B"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/joiner/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,EAAE,MAAM,CAAA;IACb,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC3B,CAAA;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACvB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;IACrB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC3B;AAED,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,KAAK,CAAC,EAAE,wBAAwB,GAAG,wBAAwB,EAAE,CAAA;IAC7D;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CACjB,MAAM,EACJ,MAAM,GACN;QACE,IAAI,EAAE,MAAM,CAAA;QACZ,sBAAsB,EAAE,MAAM,EAAE,CAAA;KACjC,CACJ,CAAA;IACD,WAAW,EAAE,MAAM,EAAE,CAAA;IACrB,aAAa,CAAC,EAAE,kBAAkB,EAAE,CAAA;IACpC,OAAO,CAAC,EAAE;QACR,WAAW,EAAE,MAAM,CAAA;QACnB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,YAAY,EAAE,kBAAkB,CAAA;KACjC,EAAE,CAAA;IACH;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC3B;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,GAAG,CAAA;CACZ;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,GAAG,CAAA;CACZ;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,KAAK,CAAC;QACd,QAAQ,EAAE,MAAM,CAAA;QAChB,MAAM,EAAE,MAAM,EAAE,CAAA;QAChB,IAAI,CAAC,EAAE,cAAc,EAAE,CAAA;QACvB,UAAU,CAAC,EAAE;YAAE,CAAC,KAAK,EAAE,MAAM,GAAG,eAAe,EAAE,CAAA;SAAE,CAAA;KACpD,CAAC,CAAA;IACF,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB,IAAI,CAAC,EAAE,cAAc,EAAE,CAAA;IACvB,UAAU,CAAC,EAAE;QAAE,CAAC,KAAK,EAAE,MAAM,GAAG,eAAe,EAAE,CAAA;KAAE,CAAA;CACpD;AAED,MAAM,WAAW,mBAAmB;IAClC,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,uBAAuB,CAAC,EAAE,OAAO,GAAG,MAAM,EAAE,CAAA;IAC5C,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CAChC;AAED,MAAM,WAAW,mBAAmB;IAClC,CAAC,GAAG,EAAE,MAAM,GAAG;QACb,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;QACjB,IAAI,CAAC,EAAE,cAAc,EAAE,CAAA;QACvB,OAAO,CAAC,EAAE,mBAAmB,CAAA;KAC9B,CAAA;CACF;AAED,MAAM,MAAM,2BAA2B,GAAG,IAAI,CAC5C,mBAAmB,EACnB,eAAe,CAChB,GAAG;IACF,aAAa,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,kBAAkB,GAAG,kBAAkB,EAAE,CAAC,CAAA;IACtE,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,YAAY,CAAC,EAAE,2BAA2B,CAAA;IAC1C,aAAa,EAAE,2BAA2B,CAAA;IAC1C,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,IAAI,CAAC,EAAE,cAAc,EAAE,CAAA;IACvB,OAAO,CAAC,EAAE,mBAAmB,CAAA;CAC9B"}

package/dist/modules-sdk/index.d.ts

@@ -174,6 +174,10 @@ export declare type ModuleJoinerRelationship = JoinerRelationship & {
      * If true, the link joiner will cascade deleting the relationship
      */
     deleteCascade?: boolean;
+    /**
+     * The fields to be filterable by the Index module using query.index
+     */
+    filterable?: string[];
     /**
      * Allow multiple relationships to exist for this
      * entity

package/dist/modules-sdk/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/modules-sdk/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAA;AAEnE,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAA;AAC3C,OAAO,EAAE,iBAAiB,EAAE,MAAM,QAAQ,CAAA;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAA;AACzD,OAAO,EACL,gBAAgB,EAChB,gBAAgB,EAChB,uBAAuB,EACvB,iCAAiC,EAClC,MAAM,mCAAmC,CAAA;AAE1C,OAAO,EACL,gBAAgB,EAChB,gBAAgB,EAChB,uBAAuB,EACvB,iCAAiC,GAClC,CAAA;AAED,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAA;AAEtE,cAAc,4BAA4B,CAAA;AAC1C,cAAc,2BAA2B,CAAA;AACzC,cAAc,mBAAmB,CAAA;AACjC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,6BAA6B,CAAA;AAC3C,cAAc,mBAAmB,CAAA;AAEjC,MAAM,MAAM,QAAQ,GAChB,OAAO,GACP,QAAQ,GACR,OAAO,GACP,MAAM,GACN,MAAM,GACN,KAAK,GACL,WAAW,CAAA;AACf,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,KAAK,GAAG,QAAQ,EAAE,CAAA;AAExD,MAAM,MAAM,sBAAsB,GAAG;IACnC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,KAAK,EAAE,UAAU,CAAA;IACjB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB,UAAU,CAAC,EAAE,sBAAsB,CAAA;IACnC,OAAO,CAAC,EAAE,MAAM,GAAG,aAAa,CAAA;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,WAAW,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAA;CAC7C,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,KAAK,EAAE,UAAU,CAAA;IACjB,UAAU,CAAC,EAAE,sBAAsB,CAAA;IACnC,MAAM,CAAC,EAAE;QACP,IAAI,EAAE,MAAM,CAAA;QACZ,GAAG,EAAE,MAAM,CAAA;QACX,SAAS,EAAE,OAAO,CAAA;KACnB,CAAA;IACD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;CACf,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,cAAc,EAAE,MAAM,GAAG,KAAK,CAAA;IAC9B,UAAU,EAAE,gBAAgB,CAAA;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB,iBAAiB,CAAC,EAAE,yBAAyB,GAAG,yBAAyB,CAAA;IACzE,aAAa,CAAC,EAAE,aAAa,GAAG,qBAAqB,CAAA;CACtD,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,GAAG,EAAE,MAAM,CAAA;IACX,cAAc,EAAE,MAAM,GAAG,KAAK,CAAA;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB,uGAAuG;IACvG,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B,wBAAwB,EACpB,yBAAyB,GACzB,yBAAyB,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;IACb,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB,wBAAwB,EAAE,yBAAyB,CAAA;CACpD,CAAA;AAED,KAAK,iBAAiB,GAAG,yBAAyB,GAAG,yBAAyB,CAAA;AAC9E,MAAM,MAAM,YAAY,GAAG,iBAAiB,GAAG;IAC7C,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,gBAAgB,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG;IACnC,cAAc,EAAE,kBAAkB,CAAA;IAClC,YAAY,EAAE,gBAAgB,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,aAAa,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;IAC9D,SAAS,EAAE,eAAe,CAAA;IAC1B,OAAO,CAAC,EAAE,QAAQ,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,CACjC,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,EAC3B,iBAAiB,CAAC,EAAE,yBAAyB,KAC1C,OAAO,CAAC,IAAI,CAAC,CAAA;AAElB,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,GAAG,KAAK,CAAA;CAC3B,EAAE,CAAA;AAEH,MAAM,MAAM,sBAAsB,GAAG,MAAM,CACzC,MAAM,EACN;IACE,IAAI,EACA,MAAM,GACN,MAAM,GACN,UAAU,GACV,QAAQ,GACR,MAAM,GACN,YAAY,GACZ,OAAO,GACP,WAAW,GACX,MAAM,GACN,MAAM,GACN,SAAS,GACT,UAAU,GACV,SAAS,GACT,WAAW,GACX,OAAO,GACP,QAAQ,GACR,SAAS,GACT,SAAS,GACT,QAAQ,GACR,MAAM,GACN,MAAM,CAAA;IACV,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAClC,CACF,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,CAAC,UAAU,EAAE,MAAM,GAAG;QAEpB,CAAC,SAAS,EAAE,MAAM,GAAG,GAAG,CAAA;KACzB,CAAA;CACF,GAAG;IACF,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,IAAI,CACnC,mBAAmB,EACnB,aAAa,GAAG,aAAa,GAAG,eAAe,GAAG,SAAS,CAC5D,GAAG;IACF;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,aAAa,CAAC,EAAE,wBAAwB,EAAE,CAAA;IAC1C,OAAO,CAAC,EAAE;QACR,WAAW,EAAE,MAAM,CAAA;QACnB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,UAAU,CAAC,EAAE,MAAM,CACjB,MAAM,EACJ,MAAM,GACN;YACE,IAAI,EAAE,MAAM,CAAA;YACZ,sBAAsB,CAAC,EAAE,MAAM,EAAE,CAAA;YACjC,MAAM,CAAC,EAAE,OAAO,CAAA;SACjB,CACJ,CAAA;QACD,YAAY,EAAE,IAAI,CAAC,wBAAwB,EAAE,SAAS,CAAC,CAAA;KACxD,EAAE,CAAA;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACrC;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAA;IAC1B,cAAc,CAAC,EAAE;QACf;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,WAAW,CAAC,EAAE,sBAAsB,CAAA;KACrC,CAAA;CACF,CAAA;AAED,MAAM,CAAC,OAAO,MAAM,wBAAwB,GAAG,kBAAkB,GAAG;IAClE;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,aAAa,CAAC,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,IAAI;IAChD,OAAO,EAAE,CAAC,CAAA;IACV,OAAO,CAAC,EAAE,oBAAoB,EAAE,CAAA;IAChC,aAAa,CAAC,CACZ,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,EAC3B,iBAAiB,CAAC,EAAE,yBAAyB,GAC5C,OAAO,CAAC,IAAI,CAAC,CAAA;IAChB,eAAe,CAAC,CACd,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,EAC3B,iBAAiB,CAAC,EAAE,yBAAyB,GAC5C,OAAO,CAAC,IAAI,CAAC,CAAA;IAChB,iBAAiB,CAAC,CAChB,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,EAC3B,iBAAiB,CAAC,EAAE,yBAAyB,GAC5C,OAAO,CAAC,IAAI,CAAC,CAAA;IAChB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB,CAAA;AAED,MAAM,WAAW,8BAA8B;IAC7C,QAAQ,EAAE;QACR;;WAEG;QACH,UAAU,CAAC,EAAE,GAAG,CAAA;QAChB,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;YACxC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;SACrC,CAAA;QACD,KAAK,CAAC,EAAE,OAAO,CAAA;QACf,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAC/B,CAAA;CACF;AAED,MAAM,MAAM,6CAA6C,GAAG;IAC1D,OAAO,CAAC,EAAE,GAAG,CAAA;IACb,YAAY,CAAC,EAAE;QACb,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAC,iBAAiB,CAAC,CAAA;KAC9C,CAAA;CACF,CAAA;AAED,MAAM,MAAM,0BAA0B,GAClC,yBAAyB,GACzB,yBAAyB,CAAA;AAK7B,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,cAAc,CAAC,IAAI,kBAAkB,CAAA;IAErC;;OAEG;IACH,OAAO,CAAC,EAAE;QACR,kBAAkB,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;QACxC,qBAAqB,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;QAC3C,4BAA4B,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;KACnD,CAAA;CACF"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/modules-sdk/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAA;AAEnE,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAA;AAC3C,OAAO,EAAE,iBAAiB,EAAE,MAAM,QAAQ,CAAA;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAA;AACzD,OAAO,EACL,gBAAgB,EAChB,gBAAgB,EAChB,uBAAuB,EACvB,iCAAiC,EAClC,MAAM,mCAAmC,CAAA;AAE1C,OAAO,EACL,gBAAgB,EAChB,gBAAgB,EAChB,uBAAuB,EACvB,iCAAiC,GAClC,CAAA;AAED,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAA;AAEtE,cAAc,4BAA4B,CAAA;AAC1C,cAAc,2BAA2B,CAAA;AACzC,cAAc,mBAAmB,CAAA;AACjC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,6BAA6B,CAAA;AAC3C,cAAc,mBAAmB,CAAA;AAEjC,MAAM,MAAM,QAAQ,GAChB,OAAO,GACP,QAAQ,GACR,OAAO,GACP,MAAM,GACN,MAAM,GACN,KAAK,GACL,WAAW,CAAA;AACf,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,KAAK,GAAG,QAAQ,EAAE,CAAA;AAExD,MAAM,MAAM,sBAAsB,GAAG;IACnC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,KAAK,EAAE,UAAU,CAAA;IACjB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB,UAAU,CAAC,EAAE,sBAAsB,CAAA;IACnC,OAAO,CAAC,EAAE,MAAM,GAAG,aAAa,CAAA;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,WAAW,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAA;CAC7C,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,KAAK,EAAE,UAAU,CAAA;IACjB,UAAU,CAAC,EAAE,sBAAsB,CAAA;IACnC,MAAM,CAAC,EAAE;QACP,IAAI,EAAE,MAAM,CAAA;QACZ,GAAG,EAAE,MAAM,CAAA;QACX,SAAS,EAAE,OAAO,CAAA;KACnB,CAAA;IACD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;CACf,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,cAAc,EAAE,MAAM,GAAG,KAAK,CAAA;IAC9B,UAAU,EAAE,gBAAgB,CAAA;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB,iBAAiB,CAAC,EAAE,yBAAyB,GAAG,yBAAyB,CAAA;IACzE,aAAa,CAAC,EAAE,aAAa,GAAG,qBAAqB,CAAA;CACtD,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,GAAG,EAAE,MAAM,CAAA;IACX,cAAc,EAAE,MAAM,GAAG,KAAK,CAAA;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB,uGAAuG;IACvG,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B,wBAAwB,EACpB,yBAAyB,GACzB,yBAAyB,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;IACb,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB,wBAAwB,EAAE,yBAAyB,CAAA;CACpD,CAAA;AAED,KAAK,iBAAiB,GAAG,yBAAyB,GAAG,yBAAyB,CAAA;AAC9E,MAAM,MAAM,YAAY,GAAG,iBAAiB,GAAG;IAC7C,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,gBAAgB,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG;IACnC,cAAc,EAAE,kBAAkB,CAAA;IAClC,YAAY,EAAE,gBAAgB,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,aAAa,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;IAC9D,SAAS,EAAE,eAAe,CAAA;IAC1B,OAAO,CAAC,EAAE,QAAQ,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,CACjC,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,EAC3B,iBAAiB,CAAC,EAAE,yBAAyB,KAC1C,OAAO,CAAC,IAAI,CAAC,CAAA;AAElB,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,GAAG,KAAK,CAAA;CAC3B,EAAE,CAAA;AAEH,MAAM,MAAM,sBAAsB,GAAG,MAAM,CACzC,MAAM,EACN;IACE,IAAI,EACA,MAAM,GACN,MAAM,GACN,UAAU,GACV,QAAQ,GACR,MAAM,GACN,YAAY,GACZ,OAAO,GACP,WAAW,GACX,MAAM,GACN,MAAM,GACN,SAAS,GACT,UAAU,GACV,SAAS,GACT,WAAW,GACX,OAAO,GACP,QAAQ,GACR,SAAS,GACT,SAAS,GACT,QAAQ,GACR,MAAM,GACN,MAAM,CAAA;IACV,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAClC,CACF,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,CAAC,UAAU,EAAE,MAAM,GAAG;QAEpB,CAAC,SAAS,EAAE,MAAM,GAAG,GAAG,CAAA;KACzB,CAAA;CACF,GAAG;IACF,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,IAAI,CACnC,mBAAmB,EACnB,aAAa,GAAG,aAAa,GAAG,eAAe,GAAG,SAAS,CAC5D,GAAG;IACF;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,aAAa,CAAC,EAAE,wBAAwB,EAAE,CAAA;IAC1C,OAAO,CAAC,EAAE;QACR,WAAW,EAAE,MAAM,CAAA;QACnB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,UAAU,CAAC,EAAE,MAAM,CACjB,MAAM,EACJ,MAAM,GACN;YACE,IAAI,EAAE,MAAM,CAAA;YACZ,sBAAsB,CAAC,EAAE,MAAM,EAAE,CAAA;YACjC,MAAM,CAAC,EAAE,OAAO,CAAA;SACjB,CACJ,CAAA;QACD,YAAY,EAAE,IAAI,CAAC,wBAAwB,EAAE,SAAS,CAAC,CAAA;KACxD,EAAE,CAAA;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACrC;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAA;IAC1B,cAAc,CAAC,EAAE;QACf;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,WAAW,CAAC,EAAE,sBAAsB,CAAA;KACrC,CAAA;CACF,CAAA;AAED,MAAM,CAAC,OAAO,MAAM,wBAAwB,GAAG,kBAAkB,GAAG;IAClE;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;IACrB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,aAAa,CAAC,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,IAAI;IAChD,OAAO,EAAE,CAAC,CAAA;IACV,OAAO,CAAC,EAAE,oBAAoB,EAAE,CAAA;IAChC,aAAa,CAAC,CACZ,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,EAC3B,iBAAiB,CAAC,EAAE,yBAAyB,GAC5C,OAAO,CAAC,IAAI,CAAC,CAAA;IAChB,eAAe,CAAC,CACd,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,EAC3B,iBAAiB,CAAC,EAAE,yBAAyB,GAC5C,OAAO,CAAC,IAAI,CAAC,CAAA;IAChB,iBAAiB,CAAC,CAChB,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,EAC3B,iBAAiB,CAAC,EAAE,yBAAyB,GAC5C,OAAO,CAAC,IAAI,CAAC,CAAA;IAChB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB,CAAA;AAED,MAAM,WAAW,8BAA8B;IAC7C,QAAQ,EAAE;QACR;;WAEG;QACH,UAAU,CAAC,EAAE,GAAG,CAAA;QAChB,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;YACxC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;SACrC,CAAA;QACD,KAAK,CAAC,EAAE,OAAO,CAAA;QACf,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAC/B,CAAA;CACF;AAED,MAAM,MAAM,6CAA6C,GAAG;IAC1D,OAAO,CAAC,EAAE,GAAG,CAAA;IACb,YAAY,CAAC,EAAE;QACb,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAC,iBAAiB,CAAC,CAAA;KAC9C,CAAA;CACF,CAAA;AAED,MAAM,MAAM,0BAA0B,GAClC,yBAAyB,GACzB,yBAAyB,CAAA;AAK7B,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,cAAc,CAAC,IAAI,kBAAkB,CAAA;IAErC;;OAEG;IACH,OAAO,CAAC,EAAE;QACR,kBAAkB,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;QACxC,qBAAqB,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;QAC3C,4BAA4B,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;KACnD,CAAA;CACF"}

package/dist/modules-sdk/remote-query.d.ts

@@ -1,8 +1,8 @@
 import { Prettify } from "../common";
+import { IndexQueryInput, QueryResultSet } from "../index-data/query-config/query-input-config";
 import { RemoteJoinerOptions, RemoteJoinerQuery } from "../joiner";
 import { RemoteQueryEntryPoints } from "./remote-query-entry-points";
 import { RemoteQueryInput, RemoteQueryObjectConfig, RemoteQueryObjectFromStringResult } from "./remote-query-object-from-string";
-import { RemoteQueryFilters } from "./to-remote-query";
 export type RemoteQueryFunctionReturnPagination = {
     skip: number;
     take: number;
@@ -25,14 +25,12 @@ export type QueryGraphFunction = {
     <const TEntry extends string>(queryConfig: RemoteQueryInput<TEntry>, options?: RemoteJoinerOptions): Promise<Prettify<GraphResultSet<TEntry>>>;
 };
 /**
- * QueryIndexFunction is a wrapper on top of remoteQuery
+ * QueryIndexFunction is a wrapper on top of indexModule
  * that simplifies the input it accepts and returns
  * a normalized/consistent output.
  */
 export type QueryIndexFunction = {
-    <const TEntry extends string>(queryOptions: RemoteQueryInput<TEntry> & {
-        joinFilters?: RemoteQueryFilters<TEntry>;
-    }, options?: RemoteJoinerOptions): Promise<Prettify<GraphResultSet<TEntry>>>;
+    <const TEntry extends string>(queryOptions: IndexQueryInput<TEntry>): Promise<Prettify<QueryResultSet<TEntry>>>;
 };
 export type RemoteQueryFunction = {
     /**

package/dist/modules-sdk/remote-query.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"remote-query.d.ts","sourceRoot":"","sources":["../../src/modules-sdk/remote-query.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA;AACpC,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAClE,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAA;AACpE,OAAO,EACL,gBAAgB,EAChB,uBAAuB,EACvB,iCAAiC,EAClC,MAAM,mCAAmC,CAAA;AAC1C,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAItD,MAAM,MAAM,mCAAmC,GAAG;IAChD,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,MAAM,SAAS,MAAM,IAAI;IAClD,IAAI,EAAE,MAAM,SAAS,MAAM,sBAAsB,GAC7C,sBAAsB,CAAC,MAAM,CAAC,EAAE,GAChC,GAAG,EAAE,CAAA;IACT,QAAQ,CAAC,EAAE,mCAAmC,CAAA;CAC/C,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,CAAC,KAAK,CAAC,MAAM,SAAS,MAAM,EAC1B,WAAW,EAAE,gBAAgB,CAAC,MAAM,CAAC,EACrC,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;CAC7C,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,CAAC,KAAK,CAAC,MAAM,SAAS,MAAM,EAC1B,YAAY,EAAE,gBAAgB,CAAC,MAAM,CAAC,GAAG;QACvC,WAAW,CAAC,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAA;KACzC,EACD,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;CAC7C,CAAA;AAiCD,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;;OAIG;IACH,CAAC,KAAK,CAAC,MAAM,SAAS,MAAM,EAC1B,WAAW,EAAE,uBAAuB,CAAC,MAAM,CAAC,EAC5C,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,GAAG,CAAC,CAAA;IAEf;;;;OAIG;IACH,CAAC,KAAK,CAAC,OAAO,SAAS,iCAAiC,CAAC,GAAG,CAAC,EAC3D,WAAW,EAAE,OAAO,EACpB,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,GAAG,CAAC,CAAA;IACf;;;;OAIG;IACH,CAAC,KAAK,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;IAEvE;;;OAGG;IACH,KAAK,EAAE,kBAAkB,CAAA;IAEzB;;;OAGG;IACH,KAAK,EAAE,kBAAkB,CAAA;IAEzB;;;;;OAKG;IACH,GAAG,EAAE,CACH,KAAK,EAAE,MAAM,EACb,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACnC,OAAO,CAAC,EAAE,mBAAmB,KAC1B,OAAO,CAAC,GAAG,CAAC,CAAA;CAClB,CAAA;AAED,MAAM,WAAW,KAAK;IACpB;;;;OAIG;IACH,KAAK,CAAC,KAAK,CAAC,MAAM,SAAS,MAAM,EAC/B,WAAW,EAAE,uBAAuB,CAAC,MAAM,CAAC,EAC5C,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,GAAG,CAAC,CAAA;IAEf;;;;OAIG;IACH,KAAK,CAAC,KAAK,CAAC,OAAO,SAAS,iCAAiC,CAAC,GAAG,CAAC,EAChE,WAAW,EAAE,OAAO,EACpB,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,GAAG,CAAC,CAAA;IACf;;;;OAIG;IACH,KAAK,CAAC,KAAK,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;IAE5E;;;OAGG;IACH,KAAK,EAAE,kBAAkB,CAAA;IAEzB;;;;;OAKG;IACH,GAAG,EAAE,CACH,KAAK,EAAE,MAAM,EACb,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACnC,OAAO,CAAC,EAAE,mBAAmB,KAC1B,OAAO,CAAC,GAAG,CAAC,CAAA;CAClB"}
+{"version":3,"file":"remote-query.d.ts","sourceRoot":"","sources":["../../src/modules-sdk/remote-query.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA;AACpC,OAAO,EACL,eAAe,EACf,cAAc,EACf,MAAM,+CAA+C,CAAA;AACtD,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAClE,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAA;AACpE,OAAO,EACL,gBAAgB,EAChB,uBAAuB,EACvB,iCAAiC,EAClC,MAAM,mCAAmC,CAAA;AAI1C,MAAM,MAAM,mCAAmC,GAAG;IAChD,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,MAAM,SAAS,MAAM,IAAI;IAClD,IAAI,EAAE,MAAM,SAAS,MAAM,sBAAsB,GAC7C,sBAAsB,CAAC,MAAM,CAAC,EAAE,GAChC,GAAG,EAAE,CAAA;IACT,QAAQ,CAAC,EAAE,mCAAmC,CAAA;CAC/C,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,CAAC,KAAK,CAAC,MAAM,SAAS,MAAM,EAC1B,WAAW,EAAE,gBAAgB,CAAC,MAAM,CAAC,EACrC,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;CAC7C,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,CAAC,KAAK,CAAC,MAAM,SAAS,MAAM,EAAE,YAAY,EAAE,eAAe,CAAC,MAAM,CAAC,GAAG,OAAO,CAC3E,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CACjC,CAAA;CACF,CAAA;AAiCD,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;;OAIG;IACH,CAAC,KAAK,CAAC,MAAM,SAAS,MAAM,EAC1B,WAAW,EAAE,uBAAuB,CAAC,MAAM,CAAC,EAC5C,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,GAAG,CAAC,CAAA;IAEf;;;;OAIG;IACH,CAAC,KAAK,CAAC,OAAO,SAAS,iCAAiC,CAAC,GAAG,CAAC,EAC3D,WAAW,EAAE,OAAO,EACpB,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,GAAG,CAAC,CAAA;IACf;;;;OAIG;IACH,CAAC,KAAK,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;IAEvE;;;OAGG;IACH,KAAK,EAAE,kBAAkB,CAAA;IAEzB;;;OAGG;IACH,KAAK,EAAE,kBAAkB,CAAA;IAEzB;;;;;OAKG;IACH,GAAG,EAAE,CACH,KAAK,EAAE,MAAM,EACb,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACnC,OAAO,CAAC,EAAE,mBAAmB,KAC1B,OAAO,CAAC,GAAG,CAAC,CAAA;CAClB,CAAA;AAED,MAAM,WAAW,KAAK;IACpB;;;;OAIG;IACH,KAAK,CAAC,KAAK,CAAC,MAAM,SAAS,MAAM,EAC/B,WAAW,EAAE,uBAAuB,CAAC,MAAM,CAAC,EAC5C,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,GAAG,CAAC,CAAA;IAEf;;;;OAIG;IACH,KAAK,CAAC,KAAK,CAAC,OAAO,SAAS,iCAAiC,CAAC,GAAG,CAAC,EAChE,WAAW,EAAE,OAAO,EACpB,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,GAAG,CAAC,CAAA;IACf;;;;OAIG;IACH,KAAK,CAAC,KAAK,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;IAE5E;;;OAGG;IACH,KAAK,EAAE,kBAAkB,CAAA;IAEzB;;;;;OAKG;IACH,GAAG,EAAE,CACH,KAAK,EAAE,MAAM,EACb,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACnC,OAAO,CAAC,EAAE,mBAAmB,KAC1B,OAAO,CAAC,GAAG,CAAC,CAAA;CAClB"}

package/dist/order/common.d.ts

@@ -255,7 +255,7 @@ export interface OrderAddressDTO {
      */
     country_code?: string;
     /**
-     * The province/state of the address.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province/state of the address.
      */
     province?: string;
     /**

package/dist/order/mutations.d.ts

@@ -39,7 +39,7 @@ export interface UpsertOrderAddressDTO {
      */
     country_code?: string;
     /**
-     * The province of the address.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province of the address.
      */
     province?: string;
     /**

package/dist/order/service.d.ts

@@ -667,8 +667,8 @@ export interface IOrderModuleService extends IModuleService {
      *     last_name: "Doe",
      *     address_1: "123 Main St",
      *     city: "Anytown",
-     *     country_code: "US",
-     *     province: "AnyState",
+     *     country_code: "us",
+     *     province: "us-ca",
      *     postal_code: "12345"
      *   }
      * ])
@@ -690,8 +690,8 @@ export interface IOrderModuleService extends IModuleService {
      *   last_name: "Doe",
      *   address_1: "123 Main St",
      *   city: "Anytown",
-     *   country_code: "US",
-     *   province: "AnyState",
+     *   country_code: "us",
+     *   province: "us-ca",
      *   postal_code: "12345"
      * })
      * ```

package/dist/stock-location/common.d.ts

@@ -99,7 +99,7 @@ export type StockLocationAddressDTO = {
      */
     postal_code?: string | null;
     /**
-     * The province of the stock location address.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province of the stock location address.
      */
     province?: string | null;
     /**
@@ -273,8 +273,8 @@ export interface FilterableStockLocationProps extends BaseFilterable<FilterableS
  *     example: HD3-1G8
  *   province:
  *     type: string
- *     description: Stock location address' province
- *     example: Sinaloa
+ *     description: Stock location address' lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province
+ *     example: us-ca
  *   metadata:
  *     type: object
  *     description: An optional key-value map with additional details
@@ -302,7 +302,7 @@ export type StockLocationAddressInput = {
      */
     phone?: string | null;
     /**
-     * The province of the stock location address.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province of the stock location address.
      */
     province?: string | null;
     /**

package/dist/tax/common.d.ts

@@ -127,7 +127,7 @@ export interface TaxRegionDTO {
      */
     country_code: string;
     /**
-     * The province code of the tax region.
+     * 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;
     /**
@@ -162,6 +162,7 @@ export interface TaxRegionDTO {
 export interface FilterableTaxRegionProps extends BaseFilterable<FilterableTaxRegionProps> {
     /**
      * Find tax regions based on currency and province codes through this search term.
+     * The province code is the lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province or state code.
      */
     q?: string;
     /**
@@ -173,7 +174,7 @@ export interface FilterableTaxRegionProps extends BaseFilterable<FilterableTaxRe
      */
     country_code?: string | string[] | OperatorMap<string>;
     /**
-     * Filter the tax regions by their province code.
+     * Filter the tax regions by their lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province or state code.
      */
     province_code?: string | string[] | OperatorMap<string>;
     /**
@@ -346,7 +347,7 @@ export interface TaxCalculationContext {
          */
         country_code: string;
         /**
-         * The province code.
+         * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province or state code.
          */
         province_code?: string | null;
         /**

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

@@ -1 +1 @@
-{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/tax/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAA;AACvC,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAE1C;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;;;OAIG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IAEnB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAExC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;;;OAIG;IACH,aAAa,EAAE,OAAO,CAAA;IAEtB;;OAEG;IACH,UAAU,EAAE,OAAO,CAAA;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;IAEvB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,UAAU,EAAE,OAAO,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,sBACf,SAAQ,cAAc,CAAC,sBAAsB,CAAC;IAC9C;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEtB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAE9C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAE9C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAE9C;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAE5B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAExC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,wBACf,SAAQ,cAAc,CAAC,wBAAwB,CAAC;IAChD;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAEtD;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAEvD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAEnD;;OAEG;IACH,QAAQ,CAAC,EACL,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACvB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GACzB,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IAExC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;;;;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,UAAU,CAAA;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAEzC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,0BACf,SAAQ,cAAc,CAAC,0BAA0B,CAAC;IAClD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAEnD;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAEtD;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAErD;;OAEG;IACH,QAAQ,CAAC,EAAE,sBAAsB,CAAA;IAEjC;;OAEG;IACH,QAAQ,CAAC,EACL,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACvB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GACzB,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IAExC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAA;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,cAAc,CAAA;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,UAAU,CAAC,EAAE,cAAc,CAAA;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,EAAE;QACP;;WAEG;QACH,YAAY,EAAE,MAAM,CAAA;QAEpB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QAE7B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAA;QAElB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;QAEb;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAA;QAEpB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;KAC1C,CAAA;IAED;;OAEG;IACH,QAAQ,CAAC,EAAE;QACT;;WAEG;QACH,EAAE,EAAE,MAAM,CAAA;QAEV;;WAEG;QACH,KAAK,EAAE,MAAM,CAAA;QAEb;;WAEG;QACH,eAAe,EAAE,MAAM,EAAE,CAAA;QAEzB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;KAC1C,CAAA;IAED;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED;;GAEG;AACH,UAAU,UAAU;IAClB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAA;CACzB"}
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/tax/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAA;AACvC,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAE1C;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;;;OAIG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IAEnB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAExC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;;;OAIG;IACH,aAAa,EAAE,OAAO,CAAA;IAEtB;;OAEG;IACH,UAAU,EAAE,OAAO,CAAA;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;IAEvB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,UAAU,EAAE,OAAO,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,sBACf,SAAQ,cAAc,CAAC,sBAAsB,CAAC;IAC9C;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEtB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAE9C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAE9C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAE9C;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAE5B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAExC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,wBACf,SAAQ,cAAc,CAAC,wBAAwB,CAAC;IAChD;;;OAGG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAEtD;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAEvD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAEnD;;OAEG;IACH,QAAQ,CAAC,EACL,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACvB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GACzB,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IAExC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;;;;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,UAAU,CAAA;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAEzC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,0BACf,SAAQ,cAAc,CAAC,0BAA0B,CAAC;IAClD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAEnD;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAEtD;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAErD;;OAEG;IACH,QAAQ,CAAC,EAAE,sBAAsB,CAAA;IAEjC;;OAEG;IACH,QAAQ,CAAC,EACL,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACvB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GACzB,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IAExC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAA;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,cAAc,CAAA;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,UAAU,CAAC,EAAE,cAAc,CAAA;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,EAAE;QACP;;WAEG;QACH,YAAY,EAAE,MAAM,CAAA;QAEpB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QAE7B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAA;QAElB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;QAEb;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAA;QAEpB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;KAC1C,CAAA;IAED;;OAEG;IACH,QAAQ,CAAC,EAAE;QACT;;WAEG;QACH,EAAE,EAAE,MAAM,CAAA;QAEV;;WAEG;QACH,KAAK,EAAE,MAAM,CAAA;QAEb;;WAEG;QACH,eAAe,EAAE,MAAM,EAAE,CAAA;QAEzB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;KAC1C,CAAA;IAED;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED;;GAEG;AACH,UAAU,UAAU;IAClB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAA;CACzB"}

package/dist/tax/mutations.d.ts

@@ -132,7 +132,7 @@ export interface CreateTaxRegionDTO {
      */
     country_code: string;
     /**
-     * The province code of the tax region.
+     * 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;
     /**
@@ -182,7 +182,7 @@ export interface UpdateTaxRegionDTO {
      */
     id: string;
     /**
-     * The province code of the tax region.
+     * 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;
     /**

package/dist/tax/service.d.ts

@@ -336,7 +336,7 @@ export interface ITaxModuleService extends IModuleService {
      *
      * @example
      * const taxRegion = await taxModule.updateTaxRegions({
-     *   province_code: "be",
+     *   province_code: "us-ca",
      * })
      */
     updateTaxRegions(data: UpdateTaxRegionDTO, sharedContext?: Context): Promise<TaxRegionDTO>;
@@ -351,11 +351,11 @@ export interface ITaxModuleService extends IModuleService {
      * const taxRegions = await taxModule.updateTaxRegions([
      *   {
      *     id: "tx-1",
-     *     province_code: "be",
+     *     province_code: "us-ca",
      *   },
      *   {
      *     id: "tx-2",
-     *     province_code: "ca",
+     *     province_code: "us-ny",
      *   },
      * ])
      */

package/dist/workflow/fulfillment/create-fulfillment.d.ts

@@ -31,7 +31,7 @@ export type CreateFulfillmentAddressWorkflowDTO = {
      */
     country_code?: string | null;
     /**
-     * The province of the fulfillment address.
+     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province of the fulfillment address.
      */
     province?: string | null;
     /**

package/dist/workflow/order/begin-order-edit.d.ts

@@ -8,6 +8,9 @@ export interface BeginorderEditWorkflowInput {
     order_id: string;
     /**
      * The ID of the user requesting the order edit.
+     *
+     * @example
+     * "user_123"
      */
     created_by?: string;
     /**

package/dist/workflow/order/begin-order-edit.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"begin-order-edit.d.ts","sourceRoot":"","sources":["../../../src/workflow/order/begin-order-edit.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C"}
+{"version":3,"file":"begin-order-edit.d.ts","sourceRoot":"","sources":["../../../src/workflow/order/begin-order-edit.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@medusajs/types",
-  "version": "2.7.2-snapshot-20250423182346",
+  "version": "2.7.2-snapshot-20250424113529",
   "description": "Medusa Types definition",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",