@stacksjs/config 0.42.2 → 0.43.1

package/README.md

@@ -21,9 +21,9 @@ pnpm i -D @stacksjs/config
 Now, you can use it in your project:
 
 ```js
-import * as config from '@stacksjs/config'
-// or
 import { app, deploy, docs, git, hashing, library, services, ui } from '@stacksjs/config'
+
+console.log(app)
 ```
 
 Learn more in the docs.

package/dist/index.d.ts

@@ -1,5 +1,8 @@
-import { CliOptions, AppOptions, DeployOptions, DocsConfig, GitOptions, HashingOptions, LibraryOptions, UiOptions } from '@stacksjs/types';
+import { CliOptions, AppOptions, DebugOptions, DeployOptions, DocsConfig, GitOptions, HashingOptions, LibraryOptions, SearchEngineOptions, UiOptions } 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 env(key: string, fallback: any): any;
 /**
  * Determines the level of debugging.
  * @param options
@@ -7,7 +10,7 @@ import { CliOptions, AppOptions, DeployOptions, DocsConfig, GitOptions, HashingO
 declare function determineDebugMode(options?: CliOptions): boolean;
 
 /**
- * ### Application Options
+ * **Application Options**
  *
  * This configuration defines all of your application options. Because Stacks is full-typed,
  * you may hover any of the options below and the definitions will be provided. In case
@@ -16,7 +19,63 @@ declare function determineDebugMode(options?: CliOptions): boolean;
 declare const app: AppOptions;
 
 /**
- * ### Deployment Options
+ * **Cache Options**
+ *
+ * This configuration defines all of your cache 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 cache: {
+    default: any;
+    redis: {
+        driver: string;
+        connection: string;
+        host: any;
+        port: any;
+    };
+    memcached: {
+        driver: string;
+        persistent_id: any;
+        sasl: any[];
+        options: {};
+        servers: {
+            host: any;
+            port: any;
+            weight: number;
+        }[];
+    };
+    dynamodb: {
+        driver: string;
+        key: any;
+        secret: any;
+        region: any;
+        table: any;
+        endpoint: any;
+    };
+};
+
+/**
+ * **Database 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 database: {
+    driver: string;
+};
+
+/**
+ * **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 debug: DebugOptions;
+
+/**
+ * **Deployment Options**
  *
  * This configuration defines all of your deploy options. Because Stacks is full-typed,
  * you may hover any of the options below and the definitions will be provided. In case
@@ -25,7 +84,7 @@ declare const app: AppOptions;
 declare const deploy: DeployOptions;
 
 /**
- * ### Documentation Options
+ * **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
@@ -40,7 +99,7 @@ declare namespace docs {
 }
 
 /**
- * ### Git Options
+ * **Git Options**
  *
  * This configuration defines all of your git options. Because Stacks is full-typed, you may
  * hover any of the options below and the definitions will be provided. In case you
@@ -51,7 +110,7 @@ declare const git: GitOptions;
 declare const hashing: HashingOptions;
 
 /**
- * ### Library Options
+ * **Library Options**
  *
  * This configuration defines all of your library options. Because Stacks is full-typed, you
  * may hover any of the options below and the definitions will be provided. In case you
@@ -60,7 +119,125 @@ declare const hashing: HashingOptions;
 declare const library: LibraryOptions;
 
 /**
- * ### Services
+ * **Notification Options**
+ *
+ * This configuration defines all of your notification 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 notification: {
+    email: {
+        sendgrid: {
+            key: any;
+            from: any;
+            senderName: any;
+        };
+        emailjs: {
+            from: any;
+            host: any;
+            user: any;
+            password: any;
+            port: any;
+            secure: any;
+        };
+        mailgun: {
+            key: any;
+            domain: any;
+            username: any;
+            from: any;
+        };
+        mailjet: {
+            key: any;
+            secret: any;
+            from: any;
+        };
+        mandrill: {
+            key: any;
+            from: any;
+        };
+        netcore: {
+            key: any;
+            from: any;
+        };
+        nodemailer: {
+            from: any;
+            host: any;
+            user: any;
+            password: any;
+            port: any;
+            secure: any;
+        };
+        postmark: {
+            key: any;
+            from: any;
+        };
+        ses: {
+            region: any;
+            key: any;
+            secret: any;
+            from: any;
+        };
+    };
+    sms: {
+        twilio: {
+            sid: any;
+            authToken: any;
+            from: any;
+        };
+        nexmo: {
+            key: any;
+            secret: any;
+            from: any;
+        };
+        gupshup: {
+            user: any;
+            password: any;
+        };
+        plivo: {
+            sid: any;
+            authToken: any;
+            from: any;
+        };
+        sms77: {
+            key: any;
+            from: any;
+        };
+        sns: {
+            region: any;
+            key: any;
+            secret: any;
+        };
+        telnyx: {
+            key: any;
+            messageProfileId: any;
+            from: any;
+        };
+        termii: {
+            key: any;
+            from: any;
+        };
+    };
+    chat: {
+        discord: {};
+        slack: {
+            appId: any;
+            clientID: any;
+            secret: any;
+        };
+    };
+};
+
+/**
+ * **Search Engine Options**
+ *
+ * This configuration defines all of your search engine 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 searchEngine: SearchEngineOptions;
+
+/**
+ * **Services**
  *
  * This configuration defines all of your services. Because Stacks is full-typed, you may
  * hover any of the options below and the definitions will be provided. In case you
@@ -96,48 +273,23 @@ declare const services: {
 };
 
 /**
- * ### UI Engine Options
+ * **Database Options**
  *
- * This configuration defines all of your UI Engine 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.
+ * 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 ui: UiOptions;
+declare const storage: {
+    driver: string;
+};
 
 /**
- * ### Cache Options
+ * **UI Engine Options**
  *
- * This configuration defines all of your cache 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.
+ * This configuration defines all of your UI Engine 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 cache: {
-    default: any;
-    redis: {
-        driver: string;
-        connection: string;
-        host: any;
-        port: any;
-    };
-    memcached: {
-        driver: string;
-        persistent_id: any;
-        sasl: any[];
-        options: {};
-        servers: {
-            host: any;
-            port: any;
-            weight: number;
-        }[];
-    };
-    dynamodb: {
-        driver: string;
-        key: any;
-        secret: any;
-        region: any;
-        table: any;
-        endpoint: any;
-    };
-};
+declare const ui: UiOptions;
 
-export { app, cache, deploy, determineDebugMode, docs, git, hashing, library, services, ui };
+export { app, cache, config, database, debug, deploy, determineDebugMode, docs, env, git, hashing, library, notification, searchEngine, services, storage, ui };

package/dist/index.mjs

@@ -1,6 +1,33 @@
-import { env } from '@stacksjs/utils';
+import { env as env$1 } from '@stacksjs/utils';
 import { frameworkPath } from '@stacksjs/path';
 
+const c = {
+  __proto__: null,
+  get docs () { return docs$1; },
+  get config () { return config; },
+  get env () { return env; },
+  get determineDebugMode () { return determineDebugMode; },
+  get app () { return app; },
+  get cache () { return cache; },
+  get database () { return database; },
+  get debug () { return debug; },
+  get deploy () { return deploy; },
+  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; }
+};
+
+function config(key, fallback) {
+  return key ? c[key] : fallback;
+}
+function env(key, fallback) {
+  return fallback;
+}
 function determineDebugMode(options) {
   if (options?.debug === true)
     return true;
@@ -10,12 +37,12 @@ function determineDebugMode(options) {
 }
 
 const app = {
-  name: env("APP_NAME", "Stacks"),
-  env: env("APP_ENV", "local"),
-  key: env("APP_KEY", ""),
-  debug: env("APP_DEBUG", false),
-  url: env("APP_URL", "https://localhost"),
-  port: env("APP_PORT", 3333),
+  name: env$1("APP_NAME", "Stacks"),
+  env: env$1("APP_ENV", "local"),
+  key: env$1("APP_KEY", ""),
+  debug: env$1("APP_DEBUG", false),
+  url: env$1("APP_URL", "https://localhost"),
+  port: env$1("APP_PORT", 3333),
   timezone: "UTC",
   locale: "en",
   fallbackLocale: "en",
@@ -23,6 +50,49 @@ const app = {
   editor: "vscode"
 };
 
+const cache = {
+  default: env$1("CACHE_DRIVER", "redis"),
+  redis: {
+    driver: "redis",
+    connection: "cache",
+    host: env$1("REDIS_HOST", "127.0.0.1"),
+    port: env$1("REDIS_PORT", "6379")
+  },
+  memcached: {
+    driver: "memcached",
+    persistent_id: env$1("MEMCACHED_PERSISTENT_ID", ""),
+    sasl: [
+      env$1("MEMCACHED_USERNAME", ""),
+      env$1("MEMCACHED_PASSWORD", "")
+    ],
+    options: {},
+    servers: [{
+      host: env$1("MEMCACHED_HOST", "127.0.0.1"),
+      port: env$1("MEMCACHED_PORT", 11211),
+      weight: 100
+    }]
+  },
+  dynamodb: {
+    driver: "dynamodb",
+    key: env$1("AWS_ACCESS_KEY_ID", ""),
+    secret: env$1("AWS_SECRET_ACCESS_KEY", ""),
+    region: env$1("AWS_DEFAULT_REGION", "us-east-1"),
+    table: env$1("DYNAMODB_CACHE_TABLE", "cache"),
+    endpoint: env$1("DYNAMODB_ENDPOINT", "")
+  }
+};
+
+const database = {
+  driver: "planetscale"
+};
+
+const debug = {
+  driver: "ray",
+  enabled: true,
+  host: "localhost",
+  port: 23517
+};
+
 const deploy = {
   host: "netlify"
 };
@@ -271,6 +341,120 @@ const library = {
   }
 };
 
+const notification = {
+  email: {
+    sendgrid: {
+      key: env$1("SENDGRID_API_KEY", "test-value"),
+      from: env$1("SENDGRID_FROM", "test-value"),
+      senderName: env$1("SENDGRID_SENDER_NAME", "test-value")
+    },
+    emailjs: {
+      from: env$1("EMAILJS_FROM_EMAIL", "test-value"),
+      host: env$1("EMAILJS_HOST", "test-value"),
+      user: env$1("EMAILJS_USERNAME", "test-value"),
+      password: env$1("EMAILJS_PASSWORD", "test-value"),
+      port: env$1("EMAILJS_PORT", 40),
+      secure: env$1("EMAILJS_SECURE", true)
+    },
+    mailgun: {
+      key: env$1("MAILGUN_API_KEY", "test-value"),
+      domain: env$1("MAILGUN_DOMAIN", "test-value"),
+      username: env$1("MAILGUN_USERNAME", "test-value"),
+      from: env$1("MAILGUN_FROM", "test-value")
+    },
+    mailjet: {
+      key: env$1("MAILJET_API_KEY", "test-value"),
+      secret: env$1("MAILJET_API_SECRET", "test-value"),
+      from: env$1("MAILJET_FROM_EMAIL", "test-value")
+    },
+    mandrill: {
+      key: env$1("MANDRILL_API_KEY", "test-value"),
+      from: env$1("MANDRILL_EMAIL", "test-value")
+    },
+    netcore: {
+      key: env$1("NETCORE_API_KEY", "test-value"),
+      from: env$1("NETCORE_FROM", "test-value")
+    },
+    nodemailer: {
+      from: env$1("NODEMAILER_FROM_EMAIL", "test-value"),
+      host: env$1("NODEMAILER_HOST", "test-value"),
+      user: env$1("NODEMAILER_USERNAME", "test-value"),
+      password: env$1("NODEMAILER_PASSWORD", "test-value"),
+      port: env$1("NODEMAILER_PORT", 40),
+      secure: env$1("NODEMAILER_SECURE", true)
+    },
+    postmark: {
+      key: env$1("POSTMARK_API_KEY", "test-value"),
+      from: env$1("POSTMARK_FROM", "test-value")
+    },
+    ses: {
+      region: env$1("SES_REGION", "test-value"),
+      key: env$1("SES_ACCESS_KEY_ID", "test-value"),
+      secret: env$1("SES_SECRET_ACCESS_KEY", "test-value"),
+      from: env$1("SES_FROM", "test-value")
+    }
+  },
+  sms: {
+    twilio: {
+      sid: env$1("TWILIO_ACCOUNT_SID", "test-value"),
+      authToken: env$1("TWILIO_AUTH_TOKEN", "test-value"),
+      from: env$1("TWILIO_FROM_NUMBER", "test-value")
+    },
+    nexmo: {
+      key: env$1("VONAGE_API_KEY", "test-value"),
+      secret: env$1("VONAGE_API_SECRET", "test-value"),
+      from: env$1("VONAGE_FROM_NUMBER", "test-value")
+    },
+    gupshup: {
+      user: env$1("GUPSHUP_USER_ID", "test-value"),
+      password: env$1("GUPSHUP_PASSWORD", "test-value")
+    },
+    plivo: {
+      sid: env$1("PLIVO_ACCOUNT_ID", "test-value"),
+      authToken: env$1("PLIVO_AUTH_TOKEN", "test-value"),
+      from: env$1("PLIVO_FROM_NUMBER", "test-value")
+    },
+    sms77: {
+      key: env$1("SMS77_API_KEY", "test-value"),
+      from: env$1("SMS77_FROM", "test-value")
+    },
+    sns: {
+      region: env$1("SNS_REGION", "test-value"),
+      key: env$1("SNS_ACCESS_KEY_ID", "test-value"),
+      secret: env$1("SNS_SECRET_ACCESS_KEY", "test-value")
+    },
+    telnyx: {
+      key: env$1("TELNYX_API_KEY", "test-value"),
+      messageProfileId: env$1("TELNYX_MESSAGE_PROFILE_ID", "test-value"),
+      from: env$1("TELNYX_FROM", "test-value")
+    },
+    termii: {
+      key: env$1("TERMII_API_KEY", "test-value"),
+      from: env$1("TERMII_SENDER", "test-value")
+    }
+  },
+  chat: {
+    discord: {},
+    slack: {
+      appId: env$1("SLACK_APPLICATION_ID", "test-value"),
+      clientID: env$1("SLACK_CLIENT_ID", "test-value"),
+      secret: env$1("SLACK_SECRET_KEY", "test-value")
+    }
+  }
+};
+
+const searchEngine = {
+  driver: "meilisearch",
+  meilisearch: {
+    host: "",
+    apiKey: ""
+  }
+};
+
+const storage = {
+  driver: "s3"
+};
+
 const 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"]
@@ -286,36 +470,4 @@ const ui = {
   }
 };
 
-const cache = {
-  default: env("CACHE_DRIVER", "redis"),
-  redis: {
-    driver: "redis",
-    connection: "cache",
-    host: env("REDIS_HOST", "127.0.0.1"),
-    port: env("REDIS_PORT", "6379")
-  },
-  memcached: {
-    driver: "memcached",
-    persistent_id: env("MEMCACHED_PERSISTENT_ID"),
-    sasl: [
-      env("MEMCACHED_USERNAME", ""),
-      env("MEMCACHED_PASSWORD", "")
-    ],
-    options: {},
-    servers: [{
-      host: env("MEMCACHED_HOST", "127.0.0.1"),
-      port: env("MEMCACHED_PORT", 11211),
-      weight: 100
-    }]
-  },
-  dynamodb: {
-    driver: "dynamodb",
-    key: env("AWS_ACCESS_KEY_ID"),
-    secret: env("AWS_SECRET_ACCESS_KEY"),
-    region: env("AWS_DEFAULT_REGION", "us-east-1"),
-    table: env("DYNAMODB_CACHE_TABLE", "cache"),
-    endpoint: env("DYNAMODB_ENDPOINT")
-  }
-};
-
-export { app, cache, deploy, determineDebugMode, docs$1 as docs, git, hashing, library, services, ui };
+export { app, cache, config, database, debug, deploy, determineDebugMode, docs$1 as docs, env, git, hashing, library, notification, searchEngine, services, storage, ui };

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@stacksjs/config",
   "type": "module",
-  "version": "0.42.2",
-  "packageManager": "pnpm@7.17.0",
+  "version": "0.43.1",
+  "packageManager": "pnpm@7.17.1",
   "description": "The Stacks configuration.",
   "author": "Chris Breuer",
   "license": "MIT",
@@ -32,16 +32,16 @@
   ],
   "engines": {
     "node": ">=v18.12.1",
-    "pnpm": ">=7.17.0"
+    "pnpm": ">=7.17.1"
   },
   "peerDependencies": {
-    "@stacksjs/utils": "0.42.2"
+    "@stacksjs/utils": "0.43.1"
   },
   "devDependencies": {
     "mkdist": "^1.0.0",
     "typescript": "^4.9.3",
     "unbuild": "^1.0.1",
-    "@stacksjs/testing": "0.42.2"
+    "@stacksjs/testing": "0.43.1"
   },
   "scripts": {
     "build": "unbuild",