@atlaskit/media-test-helpers 31.0.0 → 32.1.0

package/dist/esm/fileStateFactory/fileSimulation/simulations.js

@@ -0,0 +1,382 @@
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+import { sleep } from '../../nextTick';
+var speed = 1500;
+/**
+ * Normal File Flow
+ */
+
+export var simulateProcessed = function simulateProcessed() {
+  var withRemotePreview = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
+  return {
+    simulation: function () {
+      var _simulation = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(factory) {
+        return _regeneratorRuntime.wrap(function _callee$(_context) {
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              _context.next = 2;
+              return sleep(speed);
+            case 2:
+              factory.next('processed', {
+                withRemotePreview: withRemotePreview
+              });
+            case 3:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee);
+      }));
+      function simulation(_x) {
+        return _simulation.apply(this, arguments);
+      }
+      return simulation;
+    }(),
+    description: "File state is processed ".concat(withRemotePreview ? 'with' : 'without', " remote preview")
+  };
+};
+export var simulateProcessing = function simulateProcessing() {
+  var suceeded = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
+  var withRemotePreview = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
+  return {
+    description: "File is processing, then ".concat(suceeded ? 'succeeds' : 'fails', " ").concat(withRemotePreview ? 'with' : 'without', " remote preview"),
+    simulation: function () {
+      var _simulation2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(factory) {
+        return _regeneratorRuntime.wrap(function _callee2$(_context2) {
+          while (1) switch (_context2.prev = _context2.next) {
+            case 0:
+              _context2.next = 2;
+              return sleep(speed);
+            case 2:
+              factory.next('processing');
+              _context2.next = 5;
+              return sleep(speed);
+            case 5:
+              factory.next('processing');
+              _context2.next = 8;
+              return sleep(speed * 0.5);
+            case 8:
+              if (!suceeded) {
+                factory.next('failed-processing', {
+                  withRemotePreview: withRemotePreview
+                });
+              } else {
+                factory.next('processed', {
+                  withRemotePreview: withRemotePreview
+                });
+              }
+            case 9:
+            case "end":
+              return _context2.stop();
+          }
+        }, _callee2);
+      }));
+      function simulation(_x2) {
+        return _simulation2.apply(this, arguments);
+      }
+      return simulation;
+    }()
+  };
+};
+export var simulateImmediateFailProcessing = function simulateImmediateFailProcessing() {
+  return {
+    description: 'The first sate is failed-processing with no preview',
+    simulation: function () {
+      var _simulation3 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(factory) {
+        return _regeneratorRuntime.wrap(function _callee3$(_context3) {
+          while (1) switch (_context3.prev = _context3.next) {
+            case 0:
+              _context3.next = 2;
+              return sleep(speed);
+            case 2:
+              factory.next('failed-processing');
+            case 3:
+            case "end":
+              return _context3.stop();
+          }
+        }, _callee3);
+      }));
+      function simulation(_x3) {
+        return _simulation3.apply(this, arguments);
+      }
+      return simulation;
+    }()
+  };
+};
+export var simulateUpload = function simulateUpload(withLocalPreview) {
+  var suceeded = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
+  return {
+    description: '',
+    simulation: function () {
+      var _simulation4 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee4(factory) {
+        var chunks, chunkUploadDelay, processingTime, uploadUpTo, index;
+        return _regeneratorRuntime.wrap(function _callee4$(_context4) {
+          while (1) switch (_context4.prev = _context4.next) {
+            case 0:
+              chunks = 3;
+              chunkUploadDelay = 500;
+              processingTime = speed;
+              _context4.next = 5;
+              return sleep(speed);
+            case 5:
+              factory.next('uploading', {
+                withLocalPreview: withLocalPreview
+              });
+              uploadUpTo = !suceeded ? chunks / 2 : chunks;
+              index = 0;
+            case 8:
+              if (!(index <= uploadUpTo)) {
+                _context4.next = 15;
+                break;
+              }
+              factory.next('uploading', {
+                uploadProgress: index / chunks,
+                withLocalPreview: withLocalPreview
+              });
+              _context4.next = 12;
+              return sleep(chunkUploadDelay);
+            case 12:
+              index++;
+              _context4.next = 8;
+              break;
+            case 15:
+              if (!suceeded) {
+                factory.error(new Error('some-error'));
+              }
+              factory.next('processing', {
+                withLocalPreview: withLocalPreview
+              });
+              _context4.next = 19;
+              return sleep(processingTime);
+            case 19:
+              factory.next('processed', {
+                withLocalPreview: withLocalPreview
+              });
+            case 20:
+            case "end":
+              return _context4.stop();
+          }
+        }, _callee4);
+      }));
+      function simulation(_x4) {
+        return _simulation4.apply(this, arguments);
+      }
+      return simulation;
+    }()
+  };
+};
+export var simulateErrorState = function simulateErrorState() {
+  return {
+    description: 'File state is error',
+    simulation: function () {
+      var _simulation5 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee5(factory) {
+        return _regeneratorRuntime.wrap(function _callee5$(_context5) {
+          while (1) switch (_context5.prev = _context5.next) {
+            case 0:
+              _context5.next = 2;
+              return sleep(speed);
+            case 2:
+              factory.next('error');
+            case 3:
+            case "end":
+              return _context5.stop();
+          }
+        }, _callee5);
+      }));
+      function simulation(_x5) {
+        return _simulation5.apply(this, arguments);
+      }
+      return simulation;
+    }()
+  };
+};
+export var simulateError = function simulateError() {
+  return {
+    description: 'Subscription throws an error through the observer',
+    simulation: function () {
+      var _simulation6 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee6(factory) {
+        return _regeneratorRuntime.wrap(function _callee6$(_context6) {
+          while (1) switch (_context6.prev = _context6.next) {
+            case 0:
+              _context6.next = 2;
+              return sleep(speed);
+            case 2:
+              factory.error(new Error('error thrown from client'));
+            case 3:
+            case "end":
+              return _context6.stop();
+          }
+        }, _callee6);
+      }));
+      function simulation(_x6) {
+        return _simulation6.apply(this, arguments);
+      }
+      return simulation;
+    }()
+  };
+};
+
+/**
+ * Rare Cases
+ */
+
+export var simulateManyProcessed = function simulateManyProcessed() {
+  var withRemotePreview = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
+  return {
+    description: '',
+    simulation: function () {
+      var _simulation7 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee7(factory) {
+        return _regeneratorRuntime.wrap(function _callee7$(_context7) {
+          while (1) switch (_context7.prev = _context7.next) {
+            case 0:
+              _context7.next = 2;
+              return sleep(speed);
+            case 2:
+              factory.next('processed', {
+                withRemotePreview: withRemotePreview
+              });
+              _context7.next = 5;
+              return sleep(speed);
+            case 5:
+              factory.next('processed', {
+                withRemotePreview: withRemotePreview
+              });
+              _context7.next = 8;
+              return sleep(speed);
+            case 8:
+              factory.next('processed', {
+                withRemotePreview: withRemotePreview
+              });
+            case 9:
+            case "end":
+              return _context7.stop();
+          }
+        }, _callee7);
+      }));
+      function simulation(_x7) {
+        return _simulation7.apply(this, arguments);
+      }
+      return simulation;
+    }()
+  };
+};
+export var simulateEmptyDetails = function simulateEmptyDetails() {
+  return {
+    description: 'Incomplete uploads return empty file details and a processing status pending',
+    simulation: function () {
+      var _simulation8 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee8(factory) {
+        var emptyDetails;
+        return _regeneratorRuntime.wrap(function _callee8$(_context8) {
+          while (1) switch (_context8.prev = _context8.next) {
+            case 0:
+              emptyDetails = {
+                createdAt: 1630986510989
+              };
+              _context8.next = 3;
+              return sleep(speed);
+            case 3:
+              factory.next('processing', {
+                fileDetails: emptyDetails
+              });
+            case 4:
+            case "end":
+              return _context8.stop();
+          }
+        }, _callee8);
+      }));
+      function simulation(_x8) {
+        return _simulation8.apply(this, arguments);
+      }
+      return simulation;
+    }()
+  };
+};
+export var simulateUpdateFileId = function simulateUpdateFileId() {
+  return {
+    description: 'First File Id: video with processing issue. Next File Id: PDF sucessfully processed',
+    simulation: function () {
+      var _simulation9 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee9(factory, _ref) {
+        var updateIdentifier;
+        return _regeneratorRuntime.wrap(function _callee9$(_context9) {
+          while (1) switch (_context9.prev = _context9.next) {
+            case 0:
+              updateIdentifier = _ref.updateIdentifier;
+              _context9.next = 3;
+              return sleep(speed);
+            case 3:
+              factory.next('failed-processing');
+              _context9.next = 6;
+              return sleep(speed);
+            case 6:
+              updateIdentifier('doc');
+              _context9.next = 9;
+              return sleep(speed);
+            case 9:
+              factory.next('processing');
+              _context9.next = 12;
+              return sleep(speed);
+            case 12:
+              factory.next('processed');
+            case 13:
+            case "end":
+              return _context9.stop();
+          }
+        }, _callee9);
+      }));
+      function simulation(_x9, _x10) {
+        return _simulation9.apply(this, arguments);
+      }
+      return simulation;
+    }()
+  };
+};
+export var simulateAlwaysLoading = function simulateAlwaysLoading() {
+  return {
+    description: 'File state never fetched',
+    simulation: function () {
+      var _simulation10 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee10() {
+        return _regeneratorRuntime.wrap(function _callee10$(_context10) {
+          while (1) switch (_context10.prev = _context10.next) {
+            case 0:
+            case "end":
+              return _context10.stop();
+          }
+        }, _callee10);
+      }));
+      function simulation() {
+        return _simulation10.apply(this, arguments);
+      }
+      return simulation;
+    }()
+  };
+};
+export var simulateAlwaysProcessing = function simulateAlwaysProcessing() {
+  return {
+    description: 'File state is permanently processing',
+    simulation: function () {
+      var _simulation11 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee11(factory) {
+        return _regeneratorRuntime.wrap(function _callee11$(_context11) {
+          while (1) switch (_context11.prev = _context11.next) {
+            case 0:
+              _context11.next = 2;
+              return sleep(speed);
+            case 2:
+              factory.next('processing');
+              _context11.next = 5;
+              return sleep(speed);
+            case 5:
+              factory.next('processing');
+              _context11.next = 8;
+              return sleep(speed * 0.5);
+            case 8:
+            case "end":
+              return _context11.stop();
+          }
+        }, _callee11);
+      }));
+      function simulation(_x11) {
+        return _simulation11.apply(this, arguments);
+      }
+      return simulation;
+    }()
+  };
+};

package/dist/esm/fileStateFactory/index.js

@@ -1,3 +1,5 @@
 export { FileStateFactory, MediaClientMock } from './factory';
-export { createIdentifier, createFileDetails } from './helpers';
-export { createFileState } from './createFileState';
+export { createIdentifier, createFileDetails } from './factory';
+export { createFileState } from './factory/createFileState';
+export { useRunSimulation } from './fileSimulation';
+export { simulateProcessed, simulateProcessing, simulateImmediateFailProcessing, simulateUpload, simulateError, simulateErrorState, simulateManyProcessed, simulateEmptyDetails, simulateUpdateFileId, simulateAlwaysLoading, simulateAlwaysProcessing } from './fileSimulation';

package/dist/esm/getAuthFromContextProvider.js

@@ -14,29 +14,27 @@ export var getAuthFromContextProvider = /*#__PURE__*/function () {
   var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
     var url, body, headers, response;
     return _regeneratorRuntime.wrap(function _callee$(_context) {
-      while (1) {
-        switch (_context.prev = _context.next) {
-          case 0:
-            url = 'https://media-playground.dev.atl-paas.net/token/tenant?environment=asap';
-            body = JSON.stringify({
-              access: access
-            });
-            headers = new Headers();
-            headers.append('Content-Type', 'application/json; charset=utf-8');
-            headers.append('Accept', 'text/plain, */*; q=0.01');
-            _context.next = 7;
-            return fetch(url, {
-              method: 'POST',
-              body: body,
-              headers: headers
-            });
-          case 7:
-            response = _context.sent;
-            return _context.abrupt("return", response.json());
-          case 9:
-          case "end":
-            return _context.stop();
-        }
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          url = 'https://media-playground.dev.atl-paas.net/token/tenant?environment=asap';
+          body = JSON.stringify({
+            access: access
+          });
+          headers = new Headers();
+          headers.append('Content-Type', 'application/json; charset=utf-8');
+          headers.append('Accept', 'text/plain, */*; q=0.01');
+          _context.next = 7;
+          return fetch(url, {
+            method: 'POST',
+            body: body,
+            headers: headers
+          });
+        case 7:
+          response = _context.sent;
+          return _context.abrupt("return", response.json());
+        case 9:
+        case "end":
+          return _context.stop();
       }
     }, _callee);
   }));

package/dist/esm/index.js

@@ -37,5 +37,9 @@ export { dataURItoBlob } from './mockData/utils';
 export { mapDataUriToBlob } from './utils/index';
 export { createPollingMaxAttemptsError, createRateLimitedError, createMediaStoreError } from './mediaClientErrors';
 export { default as FeatureFlagsWrapper } from './featureFlagsWrapper';
-export { FileStateFactory, MediaClientMock, createIdentifier, createFileDetails, createFileState } from './fileStateFactory';
+export {
+// Simulation tools
+FileStateFactory, MediaClientMock, createIdentifier, createFileDetails, createFileState, useRunSimulation,
+// Predefined simulations
+simulateProcessed, simulateProcessing, simulateImmediateFailProcessing, simulateUpload, simulateError, simulateErrorState, simulateManyProcessed, simulateEmptyDetails, simulateUpdateFileId, simulateAlwaysLoading, simulateAlwaysProcessing } from './fileStateFactory';
 export { DocsContentTabs } from './docs-content-tabs';

package/dist/esm/mediaPickerAuthProvider.js

@@ -31,30 +31,28 @@ var requestAuthProvider = /*#__PURE__*/function () {
       response,
       _args = arguments;
     return _regeneratorRuntime.wrap(function _callee$(_context) {
-      while (1) {
-        switch (_context.prev = _context.next) {
-          case 0:
-            env = _args.length > 2 && _args[2] !== undefined ? _args[2] : 'dev';
-            url = "https://media-playground.".concat(env, ".atl-paas.net/token/tenant?environment=").concat(authEnvironment);
-            body = JSON.stringify({
-              access: accessUrns[collectionName] || {}
-            });
-            headers = new Headers();
-            headers.append('Content-Type', 'application/json; charset=utf-8');
-            headers.append('Accept', 'text/plain, */*; q=0.01');
-            _context.next = 8;
-            return fetch(url, {
-              method: 'POST',
-              body: body,
-              headers: headers
-            });
-          case 8:
-            response = _context.sent;
-            return _context.abrupt("return", response.json());
-          case 10:
-          case "end":
-            return _context.stop();
-        }
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          env = _args.length > 2 && _args[2] !== undefined ? _args[2] : 'dev';
+          url = "https://media-playground.".concat(env, ".atl-paas.net/token/tenant?environment=").concat(authEnvironment);
+          body = JSON.stringify({
+            access: accessUrns[collectionName] || {}
+          });
+          headers = new Headers();
+          headers.append('Content-Type', 'application/json; charset=utf-8');
+          headers.append('Accept', 'text/plain, */*; q=0.01');
+          _context.next = 8;
+          return fetch(url, {
+            method: 'POST',
+            body: body,
+            headers: headers
+          });
+        case 8:
+          response = _context.sent;
+          return _context.abrupt("return", response.json());
+        case 10:
+        case "end":
+          return _context.stop();
       }
     }, _callee);
   }));

package/dist/esm/mocks/database/collection-item.js

@@ -1,6 +1,9 @@
 import * as uuid from 'uuid';
 import { getHackerNoun, getPastDate, fakeImage, getFakeFileName, getTextFileType } from '../../utils/mockData';
 import { mapDataUriToBlob } from '../../utils';
+export var isMediaItemDetails = function isMediaItemDetails(mediaCollectionItem) {
+  return !!mediaCollectionItem['mediaType'] && !!mediaCollectionItem['mimeType'] && !!mediaCollectionItem['processingStatus'];
+};
 export function createEmptyCollectionItem(_ref) {
   var id = _ref.id,
     collectionName = _ref.collectionName,

package/dist/esm/mocks/database/index.js

@@ -8,7 +8,7 @@ import { defaultBaseUrl } from '../../mediaClientProvider';
 import { defaultCollectionName } from '../../collectionNames';
 import { RECENTS_COLLECTION } from '@atlaskit/media-client/constants';
 export { createCollection } from './collection';
-export { createCollectionItem, createEmptyCollectionItem } from './collection-item';
+export { createCollectionItem, createEmptyCollectionItem, isMediaItemDetails } from './collection-item';
 export var tenantAuth = {
   clientId: uuidV4(),
   token: 'some-tenant-token',