@meghjs/core 0.5.0 → 0.5.2
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.
- package/README.md +39 -29
- package/dist/common/helpers.d.ts +0 -1
- package/dist/common/helpers.js +0 -1
- package/dist/common/helpers.js.map +1 -1
- package/dist/config/config.js +1 -2
- package/dist/config/config.js.map +1 -1
- package/dist/core/application.d.ts +0 -6
- package/dist/core/application.js +2 -10
- package/dist/core/application.js.map +1 -1
- package/dist/core/router.js +2 -1
- package/dist/core/router.js.map +1 -1
- package/dist/di/container.d.ts +50 -6
- package/dist/di/container.js +183 -29
- package/dist/di/container.js.map +1 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.js +3 -1
- package/dist/index.js.map +1 -1
- package/dist/openapi/branding.d.ts +29 -0
- package/dist/openapi/branding.js +41 -0
- package/dist/openapi/branding.js.map +1 -0
- package/dist/openapi/openapi.d.ts +8 -0
- package/dist/openapi/openapi.js.map +1 -1
- package/dist/orm/casts.d.ts +6 -1
- package/dist/orm/casts.js +18 -7
- package/dist/orm/casts.js.map +1 -1
- package/dist/orm/config.d.ts +63 -0
- package/dist/orm/config.js +127 -0
- package/dist/orm/config.js.map +1 -0
- package/dist/orm/connect.d.ts +11 -0
- package/dist/orm/connect.js +147 -0
- package/dist/orm/connect.js.map +1 -0
- package/dist/orm/connection.d.ts +9 -5
- package/dist/orm/connection.js +41 -14
- package/dist/orm/connection.js.map +1 -1
- package/dist/orm/core.d.ts +43 -0
- package/dist/orm/core.js +23 -0
- package/dist/orm/core.js.map +1 -0
- package/dist/orm/db.d.ts +171 -0
- package/dist/orm/db.js +534 -0
- package/dist/orm/db.js.map +1 -0
- package/dist/orm/decorators.d.ts +143 -0
- package/dist/orm/decorators.js +243 -0
- package/dist/orm/decorators.js.map +1 -0
- package/dist/orm/engine.d.ts +8 -0
- package/dist/orm/engine.js +8 -0
- package/dist/orm/engine.js.map +1 -0
- package/dist/orm/has-relation.d.ts +31 -0
- package/dist/orm/has-relation.js +77 -0
- package/dist/orm/has-relation.js.map +1 -0
- package/dist/orm/index.d.ts +12 -4
- package/dist/orm/index.js +41 -1
- package/dist/orm/index.js.map +1 -1
- package/dist/orm/migrations.d.ts +27 -0
- package/dist/orm/migrations.js +40 -16
- package/dist/orm/migrations.js.map +1 -1
- package/dist/orm/model.d.ts +55 -6
- package/dist/orm/model.js +82 -16
- package/dist/orm/model.js.map +1 -1
- package/dist/orm/naming.d.ts +19 -0
- package/dist/orm/naming.js +96 -0
- package/dist/orm/naming.js.map +1 -0
- package/dist/orm/paging.d.ts +22 -0
- package/dist/orm/paging.js +32 -0
- package/dist/orm/paging.js.map +1 -0
- package/dist/orm/pivot.js +3 -2
- package/dist/orm/pivot.js.map +1 -1
- package/dist/orm/plugin.d.ts +2 -0
- package/dist/orm/plugin.js +50 -0
- package/dist/orm/plugin.js.map +1 -0
- package/dist/orm/query.d.ts +125 -10
- package/dist/orm/query.js +289 -47
- package/dist/orm/query.js.map +1 -1
- package/dist/orm/relations.d.ts +11 -2
- package/dist/orm/relations.js +14 -2
- package/dist/orm/relations.js.map +1 -1
- package/dist/orm/schema.d.ts +229 -0
- package/dist/orm/schema.js +645 -0
- package/dist/orm/schema.js.map +1 -0
- package/dist/orm/state.d.ts +4 -1
- package/dist/orm/state.js +29 -12
- package/dist/orm/state.js.map +1 -1
- package/dist/orm/types.d.ts +18 -5
- package/dist/plugins/builtin.d.ts +2 -0
- package/dist/plugins/builtin.js +12 -0
- package/dist/plugins/builtin.js.map +1 -0
- package/dist/plugins/registry.d.ts +5 -3
- package/dist/plugins/registry.js +14 -4
- package/dist/plugins/registry.js.map +1 -1
- package/package.json +6 -7
- package/dist/common/utils/di-utils.d.ts +0 -1
- package/dist/common/utils/di-utils.js +0 -20
- package/dist/common/utils/di-utils.js.map +0 -1
package/dist/orm/migrations.d.ts
CHANGED
|
@@ -1,8 +1,35 @@
|
|
|
1
1
|
import type { Kysely } from "kysely";
|
|
2
|
+
import { Schema } from "./schema";
|
|
3
|
+
/** A migration as the runner calls it. */
|
|
2
4
|
export interface Migration {
|
|
3
5
|
up(db: Kysely<any>): Promise<void>;
|
|
4
6
|
down?(db: Kysely<any>): Promise<void>;
|
|
5
7
|
}
|
|
8
|
+
/** A migration written with the schema builder. */
|
|
9
|
+
export interface SchemaMigration {
|
|
10
|
+
up(schema: Schema): Promise<void>;
|
|
11
|
+
/** Undo `up()`. Without it, the migration can't be rolled back. */
|
|
12
|
+
down?(schema: Schema): Promise<void>;
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Define a migration with Megh's schema builder:
|
|
16
|
+
*
|
|
17
|
+
* ```ts
|
|
18
|
+
* export default defineMigration({
|
|
19
|
+
* async up(schema) {
|
|
20
|
+
* await schema.create("users", (table) => {
|
|
21
|
+
* table.id();
|
|
22
|
+
* table.string("email").unique();
|
|
23
|
+
* table.timestamps();
|
|
24
|
+
* });
|
|
25
|
+
* },
|
|
26
|
+
* async down(schema) {
|
|
27
|
+
* await schema.drop("users");
|
|
28
|
+
* },
|
|
29
|
+
* });
|
|
30
|
+
* ```
|
|
31
|
+
*/
|
|
32
|
+
export declare function defineMigration(migration: SchemaMigration): Migration;
|
|
6
33
|
export interface MigrationsOptions {
|
|
7
34
|
/** Folder of migration files (`.js`, `.cjs`, `.mjs`, `.ts`, …). */
|
|
8
35
|
folder?: string;
|
package/dist/orm/migrations.js
CHANGED
|
@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
4
4
|
};
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
6
|
exports.Migrations = exports.MigrationError = void 0;
|
|
7
|
+
exports.defineMigration = defineMigration;
|
|
7
8
|
exports.readMigrationFolder = readMigrationFolder;
|
|
8
9
|
/**
|
|
9
10
|
* @copyright 2024
|
|
@@ -13,15 +14,43 @@ exports.readMigrationFolder = readMigrationFolder;
|
|
|
13
14
|
*
|
|
14
15
|
* Schema migrations, run with Kysely's `Migrator`.
|
|
15
16
|
*
|
|
16
|
-
* A migration is a module
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
17
|
+
* A migration is a module whose default export is `defineMigration({ up,
|
|
18
|
+
* down })`, which receive Megh's schema builder. Modules exporting
|
|
19
|
+
* `up(db)` / `down(db)` functions that take the Kysely instance still work.
|
|
20
|
+
* Migrations run in file-name order, so names start with a timestamp:
|
|
21
|
+
* `20261101093000_create_users_table.ts`. `megh make:migration` creates them.
|
|
20
22
|
*/
|
|
21
23
|
const node_fs_1 = __importDefault(require("node:fs"));
|
|
22
24
|
const node_path_1 = __importDefault(require("node:path"));
|
|
23
25
|
const node_url_1 = require("node:url");
|
|
24
|
-
const
|
|
26
|
+
const schema_1 = require("./schema");
|
|
27
|
+
/**
|
|
28
|
+
* Define a migration with Megh's schema builder:
|
|
29
|
+
*
|
|
30
|
+
* ```ts
|
|
31
|
+
* export default defineMigration({
|
|
32
|
+
* async up(schema) {
|
|
33
|
+
* await schema.create("users", (table) => {
|
|
34
|
+
* table.id();
|
|
35
|
+
* table.string("email").unique();
|
|
36
|
+
* table.timestamps();
|
|
37
|
+
* });
|
|
38
|
+
* },
|
|
39
|
+
* async down(schema) {
|
|
40
|
+
* await schema.drop("users");
|
|
41
|
+
* },
|
|
42
|
+
* });
|
|
43
|
+
* ```
|
|
44
|
+
*/
|
|
45
|
+
function defineMigration(migration) {
|
|
46
|
+
const { up, down } = migration;
|
|
47
|
+
return {
|
|
48
|
+
up: (db) => up.call(migration, new schema_1.Schema(db)),
|
|
49
|
+
...(down
|
|
50
|
+
? { down: (db) => down.call(migration, new schema_1.Schema(db)) }
|
|
51
|
+
: {}),
|
|
52
|
+
};
|
|
53
|
+
}
|
|
25
54
|
/** A migration run failed. `completed` lists the migrations that did run. */
|
|
26
55
|
class MigrationError extends Error {
|
|
27
56
|
migration;
|
|
@@ -70,23 +99,18 @@ async function readMigrationFolder(folder) {
|
|
|
70
99
|
const mod = await loadMigrationFile(node_path_1.default.join(folder, file));
|
|
71
100
|
const migration = typeof mod?.up === "function" ? mod : mod?.default;
|
|
72
101
|
if (typeof migration?.up !== "function") {
|
|
73
|
-
throw new Error(`[Megh ORM] Migration ${file} must export
|
|
102
|
+
throw new Error(`[Megh ORM] Migration ${file} must export defineMigration({ up, down }) as its default export.`);
|
|
74
103
|
}
|
|
75
104
|
out[file.replace(EXTENSIONS, "")] = migration;
|
|
76
105
|
}
|
|
77
106
|
return out;
|
|
78
107
|
}
|
|
79
|
-
/**
|
|
108
|
+
/**
|
|
109
|
+
* Kysely's migration module. Required at runtime: it's a subpath export,
|
|
110
|
+
* which this package's CommonJS module resolution can't type.
|
|
111
|
+
*/
|
|
80
112
|
function kyselyMigration() {
|
|
81
|
-
|
|
82
|
-
const mod = (0, common_utils_1.loadPackageFromClient)("kysely/migration");
|
|
83
|
-
if (mod?.Migrator)
|
|
84
|
-
return mod;
|
|
85
|
-
}
|
|
86
|
-
catch {
|
|
87
|
-
// fall through
|
|
88
|
-
}
|
|
89
|
-
return (0, common_utils_1.loadPackageFromClient)("kysely");
|
|
113
|
+
return require("kysely/migration");
|
|
90
114
|
}
|
|
91
115
|
/**
|
|
92
116
|
* Run schema migrations against `db`.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"migrations.js","sourceRoot":"","sources":["../../src/orm/migrations.ts"],"names":[],"mappings":";;;;;;
|
|
1
|
+
{"version":3,"file":"migrations.js","sourceRoot":"","sources":["../../src/orm/migrations.ts"],"names":[],"mappings":";;;;;;AAmDA,0CAQC;AA2DD,kDAiBC;AAvID;;;;;;;;;;;;;GAaG;AACH,sDAAyB;AACzB,0DAA6B;AAC7B,uCAAyC;AAEzC,qCAAkC;AAelC;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,eAAe,CAAC,SAA0B;IACxD,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,SAAS,CAAC;IAC/B,OAAO;QACL,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,eAAM,CAAC,EAAE,CAAC,CAAC;QAC9C,GAAG,CAAC,IAAI;YACN,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAe,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,eAAM,CAAC,EAAE,CAAC,CAAC,EAAE;YACrE,CAAC,CAAC,EAAE,CAAC;KACR,CAAC;AACJ,CAAC;AAmBD,6EAA6E;AAC7E,MAAa,cAAe,SAAQ,KAAK;IAG5B;IACA;IACA;IAJX,YACE,OAAe,EACN,SAA6B,EAC7B,SAAmB,EACnB,KAAe;QAExB,KAAK,CAAC,OAAO,CAAC,CAAC;QAJN,cAAS,GAAT,SAAS,CAAoB;QAC7B,cAAS,GAAT,SAAS,CAAU;QACnB,UAAK,GAAL,KAAK,CAAU;QAGxB,IAAI,CAAC,IAAI,GAAG,gBAAgB,CAAC;IAC/B,CAAC;CACF;AAVD,wCAUC;AAED,MAAM,UAAU,GAAG,wBAAwB,CAAC;AAC5C,MAAM,WAAW,GAAG,eAAe,CAAC;AAEpC,0EAA0E;AAC1E,iDAAiD;AACjD,MAAM,YAAY,GAAG,IAAI,QAAQ,CAAC,KAAK,EAAE,oBAAoB,CAE5C,CAAC;AAElB;;;;GAIG;AACH,KAAK,UAAU,iBAAiB,CAAC,IAAY;IAC3C,IAAI,CAAC;QACH,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC;IACvB,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,CAAC;YACH,OAAO,MAAM,YAAY,CAAC,IAAA,wBAAa,EAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC;QACtD,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;AACH,CAAC;AAED,oEAAoE;AAC7D,KAAK,UAAU,mBAAmB,CACvC,MAAc;IAEd,IAAI,CAAC,iBAAE,CAAC,UAAU,CAAC,MAAM,CAAC;QAAE,OAAO,EAAE,CAAC;IACtC,MAAM,GAAG,GAA8B,EAAE,CAAC;IAC1C,KAAK,MAAM,IAAI,IAAI,iBAAE,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;QACjD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC;YAAE,SAAS;QAC/D,MAAM,GAAG,GAAG,MAAM,iBAAiB,CAAC,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;QAC7D,MAAM,SAAS,GAAG,OAAO,GAAG,EAAE,EAAE,KAAK,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC;QACrE,IAAI,OAAO,SAAS,EAAE,EAAE,KAAK,UAAU,EAAE,CAAC;YACxC,MAAM,IAAI,KAAK,CACb,wBAAwB,IAAI,mEAAmE,CAChG,CAAC;QACJ,CAAC;QACD,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC;IAChD,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;GAGG;AACH,SAAS,eAAe;IACtB,OAAO,OAAO,CAAC,kBAAkB,CAAC,CAAC;AACrC,CAAC;AAED;;;;;;;GAOG;AACH,MAAa,UAAU;IAEF;IACA;IAFnB,YACmB,EAAe,EACf,OAA0B;QAD1B,OAAE,GAAF,EAAE,CAAa;QACf,YAAO,GAAP,OAAO,CAAmB;QAE3C,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;QAC5E,CAAC;IACH,CAAC;IAEO,QAAQ;QACd,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,eAAe,EAAE,CAAC;QACtD,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QAC9D,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC;YAC5B,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,QAAQ,EAAE;gBACR,aAAa,EAAE,KAAK,IAAI,EAAE,CACxB,UAAU,IAAI,CAAC,MAAM,mBAAmB,CAAC,MAAO,CAAC,CAAC;aACrD;YACD,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC/C,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,sBAAsB,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAC5D,CAAC,CAAC;QACH,OAAO,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,aAAa,EAAE,CAAC,CAAC;IACpD,CAAC;IAED,+DAA+D;IAC/D,KAAK,CAAC,MAAM;QACV,OAAO,GAAG,CAAC,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC,eAAe,EAAE,CAAC,CAAC;IACtD,CAAC;IAED,8EAA8E;IAC9E,KAAK,CAAC,QAAQ,CAAC,KAAK,GAAG,CAAC;QACtB,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QACjC,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;YAC/B,MAAM,KAAK,GAAG,GAAG,CAAC,MAAM,QAAQ,CAAC,WAAW,EAAE,EAAE,MAAM,CAAC,CAAC;YACxD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;gBAAE,MAAM;YAC9B,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;QACxB,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,+DAA+D;IAC/D,KAAK,CAAC,KAAK;QACT,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QACjC,OAAO,GAAG,CAAC,MAAM,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC;IAC/D,CAAC;IAED,qDAAqD;IACrD,KAAK,CAAC,OAAO;QACX,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;QAChC,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QAC/B,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;IACtB,CAAC;IAED,6CAA6C;IAC7C,KAAK,CAAC,MAAM;QACV,MAAM,IAAI,GAAU,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC,aAAa,EAAE,CAAC;QAC1D,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACtB,IAAI,EAAE,CAAC,CAAC,IAAI;YACZ,UAAU,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI;SACzD,CAAC,CAAC,CAAC;IACN,CAAC;CACF;AA/DD,gCA+DC;AAED,oEAAoE;AACpE,SAAS,GAAG,CACV,MAA4C,EAC5C,SAAmB,EAAE;IAErB,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC;IACrC,MAAM,IAAI,GAAG,OAAO;SACjB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,SAAS,CAAC;SACrC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC;IAC/B,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,OAAO,CAAC,EAAE,aAAa,CAAC;QACxE,MAAM,MAAM,GACV,MAAM,CAAC,KAAK,YAAY,KAAK;YAC3B,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO;YACtB,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC3B,MAAM,IAAI,cAAc,CACtB,MAAM;YACJ,CAAC,CAAC,aAAa,MAAM,YAAY,MAAM,EAAE;YACzC,CAAC,CAAC,sBAAsB,MAAM,EAAE,EAClC,MAAM,EACN,CAAC,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC,EACpB,MAAM,CAAC,KAAK,CACb,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}
|
package/dist/orm/model.d.ts
CHANGED
|
@@ -5,10 +5,13 @@
|
|
|
5
5
|
* @url https://github.com/xtareq
|
|
6
6
|
*/
|
|
7
7
|
import type { Expression, ExpressionBuilder, Kysely, SqlBool, Transaction } from "kysely";
|
|
8
|
+
import type { PageRequest, Paginated } from "./core";
|
|
8
9
|
import type { Cast } from "./casts";
|
|
10
|
+
import { HasRelation } from "./has-relation";
|
|
9
11
|
import { PivotRelation } from "./pivot";
|
|
10
|
-
import { ModelQuery, type ComparisonOperator } from "./query";
|
|
11
|
-
import
|
|
12
|
+
import { ModelQuery, type ComparisonOperator, type Counted, type CursorPageRequest, type CursorPaginated, type ModelAt, type RelationConstraint, type Scope, type SimplePaginated } from "./query";
|
|
13
|
+
import { RELATION } from "./relations";
|
|
14
|
+
import type { BelongsToManyKeys, ColumnKeys, Columns, CreateInput, HasRelationKeys, ModelClass, PivotOf, PrimaryKeyValue, RelatedModel, RelationKeys, RelationPaths, Row, UpdateInput } from "./types";
|
|
12
15
|
type Instance<C extends ModelClass> = InstanceType<C>;
|
|
13
16
|
/**
|
|
14
17
|
* Base class for models.
|
|
@@ -49,8 +52,9 @@ export declare abstract class Model {
|
|
|
49
52
|
static readonly generated: readonly string[];
|
|
50
53
|
/** Fill `createdAt` on insert and `updatedAt` on every write. */
|
|
51
54
|
static readonly timestamps: boolean;
|
|
52
|
-
|
|
53
|
-
static readonly
|
|
55
|
+
/** `null` when the model has no such column (`@CreatedAt` without `@UpdatedAt`). */
|
|
56
|
+
static readonly createdAt: string | null;
|
|
57
|
+
static readonly updatedAt: string | null;
|
|
54
58
|
/**
|
|
55
59
|
* `delete()` sets `deletedAt` instead of removing the row, and queries
|
|
56
60
|
* leave such rows out unless `withTrashed()` / `onlyTrashed()` is used.
|
|
@@ -76,7 +80,8 @@ export declare abstract class Model {
|
|
|
76
80
|
/**
|
|
77
81
|
* Run `fn` in a transaction that every model query inside it uses, however
|
|
78
82
|
* deep in the call chain. Commits when `fn` resolves, rolls back if it
|
|
79
|
-
* throws.
|
|
83
|
+
* throws. A nested call runs in a savepoint: if it throws, only its own
|
|
84
|
+
* work is rolled back (and the error still propagates).
|
|
80
85
|
*/
|
|
81
86
|
static transaction<T>(fn: (trx: Transaction<any>) => Promise<T>): Promise<T>;
|
|
82
87
|
static query<C extends ModelClass>(this: C): ModelQuery<Instance<C>>;
|
|
@@ -84,6 +89,15 @@ export declare abstract class Model {
|
|
|
84
89
|
static where<C extends ModelClass, K extends keyof Columns<Instance<C>> & string>(this: C, column: K, op: ComparisonOperator, value: Columns<Instance<C>>[K] | readonly Columns<Instance<C>>[K][]): ModelQuery<Instance<C>>;
|
|
85
90
|
static where<C extends ModelClass>(this: C, expression: (eb: ExpressionBuilder<any, any>) => Expression<SqlBool>): ModelQuery<Instance<C>>;
|
|
86
91
|
static with<C extends ModelClass, Q extends RelationPaths<Instance<C>>>(this: C, ...paths: Q[]): ModelQuery<Instance<C>, Q>;
|
|
92
|
+
/** Rows with at least one related row. See {@link ModelQuery.whereHas}. */
|
|
93
|
+
static whereHas<C extends ModelClass, Q extends RelationPaths<Instance<C>>>(this: C, relation: Q, constrain?: RelationConstraint<ModelAt<Instance<C>, Q>>): ModelQuery<Instance<C>>;
|
|
94
|
+
/** Rows with no related row. See {@link ModelQuery.whereDoesntHave}. */
|
|
95
|
+
static whereDoesntHave<C extends ModelClass, Q extends RelationPaths<Instance<C>>>(this: C, relation: Q, constrain?: RelationConstraint<ModelAt<Instance<C>, Q>>): ModelQuery<Instance<C>>;
|
|
96
|
+
/** Add `<relation>_count` to each result. See {@link ModelQuery.withCount}. */
|
|
97
|
+
static withCount<C extends ModelClass, N extends RelationKeys<Instance<C>>>(this: C, ...relations: N[]): ModelQuery<Instance<C>, never, ColumnKeys<Instance<C>>, Counted<N>>;
|
|
98
|
+
static withCount<C extends ModelClass, N extends RelationKeys<Instance<C>>>(this: C, relation: N, constrain: RelationConstraint<RelatedModel<Instance<C>[N]>>): ModelQuery<Instance<C>, never, ColumnKeys<Instance<C>>, Counted<N>>;
|
|
99
|
+
/** Query with a reusable {@link Scope} applied. */
|
|
100
|
+
static scope<C extends ModelClass, A extends unknown[]>(this: C, scope: Scope<Instance<C>, A>, ...args: A): ModelQuery<Instance<C>>;
|
|
87
101
|
/** Query including soft-deleted rows. */
|
|
88
102
|
static withTrashed<C extends ModelClass>(this: C): ModelQuery<Instance<C>>;
|
|
89
103
|
/** Query only soft-deleted rows. */
|
|
@@ -93,6 +107,31 @@ export declare abstract class Model {
|
|
|
93
107
|
static find<C extends ModelClass>(this: C, id: PrimaryKeyValue<C>): Promise<Row<Instance<C>> | undefined>;
|
|
94
108
|
/** Find by primary key, or throw a 404 `NotFoundException`. */
|
|
95
109
|
static findOrFail<C extends ModelClass>(this: C, id: PrimaryKeyValue<C>): Promise<Row<Instance<C>>>;
|
|
110
|
+
/**
|
|
111
|
+
* The first row matching a column value, or every given column:
|
|
112
|
+
* `User.findBy("email", "ann@x.io")`, `User.findBy({ email, active: true })`.
|
|
113
|
+
*/
|
|
114
|
+
static findBy<C extends ModelClass, K extends keyof Columns<Instance<C>> & string>(this: C, column: K, value: Columns<Instance<C>>[K]): Promise<Row<Instance<C>> | undefined>;
|
|
115
|
+
static findBy<C extends ModelClass>(this: C, values: Partial<Columns<Instance<C>>>): Promise<Row<Instance<C>> | undefined>;
|
|
116
|
+
/** Like {@link Model.findBy}, but throws a 404 `NotFoundException` when nothing matches. */
|
|
117
|
+
static findByOrFail<C extends ModelClass, K extends keyof Columns<Instance<C>> & string>(this: C, column: K, value: Columns<Instance<C>>[K]): Promise<Row<Instance<C>>>;
|
|
118
|
+
static findByOrFail<C extends ModelClass>(this: C, values: Partial<Columns<Instance<C>>>): Promise<Row<Instance<C>>>;
|
|
119
|
+
/** Number of rows (soft-deleted rows excluded). */
|
|
120
|
+
static count<C extends ModelClass>(this: C): Promise<number>;
|
|
121
|
+
/** Sum of `column`; `0` for an empty table. */
|
|
122
|
+
static sum<C extends ModelClass>(this: C, column: keyof Columns<Instance<C>> & string): Promise<number>;
|
|
123
|
+
/** Average of `column`; `null` for an empty table. */
|
|
124
|
+
static avg<C extends ModelClass>(this: C, column: keyof Columns<Instance<C>> & string): Promise<number | null>;
|
|
125
|
+
/** Smallest value of `column`; `null` for an empty table. */
|
|
126
|
+
static min<C extends ModelClass, K extends keyof Columns<Instance<C>> & string>(this: C, column: K): Promise<Columns<Instance<C>>[K] | null>;
|
|
127
|
+
/** Largest value of `column`; `null` for an empty table. */
|
|
128
|
+
static max<C extends ModelClass, K extends keyof Columns<Instance<C>> & string>(this: C, column: K): Promise<Columns<Instance<C>>[K] | null>;
|
|
129
|
+
/** One page of every row. See {@link ModelQuery.paginate}. */
|
|
130
|
+
static paginate<C extends ModelClass>(this: C, request?: PageRequest): Promise<Paginated<Row<Instance<C>>>>;
|
|
131
|
+
/** One page without a total count. See {@link ModelQuery.simplePaginate}. */
|
|
132
|
+
static simplePaginate<C extends ModelClass>(this: C, request?: PageRequest): Promise<SimplePaginated<Row<Instance<C>>>>;
|
|
133
|
+
/** Keyset pagination. See {@link ModelQuery.cursorPaginate}. */
|
|
134
|
+
static cursorPaginate<C extends ModelClass>(this: C, request?: CursorPageRequest<keyof Columns<Instance<C>> & string>): Promise<CursorPaginated<Row<Instance<C>>>>;
|
|
96
135
|
/** Insert a row and return it as a model instance. */
|
|
97
136
|
static create<C extends ModelClass>(this: C, values: CreateInput<C>): Promise<Row<Instance<C>>>;
|
|
98
137
|
/** Whether this instance's row exists in the database. */
|
|
@@ -118,8 +157,18 @@ export declare abstract class Model {
|
|
|
118
157
|
* related models: `await user.related("roles").sync([1, 2])`.
|
|
119
158
|
*/
|
|
120
159
|
related<K extends BelongsToManyKeys<this>>(name: K): PivotRelation<RelatedModel<this[K]>, PivotOf<this[K]>>;
|
|
160
|
+
/**
|
|
161
|
+
* The rows of a `hasMany` / `hasOne` relation, to query or create them
|
|
162
|
+
* with the foreign key set: `await user.related("posts").create({ title })`.
|
|
163
|
+
*/
|
|
164
|
+
related<K extends HasRelationKeys<this>>(name: K): HasRelation<RelatedModel<this[K]>, this[K] extends HasManyMarker ? "many" : "one">;
|
|
121
165
|
private key;
|
|
122
|
-
/** Columns and
|
|
166
|
+
/** Columns, loaded relations, and extras such as `pivot` and `withCount()` counts. */
|
|
123
167
|
toJSON(): Record<string, unknown>;
|
|
124
168
|
}
|
|
169
|
+
type HasManyMarker = {
|
|
170
|
+
readonly [RELATION]: {
|
|
171
|
+
type: "hasMany";
|
|
172
|
+
};
|
|
173
|
+
};
|
|
125
174
|
export {};
|
package/dist/orm/model.js
CHANGED
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.Model = void 0;
|
|
4
|
-
const
|
|
4
|
+
const core_1 = require("./core");
|
|
5
5
|
const connection_1 = require("./connection");
|
|
6
|
+
const has_relation_1 = require("./has-relation");
|
|
7
|
+
const naming_1 = require("./naming");
|
|
6
8
|
const pivot_1 = require("./pivot");
|
|
7
9
|
const query_1 = require("./query");
|
|
8
10
|
const relations_1 = require("./relations");
|
|
@@ -46,6 +48,7 @@ class Model {
|
|
|
46
48
|
static generated = ["id"];
|
|
47
49
|
/** Fill `createdAt` on insert and `updatedAt` on every write. */
|
|
48
50
|
static timestamps = false;
|
|
51
|
+
/** `null` when the model has no such column (`@CreatedAt` without `@UpdatedAt`). */
|
|
49
52
|
static createdAt = "created_at";
|
|
50
53
|
static updatedAt = "updated_at";
|
|
51
54
|
/**
|
|
@@ -78,10 +81,11 @@ class Model {
|
|
|
78
81
|
/**
|
|
79
82
|
* Run `fn` in a transaction that every model query inside it uses, however
|
|
80
83
|
* deep in the call chain. Commits when `fn` resolves, rolls back if it
|
|
81
|
-
* throws.
|
|
84
|
+
* throws. A nested call runs in a savepoint: if it throws, only its own
|
|
85
|
+
* work is rolled back (and the error still propagates).
|
|
82
86
|
*/
|
|
83
87
|
static transaction(fn) {
|
|
84
|
-
return (0, connection_1.runInTransaction)(fn);
|
|
88
|
+
return (0, connection_1.runInTransaction)(fn, { savepoint: true });
|
|
85
89
|
}
|
|
86
90
|
// ── Queries ─────────────────────────────────────────────────────────────
|
|
87
91
|
static query() {
|
|
@@ -93,6 +97,21 @@ class Model {
|
|
|
93
97
|
static with(...paths) {
|
|
94
98
|
return new query_1.ModelQuery(this).with(...paths);
|
|
95
99
|
}
|
|
100
|
+
/** Rows with at least one related row. See {@link ModelQuery.whereHas}. */
|
|
101
|
+
static whereHas(relation, constrain) {
|
|
102
|
+
return new query_1.ModelQuery(this).whereHas(relation, constrain);
|
|
103
|
+
}
|
|
104
|
+
/** Rows with no related row. See {@link ModelQuery.whereDoesntHave}. */
|
|
105
|
+
static whereDoesntHave(relation, constrain) {
|
|
106
|
+
return new query_1.ModelQuery(this).whereDoesntHave(relation, constrain);
|
|
107
|
+
}
|
|
108
|
+
static withCount(...args) {
|
|
109
|
+
return new query_1.ModelQuery(this).withCount(...args);
|
|
110
|
+
}
|
|
111
|
+
/** Query with a reusable {@link Scope} applied. */
|
|
112
|
+
static scope(scope, ...args) {
|
|
113
|
+
return new query_1.ModelQuery(this).scope(scope, ...args);
|
|
114
|
+
}
|
|
96
115
|
/** Query including soft-deleted rows. */
|
|
97
116
|
static withTrashed() {
|
|
98
117
|
return new query_1.ModelQuery(this).withTrashed();
|
|
@@ -114,9 +133,47 @@ class Model {
|
|
|
114
133
|
static async findOrFail(id) {
|
|
115
134
|
const found = await this.find(id);
|
|
116
135
|
if (!found)
|
|
117
|
-
throw new
|
|
136
|
+
throw new core_1.NotFoundException(`${this.name} not found`);
|
|
118
137
|
return found;
|
|
119
138
|
}
|
|
139
|
+
static findBy(...args) {
|
|
140
|
+
return whereAll(this, args).first();
|
|
141
|
+
}
|
|
142
|
+
static findByOrFail(...args) {
|
|
143
|
+
return whereAll(this, args).firstOrFail();
|
|
144
|
+
}
|
|
145
|
+
/** Number of rows (soft-deleted rows excluded). */
|
|
146
|
+
static count() {
|
|
147
|
+
return new query_1.ModelQuery(this).count();
|
|
148
|
+
}
|
|
149
|
+
/** Sum of `column`; `0` for an empty table. */
|
|
150
|
+
static sum(column) {
|
|
151
|
+
return new query_1.ModelQuery(this).sum(column);
|
|
152
|
+
}
|
|
153
|
+
/** Average of `column`; `null` for an empty table. */
|
|
154
|
+
static avg(column) {
|
|
155
|
+
return new query_1.ModelQuery(this).avg(column);
|
|
156
|
+
}
|
|
157
|
+
/** Smallest value of `column`; `null` for an empty table. */
|
|
158
|
+
static min(column) {
|
|
159
|
+
return new query_1.ModelQuery(this).min(column);
|
|
160
|
+
}
|
|
161
|
+
/** Largest value of `column`; `null` for an empty table. */
|
|
162
|
+
static max(column) {
|
|
163
|
+
return new query_1.ModelQuery(this).max(column);
|
|
164
|
+
}
|
|
165
|
+
/** One page of every row. See {@link ModelQuery.paginate}. */
|
|
166
|
+
static paginate(request) {
|
|
167
|
+
return new query_1.ModelQuery(this).paginate(request);
|
|
168
|
+
}
|
|
169
|
+
/** One page without a total count. See {@link ModelQuery.simplePaginate}. */
|
|
170
|
+
static simplePaginate(request) {
|
|
171
|
+
return new query_1.ModelQuery(this).simplePaginate(request);
|
|
172
|
+
}
|
|
173
|
+
/** Keyset pagination. See {@link ModelQuery.cursorPaginate}. */
|
|
174
|
+
static cursorPaginate(request) {
|
|
175
|
+
return new query_1.ModelQuery(this).cursorPaginate(request);
|
|
176
|
+
}
|
|
120
177
|
/** Insert a row and return it as a model instance. */
|
|
121
178
|
static async create(values) {
|
|
122
179
|
const row = await (0, state_1.insertRow)(this, values);
|
|
@@ -170,7 +227,7 @@ class Model {
|
|
|
170
227
|
const cls = this.constructor;
|
|
171
228
|
await (0, connection_1.getConnection)()
|
|
172
229
|
.deleteFrom((0, state_1.tableOf)(cls))
|
|
173
|
-
.where(cls.primaryKey, "=", this.key())
|
|
230
|
+
.where((0, naming_1.columnName)(cls, cls.primaryKey), "=", this.key())
|
|
174
231
|
.execute();
|
|
175
232
|
(0, state_1.markDeleted)(this);
|
|
176
233
|
}
|
|
@@ -190,30 +247,39 @@ class Model {
|
|
|
190
247
|
const value = this[cls.deletedAt];
|
|
191
248
|
return cls.softDeletes && value !== null && value !== undefined;
|
|
192
249
|
}
|
|
193
|
-
/**
|
|
194
|
-
* The pivot rows of a `belongsToMany` relation, to attach, detach or sync
|
|
195
|
-
* related models: `await user.related("roles").sync([1, 2])`.
|
|
196
|
-
*/
|
|
197
250
|
related(name) {
|
|
198
251
|
const def = (0, relations_1.getRelation)(this.constructor, name);
|
|
199
|
-
|
|
252
|
+
if (def.kind === "belongsToMany")
|
|
253
|
+
return new pivot_1.PivotRelation(this, def);
|
|
254
|
+
if (def.kind === "hasMany" || def.kind === "hasOne") {
|
|
255
|
+
return new has_relation_1.HasRelation(this, def);
|
|
256
|
+
}
|
|
257
|
+
throw new Error(`[Megh ORM] related("${name}") works with hasMany, hasOne and belongsToMany relations.`);
|
|
200
258
|
}
|
|
201
259
|
key() {
|
|
202
260
|
return this[this.constructor.primaryKey];
|
|
203
261
|
}
|
|
204
|
-
/** Columns and
|
|
262
|
+
/** Columns, loaded relations, and extras such as `pivot` and `withCount()` counts. */
|
|
205
263
|
toJSON() {
|
|
206
264
|
const out = {};
|
|
207
|
-
|
|
265
|
+
// Columns and relations are enumerable own properties; extras are not.
|
|
266
|
+
for (const key of Object.getOwnPropertyNames(this)) {
|
|
267
|
+
const value = this[key];
|
|
208
268
|
if (value !== undefined && !(0, relations_1.isRelationMarker)(value))
|
|
209
269
|
out[key] = value;
|
|
210
270
|
}
|
|
211
|
-
const pivot = this.pivot;
|
|
212
|
-
if (pivot && !Object.prototype.propertyIsEnumerable.call(this, "pivot")) {
|
|
213
|
-
out.pivot = pivot;
|
|
214
|
-
}
|
|
215
271
|
return out;
|
|
216
272
|
}
|
|
217
273
|
}
|
|
218
274
|
exports.Model = Model;
|
|
275
|
+
/** A query matching `findBy(column, value)` or `findBy({ column: value })`. */
|
|
276
|
+
function whereAll(cls, args) {
|
|
277
|
+
const query = new query_1.ModelQuery(cls);
|
|
278
|
+
if (args.length >= 2)
|
|
279
|
+
return query.where(args[0], args[1]);
|
|
280
|
+
for (const [column, value] of Object.entries(args[0] ?? {})) {
|
|
281
|
+
query.where(column, value);
|
|
282
|
+
}
|
|
283
|
+
return query;
|
|
284
|
+
}
|
|
219
285
|
//# sourceMappingURL=model.js.map
|
package/dist/orm/model.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"model.js","sourceRoot":"","sources":["../../src/orm/model.ts"],"names":[],"mappings":";;;AAaA,
|
|
1
|
+
{"version":3,"file":"model.js","sourceRoot":"","sources":["../../src/orm/model.ts"],"names":[],"mappings":";;;AAaA,iCAA2C;AAE3C,6CAA8E;AAE9E,iDAA6C;AAC7C,qCAAsC;AACtC,mCAAwC;AACxC,mCAWiB;AACjB,2CAAsE;AACtE,mCAWiB;AAmBjB;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAsB,KAAK;IACzB,4BAA4B;IAC5B,MAAM,CAAU,KAAK,CAAS;IAC9B,0BAA0B;IAC1B,MAAM,CAAU,UAAU,GAAW,IAAI,CAAC;IAC1C;;;OAGG;IACH,MAAM,CAAU,SAAS,GAAsB,CAAC,IAAI,CAAC,CAAC;IAEtD,iEAAiE;IACjE,MAAM,CAAU,UAAU,GAAY,KAAK,CAAC;IAC5C,oFAAoF;IACpF,MAAM,CAAU,SAAS,GAAkB,YAAY,CAAC;IACxD,MAAM,CAAU,SAAS,GAAkB,YAAY,CAAC;IAExD;;;OAGG;IACH,MAAM,CAAU,WAAW,GAAY,KAAK,CAAC;IAC7C,MAAM,CAAU,SAAS,GAAW,YAAY,CAAC;IAEjD;;;OAGG;IACH,MAAM,CAAU,KAAK,GAAmC,EAAE,CAAC;IAE3D,2EAA2E;IAE3E;;;OAGG;IACH,MAAM,CAAC,aAAa,CAAC,EAAe;QAClC,IAAA,0BAAa,EAAC,EAAE,CAAC,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,EAAE;QACP,OAAO,IAAA,0BAAa,GAAgB,CAAC;IACvC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,WAAW,CAAI,EAAyC;QAC7D,OAAO,IAAA,6BAAgB,EAAC,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACnD,CAAC;IAED,2EAA2E;IAE3E,MAAM,CAAC,KAAK;QACV,OAAO,IAAI,kBAAU,CAAc,IAAI,CAAC,CAAC;IAC3C,CAAC;IAuBD,MAAM,CAAC,KAAK,CAAmB,GAAG,IAAW;QAC3C,OAAQ,IAAI,kBAAU,CAAM,IAAI,CAAC,CAAC,KAAa,CAAC,GAAG,IAAI,CAAC,CAAC;IAC3D,CAAC;IAED,MAAM,CAAC,IAAI,CAET,GAAG,KAAU;QAEb,OAAO,IAAI,kBAAU,CAAc,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;IAC1D,CAAC;IAED,2EAA2E;IAC3E,MAAM,CAAC,QAAQ,CAEb,QAAW,EACX,SAAuD;QAEvD,OAAO,IAAI,kBAAU,CAAc,IAAI,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IACzE,CAAC;IAED,wEAAwE;IACxE,MAAM,CAAC,eAAe,CAKpB,QAAW,EACX,SAAuD;QAEvD,OAAO,IAAI,kBAAU,CAAc,IAAI,CAAC,CAAC,eAAe,CACtD,QAAQ,EACR,SAAS,CACV,CAAC;IACJ,CAAC;IAYD,MAAM,CAAC,SAAS,CAAmB,GAAG,IAAW;QAC/C,OAAQ,IAAI,kBAAU,CAAM,IAAI,CAAC,CAAC,SAAiB,CAAC,GAAG,IAAI,CAAC,CAAC;IAC/D,CAAC;IAED,mDAAmD;IACnD,MAAM,CAAC,KAAK,CAEV,KAA4B,EAC5B,GAAG,IAAO;QAEV,OAAO,IAAI,kBAAU,CAAc,IAAI,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC;IACjE,CAAC;IAED,yCAAyC;IACzC,MAAM,CAAC,WAAW;QAChB,OAAO,IAAI,kBAAU,CAAc,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;IACzD,CAAC;IAED,oCAAoC;IACpC,MAAM,CAAC,WAAW;QAChB,OAAO,IAAI,kBAAU,CAAc,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;IACzD,CAAC;IAED,MAAM,CAAC,GAAG;QACR,OAAO,IAAI,kBAAU,CAAc,IAAI,CAAC,CAAC,GAAG,EAAE,CAAC;IACjD,CAAC;IAED,2BAA2B;IAC3B,MAAM,CAAC,IAAI,CAET,EAAsB;QAEtB,OAAQ,IAAI,kBAAU,CAAc,IAAI,CAAqB;aAC1D,KAAK,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;aAC1B,KAAK,EAA2C,CAAC;IACtD,CAAC;IAED,+DAA+D;IAC/D,MAAM,CAAC,KAAK,CAAC,UAAU,CAErB,EAAsB;QAEtB,MAAM,KAAK,GAAG,MAAO,IAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC3C,IAAI,CAAC,KAAK;YAAE,MAAM,IAAI,wBAAiB,CAAC,GAAG,IAAI,CAAC,IAAI,YAAY,CAAC,CAAC;QAClE,OAAO,KAAK,CAAC;IACf,CAAC;IAkBD,MAAM,CAAC,MAAM,CAAmB,GAAG,IAAW;QAC5C,OAAO,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC;IACtC,CAAC;IAeD,MAAM,CAAC,YAAY,CAAmB,GAAG,IAAW;QAClD,OAAO,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;IAC5C,CAAC;IAED,mDAAmD;IACnD,MAAM,CAAC,KAAK;QACV,OAAO,IAAI,kBAAU,CAAc,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC;IACnD,CAAC;IAED,+CAA+C;IAC/C,MAAM,CAAC,GAAG,CAER,MAA2C;QAE3C,OAAO,IAAI,kBAAU,CAAc,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACvD,CAAC;IAED,sDAAsD;IACtD,MAAM,CAAC,GAAG,CAER,MAA2C;QAE3C,OAAO,IAAI,kBAAU,CAAc,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACvD,CAAC;IAED,6DAA6D;IAC7D,MAAM,CAAC,GAAG,CAGC,MAAS;QAClB,OAAO,IAAI,kBAAU,CAAc,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACvD,CAAC;IAED,4DAA4D;IAC5D,MAAM,CAAC,GAAG,CAGC,MAAS;QAClB,OAAO,IAAI,kBAAU,CAAc,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACvD,CAAC;IAED,8DAA8D;IAC9D,MAAM,CAAC,QAAQ,CAEb,OAAqB;QAErB,OAAO,IAAI,kBAAU,CAAc,IAAI,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED,6EAA6E;IAC7E,MAAM,CAAC,cAAc,CAEnB,OAAqB;QAErB,OAAO,IAAI,kBAAU,CAAc,IAAI,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACnE,CAAC;IAED,gEAAgE;IAChE,MAAM,CAAC,cAAc,CAEnB,OAAgE;QAEhE,OAAO,IAAI,kBAAU,CAAc,IAAI,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACnE,CAAC;IAED,sDAAsD;IACtD,MAAM,CAAC,KAAK,CAAC,MAAM,CAEjB,MAAsB;QAEtB,MAAM,GAAG,GAAG,MAAM,IAAA,iBAAS,EAAC,IAAI,EAAE,MAAiC,CAAC,CAAC;QACrE,OAAO,IAAA,eAAO,EAAC,IAAI,EAAE,GAAG,EAAE,KAAK,CAAqB,CAAC;IACvD,CAAC;IAED,2EAA2E;IAE3E,0DAA0D;IAC1D,WAAW;QACT,OAAO,IAAA,gBAAQ,EAAC,IAAI,CAAC,CAAC,MAAM,CAAC;IAC/B,CAAC;IAED,2DAA2D;IAC3D,IAAI,CAAC,MAAyB;QAC5B,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,IAAI;QACR,MAAM,GAAG,GAAG,IAAI,CAAC,WAAyB,CAAC;QAC3C,IAAI,CAAC,IAAA,gBAAQ,EAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;YAC3B,MAAM,GAAG,GAAG,MAAM,IAAA,iBAAS,EAAC,GAAG,EAAE,IAAA,oBAAY,EAAC,IAAI,CAAC,CAAC,CAAC;YACrD,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;YACzB,IAAA,qBAAa,EAAC,IAAI,EAAE,GAAG,CAAC,CAAC;YACzB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,OAAO,GAAG,IAAA,qBAAa,EAAC,IAAI,CAAC,CAAC;QACpC,OAAO,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC/B,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpC,MAAM,MAAM,GAAG,IAAA,sBAAc,EAAC,GAAG,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;YACtD,MAAM,IAAA,iBAAS,EAAC,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,CAAC;YACzC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC9B,CAAC;QACD,IAAA,qBAAa,EAAC,IAAI,EAAE,IAAA,oBAAY,EAAC,IAAI,CAAC,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,oEAAoE;IACpE,KAAK,CAAC,MAAM;QACV,MAAM,GAAG,GAAG,IAAI,CAAC,WAAyB,CAAC;QAC3C,IAAI,CAAC,GAAG,CAAC,WAAW;YAAE,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC;QAChD,MAAM,MAAM,GAAG,IAAA,sBAAc,EAC3B,GAAG,EACH,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,IAAI,IAAI,EAAE,EAAE,EAC/B,QAAQ,CACT,CAAC;QACF,MAAM,IAAA,iBAAS,EAAC,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,CAAC;QACzC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC5B,IAAA,qBAAa,EAAC,IAAI,EAAE,IAAA,oBAAY,EAAC,IAAI,CAAC,CAAC,CAAC;IAC1C,CAAC;IAED,2DAA2D;IAC3D,KAAK,CAAC,WAAW;QACf,MAAM,GAAG,GAAG,IAAI,CAAC,WAAyB,CAAC;QAC3C,MAAM,IAAA,0BAAa,GAAE;aAClB,UAAU,CAAC,IAAA,eAAO,EAAC,GAAG,CAAC,CAAC;aACxB,KAAK,CAAC,IAAA,mBAAU,EAAC,GAAG,EAAE,GAAG,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC;aACvD,OAAO,EAAE,CAAC;QACb,IAAA,mBAAW,EAAC,IAAI,CAAC,CAAC;IACpB,CAAC;IAED,0BAA0B;IAC1B,KAAK,CAAC,OAAO;QACX,MAAM,GAAG,GAAG,IAAI,CAAC,WAAyB,CAAC;QAC3C,IAAA,yBAAiB,EAAC,GAAG,CAAC,CAAC;QACvB,MAAM,MAAM,GAAG,IAAA,sBAAc,EAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,EAAE,QAAQ,CAAC,CAAC;QACxE,MAAM,IAAA,iBAAS,EAAC,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,CAAC;QACzC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC5B,IAAA,qBAAa,EAAC,IAAI,EAAE,IAAA,oBAAY,EAAC,IAAI,CAAC,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,4CAA4C;IAC5C,SAAS;QACP,MAAM,GAAG,GAAG,IAAI,CAAC,WAAyB,CAAC;QAC3C,MAAM,KAAK,GAAI,IAAY,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC3C,OAAO,GAAG,CAAC,WAAW,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,CAAC;IAClE,CAAC;IAmBD,OAAO,CAAC,IAAY;QAClB,MAAM,GAAG,GAAG,IAAA,uBAAW,EAAC,IAAI,CAAC,WAAyB,EAAE,IAAI,CAAC,CAAC;QAC9D,IAAI,GAAG,CAAC,IAAI,KAAK,eAAe;YAAE,OAAO,IAAI,qBAAa,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QACtE,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACpD,OAAO,IAAI,0BAAW,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QACpC,CAAC;QACD,MAAM,IAAI,KAAK,CACb,uBAAuB,IAAI,4DAA4D,CACxF,CAAC;IACJ,CAAC;IAEO,GAAG;QACT,OAAQ,IAAY,CAAE,IAAI,CAAC,WAA0B,CAAC,UAAU,CAAC,CAAC;IACpE,CAAC;IAED,sFAAsF;IACtF,MAAM;QACJ,MAAM,GAAG,GAA4B,EAAE,CAAC;QACxC,uEAAuE;QACvE,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;YACnD,MAAM,KAAK,GAAI,IAAY,CAAC,GAAG,CAAC,CAAC;YACjC,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,IAAA,4BAAgB,EAAC,KAAK,CAAC;gBAAE,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QACxE,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;;AAtZH,sBAuZC;AAID,+EAA+E;AAC/E,SAAS,QAAQ,CAAC,GAAe,EAAE,IAAW;IAC5C,MAAM,KAAK,GAAG,IAAI,kBAAU,CAAM,GAAG,CAAC,CAAC;IACvC,IAAI,IAAI,CAAC,MAAM,IAAI,CAAC;QAAE,OAAO,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3D,KAAK,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;QAC5D,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAC7B,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
export type NamingStrategy = "preserve" | "snake_case";
|
|
2
|
+
/**
|
|
3
|
+
* How decorated properties without an explicit `name` map to columns.
|
|
4
|
+
* `app.useMeghORM({ naming })` sets it; call it directly in scripts and tests.
|
|
5
|
+
*/
|
|
6
|
+
export declare function setNamingStrategy(value: NamingStrategy): void;
|
|
7
|
+
export declare function getNamingStrategy(): NamingStrategy;
|
|
8
|
+
/**
|
|
9
|
+
* The column for a property of `cls`. Anything else (a column name already,
|
|
10
|
+
* a qualified `table.column`) is returned as is, so relation keys may be
|
|
11
|
+
* given either way.
|
|
12
|
+
*/
|
|
13
|
+
export declare function columnName(cls: Function, name: string): string;
|
|
14
|
+
/** The property for a column of `cls`; names that aren't mapped are returned as is. */
|
|
15
|
+
export declare function propertyName(cls: Function, name: string): string;
|
|
16
|
+
/** `values` keyed by column instead of property. */
|
|
17
|
+
export declare function toColumns(cls: Function, values: Record<string, unknown>): Record<string, unknown>;
|
|
18
|
+
/** A database row keyed by property instead of column. */
|
|
19
|
+
export declare function toProperties(cls: Function, row: Record<string, unknown>): Record<string, unknown>;
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.setNamingStrategy = setNamingStrategy;
|
|
4
|
+
exports.getNamingStrategy = getNamingStrategy;
|
|
5
|
+
exports.columnName = columnName;
|
|
6
|
+
exports.propertyName = propertyName;
|
|
7
|
+
exports.toColumns = toColumns;
|
|
8
|
+
exports.toProperties = toProperties;
|
|
9
|
+
/**
|
|
10
|
+
* Property names on models, column names in the database.
|
|
11
|
+
*
|
|
12
|
+
* A decorated column's name comes from `@Column({ name })`, else from the
|
|
13
|
+
* naming strategy: `"preserve"` (the default) uses the property name,
|
|
14
|
+
* `"snake_case"` turns `createdAt` into `created_at`. Models without column
|
|
15
|
+
* decorators always use their property names.
|
|
16
|
+
*
|
|
17
|
+
* The rest of the ORM works in property names and converts at the edges:
|
|
18
|
+
* values on their way into SQL, rows on their way out, and column names in
|
|
19
|
+
* queries.
|
|
20
|
+
*/
|
|
21
|
+
const decorators_1 = require("./decorators");
|
|
22
|
+
const relations_1 = require("./relations");
|
|
23
|
+
let strategy = "preserve";
|
|
24
|
+
/**
|
|
25
|
+
* How decorated properties without an explicit `name` map to columns.
|
|
26
|
+
* `app.useMeghORM({ naming })` sets it; call it directly in scripts and tests.
|
|
27
|
+
*/
|
|
28
|
+
function setNamingStrategy(value) {
|
|
29
|
+
if (value !== "preserve" && value !== "snake_case") {
|
|
30
|
+
throw new Error(`[Megh ORM] Unknown naming strategy "${value}". Use "preserve" or "snake_case".`);
|
|
31
|
+
}
|
|
32
|
+
strategy = value;
|
|
33
|
+
}
|
|
34
|
+
function getNamingStrategy() {
|
|
35
|
+
return strategy;
|
|
36
|
+
}
|
|
37
|
+
const EMPTY = { toColumn: new Map(), toProperty: new Map() };
|
|
38
|
+
const cache = new WeakMap();
|
|
39
|
+
/** The property ↔ column pairs that differ, for one model class. */
|
|
40
|
+
function nameMap(cls) {
|
|
41
|
+
const cached = cache.get(cls);
|
|
42
|
+
if (cached && cached.strategy === strategy)
|
|
43
|
+
return cached.map;
|
|
44
|
+
const columns = (0, decorators_1.getModelMetadata)(cls)?.columns;
|
|
45
|
+
let map = EMPTY;
|
|
46
|
+
if (columns && columns.size > 0) {
|
|
47
|
+
map = { toColumn: new Map(), toProperty: new Map() };
|
|
48
|
+
for (const column of columns.values()) {
|
|
49
|
+
const name = column.name ??
|
|
50
|
+
(strategy === "snake_case"
|
|
51
|
+
? (0, relations_1.snakeCase)(column.property)
|
|
52
|
+
: column.property);
|
|
53
|
+
if (name === column.property)
|
|
54
|
+
continue;
|
|
55
|
+
map.toColumn.set(column.property, name);
|
|
56
|
+
map.toProperty.set(name, column.property);
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
cache.set(cls, { strategy, map });
|
|
60
|
+
return map;
|
|
61
|
+
}
|
|
62
|
+
/**
|
|
63
|
+
* The column for a property of `cls`. Anything else (a column name already,
|
|
64
|
+
* a qualified `table.column`) is returned as is, so relation keys may be
|
|
65
|
+
* given either way.
|
|
66
|
+
*/
|
|
67
|
+
function columnName(cls, name) {
|
|
68
|
+
return nameMap(cls).toColumn.get(name) ?? name;
|
|
69
|
+
}
|
|
70
|
+
/** The property for a column of `cls`; names that aren't mapped are returned as is. */
|
|
71
|
+
function propertyName(cls, name) {
|
|
72
|
+
return nameMap(cls).toProperty.get(name) ?? name;
|
|
73
|
+
}
|
|
74
|
+
/** `values` keyed by column instead of property. */
|
|
75
|
+
function toColumns(cls, values) {
|
|
76
|
+
const { toColumn } = nameMap(cls);
|
|
77
|
+
if (toColumn.size === 0)
|
|
78
|
+
return values;
|
|
79
|
+
const out = {};
|
|
80
|
+
for (const [key, value] of Object.entries(values)) {
|
|
81
|
+
out[toColumn.get(key) ?? key] = value;
|
|
82
|
+
}
|
|
83
|
+
return out;
|
|
84
|
+
}
|
|
85
|
+
/** A database row keyed by property instead of column. */
|
|
86
|
+
function toProperties(cls, row) {
|
|
87
|
+
const { toProperty } = nameMap(cls);
|
|
88
|
+
if (toProperty.size === 0)
|
|
89
|
+
return row;
|
|
90
|
+
const out = {};
|
|
91
|
+
for (const [key, value] of Object.entries(row)) {
|
|
92
|
+
out[toProperty.get(key) ?? key] = value;
|
|
93
|
+
}
|
|
94
|
+
return out;
|
|
95
|
+
}
|
|
96
|
+
//# sourceMappingURL=naming.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"naming.js","sourceRoot":"","sources":["../../src/orm/naming.ts"],"names":[],"mappings":";;AAuBA,8CAOC;AAED,8CAEC;AA0CD,gCAEC;AAGD,oCAEC;AAGD,8BAWC;AAGD,oCAWC;AA/GD;;;;;;;;;;;GAWG;AACH,6CAAgD;AAChD,2CAAwC;AAIxC,IAAI,QAAQ,GAAmB,UAAU,CAAC;AAE1C;;;GAGG;AACH,SAAgB,iBAAiB,CAAC,KAAqB;IACrD,IAAI,KAAK,KAAK,UAAU,IAAI,KAAK,KAAK,YAAY,EAAE,CAAC;QACnD,MAAM,IAAI,KAAK,CACb,uCAAuC,KAAK,oCAAoC,CACjF,CAAC;IACJ,CAAC;IACD,QAAQ,GAAG,KAAK,CAAC;AACnB,CAAC;AAED,SAAgB,iBAAiB;IAC/B,OAAO,QAAQ,CAAC;AAClB,CAAC;AAOD,MAAM,KAAK,GAAY,EAAE,QAAQ,EAAE,IAAI,GAAG,EAAE,EAAE,UAAU,EAAE,IAAI,GAAG,EAAE,EAAE,CAAC;AACtE,MAAM,KAAK,GAAG,IAAI,OAAO,EAGtB,CAAC;AAEJ,oEAAoE;AACpE,SAAS,OAAO,CAAC,GAAa;IAC5B,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC9B,IAAI,MAAM,IAAI,MAAM,CAAC,QAAQ,KAAK,QAAQ;QAAE,OAAO,MAAM,CAAC,GAAG,CAAC;IAE9D,MAAM,OAAO,GAAG,IAAA,6BAAgB,EAAC,GAAG,CAAC,EAAE,OAAO,CAAC;IAC/C,IAAI,GAAG,GAAG,KAAK,CAAC;IAChB,IAAI,OAAO,IAAI,OAAO,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;QAChC,GAAG,GAAG,EAAE,QAAQ,EAAE,IAAI,GAAG,EAAE,EAAE,UAAU,EAAE,IAAI,GAAG,EAAE,EAAE,CAAC;QACrD,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;YACtC,MAAM,IAAI,GACR,MAAM,CAAC,IAAI;gBACX,CAAC,QAAQ,KAAK,YAAY;oBACxB,CAAC,CAAC,IAAA,qBAAS,EAAC,MAAM,CAAC,QAAQ,CAAC;oBAC5B,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YACvB,IAAI,IAAI,KAAK,MAAM,CAAC,QAAQ;gBAAE,SAAS;YACvC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YACxC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IACD,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,CAAC;IAClC,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;GAIG;AACH,SAAgB,UAAU,CAAC,GAAa,EAAE,IAAY;IACpD,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC;AACjD,CAAC;AAED,uFAAuF;AACvF,SAAgB,YAAY,CAAC,GAAa,EAAE,IAAY;IACtD,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC;AACnD,CAAC;AAED,oDAAoD;AACpD,SAAgB,SAAS,CACvB,GAAa,EACb,MAA+B;IAE/B,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAClC,IAAI,QAAQ,CAAC,IAAI,KAAK,CAAC;QAAE,OAAO,MAAM,CAAC;IACvC,MAAM,GAAG,GAA4B,EAAE,CAAC;IACxC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAClD,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,GAAG,KAAK,CAAC;IACxC,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,0DAA0D;AAC1D,SAAgB,YAAY,CAC1B,GAAa,EACb,GAA4B;IAE5B,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACpC,IAAI,UAAU,CAAC,IAAI,KAAK,CAAC;QAAE,OAAO,GAAG,CAAC;IACtC,MAAM,GAAG,GAA4B,EAAE,CAAC;IACxC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/C,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,GAAG,KAAK,CAAC;IAC1C,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @copyright 2024
|
|
3
|
+
* @author Tareq Hossain
|
|
4
|
+
* @email xtrinsic96@gmail.com
|
|
5
|
+
* @url https://github.com/xtareq
|
|
6
|
+
*
|
|
7
|
+
* Internal: adding a row limit and offset to a select in the dialect's syntax.
|
|
8
|
+
*
|
|
9
|
+
* - Postgres, MySQL and SQLite use `limit … offset …`. MySQL and SQLite need a
|
|
10
|
+
* limit before an offset, so an offset alone gets the largest safe limit.
|
|
11
|
+
* - SQL Server has no `limit`. A limit alone becomes `select top(n)`. An
|
|
12
|
+
* offset becomes `offset n rows fetch next m rows only`, which needs an
|
|
13
|
+
* `order by`, so `order by (select null)` is added when the query has none.
|
|
14
|
+
*/
|
|
15
|
+
import type { Kysely } from "kysely";
|
|
16
|
+
export interface Paging {
|
|
17
|
+
limit?: number;
|
|
18
|
+
offset?: number;
|
|
19
|
+
/** Whether the query already has an `order by`. */
|
|
20
|
+
ordered: boolean;
|
|
21
|
+
}
|
|
22
|
+
export declare function applyPaging(db: Kysely<any>, qb: any, { limit, offset, ordered }: Paging): any;
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.applyPaging = applyPaging;
|
|
4
|
+
const casts_1 = require("./casts");
|
|
5
|
+
const engine_1 = require("./engine");
|
|
6
|
+
function applyPaging(db, qb, { limit, offset, ordered }) {
|
|
7
|
+
if ((0, casts_1.usesAdapter)(db, "MssqlAdapter")) {
|
|
8
|
+
if (offset === undefined) {
|
|
9
|
+
// top(n) is inlined into the SQL, so only accept a whole number.
|
|
10
|
+
return limit === undefined ? qb : qb.top(wholeNumber(limit));
|
|
11
|
+
}
|
|
12
|
+
if (!ordered)
|
|
13
|
+
qb = qb.orderBy((0, engine_1.kysely)().sql `(select null)`);
|
|
14
|
+
qb = qb.offset(offset);
|
|
15
|
+
return limit === undefined ? qb : qb.fetch(limit);
|
|
16
|
+
}
|
|
17
|
+
if (limit !== undefined)
|
|
18
|
+
qb = qb.limit(limit);
|
|
19
|
+
if (offset !== undefined) {
|
|
20
|
+
if (limit === undefined)
|
|
21
|
+
qb = qb.limit(Number.MAX_SAFE_INTEGER);
|
|
22
|
+
qb = qb.offset(offset);
|
|
23
|
+
}
|
|
24
|
+
return qb;
|
|
25
|
+
}
|
|
26
|
+
function wholeNumber(value) {
|
|
27
|
+
if (!Number.isSafeInteger(value) || value < 0) {
|
|
28
|
+
throw new Error(`The limit must be a whole number, got ${value}.`);
|
|
29
|
+
}
|
|
30
|
+
return value;
|
|
31
|
+
}
|
|
32
|
+
//# sourceMappingURL=paging.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"paging.js","sourceRoot":"","sources":["../../src/orm/paging.ts"],"names":[],"mappings":";;AAyBA,kCAqBC;AA/BD,mCAAsC;AACtC,qCAAkC;AASlC,SAAgB,WAAW,CACzB,EAAe,EACf,EAAO,EACP,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAU;IAElC,IAAI,IAAA,mBAAW,EAAC,EAAE,EAAE,cAAc,CAAC,EAAE,CAAC;QACpC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,iEAAiE;YACjE,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,CAAC,OAAO;YAAE,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,IAAA,eAAM,GAAE,CAAC,GAAG,CAAA,eAAe,CAAC,CAAC;QAC3D,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACvB,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACpD,CAAC;IAED,IAAI,KAAK,KAAK,SAAS;QAAE,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC9C,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,IAAI,KAAK,KAAK,SAAS;YAAE,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;QAChE,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACzB,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,SAAS,WAAW,CAAC,KAAa;IAChC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;QAC9C,MAAM,IAAI,KAAK,CAAC,yCAAyC,KAAK,GAAG,CAAC,CAAC;IACrE,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}
|