@stacksjs/types 0.64.6 → 0.65.0

package/dist/ssg.d.ts

@@ -0,0 +1,2 @@
+import type { ViteSSGContext } from ".";
+export type UserModule = (ctx: ViteSSGContext) => void;

package/dist/stacks.d.ts

@@ -0,0 +1,204 @@
+import type { AiConfig, AnalyticsConfig, AppConfig, BinaryConfig, CacheConfig, CloudConfig, DatabaseConfig, DnsConfig, DocsConfig, EmailConfig, ErrorConfig, GitConfig, HashingConfig, LibraryConfig, LoggingConfig, NotificationConfig, PaymentConfig, Ports, QueueConfig, SearchEngineConfig, SecurityConfig, ServicesConfig, StorageConfig, Team, UiConfig } from ".";
+/**
+* **Stacks Options**
+*
+* This configuration defines all of your Stacks 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 StacksOptions {
+	ai: AiConfig;
+	/**
+	* **Analytics Options**
+	*
+	* This configuration defines all of your Analytics 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.
+	*/
+	analytics: AnalyticsConfig;
+	/**
+	* **Application Options**
+	*
+	* This configuration defines all of your Application 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.
+	*/
+	app: AppConfig;
+	/**
+	* **Cache Options**
+	*
+	* This configuration defines all of your Cache 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.
+	*/
+	cache: CacheConfig;
+	/**
+	* **CLI / Binary Options**
+	*
+	* This configuration defines all of your Binary 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.
+	*/
+	cli: BinaryConfig;
+	/**
+	* **Cloud Options**
+	*
+	* This configuration defines all of your Cloud 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.
+	*/
+	cloud: CloudConfig;
+	/**
+	* **Database Options**
+	*
+	* This configuration defines all of your Database 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.
+	*/
+	database: DatabaseConfig;
+	/**
+	* **DNS Options**
+	*
+	* This configuration defines all of your DNS 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.
+	*/
+	dns: DnsConfig;
+	/**
+	* **Docs Options**
+	*
+	* This configuration defines all of your Docs 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.
+	*/
+	docs: DocsConfig;
+	/**
+	* **Email Options**
+	*
+	* This configuration defines all of your Email 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.
+	*/
+	email: EmailConfig;
+	/**
+	* **Errors Options**
+	*
+	* This configuration defines all of your Errors 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.
+	*/
+	errors: ErrorConfig;
+	/**
+	* **Git Options**
+	*
+	* This configuration defines all of your Git 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.
+	*/
+	git: GitConfig;
+	/**
+	* **Hashing Options**
+	*
+	* This configuration defines all of your Hashing 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.
+	*/
+	hashing: HashingConfig;
+	/**
+	* **Library Options**
+	*
+	* This configuration defines all of your Library 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.
+	*/
+	library: LibraryConfig;
+	/**
+	* **Logging Options**
+	*
+	* This configuration defines all of your logging 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.
+	*/
+	logging: LoggingConfig;
+	/**
+	* **Notification Options**
+	*
+	* This configuration defines all of your Notification 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.
+	*/
+	notification: NotificationConfig;
+	/**
+	* **Payment Options**
+	*
+	* This configuration defines all of your Payment 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.
+	*/
+	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**
+	*
+	* This configuration defines all of your Queue 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.
+	*/
+	queue: QueueConfig;
+	/**
+	* **Search Engine Options**
+	*
+	* This configuration defines all of your Search Engine 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.
+	*/
+	security: SecurityConfig;
+	/**
+	* **Search Engine Options**
+	*
+	* This configuration defines all of your Search Engine 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.
+	*/
+	searchEngine: SearchEngineConfig;
+	/**
+	* **Services Options**
+	*
+	* This configuration defines all of your Services 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.
+	*/
+	services: ServicesConfig;
+	/**
+	* **Storage Options**
+	*
+	* This configuration defines all of your Storage 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.
+	*/
+	storage: StorageConfig;
+	/**
+	* **Team Members**
+	*
+	* This configuration defines all of your Team members. 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.
+	*/
+	team: Team;
+	/**
+	* **UI Options**
+	*
+	* This configuration defines all of your UI 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.
+	*/
+	ui: UiConfig;
+}
+export type StacksConfig = Partial<StacksOptions>;

package/dist/storage.d.ts

@@ -0,0 +1,12 @@
+export interface StorageOptions {
+	/**
+	* **Storage Driver**
+	*
+	* The storage driver to utilize.
+	*
+	* @default string 's3'
+	* @see https://stacksjs.org/docs/storage
+	*/
+	driver: "s3" | "efs" | "local";
+}
+export type StorageConfig = Partial<StorageOptions>;

package/dist/tables.d.ts

@@ -0,0 +1,52 @@
+import type { Hits, SearchResponse } from "meilisearch";
+/**
+* the TableStore interface is primarily used to unify the persisting of data to localStorage
+*/
+export interface TableStore {
+	/**
+	* The search engine index name.
+	* i.e. the type of table, like `users`, `posts`, `products`, etc.
+	*/
+	index: string;
+	/**
+	* The search engine results object.
+	*/
+	results?: SearchResponse<Record<string, any>>;
+	/**
+	* The search engine hits object.
+	*/
+	hits?: Hits;
+	columns: string[];
+	source?: string;
+	password?: string;
+	searchable?: string | boolean;
+	query?: string;
+	sortable?: string | boolean;
+	sort?: string;
+	sorts?: string | string[];
+	filterable?: string | boolean;
+	filters?: string | string[];
+	filterValue?: any[];
+	actionable?: string | boolean;
+	actions?: string | string[];
+	perPage: number;
+	selectable?: string | boolean;
+	selectedRows?: number[] | string[];
+	selectedAll?: boolean;
+	goToNextPage: number;
+	goToPage: number;
+	goToPrevPage: number;
+	lastPageNumber: number;
+	searchFilters?: object;
+	searchParams?: object;
+	setTotalHits: number;
+	/**
+	*
+	* The current page number
+	* @default 1
+	* @type {number}
+	* @memberof TableStore
+	* @example 1
+	*/
+	currentPage: number;
+}

package/dist/team.d.ts

@@ -0,0 +1,8 @@
+type TeamMemberName = string;
+type Email = string;
+type TeamMembers = Record<TeamMemberName, Email>;
+export interface Team {
+	name: string;
+	members?: TeamMembers;
+}
+export {};

package/dist/ui.d.ts

@@ -0,0 +1,165 @@
+import type { UserConfig } from "@unocss/core";
+import type { UserShortcuts } from "unocss";
+export type Font = "inter" | "mona" | "hubot";
+export type Icon = "heroicons";
+export type WebFontsProviders = "google" | "bunny" | "fontshare";
+export type Shortcuts = UserShortcuts;
+export interface FontInfo {
+	title: string;
+	text: string;
+}
+export interface WebFontMeta {
+	name: string;
+	weights?: (string | number)[];
+	italic?: boolean;
+	provider?: WebFontsProviders;
+}
+/**
+* **UI Engine Options**
+*
+* This type defines all of your UI Engine 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 UiOptions {
+	/**
+	* **Shortcuts**
+	*
+	* Shortcuts provide you with the ability to combine
+	* utility names for reusability purposes.
+	*
+	* @example
+	* ```
+	* config: {
+	*   shortcuts: {
+	*     'btn': 'px-4 py-2 rounded text-white bg-blue-500',
+	*     'btn-lg': 'btn px-6 py-3',
+	*   }
+	* }
+	* ```
+	*/
+	shortcuts: Shortcuts;
+	/**
+	* **Safelist**
+	*
+	* Use the `safelist` option to ensure the generation of
+	* those utility classes. This is useful when certain
+	* class names don’t exist in your content files.
+	*
+	* @example
+	* ```ts
+	* safelist: [
+	*   'btn',
+	*   'btn-lg',
+	*   'btn-blue',
+	*   'btn-blue-500',
+	* ]
+	*/
+	safelist: string;
+	/**
+	* **Trigger String**
+	*
+	* The "trigger string" defines the class name markup
+	* you want to add into your components.
+	*
+	* @default ':stx:'
+	*
+	* @example
+	* ```ts
+	* trigger: ':stx:'
+	* ```
+	*/
+	trigger?: string;
+	/**
+	* **Class Prefix**
+	*
+	* The prefix for the compiled class name. When transforming
+	* all utility classes into a single class, this prefix
+	* will be added to the generated CSS class name.
+	*
+	* @default 'stx-'
+	*
+	* @example
+	* ```ts
+	* prefix: 'stx-'
+	* ```
+	*/
+	classPrefix?: string;
+	/**
+	* **Hash Function**
+	*
+	* The hash function used to generate the class name.
+	*
+	* @example
+	* ```ts
+	* hash: (str: string) => {
+	*   return str
+	*     .split('')
+	*     .reduce((a, b) => {
+	*       a = ((a << 5) - a) + b.charCodeAt(0)
+	*       return a & a
+	*     }, 0)
+	*     .toString(36)
+	* }
+	*/
+	hashFn?: (str: string) => string;
+	/**
+	* **CSS Resets—Preset**
+	*
+	* Define a standard of reset CSS stylesheets. By default, the Tailwind
+	* reset styles are utilized. You may set this value to `null`
+	* if you prefer not applying any default stylesheets.
+	*
+	* @url https://www.npmjs.com/package/@unocss/reset
+	* @todo preset needs to be added via a Vite plugin on development & build
+	* @example
+	* ```ts
+	* reset: 'tailwind'
+	* ```
+	*/
+	reset?: ResetPreset;
+	/**
+	* **Fonts**
+	*
+	* Define the fonts you want to use. By default, Stacks provides support
+	* for several local font providers. You may set this value to
+	* `null` if you prefer not utilize any local fonts.
+	*
+	* @see https://stacksjs.org/docs/fonts
+	* ```
+	*/
+	fonts?: any;
+	useWebFonts?: boolean | WebFontsProviders;
+	/**
+	* **Icon Sets**
+	*
+	* This value defines the icon sets you want to use. When using icons, they
+	* are displayed utilizing a technique called "icons in pure css."
+	* Learn more here https://antfu.me/posts/icons-in-pure-css.
+	*
+	* @see https://stacks.ow3.org/config/icons — list of available icon sets
+	* @todo implement this into Vite build flow
+	* @example
+	* ```ts
+	* icons: ['heroicons']
+	* ```
+	* @example
+	* ```html
+	* <i class="i-heroicons-outline-book-open w-8 h-8 text-gray-500" aria-hidden="true" />
+	* ```
+	*/
+	icons: Icon | Icon[];
+	theme: UserConfig["theme"];
+	variants: UserConfig["variants"];
+	layers: UserConfig["layers"];
+}
+export type UiConfig = Partial<UiOptions>;
+/**
+* **Style Reset — Preset**
+*
+* This value sets the "reset preset." A preset defines certain
+* CSS defaults to be applied.
+*
+* @default "tailwind"
+*/
+export type ResetPreset = "tailwind" | "normalize" | "sanitize" | "eric-meyer" | "antfu" | null;

package/dist/utils.d.ts

@@ -0,0 +1,30 @@
+/**
+* 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,9 +1,12 @@
 {
   "name": "@stacksjs/types",
   "type": "module",
-  "version": "0.64.6",
+  "version": "0.65.0",
   "description": "The Stacks framework types.",
   "author": "Chris Breuer",
+  "contributors": [
+    "Chris Breuer <chris@stacksjs.org>"
+  ],
   "license": "MIT",
   "funding": "https://github.com/sponsors/chrisbbreuer",
   "homepage": "https://github.com/stacksjs/stacks/tree/main/stacks/types#readme",
@@ -31,27 +34,24 @@
   },
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
-  "contributors": [
-    "Chris Breuer <chris@stacksjs.org>"
-  ],
   "files": [
     "README.md",
     "dist",
     "src"
   ],
   "scripts": {
-    "build": "bun --bun build.ts",
-    "typecheck": "bun --bun tsc --noEmit",
+    "build": "bun build.ts",
+    "typecheck": "bun tsc --noEmit",
     "prepublishOnly": "bun run build"
   },
   "dependencies": {
     "@mdit-vue/plugin-component": "^2.1.3",
     "@mdit-vue/plugin-frontmatter": "^2.1.3",
     "@mdit-vue/types": "^2.1.0",
-    "@rollup/pluginutils": "^5.1.0",
-    "@stacksjs/validation": "latest",
+    "@rollup/pluginutils": "^5.1.2",
+    "@stacksjs/validation": "0.64.6",
     "@types/aws4": "^1.11.6",
-    "@types/bun": "^1.1.8",
+    "@types/bun": "^1.1.11",
     "@types/crypto-js": "^4.2.2",
     "@types/fs-extra": "^11.0.4",
     "@types/markdown-it-link-attributes": "^3.0.5",
@@ -60,21 +60,21 @@
     "@vinejs/vine": "^2.1.0",
     "cac": "^6.7.14",
     "markdown-it": "^14.1.0",
-    "meilisearch": "^0.42.0",
-    "neverthrow": "^7.0.1",
+    "meilisearch": "^0.44.1",
+    "neverthrow": "^8.0.0",
     "ora": "^8.1.0",
-    "unocss": "0.62.3",
-    "unplugin-auto-import": "^0.18.2",
+    "unocss": "0.61.0",
+    "unplugin-auto-import": "^0.18.3",
     "unplugin-vue-components": "^0.27.4",
-    "vite": "^5.4.2",
+    "vite": "^5.4.8",
     "vite-plugin-inspect": "^0.8.7",
-    "vite-plugin-pwa": "^0.20.1",
+    "vite-plugin-pwa": "^0.20.5",
     "vite-ssg": "^0.23.8",
-    "vitepress": "1.3.4",
-    "vue": "^3.4.38"
+    "vitepress": "1.4.0",
+    "vue": "^3.5.11"
   },
   "devDependencies": {
-    "aws-cdk-lib": "^2.154.1",
-    "typescript": "^5.5.4"
+    "aws-cdk-lib": "^2.161.1",
+    "typescript": "^5.6.3"
   }
 }

package/src/api.ts

@@ -31,12 +31,12 @@ export interface ApiOptions {
 
   routes:
     | {
-        index: boolean
-        show: boolean
-        store: boolean
-        update: boolean
-        destroy: boolean
-      }
+      index: boolean
+      show: boolean
+      store: boolean
+      update: boolean
+      destroy: boolean
+    }
     | boolean
 
   /**

package/src/app.ts

@@ -1,4 +1,4 @@
-export type AppEnvType = 'local' | 'dev' | 'stage' | 'prod' | string
+export type AppEnvType = 'local' | 'dev' | 'stage' | 'prod' | 'testing' | string
 
 /**
  * **Application Options**

package/src/chat.ts

@@ -1,4 +1,4 @@
-type ChatOptions = {}
+interface ChatOptions {}
 export type { ChatOptions }
 
 export type ChatConfig = ChatOptions

package/src/cli.ts

@@ -3,7 +3,7 @@ import type { Ports } from './ports'
 
 type ArrayBufferView = NodeJS.TypedArray | DataView
 
-export type { Subprocess, SyncSubprocess } from 'bun'
+export type { ErrorLike, SpawnOptions, Subprocess, SyncSubprocess } from 'bun'
 export type Readable =
   | 'pipe'
   | 'inherit'
@@ -194,7 +194,7 @@ export type ActionOptions = {
   count?: number
   dryRun?: boolean // used in buddy release
 } & CliOptions &
-  DomainsOptions
+DomainsOptions
 
 export type BuildOption =
   | 'components'
@@ -256,8 +256,10 @@ export type GeneratorOption =
   | 'ideHelpers'
   | 'componentMeta'
   | 'coreSymlink'
+  | 'openApiSpec'
   | 'pkgxConfig'
   | 'openapi'
+  | 'modelFiles'
 export type GeneratorOptions = {
   [key in GeneratorOption]?: boolean
 } & CliOptions
@@ -303,7 +305,9 @@ export type ExamplesOptions = {
   [key in ExamplesBoolean]: boolean
 } & CliOptions
 export type TestOptions = CliOptions & {
-  showReport?: boolean
+  ui?: boolean
+  feature?: boolean
+  unit?: boolean
 }
 export type DomainsOptions = CliOptions & {
   domain?: string

package/src/cloud.ts

@@ -261,7 +261,7 @@ export interface CloudOptions {
 
   api: ApiConfig
 
-  storage: {}
+  storage: object
 
   /**
    * **Firewall Settings**

package/src/cron-jobs.ts

@@ -9,6 +9,7 @@ export interface JobOptions {
    */
   name?: string
 
+  // eslint-disable-next-line ts/no-unsafe-function-type
   handle?: string | Function
   action?: string
   description?: string

package/src/deploy.ts

@@ -13,4 +13,5 @@ export interface DeployOptions extends CliOptions {
   prod?: boolean
   dev?: boolean
   staging?: boolean
+  yes?: boolean
 }