@stacksjs/config 0.64.5 → 0.65.0

package/src/defaults.ts

@@ -1,9 +1,9 @@
-import { commandsPath, userDatabasePath } from '@stacksjs/path'
 import type { StacksOptions } from '@stacksjs/types'
+import { commandsPath, userDatabasePath } from '@stacksjs/path'
 
 // import { userConfig as overrides } from './overrides'
 
-export default {
+const config: StacksOptions = {
   ai: {
     deploy: false,
     models: [
@@ -187,50 +187,50 @@ export default {
 
   errors: {
     messages: {
-      string: 'The {{ field }} field must be a string',
-      email: 'The {{ field }} field must be a valid email address',
-      regex: 'The {{ field }} field format is invalid',
-      url: 'The {{ field }} field must be a valid URL',
-      activeUrl: 'The {{ field }} field must be a valid URL',
-      alpha: 'The {{ field }} field must contain only letters',
-      alphaNumeric: 'The {{ field }} field must contain only letters and numbers',
-      minLength: 'The {{ field }} field must have at least {{ min }} characters',
-      maxLength: 'The {{ field }} field must not be greater than {{ max }} characters',
-      fixedLength: 'The {{ field }} field must be {{ size }} characters long',
-      confirmed: 'The {{ field }} field and {{ otherField }} field must be the same',
-      endsWith: 'The {{ field }} field must end with {{ substring }}',
-      startsWith: 'The {{ field }} field must start with {{ substring }}',
-      sameAs: 'The {{ field }} field and {{ otherField }} field must be the same',
-      notSameAs: 'The {{ field }} field and {{ otherField }} field must be different',
-      in: 'The selected {{ field }} is invalid',
-      notIn: 'The selected {{ field }} is invalid',
-      ipAddress: 'The {{ field }} field must be a valid IP address',
-      uuid: 'The {{ field }} field must be a valid UUID',
-      ascii: 'The {{ field }} field must only contain ASCII characters',
-      creditCard: 'The {{ field }} field must be a valid {{ providersList }} card number',
-      hexCode: 'The {{ field }} field must be a valid hex color code',
-      iban: 'The {{ field }} field must be a valid IBAN number',
-      jwt: 'The {{ field }} field must be a valid JWT token',
-      coordinates: 'The {{ field }} field must contain latitude and longitude coordinates',
-      mobile: 'The {{ field }} field must be a valid mobile phone number',
-      passport: 'The {{ field }} field must be a valid passport number',
-      postalCode: 'The {{ field }} field must be a valid postal code',
+      'string': 'The {{ field }} field must be a string',
+      'email': 'The {{ field }} field must be a valid email address',
+      'regex': 'The {{ field }} field format is invalid',
+      'url': 'The {{ field }} field must be a valid URL',
+      'activeUrl': 'The {{ field }} field must be a valid URL',
+      'alpha': 'The {{ field }} field must contain only letters',
+      'alphaNumeric': 'The {{ field }} field must contain only letters and numbers',
+      'minLength': 'The {{ field }} field must have at least {{ min }} characters',
+      'maxLength': 'The {{ field }} field must not be greater than {{ max }} characters',
+      'fixedLength': 'The {{ field }} field must be {{ size }} characters long',
+      'confirmed': 'The {{ field }} field and {{ otherField }} field must be the same',
+      'endsWith': 'The {{ field }} field must end with {{ substring }}',
+      'startsWith': 'The {{ field }} field must start with {{ substring }}',
+      'sameAs': 'The {{ field }} field and {{ otherField }} field must be the same',
+      'notSameAs': 'The {{ field }} field and {{ otherField }} field must be different',
+      'in': 'The selected {{ field }} is invalid',
+      'notIn': 'The selected {{ field }} is invalid',
+      'ipAddress': 'The {{ field }} field must be a valid IP address',
+      'uuid': 'The {{ field }} field must be a valid UUID',
+      'ascii': 'The {{ field }} field must only contain ASCII characters',
+      'creditCard': 'The {{ field }} field must be a valid {{ providersList }} card number',
+      'hexCode': 'The {{ field }} field must be a valid hex color code',
+      'iban': 'The {{ field }} field must be a valid IBAN number',
+      'jwt': 'The {{ field }} field must be a valid JWT token',
+      'coordinates': 'The {{ field }} field must contain latitude and longitude coordinates',
+      'mobile': 'The {{ field }} field must be a valid mobile phone number',
+      'passport': 'The {{ field }} field must be a valid passport number',
+      'postalCode': 'The {{ field }} field must be a valid postal code',
 
       // boolean
-      boolean: 'The value must be a boolean',
+      'boolean': 'The value must be a boolean',
 
       // number
-      number: 'The {{ field }} field must be a number',
-      min: 'The {{ field }} field must be at least {{ min }}',
-      max: 'The {{ field }} field must not be greater than {{ max }}',
-      range: 'The {{ field }} field must be between {{ min }} and {{ max }}',
-      positive: 'The {{ field }} field must be positive',
-      negative: 'The {{ field }} field must be negative',
-      decimal: 'The {{ field }} field must have {{ digits }} decimal places',
-      withoutDecimals: 'The {{ field }} field must not have decimal places',
+      'number': 'The {{ field }} field must be a number',
+      'min': 'The {{ field }} field must be at least {{ min }}',
+      'max': 'The {{ field }} field must not be greater than {{ max }}',
+      'range': 'The {{ field }} field must be between {{ min }} and {{ max }}',
+      'positive': 'The {{ field }} field must be positive',
+      'negative': 'The {{ field }} field must be negative',
+      'decimal': 'The {{ field }} field must have {{ digits }} decimal places',
+      'withoutDecimals': 'The {{ field }} field must not have decimal places',
 
       // date
-      date: 'The {{ field }} field must be a datetime value',
+      'date': 'The {{ field }} field must be a datetime value',
       'date.equals': 'The {{ field }} field must be a date equal to {{ expectedValue }}',
       'date.after': 'The {{ field }} field must be a date after {{ expectedValue }}',
       'date.before': 'The {{ field }} field must be a date before {{ expectedValue }}',
@@ -241,38 +241,38 @@ export default {
       'date.afterField': 'The {{ field }} field must be a date after {{ otherField }}',
 
       // accepted
-      accepted: 'The {{ field }} field must be accepted',
+      'accepted': 'The {{ field }} field must be accepted',
 
       // enum
-      enum: 'The selected {{ field }} is invalid',
+      'enum': 'The selected {{ field }} is invalid',
 
       // literal
-      literal: 'The {{ field }} field must be {{ expectedValue }}',
+      'literal': 'The {{ field }} field must be {{ expectedValue }}',
 
       // object
-      object: 'The {{ field }} field must be an object',
+      'object': 'The {{ field }} field must be an object',
 
       // record
-      record: 'The {{ field }} field must be an object',
+      'record': 'The {{ field }} field must be an object',
       'record.minLength': 'The {{ field }} field must have at least {{ min }} items',
       'record.maxLength': 'The {{ field }} field must not have more than {{ max }} items',
       'record.fixedLength': 'The {{ field }} field must contain {{ size }} items',
 
       // array
-      array: 'The {{ field }} field must be an array',
+      'array': 'The {{ field }} field must be an array',
       'array.minLength': 'The {{ field }} field must have at least {{ min }} items',
       'array.maxLength': 'The {{ field }} field must not have more than {{ max }} items',
       'array.fixedLength': 'The {{ field }} field must contain {{ size }} items',
-      notEmpty: 'The {{ field }} field must not be empty',
-      distinct: 'The {{ field }} field has duplicate values',
+      'notEmpty': 'The {{ field }} field must not be empty',
+      'distinct': 'The {{ field }} field has duplicate values',
 
       // tuple
-      tuple: 'The {{ field }} field must be an array',
+      'tuple': 'The {{ field }} field must be an array',
 
       // union
-      union: 'Invalid value provided for {{ field }} field',
-      unionGroup: 'Invalid value provided for {{ field }} field',
-      unionOfTypes: 'Invalid value provided for {{ field }} field',
+      'union': 'Invalid value provided for {{ field }} field',
+      'unionGroup': 'Invalid value provided for {{ field }} field',
+      'unionOfTypes': 'Invalid value provided for {{ field }} field',
     },
   },
 
@@ -613,4 +613,6 @@ export default {
       },
     },
   },
-} satisfies StacksOptions
+}
+
+export default config

package/src/helpers.ts

@@ -1,4 +1,3 @@
-import { createLocalTunnel } from '@stacksjs/tunnel'
 import type {
   AppConfig,
   CacheConfig,
@@ -25,6 +24,7 @@ import type {
   StorageConfig,
   UiConfig,
 } from '@stacksjs/types'
+import { createLocalTunnel } from '@stacksjs/tunnel'
 import { config } from '.'
 
 export type LocalUrlType =
@@ -44,218 +44,185 @@ export async function localUrl({
   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
+}: {
+  domain?: string
+  type?: LocalUrlType
+  network?: boolean
+  localhost?: boolean
+  https?: boolean
+} = {}): Promise<string> {
+  let url = domain.replace(/\.[^.]+$/, '.localhost')
 
   switch (type) {
     case 'frontend':
-      if (network) return await createLocalTunnel(config.ports?.frontend || 3000)
-
-      if (localhost) return `http://localhost:${config.ports?.frontend}`
-
-      url = domain.replace(/\.[^\.]+$/, '.localhost')
-
-      if (https) return `https://${url}`
-
-      return url
+      if (network)
+        return await createLocalTunnel(config.ports?.frontend || 3000)
+      if (localhost)
+        return `http://localhost:${config.ports?.frontend}`
+      break
     case 'backend':
-      if (network) return await createLocalTunnel(config.ports?.backend || 3001)
-
-      if (localhost) return `http://localhost:${config.ports?.backend}`
-
-      url = domain.replace(/\.[^\.]+$/, '.localhost/api/')
-
-      if (https) return `https://${url}`
-
-      return url
-    case 'api':
-      if (network) return await createLocalTunnel(config.ports?.backend || 3001)
-
-      if (localhost) return `http://localhost:${config.ports?.backend}`
-
-      url = domain.replace(/\.[^\.]+$/, '.localhost/api/')
-
-      if (https) return `https://${url}`
-
-      return url
+      if (network)
+        return await createLocalTunnel(config.ports?.backend || 3001)
+      if (localhost)
+        return `http://localhost:${config.ports?.backend}`
+      url = `api.${url}`
+      break
     case 'admin':
-      if (network) return await createLocalTunnel(config.ports?.admin || 3002)
-
-      if (localhost) return `http://localhost:${config.ports?.admin}`
-
-      url = domain.replace(/\.[^\.]+$/, '.localhost/admin/')
-
-      if (https) return `https://${url}`
-
-      return url
+      if (network)
+        return await createLocalTunnel(config.ports?.admin || 3002)
+      if (localhost)
+        return `http://localhost:${config.ports?.admin}`
+      url = `admin.${url}`
+      break
     case 'library':
-      if (network) return await createLocalTunnel(config.ports?.library || 3003)
-
-      if (localhost) return `http://localhost:${config.ports?.library}`
-
-      url = domain.replace(/\.[^\.]+$/, '.localhost/libs/')
-
-      if (https) return `https://${url}`
-
-      return url
+      if (network)
+        return await createLocalTunnel(config.ports?.library || 3003)
+      if (localhost)
+        return `http://localhost:${config.ports?.library}`
+      url = `libs.${url}`
+      break
     case 'email':
-      if (network) return await createLocalTunnel(config.ports?.email || 3005)
-
-      if (localhost) return `http://localhost:${config.ports?.email}`
-
-      url = domain.replace(/\.[^\.]+$/, '.localhost/email/')
-
-      if (https) return `https://${url}`
-
-      return url
+      if (network)
+        return await createLocalTunnel(config.ports?.email || 3005)
+      if (localhost)
+        return `http://localhost:${config.ports?.email}`
+      url = `email.${url}`
+      break
     case 'desktop':
-      if (network) return await createLocalTunnel(config.ports?.desktop || 3004)
-
-      if (localhost) return `http://localhost:${config.ports?.email}`
-
-      url = domain.replace(/\.[^\.]+$/, '.localhost/email/')
-
-      if (https) return `https://${url}`
-
-      return url
+      if (network)
+        return await createLocalTunnel(config.ports?.desktop || 3004)
+      if (localhost)
+        return `http://localhost:${config.ports?.desktop}`
+      url = `desktop.${url}`
+      break
     case 'docs':
-      if (network) return await createLocalTunnel(config.ports?.desktop || 3006)
-
-      if (localhost) return `http://localhost:${config.ports?.docs}`
-
-      url = domain.replace(/\.[^\.]+$/, '.localhost/docs/')
-
-      if (https) return `https://${url}`
-
-      return url
+      if (network)
+        return await createLocalTunnel(config.ports?.docs || 3006)
+      if (localhost)
+        return `http://localhost:${config.ports?.docs}`
+      url = `docs.${url}`
+      break
     case 'inspect':
-      if (network) return await createLocalTunnel(config.ports?.desktop || 3007)
-
-      if (localhost) return `http://localhost:${config.ports?.inspect}`
-
-      url = domain.replace(/\.[^\.]+$/, '.localhost/__inspect/')
-
-      if (https) return `https://${url}`
-
-      return url
+      if (network)
+        return await createLocalTunnel(config.ports?.inspect || 3007)
+      if (localhost)
+        return `http://localhost:${config.ports?.inspect}`
+      url = `inspect.${url}`
+      break
     default:
-      if (localhost) return `http://localhost:${config.ports?.frontend}`
-
-      url = domain.replace(/\.[^\.]+$/, '.localhost')
-
-      if (https) return `https://${url}`
-
-      return url
+      if (localhost)
+        return `http://localhost:${config.ports?.frontend}`
   }
+
+  if (https)
+    return `https://${url}`
+  return `http://${url}`
 }
 
-export function defineStacksConfig(config: StacksConfig) {
+export function defineStacksConfig(config: StacksConfig): StacksConfig {
   return config
 }
 
-export function defineApp(config: AppConfig) {
+export function defineApp(config: AppConfig): AppConfig {
   return config
 }
 
-export function defineCache(config: CacheConfig) {
+export function defineCache(config: CacheConfig): CacheConfig {
   return config
 }
 
-export function defineCdn(config: CdnConfig) {
+export function defineCdn(config: CdnConfig): CdnConfig {
   return config
 }
 
-export function defineChat(config: ChatConfig) {
+export function defineChat(config: ChatConfig): ChatConfig {
   return config
 }
 
-export function defineCli(config: CliConfig) {
+export function defineCli(config: CliConfig): CliConfig {
   return config
 }
 
-export function defineJob(config: JobConfig) {
+export function defineJob(config: JobConfig): JobConfig {
   return config
 }
 
-export function defineCronJob(config: JobConfig) {
+export function defineCronJob(config: JobConfig): JobConfig {
   return config
 }
 
-export function defineDatabase(config: DatabaseConfig) {
+export function defineDatabase(config: DatabaseConfig): DatabaseConfig {
   return config
 }
 
-export function defineDependencies(config: DependenciesConfig) {
+export function defineDependencies(config: DependenciesConfig): DependenciesConfig {
   return config
 }
 
-export function defineDns(config: DnsConfig) {
+export function defineDns(config: DnsConfig): DnsConfig {
   return config
 }
 
-export function defineEmailConfig(config: EmailConfig) {
+export function defineEmailConfig(config: EmailConfig): EmailConfig {
   return config
 }
 
-export function defineEmail(config: EmailConfig) {
+export function defineEmail(config: EmailConfig): EmailConfig {
   return config
 }
 
-export function defineGit(config: GitConfig) {
+export function defineGit(config: GitConfig): GitConfig {
   return config
 }
 
-export function defineHashing(config: HashingConfig) {
+export function defineHashing(config: HashingConfig): HashingConfig {
   return config
 }
 
-export function defineLibrary(config: LibraryConfig) {
+export function defineLibrary(config: LibraryConfig): LibraryConfig {
   return config
 }
 
-export function defineNotification(config: NotificationConfig) {
+export function defineNotification(config: NotificationConfig): NotificationConfig {
   return config
 }
 
-export function definePayment(config: PaymentConfig) {
+export function definePayment(config: PaymentConfig): PaymentConfig {
   return config
 }
 
-export function defineQueue(config: QueueConfig) {
+export function defineQueue(config: QueueConfig): QueueConfig {
   return config
 }
 
-export function defineSearchEngine(config: SearchEngineConfig) {
+export function defineSearchEngine(config: SearchEngineConfig): SearchEngineConfig {
   return config
 }
 
-export function defineSecurity(config: SecurityConfig) {
+export function defineSecurity(config: SecurityConfig): SecurityConfig {
   return config
 }
 
-export function defineServices(config: ServicesConfig) {
+export function defineServices(config: ServicesConfig): ServicesConfig {
   return config
 }
 
-export function defineSms(config: any) {
+export function defineSms(config: any): any {
   return config
 }
 
-export function defineStorage(config: StorageConfig) {
+export function defineStorage(config: StorageConfig): StorageConfig {
   return config
 }
 
-export function defineUi(config: UiConfig) {
+export function defineUi(config: UiConfig): UiConfig {
   return config
 }
 
-export function defineModel(config: Model) {
+export function defineModel(config: Model): Model {
   return config
 }
 
-export function defineEvents(config: Events) {
+export function defineEvents(config: Events): Events {
   return config
 }

package/src/overrides.ts

@@ -25,8 +25,7 @@ import team from '~/config/team'
 import ui from '~/config/ui'
 // import docs from '~/docs/config'
 
-// this "user config" will override the default config options
-export default {
+const config: StacksConfig = {
   ai,
   analytics,
   app,
@@ -52,4 +51,6 @@ export default {
   storage,
   team,
   ui,
-} satisfies StacksConfig
+}
+
+export default config