epicenter-libs 3.33.0 → 3.34.1

package/dist/test/adapters/consensus.js

@@ -1,484 +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';
-
-/**
- * Creates a new consensus barrier
- * Base URL: POST `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/consensus/{WORLD_KEY}/{NAME}/{STAGE}`
- *
- * @example
- * import { consensusAdapter } from 'epicenter-libs';
- * await consensusAdapter.create(
- *     '00000173078afb05b4ae4c726637167a1a9e',
- *     'SUBMISSIONS',
- *     'ROUND1',
- *     {
- *         ROLE1: 1,
- *         ROLE2: 1,
- *         ROLE3: 2,
- *     },
- *     {
- *         ROLE1: [{ name: 'step', arguments: [] }],
- *         ROLE2: [{ name: 'step', arguments: [] }],
- *         ROLE3: [{ name: 'step', arguments: [] }],
- *     }
- * );
- *
- * @param worldKey                      World key for the world you are making a consensus barrier for
- * @param name                          Unique string to name a set of consensus barriers
- * @param stage                         Unique string to name one stage of the set of consensus barriers
- * @param expectedRoles                 Map where the keys are the names of each role participating and the number of users expected to submit consensus actions for each role
- * @param defaultActions                Map defining which actions to take if the role specified in the key does not submit
- * @param [optionals]                   Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.ttlSeconds]        How long the consensus barrier lasts for.
- * @param [optionals.transparent]       If the barrier has `transparent: false`, then only one of the default actions will be sent. If it has `transparent: true` then they are all sent.
- * @param [optionals.allowChannel]      Opt into push notifications for this resource. Applicable to projects with phylogeny >= SILENT
- * @returns promise that resolves to the newly created consensus barrier
- */
-async function create(worldKey, name, stage, expectedRoles, defaultActions, optionals = {}) {
-  const {
-    ttlSeconds,
-    transparent = false,
-    allowChannel,
-    ...routingOptions
-  } = optionals;
-  return await new Router().post(`/consensus/${worldKey}/${name}/${stage}`, {
-    body: {
-      expectedRoles,
-      ttlSeconds,
-      transparent,
-      actions: defaultActions,
-      allowChannel
-    },
-    ...routingOptions
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Load one specific consensus barrier by specifying stage
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/consensus/{WORLD_KEY}/{NAME}/{STAGE}`
- *
- * @example
- * import { consensusAdapter } from 'epicenter-libs';
- * await consensusAdapter.load('00000173078afb05b4ae4c726637167a1a9e', 'SUBMISSIONS', 'ROUND1');
- *
- * @param worldKey                      World key for the world you are loading a consensus barrier for
- * @param name                          Unique string that names a set of consensus barriers
- * @param stage                         Unique string to specify which specific barrier to load
- * @param [optionals]                   Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to the consensus barrier
- */
-async function load(worldKey, name, stage, optionals = {}) {
-  return await new Router().get(`/consensus/${worldKey}/${name}/${stage}`, optionals).then(({
-    body
-  }) => body);
-}
-
-/**
- * List all consensus barriers sharing the same name
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/consensus/{WORLD_KEY}/{NAME}`
- *
- * @example
- * import { consensusAdapter } from 'epicenter-libs';
- * await consensusAdapter.list('00000173078afb05b4ae4c726637167a1a9e', 'SUBMISSIONS');
- *
- * @param worldKey                      World key for the world you are loading consensus barriers for
- * @param name                          Unique string that specifies which set of consensus barriers to retrieve
- * @param [optionals]                   Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to a list of consensus barriers
- */
-async function list(worldKey, name, optionals = {}) {
-  return await new Router().get(`/consensus/${worldKey}/${name}`, optionals).then(({
-    body
-  }) => body);
-}
-
-/**
- * Facilitator only. Marks current consensus barrier as complete. Closing the barrier will send default actions for anyone who has not arrived. If the barrier is opaque, then only one of the default actions will be sent, and if it's transparent then they are all sent
- * Base URL: POST `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/consensus/close/{WORLD_KEY}/{NAME}/{STAGE}`
- *
- * @example
- * import { consensusAdapter } from 'epicenter-libs';
- * await consensusAdapter.forceClose('00000173078afb05b4ae4c726637167a1a9e', 'SUBMISSIONS', 'ROUND1');
- *
- * @param worldKey                      World key for the world you are making a consensus barrier for
- * @param name                          Unique string that names a set of consensus barriers
- * @param stage                         Unique string that specifies which stage of the set of consensus barriers to close
- * @param [optionals]                   Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.ritual]            Ritual type for processing the consensus actions
- * @returns promise that resolves to the response
- */
-async function forceClose(worldKey, name, stage, optionals = {}) {
-  const {
-    ritual,
-    ...routingOptions
-  } = optionals;
-  return await new Router().post(`/consensus/close/${worldKey}/${name}/${stage}`, {
-    body: {
-      ritual
-    },
-    ...routingOptions
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Updates the default actions defined in .create. A user can only update their own default actions, and this call will only work for a barrier that has `transparent: true`
- * Base URL: PATCH `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/consensus/actions/{WORLD_KEY}/{NAME}/{STAGE}`
- *
- * @example
- * import { consensusAdapter } from 'epicenter-libs';
- * await consensusAdapter.updateDefaults(
- *     '00000173078afb05b4ae4c726637167a1a9e',
- *     'SUBMISSIONS',
- *     'ROUND1',
- *     [{ name: 'var1', value: 100, objectType: 'set' }]
- * );
- *
- * @param worldKey                      World key for the world you are making a consensus barrier for
- * @param name                          Unique string to name a set of consensus barriers
- * @param stage                         Unique string to name one stage of the set of consensus barriers
- * @param actions                       List of objects describing the default actions to update for the current user
- * @param [optionals]                   Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to the updated consensus barrier
- */
-async function updateDefaults(worldKey, name, stage, actions, optionals = {}) {
-  const {
-    ...routingOptions
-  } = optionals;
-  return await new Router().patch(`/consensus/actions/${worldKey}/${name}/${stage}`, {
-    body: {
-      actions
-    },
-    ...routingOptions
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Submits actions for your turn and marks you as having `submitted`.
- * Note that you can still call operations from the runAdapter directly, but will bypass the consensus requirements.
- * Base URL: POST `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/consensus/publish/{WORLD_KEY}/{NAME}/{STAGE}`
- *
- * @example
- * import { consensusAdapter } from 'epicenter-libs';
- * await consensusAdapter.submitActions(
- *     '00000173078afb05b4ae4c726637167a1a9e',
- *     'SUBMISSIONS',
- *     'ROUND1',
- *     [{ name: 'step', arguments: [] }],
- *     { message: 'Student side submission!' },
- * );
- *
- * @param worldKey                      World key for the world you are making a consensus barrier for
- * @param name                          Unique string to name a set of consensus barriers
- * @param stage                         Unique string to name one stage of the set of consensus barriers
- * @param actions                       List of objects describing the actions to send
- * @param [optionals]                   Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.message]           Message that is stored in the barrier arrival entity; opportunity to note a description regarding this submission
- * @param [optionals.ritual]            Ritual type for processing the consensus actions
- * @returns promise that resolves to the response. Note: the response consensus object will have `triggered: true` for the final user that submits and triggers the barrier. triggered is a virtual field, not stored in the database as part of the barrier entity, so it only appears in the response for the final user submitting
- */
-async function submitActions(worldKey, name, stage, actions, optionals = {}) {
-  const {
-    message,
-    ritual,
-    ...routingOptions
-  } = optionals;
-  return await new Router().post(`/consensus/publish/${worldKey}/${name}/${stage}`, {
-    body: {
-      ritual,
-      actions,
-      message
-    },
-    ...routingOptions
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Deletes the targeted barrier, which allows users to create a new barrier with the same name and stage
- * Base URL: DELETE `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/consensus/{WORLD_KEY}/{NAME}/{STAGE}`
- *
- * @example
- * import { consensusAdapter } from 'epicenter-libs';
- * await consensusAdapter.deleteBarrier(
- *     '00000173078afb05b4ae4c726637167a1a9e',
- *     'SUBMISSIONS',
- *     'ROUND1',
- * );
- *
- * @param worldKey                      World key for the world you are targeting
- * @param name                          Unique string that names a set of consensus barriers
- * @param stage                         Unique string to specify which specific barrier to delete
- * @param [optionals]                   Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to the deleted consensus barrier
- */
-async function deleteBarrier(worldKey, name, stage, optionals = {}) {
-  const {
-    ...routingOptions
-  } = optionals;
-  return await new Router().delete(`/consensus/${worldKey}/${name}/${stage}`, {
-    ...routingOptions
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Deletes all barriers under the same name, which allows users to create new barriers with the same name and stage
- * Base URL: DELETE `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/consensus/{WORLD_KEY}/{NAME}`
- *
- * @example
- * import { consensusAdapter } from 'epicenter-libs';
- * await consensusAdapter.deleteAll(
- *     '00000173078afb05b4ae4c726637167a1a9e',
- *     'SUBMISSIONS',
- * );
- *
- * @param worldKey                      World key for the world you are targeting
- * @param name                          Unique string that names a set of consensus barriers
- * @param [optionals]                   Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to the deleted consensus barriers
- */
-async function deleteAll(worldKey, name, optionals = {}) {
-  const {
-    ...routingOptions
-  } = optionals;
-  return await new Router().delete(`/consensus/${worldKey}/${name}`, {
-    ...routingOptions
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Removes the currently logged in user from the list of users that have arrived at this barrier, thus allowing the user to redo their submission.
- * Base URL: DELETE `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/consensus/arrival/{WORLD_KEY}/{NAME}/{STAGE}`
- *
- * @example
- * import { consensusAdapter } from 'epicenter-libs';
- * await consensusAdapter.undoSubmit(
- *     '00000173078afb05b4ae4c726637167a1a9e',
- *     'SUBMISSIONS',
- *     'ROUND1',
- * );
- *
- * @param worldKey                      World key for the world you are targeting
- * @param name                          Unique string that names a set of consensus barriers
- * @param stage                         Unique string to specify which specific barrier to undo your submission for
- * @param [optionals]                   Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to the updated consensus barrier
- */
-async function undoSubmit(worldKey, name, stage, optionals = {}) {
-  const {
-    ...routingOptions
-  } = optionals;
-  return await new Router().delete(`/consensus/arrival/${worldKey}/${name}/${stage}`, {
-    ...routingOptions
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Facilitator only; artificial triggering of the arrival of a participant to the barrier. Useful for testing or for missing participants
- * Base URL: POST `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/consensus/trigger/{WORLD_KEY}/{NAME}/{STAGE}`
- *
- * @example
- * import { consensusAdapter } from 'epicenter-libs';
- * await consensusAdapter.triggerFor(
- *     '00000173078afb05b4ae4c726637167a1a9e',
- *     'SUBMISSIONS',
- *     'ROUND1',
- *     '0000017cb60ad697e109dcb11cdd4cfcdd1d',
- *     [{ name: 'step', arguments: [] }],
- *     { message: 'Facilitator triggered this submission!' },
- * );
- *
- * @param worldKey                      World key for the world you are targeting
- * @param name                          Unique string that names this set of consensus barriers
- * @param stage                         Unique string that names the stage of targeted barrier
- * @param userKey                       userKey of the user the facilitator is triggering for
- * @param actions                       List of objects describing the actions to send for the specified user
- * @param [optionals]                   Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.message]           Message that is stored in the barrier arrival entity; opportunity to note a description regarding this submission
- * @param [optionals.ritual]            Ritual type for processing the consensus actions
- * @returns promise that resolves to the response
- */
-async function triggerFor(worldKey, name, stage, userKey, actions, optionals = {}) {
-  const {
-    ritual,
-    message,
-    ...routingOptions
-  } = optionals;
-  return await new Router().post(`/consensus/trigger/${worldKey}/${name}/${stage}`, {
-    body: {
-      ritual,
-      userKey,
-      message,
-      actions
-    },
-    ...routingOptions
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Facilitator only; removes the specified user from the list of users that have arrived at this barrier, thus allowing the user to redo their submission. This only removes the arrival, not the role expectation.
- * Base URL: DELETE `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/consensus/untrigger/{WORLD_KEY}/{NAME}/{STAGE}/{USER_KEY}`
- *
- * @example
- * import { consensusAdapter } from 'epicenter-libs';
- * await consensusAdapter.undoSubmitFor(
- *     '00000173078afb05b4ae4c726637167a1a9e',
- *     'SUBMISSIONS',
- *     'ROUND1',
- *     '0000017cb60ad697e109dcb11cdd4cfcdd1d',
- * );
- *
- * @param worldKey                      World key for the world you are targeting
- * @param name                          Unique string that names a set of consensus barriers
- * @param stage                         Unique string to specify which specific barrier to undo submission for
- * @param userKey                       userKey of the user the facilitator is undoing the submit for
- * @param [optionals]                   Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to undefined if successful
- */
-async function undoSubmitFor(worldKey, name, stage, userKey, optionals = {}) {
-  const {
-    ...routingOptions
-  } = optionals;
-  return await new Router().delete(`/consensus/untrigger/${worldKey}/${name}/${stage}/${userKey}`, {
-    ...routingOptions
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Facilitator only; removes the entire role expectation from the consensus barrier based on the specified user's role assignment. This removes the expectation for that role and also removes any arrivals for that user. This is a structural change that affects all users with that role - the barrier will no longer wait for anyone with that role to submit.
- * Base URL: DELETE `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/consensus/expectation/{WORLD_KEY}/{NAME}/{STAGE}/{USER_KEY}`
- *
- * @example
- * import { consensusAdapter } from 'epicenter-libs';
- * await consensusAdapter.removeRoleExpectationFor(
- *     '00000173078afb05b4ae4c726637167a1a9e',
- *     'SUBMISSIONS',
- *     'ROUND1',
- *     '0000017cb60ad697e109dcb11cdd4cfcdd1d',
- * );
- *
- * @param worldKey                      World key for the world you are targeting
- * @param name                          Unique string that names a set of consensus barriers
- * @param stage                         Unique string to specify which specific barrier to remove the role expectation from
- * @param userKey                       userKey of a user whose role will be completely removed from the barrier expectations
- * @param [optionals]                   Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to undefined if successful
- */
-async function removeRoleExpectationFor(worldKey, name, stage, userKey, optionals = {}) {
-  return await new Router().delete(`/consensus/expectation/${worldKey}/${name}/${stage}/${userKey}`, optionals).then(({
-    body
-  }) => body);
-}
-
-/**
- * Pauses the TTL countdown timer for a timed consensus barrier. When paused, the timer stops counting down and the remaining time is preserved. Only works for barriers that have a ttlSeconds value set.
- * Base URL: PATCH `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/consensus/pause/{WORLD_KEY}/{NAME}/{STAGE}`
- *
- * @example
- * import { consensusAdapter } from 'epicenter-libs';
- * await consensusAdapter.pause(
- *     '00000173078afb05b4ae4c726637167a1a9e',
- *     'SUBMISSIONS',
- *     'ROUND1',
- * );
- *
- * @param worldKey                      World key for the world you are targeting
- * @param name                          Unique string that names a set of consensus barriers
- * @param stage                         Unique string to specify which specific barrier to pause
- * @param [optionals]                   Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to the updated consensus barrier
- */
-async function pause(worldKey, name, stage, optionals = {}) {
-  return await new Router().patch(`/consensus/pause/${worldKey}/${name}/${stage}`, {
-    body: {
-      resume: false
-    },
-    ...optionals
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Resumes the TTL countdown timer for a paused consensus barrier. The timer continues from where it was paused. Only works for barriers that were previously paused.
- * Base URL: PATCH `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/consensus/pause/{WORLD_KEY}/{NAME}/{STAGE}`
- *
- * @example
- * import { consensusAdapter } from 'epicenter-libs';
- * await consensusAdapter.resume(
- *     '00000173078afb05b4ae4c726637167a1a9e',
- *     'SUBMISSIONS',
- *     'ROUND1',
- * );
- *
- * @param worldKey                      World key for the world you are targeting
- * @param name                          Unique string that names a set of consensus barriers
- * @param stage                         Unique string to specify which specific barrier to resume
- * @param [optionals]                   Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to the updated consensus barrier
- */
-async function resume(worldKey, name, stage, optionals = {}) {
-  return await new Router().patch(`/consensus/pause/${worldKey}/${name}/${stage}`, {
-    body: {
-      resume: true
-    },
-    ...optionals
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Facilitator only; retrieves multiple consensus barriers across multiple worlds within a group or episode. This allows you to efficiently check the status of barriers across all specified worlds in a single API call.
- * Base URL: POST `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/consensus/in/{GROUP_NAME}` or POST `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/consensus/in/{GROUP_NAME}/{EPISODE_NAME}`
- *
- * @example
- * import { consensusAdapter } from 'epicenter-libs';
- * const barriers = await consensusAdapter.collectInGroup(
- *     {
- *         '00000173078afb05b4ae4c726637167a1a9e': { name: 'SUBMISSIONS', stage: 'ROUND1' },
- *         '00000173078afb05b4ae4c726637167a1b2f': { name: 'SUBMISSIONS', stage: 'ROUND1' },
- *     },
- *     'my-group-name',
- *     { episodeName: 'my-episode-name' }
- * );
- *
- * @param barrierMap                    Map of world keys to barrier name/stage pairs
- * @param groupName                     Name of the group to collect barriers from
- * @param [optionals]                   Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.episodeName]       Name of the episode to collect barriers from (optional)
- * @returns promise that resolves to an array of consensus barriers
- */
-async function collectInGroup(barrierMap, groupName, optionals = {}) {
-  const {
-    episodeName,
-    ...routingOptions
-  } = optionals;
-  return await new Router().post(`/consensus/in/${groupName}${episodeName ? `/${episodeName}` : ''}`, {
-    body: barrierMap,
-    ...routingOptions
-  }).then(({
-    body
-  }) => body);
-}
-
-export { collectInGroup, create, deleteAll, deleteBarrier, forceClose, list, load, pause, removeRoleExpectationFor, resume, submitActions, triggerFor, undoSubmit, undoSubmitFor, updateDefaults };