@dereekb/firebase 13.11.17 → 13.11.18

package/eslint/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@dereekb/firebase/eslint",
-  "version": "13.11.17",
+  "version": "13.11.18",
   "peerDependencies": {
     "@typescript-eslint/utils": "8.59.3"
   },
   "devDependencies": {
-    "@dereekb/util": "13.11.17",
+    "@dereekb/util": "13.11.18",
     "@typescript-eslint/parser": "8.59.3",
     "eslint": "10.4.0"
   },

package/eslint/src/lib/index.d.ts

@@ -2,5 +2,7 @@ export { FIREBASE_REQUIRE_TAGGED_FIRESTORE_CONSTRAINTS_RULE, type FirebaseRequir
 export { FIREBASE_REQUIRE_DBX_MODEL_FIREBASE_INDEX_QUERY_SUFFIX_RULE, type FirebaseRequireDbxModelFirebaseIndexQuerySuffixRuleOptions, type FirebaseRequireDbxModelFirebaseIndexQuerySuffixRuleDefinition } from './require-dbx-model-firebase-index-query-suffix.rule';
 export { FIREBASE_REQUIRE_DBX_MODEL_FIREBASE_INDEX_COMPANION_TAGS_RULE, type FirebaseRequireDbxModelFirebaseIndexCompanionTagsRuleOptions, type FirebaseRequireDbxModelFirebaseIndexCompanionTagsRuleDefinition } from './require-dbx-model-firebase-index-companion-tags.rule';
 export { FIREBASE_REQUIRE_DBX_MODEL_FIREBASE_INDEX_VALID_DISPATCHER_RULE, type FirebaseRequireDbxModelFirebaseIndexValidDispatcherRuleOptions, type FirebaseRequireDbxModelFirebaseIndexValidDispatcherRuleDefinition } from './require-dbx-model-firebase-index-valid-dispatcher.rule';
+export { FIREBASE_REQUIRE_FIRESTORE_CONSTRAINT_TYPE_PARAMETER_RULE, type FirebaseRequireFirestoreConstraintTypeParameterRuleOptions, type FirebaseRequireFirestoreConstraintTypeParameterRuleDefinition } from './require-firestore-constraint-type-parameter.rule';
+export { FIREBASE_REQUIRE_COMPLETE_CRUD_FUNCTION_CONFIG_MAP_RULE, DEFAULT_CRUD_VERB_NAMES, MODEL_FIREBASE_CRUD_FUNCTION_CONFIG_MAP_TYPE_NAME, type FirebaseRequireCompleteCrudFunctionConfigMapRuleOptions, type FirebaseRequireCompleteCrudFunctionConfigMapRuleDefinition } from './require-complete-crud-function-config-map.rule';
 export { FIREBASE_ESLINT_PLUGIN, firebaseESLintPlugin, type FirebaseEslintPlugin } from './plugin';
 export { DBX_MODEL_FIREBASE_INDEX_MARKER, DEFAULT_CONSTRAINT_FACTORY_NAMES, DEFAULT_INDEX_AFFECTING_CONSTRAINT_NAMES, DEFAULT_PAGINATION_CONSTRAINT_NAMES, FIREBASE_MODULE, QUERY_SUFFIX } from './util';

package/eslint/src/lib/plugin.d.ts

@@ -2,6 +2,8 @@ import { FIREBASE_REQUIRE_TAGGED_FIRESTORE_CONSTRAINTS_RULE } from './require-ta
 import { FIREBASE_REQUIRE_DBX_MODEL_FIREBASE_INDEX_QUERY_SUFFIX_RULE } from './require-dbx-model-firebase-index-query-suffix.rule';
 import { FIREBASE_REQUIRE_DBX_MODEL_FIREBASE_INDEX_COMPANION_TAGS_RULE } from './require-dbx-model-firebase-index-companion-tags.rule';
 import { FIREBASE_REQUIRE_DBX_MODEL_FIREBASE_INDEX_VALID_DISPATCHER_RULE } from './require-dbx-model-firebase-index-valid-dispatcher.rule';
+import { FIREBASE_REQUIRE_FIRESTORE_CONSTRAINT_TYPE_PARAMETER_RULE } from './require-firestore-constraint-type-parameter.rule';
+import { FIREBASE_REQUIRE_COMPLETE_CRUD_FUNCTION_CONFIG_MAP_RULE } from './require-complete-crud-function-config-map.rule';
 /**
  * ESLint plugin interface for `@dereekb/firebase` rules.
  */
@@ -11,6 +13,8 @@ export interface FirebaseEslintPlugin {
         readonly 'require-dbx-model-firebase-index-query-suffix': typeof FIREBASE_REQUIRE_DBX_MODEL_FIREBASE_INDEX_QUERY_SUFFIX_RULE;
         readonly 'require-dbx-model-firebase-index-companion-tags': typeof FIREBASE_REQUIRE_DBX_MODEL_FIREBASE_INDEX_COMPANION_TAGS_RULE;
         readonly 'require-dbx-model-firebase-index-valid-dispatcher': typeof FIREBASE_REQUIRE_DBX_MODEL_FIREBASE_INDEX_VALID_DISPATCHER_RULE;
+        readonly 'require-firestore-constraint-type-parameter': typeof FIREBASE_REQUIRE_FIRESTORE_CONSTRAINT_TYPE_PARAMETER_RULE;
+        readonly 'require-complete-crud-function-config-map': typeof FIREBASE_REQUIRE_COMPLETE_CRUD_FUNCTION_CONFIG_MAP_RULE;
     };
 }
 /**

package/eslint/src/lib/require-complete-crud-function-config-map.rule.d.ts

@@ -0,0 +1,61 @@
+import { type AstNode } from './util';
+/**
+ * Type-reference name that triggers this rule. Variables whose declared type is
+ * `ModelFirebaseCrudFunctionConfigMap<ConfigType, Identity>` will have their
+ * initializer validated against the structure of `ConfigType`.
+ */
+export declare const MODEL_FIREBASE_CRUD_FUNCTION_CONFIG_MAP_TYPE_NAME = "ModelFirebaseCrudFunctionConfigMap";
+/**
+ * CRUD verb names supported by `ModelFirebaseCrudFunctionConfigMap`. Mirrors the
+ * `create | read | update | delete | query` verbs in the type definition at
+ * `packages/firebase/src/lib/client/function/model.function.factory.ts`.
+ */
+export declare const DEFAULT_CRUD_VERB_NAMES: readonly string[];
+/**
+ * Options for the require-complete-crud-function-config-map rule.
+ */
+export interface FirebaseRequireCompleteCrudFunctionConfigMapRuleOptions {
+    readonly typeName?: string;
+    readonly verbNames?: readonly string[];
+}
+/**
+ * ESLint rule definition for require-complete-crud-function-config-map.
+ */
+export interface FirebaseRequireCompleteCrudFunctionConfigMapRuleDefinition {
+    readonly meta: {
+        readonly type: 'problem';
+        readonly fixable: undefined;
+        readonly docs: {
+            readonly description: string;
+            readonly recommended: boolean;
+        };
+        readonly messages: Readonly<Record<string, string>>;
+        readonly schema: readonly object[];
+    };
+    create(context: {
+        options: FirebaseRequireCompleteCrudFunctionConfigMapRuleOptions[];
+        report: (descriptor: {
+            node: AstNode;
+            messageId: string;
+            data?: Record<string, string>;
+        }) => void;
+    }): Record<string, (node: AstNode) => void>;
+}
+/**
+ * ESLint rule that verifies every `ModelFirebaseCrudFunctionConfigMap<ConfigType, ...>`
+ * variable initializer is structurally complete against its companion `ConfigType`
+ * defined in the same file.
+ *
+ * The rule walks the type alias for `ConfigType` (e.g., `NotificationBoxModelCrudFunctionsConfig`),
+ * builds the expected set of model keys, verbs, and specifiers, and then compares it
+ * against the object-literal initializer of the variable. Each mismatch — missing model
+ * key, missing verb, missing specifier, disabled-but-present key, etc. — is reported as
+ * an error so the const stays in sync with its companion type even when the TypeScript
+ * mapped-type enforcement decays in larger codebases.
+ *
+ * Same-file resolution only: the companion type must be declared in the same source
+ * file as the const (matching the convention in `notification.api.ts`, `oidcmodel.api.ts`,
+ * `storagefile.api.ts`). When the type cannot be located, the rule reports
+ * `configTypeNotFound`.
+ */
+export declare const FIREBASE_REQUIRE_COMPLETE_CRUD_FUNCTION_CONFIG_MAP_RULE: FirebaseRequireCompleteCrudFunctionConfigMapRuleDefinition;

package/eslint/src/lib/require-firestore-constraint-type-parameter.rule.d.ts

@@ -0,0 +1,45 @@
+import { type AstNode } from './util';
+/**
+ * Options for the require-firestore-constraint-type-parameter rule.
+ */
+export interface FirebaseRequireFirestoreConstraintTypeParameterRuleOptions {
+    readonly constraintNames?: readonly string[];
+    readonly additionalConstraintNames?: readonly string[];
+    readonly allowedImportSources?: readonly string[];
+}
+/**
+ * ESLint rule definition for require-firestore-constraint-type-parameter.
+ */
+export interface FirebaseRequireFirestoreConstraintTypeParameterRuleDefinition {
+    readonly meta: {
+        readonly type: 'suggestion';
+        readonly fixable: undefined;
+        readonly docs: {
+            readonly description: string;
+            readonly recommended: boolean;
+        };
+        readonly messages: Readonly<Record<string, string>>;
+        readonly schema: readonly object[];
+    };
+    create(context: {
+        options: FirebaseRequireFirestoreConstraintTypeParameterRuleOptions[];
+        report: (descriptor: {
+            node: AstNode;
+            messageId: string;
+            data?: Record<string, string>;
+        }) => void;
+    }): Record<string, (node: AstNode) => void>;
+}
+/**
+ * ESLint rule that warns when an `@dereekb/firebase` field-path-narrowing constraint factory
+ * (`where`, `orderBy`) is called without a generic type argument. Without `<Model>`, the
+ * overload falls back to a plain `FieldPathOrStringPath`, so field-name typos and renamed
+ * fields silently compile.
+ *
+ * The expected form is `where<Model>('field', '==', value)` / `orderBy<Model>('field')` so
+ * the field path is constrained to `StringKeyPropertyKeys<Model>`.
+ *
+ * Not auto-fixable: the rule cannot safely infer the correct model type from the surrounding
+ * function signature in an ESLint autofix.
+ */
+export declare const FIREBASE_REQUIRE_FIRESTORE_CONSTRAINT_TYPE_PARAMETER_RULE: FirebaseRequireFirestoreConstraintTypeParameterRuleDefinition;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/firebase",
-  "version": "13.11.17",
+  "version": "13.11.18",
   "sideEffects": false,
   "exports": {
     "./test": {
@@ -24,10 +24,10 @@
     }
   },
   "peerDependencies": {
-    "@dereekb/util": "13.11.17",
-    "@dereekb/date": "13.11.17",
-    "@dereekb/model": "13.11.17",
-    "@dereekb/rxjs": "13.11.17",
+    "@dereekb/util": "13.11.18",
+    "@dereekb/date": "13.11.18",
+    "@dereekb/model": "13.11.18",
+    "@dereekb/rxjs": "13.11.18",
     "@firebase/rules-unit-testing": "5.0.0",
     "arktype": "^2.2.0",
     "date-fns": "^4.1.0",

package/test/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@dereekb/firebase/test",
-  "version": "13.11.17",
+  "version": "13.11.18",
   "peerDependencies": {
-    "@dereekb/date": "13.11.17",
-    "@dereekb/firebase": "13.11.17",
-    "@dereekb/model": "13.11.17",
-    "@dereekb/rxjs": "13.11.17",
-    "@dereekb/util": "13.11.17",
+    "@dereekb/date": "13.11.18",
+    "@dereekb/firebase": "13.11.18",
+    "@dereekb/model": "13.11.18",
+    "@dereekb/rxjs": "13.11.18",
+    "@dereekb/util": "13.11.18",
     "@firebase/rules-unit-testing": "5.0.0",
     "date-fns": "^4.1.0",
     "firebase": "^12.12.1",