@hazejs/orm 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026-present hazejs contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,28 @@
-# Temporary Holding Version
+# @hazejs/orm
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Models, query builder, migrations and seeders for hazejs on top of [drizzle](https://orm.drizzle.team) — MySQL, PostgreSQL, SQLite, Turso, Cloudflare D1 — plus a MongoDB adapter (`@hazejs/orm/mongo`).
+
+## Install
+
+```bash
+pnpm add @hazejs/orm
+```
+
+## Usage
+
+```ts
+// app/model/Post.ts — columns and types come from database/schema/posts.ts
+export class Post extends Model.define(posts) {
+  static override softDelete = true
+  static override hidden = ['secret']
+}
+
+const page = await Post.where('published', true).paginate(1, 20)
+const post = await Post.findOrFail(id)
+```
+
+Part of [hazejs](https://github.com/penna-org/haze) — see the main README for documentation.
+
+## License
+
+[MIT](./LICENSE)

package/dist/index.d.mts

@@ -0,0 +1,125 @@
+import { $ as TimestampOptions, A as DatabaseConfig, C as setDatabaseManager, D as DatabaseManager, E as Connection, M as Driver, N as defineDatabaseConfig, O as DatabaseManagerOptions, P as dialectOf, Q as ModelSettings, S as resolveSession, T as useDatabaseManager, Z as ModelMeta, _ as ModelQuery, a as TableOf, at as Direction, b as WriteOptions, c as RecordClass, ct as Paginated, d as BelongsTo, et as Conditions, f as HasMany, g as RelationQuery, h as Relation, i as ModelLike, it as ColumnKey, j as Dialect, k as ConnectionConfig, l as RelationName, lt as Row, m as QueryOf, n as Model, nt as WhereObject, o as ActiveRecord, ot as Insert, p as HasOne, r as ModelClass, rt as AnyDatabase, s as FieldOf, st as Operator, t as DefinedModel, tt as WhereCondition, u as RelationResult, v as QueryBuilder, w as transaction, x as Session, y as QueryOptions } from "./model-CBky_ILK.mjs";
+import { ConfigInput, ConflictException, NotFoundException, ServiceProvider, UserProvider } from "@hazejs/core";
+import { SQL, Table } from "drizzle-orm";
+interface ModelUserProviderOptions {
+  /** 登录名字段（可多个，凭据中出现的都参与匹配），默认 `email` */
+  username?: string | string[];
+  /** 密码哈希字段（凭据中同名字段为明文密码），默认 `password` */
+  password?: string;
+}
+/**
+ * 基于模型的用户来源（config/auth.ts 的 providers）：
+ *
+ * ```ts
+ * providers: { users: modelUserProvider(() => User, { username: 'email' }) }
+ * ```
+ *
+ * 模型以函数传入，避免配置文件与模型之间的循环导入。密码字段使用 `Hash.make()` 生成的哈希。
+ */
+export declare function modelUserProvider<M extends ModelLike>(model: () => ModelClass<M>, options?: ModelUserProviderOptions): UserProvider<M>;
+interface ScopedDb {
+  table: <T extends Table>(table: T) => QueryBuilder<T>;
+  transaction: <R>(callback: (tx: AnyDatabase) => Promise<R>) => Promise<R>;
+  execute: <R = Record<string, unknown>>(query: SQL) => Promise<R[]>;
+  drizzle: () => Promise<AnyDatabase>;
+}
+/** 数据库门面：默认连接的快捷入口，`Db.connection(name)` 切换连接 */
+export declare const Db: {
+  connection: (name: string) => ScopedDb;
+  table: <T extends Table>(table: T) => QueryBuilder<T>;
+  transaction: <R>(callback: (tx: AnyDatabase) => Promise<R>) => Promise<R>;
+  execute: <R = Record<string, unknown>>(query: SQL) => Promise<R[]>;
+  drizzle: () => Promise<AnyDatabase>;
+};
+/** findOrFail() 未找到数据，渲染为 404 */
+export declare class ModelNotFoundException extends NotFoundException {
+  readonly model: string;
+  constructor(model: string, key?: unknown);
+}
+export declare class DatabaseError extends Error {
+  name: string;
+}
+/** 违反唯一约束（重复数据），渲染为 409 */
+export declare class UniqueConstraintException extends ConflictException {
+  constructor(cause: unknown);
+}
+/** 把各数据库的唯一约束错误统一转换为 UniqueConstraintException，其余原样返回 */
+export declare function translateDatabaseError(error: unknown): unknown;
+/** 内嵌的迁移文件：相对后端源码目录的路径 → 文件内容（生产构建由框架打包进产物） */
+type MigrationFiles = Record<string, string>;
+interface MigrateOptions {
+  /** 连接名，默认 default 连接 */
+  connection?: string;
+  /** 迁移目录（drizzle-kit generate 的输出目录）；配合 files 时为其中的相对路径 */
+  folder: string;
+  /** 从内嵌文件读取迁移而不是磁盘（Edge / Serverless 产物没有源码目录） */
+  files?: MigrationFiles;
+  manager?: DatabaseManager;
+}
+interface MigrateResult {
+  connection: string;
+  folder: string;
+  /** 本次执行的迁移数 */
+  applied: number;
+  /** 迁移总数 */
+  total: number;
+}
+/**
+ * 执行 drizzle-kit 生成的迁移（已执行过的会跳过）。迁移记录与 drizzle 自带的迁移器相同，
+ * 可与 drizzle-kit migrate 混用。
+ */
+export declare function migrate(options: MigrateOptions): Promise<MigrateResult>;
+interface RunMigrationsOptions {
+  /** 连接名，默认 default 连接 */
+  connection?: string;
+  /** 对所有 SQL 连接执行（跳过 MongoDB 与没有迁移的连接） */
+  all?: boolean;
+  /** 内嵌的迁移文件；省略时从 srcDir 读取 */
+  files?: MigrationFiles;
+  /** 后端源码目录，默认 process.cwd() */
+  srcDir?: string;
+  manager?: DatabaseManager;
+}
+interface RunMigrationsResult extends Partial<MigrateResult> {
+  connection: string;
+  folder: string;
+  /** 跳过的原因 */
+  skipped?: 'mongodb' | 'no-migrations';
+}
+/** 迁移目录（相对后端源码目录）：连接配置的 migrations，默认连接为 database/migrations，其它为 database/migrations/<name> */
+export declare function migrationsFolder(name?: string, manager?: DatabaseManager): string;
+/**
+ * 按 config/database.ts 执行迁移：`haze db:migrate` 与生产构建的迁移入口
+ * （`node dist/server/migrate.mjs`、Lambda 的 `index.migrate`）共用。
+ */
+export declare function runMigrations(options?: RunMigrationsOptions): Promise<RunMigrationsResult[]>;
+interface DatabaseProviderOptions {
+  /** 默认读取 config/database.ts */
+  config?: ConfigInput<DatabaseConfig>;
+}
+/**
+ * 数据库服务提供者（放在 app/provider/DatabaseProvider.ts）：
+ *
+ * ```ts
+ * export default databaseProvider()
+ * ```
+ *
+ * 注册 DatabaseManager（可 inject），并让 Db / Model 使用该配置。连接在首次查询时建立，
+ * 开发时跨热更新复用，应用关闭时释放。
+ */
+export declare function databaseProvider(options?: DatabaseProviderOptions): ServiceProvider;
+interface RefreshDatabaseOptions {
+  /** 迁移目录，默认 `<cwd>/database/migrations`（全栈项目为 `server/database/migrations`） */
+  migrations?: string;
+  connection?: string;
+}
+/**
+ * 测试用：重建连接并执行迁移。配合 `.env.test` 中的 `DATABASE_URL=:memory:`，每个用例得到全新的数据库。
+ *
+ * ```ts
+ * const t = useTestApp()
+ * beforeEach(() => refreshDatabase())
+ * ```
+ */
+export declare function refreshDatabase(options?: RefreshDatabaseOptions): Promise<void>;
+export { ActiveRecord, BelongsTo, type ColumnKey, Conditions, type Connection, type ConnectionConfig, type DatabaseConfig, DatabaseManager, type DatabaseManagerOptions, type DatabaseProviderOptions, type DefinedModel, type Dialect, type Direction, type Driver, type FieldOf, HasMany, HasOne, type Insert, type MigrateOptions, type MigrateResult, type MigrationFiles, Model, type ModelClass, type ModelMeta, ModelQuery, type ModelSettings, type ModelUserProviderOptions, type Operator, type Paginated, QueryBuilder, type QueryOf, type QueryOptions, type RecordClass, type RefreshDatabaseOptions, Relation, type RelationName, type RelationQuery, type RelationResult, type Row, type RunMigrationsOptions, type RunMigrationsResult, type ScopedDb, type Session, type TableOf, type TimestampOptions, type WhereCondition, type WhereObject, type WriteOptions, defineDatabaseConfig, dialectOf, resolveSession, setDatabaseManager, transaction, useDatabaseManager };