@lunora/cli 1.0.0-alpha.21 → 1.0.0-alpha.211
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/LICENSE.md +33 -0
- package/README.md +1 -1
- package/__assets__/package-og.svg +1 -1
- package/dist/bin.mjs +2 -10
- package/dist/index.d.mts +745 -341
- package/dist/index.d.ts +745 -341
- package/dist/index.mjs +1 -19
- package/dist/packem_chunks/handler.mjs +1 -150
- package/dist/packem_chunks/handler10.mjs +4 -22
- package/dist/packem_chunks/handler11.mjs +2 -192
- package/dist/packem_chunks/handler12.mjs +1 -131
- package/dist/packem_chunks/handler13.mjs +1 -65
- package/dist/packem_chunks/handler14.mjs +1 -58
- package/dist/packem_chunks/handler15.mjs +1 -79
- package/dist/packem_chunks/handler16.mjs +3 -43
- package/dist/packem_chunks/handler17.mjs +1 -105
- package/dist/packem_chunks/handler18.mjs +1 -170
- package/dist/packem_chunks/handler19.mjs +7 -89
- package/dist/packem_chunks/handler2.mjs +2 -114
- package/dist/packem_chunks/handler20.mjs +1 -94
- package/dist/packem_chunks/handler21.mjs +2 -311
- package/dist/packem_chunks/handler22.mjs +3 -0
- package/dist/packem_chunks/handler23.mjs +3 -0
- package/dist/packem_chunks/handler24.mjs +1 -0
- package/dist/packem_chunks/handler25.mjs +99 -0
- package/dist/packem_chunks/handler26.mjs +10 -0
- package/dist/packem_chunks/handler3.mjs +1 -204
- package/dist/packem_chunks/handler4.mjs +1 -33
- package/dist/packem_chunks/handler5.mjs +1 -49
- package/dist/packem_chunks/handler6.mjs +1 -91
- package/dist/packem_chunks/handler7.mjs +3 -42
- package/dist/packem_chunks/handler8.mjs +1 -174
- package/dist/packem_chunks/handler9.mjs +1 -16
- package/dist/packem_chunks/planDevCommand.mjs +7 -500
- package/dist/packem_chunks/runCodegenCommand.mjs +4 -52
- package/dist/packem_chunks/runDeployCommand.mjs +1 -504
- package/dist/packem_chunks/runInitCommand.mjs +118 -1383
- package/dist/packem_chunks/runMigrateGenerateCommand.mjs +9 -395
- package/dist/packem_chunks/runResetCommand.mjs +1 -41
- package/dist/packem_chunks/runRpcCommand.mjs +1 -68
- package/dist/packem_shared/COMMANDS-BXbrW8dd.mjs +1 -0
- package/dist/packem_shared/DEFAULT_IMPORT_BATCH_SIZE-Cf8ZymM1.mjs +1 -0
- package/dist/packem_shared/admin-token-rxXZbVMZ.mjs +1 -0
- package/dist/packem_shared/admin-url-Cil3Or6N.mjs +1 -0
- package/dist/packem_shared/advisory-gate-Cl8IEFIj.mjs +1 -0
- package/dist/packem_shared/api-spec-lYyq4vL6.mjs +1 -0
- package/dist/packem_shared/binding-manifest-file-CQ1eQYy1.mjs +2 -0
- package/dist/packem_shared/buildRegistryIndex-Zi3bBqpc.mjs +1 -0
- package/dist/packem_shared/cli-C37AI4tr.mjs +3 -0
- package/dist/packem_shared/codegen-error-AmH54ofi.mjs +3 -0
- package/dist/packem_shared/command-DwC11Cwe.mjs +1 -0
- package/dist/packem_shared/commands-BNKj7r1R.mjs +19 -0
- package/dist/packem_shared/createLogger-hGafwf-3.mjs +2 -0
- package/dist/packem_shared/createRecordingSpawner-DJlNacZ6.mjs +1 -0
- package/dist/packem_shared/deploy-target-D9GPy_tq.mjs +1 -0
- package/dist/packem_shared/diffSnapshots-CIOFQN_a.mjs +5 -0
- package/dist/packem_shared/docker-DpVxvYpL.mjs +1 -0
- package/dist/packem_shared/import-CdHdZRjj.mjs +12 -0
- package/dist/packem_shared/insertSchemaExtension-DY4pA8wE.mjs +8 -0
- package/dist/packem_shared/lint-ignore-report-DKZagpqk.mjs +2 -0
- package/dist/packem_shared/open-url-EnKy--w-.mjs +1 -0
- package/dist/packem_shared/output-format-DfogXx0p.mjs +2 -0
- package/dist/packem_shared/parseManifest-CwPTKdtS.mjs +1 -0
- package/dist/packem_shared/path-containment-CgxYZggb.mjs +1 -0
- package/dist/packem_shared/platform-diagnostics-uOXqysk3.mjs +4 -0
- package/dist/packem_shared/prompt-cancelled-C8Sj7OqI.mjs +1 -0
- package/dist/packem_shared/resolve-DZAGzg67.mjs +1 -0
- package/dist/packem_shared/resolve-target-BRvw8Pf7.mjs +1 -0
- package/dist/packem_shared/runAddCommand-D1Dj8-pK.mjs +1 -0
- package/dist/packem_shared/runExportCommand-DmXKEWSq.mjs +5 -0
- package/dist/packem_shared/schema-drift-gate-DARCKocg.mjs +1 -0
- package/dist/packem_shared/schemaIrToSnapshot-qpRoV7HY.mjs +1 -0
- package/dist/packem_shared/shared-D-zCOmgY.mjs +1 -0
- package/dist/packem_shared/storage-wIUel5Az.mjs +1 -0
- package/dist/packem_shared/tui-prompts-Dd0pDuNr.mjs +4 -0
- package/dist/packem_shared/vectorize-metadata-DbziRKpX.mjs +1 -0
- package/dist/packem_shared/wrangler-name-Dsk5K1f-.mjs +1 -0
- package/dist/packem_shared/wrangler-secrets-CCdt0mUl.mjs +1 -0
- package/package.json +39 -17
- package/skills/README.md +35 -17
- package/skills/lunora/SKILL.md +65 -9
- package/skills/lunora-functions/SKILL.md +38 -3
- package/skills/lunora-migration-helper/SKILL.md +70 -17
- package/skills/lunora-performance-audit/SKILL.md +36 -6
- package/skills/lunora-quickstart/SKILL.md +90 -24
- package/skills/lunora-realtime/SKILL.md +58 -30
- package/dist/packem_shared/COMMANDS-D3h9Iwvl.mjs +0 -944
- package/dist/packem_shared/DEFAULT_IMPORT_BATCH_SIZE-Ck-2bU08.mjs +0 -244
- package/dist/packem_shared/admin-url-4UzT-CI4.mjs +0 -19
- package/dist/packem_shared/api-spec-CtA6ilu4.mjs +0 -13
- package/dist/packem_shared/buildRegistryIndex-BcYe607_.mjs +0 -38
- package/dist/packem_shared/command-BC30oSBW.mjs +0 -14
- package/dist/packem_shared/commands-hl0mRqqg.mjs +0 -845
- package/dist/packem_shared/createLogger-B40gPzQo.mjs +0 -78
- package/dist/packem_shared/createRecordingSpawner-DxI3mebw.mjs +0 -43
- package/dist/packem_shared/detect-package-manager-DYp7n3mJ.mjs +0 -61
- package/dist/packem_shared/diffSnapshots-BeDvvNiF.mjs +0 -161
- package/dist/packem_shared/docker-hMQ97KSQ.mjs +0 -21
- package/dist/packem_shared/insertSchemaExtension-DAqbfr9Z.mjs +0 -64
- package/dist/packem_shared/open-url-Dfq6fAyT.mjs +0 -41
- package/dist/packem_shared/output-format-wUvAN6AL.mjs +0 -17
- package/dist/packem_shared/parseArgs-YXFuKdEk.mjs +0 -56
- package/dist/packem_shared/parseManifest--vZf2FY1.mjs +0 -94
- package/dist/packem_shared/resolve-target-qbsJ_5sF.mjs +0 -16
- package/dist/packem_shared/runAddCommand-vJdgiR5t.mjs +0 -4
- package/dist/packem_shared/schema-drift-gate-BtBt0as0.mjs +0 -79
- package/dist/packem_shared/schemaIrToSnapshot-DdsljJT-.mjs +0 -43
- package/dist/packem_shared/storage-B7hHSTZP.mjs +0 -84
- package/dist/packem_shared/tui-prompts-M6OWsuyw.mjs +0 -663
- package/dist/packem_shared/wrangler-name-cy4yhm9j.mjs +0 -12
package/dist/index.d.mts
CHANGED
|
@@ -1,33 +1,33 @@
|
|
|
1
|
-
import { CodegenOptions, SchemaIR } from '@lunora/codegen';
|
|
2
|
-
import '@
|
|
3
|
-
import {
|
|
4
|
-
export { REQUIRED_COMPATIBILITY_DATE, REQUIRED_FLAG, type WranglerProjectValidationOptions as WranglerValidationOptions, type WranglerValidationReport, type WranglerProjectValidationResult as WranglerValidationResult, validateWranglerProject as validateWrangler, validateWranglerConfig } from '@lunora/config';
|
|
1
|
+
import { CodegenOptions, Finding, SchemaIR } from '@lunora/codegen';
|
|
2
|
+
import { ensureDevVariables, ensureDevVarsExample, fillDevSecrets, LintTool, LintIgnoreOutcome, PackageManager, PackageManagerProbe } from '@lunora/config';
|
|
3
|
+
import { materializeRemoteWranglerConfig } from '@lunora/config/cloudflare';
|
|
4
|
+
export { REQUIRED_COMPATIBILITY_DATE, REQUIRED_FLAG, type WranglerProjectValidationOptions as WranglerValidationOptions, type WranglerValidationReport, type WranglerProjectValidationResult as WranglerValidationResult, validateWranglerProject as validateWrangler, validateWranglerConfig } from '@lunora/config/cloudflare';
|
|
5
5
|
/** Every command name the CLI registers (drives the `CommandName` type + tests). */
|
|
6
|
-
declare const COMMANDS: readonly ["init", "add", "dev", "codegen", "build", "deploy", "containers", "prepare", "link", "deployments", "logs", "run", "insights", "reset", "migrate", "export", "import", "seed", "backup", "verify", "info", "doctor", "env", "analyze", "view", "docs", "registry", "rules"];
|
|
6
|
+
declare const COMMANDS: readonly ["init", "add", "dev", "codegen", "build", "deploy", "containers", "prepare", "link", "deployments", "logs", "run", "insights", "reset", "migrate", "export", "import", "seed", "backup", "eval", "verify", "info", "doctor", "env", "analyze", "view", "docs", "registry", "rules", "mcp"];
|
|
7
7
|
type CommandName = (typeof COMMANDS)[number];
|
|
8
8
|
declare const VERSION: string;
|
|
9
9
|
interface RunCliOptions {
|
|
10
10
|
argv?: ReadonlyArray<string>;
|
|
11
11
|
cwd?: string;
|
|
12
12
|
/**
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
13
|
+
* Inject a console-like logger so callers (tests) can capture cerebro's
|
|
14
|
+
* help / version / usage rendering. Omitted in production, where cerebro
|
|
15
|
+
* uses its default stdout/stderr logger.
|
|
16
|
+
*/
|
|
17
17
|
logger?: Console;
|
|
18
18
|
}
|
|
19
19
|
/**
|
|
20
|
-
* Run the CLI and resolve to the process exit code. cerebro handles help,
|
|
21
|
-
* version, usage, and unknown commands (the latter throws, caught here as 1).
|
|
22
|
-
* `shouldExitProcess: false` keeps the process alive so callers/tests read the
|
|
23
|
-
* captured exit code.
|
|
24
|
-
*/
|
|
20
|
+
* Run the CLI and resolve to the process exit code. cerebro handles help,
|
|
21
|
+
* version, usage, and unknown commands (the latter throws, caught here as 1).
|
|
22
|
+
* `shouldExitProcess: false` keeps the process alive so callers/tests read the
|
|
23
|
+
* captured exit code.
|
|
24
|
+
*/
|
|
25
25
|
declare const runCli: (options?: RunCliOptions) => Promise<number>;
|
|
26
26
|
/**
|
|
27
|
-
* The `--api-spec` flag's accepted values, mirroring `@lunora/codegen`'s
|
|
28
|
-
* `CodegenOptions["apiSpec"]`. `"openapi"` (the default) emits `openapi.json`;
|
|
29
|
-
* `"openrpc"` emits `openrpc.json`; `"both"` emits both; `"none"` emits neither.
|
|
30
|
-
*/
|
|
27
|
+
* The `--api-spec` flag's accepted values, mirroring `@lunora/codegen`'s
|
|
28
|
+
* `CodegenOptions["apiSpec"]`. `"openapi"` (the default) emits `openapi.json`;
|
|
29
|
+
* `"openrpc"` emits `openrpc.json`; `"both"` emits both; `"none"` emits neither.
|
|
30
|
+
*/
|
|
31
31
|
type ApiSpec = NonNullable<CodegenOptions["apiSpec"]>;
|
|
32
32
|
interface Logger {
|
|
33
33
|
debug?: (message: string) => void;
|
|
@@ -37,11 +37,11 @@ interface Logger {
|
|
|
37
37
|
warn: (message: string) => void;
|
|
38
38
|
}
|
|
39
39
|
/**
|
|
40
|
-
* Narrowed view over the pail instance. `createPail` returns an intersection
|
|
41
|
-
* type that includes a constructor signature and `(...args: any[])` logger
|
|
42
|
-
* overloads, which the type-aware linter cannot safely resolve. We only ever
|
|
43
|
-
* call the level methods with a string, so we describe exactly that surface.
|
|
44
|
-
*/
|
|
40
|
+
* Narrowed view over the pail instance. `createPail` returns an intersection
|
|
41
|
+
* type that includes a constructor signature and `(...args: any[])` logger
|
|
42
|
+
* overloads, which the type-aware linter cannot safely resolve. We only ever
|
|
43
|
+
* call the level methods with a string, so we describe exactly that surface.
|
|
44
|
+
*/
|
|
45
45
|
interface PailLogger {
|
|
46
46
|
debug: (message: string) => void;
|
|
47
47
|
error: (message: string) => void;
|
|
@@ -51,25 +51,12 @@ interface PailLogger {
|
|
|
51
51
|
}
|
|
52
52
|
declare const createLogger: () => Logger;
|
|
53
53
|
/**
|
|
54
|
-
*
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
|
|
59
|
-
*/
|
|
60
|
-
/**
|
|
61
|
-
* Direct access to the underlying pail instance for advanced use-cases.
|
|
62
|
-
* A Proxy keeps the public `pail` binding lazy: the real pail is only
|
|
63
|
-
* constructed on first property access, so importing this module (and thus
|
|
64
|
-
* the package barrel) stays side-effect-free.
|
|
65
|
-
*/
|
|
54
|
+
* Direct access to the underlying pail instance for advanced use-cases.
|
|
55
|
+
* A Proxy keeps the public `pail` binding lazy: the real pail is only
|
|
56
|
+
* constructed on first property access, so importing this module (and thus
|
|
57
|
+
* the package barrel) stays side-effect-free.
|
|
58
|
+
*/
|
|
66
59
|
declare const pail: PailLogger;
|
|
67
|
-
/**
|
|
68
|
-
* Emit a badged step line through the shared pail (the `init` flow's off-TTY
|
|
69
|
-
* fallback for the create-astro-style transcript). The `message` may contain
|
|
70
|
-
* newlines — `LunoraReporter` indents continuation lines under the badge so a
|
|
71
|
-
* dimmed answer sits below its question.
|
|
72
|
-
*/
|
|
73
60
|
interface CodegenCommandOptions {
|
|
74
61
|
/** Which API spec(s) to emit. Defaults to codegen's `"openapi"` when omitted. */
|
|
75
62
|
apiSpec?: ApiSpec;
|
|
@@ -77,33 +64,43 @@ interface CodegenCommandOptions {
|
|
|
77
64
|
/** Output format: `pretty` (default) or `json`. */
|
|
78
65
|
format?: string;
|
|
79
66
|
logger: Logger;
|
|
67
|
+
/**
|
|
68
|
+
* Fail the run when any ERROR-level advisory is reported. Defaults to CI
|
|
69
|
+
* detection so a local `lunora codegen` stays advisory while a pipeline
|
|
70
|
+
* gates on it; `--no-strict-advisories` forces it off either way.
|
|
71
|
+
*/
|
|
72
|
+
strictAdvisories?: boolean;
|
|
73
|
+
/** Deploy target the emitted `ctx.*` surface is tailored to. Resolved by the caller; falls back to `"target"` in `lunora.json`, then `"cloudflare"`. */
|
|
74
|
+
target?: string;
|
|
80
75
|
}
|
|
81
76
|
interface CodegenCommandResult {
|
|
82
77
|
advisories: ReadonlyArray<{
|
|
83
78
|
detail: string;
|
|
84
|
-
level:
|
|
79
|
+
level: Finding["level"];
|
|
85
80
|
name: string;
|
|
86
81
|
remediation: string;
|
|
87
82
|
}>;
|
|
88
83
|
cronTriggers: ReadonlyArray<string>;
|
|
89
|
-
/** Set when the run
|
|
84
|
+
/** Set when the run failed: an invalid `--format`, an unregistered target, or an error-level platform diagnostic. */
|
|
90
85
|
error?: string;
|
|
86
|
+
/** ERROR-level advisories that made the run fail, when strict mode is on. */
|
|
87
|
+
failedAdvisories: number;
|
|
91
88
|
outputDirectory: string;
|
|
92
89
|
}
|
|
93
90
|
declare const runCodegenCommand: (options: CodegenCommandOptions) => CodegenCommandResult;
|
|
94
|
-
/** `lunora codegen` handler (lazy-loaded via the command's `loader`). */
|
|
95
|
-
/** Rows per HTTP request when importing. Convex uses ~500; same here. */
|
|
96
|
-
declare const DEFAULT_IMPORT_BATCH_SIZE = 500;
|
|
97
91
|
/**
|
|
98
|
-
* Minimal projection of `globalThis.fetch` for the
|
|
99
|
-
*
|
|
100
|
-
*
|
|
101
|
-
|
|
92
|
+
* Minimal projection of `globalThis.fetch` for the transfer commands: `body` is
|
|
93
|
+
* exposed as a stream-iterable (the export path pipes it) and accepts bytes (the
|
|
94
|
+
* blob path uploads them). The JSON-only commands use the narrower `FetchLike`
|
|
95
|
+
* in `../run/handler` instead.
|
|
96
|
+
*/
|
|
102
97
|
type StreamingFetchLike = (input: string, init?: {
|
|
103
|
-
body?: string;
|
|
98
|
+
body?: string | Uint8Array;
|
|
104
99
|
headers?: Record<string, string>;
|
|
105
100
|
method?: string;
|
|
106
101
|
}) => Promise<{
|
|
102
|
+
/** Optional: only the storage transfer reads raw bytes, and only real `fetch` needs to supply it. */
|
|
103
|
+
arrayBuffer?: () => Promise<ArrayBuffer>;
|
|
107
104
|
body: ReadableStream<Uint8Array> | null;
|
|
108
105
|
json: () => Promise<unknown>;
|
|
109
106
|
ok: boolean;
|
|
@@ -132,11 +129,82 @@ interface ExportCommandResult {
|
|
|
132
129
|
rows: number;
|
|
133
130
|
}
|
|
134
131
|
/**
|
|
135
|
-
* Stream an export. The worker emits NDJSON; we count newlines as we go and
|
|
136
|
-
* pipe straight to the output sink, so a 10M-row export doesn't materialise
|
|
137
|
-
* the body in memory.
|
|
138
|
-
*/
|
|
132
|
+
* Stream an export. The worker emits NDJSON; we count newlines as we go and
|
|
133
|
+
* pipe straight to the output sink, so a 10M-row export doesn't materialise
|
|
134
|
+
* the body in memory.
|
|
135
|
+
*/
|
|
139
136
|
declare const runExportCommand: (options: ExportCommandOptions) => Promise<ExportCommandResult>;
|
|
137
|
+
/** One row-scoped failure as the admin import endpoint reports it. */
|
|
138
|
+
interface ImportRowError {
|
|
139
|
+
code: string;
|
|
140
|
+
line: number;
|
|
141
|
+
message: string;
|
|
142
|
+
table: string;
|
|
143
|
+
}
|
|
144
|
+
/**
|
|
145
|
+
* One SHARD the fan-out never reached, as the admin import endpoint reports it.
|
|
146
|
+
*
|
|
147
|
+
* Distinct from {@link ImportRowError}: the rows a dead shard owned contribute
|
|
148
|
+
* to neither `inserted` nor `errors`, so an unknown slice of the batch is simply
|
|
149
|
+
* missing. The endpoint answers 207 Multi-Status when this array is non-empty.
|
|
150
|
+
*/
|
|
151
|
+
interface ImportShardFailure {
|
|
152
|
+
message: string;
|
|
153
|
+
shardKey: string;
|
|
154
|
+
timedOut: boolean;
|
|
155
|
+
}
|
|
156
|
+
/**
|
|
157
|
+
* The sources `--from` accepts.
|
|
158
|
+
*
|
|
159
|
+
* Only the two that cannot be detected. A Convex snapshot announces itself (a
|
|
160
|
+
* directory of `<table>/documents.jsonl`, or a `.zip` of one) and anything else
|
|
161
|
+
* is NDJSON, so naming those would advertise a control this does not implement:
|
|
162
|
+
* `--from ndjson` against a Convex export would have to either refuse it or
|
|
163
|
+
* silently import it as Convex, and the second is what an unhonoured flag
|
|
164
|
+
* actually did.
|
|
165
|
+
*/
|
|
166
|
+
declare const IMPORT_SOURCE_NAMES: readonly ["firebase", "supabase"];
|
|
167
|
+
type ImportSourceName = (typeof IMPORT_SOURCE_NAMES)[number];
|
|
168
|
+
/**
|
|
169
|
+
* The storage-reference rewrite: turning a Convex storage id into the
|
|
170
|
+
* content-hash R2 key its blob was migrated to.
|
|
171
|
+
*
|
|
172
|
+
* Split out of `./storage-mapping` (which owns the mapping *file*) because it
|
|
173
|
+
* has two callers that must never diverge — the import rewrite and `--scan`,
|
|
174
|
+
* which runs this same walk as a dry run to propose the mapping. A detector
|
|
175
|
+
* that proposed columns the rewrite would not touch, or missed ones it would,
|
|
176
|
+
* is worse than no detector.
|
|
177
|
+
*/
|
|
178
|
+
/** One reference the walk could not rewrite, with where it was found. */
|
|
179
|
+
interface UnresolvedStorageReference {
|
|
180
|
+
column: string;
|
|
181
|
+
storageId: string;
|
|
182
|
+
table: string;
|
|
183
|
+
}
|
|
184
|
+
/**
|
|
185
|
+
* What a run's storage references resolved to. The two failure buckets are
|
|
186
|
+
* deliberately separate, because they are not the same problem and do not have
|
|
187
|
+
* the same remedy:
|
|
188
|
+
*
|
|
189
|
+
* `unmigrated` is a reference to a blob that does not exist — the export omitted
|
|
190
|
+
* it, or `--include-file-storage` was not passed. Nothing the operator writes in
|
|
191
|
+
* a mapping file can fix it, and the data is broken after import, so it fails
|
|
192
|
+
* `--verify`.
|
|
193
|
+
*
|
|
194
|
+
* `ambiguous` is a string that exactly matches a blob that *did* migrate, sitting
|
|
195
|
+
* in a column the mapping does not name. It may be a storage reference the
|
|
196
|
+
* mapping forgot, or it may be user text that happens to equal an id. Failing the
|
|
197
|
+
* run on a coincidence is not defensible, so it warns and names the column the
|
|
198
|
+
* operator would add to resolve it.
|
|
199
|
+
*/
|
|
200
|
+
interface StorageRemapReport {
|
|
201
|
+
ambiguous: UnresolvedStorageReference[];
|
|
202
|
+
/** Number of references rewritten to a content-hash key. */
|
|
203
|
+
rewritten: number;
|
|
204
|
+
unmigrated: UnresolvedStorageReference[];
|
|
205
|
+
}
|
|
206
|
+
/** Rows per HTTP request when importing. Convex uses ~500; same here. */
|
|
207
|
+
declare const DEFAULT_IMPORT_BATCH_SIZE = 500;
|
|
140
208
|
interface ImportCommandOptions {
|
|
141
209
|
/** Rows per HTTP request. Defaults to {@link DEFAULT_IMPORT_BATCH_SIZE}. */
|
|
142
210
|
batchSize?: number;
|
|
@@ -144,88 +212,198 @@ interface ImportCommandOptions {
|
|
|
144
212
|
fetchImpl?: StreamingFetchLike;
|
|
145
213
|
/** Source NDJSON file. Required. */
|
|
146
214
|
file: string;
|
|
215
|
+
/**
|
|
216
|
+
* Which reader to use. Omit to auto-detect between a Convex export snapshot
|
|
217
|
+
* and a plain NDJSON file; `supabase`/`firebase` must be explicit, because a
|
|
218
|
+
* directory of CSV or JSON has no signature that distinguishes it from
|
|
219
|
+
* anything else a user might point at.
|
|
220
|
+
*/
|
|
221
|
+
from?: ImportSourceName;
|
|
147
222
|
logger: Logger;
|
|
148
223
|
prod?: boolean;
|
|
149
224
|
/**
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
225
|
+
* Scan the export for columns holding `_storage` ids and write a candidate
|
|
226
|
+
* `lunora/import-convex.json`. Scan-only: nothing is imported.
|
|
227
|
+
*/
|
|
228
|
+
scan?: boolean;
|
|
229
|
+
/**
|
|
230
|
+
* Local directory of storage objects to migrate alongside the rows — how
|
|
231
|
+
* Firebase Cloud Storage arrives, after `gcloud storage cp -r`.
|
|
232
|
+
*/
|
|
233
|
+
storageDir?: string;
|
|
234
|
+
/**
|
|
235
|
+
* Wrap each line as `{table:<name>,doc:<line>}`. Use when the source NDJSON
|
|
236
|
+
* is bare docs from a single table — Convex's `convex import --table users`
|
|
237
|
+
* shape.
|
|
238
|
+
*/
|
|
154
239
|
table?: string;
|
|
155
240
|
token?: string;
|
|
156
241
|
url?: string;
|
|
242
|
+
/**
|
|
243
|
+
* Verify per-table row parity + dangling-storage after import. Exits non-zero
|
|
244
|
+
* when a table's inserted count differs from its source line count, or when a
|
|
245
|
+
* document references a storage id that was not migrated.
|
|
246
|
+
*/
|
|
247
|
+
verify?: boolean;
|
|
248
|
+
/**
|
|
249
|
+
* Also migrate Convex `_storage` blobs: read `_storage/documents.jsonl`, upload
|
|
250
|
+
* each blob with sha256+size verification, and build the `storageId → key` map.
|
|
251
|
+
* Off by default so the plain-document import path is unchanged.
|
|
252
|
+
*/
|
|
253
|
+
withStorage?: boolean;
|
|
254
|
+
/** Confirm bulk-writing production. Required alongside `--prod`. */
|
|
255
|
+
yes?: boolean;
|
|
256
|
+
}
|
|
257
|
+
/**
|
|
258
|
+
* The JSON summary a run prints and returns — the same object either way, so a
|
|
259
|
+
* caller reading `body.conflicts` does not have to cast its way there.
|
|
260
|
+
*
|
|
261
|
+
* `undefined` on every path that imports nothing: a rejected source, a failed
|
|
262
|
+
* storage phase, or `--scan` (whose product is the mapping file it writes, not
|
|
263
|
+
* a return value).
|
|
264
|
+
*/
|
|
265
|
+
interface ImportSummary {
|
|
266
|
+
conflicts: number;
|
|
267
|
+
errors: ImportRowError[];
|
|
268
|
+
/** Shards the endpoint could not reach (it answered 207). Their rows are MISSING, not rejected — present only when non-empty. */
|
|
269
|
+
failed?: ImportShardFailure[];
|
|
270
|
+
inserted: Record<string, number>;
|
|
271
|
+
received: number;
|
|
272
|
+
storage?: {
|
|
273
|
+
ambiguous: StorageRemapReport["ambiguous"];
|
|
274
|
+
blobs: number;
|
|
275
|
+
rewritten: number;
|
|
276
|
+
unmigrated: StorageRemapReport["unmigrated"];
|
|
277
|
+
};
|
|
278
|
+
warnings?: string[];
|
|
157
279
|
}
|
|
158
280
|
interface ImportCommandResult {
|
|
159
|
-
body:
|
|
281
|
+
body: ImportSummary | undefined;
|
|
160
282
|
code: number;
|
|
161
283
|
/** Total inserted rows across batches. */
|
|
162
284
|
inserted: number;
|
|
163
285
|
}
|
|
164
|
-
/**
|
|
165
|
-
* Stream an NDJSON file in chunks, POSTing each batch to
|
|
166
|
-
* `/_lunora/admin/import`. We keep the line buffer bounded by `batchSize` so a
|
|
167
|
-
* multi-GiB file imports without buffering everything in memory.
|
|
168
|
-
*/
|
|
169
286
|
declare const runImportCommand: (options: ImportCommandOptions) => Promise<ImportCommandResult>;
|
|
170
287
|
/**
|
|
171
|
-
* Injectable probe for a Docker-compatible container engine. Tests pass a
|
|
172
|
-
* stub; production uses {@link isDockerAvailable}.
|
|
173
|
-
*/
|
|
288
|
+
* Injectable probe for a Docker-compatible container engine. Tests pass a
|
|
289
|
+
* stub; production uses {@link isDockerAvailable}.
|
|
290
|
+
*/
|
|
174
291
|
type DockerProbe = () => boolean;
|
|
175
292
|
/**
|
|
176
|
-
*
|
|
177
|
-
*
|
|
178
|
-
*
|
|
179
|
-
*
|
|
180
|
-
|
|
293
|
+
* The shared `/_lunora/health` probe used by `lunora verify --health-url` and
|
|
294
|
+
* `lunora deploy --health-check`.
|
|
295
|
+
*
|
|
296
|
+
* Both commands ask the same question — "does this deployment answer?" — so
|
|
297
|
+
* they ask it through one implementation with one error-message shape. The
|
|
298
|
+
* runtime auto-registers both routes (`packages/runtime/src/health-routes.ts`):
|
|
299
|
+
* `/_lunora/health/ready` is the readiness gate ("can this version serve"), and
|
|
300
|
+
* `/_lunora/health` is the aggregate that also exists on older deployments.
|
|
301
|
+
*
|
|
302
|
+
* The probe is transport-only: it never throws, and reports its verdict as an
|
|
303
|
+
* `{ error }` message the caller decides what to do with.
|
|
304
|
+
*/
|
|
305
|
+
/**
|
|
306
|
+
* Minimal fetch surface the probe needs — a subset of the global `fetch`,
|
|
307
|
+
* injectable so a test can feed a canned response without a network.
|
|
308
|
+
*/
|
|
309
|
+
type HealthFetch = (url: string) => Promise<{
|
|
310
|
+
ok: boolean;
|
|
311
|
+
status: number;
|
|
312
|
+
}>;
|
|
181
313
|
interface SpawnDescriptor {
|
|
182
314
|
args: ReadonlyArray<string>;
|
|
183
315
|
/**
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
316
|
+
* Capture the child's stderr (in addition to streaming it to the parent).
|
|
317
|
+
* Needed when a tool reports the *expected* outcome as an error there —
|
|
318
|
+
* `wrangler vectorize create-metadata-index` writes "already exists" to
|
|
319
|
+
* stderr, and without this the caller can only see a bare exit code and
|
|
320
|
+
* would warn on every re-run. Composes with `stdoutToStderr`, so a caller
|
|
321
|
+
* can keep stdout clean for `--format json` and still read the reason.
|
|
322
|
+
*/
|
|
323
|
+
captureStderr?: boolean;
|
|
324
|
+
/**
|
|
325
|
+
* Capture the child's stdout (in addition to streaming it to the parent), so
|
|
326
|
+
* the caller can parse it — used by `deploy` to read the deployed URL from
|
|
327
|
+
* `wrangler deploy` output. Each chunk is still teed to the parent's stdout
|
|
328
|
+
* so the user sees live progress. Mutually exclusive with `stdoutToStderr`
|
|
329
|
+
* and `captureStdoutSilently`.
|
|
330
|
+
*/
|
|
189
331
|
captureStdout?: boolean;
|
|
332
|
+
/**
|
|
333
|
+
* Capture the child's stdout WITHOUT teeing it to the parent's stdout —
|
|
334
|
+
* for output that is parsed, never displayed (e.g. `wrangler secret list
|
|
335
|
+
* --format json`). Unlike `captureStdout`, nothing is written to
|
|
336
|
+
* `process.stdout`, so it can't interleave with — and corrupt — a
|
|
337
|
+
* caller's own stdout (notably `lunora deploy --format json`, which must
|
|
338
|
+
* emit exactly one JSON document). Mutually exclusive with `captureStdout`
|
|
339
|
+
* and `stdoutToStderr`.
|
|
340
|
+
*/
|
|
341
|
+
captureStdoutSilently?: boolean;
|
|
190
342
|
command: string;
|
|
191
343
|
cwd?: string;
|
|
192
344
|
env?: Readonly<Record<string, string>>;
|
|
193
345
|
/**
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
346
|
+
* Pipe this string into the child's stdin and close it. Used to feed
|
|
347
|
+
* `wrangler secret put` its value without exposing it on the command
|
|
348
|
+
* line or in env. When absent, stdin is inherited from the parent.
|
|
349
|
+
*/
|
|
198
350
|
input?: string;
|
|
199
351
|
/**
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
352
|
+
* Route the child's stdout to the parent's STDERR instead of stdout. Set in
|
|
353
|
+
* `--format json` mode so a spawned tool's human output (e.g. `wrangler
|
|
354
|
+
* deploy`'s progress + the deployed URL) can't interleave with — and corrupt
|
|
355
|
+
* — the single JSON document the command prints to stdout.
|
|
356
|
+
*/
|
|
205
357
|
stdoutToStderr?: boolean;
|
|
206
358
|
}
|
|
207
359
|
interface SpawnResult {
|
|
208
360
|
code: number;
|
|
209
|
-
/** The captured
|
|
361
|
+
/** The captured stderr, present only when the descriptor set `captureStderr`. */
|
|
362
|
+
stderr?: string;
|
|
363
|
+
/** The captured stdout, present only when the descriptor set `captureStdout` or `captureStdoutSilently`. */
|
|
210
364
|
stdout?: string;
|
|
211
365
|
}
|
|
212
366
|
/**
|
|
213
|
-
* Injectable spawner. Tests pass a stub that just records the descriptor
|
|
214
|
-
* instead of executing a real subprocess.
|
|
215
|
-
*/
|
|
367
|
+
* Injectable spawner. Tests pass a stub that just records the descriptor
|
|
368
|
+
* instead of executing a real subprocess.
|
|
369
|
+
*/
|
|
216
370
|
type Spawner = (descriptor: SpawnDescriptor) => Promise<SpawnResult>;
|
|
217
371
|
declare const defaultSpawner: Spawner;
|
|
218
372
|
interface RecordedSpawn {
|
|
219
373
|
descriptor: SpawnDescriptor;
|
|
220
374
|
}
|
|
221
375
|
/**
|
|
222
|
-
* Test helper: returns a spawner that records every invocation and resolves
|
|
223
|
-
* with the configured exit code.
|
|
224
|
-
*/
|
|
376
|
+
* Test helper: returns a spawner that records every invocation and resolves
|
|
377
|
+
* with the configured exit code.
|
|
378
|
+
*/
|
|
225
379
|
declare const createRecordingSpawner: (exitCode?: number) => {
|
|
226
380
|
calls: RecordedSpawn[];
|
|
227
381
|
spawner: Spawner;
|
|
228
382
|
};
|
|
383
|
+
interface SecretListRunnerResult {
|
|
384
|
+
code: number;
|
|
385
|
+
stderr: string;
|
|
386
|
+
stdout: string;
|
|
387
|
+
}
|
|
388
|
+
/** Runs an argv and resolves its captured output. Injected in tests. */
|
|
389
|
+
type SecretListRunner = (command: string, args: ReadonlyArray<string>, cwd: string) => Promise<SecretListRunnerResult>;
|
|
390
|
+
interface ListRemoteSecretsInputs {
|
|
391
|
+
cwd: string;
|
|
392
|
+
/** Cloudflare environment name (`--env`). */
|
|
393
|
+
env?: string;
|
|
394
|
+
/** Injected command runner; defaults to a real `wrangler secret list`. */
|
|
395
|
+
runner?: SecretListRunner;
|
|
396
|
+
/** Target a temporary-account deployment (`--temporary`). */
|
|
397
|
+
temporary?: boolean;
|
|
398
|
+
}
|
|
399
|
+
interface ListRemoteSecretsResult {
|
|
400
|
+
/** Diagnostic message when `ok` is false. */
|
|
401
|
+
error?: string;
|
|
402
|
+
/** Remote secret names (sorted), empty when none or on failure. */
|
|
403
|
+
names: ReadonlyArray<string>;
|
|
404
|
+
/** False when wrangler failed or its output could not be parsed. */
|
|
405
|
+
ok: boolean;
|
|
406
|
+
}
|
|
229
407
|
type FetchLike = (input: string, init?: {
|
|
230
408
|
body?: string;
|
|
231
409
|
headers?: Record<string, string>;
|
|
@@ -238,11 +416,17 @@ type FetchLike = (input: string, init?: {
|
|
|
238
416
|
}>;
|
|
239
417
|
interface RunCommandOptions {
|
|
240
418
|
args?: string;
|
|
419
|
+
/** Forge this user id for the call (dispatches through the admin-gated `runAs` op). */
|
|
420
|
+
as?: string;
|
|
421
|
+
/** JSON-encoded extra identity claims to accompany {@link RunCommandOptions.as}. */
|
|
422
|
+
claims?: string;
|
|
241
423
|
cwd?: string;
|
|
242
424
|
fetchImpl?: FetchLike;
|
|
243
425
|
functionPath: string;
|
|
244
426
|
logger: Logger;
|
|
245
427
|
shard?: string;
|
|
428
|
+
/** Admin bearer for the `runAs` dispatch; resolved from the environment / `.dev.vars` when absent. */
|
|
429
|
+
token?: string;
|
|
246
430
|
url?: string;
|
|
247
431
|
}
|
|
248
432
|
interface RunCommandResult {
|
|
@@ -251,7 +435,6 @@ interface RunCommandResult {
|
|
|
251
435
|
requestUrl: string;
|
|
252
436
|
}
|
|
253
437
|
declare const runRpcCommand: (options: RunCommandOptions) => Promise<RunCommandResult>;
|
|
254
|
-
/** `lunora run <functionPath>` handler (lazy-loaded via the command's `loader`). */
|
|
255
438
|
interface DeployCommandOptions {
|
|
256
439
|
/** Override the schema-drift gate — deploy even with breaking drift and no new migration. */
|
|
257
440
|
allowSchemaDrift?: boolean;
|
|
@@ -261,82 +444,165 @@ interface DeployCommandOptions {
|
|
|
261
444
|
/** Docker-availability probe injected in tests. Defaults to a real `docker info` check. */
|
|
262
445
|
dockerAvailable?: DockerProbe;
|
|
263
446
|
/**
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
447
|
+
* Validate, bundle, and run all pre-deploy gates without publishing
|
|
448
|
+
* (`wrangler deploy --dry-run`). Post-deploy steps (data migrations, schema
|
|
449
|
+
* baseline re-bless) are skipped since nothing shipped.
|
|
450
|
+
*/
|
|
268
451
|
dryRun?: boolean;
|
|
269
452
|
env?: string;
|
|
270
453
|
/** Fetch implementation injected in tests for `--migrate` RPC calls. */
|
|
271
454
|
fetchImpl?: FetchLike;
|
|
272
455
|
/** Output format: `pretty` (default) or `json`. */
|
|
273
456
|
format?: string;
|
|
457
|
+
/**
|
|
458
|
+
* After a successful live deploy, probe the new version's health route
|
|
459
|
+
* (`/_lunora/health/ready`, falling back to `/_lunora/health`) and fail the
|
|
460
|
+
* command when it never answers. Opt-in, not default-on: a worker whose
|
|
461
|
+
* health route is admin-gated or unreachable from CI must still be
|
|
462
|
+
* deployable, and a default network step would turn a successful deploy
|
|
463
|
+
* into a red build for an unrelated reason.
|
|
464
|
+
*/
|
|
465
|
+
healthCheck?: boolean;
|
|
466
|
+
/** Injectable fetch for `--health-check`; defaults to the global `fetch`. */
|
|
467
|
+
healthFetch?: HealthFetch;
|
|
468
|
+
/** Injectable inter-attempt delay for `--health-check`; injected in tests to skip the real wait. */
|
|
469
|
+
healthSleep?: (ms: number) => Promise<void>;
|
|
274
470
|
/** Set to `false` to disable interactive spinners (test injection). */
|
|
275
471
|
interactive?: boolean;
|
|
276
472
|
logger: Logger;
|
|
277
473
|
/**
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
474
|
+
* When true, after a successful `wrangler deploy`, discover and run all
|
|
475
|
+
* pending data migrations via the worker's `/_lunora/migrate` admin RPC.
|
|
476
|
+
* The worker must be live (exit 0) before migrations are attempted.
|
|
477
|
+
*
|
|
478
|
+
* Implementation note: the status RPC returns the full shard-level
|
|
479
|
+
* migration state, but there is no single authoritative "list of pending
|
|
480
|
+
* migration ids" that can be read client-side before running the worker.
|
|
481
|
+
* Instead, `--migrate` runs `migrate status` followed by `migrate up` for
|
|
482
|
+
* each migration id discovered locally via `discoverMigrations`. The
|
|
483
|
+
* worker's `MigrationRunner` is idempotent — running `up` on an already-
|
|
484
|
+
* applied migration is a no-op — so this approach is safe.
|
|
485
|
+
*/
|
|
290
486
|
migrate?: boolean;
|
|
291
487
|
/** Admin bearer token for `--migrate` (falls back to `LUNORA_ADMIN_TOKEN`). */
|
|
292
488
|
migrateToken?: string;
|
|
293
489
|
/**
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
490
|
+
* Worker URL for `--migrate`. REQUIRED when `--migrate` is set — the deploy
|
|
491
|
+
* handler never captures the URL `wrangler deploy` published to, so there is
|
|
492
|
+
* no safe default; omitting it would silently target `http://localhost:8787`
|
|
493
|
+
* (the dev worker), applying the migration to local state instead of prod.
|
|
494
|
+
*/
|
|
299
495
|
migrateUrl?: string;
|
|
300
496
|
/**
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
497
|
+
* Confirm a production data migration triggered via `--migrate` (the
|
|
498
|
+
* `migrate up --prod` confirmation the standalone command requires). Without
|
|
499
|
+
* it a `--migrate --migrate-url <prod>` deploy refuses to run the migration.
|
|
500
|
+
*/
|
|
305
501
|
migrateYes?: boolean;
|
|
306
502
|
/**
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
503
|
+
* Emit the bundled worker to this directory via `wrangler deploy --outdir`
|
|
504
|
+
* (paired with `dryRun` by `lunora build`). Also writes esbuild metadata to
|
|
505
|
+
* `<outDir>/bundle-meta.json`. When unset, no artifact is written.
|
|
506
|
+
*/
|
|
311
507
|
outDir?: string;
|
|
312
508
|
/**
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
509
|
+
* Upload a preview version (`wrangler versions upload`) instead of a live
|
|
510
|
+
* `wrangler deploy`. Codegen + the drift gate + validation still run, but
|
|
511
|
+
* the post-deploy finalize (migrations, baseline re-bless, auto-link, the
|
|
512
|
+
* production summary) is skipped — a preview never shifts live traffic.
|
|
513
|
+
*/
|
|
318
514
|
preview?: boolean;
|
|
319
515
|
/** Railpack-availability probe injected in tests. Defaults to a real `railpack --version` + `BUILDKIT_HOST` check. */
|
|
320
516
|
railpackAvailable?: DockerProbe;
|
|
517
|
+
/** Confirm prompt for the missing-secret offer; injected in tests. Defaults to the TTY prompt. */
|
|
518
|
+
secretConfirm?: (message: string) => Promise<boolean>;
|
|
519
|
+
/** Remote-secret lister for the missing-secret offer; injected in tests. Defaults to `wrangler secret list`. */
|
|
520
|
+
secretLister?: (inputs: ListRemoteSecretsInputs) => Promise<ListRemoteSecretsResult>;
|
|
321
521
|
skipCodegen?: boolean;
|
|
322
522
|
spawner?: Spawner;
|
|
323
523
|
/**
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
524
|
+
* Fail the deploy when codegen reports an ERROR-level advisory. Same
|
|
525
|
+
* option `lunora codegen` exposes as `--no-strict-advisories`; defaults to
|
|
526
|
+
* CI detection (on in CI, off locally) so a legitimately-partial target
|
|
527
|
+
* can still be shipped interactively. Does NOT gate platform diagnostics
|
|
528
|
+
* (`platform_unsupported_feature` / `platform_unknown_target`), which
|
|
529
|
+
* always block — those mean the emitted `ctx.*` surface does not match
|
|
530
|
+
* what the target can serve, not merely a style nit.
|
|
531
|
+
*/
|
|
532
|
+
strictAdvisories?: boolean;
|
|
533
|
+
/**
|
|
534
|
+
* Deploy target. Falls back to `"target"` in `lunora.json`, then
|
|
535
|
+
* `"cloudflare"`, which selects the wrangler
|
|
536
|
+
* toolchain — i.e. today's behavior for every project. An unregistered name
|
|
537
|
+
* throws rather than falling back, so a typo can never ship the app to the
|
|
538
|
+
* wrong provider.
|
|
539
|
+
*/
|
|
540
|
+
target?: string;
|
|
541
|
+
/**
|
|
542
|
+
* Deploy to a temporary Cloudflare account (`wrangler deploy --temporary`).
|
|
543
|
+
* For unauthenticated use only: wrangler provisions a short-lived account +
|
|
544
|
+
* token, deploys, and prints a claim URL; the deployment stays live ~60
|
|
545
|
+
* minutes before the unclaimed account is deleted. Wrangler itself errors
|
|
546
|
+
* if credentials are already present (OAuth / `CLOUDFLARE_API_TOKEN` /
|
|
547
|
+
* global API key), so we pass the flag straight through without guarding.
|
|
548
|
+
*/
|
|
331
549
|
temporary?: boolean;
|
|
332
550
|
/** Re-bless the committed schema baseline with the current shape (accepts breaking drift). */
|
|
333
551
|
updateSchemaBaseline?: boolean;
|
|
334
552
|
}
|
|
553
|
+
/**
|
|
554
|
+
* What this run put where — the identity of the thing that was just deployed.
|
|
555
|
+
*
|
|
556
|
+
* Present on every run that reached (and completed) the wrangler invocation,
|
|
557
|
+
* including `--dry-run` and `--preview`, so a consumer can tell "nothing went
|
|
558
|
+
* live" from "went live" without inferring it from a missing `url`. A dry run
|
|
559
|
+
* publishes nothing and therefore never carries a `url`.
|
|
560
|
+
*
|
|
561
|
+
* No `versionId`: the pinned wrangler (4.114.0) has no structured deploy output
|
|
562
|
+
* and no flag that returns the version id — it only prints it in prose, and
|
|
563
|
+
* scraping a second value out of prose is exactly what this shouldn't do. The
|
|
564
|
+
* id is available from `lunora deployments list` after the fact.
|
|
565
|
+
*/
|
|
566
|
+
interface DeployedIdentity {
|
|
567
|
+
/** ISO-8601 stamp taken when the wrangler invocation returned. */
|
|
568
|
+
deployedAt: string;
|
|
569
|
+
/** True when `--dry-run` validated + bundled without publishing. */
|
|
570
|
+
dryRun: boolean;
|
|
571
|
+
/** The Cloudflare environment this run targeted, when `--env` named one. */
|
|
572
|
+
env?: string;
|
|
573
|
+
/** True when `--preview` uploaded a version instead of shifting live traffic. */
|
|
574
|
+
preview: boolean;
|
|
575
|
+
/** The URL wrangler reported publishing to; absent on a dry run, or when the output carried no URL. */
|
|
576
|
+
url?: string;
|
|
577
|
+
/** The Worker name from the project's wrangler config. */
|
|
578
|
+
workerName?: string;
|
|
579
|
+
}
|
|
335
580
|
interface DeployCommandResult {
|
|
336
581
|
code: number;
|
|
582
|
+
/** What was deployed and where — set once the wrangler invocation completed. */
|
|
583
|
+
deployment?: DeployedIdentity;
|
|
337
584
|
descriptor: SpawnDescriptor | undefined;
|
|
338
585
|
/** Set when the run aborted before reaching the wrangler invocation. */
|
|
339
586
|
error?: string;
|
|
587
|
+
/**
|
|
588
|
+
* The `--health-check` probe's verdict, when the flag was set and the probe
|
|
589
|
+
* ran. A red probe fails the command (`code` is non-zero) — but the deploy
|
|
590
|
+
* itself still succeeded, which is why the reason is reported separately
|
|
591
|
+
* from `error`.
|
|
592
|
+
*/
|
|
593
|
+
healthCheck?: {
|
|
594
|
+
error?: string;
|
|
595
|
+
ok: boolean;
|
|
596
|
+
url: string;
|
|
597
|
+
};
|
|
598
|
+
/**
|
|
599
|
+
* The `.dev.vars`-shaped filename (never a full path, never a value) a
|
|
600
|
+
* secret minted during this run was recorded into, when the missing-
|
|
601
|
+
* secret gate minted one — `.dev.vars` for the default environment, or a
|
|
602
|
+
* `.dev.vars.<env>` sibling for an explicit `--env`. `undefined` when
|
|
603
|
+
* nothing was minted this run.
|
|
604
|
+
*/
|
|
605
|
+
mintedSecretsFile?: string;
|
|
340
606
|
/** The schema-drift gate verdict, when it ran (skipped on `--skip-codegen`). */
|
|
341
607
|
schemaDrift?: {
|
|
342
608
|
blocked: boolean;
|
|
@@ -348,46 +614,82 @@ interface DeployCommandResult {
|
|
|
348
614
|
};
|
|
349
615
|
}
|
|
350
616
|
/**
|
|
351
|
-
* Run a deploy, then (in `--format json` mode) serialize the structured
|
|
352
|
-
* {@link DeployCommandResult} to stdout. Human/progress logging is routed to
|
|
353
|
-
* stderr for json output so stdout carries only the single JSON document.
|
|
354
|
-
*/
|
|
617
|
+
* Run a deploy, then (in `--format json` mode) serialize the structured
|
|
618
|
+
* {@link DeployCommandResult} to stdout. Human/progress logging is routed to
|
|
619
|
+
* stderr for json output so stdout carries only the single JSON document.
|
|
620
|
+
*/
|
|
355
621
|
declare const runDeployCommand: (options: DeployCommandOptions) => Promise<DeployCommandResult>;
|
|
356
|
-
/** `lunora deploy` handler (lazy-loaded via the command's `loader`). */
|
|
357
622
|
/**
|
|
358
|
-
* Start the codegen watch loop and return a handle to stop it. Regenerates on
|
|
359
|
-
* startup, then on debounced changes under `lunora/` (ignoring writes to the
|
|
360
|
-
* `_generated/` output to avoid a feedback loop). If the platform can't do a
|
|
361
|
-
* recursive watch, it logs once and falls back to startup-only codegen.
|
|
362
|
-
*/
|
|
623
|
+
* Start the codegen watch loop and return a handle to stop it. Regenerates on
|
|
624
|
+
* startup, then on debounced changes under `lunora/` (ignoring writes to the
|
|
625
|
+
* `_generated/` output to avoid a feedback loop). If the platform can't do a
|
|
626
|
+
* recursive watch, it logs once and falls back to startup-only codegen.
|
|
627
|
+
*/
|
|
363
628
|
declare const startCodegenWatch: (options: CodegenWatcherOptions) => CodegenWatcherHandle;
|
|
364
629
|
interface CodegenWatcherOptions {
|
|
365
630
|
/** Which API spec(s) to emit. Defaults to codegen's `"openapi"` when omitted. */
|
|
366
631
|
apiSpec?: CodegenOptions["apiSpec"];
|
|
367
632
|
/** Debounce window for coalescing rapid edits. Defaults to 100ms. */
|
|
368
633
|
debounceMs?: number;
|
|
634
|
+
/**
|
|
635
|
+
* The caller's logs are NDJSON on stdout, so the `postcodegen` hook's own
|
|
636
|
+
* stdout must be routed to stderr or it corrupts the stream. `lunora dev`
|
|
637
|
+
* turns this on for `--json` AND for a detected AI agent.
|
|
638
|
+
*/
|
|
639
|
+
jsonLogs?: boolean;
|
|
369
640
|
logger: Logger;
|
|
370
641
|
/** Override the lunora subdirectory name. Defaults to `"lunora"`. */
|
|
371
642
|
lunoraDirectory?: string;
|
|
372
643
|
/** Project root containing the `lunora/` directory. */
|
|
373
644
|
projectRoot: string;
|
|
645
|
+
/** Process spawner for the `postcodegen` hook. Injectable so tests need no real subprocess. */
|
|
646
|
+
spawner?: Spawner;
|
|
647
|
+
/** Deploy target the emitted `ctx.*` surface is tailored to. Resolved by the caller; falls back to `"target"` in `lunora.json`, then `"cloudflare"`. */
|
|
648
|
+
target?: string;
|
|
374
649
|
}
|
|
375
650
|
interface CodegenWatcherHandle {
|
|
376
|
-
/**
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
651
|
+
/**
|
|
652
|
+
* Stop watching, drop any queued regeneration, and resolve once the run
|
|
653
|
+
* already in flight has finished.
|
|
654
|
+
*
|
|
655
|
+
* Awaiting the result is what keeps a `postcodegen` child from being
|
|
656
|
+
* orphaned by the caller's `process.exit`; a caller that only needs the
|
|
657
|
+
* watcher detached can ignore it.
|
|
658
|
+
*/
|
|
659
|
+
close: () => Promise<void>;
|
|
660
|
+
/**
|
|
661
|
+
* Resolves once the startup regeneration — codegen AND the project's
|
|
662
|
+
* `postcodegen` — has finished.
|
|
663
|
+
*
|
|
664
|
+
* Await it before starting anything that reads generated output. `runCodegen`
|
|
665
|
+
* is synchronous and has already run by the time `startCodegenWatch` returns,
|
|
666
|
+
* but the hook is the step that FINISHES that output, so a worker spawned
|
|
667
|
+
* without waiting can bundle the unfinished copy. Resolves (never rejects)
|
|
668
|
+
* even when codegen or the hook failed — both report for themselves, and a
|
|
669
|
+
* dev server still has to come up.
|
|
670
|
+
*/
|
|
671
|
+
ready: Promise<void>;
|
|
672
|
+
/**
|
|
673
|
+
* `true` when the platform supports recursive watch and the loop is active.
|
|
674
|
+
* `false` when `fs.watch({ recursive })` threw — startup-only codegen was run
|
|
675
|
+
* but schema edits will NOT auto-regenerate. Callers can surface this in the
|
|
676
|
+
* dev banner so the degraded state is visible beyond the single startup warning.
|
|
677
|
+
*/
|
|
384
678
|
watchAvailable: boolean;
|
|
385
679
|
}
|
|
386
680
|
/**
|
|
387
|
-
*
|
|
388
|
-
*
|
|
389
|
-
*
|
|
390
|
-
|
|
681
|
+
* Readiness probe seam — tests swap the real HTTP probe out.
|
|
682
|
+
*
|
|
683
|
+
* The optional `signal` lets a caller cancel an attempt already in flight. Its
|
|
684
|
+
* absence is why a teardown used to leave one request dangling for up to
|
|
685
|
+
* {@link ATTEMPT_TIMEOUT_MS} after the dev server had been told to stop.
|
|
686
|
+
*/
|
|
687
|
+
type ReadinessProbe = (origin: string, signal?: AbortSignal) => Promise<boolean>;
|
|
688
|
+
/**
|
|
689
|
+
* Start the studio server and resolve once it is listening. Loads the static
|
|
690
|
+
* bundle + renders the host HTML once up front; serves them and proxies
|
|
691
|
+
* `/_lunora/*` (HTTP + WS) to the worker.
|
|
692
|
+
*/
|
|
391
693
|
declare const startStudioServer: (options: StudioServerOptions) => Promise<StudioServerHandle>;
|
|
392
694
|
interface StudioServerOptions {
|
|
393
695
|
/** Project root — `.dev.vars` is read from here for the admin token. */
|
|
@@ -409,6 +711,24 @@ interface StudioServerHandle {
|
|
|
409
711
|
/** The URL to open in a browser. */
|
|
410
712
|
url: string;
|
|
411
713
|
}
|
|
714
|
+
/**
|
|
715
|
+
* How the dev child runs. `wrangler` is the classic `lunora dev` stack (wrangler
|
|
716
|
+
* worker + embedded studio + codegen watch) for a standalone class-C project.
|
|
717
|
+
* `vite` is a project on `@lunora/vite`: the plugin already runs the worker,
|
|
718
|
+
* studio, and codegen inside the Vite dev server, so `lunora dev` runs the
|
|
719
|
+
* project's own dev script and gets out of the way — this also covers class-B
|
|
720
|
+
* frameworks whose own dev server runs the worker in `workerd` (Astro 6 +
|
|
721
|
+
* `@astrojs/cloudflare`, which embeds `@cloudflare/vite-plugin` in `astro dev`:
|
|
722
|
+
* SSR + `/_lunora/*` + `ShardDO` in one process, HMR intact). `framework-worker`
|
|
723
|
+
* is a class-B framework whose dev server CANNOT host the `ShardDO` Durable
|
|
724
|
+
* Object (SvelteKit / Nuxt: their adapters use wrangler's `getPlatformProxy()`,
|
|
725
|
+
* which runs an empty-script Miniflare and does not emulate internal DOs); there
|
|
726
|
+
* `lunora dev` runs the framework's own dev server (front door, HMR, and — via
|
|
727
|
+
* its `@lunora/vite` plugin — studio + codegen) AND a second `wrangler dev`
|
|
728
|
+
* sidecar that owns the real `ShardDO` in `workerd`, wired via the committed
|
|
729
|
+
* `wrangler.dev.jsonc`.
|
|
730
|
+
*/
|
|
731
|
+
type DevFlavor = "framework-worker" | "vite" | "wrangler";
|
|
412
732
|
/** A running worker child the orchestrator controls: send signals, await its exit. */
|
|
413
733
|
interface WorkerProcess {
|
|
414
734
|
/** Resolves with the worker's exit code (1 if it failed to start). */
|
|
@@ -425,15 +745,37 @@ interface DevCommandOptions {
|
|
|
425
745
|
/** Disable the codegen watch loop. */
|
|
426
746
|
codegen?: boolean;
|
|
427
747
|
cwd?: string;
|
|
748
|
+
/**
|
|
749
|
+
* Override where the binding manifest is written. One is always produced at
|
|
750
|
+
* {@link DEV_BINDINGS_FILE}; naming a path also makes a derivation failure
|
|
751
|
+
* fatal, since a named path means something is waiting on it.
|
|
752
|
+
*/
|
|
753
|
+
emitBindings?: string;
|
|
428
754
|
/** Injection seam for tests — defaults to the real `.dev.vars` scaffolder. */
|
|
429
755
|
ensureEnv?: typeof ensureDevVariables;
|
|
430
756
|
/** Injection seam for tests — defaults to the real `.dev.vars.example` package-aware scaffolder. */
|
|
431
757
|
ensureExample?: typeof ensureDevVarsExample;
|
|
758
|
+
/** Injection seam for tests — defaults to the real empty-secret/admin-token filler. */
|
|
759
|
+
fillSecrets?: typeof fillDevSecrets;
|
|
760
|
+
/** Injection seam for tests — defaults to the real free-port probe ({@link findAvailablePort}). */
|
|
761
|
+
findFreePort?: (preferred: number) => Promise<number>;
|
|
762
|
+
/** Dev flavor override (tests / callers that already detected it) — defaults to {@link detectDevFlavor}. */
|
|
763
|
+
flavor?: DevFlavor;
|
|
764
|
+
/** Injection seam for tests — defaults to the real IPv6-loopback probe ({@link hasIpv6Loopback}). */
|
|
765
|
+
hasIpv6Loopback?: () => boolean;
|
|
766
|
+
/**
|
|
767
|
+
* Logs are NDJSON on stdout (`--json`, or a detected AI agent). Forwarded to
|
|
768
|
+
* the codegen watcher so a `postcodegen` script's own stdout is routed to
|
|
769
|
+
* stderr instead of corrupting the stream.
|
|
770
|
+
*/
|
|
771
|
+
jsonLogs?: boolean;
|
|
432
772
|
logger: Logger;
|
|
433
773
|
/** Injection seam for tests — defaults to the real remote-config materializer. */
|
|
434
774
|
materializeRemote?: typeof materializeRemoteWranglerConfig;
|
|
435
775
|
/** Studio server port. */
|
|
436
776
|
port?: number;
|
|
777
|
+
/** Injection seam for tests — defaults to the real HTTP readiness probe. Without it the suite issues live GETs to the dev port. */
|
|
778
|
+
probeReady?: ReadinessProbe;
|
|
437
779
|
/** Proxy D1/KV/R2 bindings to the deployed worker during dev (`LUNORA_REMOTE=1` / `--remote`); DO shards stay local. */
|
|
438
780
|
remote?: boolean;
|
|
439
781
|
/** Injection seam for tests — defaults to the real codegen watcher. */
|
|
@@ -444,6 +786,19 @@ interface DevCommandOptions {
|
|
|
444
786
|
startWorker?: WorkerSpawner;
|
|
445
787
|
/** Disable the embedded studio server. */
|
|
446
788
|
studio?: boolean;
|
|
789
|
+
/** Deploy target the emitted `ctx.*` surface is tailored to. Resolved by the caller; falls back to `"target"` in `lunora.json`, then `"cloudflare"`. */
|
|
790
|
+
target?: string;
|
|
791
|
+
/**
|
|
792
|
+
* Injection seam for tests — defaults to parking until SIGINT.
|
|
793
|
+
*
|
|
794
|
+
* Attached mode (`--no-worker`) ends only on a signal, so without this the
|
|
795
|
+
* whole branch is unreachable from a test. That is how the readiness probe
|
|
796
|
+
* came to be wired after the early return, reported for a flavor it never
|
|
797
|
+
* covered, and shipped.
|
|
798
|
+
*/
|
|
799
|
+
waitForInterrupt?: (logger: Logger) => Promise<number>;
|
|
800
|
+
/** Disable the `wrangler dev` spawn — an external task runner owns the worker. */
|
|
801
|
+
worker?: boolean;
|
|
447
802
|
/** `wrangler dev` port. */
|
|
448
803
|
workerPort?: number;
|
|
449
804
|
}
|
|
@@ -451,10 +806,10 @@ interface DevRemotePlan {
|
|
|
451
806
|
/** Short binding labels remoted (e.g. `"DB (D1)"`), for the banner. */
|
|
452
807
|
bindings: string[];
|
|
453
808
|
/**
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
809
|
+
* Removes the generated temp wrangler config when dev exits. Always present
|
|
810
|
+
* and idempotent — a no-op when remote mode is off or nothing was
|
|
811
|
+
* materialized. The dev loop calls it on every shutdown path.
|
|
812
|
+
*/
|
|
458
813
|
cleanup: () => void;
|
|
459
814
|
/** Whether remote mode was requested. */
|
|
460
815
|
enabled: boolean;
|
|
@@ -462,58 +817,87 @@ interface DevRemotePlan {
|
|
|
462
817
|
reason?: string;
|
|
463
818
|
}
|
|
464
819
|
interface DevCommandPlan {
|
|
465
|
-
|
|
820
|
+
/** Which stack the child runs — see {@link DevFlavor}. */
|
|
821
|
+
flavor: DevFlavor;
|
|
822
|
+
/**
|
|
823
|
+
* One-line redirect hint printed when a meta-framework is detected on the
|
|
824
|
+
* wrangler flavor: without `@lunora/vite` in the dependencies the worker
|
|
825
|
+
* still runs *inside* the framework's dev server, so the user should run
|
|
826
|
+
* their framework dev script for the full app. `undefined` for the vite
|
|
827
|
+
* flavor (`lunora dev` already runs the project's dev script there) and
|
|
828
|
+
* for a standalone project. Purely informational: the wrangler spawn runs
|
|
829
|
+
* regardless.
|
|
830
|
+
*/
|
|
831
|
+
frameworkHint?: string;
|
|
832
|
+
/**
|
|
833
|
+
* True when `wrangler dev` was given `--ip 127.0.0.1` because the host has no
|
|
834
|
+
* IPv6 loopback (`::1`) — surfaced so the dev loop can note the rebind.
|
|
835
|
+
* Always `false` for the vite flavor (the plugin owns its own bind).
|
|
836
|
+
*/
|
|
837
|
+
ipv4LoopbackForced: boolean;
|
|
466
838
|
/** The remote-binding decision: which D1/KV/R2 bindings hit the deployed worker. */
|
|
467
839
|
remote: DevRemotePlan;
|
|
840
|
+
runsCodegenWatch: boolean;
|
|
841
|
+
/**
|
|
842
|
+
* The `wrangler dev` sidecar for the `framework-worker` flavor (SvelteKit /
|
|
843
|
+
* Nuxt): a second child that owns the real `ShardDO` in `workerd`, wired via
|
|
844
|
+
* the committed `wrangler.dev.jsonc`. `undefined` for every other flavor —
|
|
845
|
+
* only the two-process class-B stack has a sidecar. When present, `wrangler`
|
|
846
|
+
* (above) is the framework's own dev server (the front door / HMR) and this
|
|
847
|
+
* is the Lunora realtime plane.
|
|
848
|
+
*/
|
|
849
|
+
sidecar?: SpawnDescriptor & {
|
|
850
|
+
tag: string;
|
|
851
|
+
};
|
|
468
852
|
studioEnabled: boolean;
|
|
469
853
|
studioPort: number;
|
|
854
|
+
/**
|
|
855
|
+
* Whether this process spawns `wrangler dev`.
|
|
856
|
+
*
|
|
857
|
+
* `--no-worker` turns it off so an external task runner (Turbo, Nx, vis, a
|
|
858
|
+
* Procfile) can own worker supervision while `lunora dev` still provides
|
|
859
|
+
* codegen-watch and Studio. Without it, `lunora dev` insisted on being the
|
|
860
|
+
* process root, which is what blocked running the Lunora worker as one node
|
|
861
|
+
* in a larger dev graph.
|
|
862
|
+
*/
|
|
863
|
+
workerEnabled: boolean;
|
|
470
864
|
workerOrigin: string;
|
|
471
865
|
workerPort: number;
|
|
472
|
-
/** The
|
|
866
|
+
/** The primary child `lunora dev` spawns: `wrangler dev` (wrangler flavor) or the framework/`vite dev` server (vite / framework-worker). */
|
|
473
867
|
wrangler: SpawnDescriptor & {
|
|
474
868
|
tag: string;
|
|
475
869
|
};
|
|
476
870
|
}
|
|
477
871
|
/**
|
|
478
|
-
*
|
|
479
|
-
*
|
|
480
|
-
*
|
|
481
|
-
*
|
|
482
|
-
*
|
|
483
|
-
|
|
484
|
-
*/
|
|
485
|
-
/**
|
|
486
|
-
* Plan `lunora dev`: it runs the worker via `wrangler dev` and nothing else as a
|
|
487
|
-
* child process. Vite is intentionally NOT spawned — a project may not use Vite,
|
|
488
|
-
* and when it does, the `@lunora/vite` plugin already runs the worker inside
|
|
489
|
-
* Vite, so the user runs `vite` themselves. Pure + synchronous so it's unit-testable.
|
|
490
|
-
*/
|
|
872
|
+
* Plan `lunora dev`. Wrangler flavor: the worker runs via `wrangler dev` and
|
|
873
|
+
* nothing else as a child process. Vite flavor (`@lunora/vite` declared): the
|
|
874
|
+
* plugin already runs the worker inside the Vite dev server, so the one child
|
|
875
|
+
* is the project's own dev script (`vite dev`, `astro dev`, …) and every CLI
|
|
876
|
+
* sibling is disabled. Pure + synchronous so it's unit-testable.
|
|
877
|
+
*/
|
|
491
878
|
declare const planDevCommand: (options: DevCommandOptions) => DevCommandPlan;
|
|
492
879
|
/**
|
|
493
|
-
* Start codegen watch + the studio server, spawn `wrangler dev`, print the
|
|
494
|
-
* banner, and resolve when the worker exits or the user interrupts — tearing
|
|
495
|
-
* down the sibling servers either way. The three side-effecting pieces (worker,
|
|
496
|
-
* studio, codegen) are injectable so this is testable without real I/O.
|
|
497
|
-
*/
|
|
880
|
+
* Start codegen watch + the studio server, spawn `wrangler dev`, print the
|
|
881
|
+
* banner, and resolve when the worker exits or the user interrupts — tearing
|
|
882
|
+
* down the sibling servers either way. The three side-effecting pieces (worker,
|
|
883
|
+
* studio, codegen) are injectable so this is testable without real I/O.
|
|
884
|
+
*/
|
|
498
885
|
declare const runDevCommand: (options: DevCommandOptions) => Promise<{
|
|
499
886
|
code: number;
|
|
500
887
|
plan: DevCommandPlan;
|
|
501
888
|
}>;
|
|
502
|
-
/** `lunora dev` handler (lazy-loaded via the command's `loader`). */
|
|
503
889
|
/** Supported CI providers. */
|
|
504
890
|
type CiProvider = "github" | "gitlab";
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
*
|
|
510
|
-
*
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
*/
|
|
891
|
+
/**
|
|
892
|
+
* The per-framework auth-UI registry items (`auth-ui` resolves to one of these).
|
|
893
|
+
*
|
|
894
|
+
* Solid has two because these are copy-in source files, not a compiled package:
|
|
895
|
+
* the 1.x and 2.0 spellings are mutually exclusive in the source itself, so the
|
|
896
|
+
* two majors get one item each and {@link detectAuthUiItem} picks.
|
|
897
|
+
*/
|
|
898
|
+
type AuthUiItem = "auth-ui-angular" | "auth-ui-react" | "auth-ui-solid" | "auth-ui-solid-v2" | "auth-ui-svelte" | "auth-ui-vue";
|
|
514
899
|
/** A registry item a feature can install. */
|
|
515
|
-
type FeatureItem = "auth" | "auth-auth0" | "auth-clerk" | "mail";
|
|
516
|
-
/** The auth-provider choices offered for `add auth` / the init auth prompt. Each value is a registry item name. */
|
|
900
|
+
type FeatureItem = "auth" | "auth-auth0" | "auth-clerk" | AuthUiItem | "mail";
|
|
517
901
|
/** A single file the item scaffolds into the project. */
|
|
518
902
|
interface RegistryFile {
|
|
519
903
|
/** Source path inside the item dir (e.g. `schema.ts`). */
|
|
@@ -529,10 +913,10 @@ interface RegistryBinding {
|
|
|
529
913
|
value: unknown;
|
|
530
914
|
}
|
|
531
915
|
/**
|
|
532
|
-
* An environment variable an item needs. Scaffolded into `.dev.vars` (Workers'
|
|
533
|
-
* local-secrets file) on add — non-secrets get their `value`; secrets get an
|
|
534
|
-
* empty placeholder and a reminder to run `wrangler secret put` for production.
|
|
535
|
-
*/
|
|
916
|
+
* An environment variable an item needs. Scaffolded into `.dev.vars` (Workers'
|
|
917
|
+
* local-secrets file) on add — non-secrets get their `value`; secrets get an
|
|
918
|
+
* empty placeholder and a reminder to run `wrangler secret put` for production.
|
|
919
|
+
*/
|
|
536
920
|
interface RegistryEnvVariable {
|
|
537
921
|
/** Human note on what the variable is for. */
|
|
538
922
|
description?: string;
|
|
@@ -543,6 +927,13 @@ interface RegistryEnvVariable {
|
|
|
543
927
|
/** A default/example value for non-secret vars. */
|
|
544
928
|
value?: string;
|
|
545
929
|
}
|
|
930
|
+
/** A re-export the item needs injected into the worker entry point (class-B/C only). */
|
|
931
|
+
interface EntrypointReexport {
|
|
932
|
+
/** Optional JS comment placed above the re-export line. */
|
|
933
|
+
comment?: string;
|
|
934
|
+
/** Module specifier (e.g. `"_generated/workflows"` → `export * from "./lunora/_generated/workflows"`). */
|
|
935
|
+
module: string;
|
|
936
|
+
}
|
|
546
937
|
/** The `registry.json` manifest shape. */
|
|
547
938
|
interface RegistryManifest {
|
|
548
939
|
/** wrangler.jsonc additions (best-effort structural edits). */
|
|
@@ -554,6 +945,8 @@ interface RegistryManifest {
|
|
|
554
945
|
devDependencies?: Readonly<Record<string, string>>;
|
|
555
946
|
/** Post-install guidance printed after the item is added (per-item next steps). */
|
|
556
947
|
docs?: string;
|
|
948
|
+
/** Worker-entry re-exports the item needs (class-B/C only). */
|
|
949
|
+
entrypointReexports?: ReadonlyArray<EntrypointReexport>;
|
|
557
950
|
/** Environment variables the item needs; scaffolded into `.dev.vars`. */
|
|
558
951
|
envVars?: ReadonlyArray<RegistryEnvVariable>;
|
|
559
952
|
files: ReadonlyArray<RegistryFile>;
|
|
@@ -593,11 +986,11 @@ interface AddCommandOptions {
|
|
|
593
986
|
/** Override the remote registry source base (default gh:anolilab/lunora/registry). */
|
|
594
987
|
source?: string;
|
|
595
988
|
/**
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
989
|
+
* Customize each resolved manifest after it is loaded but before the plan is
|
|
990
|
+
* printed / reconciled — used to inject user-chosen values into otherwise
|
|
991
|
+
* static manifests (e.g. the R2 `bucket_name` the init storage prompt asks
|
|
992
|
+
* for). Applied to every item; return the manifest unchanged to leave it as-is.
|
|
993
|
+
*/
|
|
601
994
|
transformManifest?: (manifest: RegistryManifest) => RegistryManifest;
|
|
602
995
|
/** Skip the package.json mutation confirmation prompt. */
|
|
603
996
|
yes?: boolean;
|
|
@@ -613,21 +1006,20 @@ interface AddCommandResult {
|
|
|
613
1006
|
/** Files written (absolute paths). */
|
|
614
1007
|
written: ReadonlyArray<string>;
|
|
615
1008
|
}
|
|
616
|
-
/** One resolved item: its parsed manifest plus the (possibly staged) directory it lives in. */
|
|
617
1009
|
/**
|
|
618
|
-
* A feature offered in the post-scaffold multi-select. `auth`/`email` carry a
|
|
619
|
-
* sub-prompt or alias; every other value IS the registry item name applied
|
|
620
|
-
* directly (`storage` → the `storage` registry item, etc.).
|
|
621
|
-
*/
|
|
622
|
-
type StackFeature = "auth" | "backup" | "crons" | "email" | "presence" | "
|
|
1010
|
+
* A feature offered in the post-scaffold multi-select. `auth`/`email` carry a
|
|
1011
|
+
* sub-prompt or alias; every other value IS the registry item name applied
|
|
1012
|
+
* directly (`storage` → the `storage` registry item, etc.).
|
|
1013
|
+
*/
|
|
1014
|
+
type StackFeature = "ai" | "auth" | "auth-ui" | "backup" | "browser" | "cloudflare-access" | "crons" | "email" | "flags" | "hyperdrive" | "payment" | "presence" | "queue" | "storage" | "workflow";
|
|
623
1015
|
/** Customize a resolved manifest before it is written (e.g. inject the chosen R2 bucket name). */
|
|
624
1016
|
type OfferTransformManifest = (manifest: RegistryManifest) => RegistryManifest;
|
|
625
1017
|
/**
|
|
626
|
-
* One feature ready to apply: the registry item name(s), an optional manifest
|
|
627
|
-
* transform, and a short `label` (the feature value) shown on the combined
|
|
628
|
-
* progress line. Built up-front by the collectors so every prompt is answered
|
|
629
|
-
* before any apply runs.
|
|
630
|
-
*/
|
|
1018
|
+
* One feature ready to apply: the registry item name(s), an optional manifest
|
|
1019
|
+
* transform, and a short `label` (the feature value) shown on the combined
|
|
1020
|
+
* progress line. Built up-front by the collectors so every prompt is answered
|
|
1021
|
+
* before any apply runs.
|
|
1022
|
+
*/
|
|
631
1023
|
interface FeatureApply {
|
|
632
1024
|
label: string;
|
|
633
1025
|
names: ReadonlyArray<string>;
|
|
@@ -635,11 +1027,11 @@ interface FeatureApply {
|
|
|
635
1027
|
}
|
|
636
1028
|
interface OfferDeps {
|
|
637
1029
|
/**
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
1030
|
+
* Apply the collected features into the new project in one batch — resolves
|
|
1031
|
+
* `true` when every item succeeds. The CLI renders this as a single progress
|
|
1032
|
+
* line whose label changes per feature; each plan's `transformManifest`
|
|
1033
|
+
* customizes that item's manifest before it is written.
|
|
1034
|
+
*/
|
|
643
1035
|
applyAll: (plans: ReadonlyArray<FeatureApply>) => Promise<boolean>;
|
|
644
1036
|
/** When `false`, skip all prompts and print the later-setup hint. */
|
|
645
1037
|
interactive: boolean;
|
|
@@ -653,13 +1045,19 @@ interface OfferDeps {
|
|
|
653
1045
|
defaults?: ReadonlyArray<StackFeature>;
|
|
654
1046
|
}) => Promise<StackFeature[]>;
|
|
655
1047
|
/**
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
1048
|
+
* Features chosen non-interactively (the `--add` flag). When set, the
|
|
1049
|
+
* multi-select and every sub-prompt are skipped — each feature is applied with
|
|
1050
|
+
* its shipped defaults (base registry item, placeholder bindings).
|
|
1051
|
+
*/
|
|
660
1052
|
preselected?: ReadonlyArray<StackFeature>;
|
|
661
1053
|
/** The new project's name — seeds smart defaults like the `project-uploads` bucket name. */
|
|
662
1054
|
projectName: string;
|
|
1055
|
+
/**
|
|
1056
|
+
* Resolve which per-framework auth-UI item (`auth-ui-react|vue|…`) fits the
|
|
1057
|
+
* scaffolded project. Injected by the CLI (detected from the template's deps);
|
|
1058
|
+
* defaults to `auth-ui-react` when absent so this module stays pure/testable.
|
|
1059
|
+
*/
|
|
1060
|
+
resolveAuthUiItem?: () => string;
|
|
663
1061
|
/** Single-select among the auth providers (TTY-backed in production). */
|
|
664
1062
|
select: (message: string, options: ReadonlyArray<{
|
|
665
1063
|
description?: string;
|
|
@@ -674,114 +1072,127 @@ interface OfferDeps {
|
|
|
674
1072
|
placeholder?: string;
|
|
675
1073
|
}) => Promise<string>;
|
|
676
1074
|
}
|
|
677
|
-
/**
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
1075
|
+
/** One choice in the multi-select. */
|
|
1076
|
+
interface LintToolOption {
|
|
1077
|
+
description: string;
|
|
1078
|
+
label: string;
|
|
1079
|
+
value: LintTool;
|
|
1080
|
+
}
|
|
1081
|
+
interface LintToolOfferDeps {
|
|
1082
|
+
/** Write the ignores for the chosen tools — `applyLintIgnores` in production. */
|
|
1083
|
+
apply: (tools: ReadonlyArray<LintTool>) => LintIgnoreOutcome[];
|
|
1084
|
+
/** Tools already detectable in the scaffolded project — pre-selected in the prompt. */
|
|
1085
|
+
detected: ReadonlyArray<LintTool>;
|
|
1086
|
+
/** False in CI / `--yes` / off a TTY: skip the prompt and configure whatever was detected. */
|
|
1087
|
+
interactive: boolean;
|
|
1088
|
+
logger: Logger;
|
|
1089
|
+
multiSelect: (message: string, choices: ReadonlyArray<LintToolOption>, settings?: {
|
|
1090
|
+
defaults?: ReadonlyArray<LintTool>;
|
|
1091
|
+
}) => Promise<LintTool[]>;
|
|
1092
|
+
}
|
|
1093
|
+
type Template = "analog" | "astro" | "expo" | "next" | "nuxt" | "react-router" | "solid-v2" | "standalone" | "sveltekit" | "tanstack-start-react" | "tanstack-start-solid" | "vinext" | "vinext-pages";
|
|
689
1094
|
interface InitCommandOptions {
|
|
690
1095
|
/**
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
1096
|
+
* Add features non-interactively after scaffolding (the `--add` flag): a
|
|
1097
|
+
* comma-separated list of `ai | auth | backup | browser | cloudflare-access | crons | email | flags | hyperdrive | payment | presence | queue | storage | workflow`.
|
|
1098
|
+
* Bypasses the interactive multi-select and sub-prompts —
|
|
1099
|
+
* each named feature is applied with its shipped defaults.
|
|
1100
|
+
*/
|
|
696
1101
|
add?: string;
|
|
697
1102
|
/**
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
1103
|
+
* When true, accept `--source` values that don't start with `gh:` /
|
|
1104
|
+
* `github:` / `https://` or that contain `..`. Defaults to false; the CLI
|
|
1105
|
+
* gate exists to stop arbitrary filesystem / scheme sources from being
|
|
1106
|
+
* pulled without the caller opting in.
|
|
1107
|
+
*/
|
|
703
1108
|
allowUnsafeSource?: boolean;
|
|
704
1109
|
/** When set, also scaffold a CI deploy pipeline for the given provider. */
|
|
705
1110
|
ci?: CiProvider;
|
|
706
1111
|
cwd?: string;
|
|
707
1112
|
/**
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
1113
|
+
* Walk the whole flow — prompts, task list, next-steps, mascot — but make no
|
|
1114
|
+
* changes: skip the template fetch/copy, the feature applies, the dependency
|
|
1115
|
+
* install, and `git init`. Each skipped action logs a `would …` line instead.
|
|
1116
|
+
*/
|
|
712
1117
|
dryRun?: boolean;
|
|
713
1118
|
/**
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
1119
|
+
* Local directory containing the template subdirs (e.g. `vite/`,
|
|
1120
|
+
* `standalone/`). When provided, skips the network fetch entirely.
|
|
1121
|
+
* Useful for offline runs, the clean-machine smoke test, and unit tests.
|
|
1122
|
+
*/
|
|
718
1123
|
from?: string;
|
|
719
1124
|
/**
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
1125
|
+
* When true, configure Lunora into the CURRENT project (`cwd`) instead of
|
|
1126
|
+
* scaffolding a new directory. Finds an existing `vite.config.*` and
|
|
1127
|
+
* patches it via `patchViteConfig`, or creates a minimal one when absent.
|
|
1128
|
+
* All other scaffold options (`name`, `templateType`, `source`, `from`)
|
|
1129
|
+
* are ignored in this mode.
|
|
1130
|
+
*/
|
|
726
1131
|
inPlace?: boolean;
|
|
727
1132
|
/**
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
1133
|
+
* Inject the post-scaffold install offer's prompts (tests). When set, the
|
|
1134
|
+
* offer runs regardless of TTY: `confirmInstall` drives the yes/no, and
|
|
1135
|
+
* `selectManager` picks among the detected managers.
|
|
1136
|
+
*/
|
|
732
1137
|
installPrompt?: {
|
|
733
1138
|
confirmInstall: () => Promise<boolean>;
|
|
734
1139
|
selectManager: (managers: ReadonlyArray<PackageManager>) => Promise<PackageManager>;
|
|
735
1140
|
};
|
|
736
1141
|
/**
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
1142
|
+
* Force the post-scaffold "add auth / email?" offer on (the `--interactive`
|
|
1143
|
+
* flag). When omitted, the offer runs only when stdin is a TTY. `--yes`
|
|
1144
|
+
* suppresses it regardless. Has no effect once {@link prompt} is injected.
|
|
1145
|
+
*/
|
|
741
1146
|
interactive?: boolean;
|
|
1147
|
+
/**
|
|
1148
|
+
* Test seam for the lint/formatter multi-select. Separate from {@link prompt}
|
|
1149
|
+
* because that one is pinned to the feature-offer's value union — reusing it
|
|
1150
|
+
* here would only typecheck through a cast.
|
|
1151
|
+
*/
|
|
1152
|
+
lintPrompt?: LintToolOfferDeps["multiSelect"];
|
|
742
1153
|
logger: Logger;
|
|
743
1154
|
name?: string;
|
|
744
1155
|
/**
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
|
|
1156
|
+
* Local directory holding create-vite bases (one `template-<id>/` subdir per
|
|
1157
|
+
* framework). When set with `vite`, the overlay copies the base from disk
|
|
1158
|
+
* instead of fetching `create-vite` over the network — offline mode + tests.
|
|
1159
|
+
*/
|
|
749
1160
|
overlayBaseFrom?: string;
|
|
750
|
-
/** Probe for which package managers are installed (tests). Defaults to a real
|
|
1161
|
+
/** Probe for which package managers are installed (tests). Defaults to a real `<pm> --version` check. */
|
|
751
1162
|
packageManagerProbe?: PackageManagerProbe;
|
|
752
1163
|
/**
|
|
753
|
-
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
1164
|
+
* Inject the offer's prompts (tests). When set, the offer is treated as
|
|
1165
|
+
* interactive regardless of TTY, and these drive the feature multi-select,
|
|
1166
|
+
* the auth-provider sub-select, and the storage bucket-name text input.
|
|
1167
|
+
*/
|
|
757
1168
|
prompt?: Pick<OfferDeps, "multiSelect" | "select" | "text">;
|
|
758
1169
|
/**
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
|
|
1170
|
+
* Override the git ref (branch, tag, or commit) the default template source
|
|
1171
|
+
* is fetched from. Takes precedence over the version-derived ref. Ignored
|
|
1172
|
+
* when `source` or `from` is set.
|
|
1173
|
+
*/
|
|
763
1174
|
ref?: string;
|
|
764
1175
|
/** Local registry root for the offer's `runAddCommand` (offline / tests). Mirrors `from` but for registry items. */
|
|
765
1176
|
registryFrom?: string;
|
|
766
1177
|
/** Override the remote registry source base for the offer (default `gh:anolilab/lunora/registry`). */
|
|
767
1178
|
registrySource?: string;
|
|
768
1179
|
/**
|
|
769
|
-
|
|
770
|
-
|
|
771
|
-
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
1180
|
+
* Override the remote source giget downloads from. Default:
|
|
1181
|
+
* `gh:anolilab/lunora/templates/<templateType>#<ref>`, where `<ref>` is
|
|
1182
|
+
* the `ref` option when set, else derived from the CLI version (pre-release
|
|
1183
|
+
* channels → their branch, stable → `main`). Tests typically use `from`
|
|
1184
|
+
* instead to skip the network.
|
|
1185
|
+
*/
|
|
775
1186
|
source?: string;
|
|
776
1187
|
/** Spawner for the post-scaffold dependency install (tests inject a recording stub). Defaults to a real subprocess. */
|
|
777
1188
|
spawner?: Spawner;
|
|
778
1189
|
templateType?: Template;
|
|
779
1190
|
/**
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
|
|
1191
|
+
* Scaffold via the **create-vite overlay** for this framework (`react`,
|
|
1192
|
+
* `vue`, `solid`, `svelte`, `vanilla`) instead of a bespoke template: fetch
|
|
1193
|
+
* the official create-vite base and apply the Lunora layer on top. Takes
|
|
1194
|
+
* precedence over `templateType`.
|
|
1195
|
+
*/
|
|
785
1196
|
vite?: string;
|
|
786
1197
|
/** Suppress the offer entirely (the `--yes` flag): scaffold only, print the later-setup hint. */
|
|
787
1198
|
yes?: boolean;
|
|
@@ -791,8 +1202,12 @@ interface InitCommandResult {
|
|
|
791
1202
|
files: ReadonlyArray<string>;
|
|
792
1203
|
target: string;
|
|
793
1204
|
}
|
|
1205
|
+
/**
|
|
1206
|
+
* `lunora init` entry: scaffold (in-place or a new directory), then — on success
|
|
1207
|
+
* — offer to add auth + email via the registry. The offer never affects the
|
|
1208
|
+
* scaffold's exit code.
|
|
1209
|
+
*/
|
|
794
1210
|
declare const runInitCommand: (options: InitCommandOptions) => Promise<InitCommandResult>;
|
|
795
|
-
/** Narrow a raw `--template` value to a known {@link Template}. */
|
|
796
1211
|
interface MigrateGenerateCommandOptions {
|
|
797
1212
|
cwd?: string;
|
|
798
1213
|
logger: Logger;
|
|
@@ -818,29 +1233,27 @@ interface CatalogItem {
|
|
|
818
1233
|
interface IndexItem extends CatalogItem {
|
|
819
1234
|
title?: string;
|
|
820
1235
|
}
|
|
821
|
-
/** Names of the subdirectories under `root` that ship a `registry.json`. */
|
|
822
|
-
|
|
823
1236
|
/**
|
|
824
|
-
* Build the catalog (`index.json` contents) from a local registry root by
|
|
825
|
-
* reading every item's `registry.json`. Used by both `lunora registry build`
|
|
826
|
-
* and the registry tests so the committed index can't drift from the item dirs.
|
|
827
|
-
*/
|
|
1237
|
+
* Build the catalog (`index.json` contents) from a local registry root by
|
|
1238
|
+
* reading every item's `registry.json`. Used by both `lunora registry build`
|
|
1239
|
+
* and the registry tests so the committed index can't drift from the item dirs.
|
|
1240
|
+
*/
|
|
828
1241
|
declare const buildRegistryIndex: (root: string) => {
|
|
829
1242
|
items: IndexItem[];
|
|
830
1243
|
};
|
|
831
1244
|
/** `lunora registry add` (one or more item names): scaffold items into the project. */
|
|
832
1245
|
declare const runAddCommand: (options: AddCommandOptions) => Promise<AddCommandResult>;
|
|
833
1246
|
/**
|
|
834
|
-
* `lunora registry view` — inspect a registry item without installing it:
|
|
835
|
-
* print its plan (files / deps / env vars) followed by the full contents of each
|
|
836
|
-
* file it would scaffold. Resolves only the named item — no `requires` expansion.
|
|
837
|
-
*/
|
|
1247
|
+
* `lunora registry view` — inspect a registry item without installing it:
|
|
1248
|
+
* print its plan (files / deps / env vars) followed by the full contents of each
|
|
1249
|
+
* file it would scaffold. Resolves only the named item — no `requires` expansion.
|
|
1250
|
+
*/
|
|
838
1251
|
declare const runRegistryViewCommand: (options: AddCommandOptions) => Promise<AddCommandResult>;
|
|
839
1252
|
/**
|
|
840
|
-
* `lunora registry build` — regenerate `index.json` from the item directories
|
|
841
|
-
* (the catalog `list` reads). With `--check`, verify the committed index matches
|
|
842
|
-
* instead of rewriting it (exits non-zero on drift) — a CI guard.
|
|
843
|
-
*/
|
|
1253
|
+
* `lunora registry build` — regenerate `index.json` from the item directories
|
|
1254
|
+
* (the catalog `list` reads). With `--check`, verify the committed index matches
|
|
1255
|
+
* instead of rewriting it (exits non-zero on drift) — a CI guard.
|
|
1256
|
+
*/
|
|
844
1257
|
declare const runBuildIndexCommand: (options: AddCommandOptions) => Promise<AddCommandResult>;
|
|
845
1258
|
/** Validate + narrow a parsed JSON value into a {@link RegistryManifest}. */
|
|
846
1259
|
declare const parseManifest: (raw: unknown, itemName: string) => RegistryManifest;
|
|
@@ -858,23 +1271,6 @@ interface ResetCommandResult {
|
|
|
858
1271
|
removed: ReadonlyArray<string>;
|
|
859
1272
|
}
|
|
860
1273
|
declare const runResetCommand: (options: ResetCommandOptions) => Promise<ResetCommandResult>;
|
|
861
|
-
/** `lunora reset` handler (lazy-loaded via the command's `loader`). */
|
|
862
|
-
/**
|
|
863
|
-
* Tiny argv parser.
|
|
864
|
-
*
|
|
865
|
-
* Supports long options (`--name value`, `--name=value`, `--flag`), short
|
|
866
|
-
* options (`-x value`, `-xvalue`), positional arguments (everything else, in
|
|
867
|
-
* order), and a `--` terminator after which everything is positional.
|
|
868
|
-
*
|
|
869
|
-
* Intentionally small — replaces a full CLI library for the handful of
|
|
870
|
-
* subcommands we need.
|
|
871
|
-
*/
|
|
872
|
-
interface ParsedArgs {
|
|
873
|
-
flags: Record<string, boolean>;
|
|
874
|
-
options: Record<string, string>;
|
|
875
|
-
positional: ReadonlyArray<string>;
|
|
876
|
-
}
|
|
877
|
-
declare const parseArgs: (argv: ReadonlyArray<string>, booleanFlags?: ReadonlySet<string>) => ParsedArgs;
|
|
878
1274
|
type InsertSchemaExtensionResult = {
|
|
879
1275
|
ok: true;
|
|
880
1276
|
text: string;
|
|
@@ -883,12 +1279,12 @@ type InsertSchemaExtensionResult = {
|
|
|
883
1279
|
reason: "already-applied" | "invalid-identifier" | "no-define-schema" | "non-object-argument";
|
|
884
1280
|
};
|
|
885
1281
|
/**
|
|
886
|
-
* Append `.extend(
|
|
887
|
-
* `lunora/schema.ts`. Idempotent: a second call for the same `key` returns
|
|
888
|
-
* `already-applied` and leaves the text unchanged.
|
|
889
|
-
* @param source the current `lunora/schema.ts` contents
|
|
890
|
-
* @param key the registry item key (e.g. `"ratelimit"`)
|
|
891
|
-
*/
|
|
1282
|
+
* Append `.extend(<key>.extension)` and a managed import to an existing
|
|
1283
|
+
* `lunora/schema.ts`. Idempotent: a second call for the same `key` returns
|
|
1284
|
+
* `already-applied` and leaves the text unchanged.
|
|
1285
|
+
* @param source the current `lunora/schema.ts` contents
|
|
1286
|
+
* @param key the registry item key (e.g. `"ratelimit"`)
|
|
1287
|
+
*/
|
|
892
1288
|
declare const insertSchemaExtension: (source: string, key: string) => InsertSchemaExtensionResult;
|
|
893
1289
|
/** Compact snapshot of a single global table — what we persist + diff. */
|
|
894
1290
|
interface TableSnapshot {
|
|
@@ -931,26 +1327,34 @@ interface SchemaDiff {
|
|
|
931
1327
|
unsupported: ReadonlyArray<UnsupportedEntry>;
|
|
932
1328
|
}
|
|
933
1329
|
/**
|
|
934
|
-
* Map a Lunora validator kind to a SQLite type affinity — the canonical
|
|
935
|
-
* `@lunora/d1/dialect` mapping. Re-exported under this name because
|
|
936
|
-
* `schema-snapshot.ts` builds the persisted snapshot from it.
|
|
937
|
-
*/
|
|
1330
|
+
* Map a Lunora validator kind to a SQLite type affinity — the canonical
|
|
1331
|
+
* `@lunora/d1/dialect` mapping. Re-exported under this name because
|
|
1332
|
+
* `schema-snapshot.ts` builds the persisted snapshot from it.
|
|
1333
|
+
*/
|
|
938
1334
|
declare const validatorKindToSqlType: (kind: string) => ColumnSnapshot["sqlType"];
|
|
939
|
-
/**
|
|
1335
|
+
/**
|
|
1336
|
+
* Emit `CREATE TABLE` SQL for a new global table.
|
|
1337
|
+
*
|
|
1338
|
+
* Refuses a table past D1's column ceiling rather than writing SQL that
|
|
1339
|
+
* `lunora migrate up` will reject: the runtime auto-provisioner checks the same
|
|
1340
|
+
* number, and a migration file is the worse place to find out — the failure
|
|
1341
|
+
* lands later, against a database, with none of the schema context that names
|
|
1342
|
+
* which table and field to split.
|
|
1343
|
+
*/
|
|
940
1344
|
declare const renderCreateTable: (table: TableSnapshot) => string;
|
|
941
1345
|
declare const renderDropTable: (tableName: string) => string;
|
|
942
1346
|
declare const renderAddColumn: (tableName: string, columnName: string, column: ColumnSnapshot) => string;
|
|
943
1347
|
declare const renderCreateIndex: (tableName: string, index: IndexSnapshot) => string;
|
|
944
1348
|
declare const renderDropIndex: (tableName: string, indexName: string) => string;
|
|
945
1349
|
/**
|
|
946
|
-
* Compute a {@link SchemaDiff} from two snapshots. Pure function — no I/O.
|
|
947
|
-
*/
|
|
1350
|
+
* Compute a {@link SchemaDiff} from two snapshots. Pure function — no I/O.
|
|
1351
|
+
*/
|
|
948
1352
|
declare const diffSnapshots: (previous: SchemaSnapshot | undefined, next: SchemaSnapshot) => SchemaDiff;
|
|
949
1353
|
/**
|
|
950
|
-
* Render a complete migration file body from a diff. Includes a header,
|
|
951
|
-
* each SQL statement, and (if any) a trailing comment block describing the
|
|
952
|
-
* manual SQL the user needs to fill in for unsupported deltas.
|
|
953
|
-
*/
|
|
1354
|
+
* Render a complete migration file body from a diff. Includes a header,
|
|
1355
|
+
* each SQL statement, and (if any) a trailing comment block describing the
|
|
1356
|
+
* manual SQL the user needs to fill in for unsupported deltas.
|
|
1357
|
+
*/
|
|
954
1358
|
declare const renderMigrationFile: (name: string, diff: SchemaDiff, generatedAt: string) => string;
|
|
955
1359
|
declare const schemaIrToSnapshot: (ir: SchemaIR) => SchemaSnapshot;
|
|
956
|
-
export { type AddCommandOptions, type AddCommandResult, COMMANDS, type ColumnSnapshot, type CommandName, DEFAULT_IMPORT_BATCH_SIZE, type DeployCommandOptions, type DeployCommandResult, type DevCommandOptions, type DevCommandPlan, type DiffEntry, type ExportCommandOptions, type ExportCommandResult, type FetchLike, type ImportCommandOptions, type ImportCommandResult, type IndexSnapshot, type InitCommandOptions, type InitCommandResult, type InsertSchemaExtensionResult, type Logger, type MigrateGenerateCommandOptions, type MigrateGenerateCommandResult, type RecordedSpawn, type RegistryBinding, type RegistryFile, type RegistryManifest, type ResetCommandOptions, type ResetCommandResult, type RunCliOptions, type RunCommandOptions, type RunCommandResult, type SchemaDiff, type SchemaSnapshot, type SpawnDescriptor, type SpawnResult, type Spawner, type StreamingFetchLike, type TableSnapshot, type Template, type UnsupportedEntry, VERSION, buildRegistryIndex, createLogger, createRecordingSpawner, defaultSpawner, diffSnapshots, insertSchemaExtension, pail,
|
|
1360
|
+
export { type AddCommandOptions, type AddCommandResult, COMMANDS, type ColumnSnapshot, type CommandName, DEFAULT_IMPORT_BATCH_SIZE, type DeployCommandOptions, type DeployCommandResult, type DeployedIdentity, type DevCommandOptions, type DevCommandPlan, type DiffEntry, type ExportCommandOptions, type ExportCommandResult, type FetchLike, type ImportCommandOptions, type ImportCommandResult, type IndexSnapshot, type InitCommandOptions, type InitCommandResult, type InsertSchemaExtensionResult, type Logger, type MigrateGenerateCommandOptions, type MigrateGenerateCommandResult, type RecordedSpawn, type RegistryBinding, type RegistryFile, type RegistryManifest, type ResetCommandOptions, type ResetCommandResult, type RunCliOptions, type RunCommandOptions, type RunCommandResult, type SchemaDiff, type SchemaSnapshot, type SpawnDescriptor, type SpawnResult, type Spawner, type StreamingFetchLike, type TableSnapshot, type Template, type UnsupportedEntry, VERSION, buildRegistryIndex, createLogger, createRecordingSpawner, defaultSpawner, diffSnapshots, insertSchemaExtension, pail, parseManifest, planDevCommand, renderAddColumn, renderCreateIndex, renderCreateTable, renderDropIndex, renderDropTable, renderMigrationFile, runAddCommand, runBuildIndexCommand, runCli, runCodegenCommand, runDeployCommand, runDevCommand, runExportCommand, runImportCommand, runInitCommand, runMigrateGenerateCommand, runRegistryViewCommand, runResetCommand, runRpcCommand, schemaIrToSnapshot, validatorKindToSqlType };
|