@atlaskit/media-client 33.4.0 → 33.5.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @atlaskit/media-client
 
+## 33.5.0
+
+### Minor Changes
+
+- [#172332](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/172332)
+  [`d257b57972216`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/d257b57972216) -
+  Updating the response type of document content endpoint to add the new annotation and links from
+  documents
+
+## 33.4.1
+
+### Patch Changes
+
+- [#169848](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/169848)
+  [`0c2daefdb5712`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/0c2daefdb5712) -
+  Standardise generation of telemetry IDs across media packages.
+- Updated dependencies
+
 ## 33.4.0
 
 ### Minor Changes

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

@@ -665,26 +665,28 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
     key: "getDocumentContent",
     value: function () {
       var _getDocumentContent = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee12(id, options) {
-        var metadata, requestOptions;
+        var endpoint, metadata, requestOptions;
         return _regenerator.default.wrap(function _callee12$(_context12) {
           while (1) switch (_context12.prev = _context12.next) {
             case 0:
+              endpoint = cdnFeatureFlag('contents');
               metadata = {
                 method: 'GET',
-                endpoint: '/file/{fileId}/document/contents'
+                endpoint: "/file/{fileId}/document/".concat(endpoint)
               };
               requestOptions = _objectSpread(_objectSpread({}, metadata), {}, {
                 authContext: {
                   collectionName: options.collectionName
                 },
                 params: {
+                  collection: options.collectionName,
                   pageStart: options.pageStart,
                   pageEnd: options.pageEnd,
                   'max-age': _constants.FILE_CACHE_MAX_AGE
                 }
               });
-              return _context12.abrupt("return", this.request("/file/".concat(id, "/document/contents"), requestOptions).then((0, _helpers.createMapResponseToJson)(metadata)));
-            case 3:
+              return _context12.abrupt("return", this.request("/file/".concat(id, "/document/").concat(endpoint), requestOptions).then((0, _helpers.createMapResponseToJson)(metadata)));
+            case 4:
             case "end":
               return _context12.stop();
           }
@@ -703,6 +705,7 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
         return _regenerator.default.wrap(function _callee13$(_context13) {
           while (1) switch (_context13.prev = _context13.next) {
             case 0:
+              // Temporarily disabling CDN for document due to bug of CDN not forwarding query params
               endpoint = cdnFeatureFlag('page');
               metadata = {
                 method: 'GET',
@@ -713,6 +716,7 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
                   collectionName: options.collectionName
                 },
                 params: {
+                  collection: options.collectionName,
                   page: options.page,
                   zoom: options.zoom,
                   'max-age': _constants.FILE_CACHE_MAX_AGE

package/dist/cjs/utils/createCopyIntentRegisterationBatcher.js

@@ -51,8 +51,8 @@ function createBatchCopyIntentRegisterationFunc(mediaStore) {
                   while (1) switch (_context.prev = _context.next) {
                     case 0:
                       metadataTraceContext = {
-                        traceId: (0, _mediaCommon.getRandomHex)(8),
-                        spanId: (0, _mediaCommon.getRandomHex)(8)
+                        traceId: (0, _mediaCommon.getRandomTelemetryId)(),
+                        spanId: (0, _mediaCommon.getRandomTelemetryId)()
                       };
                       files = keysByToken[batchKey].map(function (key) {
                         return {

package/dist/cjs/utils/createFileDataLoader.js

@@ -101,8 +101,8 @@ function createBatchLoadingFunc(mediaStore) {
                   while (1) switch (_context.prev = _context.next) {
                     case 0:
                       metadataTraceContext = {
-                        traceId: (0, _mediaCommon.getRandomHex)(8),
-                        spanId: (0, _mediaCommon.getRandomHex)(8)
+                        traceId: (0, _mediaCommon.getRandomTelemetryId)(),
+                        spanId: (0, _mediaCommon.getRandomTelemetryId)()
                       };
                       fileIds = fileIdsByCollection[collectionNameKey];
                       includeHashForDuplicateFiles = includeHashByCollection[collectionNameKey];

package/dist/cjs/utils/request/helpers.js

@@ -56,7 +56,7 @@ function isRateLimitedError(error) {
 }
 var extendTraceContext = exports.extendTraceContext = function extendTraceContext(traceContext) {
   return traceContext ? _objectSpread(_objectSpread({}, traceContext), {}, {
-    spanId: (traceContext === null || traceContext === void 0 ? void 0 : traceContext.spanId) || (0, _mediaCommon.getRandomHex)(8)
+    spanId: (traceContext === null || traceContext === void 0 ? void 0 : traceContext.spanId) || (0, _mediaCommon.getRandomTelemetryId)()
   }) : undefined;
 };
 var ZipkinHeaderKeys = exports.ZipkinHeaderKeys = {

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

@@ -395,9 +395,10 @@ export class MediaStore {
     return this.request(`/file/${id}/image/metadata`, options).then(createMapResponseToJson(metadata));
   }
   async getDocumentContent(id, options) {
+    const endpoint = cdnFeatureFlag('contents');
     const metadata = {
       method: 'GET',
-      endpoint: '/file/{fileId}/document/contents'
+      endpoint: `/file/{fileId}/document/${endpoint}`
     };
     const requestOptions = {
       ...metadata,
@@ -405,14 +406,16 @@ export class MediaStore {
         collectionName: options.collectionName
       },
       params: {
+        collection: options.collectionName,
         pageStart: options.pageStart,
         pageEnd: options.pageEnd,
         'max-age': FILE_CACHE_MAX_AGE
       }
     };
-    return this.request(`/file/${id}/document/contents`, requestOptions).then(createMapResponseToJson(metadata));
+    return this.request(`/file/${id}/document/${endpoint}`, requestOptions).then(createMapResponseToJson(metadata));
   }
   async getDocumentPageImage(id, options) {
+    // Temporarily disabling CDN for document due to bug of CDN not forwarding query params
     const endpoint = cdnFeatureFlag('page');
     const metadata = {
       method: 'GET',
@@ -424,6 +427,7 @@ export class MediaStore {
         collectionName: options.collectionName
       },
       params: {
+        collection: options.collectionName,
         page: options.page,
         zoom: options.zoom,
         'max-age': FILE_CACHE_MAX_AGE

package/dist/es2019/utils/createCopyIntentRegisterationBatcher.js

@@ -1,5 +1,5 @@
 import Dataloader from 'dataloader';
-import { getRandomHex } from '@atlaskit/media-common';
+import { getRandomTelemetryId } from '@atlaskit/media-common';
 export const MAX_BATCH_SIZE = 100;
 /**
  * Returns a function that, given Array<DataloaderKey>, resolves to an array of same length containing either DataloaderResult or Error.
@@ -29,8 +29,8 @@ function createBatchCopyIntentRegisterationFunc(mediaStore) {
     const items = [];
     await Promise.all(Object.keys(keysByToken).map(async batchKey => {
       const metadataTraceContext = {
-        traceId: getRandomHex(8),
-        spanId: getRandomHex(8)
+        traceId: getRandomTelemetryId(),
+        spanId: getRandomTelemetryId()
       };
       const files = keysByToken[batchKey].map(key => ({
         id: key.id,

package/dist/es2019/utils/createFileDataLoader.js

@@ -1,5 +1,5 @@
 import Dataloader from 'dataloader';
-import { getRandomHex } from '@atlaskit/media-common';
+import { getRandomTelemetryId } from '@atlaskit/media-common';
 export const MAX_BATCH_SIZE = 100;
 const isBatchLoadingErrorResult = result => {
   return result.error instanceof Error;
@@ -77,8 +77,8 @@ export function createBatchLoadingFunc(mediaStore) {
     const items = [];
     await Promise.all(Object.keys(fileIdsByCollection).map(async collectionNameKey => {
       const metadataTraceContext = {
-        traceId: getRandomHex(8),
-        spanId: getRandomHex(8)
+        traceId: getRandomTelemetryId(),
+        spanId: getRandomTelemetryId()
       };
       const fileIds = fileIdsByCollection[collectionNameKey];
       const includeHashForDuplicateFiles = includeHashByCollection[collectionNameKey];

package/dist/es2019/utils/request/helpers.js

@@ -1,5 +1,5 @@
 import { isClientBasedAuth } from '@atlaskit/media-core';
-import { getRandomHex } from '@atlaskit/media-common';
+import { getRandomTelemetryId } from '@atlaskit/media-common';
 import { mapAuthToQueryParameters } from '../../models/auth-query-parameters';
 import { RequestError, isRequestError } from './errors';
 const getStatusCode = error => {
@@ -23,7 +23,7 @@ export function isRateLimitedError(error) {
 }
 export const extendTraceContext = traceContext => traceContext ? {
   ...traceContext,
-  spanId: (traceContext === null || traceContext === void 0 ? void 0 : traceContext.spanId) || getRandomHex(8)
+  spanId: (traceContext === null || traceContext === void 0 ? void 0 : traceContext.spanId) || getRandomTelemetryId()
 } : undefined;
 export const ZipkinHeaderKeys = {
   traceId: 'x-b3-traceid',

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

@@ -659,26 +659,28 @@ export var MediaStore = /*#__PURE__*/function () {
     key: "getDocumentContent",
     value: function () {
       var _getDocumentContent = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee12(id, options) {
-        var metadata, requestOptions;
+        var endpoint, metadata, requestOptions;
         return _regeneratorRuntime.wrap(function _callee12$(_context12) {
           while (1) switch (_context12.prev = _context12.next) {
             case 0:
+              endpoint = cdnFeatureFlag('contents');
               metadata = {
                 method: 'GET',
-                endpoint: '/file/{fileId}/document/contents'
+                endpoint: "/file/{fileId}/document/".concat(endpoint)
               };
               requestOptions = _objectSpread(_objectSpread({}, metadata), {}, {
                 authContext: {
                   collectionName: options.collectionName
                 },
                 params: {
+                  collection: options.collectionName,
                   pageStart: options.pageStart,
                   pageEnd: options.pageEnd,
                   'max-age': FILE_CACHE_MAX_AGE
                 }
               });
-              return _context12.abrupt("return", this.request("/file/".concat(id, "/document/contents"), requestOptions).then(createMapResponseToJson(metadata)));
-            case 3:
+              return _context12.abrupt("return", this.request("/file/".concat(id, "/document/").concat(endpoint), requestOptions).then(createMapResponseToJson(metadata)));
+            case 4:
             case "end":
               return _context12.stop();
           }
@@ -697,6 +699,7 @@ export var MediaStore = /*#__PURE__*/function () {
         return _regeneratorRuntime.wrap(function _callee13$(_context13) {
           while (1) switch (_context13.prev = _context13.next) {
             case 0:
+              // Temporarily disabling CDN for document due to bug of CDN not forwarding query params
               endpoint = cdnFeatureFlag('page');
               metadata = {
                 method: 'GET',
@@ -707,6 +710,7 @@ export var MediaStore = /*#__PURE__*/function () {
                   collectionName: options.collectionName
                 },
                 params: {
+                  collection: options.collectionName,
                   page: options.page,
                   zoom: options.zoom,
                   'max-age': FILE_CACHE_MAX_AGE

package/dist/esm/utils/createCopyIntentRegisterationBatcher.js

@@ -1,7 +1,7 @@
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
 import Dataloader from 'dataloader';
-import { getRandomHex } from '@atlaskit/media-common';
+import { getRandomTelemetryId } from '@atlaskit/media-common';
 export var MAX_BATCH_SIZE = 100;
 /**
  * Returns a function that, given Array<DataloaderKey>, resolves to an array of same length containing either DataloaderResult or Error.
@@ -43,8 +43,8 @@ function createBatchCopyIntentRegisterationFunc(mediaStore) {
                   while (1) switch (_context.prev = _context.next) {
                     case 0:
                       metadataTraceContext = {
-                        traceId: getRandomHex(8),
-                        spanId: getRandomHex(8)
+                        traceId: getRandomTelemetryId(),
+                        spanId: getRandomTelemetryId()
                       };
                       files = keysByToken[batchKey].map(function (key) {
                         return {

package/dist/esm/utils/createFileDataLoader.js

@@ -5,7 +5,7 @@ import _regeneratorRuntime from "@babel/runtime/regenerator";
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 import Dataloader from 'dataloader';
-import { getRandomHex } from '@atlaskit/media-common';
+import { getRandomTelemetryId } from '@atlaskit/media-common';
 export var MAX_BATCH_SIZE = 100;
 var isBatchLoadingErrorResult = function isBatchLoadingErrorResult(result) {
   return result.error instanceof Error;
@@ -91,8 +91,8 @@ export function createBatchLoadingFunc(mediaStore) {
                   while (1) switch (_context.prev = _context.next) {
                     case 0:
                       metadataTraceContext = {
-                        traceId: getRandomHex(8),
-                        spanId: getRandomHex(8)
+                        traceId: getRandomTelemetryId(),
+                        spanId: getRandomTelemetryId()
                       };
                       fileIds = fileIdsByCollection[collectionNameKey];
                       includeHashForDuplicateFiles = includeHashByCollection[collectionNameKey];

package/dist/esm/utils/request/helpers.js

@@ -6,7 +6,7 @@ import _regeneratorRuntime from "@babel/runtime/regenerator";
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 import { isClientBasedAuth } from '@atlaskit/media-core';
-import { getRandomHex } from '@atlaskit/media-common';
+import { getRandomTelemetryId } from '@atlaskit/media-common';
 import { mapAuthToQueryParameters } from '../../models/auth-query-parameters';
 import { RequestError, isRequestError } from './errors';
 var getStatusCode = function getStatusCode(error) {
@@ -32,7 +32,7 @@ export function isRateLimitedError(error) {
 }
 export var extendTraceContext = function extendTraceContext(traceContext) {
   return traceContext ? _objectSpread(_objectSpread({}, traceContext), {}, {
-    spanId: (traceContext === null || traceContext === void 0 ? void 0 : traceContext.spanId) || getRandomHex(8)
+    spanId: (traceContext === null || traceContext === void 0 ? void 0 : traceContext.spanId) || getRandomTelemetryId()
   }) : undefined;
 };
 export var ZipkinHeaderKeys = {

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

@@ -4,7 +4,7 @@ import { type MediaFileArtifacts } from '@atlaskit/media-state';
 import type { ItemsPayload, ImageMetadata, MediaStoreResponse, MediaStoreTouchFileParams, TouchFileDescriptor, MediaStoreTouchFileBody, RejectedTouchFile, MediaStoreRequestOptions, MediaStoreCreateFileFromUploadParams, MediaStoreCreateFileFromUploadBody, MediaStoreGetFileParams, MediaStoreGetFileImageParams, MediaStoreCopyFileWithTokenBody, MediaStoreCopyFileWithTokenParams, AppendChunksToUploadRequestBody, TouchedFiles, MediaApi, CopyFileParams } from './types';
 import { type MediaFile, type MediaUpload } from '../../models/media';
 import { ChunkHashAlgorithm } from '@atlaskit/media-core';
-import { GetDocumentPageImage, type DocumentPageRangeContent, type GetDocumentContentOptions } from '../../models/document';
+import { type GetDocumentPageImage, type DocumentPageRangeContent, type GetDocumentContentOptions } from '../../models/document';
 export declare class MediaStore implements MediaApi {
     private readonly config;
     private readonly _chunkHashAlgorithm;

package/dist/types/models/document.d.ts

@@ -27,11 +27,48 @@ export type Line = {
     r: number;
     spans: readonly Span[];
 };
+export type DocumentAnnotations = {
+    text_form_fields: readonly TextField[];
+    combobox_form_fields: readonly ComboBoxField[];
+};
+export type TextField = {
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+    f: number;
+    text: string;
+};
+export type ComboBoxField = {
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+    f: number;
+    text: string;
+};
+export type DocumentLink = {
+    type: 'uri';
+    dest: string;
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+} | {
+    type: 'local';
+    p_num: number;
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+};
 export type DocumentPageContent = {
     rotation: number;
     width: number;
     height: number;
     lines: readonly Line[];
+    annotations: DocumentAnnotations;
+    links: readonly DocumentLink[];
 };
 export type DocumentPageRangeContent = {
     total_pages: number;

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

@@ -4,7 +4,7 @@ import { type MediaFileArtifacts } from '@atlaskit/media-state';
 import type { ItemsPayload, ImageMetadata, MediaStoreResponse, MediaStoreTouchFileParams, TouchFileDescriptor, MediaStoreTouchFileBody, RejectedTouchFile, MediaStoreRequestOptions, MediaStoreCreateFileFromUploadParams, MediaStoreCreateFileFromUploadBody, MediaStoreGetFileParams, MediaStoreGetFileImageParams, MediaStoreCopyFileWithTokenBody, MediaStoreCopyFileWithTokenParams, AppendChunksToUploadRequestBody, TouchedFiles, MediaApi, CopyFileParams } from './types';
 import { type MediaFile, type MediaUpload } from '../../models/media';
 import { ChunkHashAlgorithm } from '@atlaskit/media-core';
-import { GetDocumentPageImage, type DocumentPageRangeContent, type GetDocumentContentOptions } from '../../models/document';
+import { type GetDocumentPageImage, type DocumentPageRangeContent, type GetDocumentContentOptions } from '../../models/document';
 export declare class MediaStore implements MediaApi {
     private readonly config;
     private readonly _chunkHashAlgorithm;

package/dist/types-ts4.5/models/document.d.ts

@@ -27,11 +27,48 @@ export type Line = {
     r: number;
     spans: readonly Span[];
 };
+export type DocumentAnnotations = {
+    text_form_fields: readonly TextField[];
+    combobox_form_fields: readonly ComboBoxField[];
+};
+export type TextField = {
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+    f: number;
+    text: string;
+};
+export type ComboBoxField = {
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+    f: number;
+    text: string;
+};
+export type DocumentLink = {
+    type: 'uri';
+    dest: string;
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+} | {
+    type: 'local';
+    p_num: number;
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+};
 export type DocumentPageContent = {
     rotation: number;
     width: number;
     height: number;
     lines: readonly Line[];
+    annotations: DocumentAnnotations;
+    links: readonly DocumentLink[];
 };
 export type DocumentPageRangeContent = {
     total_pages: number;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/media-client",
-	"version": "33.4.0",
+	"version": "33.5.0",
 	"description": "Media API Web Client Library",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -35,7 +35,7 @@
 	},
 	"dependencies": {
 		"@atlaskit/chunkinator": "^7.0.0",
-		"@atlaskit/media-common": "^12.1.0",
+		"@atlaskit/media-common": "^12.2.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@babel/runtime": "^7.0.0",
 		"dataloader": "^2.1.0",
@@ -57,7 +57,7 @@
 		"@atlaskit/media-core": "^36.1.0",
 		"@atlaskit/media-state": "^1.6.0",
 		"@atlaskit/ssr": "workspace:^",
-		"@atlaskit/tokens": "^5.1.0",
+		"@atlaskit/tokens": "^5.2.0",
 		"@atlassian/feature-flags-test-utils": "^0.3.0",
 		"@emotion/react": "^11.7.1",
 		"@types/deep-equal": "^1.0.1",