@stacksjs/config 0.74.28 → 0.74.31

package/dist/discovered-resources.d.ts

@@ -1,3 +1,37 @@
+/**
+ * Migration directories each discovered package contributes.
+ *
+ * These are read, never written. The migration runner deletes and rewrites
+ * files in the corpus it runs - SQLite preprocessing drops statements it
+ * cannot execute and prunes duplicate CREATEs - so a package's own directory
+ * is copied out of before any of that happens. Doing otherwise would have the
+ * framework mutating an installed package's files, which a reinstall silently
+ * undoes.
+ */
+export declare function packageMigrationRoots(options?: PackageResourceOptions): PackageResourceRoot[];
+/**
+ * Job directories each discovered package contributes.
+ *
+ * Conventional, like models, rather than opt-in like components. A job is
+ * reached by its exported name from the barrel and is inert until something
+ * dispatches or schedules it, so a package shipping `app/Jobs` it did not mean
+ * to publish costs a name in the barrel and nothing else.
+ */
+export declare function packageJobRoots(options?: PackageResourceOptions): PackageResourceRoot[];
+/**
+ * Component directories each discovered package contributes.
+ *
+ * Opt-in, unlike every other surface here: a package contributes components
+ * only by declaring `"components"` in its `stacks` key. Components resolve by
+ * bare tag name across every template in the process, so a directory picked up
+ * by convention would silently enter that namespace.
+ *
+ * The caller decides precedence. Placing these AFTER the framework's own
+ * component directories makes a package purely additive, which is what the
+ * shipped stx plugin does - stx searches its component list in order and takes
+ * the first match.
+ */
+export declare function packageComponentRoots(options?: PackageResourceOptions): PackageResourceRoot[];
 /** View directories each discovered package contributes. */
 export declare function packageViewRoots(options?: PackageResourceOptions): PackageResourceRoot[];
 /**

package/dist/discovered-resources.js

@@ -1 +1 @@
-import{existsSync,readFileSync}from"node:fs";import{isAbsolute,join}from"node:path";import{path}from"@stacksjs/path";const IMPLIED_DIRS={views:["resources/views"],models:["app/Models"]};function readManifest(manifestPath){try{return JSON.parse(readFileSync(manifestPath,"utf8"))?.packages??{}}catch{return{}}}function resourceRoots(field,options={}){const manifestPath=options.manifestPath??path.storagePath("framework/discovered-packages.json"),projectRoot=options.projectRoot??path.projectPath(),exists=options.exists??existsSync,roots=[];for(const[name,meta]of Object.entries(readManifest(manifestPath))){const declared=meta?.[field]??IMPLIED_DIRS[field];if(!declared)continue;const root=meta.root;if(!root||typeof root!=="string")continue;const base=isAbsolute(root)?root:join(projectRoot,root);for(const entry of Array.isArray(declared)?declared:[declared]){if(typeof entry!=="string"||!entry)continue;const cleaned=entry.replace(/^[/\\]+/,"");if(!cleaned||cleaned.split(/[/\\]/).includes(".."))continue;const dir=join(base,cleaned);if(exists(dir))roots.push({package:name,dir})}}return roots.sort((a,b)=>a.package.localeCompare(b.package))}export function packageViewRoots(options={}){return resourceRoots("views",options)}export function packageModelRoots(options={}){return resourceRoots("models",options)}
+import{existsSync,readFileSync}from"node:fs";import{isAbsolute,join}from"node:path";import{path}from"@stacksjs/path";const IMPLIED_DIRS={views:["resources/views"],models:["app/Models"],migrations:["database/migrations"],jobs:["app/Jobs"]};function readManifest(manifestPath){try{return JSON.parse(readFileSync(manifestPath,"utf8"))?.packages??{}}catch{return{}}}function resourceRoots(field,options={}){const manifestPath=options.manifestPath??path.storagePath("framework/discovered-packages.json"),projectRoot=options.projectRoot??path.projectPath(),exists=options.exists??existsSync,roots=[];for(const[name,meta]of Object.entries(readManifest(manifestPath))){const declared=meta?.[field]??IMPLIED_DIRS[field];if(!declared)continue;const root=meta.root;if(!root||typeof root!=="string")continue;const base=isAbsolute(root)?root:join(projectRoot,root);for(const entry of Array.isArray(declared)?declared:[declared]){if(typeof entry!=="string"||!entry)continue;const cleaned=entry.replace(/^[/\\]+/,"");if(!cleaned||cleaned.split(/[/\\]/).includes(".."))continue;const dir=join(base,cleaned);if(exists(dir))roots.push({package:name,dir})}}return roots.sort((a,b)=>a.package.localeCompare(b.package))}export function packageMigrationRoots(options={}){return resourceRoots("migrations",options)}export function packageJobRoots(options={}){return resourceRoots("jobs",options)}export function packageComponentRoots(options={}){return resourceRoots("components",options)}export function packageViewRoots(options={}){return resourceRoots("views",options)}export function packageModelRoots(options={}){return resourceRoots("models",options)}

package/dist/index.d.ts

@@ -12,7 +12,7 @@ export * from './config';
 export { FRAMEWORK_DEFAULTS } from './defaults';
 export { validateConfig, reportConfigIssues, type ConfigValidationIssue } from './validators';
 export { feature, enableFeature, disableFeature, resetFeature, listFeatures } from './features';
-export { packageModelRoots, packageViewRoots, type PackageResourceOptions, type PackageResourceRoot } from './discovered-resources';
+export { packageComponentRoots, packageJobRoots, packageMigrationRoots, packageModelRoots, packageViewRoots, type PackageResourceOptions, type PackageResourceRoot } from './discovered-resources';
 export { resolveViewPatterns, type DefaultViewsSetting, type ViewPatternResolution } from './views';
 export {
   createRequestContext,

package/dist/index.js

@@ -1 +1 @@
-export*from"./config";export{FRAMEWORK_DEFAULTS}from"./defaults";export{validateConfig,reportConfigIssues}from"./validators";export{feature,enableFeature,disableFeature,resetFeature,listFeatures}from"./features";export{packageModelRoots,packageViewRoots}from"./discovered-resources";export{resolveViewPatterns}from"./views";export{createRequestContext,installRequestContext,parseCookieHeader,useRequestEvent}from"./request-context";export*from"./capabilities";
+export*from"./config";export{FRAMEWORK_DEFAULTS}from"./defaults";export{validateConfig,reportConfigIssues}from"./validators";export{feature,enableFeature,disableFeature,resetFeature,listFeatures}from"./features";export{packageComponentRoots,packageJobRoots,packageMigrationRoots,packageModelRoots,packageViewRoots}from"./discovered-resources";export{resolveViewPatterns}from"./views";export{createRequestContext,installRequestContext,parseCookieHeader,useRequestEvent}from"./request-context";export*from"./capabilities";

package/dist/overrides.d.ts

@@ -9,6 +9,22 @@ import type { StacksConfig } from '@stacksjs/types';
  * APP_NAME / APP_ENV win where set - without depending on any of that.
  */
 export declare function defaultsForOverrides(): StacksConfig;
+/**
+ * Which of a config's accepted filenames this project actually ships.
+ *
+ * The first one on disk wins, and the primary name is first, so no project
+ * that resolves today resolves differently. Falling through the list rather
+ * than importing a missing path keeps the loader's ENOENT handling meaning
+ * "this project ships no config of this kind" rather than "the primary name
+ * was absent" - which is what made the stx/ui split invisible: `config/stx.ts`
+ * is a name stx itself accepts, and this loader read straight past it, leaving
+ * `config.ui` undefined while stx reported the file loaded fine
+ * (stacksjs/stacks#2446).
+ *
+ * Both present is ambiguous rather than wrong, so it warns and takes the
+ * primary instead of guessing silently.
+ */
+export declare function resolveUserConfigName(names: [string, ...string[]], cwd?: unknown): string;
 export declare function userConfigUrl(name: string, cwd?: unknown): string;
 export declare const overrides: StacksConfig;
 export declare const overridesReady: Promise<StacksConfig>;

package/dist/overrides.js

@@ -1,4 +1,4 @@
-import{resolve}from"node:path";import{pathToFileURL}from"node:url";import{defaults}from"./defaults";import{validateConfig}from"./validators";const skipConfigLoading=process.env.SKIP_CONFIG_LOADING==="true",skipConfigValidation=process.env.SKIP_CONFIG_VALIDATION==="true",OVERRIDES_KEY=Symbol.for("@stacksjs/config:overrides"),READY_KEY=Symbol.for("@stacksjs/config:overridesReady");export function defaultsForOverrides(){return{ai:{},analytics:{},app:{...defaults.app,name:process.env.APP_NAME||defaults.app?.name||"Stacks",env:process.env.APP_ENV||"production"},auth:{},cache:{},cli:{},cloud:{},cms:{},commerce:{},dashboard:{},database:{},dns:{},realtime:{},email:{},errors:{},featureFlags:{},git:{},hashing:{},images:{},library:{},logging:{},marketing:{},monitoring:{},notification:{},queue:{},payment:{},ports:{},saas:{},searchEngine:{},security:{},server:{},sites:{},forms:{},services:{},filesystems:{},team:{},ui:{}}}const globalScope=globalThis,sharedOverrides=globalScope[OVERRIDES_KEY];export const overrides=sharedOverrides??(()=>{const created=defaultsForOverrides();globalScope[OVERRIDES_KEY]=created;return created})();const userConfigs=[["ai","ai"],["analytics","analytics"],["app","app"],["auth","auth"],["cache","cache"],["cli","cli"],["cloud","cloud"],["cms","cms"],["commerce","commerce"],["cors","cors"],["dashboard","dashboard"],["database","database"],["dns","dns"],["docs","docs"],["email","email"],["errors","errors"],["featureFlags","feature-flags"],["git","git"],["hashing","hashing"],["images","images"],["library","library"],["logging","logging"],["marketing","marketing"],["monitoring","monitoring"],["notification","notification"],["payment","payment"],["ports","ports"],["queue","queue"],["realtime","realtime"],["saas","saas"],["searchEngine","search-engine"],["security","security"],["sites","sites"],["forms","forms"],["server","server"],["services","services"],["filesystems","filesystems"],["team","team"],["ui","ui"]];export function userConfigUrl(name,cwd=process.cwd()){return pathToFileURL(resolve(cwd,"config",`${name}.ts`)).href}const sharedReady=globalScope[READY_KEY];export const overridesReady=sharedReady??(()=>{const promise=skipConfigLoading?Promise.resolve(overrides):Promise.all(userConfigs.map(async([key,name])=>{const modulePath=userConfigUrl(name);try{const mod=await import(modulePath);if(mod?.default!==void 0)overrides[key]=mod.default}catch(err){const code=err?.code,msg=err?.message??String(err);if(!(code==="ERR_MODULE_NOT_FOUND"||code==="MODULE_NOT_FOUND"||/Cannot find module/i.test(msg)))console.warn(`[config] Failed to load ${String(key)} config from ${modulePath}: ${msg}`)}})).then(()=>{if(!skipConfigValidation){const issues=validateConfig(overrides);if(issues.length>0){console.error("[config] Configuration issues detected:");for(const issue of issues)console.error(`  \u2022 ${issue.path}: ${issue.message}`);const summary=issues.map((i)=>`  \u2022 ${i.path}: ${i.message}`).join(`
+import{existsSync}from"node:fs";import{resolve}from"node:path";import{pathToFileURL}from"node:url";import{defaults}from"./defaults";import{validateConfig}from"./validators";const skipConfigLoading=process.env.SKIP_CONFIG_LOADING==="true",skipConfigValidation=process.env.SKIP_CONFIG_VALIDATION==="true",OVERRIDES_KEY=Symbol.for("@stacksjs/config:overrides"),READY_KEY=Symbol.for("@stacksjs/config:overridesReady");export function defaultsForOverrides(){return{ai:{},analytics:{},app:{...defaults.app,name:process.env.APP_NAME||defaults.app?.name||"Stacks",env:process.env.APP_ENV||"production"},auth:{},cache:{},cli:{},cloud:{},cms:{},commerce:{},dashboard:{},database:{},dns:{},realtime:{},email:{},errors:{},featureFlags:{},git:{},hashing:{},images:{},library:{},logging:{},marketing:{},monitoring:{},notification:{},queue:{},payment:{},ports:{},saas:{},searchEngine:{},security:{},server:{},sites:{},forms:{},services:{},filesystems:{},team:{},ui:{}}}const globalScope=globalThis,sharedOverrides=globalScope[OVERRIDES_KEY];export const overrides=sharedOverrides??(()=>{const created=defaultsForOverrides();globalScope[OVERRIDES_KEY]=created;return created})();const userConfigs=[["ai","ai"],["analytics","analytics"],["app","app"],["auth","auth"],["cache","cache"],["cli","cli"],["cloud","cloud"],["cms","cms"],["commerce","commerce"],["cors","cors"],["dashboard","dashboard"],["database","database"],["dns","dns"],["docs","docs"],["email","email"],["errors","errors"],["featureFlags","feature-flags"],["git","git"],["hashing","hashing"],["images","images"],["library","library"],["logging","logging"],["marketing","marketing"],["monitoring","monitoring"],["notification","notification"],["payment","payment"],["ports","ports"],["queue","queue"],["realtime","realtime"],["saas","saas"],["searchEngine","search-engine"],["security","security"],["sites","sites"],["forms","forms"],["server","server"],["services","services"],["filesystems","filesystems"],["team","team"],["ui","ui","stx"]];export function resolveUserConfigName(names,cwd=process.cwd()){const present=names.filter((candidate)=>existsSync(resolve(cwd,"config",`${candidate}.ts`)));if(present.length>1)console.warn(`[config] config/${present.join(".ts and config/")}.ts both exist and configure the same thing. Using config/${present[0]}.ts; delete the other so every consumer agrees on one.`);return present[0]??names[0]}export function userConfigUrl(name,cwd=process.cwd()){return pathToFileURL(resolve(cwd,"config",`${name}.ts`)).href}const sharedReady=globalScope[READY_KEY];export const overridesReady=sharedReady??(()=>{const promise=skipConfigLoading?Promise.resolve(overrides):Promise.all(userConfigs.map(async([key,...names])=>{const name=resolveUserConfigName(names),modulePath=userConfigUrl(name);try{const mod=await import(modulePath);if(mod?.default!==void 0)overrides[key]=mod.default}catch(err){const code=err?.code,msg=err?.message??String(err);if(!(code==="ERR_MODULE_NOT_FOUND"||code==="MODULE_NOT_FOUND"||/Cannot find module/i.test(msg)))console.warn(`[config] Failed to load ${String(key)} config from ${modulePath}: ${msg}`)}})).then(()=>{if(!skipConfigValidation){const issues=validateConfig(overrides);if(issues.length>0){console.error("[config] Configuration issues detected:");for(const issue of issues)console.error(`  \u2022 ${issue.path}: ${issue.message}`);const summary=issues.map((i)=>`  \u2022 ${i.path}: ${i.message}`).join(`
 `);throw Error(`[config] ${issues.length} configuration issue(s) detected at boot:
 ${summary}
 Set SKIP_CONFIG_VALIDATION=true to bypass (e.g. when running migrations against partial config).`)}}return overrides});globalScope[READY_KEY]=promise;return promise})();export default overrides;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@stacksjs/config",
   "type": "module",
   "sideEffects": false,
-  "version": "0.74.28",
+  "version": "0.74.31",
   "description": "The Stacks config helper methods.",
   "author": "Chris Breuer",
   "contributors": [
@@ -55,14 +55,14 @@
     "prepublishOnly": "bun run build"
   },
   "dependencies": {
-    "@stacksjs/events": "0.74.28",
-    "@stacksjs/path": "0.74.28",
-    "@stacksjs/tunnel": "0.74.28",
+    "@stacksjs/events": "0.74.31",
+    "@stacksjs/path": "0.74.31",
+    "@stacksjs/tunnel": "0.74.31",
     "ts-pantry": "^0.11.35"
   },
   "devDependencies": {
-    "@stacksjs/alias": "0.74.28",
-    "@stacksjs/types": "0.74.28",
+    "@stacksjs/alias": "0.74.31",
+    "@stacksjs/types": "0.74.31",
     "better-dx": "^0.2.24"
   }
 }