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

package/dist/webhooks/registry.js

@@ -1,364 +0,0 @@
-"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 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 crypto_1 = require("../runtime/crypto");
-var types_1 = require("../runtime/crypto/types");
-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;

package/dist/webhooks/types.d.ts

@@ -1,69 +0,0 @@
-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/dist/webhooks/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/webhooks/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAC,MAAM,YAAY,CAAC;AAEvC,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/dist/webhooks/types.js

@@ -1,9 +0,0 @@
-"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 = {}));