@shopify/shopify-api 5.0.1 → 5.1.0

package/CHANGELOG.md

@@ -7,6 +7,13 @@ 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)

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"}

package/dist/billing/request_payment.js

@@ -0,0 +1,134 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requestPayment = void 0;
+var tslib_1 = require("tslib");
+var graphql_1 = require("../clients/graphql");
+var context_1 = require("../context");
+var error_1 = require("../error");
+var get_embedded_app_url_1 = require("../utils/get-embedded-app-url");
+var is_recurring_1 = require("./is_recurring");
+function requestPayment(session, isTest) {
+    var _a;
+    return tslib_1.__awaiter(this, void 0, void 0, function () {
+        var returnUrl, data, mutationResponse, mutationResponse;
+        return tslib_1.__generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    returnUrl = (0, get_embedded_app_url_1.buildEmbeddedAppUrl)(Buffer.from("".concat(session.shop, "/admin")).toString('base64'));
+                    if (!(0, is_recurring_1.isRecurring)()) return [3 /*break*/, 2];
+                    return [4 /*yield*/, requestRecurringPayment(session, returnUrl, isTest)];
+                case 1:
+                    mutationResponse = _b.sent();
+                    data = mutationResponse.data.appSubscriptionCreate;
+                    return [3 /*break*/, 4];
+                case 2: return [4 /*yield*/, requestSinglePayment(session, returnUrl, isTest)];
+                case 3:
+                    mutationResponse = _b.sent();
+                    data = mutationResponse.data.appPurchaseOneTimeCreate;
+                    _b.label = 4;
+                case 4:
+                    if ((_a = data.userErrors) === null || _a === void 0 ? void 0 : _a.length) {
+                        throw new error_1.BillingError({
+                            message: 'Error while billing the store',
+                            errorData: data.userErrors,
+                        });
+                    }
+                    return [2 /*return*/, data.confirmationUrl];
+            }
+        });
+    });
+}
+exports.requestPayment = requestPayment;
+function requestRecurringPayment(session, returnUrl, isTest) {
+    var _a;
+    return tslib_1.__awaiter(this, void 0, void 0, function () {
+        var client, mutationResponse;
+        return tslib_1.__generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    if (!context_1.Context.BILLING) {
+                        throw new error_1.BillingError({
+                            message: 'Attempted to request recurring payment without billing configs',
+                            errorData: [],
+                        });
+                    }
+                    client = new graphql_1.GraphqlClient(session.shop, session.accessToken);
+                    return [4 /*yield*/, client.query({
+                            data: {
+                                query: RECURRING_PURCHASE_MUTATION,
+                                variables: {
+                                    name: context_1.Context.BILLING.chargeName,
+                                    lineItems: [
+                                        {
+                                            plan: {
+                                                appRecurringPricingDetails: {
+                                                    interval: context_1.Context.BILLING.interval,
+                                                    price: {
+                                                        amount: context_1.Context.BILLING.amount,
+                                                        currencyCode: context_1.Context.BILLING.currencyCode,
+                                                    },
+                                                },
+                                            },
+                                        },
+                                    ],
+                                    returnUrl: returnUrl,
+                                    test: isTest,
+                                },
+                            },
+                        })];
+                case 1:
+                    mutationResponse = _b.sent();
+                    if ((_a = mutationResponse.body.errors) === null || _a === void 0 ? void 0 : _a.length) {
+                        throw new error_1.BillingError({
+                            message: 'Error while billing the store',
+                            errorData: mutationResponse.body.errors,
+                        });
+                    }
+                    return [2 /*return*/, mutationResponse.body];
+            }
+        });
+    });
+}
+function requestSinglePayment(session, returnUrl, isTest) {
+    var _a;
+    return tslib_1.__awaiter(this, void 0, void 0, function () {
+        var client, mutationResponse;
+        return tslib_1.__generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    if (!context_1.Context.BILLING) {
+                        throw new error_1.BillingError({
+                            message: 'Attempted to request single payment without billing configs',
+                            errorData: [],
+                        });
+                    }
+                    client = new graphql_1.GraphqlClient(session.shop, session.accessToken);
+                    return [4 /*yield*/, client.query({
+                            data: {
+                                query: ONE_TIME_PURCHASE_MUTATION,
+                                variables: {
+                                    name: context_1.Context.BILLING.chargeName,
+                                    price: {
+                                        amount: context_1.Context.BILLING.amount,
+                                        currencyCode: context_1.Context.BILLING.currencyCode,
+                                    },
+                                    returnUrl: returnUrl,
+                                    test: isTest,
+                                },
+                            },
+                        })];
+                case 1:
+                    mutationResponse = _b.sent();
+                    if ((_a = mutationResponse.body.errors) === null || _a === void 0 ? void 0 : _a.length) {
+                        throw new error_1.BillingError({
+                            message: 'Error while billing the store',
+                            errorData: mutationResponse.body.errors,
+                        });
+                    }
+                    return [2 /*return*/, mutationResponse.body];
+            }
+        });
+    });
+}
+var RECURRING_PURCHASE_MUTATION = "\n  mutation test(\n    $name: String!\n    $lineItems: [AppSubscriptionLineItemInput!]!\n    $returnUrl: URL!\n    $test: Boolean\n  ) {\n    appSubscriptionCreate(\n      name: $name\n      lineItems: $lineItems\n      returnUrl: $returnUrl\n      test: $test\n    ) {\n      confirmationUrl\n      userErrors {\n        field\n        message\n      }\n    }\n  }\n";
+var ONE_TIME_PURCHASE_MUTATION = "\n  mutation test(\n    $name: String!\n    $price: MoneyInput!\n    $returnUrl: URL!\n    $test: Boolean\n  ) {\n    appPurchaseOneTimeCreate(\n      name: $name\n      price: $price\n      returnUrl: $returnUrl\n      test: $test\n    ) {\n      confirmationUrl\n      userErrors {\n        field\n        message\n      }\n    }\n  }\n";

package/dist/billing/types.d.ts

@@ -0,0 +1,57 @@
+export declare enum BillingInterval {
+    OneTime = "ONE_TIME",
+    Every30Days = "EVERY_30_DAYS",
+    Annual = "ANNUAL"
+}
+export interface BillingSettings {
+    chargeName: string;
+    amount: number;
+    currencyCode: string;
+    interval: BillingInterval;
+}
+export interface ActiveSubscription {
+    name: string;
+    test: boolean;
+}
+export interface ActiveSubscriptions {
+    activeSubscriptions: ActiveSubscription[];
+}
+export interface OneTimePurchase {
+    name: string;
+    test: boolean;
+    status: string;
+}
+export interface OneTimePurchases {
+    oneTimePurchases: {
+        edges: {
+            node: OneTimePurchase;
+        }[];
+        pageInfo: {
+            endCursor: string;
+            hasNextPage: boolean;
+        };
+    };
+}
+export interface CurrentAppInstallations<T> {
+    userErrors: string[];
+    data: {
+        currentAppInstallation: T;
+    };
+}
+export interface RequestResponse {
+    userErrors: string[];
+    confirmationUrl: string;
+}
+export interface RecurringPaymentResponse {
+    data: {
+        appSubscriptionCreate: RequestResponse;
+    };
+    errors?: string[];
+}
+export interface SinglePaymentResponse {
+    data: {
+        appPurchaseOneTimeCreate: RequestResponse;
+    };
+    errors?: string[];
+}
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/billing/types.ts"],"names":[],"mappings":"AAAA,oBAAY,eAAe;IACzB,OAAO,aAAa;IACpB,WAAW,kBAAkB;IAC7B,MAAM,WAAW;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,eAAe,CAAC;CAC3B;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC,mBAAmB,EAAE,kBAAkB,EAAE,CAAC;CAC3C;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,gBAAgB;IAC/B,gBAAgB,EAAE;QAChB,KAAK,EAAE;YACL,IAAI,EAAE,eAAe,CAAC;SACvB,EAAE,CAAC;QACJ,QAAQ,EAAE;YACR,SAAS,EAAE,MAAM,CAAC;YAClB,WAAW,EAAE,OAAO,CAAC;SACtB,CAAC;KACH,CAAC;CACH;AAED,MAAM,WAAW,uBAAuB,CAAC,CAAC;IACxC,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,IAAI,EAAE;QACJ,sBAAsB,EAAE,CAAC,CAAC;KAC3B,CAAC;CACH;AAED,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE;QACJ,qBAAqB,EAAE,eAAe,CAAC;KACxC,CAAC;IACF,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE;QACJ,wBAAwB,EAAE,eAAe,CAAC;KAC3C,CAAC;IACF,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB"}

package/dist/billing/types.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BillingInterval = void 0;
+var BillingInterval;
+(function (BillingInterval) {
+    BillingInterval["OneTime"] = "ONE_TIME";
+    BillingInterval["Every30Days"] = "EVERY_30_DAYS";
+    BillingInterval["Annual"] = "ANNUAL";
+})(BillingInterval = exports.BillingInterval || (exports.BillingInterval = {}));

package/dist/clients/graphql/graphql_client.d.ts

@@ -10,7 +10,7 @@ export declare class GraphqlClient {
     protected baseApiPath: string;
     private readonly client;
     constructor(domain: string, accessToken?: string | undefined);
-    query(params: GraphqlParams): Promise<RequestReturn>;
+    query<T = unknown>(params: GraphqlParams): Promise<RequestReturn<T>>;
     protected getAccessTokenHeader(): AccessTokenHeader;
 }
 //# sourceMappingURL=graphql_client.d.ts.map

package/dist/clients/graphql/graphql_client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"graphql_client.d.ts","sourceRoot":"","sources":["../../../src/clients/graphql/graphql_client.ts"],"names":[],"mappings":"AAGA,OAAO,EAAW,aAAa,EAAC,MAAM,sBAAsB,CAAC;AAG7D,OAAO,EAAC,aAAa,EAAC,MAAM,SAAS,CAAC;AAEtC,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACf;AAED,qBAAa,aAAa;IAKZ,QAAQ,CAAC,MAAM,EAAE,MAAM;IAAE,QAAQ,CAAC,WAAW,CAAC;IAJ1D,SAAS,CAAC,WAAW,SAAgB;IAErC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAa;gBAEf,MAAM,EAAE,MAAM,EAAW,WAAW,CAAC,oBAAQ;IAU5D,KAAK,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;IAgC1D,SAAS,CAAC,oBAAoB,IAAI,iBAAiB;CAQpD"}
+{"version":3,"file":"graphql_client.d.ts","sourceRoot":"","sources":["../../../src/clients/graphql/graphql_client.ts"],"names":[],"mappings":"AAGA,OAAO,EAAW,aAAa,EAAC,MAAM,sBAAsB,CAAC;AAG7D,OAAO,EAAC,aAAa,EAAC,MAAM,SAAS,CAAC;AAEtC,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACf;AAED,qBAAa,aAAa;IAKZ,QAAQ,CAAC,MAAM,EAAE,MAAM;IAAE,QAAQ,CAAC,WAAW,CAAC;IAJ1D,SAAS,CAAC,WAAW,SAAgB;IAErC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAa;gBAEf,MAAM,EAAE,MAAM,EAAW,WAAW,CAAC,oBAAQ;IAU5D,KAAK,CAAC,CAAC,GAAG,OAAO,EAAE,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAgC1E,SAAS,CAAC,oBAAoB,IAAI,iBAAiB;CAQpD"}

package/dist/clients/http_client/http_client.d.ts

@@ -8,20 +8,20 @@ export declare class HttpClient {
     /**
      * Performs a GET request on the given path.
      */
-    get(params: GetRequestParams): Promise<RequestReturn>;
+    get<T = unknown>(params: GetRequestParams): Promise<RequestReturn<T>>;
     /**
      * Performs a POST request on the given path.
      */
-    post(params: PostRequestParams): Promise<RequestReturn>;
+    post<T = unknown>(params: PostRequestParams): Promise<RequestReturn<T>>;
     /**
      * Performs a PUT request on the given path.
      */
-    put(params: PutRequestParams): Promise<RequestReturn>;
+    put<T = unknown>(params: PutRequestParams): Promise<RequestReturn<T>>;
     /**
      * Performs a DELETE request on the given path.
      */
-    delete(params: DeleteRequestParams): Promise<RequestReturn>;
-    protected request(params: RequestParams): Promise<RequestReturn>;
+    delete<T = unknown>(params: DeleteRequestParams): Promise<RequestReturn<T>>;
+    protected request<T = unknown>(params: RequestParams): Promise<RequestReturn<T>>;
     protected getRequestPath(path: string): string;
     private doRequest;
 }

package/dist/clients/http_client/http_client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"http_client.d.ts","sourceRoot":"","sources":["../../../src/clients/http_client/http_client.ts"],"names":[],"mappings":"AAYA,OAAO,EAEL,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,aAAa,EACb,aAAa,EACd,MAAM,SAAS,CAAC;AAQjB,qBAAa,UAAU;IAOF,OAAO,CAAC,MAAM;IALjC,MAAM,CAAC,QAAQ,CAAC,eAAe,QAAQ;IAEvC,MAAM,CAAC,QAAQ,CAAC,uBAAuB,UAAU;IACjD,OAAO,CAAC,mBAAmB,CAA+B;gBAE/B,MAAM,EAAE,MAAM;IAIzC;;OAEG;IACU,GAAG,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,aAAa,CAAC;IAIlE;;OAEG;IACU,IAAI,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,aAAa,CAAC;IAIpE;;OAEG;IACU,GAAG,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,aAAa,CAAC;IAIlE;;OAEG;IACU,MAAM,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,aAAa,CAAC;cAIxD,OAAO,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;IA0GtE,SAAS,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;YAIhC,SAAS;CAqHxB"}
+{"version":3,"file":"http_client.d.ts","sourceRoot":"","sources":["../../../src/clients/http_client/http_client.ts"],"names":[],"mappings":"AAYA,OAAO,EAEL,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,aAAa,EACb,aAAa,EACd,MAAM,SAAS,CAAC;AAQjB,qBAAa,UAAU;IAOF,OAAO,CAAC,MAAM;IALjC,MAAM,CAAC,QAAQ,CAAC,eAAe,QAAQ;IAEvC,MAAM,CAAC,QAAQ,CAAC,uBAAuB,UAAU;IACjD,OAAO,CAAC,mBAAmB,CAA+B;gBAE/B,MAAM,EAAE,MAAM;IAIzC;;OAEG;IACU,GAAG,CAAC,CAAC,GAAG,OAAO,EAAE,MAAM,EAAE,gBAAgB;IAItD;;OAEG;IACU,IAAI,CAAC,CAAC,GAAG,OAAO,EAAE,MAAM,EAAE,iBAAiB;IAIxD;;OAEG;IACU,GAAG,CAAC,CAAC,GAAG,OAAO,EAAE,MAAM,EAAE,gBAAgB;IAItD;;OAEG;IACU,MAAM,CAAC,CAAC,GAAG,OAAO,EAAE,MAAM,EAAE,mBAAmB;cAI5C,OAAO,CAAC,CAAC,GAAG,OAAO,EACjC,MAAM,EAAE,aAAa,GACpB,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IA0G5B,SAAS,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;YAIhC,SAAS;CAqHxB"}

package/dist/clients/http_client/types.d.ts

@@ -34,8 +34,8 @@ export declare type DeleteRequestParams = GetRequestParams;
 export declare type RequestParams = (GetRequestParams | PostRequestParams) & {
     method: Method;
 };
-export interface RequestReturn {
-    body: unknown;
+export interface RequestReturn<T = unknown> {
+    body: T;
     headers: Headers;
 }
 //# sourceMappingURL=types.d.ts.map

package/dist/clients/http_client/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/clients/http_client/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,MAAM,EAAC,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAC,OAAO,EAAC,MAAM,YAAY,CAAC;AAEnC,MAAM,WAAW,YAAY;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CAChC;AAED,oBAAY,QAAQ;IAClB,IAAI,qBAAqB;IACzB,OAAO,wBAAwB;IAC/B,UAAU,sCAAsC;CACjD;AAED,oBAAY,WAAW,GACnB,MAAM,GACN,MAAM,GACN,MAAM,EAAE,GACR,MAAM,EAAE,GACR;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAA;CAAC,CAAC;AAEjC,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,IAAI,CAAC,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,GAAG,MAAM,CAAC;IACzC,KAAK,CAAC,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAA;KAAC,CAAC;IACrC,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,oBAAY,iBAAiB,GAAG,gBAAgB,GAAG;IACjD,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,GAAG,MAAM,CAAC;CACzC,CAAC;AAEF,oBAAY,gBAAgB,GAAG,iBAAiB,CAAC;AAEjD,oBAAY,mBAAmB,GAAG,gBAAgB,CAAC;AAEnD,oBAAY,aAAa,GAAG,CAAC,gBAAgB,GAAG,iBAAiB,CAAC,GAAG;IACnE,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,OAAO,CAAC;CAClB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/clients/http_client/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,MAAM,EAAC,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAC,OAAO,EAAC,MAAM,YAAY,CAAC;AAEnC,MAAM,WAAW,YAAY;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CAChC;AAED,oBAAY,QAAQ;IAClB,IAAI,qBAAqB;IACzB,OAAO,wBAAwB;IAC/B,UAAU,sCAAsC;CACjD;AAED,oBAAY,WAAW,GACnB,MAAM,GACN,MAAM,GACN,MAAM,EAAE,GACR,MAAM,EAAE,GACR;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAA;CAAC,CAAC;AAEjC,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,IAAI,CAAC,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,GAAG,MAAM,CAAC;IACzC,KAAK,CAAC,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAA;KAAC,CAAC;IACrC,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,oBAAY,iBAAiB,GAAG,gBAAgB,GAAG;IACjD,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,GAAG,MAAM,CAAC;CACzC,CAAC;AAEF,oBAAY,gBAAgB,GAAG,iBAAiB,CAAC;AAEjD,oBAAY,mBAAmB,GAAG,gBAAgB,CAAC;AAEnD,oBAAY,aAAa,GAAG,CAAC,gBAAgB,GAAG,iBAAiB,CAAC,GAAG;IACnE,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,OAAO;IACxC,IAAI,EAAE,CAAC,CAAC;IACR,OAAO,EAAE,OAAO,CAAC;CAClB"}

package/dist/clients/rest/rest_client.d.ts

@@ -6,7 +6,7 @@ declare class RestClient extends HttpClient {
     private static LINK_HEADER_REGEXP;
     private static DEFAULT_LIMIT;
     constructor(domain: string, accessToken?: string | undefined);
-    protected request(params: RequestParams): Promise<RestRequestReturn>;
+    protected request<T = unknown>(params: RequestParams): Promise<RestRequestReturn<T>>;
     protected getRequestPath(path: string): string;
     private buildRequestParams;
 }

package/dist/clients/rest/rest_client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rest_client.d.ts","sourceRoot":"","sources":["../../../src/clients/rest/rest_client.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,UAAU,EAAC,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAC,aAAa,EAAmB,MAAM,sBAAsB,CAAC;AAGrE,OAAO,EAAC,iBAAiB,EAAW,MAAM,SAAS,CAAC;AAEpD,cAAM,UAAW,SAAQ,UAAU;IAIE,QAAQ,CAAC,WAAW,CAAC;IAHxD,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAA8B;IAC/D,OAAO,CAAC,MAAM,CAAC,aAAa,CAAQ;gBAEjB,MAAM,EAAE,MAAM,EAAW,WAAW,CAAC,oBAAQ;cAUhD,OAAO,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAyD1E,SAAS,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAY9C,OAAO,CAAC,kBAAkB;CAa3B;AAED,OAAO,EAAC,UAAU,EAAC,CAAC"}
+{"version":3,"file":"rest_client.d.ts","sourceRoot":"","sources":["../../../src/clients/rest/rest_client.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,UAAU,EAAC,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAC,aAAa,EAAmB,MAAM,sBAAsB,CAAC;AAGrE,OAAO,EAAC,iBAAiB,EAAW,MAAM,SAAS,CAAC;AAEpD,cAAM,UAAW,SAAQ,UAAU;IAIE,QAAQ,CAAC,WAAW,CAAC;IAHxD,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAA8B;IAC/D,OAAO,CAAC,MAAM,CAAC,aAAa,CAAQ;gBAEjB,MAAM,EAAE,MAAM,EAAW,WAAW,CAAC,oBAAQ;cAUhD,OAAO,CAAC,CAAC,GAAG,OAAO,EACjC,MAAM,EAAE,aAAa,GACpB,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAyDhC,SAAS,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAY9C,OAAO,CAAC,kBAAkB;CAa3B;AAED,OAAO,EAAC,UAAU,EAAC,CAAC"}

package/dist/clients/rest/rest_client.js

@@ -30,7 +30,7 @@ var RestClient = /** @class */ (function (_super) {
                             : this.accessToken, _c), params.extraHeaders);
                         return [4 /*yield*/, _super.prototype.request.call(this, params)];
                     case 1:
-                        ret = (_e.sent());
+                        ret = _e.sent();
                         link = ret.headers.get('link');
                         if (link !== undefined) {
                             pageInfo = {

package/dist/clients/rest/types.d.ts

@@ -7,7 +7,7 @@ export interface PageInfo {
     prevPage?: GetRequestParams;
     nextPage?: GetRequestParams;
 }
-export declare type RestRequestReturn = RequestReturn & {
+export declare type RestRequestReturn<T = unknown> = RequestReturn<T> & {
     pageInfo?: PageInfo;
 };
 //# sourceMappingURL=types.d.ts.map

package/dist/clients/rest/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/clients/rest/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAE,gBAAgB,EAAC,MAAM,sBAAsB,CAAC;AAErE,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B,QAAQ,CAAC,EAAE,gBAAgB,CAAC;CAC7B;AAED,oBAAY,iBAAiB,GAAG,aAAa,GAAG;IAC9C,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/clients/rest/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAE,gBAAgB,EAAC,MAAM,sBAAsB,CAAC;AAErE,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B,QAAQ,CAAC,EAAE,gBAAgB,CAAC;CAC7B;AAED,oBAAY,iBAAiB,CAAC,CAAC,GAAG,OAAO,IAAI,aAAa,CAAC,CAAC,CAAC,GAAG;IAC9D,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB,CAAC"}

package/dist/context.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,cAAc,EAAC,MAAM,gCAAgC,CAAC;AAE9D,OAAO,EAAa,aAAa,EAAC,MAAM,cAAc,CAAC;AACvD,OAAO,EAAC,UAAU,EAAC,MAAM,eAAe,CAAC;AAEzC,UAAU,gBAAiB,SAAQ,aAAa;IAC9C,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,cAAc,CAAC;IAChC,MAAM,EAAE,UAAU,CAAC;IAEnB;;;;OAIG;IACH,UAAU,CAAC,MAAM,EAAE,aAAa,GAAG,IAAI,CAAC;IAExC;;OAEG;IACH,oBAAoB,IAAI,IAAI,GAAG,KAAK,CAAC;IAErC;;OAEG;IACH,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,GAAG,KAAK,CAAC;CAClD;AAOD,QAAA,MAAM,OAAO,EAAE,gBAyFd,CAAC;AAEF,OAAO,EAAC,OAAO,EAAE,gBAAgB,EAAC,CAAC"}
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,cAAc,EAAC,MAAM,gCAAgC,CAAC;AAE9D,OAAO,EAAa,aAAa,EAAC,MAAM,cAAc,CAAC;AACvD,OAAO,EAAC,UAAU,EAAC,MAAM,eAAe,CAAC;AAEzC,UAAU,gBAAiB,SAAQ,aAAa;IAC9C,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,cAAc,CAAC;IAChC,MAAM,EAAE,UAAU,CAAC;IAEnB;;;;OAIG;IACH,UAAU,CAAC,MAAM,EAAE,aAAa,GAAG,IAAI,CAAC;IAExC;;OAEG;IACH,oBAAoB,IAAI,IAAI,GAAG,KAAK,CAAC;IAErC;;OAEG;IACH,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,GAAG,KAAK,CAAC;CAClD;AAOD,QAAA,MAAM,OAAO,EAAE,gBA6Fd,CAAC;AAEF,OAAO,EAAC,OAAO,EAAE,gBAAgB,EAAC,CAAC"}

package/dist/context.js

@@ -71,6 +71,9 @@ var Context = {
         if (params.CUSTOM_SHOP_DOMAINS) {
             this.CUSTOM_SHOP_DOMAINS = params.CUSTOM_SHOP_DOMAINS;
         }
+        if (params.BILLING) {
+            this.BILLING = params.BILLING;
+        }
     },
     throwIfUninitialized: function () {
         if (!this.API_KEY || this.API_KEY.length === 0) {

package/dist/error.d.ts

@@ -83,5 +83,12 @@ export declare class UnsupportedClientType extends ShopifyError {
 }
 export declare class InvalidRequestError extends ShopifyError {
 }
+export declare class BillingError extends ShopifyError {
+    readonly errorData: any;
+    constructor({ message, errorData }: {
+        message: string;
+        errorData: any;
+    });
+}
 export {};
 //# sourceMappingURL=error.d.ts.map

package/dist/error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA,qBAAa,YAAa,SAAQ,KAAK;gBACzB,GAAG,IAAI,EAAE,GAAG;CAIzB;AAED,qBAAa,gBAAiB,SAAQ,YAAY;CAAG;AACrD,qBAAa,gBAAiB,SAAQ,YAAY;CAAG;AACrD,qBAAa,gBAAiB,SAAQ,YAAY;CAAG;AACrD,qBAAa,eAAgB,SAAQ,YAAY;CAAG;AACpD,qBAAa,oBAAqB,SAAQ,YAAY;CAAG;AAEzD,qBAAa,gBAAiB,SAAQ,YAAY;CAAG;AACrD,qBAAa,yBAA0B,SAAQ,YAAY;CAAG;AAC9D,qBAAa,eAAgB,SAAQ,YAAY;CAAG;AAEpD,qBAAa,gBAAiB,SAAQ,YAAY;CAAG;AACrD,qBAAa,mBAAoB,SAAQ,YAAY;CAAG;AAExD,UAAU,gBAAgB;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,CAAC;IAChC,OAAO,CAAC,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,CAAC;CACpC;AACD,UAAU,uBAAwB,SAAQ,gBAAgB;IACxD,OAAO,EAAE,MAAM,CAAC;CACjB;AACD,qBAAa,iBAAkB,SAAQ,YAAY;IACjD,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;gBAEjB,EACjB,OAAO,EACP,IAAI,EACJ,UAAU,EACV,IAAI,EACJ,OAAO,GACR,EAAE,uBAAuB;CAS3B;AACD,qBAAa,kBAAmB,SAAQ,iBAAiB;CAAG;AAC5D,qBAAa,iBAAkB,SAAQ,kBAAkB;CAAG;AAE5D,UAAU,uBAAwB,SAAQ,gBAAgB;IACxD,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AACD,UAAU,yBAA0B,SAAQ,uBAAuB;IACjE,OAAO,EAAE,MAAM,CAAC;CACjB;AACD,qBAAa,mBAAoB,SAAQ,kBAAkB;IACzD,QAAQ,CAAC,QAAQ,EAAE,uBAAuB,CAAC;gBAExB,EAAC,UAAU,EAAE,GAAG,MAAM,EAAC,EAAE,yBAAyB;CAItE;AAED,qBAAa,iBAAkB,SAAQ,YAAY;CAAG;AACtD,qBAAa,iBAAkB,SAAQ,YAAY;IACjD,QAAQ,CAAC,QAAQ,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,CAAC;gBAEzB,EACjB,OAAO,EACP,QAAQ,GACT,EAAE;QACD,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE;YAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAC,CAAC;KACpC;CAIF;AAED,qBAAa,iBAAkB,SAAQ,YAAY;CAAG;AACtD,qBAAa,eAAgB,SAAQ,YAAY;CAAG;AACpD,qBAAa,cAAe,SAAQ,YAAY;CAAG;AACnD,qBAAa,cAAe,SAAQ,YAAY;CAAG;AAEnD,qBAAa,mBAAoB,SAAQ,YAAY;CAAG;AACxD,qBAAa,mBAAoB,SAAQ,YAAY;CAAG;AAExD,qBAAa,uBAAwB,SAAQ,YAAY;CAAG;AAC5D,qBAAa,qBAAsB,SAAQ,YAAY;CAAG;AAE1D,qBAAa,mBAAoB,SAAQ,YAAY;CAAG"}
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA,qBAAa,YAAa,SAAQ,KAAK;gBACzB,GAAG,IAAI,EAAE,GAAG;CAIzB;AAED,qBAAa,gBAAiB,SAAQ,YAAY;CAAG;AACrD,qBAAa,gBAAiB,SAAQ,YAAY;CAAG;AACrD,qBAAa,gBAAiB,SAAQ,YAAY;CAAG;AACrD,qBAAa,eAAgB,SAAQ,YAAY;CAAG;AACpD,qBAAa,oBAAqB,SAAQ,YAAY;CAAG;AAEzD,qBAAa,gBAAiB,SAAQ,YAAY;CAAG;AACrD,qBAAa,yBAA0B,SAAQ,YAAY;CAAG;AAC9D,qBAAa,eAAgB,SAAQ,YAAY;CAAG;AAEpD,qBAAa,gBAAiB,SAAQ,YAAY;CAAG;AACrD,qBAAa,mBAAoB,SAAQ,YAAY;CAAG;AAExD,UAAU,gBAAgB;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,CAAC;IAChC,OAAO,CAAC,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,CAAC;CACpC;AACD,UAAU,uBAAwB,SAAQ,gBAAgB;IACxD,OAAO,EAAE,MAAM,CAAC;CACjB;AACD,qBAAa,iBAAkB,SAAQ,YAAY;IACjD,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;gBAEjB,EACjB,OAAO,EACP,IAAI,EACJ,UAAU,EACV,IAAI,EACJ,OAAO,GACR,EAAE,uBAAuB;CAS3B;AACD,qBAAa,kBAAmB,SAAQ,iBAAiB;CAAG;AAC5D,qBAAa,iBAAkB,SAAQ,kBAAkB;CAAG;AAE5D,UAAU,uBAAwB,SAAQ,gBAAgB;IACxD,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AACD,UAAU,yBAA0B,SAAQ,uBAAuB;IACjE,OAAO,EAAE,MAAM,CAAC;CACjB;AACD,qBAAa,mBAAoB,SAAQ,kBAAkB;IACzD,QAAQ,CAAC,QAAQ,EAAE,uBAAuB,CAAC;gBAExB,EAAC,UAAU,EAAE,GAAG,MAAM,EAAC,EAAE,yBAAyB;CAItE;AAED,qBAAa,iBAAkB,SAAQ,YAAY;CAAG;AACtD,qBAAa,iBAAkB,SAAQ,YAAY;IACjD,QAAQ,CAAC,QAAQ,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,CAAC;gBAEzB,EACjB,OAAO,EACP,QAAQ,GACT,EAAE;QACD,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE;YAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAC,CAAC;KACpC;CAIF;AAED,qBAAa,iBAAkB,SAAQ,YAAY;CAAG;AACtD,qBAAa,eAAgB,SAAQ,YAAY;CAAG;AACpD,qBAAa,cAAe,SAAQ,YAAY;CAAG;AACnD,qBAAa,cAAe,SAAQ,YAAY;CAAG;AAEnD,qBAAa,mBAAoB,SAAQ,YAAY;CAAG;AACxD,qBAAa,mBAAoB,SAAQ,YAAY;CAAG;AAExD,qBAAa,uBAAwB,SAAQ,YAAY;CAAG;AAC5D,qBAAa,qBAAsB,SAAQ,YAAY;CAAG;AAE1D,qBAAa,mBAAoB,SAAQ,YAAY;CAAG;AAExD,qBAAa,YAAa,SAAQ,YAAY;IAC5C,QAAQ,CAAC,SAAS,EAAE,GAAG,CAAC;gBAEL,EAAC,OAAO,EAAE,SAAS,EAAC,EAAE;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,GAAG,CAAA;KAAC;CAM3E"}

package/dist/error.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvalidRequestError = exports.UnsupportedClientType = exports.MissingRequiredArgument = exports.SessionStorageError = exports.InvalidWebhookError = exports.InvalidSession = exports.CookieNotFound = exports.SessionNotFound = exports.InvalidOAuthError = exports.GraphqlQueryError = exports.RestResourceError = exports.HttpThrottlingError = exports.HttpInternalError = exports.HttpRetriableError = exports.HttpResponseError = exports.HttpMaxRetriesError = exports.HttpRequestError = exports.PrivateAppError = exports.UninitializedContextError = exports.SafeCompareError = exports.MissingJwtTokenError = exports.InvalidJwtError = exports.InvalidHostError = exports.InvalidShopError = exports.InvalidHmacError = exports.ShopifyError = void 0;
+exports.BillingError = exports.InvalidRequestError = exports.UnsupportedClientType = exports.MissingRequiredArgument = exports.SessionStorageError = exports.InvalidWebhookError = exports.InvalidSession = exports.CookieNotFound = exports.SessionNotFound = exports.InvalidOAuthError = exports.GraphqlQueryError = exports.RestResourceError = exports.HttpThrottlingError = exports.HttpInternalError = exports.HttpRetriableError = exports.HttpResponseError = exports.HttpMaxRetriesError = exports.HttpRequestError = exports.PrivateAppError = exports.UninitializedContextError = exports.SafeCompareError = exports.MissingJwtTokenError = exports.InvalidJwtError = exports.InvalidHostError = exports.InvalidShopError = exports.InvalidHmacError = exports.ShopifyError = void 0;
 var tslib_1 = require("tslib");
 var ShopifyError = /** @class */ (function (_super) {
     tslib_1.__extends(ShopifyError, _super);
@@ -232,3 +232,15 @@ var InvalidRequestError = /** @class */ (function (_super) {
     return InvalidRequestError;
 }(ShopifyError));
 exports.InvalidRequestError = InvalidRequestError;
+var BillingError = /** @class */ (function (_super) {
+    tslib_1.__extends(BillingError, _super);
+    function BillingError(_a) {
+        var message = _a.message, errorData = _a.errorData;
+        var _this = _super.call(this, message) || this;
+        _this.message = message;
+        _this.errorData = errorData;
+        return _this;
+    }
+    return BillingError;
+}(ShopifyError));
+exports.BillingError = BillingError;

package/dist/index.d.ts

@@ -4,6 +4,7 @@ export declare const Shopify: {
     Context: import("./context").ContextInterface;
     Auth: {
         SESSION_COOKIE_NAME: string;
+        STATE_COOKIE_NAME: string;
         beginAuth(request: import("http").IncomingMessage, response: import("http").ServerResponse, shop: string, redirectPath: string, isOnline?: boolean): Promise<string>;
         validateAuthCallback(request: import("http").IncomingMessage, response: import("http").ServerResponse, query: import("./types").AuthQuery): Promise<import("./types").SessionInterface>;
         getCookieSessionId(request: import("http").IncomingMessage, response: import("http").ServerResponse): string | undefined;
@@ -11,6 +12,9 @@ export declare const Shopify: {
         getOfflineSessionId(shop: string): string;
         getCurrentSessionId(request: import("http").IncomingMessage, response: import("http").ServerResponse, isOnline?: boolean): string | undefined;
     };
+    Billing: {
+        check: typeof import("./billing/check").check;
+    };
     Session: {
         Session: typeof import("./auth/session/session").Session;
         MemorySessionStorage: typeof import("./auth/session").MemorySessionStorage;

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AACA,OAAO,KAAK,aAAa,MAAM,SAAS,CAAC;AAOzC,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAQnB,CAAC;AAEF,eAAe,OAAO,CAAC;AACvB,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AACA,OAAO,KAAK,aAAa,MAAM,SAAS,CAAC;AAQzC,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CASnB,CAAC;AAEF,eAAe,OAAO,CAAC;AACvB,cAAc,SAAS,CAAC"}

package/dist/index.js

@@ -5,6 +5,7 @@ var tslib_1 = require("tslib");
 var context_1 = require("./context");
 var ShopifyErrors = tslib_1.__importStar(require("./error"));
 var oauth_1 = tslib_1.__importDefault(require("./auth/oauth"));
+var billing_1 = tslib_1.__importDefault(require("./billing"));
 var session_1 = tslib_1.__importDefault(require("./auth/session"));
 var clients_1 = tslib_1.__importDefault(require("./clients"));
 var utils_1 = tslib_1.__importDefault(require("./utils"));
@@ -12,6 +13,7 @@ var webhooks_1 = tslib_1.__importDefault(require("./webhooks"));
 exports.Shopify = {
     Context: context_1.Context,
     Auth: oauth_1.default,
+    Billing: billing_1.default,
     Session: session_1.default,
     Clients: clients_1.default,
     Utils: utils_1.default,

package/dist/types.d.ts

@@ -1,5 +1,6 @@
 export * from './base-types';
 export * from './auth/types';
+export * from './billing/types';
 export * from './clients/types';
 export * from './utils/types';
 export * from './webhooks/types';

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC"}

package/dist/types.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./base-types"), exports);
 tslib_1.__exportStar(require("./auth/types"), exports);
+tslib_1.__exportStar(require("./billing/types"), exports);
 tslib_1.__exportStar(require("./clients/types"), exports);
 tslib_1.__exportStar(require("./utils/types"), exports);
 tslib_1.__exportStar(require("./webhooks/types"), exports);

package/dist/utils/decode-session-token.js

@@ -5,7 +5,7 @@ var tslib_1 = require("tslib");
 var jsonwebtoken_1 = tslib_1.__importDefault(require("jsonwebtoken"));
 var context_1 = require("../context");
 var ShopifyErrors = tslib_1.__importStar(require("../error"));
-var JWT_PERMITTED_CLOCK_TOLERANCE = 5;
+var JWT_PERMITTED_CLOCK_TOLERANCE = 10;
 /**
  * Decodes the given session token, and extracts the session information from it
  *

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

@@ -6,4 +6,5 @@ import http from 'http';
  * @param request Current HTTP request
  */
 export default function getEmbeddedAppUrl(request: http.IncomingMessage): string;
+export declare function buildEmbeddedAppUrl(host: string): string;
 //# sourceMappingURL=get-embedded-app-url.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"get-embedded-app-url.d.ts","sourceRoot":"","sources":["../../src/utils/get-embedded-app-url.ts"],"names":[],"mappings":";AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AAOxB;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,iBAAiB,CACvC,OAAO,EAAE,IAAI,CAAC,eAAe,GAC5B,MAAM,CAyBR"}
+{"version":3,"file":"get-embedded-app-url.d.ts","sourceRoot":"","sources":["../../src/utils/get-embedded-app-url.ts"],"names":[],"mappings":";AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AAOxB;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,iBAAiB,CACvC,OAAO,EAAE,IAAI,CAAC,eAAe,GAC5B,MAAM,CAuBR;AAED,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAMxD"}

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

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildEmbeddedAppUrl = void 0;
 var tslib_1 = require("tslib");
 var ShopifyErrors = tslib_1.__importStar(require("../error"));
 var context_1 = require("../context");
@@ -18,10 +19,15 @@ function getEmbeddedAppUrl(request) {
     }
     var url = new URL(request.url, "https://".concat(request.headers.host));
     var host = url.searchParams.get('host');
-    if (typeof host !== 'string' || !(0, shop_validator_1.sanitizeHost)(host)) {
+    if (typeof host !== 'string') {
         throw new ShopifyErrors.InvalidRequestError('Request does not contain a host query parameter');
     }
+    return buildEmbeddedAppUrl(host);
+}
+exports.default = getEmbeddedAppUrl;
+function buildEmbeddedAppUrl(host) {
+    (0, shop_validator_1.sanitizeHost)(host, true);
     var decodedHost = Buffer.from(host, 'base64').toString();
     return "https://".concat(decodedHost, "/apps/").concat(context_1.Context.API_KEY);
 }
-exports.default = getEmbeddedAppUrl;
+exports.buildEmbeddedAppUrl = buildEmbeddedAppUrl;

package/dist/utils/setup-jest.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"setup-jest.d.ts","sourceRoot":"","sources":["../../src/utils/setup-jest.ts"],"names":[],"mappings":"AAuCA,OAAO,CAAC,MAAM,CAAC;IAEb,UAAU,IAAI,CAAC;QAEb,UAAU,QAAQ,CAAC,CAAC;YAClB,mBAAmB,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,CAAC,CAAC;YAC7D,sBAAsB,IAAI,CAAC,CAAC;SAC7B;KAEF;CACF"}
+{"version":3,"file":"setup-jest.d.ts","sourceRoot":"","sources":["../../src/utils/setup-jest.ts"],"names":[],"mappings":"AAwCA,OAAO,CAAC,MAAM,CAAC;IAEb,UAAU,IAAI,CAAC;QAEb,UAAU,QAAQ,CAAC,CAAC;YAClB,mBAAmB,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,CAAC,CAAC;YAC7D,sBAAsB,IAAI,CAAC,CAAC;SAC7B;KAEF;CACF"}

package/dist/utils/setup-jest.js

@@ -20,6 +20,7 @@ beforeEach(function () {
         IS_PRIVATE_APP: false,
         SESSION_STORAGE: new session_1.MemorySessionStorage(),
         CUSTOM_SHOP_DOMAINS: undefined,
+        BILLING: undefined,
     });
     jest_fetch_mock_1.default.mockReset();
     currentCall = 0;

package/dist/version.d.ts

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

package/dist/webhooks/registry.js

@@ -137,7 +137,7 @@ var WebhooksRegistry = {
                                 data: buildCheckQuery(topic),
                             })];
                     case 2:
-                        checkResult = (_c.sent());
+                        checkResult = _c.sent();
                         return [3 /*break*/, 4];
                     case 3:
                         error_1 = _c.sent();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shopify/shopify-api",
-  "version": "5.0.1",
+  "version": "5.1.0",
   "description": "Shopify API Library for Node - accelerate development with support for authentication, graphql proxy, webhooks",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -54,7 +54,7 @@
     "mysql2": "^2.3.3",
     "node-fetch": "^2.6.1",
     "pg": "^8.7.3",
-    "redis": "^4.0.6",
+    "redis": "^4.1.0",
     "sqlite3": "^5.0.8",
     "tslib": "^2.0.3",
     "uuid": "^8.3.1"