@stacksjs/types 0.61.18 → 0.61.20

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/types",
   "type": "module",
-  "version": "0.61.18",
+  "version": "0.61.20",
   "description": "The Stacks framework types.",
   "author": "Chris Breuer",
   "license": "MIT",
@@ -55,7 +55,7 @@
     "@rollup/pluginutils": "^5.1.0",
     "@stacksjs/validation": "latest",
     "@types/aws4": "^1.11.6",
-    "@types/bun": "^1.1.2",
+    "@types/bun": "^1.1.3",
     "@types/crypto-js": "^4.2.2",
     "@types/fs-extra": "^11.0.4",
     "@types/markdown-it-link-attributes": "^3.0.5",
@@ -78,7 +78,7 @@
     "vue": "^3.4.27"
   },
   "devDependencies": {
-    "aws-cdk-lib": "^2.142.1",
+    "aws-cdk-lib": "^2.143.0",
     "typescript": "^5.4.5"
   }
 }

package/src/model-names.ts

@@ -1 +1,9 @@
-export type ModelNames = 'Project' | 'AccessToken' | 'Team' | 'Subscriber' | 'Deployment' | 'User' | 'Post'
+export type ModelNames =
+  | 'Project'
+  | 'SubscriberEmail'
+  | 'AccessToken'
+  | 'Team'
+  | 'Subscriber'
+  | 'Deployment'
+  | 'User'
+  | 'Post'

package/src/model.ts

@@ -25,6 +25,10 @@ export interface TimestampOptions {
   deletedAt?: string
 }
 
+interface ValidatorMessage {
+  [key: string]: string
+}
+
 export interface SoftDeleteOptions {
   deletedAt?: string // defaults to 'deleted_at' & can be used for localized tables
 }
@@ -116,7 +120,7 @@ export interface Attribute {
   factory?: () => any
   validator?: {
     rule: VineType
-    message: string
+    message: ValidatorMessage
   }
   // validation?: String | Number | Boolean | Date
 }

package/src/router.ts

@@ -1,36 +1,6 @@
 import type { Action } from '@stacksjs/actions'
-import type { ActionPath } from '~/storage/framework/types/actions'
 
-export interface NitroEventHandler {
-  /**
-   * Path prefix or route
-   *
-   * If an empty string used, will be used as a middleware
-   */
-  route?: string
-
-  /**
-   * Specifies this is a middleware handler.
-   * Middleware are called on every route and should normally return nothing to pass to the next handlers
-   */
-  middleware?: boolean
-
-  /**
-   * Use lazy loading to import handler
-   */
-  lazy?: boolean
-
-  /**
-   * Path to event handler
-   *
-   */
-  handler: string
-
-  /**
-   * Router method matcher
-   */
-  method?: string
-}
+type ActionPath = string // TODO: narrow this by automating its generation
 
 // need to refactor before, after, view to be a part of some other type
 export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'before' | 'after' | 'view'
@@ -40,7 +10,9 @@ export type RouteCallback = (params?: Record<string, any>) => any | string | obj
 export interface Route {
   name: string
   uri: string
-  url: string // used synonymously with uri
+  url: string // used synonymously with uri, TODO: narrow this type by ensuring it's generated
+  path?: string
+  prefix?: string
   method: HttpMethod
   pattern: RegExp
   callback: RouteCallback | ActionPath | Action | Promise<any> // we may be able to improve the `Promise<any>` if we could narrow this type `import('../app/Actions/BuddyAction')`
@@ -59,6 +31,8 @@ export interface MiddlewareOptions {
 export type StatusCode = 200 | 201 | 202 | 204 | 301 | 302 | 304 | 400 | 401 | 403 | 404 | 500
 export type RedirectCode = Extract<StatusCode, 301 | 302>
 
+export type RouteParam = { [key: string]: string | number } | null
+
 export type MiddlewareFn = () => void
 
 export interface Middlewares {
@@ -75,7 +49,7 @@ export interface RouteGroupOptions {
 type Prefix = string
 
 export interface RouterInterface {
-  get: (url: Route['url'], callback: Route['callback']) => Promise<this>
+  get: (url: Route['url'], callback: Route['callback']) => this
   post: (url: Route['url'], callback: Route['callback']) => this
   view: (url: Route['url'], callback: Route['callback']) => this
   redirect: (url: Route['url'], callback: Route['callback'], status?: RedirectCode) => this