@atlaskit/media-client 39.1.20 → 39.2.0

package/dist/esm/test-helpers/MockedMediaApi/createProcessingFileItem.js

@@ -0,0 +1,57 @@
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+/**
+ * Simulates the processing of the file by updating the processing status of the artifacts by a percentage
+ * Percent must be between 0 and 1
+ */
+export var createProcessingFileItem = function createProcessingFileItem(fileItem, percent) {
+  if (percent < 0 || percent > 1) {
+    throw new Error('Error createProcessingFileItem: percent must be between 0 and 1');
+  }
+
+  /**
+   * This behaviour has to be confirmed
+   * Artifacts show up immediately after processed or they have a
+   * "processing time"?
+   */
+
+  if (percent === 1) {
+    return fileItem;
+  }
+
+  // No artifacts for 0% processing
+  if (percent === 0) {
+    return _objectSpread(_objectSpread({}, fileItem), {}, {
+      details: _objectSpread(_objectSpread({}, fileItem.details), {}, {
+        processingStatus: 'pending',
+        artifacts: {},
+        // The preview will only be ready at 100% -> TODO verify against backend
+        representations: {}
+      })
+    });
+  }
+  var artifactsKeys = Object.keys(fileItem.details.artifacts);
+  var artifactsEntries = Object.entries(fileItem.details.artifacts);
+
+  // Get a % of the total artifacts to be set as processed
+  var processedArtifactKeys = artifactsKeys.slice(0, Math.ceil(artifactsKeys.length * percent));
+  var processedArtifactEntries = artifactsEntries.map(function (_ref) {
+    var _ref2 = _slicedToArray(_ref, 2),
+      key = _ref2[0],
+      artifact = _ref2[1];
+    return [key, _objectSpread(_objectSpread({}, artifact), {}, {
+      processingStatus: processedArtifactKeys.includes(key) ? 'succeeded' : 'pending'
+    })];
+  });
+  var artifactsProcessingPercent = Object.fromEntries(processedArtifactEntries);
+  return _objectSpread(_objectSpread({}, fileItem), {}, {
+    details: _objectSpread(_objectSpread({}, fileItem.details), {}, {
+      processingStatus: 'pending',
+      artifacts: artifactsProcessingPercent,
+      // The preview will only be ready at 100% -> TODO verify against backend
+      representations: {}
+    })
+  });
+};

package/dist/esm/test-helpers/MockedMediaApi/createUploadingFileState.js

@@ -0,0 +1,24 @@
+export var createUploadingFileState = function createUploadingFileState(_ref, progress, binary) {
+  var id = _ref.id,
+    _ref$details = _ref.details,
+    name = _ref$details.name,
+    size = _ref$details.size,
+    mediaType = _ref$details.mediaType,
+    mimeType = _ref$details.mimeType,
+    createdAt = _ref$details.createdAt;
+  return {
+    status: 'uploading',
+    progress: progress,
+    id: id,
+    name: name,
+    size: size,
+    mediaType: mediaType,
+    mimeType: mimeType,
+    createdAt: createdAt,
+    preview: {
+      value: binary || new Blob(['some-content'], {
+        type: mimeType
+      })
+    }
+  };
+};

package/dist/esm/test-helpers/MockedMediaApi/getIdentifier.js

@@ -0,0 +1,10 @@
+/**
+ * Extracts the file identifier from the provided file item
+ */
+export var getIdentifier = function getIdentifier(fileItem) {
+  return {
+    mediaItemType: 'file',
+    id: fileItem.id,
+    collectionName: fileItem.collection
+  };
+};

package/dist/esm/test-helpers/MockedMediaApi/getMediaFile.js

@@ -0,0 +1,11 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+// --------------------------------------------------------
+// Utils for the main class
+// --------------------------------------------------------
+export var getMediaFile = function getMediaFile(fileItem) {
+  return _objectSpread({
+    id: fileItem.id
+  }, fileItem.details);
+};

package/dist/esm/test-helpers/MockedMediaApi/helpers.js

@@ -0,0 +1,47 @@
+/* eslint-disable @repo/internal/deprecations/deprecation-ticket-required -- VOLTC-139 tracks removal of these deprecated re-export shims. */
+
+/**
+ * @deprecated Use `import { normaliseInput } from '@atlaskit/media-client/test-helpers/mocked-media-api/helpers'` instead.
+ */
+
+export { normaliseInput } from './normaliseInput';
+/**
+ * @deprecated Use `import { getMediaFile } from '@atlaskit/media-client/test-helpers/mocked-media-api/helpers'` instead.
+ */
+export { getMediaFile } from './getMediaFile';
+/**
+ * @deprecated Use `import { createEmptyFileItem } from '@atlaskit/media-client/test-helpers'` instead.
+ */
+export { createEmptyFileItem } from './createEmptyFileItem';
+/**
+ * @deprecated Use `import { createProcessingFileItem } from '@atlaskit/media-client/test-helpers'` instead.
+ */
+export { createProcessingFileItem } from './createProcessingFileItem';
+/**
+ * @deprecated Use `import { copy } from '@atlaskit/media-client/test-helpers'` instead.
+ */
+export { copy } from './copy';
+/**
+ * @deprecated Use `import { merge } from '@atlaskit/media-client/test-helpers'` instead.
+ */
+export { merge } from './merge';
+/**
+ * @deprecated Use `import { assign } from '@atlaskit/media-client/test-helpers'` instead.
+ */
+export { assign } from './assign';
+/**
+ * @deprecated Use `import { getIdentifier } from '@atlaskit/media-client/test-helpers'` instead.
+ */
+export { getIdentifier } from './getIdentifier';
+/**
+ * @deprecated Use `import { createFileState } from '@atlaskit/media-client/test-helpers'` instead.
+ */
+export { createFileState } from './createFileState';
+/**
+ * @deprecated Use `import { createUploadingFileState } from '@atlaskit/media-client/test-helpers'` instead.
+ */
+export { createUploadingFileState } from './createUploadingFileState';
+/**
+ * @deprecated Use `import { createErrorFileState } from '@atlaskit/media-client/test-helpers'` instead.
+ */
+export { createErrorFileState } from './createErrorFileState';

package/dist/esm/test-helpers/MockedMediaApi/merge.js

@@ -0,0 +1,14 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+/**
+ * Adds/overrides the attributes from fileItemB into the fileItemA
+ * */
+export var merge = function merge(fileItemA, fileItemB) {
+  var _fileItemA$details, _fileItemB$details;
+  return _objectSpread(_objectSpread(_objectSpread({}, fileItemA), fileItemB), {}, {
+    details: _objectSpread(_objectSpread(_objectSpread({}, fileItemA === null || fileItemA === void 0 ? void 0 : fileItemA.details), fileItemB === null || fileItemB === void 0 ? void 0 : fileItemB.details), {}, {
+      artifacts: _objectSpread(_objectSpread({}, fileItemA === null || fileItemA === void 0 || (_fileItemA$details = fileItemA.details) === null || _fileItemA$details === void 0 ? void 0 : _fileItemA$details.artifacts), fileItemB === null || fileItemB === void 0 || (_fileItemB$details = fileItemB.details) === null || _fileItemB$details === void 0 ? void 0 : _fileItemB$details.artifacts)
+    })
+  });
+};

package/dist/esm/test-helpers/MockedMediaApi/normaliseInput.js

@@ -0,0 +1,6 @@
+// --------------------------------------------------------
+// Factory Utils
+// --------------------------------------------------------
+export var normaliseInput = function normaliseInput(input) {
+  return !input ? [] : input instanceof Array ? input : [input];
+};

package/dist/esm/test-helpers/MockedMediaApi/types.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/test-helpers/_numbers.js

@@ -0,0 +1,3 @@
+export function numbers(count) {
+  return Array.from(Array(count).keys());
+}

package/dist/esm/test-helpers/authProvider.js

@@ -0,0 +1,62 @@
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
+import _createClass from "@babel/runtime/helpers/createClass";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+import { defaultCollectionName } from './collectionNames';
+var cachedAuths = {};
+var authProviderBaseURL = 'https://media-playground.dev.atl-paas.net/';
+export var StoryBookAuthProvider = /*#__PURE__*/function () {
+  function StoryBookAuthProvider() {
+    _classCallCheck(this, StoryBookAuthProvider);
+  }
+  return _createClass(StoryBookAuthProvider, null, [{
+    key: "create",
+    value: function create(isAsapEnvironment, access) {
+      var loadTenatAuth = /*#__PURE__*/function () {
+        var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(collectionName) {
+          var environment, headers, config, url, response;
+          return _regeneratorRuntime.wrap(function (_context) {
+            while (1) switch (_context.prev = _context.next) {
+              case 0:
+                environment = isAsapEnvironment ? 'asap' : '';
+                headers = new Headers();
+                headers.append('Content-Type', 'application/json; charset=utf-8');
+                headers.append('Accept', 'text/plain, */*; q=0.01');
+                config = {
+                  method: 'POST',
+                  headers: headers,
+                  body: access ? JSON.stringify({
+                    access: access
+                  }) : undefined
+                };
+                url = "".concat(authProviderBaseURL, "/token/tenant?collection=").concat(collectionName, "&environment=").concat(environment);
+                response = fetch(url, config); // We leverage the fact, that our internal /toke/tenant API returns data in the same format as Auth
+                _context.next = 1;
+                return response;
+              case 1:
+                _context.next = 2;
+                return _context.sent.json();
+              case 2:
+                return _context.abrupt("return", _context.sent);
+              case 3:
+              case "end":
+                return _context.stop();
+            }
+          }, _callee);
+        }));
+        return function loadTenatAuth(_x) {
+          return _ref.apply(this, arguments);
+        };
+      }();
+      return function (authContext) {
+        var collectionName = authContext && authContext.collectionName || defaultCollectionName;
+        var accessStr = access ? JSON.stringify(access) : '';
+        var cacheKey = "".concat(collectionName, "-").concat(accessStr, "-").concat(isAsapEnvironment);
+        if (!cachedAuths[cacheKey]) {
+          cachedAuths[cacheKey] = loadTenatAuth(collectionName);
+        }
+        return cachedAuths[cacheKey];
+      };
+    }
+  }]);
+}();

package/dist/esm/test-helpers/cachedAuths.js

@@ -0,0 +1 @@
+export var cachedAuths = {};

package/dist/esm/test-helpers/collectionNames.js

@@ -0,0 +1,5 @@
+export var defaultCollectionName = 'MediaServicesSample';
+export var onlyAnimatedGifsCollectionName = 'only-animated-gifs';
+export var fileCollectionName = "".concat(defaultCollectionName, "Files");
+export var defaultMediaPickerCollectionName = 'mediapicker-test';
+export var collectionNames = [defaultCollectionName, 'MediaServicesSampleAtlaskit', 'MediaServicesSampleHulk', 'MediaServicesSampleFabric', fileCollectionName, onlyAnimatedGifsCollectionName, defaultMediaPickerCollectionName];

package/dist/esm/test-helpers/createMediaStoreError.js

@@ -0,0 +1,4 @@
+import { MediaStoreError } from '../client/media-store/MediaStoreError';
+export var createMediaStoreError = function createMediaStoreError() {
+  return new MediaStoreError('missingInitialAuth');
+};

package/dist/esm/test-helpers/createPollingMaxAttemptsError.js

@@ -0,0 +1,7 @@
+import { PollingError } from '../utils/polling';
+export var createPollingMaxAttemptsError = function createPollingMaxAttemptsError() {
+  var attempts = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 1;
+  return new PollingError('pollingMaxAttemptsExceeded', {
+    attempts: attempts
+  });
+};

package/dist/esm/test-helpers/createRateLimitedError.js

@@ -0,0 +1,11 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+import { RequestError } from '../utils/request';
+import { defaultMetadata } from './defaultMetadata';
+export var createRateLimitedError = function createRateLimitedError() {
+  var metadataAndHeaders = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : defaultMetadata;
+  return new RequestError('serverRateLimited', _objectSpread(_objectSpread({}, metadataAndHeaders), {}, {
+    statusCode: 429
+  }));
+};

package/dist/esm/test-helpers/createServerUnauthorizedError.js

@@ -0,0 +1,12 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+import { RequestError } from '../utils/request';
+import { defaultMetadata } from './defaultMetadata';
+export var createServerUnauthorizedError = function createServerUnauthorizedError() {
+  var metadataAndHeaders = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : defaultMetadata;
+  var innerError = arguments.length > 1 ? arguments[1] : undefined;
+  return new RequestError('serverUnauthorized', _objectSpread(_objectSpread({}, metadataAndHeaders), {}, {
+    statusCode: 403
+  }), innerError || new Error('inner error message'));
+};

package/dist/esm/test-helpers/createStorybookMediaClient.js

@@ -0,0 +1,14 @@
+import { MediaClient } from '..';
+import { createStorybookMediaClientConfig } from './createStorybookMediaClientConfig';
+import { defaultAuthParameter } from './defaultAuthParameter';
+
+/**
+ * Creates and returns `MediaClient` (from `media-client`) based on the data provided in parameter object.
+ *
+ * @param {AuthParameter} authParameter specifies serviceName and whatever auth should be done with clientId or asapIssuer
+ * @returns {Context}
+ */
+export var createStorybookMediaClient = function createStorybookMediaClient() {
+  var authParameter = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : defaultAuthParameter;
+  return new MediaClient(createStorybookMediaClientConfig(authParameter));
+};

package/dist/esm/test-helpers/createStorybookMediaClientConfig.js

@@ -0,0 +1,18 @@
+import { StoryBookAuthProvider } from './authProvider';
+import { collectionNames } from './collectionNames';
+import { defaultAuthParameter } from './defaultAuthParameter';
+export var createStorybookMediaClientConfig = function createStorybookMediaClientConfig() {
+  var authParameter = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : defaultAuthParameter;
+  var scopes = {
+    'urn:filestore:file:*': ['read'],
+    'urn:filestore:chunk:*': ['read']
+  };
+  collectionNames.forEach(function (c) {
+    scopes["urn:filestore:collection:".concat(c)] = ['read', 'update'];
+  });
+  var isAsapEnvironment = authParameter.authType === 'asap';
+  var authProvider = StoryBookAuthProvider.create(isAsapEnvironment, scopes);
+  return {
+    authProvider: authProvider
+  };
+};

package/dist/esm/test-helpers/createUploadMediaClient.js

@@ -0,0 +1,5 @@
+import { MediaClient } from '..';
+import { createUploadMediaClientConfig } from './createUploadMediaClientConfig';
+export var createUploadMediaClient = function createUploadMediaClient() {
+  return new MediaClient(createUploadMediaClientConfig());
+};

package/dist/esm/test-helpers/createUploadMediaClientConfig.js

@@ -0,0 +1,7 @@
+import { mediaPickerAuthProvider } from './mediaPickerAuthProvider';
+export var createUploadMediaClientConfig = function createUploadMediaClientConfig(stargateBaseUrl, env) {
+  return {
+    authProvider: mediaPickerAuthProvider('asap', env),
+    stargateBaseUrl: stargateBaseUrl
+  };
+};

package/dist/esm/test-helpers/defaultAuthParameter.js

@@ -0,0 +1,3 @@
+export var defaultAuthParameter = {
+  authType: 'client'
+};

package/dist/esm/test-helpers/defaultMediaPickerAuthProvider.js

@@ -0,0 +1,11 @@
+import { authProviderBaseURL } from './mediaPickerAuthProvider';
+export var defaultMediaPickerAuthProvider = function defaultMediaPickerAuthProvider() {
+  return function () {
+    var auth = {
+      clientId: 'a89be2a1-f91f-485c-9962-a8fb25ccfa13',
+      token: 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJhODliZTJhMS1mOTFmLTQ4NWMtOTk2Mi1hOGZiMjVjY2ZhMTMiLCJ1bnNhZmUiOnRydWUsImlhdCI6MTQ3MzIyNTEzNn0.6Isj5jKgKzWDnPqfoMLiC_LVIlGM8kg_wxG6eGGwhTw',
+      baseUrl: authProviderBaseURL
+    };
+    return Promise.resolve(auth);
+  };
+};

package/dist/esm/test-helpers/defaultMetadata.js

@@ -0,0 +1,10 @@
+export var defaultMetadata = {
+  attempts: 5,
+  clientExhaustedRetries: true,
+  mediaRegion: 'test-media-region',
+  mediaEnv: 'test-media-env',
+  traceContext: {
+    traceId: 'some-trace',
+    spanId: 'some-span'
+  }
+};