@stacksjs/actions 0.58.47 → 0.58.49

package/src/generate/caddyfile.ts

@@ -0,0 +1 @@
+// TODO: generate Caddyfile for the core app

package/src/generate/component-meta.ts

@@ -0,0 +1,19 @@
+#!/usr/bin/env bun
+
+/**
+ * This action generates the component meta.
+ */
+
+import { log } from '@stacksjs/logging'
+import { hasComponents } from '@stacksjs/storage'
+import { generateComponentMeta } from '../helpers/component-meta'
+
+log.info('Generating component meta...')
+
+if (hasComponents())
+  generateComponentMeta()
+
+else
+  log.info('No components found. Skipping component meta generation.')
+
+log.success('Generated component meta.')

package/src/generate/env-files.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'
+
+logger.log('Generating type env files...')
+
+// 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 change the environment variables, please edit the .env file.
+//
+// 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')

package/src/generate/ide-helpers.ts

@@ -0,0 +1,18 @@
+#!/usr/bin/env bun
+
+/**
+ * This action generates the web-types.json & custom-elements.json
+ * files for the components.
+ */
+
+import { log } from '@stacksjs/logging'
+import { hasComponents } from '@stacksjs/storage'
+import { generateVsCodeCustomData, generateWebTypes } from '../helpers/vscode-custom-data'
+
+if (hasComponents()) {
+  await generateWebTypes()
+  await generateVsCodeCustomData()
+}
+else {
+  log.info('No components found. Skipping IDE helper generation.')
+}

package/src/generate/index.ts

@@ -0,0 +1,132 @@
+import process from 'node:process'
+import { log } from '@stacksjs/logging'
+import { Action, NpmScript } from '@stacksjs/enums'
+import type { GeneratorOptions } from '@stacksjs/types'
+import { runNpmScript } from '@stacksjs/utils'
+import { frameworkPath, projectPath } from '@stacksjs/path'
+import { runAction } from '../helpers'
+
+// import { files } from '@stacksjs/storage'
+
+export async function invoke(options?: GeneratorOptions) {
+  if (options?.types)
+    await generateTypes(options)
+
+  else if (options?.entries)
+    await generateLibEntries(options)
+
+  else if (options?.webTypes)
+    await generateWebTypes(options)
+
+  else if (options?.customData)
+    await generateVsCodeCustomData(options)
+
+  else if (options?.ideHelpers)
+    await generateIdeHelpers(options)
+
+  else if (options?.componentMeta)
+    await generateComponentMeta(options)
+}
+
+export function generate(options: GeneratorOptions) {
+  return invoke(options)
+}
+
+export async function generateLibEntries(options: GeneratorOptions) {
+  const result = await runAction(Action.GenerateLibraryEntries, {
+    ...options,
+    cwd: projectPath(),
+  })
+
+  if (result.isErr()) {
+    log.error('There was an error generating your library entry points', result.error)
+    process.exit()
+  }
+
+  log.success('Library entry points generated successfully')
+}
+
+export async function generateWebTypes(options?: GeneratorOptions) {
+  const result = await runNpmScript(NpmScript.GenerateWebTypes, options)
+
+  if (result.isErr()) {
+    log.error('There was an error generating the web-types.json file.', result.error)
+    process.exit()
+  }
+
+  log.success('Successfully generated the web-types.json file')
+}
+
+export async function generateVsCodeCustomData(options?: GeneratorOptions) {
+  const result = await runNpmScript(NpmScript.GenerateVsCodeCustomData, {
+    cwd: frameworkPath(),
+    ...options,
+  })
+
+  if (result.isErr()) {
+    log.error('There was an error generating the custom-elements.json file.', result.error)
+    process.exit()
+  }
+
+  await runAction(Action.LintFix, { verbose: true }) // the generated json file needs to be linted
+  log.success('Successfully generated the custom-elements.json file')
+}
+
+export async function generateIdeHelpers(options?: GeneratorOptions) {
+  const result = await runNpmScript(NpmScript.GenerateIdeHelpers, options)
+
+  if (result.isErr()) {
+    log.error('There was an error generating IDE helpers.', result.error)
+    process.exit()
+  }
+
+  await runAction(Action.LintFix, { verbose: true }) // the generated json file needs to be linted
+  log.success('Successfully generated IDE helpers')
+}
+
+export async function generateComponentMeta(options?: GeneratorOptions) {
+  const result = await runNpmScript(NpmScript.GenerateComponentMeta, options)
+
+  if (result.isErr()) {
+    log.error('There was an error generating your component meta information.', result.error)
+    process.exit()
+  }
+
+  await runAction(Action.LintFix, { verbose: true }) // the generated json file needs to be linted
+  log.success('Successfully generated component meta information')
+}
+
+export async function generateTypes(options?: GeneratorOptions) {
+  const result = await runNpmScript(NpmScript.GenerateTypes, {
+    cwd: frameworkPath(),
+    ...options,
+  })
+
+  if (result.isErr()) {
+    log.error('There was an error generating your types.', result.error)
+    process.exit()
+  }
+
+  log.success('Types were generated successfully')
+}
+
+export function generateMigrations() {
+  // const path = frameworkPath('database/schema.prisma')
+
+  // await migrate(path, { database: database.driver })
+
+  // await runCommand(`bunx prisma migrate dev --schema=${path}`)
+
+  log.success('Successfully updated migrations')
+}
+
+export function generatePkgxConfig() {
+  // write the yaml string to a file in your project root
+  // files.put(projectPath('./pkgx.yaml'), yamlStr)
+
+  log.success('Successfully generated `./pkgx.yaml` based on your configs')
+}
+
+export async function generateSeeder() {
+  // await seed()
+}

package/src/generate/lib-entries.ts

@@ -0,0 +1,18 @@
+#!/usr/bin/env bun
+import { log } from '@stacksjs/logging'
+import { library } from '@stacksjs/config'
+import { hasComponents, hasFunctions } from '@stacksjs/storage'
+import { generateLibEntry } from '../helpers/lib-entries'
+
+if (library.releaseable && hasComponents()) {
+  await generateLibEntry('vue-components')
+  await generateLibEntry('web-components')
+}
+else {
+  log.info('No components found. Skipping building component entry points.')
+}
+
+if (library.releaseable && hasFunctions())
+  await generateLibEntry('functions')
+else
+  log.info('No functions found. Skipping building function entry point.')

package/src/generate/model-classes.ts

@@ -0,0 +1,299 @@
+import process from 'node:process'
+import { db } from '@stacksjs/database'
+import type { Collection } from '@stacksjs/collections'
+import { collect } from '@stacksjs/collections'
+
+export interface User {
+  id: number
+  name: string
+  email: string
+  password: string
+  created_at: Date
+  deleted_at: Date
+}
+
+export type UserColumn = keyof User
+export type UserColumns = Array<keyof User>
+
+export class UserModel {
+  private _data: User | undefined = undefined
+
+  private _isSelectInvoked = false
+  public _id: number | undefined = undefined
+  private cols: UserColumns = []
+  private useSoftDeletes = true
+  private keyName: keyof User = 'id'
+
+  queryBuilder = db.selectFrom('users')// Initialize queryBuilder
+  queryBuilderStore = db.insertInto('users')// Initialize queryBuilder
+  queryBuilderUpdate = db.updateTable('users')// Initialize queryBuilder
+  queryBuilderDelete = db.deleteFrom('users')// Initialize queryBuilder
+
+  public async find(id: number | number[]): Promise<User | Collection<User>> {
+    if (Array.isArray(id))
+      return await this.findMany(id)
+
+    let query = this.queryBuilder.selectAll()
+      .where(this.keyName, '=', id)
+
+    if (this.useSoftDeletes)
+      query = query.where('deleted_at', 'is', null)
+
+    this._data = await query.executeTakeFirst()
+
+    if (!this._data)
+      throw new Error('User not found!')
+
+    return this._createProxy()
+  }
+
+  public async findMany(id: number[] | string[]): Promise<User | Collection<User>> {
+    return await this.whereIn(this.keyName, id).get()
+  }
+
+  private _createProxy() {
+    return new Proxy(this._data || {}, {
+      get: (target: User, prop: UserColumn) => {
+        // Property lookup in the User data
+        if (prop in target)
+          return target[prop]
+
+        // If it's a method on the UserModel, bind it
+        const method = this[prop as keyof this]
+        if (typeof method === 'function')
+          return method.bind(this)
+
+        return undefined
+      },
+    })
+  }
+
+  public async update(obj: Partial<User>): Promise<User | undefined | Collection<User>> {
+    if (this._data && this._data?.id) {
+      await this.queryBuilderUpdate.set(obj)
+        .where(this.keyName, '=', this._data?.id)
+        .executeTakeFirst()
+
+      return await this.find(this._data?.id)
+    }
+
+    return undefined
+  }
+
+  public async all() {
+    return await this.queryBuilder.selectAll()
+      .execute()
+  }
+
+  public async get(): Promise<Collection<User>> {
+    if (this.useSoftDeletes)
+      return collect(await this.getSoftDeletes())
+
+    if (this._isSelectInvoked)
+      return collect(await this.queryBuilder.select(this.cols).execute())
+
+    return collect(await this.queryBuilder.selectAll().execute())
+  }
+
+  public async trashed() {
+    if (this._isSelectInvoked)
+      return await this.queryBuilder.where('deleted_at', 'is not', null).select(this.cols).execute()
+
+    return await this.queryBuilder.where('deleted_at', 'is not', null).selectAll().execute()
+  }
+
+  private async getSoftDeletes() {
+    if (this._isSelectInvoked)
+      return await this.queryBuilder.where('deleted_at', 'is', null).select(this.cols).execute()
+
+    return await this.queryBuilder.where('deleted_at', 'is', null).selectAll().execute()
+  }
+
+  public where(...args: (string | number | boolean)[]): this {
+    if (args.length === 2) {
+      const [column, value] = args
+      this.queryBuilder = this.queryBuilder.where(column as UserColumn, '=', value)
+    }
+    else { this.queryBuilder = this.queryBuilder.where(...args) }
+
+    return this
+  }
+
+  public orWhere(...args: (string | number | boolean)[]): this {
+    this.queryBuilder = this.queryBuilder.where(eb => eb.or([
+      eb(...args),
+    ]))
+
+    return this
+  }
+
+  public whereIn(...args: (string[] | string | number[] | boolean[])[]): this {
+    if (args.length === 2) {
+      const [column, value] = args
+      this.queryBuilder = this.queryBuilder.where(column, 'in', value)
+    }
+    else { this.queryBuilder = this.queryBuilder.where(...args) }
+
+    return this
+  }
+
+  public whereNull(col: UserColumn): this {
+    this.queryBuilder = this.queryBuilder.where(col, 'is', null)
+
+    return this
+  }
+
+  public when(condition: boolean, callback: (instance: this) => any): this {
+    if (condition)
+      callback(this)
+
+    return this
+  }
+
+  public whereNotNull(col: UserColumn): this {
+    this.queryBuilder = this.queryBuilder.where(col, 'is not', null)
+
+    return this
+  }
+
+  public distinct() {
+    this.queryBuilder = this.queryBuilder.distinct()
+
+    return this
+  }
+
+  public distinctOn(col: UserColumn): this {
+    this.queryBuilder = this.queryBuilder.distinctOn(col)
+
+    return this
+  }
+
+  public limit(limit: number): this {
+    this.queryBuilder = this.queryBuilder.limit(limit)
+
+    return this
+  }
+
+  public orderBy(col: UserColumn) {
+    this.queryBuilder = this.queryBuilder.orderBy(col)
+
+    return this
+  }
+
+  public groupBy(col: UserColumn) {
+    this.queryBuilder = this.queryBuilder.groupBy(col)
+
+    return this
+  }
+
+  public innerJoin(...args: string[]): this {
+    this.queryBuilder = this.queryBuilder.innerJoin(...args)
+
+    return this
+  }
+
+  public join(...args: string[]): this {
+    this.queryBuilder = this.queryBuilder.innerJoin(...args)
+
+    return this
+  }
+
+  public having(...args: string[]): this {
+    this.queryBuilder = this.queryBuilder.having(...args)
+
+    return this
+  }
+
+  public rightJoin(...args: string[]): this {
+    this.queryBuilder = this.queryBuilder.rightJoin(...args)
+
+    return this
+  }
+
+  public leftJoin(...args: string[]): this {
+    this.queryBuilder = this.queryBuilder.leftJoin(...args)
+
+    return this
+  }
+
+  public offset(offset: number): this {
+    this.queryBuilder = this.queryBuilder.offset(offset)
+
+    return this
+  }
+
+  public fullJoin(...args: string[]): this {
+    this.queryBuilder = this.queryBuilder.fullJoin(...args)
+
+    return this
+  }
+
+  public innerJoinLateral(...args: string[]) {
+    this.queryBuilder.innerJoinLateral(...args)
+
+    return this
+  }
+
+  public leftJoinLateral(...args) {
+    this.queryBuilder.leftJoinLateral(...args)
+
+    return this
+  }
+
+  public orderByDesc(col: UserColumn): this {
+    this.queryBuilder = this.queryBuilder.orderBy(col, 'desc')
+
+    return this
+  }
+
+  public select(...args: UserColumns): this {
+    this.cols = args
+    this._isSelectInvoked = true
+
+    // TODO: resolve this
+    // @ts-expect-error resolve this
+    this.queryBuilder = this.queryBuilder.select(...args)
+
+    return this
+  }
+
+  public async first(): Promise<User> {
+    // Execute the query using queryBuilder
+    if (this._isSelectInvoked)
+      this._data = await this.queryBuilder.select(this.cols).executeTakeFirst()
+    else
+      this._data = await this.queryBuilder.selectAll().executeTakeFirst()
+
+    return this._createProxy()
+  }
+
+  public store(obj: any[]): User {
+    // Execute the query using queryBuilder
+    return this.queryBuilderStore.values(obj)
+      .executeTakeFirst()
+  }
+
+  public createMany(obj: any[]): User[] {
+    // Execute the query using queryBuilder
+    return this.queryBuilderStore.values(obj)
+      .executeTakeFirst()
+  }
+
+  public async delete(): Promise<any> {
+    if (this._data && this._data?.id) {
+      if (this.useSoftDeletes)
+        return await this.update({ deleted_at: new Date() })
+
+      return this.forceDelete()
+    }
+  }
+
+  public forceDelete(): any {
+    if (this._data && this._data?.id) {
+      return this.queryBuilderDelete.where(this.keyName, '=', this._data?.id)
+        .executeTakeFirst()
+    }
+  }
+}
+
+process.exit(0)

package/src/generate/model-generate.ts

@@ -0,0 +1,12 @@
+import { path as p } from '@stacksjs/path'
+
+const modelGenerate = Bun.file('model-classes.ts') // Assuming Bun is imported properly
+const file = Bun.file(p.projectStoragePath('framework/orm/UserModel.ts'))
+
+const code = await modelGenerate.text()
+
+const writer = file.writer()
+
+writer.write(code)
+
+await writer.end()

package/src/generate/pkgx-file.ts

@@ -0,0 +1,72 @@
+// generates the pkgx file based on the user configuration
+import { config } from '@stacksjs/config'
+import { runCommand } from '@stacksjs/cli'
+
+// @ts-expect-error - no types
+import data from '../../../../../pkgx.yaml'
+
+if (!data)
+  throw new Error('pkgx.yaml file not found')
+
+if (data.dependencies['aws.amazon.com/cdk'] === undefined) {
+  log.info('aws.amazon.com/cdk dependency not found in pkgx.yaml.')
+  // throw an error unless its installed locally
+  const result = await runCommand('which cdk')
+  if (result.isErr())
+    throw new Error('aws.amazon.com/cdk dependency not found in pkgx.yaml. To confirm, run `which cdk`')
+}
+
+if (data.dependencies['aws.amazon.com/cli'] === undefined) {
+  log.info('aws.amazon.com/cli dependency not found in pkgx.yaml.')
+  const result = await runCommand('which aws')
+  if (result.isErr())
+    throw new Error('aws.amazon.com/cli dependency not found in pkgx.yaml. To confirm, run `which aws`')
+}
+
+if (data.dependencies['bun.sh'] === undefined) {
+  log.info('bun.sh dependency not found in pkgx.yaml.')
+  // throw an error unless its installed locally
+  const result = await runCommand('which aws')
+  if (result.isErr())
+    throw new Error('bun.sh dependency not found in pkgx.yaml. To confirm, run `which bun`')
+}
+
+if (data.dependencies['info-zip.org/zip'] === undefined) {
+  log.info('info-zip.org/zip dependency not found in pkgx.yaml.')
+  // throw an error unless its installed locally
+  const result = await runCommand('which zip')
+  if (result.isErr())
+    throw new Error('info-zip.org/zip dependency not found in pkgx.yaml. To confirm, run `which zip`')
+}
+
+if (data.dependencies['info-zip.org/unzip'] === undefined) {
+  log.info('info-zip.org/unzip dependency not found in pkgx.yaml.')
+  // throw an error unless its installed locally
+  const result = await runCommand('which unzip')
+  if (result.isErr())
+    throw new Error('info-zip.org/unzip dependency not found in pkgx.yaml. To confirm, run `which unzip`')
+}
+
+if (data.dependencies['mailpit.axllent.org'] === undefined) {
+  log.info('mailpit.axllent.org dependency not found in pkgx.yaml.')
+  // throw an error unless its installed locally
+  const result = await runCommand('which mailpit')
+  if (result.isErr())
+    throw new Error('mailpit.axllent.org dependency not found in pkgx.yaml. To confirm, run `which mailpit`')
+}
+
+if (data.dependencies['redis.io'] === undefined) {
+  log.info('redis.io dependency not found in pkgx.yaml.')
+  // throw an error unless its installed locally
+  const result = await runCommand('which redis')
+  if (result.isErr())
+    throw new Error('redis.io dependency not found in pkgx.yaml. To confirm, run `which redis`')
+}
+
+if (config.database.default === 'sqlite' && data.dependencies['sqlite.org'] === undefined) {
+  log.info('sqlite.org dependency not found in pkgx.yaml.')
+  // throw an error unless its installed locally
+  const result = await runCommand('which sqlite')
+  if (result.isErr())
+    throw new Error('sqlite.org dependency not found in pkgx.yaml. To confirm, run `which sqlite`')
+}

package/src/generate/types.ts

@@ -0,0 +1,6 @@
+// generate types for ./resources/components & ./resources/function
+// currently triggered via buddy dev / vite
+import { log } from '@stacksjs/cli'
+
+log.info('Generating types for ./resources/components & ./resources/function')
+log.info('Generated types saved in ./storage/framework/types/*')

package/src/generate/vscode-custom-data.ts

@@ -0,0 +1,19 @@
+#!/usr/bin/env bun
+
+/**
+ * This action generates the web-types.json & custom-elements.json
+ * files for the components.
+ */
+
+import { log } from '@stacksjs/logging'
+import { hasComponents } from '@stacksjs/storage'
+import { generateVsCodeCustomData } from '../helpers/vscode-custom-data'
+
+log.info('Generating VS Code custom data...')
+
+if (hasComponents())
+  await generateVsCodeCustomData()
+
+else log.info('No components found. Skipping VS Code custom data generation.')
+
+log.success('Generated VS Code custom data.')

package/src/generate/web-types.ts

@@ -0,0 +1,2 @@
+// generate types for ./resources/components & ./resources/function
+// currently triggered via buddy dev / vite