@atlaskit/media-client 37.6.5 → 37.7.0

package/CHANGELOG.md

@@ -1,5 +1,44 @@
 # @atlaskit/media-client
 
+## 37.7.0
+
+### Minor Changes
+
+- [`be8a71519cbc2`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/be8a71519cbc2) -
+  Add support for seeding media card file state from SSR media node metadata, behind the
+  `platform_media_ssr_data_seed` feature gate.
+
+  `@atlaskit/media-client` gains a Relay-free `mapSsrMediaItemToFileState`. Malformed, partial, or
+  non-array input yields `undefined` rather than throwing.
+
+  `@atlaskit/media-card` accepts an optional `ssrMediaItem` prop. When `ssrFileState` is absent and
+  the gate is on, the card converts `ssrMediaItem` to FileState via `mapSsrMediaItemToFileState` and
+  seeds `useFileState`. `ssrFileState` still wins when both are provided (Relay / media-card-relay).
+
+  `@atlaskit/renderer` extends `MediaSSR` with `ssrMediaItems` — the host's SSR media payload,
+  passed through untouched. The renderer finds the matching item by id and forwards it as
+  `ssrMediaItem` to Card. Hosts need no knowledge of `FileState` or of media internals. The field is
+  optional and additive: hosts that do not supply it, and media ids without an entry, keep the
+  current fetch behaviour.
+
+  `@atlaskit/media-card-relay`'s `MediaCardRelay` / `MediaInlineCardRelay` now call the shared
+  `mapSsrMediaItemToFileState` mapper directly (the Relay fragment data is structurally assignable
+  to `SsrMediaItem`, so no cast or wrapper is needed). Its public API and behaviour are unchanged.
+
+  `@atlaskit/media-file-preview` now forwards an SSR-seeded pre-signed `previewCdnUrl` to the new
+  optional `MediaClient.getImageUrlSync(id, params, seededCdnUrl)` argument when
+  `platform_media_ssr_data_seed` is enabled and CDN delivery is in use. `@atlaskit/media-client`
+  preserves the signed CDN asset URL and inserts supported image parameters before the `wm-ari` /
+  `wm-v` watermark anchor, avoiding query-string rebuilding or re-encoding that can invalidate
+  CloudFront signatures. Path-based routing, isolated cloud, GCP, and callers without a seeded URL
+  retain the existing URL-generation behaviour.
+
+## 37.6.6
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 37.6.5
 
 ### Patch Changes

package/dist/cjs/client/media-client.js

@@ -60,8 +60,8 @@ var MediaClient = exports.MediaClient = /*#__PURE__*/function () {
     }
   }, {
     key: "getImageUrlSync",
-    value: function getImageUrlSync(id, params) {
-      return this.mediaStore.getFileImageURLSync(id, params);
+    value: function getImageUrlSync(id, params, seededCdnUrl) {
+      return this.mediaStore.getFileImageURLSync(id, params, seededCdnUrl);
     }
   }, {
     key: "getClientId",

package/dist/cjs/client/media-store/MediaStore.js

@@ -34,9 +34,11 @@ var _fg = require("@atlaskit/platform-feature-flags/fg");
 var _expValEquals = require("@atlaskit/tmp-editor-statsig/exp-val-equals");
 var _constants = require("../../constants");
 var _artifacts = require("../../models/artifacts");
+var _isCDNEnabled = require("../../utils/isCDNEnabled");
 var _isPathBasedEnabled = require("../../utils/isPathBasedEnabled");
 var _mapToMediaCdnUrl = require("../../utils/mapToMediaCdnUrl");
 var _mapToPathBasedUrl = require("../../utils/mapToPathBasedUrl");
+var _mapToSeedBasedCdnUrl = require("../../utils/mapToSeedBasedCdnUrl");
 var _request3 = require("../../utils/request");
 var _createMapResponseToBlob = require("../../utils/request/createMapResponseToBlob");
 var _createMapResponseToJson = require("../../utils/request/createMapResponseToJson");
@@ -460,13 +462,13 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
     }() // TODO Create ticket in case Trace Id can be supported through query params
   }, {
     key: "getFileImageURLSync",
-    value: function getFileImageURLSync(id, params) {
+    value: function getFileImageURLSync(id, params, seededCdnUrl) {
       var auth = this.resolveInitialAuth();
-      return this.createFileImageURL(id, auth, params);
+      return this.createFileImageURL(id, auth, params, seededCdnUrl);
     }
   }, {
     key: "createFileImageURL",
-    value: function createFileImageURL(id, auth, params) {
+    value: function createFileImageURL(id, auth, params, seededCdnUrl) {
       var wmv = (0, _fg.fg)('confluence_watermark_admin_ui') ? (0, _watermarkVersion.getWatermarkVersionFromToken)(auth.token) : undefined;
       var options = {
         params: _objectSpread(_objectSpread({}, (0, _extendImageParams.extendImageParams)(params)), wmv ? {
@@ -475,6 +477,9 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
         auth: auth
       };
       var imageEndpoint = (0, _cdnFeatureFlag.cdnFeatureFlag)('image');
+      if (seededCdnUrl && (0, _isCDNEnabled.isCDNEnabled)()) {
+        return (0, _mapToSeedBasedCdnUrl.mapToSeedBasedCdnUrl)(seededCdnUrl, options.params);
+      }
       if ((0, _isPathBasedEnabled.isPathBasedEnabled)()) {
         return (0, _mapToPathBasedUrl.mapToPathBasedUrl)((0, _createUrl.createUrl)("".concat(auth.baseUrl, "/file/").concat(id, "/").concat(imageEndpoint), options));
       }

package/dist/cjs/models/ssr-media-item.js

@@ -0,0 +1,153 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.mapSsrMediaItemToFileState = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _fileState = require("./file-state");
+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) { (0, _defineProperty2.default)(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; }
+function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+/**
+ * Describes the shape of a plain recorded AGG media item as serialized by Confluence SSR.
+ * All fields are optional/nullable to tolerate untrusted runtime JSON from window globals.
+ *
+ * This is the shape as returned by dt-api-filestore `media_items` aggregation.
+ */
+
+/**
+ * Describes a complete SSR media item with id and details.
+ * All fields are optional/nullable to tolerate untrusted runtime JSON from window globals.
+ */
+
+/**
+ * Safely coerce a value to a number, returning undefined if the value is null/undefined.
+ */
+var toNumber = function toNumber(value) {
+  return value == null ? undefined : Number(value);
+};
+
+/**
+ * Convert abuse classification fields to the keyed format expected by FileState,
+ * returning undefined if either classification or confidence is missing/falsy.
+ */
+var toAbuseClassification = function toAbuseClassification(value) {
+  if (!value || !value.classification || !value.confidence) {
+    return undefined;
+  }
+  return {
+    classification: value.classification,
+    confidence: value.confidence
+  };
+};
+
+/**
+ * Convert the `artifactsList` array shape into the keyed `MediaFileArtifacts`
+ * dict that `MediaItemDetails` / `FileState` consumers expect.
+ *
+ * Each artifact is keyed by its `name` (e.g. `'image.png'`, `'thumb_120.jpg'`).
+ * Artifacts missing required fields (`name`, `url`, `processingStatus`)
+ * are skipped rather than coerced — callers should treat absent artifacts as
+ * "not yet available" rather than "failed".
+ *
+ * NOTE: This assumes AGG returns `name` values matching the canonical
+ * `MediaFileArtifacts` key vocabulary. If that assumption is broken, the
+ * downstream renderer will silently miss SSR thumbnails — verify with a real
+ * payload before relying on SSR previews.
+ */
+var toArtifacts = function toArtifacts(list) {
+  var out = {};
+  if (!list) {
+    return out;
+  }
+  var _iterator = _createForOfIteratorHelper(list),
+    _step;
+  try {
+    for (_iterator.s(); !(_step = _iterator.n()).done;) {
+      var item = _step.value;
+      if (!item.name || !item.url || !item.processingStatus) {
+        continue;
+      }
+      var artifact = _objectSpread(_objectSpread(_objectSpread({
+        processingStatus: item.processingStatus,
+        url: item.url
+      }, item.mimeType ? {
+        mimeType: item.mimeType
+      } : {}), item.size != null ? {
+        size: Number(item.size)
+      } : {}), item.createdAt != null ? {
+        createdAt: Number(item.createdAt)
+      } : {});
+      out[item.name] = artifact;
+    }
+  } catch (err) {
+    _iterator.e(err);
+  } finally {
+    _iterator.f();
+  }
+  return out;
+};
+
+/**
+ * Map a plain SSR media item (from AGG / dt-api-filestore) to a `FileState`
+ * for seeding `<Card />` / `<MediaInlineCard />`.
+ *
+ * Returns `undefined` when:
+ * - `item` is null/undefined or missing `id`/`details`
+ * - any of the required `MediaFile` fields (`name`, `mimeType`, `mediaType`,
+ *   `processingStatus`) are missing or falsy
+ * - `size` is missing or cannot be coerced to a number
+ *
+ * The transformation reshapes `details.artifactsList` (array, AGG-only) into
+ * the keyed `details.artifacts` dict expected by `mapMediaItemToFileState`,
+ * and coerces `AGG$Long` numerics.
+ *
+ * MUST NOT throw on malformed input — always return undefined instead.
+ */
+var mapSsrMediaItemToFileState = exports.mapSsrMediaItemToFileState = function mapSsrMediaItemToFileState(item) {
+  try {
+    var _d$representations, _d$mediaMetadata, _d$preview;
+    if (!(item !== null && item !== void 0 && item.id) || !item.details) {
+      return undefined;
+    }
+    var d = item.details;
+    var processingStatus = d.processingStatus;
+    var mediaType = d.mediaType;
+    var size = toNumber(d.size);
+    if (!d.name || !d.mimeType || !mediaType || !processingStatus || size === undefined) {
+      return undefined;
+    }
+    var abuseClassification = toAbuseClassification(d.abuseClassification);
+    var details = _objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread({
+      name: d.name,
+      mimeType: d.mimeType,
+      mediaType: mediaType,
+      processingStatus: processingStatus,
+      size: size,
+      artifacts: toArtifacts(d.artifactsList),
+      representations: (_d$representations = d.representations) !== null && _d$representations !== void 0 && _d$representations.image ? {
+        image: {}
+      } : {}
+    }, d.failReason ? {
+      failReason: d.failReason
+    } : {}), d.createdAt != null ? {
+      createdAt: Number(d.createdAt)
+    } : {}), ((_d$mediaMetadata = d.mediaMetadata) === null || _d$mediaMetadata === void 0 ? void 0 : _d$mediaMetadata.duration) != null ? {
+      mediaMetadata: {
+        duration: d.mediaMetadata.duration
+      }
+    } : {}), abuseClassification ? {
+      abuseClassification: abuseClassification
+    } : {}), (_d$preview = d.preview) !== null && _d$preview !== void 0 && _d$preview.cdnUrl ? {
+      previewCdnUrl: d.preview.cdnUrl
+    } : {});
+    return (0, _fileState.mapMediaItemToFileState)(item.id, details);
+  } catch (_unused) {
+    // Silently catch any unexpected errors and return undefined
+    return undefined;
+  }
+};

package/dist/cjs/utils/mapToSeedBasedCdnUrl.js

@@ -0,0 +1,40 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.mapToSeedBasedCdnUrl = void 0;
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var IMAGE_PARAM_KEYS = new Set(['width', 'height', 'mode', 'allowAnimated', 'upscale', 'version', 'max-age']);
+
+/**
+ * Adds supported image parameters to a pre-signed CDN asset URL without
+ * re-parsing or re-encoding its existing query string.
+ *
+ * Watermarked CloudFront policies anchor `wm-ari` and `wm-v` as a literal
+ * suffix, so parameters must be inserted before `wm-ari`. Non-watermarked
+ * policies have a trailing wildcard, so parameters can be appended.
+ */
+var mapToSeedBasedCdnUrl = exports.mapToSeedBasedCdnUrl = function mapToSeedBasedCdnUrl(seededCdnUrl, params) {
+  var insert = Object.entries(params !== null && params !== void 0 ? params : {}).filter(function (_ref) {
+    var _ref2 = (0, _slicedToArray2.default)(_ref, 2),
+      key = _ref2[0],
+      value = _ref2[1];
+    return value != null && IMAGE_PARAM_KEYS.has(key);
+  }).map(function (_ref3) {
+    var _ref4 = (0, _slicedToArray2.default)(_ref3, 2),
+      key = _ref4[0],
+      value = _ref4[1];
+    return "".concat(encodeURIComponent(key), "=").concat(encodeURIComponent(String(value)));
+  }).join('&');
+  if (!insert) {
+    return seededCdnUrl;
+  }
+  var wm = seededCdnUrl.search(/[?&]wm-ari=/);
+  if (wm !== -1) {
+    var separator = seededCdnUrl[wm];
+    return "".concat(seededCdnUrl.slice(0, wm)).concat(separator).concat(insert, "&").concat(seededCdnUrl.slice(wm + 1));
+  }
+  return "".concat(seededCdnUrl).concat(seededCdnUrl.includes('?') ? '&' : '?').concat(insert);
+};

package/dist/cjs/utils/mediaCdn.js

@@ -4,6 +4,13 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.MEDIA_TOKEN_LENGTH_LIMIT = exports.MEDIA_CDN_MAP = void 0;
+Object.defineProperty(exports, "isCDNEnabled", {
+  enumerable: true,
+  get: function get() {
+    return _isCDNEnabled.isCDNEnabled;
+  }
+});
+var _isCDNEnabled = require("./isCDNEnabled");
 var MEDIA_CDN_MAP = exports.MEDIA_CDN_MAP = {
   'api.media.atlassian.com': 'media-cdn.atlassian.com',
   'media.staging.atl-paas.net': 'media-cdn.stg.atlassian.com'

package/dist/es2019/client/media-client.js

@@ -36,8 +36,8 @@ export class MediaClient {
   getImageUrl(id, params) {
     return this.mediaStore.getFileImageURL(id, params);
   }
-  getImageUrlSync(id, params) {
-    return this.mediaStore.getFileImageURLSync(id, params);
+  getImageUrlSync(id, params, seededCdnUrl) {
+    return this.mediaStore.getFileImageURLSync(id, params, seededCdnUrl);
   }
   async getClientId(collectionName) {
     return this.mediaStore.getClientId(collectionName);

package/dist/es2019/client/media-store/MediaStore.js

@@ -7,9 +7,11 @@ import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { FILE_CACHE_MAX_AGE } from '../../constants';
 import { getArtifactUrl } from '../../models/artifacts';
+import { isCDNEnabled } from '../../utils/isCDNEnabled';
 import { isPathBasedEnabled } from '../../utils/isPathBasedEnabled';
 import { mapToMediaCdnUrl } from '../../utils/mapToMediaCdnUrl';
 import { mapToPathBasedUrl } from '../../utils/mapToPathBasedUrl';
+import { mapToSeedBasedCdnUrl } from '../../utils/mapToSeedBasedCdnUrl';
 import { isRequestError, request } from '../../utils/request';
 import { createMapResponseToBlob } from '../../utils/request/createMapResponseToBlob';
 import { createMapResponseToJson } from '../../utils/request/createMapResponseToJson';
@@ -289,11 +291,11 @@ export class MediaStore {
   }
 
   // TODO Create ticket in case Trace Id can be supported through query params
-  getFileImageURLSync(id, params) {
+  getFileImageURLSync(id, params, seededCdnUrl) {
     const auth = this.resolveInitialAuth();
-    return this.createFileImageURL(id, auth, params);
+    return this.createFileImageURL(id, auth, params, seededCdnUrl);
   }
-  createFileImageURL(id, auth, params) {
+  createFileImageURL(id, auth, params, seededCdnUrl) {
     const wmv = fg('confluence_watermark_admin_ui') ? getWatermarkVersionFromToken(auth.token) : undefined;
     const options = {
       params: {
@@ -305,6 +307,9 @@ export class MediaStore {
       auth
     };
     const imageEndpoint = cdnFeatureFlag('image');
+    if (seededCdnUrl && isCDNEnabled()) {
+      return mapToSeedBasedCdnUrl(seededCdnUrl, options.params);
+    }
     if (isPathBasedEnabled()) {
       return mapToPathBasedUrl(createUrl(`${auth.baseUrl}/file/${id}/${imageEndpoint}`, options));
     }

package/dist/es2019/models/ssr-media-item.js

@@ -0,0 +1,138 @@
+import { mapMediaItemToFileState } from './file-state';
+
+/**
+ * Describes the shape of a plain recorded AGG media item as serialized by Confluence SSR.
+ * All fields are optional/nullable to tolerate untrusted runtime JSON from window globals.
+ *
+ * This is the shape as returned by dt-api-filestore `media_items` aggregation.
+ */
+
+/**
+ * Describes a complete SSR media item with id and details.
+ * All fields are optional/nullable to tolerate untrusted runtime JSON from window globals.
+ */
+
+/**
+ * Safely coerce a value to a number, returning undefined if the value is null/undefined.
+ */
+const toNumber = value => value == null ? undefined : Number(value);
+
+/**
+ * Convert abuse classification fields to the keyed format expected by FileState,
+ * returning undefined if either classification or confidence is missing/falsy.
+ */
+const toAbuseClassification = value => {
+  if (!value || !value.classification || !value.confidence) {
+    return undefined;
+  }
+  return {
+    classification: value.classification,
+    confidence: value.confidence
+  };
+};
+
+/**
+ * Convert the `artifactsList` array shape into the keyed `MediaFileArtifacts`
+ * dict that `MediaItemDetails` / `FileState` consumers expect.
+ *
+ * Each artifact is keyed by its `name` (e.g. `'image.png'`, `'thumb_120.jpg'`).
+ * Artifacts missing required fields (`name`, `url`, `processingStatus`)
+ * are skipped rather than coerced — callers should treat absent artifacts as
+ * "not yet available" rather than "failed".
+ *
+ * NOTE: This assumes AGG returns `name` values matching the canonical
+ * `MediaFileArtifacts` key vocabulary. If that assumption is broken, the
+ * downstream renderer will silently miss SSR thumbnails — verify with a real
+ * payload before relying on SSR previews.
+ */
+const toArtifacts = list => {
+  const out = {};
+  if (!list) {
+    return out;
+  }
+  for (const item of list) {
+    if (!item.name || !item.url || !item.processingStatus) {
+      continue;
+    }
+    const artifact = {
+      processingStatus: item.processingStatus,
+      url: item.url,
+      ...(item.mimeType ? {
+        mimeType: item.mimeType
+      } : {}),
+      ...(item.size != null ? {
+        size: Number(item.size)
+      } : {}),
+      ...(item.createdAt != null ? {
+        createdAt: Number(item.createdAt)
+      } : {})
+    };
+    out[item.name] = artifact;
+  }
+  return out;
+};
+
+/**
+ * Map a plain SSR media item (from AGG / dt-api-filestore) to a `FileState`
+ * for seeding `<Card />` / `<MediaInlineCard />`.
+ *
+ * Returns `undefined` when:
+ * - `item` is null/undefined or missing `id`/`details`
+ * - any of the required `MediaFile` fields (`name`, `mimeType`, `mediaType`,
+ *   `processingStatus`) are missing or falsy
+ * - `size` is missing or cannot be coerced to a number
+ *
+ * The transformation reshapes `details.artifactsList` (array, AGG-only) into
+ * the keyed `details.artifacts` dict expected by `mapMediaItemToFileState`,
+ * and coerces `AGG$Long` numerics.
+ *
+ * MUST NOT throw on malformed input — always return undefined instead.
+ */
+export const mapSsrMediaItemToFileState = item => {
+  try {
+    var _d$representations, _d$mediaMetadata, _d$preview;
+    if (!(item !== null && item !== void 0 && item.id) || !item.details) {
+      return undefined;
+    }
+    const d = item.details;
+    const processingStatus = d.processingStatus;
+    const mediaType = d.mediaType;
+    const size = toNumber(d.size);
+    if (!d.name || !d.mimeType || !mediaType || !processingStatus || size === undefined) {
+      return undefined;
+    }
+    const abuseClassification = toAbuseClassification(d.abuseClassification);
+    const details = {
+      name: d.name,
+      mimeType: d.mimeType,
+      mediaType: mediaType,
+      processingStatus: processingStatus,
+      size,
+      artifacts: toArtifacts(d.artifactsList),
+      representations: (_d$representations = d.representations) !== null && _d$representations !== void 0 && _d$representations.image ? {
+        image: {}
+      } : {},
+      ...(d.failReason ? {
+        failReason: d.failReason
+      } : {}),
+      ...(d.createdAt != null ? {
+        createdAt: Number(d.createdAt)
+      } : {}),
+      ...(((_d$mediaMetadata = d.mediaMetadata) === null || _d$mediaMetadata === void 0 ? void 0 : _d$mediaMetadata.duration) != null ? {
+        mediaMetadata: {
+          duration: d.mediaMetadata.duration
+        }
+      } : {}),
+      ...(abuseClassification ? {
+        abuseClassification
+      } : {}),
+      ...((_d$preview = d.preview) !== null && _d$preview !== void 0 && _d$preview.cdnUrl ? {
+        previewCdnUrl: d.preview.cdnUrl
+      } : {})
+    };
+    return mapMediaItemToFileState(item.id, details);
+  } catch {
+    // Silently catch any unexpected errors and return undefined
+    return undefined;
+  }
+};

package/dist/es2019/utils/mapToSeedBasedCdnUrl.js

@@ -0,0 +1,22 @@
+const IMAGE_PARAM_KEYS = new Set(['width', 'height', 'mode', 'allowAnimated', 'upscale', 'version', 'max-age']);
+
+/**
+ * Adds supported image parameters to a pre-signed CDN asset URL without
+ * re-parsing or re-encoding its existing query string.
+ *
+ * Watermarked CloudFront policies anchor `wm-ari` and `wm-v` as a literal
+ * suffix, so parameters must be inserted before `wm-ari`. Non-watermarked
+ * policies have a trailing wildcard, so parameters can be appended.
+ */
+export const mapToSeedBasedCdnUrl = (seededCdnUrl, params) => {
+  const insert = Object.entries(params !== null && params !== void 0 ? params : {}).filter(([key, value]) => value != null && IMAGE_PARAM_KEYS.has(key)).map(([key, value]) => `${encodeURIComponent(key)}=${encodeURIComponent(String(value))}`).join('&');
+  if (!insert) {
+    return seededCdnUrl;
+  }
+  const wm = seededCdnUrl.search(/[?&]wm-ari=/);
+  if (wm !== -1) {
+    const separator = seededCdnUrl[wm];
+    return `${seededCdnUrl.slice(0, wm)}${separator}${insert}&${seededCdnUrl.slice(wm + 1)}`;
+  }
+  return `${seededCdnUrl}${seededCdnUrl.includes('?') ? '&' : '?'}${insert}`;
+};

package/dist/es2019/utils/mediaCdn.js

@@ -6,4 +6,5 @@ export const MEDIA_CDN_MAP = {
 // Cloudfront has a hard limit of 8,192 bytes
 // https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html
 // Assuming other parts of the URL make up a max of ~1000 (in reality it's lower), the token can be ~7000
-export const MEDIA_TOKEN_LENGTH_LIMIT = 7000;
+export const MEDIA_TOKEN_LENGTH_LIMIT = 7000;
+export { isCDNEnabled } from './isCDNEnabled';

package/dist/esm/client/media-client.js

@@ -51,8 +51,8 @@ export var MediaClient = /*#__PURE__*/function () {
     }
   }, {
     key: "getImageUrlSync",
-    value: function getImageUrlSync(id, params) {
-      return this.mediaStore.getFileImageURLSync(id, params);
+    value: function getImageUrlSync(id, params, seededCdnUrl) {
+      return this.mediaStore.getFileImageURLSync(id, params, seededCdnUrl);
     }
   }, {
     key: "getClientId",

package/dist/esm/client/media-store/MediaStore.js

@@ -13,9 +13,11 @@ import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { FILE_CACHE_MAX_AGE } from '../../constants';
 import { getArtifactUrl } from '../../models/artifacts';
+import { isCDNEnabled } from '../../utils/isCDNEnabled';
 import { isPathBasedEnabled } from '../../utils/isPathBasedEnabled';
 import { mapToMediaCdnUrl } from '../../utils/mapToMediaCdnUrl';
 import { mapToPathBasedUrl } from '../../utils/mapToPathBasedUrl';
+import { mapToSeedBasedCdnUrl } from '../../utils/mapToSeedBasedCdnUrl';
 import { isRequestError, request as _request } from '../../utils/request';
 import { createMapResponseToBlob } from '../../utils/request/createMapResponseToBlob';
 import { createMapResponseToJson } from '../../utils/request/createMapResponseToJson';
@@ -434,13 +436,13 @@ export var MediaStore = /*#__PURE__*/function () {
     }() // TODO Create ticket in case Trace Id can be supported through query params
   }, {
     key: "getFileImageURLSync",
-    value: function getFileImageURLSync(id, params) {
+    value: function getFileImageURLSync(id, params, seededCdnUrl) {
       var auth = this.resolveInitialAuth();
-      return this.createFileImageURL(id, auth, params);
+      return this.createFileImageURL(id, auth, params, seededCdnUrl);
     }
   }, {
     key: "createFileImageURL",
-    value: function createFileImageURL(id, auth, params) {
+    value: function createFileImageURL(id, auth, params, seededCdnUrl) {
       var wmv = fg('confluence_watermark_admin_ui') ? getWatermarkVersionFromToken(auth.token) : undefined;
       var options = {
         params: _objectSpread(_objectSpread({}, extendImageParams(params)), wmv ? {
@@ -449,6 +451,9 @@ export var MediaStore = /*#__PURE__*/function () {
         auth: auth
       };
       var imageEndpoint = cdnFeatureFlag('image');
+      if (seededCdnUrl && isCDNEnabled()) {
+        return mapToSeedBasedCdnUrl(seededCdnUrl, options.params);
+      }
       if (isPathBasedEnabled()) {
         return mapToPathBasedUrl(createUrl("".concat(auth.baseUrl, "/file/").concat(id, "/").concat(imageEndpoint), options));
       }

package/dist/esm/models/ssr-media-item.js

@@ -0,0 +1,147 @@
+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; }
+function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+import { mapMediaItemToFileState } from './file-state';
+
+/**
+ * Describes the shape of a plain recorded AGG media item as serialized by Confluence SSR.
+ * All fields are optional/nullable to tolerate untrusted runtime JSON from window globals.
+ *
+ * This is the shape as returned by dt-api-filestore `media_items` aggregation.
+ */
+
+/**
+ * Describes a complete SSR media item with id and details.
+ * All fields are optional/nullable to tolerate untrusted runtime JSON from window globals.
+ */
+
+/**
+ * Safely coerce a value to a number, returning undefined if the value is null/undefined.
+ */
+var toNumber = function toNumber(value) {
+  return value == null ? undefined : Number(value);
+};
+
+/**
+ * Convert abuse classification fields to the keyed format expected by FileState,
+ * returning undefined if either classification or confidence is missing/falsy.
+ */
+var toAbuseClassification = function toAbuseClassification(value) {
+  if (!value || !value.classification || !value.confidence) {
+    return undefined;
+  }
+  return {
+    classification: value.classification,
+    confidence: value.confidence
+  };
+};
+
+/**
+ * Convert the `artifactsList` array shape into the keyed `MediaFileArtifacts`
+ * dict that `MediaItemDetails` / `FileState` consumers expect.
+ *
+ * Each artifact is keyed by its `name` (e.g. `'image.png'`, `'thumb_120.jpg'`).
+ * Artifacts missing required fields (`name`, `url`, `processingStatus`)
+ * are skipped rather than coerced — callers should treat absent artifacts as
+ * "not yet available" rather than "failed".
+ *
+ * NOTE: This assumes AGG returns `name` values matching the canonical
+ * `MediaFileArtifacts` key vocabulary. If that assumption is broken, the
+ * downstream renderer will silently miss SSR thumbnails — verify with a real
+ * payload before relying on SSR previews.
+ */
+var toArtifacts = function toArtifacts(list) {
+  var out = {};
+  if (!list) {
+    return out;
+  }
+  var _iterator = _createForOfIteratorHelper(list),
+    _step;
+  try {
+    for (_iterator.s(); !(_step = _iterator.n()).done;) {
+      var item = _step.value;
+      if (!item.name || !item.url || !item.processingStatus) {
+        continue;
+      }
+      var artifact = _objectSpread(_objectSpread(_objectSpread({
+        processingStatus: item.processingStatus,
+        url: item.url
+      }, item.mimeType ? {
+        mimeType: item.mimeType
+      } : {}), item.size != null ? {
+        size: Number(item.size)
+      } : {}), item.createdAt != null ? {
+        createdAt: Number(item.createdAt)
+      } : {});
+      out[item.name] = artifact;
+    }
+  } catch (err) {
+    _iterator.e(err);
+  } finally {
+    _iterator.f();
+  }
+  return out;
+};
+
+/**
+ * Map a plain SSR media item (from AGG / dt-api-filestore) to a `FileState`
+ * for seeding `<Card />` / `<MediaInlineCard />`.
+ *
+ * Returns `undefined` when:
+ * - `item` is null/undefined or missing `id`/`details`
+ * - any of the required `MediaFile` fields (`name`, `mimeType`, `mediaType`,
+ *   `processingStatus`) are missing or falsy
+ * - `size` is missing or cannot be coerced to a number
+ *
+ * The transformation reshapes `details.artifactsList` (array, AGG-only) into
+ * the keyed `details.artifacts` dict expected by `mapMediaItemToFileState`,
+ * and coerces `AGG$Long` numerics.
+ *
+ * MUST NOT throw on malformed input — always return undefined instead.
+ */
+export var mapSsrMediaItemToFileState = function mapSsrMediaItemToFileState(item) {
+  try {
+    var _d$representations, _d$mediaMetadata, _d$preview;
+    if (!(item !== null && item !== void 0 && item.id) || !item.details) {
+      return undefined;
+    }
+    var d = item.details;
+    var processingStatus = d.processingStatus;
+    var mediaType = d.mediaType;
+    var size = toNumber(d.size);
+    if (!d.name || !d.mimeType || !mediaType || !processingStatus || size === undefined) {
+      return undefined;
+    }
+    var abuseClassification = toAbuseClassification(d.abuseClassification);
+    var details = _objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread({
+      name: d.name,
+      mimeType: d.mimeType,
+      mediaType: mediaType,
+      processingStatus: processingStatus,
+      size: size,
+      artifacts: toArtifacts(d.artifactsList),
+      representations: (_d$representations = d.representations) !== null && _d$representations !== void 0 && _d$representations.image ? {
+        image: {}
+      } : {}
+    }, d.failReason ? {
+      failReason: d.failReason
+    } : {}), d.createdAt != null ? {
+      createdAt: Number(d.createdAt)
+    } : {}), ((_d$mediaMetadata = d.mediaMetadata) === null || _d$mediaMetadata === void 0 ? void 0 : _d$mediaMetadata.duration) != null ? {
+      mediaMetadata: {
+        duration: d.mediaMetadata.duration
+      }
+    } : {}), abuseClassification ? {
+      abuseClassification: abuseClassification
+    } : {}), (_d$preview = d.preview) !== null && _d$preview !== void 0 && _d$preview.cdnUrl ? {
+      previewCdnUrl: d.preview.cdnUrl
+    } : {});
+    return mapMediaItemToFileState(item.id, details);
+  } catch (_unused) {
+    // Silently catch any unexpected errors and return undefined
+    return undefined;
+  }
+};

package/dist/esm/utils/mapToSeedBasedCdnUrl.js

@@ -0,0 +1,33 @@
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+var IMAGE_PARAM_KEYS = new Set(['width', 'height', 'mode', 'allowAnimated', 'upscale', 'version', 'max-age']);
+
+/**
+ * Adds supported image parameters to a pre-signed CDN asset URL without
+ * re-parsing or re-encoding its existing query string.
+ *
+ * Watermarked CloudFront policies anchor `wm-ari` and `wm-v` as a literal
+ * suffix, so parameters must be inserted before `wm-ari`. Non-watermarked
+ * policies have a trailing wildcard, so parameters can be appended.
+ */
+export var mapToSeedBasedCdnUrl = function mapToSeedBasedCdnUrl(seededCdnUrl, params) {
+  var insert = Object.entries(params !== null && params !== void 0 ? params : {}).filter(function (_ref) {
+    var _ref2 = _slicedToArray(_ref, 2),
+      key = _ref2[0],
+      value = _ref2[1];
+    return value != null && IMAGE_PARAM_KEYS.has(key);
+  }).map(function (_ref3) {
+    var _ref4 = _slicedToArray(_ref3, 2),
+      key = _ref4[0],
+      value = _ref4[1];
+    return "".concat(encodeURIComponent(key), "=").concat(encodeURIComponent(String(value)));
+  }).join('&');
+  if (!insert) {
+    return seededCdnUrl;
+  }
+  var wm = seededCdnUrl.search(/[?&]wm-ari=/);
+  if (wm !== -1) {
+    var separator = seededCdnUrl[wm];
+    return "".concat(seededCdnUrl.slice(0, wm)).concat(separator).concat(insert, "&").concat(seededCdnUrl.slice(wm + 1));
+  }
+  return "".concat(seededCdnUrl).concat(seededCdnUrl.includes('?') ? '&' : '?').concat(insert);
+};

package/dist/esm/utils/mediaCdn.js

@@ -6,4 +6,5 @@ export var MEDIA_CDN_MAP = {
 // Cloudfront has a hard limit of 8,192 bytes
 // https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html
 // Assuming other parts of the URL make up a max of ~1000 (in reality it's lower), the token can be ~7000
-export var MEDIA_TOKEN_LENGTH_LIMIT = 7000;
+export var MEDIA_TOKEN_LENGTH_LIMIT = 7000;
+export { isCDNEnabled } from './isCDNEnabled';

package/dist/types/client/media-client.d.ts

@@ -23,7 +23,7 @@ export declare class MediaClient {
     __DO_NOT_USE__getMediaStore(): MediaStore;
     getImage(id: string, params?: MediaStoreGetFileImageParams, controller?: AbortController, fetchMaxRes?: boolean, traceContext?: MediaTraceContext): Promise<Blob>;
     getImageUrl(id: string, params?: MediaStoreGetFileImageParams): Promise<string>;
-    getImageUrlSync(id: string, params?: MediaStoreGetFileImageParams): string;
+    getImageUrlSync(id: string, params?: MediaStoreGetFileImageParams, seededCdnUrl?: string): string;
     getClientId(collectionName?: string): Promise<string | undefined>;
     getClientIdSync(): string | undefined;
     getImageMetadata(id: string, params?: MediaStoreGetFileImageParams): Promise<ImageMetadata>;

package/dist/types/client/media-store/MediaStore.d.ts

@@ -26,7 +26,7 @@ export declare class MediaStore implements MediaApi {
     }): Promise<MediaStoreResponse<TouchedFiles>>;
     getFile(fileId: string, params?: MediaStoreGetFileParams, traceContext?: MediaTraceContext): Promise<MediaStoreResponse<MediaFile>>;
     getFileImageURL(id: string, params?: MediaStoreGetFileImageParams): Promise<string>;
-    getFileImageURLSync(id: string, params?: MediaStoreGetFileImageParams): string;
+    getFileImageURLSync(id: string, params?: MediaStoreGetFileImageParams, seededCdnUrl?: string): string;
     private createFileImageURL;
     getFileBinary(id: string, collectionName?: string, abortController?: AbortController, maxAge?: number): Promise<Blob>;
     getFileBinaryURL(id: string, collectionName?: string, maxAge?: number, name?: string): Promise<string>;

package/dist/types/client/media-store/types.d.ts

@@ -177,7 +177,7 @@ export interface MediaApi {
     }) => Promise<MediaStoreResponse<TouchedFiles>>;
     getFile: (fileId: string, params: MediaStoreGetFileParams, traceContext?: MediaTraceContext) => Promise<MediaStoreResponse<MediaFile>>;
     getFileImageURL: (id: string, params?: MediaStoreGetFileImageParams) => Promise<string>;
-    getFileImageURLSync: (id: string, params?: MediaStoreGetFileImageParams) => string;
+    getFileImageURLSync: (id: string, params?: MediaStoreGetFileImageParams, seededCdnUrl?: string) => string;
     getFileBinary: (id: string, collectionName?: string, abortController?: AbortController) => Promise<Blob>;
     getFileBinaryURL: (id: string, collectionName?: string, maxAge?: number, name?: string) => Promise<string>;
     getArtifactURL: (artifacts: MediaFileArtifacts, artifactName: keyof MediaFileArtifacts, collectionName?: string) => Promise<string>;

package/dist/types/models/ssr-media-item.d.ts

@@ -0,0 +1,65 @@
+import type { FileState } from '@atlaskit/media-state/file-state';
+/**
+ * Describes the shape of a plain recorded AGG media item as serialized by Confluence SSR.
+ * All fields are optional/nullable to tolerate untrusted runtime JSON from window globals.
+ *
+ * This is the shape as returned by dt-api-filestore `media_items` aggregation.
+ */
+export interface SsrMediaItemDetails {
+    readonly name?: string | null;
+    readonly size?: number | null;
+    readonly mimeType?: string | null;
+    readonly mediaType?: string | null;
+    readonly processingStatus?: string | null;
+    readonly failReason?: string | null;
+    readonly createdAt?: number | null;
+    readonly preview?: {
+        readonly cdnUrl?: string | null;
+    } | null;
+    readonly artifactsList?: ReadonlyArray<{
+        readonly createdAt?: number | null;
+        readonly mimeType?: string | null;
+        readonly name?: string;
+        readonly processingStatus?: string | null;
+        readonly size?: number | null;
+        readonly url?: string | null;
+    }> | null;
+    readonly representations?: {
+        readonly image?: {
+            readonly _empty?: boolean | null;
+        } | null;
+    } | null;
+    readonly mediaMetadata?: {
+        readonly duration?: number | null;
+    } | null;
+    readonly abuseClassification?: {
+        readonly classification?: string | null;
+        readonly confidence?: string | null;
+    } | null;
+}
+/**
+ * Describes a complete SSR media item with id and details.
+ * All fields are optional/nullable to tolerate untrusted runtime JSON from window globals.
+ */
+export interface SsrMediaItem {
+    readonly id?: string;
+    readonly type?: string;
+    readonly details?: SsrMediaItemDetails | null;
+}
+/**
+ * Map a plain SSR media item (from AGG / dt-api-filestore) to a `FileState`
+ * for seeding `<Card />` / `<MediaInlineCard />`.
+ *
+ * Returns `undefined` when:
+ * - `item` is null/undefined or missing `id`/`details`
+ * - any of the required `MediaFile` fields (`name`, `mimeType`, `mediaType`,
+ *   `processingStatus`) are missing or falsy
+ * - `size` is missing or cannot be coerced to a number
+ *
+ * The transformation reshapes `details.artifactsList` (array, AGG-only) into
+ * the keyed `details.artifacts` dict expected by `mapMediaItemToFileState`,
+ * and coerces `AGG$Long` numerics.
+ *
+ * MUST NOT throw on malformed input — always return undefined instead.
+ */
+export declare const mapSsrMediaItemToFileState: (item: SsrMediaItem | null | undefined) => FileState | undefined;

package/dist/types/utils/mapToSeedBasedCdnUrl.d.ts

@@ -0,0 +1,10 @@
+import type { MediaStoreGetFileImageParams } from '../client/media-store/types';
+/**
+ * Adds supported image parameters to a pre-signed CDN asset URL without
+ * re-parsing or re-encoding its existing query string.
+ *
+ * Watermarked CloudFront policies anchor `wm-ari` and `wm-v` as a literal
+ * suffix, so parameters must be inserted before `wm-ari`. Non-watermarked
+ * policies have a trailing wildcard, so parameters can be appended.
+ */
+export declare const mapToSeedBasedCdnUrl: (seededCdnUrl: string, params?: MediaStoreGetFileImageParams) => string;

package/dist/types/utils/mediaCdn.d.ts

@@ -2,3 +2,4 @@ export declare const MEDIA_CDN_MAP: {
     [key: string]: string;
 };
 export declare const MEDIA_TOKEN_LENGTH_LIMIT: any;
+export { isCDNEnabled } from './isCDNEnabled';

package/media-cdn/package.json

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/media-client",
-	"version": "37.6.5",
+	"version": "37.7.0",
 	"description": "Media API Web Client Library",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -25,7 +25,7 @@
 		"@atlaskit/chunkinator": "^8.1.0",
 		"@atlaskit/media-common": "^14.6.0",
 		"@atlaskit/platform-feature-flags": "^2.2.0",
-		"@atlaskit/tmp-editor-statsig": "^173.0.0",
+		"@atlaskit/tmp-editor-statsig": "^174.0.0",
 		"@babel/runtime": "^7.0.0",
 		"dataloader": "^2.1.0",
 		"deep-equal": "^1.0.1",

package/ssr-media-item/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/media-client/ssr-media-item",
+  "main": "../dist/cjs/models/ssr-media-item.js",
+  "module": "../dist/esm/models/ssr-media-item.js",
+  "module:es2019": "../dist/es2019/models/ssr-media-item.js",
+  "sideEffects": false,
+  "types": "../dist/types/models/ssr-media-item.d.ts"
+}