@bluealba/pae-ui-react-core 4.6.0 → 4.7.0

package/dist/src/hooks/file-storage/index.d.ts

@@ -0,0 +1,2 @@
+export { useFileStorage } from './useFileStorage';
+export type { FileDto, UploadOptions, UpdateMetadataOptions, UseFileStorageResult } from './types';

package/dist/src/hooks/file-storage/types.d.ts

@@ -0,0 +1,35 @@
+export interface FileDto {
+    id: number;
+    originalName: string;
+    mimeType: string;
+    extension: string;
+    size: number;
+    isPublic: boolean;
+    description?: string;
+    metadata?: Record<string, unknown>;
+    url: string;
+    createdBy: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface UploadOptions {
+    isPublic?: boolean;
+    description?: string;
+    metadata?: Record<string, unknown>;
+    onProgress?: (percent: number) => void;
+    signal?: AbortSignal;
+}
+export interface UpdateMetadataOptions {
+    originalName?: string;
+    isPublic?: boolean;
+    description?: string;
+    metadata?: Record<string, unknown>;
+}
+export interface UseFileStorageResult {
+    isEnabled: boolean;
+    upload(file: File, options?: UploadOptions): Promise<FileDto>;
+    updateMetadata(id: number, options: UpdateMetadataOptions): Promise<FileDto>;
+    remove(id: number): Promise<void>;
+    download(id: number): Promise<void>;
+    getPreviewUrl(id: number): Promise<string>;
+}

package/dist/src/hooks/file-storage/uploadWithProgress.d.ts

@@ -0,0 +1,7 @@
+export declare function uploadWithProgress<T>(opts: {
+    url: string;
+    method: 'POST' | 'PATCH';
+    formData: FormData;
+    onProgress?: (percent: number) => void;
+    signal?: AbortSignal;
+}): Promise<T>;

package/dist/src/hooks/file-storage/uploadWithProgress.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/hooks/file-storage/useFileStorage.d.ts

@@ -0,0 +1,9 @@
+import { UseFileStorageResult } from './types';
+
+/**
+ * Hook providing client-side access to the platform File Storage API.
+ *
+ * The hook is a no-op when `fileStorageEnabled` is `false` in the platform state —
+ * every method will reject with a descriptive error.
+ */
+export declare function useFileStorage(): UseFileStorageResult;

package/dist/src/hooks/file-storage/useFileStorage.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/hooks/index.d.ts

@@ -43,3 +43,5 @@ export { useResource } from './commons/useResource';
 export { useTenants } from './tenants/useTenants';
 export { useUserState } from './userState/useUserState';
 export { useAppStatus } from './useAppStatus';
+export { useFileStorage } from './file-storage/useFileStorage';
+export type { FileDto, UploadOptions, UpdateMetadataOptions, UseFileStorageResult } from './file-storage/types';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bluealba/pae-ui-react-core",
-  "version": "4.6.0",
+  "version": "4.7.0",
   "type": "module",
   "main": "./dist/index.cjs.js",
   "module": "./dist/index.esm.js",