@stacksjs/config 0.50.0 → 0.58.28

package/src/helpers.ts

@@ -0,0 +1,256 @@
+import type { AppConfig, CacheConfig, CdnConfig, ChatConfig, CliConfig, DatabaseConfig, DependenciesConfig, DnsConfig, EmailConfig, Events, GitConfig, HashingConfig, JobConfig, LibraryConfig, Model, NotificationConfig, PaymentConfig, QueueConfig, SearchEngineConfig, SecurityConfig, ServicesConfig, SmsConfig, StacksConfig, StorageConfig, UiConfig } from '@stacksjs/types'
+import { createLocalTunnel } from '@stacksjs/tunnel'
+import { config } from '.'
+
+export type LocalUrlType = 'frontend' | 'backend' | 'api' | 'admin' | 'library' | 'email' | 'docs' | 'inspect' | 'desktop'
+
+export async function localUrl({
+  domain = config.app.url || 'stacks',
+  type = 'frontend' as LocalUrlType,
+  localhost = false,
+  https = undefined as boolean | undefined,
+  network = undefined as boolean | undefined,
+} = {}) {
+  // Ensure url starts with http:// or https://
+  // if (!url.startsWith('http://') && !url.startsWith('https://'))
+  //   url = 'https://' + url
+  let url
+
+  switch (type) {
+    case 'frontend':
+      if (network)
+        return await createLocalTunnel(config.app.ports?.frontend || 3333)
+
+      if (localhost)
+        return `http://localhost:${config.app.ports?.frontend}`
+
+      url = domain.replace(/\.[^\.]+$/, '.localhost')
+
+      if (https)
+        return `https://${url}`
+
+      return url
+    case 'backend':
+      if (network)
+        return await createLocalTunnel(config.app.ports?.backend || 3334)
+
+      if (localhost)
+        return `http://localhost:${config.app.ports?.backend}`
+
+      url = domain.replace(/\.[^\.]+$/, '.localhost/api/')
+
+      if (https)
+        return `https://${url}`
+
+      return url
+    case 'api':
+      if (network)
+        return await createLocalTunnel(config.app.ports?.backend || 3334)
+
+      if (localhost)
+        return `http://localhost:${config.app.ports?.backend}`
+
+      url = domain.replace(/\.[^\.]+$/, '.localhost/api/')
+
+      if (https)
+        return `https://${url}`
+
+      return url
+    case 'admin':
+      if (network)
+        return await createLocalTunnel(config.app.ports?.admin || 3335)
+
+      if (localhost)
+        return `http://localhost:${config.app.ports?.admin}`
+
+      url = domain.replace(/\.[^\.]+$/, '.localhost/admin/')
+
+      if (https)
+        return `https://${url}`
+
+      return url
+    case 'library':
+      if (network)
+        return await createLocalTunnel(config.app.ports?.library || 3336)
+
+      if (localhost)
+        return `http://localhost:${config.app.ports?.library}`
+
+      url = domain.replace(/\.[^\.]+$/, '.localhost/libs/')
+
+      if (https)
+        return `https://${url}`
+
+      return url
+    case 'email':
+      if (network)
+        return await createLocalTunnel(config.app.ports?.email || 3338)
+
+      if (localhost)
+        return `http://localhost:${config.app.ports?.email}`
+
+      url = domain.replace(/\.[^\.]+$/, '.localhost/email/')
+
+      if (https)
+        return `https://${url}`
+
+      return url
+    case 'desktop':
+      if (network)
+        return await createLocalTunnel(config.app.ports?.desktop || 3337)
+
+      if (localhost)
+        return `http://localhost:${config.app.ports?.email}`
+
+      url = domain.replace(/\.[^\.]+$/, '.localhost/email/')
+
+      if (https)
+        return `https://${url}`
+
+      return url
+    case 'docs':
+      if (network)
+        return await createLocalTunnel(config.app.ports?.desktop || 3339)
+
+      if (localhost)
+        return `http://localhost:${config.app.ports?.docs}`
+
+      url = domain.replace(/\.[^\.]+$/, '.localhost/docs/')
+
+      if (https)
+        return `https://${url}`
+
+      return url
+    case 'inspect':
+      if (network)
+        return await createLocalTunnel(config.app.ports?.desktop || 3340)
+
+      if (localhost)
+        return `http://localhost:${config.app.ports?.inspect}`
+
+      url = domain.replace(/\.[^\.]+$/, '.localhost/__inspect/')
+
+      if (https)
+        return `https://${url}`
+
+      return url
+    default:
+      if (localhost)
+        return `http://localhost:${config.app.ports?.frontend}`
+
+      url = domain.replace(/\.[^\.]+$/, '.localhost')
+
+      if (https)
+        return `https://${url}`
+
+      return url
+  }
+}
+
+export function defineStacksConfig(config: StacksConfig) {
+  return config
+}
+
+export function defineApp(config: AppConfig) {
+  return config
+}
+
+export function defineCache(config: CacheConfig) {
+  return config
+}
+
+export function defineCdn(config: CdnConfig) {
+  return config
+}
+
+export function defineChat(config: ChatConfig) {
+  return config
+}
+
+export function defineCli(config: CliConfig) {
+  return config
+}
+
+export function defineJob(config: JobConfig) {
+  return config
+}
+
+export function defineCronJob(config: JobConfig) {
+  return config
+}
+
+export function defineDatabase(config: DatabaseConfig) {
+  return config
+}
+
+export function defineDependencies(config: DependenciesConfig) {
+  return config
+}
+
+export function defineDns(config: DnsConfig) {
+  return config
+}
+
+export function defineEmailConfig(config: EmailConfig) {
+  return config
+}
+
+export function defineEmail(config: EmailConfig) {
+  return config
+}
+
+export function defineGit(config: GitConfig) {
+  return config
+}
+
+export function defineHashing(config: HashingConfig) {
+  return config
+}
+
+export function defineLibrary(config: LibraryConfig) {
+  return config
+}
+
+export function defineNotification(config: NotificationConfig) {
+  return config
+}
+
+export function definePayment(config: PaymentConfig) {
+  return config
+}
+
+export function defineQueue(config: QueueConfig) {
+  return config
+}
+
+export function defineSearchEngine(config: SearchEngineConfig) {
+  return config
+}
+
+export function defineSecurity(config: SecurityConfig) {
+  return config
+}
+
+export function defineServices(config: ServicesConfig) {
+  return config
+}
+
+export function defineSms(config: SmsConfig) {
+  return config
+}
+
+export function defineStorage(config: StorageConfig) {
+  return config
+}
+
+export function defineUi(config: UiConfig) {
+  return config
+}
+
+export function defineModel(config: Model) {
+  return config
+}
+
+export function defineEvents(config: Events) {
+  return config
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * as config from './config'
+export * from './config'

package/src/overrides.ts

@@ -0,0 +1,49 @@
+import type { StacksConfig } from '@stacksjs/types'
+import ai from '../../../../../config/ai'
+import api from '../../../../../config/api'
+import app from '../../../../../config/app'
+import cache from '../../../../../config/cache'
+import binary from '../../../../../config/cli'
+import cloud from '../../../../../config/cloud'
+import database from '../../../../../config/database'
+import dns from '../../../../../config/dns'
+import docs from '../../../../../config/docs'
+import email from '../../../../../config/email'
+import git from '../../../../../config/git'
+import hashing from '../../../../../config/hashing'
+import library from '../../../../../config/library'
+import queue from '../../../../../config/queue'
+import payment from '../../../../../config/payment'
+import notification from '../../../../../config/notification'
+import storage from '../../../../../config/storage'
+import searchEngine from '../../../../../config/search-engine'
+import security from '../../../../../config/security'
+import services from '../../../../../config/services'
+import team from '../../../../../config/team'
+import ui from '../../../../../config/ui'
+
+// this "user config" will override the default config options
+export default {
+  ai,
+  api,
+  app,
+  binary,
+  cache,
+  cloud,
+  database,
+  dns,
+  docs,
+  email,
+  git,
+  hashing,
+  library,
+  notification,
+  queue,
+  payment,
+  searchEngine,
+  security,
+  services,
+  storage,
+  team,
+  ui,
+} satisfies StacksConfig

package/LICENSE.md

@@ -1,21 +0,0 @@
-# MIT License
-
-Copyright (c) 2022 Open Web Foundation
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/dist/index.d.ts

@@ -1,204 +0,0 @@
-import { CliOptions, AppOptions, DebugOptions, DeployOptions, Events, DocsConfig, GitOptions, HashingOptions, LibraryOptions, NotificationOptions, 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
- */
-declare function determineDebugMode(options?: CliOptions): boolean;
-
-/**
- * **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
- * you have any questions, feel free to reach out via Discord or GitHub Discussions.
- */
-declare const app: AppOptions;
-
-/**
- * **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: {
-    driver: any;
-    redis: {
-        connection: string;
-        host: any;
-        port: any;
-    };
-    memcached: {
-        persistent_id: any;
-        sasl: any[];
-        options: {};
-        servers: {
-            host: any;
-            port: any;
-            weight: number;
-        }[];
-    };
-    dynamodb: {
-        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
- * you have any questions, feel free to reach out via Discord or GitHub Discussions.
- */
-declare const deploy: 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
- * 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,
-  };
-}
-
-/**
- * **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
- * have any questions, feel free to reach out via Discord or GitHub Discussions.
- */
-declare const git: GitOptions;
-
-declare const hashing: HashingOptions;
-
-/**
- * **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
- * have any questions, feel free to reach out via Discord or GitHub Discussions.
- */
-declare const library: LibraryOptions;
-
-/**
- * **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: NotificationOptions;
-
-/**
- * **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
- * have any questions, feel free to reach out via Discord or GitHub Discussions.
- */
-declare const services: {
-    algolia: {
-        appId: string;
-        apiKey: string;
-        indexName: string;
-    };
-    meilisearch: {
-        appId: string;
-        apiKey: string;
-        indexName: string;
-    };
-    stripe: {
-        appId: string;
-        apiKey: string;
-    };
-    planetscale: {
-        appId: string;
-        apiKey: string;
-    };
-    supabase: {
-        appId: string;
-        apiKey: string;
-    };
-    aws: {
-        appId: string;
-        apiKey: string;
-    };
-    novu: {
-        key: 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 storage: {
-    driver: string;
-};
-
-/**
- * **UI Engine 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.
- */
-declare const ui: UiOptions;
-
-export { app, cache, config, database, debug, deploy, determineDebugMode, docs, env, events, git, hashing, library, notification, searchEngine, services, storage, ui };