@stacksjs/types 0.70.86 → 0.70.88

package/dist/stack-extensions.d.ts

@@ -1,137 +0,0 @@
-/**
- * The central registry of known stack extensions.
- *
- * Third-party stack authors: submit a PR to add your stack here.
- * Once merged, all Stacks users will get autocomplete for your stack name.
- */
-export declare const stackExtensionRegistry: Record<string, StackRegistryEntry>;
-// ─── Stack Extensions Registry ──────────────────────────────────────────────
-//
-// This is the central registry of known stack extensions. Third-party authors
-// can submit a PR to add their stack here. Once merged, all Stacks users get
-// autocomplete and type safety for the new stack name.
-//
-// To add your stack, add a new entry below following the pattern:
-//   'your-stack-name': { package: '@your-org/your-stack', description: '...' },
-//
-// Requirements for PRs:
-//   - The package must be published to npm
-//   - The package.json must contain a valid `stacks` field with a `name`
-//   - The description should be concise (under 80 chars)
-// ─────────────────────────────────────────────────────────────────────────────
-declare interface StackRegistryEntry {
-  package: string
-  description: string
-  github?: string
-}
-/**
- * Metadata for a stack extension, defined in the `stacks` field of a stack's package.json.
- *
- * @example
- * ```json
- * {
- *   "name": "@stacksjs/blog",
- *   "stacks": {
- *     "name": "blog",
- *     "description": "Blog functionality for Stacks",
- *     "directories": ["app", "config", "database", "resources"]
- *   }
- * }
- * ```
- */
-export declare interface StackMeta {
-  name: KnownStackName
-  description?: string
-  version?: string
-  directories?: StackDirectory[]
-  hooks?: {
-    preInstall?: string
-    postInstall?: string
-    preUninstall?: string
-    postUninstall?: string
-  }
-}
-/** Tracks a single installed stack in the lock file */
-export declare interface StackManifestEntry {
-  packageName: string
-  name: string
-  version: string
-  installedAt: string
-  files: string[]
-  skipped: string[]
-  conflictStrategy: ConflictStrategy
-}
-/** The stacks.lock.json file format */
-export declare interface StackLock {
-  version: 1
-  generatedAt: string
-  stacks: Record<string, StackManifestEntry>
-}
-export declare interface StackInstallOptions {
-  name: KnownStackName
-  conflict?: ConflictStrategy
-  force?: boolean
-  dryRun?: boolean
-  verbose?: boolean
-}
-export declare interface StackUninstallOptions {
-  name: KnownStackName
-  force?: boolean
-  verbose?: boolean
-}
-/** Display format for the `stack:list` command */
-export declare interface StackListEntry {
-  name: string
-  packageName: string
-  version: string
-  description?: string
-  installed: boolean
-  installedAt?: string
-  fileCount?: number
-}
-/**
- * A stack extension entry in the registry (`config/stacks.ts`).
- *
- * Can be either:
- * - A string (the stack name or package name)
- * - A full object with name, URL, and GitHub repository
- *
- * @example
- * ```ts
- * export default [
- *   'blog',                                    // shorthand — autocomplete from registry
- *   '@stacksjs/commerce',                      // scoped package shorthand
- *   { name: 'analytics', github: 'stacksjs/analytics-stack' },
- * ] satisfies StackExtensionRegistry
- * ```
- */
-export declare interface StackExtensionEntry {
-  name: KnownStackName
-  url?: string
-  github?: string
-  package?: string
-}
-/**
- * Known top-level directories in a Stacks project that a stack extension can provide.
- * Uses `(string & {})` to allow custom directories while still providing autocomplete.
- */
-export type StackDirectory = | 'app'
-  | 'config'
-  | 'database'
-  | 'resources'
-  | 'routes'
-  | 'public'
-  | 'locales'
-  | 'docs'
-  | (string & {});
-/**
- * All known stack extension names, derived from the registry.
- * Uses `(string & {})` to also accept any custom/unregistered stack name.
- */
-export type KnownStackName = keyof typeof stackExtensionRegistry | (string & {});
-export type ConflictStrategy = 'skip' | 'overwrite' | 'backup';
-/**
- * The registry type for `config/stacks.ts`.
- * Accepts both string shorthands and full objects.
- */
-export type StackExtensionRegistry = (KnownStackName | StackExtensionEntry)[];

package/dist/stacks.d.ts

@@ -1,45 +0,0 @@
-import type { AiConfig, AnalyticsConfig, AppConfig, AuthConfig, BinaryConfig, CacheConfig, CloudConfig, CmsConfig, CommerceConfig, CorsConfig, DashboardConfig, DatabaseConfig, DnsConfig, DocsConfig, EmailConfig, ErrorConfig, FilesystemsConfig, GitConfig, HashingConfig, LibraryConfig, LoggingConfig, MarketingConfig, MonitoringConfig, NotificationConfig, PaymentConfig, Ports, QueueConfig, RealtimeConfig, SaasConfig, SearchEngineConfig, SecurityConfig, ServicesConfig, 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 declare interface StacksOptions {
-  ai: AiConfig
-  analytics: AnalyticsConfig
-  app: AppConfig
-  auth: AuthConfig
-  cors?: CorsConfig
-  realtime: RealtimeConfig
-  cache: CacheConfig
-  cli: BinaryConfig
-  cloud: CloudConfig
-  cms: CmsConfig
-  commerce: CommerceConfig
-  dashboard: DashboardConfig
-  database: DatabaseConfig
-  dns: DnsConfig
-  docs: DocsConfig
-  email: EmailConfig
-  errors: ErrorConfig
-  git: GitConfig
-  hashing: HashingConfig
-  library: LibraryConfig
-  logging: LoggingConfig
-  marketing: MarketingConfig
-  monitoring: MonitoringConfig
-  notification: NotificationConfig
-  payment: PaymentConfig
-  ports: Ports
-  queue: QueueConfig
-  saas: SaasConfig
-  security: SecurityConfig
-  searchEngine: SearchEngineConfig
-  services: ServicesConfig
-  filesystems: FilesystemsConfig
-  team: Team
-  ui: UiConfig
-}
-export type StacksConfig = Partial<StacksOptions>;

package/dist/storage.d.ts

@@ -1,104 +0,0 @@
-import type { Buffer } from 'node:buffer';
-/**
- * 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/table-names.d.ts

@@ -1 +0,0 @@
-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/tables.d.ts

@@ -1,34 +0,0 @@
-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/team.d.ts

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

package/dist/ui.d.ts

@@ -1,55 +0,0 @@
-// 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/utils.d.ts

@@ -1,39 +0,0 @@
-/**
- * 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/src/ai.ts

@@ -1,41 +0,0 @@
-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'
-  | '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**
- *
- * This configuration defines all of your AI 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 AiOptions {
-  default: AiModel
-  models: AiModel[]
-  deploy: boolean
-}
-
-export type AiConfig = Partial<AiOptions>

package/src/analytics.ts

@@ -1,58 +0,0 @@
-/**
- * **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.
- */
-export interface AnalyticsOptions {
-  /** 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
-    }
-  }
-}
-
-export type AnalyticsConfig = Partial<AnalyticsOptions>

package/src/api.ts

@@ -1,77 +0,0 @@
-/**
- * **API Options**
- *
- * This configuration defines all of your API 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 ApiOptions {
-  /**
-   * **API Description**
-   *
-   * This value defines the description for your API.
-   *
-   * @default "Stacks API"
-   */
-  description: string
-
-  /**
-   * **API Prefix**
-   *
-   * This value defines the prefix for all of your API routes. For example, if you set
-   * this value to `api`, all of your API routes will be prefixed with `/api`. This
-   * value is useful for when you want to version your API.
-   *
-   * @default string "api"
-   * @example string "api/v1"
-   */
-  prefix: string
-
-  middleware: string[]
-
-  routes:
-    | {
-      index: boolean
-      show: boolean
-      store: boolean
-      update: boolean
-      destroy: boolean
-    }
-    | boolean
-
-  /**
-   * **API Prewarm**
-   *
-   * This configuration determines the prewarming behavior of your API. Prewarming eliminates
-   * cold starts in your API. If this value is set to `true`, the API will be prewarmed
-   * every 5 minutes. If you provide a number, Stacks will prewarm the
-   * specified number of containers every 5 minutes.
-   *
-   * @default true
-   * @example false
-   * @example 10
-   */
-  prewarm: boolean | number
-
-  /**
-   * **API Memory Size**
-   *
-   * This value defines the memory size for your API.
-   *
-   * @default 512
-   */
-  memorySize: number
-
-  /**
-   * **API Timeout**
-   *
-   * This value defines the timeout for your API.
-   *
-   * @default 30
-   */
-  timeout: number
-
-  deploy: boolean
-}
-
-export type ApiConfig = Partial<ApiOptions>