@payloadcms/plugin-ecommerce 3.57.0-internal.f26caed → 3.58.0-canary.4

package/dist/utilities/pushTypeScriptProperties.js

@@ -0,0 +1,37 @@
+export const pushTypeScriptProperties = ({ collectionSlugMap, jsonSchema })=>{
+    if (!jsonSchema.properties) {
+        jsonSchema.properties = {};
+    }
+    if (Array.isArray(jsonSchema.required)) {
+        jsonSchema.required.push('ecommerce');
+    }
+    const requiredCollectionProperties = [];
+    const propertiesMap = new Map();
+    Object.entries(collectionSlugMap).forEach(([key, slug])=>{
+        propertiesMap.set(key, {
+            $ref: `#/definitions/${slug}`
+        });
+        requiredCollectionProperties.push(slug);
+    });
+    jsonSchema.properties.ecommerce = {
+        type: 'object',
+        additionalProperties: false,
+        description: 'Generated by the Payload Ecommerce plugin',
+        properties: {
+            collections: {
+                type: 'object',
+                additionalProperties: false,
+                properties: {
+                    ...Object.fromEntries(propertiesMap)
+                },
+                required: requiredCollectionProperties
+            }
+        },
+        required: [
+            'collections'
+        ]
+    };
+    return jsonSchema;
+};
+
+//# sourceMappingURL=pushTypeScriptProperties.js.map

package/dist/utilities/pushTypeScriptProperties.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/utilities/pushTypeScriptProperties.ts"],"sourcesContent":["import type { I18n } from '@payloadcms/translations'\nimport type { JSONSchema4 } from 'json-schema'\nimport type { SanitizedConfig } from 'payload'\n\nimport type { CollectionSlugMap, SanitizedEcommercePluginConfig } from '../types/index.js'\n\nexport const pushTypeScriptProperties = ({\n  collectionSlugMap,\n  jsonSchema,\n}: {\n  collectionSlugMap: CollectionSlugMap\n  config: SanitizedConfig\n  jsonSchema: JSONSchema4\n  sanitizedPluginConfig: SanitizedEcommercePluginConfig\n}): JSONSchema4 => {\n  if (!jsonSchema.properties) {\n    jsonSchema.properties = {}\n  }\n\n  if (Array.isArray(jsonSchema.required)) {\n    jsonSchema.required.push('ecommerce')\n  }\n\n  const requiredCollectionProperties: string[] = []\n  const propertiesMap = new Map<string, { $ref: string }>()\n\n  Object.entries(collectionSlugMap).forEach(([key, slug]) => {\n    propertiesMap.set(key, { $ref: `#/definitions/${slug}` })\n\n    requiredCollectionProperties.push(slug)\n  })\n\n  jsonSchema.properties.ecommerce = {\n    type: 'object',\n    additionalProperties: false,\n    description: 'Generated by the Payload Ecommerce plugin',\n    properties: {\n      collections: {\n        type: 'object',\n        additionalProperties: false,\n        properties: {\n          ...Object.fromEntries(propertiesMap),\n        },\n        required: requiredCollectionProperties,\n      },\n    },\n    required: ['collections'],\n  }\n\n  return jsonSchema\n}\n"],"names":["pushTypeScriptProperties","collectionSlugMap","jsonSchema","properties","Array","isArray","required","push","requiredCollectionProperties","propertiesMap","Map","Object","entries","forEach","key","slug","set","$ref","ecommerce","type","additionalProperties","description","collections","fromEntries"],"mappings":"AAMA,OAAO,MAAMA,2BAA2B,CAAC,EACvCC,iBAAiB,EACjBC,UAAU,EAMX;IACC,IAAI,CAACA,WAAWC,UAAU,EAAE;QAC1BD,WAAWC,UAAU,GAAG,CAAC;IAC3B;IAEA,IAAIC,MAAMC,OAAO,CAACH,WAAWI,QAAQ,GAAG;QACtCJ,WAAWI,QAAQ,CAACC,IAAI,CAAC;IAC3B;IAEA,MAAMC,+BAAyC,EAAE;IACjD,MAAMC,gBAAgB,IAAIC;IAE1BC,OAAOC,OAAO,CAACX,mBAAmBY,OAAO,CAAC,CAAC,CAACC,KAAKC,KAAK;QACpDN,cAAcO,GAAG,CAACF,KAAK;YAAEG,MAAM,CAAC,cAAc,EAAEF,MAAM;QAAC;QAEvDP,6BAA6BD,IAAI,CAACQ;IACpC;IAEAb,WAAWC,UAAU,CAACe,SAAS,GAAG;QAChCC,MAAM;QACNC,sBAAsB;QACtBC,aAAa;QACblB,YAAY;YACVmB,aAAa;gBACXH,MAAM;gBACNC,sBAAsB;gBACtBjB,YAAY;oBACV,GAAGQ,OAAOY,WAAW,CAACd,cAAc;gBACtC;gBACAH,UAAUE;YACZ;QACF;QACAF,UAAU;YAAC;SAAc;IAC3B;IAEA,OAAOJ;AACT,EAAC"}

package/dist/utilities/sanitizePluginConfig.d.ts

@@ -1,4 +1,4 @@
-import type { EcommercePluginConfig, SanitizedEcommercePluginConfig } from '../types.js';
+import type { EcommercePluginConfig, SanitizedEcommercePluginConfig } from '../types/index.js';
 type Props = {
     pluginConfig: EcommercePluginConfig;
 };

package/dist/utilities/sanitizePluginConfig.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sanitizePluginConfig.d.ts","sourceRoot":"","sources":["../../src/utilities/sanitizePluginConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,8BAA8B,EAAE,MAAM,aAAa,CAAA;AAKxF,KAAK,KAAK,GAAG;IACX,YAAY,EAAE,qBAAqB,CAAA;CACpC,CAAA;AAED,eAAO,MAAM,oBAAoB,qBAAsB,KAAK,KAAG,8BAkF9D,CAAA"}
+{"version":3,"file":"sanitizePluginConfig.d.ts","sourceRoot":"","sources":["../../src/utilities/sanitizePluginConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,8BAA8B,EAAE,MAAM,mBAAmB,CAAA;AAK9F,KAAK,KAAK,GAAG;IACX,YAAY,EAAE,qBAAqB,CAAA;CACpC,CAAA;AAED,eAAO,MAAM,oBAAoB,qBAAsB,KAAK,KAAG,8BAkF9D,CAAA"}

package/dist/utilities/sanitizePluginConfig.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utilities/sanitizePluginConfig.ts"],"sourcesContent":["import type { EcommercePluginConfig, SanitizedEcommercePluginConfig } from '../types.js'\n\nimport { defaultAddressFields } from '../collections/addresses/defaultAddressFields.js'\nimport { USD } from '../currencies/index.js'\n\ntype Props = {\n  pluginConfig: EcommercePluginConfig\n}\n\nexport const sanitizePluginConfig = ({ pluginConfig }: Props): SanitizedEcommercePluginConfig => {\n  const config = {\n    ...pluginConfig,\n  } as Partial<SanitizedEcommercePluginConfig>\n\n  if (typeof config.customers === 'undefined') {\n    config.customers = {\n      slug: 'users',\n    }\n  }\n\n  if (\n    typeof config.addresses === 'undefined' ||\n    (typeof config.addresses === 'boolean' && config.addresses === true)\n  ) {\n    config.addresses = {\n      addressFields: defaultAddressFields(),\n    }\n  } else {\n    const addressFields =\n      (typeof pluginConfig.addresses === 'object' &&\n        typeof pluginConfig.addresses.addressFields === 'function' &&\n        pluginConfig.addresses.addressFields({\n          defaultFields: defaultAddressFields(),\n        })) ||\n      defaultAddressFields()\n\n    config.addresses = {\n      ...config.addresses,\n      addressFields,\n    }\n  }\n\n  if (!config.currencies) {\n    config.currencies = {\n      defaultCurrency: 'USD',\n      supportedCurrencies: [USD],\n    }\n  }\n\n  if (\n    typeof config.inventory === 'undefined' ||\n    (typeof config.inventory === 'boolean' && config.inventory === true)\n  ) {\n    config.inventory = {\n      fieldName: 'inventory',\n    }\n  }\n\n  if (typeof config.carts === 'undefined') {\n    config.carts = true\n  }\n\n  if (typeof config.orders === 'undefined') {\n    config.orders = true\n  }\n\n  if (typeof config.transactions === 'undefined') {\n    config.transactions = true\n  }\n\n  if (typeof config.payments === 'undefined') {\n    config.payments = {\n      paymentMethods: [],\n    }\n  } else if (!config.payments.paymentMethods) {\n    config.payments.paymentMethods = []\n  }\n\n  if (config.products) {\n    if (typeof config.products === 'object' && typeof config.products.variants === 'undefined') {\n      config.products.variants = true\n    }\n  }\n\n  config.access = {\n    authenticatedOnly: ({ req: { user } }) => Boolean(user),\n    publicAccess: () => true,\n    ...pluginConfig.access,\n  }\n\n  return config as SanitizedEcommercePluginConfig\n}\n"],"names":["defaultAddressFields","USD","sanitizePluginConfig","pluginConfig","config","customers","slug","addresses","addressFields","defaultFields","currencies","defaultCurrency","supportedCurrencies","inventory","fieldName","carts","orders","transactions","payments","paymentMethods","products","variants","access","authenticatedOnly","req","user","Boolean","publicAccess"],"mappings":"AAEA,SAASA,oBAAoB,QAAQ,mDAAkD;AACvF,SAASC,GAAG,QAAQ,yBAAwB;AAM5C,OAAO,MAAMC,uBAAuB,CAAC,EAAEC,YAAY,EAAS;IAC1D,MAAMC,SAAS;QACb,GAAGD,YAAY;IACjB;IAEA,IAAI,OAAOC,OAAOC,SAAS,KAAK,aAAa;QAC3CD,OAAOC,SAAS,GAAG;YACjBC,MAAM;QACR;IACF;IAEA,IACE,OAAOF,OAAOG,SAAS,KAAK,eAC3B,OAAOH,OAAOG,SAAS,KAAK,aAAaH,OAAOG,SAAS,KAAK,MAC/D;QACAH,OAAOG,SAAS,GAAG;YACjBC,eAAeR;QACjB;IACF,OAAO;QACL,MAAMQ,gBACJ,AAAC,OAAOL,aAAaI,SAAS,KAAK,YACjC,OAAOJ,aAAaI,SAAS,CAACC,aAAa,KAAK,cAChDL,aAAaI,SAAS,CAACC,aAAa,CAAC;YACnCC,eAAeT;QACjB,MACFA;QAEFI,OAAOG,SAAS,GAAG;YACjB,GAAGH,OAAOG,SAAS;YACnBC;QACF;IACF;IAEA,IAAI,CAACJ,OAAOM,UAAU,EAAE;QACtBN,OAAOM,UAAU,GAAG;YAClBC,iBAAiB;YACjBC,qBAAqB;gBAACX;aAAI;QAC5B;IACF;IAEA,IACE,OAAOG,OAAOS,SAAS,KAAK,eAC3B,OAAOT,OAAOS,SAAS,KAAK,aAAaT,OAAOS,SAAS,KAAK,MAC/D;QACAT,OAAOS,SAAS,GAAG;YACjBC,WAAW;QACb;IACF;IAEA,IAAI,OAAOV,OAAOW,KAAK,KAAK,aAAa;QACvCX,OAAOW,KAAK,GAAG;IACjB;IAEA,IAAI,OAAOX,OAAOY,MAAM,KAAK,aAAa;QACxCZ,OAAOY,MAAM,GAAG;IAClB;IAEA,IAAI,OAAOZ,OAAOa,YAAY,KAAK,aAAa;QAC9Cb,OAAOa,YAAY,GAAG;IACxB;IAEA,IAAI,OAAOb,OAAOc,QAAQ,KAAK,aAAa;QAC1Cd,OAAOc,QAAQ,GAAG;YAChBC,gBAAgB,EAAE;QACpB;IACF,OAAO,IAAI,CAACf,OAAOc,QAAQ,CAACC,cAAc,EAAE;QAC1Cf,OAAOc,QAAQ,CAACC,cAAc,GAAG,EAAE;IACrC;IAEA,IAAIf,OAAOgB,QAAQ,EAAE;QACnB,IAAI,OAAOhB,OAAOgB,QAAQ,KAAK,YAAY,OAAOhB,OAAOgB,QAAQ,CAACC,QAAQ,KAAK,aAAa;YAC1FjB,OAAOgB,QAAQ,CAACC,QAAQ,GAAG;QAC7B;IACF;IAEAjB,OAAOkB,MAAM,GAAG;QACdC,mBAAmB,CAAC,EAAEC,KAAK,EAAEC,IAAI,EAAE,EAAE,GAAKC,QAAQD;QAClDE,cAAc,IAAM;QACpB,GAAGxB,aAAamB,MAAM;IACxB;IAEA,OAAOlB;AACT,EAAC"}
+{"version":3,"sources":["../../src/utilities/sanitizePluginConfig.ts"],"sourcesContent":["import type { EcommercePluginConfig, SanitizedEcommercePluginConfig } from '../types/index.js'\n\nimport { defaultAddressFields } from '../collections/addresses/defaultAddressFields.js'\nimport { USD } from '../currencies/index.js'\n\ntype Props = {\n  pluginConfig: EcommercePluginConfig\n}\n\nexport const sanitizePluginConfig = ({ pluginConfig }: Props): SanitizedEcommercePluginConfig => {\n  const config = {\n    ...pluginConfig,\n  } as Partial<SanitizedEcommercePluginConfig>\n\n  if (typeof config.customers === 'undefined') {\n    config.customers = {\n      slug: 'users',\n    }\n  }\n\n  if (\n    typeof config.addresses === 'undefined' ||\n    (typeof config.addresses === 'boolean' && config.addresses === true)\n  ) {\n    config.addresses = {\n      addressFields: defaultAddressFields(),\n    }\n  } else {\n    const addressFields =\n      (typeof pluginConfig.addresses === 'object' &&\n        typeof pluginConfig.addresses.addressFields === 'function' &&\n        pluginConfig.addresses.addressFields({\n          defaultFields: defaultAddressFields(),\n        })) ||\n      defaultAddressFields()\n\n    config.addresses = {\n      ...config.addresses,\n      addressFields,\n    }\n  }\n\n  if (!config.currencies) {\n    config.currencies = {\n      defaultCurrency: 'USD',\n      supportedCurrencies: [USD],\n    }\n  }\n\n  if (\n    typeof config.inventory === 'undefined' ||\n    (typeof config.inventory === 'boolean' && config.inventory === true)\n  ) {\n    config.inventory = {\n      fieldName: 'inventory',\n    }\n  }\n\n  if (typeof config.carts === 'undefined') {\n    config.carts = true\n  }\n\n  if (typeof config.orders === 'undefined') {\n    config.orders = true\n  }\n\n  if (typeof config.transactions === 'undefined') {\n    config.transactions = true\n  }\n\n  if (typeof config.payments === 'undefined') {\n    config.payments = {\n      paymentMethods: [],\n    }\n  } else if (!config.payments.paymentMethods) {\n    config.payments.paymentMethods = []\n  }\n\n  if (config.products) {\n    if (typeof config.products === 'object' && typeof config.products.variants === 'undefined') {\n      config.products.variants = true\n    }\n  }\n\n  config.access = {\n    authenticatedOnly: ({ req: { user } }) => Boolean(user),\n    publicAccess: () => true,\n    ...pluginConfig.access,\n  }\n\n  return config as SanitizedEcommercePluginConfig\n}\n"],"names":["defaultAddressFields","USD","sanitizePluginConfig","pluginConfig","config","customers","slug","addresses","addressFields","defaultFields","currencies","defaultCurrency","supportedCurrencies","inventory","fieldName","carts","orders","transactions","payments","paymentMethods","products","variants","access","authenticatedOnly","req","user","Boolean","publicAccess"],"mappings":"AAEA,SAASA,oBAAoB,QAAQ,mDAAkD;AACvF,SAASC,GAAG,QAAQ,yBAAwB;AAM5C,OAAO,MAAMC,uBAAuB,CAAC,EAAEC,YAAY,EAAS;IAC1D,MAAMC,SAAS;QACb,GAAGD,YAAY;IACjB;IAEA,IAAI,OAAOC,OAAOC,SAAS,KAAK,aAAa;QAC3CD,OAAOC,SAAS,GAAG;YACjBC,MAAM;QACR;IACF;IAEA,IACE,OAAOF,OAAOG,SAAS,KAAK,eAC3B,OAAOH,OAAOG,SAAS,KAAK,aAAaH,OAAOG,SAAS,KAAK,MAC/D;QACAH,OAAOG,SAAS,GAAG;YACjBC,eAAeR;QACjB;IACF,OAAO;QACL,MAAMQ,gBACJ,AAAC,OAAOL,aAAaI,SAAS,KAAK,YACjC,OAAOJ,aAAaI,SAAS,CAACC,aAAa,KAAK,cAChDL,aAAaI,SAAS,CAACC,aAAa,CAAC;YACnCC,eAAeT;QACjB,MACFA;QAEFI,OAAOG,SAAS,GAAG;YACjB,GAAGH,OAAOG,SAAS;YACnBC;QACF;IACF;IAEA,IAAI,CAACJ,OAAOM,UAAU,EAAE;QACtBN,OAAOM,UAAU,GAAG;YAClBC,iBAAiB;YACjBC,qBAAqB;gBAACX;aAAI;QAC5B;IACF;IAEA,IACE,OAAOG,OAAOS,SAAS,KAAK,eAC3B,OAAOT,OAAOS,SAAS,KAAK,aAAaT,OAAOS,SAAS,KAAK,MAC/D;QACAT,OAAOS,SAAS,GAAG;YACjBC,WAAW;QACb;IACF;IAEA,IAAI,OAAOV,OAAOW,KAAK,KAAK,aAAa;QACvCX,OAAOW,KAAK,GAAG;IACjB;IAEA,IAAI,OAAOX,OAAOY,MAAM,KAAK,aAAa;QACxCZ,OAAOY,MAAM,GAAG;IAClB;IAEA,IAAI,OAAOZ,OAAOa,YAAY,KAAK,aAAa;QAC9Cb,OAAOa,YAAY,GAAG;IACxB;IAEA,IAAI,OAAOb,OAAOc,QAAQ,KAAK,aAAa;QAC1Cd,OAAOc,QAAQ,GAAG;YAChBC,gBAAgB,EAAE;QACpB;IACF,OAAO,IAAI,CAACf,OAAOc,QAAQ,CAACC,cAAc,EAAE;QAC1Cf,OAAOc,QAAQ,CAACC,cAAc,GAAG,EAAE;IACrC;IAEA,IAAIf,OAAOgB,QAAQ,EAAE;QACnB,IAAI,OAAOhB,OAAOgB,QAAQ,KAAK,YAAY,OAAOhB,OAAOgB,QAAQ,CAACC,QAAQ,KAAK,aAAa;YAC1FjB,OAAOgB,QAAQ,CAACC,QAAQ,GAAG;QAC7B;IACF;IAEAjB,OAAOkB,MAAM,GAAG;QACdC,mBAAmB,CAAC,EAAEC,KAAK,EAAEC,IAAI,EAAE,EAAE,GAAKC,QAAQD;QAClDE,cAAc,IAAM;QACpB,GAAGxB,aAAamB,MAAM;IACxB;IAEA,OAAOlB;AACT,EAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@payloadcms/plugin-ecommerce",
-  "version": "3.57.0-internal.f26caed",
+  "version": "3.58.0-canary.4",
   "description": "Ecommerce plugin for Payload",
   "keywords": [
     "payload",
@@ -69,21 +69,22 @@
   ],
   "dependencies": {
     "qs-esm": "7.0.2",
-    "@payloadcms/translations": "3.57.0-internal.f26caed",
-    "@payloadcms/ui": "3.57.0-internal.f26caed"
+    "@payloadcms/translations": "3.58.0-canary.4",
+    "@payloadcms/ui": "3.58.0-canary.4"
   },
   "devDependencies": {
+    "@types/json-schema": "7.0.15",
     "@types/react": "19.1.0",
     "@types/react-dom": "19.1.2",
     "stripe": "18.3.0",
-    "@payloadcms/eslint-config": "3.28.0",
-    "payload": "3.57.0-internal.f26caed",
-    "@payloadcms/next": "3.57.0-internal.f26caed"
+    "@payloadcms/next": "3.58.0-canary.4",
+    "payload": "3.58.0-canary.4",
+    "@payloadcms/eslint-config": "3.28.0"
   },
   "peerDependencies": {
     "react": "^19.0.0 || ^19.0.0-rc-65a56d0e-20241020",
     "react-dom": "^19.0.0 || ^19.0.0-rc-65a56d0e-20241020",
-    "payload": "3.57.0-internal.f26caed"
+    "payload": "3.58.0-canary.4"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"

package/dist/react/provider/types.d.ts

@@ -1,172 +0,0 @@
-import type { DefaultDocumentIDType, PopulateType, SelectType, TypedCollection } from 'payload';
-import type React from 'react';
-import type { CurrenciesConfig, Currency, PaymentAdapterClient } from '../../types.js';
-type GeneratedTypes = import('payload').GeneratedTypes;
-export type SyncLocalStorageConfig = {
-    /**
-     * Key to use for localStorage.
-     * Defaults to 'cart'.
-     */
-    key?: string;
-};
-type APIProps = {
-    /**
-     * The route for the Payload API, defaults to `/api`.
-     */
-    apiRoute?: string;
-    /**
-     * Customise the query used to fetch carts. Use this when you need to fetch additional data and optimise queries using depth, select and populate.
-     *
-     * Defaults to `{ depth: 0 }`.
-     */
-    cartsFetchQuery?: {
-        depth?: number;
-        populate?: PopulateType;
-        select?: SelectType;
-    };
-    /**
-     * The route for the Payload API, defaults to ``. Eg for a Payload app running on `http://localhost:3000`, the default serverURL would be `http://localhost:3000`.
-     */
-    serverURL?: string;
-};
-export type ContextProps = {
-    /**
-     * The slug for the addresses collection.
-     *
-     * Defaults to 'addresses'.
-     */
-    addressesSlug?: string;
-    api?: APIProps;
-    /**
-     * The slug for the carts collection.
-     *
-     * Defaults to 'carts'.
-     */
-    cartsSlug?: string;
-    children?: React.ReactNode;
-    /**
-     * The configuration for currencies used in the ecommerce context.
-     * This is used to handle currency formatting and calculations, defaults to USD.
-     */
-    currenciesConfig?: CurrenciesConfig;
-    /**
-     * The slug for the customers collection.
-     *
-     * Defaults to 'users'.
-     */
-    customersSlug?: string;
-    /**
-     * Enable debug mode for the ecommerce context. This will log additional information to the console.
-     * Defaults to false.
-     */
-    debug?: boolean;
-    /**
-     * Whether to enable support for variants in the cart.
-     * This allows adding products with specific variants to the cart.
-     * Defaults to false.
-     */
-    enableVariants?: boolean;
-    /**
-     * Supported payment methods for the ecommerce context.
-     */
-    paymentMethods?: PaymentAdapterClient[];
-    /**
-     * Whether to enable localStorage for cart persistence.
-     * Defaults to true.
-     */
-    syncLocalStorage?: boolean | SyncLocalStorageConfig;
-};
-/**
- * Type used internally to represent the cart item to be added.
- */
-type CartItemArgument = {
-    /**
-     * The ID of the product to add to the cart. Always required.
-     */
-    product: DefaultDocumentIDType;
-    /**
-     * The ID of the variant to add to the cart. Optional, if not provided, the product will be added without a variant.
-     */
-    variant?: DefaultDocumentIDType;
-};
-export type EcommerceContext = {
-    /**
-     * Add an item to the cart.
-     */
-    addItem: (item: CartItemArgument, quantity?: number) => Promise<void>;
-    /**
-     * All current addresses for the current user.
-     * This is used to manage shipping and billing addresses.
-     */
-    addresses?: TypedCollection['addresses'][];
-    /**
-     * The current data of the cart.
-     */
-    cart?: GeneratedTypes['collections']['carts'];
-    /**
-     * The ID of the current cart corresponding to the cart in the database or local storage.
-     */
-    cartID?: DefaultDocumentIDType;
-    /**
-     * Clear the cart, removing all items.
-     */
-    clearCart: () => Promise<void>;
-    /**
-     * Initiate a payment using the selected payment method.
-     * This method should be called after the cart is ready for checkout.
-     * It requires the payment method ID and any necessary payment data.
-     */
-    confirmOrder: (paymentMethodID: string, options?: {
-        additionalData: Record<string, unknown>;
-    }) => Promise<unknown>;
-    /**
-     * Create a new address by providing the data.
-     */
-    createAddress: (data: Partial<TypedCollection['addresses']>) => Promise<void>;
-    /**
-     * The configuration for the currencies used in the ecommerce context.
-     */
-    currenciesConfig: CurrenciesConfig;
-    /**
-     * The currently selected currency used for the cart and price formatting automatically.
-     */
-    currency: Currency;
-    /**
-     * Decrement an item in the cart by its index ID.
-     * If quantity reaches 0, the item will be removed from the cart.
-     */
-    decrementItem: (item: DefaultDocumentIDType) => Promise<void>;
-    /**
-     * Increment an item in the cart by its index ID.
-     */
-    incrementItem: (item: DefaultDocumentIDType) => Promise<void>;
-    /**
-     * Initiate a payment using the selected payment method.
-     * This method should be called after the cart is ready for checkout.
-     * It requires the payment method ID and any necessary payment data.
-     */
-    initiatePayment: (paymentMethodID: string, options?: {
-        additionalData: Record<string, unknown>;
-    }) => Promise<unknown>;
-    paymentMethods: PaymentAdapterClient[];
-    /**
-     * Remove an item from the cart by its index ID.
-     */
-    removeItem: (item: DefaultDocumentIDType) => Promise<void>;
-    /**
-     * The name of the currently selected payment method.
-     * This is used to determine which payment method to use when initiating a payment.
-     */
-    selectedPaymentMethod?: null | string;
-    /**
-     * Change the currency for the cart, it defaults to the configured currency.
-     * This will update the currency used for pricing and calculations.
-     */
-    setCurrency: (currency: string) => void;
-    /**
-     * Update an address by providing the data and the ID.
-     */
-    updateAddress: (addressID: DefaultDocumentIDType, data: Partial<TypedCollection['addresses']>) => Promise<void>;
-};
-export {};
-//# sourceMappingURL=types.d.ts.map

package/dist/react/provider/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/react/provider/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,YAAY,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAC/F,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAE9B,OAAO,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAA;AAGtF,KAAK,cAAc,GAAG,OAAO,SAAS,EAAE,cAAc,CAAA;AAEtD,MAAM,MAAM,sBAAsB,GAAG;IACnC;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;CACb,CAAA;AAED,KAAK,QAAQ,GAAG;IACd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;;OAIG;IACH,eAAe,CAAC,EAAE;QAChB,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,QAAQ,CAAC,EAAE,YAAY,CAAA;QACvB,MAAM,CAAC,EAAE,UAAU,CAAA;KACpB,CAAA;IACD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,GAAG,CAAC,EAAE,QAAQ,CAAA;IACd;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;IAC1B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAA;IACnC;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IACf;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;OAEG;IACH,cAAc,CAAC,EAAE,oBAAoB,EAAE,CAAA;IACvC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,GAAG,sBAAsB,CAAA;CACpD,CAAA;AAED;;GAEG;AACH,KAAK,gBAAgB,GAAG;IACtB;;OAEG;IACH,OAAO,EAAE,qBAAqB,CAAA;IAC9B;;OAEG;IACH,OAAO,CAAC,EAAE,qBAAqB,CAAA;CAChC,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,OAAO,EAAE,CAAC,IAAI,EAAE,gBAAgB,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACrE;;;OAGG;IACH,SAAS,CAAC,EAAE,eAAe,CAAC,WAAW,CAAC,EAAE,CAAA;IAC1C;;OAEG;IAEH,IAAI,CAAC,EAAE,cAAc,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAA;IAC7C;;OAEG;IACH,MAAM,CAAC,EAAE,qBAAqB,CAAA;IAC9B;;OAEG;IACH,SAAS,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;IAC9B;;;;OAIG;IACH,YAAY,EAAE,CACZ,eAAe,EAAE,MAAM,EACvB,OAAO,CAAC,EAAE;QAAE,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,KAClD,OAAO,CAAC,OAAO,CAAC,CAAA;IACrB;;OAEG;IACH,aAAa,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAC7E;;OAEG;IACH,gBAAgB,EAAE,gBAAgB,CAAA;IAClC;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAA;IAClB;;;OAGG;IACH,aAAa,EAAE,CAAC,IAAI,EAAE,qBAAqB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAC7D;;OAEG;IACH,aAAa,EAAE,CAAC,IAAI,EAAE,qBAAqB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAC7D;;;;OAIG;IACH,eAAe,EAAE,CACf,eAAe,EAAE,MAAM,EACvB,OAAO,CAAC,EAAE;QAAE,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,KAClD,OAAO,CAAC,OAAO,CAAC,CAAA;IACrB,cAAc,EAAE,oBAAoB,EAAE,CAAA;IACtC;;OAEG;IACH,UAAU,EAAE,CAAC,IAAI,EAAE,qBAAqB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAC1D;;;OAGG;IACH,qBAAqB,CAAC,EAAE,IAAI,GAAG,MAAM,CAAA;IACrC;;;OAGG;IACH,WAAW,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAA;IACvC;;OAEG;IACH,aAAa,EAAE,CACb,SAAS,EAAE,qBAAqB,EAChC,IAAI,EAAE,OAAO,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC,KACxC,OAAO,CAAC,IAAI,CAAC,CAAA;CACnB,CAAA"}

package/dist/react/provider/types.js

@@ -1,3 +0,0 @@
-export { };
-
-//# sourceMappingURL=types.js.map

package/dist/react/provider/types.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/react/provider/types.ts"],"sourcesContent":["import type { DefaultDocumentIDType, PopulateType, SelectType, TypedCollection } from 'payload'\nimport type React from 'react'\n\nimport type { CurrenciesConfig, Currency, PaymentAdapterClient } from '../../types.js'\n\n// eslint-disable-next-line @typescript-eslint/consistent-type-imports\ntype GeneratedTypes = import('payload').GeneratedTypes\n\nexport type SyncLocalStorageConfig = {\n  /**\n   * Key to use for localStorage.\n   * Defaults to 'cart'.\n   */\n  key?: string\n}\n\ntype APIProps = {\n  /**\n   * The route for the Payload API, defaults to `/api`.\n   */\n  apiRoute?: string\n  /**\n   * Customise the query used to fetch carts. Use this when you need to fetch additional data and optimise queries using depth, select and populate.\n   *\n   * Defaults to `{ depth: 0 }`.\n   */\n  cartsFetchQuery?: {\n    depth?: number\n    populate?: PopulateType\n    select?: SelectType\n  }\n  /**\n   * The route for the Payload API, defaults to ``. Eg for a Payload app running on `http://localhost:3000`, the default serverURL would be `http://localhost:3000`.\n   */\n  serverURL?: string\n}\n\nexport type ContextProps = {\n  /**\n   * The slug for the addresses collection.\n   *\n   * Defaults to 'addresses'.\n   */\n  addressesSlug?: string\n  api?: APIProps\n  /**\n   * The slug for the carts collection.\n   *\n   * Defaults to 'carts'.\n   */\n  cartsSlug?: string\n  children?: React.ReactNode\n  /**\n   * The configuration for currencies used in the ecommerce context.\n   * This is used to handle currency formatting and calculations, defaults to USD.\n   */\n  currenciesConfig?: CurrenciesConfig\n  /**\n   * The slug for the customers collection.\n   *\n   * Defaults to 'users'.\n   */\n  customersSlug?: string\n  /**\n   * Enable debug mode for the ecommerce context. This will log additional information to the console.\n   * Defaults to false.\n   */\n  debug?: boolean\n  /**\n   * Whether to enable support for variants in the cart.\n   * This allows adding products with specific variants to the cart.\n   * Defaults to false.\n   */\n  enableVariants?: boolean\n  /**\n   * Supported payment methods for the ecommerce context.\n   */\n  paymentMethods?: PaymentAdapterClient[]\n  /**\n   * Whether to enable localStorage for cart persistence.\n   * Defaults to true.\n   */\n  syncLocalStorage?: boolean | SyncLocalStorageConfig\n}\n\n/**\n * Type used internally to represent the cart item to be added.\n */\ntype CartItemArgument = {\n  /**\n   * The ID of the product to add to the cart. Always required.\n   */\n  product: DefaultDocumentIDType\n  /**\n   * The ID of the variant to add to the cart. Optional, if not provided, the product will be added without a variant.\n   */\n  variant?: DefaultDocumentIDType\n}\n\nexport type EcommerceContext = {\n  /**\n   * Add an item to the cart.\n   */\n  addItem: (item: CartItemArgument, quantity?: number) => Promise<void>\n  /**\n   * All current addresses for the current user.\n   * This is used to manage shipping and billing addresses.\n   */\n  addresses?: TypedCollection['addresses'][]\n  /**\n   * The current data of the cart.\n   */\n  // @ts-ignore\n  cart?: GeneratedTypes['collections']['carts']\n  /**\n   * The ID of the current cart corresponding to the cart in the database or local storage.\n   */\n  cartID?: DefaultDocumentIDType\n  /**\n   * Clear the cart, removing all items.\n   */\n  clearCart: () => Promise<void>\n  /**\n   * Initiate a payment using the selected payment method.\n   * This method should be called after the cart is ready for checkout.\n   * It requires the payment method ID and any necessary payment data.\n   */\n  confirmOrder: (\n    paymentMethodID: string,\n    options?: { additionalData: Record<string, unknown> },\n  ) => Promise<unknown>\n  /**\n   * Create a new address by providing the data.\n   */\n  createAddress: (data: Partial<TypedCollection['addresses']>) => Promise<void>\n  /**\n   * The configuration for the currencies used in the ecommerce context.\n   */\n  currenciesConfig: CurrenciesConfig\n  /**\n   * The currently selected currency used for the cart and price formatting automatically.\n   */\n  currency: Currency\n  /**\n   * Decrement an item in the cart by its index ID.\n   * If quantity reaches 0, the item will be removed from the cart.\n   */\n  decrementItem: (item: DefaultDocumentIDType) => Promise<void>\n  /**\n   * Increment an item in the cart by its index ID.\n   */\n  incrementItem: (item: DefaultDocumentIDType) => Promise<void>\n  /**\n   * Initiate a payment using the selected payment method.\n   * This method should be called after the cart is ready for checkout.\n   * It requires the payment method ID and any necessary payment data.\n   */\n  initiatePayment: (\n    paymentMethodID: string,\n    options?: { additionalData: Record<string, unknown> },\n  ) => Promise<unknown>\n  paymentMethods: PaymentAdapterClient[]\n  /**\n   * Remove an item from the cart by its index ID.\n   */\n  removeItem: (item: DefaultDocumentIDType) => Promise<void>\n  /**\n   * The name of the currently selected payment method.\n   * This is used to determine which payment method to use when initiating a payment.\n   */\n  selectedPaymentMethod?: null | string\n  /**\n   * Change the currency for the cart, it defaults to the configured currency.\n   * This will update the currency used for pricing and calculations.\n   */\n  setCurrency: (currency: string) => void\n  /**\n   * Update an address by providing the data and the ID.\n   */\n  updateAddress: (\n    addressID: DefaultDocumentIDType,\n    data: Partial<TypedCollection['addresses']>,\n  ) => Promise<void>\n}\n"],"names":[],"mappings":"AAmGA,WAoFC"}

package/dist/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,MAAM,EACN,gBAAgB,EAChB,qBAAqB,EACrB,QAAQ,EACR,KAAK,EACL,WAAW,EACX,UAAU,EACV,cAAc,EACd,UAAU,EACV,eAAe,EACf,KAAK,EACN,MAAM,SAAS,CAAA;AAEhB,MAAM,MAAM,cAAc,GAAG,CAAC,IAAI,EAAE;IAAE,aAAa,EAAE,KAAK,EAAE,CAAA;CAAE,KAAK,KAAK,EAAE,CAAA;AAE1E,MAAM,MAAM,kBAAkB,GAAG,CAAC,IAAI,EAAE;IACtC,iBAAiB,EAAE,gBAAgB,CAAA;CACpC,KAAK,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAA;AAElD,MAAM,MAAM,QAAQ,GAAG;IACrB,EAAE,EAAE,qBAAqB,CAAA;IACzB,OAAO,EAAE,qBAAqB,GAAG,eAAe,CAAC,UAAU,CAAC,CAAA;IAC5D,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,qBAAqB,GAAG,eAAe,CAAC,UAAU,CAAC,CAAA;CAC9D,CAAA;AAED,KAAK,eAAe,GAAG;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,qBAAqB,GAAG,eAAe,CAAC,WAAW,CAAC,CAAA;IAC/D,EAAE,EAAE,qBAAqB,CAAA;IACzB,KAAK,EAAE,QAAQ,EAAE,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,IAAI,GAAG,eAAe,CAAA;AAElC,KAAK,yBAAyB,GAAG;IAC/B;;OAEG;IAEH,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,KAAK,eAAe,GAAG,CAAC,IAAI,EAAE;IAC5B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,IAAI,EAAE;QACJ;;WAEG;QACH,cAAc,EAAE,eAAe,CAAC,WAAW,CAAC,CAAA;QAC5C;;WAEG;QACH,IAAI,EAAE,IAAI,CAAA;QACV;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAA;QAChB,aAAa,EAAE,MAAM,CAAA;QACrB;;WAEG;QACH,eAAe,CAAC,EAAE,eAAe,CAAC,WAAW,CAAC,CAAA;KAC/C,CAAA;IACD,GAAG,EAAE,cAAc,CAAA;IACnB;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAA;CACzB,KAAK,yBAAyB,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAAA;AAEpE,KAAK,sBAAsB,GAAG;IAC5B;;OAEG;IAEH,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,qBAAqB,CAAA;IAC9B,aAAa,EAAE,qBAAqB,CAAA;CACrC,CAAA;AAED,KAAK,YAAY,GAAG,CAAC,IAAI,EAAE;IACzB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,IAAI,EAAE;QAEJ,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;QAClB,aAAa,CAAC,EAAE,MAAM,CAAA;KACvB,CAAA;IACD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,GAAG,EAAE,cAAc,CAAA;IACnB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAC1B,KAAK,sBAAsB,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAA;AAE9D;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,YAAY,EAAE,YAAY,CAAA;IAC1B;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAA;IACtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,KAAK,EAAE,UAAU,CAAA;IACjB;;;;;;;;;;;;;;;;;OAiBG;IACH,eAAe,EAAE,eAAe,CAAA;IAChC;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,YAAY,EAAE,OAAO,CAAA;IACrB,eAAe,EAAE,OAAO,CAAA;CACzB,GAAG,IAAI,CAAC,cAAc,EAAE,OAAO,GAAG,MAAM,CAAC,CAAA;AAE1C,MAAM,MAAM,QAAQ,GAAG;IACrB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,cAAc,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,cAAc,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAA;IAClF;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,gCAAgC,CAAC,EAAE,kBAAkB,CAAA;IACrD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,0BAA0B,CAAC,EAAE,kBAAkB,CAAA;IAC/C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,8BAA8B,CAAC,EAAE,kBAAkB,CAAA;CACpD,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,0BAA0B,CAAC,EAAE,kBAAkB,CAAA;IAC/C;;OAEG;IACH,UAAU,CAAC,EAAE,kBAAkB,CAAA;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,cAAc,CAAA;CACpC,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,wBAAwB,CAAC,EAAE,kBAAkB,CAAA;CAC9C,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,8BAA8B,CAAC,EAAE,kBAAkB,CAAA;CACpD,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,UAAU,CAAA;IACnB,KAAK,CAAC,EAAE,KAAK,CAAA;CACd,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,cAAc,CAAC,EAAE,cAAc,EAAE,CAAA;IACjC,aAAa,CAAC,EAAE,WAAW,CAAA;IAC3B,aAAa,CAAC,EAAE,WAAW,CAAA;CAC5B,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED;;GAEG;AACH,KAAK,eAAe,GAAG;IACrB;;;;;;;;;;;;;;;OAeG;IACH,2BAA2B,CAAC,EAAE,kBAAkB,CAAA;IAChD;;OAEG;IACH,aAAa,CAAC,EAAE,cAAc,CAAA;IAC9B;;;;;;;;;;;OAWG;IACH,kBAAkB,CAAC,EAAE,WAAW,EAAE,CAAA;CACnC,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,uBAAuB,CAAC,EAAE,kBAAkB,CAAA;CAC7C,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;;;OAIG;IACH,eAAe,EAAE,MAAM,CAAA;IACvB;;OAEG;IACH,mBAAmB,EAAE,QAAQ,EAAE,CAAA;CAChC,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,IAAI,EAAE;IACtC;;OAEG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAA;IACnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,OAAO,EAAE,eAAe,CAAC,UAAU,CAAC,CAAA;IACpC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,CAAA;CACtC,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;AAE1B;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,YAAY,EAAE,MAAM,CAAA;IACpB,cAAc,EAAE,MAAM,CAAA;IACtB,QAAQ,EAAE,MAAM,CAAA;IAChB,YAAY,EAAE,MAAM,CAAA;CACrB,CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,oBAAoB,EAAE,WAAW,CAAA;IACjC;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAA;IAC5B;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAA;IAC9B;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B;;OAEG;IACH,uBAAuB,EAAE,WAAW,CAAA;IACpC;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;;;;OAMG;IACH,MAAM,EAAE,YAAY,CAAA;IACpB;;;OAGG;IACH,SAAS,CAAC,EAAE,eAAe,GAAG,OAAO,CAAA;IACrC;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,WAAW,CAAA;IAC7B;;;;OAIG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAA;IAC7B;;;;;;;;;OASG;IACH,SAAS,EAAE,eAAe,CAAA;IAC1B;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,eAAe,CAAA;IACrC;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,YAAY,CAAA;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAA;IACzB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,cAAc,CAAA;IACnC;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAA;CAC5C,CAAA;AAED,MAAM,MAAM,8BAA8B,GAAG;IAC3C,MAAM,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAA;IAC9B,SAAS,EAAE;QAAE,aAAa,EAAE,KAAK,EAAE,CAAA;KAAE,GAAG,IAAI,CAAC,eAAe,EAAE,eAAe,CAAC,CAAA;IAC9E,UAAU,EAAE,QAAQ,CAAC,gBAAgB,CAAC,CAAA;IACtC,SAAS,CAAC,EAAE,eAAe,CAAA;IAC3B,QAAQ,EAAE;QACR,cAAc,EAAE,EAAE,GAAG,cAAc,EAAE,CAAA;KACtC,CAAA;CACF,GAAG,IAAI,CACN,QAAQ,CAAC,qBAAqB,CAAC,EAC/B,QAAQ,GAAG,WAAW,GAAG,YAAY,GAAG,WAAW,GAAG,UAAU,CACjE,CAAA"}

package/dist/types.js

@@ -1,3 +0,0 @@
-export { };
-
-//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/types.ts"],"sourcesContent":["import type {\n  Access,\n  CollectionConfig,\n  DefaultDocumentIDType,\n  Endpoint,\n  Field,\n  FieldAccess,\n  GroupField,\n  PayloadRequest,\n  SelectType,\n  TypedCollection,\n  Where,\n} from 'payload'\n\nexport type FieldsOverride = (args: { defaultFields: Field[] }) => Field[]\n\nexport type CollectionOverride = (args: {\n  defaultCollection: CollectionConfig\n}) => CollectionConfig | Promise<CollectionConfig>\n\nexport type CartItem = {\n  id: DefaultDocumentIDType\n  product: DefaultDocumentIDType | TypedCollection['products']\n  quantity: number\n  variant?: DefaultDocumentIDType | TypedCollection['variants']\n}\n\ntype DefaultCartType = {\n  currency?: string\n  customer?: DefaultDocumentIDType | TypedCollection['customers']\n  id: DefaultDocumentIDType\n  items: CartItem[]\n  subtotal?: number\n}\n\nexport type Cart = DefaultCartType\n\ntype InitiatePaymentReturnType = {\n  /**\n   * Allows for additional data to be returned, such as payment method specific data\n   */\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  [key: string]: any\n  message: string\n}\n\ntype InitiatePayment = (args: {\n  /**\n   * The slug of the customers collection, defaults to 'users'.\n   */\n  customersSlug?: string\n  data: {\n    /**\n     * Billing address for the payment.\n     */\n    billingAddress: TypedCollection['addresses']\n    /**\n     * Cart items.\n     */\n    cart: Cart\n    /**\n     * Currency code to use for the payment.\n     */\n    currency: string\n    customerEmail: string\n    /**\n     * Shipping address for the payment.\n     */\n    shippingAddress?: TypedCollection['addresses']\n  }\n  req: PayloadRequest\n  /**\n   * The slug of the transactions collection, defaults to 'transactions'.\n   * For example, this is used to create a record of the payment intent in the transactions collection.\n   */\n  transactionsSlug: string\n}) => InitiatePaymentReturnType | Promise<InitiatePaymentReturnType>\n\ntype ConfirmOrderReturnType = {\n  /**\n   * Allows for additional data to be returned, such as payment method specific data\n   */\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  [key: string]: any\n  message: string\n  orderID: DefaultDocumentIDType\n  transactionID: DefaultDocumentIDType\n}\n\ntype ConfirmOrder = (args: {\n  /**\n   * The slug of the carts collection, defaults to 'carts'.\n   * For example, this is used to retrieve the cart for the order.\n   */\n  cartsSlug?: string\n  /**\n   * The slug of the customers collection, defaults to 'users'.\n   */\n  customersSlug?: string\n  /**\n   * Data made available to the payment method when confirming an order. You should get the cart items from the transaction.\n   */\n  data: {\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    [key: string]: any // Allows for additional data to be passed through, such as payment method specific data\n    customerEmail?: string\n  }\n  /**\n   * The slug of the orders collection, defaults to 'orders'.\n   */\n  ordersSlug?: string\n  req: PayloadRequest\n  /**\n   * The slug of the transactions collection, defaults to 'transactions'.\n   * For example, this is used to create a record of the payment intent in the transactions collection.\n   */\n  transactionsSlug?: string\n}) => ConfirmOrderReturnType | Promise<ConfirmOrderReturnType>\n\n/**\n * The full payment adapter config expected as part of the config for the Ecommerce plugin.\n *\n * You can insert this type directly or return it from a function constructing it.\n */\nexport type PaymentAdapter = {\n  /**\n   * The function that is called via the `/api/payments/{provider_name}/confirm-order` endpoint to confirm an order after a payment has been made.\n   *\n   * You should handle the order confirmation logic here.\n   *\n   * @example\n   *\n   * ```ts\n   * const confirmOrder: ConfirmOrder = async ({ data: { customerEmail }, ordersSlug, req, transactionsSlug }) => {\n      // Confirm the payment with Stripe or another payment provider here\n      // Create an order in the orders collection here\n      // Update the record of the payment intent in the transactions collection here\n      return {\n        message: 'Order confirmed successfully',\n        orderID: 'order_123',\n        transactionID: 'txn_123',\n        // Include any additional data required for the payment method here\n      }\n    }\n   * ```\n   */\n  confirmOrder: ConfirmOrder\n  /**\n   * An array of endpoints to be bootstrapped to Payload's API in order to support the payment method. All API paths are relative to `/api/payments/{provider_name}`.\n   *\n   * So for example, path `/webhooks` in the Stripe adapter becomes `/api/payments/stripe/webhooks`.\n   *\n   * @example '/webhooks'\n   */\n  endpoints?: Endpoint[]\n  /**\n   * A group configuration to be used in the admin interface to display the payment method.\n   *\n   * @example\n   *\n   * ```ts\n   * const groupField: GroupField = {\n      name: 'stripe',\n      type: 'group',\n      admin: {\n        condition: (data) => data?.paymentMethod === 'stripe',\n      },\n      fields: [\n        {\n          name: 'stripeCustomerID',\n          type: 'text',\n          label: 'Stripe Customer ID',\n          required: true,\n        },\n        {\n          name: 'stripePaymentIntentID',\n          type: 'text',\n          label: 'Stripe PaymentIntent ID',\n          required: true,\n        },\n      ],\n    }\n   * ```\n   */\n  group: GroupField\n  /**\n   * The function that is called via the `/api/payments/{provider_name}/initiate` endpoint to initiate a payment for an order.\n   *\n   * You should handle the payment initiation logic here.\n   *\n   * @example\n   *\n   * ```ts\n   * const initiatePayment: InitiatePayment = async ({ data: { cart, currency, customerEmail, billingAddress, shippingAddress }, req, transactionsSlug }) => {\n      // Create a payment intent with Stripe or another payment provider here\n      // Create a record of the payment intent in the transactions collection here\n      return {\n        message: 'Payment initiated successfully',\n        // Include any additional data required for the payment method here\n      }\n    }\n   * ```\n   */\n  initiatePayment: InitiatePayment\n  /**\n   * The label of the payment method\n   * @example\n   * 'Bank Transfer'\n   */\n  label?: string\n  /**\n   * The name of the payment method\n   * @example 'stripe'\n   */\n  name: string\n}\n\nexport type PaymentAdapterClient = {\n  confirmOrder: boolean\n  initiatePayment: boolean\n} & Pick<PaymentAdapter, 'label' | 'name'>\n\nexport type Currency = {\n  /**\n   * The ISO 4217 currency code\n   * @example 'usd'\n   */\n  code: string\n  /**\n   * The number of decimal places the currency uses\n   * @example 2\n   */\n  decimals: number\n  /**\n   * A user friendly name for the currency.\n   *\n   * @example 'US Dollar'\n   */\n  label: string\n  /**\n   * The symbol of the currency\n   * @example '$'\n   */\n  symbol: string\n}\n\n/**\n * Commonly used arguments for a Payment Adapter function, it's use is entirely optional.\n */\nexport type PaymentAdapterArgs = {\n  /**\n   * Overrides the default fields of the collection. Affects the payment fields on collections such as transactions.\n   */\n  groupOverrides?: { fields?: FieldsOverride } & Partial<Omit<GroupField, 'fields'>>\n  /**\n   * The visually readable label for the payment method.\n   * @example 'Bank Transfer'\n   */\n  label?: string\n}\n\n/**\n * Commonly used arguments for a Payment Adapter function, it's use is entirely optional.\n */\nexport type PaymentAdapterClientArgs = {\n  /**\n   * The visually readable label for the payment method.\n   * @example 'Bank Transfer'\n   */\n  label?: string\n}\n\nexport type VariantsConfig = {\n  /**\n   * Override the default variants collection. If you override the collection, you should ensure it has the required fields for variants or re-use the default fields.\n   *\n   * @example\n   *\n   * ```ts\n   * variants: {\n      variantOptionsCollectionOverride: ({ defaultCollection }) => ({\n        ...defaultCollection,\n        fields: [\n          ...defaultCollection.fields,\n          {\n            name: 'customField',\n            label: 'Custom Field',\n            type: 'text',\n          },\n        ],\n      })\n    }\n  ```\n   */\n  variantOptionsCollectionOverride?: CollectionOverride\n  /**\n   * Override the default variants collection. If you override the collection, you should ensure it has the required fields for variants or re-use the default fields.\n   *\n   * @example\n   *\n   * ```ts\n   * variants: {\n      variantsCollectionOverride: ({ defaultCollection }) => ({\n        ...defaultCollection,\n        fields: [\n          ...defaultCollection.fields,\n          {\n            name: 'customField',\n            label: 'Custom Field',\n            type: 'text',\n          },\n        ],\n      })\n    }\n  ```\n   */\n  variantsCollectionOverride?: CollectionOverride\n  /**\n   * Override the default variants collection. If you override the collection, you should ensure it has the required fields for variants or re-use the default fields.\n   *\n   * @example\n   *\n   * ```ts\n   * variants: {\n      variantTypesCollectionOverride: ({ defaultCollection }) => ({\n        ...defaultCollection,\n        fields: [\n          ...defaultCollection.fields,\n          {\n            name: 'customField',\n            label: 'Custom Field',\n            type: 'text',\n          },\n        ],\n      })\n    }\n  ```\n   */\n  variantTypesCollectionOverride?: CollectionOverride\n}\n\nexport type ProductsConfig = {\n  /**\n   * Override the default products collection. If you override the collection, you should ensure it has the required fields for products or re-use the default fields.\n   *\n   * @example\n   *\n   * ```ts\n    products: {\n      productsCollectionOverride: ({ defaultCollection }) => ({\n        ...defaultCollection,\n        fields: [\n          ...defaultCollection.fields,\n          {\n            name: 'notes',\n            label: 'Notes',\n            type: 'textarea',\n          },\n        ],\n      })\n    }\n    ```\n   */\n  productsCollectionOverride?: CollectionOverride\n  /**\n   * Customise the validation used for checking products or variants before a transaction is created or a payment can be confirmed.\n   */\n  validation?: ProductsValidation\n  /**\n   * Enable variants and provide configuration for the variant collections.\n   *\n   * Defaults to true.\n   */\n  variants?: boolean | VariantsConfig\n}\n\nexport type OrdersConfig = {\n  /**\n   * Override the default orders collection. If you override the collection, you should ensure it has the required fields for orders or re-use the default fields.\n   *\n   * @example\n   *\n   * ```ts\n      orders: {\n        ordersCollectionOverride: ({ defaultCollection }) => ({\n          ...defaultCollection,\n          fields: [\n            ...defaultCollection.fields,\n            {\n              name: 'notes',\n              label: 'Notes',\n              type: 'textarea',\n            },\n          ],\n        })\n      }\n    ```\n   */\n  ordersCollectionOverride?: CollectionOverride\n}\n\nexport type TransactionsConfig = {\n  /**\n   * Override the default transactions collection. If you override the collection, you should ensure it has the required fields for transactions or re-use the default fields.\n   *\n   * @example\n   *\n   * ```ts\n    transactions: {\n      transactionsCollectionOverride: ({ defaultCollection }) => ({\n        ...defaultCollection,\n        fields: [\n          ...defaultCollection.fields,\n          {\n            name: 'notes',\n            label: 'Notes',\n            type: 'textarea',\n          },\n        ],\n      })\n    }\n    ```\n   */\n  transactionsCollectionOverride?: CollectionOverride\n}\n\nexport type CustomQuery = {\n  depth?: number\n  select?: SelectType\n  where?: Where\n}\n\nexport type PaymentsConfig = {\n  paymentMethods?: PaymentAdapter[]\n  productsQuery?: CustomQuery\n  variantsQuery?: CustomQuery\n}\n\nexport type CountryType = {\n  /**\n   * A user friendly name for the country.\n   */\n  label: string\n  /**\n   * The ISO 3166-1 alpha-2 country code.\n   * @example 'US'\n   */\n  value: string\n}\n\n/**\n * Configuration for the addresses used by the Ecommerce plugin. Use this to override the default collection or fields used throughout\n */\ntype AddressesConfig = {\n  /**\n   * Override the default addresses collection. If you override the collection, you should ensure it has the required fields for addresses or re-use the default fields.\n   *\n   * @example\n   * ```ts\n   * addressesCollectionOverride: (defaultCollection) => {\n   *  return {\n   *    ...defaultCollection,\n   *    fields: [\n   *      ...defaultCollection.fields,\n   *      // add custom fields here\n   *    ],\n   *  }\n   * }\n   * ```\n   */\n  addressesCollectionOverride?: CollectionOverride\n  /**\n   * These fields will be applied to all locations where addresses are used, such as Orders and Transactions. Preferred use over the collectionOverride config.\n   */\n  addressFields?: FieldsOverride\n  /**\n   * Provide an array of countries to support for addresses. This will be used in the admin interface to provide a select field of countries.\n   *\n   * Defaults to a set of commonly used countries.\n   *\n   * @example\n   * ```\n   * [\n      { label: 'United States', value: 'US' },\n      { label: 'Canada', value: 'CA' },\n    ]\n   */\n  supportedCountries?: CountryType[]\n}\n\nexport type CustomersConfig = {\n  /**\n   * Slug of the customers collection, defaults to 'users'.\n   * This is used to link carts and orders to customers.\n   */\n  slug: string\n}\n\nexport type CartsConfig = {\n  cartsCollectionOverride?: CollectionOverride\n}\n\nexport type InventoryConfig = {\n  /**\n   * Override the default field used to track inventory levels. Defaults to 'inventory'.\n   */\n  fieldName?: string\n}\n\nexport type CurrenciesConfig = {\n  /**\n   * Defaults to the first supported currency.\n   *\n   * @example 'USD'\n   */\n  defaultCurrency: string\n  /**\n   *\n   */\n  supportedCurrencies: Currency[]\n}\n\n/**\n * A function that validates a product or variant before a transaction is created or completed.\n * This should throw an error if validation fails as it will be caught by the function calling it.\n */\nexport type ProductsValidation = (args: {\n  /**\n   * The full currencies config, allowing you to check against supported currencies and their settings.\n   */\n  currenciesConfig?: CurrenciesConfig\n  /**\n   * The ISO 4217 currency code being usen in this transaction.\n   */\n  currency?: string\n  /**\n   * The full product data.\n   */\n  product: TypedCollection['products']\n  /**\n   * Quantity to check the inventory amount against.\n   */\n  quantity: number\n  /**\n   * The full variant data, if a variant was selected for the product otherwise it will be undefined.\n   */\n  variant?: TypedCollection['variants']\n}) => Promise<void> | void\n\n/**\n * A map of collection slugs used by the Ecommerce plugin.\n * Provides an easy way to track the slugs of collections even when they are overridden.\n */\nexport type CollectionSlugMap = {\n  addresses: string\n  carts: string\n  customers: string\n  orders: string\n  products: string\n  transactions: string\n  variantOptions: string\n  variants: string\n  variantTypes: string\n}\n\n/**\n * Access control functions used throughout the Ecommerce plugin.\n * You must provide these when configuring the plugin.\n *\n * @example\n *\n * ```ts\n *  access: {\n      adminOnly,\n      adminOnlyFieldAccess,\n      adminOrCustomerOwner,\n      adminOrPublishedStatus,\n      customerOnlyFieldAccess,\n    }\n  ```\n */\nexport type AccessConfig = {\n  /**\n   * Limited to only admin users.\n   */\n  adminOnly: Access\n  /**\n   * Limited to only admin users, specifically for Field level access control.\n   */\n  adminOnlyFieldAccess: FieldAccess\n  /**\n   * Is the owner of the document via the `customer` field or is an admin.\n   */\n  adminOrCustomerOwner: Access\n  /**\n   * The document status is published or user is admin.\n   */\n  adminOrPublishedStatus: Access\n  /**\n   * Authenticated users only. Defaults to the example function.\n   *\n   * @example\n   * anyUser: ({ req }) => !!req?.user\n   */\n  authenticatedOnly?: Access\n  /**\n   * Limited to customers only, specifically for Field level access control.\n   */\n  customerOnlyFieldAccess: FieldAccess\n  /**\n   * Entirely public access. Defaults to the example function.\n   *\n   * @example\n   * publicAccess: () => true\n   */\n  publicAccess?: Access\n}\n\nexport type EcommercePluginConfig = {\n  /**\n   * Customise the access control for the plugin.\n   *\n   * @example\n   * ```ts\n   * ```\n   */\n  access: AccessConfig\n  /**\n   * Enable the addresses collection to allow customers, transactions and orders to have multiple addresses for shipping and billing. Accepts an override to customise the addresses collection.\n   * Defaults to supporting a default set of countries.\n   */\n  addresses?: AddressesConfig | boolean\n  /**\n   * Configure the target collection used for carts.\n   *\n   * Defaults to true.\n   */\n  carts?: boolean | CartsConfig\n  /**\n   * Configure supported currencies and default settings.\n   *\n   * Defaults to supporting USD.\n   */\n  currencies?: CurrenciesConfig\n  /**\n   * Configure the target collection used for customers.\n   *\n   * @example\n   * ```ts\n   * customers: {\n   *  slug: 'users', // default\n   * }\n   *\n   */\n  customers: CustomersConfig\n  /**\n   * Enable tracking of inventory for products and variants. Accepts a config object to override the default collection settings.\n   *\n   * Defaults to true.\n   */\n  inventory?: boolean | InventoryConfig\n  /**\n   * Enables orders and accepts a config object to override the default collection settings.\n   *\n   * Defaults to true.\n   */\n  orders?: boolean | OrdersConfig\n  /**\n   * Enable tracking of payments. Accepts a config object to override the default collection settings.\n   *\n   * Defaults to true when the paymentMethods array is provided.\n   */\n  payments?: PaymentsConfig\n  /**\n   * Enables products and variants. Accepts a config object to override the product collection and each variant collection type.\n   *\n   * Defaults to true.\n   */\n  products?: boolean | ProductsConfig\n  /**\n   * Enable tracking of transactions. Accepts a config object to override the default collection settings.\n   *\n   * Defaults to true when the paymentMethods array is provided.\n   */\n  transactions?: boolean | TransactionsConfig\n}\n\nexport type SanitizedEcommercePluginConfig = {\n  access: Required<AccessConfig>\n  addresses: { addressFields: Field[] } & Omit<AddressesConfig, 'addressFields'>\n  currencies: Required<CurrenciesConfig>\n  inventory?: InventoryConfig\n  payments: {\n    paymentMethods: [] | PaymentAdapter[]\n  }\n} & Omit<\n  Required<EcommercePluginConfig>,\n  'access' | 'addresses' | 'currencies' | 'inventory' | 'payments'\n>\n"],"names":[],"mappings":"AA+qBA,WAWC"}