@stacksjs/actions 0.72.79 → 0.72.81

package/dist/generate/env-files.d.ts

@@ -1,9 +1,17 @@
 /**
  * The text of `storage/framework/types/env.d.ts`.
  *
+ * Bun's `env` namespace only. The `env` exported by '@stacksjs/env' used to be
+ * augmented from here too, and that was the wrong source: the key set came
+ * from whichever `.env` was on the machine running the generator, so a
+ * variable set only in deploy secrets could never be typed, and each type was
+ * read off the variable's live value, so the same variable could be `number`
+ * here and `string` on a colleague's checkout. `StacksEnv` is now extended
+ * from `config/env.ts`, which declares those variables anyway and is committed.
+ *
  * Pure, so the shape can be asserted without writing into the framework.
  */
-export declare function renderEnvTypes(keys: string[], alreadyDeclared: ReadonlySet<string>, typeOf: (key: string) => string): string;
+export declare function renderEnvTypes(keys: string[], typeOf: (key: string) => string): string;
 /**
  * Write `storage/framework/types/env.d.ts` and `storage/framework/env.ts`.
  *

package/dist/generate/env-files.js

@@ -1,12 +1,25 @@
-import{env as e,envEnum,parse}from"@stacksjs/env";import{log}from"@stacksjs/logging";import{path as p}from"@stacksjs/path";import{storage}from"@stacksjs/storage";import{existsSync,readFileSync}from"node:fs";function previouslyDeclaredKeys(){const file=p.frameworkPath("env.ts");if(!existsSync(file))return[];return[...(readFileSync(file,"utf8").match(/export const envKeys = \[([^\]]*)\]/)?.[1]??"").matchAll(/'([A-Z0-9_]+)'/g)].map((match)=>match[1])}function frameworkDeclaredKeys(){const file=[p.frameworkPath("core/env/src/types.ts"),p.projectPath("node_modules/@stacksjs/env/dist/types.d.ts")].find((candidate)=>existsSync(candidate));if(!file)return new Set;const body=readFileSync(file,"utf8"),start=body.indexOf("interface StacksEnv");if(start===-1)return new Set;const block=body.slice(start,body.indexOf(`
-}`,start));return new Set([...block.matchAll(/^\s{2}([A-Z][A-Z0-9_]*)\??:/gm)].map((match)=>match[1]))}function resolveEnvKeys(){const keys=new Set(previouslyDeclaredKeys());for(const file of[".env",".env.example"]){const path=p.projectPath(file);if(!existsSync(path))continue;for(const key of Object.keys(parse(readFileSync(path,"utf8")).parsed))keys.add(key)}return[...keys].sort()}export function renderEnvTypes(keys,alreadyDeclared,typeOf){const resolvedKeys=keys;return`
+import{env as e,envEnum,parse}from"@stacksjs/env";import{log}from"@stacksjs/logging";import{path as p}from"@stacksjs/path";import{storage}from"@stacksjs/storage";import{existsSync,readFileSync}from"node:fs";function previouslyDeclaredKeys(){const file=p.frameworkPath("env.ts");if(!existsSync(file))return[];return[...(readFileSync(file,"utf8").match(/export const envKeys = \[([^\]]*)\]/)?.[1]??"").matchAll(/'([A-Z0-9_]+)'/g)].map((match)=>match[1])}function resolveEnvKeys(){const keys=new Set(previouslyDeclaredKeys());for(const file of[".env",".env.example"]){const path=p.projectPath(file);if(!existsSync(path))continue;for(const key of Object.keys(parse(readFileSync(path,"utf8")).parsed))keys.add(key)}return[...keys].sort()}export function renderEnvTypes(keys,typeOf){return`
 // This file is auto-generated by Stacks. Do not edit this file manually.
 // If you want to change the environment variables, please edit the .env file.
 //
+// This types \`Bun.env.SOMETHING\`. The \`env\` exported by '@stacksjs/env' is
+// typed from your \`config/env.ts\` instead - declare a variable there and it
+// is typed everywhere, with no generation step:
+//
+//   const envSchema = defineEnv({
+//     STRIPE_WEBHOOK_SECRET: { validation: schema.string(), default: '' },
+//   })
+//
+//   declare module '@stacksjs/env' {
+//     interface StacksEnv extends InferEnv<typeof envSchema> {}
+//   }
+//
+//   export default envSchema
+//
 // For more information, please visit: https://stacksjs.com/docs
 
-// Marks this file as a module, which is what makes the blocks below
-// augmentations. In a global script file \`declare module 'x'\` declares an
+// Marks this file as a module, which is what makes the block below an
+// augmentation. In a global script file \`declare module 'x'\` declares an
 // ambient module instead, shadowing the real one \u2014 which took '@stacksjs/env'
 // down to only the members named here and broke every \`import { env }\` in
 // config/ with "has no exported member 'env'".
@@ -14,24 +27,11 @@ export {}
 
 declare module 'bun' {
   namespace env {
-    ${resolvedKeys.map((key)=>`const ${key}: ${typeOf(key)}`).join(`
-    `)}
-  }
-}
-
-// The \`env\` exported by '@stacksjs/env' is typed by StacksEnv, not by Bun's
-// namespace, and its catch-all index signature gives any variable the
-// framework does not name the type \`string | number | boolean | undefined\`.
-// That is assignable to nothing, so reading a project's own variable in
-// \`config/\` failed to typecheck against a plain \`string\` field. Declared
-// here, each one gets the type its value implies.
-declare module '@stacksjs/env' {
-  interface StacksEnv {
-    ${resolvedKeys.filter((key)=>!alreadyDeclared.has(key)).map((key)=>`${key}: ${typeOf(key)} | undefined`).join(`
+    ${keys.map((key)=>`const ${key}: ${typeOf(key)}`).join(`
     `)}
   }
 }
-`}export async function generateEnvFiles(){log.info("Generating type env files...");const resolvedKeys=resolveEnvKeys(),alreadyDeclared=frameworkDeclaredKeys();function typeOf(key){let type=typeof e[key],value=e[key];if(!value)if(envEnum[key]){type=envEnum[key]?.map((item)=>`'${item}'`).join(" | ");value=envEnum[key]?.[0]}else switch(type){case"number":value="0";break;case"boolean":value=!1;break;default:value=""}type="string";if(typeof value==="string"){if(value.toLowerCase()==="true"||value.toLowerCase()==="false")type="boolean";else if(!Number.isNaN(Number.parseFloat(value))&&Number.isFinite(Number(value)))type="number";else if(envEnum[key])type=envEnum[key].map((item)=>`'${item}'`).join(" | ")}else if(typeof value==="number")type="number";else if(typeof value==="boolean")type="boolean";return type}const envTypes=renderEnvTypes(resolvedKeys,alreadyDeclared,typeOf);await storage.writeFile(p.frameworkPath("types/env.d.ts"),envTypes);log.info("  - ./storage/framework/env.ts");const env=`
+`}export async function generateEnvFiles(){log.info("Generating type env files...");const resolvedKeys=resolveEnvKeys();function typeOf(key){let type=typeof e[key],value=e[key];if(!value)if(envEnum[key]){type=envEnum[key]?.map((item)=>`'${item}'`).join(" | ");value=envEnum[key]?.[0]}else switch(type){case"number":value="0";break;case"boolean":value=!1;break;default:value=""}type="string";if(typeof value==="string"){if(value.toLowerCase()==="true"||value.toLowerCase()==="false")type="boolean";else if(!Number.isNaN(Number.parseFloat(value))&&Number.isFinite(Number(value)))type="number";else if(envEnum[key])type=envEnum[key].map((item)=>`'${item}'`).join(" | ")}else if(typeof value==="number")type="number";else if(typeof value==="boolean")type="boolean";return type}const envTypes=renderEnvTypes(resolvedKeys,typeOf);await storage.writeFile(p.frameworkPath("types/env.d.ts"),envTypes);log.info("  - ./storage/framework/env.ts");const env=`
 // This file is auto-generated by Stacks. Do not edit this file manually.
 // If you want to change the environment variables, please edit the .env file.
 //

package/package.json

@@ -2,7 +2,7 @@
   "name": "@stacksjs/actions",
   "type": "module",
   "sideEffects": false,
-  "version": "0.72.79",
+  "version": "0.72.81",
   "description": "The Stacks actions.",
   "author": "Chris Breuer",
   "contributors": [
@@ -60,35 +60,35 @@
     "prepublishOnly": "bun run build"
   },
   "dependencies": {
-    "@stacksjs/config": "0.72.79",
+    "@stacksjs/config": "0.72.81",
     "@stacksjs/bumpx": "^0.2.6",
     "@stacksjs/bunpress": "^0.2.8",
     "@stacksjs/logsmith": "^0.2.3",
-    "@stacksjs/registry": "0.72.79",
+    "@stacksjs/registry": "0.72.81",
     "@stacksjs/stx": "^0.2.230",
-    "@stacksjs/ts-cloud": "^0.12.4",
+    "@stacksjs/ts-cloud": "^0.12.5",
     "@stacksjs/ts-md": "^0.1.1"
   },
   "devDependencies": {
-    "@stacksjs/api": "0.72.79",
-    "@stacksjs/cli": "0.72.79",
-    "@stacksjs/database": "0.72.79",
+    "@stacksjs/api": "0.72.81",
+    "@stacksjs/cli": "0.72.81",
+    "@stacksjs/database": "0.72.81",
     "@stacksjs/tlsx": "^0.13.2",
     "better-dx": "^0.2.24",
-    "@stacksjs/dns": "0.72.79",
-    "@stacksjs/enums": "0.72.79",
-    "@stacksjs/env": "0.72.79",
-    "@stacksjs/error-handling": "0.72.79",
-    "@stacksjs/image": "0.72.79",
-    "@stacksjs/logging": "0.72.79",
-    "@stacksjs/path": "0.72.79",
-    "@stacksjs/security": "0.72.79",
-    "@stacksjs/cms": "0.72.79",
-    "@stacksjs/sites": "0.72.79",
-    "@stacksjs/storage": "0.72.79",
-    "@stacksjs/strings": "0.72.79",
-    "@stacksjs/utils": "0.72.79",
-    "@stacksjs/validation": "0.72.79"
+    "@stacksjs/dns": "0.72.81",
+    "@stacksjs/enums": "0.72.81",
+    "@stacksjs/env": "0.72.81",
+    "@stacksjs/error-handling": "0.72.81",
+    "@stacksjs/image": "0.72.81",
+    "@stacksjs/logging": "0.72.81",
+    "@stacksjs/path": "0.72.81",
+    "@stacksjs/security": "0.72.81",
+    "@stacksjs/cms": "0.72.81",
+    "@stacksjs/sites": "0.72.81",
+    "@stacksjs/storage": "0.72.81",
+    "@stacksjs/strings": "0.72.81",
+    "@stacksjs/utils": "0.72.81",
+    "@stacksjs/validation": "0.72.81"
   },
   "peerDependencies": {
     "pickier": "^0.1.58",