@guren/server 2.8.0 → 2.9.0
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/dist/{chunk-4BUZXYGV.js → chunk-O5XIXGYM.js} +2 -2
- package/dist/{chunk-JTNRAWQR.js → chunk-SQR7277M.js} +1 -0
- package/dist/database/Seeder.d.ts +38 -0
- package/dist/database/SeederRunner.d.ts +17 -0
- package/dist/database/types.d.ts +14 -0
- package/dist/index.js +17 -3
- package/dist/runtime/index.js +1 -1
- package/dist/storage/index.js +1 -1
- package/package.json +2 -2
|
@@ -6,7 +6,7 @@ import standard from "figlet/importable-fonts/Standard.js";
|
|
|
6
6
|
// package.json
|
|
7
7
|
var package_default = {
|
|
8
8
|
name: "@guren/server",
|
|
9
|
-
version: "2.
|
|
9
|
+
version: "2.9.0",
|
|
10
10
|
type: "module",
|
|
11
11
|
license: "MIT",
|
|
12
12
|
repository: {
|
|
@@ -119,7 +119,7 @@ var package_default = {
|
|
|
119
119
|
test: "bun test"
|
|
120
120
|
},
|
|
121
121
|
dependencies: {
|
|
122
|
-
"@guren/orm": "^2.
|
|
122
|
+
"@guren/orm": "^2.6.0",
|
|
123
123
|
"@modelcontextprotocol/sdk": "^1.30.0",
|
|
124
124
|
chalk: "^5.3.0",
|
|
125
125
|
consola: "^3.4.2",
|
|
@@ -1,18 +1,53 @@
|
|
|
1
1
|
import type { SeederClass } from './types.js';
|
|
2
2
|
/**
|
|
3
3
|
* Reset called seeders tracking (for testing).
|
|
4
|
+
*
|
|
5
|
+
* @deprecated Bookkeeping for {@link BaseSeeder}'s `callOnce`. Write seeders
|
|
6
|
+
* with `defineSeeder` from `@guren/core` instead, which needs no such
|
|
7
|
+
* tracking. Deprecated in 2.9.0, removed in 3.0.0.
|
|
4
8
|
*/
|
|
5
9
|
export declare function resetCalledSeeders(): void;
|
|
6
10
|
/**
|
|
7
11
|
* Abstract base class for database seeders.
|
|
12
|
+
*
|
|
13
|
+
* @deprecated Write seeders with `defineSeeder` from `@guren/core` instead.
|
|
14
|
+
* Deprecated in 2.9.0, removed in 3.0.0.
|
|
15
|
+
*
|
|
16
|
+
* A seeder class is not itself the problem: `db:seed` loads every seeder
|
|
17
|
+
* through `runSeeders()`, which does accept an exported class whose prototype
|
|
18
|
+
* has a `run` method, constructs it, and calls `run({ db })`. What this base
|
|
19
|
+
* class gets wrong is the signature it imposes on that method. `run()` is
|
|
20
|
+
* declared to take no parameters, so it hides the one argument a seeder
|
|
21
|
+
* needs.
|
|
22
|
+
*
|
|
23
|
+
* A subclass cannot simply correct that: declaring `run(ctx: SeederContext)`
|
|
24
|
+
* fails to compile against the base (`TS2416: Target signature provides too
|
|
25
|
+
* few arguments. Expected 1 or more, but got 0`). Widening it to an optional
|
|
26
|
+
* `run(ctx?: SeederContext)` does compile, but then the subclass has to handle
|
|
27
|
+
* a missing context — and that case is real, because
|
|
28
|
+
* {@link BaseSeeder.call}, {@link BaseSeeder.callOnce},
|
|
29
|
+
* {@link BaseSeeder.callMany} and {@link BaseSeeder.callParallel} construct
|
|
30
|
+
* child seeders and invoke `run()` with no arguments at all. A parent that
|
|
31
|
+
* received a context cannot pass it down.
|
|
32
|
+
*
|
|
33
|
+
* The orchestration these classes were written for, `SeederRunner`, is
|
|
34
|
+
* reached by no Guren command.
|
|
8
35
|
*/
|
|
9
36
|
export declare abstract class BaseSeeder {
|
|
37
|
+
constructor();
|
|
10
38
|
/**
|
|
11
39
|
* Run the seeder.
|
|
40
|
+
*
|
|
41
|
+
* Declared without parameters, which is what makes this class the wrong
|
|
42
|
+
* base: `runSeeders()` calls it with a `{ db }` context that this signature
|
|
43
|
+
* cannot name.
|
|
12
44
|
*/
|
|
13
45
|
abstract run(): Promise<void>;
|
|
14
46
|
/**
|
|
15
47
|
* Call another seeder.
|
|
48
|
+
*
|
|
49
|
+
* No context is forwarded: the child's `run()` is invoked with no
|
|
50
|
+
* arguments, whatever the caller itself received.
|
|
16
51
|
*/
|
|
17
52
|
protected call(SeederClass: SeederClass): Promise<void>;
|
|
18
53
|
/**
|
|
@@ -31,5 +66,8 @@ export declare abstract class BaseSeeder {
|
|
|
31
66
|
}
|
|
32
67
|
/**
|
|
33
68
|
* Alias for BaseSeeder.
|
|
69
|
+
*
|
|
70
|
+
* @deprecated Write seeders with `defineSeeder` from `@guren/core` instead.
|
|
71
|
+
* Deprecated in 2.9.0, removed in 3.0.0. See {@link BaseSeeder}.
|
|
34
72
|
*/
|
|
35
73
|
export { BaseSeeder as Seeder };
|
|
@@ -1,6 +1,19 @@
|
|
|
1
1
|
import type { SeederClass, SeederRunnerOptions } from './types.js';
|
|
2
2
|
/**
|
|
3
3
|
* Seeder runner for executing database seeders.
|
|
4
|
+
*
|
|
5
|
+
* @deprecated No Guren command reaches this runner. Write seeders with
|
|
6
|
+
* `defineSeeder` from `@guren/core` and run them with `db:seed`. Deprecated
|
|
7
|
+
* in 2.9.0, removed in 3.0.0.
|
|
8
|
+
*
|
|
9
|
+
* `db:seed` seeds by loading the seeders folder through `runSeeders()`, which
|
|
10
|
+
* runs every seeder it finds there and hands each one a `{ db }` context. This
|
|
11
|
+
* runner orchestrates differently: it runs a single seeder per call, taken
|
|
12
|
+
* from a class passed in, a name registered with {@link SeederRunner.register},
|
|
13
|
+
* or a name resolved to `<seedersPath>/<Name>.ts` and defaulting to
|
|
14
|
+
* `DatabaseSeeder`; it constructs it with `new` and invokes `.run()` with no
|
|
15
|
+
* context. Nothing in the framework calls any of it. See {@link BaseSeeder}
|
|
16
|
+
* for what the no-context `run()` costs a seeder written against it.
|
|
4
17
|
*/
|
|
5
18
|
export declare class SeederRunner {
|
|
6
19
|
private options;
|
|
@@ -37,5 +50,9 @@ export declare class SeederRunner {
|
|
|
37
50
|
}
|
|
38
51
|
/**
|
|
39
52
|
* Create a seeder runner.
|
|
53
|
+
*
|
|
54
|
+
* @deprecated No Guren command reaches this runner. Write seeders with
|
|
55
|
+
* `defineSeeder` from `@guren/core` instead. Deprecated in 2.9.0, removed in
|
|
56
|
+
* 3.0.0. See {@link SeederRunner}.
|
|
40
57
|
*/
|
|
41
58
|
export declare function createSeederRunner(options?: SeederRunnerOptions): SeederRunner;
|
package/dist/database/types.d.ts
CHANGED
|
@@ -1,11 +1,21 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Seeder class interface.
|
|
3
|
+
*
|
|
4
|
+
* @deprecated The constructor shape `BaseSeeder` and `SeederRunner` expect.
|
|
5
|
+
* Write seeders with `defineSeeder` from `@guren/core` instead. Deprecated in
|
|
6
|
+
* 2.9.0, removed in 3.0.0.
|
|
3
7
|
*/
|
|
4
8
|
export interface SeederClass {
|
|
5
9
|
new (): Seeder;
|
|
6
10
|
}
|
|
7
11
|
/**
|
|
8
12
|
* Abstract seeder interface.
|
|
13
|
+
*
|
|
14
|
+
* Exported from the package root as `SeederInterface`.
|
|
15
|
+
*
|
|
16
|
+
* @deprecated The no-context `run()` shape `BaseSeeder` imposes. Write seeders
|
|
17
|
+
* with `defineSeeder` from `@guren/core` instead, whose handler is typed to
|
|
18
|
+
* receive `{ db }`. Deprecated in 2.9.0, removed in 3.0.0.
|
|
9
19
|
*/
|
|
10
20
|
export interface Seeder {
|
|
11
21
|
run(): Promise<void>;
|
|
@@ -28,6 +38,10 @@ export interface Factory<T> {
|
|
|
28
38
|
}
|
|
29
39
|
/**
|
|
30
40
|
* Seeder runner options.
|
|
41
|
+
*
|
|
42
|
+
* @deprecated Options for `SeederRunner`, which no Guren command reaches.
|
|
43
|
+
* Write seeders with `defineSeeder` from `@guren/core` and run them with
|
|
44
|
+
* `db:seed`. Deprecated in 2.9.0, removed in 3.0.0.
|
|
31
45
|
*/
|
|
32
46
|
export interface SeederRunnerOptions {
|
|
33
47
|
/**
|
package/dist/index.js
CHANGED
|
@@ -5,7 +5,7 @@ import {
|
|
|
5
5
|
logDevServerBanner,
|
|
6
6
|
parseImportMap,
|
|
7
7
|
startViteDevServer
|
|
8
|
-
} from "./chunk-
|
|
8
|
+
} from "./chunk-O5XIXGYM.js";
|
|
9
9
|
import {
|
|
10
10
|
PendingSchedule,
|
|
11
11
|
Schedule,
|
|
@@ -25,8 +25,9 @@ import {
|
|
|
25
25
|
MemoryDriver as MemoryDriver3,
|
|
26
26
|
S3Driver,
|
|
27
27
|
StorageManager,
|
|
28
|
-
createStorageManager
|
|
29
|
-
|
|
28
|
+
createStorageManager,
|
|
29
|
+
warnOnce
|
|
30
|
+
} from "./chunk-SQR7277M.js";
|
|
30
31
|
import {
|
|
31
32
|
trimSlashes
|
|
32
33
|
} from "./chunk-AZOYI43J.js";
|
|
@@ -4796,8 +4797,17 @@ function resetCalledSeeders() {
|
|
|
4796
4797
|
calledSeeders.clear();
|
|
4797
4798
|
}
|
|
4798
4799
|
var BaseSeeder = class {
|
|
4800
|
+
constructor() {
|
|
4801
|
+
warnOnce(
|
|
4802
|
+
"seeder-class-convention:base-seeder",
|
|
4803
|
+
"[guren] Deprecation (seeder-class-convention): BaseSeeder/Seeder is deprecated\n since 2.9.0, will be removed in 3.0.0.\n Write seeders with defineSeeder from '@guren/core': its handler receives { db }, which BaseSeeder.run() is declared not to take."
|
|
4804
|
+
);
|
|
4805
|
+
}
|
|
4799
4806
|
/**
|
|
4800
4807
|
* Call another seeder.
|
|
4808
|
+
*
|
|
4809
|
+
* No context is forwarded: the child's `run()` is invoked with no
|
|
4810
|
+
* arguments, whatever the caller itself received.
|
|
4801
4811
|
*/
|
|
4802
4812
|
async call(SeederClass) {
|
|
4803
4813
|
const seeder = new SeederClass();
|
|
@@ -4989,6 +4999,10 @@ var SeederRunner = class {
|
|
|
4989
4999
|
options;
|
|
4990
5000
|
seeders = /* @__PURE__ */ new Map();
|
|
4991
5001
|
constructor(options = {}) {
|
|
5002
|
+
warnOnce(
|
|
5003
|
+
"seeder-class-convention:seeder-runner",
|
|
5004
|
+
"[guren] Deprecation (seeder-class-convention): SeederRunner is deprecated\n since 2.9.0, will be removed in 3.0.0.\n No Guren command runs it. Write seeders with defineSeeder from '@guren/core' and run them with `guren db:seed`."
|
|
5005
|
+
);
|
|
4992
5006
|
this.options = {
|
|
4993
5007
|
seedersPath: options.seedersPath ?? "db/seeders",
|
|
4994
5008
|
defaultSeeder: options.defaultSeeder ?? "DatabaseSeeder",
|
package/dist/runtime/index.js
CHANGED
package/dist/storage/index.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@guren/server",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.9.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
@@ -113,7 +113,7 @@
|
|
|
113
113
|
"test": "bun test"
|
|
114
114
|
},
|
|
115
115
|
"dependencies": {
|
|
116
|
-
"@guren/orm": "^2.
|
|
116
|
+
"@guren/orm": "^2.6.0",
|
|
117
117
|
"@modelcontextprotocol/sdk": "^1.30.0",
|
|
118
118
|
"chalk": "^5.3.0",
|
|
119
119
|
"consola": "^3.4.2",
|