chore: wip

chrisbbreuer · chrisbbreuer · commit bf5dda6e32c9 · 2023-09-03T16:11:21.000-07:00
diff --git a/.stacks/core/config/src/defaults.ts b/.stacks/core/config/src/defaults.ts
@@ -2,6 +2,44 @@ import type { StacksConfig } from '@stacksjs/types'
 import { path as p } from '@stacksjs/path'
 // import { userConfig as overrides } from './overrides'
 
+const nav = [
+  { text: 'Config', link: '/config', activeMatch: '/config' },
+  {
+    text: 'Changelog',
+    link: 'https://github.com/stacksjs/stacks/blob/main/CHANGELOG.md',
+  },
+  { text: 'Blog', link: 'https://updates.ow3.org' },
+]
+
+const sidebar = {
+  '/guide/': [
+    {
+      text: 'Introduction',
+      collapsible: true,
+      items: [
+        { text: 'What is Stacks?', link: '/guide/what-is-stacks' },
+        { text: 'Getting Started', link: '/guide/getting-started' },
+        { text: 'Configuration', link: '/guide/config' },
+      ],
+    },
+
+    {
+      text: 'Digging Deeper',
+      collapsible: true,
+      items: [
+        { text: 'APIs', link: '/guide/apis' },
+        { text: 'Apps', link: '/guide/apps' },
+        { text: 'Buddy', link: '/guide/buddy' },
+        { text: 'CI / CD', link: '/guide/ci' },
+        { text: 'Composability', link: '/guide/composability' },
+        { text: 'Cloud', link: '/guide/cloud' },
+        { text: 'Libraries', link: '/guide/libraries' },
+        { text: 'Testing', link: '/guide/testing' },
+      ],
+    },
+  ],
+}
+
 export const defaults: StacksConfig = {
   app: {
     name: 'Stacks',
@@ -118,11 +156,168 @@ export const defaults: StacksConfig = {
     txt: [],
   },
 
-  docs: {},
+  docs: {
+    lang: 'en-US',
+    title: 'Stacks',
+    description: 'Rapid application, cloud & library framework.',
+    lastUpdated: true,
+
+    themeConfig: {
+      nav,
+      sidebar,
+
+      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 © 2023-present Stacks',
+      },
+
+      // socialLinks: [
+      //   { icon: 'twitter', link: 'https://twitter.com/stacksjs' },
+      //   { icon: 'github', link: 'https://github.com/stacksjs/stacks' },
+      //   { icon: 'discord', link: 'https://discord.gg/stacksjs' },
+      // ],
+
+      // algolia: services.algolia,
+
+      // carbonAds: {
+      //   code: '',
+      //   placement: '',
+      // },
+    },
+  },
 
   email: {
-    
+    from: {
+      name: 'Stacks',
+      address: 'no-reply@stacksjs.com',
+    },
+
+    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.com>'],
+    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',
+  },
+
+  // wip
+  payment: {},
+
+  queue: {},
+  searchEngine: {},
+  security: {},
+  services: {},
+  storage: {},
+  ui: {},
 }
 
 // export {
diff --git a/.stacks/core/types/src/hashing.ts b/.stacks/core/types/src/hashing.ts
@@ -21,7 +21,7 @@ export interface HashingOptions {
    *
    * @see https://stacksjs.dev/docs/hashing
    */
-  driver: 'argon' | 'bcrypt'
+  driver: 'argon2' | 'argon2id' | 'argon2i' | 'argon2d' | 'bcrypt'
 
   /**
    * **Bcrypt Option**
@@ -43,7 +43,7 @@ export interface HashingOptions {
    *
    * @see https://stacksjs.dev/docs/hashing
    */
-  argon?: ArgonOptions
+  argon2?: ArgonOptions
 }
 
 export type HashingConfig = Partial<HashingOptions>
@@ -64,7 +64,14 @@ export interface BcryptOptions {
    * @default number 10
    * @see https://stacksjs.dev/docs/hashing
    */
-  rounds?: number
+  rounds: number
+
+  /**
+   * Bcrypt cost. This is a number between 4-31.
+   * @default number 4
+   * @see https://stacksjs.dev/docs/hashing
+   */
+  cost: number
 }
 
 /**
diff --git a/config/cloud.ts b/config/cloud.ts
@@ -14,5 +14,21 @@ export default {
   storage: {
     useFileSystem: true,
   },
-  // cdn: {}
+  cdn: {
+    enableLogging: true,
+    compress: true,
+    allowedMethods: 'ALL',
+    cachedMethods: 'GET_HEAD',
+    originShieldRegion: 'us-east-1',
+    minTtl: 0,
+    defaultTtl: 86400,
+    maxTtl: 31536000,
+    priceClass: 'PriceClass_All',
+    cookieBehavior: 'none',
+    allowList: {
+      cookies: [],
+      headers: [],
+      queryStrings: [],
+    },
+  },
 } satisfies CloudConfig
diff --git a/config/hashing.ts b/config/hashing.ts
@@ -8,15 +8,16 @@ import type { HashingConfig } from '@stacksjs/types'
  * have any questions, feel free to reach out via Discord or GitHub Discussions.
  */
 export default {
-  driver: 'bcrypt',
+  driver: 'argon2',
 
   bcrypt: {
     rounds: 10,
+    cost: 4, // number between 4-31
   },
 
-  argon: {
-    memory: 65536,
+  argon2: {
+    memory: 65536, // memory usage in kibibytes
     threads: 1,
-    time: 1,
+    time: 1, // the number of iterations
   },
 } satisfies HashingConfig
