@shopify/shopify-api 5.1.0 → 6.0.0-rc2

package/dist/adapters/node/adapter.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="node" />
+import type { IncomingMessage, ServerResponse } from 'http';
+import { SQLiteSessionStorage } from '../../session-storage/sqlite';
+import { AdapterArgs, Headers, NormalizedRequest, NormalizedResponse } from '../../runtime/http';
+interface NodeAdapterArgs extends AdapterArgs {
+    rawRequest: IncomingMessage;
+    rawResponse: ServerResponse;
+}
+export declare function nodeConvertRequest(adapterArgs: NodeAdapterArgs): Promise<NormalizedRequest>;
+export declare function nodeConvertAndSendResponse(response: NormalizedResponse, adapterArgs: NodeAdapterArgs): Promise<void>;
+export declare function nodeConvertAndSetHeaders(headers: Headers, adapterArgs: NodeAdapterArgs): Promise<void>;
+export declare function nodeFetch({ url, method, headers, body, }: NormalizedRequest): Promise<NormalizedResponse>;
+export declare function nodeCreateDefaultStorage(): SQLiteSessionStorage;
+export declare function nodeRuntimeString(): string;
+export {};
+//# sourceMappingURL=adapter.d.ts.map

package/dist/adapters/node/adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../../../src/adapters/node/adapter.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAC,eAAe,EAAE,cAAc,EAAC,MAAM,MAAM,CAAC;AAK1D,OAAO,EAAC,oBAAoB,EAAC,MAAM,8BAA8B,CAAC;AAClE,OAAO,EACL,WAAW,EAGX,OAAO,EACP,iBAAiB,EACjB,kBAAkB,EACnB,MAAM,oBAAoB,CAAC;AAE5B,UAAU,eAAgB,SAAQ,WAAW;IAC3C,UAAU,EAAE,eAAe,CAAC;IAC5B,WAAW,EAAE,cAAc,CAAC;CAC7B;AAED,wBAAsB,kBAAkB,CACtC,WAAW,EAAE,eAAe,GAC3B,OAAO,CAAC,iBAAiB,CAAC,CAO5B;AAED,wBAAsB,0BAA0B,CAC9C,QAAQ,EAAE,kBAAkB,EAC5B,WAAW,EAAE,eAAe,GAC3B,OAAO,CAAC,IAAI,CAAC,CAef;AAED,wBAAsB,wBAAwB,CAC5C,OAAO,EAAE,OAAO,EAChB,WAAW,EAAE,eAAe,GAC3B,OAAO,CAAC,IAAI,CAAC,CAMf;AAED,wBAAsB,SAAS,CAAC,EAC9B,GAAG,EACH,MAAM,EACN,OAAY,EACZ,IAAI,GACL,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CASjD;AAED,wBAAgB,wBAAwB,yBAOvC;AAED,wBAAgB,iBAAiB,WAEhC"}

package/dist/adapters/node/adapter.js

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.nodeRuntimeString = exports.nodeCreateDefaultStorage = exports.nodeFetch = exports.nodeConvertAndSetHeaders = exports.nodeConvertAndSendResponse = exports.nodeConvertRequest = void 0;
+var tslib_1 = require("tslib");
+var path_1 = tslib_1.__importDefault(require("path"));
+var node_fetch_1 = tslib_1.__importDefault(require("node-fetch"));
+var sqlite_1 = require("../../session-storage/sqlite");
+var http_1 = require("../../runtime/http");
+function nodeConvertRequest(adapterArgs) {
+    var _a;
+    return tslib_1.__awaiter(this, void 0, void 0, function () {
+        var req;
+        return tslib_1.__generator(this, function (_b) {
+            req = adapterArgs.rawRequest;
+            return [2 /*return*/, {
+                    headers: (0, http_1.canonicalizeHeaders)(tslib_1.__assign({}, req.headers)),
+                    method: (_a = req.method) !== null && _a !== void 0 ? _a : 'GET',
+                    url: req.url,
+                }];
+        });
+    });
+}
+exports.nodeConvertRequest = nodeConvertRequest;
+function nodeConvertAndSendResponse(response, adapterArgs) {
+    return tslib_1.__awaiter(this, void 0, void 0, function () {
+        var res;
+        return tslib_1.__generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    res = adapterArgs.rawResponse;
+                    if (!response.headers) return [3 /*break*/, 2];
+                    return [4 /*yield*/, nodeConvertAndSetHeaders(response.headers, adapterArgs)];
+                case 1:
+                    _a.sent();
+                    _a.label = 2;
+                case 2:
+                    if (response.body) {
+                        res.write(response.body);
+                    }
+                    res.statusCode = response.statusCode;
+                    res.statusMessage = response.statusText;
+                    res.end();
+                    return [2 /*return*/];
+            }
+        });
+    });
+}
+exports.nodeConvertAndSendResponse = nodeConvertAndSendResponse;
+function nodeConvertAndSetHeaders(headers, adapterArgs) {
+    return tslib_1.__awaiter(this, void 0, void 0, function () {
+        var res;
+        return tslib_1.__generator(this, function (_a) {
+            res = adapterArgs.rawResponse;
+            Object.entries(headers).forEach(function (_a) {
+                var _b = tslib_1.__read(_a, 2), header = _b[0], value = _b[1];
+                return res.setHeader(header, value);
+            });
+            return [2 /*return*/];
+        });
+    });
+}
+exports.nodeConvertAndSetHeaders = nodeConvertAndSetHeaders;
+function nodeFetch(_a) {
+    var url = _a.url, method = _a.method, _b = _a.headers, headers = _b === void 0 ? {} : _b, body = _a.body;
+    return tslib_1.__awaiter(this, void 0, void 0, function () {
+        var resp, respBody;
+        return tslib_1.__generator(this, function (_c) {
+            switch (_c.label) {
+                case 0: return [4 /*yield*/, (0, node_fetch_1.default)(url, { method: method, headers: (0, http_1.flatHeaders)(headers), body: body })];
+                case 1:
+                    resp = _c.sent();
+                    return [4 /*yield*/, resp.text()];
+                case 2:
+                    respBody = _c.sent();
+                    return [2 /*return*/, {
+                            statusCode: resp.status,
+                            statusText: resp.statusText,
+                            body: respBody,
+                            headers: (0, http_1.canonicalizeHeaders)(Object.fromEntries(resp.headers.entries())),
+                        }];
+            }
+        });
+    });
+}
+exports.nodeFetch = nodeFetch;
+function nodeCreateDefaultStorage() {
+    var dbFile = path_1.default.join(require.main ? path_1.default.dirname(require.main.filename) : process.cwd(), 'database.sqlite');
+    return new sqlite_1.SQLiteSessionStorage(dbFile);
+}
+exports.nodeCreateDefaultStorage = nodeCreateDefaultStorage;
+function nodeRuntimeString() {
+    return "Node ".concat(process.version);
+}
+exports.nodeRuntimeString = nodeRuntimeString;

package/dist/adapters/node/index.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/adapters/node/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/adapters/node/index.ts"],"names":[],"mappings":""}

package/dist/adapters/node/index.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+var crypto_1 = tslib_1.__importDefault(require("crypto"));
+var runtime_1 = require("../../runtime");
+var adapter_1 = require("./adapter");
+(0, runtime_1.setAbstractFetchFunc)(adapter_1.nodeFetch);
+(0, runtime_1.setAbstractConvertRequestFunc)(adapter_1.nodeConvertRequest);
+(0, runtime_1.setAbstractConvertResponseFunc)(adapter_1.nodeConvertAndSendResponse);
+(0, runtime_1.setAbstractConvertHeadersFunc)(adapter_1.nodeConvertAndSetHeaders);
+(0, runtime_1.setAbstractCreateDefaultStorage)(adapter_1.nodeCreateDefaultStorage);
+(0, runtime_1.setAbstractRuntimeString)(adapter_1.nodeRuntimeString);
+(0, runtime_1.setCrypto)(crypto_1.default);

package/dist/auth/get-embedded-app-url.d.ts

@@ -0,0 +1,5 @@
+import { ConfigInterface } from '../base-types';
+import { GetEmbeddedAppUrlParams } from './types';
+export declare function createGetEmbeddedAppUrl(config: ConfigInterface): ({ ...adapterArgs }: GetEmbeddedAppUrlParams) => Promise<string>;
+export declare function createBuildEmbeddedAppUrl(config: ConfigInterface): (host: string) => string;
+//# sourceMappingURL=get-embedded-app-url.d.ts.map

package/dist/auth/get-embedded-app-url.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-embedded-app-url.d.ts","sourceRoot":"","sources":["../../src/auth/get-embedded-app-url.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,eAAe,EAAC,MAAM,eAAe,CAAC;AAI9C,OAAO,EAAC,uBAAuB,EAAC,MAAM,SAAS,CAAC;AAEhD,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,eAAe,wBAC7B,uBAAuB,KAAG,QAAQ,MAAM,CAAC,CA0B1E;AAED,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,eAAe,UACjD,MAAM,KAAG,MAAM,CAY9B"}

package/dist/auth/get-embedded-app-url.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createBuildEmbeddedAppUrl = exports.createGetEmbeddedAppUrl = void 0;
+var tslib_1 = require("tslib");
+var ShopifyErrors = tslib_1.__importStar(require("../error"));
+var http_1 = require("../runtime/http");
+var shop_validator_1 = require("../utils/shop-validator");
+function createGetEmbeddedAppUrl(config) {
+    var _this = this;
+    return function (_a) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
+        var request, url, host;
+        var adapterArgs = tslib_1.__rest(_a, []);
+        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();
+                    if (!request) {
+                        throw new ShopifyErrors.MissingRequiredArgument('getEmbeddedAppUrl requires a request object argument');
+                    }
+                    if (!request.url) {
+                        throw new ShopifyErrors.InvalidRequestError('Request does not contain a URL');
+                    }
+                    url = new URL(request.url, "https://".concat(request.headers.host));
+                    host = url.searchParams.get('host');
+                    if (typeof host !== 'string') {
+                        throw new ShopifyErrors.InvalidRequestError('Request does not contain a host query parameter');
+                    }
+                    return [2 /*return*/, createBuildEmbeddedAppUrl(config)(host)];
+            }
+        });
+    }); };
+}
+exports.createGetEmbeddedAppUrl = createGetEmbeddedAppUrl;
+function createBuildEmbeddedAppUrl(config) {
+    return function (host) {
+        (0, shop_validator_1.createSanitizeHost)(config)(host, true);
+        // eslint-disable-next-line no-warning-comments
+        // TODO Remove the Buffer.from call when dropping Node 14 support
+        var decodedHost = typeof atob === 'undefined'
+            ? Buffer.from(host, 'base64').toString()
+            : atob(host);
+        return "https://".concat(decodedHost, "/apps/").concat(config.apiKey);
+    };
+}
+exports.createBuildEmbeddedAppUrl = createBuildEmbeddedAppUrl;

package/dist/auth/index.d.ts

@@ -0,0 +1,12 @@
+import { ConfigInterface } from '../base-types';
+import { nonce } from './oauth/nonce';
+import { safeCompare } from './oauth/safe-compare';
+export declare function shopifyAuth(config: ConfigInterface): {
+    begin: ({ shop, callbackPath, isOnline, ...adapterArgs }: import("./types").BeginParams) => Promise<any>;
+    callback: <T = any>({ isOnline, ...adapterArgs }: import("./types").CallbackParams) => Promise<import("./types").CallbackResponse<T>>;
+    nonce: typeof nonce;
+    safeCompare: typeof safeCompare;
+    getEmbeddedAppUrl: ({ ...adapterArgs }: import("./types").GetEmbeddedAppUrlParams) => Promise<string>;
+    buildEmbeddedAppUrl: (host: string) => string;
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/auth/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/auth/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,eAAe,EAAC,MAAM,eAAe,CAAC;AAG9C,OAAO,EAAC,KAAK,EAAC,MAAM,eAAe,CAAC;AACpC,OAAO,EAAC,WAAW,EAAC,MAAM,sBAAsB,CAAC;AAMjD,wBAAgB,WAAW,CAAC,MAAM,EAAE,eAAe;;;;;;;EASlD"}

package/dist/auth/index.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shopifyAuth = void 0;
+var oauth_1 = require("./oauth/oauth");
+var nonce_1 = require("./oauth/nonce");
+var safe_compare_1 = require("./oauth/safe-compare");
+var get_embedded_app_url_1 = require("./get-embedded-app-url");
+function shopifyAuth(config) {
+    return {
+        begin: (0, oauth_1.createBegin)(config),
+        callback: (0, oauth_1.createCallback)(config),
+        nonce: nonce_1.nonce,
+        safeCompare: safe_compare_1.safeCompare,
+        getEmbeddedAppUrl: (0, get_embedded_app_url_1.createGetEmbeddedAppUrl)(config),
+        buildEmbeddedAppUrl: (0, get_embedded_app_url_1.createBuildEmbeddedAppUrl)(config),
+    };
+}
+exports.shopifyAuth = shopifyAuth;

package/dist/auth/oauth/nonce.d.ts

@@ -0,0 +1,2 @@
+export declare function nonce(): string;
+//# sourceMappingURL=nonce.d.ts.map

package/dist/auth/oauth/nonce.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nonce.d.ts","sourceRoot":"","sources":["../../../src/auth/oauth/nonce.ts"],"names":[],"mappings":"AAEA,wBAAgB,KAAK,IAAI,MAAM,CAgB9B"}

package/dist/auth/oauth/nonce.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.nonce = void 0;
+var crypto_1 = require("../../runtime/crypto");
+function nonce() {
+    var length = 15;
+    // eslint-disable-next-line no-warning-comments
+    // TODO Remove the randomBytes call when dropping Node 14 support
+    var bytes = crypto_1.crypto.getRandomValues
+        ? crypto_1.crypto.getRandomValues(new Uint8Array(length))
+        : crypto_1.crypto.randomBytes(length);
+    var nonce = bytes
+        .map(function (byte) {
+        return byte % 10;
+    })
+        .join('');
+    return nonce;
+}
+exports.nonce = nonce;

package/dist/auth/oauth/oauth.d.ts

@@ -1,62 +1,6 @@
-import http from 'http';
-import { SessionInterface } from '../session/types';
-import { AuthQuery } from './types';
-declare const ShopifyOAuth: {
-    SESSION_COOKIE_NAME: string;
-    STATE_COOKIE_NAME: string;
-    /**
-     * Initializes a session and cookie for the OAuth process, and returns the necessary authorization url.
-     *
-     * @param request Current HTTP Request
-     * @param response Current HTTP Response
-     * @param shop Shop url: {shop}.myshopify.com
-     * @param redirect Redirect url for callback
-     * @param isOnline Boolean value. If true, appends 'per-user' grant options to authorization url to receive online access token.
-     *                 During final oauth request, will receive back the online access token and current online session information.
-     *                 Defaults to online access.
-     */
-    beginAuth(request: http.IncomingMessage, response: http.ServerResponse, shop: string, redirectPath: string, isOnline?: boolean): Promise<string>;
-    /**
-     * Validates the received callback query.
-     * If valid, will make the subsequent request to update the current session with the appropriate access token.
-     * Throws errors for missing sessions and invalid callbacks.
-     *
-     * @param request Current HTTP Request
-     * @param response Current HTTP Response
-     * @param query Current HTTP Request Query, containing the information to be validated.
-     *              Depending on framework, this may need to be cast as "unknown" before being passed.
-     * @param isOnline Boolean value. Defaults to true (online access).
-     * @returns SessionInterface
-     */
-    validateAuthCallback(request: http.IncomingMessage, response: http.ServerResponse, query: AuthQuery): Promise<SessionInterface>;
-    /**
-     * Loads the current session id from the session cookie.
-     *
-     * @param request HTTP request object
-     * @param response HTTP response object
-     */
-    getCookieSessionId(request: http.IncomingMessage, response: http.ServerResponse): string | undefined;
-    /**
-     * Builds a JWT session id from the current shop and user.
-     *
-     * @param shop Shopify shop domain
-     * @param userId Current actor id
-     */
-    getJwtSessionId(shop: string, userId: string): string;
-    /**
-     * Builds an offline session id for the given shop.
-     *
-     * @param shop Shopify shop domain
-     */
-    getOfflineSessionId(shop: string): string;
-    /**
-     * Extracts the current session id from the request / response pair.
-     *
-     * @param request  HTTP request object
-     * @param response HTTP response object
-     * @param isOnline Whether to load online (default) or offline sessions (optional)
-     */
-    getCurrentSessionId(request: http.IncomingMessage, response: http.ServerResponse, isOnline?: boolean): string | undefined;
-};
-export { ShopifyOAuth };
+import { ConfigInterface } from '../../base-types';
+import { AdapterResponse } from '../../runtime/http';
+import { BeginParams, CallbackParams, CallbackResponse } from './types';
+export declare function createBegin(config: ConfigInterface): ({ shop, callbackPath, isOnline, ...adapterArgs }: BeginParams) => Promise<AdapterResponse>;
+export declare function createCallback(config: ConfigInterface): <T = any>({ isOnline, ...adapterArgs }: CallbackParams) => Promise<CallbackResponse<T>>;
 //# sourceMappingURL=oauth.d.ts.map

package/dist/auth/oauth/oauth.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"oauth.d.ts","sourceRoot":"","sources":["../../../src/auth/oauth/oauth.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AAexB,OAAO,EAAC,gBAAgB,EAAC,MAAM,kBAAkB,CAAC;AAGlD,OAAO,EACL,SAAS,EAIV,MAAM,SAAS,CAAC;AAEjB,QAAA,MAAM,YAAY;;;IAIhB;;;;;;;;;;OAUG;uBAEQ,KAAK,eAAe,YACnB,KAAK,cAAc,QACvB,MAAM,gBACE,MAAM,uBAEnB,QAAQ,MAAM,CAAC;IAkClB;;;;;;;;;;;OAWG;kCAEQ,KAAK,eAAe,YACnB,KAAK,cAAc,SACtB,SAAS,GACf,QAAQ,gBAAgB,CAAC;IAwE5B;;;;;OAKG;gCAEQ,KAAK,eAAe,YACnB,KAAK,cAAc,GAC5B,MAAM,GAAG,SAAS;IAIrB;;;;;OAKG;0BACmB,MAAM,UAAU,MAAM,GAAG,MAAM;IAIrD;;;;OAIG;8BACuB,MAAM,GAAG,MAAM;IAIzC;;;;;;OAMG;iCAEQ,KAAK,eAAe,YACnB,KAAK,cAAc,uBAE5B,MAAM,GAAG,SAAS;CAqCtB,CAAC;AAwGF,OAAO,EAAC,YAAY,EAAC,CAAC"}
+{"version":3,"file":"oauth.d.ts","sourceRoot":"","sources":["../../../src/auth/oauth/oauth.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,eAAe,EAAC,MAAM,kBAAkB,CAAC;AAYjD,OAAO,EAIL,eAAe,EAIhB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAGL,WAAW,EACX,cAAc,EAKd,gBAAgB,EACjB,MAAM,SAAS,CAAC;AAIjB,wBAAgB,WAAW,CAAC,MAAM,EAAE,eAAe,sDAM9C,WAAW,KAAG,QAAQ,eAAe,CAAC,CA6C1C;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,eAAe,2CAIjD,cAAc,kCAiFlB"}