@foxy.io/sdk 1.9.4 → 1.10.0

package/dist/cjs/core/API/Node.js

@@ -78,8 +78,9 @@ class Node {
             const { filters, fields, offset, limit, order, zoom } = query !== null && query !== void 0 ? query : {};
             if (filters !== undefined) {
                 filters.forEach((filter) => {
-                    const params = new URLSearchParams(filter);
-                    [...params.entries()].forEach(([key, value]) => url.searchParams.append(key, value));
+                    const [key, value = ''] = filter.split('=');
+                    if (key)
+                        url.searchParams.append(key, value);
                 });
             }
             if (fields !== undefined)

package/dist/cjs/core/getResourceId.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getResourceId = void 0;
+/**
+ * Returns the last path segment, which is usually an ID.
+ * If it's a non-NaN numeric ID (true for most Foxy resources) then a `number` is returned.
+ * Otherwise returns a string or `null` if the path is empty.
+ *
+ * @param uri `self` link on a resource, e.g. `https://api.foxy.io/stores/123`
+ * @returns resource ID or `null` if not found
+ */
+function getResourceId(uri) {
+    try {
+        const idAsString = new URL(uri).pathname.split('/').pop() || undefined;
+        if (idAsString === undefined)
+            return null;
+        const idAsInt = parseInt(idAsString);
+        return isNaN(idAsInt) ? idAsString : idAsInt;
+    }
+    catch (_a) {
+        return null;
+    }
+}
+exports.getResourceId = getResourceId;

package/dist/cjs/core/index.js

@@ -19,10 +19,12 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.API = exports.Rumour = exports.BooleanSelector = exports.Nucleon = void 0;
+exports.API = exports.Rumour = exports.getResourceId = exports.BooleanSelector = exports.Nucleon = void 0;
 exports.Nucleon = __importStar(require("./Nucleon/index.js"));
 var BooleanSelector_js_1 = require("./BooleanSelector.js");
 Object.defineProperty(exports, "BooleanSelector", { enumerable: true, get: function () { return BooleanSelector_js_1.BooleanSelector; } });
+var getResourceId_js_1 = require("./getResourceId.js");
+Object.defineProperty(exports, "getResourceId", { enumerable: true, get: function () { return getResourceId_js_1.getResourceId; } });
 var index_js_1 = require("./Rumour/index.js");
 Object.defineProperty(exports, "Rumour", { enumerable: true, get: function () { return index_js_1.Rumour; } });
 var index_js_2 = require("./API/index.js");

package/dist/esm/core/API/Node.js

@@ -72,8 +72,9 @@ export class Node {
             const { filters, fields, offset, limit, order, zoom } = query !== null && query !== void 0 ? query : {};
             if (filters !== undefined) {
                 filters.forEach((filter) => {
-                    const params = new URLSearchParams(filter);
-                    [...params.entries()].forEach(([key, value]) => url.searchParams.append(key, value));
+                    const [key, value = ''] = filter.split('=');
+                    if (key)
+                        url.searchParams.append(key, value);
                 });
             }
             if (fields !== undefined)

package/dist/esm/core/getResourceId.js

@@ -0,0 +1,20 @@
+/**
+ * Returns the last path segment, which is usually an ID.
+ * If it's a non-NaN numeric ID (true for most Foxy resources) then a `number` is returned.
+ * Otherwise returns a string or `null` if the path is empty.
+ *
+ * @param uri `self` link on a resource, e.g. `https://api.foxy.io/stores/123`
+ * @returns resource ID or `null` if not found
+ */
+export function getResourceId(uri) {
+    try {
+        const idAsString = new URL(uri).pathname.split('/').pop() || undefined;
+        if (idAsString === undefined)
+            return null;
+        const idAsInt = parseInt(idAsString);
+        return isNaN(idAsInt) ? idAsString : idAsInt;
+    }
+    catch (_a) {
+        return null;
+    }
+}

package/dist/esm/core/index.js

@@ -1,5 +1,6 @@
 import * as Nucleon_1 from './Nucleon/index.js';
 export { Nucleon_1 as Nucleon };
 export { BooleanSelector } from './BooleanSelector.js';
+export { getResourceId } from './getResourceId.js';
 export { Rumour } from './Rumour/index.js';
 export { API } from './API/index.js';

package/dist/types/backend/Graph/applied_coupon_code.d.ts

@@ -23,6 +23,8 @@ export interface AppliedCouponCode extends Graph {
   props: {
     /** The coupon code applied to this cart. */
     code: string;
+    /** Allow the coupon to be added to the cart, even if it has expired or the number of uses per coupon, code or customer has reached their maximums. This value is available only in POST request body. */
+    ignore_usage_limits?: boolean;
     /** The date this resource was created. */
     date_created: string | null;
     /** The date this resource was last modified. */

package/dist/types/backend/Graph/cart.d.ts

@@ -113,16 +113,20 @@ export interface Cart extends Graph {
     template_set_uri: string;
     /** The language defined by the template set being used. */
     language: string;
+    /** The 3 character ISO code for the currency. This value may be unavailable in some carts. */
+    currency_code?: string;
+    /** The currency symbol, such as $, £, €, etc. This value may be unavailable in some carts. */
+    currency_symbol?: string;
     /** Total amount of the items in this cart. */
-    total_item_price: string;
+    total_item_price: number;
     /** Total amount of the taxes for this cart. */
-    total_tax: string;
+    total_tax: number;
     /** Total amount of the shipping costs for this cart. */
-    total_shipping: string;
+    total_shipping: number;
     /** If this cart has any shippable subscription items which will process in the future, this will be the total amount of shipping costs for those items. */
-    total_future_shipping: string;
+    total_future_shipping: number;
     /** Total order amount of this cart including all items, taxes, shipping costs and discounts. */
-    total_order: string;
+    total_order: number;
     /** The date this resource was created. */
     date_created: string | null;
     /** The date this resource was last modified. */

package/dist/types/backend/Graph/hosted_payment_gateways_helper.d.ts

@@ -47,6 +47,7 @@ export interface HostedPaymentGatewaysHelper extends Graph {
               type: string;
               description?: string;
               default_value: string;
+              options?: { name: string; value: string }[];
             }[];
           }[];
         };

package/dist/types/backend/Graph/item.d.ts

@@ -1,4 +1,5 @@
 import type { Attributes } from './attributes';
+import type { Cart } from './cart';
 import type { CouponDetails } from './coupon_details';
 import type { DiscountDetails } from './discount_details';
 import type { Graph } from '../../core';
@@ -6,6 +7,7 @@ import type { ItemCategory } from './item_category';
 import type { ItemOptions } from './item_options';
 import type { Shipment } from './shipment';
 import type { Store } from './store';
+import type { Subscription } from './subscription';
 import type { Transaction } from './transaction';
 
 export interface Item extends Graph {
@@ -16,12 +18,16 @@ export interface Item extends Graph {
     'self': Item;
     /** Store this item belongs to. */
     'fx:store': Store;
-    /** Related shipment info. */
+    /** Related shipment info. This link is available in purchased items only. */
     'fx:shipment': Shipment;
     /** Custom attributes linked to this item. */
     'fx:attributes': Attributes;
-    /** Related transaction info. */
+    /** Related transaction info. This link is available in transaction items only. */
     'fx:transaction': Transaction;
+    /** Related subscription info. This link is available only when this item is part of a subscription. */
+    'fx:subscription': Subscription;
+    /** Related cart info. This link is available in cart items only. */
+    'fx:cart': Cart;
     /** Various custom options for this item. */
     'fx:item_options': ItemOptions;
     /** Category this item belongs in. */

package/dist/types/backend/Graph/payment_gateways_helper.d.ts

@@ -47,6 +47,7 @@ export interface PaymentGatewaysHelper extends Graph {
               type: string;
               description?: string;
               default_value: string;
+              options?: { name: string; value: string }[];
             }[];
           }[];
         };

package/dist/types/backend/Graph/sub_modification_url.d.ts

@@ -0,0 +1,5 @@
+import type { Graph } from '../../core';
+
+export interface SubModificationUrl extends Graph {
+  curie: 'fx:sub_modification_url';
+}

package/dist/types/backend/Graph/subscription.d.ts

@@ -4,6 +4,7 @@ import type { Graph } from '../../core';
 import type { LastTransaction } from './last_transaction';
 import type { OriginalTransaction } from './original_transaction';
 import type { Store } from './store';
+import type { SubModificationUrl } from './sub_modification_url';
 import type { SubTokenUrl } from './sub_token_url';
 import type { TransactionTemplate } from './transaction_template';
 import type { Transactions } from './transactions';
@@ -28,6 +29,8 @@ export interface Subscription extends Graph {
     'fx:transaction_template': TransactionTemplate;
     /** Open this link in browser to load up the subscription template into a full HTML cart for the store. */
     'fx:sub_token_url': SubTokenUrl;
+    /** URL of the page where the customer can modify this subscription. This link is available only when configured in subscription settings. */
+    'fx:sub_modification_url': SubModificationUrl;
   };
 
   props: {

package/dist/types/core/getResourceId.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Returns the last path segment, which is usually an ID.
+ * If it's a non-NaN numeric ID (true for most Foxy resources) then a `number` is returned.
+ * Otherwise returns a string or `null` if the path is empty.
+ *
+ * @param uri `self` link on a resource, e.g. `https://api.foxy.io/stores/123`
+ * @returns resource ID or `null` if not found
+ */
+export declare function getResourceId(uri: string): string | number | null;

package/dist/types/core/index.d.ts

@@ -4,5 +4,6 @@ export type { Query } from './Query';
 export type { Graph } from './Graph';
 export * as Nucleon from './Nucleon/index.js';
 export { BooleanSelector } from './BooleanSelector.js';
+export { getResourceId } from './getResourceId.js';
 export { Rumour } from './Rumour/index.js';
 export { API } from './API/index.js';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@foxy.io/sdk",
   "type": "commonjs",
-  "version": "1.9.4",
+  "version": "1.10.0",
   "description": "Universal SDK for a full server-side and a limited in-browser access to Foxy hAPI.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -31,8 +31,8 @@
     "backend.d.ts"
   ],
   "scripts": {
-    "test": "jest",
-    "test:watch": "jest --watch",
+    "test": "NODE_OPTIONS=--no-experimental-fetch jest",
+    "test:watch": "NODE_OPTIONS=--no-experimental-fetch jest --watch",
     "lint": "npm run lint:eslint && npm run lint:prettier",
     "lint:eslint": "eslint --ext .ts,.html . --ignore-path .gitignore",
     "lint:prettier": "prettier \"**/*.ts\" --check --ignore-path .gitignore",
@@ -85,17 +85,17 @@
     "rimraf": "^3.0.2",
     "semantic-release": "^17.3.0",
     "ts-jest": "^26.4.4",
-    "ts-loader": "^8.0.9",
+    "ts-loader": "^8.4.0",
     "ts-node": "^9.1.1",
-    "ttypescript": "^1.5.12",
+    "ttypescript": "^1.5.15",
     "typedoc": "^0.22.18",
     "typescript": "^4.0.3",
-    "webpack": "^5.4.0",
-    "webpack-cli": "^4.2.0",
+    "webpack": "^5.75.0",
+    "webpack-cli": "^4.10.0",
     "webpack-node-externals": "^2.5.2"
   },
   "engines": {
-    "node": ">=10 <=15"
+    "node": ">=10 <=20"
   },
   "eslintConfig": {
     "extends": [