@shopify/shopify-api 3.0.0-rc.3 → 3.1.0

package/dist/utils/with-session.js

@@ -19,7 +19,7 @@ function withSession(_a) {
                     if (!req || !res) {
                         throw new ShopifyErrors.MissingRequiredArgument('Please pass in both the "request" and "response" objects.');
                     }
-                    return [4 /*yield*/, load_current_session_1.default(req, res)];
+                    return [4 /*yield*/, (0, load_current_session_1.default)(req, res)];
                 case 1:
                     session = _b.sent();
                     return [3 /*break*/, 4];
@@ -27,7 +27,7 @@ function withSession(_a) {
                     if (!shop) {
                         throw new ShopifyErrors.MissingRequiredArgument('Please pass in a value for "shop"');
                     }
-                    return [4 /*yield*/, load_offline_session_1.default(shop)];
+                    return [4 /*yield*/, (0, load_offline_session_1.default)(shop)];
                 case 3:
                     session = _b.sent();
                     _b.label = 4;
@@ -52,7 +52,7 @@ function withSession(_a) {
                                     session: session,
                                 }];
                         default:
-                            throw new ShopifyErrors.UnsupportedClientType("\"" + clientType + "\" is an unsupported clientType. Please use \"rest\" or \"graphql\".");
+                            throw new ShopifyErrors.UnsupportedClientType("\"".concat(clientType, "\" is an unsupported clientType. Please use \"rest\" or \"graphql\"."));
                     }
                     return [2 /*return*/];
             }

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-export declare const SHOPIFY_API_LIBRARY_VERSION = "2.1.0";
+export declare const SHOPIFY_API_LIBRARY_VERSION = "3.1.0";
 //# sourceMappingURL=version.d.ts.map

package/dist/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SHOPIFY_API_LIBRARY_VERSION = void 0;
-exports.SHOPIFY_API_LIBRARY_VERSION = '2.1.0';
+exports.SHOPIFY_API_LIBRARY_VERSION = '3.1.0';

package/dist/webhooks/registry.d.ts

@@ -59,6 +59,7 @@ interface RegistryInterface {
 }
 declare function buildCheckQuery(topic: string): string;
 declare function buildQuery(topic: string, address: string, deliveryMethod?: DeliveryMethod, webhookId?: string): string;
+declare const gdprTopics: string[];
 declare const WebhooksRegistry: RegistryInterface;
-export { WebhooksRegistry, RegistryInterface, buildCheckQuery, buildQuery };
+export { WebhooksRegistry, RegistryInterface, buildCheckQuery, buildQuery, gdprTopics, };
 //# sourceMappingURL=registry.d.ts.map

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,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;AAiCD,iBAAS,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAuB9C;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"}
+{"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;AAiCD,iBAAS,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAuB9C;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,UAAU,EAAE,MAAM,EAIvB,CAAC;AAEF,QAAA,MAAM,gBAAgB,EAAE,iBA0PvB,CAAC;AAEF,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,eAAe,EACf,UAAU,EACV,UAAU,GACX,CAAC"}

package/dist/webhooks/registry.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildQuery = exports.buildCheckQuery = exports.WebhooksRegistry = void 0;
+exports.gdprTopics = exports.buildQuery = exports.buildCheckQuery = exports.WebhooksRegistry = void 0;
 var tslib_1 = require("tslib");
 var crypto_1 = require("crypto");
 var network_1 = require("@shopify/network");
@@ -34,7 +34,7 @@ function validateDeliveryMethod(_deliveryMethod) {
     return true;
 }
 function buildCheckQuery(topic) {
-    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            ... on WebhookPubSubEndpoint {\n              pubSubProject\n              pubSubTopic\n            }\n          }\n        }\n      }\n    }\n  }";
+    return "{\n    webhookSubscriptions(first: 1, topics: ".concat(topic, ") {\n      edges {\n        node {\n          id\n          endpoint {\n            __typename\n            ... on WebhookHttpEndpoint {\n              callbackUrl\n            }\n            ... on WebhookEventBridgeEndpoint {\n              arn\n            }\n            ... on WebhookPubSubEndpoint {\n              pubSubProject\n              pubSubTopic\n            }\n          }\n        }\n      }\n    }\n  }");
 }
 exports.buildCheckQuery = buildCheckQuery;
 function buildQuery(topic, address, deliveryMethod, webhookId) {
@@ -43,10 +43,10 @@ function buildQuery(topic, address, deliveryMethod, webhookId) {
     validateDeliveryMethod(deliveryMethod);
     var identifier;
     if (webhookId) {
-        identifier = "id: \"" + webhookId + "\"";
+        identifier = "id: \"".concat(webhookId, "\"");
     }
     else {
-        identifier = "topic: " + topic;
+        identifier = "topic: ".concat(topic);
     }
     var mutationName;
     var webhookSubscriptionArgs;
@@ -57,13 +57,13 @@ function buildQuery(topic, address, deliveryMethod, webhookId) {
             mutationName = webhookId
                 ? 'webhookSubscriptionUpdate'
                 : 'webhookSubscriptionCreate';
-            webhookSubscriptionArgs = "{callbackUrl: \"" + address + "\"}";
+            webhookSubscriptionArgs = "{callbackUrl: \"".concat(address, "\"}");
             break;
         case types_1.DeliveryMethod.EventBridge:
             mutationName = webhookId
                 ? 'eventBridgeWebhookSubscriptionUpdate'
                 : 'eventBridgeWebhookSubscriptionCreate';
-            webhookSubscriptionArgs = "{arn: \"" + address + "\"}";
+            webhookSubscriptionArgs = "{arn: \"".concat(address, "\"}");
             break;
         case types_1.DeliveryMethod.PubSub:
             mutationName = webhookId
@@ -72,12 +72,18 @@ function buildQuery(topic, address, deliveryMethod, webhookId) {
             _a = tslib_1.__read(address
                 .replace(/^pubsub:\/\//, '')
                 .split(':'), 2), pubSubProject = _a[0], pubSubTopic = _a[1];
-            webhookSubscriptionArgs = "{pubSubProject: \"" + pubSubProject + "\",\n                                  pubSubTopic: \"" + pubSubTopic + "\"}";
+            webhookSubscriptionArgs = "{pubSubProject: \"".concat(pubSubProject, "\",\n                                  pubSubTopic: \"").concat(pubSubTopic, "\"}");
             break;
     }
-    return "\n    mutation webhookSubscription {\n      " + mutationName + "(" + identifier + ", webhookSubscription: " + webhookSubscriptionArgs + ") {\n        userErrors {\n          field\n          message\n        }\n        webhookSubscription {\n          id\n        }\n      }\n    }\n  ";
+    return "\n    mutation webhookSubscription {\n      ".concat(mutationName, "(").concat(identifier, ", webhookSubscription: ").concat(webhookSubscriptionArgs, ") {\n        userErrors {\n          field\n          message\n        }\n        webhookSubscription {\n          id\n        }\n      }\n    }\n  ");
 }
 exports.buildQuery = buildQuery;
+var gdprTopics = [
+    'CUSTOMERS_DATA_REQUEST',
+    'CUSTOMERS_REDACT',
+    'SHOP_REDACT',
+];
+exports.gdprTopics = gdprTopics;
 var WebhooksRegistry = {
     webhookRegistry: {},
     addHandler: function (topic, _a) {
@@ -106,10 +112,23 @@ var WebhooksRegistry = {
                 switch (_c.label) {
                     case 0:
                         registerReturn = {};
+                        if (gdprTopics.includes(topic)) {
+                            registerReturn[topic] = {
+                                success: false,
+                                result: {
+                                    errors: [
+                                        {
+                                            message: "GDPR topic '".concat(topic, "' cannot be registered here. Please set the appropriate webhook endpoint in the 'GDPR mandatory webhooks' section of 'App setup' in the Partners Dashboard"),
+                                        },
+                                    ],
+                                },
+                            };
+                            return [2 /*return*/, registerReturn];
+                        }
                         validateDeliveryMethod(deliveryMethod);
                         client = new graphql_client_1.GraphqlClient(shop, accessToken);
                         address = deliveryMethod === types_1.DeliveryMethod.Http
-                            ? "https://" + context_1.Context.HOST_NAME + path
+                            ? "".concat(context_1.Context.HOST_SCHEME, "://").concat(context_1.Context.HOST_NAME).concat(path)
                             : path;
                         return [4 /*yield*/, client.query({
                                 data: buildCheckQuery(topic),
@@ -117,6 +136,13 @@ var WebhooksRegistry = {
                     case 1:
                         checkResult = (_c.sent());
                         mustRegister = true;
+                        if ('errors' in checkResult.body) {
+                            registerReturn[topic] = {
+                                success: false,
+                                result: checkResult.body,
+                            };
+                            return [2 /*return*/, registerReturn];
+                        }
                         if (checkResult.body.data.webhookSubscriptions.edges.length) {
                             node = checkResult.body.data.webhookSubscriptions.edges[0].node;
                             endpointAddress = '';
@@ -252,10 +278,10 @@ var WebhooksRegistry = {
                                     if (missingHeaders.length) {
                                         response.writeHead(network_1.StatusCode.BadRequest);
                                         response.end();
-                                        return [2 /*return*/, reject(new ShopifyErrors.InvalidWebhookError("Missing one or more of the required HTTP headers to process webhooks: [" + missingHeaders.join(', ') + "]"))];
+                                        return [2 /*return*/, reject(new ShopifyErrors.InvalidWebhookError("Missing one or more of the required HTTP headers to process webhooks: [".concat(missingHeaders.join(', '), "]")))];
                                     }
                                     headers = {};
-                                    generatedHash = crypto_1.createHmac('sha256', context_1.Context.API_SECRET_KEY)
+                                    generatedHash = (0, crypto_1.createHmac)('sha256', context_1.Context.API_SECRET_KEY)
                                         .update(reqBody, 'utf8')
                                         .digest('base64');
                                     if (!utils_1.default.safeCompare(generatedHash, hmac)) return [3 /*break*/, 7];
@@ -280,12 +306,12 @@ var WebhooksRegistry = {
                                 case 4: return [3 /*break*/, 6];
                                 case 5:
                                     statusCode = network_1.StatusCode.Forbidden;
-                                    responseError = new ShopifyErrors.InvalidWebhookError("No webhook is registered for topic " + topic);
+                                    responseError = new ShopifyErrors.InvalidWebhookError("No webhook is registered for topic ".concat(topic));
                                     _a.label = 6;
                                 case 6: return [3 /*break*/, 8];
                                 case 7:
                                     statusCode = network_1.StatusCode.Forbidden;
-                                    responseError = new ShopifyErrors.InvalidWebhookError("Could not validate request for topic " + topic);
+                                    responseError = new ShopifyErrors.InvalidWebhookError("Could not validate request for topic ".concat(topic));
                                     _a.label = 8;
                                 case 8:
                                     response.writeHead(statusCode, headers);

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@shopify/shopify-api",
-  "version": "3.0.0-rc.3",
+  "version": "3.1.0",
   "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 --testPathIgnorePatterns=src/rest-resources/__tests__",
+    "test": "jest --testPathIgnorePatterns=src/rest-resources/__tests__ --testPathIgnorePatterns=src/auth/session/storage",
+    "test_sessionstorage": "jest src/auth/session/storage",
     "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",
@@ -49,7 +50,12 @@
     "@types/supertest": "^2.0.10",
     "cookies": "^0.8.0",
     "jsonwebtoken": "^8.5.1",
+    "mongodb": "^4.5.0",
+    "mysql2": "^2.3.3",
     "node-fetch": "^2.6.1",
+    "pg": "^8.7.3",
+    "redis": "^4.0.6",
+    "sqlite3": "^5.0.2",
     "tslib": "^2.0.3",
     "uuid": "^8.3.1"
   },
@@ -58,7 +64,9 @@
     "@shopify/prettier-config": "^1.1.2",
     "@types/cookies": "^0.7.5",
     "@types/jest": "^26.0.15",
-    "@types/node": "^14.14.1",
+    "@types/node": "^14.18.12",
+    "@types/pg": "^8.6.5",
+    "@types/sqlite3": "^3.1.8",
     "@types/uuid": "^8.3.0",
     "eslint": "^7.30.0",
     "eslint-plugin-prettier": "^4.0.0",
@@ -69,7 +77,7 @@
     "rimraf": "^3.0.2",
     "supertest": "^6.1.3",
     "ts-jest": "^27.1.1",
-    "typescript": "^3.8.0"
+    "typescript": "^4.6.3"
   },
   "files": [
     "dist/*",