firebase-contract 0.1.0-rc.0

package/dist/lib/_internal/generators/index.d.ts

@@ -0,0 +1,31 @@
+import { GeneratorRegistry } from './registry.js';
+export type { GeneratedFile, Generator, GeneratorContext } from './generator.js';
+export { GeneratorRegistry } from './registry.js';
+export { createTypeScriptGenerator } from './typescript/typescript-generator.js';
+export { createTypeScriptSplitGenerator } from './typescript/typescript-split-generator.js';
+export type { TypeScriptGeneratorOptions } from './typescript/typescript-generator.js';
+export { createZodGenerator } from './zod/zod-generator.js';
+export { createZodSplitGenerator } from './zod/zod-split-generator.js';
+export { createDataConnectGraphqlGenerator, createDataConnectGraphqlSplitGenerator } from './data-connect/graphql-generator.js';
+export { createDataConnectAdapterGenerator } from './data-connect/adapter-generator.js';
+export { createDataConnectOperationsGenerator, createDataConnectOperationsSplitGenerator } from './data-connect/operations-generator.js';
+export { createFirestoreTypeGenerator } from './firestore/firestore-type-generator.js';
+export type { FirestoreGeneratorOptions } from './firestore/firestore-type-generator.js';
+export { createFirestoreProjectionGenerator } from './firestore/firestore-projection-generator.js';
+export { createFirestoreSplitGenerator } from './firestore/firestore-split-generator.js';
+export { createApiTypesGenerator } from './api/api-types-generator.js';
+export { createApiValidationGenerator } from './api/api-validation-generator.js';
+export { createApiDtoGenerator } from './api/api-dto-generator.js';
+export { createTaskPayloadGenerator } from './api/task-payload-generator.js';
+export { createSqlMigrationGenerator } from './sql/sql-migration-generator.js';
+export { createIdCodecGenerator } from './id/id-codec-generator.js';
+export type { IdCodecGeneratorOptions } from './id/id-codec-generator.js';
+export { createUnionGenerator } from './union/union-generator.js';
+export { createConfigGenerator } from './config/config-generator.js';
+/**
+ * Build a registry populated with the built-in generators:
+ * TypeScript, Zod, Data Connect (GraphQL schema / operations / adapter),
+ * Firestore types, and the API layer (types / request validation).
+ */
+export declare const createDefaultRegistry: () => GeneratorRegistry;
+//# sourceMappingURL=index.d.ts.map

package/dist/lib/_internal/generators/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/_internal/generators/index.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAA;AAMjD,YAAY,EAAE,aAAa,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAChF,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAA;AACjD,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAA;AAChF,OAAO,EAAE,8BAA8B,EAAE,MAAM,4CAA4C,CAAA;AAC3F,YAAY,EAAE,0BAA0B,EAAE,MAAM,sCAAsC,CAAA;AACtF,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAA;AAC3D,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAA;AACtE,OAAO,EAAE,iCAAiC,EAAE,sCAAsC,EAAE,MAAM,qCAAqC,CAAA;AAC/H,OAAO,EAAE,iCAAiC,EAAE,MAAM,qCAAqC,CAAA;AACvF,OAAO,EAAE,oCAAoC,EAAE,yCAAyC,EAAE,MAAM,wCAAwC,CAAA;AACxI,OAAO,EAAE,4BAA4B,EAAE,MAAM,yCAAyC,CAAA;AACtF,YAAY,EAAE,yBAAyB,EAAE,MAAM,yCAAyC,CAAA;AACxF,OAAO,EAAE,kCAAkC,EAAE,MAAM,+CAA+C,CAAA;AAClG,OAAO,EAAE,6BAA6B,EAAE,MAAM,0CAA0C,CAAA;AACxF,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAA;AACtE,OAAO,EAAE,4BAA4B,EAAE,MAAM,mCAAmC,CAAA;AAChF,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAA;AAClE,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAA;AAC5E,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAA;AAC9E,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAA;AACnE,YAAY,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAA;AACzE,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAA;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAA;AAEpE;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,QAAO,iBAqBH,CAAA"}

package/dist/lib/_internal/generators/index.js

@@ -0,0 +1,64 @@
+import { createApiDtoGenerator } from './api/api-dto-generator.js';
+import { createApiTypesGenerator } from './api/api-types-generator.js';
+import { createApiValidationGenerator } from './api/api-validation-generator.js';
+import { createTaskPayloadGenerator } from './api/task-payload-generator.js';
+import { createConfigGenerator } from './config/config-generator.js';
+import { createDataConnectAdapterGenerator } from './data-connect/adapter-generator.js';
+import { createDataConnectGraphqlGenerator, createDataConnectGraphqlSplitGenerator } from './data-connect/graphql-generator.js';
+import { createDataConnectOperationsGenerator, createDataConnectOperationsSplitGenerator } from './data-connect/operations-generator.js';
+import { createFirestoreProjectionGenerator } from './firestore/firestore-projection-generator.js';
+import { createFirestoreSplitGenerator } from './firestore/firestore-split-generator.js';
+import { createFirestoreTypeGenerator } from './firestore/firestore-type-generator.js';
+import { createIdCodecGenerator } from './id/id-codec-generator.js';
+import { createSqlMigrationGenerator } from './sql/sql-migration-generator.js';
+import { createUnionGenerator } from './union/union-generator.js';
+import { GeneratorRegistry } from './registry.js';
+import { createTypeScriptGenerator } from './typescript/typescript-generator.js';
+import { createTypeScriptSplitGenerator } from './typescript/typescript-split-generator.js';
+import { createZodGenerator } from './zod/zod-generator.js';
+import { createZodSplitGenerator } from './zod/zod-split-generator.js';
+export { GeneratorRegistry } from './registry.js';
+export { createTypeScriptGenerator } from './typescript/typescript-generator.js';
+export { createTypeScriptSplitGenerator } from './typescript/typescript-split-generator.js';
+export { createZodGenerator } from './zod/zod-generator.js';
+export { createZodSplitGenerator } from './zod/zod-split-generator.js';
+export { createDataConnectGraphqlGenerator, createDataConnectGraphqlSplitGenerator } from './data-connect/graphql-generator.js';
+export { createDataConnectAdapterGenerator } from './data-connect/adapter-generator.js';
+export { createDataConnectOperationsGenerator, createDataConnectOperationsSplitGenerator } from './data-connect/operations-generator.js';
+export { createFirestoreTypeGenerator } from './firestore/firestore-type-generator.js';
+export { createFirestoreProjectionGenerator } from './firestore/firestore-projection-generator.js';
+export { createFirestoreSplitGenerator } from './firestore/firestore-split-generator.js';
+export { createApiTypesGenerator } from './api/api-types-generator.js';
+export { createApiValidationGenerator } from './api/api-validation-generator.js';
+export { createApiDtoGenerator } from './api/api-dto-generator.js';
+export { createTaskPayloadGenerator } from './api/task-payload-generator.js';
+export { createSqlMigrationGenerator } from './sql/sql-migration-generator.js';
+export { createIdCodecGenerator } from './id/id-codec-generator.js';
+export { createUnionGenerator } from './union/union-generator.js';
+export { createConfigGenerator } from './config/config-generator.js';
+/**
+ * Build a registry populated with the built-in generators:
+ * TypeScript, Zod, Data Connect (GraphQL schema / operations / adapter),
+ * Firestore types, and the API layer (types / request validation).
+ */
+export const createDefaultRegistry = () => new GeneratorRegistry()
+    .register(createTypeScriptGenerator())
+    .register(createTypeScriptSplitGenerator())
+    .register(createZodGenerator())
+    .register(createZodSplitGenerator())
+    .register(createDataConnectGraphqlGenerator())
+    .register(createDataConnectGraphqlSplitGenerator())
+    .register(createDataConnectOperationsGenerator())
+    .register(createDataConnectOperationsSplitGenerator())
+    .register(createDataConnectAdapterGenerator())
+    .register(createFirestoreTypeGenerator())
+    .register(createFirestoreProjectionGenerator())
+    .register(createFirestoreSplitGenerator())
+    .register(createApiTypesGenerator())
+    .register(createApiValidationGenerator())
+    .register(createApiDtoGenerator())
+    .register(createTaskPayloadGenerator())
+    .register(createSqlMigrationGenerator())
+    .register(createIdCodecGenerator())
+    .register(createUnionGenerator())
+    .register(createConfigGenerator());

package/dist/lib/_internal/generators/registry.d.ts

@@ -0,0 +1,15 @@
+import { Generator } from './generator.js';
+/**
+ * Holds the set of available generators keyed by name. The compiler resolves
+ * requested generators through the registry, so adding a new generator is just
+ * a `register` call — no existing code changes.
+ */
+export declare class GeneratorRegistry {
+    private readonly generators;
+    register(generator: Generator): this;
+    has(name: string): boolean;
+    get(name: string): Generator | undefined;
+    names(): string[];
+    list(): Generator[];
+}
+//# sourceMappingURL=registry.d.ts.map

package/dist/lib/_internal/generators/registry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../../../src/lib/_internal/generators/registry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE1C;;;;GAIG;AACH,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA+B;IAE1D,QAAQ,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI;IAKpC,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI1B,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IAIxC,KAAK,IAAI,MAAM,EAAE;IAIjB,IAAI,IAAI,SAAS,EAAE;CAGpB"}

package/dist/lib/_internal/generators/registry.js

@@ -0,0 +1,24 @@
+/**
+ * Holds the set of available generators keyed by name. The compiler resolves
+ * requested generators through the registry, so adding a new generator is just
+ * a `register` call — no existing code changes.
+ */
+export class GeneratorRegistry {
+    generators = new Map();
+    register(generator) {
+        this.generators.set(generator.name, generator);
+        return this;
+    }
+    has(name) {
+        return this.generators.has(name);
+    }
+    get(name) {
+        return this.generators.get(name);
+    }
+    names() {
+        return [...this.generators.keys()];
+    }
+    list() {
+        return [...this.generators.values()];
+    }
+}

package/dist/lib/_internal/generators/sql/sql-migration-generator.d.ts

@@ -0,0 +1,9 @@
+import { Generator } from '../generator.js';
+/**
+ * Generates raw SQL migrations for constraints Data Connect cannot express:
+ * composite foreign keys, CHECK constraints, and extra indexes — constraints
+ * that otherwise live only as hand-written schema comments with no executable
+ * artifact. This turns them into a runnable `.sql` file.
+ */
+export declare const createSqlMigrationGenerator: () => Generator;
+//# sourceMappingURL=sql-migration-generator.d.ts.map

package/dist/lib/_internal/generators/sql/sql-migration-generator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sql-migration-generator.d.ts","sourceRoot":"","sources":["../../../../../src/lib/_internal/generators/sql/sql-migration-generator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAiB,SAAS,EAAoB,MAAM,iBAAiB,CAAA;AA+B5E;;;;;GAKG;AACH,eAAO,MAAM,2BAA2B,QAAO,SAY7C,CAAA"}

package/dist/lib/_internal/generators/sql/sql-migration-generator.js

@@ -0,0 +1,44 @@
+import { pluralize, snakeCase } from '../support/naming.js';
+import { headerBlocks } from '../support/header.js';
+const tableName = (model) => model.table ?? pluralize(snakeCase(model.name));
+const renderModelSql = (model) => {
+    const sql = model.sql;
+    if (!sql)
+        return [];
+    const table = tableName(model);
+    const statements = [];
+    sql.checks.forEach((expr, i) => {
+        const name = `${table}_chk_${i + 1}`;
+        statements.push(`ALTER TABLE "${table}" ADD CONSTRAINT "${name}" CHECK (${expr});`);
+    });
+    for (const fk of sql.foreignKeys) {
+        const name = fk.name ?? `${table}_${fk.columns.join('_')}_fkey`;
+        const cols = fk.columns.map(c => `"${c}"`).join(', ');
+        statements.push(`ALTER TABLE "${table}" ADD CONSTRAINT "${name}" FOREIGN KEY (${cols}) REFERENCES ${fk.references};`);
+    }
+    for (const idx of sql.indexes) {
+        const name = idx.name ?? `${table}_${idx.columns.join('_')}_${idx.unique ? 'uidx' : 'idx'}`;
+        const cols = idx.columns.map(c => `"${c}"`).join(', ');
+        statements.push(`CREATE ${idx.unique ? 'UNIQUE ' : ''}INDEX "${name}" ON "${table}" (${cols});`);
+    }
+    return statements.length > 0 ? [`-- ${model.name} (${table})`, ...statements] : [];
+};
+/**
+ * Generates raw SQL migrations for constraints Data Connect cannot express:
+ * composite foreign keys, CHECK constraints, and extra indexes — constraints
+ * that otherwise live only as hand-written schema comments with no executable
+ * artifact. This turns them into a runnable `.sql` file.
+ */
+export const createSqlMigrationGenerator = () => ({
+    name: 'sql-migrations',
+    description: 'Raw SQL migrations for composite FK / CHECK / index constraints',
+    generate(ir, context) {
+        const blocks = ir.models.flatMap(renderModelSql);
+        if (blocks.length === 0) {
+            return [];
+        }
+        const banner = headerBlocks(context, header => header.replace(/^\/\/ ?/gm, '-- '));
+        const content = `${[...banner, blocks.join('\n')].join('\n\n')}\n`;
+        return [{ path: 'migrations/constraints.sql', content }];
+    },
+});

package/dist/lib/_internal/generators/support/constraints.d.ts

@@ -0,0 +1,8 @@
+import { IrField } from '../../ir/ir.js';
+/**
+ * Zod constraint chain for a field. For list fields the constraints apply to the
+ * array (length); otherwise to the value. Returned as a suffix to append after
+ * the base schema (and after `z.array(...)` for lists).
+ */
+export declare const zodConstraints: (field: IrField) => string;
+//# sourceMappingURL=constraints.d.ts.map

package/dist/lib/_internal/generators/support/constraints.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constraints.d.ts","sourceRoot":"","sources":["../../../../../src/lib/_internal/generators/support/constraints.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAQxC;;;;GAIG;AACH,eAAO,MAAM,cAAc,GAAI,OAAO,OAAO,KAAG,MAqB/C,CAAA"}

package/dist/lib/_internal/generators/support/constraints.js

@@ -0,0 +1,39 @@
+const isNumber = (field) => field.type.kind === 'scalar' && (field.type.name === 'int' || field.type.name === 'int64' || field.type.name === 'float');
+const isStringy = (field) => field.type.kind === 'scalar' && (field.type.name === 'string' || field.type.name === 'id');
+/**
+ * Zod constraint chain for a field. For list fields the constraints apply to the
+ * array (length); otherwise to the value. Returned as a suffix to append after
+ * the base schema (and after `z.array(...)` for lists).
+ */
+export const zodConstraints = (field) => {
+    const c = field.constraints;
+    const parts = [];
+    if (field.list) {
+        if (c.minLength !== undefined)
+            parts.push(`.min(${c.minLength})`);
+        if (c.maxLength !== undefined)
+            parts.push(`.max(${c.maxLength})`);
+        if (c.nonempty)
+            parts.push('.nonempty()');
+        return parts.join('');
+    }
+    if (isNumber(field)) {
+        if (c.min !== undefined)
+            parts.push(`.min(${c.min})`);
+        if (c.max !== undefined)
+            parts.push(`.max(${c.max})`);
+    }
+    if (isStringy(field)) {
+        if (c.email)
+            parts.push('.email()');
+        if (c.url)
+            parts.push('.url()');
+        if (c.nonempty || c.minLength !== undefined)
+            parts.push(`.min(${c.minLength ?? 1})`);
+        if (c.maxLength !== undefined)
+            parts.push(`.max(${c.maxLength})`);
+        if (c.pattern)
+            parts.push(`.regex(/${c.pattern}/)`);
+    }
+    return parts.join('');
+};

package/dist/lib/_internal/generators/support/header.d.ts

@@ -0,0 +1,13 @@
+import { GeneratorContext } from '../generator.js';
+/** Default banner marking a file as generated (do-not-edit). */
+export declare const DEFAULT_HEADER: string;
+/** Turn raw header text into `//` comment lines; `default` selects the built-in banner. */
+export declare const toHeaderComment: (text: string) => string;
+/** The configured header in `//` comment form, or `''` when none is configured. */
+export declare const headerFor: (context: GeneratorContext | undefined) => string;
+/**
+ * The header as a leading block list — empty when no header is configured, so
+ * generators can spread it without emitting blank lines.
+ */
+export declare const headerBlocks: (context: GeneratorContext | undefined, transform?: (header: string) => string) => string[];
+//# sourceMappingURL=header.d.ts.map

package/dist/lib/_internal/generators/support/header.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"header.d.ts","sourceRoot":"","sources":["../../../../../src/lib/_internal/generators/support/header.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAElD,gEAAgE;AAChE,eAAO,MAAM,cAAc,QAGf,CAAA;AAEZ,2FAA2F;AAC3F,eAAO,MAAM,eAAe,GAAI,MAAM,MAAM,KAAG,MACwD,CAAA;AAEvG,mFAAmF;AACnF,eAAO,MAAM,SAAS,GAAI,SAAS,gBAAgB,GAAG,SAAS,KAAG,MAA+B,CAAA;AAEjG;;;GAGG;AACH,eAAO,MAAM,YAAY,GACvB,SAAS,gBAAgB,GAAG,SAAS,EACrC,YAAW,CAAC,MAAM,EAAE,MAAM,KAAK,MAAyB,KACvD,MAAM,EAGR,CAAA"}

package/dist/lib/_internal/generators/support/header.js

@@ -0,0 +1,17 @@
+/** Default banner marking a file as generated (do-not-edit). */
+export const DEFAULT_HEADER = [
+    '// AUTO-GENERATED by firebase-contract. Do not edit by hand.',
+    '// Regenerate with: fbc generate',
+].join('\n');
+/** Turn raw header text into `//` comment lines; `default` selects the built-in banner. */
+export const toHeaderComment = (text) => text === 'default' ? DEFAULT_HEADER : text.split('\n').map(line => `// ${line}`.trimEnd()).join('\n');
+/** The configured header in `//` comment form, or `''` when none is configured. */
+export const headerFor = (context) => context?.header ?? '';
+/**
+ * The header as a leading block list — empty when no header is configured, so
+ * generators can spread it without emitting blank lines.
+ */
+export const headerBlocks = (context, transform = header => header) => {
+    const header = headerFor(context);
+    return header ? [transform(header)] : [];
+};

package/dist/lib/_internal/generators/support/naming.d.ts

@@ -0,0 +1,10 @@
+/** Stateless naming helpers shared by generators. Pure functions only. */
+export declare const pascalCase: (value: string) => string;
+export declare const camelCase: (value: string) => string;
+export declare const constantCase: (value: string) => string;
+export declare const snakeCase: (value: string) => string;
+/** Naive English pluralization sufficient for table naming. */
+export declare const pluralize: (value: string) => string;
+/** Escape a string for use inside a single-quoted TypeScript literal. */
+export declare const singleQuote: (value: string) => string;
+//# sourceMappingURL=naming.d.ts.map

package/dist/lib/_internal/generators/support/naming.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"naming.d.ts","sourceRoot":"","sources":["../../../../../src/lib/_internal/generators/support/naming.ts"],"names":[],"mappings":"AAAA,0EAA0E;AAU1E,eAAO,MAAM,UAAU,GAAI,OAAO,MAAM,KAAG,MAG9B,CAAA;AAEb,eAAO,MAAM,SAAS,GAAI,OAAO,MAAM,KAAG,MAGzC,CAAA;AAED,eAAO,MAAM,YAAY,GAAI,OAAO,MAAM,KAAG,MAG/B,CAAA;AAEd,eAAO,MAAM,SAAS,GAAI,OAAO,MAAM,KAAG,MAG5B,CAAA;AAEd,+DAA+D;AAC/D,eAAO,MAAM,SAAS,GAAI,OAAO,MAAM,KAAG,MAIzC,CAAA;AAED,yEAAyE;AACzE,eAAO,MAAM,WAAW,GAAI,OAAO,MAAM,KAAG,MAAkE,CAAA"}

package/dist/lib/_internal/generators/support/naming.js

@@ -0,0 +1,30 @@
+/** Stateless naming helpers shared by generators. Pure functions only. */
+const words = (value) => value
+    .replace(/([a-z0-9])([A-Z])/g, '$1 $2')
+    .replace(/[_\-\s]+/g, ' ')
+    .trim()
+    .split(' ')
+    .filter(Boolean);
+export const pascalCase = (value) => words(value)
+    .map(word => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase())
+    .join('');
+export const camelCase = (value) => {
+    const pascal = pascalCase(value);
+    return pascal.charAt(0).toLowerCase() + pascal.slice(1);
+};
+export const constantCase = (value) => words(value)
+    .map(word => word.toUpperCase())
+    .join('_');
+export const snakeCase = (value) => words(value)
+    .map(word => word.toLowerCase())
+    .join('_');
+/** Naive English pluralization sufficient for table naming. */
+export const pluralize = (value) => {
+    if (/[^aeiou]y$/.test(value))
+        return `${value.slice(0, -1)}ies`;
+    if (/(s|x|z|ch|sh)$/.test(value))
+        return `${value}es`;
+    return `${value}s`;
+};
+/** Escape a string for use inside a single-quoted TypeScript literal. */
+export const singleQuote = (value) => `'${value.replace(/\\/g, '\\\\').replace(/'/g, "\\'")}'`;

package/dist/lib/_internal/generators/support/relations.d.ts

@@ -0,0 +1,12 @@
+import { Ir, IrField, ScalarType } from '../../ir/ir.js';
+/** A model-typed field that is a foreign-key relation (not an embedded value object). */
+export declare const isRelation: (field: IrField) => boolean;
+/**
+ * Foreign-key column name for a relation field. Data Connect stores a relation
+ * `owner: User` as an `ownerId` column, so the entity/row/Firestore types expose
+ * the id, matching how the value is actually persisted and projected.
+ */
+export declare const relationFkName: (field: IrField) => string;
+/** Scalar type of a relation's foreign key (the related model's id type). */
+export declare const relationFkType: (ir: Ir, field: IrField) => ScalarType;
+//# sourceMappingURL=relations.d.ts.map

package/dist/lib/_internal/generators/support/relations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"relations.d.ts","sourceRoot":"","sources":["../../../../../src/lib/_internal/generators/support/relations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAElE,yFAAyF;AACzF,eAAO,MAAM,UAAU,GAAI,OAAO,OAAO,KAAG,OAAwD,CAAA;AAEpG;;;;GAIG;AACH,eAAO,MAAM,cAAc,GAAI,OAAO,OAAO,KAAG,MAA2B,CAAA;AAE3E,6EAA6E;AAC7E,eAAO,MAAM,cAAc,GAAI,IAAI,EAAE,EAAE,OAAO,OAAO,KAAG,UACgB,CAAA"}

package/dist/lib/_internal/generators/support/relations.js

@@ -0,0 +1,11 @@
+import { idTypeOf } from '../../ir/ir.js';
+/** A model-typed field that is a foreign-key relation (not an embedded value object). */
+export const isRelation = (field) => field.relation && field.type.kind === 'model';
+/**
+ * Foreign-key column name for a relation field. Data Connect stores a relation
+ * `owner: User` as an `ownerId` column, so the entity/row/Firestore types expose
+ * the id, matching how the value is actually persisted and projected.
+ */
+export const relationFkName = (field) => `${field.name}Id`;
+/** Scalar type of a relation's foreign key (the related model's id type). */
+export const relationFkType = (ir, field) => field.type.kind === 'model' ? idTypeOf(ir, field.type.name) : 'string';

package/dist/lib/_internal/generators/support/split.d.ts

@@ -0,0 +1,34 @@
+import { Ir, IrModel } from '../../ir/ir.js';
+/** Whether a model is a real table (vs an embedded value object). */
+export declare const isTable: (model: IrModel) => boolean;
+export declare const tableNameOf: (model: IrModel) => string;
+export declare const kebabCase: (value: string) => string;
+export interface HostedDeps {
+    /** Enum names in first-reference order. */
+    enums: string[];
+    /** Embedded model names in dependency (topological) order. */
+    models: string[];
+}
+/**
+ * Transitive enum/embedded-model dependencies of `roots`, in stable order:
+ * enums by first reference, embedded models dependencies-first so their
+ * declarations can be emitted top-down without forward references.
+ */
+export declare const collectDeps: (ir: Ir, roots: IrModel[]) => HostedDeps;
+export interface SplitGroups {
+    tables: IrModel[];
+    /** enum name → hosting table model name */
+    enumHome: Map<string, string>;
+    /** embedded model name → hosting table model name */
+    modelHome: Map<string, string>;
+    /** Enums referenced by no table (api-only etc.). */
+    leftoverEnums: string[];
+    /** Embedded models referenced by no table. */
+    leftoverModels: string[];
+}
+/**
+ * Assign every enum and embedded model to the first table model that
+ * (transitively) references it; the rest become shared leftovers.
+ */
+export declare const splitGroups: (ir: Ir) => SplitGroups;
+//# sourceMappingURL=split.d.ts.map

package/dist/lib/_internal/generators/support/split.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"split.d.ts","sourceRoot":"","sources":["../../../../../src/lib/_internal/generators/support/split.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,EAAE,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAIvD,qEAAqE;AACrE,eAAO,MAAM,OAAO,GAAI,OAAO,OAAO,KAAG,OAAiE,CAAA;AAE1G,eAAO,MAAM,WAAW,GAAI,OAAO,OAAO,KAAG,MAAyD,CAAA;AAEtG,eAAO,MAAM,SAAS,GAAI,OAAO,MAAM,KAAG,MAA6C,CAAA;AAavF,MAAM,WAAW,UAAU;IACzB,2CAA2C;IAC3C,KAAK,EAAE,MAAM,EAAE,CAAA;IACf,8DAA8D;IAC9D,MAAM,EAAE,MAAM,EAAE,CAAA;CACjB;AAED;;;;GAIG;AACH,eAAO,MAAM,WAAW,GAAI,IAAI,EAAE,EAAE,OAAO,OAAO,EAAE,KAAG,UAuBtD,CAAA;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,OAAO,EAAE,CAAA;IACjB,2CAA2C;IAC3C,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC7B,qDAAqD;IACrD,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC9B,oDAAoD;IACpD,aAAa,EAAE,MAAM,EAAE,CAAA;IACvB,8CAA8C;IAC9C,cAAc,EAAE,MAAM,EAAE,CAAA;CACzB;AAED;;;GAGG;AACH,eAAO,MAAM,WAAW,GAAI,IAAI,EAAE,KAAG,WAepC,CAAA"}

package/dist/lib/_internal/generators/support/split.js

@@ -0,0 +1,75 @@
+import { findModel } from '../../ir/ir.js';
+import { pluralize, snakeCase } from './naming.js';
+import { isRelation } from './relations.js';
+/** Whether a model is a real table (vs an embedded value object). */
+export const isTable = (model) => model.key.length > 0 || model.fields.some(f => f.isId);
+export const tableNameOf = (model) => model.table ?? pluralize(snakeCase(model.name));
+export const kebabCase = (value) => snakeCase(value).replace(/_/g, '-');
+/** Direct enum/embedded-model dependencies of a model (relations excluded). */
+const directDeps = (model) => {
+    const enums = [];
+    const models = [];
+    for (const field of model.fields) {
+        if (field.type.kind === 'enum')
+            enums.push(field.type.name);
+        else if (field.type.kind === 'model' && !isRelation(field))
+            models.push(field.type.name);
+    }
+    return { enums, models };
+};
+/**
+ * Transitive enum/embedded-model dependencies of `roots`, in stable order:
+ * enums by first reference, embedded models dependencies-first so their
+ * declarations can be emitted top-down without forward references.
+ */
+export const collectDeps = (ir, roots) => {
+    const enums = [];
+    const models = [];
+    const seenEnums = new Set();
+    const seenModels = new Set();
+    const visit = (model) => {
+        const deps = directDeps(model);
+        for (const name of deps.models) {
+            if (seenModels.has(name))
+                continue;
+            seenModels.add(name);
+            const embedded = findModel(ir, name);
+            if (embedded)
+                visit(embedded); // dependencies of the dependency come first
+            models.push(name);
+        }
+        for (const name of deps.enums) {
+            if (!seenEnums.has(name)) {
+                seenEnums.add(name);
+                enums.push(name);
+            }
+        }
+    };
+    for (const root of roots)
+        visit(root);
+    return { enums, models };
+};
+/**
+ * Assign every enum and embedded model to the first table model that
+ * (transitively) references it; the rest become shared leftovers.
+ */
+export const splitGroups = (ir) => {
+    const tables = ir.models.filter(isTable);
+    const enumHome = new Map();
+    const modelHome = new Map();
+    for (const table of tables) {
+        const deps = collectDeps(ir, [table]);
+        for (const name of deps.enums)
+            if (!enumHome.has(name))
+                enumHome.set(name, table.name);
+        for (const name of deps.models)
+            if (!modelHome.has(name))
+                modelHome.set(name, table.name);
+    }
+    const leftoverEnums = ir.enums.map(e => e.name).filter(name => !enumHome.has(name));
+    const leftoverModels = ir.models
+        .filter(model => !isTable(model))
+        .map(model => model.name)
+        .filter(name => !modelHome.has(name));
+    return { tables, enumHome, modelHome, leftoverEnums, leftoverModels };
+};

package/dist/lib/_internal/generators/typescript/typescript-generator.d.ts

@@ -0,0 +1,18 @@
+import { Generator } from '../generator.js';
+export interface TypeScriptGeneratorOptions {
+    /**
+     * How enums are emitted. `const` (default) produces a frozen const object plus
+     * a `Key` type and a value type — giving runtime values and types from one
+     * source. `union` produces a plain
+     * string-literal union.
+     */
+    enumStyle?: 'const' | 'union';
+}
+/**
+ * Generates TypeScript types: an interface per model and, per enum, either a
+ * frozen const object (default — runtime values + `Key`/value types) or a
+ * plain string-literal union. This is the highest-priority
+ * generator and the shape other TS-facing generators reference.
+ */
+export declare const createTypeScriptGenerator: (options?: TypeScriptGeneratorOptions) => Generator;
+//# sourceMappingURL=typescript-generator.d.ts.map

package/dist/lib/_internal/generators/typescript/typescript-generator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typescript-generator.d.ts","sourceRoot":"","sources":["../../../../../src/lib/_internal/generators/typescript/typescript-generator.ts"],"names":[],"mappings":"AACA,OAAO,EAAiB,SAAS,EAAoB,MAAM,iBAAiB,CAAA;AAK5E,MAAM,WAAW,0BAA0B;IACzC;;;;;OAKG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,OAAO,CAAA;CAC9B;AA+ED;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,GAAI,UAAS,0BAA+B,KAAG,SAyBpF,CAAA"}

package/dist/lib/_internal/generators/typescript/typescript-generator.js

@@ -0,0 +1,99 @@
+import { headerBlocks } from '../support/header.js';
+import { constantCase, singleQuote } from '../support/naming.js';
+import { isRelation, relationFkName, relationFkType } from '../support/relations.js';
+const SCALAR_TS = {
+    string: 'string',
+    int: 'number',
+    int64: 'number',
+    float: 'number',
+    boolean: 'boolean',
+    timestamp: 'string',
+    date: 'string',
+    json: 'Json',
+    id: 'string',
+};
+const JSON_TYPE = [
+    'export type Json =',
+    '  | string',
+    '  | number',
+    '  | boolean',
+    '  | null',
+    '  | Json[]',
+    '  | { [key: string]: Json }',
+].join('\n');
+const renderRef = (ref) => {
+    switch (ref.kind) {
+        case 'scalar':
+            return SCALAR_TS[ref.name];
+        case 'enum':
+        case 'model':
+            return ref.name;
+        default:
+            return 'unknown';
+    }
+};
+const renderFieldType = (field) => {
+    const base = renderRef(field.type);
+    return field.list ? `${base}[]` : base;
+};
+const renderField = (field, ir) => {
+    const optional = field.optional ? '?' : '';
+    const doc = field.description ? `  /** ${field.description} */\n` : '';
+    if (field.literal !== undefined) {
+        const type = field.list ? `${singleQuote(field.literal)}[]` : singleQuote(field.literal);
+        return `${doc}  ${field.name}${optional}: ${type}`;
+    }
+    // Relation: expose the foreign-key id (matching the persisted/projected shape).
+    if (isRelation(field)) {
+        const base = SCALAR_TS[relationFkType(ir, field)];
+        const type = field.list ? `${base}[]` : base;
+        return `${doc}  ${relationFkName(field)}${optional}: ${type}`;
+    }
+    return `${doc}  ${field.name}${optional}: ${renderFieldType(field)}`;
+};
+const usesJson = (ir) => ir.models.some(model => model.fields.some(field => field.type.kind === 'scalar' && field.type.name === 'json'));
+const renderEnumUnion = (irEnum) => {
+    const doc = irEnum.description ? `/** ${irEnum.description} */\n` : '';
+    const union = irEnum.values.map(value => singleQuote(value)).join(' | ') || 'never';
+    return `${doc}export type ${irEnum.name} = ${union}`;
+};
+const renderEnumConst = (irEnum) => {
+    const doc = irEnum.description ? `/** ${irEnum.description} */\n` : '';
+    const constName = constantCase(irEnum.name);
+    const entries = irEnum.values.map(value => `  ${constantCase(value)}: ${singleQuote(value)},`).join('\n');
+    return [
+        `${doc}export const ${constName} = Object.freeze({`,
+        entries,
+        `} as const)`,
+        `export type ${irEnum.name}Key = keyof typeof ${constName}`,
+        `export type ${irEnum.name} = (typeof ${constName})[${irEnum.name}Key]`,
+    ].join('\n');
+};
+/**
+ * Generates TypeScript types: an interface per model and, per enum, either a
+ * frozen const object (default — runtime values + `Key`/value types) or a
+ * plain string-literal union. This is the highest-priority
+ * generator and the shape other TS-facing generators reference.
+ */
+export const createTypeScriptGenerator = (options = {}) => {
+    const enumStyle = options.enumStyle ?? 'const';
+    return {
+        name: 'typescript',
+        description: 'TypeScript interfaces and enum const/union types',
+        generate(ir, context) {
+            const blocks = [...headerBlocks(context)];
+            if (usesJson(ir)) {
+                blocks.push(JSON_TYPE);
+            }
+            for (const irEnum of ir.enums) {
+                blocks.push(enumStyle === 'const' ? renderEnumConst(irEnum) : renderEnumUnion(irEnum));
+            }
+            for (const model of ir.models) {
+                const doc = model.description ? `/** ${model.description} */\n` : '';
+                const fields = model.fields.map(field => renderField(field, ir)).join('\n');
+                blocks.push(`${doc}export interface ${model.name} {\n${fields}\n}`);
+            }
+            return [{ path: 'types.ts', content: `${blocks.join('\n\n')}\n` }];
+        },
+    };
+};

package/dist/lib/_internal/generators/typescript/typescript-split-generator.d.ts

@@ -0,0 +1,10 @@
+import { Generator } from '../generator.js';
+/**
+ * Split variant of the TypeScript generator: one file per table at
+ * `types/<table-name>.ts` (kebab-case), with enums and embedded value objects
+ * co-located in the file of the first table that references them. Shared
+ * leftovers (and the `Json` type) live in `types/_shared.ts`, and `types.ts`
+ * is a barrel re-exporting every file.
+ */
+export declare const createTypeScriptSplitGenerator: () => Generator;
+//# sourceMappingURL=typescript-split-generator.d.ts.map

package/dist/lib/_internal/generators/typescript/typescript-split-generator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typescript-split-generator.d.ts","sourceRoot":"","sources":["../../../../../src/lib/_internal/generators/typescript/typescript-split-generator.ts"],"names":[],"mappings":"AACA,OAAO,EAAiB,SAAS,EAAoB,MAAM,iBAAiB,CAAA;AA2F5E;;;;;;GAMG;AACH,eAAO,MAAM,8BAA8B,QAAO,SAyEhD,CAAA"}