@dereekb/firebase 13.12.3 → 13.12.5

package/eslint/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@dereekb/firebase/eslint",
-  "version": "13.12.3",
+  "version": "13.12.5",
   "peerDependencies": {
-    "@dereekb/util": "13.12.3",
+    "@dereekb/util": "13.12.5",
     "@marcbachmann/cel-js": "^7.6.1",
     "@typescript-eslint/parser": "8.59.3",
     "@typescript-eslint/utils": "8.59.3"
   },
   "devDependencies": {
-    "@dereekb/firebase": "13.12.3",
+    "@dereekb/firebase": "13.12.5",
     "eslint": "10.4.0",
     "firebase": "^12.12.1"
   },

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

@@ -11,6 +11,8 @@ export { FIREBASE_REQUIRE_FIRESTORE_RULE_FOR_SERVICE_MODEL_RULE, DEFAULT_FIRESTO
 export { FIREBASE_REQUIRE_DBX_MODEL_SERVICE_FACTORY_TAG_RULE, FIREBASE_MODEL_SERVICE_FACTORY_NAME, FIREBASE_MODEL_SERVICE_FACTORY_MODULE, DBX_MODEL_SERVICE_FACTORY_TAG, type FirebaseRequireDbxModelServiceFactoryTagRuleOptions, type FirebaseRequireDbxModelServiceFactoryTagRuleDefinition } from './require-dbx-model-service-factory-tag.rule';
 export { FIREBASE_REQUIRE_SERVICE_FACTORY_FOR_DBX_MODEL_RULE, DEFAULT_FACTORY_SEARCH_ROOTS, DEFAULT_MODEL_MARKER_TAG, DEFAULT_FACTORY_TAG, type FirebaseRequireServiceFactoryForDbxModelRuleOptions, type FirebaseRequireServiceFactoryForDbxModelRuleDefinition } from './require-service-factory-for-dbx-model.rule';
 export { FIREBASE_REQUIRE_DBX_MODEL_COMPANION_TAGS_RULE, type FirebaseRequireDbxModelCompanionTagsRuleOptions, type FirebaseRequireDbxModelCompanionTagsRuleDefinition } from './require-dbx-model-companion-tags.rule';
+export { FIREBASE_REQUIRE_CANONICAL_API_SPEC_FILENAME_RULE, DEFAULT_FUNCTION_DIR_SEGMENT, type FirebaseRequireCanonicalApiSpecFilenameRuleOptions, type FirebaseRequireCanonicalApiSpecFilenameRuleDefinition } from './require-canonical-api-spec-filename.rule';
+export { FIREBASE_REQUIRE_API_CRUD_SPEC_FOR_GROUP_RULE, type FirebaseRequireApiCrudSpecForGroupRuleOptions, type FirebaseRequireApiCrudSpecForGroupRuleDefinition } from './require-api-crud-spec-for-group.rule';
 export { parseStorageRules, MIRRORS_POLICY_KEY_MARKER_REGEX, type ParsedRuleBranch, type ParsedStorageRulesBlock } from './storage-rules-parser';
 export { parseFirestoreRules, type ParsedFirestoreMatchBlock } from './firestore-rules-parser';
 export { FIREBASE_ESLINT_PLUGIN, firebaseESLintPlugin, type FirebaseEslintPlugin } from './plugin';

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

@@ -11,6 +11,8 @@ import { FIREBASE_REQUIRE_FIRESTORE_RULE_FOR_SERVICE_MODEL_RULE } from './requir
 import { FIREBASE_REQUIRE_DBX_MODEL_SERVICE_FACTORY_TAG_RULE } from './require-dbx-model-service-factory-tag.rule';
 import { FIREBASE_REQUIRE_SERVICE_FACTORY_FOR_DBX_MODEL_RULE } from './require-service-factory-for-dbx-model.rule';
 import { FIREBASE_REQUIRE_DBX_MODEL_COMPANION_TAGS_RULE } from './require-dbx-model-companion-tags.rule';
+import { FIREBASE_REQUIRE_CANONICAL_API_SPEC_FILENAME_RULE } from './require-canonical-api-spec-filename.rule';
+import { FIREBASE_REQUIRE_API_CRUD_SPEC_FOR_GROUP_RULE } from './require-api-crud-spec-for-group.rule';
 /**
  * ESLint plugin interface for `@dereekb/firebase` rules.
  */
@@ -29,6 +31,8 @@ export interface FirebaseEslintPlugin {
         readonly 'require-dbx-model-service-factory-tag': typeof FIREBASE_REQUIRE_DBX_MODEL_SERVICE_FACTORY_TAG_RULE;
         readonly 'require-service-factory-for-dbx-model': typeof FIREBASE_REQUIRE_SERVICE_FACTORY_FOR_DBX_MODEL_RULE;
         readonly 'require-dbx-model-companion-tags': typeof FIREBASE_REQUIRE_DBX_MODEL_COMPANION_TAGS_RULE;
+        readonly 'require-canonical-api-spec-filename': typeof FIREBASE_REQUIRE_CANONICAL_API_SPEC_FILENAME_RULE;
+        readonly 'require-api-crud-spec-for-group': typeof FIREBASE_REQUIRE_API_CRUD_SPEC_FOR_GROUP_RULE;
     };
 }
 /**

package/eslint/src/lib/require-api-crud-spec-for-group.rule.d.ts

@@ -0,0 +1,47 @@
+import { type AstNode } from './util';
+/**
+ * Options for the require-api-crud-spec-for-group rule.
+ */
+export interface FirebaseRequireApiCrudSpecForGroupRuleOptions {
+    /**
+     * Path-suffix marker that anchors the rule to API function folders.
+     * Defaults to `'src/app/function'`. Files outside this segment are ignored.
+     */
+    readonly functionDirSegment?: string;
+}
+/**
+ * ESLint rule definition for require-api-crud-spec-for-group.
+ */
+export interface FirebaseRequireApiCrudSpecForGroupRuleDefinition {
+    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: FirebaseRequireApiCrudSpecForGroupRuleOptions[];
+        filename: string;
+        report: (descriptor: {
+            node: AstNode;
+            messageId: string;
+            data?: Record<string, string>;
+        }) => void;
+    }): Record<string, (node: AstNode) => void>;
+}
+/**
+ * ESLint rule that fires on every `<apiDir>/src/app/function/<group>/index.ts`
+ * (the canonical anchor file for a Firebase Functions group) and verifies
+ * that the same folder contains a `<group>.crud.spec.ts` (or any
+ * `<group>.crud.<sub>.spec.ts` variant) sibling. Mirrors the coverage check
+ * in `dbx_model_test_validate_app` so editor + CI lint flag missing CRUD
+ * coverage without needing the MCP audit.
+ *
+ * Not auto-fixable: creating a spec file shell with sensible test cases is
+ * outside the safe scope of an ESLint autofix.
+ */
+export declare const FIREBASE_REQUIRE_API_CRUD_SPEC_FOR_GROUP_RULE: FirebaseRequireApiCrudSpecForGroupRuleDefinition;

package/eslint/src/lib/require-canonical-api-spec-filename.rule.d.ts

@@ -0,0 +1,55 @@
+import { type AstNode } from './util';
+/**
+ * Default subpath segment (relative to an app source root) below which the
+ * rule expects model-group function folders. Matches the convention used by
+ * `<apiDir>/src/app/function/<group>/`.
+ */
+export declare const DEFAULT_FUNCTION_DIR_SEGMENT = "src/app/function";
+/**
+ * Options for the require-canonical-api-spec-filename rule.
+ */
+export interface FirebaseRequireCanonicalApiSpecFilenameRuleOptions {
+    /**
+     * Path-suffix marker that anchors the rule to API function folders.
+     * Defaults to `'src/app/function'`. Any `.spec.ts` whose path contains
+     * `<marker>/<group>/<filename>` is classified; everything else is ignored.
+     */
+    readonly functionDirSegment?: string;
+}
+/**
+ * ESLint rule definition for require-canonical-api-spec-filename.
+ */
+export interface FirebaseRequireCanonicalApiSpecFilenameRuleDefinition {
+    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: FirebaseRequireCanonicalApiSpecFilenameRuleOptions[];
+        filename: string;
+        report: (descriptor: {
+            node: AstNode;
+            messageId: string;
+            data?: Record<string, string>;
+        }) => void;
+    }): Record<string, (node: AstNode) => void>;
+}
+/**
+ * ESLint rule that enforces the canonical naming convention for Firebase
+ * Functions API spec files: every `.spec.ts` under
+ * `<apiDir>/src/app/function/<group>/` must be `<group>.crud[.<sub>...].spec.ts`
+ * or `<group>.scenario[.<sub>...].spec.ts`. Drift forms surface a rename
+ * suggestion derived from the shared `classifySpecFile` classifier in
+ * `@dereekb/util`, so this rule and the `dbx_model_test_validate_app` MCP
+ * tool never diverge.
+ *
+ * Not auto-fixable: renaming files (and updating any imports/snapshots they
+ * carry) is outside the safe scope of an ESLint autofix.
+ */
+export declare const FIREBASE_REQUIRE_CANONICAL_API_SPEC_FILENAME_RULE: FirebaseRequireCanonicalApiSpecFilenameRuleDefinition;

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

@@ -7,7 +7,7 @@ import { type AstNode } from './util';
 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
+ * `create | read | update | delete | query | invoke` 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[];