chore: wip

chrisbbreuer · chrisbbreuer · commit e6461e9d8ffb · 2024-02-13T18:41:42.000-08:00
diff --git a/.github/workflows/deploy-dev.yml b/.github/workflows/deploy-dev.yml
@@ -0,0 +1,29 @@
+name: Deployment (Dev)
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  deployment:
+    runs-on: ubuntu-latest
+    environment: development
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v1
+
+      - name: Use cached node_modules
+        uses: actions/cache@v4
+        with:
+          path: node_modules
+          key: node-modules-${{ hashFiles('**/bun.lockb') }}
+          restore-keys: |
+            node-modules-
+
+      - name: Install Dependencies
+        run: bun install
+
diff --git a/.github/workflows/deploy-prod.yml b/.github/workflows/deploy-prod.yml
@@ -0,0 +1,29 @@
+name: Deployment (Prod)
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deployment:
+    runs-on: ubuntu-latest
+    environment: production
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v1
+
+      - name: Use cached node_modules
+        uses: actions/cache@v4
+        with:
+          path: node_modules
+          key: node-modules-${{ hashFiles('**/bun.lockb') }}
+          restore-keys: |
+            node-modules-
+
+      - name: Install Dependencies
+        run: bun install
+
diff --git a/.github/workflows/deploy-stage.yml b/.github/workflows/deploy-stage.yml
@@ -0,0 +1,29 @@
+name: Deployment (Stage)
+
+on:
+  push:
+    tags:
+      - '*-beta.*'
+
+jobs:
+  deployment:
+    runs-on: ubuntu-latest
+    environment: staging
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v1
+
+      - name: Use cached node_modules
+        uses: actions/cache@v4
+        with:
+          path: node_modules
+          key: node-modules-${{ hashFiles('**/bun.lockb') }}
+          restore-keys: |
+            node-modules-
+
+      - name: Install Dependencies
+        run: bun install
+
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,18 @@
 # Stacks Changelog
 
+## v0.58.65...v0.58.65-3-gd47ed35f9
+
+[compare changes](https://github.com/stacksjs/stacks/compare/v0.58.65...v0.58.65-3-gd47ed35f9)
+
+### 🏡 Chore
+
+- Wip ([80078006f](https://github.com/stacksjs/stacks/commit/80078006f))
+- Wip ([d47ed35f9](https://github.com/stacksjs/stacks/commit/d47ed35f9))
+
+### ❤️ Contributors
+
+- Chris <chrisbreuer93@gmail.com>
+
 ## v0.58.64...v0.58.64-3-g940445637
 
 [compare changes](https://github.com/stacksjs/stacks/compare/v0.58.64...v0.58.64-3-g940445637)
diff --git a/app/Actions/BuddyAction.ts b/app/Actions/BuddyAction.ts
@@ -3,6 +3,7 @@ import { Action } from '@stacksjs/actions'
 export default new Action({
   name: 'Buddy Info',
   description: 'This command displays the buddy info.',
+  path: 'buddy', // turns into `APP_URL/api/buddy`
 
   handle() {
     return {
diff --git a/app/Actions/LogAction.ts b/app/Actions/LogAction.ts
@@ -0,0 +1,27 @@
+import { Action } from '@stacksjs/actions'
+import { validator } from '@stacksjs/validation'
+import { log } from '@stacksjs/logging'
+
+export default new Action({
+  name: 'Dummy Logger',
+  description: 'This action is used to demo how to POST to a server and upon success, log a message.',
+
+  fields: {
+    message: {
+      rule: validator.string().minLength(3).maxLength(255),
+      message: 'The message must be between 3 and 255 characters long.',
+    },
+
+    level: {
+      rule: validator.enum(['info', 'warn', 'error']),
+      message: 'The log level must be one of "info", "warn", or "error".',
+    },
+  },
+
+  // handle(request: { message: string, level: 'info' | 'warn' | 'error' }) {
+  handle(request: Request) {
+    log[request.level](request.message)
+
+    return `Logged "${request.message}" at "${request.level}" level`
+  },
+})
diff --git a/app/Middleware/Api.ts b/app/Middleware/Api.ts
@@ -0,0 +1,10 @@
+import { log } from '@stacksjs/cli'
+import { Middleware } from '@stacksjs/router'
+
+export default new Middleware({
+  name: 'API Authentication',
+  priority: 1,
+  handle() {
+    log.info('API Authentication middleware')
+  },
+})
diff --git a/app/Middleware/Logger.ts b/app/Middleware/Logger.ts
@@ -2,9 +2,9 @@ import { log } from '@stacksjs/cli'
 import { Middleware } from '@stacksjs/router'
 
 export default new Middleware({
-  name: 'logger',
-  priority: 1,
+  name: 'Logger',
+  priority: 2,
   handle() {
-    log.info('logger middleware')
+    log.info('Logger middleware')
   },
 })
diff --git a/bun.lockb b/bun.lockb
diff --git a/routes/api.ts b/routes/api.ts
@@ -7,16 +7,13 @@ route.get('/api/welcome', () => 'hello world 3') // stacksjs.org/api/welcome
 route.get('/api/welcome/', () => 'hello world 4') // stacksjs.org/api/welcome/
 
 route.health() // /api/health
+// route.action('BuddyAction') // /api/buddy
+// route.get('/api/buddy', 'BuddyAction') // /api/buddy
 // route.job('/api/example') // the equivalent of route.get('/api/example', 'ExampleJob')
-// route.action('/api/buddy') // the equivalent of route.get('/api/buddy', 'BuddyAction')
 // route.get('/api/buddy-2', '../app/Actions/BuddyAction') // todo: support this
 // route.get('/api/buddy-3', import('../app/Actions/BuddyAction')) // todo: support this
 
 // route.group({ prefix: '/users' }, () => {
-//   route.before(async (params) => {
-//     console.log(`[${now()}] ${params.method} ${params.url}`)
-//   })
-
 //   route.get('/:id', ({ id }) => {
 //     // Retrieve user from database
 //     return `User with ID ${id}`
diff --git a/storage/framework/core/actions/package.json b/storage/framework/core/actions/package.json
@@ -64,6 +64,7 @@
     "@stacksjs/storage": "workspace:*",
     "@stacksjs/types": "workspace:*",
     "@stacksjs/utils": "workspace:*",
+    "@stacksjs/validation": "workspace:*",
     "markdown-it": "^14.0.0",
     "vue-component-meta": "^1.8.27"
   },
@@ -81,6 +82,7 @@
     "@stacksjs/storage": "workspace:*",
     "@stacksjs/strings": "workspace:*",
     "@stacksjs/utils": "workspace:*",
+    "@stacksjs/validation": "workspace:*",
     "markdown-it": "^14.0.0",
     "vue-component-meta": "^1.8.27"
   },
diff --git a/storage/framework/core/actions/src/action.ts b/storage/framework/core/actions/src/action.ts
@@ -1,29 +1,48 @@
-import type { JobOptions } from '@stacksjs/types'
+import type { JobOptions, Nullable } from '@stacksjs/types'
+import type { ValidationBoolean, ValidationNumber, ValidationString } from '@stacksjs/validation'
+
+type FieldKey = string
+interface FieldValue {
+  rule: ValidationString | ValidationNumber | ValidationBoolean | Date | Nullable<any>
+  message: string
+  factory?: any
+  unique?: boolean
+}
+
+// TODO: this is temporary and will get auto generated based on ./app/Actions/*
+interface Request {
+  message: string
+  level: 'info' | 'warn' | 'error'
+}
 
 interface ActionOptions {
   name?: string
   description?: string
-  handle: () => Promise<any> | any
+  fields?: Record<FieldKey, FieldValue>
+  path?: string
   rate?: JobOptions['rate']
   tries?: JobOptions['tries']
   backoff?: JobOptions['backoff']
   enabled?: JobOptions['enabled']
+  handle: (request?: Request) => Promise<any> | string
 }
 
 export class Action {
   name?: string
   description?: string
+  fields?: Record<FieldKey, FieldValue>
   rate?: JobOptions['rate']
   tries?: JobOptions['tries']
   backoff?: JobOptions['backoff']
   enabled?: boolean
-  handle: () => Promise<any>
+  handle: (request?: Request) => Promise<any> | string
 
-  constructor({ name, description, handle, rate, tries, backoff, enabled }: ActionOptions) {
-    // log.debug(`Action ${name} created`) // TODO
+  constructor({ name, description, fields, handle, rate, tries, backoff, enabled }: ActionOptions) {
+    // log.debug(`Action ${name} created`) // TODO: this does not yet work because the cloud does not yet have proper file system (efs) access
 
     this.name = name
     this.description = description
+    this.fields = fields
     this.rate = rate
     this.tries = tries
     this.backoff = backoff
diff --git a/storage/framework/core/actions/src/generate/action-types.ts b/storage/framework/core/actions/src/generate/action-types.ts
@@ -0,0 +1,89 @@
+import { path as p } from '@stacksjs/path'
+import { storage } from '@stacksjs/storage'
+import { env as e, enums } from '@stacksjs/env'
+import { logger } from '@stacksjs/logging'
+import { envKeys } from '../../../../env'
+
+log.debug('Generating type Action types...')
+
+// generate ./storage/framework/types/env.d.ts file from .env
+const envTypes = `
+// This file is auto-generated by Stacks. Do not edit this file manually.
+// If you want to edit Action types, please edit the app/Actions/* validations
+//
+// For more information, please visit: https://stacksjs.org/docs
+
+declare module 'bun' {
+  namespace env {
+    ${envKeys.map((key) => {
+      let type: string | undefined = typeof e[key]
+      let value: string | boolean | number | undefined = e[key]
+
+      if (!value) {
+        if (enums[key]) {
+          type = enums[key]?.map(item => `'${item}'`).join(' | ')
+          value = enums[key]?.[0] // default to the first enum value
+        }
+ else {
+          switch (type) {
+            case 'number':
+              value = '0'
+              break
+            case 'boolean':
+              value = false
+              break
+            default:
+              value = ''
+          }
+        }
+      }
+
+      type = 'string'
+      if (typeof value === 'string') {
+        if (value.toLowerCase() === 'true' || value.toLowerCase() === 'false') {
+          type = 'boolean'
+        }
+        else if (!Number.isNaN(Number.parseFloat(value)) && Number.isFinite(Number(value))) {
+          type = 'number'
+        }
+        else if (enums[key]) {
+          // @ts-expect-error enums[key] is defined
+          type = enums[key].map(item => `'${item}'`).join(' | ')
+        }
+      }
+
+      else if (typeof value === 'number') {
+        type = 'number'
+      }
+
+      else if (typeof value === 'boolean') {
+        type = 'boolean'
+      }
+
+      return `const ${key}: ${type}`
+    }).join('\n    ')}
+  }
+}
+`
+
+await storage.writeFile(p.frameworkPath('types/env.d.ts'), envTypes)
+
+logger.log('  - ./storage/framework/env.ts')
+
+// generate ./storage/framework/env.ts file based on Bun.env
+const env = `
+// This file is auto-generated by Stacks. Do not edit this file manually.
+// If you want to change the environment variables, please edit the .env file.
+//
+// For more information, please visit: https://stacksjs.org/docs
+
+export const envKeys = [
+  ${envKeys.map(key => `'${key}'`).join(',\n  ')}
+] as const
+
+export type EnvKey = typeof envKeys[number]
+`
+
+await storage.writeFile(p.frameworkPath('env.ts'), env)
+
+logger.log('  - ./storage/framework/env.d.ts')
diff --git a/storage/framework/core/types/src/index.ts b/storage/framework/core/types/src/index.ts
@@ -42,6 +42,7 @@ export * from './pwa'
 export * from './push'
 export * from './queue'
 export * from './reactivity'
+export * from './request'
 export * from './router'
 export * from './scheduler'
 export * from './search-engine'
diff --git a/storage/framework/core/types/src/request.ts b/storage/framework/core/types/src/request.ts
@@ -0,0 +1,3 @@
+export interface Request {
+  [key: string]: any
+}
diff --git a/storage/framework/core/validation/build.ts b/storage/framework/core/validation/build.ts
@@ -1,5 +1,5 @@
 import { runCommand } from '@stacksjs/cli'
 
-await runCommand('bun build ./src/index.ts --outdir dist --format esm --external @vinejs/vine --external @stacksjs/vite --external @stacksjs/strings --external @stacksjs/types --external @dinero.js/currencies --external dinero.js --target bun', {
+await runCommand('bun build ./src/index.ts --outdir dist --format esm --external @vinejs/vine --external @stacksjs/vite --external @stacksjs/strings --external @stacksjs/types --external @stacksjs/validation --external @dinero.js/currencies --external dinero.js --target bun', {
   cwd: import.meta.dir,
 })
