@stacksjs/config 0.50.0 → 0.58.28

package/README.md

@@ -1,38 +1,47 @@
-# Stacks Config
+# Stacks Objects
 
-This package simplifies accessing your Stacks configuration.
+Easily work with objects.
 
 ## ☘️ Features
 
-- ⚡️ API to access your Stacks config
+- Access to Laravel-like Collections API
+- Other object helpers
 
 ## 🤖 Usage
 
 ```bash
-pnpm i -D @stacksjs/config
+bun install -d @stacksjs/objects
 ```
 
-Now, you can use it in your project:
+Now, you can easily access it in your project:
 
-```ts
-import { app, deploy, docs, git, hashing, library, services, ui } from '@stacksjs/config'
+```js
+import { collect } from '@stacksjs/objects'
 
-console.log(app) // { name: 'Your App Name', env: 'local', url: 'https://localhost', ... }
+const collection = collect([{
+  name: 'My story',
+  pages: 176,
+}, {
+  name: 'Fantastic Beasts and Where to Find Them',
+  pages: 1096,
+}])
+
+console.log(collection.avg('pages')) // 636
 ```
 
-Learn more in the docs.
+To view the full documentation, please visit [https://stacksjs.org/objects](https://stacksjs.org/objects).
 
 ## 🧪 Testing
 
 ```bash
-pnpm test
+bun test
 ```
 
 ## 📈 Changelog
 
 Please see our [releases](https://github.com/stacksjs/stacks/releases) page for more information on what has changed recently.
 
-## 💪🏼 Contributing
+## 🚜 Contributing
 
 Please review the [Contributing Guide](https://github.com/stacksjs/contributing) for details.
 
@@ -44,10 +53,19 @@ For help, discussion about best practices, or any other conversation that would
 
 For casual chit-chat with others using this package:
 
-[Join the Stacks Discord Server](https://discord.ow3.org)
+[Join the Stacks Discord Server](https://discord.gg/stacksjs)
+
+## 🙏🏼 Credits
+
+Many thanks to the following core technologies & people who have contributed to this package:
+
+- [Collect.js](https://github.com/ecrmnn/collect.js)
+- [Laravel](https://laravel.com/)
+- [Chris Breuer](https://github.com/chrisbbreuer)
+- [All Contributors](../../contributors)
 
 ## 📄 License
 
 The MIT License (MIT). Please see [LICENSE](https://github.com/stacksjs/stacks/tree/main/LICENSE.md) for more information.
 
-Made with ❤️
+Made with 💙

package/package.json

@@ -1,52 +1,54 @@
 {
   "name": "@stacksjs/config",
   "type": "module",
-  "version": "0.50.0",
-  "packageManager": "pnpm@7.25.1",
-  "description": "The Stacks configuration.",
+  "version": "0.58.28",
+  "description": "The Stacks config helper methods.",
   "author": "Chris Breuer",
   "license": "MIT",
   "funding": "https://github.com/sponsors/chrisbbreuer",
-  "homepage": "https://github.com/stacksjs/stacks/tree/main/.stacks/core/config#readme",
+  "homepage": "https://github.com/stacksjs/stacks/tree/main/storage/framework/core/config#readme",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/stacksjs/stacks.git",
-    "directory": "./.stacks/core/config"
+    "directory": "./storage/framework/core/config"
   },
   "bugs": {
     "url": "https://github.com/stacksjs/stacks/issues"
   },
   "keywords": [
-    "configuration",
+    "config",
+    "utilities",
+    "functions",
     "stacks"
   ],
-  "main": "dist/index.mjs",
-  "module": "dist/index.mjs",
-  "types": "dist/index.d.ts",
   "contributors": [
-    "Chris Breuer <chris@ow3.org>"
+    "Chris Breuer <chris@stacksjs.org>"
   ],
+  "exports": {
+    ".": {
+      "bun": "./src/index.ts",
+      "import": "./dist/index.js"
+    },
+    "./*": {
+      "bun": "./*"
+    }
+  },
   "files": [
-    "dist",
-    "README.md"
+    "README.md",
+    "src"
   ],
-  "engines": {
-    "node": ">=v18.13.0",
-    "pnpm": ">=7.25.1"
+  "scripts": {
+    "build": "bun --bun build.ts",
+    "typecheck": "bun --bun tsc --noEmit",
+    "prepublishOnly": "bun --bun run build"
   },
   "peerDependencies": {
-    "@stacksjs/path": "0.50.0",
-    "@stacksjs/utils": "0.50.0"
+    "@stacksjs/utils": "workspace:*",
+    "@stacksjs/validation": "workspace:*"
   },
   "devDependencies": {
-    "mkdist": "^1.1.0",
-    "typescript": "^4.9.4",
-    "unbuild": "^1.1.1",
-    "@stacksjs/testing": "0.50.0"
-  },
-  "scripts": {
-    "build": "unbuild",
-    "dev": "unbuild --stub",
-    "typecheck": "tsc --noEmit"
+    "@stacksjs/alias": "workspace:*",
+    "@stacksjs/development": "workspace:*",
+    "@stacksjs/types": "workspace:*"
   }
-}
+}

package/src/config.ts

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

package/src/defaults.ts

@@ -0,0 +1,460 @@
+import { path as p } from '@stacksjs/path'
+import type { StacksOptions } from '@stacksjs/types'
+
+// import { userConfig as overrides } from './overrides'
+
+export default {
+  ai: {
+    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: {
+    prefix: 'api',
+    description: 'Stacks API',
+    prewarm: true,
+    memorySize: 512,
+    timeout: 30,
+    // version: 'v1',
+  },
+
+  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,
+    ports: {
+      frontend: 3333,
+      backend: 3334,
+      admin: 3335,
+      library: 3336,
+      desktop: 3337,
+      email: 3338,
+      docs: 3339,
+      inspect: 3340,
+      api: 3999,
+    },
+  },
+
+  binary: {
+    name: 'buddy',
+    command: 'buddy',
+    description: 'Stacks is a full-stack framework for TypeScript.',
+    source: p.appPath('commands'),
+  },
+
+  cache: {
+    driver: 'redis',
+    prefix: 'stx',
+    ttl: 3600,
+
+    drivers: {
+      redis: {
+        connection: 'default',
+        host: 'localhost',
+        port: 6379,
+      },
+    },
+  },
+
+  cloud: {
+    driver: 'aws',
+
+    storage: {},
+
+    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: [],
+      },
+    },
+
+    ai: true,
+    docs: true,
+    api: true,
+    fileSystem: true,
+  },
+
+  database: {
+    default: 'sqlite',
+
+    name: 'stacks',
+
+    connections: {
+      sqlite: {
+        database: p.projectStoragePath('framework/database/stacks.sqlite'),
+        prefix: '',
+      },
+    },
+  },
+
+  dns: {
+    driver: 'aws',
+    a: [],
+    aaaa: [],
+    cname: [],
+    mx: [],
+    txt: [],
+  },
+
+  docs: {
+    lang: 'en-US',
+    title: 'Stacks',
+    description: 'Rapid application, cloud & library framework.',
+    lastUpdated: true,
+
+    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',
+    },
+
+    server: {
+      scan: true,
+      mailboxes: [],
+    },
+  },
+
+  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,
+      functions: [
+        'counter',
+        'dark',
+      ],
+    },
+  },
+
+  notification: {
+    default: 'email',
+  },
+
+  payment: {
+    driver: 'stripe',
+  },
+
+  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: 'meilisearch',
+  },
+
+  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: '',
+    },
+
+    planetscale: {
+      appId: '',
+      apiKey: '',
+    },
+
+    supabase: {
+      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',
+      },
+    },
+  },
+} satisfies StacksOptions