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

package/dist/utils/version-compatible.js

@@ -1,15 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 var context_1 = require("../context");
-var base_types_1 = require("../base_types");
+var base_types_1 = require("../base-types");
 /**
  * Check if the current or optionally supplied version is compatible with a given version
  */
 function versionCompatible(referenceVersion, currentVersion) {
     if (currentVersion === void 0) { currentVersion = context_1.Context.API_VERSION; }
     // Return true if not using a dated version
-    if (currentVersion === base_types_1.ApiVersion.Unstable ||
-        currentVersion === base_types_1.ApiVersion.Unversioned) {
+    if (currentVersion === base_types_1.ApiVersion.Unstable) {
         return true;
     }
     var numericVersion = function (version) {

package/dist/webhooks/registry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../src/webhooks/registry.ts"],"names":[],"mappings":";AACA,OAAO,IAAI,MAAM,MAAM,CAAC;AAUxB,OAAO,EACL,cAAc,EACd,eAAe,EACf,cAAc,EACd,oBAAoB,EAGpB,wBAAwB,EACzB,MAAM,SAAS,CAAC;AAEjB,UAAU,gBAAgB;IACxB,CAAC,KAAK,EAAE,MAAM,GAAG,oBAAoB,CAAC;CACvC;AAED,UAAU,iBAAiB;IACzB,eAAe,EAAE;QAAC,CAAC,KAAK,EAAE,MAAM,GAAG,oBAAoB,CAAC;KAAC,CAAC;IAE1D;;;;;OAKG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAE/D;;;;OAIG;IACH,WAAW,CAAC,QAAQ,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE9C;;;;OAIG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,oBAAoB,GAAG,IAAI,CAAC;IAEvD;;OAEG;IACH,SAAS,IAAI,MAAM,EAAE,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAE5D;;;;OAIG;IACH,WAAW,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAExE;;;;;OAKG;IACH,OAAO,CACL,OAAO,EAAE,IAAI,CAAC,eAAe,EAC7B,QAAQ,EAAE,IAAI,CAAC,cAAc,GAC5B,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;OAIG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;CACtC;AAwDD,iBAAS,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAwC9C;AAED,iBAAS,UAAU,CACjB,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,EACf,cAAc,GAAE,cAAoC,EACpD,SAAS,CAAC,EAAE,MAAM,GACjB,MAAM,CAmDR;AAED,QAAA,MAAM,gBAAgB,EAAE,iBA+NvB,CAAC;AAEF,OAAO,EAAC,gBAAgB,EAAE,iBAAiB,EAAE,eAAe,EAAE,UAAU,EAAC,CAAC"}
+{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../src/webhooks/registry.ts"],"names":[],"mappings":";AACA,OAAO,IAAI,MAAM,MAAM,CAAC;AAUxB,OAAO,EACL,cAAc,EACd,eAAe,EACf,cAAc,EACd,oBAAoB,EAEpB,wBAAwB,EACzB,MAAM,SAAS,CAAC;AAEjB,UAAU,gBAAgB;IACxB,CAAC,KAAK,EAAE,MAAM,GAAG,oBAAoB,CAAC;CACvC;AAED,UAAU,iBAAiB;IACzB,eAAe,EAAE;QAAC,CAAC,KAAK,EAAE,MAAM,GAAG,oBAAoB,CAAA;KAAC,CAAC;IAEzD;;;;;OAKG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAE/D;;;;OAIG;IACH,WAAW,CAAC,QAAQ,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAE9C;;;;OAIG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,oBAAoB,GAAG,IAAI,CAAC;IAEvD;;OAEG;IACH,SAAS,IAAI,MAAM,EAAE,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAE5D;;;;OAIG;IACH,WAAW,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAExE;;;;;OAKG;IACH,OAAO,CACL,OAAO,EAAE,IAAI,CAAC,eAAe,EAC7B,QAAQ,EAAE,IAAI,CAAC,cAAc,GAC5B,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;OAIG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;CACtC;AAyCD,iBAAS,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CA2B9C;AAED,iBAAS,UAAU,CACjB,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,EACf,cAAc,GAAE,cAAoC,EACpD,SAAS,CAAC,EAAE,MAAM,GACjB,MAAM,CAmDR;AAED,QAAA,MAAM,gBAAgB,EAAE,iBAiOvB,CAAC;AAEF,OAAO,EAAC,gBAAgB,EAAE,iBAAiB,EAAE,eAAe,EAAE,UAAU,EAAC,CAAC"}

package/dist/webhooks/registry.js

@@ -5,7 +5,7 @@ var tslib_1 = require("tslib");
 var crypto_1 = require("crypto");
 var network_1 = require("@shopify/network");
 var graphql_client_1 = require("../clients/graphql/graphql_client");
-var base_types_1 = require("../base_types");
+var base_types_1 = require("../base-types");
 var utils_1 = tslib_1.__importDefault(require("../utils"));
 var context_1 = require("../context");
 var ShopifyErrors = tslib_1.__importStar(require("../error"));
@@ -30,32 +30,21 @@ function isSuccess(result, deliveryMethod, webhookId) {
         result.data[endpoint] &&
         result.data[endpoint].webhookSubscription);
 }
-// 2020-07 onwards
-function versionSupportsEndpointField() {
-    return utils_1.default.versionCompatible(base_types_1.ApiVersion.July20);
-}
 function versionSupportsPubSub() {
     return utils_1.default.versionCompatible(base_types_1.ApiVersion.July21);
 }
 function validateDeliveryMethod(deliveryMethod) {
-    if (deliveryMethod === types_1.DeliveryMethod.EventBridge &&
-        !versionSupportsEndpointField()) {
-        throw new ShopifyErrors.UnsupportedClientType("EventBridge webhooks are not supported in API version \"" + context_1.Context.API_VERSION + "\".");
-    }
-    else if (deliveryMethod === types_1.DeliveryMethod.PubSub &&
-        !versionSupportsPubSub()) {
+    if (deliveryMethod === types_1.DeliveryMethod.PubSub && !versionSupportsPubSub()) {
         throw new ShopifyErrors.UnsupportedClientType("Pub/Sub webhooks are not supported in API version \"" + context_1.Context.API_VERSION + "\".");
     }
 }
 function buildCheckQuery(topic) {
-    var query = "{\n    webhookSubscriptions(first: 1, topics: " + topic + ") {\n      edges {\n        node {\n          id\n          endpoint {\n            __typename\n            ... on WebhookHttpEndpoint {\n              callbackUrl\n            }\n            ... on WebhookEventBridgeEndpoint {\n              arn\n            }\n            " + (versionSupportsPubSub()
+    return "{\n    webhookSubscriptions(first: 1, topics: " + topic + ") {\n      edges {\n        node {\n          id\n          endpoint {\n            __typename\n            ... on WebhookHttpEndpoint {\n              callbackUrl\n            }\n            ... on WebhookEventBridgeEndpoint {\n              arn\n            }\n            " + (versionSupportsPubSub()
         ? '... on WebhookPubSubEndpoint { \
                     pubSubProject \
                     pubSubTopic \
                   }'
         : '') + "\n          }\n        }\n      }\n    }\n  }";
-    var legacyQuery = "{\n    webhookSubscriptions(first: 1, topics: " + topic + ") {\n      edges {\n        node {\n          id\n          callbackUrl\n        }\n      }\n    }\n  }";
-    return versionSupportsEndpointField() ? query : legacyQuery;
 }
 exports.buildCheckQuery = buildCheckQuery;
 function buildQuery(topic, address, deliveryMethod, webhookId) {
@@ -113,7 +102,8 @@ var WebhooksRegistry = {
         }
     },
     getHandler: function (topic) {
-        return topic in WebhooksRegistry.webhookRegistry ? WebhooksRegistry.webhookRegistry[topic] : null;
+        var _a;
+        return (_a = WebhooksRegistry.webhookRegistry[topic]) !== null && _a !== void 0 ? _a : null;
     },
     getTopics: function () {
         return Object.keys(WebhooksRegistry.webhookRegistry);
@@ -140,16 +130,11 @@ var WebhooksRegistry = {
                         if (checkResult.body.data.webhookSubscriptions.edges.length) {
                             node = checkResult.body.data.webhookSubscriptions.edges[0].node;
                             endpointAddress = '';
-                            if ('endpoint' in node) {
-                                if (node.endpoint.__typename === 'WebhookHttpEndpoint') {
-                                    endpointAddress = node.endpoint.callbackUrl;
-                                }
-                                else if (node.endpoint.__typename === 'WebhookEventBridgeEndpoint') {
-                                    endpointAddress = node.endpoint.arn;
-                                }
+                            if (node.endpoint.__typename === 'WebhookHttpEndpoint') {
+                                endpointAddress = node.endpoint.callbackUrl;
                             }
-                            else {
-                                endpointAddress = node.callbackUrl;
+                            else if (node.endpoint.__typename === 'WebhookEventBridgeEndpoint') {
+                                endpointAddress = node.endpoint.arn;
                             }
                             webhookId = node.id;
                             if (endpointAddress === address) {
@@ -284,7 +269,9 @@ var WebhooksRegistry = {
                                         .update(reqBody, 'utf8')
                                         .digest('base64');
                                     if (!utils_1.default.safeCompare(generatedHash, hmac)) return [3 /*break*/, 7];
-                                    graphqlTopic = topic.toUpperCase().replace(/\//g, '_');
+                                    graphqlTopic = topic
+                                        .toUpperCase()
+                                        .replace(/\//g, '_');
                                     webhookEntry = WebhooksRegistry.getHandler(graphqlTopic);
                                     if (!webhookEntry) return [3 /*break*/, 5];
                                     _a.label = 1;

package/dist/webhooks/types.d.ts

@@ -43,9 +43,6 @@ interface WebhookCheckResponseNode<T = {
         id: string;
     } & T;
 }
-declare type WebhookCheckLegacyResponseNode = WebhookCheckResponseNode<{
-    callbackUrl: string;
-}>;
 export interface WebhookCheckResponse<T = WebhookCheckResponseNode> {
     data: {
         webhookSubscriptions: {
@@ -53,6 +50,5 @@ export interface WebhookCheckResponse<T = WebhookCheckResponseNode> {
         };
     };
 }
-export declare type WebhookCheckResponseLegacy = WebhookCheckResponse<WebhookCheckLegacyResponseNode>;
 export {};
 //# sourceMappingURL=types.d.ts.map

package/dist/webhooks/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/webhooks/types.ts"],"names":[],"mappings":"AAAA,oBAAY,cAAc;IACxB,IAAI,SAAS;IACb,WAAW,gBAAgB;IAC3B,MAAM,WAAW;CAClB;AAED,aAAK,sBAAsB,GAAG,CAC5B,KAAK,EAAE,MAAM,EACb,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,MAAM,KACT,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnB,MAAM,WAAW,eAAe;IAE9B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC;AAED,MAAM,WAAW,wBAAwB;IAEvC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC;AAED,MAAM,WAAW,cAAc;IAC7B,CAAC,KAAK,EAAE,MAAM,GAAG;QACf,OAAO,EAAE,OAAO,CAAC;QACjB,MAAM,EAAE,OAAO,CAAC;KACjB,CAAC;CACH;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,sBAAsB,CAAC;CACxC;AAED,UAAU,wBAAwB,CAChC,CAAC,GAAG;IACF,QAAQ,EACJ;QACE,UAAU,EAAE,qBAAqB,CAAC;QAClC,WAAW,EAAE,MAAM,CAAC;KACrB,GACD;QACE,UAAU,EAAE,4BAA4B,CAAC;QACzC,GAAG,EAAE,MAAM,CAAC;KACb,GACD;QACE,UAAU,EAAE,uBAAuB,CAAC;QACpC,aAAa,EAAE,MAAM,CAAC;QACtB,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;CACP;IAED,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAC;KACZ,GAAG,CAAC,CAAC;CACP;AAED,aAAK,8BAA8B,GAAG,wBAAwB,CAAC;IAC7D,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC,CAAC;AAEH,MAAM,WAAW,oBAAoB,CAAC,CAAC,GAAG,wBAAwB;IAChE,IAAI,EAAE;QACJ,oBAAoB,EAAE;YACpB,KAAK,EAAE,CAAC,EAAE,CAAC;SACZ,CAAC;KACH,CAAC;CACH;AAED,oBAAY,0BAA0B,GACpC,oBAAoB,CAAC,8BAA8B,CAAC,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/webhooks/types.ts"],"names":[],"mappings":"AAAA,oBAAY,cAAc;IACxB,IAAI,SAAS;IACb,WAAW,gBAAgB;IAC3B,MAAM,WAAW;CAClB;AAED,aAAK,sBAAsB,GAAG,CAC5B,KAAK,EAAE,MAAM,EACb,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,MAAM,KACT,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnB,MAAM,WAAW,eAAe;IAE9B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC;AAED,MAAM,WAAW,wBAAwB;IAEvC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC;AAED,MAAM,WAAW,cAAc;IAC7B,CAAC,KAAK,EAAE,MAAM,GAAG;QACf,OAAO,EAAE,OAAO,CAAC;QACjB,MAAM,EAAE,OAAO,CAAC;KACjB,CAAC;CACH;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,sBAAsB,CAAC;CACxC;AAED,UAAU,wBAAwB,CAChC,CAAC,GAAG;IACF,QAAQ,EACJ;QACE,UAAU,EAAE,qBAAqB,CAAC;QAClC,WAAW,EAAE,MAAM,CAAC;KACrB,GACD;QACE,UAAU,EAAE,4BAA4B,CAAC;QACzC,GAAG,EAAE,MAAM,CAAC;KACb,GACD;QACE,UAAU,EAAE,uBAAuB,CAAC;QACpC,aAAa,EAAE,MAAM,CAAC;QACtB,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;CACP;IAED,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAC;KACZ,GAAG,CAAC,CAAC;CACP;AAED,MAAM,WAAW,oBAAoB,CAAC,CAAC,GAAG,wBAAwB;IAChE,IAAI,EAAE;QACJ,oBAAoB,EAAE;YACpB,KAAK,EAAE,CAAC,EAAE,CAAC;SACZ,CAAC;KACH,CAAC;CACH"}

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@shopify/shopify-api",
-  "version": "2.1.0",
+  "version": "3.0.0-rc.1",
   "description": "Shopify API Library for Node - accelerate development with support for authentication, graphql proxy, webhooks",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "prettier": "@shopify/prettier-config",
   "scripts": {
-    "test": "jest",
+    "test": "jest --testPathIgnorePatterns=src/rest-resources/__tests__",
+    "test_rest_resources": "ls src/rest-resources/__tests__ | xargs -I \"{}\" sh -c 'yarn jest --no-coverage --testPathPattern=\\\"{}\\\" || exit 255'",
     "build": "tsc",
     "lint": "eslint '**/*.{ts,tsx}' --max-warnings 0",
     "clean": "rimraf ./dist tsconfig.tsbuildinfo",
@@ -38,6 +39,9 @@
     "Admin API",
     "Storefront API"
   ],
+  "resolutions": {
+    "node-fetch": "^2.6.7"
+  },
   "dependencies": {
     "@shopify/network": "^1.5.1",
     "@types/jsonwebtoken": "^8.5.0",
@@ -50,18 +54,18 @@
     "uuid": "^8.3.1"
   },
   "devDependencies": {
-    "@shopify/eslint-plugin": "^39.0.3",
+    "@shopify/eslint-plugin": "^41.1.0",
     "@shopify/prettier-config": "^1.1.2",
     "@types/cookies": "^0.7.5",
     "@types/jest": "^26.0.15",
     "@types/node": "^14.14.1",
     "@types/uuid": "^8.3.0",
     "eslint": "^7.30.0",
-    "eslint-plugin-tsdoc": "^0.2.7",
+    "eslint-plugin-prettier": "^4.0.0",
     "express": "^4.17.1",
     "jest": "^27.4.3",
     "jest-fetch-mock": "^3.0.3",
-    "prettier": "^2.3.2",
+    "prettier": "^2.5.1",
     "rimraf": "^3.0.2",
     "supertest": "^6.1.3",
     "ts-jest": "^27.1.1",