@atlaskit/media-test-helpers 41.2.0 → 42.0.0

package/AGENTS.md

@@ -0,0 +1,58 @@
+# media-test-helpers — Agent Guide
+
+> **Parent guide:** Always read [`../AGENTS.md`](../AGENTS.md) before working in this package — it
+> contains workspace-wide rules covering platform guidelines, changeset workflow, accessibility
+> standards, and the knowledge index protocol that applies to every Media package.
+
+## Package identity
+
+| Field    | Value                                                                                             |
+| -------- | ------------------------------------------------------------------------------------------------- |
+| NPM name | `@atlaskit/media-test-helpers`                                                                    |
+| Path     | `media-test-helpers/`                                                                             |
+| Owner    | Media Exif                                                                                        |
+| Purpose  | Collection of test helpers, mocks, fakes, and utilities used in Media component stories and specs |
+
+## Knowledge index
+
+> Read, search, edit, investigate, and validate the repository knowledge index at
+> `.agents/knowledge-index/`. ALWAYS use this skill before making ANY repo change, or when exploring
+> the codebase. The knowledge index is the canonical starting point for every coding task in this
+> repo, trigger this skill aggressively whenever the user mentions architecture, conventions,
+> packages, modules, services, build, coding, writing code, APIs, feature flags, testing, or
+> anything similar. Also trigger when "is the knowledge index up to date?" / "update the knowledge
+> index" / "what does the knowledge index say about Y?" — even if they don't say the words
+> "knowledge index". Also use it (via the `validate` subcommand) to detect drift between the
+> codebase and the docs after any code change. Use the `generate` subcommand to bootstrap the index
+> in a new repository.
+
+**Entry point:** `.agents/knowledge-index/INDEX.md` **Unit doc:**
+`.agents/knowledge-index/domains/media/units/atlaskit-media-test-helpers.md` **CLI:**
+`python3 .agents/skills/knowledge-index/scripts/kg.py {find,read,edit,investigate,validate,init,explore,generate} …`
+**Refresh protocol:** never silently bump `Last verified` — always re-read the listed `Sources`
+first, edit, then `kg.py edit <path> --message "<reason>"`.
+
+## Key source files
+
+- `src/index.tsx` — public API entry point
+- `src/fakeMediaClient.ts` — `fakeMediaClient()` factory for tests
+- `src/mockData/` — MSW mock handlers and routers
+- `src/mocks/` — mock database, routers, and WebSocket mocks
+- `src/fileStateFactory/` — `FileState` factories and file simulation
+- `src/dataURIs/` — sample data URIs for image testing
+- `src/featureFlagsWrapper/` — feature flag test wrapper
+- `src/utils/` — shared test utilities
+
+## Public API (key exports)
+
+`fakeMediaClient`, `StoryBookAuthProvider`, `generateFilesFromTestData`, and 48 total export
+subpaths covering mocks, helpers, factories, and data URIs.
+
+## Development notes
+
+- Internal dependencies: `@atlaskit/media-client`, `@atlaskit/media-common`,
+  `@atlaskit/media-state`, `@atlaskit/media-ui`
+- Peer dependencies: `@atlaskit/media-core`, `react`, `react-intl`
+- 1 feature flag: `should-render-to-parent-should-be-true-media-exif`
+- 48 export subpaths — always use subpath imports rather than the root barrel
+- Uses MSW (Mock Service Worker) for network-level mocking

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @atlaskit/media-test-helpers
 
+## 42.0.0
+
+### Major Changes
+
+- [`f2dc9097319f0`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/f2dc9097319f0) - ###
+  Dropped support for _legacy_ Typescript 4 types. **Typescript 5 is now the new minimum**.
+
+  Removes the `typesVersions` property and `dist/types-ts4.5` directory from the dist.
+
+  Types are now exclusively via the `"types": "dist/types/index.d.ts"` property.
+
+  ```diff
+  - "typesVersions": {
+  -    ">=4.5 <4.9": {
+  -        "*": [
+  -            "dist/types-ts4.5/*",
+  -            "dist/types-ts4.5/index.d.ts"
+  -        ]
+  -    }
+  - },
+  ```
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 41.2.0
 
 ### Minor Changes

package/I18nWrapper/package.json

@@ -6,12 +6,5 @@
   "sideEffects": [
     "*.compiled.css"
   ],
-  "types": "../dist/types/I18nWrapper.d.ts",
-  "typesVersions": {
-    ">=4.5 <5.9": {
-      "*": [
-        "../dist/types-ts4.5/I18nWrapper.d.ts"
-      ]
-    }
-  }
+  "types": "../dist/types/I18nWrapper.d.ts"
 }

package/MockGlobalImage/package.json

@@ -6,12 +6,5 @@
   "sideEffects": [
     "*.compiled.css"
   ],
-  "types": "../dist/types/MockGlobalImage.d.ts",
-  "typesVersions": {
-    ">=4.5 <5.9": {
-      "*": [
-        "../dist/types-ts4.5/MockGlobalImage.d.ts"
-      ]
-    }
-  }
+  "types": "../dist/types/MockGlobalImage.d.ts"
 }

package/authProvider/package.json

@@ -6,12 +6,5 @@
   "sideEffects": [
     "*.compiled.css"
   ],
-  "types": "../dist/types/authProvider.d.ts",
-  "typesVersions": {
-    ">=4.5 <5.9": {
-      "*": [
-        "../dist/types-ts4.5/authProvider.d.ts"
-      ]
-    }
-  }
+  "types": "../dist/types/authProvider.d.ts"
 }

package/await-error/package.json

@@ -6,12 +6,5 @@
   "sideEffects": [
     "*.compiled.css"
   ],
-  "types": "../dist/types/await-error.d.ts",
-  "typesVersions": {
-    ">=4.5 <5.9": {
-      "*": [
-        "../dist/types-ts4.5/await-error.d.ts"
-      ]
-    }
-  }
+  "types": "../dist/types/await-error.d.ts"
 }

package/clipboardEventMocks/package.json

@@ -6,12 +6,5 @@
   "sideEffects": [
     "*.compiled.css"
   ],
-  "types": "../dist/types/clipboardEventMocks.d.ts",
-  "typesVersions": {
-    ">=4.5 <5.9": {
-      "*": [
-        "../dist/types-ts4.5/clipboardEventMocks.d.ts"
-      ]
-    }
-  }
+  "types": "../dist/types/clipboardEventMocks.d.ts"
 }

package/collectionNames/package.json

@@ -6,12 +6,5 @@
   "sideEffects": [
     "*.compiled.css"
   ],
-  "types": "../dist/types/collectionNames.d.ts",
-  "typesVersions": {
-    ">=4.5 <5.9": {
-      "*": [
-        "../dist/types-ts4.5/collectionNames.d.ts"
-      ]
-    }
-  }
+  "types": "../dist/types/collectionNames.d.ts"
 }

package/createFileState/package.json

@@ -6,12 +6,5 @@
   "sideEffects": [
     "*.compiled.css"
   ],
-  "types": "../dist/types/fileStateFactory/factory/createFileState.d.ts",
-  "typesVersions": {
-    ">=4.5 <5.9": {
-      "*": [
-        "../dist/types-ts4.5/fileStateFactory/factory/createFileState.d.ts"
-      ]
-    }
-  }
+  "types": "../dist/types/fileStateFactory/factory/createFileState.d.ts"
 }

package/createMouseEvent/package.json

@@ -6,12 +6,5 @@
   "sideEffects": [
     "*.compiled.css"
   ],
-  "types": "../dist/types/createMouseEvent.d.ts",
-  "typesVersions": {
-    ">=4.5 <5.9": {
-      "*": [
-        "../dist/types-ts4.5/createMouseEvent.d.ts"
-      ]
-    }
-  }
+  "types": "../dist/types/createMouseEvent.d.ts"
 }

package/createTouchEvent/package.json

@@ -6,12 +6,5 @@
   "sideEffects": [
     "*.compiled.css"
   ],
-  "types": "../dist/types/createTouchEvent.d.ts",
-  "typesVersions": {
-    ">=4.5 <5.9": {
-      "*": [
-        "../dist/types-ts4.5/createTouchEvent.d.ts"
-      ]
-    }
-  }
+  "types": "../dist/types/createTouchEvent.d.ts"
 }

package/dist/cjs/authProvider.js

@@ -23,7 +23,7 @@ var StoryBookAuthProvider = exports.StoryBookAuthProvider = /*#__PURE__*/functio
       var loadTenatAuth = /*#__PURE__*/function () {
         var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(collectionName) {
           var environment, headers, config, url, response;
-          return _regenerator.default.wrap(function _callee$(_context) {
+          return _regenerator.default.wrap(function (_context) {
             while (1) switch (_context.prev = _context.next) {
               case 0:
                 environment = isAsapEnvironment ? 'asap' : '';
@@ -40,14 +40,14 @@ var StoryBookAuthProvider = exports.StoryBookAuthProvider = /*#__PURE__*/functio
                 };
                 url = "".concat(_mediaBaseURLS.MEDIA_PLAYGROUND_BASE_URL, "/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 = 9;
+                _context.next = 1;
                 return response;
-              case 9:
-                _context.next = 11;
+              case 1:
+                _context.next = 2;
                 return _context.sent.json();
-              case 11:
+              case 2:
                 return _context.abrupt("return", _context.sent);
-              case 12:
+              case 3:
               case "end":
                 return _context.stop();
             }

package/dist/cjs/await-error.js

@@ -12,28 +12,29 @@ function awaitError(_x, _x2) {
 }
 function _awaitError() {
   _awaitError = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(response, expectedMessage) {
-    return _regenerator.default.wrap(function _callee$(_context) {
+    var _t;
+    return _regenerator.default.wrap(function (_context) {
       while (1) switch (_context.prev = _context.next) {
         case 0:
           _context.prev = 0;
-          _context.next = 3;
+          _context.next = 1;
           return response;
-        case 3:
-          _context.next = 9;
+        case 1:
+          _context.next = 3;
           break;
-        case 5:
-          _context.prev = 5;
-          _context.t0 = _context["catch"](0);
-          if (!(_context.t0 instanceof Error && _context.t0.message !== expectedMessage)) {
-            _context.next = 9;
+        case 2:
+          _context.prev = 2;
+          _t = _context["catch"](0);
+          if (!(_t instanceof Error && _t.message !== expectedMessage)) {
+            _context.next = 3;
             break;
           }
-          throw _context.t0;
-        case 9:
+          throw _t;
+        case 3:
         case "end":
           return _context.stop();
       }
-    }, _callee, null, [[0, 5]]);
+    }, _callee, null, [[0, 2]]);
   }));
   return _awaitError.apply(this, arguments);
 }

package/dist/cjs/fileStateFactory/factory/factory.js

@@ -39,21 +39,21 @@ var MediaClientMock = exports.MediaClientMock = /*#__PURE__*/function (_MediaCli
     });
     (0, _defineProperty2.default)(_this, "getImage", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
       var _this$options$getImag, getImageDelay;
-      return _regenerator.default.wrap(function _callee$(_context) {
+      return _regenerator.default.wrap(function (_context) {
         while (1) switch (_context.prev = _context.next) {
           case 0:
             _this$options$getImag = _this.options.getImageDelay, getImageDelay = _this$options$getImag === void 0 ? 0 : _this$options$getImag;
             if (_this.hasPreview) {
-              _context.next = 3;
+              _context.next = 1;
               break;
             }
             throw new Error('some error');
-          case 3:
-            _context.next = 5;
+          case 1:
+            _context.next = 2;
             return (0, _nextTick.sleep)(getImageDelay);
-          case 5:
+          case 2:
             return _context.abrupt("return", (0, _mockData.dataURItoBlob)(_images.tallImage));
-          case 6:
+          case 3:
           case "end":
             return _context.stop();
         }
@@ -76,7 +76,7 @@ var MediaClientMock = exports.MediaClientMock = /*#__PURE__*/function (_MediaCli
 var mockConfig = {
   authProvider: function () {
     var _authProvider = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
-      return _regenerator.default.wrap(function _callee2$(_context2) {
+      return _regenerator.default.wrap(function (_context2) {
         while (1) switch (_context2.prev = _context2.next) {
           case 0:
             return _context2.abrupt("return", {

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

@@ -18,16 +18,16 @@ var simulateProcessed = exports.simulateProcessed = function simulateProcessed()
   return {
     simulation: function () {
       var _simulation = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(factory) {
-        return _regenerator.default.wrap(function _callee$(_context) {
+        return _regenerator.default.wrap(function (_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
-              _context.next = 2;
+              _context.next = 1;
               return (0, _nextTick.sleep)(speed);
-            case 2:
+            case 1:
               factory.next('processed', {
                 withRemotePreview: withRemotePreview
               });
-            case 3:
+            case 2:
             case "end":
               return _context.stop();
           }
@@ -48,20 +48,20 @@ var simulateProcessing = exports.simulateProcessing = function simulateProcessin
     description: "File is processing, then ".concat(suceeded ? 'succeeds' : 'fails', " ").concat(withRemotePreview ? 'with' : 'without', " remote preview"),
     simulation: function () {
       var _simulation2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(factory) {
-        return _regenerator.default.wrap(function _callee2$(_context2) {
+        return _regenerator.default.wrap(function (_context2) {
           while (1) switch (_context2.prev = _context2.next) {
             case 0:
-              _context2.next = 2;
+              _context2.next = 1;
               return (0, _nextTick.sleep)(speed);
-            case 2:
+            case 1:
               factory.next('processing');
-              _context2.next = 5;
+              _context2.next = 2;
               return (0, _nextTick.sleep)(speed);
-            case 5:
+            case 2:
               factory.next('processing');
-              _context2.next = 8;
+              _context2.next = 3;
               return (0, _nextTick.sleep)(speed * 0.5);
-            case 8:
+            case 3:
               if (!suceeded) {
                 factory.next('failed-processing', {
                   withRemotePreview: withRemotePreview
@@ -71,7 +71,7 @@ var simulateProcessing = exports.simulateProcessing = function simulateProcessin
                   withRemotePreview: withRemotePreview
                 });
               }
-            case 9:
+            case 4:
             case "end":
               return _context2.stop();
           }
@@ -89,14 +89,14 @@ var simulateImmediateFailProcessing = exports.simulateImmediateFailProcessing =
     description: 'The first sate is failed-processing with no preview',
     simulation: function () {
       var _simulation3 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(factory) {
-        return _regenerator.default.wrap(function _callee3$(_context3) {
+        return _regenerator.default.wrap(function (_context3) {
           while (1) switch (_context3.prev = _context3.next) {
             case 0:
-              _context3.next = 2;
+              _context3.next = 1;
               return (0, _nextTick.sleep)(speed);
-            case 2:
+            case 1:
               factory.next('failed-processing');
-            case 3:
+            case 2:
             case "end":
               return _context3.stop();
           }
@@ -116,49 +116,49 @@ var simulateUpload = exports.simulateUpload = function simulateUpload(withLocalP
     simulation: function () {
       var _simulation4 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(factory) {
         var chunks, chunkUploadDelay, processingTime, uploadUpTo, index;
-        return _regenerator.default.wrap(function _callee4$(_context4) {
+        return _regenerator.default.wrap(function (_context4) {
           while (1) switch (_context4.prev = _context4.next) {
             case 0:
               chunks = 3;
               chunkUploadDelay = 500;
               processingTime = speed;
-              _context4.next = 5;
+              _context4.next = 1;
               return (0, _nextTick.sleep)(speed);
-            case 5:
+            case 1:
               factory.next('uploading', {
                 withLocalPreview: withLocalPreview
               });
               uploadUpTo = !suceeded ? chunks / 2 : chunks;
               index = 0;
-            case 8:
+            case 2:
               if (!(index <= uploadUpTo)) {
-                _context4.next = 15;
+                _context4.next = 4;
                 break;
               }
               factory.next('uploading', {
                 uploadProgress: index / chunks,
                 withLocalPreview: withLocalPreview
               });
-              _context4.next = 12;
+              _context4.next = 3;
               return (0, _nextTick.sleep)(chunkUploadDelay);
-            case 12:
+            case 3:
               index++;
-              _context4.next = 8;
+              _context4.next = 2;
               break;
-            case 15:
+            case 4:
               if (!suceeded) {
                 factory.error(new Error('some-error'));
               }
               factory.next('processing', {
                 withLocalPreview: withLocalPreview
               });
-              _context4.next = 19;
+              _context4.next = 5;
               return (0, _nextTick.sleep)(processingTime);
-            case 19:
+            case 5:
               factory.next('processed', {
                 withLocalPreview: withLocalPreview
               });
-            case 20:
+            case 6:
             case "end":
               return _context4.stop();
           }
@@ -176,14 +176,14 @@ var simulateErrorState = exports.simulateErrorState = function simulateErrorStat
     description: 'File state is error',
     simulation: function () {
       var _simulation5 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5(factory) {
-        return _regenerator.default.wrap(function _callee5$(_context5) {
+        return _regenerator.default.wrap(function (_context5) {
           while (1) switch (_context5.prev = _context5.next) {
             case 0:
-              _context5.next = 2;
+              _context5.next = 1;
               return (0, _nextTick.sleep)(speed);
-            case 2:
+            case 1:
               factory.next('error');
-            case 3:
+            case 2:
             case "end":
               return _context5.stop();
           }
@@ -201,14 +201,14 @@ var simulateError = exports.simulateError = function simulateError() {
     description: 'Subscription throws an error through the observer',
     simulation: function () {
       var _simulation6 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee6(factory) {
-        return _regenerator.default.wrap(function _callee6$(_context6) {
+        return _regenerator.default.wrap(function (_context6) {
           while (1) switch (_context6.prev = _context6.next) {
             case 0:
-              _context6.next = 2;
+              _context6.next = 1;
               return (0, _nextTick.sleep)(speed);
-            case 2:
+            case 1:
               factory.error(new Error('error thrown from client'));
-            case 3:
+            case 2:
             case "end":
               return _context6.stop();
           }
@@ -232,28 +232,28 @@ var simulateManyProcessed = exports.simulateManyProcessed = function simulateMan
     description: '',
     simulation: function () {
       var _simulation7 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee7(factory) {
-        return _regenerator.default.wrap(function _callee7$(_context7) {
+        return _regenerator.default.wrap(function (_context7) {
           while (1) switch (_context7.prev = _context7.next) {
             case 0:
-              _context7.next = 2;
+              _context7.next = 1;
               return (0, _nextTick.sleep)(speed);
-            case 2:
+            case 1:
               factory.next('processed', {
                 withRemotePreview: withRemotePreview
               });
-              _context7.next = 5;
+              _context7.next = 2;
               return (0, _nextTick.sleep)(speed);
-            case 5:
+            case 2:
               factory.next('processed', {
                 withRemotePreview: withRemotePreview
               });
-              _context7.next = 8;
+              _context7.next = 3;
               return (0, _nextTick.sleep)(speed);
-            case 8:
+            case 3:
               factory.next('processed', {
                 withRemotePreview: withRemotePreview
               });
-            case 9:
+            case 4:
             case "end":
               return _context7.stop();
           }
@@ -272,19 +272,19 @@ var simulateEmptyDetails = exports.simulateEmptyDetails = function simulateEmpty
     simulation: function () {
       var _simulation8 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee8(factory) {
         var emptyDetails;
-        return _regenerator.default.wrap(function _callee8$(_context8) {
+        return _regenerator.default.wrap(function (_context8) {
           while (1) switch (_context8.prev = _context8.next) {
             case 0:
               emptyDetails = {
                 createdAt: 1630986510989
               };
-              _context8.next = 3;
+              _context8.next = 1;
               return (0, _nextTick.sleep)(speed);
-            case 3:
+            case 1:
               factory.next('processing', {
                 fileDetails: emptyDetails
               });
-            case 4:
+            case 2:
             case "end":
               return _context8.stop();
           }
@@ -303,27 +303,27 @@ var simulateUpdateFileId = exports.simulateUpdateFileId = function simulateUpdat
     simulation: function () {
       var _simulation9 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee9(factory, _ref) {
         var updateIdentifier;
-        return _regenerator.default.wrap(function _callee9$(_context9) {
+        return _regenerator.default.wrap(function (_context9) {
           while (1) switch (_context9.prev = _context9.next) {
             case 0:
               updateIdentifier = _ref.updateIdentifier;
-              _context9.next = 3;
+              _context9.next = 1;
               return (0, _nextTick.sleep)(speed);
-            case 3:
+            case 1:
               factory.next('failed-processing');
-              _context9.next = 6;
+              _context9.next = 2;
               return (0, _nextTick.sleep)(speed);
-            case 6:
+            case 2:
               updateIdentifier('doc');
-              _context9.next = 9;
+              _context9.next = 3;
               return (0, _nextTick.sleep)(speed);
-            case 9:
+            case 3:
               factory.next('processing');
-              _context9.next = 12;
+              _context9.next = 4;
               return (0, _nextTick.sleep)(speed);
-            case 12:
+            case 4:
               factory.next('processed');
-            case 13:
+            case 5:
             case "end":
               return _context9.stop();
           }
@@ -341,7 +341,7 @@ var simulateAlwaysLoading = exports.simulateAlwaysLoading = function simulateAlw
     description: 'File state never fetched',
     simulation: function () {
       var _simulation0 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee0() {
-        return _regenerator.default.wrap(function _callee0$(_context0) {
+        return _regenerator.default.wrap(function (_context0) {
           while (1) switch (_context0.prev = _context0.next) {
             case 0:
             case "end":
@@ -361,20 +361,20 @@ var simulateAlwaysProcessing = exports.simulateAlwaysProcessing = function simul
     description: 'File state is permanently processing',
     simulation: function () {
       var _simulation1 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee1(factory) {
-        return _regenerator.default.wrap(function _callee1$(_context1) {
+        return _regenerator.default.wrap(function (_context1) {
           while (1) switch (_context1.prev = _context1.next) {
             case 0:
-              _context1.next = 2;
+              _context1.next = 1;
               return (0, _nextTick.sleep)(speed);
-            case 2:
+            case 1:
               factory.next('processing');
-              _context1.next = 5;
+              _context1.next = 2;
               return (0, _nextTick.sleep)(speed);
-            case 5:
+            case 2:
               factory.next('processing');
-              _context1.next = 8;
+              _context1.next = 3;
               return (0, _nextTick.sleep)(speed * 0.5);
-            case 8:
+            case 3:
             case "end":
               return _context1.stop();
           }