@stacksjs/types 0.70.23 → 0.70.25

package/dist/src/storage.d.ts

@@ -0,0 +1,105 @@
+import type { Buffer } from 'node:buffer';
+import type { ReadableStream } from 'node:stream/web';
+/**
+ * File stat entry information
+ */
+export declare interface StatEntry {
+  path: string
+  type: 'file' | 'directory'
+  visibility: Visibility
+  size: number
+  lastModified: number
+  mimeType?: string
+  metadata?: Record<string, any>
+}
+/**
+ * Directory listing entry
+ */
+export declare interface DirectoryEntry {
+  path: string
+  type: 'file' | 'directory'
+}
+/**
+ * Directory listing iterator
+ */
+export declare interface DirectoryListing extends AsyncIterable<DirectoryEntry> {
+  [Symbol.asyncIterator](): AsyncIterator<DirectoryEntry>
+}
+/**
+ * Options for generating public URLs
+ */
+export declare interface PublicUrlOptions {
+  domain?: string
+}
+/**
+ * Options for generating temporary URLs
+ */
+export declare interface TemporaryUrlOptions {
+  expiresIn: number | Date
+}
+/**
+ * Checksum algorithm options
+ */
+export declare interface ChecksumOptions {
+  algorithm?: 'md5' | 'sha1' | 'sha256'
+}
+/**
+ * MIME type detection options
+ */
+export declare interface MimeTypeOptions {
+  useExtension?: boolean
+}
+export declare interface StorageOptions {
+  driver: 's3' | 'efs' | 'local' | 'bun' | 'memory'
+  root?: string
+  s3?: {
+    bucket: string
+    region?: string
+    prefix?: string
+    credentials?: {
+      accessKeyId: string
+      secretAccessKey: string
+    }
+    endpoint?: string
+  }
+  publicUrl?: {
+    domain?: string
+  }
+  defaultVisibility?: Visibility
+}
+export declare interface StorageDriver {
+  list: (path: string, options?: any) => DirectoryListing
+  changeVisibility: (path: string, visibility: Visibility) => Promise<void>
+  visibility: (path: string) => Promise<Visibility>
+  fileExists: (path: string) => Promise<boolean>
+  directoryExists: (path: string) => Promise<boolean>
+  publicUrl: (path: string, options: PublicUrlOptions) => Promise<string>
+  temporaryUrl: (path: string, options: TemporaryUrlOptions) => Promise<string>
+  checksum: (path: string, options: ChecksumOptions) => Promise<string>
+  mimeType: (path: string, options: MimeTypeOptions) => Promise<string>
+  lastModified: (path: string) => Promise<number>
+  fileSize: (path: string) => Promise<number>
+  read: (path: string) => Promise<FileContents>
+  readToString: (path: string) => Promise<string>
+  readToBuffer: (path: string) => Promise<Buffer>
+  readToUint8Array: (path: string) => Promise<Uint8Array>
+  deleteFile: (path: string) => Promise<void>
+  copyFile: (from: string, to: string) => Promise<void>
+  moveFile: (from: string, to: string) => Promise<void>
+  stat: (path: string) => Promise<StatEntry>
+  createDirectory: (path: string) => Promise<void>
+  write: (path: string, contents: FileContents) => Promise<void>
+}
+/**
+ * File contents can be a string, Buffer, Uint8Array, or ReadableStream
+ */
+export type FileContents = string | Buffer | Uint8Array | ReadableStream;
+/**
+ * Visibility options for files
+ */
+export type Visibility = 'public' | 'private';
+export type StorageConfig = Partial<StorageOptions>;
+/**
+ * Filesystem configuration (Laravel-style alias)
+ */
+export type FilesystemsConfig = StorageConfig;

package/dist/src/table-names.d.ts

@@ -0,0 +1 @@
+export type TableNames = 'tags' | 'taggables' | 'categorizables' | 'comments' | 'commentables' | 'commentable_upvotes' | 'passkeys' | 'password_resets' | 'query_logs' | 'migrations' | 'tags' | 'payment_products' | 'failed_jobs' | 'social_posts' | 'payment_methods' | 'campaigns' | 'payment_transactions' | 'requests' | 'activities' | 'email_lists' | 'notifications' | 'jobs' | 'logs' | 'subscriptions' | 'errors' | 'comments' | 'users' | 'websockets' | 'pages' | 'authors' | 'posts' | 'print_devices' | 'categories' | 'payments' | 'drivers' | 'waitlist_products' | 'digital_deliveries' | 'manufacturers' | 'order_items' | 'shipping_zones' | 'customers' | 'products' | 'receipts' | 'product_variants' | 'license_keys' | 'waitlist_restaurants' | 'reviews' | 'product_units' | 'gift_cards' | 'orders' | 'coupons' | 'tax_rates' | 'transactions' | 'loyalty_points' | 'loyalty_rewards' | 'shipping_methods' | 'shipping_rates' | 'carts' | 'delivery_routes' | 'cart_items' | 'subscribers' | 'subscriber_emails';

package/dist/src/tables.d.ts

@@ -0,0 +1,34 @@
+import type { Hits, SearchResponse } from 'meilisearch';
+/**
+ * the TableStore interface is primarily used to unify the persisting of data to localStorage
+ */
+export declare interface TableStore {
+  index: string
+  results?: SearchResponse<Record<string, any>>
+  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
+  currentPage: number
+}

package/dist/src/team.d.ts

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

package/dist/src/ui.d.ts

@@ -0,0 +1,55 @@
+// Local mirror of crosswind's `Options` shape so we don't bring crosswind
+// into @stacksjs/types as a hard dependency. Apps that import these types
+// only need the structural surface (shortcuts/theme/variants); when full
+// crosswind type fidelity is needed, projects can import directly from
+// `crosswind`.
+declare interface CrosswindOptions {
+  shortcuts?: unknown
+  theme?: unknown
+  variants?: unknown
+  [key: string]: unknown
+}
+export declare interface FontInfo {
+  title: string
+  text: string
+}
+export declare 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 declare interface UiOptions {
+  shortcuts: Shortcuts
+  safelist: string
+  trigger?: string
+  classPrefix?: string
+  hashFn?: (str: string) => string
+  reset?: ResetPreset
+  fonts?: any
+  useWebFonts?: boolean | WebFontsProviders
+  icons: Icon | Icon[]
+  theme: CrosswindOptions['theme']
+  variants: CrosswindOptions['variants']
+}
+export type Font = 'inter' | 'mona' | 'hubot';
+export type Icon = 'heroicons' | 'hugeicons';
+export type WebFontsProviders = 'google' | 'bunny' | 'fontshare';
+export type Shortcuts = CrosswindOptions['shortcuts'];
+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/src/utils.d.ts

@@ -0,0 +1,39 @@
+/**
+ * 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,11 +1,11 @@
 {
   "name": "@stacksjs/types",
   "type": "module",
-  "version": "0.70.23",
+  "version": "0.70.25",
   "description": "The Stacks framework types.",
   "author": "Chris Breuer",
   "contributors": [
-    "Chris Breuer <chris@stacksjs.org>"
+    "Chris Breuer <chris@stacksjs.com>"
   ],
   "license": "MIT",
   "funding": "https://github.com/sponsors/chrisbbreuer",
@@ -26,6 +26,7 @@
   ],
   "exports": {
     ".": {
+      "bun": "./src/index.ts",
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
     },
@@ -43,35 +44,15 @@
     "typecheck": "bun tsc --noEmit",
     "prepublishOnly": "bun run build"
   },
+  "dependencies": {
+    "@stacksjs/bunpress": "^0.1.4",
+    "@stacksjs/ts-validation": "^0.4.10",
+    "bun-query-builder": "^0.1.18"
+  },
   "devDependencies": {
-    "@mdit-vue/plugin-component": "^2.1.3",
-    "@mdit-vue/plugin-frontmatter": "^2.1.3",
-    "@mdit-vue/types": "^2.1.0",
-    "@rollup/pluginutils": "^5.1.4",
-    "@stacksjs/validation": "0.70.22",
-    "@types/aws4": "^1.11.6",
-    "@types/bun": "^1.2.8",
-    "@types/crypto-js": "^4.2.2",
-    "@types/fs-extra": "^11.0.4",
-    "@types/markdown-it-link-attributes": "^3.0.5",
-    "@types/minimatch": "^5.1.2",
-    "@types/nprogress": "^0.2.3",
-    "@vinejs/vine": "^3.0.1",
-    "aws-cdk-lib": "^2.187.0",
-    "cac": "^6.7.14",
-    "markdown-it": "^14.1.0",
-    "meilisearch": "^0.49.0",
-    "neverthrow": "^8.2.0",
-    "ora": "^8.2.0",
-    "typescript": "^5.8.2",
-    "unocss": "66.0.0",
-    "unplugin-auto-import": "^19.1.2",
-    "unplugin-vue-components": "^28.4.1",
-    "vite": "^6.2.4",
-    "vite-plugin-inspect": "^11.0.0",
-    "vite-plugin-pwa": "^1.0.0",
-    "vite-ssg": "^26.1.1",
-    "vitepress": "1.6.3",
-    "vue": "^3.5.13"
-  }
+    "@stacksjs/validation": "0.70.23",
+    "@types/bun": "^1.3.11",
+    "typescript": "^5.9.3"
+  },
+  "sideEffects": false
 }

package/src/ai.ts

@@ -1,15 +1,29 @@
 type AiModel =
+  // Amazon Titan
   | 'amazon.titan-embed-text-v1'
+  | 'amazon.titan-embed-text-v2:0'
   | 'amazon.titan-text-lite-v1'
   | 'amazon.titan-text-express-v1'
+  | 'amazon.titan-text-premier-v1:0'
   | 'amazon.titan-embed-image-v1'
   | 'amazon.titan-image-generator-v1'
-  | 'anthropic.claude-v1'
-  | 'anthropic.claude-v2'
-  | 'anthropic.claude-v2:1'
-  | 'anthropic.claude-instant-v1'
-  | 'meta.llama2-13b-chat-v1'
-  | 'meta.llama2-70b-chat-v1'
+  | 'amazon.titan-image-generator-v2:0'
+  // Anthropic Claude (current models via Bedrock)
+  | 'anthropic.claude-sonnet-4-20250514-v1:0'
+  | 'anthropic.claude-haiku-4-20250514-v1:0'
+  | 'anthropic.claude-3-5-sonnet-20241022-v2:0'
+  | 'anthropic.claude-3-5-haiku-20241022-v1:0'
+  | 'anthropic.claude-3-opus-20240229-v1:0'
+  | 'anthropic.claude-3-sonnet-20240229-v1:0'
+  | 'anthropic.claude-3-haiku-20240307-v1:0'
+  // Meta Llama 3
+  | 'meta.llama3-8b-instruct-v1:0'
+  | 'meta.llama3-70b-instruct-v1:0'
+  | 'meta.llama3-1-8b-instruct-v1:0'
+  | 'meta.llama3-1-70b-instruct-v1:0'
+  | 'meta.llama3-1-405b-instruct-v1:0'
+  // Allow custom model strings
+  | (string & {})
 
 /**
  * **AI Options**

package/src/analytics.ts

@@ -6,14 +6,51 @@
  * have any questions, feel free to reach out via Discord or GitHub Discussions.
  */
 export interface AnalyticsOptions {
-  driver: 'google-analytics' | 'fathom'
+  /** The analytics driver/provider to use */
+  driver: 'google-analytics' | 'fathom' | 'plausible' | 'self-hosted'
 
   drivers: {
+    /** Google Analytics configuration */
     googleAnalytics?: {
+      /** GA4 Measurement ID (e.g., G-XXXXXXXXXX) */
       trackingId: string
+      /** Enable debug mode */
+      debug?: boolean
     }
+    /** Fathom Analytics configuration (privacy-focused) */
     fathom?: {
+      /** Fathom site ID */
       siteId: string
+      /** Custom script URL */
+      scriptUrl?: string
+      /** Honor Do Not Track browser setting */
+      honorDnt?: boolean
+      /** Enable SPA mode for client-side routing */
+      spa?: boolean
+    }
+    /** Plausible Analytics configuration (privacy-focused, open source) */
+    plausible?: {
+      /** Your domain (e.g., example.com) */
+      domain: string
+      /** Custom script URL (for self-hosted Plausible) */
+      scriptUrl?: string
+      /** Track localhost during development */
+      trackLocalhost?: boolean
+      /** Enable hash-based routing */
+      hashMode?: boolean
+    }
+    /** Self-hosted analytics configuration (using Stacks Analytics / dynamodb-tooling) */
+    selfHosted?: {
+      /** Site ID for tracking */
+      siteId: string
+      /** API endpoint URL for collecting analytics (e.g., https://api.example.com/analytics) */
+      apiEndpoint: string
+      /** Honor Do Not Track browser setting */
+      honorDnt?: boolean
+      /** Track hash changes as page views */
+      trackHashChanges?: boolean
+      /** Track outbound link clicks */
+      trackOutboundLinks?: boolean
     }
   }
 }

package/src/app.ts

@@ -83,6 +83,23 @@ export interface AppOptions {
    */
   maintenanceMode: boolean
 
+  /**
+   * **Coming Soon Mode**
+   *
+   * When enabled, public web requests can render a launch screen while
+   * optionally allowing preview access through a secret bypass.
+   *
+   * @default false
+   */
+  comingSoonMode?: boolean
+
+  /**
+   * **Coming Soon Secret**
+   *
+   * Optional preview token used to bypass coming soon mode.
+   */
+  comingSoonSecret?: string
+
   /**
    * **Encryption Key**
    *
@@ -146,6 +163,27 @@ export interface AppOptions {
    * @default false
    */
   docMode: boolean
+
+  /**
+   * **Primary Brand Color**
+   *
+   * The primary color used for branding in emails and UI components.
+   * Should be a valid CSS color value (hex, rgb, etc.)
+   *
+   * @default "#3b82f6"
+   * @example "#3b82f6"
+   */
+  primaryColor: string
+
+  /**
+   * **Support Email**
+   *
+   * The email address users should contact for support.
+   * Used in transactional emails and error messages.
+   *
+   * @example "support@example.com"
+   */
+  supportEmail: string
 }
 
 export type AppConfig = Partial<AppOptions>

package/src/attributes.ts

@@ -1 +1,5 @@
-export * from '../../../types/attributes'
+// Project-generated `Attributes` interface lives at
+// `storage/framework/types/attributes.ts` (one big union of every model's
+// fillable column). Re-export type-only so Bun's runtime resolver doesn't
+// try to load the file from the shipped `@stacksjs/types` package.
+export type * from '../../../types/attributes'

package/src/auth.ts

@@ -0,0 +1,122 @@
+export interface AuthOptions {
+  /**
+   * The default authentication guard to use
+   */
+  default: string
+
+  /**
+   * The authentication guards available
+   */
+  guards: {
+    [key: string]: {
+      /**
+       * The authentication driver to use
+       */
+      driver: 'session' | 'token'
+
+      /**
+       * The authentication provider to use
+       */
+      provider: string
+    }
+  }
+
+  /**
+   * The authentication providers available
+   */
+  providers: {
+    [key: string]: {
+      /**
+       * The database driver to use
+       */
+      driver: 'database'
+
+      /**
+       * The database table to use
+       */
+      table: string
+    }
+  }
+
+  /**
+   * The username field used for authentication
+   */
+  username: string
+
+  /**
+   * The password field used for authentication
+   */
+  password: string
+
+  /**
+   * The access-token expiry time in milliseconds. Defaults to 1 hour —
+   * the matching refresh token below covers the longer-lived window.
+   */
+  tokenExpiry: number
+
+  /**
+   * The refresh-token expiry time in milliseconds. Defaults to 30 days.
+   * Refresh tokens are single-use and rotate on every refresh exchange.
+   */
+  refreshTokenExpiry?: number
+
+  /**
+   * The token rotation time in hours
+   */
+  tokenRotation: number
+
+  /**
+   * The token abilities that are granted by default
+   */
+  defaultAbilities: string[]
+
+  /**
+   * The token name used when creating new tokens
+   */
+  defaultTokenName: string
+
+  /**
+   * Password reset configuration
+   */
+  passwordReset: {
+    /**
+     * Token expiration time in minutes
+     * @default 60
+     */
+    expire: number
+
+    /**
+     * Throttle time in seconds between password reset requests
+     * @default 60
+     */
+    throttle: number
+  }
+}
+
+export type AuthConfig = Partial<AuthOptions>
+
+export interface AuthInstance {
+  guard: string
+  provider: string
+  user?: any
+  token?: string
+}
+
+export type GuardType = 'session' | 'token'
+export type ProviderType = 'database'
+
+export interface AuthDriver {
+  attempt: (credentials: any) => Promise<boolean>
+  validate: (token: string) => Promise<boolean>
+  login: (credentials: any) => Promise<{ token: string } | null>
+  logout: () => Promise<void>
+  user: () => Promise<any>
+  token: () => string | null
+}
+
+export interface Authenticatable {
+  getAuthIdentifier: () => any
+  getAuthPassword: () => string
+  getRememberToken: () => string
+  setRememberToken: (token: string) => void
+}

package/src/auto-imports.ts

@@ -1 +1,8 @@
-export type { Options as AutoImportsOptions } from 'unplugin-auto-import/types'
+// `unplugin-auto-import` isn't a runtime dependency of @stacksjs/types — we
+// only re-publish its option shape so users get autocomplete in user-land
+// configs. The local type intentionally mirrors the upstream `Options`
+// surface as an open record; if/when this package adopts unplugin-auto-import
+// as a real dependency, swap this for `import type { Options }` from there.
+export interface AutoImportsOptions {
+  [key: string]: unknown
+}