@atlaskit/media-client 33.2.0 → 33.3.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/media-client
 
+## 33.3.0
+
+### Minor Changes
+
+- [#152511](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/152511)
+  [`c5dbe965a1abe`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/c5dbe965a1abe) -
+  Exported hasArtifacts utility
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 33.2.0
 
 ### Minor Changes

package/dist/cjs/client/file-fetcher/index.js

@@ -261,21 +261,21 @@ var FileFetcherImpl = exports.FileFetcherImpl = /*#__PURE__*/function () {
               return _this.getOrFetchFileState(id, collectionName);
             case 2:
               fileState = _context4.sent;
-              if (!(fileState.status !== "processed" || fileState.mediaType !== "video" || !fileState.artifacts["video.mp4"])) {
+              if (!(fileState.status !== 'processed' || fileState.mediaType !== 'video' || !fileState.artifacts['video.mp4'])) {
                 _context4.next = 5;
                 break;
               }
-              throw new Error("File is not a video");
+              throw new Error('File is not a video');
             case 5:
               _context4.next = 7;
-              return _this.getArtifactURL(fileState.artifacts, "video.mp4");
+              return _this.getArtifactURL(fileState.artifacts, 'video.mp4');
             case 7:
               aritfactUrl = _context4.sent;
               artifactPath = new URL(aritfactUrl).pathname;
               _context4.next = 11;
               return _this.mediaApi.request(artifactPath, {
                 headers: {
-                  Range: "bytes=0-199"
+                  Range: 'bytes=0-199'
                 }
               });
             case 11:
@@ -325,7 +325,7 @@ var FileFetcherImpl = exports.FileFetcherImpl = /*#__PURE__*/function () {
                 _context4.next = 36;
                 break;
               }
-              throw new Error("Unable to find mvhd bytes");
+              throw new Error('Unable to find mvhd bytes');
             case 36:
               // Create DataView for reading big-endian integers
               dataView = new DataView(arrayBuffer);
@@ -344,7 +344,7 @@ var FileFetcherImpl = exports.FileFetcherImpl = /*#__PURE__*/function () {
                 _context4.next = 44;
                 break;
               }
-              throw new Error("Timescale is invalid");
+              throw new Error('Timescale is invalid');
             case 44:
               // get the video length in seconds
               videoLength = Math.floor(duration / timeScale);

package/dist/cjs/index.js

@@ -171,6 +171,12 @@ Object.defineProperty(exports, "globalMediaEventEmitter", {
     return _globalMediaEventEmitter.globalMediaEventEmitter;
   }
 });
+Object.defineProperty(exports, "hasArtifacts", {
+  enumerable: true,
+  get: function get() {
+    return _fileState.hasArtifacts;
+  }
+});
 Object.defineProperty(exports, "imageResizeModeToFileImageMode", {
   enumerable: true,
   get: function get() {

package/dist/cjs/models/file-state.js

@@ -4,7 +4,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.mapMediaItemToFileState = exports.mapMediaFileToFileState = exports.isUploadingFileState = exports.isProcessingFileState = exports.isProcessedFileState = exports.isPreviewableFileState = exports.isNonErrorFinalFileState = exports.isImageRepresentationReady = exports.isFinalFileState = exports.isErrorFileState = void 0;
+exports.mapMediaItemToFileState = exports.mapMediaFileToFileState = exports.isUploadingFileState = exports.isProcessingFileState = exports.isProcessedFileState = exports.isPreviewableFileState = exports.isNonErrorFinalFileState = exports.isImageRepresentationReady = exports.isFinalFileState = exports.isErrorFileState = exports.hasArtifacts = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@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) { (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; }
@@ -29,6 +29,9 @@ var isFinalFileState = exports.isFinalFileState = function isFinalFileState(file
 var isNonErrorFinalFileState = exports.isNonErrorFinalFileState = function isNonErrorFinalFileState(fileState) {
   return ['processed', 'failed-processing'].includes(fileState.status);
 };
+var hasArtifacts = exports.hasArtifacts = function hasArtifacts(fileState) {
+  return 'artifacts' in fileState && fileState.artifacts !== undefined;
+};
 var isImageRepresentationReady = exports.isImageRepresentationReady = function isImageRepresentationReady(fileState) {
   switch (fileState.status) {
     case 'processing':

package/dist/es2019/client/file-fetcher/index.js

@@ -163,14 +163,14 @@ export class FileFetcherImpl {
     });
     _defineProperty(this, "getDurationOfVideo", async (id, collectionName) => {
       const fileState = await this.getOrFetchFileState(id, collectionName);
-      if (fileState.status !== "processed" || fileState.mediaType !== "video" || !fileState.artifacts["video.mp4"]) {
-        throw new Error("File is not a video");
+      if (fileState.status !== 'processed' || fileState.mediaType !== 'video' || !fileState.artifacts['video.mp4']) {
+        throw new Error('File is not a video');
       }
-      const aritfactUrl = await this.getArtifactURL(fileState.artifacts, "video.mp4");
+      const aritfactUrl = await this.getArtifactURL(fileState.artifacts, 'video.mp4');
       const artifactPath = new URL(aritfactUrl).pathname;
       const res = await this.mediaApi.request(artifactPath, {
         headers: {
-          Range: "bytes=0-199"
+          Range: 'bytes=0-199'
         }
       });
 
@@ -193,7 +193,7 @@ export class FileFetcherImpl {
         }
       }
       if (mvhdIndex === -1) {
-        throw new Error("Unable to find mvhd bytes");
+        throw new Error('Unable to find mvhd bytes');
       }
 
       // Create DataView for reading big-endian integers
@@ -209,7 +209,7 @@ export class FileFetcherImpl {
       const timeScale = dataView.getUint32(start, false);
       const duration = dataView.getUint32(start + 4, false);
       if (timeScale === 0) {
-        throw new Error("Timescale is invalid");
+        throw new Error('Timescale is invalid');
       }
 
       // get the video length in seconds

package/dist/es2019/index.js

@@ -3,7 +3,7 @@ export { UploadController } from './upload-controller';
 export { isPreviewableType } from './models/media';
 export { getArtifactUrl } from './models/artifacts';
 export { isMediaClientError, getMediaClientErrorReason, isCommonMediaClientError, toCommonMediaClientError } from './models/errors';
-export { isUploadingFileState, isProcessingFileState, isProcessedFileState, isErrorFileState, isPreviewableFileState, isFinalFileState, isImageRepresentationReady, isNonErrorFinalFileState, mapMediaFileToFileState, mapMediaItemToFileState } from './models/file-state';
+export { isUploadingFileState, isProcessingFileState, isProcessedFileState, isErrorFileState, isPreviewableFileState, isFinalFileState, isImageRepresentationReady, isNonErrorFinalFileState, mapMediaFileToFileState, mapMediaItemToFileState, hasArtifacts } from './models/file-state';
 export { uploadFile } from './uploader';
 export { request, RequestError, isRequestError, isRateLimitedError, createRequestErrorReason } from './utils/request';
 export { isAbortedRequestError, createUrl } from './utils/request/helpers';

package/dist/es2019/models/file-state.js

@@ -5,6 +5,7 @@ export const isErrorFileState = fileState => fileState.status === 'error';
 export const isPreviewableFileState = fileState => !isErrorFileState(fileState) && !!fileState.preview;
 export const isFinalFileState = fileState => ['processed', 'failed-processing', 'error'].includes(fileState.status);
 export const isNonErrorFinalFileState = fileState => ['processed', 'failed-processing'].includes(fileState.status);
+export const hasArtifacts = fileState => 'artifacts' in fileState && fileState.artifacts !== undefined;
 export const isImageRepresentationReady = fileState => {
   switch (fileState.status) {
     case 'processing':

package/dist/esm/client/file-fetcher/index.js

@@ -243,21 +243,21 @@ export var FileFetcherImpl = /*#__PURE__*/function () {
               return _this.getOrFetchFileState(id, collectionName);
             case 2:
               fileState = _context4.sent;
-              if (!(fileState.status !== "processed" || fileState.mediaType !== "video" || !fileState.artifacts["video.mp4"])) {
+              if (!(fileState.status !== 'processed' || fileState.mediaType !== 'video' || !fileState.artifacts['video.mp4'])) {
                 _context4.next = 5;
                 break;
               }
-              throw new Error("File is not a video");
+              throw new Error('File is not a video');
             case 5:
               _context4.next = 7;
-              return _this.getArtifactURL(fileState.artifacts, "video.mp4");
+              return _this.getArtifactURL(fileState.artifacts, 'video.mp4');
             case 7:
               aritfactUrl = _context4.sent;
               artifactPath = new URL(aritfactUrl).pathname;
               _context4.next = 11;
               return _this.mediaApi.request(artifactPath, {
                 headers: {
-                  Range: "bytes=0-199"
+                  Range: 'bytes=0-199'
                 }
               });
             case 11:
@@ -307,7 +307,7 @@ export var FileFetcherImpl = /*#__PURE__*/function () {
                 _context4.next = 36;
                 break;
               }
-              throw new Error("Unable to find mvhd bytes");
+              throw new Error('Unable to find mvhd bytes');
             case 36:
               // Create DataView for reading big-endian integers
               dataView = new DataView(arrayBuffer);
@@ -326,7 +326,7 @@ export var FileFetcherImpl = /*#__PURE__*/function () {
                 _context4.next = 44;
                 break;
               }
-              throw new Error("Timescale is invalid");
+              throw new Error('Timescale is invalid');
             case 44:
               // get the video length in seconds
               videoLength = Math.floor(duration / timeScale);

package/dist/esm/index.js

@@ -3,7 +3,7 @@ export { UploadController } from './upload-controller';
 export { isPreviewableType } from './models/media';
 export { getArtifactUrl } from './models/artifacts';
 export { isMediaClientError, getMediaClientErrorReason, isCommonMediaClientError, toCommonMediaClientError } from './models/errors';
-export { isUploadingFileState, isProcessingFileState, isProcessedFileState, isErrorFileState, isPreviewableFileState, isFinalFileState, isImageRepresentationReady, isNonErrorFinalFileState, mapMediaFileToFileState, mapMediaItemToFileState } from './models/file-state';
+export { isUploadingFileState, isProcessingFileState, isProcessedFileState, isErrorFileState, isPreviewableFileState, isFinalFileState, isImageRepresentationReady, isNonErrorFinalFileState, mapMediaFileToFileState, mapMediaItemToFileState, hasArtifacts } from './models/file-state';
 export { uploadFile } from './uploader';
 export { request, RequestError, isRequestError, isRateLimitedError, createRequestErrorReason } from './utils/request';
 export { isAbortedRequestError, createUrl } from './utils/request/helpers';

package/dist/esm/models/file-state.js

@@ -22,6 +22,9 @@ export var isFinalFileState = function isFinalFileState(fileState) {
 export var isNonErrorFinalFileState = function isNonErrorFinalFileState(fileState) {
   return ['processed', 'failed-processing'].includes(fileState.status);
 };
+export var hasArtifacts = function hasArtifacts(fileState) {
+  return 'artifacts' in fileState && fileState.artifacts !== undefined;
+};
 export var isImageRepresentationReady = function isImageRepresentationReady(fileState) {
   switch (fileState.status) {
     case 'processing':

package/dist/types/index.d.ts

@@ -8,7 +8,7 @@ export type { MediaFileProcessingStatus, MediaType, MediaFile, MediaRepresentati
 export { getArtifactUrl } from './models/artifacts';
 export { isMediaClientError, getMediaClientErrorReason, isCommonMediaClientError, toCommonMediaClientError, } from './models/errors';
 export type { MediaClientError, MediaClientErrorReason, MediaClientErrorAttributes, } from './models/errors';
-export { isUploadingFileState, isProcessingFileState, isProcessedFileState, isErrorFileState, isPreviewableFileState, isFinalFileState, isImageRepresentationReady, isNonErrorFinalFileState, mapMediaFileToFileState, mapMediaItemToFileState, } from './models/file-state';
+export { isUploadingFileState, isProcessingFileState, isProcessedFileState, isErrorFileState, isPreviewableFileState, isFinalFileState, isImageRepresentationReady, isNonErrorFinalFileState, mapMediaFileToFileState, mapMediaItemToFileState, hasArtifacts, } from './models/file-state';
 export type { FileStatus, PreviewOptions, GetFileOptions, NonErrorFileState, PreviewableFileState, } from './models/file-state';
 export type { FileState, FilePreview, ErrorFileState, UploadingFileState, ProcessingFileState, ProcessedFileState, ProcessingFailedState, MediaFileArtifact, MediaFileArtifacts, } from '@atlaskit/media-state';
 export type { MobileUpload, MobileUploadStartEvent, MobileUploadProgressEvent, MobileUploadEndEvent, MobileUploadErrorEvent, } from './models/mobile-upload';

package/dist/types/models/file-state.d.ts

@@ -1,7 +1,7 @@
 import { type FileStatus as CommonFileStatus } from '@atlaskit/media-common';
 import { type MediaStoreResponse } from '../client/media-store';
 import { type MediaItemDetails, type MediaFile } from './media';
-import { type FilePreview, type FileState, type ErrorFileState, type UploadingFileState, type ProcessingFileState, type ProcessedFileState, type ProcessingFailedState } from '@atlaskit/media-state';
+import { type FilePreview, type FileState, type ErrorFileState, type UploadingFileState, type ProcessingFileState, type ProcessedFileState, type ProcessingFailedState, type MediaFileArtifacts } from '@atlaskit/media-state';
 export type FileStatus = CommonFileStatus;
 export interface PreviewOptions {
 }
@@ -23,6 +23,9 @@ export declare const isErrorFileState: (fileState: FileState) => fileState is Er
 export declare const isPreviewableFileState: (fileState: FileState) => fileState is (UploadingFileState | ProcessingFileState | ProcessedFileState | ProcessingFailedState) & PreviewableFileState;
 export declare const isFinalFileState: (fileState: FileState) => fileState is ProcessedFileState | ErrorFileState | ProcessingFailedState;
 export declare const isNonErrorFinalFileState: (fileState: FileState) => fileState is ProcessedFileState | ProcessingFailedState;
+export declare const hasArtifacts: (fileState: FileState) => fileState is FileState & {
+    artifacts: MediaFileArtifacts;
+};
 export declare const isImageRepresentationReady: (fileState: FileState) => boolean;
 export declare const mapMediaFileToFileState: (mediaFile: MediaStoreResponse<MediaFile>) => FileState;
 export declare const mapMediaItemToFileState: (id: string, item: MediaItemDetails) => FileState;

package/dist/types-ts4.5/index.d.ts

@@ -8,7 +8,7 @@ export type { MediaFileProcessingStatus, MediaType, MediaFile, MediaRepresentati
 export { getArtifactUrl } from './models/artifacts';
 export { isMediaClientError, getMediaClientErrorReason, isCommonMediaClientError, toCommonMediaClientError, } from './models/errors';
 export type { MediaClientError, MediaClientErrorReason, MediaClientErrorAttributes, } from './models/errors';
-export { isUploadingFileState, isProcessingFileState, isProcessedFileState, isErrorFileState, isPreviewableFileState, isFinalFileState, isImageRepresentationReady, isNonErrorFinalFileState, mapMediaFileToFileState, mapMediaItemToFileState, } from './models/file-state';
+export { isUploadingFileState, isProcessingFileState, isProcessedFileState, isErrorFileState, isPreviewableFileState, isFinalFileState, isImageRepresentationReady, isNonErrorFinalFileState, mapMediaFileToFileState, mapMediaItemToFileState, hasArtifacts, } from './models/file-state';
 export type { FileStatus, PreviewOptions, GetFileOptions, NonErrorFileState, PreviewableFileState, } from './models/file-state';
 export type { FileState, FilePreview, ErrorFileState, UploadingFileState, ProcessingFileState, ProcessedFileState, ProcessingFailedState, MediaFileArtifact, MediaFileArtifacts, } from '@atlaskit/media-state';
 export type { MobileUpload, MobileUploadStartEvent, MobileUploadProgressEvent, MobileUploadEndEvent, MobileUploadErrorEvent, } from './models/mobile-upload';

package/dist/types-ts4.5/models/file-state.d.ts

@@ -1,7 +1,7 @@
 import { type FileStatus as CommonFileStatus } from '@atlaskit/media-common';
 import { type MediaStoreResponse } from '../client/media-store';
 import { type MediaItemDetails, type MediaFile } from './media';
-import { type FilePreview, type FileState, type ErrorFileState, type UploadingFileState, type ProcessingFileState, type ProcessedFileState, type ProcessingFailedState } from '@atlaskit/media-state';
+import { type FilePreview, type FileState, type ErrorFileState, type UploadingFileState, type ProcessingFileState, type ProcessedFileState, type ProcessingFailedState, type MediaFileArtifacts } from '@atlaskit/media-state';
 export type FileStatus = CommonFileStatus;
 export interface PreviewOptions {
 }
@@ -23,6 +23,9 @@ export declare const isErrorFileState: (fileState: FileState) => fileState is Er
 export declare const isPreviewableFileState: (fileState: FileState) => fileState is (UploadingFileState | ProcessingFileState | ProcessedFileState | ProcessingFailedState) & PreviewableFileState;
 export declare const isFinalFileState: (fileState: FileState) => fileState is ProcessedFileState | ErrorFileState | ProcessingFailedState;
 export declare const isNonErrorFinalFileState: (fileState: FileState) => fileState is ProcessedFileState | ProcessingFailedState;
+export declare const hasArtifacts: (fileState: FileState) => fileState is FileState & {
+    artifacts: MediaFileArtifacts;
+};
 export declare const isImageRepresentationReady: (fileState: FileState) => boolean;
 export declare const mapMediaFileToFileState: (mediaFile: MediaStoreResponse<MediaFile>) => FileState;
 export declare const mapMediaItemToFileState: (id: string, item: MediaItemDetails) => FileState;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/media-client",
-	"version": "33.2.0",
+	"version": "33.3.0",
 	"description": "Media API Web Client Library",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -51,11 +51,11 @@
 	},
 	"peerDependencies": {
 		"@atlaskit/media-core": "^36.1.0",
-		"@atlaskit/media-state": "^1.5.0"
+		"@atlaskit/media-state": "^1.6.0"
 	},
 	"devDependencies": {
 		"@atlaskit/media-core": "^36.1.0",
-		"@atlaskit/media-state": "^1.5.0",
+		"@atlaskit/media-state": "^1.6.0",
 		"@atlaskit/ssr": "workspace:^",
 		"@atlaskit/tokens": "^4.8.0",
 		"@atlassian/feature-flags-test-utils": "^0.3.0",