@stacksjs/types 0.58.72 → 0.59.1

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.72",
+  "version": "0.59.1",
   "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.5",
+    "@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.18.2",
+    "vite-plugin-pwa": "^0.19.2",
     "vite-ssg": "^0.23.6",
-    "vitepress": "1.0.0-rc.42",
-    "vue": "^3.4.19"
+    "vitepress": "1.0.0-rc.44",
+    "vue": "^3.4.21"
   },
   "devDependencies": {
-    "aws-cdk-lib": "^2.128.0",
+    "aws-cdk-lib": "^2.131.0",
     "typescript": "^5.3.3"
   }
 }

package/src/app.ts

@@ -1,17 +1,5 @@
 export type AppEnvType = 'local' | 'dev' | 'stage' | 'prod' | string
 
-interface Ports {
-  frontend: number
-  backend: number // proxies api
-  api: number // the Bun server
-  admin: number
-  library: number
-  desktop: number
-  email: number
-  docs: number
-  inspect: number
-}
-
 /**
  * **Application Options**
  *
@@ -104,15 +92,6 @@ export interface AppOptions {
    */
   key: string
 
-  /**
-   * **Application Ports**
-   *
-   * This port is used by the Stacks servers when running your application, library, email services,
-   * and other services. You may change this port to any other port that is free
-   * on your machine, as long as the following 6 ports are also available.
-   */
-  ports: Ports
-
   /**
    * **Application Timezone**
    *

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

@@ -1,4 +1,5 @@
 import type { BunFile } from 'bun'
+import type { Ports } from './ports'
 
 type ArrayBufferView = NodeJS.TypedArray | DataView
 
@@ -121,6 +122,16 @@ export interface CliOptions {
    */
   silent?: boolean
 
+  /**
+   * **Quiet Mode**
+   *
+   * When you are using "quiet"-mode, the CLI will output minimally
+   * to the console.
+   *
+   * @default false
+   */
+  quiet?: boolean
+
   /**
    * **Current Work Directory**
    *
@@ -163,7 +174,7 @@ export interface CliOptions {
 
   input?: string | ArrayBufferView | ReadableStream | Blob | Response | Request
 
-  quiet?: boolean
+  project?: string // TODO: can create an action that automates creating a type for this
 }
 
 export type CliConfig = CliOptions
@@ -207,7 +218,7 @@ export type DevOptions = {
   [key in DevOption]: boolean;
 } & CliOptions
 
-export type GeneratorOption = 'types' | 'entries' | 'webTypes' | 'customData' | 'ideHelpers' | 'componentMeta'
+export type GeneratorOption = 'types' | 'entries' | 'webTypes' | 'customData' | 'ideHelpers' | 'componentMeta' | 'coreSymlink' | 'pkgxConfig'
 export type GeneratorOptions = {
   [key in GeneratorOption]?: boolean;
 } & CliOptions
@@ -225,7 +236,8 @@ export type MakeOptions = {
   [key in MakeStringOption]: string
 } & CliOptions
 
-export type UpgradeBoolean = 'framework' | 'dependencies' | 'packageManager' | 'node' | 'all' | 'force'
+export type UpgradeBoolean = 'framework' | 'dependencies' | 'bun' | 'shell' | 'binary' | 'all' | 'force'
+
 export type UpgradeString = 'version'
 
 export type UpgradeOptions = {
@@ -305,8 +317,14 @@ export interface InstallOptions extends CliOptions { }
 export interface ReleaseOptions extends CliOptions {
   dryRun?: boolean
 }
+export interface ProjectsOptions extends CliOptions {
+  list?: boolean
+}
 export interface PreinstallOptions extends CliOptions { }
 export interface PrepublishOptions extends CliOptions { }
+export interface PortsOptions extends CliOptions {
+  ports?: Partial<Ports>
+}
 export interface TinkerOptions extends CliOptions { }
 export interface TypesOptions 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/email.ts

@@ -2,12 +2,15 @@ import type { IEmailOptions } from '@novu/stateless'
 
 export type EmailOptions = Omit<IEmailOptions, 'from'> & {
   from: {
-    name?: string
-    address?: string
+    name: string
+    address: string
   }
 
   mailboxes: string[]
 
+  url: string
+  charset: string // e.g. UTF-8
+
   server: {
     scan?: boolean
   }

package/src/index.ts

@@ -37,12 +37,12 @@ export * from './money'
 export * from './notifications'
 export * from './pages'
 export * from './payments'
+export * from './ports'
 export * from './promise'
 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/ports.ts

@@ -0,0 +1,19 @@
+/**
+ * **Stacks Ports**
+ *
+ * This port is used by the Stacks servers when running your application, library, email services,
+ * and other services. You may change this port to any other port that is free
+ * on your machine, as long as the following 6 ports are also available.
+ */
+export interface Ports {
+  frontend: number
+  backend: number // proxies api
+  admin: number
+  library: number
+  desktop: number
+  email: number
+  docs: number
+  inspect: number
+  api: number // the bun server
+  systemTray: number
+}

package/src/router.ts

@@ -1,4 +1,5 @@
 import type { Action } from '@stacksjs/actions'
+import type { ActionPath } from '~/storage/framework/types/actions'
 
 export interface NitroEventHandler {
   /**
@@ -36,23 +37,22 @@ 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 | ActionName | Action | Promise<any> // we may be able to improve the `Promise<any>` if we could narrow this type `import('../app/Actions/BuddyAction')`
+  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')`
   paramNames: string[]
   middleware?: string | string[]
   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/stacks.ts

@@ -15,6 +15,7 @@ import type {
   LoggerConfig,
   NotificationConfig,
   PaymentConfig,
+  Ports,
   QueueConfig,
   SearchEngineConfig,
   SecurityConfig,
@@ -169,6 +170,15 @@ export interface StacksOptions {
    */
   payment: PaymentConfig
 
+  /**
+   * **Ports**
+   *
+   * This configuration defines all of your Ports 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.
+   */
+  ports: Ports
+
   /**
    * **Queue Options**
    *

package/src/request.ts

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