npm - @stacksjs/database - Versions diffs - 0.72.23 → 0.72.24 - Mend

@stacksjs/database 0.72.23 → 0.72.24

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

package/dist/framework-schema.d.ts +2032 -0
package/dist/framework-schema.js +0 -0
package/dist/index.d.ts +2 -1
package/dist/utils.d.ts +46 -10
package/package.json +10 -10

package/dist/framework-schema.js ADDED Viewed

File without changes

package/dist/index.d.ts CHANGED Viewed

@@ -10,6 +10,8 @@ export type {
   PostgresConfig,
   SqliteConfig,
 } from './driver-config';
+// Core database utilities and default instance
+export type { FrameworkSchema } from './framework-schema';
 export type { SchemaDriftColumn, SchemaDriftReport } from './schema-drift';
 export type { DeclaredFK, FkAuditResult, FkOrphan, FkOrphanReport, LiveFK } from './fk-audit';
 export type { DeclaredUnique, LiveUniqueIndex, UniqueAuditResult } from './unique-audit';
@@ -74,7 +76,6 @@ export {
   mergeWithDefaults,
   validateDriverConfig,
 } from './driver-config';
-// Core database utilities and default instance
 export * from './utils';
 // Types (compatibility layer for Kysely types)
 export * from './types';

package/dist/utils.d.ts CHANGED Viewed

@@ -1,4 +1,5 @@
 import { createQueryBuilder, setConfig } from '@stacksjs/query-builder';
+import type { FrameworkSchema } from './framework-schema';
 import type { QueryHooks } from '@stacksjs/query-builder';
 export declare function acquireDbConfigLock(): Promise<() => void>;
 // Function to initialize the config when it's available
@@ -105,6 +106,25 @@ export declare interface DatabaseQueryLogEvent {
   queryDurationMillis: number
   error?: unknown
 }
+/**
+ * What an insert reports when it was not asked to return rows.
+ *
+ * Every field optional and every one differently named, because drivers
+ * disagree: Postgres answers a count, SQLite a `changes`, MySQL an `insertId`.
+ * Typing this as the row - which is what the query builder's own declarations
+ * do - is how framework code came to read `insertId` off a value that is not a
+ * row and cannot have one.
+ *
+ * `returning(...)` is the way to get rows out of an insert, and it changes the
+ * chain's kind so the types follow.
+ */
+export declare interface InsertReceipt {
+  insertId?: number | bigint
+  numInsertedOrUpdatedRows?: number | bigint
+  numAffectedRows?: number | bigint
+  affectedRows?: number
+  changes?: number
+}
 export declare interface BaseFluentChain<TRow = Record<string, unknown>, TKind extends ChainKind = 'select'> {
   where(callback: (eb: import('./types').StacksExpressionBuilder) => unknown): FluentChain<TRow, TKind>
   where(...args: unknown[]): FluentChain<TRow, TKind>
@@ -237,12 +257,20 @@ export type ChainKind = 'select' | 'insert' | 'update' | 'delete' | 'returning';
 export type ResultOf<TRow, TKind extends ChainKind> = TKind extends 'select' | 'returning'
   ? TRow[]
   : number;
-/** What `executeTakeFirst()` resolves to for each verb. */
-export type FirstOf<TRow, TKind extends ChainKind> = TKind extends 'select' | 'returning' | 'insert'
+/**
+ * What `executeTakeFirst()` resolves to for each verb.
+ *
+ * The counts are *required*, because the runtime always sets them: an update
+ * that changed nothing answers `{ numUpdatedRows: 0 }`. Declaring them optional
+ * would make every caller write `?? 0` for a case that cannot happen.
+ */
+export type FirstOf<TRow, TKind extends ChainKind> = TKind extends 'select' | 'returning'
   ? TRow | undefined
-  : TKind extends 'update'
-    ? { numUpdatedRows?: number }
-    : { numDeletedRows?: number }
+  : TKind extends 'insert'
+    ? InsertReceipt | undefined
+    : TKind extends 'update'
+      ? { numUpdatedRows: number }
+      : { numDeletedRows: number }
 /** `created_at` -> `CreatedAt`, for the dynamic helper names below. */
 declare type SnakeToPascal<S extends string> = S extends `${infer Head}_${infer Tail}`
   ? `${Capitalize<Head>}${SnakeToPascal<Tail>}`
@@ -320,7 +348,7 @@ declare type GenericPassthroughKeys = | 'transaction'
  * well-documented LiteralUnion trick.
  */
 // eslint-disable-next-line ts/no-empty-object-type
-export type TableName = (keyof DatabaseSchema & string) | (string & {});
+export type TableName = (keyof DatabaseSchema & string) | (keyof FrameworkSchema & string) | (string & {});
 /**
  * The row type of a registered table, or an unknown-valued record.
  *
@@ -330,10 +358,18 @@ export type TableName = (keyof DatabaseSchema & string) | (string & {});
  * the caller narrows, but narrowing it is checked rather than waved through.
  */
 export type RowOf<T extends TableName> = T extends keyof DatabaseSchema
-  ? DatabaseSchema[T] extends { columns: infer C }
-    ? C
-    : DatabaseSchema[T]
-  : Record<string, unknown>;
+  ? Shape<DatabaseSchema[T]>
+  : T extends keyof FrameworkSchema
+    ? Shape<FrameworkSchema[T]>
+    : Record<string, unknown>;
+/**
+ * A generated entry, whichever of the two shapes it was written in.
+ *
+ * The app generator has emitted a flat column record for a while; the
+ * `{ columns }` form is what the query builder's own schema type uses. Both are
+ * accepted so an app does not have to regenerate to keep compiling.
+ */
+declare type Shape<T> = T extends { columns: infer C } ? C : T;
 // SQLite bootstrap pragmas (stacksjs/stacks#1951) now live in
 // @stacksjs/query-builder — the one chokepoint every framework
 // query-builder instance is created through — so EVERY fresh sqlite

package/package.json CHANGED Viewed

@@ -2,7 +2,7 @@
   "name": "@stacksjs/database",
   "type": "module",
   "sideEffects": false,
-  "version": "0.72.23",
+  "version": "0.72.24",
   "description": "The Stacks database integration.",
   "author": "Chris Breuer",
   "contributors": [
@@ -65,15 +65,15 @@
     "dynamodb-tooling": "^0.3.2"
   },
   "devDependencies": {
-    "@stacksjs/cli": "0.72.23",
-    "@stacksjs/config": "0.72.23",
-    "@stacksjs/logging": "0.72.23",
-    "@stacksjs/router": "0.72.23",
+    "@stacksjs/cli": "0.72.24",
+    "@stacksjs/config": "0.72.24",
+    "@stacksjs/logging": "0.72.24",
+    "@stacksjs/router": "0.72.24",
     "better-dx": "^0.2.23",
-    "@stacksjs/path": "0.72.23",
-    "@stacksjs/query-builder": "0.72.23",
-    "@stacksjs/storage": "0.72.23",
-    "@stacksjs/strings": "0.72.23",
-    "@stacksjs/utils": "0.72.23"
+    "@stacksjs/path": "0.72.24",
+    "@stacksjs/query-builder": "0.72.24",
+    "@stacksjs/storage": "0.72.24",
+    "@stacksjs/strings": "0.72.24",
+    "@stacksjs/utils": "0.72.24"
   }
 }