@shopify/shopify-api 5.0.0 → 5.1.0

package/CHANGELOG.md

@@ -7,6 +7,17 @@ and adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
 
+## [5.1.0] - 2022-09-19
+
+- Increased tolerance for expired JWT session tokens from 5s to 10s [#462](https://github.com/Shopify/shopify-api-node/pull/462)
+- Add support for billing to the library [#449](https://github.com/Shopify/shopify-api-node/pull/449)
+- Allow dynamically typing the body of REST and GraphQL request responses, so callers don't need to cast it [#447](https://github.com/Shopify/shopify-api-node/pull/447)
+- Rather than create a temporary session in order to store a session id in a cookie for the OAuth transaction, we can store the `state` in the cookie instead, that can then be compared against the `state` provided by Shopify in the callback. [#438](https://github.com/Shopify/shopify-api-node/pull/438)
+
+## [5.0.1] - 2022-08-03
+
+- Make `sanitizeHost` validation more flexible [#446](https://github.com/Shopify/shopify-api-node/pull/446)
+
 ## [5.0.0] - 2022-07-28
 
 - ⚠️ [Breaking] If a response from a GraphQL query contains an `errors` attribute, `GraphqlClient` will now throw a `GraphqlQueryError`. The caller can check the `error.response` attribute to see what was returned from the GraphQL API. [#431](https://github.com/Shopify/shopify-api-node/pull/431)

package/README.md

@@ -51,5 +51,6 @@ You can follow our [getting started guide](docs/), which will provide instructio
 - [Webhooks](docs/usage/webhooks.md)
   - [Register a Webhook](docs/usage/webhooks.md#register-a-webhook)
   - [Process a Webhook](docs/usage/webhooks.md#process-a-webhook)
+- [Billing](docs/usage/billing.md)
 - [Known issues and caveats](docs/issues.md)
   - [Notes on session handling](docs/issues.md#notes-on-session-handling)

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

@@ -3,6 +3,7 @@ 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.
      *
@@ -24,6 +25,7 @@ declare const ShopifyOAuth: {
      * @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>;

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;;IAGhB;;;;;;;;;;OAUG;uBAEQ,KAAK,eAAe,YACnB,KAAK,cAAc,QACvB,MAAM,gBACE,MAAM,uBAEnB,QAAQ,MAAM,CAAC;IAiDlB;;;;;;;;;;OAUG;kCAEQ,KAAK,eAAe,YACnB,KAAK,cAAc,SACtB,SAAS,GACf,QAAQ,gBAAgB,CAAC;IAuG5B;;;;;OAKG;gCAEQ,KAAK,eAAe,YACnB,KAAK,cAAc,GAC5B,MAAM,GAAG,SAAS;IAQrB;;;;;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;CAiCtB,CAAC;AAcF,OAAO,EAAC,YAAY,EAAC,CAAC"}
+{"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"}

package/dist/auth/oauth/oauth.js

@@ -17,6 +17,7 @@ var ShopifyErrors = tslib_1.__importStar(require("../../error"));
 var shop_validator_1 = require("../../utils/shop-validator");
 var ShopifyOAuth = {
     SESSION_COOKIE_NAME: 'shopify_app_session',
+    STATE_COOKIE_NAME: 'shopify_app_state',
     /**
      * Initializes a session and cookie for the OAuth process, and returns the necessary authorization url.
      *
@@ -31,41 +32,31 @@ var ShopifyOAuth = {
     beginAuth: function (request, response, shop, redirectPath, isOnline) {
         if (isOnline === void 0) { isOnline = true; }
         return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var cleanShop, cookies, state, session, sessionStored, query, queryString;
+            var cleanShop, cookies, state, query, queryString;
             return tslib_1.__generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        context_1.Context.throwIfUninitialized();
-                        context_1.Context.throwIfPrivateApp('Cannot perform OAuth for private apps');
-                        cleanShop = (0, shop_validator_1.sanitizeShop)(shop, true);
-                        cookies = new cookies_1.default(request, response, {
-                            keys: [context_1.Context.API_SECRET_KEY],
-                            secure: true,
-                        });
-                        state = (0, nonce_1.default)();
-                        session = new session_1.Session(isOnline ? (0, uuid_1.v4)() : this.getOfflineSessionId(cleanShop), cleanShop, state, isOnline);
-                        return [4 /*yield*/, context_1.Context.SESSION_STORAGE.storeSession(session)];
-                    case 1:
-                        sessionStored = _a.sent();
-                        if (!sessionStored) {
-                            throw new ShopifyErrors.SessionStorageError('OAuth Session could not be saved. Please check your session storage functionality.');
-                        }
-                        cookies.set(ShopifyOAuth.SESSION_COOKIE_NAME, session.id, {
-                            signed: true,
-                            expires: new Date(Date.now() + 60000),
-                            sameSite: 'lax',
-                            secure: true,
-                        });
-                        query = {
-                            client_id: context_1.Context.API_KEY,
-                            scope: context_1.Context.SCOPES.toString(),
-                            redirect_uri: "".concat(context_1.Context.HOST_SCHEME, "://").concat(context_1.Context.HOST_NAME).concat(redirectPath),
-                            state: state,
-                            'grant_options[]': isOnline ? 'per-user' : '',
-                        };
-                        queryString = querystring_1.default.stringify(query);
-                        return [2 /*return*/, "https://".concat(cleanShop, "/admin/oauth/authorize?").concat(queryString)];
-                }
+                context_1.Context.throwIfUninitialized();
+                context_1.Context.throwIfPrivateApp('Cannot perform OAuth for private apps');
+                cleanShop = (0, shop_validator_1.sanitizeShop)(shop, true);
+                cookies = new cookies_1.default(request, response, {
+                    keys: [context_1.Context.API_SECRET_KEY],
+                    secure: true,
+                });
+                state = isOnline ? "online_".concat((0, nonce_1.default)()) : "offline_".concat((0, nonce_1.default)());
+                cookies.set(ShopifyOAuth.STATE_COOKIE_NAME, state, {
+                    signed: true,
+                    expires: new Date(Date.now() + 60000),
+                    sameSite: 'lax',
+                    secure: true,
+                });
+                query = {
+                    client_id: context_1.Context.API_KEY,
+                    scope: context_1.Context.SCOPES.toString(),
+                    redirect_uri: "".concat(context_1.Context.HOST_SCHEME, "://").concat(context_1.Context.HOST_NAME).concat(redirectPath),
+                    state: state,
+                    'grant_options[]': isOnline ? 'per-user' : '',
+                };
+                queryString = querystring_1.default.stringify(query);
+                return [2 /*return*/, "https://".concat(cleanShop, "/admin/oauth/authorize?").concat(queryString)];
             });
         });
     },
@@ -78,33 +69,26 @@ var ShopifyOAuth = {
      * @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: function (request, response, query) {
         return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var cookies, sessionCookie, currentSession, body, postParams, client, postResponse, responseBody, access_token, scope, rest, sessionExpiration, onlineInfo, jwtSessionId, jwtSession, sessionDeleted, responseBody, sessionStored;
+            var stateFromCookie, isOnline, body, postParams, cleanShop, client, postResponse, session, cookies, sessionStored;
             return tslib_1.__generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
                         context_1.Context.throwIfUninitialized();
                         context_1.Context.throwIfPrivateApp('Cannot perform OAuth for private apps');
-                        cookies = new cookies_1.default(request, response, {
-                            keys: [context_1.Context.API_SECRET_KEY],
-                            secure: true,
-                        });
-                        sessionCookie = this.getCookieSessionId(request, response);
-                        if (!sessionCookie) {
+                        stateFromCookie = getValueFromCookie(request, response, this.STATE_COOKIE_NAME);
+                        deleteCookie(request, response, this.STATE_COOKIE_NAME);
+                        if (!stateFromCookie) {
                             throw new ShopifyErrors.CookieNotFound("Cannot complete OAuth process. Could not find an OAuth cookie for shop url: ".concat(query.shop));
                         }
-                        return [4 /*yield*/, context_1.Context.SESSION_STORAGE.loadSession(sessionCookie)];
-                    case 1:
-                        currentSession = _a.sent();
-                        if (!currentSession) {
-                            throw new ShopifyErrors.SessionNotFound("Cannot complete OAuth process. No session found for the specified shop url: ".concat(query.shop));
-                        }
-                        if (!validQuery(query, currentSession)) {
+                        if (!validQuery(query, stateFromCookie)) {
                             throw new ShopifyErrors.InvalidOAuthError('Invalid OAuth callback.');
                         }
+                        isOnline = stateFromCookie.startsWith('online_');
                         body = {
                             client_id: context_1.Context.API_KEY,
                             client_secret: context_1.Context.API_SECRET_KEY,
@@ -115,50 +99,31 @@ var ShopifyOAuth = {
                             type: types_1.DataType.JSON,
                             data: body,
                         };
-                        client = new http_client_1.HttpClient(currentSession.shop);
+                        cleanShop = (0, shop_validator_1.sanitizeShop)(query.shop, true);
+                        client = new http_client_1.HttpClient(cleanShop);
                         return [4 /*yield*/, client.post(postParams)];
-                    case 2:
+                    case 1:
                         postResponse = _a.sent();
-                        if (!currentSession.isOnline) return [3 /*break*/, 5];
-                        responseBody = postResponse.body;
-                        access_token = responseBody.access_token, scope = responseBody.scope, rest = tslib_1.__rest(responseBody, ["access_token", "scope"]);
-                        sessionExpiration = new Date(Date.now() + responseBody.expires_in * 1000);
-                        currentSession.accessToken = access_token;
-                        currentSession.expires = sessionExpiration;
-                        currentSession.scope = scope;
-                        currentSession.onlineAccessInfo = rest;
-                        if (!context_1.Context.IS_EMBEDDED_APP) return [3 /*break*/, 4];
-                        onlineInfo = currentSession.onlineAccessInfo;
-                        jwtSessionId = this.getJwtSessionId(currentSession.shop, "".concat(onlineInfo.associated_user.id));
-                        jwtSession = session_1.Session.cloneSession(currentSession, jwtSessionId);
-                        return [4 /*yield*/, context_1.Context.SESSION_STORAGE.deleteSession(currentSession.id)];
-                    case 3:
-                        sessionDeleted = _a.sent();
-                        if (!sessionDeleted) {
-                            throw new ShopifyErrors.SessionStorageError('OAuth Session could not be deleted. Please check your session storage functionality.');
+                        session = createSession(postResponse, cleanShop, stateFromCookie, isOnline);
+                        if (!context_1.Context.IS_EMBEDDED_APP) {
+                            cookies = new cookies_1.default(request, response, {
+                                keys: [context_1.Context.API_SECRET_KEY],
+                                secure: true,
+                            });
+                            cookies.set(ShopifyOAuth.SESSION_COOKIE_NAME, session.id, {
+                                signed: true,
+                                expires: session.expires,
+                                sameSite: 'lax',
+                                secure: true,
+                            });
                         }
-                        currentSession = jwtSession;
-                        _a.label = 4;
-                    case 4: return [3 /*break*/, 6];
-                    case 5:
-                        responseBody = postResponse.body;
-                        currentSession.accessToken = responseBody.access_token;
-                        currentSession.scope = responseBody.scope;
-                        _a.label = 6;
-                    case 6:
-                        cookies.set(ShopifyOAuth.SESSION_COOKIE_NAME, currentSession.id, {
-                            signed: true,
-                            expires: context_1.Context.IS_EMBEDDED_APP ? new Date() : currentSession.expires,
-                            sameSite: 'lax',
-                            secure: true,
-                        });
-                        return [4 /*yield*/, context_1.Context.SESSION_STORAGE.storeSession(currentSession)];
-                    case 7:
+                        return [4 /*yield*/, context_1.Context.SESSION_STORAGE.storeSession(session)];
+                    case 2:
                         sessionStored = _a.sent();
                         if (!sessionStored) {
-                            throw new ShopifyErrors.SessionStorageError('OAuth Session could not be saved. Please check your session storage functionality.');
+                            throw new ShopifyErrors.SessionStorageError('Session could not be saved. Please check your session storage functionality.');
                         }
-                        return [2 /*return*/, currentSession];
+                        return [2 /*return*/, session];
                 }
             });
         });
@@ -170,11 +135,7 @@ var ShopifyOAuth = {
      * @param response HTTP response object
      */
     getCookieSessionId: function (request, response) {
-        var cookies = new cookies_1.default(request, response, {
-            secure: true,
-            keys: [context_1.Context.API_SECRET_KEY],
-        });
-        return cookies.get(this.SESSION_COOKIE_NAME, { signed: true });
+        return getValueFromCookie(request, response, this.SESSION_COOKIE_NAME);
     },
     /**
      * Builds a JWT session id from the current shop and user.
@@ -225,7 +186,7 @@ var ShopifyOAuth = {
         // JWT.
         if (!currentSessionId) {
             // We still want to get the offline session id from the cookie to make sure it's validated
-            currentSessionId = this.getCookieSessionId(request, response);
+            currentSessionId = getValueFromCookie(request, response, this.SESSION_COOKIE_NAME);
         }
         return currentSessionId;
     },
@@ -235,8 +196,72 @@ exports.ShopifyOAuth = ShopifyOAuth;
  * Uses the validation utils validateHmac, and safeCompare to assess whether the callback is valid.
  *
  * @param query Current HTTP Request Query
- * @param session Current session
+ * @param stateFromCookie state value from the current cookie
  */
-function validQuery(query, session) {
-    return ((0, hmac_validator_1.default)(query) && (0, safe_compare_1.default)(query.state, session.state));
+function validQuery(query, stateFromCookie) {
+    return (0, hmac_validator_1.default)(query) && (0, safe_compare_1.default)(query.state, stateFromCookie);
+}
+/**
+ * Loads a given value from the cookie
+ *
+ * @param request HTTP request object
+ * @param response HTTP response object
+ * @param name Name of the cookie to load
+ */
+function getValueFromCookie(request, response, name) {
+    var cookies = new cookies_1.default(request, response, {
+        secure: true,
+        keys: [context_1.Context.API_SECRET_KEY],
+    });
+    return cookies.get(name, { signed: true });
+}
+/**
+ * Loads a given value from the cookie
+ *
+ * @param request HTTP request object
+ * @param response HTTP response object
+ * @param name Name of the cookie to load
+ */
+function deleteCookie(request, response, name) {
+    var cookies = new cookies_1.default(request, response, {
+        secure: true,
+        keys: [context_1.Context.API_SECRET_KEY],
+    });
+    cookies.set(name);
+}
+/**
+ * Creates a new session from the response from the access token request.
+ *
+ * @param postResponse Response from the access token request
+ * @param shop Shop url: {shop}.myshopify.com
+ * @param stateFromCookie State from the cookie received by the OAuth callback
+ * @param isOnline Boolean indicating if the access token is for online access
+ * @returns SessionInterface
+ */
+function createSession(postResponse, shop, stateFromCookie, isOnline) {
+    var session;
+    if (isOnline) {
+        var sessionId = void 0;
+        var responseBody = postResponse.body;
+        var access_token = responseBody.access_token, scope = responseBody.scope, rest = tslib_1.__rest(responseBody, ["access_token", "scope"]); // eslint-disable-line @typescript-eslint/naming-convention
+        var sessionExpiration = new Date(Date.now() + responseBody.expires_in * 1000);
+        if (context_1.Context.IS_EMBEDDED_APP) {
+            sessionId = ShopifyOAuth.getJwtSessionId(shop, "".concat(rest.associated_user.id));
+        }
+        else {
+            sessionId = (0, uuid_1.v4)();
+        }
+        session = new session_1.Session(sessionId, shop, stateFromCookie, isOnline);
+        session.accessToken = access_token;
+        session.scope = scope;
+        session.expires = sessionExpiration;
+        session.onlineAccessInfo = rest;
+    }
+    else {
+        var responseBody = postResponse.body;
+        session = new session_1.Session(ShopifyOAuth.getOfflineSessionId(shop), shop, stateFromCookie, isOnline);
+        session.accessToken = responseBody.access_token;
+        session.scope = responseBody.scope;
+    }
+    return session;
 }

package/dist/auth/session/storage/redis.d.ts

@@ -3,6 +3,7 @@ import { SessionInterface } from '../types';
 import { SessionStorage } from '../session_storage';
 export interface RedisSessionStorageOptions extends RedisClientOptions {
     sessionKeyPrefix: string;
+    onError?: (...args: any[]) => void;
 }
 export declare class RedisSessionStorage implements SessionStorage {
     private dbUrl;

package/dist/auth/session/storage/redis.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"redis.d.ts","sourceRoot":"","sources":["../../../../src/auth/session/storage/redis.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgC,kBAAkB,EAAC,MAAM,OAAO,CAAC;AAExE,OAAO,EAAC,gBAAgB,EAAC,MAAM,UAAU,CAAC;AAC1C,OAAO,EAAC,cAAc,EAAC,MAAM,oBAAoB,CAAC;AAIlD,MAAM,WAAW,0BAA2B,SAAQ,kBAAkB;IACpE,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAKD,qBAAa,mBAAoB,YAAW,cAAc;IAuBtD,OAAO,CAAC,KAAK;IAtBf,MAAM,CAAC,eAAe,CACpB,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,OAAO,CAAC,0BAA0B,CAAC;IAY3C,SAAgB,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACrC,OAAO,CAAC,OAAO,CAA6B;IAC5C,OAAO,CAAC,MAAM,CAAkB;gBAGtB,KAAK,EAAE,GAAG,EAClB,IAAI,GAAE,OAAO,CAAC,0BAA0B,CAAM;IASnC,YAAY,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC;IAUzD,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAW9D,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAM3C,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAM/C,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAiB7D,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAIxC,OAAO,CAAC,OAAO;YAID,IAAI;CAOnB"}
+{"version":3,"file":"redis.d.ts","sourceRoot":"","sources":["../../../../src/auth/session/storage/redis.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,kBAAkB,EAAC,MAAM,OAAO,CAAC;AAEvD,OAAO,EAAC,gBAAgB,EAAC,MAAM,UAAU,CAAC;AAC1C,OAAO,EAAC,cAAc,EAAC,MAAM,oBAAoB,CAAC;AAKlD,MAAM,WAAW,0BAA2B,SAAQ,kBAAkB;IACpE,gBAAgB,EAAE,MAAM,CAAC;IACzB,OAAO,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;CACpC;AAKD,qBAAa,mBAAoB,YAAW,cAAc;IAuBtD,OAAO,CAAC,KAAK;IAtBf,MAAM,CAAC,eAAe,CACpB,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,OAAO,CAAC,0BAA0B,CAAC;IAY3C,SAAgB,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACrC,OAAO,CAAC,OAAO,CAA6B;IAC5C,OAAO,CAAC,MAAM,CAAc;gBAGlB,KAAK,EAAE,GAAG,EAClB,IAAI,GAAE,OAAO,CAAC,0BAA0B,CAAM;IASnC,YAAY,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC;IAUzD,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAW9D,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAM3C,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAM/C,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAiB7D,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAIxC,OAAO,CAAC,OAAO;YAID,IAAI;CAUnB"}

package/dist/auth/session/storage/redis.js

@@ -157,6 +157,9 @@ var RedisSessionStorage = /** @class */ (function () {
                 switch (_a.label) {
                     case 0:
                         this.client = (0, redis_1.createClient)(tslib_1.__assign(tslib_1.__assign({}, this.options), { url: this.dbUrl.toString() }));
+                        if (this.options.onError) {
+                            this.client.on('error', this.options.onError);
+                        }
                         return [4 /*yield*/, this.client.connect()];
                     case 1:
                         _a.sent();

package/dist/base-types.d.ts

@@ -1,5 +1,6 @@
 import { AuthScopes } from './auth/scopes';
 import { SessionStorage } from './auth/session/session_storage';
+import { BillingSettings } from './billing/types';
 export interface ContextParams {
     API_KEY: string;
     API_SECRET_KEY: string;
@@ -14,6 +15,7 @@ export interface ContextParams {
     USER_AGENT_PREFIX?: string;
     PRIVATE_APP_STOREFRONT_ACCESS_TOKEN?: string;
     CUSTOM_SHOP_DOMAINS?: (RegExp | string)[];
+    BILLING?: BillingSettings;
 }
 export declare enum ApiVersion {
     October21 = "2021-10",

package/dist/base-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base-types.d.ts","sourceRoot":"","sources":["../src/base-types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,eAAe,CAAC;AACzC,OAAO,EAAC,cAAc,EAAC,MAAM,gCAAgC,CAAC;AAE9D,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,UAAU,CAAC;IACxB,eAAe,EAAE,OAAO,CAAC;IACzB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,eAAe,CAAC,EAAE,cAAc,CAAC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,mCAAmC,CAAC,EAAE,MAAM,CAAC;IAC7C,mBAAmB,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;CAC3C;AAED,oBAAY,UAAU;IACpB,SAAS,YAAY;IACrB,SAAS,YAAY;IACrB,OAAO,YAAY;IACnB,MAAM,YAAY;IAClB,QAAQ,aAAa;CACtB;AAED,eAAO,MAAM,kBAAkB,oBAAoB,CAAC;AAEpD,oBAAY,aAAa;IACvB,WAAW,2BAA2B;IACtC,qBAAqB,sCAAsC;IAC3D,IAAI,0BAA0B;IAC9B,KAAK,oBAAoB;IACzB,MAAM,0BAA0B;CACjC"}
+{"version":3,"file":"base-types.d.ts","sourceRoot":"","sources":["../src/base-types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,eAAe,CAAC;AACzC,OAAO,EAAC,cAAc,EAAC,MAAM,gCAAgC,CAAC;AAC9D,OAAO,EAAC,eAAe,EAAC,MAAM,iBAAiB,CAAC;AAEhD,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,UAAU,CAAC;IACxB,eAAe,EAAE,OAAO,CAAC;IACzB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,eAAe,CAAC,EAAE,cAAc,CAAC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,mCAAmC,CAAC,EAAE,MAAM,CAAC;IAC7C,mBAAmB,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAC1C,OAAO,CAAC,EAAE,eAAe,CAAC;CAC3B;AAED,oBAAY,UAAU;IACpB,SAAS,YAAY;IACrB,SAAS,YAAY;IACrB,OAAO,YAAY;IACnB,MAAM,YAAY;IAClB,QAAQ,aAAa;CACtB;AAED,eAAO,MAAM,kBAAkB,oBAAoB,CAAC;AAEpD,oBAAY,aAAa;IACvB,WAAW,2BAA2B;IACtC,qBAAqB,sCAAsC;IAC3D,IAAI,0BAA0B;IAC9B,KAAK,oBAAoB;IACzB,MAAM,0BAA0B;CACjC"}

package/dist/billing/check.d.ts

@@ -0,0 +1,12 @@
+import { SessionInterface } from '../auth/session/types';
+interface CheckInterface {
+    session: SessionInterface;
+    isTest?: boolean;
+}
+interface CheckReturn {
+    hasPayment: boolean;
+    confirmBillingUrl?: string;
+}
+export declare function check({ session, isTest, }: CheckInterface): Promise<CheckReturn>;
+export {};
+//# sourceMappingURL=check.d.ts.map

package/dist/billing/check.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"check.d.ts","sourceRoot":"","sources":["../../src/billing/check.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,gBAAgB,EAAC,MAAM,uBAAuB,CAAC;AAKvD,UAAU,cAAc;IACtB,OAAO,EAAE,gBAAgB,CAAC;IAC1B,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,UAAU,WAAW;IACnB,UAAU,EAAE,OAAO,CAAC;IACpB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,wBAAsB,KAAK,CAAC,EAC1B,OAAO,EACP,MAAa,GACd,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC,CAgBvC"}

package/dist/billing/check.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.check = void 0;
+var tslib_1 = require("tslib");
+var context_1 = require("../context");
+var has_active_payment_1 = require("./has_active_payment");
+var request_payment_1 = require("./request_payment");
+function check(_a) {
+    var session = _a.session, _b = _a.isTest, isTest = _b === void 0 ? true : _b;
+    return tslib_1.__awaiter(this, void 0, void 0, function () {
+        var hasPayment, confirmBillingUrl;
+        return tslib_1.__generator(this, function (_c) {
+            switch (_c.label) {
+                case 0:
+                    if (!context_1.Context.BILLING) {
+                        return [2 /*return*/, { hasPayment: true, confirmBillingUrl: undefined }];
+                    }
+                    return [4 /*yield*/, (0, has_active_payment_1.hasActivePayment)(session, isTest)];
+                case 1:
+                    if (!_c.sent()) return [3 /*break*/, 2];
+                    hasPayment = true;
+                    return [3 /*break*/, 4];
+                case 2:
+                    hasPayment = false;
+                    return [4 /*yield*/, (0, request_payment_1.requestPayment)(session, isTest)];
+                case 3:
+                    confirmBillingUrl = _c.sent();
+                    _c.label = 4;
+                case 4: return [2 /*return*/, { hasPayment: hasPayment, confirmBillingUrl: confirmBillingUrl }];
+            }
+        });
+    });
+}
+exports.check = check;

package/dist/billing/has_active_payment.d.ts

@@ -0,0 +1,3 @@
+import { SessionInterface } from '../auth/session/types';
+export declare function hasActivePayment(session: SessionInterface, isTest: boolean): Promise<boolean>;
+//# sourceMappingURL=has_active_payment.d.ts.map

package/dist/billing/has_active_payment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"has_active_payment.d.ts","sourceRoot":"","sources":["../../src/billing/has_active_payment.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,gBAAgB,EAAC,MAAM,uBAAuB,CAAC;AASvD,wBAAsB,gBAAgB,CACpC,OAAO,EAAE,gBAAgB,EACzB,MAAM,EAAE,OAAO,GACd,OAAO,CAAC,OAAO,CAAC,CAMlB"}

package/dist/billing/has_active_payment.js

@@ -0,0 +1,91 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasActivePayment = void 0;
+var tslib_1 = require("tslib");
+var context_1 = require("../context");
+var error_1 = require("../error");
+var graphql_1 = require("../clients/graphql");
+var is_recurring_1 = require("./is_recurring");
+function hasActivePayment(session, isTest) {
+    return tslib_1.__awaiter(this, void 0, void 0, function () {
+        return tslib_1.__generator(this, function (_a) {
+            if ((0, is_recurring_1.isRecurring)()) {
+                return [2 /*return*/, hasActiveSubscription(session, isTest)];
+            }
+            else {
+                return [2 /*return*/, hasActiveOneTimePurchase(session, isTest)];
+            }
+            return [2 /*return*/];
+        });
+    });
+}
+exports.hasActivePayment = hasActivePayment;
+function hasActiveSubscription(session, isTest) {
+    return tslib_1.__awaiter(this, void 0, void 0, function () {
+        var client, currentInstallations;
+        return tslib_1.__generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    if (!context_1.Context.BILLING) {
+                        throw new error_1.BillingError({
+                            message: 'Attempted to look for subscriptions without billing configs',
+                            errorData: [],
+                        });
+                    }
+                    client = new graphql_1.GraphqlClient(session.shop, session.accessToken);
+                    return [4 /*yield*/, client.query({
+                            data: RECURRING_PURCHASES_QUERY,
+                        })];
+                case 1:
+                    currentInstallations = _a.sent();
+                    return [2 /*return*/, currentInstallations.body.data.currentAppInstallation.activeSubscriptions.some(function (subscription) {
+                            return subscription.name === context_1.Context.BILLING.chargeName &&
+                                (isTest || !subscription.test);
+                        })];
+            }
+        });
+    });
+}
+function hasActiveOneTimePurchase(session, isTest) {
+    return tslib_1.__awaiter(this, void 0, void 0, function () {
+        var client, installation, endCursor, currentInstallations;
+        return tslib_1.__generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    if (!context_1.Context.BILLING) {
+                        throw new error_1.BillingError({
+                            message: 'Attempted to look for one time purchases without billing configs',
+                            errorData: [],
+                        });
+                    }
+                    client = new graphql_1.GraphqlClient(session.shop, session.accessToken);
+                    endCursor = null;
+                    _a.label = 1;
+                case 1: return [4 /*yield*/, client.query({
+                        data: {
+                            query: ONE_TIME_PURCHASES_QUERY,
+                            variables: { endCursor: endCursor },
+                        },
+                    })];
+                case 2:
+                    currentInstallations = _a.sent();
+                    installation = currentInstallations.body.data.currentAppInstallation;
+                    if (installation.oneTimePurchases.edges.some(function (purchase) {
+                        return purchase.node.name === context_1.Context.BILLING.chargeName &&
+                            (isTest || !purchase.node.test) &&
+                            purchase.node.status === 'ACTIVE';
+                    })) {
+                        return [2 /*return*/, true];
+                    }
+                    endCursor = installation.oneTimePurchases.pageInfo.endCursor;
+                    _a.label = 3;
+                case 3:
+                    if (installation === null || installation === void 0 ? void 0 : installation.oneTimePurchases.pageInfo.hasNextPage) return [3 /*break*/, 1];
+                    _a.label = 4;
+                case 4: return [2 /*return*/, false];
+            }
+        });
+    });
+}
+var RECURRING_PURCHASES_QUERY = "\n  query appSubscription {\n    currentAppInstallation {\n      activeSubscriptions {\n        name\n        test\n      }\n    }\n  }\n";
+var ONE_TIME_PURCHASES_QUERY = "\n  query appPurchases($endCursor: String) {\n    currentAppInstallation {\n      oneTimePurchases(first: 250, sortKey: CREATED_AT, after: $endCursor) {\n        edges {\n          node {\n            name\n            test\n            status\n          }\n        }\n        pageInfo {\n          hasNextPage\n          endCursor\n        }\n      }\n    }\n  }\n";

package/dist/billing/index.d.ts

@@ -0,0 +1,7 @@
+import { check } from './check';
+declare const ShopifyBilling: {
+    check: typeof check;
+};
+export { ShopifyBilling };
+export default ShopifyBilling;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/billing/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAC,MAAM,SAAS,CAAC;AAE9B,QAAA,MAAM,cAAc;;CAEnB,CAAC;AAEF,OAAO,EAAC,cAAc,EAAC,CAAC;AACxB,eAAe,cAAc,CAAC"}

package/dist/billing/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShopifyBilling = void 0;
+var check_1 = require("./check");
+var ShopifyBilling = {
+    check: check_1.check,
+};
+exports.ShopifyBilling = ShopifyBilling;
+exports.default = ShopifyBilling;

package/dist/billing/is_recurring.d.ts

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

package/dist/billing/is_recurring.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"is_recurring.d.ts","sourceRoot":"","sources":["../../src/billing/is_recurring.ts"],"names":[],"mappings":"AAUA,wBAAgB,WAAW,IAAI,OAAO,CASrC"}

package/dist/billing/is_recurring.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isRecurring = void 0;
+var context_1 = require("../context");
+var error_1 = require("../error");
+var types_1 = require("./types");
+var RECURRING_INTERVALS = [
+    types_1.BillingInterval.Every30Days,
+    types_1.BillingInterval.Annual,
+];
+function isRecurring() {
+    if (!context_1.Context.BILLING) {
+        throw new error_1.BillingError({
+            message: 'Attempted to request billing without billing configs',
+            errorData: [],
+        });
+    }
+    return RECURRING_INTERVALS.includes(context_1.Context.BILLING.interval);
+}
+exports.isRecurring = isRecurring;

package/dist/billing/request_payment.d.ts

@@ -0,0 +1,3 @@
+import { SessionInterface } from '../auth/session/types';
+export declare function requestPayment(session: SessionInterface, isTest: boolean): Promise<string | undefined>;
+//# sourceMappingURL=request_payment.d.ts.map

package/dist/billing/request_payment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request_payment.d.ts","sourceRoot":"","sources":["../../src/billing/request_payment.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,gBAAgB,EAAC,MAAM,uBAAuB,CAAC;AAYvD,wBAAsB,cAAc,CAClC,OAAO,EAAE,gBAAgB,EACzB,MAAM,EAAE,OAAO,GACd,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CA8B7B"}