@qualtrics/plugin-client 1.8.19

package/create-npm-package.js

@@ -0,0 +1,39 @@
+#!/usr/bin/env node
+
+/**
+ * Create a valid package.json file by merging the base package.json with an
+ * overlay.
+ *
+ * Also inject the correct version.
+ */
+
+const overlay = {
+  private: false,
+  main: 'src/lib/plugin/index.js',
+  types: 'src/lib/plugin/index.d.ts',
+  files: ['src'],
+}
+
+const version = require('../plugin-sdk/webpackConstants').CLIENT_VERSION
+
+const JSON_INDENT_SPACES = 2
+
+const fs = require('fs')
+
+const src = `${__dirname}`
+const dest = `${src}/dist`
+
+// Write package.json
+const basePackage = JSON.parse(fs.readFileSync(`${src}/package.json`).toString())
+const pkgJson = Object.assign({}, basePackage, overlay, {version})
+
+fs.writeFileSync(`${dest}/package.json`, JSON.stringify(pkgJson, null, JSON_INDENT_SPACES))
+
+fs.access(`${dest}/src/lib/host`, fs.constants.R_OK, (err) => {
+  if (!err) {
+    process.stderr.write(
+      `Error: Client package includes lib/host! This bloats the package unnecessarily.\n`,
+    )
+    process.exit(1)
+  }
+})

package/dist/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@qualtrics/plugin-client",
+  "description": "Interface for XM Plugins to communicate with the environment they're rendered in",
+  "scripts": {
+    "ci-build": "yarn clean && yarn build",
+    "build": "tspc && ./create-npm-package.js && depcheck dist",
+    "clean": "rm -rf dist"
+  },
+  "repository": {
+    "type": "git",
+    "url": "ssh://git@gitlab-app.eng.qops.net:10022/developer-platform/app-framework/plugin-sdk.git"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "depcheck": "1.4.7",
+    "ts-patch": "3.1.2"
+  },
+  "dependencies": {
+    "fp-ts": "^2.10.5",
+    "io-ts": "^2.2.16",
+    "lodash": "^4.17.21"
+  },
+  "main": "src/lib/plugin/index.js",
+  "types": "src/lib/plugin/index.d.ts",
+  "private": false,
+  "files": [
+    "src"
+  ]
+}

package/dist/src/constants.d.ts

@@ -0,0 +1,12 @@
+export declare const CONNECTION_SCHEMES: Readonly<{
+    API_KEY: "apikey";
+    BASIC: "basic";
+    OAUTH: "oauth2";
+    SFTP: "sftp";
+    ADOBE: "adobe";
+    OAUTH_CLIENT_JWT: "oauth2ClientJWT";
+    AWSSIGV4: "awsSigV4";
+    SUCCESS_FACTORS: "successfactors";
+    INTERNAL: "internal";
+    NONE: "none";
+}>;

package/dist/src/constants.js

@@ -0,0 +1,21 @@
+// All current connection schemes supported by App Framework
+export var CONNECTION_SCHEMES = Object.freeze({
+    API_KEY: 'apikey',
+    BASIC: 'basic',
+    OAUTH: 'oauth2',
+    SFTP: 'sftp',
+    ADOBE: 'adobe',
+    OAUTH_CLIENT_JWT: 'oauth2ClientJWT',
+    AWSSIGV4: 'awsSigV4',
+    // NOTE: The successfactors scheme is NOT recognized by the credential service. It
+    // instead uses the oauth2ClientSAML scheme under the hood.
+    SUCCESS_FACTORS: 'successfactors',
+    // NOTE: The internal scheme is NOT recognized by the credential service. It
+    // is only for use by first-party apps, to access UDS endpoints.
+    // See APP-1290.
+    INTERNAL: 'internal',
+    // NOTE: The none scheme is NOT recognized by the credential service. It
+    // instead uses the mtls scheme under the hood.
+    NONE: 'none',
+});
+//# sourceMappingURL=constants.js.map

package/dist/src/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../plugin-sdk/src/constants.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,MAAM,CAAC,IAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC9C,OAAO,EAAE,QAAQ;IACjB,KAAK,EAAE,OAAO;IACd,KAAK,EAAE,QAAQ;IACf,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;IACd,gBAAgB,EAAE,iBAAiB;IACnC,QAAQ,EAAE,UAAU;IAEpB,kFAAkF;IAClF,2DAA2D;IAC3D,eAAe,EAAE,gBAAgB;IAEjC,4EAA4E;IAC5E,gEAAgE;IAChE,gBAAgB;IAChB,QAAQ,EAAE,UAAU;IAEpB,wEAAwE;IACxE,+CAA+C;IAC/C,IAAI,EAAE,MAAM;CACb,CAAC,CAAA"}

package/dist/src/deferred.d.ts

@@ -0,0 +1,6 @@
+export declare class Deferred<T> {
+    readonly promise: Promise<T>;
+    readonly resolve: (value: T) => void;
+    readonly reject: (reason: unknown) => void;
+    constructor();
+}

package/dist/src/deferred.js

@@ -0,0 +1,28 @@
+// Deferred represents a Promise and its associated resolve and reject
+// functions.
+//
+// Deferreds should always be private, since they allow changing the contained
+// Promise. Callers interested in the values should be given access to the
+// Promise only.
+var Deferred = /** @class */ (function () {
+    function Deferred() {
+        var resolve = undefined;
+        var reject = undefined;
+        var promise = new Promise(function (res, rej) {
+            resolve = res;
+            reject = rej;
+        });
+        if (!resolve) {
+            throw new Error("resolve wasn't set!");
+        }
+        if (!reject) {
+            throw new Error("reject wasn't set!");
+        }
+        this.promise = promise;
+        this.resolve = resolve;
+        this.reject = reject;
+    }
+    return Deferred;
+}());
+export { Deferred };
+//# sourceMappingURL=deferred.js.map

package/dist/src/deferred.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deferred.js","sourceRoot":"","sources":["../../../plugin-sdk/src/deferred.ts"],"names":[],"mappings":"AAAA,sEAAsE;AACtE,aAAa;AACb,EAAE;AACF,8EAA8E;AAC9E,0EAA0E;AAC1E,gBAAgB;AAEhB;IAKE;QACE,IAAI,OAAO,GAAuD,SAAS,CAAA;QAC3E,IAAI,MAAM,GAA4C,SAAS,CAAA;QAC/D,IAAM,OAAO,GAAG,IAAI,OAAO,CAAI,UAAC,GAAG,EAAE,GAAG;YACtC,OAAO,GAAG,GAAG,CAAA;YACb,MAAM,GAAG,GAAG,CAAA;QACd,CAAC,CAAC,CAAA;QACF,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAA;QACxC,CAAC;QACD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAA;QACvC,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IACH,eAAC;AAAD,CAAC,AAtBD,IAsBC"}

package/dist/src/errors/encoder.d.ts

@@ -0,0 +1,15 @@
+declare enum knownErrorTypes {
+    fetchError = "fetchError",
+    egressServiceError = "egressServiceError",
+    egressUnexpectedResponseError = "egressUnexpectedResponseError",
+    timeoutError = "timeoutError"
+}
+export type EncodedError = {
+    message: string;
+    props: Partial<Record<string, string>>;
+    errorType?: knownErrorTypes;
+};
+export declare function isEncodedError(u: unknown): u is EncodedError;
+export declare function encodeError(e: Error): EncodedError;
+export declare function decodeError(e: EncodedError): Error;
+export {};

package/dist/src/errors/encoder.js

@@ -0,0 +1,130 @@
+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);
+};
+import { EgressServiceError, EgressUnexpectedResponseError, FetchError, TimeoutError, } from "./errorTypes";
+var knownErrorTypes;
+(function (knownErrorTypes) {
+    knownErrorTypes["fetchError"] = "fetchError";
+    knownErrorTypes["egressServiceError"] = "egressServiceError";
+    knownErrorTypes["egressUnexpectedResponseError"] = "egressUnexpectedResponseError";
+    knownErrorTypes["timeoutError"] = "timeoutError";
+})(knownErrorTypes || (knownErrorTypes = {}));
+function getErrorType(e) {
+    if (e instanceof FetchError)
+        return knownErrorTypes.fetchError;
+    if (e instanceof EgressServiceError)
+        return knownErrorTypes.egressServiceError;
+    if (e instanceof EgressUnexpectedResponseError)
+        return knownErrorTypes.egressUnexpectedResponseError;
+    if (e instanceof TimeoutError)
+        return knownErrorTypes.timeoutError;
+    return undefined;
+}
+export function isEncodedError(u) {
+    if (!u || typeof u !== 'object')
+        return false;
+    var o = u;
+    if (!('message' in o))
+        return false;
+    if (typeof o.message !== 'string')
+        return false;
+    if ('errorType' in o && typeof o.errorType !== 'string')
+        return false;
+    if (!('props' in o))
+        return false;
+    if (!o.props)
+        return false;
+    if (typeof o.props !== 'object')
+        return false;
+    return true;
+}
+function isEncodedFetchError(u) {
+    if (!isEncodedError(u))
+        return false;
+    var se = u;
+    if (se.errorType != knownErrorTypes.fetchError)
+        return false;
+    if (!('status' in se.props))
+        return false;
+    if (typeof se.props.status !== 'number')
+        return false;
+    return true;
+}
+function isEncodedEgressServiceError(u) {
+    if (!isEncodedError(u))
+        return false;
+    var se = u;
+    if (se.errorType != knownErrorTypes.egressServiceError)
+        return false;
+    if (!('errorCode' in se.props))
+        return false;
+    if (typeof se.props.errorCode !== 'string')
+        return false;
+    return true;
+}
+function isEncodedEgressUnexpectedResponseError(u) {
+    if (!isEncodedError(u))
+        return false;
+    var se = u;
+    if (se.errorType != knownErrorTypes.egressUnexpectedResponseError)
+        return false;
+    if (!('httpStatusCode' in se.props))
+        return false;
+    if (typeof se.props.httpStatusCode !== 'number')
+        return false;
+    return true;
+}
+function isEncodedTimeoutError(u) {
+    if (!isEncodedError(u))
+        return false;
+    var se = u;
+    if (se.errorType != knownErrorTypes.timeoutError)
+        return false;
+    return true;
+}
+function decodeGenericError(e) {
+    var error = new Error(e.message);
+    Object.assign(error, e.props);
+    return error;
+}
+function decodeFetchError(e) {
+    return new FetchError(e.message, e.props.status, e.props.responseData, e.props.responseHeaders);
+}
+function decodeEgressServiceError(e) {
+    return new EgressServiceError(e.props.errorCode, e.message);
+}
+function decodeEgressUnexpectedResponseError(e) {
+    return new EgressUnexpectedResponseError(e.props.httpStatusCode, e.message);
+}
+function decodeTimeoutError(e) {
+    return new TimeoutError(e.message);
+}
+export function encodeError(e) {
+    return {
+        message: e.message,
+        props: __assign({}, e),
+        errorType: getErrorType(e),
+    };
+}
+export function decodeError(e) {
+    if (!isEncodedError(e))
+        throw new Error('not a valid encoded error');
+    if (isEncodedFetchError(e))
+        return decodeFetchError(e);
+    if (isEncodedEgressServiceError(e))
+        return decodeEgressServiceError(e);
+    if (isEncodedEgressUnexpectedResponseError(e))
+        return decodeEgressUnexpectedResponseError(e);
+    if (isEncodedTimeoutError(e))
+        return decodeTimeoutError(e);
+    return decodeGenericError(e);
+}
+//# sourceMappingURL=encoder.js.map

package/dist/src/errors/encoder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"encoder.js","sourceRoot":"","sources":["../../../../plugin-sdk/src/errors/encoder.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,OAAO,EACL,kBAAkB,EAClB,6BAA6B,EAC7B,UAAU,EACV,YAAY,GACb,qBAA8B;AAE/B,IAAK,eAKJ;AALD,WAAK,eAAe;IAClB,4CAAyB,CAAA;IACzB,4DAAyC,CAAA;IACzC,kFAA+D,CAAA;IAC/D,gDAA6B,CAAA;AAC/B,CAAC,EALI,eAAe,KAAf,eAAe,QAKnB;AAED,SAAS,YAAY,CAAC,CAAQ;IAC5B,IAAI,CAAC,YAAY,UAAU;QAAE,OAAO,eAAe,CAAC,UAAU,CAAA;IAC9D,IAAI,CAAC,YAAY,kBAAkB;QAAE,OAAO,eAAe,CAAC,kBAAkB,CAAA;IAC9E,IAAI,CAAC,YAAY,6BAA6B;QAC5C,OAAO,eAAe,CAAC,6BAA6B,CAAA;IACtD,IAAI,CAAC,YAAY,YAAY;QAAE,OAAO,eAAe,CAAC,YAAY,CAAA;IAClE,OAAO,SAAS,CAAA;AAClB,CAAC;AAUD,MAAM,UAAU,cAAc,CAAC,CAAU;IACvC,IAAI,CAAC,CAAC,IAAI,OAAO,CAAC,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IAC7C,IAAM,CAAC,GAA4B,CAA4B,CAAA;IAC/D,IAAI,CAAC,CAAC,SAAS,IAAI,CAAC,CAAC;QAAE,OAAO,KAAK,CAAA;IACnC,IAAI,OAAO,CAAC,CAAC,OAAO,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IAC/C,IAAI,WAAW,IAAI,CAAC,IAAI,OAAO,CAAC,CAAC,SAAS,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IACrE,IAAI,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC;QAAE,OAAO,KAAK,CAAA;IACjC,IAAI,CAAC,CAAC,CAAC,KAAK;QAAE,OAAO,KAAK,CAAA;IAC1B,IAAI,OAAO,CAAC,CAAC,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IAE7C,OAAO,IAAI,CAAA;AACb,CAAC;AA6BD,SAAS,mBAAmB,CAAC,CAAU;IACrC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;QAAE,OAAO,KAAK,CAAA;IACpC,IAAM,EAAE,GAAiB,CAAC,CAAA;IAC1B,IAAI,EAAE,CAAC,SAAS,IAAI,eAAe,CAAC,UAAU;QAAE,OAAO,KAAK,CAAA;IAC5D,IAAI,CAAC,CAAC,QAAQ,IAAI,EAAE,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAA;IACzC,IAAI,OAAO,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IACrD,OAAO,IAAI,CAAA;AACb,CAAC;AAED,SAAS,2BAA2B,CAAC,CAAU;IAC7C,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;QAAE,OAAO,KAAK,CAAA;IACpC,IAAM,EAAE,GAAiB,CAAC,CAAA;IAC1B,IAAI,EAAE,CAAC,SAAS,IAAI,eAAe,CAAC,kBAAkB;QAAE,OAAO,KAAK,CAAA;IACpE,IAAI,CAAC,CAAC,WAAW,IAAI,EAAE,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAA;IAC5C,IAAI,OAAO,EAAE,CAAC,KAAK,CAAC,SAAS,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IACxD,OAAO,IAAI,CAAA;AACb,CAAC;AAED,SAAS,sCAAsC,CAC7C,CAAU;IAEV,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;QAAE,OAAO,KAAK,CAAA;IACpC,IAAM,EAAE,GAAiB,CAAC,CAAA;IAC1B,IAAI,EAAE,CAAC,SAAS,IAAI,eAAe,CAAC,6BAA6B;QAAE,OAAO,KAAK,CAAA;IAC/E,IAAI,CAAC,CAAC,gBAAgB,IAAI,EAAE,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAA;IACjD,IAAI,OAAO,EAAE,CAAC,KAAK,CAAC,cAAc,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IAC7D,OAAO,IAAI,CAAA;AACb,CAAC;AAED,SAAS,qBAAqB,CAAC,CAAU;IACvC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;QAAE,OAAO,KAAK,CAAA;IACpC,IAAM,EAAE,GAAiB,CAAC,CAAA;IAC1B,IAAI,EAAE,CAAC,SAAS,IAAI,eAAe,CAAC,YAAY;QAAE,OAAO,KAAK,CAAA;IAC9D,OAAO,IAAI,CAAA;AACb,CAAC;AAED,SAAS,kBAAkB,CAAC,CAAe;IACzC,IAAM,KAAK,GAAG,IAAI,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAA;IAClC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,CAAA;IAC7B,OAAO,KAAK,CAAA;AACd,CAAC;AAED,SAAS,gBAAgB,CAAC,CAAoB;IAC5C,OAAO,IAAI,UAAU,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAA;AACjG,CAAC;AAED,SAAS,wBAAwB,CAAC,CAA4B;IAC5D,OAAO,IAAI,kBAAkB,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,CAAA;AAC7D,CAAC;AAED,SAAS,mCAAmC,CAC1C,CAAuC;IAEvC,OAAO,IAAI,6BAA6B,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC,CAAC,OAAO,CAAC,CAAA;AAC7E,CAAC;AAED,SAAS,kBAAkB,CAAC,CAAsB;IAChD,OAAO,IAAI,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,CAAA;AACpC,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,CAAQ;IAClC,OAAO;QACL,OAAO,EAAE,CAAC,CAAC,OAAO;QAClB,KAAK,eAAM,CAAC,CAAC;QACb,SAAS,EAAE,YAAY,CAAC,CAAC,CAAC;KAC3B,CAAA;AACH,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,CAAe;IACzC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;IACpE,IAAI,mBAAmB,CAAC,CAAC,CAAC;QAAE,OAAO,gBAAgB,CAAC,CAAC,CAAC,CAAA;IACtD,IAAI,2BAA2B,CAAC,CAAC,CAAC;QAAE,OAAO,wBAAwB,CAAC,CAAC,CAAC,CAAA;IACtE,IAAI,sCAAsC,CAAC,CAAC,CAAC;QAAE,OAAO,mCAAmC,CAAC,CAAC,CAAC,CAAA;IAC5F,IAAI,qBAAqB,CAAC,CAAC,CAAC;QAAE,OAAO,kBAAkB,CAAC,CAAC,CAAC,CAAA;IAC1D,OAAO,kBAAkB,CAAC,CAAC,CAAC,CAAA;AAC9B,CAAC"}

package/dist/src/errors/errorMessages.d.ts

@@ -0,0 +1,4 @@
+import * as t from 'io-ts';
+export declare function missingVariable(variableName: string): Error;
+export declare function invalidParameter(variableName: string, errorMsg: string): TypeError;
+export declare function invalidInterface<A, O, I>(variableName: string, codec: t.Type<A, O, I>, invalidObject: unknown): TypeError;

package/dist/src/errors/errorMessages.js

@@ -0,0 +1,14 @@
+import { getInvalidInterfacePaths } from './interfaceValidator';
+export function missingVariable(variableName) {
+    return new Error("Required parameter not provided: ".concat(variableName));
+}
+export function invalidParameter(variableName, errorMsg) {
+    return new TypeError("Invalid parameter ".concat(variableName, ": ").concat(errorMsg));
+}
+export function invalidInterface(variableName, codec, invalidObject) {
+    var configErrors = getInvalidInterfacePaths(codec.decode(invalidObject));
+    var configErrorsWithPrefix = configErrors.map(function (error) { return "\n\t- ".concat(error); });
+    var configErrorMsg = configErrorsWithPrefix.length !== 0 ? "Invalid keys:".concat(configErrorsWithPrefix.join('')) : '';
+    return new TypeError("Invalid collection ".concat(variableName, ". ").concat(configErrorMsg));
+}
+//# sourceMappingURL=errorMessages.js.map

package/dist/src/errors/errorMessages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errorMessages.js","sourceRoot":"","sources":["../../../../plugin-sdk/src/errors/errorMessages.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,wBAAwB,EAAC,MAAM,sBAAsB,CAAA;AAE7D,MAAM,UAAU,eAAe,CAAC,YAAoB;IAClD,OAAO,IAAI,KAAK,CAAC,2CAAoC,YAAY,CAAE,CAAC,CAAA;AACtE,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,YAAoB,EAAE,QAAgB;IACrE,OAAO,IAAI,SAAS,CAAC,4BAAqB,YAAY,eAAK,QAAQ,CAAE,CAAC,CAAA;AACxE,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,YAAoB,EACpB,KAAsB,EACtB,aAAsB;IAEtB,IAAM,YAAY,GAAG,wBAAwB,CAAC,KAAK,CAAC,MAAM,CAAC,aAAkB,CAAC,CAAC,CAAA;IAC/E,IAAM,sBAAsB,GAAG,YAAY,CAAC,GAAG,CAAC,UAAC,KAAK,IAAK,OAAA,gBAAS,KAAK,CAAE,EAAhB,CAAgB,CAAC,CAAA;IAC5E,IAAM,cAAc,GAClB,sBAAsB,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,uBAAgB,sBAAsB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAE,CAAC,CAAC,CAAC,EAAE,CAAA;IAC9F,OAAO,IAAI,SAAS,CAAC,6BAAsB,YAAY,eAAK,cAAc,CAAE,CAAC,CAAA;AAC/E,CAAC"}

package/dist/src/errors/errorTypes.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Special implementation of Error for when there is a failed fetch (API or normal)
+ */
+export declare class FetchError extends Error {
+    status?: number | undefined;
+    responseData?: unknown;
+    responseHeaders?: Record<string, string> | undefined;
+    axiosErrorCode?: string | undefined;
+    constructor(errorMessage: string, status?: number | undefined, responseData?: unknown, responseHeaders?: Record<string, string> | undefined, axiosErrorCode?: string | undefined);
+}
+/**
+ * Special implementation of Error for when there is a timeout
+ */
+export declare class TimeoutError extends Error {
+    constructor(errorMessage: string);
+}
+/**
+ * Error class to indicate a missing credential
+ */
+export declare class MissingCredentialError extends Error {
+    constructor(credentialId: string | undefined);
+}
+export declare const USER_ERROR_CONTEXTS: Readonly<{
+    ACCOUNT: "account selector";
+    PLUGIN: "plugin selector";
+    EXTENSION: "extension selector";
+}>;
+/**
+ * Error class to indicate a user cancellation
+ */
+export declare class UserCancelError extends Error {
+    constructor(selectorType: string);
+}
+/**
+ * Error class to indicate a user went back
+ */
+export declare class UserBackError extends Error {
+    constructor(selectorType: string);
+}
+/**
+ * Error class to indicate wrong scheme
+ */
+export declare class WrongSchemeError extends Error {
+    constructor(scheme: string);
+}
+/**
+ * Representation of an error from Egress Gateway, which takes the following form:
+ * {
+ *    meta: ...
+ *    error: {
+ *      errorCode: "ERR_X.X"
+ *      errorMessage: "message"
+ *    }
+ * }
+ */
+export declare class EgressServiceError extends Error {
+    errorCode: string;
+    constructor(errorCode: string, errorMessage: string);
+}
+/**
+ * Represents error thrown when a (successful) EgressResponse does not
+ * match the expected response.
+ */
+export declare class EgressUnexpectedResponseError extends Error {
+    httpStatusCode: number;
+    constructor(httpStatusCode: number, errorMessage: string);
+}

package/dist/src/errors/errorTypes.js

@@ -0,0 +1,166 @@
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+/**
+ * Special implementation of Error for when there is a failed fetch (API or normal)
+ */
+var FetchError = /** @class */ (function (_super) {
+    __extends(FetchError, _super);
+    function FetchError(errorMessage, status, responseData, responseHeaders, axiosErrorCode) {
+        var _newTarget = this.constructor;
+        var _this = _super.call(this, errorMessage) || this;
+        _this.status = status;
+        _this.responseData = responseData;
+        _this.responseHeaders = responseHeaders;
+        _this.axiosErrorCode = axiosErrorCode;
+        // Error breaks the prototype chain, so restore it manually. See:
+        // https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-2.html#support-for-newtarget
+        Object.setPrototypeOf(_this, _newTarget.prototype);
+        return _this;
+    }
+    return FetchError;
+}(Error));
+export { FetchError };
+/**
+ * Special implementation of Error for when there is a timeout
+ */
+var TimeoutError = /** @class */ (function (_super) {
+    __extends(TimeoutError, _super);
+    function TimeoutError(errorMessage) {
+        var _newTarget = this.constructor;
+        var _this = _super.call(this, errorMessage) || this;
+        // Error breaks the prototype chain, so restore it manually. See:
+        // https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-2.html#support-for-newtarget
+        Object.setPrototypeOf(_this, _newTarget.prototype);
+        return _this;
+    }
+    return TimeoutError;
+}(Error));
+export { TimeoutError };
+/**
+ * Error class to indicate a missing credential
+ */
+var MissingCredentialError = /** @class */ (function (_super) {
+    __extends(MissingCredentialError, _super);
+    function MissingCredentialError(credentialId) {
+        var _newTarget = this.constructor;
+        var _this = _super.call(this, "The provided credential ID \"".concat(credentialId || 'undefined', "\" is not available to the current user.")) || this;
+        // Error breaks the prototype chain, so restore it manually. See:
+        // https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-2.html#support-for-newtarget
+        Object.setPrototypeOf(_this, _newTarget.prototype);
+        return _this;
+    }
+    return MissingCredentialError;
+}(Error));
+export { MissingCredentialError };
+export var USER_ERROR_CONTEXTS = Object.freeze({
+    ACCOUNT: 'account selector',
+    PLUGIN: 'plugin selector',
+    EXTENSION: 'extension selector',
+});
+/**
+ * Error class to indicate a user cancellation
+ */
+var UserCancelError = /** @class */ (function (_super) {
+    __extends(UserCancelError, _super);
+    function UserCancelError(selectorType) {
+        var _newTarget = this.constructor;
+        var _this = _super.call(this, "The user canceled the ".concat(selectorType)) || this;
+        _this.name = 'UserCancelError';
+        // Error breaks the prototype chain, so restore it manually. See:
+        // https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-2.html#support-for-newtarget
+        Object.setPrototypeOf(_this, _newTarget.prototype);
+        return _this;
+    }
+    return UserCancelError;
+}(Error));
+export { UserCancelError };
+/**
+ * Error class to indicate a user went back
+ */
+var UserBackError = /** @class */ (function (_super) {
+    __extends(UserBackError, _super);
+    function UserBackError(selectorType) {
+        var _newTarget = this.constructor;
+        var _this = _super.call(this, "The user backed out of the ".concat(selectorType)) || this;
+        _this.name = 'UserBackError';
+        // Error breaks the prototype chain, so restore it manually. See:
+        // https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-2.html#support-for-newtarget
+        Object.setPrototypeOf(_this, _newTarget.prototype);
+        return _this;
+    }
+    return UserBackError;
+}(Error));
+export { UserBackError };
+/**
+ * Error class to indicate wrong scheme
+ */
+var WrongSchemeError = /** @class */ (function (_super) {
+    __extends(WrongSchemeError, _super);
+    function WrongSchemeError(scheme) {
+        var _newTarget = this.constructor;
+        var _this = _super.call(this, "This function require scheme: ".concat(scheme)) || this;
+        _this.name = 'WrongSchemeError';
+        // Error breaks the prototype chain, so restore it manually. See:
+        // https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-2.html#support-for-newtarget
+        Object.setPrototypeOf(_this, _newTarget.prototype);
+        return _this;
+    }
+    return WrongSchemeError;
+}(Error));
+export { WrongSchemeError };
+/**
+ * Representation of an error from Egress Gateway, which takes the following form:
+ * {
+ *    meta: ...
+ *    error: {
+ *      errorCode: "ERR_X.X"
+ *      errorMessage: "message"
+ *    }
+ * }
+ */
+var EgressServiceError = /** @class */ (function (_super) {
+    __extends(EgressServiceError, _super);
+    function EgressServiceError(errorCode, errorMessage) {
+        var _newTarget = this.constructor;
+        var _this = _super.call(this, errorMessage) || this;
+        _this.errorCode = errorCode;
+        // Error breaks the prototype chain, so restore it manually. See:
+        // https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-2.html#support-for-newtarget
+        Object.setPrototypeOf(_this, _newTarget.prototype);
+        return _this;
+    }
+    return EgressServiceError;
+}(Error));
+export { EgressServiceError };
+/**
+ * Represents error thrown when a (successful) EgressResponse does not
+ * match the expected response.
+ */
+var EgressUnexpectedResponseError = /** @class */ (function (_super) {
+    __extends(EgressUnexpectedResponseError, _super);
+    function EgressUnexpectedResponseError(httpStatusCode, errorMessage) {
+        var _newTarget = this.constructor;
+        var _this = _super.call(this, errorMessage) || this;
+        _this.httpStatusCode = httpStatusCode;
+        // Error breaks the prototype chain, so restore it manually. See:
+        // https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-2.html#support-for-newtarget
+        Object.setPrototypeOf(_this, _newTarget.prototype);
+        return _this;
+    }
+    return EgressUnexpectedResponseError;
+}(Error));
+export { EgressUnexpectedResponseError };
+//# sourceMappingURL=errorTypes.js.map

package/dist/src/errors/errorTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errorTypes.js","sourceRoot":"","sources":["../../../../plugin-sdk/src/errors/errorTypes.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA;;GAEG;AACH;IAAgC,8BAAK;IACnC,oBACE,YAAoB,EACb,MAAe,EACf,YAAsB,EACtB,eAAwC,EACxC,cAAuB;;QAE9B,YAAA,MAAK,YAAC,YAAY,CAAC,SAAA;QALZ,YAAM,GAAN,MAAM,CAAS;QACf,kBAAY,GAAZ,YAAY,CAAU;QACtB,qBAAe,GAAf,eAAe,CAAyB;QACxC,oBAAc,GAAd,cAAc,CAAS;QAI9B,iEAAiE;QACjE,uGAAuG;QACvG,MAAM,CAAC,cAAc,CAAC,KAAI,EAAE,WAAW,SAAS,CAAC,CAAA;;IACnD,CAAC;IACH,iBAAC;AAAD,CAAC,AAdD,CAAgC,KAAK,GAcpC;;AAED;;GAEG;AACH;IAAkC,gCAAK;IACrC,sBAAmB,YAAoB;;QACrC,YAAA,MAAK,YAAC,YAAY,CAAC,SAAA;QAEnB,iEAAiE;QACjE,uGAAuG;QACvG,MAAM,CAAC,cAAc,CAAC,KAAI,EAAE,WAAW,SAAS,CAAC,CAAA;;IACnD,CAAC;IACH,mBAAC;AAAD,CAAC,AARD,CAAkC,KAAK,GAQtC;;AAED;;GAEG;AACH;IAA4C,0CAAK;IAC/C,gCAAmB,YAAgC;;QACjD,YAAA,MAAK,YACH,uCACE,YAAY,IAAI,WAAW,6CACY,CAC1C,SAAA;QAED,iEAAiE;QACjE,uGAAuG;QACvG,MAAM,CAAC,cAAc,CAAC,KAAI,EAAE,WAAW,SAAS,CAAC,CAAA;;IACnD,CAAC;IACH,6BAAC;AAAD,CAAC,AAZD,CAA4C,KAAK,GAYhD;;AAED,MAAM,CAAC,IAAM,mBAAmB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC/C,OAAO,EAAE,kBAAkB;IAC3B,MAAM,EAAE,iBAAiB;IACzB,SAAS,EAAE,oBAAoB;CAChC,CAAC,CAAA;AAEF;;GAEG;AACH;IAAqC,mCAAK;IACxC,yBAAmB,YAAoB;;QACrC,YAAA,MAAK,YAAC,gCAAyB,YAAY,CAAE,CAAC,SAAA;QAC9C,KAAI,CAAC,IAAI,GAAG,iBAAiB,CAAA;QAE7B,iEAAiE;QACjE,uGAAuG;QACvG,MAAM,CAAC,cAAc,CAAC,KAAI,EAAE,WAAW,SAAS,CAAC,CAAA;;IACnD,CAAC;IACH,sBAAC;AAAD,CAAC,AATD,CAAqC,KAAK,GASzC;;AAED;;GAEG;AACH;IAAmC,iCAAK;IACtC,uBAAmB,YAAoB;;QACrC,YAAA,MAAK,YAAC,qCAA8B,YAAY,CAAE,CAAC,SAAA;QACnD,KAAI,CAAC,IAAI,GAAG,eAAe,CAAA;QAE3B,iEAAiE;QACjE,uGAAuG;QACvG,MAAM,CAAC,cAAc,CAAC,KAAI,EAAE,WAAW,SAAS,CAAC,CAAA;;IACnD,CAAC;IACH,oBAAC;AAAD,CAAC,AATD,CAAmC,KAAK,GASvC;;AAED;;GAEG;AACH;IAAsC,oCAAK;IACzC,0BAAmB,MAAc;;QAC/B,YAAA,MAAK,YAAC,wCAAiC,MAAM,CAAE,CAAC,SAAA;QAChD,KAAI,CAAC,IAAI,GAAG,kBAAkB,CAAA;QAE9B,iEAAiE;QACjE,uGAAuG;QACvG,MAAM,CAAC,cAAc,CAAC,KAAI,EAAE,WAAW,SAAS,CAAC,CAAA;;IACnD,CAAC;IACH,uBAAC;AAAD,CAAC,AATD,CAAsC,KAAK,GAS1C;;AAED;;;;;;;;;GASG;AACH;IAAwC,sCAAK;IAE3C,4BAAmB,SAAiB,EAAE,YAAoB;;QACxD,YAAA,MAAK,YAAC,YAAY,CAAC,SAAA;QACnB,KAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC1B,iEAAiE;QACjE,uGAAuG;QACvG,MAAM,CAAC,cAAc,CAAC,KAAI,EAAE,WAAW,SAAS,CAAC,CAAA;;IACnD,CAAC;IACH,yBAAC;AAAD,CAAC,AATD,CAAwC,KAAK,GAS5C;;AAED;;;GAGG;AACH;IAAmD,iDAAK;IAEtD,uCAAmB,cAAsB,EAAE,YAAoB;;QAC7D,YAAA,MAAK,YAAC,YAAY,CAAC,SAAA;QACnB,KAAI,CAAC,cAAc,GAAG,cAAc,CAAA;QACpC,iEAAiE;QACjE,uGAAuG;QACvG,MAAM,CAAC,cAAc,CAAC,KAAI,EAAE,WAAW,SAAS,CAAC,CAAA;;IACnD,CAAC;IACH,oCAAC;AAAD,CAAC,AATD,CAAmD,KAAK,GASvD"}

package/dist/src/errors/interfaceValidator.d.ts

@@ -0,0 +1,30 @@
+import * as t from 'io-ts';
+/**
+ * Function parses out invalid object paths for an invalid interface type. For example, if you have the codec:
+ * const Person = t.type({
+ *   name: t.string,
+ *   age: t.number,
+ *   livesIn: {
+ *     city: t.string,
+ *     zipCode: t.number
+ *   }
+ * })
+ *
+ * and you want to validate the object
+ *
+ * const max = {
+ *  name: "Max Lloyd",
+ *  age: "Don't worry about it", // invalid type
+ *  livesIn: {
+ *    zipCode: 12345, // not providing required 'city' parameter
+ *  }
+ * }
+ *
+ * running Person.decode(max) returns a io-ts validator and
+ *
+ * const validatorForMax = Person.validate(max)
+ * getInvalidInterfacePaths(validatorForMax) => ['age', 'livesIn.city']
+ *
+ * @param v io-ts Validator (returned if `decode` is called on any io-ts codec)
+ */
+export declare const getInvalidInterfacePaths: <A>(v: t.Validation<A>) => Array<string>;

package/dist/src/errors/interfaceValidator.js

@@ -0,0 +1,54 @@
+import { fold } from 'fp-ts/lib/Either';
+import { pipe } from 'fp-ts/lib/pipeable';
+import _ from 'lodash';
+var isValidContext = function (context) {
+    return !!context.key && isNaN(parseInt(context.key));
+};
+var getErrorMessageFromContext = function (context) {
+    var keyPath = context.filter(isValidContext);
+    if (!keyPath.length) {
+        return '';
+    }
+    var desiredVariableType = keyPath[keyPath.length - 1].type.name;
+    return keyPath.map(function (_a) {
+        var key = _a.key;
+        return key;
+    }).join('.') + " | should be type: ".concat(desiredVariableType);
+};
+var getInvalidPathsForErrors = function (errors) {
+    var allPaths = errors.map(function (error) { return getErrorMessageFromContext(error.context); });
+    var allNonEmptyPaths = allPaths.filter(function (path) { return !!path; });
+    return _.uniq(allNonEmptyPaths);
+};
+/**
+ * Function parses out invalid object paths for an invalid interface type. For example, if you have the codec:
+ * const Person = t.type({
+ *   name: t.string,
+ *   age: t.number,
+ *   livesIn: {
+ *     city: t.string,
+ *     zipCode: t.number
+ *   }
+ * })
+ *
+ * and you want to validate the object
+ *
+ * const max = {
+ *  name: "Max Lloyd",
+ *  age: "Don't worry about it", // invalid type
+ *  livesIn: {
+ *    zipCode: 12345, // not providing required 'city' parameter
+ *  }
+ * }
+ *
+ * running Person.decode(max) returns a io-ts validator and
+ *
+ * const validatorForMax = Person.validate(max)
+ * getInvalidInterfacePaths(validatorForMax) => ['age', 'livesIn.city']
+ *
+ * @param v io-ts Validator (returned if `decode` is called on any io-ts codec)
+ */
+export var getInvalidInterfacePaths = function (v) {
+    return pipe(v, fold(getInvalidPathsForErrors, function () { return ['no errors']; }));
+};
+//# sourceMappingURL=interfaceValidator.js.map

package/dist/src/errors/interfaceValidator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaceValidator.js","sourceRoot":"","sources":["../../../../plugin-sdk/src/errors/interfaceValidator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,kBAAkB,CAAA;AACrC,OAAO,EAAC,IAAI,EAAC,MAAM,oBAAoB,CAAA;AAEvC,OAAO,CAAC,MAAM,QAAQ,CAAA;AAEtB,IAAM,cAAc,GAAG,UAAC,OAAuB;IAC7C,OAAA,CAAC,CAAC,OAAO,CAAC,GAAG,IAAI,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;AAA7C,CAA6C,CAAA;AAE/C,IAAM,0BAA0B,GAAG,UAAC,OAAkB;IACpD,IAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAA;IAC9C,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QACpB,OAAO,EAAE,CAAA;IACX,CAAC;IACD,IAAM,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAA;IACjE,OAAO,OAAO,CAAC,GAAG,CAAC,UAAC,EAAK;YAAJ,GAAG,SAAA;QAAM,OAAA,GAAG;IAAH,CAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,6BAAsB,mBAAmB,CAAE,CAAA;AAC5F,CAAC,CAAA;AAED,IAAM,wBAAwB,GAAG,UAAC,MAAgB;IAChD,IAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,UAAC,KAAK,IAAK,OAAA,0BAA0B,CAAC,KAAK,CAAC,OAAO,CAAC,EAAzC,CAAyC,CAAC,CAAA;IACjF,IAAM,gBAAgB,GAAG,QAAQ,CAAC,MAAM,CAAC,UAAC,IAAI,IAAK,OAAA,CAAC,CAAC,IAAI,EAAN,CAAM,CAAC,CAAA;IAC1D,OAAO,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;AACjC,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,CAAC,IAAM,wBAAwB,GAAG,UAAI,CAAkB;IAC5D,OAAO,IAAI,CACT,CAAC,EACD,IAAI,CAAC,wBAAwB,EAAE,cAAM,OAAA,CAAC,WAAW,CAAC,EAAb,CAAa,CAAC,CACpD,CAAA;AACH,CAAC,CAAA"}