@geekmidas/cli 10.0.0-alpha.30 → 10.0.0-alpha.32
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/index.cjs +115 -47
- package/dist/index.cjs.map +1 -1
- package/dist/index.mjs +115 -47
- package/dist/index.mjs.map +1 -1
- package/dist/{migrate-BuCx7tIv.cjs → migrate-BiasgAIN.cjs} +269 -26
- package/dist/migrate-BiasgAIN.cjs.map +1 -0
- package/dist/{migrate-CBICVMAi.mjs → migrate-CnPtWnkR.mjs} +269 -28
- package/dist/migrate-CnPtWnkR.mjs.map +1 -0
- package/dist/vitest.cjs +5 -5
- package/dist/vitest.cjs.map +1 -1
- package/dist/vitest.d.cts +4 -4
- package/dist/vitest.d.mts +4 -4
- package/dist/vitest.mjs +5 -5
- package/dist/vitest.mjs.map +1 -1
- package/package.json +14 -14
- package/dist/migrate-BuCx7tIv.cjs.map +0 -1
- package/dist/migrate-CBICVMAi.mjs.map +0 -1
package/dist/index.mjs
CHANGED
|
@@ -37,7 +37,7 @@ import { Subscriber } from "@geekmidas/constructs/subscribers";
|
|
|
37
37
|
import { Topic } from "@geekmidas/constructs/topic";
|
|
38
38
|
import { lookup } from "node:dns/promises";
|
|
39
39
|
//#region package.json
|
|
40
|
-
var version = "10.0.0-alpha.
|
|
40
|
+
var version = "10.0.0-alpha.32";
|
|
41
41
|
//#endregion
|
|
42
42
|
//#region src/auth/credentials.ts
|
|
43
43
|
/**
|
|
@@ -1086,7 +1086,10 @@ async function workspaceDevCommand(workspace, options) {
|
|
|
1086
1086
|
...rawSecrets,
|
|
1087
1087
|
...reconciled.env
|
|
1088
1088
|
};
|
|
1089
|
-
|
|
1089
|
+
if (options.migrate || options.seed) {
|
|
1090
|
+
const { prepareDevDatabases } = await import("./migrate-CnPtWnkR.mjs");
|
|
1091
|
+
await prepareDevDatabases(workspace, reconciled.env, { seed: !!options.seed });
|
|
1092
|
+
} else await import("./migrate-CnPtWnkR.mjs").then(({ reportPendingMigrations }) => reportPendingMigrations(workspace, reconciled.env)).catch((error) => {
|
|
1090
1093
|
logger$10.log(`⚠️ Could not check for pending migrations: ${error instanceof Error ? error.message : String(error)}`);
|
|
1091
1094
|
});
|
|
1092
1095
|
const appUrls = {};
|
|
@@ -8293,7 +8296,7 @@ function layoutBlock(options, template) {
|
|
|
8293
8296
|
const { database } = options.constructs;
|
|
8294
8297
|
const isWorker = template.name === "worker";
|
|
8295
8298
|
if (monorepo) return `constructs/ # every construct: the surface, the database, topics
|
|
8296
|
-
${database ? "db/<construct>/ # migrations
|
|
8299
|
+
${database ? "db/<construct>/ # migrations/ and seeds/, one folder per database construct\n" : ""}${apiPath}/ # the API app
|
|
8297
8300
|
gkm.config.ts # name, constructs glob, secrets`;
|
|
8298
8301
|
const lines = ["src/constructs/ # the surface, and anything it declares", "src/config/ # env parser, logger"];
|
|
8299
8302
|
if (!isWorker) lines.push("src/endpoints/ # HTTP handlers");
|
|
@@ -8301,7 +8304,7 @@ gkm.config.ts # name, constructs glob, secrets`;
|
|
|
8301
8304
|
lines.push("src/crons/ # scheduled work");
|
|
8302
8305
|
lines.push("src/subscribers/ # topic consumers");
|
|
8303
8306
|
}
|
|
8304
|
-
if (database) lines.push("db/<construct>/ # migrations
|
|
8307
|
+
if (database) lines.push("db/<construct>/ # migrations/ and seeds/, one folder per database construct");
|
|
8305
8308
|
lines.push("gkm.config.ts # name, constructs glob, secrets");
|
|
8306
8309
|
return lines.join("\n");
|
|
8307
8310
|
}
|
|
@@ -8430,36 +8433,80 @@ Queries go through Kysely. Never open your own connection pool — the one the
|
|
|
8430
8433
|
construct provides is the one that gets credentials, pooling and shutdown.`;
|
|
8431
8434
|
}
|
|
8432
8435
|
function migrationsSection() {
|
|
8433
|
-
return `## Migrations
|
|
8436
|
+
return `## Migrations and seeds
|
|
8434
8437
|
|
|
8435
8438
|
Each database construct has its own folder, named after the construct:
|
|
8436
8439
|
\`Database\` is \`db/database/\`, a tenant \`AuthDatabase\` is
|
|
8437
|
-
\`db/auth-database/\`.
|
|
8438
|
-
|
|
8440
|
+
\`db/auth-database/\`. It holds two folders and nothing else:
|
|
8441
|
+
|
|
8442
|
+
\`\`\`
|
|
8443
|
+
db/database/
|
|
8444
|
+
migrations/ # the schema's history, applied once each
|
|
8445
|
+
seeds/ # the reference data the app needs, run on every pass
|
|
8446
|
+
\`\`\`
|
|
8447
|
+
|
|
8448
|
+
Each construct keeps its own history, in its own schema, and is migrated and
|
|
8449
|
+
seeded as its own **owner** role — the role a handler runs as cannot create a
|
|
8439
8450
|
table.
|
|
8440
8451
|
|
|
8441
8452
|
\`\`\`bash
|
|
8442
|
-
gkm migration database add_workouts # db/database/20260930143012_add_workouts.ts
|
|
8453
|
+
gkm migration database add_workouts # db/database/migrations/20260930143012_add_workouts.ts
|
|
8443
8454
|
gkm migration auth # Better Auth's schema change, as SQL
|
|
8444
|
-
gkm migrate # apply every
|
|
8455
|
+
gkm migrate # apply every construct's migrations, parents first
|
|
8445
8456
|
gkm migrate database # apply one construct's
|
|
8457
|
+
gkm seed # migrate, then run every seed
|
|
8458
|
+
gkm dev --migrate # migrate before the apps start
|
|
8459
|
+
gkm dev --seed # migrate and seed before the apps start
|
|
8446
8460
|
\`\`\`
|
|
8447
8461
|
|
|
8448
|
-
-
|
|
8449
|
-
\`.sql\`, which runs whole. Never rename or edit one that has
|
|
8450
|
-
it is recorded by name. Change the schema with a new
|
|
8462
|
+
- Migrations are \`<UTC timestamp>_<name>.ts\` exporting \`up\` (and
|
|
8463
|
+
\`down\`), or \`.sql\`, which runs whole. Never rename or edit one that has
|
|
8464
|
+
been applied — it is recorded by name. Change the schema with a new
|
|
8465
|
+
migration.
|
|
8451
8466
|
- Write migrations with \`Kysely<unknown>\` and snake_case names: they are the
|
|
8452
8467
|
SQL, and the camelCase plugin is the app's, not theirs.
|
|
8453
8468
|
- \`gkm migration auth\` compares Better Auth's schema to its tenant and writes
|
|
8454
8469
|
only the difference. Run it after adding a Better Auth plugin, and commit the
|
|
8455
8470
|
file.
|
|
8456
|
-
-
|
|
8457
|
-
\`
|
|
8458
|
-
|
|
8471
|
+
- Seeds always run after migrations, never instead of them. Each is a
|
|
8472
|
+
\`.ts\` exporting \`seed(db, { stage })\`, or \`.sql\`, run in name
|
|
8473
|
+
order, in a transaction of its own.
|
|
8474
|
+
- **Seeds run on every stage, production included.** Write them to be safe
|
|
8475
|
+
there. A seed that belongs only somewhere checks the stage it is handed:
|
|
8476
|
+
\`if (stage === 'production') return;\`. A \`.sql\` seed has no stage, so
|
|
8477
|
+
it must be right everywhere.
|
|
8478
|
+
- Tests migrate and seed themselves: the root vitest config's
|
|
8479
|
+
\`globalSetup: ['@geekmidas/cli/vitest']\` does both for the test stage
|
|
8480
|
+
before any test runs. \`gkm dev\` without a flag only reports what is
|
|
8481
|
+
pending.
|
|
8459
8482
|
- A deploy migrates before the new version goes live, so the old version runs
|
|
8460
8483
|
against the new schema until it is replaced. Keep each migration compatible
|
|
8461
8484
|
with the code before it: add a column in one release, stop using the old one,
|
|
8462
|
-
drop it in a later release
|
|
8485
|
+
drop it in a later release.
|
|
8486
|
+
|
|
8487
|
+
**Migrations hold schema, never data.** Tables, columns, constraints, indexes.
|
|
8488
|
+
No inserts, updates or deletes against the application's rows.
|
|
8489
|
+
|
|
8490
|
+
- **Reference data is a seed.** A permission catalogue, the roles and what
|
|
8491
|
+
they grant, a list of statuses — rows the app needs in order to run — are
|
|
8492
|
+
written by a seed in \`db/<construct>/seeds/\`, never by a migration.
|
|
8493
|
+
- **A seed is an upsert, run every time.** There is no history: every seed
|
|
8494
|
+
runs on every \`gkm seed\`, so changing what it writes and running it again
|
|
8495
|
+
is how the change is applied. Write \`onConflict(…).doUpdateSet(…)\` (or
|
|
8496
|
+
\`doNothing()\`), never a bare insert.
|
|
8497
|
+
- **Define it once, typed, where every app can import it.** A catalogue
|
|
8498
|
+
belongs in code, declared \`as const\` so its keys are a union type, and the
|
|
8499
|
+
seed writes the table from that constant — so the two cannot drift, and no
|
|
8500
|
+
test is needed to keep them in step. The API's guards, the web app's gates
|
|
8501
|
+
and a mobile app's gates all name the same keys, and a typo — or a removed
|
|
8502
|
+
permission still checked somewhere — fails to compile instead of failing
|
|
8503
|
+
closed at runtime.
|
|
8504
|
+
- **Sample data is factories'.** Demo users, a tournament for a test — those
|
|
8505
|
+
come from test factories, never a seed and never a migration.
|
|
8506
|
+
- **A backfill is the one data change a migration makes.** When a schema
|
|
8507
|
+
change needs existing rows transformed — a new non-null column filled from
|
|
8508
|
+
an old one — do it in the same migration, keyed on the rows it transforms.
|
|
8509
|
+
It never inserts rows that were not there.`;
|
|
8463
8510
|
}
|
|
8464
8511
|
function queriesSection() {
|
|
8465
8512
|
return `## Writing queries and relations
|
|
@@ -8716,26 +8763,26 @@ function loadPackageJson() {
|
|
|
8716
8763
|
* Run: pnpm --filter @geekmidas/cli sync-versions
|
|
8717
8764
|
*/
|
|
8718
8765
|
const GEEKMIDAS_VERSIONS = {
|
|
8719
|
-
"@geekmidas/audit": "~10.0.0-alpha.
|
|
8720
|
-
"@geekmidas/auth": "~10.0.0-alpha.
|
|
8721
|
-
"@geekmidas/cache": "~10.0.0-alpha.
|
|
8722
|
-
"@geekmidas/client": "~10.0.0-alpha.
|
|
8723
|
-
"@geekmidas/cloud": "~10.0.0-alpha.
|
|
8724
|
-
"@geekmidas/constructs": "~10.0.0-alpha.
|
|
8725
|
-
"@geekmidas/db": "~10.0.0-alpha.
|
|
8726
|
-
"@geekmidas/emailkit": "~10.0.0-alpha.
|
|
8727
|
-
"@geekmidas/envkit": "~10.0.0-alpha.
|
|
8728
|
-
"@geekmidas/errors": "~10.0.0-alpha.
|
|
8729
|
-
"@geekmidas/events": "~10.0.0-alpha.
|
|
8730
|
-
"@geekmidas/logger": "~10.0.0-alpha.
|
|
8731
|
-
"@geekmidas/manifest": "~10.0.0-alpha.
|
|
8732
|
-
"@geekmidas/rate-limit": "~10.0.0-alpha.
|
|
8733
|
-
"@geekmidas/schema": "~10.0.0-alpha.
|
|
8734
|
-
"@geekmidas/services": "~10.0.0-alpha.
|
|
8735
|
-
"@geekmidas/storage": "~10.0.0-alpha.
|
|
8736
|
-
"@geekmidas/studio": "~10.0.0-alpha.
|
|
8737
|
-
"@geekmidas/telescope": "~10.0.0-alpha.
|
|
8738
|
-
"@geekmidas/testkit": "~10.0.0-alpha.
|
|
8766
|
+
"@geekmidas/audit": "~10.0.0-alpha.32",
|
|
8767
|
+
"@geekmidas/auth": "~10.0.0-alpha.32",
|
|
8768
|
+
"@geekmidas/cache": "~10.0.0-alpha.32",
|
|
8769
|
+
"@geekmidas/client": "~10.0.0-alpha.32",
|
|
8770
|
+
"@geekmidas/cloud": "~10.0.0-alpha.32",
|
|
8771
|
+
"@geekmidas/constructs": "~10.0.0-alpha.32",
|
|
8772
|
+
"@geekmidas/db": "~10.0.0-alpha.32",
|
|
8773
|
+
"@geekmidas/emailkit": "~10.0.0-alpha.32",
|
|
8774
|
+
"@geekmidas/envkit": "~10.0.0-alpha.32",
|
|
8775
|
+
"@geekmidas/errors": "~10.0.0-alpha.32",
|
|
8776
|
+
"@geekmidas/events": "~10.0.0-alpha.32",
|
|
8777
|
+
"@geekmidas/logger": "~10.0.0-alpha.32",
|
|
8778
|
+
"@geekmidas/manifest": "~10.0.0-alpha.32",
|
|
8779
|
+
"@geekmidas/rate-limit": "~10.0.0-alpha.32",
|
|
8780
|
+
"@geekmidas/schema": "~10.0.0-alpha.32",
|
|
8781
|
+
"@geekmidas/services": "~10.0.0-alpha.32",
|
|
8782
|
+
"@geekmidas/storage": "~10.0.0-alpha.32",
|
|
8783
|
+
"@geekmidas/studio": "~10.0.0-alpha.32",
|
|
8784
|
+
"@geekmidas/telescope": "~10.0.0-alpha.32",
|
|
8785
|
+
"@geekmidas/testkit": "~10.0.0-alpha.32",
|
|
8739
8786
|
"@geekmidas/cli": `~${loadPackageJson().version}`
|
|
8740
8787
|
};
|
|
8741
8788
|
//#endregion
|
|
@@ -15330,9 +15377,12 @@ async function testCommand(options = {}) {
|
|
|
15330
15377
|
});
|
|
15331
15378
|
});
|
|
15332
15379
|
}
|
|
15333
|
-
/**
|
|
15380
|
+
/**
|
|
15381
|
+
* Migrate the test stage just reconciled, then seed it: a test run never
|
|
15382
|
+
* starts without the reference data the app needs.
|
|
15383
|
+
*/
|
|
15334
15384
|
async function migrateTestStage(workspace, env) {
|
|
15335
|
-
const {
|
|
15385
|
+
const { migrateAndSeed } = await import("./migrate-CnPtWnkR.mjs");
|
|
15336
15386
|
const { discover } = await import("./discover-CMxesskG.mjs").then((n) => n.n);
|
|
15337
15387
|
const sources = {};
|
|
15338
15388
|
const manifest = await discover({
|
|
@@ -15340,13 +15390,15 @@ async function migrateTestStage(workspace, env) {
|
|
|
15340
15390
|
cwd: workspace.root,
|
|
15341
15391
|
sources
|
|
15342
15392
|
});
|
|
15343
|
-
const
|
|
15393
|
+
const { migrations, seeds } = await migrateAndSeed({
|
|
15344
15394
|
root: workspace.root,
|
|
15345
15395
|
manifest,
|
|
15346
15396
|
sources,
|
|
15347
|
-
env
|
|
15397
|
+
env,
|
|
15398
|
+
stage: TEST_STAGE
|
|
15348
15399
|
});
|
|
15349
|
-
for (const { target, applied } of
|
|
15400
|
+
for (const { target, applied } of migrations) if (applied.length > 0) console.log(` 🗄️ ${target.migrations}: applied ${applied.join(", ")}`);
|
|
15401
|
+
for (const { target, seeded } of seeds) if (seeded.length > 0) console.log(` 🌱 ${target.seeds}: ran ${seeded.join(", ")}`);
|
|
15350
15402
|
}
|
|
15351
15403
|
/** `gkm test` outside a project that declares stages, with none named. */
|
|
15352
15404
|
var NoStageToTest = class extends Error {
|
|
@@ -15730,7 +15782,7 @@ program.command("build").description("Build handlers and the manifest from decla
|
|
|
15730
15782
|
process.exit(1);
|
|
15731
15783
|
}
|
|
15732
15784
|
});
|
|
15733
|
-
program.command("dev").description("Reconcile constructs and start the dev server with automatic reload").option("-p, --port <port>", "Port to run the development server on").option("--entry <file>", "Entry file to run (bypasses gkm config)").option("--watch", "Watch for file changes (default: true with --entry)").option("--no-watch", "Disable file watching").option("--enable-openapi", "Enable OpenAPI documentation for development server", true).action(async (options) => {
|
|
15785
|
+
program.command("dev").description("Reconcile constructs and start the dev server with automatic reload").option("-p, --port <port>", "Port to run the development server on").option("--entry <file>", "Entry file to run (bypasses gkm config)").option("--watch", "Watch for file changes (default: true with --entry)").option("--no-watch", "Disable file watching").option("--enable-openapi", "Enable OpenAPI documentation for development server", true).option("--migrate", "Apply pending migrations before the apps start").option("--seed", "Migrate, then run the seeds, before the apps start").action(async (options) => {
|
|
15734
15786
|
try {
|
|
15735
15787
|
const globalOptions = program.opts();
|
|
15736
15788
|
if (globalOptions.cwd) process.chdir(globalOptions.cwd);
|
|
@@ -15739,7 +15791,9 @@ program.command("dev").description("Reconcile constructs and start the dev serve
|
|
|
15739
15791
|
portExplicit: !!options.port,
|
|
15740
15792
|
enableOpenApi: options.enableOpenapi ?? true,
|
|
15741
15793
|
entry: options.entry,
|
|
15742
|
-
watch: options.watch
|
|
15794
|
+
watch: options.watch,
|
|
15795
|
+
migrate: options.migrate,
|
|
15796
|
+
seed: options.seed
|
|
15743
15797
|
});
|
|
15744
15798
|
} catch (error) {
|
|
15745
15799
|
console.error(formatError(error));
|
|
@@ -15756,7 +15810,7 @@ program.command("exec").description("Run a command with secrets injected into Cr
|
|
|
15756
15810
|
process.exit(1);
|
|
15757
15811
|
}
|
|
15758
15812
|
});
|
|
15759
|
-
program.command("test").description("Run tests with secrets loaded from environment").option("--stage <stage>", "Stage to load secrets from (default: stages.local)").option("--run", "Run tests once without watch mode").option("--watch", "Enable watch mode").option("--coverage", "Generate coverage report").option("--ui", "Open Vitest UI").option("--auto-setup", "Generate a fresh stage (secrets + key) from the workspace config when none exists (for CI; also via GKM_AUTO_SETUP)").option("--prepare", "Write the test manifest and #test harness, then stop — for a typecheck that runs before the suite").option("--setup", "Reconcile and
|
|
15813
|
+
program.command("test").description("Run tests with secrets loaded from environment").option("--stage <stage>", "Stage to load secrets from (default: stages.local)").option("--run", "Run tests once without watch mode").option("--watch", "Enable watch mode").option("--coverage", "Generate coverage report").option("--ui", "Open Vitest UI").option("--auto-setup", "Generate a fresh stage (secrets + key) from the workspace config when none exists (for CI; also via GKM_AUTO_SETUP)").option("--prepare", "Write the test manifest and #test harness, then stop — for a typecheck that runs before the suite").option("--setup", "Reconcile, migrate and seed the test stage and write the harness, then stop — what @geekmidas/cli/vitest runs").argument("[pattern]", "Pattern to filter tests").action(async (pattern, options) => {
|
|
15760
15814
|
try {
|
|
15761
15815
|
const globalOptions = program.opts();
|
|
15762
15816
|
if (globalOptions.cwd) process.chdir(globalOptions.cwd);
|
|
@@ -15769,11 +15823,11 @@ program.command("test").description("Run tests with secrets loaded from environm
|
|
|
15769
15823
|
process.exit(1);
|
|
15770
15824
|
}
|
|
15771
15825
|
});
|
|
15772
|
-
program.command("migrate").description("Apply each database construct's migrations from db/<construct
|
|
15826
|
+
program.command("migrate").description("Apply each database construct's migrations from db/<construct>/migrations/, as its owner").argument("[construct]", "Only this construct, by name").option("--stage <stage>", "The local stage (default) or test — a deploy migrates its own stage").action(async (construct, options) => {
|
|
15773
15827
|
try {
|
|
15774
15828
|
const globalOptions = program.opts();
|
|
15775
15829
|
if (globalOptions.cwd) process.chdir(globalOptions.cwd);
|
|
15776
|
-
const { migrateCommand } = await import("./migrate-
|
|
15830
|
+
const { migrateCommand } = await import("./migrate-CnPtWnkR.mjs");
|
|
15777
15831
|
await migrateCommand({
|
|
15778
15832
|
...options,
|
|
15779
15833
|
...construct ? { construct } : {}
|
|
@@ -15783,11 +15837,25 @@ program.command("migrate").description("Apply each database construct's migratio
|
|
|
15783
15837
|
process.exit(1);
|
|
15784
15838
|
}
|
|
15785
15839
|
});
|
|
15840
|
+
program.command("seed").description("Migrate, then run each database construct's seeds from db/<construct>/seeds/, as its owner").argument("[construct]", "Only this construct, by name").option("--stage <stage>", "The local stage (default) or test — a deploy seeds its own stage").action(async (construct, options) => {
|
|
15841
|
+
try {
|
|
15842
|
+
const globalOptions = program.opts();
|
|
15843
|
+
if (globalOptions.cwd) process.chdir(globalOptions.cwd);
|
|
15844
|
+
const { seedCommand } = await import("./migrate-CnPtWnkR.mjs");
|
|
15845
|
+
await seedCommand({
|
|
15846
|
+
...options,
|
|
15847
|
+
...construct ? { construct } : {}
|
|
15848
|
+
});
|
|
15849
|
+
} catch (error) {
|
|
15850
|
+
console.error(formatError(error));
|
|
15851
|
+
process.exit(1);
|
|
15852
|
+
}
|
|
15853
|
+
});
|
|
15786
15854
|
program.command("migration").description("Write a construct's next migration: an empty one for a database, the schema change for an auth server").argument("<construct>", "The construct, by name").argument("[name]", "What the migration is called").action(async (construct, name) => {
|
|
15787
15855
|
try {
|
|
15788
15856
|
const globalOptions = program.opts();
|
|
15789
15857
|
if (globalOptions.cwd) process.chdir(globalOptions.cwd);
|
|
15790
|
-
const { migrationCommand } = await import("./migrate-
|
|
15858
|
+
const { migrationCommand } = await import("./migrate-CnPtWnkR.mjs");
|
|
15791
15859
|
await migrationCommand({
|
|
15792
15860
|
construct,
|
|
15793
15861
|
...name ? { name } : {}
|