@stacksjs/config 0.59.11 → 0.61.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/config",
   "type": "module",
-  "version": "0.59.11",
+  "version": "0.61.0",
   "description": "The Stacks config helper methods.",
   "author": "Chris Breuer",
   "license": "MIT",

package/src/config.ts

@@ -11,6 +11,7 @@ export const config: StacksOptions = {
 export const {
   ai,
   analytics,
+  api,
   app,
   cache,
   cloud,
@@ -19,6 +20,7 @@ export const {
   dns,
   docs,
   email,
+  errors,
   git,
   hashing,
   library,
@@ -38,3 +40,12 @@ export const {
 export { defaults, overrides }
 
 export * from './helpers'
+
+export const determineAppEnv = (): string => {
+  if (app.env === 'local') return 'dev'
+  if (app.env === 'development') return 'dev'
+  if (app.env === 'staging') return 'stage'
+  if (app.env === 'production') return 'prod'
+
+  return app.env
+}

package/src/defaults.ts

@@ -1,4 +1,4 @@
-import { commandsPath, projectStoragePath } from '@stacksjs/path'
+import { commandsPath, userDatabasePath } from '@stacksjs/path'
 import type { StacksOptions } from '@stacksjs/types'
 
 // import { userConfig as overrides } from './overrides'
@@ -24,6 +24,19 @@ export default {
     driver: undefined,
   },
 
+  api: {
+    // version: 'v1',
+    prefix: 'api',
+    middleware: ['auth'],
+    routes: {
+      index: true,
+      show: true,
+      store: true,
+      update: true,
+      destroy: true,
+    },
+  },
+
   app: {
     name: 'Stacks',
     description: 'A Stacks application.',
@@ -106,30 +119,21 @@ export default {
       },
     },
 
-    api: {
-      deploy: false,
-      prefix: 'api',
-      description: 'Stacks API',
-      prewarm: true,
-      memorySize: 512,
-      timeout: 30,
-      // version: 'v1',
-    },
-
     fileSystem: false,
   },
 
   database: {
     default: 'sqlite',
 
-    name: 'stacks',
-
     connections: {
       sqlite: {
-        database: projectStoragePath('framework/database/stacks.sqlite'),
+        database: userDatabasePath('stacks.sqlite'),
         prefix: '',
       },
     },
+
+    migrations: 'migrations',
+    migrationLocks: 'migration_locks',
   },
 
   dns: {
@@ -181,6 +185,97 @@ 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',
+
+      // 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',
+
+      // date
+      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 }}',
+      'date.afterOrEqual': 'The {{ field }} field must be a date after or equal to {{ expectedValue }}',
+      'date.beforeOrEqual': 'The {{ field }} field must be a date before or equal to {{ expectedValue }}',
+      'date.sameAs': 'The {{ field }} field and {{ otherField }} field must be the same',
+      'date.notSameAs': 'The {{ field }} field and {{ otherField }} field must be different',
+      'date.afterField': 'The {{ field }} field must be a date after {{ otherField }}',
+
+      // accepted
+      accepted: 'The {{ field }} field must be accepted',
+
+      // enum
+      enum: 'The selected {{ field }} is invalid',
+
+      // literal
+      literal: 'The {{ field }} field must be {{ expectedValue }}',
+
+      // object
+      object: 'The {{ field }} field must be an object',
+
+      // record
+      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.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',
+
+      // tuple
+      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',
+    },
+  },
+
   git: {
     hooks: {
       'pre-commit': 'lint-staged',
@@ -242,17 +337,57 @@ export default {
     },
 
     types: [
-      { value: 'feat', name: 'feat:     ✨  A new feature', emoji: ':sparkles:' },
+      {
+        value: 'feat',
+        name: 'feat:     ✨  A new feature',
+        emoji: ':sparkles:',
+      },
       { value: 'fix', name: 'fix:      🐛  A bug fix', emoji: ':bug:' },
-      { value: 'docs', name: 'docs:     📝  Documentation only changes', emoji: ':memo:' },
-      { value: 'style', name: 'style:    💄  Changes that do not affect the meaning of the code', emoji: ':lipstick:' },
-      { value: 'refactor', name: 'refactor: ♻️   A code change that neither fixes a bug nor adds a feature', emoji: ':recycle:' },
-      { value: 'perf', name: 'perf:     ⚡️  A code change that improves performance', emoji: ':zap:' },
-      { value: 'test', name: 'test:     ✅  Adding missing tests or adjusting existing tests', emoji: ':white_check_mark:' },
-      { value: 'build', name: 'build:    📦️  Changes that affect the build system or external dependencies', emoji: ':package:' },
-      { value: 'ci', name: 'ci:       🎡  Changes to our CI configuration files and scripts', emoji: ':ferris_wheel:' },
-      { value: 'chore', name: 'chore:    🔨  Other changes that don’t modify src or test files', emoji: ':hammer:' },
-      { value: 'revert', name: 'revert:   ⏪️  Reverts a previous commit', emoji: ':rewind:' },
+      {
+        value: 'docs',
+        name: 'docs:     📝  Documentation only changes',
+        emoji: ':memo:',
+      },
+      {
+        value: 'style',
+        name: 'style:    💄  Changes that do not affect the meaning of the code',
+        emoji: ':lipstick:',
+      },
+      {
+        value: 'refactor',
+        name: 'refactor: ♻️   A code change that neither fixes a bug nor adds a feature',
+        emoji: ':recycle:',
+      },
+      {
+        value: 'perf',
+        name: 'perf:     ⚡️  A code change that improves performance',
+        emoji: ':zap:',
+      },
+      {
+        value: 'test',
+        name: 'test:     ✅  Adding missing tests or adjusting existing tests',
+        emoji: ':white_check_mark:',
+      },
+      {
+        value: 'build',
+        name: 'build:    📦️  Changes that affect the build system or external dependencies',
+        emoji: ':package:',
+      },
+      {
+        value: 'ci',
+        name: 'ci:       🎡  Changes to our CI configuration files and scripts',
+        emoji: ':ferris_wheel:',
+      },
+      {
+        value: 'chore',
+        name: 'chore:    🔨  Other changes that don’t modify src or test files',
+        emoji: ':hammer:',
+      },
+      {
+        value: 'revert',
+        name: 'revert:   ⏪️  Reverts a previous commit',
+        emoji: ':rewind:',
+      },
     ],
   },
 
@@ -266,7 +401,7 @@ export default {
 
     argon2: {
       memory: 65536, // memory usage in kibibytes
-      threads: 1,
+      // threads: 1,
       time: 1, // the number of iterations
     },
   },
@@ -284,28 +419,36 @@ export default {
       name: 'hello-world-vue',
       description: 'Your Vue component library description',
       keywords: ['component', 'library', 'vue', 'vite', 'typescript', 'javascript'],
-      tags: [{
-        name: ['HelloWorld', 'AppHelloWorld'],
-        description: 'The Hello World custom element, built via this framework.',
-        attributes: [{
-          name: 'greeting',
-          description: 'The greeting.',
-        }],
-      }],
+      tags: [
+        {
+          name: ['HelloWorld', 'AppHelloWorld'],
+          description: 'The Hello World custom element, built via this framework.',
+          attributes: [
+            {
+              name: 'greeting',
+              description: 'The greeting.',
+            },
+          ],
+        },
+      ],
     },
 
     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.',
-        }],
-      }],
+      tags: [
+        {
+          name: ['HelloWorld', 'AppHelloWorld'],
+          description: 'The Hello World custom element, built via this framework.',
+          attributes: [
+            {
+              name: 'greeting',
+              description: 'The greeting.',
+            },
+          ],
+        },
+      ],
     },
 
     functions: {
@@ -313,10 +456,7 @@ export default {
       description: 'Your function library description.',
       keywords: ['functions', 'composables', 'library', 'typescript', 'javascript'],
       shouldGenerateSourcemap: false,
-      functions: [
-        'counter',
-        'dark',
-      ],
+      functions: ['counter', 'dark'],
     },
   },
 
@@ -345,6 +485,7 @@ export default {
     inspect: 3007,
     api: 3008,
     systemTray: 3009,
+    database: 3010,
     // mobile: 3010,
   },
 
@@ -383,7 +524,7 @@ export default {
   },
 
   searchEngine: {
-    driver: 'meilisearch',
+    driver: 'opensearch',
   },
 
   security: {
@@ -422,11 +563,6 @@ export default {
       appId: '',
       apiKey: '',
     },
-
-    supabase: {
-      appId: '',
-      apiKey: '',
-    },
   },
 
   storage: {
@@ -442,7 +578,10 @@ export default {
 
   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'],
+      [
+        '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',

package/src/helpers.ts

@@ -1,8 +1,42 @@
-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 type {
+  AppConfig,
+  CacheConfig,
+  CdnConfig,
+  ChatConfig,
+  CliConfig,
+  DatabaseConfig,
+  DependenciesConfig,
+  DnsConfig,
+  EmailConfig,
+  Events,
+  GitConfig,
+  HashingConfig,
+  JobConfig,
+  LibraryConfig,
+  Model,
+  NotificationConfig,
+  PaymentConfig,
+  QueueConfig,
+  SearchEngineConfig,
+  SecurityConfig,
+  ServicesConfig,
+  StacksConfig,
+  StorageConfig,
+  UiConfig,
+} from '@stacksjs/types'
 import { config } from '.'
 
-export type LocalUrlType = 'frontend' | 'backend' | 'api' | 'admin' | 'library' | 'email' | 'docs' | 'inspect' | 'desktop'
+export type LocalUrlType =
+  | 'frontend'
+  | 'backend'
+  | 'api'
+  | 'admin'
+  | 'library'
+  | 'email'
+  | 'docs'
+  | 'inspect'
+  | 'desktop'
 
 export async function localUrl({
   domain = config.app.url || 'stacks',
@@ -18,130 +52,101 @@ export async function localUrl({
 
   switch (type) {
     case 'frontend':
-      if (network)
-        return await createLocalTunnel(config.ports?.frontend || 3000)
+      if (network) return await createLocalTunnel(config.ports?.frontend || 3000)
 
-      if (localhost)
-        return `http://localhost:${config.ports?.frontend}`
+      if (localhost) return `http://localhost:${config.ports?.frontend}`
 
       url = domain.replace(/\.[^\.]+$/, '.localhost')
 
-      if (https)
-        return `https://${url}`
+      if (https) return `https://${url}`
 
       return url
     case 'backend':
-      if (network)
-        return await createLocalTunnel(config.ports?.backend || 3001)
+      if (network) return await createLocalTunnel(config.ports?.backend || 3001)
 
-      if (localhost)
-        return `http://localhost:${config.ports?.backend}`
+      if (localhost) return `http://localhost:${config.ports?.backend}`
 
       url = domain.replace(/\.[^\.]+$/, '.localhost/api/')
 
-      if (https)
-        return `https://${url}`
+      if (https) return `https://${url}`
 
       return url
     case 'api':
-      if (network)
-        return await createLocalTunnel(config.ports?.backend || 3001)
+      if (network) return await createLocalTunnel(config.ports?.backend || 3001)
 
-      if (localhost)
-        return `http://localhost:${config.ports?.backend}`
+      if (localhost) return `http://localhost:${config.ports?.backend}`
 
       url = domain.replace(/\.[^\.]+$/, '.localhost/api/')
 
-      if (https)
-        return `https://${url}`
+      if (https) return `https://${url}`
 
       return url
     case 'admin':
-      if (network)
-        return await createLocalTunnel(config.ports?.admin || 3002)
+      if (network) return await createLocalTunnel(config.ports?.admin || 3002)
 
-      if (localhost)
-        return `http://localhost:${config.ports?.admin}`
+      if (localhost) return `http://localhost:${config.ports?.admin}`
 
       url = domain.replace(/\.[^\.]+$/, '.localhost/admin/')
 
-      if (https)
-        return `https://${url}`
+      if (https) return `https://${url}`
 
       return url
     case 'library':
-      if (network)
-        return await createLocalTunnel(config.ports?.library || 3003)
+      if (network) return await createLocalTunnel(config.ports?.library || 3003)
 
-      if (localhost)
-        return `http://localhost:${config.ports?.library}`
+      if (localhost) return `http://localhost:${config.ports?.library}`
 
       url = domain.replace(/\.[^\.]+$/, '.localhost/libs/')
 
-      if (https)
-        return `https://${url}`
+      if (https) return `https://${url}`
 
       return url
     case 'email':
-      if (network)
-        return await createLocalTunnel(config.ports?.email || 3005)
+      if (network) return await createLocalTunnel(config.ports?.email || 3005)
 
-      if (localhost)
-        return `http://localhost:${config.ports?.email}`
+      if (localhost) return `http://localhost:${config.ports?.email}`
 
       url = domain.replace(/\.[^\.]+$/, '.localhost/email/')
 
-      if (https)
-        return `https://${url}`
+      if (https) return `https://${url}`
 
       return url
     case 'desktop':
-      if (network)
-        return await createLocalTunnel(config.ports?.desktop || 3004)
+      if (network) return await createLocalTunnel(config.ports?.desktop || 3004)
 
-      if (localhost)
-        return `http://localhost:${config.ports?.email}`
+      if (localhost) return `http://localhost:${config.ports?.email}`
 
       url = domain.replace(/\.[^\.]+$/, '.localhost/email/')
 
-      if (https)
-        return `https://${url}`
+      if (https) return `https://${url}`
 
       return url
     case 'docs':
-      if (network)
-        return await createLocalTunnel(config.ports?.desktop || 3006)
+      if (network) return await createLocalTunnel(config.ports?.desktop || 3006)
 
-      if (localhost)
-        return `http://localhost:${config.ports?.docs}`
+      if (localhost) return `http://localhost:${config.ports?.docs}`
 
       url = domain.replace(/\.[^\.]+$/, '.localhost/docs/')
 
-      if (https)
-        return `https://${url}`
+      if (https) return `https://${url}`
 
       return url
     case 'inspect':
-      if (network)
-        return await createLocalTunnel(config.ports?.desktop || 3007)
+      if (network) return await createLocalTunnel(config.ports?.desktop || 3007)
 
-      if (localhost)
-        return `http://localhost:${config.ports?.inspect}`
+      if (localhost) return `http://localhost:${config.ports?.inspect}`
 
       url = domain.replace(/\.[^\.]+$/, '.localhost/__inspect/')
 
-      if (https)
-        return `https://${url}`
+      if (https) return `https://${url}`
 
       return url
     default:
-      if (localhost)
-        return `http://localhost:${config.ports?.frontend}`
+      if (localhost) return `http://localhost:${config.ports?.frontend}`
 
       url = domain.replace(/\.[^\.]+$/, '.localhost')
 
-      if (https)
-        return `https://${url}`
+      if (https) return `https://${url}`
 
       return url
   }
@@ -235,7 +240,7 @@ export function defineServices(config: ServicesConfig) {
   return config
 }
 
-export function defineSms(config: SmsConfig) {
+export function defineSms(config: any) {
   return config
 }
 

package/src/overrides.ts

@@ -1,5 +1,6 @@
 import type { StacksConfig } from '@stacksjs/types'
 import ai from '~/config/ai'
+import analytics from '~/config/analytics'
 import app from '~/config/app'
 import cache from '~/config/cache'
 import cli from '~/config/cli'
@@ -8,24 +9,26 @@ import database from '~/config/database'
 import dns from '~/config/dns'
 import docs from '~/config/docs'
 import email from '~/config/email'
+import errors from '~/config/errors'
 import git from '~/config/git'
 import hashing from '~/config/hashing'
 import library from '~/config/library'
 import logger from '~/config/logger'
-import queue from '~/config/queue'
+import notification from '~/config/notification'
 import payment from '~/config/payment'
 import ports from '~/config/ports'
-import notification from '~/config/notification'
-import storage from '~/config/storage'
+import queue from '~/config/queue'
 import searchEngine from '~/config/search-engine'
 import security from '~/config/security'
 import services from '~/config/services'
+import storage from '~/config/storage'
 import team from '~/config/team'
 import ui from '~/config/ui'
 
 // this "user config" will override the default config options
 export default {
   ai,
+  analytics,
   app,
   cache,
   cli,
@@ -34,6 +37,7 @@ export default {
   dns,
   docs,
   email,
+  errors,
   git,
   hashing,
   library,

package/dist/config.d.ts

@@ -1,7 +0,0 @@
-import type { StacksOptions } from '@stacksjs/types';
-import defaults from './defaults';
-import overrides from './overrides';
-export declare const config: StacksOptions;
-export declare const ai: StacksOptions, analytics: StacksOptions, app: StacksOptions, cache: StacksOptions, cloud: StacksOptions, cli: StacksOptions, database: StacksOptions, dns: StacksOptions, docs: StacksOptions, email: StacksOptions, git: StacksOptions, hashing: StacksOptions, library: StacksOptions, logger: StacksOptions, notification: StacksOptions, payment: StacksOptions, ports: StacksOptions, queue: StacksOptions, security: StacksOptions, searchEngine: StacksOptions, services: StacksOptions, storage: StacksOptions, team: StacksOptions, ui: StacksOptions;
-export { defaults, overrides };
-export * from './helpers';

package/dist/defaults.d.ts

@@ -1,2 +0,0 @@
-declare const _default: StacksOptions;
-export default _default;