epicenter-libs 3.33.0 → 3.34.1

package/dist/test/adapters/leaderboard.js

@@ -1,162 +0,0 @@
-import '../utils/helpers.js';
-import { parseFilterInput } from '../utils/filter-parser.js';
-import '../utils/config.js';
-import identification from '../utils/identification.js';
-import '../utils/error-manager.js';
-import Router from '../utils/router.js';
-
-/**
- * Creates a leaderboard entry.
- * Base URL: POST `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/leaderboard`
- *
- * @example
- * import { leaderboardAdapter, SCOPE_BOUNDARY } from 'epicenter-libs';
- * const leaderboard = await leaderboardAdapter.update(
- *     'class-23-leaderboard',
- *     { scopeBoundary: SCOPE_BOUNDARY.GROUP, scopeKey: '0000017dd3bf540e5ada5b1e058f08f20461' },
- *     [{ name: 'total', quantity: 20 }, { name: 'extraCredit', quantity: 2 }],
- *     { tags: [{ label: 'role', content: 'doctor' }] }
- * );
- *
- * @param collection                Name of the leaderboard
- * @param scope                     Scope attached to the leaderboard entry; allows for scoping
- * @param scope.scopeBoundary       Scope boundary, defines the type of scope; See [scope boundary](#SCOPE_BOUNDARY) for all types
- * @param scope.scopeKey            Scope key, a unique identifier tied to the scope. E.g., if your `scopeBoundary` is `GROUP`, your `scopeKey` will be your `groupKey`; for `EPISODE`, `episodeKey`, etc.
- * @param [scope.userKey]           User key for the user creating the entry; if omitted will use the one in current session
- * @param scores                    List of score objects
- * @param scores[].name             Name of the score
- * @param scores[].quantity         Value of the score
- * @param [optionals]               Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.tags]          Tags for the leaderboard entry; helps to provide another layer of scope if needed
- * @param [optionals.allowChannel]  If true, allows channel notifications for this update
- * @returns promise that resolves to the leaderboard entry created
- */
-async function update(collection, scope, scores, optionals = {}) {
-  const {
-    tags,
-    allowChannel,
-    ...routingOptions
-  } = optionals;
-  const {
-    scopeBoundary,
-    scopeKey,
-    userKey
-  } = scope;
-  const session = identification.session;
-  return await new Router().post('/leaderboard', {
-    body: {
-      scope: {
-        scopeBoundary,
-        scopeKey,
-        userKey: userKey !== null && userKey !== void 0 ? userKey : session === null || session === void 0 ? void 0 : session.userKey
-      },
-      collection,
-      scores,
-      tags,
-      allowChannel
-    },
-    ...routingOptions
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Gathers leaderboard information; not paginable (hence named 'list' and not 'query')
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/leaderboard/{SCOPE_BOUNDARY}/{SCOPE_KEY}/{COLLECTION}`
- *
- * @example
- * import { leaderboardAdapter, SCOPE_BOUNDARY } from 'epicenter-libs';
- * const leaderboard = await leaderboardAdapter.list('myLeaderboard', {
- *     scopeBoundary: SCOPE_BOUNDARY.GROUP,
- *     scopeKey: 'GROUP_KEY',
- * }, {
- *     filter: [
- *         'tag.role=doctor',  // look for leaderboard entries tagged with role=doctor
- *         'score.total>0'     // where the users scored a total higher than 0
- *     ],
- *     sort: ['+score.total'], // sort results by 'total' in ascending order
- *     first: 0,
- *     max: 20                 // retrieve only the first 20 entries
- * });
- *
- * @param collection                Name of the leaderboard
- * @param scope                     Scope attached to the leaderboard entry; allows for scoping
- * @param scope.scopeBoundary       Scope boundary, defines the type of scope; See [scope boundary](#SCOPE_BOUNDARY) for all types
- * @param scope.scopeKey            Scope key, a unique identifier tied to the scope. E.g., if your `scopeBoundary` is `GROUP`, your `scopeKey` will be your `groupKey`; for `EPISODE`, `episodeKey`, etc.
- * @param searchOptions             Search options for the query
- * @param [searchOptions.filter]    Filters for searching
- * @param [searchOptions.sort]      Sorting criteria
- * @param [searchOptions.first]     The starting index of the list returned
- * @param [searchOptions.max]       The maximum number of entries in the list
- * @param [optionals]               Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to a list of leaderboard entries
- */
-async function list(collection, scope, searchOptions, optionals = {}) {
-  const {
-    scopeBoundary,
-    scopeKey
-  } = scope;
-  const {
-    filter,
-    sort = [],
-    first,
-    max
-  } = searchOptions;
-  const searchParams = {
-    filter: parseFilterInput(filter),
-    sort: sort.join(';') || undefined,
-    first,
-    max
-  };
-  return await new Router().withSearchParams(searchParams).get(`/leaderboard/${scopeBoundary}/${scopeKey}/${collection}`, optionals).then(({
-    body
-  }) => body);
-}
-async function get(collection, scope, searchOptions, optionals = {}) {
-  console.warn('DEPRECATION WARNING: leaderboardAdapter.get is deprecated and will be removed with the next release. Use leaderboardAdapter.list instead.');
-  return await list(collection, scope, searchOptions, optionals);
-}
-
-/**
- * Returns the total count in the given collection
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/leaderboard/count/{SCOPE_BOUNDARY}/{SCOPE_KEY}/{COLLECTION}`
- *
- * @example
- * import { leaderboardAdapter, SCOPE_BOUNDARY } from 'epicenter-libs';
- * const count = await leaderboardAdapter.getCount('myLeaderboard', {
- *     scopeBoundary: SCOPE_BOUNDARY.GROUP,
- *     scopeKey: '0000017dd3bf540e5ada5b1e058f08f20461',
- * }, {
- *     filter: [
- *         'tag.role=doctor',  // look for leaderboard entries tagged with role=doctor
- *         'score.total>0'     // where the users scored a total higher than 0
- *     ],
- * });
- *
- * @param collection                Name of the leaderboard
- * @param scope                     Scope attached to the leaderboard entry; allows for scoping
- * @param scope.scopeBoundary       Scope boundary, defines the type of scope; See [scope boundary](#SCOPE_BOUNDARY) for all types
- * @param scope.scopeKey            Scope key, a unique identifier tied to the scope. E.g., if your `scopeBoundary` is `GROUP`, your `scopeKey` will be your `groupKey`; for `EPISODE`, `episodeKey`, etc.
- * @param searchOptions             Search options for the query
- * @param [searchOptions.filter]    Filters for searching
- * @param [optionals]               Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to the number of entries in the leaderboard
- */
-async function getCount(collection, scope, searchOptions, optionals = {}) {
-  const {
-    scopeBoundary,
-    scopeKey
-  } = scope;
-  const {
-    filter
-  } = searchOptions;
-  const searchParams = {
-    filter: parseFilterInput(filter)
-  };
-  return await new Router().withSearchParams(searchParams).get(`/leaderboard/count/${scopeBoundary}/${scopeKey}/${collection}`, optionals).then(({
-    body
-  }) => body);
-}
-
-export { get, getCount, list, update };

package/dist/test/adapters/matchmaker.js

@@ -1,159 +0,0 @@
-import Router from '../utils/router.js';
-
-/**
- * Creates a matchmaker list; requires facilitator level authentication
- * Base URL: POST `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/matchmaker/udome/{NAME}`
- *
- * @example
- * import { matchmakerAdapter, SCOPE_BOUNDARY } from 'epicenter-libs';
- * const list = await matchmakerAdapter.create('my-matchmaker', 2, {
- *     scopeBoundary: SCOPE_BOUNDARY.GROUP,
- *     scopeKey: '0000017dd3bf540e5ada5b1e058f08f20461',
- * });
- *
- * @param name                  The name for the matchmaker list
- * @param partners              The number of partners each participant should be assigned
- * @param scope                 Scope associated with list
- * @param scope.scopeBoundary   Scope boundary, defines the type of scope; See [scope boundary](#SCOPE_BOUNDARY) for all types
- * @param scope.scopeKey        Scope key, a unique identifier tied to the scope. E.g., if your `scopeBoundary` is `GROUP`, your `scopeKey` will be your `groupKey`; for `EPISODE`, `episodeKey`, etc.
- * @param [optionals]           Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to the matchmaker list object
- */
-async function create(name, partners, scope, optionals = {}) {
-  const {
-    accountShortName,
-    projectShortName,
-    server
-  } = optionals;
-  return await new Router().withServer(server).withAccountShortName(accountShortName).withProjectShortName(projectShortName).post(`/matchmaker/udome/${name}`, {
-    body: {
-      scope,
-      partners
-    }
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Changes the opened/closed status of a matchmaker list; requires facilitator level authentication
- * Base URL: PUT `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/matchmaker/udome/{UDOME_KEY}`
- *
- * @example
- * import { matchmakerAdapter } from 'epicenter-libs';
- * const list = await matchmakerAdapter.edit('udomeKey123', true);
- *
- * @param udomeKey      The unique key for the targeted matchmaker list
- * @param closed        Whether the matchmaker list is open or closed
- * @param [optionals]   Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to the matchmaker list object
- */
-async function edit(udomeKey, closed, optionals = {}) {
-  const {
-    accountShortName,
-    projectShortName,
-    server
-  } = optionals;
-  return await new Router().withServer(server).withAccountShortName(accountShortName).withProjectShortName(projectShortName).put(`/matchmaker/udome/${udomeKey}`, {
-    body: {
-      closed
-    }
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Adds the user making the request to the matchmaker list provided that it is open; requires participant authentication
- * Base URL: PATCH `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/matchmaker/udome`
- *
- * @example
- * import { matchmakerAdapter } from 'epicenter-libs';
- * const list = await matchmakerAdapter.addUser('udomeKey123');
- *
- * @param udomeKey      The unique key for the targeted matchmaker list
- * @param [optionals]   Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to the matchmaker list object
- */
-async function addUser(udomeKey, optionals = {}) {
-  const {
-    accountShortName,
-    projectShortName,
-    server
-  } = optionals;
-  return await new Router().withServer(server).withAccountShortName(accountShortName).withProjectShortName(projectShortName).patch('/matchmaker/udome', {
-    body: {
-      udomeKey
-    }
-  }).then(({
-    body
-  }) => body);
-}
-const NOT_FOUND = 404;
-/**
- * Gets a matchmaker list based on a udomeKey; requires participant level authentication
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/matchmaker/udome/{UDOME_KEY}`
- *
- * @example
- * import { matchmakerAdapter } from 'epicenter-libs';
- * const list = await matchmakerAdapter.get('udomeKey123');
- *
- * @param udomeKey      The unique key for the targeted matchmaker list
- * @param [optionals]   Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to the matchmaker list object, or undefined if not found
- */
-async function get(udomeKey, optionals = {}) {
-  const {
-    accountShortName,
-    projectShortName,
-    server
-  } = optionals;
-  return await new Router().withServer(server).withAccountShortName(accountShortName).withProjectShortName(projectShortName).get(`/matchmaker/udome/${udomeKey}`).catch(error => {
-    if (error.status === NOT_FOUND) return {
-      body: undefined
-    };
-    return Promise.reject(error);
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Gets a matchmaker list based on name and scope; requires participant level authentication
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/matchmaker/udome/{SCOPE_BOUNDARY}/{SCOPE_KEY}/{NAME}`
- *
- * @example
- * import { matchmakerAdapter, SCOPE_BOUNDARY } from 'epicenter-libs';
- * const list = await matchmakerAdapter.byName('my-matchmaker', {
- *     scopeBoundary: SCOPE_BOUNDARY.GROUP,
- *     scopeKey: 'GROUP_KEY',
- * });
- *
- * @param name                  The name of the matchmaker list
- * @param scope                 Scope associated with list
- * @param scope.scopeBoundary   Scope boundary, defines the type of scope; See [scope boundary](#SCOPE_BOUNDARY) for all types
- * @param scope.scopeKey        Scope key, a unique identifier tied to the scope. E.g., if your `scopeBoundary` is `GROUP`, your `scopeKey` will be your `groupKey`; for `EPISODE`, `episodeKey`, etc.
- * @param [optionals]           Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to the matchmaker list object, or undefined if not found
- */
-async function byName(name, scope, optionals = {}) {
-  const {
-    accountShortName,
-    projectShortName,
-    server
-  } = optionals;
-  const {
-    scopeBoundary,
-    scopeKey
-  } = scope;
-  return await new Router().withServer(server).withAccountShortName(accountShortName).withProjectShortName(projectShortName).get(`/matchmaker/udome/${scopeBoundary}/${scopeKey}/${name}`).catch(error => {
-    if (error.status === NOT_FOUND) return {
-      body: undefined
-    };
-    return Promise.reject(error);
-  }).then(({
-    body
-  }) => body);
-}
-
-export { addUser, byName, create, edit, get };

package/dist/test/adapters/presence.js

@@ -1,85 +0,0 @@
-import '../utils/helpers.js';
-import '../utils/config.js';
-import identification from '../utils/identification.js';
-import '../utils/error-manager.js';
-import Router from '../utils/router.js';
-import cometdAdapter from './cometd.js';
-
-/**
- * Makes a connection request to the CometD server; effectively marking the user as online.
- * This isn't required to be called in order to be considered online. Subscribe to a CometD
- * channel will do the same as well. This is just a convenience method for when you don't
- * need to utilize the channels except specifically for presence.
- * Using [logout](#authAdapter-logout) will automatically disconnect for you.
- * Base URL: Uses CometD push channel connection
- *
- * @example
- * import { presenceAdapter } from 'epicenter-libs';
- * await presenceAdapter.connect();
- *
- * @returns promise indicating whether or not the connection was successful
- */
-async function connect() {
-  await cometdAdapter.handshake();
-  return;
-}
-
-/**
- * Disconnects from CometD and removes user presence.
- * Using [logout](#authAdapter-logout) will automatically disconnect for you.
- * Base URL: DELETE `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/presence/group/{GROUP_KEY}`
- *
- * @example
- * import { presenceAdapter } from 'epicenter-libs';
- * await presenceAdapter.disconnect();
- *
- * @param [optionals]   Optional arguments; pass network call options overrides here.
- * @returns promise indicating whether or not the disconnection was successful
- */
-async function disconnect(optionals) {
-  var _identification$sessi;
-  const cleanup = [cometdAdapter.disconnect()];
-  const groupKey = identification === null || identification === void 0 || (_identification$sessi = identification.session) === null || _identification$sessi === void 0 ? void 0 : _identification$sessi.groupKey;
-  if (groupKey) {
-    cleanup.push(new Router().delete(`/presence/group/${groupKey}`, optionals));
-  }
-  await Promise.allSettled(cleanup);
-}
-
-/**
- * Retrieves the presence information for a particular group
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/presence/group/{GROUP_KEY}`
- *
- * @example
- * import { presenceAdapter } from 'epicenter-libs';
- * const presence = await presenceAdapter.forGroup('0000017dd3bf540e5ada5b1e058f08f20461');
- *
- * @param groupKey      Key associated with group
- * @param [optionals]   Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to a list of users online
- */
-async function forGroup(groupKey, optionals = {}) {
-  return await new Router().get(`/presence/group/${groupKey}`, optionals).then(({
-    body
-  }) => body);
-}
-
-/**
- * Retrieves the presence information for a particular world
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/presence/world/{WORLD_KEY}`
- *
- * @example
- * import { presenceAdapter } from 'epicenter-libs';
- * const presence = await presenceAdapter.forWorld('0000017a445032dc38cb2cecd5fc13708314');
- *
- * @param worldKey      Key associated with world
- * @param [optionals]   Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to a list of users online
- */
-async function forWorld(worldKey, optionals = {}) {
-  return await new Router().get(`/presence/world/${worldKey}`, optionals).then(({
-    body
-  }) => body);
-}
-
-export { connect, disconnect, forGroup, forWorld };

package/dist/test/adapters/project.js

@@ -1,94 +0,0 @@
-import '../utils/helpers.js';
-import '../utils/config.js';
-import '../utils/identification.js';
-import '../utils/error-manager.js';
-import Router from '../utils/router.js';
-
-const ACCESS_TYPE = {
-  PUBLIC: 'PUBLIC',
-  PRIVATE: 'PRIVATE',
-  AUTHENTICATED: 'AUTHENTICATED'
-};
-const WORKER_PARTITION = {
-  NONE: 'NONE',
-  ALL: 'ALL',
-  FREE: 'FREE',
-  LICENSED: 'LICENSED',
-  ACCOUNT: 'ACCOUNT'
-};
-const PHYLOGENY = {
-  ORIGINAL: 'ORIGINAL',
-  HISTORICAL: 'HISTORICAL',
-  REFERENTIAL: 'REFERENTIAL',
-  ORDERED: 'ORDERED',
-  EVENTUAL: 'EVENTUAL',
-  /**
-   * TRANSMOGRIFIED Improves the way Epicenter runs proxies.
-   */
-  TRANSMOGRIFIED: 'TRANSMOGRIFIED',
-  /**
-   * REANIMATED Changes the default run start-up ritual.
-   */
-  REANIMATED: 'REANIMATED',
-  /**
-   * SILENT Inhibits push channel notifications unless allowChannel is true, which by default is false.
-   */
-  SILENT: 'SILENT'
-};
-const CHANNEL_PROTOCOL = {
-  OUMUAMUA: 'OUMUAMUA',
-  COMETD: 'COMETD'
-};
-/**
- * Checks to see if the project currently has the push channels enabled
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/project/channel/isEnabled`
- *
- * @example
- * import { projectAdapter } from 'epicenter-libs';
- * const enabled = await projectAdapter.channelsEnabled();
- *
- * @param [optionals]   Optional arguments; pass network call options overrides here.
- * @returns promise resolving true/false whether or not the project supports the use of push channels
- */
-async function channelsEnabled(optionals = {}) {
-  return await new Router().get('/project/channel/isEnabled', optionals).then(({
-    body
-  }) => body);
-}
-
-/**
- * Gets the current project details
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/project`
- *
- * @example
- * import { projectAdapter } from 'epicenter-libs';
- * const project = await projectAdapter.get();
- *
- * @param [optionals]   Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to the project object
- */
-async function get(optionals = {}) {
-  return await new Router().get('/project', optionals).then(({
-    body
-  }) => body);
-}
-
-/**
- * Lists all projects in an account
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/manager/project/in`
- *
- * @example
- * import { projectAdapter } from 'epicenter-libs';
- * const projects = await projectAdapter.list('my-account');
- *
- * @param accountShortName  The account short name
- * @param [optionals]       Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to an array of project objects
- */
-async function list(accountShortName, optionals = {}) {
-  return await new Router().withAccountShortName(accountShortName).withProjectShortName('manager').get('/project/in', optionals).then(({
-    body
-  }) => body);
-}
-
-export { ACCESS_TYPE, CHANNEL_PROTOCOL, PHYLOGENY, WORKER_PARTITION, channelsEnabled, get, list };

package/dist/test/adapters/recaptcha.js

@@ -1,24 +0,0 @@
-import Router from '../utils/router.js';
-
-/**
- * Verifies a Google reCAPTCHA token
- * Base URL: POST `https://forio.com/api/v3/epicenter/manager/recaptcha/google`
- *
- * @example
- * import { recaptchaAdapter } from 'epicenter-libs';
- * const result = await recaptchaAdapter.google(token);
- *
- * @param humanKey  The reCAPTCHA token to verify
- * @returns promise that resolves to the verification result
- */
-async function google(humanKey) {
-  return await new Router().withAccountShortName('epicenter').withProjectShortName('manager').post('/recaptcha/google', {
-    body: {
-      humanKey: humanKey
-    }
-  }).then(({
-    body
-  }) => body);
-}
-
-export { google };