epicenter-libs 3.33.0 → 3.34.1

package/dist/test/adapters/vonage.js

@@ -1,130 +0,0 @@
-import { ROLE } from '../utils/constants.js';
-import { getInfo, getSession, postToken, postArchive, deleteArchiveByID } from '../apis/vonage.js';
-
-/**
- * Gets the Vonage project ID (not to be confused with the Epicenter project). Used to initialize the session object on the client side
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/vonage/info`
- *
- * @example
- * import OT from '@opentok/client';
- * import { vonageAdapter } from 'epicenter-libs';
- * const [sessionID, projectID] = await Promise.all([
- *     vonageAdapter.createSession(),
- *     vonageAdapter.getProjectID()
- * ]);
- * const vonageSession = OT.initSession(projectID, sessionID);
- *
- * @param [optionals]   Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to the Vonage project ID (otherwise known as the Vonage API key)
- */
-async function getProjectID(optionals = {}) {
-  return (await getInfo(optionals)).apiKey;
-}
-
-/**
- * Calls the server SDK call for creating a session. Used to create a session object on the client side.
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/vonage/session`
- *
- * @example
- * import OT from '@opentok/client';
- * import { vonageAdapter } from 'epicenter-libs';
- * const [sessionID, projectID] = await Promise.all([
- *     vonageAdapter.createSession(),
- *     vonageAdapter.getProjectID()
- * ]);
- * const vonageSession = OT.initSession(projectID, sessionID);
- *
- * @param [optionals]   Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to an object containing the Vonage session ID
- */
-async function createSession(optionals = {}) {
-  return getSession(optionals);
-}
-
-/**
- * Creates a Vonage session token, used to connect a session.
- * Base URL: POST `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/vonage/token`
- *
- * @example
- * import { vonageAdapter } from 'epicenter-libs';
- * const token = await vonageAdapter.generateToken('2_MX40NzQ...Y1TnZ-fg');
- * vonageSession.connect(token);
- *
- * @param sessionID     ID of the session you're expecting to connect to using the token
- * @param [optionals]   Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to a Vonage session token
- */
-async function generateToken(sessionID, optionals = {}) {
-  return (await postToken({
-    sessionId: sessionID
-  }, optionals)).token;
-}
-
-/**
- * Starts a Vonage archive -- a user recording of a Vonage session
- * Base URL: POST `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/vonage/archive`
- *
- * @example
- * import { authAdapter, vonageAdapter, SCOPE_BOUNDARY } from 'epicenter-libs';
- * const session = authAdapter.getLocalSession();
- * vonageAdapter.startArchive('my-archive', '2_MX40NzQ...Y1TnZ-fg', {
- *     scopeBoundary: SCOPE_BOUNDARY.GROUP,
- *     scopeKey: session.groupKey,
- * })
- *
- * @param name                      Name of the archive; for your own purposes
- * @param sessionID                 ID of the session you're creating an archive for
- * @param scope                     Scope attached to the archive
- * @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, to attach a user to the scope
- * @param [optionals]               Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.readLock]      Read permission role; one of the strings defined in ROLE
- * @param [optionals.writeLock]     Write permission role; one of the strings defined in ROLE
- * @param [optionals.resolution]    Video resolution the archive should be recorded at -- string like '1920x1080'
- * @param [optionals.ttlSeconds]    Life span of the archive (how long before it is deleted); defaults to 604,800 (1 week), max of 31,536,000 (1 year)
- * @returns promise that resolves to an object containing the archive ID and status
- */
-async function startArchive(name, sessionID, scope, optionals = {}) {
-  const {
-    readLock,
-    writeLock,
-    ttlSeconds,
-    resolution,
-    ...routingOptions
-  } = optionals;
-  const {
-    PARTICIPANT,
-    USER
-  } = ROLE;
-  const defaultLock = scope.userKey ? USER : PARTICIPANT;
-  return postArchive({
-    name,
-    sessionId: sessionID,
-    scope,
-    permit: {
-      readLock: readLock !== null && readLock !== void 0 ? readLock : defaultLock,
-      writeLock: writeLock !== null && writeLock !== void 0 ? writeLock : defaultLock
-    },
-    ttlSeconds,
-    resolution
-  }, routingOptions);
-}
-
-/**
- * Stops a Vonage archive -- begins the serialization process for a recording
- * Base URL: DELETE `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/vonage/archive/{ARCHIVE_ID}`
- *
- * @example
- * import { vonageAdapter } from 'epicenter-libs';
- * vonageAdapter.stopArchive('004355...ede770e39');
- *
- * @param archiveID     ID of the archive to stop
- * @param [optionals]   Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to an object containing the archive ID and status (which should be "stopped")
- */
-async function stopArchive(archiveID, optionals = {}) {
-  return deleteArchiveByID(archiveID, optionals);
-}
-
-export { createSession, generateToken, getProjectID, startArchive, stopArchive };

package/dist/test/adapters/wallet.js

@@ -1,130 +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';
-
-/**
- * Updates a wallet
- * Base URL: POST `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/wallet`
- *
- * @example
- * // Add a user's phone number to their wallet
- * import { walletAdapter } from 'epicenter-libs';
- * const scope = {
- *     userKey: '000001796733eef0842f4d6d960997018a33',
- *     scopeBoundary: SCOPE_BOUNDARY.GROUP,
- *     scopeKey: '0000017dd3bf540e5ada5b1e058f08f20461',
- * };
- * walletAdapter.update(scope, [{ label: 'phone', value: '555-555-5555' }]);
- *
- * @param scope                 Scope attached to the wallet; userKey is required
- * @param scope.scopeBoundary   Can be a couple things, commonly group, project, episode, or world
- * @param scope.scopeKey        Key of the resource defined by the scope boundary
- * @param scope.userKey         User key for the user creating the entry, if omitted will use the one in current session
- * @param items                 List of items to update the wallet with
- * @param [optionals]           Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to the updated wallet
- */
-async function update(scope, items, optionals = {}) {
-  var _scope$userKey;
-  const session = identification.session;
-  (_scope$userKey = scope.userKey) !== null && _scope$userKey !== void 0 ? _scope$userKey : scope.userKey = session === null || session === void 0 ? void 0 : session.userKey;
-  return await new Router().post('/wallet', {
-    body: {
-      items,
-      scope
-    },
-    ...optionals
-  }).then(({
-    body
-  }) => body);
-}
-const NOT_FOUND = 404;
-/**
- * Gets a wallet
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/wallet/{SCOPE_BOUNDARY}/{SCOPE_KEY}/{USER_KEY}`
- *
- * @example
- * // Get a user's wallet
- * import { walletAdapter, SCOPE_BOUNDARY } from 'epicenter-libs';
- * const scope = {
- *     userKey: '000001796733eef0842f4d6d960997018a33',
- *     scopeBoundary: SCOPE_BOUNDARY.GROUP,
- *     scopeKey: '0000017dd3bf540e5ada5b1e058f08f20461',
- * };
- * walletAdapter.get(scope);
- *
- * @param scope                 Scope attached to the wallet; userKey is required
- * @param scope.scopeBoundary   Can be a couple things, commonly group, project, episode, or world
- * @param scope.scopeKey        Key of the resource defined by the scope boundary
- * @param scope.userKey         User key for the user creating the entry, if omitted will use the one in current session
- * @param [optionals]           Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to the wallet
- */
-async function get(scope, optionals = {}) {
-  const {
-    scopeBoundary,
-    scopeKey
-  } = scope;
-  let {
-    userKey
-  } = scope;
-  const session = identification.session;
-  userKey !== null && userKey !== void 0 ? userKey : userKey = session === null || session === void 0 ? void 0 : session.userKey;
-  return await new Router().get(`/wallet/${scopeBoundary}/${scopeKey}/${userKey}`, optionals).catch(error => {
-    if (error.status === NOT_FOUND) return {
-      body: undefined
-    };
-    return Promise.reject(error);
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Get all wallets under a certain scope
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/wallet/with/{SCOPE_BOUNDARY}/{SCOPE_KEY}`
- *
- * @example
- * // Get all wallets under a group
- * import { walletAdapter, SCOPE_BOUNDARY } from 'epicenter-libs';
- * const scope = {
- *     scopeBoundary: SCOPE_BOUNDARY.GROUP,
- *     scopeKey: '0000017dd3bf540e5ada5b1e058f08f20461',
- * };
- * walletAdapter.withScope(scope);
- *
- * @param scope                 Scope attached to the wallets
- * @param scope.scopeBoundary   Can be a couple things, commonly group, project, episode, or world
- * @param scope.scopeKey        Key of the resource defined by the scope boundary
- * @param [optionals]           Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to a page of wallets
- */
-async function withScope(scope, optionals = {}) {
-  const {
-    scopeBoundary,
-    scopeKey
-  } = scope;
-  const {
-    first = 0,
-    max,
-    ...routingOptions
-  } = optionals;
-  return await new Router().withSearchParams({
-    first,
-    max
-  }).get(`/wallet/with/${scopeBoundary}/${scopeKey}`, {
-    paginated: true,
-    ...routingOptions
-  }).catch(error => {
-    if (error.status === NOT_FOUND) return {
-      body: undefined
-    };
-    return Promise.reject(error);
-  }).then(({
-    body
-  }) => body);
-}
-
-export { get, update, withScope };