@stacksjs/config 0.66.0 → 0.68.0

package/src/defaults.ts

@@ -1,618 +0,0 @@
-import type { StacksOptions } from '@stacksjs/types'
-import { commandsPath, userDatabasePath } from '@stacksjs/path'
-
-// import { userConfig as overrides } from './overrides'
-
-const config: StacksOptions = {
-  ai: {
-    deploy: false,
-    models: [
-      'amazon.titan-embed-text-v1',
-      'amazon.titan-text-express-v1',
-      'amazon.titan-embed-image-v1',
-      'amazon.titan-image-generator-v1',
-      'anthropic.claude-v1',
-      'anthropic.claude-v2',
-      'anthropic.claude-v2:1',
-      'anthropic.claude-instant-v1',
-      'meta.llama2-13b-chat-v1',
-      'meta.llama2-70b-chat-v1',
-    ],
-  },
-
-  analytics: {
-    driver: undefined,
-  },
-
-  // api: {
-  //   // version: 'v1',
-  //   prefix: 'api',
-  //   middleware: ['Api'],
-  //   routes: {
-  //     index: true,
-  //     show: true,
-  //     store: true,
-  //     update: true,
-  //     destroy: true,
-  //   },
-  // },
-
-  app: {
-    name: 'Stacks',
-    description: 'A Stacks application.',
-    env: 'local',
-    url: 'stacks.localhost',
-    debug: true,
-    key: '',
-    timezone: 'UTC',
-    locale: 'en',
-    fallbackLocale: 'en',
-    cipher: 'AES-256-CBC',
-    docMode: false,
-    redirectUrls: [],
-    maintenanceMode: false,
-  },
-
-  cli: {
-    name: 'My Custom CLI',
-    command: 'my-custom-cli',
-    description: 'Stacks is a full-stack framework for TypeScript.',
-    source: commandsPath(),
-    deploy: false,
-  },
-
-  cache: {
-    driver: 'redis',
-    prefix: 'stx',
-    ttl: 3600,
-
-    drivers: {
-      redis: {
-        connection: 'default',
-        host: 'localhost',
-        port: 6379,
-        username: '',
-        password: '',
-      },
-    },
-  },
-
-  cloud: {
-    type: 'serverless',
-
-    driver: 'aws',
-
-    storage: {},
-
-    environments: ['production', 'staging', 'development'],
-
-    firewall: {
-      enabled: true,
-      countryCodes: [],
-      ipAddresses: [],
-      queryString: [],
-      httpHeaders: [],
-      // ipSets: [],
-      rateLimitPerMinute: 1000,
-      useIpReputationLists: true,
-      useKnownBadInputsRuleSet: true,
-    },
-
-    cdn: {
-      allowedMethods: 'GET_HEAD',
-      cachedMethods: 'GET_HEAD',
-      minTtl: 0,
-      defaultTtl: 86400,
-      maxTtl: 31536000,
-      compress: true,
-      priceClass: 'PriceClass_All',
-      originShieldRegion: 'us-east-1',
-      cookieBehavior: 'none',
-      allowList: {
-        cookies: [],
-        headers: [],
-        queryStrings: [],
-      },
-      realtimeLogs: {
-        enabled: true,
-        samplingRate: 2,
-      },
-    },
-
-    fileSystem: false,
-  },
-
-  database: {
-    default: 'sqlite',
-
-    connections: {
-      sqlite: {
-        database: userDatabasePath('stacks.sqlite'),
-        prefix: '',
-      },
-    },
-
-    migrations: 'migrations',
-    migrationLocks: 'migration_locks',
-  },
-
-  dns: {
-    driver: 'aws',
-    a: [],
-    aaaa: [],
-    cname: [],
-    mx: [],
-    txt: [],
-  },
-
-  docs: {
-    lang: 'en-US',
-    title: 'Stacks',
-    description: 'Rapid application, cloud & library framework.',
-    lastUpdated: true,
-    deploy: false,
-
-    themeConfig: {
-      editLink: {
-        pattern: 'https://github.com/stacksjs/stacks/edit/main/docs/docs/:path',
-        text: 'Edit this page on GitHub',
-      },
-
-      footer: {
-        message: 'Released under the MIT License.',
-        copyright: 'Copyright © 2024-present Stacks.js, Inc.',
-      },
-
-      // algolia: services.algolia,
-
-      // carbonAds: {
-      //   code: '',
-      //   placement: '',
-      // },
-    },
-  },
-
-  email: {
-    from: {
-      name: 'Stacks',
-      address: 'no-reply@stacksjs.org',
-    },
-
-    mailboxes: [],
-
-    server: {
-      scan: true,
-    },
-  },
-
-  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',
-    },
-
-    scopes: [
-      '',
-      'ci',
-      'deps',
-      'dx',
-      'release',
-      'docs',
-      'test',
-      'core',
-      'actions',
-      'arrays',
-      'auth',
-      'build',
-      'cache',
-      'cli',
-      'cloud',
-      'collections',
-      'config',
-      'database',
-      'datetime',
-      'docs',
-      'errors',
-      'git',
-      'lint',
-      'x-ray',
-      'modules',
-      'notifications',
-      'objects',
-      'path',
-      'realtime',
-      'router',
-      'buddy',
-      'security',
-      'server',
-      'storage',
-      'strings',
-      'tests',
-      'types',
-      'ui',
-      'utils',
-    ],
-
-    messages: {
-      type: 'Select the type of change that you’re committing:',
-      scope: 'Select the SCOPE of this change (optional):',
-      customScope: 'Select the SCOPE of this change:',
-      subject: 'Write a SHORT, IMPERATIVE tense description of the change:\n',
-      body: 'Provide a LONGER description of the change (optional). Use "|" to break new line:\n',
-      breaking: 'List any BREAKING CHANGES (optional). Use "|" to break new line:\n',
-      footerPrefixesSelect: 'Select the ISSUES type of the change list by this change (optional):',
-      customFooterPrefixes: 'Input ISSUES prefix:',
-      footer: 'List any ISSUES by this change. E.g.: #31, #34:\n',
-      confirmCommit: 'Are you sure you want to proceed with the commit above?',
-    },
-
-    types: [
-      {
-        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:',
-      },
-    ],
-  },
-
-  hashing: {
-    driver: 'argon2',
-
-    bcrypt: {
-      rounds: 10,
-      cost: 4, // number between 4-31
-    },
-
-    argon2: {
-      memory: 65536, // memory usage in kibibytes
-      // threads: 1,
-      time: 1, // the number of iterations
-    },
-  },
-
-  library: {
-    name: 'hello-world',
-    owner: '@stacksjs', // you may or may not add the @ prefix here (it is added automatically)
-    repository: 'stacksjs/stacks',
-    license: 'MIT',
-    author: 'Chris Breuer',
-    contributors: ['Chris Breuer <chris@stacksjs.org>'],
-    defaultLanguage: 'en',
-
-    vueComponents: {
-      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.',
-            },
-          ],
-        },
-      ],
-    },
-
-    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.',
-            },
-          ],
-        },
-      ],
-    },
-
-    functions: {
-      name: 'hello-world-fx',
-      description: 'Your function library description.',
-      keywords: ['functions', 'composables', 'library', 'typescript', 'javascript'],
-      shouldGenerateSourcemap: false,
-      files: ['counter', 'dark'],
-    },
-  },
-
-  logging: {
-    logsPath: 'storage/logs/stacks.log',
-    deploymentsPath: 'storage/logs/deployments.log',
-  },
-
-  notification: {
-    default: 'email',
-  },
-
-  payment: {
-    driver: 'stripe',
-  },
-
-  ports: {
-    frontend: 3000,
-    backend: 3001,
-    admin: 3002,
-    library: 3003,
-    desktop: 3004,
-    email: 3005,
-    docs: 3006,
-    inspect: 3007,
-    api: 3008,
-    systemTray: 3009,
-    database: 3010,
-    // mobile: 3010,
-  },
-
-  queue: {
-    default: 'sync',
-
-    connections: {
-      sync: {
-        driver: 'sync',
-      },
-
-      database: {
-        driver: 'database',
-        table: 'jobs',
-        queue: 'default',
-        retry_after: 90,
-      },
-
-      redis: {
-        driver: 'redis',
-        connection: 'default',
-        queue: 'default',
-        retry_after: 90,
-      },
-
-      sqs: {
-        driver: 'sqs',
-        key: '',
-        secret: '',
-        prefix: '',
-        suffix: '',
-        queue: 'default',
-        region: 'us-east-1',
-      },
-    },
-  },
-
-  searchEngine: {
-    driver: 'opensearch',
-  },
-
-  security: {
-    firewall: {
-      enabled: true,
-      countryCodes: [],
-      ipAddresses: [],
-      queryString: [],
-      httpHeaders: [],
-      // ipSets: [],
-      rateLimitPerMinute: 1000,
-      useIpReputationLists: true,
-      useKnownBadInputsRuleSet: true,
-    },
-  },
-
-  services: {
-    aws: {
-      accountId: '',
-      appId: '',
-      apiKey: '',
-      region: 'us-east-1',
-    },
-
-    algolia: {
-      appId: '',
-      apiKey: '',
-    },
-
-    meilisearch: {
-      appId: '',
-      apiKey: '',
-    },
-
-    stripe: {
-      appId: '',
-      apiKey: '',
-    },
-  },
-
-  storage: {
-    driver: 's3',
-  },
-
-  team: {
-    name: 'Stacks',
-    members: {
-      'Chris Breuer': 'chris@stacksjs.org',
-    },
-  },
-
-  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',
-      ],
-    ],
-
-    safelist: 'prose prose-sm m-auto text-left',
-
-    trigger: ':stx:',
-    classPrefix: 'stx-',
-    reset: 'tailwind',
-
-    icons: ['heroicons'],
-
-    fonts: {
-      email: {
-        title: 'Mona',
-        text: 'Hubot',
-      },
-
-      desktop: {
-        title: 'Mona',
-        text: 'Hubot',
-      },
-
-      mobile: {
-        title: 'Mona',
-        text: 'Hubot',
-      },
-
-      web: {
-        title: 'Mona',
-        text: 'Hubot',
-      },
-    },
-  },
-}
-
-export default config