@stacksjs/types 0.70.88 → 0.70.91

package/dist/ai.d.ts

@@ -0,0 +1,37 @@
+/**
+ * **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 declare interface AiOptions {
+  default: AiModel
+  models: AiModel[]
+  deploy: boolean
+}
+declare type AiModel = | '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 & {});
+export type AiConfig = Partial<AiOptions>;

package/dist/analytics.d.ts

@@ -0,0 +1,36 @@
+/**
+ * **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 declare interface AnalyticsOptions {
+  driver: 'google-analytics' | 'fathom' | 'plausible' | 'self-hosted'
+  drivers: {
+    googleAnalytics?: {
+      trackingId: string
+      debug?: boolean
+    }
+    fathom?: {
+      siteId: string
+      scriptUrl?: string
+      honorDnt?: boolean
+      spa?: boolean
+    }
+    plausible?: {
+      domain: string
+      scriptUrl?: string
+      trackLocalhost?: boolean
+      hashMode?: boolean
+    }
+    selfHosted?: {
+      siteId: string
+      apiEndpoint: string
+      honorDnt?: boolean
+      trackHashChanges?: boolean
+      trackOutboundLinks?: boolean
+    }
+  }
+}
+export type AnalyticsConfig = Partial<AnalyticsOptions>;

package/dist/api.d.ts

@@ -0,0 +1,26 @@
+/**
+ * **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 declare interface ApiOptions {
+  description: string
+  prefix: string
+  middleware: string[]
+  routes:
+    | {
+      index: boolean
+      show: boolean
+      store: boolean
+      update: boolean
+      destroy: boolean
+    }
+    | boolean
+  prewarm: boolean | number
+  memorySize: number
+  timeout: number
+  deploy: boolean
+}
+export type ApiConfig = Partial<ApiOptions>;

package/dist/app.d.ts

@@ -0,0 +1,28 @@
+/**
+ * **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 declare interface AppOptions {
+  name: string
+  description: string
+  env: AppEnvType
+  url: string
+  redirectUrls: string | string[]
+  debug: boolean
+  maintenanceMode: boolean
+  comingSoonMode?: boolean
+  comingSoonSecret?: string
+  key: string
+  timezone: string
+  locale: string
+  fallbackLocale: 'en'
+  cipher: string
+  docMode: boolean
+  primaryColor: string
+  supportEmail: string
+}
+export type AppEnvType = 'local' | 'dev' | 'stage' | 'prod' | 'testing' | string;
+export type AppConfig = Partial<AppOptions>;

package/dist/attributes.d.ts

@@ -0,0 +1 @@
+export type * from '../../../types/attributes';

package/dist/auth.d.ts

@@ -0,0 +1,62 @@
+export declare interface AuthOptions {
+  enabled?: boolean
+  env?: string[]
+  default: string
+  guards: {
+    [key: string]: {
+      driver: 'session' | 'token'
+      provider: string
+    }
+  }
+  providers: {
+    [key: string]: {
+      driver: 'database'
+      table: string
+    }
+  }
+  username: string
+  password: string
+  tokenExpiry: number
+  refreshTokenExpiry?: number
+  tokenRotation: number
+  defaultAbilities: string[]
+  defaultTokenName: string
+  passwordReset: {
+    expire: number
+    throttle: number
+    url?: string
+  }
+  emailVerification?: {
+    expire?: number
+    url?: string
+  }
+  session?: {
+    enforceFingerprint?: boolean | { ip?: boolean, userAgent?: boolean }
+  }
+  registration?: {
+    preventEnumeration?: boolean
+  }
+}
+export declare interface AuthInstance {
+  guard: string
+  provider: string
+  user?: any
+  token?: string
+}
+export declare 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 declare interface Authenticatable {
+  getAuthIdentifier: () => any
+  getAuthPassword: () => string
+  getRememberToken: () => string
+  setRememberToken: (token: string) => void
+}
+export type AuthConfig = Partial<AuthOptions>;
+export type GuardType = 'session' | 'token';
+export type ProviderType = 'database';

package/dist/auto-imports.d.ts

@@ -0,0 +1,8 @@
+// `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 declare interface AutoImportsOptions {
+  [key: string]: unknown
+}

package/dist/binary.d.ts

@@ -0,0 +1,11 @@
+/**
+ * The Binary/CLI Options used in `./config/cli.ts`.
+ */
+export declare interface BinaryOptions {
+  name: string
+  command: string
+  description: string
+  source: string
+  deploy: boolean
+}
+export type BinaryConfig = Partial<BinaryOptions>;

package/dist/cache.d.ts

@@ -0,0 +1,88 @@
+/**
+ * Cache Options - Configuration for the caching system
+ */
+export declare interface CacheOptions {
+  driver: 'memory' | 'redis' | 'singlestore'
+  prefix: string
+  ttl: number
+  maxKeys?: number
+  useClones?: boolean
+  drivers: {
+    redis?: {
+      url?: string
+      host: string
+      port: number
+      username?: string
+      password?: string
+      database?: number
+      tls?: boolean
+    }
+    memory?: {
+      maxKeys?: number
+      checkPeriod?: number
+      deleteOnExpire?: boolean
+    }
+    singlestore?: {
+      host?: string
+      port?: number
+      username?: string
+      password?: string
+      database?: string
+      table?: string
+      ssl?: boolean
+    }
+  }
+}
+/**
+ * Cache Driver Interface - Defines the API for all cache implementations
+ */
+export declare interface CacheDriver {
+  get: <T>(key: string) => Promise<T | undefined>
+  mget: <T>(keys: string[]) => Promise<Record<string, T>>
+  set: <T>(key: string, value: T, ttl?: number) => Promise<boolean>
+  mset: <T>(entries: Array<{ key: string, value: T, ttl?: number }>) => Promise<boolean>
+  setForever: <T>(key: string, value: T) => Promise<boolean>
+  getOrSet: <T>(key: string, fetcher: () => T | Promise<T>, ttl?: number) => Promise<T>
+  del: (keys: string | string[]) => Promise<number>
+  has: (key: string) => Promise<boolean>
+  missing: (key: string) => Promise<boolean>
+  remove: (key: string) => Promise<void>
+  deleteMany: (keys: string[]) => Promise<number>
+  clear: () => Promise<void>
+  flush: () => Promise<void>
+  keys: (pattern?: string) => Promise<string[]>
+  getTtl: (key: string) => Promise<number | undefined>
+  ttl: (key: string, ttl: number) => Promise<boolean>
+  take: <T>(key: string) => Promise<T | undefined>
+  remember: <T>(key: string, ttl: number, callback: () => T | Promise<T>) => Promise<T>
+  rememberForever: <T>(key: string, callback: () => T | Promise<T>) => Promise<T>
+  getStats: () => Promise<CacheStats>
+  close: () => Promise<void>
+  disconnect: () => Promise<void>
+  tags?: (tags: readonly string[]) => TaggedCacheScope
+}
+/**
+ * Returned by `cache.tags(tags)`. Tag-scoped writes/reads with a
+ * cascading `flush()`.
+ */
+export declare 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 declare interface CacheStats {
+  hits: number
+  misses: number
+  keys: number
+  size?: number
+  hitRate?: number
+}
+export type CacheConfig = Partial<CacheOptions>;

package/dist/cdn.d.ts

@@ -0,0 +1,4 @@
+export declare interface CdnOptions {
+  driver: string
+}
+export type CdnConfig = Partial<CdnOptions>;

package/dist/chat.d.ts

@@ -0,0 +1,69 @@
+/**
+ * Configuration options for chat drivers
+ */
+export declare interface ChatDriverConfig {
+  maxRetries?: number
+  retryTimeout?: number
+  [key: string]: any
+}
+/**
+ * Base chat message interface
+ */
+export declare interface ChatMessage {
+  to: string | string[]
+  from?: {
+    id?: string
+    name?: string
+    avatar?: string
+  }
+  subject?: string
+  content?: string
+  template?: string
+  data?: Record<string, any>
+  attachments?: ChatAttachment[]
+  onSuccess?: () => void | Promise<void> | Partial<ChatResult>
+  onError?: (error: Error) => void | Promise<void> | Partial<ChatResult>
+  handle?: () => void | Promise<void> | Partial<ChatResult>
+  [key: string]: any
+}
+/**
+ * Structure for message attachments
+ */
+export declare interface ChatAttachment {
+  filename: string
+  content: string | Uint8Array
+  contentType: string
+  options?: Record<string, any>
+}
+/**
+ * Standard result object for chat operations
+ */
+export declare interface ChatResult {
+  success: boolean
+  message: string
+  provider: string
+  messageId?: string
+  data?: Record<string, any>
+}
+/**
+ * Base chat driver interface
+ */
+export declare interface ChatDriver {
+  name: string
+  configure: (config: ChatDriverConfig) => void
+  send: (message: ChatMessage, options?: ChatOptions) => Promise<ChatResult>
+}
+/**
+ * Slack-specific response
+ */
+export declare interface SlackResponse {
+  id: string
+  channel?: string
+  ts?: string
+  [key: string]: any
+}
+export type ChatConfig = ChatOptions;
+/**
+ * Chat driver options
+ */
+export type ChatOptions = Record<string, any>;

package/dist/cli.d.ts

@@ -0,0 +1,316 @@
+import type { BunFile } from 'bun';
+import type { Ports } from './ports';
+export type { ErrorLike, SpawnOptions, Subprocess, SyncSubprocess } from 'bun';
+export type { CLI } from '@stacksjs/clapp';
+export declare interface OutroOptions extends CliOptions {
+  type?: 'success' | 'error' | 'warning' | 'info'
+  startTime?: number
+  useSeconds?: boolean
+  quiet?: boolean
+  message?: string
+}
+export declare interface IntroOptions {
+  showPerformance?: boolean
+  quiet: boolean
+}
+/**
+ * The options to pass to the CLI.
+ */
+export declare interface CliOptions {
+  verbose?: boolean
+  silent?: boolean
+  quiet?: boolean
+  cwd?: string
+  stdio?: [In, Out, Out]
+  stdin?: stdin
+  stdout?: stdout
+  stderr?: stderr
+  env?: Record<string, string | undefined>
+  background?: boolean
+  timeoutMs?: number
+  startTime?: number
+  withLocalhost?: boolean
+  input?: string | ArrayBufferView | ReadableStream | Blob | Response | Request
+  project?: string
+}
+export declare interface CleanOptions extends CliOptions {}
+export declare interface CloudCliOptions extends CliOptions {
+  ssh?: boolean
+  connect?: boolean
+  jumpBox?: boolean
+  invalidateCache?: boolean
+  paths?: string
+  diff?: boolean
+}
+export declare interface CommitOptions extends CliOptions {}
+export declare interface FreshOptions extends CliOptions {
+  dryRun?: boolean
+  quiet?: boolean
+}
+export declare interface InspireOptions extends CliOptions {}
+export declare interface InstallOptions extends CliOptions {}
+export declare interface KeyOptions extends CliOptions {}
+export declare interface MigrateOptions extends CliOptions {
+  diff?: boolean
+}
+export declare interface CliQueueOptions extends CliOptions {
+  queue?: string
+  id?: string | number
+  all?: boolean
+  force?: boolean
+  connection?: string
+}
+export declare interface ReleaseOptions extends CliOptions {
+  dryRun?: boolean
+  bump?: 'patch' | 'minor' | 'major' | 'prepatch' | 'preminor' | 'premajor' | 'prerelease' | string
+}
+export declare interface ChangelogOptions extends CliOptions {
+  dryRun?: boolean
+  from?: string
+  to?: string
+  version?: string
+}
+export declare interface ProjectsOptions extends CliOptions {
+  list?: boolean
+}
+export declare interface PreinstallOptions extends CliOptions {}
+export declare interface PrepublishOptions extends CliOptions {}
+export declare interface PortsOptions extends CliOptions {
+  ports?: Partial<Ports>
+}
+export declare interface SaasOptions extends CliOptions {}
+export declare interface SearchCommandOptions extends CliOptions {
+  model: string
+  settings: boolean
+  flush: boolean
+}
+export declare interface ScheduleOptions extends CliOptions {}
+export declare interface TinkerOptions extends CliOptions {
+  eval?: string | boolean
+  print?: string | boolean
+  noBanner?: boolean
+  preload?: string
+}
+export declare interface TypesOptions extends CliOptions {}
+declare type ArrayBufferView = NodeJS.TypedArray | DataView;
+export type Readable = | 'pipe'
+  | 'inherit'
+  | 'ignore'
+  | null // equivalent to 'ignore'
+  | undefined // to use default
+  | BunFile
+  | ArrayBufferView
+  | number;
+export type Writable = | 'pipe'
+  | 'inherit'
+  | 'ignore'
+  | null // equivalent to 'ignore'
+  | undefined // to use default
+  | BunFile
+  | ArrayBufferView
+  | number
+  | ReadableStream
+  | Blob
+  | Response
+  | Request;
+export type In = Readable;
+export type Out = Writable;
+/**
+ * The file descriptor for the standard input. It may be:
+ *
+ * - `"ignore"`, `null`, `undefined`: The process will have no standard input
+ * - `"pipe"`: The process will have a new {@link FileSink} for standard input
+ * - `"inherit"`: The process will inherit the standard input of the current process
+ * - `ArrayBufferView`, `Blob`: The process will read from the buffer
+ * - `number`: The process will read from the file descriptor
+ *
+ * @default "ignore"
+ */
+export type stdin = 'ignore' | 'inherit' | 'pipe' | ArrayBufferView | number | null | undefined;
+/**
+ * The file descriptor for the standard output. It may be:
+ *
+ * - `"pipe"`, `undefined`: The process will have a {@link ReadableStream} for standard output/error
+ * - `"ignore"`, `null`: The process will have no standard output/error
+ * - `"inherit"`: The process will inherit the standard output/error of the current process
+ * - `ArrayBufferView`: The process write to the preallocated buffer. Not implemented.
+ * - `number`: The process will write to the file descriptor
+ *
+ * @default "pipe"
+ */
+export type stdout = 'ignore' | 'inherit' | 'pipe' | ArrayBufferView | number;
+/**
+ * The file descriptor for the standard error. It may be:
+ *
+ * - `"pipe"`, `undefined`: The process will have a {@link ReadableStream} for standard output/error
+ * - `"ignore"`, `null`: The process will have no standard output/error
+ * - `"inherit"`: The process will inherit the standard output/error of the current process
+ * - `ArrayBufferView`: The process write to the preallocated buffer. Not implemented.
+ * - `number`: The process will write to the file descriptor
+ *
+ * @default "inherit" for `spawn`
+ * "pipe" for `spawnSync`
+ */
+export type stderr = 'ignore' | 'inherit' | 'pipe' | ArrayBufferView | number;
+// type SpinnerOptions = Ora
+export type CliOptionsKeys = keyof CliOptions;
+export type CliConfig = CliOptions;
+// export type { Ora as SpinnerOptions } from 'ora'
+// the `domains` option is only available for the `deploy` command
+// the `count` option is only available for the `seed` command
+export type ActionOption = 'types' | 'domains' | 'count';
+/**
+ * The options to pass to the Action.
+ */
+export type ActionOptions = {
+  types?: boolean
+  domains?: boolean
+  count?: number
+  dryRun?: boolean // used in buddy release
+} & CliOptions &
+DomainsOptions;
+export type BuildOption = | 'components'
+  | 'webComponents'
+  | 'elements'
+  | 'functions'
+  | 'docs'
+  | 'views'
+  | 'stacks'
+  | 'all'
+  | 'buddy'
+  | 'server';
+export type BuildOptions = {
+  [key in BuildOption]: boolean
+} & CliOptions;
+export type AddOption = 'table' | 'calendar' | 'all';
+export type AddOptions = {
+  [key in AddOption]?: boolean
+} & CliOptions;
+export type CreateStringOption = 'name';
+export type CreateBooleanOption = | 'ui'
+  | 'components'
+  | 'web-components'
+  | 'vue'
+  | 'views'
+  | 'functions'
+  | 'api'
+  | 'database'
+  | 'minimal';
+export type CreateOptions = {
+  [key in CreateBooleanOption]: boolean
+} & {
+  [key in CreateStringOption]: string
+} & CliOptions;
+export type DevOption = | 'components'
+  | 'docs'
+  | 'frontend'
+  | 'api'
+  | 'desktop'
+  | 'native'
+  | 'all'
+  | 'email'
+  | 'system-tray'
+  | 'interactive'
+  | 'verbose';
+export type DevOptions = {
+  [key in DevOption]: boolean
+} & CliOptions;
+export type GeneratorOption = | 'types'
+  | 'entries'
+  | 'webTypes'
+  | 'customData'
+  | 'ideHelpers'
+  | 'componentMeta'
+  | 'coreSymlink'
+  | 'openApiSpec'
+  | 'pantryConfig'
+  | 'openapi'
+  | 'modelFiles';
+export type GeneratorOptions = {
+  [key in GeneratorOption]?: boolean
+} & CliOptions;
+export type LintOption = 'fix';
+export type LintOptions = {
+  [key in LintOption]: boolean
+} & CliOptions;
+export type MakeStringOption = 'name' | 'chat' | 'sms' | 'env';
+export type MakeBooleanOption = | 'component'
+  | 'page'
+  | 'function'
+  | 'language'
+  | 'database'
+  | 'migration'
+  | 'model'
+  | 'notification'
+  | 'stack'
+  | 'middleware'
+  | 'dryRun'
+  | 'withValidation'
+  | 'withAuth';
+export type MakeOptions = {
+  [key in MakeBooleanOption]: boolean
+} & {
+  [key in MakeStringOption]: string
+} & CliOptions;
+export type UpgradeBoolean = 'framework' | 'dependencies' | 'bun' | 'shell' | 'binary' | 'all' | 'force' | 'canary' | 'stable' | 'noPostinstall' | 'postinstall';
+export type UpgradeString = 'version' | 'from';
+export type UpgradeOptions = {
+  [key in UpgradeBoolean]?: boolean
+} & {
+  [key in UpgradeString]?: string
+} & CliOptions;
+export type ExamplesString = 'version';
+export type ExamplesBoolean = 'components' | 'vue' | 'webComponents' | 'elements' | 'all' | 'force';
+export type ExamplesOption = ExamplesString & ExamplesBoolean;
+export type ExamplesOptions = {
+  [key in ExamplesString]: string
+} & {
+  [key in ExamplesBoolean]: boolean
+} & CliOptions;
+export type TestingOptions = CliOptions & {
+  ui?: boolean
+  feature?: boolean
+  unit?: boolean
+}
+export type DomainsOptions = CliOptions & {
+  domain?: string
+  yes?: boolean
+  years?: number
+  privacy?: boolean
+  autoRenew?: boolean
+  registrantFirstName?: string
+  registrantLastName?: string
+  registrantOrganization?: string
+  registrantAddress?: string
+  registrantCity?: string
+  registrantState?: string
+  registrantCountry?: string
+  registrantZip?: string
+  registrantPhone?: string
+  registrantEmail?: string
+  adminFirstName?: string
+  adminLastName?: string
+  adminOrganization?: string
+  adminAddress?: string
+  adminCity?: string
+  adminState?: string
+  adminCountry?: string
+  adminZip?: string
+  adminPhone?: string
+  adminEmail?: string
+  techFirstName?: string
+  techLastName?: string
+  techOrganization?: string
+  techAddress?: string
+  techCity?: string
+  techState?: string
+  techCountry?: string
+  techZip?: string
+  techPhone?: string
+  techEmail?: string
+  privacyAdmin?: boolean
+  privacyTech?: boolean
+  privacyRegistrant?: boolean
+  contactType?: string
+}
+export type LibEntryType = 'web-components' | 'functions' | 'all';