ormbridge 0.2.0 → 0.3.0

package/dist/emitters/gorm.d.ts

@@ -0,0 +1,38 @@
+import type { MultiFileEmitOutput } from '../formats.js';
+import type { IrSchema } from '../ir.js';
+import type { NamingMode } from '../transforms.js';
+import type { PrismaProvider } from './prisma.js';
+/**
+ * GORM emitter (Go structs with `gorm:"..."` tags). Writes one file per model
+ * (`models/post.go`) and one per enum (`models/post_status.go`), so it returns
+ * the multi-file form of the emit contract. Column and table names that match
+ * GORM's naming conventions are left implicit; everything else is written out.
+ */
+export interface GormEmitOptions {
+    /** Database provider; chooses column types such as `uuid` vs `char(36)` and the UUID default. */
+    provider: PrismaProvider;
+    /** "normalize" applies GORM's conventions (plural snake_case tables, timestamps) before writing. */
+    naming: NamingMode;
+    /** Go package name of the generated files (default `models`); also the output directory. */
+    goPackage?: string;
+}
+export declare const DEFAULT_GO_PACKAGE: string;
+/** True when `value` can be used as a Go package name: an identifier that is not `_` or a keyword. */
+export declare function isValidGoPackageName(value: string): boolean;
+export declare function emitGorm(schema: IrSchema, options: GormEmitOptions): MultiFileEmitOutput;
+/**
+ * The column name GORM derives from a Go field name (`schema.NamingStrategy.ColumnName`,
+ * gorm v1.31): `PublicID` becomes `public_id`, `HTTPServer` becomes `http_server`.
+ */
+export declare function gormColumnName(goName: string): string;
+/** Pluralizes a lower-case snake_case name the way GORM does for table names. */
+export declare function gormPluralize(snake: string): string;
+/** The table name GORM derives from a Go struct name: `BlogPost` becomes `blog_posts`. */
+export declare function gormTableName(goTypeName: string): string;
+/**
+ * Applies GORM's conventions to a schema: plural snake_case table names (join
+ * tables keep theirs), snake_case columns, and `created_at` / `updated_at`
+ * where a model has none (GORM fills both in by name). Primary keys keep their
+ * type.
+ */
+export declare function normalizeGormSchema(schema: IrSchema): IrSchema;