@atlaskit/media-client 34.1.0 → 34.2.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/media-client
 
+## 34.2.0
+
+### Minor Changes
+
+- [#177492](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/177492)
+  [`77d01c4bd4ead`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/77d01c4bd4ead) -
+  Added password option and traceContext for getting Media Document Contents and Page
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 34.1.0
 
 ### Minor Changes

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

@@ -665,35 +665,44 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
   }, {
     key: "getDocumentContent",
     value: function () {
-      var _getDocumentContent = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee12(id, options) {
-        var endpoint, metadata, requestOptions;
+      var _getDocumentContent = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee12(id, options, traceContext) {
+        var shouldCache, endpoint, metadata, headers, requestOptions;
         return _regenerator.default.wrap(function _callee12$(_context12) {
           while (1) switch (_context12.prev = _context12.next) {
             case 0:
-              endpoint = cdnFeatureFlag('contents');
+              // when requesting for password protected document don't use CDN as it won't forward headers
+              // this is deliberate to avoid caching Password protected files
+              // Note: this should be removed once endpoint implements server side Cache-Control headers
+              shouldCache = !options.password;
+              endpoint = shouldCache ? cdnFeatureFlag('contents') : 'contents';
               metadata = {
                 method: 'GET',
                 endpoint: "/file/{fileId}/document/".concat(endpoint)
               };
+              headers = options.password ? {
+                'x-document-authorization': "Basic ".concat(options.password)
+              } : {};
               requestOptions = _objectSpread(_objectSpread({}, metadata), {}, {
                 authContext: {
                   collectionName: options.collectionName
                 },
+                headers: headers,
                 params: {
                   collection: options.collectionName,
                   pageStart: options.pageStart,
                   pageEnd: options.pageEnd,
-                  'max-age': _constants.FILE_CACHE_MAX_AGE
-                }
+                  'max-age': shouldCache ? _constants.FILE_CACHE_MAX_AGE : 0
+                },
+                traceContext: traceContext
               });
               return _context12.abrupt("return", this.request("/file/".concat(id, "/document/").concat(endpoint), requestOptions).then((0, _helpers.createMapResponseToJson)(metadata)));
-            case 4:
+            case 6:
             case "end":
               return _context12.stop();
           }
         }, _callee12, this);
       }));
-      function getDocumentContent(_x44, _x45) {
+      function getDocumentContent(_x44, _x45, _x46) {
         return _getDocumentContent.apply(this, arguments);
       }
       return getDocumentContent;
@@ -701,36 +710,44 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
   }, {
     key: "getDocumentPageImage",
     value: function () {
-      var _getDocumentPageImage = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee13(id, options) {
-        var endpoint, metadata, requestOptions;
+      var _getDocumentPageImage = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee13(id, options, traceContext) {
+        var shouldCache, endpoint, metadata, headers, requestOptions;
         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');
+              // when requesting for password protected document don't use CDN as it won't forward headers
+              // this is deliberate to avoid caching Password protected files
+              // Note: this should be removed once endpoint implements server side Cache-Control headers
+              shouldCache = !options.password;
+              endpoint = shouldCache ? cdnFeatureFlag('page') : 'page';
               metadata = {
                 method: 'GET',
                 endpoint: "/file/{fileId}/document/".concat(endpoint)
               };
+              headers = options.password ? {
+                'x-document-authorization': "Basic ".concat(options.password)
+              } : {};
               requestOptions = _objectSpread(_objectSpread({}, metadata), {}, {
                 authContext: {
                   collectionName: options.collectionName
                 },
+                headers: headers,
                 params: {
                   collection: options.collectionName,
                   page: options.page,
                   zoom: options.zoom,
-                  'max-age': _constants.FILE_CACHE_MAX_AGE
-                }
+                  'max-age': shouldCache ? _constants.FILE_CACHE_MAX_AGE : 0
+                },
+                traceContext: traceContext
               });
               return _context13.abrupt("return", this.request("/file/".concat(id, "/document/").concat(endpoint), requestOptions).then((0, _helpers.createMapResponseToBlob)(metadata)));
-            case 4:
+            case 6:
             case "end":
               return _context13.stop();
           }
         }, _callee13, this);
       }));
-      function getDocumentPageImage(_x46, _x47) {
+      function getDocumentPageImage(_x47, _x48, _x49) {
         return _getDocumentPageImage.apply(this, arguments);
       }
       return getDocumentPageImage;
@@ -763,7 +780,7 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
           }
         }, _callee14, this);
       }));
-      function appendChunksToUpload(_x48, _x49, _x50, _x51) {
+      function appendChunksToUpload(_x50, _x51, _x52, _x53) {
         return _appendChunksToUpload.apply(this, arguments);
       }
       return appendChunksToUpload;
@@ -845,7 +862,7 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
           }
         }, _callee15, this);
       }));
-      function registerCopyIntents(_x52, _x53, _x54) {
+      function registerCopyIntents(_x54, _x55, _x56) {
         return _registerCopyIntents.apply(this, arguments);
       }
       return registerCopyIntents;
@@ -930,7 +947,7 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
           }
         }, _callee16, this);
       }));
-      function request(_x55) {
+      function request(_x57) {
         return _request2.apply(this, arguments);
       }
       return request;
@@ -963,7 +980,7 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
           }
         }, _callee17);
       }));
-      function testUrl(_x56) {
+      function testUrl(_x58) {
         return _testUrl.apply(this, arguments);
       }
       return testUrl;

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

@@ -291,6 +291,10 @@ function createRequestErrorReason(statusCode) {
       return 'serverForbidden';
     case 404:
       return 'serverNotFound';
+    case 422:
+      return 'serverUnprocessableEntity';
+    case 423:
+      return 'serverEntityLocked';
     case 429:
       return 'serverRateLimited';
     case 500:

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

@@ -395,44 +395,61 @@ export class MediaStore {
     };
     return this.request(`/file/${id}/image/metadata`, options).then(createMapResponseToJson(metadata));
   }
-  async getDocumentContent(id, options) {
-    const endpoint = cdnFeatureFlag('contents');
+  async getDocumentContent(id, options, traceContext) {
+    // when requesting for password protected document don't use CDN as it won't forward headers
+    // this is deliberate to avoid caching Password protected files
+    // Note: this should be removed once endpoint implements server side Cache-Control headers
+    const shouldCache = !options.password;
+    const endpoint = shouldCache ? cdnFeatureFlag('contents') : 'contents';
     const metadata = {
       method: 'GET',
       endpoint: `/file/{fileId}/document/${endpoint}`
     };
+    const headers = options.password ? {
+      'x-document-authorization': `Basic ${options.password}`
+    } : {};
     const requestOptions = {
       ...metadata,
       authContext: {
         collectionName: options.collectionName
       },
+      headers,
       params: {
         collection: options.collectionName,
         pageStart: options.pageStart,
         pageEnd: options.pageEnd,
-        'max-age': FILE_CACHE_MAX_AGE
-      }
+        'max-age': shouldCache ? FILE_CACHE_MAX_AGE : 0
+      },
+      traceContext
     };
     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');
+  async getDocumentPageImage(id, options, traceContext) {
+    // when requesting for password protected document don't use CDN as it won't forward headers
+    // this is deliberate to avoid caching Password protected files
+    // Note: this should be removed once endpoint implements server side Cache-Control headers
+    const shouldCache = !options.password;
+    const endpoint = shouldCache ? cdnFeatureFlag('page') : 'page';
     const metadata = {
       method: 'GET',
       endpoint: `/file/{fileId}/document/${endpoint}`
     };
+    const headers = options.password ? {
+      'x-document-authorization': `Basic ${options.password}`
+    } : {};
     const requestOptions = {
       ...metadata,
       authContext: {
         collectionName: options.collectionName
       },
+      headers,
       params: {
         collection: options.collectionName,
         page: options.page,
         zoom: options.zoom,
-        'max-age': FILE_CACHE_MAX_AGE
-      }
+        'max-age': shouldCache ? FILE_CACHE_MAX_AGE : 0
+      },
+      traceContext
     };
     return this.request(`/file/${id}/document/${endpoint}`, requestOptions).then(createMapResponseToBlob(metadata));
   }

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

@@ -184,6 +184,10 @@ export function createRequestErrorReason(statusCode) {
       return 'serverForbidden';
     case 404:
       return 'serverNotFound';
+    case 422:
+      return 'serverUnprocessableEntity';
+    case 423:
+      return 'serverEntityLocked';
     case 429:
       return 'serverRateLimited';
     case 500:

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

@@ -659,35 +659,44 @@ export var MediaStore = /*#__PURE__*/function () {
   }, {
     key: "getDocumentContent",
     value: function () {
-      var _getDocumentContent = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee12(id, options) {
-        var endpoint, metadata, requestOptions;
+      var _getDocumentContent = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee12(id, options, traceContext) {
+        var shouldCache, endpoint, metadata, headers, requestOptions;
         return _regeneratorRuntime.wrap(function _callee12$(_context12) {
           while (1) switch (_context12.prev = _context12.next) {
             case 0:
-              endpoint = cdnFeatureFlag('contents');
+              // when requesting for password protected document don't use CDN as it won't forward headers
+              // this is deliberate to avoid caching Password protected files
+              // Note: this should be removed once endpoint implements server side Cache-Control headers
+              shouldCache = !options.password;
+              endpoint = shouldCache ? cdnFeatureFlag('contents') : 'contents';
               metadata = {
                 method: 'GET',
                 endpoint: "/file/{fileId}/document/".concat(endpoint)
               };
+              headers = options.password ? {
+                'x-document-authorization': "Basic ".concat(options.password)
+              } : {};
               requestOptions = _objectSpread(_objectSpread({}, metadata), {}, {
                 authContext: {
                   collectionName: options.collectionName
                 },
+                headers: headers,
                 params: {
                   collection: options.collectionName,
                   pageStart: options.pageStart,
                   pageEnd: options.pageEnd,
-                  'max-age': FILE_CACHE_MAX_AGE
-                }
+                  'max-age': shouldCache ? FILE_CACHE_MAX_AGE : 0
+                },
+                traceContext: traceContext
               });
               return _context12.abrupt("return", this.request("/file/".concat(id, "/document/").concat(endpoint), requestOptions).then(createMapResponseToJson(metadata)));
-            case 4:
+            case 6:
             case "end":
               return _context12.stop();
           }
         }, _callee12, this);
       }));
-      function getDocumentContent(_x44, _x45) {
+      function getDocumentContent(_x44, _x45, _x46) {
         return _getDocumentContent.apply(this, arguments);
       }
       return getDocumentContent;
@@ -695,36 +704,44 @@ export var MediaStore = /*#__PURE__*/function () {
   }, {
     key: "getDocumentPageImage",
     value: function () {
-      var _getDocumentPageImage = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee13(id, options) {
-        var endpoint, metadata, requestOptions;
+      var _getDocumentPageImage = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee13(id, options, traceContext) {
+        var shouldCache, endpoint, metadata, headers, requestOptions;
         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');
+              // when requesting for password protected document don't use CDN as it won't forward headers
+              // this is deliberate to avoid caching Password protected files
+              // Note: this should be removed once endpoint implements server side Cache-Control headers
+              shouldCache = !options.password;
+              endpoint = shouldCache ? cdnFeatureFlag('page') : 'page';
               metadata = {
                 method: 'GET',
                 endpoint: "/file/{fileId}/document/".concat(endpoint)
               };
+              headers = options.password ? {
+                'x-document-authorization': "Basic ".concat(options.password)
+              } : {};
               requestOptions = _objectSpread(_objectSpread({}, metadata), {}, {
                 authContext: {
                   collectionName: options.collectionName
                 },
+                headers: headers,
                 params: {
                   collection: options.collectionName,
                   page: options.page,
                   zoom: options.zoom,
-                  'max-age': FILE_CACHE_MAX_AGE
-                }
+                  'max-age': shouldCache ? FILE_CACHE_MAX_AGE : 0
+                },
+                traceContext: traceContext
               });
               return _context13.abrupt("return", this.request("/file/".concat(id, "/document/").concat(endpoint), requestOptions).then(createMapResponseToBlob(metadata)));
-            case 4:
+            case 6:
             case "end":
               return _context13.stop();
           }
         }, _callee13, this);
       }));
-      function getDocumentPageImage(_x46, _x47) {
+      function getDocumentPageImage(_x47, _x48, _x49) {
         return _getDocumentPageImage.apply(this, arguments);
       }
       return getDocumentPageImage;
@@ -757,7 +774,7 @@ export var MediaStore = /*#__PURE__*/function () {
           }
         }, _callee14, this);
       }));
-      function appendChunksToUpload(_x48, _x49, _x50, _x51) {
+      function appendChunksToUpload(_x50, _x51, _x52, _x53) {
         return _appendChunksToUpload.apply(this, arguments);
       }
       return appendChunksToUpload;
@@ -839,7 +856,7 @@ export var MediaStore = /*#__PURE__*/function () {
           }
         }, _callee15, this);
       }));
-      function registerCopyIntents(_x52, _x53, _x54) {
+      function registerCopyIntents(_x54, _x55, _x56) {
         return _registerCopyIntents.apply(this, arguments);
       }
       return registerCopyIntents;
@@ -924,7 +941,7 @@ export var MediaStore = /*#__PURE__*/function () {
           }
         }, _callee16, this);
       }));
-      function request(_x55) {
+      function request(_x57) {
         return _request2.apply(this, arguments);
       }
       return request;
@@ -957,7 +974,7 @@ export var MediaStore = /*#__PURE__*/function () {
           }
         }, _callee17);
       }));
-      function testUrl(_x56) {
+      function testUrl(_x58) {
         return _testUrl.apply(this, arguments);
       }
       return testUrl;

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

@@ -267,6 +267,10 @@ export function createRequestErrorReason(statusCode) {
       return 'serverForbidden';
     case 404:
       return 'serverNotFound';
+    case 422:
+      return 'serverUnprocessableEntity';
+    case 423:
+      return 'serverEntityLocked';
     case 429:
       return 'serverRateLimited';
     case 500:

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

@@ -30,8 +30,8 @@ export declare class MediaStore implements MediaApi {
     getImageMetadata(id: string, params?: MediaStoreGetFileImageParams, traceContext?: MediaTraceContext): Promise<{
         metadata: ImageMetadata;
     }>;
-    getDocumentContent(id: string, options: GetDocumentContentOptions): Promise<DocumentPageRangeContent>;
-    getDocumentPageImage(id: string, options: GetDocumentPageImage): Promise<Blob>;
+    getDocumentContent(id: string, options: GetDocumentContentOptions, traceContext?: MediaTraceContext): Promise<DocumentPageRangeContent>;
+    getDocumentPageImage(id: string, options: GetDocumentPageImage, traceContext?: MediaTraceContext): Promise<Blob>;
     appendChunksToUpload(uploadId: string, body: AppendChunksToUploadRequestBody, collectionName?: string, traceContext?: MediaTraceContext): Promise<void>;
     copyFileWithToken(body: MediaStoreCopyFileWithTokenBody, params: MediaStoreCopyFileWithTokenParams, traceContext?: MediaTraceContext): Promise<MediaStoreResponse<MediaFile>>;
     copyFile(id: string, params: CopyFileParams, traceContext?: MediaTraceContext): Promise<MediaStoreResponse<MediaFile>>;

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

@@ -202,7 +202,7 @@ export interface MediaApi {
     resolveAuth: (authContext?: AuthContext) => Promise<Auth>;
     resolveInitialAuth: () => Auth;
     /** @exprimental This is exprimental for the purposes of enabling the document viewer and not ready for external use, it is prone to breaking changes */
-    getDocumentContent(id: string, options: GetDocumentContentOptions): Promise<DocumentPageRangeContent>;
+    getDocumentContent(id: string, options: GetDocumentContentOptions, traceContext?: MediaTraceContext): Promise<DocumentPageRangeContent>;
     /** @exprimental This is exprimental for the purposes of enabling the document viewer and not ready for external use, it is prone to breaking changes */
-    getDocumentPageImage(id: string, options: GetDocumentPageImage): Promise<Blob>;
+    getDocumentPageImage(id: string, options: GetDocumentPageImage, traceContext?: MediaTraceContext): Promise<Blob>;
 }

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

@@ -69,6 +69,7 @@ export type DocumentPageContent = {
     lines: readonly Line[];
     annotations: DocumentAnnotations;
     links: readonly DocumentLink[];
+    password?: string;
 };
 export type DocumentPageRangeContent = {
     total_pages: number;
@@ -82,10 +83,12 @@ export type GetDocumentContentOptions = {
     pageEnd: number;
     collectionName?: string;
     maxAge?: number;
+    password?: string;
 };
 export type GetDocumentPageImage = {
     page: number;
     zoom: number;
     collectionName?: string;
     maxAge?: number;
+    password?: string;
 };

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

@@ -2,7 +2,7 @@ import { type MediaTraceContext } from '@atlaskit/media-common';
 export interface SerializableObject {
     [key: string]: string | number | boolean | null | undefined | SerializableObject;
 }
-export type MediaClientErrorReason = 'clientOffline' | 'clientAbortedRequest' | 'clientTimeoutRequest' | 'serverInvalidBody' | 'serverBadRequest' | 'serverUnauthorized' | 'serverForbidden' | 'serverNotFound' | 'serverRateLimited' | 'serverInternalError' | 'serverBadGateway' | 'serverUnexpectedError' | 'failedAuthProvider' | 'tokenExpired' | 'missingInitialAuth' | 'emptyAuth' | 'authProviderTimedOut' | 'invalidFileId' | 'emptyItems' | 'zeroVersionFile' | 'emptyFileName' | 'pollingMaxAttemptsExceeded' | 'fileSizeExceedsLimit' | 'deprecatedEndpoint';
+export type MediaClientErrorReason = 'clientOffline' | 'clientAbortedRequest' | 'clientTimeoutRequest' | 'serverInvalidBody' | 'serverBadRequest' | 'serverUnauthorized' | 'serverForbidden' | 'serverNotFound' | 'serverRateLimited' | 'serverInternalError' | 'serverBadGateway' | 'serverUnexpectedError' | 'serverUnprocessableEntity' | 'serverEntityLocked' | 'failedAuthProvider' | 'tokenExpired' | 'missingInitialAuth' | 'emptyAuth' | 'authProviderTimedOut' | 'invalidFileId' | 'emptyItems' | 'zeroVersionFile' | 'emptyFileName' | 'pollingMaxAttemptsExceeded' | 'fileSizeExceedsLimit' | 'deprecatedEndpoint';
 export type MediaClientErrorMetadata = SerializableObject & {
     traceContext?: MediaTraceContext;
 };

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

@@ -36,7 +36,7 @@ export type CreateUrlOptions = {
     readonly params?: RequestParams;
     readonly auth?: Auth;
 };
-export type RequestErrorReason = 'clientOffline' | 'clientAbortedRequest' | 'clientTimeoutRequest' | 'serverInvalidBody' | 'serverBadRequest' | 'serverUnauthorized' | 'serverForbidden' | 'serverNotFound' | 'serverRateLimited' | 'serverInternalError' | 'serverBadGateway' | 'serverUnexpectedError';
+export type RequestErrorReason = 'clientOffline' | 'clientAbortedRequest' | 'clientTimeoutRequest' | 'serverInvalidBody' | 'serverBadRequest' | 'serverUnauthorized' | 'serverForbidden' | 'serverNotFound' | 'serverRateLimited' | 'serverInternalError' | 'serverBadGateway' | 'serverUnprocessableEntity' | 'serverEntityLocked' | 'serverUnexpectedError';
 export type RequestErrorMetadata = RequestMetadata & {
     readonly attempts?: number;
     readonly clientExhaustedRetries?: boolean;

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

@@ -30,8 +30,8 @@ export declare class MediaStore implements MediaApi {
     getImageMetadata(id: string, params?: MediaStoreGetFileImageParams, traceContext?: MediaTraceContext): Promise<{
         metadata: ImageMetadata;
     }>;
-    getDocumentContent(id: string, options: GetDocumentContentOptions): Promise<DocumentPageRangeContent>;
-    getDocumentPageImage(id: string, options: GetDocumentPageImage): Promise<Blob>;
+    getDocumentContent(id: string, options: GetDocumentContentOptions, traceContext?: MediaTraceContext): Promise<DocumentPageRangeContent>;
+    getDocumentPageImage(id: string, options: GetDocumentPageImage, traceContext?: MediaTraceContext): Promise<Blob>;
     appendChunksToUpload(uploadId: string, body: AppendChunksToUploadRequestBody, collectionName?: string, traceContext?: MediaTraceContext): Promise<void>;
     copyFileWithToken(body: MediaStoreCopyFileWithTokenBody, params: MediaStoreCopyFileWithTokenParams, traceContext?: MediaTraceContext): Promise<MediaStoreResponse<MediaFile>>;
     copyFile(id: string, params: CopyFileParams, traceContext?: MediaTraceContext): Promise<MediaStoreResponse<MediaFile>>;

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

@@ -202,7 +202,7 @@ export interface MediaApi {
     resolveAuth: (authContext?: AuthContext) => Promise<Auth>;
     resolveInitialAuth: () => Auth;
     /** @exprimental This is exprimental for the purposes of enabling the document viewer and not ready for external use, it is prone to breaking changes */
-    getDocumentContent(id: string, options: GetDocumentContentOptions): Promise<DocumentPageRangeContent>;
+    getDocumentContent(id: string, options: GetDocumentContentOptions, traceContext?: MediaTraceContext): Promise<DocumentPageRangeContent>;
     /** @exprimental This is exprimental for the purposes of enabling the document viewer and not ready for external use, it is prone to breaking changes */
-    getDocumentPageImage(id: string, options: GetDocumentPageImage): Promise<Blob>;
+    getDocumentPageImage(id: string, options: GetDocumentPageImage, traceContext?: MediaTraceContext): Promise<Blob>;
 }

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

@@ -69,6 +69,7 @@ export type DocumentPageContent = {
     lines: readonly Line[];
     annotations: DocumentAnnotations;
     links: readonly DocumentLink[];
+    password?: string;
 };
 export type DocumentPageRangeContent = {
     total_pages: number;
@@ -82,10 +83,12 @@ export type GetDocumentContentOptions = {
     pageEnd: number;
     collectionName?: string;
     maxAge?: number;
+    password?: string;
 };
 export type GetDocumentPageImage = {
     page: number;
     zoom: number;
     collectionName?: string;
     maxAge?: number;
+    password?: string;
 };

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

@@ -2,7 +2,7 @@ import { type MediaTraceContext } from '@atlaskit/media-common';
 export interface SerializableObject {
     [key: string]: string | number | boolean | null | undefined | SerializableObject;
 }
-export type MediaClientErrorReason = 'clientOffline' | 'clientAbortedRequest' | 'clientTimeoutRequest' | 'serverInvalidBody' | 'serverBadRequest' | 'serverUnauthorized' | 'serverForbidden' | 'serverNotFound' | 'serverRateLimited' | 'serverInternalError' | 'serverBadGateway' | 'serverUnexpectedError' | 'failedAuthProvider' | 'tokenExpired' | 'missingInitialAuth' | 'emptyAuth' | 'authProviderTimedOut' | 'invalidFileId' | 'emptyItems' | 'zeroVersionFile' | 'emptyFileName' | 'pollingMaxAttemptsExceeded' | 'fileSizeExceedsLimit' | 'deprecatedEndpoint';
+export type MediaClientErrorReason = 'clientOffline' | 'clientAbortedRequest' | 'clientTimeoutRequest' | 'serverInvalidBody' | 'serverBadRequest' | 'serverUnauthorized' | 'serverForbidden' | 'serverNotFound' | 'serverRateLimited' | 'serverInternalError' | 'serverBadGateway' | 'serverUnexpectedError' | 'serverUnprocessableEntity' | 'serverEntityLocked' | 'failedAuthProvider' | 'tokenExpired' | 'missingInitialAuth' | 'emptyAuth' | 'authProviderTimedOut' | 'invalidFileId' | 'emptyItems' | 'zeroVersionFile' | 'emptyFileName' | 'pollingMaxAttemptsExceeded' | 'fileSizeExceedsLimit' | 'deprecatedEndpoint';
 export type MediaClientErrorMetadata = SerializableObject & {
     traceContext?: MediaTraceContext;
 };

package/dist/types-ts4.5/utils/request/types.d.ts

@@ -36,7 +36,7 @@ export type CreateUrlOptions = {
     readonly params?: RequestParams;
     readonly auth?: Auth;
 };
-export type RequestErrorReason = 'clientOffline' | 'clientAbortedRequest' | 'clientTimeoutRequest' | 'serverInvalidBody' | 'serverBadRequest' | 'serverUnauthorized' | 'serverForbidden' | 'serverNotFound' | 'serverRateLimited' | 'serverInternalError' | 'serverBadGateway' | 'serverUnexpectedError';
+export type RequestErrorReason = 'clientOffline' | 'clientAbortedRequest' | 'clientTimeoutRequest' | 'serverInvalidBody' | 'serverBadRequest' | 'serverUnauthorized' | 'serverForbidden' | 'serverNotFound' | 'serverRateLimited' | 'serverInternalError' | 'serverBadGateway' | 'serverUnprocessableEntity' | 'serverEntityLocked' | 'serverUnexpectedError';
 export type RequestErrorMetadata = RequestMetadata & {
     readonly attempts?: number;
     readonly clientExhaustedRetries?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/media-client",
-	"version": "34.1.0",
+	"version": "34.2.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.2.0",
+		"@atlaskit/media-common": "^12.3.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@babel/runtime": "^7.0.0",
 		"dataloader": "^2.1.0",