@atlaskit/media-client 36.4.0 → 37.1.0

package/CHANGELOG.md

@@ -1,5 +1,45 @@
 # @atlaskit/media-client
 
+## 37.1.0
+
+### Minor Changes
+
+- [`0a00d74d3fe12`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/0a00d74d3fe12) -
+  Surface the underlying `DOMException` (e.g. `NotReadableError`, `NotFoundError`, `SecurityError`)
+  when a `FileReader` fails while hashing an upload, instead of leaking the browser `ProgressEvent`
+  which analytics serialised to the opaque `{"isTrusted":true}` error detail. Gated behind
+  `platform_media_filereader_error_surfacing`.
+
+  `@atlaskit/media-client` also exposes the `toFileReaderError` helper via a new
+  `@atlaskit/media-client/hashing/file-reader-error` entry point so consumers can normalise
+  `FileReader`/`DOMException` failures consistently without duplicating the logic.
+
+## 37.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
+
 ## 36.4.0
 
 ### Minor Changes

package/dist/cjs/constants.js

@@ -3,11 +3,23 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.RECENTS_COLLECTION = exports.PROCESSING_BATCH_SIZE = exports.MAX_UPLOAD_FILE_SIZE = exports.MAX_RESOLUTION = exports.FILE_CACHE_MAX_AGE = exports.CHUNK_SIZE = void 0;
+exports.RECENTS_COLLECTION = exports.PROCESSING_BATCH_SIZE = exports.MAX_UPLOAD_FILE_SIZE = exports.MAX_RESOLUTION = exports.FILE_READER_FALLBACK_ERROR_NAME = exports.FILE_CACHE_MAX_AGE = exports.CHUNK_SIZE = void 0;
 var _media = require("./models/media");
 var RECENTS_COLLECTION = exports.RECENTS_COLLECTION = 'recents';
 var FILE_CACHE_MAX_AGE = exports.FILE_CACHE_MAX_AGE = 60 * 60 * 24 * 30; // Retain for 30 days
 var MAX_RESOLUTION = exports.MAX_RESOLUTION = 4096;
 var CHUNK_SIZE = exports.CHUNK_SIZE = 5 * _media.DATA_UNIT.MB;
 var PROCESSING_BATCH_SIZE = exports.PROCESSING_BATCH_SIZE = 1000;
-var MAX_UPLOAD_FILE_SIZE = exports.MAX_UPLOAD_FILE_SIZE = 2 * _media.DATA_UNIT.TB;
+var MAX_UPLOAD_FILE_SIZE = exports.MAX_UPLOAD_FILE_SIZE = 2 * _media.DATA_UNIT.TB;
+
+/**
+ * Sentinel error name used when a `FileReader`/upload failure cannot be attributed
+ * to a concrete `DOMException` (e.g. `reader.error` is `null` or has an empty name).
+ *
+ * This value ends up as the analytics `errorDetail`/`failReason`, so it is an
+ * implicit contract that dashboards/SLO filters key off. It lives here (a public
+ * `@atlaskit/media-client/constants` entry point) so both media-client and
+ * downstream packages (e.g. media-picker) import a single source of truth rather
+ * than re-typing the literal and risking analytics bucket drift.
+ */
+var FILE_READER_FALLBACK_ERROR_NAME = exports.FILE_READER_FALLBACK_ERROR_NAME = 'FileReaderError';

package/dist/cjs/utils/hashing/fileReaderError.js

@@ -0,0 +1,36 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.toFileReaderError = void 0;
+var _constants = require("../../constants");
+/**
+ * `FileReader.onerror` hands back a `ProgressEvent`, not an `Error`. Rejecting a
+ * promise with that event causes downstream analytics (`JSON.stringify`) to
+ * collapse it to `{"isTrusted":true}`, hiding the real cause. The actual failure
+ * is on `reader.error` as a `DOMException` whose `name` identifies the problem
+ * (e.g. `NotReadableError`, `NotFoundError`, `SecurityError`).
+ *
+ * This converts that `DOMException` into a real `Error` that preserves the name,
+ * so the failure stays legible as it travels through the upload pipeline. The
+ * original `DOMException` (including its descriptive message) is retained on the
+ * `cause` property for debugging — defined non-enumerable, mirroring the native
+ * `new Error(message, { cause })` form, so it never leaks into analytics that
+ * read `name`/`message` or serialise the error via `JSON.stringify`.
+ */
+var toFileReaderError = exports.toFileReaderError = function toFileReaderError(error) {
+  var _error$name;
+  var name = error !== null && error !== void 0 && (_error$name = error.name) !== null && _error$name !== void 0 && _error$name.trim() ? error.name : _constants.FILE_READER_FALLBACK_ERROR_NAME;
+  var normalized = new Error(name);
+  normalized.name = name;
+  if (error) {
+    Object.defineProperty(normalized, 'cause', {
+      value: error,
+      enumerable: false,
+      configurable: true,
+      writable: true
+    });
+  }
+  return normalized;
+};

package/dist/cjs/utils/hashing/sha256SimpleHasher.js

@@ -8,6 +8,8 @@ exports.SimpleHasher = void 0;
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _jsSha = require("js-sha256");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+var _fileReaderError = require("./fileReaderError");
 var SimpleHasher = exports.SimpleHasher = /*#__PURE__*/function () {
   function SimpleHasher() {
     (0, _classCallCheck2.default)(this, SimpleHasher);
@@ -22,7 +24,13 @@ var SimpleHasher = exports.SimpleHasher = /*#__PURE__*/function () {
           var _reader$result;
           resolve("sha256-".concat(_jsSha.sha256.create().update((_reader$result = reader.result) !== null && _reader$result !== void 0 ? _reader$result : '').hex()));
         };
-        reader.onerror = reject;
+        reader.onerror = function (event) {
+          if ((0, _platformFeatureFlags.fg)('platform_media_filereader_error_surfacing')) {
+            reject((0, _fileReaderError.toFileReaderError)(reader.error));
+          } else {
+            reject(event);
+          }
+        };
       });
     }
   }]);

package/dist/cjs/utils/hashing/simpleHasher.js

@@ -9,6 +9,8 @@ exports.SimpleHasher = void 0;
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var Rusha = _interopRequireWildcard(require("rusha"));
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+var _fileReaderError = require("./fileReaderError");
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
 var SimpleHasher = exports.SimpleHasher = /*#__PURE__*/function () {
   function SimpleHasher() {
@@ -24,7 +26,13 @@ var SimpleHasher = exports.SimpleHasher = /*#__PURE__*/function () {
           var _reader$result;
           resolve(Rusha.createHash().update((_reader$result = reader.result) !== null && _reader$result !== void 0 ? _reader$result : '').digest('hex'));
         };
-        reader.onerror = reject;
+        reader.onerror = function (event) {
+          if ((0, _platformFeatureFlags.fg)('platform_media_filereader_error_surfacing')) {
+            reject((0, _fileReaderError.toFileReaderError)(reader.error));
+          } else {
+            reject(event);
+          }
+        };
       });
     }
   }]);

package/dist/es2019/constants.js

@@ -4,4 +4,16 @@ export const FILE_CACHE_MAX_AGE = 60 * 60 * 24 * 30; // Retain for 30 days
 export const MAX_RESOLUTION = 4096;
 export const CHUNK_SIZE = 5 * DATA_UNIT.MB;
 export const PROCESSING_BATCH_SIZE = 1000;
-export const MAX_UPLOAD_FILE_SIZE = 2 * DATA_UNIT.TB;
+export const MAX_UPLOAD_FILE_SIZE = 2 * DATA_UNIT.TB;
+
+/**
+ * Sentinel error name used when a `FileReader`/upload failure cannot be attributed
+ * to a concrete `DOMException` (e.g. `reader.error` is `null` or has an empty name).
+ *
+ * This value ends up as the analytics `errorDetail`/`failReason`, so it is an
+ * implicit contract that dashboards/SLO filters key off. It lives here (a public
+ * `@atlaskit/media-client/constants` entry point) so both media-client and
+ * downstream packages (e.g. media-picker) import a single source of truth rather
+ * than re-typing the literal and risking analytics bucket drift.
+ */
+export const FILE_READER_FALLBACK_ERROR_NAME = 'FileReaderError';

package/dist/es2019/utils/hashing/fileReaderError.js

@@ -0,0 +1,31 @@
+import { FILE_READER_FALLBACK_ERROR_NAME } from '../../constants';
+
+/**
+ * `FileReader.onerror` hands back a `ProgressEvent`, not an `Error`. Rejecting a
+ * promise with that event causes downstream analytics (`JSON.stringify`) to
+ * collapse it to `{"isTrusted":true}`, hiding the real cause. The actual failure
+ * is on `reader.error` as a `DOMException` whose `name` identifies the problem
+ * (e.g. `NotReadableError`, `NotFoundError`, `SecurityError`).
+ *
+ * This converts that `DOMException` into a real `Error` that preserves the name,
+ * so the failure stays legible as it travels through the upload pipeline. The
+ * original `DOMException` (including its descriptive message) is retained on the
+ * `cause` property for debugging — defined non-enumerable, mirroring the native
+ * `new Error(message, { cause })` form, so it never leaks into analytics that
+ * read `name`/`message` or serialise the error via `JSON.stringify`.
+ */
+export const toFileReaderError = error => {
+  var _error$name;
+  const name = error !== null && error !== void 0 && (_error$name = error.name) !== null && _error$name !== void 0 && _error$name.trim() ? error.name : FILE_READER_FALLBACK_ERROR_NAME;
+  const normalized = new Error(name);
+  normalized.name = name;
+  if (error) {
+    Object.defineProperty(normalized, 'cause', {
+      value: error,
+      enumerable: false,
+      configurable: true,
+      writable: true
+    });
+  }
+  return normalized;
+};

package/dist/es2019/utils/hashing/sha256SimpleHasher.js

@@ -1,4 +1,6 @@
 import { sha256 } from 'js-sha256';
+import { fg } from '@atlaskit/platform-feature-flags';
+import { toFileReaderError } from './fileReaderError';
 export class SimpleHasher {
   hash(blob) {
     return new Promise((resolve, reject) => {
@@ -8,7 +10,13 @@ export class SimpleHasher {
         var _reader$result;
         resolve(`sha256-${sha256.create().update((_reader$result = reader.result) !== null && _reader$result !== void 0 ? _reader$result : '').hex()}`);
       };
-      reader.onerror = reject;
+      reader.onerror = event => {
+        if (fg('platform_media_filereader_error_surfacing')) {
+          reject(toFileReaderError(reader.error));
+        } else {
+          reject(event);
+        }
+      };
     });
   }
 }

package/dist/es2019/utils/hashing/simpleHasher.js

@@ -1,4 +1,6 @@
 import * as Rusha from 'rusha';
+import { fg } from '@atlaskit/platform-feature-flags';
+import { toFileReaderError } from './fileReaderError';
 export class SimpleHasher {
   hash(blob) {
     return new Promise((resolve, reject) => {
@@ -8,7 +10,13 @@ export class SimpleHasher {
         var _reader$result;
         resolve(Rusha.createHash().update((_reader$result = reader.result) !== null && _reader$result !== void 0 ? _reader$result : '').digest('hex'));
       };
-      reader.onerror = reject;
+      reader.onerror = event => {
+        if (fg('platform_media_filereader_error_surfacing')) {
+          reject(toFileReaderError(reader.error));
+        } else {
+          reject(event);
+        }
+      };
     });
   }
 }

package/dist/esm/constants.js

@@ -4,4 +4,16 @@ export var FILE_CACHE_MAX_AGE = 60 * 60 * 24 * 30; // Retain for 30 days
 export var MAX_RESOLUTION = 4096;
 export var CHUNK_SIZE = 5 * DATA_UNIT.MB;
 export var PROCESSING_BATCH_SIZE = 1000;
-export var MAX_UPLOAD_FILE_SIZE = 2 * DATA_UNIT.TB;
+export var MAX_UPLOAD_FILE_SIZE = 2 * DATA_UNIT.TB;
+
+/**
+ * Sentinel error name used when a `FileReader`/upload failure cannot be attributed
+ * to a concrete `DOMException` (e.g. `reader.error` is `null` or has an empty name).
+ *
+ * This value ends up as the analytics `errorDetail`/`failReason`, so it is an
+ * implicit contract that dashboards/SLO filters key off. It lives here (a public
+ * `@atlaskit/media-client/constants` entry point) so both media-client and
+ * downstream packages (e.g. media-picker) import a single source of truth rather
+ * than re-typing the literal and risking analytics bucket drift.
+ */
+export var FILE_READER_FALLBACK_ERROR_NAME = 'FileReaderError';

package/dist/esm/utils/hashing/fileReaderError.js

@@ -0,0 +1,31 @@
+import { FILE_READER_FALLBACK_ERROR_NAME } from '../../constants';
+
+/**
+ * `FileReader.onerror` hands back a `ProgressEvent`, not an `Error`. Rejecting a
+ * promise with that event causes downstream analytics (`JSON.stringify`) to
+ * collapse it to `{"isTrusted":true}`, hiding the real cause. The actual failure
+ * is on `reader.error` as a `DOMException` whose `name` identifies the problem
+ * (e.g. `NotReadableError`, `NotFoundError`, `SecurityError`).
+ *
+ * This converts that `DOMException` into a real `Error` that preserves the name,
+ * so the failure stays legible as it travels through the upload pipeline. The
+ * original `DOMException` (including its descriptive message) is retained on the
+ * `cause` property for debugging — defined non-enumerable, mirroring the native
+ * `new Error(message, { cause })` form, so it never leaks into analytics that
+ * read `name`/`message` or serialise the error via `JSON.stringify`.
+ */
+export var toFileReaderError = function toFileReaderError(error) {
+  var _error$name;
+  var name = error !== null && error !== void 0 && (_error$name = error.name) !== null && _error$name !== void 0 && _error$name.trim() ? error.name : FILE_READER_FALLBACK_ERROR_NAME;
+  var normalized = new Error(name);
+  normalized.name = name;
+  if (error) {
+    Object.defineProperty(normalized, 'cause', {
+      value: error,
+      enumerable: false,
+      configurable: true,
+      writable: true
+    });
+  }
+  return normalized;
+};

package/dist/esm/utils/hashing/sha256SimpleHasher.js

@@ -1,6 +1,8 @@
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
 import { sha256 } from 'js-sha256';
+import { fg } from '@atlaskit/platform-feature-flags';
+import { toFileReaderError } from './fileReaderError';
 export var SimpleHasher = /*#__PURE__*/function () {
   function SimpleHasher() {
     _classCallCheck(this, SimpleHasher);
@@ -15,7 +17,13 @@ export var SimpleHasher = /*#__PURE__*/function () {
           var _reader$result;
           resolve("sha256-".concat(sha256.create().update((_reader$result = reader.result) !== null && _reader$result !== void 0 ? _reader$result : '').hex()));
         };
-        reader.onerror = reject;
+        reader.onerror = function (event) {
+          if (fg('platform_media_filereader_error_surfacing')) {
+            reject(toFileReaderError(reader.error));
+          } else {
+            reject(event);
+          }
+        };
       });
     }
   }]);

package/dist/esm/utils/hashing/simpleHasher.js

@@ -1,6 +1,8 @@
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
 import * as Rusha from 'rusha';
+import { fg } from '@atlaskit/platform-feature-flags';
+import { toFileReaderError } from './fileReaderError';
 export var SimpleHasher = /*#__PURE__*/function () {
   function SimpleHasher() {
     _classCallCheck(this, SimpleHasher);
@@ -15,7 +17,13 @@ export var SimpleHasher = /*#__PURE__*/function () {
           var _reader$result;
           resolve(Rusha.createHash().update((_reader$result = reader.result) !== null && _reader$result !== void 0 ? _reader$result : '').digest('hex'));
         };
-        reader.onerror = reject;
+        reader.onerror = function (event) {
+          if (fg('platform_media_filereader_error_surfacing')) {
+            reject(toFileReaderError(reader.error));
+          } else {
+            reject(event);
+          }
+        };
       });
     }
   }]);

package/dist/types/constants.d.ts

@@ -4,3 +4,14 @@ export declare const MAX_RESOLUTION = 4096;
 export declare const CHUNK_SIZE: number;
 export declare const PROCESSING_BATCH_SIZE = 1000;
 export declare const MAX_UPLOAD_FILE_SIZE: number;
+/**
+ * Sentinel error name used when a `FileReader`/upload failure cannot be attributed
+ * to a concrete `DOMException` (e.g. `reader.error` is `null` or has an empty name).
+ *
+ * This value ends up as the analytics `errorDetail`/`failReason`, so it is an
+ * implicit contract that dashboards/SLO filters key off. It lives here (a public
+ * `@atlaskit/media-client/constants` entry point) so both media-client and
+ * downstream packages (e.g. media-picker) import a single source of truth rather
+ * than re-typing the literal and risking analytics bucket drift.
+ */
+export declare const FILE_READER_FALLBACK_ERROR_NAME = "FileReaderError";

package/dist/types/utils/hashing/fileReaderError.d.ts

@@ -0,0 +1,15 @@
+/**
+ * `FileReader.onerror` hands back a `ProgressEvent`, not an `Error`. Rejecting a
+ * promise with that event causes downstream analytics (`JSON.stringify`) to
+ * collapse it to `{"isTrusted":true}`, hiding the real cause. The actual failure
+ * is on `reader.error` as a `DOMException` whose `name` identifies the problem
+ * (e.g. `NotReadableError`, `NotFoundError`, `SecurityError`).
+ *
+ * This converts that `DOMException` into a real `Error` that preserves the name,
+ * so the failure stays legible as it travels through the upload pipeline. The
+ * original `DOMException` (including its descriptive message) is retained on the
+ * `cause` property for debugging — defined non-enumerable, mirroring the native
+ * `new Error(message, { cause })` form, so it never leaks into analytics that
+ * read `name`/`message` or serialise the error via `JSON.stringify`.
+ */
+export declare const toFileReaderError: (error: DOMException | null) => Error;

package/hashing/file-reader-error/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/media-client/hashing/file-reader-error",
+  "main": "../../dist/cjs/utils/hashing/fileReaderError.js",
+  "module": "../../dist/esm/utils/hashing/fileReaderError.js",
+  "module:es2019": "../../dist/es2019/utils/hashing/fileReaderError.js",
+  "sideEffects": false,
+  "types": "../../dist/types/utils/hashing/fileReaderError.d.ts"
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/media-client",
-	"version": "36.4.0",
+	"version": "37.1.0",
 	"description": "Media API Web Client Library",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -12,14 +12,6 @@
 	"module": "dist/esm/index.js",
 	"module:es2019": "dist/es2019/index.js",
 	"types": "dist/types/index.d.ts",
-	"typesVersions": {
-		">=4.5 <4.9": {
-			"*": [
-				"dist/types-ts4.5/*",
-				"dist/types-ts4.5/index.d.ts"
-			]
-		}
-	},
 	"sideEffects": false,
 	"atlaskit:src": "src/index.ts",
 	"atlassian": {
@@ -29,10 +21,10 @@
 		}
 	},
 	"dependencies": {
-		"@atlaskit/atlassian-context": "^0.11.0",
-		"@atlaskit/chunkinator": "^7.1.0",
-		"@atlaskit/media-common": "^13.3.0",
-		"@atlaskit/platform-feature-flags": "^1.1.0",
+		"@atlaskit/atlassian-context": "^1.0.0",
+		"@atlaskit/chunkinator": "^8.0.0",
+		"@atlaskit/media-common": "^14.1.0",
+		"@atlaskit/platform-feature-flags": "^2.0.0",
 		"@babel/runtime": "^7.0.0",
 		"dataloader": "^2.1.0",
 		"deep-equal": "^1.0.1",
@@ -45,14 +37,14 @@
 		"xstate": "4.20.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/media-core": "^37.1.0",
-		"@atlaskit/media-state": "^2.2.0"
+		"@atlaskit/media-core": "^38.0.0",
+		"@atlaskit/media-state": "^3.0.0"
 	},
 	"devDependencies": {
-		"@atlaskit/media-core": "^37.1.0",
-		"@atlaskit/media-state": "^2.2.0",
+		"@atlaskit/media-core": "^38.0.0",
+		"@atlaskit/media-state": "^3.0.0",
 		"@atlaskit/ssr": "workspace:^",
-		"@atlaskit/tokens": "^13.4.0",
+		"@atlaskit/tokens": "^14.0.0",
 		"@atlassian/a11y-jest-testing": "^0.12.0",
 		"@atlassian/feature-flags-test-utils": "^1.1.0",
 		"@emotion/react": "^11.7.1",
@@ -98,6 +90,10 @@
 		},
 		"platform_media_upload_expected_size_header": {
 			"type": "boolean"
+		},
+		"platform_media_filereader_error_surfacing": {
+			"type": "boolean",
+			"referenceOnly": true
 		}
 	}
 }