@envoy/envoy-integrations-sdk 2.0.1-beta.5 → 2.0.2

package/dist/util/EnvoyJWT.js

@@ -0,0 +1,54 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
+var constants_1 = require("../constants");
+/**
+ * Helper to encode and decode JWTs.
+ *
+ * @category Helper
+ * @category Request Object
+ */
+var EnvoyJWT = /** @class */ (function () {
+    function EnvoyJWT(secret, algorithm) {
+        if (secret === void 0) { secret = constants_1.jwtSecret; }
+        if (algorithm === void 0) { algorithm = 'HS256'; }
+        if (!secret) {
+            throw new Error('JWT secret missing. Have you set the `JWT_SECRET` environment variable?');
+        }
+        this.secret = secret;
+        this.algorithm = algorithm;
+    }
+    EnvoyJWT.prototype.encode = function (subject, expiresIn, payload) {
+        if (payload === void 0) { payload = {}; }
+        var _a = this, secret = _a.secret, algorithm = _a.algorithm;
+        var options = { algorithm: algorithm };
+        if (subject) {
+            options.subject = "" + subject;
+        }
+        if (expiresIn) {
+            options.expiresIn = expiresIn;
+        }
+        return jsonwebtoken_1.default.sign(payload, secret, options);
+    };
+    EnvoyJWT.prototype.decode = function (token, options) {
+        if (options === void 0) { options = {}; }
+        var _a = this, secret = _a.secret, algorithm = _a.algorithm;
+        return jsonwebtoken_1.default.verify(token, secret, __assign(__assign({ ignoreExpiration: false, ignoreNotBefore: false }, options), { algorithms: [algorithm] }));
+    };
+    return EnvoyJWT;
+}());
+exports.default = EnvoyJWT;

package/dist/util/EnvoySignatureVerifier.d.ts

@@ -0,0 +1,26 @@
+/// <reference types="node" />
+import { BinaryToTextEncoding } from 'crypto';
+import { Request } from 'express';
+/**
+ * @category Helper
+ */
+export declare type EnvoySignatureVerifierOptions = {
+    algorithm: 'sha256' | string;
+    encoding: BinaryToTextEncoding;
+    secret: string;
+    header: 'x-envoy-signature' | string;
+};
+/**
+ * Verifies that a request is coming from Envoy.
+ *
+ * @category Helper
+ */
+export default class EnvoySignatureVerifier {
+    private readonly options;
+    constructor(options?: EnvoySignatureVerifierOptions);
+    /**
+     * Verifies that the signature provided matches the request body.
+     */
+    verify(req: Request, rawBody: Buffer): boolean;
+}
+//# sourceMappingURL=EnvoySignatureVerifier.d.ts.map

package/dist/util/EnvoySignatureVerifier.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EnvoySignatureVerifier.d.ts","sourceRoot":"","sources":["../../src/util/EnvoySignatureVerifier.ts"],"names":[],"mappings":";AAAA,OAAe,EAAE,oBAAoB,EAAE,MAAM,QAAQ,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAGlC;;GAEG;AACH,oBAAY,6BAA6B,GAAG;IAC1C,SAAS,EAAE,QAAQ,GAAG,MAAM,CAAC;IAC7B,QAAQ,EAAE,oBAAoB,CAAC;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,mBAAmB,GAAG,MAAM,CAAC;CACtC,CAAC;AASF;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,sBAAsB;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAgC;gBAE5C,OAAO,GAAE,6BAA8C;IAQnE;;OAEG;IACH,MAAM,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO;CAoB/C"}

package/dist/util/EnvoySignatureVerifier.js

@@ -0,0 +1,53 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var crypto_1 = __importDefault(require("crypto"));
+var constants_1 = require("../constants");
+var defaultOptions = {
+    algorithm: 'sha256',
+    encoding: 'base64',
+    secret: constants_1.envoyClientSecret,
+    header: 'x-envoy-signature',
+};
+/**
+ * Verifies that a request is coming from Envoy.
+ *
+ * @category Helper
+ */
+var EnvoySignatureVerifier = /** @class */ (function () {
+    function EnvoySignatureVerifier(options) {
+        if (options === void 0) { options = defaultOptions; }
+        this.options = __assign(__assign({}, defaultOptions), options);
+        if (!this.options.secret) {
+            throw new Error('No client secret found in the ENVOY_CLIENT_SECRET environment variable.');
+        }
+    }
+    /**
+     * Verifies that the signature provided matches the request body.
+     */
+    EnvoySignatureVerifier.prototype.verify = function (req, rawBody) {
+        var _a = this.options, algorithm = _a.algorithm, encoding = _a.encoding, secret = _a.secret, header = _a.header;
+        if (!req.headers[header]) {
+            return false;
+        }
+        var receivedDigest = req.headers[header];
+        var computedHmac = crypto_1.default.createHmac(algorithm, secret);
+        computedHmac.update(rawBody);
+        return crypto_1.default.timingSafeEqual(Buffer.from(receivedDigest), Buffer.from(computedHmac.digest(encoding)));
+    };
+    return EnvoySignatureVerifier;
+}());
+exports.default = EnvoySignatureVerifier;

package/dist/util/axiosConstructor.d.ts

@@ -0,0 +1,4 @@
+import { AxiosInstance, AxiosRequestConfig } from 'axios';
+export declare function sanitizeAxiosError(error: unknown): Error;
+export declare function createAxiosClient(config?: AxiosRequestConfig | undefined): AxiosInstance;
+//# sourceMappingURL=axiosConstructor.d.ts.map

package/dist/util/axiosConstructor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"axiosConstructor.d.ts","sourceRoot":"","sources":["../../src/util/axiosConstructor.ts"],"names":[],"mappings":"AAAA,OAAc,EAA4B,aAAa,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAG3F,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,CAgCxD;AAED,wBAAgB,iBAAiB,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,SAAS,GAAG,aAAa,CAQxF"}

package/dist/util/axiosConstructor.js

@@ -0,0 +1,58 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createAxiosClient = exports.sanitizeAxiosError = void 0;
+var axios_1 = __importStar(require("axios"));
+var errorHandling_1 = require("./errorHandling");
+function sanitizeAxiosError(error) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+    if (!axios_1.default.isAxiosError(error)) {
+        return errorHandling_1.ensureError(error);
+    }
+    var safeError = new axios_1.AxiosError(error.message, error.code, {
+        url: (_a = error.config) === null || _a === void 0 ? void 0 : _a.url,
+        method: (_b = error.config) === null || _b === void 0 ? void 0 : _b.method,
+        baseURL: (_c = error.config) === null || _c === void 0 ? void 0 : _c.baseURL,
+        headers: new axios_1.AxiosHeaders(),
+    }, {
+        url: (_d = error.request) === null || _d === void 0 ? void 0 : _d.url,
+        method: (_e = error.request) === null || _e === void 0 ? void 0 : _e.method,
+        baseURL: (_f = error.request) === null || _f === void 0 ? void 0 : _f.baseURL,
+        data: (_g = error.request) === null || _g === void 0 ? void 0 : _g.data,
+    }, {
+        data: (_h = error.response) === null || _h === void 0 ? void 0 : _h.data,
+        status: (_k = (_j = error.response) === null || _j === void 0 ? void 0 : _j.status) !== null && _k !== void 0 ? _k : 0,
+        statusText: (_m = (_l = error.response) === null || _l === void 0 ? void 0 : _l.statusText) !== null && _m !== void 0 ? _m : '',
+        headers: new axios_1.AxiosHeaders(),
+        config: {
+            headers: new axios_1.AxiosHeaders(),
+        },
+    });
+    safeError.stack = error.stack;
+    return safeError;
+}
+exports.sanitizeAxiosError = sanitizeAxiosError;
+function createAxiosClient(config) {
+    var client = axios_1.default.create(config);
+    client.interceptors.response.use(function (response) { return response; }, function (error) { return Promise.reject(sanitizeAxiosError(error)); });
+    return client;
+}
+exports.createAxiosClient = createAxiosClient;

package/dist/util/errorHandling.d.ts

@@ -0,0 +1,2 @@
+export declare function ensureError(value: unknown): Error;
+//# sourceMappingURL=errorHandling.d.ts.map

package/dist/util/errorHandling.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errorHandling.d.ts","sourceRoot":"","sources":["../../src/util/errorHandling.ts"],"names":[],"mappings":"AAAA,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,CAcjD"}

package/dist/util/errorHandling.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureError = void 0;
+function ensureError(value) {
+    if (value instanceof Error) {
+        return value;
+    }
+    var stringified = '[Unable to stringify the thrown value]';
+    try {
+        stringified = JSON.stringify(value);
+    }
+    catch (_a) {
+        // ignore
+    }
+    var error = new Error("This value was thrown as is, not through an Error: " + stringified);
+    return error;
+}
+exports.ensureError = ensureError;

package/dist/util/json-api/JSONAPIData.d.ts

@@ -0,0 +1,5 @@
+export default interface JSONAPIData<Type = string, ID = string> {
+    id: ID;
+    type: Type;
+}
+//# sourceMappingURL=JSONAPIData.d.ts.map

package/dist/util/json-api/JSONAPIData.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"JSONAPIData.d.ts","sourceRoot":"","sources":["../../../src/util/json-api/JSONAPIData.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC,IAAI,GAAG,MAAM,EAAE,EAAE,GAAG,MAAM;IAC7D,EAAE,EAAE,EAAE,CAAC;IACP,IAAI,EAAE,IAAI,CAAC;CACZ"}

package/dist/util/json-api/JSONAPIData.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/util/json-api/JSONAPIFilterParams.d.ts

@@ -0,0 +1,5 @@
+import JSONAPIParams from './JSONAPIParams';
+export default interface JSONAPIFilterParams<FilterFields> extends JSONAPIParams {
+    filter?: FilterFields;
+}
+//# sourceMappingURL=JSONAPIFilterParams.d.ts.map

package/dist/util/json-api/JSONAPIFilterParams.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"JSONAPIFilterParams.d.ts","sourceRoot":"","sources":["../../../src/util/json-api/JSONAPIFilterParams.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAE5C,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC,YAAY,CAAE,SAAQ,aAAa;IAC9E,MAAM,CAAC,EAAE,YAAY,CAAC;CACvB"}

package/dist/util/json-api/JSONAPIFilterParams.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/util/json-api/JSONAPIModel.d.ts

@@ -0,0 +1,10 @@
+import JSONAPIData from './JSONAPIData';
+export default interface JSONAPIModel<Attributes, Relationships extends string, Type = string, ID = string> extends JSONAPIData<Type, ID> {
+    attributes: Attributes;
+    relationships: {
+        [key in Relationships]: {
+            data: JSONAPIData & Array<JSONAPIData>;
+        };
+    };
+}
+//# sourceMappingURL=JSONAPIModel.d.ts.map

package/dist/util/json-api/JSONAPIModel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"JSONAPIModel.d.ts","sourceRoot":"","sources":["../../../src/util/json-api/JSONAPIModel.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,eAAe,CAAC;AAExC,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC,UAAU,EAAE,aAAa,SAAS,MAAM,EAAE,IAAI,GAAG,MAAM,EAAE,EAAE,GAAG,MAAM,CAAE,SAAQ,WAAW,CAAC,IAAI,EAAE,EAAE,CAAC;IACvI,UAAU,EAAE,UAAU,CAAC;IACvB,aAAa,EAAE;SACZ,GAAG,IAAI,aAAa,GAAG;YACtB,IAAI,EAAE,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC,CAAA;SACvC;KACF,CAAA;CACF"}

package/dist/util/json-api/JSONAPIModel.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/util/json-api/JSONAPIPaginationParams.d.ts

@@ -0,0 +1,9 @@
+import JSONAPIFilterParams from './JSONAPIFilterParams';
+export default interface JSONAPIPaginationParams<FilterFields, SortFields extends string> extends JSONAPIFilterParams<FilterFields> {
+    page?: {
+        offset?: number;
+        limit?: number;
+    };
+    sort?: SortFields;
+}
+//# sourceMappingURL=JSONAPIPaginationParams.d.ts.map

package/dist/util/json-api/JSONAPIPaginationParams.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"JSONAPIPaginationParams.d.ts","sourceRoot":"","sources":["../../../src/util/json-api/JSONAPIPaginationParams.ts"],"names":[],"mappings":"AAAA,OAAO,mBAAmB,MAAM,uBAAuB,CAAC;AAExD,MAAM,CAAC,OAAO,WAAW,uBAAuB,CAAC,YAAY,EAAE,UAAU,SAAS,MAAM,CACtF,SAAQ,mBAAmB,CAAC,YAAY,CAAC;IAEzC,IAAI,CAAC,EAAE;QACL,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAA;IAED,IAAI,CAAC,EAAE,UAAU,CAAC;CACnB"}

package/dist/util/json-api/JSONAPIPaginationParams.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/util/json-api/JSONAPIParams.d.ts

@@ -0,0 +1,4 @@
+export default interface JSONAPIParams {
+    include?: string;
+}
+//# sourceMappingURL=JSONAPIParams.d.ts.map

package/dist/util/json-api/JSONAPIParams.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"JSONAPIParams.d.ts","sourceRoot":"","sources":["../../../src/util/json-api/JSONAPIParams.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,WAAW,aAAa;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/dist/util/json-api/JSONAPIParams.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/util/json-api/JSONAPIResponse.d.ts

@@ -0,0 +1,6 @@
+export default interface JSONAPIResponse<Model> {
+    data: Model;
+    included?: Array<unknown>;
+    meta?: Array<unknown>;
+}
+//# sourceMappingURL=JSONAPIResponse.d.ts.map

package/dist/util/json-api/JSONAPIResponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"JSONAPIResponse.d.ts","sourceRoot":"","sources":["../../../src/util/json-api/JSONAPIResponse.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,WAAW,eAAe,CAAC,KAAK;IAC5C,IAAI,EAAE,KAAK,CAAC;IACZ,QAAQ,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAC1B,IAAI,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAA;CACtB"}

package/dist/util/json-api/JSONAPIResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,10 +1,24 @@
 {
   "name": "@envoy/envoy-integrations-sdk",
-  "version": "2.0.1-beta.5",
-  "description": "",
-  "main": "index.js",
+  "version": "2.0.2",
+  "description": "SDK for building Envoy integrations.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "directories": {
+    "lib": "src",
+    "doc": "docs"
+  },
+  "files": [
+    "dist/*.d.ts",
+    "dist/*.d.ts.map",
+    "dist",
+    "src"
+  ],
   "scripts": {
-    "test": "jest"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "docs:generate": "typedoc",
+    "prepublishOnly": "tsc",
+    "compile": "tsc"
   },
   "repository": {
     "type": "git",
@@ -17,22 +31,43 @@
   },
   "homepage": "https://github.com/envoy/envoy-integrations-sdk-nodejs#readme",
   "dependencies": {
+    "@types/dotenv": "^8.2.0",
+    "@types/faker": "^5.5.6",
+    "@types/jsonwebtoken": "^9.0.0",
+    "@types/node": "^15.12.0",
+    "@types/qs": "^6.9.6",
     "axios": "^1.4.0",
     "body-parser": "^1.19.0",
-    "dotenv": "^8.1.0",
+    "dataloader": "^2.0.0",
+    "dotenv-flow": "^3.2.0",
+    "factory.ts": "^0.5.2",
+    "faker": "^5.5.3",
     "jsonwebtoken": "^9.0.0",
-    "request": "^2.88.0",
-    "request-promise-native": "^1.0.7"
+    "lodash.ismatch": "^4.4.0",
+    "luxon": "^1.27.0",
+    "qs": "^6.10.1"
   },
   "devDependencies": {
+    "@types/dotenv-flow": "^3.1.1",
+    "@types/express": "^4.17.12",
+    "@types/lodash.ismatch": "^4.4.6",
+    "@types/luxon": "^1.27.0",
+    "@typescript-eslint/eslint-plugin": "^4.26.0",
+    "@typescript-eslint/parser": "^4.26.0",
     "chai": "^4.2.0",
-    "eslint": "^5.16.0",
-    "eslint-config-airbnb-base": "^13.1.0",
-    "eslint-plugin-import": "^2.17.3",
-    "jest": "^29.5.0",
+    "eslint": "^7.27.0",
+    "eslint-config-airbnb-typescript": "^12.3.1",
+    "eslint-plugin-import": "^2.23.4",
     "jsdoc-to-markdown": "^5.0.0",
-    "mocha": "^10.2.0",
+    "mocha": "^6.1.4",
     "proxyquire": "^2.1.0",
-    "sinon": "^7.3.2"
+    "sinon": "^7.3.2",
+    "typedoc": "^0.20.36",
+    "typedoc-github-wiki-theme": "^0.3.0",
+    "typedoc-plugin-markdown": "^3.9.0",
+    "typescript": "4.2"
+  },
+  "peerDependencies": {
+    "@types/express": "^4"
   }
 }

package/src/base/EnvoyAPI.ts

@@ -0,0 +1,87 @@
+import qs from 'qs';
+import DataLoader from 'dataloader';
+import JSONAPIData from '../util/json-api/JSONAPIData';
+import { envoyBaseURL } from '../constants';
+import { createAxiosClient } from '../util/axiosConstructor';
+
+interface EnvoyWebDataLoaderKey extends JSONAPIData {
+  include?: string;
+}
+
+/**
+ * Sometimes envoy-web will give us back some relationship data
+ * with the "type" set to the relationships name instead of the actual model's name.
+ * This mapping allows us to alias those cases.
+ */
+const TYPE_ALIASES = new Map<string, string>([
+  ['employee-screening-flows', 'flows'],
+]);
+
+/**
+ * Make typed API calls to Envoy.
+ * Uses a data loader to leverage JSONAPI's "include" functionality.
+ * This allows us to save everything that was included in the initial response
+ * to be used later without re-fetching from the API.
+ *
+ * @category Base
+ */
+export default class EnvoyAPI {
+  /**
+   * HTTP Client with Envoy's defaults.
+   */
+  readonly axios = createAxiosClient({
+    baseURL: envoyBaseURL,
+    headers: {
+      'Content-Type': 'application/vnd.api+json',
+      Accept: 'application/vnd.api+json',
+    },
+    paramsSerializer: (params) => qs.stringify(params, {
+      arrayFormat: 'brackets',
+      encode: false,
+    }),
+  });
+
+  /**
+   * A dataloader: https://github.com/graphql/dataloader
+   * Will fetch individual resources from the API,
+   * unless they exist in cache (which they usually will).
+   */
+  protected readonly dataLoader = new DataLoader<EnvoyWebDataLoaderKey, any, string>(
+    (keys) => Promise.all(
+      keys.map(async ({ type, id, include }) => {
+        const { data } = await this.axios.get(`api/v3/${type}/${id}`, { params: { include } });
+        return data.data;
+      }),
+    ),
+    {
+      cacheKeyFn: (key) => `${key.type}_${key.id}`,
+    },
+  );
+
+  constructor(accessToken: string) {
+    this.axios.defaults.headers.authorization = `Bearer ${accessToken}`;
+    /**
+     * Saves every model that was "include"ed in the response,
+     * which saves us the trouble of fetching related data.
+     */
+    this.axios.interceptors.response.use((response) => {
+      const {
+        data: {
+          data: modelOrModels,
+          included,
+        },
+      } = response;
+
+      (included || [])
+        .concat(modelOrModels)
+        .forEach((model: JSONAPIData) => {
+          this.dataLoader.prime({ type: model.type, id: model.id }, model);
+          const alias = TYPE_ALIASES.get(model.type);
+          if (alias) {
+            this.dataLoader.prime({ type: alias, id: model.id }, model);
+          }
+        });
+      return response;
+    }, (error) => Promise.reject(error));
+  }
+}

package/src/base/EnvoyPluginStoragePipeline.ts

@@ -0,0 +1,99 @@
+import EnvoyStorageCommand, {
+  EnvoyStorageSetUniqueNumOptions,
+  EnvoyStorageSetUniqueOptions,
+} from '../internal/EnvoyStorageCommand';
+import EnvoyStorageResult from '../internal/EnvoyStorageResult';
+import EnvoyPluginAPI from '../sdk/EnvoyPluginAPI';
+
+/**
+ * Builds up a request pipeline for submitting storage commands.
+ *
+ * @category Base
+ */
+export default class EnvoyPluginStoragePipeline {
+  protected readonly api: EnvoyPluginAPI;
+
+  readonly installId: string | undefined;
+
+  protected readonly commands: Array<EnvoyStorageCommand>;
+
+  constructor(pluginAPI: EnvoyPluginAPI, installId?: string) {
+    this.api = pluginAPI;
+    this.installId = installId;
+    this.commands = [];
+  }
+
+  /**
+   * Executes all the commands in the pipeline.
+   */
+  execute<Result extends EnvoyStorageResult = EnvoyStorageResult>(): Promise<Array<Result>> {
+    return this.api.storagePipeline<Result>(this.commands, this.installId);
+  }
+
+  /**
+   * Executes the pipeline and returns the first result.
+   */
+  async executeSingle<Result extends EnvoyStorageResult = EnvoyStorageResult>(): Promise<Result> {
+    const [result] = await this.execute<Result>();
+    return result;
+  }
+
+  addCommand(command: EnvoyStorageCommand): EnvoyPluginStoragePipeline {
+    this.commands.push(command);
+    return this;
+  }
+
+  /**
+   * Gets a storage item.
+   */
+  get(key: string): EnvoyPluginStoragePipeline {
+    return this.addCommand({ action: 'get', key });
+  }
+
+  /**
+   * Sets a value for a storage item,
+   * and returns that item.
+   */
+  set(key: string, value: unknown): EnvoyPluginStoragePipeline {
+    return this.addCommand({ action: 'set', key, value });
+  }
+
+  /**
+   * Sets a unique value for a storage item,
+   * and returns that item.
+   */
+  setUnique(key: string, options: EnvoyStorageSetUniqueOptions = {}): EnvoyPluginStoragePipeline {
+    return this.addCommand({ action: 'set_unique', key, ...options });
+  }
+
+  /**
+   * Sets a unique number value for a storage item,
+   * and returns that item.
+   */
+  setUniqueNum(key: string, options: EnvoyStorageSetUniqueNumOptions = {}): EnvoyPluginStoragePipeline {
+    if (options.min) {
+      options.min = Number(options.min);
+    }
+    if (options.max) {
+      options.max = Number(options.max);
+    }
+    return this.addCommand({ action: 'set_unique_num', key, ...options });
+  }
+
+  /**
+   * Unsets a storage item.
+   */
+  unset(key: string): EnvoyPluginStoragePipeline {
+    return this.addCommand({ action: 'unset', key });
+  }
+
+  /**
+   * Lists storage items.
+   */
+  list(page = 1): EnvoyPluginStoragePipeline {
+    if (!page) {
+      page = 1;
+    }
+    return this.addCommand({ action: 'list', page });
+  }
+}

package/src/constants.ts

@@ -0,0 +1,7 @@
+import dotenv from 'dotenv-flow';
+
+dotenv.config();
+export const envoyBaseURL = process.env.ENVOY_BASE_URL || 'https://app.envoy.com';
+export const envoyClientId = process.env.ENVOY_CLIENT_ID as string;
+export const envoyClientSecret = process.env.ENVOY_CLIENT_SECRET as string;
+export const jwtSecret = process.env.JWT_SECRET as string;