@stacksjs/types 0.68.2 → 0.69.2

package/dist/search-engine.d.ts

@@ -1,17 +1,6 @@
 import type { MaybePromise } from '.';
 
-export type {;
-declare 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 type {
 export declare interface SearchEngineOptions {
   driver: 'opensearch'
 
@@ -23,6 +12,14 @@ export declare interface SearchEngineOptions {
     auth: string
   }
 
+  meilisearch?: {
+    host: string
+    protocol: number
+    port: number
+    auth: string
+    apiKey: string
+  }
+
   filters?: {
     [key: string]: string
   }
@@ -30,59 +27,100 @@ export declare interface SearchEngineOptions {
   perPage?: number
 }
 export declare type SearchEngineConfig = Partial<SearchEngineOptions>
-export declare interface SearchEngineDriver {
-  client: MeiliSearch
+
+export interface SearchEngineDriver {
+  client: () => MeiliSearch
+
+  search: (index: string, params: any) => Promise<SearchResponse<Record<string, any>>>
 
   createIndex: (name: string, options?: IndexOptions) => MaybePromise<EnqueuedTask>
-  getIndex: (name: string) => MaybePromise<Index>
+  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>
-  updateIndexSettings: (name: string, settings: SearchEngineOptions) => MaybePromise<EnqueuedTask>
   listAllIndexes: () => MaybePromise<IndexesResults<Index[]>>
   listAllIndices: () => MaybePromise<IndexesResults<Index[]>> 
 
-  getRecord: (key: string) => MaybePromise<any>
-  getRecords: (key: string) => MaybePromise<RecordOptions>
-  createRecord: (record: any, indexName: string, options: RecordOptions) => MaybePromise<EnqueuedTask>
-  createRecords: (records: any, indexName: string, options: RecordOptions) => MaybePromise<EnqueuedTask>
-  createOrReplaceRecord: (record: any, indexName: string, options: RecordOptions) => MaybePromise<EnqueuedTask>
-  createOrUpdateRecord: (record: any, indexName: string, options: RecordOptions) => MaybePromise<EnqueuedTask>
-  deleteRecord: (recordId: string | number, indexName: string) => MaybePromise<EnqueuedTask>
-  deleteAllRecords: (indexName: string) => MaybePromise<EnqueuedTask>
-  batchDeleteRecords: (recordIds: string[] | number[], indexName: string) => MaybePromise<EnqueuedTask>
-
-  search: (query: string, indexName: string, options: SearchParams) => MaybePromise<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 
-  searchFilters: SearchFilters
-  searchParams: SearchParams
-  setTotalHits: number
-  sort: Sort
-  sorts: Sorts
-  totalPages: number
+  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 declare interface SearchEngineStorage {
+
+export interface SearchEngineStorage {
   index?: string
   results?: SearchResponse
   hits?: Hits
   perPage: number
   currentPage: number
 }
-export declare interface SearchOptions {
+
+export interface SearchOptions {
+  displayable: string[]
   searchable: string[]
   sortable: string[]
   filterable: string[]
   options?: SearchEngineOptions
+}
+
+  EnqueuedTask,
+  Hits,
+  Index,
+  IndexesResults,
+  IndexOptions,
+  MeiliSearch,
+  MeilisearchOptions,
+  RecordOptions,
+  SearchParams,
+  SearchResponse,
 }

package/dist/security.d.ts

@@ -12,9 +12,11 @@ export declare interface FirewallOptions {
   useKnownBadInputsRuleSet: boolean
 }
 export declare type FirewallConfig = Partial<FirewallOptions>
-export declare interface SecurityOptions {
+
+export interface SecurityOptions {
   driver: 'aws'
 
   firewall: FirewallOptions
 }
-export declare type SecurityConfig = DeepPartial<SecurityOptions>
+
+export type SecurityConfig = DeepPartial<SecurityOptions>

package/dist/storage.d.ts

@@ -5,7 +5,8 @@ export declare interface StorageOptions {
   driver: 's3' | 'efs' | 'local'
 }
 export declare type StorageConfig = Partial<StorageOptions>
-export declare interface StorageDriver {
+
+export interface StorageDriver {
   list: (path: string, options?: any) => DirectoryListing
   changeVisibility: (path: string, visibility: string) => Promise<void>
   visibility: (path: string) => Promise<string>

package/dist/table-names.d.ts

@@ -0,0 +1 @@
+export declare type TableNames = 'projects' | 'subscriber_emails' | 'personal_access_tokens' | 'team_users' | 'teams' | 'activities' | 'subscribers' | 'deployments' | 'releases' | 'team_users' | 'users' | 'posts' | 'failed_jobs' | 'products' | 'payment_methods' | 'transactions' | 'jobs' | 'subscriptions' | 'errors'

package/dist/team.d.ts

@@ -1,7 +1,8 @@
 declare type TeamMemberName = string
 type Email = string
 type TeamMembers = Record<TeamMemberName, Email>
-export declare interface Team {
+
+export interface Team {
   name: string
   members?: TeamMembers
 }

package/dist/ui.d.ts

@@ -2,20 +2,23 @@ import type { UserConfig } from '@unocss/core';
 import type { UserShortcuts } from 'unocss';
 
 export declare type Font = 'inter' | 'mona' | 'hubot'
-export type Icon = 'heroicons'
-export declare type WebFontsProviders = 'google' | 'bunny' | 'fontshare'
+export type Icon = 'heroicons' | 'hugeicons'
+export type WebFontsProviders = 'google' | 'bunny' | 'fontshare'
 export type Shortcuts = UserShortcuts
-export declare interface FontInfo {
+
+export interface FontInfo {
   title: string
   text: string
 }
-export declare interface WebFontMeta {
+
+export interface WebFontMeta {
   name: string
   weights?: (string | number)[]
   italic?: boolean
   provider?: WebFontsProviders
 }
-export declare interface UiOptions {
+
+export interface UiOptions {
   shortcuts: Shortcuts
 
   safelist: string
@@ -38,5 +41,7 @@ export declare interface UiOptions {
   variants: UserConfig['variants']
   layers: UserConfig['layers']
 }
-export declare type UiConfig = Partial<UiOptions>
-export declare type ResetPreset = 'tailwind' | 'normalize' | 'sanitize' | 'eric-meyer' | 'antfu' | null
+
+export type UiConfig = Partial<UiOptions>
+
+export type ResetPreset = 'tailwind' | 'normalize' | 'sanitize' | 'eric-meyer' | 'antfu' | null

package/dist/utils.d.ts

@@ -1,12 +1,18 @@
 export declare type Nullable<T> = T | null | undefined
-export declare type Fn<T = void> = () => T
-export declare type Arrayable<T> = T | Array<T>
-export declare type Constructor<T = void> = new (...args: any[]) => T
-export declare type UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends (k: infer I) => void
+
+export type Fn<T = void> = () => T
+
+export type Arrayable<T> = T | Array<T>
+
+export type Constructor<T = void> = new (...args: any[]) => T
+
+export type UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends (k: infer I) => void
   ? I
   : never
-export declare type MergeInsertions<T> = T extends object ? { [K in keyof T]: MergeInsertions<T[K]> } : T
-export declare type DeepMerge<F, S> = MergeInsertions<{
+
+export type MergeInsertions<T> = T extends object ? { [K in keyof T]: MergeInsertions<T[K]> } : T
+
+export type DeepMerge<F, S> = MergeInsertions<{
   [K in keyof F | keyof S]: K extends keyof S & keyof F
     ? DeepMerge<F[K], S[K]>
     : K extends keyof S
@@ -15,6 +21,7 @@ export declare type DeepMerge<F, S> = MergeInsertions<{
         ? F[K]
         : never
 }>
-export declare type DeepPartial<T> = {
+
+export type DeepPartial<T> = {
   [P in keyof T]?: DeepPartial<T[P]>
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/types",
   "type": "module",
-  "version": "0.68.2",
+  "version": "0.69.2",
   "description": "The Stacks framework types.",
   "author": "Chris Breuer",
   "contributors": [
@@ -43,37 +43,35 @@
     "typecheck": "bun tsc --noEmit",
     "prepublishOnly": "bun run build"
   },
-  "dependencies": {
+  "devDependencies": {
     "@mdit-vue/plugin-component": "^2.1.3",
     "@mdit-vue/plugin-frontmatter": "^2.1.3",
     "@mdit-vue/types": "^2.1.0",
-    "@rollup/pluginutils": "^5.1.3",
-    "@stacksjs/validation": "0.68.1",
+    "@rollup/pluginutils": "^5.1.4",
+    "@stacksjs/validation": "0.69.2",
     "@types/aws4": "^1.11.6",
-    "@types/bun": "^1.1.12",
+    "@types/bun": "^1.2.2",
     "@types/crypto-js": "^4.2.2",
     "@types/fs-extra": "^11.0.4",
     "@types/markdown-it-link-attributes": "^3.0.5",
     "@types/minimatch": "^5.1.2",
     "@types/nprogress": "^0.2.3",
-    "@vinejs/vine": "^2.1.0",
+    "@vinejs/vine": "^3.0.0",
+    "aws-cdk-lib": "^2.179.0",
     "cac": "^6.7.14",
     "markdown-it": "^14.1.0",
-    "meilisearch": "^0.44.1",
+    "meilisearch": "^0.49.0",
     "neverthrow": "^8.1.1",
-    "ora": "^8.1.0",
-    "unocss": "0.61.0",
-    "unplugin-auto-import": "^0.18.3",
-    "unplugin-vue-components": "^0.27.4",
-    "vite": "^5.4.10",
-    "vite-plugin-inspect": "^0.8.7",
-    "vite-plugin-pwa": "^0.20.5",
-    "vite-ssg": "^0.23.8",
-    "vitepress": "1.4.1",
-    "vue": "^3.5.12"
-  },
-  "devDependencies": {
-    "aws-cdk-lib": "^2.164.1",
-    "typescript": "^5.6.3"
+    "ora": "^8.2.0",
+    "typescript": "^5.7.3",
+    "unocss": "66.0.0",
+    "unplugin-auto-import": "^19.1.0",
+    "unplugin-vue-components": "^28.1.0",
+    "vite": "^6.1.0",
+    "vite-plugin-inspect": "^10.2.1",
+    "vite-plugin-pwa": "^0.21.1",
+    "vite-ssg": "^25.0.0",
+    "vitepress": "1.6.3",
+    "vue": "^3.5.13"
   }
 }

package/src/attributes.ts

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

package/src/cli.ts

@@ -363,7 +363,6 @@ export type DomainsOptions = CliOptions & {
 
 export interface CleanOptions extends CliOptions {}
 
-export interface SaasOptions extends CliOptions {}
 export interface CloudCliOptions extends CliOptions {
   ssh?: boolean
   connect?: boolean
@@ -373,16 +372,24 @@ export interface CloudCliOptions extends CliOptions {
   diff?: boolean
 }
 export interface CommitOptions extends CliOptions {}
-export interface KeyOptions extends CliOptions {}
 export interface FreshOptions extends CliOptions {
   dryRun?: boolean
   quiet?: boolean
 }
+
+export interface InspireOptions extends CliOptions {}
+export interface InstallOptions extends CliOptions {}
+
+export interface KeyOptions extends CliOptions {}
+
 export interface MigrateOptions extends CliOptions {
   diff?: boolean
 }
-export interface InspireOptions extends CliOptions {}
-export interface InstallOptions extends CliOptions {}
+
+export interface CliQueueOptions extends CliOptions {
+  queue?: string
+}
+
 export interface ReleaseOptions extends CliOptions {
   dryRun?: boolean
 }
@@ -394,6 +401,17 @@ export interface PrepublishOptions extends CliOptions {}
 export interface PortsOptions extends CliOptions {
   ports?: Partial<Ports>
 }
+
+export interface SaasOptions extends CliOptions {}
+
+export interface SearchCommandOptions extends CliOptions {
+  model: string
+  settings: boolean
+  flush: boolean
+}
+
+export interface ScheduleOptions extends CliOptions {}
+
 export interface TinkerOptions extends CliOptions {}
 export interface TypesOptions extends CliOptions {}
 

package/src/cron-jobs.ts

@@ -1,40 +1,15 @@
-import type { IntRange } from '@stacksjs/scheduler'
+import type { IntRange } from '@stacksjs/cron'
 
-/**
- * Cron Job Options.
- */
-export interface JobOptions {
-  /**
-   * The name of the job.
-   */
-  name?: string
-
-  // eslint-disable-next-line ts/no-unsafe-function-type
-  handle?: string | Function
-  action?: string
-  description?: string
-  queue?: string
-  timezone?: string
-  /**
-   * Number of tries. Must be between 0 and 185.
-   */
-  tries?: IntRange<0, 185>
-  backoff?: number | number[]
-  rate?: string | Every
-  enabled?: boolean
-}
-
-export type JobConfig = JobOptions
 export type Job = JobOptions
 export type Jobs = Job[]
 export type CronJob = Job
 export type CronJobs = Jobs
 
 export enum Every {
-  // Second = '* * * * * *',
-  // FiveSeconds = '*/5 * * * * *',
-  // TenSeconds = '*/10 * * * * *',
-  // ThirtySeconds = '*/30 * * * * *',
+  Second = '* * * * * *',
+  FiveSeconds = '*/5 * * * * *',
+  TenSeconds = '*/10 * * * * *',
+  ThirtySeconds = '*/30 * * * * *',
   Minute = '* * * * *',
   TwoMinutes = '*/2 * * * *',
   FiveMinutes = '*/5 * * * *',
@@ -50,3 +25,122 @@ export enum Every {
   Month = '0 0 1 * *',
   Year = '0 0 1 1 *',
 }
+
+export type JobHandler = (data?: any) => Promise<any> | any
+
+/**
+ * Represents different backoff strategies for job retries
+ */
+type BackoffStrategy = 'fixed' | 'exponential' | 'linear' | 'random'
+
+export interface JitterConfig {
+  /**
+   * Enable/disable jitter
+   */
+  enabled: boolean
+  /**
+   * Maximum percentage of variation (0-1)
+   */
+  factor?: number
+  /**
+   * Minimum delay in milliseconds
+   */
+  minDelay?: number
+  /**
+   * Maximum delay in milliseconds
+   */
+  maxDelay?: number
+}
+
+export interface BackoffConfig {
+  /**
+   * The strategy to use for calculating delay between retries
+   */
+  strategy: BackoffStrategy
+  /**
+   * Initial delay in milliseconds
+   */
+  initialDelay: number
+  /**
+   * For exponential/linear backoff: the multiplier/increment to apply
+   */
+  factor?: number
+  /**
+   * Maximum delay between retries in milliseconds
+   */
+  maxDelay?: number
+  /**
+   * Jitter configuration to add randomness to delays
+   */
+  jitter?: JitterConfig
+}
+
+export interface JobOptions {
+  /**
+   * The name of the job
+   */
+  name?: string
+  /**
+   * Job handler function or identifier string
+   */
+  handle?: string | JobHandler
+  /**
+   * Action identifier
+   */
+  action?: string
+  /**
+   * Job description
+   */
+  description?: string
+  /**
+   * Queue name
+   */
+  queue?: string
+  /**
+   * Timezone for scheduling
+   */
+  timezone?: string
+  /**
+   * Number of retry attempts. Must be between 0 and 185
+   */
+  tries?: IntRange<0, 185>
+  /**
+   * Simple backoff configuration using delay values
+   * Can be a single number for fixed delay,
+   * or an array of delays for custom retry delays
+   */
+  backoff?: number | number[]
+  /**
+   * Advanced backoff configuration
+   */
+  backoffConfig?: BackoffConfig
+  /**
+   * Rate limiting configuration
+   * Can be a string like "5/minute" or an Every object
+   */
+  rate?: string | Every
+  /**
+   * Whether the job is enabled
+   */
+  enabled?: boolean
+  /**
+   * Maximum execution time in milliseconds
+   */
+  timeout?: number
+  /**
+   * Unique job key to prevent duplicates
+   */
+  key?: string
+  /**
+   * Time-to-live in seconds for the job key
+   */
+  ttl?: number
+  /**
+   * Whether to run the job immediately when added
+   */
+  immediate?: boolean
+  /**
+   * Custom metadata for the job
+   */
+  meta?: Record<string, any>
+}

package/src/docs.ts

@@ -14,6 +14,7 @@ export interface SocialLink {
 }
 
 export enum SocialLinkIcon {
+  Bluesky = 'bluesky',
   Discord = 'discord',
   Facebook = 'facebook',
   GitHub = 'github',

package/src/events.ts

@@ -28,3 +28,5 @@
 export interface Events {
   [key: string]: string[]
 }
+
+export * from '../../../types/events'

package/src/index.ts

@@ -2,6 +2,7 @@ export * from './ai'
 export * from './analytics'
 export * from './api'
 export * from './app'
+export * from './attributes'
 export * from './auto-imports'
 export * from './binary'
 export * from './build'
@@ -45,6 +46,7 @@ export * from './pwa'
 export * from './queue'
 export * from './reactivity'
 export * from './request'
+export * from './response'
 export * from './router'
 export * from './saas'
 export * from './scheduler'
@@ -57,6 +59,7 @@ export * from './sms'
 export * from './ssg'
 export * from './stacks'
 export * from './storage'
+export * from './table-names'
 export * from './tables'
 export * from './team'
 export * from './ui'

package/src/model-names.ts

@@ -1 +1 @@
-export type ModelNames = 'Project' | 'SubscriberEmail' | 'AccessToken' | 'Team' | 'Subscriber' | 'Deployment' | 'Release' | 'User' | 'Post' | 'Subscription' | 'Error'
+export type ModelNames = 'Project' | 'SubscriberEmail' | 'AccessToken' | 'Team' | 'Activity' | 'Subscriber' | 'Deployment' | 'Release' | 'User' | 'Post' | 'FailedJob' | 'Product' | 'PaymentMethod' | 'Transaction' | 'Job' | 'Subscription' | 'Error'