@stacksjs/types 0.70.86 → 0.70.88

package/src/app.ts

@@ -1,189 +0,0 @@
-export type AppEnvType = 'local' | 'dev' | 'stage' | 'prod' | 'testing' | string
-
-/**
- * **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.
- */
-export interface AppOptions {
-  /**
-   * **Application Name**
-   *
-   * This value is the name of your application. This value is used when the
-   * framework needs to place the application's name in a log or any
-   * other location as required by the application or its packages.
-   *
-   * @default string "Stacks"
-   */
-  name: string
-
-  /**
-   * **Application Description**
-   *
-   * This value is the description of your application. This value is used when the
-   * framework generates meta tags for the frontend.
-   */
-  description: string
-
-  /**
-   * **Application Environment**
-   *
-   * This value determines the "environment" your application is currently
-   * running in. This may determine how you prefer to configure various
-   * services the application utilizes. Set this in your ".env" file
-   *
-   * @default "local"
-   */
-  env: AppEnvType
-
-  /**
-   * **Application URL**
-   *
-   * This URL is used by the console to properly generate URLs when using
-   * the Buddy command line tool. You should set this to the root of
-   * your application so that it is used when running Buddy tasks.
-   *
-   * @default string "stacks.localhost"
-   * @example "my-project.test"
-   */
-  url: string
-
-  /**
-   * **Redirect URLs**
-   *
-   * A Redirect URL is a URL that permanently redirects to the Application URL.
-   * This is useful for when you have multiple domains that you want to redirect
-   * to your application. You can set this to a string or an array of strings.
-   *
-   * @default []
-   * @example "['stacksjs.com', 'stacksjs.dev']"
-   */
-  redirectUrls: string | string[]
-
-  /**
-   * **Application Debug Mode**
-   *
-   * When your application is in debug mode, detailed error messages with
-   * stack traces will be shown on every error that occurs within your
-   * application. If disabled, a simple generic error page is shown.
-   *
-   * @default true
-   */
-  debug: boolean
-
-  /**
-   * **Maintenance Mode**
-   *
-   * When your application is in maintenance mode, a simple maintenance
-   * page will be shown on every request into your application.
-   *
-   * @default false
-   */
-  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**
-   *
-   * This key is used by the Stacks encrypter service and should be set to
-   * a random, 32 character string, otherwise these encrypted strings will
-   * not be safe. Please do this before deploying an application!
-   */
-  key: string
-
-  /**
-   * **Application Timezone**
-   *
-   * Here you may specify the default timezone for your application, which
-   * will be used by Stacks and date-time functions. We have gone ahead
-   * and set this to a sensible default for you out of the box.
-   *
-   * @default string "UTC"
-   */
-  timezone: string
-
-  /**
-   * **Application Locale Configuration**
-   *
-   * The application locale determines the default locale that will be used
-   * by the translation service provider. You are free to set this value
-   * to any of the locales which will be supported by the application.
-   *
-   * @default string "en"
-   * @example
-   * de // ./lang/de.yml needs to be present for this
-   */
-  locale: string
-
-  /**
-   * **Application Fallback Locale**
-   *
-   * The fallback locale determines the locale to use when the current one
-   * is not available. You may change the value to correspond to any of
-   * the language folders that are provided through your application.
-   *
-   * @default string "en"
-   */
-  fallbackLocale: 'en'
-
-  /**
-   * **Cipher**
-   *
-   * Description WIP.
-   *
-   * @default string "aes-256-cbc"
-   */
-  cipher: string
-
-  // inspect: <InspectOptions>{},
-
-  /**
-   * **Documentation Mode**
-   *
-   * $appUrl becomes your Documentation URL.
-   *
-   * @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,5 +0,0 @@
-// 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

@@ -1,161 +0,0 @@
-export interface AuthOptions {
-  /**
-   * Top-level feature gate. When `false`, the auth feature is inert at boot
-   * (no token/password-reset/email-verification flows wired up). Missing or
-   * `true` means auth is on.
-   */
-  enabled?: boolean
-  /** Optional deploy-target gate, e.g. `['production']`. */
-  env?: string[]
-  /**
-   * 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
-
-    /**
-     * Reset-link URL template. Supports `{token}` and `{email}`
-     * placeholders. Absolute templates (`https://…`) are used as-is;
-     * path templates are prefixed with the app URL. Lets apps whose
-     * reset page lives on a custom route reuse `passwordResets().sendEmail()`
-     * instead of hand-rolling the send.
-     * @default '/password/reset/{token}?email={email}'
-     */
-    url?: string
-  }
-
-  /**
-   * Email verification configuration
-   */
-  emailVerification?: {
-    /**
-     * Token expiration time in minutes
-     * @default 60
-     */
-    expire?: number
-
-    /**
-     * Verification-link URL template. Supports `{id}` and `{token}`
-     * placeholders. Absolute templates (`https://…`) are used as-is;
-     * path templates are prefixed with the app URL. Lets apps whose
-     * verify page lives on a custom route reuse `sendVerificationEmail()`
-     * instead of hand-rolling the send.
-     * @default '/verify-email/{id}/{token}'
-     */
-    url?: string
-  }
-}
-
-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,8 +0,0 @@
-// `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
-}

package/src/binary.ts

@@ -1,13 +0,0 @@
-/**
- * The Binary/CLI Options used in `./config/cli.ts`.
- */
-export interface BinaryOptions {
-  name: string
-  command: string
-  description: string
-  source: string
-  deploy: boolean
-  // path: string // TODO: add this for a configurable path where the commands are located
-}
-
-export type BinaryConfig = Partial<BinaryOptions>

package/src/cache.ts

@@ -1,325 +0,0 @@
-/**
- * Cache Options - Configuration for the caching system
- */
-export interface CacheOptions {
-  /**
-   * **Cache Driver**
-   *
-   * The cache driver that will be used by your application to store
-   * cached data. Supports 'memory', 'redis', and 'singlestore' drivers.
-   *
-   * The 'singlestore' driver persists cache entries in a SingleStore
-   * rowstore table (with epoch-based TTL) — useful when you want a single
-   * SingleStore cluster to back both your primary data and your cache.
-   *
-   * @default "memory"
-   */
-  driver: 'memory' | 'redis' | 'singlestore'
-
-  /**
-   * **Cache Prefix**
-   *
-   * The prefix used when storing items in the cache. Useful when
-   * multiple applications share the same cache driver.
-   *
-   * @default "stacks"
-   */
-  prefix: string
-
-  /**
-   * **Cache TTL**
-   *
-   * Default time to live for items stored in the cache (in seconds).
-   * Use 0 for no expiration.
-   *
-   * @default 3600
-   */
-  ttl: number
-
-  /**
-   * **Max Keys**
-   *
-   * Maximum number of keys to store in the cache.
-   * Use -1 for unlimited.
-   *
-   * @default -1
-   */
-  maxKeys?: number
-
-  /**
-   * **Use Clones**
-   *
-   * Whether to clone values when getting/setting.
-   * Disable for better performance with immutable data.
-   *
-   * @default true
-   */
-  useClones?: boolean
-
-  /**
-   * **Driver-specific configurations**
-   */
-  drivers: {
-    redis?: {
-      /**
-       * Redis connection URL
-       * @example "redis://localhost:6379"
-       */
-      url?: string
-
-      /**
-       * Redis Host
-       * @default "localhost"
-       */
-      host: string
-
-      /**
-       * Redis Port
-       * @default 6379
-       */
-      port: number
-
-      /**
-       * Redis Username
-       */
-      username?: string
-
-      /**
-       * Redis Password
-       */
-      password?: string
-
-      /**
-       * Redis Database number
-       * @default 0
-       */
-      database?: number
-
-      /**
-       * Enable TLS
-       * @default false
-       */
-      tls?: boolean
-    }
-
-    memory?: {
-      /**
-       * Maximum number of keys
-       * @default -1
-       */
-      maxKeys?: number
-
-      /**
-       * Check period for expired keys (in seconds)
-       * @default 600
-       */
-      checkPeriod?: number
-
-      /**
-       * Delete keys on expire
-       * @default true
-       */
-      deleteOnExpire?: boolean
-    }
-
-    singlestore?: {
-      /**
-       * SingleStore host (MySQL wire protocol)
-       * @default "127.0.0.1"
-       */
-      host?: string
-
-      /**
-       * SingleStore port
-       * @default 3306
-       */
-      port?: number
-
-      /**
-       * SingleStore username
-       * @default "root"
-       */
-      username?: string
-
-      /**
-       * SingleStore password
-       */
-      password?: string
-
-      /**
-       * Database that holds the cache table
-       * @default "stacks"
-       */
-      database?: string
-
-      /**
-       * Table used to store cache entries
-       * @default "stacks_cache"
-       */
-      table?: string
-
-      /**
-       * Enable TLS (required by managed SingleStore / Helios)
-       * @default false
-       */
-      ssl?: boolean
-    }
-  }
-}
-
-export type CacheConfig = Partial<CacheOptions>
-
-/**
- * Cache Driver Interface - Defines the API for all cache implementations
- */
-export interface CacheDriver {
-  /**
-   * Get a cached value
-   */
-  get: <T>(key: string) => Promise<T | undefined>
-
-  /**
-   * Get multiple cached values
-   */
-  mget: <T>(keys: string[]) => Promise<Record<string, T>>
-
-  /**
-   * Set a cached value with optional TTL (in seconds)
-   */
-  set: <T>(key: string, value: T, ttl?: number) => Promise<boolean>
-
-  /**
-   * Set multiple cached values
-   */
-  mset: <T>(entries: Array<{ key: string, value: T, ttl?: number }>) => Promise<boolean>
-
-  /**
-   * Set a cached value that never expires
-   */
-  setForever: <T>(key: string, value: T) => Promise<boolean>
-
-  /**
-   * Get a value or set it if not cached
-   */
-  getOrSet: <T>(key: string, fetcher: () => T | Promise<T>, ttl?: number) => Promise<T>
-
-  /**
-   * Delete one or more keys
-   */
-  del: (keys: string | string[]) => Promise<number>
-
-  /**
-   * Check if a key exists
-   */
-  has: (key: string) => Promise<boolean>
-
-  /**
-   * Check if a key is missing
-   */
-  missing: (key: string) => Promise<boolean>
-
-  /**
-   * Delete a single key (alias for del)
-   */
-  remove: (key: string) => Promise<void>
-
-  /**
-   * Delete multiple keys
-   */
-  deleteMany: (keys: string[]) => Promise<number>
-
-  /**
-   * Clear all cached values
-   */
-  clear: () => Promise<void>
-
-  /**
-   * Clear all cached values (alias for clear)
-   */
-  flush: () => Promise<void>
-
-  /**
-   * Get all keys matching a pattern
-   */
-  keys: (pattern?: string) => Promise<string[]>
-
-  /**
-   * Get the TTL of a key (in seconds)
-   */
-  getTtl: (key: string) => Promise<number | undefined>
-
-  /**
-   * Set/update the TTL of a key
-   */
-  ttl: (key: string, ttl: number) => Promise<boolean>
-
-  /**
-   * Get a value and delete it atomically
-   */
-  take: <T>(key: string) => Promise<T | undefined>
-
-  /**
-   * Get a cached value or compute and store it (Laravel-style).
-   * TTL comes before callback (Laravel convention).
-   */
-  remember: <T>(key: string, ttl: number, callback: () => T | Promise<T>) => Promise<T>
-
-  /**
-   * Get a cached value or compute and store it forever (no expiration).
-   */
-  rememberForever: <T>(key: string, callback: () => T | Promise<T>) => Promise<T>
-
-  /**
-   * Get cache statistics
-   */
-  getStats: () => Promise<CacheStats>
-
-  /**
-   * Close the cache connection
-   */
-  close: () => Promise<void>
-
-  /**
-   * Disconnect from the cache (alias for close)
-   */
-  disconnect: () => Promise<void>
-
-  /**
-   * Tag-aware writes. The returned scope mirrors the cache API but
-   * indexes every write under the supplied tag(s) so a single
-   * `flush()` can invalidate cascading entries together.
-   *
-   * @example
-   * ```ts
-   * await cache.tags(['user:42']).put('user:42:feed', payload, 300)
-   * await cache.tags(['user:42']).flush()
-   * ```
-   */
-  tags?: (tags: readonly string[]) => TaggedCacheScope
-}
-
-/**
- * Returned by `cache.tags(tags)`. Tag-scoped writes/reads with a
- * cascading `flush()`.
- */
-export interface TaggedCacheScope {
-  put: <T>(key: string, value: T, ttl?: number) => Promise<boolean>
-  set: <T>(key: string, value: T, ttl?: number) => Promise<boolean>
-  setForever: <T>(key: string, value: T) => Promise<boolean>
-  remember: <T>(key: string, ttl: number, callback: () => T | Promise<T>) => Promise<T>
-  rememberForever: <T>(key: string, callback: () => T | Promise<T>) => Promise<T>
-  get: <T>(key: string) => Promise<T | undefined>
-  has: (key: string) => Promise<boolean>
-  flush: () => Promise<number>
-}
-
-/**
- * Cache Statistics
- */
-export interface CacheStats {
-  hits: number
-  misses: number
-  keys: number
-  size?: number
-  hitRate?: number
-}

package/src/cdn.ts

@@ -1,17 +0,0 @@
-export interface CdnOptions {
-  /**
-   * **CDN Driver**
-   *
-   * This value determines the default CDN driver that will be used when interacting with the
-   * CDN service. This value may be overridden when interacting with the CDN service.
-   *
-   * @default "cloudfront"
-   * @example "cloudfront"
-   * @example "fastly" wip
-   *
-   * @see https://stacks.js.org/docs/cdn
-   */
-  driver: string
-}
-
-export type CdnConfig = Partial<CdnOptions>