@stacksjs/actions 0.70.336 → 0.70.337

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.
@@ -1 +1,15 @@
1
- export {};
1
+ /**
2
+ * The text of `storage/framework/types/env.d.ts`.
3
+ *
4
+ * Pure, so the shape can be asserted without writing into the framework.
5
+ */
6
+ export declare function renderEnvTypes(keys: string[], alreadyDeclared: ReadonlySet<string>, typeOf: (key: string) => string): string;
7
+ /**
8
+ * Write `storage/framework/types/env.d.ts` and `storage/framework/env.ts`.
9
+ *
10
+ * This was a top-level script with nothing importing it — no command, no
11
+ * build step, no test referenced the file — so the declarations it owns were
12
+ * whatever the last person to run it by hand had produced. `generateTypes()`
13
+ * calls it now.
14
+ */
15
+ export declare function generateEnvFiles(): Promise<void>;
@@ -1,25 +1,46 @@
1
- import{env as e,envEnum}from"@stacksjs/env";import{log}from"@stacksjs/logging";import{path as p}from"@stacksjs/path";import{storage}from"@stacksjs/storage";import{envKeys}from"../../../../env";log.info("Generating type env files...");const envTypes=`
1
+ 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(`
2
+ }`,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`
2
3
  // This file is auto-generated by Stacks. Do not edit this file manually.
3
4
  // If you want to change the environment variables, please edit the .env file.
4
5
  //
5
6
  // For more information, please visit: https://stacksjs.com/docs
6
7
 
8
+ // Marks this file as a module, which is what makes the blocks below
9
+ // augmentations. In a global script file \`declare module 'x'\` declares an
10
+ // ambient module instead, shadowing the real one \u2014 which took '@stacksjs/env'
11
+ // down to only the members named here and broke every \`import { env }\` in
12
+ // config/ with "has no exported member 'env'".
13
+ export {}
14
+
7
15
  declare module 'bun' {
8
16
  namespace env {
9
- ${envKeys.map((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`const ${key}: ${type}`}).join(`
17
+ ${resolvedKeys.map((key)=>`const ${key}: ${typeOf(key)}`).join(`
18
+ `)}
19
+ }
20
+ }
21
+
22
+ // The \`env\` exported by '@stacksjs/env' is typed by StacksEnv, not by Bun's
23
+ // namespace, and its catch-all index signature gives any variable the
24
+ // framework does not name the type \`string | number | boolean | undefined\`.
25
+ // That is assignable to nothing, so reading a project's own variable in
26
+ // \`config/\` failed to typecheck against a plain \`string\` field. Declared
27
+ // here, each one gets the type its value implies.
28
+ declare module '@stacksjs/env' {
29
+ interface StacksEnv {
30
+ ${resolvedKeys.filter((key)=>!alreadyDeclared.has(key)).map((key)=>`${key}: ${typeOf(key)} | undefined`).join(`
10
31
  `)}
11
32
  }
12
33
  }
13
- `;await storage.writeFile(p.frameworkPath("types/env.d.ts"),envTypes);log.info(" - ./storage/framework/env.ts");const env=`
34
+ `}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=`
14
35
  // This file is auto-generated by Stacks. Do not edit this file manually.
15
36
  // If you want to change the environment variables, please edit the .env file.
16
37
  //
17
38
  // For more information, please visit: https://stacksjs.com/docs
18
39
 
19
40
  export const envKeys = [
20
- ${envKeys.map((key)=>`'${key}'`).join(`,
41
+ ${resolvedKeys.map((key)=>`'${key}'`).join(`,
21
42
  `)}
22
43
  ] as const
23
44
 
24
45
  export type EnvKey = typeof envKeys[number]
25
- `;await storage.writeFile(p.frameworkPath("env.ts"),env);log.info(" - ./storage/framework/env.d.ts");
46
+ `;await storage.writeFile(p.frameworkPath("env.ts"),env);log.info(" - ./storage/framework/env.d.ts")}
@@ -1 +1 @@
1
- import*as fs from"node:fs";import process from"node:process";import{runCommand}from"@stacksjs/cli";import{Action,NpmScript}from"@stacksjs/enums";import{log}from"@stacksjs/logging";import{frameworkPath,projectPath,storagePath}from"@stacksjs/path";import{ExitCode}from"@stacksjs/types";import{runNpmScript}from"@stacksjs/utils";import{runAction}from"../helpers";import{generateVsCodeCustomData as genVsCodeCustomData}from"../helpers/vscode-custom-data";import{generateProjectImages}from"./images";export{generateProjectImages}from"./images";export{generateVSchema}from"./vschema";export async function invoke(options){if(options?.types)await generateTypes(options);else if(options?.entries)await generateLibEntries(options);else if(options?.webTypes)await generateWebTypes(options);else if(options?.customData)await generateVsCodeCustomData();else if(options?.ideHelpers)await generateIdeHelpers(options);else if(options?.componentMeta)await generateComponentMeta();else if(options?.coreSymlink)await generateCoreSymlink();else if(options?.openApiSpec)await generateOpenApiSpec();else if(options?.images)await generateProjectImages({verbose:options?.verbose})}export function generate(options){return invoke(options)}export async function generateLibEntries(options){const result=await runAction(Action.GenerateLibraryEntries,{...options,cwd:projectPath()});if(result.isErr){log.error("There was an error generating your library entry points",result.error);process.exit(ExitCode.FatalError)}log.success("Library entry points generated successfully")}export async function generateWebTypes(options){const result=await runNpmScript(NpmScript.GenerateWebTypes,options);if(result.isErr){log.error("There was an error generating the web-types.json file.",result.error);process.exit(ExitCode.FatalError)}log.success("Successfully generated the web-types.json file")}export async function generateVsCodeCustomData(){const result=await genVsCodeCustomData();if(result.isErr){log.error("There was an error generating the custom-elements.json file.",result.error);process.exit(ExitCode.FatalError)}await runAction(Action.LintFix,{verbose:!0,cwd:projectPath()});log.success("Successfully generated the custom-elements.json file")}export async function generateIdeHelpers(options){const result=await runNpmScript(NpmScript.GenerateIdeHelpers,options);if(result.isErr){log.error("There was an error generating IDE helpers.",result.error);process.exit(ExitCode.FatalError)}await runAction(Action.LintFix,{verbose:!0,cwd:projectPath()});log.success("Successfully generated IDE helpers")}export async function generateComponentMeta(){const result=await genVsCodeCustomData();if(result.isErr){log.error("There was an error generating your component meta information.",result.error);process.exit(ExitCode.FatalError)}await runAction(Action.LintFix,{verbose:!0,cwd:projectPath()});log.success("Successfully generated component meta information")}export async function generateTypes(options){const entry=frameworkPath("core/actions/src/generate/types.ts");if(!fs.existsSync(entry)){await import(`./types?t=${Date.now()}`);return}const result=await runNpmScript(NpmScript.GenerateTypes,{cwd:frameworkPath(),...options});if(result.isErr){log.error("There was an error generating your types.",result.error);throw result.error instanceof Error?result.error:Error(String(result.error))}log.success("Types were generated successfully")}export async function watchTypes(options){try{const manifestPath=`${frameworkPath()}/package.json`,text=fs.existsSync(manifestPath)?fs.readFileSync(manifestPath,"utf-8"):"";if(!(text?JSON.parse(text):{})?.scripts?.["generate:types"]){log.warn("[generate:types --watch] no `generate:types` script in framework package.json \u2014 type regeneration disabled. dev:api will keep running, but type definitions won't auto-refresh on model/config changes.");return}}catch{}const watched=[projectPath("app/Models"),storagePath("framework/defaults/app/Models"),projectPath("config"),projectPath("database/migrations")];log.info(`[generate:types --watch] watching ${watched.length} directories`);let pending=null,inflight=!1;const trigger=()=>{if(pending)clearTimeout(pending);pending=setTimeout(async()=>{if(inflight)return;inflight=!0;try{log.info("[generate:types --watch] change detected, regenerating\u2026");await generateTypes(options);log.success("[generate:types --watch] types up to date")}catch(err){log.error("[generate:types --watch] regeneration failed:",err)}finally{inflight=!1}},200)},watchers=[];for(const dir of watched)try{if(!fs.existsSync(dir))continue;const w=fs.watch(dir,{recursive:!0},()=>trigger());watchers.push(w)}catch(err){log.warn(`[generate:types --watch] cannot watch ${dir}: ${err}`)}if(watchers.length===0){log.warn("[generate:types --watch] no directories to watch \u2014 exiting");return}await new Promise((resolve)=>{process.once("SIGINT",()=>{log.info("[generate:types --watch] stopping");for(const w of watchers)try{w.close()}catch{}resolve()})})}export function generatePantryConfig(){log.success("Successfully generated `./pantry.yaml` based on your config")}export async function generateSeeder(){}export async function generateCoreSymlink(){const link=projectPath(".framework");if(fs.existsSync(link))await runCommand(`rm -f ${link}`);await runCommand(`ln -s ${frameworkPath()} ${link}`)}export async function generateOpenApiSpec(){const{generateOpenApi}=await import("@stacksjs/api");await generateOpenApi();log.success("Successfully generated Open API Spec")}
1
+ import*as fs from"node:fs";import process from"node:process";import{runCommand}from"@stacksjs/cli";import{Action,NpmScript}from"@stacksjs/enums";import{log}from"@stacksjs/logging";import{frameworkPath,projectPath,storagePath}from"@stacksjs/path";import{ExitCode}from"@stacksjs/types";import{runNpmScript}from"@stacksjs/utils";import{runAction}from"../helpers";import{generateVsCodeCustomData as genVsCodeCustomData}from"../helpers/vscode-custom-data";import{generateProjectImages}from"./images";import{generateEnvFiles}from"./env-files";export{generateProjectImages}from"./images";export{generateVSchema}from"./vschema";export async function invoke(options){if(options?.types)await generateTypes(options);else if(options?.entries)await generateLibEntries(options);else if(options?.webTypes)await generateWebTypes(options);else if(options?.customData)await generateVsCodeCustomData();else if(options?.ideHelpers)await generateIdeHelpers(options);else if(options?.componentMeta)await generateComponentMeta();else if(options?.coreSymlink)await generateCoreSymlink();else if(options?.openApiSpec)await generateOpenApiSpec();else if(options?.images)await generateProjectImages({verbose:options?.verbose})}export function generate(options){return invoke(options)}export async function generateLibEntries(options){const result=await runAction(Action.GenerateLibraryEntries,{...options,cwd:projectPath()});if(result.isErr){log.error("There was an error generating your library entry points",result.error);process.exit(ExitCode.FatalError)}log.success("Library entry points generated successfully")}export async function generateWebTypes(options){const result=await runNpmScript(NpmScript.GenerateWebTypes,options);if(result.isErr){log.error("There was an error generating the web-types.json file.",result.error);process.exit(ExitCode.FatalError)}log.success("Successfully generated the web-types.json file")}export async function generateVsCodeCustomData(){const result=await genVsCodeCustomData();if(result.isErr){log.error("There was an error generating the custom-elements.json file.",result.error);process.exit(ExitCode.FatalError)}await runAction(Action.LintFix,{verbose:!0,cwd:projectPath()});log.success("Successfully generated the custom-elements.json file")}export async function generateIdeHelpers(options){const result=await runNpmScript(NpmScript.GenerateIdeHelpers,options);if(result.isErr){log.error("There was an error generating IDE helpers.",result.error);process.exit(ExitCode.FatalError)}await runAction(Action.LintFix,{verbose:!0,cwd:projectPath()});log.success("Successfully generated IDE helpers")}export async function generateComponentMeta(){const result=await genVsCodeCustomData();if(result.isErr){log.error("There was an error generating your component meta information.",result.error);process.exit(ExitCode.FatalError)}await runAction(Action.LintFix,{verbose:!0,cwd:projectPath()});log.success("Successfully generated component meta information")}export async function generateTypes(options){await generateEnvFiles();const entry=frameworkPath("core/actions/src/generate/types.ts");if(!fs.existsSync(entry)){await import(`./types?t=${Date.now()}`);return}const result=await runNpmScript(NpmScript.GenerateTypes,{cwd:frameworkPath(),...options});if(result.isErr){log.error("There was an error generating your types.",result.error);throw result.error instanceof Error?result.error:Error(String(result.error))}log.success("Types were generated successfully")}export async function watchTypes(options){try{const manifestPath=`${frameworkPath()}/package.json`,text=fs.existsSync(manifestPath)?fs.readFileSync(manifestPath,"utf-8"):"";if(!(text?JSON.parse(text):{})?.scripts?.["generate:types"]){log.warn("[generate:types --watch] no `generate:types` script in framework package.json \u2014 type regeneration disabled. dev:api will keep running, but type definitions won't auto-refresh on model/config changes.");return}}catch{}const watched=[projectPath("app/Models"),storagePath("framework/defaults/app/Models"),projectPath("config"),projectPath("database/migrations")];log.info(`[generate:types --watch] watching ${watched.length} directories`);let pending=null,inflight=!1;const trigger=()=>{if(pending)clearTimeout(pending);pending=setTimeout(async()=>{if(inflight)return;inflight=!0;try{log.info("[generate:types --watch] change detected, regenerating\u2026");await generateTypes(options);log.success("[generate:types --watch] types up to date")}catch(err){log.error("[generate:types --watch] regeneration failed:",err)}finally{inflight=!1}},200)},watchers=[];for(const dir of watched)try{if(!fs.existsSync(dir))continue;const w=fs.watch(dir,{recursive:!0},()=>trigger());watchers.push(w)}catch(err){log.warn(`[generate:types --watch] cannot watch ${dir}: ${err}`)}if(watchers.length===0){log.warn("[generate:types --watch] no directories to watch \u2014 exiting");return}await new Promise((resolve)=>{process.once("SIGINT",()=>{log.info("[generate:types --watch] stopping");for(const w of watchers)try{w.close()}catch{}resolve()})})}export function generatePantryConfig(){log.success("Successfully generated `./pantry.yaml` based on your config")}export async function generateSeeder(){}export async function generateCoreSymlink(){const link=projectPath(".framework");if(fs.existsSync(link))await runCommand(`rm -f ${link}`);await runCommand(`ln -s ${frameworkPath()} ${link}`)}export async function generateOpenApiSpec(){const{generateOpenApi}=await import("@stacksjs/api");await generateOpenApi();log.success("Successfully generated Open API Spec")}
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@stacksjs/actions",
3
3
  "type": "module",
4
4
  "sideEffects": false,
5
- "version": "0.70.336",
5
+ "version": "0.70.337",
6
6
  "description": "The Stacks actions.",
7
7
  "author": "Chris Breuer",
8
8
  "contributors": [
@@ -59,33 +59,33 @@
59
59
  "prepublishOnly": "bun run build"
60
60
  },
61
61
  "dependencies": {
62
- "@stacksjs/config": "0.70.336",
62
+ "@stacksjs/config": "0.70.337",
63
63
  "@stacksjs/bumpx": "^0.2.6",
64
64
  "@stacksjs/bunpress": "^0.1.18",
65
65
  "@stacksjs/logsmith": "^0.2.3",
66
- "@stacksjs/registry": "0.70.336",
66
+ "@stacksjs/registry": "0.70.337",
67
67
  "@stacksjs/stx": "^0.2.148",
68
68
  "@stacksjs/ts-cloud": "^0.7.103",
69
69
  "@stacksjs/ts-md": "^0.1.1"
70
70
  },
71
71
  "devDependencies": {
72
- "@stacksjs/api": "0.70.336",
73
- "@stacksjs/cli": "0.70.336",
74
- "@stacksjs/database": "0.70.336",
72
+ "@stacksjs/api": "0.70.337",
73
+ "@stacksjs/cli": "0.70.337",
74
+ "@stacksjs/database": "0.70.337",
75
75
  "@stacksjs/tlsx": "^0.13.2",
76
76
  "better-dx": "^0.2.17",
77
- "@stacksjs/dns": "0.70.336",
78
- "@stacksjs/enums": "0.70.336",
79
- "@stacksjs/env": "0.70.336",
80
- "@stacksjs/error-handling": "0.70.336",
81
- "@stacksjs/image": "0.70.336",
82
- "@stacksjs/logging": "0.70.336",
83
- "@stacksjs/path": "0.70.336",
84
- "@stacksjs/security": "0.70.336",
85
- "@stacksjs/storage": "0.70.336",
86
- "@stacksjs/strings": "0.70.336",
87
- "@stacksjs/utils": "0.70.336",
88
- "@stacksjs/validation": "0.70.336"
77
+ "@stacksjs/dns": "0.70.337",
78
+ "@stacksjs/enums": "0.70.337",
79
+ "@stacksjs/env": "0.70.337",
80
+ "@stacksjs/error-handling": "0.70.337",
81
+ "@stacksjs/image": "0.70.337",
82
+ "@stacksjs/logging": "0.70.337",
83
+ "@stacksjs/path": "0.70.337",
84
+ "@stacksjs/security": "0.70.337",
85
+ "@stacksjs/storage": "0.70.337",
86
+ "@stacksjs/strings": "0.70.337",
87
+ "@stacksjs/utils": "0.70.337",
88
+ "@stacksjs/validation": "0.70.337"
89
89
  },
90
90
  "peerDependencies": {
91
91
  "pickier": "^0.1.35"