@atlaskit/media-client 33.4.1 → 33.5.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @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

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/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/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/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/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.1",
+	"version": "33.5.0",
 	"description": "Media API Web Client Library",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"