@qualtrics/plugin-client 1.8.19

package/dist/src/lib/plugin/pluginClient.d.ts

@@ -0,0 +1,155 @@
+import { Context, FetchResponse, MessageData, SerializableRecord, UserProvidedFetchConfig, UserProvidedQualtricsApiFetchConfig } from "../../models";
+import { Handler } from "./models";
+declare class PluginClient {
+    private readonly context;
+    private channel;
+    private translator?;
+    private constructor();
+    static initialize(handlers?: Record<string, Handler>): Promise<PluginClient>;
+    destroy(): void;
+    postMessage(name: string, data?: MessageData, timeout?: number): Promise<MessageData>;
+    /**
+     * Sends a request to the provided URL. Injects user defined account for authentication
+     * if specified in connection property.
+     *
+     * fetchConfig should be formatted as follows:
+     * {
+     *   method {string}: the http method to use (ex: 'POST', 'GET, 'PUT', etc.)
+     *   headers {object} (optional): key/value pairs that correspond to headers to add to the request (ex: "Content-Type": "application/json")
+     *   body {object | string} (optional): the body of the request
+     *   params {object} (optional): key/value pairs that correspond query params to add to the request URL (ex: "filter": "random")
+     *   connection {object} (optional): {
+     *     connectionName {string}: the name of the connection to use (see context.availableConnections for a list of connections).
+     *     paramFormat {string}: where to place the credential. Can be 'header','body', or 'query'.
+     *     paramName {string}: what to name the credential param. As in, the field name for a body param, the query name for a query param, or the header name for a header. Ex: for a bearer token this might be "Authorization".
+     *     paramTemplate {string}: what to insert the credential as. Use it similarly to a string passed to String.format. EX: "Bearer %s" would be a template for bearer tokens, "%s" inserts the token as-is.
+     *   }
+     * }
+     * @param {string} url - The URL to make a request to
+     * @param {object} fetchConfig - Configures all aspects of the request
+     * @param {number} timeout - Defaults to 10000 (10 seconds). Specifies the number of milliseconds at which to reject the returned promise if no response has been received from the Plugin.
+     * @returns {Promise} resolves to an object containing {responseBody: JSON string, httpStatusCode: string}
+     */
+    fetch(url: string, fetchConfig: UserProvidedFetchConfig, timeout?: number): Promise<MessageData>;
+    /**
+     * The exciting sequel to `fetch`
+     *
+     * Sends a request to the provided URL. Injects user defined account for authentication
+     * if specified in connection property.
+     *
+     * fetchConfig should be formatted as follows:
+     * {
+     *   method {string}: the http method to use (ex: 'POST', 'GET, 'PUT', etc.)
+     *   headers {object} (optional): key/value pairs that correspond to headers to add to the request (ex: "Content-Type": "application/json")
+     *   body {object | string} (optional): the body of the request
+     *   params {object} (optional): key/value pairs that correspond query params to add to the request URL (ex: "filter": "random")
+     *   connection {object} (optional): {
+     *     connectionName {string}: the name of the connection to use (see context.availableConnections for a list of connections).
+     *     paramFormat {string}: where to place the credential. Can be 'header','body', or 'query'.
+     *     paramName {string}: what to name the credential param. As in, the field name for a body param, the query name for a query param, or the header name for a header. Ex: for a bearer token this might be "Authorization".
+     *     paramTemplate {string}: what to insert the credential as. Use it similarly to a string passed to String.format. EX: "Bearer %s" would be a template for bearer tokens, "%s" inserts the token as-is.
+     *   }
+     * }
+     *
+     * Promise resolves to either a successful FetchResponse or throws a FetchError. Both
+     * contain a `status` prop for checking the status code and a `responseData` property that
+     * contains whatever the response has. This could be more information on the Error that
+     * occurred or the data that was requested.
+     *
+     * Successful response example:
+     * {
+     *  status: 200
+     *  responseData: {
+     *    ... // data from the 3rd party service
+     *  }
+     * }
+     *
+     * Error response Example:
+     * Uncaught Error: "GET https://pokeapi.co/api/v2/pokemon/porkachu/ 404 Not Found"
+     * {
+     *  status: 404
+     *  responseData: "404 - Not Found"
+     * }
+     *
+     * @param {string} url - The URL to make a request to
+     * @param {object} fetchConfig - Configures all aspects of the request
+     * @param {number} timeout - Defaults to 10000 (10 seconds). Specifies the number of milliseconds at which to reject the returned promise if no response has been received from the Plugin.
+     * @returns {Promise} response from the service
+     */
+    fetch2(url: string, fetchConfig: UserProvidedFetchConfig, timeout?: number): Promise<FetchResponse>;
+    private isJSON;
+    /**
+     * Make a request to Qualtrics Public API. Similar to fetch, but doesn't accept a connection.
+     *
+     * The config should be formatted as follows:
+     * {
+     *   method {string}: the http method to use (ex: 'POST', 'GET, 'PUT', etc.)
+     *   body {object | string} (optional): the body of the request
+     * }
+     * @param {string} url - The relative Qualtrics API path to make a request to, such as `surveys`
+     * @param {object} config - Configures all aspects of the request
+     * @param {number} timeout - Defaults to 10000 (10 seconds). Specifies the number of milliseconds at which to reject the returned promise if no response has been received from the Plugin.
+     * @returns {Promise} - response from the API
+     */
+    qualtricsApiFetch(url: string, config: UserProvidedQualtricsApiFetchConfig, timeout?: number): Promise<SerializableRecord>;
+    /**
+     * The exciting sequel to `qualtricsApiFetch`
+     *
+     * Make a request to Qualtrics Public API. Similar to fetch, but doesn't accept a connection.
+     *
+     * The config should be formatted as follows:
+     * {
+     *   method {string}: the http method to use (ex: 'POST', 'GET, 'PUT', etc.)
+     *   body {object | string} (optional): the body of the request
+     * }
+     *
+     * Promise resolves to either a successful FetchResponse or throws a FetchError. Both
+     * contain a `status` prop for checking the status code and a `responseData` property that
+     * contains whatever the response has. This could be more information on the Error that
+     * occurred or the data that was requested.
+     *
+     * Successful response example:
+     * {
+     *  status: 200
+     *  responseData: {
+     *    meta: {
+     *      httpStatus: "200 - OK"
+     *      requestId: "c0bf74f9-7119-47c1-99bf-3d2353032d11"
+     *    }
+     *    result: {
+     *      elements: [...] //surveys
+     *      nextPage: null
+     *    }
+     *  }
+     * }
+     *
+     * Error response Example:
+     * Uncaught Error: "GET /API/v3/surveys/SV_notarealid 400 Bad Request"
+     * {
+     *  status: 400
+     *  responseData: {
+     *    meta: {
+     *      httpStatus: "400 - Bad Request"
+     *      error: {
+     *        errorMessage: "Invalid surveyId."
+     *        errorCode: "GSI_1"
+     *      }
+     *    }
+     *    requestId: "41885efc-4ecf-41db-890b-9e3d5222112a"
+     *    }
+     *  }
+     * }
+     * @param {string} url - The relative Qualtrics API path to make a request to, such as `surveys`
+     * @param {object} config - Configures all aspects of the request
+     * @param {number} timeout - Defaults to 10000 (10 seconds). Specifies the number of milliseconds at which to reject the returned promise if no response has been received from the Plugin.
+     * @returns {Promise} - response from the API.
+     */
+    qualtricsApiFetch2(url: string, config: UserProvidedQualtricsApiFetchConfig, timeout?: number): Promise<FetchResponse>;
+    logAmplitudeEvent(eventNamespace: string, eventName: string, eventData?: Record<string, unknown>): Promise<MessageData>;
+    private validateFetchInput;
+    private removeLeadingSlash;
+    getContext(): Context;
+    getLanguage(): string;
+    getText(key: string, placeHolders?: Record<string, string>, defaultVal?: string): string;
+}
+export default PluginClient;

package/dist/src/lib/plugin/pluginClient.js

@@ -0,0 +1,436 @@
+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 (g && (g = 0, op[0] && (_ = 0)), _) 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 };
+    }
+};
+import * as t from 'io-ts';
+import * as Errors from "../../errors/errorMessages";
+import { FetchError } from "../../errors/errorTypes";
+import { EgressResponse, isContext, SerializableRecord, UserProvidedFetchConfig, UserProvidedQualtricsApiFetchConfig, } from "../../models";
+import { isPresent, NonEmptyString, OptionalArg } from "../../modelUtils";
+import MessageChannel from "../messages/messageChannel";
+import { getClientVersion } from "./buildConfig";
+import { PluginClientHandlerCollection } from "./models";
+import Translator from './translations';
+var referrer = document.referrer ? new URL(document.referrer).origin : null;
+window.Promise = window.Promise || Promise;
+var LONG_TIMEOUT = 10000;
+var INIT_EVENT = 'init';
+var PluginClient = /** @class */ (function () {
+    function PluginClient(context, channel) {
+        this.context = context;
+        this.channel = channel;
+        if (this.context.translations) {
+            this.translator = new Translator(this.context.translations);
+        }
+    }
+    // Factory method. Fetches context before constructing and returning the plugin client.
+    PluginClient.initialize = function (handlers) {
+        if (handlers === void 0) { handlers = {}; }
+        return __awaiter(this, void 0, void 0, function () {
+            var channel, initMessage, maybeContext, context, pluginClient, getWrappedHandler, _i, _a, name_1;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        if (!PluginClientHandlerCollection.is(handlers)) {
+                            throw Errors.invalidParameter('handlers', 'Must be a collection of functions');
+                        }
+                        channel = new MessageChannel({
+                            name: 'plugin',
+                            other: window.parent,
+                            otherOrigin: referrer,
+                        });
+                        initMessage = { clientVersion: getClientVersion() };
+                        return [4 /*yield*/, channel.postMessage(INIT_EVENT, initMessage)];
+                    case 1:
+                        maybeContext = _b.sent();
+                        if (!isContext(maybeContext)) {
+                            throw new Error("init message replied with an invalid context: ".concat(typeof maybeContext === 'object' && maybeContext
+                                ? JSON.stringify(maybeContext)
+                                : typeof maybeContext));
+                        }
+                        context = maybeContext;
+                        channel.setInstanceId(context.instanceID);
+                        pluginClient = new PluginClient(context, channel);
+                        getWrappedHandler = function (handler, pluginClient) {
+                            return function (data) { return handler(data, pluginClient); };
+                        };
+                        // wrap each of the provided handlers and register them to the channel
+                        for (_i = 0, _a = Object.getOwnPropertyNames(handlers); _i < _a.length; _i++) {
+                            name_1 = _a[_i];
+                            channel.registerHandler(name_1, getWrappedHandler(handlers[name_1], pluginClient));
+                        }
+                        return [2 /*return*/, pluginClient];
+                }
+            });
+        });
+    };
+    PluginClient.prototype.destroy = function () {
+        // Disconnect message channel
+        if (this.channel) {
+            this.channel.destroy();
+        }
+    };
+    /*
+      Generic post message to the parent window. Returns a promise to be resolved once the host replies.
+    */
+    PluginClient.prototype.postMessage = function (name, data, timeout) {
+        if (timeout === void 0) { timeout = LONG_TIMEOUT; }
+        return this.channel.postMessage(name, data, timeout);
+    };
+    /**
+     * Sends a request to the provided URL. Injects user defined account for authentication
+     * if specified in connection property.
+     *
+     * fetchConfig should be formatted as follows:
+     * {
+     *   method {string}: the http method to use (ex: 'POST', 'GET, 'PUT', etc.)
+     *   headers {object} (optional): key/value pairs that correspond to headers to add to the request (ex: "Content-Type": "application/json")
+     *   body {object | string} (optional): the body of the request
+     *   params {object} (optional): key/value pairs that correspond query params to add to the request URL (ex: "filter": "random")
+     *   connection {object} (optional): {
+     *     connectionName {string}: the name of the connection to use (see context.availableConnections for a list of connections).
+     *     paramFormat {string}: where to place the credential. Can be 'header','body', or 'query'.
+     *     paramName {string}: what to name the credential param. As in, the field name for a body param, the query name for a query param, or the header name for a header. Ex: for a bearer token this might be "Authorization".
+     *     paramTemplate {string}: what to insert the credential as. Use it similarly to a string passed to String.format. EX: "Bearer %s" would be a template for bearer tokens, "%s" inserts the token as-is.
+     *   }
+     * }
+     * @param {string} url - The URL to make a request to
+     * @param {object} fetchConfig - Configures all aspects of the request
+     * @param {number} timeout - Defaults to 10000 (10 seconds). Specifies the number of milliseconds at which to reject the returned promise if no response has been received from the Plugin.
+     * @returns {Promise} resolves to an object containing {responseBody: JSON string, httpStatusCode: string}
+     */
+    PluginClient.prototype.fetch = function (url, fetchConfig, timeout) {
+        if (timeout === void 0) { timeout = LONG_TIMEOUT; }
+        return __awaiter(this, void 0, void 0, function () {
+            var fetchMessage;
+            return __generator(this, function (_a) {
+                this.validateFetchInput(url, timeout);
+                if (!isPresent(fetchConfig)) {
+                    throw Errors.missingVariable('fetchConfig');
+                }
+                if (!UserProvidedFetchConfig.is(fetchConfig)) {
+                    throw Errors.invalidInterface('fetchConfig', UserProvidedFetchConfig, fetchConfig);
+                }
+                fetchMessage = __assign(__assign({}, fetchConfig), { url: url });
+                return [2 /*return*/, this.channel.postMessage('fetch', fetchMessage, timeout)];
+            });
+        });
+    };
+    /**
+     * The exciting sequel to `fetch`
+     *
+     * Sends a request to the provided URL. Injects user defined account for authentication
+     * if specified in connection property.
+     *
+     * fetchConfig should be formatted as follows:
+     * {
+     *   method {string}: the http method to use (ex: 'POST', 'GET, 'PUT', etc.)
+     *   headers {object} (optional): key/value pairs that correspond to headers to add to the request (ex: "Content-Type": "application/json")
+     *   body {object | string} (optional): the body of the request
+     *   params {object} (optional): key/value pairs that correspond query params to add to the request URL (ex: "filter": "random")
+     *   connection {object} (optional): {
+     *     connectionName {string}: the name of the connection to use (see context.availableConnections for a list of connections).
+     *     paramFormat {string}: where to place the credential. Can be 'header','body', or 'query'.
+     *     paramName {string}: what to name the credential param. As in, the field name for a body param, the query name for a query param, or the header name for a header. Ex: for a bearer token this might be "Authorization".
+     *     paramTemplate {string}: what to insert the credential as. Use it similarly to a string passed to String.format. EX: "Bearer %s" would be a template for bearer tokens, "%s" inserts the token as-is.
+     *   }
+     * }
+     *
+     * Promise resolves to either a successful FetchResponse or throws a FetchError. Both
+     * contain a `status` prop for checking the status code and a `responseData` property that
+     * contains whatever the response has. This could be more information on the Error that
+     * occurred or the data that was requested.
+     *
+     * Successful response example:
+     * {
+     *  status: 200
+     *  responseData: {
+     *    ... // data from the 3rd party service
+     *  }
+     * }
+     *
+     * Error response Example:
+     * Uncaught Error: "GET https://pokeapi.co/api/v2/pokemon/porkachu/ 404 Not Found"
+     * {
+     *  status: 404
+     *  responseData: "404 - Not Found"
+     * }
+     *
+     * @param {string} url - The URL to make a request to
+     * @param {object} fetchConfig - Configures all aspects of the request
+     * @param {number} timeout - Defaults to 10000 (10 seconds). Specifies the number of milliseconds at which to reject the returned promise if no response has been received from the Plugin.
+     * @returns {Promise} response from the service
+     */
+    PluginClient.prototype.fetch2 = function (url, fetchConfig, timeout) {
+        if (timeout === void 0) { timeout = LONG_TIMEOUT; }
+        return __awaiter(this, void 0, void 0, function () {
+            var res, fetchResponse;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.fetch(url, fetchConfig, timeout)
+                        // appeases TS - this error more than likely will never get thrown
+                    ];
+                    case 1:
+                        res = _a.sent();
+                        // appeases TS - this error more than likely will never get thrown
+                        if (!EgressResponse.is(res)) {
+                            throw new Error("Response from fetch is not an Egress Response. Instead received ".concat(typeof res));
+                        }
+                        fetchResponse = {
+                            status: res.httpStatusCode,
+                            responseData: this.isJSON(res.responseBody) ? JSON.parse(res.responseBody) : res.responseBody,
+                            responseHeaders: res.responseHeaders,
+                        };
+                        return [2 /*return*/, fetchResponse];
+                }
+            });
+        });
+    };
+    /* credit: https://github.com/lodash/lodash/issues/2142 */
+    PluginClient.prototype.isJSON = function (string) {
+        try {
+            var obj = JSON.parse(string);
+            if (obj && typeof obj === 'object' && obj !== null) {
+                return true;
+            }
+            // eslint-disable-next-line no-empty
+        }
+        catch (err) { }
+        return false;
+    };
+    /**
+     * Make a request to Qualtrics Public API. Similar to fetch, but doesn't accept a connection.
+     *
+     * The config should be formatted as follows:
+     * {
+     *   method {string}: the http method to use (ex: 'POST', 'GET, 'PUT', etc.)
+     *   body {object | string} (optional): the body of the request
+     * }
+     * @param {string} url - The relative Qualtrics API path to make a request to, such as `surveys`
+     * @param {object} config - Configures all aspects of the request
+     * @param {number} timeout - Defaults to 10000 (10 seconds). Specifies the number of milliseconds at which to reject the returned promise if no response has been received from the Plugin.
+     * @returns {Promise} - response from the API
+     */
+    PluginClient.prototype.qualtricsApiFetch = function (url, config, timeout) {
+        if (timeout === void 0) { timeout = LONG_TIMEOUT; }
+        return __awaiter(this, void 0, void 0, function () {
+            var qualtricsApiFetchMessage, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        this.validateFetchInput(url, timeout);
+                        if (!isPresent(config)) {
+                            throw Errors.missingVariable('config');
+                        }
+                        if (!UserProvidedQualtricsApiFetchConfig.is(config)) {
+                            throw Errors.invalidInterface('config', UserProvidedQualtricsApiFetchConfig, config);
+                        }
+                        url = this.removeLeadingSlash(url);
+                        qualtricsApiFetchMessage = __assign(__assign({}, config), { url: url });
+                        return [4 /*yield*/, this.channel.postMessage('apiv3', qualtricsApiFetchMessage, timeout)];
+                    case 1:
+                        response = _a.sent();
+                        if (!SerializableRecord.is(response)) {
+                            throw new Error("Response From API v3 is not a record. Instead received ".concat(typeof response === 'object' && response ? JSON.stringify(response) : 'unknown type'));
+                        }
+                        return [2 /*return*/, response];
+                }
+            });
+        });
+    };
+    /**
+     * The exciting sequel to `qualtricsApiFetch`
+     *
+     * Make a request to Qualtrics Public API. Similar to fetch, but doesn't accept a connection.
+     *
+     * The config should be formatted as follows:
+     * {
+     *   method {string}: the http method to use (ex: 'POST', 'GET, 'PUT', etc.)
+     *   body {object | string} (optional): the body of the request
+     * }
+     *
+     * Promise resolves to either a successful FetchResponse or throws a FetchError. Both
+     * contain a `status` prop for checking the status code and a `responseData` property that
+     * contains whatever the response has. This could be more information on the Error that
+     * occurred or the data that was requested.
+     *
+     * Successful response example:
+     * {
+     *  status: 200
+     *  responseData: {
+     *    meta: {
+     *      httpStatus: "200 - OK"
+     *      requestId: "c0bf74f9-7119-47c1-99bf-3d2353032d11"
+     *    }
+     *    result: {
+     *      elements: [...] //surveys
+     *      nextPage: null
+     *    }
+     *  }
+     * }
+     *
+     * Error response Example:
+     * Uncaught Error: "GET /API/v3/surveys/SV_notarealid 400 Bad Request"
+     * {
+     *  status: 400
+     *  responseData: {
+     *    meta: {
+     *      httpStatus: "400 - Bad Request"
+     *      error: {
+     *        errorMessage: "Invalid surveyId."
+     *        errorCode: "GSI_1"
+     *      }
+     *    }
+     *    requestId: "41885efc-4ecf-41db-890b-9e3d5222112a"
+     *    }
+     *  }
+     * }
+     * @param {string} url - The relative Qualtrics API path to make a request to, such as `surveys`
+     * @param {object} config - Configures all aspects of the request
+     * @param {number} timeout - Defaults to 10000 (10 seconds). Specifies the number of milliseconds at which to reject the returned promise if no response has been received from the Plugin.
+     * @returns {Promise} - response from the API.
+     */
+    PluginClient.prototype.qualtricsApiFetch2 = function (url, config, timeout) {
+        if (timeout === void 0) { timeout = LONG_TIMEOUT; }
+        return __awaiter(this, void 0, void 0, function () {
+            var res, status, errorMessage, fetchResponse;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.qualtricsApiFetch(url, config, timeout)
+                        // required typeguard to appease TS
+                    ];
+                    case 1:
+                        res = _a.sent();
+                        // required typeguard to appease TS
+                        if (!(res === null || res === void 0 ? void 0 : res.status) || !(typeof (res === null || res === void 0 ? void 0 : res.status) === 'number')) {
+                            throw new Error('Fetch response received is missing a status code.');
+                        }
+                        if (!(res === null || res === void 0 ? void 0 : res.statusText) || !(typeof (res === null || res === void 0 ? void 0 : res.statusText) === 'string')) {
+                            throw new Error('Fetch response received is missing a status text.');
+                        }
+                        status = res.status;
+                        // if there's an error on the request, the messageChannel promise won't reject, so it
+                        // has to be manually checked for and thrown here
+                        if (status > 299 || status < 200) {
+                            errorMessage = "".concat(config.method, " /API/v3/").concat(url, " ").concat(status, " ").concat(res.statusText);
+                            throw new FetchError(errorMessage, status, res.data);
+                        }
+                        fetchResponse = {
+                            status: res.status,
+                            responseData: res.data,
+                        };
+                        return [2 /*return*/, fetchResponse];
+                }
+            });
+        });
+    };
+    PluginClient.prototype.logAmplitudeEvent = function (eventNamespace, eventName, eventData) {
+        if (eventData === void 0) { eventData = {}; }
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.channel.postMessage('logAmplitudeEvent', {
+                        eventNamespace: eventNamespace,
+                        eventName: eventName,
+                        eventData: eventData,
+                    }, LONG_TIMEOUT)];
+            });
+        });
+    };
+    /*
+      Validates expectations for the input to the fetch functions. Throws an error if any issues are detected.
+      Accepts isApiFetch to modify checks for qualtricsApiFetch; defaults to false.
+    */
+    PluginClient.prototype.validateFetchInput = function (url, timeout) {
+        if (!isPresent(url)) {
+            throw Errors.missingVariable('url');
+        }
+        if (!NonEmptyString.is(url)) {
+            throw Errors.invalidParameter('url', 'Must be a non-empty string');
+        }
+        if (!t.number.is(timeout)) {
+            throw Errors.invalidParameter('timeout', 'Must be an integer');
+        }
+    };
+    PluginClient.prototype.removeLeadingSlash = function (url) {
+        if (url.startsWith('/')) {
+            return url.substring(1);
+        }
+        return url;
+    };
+    /*
+      Returns the context object that was given by the host on init.
+    */
+    PluginClient.prototype.getContext = function () {
+        return this.context;
+    };
+    /*
+      Returns the language code of the logged in user given by the host on init.
+    */
+    PluginClient.prototype.getLanguage = function () {
+        return this.context.language;
+    };
+    PluginClient.prototype.getText = function (key, placeHolders, defaultVal) {
+        if (!isPresent(key)) {
+            throw Errors.missingVariable('key');
+        }
+        if (!NonEmptyString.is(key)) {
+            throw Errors.invalidParameter('key', 'Must be a non-empty string');
+        }
+        if (!OptionalArg(t.record(t.string, t.string)).is(placeHolders)) {
+            throw Errors.invalidParameter('placeHolders', 'Must be a collection of strings if present');
+        }
+        if (!OptionalArg(NonEmptyString).is(defaultVal)) {
+            throw Errors.invalidParameter('defaultValue', 'Must be non-empty string if provided');
+        }
+        if (!this.translator) {
+            throw new Error('Translation file not found');
+        }
+        return this.translator.getText(key, placeHolders, defaultVal);
+    };
+    return PluginClient;
+}());
+export default PluginClient;
+//# sourceMappingURL=pluginClient.js.map

package/dist/src/lib/plugin/pluginClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pluginClient.js","sourceRoot":"","sources":["../../../../../plugin-sdk/src/lib/plugin/pluginClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,KAAK,CAAC,MAAM,OAAO,CAAA;AAE1B,OAAO,KAAK,MAAM,mCAAiC;AACnD,OAAO,EAAC,UAAU,EAAC,gCAA8B;AACjD,OAAO,EAGL,cAAc,EAGd,SAAS,EAET,kBAAkB,EAClB,uBAAuB,EACvB,mCAAmC,GACpC,qBAAmB;AACpB,OAAO,EAAC,SAAS,EAAE,cAAc,EAAE,WAAW,EAAC,yBAAuB;AACtE,OAAO,cAAc,mCAAgC;AACrD,OAAO,EAAC,gBAAgB,EAAC,sBAA2B;AACpD,OAAO,EAAU,6BAA6B,EAAC,iBAAsB;AACrE,OAAO,UAAU,MAAM,gBAAgB,CAAA;AAEvC,IAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAA;AAE7E,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,OAAO,CAAA;AAE1C,IAAM,YAAY,GAAG,KAAK,CAAA;AAC1B,IAAM,UAAU,GAAG,MAAM,CAAA;AAEzB;IAGE,sBACmB,OAAgB,EACzB,OAAuB;QADd,YAAO,GAAP,OAAO,CAAS;QACzB,YAAO,GAAP,OAAO,CAAgB;QAE/B,IAAI,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC;YAC9B,IAAI,CAAC,UAAU,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;QAC7D,CAAC;IACH,CAAC;IAED,uFAAuF;IAC1E,uBAAU,GAAvB,UAAwB,QAAsC;QAAtC,yBAAA,EAAA,aAAsC;;;;;;wBAC5D,IAAI,CAAC,6BAA6B,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;4BAChD,MAAM,MAAM,CAAC,gBAAgB,CAAC,UAAU,EAAE,mCAAmC,CAAC,CAAA;wBAChF,CAAC;wBAGK,OAAO,GAAG,IAAI,cAAc,CAAC;4BACjC,IAAI,EAAE,QAAQ;4BACd,KAAK,EAAE,MAAM,CAAC,MAAM;4BACpB,WAAW,EAAE,QAAQ;yBACtB,CAAC,CAAA;wBAEI,WAAW,GAAgB,EAAC,aAAa,EAAE,gBAAgB,EAAE,EAAC,CAAA;wBAC/C,qBAAM,OAAO,CAAC,WAAW,CAAC,UAAU,EAAE,WAAW,CAAC,EAAA;;wBAAjE,YAAY,GAAG,SAAkD;wBACvE,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,CAAC;4BAC7B,MAAM,IAAI,KAAK,CACb,wDACE,OAAO,YAAY,KAAK,QAAQ,IAAI,YAAY;gCAC9C,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC;gCAC9B,CAAC,CAAC,OAAO,YAAY,CACvB,CACH,CAAA;wBACH,CAAC;wBACK,OAAO,GAAY,YAAY,CAAA;wBACrC,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;wBAEnC,YAAY,GAAG,IAAI,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;wBAGjD,iBAAiB,GAAG,UAAC,OAAgB,EAAE,YAA0B;4BACrE,OAAO,UAAC,IAAiB,IAAkB,OAAA,OAAO,CAAC,IAAI,EAAE,YAAY,CAAC,EAA3B,CAA2B,CAAA;wBACxE,CAAC,CAAA;wBACD,sEAAsE;wBACtE,WAAuD,EAApC,KAAA,MAAM,CAAC,mBAAmB,CAAC,QAAQ,CAAC,EAApC,cAAoC,EAApC,IAAoC,EAAE,CAAC;4BAArD;4BACH,OAAO,CAAC,eAAe,CAAC,MAAI,EAAE,iBAAiB,CAAC,QAAQ,CAAC,MAAI,CAAC,EAAE,YAAY,CAAC,CAAC,CAAA;wBAChF,CAAC;wBACD,sBAAO,YAAY,EAAA;;;;KACpB;IAED,8BAAO,GAAP;QACE,6BAA6B;QAC7B,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAA;QACxB,CAAC;IACH,CAAC;IAED;;MAEE;IACF,kCAAW,GAAX,UAAY,IAAY,EAAE,IAAkB,EAAE,OAAsB;QAAtB,wBAAA,EAAA,sBAAsB;QAClE,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;IACtD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,4BAAK,GAAX,UACE,GAAW,EACX,WAAoC,EACpC,OAAsB;QAAtB,wBAAA,EAAA,sBAAsB;;;;gBAEtB,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;gBACrC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,CAAC;oBAC5B,MAAM,MAAM,CAAC,eAAe,CAAC,aAAa,CAAC,CAAA;gBAC7C,CAAC;gBACD,IAAI,CAAC,uBAAuB,CAAC,EAAE,CAAC,WAAW,CAAC,EAAE,CAAC;oBAC7C,MAAM,MAAM,CAAC,gBAAgB,CAAC,aAAa,EAAE,uBAAuB,EAAE,WAAW,CAAC,CAAA;gBACpF,CAAC;gBAGK,YAAY,yBAAO,WAAW,KAAE,GAAG,KAAA,GAAC,CAAA;gBAC1C,sBAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,CAAC,EAAA;;;KAChE;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4CG;IACG,6BAAM,GAAZ,UACE,GAAW,EACX,WAAoC,EACpC,OAAsB;QAAtB,wBAAA,EAAA,sBAAsB;;;;;4BAED,qBAAM,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,WAAW,EAAE,OAAO,CAAC;wBAChE,kEAAkE;sBADF;;wBAA1D,GAAG,GAAY,SAA2C;wBAChE,kEAAkE;wBAClE,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;4BAC5B,MAAM,IAAI,KAAK,CACb,0EAAmE,OAAO,GAAG,CAAE,CAChF,CAAA;wBACH,CAAC;wBAEK,aAAa,GAAkB;4BACnC,MAAM,EAAE,GAAG,CAAC,cAAc;4BAC1B,YAAY,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY;4BAC7F,eAAe,EAAE,GAAG,CAAC,eAAe;yBACrC,CAAA;wBACD,sBAAO,aAAa,EAAA;;;;KACrB;IAED,0DAA0D;IAClD,6BAAM,GAAd,UAAe,MAAc;QAC3B,IAAI,CAAC;YACH,IAAM,GAAG,GAAY,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;YACvC,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;gBACnD,OAAO,IAAI,CAAA;YACb,CAAC;YACD,oCAAoC;QACtC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC,CAAA,CAAC;QAEhB,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;;;;;;;;OAYG;IACG,wCAAiB,GAAvB,UACE,GAAW,EACX,MAA2C,EAC3C,OAAsB;QAAtB,wBAAA,EAAA,sBAAsB;;;;;;wBAEtB,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;wBACrC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;4BACvB,MAAM,MAAM,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAA;wBACxC,CAAC;wBACD,IAAI,CAAC,mCAAmC,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;4BACpD,MAAM,MAAM,CAAC,gBAAgB,CAAC,QAAQ,EAAE,mCAAmC,EAAE,MAAM,CAAC,CAAA;wBACtF,CAAC;wBACD,GAAG,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAA;wBAE5B,wBAAwB,yBACzB,MAAM,KACT,GAAG,KAAA,GACJ,CAAA;wBACgB,qBAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,OAAO,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAA;;wBAArF,QAAQ,GAAG,SAA0E;wBAC3F,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;4BACrC,MAAM,IAAI,KAAK,CACb,iEACE,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,cAAc,CACpF,CACH,CAAA;wBACH,CAAC;wBACD,sBAAO,QAAQ,EAAA;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmDG;IACG,yCAAkB,GAAxB,UACE,GAAW,EACX,MAA2C,EAC3C,OAAsB;QAAtB,wBAAA,EAAA,sBAAsB;;;;;4BAEV,qBAAM,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC;wBAC9D,mCAAmC;sBAD2B;;wBAAxD,GAAG,GAAG,SAAkD;wBAC9D,mCAAmC;wBACnC,IAAI,CAAC,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,MAAM,CAAA,IAAI,CAAC,CAAC,OAAO,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,MAAM,CAAA,KAAK,QAAQ,CAAC,EAAE,CAAC;4BACvD,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAA;wBACtE,CAAC;wBACD,IAAI,CAAC,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,UAAU,CAAA,IAAI,CAAC,CAAC,OAAO,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,UAAU,CAAA,KAAK,QAAQ,CAAC,EAAE,CAAC;4BAC/D,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAA;wBACtE,CAAC;wBACK,MAAM,GAAW,GAAG,CAAC,MAAM,CAAA;wBACjC,qFAAqF;wBACrF,iDAAiD;wBACjD,IAAI,MAAM,GAAG,GAAG,IAAI,MAAM,GAAG,GAAG,EAAE,CAAC;4BAC3B,YAAY,GAAG,UAAG,MAAM,CAAC,MAAM,sBAAY,GAAG,cAAI,MAAM,cAAI,GAAG,CAAC,UAAU,CAAE,CAAA;4BAClF,MAAM,IAAI,UAAU,CAAC,YAAY,EAAE,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,CAAA;wBACtD,CAAC;wBACK,aAAa,GAAkB;4BACnC,MAAM,EAAE,GAAG,CAAC,MAAM;4BAClB,YAAY,EAAE,GAAG,CAAC,IAAI;yBACvB,CAAA;wBACD,sBAAO,aAAa,EAAA;;;;KACrB;IAEK,wCAAiB,GAAvB,UACE,cAAsB,EACtB,SAAiB,EACjB,SAAuC;QAAvC,0BAAA,EAAA,cAAuC;;;gBAEvC,sBAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAC7B,mBAAmB,EACnB;wBACE,cAAc,gBAAA;wBACd,SAAS,WAAA;wBACT,SAAS,WAAA;qBACV,EACD,YAAY,CACb,EAAA;;;KACF;IAED;;;MAGE;IACM,yCAAkB,GAA1B,UAA2B,GAAW,EAAE,OAAe;QACrD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;YACpB,MAAM,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC,CAAA;QACrC,CAAC;QACD,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;YAC5B,MAAM,MAAM,CAAC,gBAAgB,CAAC,KAAK,EAAE,4BAA4B,CAAC,CAAA;QACpE,CAAC;QACD,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;YAC1B,MAAM,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAA;QAChE,CAAC;IACH,CAAC;IAEO,yCAAkB,GAA1B,UAA2B,GAAW;QACpC,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACxB,OAAO,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;QACzB,CAAC;QACD,OAAO,GAAG,CAAA;IACZ,CAAC;IAED;;MAEE;IACF,iCAAU,GAAV;QACE,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAED;;MAEE;IACF,kCAAW,GAAX;QACE,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAA;IAC9B,CAAC;IAED,8BAAO,GAAP,UAAQ,GAAW,EAAE,YAAqC,EAAE,UAAmB;QAC7E,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;YACpB,MAAM,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC,CAAA;QACrC,CAAC;QACD,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;YAC5B,MAAM,MAAM,CAAC,gBAAgB,CAAC,KAAK,EAAE,4BAA4B,CAAC,CAAA;QACpE,CAAC;QACD,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE,CAAC;YAChE,MAAM,MAAM,CAAC,gBAAgB,CAAC,cAAc,EAAE,4CAA4C,CAAC,CAAA;QAC7F,CAAC;QACD,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC;YAChD,MAAM,MAAM,CAAC,gBAAgB,CAAC,cAAc,EAAE,sCAAsC,CAAC,CAAA;QACvF,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAA;QAC/C,CAAC;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,EAAE,YAAY,EAAE,UAAU,CAAC,CAAA;IAC/D,CAAC;IACH,mBAAC;AAAD,CAAC,AAzXD,IAyXC;AAED,eAAe,YAAY,CAAA"}

package/dist/src/lib/plugin/translations.d.ts

@@ -0,0 +1,15 @@
+import { TranslationFile, TranslationFileDeprecated } from "../../models";
+declare class Translator {
+    private translationFile;
+    constructor(translationFile: TranslationFile | TranslationFileDeprecated);
+    getText(key: string, params?: Record<string, string>, defaultValue?: string): string;
+    private getTemplateOrDefault;
+    private getTemplate;
+    /**
+     * Replace placeholders like "{{foo}}" with the value specified in params['foo'].
+     *
+     * Placeholders without a value present in params are left untouched.
+     */
+    private static replacePlaceholders;
+}
+export default Translator;