@stacksjs/types 0.70.23 → 0.70.25

package/dist/{saas.d.ts → src/saas.d.ts}

@@ -5,7 +5,7 @@ export declare interface SaasOption {
     pricing: {
       key: string
       price: number
-      interval?: 'day' | 'month' | 'week' | 'year' 
+      interval?: 'day' | 'month' | 'week' | 'year'
       currency: string
     }[]
     metadata: {
@@ -29,4 +29,4 @@ export declare interface SaasOption {
     images: string[]
   }[]
 }
-export declare type SaasConfig = Partial<SaasOption>
+export type SaasConfig = Partial<SaasOption>;

package/dist/src/scheduler.d.ts

@@ -0,0 +1 @@
+export type { Schedule } from '@stacksjs/scheduler';

package/dist/{search-engine.d.ts → src/search-engine.d.ts}

@@ -1,38 +1,57 @@
+import type { Dictionary, DocumentOptions, EnqueuedTask, Faceting, Hits, Index, IndexesResults, IndexOptions, MeiliSearch, Settings as MeilisearchOptions, PaginationSettings, DocumentOptions as RecordOptions, SearchParams, SearchResponse, Settings, Synonyms, TypoTolerance } from 'meilisearch';
 import type { MaybePromise } from '.';
-
 export type {
+  EnqueuedTask,
+  Hits,
+  Index,
+  IndexesResults,
+  IndexOptions,
+  MeiliSearch,
+  MeilisearchOptions,
+  RecordOptions,
+  SearchParams,
+  SearchResponse,
+};
+// type Search = any
+// type Page = any
+// type Pages = Page[]
+// type Filter = any
+// type Filters = Filter[]
+// type Result = any
+// type Results = Result[]
+// type SearchFilter = any
+// type SearchFilters = SearchFilter[]
+// type Sorts = any
+// type Sort = any
 export declare interface SearchEngineOptions {
-  driver: 'opensearch'
-
-
+  driver: 'meilisearch' | 'algolia' | 'opensearch'
   opensearch?: {
     host: string
     protocol: number
     port: number
     auth: string
   }
-
   meilisearch?: {
     host: string
-    protocol: number
-    port: number
-    auth: string
+    protocol?: number
+    port?: number
+    auth?: string
     apiKey: string
   }
-
+  algolia?: {
+    appId: string
+    apiKey: string
+    searchOnlyApiKey?: string
+  }
   filters?: {
     [key: string]: string
   }
-
   perPage?: number
 }
-export declare type SearchEngineConfig = Partial<SearchEngineOptions>
-
-export interface SearchEngineDriver {
+export declare interface SearchEngineDriver {
   client: () => MeiliSearch
-
+  resetClient?: () => void
   search: (index: string, params: any) => Promise<SearchResponse<Record<string, any>>>
-
   createIndex: (name: string, options?: IndexOptions) => MaybePromise<EnqueuedTask>
   getIndex: (name: string) => Promise<Index<Record<string, any>>>
   addDocument: (indexName: string, params: any) => Promise<EnqueuedTask>
@@ -45,82 +64,59 @@ export interface SearchEngineDriver {
   updateIndex: (name: string, options: IndexOptions) => MaybePromise<EnqueuedTask>
   deleteIndex: (name: string) => MaybePromise<EnqueuedTask>
   listAllIndexes: () => MaybePromise<IndexesResults<Index[]>>
-  listAllIndices: () => MaybePromise<IndexesResults<Index[]>> 
-
+  listAllIndices: () => MaybePromise<IndexesResults<Index[]>>
   getFilterableAttributes: (index: string) => Promise<string[]>
   updateFilterableAttributes: (index: string, filterableAttributes: string[] | null) => Promise<EnqueuedTask>
   resetFilterableAttributes: (index: string) => Promise<EnqueuedTask>
-
   updateSearchableAttributes: (index: string, searchableAttributes: string[] | null) => Promise<EnqueuedTask>
   resetSearchableAttributes: (index: string) => Promise<EnqueuedTask>
   getSearchableAttributes: (index: string) => Promise<string[]>
-
   updateSortableAttributes: (index: string, sortableAttributes: string[] | null) => Promise<EnqueuedTask>
   resetSortableAttributes: (index: string) => Promise<EnqueuedTask>
   getSortableAttributes: (index: string) => Promise<string[]>
-
   updateDisplayedAttributes: (index: string, displayedAttributes: string[] | null) => Promise<EnqueuedTask>
   getDisplayedAttributes: (index: string) => Promise<string[]>
   resetDisplayedAttributes: (index: string) => Promise<EnqueuedTask>
-
   getSettings: (index: string) => Promise<Settings>
   updateSettings: (index: string, settings: Settings) => Promise<EnqueuedTask>
   resetSettings: (index: string) => Promise<EnqueuedTask>
-  å
   getPagination: (index: string) => Promise<PaginationSettings>
   updatePagination: (index: string, pagination: PaginationSettings) => Promise<EnqueuedTask>
   resetPagination: (index: string) => Promise<EnqueuedTask>
-
   getSynonyms: (index: string) => Promise<any>
   updateSynonyms: (index: string, synonyms: Synonyms) => Promise<EnqueuedTask>
   resetSynonyms: (index: string) => Promise<EnqueuedTask>
-
   getRankingRules: (index: string) => Promise<string[]>
   updateRankingRules: (index: string, rankingRules: string[] | null) => Promise<EnqueuedTask>
   resetRankingRules: (index: string) => Promise<EnqueuedTask>
-
   getDistinctAttribute: (index: string) => Promise<string | null>
   updateDistinctAttribute: (index: string, distinctAttribute: string | null) => Promise<EnqueuedTask>
   resetDistinctAttribute: (index: string) => Promise<EnqueuedTask>
-
   getFaceting: (index: string) => Promise<Faceting>
   updateFaceting: (index: string, faceting: Faceting) => Promise<EnqueuedTask>
   resetFaceting: (index: string) => Promise<EnqueuedTask>
-
   getTypoTolerance: (index: string) => Promise<TypoTolerance>
   updateTypoTolerance: (index: string, typoTolerance: TypoTolerance | null) => Promise<EnqueuedTask>
   resetTypoTolerance: (index: string) => Promise<EnqueuedTask>
-
   getDictionary: (index: string) => Promise<Dictionary>
   updateDictionary: (index: string, dictionary: Dictionary | null) => Promise<EnqueuedTask>
   resetDictionary: (index: string) => Promise<EnqueuedTask>
-
 }
-
-export interface SearchEngineStorage {
+/**
+ * This interface is used to unify the persisting of data to localStorage
+ */
+export declare interface SearchEngineStorage {
   index?: string
   results?: SearchResponse
   hits?: Hits
   perPage: number
   currentPage: number
 }
-
-export interface SearchOptions {
+export declare interface SearchOptions {
   displayable: string[]
   searchable: string[]
   sortable: string[]
   filterable: string[]
   options?: SearchEngineOptions
 }
-
-  EnqueuedTask,
-  Hits,
-  Index,
-  IndexesResults,
-  IndexOptions,
-  MeiliSearch,
-  MeilisearchOptions,
-  RecordOptions,
-  SearchParams,
-  SearchResponse,
-}
+export type SearchEngineConfig = Partial<SearchEngineOptions>;

package/dist/{security.d.ts → src/security.d.ts}

@@ -1,8 +1,7 @@
 import type { CountryCode } from './cloud';
 import type { DeepPartial } from './utils';
-
 export declare interface FirewallOptions {
-  enabled: boolean 
+  enabled: boolean
   countryCodes: CountryCode[]
   ipAddresses: string[]
   queryString: string[]
@@ -11,12 +10,9 @@ export declare interface FirewallOptions {
   useIpReputationLists: boolean
   useKnownBadInputsRuleSet: boolean
 }
-export declare type FirewallConfig = Partial<FirewallOptions>
-
-export interface SecurityOptions {
+export declare interface SecurityOptions {
   driver: 'aws'
-
   firewall: FirewallOptions
 }
-
-export type SecurityConfig = DeepPartial<SecurityOptions>
+export type FirewallConfig = Partial<FirewallOptions>;
+export type SecurityConfig = DeepPartial<SecurityOptions>;

package/dist/{server.d.ts → src/server.d.ts}

@@ -13,4 +13,4 @@ export declare interface ServerOptions {
   host?: string
   port?: number
   open?: boolean
-}
+}

package/dist/src/services.d.ts

@@ -0,0 +1,140 @@
+export declare interface ServicesOptions {
+  algolia?: {
+    appId: string
+    apiKey: string
+  }
+  aws?: {
+    accountId: string
+    appId: string
+    apiKey: string
+    region: string
+  }
+  github?: {
+    clientId: string
+    clientSecret: string
+    redirectUrl: string
+    scopes?: string[]
+  }
+  google?: {
+    clientId: string
+    clientSecret: string
+    redirectUrl: string
+    scopes?: string[]
+  }
+  facebook?: {
+    clientId: string
+    clientSecret: string
+    redirectUrl: string
+    scopes?: string[]
+  }
+  twitter?: {
+    clientId: string
+    clientSecret: string
+    redirectUrl: string
+    scopes?: string[]
+  }
+  godaddy?: {
+    apiKey: string
+    apiSecret: string
+  }
+  hetzner: {
+    appId: string
+    apiKey: string
+  }
+  digitalOcean: {
+    appId: string
+    apiKey: string
+  }
+  mailgun?: {
+    apiKey?: string
+    domain?: string
+    endpoint?: string
+    maxRetries?: number
+    retryTimeout?: number
+  }
+  mailtrap?: {
+    token: string
+    host: string
+    inboxId?: string | number
+    maxRetries?: number
+    retryTimeout?: number
+  }
+  meilisearch?: {
+    appId: string
+    apiKey: string
+  }
+  sendgrid?: {
+    apiKey?: string
+    maxRetries?: number
+    retryTimeout?: number
+  }
+  ses?: {
+    region: string
+    credentials: {
+      accessKeyId?: string
+      secretAccessKey?: string
+    }
+    maxRetries?: number
+    retryTimeout?: number
+  }
+  smtp?: {
+    host: string
+    port: number
+    username?: string
+    password?: string
+    encryption?: 'tls' | 'ssl' | null
+    maxRetries?: number
+    retryTimeout?: number
+  }
+  slack?: {
+    appId?: string
+    clientId?: string
+    secretKey?: string
+    webhookUrl?: string
+    botToken?: string
+    maxRetries?: number
+    retryTimeout?: number
+  }
+  discord?: {
+    webhookUrl?: string
+    botToken?: string
+    maxRetries?: number
+    retryTimeout?: number
+  }
+  teams?: {
+    webhookUrl?: string
+    maxRetries?: number
+    retryTimeout?: number
+  }
+  expo?: {
+    accessToken?: string
+  }
+  fcm?: {
+    serverKey?: string
+    projectId?: string
+    clientEmail?: string
+    privateKey?: string
+  }
+  openai?: {
+    apiKey?: string
+    model?: string
+    embeddingModel?: string
+    baseUrl?: string
+  }
+  anthropic?: {
+    apiKey?: string
+    model?: string
+    maxTokens?: number
+  }
+  ollama?: {
+    host?: string
+    model?: string
+    embeddingModel?: string
+  }
+  stripe?: {
+    secretKey?: string
+    publicKey?: string
+    apiVersion?: string
+  }
+}
+export type ServicesConfig = Partial<ServicesOptions>;

package/dist/{settings-config.d.ts → src/settings-config.d.ts}

@@ -6,4 +6,4 @@ export declare interface SettingsMenuOption {
 export declare interface MenuIcon {
   name?: string
   source?: string
-}
+}

package/dist/src/sms.d.ts

@@ -0,0 +1,144 @@
+export declare interface SmsMessage {
+  to: string | string[]
+  body: string
+  from?: string
+  mediaUrls?: string[]
+  statusCallback?: string
+  options?: Record<string, unknown>
+}
+export declare interface SmsSendResult {
+  success: boolean
+  messageId?: string
+  status?: SmsStatus
+  to: string
+  error?: string
+  provider: SmsProvider
+  segments?: number
+  price?: number
+  currency?: string
+}
+export declare interface SmsStatusUpdate {
+  messageId: string
+  to: string
+  status: SmsStatus
+  timestamp: Date
+  errorCode?: string
+  errorMessage?: string
+}
+// =============================================================================
+// Provider Configurations
+// =============================================================================
+export declare interface TwilioConfig {
+  accountSid: string
+  authToken: string
+  from?: string
+  messagingServiceSid?: string
+  statusCallback?: string
+}
+export declare interface VonageConfig {
+  apiKey: string
+  apiSecret: string
+  from?: string
+  applicationId?: string
+  privateKey?: string
+}
+export declare interface AwsSmsConfig {
+  region: string
+  accessKeyId?: string
+  secretAccessKey?: string
+  senderId?: string
+  originationNumber?: string
+}
+// =============================================================================
+// SMS Options (Main Config)
+// =============================================================================
+export declare interface SmsTemplateConfig {
+  name: string
+  body: string
+  variables?: string[]
+}
+export declare interface SmsOptOutConfig {
+  enabled: boolean
+  keywords: string[]
+}
+export declare interface SmsTwoWayConfig {
+  enabled: boolean
+  webhookUrl?: string
+  snsTopicArn?: string
+}
+export declare interface SmsInboxConfig {
+  enabled: boolean
+  bucket: string
+  prefix?: string
+  retentionDays?: number
+}
+export declare interface SmsOptions {
+  enabled: boolean
+  provider: SmsProvider
+  from?: string
+  defaultCountryCode?: string
+  messageType?: 'TRANSACTIONAL' | 'PROMOTIONAL'
+  drivers: {
+    twilio?: TwilioConfig
+    vonage?: VonageConfig
+    pinpoint?: AwsSmsConfig
+    sns?: AwsSmsConfig
+  }
+  optOut?: SmsOptOutConfig
+  twoWay?: SmsTwoWayConfig
+  templates?: SmsTemplateConfig[]
+  inbox?: SmsInboxConfig
+  maxSpendPerMonth?: number
+}
+// =============================================================================
+// SMS Driver Interface
+// =============================================================================
+export declare interface SmsDriver {
+  send(message: SmsMessage): Promise<SmsSendResult>
+  sendBulk(messages: SmsMessage[]): Promise<SmsSendResult[]>
+  getStatus?(messageId: string): Promise<SmsStatusUpdate>
+  verify?(phoneNumber: string): Promise<{ valid: boolean, carrier?: string, type?: string }>
+  getBalance?(): Promise<{ balance: number, currency: string }>
+}
+// =============================================================================
+// Verification Types (for 2FA/OTP)
+// =============================================================================
+export declare interface VerificationRequest {
+  to: string
+  channel?: 'sms' | 'call' | 'whatsapp'
+  codeLength?: number
+  locale?: string
+  customMessage?: string
+}
+export declare interface VerificationResult {
+  success: boolean
+  verificationId?: string
+  status: 'pending' | 'approved' | 'denied' | 'expired'
+  error?: string
+}
+export declare interface VerificationCheckRequest {
+  verificationId?: string
+  to: string
+  code: string
+}
+export declare interface SmsVerificationDriver {
+  startVerification(request: VerificationRequest): Promise<VerificationResult>
+  checkVerification(request: VerificationCheckRequest): Promise<VerificationResult>
+  cancelVerification?(verificationId: string): Promise<boolean>
+}
+/**
+ * SMS Service Configuration Types
+ * Supports Twilio, Vonage, and AWS providers
+ */
+// =============================================================================
+// Core SMS Types
+// =============================================================================
+export type SmsProvider = 'twilio' | 'vonage' | 'pinpoint' | 'sns';
+export type SmsStatus = | 'queued'
+  | 'sending'
+  | 'sent'
+  | 'delivered'
+  | 'failed'
+  | 'undelivered'
+  | 'unknown';
+export type SmsConfig = Partial<SmsOptions>;

package/dist/src/stack-extensions.d.ts

@@ -0,0 +1,137 @@
+/**
+ * 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/src/stacks.d.ts

@@ -0,0 +1,40 @@
+import type { AiConfig, AnalyticsConfig, AppConfig, AuthConfig, BinaryConfig, CacheConfig, CloudConfig, DashboardConfig, DatabaseConfig, DnsConfig, DocsConfig, EmailConfig, ErrorConfig, FilesystemsConfig, GitConfig, HashingConfig, LibraryConfig, LoggingConfig, 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
+  realtime: RealtimeConfig
+  cache: CacheConfig
+  cli: BinaryConfig
+  cloud: CloudConfig
+  dashboard: DashboardConfig
+  database: DatabaseConfig
+  dns: DnsConfig
+  docs: DocsConfig
+  email: EmailConfig
+  errors: ErrorConfig
+  git: GitConfig
+  hashing: HashingConfig
+  library: LibraryConfig
+  logging: LoggingConfig
+  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>;