@stacksjs/types 0.70.85 → 0.70.87

package/src/saas.ts

@@ -1,33 +0,0 @@
-export interface SaasOption {
-  plans: {
-    productName: string
-    description: string
-    pricing: {
-      key: string
-      price: number
-      interval?: 'day' | 'month' | 'week' | 'year' // Optional interval
-      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/src/scheduler.ts

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

package/src/search-engine.ts

@@ -1,251 +0,0 @@
-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 '.'
-
-// 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 interface SearchEngineOptions {
-  /**
-   * **Search Engine Driver**
-   *
-   * The search engine to utilize.
-   *
-   * @default string 'meilisearch'
-   * @see https://stacksjs.com/docs/search-engine
-   */
-  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
-  }
-
-  /**
-   * The number of hits to be returned per page.
-   *
-   * @default number 20
-   */
-  perPage?: number
-}
-
-export type SearchEngineConfig = Partial<SearchEngineOptions>
-
-export interface SearchEngineDriver {
-  client: () => Meilisearch
-  resetClient?: () => void
-
-  search: (index: string, params: any) => Promise<SearchResponse<Record<string, any>>>
-
-  // Indexes
-  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[]>> // alternatives plural spelling
-
-  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>
-
-  // Search
-  // calculatePagination: Pages
-  // currentPage: Page
-  // filterName: string
-  // filters: Filters
-  // goToNextPage: () => Page
-  // goToPage: (pageNumber: number) => Page
-  // goToPrevPage: () => Page
-  // hits: Hits
-  // index: Index
-  // lastPage: Page
-  // perPage: number
-  // query: string
-  // results: Results // SearchResponse
-  // searchFilters: SearchFilters
-  // searchParams: SearchParams
-  // setTotalHits: number
-  // sort: Sort
-  // sorts: Sorts
-  // totalPages: number
-}
-
-/**
- * This interface is used to unify the persisting of data to localStorage
- */
-export interface SearchEngineStorage {
-  /**
-   * The search engine index name.
-   * i.e. the type of table, like `users`, `posts`, `products`, etc.
-   */
-  index?: string
-  /**
-   * The search engine results object.
-   */
-  results?: SearchResponse
-  /**
-   * The search engine hits object.
-   */
-  hits?: Hits
-  /**
-   * The number of hits to be returned per page.
-   *
-   * @default number 20
-   */
-  perPage: number
-  /**
-   * The current page number.
-   *
-   * @default number 1
-   */
-  currentPage: number
-}
-
-export interface SearchOptions {
-  displayable: string[]
-  searchable: string[]
-  sortable: string[]
-  filterable: string[]
-  options?: SearchEngineOptions
-  /**
-   * Cross-table denormalisation for searchable fields that live on a
-   * related model (stacksjs/stacks#1918). Maps an indexed-document
-   * field name to a dot-path resolved against the model instance's
-   * `_relations`. Without this, `toSearchableObject` only reads from
-   * `_attributes` and silently emits `undefined` for any field that
-   * exists on a `belongsTo` / `hasOne` / `hasMany` relation.
-   *
-   * Example: a `Judge` belongsTo a `CourtHouse`. To make the court
-   * house's `name` searchable on the judge index:
-   *
-   *   useSearch: {
-   *     searchable:  ['name', 'court_name'],
-   *     displayable: ['id', 'name', 'court_name'],
-   *     denormalize: { court_name: 'court_house.name' },
-   *   }
-   *
-   * The caller is responsible for eager-loading the named relations
-   * (e.g. via `Judge.query().with('court_house').get()`) — the live
-   * observer hook and the CLI bulk-index path do this automatically
-   * for every distinct head segment in the `denormalize` map.
-   * `toSearchableObject` stays synchronous; no per-row database lookup.
-   */
-  denormalize?: Record<string, string>
-}
-
-export type {
-  EnqueuedTask,
-  Hits,
-  Index,
-  IndexesResults,
-  IndexOptions,
-  Meilisearch,
-  MeilisearchOptions,
-  RecordOptions,
-  SearchParams,
-  SearchResponse,
-}

package/src/security.ts

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

package/src/server.ts

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

package/src/services.ts

@@ -1,211 +0,0 @@
-export 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[]
-  }
-
-  /**
-   * Sign in with Apple. Apple has no static client secret — the driver
-   * signs a short-lived ES256 JWT from teamId + keyId + privateKey
-   * (the .p8 file's contents) instead.
-   */
-  apple?: {
-    /** The Services ID identifier, e.g. `org.example.web` */
-    clientId: string
-    /** Apple Developer Team ID (10 chars) */
-    teamId: string
-    /** Key ID of the "Sign in with Apple" key */
-    keyId: string
-    /** Contents of the downloaded .p8 private key */
-    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
-  }
-
-  // lemonSqueezy?: {
-  //   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 Configuration for local development
-   * Works with HELO, Mailtrap Desktop, Mailhog, etc.
-   */
-  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
-  }
-
-  // Push Notification Services
-  expo?: {
-    accessToken?: string
-  }
-
-  fcm?: {
-    serverKey?: string
-    projectId?: string
-    clientEmail?: string
-    privateKey?: string
-  }
-
-  // AI Services
-  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
-    /**
-     * Signing secret for verifying inbound Stripe webhook requests
-     * (`whsec_...`, from the Stripe dashboard's webhook endpoint
-     * config). Required by any app receiving Stripe webhooks —
-     * without it, `stripe.webhooks.constructEvent` has nothing to
-     * verify the `stripe-signature` header against.
-     */
-    webhookSecret?: string
-    /**
-     * Pinned Stripe API version. Defaults to whatever the bundled SDK
-     * was compiled against; override here when rolling forward without
-     * a code change. Format: 'YYYY-MM-DD' or 'YYYY-MM-DD.preview'.
-     */
-    apiVersion?: string
-  }
-
-  // supabase?: {
-  //   appId: string
-  //   apiKey: string
-  // }
-}
-
-export type ServicesConfig = Partial<ServicesOptions>

package/src/settings-config.ts

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