@strapi/upload 5.0.6 → 5.1.1

package/dist/admin/src/utils/containsAssetFilter.d.ts

@@ -0,0 +1,2 @@
+import type { Query } from '../../../shared/contracts/files';
+export declare const containsAssetFilter: (query: Query | null) => boolean;

package/dist/admin/src/utils/createAssetUrl.d.ts

@@ -0,0 +1,2 @@
+import type { File } from '../../../shared/contracts/files';
+export declare const createAssetUrl: (asset: File, forThumbnail?: boolean) => string | undefined;

package/dist/admin/src/utils/displayedFilters.d.ts

@@ -0,0 +1,22 @@
+export declare const displayedFilters: ({
+    name: string;
+    fieldSchema: {
+        type: string;
+        options?: undefined;
+    };
+    metadatas: {
+        label: string;
+    };
+} | {
+    name: string;
+    fieldSchema: {
+        type: string;
+        options: {
+            label: string;
+            value: string;
+        }[];
+    };
+    metadatas: {
+        label: string;
+    };
+})[];

package/dist/admin/src/utils/downloadFile.d.ts

@@ -0,0 +1 @@
+export declare const downloadFile: (url: string, fileName: string) => Promise<void>;

package/dist/admin/src/utils/findRecursiveFolderByValue.d.ts

@@ -0,0 +1,10 @@
+import type { FolderNode } from '../../../shared/contracts/folders';
+interface FolderStructureValue extends Omit<FolderNode, 'children'> {
+    value: number | null;
+    children?: FolderStructureValue[];
+}
+type Value = number | null | {
+    value: number | null;
+};
+export declare function findRecursiveFolderByValue(data: FolderStructureValue[], value: Value): undefined;
+export {};

package/dist/admin/src/utils/formatBytes.d.ts

@@ -0,0 +1 @@
+export declare function formatBytes(receivedBytes: number | string, decimals?: number): string;

package/dist/admin/src/utils/formatDuration.d.ts

@@ -0,0 +1 @@
+export declare const formatDuration: (durationInSecond: number) => string;

package/dist/admin/src/utils/getAPIInnerErrors.d.ts

@@ -0,0 +1,14 @@
+import type { FetchError } from '@strapi/admin/strapi-admin';
+import type { MessageDescriptor } from 'react-intl';
+type GetAPIInnerErrorsReturn = {
+    [key: string]: MessageDescriptor;
+};
+/**
+ *
+ * Returns a normalized error message
+ *
+ */
+export declare function getAPIInnerErrors(error: FetchError, { getTrad }: {
+    getTrad: (key: string) => string;
+}): string | GetAPIInnerErrorsReturn | undefined;
+export {};

package/dist/admin/src/utils/getAllowedFiles.d.ts

@@ -0,0 +1,15 @@
+import type { File } from '../../../shared/contracts/files';
+/**
+ * Returns the files that can be added to the media field
+ * @param {Object[]} pluralTypes Array of string (allowedTypes)
+ * @param {Object[]} files Array of files
+ * @returns Object[]
+ */
+interface AllowedFiles extends File {
+    documentId: string;
+    isSelectable: boolean;
+    locale: string | null;
+    type: string;
+}
+export declare const getAllowedFiles: (pluralTypes: string[], files: AllowedFiles[]) => AllowedFiles[];
+export {};

package/dist/admin/src/utils/getBreadcrumbDataCM.d.ts

@@ -0,0 +1,19 @@
+import type { Folder } from '../../../shared/contracts/folders';
+import type { MessageDescriptor } from 'react-intl';
+interface BreadcrumbDataFolder extends Omit<Folder, 'children' | 'files' | 'parent'> {
+    parent?: BreadcrumbDataFolder;
+    children?: {
+        count: number;
+    };
+    files?: {
+        count: number;
+    };
+}
+interface BreadcrumbItem {
+    id?: number | null;
+    label?: MessageDescriptor | string;
+    path?: string;
+}
+type BreadcrumbData = BreadcrumbItem | [];
+export declare const getBreadcrumbDataCM: (folder: BreadcrumbDataFolder | null) => BreadcrumbData[];
+export {};

package/dist/admin/src/utils/getBreadcrumbDataML.d.ts

@@ -0,0 +1,18 @@
+import type { Query } from '../../../shared/contracts/files';
+import type { Folder } from '../../../shared/contracts/folders';
+import type { MessageDescriptor } from 'react-intl';
+interface GetBreadcrumbDataMLProps {
+    folder: Folder;
+    options: {
+        pathname: string;
+        query?: Query;
+    };
+}
+interface GetBreadcrumbDataMLReturn {
+    id: number | null;
+    label: string | MessageDescriptor;
+    href?: string;
+}
+type BreadcrumbData = GetBreadcrumbDataMLReturn | [];
+export declare const getBreadcrumbDataML: (folder: GetBreadcrumbDataMLProps['folder'] | null, { pathname, query }: GetBreadcrumbDataMLProps['options']) => BreadcrumbData[];
+export default getBreadcrumbDataML;

package/dist/admin/src/utils/getFileExtension.d.ts

@@ -0,0 +1 @@
+export declare const getFileExtension: (ext?: string | null) => string | null | undefined;

package/dist/admin/src/utils/getFolderParents.d.ts

@@ -0,0 +1,10 @@
+import type { FolderNode } from '../../../shared/contracts/folders';
+interface FolderStructureValue extends Omit<FolderNode, 'children'> {
+    value: number | null;
+    children?: FolderStructureValue[];
+}
+export declare const getFolderParents: (folders: FolderStructureValue[], currentFolderId: number) => {
+    id: number | null | undefined;
+    label: string | undefined;
+}[];
+export {};

package/dist/admin/src/utils/getFolderURL.d.ts

@@ -0,0 +1,5 @@
+import type { Query } from '../../../shared/contracts/files';
+export declare const getFolderURL: (pathname: string, currentQuery: Query, { folder, folderPath }?: {
+    folder?: string;
+    folderPath?: string;
+}) => string;

package/dist/admin/src/utils/getTrad.d.ts

@@ -0,0 +1 @@
+export declare const getTrad: (id: string) => string;

package/dist/admin/src/utils/index.d.ts

@@ -0,0 +1,25 @@
+export * from './appendSearchParamsToUrl';
+export * from './containsAssetFilter';
+export * from './createAssetUrl';
+export * from './displayedFilters';
+export * from './downloadFile';
+export * from './findRecursiveFolderByValue';
+export * from './formatBytes';
+export * from './formatDuration';
+export * from './getAllowedFiles';
+export * from './getAPIInnerErrors';
+export * from './getBreadcrumbDataCM';
+export * from './getBreadcrumbDataML';
+export * from './getFileExtension';
+export * from './getFolderParents';
+export * from './getFolderURL';
+export * from './getTrad';
+export * from './moveElement';
+export * from './normalizeAPIError';
+export * from './prefixFileUrlWithBackendUrl';
+export * from './prefixPluginTranslations';
+export * from './rawFileToAsset';
+export * from './toSingularTypes';
+export * from './typeFromMime';
+export * from './urlsToAssets';
+export * from './urlYupSchema';

package/dist/admin/src/utils/moveElement.d.ts

@@ -0,0 +1 @@
+export declare const moveElement: (array: number[], index: number, offset: number) => number[];

package/dist/admin/src/utils/normalizeAPIError.d.ts

@@ -0,0 +1,22 @@
+import type { FetchError } from '@strapi/admin/strapi-admin';
+interface NormalizeErrorOptions {
+    name?: string;
+    intlMessagePrefixCallback?: (id: string) => string;
+}
+interface NormalizeErrorReturn {
+    id: string;
+    defaultMessage: string;
+    name?: string;
+    values: Record<'path', string> | Record<string, never>;
+}
+/**
+ * Normalize the format of `ResponseError`
+ * in places where the hook `useAPIErrorHandler` can not called
+ * (e.g. outside of a React component).
+ */
+export declare function normalizeAPIError(apiError: FetchError, intlMessagePrefixCallback?: NormalizeErrorOptions['intlMessagePrefixCallback']): NormalizeErrorReturn | {
+    name: string;
+    message: string | null;
+    errors: NormalizeErrorReturn[];
+} | null;
+export {};

package/dist/admin/src/utils/prefixFileUrlWithBackendUrl.d.ts

@@ -0,0 +1 @@
+export declare const prefixFileUrlWithBackendUrl: (fileURL?: string) => string | undefined;

package/dist/admin/src/utils/prefixPluginTranslations.d.ts

@@ -0,0 +1,5 @@
+type Translations = {
+    [key: string]: string;
+};
+export declare const prefixPluginTranslations: (trad: Translations, pluginId?: string) => Translations;
+export {};

package/dist/admin/src/utils/rawFileToAsset.d.ts

@@ -0,0 +1,14 @@
+import { AssetSource } from '../newConstants';
+import type { RawFile } from '../../../shared/contracts/files';
+export declare const rawFileToAsset: (rawFile: RawFile, assetSource: AssetSource) => {
+    size: number;
+    createdAt: string;
+    name: string;
+    source: AssetSource;
+    type: import("../newConstants").AssetType;
+    url: string;
+    ext: string | undefined;
+    mime: string;
+    rawFile: RawFile;
+    isLocal: boolean;
+};

package/dist/admin/src/utils/toSingularTypes.d.ts

@@ -0,0 +1,2 @@
+export declare const toSingularTypes: (types?: string[]) => string[];
+export default toSingularTypes;

package/dist/admin/src/utils/typeFromMime.d.ts

@@ -0,0 +1,2 @@
+import { AssetType } from '../newConstants';
+export declare const typeFromMime: (mime: string) => AssetType;

package/dist/admin/src/utils/urlYupSchema.d.ts

@@ -0,0 +1,8 @@
+import * as yup from 'yup';
+export declare const urlSchema: yup.default<import("yup/lib/object").Assign<import("yup/lib/object").ObjectShape, {
+    urls: yup.default<string | undefined, Record<string, any>, string | undefined>;
+}>, Record<string, any>, import("yup/lib/object").TypeOfShape<import("yup/lib/object").Assign<import("yup/lib/object").ObjectShape, {
+    urls: yup.default<string | undefined, Record<string, any>, string | undefined>;
+}>>, import("yup/lib/object").AssertsShape<import("yup/lib/object").Assign<import("yup/lib/object").ObjectShape, {
+    urls: yup.default<string | undefined, Record<string, any>, string | undefined>;
+}>>>;

package/dist/admin/src/utils/urlsToAssets.d.ts

@@ -0,0 +1,10 @@
+import { AssetSource } from '../newConstants';
+export declare const urlsToAssets: (urls: string[]) => Promise<{
+    source: AssetSource;
+    name: string;
+    type: import("../newConstants").AssetType;
+    url: string;
+    ext: string | undefined;
+    mime: string | null;
+    rawFile: File;
+}[]>;

package/dist/shared/contracts/configuration.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Used to store the media library configuration.
+ * E.g the page size, the sort.
+ */
+import { errors } from '@strapi/utils';
+import { Utils } from '@strapi/types';
+type SortOrder = 'ASC' | 'DESC';
+type SortKey = 'createdAt' | 'name' | 'updatedAt';
+export interface Configuration {
+    pageSize: number;
+    sort: `${SortKey}:${SortOrder}`;
+}
+/**
+ * GET /upload/configuration
+ *
+ * Return the configuration for the media files.
+ */
+export declare namespace GetConfiguration {
+    interface Request {
+        query?: {};
+    }
+    interface Response {
+        data: {
+            data: Configuration;
+        };
+        error?: errors.ApplicationError | errors.NotFoundError;
+    }
+}
+/**
+ * PUT /upload/configuration
+ *
+ * Update the configuration
+ */
+export declare namespace UpdateConfiguration {
+    interface Request {
+        body: Configuration;
+    }
+    type Response = Utils.OneOf<{
+        data: Configuration;
+    }, {
+        error?: errors.ApplicationError | errors.ValidationError;
+    }>;
+}
+export {};

package/dist/shared/contracts/files.d.ts

@@ -0,0 +1,207 @@
+import { errors } from '@strapi/utils';
+type SortOrder = 'ASC' | 'DESC';
+type SortKey = 'createdAt' | 'name' | 'updatedAt';
+type ComparisonOperators<T> = {
+    [operator: string]: T | T[] | boolean;
+};
+export type FilterCondition<T> = {
+    [field: string]: T | ComparisonOperators<T> | FilterCondition<T>;
+};
+type Filters<T> = {
+    [logicOperator: string]: FilterCondition<T>[];
+};
+export type Query = {
+    _q?: string;
+    folderPath?: string;
+    folder?: null | number | {
+        id: number;
+    };
+    page?: string | number | {
+        id: string | number;
+    };
+    pageSize?: string | number;
+    pagination?: {
+        pageSize: number;
+    };
+    sort?: `${SortKey}:${SortOrder}`;
+    filters?: Filters<string | number | boolean>;
+    state?: boolean;
+};
+type FileFormat = {
+    name: string;
+    hash: string;
+    ext: string;
+    mime: string;
+    path: null | string;
+    width: number;
+    height: number;
+    size: number;
+    sizeInBytes: number;
+    url: string;
+};
+export interface File {
+    id: number;
+    name: string;
+    alternativeText?: string | null;
+    caption?: string | null;
+    width?: number;
+    height?: number;
+    formats?: Record<string, FileFormat>;
+    hash: string;
+    ext?: string;
+    mime?: string;
+    size?: number;
+    sizeInBytes?: number;
+    url?: string;
+    previewUrl?: string;
+    path?: string | null;
+    provider?: string;
+    provider_metadata?: Record<string, unknown>;
+    isUrlSigned?: boolean;
+    folder?: number | null;
+    folderPath?: string;
+    related?: {
+        id: string | number;
+        __type: string;
+        __pivot: {
+            field: string;
+        };
+    }[];
+    createdAt?: string;
+    updatedAt?: string;
+    createdBy?: number;
+    publishedAt?: string;
+    updatedBy?: number;
+    isLocal?: boolean;
+}
+export interface RawFile extends Blob {
+    size: number;
+    lastModified: number;
+    name: string;
+    type: string;
+}
+export interface Pagination {
+    page: number;
+    pageSize: number;
+    pageCount: number;
+    total: number;
+}
+/**
+ * GET /upload/files - Get files
+ */
+export declare namespace GetFiles {
+    interface Request {
+        body: {};
+        query: {
+            page?: string;
+            pageSize?: string;
+            folder: number | null;
+            sort?: `${SortKey}:${SortOrder}`;
+        };
+    }
+    interface Response {
+        data: {
+            results: File[];
+            pagination: Pagination;
+        };
+        error?: errors.ApplicationError | errors.NotFoundError;
+    }
+}
+/**
+ * GET /upload/files/:id - Get specific file
+ */
+export declare namespace GetFile {
+    interface Request {
+        params: {
+            id: number;
+        };
+        query: {};
+    }
+    interface Response {
+        data: File;
+        error?: errors.ApplicationError | errors.NotFoundError;
+    }
+}
+/**
+ * POST /upload/actions/bulk-delete - Delete Files
+ */
+export declare namespace BulkDeleteFiles {
+    interface Request {
+        body: {
+            fileIds: number[];
+        };
+    }
+    interface Response {
+        data: {
+            data: {
+                files: File[];
+                folders: [];
+            };
+        };
+        error?: errors.ApplicationError | errors.ValidationError;
+    }
+}
+/**
+ * POST /upload/actions/bulk-move - Move Files
+ */
+export declare namespace BulkMoveFiles {
+    interface Request {
+        body: {
+            fileIds: number[];
+            destinationFolderId: number;
+        };
+    }
+    interface Response {
+        data: {
+            data: {
+                files: File[];
+                folders: [];
+            };
+        };
+        error?: errors.ApplicationError | errors.ValidationError;
+    }
+}
+/**
+ * DELETE /upload/files/:id - Delete a specific asset
+ */
+export declare namespace DeleteFile {
+    interface Request {
+        params: {
+            id: number;
+        };
+        query: {};
+    }
+    interface Response {
+        data: File;
+        error?: errors.ApplicationError | errors.NotFoundError;
+    }
+}
+/**
+ * POST /upload - Create a file
+ */
+export declare namespace CreateFile {
+    interface Request {
+        body: FormData;
+        files: File[];
+    }
+    interface Response {
+        data: File[];
+        error?: errors.ApplicationError | errors.ValidationError;
+    }
+}
+/**
+ * POST /upload?id=:id - Update asset
+ */
+export declare namespace UpdateFile {
+    interface Request {
+        body: FormData;
+        params: {
+            id: number;
+        };
+    }
+    interface Response {
+        data: File;
+        error?: errors.ApplicationError | errors.ValidationError;
+    }
+}
+export {};

package/dist/shared/contracts/folders.d.ts

@@ -0,0 +1,140 @@
+import { errors } from '@strapi/utils';
+export type SortOrder = 'ASC' | 'DESC';
+export type SortKey = 'createdAt' | 'name' | 'updatedAt';
+import type { File } from './files';
+export interface Folder {
+    id: number;
+    name: string;
+    pathId?: number;
+    /**
+     * parent id
+     */
+    parent?: number | null | Folder;
+    /**
+     * children ids
+     */
+    children?: number[];
+    path?: string;
+    files?: File[];
+}
+export type FolderNode = Partial<Omit<Folder, 'children'>> & {
+    children: FolderNode[];
+};
+/**
+ * GET /upload/folders/:id - Get specific folder
+ */
+export declare namespace GetFolder {
+    interface Request {
+        params: {
+            id: number;
+        };
+        query: {};
+    }
+    interface Response {
+        data: Folder;
+        error?: errors.ApplicationError | errors.NotFoundError;
+    }
+}
+/**
+ * GET /upload/folders - Get folders
+ */
+export declare namespace GetFolders {
+    interface Request {
+        body: {};
+        query: {
+            page?: string;
+            pageSize?: string;
+            sort?: `${SortKey}:${SortOrder}`;
+        };
+    }
+    interface Response {
+        data: Folder[];
+        error?: errors.ApplicationError | errors.NotFoundError;
+    }
+}
+/**
+ * POST /upload/folders - Create folders
+ */
+export declare namespace CreateFolders {
+    interface Request {
+        body: Pick<Folder, 'name' | 'parent'>;
+    }
+    interface Response {
+        data: Folder;
+        error?: errors.ApplicationError | errors.ValidationError;
+    }
+}
+/**
+ * PUT /upload/folders/:id - Update a specific folder
+ */
+export declare namespace UpdateFolder {
+    interface Request {
+        params: {
+            id: number;
+        };
+        query: {};
+        body: {
+            name: string;
+            parent: number | null;
+        };
+    }
+    interface Response {
+        data: Folder;
+        error?: errors.ApplicationError | errors.NotFoundError;
+    }
+}
+/**
+ * GET /upload/folder-structure
+ *
+ * Return the structure of a folder.
+ */
+export declare namespace GetFolderStructure {
+    interface Request {
+        query?: {};
+    }
+    interface Response {
+        data: {
+            data: number[] & FolderNode[];
+        };
+        error?: errors.ApplicationError | errors.NotFoundError;
+    }
+}
+/**
+ * POST /upload/actions/bulk-delete - Delete Folder
+ */
+export declare namespace BulkDeleteFolders {
+    interface Request {
+        body: {
+            folderIds: number[];
+        };
+    }
+    interface Response {
+        data: {
+            data: {
+                files: [];
+                folders: Folder[];
+            };
+        };
+        error?: errors.ApplicationError | errors.ValidationError;
+    }
+}
+/**
+ * POST /upload/actions/bulk-move - Move Folder
+ */
+export declare namespace BulkMoveFolders {
+    interface Request {
+        body: {
+            folderIds: number[];
+            destinationFolderId: number;
+        };
+    }
+    interface Response {
+        data: {
+            data: {
+                files: [];
+                folders: Folder[];
+            };
+        };
+        error?: errors.ApplicationError | errors.ValidationError;
+    }
+}