@atlaskit/media-file-preview 0.18.0 → 1.0.1

package/AGENTS.md

@@ -0,0 +1,59 @@
+# media-file-preview — Agent Guide
+
+> **Parent guide:** Always read [`../AGENTS.md`](../AGENTS.md) before working in this package — it
+> contains workspace-wide rules covering platform guidelines, changeset workflow, accessibility
+> standards, and the knowledge index protocol that applies to every Media package.
+
+## Package identity
+
+| Field    | Value                                                                                                                                      |
+| -------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
+| NPM name | `@atlaskit/media-file-preview`                                                                                                             |
+| Path     | `media-file-preview/`                                                                                                                      |
+| Owner    | Media Exif                                                                                                                                 |
+| Purpose  | React hooks for fetching and rendering media file previews — `useFilePreview` for general previews and `useMediaImage` for image rendering |
+
+## Knowledge index
+
+> Read, search, edit, investigate, and validate the repository knowledge index at
+> `.agents/knowledge-index/`. ALWAYS use this skill before making ANY repo change, or when exploring
+> the codebase. The knowledge index is the canonical starting point for every coding task in this
+> repo, trigger this skill aggressively whenever the user mentions architecture, conventions,
+> packages, modules, services, build, coding, writing code, APIs, feature flags, testing, or
+> anything similar. Also trigger when "is the knowledge index up to date?" / "update the knowledge
+> index" / "what does the knowledge index say about Y?" — even if they don't say the words
+> "knowledge index". Also use it (via the `validate` subcommand) to detect drift between the
+> codebase and the docs after any code change. Use the `generate` subcommand to bootstrap the index
+> in a new repository.
+
+**Entry point:** `.agents/knowledge-index/INDEX.md`
+**Unit doc:** `.agents/knowledge-index/domains/media/units/atlaskit-media-file-preview.md`
+**Standards page:** `.agents/knowledge-index/domains/media/units/atlaskit-media-file-preview/standards-and-patterns.md`
+**CLI:** `python3 .agents/skills/knowledge-index/scripts/kg.py {find,read,edit,investigate,validate,init,explore,generate} …`
+**Refresh protocol:** never silently bump `Last verified` — always re-read the listed `Sources` first, edit, then `kg.py edit <path> --message "<reason>"`.
+
+## Key source files
+
+- `src/index.ts` — public API entry point
+- `src/useFilePreview.tsx` — primary hook for file preview state
+- `src/useMediaImage.tsx` — hook for image blob URL resolution
+- `src/getPreview/` — preview resolution strategies per media type
+- `src/globalScope/` — browser globals abstraction (for SSR safety)
+- `src/types.ts` — shared type definitions
+- `src/errors.ts` — error types and predicates
+- `src/analytics.ts` — analytics event helpers
+
+## Public API (key exports)
+
+`useFilePreview`, `UseFilePreviewParams`, `useMediaImage`, `UseMediaImageParams`,
+`MediaFilePreview`, `isMediaFilePreviewError`, `MediaFilePreviewErrorPrimaryReason`
+
+## Development notes
+
+- React Compiler is enabled for this package
+- Peer dependencies: `react`, `react-dom`
+- 5 feature flags registered (see `package.json` → `platform-feature-flags`)
+- Includes SSR-safe preview behaviour
+- Export subpaths: `.`, `./errors`, `./types`, `./use-file-preview`, `./use-media-image`
+- All new behaviour changes must be behind a feature gate (`fg()` from
+  `@atlaskit/platform-feature-flags`)

package/CHANGELOG.md

@@ -1,5 +1,40 @@
 # @atlaskit/media-file-preview
 
+## 1.0.1
+
+### Patch Changes
+
+- [`ee28cf33718b0`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/ee28cf33718b0) -
+  Add @atlassian/react-compiler-gating as a runtime dependency to enable React Compiler platform
+  gating.
+- Updated dependencies
+
+## 1.0.0
+
+### Major Changes
+
+- [`f2dc9097319f0`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/f2dc9097319f0) - ###
+  Dropped support for _legacy_ Typescript 4 types. **Typescript 5 is now the new minimum**.
+
+  Removes the `typesVersions` property and `dist/types-ts4.5` directory from the dist.
+
+  Types are now exclusively via the `"types": "dist/types/index.d.ts"` property.
+
+  ```diff
+  - "typesVersions": {
+  -    ">=4.5 <4.9": {
+  -        "*": [
+  -            "dist/types-ts4.5/*",
+  -            "dist/types-ts4.5/index.d.ts"
+  -        ]
+  -    }
+  - },
+  ```
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 0.18.0
 
 ### Minor Changes

package/errors/package.json

@@ -4,12 +4,5 @@
   "module": "../dist/esm/errors.js",
   "module:es2019": "../dist/es2019/errors.js",
   "sideEffects": false,
-  "types": "../dist/types/errors.d.ts",
-  "typesVersions": {
-    ">=4.5 <5.9": {
-      "*": [
-        "../dist/types-ts4.5/errors.d.ts"
-      ]
-    }
-  }
+  "types": "../dist/types/errors.d.ts"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/media-file-preview",
-	"version": "0.18.0",
+	"version": "1.0.1",
 	"description": "A React Hook to fetch and render file previews. It's overloaded with fancy features like SSR, lazy loading, memory cache and local preview.",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -26,23 +26,16 @@
 	"module": "dist/esm/index.js",
 	"module:es2019": "dist/es2019/index.js",
 	"types": "dist/types/index.d.ts",
-	"typesVersions": {
-		">=4.5 <4.9": {
-			"*": [
-				"dist/types-ts4.5/*",
-				"dist/types-ts4.5/index.d.ts"
-			]
-		}
-	},
 	"sideEffects": false,
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
-		"@atlaskit/media-client": "^36.3.0",
-		"@atlaskit/media-client-react": "^5.2.0",
-		"@atlaskit/media-common": "^13.3.0",
-		"@atlaskit/media-ui": "^29.3.0",
-		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/react-ufo": "^6.5.0",
+		"@atlaskit/media-client": "^37.1.0",
+		"@atlaskit/media-client-react": "^6.0.0",
+		"@atlaskit/media-common": "^14.1.0",
+		"@atlaskit/media-ui": "^30.3.0",
+		"@atlaskit/platform-feature-flags": "^2.0.0",
+		"@atlaskit/react-ufo": "^7.1.0",
+		"@atlassian/react-compiler-gating": "^0.2.0",
 		"@babel/runtime": "^7.0.0",
 		"lru_map": "^0.4.1"
 	},
@@ -53,13 +46,12 @@
 	"devDependencies": {
 		"@af/integration-testing": "workspace:^",
 		"@af/visual-regression": "workspace:^",
-		"@atlaskit/media-state": "^2.2.0",
-		"@atlaskit/media-test-data": "^3.3.0",
-		"@atlaskit/section-message": "^8.13.0",
+		"@atlaskit/media-state": "^3.0.0",
+		"@atlaskit/media-test-data": "^4.0.0",
+		"@atlaskit/section-message": "^9.1.0",
 		"@atlaskit/ssr": "workspace:^",
-		"@atlassian/a11y-jest-testing": "^0.11.0",
+		"@atlassian/a11y-jest-testing": "^0.12.0",
 		"@atlassian/feature-flags-test-utils": "^1.1.0",
-		"@atlassian/react-compiler-gating": "workspace:^",
 		"@atlassian/testing-library": "^0.6.0",
 		"@testing-library/react": "^16.3.0",
 		"react": "^18.2.0",

package/types/package.json

@@ -4,12 +4,5 @@
   "module": "../dist/esm/types.js",
   "module:es2019": "../dist/es2019/types.js",
   "sideEffects": false,
-  "types": "../dist/types/types.d.ts",
-  "typesVersions": {
-    ">=4.5 <5.9": {
-      "*": [
-        "../dist/types-ts4.5/types.d.ts"
-      ]
-    }
-  }
+  "types": "../dist/types/types.d.ts"
 }

package/use-file-preview/package.json

@@ -4,12 +4,5 @@
   "module": "../dist/esm/useFilePreview.js",
   "module:es2019": "../dist/es2019/useFilePreview.js",
   "sideEffects": false,
-  "types": "../dist/types/useFilePreview.d.ts",
-  "typesVersions": {
-    ">=4.5 <5.9": {
-      "*": [
-        "../dist/types-ts4.5/useFilePreview.d.ts"
-      ]
-    }
-  }
+  "types": "../dist/types/useFilePreview.d.ts"
 }

package/use-media-image/package.json

@@ -4,12 +4,5 @@
   "module": "../dist/esm/useMediaImage.js",
   "module:es2019": "../dist/es2019/useMediaImage.js",
   "sideEffects": false,
-  "types": "../dist/types/useMediaImage.d.ts",
-  "typesVersions": {
-    ">=4.5 <5.9": {
-      "*": [
-        "../dist/types-ts4.5/useMediaImage.d.ts"
-      ]
-    }
-  }
+  "types": "../dist/types/useMediaImage.d.ts"
 }

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

@@ -1,30 +0,0 @@
-import { type MediaClientErrorReason } from '@atlaskit/media-client';
-import { type MediaTraceContext, type SuccessAttributes } from '@atlaskit/media-common';
-import { type MediaFilePreviewError, type MediaFilePreviewErrorPrimaryReason } from './errors';
-import { type MediaFilePreview } from './types';
-export type FailedErrorFailReason = MediaFilePreviewErrorPrimaryReason | 'nativeError';
-export type MediaFilePreviewErrorInfo = {
-    failReason: FailedErrorFailReason;
-    error: MediaClientErrorReason | 'nativeError';
-    errorDetail: string;
-    metadataTraceContext?: MediaTraceContext;
-};
-export type SSRStatusFail = MediaFilePreviewErrorInfo & {
-    status: 'fail';
-};
-type SSRStatusSuccess = SuccessAttributes;
-type SSRStatusUnknown = {
-    status: 'unknown';
-};
-type SSRStatusAttributes = SSRStatusSuccess | SSRStatusFail | SSRStatusUnknown;
-export type SSRStatus = {
-    server: SSRStatusAttributes;
-    client: SSRStatusAttributes;
-};
-export declare const getErrorTraceContext: (error: MediaFilePreviewError) => MediaTraceContext | undefined;
-export declare const getRenderErrorFailReason: (error: MediaFilePreviewError) => FailedErrorFailReason;
-export declare const getRenderErrorErrorReason: (error: MediaFilePreviewError) => MediaClientErrorReason | "nativeError";
-export declare const getRenderErrorErrorDetail: (error: MediaFilePreviewError) => string;
-export declare const extractErrorInfo: (error: MediaFilePreviewError, metadataTraceContext?: MediaTraceContext) => MediaFilePreviewErrorInfo;
-export declare const createFailedSSRObject: (preview: MediaFilePreview, metadataTraceContext?: MediaTraceContext) => SSRStatusFail;
-export {};

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

@@ -1,38 +0,0 @@
-import { type MediaFilePreview } from './types';
-/**
- * Primary reason is logged through Data Portal.
- * Make sure all the values are whitelisted in Measure -> Event Regitry -> "mediaCardRender failed" event
- */
-export type MediaFilePreviewErrorPrimaryReason = 'upload' | 'metadata-fetch' | 'error-file-state' | 'failed-processing' | RemotePreviewPrimaryReason | LocalPreviewPrimaryReason | ImageLoadPrimaryReason | SsrPreviewPrimaryReason | 'missing-error-data' | 'preview-fetch';
-export type ImageLoadPrimaryReason = 'cache-remote-uri' | 'cache-local-uri' | 'local-uri' | 'remote-uri' | 'external-uri' | 'ssr-client-uri' | 'ssr-server-uri' | 'unknown-uri';
-export type RemotePreviewPrimaryReason = 'remote-preview-fetch' | 'remote-preview-not-ready' | 'remote-preview-fetch-ssr';
-export type LocalPreviewPrimaryReason = 'local-preview-get' | 'local-preview-unsupported' | 'local-preview-rejected' | 'local-preview-image' | 'local-preview-video';
-export type SsrPreviewPrimaryReason = 'ssr-client-uri' | 'ssr-client-load' | 'ssr-server-uri' | 'ssr-server-load';
-export declare class MediaFilePreviewError extends Error {
-    readonly primaryReason: MediaFilePreviewErrorPrimaryReason;
-    readonly secondaryError?: Error | undefined;
-    constructor(primaryReason: MediaFilePreviewErrorPrimaryReason, secondaryError?: Error | undefined);
-}
-export declare class LocalPreviewError extends MediaFilePreviewError {
-    readonly primaryReason: LocalPreviewPrimaryReason;
-    readonly secondaryError?: Error | undefined;
-    constructor(primaryReason: LocalPreviewPrimaryReason, secondaryError?: Error | undefined);
-}
-export declare class RemotePreviewError extends MediaFilePreviewError {
-    readonly primaryReason: RemotePreviewPrimaryReason;
-    readonly secondaryError?: Error | undefined;
-    constructor(primaryReason: RemotePreviewPrimaryReason, secondaryError?: Error | undefined);
-}
-export declare class SsrPreviewError extends MediaFilePreviewError {
-    readonly primaryReason: SsrPreviewPrimaryReason;
-    readonly secondaryError?: Error | undefined;
-    constructor(primaryReason: SsrPreviewPrimaryReason, secondaryError?: Error | undefined);
-}
-export declare class ImageLoadError extends MediaFilePreviewError {
-    constructor(source?: MediaFilePreview['source']);
-}
-export declare function isMediaFilePreviewError(err: Error): err is MediaFilePreviewError;
-export declare const isLocalPreviewError: (err: Error) => err is LocalPreviewError;
-export declare const isRemotePreviewError: (err: Error) => err is RemotePreviewError;
-export declare const isUnsupportedLocalPreviewError: (err: Error) => boolean;
-export declare const ensureMediaFilePreviewError: (primaryReason: MediaFilePreviewErrorPrimaryReason, error: Error, updatePrimaryReason?: boolean) => MediaFilePreviewError;

package/dist/types-ts4.5/getPreview/cache.d.ts

@@ -1,25 +0,0 @@
-import { type MediaStoreGetFileImageParams } from '@atlaskit/media-client';
-import { type MediaFilePreview } from '../types';
-import { type ObjectURLCache } from './objectURLCache';
-type Mode = MediaStoreGetFileImageParams['mode'] | undefined;
-export declare const getCacheKey: (id: string, mode: Mode) => string;
-export interface MediaFilePreviewCache {
-    get(id: string, mode: Mode): MediaFilePreview | undefined;
-    set(id: string, mode: Mode, cardPreview: MediaFilePreview): void;
-    remove(id: string, mode: Mode): void;
-    clear(): void;
-    acquire(id: string, mode: Mode): void;
-    release(id: string, mode: Mode): void;
-}
-export declare class CardPreviewCacheImpl implements MediaFilePreviewCache {
-    private previewCache;
-    constructor(previewCache: ObjectURLCache);
-    get: (id: string, mode: Mode) => MediaFilePreview | undefined;
-    set: (id: string, mode: Mode, cardPreview: MediaFilePreview) => void;
-    remove: (id: string, mode: Mode) => void;
-    clear: () => void;
-    acquire: (id: string, mode: Mode) => void;
-    release: (id: string, mode: Mode) => void;
-}
-export declare const mediaFilePreviewCache: CardPreviewCacheImpl;
-export {};

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

@@ -1,22 +0,0 @@
-import { type FilePreview, type MediaBlobUrlAttrs, type MediaClient, type MediaStoreGetFileImageParams } from '@atlaskit/media-client';
-import { type MediaTraceContext, type SSR } from '@atlaskit/media-common';
-import { type MediaFilePreview, type MediaFilePreviewDimensions } from '../types';
-/**
- * Pull the CDN-signing query params (token / Policy / Key-Pair-Id / Signature
- * / Expires) out of a pre-signed CDN URL so they can be overlaid on a URL
- * built independently by `getImageUrlSync` (which constructs path, image
- * params, pathBased routing, wmv, etc.). Image-shape params from the cdn URL
- * itself (width/height/mode/...) are intentionally NOT extracted — those come
- * from `imageURLParams` via `getImageUrlSync`.
- *
- * Returns `{}` on parse failure so we degrade rather than throw.
- */
-export declare const extractCdnSigningParams: (cdnUrl: string) => Record<string, string>;
-export declare const getSSRPreview: (ssr: SSR, mediaClient: MediaClient, id: string, params: MediaStoreGetFileImageParams, mediaBlobUrlAttrs?: MediaBlobUrlAttrs, cdnSigningParams?: Record<string, string>) => MediaFilePreview;
-export declare const isLocalPreview: (preview: MediaFilePreview) => boolean;
-export declare const isRemotePreview: (preview: MediaFilePreview) => boolean;
-export declare const isSSRClientPreview: (preview: MediaFilePreview) => boolean;
-export declare const isSSRDataPreview: (preview: MediaFilePreview) => boolean;
-export declare const isSSRPreview: (preview: MediaFilePreview) => boolean;
-export declare const getAndCacheRemotePreview: (mediaClient: MediaClient, id: string, dimensions: MediaFilePreviewDimensions, params: MediaStoreGetFileImageParams, mediaBlobUrlAttrs?: MediaBlobUrlAttrs, traceContext?: MediaTraceContext) => Promise<MediaFilePreview>;
-export declare const getAndCacheLocalPreview: (mediaClient: MediaClient, id: string, filePreview: FilePreview | Promise<FilePreview>, dimensions: MediaFilePreviewDimensions, mode: MediaStoreGetFileImageParams["mode"], mediaBlobUrlAttrs?: MediaBlobUrlAttrs, collectionName?: string) => Promise<MediaFilePreview>;

package/dist/types-ts4.5/getPreview/helpers.d.ts

@@ -1,10 +0,0 @@
-import { type FilePreview, type MediaClient, type MediaStoreGetFileImageParams, type MediaType } from '@atlaskit/media-client';
-import { type MediaTraceContext } from '@atlaskit/media-common';
-import { type MediaFilePreview } from '../types';
-/**
- * This method tells the support for the media
- * types covered in getCardPreviewFromFilePreview
- */
-export declare const isSupportedLocalPreview: (mediaType?: MediaType) => mediaType is "video" | "image";
-export declare const getLocalPreview: (filePreview: FilePreview | Promise<FilePreview>) => Promise<MediaFilePreview>;
-export declare const getRemotePreview: (mediaClient: MediaClient, id: string, params: MediaStoreGetFileImageParams, traceContext?: MediaTraceContext) => Promise<MediaFilePreview>;

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

@@ -1,3 +0,0 @@
-export { mediaFilePreviewCache } from './cache';
-export { getSSRPreview, isLocalPreview, isRemotePreview, isSSRPreview, isSSRClientPreview, isSSRDataPreview, getAndCacheRemotePreview, getAndCacheLocalPreview, extractCdnSigningParams, } from './getPreview';
-export { isSupportedLocalPreview } from './helpers';

package/dist/types-ts4.5/getPreview/objectURLCache.d.ts

@@ -1,21 +0,0 @@
-import { type MediaFilePreview } from '../types';
-export declare const PREVIEW_CACHE_LRU_SIZE = 50;
-export declare class ObjectURLCache {
-    private readonly cache;
-    private readonly activeRefs;
-    constructor(size: number);
-    /**
-     * Marks a cache key as actively in use by a consumer.
-     * Multiple consumers can acquire the same key; eviction is
-     * blocked until all consumers have released it.
-     */
-    acquire(key: string): void;
-    release(key: string): void;
-    private isInUse;
-    has(key: string): boolean;
-    get(key: string): MediaFilePreview | undefined;
-    set(key: string, value: MediaFilePreview): void;
-    remove(key: string): void;
-    clear(): void;
-}
-export declare const createObjectURLCache: () => ObjectURLCache;

package/dist/types-ts4.5/getPreview/videoSnapshot.d.ts

@@ -1 +0,0 @@
-export declare const takeSnapshot: (blob: Blob) => Promise<string>;

package/dist/types-ts4.5/globalScope/getSSRData.d.ts

@@ -1,3 +0,0 @@
-import { type FileIdentifier, type ImageResizeMode } from '@atlaskit/media-client';
-import type { MediaCardSsrData } from './types';
-export declare const getSSRData: (identifier: FileIdentifier, resizeMode?: ImageResizeMode) => MediaCardSsrData | undefined;

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

@@ -1,23 +0,0 @@
-import type React from 'react';
-import { type FileIdentifier } from '@atlaskit/media-client';
-import { type NumericalCardDimensions } from '@atlaskit/media-common';
-import { type MediaFilePreviewErrorInfo } from '../analytics';
-import { type MediaCardSsr } from './types';
-export declare const GLOBAL_MEDIA_CARD_SSR = "mediaCardSsr";
-export declare const GLOBAL_MEDIA_COUNT_SSR = "mediaCountSsr";
-export declare const GLOBAL_MEDIA_PERFORMANCE_ENTRIES = "performanceEntries";
-export declare const GLOBAL_MEDIA_NAMESPACE = "__MEDIA_INTERNAL";
-export type MediaGlobalScope = {
-    [GLOBAL_MEDIA_CARD_SSR]?: MediaCardSsr;
-    [GLOBAL_MEDIA_COUNT_SSR]?: number;
-    [GLOBAL_MEDIA_PERFORMANCE_ENTRIES]?: PerformanceEntry[];
-};
-type MediaFeatureFlags = {
-    'media-perf-uplift-mutation-fix'?: boolean;
-    'media-perf-lazy-loading-optimisation'?: boolean;
-};
-export declare function getMediaGlobalScope(globalScope?: any): MediaGlobalScope;
-export declare function getMediaCardSSR(globalScope?: any): MediaCardSsr;
-export declare const getKey: ({ id, collectionName, occurrenceKey }: FileIdentifier, resizeMode?: string) => string;
-export declare const generateScriptProps: (identifier: FileIdentifier, dataURI?: string, mode?: string, srcSet?: string, dimensions?: Partial<NumericalCardDimensions>, error?: MediaFilePreviewErrorInfo, featureFlags?: MediaFeatureFlags) => React.ScriptHTMLAttributes<HTMLScriptElement>;
-export {};

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

@@ -1,4 +0,0 @@
-export { GLOBAL_MEDIA_NAMESPACE, GLOBAL_MEDIA_CARD_SSR, generateScriptProps, getKey, } from './globalScope';
-export { getSSRData } from './getSSRData';
-export type { MediaCardSsrData, MediaCardSsr } from './types';
-export type { MediaGlobalScope } from './globalScope';

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

@@ -1,12 +0,0 @@
-import { type NumericalCardDimensions } from '@atlaskit/media-common';
-import { type MediaFilePreviewErrorInfo } from '../analytics';
-export type MediaCardSsrData = {
-    dataURI?: string;
-    dimensions?: Partial<NumericalCardDimensions>;
-    error?: MediaFilePreviewErrorInfo;
-    mode?: string;
-    srcSet?: string;
-    loadPromise?: Promise<void>;
-    loading?: 'lazy' | '';
-};
-export type MediaCardSsr = Record<string, MediaCardSsrData>;

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

@@ -1,11 +0,0 @@
-import { type MutableRefObject } from 'react';
-import { type MediaFilePreviewDimensions } from './types';
-/**
- * Checks if at least one of next dimensions is bigger than current
- * If a single dimension is undefined, returns false
- */
-export declare const isBigger: (current?: MediaFilePreviewDimensions, next?: MediaFilePreviewDimensions) => boolean;
-export declare const isWider: (current?: MediaFilePreviewDimensions, next?: MediaFilePreviewDimensions) => boolean;
-export declare const createRequestDimensions: (dimensions: Partial<MediaFilePreviewDimensions>) => Partial<MediaFilePreviewDimensions> | undefined;
-/** Stores the provided value in a ref object to avoid "component rerenders" when the value is used as a hook dependency */
-export declare function useCurrentValueRef<T>(value: T): MutableRefObject<T>;

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

@@ -1,7 +0,0 @@
-export { useFilePreview } from './useFilePreview';
-export type { UseFilePreviewParams } from './useFilePreview';
-export { useMediaImage } from './useMediaImage';
-export type { UseMediaImageParams } from './useMediaImage';
-export type { MediaFilePreview } from './types';
-export { isMediaFilePreviewError } from './errors';
-export type { MediaFilePreviewErrorPrimaryReason } from './errors';

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

@@ -1,14 +0,0 @@
-export type MediaFilePreviewSource = 'local' | 'remote' | 'ssr-server' | 'ssr-client' | 'ssr-data' | 'cache-local' | 'cache-remote' | 'external';
-export type MediaFilePreviewDimensions = {
-    width?: number;
-    height?: number;
-};
-export interface MediaFilePreview {
-    dataURI: string;
-    srcSet?: string;
-    lazy?: boolean;
-    orientation?: number;
-    dimensions?: MediaFilePreviewDimensions;
-    source: MediaFilePreviewSource;
-}
-export type MediaFilePreviewStatus = 'loading' | 'complete' | 'error';

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

@@ -1,46 +0,0 @@
-import { type DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES, type ScriptHTMLAttributes } from 'react';
-import { type FileIdentifier, type FileState, type MediaBlobUrlAttrs, type MediaStoreGetFileImageParams } from '@atlaskit/media-client';
-import { type MediaTraceContext, type SSR } from '@atlaskit/media-common';
-import { type SSRStatus } from './analytics';
-import { MediaFilePreviewError } from './errors';
-import { type MediaFilePreview, type MediaFilePreviewDimensions, type MediaFilePreviewStatus } from './types';
-export interface UseFilePreviewParams {
-    /** Instance of file identifier. */
-    readonly identifier: FileIdentifier;
-    /** Resize the media to 'crop' | 'fit' | 'full-fit' */
-    readonly resizeMode?: MediaStoreGetFileImageParams['mode'];
-    /** Dimensions to be requested to the server. Will be scaled x2 in Retina Displays */
-    readonly dimensions?: MediaFilePreviewDimensions;
-    /** Server-Side-Rendering modes are "server" and "client" */
-    readonly ssr?: SSR;
-    /** Whether to use the srcSet for the preview. */
-    readonly useSrcSet?: boolean;
-    /** Attributes to attach to the created Blob Url */
-    readonly mediaBlobUrlAttrs?: MediaBlobUrlAttrs;
-    /** Trace context to be passed to the backend requests */
-    readonly traceContext?: MediaTraceContext;
-    /** Do not fetch a remote preview. Helpful for lazy loading */
-    readonly skipRemote?: boolean;
-    /** Define whether an animated image is acceptable to return */
-    readonly allowAnimated?: boolean;
-    /** Define the upscale strategy for this image. */
-    readonly upscale?: boolean;
-    /** Make the client receive the response with the given max-age cache control header. Minimum: 0, maximum: 9223372036854776000.
-     */
-    readonly maxAge?: number;
-    /** Defines the source component */
-    readonly source?: string;
-    /** Initial file state to be used for the preview. */
-    readonly initialFileState?: FileState;
-}
-export declare const useFilePreview: ({ resizeMode, identifier, ssr, dimensions, useSrcSet, traceContext, skipRemote, mediaBlobUrlAttrs, allowAnimated, upscale, maxAge, source, initialFileState, }: UseFilePreviewParams) => {
-    preview: MediaFilePreview | undefined;
-    status: MediaFilePreviewStatus;
-    error: MediaFilePreviewError | undefined;
-    nonCriticalError: MediaFilePreviewError | undefined;
-    ssrReliability: SSRStatus;
-    onImageError: (failedPreview?: MediaFilePreview) => void;
-    onImageLoad: (newPreview?: MediaFilePreview) => void;
-    getSsrScriptProps: (() => ScriptHTMLAttributes<HTMLScriptElement>) | undefined;
-    copyNodeRef: (instance: HTMLDivElement | HTMLImageElement | null) => void | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES];
-};

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

@@ -1,45 +0,0 @@
-import { type ScriptHTMLAttributes } from 'react';
-import { type FileIdentifier, type MediaBlobUrlAttrs, type MediaStoreGetFileImageParams } from '@atlaskit/media-client';
-import { type MediaTraceContext, type SSR } from '@atlaskit/media-common';
-import type { MediaFilePreviewError } from './errors';
-import { type MediaFilePreviewDimensions, type MediaFilePreviewSource, type MediaFilePreviewStatus } from './types';
-export interface UseMediaImageParams {
-    /** Instance of file identifier. */
-    readonly identifier: FileIdentifier;
-    /** Resize the media to 'crop' | 'fit' | 'full-fit' */
-    readonly resizeMode?: MediaStoreGetFileImageParams['mode'];
-    /** Dimensions to be requested to the server. Will be scaled x2 in Retina Displays */
-    readonly dimensions?: MediaFilePreviewDimensions;
-    /** Server-Side-Rendering modes are "server" and "client" */
-    readonly ssr?: SSR;
-    /** Attributes to attach to the created Blob Url */
-    readonly mediaBlobUrlAttrs?: MediaBlobUrlAttrs;
-    /** Trace context to be passed to the backend requests */
-    readonly traceContext?: MediaTraceContext;
-    /** Do not fetch a remote preview. Helpful for lazy loading */
-    readonly skipRemote?: boolean;
-    /** Define whether an animated image is acceptable to return */
-    readonly allowAnimated?: boolean;
-    /** Define the upscale strategy for this image. */
-    readonly upscale?: boolean;
-    /** Make the client receive the response with the given max-age cache control header. Minimum: 0, maximum: 9223372036854776000.
-     */
-    readonly maxAge?: number;
-    /** On image load and on error callback from the parent. We are keeping the name same to streamline the customer experience when using these properties back to their image components */
-    readonly onLoad?: () => void;
-    readonly onError?: () => void;
-}
-export declare const useMediaImage: ({ identifier, resizeMode, dimensions, ssr, mediaBlobUrlAttrs, traceContext, skipRemote, allowAnimated, upscale, maxAge, onLoad: onLoadCallback, onError: onErrorCallback, }: UseMediaImageParams) => {
-    status: MediaFilePreviewStatus;
-    error: MediaFilePreviewError | undefined;
-    getImgProps: () => {
-        src: string | undefined;
-        onLoad: () => void;
-        onError: () => void;
-        alt: string;
-        "data-test-file-id": string;
-        "data-test-collection": string | undefined;
-        "data-test-preview-source": MediaFilePreviewSource | undefined;
-    };
-    getSsrScriptProps: (() => ScriptHTMLAttributes<HTMLScriptElement>) | undefined;
-};