@atlaskit/media-client 33.3.1 → 33.4.0

package/dist/types/client/file-fetcher/index.d.ts

@@ -9,7 +9,7 @@ import { type MediaSubscribable } from '../../utils/mediaSubscribable';
 import { type Dimensions } from '../../utils/getDimensionsFromBlob';
 import { type MediaTraceContext } from '@atlaskit/media-common';
 import { type FilePreview, type FileState, type MediaStore } from '@atlaskit/media-state';
-import { type UploadArtifactParams } from '../media-store/types';
+import { type UploadArtifactParams, type DeleteArtifactParams } from '../media-store/types';
 export type { FileFetcherErrorAttributes, FileFetcherErrorReason } from './error';
 export { isFileFetcherError, FileFetcherError } from './error';
 export interface CopySourceFile {
@@ -42,6 +42,7 @@ export interface FileFetcher {
     getFileBinaryURL(id: string, collectionName?: string, maxAge?: number): Promise<string>;
     registerCopyIntent(id: string, collectionName?: string): Promise<void>;
     uploadArtifact(id: string, file: File, params: UploadArtifactParams, collectionName?: string, traceContext?: MediaTraceContext): Promise<MediaItemDetails>;
+    deleteArtifact(id: string, params: DeleteArtifactParams, collectionName?: string, traceContext?: MediaTraceContext): Promise<void>;
     /** @exprimental This is exprimental for the purposes of COMMIT-18082 and is prone to breaking changes */
     getVideoDurations(files: Array<{
         id: string;
@@ -74,6 +75,7 @@ export declare class FileFetcherImpl implements FileFetcher {
     private copyFileWithIntent;
     copyFile(source: CopySourceFile, destination: CopyDestination, options?: CopyFileOptions, traceContext?: MediaTraceContext): Promise<MediaFile>;
     uploadArtifact: FileFetcher['uploadArtifact'];
+    deleteArtifact: FileFetcher['deleteArtifact'];
     private getOrFetchFileState;
     private getDurationOfVideo;
     getVideoDurations: (files: Array<{

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

@@ -4,6 +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';
 export declare class MediaStore implements MediaApi {
     private readonly config;
     private readonly _chunkHashAlgorithm;
@@ -23,11 +24,14 @@ export declare class MediaStore implements MediaApi {
     getArtifactURL(artifacts: MediaFileArtifacts, artifactName: keyof MediaFileArtifacts, collectionName?: string, maxAge?: number): Promise<string>;
     getArtifactBinary: MediaApi['getArtifactBinary'];
     uploadArtifact: MediaApi['uploadArtifact'];
+    deleteArtifact: MediaApi['deleteArtifact'];
     getImage(id: string, params?: MediaStoreGetFileImageParams, controller?: AbortController, fetchMaxRes?: boolean, traceContext?: MediaTraceContext): Promise<Blob>;
     getItems(ids: string[], collectionName?: string, traceContext?: MediaTraceContext, includeHashForDuplicateFiles?: boolean): Promise<MediaStoreResponse<ItemsPayload>>;
     getImageMetadata(id: string, params?: MediaStoreGetFileImageParams, traceContext?: MediaTraceContext): Promise<{
         metadata: ImageMetadata;
     }>;
+    getDocumentContent(id: string, options: GetDocumentContentOptions): Promise<DocumentPageRangeContent>;
+    getDocumentPageImage(id: string, options: GetDocumentPageImage): 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

@@ -4,6 +4,7 @@ import { type MediaFileArtifacts } from '@atlaskit/media-state';
 import { type MediaItemDetails, type MediaFile, type MediaUpload } from '../../models/media';
 import { type ClientOptions, type RequestHeaders, type RequestMethod, type RequestParams, type RequestMetadata } from '../../utils/request/types';
 import { type ChunkHashAlgorithm } from '@atlaskit/media-core';
+import { type DocumentPageRangeContent, type GetDocumentPageImage, type GetDocumentContentOptions } from '../../models/document';
 export interface ResponseFileItem {
     id: string;
     type: 'file';
@@ -163,6 +164,9 @@ export type UploadArtifactCaptionsParams = {
     language: string;
 };
 export type UploadArtifactParams = UploadArtifactCaptionsParams;
+export type DeleteArtifactParams = {
+    artifactName: string;
+};
 export interface MediaApi {
     removeCollectionFile: (id: string, collectionName: string, occurrenceKey?: string, traceContext?: MediaTraceContext) => Promise<void>;
     createUpload: (createUpTo: number, collectionName?: string, traceContext?: MediaTraceContext, chunkChunkHashAlgorithm?: ChunkHashAlgorithm) => Promise<MediaStoreResponse<MediaUpload[]>>;
@@ -178,6 +182,7 @@ export interface MediaApi {
     getArtifactURL: (artifacts: MediaFileArtifacts, artifactName: keyof MediaFileArtifacts, collectionName?: string) => Promise<string>;
     getArtifactBinary(artifacts: MediaFileArtifacts, artifactName: keyof MediaFileArtifacts, options: GetArtifactBinaryOptions): Promise<Blob>;
     uploadArtifact(id: string, file: File, params: UploadArtifactParams, collectionName?: string, traceContext?: MediaTraceContext): Promise<MediaStoreResponse<MediaItemDetails>>;
+    deleteArtifact(id: string, params: DeleteArtifactParams, collectionName?: string, traceContext?: MediaTraceContext): Promise<void>;
     getImage: (id: string, params?: MediaStoreGetFileImageParams, controller?: AbortController, fetchMaxRes?: boolean, traceContext?: MediaTraceContext) => Promise<Blob>;
     getItems: (ids: string[], collectionName?: string, traceContext?: MediaTraceContext, includeHashForDuplicateFiles?: boolean) => Promise<MediaStoreResponse<ItemsPayload>>;
     getImageMetadata: (id: string, params?: MediaStoreGetFileImageParams, traceContext?: MediaTraceContext) => Promise<{
@@ -196,4 +201,8 @@ export interface MediaApi {
     }) => Promise<void>;
     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>;
+    /** @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>;
 }

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

@@ -0,0 +1,54 @@
+export type Font = {
+    name: string;
+    size: number;
+    weight: number;
+    is_all_caps: boolean;
+    is_bold_reenforced: boolean;
+    is_cursive: boolean;
+    is_fixed_pitch: boolean;
+    is_italic: boolean;
+    is_non_symbolic: boolean;
+    is_proportional_pitch: boolean;
+    is_sans_serif: boolean;
+    is_serif: boolean;
+    is_small_caps: boolean;
+    is_symbolic: boolean;
+};
+export type Span = {
+    text: string;
+    fi: number;
+    r: number;
+    x: number;
+    y: number;
+    h: number;
+    l: number;
+};
+export type Line = {
+    r: number;
+    spans: readonly Span[];
+};
+export type DocumentPageContent = {
+    rotation: number;
+    width: number;
+    height: number;
+    lines: readonly Line[];
+};
+export type DocumentPageRangeContent = {
+    total_pages: number;
+    start_index: number;
+    end_index: number;
+    fonts: readonly Font[];
+    pages: readonly DocumentPageContent[];
+};
+export type GetDocumentContentOptions = {
+    pageStart: number;
+    pageEnd: number;
+    collectionName?: string;
+    maxAge?: number;
+};
+export type GetDocumentPageImage = {
+    page: number;
+    zoom: number;
+    collectionName?: string;
+    maxAge?: number;
+};

package/dist/types-ts4.5/client/file-fetcher/index.d.ts

@@ -9,7 +9,7 @@ import { type MediaSubscribable } from '../../utils/mediaSubscribable';
 import { type Dimensions } from '../../utils/getDimensionsFromBlob';
 import { type MediaTraceContext } from '@atlaskit/media-common';
 import { type FilePreview, type FileState, type MediaStore } from '@atlaskit/media-state';
-import { type UploadArtifactParams } from '../media-store/types';
+import { type UploadArtifactParams, type DeleteArtifactParams } from '../media-store/types';
 export type { FileFetcherErrorAttributes, FileFetcherErrorReason } from './error';
 export { isFileFetcherError, FileFetcherError } from './error';
 export interface CopySourceFile {
@@ -42,6 +42,7 @@ export interface FileFetcher {
     getFileBinaryURL(id: string, collectionName?: string, maxAge?: number): Promise<string>;
     registerCopyIntent(id: string, collectionName?: string): Promise<void>;
     uploadArtifact(id: string, file: File, params: UploadArtifactParams, collectionName?: string, traceContext?: MediaTraceContext): Promise<MediaItemDetails>;
+    deleteArtifact(id: string, params: DeleteArtifactParams, collectionName?: string, traceContext?: MediaTraceContext): Promise<void>;
     /** @exprimental This is exprimental for the purposes of COMMIT-18082 and is prone to breaking changes */
     getVideoDurations(files: Array<{
         id: string;
@@ -74,6 +75,7 @@ export declare class FileFetcherImpl implements FileFetcher {
     private copyFileWithIntent;
     copyFile(source: CopySourceFile, destination: CopyDestination, options?: CopyFileOptions, traceContext?: MediaTraceContext): Promise<MediaFile>;
     uploadArtifact: FileFetcher['uploadArtifact'];
+    deleteArtifact: FileFetcher['deleteArtifact'];
     private getOrFetchFileState;
     private getDurationOfVideo;
     getVideoDurations: (files: Array<{

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

@@ -4,6 +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';
 export declare class MediaStore implements MediaApi {
     private readonly config;
     private readonly _chunkHashAlgorithm;
@@ -23,11 +24,14 @@ export declare class MediaStore implements MediaApi {
     getArtifactURL(artifacts: MediaFileArtifacts, artifactName: keyof MediaFileArtifacts, collectionName?: string, maxAge?: number): Promise<string>;
     getArtifactBinary: MediaApi['getArtifactBinary'];
     uploadArtifact: MediaApi['uploadArtifact'];
+    deleteArtifact: MediaApi['deleteArtifact'];
     getImage(id: string, params?: MediaStoreGetFileImageParams, controller?: AbortController, fetchMaxRes?: boolean, traceContext?: MediaTraceContext): Promise<Blob>;
     getItems(ids: string[], collectionName?: string, traceContext?: MediaTraceContext, includeHashForDuplicateFiles?: boolean): Promise<MediaStoreResponse<ItemsPayload>>;
     getImageMetadata(id: string, params?: MediaStoreGetFileImageParams, traceContext?: MediaTraceContext): Promise<{
         metadata: ImageMetadata;
     }>;
+    getDocumentContent(id: string, options: GetDocumentContentOptions): Promise<DocumentPageRangeContent>;
+    getDocumentPageImage(id: string, options: GetDocumentPageImage): 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

@@ -4,6 +4,7 @@ import { type MediaFileArtifacts } from '@atlaskit/media-state';
 import { type MediaItemDetails, type MediaFile, type MediaUpload } from '../../models/media';
 import { type ClientOptions, type RequestHeaders, type RequestMethod, type RequestParams, type RequestMetadata } from '../../utils/request/types';
 import { type ChunkHashAlgorithm } from '@atlaskit/media-core';
+import { type DocumentPageRangeContent, type GetDocumentPageImage, type GetDocumentContentOptions } from '../../models/document';
 export interface ResponseFileItem {
     id: string;
     type: 'file';
@@ -163,6 +164,9 @@ export type UploadArtifactCaptionsParams = {
     language: string;
 };
 export type UploadArtifactParams = UploadArtifactCaptionsParams;
+export type DeleteArtifactParams = {
+    artifactName: string;
+};
 export interface MediaApi {
     removeCollectionFile: (id: string, collectionName: string, occurrenceKey?: string, traceContext?: MediaTraceContext) => Promise<void>;
     createUpload: (createUpTo: number, collectionName?: string, traceContext?: MediaTraceContext, chunkChunkHashAlgorithm?: ChunkHashAlgorithm) => Promise<MediaStoreResponse<MediaUpload[]>>;
@@ -178,6 +182,7 @@ export interface MediaApi {
     getArtifactURL: (artifacts: MediaFileArtifacts, artifactName: keyof MediaFileArtifacts, collectionName?: string) => Promise<string>;
     getArtifactBinary(artifacts: MediaFileArtifacts, artifactName: keyof MediaFileArtifacts, options: GetArtifactBinaryOptions): Promise<Blob>;
     uploadArtifact(id: string, file: File, params: UploadArtifactParams, collectionName?: string, traceContext?: MediaTraceContext): Promise<MediaStoreResponse<MediaItemDetails>>;
+    deleteArtifact(id: string, params: DeleteArtifactParams, collectionName?: string, traceContext?: MediaTraceContext): Promise<void>;
     getImage: (id: string, params?: MediaStoreGetFileImageParams, controller?: AbortController, fetchMaxRes?: boolean, traceContext?: MediaTraceContext) => Promise<Blob>;
     getItems: (ids: string[], collectionName?: string, traceContext?: MediaTraceContext, includeHashForDuplicateFiles?: boolean) => Promise<MediaStoreResponse<ItemsPayload>>;
     getImageMetadata: (id: string, params?: MediaStoreGetFileImageParams, traceContext?: MediaTraceContext) => Promise<{
@@ -196,4 +201,8 @@ export interface MediaApi {
     }) => Promise<void>;
     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>;
+    /** @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>;
 }

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

@@ -0,0 +1,54 @@
+export type Font = {
+    name: string;
+    size: number;
+    weight: number;
+    is_all_caps: boolean;
+    is_bold_reenforced: boolean;
+    is_cursive: boolean;
+    is_fixed_pitch: boolean;
+    is_italic: boolean;
+    is_non_symbolic: boolean;
+    is_proportional_pitch: boolean;
+    is_sans_serif: boolean;
+    is_serif: boolean;
+    is_small_caps: boolean;
+    is_symbolic: boolean;
+};
+export type Span = {
+    text: string;
+    fi: number;
+    r: number;
+    x: number;
+    y: number;
+    h: number;
+    l: number;
+};
+export type Line = {
+    r: number;
+    spans: readonly Span[];
+};
+export type DocumentPageContent = {
+    rotation: number;
+    width: number;
+    height: number;
+    lines: readonly Line[];
+};
+export type DocumentPageRangeContent = {
+    total_pages: number;
+    start_index: number;
+    end_index: number;
+    fonts: readonly Font[];
+    pages: readonly DocumentPageContent[];
+};
+export type GetDocumentContentOptions = {
+    pageStart: number;
+    pageEnd: number;
+    collectionName?: string;
+    maxAge?: number;
+};
+export type GetDocumentPageImage = {
+    page: number;
+    zoom: number;
+    collectionName?: string;
+    maxAge?: number;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/media-client",
-	"version": "33.3.1",
+	"version": "33.4.0",
 	"description": "Media API Web Client Library",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -57,7 +57,7 @@
 		"@atlaskit/media-core": "^36.1.0",
 		"@atlaskit/media-state": "^1.6.0",
 		"@atlaskit/ssr": "workspace:^",
-		"@atlaskit/tokens": "^4.9.0",
+		"@atlaskit/tokens": "^5.1.0",
 		"@atlassian/feature-flags-test-utils": "^0.3.0",
 		"@emotion/react": "^11.7.1",
 		"@types/deep-equal": "^1.0.1",