@stacksjs/types 0.70.88 → 0.70.91

package/dist/response.d.ts

@@ -0,0 +1,15 @@
+export declare interface ResponseInstance {
+  json: (data: any, status?: number) => ResponseData
+  success: (data: any) => ResponseData
+  created: (data: any) => ResponseData
+  noContent: () => ResponseData
+  error: (message: string, status: number) => ResponseData
+  forbidden: (message: string) => ResponseData
+  unauthorized: (message: string) => ResponseData
+  notFound: (message: string) => ResponseData
+}
+export declare interface ResponseData {
+  status: number
+  headers: { [key: string]: string }
+  body: string
+}

package/dist/router.d.ts

@@ -0,0 +1,105 @@
+import type { Action } from '@stacksjs/actions';
+import type { HttpMethod } from './request';
+import type { ValidationType } from '@stacksjs/ts-validation';
+export declare interface RequestData {
+  [key: string]: any
+}
+export declare interface ValidationField {
+  rule: ValidationType
+  message: Record<string, string>
+}
+export declare interface CustomAttributes {
+  [key: string]: ValidationField
+}
+export declare interface RouteParams { [key: string]: string | number }
+export declare interface Route {
+  name: string
+  uri: string
+  url: string
+  path?: string
+  prefix?: string
+  method: HttpMethod
+  pattern: RegExp
+  callback: RouteCallback | ActionPath | Action | Promise<any>
+  paramNames: string[]
+  middleware?: string | string[]
+  statusCode?: StatusCode
+}
+export declare interface ServeOptions {
+  host?: string
+  port?: number
+  debug?: boolean
+  timezone?: string
+}
+export declare interface Options {
+  statusCode?: StatusCode
+}
+export declare interface MiddlewareOptions {
+  name: string
+  description?: string
+  priority: number
+  handle: (request: Request) => Promise<void> | void
+}
+export declare interface RouteParam { [key: string]: string | number }
+export declare interface Middlewares {
+  logger: MiddlewareFn
+  auth: MiddlewareFn
+  [key: string]: MiddlewareFn
+}
+export declare interface RouteGroupOptions {
+  prefix?: string
+  middleware?: Route['middleware']
+}
+export declare interface RouterInterface {
+  get: (url: Route['url'], callback: Route['callback']) => this
+  post: (url: Route['url'], callback: Route['callback']) => this
+  view: (url: Route['url'], callback: Route['callback']) => this
+  redirect: (url: Route['url'], callback: Route['callback'], status?: RedirectCode) => this
+  delete: (url: Route['url'], callback: Route['callback']) => this
+  patch: (url: Route['url'], callback: Route['callback']) => this
+  put: (url: Route['url'], callback: Route['callback']) => this
+  email: (url: Route['url']) => Promise<this>
+  health: () => Promise<this>
+  job: (url: Route['url']) => Promise<this>
+  action: (url: Route['url']) => Promise<this>
+  group: (options: Prefix | RouteGroupOptions, callback: () => void) => this
+  name: (name: string) => this
+  middleware: (middleware: Route['middleware']) => this
+  getRoutes: () => Promise<Route[]>
+}
+export declare interface RouterInstance {
+  query: any
+  params: RouteParams
+  headers: any
+  addQuery: (url: URL) => void
+  addBodies: (params: any) => void
+  addParam: (param: RouteParam) => void
+  addHeaders: (headerParams: Headers) => void
+  get: <K extends string>(element: K, defaultValue?: K extends NumericField ? number : string) => K extends NumericField ? number : string
+  all: () => any
+  validate: (attributes?: CustomAttributes) => Promise<void>
+  has: (element: string) => boolean
+  isEmpty: () => boolean
+  extractParamsFromRoute: (routePattern: string, pathname: string) => void
+  header: (headerParam: string) => string | number | boolean | null
+  getHeaders: () => any
+  Header: (headerParam: string) => string | number | boolean | null
+  getParam: <T>(key: string) => T
+  route: (key: string) => number | string | null
+  bearerToken: () => string | null | RouterAuthToken
+  getParams: () => RouteParams
+  getParamAsInt: (key: string) => number | null
+  browser: () => string | null
+  ip: () => string | null
+  ipForRateLimit: () => string | null
+}
+declare type Request = any;
+declare type ActionPath = string;
+// need to refactor before, after, view to be a part of some other type
+export type RouteCallback = ((_params?: Record<string, any>) => any | string | object) | ((req: any, res: any) => Promise<void>);
+export type RouterAuthToken = `${number}:${number}:${string}`;
+export type NumericField = 'id' | 'age' | 'count' | 'quantity' | 'amount' | 'price' | 'total' | 'score' | 'rating' | 'duration' | 'size' | 'weight' | 'height' | 'width' | 'length' | 'distance' | 'speed' | 'temperature' | 'volume' | 'capacity' | 'density' | 'pressure' | 'force' | 'energy' | 'power' | 'frequency' | 'voltage' | 'current' | 'resistance' | 'time' | 'date' | 'year' | 'month' | 'day' | 'hour' | 'minute' | 'second' | 'millisecond' | 'microsecond' | 'nanosecond';
+export type StatusCode = 200 | 201 | 202 | 204 | 301 | 302 | 304 | 400 | 401 | 403 | 404 | 500;
+export type RedirectCode = Extract<StatusCode, 301 | 302>;
+export type MiddlewareFn = (_request: Request) => Promise<void>;
+declare type Prefix = string;

package/dist/saas.d.ts

@@ -0,0 +1,32 @@
+export declare interface SaasOption {
+  plans: {
+    productName: string
+    description: string
+    pricing: {
+      key: string
+      price: number
+      interval?: 'day' | 'month' | 'week' | 'year'
+      currency: string
+    }[]
+    metadata: {
+      createdBy: string
+      version: string
+    }
+  }[]
+  webhook: {
+    endpoint: string
+    secret: string
+  }
+  currencies: string[]
+  coupons: {
+    code: string
+    amountOff: number
+    duration: 'once' | 'repeating' | 'forever'
+  }[]
+  products: {
+    name: string
+    description: string
+    images: string[]
+  }[]
+}
+export type SaasConfig = Partial<SaasOption>;

package/dist/scheduler.d.ts

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

package/dist/search-engine.d.ts

@@ -0,0 +1,129 @@
+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: 'meilisearch' | 'algolia' | 'opensearch' | 'typesense'
+  opensearch?: {
+    host: string
+    protocol: number
+    port: number
+    auth: string
+  }
+  meilisearch?: {
+    host: string
+    protocol?: number
+    port?: number
+    auth?: string
+    apiKey: string
+  }
+  algolia?: {
+    appId: string
+    apiKey: string
+    searchOnlyApiKey?: string
+  }
+  typesense?: {
+    host?: string
+    port?: number
+    protocol?: string
+    apiKey?: string
+  }
+  filters?: {
+    [key: string]: string
+  }
+  perPage?: number
+}
+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>
+  updateDocuments: (indexName: string, params: DocumentOptions[]) => Promise<EnqueuedTask>
+  updateDocument: (indexName: string, params: DocumentOptions) => Promise<EnqueuedTask>
+  addDocuments: (indexName: string, params: any[]) => Promise<EnqueuedTask>
+  getDocument: (indexName: string, id: number, fields: any) => Promise<EnqueuedTask>
+  deleteDocument: (indexName: string, id: number) => Promise<EnqueuedTask>
+  deleteDocuments: (indexName: string, filters: string | string[]) => Promise<EnqueuedTask>
+  updateIndex: (name: string, options: IndexOptions) => MaybePromise<EnqueuedTask>
+  deleteIndex: (name: string) => MaybePromise<EnqueuedTask>
+  listAllIndexes: () => 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>
+}
+/**
+ * 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 declare interface SearchOptions {
+  displayable: string[]
+  searchable: string[]
+  sortable: string[]
+  filterable: string[]
+  options?: SearchEngineOptions
+  denormalize?: Record<string, string>
+}
+export type SearchEngineConfig = Partial<SearchEngineOptions>;

package/dist/security.d.ts

@@ -0,0 +1,18 @@
+import type { CountryCode } from './cloud';
+import type { DeepPartial } from './utils';
+export declare interface FirewallOptions {
+  enabled: boolean
+  countryCodes: CountryCode[]
+  ipAddresses: string[]
+  queryString: string[]
+  httpHeaders: string[]
+  rateLimitPerMinute: number
+  useIpReputationLists: boolean
+  useKnownBadInputsRuleSet: boolean
+}
+export declare interface SecurityOptions {
+  driver: 'aws'
+  firewall: FirewallOptions
+}
+export type FirewallConfig = Partial<FirewallOptions>;
+export type SecurityConfig = DeepPartial<SecurityOptions>;

package/dist/server.d.ts

@@ -0,0 +1,16 @@
+export declare interface ServerOptions {
+  type?:
+    | 'frontend'
+    | 'backend'
+    | 'api'
+    | 'library'
+    | 'desktop'
+    | 'docs'
+    | 'email'
+    | 'admin'
+    | 'system-tray'
+    | 'database'
+  host?: string
+  port?: number
+  open?: boolean
+}

package/dist/services.d.ts

@@ -0,0 +1,149 @@
+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[]
+  }
+  apple?: {
+    clientId: string
+    teamId: string
+    keyId: string
+    privateKey: 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
+    webhookSecret?: string
+    apiVersion?: string
+  }
+}
+export type ServicesConfig = Partial<ServicesOptions>;

package/dist/settings-config.d.ts

@@ -0,0 +1,9 @@
+export declare interface SettingsMenuOption {
+  label: string
+  path: string
+  icon?: MenuIcon
+}
+export declare interface MenuIcon {
+  name?: string
+  source?: string
+}

package/dist/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>;