@stacksjs/types 0.58.73 → 0.59.2

package/dist/utils.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Null or whatever.
+ */
+export type Nullable<T> = T | null | undefined;
+/**
+ * Function
+ */
+export type Fn<T = void> = () => T;
+/**
+ * Array, or not yet
+ */
+export type Arrayable<T> = T | Array<T>;
+/**
+ * Constructor.
+ */
+export type Constructor<T = void> = new (...args: any[]) => T;
+/**
+ * Defines an intersection type of all union items.
+ *
+ * @param U Union of any types that will be intersected.
+ * @returns U items intersected
+ * @see https://stackoverflow.com/a/50375286/9259330
+ */
+export type UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends ((k: infer I) => void) ? I : never;
+export type MergeInsertions<T> = T extends object ? {
+    [K in keyof T]: MergeInsertions<T[K]>;
+} : T;
+export type DeepMerge<F, S> = MergeInsertions<{
+    [K in keyof F | keyof S]: K extends keyof S & keyof F ? DeepMerge<F[K], S[K]> : K extends keyof S ? S[K] : K extends keyof F ? F[K] : never;
+}>;
+export type DeepPartial<T> = {
+    [P in keyof T]?: DeepPartial<T[P]>;
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/types",
   "type": "module",
-  "version": "0.58.73",
+  "version": "0.59.2",
   "description": "The Stacks framework types.",
   "author": "Chris Breuer",
   "license": "MIT",
@@ -51,18 +51,17 @@
     "@mdit-vue/plugin-component": "^2.0.0",
     "@mdit-vue/plugin-frontmatter": "^2.0.0",
     "@mdit-vue/types": "^2.0.0",
-    "@novu/stateless": "^0.23.1",
     "@rollup/pluginutils": "^5.1.0",
     "@stacksjs/validation": "latest",
     "@types/aws4": "^1.11.6",
     "@types/bcryptjs": "^2.4.6",
-    "@types/bun": "^1.0.6",
+    "@types/bun": "^1.0.8",
     "@types/crypto-js": "^4.2.2",
-    "@types/eslint": "^8.56.2",
+    "@types/eslint": "^8.56.5",
     "@types/fs-extra": "^11.0.4",
     "@types/markdown-it-link-attributes": "^3.0.4",
     "@types/minimatch": "^5.1.2",
-    "@types/node": "^20.11.19",
+    "@types/node": "^20.11.24",
     "@types/nprogress": "^0.2.3",
     "@vinejs/vine": "^1.7.1",
     "cac": "^6.7.14",
@@ -73,15 +72,15 @@
     "unocss": "^0.58.5",
     "unplugin-auto-import": "^0.17.5",
     "unplugin-vue-components": "^0.26.0",
-    "vite": "^5.1.3",
+    "vite": "^5.1.5",
     "vite-plugin-inspect": "^0.8.3",
-    "vite-plugin-pwa": "^0.19.0",
+    "vite-plugin-pwa": "^0.19.2",
     "vite-ssg": "^0.23.6",
     "vitepress": "1.0.0-rc.44",
-    "vue": "^3.4.19"
+    "vue": "^3.4.21"
   },
   "devDependencies": {
-    "aws-cdk-lib": "^2.128.0",
+    "aws-cdk-lib": "^2.131.0",
     "typescript": "^5.3.3"
   }
 }

package/src/chat.ts

@@ -1,5 +1,4 @@
-import type { IChatOptions as ChatOptions } from '@novu/stateless'
-
+interface ChatOptions {}
 export type { ChatOptions }
 
 export type ChatConfig = ChatOptions

package/src/cli.ts

@@ -322,7 +322,7 @@ export interface ProjectsOptions extends CliOptions {
 }
 export interface PreinstallOptions extends CliOptions { }
 export interface PrepublishOptions extends CliOptions { }
-export interface CheckOptions extends CliOptions {
+export interface PortsOptions extends CliOptions {
   ports?: Partial<Ports>
 }
 export interface TinkerOptions extends CliOptions { }

package/src/cloud.ts

@@ -31,6 +31,8 @@ export type CountryCode =
 type Environment = 'development' | 'staging' | 'production'
 
 export interface CloudOptions {
+  type: 'serverless' // | 'server' coming soon
+
   driver: 'aws'
 
   // eslint-disable-next-line ts/ban-types

package/src/index.ts

@@ -43,7 +43,6 @@ 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'

package/src/model.ts

@@ -25,27 +25,37 @@ interface Base {}
 export interface ModelOptions extends Base {
   name: string // defaults to the file name of the model
   table: string // defaults to the lowercase, plural name of the model
-  useUuid: boolean
+  primaryKey?: string // defaults to `id`
+  autoIncrement?: boolean // defaults to true
+
+  traits: {
+    useUuid?: boolean // defaults to false
+    useTimestamps?: boolean | TimestampOptions // defaults to true
+    useSoftDeletes?: boolean | SoftDeleteOptions // defaults to false
+
+    useAuth?: boolean | AuthOptions // defaults to false
+    authenticatable?: boolean | AuthOptions // useAuth alias
+    useSeeder?: boolean | SeedOptions // defaults to a count of 10
+    seedable?: boolean | SeedOptions // useSeeder alias
+    useSearch?: boolean | SearchEngineSettings // defaults to false
+    searchable?: boolean | SearchEngineSettings // useSearch alias
+  }
+
   fields: Fields
+
+  // relationships
   hasOne: string // hasOne: 'Post'
   hasMany: {
     model: string // should be typed as ModelName
     foreignKey?: string
   }
+  belongsTo: string // belongsTo: 'User'
   belongsToMany: object
   hasThrough: {
     model: string // should be typed as ModelName
     through: string
     using: string
   }
-  authenticatable: boolean | AuthOptions
-  seedable: boolean | SeedOptions
-  searchable: boolean | SearchEngineSettings
-  useSeed: boolean | SeedOptions
-  useSearch: boolean | SearchEngineSettings
-  useSearchEngine: boolean | SearchEngineSettings
-  useTimestamps: boolean | TimestampOptions
-  useSoftDeletes: boolean | SoftDeleteOptions
 
   attributes: {
     [key: string]: {

package/src/router.ts

@@ -49,10 +49,10 @@ export interface Route {
   statusCode?: StatusCode
 }
 
-export interface MiddlewareType {
+export interface MiddlewareOptions {
   name: string
+  description?: string
   priority: number
-
   handle: Function
 }
 
@@ -71,3 +71,23 @@ export interface RouteGroupOptions {
   prefix?: string
   middleware?: Route['middleware']
 }
+
+type Prefix = string
+
+export interface RouterInterface {
+  get: (url: Route['url'], callback: Route['callback']) => Promise<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
+  delete: (url: Route['url'], callback: Route['callback']) => this
+  patch: (url: Route['url'], callback: Route['callback']) => this
+  put: (url: Route['url'], callback: Route['callback']) => this
+  email: (url: Route['url']) => Promise<this>
+  health: () => Promise<this>
+  job: (url: Route['url']) => Promise<this>
+  action: (url: Route['url']) => Promise<this>
+  group: (options: Prefix | RouteGroupOptions, callback: () => void) => this
+  name: (name: string) => this
+  middleware: (middleware: Route['middleware']) => this
+  getRoutes: () => Promise<Route[]>
+}

package/src/scheduler.ts

@@ -1 +1 @@
-export type { Schedule, Scheduler } from '@stacksjs/scheduler'
+export type { Schedule } from '@stacksjs/scheduler'

package/src/services.ts

@@ -35,10 +35,6 @@ export interface ServicesOptions {
     apiKey: string
     region: string
   }
-
-  novu?: {
-    key: string
-  }
 }
 
 export type ServicesConfig = Partial<ServicesOptions>

package/src/sms.ts

@@ -1,5 +1,5 @@
-import type { ISmsOptions as SmsOptions } from '@novu/stateless'
+// import type { ISmsOptions as SmsOptions } from '@novu/stateless'
 
-export type { SmsOptions }
+// export type { SmsOptions }
 
-export type SmsConfig = SmsOptions
+// export type SmsConfig = SmsOptions

package/src/request.ts

@@ -1,3 +0,0 @@
-export interface Request {
-  [key: string]: any
-}