epicenter-libs 3.33.0 → 3.34.1

package/dist/test/adapters/asset.js

@@ -1,425 +0,0 @@
-import fetch from 'cross-fetch';
-import { ROLE } from '../utils/constants.js';
-import '../utils/helpers.js';
-import Fault from '../utils/fault.js';
-import '../utils/config.js';
-import '../utils/identification.js';
-import '../utils/error-manager.js';
-import Router from '../utils/router.js';
-
-/**
- * Creates a presigned URL for uploading a file to S3
- * Base URL: POST `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/asset`
- *
- * @example
- * import { assetAdapter, SCOPE_BOUNDARY } from 'epicenter-libs';
- * const ticket = await assetAdapter.create('myfile.pdf', {
- *     scopeBoundary: SCOPE_BOUNDARY.GROUP,
- *     scopeKey: '0000017dd3bf540e5ada5b1e058f08f20461',
- * });
- *
- * @param file                              File path/name for the asset
- * @param scope                             Scope associated with the asset
- * @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 further scope the asset to a specific 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.readLock]              Role allowed to read; defaults to USER
- * @param [optionals.writeLock]             Role allowed to write; defaults to USER
- * @param [optionals.ttlSeconds]            Time to live in seconds for the asset
- * @param [optionals.tokenAccessSeconds]    How long the presigned URL is valid for in seconds
- * @returns promise that resolves to an asset ticket containing the presigned upload URL
- */
-async function create(file, scope, optionals = {}) {
-  const {
-    scopeBoundary,
-    scopeKey,
-    userKey
-  } = scope;
-  const {
-    readLock,
-    writeLock,
-    ttlSeconds,
-    tokenAccessSeconds,
-    ...routingOptions
-  } = optionals;
-  return await new Router().withSearchParams({
-    tokenAccessSeconds
-  }).post('/asset', {
-    body: {
-      file,
-      scope: {
-        scopeBoundary,
-        scopeKey,
-        userKey
-      },
-      permit: {
-        readLock: readLock !== null && readLock !== void 0 ? readLock : ROLE.USER,
-        writeLock: writeLock !== null && writeLock !== void 0 ? writeLock : ROLE.USER
-      },
-      ttlSeconds
-    },
-    ...routingOptions
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Updates an existing asset and returns a presigned URL for uploading the new file to S3
- * Base URL: PATCH `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/asset`
- *
- * @example
- * import { assetAdapter, SCOPE_BOUNDARY } from 'epicenter-libs';
- * const ticket = await assetAdapter.update('myfile.pdf', {
- *     scopeBoundary: SCOPE_BOUNDARY.GROUP,
- *     scopeKey: '0000017dd3bf540e5ada5b1e058f08f20461',
- * });
- *
- * @param file                              File path/name for the asset
- * @param scope                             Scope associated with the asset
- * @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 further scope the asset to a specific 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.readLock]              Role allowed to read; defaults to USER
- * @param [optionals.writeLock]             Role allowed to write; defaults to USER
- * @param [optionals.ttlSeconds]            Time to live in seconds for the asset
- * @param [optionals.tokenAccessSeconds]    How long the presigned URL is valid for in seconds
- * @returns promise that resolves to an asset ticket containing the presigned upload URL
- */
-async function update(file, scope, optionals = {}) {
-  const {
-    scopeBoundary,
-    scopeKey,
-    userKey
-  } = scope;
-  const {
-    readLock,
-    writeLock,
-    ttlSeconds,
-    tokenAccessSeconds,
-    ...routingOptions
-  } = optionals;
-  return await new Router().withSearchParams({
-    tokenAccessSeconds
-  }).patch('/asset', {
-    body: {
-      file,
-      scope: {
-        scopeBoundary,
-        scopeKey,
-        userKey
-      },
-      permit: {
-        readLock: readLock !== null && readLock !== void 0 ? readLock : ROLE.USER,
-        writeLock: writeLock !== null && writeLock !== void 0 ? writeLock : ROLE.USER
-      },
-      ttlSeconds
-    },
-    ...routingOptions
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Deletes an asset by asset key
- * Base URL: DELETE `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/asset/{ASSET_KEY}`
- *
- * @example
- * import { assetAdapter } from 'epicenter-libs';
- * await assetAdapter.remove('0000017dd3bf540e5ada5b1e058f08f20461');
- *
- * @param assetKey      The unique key for the asset
- * @param [optionals]   Optional arguments; pass network call options overrides here.
- * @returns promise that resolves when the asset is deleted
- */
-async function remove(assetKey, optionals = {}) {
-  return await new Router().delete(`/asset/${assetKey}`, optionals).then(({
-    body
-  }) => body);
-}
-
-/**
- * Deletes all assets within a given scope
- * Base URL: DELETE `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/asset/in/{SCOPE_BOUNDARY}/{SCOPE_KEY}` or DELETE `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/asset/in/{SCOPE_BOUNDARY}/{SCOPE_KEY}/{USER_KEY}`
- *
- * @example
- * import { assetAdapter, SCOPE_BOUNDARY } from 'epicenter-libs';
- * await assetAdapter.removeFromScope({
- *     scopeBoundary: SCOPE_BOUNDARY.GROUP,
- *     scopeKey: '0000017dd3bf540e5ada5b1e058f08f20461',
- * });
- *
- * @param scope                     Scope associated with the assets to delete
- * @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 further scope the deletion to a specific user
- * @param [optionals]               Optional arguments; pass network call options overrides here.
- * @returns promise that resolves when all assets in the scope are deleted
- */
-async function removeFromScope(scope, optionals = {}) {
-  const {
-    scopeBoundary,
-    scopeKey,
-    userKey
-  } = scope;
-  const uriComponent = userKey ? `/${userKey}` : '';
-  return await new Router().delete(`/asset/in/${scopeBoundary}/${scopeKey}${uriComponent}`, optionals).then(({
-    body
-  }) => body);
-}
-
-/**
- * Retrieves asset metadata by asset key
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/asset/{ASSET_KEY}`
- *
- * @example
- * import { assetAdapter } from 'epicenter-libs';
- * const asset = await assetAdapter.get('0000017dd3bf540e5ada5b1e058f08f20461');
- *
- * @param assetKey      The unique key for the asset
- * @param [optionals]   Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to the asset metadata
- */
-async function get(assetKey, optionals = {}) {
-  const {
-    server,
-    accountShortName,
-    projectShortName
-  } = optionals;
-  return await new Router().withServer(server).withAccountShortName(accountShortName).withProjectShortName(projectShortName).get(`/asset/${assetKey}`).then(({
-    body
-  }) => body);
-}
-
-/**
- * Lists all assets within a given scope, optionally filtered by file pattern
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/asset/in/{SCOPE_BOUNDARY}/{SCOPE_KEY}/{FILTER}` or GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/asset/in/{SCOPE_BOUNDARY}/{SCOPE_KEY}/{USER_KEY}/{FILTER}`
- *
- * @example
- * import { assetAdapter, SCOPE_BOUNDARY } from 'epicenter-libs';
- * // List all assets in the scope
- * const assets = await assetAdapter.list({
- *     scopeBoundary: SCOPE_BOUNDARY.GROUP,
- *     scopeKey: '0000017dd3bf540e5ada5b1e058f08f20461',
- * });
- * // List only PDF files
- * const pdfs = await assetAdapter.list({
- *     scopeBoundary: SCOPE_BOUNDARY.GROUP,
- *     scopeKey: '0000017dd3bf540e5ada5b1e058f08f20461',
- * }, { filter: '*.pdf' });
- *
- * @param scope                     Scope associated with the assets
- * @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 further scope the list to a specific 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.filter]        File pattern to filter assets (e.g., '*.pdf' for PDF files); defaults to '*' (all files)
- * @returns promise that resolves to a list of assets
- */
-async function list(scope, optionals = {}) {
-  const {
-    scopeBoundary,
-    scopeKey,
-    userKey
-  } = scope;
-  const {
-    filter,
-    ...routingOptions
-  } = optionals;
-  const uriComponent = userKey ? `/${userKey}` : '';
-  return await new Router().get(`/asset/in/${scopeBoundary}/${scopeKey}${uriComponent}/${filter !== null && filter !== void 0 ? filter : '*'}`, routingOptions).then(({
-    body
-  }) => body);
-}
-
-/**
- * Generates a presigned URL for accessing an asset
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/asset/url/{ASSET_KEY}`
- *
- * @example
- * import { assetAdapter } from 'epicenter-libs';
- * const url = await assetAdapter.getURL('0000017dd3bf540e5ada5b1e058f08f20461');
- * // Use the url to access the asset
- *
- * @param assetKey                          The unique key for the asset
- * @param [optionals]                       Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.tokenAccessSeconds]    How long the presigned URL is valid for in seconds
- * @returns promise that resolves to the presigned URL
- */
-async function getURL(assetKey, optionals = {}) {
-  const {
-    tokenAccessSeconds,
-    ...routingOptions
-  } = optionals;
-  return await new Router().withSearchParams({
-    tokenAccessSeconds
-  }).get(`/asset/url/${assetKey}`, routingOptions).then(({
-    body
-  }) => body);
-}
-
-/**
- * Generates a presigned URL for accessing an asset by scope and file name
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/asset/url/with/{SCOPE_BOUNDARY}/{SCOPE_KEY}/{FILE}` or GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/asset/url/with/{SCOPE_BOUNDARY}/{SCOPE_KEY}/{USER_KEY}/{FILE}`
- *
- * @example
- * import { assetAdapter, SCOPE_BOUNDARY } from 'epicenter-libs';
- * const url = await assetAdapter.getURLWithScope('myfile.pdf', {
- *     scopeBoundary: SCOPE_BOUNDARY.GROUP,
- *     scopeKey: '0000017dd3bf540e5ada5b1e058f08f20461',
- * });
- *
- * @param file                              File path/name for the asset
- * @param scope                             Scope associated with the asset
- * @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 further scope the asset to a specific 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.tokenAccessSeconds]    How long the presigned URL is valid for in seconds
- * @returns promise that resolves to the presigned URL
- */
-async function getURLWithScope(file, scope, optionals = {}) {
-  const {
-    scopeBoundary,
-    scopeKey,
-    userKey
-  } = scope;
-  const {
-    tokenAccessSeconds,
-    ...routingOptions
-  } = optionals;
-  const uriComponent = userKey ? `/${userKey}` : '';
-  return await new Router().withSearchParams({
-    tokenAccessSeconds
-  }).get(`/asset/url/with/${scopeBoundary}/${scopeKey}${uriComponent}/${file}`, routingOptions).then(({
-    body
-  }) => body);
-}
-
-/**
- * Downloads an asset by asset key
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/asset/download/{ASSET_KEY}`
- *
- * @example
- * import { assetAdapter } from 'epicenter-libs';
- * await assetAdapter.download('0000017dd3bf540e5ada5b1e058f08f20461');
- *
- * @param assetKey                          The unique key for the asset
- * @param [optionals]                       Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.tokenAccessSeconds]    How long the presigned URL is valid for in seconds
- * @returns promise that resolves when the download is complete
- */
-async function download(assetKey, optionals = {}) {
-  const {
-    tokenAccessSeconds,
-    ...routingOptions
-  } = optionals;
-  return await new Router().withSearchParams({
-    tokenAccessSeconds
-  }).get(`/asset/download/${assetKey}`, routingOptions).then(({
-    body
-  }) => body);
-}
-
-/**
- * Downloads an asset by scope and file name
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/asset/download/with/{SCOPE_BOUNDARY}/{SCOPE_KEY}/{FILE}` or GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/asset/download/with/{SCOPE_BOUNDARY}/{SCOPE_KEY}/{USER_KEY}/{FILE}`
- *
- * @example
- * import { assetAdapter, SCOPE_BOUNDARY } from 'epicenter-libs';
- * await assetAdapter.downloadWithScope('myfile.pdf', {
- *     scopeBoundary: SCOPE_BOUNDARY.GROUP,
- *     scopeKey: '0000017dd3bf540e5ada5b1e058f08f20461',
- * });
- *
- * @param file                              File path/name for the asset
- * @param scope                             Scope associated with the asset
- * @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 further scope the asset to a specific 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.tokenAccessSeconds]    How long the presigned URL is valid for in seconds
- * @returns promise that resolves when the download is complete
- */
-async function downloadWithScope(file, scope, optionals = {}) {
-  const {
-    scopeBoundary,
-    scopeKey,
-    userKey
-  } = scope;
-  const {
-    tokenAccessSeconds,
-    ...routingOptions
-  } = optionals;
-  const uriComponent = userKey ? `/${userKey}` : '';
-  return await new Router().withSearchParams({
-    tokenAccessSeconds
-  }).get(`/asset/download/with/${scopeBoundary}/${scopeKey}${uriComponent}/${file}`, routingOptions).then(({
-    body
-  }) => body);
-}
-
-/**
- * Convenience function to store a file directly to S3. This function obtains a presigned URL from the Epicenter server and uploads the file to S3. If the asset already exists and `overwrite` is true, it will update the existing asset.
- *
- * @example
- * import { assetAdapter, SCOPE_BOUNDARY, ROLE } from 'epicenter-libs';
- * const file = new File(['content'], 'myfile.pdf');
- * await assetAdapter.store(file, {
- *     scopeBoundary: SCOPE_BOUNDARY.GROUP,
- *     scopeKey: '0000017dd3bf540e5ada5b1e058f08f20461',
- * }, {
- *     overwrite: true,
- *     readLock: ROLE.USER,
- * });
- *
- * @param file                              File object to store
- * @param scope                             Scope associated with the asset
- * @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 further scope the asset to a specific 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.readLock]              Role allowed to read; defaults to USER
- * @param [optionals.writeLock]             Role allowed to write; defaults to USER
- * @param [optionals.ttlSeconds]            Time to live in seconds for the asset
- * @param [optionals.overwrite]             If true, will update the asset if it already exists; if false, will throw an error if the asset exists
- * @param [optionals.fileName]              Optional file name to use instead of the file's name property
- * @param [optionals.tokenAccessSeconds]    How long the presigned URL is valid for in seconds
- * @returns promise that resolves when the file is stored
- */
-const CONFLICT = 409;
-async function store(file, scope, optionals = {}) {
-  const {
-    overwrite,
-    fileName,
-    ...remaining
-  } = optionals;
-  const name = fileName !== null && fileName !== void 0 ? fileName : file.name;
-  let presignedUrl = '';
-  try {
-    const response = await create(name, scope, {
-      inert: true,
-      ...remaining
-    });
-    presignedUrl = response.url;
-  } catch (error) {
-    if (error instanceof Fault) {
-      const shouldUpdate = error.status === CONFLICT && overwrite;
-      if (!shouldUpdate) throw error;
-      const response = await update(name, scope, remaining);
-      presignedUrl = response.url;
-    } else {
-      throw error;
-    }
-  }
-  await fetch(presignedUrl, {
-    method: 'PUT',
-    body: file
-  });
-  return;
-}
-
-export { create, download, downloadWithScope, get, getURL, getURLWithScope, list, remove, removeFromScope, store, update };