@dereekb/firebase 13.12.4 → 13.12.5

package/eslint/index.cjs.js

@@ -17229,6 +17229,415 @@ function reportCompositeKeyTag(ctx, tag, allowedEncodings) {
     }
 };
 
+var SPEC_SUFFIX = '.spec.ts';
+/**
+ * Classifies a spec filename against the conventions for the given parent
+ * folder. Pure function — never touches the filesystem.
+ *
+ * @param config - Inputs.
+ * @param config.filename - Bare filename including the `.spec.ts` suffix
+ *   (e.g. `job.scenario.requirement.spec.ts`).
+ * @param config.parentFolderName - Name of the directory containing the file
+ *   (e.g. `job`). Used to detect cross-group misplacement.
+ * @returns The classification.
+ */ function classifySpecFile(config) {
+    var filename = config.filename, parentFolderName = config.parentFolderName;
+    var result;
+    if (!filename.endsWith(SPEC_SUFFIX)) {
+        result = {
+            filename: filename,
+            group: '',
+            kind: 'non-spec',
+            subgroups: [],
+            isCanonical: false
+        };
+    } else {
+        var _parts_;
+        var stem = filename.slice(0, -SPEC_SUFFIX.length);
+        var parts = stem.split('.');
+        var group = (_parts_ = parts[0]) !== null && _parts_ !== void 0 ? _parts_ : '';
+        if (group !== parentFolderName) {
+            result = {
+                filename: filename,
+                group: group,
+                kind: 'non-group',
+                subgroups: [],
+                isCanonical: false
+            };
+        } else {
+            var rest = parts.slice(1);
+            result = classifyRemainingSegments({
+                filename: filename,
+                group: group,
+                rest: rest
+            });
+        }
+    }
+    return result;
+}
+function classifyRemainingSegments(config) {
+    var filename = config.filename, group = config.group, rest = config.rest;
+    var result;
+    var crudIdx = rest.indexOf('crud');
+    var scenarioIdx = rest.indexOf('scenario');
+    if (crudIdx === 0) {
+        if (rest.length === 1) {
+            result = {
+                filename: filename,
+                group: group,
+                kind: 'crud',
+                subgroups: [],
+                isCanonical: true
+            };
+        } else {
+            result = {
+                filename: filename,
+                group: group,
+                kind: 'crud-subgroup',
+                subgroups: rest.slice(1),
+                isCanonical: true
+            };
+        }
+    } else if (scenarioIdx === 0) {
+        if (rest.length === 1) {
+            result = {
+                filename: filename,
+                group: group,
+                kind: 'scenario',
+                subgroups: [],
+                isCanonical: true
+            };
+        } else {
+            result = {
+                filename: filename,
+                group: group,
+                kind: 'scenario-subgroup',
+                subgroups: rest.slice(1),
+                isCanonical: true
+            };
+        }
+    } else if (crudIdx > 0) {
+        var subgroups = rest.filter(function(_, i) {
+            return i !== crudIdx;
+        });
+        var recommendedRename = buildCanonicalFilename({
+            group: group,
+            bucket: 'crud',
+            subgroups: subgroups
+        });
+        result = {
+            filename: filename,
+            group: group,
+            kind: 'crud-misplaced',
+            subgroups: subgroups,
+            isCanonical: false,
+            recommendedRename: recommendedRename,
+            driftReason: '`crud` segment is not directly after the group name.'
+        };
+    } else if (scenarioIdx > 0) {
+        var subgroups1 = rest.filter(function(_, i) {
+            return i !== scenarioIdx;
+        });
+        var recommendedRename1 = buildCanonicalFilename({
+            group: group,
+            bucket: 'scenario',
+            subgroups: subgroups1
+        });
+        result = {
+            filename: filename,
+            group: group,
+            kind: 'scenario-misplaced',
+            subgroups: subgroups1,
+            isCanonical: false,
+            recommendedRename: recommendedRename1,
+            driftReason: '`scenario` segment is not directly after the group name.'
+        };
+    } else if (rest.length === 0) {
+        var recommendedRename2 = buildCanonicalFilename({
+            group: group,
+            bucket: 'scenario',
+            subgroups: []
+        });
+        result = {
+            filename: filename,
+            group: group,
+            kind: 'no-bucket',
+            subgroups: [],
+            isCanonical: false,
+            recommendedRename: recommendedRename2,
+            driftReason: 'Missing `crud` or `scenario` segment.'
+        };
+    } else {
+        var recommendedRename3 = buildCanonicalFilename({
+            group: group,
+            bucket: 'scenario',
+            subgroups: rest
+        });
+        result = {
+            filename: filename,
+            group: group,
+            kind: 'no-bucket',
+            subgroups: rest,
+            isCanonical: false,
+            recommendedRename: recommendedRename3,
+            driftReason: 'Missing `crud` or `scenario` segment — defaulting suggestion to `scenario`.'
+        };
+    }
+    return result;
+}
+/**
+ * Renders a canonical spec filename for the given group + bucket + subgroup
+ * chain. Pure data — used both by drift remediation and by the
+ * `recommendSpecPath()` helper below.
+ *
+ * @param config - Inputs.
+ * @param config.group - The model-group name (e.g. `job`).
+ * @param config.bucket - `crud` or `scenario`.
+ * @param config.subgroups - Optional ordered subgroup segments
+ *   (e.g. `['requirement','worker']`).
+ * @returns The canonical filename (e.g. `job.scenario.requirement.worker.spec.ts`).
+ */ function buildCanonicalFilename(config) {
+    var group = config.group, bucket = config.bucket, subgroups = config.subgroups;
+    var tail = subgroups.length === 0 ? '' : ".".concat(subgroups.join('.'));
+    return "".concat(group, ".").concat(bucket).concat(tail, ".spec.ts");
+}
+
+/**
+ * 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>/`.
+ */ var DEFAULT_FUNCTION_DIR_SEGMENT = 'src/app/function';
+function matchFunctionSpecPath(filename, functionDirSegment) {
+    var result;
+    if (filename.endsWith('.spec.ts')) {
+        var normalized = filename.split(node_path.sep).join('/');
+        var marker = "/".concat(functionDirSegment, "/");
+        var markerIdx = normalized.indexOf(marker);
+        if (markerIdx >= 0) {
+            var afterMarker = normalized.slice(markerIdx + marker.length);
+            var parts = afterMarker.split('/');
+            if (parts.length === 2) {
+                var _parts_, _parts_1;
+                result = {
+                    filename: (_parts_ = parts[1]) !== null && _parts_ !== void 0 ? _parts_ : '',
+                    parentFolderName: (_parts_1 = parts[0]) !== null && _parts_1 !== void 0 ? _parts_1 : ''
+                };
+            } else if (parts.length > 2) {
+                result = {
+                    filename: node_path.basename(filename),
+                    parentFolderName: node_path.basename(node_path.dirname(filename))
+                };
+            }
+        }
+    }
+    return result;
+}
+/**
+ * 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.
+ */ var FIREBASE_REQUIRE_CANONICAL_API_SPEC_FILENAME_RULE = {
+    meta: {
+        type: 'suggestion',
+        fixable: undefined,
+        docs: {
+            description: 'Require API spec filenames under `src/app/function/<group>/` to follow the `<group>.crud[.<sub>...].spec.ts` / `<group>.scenario[.<sub>...].spec.ts` convention.',
+            recommended: true
+        },
+        messages: {
+            testFileDriftRename: '`{{filename}}`: {{reason}} Rename to `{{recommendedRename}}`.',
+            testFileMissingBucket: '`{{filename}}`: missing `crud` / `scenario` segment. Rename to `{{recommendedRename}}` (default) or to a `crud` variant if the tests are CRUD-flavored.',
+            testFileNonGroupPlacement: '`{{filename}}`: first segment `{{group}}` does not match the parent folder `{{parentFolderName}}`. Move into `{{group}}/` or rename the prefix to match the current folder.'
+        },
+        schema: [
+            {
+                type: 'object',
+                additionalProperties: false,
+                properties: {
+                    functionDirSegment: {
+                        type: 'string'
+                    }
+                }
+            }
+        ]
+    },
+    create: function create(context) {
+        var _context_options_, _options_functionDirSegment;
+        var options = (_context_options_ = context.options[0]) !== null && _context_options_ !== void 0 ? _context_options_ : {};
+        var functionDirSegment = (_options_functionDirSegment = options.functionDirSegment) !== null && _options_functionDirSegment !== void 0 ? _options_functionDirSegment : DEFAULT_FUNCTION_DIR_SEGMENT;
+        var matched = matchFunctionSpecPath(context.filename, functionDirSegment);
+        function check(programNode) {
+            if (!matched) return;
+            var classification = classifySpecFile({
+                filename: matched.filename,
+                parentFolderName: matched.parentFolderName
+            });
+            if (classification.isCanonical) return;
+            if (classification.kind === 'non-spec') return;
+            if (classification.kind === 'crud-misplaced' || classification.kind === 'scenario-misplaced') {
+                var _classification_driftReason, _classification_recommendedRename;
+                context.report({
+                    node: programNode,
+                    messageId: 'testFileDriftRename',
+                    data: {
+                        filename: classification.filename,
+                        reason: (_classification_driftReason = classification.driftReason) !== null && _classification_driftReason !== void 0 ? _classification_driftReason : 'segment order does not match the convention.',
+                        recommendedRename: (_classification_recommendedRename = classification.recommendedRename) !== null && _classification_recommendedRename !== void 0 ? _classification_recommendedRename : ''
+                    }
+                });
+            } else if (classification.kind === 'no-bucket') {
+                var _classification_recommendedRename1;
+                context.report({
+                    node: programNode,
+                    messageId: 'testFileMissingBucket',
+                    data: {
+                        filename: classification.filename,
+                        recommendedRename: (_classification_recommendedRename1 = classification.recommendedRename) !== null && _classification_recommendedRename1 !== void 0 ? _classification_recommendedRename1 : ''
+                    }
+                });
+            } else if (classification.kind === 'non-group') {
+                context.report({
+                    node: programNode,
+                    messageId: 'testFileNonGroupPlacement',
+                    data: {
+                        filename: classification.filename,
+                        group: classification.group,
+                        parentFolderName: matched.parentFolderName
+                    }
+                });
+            }
+        }
+        return {
+            Program: function Program(node) {
+                return check(node);
+            }
+        };
+    }
+};
+
+function isGroupIndex(filename, functionDirSegment) {
+    var normalized = filename.split(node_path.sep).join('/');
+    var marker = "/".concat(functionDirSegment, "/");
+    var markerIdx = normalized.indexOf(marker);
+    var result = false;
+    if (markerIdx >= 0) {
+        var afterMarker = normalized.slice(markerIdx + marker.length);
+        var parts = afterMarker.split('/');
+        result = parts.length === 2 && parts[1] === 'index.ts';
+    }
+    return result;
+}
+function hasCrudSpec(groupDir, group) {
+    var found = false;
+    try {
+        var entries = node_fs.readdirSync(groupDir);
+        var _iteratorNormalCompletion = true, _didIteratorError = false, _iteratorError = undefined;
+        try {
+            for(var _iterator = entries[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true){
+                var entry = _step.value;
+                var classification = classifySpecFile({
+                    filename: entry,
+                    parentFolderName: group
+                });
+                if (classification.kind === 'crud' || classification.kind === 'crud-subgroup') {
+                    found = true;
+                    break;
+                }
+            }
+        } catch (err) {
+            _didIteratorError = true;
+            _iteratorError = err;
+        } finally{
+            try {
+                if (!_iteratorNormalCompletion && _iterator.return != null) {
+                    _iterator.return();
+                }
+            } finally{
+                if (_didIteratorError) {
+                    throw _iteratorError;
+                }
+            }
+        }
+    } catch (unused) {
+    // Directory unreadable — treat as no crud spec; rule will emit the warning
+    // and the user can investigate. We do NOT swallow the error silently
+    // in any other way.
+    }
+    return found;
+}
+/**
+ * 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.
+ */ var FIREBASE_REQUIRE_API_CRUD_SPEC_FOR_GROUP_RULE = {
+    meta: {
+        type: 'suggestion',
+        fixable: undefined,
+        docs: {
+            description: 'Require every API model-group function folder to have a `<group>.crud.spec.ts` covering its CRUD function map.',
+            recommended: true
+        },
+        messages: {
+            modelGroupMissingCrudSpec: 'Model group `{{group}}` has no `{{expectedFilename}}`. Add it covering the CRUD function map (create/read/update/delete + permission/error paths).'
+        },
+        schema: [
+            {
+                type: 'object',
+                additionalProperties: false,
+                properties: {
+                    functionDirSegment: {
+                        type: 'string'
+                    }
+                }
+            }
+        ]
+    },
+    create: function create(context) {
+        var _context_options_, _options_functionDirSegment;
+        var options = (_context_options_ = context.options[0]) !== null && _context_options_ !== void 0 ? _context_options_ : {};
+        var functionDirSegment = (_options_functionDirSegment = options.functionDirSegment) !== null && _options_functionDirSegment !== void 0 ? _options_functionDirSegment : DEFAULT_FUNCTION_DIR_SEGMENT;
+        var filename = context.filename;
+        var isAnchor = isGroupIndex(filename, functionDirSegment);
+        function check(programNode) {
+            if (!isAnchor) return;
+            var groupDir = node_path.dirname(filename);
+            var group = node_path.basename(groupDir);
+            if (hasCrudSpec(groupDir, group)) return;
+            var expectedFilename = buildCanonicalFilename({
+                group: group,
+                bucket: 'crud',
+                subgroups: []
+            });
+            context.report({
+                node: programNode,
+                messageId: 'modelGroupMissingCrudSpec',
+                data: {
+                    group: group,
+                    expectedFilename: expectedFilename
+                }
+            });
+        }
+        return {
+            Program: function Program(node) {
+                return check(node);
+            }
+        };
+    }
+};
+
 /**
  * ESLint plugin for `@dereekb/firebase` rules.
  *
@@ -17248,7 +17657,9 @@ function reportCompositeKeyTag(ctx, tag, allowedEncodings) {
         'require-firestore-rule-for-service-model': FIREBASE_REQUIRE_FIRESTORE_RULE_FOR_SERVICE_MODEL_RULE,
         'require-dbx-model-service-factory-tag': FIREBASE_REQUIRE_DBX_MODEL_SERVICE_FACTORY_TAG_RULE,
         'require-service-factory-for-dbx-model': FIREBASE_REQUIRE_SERVICE_FACTORY_FOR_DBX_MODEL_RULE,
-        'require-dbx-model-companion-tags': FIREBASE_REQUIRE_DBX_MODEL_COMPANION_TAGS_RULE
+        'require-dbx-model-companion-tags': FIREBASE_REQUIRE_DBX_MODEL_COMPANION_TAGS_RULE,
+        'require-canonical-api-spec-filename': FIREBASE_REQUIRE_CANONICAL_API_SPEC_FILENAME_RULE,
+        'require-api-crud-spec-for-group': FIREBASE_REQUIRE_API_CRUD_SPEC_FOR_GROUP_RULE
     }
 };
 /**
@@ -17268,6 +17679,7 @@ exports.DEFAULT_DISCOVERY_EXCLUDED_DIRS = DEFAULT_DISCOVERY_EXCLUDED_DIRS;
 exports.DEFAULT_FACTORY_SEARCH_ROOTS = DEFAULT_FACTORY_SEARCH_ROOTS;
 exports.DEFAULT_FACTORY_TAG = DEFAULT_FACTORY_TAG;
 exports.DEFAULT_FIRESTORE_RULES_FILENAME = DEFAULT_FIRESTORE_RULES_FILENAME;
+exports.DEFAULT_FUNCTION_DIR_SEGMENT = DEFAULT_FUNCTION_DIR_SEGMENT;
 exports.DEFAULT_IDENTITY_FACTORY_NAME = DEFAULT_IDENTITY_FACTORY_NAME;
 exports.DEFAULT_INDEX_AFFECTING_CONSTRAINT_NAMES = DEFAULT_INDEX_AFFECTING_CONSTRAINT_NAMES;
 exports.DEFAULT_MODEL_MARKER_TAG = DEFAULT_MODEL_MARKER_TAG;
@@ -17280,7 +17692,9 @@ exports.FIREBASE_ESLINT_PLUGIN = FIREBASE_ESLINT_PLUGIN;
 exports.FIREBASE_MODEL_SERVICE_FACTORY_MODULE = FIREBASE_MODEL_SERVICE_FACTORY_MODULE;
 exports.FIREBASE_MODEL_SERVICE_FACTORY_NAME = FIREBASE_MODEL_SERVICE_FACTORY_NAME;
 exports.FIREBASE_MODULE = FIREBASE_MODULE;
+exports.FIREBASE_REQUIRE_API_CRUD_SPEC_FOR_GROUP_RULE = FIREBASE_REQUIRE_API_CRUD_SPEC_FOR_GROUP_RULE;
 exports.FIREBASE_REQUIRE_API_DETAILS_FOR_CRUD_FUNCTION_RULE = FIREBASE_REQUIRE_API_DETAILS_FOR_CRUD_FUNCTION_RULE;
+exports.FIREBASE_REQUIRE_CANONICAL_API_SPEC_FILENAME_RULE = FIREBASE_REQUIRE_CANONICAL_API_SPEC_FILENAME_RULE;
 exports.FIREBASE_REQUIRE_COMPLETE_CRUD_FUNCTION_CONFIG_MAP_RULE = FIREBASE_REQUIRE_COMPLETE_CRUD_FUNCTION_CONFIG_MAP_RULE;
 exports.FIREBASE_REQUIRE_DBX_MODEL_COMPANION_TAGS_RULE = FIREBASE_REQUIRE_DBX_MODEL_COMPANION_TAGS_RULE;
 exports.FIREBASE_REQUIRE_DBX_MODEL_FIREBASE_INDEX_COMPANION_TAGS_RULE = FIREBASE_REQUIRE_DBX_MODEL_FIREBASE_INDEX_COMPANION_TAGS_RULE;