@stacksjs/types 0.58.48 → 0.58.49

package/src/router.ts

@@ -0,0 +1,70 @@
+export interface NitroEventHandler {
+  /**
+   * Path prefix or route
+   *
+   * If an empty string used, will be used as a middleware
+   */
+  route?: string
+
+  /**
+   * Specifies this is a middleware handler.
+   * Middleware are called on every route and should normally return nothing to pass to the next handlers
+   */
+  middleware?: boolean
+
+  /**
+   * Use lazy loading to import handler
+   */
+  lazy?: boolean
+
+  /**
+   * Path to event handler
+   *
+   */
+  handler: string
+
+  /**
+   * Router method matcher
+   */
+  method?: string
+}
+
+// need to refactor before, after, view to be a part of some other type
+export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'before' | 'after' | 'view'
+
+export type RouteCallback = (params?: Record<string, any>) => any | string | object
+
+export interface Route {
+  name: string
+  uri: string
+  url: string // used synonymously with uri
+  method: HttpMethod
+  pattern: RegExp
+  callback: RouteCallback
+  paramNames: string[]
+  middleware?: string | string[]
+  statusCode?: StatusCode
+}
+
+export interface MiddlewareType {
+  name: string
+  priority: number
+
+  handle: Function
+}
+
+export type StatusCode = 200 | 201 | 202 | 204 | 301 | 302 | 304 | 400 | 401 | 403 | 404 | 500
+export type RedirectCode = Extract<StatusCode, 301 | 302>
+
+export type Middleware = () => void
+
+export interface Middlewares {
+  logger: Middleware
+  auth: Middleware
+  [key: string]: Middleware
+}
+
+export interface RouteGroupOptions {
+  prefix?: string
+  middleware?: Route['middleware']
+}

package/src/scheduler.ts

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

package/src/search-engine.ts

@@ -0,0 +1,136 @@
+import type { EnqueuedTask, Hits, Index, IndexOptions, IndexesResults, MeiliSearch, DocumentOptions as RecordOptions, Settings as SearchEngineSettings, SearchParams, SearchResponse } 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.org/docs/search-engine
+   */
+  driver: 'meilisearch' | 'algolia' | 'opensearch'
+
+  meilisearch?: {
+    host: string
+    apiKey: string
+  }
+
+  openSearch?: {
+    host: string
+    protocol: number
+    port: number
+    auth: 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
+
+  // Indexes
+  createIndex: (name: string, options?: IndexOptions) => MaybePromise<EnqueuedTask>
+  getIndex: (name: string) => MaybePromise<Index>
+  updateIndex: (name: string, options: IndexOptions) => MaybePromise<EnqueuedTask>
+  deleteIndex: (name: string) => MaybePromise<EnqueuedTask>
+  updateIndexSettings: (name: string, settings: SearchEngineSettings) => MaybePromise<EnqueuedTask>
+  listAllIndexes: () => MaybePromise<IndexesResults<Index[]>>
+  listAllIndices: () => MaybePromise<IndexesResults<Index[]>> // alternatives plural spelling
+
+  // Records (MeiliSearch uses the term "documents")
+  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
+  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 // 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 MeiliSearchOptions {
+  apiKey: string
+  host: string
+}
+
+export type { EnqueuedTask, Hits, Index, IndexOptions, IndexesResults, MeiliSearch, RecordOptions, SearchEngineSettings, SearchParams, SearchResponse }

package/src/security.ts

@@ -0,0 +1,23 @@
+import type { DeepPartial } from './utils'
+import type { CountryCode } from './cloud'
+
+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/services.ts

@@ -0,0 +1,44 @@
+export interface ServicesOptions {
+  algolia?: {
+    appId: string
+    apiKey: string
+  }
+
+  godaddy?: {
+    apiKey: string
+    apiSecret: string
+  }
+
+  meilisearch?: {
+    appId: string
+    apiKey: string
+  }
+
+  stripe?: {
+    appId: string
+    apiKey: string
+  }
+
+  planetscale?: {
+    appId: string
+    apiKey: string
+  }
+
+  supabase?: {
+    appId: string
+    apiKey: string
+  }
+
+  aws?: {
+    accountId: string
+    appId: string
+    apiKey: string
+    region: string
+  }
+
+  novu?: {
+    key: string
+  }
+}
+
+export type ServicesConfig = Partial<ServicesOptions>

package/src/sms.ts

@@ -0,0 +1,5 @@
+import type { ISmsOptions as SmsOptions } from '@novu/stateless'
+
+export type { SmsOptions }
+
+export type SmsConfig = SmsOptions

package/src/ssg.ts

@@ -0,0 +1,3 @@
+import type { ViteSSGContext } from '.'
+
+export type UserModule = (ctx: ViteSSGContext) => void

package/src/stacks.ts

@@ -0,0 +1,226 @@
+import type {
+  AiConfig,
+  AnalyticsConfig,
+  AppConfig,
+  BinaryConfig,
+  CacheConfig,
+  CloudConfig,
+  DatabaseConfig,
+  DnsConfig,
+  DocsConfig,
+  EmailConfig,
+  GitConfig,
+  HashingConfig,
+  LibraryConfig,
+  NotificationConfig,
+  PaymentConfig,
+  QueueConfig,
+  SearchEngineConfig,
+  SecurityConfig,
+  ServicesConfig,
+  StorageConfig,
+  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 interface StacksOptions {
+  ai: AiConfig
+
+  /**
+   * **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.
+   */
+  analytics: AnalyticsConfig
+
+  /**
+   * **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.
+   */
+  app: AppConfig
+
+  /**
+   * **Binary Options**
+   *
+   * This configuration defines all of your Binary 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.
+   */
+  binary: BinaryConfig
+
+  /**
+   * **Cache Options**
+   *
+   * This configuration defines all of your Cache 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.
+   */
+  cache: CacheConfig
+
+  /**
+   * **Cloud Options**
+   *
+   * This configuration defines all of your Cloud 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.
+   */
+  cloud: CloudConfig
+
+  /**
+   * **Database Options**
+   *
+   * This configuration defines all of your Database 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.
+   */
+  database: DatabaseConfig
+
+  /**
+   * **DNS Options**
+   *
+   * This configuration defines all of your DNS 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.
+   */
+  dns: DnsConfig
+
+  /**
+   * **Docs Options**
+   *
+   * This configuration defines all of your Docs 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.
+   */
+  docs: DocsConfig
+
+  /**
+   * **Email Options**
+   *
+   * This configuration defines all of your Email 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.
+   */
+  email: EmailConfig
+
+  /**
+   * **Git Options**
+   *
+   * This configuration defines all of your Git 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.
+   */
+  git: GitConfig
+
+  /**
+   * **Hashing Options**
+   *
+   * This configuration defines all of your Hashing 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.
+   */
+  hashing: HashingConfig
+
+  /**
+   * **Library Options**
+   *
+   * This configuration defines all of your Library 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.
+   */
+  library: LibraryConfig
+
+  /**
+   * **Notification Options**
+   *
+   * This configuration defines all of your Notification 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.
+   */
+  notification: NotificationConfig
+
+  /**
+   * **Payment Options**
+   *
+   * This configuration defines all of your Payment 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.
+   */
+  payment: PaymentConfig
+
+  /**
+   * **Queue Options**
+   *
+   * This configuration defines all of your Queue 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.
+   */
+  queue: QueueConfig
+
+  /**
+   * **Search Engine Options**
+   *
+   * This configuration defines all of your Search Engine 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.
+   */
+  security: SecurityConfig
+
+  /**
+   * **Search Engine Options**
+   *
+   * This configuration defines all of your Search Engine 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.
+   */
+  searchEngine: SearchEngineConfig
+
+  /**
+   * **Services Options**
+   *
+   * This configuration defines all of your Services 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.
+   */
+  services: ServicesConfig
+
+  /**
+   * **Storage Options**
+   *
+   * This configuration defines all of your Storage 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.
+   */
+  storage: StorageConfig
+
+  /**
+   * **Team Members**
+   *
+   * This configuration defines all of your Team members. 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.
+   */
+  team: Team
+
+  /**
+   * **UI Options**
+   *
+   * This configuration defines all of your UI 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.
+   */
+  ui: UiConfig
+}
+
+export type StacksConfig = Partial<StacksOptions>

package/src/storage.ts

@@ -0,0 +1,13 @@
+export interface StorageOptions {
+  /**
+   * **Storage Driver**
+   *
+   * The storage driver to utilize.
+   *
+   * @default string 's3'
+   * @see https://stacksjs.org/docs/storage
+   */
+  driver: 's3' | 'efs' | 'local'
+}
+
+export type StorageConfig = Partial<StorageOptions>

package/src/tables.ts

@@ -0,0 +1,57 @@
+import type { Hits, SearchResponse } from 'meilisearch'
+
+/**
+ * the TableStore interface is primarily used to unify the persisting of data to localStorage
+ */
+export interface TableStore {
+  /**
+   * 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<Record<string, any>> // optional: the Meilisearch search response (defaults: {})
+  /**
+   * The search engine hits object.
+   */
+  hits?: Hits
+
+  columns: string[] // used as table heads/column titles
+  source?: string // optional: the Meilisearch host name/address (defaults: http://127.0.0.1:7700)
+  password?: string // optional: the Meilisearch password (defaults: '')
+  searchable?: string | boolean // optional: determines whether the table displays the search bar (defaults: true)
+  query?: string // optional: the "query" (= search input) used to search the table (defaults: '')
+  sortable?: string | boolean // optional: determines whether the table displays the "table head"-sorts (defaults: true)
+  sort?: string // optional: the only active sort to be applied to the table (defaults: '')
+  sorts?: string | string[] // optional: the specific type of sorts to be applied to the table (defaults: [])
+  filterable?: string | boolean // optional: determines whether the table displays the filters component (defaults: true)
+  filters?: string | string[] // optional: the specific type of filters to be displayed/utilized in the table (defaults: [])
+  filterValue?: any[]// optional: the specific type of filters to be displayed/utilized in the table (defaults: [])
+  actionable?: string | boolean // optional: determines whether the table displays any "action items" (defaults: true)
+  actions?: string | string[] // optional: the specific type of actions to be displayed/utilized in the table (defaults: 'Edit, Delete')
+  perPage: number // optional: the number of rows (items) to be displayed per page (defaults: 10)
+  selectable?: string | boolean // optional: determines whether the table displays the checkboxes (defaults: true)
+  selectedRows?: number[] | string[] // optional: holds the selected rows (defaults: [])
+  selectedAll?: boolean // optional: determines whether all the rows are selected (defaults: false)
+  // stickyHeader?: string | boolean // optional: determines whether the table displays the sticky header (defaults: false)
+  // stickyFooter?: string | boolean // optional: determines whether the table displays the sticky footer (defaults: false)
+  goToNextPage: number
+  goToPage: number
+  goToPrevPage: number
+  lastPageNumber: number
+  searchFilters?: object
+  searchParams?: object
+  setTotalHits: number
+
+  /**
+   *
+   * The current page number
+   * @default 1
+   * @type {number}
+   * @memberof TableStore
+   * @example 1
+   */
+  currentPage: number
+}

package/src/team.ts

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