@stacksjs/types 0.70.86 → 0.70.87

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>

package/src/chat.ts

@@ -1,193 +0,0 @@
-export type ChatConfig = ChatOptions
-
-// Chat Message Types
-
-/**
- * Configuration options for chat drivers
- */
-export interface ChatDriverConfig {
-  /**
-   * Maximum number of retry attempts
-   */
-  maxRetries?: number
-
-  /**
-   * Timeout between retry attempts in milliseconds
-   */
-  retryTimeout?: number
-
-  /**
-   * Any additional driver-specific configuration
-   */
-  [key: string]: any
-}
-
-/**
- * Base chat message interface
- */
-export interface ChatMessage {
-  /**
-   * Recipient(s) of the message
-   * This could be channel ID, user ID, or other identifier
-   */
-  to: string | string[]
-
-  /**
-   * Optional sender information
-   */
-  from?: {
-    id?: string
-    name?: string
-    avatar?: string
-  }
-
-  /**
-   * Optional message subject or title
-   */
-  subject?: string
-
-  /**
-   * Message content in plain text
-   */
-  content?: string
-
-  /**
-   * Template to be used for rendering the message
-   */
-  template?: string
-
-  /**
-   * Template data
-   */
-  data?: Record<string, any>
-
-  /**
-   * Any attachments to include with the message
-   */
-  attachments?: ChatAttachment[]
-
-  /**
-   * Callback triggered on successful message delivery
-   */
-  onSuccess?: () => void | Promise<void> | Partial<ChatResult>
-
-  /**
-   * Callback triggered on message delivery failure
-   */
-  onError?: (error: Error) => void | Promise<void> | Partial<ChatResult>
-
-  /**
-   * General handler for both success and error cases
-   */
-  handle?: () => void | Promise<void> | Partial<ChatResult>
-
-  /**
-   * Custom fields for platform-specific options
-   */
-  [key: string]: any
-}
-
-/**
- * Structure for message attachments
- */
-export interface ChatAttachment {
-  /**
-   * Filename of the attachment
-   */
-  filename: string
-
-  /**
-   * Content of the attachment
-   */
-  content: string | Uint8Array
-
-  /**
-   * MIME type of the attachment
-   */
-  contentType: string
-
-  /**
-   * Additional options for the attachment
-   */
-  options?: Record<string, any>
-}
-
-/**
- * Standard result object for chat operations
- */
-export interface ChatResult {
-  /**
-   * Indicates whether the operation was successful
-   */
-  success: boolean
-
-  /**
-   * Human-readable message about the result
-   */
-  message: string
-
-  /**
-   * Name of the provider that handled the message
-   */
-  provider: string
-
-  /**
-   * Optional message ID returned from the provider
-   */
-  messageId?: string
-
-  /**
-   * Any additional provider-specific response data
-   */
-  data?: Record<string, any>
-}
-
-/**
- * Chat driver options
- */
-export type ChatOptions = Record<string, any>
-
-/**
- * Base chat driver interface
- */
-export interface ChatDriver {
-  /**
-   * Name of the chat provider
-   */
-  name: string
-
-  /**
-   * Configure the driver
-   */
-  configure: (config: ChatDriverConfig) => void
-
-  /**
-   * Send a message
-   */
-  send: (message: ChatMessage, options?: ChatOptions) => Promise<ChatResult>
-}
-
-/**
- * Slack-specific response
- */
-export interface SlackResponse {
-  /**
-   * ID of the sent message
-   */
-  id: string
-
-  /**
-   * Channel where the message was sent
-   */
-  channel?: string
-
-  /**
-   * Timestamp of the message
-   */
-  ts?: string
-
-  /**
-   * Any additional response data
-   */
-  [key: string]: any
-}