@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/pivot.js
CHANGED
|
@@ -9,6 +9,7 @@ exports.PivotRelation = void 0;
|
|
|
9
9
|
*/
|
|
10
10
|
const casts_1 = require("./casts");
|
|
11
11
|
const connection_1 = require("./connection");
|
|
12
|
+
const naming_1 = require("./naming");
|
|
12
13
|
const query_1 = require("./query");
|
|
13
14
|
/**
|
|
14
15
|
* The pivot rows of one model's `belongsToMany` relation:
|
|
@@ -25,7 +26,7 @@ class PivotRelation {
|
|
|
25
26
|
return this.def.pivot;
|
|
26
27
|
}
|
|
27
28
|
parentKey() {
|
|
28
|
-
const key = this.parent[this.def.localKey];
|
|
29
|
+
const key = this.parent[(0, naming_1.propertyName)(this.parent.constructor, this.def.localKey)];
|
|
29
30
|
if (key === null || key === undefined) {
|
|
30
31
|
throw new Error(`[Megh ORM] Save the ${this.parent.constructor.name} before changing its "${this.pivot.table}" pivot rows.`);
|
|
31
32
|
}
|
|
@@ -33,7 +34,7 @@ class PivotRelation {
|
|
|
33
34
|
}
|
|
34
35
|
keyOf(ref) {
|
|
35
36
|
return ref !== null && typeof ref === "object"
|
|
36
|
-
? ref[this.pivot.relatedKey]
|
|
37
|
+
? ref[(0, naming_1.propertyName)(ref.constructor, this.pivot.relatedKey)]
|
|
37
38
|
: ref;
|
|
38
39
|
}
|
|
39
40
|
keysOf(refs) {
|
package/dist/orm/pivot.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"pivot.js","sourceRoot":"","sources":["../../src/orm/pivot.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,mCAA6C;AAC7C,6CAA+D;AAC/D,mCAA4C;AAO5C;;;GAGG;AACH,MAAa,aAAa;IAEL;IACA;IAFnB,YACmB,MAAW,EACX,GAAuB;QADvB,WAAM,GAAN,MAAM,CAAK;QACX,QAAG,GAAH,GAAG,CAAoB;IACvC,CAAC;IAEJ,IAAY,KAAK;QACf,OAAO,IAAI,CAAC,GAAG,CAAC,KAAM,CAAC;IACzB,CAAC;IAEO,SAAS;QACf,MAAM,GAAG,
|
|
1
|
+
{"version":3,"file":"pivot.js","sourceRoot":"","sources":["../../src/orm/pivot.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,mCAA6C;AAC7C,6CAA+D;AAC/D,qCAAwC;AACxC,mCAA4C;AAO5C;;;GAGG;AACH,MAAa,aAAa;IAEL;IACA;IAFnB,YACmB,MAAW,EACX,GAAuB;QADvB,WAAM,GAAN,MAAM,CAAK;QACX,QAAG,GAAH,GAAG,CAAoB;IACvC,CAAC;IAEJ,IAAY,KAAK;QACf,OAAO,IAAI,CAAC,GAAG,CAAC,KAAM,CAAC;IACzB,CAAC;IAEO,SAAS;QACf,MAAM,GAAG,GACP,IAAI,CAAC,MAAM,CAAC,IAAA,qBAAY,EAAC,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;QACxE,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CACb,uBAAuB,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,yBAAyB,IAAI,CAAC,KAAK,CAAC,KAAK,eAAe,CAC5G,CAAC;QACJ,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAEO,KAAK,CAAC,GAAe;QAC3B,OAAO,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ;YAC5C,CAAC,CAAE,GAAW,CAAC,IAAA,qBAAY,EAAC,GAAG,CAAC,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;YACpE,CAAC,CAAC,GAAG,CAAC;IACV,CAAC;IAEO,MAAM,CAAC,IAAwC;QACrD,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACzE,CAAC;IAED,qDAAqD;IACrD,KAAK,CAAC,GAAG;QACP,MAAM,MAAM,GAAQ,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC;QAC9D,MAAM,IAAA,yBAAiB,EACrB,IAAI,CAAC,GAAG,EACR,IAAI,CAAC,GAAG,CAAC,OAAO,EAA2B,EAC3C,CAAC,MAAM,CAAC,EACR,SAAS,EACT,EAAE,CACH,CAAC;QACF,OAAO,MAAM,CAAC,OAAO,CAAC;IACxB,CAAC;IAED,2EAA2E;IAC3E,KAAK,CAAC,MAAM,CACV,IAAwC,EACxC,aAA6B,EAAE;QAE/B,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC/B,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QAC9B,MAAM,EAAE,GAAG,IAAA,0BAAa,GAAE,CAAC;QAC3B,MAAM,MAAM,GAAG,IAAA,gBAAQ,EAAC,EAAE,CAAC,CAAC;QAC5B,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QACnC,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;YAC5B,MAAM,GAAG,GAA4B;gBACnC,GAAI,UAAsC;gBAC1C,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,SAAS;gBAChC,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE,GAAG;aAClC,CAAC;YACF,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC;gBAAE,GAAG,CAAC,CAAC,CAAC,GAAG,IAAA,gBAAQ,EAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YACvE,OAAO,GAAG,CAAC;QACb,CAAC,CAAC,CAAC;QACH,MAAM,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC;IAC/D,CAAC;IAED,kFAAkF;IAClF,KAAK,CAAC,MAAM,CAAC,IAAyC;QACpD,IAAI,EAAE,GAAQ,IAAA,0BAAa,GAAE;aAC1B,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;aAC5B,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;QACrD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAC/B,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO,CAAC,CAAC;YAChC,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QACxD,CAAC;QACD,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,gBAAgB,EAAE,CAAC;QAC3C,OAAO,MAAM,CAAC,MAAM,EAAE,cAAc,IAAI,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAI,CACR,IAA2B;QAE3B,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACjC,OAAO,IAAA,6BAAgB,EAAC,KAAK,IAAI,EAAE;YACjC,MAAM,OAAO,GAAc,CACzB,MAAM,IAAA,0BAAa,GAAE;iBAClB,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;iBAC5B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC;iBAClC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;iBACjD,OAAO,EAAE,CACb,CAAC,GAAG,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC;YAEjD,MAAM,GAAG,GAAG,CAAC,IAAe,EAAE,GAAY,EAAE,EAAE,CAC5C,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;YAC9C,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;YACxD,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;YACxD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC;gBAAE,MAAM,IAAI,CAAC,MAAM,CAAC,QAAwB,CAAC,CAAC;YACrE,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC;gBAAE,MAAM,IAAI,CAAC,MAAM,CAAC,QAAwB,CAAC,CAAC;YACrE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC;QAChC,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA1GD,sCA0GC"}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ormPlugin = void 0;
|
|
4
|
+
const core_1 = require("./core");
|
|
5
|
+
const config_1 = require("./config");
|
|
6
|
+
const connect_1 = require("./connect");
|
|
7
|
+
const connection_1 = require("./connection");
|
|
8
|
+
const naming_1 = require("./naming");
|
|
9
|
+
function isConfigClass(value) {
|
|
10
|
+
return typeof value === "function" && value.prototype instanceof core_1.MeghConfig;
|
|
11
|
+
}
|
|
12
|
+
function readEnv(ctx) {
|
|
13
|
+
const env = ctx.container.get(core_1.Environment);
|
|
14
|
+
return (key) => env.get(key);
|
|
15
|
+
}
|
|
16
|
+
let warnedUseDatabase = false;
|
|
17
|
+
exports.ormPlugin = (0, core_1.definePlugin)({
|
|
18
|
+
name: "@meghjs/orm",
|
|
19
|
+
register(ctx) {
|
|
20
|
+
ctx.extend("useMeghORM", (options) => {
|
|
21
|
+
const given = isConfigClass(options)
|
|
22
|
+
? ctx.container
|
|
23
|
+
.get(options)
|
|
24
|
+
.config(ctx.container.get(core_1.Environment))
|
|
25
|
+
: options;
|
|
26
|
+
const resolved = (0, config_1.resolveDatabaseOptions)(given, readEnv(ctx));
|
|
27
|
+
if (resolved.naming)
|
|
28
|
+
(0, naming_1.setNamingStrategy)(resolved.naming);
|
|
29
|
+
const db = (0, connect_1.createDatabase)(resolved);
|
|
30
|
+
(0, connection_1.setConnection)(db);
|
|
31
|
+
ctx.onInit(async () => {
|
|
32
|
+
await (0, connect_1.verifyConnection)(db, resolved);
|
|
33
|
+
ctx.logger.info(`Connected to ${(0, config_1.describeConnection)(resolved)}`);
|
|
34
|
+
});
|
|
35
|
+
ctx.onClose(() => db.destroy());
|
|
36
|
+
return ctx.app;
|
|
37
|
+
});
|
|
38
|
+
ctx.extend("useDatabase", (db) => {
|
|
39
|
+
if (!warnedUseDatabase) {
|
|
40
|
+
warnedUseDatabase = true;
|
|
41
|
+
ctx.logger.warn("app.useDatabase(kysely) is deprecated. Use app.useMeghORM({ dialect, url }); Megh creates the connection.");
|
|
42
|
+
}
|
|
43
|
+
(0, connection_1.setConnection)(db);
|
|
44
|
+
ctx.onClose(() => db.destroy());
|
|
45
|
+
return ctx.app;
|
|
46
|
+
});
|
|
47
|
+
},
|
|
48
|
+
});
|
|
49
|
+
exports.default = exports.ormPlugin;
|
|
50
|
+
//# sourceMappingURL=plugin.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../src/orm/plugin.ts"],"names":[],"mappings":";;;AAMA,iCAMgB;AAChB,qCAIkB;AAClB,uCAA6D;AAC7D,6CAA6C;AAC7C,qCAA6C;AAE7C,SAAS,aAAa,CAAC,KAAc;IACnC,OAAO,OAAO,KAAK,KAAK,UAAU,IAAI,KAAK,CAAC,SAAS,YAAY,iBAAU,CAAC;AAC9E,CAAC;AAED,SAAS,OAAO,CAAC,GAAkB;IACjC,MAAM,GAAG,GAAG,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,kBAAW,CAAC,CAAC;IAC3C,OAAO,CAAC,GAAW,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAqB,GAAG,CAAC,CAAC;AAC3D,CAAC;AAED,IAAI,iBAAiB,GAAG,KAAK,CAAC;AAEjB,QAAA,SAAS,GAAG,IAAA,mBAAY,EAAC;IACpC,IAAI,EAAE,aAAa;IACnB,QAAQ,CAAC,GAAG;QACV,GAAG,CAAC,MAAM,CACR,YAAY,EACZ,CAAC,OAA4D,EAAE,EAAE;YAC/D,MAAM,KAAK,GAAG,aAAa,CAAC,OAAO,CAAC;gBAClC,CAAC,CAAC,GAAG,CAAC,SAAS;qBACV,GAAG,CAA8B,OAAO,CAAC;qBACzC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,kBAAW,CAAC,CAAC;gBAC3C,CAAC,CAAC,OAAO,CAAC;YACZ,MAAM,QAAQ,GAAG,IAAA,+BAAsB,EAAC,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;YAC7D,IAAI,QAAQ,CAAC,MAAM;gBAAE,IAAA,0BAAiB,EAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACxD,MAAM,EAAE,GAAG,IAAA,wBAAc,EAAC,QAAQ,CAAC,CAAC;YACpC,IAAA,0BAAa,EAAC,EAAE,CAAC,CAAC;YAClB,GAAG,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE;gBACpB,MAAM,IAAA,0BAAgB,EAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;gBACrC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,IAAA,2BAAkB,EAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YAClE,CAAC,CAAC,CAAC;YACH,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAChC,OAAO,GAAG,CAAC,GAAG,CAAC;QACjB,CAAC,CACF,CAAC;QAEF,GAAG,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC,EAAe,EAAE,EAAE;YAC5C,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBACvB,iBAAiB,GAAG,IAAI,CAAC;gBACzB,GAAG,CAAC,MAAM,CAAC,IAAI,CACb,2GAA2G,CAC5G,CAAC;YACJ,CAAC;YACD,IAAA,0BAAa,EAAC,EAAE,CAAC,CAAC;YAClB,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAChC,OAAO,GAAG,CAAC,GAAG,CAAC;QACjB,CAAC,CAAC,CAAC;IACL,CAAC;CACF,CAAC,CAAC;AAEH,kBAAe,iBAAS,CAAC"}
|
package/dist/orm/query.d.ts
CHANGED
|
@@ -5,16 +5,68 @@
|
|
|
5
5
|
* @url https://github.com/xtareq
|
|
6
6
|
*/
|
|
7
7
|
import type { ComparisonOperatorExpression, Expression, ExpressionBuilder, SqlBool } from "kysely";
|
|
8
|
-
import { type PageRequest, type Paginated } from "
|
|
8
|
+
import { type PageRequest, type Paginated } from "./core";
|
|
9
9
|
import { type RelationDefinition } from "./relations";
|
|
10
|
-
import type { ColumnKeys, Columns, ModelClass, RelationPaths, Row, UpdateInput } from "./types";
|
|
10
|
+
import type { ColumnKeys, Columns, ModelClass, RelatedModel, RelationKeys, RelationPaths, Row, UpdateInput } from "./types";
|
|
11
11
|
export type ComparisonOperator = ComparisonOperatorExpression;
|
|
12
|
+
/** The model at the end of a relation path: `ModelAt<User, "posts.comments">` is `Comment`. */
|
|
13
|
+
export type ModelAt<M, P extends string> = P extends `${infer H}.${infer R}` ? ModelAt<RelatedModel<M[H & keyof M]>, R> : RelatedModel<M[P & keyof M]>;
|
|
14
|
+
/** Narrows a related query, e.g. in `whereHas("posts", q => q.where("published", 1))`. */
|
|
15
|
+
export type RelationConstraint<R> = (query: ModelQuery<R>) => unknown;
|
|
16
|
+
/**
|
|
17
|
+
* A reusable query fragment, applied with `scope()`:
|
|
18
|
+
*
|
|
19
|
+
* ```ts
|
|
20
|
+
* const published: Scope<Post> = (q) => q.whereNotNull("published_at");
|
|
21
|
+
* const by: Scope<Post, [number]> = (q, userId) => q.where("user_id", userId);
|
|
22
|
+
*
|
|
23
|
+
* await Post.scope(published).scope(by, 1).get();
|
|
24
|
+
* ```
|
|
25
|
+
*/
|
|
26
|
+
export type Scope<M, A extends unknown[] = []> = (query: ModelQuery<M, any, any, any>, ...args: A) => unknown;
|
|
27
|
+
/** `withCount("posts")` adds `posts_count`. */
|
|
28
|
+
export type Counted<N extends string> = {
|
|
29
|
+
readonly [K in N as `${K}_count`]: number;
|
|
30
|
+
};
|
|
31
|
+
/** Result of {@link ModelQuery.simplePaginate}: no total, so no `lastPage`. */
|
|
32
|
+
export interface SimplePaginated<T> {
|
|
33
|
+
data: T[];
|
|
34
|
+
meta: {
|
|
35
|
+
page: number;
|
|
36
|
+
perPage: number;
|
|
37
|
+
hasMore: boolean;
|
|
38
|
+
next: number | null;
|
|
39
|
+
prev: number | null;
|
|
40
|
+
};
|
|
41
|
+
}
|
|
42
|
+
/** Request for {@link ModelQuery.cursorPaginate}. */
|
|
43
|
+
export interface CursorPageRequest<K extends string = string> {
|
|
44
|
+
/** `meta.nextCursor` from the previous page; omit for the first page. */
|
|
45
|
+
cursor?: string | null;
|
|
46
|
+
/** Items per page. Defaults to 10. */
|
|
47
|
+
perPage?: number;
|
|
48
|
+
/** Column to page by. Must be unique and sortable. Defaults to the primary key. */
|
|
49
|
+
column?: K;
|
|
50
|
+
direction?: "asc" | "desc";
|
|
51
|
+
}
|
|
52
|
+
/** Result of {@link ModelQuery.cursorPaginate}. */
|
|
53
|
+
export interface CursorPaginated<T> {
|
|
54
|
+
data: T[];
|
|
55
|
+
meta: {
|
|
56
|
+
perPage: number;
|
|
57
|
+
hasMore: boolean;
|
|
58
|
+
/** Pass as `cursor` to get the next page; `null` on the last page. */
|
|
59
|
+
nextCursor: string | null;
|
|
60
|
+
};
|
|
61
|
+
}
|
|
12
62
|
/**
|
|
13
63
|
* A query on one model, e.g. `User.where("active", true).with("posts").get()`.
|
|
14
64
|
* Nothing runs until `get()`, `first()`, `count()`, `paginate()`, `update()`
|
|
15
65
|
* or `delete()` is called. Results are model instances.
|
|
16
66
|
*/
|
|
17
|
-
export declare class ModelQuery<M, P extends string = never, S extends ColumnKeys<M> = ColumnKeys<M
|
|
67
|
+
export declare class ModelQuery<M, P extends string = never, S extends ColumnKeys<M> = ColumnKeys<M>,
|
|
68
|
+
/** Extra fields on each result, such as `withCount()` counts. */
|
|
69
|
+
X extends object = {}> {
|
|
18
70
|
private readonly model;
|
|
19
71
|
private filters;
|
|
20
72
|
private ordering;
|
|
@@ -22,6 +74,7 @@ export declare class ModelQuery<M, P extends string = never, S extends ColumnKey
|
|
|
22
74
|
private offsetCount?;
|
|
23
75
|
private eager;
|
|
24
76
|
private selected?;
|
|
77
|
+
private counts;
|
|
25
78
|
private trashed;
|
|
26
79
|
constructor(model: ModelClass<M>);
|
|
27
80
|
/** `where(column, value)`: equality; `null` becomes `IS NULL`. */
|
|
@@ -37,6 +90,25 @@ export declare class ModelQuery<M, P extends string = never, S extends ColumnKey
|
|
|
37
90
|
whereNotIn<K extends keyof Columns<M> & string>(column: K, values: readonly Columns<M>[K][]): this;
|
|
38
91
|
whereNull(column: keyof Columns<M> & string): this;
|
|
39
92
|
whereNotNull(column: keyof Columns<M> & string): this;
|
|
93
|
+
/**
|
|
94
|
+
* Rows with at least one related row (matching `constrain`, if given).
|
|
95
|
+
* Follows dotted paths:
|
|
96
|
+
* `whereHas("posts.comments", q => q.where("body", "like", "%hi%"))`.
|
|
97
|
+
* Runs as an `EXISTS` subquery.
|
|
98
|
+
*/
|
|
99
|
+
whereHas<Q extends RelationPaths<M>>(relation: Q, constrain?: RelationConstraint<ModelAt<M, Q>>): this;
|
|
100
|
+
/** Rows with no related row (matching `constrain`, if given). The inverse of {@link whereHas}. */
|
|
101
|
+
whereDoesntHave<Q extends RelationPaths<M>>(relation: Q, constrain?: RelationConstraint<ModelAt<M, Q>>): this;
|
|
102
|
+
private whereRelation;
|
|
103
|
+
/**
|
|
104
|
+
* Add `<relation>_count` to each result: `withCount("posts", "comments")`,
|
|
105
|
+
* or one relation narrowed by a constraint:
|
|
106
|
+
* `withCount("posts", q => q.where("published", 1))`.
|
|
107
|
+
*/
|
|
108
|
+
withCount<N extends RelationKeys<M>>(...relations: N[]): ModelQuery<M, P, S, X & Counted<N>>;
|
|
109
|
+
withCount<N extends RelationKeys<M>>(relation: N, constrain: RelationConstraint<RelatedModel<M[N]>>): ModelQuery<M, P, S, X & Counted<N>>;
|
|
110
|
+
/** Apply a reusable {@link Scope}: `Post.query().scope(byAuthor, 1)`. */
|
|
111
|
+
scope<A extends unknown[]>(scope: Scope<M, A>, ...args: A): this;
|
|
40
112
|
orderBy(column: keyof Columns<M> & string, direction?: "asc" | "desc"): this;
|
|
41
113
|
/** Include soft-deleted rows. */
|
|
42
114
|
withTrashed(): this;
|
|
@@ -45,20 +117,48 @@ export declare class ModelQuery<M, P extends string = never, S extends ColumnKey
|
|
|
45
117
|
limit(count: number): this;
|
|
46
118
|
offset(count: number): this;
|
|
47
119
|
/** Only fetch these columns. The result type narrows to them. */
|
|
48
|
-
select<K extends keyof Columns<M> & string>(...columns: K[]): ModelQuery<M, P, K>;
|
|
120
|
+
select<K extends keyof Columns<M> & string>(...columns: K[]): ModelQuery<M, P, K, X>;
|
|
49
121
|
/**
|
|
50
122
|
* Eager-load relations, nested with dots: `with("posts.comments", "profile")`.
|
|
51
123
|
* Runs one query per relation level, however many rows there are.
|
|
52
124
|
*/
|
|
53
|
-
with<Q extends RelationPaths<M>>(...paths: Q[]): ModelQuery<M, P | Q, S>;
|
|
54
|
-
get(): Promise<Row<M, P, S>[]>;
|
|
55
|
-
first(): Promise<Row<M, P, S> | undefined>;
|
|
125
|
+
with<Q extends RelationPaths<M>>(...paths: Q[]): ModelQuery<M, P | Q, S, X>;
|
|
126
|
+
get(): Promise<(Row<M, P, S> & X)[]>;
|
|
127
|
+
first(): Promise<(Row<M, P, S> & X) | undefined>;
|
|
56
128
|
/** Like {@link first}, but throws a 404 `NotFoundException` when nothing matches. */
|
|
57
|
-
firstOrFail(): Promise<Row<M, P, S
|
|
129
|
+
firstOrFail(): Promise<Row<M, P, S> & X>;
|
|
58
130
|
count(): Promise<number>;
|
|
59
131
|
exists(): Promise<boolean>;
|
|
60
132
|
/** One page of results in the unified `{ data, meta }` shape. */
|
|
61
|
-
paginate(request?: PageRequest): Promise<Paginated<Row<M, P, S
|
|
133
|
+
paginate(request?: PageRequest): Promise<Paginated<Row<M, P, S> & X>>;
|
|
134
|
+
/**
|
|
135
|
+
* A page of results without counting the total, for large tables or
|
|
136
|
+
* "load more" lists: fetches one extra row to tell whether there is a
|
|
137
|
+
* next page.
|
|
138
|
+
*/
|
|
139
|
+
simplePaginate(request?: PageRequest): Promise<SimplePaginated<Row<M, P, S> & X>>;
|
|
140
|
+
/**
|
|
141
|
+
* Keyset ("cursor") pagination: stable under inserts and fast at any depth.
|
|
142
|
+
* Orders by `column` (default: the primary key, which should be unique)
|
|
143
|
+
* before any other `orderBy()`. Pass `meta.nextCursor` back as `cursor`
|
|
144
|
+
* for the next page.
|
|
145
|
+
*
|
|
146
|
+
* ```ts
|
|
147
|
+
* const first = await Post.query().cursorPaginate({ perPage: 20 });
|
|
148
|
+
* const second = await Post.query().cursorPaginate({ perPage: 20, cursor: first.meta.nextCursor });
|
|
149
|
+
* ```
|
|
150
|
+
*/
|
|
151
|
+
cursorPaginate(request?: CursorPageRequest<keyof Columns<M> & string>): Promise<CursorPaginated<Row<M, P, S> & X>>;
|
|
152
|
+
/** Sum of `column` over matching rows; `0` when none match. */
|
|
153
|
+
sum(column: keyof Columns<M> & string): Promise<number>;
|
|
154
|
+
/** Average of `column` over matching rows; `null` when none match. */
|
|
155
|
+
avg(column: keyof Columns<M> & string): Promise<number | null>;
|
|
156
|
+
/** Smallest value of `column` (with its cast applied); `null` when none match. */
|
|
157
|
+
min<K extends keyof Columns<M> & string>(column: K): Promise<Columns<M>[K] | null>;
|
|
158
|
+
/** Largest value of `column` (with its cast applied); `null` when none match. */
|
|
159
|
+
max<K extends keyof Columns<M> & string>(column: K): Promise<Columns<M>[K] | null>;
|
|
160
|
+
private aggregate;
|
|
161
|
+
private castAggregate;
|
|
62
162
|
/**
|
|
63
163
|
* Update every matching row (and `updated_at` when the model has
|
|
64
164
|
* timestamps). Returns the number of rows updated.
|
|
@@ -73,11 +173,26 @@ export declare class ModelQuery<M, P extends string = never, S extends ColumnKey
|
|
|
73
173
|
forceDelete(): Promise<number>;
|
|
74
174
|
/** Restore matching soft-deleted rows. Returns the number restored. */
|
|
75
175
|
restore(): Promise<number>;
|
|
76
|
-
clone(): ModelQuery<M, P, S>;
|
|
176
|
+
clone(): ModelQuery<M, P, S, X>;
|
|
177
|
+
/** The column for a property of this query's model. */
|
|
178
|
+
private col;
|
|
179
|
+
private context;
|
|
77
180
|
private applyFilters;
|
|
181
|
+
/**
|
|
182
|
+
* `from <related> where <related row belongs to the outer row>`, plus the
|
|
183
|
+
* related query's filters (from `constrain`) and soft-delete scope. The
|
|
184
|
+
* caller adds the select list. The related table is aliased, so
|
|
185
|
+
* self-referencing relations work.
|
|
186
|
+
*/
|
|
187
|
+
private relationSubquery;
|
|
78
188
|
/** Selected columns plus the keys eager loading needs, or `undefined` for all. */
|
|
79
189
|
private selectedColumns;
|
|
80
190
|
}
|
|
81
191
|
/** Many-to-many: one join query through the pivot table per level. */
|
|
82
192
|
export declare function loadBelongsToMany(def: RelationDefinition, related: ModelClass, parents: any[], name: string, nested: string[]): Promise<void>;
|
|
193
|
+
/**
|
|
194
|
+
* Set a computed value (pivot row, relation count) on a model instance. Not
|
|
195
|
+
* enumerable, so `save()` never writes it as a column; `toJSON()` includes it.
|
|
196
|
+
*/
|
|
197
|
+
export declare function defineExtra(instance: object, key: string, value: unknown): void;
|
|
83
198
|
export declare function assertSoftDeletes(cls: ModelClass): void;
|