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

package/README.md

@@ -1,6 +1,6 @@
 # Envoy Node.js SDK
 
-The SDK exports several classes and functions, however the most typical way to integrate the SDK is as middleware. The `middleware()` function call returns a middleware that attaches an instance of `EnvoyPluginSDK` to the `req` object and verifies that the request came from Envoy. It is available as `req.envoy`.
+The SDK exports several classes and functions, however the most typical way to integrate the SDK is as middleware. The `envoyMiddleware()` function call returns a middleware that attaches an instance of `EnvoyPluginSDK` to the `req` object and verifies that the request came from Envoy. It is available as `req.envoy`.
 
 ## Installation
 
@@ -25,127 +25,195 @@ View our Node.js [quickstart guide](https://developers.envoy.com/hub/docs/nodejs
 
 ### Usage
 
-Here's the typical SDK usage at a glance.
+#### Define your `config`
+When customers go through your integration's setup steps, that info is saved in a `config` object that is sent along with every request Envoy makes to your integration.
 
-```javascript
-const express = require('express');
-const { middleware, errorMiddleware, asyncHandler } = require('@envoy/envoy-integrations-sdk');
+Defining this object as a specific type allows us to safely type the various handlers that will use those values.
+
+```typescript
+// defs/Config.ts
+type Config = {
+  greeting: string
+};
+export default Config;
+```
+
+#### Implement setup routes
+As customers go through the setup steps of your integration, they may trigger several requests to your integration for things like:
+- loading dropdown options
+- loading text fields with remote data
+- validating submitted step data
+
+Below, we'll implement a route that will load a list of greetings into a dropdown in our setup steps.
+ 
+View the other types of handlers [here](docs#handler-functions).
+
+```typescript
+// greetingOptions.ts
+import { optionsRouteHandler } from '@envoy/envoy-integrations-sdk';
+
+export default optionsRouteHandler((req, res) => {
+  res.send([
+    {
+      label: 'Hello',
+      value: 'Hello',
+    },
+    {
+      label: 'Hola',
+      value: 'Hola',
+    },
+    {
+      label: 'Aloha',
+      value: 'Aloha',
+    },
+  ]);
+});
+```
+
+#### Implement event handlers
+Your integration can respond to several Envoy events. Below, we'll implement a simple event handler for an `entry_sign_in` event.
+
+All it does is to take the greeting that the customer chose during setup, and displays it in the Envoy Dashboard when a visitor signs in.
+
+View the other types of handlers [here](docs#handler-functions).
+
+```typescript
+// entrySignIn.ts
+import { entryEventHandler } from '@envoy/envoy-integrations-sdk';
+import Config from './defs/Config';
+
+export default entryEventHandler<Config>(async (req, res) => {
+  const { envoy } = req;
+  const { job, meta, payload: visitor } = envoy;
+  const hello = `${meta.config.greeting} ${visitor.attributes['full-name']}!`; // our custom greeting
+  await job.attach({ label: 'Greeting', value: hello }); // show in the Envoy dashboard.
+  res.send({ hello });
+});
+```
+
+
+#### Setup your `express.js` app
+Use the `envoyMiddleware` to get an instance of [EnvoyPluginSDK](docs/classes/envoypluginsdk.md) attached to every request.
+
+View the other types of middleware [here](docs#middleware-functions).
+```typescript
+// index.ts
+import express from 'express';
+import { envoyMiddleware, errorMiddleware } from '@envoy/envoy-integrations-sdk';
+
+import greetingOptions from './greetingOptions';
+import entrySignIn from './entrySignIn'
 
 const app = express();
+app.use(envoyMiddleware());
+app.post('/greeting-options', greetingOptions);
+app.post('/entry-sign-in', entrySignIn);
+app.use(errorMiddleware());
+app.listen(process.env.PORT);
+```
+
+#### More examples
+Here's some more things you can do with the `req.envoy` object.
+```typescript
+ /**
+ * @type EnvoyPluginSDK
+ */
+const { envoy } = req;  // "envoy" is the SDK
+const {
+  meta, // the platform event request_meta object
+  payload, // the platform event request_body object
+  userAPI, // user-scoped API calls, used in routes
+  pluginAPI, // plugin-scoped API calls, for plugin services
+  installStorage, // install-scoped storage
+  globalStorage, // global-scoped storage
+  job, // update the job (if in an event handler)
+  jwt, // helper to encode/decode jwts
+} = envoy;
+
+/**
+ * User API usage
+ */
+const visitorTypes = await userAPI.getFlows({ filter: { location: '1' } });
+
+/**
+ * Storage usage
+ * The below can be used both at the install level or global level
+ */
+await installStorage.set('foo', 'bar'); // sets foo=bar in storage for this install
+const { value } = await installStorage.get<string>('foo'); // also gets the current value of foo
+const { value } = await installStorage.setUnique('foo'); // creates and returns a unique text value for foo
+const { value } = await installStorage.get<string>('foo'); // also gets the current value of foo
+const { value } = await installStorage.setUniqueNum('foo'); // creates and returns a unique number for foo
+const { value } = await installStorage.get<number>('foo'); // also gets the current value of foo
+await installStorage.unset('foo'); // deletes foo
 /**
- * "middleware()" returns an instance of bodyParser.json,
- * that also verifies the Envoy signature in addition to
- * parsing the request body as JSON.
+ * You can also send multiple commands at once,
+ * to be executed in the same transaction.
+ * The response will be an array of the results of each command, in order.
  */
-app.use(middleware());
+const results = await installStorage.pipeline().set('foo1', 'bar').unset('foo2').get('foo3').execute();
 
-app.post('/url-to-a-route-or-worker', asyncHandler(async (req, res) => {
+/**
+ * Job updates
+ * Note that job.complete can take any number of attachments after the first argument.
+ */
+await job.complete('Credentials provisioned.', { label: 'password', value: 'password' });
+await job.ignore('No credentials provisioned.', 'Email was not supplied.');
+await job.fail('Could not provision credentials.', 'Server could not be reached.');
+/**
+ * You can also just attach things without completing the job.
+ * Attach more things by providing more arguments.
+ */
+await job.attach({ type: 'text', label: 'foo', value: 'bar' });
+/**
+ * If the job is some multi-step process,
+ * you can update it's message without changing the status.
+ * You can also optionally attach things by providing more arguments.
+ */
+await job.update('Still working...');
 
- /**
-  * @type EnvoyPluginSDK
-  */
-  const { envoy } = req;  // "envoy" is the SDK
-  const {
-    meta, // the platform event request_meta object
-    payload, // the platform event request_body object
-    userAPI, // user-scoped API calls, used in routes
-    pluginAPI, // plugin-scoped API calls, for plugin services
-    installStorage, // install-scoped storage
-    globalStorage, // global-scoped storage
-    job, // update the job (if in a worker)
-    jwt, // helper to encode/decode jwts
-  } = envoy;
-
-  /**
-  * User API usage
-  */
-  const visitorTypes = await userAPI.flows(locationId);
-
-  /**
-  * Storage usage
-  * The below can be used both at the install level or global level
-  */
-  await installStorage.set('foo', 'bar'); // sets foo=bar in storage for this install
-  const { value } = await installStorage.setUnique('foo'); // creates and returns a unique text value for foo
-  const { value } = await installStorage.setUniqueNum('foo'); // creates and returns a unique number for foo
-  const { value } = await installStorage.get('foo'); // also gets the current value of foo
-  await installStorage.unset('foo'); // deletes foo
-  /**
-  * You can also send multiple commands at once,
-  * to be executed in the same transaction.
-  * The response will be an array of the results of each command, in order.
-  */
-  const results = await installStorage.pipeline().set('foo1', 'bar').unset('foo2').get('foo3').execute();
-
-  /**
-  * Job updates
-  * Note that job.complete can take any number of attachments after the first argument.
-  */
-  await job.complete('Credentials provisioned.', { label: 'password', value: 'password' });
-  await job.ignore('No credentials provisioned.', 'Email was not supplied.');
-  await job.fail('Could not provision credentials.', 'Server could not be reached.');
-  /**
-  * You can also just attach things without completing the job.
-  * Attach more things by providing more arguments.
-  */
-  await job.attach({ type: 'text', label: 'foo', value: 'bar' });
-  /**
-  * If the job is some multi-step process,
-  * you can update it's message without changing the status.
-  * You can also optionally attach things by providing more arguments.
-  */
-  await job.update('Still working...');
-
-  /**
-  * JWT usage
-  */
-  const token = await jwt.encode(visitorId, '30m');
-  const { sub: visitorId } = await jwt.decode(token);
-
-  /**
-  * If in a validation URL:
-  */
-  res.send({ foo: 'bar' }); // will save foo in the installation config.
-  // or
-  res.sendFailed('This step has failed validation.'); // prevent the installer from progressing.
-
-  /**
-  * If in an options URL:
-  */
-  res.send([ { label: 'Foo', value: 1 }, { label: 'Bar', value: 2 } ]); // display these options in the dropdown.
-
-  /**
-  * If in a worker:
-  */
-  res.send({ hello: 'world' }); // the job was a success, and here's some data about it.
-  // or
-  res.sendOngoing({ hello: 'world' }); // the job is still ongoing, but here's some data about it.
-  // or
-  res.sendIgnored("We're not gonna do this one, sorry.", { hello: 'world' }); // doesnt meet the requirements to continue.
-  // or
-  res.sendFailed('We tried, but failed.', { hello: 'world' }); // we cant continue with this job.
-
-}));
+/**
+ * JWT usage
+ */
+const token = await jwt.encode(visitorId, '30m');
+const { sub: visitorId } = await jwt.decode(token);
+
+/**
+ * If in a validation route:
+ */
+res.send({ foo: 'bar' }); // will save foo in the installation config.
+// or
+res.sendFailed('This step has failed validation.'); // prevent the installer from progressing.
+
+/**
+ * If in an options route:
+ */
+res.send([ { label: 'Foo', value: 1 }, { label: 'Bar', value: 2 } ]); // display these options in the dropdown.
+
+/**
+ * If in an event handler:
+ */
+res.send({ hello: 'world' }); // the job was a success, and here's some data about it.
+// or
+res.sendOngoing("We're still working on it.", { hello: 'world' }); // the job is still ongoing, but here's some data about it.
+// or
+res.sendIgnored("We're not gonna do this one, sorry.", { hello: 'world' }); // doesnt meet the requirements to continue.
+// or
+res.sendFailed('We tried, but failed.', { hello: 'world' }); // we cant continue with this job.
+
+/**
+* Implement Axios Loggers
+*/
+this.axios.interceptors.request.use(envoyAxiosRequestLogger, envoyAxiosErrorLogger); // Request interceptor
+
+this.axios.interceptors.response.use(envoyAxiosResponseLogger, envoyAxiosErrorLogger); // Response interceptor
 
-app.use(errorMiddleware());
 ```
 
+
 ## SDK Reference
 
-For completeness, here is a list of each module exported by the SDK package.
-
-| Name | Type |
-| :--- | :--- |
-| EnvoyAPI | [EnvoyAPI](envoyapi.md) |
-| EnvoyJWT | [EnvoyJWT](envoyjwt.md) |
-| EnvoyPluginJob | [EnvoyPluginJob](envoypluginjob.md) |
-| EnvoyPluginSDK | [EnvoyPluginSDK](envoypluginsdk.md) |
-| EnvoyPluginStorage | [EnvoyPluginStorage](envoypluginstorage.md) |
-| EnvoyPluginStoragePipeline | [EnvoyPluginStoragePipeline](envoypluginstoragepipeline.md) |
-| EnvoySignatureVerifier | [EnvoySignatureVerifier](envoysignatureverifier.md) |
-| middleware | [middleware](middleware.md) |
-| errorMiddleware | [errorMiddleware](errormiddleware.md) |
-| asyncHandler | [asyncHandler](asynchandler.md) |
+Please see detailed documentation [here](docs/README.md).
 
 ### Contributing
 

package/dist/base/EnvoyAPI.d.ts

@@ -0,0 +1,28 @@
+import DataLoader from 'dataloader';
+import JSONAPIData from '../util/json-api/JSONAPIData';
+interface EnvoyWebDataLoaderKey extends JSONAPIData {
+    include?: string;
+}
+/**
+ * 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: import("axios").AxiosInstance;
+    /**
+     * 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: DataLoader<EnvoyWebDataLoaderKey, any, string>;
+    constructor(accessToken: string);
+}
+export {};
+//# sourceMappingURL=EnvoyAPI.d.ts.map

package/dist/base/EnvoyAPI.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EnvoyAPI.d.ts","sourceRoot":"","sources":["../../src/base/EnvoyAPI.ts"],"names":[],"mappings":"AACA,OAAO,UAAU,MAAM,YAAY,CAAC;AACpC,OAAO,WAAW,MAAM,8BAA8B,CAAC;AAIvD,UAAU,qBAAsB,SAAQ,WAAW;IACjD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAWD;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B;;OAEG;IACH,QAAQ,CAAC,KAAK,gCAUX;IAEH;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,UAAU,iDAU3B;gBAEU,WAAW,EAAE,MAAM;CA0BhC"}

package/dist/base/EnvoyAPI.js

@@ -0,0 +1,121 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var qs_1 = __importDefault(require("qs"));
+var dataloader_1 = __importDefault(require("dataloader"));
+var constants_1 = require("../constants");
+var axiosConstructor_1 = require("../util/axiosConstructor");
+/**
+ * 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.
+ */
+var TYPE_ALIASES = new Map([
+    ['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
+ */
+var EnvoyAPI = /** @class */ (function () {
+    function EnvoyAPI(accessToken) {
+        var _this = this;
+        /**
+         * HTTP Client with Envoy's defaults.
+         */
+        this.axios = axiosConstructor_1.createAxiosClient({
+            baseURL: constants_1.envoyBaseURL,
+            headers: {
+                'Content-Type': 'application/vnd.api+json',
+                Accept: 'application/vnd.api+json',
+            },
+            paramsSerializer: function (params) { return qs_1.default.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).
+         */
+        this.dataLoader = new dataloader_1.default(function (keys) { return Promise.all(keys.map(function (_a) {
+            var type = _a.type, id = _a.id, include = _a.include;
+            return __awaiter(_this, void 0, void 0, function () {
+                var data;
+                return __generator(this, function (_b) {
+                    switch (_b.label) {
+                        case 0: return [4 /*yield*/, this.axios.get("api/v3/" + type + "/" + id, { params: { include: include } })];
+                        case 1:
+                            data = (_b.sent()).data;
+                            return [2 /*return*/, data.data];
+                    }
+                });
+            });
+        })); }, {
+            cacheKeyFn: function (key) { return key.type + "_" + key.id; },
+        });
+        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(function (response) {
+            var _a = response.data, modelOrModels = _a.data, included = _a.included;
+            (included || [])
+                .concat(modelOrModels)
+                .forEach(function (model) {
+                _this.dataLoader.prime({ type: model.type, id: model.id }, model);
+                var alias = TYPE_ALIASES.get(model.type);
+                if (alias) {
+                    _this.dataLoader.prime({ type: alias, id: model.id }, model);
+                }
+            });
+            return response;
+        }, function (error) { return Promise.reject(error); });
+    }
+    return EnvoyAPI;
+}());
+exports.default = EnvoyAPI;

package/dist/base/EnvoyPluginStoragePipeline.d.ts

@@ -0,0 +1,51 @@
+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);
+    /**
+     * Executes all the commands in the pipeline.
+     */
+    execute<Result extends EnvoyStorageResult = EnvoyStorageResult>(): Promise<Array<Result>>;
+    /**
+     * Executes the pipeline and returns the first result.
+     */
+    executeSingle<Result extends EnvoyStorageResult = EnvoyStorageResult>(): Promise<Result>;
+    addCommand(command: EnvoyStorageCommand): EnvoyPluginStoragePipeline;
+    /**
+     * Gets a storage item.
+     */
+    get(key: string): EnvoyPluginStoragePipeline;
+    /**
+     * Sets a value for a storage item,
+     * and returns that item.
+     */
+    set(key: string, value: unknown): EnvoyPluginStoragePipeline;
+    /**
+     * Sets a unique value for a storage item,
+     * and returns that item.
+     */
+    setUnique(key: string, options?: EnvoyStorageSetUniqueOptions): EnvoyPluginStoragePipeline;
+    /**
+     * Sets a unique number value for a storage item,
+     * and returns that item.
+     */
+    setUniqueNum(key: string, options?: EnvoyStorageSetUniqueNumOptions): EnvoyPluginStoragePipeline;
+    /**
+     * Unsets a storage item.
+     */
+    unset(key: string): EnvoyPluginStoragePipeline;
+    /**
+     * Lists storage items.
+     */
+    list(page?: number): EnvoyPluginStoragePipeline;
+}
+//# sourceMappingURL=EnvoyPluginStoragePipeline.d.ts.map

package/dist/base/EnvoyPluginStoragePipeline.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EnvoyPluginStoragePipeline.d.ts","sourceRoot":"","sources":["../../src/base/EnvoyPluginStoragePipeline.ts"],"names":[],"mappings":"AAAA,OAAO,mBAAmB,EAAE,EAC1B,+BAA+B,EAC/B,4BAA4B,EAC7B,MAAM,iCAAiC,CAAC;AACzC,OAAO,kBAAkB,MAAM,gCAAgC,CAAC;AAChE,OAAO,cAAc,MAAM,uBAAuB,CAAC;AAEnD;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,0BAA0B;IAC7C,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC;IAEvC,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAEvC,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;gBAE5C,SAAS,EAAE,cAAc,EAAE,SAAS,CAAC,EAAE,MAAM;IAMzD;;OAEG;IACH,OAAO,CAAC,MAAM,SAAS,kBAAkB,GAAG,kBAAkB,KAAK,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAIzF;;OAEG;IACG,aAAa,CAAC,MAAM,SAAS,kBAAkB,GAAG,kBAAkB,KAAK,OAAO,CAAC,MAAM,CAAC;IAK9F,UAAU,CAAC,OAAO,EAAE,mBAAmB,GAAG,0BAA0B;IAKpE;;OAEG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,0BAA0B;IAI5C;;;OAGG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,0BAA0B;IAI5D;;;OAGG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,4BAAiC,GAAG,0BAA0B;IAI9F;;;OAGG;IACH,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,+BAAoC,GAAG,0BAA0B;IAUpG;;OAEG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,0BAA0B;IAI9C;;OAEG;IACH,IAAI,CAAC,IAAI,SAAI,GAAG,0BAA0B;CAM3C"}

package/dist/base/EnvoyPluginStoragePipeline.js

@@ -0,0 +1,140 @@
+"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 __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Builds up a request pipeline for submitting storage commands.
+ *
+ * @category Base
+ */
+var EnvoyPluginStoragePipeline = /** @class */ (function () {
+    function EnvoyPluginStoragePipeline(pluginAPI, installId) {
+        this.api = pluginAPI;
+        this.installId = installId;
+        this.commands = [];
+    }
+    /**
+     * Executes all the commands in the pipeline.
+     */
+    EnvoyPluginStoragePipeline.prototype.execute = function () {
+        return this.api.storagePipeline(this.commands, this.installId);
+    };
+    /**
+     * Executes the pipeline and returns the first result.
+     */
+    EnvoyPluginStoragePipeline.prototype.executeSingle = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var result;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.execute()];
+                    case 1:
+                        result = (_a.sent())[0];
+                        return [2 /*return*/, result];
+                }
+            });
+        });
+    };
+    EnvoyPluginStoragePipeline.prototype.addCommand = function (command) {
+        this.commands.push(command);
+        return this;
+    };
+    /**
+     * Gets a storage item.
+     */
+    EnvoyPluginStoragePipeline.prototype.get = function (key) {
+        return this.addCommand({ action: 'get', key: key });
+    };
+    /**
+     * Sets a value for a storage item,
+     * and returns that item.
+     */
+    EnvoyPluginStoragePipeline.prototype.set = function (key, value) {
+        return this.addCommand({ action: 'set', key: key, value: value });
+    };
+    /**
+     * Sets a unique value for a storage item,
+     * and returns that item.
+     */
+    EnvoyPluginStoragePipeline.prototype.setUnique = function (key, options) {
+        if (options === void 0) { options = {}; }
+        return this.addCommand(__assign({ action: 'set_unique', key: key }, options));
+    };
+    /**
+     * Sets a unique number value for a storage item,
+     * and returns that item.
+     */
+    EnvoyPluginStoragePipeline.prototype.setUniqueNum = function (key, options) {
+        if (options === void 0) { options = {}; }
+        if (options.min) {
+            options.min = Number(options.min);
+        }
+        if (options.max) {
+            options.max = Number(options.max);
+        }
+        return this.addCommand(__assign({ action: 'set_unique_num', key: key }, options));
+    };
+    /**
+     * Unsets a storage item.
+     */
+    EnvoyPluginStoragePipeline.prototype.unset = function (key) {
+        return this.addCommand({ action: 'unset', key: key });
+    };
+    /**
+     * Lists storage items.
+     */
+    EnvoyPluginStoragePipeline.prototype.list = function (page) {
+        if (page === void 0) { page = 1; }
+        if (!page) {
+            page = 1;
+        }
+        return this.addCommand({ action: 'list', page: page });
+    };
+    return EnvoyPluginStoragePipeline;
+}());
+exports.default = EnvoyPluginStoragePipeline;

package/dist/constants.d.ts

@@ -0,0 +1,5 @@
+export declare const envoyBaseURL: string;
+export declare const envoyClientId: string;
+export declare const envoyClientSecret: string;
+export declare const jwtSecret: string;
+//# sourceMappingURL=constants.d.ts.map