@shopify/shopify-api 2.1.0 → 3.0.0-rc.1

package/dist/base-rest-resource.js

@@ -0,0 +1,288 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+var error_1 = require("./error");
+var rest_1 = require("./clients/rest");
+var types_1 = require("./clients/http_client/types");
+var context_1 = require("./context");
+var Base = /** @class */ (function () {
+    function Base(_a) {
+        var session = _a.session, fromData = _a.fromData;
+        this.session = session;
+        if (fromData) {
+            this.setData(fromData);
+        }
+    }
+    Base.baseFind = function (_a) {
+        var _b, _c, _d, _e;
+        var session = _a.session, urlIds = _a.urlIds, params = _a.params;
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var response;
+            return tslib_1.__generator(this, function (_f) {
+                switch (_f.label) {
+                    case 0: return [4 /*yield*/, this.request({
+                            http_method: 'get',
+                            operation: 'get',
+                            session: session,
+                            urlIds: urlIds,
+                            params: params,
+                        })];
+                    case 1:
+                        response = _f.sent();
+                        this.NEXT_PAGE_INFO = (_c = (_b = response.pageInfo) === null || _b === void 0 ? void 0 : _b.nextPage) !== null && _c !== void 0 ? _c : undefined;
+                        this.PREV_PAGE_INFO = (_e = (_d = response.pageInfo) === null || _d === void 0 ? void 0 : _d.prevPage) !== null && _e !== void 0 ? _e : undefined;
+                        return [2 /*return*/, this.createInstancesFromResponse(session, response.body)];
+                }
+            });
+        });
+    };
+    Base.request = function (_a) {
+        var session = _a.session, http_method = _a.http_method, operation = _a.operation, urlIds = _a.urlIds, params = _a.params, body = _a.body, entity = _a.entity;
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var client, path, cleanParams, key, _b, error_2;
+            return tslib_1.__generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (context_1.Context.API_VERSION !== this.API_VERSION) {
+                            throw new error_1.RestResourceError("Current Context.API_VERSION '" + context_1.Context.API_VERSION + "' does not match resource version " + this.API_VERSION);
+                        }
+                        client = new rest_1.RestClient(session.shop, session.accessToken);
+                        path = this.getPath({ http_method: http_method, operation: operation, urlIds: urlIds, entity: entity });
+                        cleanParams = {};
+                        if (params) {
+                            for (key in params) {
+                                if (params[key] !== null) {
+                                    cleanParams[key] = params[key];
+                                }
+                            }
+                        }
+                        _c.label = 1;
+                    case 1:
+                        _c.trys.push([1, 12, , 13]);
+                        _b = http_method;
+                        switch (_b) {
+                            case 'get': return [3 /*break*/, 2];
+                            case 'post': return [3 /*break*/, 4];
+                            case 'put': return [3 /*break*/, 6];
+                            case 'delete': return [3 /*break*/, 8];
+                        }
+                        return [3 /*break*/, 10];
+                    case 2: return [4 /*yield*/, client.get({ path: path, query: cleanParams })];
+                    case 3: return [2 /*return*/, _c.sent()];
+                    case 4: return [4 /*yield*/, client.post({
+                            path: path,
+                            query: cleanParams,
+                            data: body,
+                            type: types_1.DataType.JSON,
+                        })];
+                    case 5: return [2 /*return*/, _c.sent()];
+                    case 6: return [4 /*yield*/, client.put({
+                            path: path,
+                            query: cleanParams,
+                            data: body,
+                            type: types_1.DataType.JSON,
+                        })];
+                    case 7: return [2 /*return*/, _c.sent()];
+                    case 8: return [4 /*yield*/, client.delete({ path: path, query: cleanParams })];
+                    case 9: return [2 /*return*/, _c.sent()];
+                    case 10: throw new Error("Unrecognized HTTP method \"" + http_method + "\"");
+                    case 11: return [3 /*break*/, 13];
+                    case 12:
+                        error_2 = _c.sent();
+                        if (error_2 instanceof error_1.HttpResponseError) {
+                            throw new error_1.RestResourceRequestError(error_2.message, error_2.code, error_2.statusText);
+                        }
+                        else {
+                            throw error_2;
+                        }
+                        return [3 /*break*/, 13];
+                    case 13: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    Base.getJsonBodyName = function () {
+        return this.name.replace(/([a-z])([A-Z])/g, '$1_$2').toLowerCase();
+    };
+    Base.getPath = function (_a) {
+        var http_method = _a.http_method, operation = _a.operation, urlIds = _a.urlIds, entity = _a.entity;
+        var match = null;
+        var specificity = -1;
+        this.PATHS.forEach(function (path) {
+            if (http_method !== path.http_method ||
+                operation !== path.operation ||
+                path.ids.length <= specificity) {
+                return;
+            }
+            var pathUrlIds = tslib_1.__assign({}, urlIds);
+            path.ids.forEach(function (id) {
+                if (!pathUrlIds[id] && entity && entity[id]) {
+                    pathUrlIds[id] = entity[id];
+                }
+            });
+            pathUrlIds = Object.entries(pathUrlIds).reduce(function (acc, _a) {
+                var _b = tslib_1.__read(_a, 2), key = _b[0], value = _b[1];
+                if (value) {
+                    acc[key] = value;
+                }
+                return acc;
+            }, {});
+            // If we weren't given all of the path's required ids, we can't use it
+            var diff = path.ids.reduce(function (acc, id) { return (pathUrlIds[id] ? acc : acc.concat(id)); }, []);
+            if (diff.length > 0) {
+                return;
+            }
+            specificity = path.ids.length;
+            match = path.path.replace(/(<([^>]+)>)/g, 
+            // eslint-disable-next-line @typescript-eslint/naming-convention
+            function (_m1, _m2, id) { return "" + pathUrlIds[id]; });
+        });
+        if (!match) {
+            throw new error_1.RestResourceError('Could not find a path for request');
+        }
+        if (this.CUSTOM_PREFIX) {
+            return this.CUSTOM_PREFIX + "/" + match;
+        }
+        else {
+            return match;
+        }
+    };
+    Base.createInstancesFromResponse = function (session, data) {
+        var _this = this;
+        if (data[this.PLURAL_NAME]) {
+            return data[this.PLURAL_NAME].reduce(function (acc, entry) {
+                return acc.concat(_this.createInstance(session, entry));
+            }, []);
+        }
+        if (data[this.NAME]) {
+            return [this.createInstance(session, data[this.NAME])];
+        }
+        return [];
+    };
+    Base.createInstance = function (session, data, prevInstance) {
+        var instance = prevInstance
+            ? prevInstance
+            : new this({ session: session });
+        if (data) {
+            instance.setData(data);
+        }
+        return instance;
+    };
+    Base.prototype.save = function (_a) {
+        var _b = (_a === void 0 ? {} : _a).update, update = _b === void 0 ? false : _b;
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var _c, PRIMARY_KEY, NAME, method, data, response, body;
+            var _d;
+            return tslib_1.__generator(this, function (_e) {
+                switch (_e.label) {
+                    case 0:
+                        _c = this.resource(), PRIMARY_KEY = _c.PRIMARY_KEY, NAME = _c.NAME;
+                        method = this[PRIMARY_KEY] ? 'put' : 'post';
+                        data = this.serialize();
+                        return [4 /*yield*/, this.resource().request({
+                                http_method: method,
+                                operation: method,
+                                session: this.session,
+                                urlIds: {},
+                                body: (_d = {}, _d[this.resource().getJsonBodyName()] = data, _d),
+                                entity: this,
+                            })];
+                    case 1:
+                        response = _e.sent();
+                        body = response.body[NAME];
+                        if (update && body) {
+                            this.setData(body);
+                        }
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    Base.prototype.saveAndUpdate = function () {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.save({ update: true })];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    Base.prototype.delete = function () {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.resource().request({
+                            http_method: 'delete',
+                            operation: 'delete',
+                            session: this.session,
+                            urlIds: {},
+                            entity: this,
+                        })];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    Base.prototype.serialize = function () {
+        var _a = this.resource(), HAS_MANY = _a.HAS_MANY, HAS_ONE = _a.HAS_ONE;
+        return Object.entries(this).reduce(function (acc, _a) {
+            var _b = tslib_1.__read(_a, 2), attribute = _b[0], value = _b[1];
+            if (['session'].includes(attribute)) {
+                return acc;
+            }
+            if (attribute in HAS_MANY && value) {
+                acc[attribute] = value.reduce(function (attrAcc, entry) {
+                    return attrAcc.concat(entry.serialize ? entry.serialize() : entry);
+                }, []);
+            }
+            else if (attribute in HAS_ONE && value && value.serialize) {
+                acc[attribute] = value.serialize();
+            }
+            else {
+                acc[attribute] = value;
+            }
+            return acc;
+        }, {});
+    };
+    Base.prototype.setData = function (data) {
+        var _this = this;
+        var _a = this.resource(), HAS_MANY = _a.HAS_MANY, HAS_ONE = _a.HAS_ONE;
+        Object.entries(data).forEach(function (_a) {
+            var _b = tslib_1.__read(_a, 2), attribute = _b[0], val = _b[1];
+            if (attribute in HAS_MANY) {
+                var HasManyResource_1 = HAS_MANY[attribute];
+                _this[attribute] = [];
+                val.forEach(function (entry) {
+                    _this[attribute].push(new HasManyResource_1({ session: _this.session, fromData: entry }));
+                });
+            }
+            else if (attribute in HAS_ONE) {
+                var HasOneResource = HAS_ONE[attribute];
+                _this[attribute] = new HasOneResource({
+                    session: _this.session,
+                    fromData: val,
+                });
+            }
+            else {
+                _this[attribute] = val;
+            }
+        });
+    };
+    Base.prototype.resource = function () {
+        return this.constructor;
+    };
+    Base.NAME = '';
+    Base.PLURAL_NAME = '';
+    Base.PRIMARY_KEY = 'id';
+    Base.CUSTOM_PREFIX = null;
+    Base.HAS_ONE = {};
+    Base.HAS_MANY = {};
+    Base.PATHS = [];
+    return Base;
+}());
+exports.default = Base;

package/dist/{base_types.d.ts → base-types.d.ts}

@@ -14,20 +14,12 @@ export interface ContextParams {
     PRIVATE_APP_STOREFRONT_ACCESS_TOKEN?: string;
 }
 export declare enum ApiVersion {
-    April19 = "2019-04",
-    July19 = "2019-07",
-    October19 = "2019-10",
-    January20 = "2020-01",
-    April20 = "2020-04",
-    July20 = "2020-07",
-    October20 = "2020-10",
-    January21 = "2021-01",
     April21 = "2021-04",
     July21 = "2021-07",
     October21 = "2021-10",
     January22 = "2022-01",
-    Unstable = "unstable",
-    Unversioned = "unversioned"
+    April22 = "2022-04",
+    Unstable = "unstable"
 }
 export declare enum ShopifyHeader {
     AccessToken = "X-Shopify-Access-Token",
@@ -36,4 +28,4 @@ export declare enum ShopifyHeader {
     Topic = "X-Shopify-Topic",
     Domain = "X-Shopify-Shop-Domain"
 }
-//# sourceMappingURL=base_types.d.ts.map
+//# sourceMappingURL=base-types.d.ts.map

package/dist/{base_types.d.ts.map → base-types.d.ts.map}

@@ -1 +1 @@
-{"version":3,"file":"base_types.d.ts","sourceRoot":"","sources":["../src/base_types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,eAAe,CAAC;AACzC,OAAO,EAAC,cAAc,EAAC,MAAM,gCAAgC,CAAC;AAE9D,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,UAAU,CAAC;IACxB,eAAe,EAAE,OAAO,CAAC;IACzB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,eAAe,CAAC,EAAE,cAAc,CAAC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,mCAAmC,CAAC,EAAE,MAAM,CAAC;CAC9C;AAED,oBAAY,UAAU;IACpB,OAAO,YAAY;IACnB,MAAM,YAAY;IAClB,SAAS,YAAY;IACrB,SAAS,YAAY;IACrB,OAAO,YAAY;IACnB,MAAM,YAAY;IAClB,SAAS,YAAY;IACrB,SAAS,YAAY;IACrB,OAAO,YAAY;IACnB,MAAM,YAAY;IAClB,SAAS,YAAY;IACrB,SAAS,YAAY;IACrB,QAAQ,aAAa;IACrB,WAAW,gBAAgB;CAC5B;AAED,oBAAY,aAAa;IACvB,WAAW,2BAA2B;IACtC,qBAAqB,sCAAsC;IAC3D,IAAI,0BAA0B;IAC9B,KAAK,oBAAoB;IACzB,MAAM,0BAA0B;CACjC"}
+{"version":3,"file":"base-types.d.ts","sourceRoot":"","sources":["../src/base-types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,eAAe,CAAC;AACzC,OAAO,EAAC,cAAc,EAAC,MAAM,gCAAgC,CAAC;AAE9D,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,UAAU,CAAC;IACxB,eAAe,EAAE,OAAO,CAAC;IACzB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,eAAe,CAAC,EAAE,cAAc,CAAC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,mCAAmC,CAAC,EAAE,MAAM,CAAC;CAC9C;AAED,oBAAY,UAAU;IACpB,OAAO,YAAY;IACnB,MAAM,YAAY;IAClB,SAAS,YAAY;IACrB,SAAS,YAAY;IACrB,OAAO,YAAY;IACnB,QAAQ,aAAa;CACtB;AAED,oBAAY,aAAa;IACvB,WAAW,2BAA2B;IACtC,qBAAqB,sCAAsC;IAC3D,IAAI,0BAA0B;IAC9B,KAAK,oBAAoB;IACzB,MAAM,0BAA0B;CACjC"}

package/dist/{base_types.js → base-types.js}

@@ -3,20 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ShopifyHeader = exports.ApiVersion = void 0;
 var ApiVersion;
 (function (ApiVersion) {
-    ApiVersion["April19"] = "2019-04";
-    ApiVersion["July19"] = "2019-07";
-    ApiVersion["October19"] = "2019-10";
-    ApiVersion["January20"] = "2020-01";
-    ApiVersion["April20"] = "2020-04";
-    ApiVersion["July20"] = "2020-07";
-    ApiVersion["October20"] = "2020-10";
-    ApiVersion["January21"] = "2021-01";
     ApiVersion["April21"] = "2021-04";
     ApiVersion["July21"] = "2021-07";
     ApiVersion["October21"] = "2021-10";
     ApiVersion["January22"] = "2022-01";
+    ApiVersion["April22"] = "2022-04";
     ApiVersion["Unstable"] = "unstable";
-    ApiVersion["Unversioned"] = "unversioned";
 })(ApiVersion = exports.ApiVersion || (exports.ApiVersion = {}));
 var ShopifyHeader;
 (function (ShopifyHeader) {

package/dist/clients/graphql/graphql_client.js

@@ -4,7 +4,7 @@ exports.GraphqlClient = void 0;
 var tslib_1 = require("tslib");
 var error_1 = require("../../error");
 var context_1 = require("../../context");
-var base_types_1 = require("../../base_types");
+var base_types_1 = require("../../base-types");
 var http_client_1 = require("../http_client/http_client");
 var types_1 = require("../http_client/types");
 var ShopifyErrors = tslib_1.__importStar(require("../../error"));

package/dist/clients/graphql/storefront_client.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.StorefrontClient = void 0;
 var tslib_1 = require("tslib");
 var context_1 = require("../../context");
-var base_types_1 = require("../../base_types");
+var base_types_1 = require("../../base-types");
 var graphql_client_1 = require("./graphql_client");
 var StorefrontClient = /** @class */ (function (_super) {
     tslib_1.__extends(StorefrontClient, _super);

package/dist/clients/http_client/http_client.d.ts

@@ -1,4 +1,4 @@
-import { GetRequestParams, PostRequestParams, PutRequestParams, DeleteRequestParams, RequestParams, RequestReturn } from './types';
+import { DeleteRequestParams, GetRequestParams, PostRequestParams, PutRequestParams, RequestParams, RequestReturn } from './types';
 declare class HttpClient {
     private domain;
     static readonly RETRY_WAIT_TIME = 1000;
@@ -22,6 +22,7 @@ declare class HttpClient {
      */
     delete(params: DeleteRequestParams): Promise<RequestReturn>;
     protected request(params: RequestParams): Promise<RequestReturn>;
+    protected getRequestPath(path: string): string;
     private doRequest;
 }
 export { HttpClient };

package/dist/clients/http_client/http_client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"http_client.d.ts","sourceRoot":"","sources":["../../../src/clients/http_client/http_client.ts"],"names":[],"mappings":"AAYA,OAAO,EAEL,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,mBAAmB,EACnB,aAAa,EACb,aAAa,EACd,MAAM,SAAS,CAAC;AAEjB,cAAM,UAAU;IAOK,OAAO,CAAC,MAAM;IALjC,MAAM,CAAC,QAAQ,CAAC,eAAe,QAAQ;IAEvC,MAAM,CAAC,QAAQ,CAAC,uBAAuB,UAAU;IACjD,OAAO,CAAC,mBAAmB,CAA8B;gBAE9B,MAAM,EAAE,MAAM;IAQzC;;OAEG;IACU,GAAG,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,aAAa,CAAC;IAIlE;;OAEG;IACU,IAAI,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,aAAa,CAAC;IAIpE;;OAEG;IACU,GAAG,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,aAAa,CAAC;IAIlE;;OAEG;IACU,MAAM,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,aAAa,CAAC;cAIxD,OAAO,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;YA4GxD,SAAS;CAgGxB;AAED,OAAO,EAAC,UAAU,EAAC,CAAC"}
+{"version":3,"file":"http_client.d.ts","sourceRoot":"","sources":["../../../src/clients/http_client/http_client.ts"],"names":[],"mappings":"AAaA,OAAO,EAEL,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,aAAa,EACb,aAAa,EACd,MAAM,SAAS,CAAC;AAEjB,cAAM,UAAU;IAOK,OAAO,CAAC,MAAM;IALjC,MAAM,CAAC,QAAQ,CAAC,eAAe,QAAQ;IAEvC,MAAM,CAAC,QAAQ,CAAC,uBAAuB,UAAU;IACjD,OAAO,CAAC,mBAAmB,CAA+B;gBAE/B,MAAM,EAAE,MAAM;IAQzC;;OAEG;IACU,GAAG,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,aAAa,CAAC;IAIlE;;OAEG;IACU,IAAI,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,aAAa,CAAC;IAIpE;;OAEG;IACU,GAAG,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,aAAa,CAAC;IAIlE;;OAEG;IACU,MAAM,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,aAAa,CAAC;cAIxD,OAAO,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;IA0GtE,SAAS,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;YAIhC,SAAS;CAgGxB;AAED,OAAO,EAAC,UAAU,EAAC,CAAC"}

package/dist/clients/http_client/http_client.js

@@ -11,6 +11,7 @@ var ShopifyErrors = tslib_1.__importStar(require("../../error"));
 var version_1 = require("../../version");
 var shop_validator_1 = tslib_1.__importDefault(require("../../utils/shop-validator"));
 var context_1 = require("../../context");
+var processed_query_1 = tslib_1.__importDefault(require("../../utils/processed-query"));
 var types_1 = require("./types");
 var HttpClient = /** @class */ (function () {
     function HttpClient(domain) {
@@ -70,7 +71,7 @@ var HttpClient = /** @class */ (function () {
                     });
                 });
             }
-            var maxTries, userAgent, headers, body, _a, type, data, queryString, url, options, tries, error_1, waitTime;
+            var maxTries, userAgent, headers, body, _a, type, data, url, options, tries, error_1, waitTime;
             return tslib_1.__generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
@@ -113,10 +114,7 @@ var HttpClient = /** @class */ (function () {
                                 headers = tslib_1.__assign({ 'Content-Type': type, 'Content-Length': Buffer.byteLength(body) }, params.extraHeaders);
                             }
                         }
-                        queryString = params.query
-                            ? "?" + querystring_1.default.stringify(params.query)
-                            : '';
-                        url = "https://" + this.domain + params.path + queryString;
+                        url = "https://" + this.domain + this.getRequestPath(params.path) + processed_query_1.default.stringify(params.query);
                         options = {
                             method: params.method.toString(),
                             headers: headers,
@@ -163,6 +161,9 @@ var HttpClient = /** @class */ (function () {
             });
         });
     };
+    HttpClient.prototype.getRequestPath = function (path) {
+        return "/" + path.replace(/^\//, '');
+    };
     HttpClient.prototype.doRequest = function (url, options) {
         return tslib_1.__awaiter(this, void 0, void 0, function () {
             var _this = this;

package/dist/clients/http_client/types.d.ts

@@ -1,22 +1,33 @@
 import { Method } from '@shopify/network';
 import { Headers } from 'node-fetch';
-export declare type HeaderParams = Record<string, string | number>;
+export interface HeaderParams {
+    [key: string]: string | number;
+}
 export declare enum DataType {
     JSON = "application/json",
     GraphQL = "application/graphql",
     URLEncoded = "application/x-www-form-urlencoded"
 }
+export declare type QueryParams = string | number | string[] | number[] | {
+    [key: string]: QueryParams;
+};
 export interface GetRequestParams {
     path: string;
     type?: DataType;
-    data?: Record<string, unknown> | string;
-    query?: Record<string, string | number>;
+    data?: {
+        [key: string]: unknown;
+    } | string;
+    query?: {
+        [key: string]: QueryParams;
+    };
     extraHeaders?: HeaderParams;
     tries?: number;
 }
 export declare type PostRequestParams = GetRequestParams & {
     type: DataType;
-    data: Record<string, unknown> | string;
+    data: {
+        [key: string]: unknown;
+    } | string;
 };
 export declare type PutRequestParams = PostRequestParams;
 export declare type DeleteRequestParams = GetRequestParams;

package/dist/clients/http_client/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/clients/http_client/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,MAAM,EAAC,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAC,OAAO,EAAC,MAAM,YAAY,CAAC;AAEnC,oBAAY,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;AAE3D,oBAAY,QAAQ;IAClB,IAAI,qBAAqB;IACzB,OAAO,wBAAwB;IAC/B,UAAU,sCAAsC;CACjD;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;IACxC,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,oBAAY,iBAAiB,GAAG,gBAAgB,GAAG;IACjD,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC;CACxC,CAAC;AAEF,oBAAY,gBAAgB,GAAG,iBAAiB,CAAC;AAEjD,oBAAY,mBAAmB,GAAG,gBAAgB,CAAC;AAEnD,oBAAY,aAAa,GAAG,CAAC,gBAAgB,GAAG,iBAAiB,CAAC,GAAG;IACnE,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,OAAO,CAAC;CAClB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/clients/http_client/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,MAAM,EAAC,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAC,OAAO,EAAC,MAAM,YAAY,CAAC;AAEnC,MAAM,WAAW,YAAY;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CAChC;AAED,oBAAY,QAAQ;IAClB,IAAI,qBAAqB;IACzB,OAAO,wBAAwB;IAC/B,UAAU,sCAAsC;CACjD;AAED,oBAAY,WAAW,GACnB,MAAM,GACN,MAAM,GACN,MAAM,EAAE,GACR,MAAM,EAAE,GACR;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAA;CAAC,CAAC;AAEjC,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,IAAI,CAAC,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,GAAG,MAAM,CAAC;IACzC,KAAK,CAAC,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAA;KAAC,CAAC;IACrC,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,oBAAY,iBAAiB,GAAG,gBAAgB,GAAG;IACjD,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,GAAG,MAAM,CAAC;CACzC,CAAC;AAEF,oBAAY,gBAAgB,GAAG,iBAAiB,CAAC;AAEjD,oBAAY,mBAAmB,GAAG,gBAAgB,CAAC;AAEnD,oBAAY,aAAa,GAAG,CAAC,gBAAgB,GAAG,iBAAiB,CAAC,GAAG;IACnE,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,OAAO,CAAC;CAClB"}

package/dist/clients/rest/rest_client.d.ts

@@ -7,7 +7,7 @@ declare class RestClient extends HttpClient {
     private static DEFAULT_LIMIT;
     constructor(domain: string, accessToken?: string | undefined);
     protected request(params: RequestParams): Promise<RestRequestReturn>;
-    private getRestPath;
+    protected getRequestPath(path: string): string;
     private buildRequestParams;
 }
 export { RestClient };

package/dist/clients/rest/rest_client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rest_client.d.ts","sourceRoot":"","sources":["../../../src/clients/rest/rest_client.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,UAAU,EAAC,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAC,aAAa,EAAmB,MAAM,sBAAsB,CAAC;AAGrE,OAAO,EAAC,iBAAiB,EAAW,MAAM,SAAS,CAAC;AAEpD,cAAM,UAAW,SAAQ,UAAU;IAIE,QAAQ,CAAC,WAAW,CAAC;IAHxD,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAA8B;IAC/D,OAAO,CAAC,MAAM,CAAC,aAAa,CAAQ;gBAEjB,MAAM,EAAE,MAAM,EAAW,WAAW,CAAC,oBAAQ;cAUhD,OAAO,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,iBAAiB,CAAC;IA2D1E,OAAO,CAAC,WAAW;IAInB,OAAO,CAAC,kBAAkB;CAa3B;AAED,OAAO,EAAC,UAAU,EAAC,CAAC"}
+{"version":3,"file":"rest_client.d.ts","sourceRoot":"","sources":["../../../src/clients/rest/rest_client.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,UAAU,EAAC,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAC,aAAa,EAAmB,MAAM,sBAAsB,CAAC;AAGrE,OAAO,EAAC,iBAAiB,EAAW,MAAM,SAAS,CAAC;AAEpD,cAAM,UAAW,SAAQ,UAAU;IAIE,QAAQ,CAAC,WAAW,CAAC;IAHxD,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAA8B;IAC/D,OAAO,CAAC,MAAM,CAAC,aAAa,CAAQ;gBAEjB,MAAM,EAAE,MAAM,EAAW,WAAW,CAAC,oBAAQ;cAUhD,OAAO,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAyD1E,SAAS,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAY9C,OAAO,CAAC,kBAAkB;CAa3B;AAED,OAAO,EAAC,UAAU,EAAC,CAAC"}

package/dist/clients/rest/rest_client.js

@@ -4,7 +4,7 @@ exports.RestClient = void 0;
 var tslib_1 = require("tslib");
 var querystring_1 = tslib_1.__importDefault(require("querystring"));
 var context_1 = require("../../context");
-var base_types_1 = require("../../base_types");
+var base_types_1 = require("../../base-types");
 var http_client_1 = require("../http_client/http_client");
 var ShopifyErrors = tslib_1.__importStar(require("../../error"));
 var RestClient = /** @class */ (function (_super) {
@@ -18,25 +18,23 @@ var RestClient = /** @class */ (function (_super) {
         return _this;
     }
     RestClient.prototype.request = function (params) {
+        var _a, _b;
         return tslib_1.__awaiter(this, void 0, void 0, function () {
             var ret, link, pageInfo, links, links_1, links_1_1, link_1, parsedLink, linkRel, linkUrl, linkFields, linkPageToken;
-            var _a, e_1, _b;
-            return tslib_1.__generator(this, function (_c) {
-                switch (_c.label) {
+            var _c, e_1, _d;
+            return tslib_1.__generator(this, function (_e) {
+                switch (_e.label) {
                     case 0:
-                        params.extraHeaders = tslib_1.__assign((_a = {}, _a[base_types_1.ShopifyHeader.AccessToken] = context_1.Context.IS_PRIVATE_APP
+                        params.extraHeaders = tslib_1.__assign((_c = {}, _c[base_types_1.ShopifyHeader.AccessToken] = context_1.Context.IS_PRIVATE_APP
                             ? context_1.Context.API_SECRET_KEY
-                            : this.accessToken, _a), params.extraHeaders);
-                        params.path = this.getRestPath(params.path);
+                            : this.accessToken, _c), params.extraHeaders);
                         return [4 /*yield*/, _super.prototype.request.call(this, params)];
                     case 1:
-                        ret = (_c.sent());
+                        ret = (_e.sent());
                         link = ret.headers.get('link');
-                        if (params.query && link !== undefined) {
+                        if (link !== undefined) {
                             pageInfo = {
-                                limit: params.query.limit
-                                    ? params.query.limit.toString()
-                                    : RestClient.DEFAULT_LIMIT,
+                                limit: ((_a = params.query) === null || _a === void 0 ? void 0 : _a.limit) ? (_b = params.query) === null || _b === void 0 ? void 0 : _b.limit.toString() : RestClient.DEFAULT_LIMIT,
                             };
                             if (link) {
                                 links = link.split(', ');
@@ -71,7 +69,7 @@ var RestClient = /** @class */ (function (_super) {
                                 catch (e_1_1) { e_1 = { error: e_1_1 }; }
                                 finally {
                                     try {
-                                        if (links_1_1 && !links_1_1.done && (_b = links_1.return)) _b.call(links_1);
+                                        if (links_1_1 && !links_1_1.done && (_d = links_1.return)) _d.call(links_1);
                                     }
                                     finally { if (e_1) throw e_1.error; }
                                 }
@@ -83,8 +81,14 @@ var RestClient = /** @class */ (function (_super) {
             });
         });
     };
-    RestClient.prototype.getRestPath = function (path) {
-        return "/admin/api/" + context_1.Context.API_VERSION + "/" + path + ".json";
+    RestClient.prototype.getRequestPath = function (path) {
+        var cleanPath = _super.prototype.getRequestPath.call(this, path);
+        if (cleanPath.startsWith('/admin')) {
+            return cleanPath.replace(/\.json$/, '') + ".json";
+        }
+        else {
+            return "/admin/api/" + context_1.Context.API_VERSION + cleanPath.replace(/\.json$/, '') + ".json";
+        }
     };
     RestClient.prototype.buildRequestParams = function (newPageUrl) {
         var pattern = "^/admin/api/[^/]+/(.*).json$";

package/dist/context.d.ts

@@ -1,5 +1,5 @@
 import { SessionStorage } from './auth/session/session_storage';
-import { ContextParams } from './base_types';
+import { ContextParams } from './base-types';
 import { AuthScopes } from './auth/scopes';
 interface ContextInterface extends ContextParams {
     SESSION_STORAGE: SessionStorage;

package/dist/context.js

@@ -4,7 +4,7 @@ exports.Context = void 0;
 var tslib_1 = require("tslib");
 var ShopifyErrors = tslib_1.__importStar(require("./error"));
 var memory_1 = require("./auth/session/storage/memory");
-var base_types_1 = require("./base_types");
+var base_types_1 = require("./base-types");
 var scopes_1 = require("./auth/scopes");
 var Context = {
     API_KEY: '',

package/dist/error.d.ts

@@ -32,6 +32,10 @@ declare class HttpThrottlingError extends HttpRetriableError {
     readonly retryAfter?: number | undefined;
     constructor(message: string, retryAfter?: number | undefined);
 }
+declare class RestResourceError extends ShopifyError {
+}
+declare class RestResourceRequestError extends HttpResponseError {
+}
 declare class InvalidOAuthError extends ShopifyError {
 }
 declare class SessionNotFound extends ShopifyError {
@@ -48,5 +52,5 @@ declare class MissingRequiredArgument extends ShopifyError {
 }
 declare class UnsupportedClientType extends ShopifyError {
 }
-export { ShopifyError, InvalidHmacError, InvalidShopError, InvalidJwtError, MissingJwtTokenError, SafeCompareError, HttpRequestError, HttpMaxRetriesError, HttpResponseError, HttpRetriableError, HttpInternalError, HttpThrottlingError, UninitializedContextError, InvalidOAuthError, SessionNotFound, CookieNotFound, InvalidSession, InvalidWebhookError, MissingRequiredArgument, UnsupportedClientType, SessionStorageError, PrivateAppError, };
+export { ShopifyError, InvalidHmacError, InvalidShopError, InvalidJwtError, MissingJwtTokenError, SafeCompareError, HttpRequestError, HttpMaxRetriesError, HttpResponseError, HttpRetriableError, HttpInternalError, HttpThrottlingError, RestResourceError, RestResourceRequestError, UninitializedContextError, InvalidOAuthError, SessionNotFound, CookieNotFound, InvalidSession, InvalidWebhookError, MissingRequiredArgument, UnsupportedClientType, SessionStorageError, PrivateAppError, };
 //# sourceMappingURL=error.d.ts.map

package/dist/error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA,cAAM,YAAa,SAAQ,KAAK;gBAClB,GAAG,IAAI,EAAE,GAAG;CAIzB;AAED,cAAM,gBAAiB,SAAQ,YAAY;CAAG;AAC9C,cAAM,gBAAiB,SAAQ,YAAY;CAAG;AAC9C,cAAM,eAAgB,SAAQ,YAAY;CAAG;AAC7C,cAAM,oBAAqB,SAAQ,YAAY;CAAG;AAElD,cAAM,gBAAiB,SAAQ,YAAY;CAAG;AAC9C,cAAM,yBAA0B,SAAQ,YAAY;CAAG;AACvD,cAAM,eAAgB,SAAQ,YAAY;CAAG;AAE7C,cAAM,gBAAiB,SAAQ,YAAY;CAAG;AAC9C,cAAM,mBAAoB,SAAQ,YAAY;CAAG;AACjD,cAAM,iBAAkB,SAAQ,YAAY;IAGxC,QAAQ,CAAC,IAAI,EAAE,MAAM;IACrB,QAAQ,CAAC,UAAU,EAAE,MAAM;gBAF3B,OAAO,EAAE,MAAM,EACN,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,MAAM;CAI9B;AACD,cAAM,kBAAmB,SAAQ,YAAY;CAAG;AAChD,cAAM,iBAAkB,SAAQ,kBAAkB;CAAG;AACrD,cAAM,mBAAoB,SAAQ,kBAAkB;IACd,QAAQ,CAAC,UAAU,CAAC;gBAArC,OAAO,EAAE,MAAM,EAAW,UAAU,CAAC,oBAAQ;CAGjE;AAED,cAAM,iBAAkB,SAAQ,YAAY;CAAG;AAC/C,cAAM,eAAgB,SAAQ,YAAY;CAAG;AAC7C,cAAM,cAAe,SAAQ,YAAY;CAAG;AAC5C,cAAM,cAAe,SAAQ,YAAY;CAAG;AAE5C,cAAM,mBAAoB,SAAQ,YAAY;CAAG;AACjD,cAAM,mBAAoB,SAAQ,YAAY;CAAG;AAEjD,cAAM,uBAAwB,SAAQ,YAAY;CAAG;AACrD,cAAM,qBAAsB,SAAQ,YAAY;CAAG;AAEnD,OAAO,EACL,YAAY,EACZ,gBAAgB,EAChB,gBAAgB,EAChB,eAAe,EACf,oBAAoB,EACpB,gBAAgB,EAChB,gBAAgB,EAChB,mBAAmB,EACnB,iBAAiB,EACjB,kBAAkB,EAClB,iBAAiB,EACjB,mBAAmB,EACnB,yBAAyB,EACzB,iBAAiB,EACjB,eAAe,EACf,cAAc,EACd,cAAc,EACd,mBAAmB,EACnB,uBAAuB,EACvB,qBAAqB,EACrB,mBAAmB,EACnB,eAAe,GAChB,CAAC"}
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA,cAAM,YAAa,SAAQ,KAAK;gBAClB,GAAG,IAAI,EAAE,GAAG;CAIzB;AAED,cAAM,gBAAiB,SAAQ,YAAY;CAAG;AAC9C,cAAM,gBAAiB,SAAQ,YAAY;CAAG;AAC9C,cAAM,eAAgB,SAAQ,YAAY;CAAG;AAC7C,cAAM,oBAAqB,SAAQ,YAAY;CAAG;AAElD,cAAM,gBAAiB,SAAQ,YAAY;CAAG;AAC9C,cAAM,yBAA0B,SAAQ,YAAY;CAAG;AACvD,cAAM,eAAgB,SAAQ,YAAY;CAAG;AAE7C,cAAM,gBAAiB,SAAQ,YAAY;CAAG;AAC9C,cAAM,mBAAoB,SAAQ,YAAY;CAAG;AACjD,cAAM,iBAAkB,SAAQ,YAAY;IAGxC,QAAQ,CAAC,IAAI,EAAE,MAAM;IACrB,QAAQ,CAAC,UAAU,EAAE,MAAM;gBAF3B,OAAO,EAAE,MAAM,EACN,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,MAAM;CAI9B;AACD,cAAM,kBAAmB,SAAQ,YAAY;CAAG;AAChD,cAAM,iBAAkB,SAAQ,kBAAkB;CAAG;AACrD,cAAM,mBAAoB,SAAQ,kBAAkB;IACd,QAAQ,CAAC,UAAU,CAAC;gBAArC,OAAO,EAAE,MAAM,EAAW,UAAU,CAAC,oBAAQ;CAGjE;AAED,cAAM,iBAAkB,SAAQ,YAAY;CAAG;AAC/C,cAAM,wBAAyB,SAAQ,iBAAiB;CAAG;AAE3D,cAAM,iBAAkB,SAAQ,YAAY;CAAG;AAC/C,cAAM,eAAgB,SAAQ,YAAY;CAAG;AAC7C,cAAM,cAAe,SAAQ,YAAY;CAAG;AAC5C,cAAM,cAAe,SAAQ,YAAY;CAAG;AAE5C,cAAM,mBAAoB,SAAQ,YAAY;CAAG;AACjD,cAAM,mBAAoB,SAAQ,YAAY;CAAG;AAEjD,cAAM,uBAAwB,SAAQ,YAAY;CAAG;AACrD,cAAM,qBAAsB,SAAQ,YAAY;CAAG;AAEnD,OAAO,EACL,YAAY,EACZ,gBAAgB,EAChB,gBAAgB,EAChB,eAAe,EACf,oBAAoB,EACpB,gBAAgB,EAChB,gBAAgB,EAChB,mBAAmB,EACnB,iBAAiB,EACjB,kBAAkB,EAClB,iBAAiB,EACjB,mBAAmB,EACnB,iBAAiB,EACjB,wBAAwB,EACxB,yBAAyB,EACzB,iBAAiB,EACjB,eAAe,EACf,cAAc,EACd,cAAc,EACd,mBAAmB,EACnB,uBAAuB,EACvB,qBAAqB,EACrB,mBAAmB,EACnB,eAAe,GAChB,CAAC"}

package/dist/error.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PrivateAppError = exports.SessionStorageError = exports.UnsupportedClientType = exports.MissingRequiredArgument = exports.InvalidWebhookError = exports.InvalidSession = exports.CookieNotFound = exports.SessionNotFound = exports.InvalidOAuthError = exports.UninitializedContextError = exports.HttpThrottlingError = exports.HttpInternalError = exports.HttpRetriableError = exports.HttpResponseError = exports.HttpMaxRetriesError = exports.HttpRequestError = exports.SafeCompareError = exports.MissingJwtTokenError = exports.InvalidJwtError = exports.InvalidShopError = exports.InvalidHmacError = exports.ShopifyError = void 0;
+exports.PrivateAppError = exports.SessionStorageError = exports.UnsupportedClientType = exports.MissingRequiredArgument = exports.InvalidWebhookError = exports.InvalidSession = exports.CookieNotFound = exports.SessionNotFound = exports.InvalidOAuthError = exports.UninitializedContextError = exports.RestResourceRequestError = exports.RestResourceError = exports.HttpThrottlingError = exports.HttpInternalError = exports.HttpRetriableError = exports.HttpResponseError = exports.HttpMaxRetriesError = exports.HttpRequestError = exports.SafeCompareError = exports.MissingJwtTokenError = exports.InvalidJwtError = exports.InvalidShopError = exports.InvalidHmacError = exports.ShopifyError = void 0;
 var tslib_1 = require("tslib");
 var ShopifyError = /** @class */ (function (_super) {
     tslib_1.__extends(ShopifyError, _super);
@@ -126,6 +126,22 @@ var HttpThrottlingError = /** @class */ (function (_super) {
     return HttpThrottlingError;
 }(HttpRetriableError));
 exports.HttpThrottlingError = HttpThrottlingError;
+var RestResourceError = /** @class */ (function (_super) {
+    tslib_1.__extends(RestResourceError, _super);
+    function RestResourceError() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    return RestResourceError;
+}(ShopifyError));
+exports.RestResourceError = RestResourceError;
+var RestResourceRequestError = /** @class */ (function (_super) {
+    tslib_1.__extends(RestResourceRequestError, _super);
+    function RestResourceRequestError() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    return RestResourceRequestError;
+}(HttpResponseError));
+exports.RestResourceRequestError = RestResourceRequestError;
 var InvalidOAuthError = /** @class */ (function (_super) {
     tslib_1.__extends(InvalidOAuthError, _super);
     function InvalidOAuthError() {