@shopify/shopify-api 3.1.2 → 3.1.3

package/CHANGELOG.md

@@ -5,7 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [3.1.1] - 2022-06-07
+## [3.1.3] - 2022-06-08
+
+### Fixes
+- Return instances of `Session` from session storages, not POJOs.
+
+## [3.1.2] - 2022-06-07
 
 ### Added
 - Store user id and expiration date of online tokens

package/dist/auth/session/session-utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"session-utils.d.ts","sourceRoot":"","sources":["../../../src/auth/session/session-utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,SAAS,CAAC;AAE9C;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,EAAE,GACnC,gBAAgB,CAgDlB;AAYD,wBAAgB,cAAc,CAC5B,OAAO,EAAE,gBAAgB,GACxB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,EAAE,CAmB7B;AAED,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,gBAAgB,GAAG,SAAS,EACtC,QAAQ,EAAE,gBAAgB,GAAG,SAAS,GACrC,OAAO,CAMT"}
+{"version":3,"file":"session-utils.d.ts","sourceRoot":"","sources":["../../../src/auth/session/session-utils.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,SAAS,CAAC;AAE9C;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,EAAE,GACnC,gBAAgB,CAkDlB;AAYD,wBAAgB,cAAc,CAC5B,OAAO,EAAE,gBAAgB,GACxB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,EAAE,CAsB7B;AAED,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,gBAAgB,GAAG,SAAS,EACtC,QAAQ,EAAE,gBAAgB,GAAG,SAAS,GACrC,OAAO,CAQT"}

package/dist/auth/session/session-utils.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.sessionEqual = exports.sessionEntries = exports.sessionFromEntries = void 0;
 var tslib_1 = require("tslib");
+var session_1 = require("./session");
 /**
  * Like Object.fromEntries(), but normalizes the keys and filters out null values.
  */
@@ -9,7 +10,7 @@ function sessionFromEntries(entries) {
     var obj = Object.fromEntries(entries
         .filter(function (_a) {
         var _b = tslib_1.__read(_a, 2), _key = _b[0], value = _b[1];
-        return value !== null;
+        return value !== null && value !== undefined;
     })
         // Sanitize keys
         .map(function (_a) {
@@ -55,6 +56,7 @@ function sessionFromEntries(entries) {
                 return [key, value];
         }
     }));
+    Object.setPrototypeOf(obj, session_1.Session.prototype);
     return obj;
 }
 exports.sessionFromEntries = sessionFromEntries;
@@ -71,8 +73,8 @@ var includedKeys = [
 function sessionEntries(session) {
     return (Object.entries(session)
         .filter(function (_a) {
-        var _b = tslib_1.__read(_a, 1), key = _b[0];
-        return includedKeys.includes(key);
+        var _b = tslib_1.__read(_a, 2), key = _b[0], value = _b[1];
+        return includedKeys.includes(key) && value !== undefined && value !== null;
     })
         // Prepare values for db storage
         .map(function (_a) {
@@ -97,8 +99,18 @@ function sessionEqual(sessionA, sessionB) {
         return false;
     if (!sessionB)
         return false;
-    var copyA = sessionFromEntries(sessionEntries(sessionA));
-    var copyB = sessionFromEntries(sessionEntries(sessionB));
+    var copyA = sessionEntries(sessionA);
+    copyA.sort(function (_a, _b) {
+        var _c = tslib_1.__read(_a, 1), k1 = _c[0];
+        var _d = tslib_1.__read(_b, 1), k2 = _d[0];
+        return (k1 < k2 ? -1 : 1);
+    });
+    var copyB = sessionEntries(sessionB);
+    copyB.sort(function (_a, _b) {
+        var _c = tslib_1.__read(_a, 1), k1 = _c[0];
+        var _d = tslib_1.__read(_b, 1), k2 = _d[0];
+        return (k1 < k2 ? -1 : 1);
+    });
     return JSON.stringify(copyA) === JSON.stringify(copyB);
 }
 exports.sessionEqual = sessionEqual;

package/dist/auth/session/storage/__tests__/battery-of-tests.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"battery-of-tests.d.ts","sourceRoot":"","sources":["../../../../../src/auth/session/storage/__tests__/battery-of-tests.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,cAAc,EAAC,MAAM,uBAAuB,CAAC;AAErD,wBAAgB,cAAc,CAAC,cAAc,EAAE,MAAM,OAAO,CAAC,cAAc,CAAC,QAqF3E"}
+{"version":3,"file":"battery-of-tests.d.ts","sourceRoot":"","sources":["../../../../../src/auth/session/storage/__tests__/battery-of-tests.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,cAAc,EAAC,MAAM,uBAAuB,CAAC;AAErD,wBAAgB,cAAc,CAAC,cAAc,EAAE,MAAM,OAAO,CAAC,cAAc,CAAC,QA+F3E"}

package/dist/auth/session/storage/__tests__/battery-of-tests.js

@@ -2,22 +2,25 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.batteryOfTests = void 0;
 var tslib_1 = require("tslib");
+var context_1 = require("../../../../context");
 var session_1 = require("../../session");
 var session_utils_1 = require("../../session-utils");
 function batteryOfTests(storageFactory) {
     var _this = this;
     it('can store and delete all kinds of sessions', function () { return tslib_1.__awaiter(_this, void 0, void 0, function () {
-        var sessionFactories, sessionId, storage, sessionFactories_1, sessionFactories_1_1, factory, session, _a, _b, _c, _d, e_1_1;
-        var e_1, _e;
+        var sessionFactories, sessionId, storage, sessionFactories_1, sessionFactories_1_1, factory, session, _a, _b, loadedSession, e_1_1;
+        var e_1, _c;
         var _this = this;
-        return tslib_1.__generator(this, function (_f) {
-            switch (_f.label) {
+        return tslib_1.__generator(this, function (_d) {
+            switch (_d.label) {
                 case 0:
                     sessionFactories = [
                         function () { return tslib_1.__awaiter(_this, void 0, void 0, function () {
                             var session;
                             return tslib_1.__generator(this, function (_a) {
                                 session = new session_1.Session(sessionId, 'shop', 'state', false);
+                                session.scope = context_1.Context.SCOPES.toString();
+                                session.accessToken = '123';
                                 return [2 /*return*/, session];
                             });
                         }); },
@@ -28,6 +31,8 @@ function batteryOfTests(storageFactory) {
                                 expiryDate = new Date();
                                 expiryDate.setMinutes(expiryDate.getMinutes() + 60);
                                 session.expires = expiryDate;
+                                session.accessToken = '123';
+                                session.scope = context_1.Context.SCOPES.toString();
                                 return [2 /*return*/, session];
                             });
                         }); },
@@ -36,6 +41,8 @@ function batteryOfTests(storageFactory) {
                             return tslib_1.__generator(this, function (_a) {
                                 session = new session_1.Session(sessionId, 'shop', 'state', false);
                                 session.expires = null;
+                                session.scope = context_1.Context.SCOPES.toString();
+                                session.accessToken = '123';
                                 return [2 /*return*/, session];
                             });
                         }); },
@@ -44,6 +51,8 @@ function batteryOfTests(storageFactory) {
                             return tslib_1.__generator(this, function (_a) {
                                 session = new session_1.Session(sessionId, 'shop', 'state', false);
                                 session.expires = undefined;
+                                session.scope = context_1.Context.SCOPES.toString();
+                                session.accessToken = '123';
                                 return [2 /*return*/, session];
                             });
                         }); },
@@ -54,6 +63,8 @@ function batteryOfTests(storageFactory) {
                                 // eslint-disable-next-line  @typescript-eslint/naming-convention
                                 session.onlineAccessInfo = { associated_user: {} };
                                 session.onlineAccessInfo.associated_user.id = 123;
+                                session.scope = context_1.Context.SCOPES.toString();
+                                session.accessToken = '123';
                                 return [2 /*return*/, session];
                             });
                         }); },
@@ -61,57 +72,57 @@ function batteryOfTests(storageFactory) {
                     sessionId = 'test_session';
                     return [4 /*yield*/, storageFactory()];
                 case 1:
-                    storage = _f.sent();
-                    _f.label = 2;
+                    storage = _d.sent();
+                    _d.label = 2;
                 case 2:
-                    _f.trys.push([2, 14, 15, 16]);
+                    _d.trys.push([2, 14, 15, 16]);
                     sessionFactories_1 = tslib_1.__values(sessionFactories), sessionFactories_1_1 = sessionFactories_1.next();
-                    _f.label = 3;
+                    _d.label = 3;
                 case 3:
                     if (!!sessionFactories_1_1.done) return [3 /*break*/, 13];
                     factory = sessionFactories_1_1.value;
                     return [4 /*yield*/, factory()];
                 case 4:
-                    session = _f.sent();
+                    session = _d.sent();
                     return [4 /*yield*/, expect(storage.storeSession(session)).resolves.toBe(true)];
                 case 5:
-                    _f.sent();
+                    _d.sent();
                     _a = expect;
                     _b = session_utils_1.sessionEqual;
                     return [4 /*yield*/, storage.loadSession(sessionId)];
                 case 6:
-                    _a.apply(void 0, [_b.apply(void 0, [_f.sent(), session])]).toBe(true);
+                    _a.apply(void 0, [_b.apply(void 0, [_d.sent(), session])]).toBe(true);
                     return [4 /*yield*/, expect(storage.storeSession(session)).resolves.toBe(true)];
                 case 7:
-                    _f.sent();
-                    _c = expect;
-                    _d = session_utils_1.sessionEqual;
+                    _d.sent();
                     return [4 /*yield*/, storage.loadSession(sessionId)];
                 case 8:
-                    _c.apply(void 0, [_d.apply(void 0, [_f.sent(), session])]).toBe(true);
+                    loadedSession = _d.sent();
+                    expect((0, session_utils_1.sessionEqual)(loadedSession, session)).toBe(true);
+                    expect(loadedSession === null || loadedSession === void 0 ? void 0 : loadedSession.isActive()).toBe(true);
                     return [4 /*yield*/, expect(storage.deleteSession(sessionId)).resolves.toBe(true)];
                 case 9:
-                    _f.sent();
+                    _d.sent();
                     return [4 /*yield*/, expect(storage.loadSession(sessionId)).resolves.toBeUndefined()];
                 case 10:
-                    _f.sent();
+                    _d.sent();
                     // Deleting a non-existing session should work
                     return [4 /*yield*/, expect(storage.deleteSession(sessionId)).resolves.toBe(true)];
                 case 11:
                     // Deleting a non-existing session should work
-                    _f.sent();
-                    _f.label = 12;
+                    _d.sent();
+                    _d.label = 12;
                 case 12:
                     sessionFactories_1_1 = sessionFactories_1.next();
                     return [3 /*break*/, 3];
                 case 13: return [3 /*break*/, 16];
                 case 14:
-                    e_1_1 = _f.sent();
+                    e_1_1 = _d.sent();
                     e_1 = { error: e_1_1 };
                     return [3 /*break*/, 16];
                 case 15:
                     try {
-                        if (sessionFactories_1_1 && !sessionFactories_1_1.done && (_e = sessionFactories_1.return)) _e.call(sessionFactories_1);
+                        if (sessionFactories_1_1 && !sessionFactories_1_1.done && (_c = sessionFactories_1.return)) _c.call(sessionFactories_1);
                     }
                     finally { if (e_1) throw e_1.error; }
                     return [7 /*endfinally*/];

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-export declare const SHOPIFY_API_LIBRARY_VERSION = "3.1.1";
+export declare const SHOPIFY_API_LIBRARY_VERSION = "3.1.3";
 //# 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 = '3.1.1';
+exports.SHOPIFY_API_LIBRARY_VERSION = '3.1.3';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shopify/shopify-api",
-  "version": "3.1.2",
+  "version": "3.1.3",
   "description": "Shopify API Library for Node - accelerate development with support for authentication, graphql proxy, webhooks",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",