firebase-contract 0.1.0-rc.9 → 0.1.0

package/dist/lib/_internal/validation/rules.js

@@ -1,5 +1,7 @@
 import { error, warning } from '../diagnostics.js';
-import { findModel } from '../ir/ir.js';
+import { constantCase } from '../generators/support/naming.js';
+import { isTable } from '../generators/support/split.js';
+import { findFragment, findModel } from '../ir/ir.js';
 const IDENTIFIER = /^[A-Za-z_][A-Za-z0-9_]*$/;
 /** Every field type must resolve to a known scalar, enum, or model. */
 export const unresolvedTypes = ir => ir.models.flatMap(model => model.fields
@@ -267,6 +269,134 @@ export const unions = ir => ir.unions.flatMap(union => {
     }
     return diagnostics;
 });
+/**
+ * A firestore doc's `extends` must reference a declared fragment. An unknown
+ * name would otherwise resolve to no fields and silently drop the shared
+ * columns (`extends: [metaa]` → no `_meta_`), the exact silent-coercion class
+ * the contract-is-truth rules exist to kill.
+ */
+export const fragmentRefs = ir => ir.firestore.flatMap(doc => doc.extends
+    .filter(name => !findFragment(ir, name))
+    .map(name => error('UNKNOWN_FRAGMENT', `Firestore doc "${doc.name}" extends unknown fragment "${name}"`, {
+    file: doc.sourceFile,
+    path: `firestore.${doc.name}.extends`,
+})));
+const RESERVED_OWNER = 'the generated runtime';
+/**
+ * Type names must be unique within every output namespace — the export surface
+ * where generated identifiers converge (a split layout still merges into one
+ * barrel, so physical files are irrelevant). Renames (`gqlName` / `fsName`)
+ * deliberately move a type between namespaces, so each namespace is checked
+ * independently against its *effective* names:
+ *
+ * - TypeScript types module: model/enum/union logical names, enum const
+ *   (`CONSTANT_CASE`) and `…Key` companions, plus the reserved `Json` type
+ * - zod schemas module: logical names and their `…Schema` companions
+ * - unions module: union names/schemas plus the variant schemas it imports
+ * - firestore module: doc names, co-located enums/embedded models under
+ *   `fsName ?? name`, plus the `FIRESTORE_DATABASES` runtime
+ *
+ * GraphQL names are checked separately ({@link graphqlNameCollisions}) because
+ * that namespace is scoped per data-connect-graphql declaration, not global.
+ *
+ * Same-kind duplicates are already DUPLICATE_DEFINITION at merge time; this
+ * rule closes every cross-kind and derived-identifier hole. Each colliding
+ * definition pair is reported once (the first namespace that trips).
+ */
+export const nameCollisions = ir => {
+    const diagnostics = [];
+    const reportedPairs = new Set();
+    const check = (space, claims) => {
+        const first = new Map();
+        for (const claim of claims) {
+            const prev = first.get(claim.identifier);
+            if (!prev) {
+                first.set(claim.identifier, claim);
+                continue;
+            }
+            if (prev.owner === claim.owner)
+                continue;
+            const pair = [prev.owner, claim.owner].sort().join(' vs ');
+            if (reportedPairs.has(pair))
+                continue;
+            reportedPairs.add(pair);
+            diagnostics.push(error('NAME_COLLISION', `${prev.owner} and ${claim.owner} both emit "${claim.identifier}" in the ${space} output`, {
+                file: claim.file ?? prev.file,
+                path: claim.path,
+            }));
+        }
+    };
+    const claim = (owner, file, path, identifiers) => identifiers.map(identifier => ({ owner, identifier, file, path }));
+    // TypeScript types module: the logical namespace every other output derives from.
+    check('TypeScript types', [
+        { owner: RESERVED_OWNER, identifier: 'Json', path: '(generated)' },
+        ...ir.models.flatMap(m => claim(`model "${m.name}"`, m.sourceFile, `models.${m.name}`, [m.name])),
+        ...ir.enums.flatMap(e => claim(`enum "${e.name}"`, e.sourceFile, `enums.${e.name}`, [e.name, `${e.name}Key`, constantCase(e.name)])),
+        ...ir.unions.flatMap(u => claim(`union "${u.name}"`, u.sourceFile, `unions.${u.name}`, [u.name])),
+    ]);
+    // zod schemas module: logical names plus their `…Schema` consts.
+    check('zod schemas', [
+        ...ir.models.flatMap(m => claim(`model "${m.name}"`, m.sourceFile, `models.${m.name}`, [m.name, `${m.name}Schema`])),
+        ...ir.enums.flatMap(e => claim(`enum "${e.name}"`, e.sourceFile, `enums.${e.name}`, [e.name, `${e.name}Schema`])),
+    ]);
+    // unions module: union declarations plus the variant schemas imported into it.
+    const variantOwners = new Map();
+    for (const union of ir.unions)
+        for (const variant of union.variants)
+            variantOwners.set(variant, `model "${variant}"`);
+    check('unions', [
+        ...ir.unions.flatMap(u => claim(`union "${u.name}"`, u.sourceFile, `unions.${u.name}`, [u.name, `${u.name}Schema`])),
+        ...[...variantOwners.entries()].map(([variant, owner]) => {
+            const model = findModel(ir, variant);
+            return { owner, identifier: `${variant}Schema`, file: model?.sourceFile, path: `models.${variant}` };
+        }),
+    ]);
+    // firestore module: doc schemas + co-located enums/embedded models under fsName-effective names.
+    // Tables are imported as `Dc…Schema` aliases, so they don't claim names here.
+    check('firestore', [
+        ...['FIRESTORE_DATABASES', 'FirestoreDatabaseKey', 'FirestoreDatabaseId'].map(identifier => ({ owner: RESERVED_OWNER, identifier, path: '(generated)' })),
+        ...ir.firestore.flatMap(d => claim(`firestore doc "${d.name}"`, d.sourceFile, `firestore.${d.name}`, [d.name, `${d.name}Schema`])),
+        ...ir.enums.flatMap(e => {
+            const fs = e.fsName ?? e.name;
+            return claim(`enum "${e.name}"`, e.sourceFile, `enums.${e.name}`, [fs, `${fs}Key`, constantCase(fs), `${fs}Schema`]);
+        }),
+        ...ir.models
+            .filter(m => !isTable(m))
+            .flatMap(m => {
+            const fs = m.fsName ?? m.name;
+            return claim(`model "${m.name}"`, m.sourceFile, `models.${m.name}`, [fs, `${fs}Schema`]);
+        }),
+    ]);
+    return diagnostics;
+};
+/**
+ * GraphQL name uniqueness under `gqlName ?? name`. Unlike {@link nameCollisions}
+ * this is NOT a default rule: a GraphQL schema exists per `data-connect-graphql`
+ * declaration, scoped to the declaring yml's import subtree — distinct services
+ * may intentionally reuse a gqlName (e.g. a `T2…` logical name mapped back to
+ * the plain name inside its own service). The compiler runs this check only
+ * when the entry document itself declares a GraphQL-emitting generator, i.e.
+ * exactly at the scope the schema is generated from.
+ */
+export const graphqlNameCollisions = ir => {
+    const diagnostics = [];
+    const first = new Map();
+    const claims = [
+        ...ir.models.map(m => ({ owner: `model "${m.name}"`, name: m.gqlName ?? m.name, file: m.sourceFile, path: `models.${m.name}` })),
+        ...ir.enums.map(e => ({ owner: `enum "${e.name}"`, name: e.gqlName ?? e.name, file: e.sourceFile, path: `enums.${e.name}` })),
+    ];
+    for (const { owner, name, file, path } of claims) {
+        const prev = first.get(name);
+        if (!prev) {
+            first.set(name, { owner, file, path });
+            continue;
+        }
+        if (prev.owner === owner)
+            continue;
+        diagnostics.push(error('NAME_COLLISION', `${prev.owner} and ${owner} both emit "${name}" in the GraphQL schema output`, { file: file ?? prev.file, path }));
+    }
+    return diagnostics;
+};
 export const DEFAULT_RULES = [
     unresolvedTypes,
     emptyEnums,
@@ -279,4 +409,6 @@ export const DEFAULT_RULES = [
     apis,
     firestore,
     unions,
+    fragmentRefs,
+    nameCollisions,
 ];

package/dist/lib/cli/commands/generate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../../../../src/lib/cli/commands/generate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AA4BnC,eAAO,MAAM,gBAAgB,GAAI,SAAS,OAAO,KAAG,IAgFnD,CAAA"}
+{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../../../../src/lib/cli/commands/generate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AA4BnC,eAAO,MAAM,gBAAgB,GAAI,SAAS,OAAO,KAAG,IAiFnD,CAAA"}

package/dist/lib/cli/commands/generate.js

@@ -27,14 +27,16 @@ export const registerGenerate = (program) => {
         .action((entryArg, flags) => {
         const config = loadConfig();
         const entry = entryArg ?? config.entry ?? 'contract.yml';
-        const outDir = flags.outDir ?? config.outDir ?? 'generated';
-        const generators = flags.generators?.split(',').map(name => name.trim()).filter(Boolean) ?? config.generators;
+        const outDir = flags.outDir ?? 'generated';
+        const generators = flags.generators?.split(',').map(name => name.trim()).filter(Boolean);
         const header = flags.header === true ? DEFAULT_HEADER : typeof flags.header === 'string' ? toHeaderComment(flags.header) : undefined;
         const registry = createDefaultRegistry();
         const context = header !== undefined ? { header } : undefined;
         // Without -o/-g, run every generator declared in the contract
-        // graph — the one-command flow. Flags switch back to single-target mode.
-        const explicit = flags.outDir !== undefined || flags.generators !== undefined || config.outDir !== undefined || config.generators !== undefined;
+        // graph — the one-command flow. Only explicit flags switch back to
+        // single-target mode; the config file cannot (it must never silently
+        // disable the contract's own generators: declarations).
+        const explicit = flags.outDir !== undefined || flags.generators !== undefined;
         if (!explicit) {
             const all = generateAll(entry, { registry, write: !flags.check, ...(context ? { context } : {}) });
             if (all.targets.length > 0 || !all.ok) {

package/dist/lib/cli/commands/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/cli/commands/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAOnC,iDAAiD;AACjD,eAAO,MAAM,gBAAgB,GAAI,SAAS,OAAO,KAAG,IAKnD,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/cli/commands/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAQnC,iDAAiD;AACjD,eAAO,MAAM,gBAAgB,GAAI,SAAS,OAAO,KAAG,IAMnD,CAAA"}

package/dist/lib/cli/commands/index.js

@@ -2,10 +2,12 @@ import { registerGenerate } from './generate.js';
 import { registerInit } from './init.js';
 import { registerInspect } from './inspect.js';
 import { registerValidate } from './validate.js';
+import { registerWhere } from './where.js';
 /** Register every CLI command on the program. */
 export const registerCommands = (program) => {
     registerInit(program);
     registerValidate(program);
     registerGenerate(program);
     registerInspect(program);
+    registerWhere(program);
 };

package/dist/lib/cli/commands/init.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../../../src/lib/cli/commands/init.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAqEnC,eAAO,MAAM,YAAY,GAAI,SAAS,OAAO,KAAG,IAgB/C,CAAA"}
+{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../../../src/lib/cli/commands/init.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAgDnC,eAAO,MAAM,YAAY,GAAI,SAAS,OAAO,KAAG,IAgB/C,CAAA"}

package/dist/lib/cli/commands/init.js

@@ -1,9 +1,7 @@
 import { existsSync, writeFileSync } from 'node:fs';
 import { resolve } from 'node:path';
 import { CONFIG_FILENAME } from '../config.js';
-const EXAMPLE_CONTRACT = `version: 1
-
-# Declare generators once (name + output template); entries opt in below.
+const EXAMPLE_CONTRACT = `# Declare generators once (name + output template); entries opt in below.
 generators:
   - { generator: typescript, out: generated }
   - { generator: zod, out: generated }
@@ -36,21 +34,7 @@ models:
       metadata: { type: json, optional: true }
       createdAt: timestamp
 `;
-const EXAMPLE_CONFIG = JSON.stringify({
-    entry: 'contract.yml',
-    outDir: 'generated',
-    generators: [
-        'typescript',
-        'zod',
-        'data-connect-graphql',
-        'data-connect-operations',
-        'data-connect-adapter',
-        'firestore-types',
-        'firestore',
-        'api-types',
-        'api-validation',
-    ],
-}, null, 2) + '\n';
+const EXAMPLE_CONFIG = JSON.stringify({ entry: 'contract.yml' }, null, 2) + '\n';
 const writeIfAbsent = (path, content, force) => {
     if (existsSync(path) && !force) {
         return false;

package/dist/lib/cli/commands/where.d.ts

@@ -0,0 +1,3 @@
+import { Command } from 'commander';
+export declare const registerWhere: (program: Command) => void;
+//# sourceMappingURL=where.d.ts.map

package/dist/lib/cli/commands/where.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"where.d.ts","sourceRoot":"","sources":["../../../../src/lib/cli/commands/where.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AA+CnC,eAAO,MAAM,aAAa,GAAI,SAAS,OAAO,KAAG,IA2BhD,CAAA"}

package/dist/lib/cli/commands/where.js

@@ -0,0 +1,57 @@
+import { compile } from '../../_internal/compiler/compiler.js';
+import { hasErrors } from '../../_internal/diagnostics.js';
+import { formatDiagnostics } from '../../_internal/format-diagnostics.js';
+import { loadConfig } from '../config.js';
+const definitionsOf = (ir) => [
+    ...ir.models.map(m => ({
+        kind: 'model',
+        name: m.name,
+        sourceFile: m.sourceFile,
+        yamlPath: `models.${m.name}`,
+        renames: [
+            ...(m.gqlName ? [`gqlName: ${m.gqlName}`] : []),
+            ...(m.fsName ? [`fsName: ${m.fsName}`] : []),
+            ...(m.table ? [`table: ${m.table}`] : []),
+        ],
+    })),
+    ...ir.enums.map(e => ({
+        kind: 'enum',
+        name: e.name,
+        sourceFile: e.sourceFile,
+        yamlPath: `enums.${e.name}`,
+        renames: [...(e.gqlName ? [`gqlName: ${e.gqlName}`] : []), ...(e.fsName ? [`fsName: ${e.fsName}`] : [])],
+    })),
+    ...ir.unions.map(u => ({ kind: 'union', name: u.name, sourceFile: u.sourceFile, yamlPath: `unions.${u.name}`, renames: [] })),
+    ...ir.firestore.map(d => ({ kind: 'firestore doc', name: d.name, sourceFile: d.sourceFile, yamlPath: `firestore.${d.name}`, renames: [] })),
+    ...ir.envelopes.map(e => ({ kind: 'envelope', name: e.name, sourceFile: e.sourceFile, yamlPath: `envelopes.${e.name}`, renames: [] })),
+    ...ir.apis.map(a => ({ kind: 'api', name: a.name, sourceFile: a.sourceFile, yamlPath: `apis.${a.name}`, renames: [] })),
+    ...ir.operations.map(o => ({ kind: 'operation', name: o.name, sourceFile: o.sourceFile, yamlPath: `operations.${o.name}`, renames: [] })),
+];
+/** True when the definition is known by `query` under any of its names. */
+const matches = (definition, query) => definition.name === query || definition.renames.some(rename => rename.endsWith(`: ${query}`));
+export const registerWhere = (program) => {
+    program
+        .command('where')
+        .description('Locate the yml that defines a type (matches logical, gqlName, fsName, and table names)')
+        .argument('<name>', 'type name to look up')
+        .argument('[entry]', 'entry contract file')
+        .action((name, entryArg) => {
+        const config = loadConfig();
+        const entry = entryArg ?? config.entry ?? 'contract.yml';
+        const { ir, diagnostics } = compile(entry);
+        if (hasErrors(diagnostics)) {
+            console.error(formatDiagnostics(diagnostics));
+            process.exit(1);
+        }
+        const found = definitionsOf(ir).filter(definition => matches(definition, name));
+        if (found.length === 0) {
+            console.error(`"${name}" is not defined in ${entry} or its imports`);
+            process.exit(1);
+        }
+        for (const definition of found) {
+            const location = definition.sourceFile ?? '(unknown file)';
+            const renames = definition.renames.length > 0 ? `  [${definition.renames.join(', ')}]` : '';
+            console.log(`${definition.kind} ${definition.name}  ${location}  (${definition.yamlPath})${renames}`);
+        }
+    });
+};

package/dist/lib/cli/config.d.ts

@@ -1,12 +1,13 @@
 export declare const CONFIG_FILENAME = "firebase-contract.json";
 export interface FbcConfig {
     entry?: string;
-    outDir?: string;
-    generators?: string[];
 }
 /**
  * Load `firebase-contract.json` from `cwd` if present. CLI flags override these
  * values; the config only supplies defaults so common invocations stay short.
+ * Deliberately only `entry`: a config-side outDir/generators used to flip
+ * `fbc generate` into single-target mode, silently ignoring every `generators:`
+ * declaration in the contract graph — output routing belongs in the yml.
  */
 export declare const loadConfig: (cwd?: string) => FbcConfig;
 //# sourceMappingURL=config.d.ts.map

package/dist/lib/cli/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/lib/cli/config.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,eAAe,2BAA2B,CAAA;AAEvD,MAAM,WAAW,SAAS;IACxB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;CACtB;AAED;;;GAGG;AACH,eAAO,MAAM,UAAU,GAAI,MAAK,MAAsB,KAAG,SAWxD,CAAA"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/lib/cli/config.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,eAAe,2BAA2B,CAAA;AAEvD,MAAM,WAAW,SAAS;IACxB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,GAAI,MAAK,MAAsB,KAAG,SAWxD,CAAA"}

package/dist/lib/cli/config.js

@@ -4,6 +4,9 @@ export const CONFIG_FILENAME = 'firebase-contract.json';
 /**
  * Load `firebase-contract.json` from `cwd` if present. CLI flags override these
  * values; the config only supplies defaults so common invocations stay short.
+ * Deliberately only `entry`: a config-side outDir/generators used to flip
+ * `fbc generate` into single-target mode, silently ignoring every `generators:`
+ * declaration in the contract graph — output routing belongs in the yml.
  */
 export const loadConfig = (cwd = process.cwd()) => {
     const path = resolve(cwd, CONFIG_FILENAME);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-contract",
-  "version": "0.1.0-rc.9",
+  "version": "0.1.0",
   "type": "module",
   "bin": {
     "firebase-contract": "./dist/lib/cli/index.js",