@stacksjs/types 0.58.72 → 0.58.73

package/dist/index.js

@@ -28,7 +28,7 @@ var __export = (target, all) => {
 var __esm = (fn, res) => () => (fn && (res = fn(fn = 0)), res);
 var __require = createRequire(import.meta.url);
 
-// /home/runner/work/stacks/stacks/node_modules/consola/dist/core.mjs
+// ../../../../node_modules/consola/dist/core.mjs
 class Consola {
   constructor(options = {}) {
     const types = options.types || LogTypes;
@@ -409,7 +409,7 @@ var init_core = __esm(() => {
   Consola.prototype.resume = Consola.prototype.resumeLogs;
 });
 
-// /home/runner/work/stacks/stacks/node_modules/consola/dist/shared/consola.06ad8a64.mjs
+// ../../../../node_modules/consola/dist/shared/consola.06ad8a64.mjs
 import {formatWithOptions} from "node:util";
 import {sep} from "node:path";
 
@@ -469,7 +469,7 @@ var init_consola_06ad8a64 = __esm(() => {
   bracket = (x) => x ? `[${x}]` : "";
 });
 
-// /home/runner/work/stacks/stacks/node_modules/consola/dist/utils.mjs
+// ../../../../node_modules/consola/dist/utils.mjs
 import * as tty from "node:tty";
 var replaceClose, clearBleed, filterEmpty, init, createColors, getColor, stripAnsi, box, env, argv, platform, isDisabled, isForced, isWindows, isDumbTerminal, isCompatibleTerminal, isCI, isColorSupported, colorDefs, colors, ansiRegex, boxStylePresets, defaultStyle;
 var init_utils = __esm(() => {
@@ -682,7 +682,7 @@ var init_utils = __esm(() => {
   };
 });
 
-// /home/runner/work/stacks/stacks/node_modules/consola/dist/chunks/prompt.mjs
+// ../../../../node_modules/consola/dist/chunks/prompt.mjs
 var exports_prompt = {};
 __export(exports_prompt, {
   prompt: () => {
@@ -1440,7 +1440,7 @@ ${colors.cyan(S_BAR_END)}
   };
 });
 
-// /home/runner/work/stacks/stacks/node_modules/consola/dist/shared/consola.36c0034f.mjs
+// ../../../../node_modules/consola/dist/shared/consola.36c0034f.mjs
 import process$1 from "node:process";
 
 class FancyReporter extends BasicReporter {
@@ -1792,7 +1792,7 @@ var init_consola_36c0034f = __esm(() => {
   consola = createConsola2();
 });
 
-// /home/runner/work/stacks/stacks/node_modules/slugify/slugify.js
+// ../../../../node_modules/slugify/slugify.js
 var require_slugify = __commonJS((exports, module) => {
   (function(name, root, factory) {
     if (typeof exports === "object") {
@@ -1843,7 +1843,7 @@ var require_slugify = __commonJS((exports, module) => {
   });
 });
 
-// /home/runner/work/stacks/stacks/node_modules/pluralize/pluralize.js
+// ../../../../node_modules/pluralize/pluralize.js
 var require_pluralize = __commonJS((exports, module) => {
   (function(root, pluralize) {
     if (typeof __require === "function" && typeof exports === "object" && typeof module === "object") {
@@ -2207,14 +2207,14 @@ var ExitCode;
   ExitCode2[ExitCode2["FatalError"] = 1] = "FatalError";
   ExitCode2[ExitCode2["InvalidArgument"] = 9] = "InvalidArgument";
 })(ExitCode || (ExitCode = {}));
-// /home/runner/work/stacks/stacks/node_modules/consola/dist/index.mjs
+// ../../../../node_modules/consola/dist/index.mjs
 init_consola_36c0034f();
 init_core();
 init_consola_06ad8a64();
 init_utils();
-// /home/runner/work/stacks/stacks/storage/framework/core/strings/src/utils.ts
+// ../strings/src/utils.ts
 var import_slugify = __toESM(require_slugify(), 1);
-// /home/runner/work/stacks/stacks/node_modules/title-case/dist/index.js
+// ../../../../node_modules/title-case/dist/index.js
 var WORD_SEPARATORS = new Set(["\u2014", "\u2013", "-", "\u2015", "/"]);
 var SENTENCE_TERMINATORS = new Set([".", "!", "?"]);
 var TITLE_TERMINATORS = new Set([
@@ -2262,9 +2262,9 @@ var SMALL_WORDS = new Set([
   "without",
   "yet"
 ]);
-// /home/runner/work/stacks/stacks/storage/framework/core/strings/src/pluralize.ts
+// ../strings/src/pluralize.ts
 var pluralize = __toESM(require_pluralize(), 1);
-// /home/runner/work/stacks/stacks/storage/framework/core/strings/src/helpers.ts
+// ../strings/src/helpers.ts
 function toString(v2) {
   return Object.prototype.toString.call(v2);
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/types",
   "type": "module",
-  "version": "0.58.72",
+  "version": "0.58.73",
   "description": "The Stacks framework types.",
   "author": "Chris Breuer",
   "license": "MIT",
@@ -56,7 +56,7 @@
     "@stacksjs/validation": "latest",
     "@types/aws4": "^1.11.6",
     "@types/bcryptjs": "^2.4.6",
-    "@types/bun": "^1.0.5",
+    "@types/bun": "^1.0.6",
     "@types/crypto-js": "^4.2.2",
     "@types/eslint": "^8.56.2",
     "@types/fs-extra": "^11.0.4",
@@ -75,9 +75,9 @@
     "unplugin-vue-components": "^0.26.0",
     "vite": "^5.1.3",
     "vite-plugin-inspect": "^0.8.3",
-    "vite-plugin-pwa": "^0.18.2",
+    "vite-plugin-pwa": "^0.19.0",
     "vite-ssg": "^0.23.6",
-    "vitepress": "1.0.0-rc.42",
+    "vitepress": "1.0.0-rc.44",
     "vue": "^3.4.19"
   },
   "devDependencies": {

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/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 CheckOptions extends CliOptions {
+  ports?: Partial<Ports>
+}
 export interface TinkerOptions extends CliOptions { }
 export interface TypesOptions extends CliOptions { }
 

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

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,14 +37,13 @@ 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

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**
    *