@atlaskit/media-client 25.0.2 → 25.0.3

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

@@ -0,0 +1,161 @@
+import { Auth, AsapBasedAuth, AuthContext, ClientAltBasedAuth } from '@atlaskit/media-core';
+import { MediaTraceContext } from '@atlaskit/media-common';
+import { MediaFileArtifacts } from '@atlaskit/media-state';
+import { MediaItemDetails, MediaChunksProbe, MediaFile, MediaUpload } from '../../models/media';
+import { ClientOptions, RequestHeaders, RequestMethod, RequestParams, RequestMetadata } from '../../utils/request/types';
+export interface ResponseFileItem {
+    id: string;
+    type: 'file';
+    details: MediaItemDetails;
+    collection?: string;
+    metadataTraceContext?: MediaTraceContext;
+}
+export interface ItemsPayload {
+    items: ResponseFileItem[];
+}
+export type ImageMetadataArtifact = {
+    url?: string;
+    width?: number;
+    height?: number;
+    size?: number;
+};
+export interface ImageMetadata {
+    pending: boolean;
+    preview?: ImageMetadataArtifact;
+    original?: ImageMetadataArtifact;
+}
+export interface MediaStoreResponse<Data> {
+    readonly data: Data;
+}
+export type MediaStoreRequestOptions = RequestMetadata & {
+    readonly method?: RequestMethod;
+    readonly authContext?: AuthContext;
+    readonly params?: RequestParams;
+    readonly headers?: RequestHeaders;
+    readonly body?: any;
+    readonly clientOptions?: ClientOptions;
+    readonly traceContext?: MediaTraceContext;
+};
+export type MediaStoreCreateFileFromUploadParams = {
+    readonly collection?: string;
+    readonly occurrenceKey?: string;
+    readonly expireAfter?: number;
+    readonly replaceFileId?: string;
+    readonly skipConversions?: boolean;
+};
+export type MediaStoreCreateFileParams = {
+    readonly occurrenceKey?: string;
+    readonly collection?: string;
+};
+export interface MediaStoreTouchFileParams {
+    readonly collection?: string;
+}
+export interface TouchFileDescriptor {
+    fileId: string;
+    collection?: string;
+    occurrenceKey?: string;
+    expireAfter?: number;
+    deletable?: boolean;
+    size?: number;
+}
+export interface MediaStoreTouchFileBody {
+    descriptors: TouchFileDescriptor[];
+}
+export type MediaStoreCreateFileFromBinaryParams = {
+    readonly replaceFileId?: string;
+    readonly collection?: string;
+    readonly occurrenceKey?: string;
+    readonly expireAfter?: number;
+    readonly skipConversions?: boolean;
+    readonly name?: string;
+};
+export type MediaStoreCreateFileFromUploadConditions = {
+    readonly hash?: string;
+    readonly size?: number;
+};
+export type MediaStoreCreateFileFromUploadBody = {
+    readonly uploadId: string;
+    readonly name?: string;
+    readonly mimeType?: string;
+    readonly conditions?: MediaStoreCreateFileFromUploadConditions;
+};
+export type MediaStoreGetFileParams = {
+    readonly version?: number;
+    readonly collection?: string;
+};
+export type MediaStoreGetFileImageParams = {
+    readonly allowAnimated?: boolean;
+    readonly version?: number;
+    readonly collection?: string;
+    readonly width?: number;
+    readonly height?: number;
+    readonly mode?: 'fit' | 'full-fit' | 'crop';
+    readonly upscale?: boolean;
+    readonly 'max-age'?: number;
+};
+export interface SourceFile {
+    id: string;
+    owner: ClientAltBasedAuth | AsapBasedAuth;
+    collection?: string;
+    version?: number;
+}
+export type MediaStoreCopyFileWithTokenBody = {
+    sourceFile: SourceFile;
+};
+export type MediaStoreCopyFileWithTokenParams = {
+    readonly collection?: string;
+    readonly replaceFileId?: string;
+    readonly occurrenceKey?: string;
+};
+export type AppendChunksToUploadRequestBody = {
+    readonly chunks: string[];
+    readonly hash?: string;
+    readonly offset?: number;
+};
+export interface CreatedTouchedFile {
+    fileId: string;
+    uploadId: string;
+}
+export interface RejectedTouchFile {
+    fileId: string;
+    error: RejectionError;
+}
+export type RejectionError = {
+    code: 'ExceedMaxFileSizeLimit';
+    title: string;
+    href: string;
+    limit: number;
+    size: number;
+};
+export type TouchedFiles = {
+    created: CreatedTouchedFile[];
+    rejected?: RejectedTouchFile[];
+};
+export interface EmptyFile {
+    readonly id: string;
+    readonly createdAt: number;
+}
+export interface MediaApi {
+    removeCollectionFile: (id: string, collectionName: string, occurrenceKey?: string, traceContext?: MediaTraceContext) => Promise<void>;
+    createUpload: (createUpTo: number, collectionName?: string, traceContext?: MediaTraceContext) => Promise<MediaStoreResponse<MediaUpload[]>>;
+    uploadChunk: (etag: string, blob: Blob, uploadId: string, partNumber: number, collectionName?: string, traceContext?: MediaTraceContext) => Promise<void>;
+    probeChunks: (chunks: string[], uploadId: string, collectionName?: string, traceContext?: MediaTraceContext) => Promise<MediaStoreResponse<MediaChunksProbe>>;
+    createFileFromUpload: (body: MediaStoreCreateFileFromUploadBody, params: MediaStoreCreateFileFromUploadParams, traceContext?: MediaTraceContext) => Promise<MediaStoreResponse<MediaFile>>;
+    getRejectedResponseFromDescriptor: (descriptor: TouchFileDescriptor, limit: number) => RejectedTouchFile;
+    touchFiles: (body: MediaStoreTouchFileBody, params: MediaStoreTouchFileParams, traceContext?: MediaTraceContext) => Promise<MediaStoreResponse<TouchedFiles>>;
+    getFile: (fileId: string, params: MediaStoreGetFileParams, traceContext?: MediaTraceContext) => Promise<MediaStoreResponse<MediaFile>>;
+    getFileImageURL: (id: string, params?: MediaStoreGetFileImageParams) => Promise<string>;
+    getFileImageURLSync: (id: string, params?: MediaStoreGetFileImageParams) => string;
+    getFileBinaryURL: (id: string, collectionName?: string) => Promise<string>;
+    getArtifactURL: (artifacts: MediaFileArtifacts, artifactName: keyof MediaFileArtifacts, collectionName?: string) => Promise<string>;
+    getImage: (id: string, params?: MediaStoreGetFileImageParams, controller?: AbortController, fetchMaxRes?: boolean, traceContext?: MediaTraceContext) => Promise<Blob>;
+    getItems: (ids: string[], collectionName?: string, traceContext?: MediaTraceContext) => Promise<MediaStoreResponse<ItemsPayload>>;
+    getImageMetadata: (id: string, params?: MediaStoreGetFileImageParams, traceContext?: MediaTraceContext) => Promise<{
+        metadata: ImageMetadata;
+    }>;
+    appendChunksToUpload: (uploadId: string, body: AppendChunksToUploadRequestBody, collectionName?: string, traceContext?: MediaTraceContext) => Promise<void>;
+    copyFileWithToken: (body: MediaStoreCopyFileWithTokenBody, params: MediaStoreCopyFileWithTokenParams, traceContext?: MediaTraceContext) => Promise<MediaStoreResponse<MediaFile>>;
+    request: (path: string, options: MediaStoreRequestOptions, controller?: AbortController) => Promise<Response>;
+    resolveAuth: (authContext?: AuthContext) => Promise<Auth>;
+    resolveInitialAuth: () => Auth;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/media-client",
-  "version": "25.0.2",
+  "version": "25.0.3",
   "description": "Media API Web Client Library",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"

package/report.api.md

@@ -604,6 +604,125 @@ export const mapMediaItemToFileState: (
 // @public (undocumented)
 export const MAX_RESOLUTION = 4096;
 
+// @public (undocumented)
+interface MediaApi {
+  // (undocumented)
+  appendChunksToUpload: (
+    uploadId: string,
+    body: AppendChunksToUploadRequestBody,
+    collectionName?: string,
+    traceContext?: MediaTraceContext,
+  ) => Promise<void>;
+  // (undocumented)
+  copyFileWithToken: (
+    body: MediaStoreCopyFileWithTokenBody,
+    params: MediaStoreCopyFileWithTokenParams,
+    traceContext?: MediaTraceContext,
+  ) => Promise<MediaStoreResponse<MediaFile>>;
+  // (undocumented)
+  createFileFromUpload: (
+    body: MediaStoreCreateFileFromUploadBody,
+    params: MediaStoreCreateFileFromUploadParams,
+    traceContext?: MediaTraceContext,
+  ) => Promise<MediaStoreResponse<MediaFile>>;
+  // (undocumented)
+  createUpload: (
+    createUpTo: number,
+    collectionName?: string,
+    traceContext?: MediaTraceContext,
+  ) => Promise<MediaStoreResponse<MediaUpload[]>>;
+  // (undocumented)
+  getArtifactURL: (
+    artifacts: MediaFileArtifacts,
+    artifactName: keyof MediaFileArtifacts,
+    collectionName?: string,
+  ) => Promise<string>;
+  // (undocumented)
+  getFile: (
+    fileId: string,
+    params: MediaStoreGetFileParams,
+    traceContext?: MediaTraceContext,
+  ) => Promise<MediaStoreResponse<MediaFile>>;
+  // (undocumented)
+  getFileBinaryURL: (id: string, collectionName?: string) => Promise<string>;
+  // (undocumented)
+  getFileImageURL: (
+    id: string,
+    params?: MediaStoreGetFileImageParams,
+  ) => Promise<string>;
+  // (undocumented)
+  getFileImageURLSync: (
+    id: string,
+    params?: MediaStoreGetFileImageParams,
+  ) => string;
+  // (undocumented)
+  getImage: (
+    id: string,
+    params?: MediaStoreGetFileImageParams,
+    controller?: AbortController,
+    fetchMaxRes?: boolean,
+    traceContext?: MediaTraceContext,
+  ) => Promise<Blob>;
+  // (undocumented)
+  getImageMetadata: (
+    id: string,
+    params?: MediaStoreGetFileImageParams,
+    traceContext?: MediaTraceContext,
+  ) => Promise<{
+    metadata: ImageMetadata;
+  }>;
+  // (undocumented)
+  getItems: (
+    ids: string[],
+    collectionName?: string,
+    traceContext?: MediaTraceContext,
+  ) => Promise<MediaStoreResponse<ItemsPayload>>;
+  // (undocumented)
+  getRejectedResponseFromDescriptor: (
+    descriptor: TouchFileDescriptor,
+    limit: number,
+  ) => RejectedTouchFile;
+  // (undocumented)
+  probeChunks: (
+    chunks: string[],
+    uploadId: string,
+    collectionName?: string,
+    traceContext?: MediaTraceContext,
+  ) => Promise<MediaStoreResponse<MediaChunksProbe>>;
+  // (undocumented)
+  removeCollectionFile: (
+    id: string,
+    collectionName: string,
+    occurrenceKey?: string,
+    traceContext?: MediaTraceContext,
+  ) => Promise<void>;
+  // (undocumented)
+  request: (
+    path: string,
+    options: MediaStoreRequestOptions,
+    controller?: AbortController,
+  ) => Promise<Response>;
+  // (undocumented)
+  resolveAuth: (authContext?: AuthContext) => Promise<Auth>;
+  // (undocumented)
+  resolveInitialAuth: () => Auth;
+  // (undocumented)
+  touchFiles: (
+    body: MediaStoreTouchFileBody,
+    params: MediaStoreTouchFileParams,
+    traceContext?: MediaTraceContext,
+  ) => Promise<MediaStoreResponse<TouchedFiles>>;
+  // (undocumented)
+  uploadChunk: (
+    etag: string,
+    blob: Blob,
+    uploadId: string,
+    partNumber: number,
+    collectionName?: string,
+    traceContext?: MediaTraceContext,
+  ) => Promise<void>;
+}
+
 // @public (undocumented)
 export interface MediaArtifact {
   // (undocumented)
@@ -800,7 +919,7 @@ export type MediaRepresentations = {
 };
 
 // @public (undocumented)
-export class MediaStore {
+export class MediaStore implements MediaApi {
   constructor(config: MediaApiConfig);
   // (undocumented)
   appendChunksToUpload(

package/tmp/api-report-tmp.d.ts

@@ -453,6 +453,52 @@ export const mapMediaItemToFileState: (id: string, item: MediaItemDetails) => Fi
 // @public (undocumented)
 export const MAX_RESOLUTION = 4096;
 
+// @public (undocumented)
+interface MediaApi {
+    // (undocumented)
+    appendChunksToUpload: (uploadId: string, body: AppendChunksToUploadRequestBody, collectionName?: string, traceContext?: MediaTraceContext) => Promise<void>;
+    // (undocumented)
+    copyFileWithToken: (body: MediaStoreCopyFileWithTokenBody, params: MediaStoreCopyFileWithTokenParams, traceContext?: MediaTraceContext) => Promise<MediaStoreResponse<MediaFile>>;
+    // (undocumented)
+    createFileFromUpload: (body: MediaStoreCreateFileFromUploadBody, params: MediaStoreCreateFileFromUploadParams, traceContext?: MediaTraceContext) => Promise<MediaStoreResponse<MediaFile>>;
+    // (undocumented)
+    createUpload: (createUpTo: number, collectionName?: string, traceContext?: MediaTraceContext) => Promise<MediaStoreResponse<MediaUpload[]>>;
+    // (undocumented)
+    getArtifactURL: (artifacts: MediaFileArtifacts, artifactName: keyof MediaFileArtifacts, collectionName?: string) => Promise<string>;
+    // (undocumented)
+    getFile: (fileId: string, params: MediaStoreGetFileParams, traceContext?: MediaTraceContext) => Promise<MediaStoreResponse<MediaFile>>;
+    // (undocumented)
+    getFileBinaryURL: (id: string, collectionName?: string) => Promise<string>;
+    // (undocumented)
+    getFileImageURL: (id: string, params?: MediaStoreGetFileImageParams) => Promise<string>;
+    // (undocumented)
+    getFileImageURLSync: (id: string, params?: MediaStoreGetFileImageParams) => string;
+    // (undocumented)
+    getImage: (id: string, params?: MediaStoreGetFileImageParams, controller?: AbortController, fetchMaxRes?: boolean, traceContext?: MediaTraceContext) => Promise<Blob>;
+    // (undocumented)
+    getImageMetadata: (id: string, params?: MediaStoreGetFileImageParams, traceContext?: MediaTraceContext) => Promise<{
+        metadata: ImageMetadata;
+    }>;
+    // (undocumented)
+    getItems: (ids: string[], collectionName?: string, traceContext?: MediaTraceContext) => Promise<MediaStoreResponse<ItemsPayload>>;
+    // (undocumented)
+    getRejectedResponseFromDescriptor: (descriptor: TouchFileDescriptor, limit: number) => RejectedTouchFile;
+    // (undocumented)
+    probeChunks: (chunks: string[], uploadId: string, collectionName?: string, traceContext?: MediaTraceContext) => Promise<MediaStoreResponse<MediaChunksProbe>>;
+    // (undocumented)
+    removeCollectionFile: (id: string, collectionName: string, occurrenceKey?: string, traceContext?: MediaTraceContext) => Promise<void>;
+    // (undocumented)
+    request: (path: string, options: MediaStoreRequestOptions, controller?: AbortController) => Promise<Response>;
+    // (undocumented)
+    resolveAuth: (authContext?: AuthContext) => Promise<Auth>;
+    // (undocumented)
+    resolveInitialAuth: () => Auth;
+    // (undocumented)
+    touchFiles: (body: MediaStoreTouchFileBody, params: MediaStoreTouchFileParams, traceContext?: MediaTraceContext) => Promise<MediaStoreResponse<TouchedFiles>>;
+    // (undocumented)
+    uploadChunk: (etag: string, blob: Blob, uploadId: string, partNumber: number, collectionName?: string, traceContext?: MediaTraceContext) => Promise<void>;
+}
+
 // @public (undocumented)
 export interface MediaArtifact {
     // (undocumented)
@@ -590,7 +636,7 @@ export type MediaRepresentations = {
 };
 
 // @public (undocumented)
-export class MediaStore {
+export class MediaStore implements MediaApi {
     constructor(config: MediaApiConfig);
     // (undocumented)
     appendChunksToUpload(uploadId: string, body: AppendChunksToUploadRequestBody, collectionName?: string, traceContext?: MediaTraceContext): Promise<void>;