@shopify/shopify-api 6.0.0-rc5 → 6.0.0-rc6

package/lib/webhooks/registry.js

@@ -0,0 +1,365 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createProcess = exports.createRegisterAllHttp = exports.createRegister = exports.createGetTopicsAdded = exports.createGetHttpHandler = exports.createAddHttpHandlers = exports.createAddHttpHandler = exports.buildQuery = exports.buildCheckQuery = void 0;
+var tslib_1 = require("tslib");
+var network_1 = require("@shopify/network");
+var http_1 = require("../../runtime/http");
+var crypto_1 = require("../../runtime/crypto");
+var types_1 = require("../../runtime/crypto/types");
+var graphql_client_1 = require("../clients/graphql/graphql_client");
+var base_types_1 = require("../base-types");
+var safe_compare_1 = require("../auth/oauth/safe-compare");
+var ShopifyErrors = tslib_1.__importStar(require("../error"));
+var types_2 = require("./types");
+function isSuccess(result, deliveryMethod, webhookId) {
+    var endpoint;
+    switch (deliveryMethod) {
+        case types_2.DeliveryMethod.Http:
+            endpoint = 'webhookSubscription';
+            break;
+        case types_2.DeliveryMethod.EventBridge:
+            endpoint = 'eventBridgeWebhookSubscription';
+            break;
+        case types_2.DeliveryMethod.PubSub:
+            endpoint = 'pubSubWebhookSubscription';
+            break;
+        default:
+            return false;
+    }
+    endpoint += webhookId ? 'Update' : 'Create';
+    return Boolean(result.data &&
+        result.data[endpoint] &&
+        result.data[endpoint].webhookSubscription);
+}
+function buildCheckQuery(_a) {
+    var topic = _a.topic;
+    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(_a) {
+    var _b;
+    var topic = _a.topic, address = _a.address, _c = _a.deliveryMethod, deliveryMethod = _c === void 0 ? types_2.DeliveryMethod.Http : _c, webhookId = _a.webhookId;
+    var identifier;
+    if (webhookId) {
+        identifier = "id: \"".concat(webhookId, "\"");
+    }
+    else {
+        identifier = "topic: ".concat(topic);
+    }
+    var mutationName;
+    var webhookSubscriptionArgs;
+    var pubSubProject;
+    var pubSubTopic;
+    switch (deliveryMethod) {
+        case types_2.DeliveryMethod.Http:
+            mutationName = webhookId
+                ? 'webhookSubscriptionUpdate'
+                : 'webhookSubscriptionCreate';
+            webhookSubscriptionArgs = "{callbackUrl: \"".concat(address, "\"}");
+            break;
+        case types_2.DeliveryMethod.EventBridge:
+            mutationName = webhookId
+                ? 'eventBridgeWebhookSubscriptionUpdate'
+                : 'eventBridgeWebhookSubscriptionCreate';
+            webhookSubscriptionArgs = "{arn: \"".concat(address, "\"}");
+            break;
+        case types_2.DeliveryMethod.PubSub:
+            mutationName = webhookId
+                ? 'pubSubWebhookSubscriptionUpdate'
+                : 'pubSubWebhookSubscriptionCreate';
+            _b = tslib_1.__read(address
+                .replace(/^pubsub:\/\//, '')
+                .split(':'), 2), pubSubProject = _b[0], pubSubTopic = _b[1];
+            webhookSubscriptionArgs = "{pubSubProject: \"".concat(pubSubProject, "\",\n                                  pubSubTopic: \"").concat(pubSubTopic, "\"}");
+            break;
+    }
+    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;
+function topicForStorage(topic) {
+    return topic.toUpperCase().replace(/\//g, '_');
+}
+function createAddHttpHandler(httpWebhookRegistry) {
+    return function addHttpHandler(params) {
+        var topic = params.topic, handler = params.handler;
+        httpWebhookRegistry[topicForStorage(topic)] = handler;
+    };
+}
+exports.createAddHttpHandler = createAddHttpHandler;
+function createAddHttpHandlers(httpWebhookRegistry) {
+    var addHttpHandler = createAddHttpHandler(httpWebhookRegistry);
+    return function addHttpHandlers(handlers) {
+        handlers.forEach(function (handlerParam) { return addHttpHandler(handlerParam); });
+    };
+}
+exports.createAddHttpHandlers = createAddHttpHandlers;
+function createGetHttpHandler(httpWebhookRegistry) {
+    return function getHttpHandler(topic) {
+        var _a;
+        return (_a = httpWebhookRegistry[topicForStorage(topic)]) !== null && _a !== void 0 ? _a : null;
+    };
+}
+exports.createGetHttpHandler = createGetHttpHandler;
+function createGetTopicsAdded(httpWebhookRegistry) {
+    return function getTopicsAdded() {
+        return Object.keys(httpWebhookRegistry);
+    };
+}
+exports.createGetTopicsAdded = createGetTopicsAdded;
+function createRegister(config) {
+    var GraphqlClient = (0, graphql_client_1.createGraphqlClientClass)({ config: config });
+    return function register(_a) {
+        var path = _a.path, topic = _a.topic, accessToken = _a.accessToken, shop = _a.shop, _b = _a.deliveryMethod, deliveryMethod = _b === void 0 ? types_2.DeliveryMethod.Http : _b;
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var registerReturn, client, address, checkResult, error_1, result, webhookId, mustRegister, node, endpointAddress, result;
+            return tslib_1.__generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        registerReturn = {};
+                        if (base_types_1.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];
+                        }
+                        client = new GraphqlClient({ domain: shop, accessToken: accessToken });
+                        address = deliveryMethod === types_2.DeliveryMethod.Http
+                            ? "".concat(config.hostScheme, "://").concat(config.hostName).concat(path)
+                            : path;
+                        _c.label = 1;
+                    case 1:
+                        _c.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, client.query({
+                                data: buildCheckQuery({ topic: topic }),
+                            })];
+                    case 2:
+                        checkResult = _c.sent();
+                        return [3 /*break*/, 4];
+                    case 3:
+                        error_1 = _c.sent();
+                        result = error_1 instanceof ShopifyErrors.GraphqlQueryError ? error_1.response : {};
+                        registerReturn[topic] = { success: false, result: result };
+                        return [2 /*return*/, registerReturn];
+                    case 4:
+                        mustRegister = true;
+                        if (checkResult.body.data.webhookSubscriptions.edges.length) {
+                            node = checkResult.body.data.webhookSubscriptions.edges[0].node;
+                            endpointAddress = '';
+                            if (node.endpoint.__typename === 'WebhookHttpEndpoint') {
+                                endpointAddress = node.endpoint.callbackUrl;
+                            }
+                            else if (node.endpoint.__typename === 'WebhookEventBridgeEndpoint') {
+                                endpointAddress = node.endpoint.arn;
+                            }
+                            webhookId = node.id;
+                            if (endpointAddress === address) {
+                                mustRegister = false;
+                            }
+                        }
+                        if (!mustRegister) return [3 /*break*/, 6];
+                        return [4 /*yield*/, client.query({
+                                data: buildQuery({ topic: topic, address: address, deliveryMethod: deliveryMethod, webhookId: webhookId }),
+                            })];
+                    case 5:
+                        result = _c.sent();
+                        registerReturn[topic] = {
+                            success: isSuccess(result.body, deliveryMethod, webhookId),
+                            result: result.body,
+                        };
+                        return [3 /*break*/, 7];
+                    case 6:
+                        registerReturn[topic] = {
+                            success: true,
+                            result: {},
+                        };
+                        _c.label = 7;
+                    case 7: return [2 /*return*/, registerReturn];
+                }
+            });
+        });
+    };
+}
+exports.createRegister = createRegister;
+function createRegisterAllHttp(config, httpWebhookRegistry) {
+    var register = createRegister(config);
+    var getTopicsAdded = createGetTopicsAdded(httpWebhookRegistry);
+    var getHttpHandler = createGetHttpHandler(httpWebhookRegistry);
+    return function registerAllHttp(_a) {
+        var path = _a.path, accessToken = _a.accessToken, shop = _a.shop;
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var registerReturn, topics, topics_1, topics_1_1, topic, handler, webhook, returnedRegister, e_1_1;
+            var e_1, _b;
+            return tslib_1.__generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        registerReturn = {};
+                        topics = getTopicsAdded();
+                        _c.label = 1;
+                    case 1:
+                        _c.trys.push([1, 6, 7, 8]);
+                        topics_1 = tslib_1.__values(topics), topics_1_1 = topics_1.next();
+                        _c.label = 2;
+                    case 2:
+                        if (!!topics_1_1.done) return [3 /*break*/, 5];
+                        topic = topics_1_1.value;
+                        handler = getHttpHandler(topic);
+                        if (!handler) return [3 /*break*/, 4];
+                        webhook = {
+                            path: path,
+                            topic: topic,
+                            accessToken: accessToken,
+                            shop: shop,
+                            deliveryMethod: types_2.DeliveryMethod.Http,
+                        };
+                        return [4 /*yield*/, register(webhook)];
+                    case 3:
+                        returnedRegister = _c.sent();
+                        registerReturn = tslib_1.__assign(tslib_1.__assign({}, registerReturn), returnedRegister);
+                        _c.label = 4;
+                    case 4:
+                        topics_1_1 = topics_1.next();
+                        return [3 /*break*/, 2];
+                    case 5: return [3 /*break*/, 8];
+                    case 6:
+                        e_1_1 = _c.sent();
+                        e_1 = { error: e_1_1 };
+                        return [3 /*break*/, 8];
+                    case 7:
+                        try {
+                            if (topics_1_1 && !topics_1_1.done && (_b = topics_1.return)) _b.call(topics_1);
+                        }
+                        finally { if (e_1) throw e_1.error; }
+                        return [7 /*endfinally*/];
+                    case 8: return [2 /*return*/, registerReturn];
+                }
+            });
+        });
+    };
+}
+exports.createRegisterAllHttp = createRegisterAllHttp;
+var statusTextLookup = (_a = {},
+    _a[network_1.StatusCode.Ok] = 'OK',
+    _a[network_1.StatusCode.BadRequest] = 'Bad Request',
+    _a[network_1.StatusCode.Unauthorized] = 'Unauthorized',
+    _a[network_1.StatusCode.NotFound] = 'Not Found',
+    _a[network_1.StatusCode.InternalServerError] = 'Internal Server Error',
+    _a);
+function checkWebhookRequest(rawBody, headers) {
+    var retVal = {
+        webhookOk: true,
+        errorMessage: '',
+        hmac: '',
+        topic: '',
+        domain: '',
+    };
+    if (rawBody.length) {
+        var hmac = (0, http_1.getHeader)(headers, base_types_1.ShopifyHeader.Hmac);
+        var topic = (0, http_1.getHeader)(headers, base_types_1.ShopifyHeader.Topic);
+        var domain = (0, http_1.getHeader)(headers, base_types_1.ShopifyHeader.Domain);
+        var missingHeaders = [];
+        if (!hmac) {
+            missingHeaders.push(base_types_1.ShopifyHeader.Hmac);
+        }
+        if (!topic) {
+            missingHeaders.push(base_types_1.ShopifyHeader.Topic);
+        }
+        if (!domain) {
+            missingHeaders.push(base_types_1.ShopifyHeader.Domain);
+        }
+        if (missingHeaders.length) {
+            retVal.webhookOk = false;
+            retVal.errorMessage = "Missing one or more of the required HTTP headers to process webhowebhookOks: [".concat(missingHeaders.join(', '), "]");
+        }
+        else {
+            retVal.hmac = hmac;
+            retVal.topic = topic;
+            retVal.domain = domain;
+        }
+    }
+    else {
+        retVal.webhookOk = false;
+        retVal.errorMessage = 'No body was received when processing webhook';
+    }
+    return retVal;
+}
+function createProcess(config, httpWebhookRegistry) {
+    var getHttpHandler = createGetHttpHandler(httpWebhookRegistry);
+    return function process(_a) {
+        var rawBody = _a.rawBody, adapterArgs = tslib_1.__rest(_a, ["rawBody"]);
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var request, response, webhookCheck, webhookOk, hmac, topic, domain, errorMessage, generatedHash, graphqlTopic, handler, error_2, returnResponse;
+            return tslib_1.__generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0: return [4 /*yield*/, (0, http_1.abstractConvertRequest)(adapterArgs)];
+                    case 1:
+                        request = _b.sent();
+                        response = {
+                            statusCode: network_1.StatusCode.Ok,
+                            statusText: statusTextLookup[network_1.StatusCode.Ok],
+                            headers: {},
+                        };
+                        webhookCheck = checkWebhookRequest(rawBody, request.headers);
+                        webhookOk = webhookCheck.webhookOk, hmac = webhookCheck.hmac, topic = webhookCheck.topic, domain = webhookCheck.domain;
+                        errorMessage = webhookCheck.errorMessage;
+                        if (!webhookOk) return [3 /*break*/, 11];
+                        return [4 /*yield*/, (0, crypto_1.createSHA256HMAC)(config.apiSecretKey, rawBody, types_1.HashFormat.Base64)];
+                    case 2:
+                        generatedHash = _b.sent();
+                        if (!(0, safe_compare_1.safeCompare)(generatedHash, hmac)) return [3 /*break*/, 9];
+                        graphqlTopic = topicForStorage(topic);
+                        handler = getHttpHandler(graphqlTopic);
+                        if (!handler) return [3 /*break*/, 7];
+                        _b.label = 3;
+                    case 3:
+                        _b.trys.push([3, 5, , 6]);
+                        return [4 /*yield*/, handler(graphqlTopic, domain, rawBody)];
+                    case 4:
+                        _b.sent();
+                        response.statusCode = network_1.StatusCode.Ok;
+                        return [3 /*break*/, 6];
+                    case 5:
+                        error_2 = _b.sent();
+                        response.statusCode = network_1.StatusCode.InternalServerError;
+                        errorMessage = error_2.message;
+                        return [3 /*break*/, 6];
+                    case 6: return [3 /*break*/, 8];
+                    case 7:
+                        response.statusCode = network_1.StatusCode.NotFound;
+                        errorMessage = "No webhook is registered for topic ".concat(topic);
+                        _b.label = 8;
+                    case 8: return [3 /*break*/, 10];
+                    case 9:
+                        response.statusCode = network_1.StatusCode.Unauthorized;
+                        errorMessage = "Could not validate request for topic ".concat(topic);
+                        _b.label = 10;
+                    case 10: return [3 /*break*/, 12];
+                    case 11:
+                        response.statusCode = network_1.StatusCode.BadRequest;
+                        _b.label = 12;
+                    case 12:
+                        response.statusText = statusTextLookup[response.statusCode];
+                        return [4 /*yield*/, (0, http_1.abstractConvertResponse)(response, adapterArgs)];
+                    case 13:
+                        returnResponse = _b.sent();
+                        if (!(0, http_1.isOK)(response)) {
+                            throw new ShopifyErrors.InvalidWebhookError({
+                                message: errorMessage,
+                                response: returnResponse,
+                            });
+                        }
+                        return [2 /*return*/, Promise.resolve(returnResponse)];
+                }
+            });
+        });
+    };
+}
+exports.createProcess = createProcess;
+//# sourceMappingURL=registry.js.map

package/lib/webhooks/registry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.js","sourceRoot":"","sources":["registry.ts"],"names":[],"mappings":";;;;;AAAA,4CAA4C;AAE5C,2CAS4B;AAC5B,+CAAsD;AACtD,oDAAsD;AACtD,oEAA2E;AAC3E,4CAAyE;AACzE,2DAAuD;AACvD,8DAA0C;AAE1C,iCAYiB;AAEjB,SAAS,SAAS,CAChB,MAAW,EACX,cAA8B,EAC9B,SAAkB;IAElB,IAAI,QAAQ,CAAC;IACb,QAAQ,cAAc,EAAE;QACtB,KAAK,sBAAc,CAAC,IAAI;YACtB,QAAQ,GAAG,qBAAqB,CAAC;YACjC,MAAM;QACR,KAAK,sBAAc,CAAC,WAAW;YAC7B,QAAQ,GAAG,gCAAgC,CAAC;YAC5C,MAAM;QACR,KAAK,sBAAc,CAAC,MAAM;YACxB,QAAQ,GAAG,2BAA2B,CAAC;YACvC,MAAM;QACR;YACE,OAAO,KAAK,CAAC;KAChB;IACD,QAAQ,IAAI,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC;IAC5C,OAAO,OAAO,CACZ,MAAM,CAAC,IAAI;QACT,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;QACrB,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,mBAAmB,CAC5C,CAAC;AACJ,CAAC;AAED,SAAgB,eAAe,CAAC,EAA8B;QAA7B,KAAK,WAAA;IACpC,OAAO,wDACoC,KAAK,0aAoB9C,CAAC;AACL,CAAC;AAvBD,0CAuBC;AAED,SAAgB,UAAU,CAAC,EAKR;;QAJjB,KAAK,WAAA,EACL,OAAO,aAAA,EACP,sBAAoC,EAApC,cAAc,mBAAG,sBAAc,CAAC,IAAI,KAAA,EACpC,SAAS,eAAA;IAET,IAAI,UAAkB,CAAC;IACvB,IAAI,SAAS,EAAE;QACb,UAAU,GAAG,gBAAQ,SAAS,OAAG,CAAC;KACnC;SAAM;QACL,UAAU,GAAG,iBAAU,KAAK,CAAE,CAAC;KAChC;IAED,IAAI,YAAoB,CAAC;IACzB,IAAI,uBAA+B,CAAC;IACpC,IAAI,aAAqB,CAAC;IAC1B,IAAI,WAAmB,CAAC;IACxB,QAAQ,cAAc,EAAE;QACtB,KAAK,sBAAc,CAAC,IAAI;YACtB,YAAY,GAAG,SAAS;gBACtB,CAAC,CAAC,2BAA2B;gBAC7B,CAAC,CAAC,2BAA2B,CAAC;YAChC,uBAAuB,GAAG,0BAAkB,OAAO,QAAI,CAAC;YACxD,MAAM;QACR,KAAK,sBAAc,CAAC,WAAW;YAC7B,YAAY,GAAG,SAAS;gBACtB,CAAC,CAAC,sCAAsC;gBACxC,CAAC,CAAC,sCAAsC,CAAC;YAC3C,uBAAuB,GAAG,kBAAU,OAAO,QAAI,CAAC;YAChD,MAAM;QACR,KAAK,sBAAc,CAAC,MAAM;YACxB,YAAY,GAAG,SAAS;gBACtB,CAAC,CAAC,iCAAiC;gBACnC,CAAC,CAAC,iCAAiC,CAAC;YACtC,KAAA,eAA+B,OAAO;iBACnC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC;iBAC3B,KAAK,CAAC,GAAG,CAAC,IAAA,EAFZ,aAAa,QAAA,EAAE,WAAW,QAAA,CAEb;YACd,uBAAuB,GAAG,4BAAoB,aAAa,mEACf,WAAW,QAAI,CAAC;YAC5D,MAAM;KACT;IAED,OAAO,sDAED,YAAY,cAAI,UAAU,oCAA0B,uBAAuB,yJAUhF,CAAC;AACJ,CAAC;AAvDD,gCAuDC;AAED,SAAS,eAAe,CAAC,KAAa;IACpC,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AACjD,CAAC;AAED,SAAgB,oBAAoB,CAAC,mBAAwC;IAC3E,OAAO,SAAS,cAAc,CAAC,MAAwB;QAC9C,IAAA,KAAK,GAAa,MAAM,MAAnB,EAAE,OAAO,GAAI,MAAM,QAAV,CAAW;QAChC,mBAAmB,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,GAAG,OAAO,CAAC;IACxD,CAAC,CAAC;AACJ,CAAC;AALD,oDAKC;AAED,SAAgB,qBAAqB,CACnC,mBAAwC;IAExC,IAAM,cAAc,GAAG,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;IACjE,OAAO,SAAS,eAAe,CAAC,QAA4B;QAC1D,QAAQ,CAAC,OAAO,CAAC,UAAC,YAAY,IAAK,OAAA,cAAc,CAAC,YAAY,CAAC,EAA5B,CAA4B,CAAC,CAAC;IACnE,CAAC,CAAC;AACJ,CAAC;AAPD,sDAOC;AAED,SAAgB,oBAAoB,CAAC,mBAAwC;IAC3E,OAAO,SAAS,cAAc,CAAC,KAAa;;QAC1C,OAAO,MAAA,mBAAmB,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,mCAAI,IAAI,CAAC;IAC7D,CAAC,CAAC;AACJ,CAAC;AAJD,oDAIC;AAED,SAAgB,oBAAoB,CAAC,mBAAwC;IAC3E,OAAO,SAAS,cAAc;QAC5B,OAAO,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;IAC1C,CAAC,CAAC;AACJ,CAAC;AAJD,oDAIC;AAED,SAAgB,cAAc,CAAC,MAAuB;IACpD,IAAM,aAAa,GAAG,IAAA,yCAAwB,EAAC,EAAC,MAAM,QAAA,EAAC,CAAC,CAAC;IAEzD,OAAO,SAAe,QAAQ,CAAC,EAMd;YALf,IAAI,UAAA,EACJ,KAAK,WAAA,EACL,WAAW,iBAAA,EACX,IAAI,UAAA,EACJ,sBAAoC,EAApC,cAAc,mBAAG,sBAAc,CAAC,IAAI,KAAA;;;;;;wBAE9B,cAAc,GAAmB,EAAE,CAAC;wBAE1C,IAAI,uBAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;4BAC9B,cAAc,CAAC,KAAK,CAAC,GAAG;gCACtB,OAAO,EAAE,KAAK;gCACd,MAAM,EAAE;oCACN,MAAM,EAAE;wCACN;4CACE,OAAO,EAAE,sBAAe,KAAK,+JAA4J;yCAC1L;qCACF;iCACF;6BACF,CAAC;4BAEF,sBAAO,cAAc,EAAC;yBACvB;wBAEK,MAAM,GAAG,IAAI,aAAa,CAAC,EAAC,MAAM,EAAE,IAAI,EAAE,WAAW,aAAA,EAAC,CAAC,CAAC;wBACxD,OAAO,GACX,cAAc,KAAK,sBAAc,CAAC,IAAI;4BACpC,CAAC,CAAC,UAAG,MAAM,CAAC,UAAU,gBAAM,MAAM,CAAC,QAAQ,SAAG,IAAI,CAAE;4BACpD,CAAC,CAAC,IAAI,CAAC;;;;wBAIK,qBAAM,MAAM,CAAC,KAAK,CAAuB;gCACrD,IAAI,EAAE,eAAe,CAAC,EAAC,KAAK,OAAA,EAAC,CAAC;6BAC/B,CAAC,EAAA;;wBAFF,WAAW,GAAG,SAEZ,CAAC;;;;wBAEG,MAAM,GACV,OAAK,YAAY,aAAa,CAAC,iBAAiB,CAAC,CAAC,CAAC,OAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;wBACzE,cAAc,CAAC,KAAK,CAAC,GAAG,EAAC,OAAO,EAAE,KAAK,EAAE,MAAM,QAAA,EAAC,CAAC;wBACjD,sBAAO,cAAc,EAAC;;wBAIpB,YAAY,GAAG,IAAI,CAAC;wBAExB,IAAI,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,MAAM,EAAE;4BACpD,IAAI,GAAI,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC,KAAvD,CAAwD;4BAC/D,eAAe,GAAG,EAAE,CAAC;4BACzB,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,KAAK,qBAAqB,EAAE;gCACtD,eAAe,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC;6BAC7C;iCAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,KAAK,4BAA4B,EAAE;gCACpE,eAAe,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;6BACrC;4BAED,SAAS,GAAG,IAAI,CAAC,EAAE,CAAC;4BACpB,IAAI,eAAe,KAAK,OAAO,EAAE;gCAC/B,YAAY,GAAG,KAAK,CAAC;6BACtB;yBACF;6BAEG,YAAY,EAAZ,wBAAY;wBACC,qBAAM,MAAM,CAAC,KAAK,CAAC;gCAChC,IAAI,EAAE,UAAU,CAAC,EAAC,KAAK,OAAA,EAAE,OAAO,SAAA,EAAE,cAAc,gBAAA,EAAE,SAAS,WAAA,EAAC,CAAC;6BAC9D,CAAC,EAAA;;wBAFI,MAAM,GAAG,SAEb;wBACF,cAAc,CAAC,KAAK,CAAC,GAAG;4BACtB,OAAO,EAAE,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,cAAc,EAAE,SAAS,CAAC;4BAC1D,MAAM,EAAE,MAAM,CAAC,IAAI;yBACpB,CAAC;;;wBAEF,cAAc,CAAC,KAAK,CAAC,GAAG;4BACtB,OAAO,EAAE,IAAI;4BACb,MAAM,EAAE,EAAE;yBACX,CAAC;;4BAEJ,sBAAO,cAAc,EAAC;;;;KACvB,CAAC;AACJ,CAAC;AA/ED,wCA+EC;AAED,SAAgB,qBAAqB,CACnC,MAAuB,EACvB,mBAAwC;IAExC,IAAM,QAAQ,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;IACxC,IAAM,cAAc,GAAG,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;IACjE,IAAM,cAAc,GAAG,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;IAEjE,OAAO,SAAe,eAAe,CAAC,EAIZ;YAHxB,IAAI,UAAA,EACJ,WAAW,iBAAA,EACX,IAAI,UAAA;;;;;;;wBAEA,cAAc,GAAG,EAAE,CAAC;wBAClB,MAAM,GAAG,cAAc,EAAE,CAAC;;;;wBAEZ,WAAA,iBAAA,MAAM,CAAA;;;;wBAAf,KAAK;wBACR,OAAO,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;6BAClC,OAAO,EAAP,wBAAO;wBACH,OAAO,GAAmB;4BAC9B,IAAI,MAAA;4BACJ,KAAK,OAAA;4BACL,WAAW,aAAA;4BACX,IAAI,MAAA;4BACJ,cAAc,EAAE,sBAAc,CAAC,IAAI;yBACpC,CAAC;wBACuB,qBAAM,QAAQ,CAAC,OAAO,CAAC,EAAA;;wBAA1C,gBAAgB,GAAG,SAAuB;wBAChD,cAAc,yCAAO,cAAc,GAAK,gBAAgB,CAAC,CAAC;;;;;;;;;;;;;;;;4BAG9D,sBAAO,cAAc,EAAC;;;;KACvB,CAAC;AACJ,CAAC;AAhCD,sDAgCC;AACD,IAAM,gBAAgB;IACpB,GAAC,oBAAU,CAAC,EAAE,IAAG,IAAI;IACrB,GAAC,oBAAU,CAAC,UAAU,IAAG,aAAa;IACtC,GAAC,oBAAU,CAAC,YAAY,IAAG,cAAc;IACzC,GAAC,oBAAU,CAAC,QAAQ,IAAG,WAAW;IAClC,GAAC,oBAAU,CAAC,mBAAmB,IAAG,uBAAuB;OAC1D,CAAC;AAEF,SAAS,mBAAmB,CAC1B,OAAe,EACf,OAAgB;IAQhB,IAAM,MAAM,GAAG;QACb,SAAS,EAAE,IAAI;QACf,YAAY,EAAE,EAAE;QAChB,IAAI,EAAE,EAAE;QACR,KAAK,EAAE,EAAE;QACT,MAAM,EAAE,EAAE;KACX,CAAC;IAEF,IAAI,OAAO,CAAC,MAAM,EAAE;QAClB,IAAM,IAAI,GAAG,IAAA,gBAAS,EAAC,OAAO,EAAE,0BAAa,CAAC,IAAI,CAAC,CAAC;QACpD,IAAM,KAAK,GAAG,IAAA,gBAAS,EAAC,OAAO,EAAE,0BAAa,CAAC,KAAK,CAAC,CAAC;QACtD,IAAM,MAAM,GAAG,IAAA,gBAAS,EAAC,OAAO,EAAE,0BAAa,CAAC,MAAM,CAAC,CAAC;QAExD,IAAM,cAAc,GAAoB,EAAE,CAAC;QAC3C,IAAI,CAAC,IAAI,EAAE;YACT,cAAc,CAAC,IAAI,CAAC,0BAAa,CAAC,IAAI,CAAC,CAAC;SACzC;QACD,IAAI,CAAC,KAAK,EAAE;YACV,cAAc,CAAC,IAAI,CAAC,0BAAa,CAAC,KAAK,CAAC,CAAC;SAC1C;QACD,IAAI,CAAC,MAAM,EAAE;YACX,cAAc,CAAC,IAAI,CAAC,0BAAa,CAAC,MAAM,CAAC,CAAC;SAC3C;QAED,IAAI,cAAc,CAAC,MAAM,EAAE;YACzB,MAAM,CAAC,SAAS,GAAG,KAAK,CAAC;YACzB,MAAM,CAAC,YAAY,GAAG,wFAAiF,cAAc,CAAC,IAAI,CACxH,IAAI,CACL,MAAG,CAAC;SACN;aAAM;YACL,MAAM,CAAC,IAAI,GAAG,IAAc,CAAC;YAC7B,MAAM,CAAC,KAAK,GAAG,KAAe,CAAC;YAC/B,MAAM,CAAC,MAAM,GAAG,MAAgB,CAAC;SAClC;KACF;SAAM;QACL,MAAM,CAAC,SAAS,GAAG,KAAK,CAAC;QACzB,MAAM,CAAC,YAAY,GAAG,8CAA8C,CAAC;KACtE;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAgB,aAAa,CAC3B,MAAuB,EACvB,mBAAwC;IAExC,IAAM,cAAc,GAAG,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;IAEjE,OAAO,SAAe,OAAO,CAAC,EAGP;QAFrB,IAAA,OAAO,aAAA,EACJ,WAAW,sBAFc,WAG7B,CADe;;;;;4BAEqB,qBAAM,IAAA,6BAAsB,EAC7D,WAAW,CACZ,EAAA;;wBAFK,OAAO,GAAsB,SAElC;wBACK,QAAQ,GAAuB;4BACnC,UAAU,EAAE,oBAAU,CAAC,EAAE;4BACzB,UAAU,EAAE,gBAAgB,CAAC,oBAAU,CAAC,EAAE,CAAC;4BAC3C,OAAO,EAAE,EAAE;yBACZ,CAAC;wBAEI,YAAY,GAAG,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;wBAC5D,SAAS,GAAyB,YAAY,UAArC,EAAE,IAAI,GAAmB,YAAY,KAA/B,EAAE,KAAK,GAAY,YAAY,MAAxB,EAAE,MAAM,GAAI,YAAY,OAAhB,CAAiB;wBACjD,YAAY,GAAI,YAAY,aAAhB,CAAiB;6BAE9B,SAAS,EAAT,yBAAS;wBACW,qBAAM,IAAA,yBAAgB,EAC1C,MAAM,CAAC,YAAY,EACnB,OAAO,EACP,kBAAU,CAAC,MAAM,CAClB,EAAA;;wBAJK,aAAa,GAAG,SAIrB;6BAEG,IAAA,0BAAW,EAAC,aAAa,EAAE,IAAI,CAAC,EAAhC,wBAAgC;wBAC5B,YAAY,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;wBACtC,OAAO,GAAG,cAAc,CAAC,YAAY,CAAC,CAAC;6BAEzC,OAAO,EAAP,wBAAO;;;;wBAEP,qBAAM,OAAO,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAA;;wBAA5C,SAA4C,CAAC;wBAC7C,QAAQ,CAAC,UAAU,GAAG,oBAAU,CAAC,EAAE,CAAC;;;;wBAEpC,QAAQ,CAAC,UAAU,GAAG,oBAAU,CAAC,mBAAmB,CAAC;wBACrD,YAAY,GAAG,OAAK,CAAC,OAAO,CAAC;;;;wBAG/B,QAAQ,CAAC,UAAU,GAAG,oBAAU,CAAC,QAAQ,CAAC;wBAC1C,YAAY,GAAG,6CAAsC,KAAK,CAAE,CAAC;;;;wBAG/D,QAAQ,CAAC,UAAU,GAAG,oBAAU,CAAC,YAAY,CAAC;wBAC9C,YAAY,GAAG,+CAAwC,KAAK,CAAE,CAAC;;;;wBAGjE,QAAQ,CAAC,UAAU,GAAG,oBAAU,CAAC,UAAU,CAAC;;;wBAG9C,QAAQ,CAAC,UAAU,GAAG,gBAAgB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;wBACrC,qBAAM,IAAA,8BAAuB,EAAC,QAAQ,EAAE,WAAW,CAAC,EAAA;;wBAArE,cAAc,GAAG,SAAoD;wBAC3E,IAAI,CAAC,IAAA,WAAI,EAAC,QAAQ,CAAC,EAAE;4BACnB,MAAM,IAAI,aAAa,CAAC,mBAAmB,CAAC;gCAC1C,OAAO,EAAE,YAAY;gCACrB,QAAQ,EAAE,cAAc;6BACzB,CAAC,CAAC;yBACJ;wBAED,sBAAO,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,EAAC;;;;KACxC,CAAC;AACJ,CAAC;AAjED,sCAiEC"}

package/lib/webhooks/types.d.ts

@@ -0,0 +1,69 @@
+import { AdapterArgs } from '../../runtime';
+import type { shopifyWebhooks } from '.';
+export declare enum DeliveryMethod {
+    Http = "http",
+    EventBridge = "eventbridge",
+    PubSub = "pubsub"
+}
+export declare type WebhookHandlerFunction = (topic: string, shop_domain: string, body: string) => Promise<void>;
+export interface HttpWebhookRegistry {
+    [topic: string]: WebhookHandlerFunction;
+}
+export interface ShortenedRegisterParams {
+    path: string;
+    shop: string;
+    accessToken: string;
+}
+export interface RegisterParams extends ShortenedRegisterParams {
+    topic: string;
+    deliveryMethod?: DeliveryMethod;
+}
+export interface RegisterReturn {
+    [topic: string]: {
+        success: boolean;
+        result: unknown;
+    };
+}
+interface WebhookCheckResponseNode<T = {
+    endpoint: {
+        __typename: 'WebhookHttpEndpoint';
+        callbackUrl: string;
+    } | {
+        __typename: 'WebhookEventBridgeEndpoint';
+        arn: string;
+    } | {
+        __typename: 'WebhookPubSubEndpoint';
+        pubSubProject: string;
+        pubSubTopic: string;
+    };
+}> {
+    node: {
+        id: string;
+    } & T;
+}
+export interface WebhookCheckResponse<T = WebhookCheckResponseNode> {
+    data: {
+        webhookSubscriptions: {
+            edges: T[];
+        };
+    };
+}
+export interface BuildCheckQueryParams {
+    topic: string;
+}
+export interface BuildQueryParams {
+    topic: string;
+    address: string;
+    deliveryMethod: DeliveryMethod;
+    webhookId?: string;
+}
+export interface AddHandlerParams {
+    topic: string;
+    handler: WebhookHandlerFunction;
+}
+export interface WebhookProcessParams extends AdapterArgs {
+    rawBody: string;
+}
+export declare type ShopifyWebhooks = ReturnType<typeof shopifyWebhooks>;
+export {};
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAC,MAAM,eAAe,CAAC;AAE1C,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,GAAG,CAAC;AAEvC,oBAAY,cAAc;IACxB,IAAI,SAAS;IACb,WAAW,gBAAgB;IAC3B,MAAM,WAAW;CAClB;AAED,oBAAY,sBAAsB,GAAG,CACnC,KAAK,EAAE,MAAM,EACb,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,MAAM,KACT,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnB,MAAM,WAAW,mBAAmB;IAClC,CAAC,KAAK,EAAE,MAAM,GAAG,sBAAsB,CAAC;CACzC;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,cAAe,SAAQ,uBAAuB;IAE7D,KAAK,EAAE,MAAM,CAAC;IACd,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,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;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,cAAc,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,sBAAsB,CAAC;CACjC;AAED,MAAM,WAAW,oBAAqB,SAAQ,WAAW;IACvD,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,oBAAY,eAAe,GAAG,UAAU,CAAC,OAAO,eAAe,CAAC,CAAC"}

package/lib/webhooks/types.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeliveryMethod = void 0;
+var DeliveryMethod;
+(function (DeliveryMethod) {
+    DeliveryMethod["Http"] = "http";
+    DeliveryMethod["EventBridge"] = "eventbridge";
+    DeliveryMethod["PubSub"] = "pubsub";
+})(DeliveryMethod = exports.DeliveryMethod || (exports.DeliveryMethod = {}));
+//# sourceMappingURL=types.js.map

package/lib/webhooks/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":";;;AAIA,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,+BAAa,CAAA;IACb,6CAA2B,CAAA;IAC3B,mCAAiB,CAAA;AACnB,CAAC,EAJW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAIzB"}

package/package.json

@@ -1,53 +1,54 @@
 {
   "name": "@shopify/shopify-api",
-  "version": "6.0.0-rc5",
+  "version": "6.0.0-rc6",
   "description": "Shopify API Library for Node - accelerate development with support for authentication, graphql proxy, webhooks",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
   "exports": {
     ".": {
-      "import": "./dist/index.js",
-      "require": "./dist/index.js",
-      "types": "./dist/index.d.ts"
+      "default": "./lib/index.js",
+      "require": "./lib/index.js",
+      "types": "./lib/index.d.ts"
     },
     "./session-storage/*": {
-      "import": "./dist/session-storage/*.js",
-      "require": "./dist/session-storage/*.js",
-      "types": "./dist/session-storage/*.d.ts"
+      "import": "./session-storage/*.js",
+      "require": "./session-storage/*.js",
+      "types": "./session-storage/*.d.ts"
     },
     "./rest/admin/*": {
-      "import": "./dist/rest/admin/*/index.js",
-      "require": "./dist/rest/admin/*/index.js",
-      "types": "./dist/rest/admin/*/index.d.ts"
+      "import": "./rest/admin/*/index.js",
+      "require": "./rest/admin/*/index.js",
+      "types": "./rest/admin/*/index.d.ts"
     },
     "./runtime": {
-      "import": "./dist/runtime/index.js",
-      "require": "./dist/runtime/index.js",
-      "types": "./dist/runtime/index.d.ts"
+      "import": "./runtime/index.js",
+      "require": "./runtime/index.js",
+      "types": "./runtime/index.d.ts"
     },
     "./adapters/node": {
-      "import": "./dist/adapters/node/index.js",
-      "require": "./dist/adapters/node/index.js",
-      "types": "./dist/adapters/node/index.d.ts"
+      "import": "./adapters/node/index.js",
+      "require": "./adapters/node/index.js",
+      "types": "./adapters/node/index.d.ts"
     },
     "./adapters/cf-worker": {
-      "import": "./dist/adapters/cf-worker/index.js",
-      "require": "./dist/adapters/cf-worker/index.js",
-      "types": "./dist/adapters/cf-worker/index.d.ts"
+      "import": "./adapters/cf-worker/index.js",
+      "require": "./adapters/cf-worker/index.js",
+      "types": "./adapters/cf-worker/index.d.ts"
     }
   },
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
   "prettier": "@shopify/prettier-config",
   "scripts": {
     "test:all": "jest",
     "test": "jest --selectProjects library",
-    "pretest:adapters": "yarn build && yarn rollup -c src/adapters/__e2etests__/rollup.test-cf-worker-app.config.js",
+    "pretest:adapters": "yarn build && yarn rollup -c adapters/__e2etests__/rollup.test-cf-worker-app.config.js",
     "test:adapters": "jest --selectProjects adapters:mock adapters:node adapters:cf-worker",
     "test:session_storage": "jest --selectProjects session_storage",
     "test:rest_resources": "jest --selectProjects rest_resources",
     "lint": "jest --selectProjects lint",
     "test:dev": "jest --selectProjects library lint",
+    "clean": "yarn tsc --build --clean",
+    "prebuild": "yarn tsc --build --clean",
     "build": "tsc",
-    "clean": "rimraf ./dist tsconfig.tsbuildinfo",
     "prepublishOnly": "yarn run build",
     "preversion": "yarn run test",
     "postversion": "git push origin main --follow-tags && echo \"Log in to shipit to deploy version $npm_package_version\""
@@ -90,6 +91,7 @@
     "node-fetch": "^2.6.1",
     "pg": "^8.7.3",
     "redis": "^4.1.0",
+    "semver": "^7.3.8",
     "sqlite3": "^5.0.8",
     "tslib": "^2.0.3",
     "uuid": "^8.3.1"
@@ -106,12 +108,13 @@
     "@types/jest": "^26.0.15",
     "@types/node": "^14.18.12",
     "@types/pg": "^8.6.5",
+    "@types/semver": "^7.3.12",
     "@types/sqlite3": "^3.1.8",
     "@types/uuid": "^8.3.0",
     "eslint": "^7.30.0",
     "eslint-plugin-prettier": "^4.0.0",
     "express": "^4.17.1",
-    "jest": "^27.4.3",
+    "jest": "^29.1.2",
     "jest-environment-miniflare": "^2.6.0",
     "jest-fetch-mock": "^3.0.3",
     "jest-runner-eslint": "^1.0.1",
@@ -121,11 +124,8 @@
     "rollup": "^2.79.1",
     "rollup-plugin-swc": "^0.2.1",
     "supertest": "^6.1.3",
-    "ts-jest": "^27.1.1",
+    "ts-jest": "^29.0.3",
+    "ts-node": "^10.9.1",
     "typescript": "^4.6.3"
-  },
-  "files": [
-    "dist/*",
-    "!tsconfig.tsbuildinfo"
-  ]
+  }
 }