@geekmidas/cli 10.0.0-alpha.86 → 10.0.0-alpha.88

package/dist/index.mjs

@@ -47,7 +47,7 @@ import crypto from "crypto";
 import { Function } from "@geekmidas/constructs/functions";
 import { Topic } from "@geekmidas/constructs/topic";
 //#region package.json
-var version = "10.0.0-alpha.86";
+var version = "10.0.0-alpha.88";
 //#endregion
 //#region src/prompt.ts
 /**
@@ -493,6 +493,54 @@ var UnsupportedPlatform = class extends Error {
 	}
 };
 //#endregion
+//#region src/workspace/stageTypes.ts
+/**
+* `.gkm/stages.d.ts`: the declared stages, as types application code can see.
+*
+* Constructs and app code cannot import `gkm.config.ts`, so the stage names it
+* declares were plain strings everywhere else. This writes them into
+* `@geekmidas/constructs`' `Stages` interface, which `LocalStage`,
+* `DeployedStage` and `AnyStage` read — an `ExternalApi` url keyed `prodution`
+* becomes a type error. Without the file those types are `string`.
+*
+* Written by `gkm dev`, `gkm build` and `gkm test --prepare`, beside the
+* generated clients; a project's tsconfig `include`s it.
+*/
+/** Where the declaration is written, relative to the workspace root. */
+const STAGE_TYPES_FILE = ".gkm/stages.d.ts";
+/** A union of string literal types: `'staging' | 'prod'`, or `never`. */
+function union(names) {
+	return names.length ? names.map((name) => `'${name}'`).join(" | ") : "never";
+}
+/** The declaration for a stages block. */
+function stageTypesDeclaration(stages) {
+	return `// Generated by gkm from the \`stages\` in gkm.config.ts — do not edit.
+// \`gkm dev\`, \`gkm build\` and \`gkm test --prepare\` rewrite it.
+export {};
+
+declare module '@geekmidas/constructs' {
+	interface Stages {
+		local: ${union([stages.local])};
+		deployed: ${union(stages.deployed)};
+	}
+}
+`;
+}
+/**
+* Write `.gkm/stages.d.ts` under the workspace root, and return its path — or
+* nothing when there are no stages to write. Left untouched when unchanged, so
+* an editor's watcher does not re-check the project on every start.
+*/
+async function writeStageTypes(root, stages) {
+	if (!stages) return void 0;
+	const path = join(root, STAGE_TYPES_FILE);
+	const content = stageTypesDeclaration(stages);
+	if (await readFile(path, "utf8").catch(() => void 0) === content) return path;
+	await mkdir(join(root, ".gkm"), { recursive: true });
+	await writeFile(path, content);
+	return path;
+}
+//#endregion
 //#region src/dev/credentials.ts
 /**
 * `gkm dev:credentials` — where to sign in to each local service, and as
@@ -1806,8 +1854,10 @@ async function devCommand(options) {
 	if (!appConfig) {
 		logger$5.log("🔎 Reading gkm.config.ts and the constructs");
 		const { workspace: everything } = await loadWorkspaceConfig();
+		await writeStageTypes(everything.root, everything.stages);
 		return workspaceDevCommand(everything, options);
 	}
+	await writeStageTypes(appConfig.workspace.root, appConfig.workspace.stages);
 	const config = appConfig.gkmConfig;
 	const appRoot = appConfig.appRoot;
 	const secretsRoot = appConfig.workspaceRoot;
@@ -3138,6 +3188,7 @@ var UnknownCacheBackend = class extends Error {
 };
 async function buildCommand(options) {
 	const loadedConfig = await loadWorkspaceConfig();
+	await writeStageTypes(loadedConfig.workspace.root, loadedConfig.workspace.stages);
 	if (loadedConfig.type === "workspace") {
 		const cwd = resolve(process.cwd());
 		const workspaceRoot = resolve(loadedConfig.workspace.root);
@@ -5219,25 +5270,25 @@ function loadPackageJson() {
 * Run: pnpm --filter @geekmidas/cli sync-versions
 */
 const GEEKMIDAS_VERSIONS = {
-	"@geekmidas/audit": "~10.0.0-alpha.86",
-	"@geekmidas/auth": "~10.0.0-alpha.86",
-	"@geekmidas/cache": "~10.0.0-alpha.86",
-	"@geekmidas/client": "~10.0.0-alpha.86",
-	"@geekmidas/cloud": "~10.0.0-alpha.86",
-	"@geekmidas/constructs": "~10.0.0-alpha.86",
-	"@geekmidas/db": "~10.0.0-alpha.86",
-	"@geekmidas/emailkit": "~10.0.0-alpha.86",
-	"@geekmidas/envkit": "~10.0.0-alpha.86",
-	"@geekmidas/errors": "~10.0.0-alpha.86",
-	"@geekmidas/events": "~10.0.0-alpha.86",
-	"@geekmidas/logger": "~10.0.0-alpha.86",
-	"@geekmidas/manifest": "~10.0.0-alpha.86",
-	"@geekmidas/rate-limit": "~10.0.0-alpha.86",
-	"@geekmidas/schema": "~10.0.0-alpha.86",
-	"@geekmidas/services": "~10.0.0-alpha.86",
-	"@geekmidas/storage": "~10.0.0-alpha.86",
-	"@geekmidas/telescope": "~10.0.0-alpha.86",
-	"@geekmidas/testkit": "~10.0.0-alpha.86",
+	"@geekmidas/audit": "~10.0.0-alpha.88",
+	"@geekmidas/auth": "~10.0.0-alpha.88",
+	"@geekmidas/cache": "~10.0.0-alpha.88",
+	"@geekmidas/client": "~10.0.0-alpha.88",
+	"@geekmidas/cloud": "~10.0.0-alpha.88",
+	"@geekmidas/constructs": "~10.0.0-alpha.88",
+	"@geekmidas/db": "~10.0.0-alpha.88",
+	"@geekmidas/emailkit": "~10.0.0-alpha.88",
+	"@geekmidas/envkit": "~10.0.0-alpha.88",
+	"@geekmidas/errors": "~10.0.0-alpha.88",
+	"@geekmidas/events": "~10.0.0-alpha.88",
+	"@geekmidas/logger": "~10.0.0-alpha.88",
+	"@geekmidas/manifest": "~10.0.0-alpha.88",
+	"@geekmidas/rate-limit": "~10.0.0-alpha.88",
+	"@geekmidas/schema": "~10.0.0-alpha.88",
+	"@geekmidas/services": "~10.0.0-alpha.88",
+	"@geekmidas/storage": "~10.0.0-alpha.88",
+	"@geekmidas/telescope": "~10.0.0-alpha.88",
+	"@geekmidas/testkit": "~10.0.0-alpha.88",
 	"@geekmidas/cli": `~${loadPackageJson().version}`
 };
 //#endregion
@@ -5288,7 +5339,7 @@ function generateAuthAppFiles(options) {
 				[`@${options.name}/*`]: ["../../packages/*/src"]
 			}
 		},
-		include: ["src/**/*.ts"],
+		include: ["src/**/*.ts", "../../.gkm/stages.d.ts"],
 		exclude: ["node_modules", "dist"]
 	};
 	return [
@@ -5399,7 +5450,7 @@ export default defineConfig({${stagesBlock(options.stages)}${options.monorepo ?
 	gkmConfig += `
 });
 `;
-	const tsConfig = options.monorepo ? workspaceApiTsConfig(options.name) : {
+	const tsConfig = options.monorepo ? workspaceApiTsConfig(options.name, ".gkm/stages.d.ts") : {
 		compilerOptions: {
 			target: "ES2022",
 			module: "NodeNext",
@@ -5414,7 +5465,7 @@ export default defineConfig({${stagesBlock(options.stages)}${options.monorepo ?
 			allowImportingTsExtensions: true,
 			paths: { "~/*": ["./src/*"] }
 		},
-		include: ["src/**/*.ts"],
+		include: ["src/**/*.ts", ".gkm/stages.d.ts"],
 		exclude: ["node_modules", "dist"]
 	};
 	if (options.monorepo) {
@@ -5529,7 +5580,7 @@ export default defineConfig({${stagesBlock(options.stages)}${options.monorepo ?
 * the root constructs, so in the other `@<name>/constructs/api.ts` fell through
 * to the `packages/` mapping and nothing could load the surface.
 */
-function workspaceApiTsConfig(name) {
+function workspaceApiTsConfig(name, stageTypes) {
 	return {
 		extends: "../../tsconfig.json",
 		compilerOptions: {
@@ -5541,12 +5592,12 @@ function workspaceApiTsConfig(name) {
 				[`@${name}/*`]: ["../../packages/*/src"]
 			}
 		},
-		include: ["src/**/*.ts"],
+		include: ["src/**/*.ts", stageTypes],
 		exclude: ["node_modules", "dist"]
 	};
 }
 function generateSingleAppConfigFiles(options, _template, _helpers) {
-	const tsConfig = workspaceApiTsConfig(options.name);
+	const tsConfig = workspaceApiTsConfig(options.name, "../../.gkm/stages.d.ts");
 	const files = [{
 		path: "tsconfig.json",
 		content: `${JSON.stringify(tsConfig, null, 2)}\n`
@@ -5638,7 +5689,7 @@ const COMMIT = /^[0-9a-f]{40}$/;
 * The `uses:` value for the stages action, with a comment saying which CLI
 * release the pinned commit is.
 */
-function stagesActionUses(commit = "4b431683030dbd72d145ef850ef5348106aac97f", version = cliVersion()) {
+function stagesActionUses(commit = "5bd5a7422c74b30cb3c285d0717da882171c103a", version = cliVersion()) {
 	return commit && COMMIT.test(commit) ? `${STAGES_ACTION}@${commit} # @geekmidas/cli ${version}` : `${STAGES_ACTION}@main # pin to a commit SHA: see the action's README`;
 }
 //#endregion
@@ -7398,6 +7449,7 @@ ${isSst ? "\n# SST\n.sst/\n" : ""}`;
 			forceConsistentCasingInFileNames: true,
 			resolveJsonModule: true
 		},
+		include: ["**/*", ".gkm/stages.d.ts"],
 		exclude: [
 			"node_modules",
 			"dist",
@@ -10938,7 +10990,6 @@ const logger$1 = console;
 * machine, so no container is started for one.
 */
 async function setupCommand(options = {}) {
-	logger$1.log("\n🔧 Setting up the local environment...\n");
 	let loadedConfig;
 	try {
 		loadedConfig = await loadWorkspaceConfig();
@@ -10949,6 +11000,7 @@ async function setupCommand(options = {}) {
 	const stage = options.stage ?? loadedConfig.workspace.stages.local;
 	const { workspace } = loadedConfig;
 	const local = stage === workspace.stages.local;
+	logger$1.log(local ? "\n🔧 Setting up the local environment...\n" : `\n☁️  Provisioning the '${stage}' stage${options.dryRun ? " (dry run)" : ""}...\n`);
 	logger$1.log(`📦 Workspace: ${workspace.name}`);
 	logger$1.log(`📱 Apps: ${Object.keys(workspace.apps).join(", ")}`);
 	logger$1.log(`🔑 Stage: ${stage}\n`);
@@ -11260,6 +11312,7 @@ async function testCommand(options = {}) {
 	const preloadPath = join(gkmDir, "test-credentials-preload.ts");
 	await createCredentialsPreload(preloadPath, result.secretsJsonPath);
 	const workspace = await loadWorkspaceConfig(cwd).then((loaded) => loaded.workspace).catch(() => void 0);
+	if (workspace) await writeStageTypes(workspace.root, workspace.stages);
 	const manifestPath = workspace ? await writeTestHarness({
 		root: workspace.root,
 		targets: [workspace.root, ...Object.values(workspace.apps).map((app) => isAbsolute(app.path) ? app.path : join(workspace.root, app.path))],