@stacksjs/types 0.58.57 → 0.58.59

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/types",
   "type": "module",
-  "version": "0.58.57",
+  "version": "0.58.59",
   "description": "The Stacks framework types.",
   "author": "Chris Breuer",
   "license": "MIT",
@@ -51,7 +51,7 @@
     "@mdit-vue/plugin-component": "^2.0.0",
     "@mdit-vue/plugin-frontmatter": "^2.0.0",
     "@mdit-vue/types": "^2.0.0",
-    "@novu/stateless": "^0.23.0",
+    "@novu/stateless": "^0.23.1",
     "@rollup/pluginutils": "^5.1.0",
     "@stacksjs/validation": "latest",
     "@types/aws4": "^1.11.6",
@@ -62,7 +62,7 @@
     "@types/fs-extra": "^11.0.4",
     "@types/markdown-it-link-attributes": "^3.0.4",
     "@types/minimatch": "^5.1.2",
-    "@types/node": "^20.11.16",
+    "@types/node": "^20.11.17",
     "@types/nprogress": "^0.2.3",
     "@vinejs/vine": "^1.7.1",
     "cac": "^6.7.14",
@@ -73,15 +73,15 @@
     "unocss": "^0.58.5",
     "unplugin-auto-import": "^0.17.5",
     "unplugin-vue-components": "^0.26.0",
-    "vite": "^5.0.12",
+    "vite": "^5.1.1",
     "vite-plugin-inspect": "^0.8.3",
-    "vite-plugin-pwa": "^0.17.5",
+    "vite-plugin-pwa": "^0.18.1",
     "vite-ssg": "^0.23.6",
     "vitepress": "1.0.0-rc.42",
-    "vue": "^3.4.15"
+    "vue": "^3.4.18"
   },
   "devDependencies": {
-    "aws-cdk-lib": "^2.126.0",
+    "aws-cdk-lib": "^2.127.0",
     "typescript": "^5.3.3"
   }
 }

package/src/ai.ts

@@ -20,6 +20,7 @@ type AiModel = 'amazon.titan-embed-text-v1'
 export interface AiOptions {
   default: AiModel
   models: AiModel[]
+  deploy: boolean
 }
 
 export type AiConfig = Partial<AiOptions>

package/src/binary.ts

@@ -6,6 +6,7 @@ export interface BinaryOptions {
   command: string
   description: string
   source: string
+  deploy: boolean
   // path: string // TODO: add this for a configurable path where the commands are located
 }
 

package/src/cli.ts

@@ -1,6 +1,6 @@
 import type { BunFile } from 'bun'
 
-type ArrayBufferView = TypedArray | DataView
+type ArrayBufferView = NodeJS.TypedArray | DataView
 
 export type { Subprocess, SyncSubprocess } from 'bun'
 export type Readable =
@@ -160,6 +160,10 @@ export interface CliOptions {
    * @default false
    */
   withLocalhost?: boolean
+
+  input?: string | ArrayBufferView | ReadableStream | Blob | Response | Request
+
+  quiet?: boolean
 }
 
 export type CliConfig = CliOptions
@@ -177,6 +181,7 @@ export type ActionOptions = {
   types?: boolean
   domains?: boolean
   count?: number
+  dryRun?: boolean // used in buddy release
 } & CliOptions & DomainsOptions
 
 export type BuildOption = 'components' | 'vueComponents' | 'webComponents' | 'elements' | 'functions' | 'docs' | 'views' | 'stacks' | 'all' | 'buddy' | 'server'
@@ -290,11 +295,16 @@ export interface CloudCliOptions extends CliOptions {
 }
 export interface CommitOptions extends CliOptions { }
 export interface KeyOptions extends CliOptions { }
-export interface FreshOptions extends CliOptions { }
+export interface FreshOptions extends CliOptions {
+  dryRun?: boolean
+  quiet?: boolean
+}
 export interface MigrateOptions extends CliOptions { }
 export interface InspireOptions extends CliOptions { }
 export interface InstallOptions extends CliOptions { }
-export interface ReleaseOptions extends CliOptions { }
+export interface ReleaseOptions extends CliOptions {
+  dryRun?: boolean
+}
 export interface PreinstallOptions extends CliOptions { }
 export interface PrepublishOptions extends CliOptions { }
 export interface TinkerOptions extends CliOptions { }

package/src/cron-jobs.ts

@@ -1,3 +1,5 @@
+import type { IntRange } from '@stacksjs/scheduler'
+
 /**
  * Cron Job Options.
  */
@@ -12,7 +14,10 @@ export interface JobOptions {
   description?: string
   queue?: string
   timezone?: string
-  tries?: number
+  /**
+   * Number of tries. Must be between 0 and 185.
+   */
+  tries?: IntRange<0, 185>
   backoff?: number | number[]
   rate?: string | Every
   enabled?: boolean

package/src/docs.ts

@@ -1,6 +1,10 @@
 import type { UserConfig } from 'vitepress'
 
-export type DocsConfig = UserConfig
+interface DeployedUserConfig extends UserConfig {
+  deploy: boolean
+}
+
+export type DocsConfig = DeployedUserConfig
 export type DocsOptions = DocsConfig
 
 export interface SocialLink {

package/src/index.ts

@@ -30,6 +30,7 @@ export * from './i18n'
 export * from './inspect'
 // export * from './layout'
 export * from './library'
+export * from './logger'
 export * from './manifest'
 export * from './model'
 export * from './money'

package/src/logger.ts

@@ -0,0 +1,54 @@
+import type { LogLevel } from 'consola'
+import { LogLevels, LogTypes } from 'consola'
+
+/**
+ * **Logger Options**
+ *
+ * This configuration defines all of your logger 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.
+ */
+export interface LoggerOptions {
+  /**
+   * **Log Level**
+   *
+   * The log level is a number that represents the verbosity of the logs. The higher the number,
+   * the more verbose the logs will be. The log levels are as follows:
+   *
+   * - 0: Error
+   * - 1: Warning
+   * - 2: Normal
+   * - 3: Info
+   * - 4: Debug
+   * - 5: Trace
+   * - -999: Silent
+   * - +999: Verbose
+   *
+   * @default 3
+   */
+  level: LogLevel
+
+  /**
+   * **Log File Path**
+   *
+   * The path to the log file. This will be used to write logs to a file. If you do not want to
+   * write logs to a file, you may set this to `null`.
+   *
+   * @default 'storage/logs/console.log'
+   */
+  logFilePath: string
+
+  /**
+   * **Errors Log Path**
+   *
+   * The path to the errors log file. This will be used to write error logs to a file. If you do
+   * not want to write error logs to a file, you may set this to `null`.
+   *
+   * @default 'storage/logs/errors.log'
+   */
+  errorsPath: string
+}
+
+export type LoggerConfig = Partial<LoggerOptions>
+
+export { LogLevels, LogTypes }

package/src/router.ts

@@ -34,13 +34,14 @@ export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'before'
 
 export type RouteCallback = (params?: Record<string, any>) => any | string | object
 
+type ActionName = string
 export interface Route {
   name: string
   uri: string
   url: string // used synonymously with uri
   method: HttpMethod
   pattern: RegExp
-  callback: RouteCallback
+  callback: RouteCallback | ActionName
   paramNames: string[]
   middleware?: string | string[]
   statusCode?: StatusCode

package/src/stacks.ts

@@ -12,6 +12,7 @@ import type {
   GitConfig,
   HashingConfig,
   LibraryConfig,
+  LoggerConfig,
   NotificationConfig,
   PaymentConfig,
   QueueConfig,
@@ -141,6 +142,15 @@ export interface StacksOptions {
    */
   library: LibraryConfig
 
+  /**
+   * **Logger Options**
+   *
+   * This configuration defines all of your Logger 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.
+   */
+  logger: LoggerConfig
+
   /**
    * **Notification Options**
    *

package/src/team.ts

@@ -1,6 +1,6 @@
 type TeamMemberName = string
 type Email = string
-type TeamMembers = Record<TeamMemberName, Email>
+type TeamMembers = Record<TeamMemberName, Email>[]
 
 export interface Team {
   name: string