epicenter-libs 3.33.0 → 3.34.1

package/dist/test/adapters/somebody.js

@@ -1,154 +0,0 @@
-import Router from '../utils/router.js';
-
-/**
- * Adds somebody to an account; somebody is a person who is not a user, but whose information is used in a simulation; requires support level authentication
- * Base URL: POST `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/somebody`
- *
- * @example
- * import { somebodyAdapter, SCOPE_BOUNDARY } from 'epicenter-libs';
- * const email = 'test@test.com';
- * const scope = {
- *     scopeBoundary: SCOPE_BOUNDARY.GROUP,
- *     scopeKey: '0000017dd3bf540e5ada5b1e058f08f20461',
- * };
- * const somebody = await somebodyAdapter.create(email, scope, {
- *     givenName: 'Person',
- *     familyName: 'Family',
- * });
- *
- * @param email                         Email of the person being added
- * @param scope                         Scope associated with the somebody
- * @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. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.givenName]         Given name of the person
- * @param [optionals.familyName]        Family name of the person
- * @returns promise that resolves to the newly created somebody object
- */
-
-async function create(email, scope, optionals = {}) {
-  const {
-    givenName,
-    familyName,
-    ...routingOptions
-  } = optionals;
-  return await new Router().post('/somebody', {
-    body: {
-      email,
-      givenName,
-      familyName,
-      scope
-    },
-    ...routingOptions
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Gets a somebody by their key
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/somebody/{SOMEBODY_KEY}`
- *
- * @example
- * import { somebodyAdapter } from 'epicenter-libs';
- * const somebodyKey = '0000017dd3bf540e5ada5b1e058f08f20461';
- * const somebody = await somebodyAdapter.get(somebodyKey);
- *
- * @param somebodyKey   Key associated with the somebody
- * @param [optionals]   Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to the somebody object, or undefined if not found
- */
-const NOT_FOUND = 404;
-async function get(somebodyKey, optionals = {}) {
-  return await new Router().get(`/somebody/${somebodyKey}`, optionals).catch(error => {
-    if (error.status === NOT_FOUND) return {
-      body: undefined
-    };
-    return Promise.reject(error);
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Gets all somebodies within a specific scope
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/somebody/in/{SCOPE_BOUNDARY}/{SCOPE_KEY}`
- *
- * @example
- * import { somebodyAdapter, SCOPE_BOUNDARY } from 'epicenter-libs';
- * const scope = {
- *     scopeBoundary: SCOPE_BOUNDARY.GROUP,
- *     scopeKey: '0000017dd3bf540e5ada5b1e058f08f20461',
- * };
- * const somebodies = await somebodyAdapter.inScope(scope, { first: 0, max: 100 });
- *
- * @param scope                 Scope associated with the somebodies
- * @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. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.first]     Index of first result to return
- * @param [optionals.max]       Maximum number of results to return (max of 300; default of 300)
- * @returns promise that resolves to a page of somebody objects, or undefined if not found
- */
-async function inScope(scope, optionals = {}) {
-  const {
-    scopeBoundary,
-    scopeKey
-  } = scope;
-  const {
-    first,
-    max,
-    ...routingOptions
-  } = optionals;
-  const searchParams = {
-    first,
-    max
-  };
-  return await new Router().withSearchParams(searchParams).get(`/somebody/in/${scopeBoundary}/${scopeKey}`, {
-    paginated: true,
-    ...routingOptions
-  }).catch(error => {
-    if (error.status === NOT_FOUND) return {
-      body: undefined
-    };
-    return Promise.reject(error);
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Gets a somebody by their email within a specific scope
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/somebody/with/{SCOPE_BOUNDARY}/{SCOPE_KEY}/{EMAIL}`
- *
- * @example
- * import { somebodyAdapter, SCOPE_BOUNDARY } from 'epicenter-libs';
- * const scope = {
- *     scopeBoundary: SCOPE_BOUNDARY.GROUP,
- *     scopeKey: '0000017dd3bf540e5ada5b1e058f08f20461',
- * };
- * const somebody = await somebodyAdapter.byEmail('test@test.com', scope);
- *
- * @param email                 Email of the somebody to retrieve
- * @param scope                 Scope associated with the somebody
- * @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 somebody object, or undefined if not found
- */
-async function byEmail(email, scope, optionals = {}) {
-  const {
-    scopeBoundary,
-    scopeKey
-  } = scope;
-  return await new Router().get(`/somebody/with/${scopeBoundary}/${scopeKey}/${email}`, optionals).catch(error => {
-    if (error.status === NOT_FOUND) return {
-      body: undefined
-    };
-    return Promise.reject(error);
-  }).then(({
-    body
-  }) => body);
-}
-
-export { byEmail, create, get, inScope };

package/dist/test/adapters/task.js

@@ -1,192 +0,0 @@
-import Router from '../utils/router.js';
-
-let RETRY_POLICY = /*#__PURE__*/function (RETRY_POLICY) {
-  RETRY_POLICY["DO_NOTHING"] = "DO_NOTHING";
-  // If the task fails, do nothing (this is the default)
-  RETRY_POLICY["RESCHEDULE"] = "RESCHEDULE";
-  // If the task fails retry at the next scheduled time point
-  RETRY_POLICY["FIRE_ON_FAIL_SAFE"] = "FIRE_ON_FAIL_SAFE"; // Will re-execute the task after it fails; how long until this occurs is equal to ttlSeconds
-  return RETRY_POLICY;
-}({});
-
-// Generic type aliases for task adapter
-
-// Status type for group status tasks
-
-// Trigger type definitions for creating tasks
-
-// Payload type definitions for creating tasks
-
-// Payload type definitions for reading tasks
-
-// Task response structure
-
-/**
- * Creates a task; requires support level authentication
- * Base URL: POST `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/task`
- *
- * @example
- * import { taskAdapter, SCOPE_BOUNDARY } from 'epicenter-libs';
- * const scope = {
- *     scopeBoundary: SCOPE_BOUNDARY.GROUP,
- *     scopeKey: session.groupKey,
- * };
- * const name = 'task-1-send-emails';
- * const payload = {
- *     method: 'POST',
- *     url: 'https://forio.com/app/forio-dev/test-project/send-out-emails',
- * };
- * const trigger = {
- *     value: '0 7 15 * * ?', // triggers on day 15 7am of each month
- *     objectType: 'cron',
- * };
- * await taskAdapter.create(scope, name, payload, trigger);
- *
- * @param scope                                 Scope associated with the task
- * @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]                       Key associated with the user
- * @param name                                  Name of the task
- * @param payload                               An HTTP task object that will be executed when the task is triggered
- * @param payload.method                        Type of method to use with the HTTP request (e.g., 'GET', 'POST', 'PATCH')
- * @param payload.url                           The URL the HTTP request will be sent to
- * @param [payload.body]                        The body of the HTTP request
- * @param [payload.headers]                     Headers to send along with the HTTP request
- * @param trigger                               Object that determines when to run the task (cron, offset, or date)
- * @param [trigger.value]                       For cron: cron expression (e.g., '0 7 * * * ?'). For date: ISO-8601 date-time string
- * @param [trigger.objectType]                  Type of trigger: 'cron', 'offset', or 'date'
- * @param [trigger.minutes]                     For offset triggers: number of minutes until the task triggers
- * @param [trigger.hours]                       For offset triggers: number of hours until the task triggers
- * @param [trigger.days]                        For offset triggers: number of days until the task triggers
- * @param [optionals]                           Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.accountShortName]          Name of account (by default will be the account associated with the session)
- * @param [optionals.projectShortName]          Name of project (by default will be the project associated with the session)
- * @param [optionals.retryPolicy]               Specifies what to do should the task fail; see RETRY_POLICY
- * @param [optionals.failSafeTermination]       The ISO-8601 date-time when the task will be deleted regardless of any triggers; defaults to null
- * @param [optionals.ttlSeconds]                Max life expectancy of the task; used to determine if retrying the task is necessary
- * @returns promise that resolves to the task object including the taskKey
- */
-async function create(scope, name, payload, trigger, optionals = {}) {
-  const {
-    retryPolicy,
-    failSafeTermination,
-    ttlSeconds,
-    ...routingOptions
-  } = optionals;
-  return await new Router().post('/task', {
-    body: {
-      payload: {
-        objectType: 'http',
-        ...payload
-      },
-      trigger,
-      retryPolicy,
-      failSafeTermination,
-      ttlSeconds,
-      scope,
-      name
-    },
-    ...routingOptions
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Deletes a task (changes status to cancelled); requires support level authentication
- * Base URL: DELETE `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/task/{TASK_KEY}`
- *
- * @example
- * import { taskAdapter } from 'epicenter-libs';
- * const taskKey = '0000017dd3bf540e5ada5b1e058f08f20461';
- * await taskAdapter.destroy(taskKey);
- *
- * @param taskKey                               Unique key associated with a task
- * @param [optionals]                           Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.accountShortName]          Name of account (by default will be the account associated with the session)
- * @param [optionals.projectShortName]          Name of project (by default will be the project associated with the session)
- * @returns promise that resolves to undefined when successful
- */
-async function destroy(taskKey, optionals = {}) {
-  return await new Router().delete(`/task/${taskKey}`, optionals).then(({
-    body
-  }) => body);
-}
-
-/**
- * Gets a task by taskKey; requires support level authentication
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/task/{TASK_KEY}`
- *
- * @example
- * import { taskAdapter } from 'epicenter-libs';
- * const taskKey = '0000017dd3bf540e5ada5b1e058f08f20461';
- * const task = await taskAdapter.get(taskKey);
- *
- * @param taskKey                               Unique key associated with a task
- * @param [optionals]                           Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.accountShortName]          Name of account (by default will be the account associated with the session)
- * @param [optionals.projectShortName]          Name of project (by default will be the project associated with the session)
- * @returns promise that resolves to the task object
- */
-async function get(taskKey, optionals = {}) {
-  return await new Router().get(`/task/${taskKey}`, optionals).then(({
-    body
-  }) => body);
-}
-
-/**
- * Gets the history (100 most recent times it has triggered) of a task by taskKey; requires support level authentication
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/task/history/{TASK_KEY}`
- *
- * @example
- * import { taskAdapter } from 'epicenter-libs';
- * const taskKey = '0000017dd3bf540e5ada5b1e058f08f20461';
- * const history = await taskAdapter.getHistory(taskKey);
- *
- * @param taskKey                               Unique key associated with a task
- * @param [optionals]                           Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.accountShortName]          Name of account (by default will be the account associated with the session)
- * @param [optionals.projectShortName]          Name of project (by default will be the project associated with the session)
- * @returns promise that resolves to an array of task history objects
- */
-async function getHistory(taskKey, optionals = {}) {
-  return await new Router().get(`/task/history/${taskKey}`, optionals).then(({
-    body
-  }) => body);
-}
-
-/**
- * Gets most recent 100 tasks related to the selected scope; requires support level authentication
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/task/in/{SCOPE_BOUNDARY}/{SCOPE_KEY}` or GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/task/in/{SCOPE_BOUNDARY}/{SCOPE_KEY}/{USER_KEY}`
- *
- * Note: Will retrieve all tasks that were CREATED in the specified scope. If something was created with episode scope, it will not be retrievable through group scoping.
- *
- * @example
- * import { taskAdapter, SCOPE_BOUNDARY } from 'epicenter-libs';
- * const scope = {
- *     scopeBoundary: SCOPE_BOUNDARY.GROUP,
- *     scopeKey: '0000017dd3bf540e5ada5b1e058f08f20461',
- * };
- * const tasks = await taskAdapter.getTaskIn(scope);
- *
- * @param scope                                 Scope associated with the tasks
- * @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]                       Key associated with the user; will retrieve tasks in the scope that were made by 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.accountShortName]          Name of account (by default will be the account associated with the session)
- * @param [optionals.projectShortName]          Name of project (by default will be the project associated with the session)
- * @returns promise that resolves to an array of task objects
- */
-async function getTaskIn(scope, optionals = {}) {
-  const {
-    scopeBoundary,
-    scopeKey,
-    userKey
-  } = scope;
-  return await new Router().get(`/task/in/${scopeBoundary}/${scopeKey}${userKey ? `/${userKey}` : ''}`, optionals).then(({
-    body
-  }) => body);
-}
-
-export { RETRY_POLICY, create, destroy, get, getHistory, getTaskIn };

package/dist/test/adapters/time.js

@@ -1,28 +0,0 @@
-import Router from '../utils/router.js';
-
-/**
- * Fetches the current server time
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/time`
- *
- * @example
- * import { timeAdapter } from 'epicenter-libs';
- * const serverTime = await timeAdapter.get();
- *
- * @param [optionals]                           Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.accountShortName]          Name of account (by default will be the account associated with the session)
- * @param [optionals.projectShortName]          Name of project (by default will be the project associated with the session)
- * @returns promise that resolves to the current server time in ISO 8601 format, or undefined if not found
- */
-const NOT_FOUND = 404;
-async function get(optionals = {}) {
-  return await new Router().get('/time', optionals).catch(error => {
-    if (error.status === NOT_FOUND) return {
-      body: undefined
-    };
-    return Promise.reject(error);
-  }).then(({
-    body
-  }) => body);
-}
-
-export { get };

package/dist/test/adapters/user.js

@@ -1,105 +0,0 @@
-import Router from '../utils/router.js';
-
-// Generic type alias for SSO realm data
-
-/**
- * Upload a CSV file to create multiple users
- * Base URL: POST `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/user/upload`
- *
- * @example
- * import { userAdapter } from 'epicenter-libs';
- * const file = new File([csvContent], 'users.csv');
- * const report = await userAdapter.uploadCSV(file, { overwrite: true });
- *
- * @param file                      CSV file containing user data
- * @param [optionals]               Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.overwrite]     If true, overwrites existing users with matching identifiers; defaults to false
- * @returns promise that resolves to a report containing created, updated, and discarded users
- */
-async function uploadCSV(file, optionals = {}) {
-  const {
-    overwrite,
-    ...routingOptions
-  } = optionals;
-  const formdata = new FormData();
-  formdata.append('file', file);
-  return await new Router().withSearchParams({
-    overwrite
-  }).post('/user/upload', {
-    body: formdata,
-    ...routingOptions
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Create a new user (native or external).
- * Base URL: POST `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/user`
- *
- * @example
- * import { userAdapter } from 'epicenter-libs';
- * // Create a native user
- * const user = await userAdapter.createUser({
- *     objectType: 'native',
- *     handle: 'john.doe',
- *     displayName: 'John Doe',
- *     email: 'john@example.com',
- * });
- *
- * @param view              User data to create; can be either a native or external user
- * @param [optionals]       Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to the created user
- */
-async function createUser(view, optionals = {}) {
-  return await new Router().post('/user', {
-    body: view,
-    ...optionals
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Gets a specific user.
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/user/{USER_KEY}`
- *
- * @example
- * import { userAdapter } from 'epicenter-libs';
- * const user = await userAdapter.get('00000179b4d3fb0c84f822df8cd2aa53be25');
- *
- * @param userKey       The user key
- * @param [optionals]   Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to a user
- */
-async function get(userKey, optionals = {}) {
-  return await new Router().get(`/user/${userKey}`, optionals).then(({
-    body
-  }) => body);
-}
-
-/**
- * Gets a specific user by their handle.
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/user/with/{HANDLE}` or GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/user/with/{HANDLE}/{MODALITY}`
- *
- * @example
- * import { userAdapter } from 'epicenter-libs';
- * const user = await userAdapter.getWithHandle('john.doe@example.com', { modality: 'email' });
- *
- * @param handle                Handle of the user to retrieve
- * @param [optionals]           Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.modality]  Modality to filter by (e.g., 'email', 'sms')
- * @returns promise that resolves to a user
- */
-async function getWithHandle(handle, optionals = {}) {
-  const {
-    modality,
-    ...routingOptions
-  } = optionals;
-  const uriComponent = modality ? `/${modality}` : '';
-  return await new Router().get(`/user/with/${handle}${uriComponent}`, routingOptions).then(({
-    body
-  }) => body);
-}
-
-export { createUser, get, getWithHandle, uploadCSV };