@stacksjs/config 0.74.20 → 0.74.21

package/dist/discovered-resources.d.ts

@@ -0,0 +1,34 @@
+/** View directories each discovered package contributes. */
+export declare function packageViewRoots(options?: PackageResourceOptions): PackageResourceRoot[];
+/**
+ * Model directories each discovered package contributes.
+ *
+ * One reader rather than one per consumer. The migration side and the
+ * auto-import barrel both need this answer, and they are in different packages;
+ * two copies of the resolution rule would eventually disagree about where a
+ * package lives, and routes and models would then point at different trees.
+ */
+export declare function packageModelRoots(options?: PackageResourceOptions): PackageResourceRoot[];
+/**
+ * The view directories that discovered packages contribute.
+ *
+ * A package declaring a `stacks` key already has its route files registered by
+ * the router. This is the same idea for templates, so a package can ship the
+ * pages that its routes render rather than asking the application to copy them
+ * in.
+ *
+ * The manifest is READ, not imported. `discoverPackages()` lives in
+ * `@stacksjs/actions`, which depends on this package, so importing it here
+ * would close a cycle. The router and the model resolver both read the same
+ * file for the same reason.
+ */
+/** One directory a discovered package contributes. */
+export declare interface PackageResourceRoot {
+  package: string
+  dir: string
+}
+export declare interface PackageResourceOptions {
+  manifestPath?: string
+  projectRoot?: string
+  exists?: (candidate: string) => boolean
+}

package/dist/discovered-resources.js

@@ -0,0 +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)}

package/dist/helpers.js

@@ -1 +1 @@
-import{config}from".";export async function localUrl(options={}){const domain=options.domain??config.app.url??"stacks",type=options.type??"frontend",localhost=options.localhost??!1,https=options.https,network=options.network;let url=domain.replace(/\.[^.]+$/,".localhost");async function tunnel(port){const{createLocalTunnel}=await import("@stacksjs/tunnel");return createLocalTunnel(port)}switch(type){case"frontend":if(network)return await tunnel(config.ports?.frontend||3000);if(localhost)return`http://localhost:${config.ports?.frontend}`;break;case"backend":if(network)return await tunnel(config.ports?.backend||3001);if(localhost)return`http://localhost:${config.ports?.backend}`;url=`api.${url}`;break;case"admin":if(network)return await tunnel(config.ports?.admin||3002);if(localhost)return`http://localhost:${config.ports?.admin}`;url=`admin.${url}`;break;case"library":if(network)return await tunnel(config.ports?.library||3003);if(localhost)return`http://localhost:${config.ports?.library}`;url=`libs.${url}`;break;case"email":if(network)return await tunnel(config.ports?.email||3005);if(localhost)return`http://localhost:${config.ports?.email}`;url=`email.${url}`;break;case"desktop":if(network)return await tunnel(config.ports?.desktop||3004);if(localhost)return`http://localhost:${config.ports?.desktop}`;url=`desktop.${url}`;break;case"docs":if(network)return await tunnel(config.ports?.docs||3006);if(localhost)return`http://localhost:${config.ports?.docs}`;url=`docs.${url}`;break;case"inspect":if(network)return await tunnel(config.ports?.inspect||3007);if(localhost)return`http://localhost:${config.ports?.inspect}`;url=`inspect.${url}`;break;default:if(localhost)return`http://localhost:${config.ports?.frontend}`}if(https)return`https://${url}`;return`http://${url}`}export function defineStacksConfig(config){return config}export function defineApp(config){return config}export function defineCache(config){return config}export function defineCdn(config){return config}export function defineChat(config){return config}export function defineCli(config){return config}export function defineDatabase(config){return config}export function defineDependencies(config){return config}export function defineDns(config){return config}export function defineEmailConfig(config){return config}export function defineEmail(config){return config}export function defineGit(config){return config}export function defineHashing(config){return config}export function defineImages(config){return config}export function defineLibrary(config){return config}export function defineNotification(config){return config}export function definePayment(config){return config}export function defineQueue(config){return config}export function defineSearchEngine(config){return config}export function defineSecurity(config){return config}export function defineServices(config){return config}export function defineSms(config){return config}export function defineStorage(config){return config}export function defineFilesystems(config){return config}export function defineFeatureFlags(config){return config}export function defineUi(config){return config}export{defineEvents}from"@stacksjs/events";
+import{config}from".";export async function localUrl(options={}){const domain=options.domain??config.app.url??"stacks",type=options.type??"frontend",localhost=options.localhost??!1,{https,network}=options;let url=domain.replace(/\.[^.]+$/,".localhost");async function tunnel(port){const{createLocalTunnel}=await import("@stacksjs/tunnel");return createLocalTunnel(port)}switch(type){case"frontend":if(network)return await tunnel(config.ports?.frontend||3000);if(localhost)return`http://localhost:${config.ports?.frontend}`;break;case"backend":if(network)return await tunnel(config.ports?.backend||3001);if(localhost)return`http://localhost:${config.ports?.backend}`;url=`api.${url}`;break;case"admin":if(network)return await tunnel(config.ports?.admin||3002);if(localhost)return`http://localhost:${config.ports?.admin}`;url=`admin.${url}`;break;case"library":if(network)return await tunnel(config.ports?.library||3003);if(localhost)return`http://localhost:${config.ports?.library}`;url=`libs.${url}`;break;case"email":if(network)return await tunnel(config.ports?.email||3005);if(localhost)return`http://localhost:${config.ports?.email}`;url=`email.${url}`;break;case"desktop":if(network)return await tunnel(config.ports?.desktop||3004);if(localhost)return`http://localhost:${config.ports?.desktop}`;url=`desktop.${url}`;break;case"docs":if(network)return await tunnel(config.ports?.docs||3006);if(localhost)return`http://localhost:${config.ports?.docs}`;url=`docs.${url}`;break;case"inspect":if(network)return await tunnel(config.ports?.inspect||3007);if(localhost)return`http://localhost:${config.ports?.inspect}`;url=`inspect.${url}`;break;default:if(localhost)return`http://localhost:${config.ports?.frontend}`}if(https)return`https://${url}`;return`http://${url}`}export function defineStacksConfig(config){return config}export function defineApp(config){return config}export function defineCache(config){return config}export function defineCdn(config){return config}export function defineChat(config){return config}export function defineCli(config){return config}export function defineDatabase(config){return config}export function defineDependencies(config){return config}export function defineDns(config){return config}export function defineEmailConfig(config){return config}export function defineEmail(config){return config}export function defineGit(config){return config}export function defineHashing(config){return config}export function defineImages(config){return config}export function defineLibrary(config){return config}export function defineNotification(config){return config}export function definePayment(config){return config}export function defineQueue(config){return config}export function defineSearchEngine(config){return config}export function defineSecurity(config){return config}export function defineServices(config){return config}export function defineSms(config){return config}export function defineStorage(config){return config}export function defineFilesystems(config){return config}export function defineFeatureFlags(config){return config}export function defineUi(config){return config}export{defineEvents}from"@stacksjs/events";

package/dist/index.d.ts

@@ -12,6 +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 { 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{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{packageModelRoots,packageViewRoots}from"./discovered-resources";export{resolveViewPatterns}from"./views";export{createRequestContext,installRequestContext,parseCookieHeader,useRequestEvent}from"./request-context";export*from"./capabilities";

package/dist/views.d.ts

@@ -1,3 +1,4 @@
+import type { PackageResourceRoot } from './discovered-resources';
 /**
  * Compose the view patterns for the dev and production servers
  * (stacksjs/stacks#2237).
@@ -17,8 +18,18 @@
  *
  * `exists` is injectable so the resolution is testable without a fixture tree;
  * it defaults to the real filesystem.
+ *
+ * Views a discovered package ships are appended LAST, after everything above.
+ * stx's `getRoute()` returns the first pattern whose relative path matches, so
+ * anything appended after the existing roots cannot change the answer for a
+ * path that already resolves. That is what makes this additive for an app with
+ * no packages, and for every pre-existing route in an app with them.
+ *
+ * `defaultViews` is not consulted for packages. That setting decides whether
+ * the app serves the FRAMEWORK's demo views; an application that installed a
+ * package asked for that package's pages either way.
  */
-export declare function resolveViewPatterns(userViewsPath: string, defaultViewsPath: string, setting: DefaultViewsSetting | undefined, exists?: (path: string) => boolean): ViewPatternResolution;
+export declare function resolveViewPatterns(userViewsPath: string, defaultViewsPath: string, setting: DefaultViewsSetting | undefined, exists?: (path: string) => boolean, packageViews?: PackageResourceRoot[]): ViewPatternResolution;
 export declare interface ViewPatternResolution {
   patterns: string[]
   missing: string[]

package/dist/views.js

@@ -1 +1 @@
-import{existsSync}from"node:fs";import{join}from"node:path";export function resolveViewPatterns(userViewsPath,defaultViewsPath,setting,exists=existsSync){if(setting===void 0||setting===!0)return{patterns:[userViewsPath,defaultViewsPath],missing:[]};if(setting===!1)return{patterns:[userViewsPath],missing:[]};if(!Array.isArray(setting))return{patterns:[userViewsPath,defaultViewsPath],missing:[]};const patterns=[userViewsPath],missing=[];for(const name of setting){const cleaned=String(name).replace(/^[/\\]+/,"");if(!cleaned||cleaned.split(/[/\\]/).includes(".."))continue;const candidate=join(defaultViewsPath,cleaned);if(exists(candidate))patterns.push(candidate);else missing.push(cleaned)}return{patterns,missing}}
+import{existsSync}from"node:fs";import{join}from"node:path";import{packageViewRoots}from"./discovered-resources";export function resolveViewPatterns(userViewsPath,defaultViewsPath,setting,exists=existsSync,packageViews=packageViewRoots({exists})){const fromPackages=packageViews.map((root)=>root.dir);if(setting===void 0||setting===!0)return{patterns:[userViewsPath,defaultViewsPath,...fromPackages],missing:[]};if(setting===!1)return{patterns:[userViewsPath,...fromPackages],missing:[]};if(!Array.isArray(setting))return{patterns:[userViewsPath,defaultViewsPath,...fromPackages],missing:[]};const patterns=[userViewsPath],missing=[];for(const name of setting){const cleaned=String(name).replace(/^[/\\]+/,"");if(!cleaned||cleaned.split(/[/\\]/).includes(".."))continue;const candidate=join(defaultViewsPath,cleaned);if(exists(candidate))patterns.push(candidate);else missing.push(cleaned)}patterns.push(...fromPackages);return{patterns,missing}}

package/package.json

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