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

package/adapters/mock/mock_test_requests.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mock_test_requests.js","sourceRoot":"","sources":["mock_test_requests.ts"],"names":[],"mappings":";;;AAea,QAAA,gBAAgB,GAAkB;IAC7C,WAAW,EAAE,EAAE;IACf,YAAY,EAAE,EAAE;IAEhB,aAAa,EAAb,UAAc,QAA4B;QACxC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED,UAAU,EAAV,UAAW,KAAY;QACrB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC;IAED,UAAU,EAAV;QACE,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED,YAAY,EAAZ;QACE,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,KAAK;QACH,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;IACzB,CAAC;CACF,CAAC"}

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

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["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/adapters/node/adapter.js

@@ -0,0 +1,95 @@
+"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;
+//# sourceMappingURL=adapter.js.map

package/adapters/node/adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.js","sourceRoot":"","sources":["adapter.ts"],"names":[],"mappings":";;;;AACA,sDAAwB;AAExB,kEAA+B;AAE/B,uDAAkE;AAClE,2CAO4B;AAO5B,SAAsB,kBAAkB,CACtC,WAA4B;;;;;YAEtB,GAAG,GAAG,WAAW,CAAC,UAAU,CAAC;YACnC,sBAAO;oBACL,OAAO,EAAE,IAAA,0BAAmB,EAAC,qBAAI,GAAG,CAAC,OAAO,CAAQ,CAAC;oBACrD,MAAM,EAAE,MAAA,GAAG,CAAC,MAAM,mCAAI,KAAK;oBAC3B,GAAG,EAAE,GAAG,CAAC,GAAI;iBACd,EAAC;;;CACH;AATD,gDASC;AAED,SAAsB,0BAA0B,CAC9C,QAA4B,EAC5B,WAA4B;;;;;;oBAEtB,GAAG,GAAG,WAAW,CAAC,WAAW,CAAC;yBAEhC,QAAQ,CAAC,OAAO,EAAhB,wBAAgB;oBAClB,qBAAM,wBAAwB,CAAC,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC,EAAA;;oBAA7D,SAA6D,CAAC;;;oBAGhE,IAAI,QAAQ,CAAC,IAAI,EAAE;wBACjB,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;qBAC1B;oBAED,GAAG,CAAC,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC;oBACrC,GAAG,CAAC,aAAa,GAAG,QAAQ,CAAC,UAAU,CAAC;oBAExC,GAAG,CAAC,GAAG,EAAE,CAAC;;;;;CACX;AAlBD,gEAkBC;AAED,SAAsB,wBAAwB,CAC5C,OAAgB,EAChB,WAA4B;;;;YAEtB,GAAG,GAAG,WAAW,CAAC,WAAW,CAAC;YAEpC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,UAAC,EAAe;oBAAf,KAAA,qBAAe,EAAd,MAAM,QAAA,EAAE,KAAK,QAAA;gBAC7C,OAAA,GAAG,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC;YAA5B,CAA4B,CAC7B,CAAC;;;;CACH;AATD,4DASC;AAED,SAAsB,SAAS,CAAC,EAKZ;QAJlB,GAAG,SAAA,EACH,MAAM,YAAA,EACN,eAAY,EAAZ,OAAO,mBAAG,EAAE,KAAA,EACZ,IAAI,UAAA;;;;;wBAES,qBAAM,IAAA,oBAAK,EAAC,GAAG,EAAE,EAAC,MAAM,QAAA,EAAE,OAAO,EAAE,IAAA,kBAAW,EAAC,OAAO,CAAC,EAAE,IAAI,MAAA,EAAC,CAAC,EAAA;;oBAAtE,IAAI,GAAG,SAA+D;oBAC3D,qBAAM,IAAI,CAAC,IAAI,EAAE,EAAA;;oBAA5B,QAAQ,GAAG,SAAiB;oBAClC,sBAAO;4BACL,UAAU,EAAE,IAAI,CAAC,MAAM;4BACvB,UAAU,EAAE,IAAI,CAAC,UAAU;4BAC3B,IAAI,EAAE,QAAQ;4BACd,OAAO,EAAE,IAAA,0BAAmB,EAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;yBACzE,EAAC;;;;CACH;AAdD,8BAcC;AAED,SAAgB,wBAAwB;IACtC,IAAM,MAAM,GAAG,cAAI,CAAC,IAAI,CACtB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAClE,iBAAiB,CAClB,CAAC;IAEF,OAAO,IAAI,6BAAoB,CAAC,MAAM,CAAC,CAAC;AAC1C,CAAC;AAPD,4DAOC;AAED,SAAgB,iBAAiB;IAC/B,OAAO,eAAQ,OAAO,CAAC,OAAO,CAAE,CAAC;AACnC,CAAC;AAFD,8CAEC"}

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

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

package/adapters/node/index.js

@@ -0,0 +1,14 @@
+"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);
+//# sourceMappingURL=index.js.map

package/adapters/node/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;AAAA,0DAA4B;AAE5B,yCAQuB;AAEvB,qCAOmB;AAEnB,IAAA,8BAAoB,EAAC,mBAAS,CAAC,CAAC;AAChC,IAAA,uCAA6B,EAAC,4BAAkB,CAAC,CAAC;AAClD,IAAA,wCAA8B,EAAC,oCAA0B,CAAC,CAAC;AAC3D,IAAA,uCAA6B,EAAC,kCAAwB,CAAC,CAAC;AACxD,IAAA,yCAA+B,EAAC,kCAAwB,CAAC,CAAC;AAC1D,IAAA,kCAAwB,EAAC,2BAAiB,CAAC,CAAC;AAC5C,IAAA,mBAAS,EAAC,gBAAa,CAAC,CAAC"}

package/docs/issues.md

@@ -0,0 +1,25 @@
+# Known issues and caveats
+
+By following this guide, you will have a fully functional Shopify app. However, there are some things you should be aware of before using your new app in a production environment.
+
+## Notes on session handling
+
+Before you start writing your application, please note that the Shopify library stores some information in sessions, like the API access token and the approved scopes.
+
+Browsers are making it increasingly more difficult to use 3rd party cookies (e.g. [Firefox](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/cookies#tracking_protection)), and because embedded apps run in an iframe, their cookies are considered 3rd party cookies. **That means that this library cannot rely on cookies for sessions**, which is what web frameworks typically use for session management.
+
+This library can use your app's data storage to store sessions to work around that issue, using `SessionStorage`.
+Each app may choose a different storage strategy, so the library cannot assume any specific strategy will be available, but [we provide some options](../session-storage/README.md) to help you quickly set up your app.
+
+- By default, Node.js apps will use `SQLiteSessionStorage`, which will enable you to start developing your app by storing sessions using the file-based SQLite package.
+  - It will use a file named `database.sqlite` by default.
+  - It's designed to be a single-process solution and _may_ be sufficient for your production needs depending on your application's design and needs.
+- For runtimes that don't support file-system access, we also provide `MemorySessionStorage`.
+  - This strategy is **purposely** designed to be a single-process, development-only solution. It **will leak** memory in most cases and delete all sessions when your app restarts. You should **never** use it in production apps.
+  - We don't default to this strategy for CloudFlare workers, because it only works if you're running all your endpoints on the same worker, which won't always happen.
+
+The other storage adapters cover a variety of production-grade storage options, but require further setup from the app to provide database access.
+
+If you wish to have an alternative storage solution, you must use a `CustomSessionStorage` solution in your production app- you can reference our [usage example with redis](usage/customsessions.md) to get started.
+
+[Back to guide index](../README.md)