@dereekb/firebase 14.8.0 → 14.9.0

package/eslint/package.json

@@ -1,17 +1,17 @@
 {
   "name": "@dereekb/firebase/eslint",
-  "version": "14.8.0",
+  "version": "14.9.0",
   "sideEffects": false,
   "type": "module",
   "peerDependencies": {
-    "@dereekb/util": "14.8.0",
+    "@dereekb/util": "14.9.0",
     "@marcbachmann/cel-js": "^8.0.0",
     "@typescript-eslint/parser": "8.69.0",
     "@typescript-eslint/utils": "8.69.0",
     "typescript": "6.0.3"
   },
   "devDependencies": {
-    "@dereekb/firebase": "14.8.0",
+    "@dereekb/firebase": "14.9.0",
     "eslint": "10.9.1",
     "firebase": "^12.18.0"
   },

package/index.esm.js

@@ -19327,7 +19327,6 @@ function _unsupported_iterable_to_array$6(o, minLen) {
  * This is the backstop sweep: submission normally creates the task inline, so a space that is still sitting
  * here is one whose task creation was lost.
  *
- * @param limitCount - Maximum number of results. Omit for unbounded.
  * @returns Firestore query constraints for FormSpaces queued for processing.
  *
  * @dbxModelFirebaseIndex
@@ -19337,16 +19336,12 @@ function _unsupported_iterable_to_array$6(o, minLen) {
  *
  * @example
  * ```ts
- * const constraints = formSpacesQueuedForProcessingQuery(100);
+ * const constraints = formSpacesQueuedForProcessingQuery();
  * ```
- */ function formSpacesQueuedForProcessingQuery(limitCount) {
-    var constraints = [
+ */ function formSpacesQueuedForProcessingQuery() {
+    return [
         where('ps', '==', FormSpaceProcessingState.QUEUED_FOR_PROCESSING)
     ];
-    if (limitCount != null) {
-        constraints.push(limit(limitCount));
-    }
-    return constraints;
 }
 /**
  * Returns query constraints for FormSpaces whose expiration instant has arrived.
@@ -19355,7 +19350,7 @@ function _unsupported_iterable_to_array$6(o, minLen) {
  * whose type does not expire, or one that has already been submitted or expired and had `eat` cleared — is
  * not matched. That absence IS the exclusion mechanism; there is no second flag to keep in step.
  *
- * @param input - The pinned cutoff and page size.
+ * @param input - The pinned cutoff.
  * @returns Firestore query constraints for FormSpaces due for expiration.
  *
  * @dbxModelFirebaseIndex
@@ -19365,17 +19360,13 @@ function _unsupported_iterable_to_array$6(o, minLen) {
  *
  * @example
  * ```ts
- * const constraints = formSpacesDueForExpirationQuery({ before: new Date(), limit: 50 });
+ * const constraints = formSpacesDueForExpirationQuery({ before: new Date() });
  * ```
  */ function formSpacesDueForExpirationQuery(input) {
-    var constraints = [
+    return [
         orderBy('eat', 'asc'),
         whereDateIsOnOrBefore('eat', input.before)
     ];
-    if (input.limit != null) {
-        constraints.push(limit(input.limit));
-    }
-    return constraints;
 }
 /**
  * Returns query constraints for every StorageFile that belongs to a FormSpace.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/firebase",
-  "version": "14.8.0",
+  "version": "14.9.0",
   "type": "module",
   "sideEffects": false,
   "exports": {
@@ -22,10 +22,10 @@
     }
   },
   "peerDependencies": {
-    "@dereekb/date": "14.8.0",
-    "@dereekb/model": "14.8.0",
-    "@dereekb/rxjs": "14.8.0",
-    "@dereekb/util": "14.8.0",
+    "@dereekb/date": "14.9.0",
+    "@dereekb/model": "14.9.0",
+    "@dereekb/rxjs": "14.9.0",
+    "@dereekb/util": "14.9.0",
     "@firebase/rules-unit-testing": "5.0.2",
     "@marcbachmann/cel-js": "^8.0.0",
     "@typescript-eslint/parser": "8.69.0",

package/src/lib/model/formspace/formspace.query.d.ts

@@ -1,4 +1,3 @@
-import { type Maybe } from '@dereekb/util';
 import { type FirestoreQueryConstraint } from '../../common/firestore/query/constraint';
 import { type FirebaseAuthOwnershipKey } from '../../common/auth/auth';
 import { type FormSpaceKey } from './formspace.id';
@@ -16,7 +15,6 @@ import { type FormSpaceKey } from './formspace.id';
  * This is the backstop sweep: submission normally creates the task inline, so a space that is still sitting
  * here is one whose task creation was lost.
  *
- * @param limitCount - Maximum number of results. Omit for unbounded.
  * @returns Firestore query constraints for FormSpaces queued for processing.
  *
  * @dbxModelFirebaseIndex
@@ -26,10 +24,10 @@ import { type FormSpaceKey } from './formspace.id';
  *
  * @example
  * ```ts
- * const constraints = formSpacesQueuedForProcessingQuery(100);
+ * const constraints = formSpacesQueuedForProcessingQuery();
  * ```
  */
-export declare function formSpacesQueuedForProcessingQuery(limitCount?: Maybe<number>): FirestoreQueryConstraint[];
+export declare function formSpacesQueuedForProcessingQuery(): FirestoreQueryConstraint[];
 /**
  * Input for {@link formSpacesDueForExpirationQuery}.
  */
@@ -41,10 +39,6 @@ export interface FormSpacesDueForExpirationQueryInput {
      * clock lets a space that ages mid-sweep join a page not yet reached, making the pass unbounded.
      */
     readonly before: Date;
-    /**
-     * Maximum number of results per page.
-     */
-    readonly limit?: Maybe<number>;
 }
 /**
  * Returns query constraints for FormSpaces whose expiration instant has arrived.
@@ -53,7 +47,7 @@ export interface FormSpacesDueForExpirationQueryInput {
  * whose type does not expire, or one that has already been submitted or expired and had `eat` cleared — is
  * not matched. That absence IS the exclusion mechanism; there is no second flag to keep in step.
  *
- * @param input - The pinned cutoff and page size.
+ * @param input - The pinned cutoff.
  * @returns Firestore query constraints for FormSpaces due for expiration.
  *
  * @dbxModelFirebaseIndex
@@ -63,7 +57,7 @@ export interface FormSpacesDueForExpirationQueryInput {
  *
  * @example
  * ```ts
- * const constraints = formSpacesDueForExpirationQuery({ before: new Date(), limit: 50 });
+ * const constraints = formSpacesDueForExpirationQuery({ before: new Date() });
  * ```
  */
 export declare function formSpacesDueForExpirationQuery(input: FormSpacesDueForExpirationQueryInput): FirestoreQueryConstraint[];

package/src/lib/model/notification/notification.api.d.ts

@@ -84,6 +84,8 @@ export interface UpdateNotificationUserNotificationBoxRecipientParams extends Up
 export declare const updateNotificationUserNotificationBoxRecipientParamsType: Type<UpdateNotificationUserNotificationBoxRecipientParams>;
 /**
  * Used for updating the NotificationUser.
+ *
+ * @dbxModelApiParams
  */
 export interface UpdateNotificationUserParams extends TargetModelParams {
     readonly gc?: Maybe<UpdateNotificationUserDefaultNotificationBoxRecipientConfigParams>;
@@ -102,6 +104,8 @@ export interface ResyncNotificationUserResult {
  * The check always inspects the user's configuration, their notification box subscriptions, and whatever
  * read-only diagnostics each configured delivery method's send service offers. Actually dispatching a
  * test message is opt-in via `sendProbe`, since that delivers real mail/SMS to the user.
+ *
+ * @dbxModelApiParams
  */
 export interface NotificationUserHealthCheckParams extends TargetModelParams {
     /**
@@ -206,6 +210,8 @@ export interface CreateNotificationSummaryParams {
 export declare const createNotificationSummaryParamsType: Type<CreateNotificationSummaryParams>;
 /**
  * Used for updating the NotificationSummary.
+ *
+ * @dbxModelApiParams
  */
 export interface UpdateNotificationSummaryParams extends TargetModelParams {
     readonly flagAllRead?: Maybe<boolean>;
@@ -255,6 +261,8 @@ export type UpdateNotificationBoxParams = TargetModelParams;
 export { targetModelParamsType as updateNotificationBoxParamsType } from '../../common/model/model/model.param';
 /**
  * Used to create/update a notification box recipient.
+ *
+ * @dbxModelApiParams
  */
 export interface UpdateNotificationBoxRecipientParams extends UpdateNotificationBoxRecipientLikeParams, TargetModelParams {
     readonly key: FirestoreModelKey;
@@ -275,6 +283,8 @@ export interface NotificationRecipientParams {
 export declare const notificationRecipientParamsType: Type<NotificationRecipientParams>;
 /**
  * Used for sending the notification immediately, if it has not already been sent.
+ *
+ * @dbxModelApiParams
  */
 export interface SendNotificationParams extends TargetModelParams {
     readonly ignoreSendAtThrottle?: Maybe<boolean>;

package/src/lib/model/storagefile/storagefile.api.d.ts

@@ -13,6 +13,8 @@ export declare const DOWNLOAD_MULTIPLE_STORAGE_FILES_MAX_FILES = 50;
  * Parameters for directly creating a new StorageFile document (no upload initialization).
  *
  * Typically used server-side or for testing. Validated with {@link createStorageFileParamsType}.
+ *
+ * @dbxModelApiParams
  */
 export interface CreateStorageFileParams {
 }
@@ -22,6 +24,8 @@ export declare const createStorageFileParamsType: Type<CreateStorageFileParams>;
  *
  * Scans the uploads folder (or a custom path) and runs the upload determination/initialization
  * pipeline for each file found. Validated with {@link initializeAllStorageFilesFromUploadsParamsType}.
+ *
+ * @dbxModelApiParams
  */
 export interface InitializeAllStorageFilesFromUploadsParams {
     readonly maxFilesToInitialize?: Maybe<number>;
@@ -50,6 +54,8 @@ export interface InitializeAllStorageFilesFromUploadsResult extends OnCallCreate
  *
  * The file is run through the upload type determination pipeline and, if matched,
  * creates a corresponding StorageFile document. Validated with {@link initializeStorageFileFromUploadParamsType}.
+ *
+ * @dbxModelApiParams
  */
 export interface InitializeStorageFileFromUploadParams extends Pick<StoragePath, 'pathString'> {
     readonly bucketId?: Maybe<StorageBucketId>;
@@ -67,6 +73,8 @@ export declare const initializeStorageFileFromUploadParamsType: Type<InitializeS
  * those flags. `ARCHIVED` and `DO_NOT_PROCESS` files cannot be processed at all.
  *
  * Validated with {@link processStorageFileParamsType}.
+ *
+ * @dbxModelApiParams
  */
 export interface ProcessStorageFileParams extends TargetModelParams {
     /**
@@ -106,10 +114,20 @@ export interface ProcessAllQueuedStorageFilesResult {
     readonly storageFilesProcessStarted: number;
     readonly storageFilesFailedStarting: number;
 }
+/**
+ * Parameters for updating a StorageFile.
+ *
+ * @dbxModelApiParams
+ */
 export interface UpdateStorageFileParams extends TargetModelParams {
     readonly sdat?: Maybe<Date>;
 }
 export declare const updateStorageFileParamsType: Type<UpdateStorageFileParams>;
+/**
+ * Parameters for deleting a StorageFile.
+ *
+ * @dbxModelApiParams
+ */
 export interface DeleteStorageFileParams extends TargetModelParams {
     readonly force?: Maybe<boolean>;
 }
@@ -143,6 +161,8 @@ export interface DownloadStorageFileOptions {
  *
  * Extends {@link DownloadStorageFileOptions} with target model key.
  * Validated with {@link downloadStorageFileParamsType}.
+ *
+ * @dbxModelApiParams
  */
 export interface DownloadStorageFileParams extends TargetModelParams, DownloadStorageFileOptions {
 }
@@ -198,6 +218,8 @@ export interface DownloadMultipleStorageFileErrorItem {
  *   ]
  * };
  * ```
+ *
+ * @dbxModelApiParams
  */
 export interface DownloadMultipleStorageFilesParams extends DownloadStorageFileOptions {
     readonly files: DownloadMultipleStorageFilesFileParams[];
@@ -223,6 +245,8 @@ export interface DownloadMultipleStorageFilesResult {
  * Unlike {@link DownloadStorageFileParams}, no signed URL is minted — only the object's
  * {@link StorageMetadata} (size, md5Hash, generation, content headers, custom metadata, etc.) is returned.
  * `asAdmin` only selects the read role used for permission gating. Validated with {@link readStorageFileMetadataParamsType}.
+ *
+ * @dbxModelApiParams
  */
 export interface ReadStorageFileMetadataParams extends TargetModelParams {
     readonly asAdmin?: Maybe<boolean>;
@@ -265,6 +289,8 @@ export interface ReadMultipleStorageFileMetadataErrorItem {
  * Parameters for batch-reading the Cloud Storage metadata of multiple StorageFiles.
  *
  * `asAdmin` selects the read role for the whole batch. Validated with {@link readMultipleStorageFilesMetadataParamsType}.
+ *
+ * @dbxModelApiParams
  */
 export interface ReadMultipleStorageFilesMetadataParams {
     readonly files: ReadMultipleStorageFilesMetadataFileParams[];
@@ -317,6 +343,8 @@ export declare const CREATE_STORAGE_FILE_SIGNED_UPLOAD_URL_MAX_FILENAME_LENGTH =
  * `/uploads/u/{uid}/...` namespace. Once uploaded, the existing
  * `StorageFileInitializeFromUploadService` flow picks the file up and creates
  * the matching `StorageFile` document.
+ *
+ * @dbxModelApiParams
  */
 export interface CreateStorageFileSignedUploadUrlParams {
     /**
@@ -416,6 +444,11 @@ export interface CreateStorageFileGroupParams {
     readonly storageFileId?: Maybe<StorageFileId>;
 }
 export declare const createStorageFileGroupParamsType: Type<CreateStorageFileGroupParams>;
+/**
+ * Parameters for syncing a StorageFile with its StorageFileGroups.
+ *
+ * @dbxModelApiParams
+ */
 export interface SyncStorageFileWithGroupsParams extends TargetModelParams {
     readonly force?: Maybe<boolean>;
 }
@@ -437,10 +470,20 @@ export interface UpdateStorageFileGroupEntryParams {
     readonly n?: Maybe<string>;
 }
 export declare const updateStorageFileGroupEntryParamsType: Type<UpdateStorageFileGroupEntryParams>;
+/**
+ * Parameters for updating a StorageFileGroup.
+ *
+ * @dbxModelApiParams
+ */
 export interface UpdateStorageFileGroupParams extends TargetModelParams {
     readonly entries?: Maybe<UpdateStorageFileGroupEntryParams[]>;
 }
 export declare const updateStorageFileGroupParamsType: Type<UpdateStorageFileGroupParams>;
+/**
+ * Parameters for regenerating a StorageFileGroup's content.
+ *
+ * @dbxModelApiParams
+ */
 export interface RegenerateStorageFileGroupContentParams extends TargetModelParams {
     readonly force?: Maybe<boolean>;
 }

package/test/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@dereekb/firebase/test",
-  "version": "14.8.0",
+  "version": "14.9.0",
   "sideEffects": false,
   "type": "module",
   "peerDependencies": {
-    "@dereekb/date": "14.8.0",
-    "@dereekb/firebase": "14.8.0",
-    "@dereekb/model": "14.8.0",
-    "@dereekb/rxjs": "14.8.0",
-    "@dereekb/util": "14.8.0",
+    "@dereekb/date": "14.9.0",
+    "@dereekb/firebase": "14.9.0",
+    "@dereekb/model": "14.9.0",
+    "@dereekb/rxjs": "14.9.0",
+    "@dereekb/util": "14.9.0",
     "@firebase/rules-unit-testing": "5.0.2",
     "date-fns": "^4.1.0",
     "firebase": "^12.18.0",