@atlaskit/media-client 36.3.3 → 36.4.0

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

@@ -1,34 +0,0 @@
-import { type Executor } from './types';
-export { PollingError, isPollingError } from './errors';
-export interface PollingOptions {
-    poll_intervalMs: number;
-    poll_maxAttempts: number;
-    poll_backoffFactor: number;
-    poll_maxIntervalMs: number;
-}
-export declare const defaultPollingOptions: PollingOptions;
-/**
- * This class encapsulates polling functionality with the following features:
- *
- *  - async executor function provides each attempt
- *  - executor will only repeat defined max amount of times (options)
- *  - each attempt uses a timeout to the next attempt by an interval (ms)
- *  - each attempt increases the timeout interval by a "poll_backoffFactor"
- *  - if max attempts are exceeded or executor has exception then onError handler is called
- *
- * IMPORTANT! the executor function must explicitly call ".next()" for the next iteration to run
- */
-export declare class PollingFunction {
-    options: PollingOptions;
-    poll_intervalMs: number;
-    attempt: number;
-    shouldIterate: boolean;
-    onError?: (error: Error) => void;
-    timeoutId: number;
-    constructor(options?: Partial<PollingOptions>);
-    execute(executor: Executor): Promise<void>;
-    private fail;
-    getIntervalMsForIteration(iteration: number): number;
-    next(): void;
-    cancel(): void;
-}

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

@@ -1,10 +0,0 @@
-export type Executor = () => Promise<void>;
-export type PollingErrorReason = 'pollingMaxAttemptsExceeded';
-export type PollingErrorMetadata = {
-    attempts: number;
-};
-export type PollingErrorAttributes = {
-    readonly reason: PollingErrorReason;
-    readonly attempts: number;
-    readonly innerError?: Error;
-};

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

@@ -1,22 +0,0 @@
-import type { MediaTraceContext } from '@atlaskit/media-common';
-import { BaseMediaClientError } from '../../models/errors';
-import { type RequestErrorReason, type RequestErrorMetadata, type RequestErrorAttributes, type RequestMethod } from './types';
-export declare class RequestError extends BaseMediaClientError<RequestErrorReason, RequestErrorMetadata | undefined, Error | undefined, RequestErrorAttributes> {
-    constructor(reason: RequestErrorReason, metadata?: RequestErrorMetadata, innerError?: Error);
-    /** Will be deprecated. Use the properties `reason` and `metadata` instead */
-    get attributes(): {
-        reason: RequestErrorReason;
-        method: RequestMethod | undefined;
-        endpoint: string | undefined;
-        mediaRegion: string | undefined;
-        mediaEnv: string | undefined;
-        attempts: number | undefined;
-        clientExhaustedRetries: boolean | undefined;
-        statusCode: number | undefined;
-        metadata: {
-            traceContext: MediaTraceContext | undefined;
-        };
-        innerError: Error | undefined;
-    };
-}
-export declare function isRequestError(err: Error): err is RequestError;

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

@@ -1,32 +0,0 @@
-import { type Auth } from '@atlaskit/media-core';
-import { type MediaTraceContext } from '@atlaskit/media-common';
-import { RequestError } from './errors';
-import { type CreateUrlOptions, type RequestErrorReason, type RequestErrorMetadata, type RequestHeaders, type RequestMetadata, type RetryOptions } from './types';
-export declare function waitPromise(timeout: number): Promise<void>;
-export declare function isAbortedRequestError(err: any): boolean;
-export declare function isFetchNetworkError(err: any): err is TypeError;
-export declare function isRateLimitedError(error: Error | undefined): boolean;
-export declare const extendTraceContext: (traceContext?: MediaTraceContext) => Required<MediaTraceContext> | undefined;
-export declare const ZipkinHeaderKeys: {
-    traceId: string;
-    spanId: string;
-    parentSpanId: string;
-    sampled: string;
-    flags: string;
-};
-export declare function mapAuthToRequestHeaders(auth?: Auth): RequestHeaders;
-export declare function createUrl(url: string, { params, auth }: CreateUrlOptions): string;
-export declare function extendHeaders(headers?: RequestHeaders, auth?: Auth, traceContext?: Required<MediaTraceContext>): RequestHeaders | undefined;
-export declare function createMapResponseToJson(metadata: RequestMetadata): (response: Response) => Promise<any>;
-export declare function createMapResponseToBlob(metadata: RequestMetadata): (response: Response) => Promise<Blob>;
-export declare const defaultShouldRetryError: (err: any) => boolean;
-export declare const DEFAULT_RETRY_OPTIONS: RetryOptions;
-export declare function cloneRequestError(error: RequestError, extraMetadata: Partial<RequestErrorMetadata>): RequestError;
-export declare function fetchRetry(functionToRetry: () => Promise<Response>, metadata: RequestMetadata, overwriteOptions?: Partial<RetryOptions>): Promise<Response>;
-export declare function createRequestErrorReason(statusCode: number): RequestErrorReason;
-export declare function createRequestErrorFromResponse(metadata: RequestErrorMetadata, response: Response): RequestError;
-export declare function createProcessFetchResponse(metadata: RequestMetadata): (response: Response) => Response;
-export declare function extractMediaHeaders(response: Response): {
-    mediaRegion: string;
-    mediaEnv: string;
-};

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

@@ -1,5 +0,0 @@
-import { type RequestOptions } from './types';
-export type { RequestErrorReason, RequestErrorMetadata, RequestErrorAttributes } from './types';
-export { RequestError, isRequestError } from './errors';
-export { isRateLimitedError, createRequestErrorReason } from './helpers';
-export declare function request(url: string, options?: RequestOptions, controller?: AbortController): Promise<Response>;

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

@@ -1,47 +0,0 @@
-import { type Auth } from '@atlaskit/media-core';
-import type { MediaTraceContext } from '@atlaskit/media-common';
-export type RequestMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'HEAD';
-export type RequestParams = {
-    [key: string]: any;
-};
-export type RequestHeaders = {
-    [key: string]: string;
-};
-export type RetryOptions = {
-    readonly startTimeoutInMs: number;
-    readonly maxAttempts: number;
-    readonly factor: number;
-    readonly shouldRetryError?: (err: any) => boolean;
-};
-export type ClientOptions = {
-    readonly retryOptions?: Partial<RetryOptions>;
-    readonly clientTimeout?: number;
-};
-export type RequestMetadata = {
-    readonly method?: RequestMethod;
-    readonly endpoint?: string;
-    readonly mediaRegion?: string;
-    readonly mediaEnv?: string;
-    readonly traceContext?: MediaTraceContext;
-};
-export type RequestOptions = RequestMetadata & {
-    readonly auth?: Auth;
-    readonly traceContext?: Required<MediaTraceContext>;
-    readonly params?: RequestParams;
-    readonly headers?: RequestHeaders;
-    readonly body?: any;
-    readonly clientOptions?: ClientOptions;
-};
-export type CreateUrlOptions = {
-    readonly params?: RequestParams;
-    readonly auth?: Auth;
-};
-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;
-    readonly statusCode?: number;
-};
-export type RequestErrorAttributes = RequestErrorMetadata & {
-    readonly reason: RequestErrorReason;
-};

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

@@ -1,2 +0,0 @@
-export declare const resolveTimeout: <T>(timeout: number, resolveWith: T) => Promise<T>;
-export declare const rejectTimeout: (timeout: number, rejectWith: Error) => Promise<undefined>;

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

@@ -1,14 +0,0 @@
-import { type FilePreview } from '@atlaskit/media-state';
-import { type MediaType } from '../models/media';
-/**
- * Async helper determining if we should fetch remote fileStates from the backend:
- * - we poll the backend for all supported documents,
- * - we poll the backend is mimeType isn't natively supported by the browser,
- * - we poll the backend if we don't have a local preview available.
- * - we poll the backend if we have a video with which we can't extract dimensions,
- *
- * Polling the backend periodically refreshes the cached fileState until the file is processed.
- * Polling is needed for the use cases above to properly render the file in our components.
- *
- */
-export declare function shouldFetchRemoteFileStates(mediaType: MediaType, mimeType: string, preview?: FilePreview | Promise<FilePreview>): Promise<boolean>;

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

@@ -1,18 +0,0 @@
-export declare const isMediaBlobUrl: (url: string) => boolean;
-export interface MediaBlobUrlAttrs {
-    id: string;
-    contextId: string;
-    clientId?: string;
-    collection?: string;
-    size?: number;
-    name?: string;
-    mimeType?: string;
-    width?: number;
-    height?: number;
-    alt?: string;
-}
-export declare const getAttrsFromUrl: (blobUrl: string) => MediaBlobUrlAttrs | undefined;
-export declare const objectToQueryString: (json: {
-    [key: string]: string | number | boolean | undefined | null;
-}) => string;
-export declare const addFileAttrsToUrl: (url: string, fileAttrs: MediaBlobUrlAttrs) => string;

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

@@ -1,10 +0,0 @@
-/**
- * Extracts the watermark version string from a JWT auth token.
- *
- * The token payload may contain a `watermark` field, which is a JSON-encoded
- * string like `{"v":"WjtFdA","ari":"ari:cloud:confluence:..."}`.
- *
- * Returns the `v` value if present, or `undefined` if the token has no
- * watermark or cannot be decoded.
- */
-export declare function getWatermarkVersionFromToken(token: string): string | undefined;