@stacksjs/orm 0.72.23 → 0.72.24

package/dist/generate-database-schema.d.ts

@@ -8,12 +8,13 @@ export declare function buildDatabaseSchema(options?: GenerateSchemaOptions): Pr
  * Pure renderer — for tests that don't want to round-trip through the
  * model loader.
  */
-export declare function renderDatabaseTypeFile(tables: Array<{ table: string, columns: Record<string, string> }>): string;
+export declare function renderDatabaseTypeFile(tables: Array<{ table: string, columns: Record<string, string> }>, target?: SchemaTarget): string;
 export declare interface GenerateSchemaOptions {
   modelsDir?: string
   defaultsDir?: string
   outFile?: string
   dryRun?: boolean
+  target?: SchemaTarget
 }
 export declare interface GenerateSchemaResult {
   outFile: string
@@ -21,3 +22,19 @@ export declare interface GenerateSchemaResult {
   errors: Array<{ file: string, error: string }>
   content: string
 }
+/**
+ * The two shapes this generator can write.
+ *
+ * `app` augments `DatabaseSchema` from userland, which is what
+ * `buddy generate:db-types` produces. `framework` declares `FrameworkSchema`
+ * *inside* the database package, so the framework's own default models are typed
+ * for the framework's own code - which is the difference between
+ * `db.selectFrom('reviews')` answering a review and answering an unknown-valued
+ * record that every call site then has to assert.
+ *
+ * They are separate interfaces rather than one merged declaration on purpose:
+ * an app that overrides a default model must win, and declaration merging has no
+ * notion of precedence - two declarations of the same table would be a
+ * conflict rather than an override.
+ */
+export type SchemaTarget = 'app' | 'framework';