@dereekb/firebase 13.11.17 → 13.12.0

package/test/index.esm.js

@@ -1469,12 +1469,10 @@ function _is_native_reflect_construct$4() {
 }(AbstractFirestoreDocument);
 /**
  * Firestore collection path name.
- */ // eslint-disable-next-line @typescript-eslint/naming-convention -- camelCase chosen to match neighboring mock exports in this test fixture
-var MOCK_ITEM_USER_COLLECTION_NAME = 'mockItemUser';
+ */ var MOCK_ITEM_USER_COLLECTION_NAME = 'mockItemUser';
 /**
  * Default document identifier used for MockItemUser in tests.
- */ // eslint-disable-next-line @typescript-eslint/naming-convention -- camelCase chosen to match neighboring mock exports in this test fixture
-var MOCK_ITEM_USER_IDENTIFIER = '0';
+ */ var MOCK_ITEM_USER_IDENTIFIER = '0';
 /**
  * Used to build a FirestoreDataConverter. Fields are configured via configuration. See the SnapshotConverterFunctions for more info.
  */ var mockItemUserConverter = snapshotConverterFunctions({

package/test/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@dereekb/firebase/test",
-  "version": "13.11.17",
+  "version": "13.12.0",
   "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.12.0",
+    "@dereekb/firebase": "13.12.0",
+    "@dereekb/model": "13.12.0",
+    "@dereekb/rxjs": "13.12.0",
+    "@dereekb/util": "13.12.0",
     "@firebase/rules-unit-testing": "5.0.0",
     "date-fns": "^4.1.0",
     "firebase": "^12.12.1",

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

@@ -1,112 +0,0 @@
-import type { Maybe } from '@dereekb/util';
-/**
- * The bundler hint string that marks a function call as side-effect-free.
- */
-export declare const NO_SIDE_EFFECTS_TAG = "@__NO_SIDE_EFFECTS__";
-type AstNode = any;
-export interface JsdocCommentInfo {
-    readonly node: AstNode;
-    readonly text: string;
-    readonly hasNoSideEffects: boolean;
-}
-export interface FunctionLeadingContext {
-    readonly jsdoc: Maybe<JsdocCommentInfo>;
-    /**
-     * Adjacent `@__NO_SIDE_EFFECTS__` line/block comments that should be migrated into the JSDoc
-     * and removed. Excludes the implementation-leading annotation on overloaded functions, which
-     * is tracked separately by {@link implLineComment} because it must be preserved.
-     */
-    readonly orphanLineComments: readonly AstNode[];
-    /**
-     * True when this implementation is preceded by sibling overload signatures (`TSDeclareFunction`
-     * statements with the same name).
-     */
-    readonly hasOverloads: boolean;
-    /**
-     * The `@__NO_SIDE_EFFECTS__` line/block comment immediately above the implementation
-     * declaration when the function has overloads. TypeScript erases overload signatures during
-     * emit, so JSDoc placed only on the first overload is dropped from the bundled JS — the
-     * line comment directly above the implementation is what survives and reaches the bundler.
-     *
-     * `null` when the function is single-signature (the line comment is then a removable orphan)
-     * or when no such comment is present.
-     */
-    readonly implLineComment: Maybe<AstNode>;
-    /**
-     * True when the implementation will carry the `@__NO_SIDE_EFFECTS__` annotation in the emitted
-     * JavaScript:
-     *
-     * - Single-signature: true when the (only) JSDoc carries the tag.
-     * - Overloaded: true when a line/block comment with the tag sits immediately above the
-     *   implementation, OR the implementation has its own JSDoc carrying the tag.
-     *
-     * This is the signal upstream packages need so esbuild/rollup can tree-shake unused calls.
-     */
-    readonly implHasSurvivingAnnotation: boolean;
-    /**
-     * The first statement in the overload chain (i.e. the first overload's export wrapper, or the
-     * implementation itself when there are no overloads). Use this as the insertion anchor when
-     * creating a brand-new JSDoc for the function, since docs conventionally live on the first
-     * overload rather than the implementation.
-     */
-    readonly chainStartStatement: AstNode;
-}
-/**
- * Returns true if the given comment text contains the @__NO_SIDE_EFFECTS__ marker.
- *
- * @param text - The comment body text (without the `/*` and `*\/` delimiters).
- * @returns True when the marker substring is present.
- */
-export declare function commentContainsNoSideEffects(text: string): boolean;
-/**
- * Returns the leading whitespace (column indent) of the line containing the given offset.
- *
- * @param sourceText - The full source text being inspected.
- * @param offset - A character offset into `sourceText` indicating the line of interest.
- * @returns The whitespace prefix (spaces/tabs) of that line.
- */
-export declare function getLineIndent(sourceText: string, offset: number): string;
-/**
- * Returns the outermost statement node for a FunctionDeclaration — its `ExportNamedDeclaration`
- * or `ExportDefaultDeclaration` parent if exported, otherwise the declaration itself. This is the
- * node ESLint attaches leading comments to.
- *
- * @param node - The FunctionDeclaration AST node.
- * @returns The statement node ESLint attaches leading comments to.
- */
-export declare function getStatementAnchor(node: AstNode): AstNode;
-/**
- * Returns the JSDoc Block comment immediately preceding `anchor`, or `null` when
- * the anchor has no JSDoc leader. Used by the `@dbx<Family>` companion-tag rules
- * to locate the tagged declaration's documentation.
- *
- * @param sourceCode - The ESLint `SourceCode` object.
- * @param anchor - The statement-level node ESLint attaches leading comments to.
- * @returns The JSDoc block comment, or null when none is present.
- */
-export declare function leadingJsdocFor(sourceCode: AstNode, anchor: AstNode): Maybe<AstNode>;
-/**
- * Walks backward from the implementation FunctionDeclaration through any overload signatures
- * with the same name, collecting:.
- *
- * - The leading JSDoc block (preferring the one attached to the **first** overload, since that's
- *   where the function's documentation conventionally lives).
- * - All orphan `@__NO_SIDE_EFFECTS__` line/block comments encountered between overloads or
- *   between the last overload and the implementation.
- *
- * This handles the common pattern:
- *
- * ```ts
- * \/\*\* doc \*\/
- * export function foo(a: number): number;
- * export function foo(a: string): string;
- * \/\/ \@__NO_SIDE_EFFECTS__
- * export function foo(a: any) { ... }
- * ```
- *
- * @param sourceCode - The ESLint `SourceCode` object used to read leading comments.
- * @param implNode - The implementation FunctionDeclaration node.
- * @returns The leading JSDoc (if any) and any orphan side-effect annotation comments.
- */
-export declare function findFunctionLeadingContext(sourceCode: AstNode, implNode: AstNode): FunctionLeadingContext;
-export {};

package/eslint/src/lib/dbx-tag-families.d.ts

@@ -1,280 +0,0 @@
-/**
- * Shared helpers for the `@dbx<Family>` companion-tag ESLint rules. Mirrors the
- * scanner schemas in `packages/dbx-components-mcp/src/scan/*-extract.ts` so
- * violations surface at lint time instead of at manifest-regeneration time.
- *
- * Each per-family rule supplies a {@link DbxTagFamilySpec} describing which
- * companions are required/optional, what value format each accepts, and which
- * messageId to emit when a check fails. The rule body itself only wires the
- * visitors and message map; all value-format validation lives here.
- */
-import type { Maybe } from '@dereekb/util';
-import { type ParsedJsdoc, type ParsedJsdocTag } from './jsdoc-parser';
-interface AstNode {
-    readonly type: string;
-    [key: string]: any;
-}
-/**
- * Kebab-case slug pattern: lowercase letters/digits, words separated by single hyphens,
- * starts with a letter. Used to validate slug/related/skill-ref values.
- */
-export declare const KEBAB_SLUG_PATTERN: RegExp;
-/**
- * Pascal-case TypeScript identifier pattern (starts uppercase). Used for model
- * identifiers and other `<ModelName>` style tag values.
- */
-export declare const PASCAL_IDENTIFIER_PATTERN: RegExp;
-/**
- * Discriminated description of how a companion tag's value should be parsed
- * and validated. The shared checker dispatches on `kind`.
- */
-export type DbxTagFormat = {
-    readonly kind: 'marker';
-} | {
-    readonly kind: 'kebab-slug';
-} | {
-    readonly kind: 'enum';
-    readonly values: readonly string[];
-} | {
-    readonly kind: 'pascal-identifier';
-} | {
-    readonly kind: 'comma-list-kebab-slug';
-} | {
-    readonly kind: 'comma-list-lowercase';
-} | {
-    readonly kind: 'comma-list-free-text';
-} | {
-    readonly kind: 'free-text';
-} | {
-    readonly kind: 'boolean';
-};
-/**
- * One companion-tag spec entry. `suffix` is appended to the family marker name
- * to form the full tag (e.g. `dbxPipe` + `Slug` → `@dbxPipeSlug`).
- */
-export interface DbxCompanionTagSpec {
-    readonly suffix: string;
-    readonly required?: boolean;
-    readonly multiple?: boolean;
-    readonly format: DbxTagFormat;
-}
-/**
- * The full set of companions plus the marker that triggers a family rule.
- */
-export interface DbxTagFamilySpec {
-    readonly marker: string;
-    readonly companions: readonly DbxCompanionTagSpec[];
-}
-/**
- * One violation emitted by {@link checkDbxTagFamily}. Each rule's `meta.messages`
- * map provides the message text for each `kind`.
- */
-export type DbxTagViolation = {
-    readonly kind: 'missing';
-    readonly suffix: string;
-    readonly lineIndex: number;
-} | {
-    readonly kind: 'empty';
-    readonly suffix: string;
-    readonly lineIndex: number;
-} | {
-    readonly kind: 'invalid-kebab';
-    readonly suffix: string;
-    readonly value: string;
-    readonly lineIndex: number;
-} | {
-    readonly kind: 'invalid-enum';
-    readonly suffix: string;
-    readonly value: string;
-    readonly allowed: readonly string[];
-    readonly lineIndex: number;
-} | {
-    readonly kind: 'invalid-pascal';
-    readonly suffix: string;
-    readonly value: string;
-    readonly lineIndex: number;
-} | {
-    readonly kind: 'invalid-boolean';
-    readonly suffix: string;
-    readonly value: string;
-    readonly lineIndex: number;
-} | {
-    readonly kind: 'comma-item-not-kebab';
-    readonly suffix: string;
-    readonly value: string;
-    readonly lineIndex: number;
-} | {
-    readonly kind: 'tags-not-lowercase';
-    readonly suffix: string;
-    readonly value: string;
-    readonly lineIndex: number;
-    readonly raw: ParsedJsdocTag;
-} | {
-    readonly kind: 'unknown';
-    readonly suffix: string;
-    readonly lineIndex: number;
-} | {
-    readonly kind: 'duplicate';
-    readonly suffix: string;
-    readonly lineIndex: number;
-};
-/**
- * Splits a comma-separated tag-value string into trimmed items, preserving order.
- *
- * @param value - Raw text following the tag name on a single line.
- * @returns Non-empty trimmed segments in declaration order.
- */
-export declare function splitCommaSeparated(value: string): string[];
-/**
- * Parses a boolean tag value using the workspace vocabulary
- * (`''`/`true`/`yes` → true; `false`/`no` → false). Other inputs return `undefined`.
- *
- * @param text - The trimmed tag value text.
- * @returns The parsed boolean, or `undefined` when the text is not in the vocabulary.
- */
-export declare function parseBooleanTagValue(text: string): Maybe<boolean>;
-/**
- * Returns the source-text offset of an offset-within-comment-value, given a Block comment node.
- *
- * @param commentNode - The ESLint Block comment AST node.
- * @param valueOffset - The character offset within `comment.value`.
- * @returns The character offset in the source file.
- */
-export declare function commentValueToSourceOffset(commentNode: AstNode, valueOffset: number): number;
-/**
- * Returns the family marker + companion tag list for the given parsed JSDoc.
- * Family membership is determined by tag-name prefix.
- *
- * @param parsed - The parsed JSDoc.
- * @param marker - The bare family marker (e.g. `'dbxPipe'`).
- * @returns The marker tag (if present), and all companion tags in source order.
- */
-export declare function findFamilyTags(parsed: ParsedJsdoc, marker: string): {
-    readonly markerTag: Maybe<ParsedJsdocTag>;
-    readonly familyTags: readonly ParsedJsdocTag[];
-};
-/**
- * Groups companion tags (those after the marker) by suffix. Marker entries are excluded.
- *
- * @param familyTags - The family tag list from {@link findFamilyTags}.
- * @param marker - The bare family marker.
- * @returns Lookup keyed by companion-suffix listing matching tags in declaration order.
- */
-export declare function groupCompanionsBySuffix(familyTags: readonly ParsedJsdocTag[], marker: string): Map<string, ParsedJsdocTag[]>;
-/**
- * Runs the canonical companion-tag validation pass for a `@dbx<Family>`-tagged
- * JSDoc against the supplied {@link DbxTagFamilySpec}. Emits one
- * {@link DbxTagViolation} per finding via `emit`; the calling rule maps each
- * violation to its own messageId.
- *
- * Validation pass order:
- *
- *   1. Unknown companions (typo detection — companions not in the spec).
- *   2. Required companions present (one violation per missing required tag).
- *   3. Duplicates (companion appears more than once, when `multiple` is not set).
- *   4. Per-companion value-format validation.
- *
- * Marker presence is the caller's responsibility — pass `markerPresent=true`
- * (i.e. `requireBareMarker` already satisfied) before invoking this.
- */
-export interface CheckDbxTagFamilyInput {
-    readonly parsed: ParsedJsdoc;
-    readonly spec: DbxTagFamilySpec;
-    readonly markerTag: ParsedJsdocTag;
-    readonly familyTags: readonly ParsedJsdocTag[];
-    readonly emit: (violation: DbxTagViolation) => void;
-}
-/**
- * Validates a `@dbx<Family>` marker plus its companion tags against the supplied spec.
- * Reports unknown companions, missing required companions, duplicates, and per-companion
- * value violations through `input.emit`.
- *
- * @param input - Parsed JSDoc, family spec, resolved marker/companion tags, and emit sink.
- *
- * @example
- * ```ts
- * checkDbxTagFamily({ parsed, spec, markerTag, familyTags, emit });
- * ```
- */
-export declare function checkDbxTagFamily(input: CheckDbxTagFamilyInput): void;
-/**
- * Wraps `context.report` with the family rule's common "report on a tag line"
- * helper. The shared rule body uses this to translate {@link DbxTagViolation}
- * locations into ESLint source ranges.
- */
-export interface ReportOnLineInput {
-    readonly commentNode: AstNode;
-    readonly parsed: ParsedJsdoc;
-    readonly sourceCode: AstNode;
-    readonly lineIndex: number;
-    readonly messageId: string;
-    readonly data?: Record<string, string>;
-    readonly report: (descriptor: {
-        loc: AstNode;
-        messageId: string;
-        data?: Record<string, string>;
-        fix?: (fixer: AstNode) => Maybe<AstNode | AstNode[]>;
-    }) => void;
-    readonly fix?: (fixer: AstNode) => Maybe<AstNode | AstNode[]>;
-}
-/**
- * Translates a JSDoc-line violation into an ESLint `context.report()` call by computing the
- * source range of the offending line and attaching the supplied message + optional fixer.
- *
- * @param input - Reporting context (comment node, parsed JSDoc, source code, line index, message id, optional data + fixer, report sink).
- *
- * @example
- * ```ts
- * reportOnJsdocLine({ commentNode, parsed, sourceCode, lineIndex: tag.startLineIndex, messageId: 'unknown', report: context.report });
- * ```
- */
-export declare function reportOnJsdocLine(input: ReportOnLineInput): void;
-/**
- * The visitor scopes used by `@dbx<Family>` companion-tag rules. Each rule
- * supplies a subset and the shared visitor wires them with the canonical
- * `getStatementAnchor` / `leadingJsdocFor` logic.
- */
-export type DbxFamilyVisitorKind = 'FunctionDeclaration' | 'VariableDeclaration' | 'ClassDeclaration' | 'TSInterfaceDeclaration' | 'TSTypeAliasDeclaration' | 'TSEnumDeclaration' | 'TSPropertySignature' | 'PropertyDefinition' | 'TSEnumMember';
-/**
- * Callback that maps a {@link DbxTagViolation} to its rule-specific
- * messageId + data, or `null` when the violation should be silently dropped
- * (e.g. when the rule does not require the missing companion).
- */
-export type DbxFamilyViolationMapper = (violation: DbxTagViolation) => Maybe<{
-    readonly messageId: string;
-    readonly data?: Record<string, string>;
-    readonly fixable?: boolean;
-}>;
-/**
- * Produces an auto-fix for a `@dbx<Family>Tags ...` line that lowercases every
- * token after the tag name. Returns the replacement source range + text, or
- * `undefined` when the line is already canonical.
- *
- * @param input - The fix context (comment node, parsed JSDoc, source code, tag).
- * @returns The replacement range/text, or `undefined` when no fix is needed.
- */
-export interface BuildLowercaseTagsFixInput {
-    readonly commentNode: AstNode;
-    readonly parsed: ParsedJsdoc;
-    readonly sourceCode: AstNode;
-    readonly tag: ParsedJsdocTag;
-}
-export interface LowercaseTagsFixResult {
-    readonly startOffset: number;
-    readonly endOffset: number;
-    readonly replacement: string;
-}
-/**
- * Computes an auto-fix descriptor that lowercases every token after a `@dbx<Family>Tags` tag
- * name. Returns `undefined` when the line is already canonical so the caller can short-circuit.
- *
- * @param input - Fix context (comment node, parsed JSDoc, source code, target tag).
- * @returns Replacement range + text when a rewrite is needed; otherwise `undefined`.
- *
- * @example
- * ```ts
- * const fix = buildLowercaseTagsFix({ commentNode, parsed, sourceCode, tag });
- * ```
- */
-export declare function buildLowercaseTagsFix(input: BuildLowercaseTagsFixInput): Maybe<LowercaseTagsFixResult>;
-export {};

package/eslint/src/lib/jsdoc-parser.d.ts

@@ -1,116 +0,0 @@
-import type { Maybe } from '@dereekb/util';
-/**
- * Minimal JSDoc parser used by the workspace's custom ESLint rules.
- *
- * Operates on the raw `value` of an ESLint Block comment (the text between `/*` and `*\/`,
- * which includes the leading `*` of a JSDoc opener). Returns a structured view of the comment:
- * description, paragraphs, tags (with their continuation lines), and per-line metadata.
- */
-/**
- * Per-line view of a comment body.
- */
-export interface ParsedJsdocLine {
-    /**
-     * Raw line content with leading whitespace + `*` prefix preserved.
-     */
-    readonly raw: string;
-    /**
-     * Text content after the leading whitespace + `*` + optional space prefix has been stripped.
-     */
-    readonly text: string;
-    /**
-     * True when the line is blank after stripping (only `* ` with nothing else).
-     */
-    readonly blank: boolean;
-    /**
-     * Index in the original `splitLines` array.
-     */
-    readonly index: number;
-    /**
-     * Character offset of `raw[0]` relative to the start of `commentValue` (not the source file).
-     */
-    readonly valueOffsetStart: number;
-    /**
-     * Character offset of `text[0]` relative to the start of `commentValue`. Equals `valueOffsetStart` plus the length of the stripped prefix.
-     */
-    readonly textOffsetStart: number;
-}
-/**
- * Parsed view of a single `@tag` block, including any continuation lines that follow it
- * up to the next tag (or end of comment).
- */
-export interface ParsedJsdocTag {
-    /**
-     * Tag name without the leading `@`, e.g. `param`, `returns`, `throws`, `dbxUtil`, `__NO_SIDE_EFFECTS__`.
-     */
-    readonly tag: string;
-    /**
-     * For `@param`: the parameter name. For other tags: `undefined`.
-     */
-    readonly name: Maybe<string>;
-    /**
-     * For `@throws` / `@param` style: the `{Type}` annotation if present.
-     */
-    readonly type: Maybe<string>;
-    /**
-     * Remaining text on the tag line + continuation lines, joined with `\n`. Trimmed of trailing whitespace.
-     */
-    readonly description: string;
-    /**
-     * All lines belonging to this tag (the tag line itself and any continuation lines).
-     */
-    readonly lines: readonly ParsedJsdocLine[];
-    /**
-     * Index in the comment-lines array where the tag starts.
-     */
-    readonly startLineIndex: number;
-    /**
-     * Index (inclusive) where the tag ends.
-     */
-    readonly endLineIndex: number;
-}
-/**
- * Parsed view of a whole JSDoc comment.
- */
-export interface ParsedJsdoc {
-    /**
-     * All lines in the comment body.
-     */
-    readonly lines: readonly ParsedJsdocLine[];
-    /**
-     * Lines belonging to the description (before any tag).
-     */
-    readonly descriptionLines: readonly ParsedJsdocLine[];
-    /**
-     * Description text joined with `\n`, with leading and trailing blank lines stripped.
-     */
-    readonly description: string;
-    /**
-     * Description split into paragraphs by blank lines, with each paragraph joined by `\n`.
-     */
-    readonly descriptionParagraphs: readonly string[];
-    /**
-     * All tags in source order.
-     */
-    readonly tags: readonly ParsedJsdocTag[];
-    /**
-     * True when the original comment is a single-line `/** ... *\/` block (no newlines).
-     */
-    readonly singleLine: boolean;
-}
-/**
- * Parses the value of an ESLint Block comment that represents a JSDoc into a structured form.
- *
- * @param commentValue - The `value` of an ESLint Block comment (text between `/*` and `*\/`, including the leading `*`).
- * @returns A structured view of the JSDoc with description, paragraphs, and tags.
- *
- * @example
- * ```ts
- * const parsed = parseJsdocComment('*\n * Hello.\n *\n * @param x - The value.\n ');
- * // parsed.description === 'Hello.'
- * // parsed.tags[0].tag === 'param'
- * // parsed.tags[0].name === 'x'
- * // parsed.tags[0].description === 'The value.'
- * ```
- */
-export declare function parseJsdocComment(commentValue: string): ParsedJsdoc;