@cosmicdrift/kumiko-framework 0.387.0 → 0.388.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/AGENTS.md +6 -1
- package/agents/examples/anonymous-access.md +1 -1
- package/agents/examples/apex-landing.md +204 -0
- package/agents/examples/api-worker-split.md +64 -0
- package/agents/examples/app-config.md +14 -0
- package/agents/examples/auth-mfa.md +115 -0
- package/agents/examples/env-composition.md +28 -1
- package/agents/examples/legal-pages.md +1 -1
- package/agents/examples/prod-boot-options.md +16 -0
- package/agents/examples/rate-limiting.md +48 -0
- package/agents/examples/record-detail-layout.md +692 -0
- package/agents/examples/seed-migration.md +212 -0
- package/agents/examples/wizard-form.md +941 -0
- package/agents/examples/writeform-section.md +548 -0
- package/agents/features.md +19 -2
- package/agents/widgets.md +1 -0
- package/dist/api/client-error-route.js +8 -2
- package/dist/api/index.d.ts +3 -1
- package/dist/api/index.js +3 -1
- package/dist/api/request-context.d.ts +1 -1
- package/dist/api/request-context.js +1 -1
- package/dist/api/server-boot-checks.d.ts +10 -0
- package/dist/api/server-boot-checks.js +157 -0
- package/dist/api/server-event-dispatcher.d.ts +26 -0
- package/dist/api/server-event-dispatcher.js +208 -0
- package/dist/api/server-extra-routes.d.ts +11 -0
- package/dist/api/server-extra-routes.js +203 -0
- package/dist/api/server-middleware.d.ts +20 -0
- package/dist/api/server-middleware.js +211 -0
- package/dist/api/server-routes.d.ts +19 -0
- package/dist/api/server-routes.js +293 -0
- package/dist/api/server-websocket-routes.d.ts +4 -0
- package/dist/api/server-websocket-routes.js +108 -0
- package/dist/api/server-wiring.d.ts +32 -0
- package/dist/api/server-wiring.js +236 -0
- package/dist/api/server.d.ts +10 -15
- package/dist/api/server.js +48 -1251
- package/dist/api/session-cookies.js +4 -4
- package/dist/api/sse-route.js +16 -12
- package/dist/crypto/owner-transition-rekey.d.ts +5 -1
- package/dist/crypto/owner-transition-rekey.js +1 -1
- package/dist/crypto/pii-field-encryption.d.ts +5 -1
- package/dist/crypto/pii-field-encryption.js +3 -1
- package/dist/db/aggregate-sql.d.ts +21 -0
- package/dist/db/aggregate-sql.js +155 -0
- package/dist/db/closed-connection.d.ts +9 -0
- package/dist/db/closed-connection.js +95 -0
- package/dist/db/dialect.js +1 -1
- package/dist/db/distinct-on.d.ts +1 -1
- package/dist/db/driver-row-coercion.d.ts +2 -0
- package/dist/db/driver-row-coercion.js +186 -0
- package/dist/db/driver-value-preparation.d.ts +16 -0
- package/dist/db/driver-value-preparation.js +99 -0
- package/dist/db/entity-field-encryption.d.ts +1 -0
- package/dist/db/entity-field-encryption.js +1 -1
- package/dist/db/entity-table-meta.js +103 -110
- package/dist/db/event-store-executor-context.d.ts +2 -1
- package/dist/db/event-store-executor-read-aggregate.d.ts +8 -0
- package/dist/db/event-store-executor-read-aggregate.js +112 -0
- package/dist/db/event-store-executor-read-filter.d.ts +31 -0
- package/dist/db/event-store-executor-read-filter.js +203 -0
- package/dist/db/event-store-executor-read-paging.d.ts +14 -0
- package/dist/db/event-store-executor-read-paging.js +99 -0
- package/dist/db/event-store-executor-read-rows.d.ts +6 -0
- package/dist/db/event-store-executor-read-rows.js +32 -0
- package/dist/db/event-store-executor-read-search.d.ts +28 -0
- package/dist/db/event-store-executor-read-search.js +221 -0
- package/dist/db/event-store-executor-read-sort.d.ts +41 -0
- package/dist/db/event-store-executor-read-sort.js +130 -0
- package/dist/db/event-store-executor-read-where.d.ts +24 -0
- package/dist/db/event-store-executor-read-where.js +81 -0
- package/dist/db/event-store-executor-read.d.ts +2 -9
- package/dist/db/event-store-executor-read.js +48 -701
- package/dist/db/event-store-executor-write-steps.d.ts +20 -0
- package/dist/db/event-store-executor-write-steps.js +100 -0
- package/dist/db/event-store-executor-write.js +395 -499
- package/dist/db/index.d.ts +6 -2
- package/dist/db/index.js +5 -1
- package/dist/db/list-aggregate-labels.d.ts +14 -0
- package/dist/db/list-aggregate-labels.js +26 -0
- package/dist/db/migrate-generator.js +71 -86
- package/dist/db/migrate-runner.js +4 -1
- package/dist/db/query.d.ts +2 -15
- package/dist/db/query.js +8 -761
- package/dist/db/reference-data.js +6 -1
- package/dist/db/table-builder.js +113 -166
- package/dist/db/table-info.d.ts +10 -0
- package/dist/db/table-info.js +45 -0
- package/dist/db/temporal-value-guards.d.ts +6 -0
- package/dist/db/temporal-value-guards.js +15 -0
- package/dist/db/tenant-db-runner.d.ts +1 -0
- package/dist/db/tenant-db-runner.js +3 -0
- package/dist/db/tenant-db.js +39 -9
- package/dist/db/where-clause.d.ts +6 -0
- package/dist/db/where-clause.js +236 -0
- package/dist/derivatives/delete-stored-file.js +2 -1
- package/dist/engine/boot-validator/boot-check.js +1 -1
- package/dist/engine/boot-validator/detail-screens.js +2 -2
- package/dist/engine/boot-validator/entity-handler.d.ts +1 -0
- package/dist/engine/boot-validator/entity-handler.js +17 -0
- package/dist/engine/boot-validator/form-derivations.js +35 -1
- package/dist/engine/boot-validator/i18n-keys.js +5 -3
- package/dist/engine/boot-validator/index.js +2 -0
- package/dist/engine/boot-validator/pii-retention.js +233 -155
- package/dist/engine/boot-validator/screens-actions.d.ts +1 -0
- package/dist/engine/boot-validator/screens-actions.js +8 -1
- package/dist/engine/boot-validator/screens-dashboard.js +2 -5
- package/dist/engine/boot-validator/screens-forms.js +2 -6
- package/dist/engine/boot-validator/screens-kind-config-edit.d.ts +3 -0
- package/dist/engine/boot-validator/screens-kind-config-edit.js +88 -0
- package/dist/engine/boot-validator/screens-kind-entity-edit.d.ts +3 -0
- package/dist/engine/boot-validator/screens-kind-entity-edit.js +55 -0
- package/dist/engine/boot-validator/screens-kind-entity-list.d.ts +3 -0
- package/dist/engine/boot-validator/screens-kind-entity-list.js +228 -0
- package/dist/engine/boot-validator/screens-kind-projection-detail.d.ts +3 -0
- package/dist/engine/boot-validator/screens-kind-projection-detail.js +235 -0
- package/dist/engine/boot-validator/screens-kind-projection-list.d.ts +3 -0
- package/dist/engine/boot-validator/screens-kind-projection-list.js +52 -0
- package/dist/engine/boot-validator/screens-kind-secret-mint.d.ts +3 -0
- package/dist/engine/boot-validator/screens-kind-secret-mint.js +28 -0
- package/dist/engine/boot-validator/screens-kind-shared.d.ts +37 -0
- package/dist/engine/boot-validator/screens-kind-shared.js +142 -0
- package/dist/engine/boot-validator/screens-lists.d.ts +2 -1
- package/dist/engine/boot-validator/screens-lists.js +12 -9
- package/dist/engine/boot-validator/screens.d.ts +0 -2
- package/dist/engine/boot-validator/screens.js +99 -860
- package/dist/engine/build-app-schema.js +56 -96
- package/dist/engine/define-feature.js +9 -2
- package/dist/engine/define-handler.js +1 -0
- package/dist/engine/entity-handlers.d.ts +13 -0
- package/dist/engine/entity-handlers.js +10 -21
- package/dist/engine/entity-list-runtime-options.d.ts +8 -0
- package/dist/engine/entity-list-runtime-options.js +18 -0
- package/dist/engine/feature-ast/extractors/handlers.js +1 -0
- package/dist/engine/feature-ast/extractors/round2.js +25 -6
- package/dist/engine/feature-ast/patch.js +4 -182
- package/dist/engine/feature-ast/pattern-change-schema.d.ts +3 -0
- package/dist/engine/feature-ast/pattern-change-schema.js +1 -0
- package/dist/engine/feature-ast/pattern-id-matchers.d.ts +7 -0
- package/dist/engine/feature-ast/pattern-id-matchers.js +210 -0
- package/dist/engine/feature-ast/patterns.d.ts +9 -0
- package/dist/engine/feature-ast/patterns.js +43 -51
- package/dist/engine/feature-ast/render.js +48 -87
- package/dist/engine/feature-entity-handlers.js +3 -0
- package/dist/engine/form-derivations.js +18 -7
- package/dist/engine/handler-field-references.js +1 -1
- package/dist/engine/project-app-schema-for-roles.d.ts +2 -0
- package/dist/engine/project-app-schema-for-roles.js +6 -4
- package/dist/engine/registry-ingest.js +1 -1
- package/dist/engine/schema-builder.js +228 -212
- package/dist/engine/screen-helpers.js +1 -1
- package/dist/engine/screen-kind.d.ts +7 -0
- package/dist/engine/screen-kind.js +1 -0
- package/dist/engine/strip-disabled-features-from-app-schema.js +51 -14
- package/dist/engine/validate-projection-allowlist.js +2 -1
- package/dist/entrypoint/index.d.ts +4 -1
- package/dist/entrypoint/index.js +7 -1
- package/dist/errors/docs-url.d.ts +1 -1
- package/dist/errors/docs-url.js +22 -2
- package/dist/es-ops/context.js +1 -1
- package/dist/event-store/admin-api.js +1 -1
- package/dist/event-store/event-store.js +10 -4
- package/dist/files/bind-pending-file-refs.js +3 -3
- package/dist/files/create-file-ref-from-bytes.js +4 -1
- package/dist/files/file-handle.js +2 -3
- package/dist/files/file-routes.js +11 -8
- package/dist/files/resolve-content-type.js +43 -0
- package/dist/files/upload-ledger.js +7 -0
- package/dist/i18n/required-surface-keys.js +182 -206
- package/dist/internal/stack-support.d.ts +2 -1
- package/dist/internal/stack-support.js +1 -1
- package/dist/jobs/job-runner-context.d.ts +32 -0
- package/dist/jobs/job-runner-context.js +305 -0
- package/dist/jobs/job-runner-execution.d.ts +7 -0
- package/dist/jobs/job-runner-execution.js +160 -0
- package/dist/jobs/job-runner-gates.d.ts +19 -0
- package/dist/jobs/job-runner-gates.js +198 -0
- package/dist/jobs/job-runner-helpers.d.ts +17 -3
- package/dist/jobs/job-runner-helpers.js +61 -2
- package/dist/jobs/job-runner-scope.d.ts +44 -0
- package/dist/jobs/job-runner-scope.js +102 -0
- package/dist/jobs/job-runner-types.d.ts +12 -0
- package/dist/jobs/job-runner.d.ts +0 -1
- package/dist/jobs/job-runner.js +47 -657
- package/dist/observability/escape-hatch-report.d.ts +3 -0
- package/dist/observability/escape-hatch-report.js +12 -1
- package/dist/pipeline/cascade-handler.js +165 -138
- package/dist/pipeline/dispatch-query.js +10 -3
- package/dist/pipeline/dispatch-shared.d.ts +13 -3
- package/dist/pipeline/dispatch-shared.js +58 -710
- package/dist/pipeline/dispatch-write.js +296 -189
- package/dist/pipeline/event-dispatcher-admin.js +2 -1
- package/dist/pipeline/event-dispatcher-delivery.js +3 -5
- package/dist/pipeline/handler-context-auth.d.ts +9 -0
- package/dist/pipeline/handler-context-auth.js +54 -0
- package/dist/pipeline/handler-context-config.d.ts +14 -0
- package/dist/pipeline/handler-context-config.js +113 -0
- package/dist/pipeline/handler-context-db.d.ts +24 -0
- package/dist/pipeline/handler-context-db.js +149 -0
- package/dist/pipeline/handler-context-dispatch.d.ts +21 -0
- package/dist/pipeline/handler-context-dispatch.js +89 -0
- package/dist/pipeline/handler-context-events.d.ts +43 -0
- package/dist/pipeline/handler-context-events.js +237 -0
- package/dist/pipeline/handler-context-notify.d.ts +12 -0
- package/dist/pipeline/handler-context-notify.js +55 -0
- package/dist/pipeline/handler-context-observability.d.ts +7 -0
- package/dist/pipeline/handler-context-observability.js +21 -0
- package/dist/pipeline/handler-context-scope.d.ts +48 -0
- package/dist/pipeline/handler-context-scope.js +88 -0
- package/dist/pipeline/notify-scope.js +12 -1
- package/dist/pipeline/pre-handler-gates.js +20 -4
- package/dist/pipeline/pre-transaction-reservations.d.ts +1 -0
- package/dist/pipeline/pre-transaction-reservations.js +9 -3
- package/dist/pipeline/projection-rebuild.js +2 -1
- package/dist/schema-cli/apply-command.d.ts +2 -0
- package/dist/schema-cli/apply-command.js +97 -0
- package/dist/schema-cli/baseline-command.d.ts +2 -0
- package/dist/schema-cli/baseline-command.js +33 -0
- package/dist/schema-cli/generate-command.d.ts +2 -0
- package/dist/schema-cli/generate-command.js +90 -0
- package/dist/schema-cli/shared.d.ts +39 -0
- package/dist/schema-cli/shared.js +95 -0
- package/dist/schema-cli/status-command.d.ts +2 -0
- package/dist/schema-cli/status-command.js +73 -0
- package/dist/schema-cli/validate-boot-input.d.ts +5 -0
- package/dist/schema-cli/validate-boot-input.js +130 -0
- package/dist/schema-cli/validate-command.d.ts +2 -0
- package/dist/schema-cli/validate-command.js +130 -0
- package/dist/schema-cli.d.ts +2 -18
- package/dist/schema-cli.js +47 -604
- package/dist/search/meilisearch-adapter.js +2 -1
- package/dist/upgrade-cli.js +149 -121
- package/package.json +4 -4
- package/src/changes.json +310 -0
- package/src/scripts/codemod/feature-layout.ts +10 -2
- package/src/scripts/codemod/object-form.ts +41 -4
- package/src/scripts/codemod/package-merge.ts +58 -8
- package/src/scripts/codemod/pii-personal-migration.ts +175 -145
- package/src/scripts/codemod/testing-injection.ts +122 -42
- package/src/scripts/codemod/testing-move.ts +29 -7
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
import { configureBlindIndexKey, configurePiiSubjectKms, resolveKmsWiringAsync, } from "../crypto/index.js";
|
|
2
|
+
import { createDbConnection, runMigrationsFromDir } from "../db/index.js";
|
|
3
|
+
import { createRegistry } from "../engine/registry.js";
|
|
4
|
+
import { createEventsTable } from "../event-store/index.js";
|
|
5
|
+
import { queueRebuildsFromMarkers, reportPendingRebuildRun, runPendingRebuilds, } from "../migrations/index.js";
|
|
6
|
+
import { createEventConsumerStateTable, createProjectionStateTable } from "../pipeline/index.js";
|
|
7
|
+
import { migrationsDirExistsOrReport, readDatabaseUrlOrReport, } from "./shared.js";
|
|
8
|
+
async function ensureFrameworkInfrastructureTables(db) {
|
|
9
|
+
// Framework infrastructure tables (event store + pipeline state) are not captured by
|
|
10
|
+
// `generate`, which handles only entity read tables. Existing databases have them
|
|
11
|
+
// from the legacy-drizzle foundation; without them, a greenfield database (the
|
|
12
|
+
// first app without a cutover) would lack kumiko_events and runProdApp would fail
|
|
13
|
+
// during boot. All three are idempotent (tableExists-gated), so they are no-ops for
|
|
14
|
+
// existing databases.
|
|
15
|
+
await createEventsTable(db);
|
|
16
|
+
await createEventConsumerStateTable(db);
|
|
17
|
+
await createProjectionStateTable(db);
|
|
18
|
+
}
|
|
19
|
+
function reportAppliedMigrations(out, result) {
|
|
20
|
+
out.log("");
|
|
21
|
+
if (result.applied.length === 0) {
|
|
22
|
+
out.log(` ✓ All ${result.skipped.length} migrations already applied.`);
|
|
23
|
+
}
|
|
24
|
+
else {
|
|
25
|
+
out.log(` ✓ Applied ${result.applied.length}:`);
|
|
26
|
+
for (const id of result.applied)
|
|
27
|
+
out.log(` + ${id}`);
|
|
28
|
+
if (result.skipped.length > 0)
|
|
29
|
+
out.log(` (${result.skipped.length} already applied)`);
|
|
30
|
+
}
|
|
31
|
+
out.log("");
|
|
32
|
+
}
|
|
33
|
+
function configureRebuildKms(wiring) {
|
|
34
|
+
if ("kms" in wiring) {
|
|
35
|
+
configurePiiSubjectKms(wiring.kms);
|
|
36
|
+
configureBlindIndexKey(wiring.blindIndexKey);
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
async function rebuildQueuedProjections(db, ctx, features, appliedIds) {
|
|
40
|
+
const thisRunTables = await queueRebuildsFromMarkers(db, {
|
|
41
|
+
migrationsDir: ctx.migrationsDir,
|
|
42
|
+
appliedIds,
|
|
43
|
+
});
|
|
44
|
+
const registry = createRegistry(features);
|
|
45
|
+
const rebuildRun = await runPendingRebuilds(db, registry, { thisRunTables });
|
|
46
|
+
reportPendingRebuildRun(rebuildRun, ctx.out.log);
|
|
47
|
+
}
|
|
48
|
+
export async function runApplyCommand(ctx) {
|
|
49
|
+
const { out, options, migrationsDir } = ctx;
|
|
50
|
+
const dbUrl = readDatabaseUrlOrReport(out);
|
|
51
|
+
if (dbUrl === undefined)
|
|
52
|
+
return 1;
|
|
53
|
+
if (!migrationsDirExistsOrReport(ctx))
|
|
54
|
+
return 1;
|
|
55
|
+
const { db, close } = createDbConnection({ url: dbUrl });
|
|
56
|
+
let wiring;
|
|
57
|
+
try {
|
|
58
|
+
const result = await runMigrationsFromDir(db, migrationsDir);
|
|
59
|
+
await ensureFrameworkInfrastructureTables(db);
|
|
60
|
+
reportAppliedMigrations(out, result);
|
|
61
|
+
// Projection-rebuild for tables a freshly applied migration changed
|
|
62
|
+
// (marker NNNN_<name>.rebuild.json from `generate`). Needs the composed
|
|
63
|
+
// feature set → only when the caller passed `features` (the app bin);
|
|
64
|
+
// the dev CLI omits it and applies migrations only. Runs unconditionally
|
|
65
|
+
// (not gated on result.applied.length > 0): a persistent queue
|
|
66
|
+
// (kumiko_pending_rebuilds) survives a failed/crashed rebuild from an
|
|
67
|
+
// earlier apply, so a later apply with zero new migrations still must
|
|
68
|
+
// retry it — otherwise a failed rebuild is silently never retried,
|
|
69
|
+
// since the migration itself is already tracked applied.
|
|
70
|
+
if (options.features) {
|
|
71
|
+
// A rebuild replays applyEntityEvent, which computes bidx columns from
|
|
72
|
+
// configureBlindIndexKey/configurePiiSubjectKms — both boot-injected by
|
|
73
|
+
// run{Prod,Dev}App but never by this standalone CLI (the migrate-db
|
|
74
|
+
// initContainer). Without wiring them here, a rebuild would silently
|
|
75
|
+
// null out bidx columns and, for ciphertext, throw only once it hits
|
|
76
|
+
// the row.
|
|
77
|
+
wiring = await resolveKmsWiringAsync(process.env, {
|
|
78
|
+
logPrefix: "[kumiko schema apply]",
|
|
79
|
+
log: out.log,
|
|
80
|
+
slots: options.kmsSlots,
|
|
81
|
+
});
|
|
82
|
+
configureRebuildKms(wiring);
|
|
83
|
+
await rebuildQueuedProjections(db, ctx, options.features, result.applied);
|
|
84
|
+
}
|
|
85
|
+
return 0;
|
|
86
|
+
}
|
|
87
|
+
catch (e) {
|
|
88
|
+
out.err("");
|
|
89
|
+
out.err(` ✗ ${e instanceof Error ? (e.stack ?? e.message) : String(e)}`);
|
|
90
|
+
out.err("");
|
|
91
|
+
return 1;
|
|
92
|
+
}
|
|
93
|
+
finally {
|
|
94
|
+
await wiring?.close();
|
|
95
|
+
await close();
|
|
96
|
+
}
|
|
97
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { baselineMigrations, createDbConnection, loadMigrationsFromDir } from "../db/index.js";
|
|
2
|
+
import { describeThrown, migrationsDirExistsOrReport, readDatabaseUrlOrReport, } from "./shared.js";
|
|
3
|
+
export async function runBaselineCommand(ctx) {
|
|
4
|
+
const { out, migrationsDir } = ctx;
|
|
5
|
+
// Adopt an existing DB: mark all checked-in migrations as applied WITHOUT
|
|
6
|
+
// running their SQL (prod tables already exist — cutover from the legacy
|
|
7
|
+
// drizzle system). Afterwards the boot-gate is drift-free.
|
|
8
|
+
const dbUrl = readDatabaseUrlOrReport(out);
|
|
9
|
+
if (dbUrl === undefined)
|
|
10
|
+
return 1;
|
|
11
|
+
if (!migrationsDirExistsOrReport(ctx))
|
|
12
|
+
return 1;
|
|
13
|
+
const { db, close } = createDbConnection({ url: dbUrl });
|
|
14
|
+
try {
|
|
15
|
+
const result = await baselineMigrations(db, loadMigrationsFromDir(migrationsDir));
|
|
16
|
+
out.log("");
|
|
17
|
+
out.log(` ✓ Marked ${result.marked.length} migration(s) as applied (no SQL run):`);
|
|
18
|
+
for (const id of result.marked)
|
|
19
|
+
out.log(` + ${id}`);
|
|
20
|
+
if (result.alreadyTracked.length > 0) {
|
|
21
|
+
out.log(` (${result.alreadyTracked.length} already tracked)`);
|
|
22
|
+
}
|
|
23
|
+
out.log("");
|
|
24
|
+
return 0;
|
|
25
|
+
}
|
|
26
|
+
catch (e) {
|
|
27
|
+
out.err(` ✗ ${describeThrown(e)}`);
|
|
28
|
+
return 1;
|
|
29
|
+
}
|
|
30
|
+
finally {
|
|
31
|
+
await close();
|
|
32
|
+
}
|
|
33
|
+
}
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
import { existsSync, mkdirSync, writeFileSync } from "node:fs";
|
|
2
|
+
import { join } from "node:path";
|
|
3
|
+
import { assertValidMigrationName, generateMigration, readMigrationSqlTexts, rebuildTablesFromDiff, writeRebuildMarker, writeSnapshotJson, } from "../db/index.js";
|
|
4
|
+
import { describeThrown, loadPreviousSnapshot, loadSchemaModOrReport, nextSequenceNumber, SNAPSHOT_FILENAME, } from "./shared.js";
|
|
5
|
+
const GENERATE_USAGE = " Usage: schema generate <name>";
|
|
6
|
+
function parseGenerateName(ctx) {
|
|
7
|
+
const { argv, out } = ctx;
|
|
8
|
+
const name = argv[1];
|
|
9
|
+
if (name === "--help" || name === "-h") {
|
|
10
|
+
out.log(GENERATE_USAGE);
|
|
11
|
+
return { kind: "exit", code: 0 };
|
|
12
|
+
}
|
|
13
|
+
if (!name) {
|
|
14
|
+
out.err(GENERATE_USAGE);
|
|
15
|
+
return { kind: "exit", code: 1 };
|
|
16
|
+
}
|
|
17
|
+
// name lands unescaped in `${seq}_${name}.sql` (generateMigration) —
|
|
18
|
+
// shared allowlist blocks flag-like names, path traversal, and
|
|
19
|
+
// ENAMETOOLONG-length names.
|
|
20
|
+
try {
|
|
21
|
+
assertValidMigrationName(name);
|
|
22
|
+
}
|
|
23
|
+
catch (e) {
|
|
24
|
+
out.err(` ${describeThrown(e)}`);
|
|
25
|
+
out.err(GENERATE_USAGE);
|
|
26
|
+
return { kind: "exit", code: 1 };
|
|
27
|
+
}
|
|
28
|
+
// Trailing args (e.g. a typo'd `--dry-run` — there is no such flag) were
|
|
29
|
+
// silently ignored and the migration got written anyway. Reject them
|
|
30
|
+
// before any IO instead of pretending they did something.
|
|
31
|
+
if (argv.length > 2) {
|
|
32
|
+
out.err(` Unrecognized argument(s): ${argv.slice(2).join(" ")}`);
|
|
33
|
+
out.err(GENERATE_USAGE);
|
|
34
|
+
return { kind: "exit", code: 1 };
|
|
35
|
+
}
|
|
36
|
+
return { kind: "name", name };
|
|
37
|
+
}
|
|
38
|
+
function isEmptyMigration(result) {
|
|
39
|
+
return (result.diff.newTables.length === 0 &&
|
|
40
|
+
result.diff.changedTables.length === 0 &&
|
|
41
|
+
result.diff.droppedTables.length === 0 &&
|
|
42
|
+
result.retiredDrops.length === 0);
|
|
43
|
+
}
|
|
44
|
+
function writeMigrationFiles(migrationsDir, snapshotPath, result) {
|
|
45
|
+
if (!existsSync(migrationsDir))
|
|
46
|
+
mkdirSync(migrationsDir, { recursive: true });
|
|
47
|
+
writeFileSync(join(migrationsDir, result.filename), result.sqlContent);
|
|
48
|
+
writeSnapshotJson(snapshotPath, result.snapshot);
|
|
49
|
+
}
|
|
50
|
+
function reportGeneratedMigration(out, result, rebuildTables) {
|
|
51
|
+
out.log("");
|
|
52
|
+
out.log(` ✓ ${result.filename}`);
|
|
53
|
+
out.log(` new tables: ${result.diff.newTables.length}, changed: ${result.diff.changedTables.length}, dropped: ${result.diff.droppedTables.length}, retired framework tables dropped: ${result.retiredDrops.length}`);
|
|
54
|
+
if (rebuildTables.length > 0) {
|
|
55
|
+
out.log(` rebuild-marker: ${result.filename.replace(/\.sql$/, ".rebuild.json")} (${rebuildTables.length} table(s))`);
|
|
56
|
+
}
|
|
57
|
+
out.log("");
|
|
58
|
+
out.log(" Review, hand-edit if needed, then git add + commit. Apply via: schema apply");
|
|
59
|
+
out.log("");
|
|
60
|
+
}
|
|
61
|
+
export async function runGenerateCommand(ctx) {
|
|
62
|
+
const { out, migrationsDir } = ctx;
|
|
63
|
+
const parsed = parseGenerateName(ctx);
|
|
64
|
+
if (parsed.kind === "exit")
|
|
65
|
+
return parsed.code;
|
|
66
|
+
const schemaMod = await loadSchemaModOrReport(ctx);
|
|
67
|
+
if (schemaMod === undefined)
|
|
68
|
+
return 1;
|
|
69
|
+
const snapshotPath = join(migrationsDir, SNAPSHOT_FILENAME);
|
|
70
|
+
const prevSnapshot = loadPreviousSnapshot(snapshotPath);
|
|
71
|
+
const result = generateMigration({
|
|
72
|
+
metas: schemaMod.entityMetas,
|
|
73
|
+
prevSnapshot,
|
|
74
|
+
name: parsed.name,
|
|
75
|
+
sequenceNumber: nextSequenceNumber(migrationsDir),
|
|
76
|
+
priorMigrationsSql: readMigrationSqlTexts(migrationsDir),
|
|
77
|
+
});
|
|
78
|
+
if (isEmptyMigration(result)) {
|
|
79
|
+
out.log(" No schema changes detected — no new migration file written.");
|
|
80
|
+
return 0;
|
|
81
|
+
}
|
|
82
|
+
writeMigrationFiles(migrationsDir, snapshotPath, result);
|
|
83
|
+
// Rebuild markers are written only for incremental migrations — the initial
|
|
84
|
+
// migration (prevSnapshot===null) only creates tables, so there are no historical
|
|
85
|
+
// events to replay.
|
|
86
|
+
const rebuildTables = prevSnapshot === null ? [] : rebuildTablesFromDiff(result.diff);
|
|
87
|
+
writeRebuildMarker(migrationsDir, result.filename, rebuildTables);
|
|
88
|
+
reportGeneratedMigration(out, result, rebuildTables);
|
|
89
|
+
return 0;
|
|
90
|
+
}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { type renderTablesDdl } from "../db/index.ts";
|
|
2
|
+
import type { FeatureDefinition } from "../engine/types/feature.ts";
|
|
3
|
+
export type SchemaCliOut = {
|
|
4
|
+
readonly log: (line: string) => void;
|
|
5
|
+
readonly err: (line: string) => void;
|
|
6
|
+
};
|
|
7
|
+
export type RunSchemaCliOptions = {
|
|
8
|
+
readonly features?: undefined;
|
|
9
|
+
readonly kmsSlots?: undefined;
|
|
10
|
+
} | {
|
|
11
|
+
/** Composed app features. When given, `apply` rebuilds the projections whose
|
|
12
|
+
* tables a freshly applied migration changed (via its `.rebuild.json`
|
|
13
|
+
* marker). Omitted (dev `kumiko schema`) → no rebuild, migrations only. */
|
|
14
|
+
readonly features: readonly FeatureDefinition[];
|
|
15
|
+
/** Schema-declared Key Manager slots, `kmsSlotsOf(composedEnv.schema)`, or
|
|
16
|
+
* `[]` when the app wires none. This CLI parses no env schema, so the
|
|
17
|
+
* rebuild's KMS wiring cannot derive them itself. */
|
|
18
|
+
readonly kmsSlots: readonly string[];
|
|
19
|
+
};
|
|
20
|
+
export type SchemaCliContext = {
|
|
21
|
+
readonly argv: readonly string[];
|
|
22
|
+
readonly out: SchemaCliOut;
|
|
23
|
+
readonly options: RunSchemaCliOptions;
|
|
24
|
+
readonly schemaFile: string;
|
|
25
|
+
readonly migrationsDir: string;
|
|
26
|
+
};
|
|
27
|
+
export type SchemaSubcommandHandler = (ctx: SchemaCliContext) => Promise<number>;
|
|
28
|
+
export declare const SNAPSHOT_FILENAME = ".snapshot.json";
|
|
29
|
+
export type SchemaMod = {
|
|
30
|
+
readonly entityMetas: Parameters<typeof renderTablesDdl>[0];
|
|
31
|
+
readonly features?: unknown;
|
|
32
|
+
readonly validateBootOptions?: unknown;
|
|
33
|
+
};
|
|
34
|
+
export declare function describeThrown(e: unknown): string;
|
|
35
|
+
export declare function nextSequenceNumber(migrationsDir: string): number;
|
|
36
|
+
export declare function loadPreviousSnapshot(snapshotPath: string): import("../db/migrate-generator.ts").Snapshot | null;
|
|
37
|
+
export declare function loadSchemaModOrReport(ctx: SchemaCliContext): Promise<SchemaMod | undefined>;
|
|
38
|
+
export declare function readDatabaseUrlOrReport(out: SchemaCliOut): string | undefined;
|
|
39
|
+
export declare function migrationsDirExistsOrReport(ctx: SchemaCliContext): boolean;
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
var __rewriteRelativeImportExtension = (this && this.__rewriteRelativeImportExtension) || function (path, preserveJsx) {
|
|
2
|
+
if (typeof path === "string" && /^\.\.?\//.test(path)) {
|
|
3
|
+
return path.replace(/\.(tsx)$|((?:\.d)?)((?:\.[^./]+?)?)\.([cm]?)ts$/i, function (m, tsx, d, ext, cm) {
|
|
4
|
+
return tsx ? preserveJsx ? ".jsx" : ".js" : d && (!ext || !cm) ? m : (d + ext + "." + cm.toLowerCase() + "js");
|
|
5
|
+
});
|
|
6
|
+
}
|
|
7
|
+
return path;
|
|
8
|
+
};
|
|
9
|
+
import { existsSync, readdirSync } from "node:fs";
|
|
10
|
+
import { isPlainObject } from "@cosmicdrift/kumiko-types/type-guards";
|
|
11
|
+
import { assertUniqueTableNames, loadSnapshotJson } from "../db/index.js";
|
|
12
|
+
import { isEntityTableMeta } from "../db/table-introspection.js";
|
|
13
|
+
export const SNAPSHOT_FILENAME = ".snapshot.json";
|
|
14
|
+
export function describeThrown(e) {
|
|
15
|
+
return e instanceof Error ? e.message : String(e);
|
|
16
|
+
}
|
|
17
|
+
function tableNameHint(entry) {
|
|
18
|
+
if (isPlainObject(entry) && typeof entry["tableName"] === "string")
|
|
19
|
+
return entry["tableName"];
|
|
20
|
+
return "unknown";
|
|
21
|
+
}
|
|
22
|
+
// Single load-path for kumiko/schema.ts (512/3) — `generate` and `validate`
|
|
23
|
+
// both need ENTITY_METAS (and validate additionally wants FEATURES); this is
|
|
24
|
+
// the one place that enforces "ENTITY_METAS must be an array" so the two
|
|
25
|
+
// commands can't drift on the check or its wording. Throws — callers that
|
|
26
|
+
// want a graceful exit code (validate) catch it themselves.
|
|
27
|
+
async function loadSchemaModFromApp(schemaFile) {
|
|
28
|
+
// bun imports TS directly — no spawn needed.
|
|
29
|
+
const mod = await import(__rewriteRelativeImportExtension(schemaFile));
|
|
30
|
+
const entityMetas = mod["ENTITY_METAS"];
|
|
31
|
+
if (!Array.isArray(entityMetas)) {
|
|
32
|
+
throw new Error(`Schema file ${schemaFile} must declare \`export const ENTITY_METAS: EntityTableMeta[]\`.`);
|
|
33
|
+
}
|
|
34
|
+
const validMetas = [];
|
|
35
|
+
for (const [index, entry] of entityMetas.entries()) {
|
|
36
|
+
if (!isEntityTableMeta(entry)) {
|
|
37
|
+
throw new Error(`Schema file ${schemaFile}: ENTITY_METAS[${index}] is not an EntityTableMeta (table: ${tableNameHint(entry)}).`);
|
|
38
|
+
}
|
|
39
|
+
validMetas.push(entry);
|
|
40
|
+
}
|
|
41
|
+
assertUniqueTableNames(validMetas);
|
|
42
|
+
return {
|
|
43
|
+
entityMetas: validMetas,
|
|
44
|
+
features: mod["FEATURES"],
|
|
45
|
+
validateBootOptions: mod["VALIDATE_BOOT_OPTIONS"],
|
|
46
|
+
};
|
|
47
|
+
}
|
|
48
|
+
export function nextSequenceNumber(migrationsDir) {
|
|
49
|
+
if (!existsSync(migrationsDir))
|
|
50
|
+
return 1;
|
|
51
|
+
const files = readdirSync(migrationsDir).filter((f) => f.endsWith(".sql"));
|
|
52
|
+
let max = 0;
|
|
53
|
+
for (const f of files) {
|
|
54
|
+
const m = f.match(/^(\d+)_/);
|
|
55
|
+
if (m) {
|
|
56
|
+
const n = Number(m[1]);
|
|
57
|
+
if (n > max)
|
|
58
|
+
max = n;
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
return max + 1;
|
|
62
|
+
}
|
|
63
|
+
export function loadPreviousSnapshot(snapshotPath) {
|
|
64
|
+
return existsSync(snapshotPath) ? loadSnapshotJson(snapshotPath) : null;
|
|
65
|
+
}
|
|
66
|
+
export async function loadSchemaModOrReport(ctx) {
|
|
67
|
+
const { out, schemaFile } = ctx;
|
|
68
|
+
if (!existsSync(schemaFile)) {
|
|
69
|
+
out.err(` ${schemaFile} is missing.`);
|
|
70
|
+
out.err(" App convention: kumiko/schema.ts with");
|
|
71
|
+
out.err(" export const ENTITY_METAS: EntityTableMeta[] = [...]");
|
|
72
|
+
return undefined;
|
|
73
|
+
}
|
|
74
|
+
try {
|
|
75
|
+
return await loadSchemaModFromApp(schemaFile);
|
|
76
|
+
}
|
|
77
|
+
catch (e) {
|
|
78
|
+
out.err(` ${describeThrown(e)}`);
|
|
79
|
+
return undefined;
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
export function readDatabaseUrlOrReport(out) {
|
|
83
|
+
const dbUrl = process.env["DATABASE_URL"];
|
|
84
|
+
if (!dbUrl) {
|
|
85
|
+
out.err(" DATABASE_URL not set.");
|
|
86
|
+
return undefined;
|
|
87
|
+
}
|
|
88
|
+
return dbUrl;
|
|
89
|
+
}
|
|
90
|
+
export function migrationsDirExistsOrReport(ctx) {
|
|
91
|
+
if (existsSync(ctx.migrationsDir))
|
|
92
|
+
return true;
|
|
93
|
+
ctx.out.err(` ${ctx.migrationsDir} is missing — run schema generate <name> first.`);
|
|
94
|
+
return false;
|
|
95
|
+
}
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
import { existsSync } from "node:fs";
|
|
2
|
+
import { join } from "node:path";
|
|
3
|
+
import { createDbConnection, fetchAppliedMigrations, findCommentedDropTables, isRetiredFrameworkTable, loadMigrationsFromDir, readMigrationSqlTexts, tableExists, } from "../db/index.js";
|
|
4
|
+
import { describeThrown, loadPreviousSnapshot, readDatabaseUrlOrReport, SNAPSHOT_FILENAME, } from "./shared.js";
|
|
5
|
+
// A table that a migration only drops as a commented DESTRUCTIVE marker and
|
|
6
|
+
// that the snapshot no longer has is gone on paper but still in the live DB.
|
|
7
|
+
async function reportLeftoverDroppedTables(db, migrationsDir, out) {
|
|
8
|
+
const snapshot = loadPreviousSnapshot(join(migrationsDir, SNAPSHOT_FILENAME));
|
|
9
|
+
const leftovers = [];
|
|
10
|
+
for (const tableName of findCommentedDropTables(readMigrationSqlTexts(migrationsDir), snapshot)) {
|
|
11
|
+
if (await tableExists(db, tableName))
|
|
12
|
+
leftovers.push(tableName);
|
|
13
|
+
}
|
|
14
|
+
// skip: nothing left over, nothing to report
|
|
15
|
+
if (leftovers.length === 0)
|
|
16
|
+
return;
|
|
17
|
+
out.log(" Tables dropped only as a commented DESTRUCTIVE marker but still in the database:");
|
|
18
|
+
for (const tableName of leftovers) {
|
|
19
|
+
out.log(isRetiredFrameworkTable(tableName)
|
|
20
|
+
? ` ! ${tableName} — retired framework table: the next \`schema generate <name>\` creates the drop`
|
|
21
|
+
: ` ! ${tableName} — app table: after a backup, write a new migration with the drop`);
|
|
22
|
+
}
|
|
23
|
+
out.log("");
|
|
24
|
+
}
|
|
25
|
+
async function fetchAppliedMigrationIds(db) {
|
|
26
|
+
// On a fresh database where `kumiko schema apply` has never run, the tracking table is
|
|
27
|
+
// absent, which means "nothing applied". Connection and permission errors must not
|
|
28
|
+
// be swallowed (false pending results would hide the problem) — tableExists checks
|
|
29
|
+
// only for existence, while all other errors propagate.
|
|
30
|
+
const trackingExists = await tableExists(db, "_kumiko_migrations");
|
|
31
|
+
return trackingExists
|
|
32
|
+
? new Set((await fetchAppliedMigrations(db)).map((a) => a.id))
|
|
33
|
+
: new Set();
|
|
34
|
+
}
|
|
35
|
+
export async function runStatusCommand(ctx) {
|
|
36
|
+
const { out, migrationsDir } = ctx;
|
|
37
|
+
const dbUrl = readDatabaseUrlOrReport(out);
|
|
38
|
+
if (dbUrl === undefined)
|
|
39
|
+
return 1;
|
|
40
|
+
if (!existsSync(migrationsDir)) {
|
|
41
|
+
out.log(" No kumiko/migrations/ — the app is still on the legacy drizzle path.");
|
|
42
|
+
return 0;
|
|
43
|
+
}
|
|
44
|
+
const local = loadMigrationsFromDir(migrationsDir);
|
|
45
|
+
const { db, close } = createDbConnection({ url: dbUrl });
|
|
46
|
+
try {
|
|
47
|
+
const applied = await fetchAppliedMigrationIds(db);
|
|
48
|
+
out.log("");
|
|
49
|
+
out.log(` ${local.length} migrations in ${migrationsDir}:`);
|
|
50
|
+
for (const m of local)
|
|
51
|
+
out.log(` ${applied.has(m.id) ? "✓" : " "} ${m.id}`);
|
|
52
|
+
const pending = local.filter((m) => !applied.has(m.id)).length;
|
|
53
|
+
out.log("");
|
|
54
|
+
out.log(` ${applied.size} applied, ${pending} pending.`);
|
|
55
|
+
out.log("");
|
|
56
|
+
await reportLeftoverDroppedTables(db, migrationsDir, out);
|
|
57
|
+
return pending === 0 ? 0 : 1;
|
|
58
|
+
}
|
|
59
|
+
catch (e) {
|
|
60
|
+
// Message only, never dbUrl: it can carry the password.
|
|
61
|
+
out.err(` ✗ schema status failed: ${describeThrown(e)}`);
|
|
62
|
+
out.err(' Check that DATABASE_URL is reachable and the database exists (the scaffold\'s docker-compose creates "app").');
|
|
63
|
+
return 1;
|
|
64
|
+
}
|
|
65
|
+
finally {
|
|
66
|
+
try {
|
|
67
|
+
await close();
|
|
68
|
+
}
|
|
69
|
+
catch {
|
|
70
|
+
// The connection already failed and was reported above; a failing close must not throw again.
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import type { ValidateBootOptions } from "../engine/boot-validator.ts";
|
|
2
|
+
import type { FeatureDefinition } from "../engine/types/feature.ts";
|
|
3
|
+
export declare function withFileStoragePresence(env: Readonly<Record<string, string | undefined>>): Record<string, string | undefined>;
|
|
4
|
+
export declare function parseValidateBootOptions(raw: unknown): ValidateBootOptions;
|
|
5
|
+
export declare function featureDefinitionsOf(value: unknown): readonly FeatureDefinition[] | undefined;
|
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
import { isPlainObject } from "@cosmicdrift/kumiko-types/type-guards";
|
|
2
|
+
import { FILE_STORAGE_PROVIDER_BOOT_SENTINEL, FILE_STORAGE_PROVIDER_ENV, } from "../engine/extension-names.js";
|
|
3
|
+
// `validate` only sees the composed FEATURES. The file provider normally comes from
|
|
4
|
+
// runProdApp's `fileStorage` option, which defaults FILE_STORAGE_PROVIDER at boot, so
|
|
5
|
+
// an unset variable here is no misconfiguration. The deploy env is checked by the real boot.
|
|
6
|
+
export function withFileStoragePresence(env) {
|
|
7
|
+
return env[FILE_STORAGE_PROVIDER_ENV] === undefined
|
|
8
|
+
? { ...env, [FILE_STORAGE_PROVIDER_ENV]: FILE_STORAGE_PROVIDER_BOOT_SENTINEL }
|
|
9
|
+
: { ...env };
|
|
10
|
+
}
|
|
11
|
+
function isStringSet(value) {
|
|
12
|
+
return value instanceof Set && [...value].every((entry) => typeof entry === "string");
|
|
13
|
+
}
|
|
14
|
+
function isNonEmptyStringArray(value) {
|
|
15
|
+
return Array.isArray(value) && value.every((entry) => typeof entry === "string" && entry !== "");
|
|
16
|
+
}
|
|
17
|
+
function isBoolean(value) {
|
|
18
|
+
return typeof value === "boolean";
|
|
19
|
+
}
|
|
20
|
+
function validateBootOptionsError(detail) {
|
|
21
|
+
return new Error(`kumiko/schema.ts: \`VALIDATE_BOOT_OPTIONS\` ${detail}`);
|
|
22
|
+
}
|
|
23
|
+
function readOptionalOption(raw, key, isValid, expected) {
|
|
24
|
+
const value = Reflect.get(raw, key);
|
|
25
|
+
if (value === undefined)
|
|
26
|
+
return undefined;
|
|
27
|
+
if (!isValid(value))
|
|
28
|
+
throw validateBootOptionsError(`\`${key}\` must be ${expected}.`);
|
|
29
|
+
return value;
|
|
30
|
+
}
|
|
31
|
+
// Boundary check for `export const VALIDATE_BOOT_OPTIONS` in kumiko/schema.ts.
|
|
32
|
+
// Only the options that change what validateBoot reports are honoured; `env` and
|
|
33
|
+
// `entityFieldCipher` are runner-injected and deliberately ignored here.
|
|
34
|
+
export function parseValidateBootOptions(raw) {
|
|
35
|
+
if (raw === undefined)
|
|
36
|
+
return {};
|
|
37
|
+
if (typeof raw !== "object" || raw === null || Array.isArray(raw)) {
|
|
38
|
+
throw validateBootOptionsError("must be an object (ValidateBootOptions).");
|
|
39
|
+
}
|
|
40
|
+
const navAllowlist = readOptionalOption(raw, "navAllowlist", isStringSet, "a Set<string>");
|
|
41
|
+
const navAllowlistExempt = readOptionalOption(raw, "navAllowlistExempt", isStringSet, "a Set<string>");
|
|
42
|
+
const warnOnUniqueAccessRoles = readOptionalOption(raw, "warnOnUniqueAccessRoles", isBoolean, "a boolean");
|
|
43
|
+
const requiredLocales = readOptionalOption(raw, "requiredLocales", isNonEmptyStringArray, "an array of non-empty strings");
|
|
44
|
+
return {
|
|
45
|
+
...(requiredLocales !== undefined && { requiredLocales }),
|
|
46
|
+
...(navAllowlist !== undefined && { navAllowlist }),
|
|
47
|
+
...(navAllowlistExempt !== undefined && { navAllowlistExempt }),
|
|
48
|
+
...(warnOnUniqueAccessRoles !== undefined && { warnOnUniqueAccessRoles }),
|
|
49
|
+
};
|
|
50
|
+
}
|
|
51
|
+
// Every non-optional top-level property of FeatureDefinition, grouped by the runtime shape the
|
|
52
|
+
// boot validators rely on; a hand-built entry missing one would crash far from the cause.
|
|
53
|
+
const FEATURE_ARRAY_KEYS = [
|
|
54
|
+
"requires",
|
|
55
|
+
"optionalRequires",
|
|
56
|
+
"configSeeds",
|
|
57
|
+
"extensionUsages",
|
|
58
|
+
"extensionSelectors",
|
|
59
|
+
"bootChecks",
|
|
60
|
+
"referenceData",
|
|
61
|
+
"configReads",
|
|
62
|
+
"authClaimsHooks",
|
|
63
|
+
];
|
|
64
|
+
const FEATURE_SET_KEYS = [
|
|
65
|
+
"requiredProjections",
|
|
66
|
+
"requiredSteps",
|
|
67
|
+
"exposedApis",
|
|
68
|
+
"usedApis",
|
|
69
|
+
];
|
|
70
|
+
const FEATURE_RECORD_KEYS = [
|
|
71
|
+
"relations",
|
|
72
|
+
"writeHandlers",
|
|
73
|
+
"queryHandlers",
|
|
74
|
+
"streamHandlers",
|
|
75
|
+
"translations",
|
|
76
|
+
"configKeys",
|
|
77
|
+
"jobs",
|
|
78
|
+
"registrarExtensions",
|
|
79
|
+
"notifications",
|
|
80
|
+
"events",
|
|
81
|
+
"eventMigrations",
|
|
82
|
+
"handlerEntityMappings",
|
|
83
|
+
"metrics",
|
|
84
|
+
"secretKeys",
|
|
85
|
+
"secretNamespaces",
|
|
86
|
+
"projections",
|
|
87
|
+
"multiStreamProjections",
|
|
88
|
+
"claimKeys",
|
|
89
|
+
"screens",
|
|
90
|
+
"navs",
|
|
91
|
+
"workspaces",
|
|
92
|
+
"httpRoutes",
|
|
93
|
+
"webSocketRoutes",
|
|
94
|
+
"storeTables",
|
|
95
|
+
];
|
|
96
|
+
function firstFeatureShapeViolation(entry) {
|
|
97
|
+
if (!isPlainObject(entry))
|
|
98
|
+
return "entry must be an object";
|
|
99
|
+
if (typeof entry["name"] !== "string")
|
|
100
|
+
return "`name` must be a string";
|
|
101
|
+
if (typeof entry["systemScope"] !== "boolean")
|
|
102
|
+
return "`systemScope` must be a boolean";
|
|
103
|
+
const arrayKey = FEATURE_ARRAY_KEYS.find((key) => !Array.isArray(entry[key]));
|
|
104
|
+
if (arrayKey)
|
|
105
|
+
return `\`${arrayKey}\` must be an array`;
|
|
106
|
+
const setKey = FEATURE_SET_KEYS.find((key) => !(entry[key] instanceof Set));
|
|
107
|
+
if (setKey)
|
|
108
|
+
return `\`${setKey}\` must be a Set`;
|
|
109
|
+
const recordKey = FEATURE_RECORD_KEYS.find((key) => !isPlainObject(entry[key]));
|
|
110
|
+
if (recordKey)
|
|
111
|
+
return `\`${recordKey}\` must be an object`;
|
|
112
|
+
return undefined;
|
|
113
|
+
}
|
|
114
|
+
function isFeatureDefinitionShape(entry) {
|
|
115
|
+
return firstFeatureShapeViolation(entry) === undefined;
|
|
116
|
+
}
|
|
117
|
+
// FEATURES comes from the app's schema module; one malformed entry would make
|
|
118
|
+
// validateBoot fail with an unrelated error far from the cause, so name the index here.
|
|
119
|
+
export function featureDefinitionsOf(value) {
|
|
120
|
+
if (!Array.isArray(value))
|
|
121
|
+
return undefined;
|
|
122
|
+
const definitions = [];
|
|
123
|
+
for (const [index, entry] of value.entries()) {
|
|
124
|
+
if (!isFeatureDefinitionShape(entry)) {
|
|
125
|
+
throw new Error(`FEATURES[${index}] is not a FeatureDefinition: ${firstFeatureShapeViolation(entry)}`);
|
|
126
|
+
}
|
|
127
|
+
definitions.push(entry);
|
|
128
|
+
}
|
|
129
|
+
return definitions;
|
|
130
|
+
}
|