epicenter-libs 3.33.0 → 3.34.1

package/dist/test/utilities.js

@@ -1,17 +0,0 @@
-import fetch from 'cross-fetch';
-import config from './utils/config.js';
-import { prefix } from './utils/helpers.js';
-export { parseFilterInput } from './utils/filter-parser.js';
-
-const proxy = async (resource, options) => {
-  const {
-    accountShortName,
-    projectShortName,
-    isLocal
-  } = config;
-  let path = prefix('/', resource);
-  if (!isLocal()) path = `/proxy/${accountShortName}/${projectShortName}${path}`;
-  return fetch(path, options);
-};
-
-export { proxy };

package/dist/test/utils/config.js

@@ -1,189 +0,0 @@
-import _defineProperty from '../node_modules/@babel/runtime/helpers/esm/defineProperty.js';
-import EpicenterError from './error.js';
-import { isBrowser, isNode } from './helpers.js';
-
-const API_VERSION = 3;
-class Config {
-  constructor() {
-    _defineProperty(this, "_apiVersion", API_VERSION);
-    _defineProperty(this, "_apiProtocol", '');
-    _defineProperty(this, "_apiHost", '');
-    _defineProperty(this, "_useProjectProxy", false);
-    _defineProperty(this, "_accountShortName", '');
-    _defineProperty(this, "_projectShortName", '');
-    _defineProperty(this, "authOverride", void 0);
-    if (isBrowser()) {
-      this.loadBrowser();
-      return;
-    }
-    if (isNode()) {
-      this.loadNode();
-      return;
-    }
-    throw new EpicenterError('Could not identify environment; no configuration was setup');
-  }
-
-  /**
-   * Protocol used to make network requests (whether `http://` or `https://`).
-   * It is typically set on-load based on your browser's URL. For local development,
-   * this is defaulted to `https`, and can be overwritten if desired.
-   * @memberof config
-   * @type {string}
-   *  */
-  get apiProtocol() {
-    return this._apiProtocol;
-  }
-  set apiProtocol(apiProtocol) {
-    if (!apiProtocol.startsWith('http')) return;
-    if (apiProtocol.endsWith(':')) {
-      apiProtocol = apiProtocol.slice(0, -1);
-    }
-    this._apiProtocol = apiProtocol;
-  }
-
-  /**
-   * Hostname used to make network requests. It is typically set on-load based on
-   * your browser's URL. For local development, this is defaulted to `forio.com`,
-   * and can be overwritten if desired.
-   * @memberof config
-   * @type {string}
-   *  */
-  get apiHost() {
-    return this._apiHost;
-  }
-  set apiHost(apiHost) {
-    this._apiHost = apiHost;
-  }
-
-  /**
-   * If true, requests are routed to project proxy server.
-   * The proxy server processes requests and forwards them to the Epicenter platform as appropriate,
-   * usually with some modification. Can be used to grant heightened privileges to a request.
-   * @memberof config
-   * @type {boolean}
-   */
-  get useProjectProxy() {
-    return this._useProjectProxy;
-  }
-  set useProjectProxy(useProjectProxy) {
-    this._useProjectProxy = useProjectProxy;
-  }
-
-  /**
-   * Version used to make network requests. This is read-only variable intended for internal use.
-   * @memberof config
-   * @type {number}
-   */
-  get apiVersion() {
-    return this._apiVersion;
-  }
-  set apiVersion(_apiVersion) {
-    return;
-  }
-
-  /**
-   * Account name used for making network requests.
-   * This is the default value used by Epicenter API adapters when making
-   * network requests without explicitly defining an account to use.
-   * It is defined on-load based on your browser's URL, and can be
-   * overwritten for local development.
-   * @example
-   * // with browser URL: https://forio.com/app/acme-simulations/foobar-game
-   *
-   * console.log(config.accountShortName);
-   * // should log 'acme-simulations'
-   *
-   * runAdapter.get(123);
-   * // instantiates a GET call with the URL: https://forio.com/api/v3/acme-simulations/foobar-game/run/123
-   *
-   * config.accountShortName = 'globex-simuations';
-   * runAdapter.get(123);
-   * // now instantiates a GET with the URL: https://forio.com/api/v3/globex-simulations/foobar-game/run/123
-   *
-   * runAdapter.get(123, { accountShortName: 'initech-simulations' });
-   * // now instantiates a GET with the URL: https://forio.com/api/v3/initech-simulations/foobar-game/run/123
-   *
-   * @memberof config
-   * @type {string}
-   */
-  get accountShortName() {
-    return this._accountShortName;
-  }
-  set accountShortName(accountShortName) {
-    this._accountShortName = accountShortName;
-  }
-
-  /**
-   * Project name used for making network requests.
-   * This is the default value used by Epicenter API adapters when making
-   * network requests without explicitly defining an account to use.
-   * It is defined on-load based on your browser's URL, and can be
-   * overwritten for local development.
-   * @example
-   * // with browser URL: https://forio.com/app/acme-simulations/foobar-game
-   *
-   * console.log(config.projectShortName);
-   * // should log 'foobar-game'
-   *
-   * runAdapter.get(123);
-   * // instantiates a GET call with the URL: https://forio.com/api/v3/acme-simulations/foobar-game/run/123
-   *
-   * config.projectShortName = 'barfoo-game';
-   * runAdapter.get(123);
-   * // now instantiates a GET with the URL: https://forio.com/api/v3/acme-simulations/barfoo-game/run/123
-   *
-   * runAdapter.get(123, { projectShortName: 'barbaz-game' });
-   * // now instantiates a GET with the URL: https://forio.com/api/v3/acme-simulations/barbaz-game/run/123
-   *
-   * @memberof config
-   * @type {string}
-   */
-  get projectShortName() {
-    return this._projectShortName;
-  }
-  set projectShortName(projectShortName) {
-    this._projectShortName = projectShortName;
-  }
-
-  /**
-   * Use to determines whether or not the environment is local.
-   * @memberof config
-   * @return whether or not environment is local.
-   */
-  isLocal() {
-    if (!isBrowser()) return false;
-    const host = window.location.host;
-    return host === '127.0.0.1' || host.indexOf('local.') === 0 || host.indexOf('ngrok') !== -1 || host.indexOf('localhost') === 0;
-  }
-  loadNode() {
-    this.apiProtocol = 'https';
-    this.apiHost = 'forio.com';
-    return;
-  }
-  loadBrowser() {
-    const isLocal = this.isLocal();
-    const {
-      protocol,
-      pathname,
-      host
-    } = window.location;
-    this.apiProtocol = isLocal ? 'https' : protocol;
-    this.apiHost = isLocal ? 'forio.com' : host;
-    const match = pathname.match(/\/app\/([\w-]+)\/([\w-]+)/);
-    if (match) {
-      const [account, project] = match.slice(1);
-      this.accountShortName = account;
-      this.projectShortName = project;
-    }
-  }
-  setContext(context) {
-    if (context.apiProtocol) this.apiProtocol = context.apiProtocol;
-    if (context.apiHost) this.apiHost = context.apiHost;
-    if (typeof context.useProjectProxy === 'boolean') this.useProjectProxy = context.useProjectProxy;
-    if (context.accountShortName) this.accountShortName = context.accountShortName;
-    if (context.projectShortName) this.projectShortName = context.projectShortName;
-  }
-}
-const config = new Config();
-
-export { config as default };

package/dist/test/utils/constants.js

@@ -1,293 +0,0 @@
-let BROWSER_STORAGE_TYPE = /*#__PURE__*/function (BROWSER_STORAGE_TYPE) {
-  BROWSER_STORAGE_TYPE["COOKIE"] = "COOKIE";
-  BROWSER_STORAGE_TYPE["SESSION"] = "SESSION";
-  return BROWSER_STORAGE_TYPE;
-}({});
-
-/**
- * Scope boundaries are values associated with runs. They help to define the *default* user permissions used when a run is created, althought further permission configuration can be done with {@link #ROLE lock types}. Scopes also provide an index that in which a run can be queried for.
- *
- * Three parts -- boundary: level of hierarchy (ontology) that a piece of data belongs to. Specifically, a run, an asset, or a vault data
- * Boundary in which a piece of data (run, asset, vault) is ID-ed to (see scopeKey).
- *
- * pseudonymKey, goes in tandem w/ permit (lock types) --
- * Data lives and dies with scope, delete the scope, you lose the data and associated scopes
- * @enum {string}
- */
-let SCOPE_BOUNDARY = /*#__PURE__*/function (SCOPE_BOUNDARY) {
-  /**
-   * Runs scoped by project, users and facilitators are allowed access so long as they are a user in a group on the project.
-   * @constant
-   * @type {string}
-   */
-  SCOPE_BOUNDARY["PROJECT"] = "PROJECT";
-  /**
-   * Runs scoped by group, users and facilitators are allowed access only if they are in the associated group
-   * Groups are scoped by projects
-   * @constant
-   * @type {string}
-   */
-  SCOPE_BOUNDARY["GROUP"] = "GROUP";
-  /**
-   * Runs scoped by episode, not sure what this one is permission-wise
-   * Episodes are scoped by groups
-   * @constant
-   * @type {string}
-   */
-  SCOPE_BOUNDARY["EPISODE"] = "EPISODE";
-  /**
-   * Runs scoped by world, users are only allowed access to the if they are assigned to the associated world. Facilitators need only to belong on the group that created the world
-   * Worlds can be scoped by group or episode
-   * @constant
-   * @type {string}
-   */
-  SCOPE_BOUNDARY["WORLD"] = "WORLD";
-  return SCOPE_BOUNDARY;
-}({});
-
-/**
- * Rituals are used to define the way in which the Epicenter stores a run while running actions like getting variables, saving meta data, and call model operations. Runs can exist in-memory for a certain amount of time before expiring, and requiring their revival again before use.
- * @enum {string}
- */
-let RITUAL = /*#__PURE__*/function (RITUAL) {
-  /**
-   * Allow GET action against archive, no revival of run
-   * @constant
-   * @type {string}
-   */
-  RITUAL["NONE"] = "NONE";
-  /**
-   * Does not allow restore and will not access archived state (if down stay down)
-   * @constant
-   * @type {string}
-   */
-  RITUAL["INTER"] = "INTER";
-  /**
-   * A run with this ritual will be pulled into memory as needed, and will stay in memory until it's lifespan (defined in your project Settings) has expired.
-   * @constant
-   * @type {string}
-   */
-  RITUAL["REANIMATE"] = "REANIMATE";
-  /**
-   * Will always restore, and never access archived state
-   * @constant
-   * @type {string}
-   */
-  RITUAL["REVIVE"] = "REVIVE";
-  /**
-   * A run with this ritual will be pulled into memory as needed, and removed from memory afterwards.
-   * @constant
-   * @type {string}
-   */
-  RITUAL["EXORCISE"] = "EXORCISE";
-  /**
-   * Will always restore, and never access archived state, but will also terminate the run after issuing the command.
-   * @constant
-   * @type {string}
-   */
-  RITUAL["RESURRECT"] = "RESURRECT";
-  return RITUAL;
-}({});
-
-/**
- * Push categories are pre-defined channels types in which one might use to receive push channel updates
- * @enum {string}
- */
-let PUSH_CATEGORY = /*#__PURE__*/function (PUSH_CATEGORY) {
-  /**
-   * intended for messaging users
-   * yes pub
-   * @constant
-   * @type {string} */
-  PUSH_CATEGORY["CHAT"] = "CHAT";
-  /**
-   * Used for the {@link https://github.com/forio Consensus API}
-   * no pub
-   * @constant
-   * @type {string} */
-  PUSH_CATEGORY["CONSENSUS"] = "CONSENSUS";
-  /**
-   * intended for general non-chat, sim-level communication
-   * yes pub
-   * @constant
-   * @type {string} */
-  PUSH_CATEGORY["CONTROL"] = "CONTROL";
-  /**
-   * Used for the {@link https://github.com/forio Presence API}
-   * no pub
-   * @constant
-   * @type {string} */
-  PUSH_CATEGORY["PRESENCE"] = "PRESENCE";
-  /**
-   * intended for awaiting entering games
-   * yes pub
-   * @constant
-   * @type {string} */
-  PUSH_CATEGORY["LOBBY"] = "LOBBY";
-  /**
-   * Used for streaming data; bypasses ack extension
-   * yes pub
-   * @constant
-   * @type {string} */
-  PUSH_CATEGORY["STREAM"] = "STREAM";
-  /**
-   * Used for the {@link https://github.com/forio Run API}
-   * no pub
-   * @constant
-   * @type {string} */
-  PUSH_CATEGORY["RUN"] = "RUN";
-  /**
-   * Used for the {@link https://github.com/forio Vault API}
-   * no pub
-   * @constant
-   * @type {string}
-   */
-  PUSH_CATEGORY["VAULT"] = "VAULT";
-  /**
-   * Used for the {@link https://github.com/forio Video API}
-   * no pub
-   * @constant
-   * @type {string}
-   */
-  PUSH_CATEGORY["VIDEO"] = "VIDEO";
-  /**
-   * Used for the {@link https://github.com/forio World API}
-   * no pub
-   * @constant
-   * @type {string}
-   */
-  PUSH_CATEGORY["WORLD"] = "WORLD";
-  /**
-   * Used for the {@link https://github.com/forio Leaderboard API}
-   * no pub
-   * @constant
-   * @type {string}
-   */
-  PUSH_CATEGORY["LEADERBOARD"] = "LEADERBOARD";
-  /**
-   * For group related things; assignments, unassignments
-   * @constant
-   * @type {string}
-   */
-  PUSH_CATEGORY["GROUP"] = "GROUP";
-  /**
-   * internal
-   * @constant
-   * @type {string} */
-  PUSH_CATEGORY["SYSTEM"] = "SYSTEM";
-  return PUSH_CATEGORY;
-}({});
-
-/**
- * Roles are used to define permissions on resources in Epicenter.
- * @enum {string}
- */
-let ROLE = /*#__PURE__*/function (ROLE) {
-  /**
-   * System -- Epicenter Manager
-   * @constant
-   * @type {string}
-   */
-  ROLE["SYSTEM"] = "SYSTEM";
-  /**
-   * System minus -- read-only system access, write for certain accounts; think Geromel
-   * @constant
-   * @type {string}
-   */
-  ROLE["MONITOR"] = "MONITOR";
-  /**
-   * Owner -- Full control over account
-   * @constant
-   * @type {string}
-   */
-  ROLE["OWNER"] = "OWNER";
-  /**
-   * Author -- Team Members (and node server API keys)
-   * tied to one account (personal + current account)
-   * @constant
-   * @type {string}
-   */
-  ROLE["AUTHOR"] = "AUTHOR";
-  /**
-   * Author minus
-   * @constant
-   * @type {string}
-   */
-  ROLE["SUPPORT"] = "SUPPORT";
-  /**
-   * Associate -- Limited access to specific account
-   * @constant
-   * @type {string}
-   */
-  ROLE["ASSOCIATE"] = "ASSOCIATE";
-  /**
-   * Facilitators
-   * @constant
-   * @type {string}
-   */
-  ROLE["FACILITATOR"] = "FACILITATOR";
-  /**
-   * Reviewers (weaker facilitator)
-   * Facilitator minus
-   * @constant
-   * @type {string}
-   */
-  ROLE["REVIEWER"] = "REVIEWER";
-  /**
-   * Users -- pseudonymKey (userKey) required in scope
-   * e.g., an avatar -- GROUP scope, PARTICIPANT read, USER write, userKey pseudonymKey
-   * @constant
-   * @type {string}
-   */
-  ROLE["USER"] = "USER";
-  /**
-   * Leader
-   * Participant plus
-   * @constant
-   * @type {string}
-   */
-  ROLE["LEADER"] = "LEADER";
-  /**
-   * Participant
-   * @constant
-   * @type {string}
-   */
-  ROLE["PARTICIPANT"] = "PARTICIPANT";
-  /**
-   * Anonymous
-   * @constant
-   * @type {string}
-   */
-  ROLE["ANONYMOUS"] = "ANONYMOUS";
-  return ROLE;
-}({});
-
-// /**
-//  * Roles are used to define permissions on resources in Epicenter.
-//  * @enum {string}
-//  */
-//  export const ROLE = {
-//     ...INTERNAL_ROLE,
-//     ...ACCOUNT_ROLE,
-//     ...PROJECT_ROLE,
-//     ...GROUP_ROLE,
-// };
-
-// export type ROLE = INTERNAL_ROLE | ACCOUNT_ROLE | PROJECT_ROLE | GROUP_ROLE;
-
-/**
- * Generic search options for adapter methods. All adapter methods
- * will take `filter` and `sort` as a list of strings, and join with a ";"
- *
- * Enhanced filter support allows:
- * - string[] (legacy): ['name=Mike', 'count<=3'] -> 'name=Mike;count<=3'
- * - string (raw): '(name=Mike;count<=3;[id=1;id=2])' -> passed through as-is
- * - FilterGroup (object): { type: 'and', filters: [...] } -> parsed to boolean syntax
- */
-
-/**
- * The query parameters expected by the Epicenter APIs for
- * any kind of open search on a resource.
- */
-
-export { BROWSER_STORAGE_TYPE, PUSH_CATEGORY, RITUAL, ROLE, SCOPE_BOUNDARY };

package/dist/test/utils/cookies.js

@@ -1,75 +0,0 @@
-import { escapeRegExp } from './helpers.js';
-
-// Modified version of https://github.com/madmurphy/cookies.js
-const getExpiration = vEnd => {
-  if (!vEnd) return '';
-  switch (vEnd.constructor) {
-    case Number:
-      return vEnd === Infinity ? '; expires=Fri, 31 Dec 9999 23:59:59 GMT' : `; max-age=${vEnd}`;
-    /*
-        Note: Despite officially defined in RFC 6265, the use of `max-age` is not compatible with any
-        version of Internet Explorer, Edge and some mobile browsers. Therefore passing a number to
-        the end parameter might not work as expected. A possible solution might be to convert the the
-        relative time to an absolute time. For instance, replacing the previous line with:
-    */
-    /*
-        case Number: return vEnd === Infinity ? '; expires=Fri, 31 Dec 9999 23:59:59 GMT' : `; expires=${(new Date(vEnd * 1e3 + Date.now())).toUTCString()}`;
-    */
-    case String:
-      return `; expires=${vEnd}`;
-    case Date:
-      return `; expires=${new Date(vEnd).toUTCString()}`;
-    default:
-      return '';
-  }
-};
-var cookies = {
-  getItem(key) {
-    if (!key) return null;
-    return decodeURIComponent(document.cookie.replace(new RegExp(`(?:(?:^|.*;)\\s*${escapeRegExp(encodeURIComponent(key))}\\s*\\=\\s*([^;]*).*$)|^.*$`), '$1')) || null;
-  },
-  setItem(key, value, options = {}) {
-    if (!key || /^(?:expires|max-age|path|domain|secure)$/i.test(key)) return false;
-    const {
-      path,
-      domain,
-      end,
-      secure,
-      samesite
-    } = options;
-    const expireStr = getExpiration(end);
-    const domainStr = domain ? `; domain=${domain}` : '';
-    const pathStr = path ? `; path=${path}` : '';
-    const secureStr = secure ? '; secure' : '';
-    const samesiteStr = samesite ? `; samesite=${samesite}` : '';
-    document.cookie = `${encodeURIComponent(key)}=${encodeURIComponent(value)}${expireStr}${domainStr}${pathStr}${secureStr}${samesiteStr}`;
-    return true;
-  },
-  removeItem(key, options = {}) {
-    if (!this.hasItem(key)) return false;
-    const {
-      path,
-      domain
-    } = options;
-    const domainStr = domain ? `; domain=${domain}` : '';
-    const pathStr = path ? `; path=${path}` : '';
-    document.cookie = `${encodeURIComponent(key)}=; expires=Thu, 01 Jan 1970 00:00:00 GMT${domainStr}${pathStr}`;
-    return true;
-  },
-  hasItem(key) {
-    if (!key || /^(?:expires|max-age|path|domain|secure)$/i.test(key)) return false;
-    return new RegExp(`(?:^|;\\s*)${escapeRegExp(encodeURIComponent(key))}\\s*\\=`).test(document.cookie);
-  },
-  clear() {
-    // TODO: potentially replace this regex with simpler implementation
-    // eslint-disable-next-line no-useless-backreference
-    const aKeys = document.cookie.replace(/((?:^|\s*;)[^=]+)(?=;|$)|^\s*|\s*(?:=[^;]*)?(?:\1|$)/g, '').split(/\s*(?:=[^;]*)?;\s*/);
-    for (let nLen = aKeys.length, nIdx = 0; nIdx < nLen; nIdx++) {
-      aKeys[nIdx] = decodeURIComponent(aKeys[nIdx]);
-      this.removeItem(aKeys[nIdx]);
-    }
-    return aKeys;
-  }
-};
-
-export { cookies as default };

package/dist/test/utils/error-manager.js

@@ -1,57 +0,0 @@
-import _defineProperty from '../node_modules/@babel/runtime/helpers/esm/defineProperty.js';
-import Fault from './fault.js';
-
-/* eslint-disable  @typescript-eslint/no-explicit-any */
-
-/* eslint-enable  @typescript-eslint/no-explicit-any */
-
-class ErrorManager {
-  constructor() {
-    _defineProperty(this, "_handlers", []);
-  }
-  get handlers() {
-    return this._handlers;
-  }
-  clearHandlers() {
-    this._handlers = [];
-  }
-  registerHandler(identifier, handleFn) {
-    const handler = {
-      identifier,
-      handle: handleFn,
-      unregister: () => this.unregisterHandler(identifier)
-    };
-    this.handlers.unshift(handler);
-    return handler;
-  }
-  unregisterHandler(identifier) {
-    const index = this.handlers.findIndex(handler => handler.identifier === identifier);
-    if (index > -1) this.handlers.splice(index, 1);
-  }
-  async handle(error, retryFn, handlers) {
-    handlers = handlers || this.handlers;
-    const index = handlers.findIndex(({
-      identifier
-    }) => identifier(error));
-    const handler = handlers[index];
-    if (!handler) throw error;
-    let promise;
-    try {
-      promise = await handler.handle(error, retryFn).catch(err => {
-        /* This catch call ensures that handle always returns a promise,
-        otherwise it'd be caught in the catch block below */
-        throw err;
-      });
-    } catch (e) {
-      console.error('Handler failed due to error', e);
-      const remainingHandlers = index > -1 ? [...handlers.slice(0, index), ...handlers.slice(index + 1)] : [];
-      // Try to handle the new error with the remaining handlers, otherwise keep trying to handle the original error
-      const handleableError = e instanceof Fault ? e : error;
-      promise = await this.handle(handleableError, retryFn, remainingHandlers);
-    }
-    return promise;
-  }
-}
-const errorManager = new ErrorManager();
-
-export { errorManager as default };

package/dist/test/utils/error.js

@@ -1,12 +0,0 @@
-import _defineProperty from '../node_modules/@babel/runtime/helpers/esm/defineProperty.js';
-
-/* Generic throwable error */
-class EpicenterError extends Error {
-  constructor(message, code) {
-    super(message);
-    _defineProperty(this, "code", void 0);
-    this.code = code;
-  }
-}
-
-export { EpicenterError as default };

package/dist/test/utils/fault.js

@@ -1,34 +0,0 @@
-import _defineProperty from '../node_modules/@babel/runtime/helpers/esm/defineProperty.js';
-import EpicenterError from './error.js';
-
-/* For failed network calls */
-class Fault extends EpicenterError {
-  constructor(body, response) {
-    var _body$information;
-    super(body.message, (_body$information = body.information) === null || _body$information === void 0 ? void 0 : _body$information.code);
-    _defineProperty(this, "status", void 0);
-    _defineProperty(this, "information", void 0);
-    _defineProperty(this, "cause", void 0);
-    const {
-      information,
-      message,
-      cause,
-      status
-    } = body;
-    this.status = status !== null && status !== void 0 ? status : response === null || response === void 0 ? void 0 : response.status;
-    this.message = message;
-    if (information) {
-      const {
-        code,
-        ...rest
-      } = information;
-      this.code = code;
-      this.information = rest;
-    }
-    if (cause) {
-      this.cause = cause;
-    }
-  }
-}
-
-export { Fault as default };