@meghjs/core 0.5.1 → 0.5.3
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 +31 -32
- package/dist/collection/pagination.d.ts +9 -0
- package/dist/collection/pagination.js +11 -1
- package/dist/collection/pagination.js.map +1 -1
- package/dist/core/application.js +23 -2
- package/dist/core/application.js.map +1 -1
- package/dist/core/router.js +40 -4
- package/dist/core/router.js.map +1 -1
- package/dist/openapi/branding.d.ts +1 -1
- package/dist/openapi/branding.js.map +1 -1
- package/dist/openapi/index.d.ts +1 -0
- package/dist/openapi/index.js +4 -0
- package/dist/openapi/index.js.map +1 -1
- package/dist/openapi/openapi.d.ts +122 -21
- package/dist/openapi/openapi.js.map +1 -1
- package/dist/openapi/responses.d.ts +89 -0
- package/dist/openapi/responses.js +275 -0
- package/dist/openapi/responses.js.map +1 -0
- package/dist/openapi/swagger-schema.d.ts +5 -0
- package/dist/openapi/swagger-schema.js +5 -0
- package/dist/openapi/swagger-schema.js.map +1 -1
- package/dist/orm/connect.d.ts +12 -1
- package/dist/orm/connect.js +72 -1
- package/dist/orm/connect.js.map +1 -1
- package/dist/orm/connection.d.ts +7 -0
- package/dist/orm/connection.js +27 -3
- package/dist/orm/connection.js.map +1 -1
- package/dist/orm/core.d.ts +2 -0
- package/dist/orm/core.js +3 -1
- package/dist/orm/core.js.map +1 -1
- package/dist/orm/db.js +15 -10
- package/dist/orm/db.js.map +1 -1
- package/dist/orm/decorators.d.ts +4 -4
- package/dist/orm/decorators.js +3 -3
- package/dist/orm/decorators.js.map +1 -1
- package/dist/orm/factories.d.ts +59 -0
- package/dist/orm/factories.js +145 -0
- package/dist/orm/factories.js.map +1 -0
- package/dist/orm/index.d.ts +3 -0
- package/dist/orm/index.js +16 -1
- package/dist/orm/index.js.map +1 -1
- package/dist/orm/migrations.d.ts +6 -0
- package/dist/orm/migrations.js +1 -0
- package/dist/orm/migrations.js.map +1 -1
- package/dist/orm/model.d.ts +2 -8
- package/dist/orm/model.js.map +1 -1
- package/dist/orm/openapi.d.ts +8 -0
- package/dist/orm/openapi.js +75 -0
- package/dist/orm/openapi.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/query.js +8 -9
- package/dist/orm/query.js.map +1 -1
- package/dist/orm/schema.d.ts +2 -0
- package/dist/orm/schema.js +21 -0
- package/dist/orm/schema.js.map +1 -1
- package/dist/orm/seeders.d.ts +66 -0
- package/dist/orm/seeders.js +173 -0
- package/dist/orm/seeders.js.map +1 -0
- package/dist/orm/state.d.ts +2 -2
- package/dist/orm/state.js +13 -3
- package/dist/orm/state.js.map +1 -1
- package/dist/orm/types.d.ts +39 -15
- package/package.json +11 -2
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Factory = void 0;
|
|
4
|
+
exports.useFaker = useFaker;
|
|
5
|
+
exports.getFaker = getFaker;
|
|
6
|
+
exports.defineFactory = defineFactory;
|
|
7
|
+
/**
|
|
8
|
+
* Model factories: build and save model rows with fake data, for seeders and
|
|
9
|
+
* tests. Fake values come from Faker (`@faker-js/faker`, installed by the app).
|
|
10
|
+
*
|
|
11
|
+
* ```ts
|
|
12
|
+
* export const UserFactory = defineFactory(User, ({ faker }) => ({
|
|
13
|
+
* name: faker.person.fullName(),
|
|
14
|
+
* email: faker.internet.email(),
|
|
15
|
+
* role_id: RoleFactory, // creates a role and uses its id
|
|
16
|
+
* }));
|
|
17
|
+
*
|
|
18
|
+
* await UserFactory.createMany(10);
|
|
19
|
+
* await UserFactory.state({ is_active: false }).create({ name: "Ann" });
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
const node_url_1 = require("node:url");
|
|
23
|
+
const core_1 = require("./core");
|
|
24
|
+
// A real dynamic import: TypeScript compiles `import()` to `require()` in
|
|
25
|
+
// CommonJS output, which cannot load ES modules on older Node versions.
|
|
26
|
+
const nativeImport = new Function("url", "return import(url)");
|
|
27
|
+
let fakerInstance;
|
|
28
|
+
let fakerLoading;
|
|
29
|
+
/**
|
|
30
|
+
* Use this Faker instance in factories instead of the default English one,
|
|
31
|
+
* e.g. a locale (`fakerDE`) or one with a fixed seed.
|
|
32
|
+
*/
|
|
33
|
+
function useFaker(faker) {
|
|
34
|
+
fakerInstance = faker;
|
|
35
|
+
}
|
|
36
|
+
/** The Faker instance factories use, loaded from the app on first use. */
|
|
37
|
+
function getFaker() {
|
|
38
|
+
if (fakerInstance)
|
|
39
|
+
return Promise.resolve(fakerInstance);
|
|
40
|
+
fakerLoading ??= loadFaker().then((faker) => (fakerInstance = faker), (error) => {
|
|
41
|
+
fakerLoading = undefined; // try again after it is installed
|
|
42
|
+
throw error;
|
|
43
|
+
});
|
|
44
|
+
return fakerLoading;
|
|
45
|
+
}
|
|
46
|
+
async function loadFaker() {
|
|
47
|
+
let mod;
|
|
48
|
+
try {
|
|
49
|
+
// Node 22.12+ can require() Faker's ES modules.
|
|
50
|
+
mod = (0, core_1.loadPackageFromClient)("@faker-js/faker");
|
|
51
|
+
}
|
|
52
|
+
catch {
|
|
53
|
+
try {
|
|
54
|
+
const file = require.resolve("@faker-js/faker", {
|
|
55
|
+
paths: [process.cwd()],
|
|
56
|
+
});
|
|
57
|
+
mod = await nativeImport((0, node_url_1.pathToFileURL)(file).href);
|
|
58
|
+
}
|
|
59
|
+
catch {
|
|
60
|
+
throw new Error("[Megh ORM] Factories use Faker for fake values. Install it: npm install -D @faker-js/faker");
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
const faker = mod?.faker ?? mod?.default?.faker;
|
|
64
|
+
if (!faker)
|
|
65
|
+
throw new Error("[Megh ORM] @faker-js/faker has no `faker` export; upgrade it.");
|
|
66
|
+
return faker;
|
|
67
|
+
}
|
|
68
|
+
/** Builds rows of one model. Every method returns a new factory or a promise. */
|
|
69
|
+
class Factory {
|
|
70
|
+
model;
|
|
71
|
+
definition;
|
|
72
|
+
states;
|
|
73
|
+
counter;
|
|
74
|
+
constructor(model, definition, states = [],
|
|
75
|
+
// Shared by the factories `state()` derives, so sequences don't repeat.
|
|
76
|
+
counter = { value: 0 }) {
|
|
77
|
+
this.model = model;
|
|
78
|
+
this.definition = definition;
|
|
79
|
+
this.states = states;
|
|
80
|
+
this.counter = counter;
|
|
81
|
+
}
|
|
82
|
+
/** A factory that also applies these values (or a function returning them). */
|
|
83
|
+
state(values) {
|
|
84
|
+
return new Factory(this.model, this.definition, [...this.states, values], this.counter);
|
|
85
|
+
}
|
|
86
|
+
/** Start `sequence` from 1 again. */
|
|
87
|
+
resetSequence() {
|
|
88
|
+
this.counter.value = 0;
|
|
89
|
+
return this;
|
|
90
|
+
}
|
|
91
|
+
/**
|
|
92
|
+
* The column values for one row, without saving it. Values that are
|
|
93
|
+
* factories are created, so their keys are real.
|
|
94
|
+
*/
|
|
95
|
+
async raw(overrides) {
|
|
96
|
+
const context = {
|
|
97
|
+
faker: await getFaker(),
|
|
98
|
+
sequence: ++this.counter.value,
|
|
99
|
+
};
|
|
100
|
+
const values = { ...this.definition(context) };
|
|
101
|
+
for (const state of [...this.states, ...(overrides ? [overrides] : [])]) {
|
|
102
|
+
Object.assign(values, typeof state === "function" ? state(context) : state);
|
|
103
|
+
}
|
|
104
|
+
for (const [key, value] of Object.entries(values)) {
|
|
105
|
+
if (value instanceof Factory) {
|
|
106
|
+
const parent = await value.create();
|
|
107
|
+
values[key] = parent[value.model.primaryKey];
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
return values;
|
|
111
|
+
}
|
|
112
|
+
/** A model instance with the values, not saved: call `save()` to insert it. */
|
|
113
|
+
async make(overrides) {
|
|
114
|
+
const instance = new this.model();
|
|
115
|
+
instance.fill(await this.raw(overrides));
|
|
116
|
+
return instance;
|
|
117
|
+
}
|
|
118
|
+
/** `count` unsaved model instances. */
|
|
119
|
+
async makeMany(count, overrides) {
|
|
120
|
+
const out = [];
|
|
121
|
+
for (let i = 0; i < count; i++)
|
|
122
|
+
out.push(await this.make(overrides));
|
|
123
|
+
return out;
|
|
124
|
+
}
|
|
125
|
+
/** Insert one row and return it. */
|
|
126
|
+
async create(overrides) {
|
|
127
|
+
return this.model.create(await this.raw(overrides));
|
|
128
|
+
}
|
|
129
|
+
/** Insert `count` rows, one by one (each with its own fake values), and return them. */
|
|
130
|
+
async createMany(count, overrides) {
|
|
131
|
+
const out = [];
|
|
132
|
+
for (let i = 0; i < count; i++)
|
|
133
|
+
out.push(await this.create(overrides));
|
|
134
|
+
return out;
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
exports.Factory = Factory;
|
|
138
|
+
/**
|
|
139
|
+
* Define a factory for a model. The definition returns fake column values;
|
|
140
|
+
* `state()` and the `overrides` of `make()` / `create()` replace them.
|
|
141
|
+
*/
|
|
142
|
+
function defineFactory(model, definition) {
|
|
143
|
+
return new Factory(model, definition);
|
|
144
|
+
}
|
|
145
|
+
//# sourceMappingURL=factories.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"factories.js","sourceRoot":"","sources":["../../src/orm/factories.ts"],"names":[],"mappings":";;;AAuDA,4BAEC;AAGD,4BAUC;AAkHD,sCAKC;AA7LD;;;;;;;;;;;;;;GAcG;AACH,uCAAyC;AAEzC,iCAA+C;AAyB/C,0EAA0E;AAC1E,wEAAwE;AACxE,MAAM,YAAY,GAAG,IAAI,QAAQ,CAAC,KAAK,EAAE,oBAAoB,CAE5C,CAAC;AAElB,IAAI,aAAgC,CAAC;AACrC,IAAI,YAAwC,CAAC;AAE7C;;;GAGG;AACH,SAAgB,QAAQ,CAAC,KAAY;IACnC,aAAa,GAAG,KAAK,CAAC;AACxB,CAAC;AAED,0EAA0E;AAC1E,SAAgB,QAAQ;IACtB,IAAI,aAAa;QAAE,OAAO,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IACzD,YAAY,KAAK,SAAS,EAAE,CAAC,IAAI,CAC/B,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,aAAa,GAAG,KAAK,CAAC,EAClC,CAAC,KAAK,EAAE,EAAE;QACR,YAAY,GAAG,SAAS,CAAC,CAAC,kCAAkC;QAC5D,MAAM,KAAK,CAAC;IACd,CAAC,CACF,CAAC;IACF,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,KAAK,UAAU,SAAS;IACtB,IAAI,GAAQ,CAAC;IACb,IAAI,CAAC;QACH,gDAAgD;QAChD,GAAG,GAAG,IAAA,4BAAqB,EAAC,iBAAiB,CAAC,CAAC;IACjD,CAAC;IAAC,MAAM,CAAC;QACP,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,iBAAiB,EAAE;gBAC9C,KAAK,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;aACvB,CAAC,CAAC;YACH,GAAG,GAAG,MAAM,YAAY,CAAC,IAAA,wBAAa,EAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC;QACrD,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,KAAK,CACb,4FAA4F,CAC7F,CAAC;QACJ,CAAC;IACH,CAAC;IACD,MAAM,KAAK,GAAG,GAAG,EAAE,KAAK,IAAI,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC;IAChD,IAAI,CAAC,KAAK;QACR,MAAM,IAAI,KAAK,CACb,+DAA+D,CAChE,CAAC;IACJ,OAAO,KAAK,CAAC;AACf,CAAC;AAED,iFAAiF;AACjF,MAAa,OAAO;IAEP;IACQ;IAGA;IAEA;IAPnB,YACW,KAAQ,EACA,UAEQ,EACR,SAAsB,EAAE;IACzC,wEAAwE;IACvD,UAA6B,EAAE,KAAK,EAAE,CAAC,EAAE;QANjD,UAAK,GAAL,KAAK,CAAG;QACA,eAAU,GAAV,UAAU,CAEF;QACR,WAAM,GAAN,MAAM,CAAkB;QAExB,YAAO,GAAP,OAAO,CAAkC;IACzD,CAAC;IAEJ,+EAA+E;IAC/E,KAAK,CAAC,MAAiB;QACrB,OAAO,IAAI,OAAO,CAChB,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,UAAU,EACf,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,EACxB,IAAI,CAAC,OAAO,CACb,CAAC;IACJ,CAAC;IAED,qCAAqC;IACrC,aAAa;QACX,IAAI,CAAC,OAAO,CAAC,KAAK,GAAG,CAAC,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,GAAG,CAAC,SAAqB;QAC7B,MAAM,OAAO,GAAmB;YAC9B,KAAK,EAAE,MAAM,QAAQ,EAAE;YACvB,QAAQ,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK;SAC/B,CAAC;QACF,MAAM,MAAM,GAA4B,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QACxE,KAAK,MAAM,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;YACxE,MAAM,CAAC,MAAM,CACX,MAAM,EACN,OAAO,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CACrD,CAAC;QACJ,CAAC;QACD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAClD,IAAI,KAAK,YAAY,OAAO,EAAE,CAAC;gBAC7B,MAAM,MAAM,GAAQ,MAAM,KAAK,CAAC,MAAM,EAAE,CAAC;gBACzC,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;YAC/C,CAAC;QACH,CAAC;QACD,OAAO,MAAiC,CAAC;IAC3C,CAAC;IAED,+EAA+E;IAC/E,KAAK,CAAC,IAAI,CAAC,SAAqB;QAC9B,MAAM,QAAQ,GAAG,IAAI,IAAI,CAAC,KAAK,EAAc,CAAC;QAC7C,QAAgB,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;QAClD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,uCAAuC;IACvC,KAAK,CAAC,QAAQ,CAAC,KAAa,EAAE,SAAqB;QACjD,MAAM,GAAG,GAAe,EAAE,CAAC;QAC3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE;YAAE,GAAG,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;QACrE,OAAO,GAAG,CAAC;IACb,CAAC;IAED,oCAAoC;IACpC,KAAK,CAAC,MAAM,CAAC,SAAqB;QAChC,OAAQ,IAAI,CAAC,KAAa,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;IAC/D,CAAC;IAED,wFAAwF;IACxF,KAAK,CAAC,UAAU,CACd,KAAa,EACb,SAAqB;QAErB,MAAM,GAAG,GAAoB,EAAE,CAAC;QAChC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE;YAAE,GAAG,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;QACvE,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AAhFD,0BAgFC;AAED;;;GAGG;AACH,SAAgB,aAAa,CAC3B,KAAQ,EACR,UAA6D;IAE7D,OAAO,IAAI,OAAO,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;AACxC,CAAC"}
|
package/dist/orm/index.d.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
export { Model } from "./model";
|
|
2
|
+
export { modelSchema } from "./openapi";
|
|
2
3
|
export { ModelQuery, type ComparisonOperator, type Counted, type CursorPageRequest, type CursorPaginated, type ModelAt, type RelationConstraint, type Scope, type SimplePaginated, } from "./query";
|
|
3
4
|
export { HasRelation } from "./has-relation";
|
|
4
5
|
export { hasMany, hasOne, belongsTo, belongsToMany, type BelongsToManyOptions, } from "./relations";
|
|
@@ -8,6 +9,8 @@ export { PivotRelation, type RelatedRef } from "./pivot";
|
|
|
8
9
|
export type { Cast, CustomCast } from "./casts";
|
|
9
10
|
export type { Columns, ColumnKeys, RelationKeys, RelationPaths, BelongsToManyKeys, HasRelationKeys, PivotOf, TimestampKeys, Row, ModelClass, CreateInput, UpdateInput, PrimaryKeyValue, TableOf, DatabaseOf, } from "./types";
|
|
10
11
|
export { Migrations, MigrationError, defineMigration, type SchemaMigration, readMigrationFolder, type Migration, type MigrationsOptions, type MigrationStatus, } from "./migrations";
|
|
12
|
+
export { Seeders, SeedError, defineSeeder, readSeederFolder, seederName, ENTRY_SEEDER, type Seeder, type SeedContext, type SeedersOptions, } from "./seeders";
|
|
13
|
+
export { Factory, defineFactory, getFaker, useFaker, type FactoryAttributes, type FactoryContext, } from "./factories";
|
|
11
14
|
export { ormPlugin } from "./plugin";
|
|
12
15
|
export { DatabaseConfigError, resolveDatabaseOptions, type DatabaseOptions, type Dialect, type PoolOptions, type ResolvedDatabaseOptions, } from "./config";
|
|
13
16
|
export { createDatabase } from "./connect";
|
package/dist/orm/index.js
CHANGED
|
@@ -1,8 +1,11 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.
|
|
3
|
+
exports.WhereGroup = exports.WhereClauses = exports.TableQuery = exports.DB = exports.SchemaError = exports.ForeignKeyDefinition = exports.ColumnDefinition = exports.Blueprint = exports.Schema = exports.createDatabase = exports.resolveDatabaseOptions = exports.DatabaseConfigError = exports.ormPlugin = exports.useFaker = exports.getFaker = exports.defineFactory = exports.Factory = exports.ENTRY_SEEDER = exports.seederName = exports.readSeederFolder = exports.defineSeeder = exports.SeedError = exports.Seeders = exports.readMigrationFolder = exports.defineMigration = exports.MigrationError = exports.Migrations = exports.PivotRelation = exports.ORM_CONNECTION = exports.getModelMetadata = exports.BelongsToMany = exports.BelongsTo = exports.HasOne = exports.HasMany = exports.DeletedAt = exports.UpdatedAt = exports.CreatedAt = exports.Identity = exports.AutoIncrement = exports.PrimaryKey = exports.Column = exports.Table = exports.belongsToMany = exports.belongsTo = exports.hasOne = exports.hasMany = exports.HasRelation = exports.ModelQuery = exports.modelSchema = exports.Model = void 0;
|
|
4
|
+
exports.getNamingStrategy = exports.setNamingStrategy = void 0;
|
|
4
5
|
var model_1 = require("./model");
|
|
5
6
|
Object.defineProperty(exports, "Model", { enumerable: true, get: function () { return model_1.Model; } });
|
|
7
|
+
var openapi_1 = require("./openapi");
|
|
8
|
+
Object.defineProperty(exports, "modelSchema", { enumerable: true, get: function () { return openapi_1.modelSchema; } });
|
|
6
9
|
var query_1 = require("./query");
|
|
7
10
|
Object.defineProperty(exports, "ModelQuery", { enumerable: true, get: function () { return query_1.ModelQuery; } });
|
|
8
11
|
var has_relation_1 = require("./has-relation");
|
|
@@ -37,6 +40,18 @@ Object.defineProperty(exports, "Migrations", { enumerable: true, get: function (
|
|
|
37
40
|
Object.defineProperty(exports, "MigrationError", { enumerable: true, get: function () { return migrations_1.MigrationError; } });
|
|
38
41
|
Object.defineProperty(exports, "defineMigration", { enumerable: true, get: function () { return migrations_1.defineMigration; } });
|
|
39
42
|
Object.defineProperty(exports, "readMigrationFolder", { enumerable: true, get: function () { return migrations_1.readMigrationFolder; } });
|
|
43
|
+
var seeders_1 = require("./seeders");
|
|
44
|
+
Object.defineProperty(exports, "Seeders", { enumerable: true, get: function () { return seeders_1.Seeders; } });
|
|
45
|
+
Object.defineProperty(exports, "SeedError", { enumerable: true, get: function () { return seeders_1.SeedError; } });
|
|
46
|
+
Object.defineProperty(exports, "defineSeeder", { enumerable: true, get: function () { return seeders_1.defineSeeder; } });
|
|
47
|
+
Object.defineProperty(exports, "readSeederFolder", { enumerable: true, get: function () { return seeders_1.readSeederFolder; } });
|
|
48
|
+
Object.defineProperty(exports, "seederName", { enumerable: true, get: function () { return seeders_1.seederName; } });
|
|
49
|
+
Object.defineProperty(exports, "ENTRY_SEEDER", { enumerable: true, get: function () { return seeders_1.ENTRY_SEEDER; } });
|
|
50
|
+
var factories_1 = require("./factories");
|
|
51
|
+
Object.defineProperty(exports, "Factory", { enumerable: true, get: function () { return factories_1.Factory; } });
|
|
52
|
+
Object.defineProperty(exports, "defineFactory", { enumerable: true, get: function () { return factories_1.defineFactory; } });
|
|
53
|
+
Object.defineProperty(exports, "getFaker", { enumerable: true, get: function () { return factories_1.getFaker; } });
|
|
54
|
+
Object.defineProperty(exports, "useFaker", { enumerable: true, get: function () { return factories_1.useFaker; } });
|
|
40
55
|
var plugin_1 = require("./plugin");
|
|
41
56
|
Object.defineProperty(exports, "ormPlugin", { enumerable: true, get: function () { return plugin_1.ormPlugin; } });
|
|
42
57
|
var config_1 = require("./config");
|
package/dist/orm/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/orm/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/orm/index.ts"],"names":[],"mappings":";;;;AAAA,iCAAgC;AAAvB,8FAAA,KAAK,OAAA;AACd,qCAAwC;AAA/B,sGAAA,WAAW,OAAA;AACpB,iCAUiB;AATf,mGAAA,UAAU,OAAA;AAUZ,+CAA6C;AAApC,2GAAA,WAAW,OAAA;AACpB,yCAMqB;AALnB,oGAAA,OAAO,OAAA;AACP,mGAAA,MAAM,OAAA;AACN,sGAAA,SAAS,OAAA;AACT,0GAAA,aAAa,OAAA;AAGf,qEAAqE;AACrE,+EAA+E;AAC/E,2CAqBsB;AApBpB,mGAAA,KAAK,OAAA;AACL,oGAAA,MAAM,OAAA;AACN,wGAAA,UAAU,OAAA;AACV,2GAAA,aAAa,OAAA;AACb,sGAAA,QAAQ,OAAA;AACR,uGAAA,SAAS,OAAA;AACT,uGAAA,SAAS,OAAA;AACT,uGAAA,SAAS,OAAA;AACT,qGAAA,OAAO,OAAA;AACP,oGAAA,MAAM,OAAA;AACN,uGAAA,SAAS,OAAA;AACT,2GAAA,aAAa,OAAA;AACb,8GAAA,gBAAgB,OAAA;AASlB,2CAA8C;AAArC,4GAAA,cAAc,OAAA;AACvB,iCAAyD;AAAhD,sGAAA,aAAa,OAAA;AAmBtB,2CASsB;AARpB,wGAAA,UAAU,OAAA;AACV,4GAAA,cAAc,OAAA;AACd,6GAAA,eAAe,OAAA;AAEf,iHAAA,mBAAmB,OAAA;AAKrB,qCAUmB;AATjB,kGAAA,OAAO,OAAA;AACP,oGAAA,SAAS,OAAA;AACT,uGAAA,YAAY,OAAA;AACZ,2GAAA,gBAAgB,OAAA;AAChB,qGAAA,UAAU,OAAA;AACV,uGAAA,YAAY,OAAA;AAKd,yCAOqB;AANnB,oGAAA,OAAO,OAAA;AACP,0GAAA,aAAa,OAAA;AACb,qGAAA,QAAQ,OAAA;AACR,qGAAA,QAAQ,OAAA;AAIV,mCAAqC;AAA5B,mGAAA,SAAS,OAAA;AAClB,mCAOkB;AANhB,6GAAA,mBAAmB,OAAA;AACnB,gHAAA,sBAAsB,OAAA;AAMxB,qCAA2C;AAAlC,yGAAA,cAAc,OAAA;AACvB,mCAQkB;AAPhB,gGAAA,MAAM,OAAA;AACN,mGAAA,SAAS,OAAA;AACT,0GAAA,gBAAgB,OAAA;AAChB,8GAAA,oBAAoB,OAAA;AACpB,qGAAA,WAAW,OAAA;AAIb,2BAA+E;AAAtE,wFAAA,EAAE,OAAA;AAAE,gGAAA,UAAU,OAAA;AAAE,kGAAA,YAAY,OAAA;AAAE,gGAAA,UAAU,OAAA;AACjD,mCAIkB;AAHhB,2GAAA,iBAAiB,OAAA;AACjB,2GAAA,iBAAiB,OAAA"}
|
package/dist/orm/migrations.d.ts
CHANGED
|
@@ -52,6 +52,12 @@ export declare class MigrationError extends Error {
|
|
|
52
52
|
readonly cause?: unknown | undefined;
|
|
53
53
|
constructor(message: string, migration: string | undefined, completed: string[], cause?: unknown | undefined);
|
|
54
54
|
}
|
|
55
|
+
/**
|
|
56
|
+
* `require()` first: it loads CommonJS everywhere and ES modules on Node
|
|
57
|
+
* 20.19+ / 22.12+. A native `import()` covers what it can't, such as `.ts`
|
|
58
|
+
* files under a loader hook.
|
|
59
|
+
*/
|
|
60
|
+
export declare function loadMigrationFile(file: string): Promise<any>;
|
|
55
61
|
/** Migrations in `folder`, keyed by file name without extension. */
|
|
56
62
|
export declare function readMigrationFolder(folder: string): Promise<Record<string, Migration>>;
|
|
57
63
|
/**
|
package/dist/orm/migrations.js
CHANGED
|
@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
6
|
exports.Migrations = exports.MigrationError = void 0;
|
|
7
7
|
exports.defineMigration = defineMigration;
|
|
8
|
+
exports.loadMigrationFile = loadMigrationFile;
|
|
8
9
|
exports.readMigrationFolder = readMigrationFolder;
|
|
9
10
|
/**
|
|
10
11
|
* @copyright 2024
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"migrations.js","sourceRoot":"","sources":["../../src/orm/migrations.ts"],"names":[],"mappings":";;;;;;AAmDA,0CAQC;
|
|
1
|
+
{"version":3,"file":"migrations.js","sourceRoot":"","sources":["../../src/orm/migrations.ts"],"names":[],"mappings":";;;;;;AAmDA,0CAQC;AA8CD,8CAUC;AAGD,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;AACI,KAAK,UAAU,iBAAiB,CAAC,IAAY;IAClD,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
|
@@ -10,8 +10,7 @@ import type { Cast } from "./casts";
|
|
|
10
10
|
import { HasRelation } from "./has-relation";
|
|
11
11
|
import { PivotRelation } from "./pivot";
|
|
12
12
|
import { ModelQuery, type ComparisonOperator, type Counted, type CursorPageRequest, type CursorPaginated, type ModelAt, type RelationConstraint, type Scope, type SimplePaginated } from "./query";
|
|
13
|
-
import {
|
|
14
|
-
import type { BelongsToManyKeys, ColumnKeys, Columns, CreateInput, HasRelationKeys, ModelClass, PivotOf, PrimaryKeyValue, RelatedModel, RelationKeys, RelationPaths, Row, UpdateInput } from "./types";
|
|
13
|
+
import type { BelongsToManyKeys, ColumnKeys, Columns, CreateInput, HasRelationKeys, IsManyRelation, ModelClass, PivotOf, PrimaryKeyValue, RelatedModel, RelationKeys, RelationPaths, Row, UpdateInput } from "./types";
|
|
15
14
|
type Instance<C extends ModelClass> = InstanceType<C>;
|
|
16
15
|
/**
|
|
17
16
|
* Base class for models.
|
|
@@ -161,14 +160,9 @@ export declare abstract class Model {
|
|
|
161
160
|
* The rows of a `hasMany` / `hasOne` relation, to query or create them
|
|
162
161
|
* with the foreign key set: `await user.related("posts").create({ title })`.
|
|
163
162
|
*/
|
|
164
|
-
related<K extends HasRelationKeys<this>>(name: K): HasRelation<RelatedModel<this[K]>, this[K] extends
|
|
163
|
+
related<K extends HasRelationKeys<this>>(name: K): HasRelation<RelatedModel<this[K]>, IsManyRelation<this[K]> extends true ? "many" : "one">;
|
|
165
164
|
private key;
|
|
166
165
|
/** Columns, loaded relations, and extras such as `pivot` and `withCount()` counts. */
|
|
167
166
|
toJSON(): Record<string, unknown>;
|
|
168
167
|
}
|
|
169
|
-
type HasManyMarker = {
|
|
170
|
-
readonly [RELATION]: {
|
|
171
|
-
type: "hasMany";
|
|
172
|
-
};
|
|
173
|
-
};
|
|
174
168
|
export {};
|
package/dist/orm/model.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
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,
|
|
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,2CAA4D;AAC5D,mCAWiB;AAoBjB;;;;;;;;;;;;;;;;;;;;;;;;;;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;AAED,+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,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* OpenAPI schemas for models: `@ApiResponse(200, User)` documents a model
|
|
3
|
+
* from its column decorators. Registered with core's OpenAPI module, so core
|
|
4
|
+
* doesn't depend on the ORM.
|
|
5
|
+
*/
|
|
6
|
+
import { type SchemaClass, type SchemaObject } from "./core";
|
|
7
|
+
/** JSON schema for a model's columns, from its decorators and TypeScript types. */
|
|
8
|
+
export declare function modelSchema(cls: SchemaClass): SchemaObject | undefined;
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.modelSchema = modelSchema;
|
|
4
|
+
/**
|
|
5
|
+
* OpenAPI schemas for models: `@ApiResponse(200, User)` documents a model
|
|
6
|
+
* from its column decorators. Registered with core's OpenAPI module, so core
|
|
7
|
+
* doesn't depend on the ORM.
|
|
8
|
+
*/
|
|
9
|
+
const core_1 = require("./core");
|
|
10
|
+
const decorators_1 = require("./decorators");
|
|
11
|
+
/** JSON schema for a model's columns, from its decorators and TypeScript types. */
|
|
12
|
+
function modelSchema(cls) {
|
|
13
|
+
const columns = (0, decorators_1.getModelMetadata)(cls)?.columns;
|
|
14
|
+
// Only models described with decorators; others go to the DTO reader.
|
|
15
|
+
if (!columns || columns.size === 0)
|
|
16
|
+
return undefined;
|
|
17
|
+
const properties = {};
|
|
18
|
+
const required = [];
|
|
19
|
+
for (const column of columns.values()) {
|
|
20
|
+
const design = Reflect.getMetadata?.("design:type", cls.prototype, column.property);
|
|
21
|
+
// `string | null` fields emit `Object` as their type: a length or
|
|
22
|
+
// precision still tells what the column holds.
|
|
23
|
+
const type = column.type ??
|
|
24
|
+
(column.length ? "string" : column.precision ? "decimal" : undefined);
|
|
25
|
+
const schema = columnSchema(type, design, column.primary || !!column.generated);
|
|
26
|
+
if (column.length && schema.type === "string")
|
|
27
|
+
schema.maxLength = column.length;
|
|
28
|
+
if (column.nullable)
|
|
29
|
+
schema.nullable = true;
|
|
30
|
+
properties[column.property] = schema;
|
|
31
|
+
// Rows read from the database have every column, NULL or not.
|
|
32
|
+
required.push(column.property);
|
|
33
|
+
}
|
|
34
|
+
return { type: "object", properties, required };
|
|
35
|
+
}
|
|
36
|
+
function columnSchema(type, design, key) {
|
|
37
|
+
switch (type) {
|
|
38
|
+
case "integer":
|
|
39
|
+
case "bigint":
|
|
40
|
+
return { type: "integer" };
|
|
41
|
+
case "float":
|
|
42
|
+
case "double":
|
|
43
|
+
case "decimal":
|
|
44
|
+
return { type: "number" };
|
|
45
|
+
case "boolean":
|
|
46
|
+
return { type: "boolean" };
|
|
47
|
+
case "date":
|
|
48
|
+
return { type: "string", format: "date" };
|
|
49
|
+
case "datetime":
|
|
50
|
+
case "timestamp":
|
|
51
|
+
return { type: "string", format: "date-time" };
|
|
52
|
+
case "time":
|
|
53
|
+
return { type: "string", format: "time" };
|
|
54
|
+
case "uuid":
|
|
55
|
+
return { type: "string", format: "uuid" };
|
|
56
|
+
case "json":
|
|
57
|
+
return {};
|
|
58
|
+
case "binary":
|
|
59
|
+
return { type: "string", format: "binary" };
|
|
60
|
+
case "string":
|
|
61
|
+
case "text":
|
|
62
|
+
return { type: "string" };
|
|
63
|
+
}
|
|
64
|
+
if (design === Number)
|
|
65
|
+
return { type: key ? "integer" : "number" };
|
|
66
|
+
if (design === String)
|
|
67
|
+
return { type: "string" };
|
|
68
|
+
if (design === Boolean)
|
|
69
|
+
return { type: "boolean" };
|
|
70
|
+
if (design === Date)
|
|
71
|
+
return { type: "string", format: "date-time" };
|
|
72
|
+
return {};
|
|
73
|
+
}
|
|
74
|
+
(0, core_1.registerSchemaProvider)(modelSchema);
|
|
75
|
+
//# sourceMappingURL=openapi.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"openapi.js","sourceRoot":"","sources":["../../src/orm/openapi.ts"],"names":[],"mappings":";;AAaA,kCA8BC;AA3CD;;;;GAIG;AACH,iCAIgB;AAChB,6CAAgD;AAEhD,mFAAmF;AACnF,SAAgB,WAAW,CAAC,GAAgB;IAC1C,MAAM,OAAO,GAAG,IAAA,6BAAgB,EAAC,GAAG,CAAC,EAAE,OAAO,CAAC;IAC/C,sEAAsE;IACtE,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IACrD,MAAM,UAAU,GAAiC,EAAE,CAAC;IACpD,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;QACtC,MAAM,MAAM,GAAI,OAAe,CAAC,WAAW,EAAE,CAC3C,aAAa,EACb,GAAG,CAAC,SAAS,EACb,MAAM,CAAC,QAAQ,CAChB,CAAC;QACF,kEAAkE;QAClE,+CAA+C;QAC/C,MAAM,IAAI,GACR,MAAM,CAAC,IAAI;YACX,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QACxE,MAAM,MAAM,GAAiB,YAAY,CACvC,IAAI,EACJ,MAAM,EACN,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC,MAAM,CAAC,SAAS,CACrC,CAAC;QACF,IAAI,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ;YAC3C,MAAM,CAAC,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC;QACnC,IAAI,MAAM,CAAC,QAAQ;YAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;QAC5C,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC;QACrC,8DAA8D;QAC9D,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC;AAClD,CAAC;AAED,SAAS,YAAY,CACnB,IAAwB,EACxB,MAAe,EACf,GAAY;IAEZ,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,SAAS,CAAC;QACf,KAAK,QAAQ;YACX,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;QAC7B,KAAK,OAAO,CAAC;QACb,KAAK,QAAQ,CAAC;QACd,KAAK,SAAS;YACZ,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;QAC5B,KAAK,SAAS;YACZ,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;QAC7B,KAAK,MAAM;YACT,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QAC5C,KAAK,UAAU,CAAC;QAChB,KAAK,WAAW;YACd,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;QACjD,KAAK,MAAM;YACT,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QAC5C,KAAK,MAAM;YACT,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QAC5C,KAAK,MAAM;YACT,OAAO,EAAE,CAAC;QACZ,KAAK,QAAQ;YACX,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;QAC9C,KAAK,QAAQ,CAAC;QACd,KAAK,MAAM;YACT,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;IAC9B,CAAC;IACD,IAAI,MAAM,KAAK,MAAM;QAAE,OAAO,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;IACnE,IAAI,MAAM,KAAK,MAAM;QAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;IACjD,IAAI,MAAM,KAAK,OAAO;QAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;IACnD,IAAI,MAAM,KAAK,IAAI;QAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;IACpE,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,IAAA,6BAAsB,EAAC,WAAW,CAAC,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"}
|
package/dist/orm/query.js
CHANGED
|
@@ -8,6 +8,7 @@ const core_1 = require("./core");
|
|
|
8
8
|
const core_2 = require("./core");
|
|
9
9
|
const casts_1 = require("./casts");
|
|
10
10
|
const connection_1 = require("./connection");
|
|
11
|
+
const paging_1 = require("./paging");
|
|
11
12
|
const naming_1 = require("./naming");
|
|
12
13
|
const relations_1 = require("./relations");
|
|
13
14
|
const state_1 = require("./state");
|
|
@@ -163,7 +164,8 @@ class ModelQuery {
|
|
|
163
164
|
}
|
|
164
165
|
async get() {
|
|
165
166
|
const ctx = this.context();
|
|
166
|
-
|
|
167
|
+
const db = (0, connection_1.getConnection)();
|
|
168
|
+
let qb = this.applyFilters(db.selectFrom((0, state_1.tableOf)(this.model)), ctx);
|
|
167
169
|
const columns = this.selectedColumns();
|
|
168
170
|
qb = columns ? qb.select(columns) : qb.selectAll();
|
|
169
171
|
for (const { relation, constrain } of this.counts) {
|
|
@@ -174,14 +176,11 @@ class ModelQuery {
|
|
|
174
176
|
}
|
|
175
177
|
for (const step of this.ordering)
|
|
176
178
|
qb = step(qb, ctx);
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
qb = qb.limit(Number.MAX_SAFE_INTEGER);
|
|
183
|
-
qb = qb.offset(this.offsetCount);
|
|
184
|
-
}
|
|
179
|
+
qb = (0, paging_1.applyPaging)(db, qb, {
|
|
180
|
+
limit: this.limitCount,
|
|
181
|
+
offset: this.offsetCount,
|
|
182
|
+
ordered: this.ordering.length > 0,
|
|
183
|
+
});
|
|
185
184
|
const rows = await qb.execute();
|
|
186
185
|
const models = rows.map((row) => {
|
|
187
186
|
const counts = {};
|