@stacksjs/config 0.75.9 → 0.75.10

package/dist/index.d.ts

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

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{packageComponentRoots,packageJobRoots,packageMigrationRoots,packageModelRoots,packageViewRoots}from"./discovered-resources";export{resolveViewPatterns}from"./views";export{createRequestContext,enterRequestScope,installRequestContext,installRequestScope,parseCookieHeader,scopedRequestSnapshot,scopeStxServeContext,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{DEFAULT_VIEW_ROUTE_BUNDLES,DEFAULT_VIEW_TEMPLATES,DEFAULT_VIEWS_ALWAYS,resolveViewPatterns,withheldDefaultViews}from"./views";export{createRequestContext,enterRequestScope,installRequestContext,installRequestScope,parseCookieHeader,scopedRequestSnapshot,scopeStxServeContext,useRequestEvent}from"./request-context";export*from"./capabilities";

package/dist/views.d.ts

@@ -1,46 +1,72 @@
 import type { PackageResourceRoot } from './discovered-resources';
 /**
- * Compose the view patterns for the dev and production servers
- * (stacksjs/stacks#2237).
- *
- * Both servers registered `[userViewsPath, defaultViewsPath]` unconditionally,
- * so every Stacks app served the scaffold's demo storefront as live public
- * routes — `/cart`, `/checkout/payment`, `/orders/:id` — and enumerated them
- * into its sitemap. An analytics SaaS has no business answering `/checkout`.
+ * The default views withheld when `defaultViews` is unset: the pages of every
+ * bundle that is not mounted, and the templates that are never routes.
+ * Relative to the defaults views directory.
+ */
+export declare function withheldDefaultViews(mountedBundles: ReadonlySet<string>): string[];
+/*`.
  *
- * The route registry already lets an app decide what to spread; this is the
- * same lever for views.
+ * `mountedBundles` is what `mountedDefaultRouteBundles` in `@stacksjs/router`
+ * answers; it is a parameter because the router depends on this package. Left
+ * out, nothing counts as mounted: a caller that forgot it loses pages loudly,
+ * rather than serving forms into routes that are not there.
  *
- * Shared by both callers on purpose. They are in different packages and have
- * drifted before — `requestContext` is installed twice, differently, which is
- * its own report (#2232) — and a views policy that dev and production disagree
- * about is a defect you only find in production.
+ * The explicit settings keep their meaning and withhold nothing: `true` is
+ * every default view, `false` none, a list exactly the subtrees it names.
+ */
+export declare function resolveViewPatterns(userViewsPath: string, defaultViewsPath: string, setting: DefaultViewsSetting | undefined, exists?: (path: string) => boolean, packageViews?: PackageResourceRoot[], mountedBundles?: ReadonlySet<string>): ViewPatternResolution;
+/**
+ * The default views that are only as good as a route bundle behind them,
+ * keyed by bundle (`STACKS_DEFAULT_ROUTES`; see `resolveDefaultRouteBundles`
+ * in `@stacksjs/router`). Entries are files or directories under the defaults
+ * views directory.
  *
- * `exists` is injectable so the resolution is testable without a fixture tree;
- * it defaults to the real filesystem.
+ * `auth` - every page posts to `defaults/routes/auth.ts`: `/login` to
+ * `POST /login`, `/register` to `POST /register`, `/forgot-password` to
+ * `POST /password/forgot`, `/password/reset/{token}` to `POST /password/reset`,
+ * `/auth/magic/{token}` to `POST /auth/magic-link/consume`.
  *
- * 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.
+ * `dashboard` - the storefront, whose routes live in `defaults/routes/dashboard.ts`
+ * and not in a bundle of their own: `/cart` posts to `/api/cart/update`, the
+ * three checkout steps to `/api/checkout/{contact,shipping,place}`, and
+ * `/orders/{id}` is where `place` lands. `dashboard/index.stx` is the stub
+ * `/dashboard` renders on the views server, meaningless without the bundle.
  *
- * `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.
+ * Served with every bundle mounted, withheld without it: an app answering 200
+ * on `/login` whose form posts into a 404 is worse than an app answering 404.
+ */
+export declare const DEFAULT_VIEW_ROUTE_BUNDLES: Readonly<Record<string, readonly string[]>>;
+/*` are rendered BY PATH - `renderCmsPage`
+ * resolves them with its own lookup and hands them the page it found - and a
+ * published CMS page is served at its own URL by the CMS fallback. Routed
+ * directly, `/cms/page` renders the shell around no page at all, with or
+ * without CMS enabled, so there is no bundle to wait for.
+ */
+export declare const DEFAULT_VIEW_TEMPLATES: readonly string[];
+/**
+ * Default views served whatever is mounted: the home fallback, the
+ * coming-soon page the maintenance gate renders, the error pages (the 404
+ * lookup, and `errors/tester`, which gates itself to local deployments) and
+ * the mail previews. Named so a test can hold every file in the defaults
+ * tree to exactly one of these three lists.
  */
-export declare function resolveViewPatterns(userViewsPath: string, defaultViewsPath: string, setting: DefaultViewsSetting | undefined, exists?: (path: string) => boolean, packageViews?: PackageResourceRoot[]): ViewPatternResolution;
+export declare const DEFAULT_VIEWS_ALWAYS: readonly string[];
 export declare interface ViewPatternResolution {
   patterns: string[]
   missing: string[]
+  exclude: string[]
+  withheld: string[]
 }
 /**
  * Whether an app serves the framework's default views, and which of them.
  *
- * `true` (the default) keeps every default view registered, which is the
- * behaviour every existing app already has. `false` registers the app's own
- * views only. An array registers just the named subtrees of the defaults
- * directory — `['errors', 'emails']` for an app that wants the error pages and
- * the mail previews but not the demo storefront.
+ * Unset (the default) serves the default views that have routes behind them:
+ * each page that posts to a framework route bundle is served only while that
+ * bundle is mounted, see {@link DEFAULT_VIEW_ROUTE_BUNDLES}. `true` serves
+ * every default view whatever is mounted, which is what unset used to mean.
+ * `false` registers the app's own views only. An array registers just the
+ * named subtrees of the defaults directory: `['errors', 'emails']` for an app
+ * that wants the error pages and the mail previews but not the demo storefront.
  */
 export type DefaultViewsSetting = boolean | string[];

package/dist/views.js

@@ -1 +1 @@
-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}}
+import{existsSync}from"node:fs";import{join}from"node:path";import{packageViewRoots}from"./discovered-resources";export const DEFAULT_VIEW_ROUTE_BUNDLES={auth:["login.stx","register.stx","forgot-password.stx","password","auth"],dashboard:["cart.stx","checkout","orders","dashboard"]},DEFAULT_VIEW_TEMPLATES=["cms"],DEFAULT_VIEWS_ALWAYS=["index.stx","coming-soon.stx","errors","emails"];export function withheldDefaultViews(mountedBundles){const withheld=[];for(const[bundle,views]of Object.entries(DEFAULT_VIEW_ROUTE_BUNDLES))if(!mountedBundles.has(bundle))withheld.push(...views);withheld.push(...DEFAULT_VIEW_TEMPLATES);return withheld}export function resolveViewPatterns(userViewsPath,defaultViewsPath,setting,exists=existsSync,packageViews=packageViewRoots({exists}),mountedBundles=new Set){const fromPackages=packageViews.map((root)=>root.dir);if(setting===void 0){const withheld=withheldDefaultViews(mountedBundles);return{patterns:[userViewsPath,defaultViewsPath,...fromPackages],missing:[],exclude:withheld.map((name)=>join(defaultViewsPath,name)),withheld}}if(setting===!0)return{patterns:[userViewsPath,defaultViewsPath,...fromPackages],missing:[],exclude:[],withheld:[]};if(setting===!1)return{patterns:[userViewsPath,...fromPackages],missing:[],exclude:[],withheld:[]};if(!Array.isArray(setting))return{patterns:[userViewsPath,defaultViewsPath,...fromPackages],missing:[],exclude:[],withheld:[]};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,exclude:[],withheld:[]}}

package/package.json

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