stacks 0.53.1 → 0.56.3

package/core/tinker/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@stacksjs/tinker",
   "type": "module",
-  "version": "0.53.1",
-  "packageManager": "pnpm@8.5.1",
+  "version": "0.56.3",
+  "packageManager": "pnpm@8.6.5",
   "description": "The Stacks way to tinker.",
   "author": "Chris Breuer",
   "license": "MIT",
@@ -36,10 +36,22 @@
     "dist",
     "README.md"
   ],
+  "scripts": {
+    "build": "unbuild",
+    "dev": "unbuild --stub",
+    "prepublishOnly": "unbuild",
+    "typecheck": "tsc --noEmit"
+  },
+  "peerDependencies": {
+    "@vue/repl": "^2.3.0",
+    "tsx": "^3.12.7"
+  },
   "dependencies": {
+    "@vue/repl": "^2.3.0",
     "tsx": "^3.12.7"
   },
   "devDependencies": {
-    "@stacksjs/development": "workspace:*"
+    "typescript": "^5.1.3",
+    "unbuild": "^1.2.1"
   }
 }

package/core/tinker/src/index.ts

@@ -0,0 +1 @@
+export * from '@vue/repl'

package/core/types/build.config.ts

@@ -1,13 +1,22 @@
-import { defineBuildConfig } from 'unbuild'
+import type { BuildConfig } from '@stacksjs/development'
+import { alias, defineBuildConfig } from '@stacksjs/development'
+
+type Entries = BuildConfig['entries']
+const devEntries: Entries = [{
+  input: './src/index',
+  outDir: './dist/',
+}]
+const buildEntries = devEntries
+const command = process.env.npm_lifecycle_script
+const entries: Entries = command?.includes('--stub') ? devEntries : buildEntries
 
 export default defineBuildConfig({
-  entries: [
-    {
-      builder: 'mkdist',
-      input: './src/',
-      outDir: './dist/',
-      format: 'esm',
-    },
+  alias,
+
+  entries,
+
+  externals: [
+    '@stacksjs/utils',
   ],
 
   clean: true,

package/core/types/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@stacksjs/types",
   "type": "module",
-  "version": "0.53.1",
-  "packageManager": "pnpm@8.5.1",
+  "version": "0.56.3",
+  "packageManager": "pnpm@8.6.5",
   "description": "The Stacks framework types.",
   "author": "Chris Breuer",
   "license": "MIT",
@@ -26,9 +26,9 @@
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.mjs"
-    }
+    },
+    "./*": "./*"
   },
-  "main": "dist/index.mjs",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
   "contributors": [
@@ -41,41 +41,47 @@
   "scripts": {
     "build": "unbuild",
     "dev": "unbuild --stub",
-    "prepublishOnly": "pnpm run build",
+    "prepublishOnly": "unbuild",
     "typecheck": "tsc --noEmit"
   },
+  "peerDependencies": {
+    "neverthrow": "^6.0.0"
+  },
   "dependencies": {
     "@mdit-vue/plugin-component": "^0.12.0",
     "@mdit-vue/plugin-frontmatter": "^0.12.0",
     "@mdit-vue/types": "^0.12.0",
-    "@novu/stateless": "^0.15.0",
+    "@novu/stateless": "^0.16.1",
     "@rollup/pluginutils": "^5.0.2",
-    "@stacksjs/development": "workspace:*",
     "@types/bcryptjs": "^2.4.2",
     "@types/crypto-js": "^4.1.1",
-    "@types/eslint": "^8.40.0",
+    "@types/eslint": "^8.40.2",
     "@types/fs-extra": "^11.0.1",
     "@types/markdown-it-link-attributes": "^3.0.1",
     "@types/minimatch": "^5.1.2",
-    "@types/node": "^18.16.14",
+    "@types/node": "^18.16.18",
     "@types/nprogress": "^0.2.0",
     "@types/pluralize": "^0.0.29",
+    "@vinejs/vine": "^1.4.1",
     "cac": "^6.7.14",
     "execa": "^7.1.1",
     "markdown-it": "^13.0.1",
-    "meilisearch": "^0.32.4",
+    "meilisearch": "^0.33.0",
     "neverthrow": "^6.0.0",
     "ora": "^6.3.1",
-    "unocss": "^0.52.3",
-    "unplugin-auto-import": "^0.16.2",
-    "unplugin-vue-components": "^0.24.1",
-    "vite": "^4.3.8",
-    "vite-plugin-inspect": "^0.7.28",
-    "vite-plugin-pwa": "^0.15.0",
+    "unocss": "^0.53.4",
+    "unplugin-auto-import": "^0.16.4",
+    "unplugin-vue-components": "^0.25.1",
+    "vite": "^4.3.9",
+    "vite-plugin-inspect": "^0.7.29",
+    "vite-plugin-pwa": "^0.16.4",
     "vite-plugin-vue-layouts": "^0.8.0",
     "vite-ssg": "^0.22.2",
-    "vitepress": "1.0.0-beta.1",
-    "vue": "^3.3.4",
-    "zod": "^3.21.4"
+    "vitepress": "1.0.0-beta.3",
+    "vue": "^3.3.4"
+  },
+  "devDependencies": {
+    "typescript": "^5.1.3",
+    "unbuild": "^1.2.1"
   }
 }

package/core/types/src/app.ts

@@ -26,7 +26,7 @@ export interface AppOptions {
    *
    * @default "local"
    */
-  env?: 'local' | 'development' | 'production'
+  env: 'local' | 'development' | 'staging' | 'production'
 
   /**
    * **Application URL**
@@ -35,10 +35,10 @@ export interface AppOptions {
    * the Buddy command line tool. You should set this to the root of
    * your application so that it is used when running Buddy tasks.
    *
-   * @default string "https://localhost"
-   * @example "https://hello-world.test"
+   * @default string "https://stacks.test"
+   * @example "https://my-project.test"
    */
-  url?: string
+  url: string
 
   /**
    * **Application Debug Mode**

package/core/types/src/cli.ts

@@ -214,7 +214,7 @@ export type LibEntryType = 'vue-components' | 'web-components' | 'functions' | '
  */
 export const enum NpmScript {
   Build = 'build',
-  BuildComponents = 'build:components',
+  BuildComponents = 'vite build --config ./core/build/src/vue-components.ts',
   BuildWebComponents = 'build:web-components',
   BuildFunctions = 'build:functions',
   BuildDocs = 'build:docs',
@@ -227,8 +227,9 @@ export const enum NpmScript {
   DevPages = 'dev:pages',
   DevFunctions = 'dev:functions',
   Fresh = 'fresh',
-  Lint = 'eslint . ; npx publint',
+  Lint = 'eslint .',
   LintFix = 'eslint . --fix',
+  LintPackageJson = 'npx publint',
   MakeStack = 'make:stack',
   Test = 'vitest --config vitest.config.ts',
   TestUnit = 'vitest --config vitest.config.ts',
@@ -260,42 +261,43 @@ export const enum NpmScript {
 }
 
 export const enum Action {
-  Bump = 'bump', // wip
-  BuildStacks = 'build/stacks', // wip
-  BuildComponentLibs = 'build-component-libs', // wip
-  BuildVueComponentLib = 'build-vue-component-lib', // wip
-  BuildWebComponentLib = 'build-web-component-lib', // wip
-  BuildCli = 'build-cli', // wip
-  BuildCore = 'build/core', // wip
+  Bump = 'bump',
+  BuildStacks = 'build/stacks',
+  BuildComponentLibs = 'build/component-libs',
+  BuildVueComponentLib = 'build-vue-component-lib',
+  BuildWebComponentLib = 'build-web-component-lib',
+  BuildCli = 'build-cli',
+  BuildCore = 'build/core',
   BuildDocs = 'build-docs',
   BuildFunctionLib = 'build-function-lib',
-  Changelog = 'changelog', // wip
-  Clean = 'clean', // wip
-  DevComponents = 'dev/components', // wip
-  DevDocs = 'dev/docs', // wip
-  Deploy = 'deploy', // wip
-  Fresh = 'fresh', // wip
+  Changelog = 'changelog',
+  Clean = 'clean',
+  DevComponents = 'dev/components', // ✅
+  Dev = 'dev/index',
+  DevDocs = 'dev/docs',
+  Deploy = 'deploy',
+  Fresh = 'fresh',
   GenerateLibraryEntries = 'generate/lib-entries', // ✅
-  Inspire = 'inspire', // wip
-  KeyGenerate = 'key-generate', // wip
-  MakeNotification = 'make-notification', // wip
-  Migrate = 'migrate', // wip
-  Seed = 'seed', // wip
-  Lint = 'lint/index', // wip
-  LintFix = 'lint/fix', // ✅
-  Prepublish = 'prepublish', // wip
-  Release = 'release', // wip
-  ShowFeatureTestReport = 'show-feature-test-report', // wip
-  Test = 'test', // wip
-  TestUi = 'test-ui', // wip
-  TestUnit = 'test-unit', // wip
-  TestFeature = 'test-feature', // wip
-  TestCoverage = 'test-coverage', // wip
+  Inspire = 'inspire',
+  KeyGenerate = 'key-generate',
+  MakeNotification = 'make-notification',
+  Migrate = 'migrate',
+  Seed = 'seed',
+  Lint = 'lint/index',
+  LintFix = 'lint/fix',
+  Prepublish = 'prepublish',
+  Release = 'release', // ✅
+  ShowFeatureTestReport = 'show-feature-test-report',
+  Test = 'test',
+  TestUi = 'test-ui',
+  TestUnit = 'test-unit',
+  TestFeature = 'test-feature',
+  TestCoverage = 'test-coverage',
   Tinker = 'tinker',
-  Typecheck = 'typecheck', // wip
-  Upgrade = 'upgrade/index', // wip
-  UpgradeNode = 'upgrade/node', // wip
-  UpgradePackageManager = 'upgrade/package-manager', // wip
+  Typecheck = 'typecheck',
+  Upgrade = 'upgrade/index',
+  UpgradeNode = 'upgrade/node',
+  UpgradePackageManager = 'upgrade/package-manager',
 }
 
 export type { CAC as CLI } from 'cac'

package/core/types/src/cron-jobs.ts

@@ -1,17 +1,38 @@
 /**
  * Cron Job Options.
  */
-export interface CronJobOptions {
+export interface JobOptions {
   /**
-   * The name of the cron job.
+   * The name of the job.
    */
   name?: string
-  function: string
-  schedule: string
+  action?: string | Function
+  run?: string | Function
+  schedule?: string
   description?: string
   enabled?: boolean
   timezone?: string
+  active?: boolean
+  tries?: number
+  backoff?: number | number[]
 }
+export type Job = JobOptions
+export type Jobs = Job[]
 
+export interface CronJobOptions extends Omit<JobOptions, 'schedule'> {
+  schedule: string
+}
 export type CronJob = CronJobOptions
 export type CronJobs = CronJob[]
+
+export enum Every {
+  Minute = '* * * * *',
+  Hour = '0 * * * *',
+  HalfHour = '0,30 * * * *',
+  Day = '0 0 * * *',
+  Month = '0 0 1 * *',
+  Week = '0 0 * * 0',
+  Year = '0 0 1 1 *',
+  FifthMinute = '*/5 * * * *',
+  TenthMinute = '*/10 * * * *',
+}

package/core/types/src/database.ts

@@ -3,22 +3,31 @@ import type { Model } from './model'
 export type DatabaseClient = any
 
 export interface DatabaseOptions {
-  driver: string
+  default: string
 
-  drivers: {
+  connections: {
     mysql: {
       url?: string
       host?: string
       port?: number
       client?: DatabaseClient
-      name: string
+      name?: string
       username?: string
       password?: string
+      prefix?: string
+    }
+
+    sqlite: {
+      url?: string
+      database?: string
+      prefix?: string
     }
 
     planetscale: {}
     postgres: {}
   }
+
+  migrations: string
 }
 
 export interface FactoryOptions {

package/core/types/src/errors.ts

@@ -1,6 +1,24 @@
-export {
+import {
   Err,
   Ok,
   Result,
   ResultAsync,
 } from 'neverthrow'
+
+export declare class ValidationError extends Error {
+  messages: any
+  status: number
+  code: string
+  constructor(messages: any, options?: ErrorOptions)
+  get [Symbol.toStringTag](): string
+  toString(): string
+}
+
+export type StacksError = Error | ValidationError
+
+export {
+  Err,
+  Ok,
+  Result,
+  ResultAsync,
+}

package/core/types/src/events.ts

@@ -7,16 +7,24 @@
  *
  * @example To fire an event, you may use any of the following approaches:
  * ```ts
- * useEvent('user:registered', { name: 'Chris'})
- * dispatch('user:registered', { name: 'Chris'})
+ * dispatch('user:registered', { name: 'Chris', email: 'chris@stacksjs.dev' })
+ *
+ * // alternatively, you may use the following:
+ * useEvent('user:registered', { name: 'Chris', email: 'chris@stacksjs.dev' })
+ * events.emit('user:registered', { name: 'Chris', email: 'chris@stacksjs.dev' })
+ * useEvents.emit('user:registered', { name: 'Chris', email: 'chris@stacksjs.dev' })
  * ````
 
  * @example To capture an event, you may use any of the following approaches:
  * ```ts
- * useListen('user:registered', (user) => console.log(user))
- * listen('user:registered', (user) => console.log(user))
+ * listen('user:registered', (user) => sendWelcomeEmail(user))
+ *
+ * // alternatively, you may use the following:
+ * useListen('user:registered', (user) => sendWelcomeEmail(user))
+ * events.on('user:registered', (user) => sendWelcomeEmail(user))
+ * useEvents.on('user:registered', (user) => sendWelcomeEmail(user))
  * ```
  */
 export interface Events {
-  [key: string]: any
+  [key: string]: (...args: any[]) => Function
 }

package/core/types/src/git.ts

@@ -33,7 +33,7 @@ export interface GitOptions {
    * git: [
    *   scopes: [
    *     '', 'ci', 'deps', 'dx', 'release', 'readme', 'test', 'actions', 'build', 'cli',
-   *     'config', 'examples', 'functions', 'modules', 'pages', 'router', 'scripts',
+   *     'config', 'examples', 'functions', 'modules', 'views', 'router', 'scripts',
    *     'ui', 'utils', 'arrays', 'collections', 'fs', 'objects', 'strings',
    *   ]
    * ]

package/core/types/src/index.ts

@@ -22,13 +22,14 @@ export * from './inspect'
 export * from './layout'
 export * from './library'
 export * from './manifest'
-export * from './markdown'
 export * from './model'
+export * from './money'
 export * from './notifications'
 export * from './pages'
 export * from './payments'
 export * from './promise'
 export * from './pwa'
+export * from './queue'
 export * from './reactivity'
 export * from './router'
 export * from './search-engine'

package/core/types/src/library.ts

@@ -91,13 +91,6 @@ export interface LibraryBuildOptions {
    */
   keywords: string[]
 
-  /**
-   * Should your library include an IIFE build?
-   * (Immediately Invoked Function Expression)
-   * @default false
-   */
-  shouldBuildIife?: boolean
-
   /**
    * Should your library generate a sourcemap?
    * @default false

package/core/types/src/model.ts

@@ -1,5 +1,11 @@
-import type { ZodBoolean as Boolean, ZodDate as Date, ZodNumber as Number, ZodString as String } from 'zod'
-import type { SearchIndexSettings } from './search-engine'
+import type {
+  VineBoolean as Boolean,
+  VineNumber as Number,
+  VineString as String,
+} from '@vinejs/vine'
+import type { Nullable, SearchEngineSettings } from './'
+
+export interface AuthOptions {}
 
 export interface SeedOptions {
   count: number
@@ -11,10 +17,12 @@ export interface TimestampOptions {
   deletedAt?: string
 }
 
+interface Base {}
+
 /**
  * Model.
  */
-export interface Model {
+export interface Model extends Base {
   name?: string // defaults to the file name of the model
   table?: string // defaults to the lowercase, plural name of the model
   fields: Fields
@@ -22,14 +30,16 @@ export interface Model {
   hasMany?: string
   belongsToMany?: string
   hasThrough?: {
-    model: string
+    model: string // should be typed as ModelName
     through: string
     using: string
   }
+  authenticatable?: boolean | AuthOptions
   seedable?: boolean | SeedOptions
+  searchable?: boolean | SearchEngineSettings
   useSeed?: boolean | SeedOptions
-  searchable?: boolean | SearchIndexSettings
-  useSearch?: boolean | SearchIndexSettings
+  useSearch?: boolean | SearchEngineSettings
+  useSearchEngine?: boolean | SearchEngineSettings
   useTimestamps?: boolean | TimestampOptions
   // useSoftDeletes?: boolean | SoftDeleteOptions
 }
@@ -40,6 +50,10 @@ export interface Fields {
     unique?: boolean
     required?: boolean
     factory?: () => any
-    validation?: String | Number | Boolean | Date
+    validator?: {
+      rule: String | Number | Boolean | Date | Nullable<any>
+      message: string
+    }
+    // validation?: String | Number | Boolean | Date
   }
 }

package/core/types/src/money.ts

@@ -0,0 +1,3 @@
+import type { Dinero } from '@stacksjs/utils'
+
+export type Money = Dinero<number>

package/core/types/src/notifications.ts

@@ -5,8 +5,11 @@ export interface NotificationOptions {
 
   email: {
     default: 'emailjs' | 'mailgun' | 'mailjet' | 'mandrill' | 'netcore' | 'nodemailer' | 'postmark' | 'sendgrid' | 'ses' | string
-    from: string
-    to: string
+
+    from: {
+      name: string
+      address: string
+    }
 
     drivers: {
       smtp: {
@@ -74,7 +77,6 @@ export interface NotificationOptions {
   sms: {
     default: 'twilio' | 'nexmo' | 'gupshup' | 'plivo' | 'sms77' | 'sns' | 'telnyx' | 'termii' | string
     from: string
-    to: string
 
     drivers: {
       twilio: {
@@ -121,7 +123,6 @@ export interface NotificationOptions {
   chat: {
     default: 'slack' | 'msTeams' | 'discord' | string
     from: string
-    to: string
 
     drivers: {
       slack?: {
@@ -197,7 +198,8 @@ export type EmailOptions = Omit<IEmailOptions, 'from'> & {
   domain?: string
 
   mailboxes?: {
-    'username': string
-    'forwardTo': string
-  }[]
+    [key: string]: string
+    // 'username': string
+    // 'forwardTo': string
+  }
 }

package/core/types/src/queue.ts

@@ -0,0 +1,34 @@
+export interface QueueOptions {
+  default: 'sync' | 'database' | 'redis' | 'sqs'
+  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'
+    }
+  }
+  failed: {
+    driver: 'database'
+    database: 'mysql'
+    table: 'failed_jobs'
+  }
+}

package/core/types/src/search-engine.ts

@@ -1,4 +1,4 @@
-import type { EnqueuedTask, Hits, Index, IndexOptions, IndexesResults, MeiliSearch, DocumentOptions as RecordOptions, Settings as SearchIndexSettings, SearchParams, SearchResponse } from 'meilisearch'
+import type { EnqueuedTask, Hits, Index, IndexOptions, IndexesResults, MeiliSearch, DocumentOptions as RecordOptions, Settings as SearchEngineSettings, SearchParams, SearchResponse } from 'meilisearch'
 import type { MaybePromise } from '.'
 
 type Search = any
@@ -91,7 +91,7 @@ export interface SearchEngineDriver {
   getIndex: (name: string) => MaybePromise<Index>
   updateIndex?: (name: string, options: IndexOptions) => MaybePromise<EnqueuedTask>
   deleteIndex?: (name: string) => MaybePromise<EnqueuedTask>
-  updateIndexSettings: (name: string, settings: SearchIndexSettings) => MaybePromise<EnqueuedTask>
+  updateIndexSettings: (name: string, settings: SearchEngineSettings) => MaybePromise<EnqueuedTask>
   listAllIndexes: () => MaybePromise<IndexesResults<Index[]>>
   listAllIndices: () => MaybePromise<IndexesResults<Index[]>> // alternatives plural spelling
 
@@ -163,4 +163,4 @@ export interface SearchEngineStorage {
   currentPage: number
 }
 
-export type { EnqueuedTask, Hits, Index, IndexOptions, IndexesResults, MeiliSearch, RecordOptions, SearchIndexSettings, SearchParams, SearchResponse }
+export type { EnqueuedTask, Hits, Index, IndexOptions, IndexesResults, MeiliSearch, RecordOptions, SearchEngineSettings, SearchParams, SearchResponse }

package/core/types/src/stacks.ts

@@ -7,7 +7,6 @@ import type {
   DnsOptions,
   DocsOptions,
   EmailOptions,
-  EventOptions,
   GitOptions,
   HashingOptions,
   LibraryOptions,
@@ -15,7 +14,6 @@ import type {
   PaymentOptions,
   SearchEngineOptions,
   ServicesOptions,
-  StorageOptions,
   UiOptions,
   UserCliOptions,
 } from './'
@@ -109,15 +107,6 @@ export interface StacksOptions {
    */
   email: Partial<EmailOptions>
 
-  /**
-   * **Event Options**
-   *
-   * This configuration defines all of your Event options. Because Stacks is fully-typed, you
-   * may hover any of the options below and the definitions will be provided. In case you
-   * have any questions, feel free to reach out via Discord or GitHub Discussions.
-   */
-  event: Partial<EventOptions>
-
   /**
    * **Git Options**
    *
@@ -188,7 +177,7 @@ export interface StacksOptions {
    * you may hover any of the options below and the definitions will be provided. In case
    * you have any questions, feel free to reach out via Discord or GitHub Discussions.
    */
-  storage: Partial<StorageOptions>
+  // storage: Partial<StorageOptions>
 
   /**
    * **UI Options**