@stacksjs/config 0.50.0 → 0.51.0

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-import { CliOptions, AppOptions, DebugOptions, DeployOptions, Events, DocsConfig, GitOptions, HashingOptions, LibraryOptions, NotificationOptions, SearchEngineOptions, UiOptions } from '@stacksjs/types';
+import { CliOptions, AppOptions, DebugOptions, DeployOptions, Events, GitOptions, HashingOptions, LibraryOptions, NotificationOptions, SearchEngineOptions, UiOptions, DocsConfig } from '@stacksjs/types';
 
 type Config = 'app' | 'cache' | 'database' | 'debug' | 'deploy' | 'docs' | 'git' | 'hashing' | 'library' | 'notification' | 'searchEngine' | 'services' | 'storage' | 'ui';
-declare function config(key?: Config, fallback?: any): any;
+declare function config$f(key?: Config, fallback?: any): any;
 declare function env(key: string, fallback: any): any;
 /**
  * Determines the level of debugging.
@@ -16,7 +16,7 @@ declare function determineDebugMode(options?: CliOptions): boolean;
  * you may hover any of the options below and the definitions will be provided. In case
  * you have any questions, feel free to reach out via Discord or GitHub Discussions.
  */
-declare const app: AppOptions;
+declare const config$e: AppOptions;
 
 /**
  * **Cache Options**
@@ -25,7 +25,7 @@ declare const app: AppOptions;
  * you may hover any of the options below and the definitions will be provided. In case
  * you have any questions, feel free to reach out via Discord or GitHub Discussions.
  */
-declare const cache: {
+declare const config$d: {
     driver: any;
     redis: {
         connection: string;
@@ -58,7 +58,7 @@ declare const cache: {
  * you may hover any of the options below and the definitions will be provided. In case
  * you have any questions, feel free to reach out via Discord or GitHub Discussions.
  */
-declare const database: {
+declare const config$c: {
     driver: string;
 };
 
@@ -69,7 +69,7 @@ declare const database: {
  * you may hover any of the options below and the definitions will be provided. In case
  * you have any questions, feel free to reach out via Discord or GitHub Discussions.
  */
-declare const debug: DebugOptions;
+declare const config$b: DebugOptions;
 
 /**
  * **Deployment Options**
@@ -78,31 +78,16 @@ declare const debug: DebugOptions;
  * you may hover any of the options below and the definitions will be provided. In case
  * you have any questions, feel free to reach out via Discord or GitHub Discussions.
  */
-declare const deploy: DeployOptions;
+declare const config$a: DeployOptions;
 
 /**
  * **Events**
  *
- * This configuration defines all of your events. Because Stacks is full-typed, you may
- * hover any of the options below and the definitions will be provided. In case you
+ * This configuration defines all of your events. Think of this as your Events type definitions:
+ * first, pick an event name and then define it with its return type. In case you
  * have any questions, feel free to reach out via Discord or GitHub Discussions.
  */
-declare const events: Events;
-
-/**
- * **Documentation Options**
- *
- * This configuration defines all of your documentation options. Because Stacks is full-typed,
- * you may hover any of the options below and the definitions will be provided. In case
- * you have any questions, feel free to reach out via Discord or GitHub Discussions.
- */
-declare const _default: DocsConfig;
-
-declare namespace docs {
-  export {
-    _default as default,
-  };
-}
+declare const config$9: Events;
 
 /**
  * **Git Options**
@@ -111,9 +96,9 @@ declare namespace docs {
  * hover any of the options below and the definitions will be provided. In case you
  * have any questions, feel free to reach out via Discord or GitHub Discussions.
  */
-declare const git: GitOptions;
+declare const config$8: GitOptions;
 
-declare const hashing: HashingOptions;
+declare const config$7: HashingOptions;
 
 /**
  * **Library Options**
@@ -122,7 +107,25 @@ declare const hashing: HashingOptions;
  * may hover any of the options below and the definitions will be provided. In case you
  * have any questions, feel free to reach out via Discord or GitHub Discussions.
  */
-declare const library: LibraryOptions;
+declare const config$6: LibraryOptions;
+
+/**
+ * **Debug Options**
+ *
+ * This configuration defines all of your database options. Because Stacks is full-typed,
+ * you may hover any of the options below and the definitions will be provided. In case
+ * you have any questions, feel free to reach out via Discord or GitHub Discussions.
+ */
+declare const config$5: {
+    onboarding: {
+        path: string;
+        pages: never[];
+    };
+    settings: {
+        path: string;
+        pages: never[];
+    };
+};
 
 /**
  * **Notification Options**
@@ -131,7 +134,7 @@ declare const library: LibraryOptions;
  * you may hover any of the options below and the definitions will be provided. In case
  * you have any questions, feel free to reach out via Discord or GitHub Discussions.
  */
-declare const notification: NotificationOptions;
+declare const config$4: NotificationOptions;
 
 /**
  * **Search Engine Options**
@@ -140,7 +143,7 @@ declare const notification: NotificationOptions;
  * you may hover any of the options below and the definitions will be provided. In case
  * you have any questions, feel free to reach out via Discord or GitHub Discussions.
  */
-declare const searchEngine: SearchEngineOptions;
+declare const config$3: SearchEngineOptions;
 
 /**
  * **Services**
@@ -149,7 +152,7 @@ declare const searchEngine: SearchEngineOptions;
  * hover any of the options below and the definitions will be provided. In case you
  * have any questions, feel free to reach out via Discord or GitHub Discussions.
  */
-declare const services: {
+declare const config$2: {
     algolia: {
         appId: string;
         apiKey: string;
@@ -188,7 +191,7 @@ declare const services: {
  * you may hover any of the options below and the definitions will be provided. In case
  * you have any questions, feel free to reach out via Discord or GitHub Discussions.
  */
-declare const storage: {
+declare const config$1: {
     driver: string;
 };
 
@@ -199,6 +202,21 @@ declare const storage: {
  * may hover any of the options below and the definitions will be provided. In case you
  * have any questions, feel free to reach out via Discord or GitHub Discussions.
  */
-declare const ui: UiOptions;
+declare const config: UiOptions;
+
+/**
+ * **Documentation Options**
+ *
+ * This configuration defines all of your documentation options. Because Stacks is full-typed,
+ * you may hover any of the options below and the definitions will be provided. In case
+ * you have any questions, feel free to reach out via Discord or GitHub Discussions.
+ */
+declare const _default: DocsConfig;
+
+declare namespace docs {
+  export {
+    _default as default,
+  };
+}
 
-export { app, cache, config, database, debug, deploy, determineDebugMode, docs, env, events, git, hashing, library, notification, searchEngine, services, storage, ui };
+export { config$e as app, config$d as cache, config$f as config, config$c as database, config$b as debug, config$a as deploy, determineDebugMode, docs, env, config$9 as events, config$8 as git, config$7 as hashing, config$6 as library, config$4 as notification, config$5 as page, config$3 as searchEngine, config$2 as services, config$1 as storage, config as ui };

package/dist/index.mjs

@@ -3,41 +3,42 @@ import { frameworkPath } from '@stacksjs/path';
 
 const c = {
   __proto__: null,
-  get app () { return app; },
-  get cache () { return cache; },
-  get config () { return config; },
-  get database () { return database; },
-  get debug () { return debug; },
-  get deploy () { return deploy; },
+  get app () { return config$e; },
+  get cache () { return config$d; },
+  get config () { return config$f; },
+  get database () { return config$c; },
+  get debug () { return config$b; },
+  get deploy () { return config$a; },
   get determineDebugMode () { return determineDebugMode; },
   get docs () { return docs$1; },
   get env () { return env; },
-  get events () { return events; },
-  get git () { return git; },
-  get hashing () { return hashing; },
-  get library () { return library; },
-  get notification () { return notification; },
-  get searchEngine () { return searchEngine; },
-  get services () { return services; },
-  get storage () { return storage; },
-  get ui () { return ui; }
+  get events () { return config$9; },
+  get git () { return config$8; },
+  get hashing () { return config$7; },
+  get library () { return config$6; },
+  get notification () { return config$4; },
+  get page () { return config$5; },
+  get searchEngine () { return config$3; },
+  get services () { return config$2; },
+  get storage () { return config$1; },
+  get ui () { return config; }
 };
 
-function config(key, fallback) {
+function config$f(key, fallback) {
   return key ? c[key] : fallback;
 }
 function env(key, fallback) {
   return fallback;
 }
 function determineDebugMode(options) {
-  if (options?.debug === true)
+  if (options?.verbose === true)
     return true;
-  if (app.debug === true)
+  if (config$e.debug === true)
     return true;
   return false;
 }
 
-const app = {
+const config$e = {
   name: env$1("APP_NAME", "Stacks"),
   env: env$1("APP_ENV", "local"),
   key: env$1("APP_KEY", ""),
@@ -51,7 +52,7 @@ const app = {
   editor: "vscode"
 };
 
-const cache = {
+const config$d = {
   driver: env$1("CACHE_DRIVER", "redis"),
   redis: {
     connection: "cache",
@@ -82,141 +83,25 @@ const cache = {
   }
 };
 
-const database = {
+const config$c = {
   driver: "planetscale"
 };
 
-const debug = {
+const config$b = {
   enabled: true,
   host: "localhost",
   port: 23517
 };
 
-const deploy = {
+const config$a = {
   driver: "netlify"
 };
 
-const events = {
+const config$9 = {
   // 'user:registered': User,
 };
 
-const services = {
-  algolia: {
-    appId: "",
-    apiKey: "",
-    indexName: ""
-  },
-  meilisearch: {
-    appId: "",
-    apiKey: "",
-    indexName: ""
-  },
-  stripe: {
-    appId: "",
-    apiKey: ""
-  },
-  planetscale: {
-    appId: "",
-    apiKey: ""
-  },
-  supabase: {
-    appId: "",
-    apiKey: ""
-  },
-  aws: {
-    appId: "",
-    apiKey: ""
-  },
-  novu: {
-    key: env$1("NOVU_API_KEY", "test-key")
-  }
-};
-
-const docs = {
-  outDir: frameworkPath("docs/dist"),
-  lang: "en-US",
-  title: "Stacks",
-  description: "Composability-First. UI/FX Framework.",
-  lastUpdated: true,
-  themeConfig: {
-    nav: nav(),
-    sidebar: {
-      "/guide/": sidebarGuide()
-    },
-    editLink: {
-      pattern: "https://github.com/stacksjs/stacks/edit/main/apps/docs/docs/:path",
-      text: "Edit this page on GitHub"
-    },
-    socialLinks: [
-      { icon: "twitter", link: "https://twitter.com/stacksjs" },
-      { icon: "github", link: "https://github.com/stacksjs/stacks" },
-      { icon: "discord", link: "https://twitter.com/stacksjs" }
-    ],
-    footer: {
-      message: "Released under the MIT License.",
-      copyright: "Copyright \xA9 2022-present Open Web Foundation"
-    },
-    algolia: services.algolia,
-    carbonAds: {
-      code: "",
-      placement: ""
-    }
-  }
-};
-function nav() {
-  return [
-    { text: "Config", link: "/config", activeMatch: "/config" },
-    {
-      text: "Changelog",
-      link: "https://github.com/stacksjs/stacks/blob/main/CHANGELOG.md"
-    },
-    { text: "Blog", link: "https://updates.ow3.org" }
-  ];
-}
-function sidebarGuide() {
-  return [
-    {
-      text: "Introduction",
-      collapsible: true,
-      items: [
-        { text: "What is Stacks?", link: "/guide/what-is-stacks" },
-        { text: "Getting Started", link: "/guide/getting-started" },
-        { text: "Configuration", link: "/guide/config" }
-      ]
-    },
-    {
-      text: "Digging Deeper",
-      collapsible: true,
-      items: [
-        { text: "How To?", link: "/guide/stacks" },
-        { text: "Workflows / CI", link: "/guide/ci" },
-        { text: "VS Code", link: "/guide/vs-code" },
-        { text: "Apps", link: "/guide/apps" },
-        { text: "Examples", link: "/guide/examples" },
-        { text: "Packages", link: "/guide/packages" },
-        { text: "Testing", link: "/guide/testing" },
-        { text: "Single File Components", link: "/guide/sfcs" }
-      ]
-    },
-    {
-      text: "Starters",
-      collapsible: true,
-      items: [
-        { text: "Vue Starter", link: "/starter/vue" },
-        { text: "Web Component Starter", link: "/starter/web-components" },
-        { text: "Composable Starter", link: "/starter/web-components" },
-        { text: "TypeScript Starter", link: "/starter/web-components" }
-      ]
-    }
-  ];
-}
-
-const docs$1 = {
-  __proto__: null,
-  default: docs
-};
-
-const git = {
+const config$8 = {
   hooks: {
     "pre-commit": "lint-staged"
   },
@@ -288,7 +173,7 @@ const git = {
   ]
 };
 
-const hashing = {
+const config$7 = {
   driver: "bcrypt",
   bcrypt: {
     rounds: 10
@@ -300,7 +185,7 @@ const hashing = {
   }
 };
 
-const library = {
+const config$6 = {
   name: "hello-world",
   parentName: "@stacksjs",
   repository: "stacksjs/stacks",
@@ -347,7 +232,18 @@ const library = {
   }
 };
 
-const notification = {
+const config$5 = {
+  onboarding: {
+    path: "pages/dashboard/onboarding",
+    pages: []
+  },
+  settings: {
+    path: "pages/dashboard/settings",
+    pages: []
+  }
+};
+
+const config$4 = {
   type: env$1("NOTIFICATION_TYPE", "email"),
   driver: env$1("NOTIFICATION_DRIVER", "sendgrid"),
   email: {
@@ -453,7 +349,7 @@ const notification = {
   }
 };
 
-const searchEngine = {
+const config$3 = {
   driver: "meilisearch",
   meilisearch: {
     host: "",
@@ -461,11 +357,43 @@ const searchEngine = {
   }
 };
 
-const storage = {
+const config$2 = {
+  algolia: {
+    appId: "",
+    apiKey: "",
+    indexName: ""
+  },
+  meilisearch: {
+    appId: "",
+    apiKey: "",
+    indexName: ""
+  },
+  stripe: {
+    appId: "",
+    apiKey: ""
+  },
+  planetscale: {
+    appId: "",
+    apiKey: ""
+  },
+  supabase: {
+    appId: "",
+    apiKey: ""
+  },
+  aws: {
+    appId: "",
+    apiKey: ""
+  },
+  novu: {
+    key: env$1("NOVU_API_KEY", "test-key")
+  }
+};
+
+const config$1 = {
   driver: "s3"
 };
 
-const ui = {
+const config = {
   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"]
   ],
@@ -494,4 +422,88 @@ const ui = {
   }
 };
 
-export { app, cache, config, database, debug, deploy, determineDebugMode, docs$1 as docs, env, events, git, hashing, library, notification, searchEngine, services, storage, ui };
+const docs = {
+  outDir: frameworkPath("docs/dist"),
+  lang: "en-US",
+  title: "Stacks",
+  description: "Composability-First. UI/FX Framework.",
+  lastUpdated: true,
+  themeConfig: {
+    nav: nav(),
+    sidebar: {
+      "/guide/": sidebarGuide()
+    },
+    editLink: {
+      pattern: "https://github.com/stacksjs/stacks/edit/main/apps/docs/docs/:path",
+      text: "Edit this page on GitHub"
+    },
+    socialLinks: [
+      { icon: "twitter", link: "https://twitter.com/stacksjs" },
+      { icon: "github", link: "https://github.com/stacksjs/stacks" },
+      { icon: "discord", link: "https://twitter.com/stacksjs" }
+    ],
+    footer: {
+      message: "Released under the MIT License.",
+      copyright: "Copyright \xA9 2022-present Open Web Foundation"
+    },
+    algolia: config$2.algolia,
+    carbonAds: {
+      code: "",
+      placement: ""
+    }
+  }
+};
+function nav() {
+  return [
+    { text: "Config", link: "/config", activeMatch: "/config" },
+    {
+      text: "Changelog",
+      link: "https://github.com/stacksjs/stacks/blob/main/CHANGELOG.md"
+    },
+    { text: "Blog", link: "https://updates.ow3.org" }
+  ];
+}
+function sidebarGuide() {
+  return [
+    {
+      text: "Introduction",
+      collapsible: true,
+      items: [
+        { text: "What is Stacks?", link: "/guide/what-is-stacks" },
+        { text: "Getting Started", link: "/guide/getting-started" },
+        { text: "Configuration", link: "/guide/config" }
+      ]
+    },
+    {
+      text: "Digging Deeper",
+      collapsible: true,
+      items: [
+        { text: "How To?", link: "/guide/stacks" },
+        { text: "Workflows / CI", link: "/guide/ci" },
+        { text: "VS Code", link: "/guide/vs-code" },
+        { text: "Apps", link: "/guide/apps" },
+        { text: "Examples", link: "/guide/examples" },
+        { text: "Packages", link: "/guide/packages" },
+        { text: "Testing", link: "/guide/testing" },
+        { text: "Single File Components", link: "/guide/sfcs" }
+      ]
+    },
+    {
+      text: "Starters",
+      collapsible: true,
+      items: [
+        { text: "Vue Starter", link: "/starter/vue" },
+        { text: "Web Component Starter", link: "/starter/web-components" },
+        { text: "Composable Starter", link: "/starter/web-components" },
+        { text: "TypeScript Starter", link: "/starter/web-components" }
+      ]
+    }
+  ];
+}
+
+const docs$1 = {
+  __proto__: null,
+  default: docs
+};
+
+export { config$e as app, config$d as cache, config$f as config, config$c as database, config$b as debug, config$a as deploy, determineDebugMode, docs$1 as docs, env, config$9 as events, config$8 as git, config$7 as hashing, config$6 as library, config$4 as notification, config$5 as page, config$3 as searchEngine, config$2 as services, config$1 as storage, config as ui };

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@stacksjs/config",
   "type": "module",
-  "version": "0.50.0",
-  "packageManager": "pnpm@7.25.1",
+  "version": "0.51.0",
+  "packageManager": "pnpm@7.26.3",
   "description": "The Stacks configuration.",
   "author": "Chris Breuer",
   "license": "MIT",
@@ -31,18 +31,18 @@
     "README.md"
   ],
   "engines": {
-    "node": ">=v18.13.0",
-    "pnpm": ">=7.25.1"
+    "node": ">=v18.14.0",
+    "pnpm": ">=7.26.3"
   },
   "peerDependencies": {
-    "@stacksjs/path": "0.50.0",
-    "@stacksjs/utils": "0.50.0"
+    "@stacksjs/path": "0.51.0",
+    "@stacksjs/utils": "0.51.0"
   },
   "devDependencies": {
     "mkdist": "^1.1.0",
-    "typescript": "^4.9.4",
+    "typescript": "^4.9.5",
     "unbuild": "^1.1.1",
-    "@stacksjs/testing": "0.50.0"
+    "@stacksjs/testing": "0.51.0"
   },
   "scripts": {
     "build": "unbuild",