@stacksjs/config 0.75.85 → 0.75.87

package/dist/defaults.js

@@ -2,4 +2,4 @@ var {require}=import.meta;import process from"node:process";import{commandsPath,
 `,body:`Provide a LONGER description of the change (optional). Use "|" to break new line:
 `,breaking:`List any BREAKING CHANGES (optional). Use "|" to break new line:
 `,footerPrefixesSelect:"Select the ISSUES type of the change list by this change (optional):",customFooterPrefixes:"Input ISSUES prefix:",footer:`List any ISSUES by this change. E.g.: #31, #34:
-`,confirmCommit:"Are you sure you want to proceed with the commit above?"},types:[{value:"feat",name:"feat:     \u2728  A new feature",emoji:":sparkles:"},{value:"fix",name:"fix:      \uD83D\uDC1B  A bug fix",emoji:":bug:"},{value:"docs",name:"docs:     \uD83D\uDCDD  Documentation only changes",emoji:":memo:"},{value:"style",name:"style:    \uD83D\uDC84  Changes that do not affect the meaning of the code",emoji:":lipstick:"},{value:"refactor",name:"refactor: \u267B\uFE0F   A code change that neither fixes a bug nor adds a feature",emoji:":recycle:"},{value:"perf",name:"perf:     \u26A1\uFE0F  A code change that improves performance",emoji:":zap:"},{value:"test",name:"test:     \u2705  Adding missing tests or adjusting existing tests",emoji:":white_check_mark:"},{value:"build",name:"build:    \uD83D\uDCE6\uFE0F  Changes that affect the build system or external dependencies",emoji:":package:"},{value:"ci",name:"ci:       \uD83C\uDFA1  Changes to our CI configuration files and scripts",emoji:":ferris_wheel:"},{value:"chore",name:"chore:    \uD83D\uDD28  Other changes that don't modify src or test files",emoji:":hammer:"},{value:"revert",name:"revert:   \u23EA\uFE0F  Reverts a previous commit",emoji:":rewind:"}]},hashing:{driver:"bcrypt",rehashOnLogin:!0,bcrypt:{rounds:12},argon2:{memory:65536,time:2}},images:{social:{enabled:!1,outputDir:"public/social",publicPath:"/social",presets:["og","square","portrait"]},appStore:{enabled:!1,outputDir:"resources/app-store/screenshots"},appIcons:{enabled:!1,outputDir:"resources/app-icons",platforms:["ios","macos"],faviconDir:"public"}},library:{name:"hello-world",owner:"@stacksjs",repository:"stacksjs/stacks",license:"MIT",author:"",contributors:[],defaultLanguage:"en",webComponents:{name:"hello-world-elements",description:"Your framework agnostic web component library description.",keywords:["custom-elements","web-components","library","framework-agnostic","typescript","javascript"],tags:[{name:["HelloWorld","AppHelloWorld"],description:"The Hello World custom element, built via this framework.",attributes:[{name:"greeting",description:"The greeting."}]}]},functions:{name:"hello-world-fx",description:"Your function library description.",keywords:["functions","composables","library","typescript","javascript"],shouldGenerateSourcemap:!1,files:["counter","dark"]}},logging:{logsPath:"storage/logs/stacks.log",deploymentsPath:"storage/logs/deployments.log"},notification:{default:"email"},payment:{driver:"stripe"},server:{proxy:{}},ports:{frontend:3000,backend:3001,admin:3002,library:3003,desktop:3004,email:3005,docs:3006,inspect:3007,api:3008,systemTray:3009,database:3010},queue:{default:"sync",connections:{sync:{driver:"sync"},database:{driver:"database",table:"jobs",queue:"default",retryAfter:90},redis:{driver:"redis",queue:"default",retryAfter:90},sqs:{driver:"sqs",key:"",secret:"",prefix:"",suffix:"",queue:"default",region:FRAMEWORK_DEFAULTS.awsRegion}}},saas:{plans:[{productName:"Stacks Hobby",description:"All the Stacks features.",pricing:[{key:"stacks_hobby_monthly",price:3900,interval:"month",currency:"usd"},{key:"stacks_hobby_yearly",price:37900,interval:"year",currency:"usd"}],metadata:{createdBy:"admin",version:"1.0.0"}},{productName:"Stacks Pro",description:"All the Stacks features, including being able to invite team members.",pricing:[{key:"stacks_pro_monthly",price:5900,interval:"month",currency:"usd"},{key:"stacks_pro_yearly",price:57900,interval:"year",currency:"usd"}],metadata:{createdBy:"admin",version:"1.0.0"}}],webhook:{endpoint:"/webhooks/stripe",secret:""},currencies:["usd"],coupons:[{code:"SUMMER2024",amountOff:500,duration:"once"}],products:[{name:"Stacks Pro",description:"All the Stacks features.",images:["url_to_image"]}]},searchEngine:{driver:"opensearch"},security:{firewall:{enabled:!0,countryCodes:[],ipAddresses:[],queryString:[],httpHeaders:[],rateLimitPerMinute:1000,useIpReputationLists:!0,useKnownBadInputsRuleSet:!0}},services:{aws:{accountId:"",appId:"",apiKey:"",region:FRAMEWORK_DEFAULTS.awsRegion},algolia:{appId:"",apiKey:""},meilisearch:{appId:"",apiKey:""},stripe:{appId:"",apiKey:""}},filesystems:{driver:"local"},team:{name:"",members:{}},ui:{shortcuts:[["btn","inline-flex items-center px-4 py-2 ml-2 border border-transparent shadow-sm text-base font-medium rounded-md text-white bg-indigo-600 hover:bg-indigo-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-indigo-500 cursor-pointer"]],safelist:"prose prose-sm m-auto text-left",trigger:":stx:",classPrefix:"stx-",reset:"tailwind",icons:["hugeicons"],fonts:{email:{title:"Mona",text:"Hubot"},desktop:{title:"Mona",text:"Hubot"},mobile:{title:"Mona",text:"Hubot"},web:{title:"Mona",text:"Hubot"}}}};export default defaults;
+`,confirmCommit:"Are you sure you want to proceed with the commit above?"},types:[{value:"feat",name:"feat:     \u2728  A new feature",emoji:":sparkles:"},{value:"fix",name:"fix:      \uD83D\uDC1B  A bug fix",emoji:":bug:"},{value:"docs",name:"docs:     \uD83D\uDCDD  Documentation only changes",emoji:":memo:"},{value:"style",name:"style:    \uD83D\uDC84  Changes that do not affect the meaning of the code",emoji:":lipstick:"},{value:"refactor",name:"refactor: \u267B\uFE0F   A code change that neither fixes a bug nor adds a feature",emoji:":recycle:"},{value:"perf",name:"perf:     \u26A1\uFE0F  A code change that improves performance",emoji:":zap:"},{value:"test",name:"test:     \u2705  Adding missing tests or adjusting existing tests",emoji:":white_check_mark:"},{value:"build",name:"build:    \uD83D\uDCE6\uFE0F  Changes that affect the build system or external dependencies",emoji:":package:"},{value:"ci",name:"ci:       \uD83C\uDFA1  Changes to our CI configuration files and scripts",emoji:":ferris_wheel:"},{value:"chore",name:"chore:    \uD83D\uDD28  Other changes that don't modify src or test files",emoji:":hammer:"},{value:"revert",name:"revert:   \u23EA\uFE0F  Reverts a previous commit",emoji:":rewind:"}]},hashing:{driver:"bcrypt",rehashOnLogin:!0,bcrypt:{rounds:12},argon2:{memory:65536,time:2}},images:{social:{enabled:!1,outputDir:"public/social",publicPath:"/social",presets:["og","square","portrait"]},appStore:{enabled:!1,outputDir:"resources/app-store/screenshots"},appIcons:{enabled:!1,outputDir:"resources/app-icons",platforms:["ios","macos"],faviconDir:"public"}},library:{name:"hello-world",owner:"@stacksjs",repository:"stacksjs/stacks",license:"MIT",author:"",contributors:[],defaultLanguage:"en",webComponents:{name:"hello-world-elements",description:"Your framework agnostic web component library description.",keywords:["custom-elements","web-components","library","framework-agnostic","typescript","javascript"],tags:[{name:["HelloWorld","AppHelloWorld"],description:"The Hello World custom element, built via this framework.",attributes:[{name:"greeting",description:"The greeting."}]}]},functions:{name:"hello-world-fx",description:"Your function library description.",keywords:["functions","composables","library","typescript","javascript"],shouldGenerateSourcemap:!1,files:["counter","dark"]}},logging:{logsPath:"storage/logs/stacks.log",deploymentsPath:"storage/logs/deployments.log"},notification:{default:"email"},payment:{driver:"stripe"},server:{proxy:{}},ports:{frontend:3000,backend:3001,admin:3002,library:3003,desktop:3004,email:3005,docs:3006,inspect:3007,api:3008,systemTray:3009,database:3010},queue:{default:"sync",connections:{sync:{driver:"sync"},database:{driver:"database",table:"jobs",queue:"default",retryAfter:90},redis:{driver:"redis",queue:"default",retryAfter:90},sqs:{driver:"sqs",key:"",secret:"",prefix:"",suffix:"",queue:"default",region:FRAMEWORK_DEFAULTS.awsRegion}}},saas:{plans:[{productName:"Stacks Hobby",description:"All the Stacks features.",pricing:[{key:"stacks_hobby_monthly",price:3900,interval:"month",currency:"usd"},{key:"stacks_hobby_yearly",price:37900,interval:"year",currency:"usd"}],metadata:{createdBy:"admin",version:"1.0.0"}},{productName:"Stacks Pro",description:"All the Stacks features, including being able to invite team members.",pricing:[{key:"stacks_pro_monthly",price:5900,interval:"month",currency:"usd"},{key:"stacks_pro_yearly",price:57900,interval:"year",currency:"usd"}],metadata:{createdBy:"admin",version:"1.0.0"}}],webhook:{endpoint:"/webhooks/stripe",secret:""},currencies:["usd"],coupons:[{code:"SUMMER2024",amountOff:500,duration:"once"}],products:[{name:"Stacks Pro",description:"All the Stacks features.",images:["url_to_image"]}]},searchEngine:{driver:"opensearch"},security:{api:{rowScoping:"deny",models:"all"},firewall:{enabled:!0,countryCodes:[],ipAddresses:[],queryString:[],httpHeaders:[],rateLimitPerMinute:1000,useIpReputationLists:!0,useKnownBadInputsRuleSet:!0}},services:{aws:{accountId:"",appId:"",apiKey:"",region:FRAMEWORK_DEFAULTS.awsRegion},algolia:{appId:"",apiKey:""},meilisearch:{appId:"",apiKey:""},stripe:{appId:"",apiKey:""}},filesystems:{driver:"local"},team:{name:"",members:{}},ui:{shortcuts:[["btn","inline-flex items-center px-4 py-2 ml-2 border border-transparent shadow-sm text-base font-medium rounded-md text-white bg-indigo-600 hover:bg-indigo-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-indigo-500 cursor-pointer"]],safelist:"prose prose-sm m-auto text-left",trigger:":stx:",classPrefix:"stx-",reset:"tailwind",icons:["hugeicons"],fonts:{email:{title:"Mona",text:"Hubot"},desktop:{title:"Mona",text:"Hubot"},mobile:{title:"Mona",text:"Hubot"},web:{title:"Mona",text:"Hubot"}}}};export default defaults;

package/dist/features.d.ts

@@ -1,18 +1,18 @@
 import { type FeatureName } from '@stacksjs/features/names';
-export declare function feature(name: string): boolean;
+export declare function feature(name: FeatureFlag): boolean;
 /**
  * Force-enable a feature in the running process. Intended for tests and
  * staged rollouts; production code should prefer config-file overrides.
  */
-export declare function enableFeature(name: string): void;
+export declare function enableFeature(name: FeatureFlag): void;
 /**
  * Force-disable a feature in the running process.
  */
-export declare function disableFeature(name: string): void;
+export declare function disableFeature(name: FeatureFlag): void;
 /**
  * Drop a runtime override and fall back to the config-driven value.
  */
-export declare function resetFeature(name: string): void;
+export declare function resetFeature(name: FeatureFlag): void;
 /**
  * Snapshot of the live flag set — useful for `/__features` debug endpoints
  * and CLI commands that print the active configuration. Iterates the known
@@ -20,7 +20,24 @@ export declare function resetFeature(name: string): void;
  */
 export declare function listFeatures(): Record<string, boolean>;
 /**
- * Every name `feature()` answers for: the installable bundles, plus `auth`.
+ * Flags an app defines for itself - a ramp switched with `enableFeature`, or
+ * a `config/<name>.ts` with an `enabled` field. Declare them here so
+ * `feature()` accepts them; anything else is a compile error, which is what
+ * keeps `feature('commrce')` from being a silent `false`:
+ *
+ * ```ts
+ * declare module '@stacksjs/config' {
+ *   interface AppFeatureFlags {
+ *     'new-checkout': true
+ *   }
+ * }
+ * ```
+ */
+// eslint-disable-next-line ts/no-empty-object-type
+export declare interface AppFeatureFlags {}
+/**
+ * Every name `feature()` answers for: the installable bundles, plus two gates
+ * that are config sections rather than bundles.
  *
  * Derived rather than restated. The bundles were spelled out here as well as in
  * `@stacksjs/features`, and nothing related the two lists, so a feature added
@@ -34,13 +51,20 @@ export declare function listFeatures(): Record<string, boolean>;
  * `@stacksjs/path` for them, which costs about a millisecond on a path every
  * process walks before anything else. The names module imports nothing.
  *
- * `auth` is added here and is not an installable bundle, which looks backwards
- * until you read why: `config/auth.ts` ships in every app with `enabled: true`,
- * so gating the auth routes on `feature('auth')` would mount `/login`,
- * `/register`, `/generate-two-factor-secret`, `/logout-all` and `/auth/tokens`
- * into every app currently running with `dashboard` off. Route selection is
- * explicit instead, through `STACKS_DEFAULT_ROUTES` - see the rationale in
- * `router/src/route-loader.ts` and `defaults/bootstrap.ts`. It is a name
- * `feature()` knows, and nothing gates on it.
+ * The two gates have no install command, because there is nothing to install:
+ *
+ * - `auth` (`config/auth.ts`) decides whether `@stacksjs/orm` loads the
+ *   framework's account-family models - `Team`, `TeamMember`, `Referral`,
+ *   `SocialAccount`, `Subscriber`, `Subscription`, `Site`, `MagicLinkToken`,
+ *   `GdprRequest` and the rest of its manifest's `'auth'` rows. It does NOT
+ *   mount the auth routes. `config/auth.ts` ships enabled in every app, so
+ *   gating `/login`, `/register` and `/auth/tokens` on it would mount them
+ *   into every app running with `dashboard` off; route selection is explicit,
+ *   through `STACKS_DEFAULT_ROUTES` (see `router/src/route-loader.ts`).
+ * - `email` (`config/email.ts`) gates the `email` route bundle - the provider
+ *   webhooks - when an app has not named its bundles. It was a name only the
+ *   router knew, so canonical mode did not force it on.
  */
-export type StacksFeature = FeatureName | 'auth';
+export type StacksFeature = FeatureName | 'auth' | 'email';
+/** A name `feature()` accepts: the framework's, or one the app declared. */
+export type FeatureFlag = StacksFeature | Extract<keyof AppFeatureFlags, string>;

package/dist/features.js

@@ -1 +1 @@
-import{FEATURE_NAMES as INSTALLABLE_FEATURES}from"@stacksjs/features/names";import{config}from"./runtime";const FEATURE_NAMES=[...INSTALLABLE_FEATURES,"auth"],FEATURE_DEFAULTS={dashboard:!0},overrides=new Map;function configFor(name){const raw=config[name];return raw&&typeof raw==="object"?raw:void 0}function canonicalFeatures(){return process.env.STACKS_CANONICAL_FEATURES==="1"}export function feature(name){if(overrides.has(name))return overrides.get(name);if(canonicalFeatures()&&FEATURE_NAMES.includes(name))return!0;const cfg=configFor(name);if(cfg){const enabledField=cfg.enabled;if(enabledField===!1)return!1;if(Array.isArray(cfg.env)&&cfg.env.length>0){const currentEnv=(config.app?.env??"").toString();if(!cfg.env.includes(currentEnv))return!1}if(enabledField!==void 0)return!!enabledField;return!0}return FEATURE_DEFAULTS[name]??!1}export function enableFeature(name){overrides.set(name,!0)}export function disableFeature(name){overrides.set(name,!1)}export function resetFeature(name){overrides.delete(name)}export function listFeatures(){const out={};for(const name of FEATURE_NAMES)out[name]=feature(name);for(const name of overrides.keys())out[name]=feature(name);return out}
+import{FEATURE_NAMES as INSTALLABLE_FEATURES}from"@stacksjs/features/names";import{config}from"./runtime";const FEATURE_NAMES=[...INSTALLABLE_FEATURES,"auth","email"],FEATURE_DEFAULTS={dashboard:!0},overrides=new Map;function configFor(name){const raw=config[name];return raw&&typeof raw==="object"?raw:void 0}function canonicalFeatures(){return process.env.STACKS_CANONICAL_FEATURES==="1"}export function feature(name){if(overrides.has(name))return overrides.get(name);if(canonicalFeatures()&&FEATURE_NAMES.includes(name))return!0;const cfg=configFor(name);if(cfg){const enabledField=cfg.enabled;if(enabledField===!1)return!1;if(Array.isArray(cfg.env)&&cfg.env.length>0){const currentEnv=(config.app?.env??"").toString();if(!cfg.env.includes(currentEnv))return!1}if(enabledField!==void 0)return!!enabledField;return!0}return FEATURE_DEFAULTS[name]??!1}export function enableFeature(name){overrides.set(name,!0)}export function disableFeature(name){overrides.set(name,!1)}export function resetFeature(name){overrides.delete(name)}export function listFeatures(){const out={};for(const name of FEATURE_NAMES)out[name]=feature(name);for(const name of overrides.keys())out[name]=feature(name);return out}

package/dist/index.d.ts

@@ -11,7 +11,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 { feature, enableFeature, disableFeature, resetFeature, listFeatures, type AppFeatureFlags, type FeatureFlag, type StacksFeature } from './features';
 export { packageComponentRoots, packageJobRoots, packageMigrationRoots, packageModelRoots, packageViewRoots, type PackageResourceOptions, type PackageResourceRoot } from './discovered-resources';
 export { DEFAULT_VIEW_ROUTE_BUNDLES, DEFAULT_VIEW_TEMPLATES, DEFAULT_VIEWS_ALWAYS, resolveViewPatterns, withheldDefaultViews, type DefaultViewsSetting, type ViewPatternResolution } from './views';
 export {

package/package.json

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