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

package/dist/sdk/EnvoyPluginJob.js

@@ -0,0 +1,99 @@
+"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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * A "job" is an event, like `entry_sign_in`.
+ * When your plugin handles the event, you can use this job concept
+ * to update the status (e.g. complete, failed, ignored)
+ * as well as attach extra data to the event's subject
+ * (e.g. showing a generated card number in the dashboard for a visitor on `entry_sign_in`).
+ *
+ * @category Request Object
+ */
+var EnvoyPluginJob = /** @class */ (function () {
+    function EnvoyPluginJob(pluginAPI, jobId) {
+        this.api = pluginAPI;
+        this.id = jobId;
+    }
+    EnvoyPluginJob.prototype.execute = function (status, message, reason, attachments) {
+        if (attachments === void 0) { attachments = []; }
+        var updates = {
+            attachments: attachments.map(function (attachment) { return (__assign({ type: 'text' }, attachment)); }),
+        };
+        if (status) {
+            Object.assign(updates, { status: status });
+        }
+        if (message) {
+            Object.assign(updates, { status_message: message });
+        }
+        if (reason) {
+            Object.assign(updates, { failure_reason: reason });
+        }
+        return this.api.updateJob(this.id, updates);
+    };
+    /**
+     * Add attachments to this job.
+     */
+    EnvoyPluginJob.prototype.attach = function () {
+        var attachments = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            attachments[_i] = arguments[_i];
+        }
+        return this.execute(null, null, null, attachments);
+    };
+    /**
+     * Reports that the job is complete.
+     *
+     * Instead of calling this directly, you can return a 200 response from the job's event handler,
+     * using {@link EnvoyRequest.send}.
+     */
+    EnvoyPluginJob.prototype.complete = function (message) {
+        var attachments = [];
+        for (var _i = 1; _i < arguments.length; _i++) {
+            attachments[_i - 1] = arguments[_i];
+        }
+        return this.execute('done', message, null, attachments);
+    };
+    /**
+     * Reports that the job is ignored.
+     *
+     * Instead of calling this directly, you can return a 400 response from the job's event handler,
+     * using {@link EnvoyRequest.sendIgnored}.
+     */
+    EnvoyPluginJob.prototype.ignore = function (message, reason) {
+        return this.execute('ignored', message, reason);
+    };
+    /**
+     * Reports that the job is ignored.
+     *
+     * Instead of calling this directly, you can return a 400 response from the job's event handler,
+     * using {@link EnvoyRequest.sendFailed}.
+     */
+    EnvoyPluginJob.prototype.fail = function (message, reason) {
+        return this.execute('failed', message, reason);
+    };
+    /**
+     * Updates the job with a new message and attachments.
+     *
+     * Can be used to periodically update long-running jobs.
+     */
+    EnvoyPluginJob.prototype.update = function (message) {
+        var attachments = [];
+        for (var _i = 1; _i < arguments.length; _i++) {
+            attachments[_i - 1] = arguments[_i];
+        }
+        return this.execute(null, message, null, attachments);
+    };
+    return EnvoyPluginJob;
+}());
+exports.default = EnvoyPluginJob;

package/dist/sdk/EnvoyPluginJobAttachment.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Display some text in Envoy's dashboard.
+ *
+ * @category Attachment
+ */
+export interface EnvoyPluginTextJobAttachment {
+    type?: 'text' | 'password' | string;
+    label: string;
+    value: string;
+}
+/**
+ * Display a link in Envoy's dashboard.
+ *
+ * @category Attachment
+ */
+export interface EnvoyPluginLinkJobAttachment extends EnvoyPluginTextJobAttachment {
+    type: 'link';
+    url: string;
+}
+/**
+ * Display a credential in Envoy's dashboard,
+ * and include the credential's image in the invitee's welcome email.
+ *
+ * @category Attachment
+ */
+export interface EnvoyPluginCredentialJobAttachment extends EnvoyPluginTextJobAttachment {
+    type: 'credential_image';
+    title: string;
+    image: {
+        type: 's3';
+        link: string;
+    };
+}
+/**
+ * Attachments to jobs, which will be displayed in the Envoy dashboard.
+ * Some attachments like `credential_image` can show up in other places,
+ * like an invitee's welcome email.
+ *
+ * @category Attachment
+ */
+declare type EnvoyPluginJobAttachment = EnvoyPluginTextJobAttachment | EnvoyPluginLinkJobAttachment | EnvoyPluginCredentialJobAttachment;
+export default EnvoyPluginJobAttachment;
+//# sourceMappingURL=EnvoyPluginJobAttachment.d.ts.map

package/dist/sdk/EnvoyPluginJobAttachment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EnvoyPluginJobAttachment.d.ts","sourceRoot":"","sources":["../../src/sdk/EnvoyPluginJobAttachment.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,CAAC;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA6B,SAAQ,4BAA4B;IAChF,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;;;GAKG;AACH,MAAM,WAAW,kCAAmC,SAAQ,4BAA4B;IACtF,IAAI,EAAE,kBAAkB,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE;QACL,IAAI,EAAE,IAAI,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH;AAED;;;;;;GAMG;AACH,aAAK,wBAAwB,GAAG,4BAA4B,GAC1D,4BAA4B,GAC5B,kCAAkC,CAAC;AAErC,eAAe,wBAAwB,CAAC"}

package/dist/sdk/EnvoyPluginJobAttachment.js

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

package/dist/sdk/EnvoyPluginSDK.d.ts

@@ -0,0 +1,100 @@
+import EnvoyPluginStorage from './EnvoyPluginStorage';
+import EnvoyPluginJob from './EnvoyPluginJob';
+import EnvoyJWT from '../util/EnvoyJWT';
+import EnvoyUserAPI from './EnvoyUserAPI';
+import EnvoyPluginAPI from './EnvoyPluginAPI';
+/**
+ * Every Envoy request has a `meta` and `payload`.
+ * @category Request
+ */
+export interface EnvoyRequestBody<Meta, Payload> {
+    meta: Meta;
+    payload: Payload;
+}
+/**
+ * Sets up all relevant Envoy functions.
+ * Attaches itself to every request object using our {@link middleware},
+ * to allow for easy access to Envoy functions.
+ *
+ * @category SDK
+ */
+export default class EnvoyPluginSDK<Meta = unknown, Payload = unknown> {
+    /**
+     * Body of the request.
+     * use `meta` or `payload` to access the relevant properties,
+     * instead of this directly.
+     */
+    private readonly body;
+    /**
+     * Verified that the request comes from Envoy.
+     */
+    private readonly isVerified;
+    /**
+     * The internally managed plugin access token.
+     * Use the `pluginAPI` instead of this directly.
+     */
+    private readonly pluginAccessToken;
+    /**
+     * Don't create an instance of this class directly.
+     *
+     * Instead, use {@link middleware} to automatically attach an instance to `req` on every request.
+     * @param body - Request body
+     * @param isVerified - If the request has been verified via {@link EnvoySignatureVerifier}
+     * @param pluginAccessToken - An access token from {@link EnvoyPluginAPI.loginAsPlugin}
+     */
+    constructor(body: EnvoyRequestBody<Meta, Payload>, isVerified?: boolean, pluginAccessToken?: string | null);
+    /**
+     * The metadata for the request.
+     * Either an {@link EnvoyEventMeta}} or {@link EnvoyRouteMeta}.
+     */
+    get meta(): Meta;
+    /**
+     * The payload for the request.
+     * For events, it's some Envoy event payload, like an {@link EntryPayload} or {@link InvitePayload}.
+     * For setup step validation URLs, it's the form submitted values for a validation URL.
+     */
+    get payload(): Payload;
+    /**
+     * Envoy API scoped to the user.
+     * Used only in routes.
+     */
+    get userAPI(): EnvoyUserAPI;
+    /**
+     * Envoy API scoped to the plugin.
+     * Used to perform storage or job operations.
+     */
+    get pluginAPI(): EnvoyPluginAPI;
+    /**
+     * A function that returns an instance of EnvoyPluginStorage,
+     * optionally scoped to an install ID.
+     *
+     * Use {@link installStorage} or {@link globalStorage} instead of this directly.
+     */
+    private get getStorage();
+    /**
+     * Storage scoped to the install.
+     */
+    get installStorage(): EnvoyPluginStorage;
+    /**
+     * Storage scoped globally (across installs).
+     */
+    get globalStorage(): EnvoyPluginStorage;
+    /**
+     * Returns a job based on an ID.
+     */
+    get getJob(): (jobId: string) => EnvoyPluginJob;
+    /**
+     * Returns the current job's ID.
+     */
+    get jobId(): string | null;
+    /**
+     * Perform operations on the current job.
+     */
+    get job(): EnvoyPluginJob;
+    /**
+     * A utility to encode and decode JWTs.
+     * Useful for verifiable communications between plugin endpoints.
+     */
+    get jwt(): EnvoyJWT;
+}
+//# sourceMappingURL=EnvoyPluginSDK.d.ts.map

package/dist/sdk/EnvoyPluginSDK.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EnvoyPluginSDK.d.ts","sourceRoot":"","sources":["../../src/sdk/EnvoyPluginSDK.ts"],"names":[],"mappings":"AACA,OAAO,kBAAkB,MAAM,sBAAsB,CAAC;AACtD,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,QAAQ,MAAM,kBAAkB,CAAC;AACxC,OAAO,YAAY,MAAM,gBAAgB,CAAC;AAC1C,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAK9C;;;GAGG;AACH,MAAM,WAAW,gBAAgB,CAAC,IAAI,EAAE,OAAO;IAC7C,IAAI,EAAE,IAAI,CAAC;IACX,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,OAAO,cAAc,CAAC,IAAI,GAAG,OAAO,EAAE,OAAO,GAAG,OAAO;IACnE;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAkC;IAEvD;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAU;IAErC;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAuB;IAEzD;;;;;;;OAOG;gBACS,IAAI,EAAE,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,UAAU,UAAQ,EAAE,iBAAiB,GAAE,MAAM,GAAG,IAAW;IAM9G;;;OAGG;IACH,IAAI,IAAI,IAAI,IAAI,CAKf;IAED;;;;OAIG;IACH,IAAI,OAAO,IAAI,OAAO,CAarB;IAED;;;OAGG;IACH,IAAI,OAAO,IAAI,YAAY,CAW1B;IAED;;;OAGG;IACH,IAAI,SAAS,IAAI,cAAc,CAM9B;IAED;;;;;OAKG;IACH,OAAO,KAAK,UAAU,GAErB;IAED;;OAEG;IACH,IAAI,cAAc,IAAI,kBAAkB,CAMvC;IAED;;OAEG;IACH,IAAI,aAAa,IAAI,kBAAkB,CAEtC;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,CAAC,KAAK,EAAE,MAAM,KAAK,cAAc,CAE9C;IAED;;OAEG;IACH,IAAI,KAAK,IAAI,MAAM,GAAG,IAAI,CAMzB;IAED;;OAEG;IACH,IAAI,GAAG,IAAI,cAAc,CAMxB;IAED;;;OAGG;IAEH,IAAI,GAAG,IAAI,QAAQ,CAElB;CACF"}

package/dist/sdk/EnvoyPluginSDK.js

@@ -0,0 +1,204 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var EnvoyPluginStorage_1 = __importDefault(require("./EnvoyPluginStorage"));
+var EnvoyPluginJob_1 = __importDefault(require("./EnvoyPluginJob"));
+var EnvoyJWT_1 = __importDefault(require("../util/EnvoyJWT"));
+var EnvoyUserAPI_1 = __importDefault(require("./EnvoyUserAPI"));
+var EnvoyPluginAPI_1 = __importDefault(require("./EnvoyPluginAPI"));
+var EntryPayload_1 = require("../payloads/EntryPayload");
+var InvitePayload_1 = require("../payloads/InvitePayload");
+/**
+ * Sets up all relevant Envoy functions.
+ * Attaches itself to every request object using our {@link middleware},
+ * to allow for easy access to Envoy functions.
+ *
+ * @category SDK
+ */
+var EnvoyPluginSDK = /** @class */ (function () {
+    /**
+     * Don't create an instance of this class directly.
+     *
+     * Instead, use {@link middleware} to automatically attach an instance to `req` on every request.
+     * @param body - Request body
+     * @param isVerified - If the request has been verified via {@link EnvoySignatureVerifier}
+     * @param pluginAccessToken - An access token from {@link EnvoyPluginAPI.loginAsPlugin}
+     */
+    function EnvoyPluginSDK(body, isVerified, pluginAccessToken) {
+        if (isVerified === void 0) { isVerified = false; }
+        if (pluginAccessToken === void 0) { pluginAccessToken = null; }
+        /**
+         * The internally managed plugin access token.
+         * Use the `pluginAPI` instead of this directly.
+         */
+        this.pluginAccessToken = null;
+        this.body = body;
+        this.isVerified = isVerified;
+        this.pluginAccessToken = pluginAccessToken;
+    }
+    Object.defineProperty(EnvoyPluginSDK.prototype, "meta", {
+        /**
+         * The metadata for the request.
+         * Either an {@link EnvoyEventMeta}} or {@link EnvoyRouteMeta}.
+         */
+        get: function () {
+            if (!this.isVerified) {
+                throw new Error('Could not verify meta.');
+            }
+            return this.body.meta;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(EnvoyPluginSDK.prototype, "payload", {
+        /**
+         * The payload for the request.
+         * For events, it's some Envoy event payload, like an {@link EntryPayload} or {@link InvitePayload}.
+         * For setup step validation URLs, it's the form submitted values for a validation URL.
+         */
+        get: function () {
+            if (!this.isVerified) {
+                throw new Error('Could not verify payload.');
+            }
+            var payload = this.body.payload;
+            switch (payload.type) {
+                case 'entries':
+                    return EntryPayload_1.normalizeEntryPayload(payload);
+                case 'invites':
+                    return InvitePayload_1.normalizeInvitePayload(payload);
+                default:
+                    return payload;
+            }
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(EnvoyPluginSDK.prototype, "userAPI", {
+        /**
+         * Envoy API scoped to the user.
+         * Used only in routes.
+         */
+        get: function () {
+            var meta = this.meta;
+            var auth = meta.auth;
+            var accessToken = auth === null || auth === void 0 ? void 0 : auth.access_token;
+            if (!accessToken && ('forwarded_bearer_token' in meta)) {
+                accessToken = meta.forwarded_bearer_token;
+            }
+            if (!accessToken) {
+                throw new Error("This user's API token was not found. Either no scopes were asked for, or this is a route.");
+            }
+            return new EnvoyUserAPI_1.default(accessToken);
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(EnvoyPluginSDK.prototype, "pluginAPI", {
+        /**
+         * Envoy API scoped to the plugin.
+         * Used to perform storage or job operations.
+         */
+        get: function () {
+            var pluginAccessToken = this.pluginAccessToken;
+            if (!pluginAccessToken) {
+                throw new Error('No API token found. Are your Envoy client ID and secret set?');
+            }
+            return new EnvoyPluginAPI_1.default(pluginAccessToken);
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(EnvoyPluginSDK.prototype, "getStorage", {
+        /**
+         * A function that returns an instance of EnvoyPluginStorage,
+         * optionally scoped to an install ID.
+         *
+         * Use {@link installStorage} or {@link globalStorage} instead of this directly.
+         */
+        get: function () {
+            var _this = this;
+            return function (installId) { return new EnvoyPluginStorage_1.default(_this.pluginAPI, installId); };
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(EnvoyPluginSDK.prototype, "installStorage", {
+        /**
+         * Storage scoped to the install.
+         */
+        get: function () {
+            var installId = this.meta.install_id;
+            if (!installId) {
+                throw new Error('No install ID found in meta.');
+            }
+            return this.getStorage(installId);
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(EnvoyPluginSDK.prototype, "globalStorage", {
+        /**
+         * Storage scoped globally (across installs).
+         */
+        get: function () {
+            return this.getStorage();
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(EnvoyPluginSDK.prototype, "getJob", {
+        /**
+         * Returns a job based on an ID.
+         */
+        get: function () {
+            var _this = this;
+            return function (jobId) { return new EnvoyPluginJob_1.default(_this.pluginAPI, jobId); };
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(EnvoyPluginSDK.prototype, "jobId", {
+        /**
+         * Returns the current job's ID.
+         */
+        get: function () {
+            var meta = this.meta;
+            if ('job' in meta) {
+                return meta.job.id;
+            }
+            return null;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(EnvoyPluginSDK.prototype, "job", {
+        /**
+         * Perform operations on the current job.
+         */
+        get: function () {
+            var jobId = this.jobId;
+            if (!jobId) {
+                throw new Error('No job found in meta. Are you in a worker?');
+            }
+            return this.getJob(jobId);
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(EnvoyPluginSDK.prototype, "jwt", {
+        /**
+         * A utility to encode and decode JWTs.
+         * Useful for verifiable communications between plugin endpoints.
+         */
+        // eslint-disable-next-line class-methods-use-this
+        get: function () {
+            return new EnvoyJWT_1.default();
+        },
+        enumerable: false,
+        configurable: true
+    });
+    return EnvoyPluginSDK;
+}());
+exports.default = EnvoyPluginSDK;

package/dist/sdk/EnvoyPluginStorage.d.ts

@@ -0,0 +1,69 @@
+import EnvoyPluginStoragePipeline from '../base/EnvoyPluginStoragePipeline';
+import { EnvoyStorageSetUniqueNumOptions, EnvoyStorageSetUniqueOptions } from '../internal/EnvoyStorageCommand';
+import EnvoyStorageItem from './EnvoyStorageItem';
+import EnvoyPluginAPI from './EnvoyPluginAPI';
+/**
+ * A key-value storage that can be scoped to a specific install,
+ * or to the plugin itself.
+ *
+ * @category Storage
+ * @category Request Object
+ */
+export default class EnvoyPluginStorage {
+    protected readonly api: EnvoyPluginAPI;
+    readonly installId: string | undefined;
+    constructor(pluginAPI: EnvoyPluginAPI, installId?: string);
+    /**
+     * Creates a new pipeline instance.
+     */
+    pipeline(): EnvoyPluginStoragePipeline;
+    /**
+     * Gets a single {@link EnvoyStorageItem} from storage.
+     *
+     * Wrapper for single pipeline get.
+     */
+    get<Value = unknown>(key: string): Promise<EnvoyStorageItem<Value> | {
+        key: string;
+        value: undefined;
+    }>;
+    /**
+     * Sets a single {@link EnvoyStorageItem} from storage.
+     *
+     * Wrapper for single pipeline set.
+     */
+    set<Value = unknown>(key: string, value: Value): Promise<EnvoyStorageItem<Value>>;
+    /**
+     * Sets a single unique string {@link EnvoyStorageItem} from storage.
+     *
+     * Wrapper for single pipeline setUnique.
+     */
+    setUnique(key: string, options?: EnvoyStorageSetUniqueOptions): Promise<EnvoyStorageItem<string> | {
+        key: string;
+        value: undefined;
+    }>;
+    /**
+     * Sets a single unique number {@link EnvoyStorageItem} from storage.
+     *
+     * Wrapper for single pipeline setUnique.
+     */
+    setUniqueNum(key: string, options?: EnvoyStorageSetUniqueNumOptions): Promise<EnvoyStorageItem<number> | {
+        key: string;
+        value: undefined;
+    }>;
+    /**
+     * Unsets an {@link EnvoyStorageItem} from storage. Returns null if the item did not previously exist.
+     *
+     * Wrapper for single pipeline unset.
+     */
+    unset<Value = unknown>(key: string): Promise<EnvoyStorageItem<Value> | {
+        key: string;
+        value: undefined;
+    }>;
+    /**
+     * Returns an array of {@link EnvoyStorageItem} from storage.
+     *
+     * Wrapper for single pipeline list.
+     */
+    list<Value = unknown>(page?: number): Promise<EnvoyStorageItem<Value>[]>;
+}
+//# sourceMappingURL=EnvoyPluginStorage.d.ts.map

package/dist/sdk/EnvoyPluginStorage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EnvoyPluginStorage.d.ts","sourceRoot":"","sources":["../../src/sdk/EnvoyPluginStorage.ts"],"names":[],"mappings":"AAAA,OAAO,0BAA0B,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,+BAA+B,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AAChH,OAAO,gBAAgB,MAAM,oBAAoB,CAAC;AAClD,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAE9C;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,OAAO,kBAAkB;IACrC,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC;IAEvC,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;gBAE3B,SAAS,EAAE,cAAc,EAAE,SAAS,CAAC,EAAE,MAAM;IAKzD;;OAEG;IACH,QAAQ,IAAI,0BAA0B;IAItC;;;;OAIG;IACH,GAAG,CAAC,KAAK,GAAG,OAAO,EAAE,GAAG,EAAE,MAAM;aACiD,MAAM;eAAW,SAAS;;IAG3G;;;;OAIG;IACH,GAAG,CAAC,KAAK,GAAG,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK;IAI9C;;;;OAIG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,4BAAiC;aACgC,MAAM;eAAW,SAAS;;IAG3H;;;;OAIG;IACH,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,+BAAoC;aAC6B,MAAM;eAAW,SAAS;;IAG9H;;;;OAIG;IACH,KAAK,CAAC,KAAK,GAAG,OAAO,EAAE,GAAG,EAAE,MAAM;aACiD,MAAM;eAAW,SAAS;;IAG7G;;;;OAIG;IACH,IAAI,CAAC,KAAK,GAAG,OAAO,EAAE,IAAI,SAAI;CAG/B"}

package/dist/sdk/EnvoyPluginStorage.js

@@ -0,0 +1,78 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var EnvoyPluginStoragePipeline_1 = __importDefault(require("../base/EnvoyPluginStoragePipeline"));
+/**
+ * A key-value storage that can be scoped to a specific install,
+ * or to the plugin itself.
+ *
+ * @category Storage
+ * @category Request Object
+ */
+var EnvoyPluginStorage = /** @class */ (function () {
+    function EnvoyPluginStorage(pluginAPI, installId) {
+        this.api = pluginAPI;
+        this.installId = installId;
+    }
+    /**
+     * Creates a new pipeline instance.
+     */
+    EnvoyPluginStorage.prototype.pipeline = function () {
+        return new EnvoyPluginStoragePipeline_1.default(this.api, this.installId);
+    };
+    /**
+     * Gets a single {@link EnvoyStorageItem} from storage.
+     *
+     * Wrapper for single pipeline get.
+     */
+    EnvoyPluginStorage.prototype.get = function (key) {
+        return this.pipeline().get(key).executeSingle();
+    };
+    /**
+     * Sets a single {@link EnvoyStorageItem} from storage.
+     *
+     * Wrapper for single pipeline set.
+     */
+    EnvoyPluginStorage.prototype.set = function (key, value) {
+        return this.pipeline().set(key, value).executeSingle();
+    };
+    /**
+     * Sets a single unique string {@link EnvoyStorageItem} from storage.
+     *
+     * Wrapper for single pipeline setUnique.
+     */
+    EnvoyPluginStorage.prototype.setUnique = function (key, options) {
+        if (options === void 0) { options = {}; }
+        return this.pipeline().setUnique(key, options).executeSingle();
+    };
+    /**
+     * Sets a single unique number {@link EnvoyStorageItem} from storage.
+     *
+     * Wrapper for single pipeline setUnique.
+     */
+    EnvoyPluginStorage.prototype.setUniqueNum = function (key, options) {
+        if (options === void 0) { options = {}; }
+        return this.pipeline().setUniqueNum(key, options).executeSingle();
+    };
+    /**
+     * Unsets an {@link EnvoyStorageItem} from storage. Returns null if the item did not previously exist.
+     *
+     * Wrapper for single pipeline unset.
+     */
+    EnvoyPluginStorage.prototype.unset = function (key) {
+        return this.pipeline().unset(key).executeSingle();
+    };
+    /**
+     * Returns an array of {@link EnvoyStorageItem} from storage.
+     *
+     * Wrapper for single pipeline list.
+     */
+    EnvoyPluginStorage.prototype.list = function (page) {
+        if (page === void 0) { page = 1; }
+        return this.pipeline().list(page).executeSingle();
+    };
+    return EnvoyPluginStorage;
+}());
+exports.default = EnvoyPluginStorage;