@dereekb/firebase-server 13.12.9 → 13.13.0

package/model/src/lib/storagefile/storagefile.action.server.d.ts

@@ -1,4 +1,4 @@
-import { type FirestoreContextReference, type InitializeStorageFileFromUploadParams, type AsyncStorageFileCreateAction, type StorageFileFirestoreCollections, type ProcessStorageFileParams, type StorageFileDocument, type ProcessStorageFileResult, type CreateStorageFileParams, type AsyncStorageFileUpdateAction, type UpdateStorageFileParams, type NotificationFirestoreCollections, type FirebaseStorageAccessorFile, type InitializeAllStorageFilesFromUploadsResult, type InitializeAllStorageFilesFromUploadsParams, type ProcessAllQueuedStorageFilesParams, type ProcessAllQueuedStorageFilesResult, type DeleteAllQueuedStorageFilesParams, type DeleteAllQueuedStorageFilesResult, type DeleteStorageFileParams, type AsyncStorageFileDeleteAction, type StorageFile, type DownloadStorageFileParams, type DownloadStorageFileResult, type DownloadMultipleStorageFilesParams, type DownloadMultipleStorageFilesResult, type DownloadMultipleStorageFileSuccessItem, type FirestoreModelKey, type SyncStorageFileWithGroupsParams, type SyncAllFlaggedStorageFilesWithGroupsParams, type SyncAllFlaggedStorageFilesWithGroupsResult, type SyncStorageFileWithGroupsResult, type RegenerateAllFlaggedStorageFileGroupsContentParams, type RegenerateAllFlaggedStorageFileGroupsContentResult, type RegenerateStorageFileGroupContentParams, type RegenerateStorageFileGroupContentResult, type StorageFileGroupDocument, type AsyncStorageFileGroupCreateAction, type CreateStorageFileGroupParams, type Transaction, type StorageFileGroup, type StorageFileGroupDocumentReferencePair, type StorageFileGroupId, type UpdateStorageFileGroupParams, type DownloadStorageFileOptions, type CreateStorageFileSignedUploadUrlParams, type CreateStorageFileSignedUploadUrlResult, type StorageFilePurposeUploadPolicy, type FirebaseAuthUserId, type AsyncFirebaseFunctionCreateAction } from '@dereekb/firebase';
+import { type FirestoreContextReference, type InitializeStorageFileFromUploadParams, type AsyncStorageFileCreateAction, type StorageFileFirestoreCollections, type ProcessStorageFileParams, type StorageFileDocument, type ProcessStorageFileResult, type CreateStorageFileParams, type AsyncStorageFileUpdateAction, type UpdateStorageFileParams, type NotificationFirestoreCollections, type FirebaseStorageAccessorFile, type InitializeAllStorageFilesFromUploadsResult, type InitializeAllStorageFilesFromUploadsParams, type ProcessAllQueuedStorageFilesParams, type ProcessAllQueuedStorageFilesResult, type DeleteAllQueuedStorageFilesParams, type DeleteAllQueuedStorageFilesResult, type DeleteStorageFileParams, type AsyncStorageFileDeleteAction, type StorageFile, type DownloadStorageFileParams, type DownloadStorageFileResult, type DownloadMultipleStorageFilesParams, type DownloadMultipleStorageFilesResult, type DownloadMultipleStorageFileSuccessItem, type ReadStorageFileMetadataParams, type ReadStorageFileMetadataResult, type ReadMultipleStorageFilesMetadataParams, type ReadMultipleStorageFilesMetadataResult, type ReadMultipleStorageFileMetadataSuccessItem, type FirestoreModelKey, type SyncStorageFileWithGroupsParams, type SyncAllFlaggedStorageFilesWithGroupsParams, type SyncAllFlaggedStorageFilesWithGroupsResult, type SyncStorageFileWithGroupsResult, type RegenerateAllFlaggedStorageFileGroupsContentParams, type RegenerateAllFlaggedStorageFileGroupsContentResult, type RegenerateStorageFileGroupContentParams, type RegenerateStorageFileGroupContentResult, type StorageFileGroupDocument, type AsyncStorageFileGroupCreateAction, type CreateStorageFileGroupParams, type Transaction, type StorageFileGroup, type StorageFileGroupDocumentReferencePair, type StorageFileGroupId, type UpdateStorageFileGroupParams, type DownloadStorageFileOptions, type CreateStorageFileSignedUploadUrlParams, type CreateStorageFileSignedUploadUrlResult, type StorageFilePurposeUploadPolicy, type FirebaseAuthUserId, type AsyncFirebaseFunctionCreateAction } from '@dereekb/firebase';
 import { type FirebaseServerStorageServiceRef, type FirebaseServerActionsContext, type FirebaseServerAuthServiceRef } from '@dereekb/firebase-server';
 import { type TransformAndValidateFunctionResult } from '@dereekb/model';
 import { type InjectionToken } from '@nestjs/common';
@@ -59,6 +59,8 @@ export declare abstract class StorageFileServerActions {
     abstract deleteStorageFile(params: DeleteStorageFileParams): AsyncStorageFileDeleteAction<DeleteStorageFileParams>;
     abstract downloadStorageFile(params: DownloadStorageFileParams): Promise<TransformAndValidateFunctionResult<DownloadStorageFileParams, (storageFileDocument?: Maybe<StorageFileDocument>) => Promise<DownloadStorageFileResult>>>;
     abstract downloadMultipleStorageFiles(params: DownloadMultipleStorageFilesParams): Promise<TransformAndValidateFunctionResult<DownloadMultipleStorageFilesParams, (storageFileDocuments?: Maybe<StorageFileDocument[]>) => Promise<DownloadMultipleStorageFilesResult>>>;
+    abstract readStorageFileMetadata(params: ReadStorageFileMetadataParams): Promise<TransformAndValidateFunctionResult<ReadStorageFileMetadataParams, (storageFileDocument?: Maybe<StorageFileDocument>) => Promise<ReadStorageFileMetadataResult>>>;
+    abstract readMultipleStorageFilesMetadata(params: ReadMultipleStorageFilesMetadataParams): Promise<TransformAndValidateFunctionResult<ReadMultipleStorageFilesMetadataParams, (storageFileDocuments?: Maybe<StorageFileDocument[]>) => Promise<ReadMultipleStorageFilesMetadataResult>>>;
     abstract createStorageFileGroup(params: CreateStorageFileGroupParams): AsyncStorageFileGroupCreateAction<CreateStorageFileGroupParams>;
     abstract updateStorageFileGroup(params: UpdateStorageFileGroupParams): Promise<TransformAndValidateFunctionResult<UpdateStorageFileGroupParams, (storageFileGroupDocument: StorageFileGroupDocument) => Promise<StorageFileGroupDocument>>>;
     abstract syncStorageFileWithGroups(params: SyncStorageFileWithGroupsParams): Promise<TransformAndValidateFunctionResult<SyncStorageFileWithGroupsParams, (storageFileDocument: StorageFileDocument) => Promise<SyncStorageFileWithGroupsResult>>>;
@@ -308,6 +310,64 @@ export declare function downloadStorageFileFactory(context: StorageFileServerAct
  * @returns An async transform-and-validate function that generates signed download URLs for multiple files.
  */
 export declare function downloadMultipleStorageFilesFactory(context: StorageFileServerActionsContext): import("@dereekb/model").TransformAndValidateFunctionResultFunction<DownloadMultipleStorageFilesParams, (storageFileDocuments?: Maybe<StorageFileDocument[]>) => Promise<DownloadMultipleStorageFilesResult>, object, unknown>;
+/**
+ * Per-item input for the internal multiple-metadata-read factory.
+ */
+export interface ReadMultipleStorageFilesMetadataFactoryInputItem {
+    readonly key: FirestoreModelKey;
+    readonly storageFileDocument?: Maybe<StorageFileDocument>;
+}
+/**
+ * Input configuration for {@link _readMultipleStorageFilesMetadataFactory}.
+ *
+ * @example
+ * ```ts
+ * const result = await readMultipleStorageFilesMetadata({
+ *   items: [{ key: 'storageFile/abc' }],
+ *   throwOnFirstError: true
+ * });
+ * ```
+ */
+export interface ReadMultipleStorageFilesMetadataFactoryInput {
+    readonly items: ReadMultipleStorageFilesMetadataFactoryInputItem[];
+    /**
+     * When true, throws on the first read failure instead of collecting errors.
+     *
+     * Used by the single-read path ({@link readStorageFileMetadataFactory}).
+     */
+    readonly throwOnFirstError?: Maybe<boolean>;
+    /**
+     * Maximum number of concurrent metadata read operations.
+     *
+     * Defaults to {@link DEFAULT_READ_MULTIPLE_STORAGE_FILES_METADATA_MAX_PARALLEL_TASKS}.
+     */
+    readonly maxParallelTasks?: Maybe<number>;
+}
+/**
+ * Default maximum number of concurrent metadata read operations when batch-reading StorageFile metadata.
+ */
+export declare const DEFAULT_READ_MULTIPLE_STORAGE_FILES_METADATA_MAX_PARALLEL_TASKS = 5;
+/**
+ * Factory for the `readStorageFileMetadata` action.
+ *
+ * Reads the underlying Cloud Storage object metadata for a single {@link StorageFile}.
+ * Delegates to {@link _readMultipleStorageFilesMetadataFactory} with a single item and `throwOnFirstError: true`.
+ *
+ * @param context - The storage file server actions context.
+ * @returns An async transform-and-validate function that reads a StorageFile's Cloud Storage metadata.
+ */
+export declare function readStorageFileMetadataFactory(context: StorageFileServerActionsContext): import("@dereekb/model").TransformAndValidateFunctionResultFunction<ReadStorageFileMetadataParams, (storageFileDocument?: Maybe<StorageFileDocument>) => Promise<ReadMultipleStorageFileMetadataSuccessItem>, object, unknown>;
+/**
+ * Factory for the `readMultipleStorageFilesMetadata` action.
+ *
+ * Reads the underlying Cloud Storage object metadata for multiple {@link StorageFile} documents in a single call.
+ * By default, individual failures are collected in the errors array rather than failing the entire batch.
+ * Set `throwOnFirstError` in params to throw on the first failure instead.
+ *
+ * @param context - The storage file server actions context.
+ * @returns An async transform-and-validate function that reads Cloud Storage metadata for multiple files.
+ */
+export declare function readMultipleStorageFilesMetadataFactory(context: StorageFileServerActionsContext): import("@dereekb/model").TransformAndValidateFunctionResultFunction<ReadMultipleStorageFilesMetadataParams, (storageFileDocuments?: Maybe<StorageFileDocument[]>) => Promise<ReadMultipleStorageFilesMetadataResult>, object, unknown>;
 /**
  * Used for creating a new NotificationBox within a transaction.
  *