@stacksjs/types 0.70.86 → 0.70.87

package/src/stacks.ts

@@ -1,339 +0,0 @@
-import type {
-  AiConfig,
-  AnalyticsConfig,
-  AppConfig,
-  AuthConfig,
-  BinaryConfig,
-  CacheConfig,
-  CloudConfig,
-  CmsConfig,
-  CommerceConfig,
-  CorsConfig,
-  DashboardConfig,
-  DatabaseConfig,
-  DnsConfig,
-  DocsConfig,
-  EmailConfig,
-  ErrorConfig,
-  FilesystemsConfig,
-  GitConfig,
-  HashingConfig,
-  LibraryConfig,
-  LoggingConfig,
-  MarketingConfig,
-  MonitoringConfig,
-  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 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
-
-  /**
-   * **Auth Options**
-   *
-   * This configuration defines all of your Auth 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.
-   */
-  auth: AuthConfig
-
-  /**
-   * **CORS Options**
-   *
-   * Cross-origin resource sharing policy applied to API responses.
-   * Configured via `config/cors.ts`. See {@link CorsConfig}.
-   */
-  cors?: CorsConfig
-
-  /**
-   * **Realtime Options**
-   *
-   * This configuration defines all of your Realtime 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.
-   */
-  realtime: RealtimeConfig
-
-  /**
-   * **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
-
-  /**
-   * **CLI / 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.
-   */
-  cli: BinaryConfig
-
-  /**
-   * **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
-
-  /**
-   * **CMS Options**
-   *
-   * Top-level feature gate for the CMS bundle (Post / Page / Author /
-   * Comment / Tag / Category models + content-edit dashboards).
-   */
-  cms: CmsConfig
-
-  /**
-   * **Commerce Options**
-   *
-   * Top-level feature gate for the commerce bundle plus storefront defaults.
-   */
-  commerce: CommerceConfig
-
-  /**
-   * **Dashboard Options**
-   *
-   * Top-level feature gate plus per-section visibility toggles for the
-   * `buddy dev --dashboard` sidebar.
-   */
-  dashboard: DashboardConfig
-
-  /**
-   * **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
-
-  /**
-   * **Errors Options**
-   *
-   * This configuration defines all of your Errors 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.
-   */
-  errors: ErrorConfig
-
-  /**
-   * **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
-
-  /**
-   * **Logging Options**
-   *
-   * This configuration defines all of your logging 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.
-   */
-  logging: LoggingConfig
-
-  /**
-   * **Marketing Options**
-   *
-   * Top-level feature gate for the marketing bundle (`/api/email/subscribe`,
-   * `/api/contact`, Campaign / EmailList / SocialPost).
-   */
-  marketing: MarketingConfig
-
-  /**
-   * **Monitoring Options**
-   *
-   * Top-level feature gate for the monitoring bundle (Error model +
-   * error-tracking views and actions).
-   */
-  monitoring: MonitoringConfig
-
-  /**
-   * **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
-
-  /**
-   * **Ports**
-   *
-   * This configuration defines all of your Ports 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.
-   */
-  ports: Ports
-
-  /**
-   * **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
-
-  /**
-   * **SaaS Options**
-   *
-   * This configuration defines all of your SaaS 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.
-   */
-  saas: SaasConfig
-
-  /**
-   * **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
-
-  /**
-   * **Filesystems Options**
-   *
-   * This configuration defines all of your Filesystem 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.
-   */
-  filesystems: FilesystemsConfig
-
-  /**
-   * **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

@@ -1,173 +0,0 @@
-import type { Buffer } from 'node:buffer'
-
-/**
- * File contents can be a string, Buffer, Uint8Array, or ReadableStream
- */
-export type FileContents = string | Buffer | Uint8Array | ReadableStream
-
-/**
- * Visibility options for files
- */
-export type Visibility = 'public' | 'private'
-
-/**
- * File stat entry information
- */
-export interface StatEntry {
-  path: string
-  type: 'file' | 'directory'
-  visibility: Visibility
-  size: number
-  lastModified: number
-  mimeType?: string
-  metadata?: Record<string, any>
-}
-
-/**
- * Directory listing entry
- */
-export interface DirectoryEntry {
-  path: string
-  type: 'file' | 'directory'
-}
-
-/**
- * Directory listing iterator
- */
-export interface DirectoryListing extends AsyncIterable<DirectoryEntry> {
-  [Symbol.asyncIterator](): AsyncIterator<DirectoryEntry>
-}
-
-/**
- * Options for generating public URLs
- */
-export interface PublicUrlOptions {
-  domain?: string
-}
-
-/**
- * Options for generating temporary URLs
- */
-export interface TemporaryUrlOptions {
-  expiresIn: number | Date
-}
-
-/**
- * Checksum algorithm options
- */
-export interface ChecksumOptions {
-  algorithm?: 'md5' | 'sha1' | 'sha256'
-}
-
-/**
- * MIME type detection options
- */
-export interface MimeTypeOptions {
-  useExtension?: boolean
-}
-
-export interface StorageOptions {
-  /**
-   * **Storage Driver**
-   *
-   * The storage driver to utilize.
-   *
-   * @default 'local'
-   * @see https://stacksjs.com/docs/storage
-   */
-  driver: 's3' | 'efs' | 'local' | 'bun' | 'memory'
-
-  /**
-   * **Root Directory**
-   *
-   * Root directory for local and bun drivers.
-   *
-   * @default process.cwd()
-   */
-  root?: string
-
-  /**
-   * **S3 Configuration**
-   */
-  s3?: {
-    /**
-     * S3 bucket name
-     */
-    bucket: string
-
-    /**
-     * S3 region
-     *
-     * @default 'us-east-1'
-     */
-    region?: string
-
-    /**
-     * Key prefix for all S3 objects
-     */
-    prefix?: string
-
-    /**
-     * AWS credentials
-     */
-    credentials?: {
-      accessKeyId: string
-      secretAccessKey: string
-    }
-
-    /**
-     * Custom endpoint (for S3-compatible services)
-     */
-    endpoint?: string
-  }
-
-  /**
-   * **Public URL Configuration**
-   */
-  publicUrl?: {
-    /**
-     * Domain for public URLs
-     *
-     * @default 'http://localhost'
-     */
-    domain?: string
-  }
-
-  /**
-   * **Default Visibility**
-   *
-   * @default 'private'
-   */
-  defaultVisibility?: Visibility
-}
-
-export type StorageConfig = Partial<StorageOptions>
-
-/**
- * Filesystem configuration (Laravel-style alias)
- */
-export type FilesystemsConfig = StorageConfig
-
-export interface StorageDriver {
-  list: (path: string, options?: any) => DirectoryListing
-  changeVisibility: (path: string, visibility: Visibility) => Promise<void>
-  visibility: (path: string) => Promise<Visibility>
-  fileExists: (path: string) => Promise<boolean>
-  directoryExists: (path: string) => Promise<boolean>
-  publicUrl: (path: string, options: PublicUrlOptions) => Promise<string>
-  temporaryUrl: (path: string, options: TemporaryUrlOptions) => Promise<string>
-  checksum: (path: string, options: ChecksumOptions) => Promise<string>
-  mimeType: (path: string, options: MimeTypeOptions) => Promise<string>
-  lastModified: (path: string) => Promise<number>
-  fileSize: (path: string) => Promise<number>
-  read: (path: string) => Promise<FileContents>
-  readToString: (path: string) => Promise<string>
-  readToBuffer: (path: string) => Promise<Buffer>
-  readToUint8Array: (path: string) => Promise<Uint8Array>
-  deleteFile: (path: string) => Promise<void>
-  copyFile: (from: string, to: string) => Promise<void>
-  moveFile: (from: string, to: string) => Promise<void>
-  stat: (path: string) => Promise<StatEntry>
-  createDirectory: (path: string) => Promise<void>
-  write: (path: string, contents: FileContents) => Promise<void>
-}

package/src/table-names.ts

@@ -1 +0,0 @@
-export type TableNames = 'tags' | 'taggables' | 'categorizables' | 'comments' | 'commentables' | 'commentable_upvotes' | 'passkeys' | 'password_resets' | 'query_logs' | 'migrations' | 'tags' | 'payment_products' | 'failed_jobs' | 'social_posts' | 'payment_methods' | 'campaigns' | 'payment_transactions' | 'requests' | 'activities' | 'email_lists' | 'notifications' | 'jobs' | 'logs' | 'subscriptions' | 'errors' | 'comments' | 'users' | 'websockets' | 'pages' | 'authors' | 'posts' | 'print_devices' | 'categories' | 'payments' | 'drivers' | 'waitlist_products' | 'digital_deliveries' | 'manufacturers' | 'order_items' | 'shipping_zones' | 'customers' | 'products' | 'receipts' | 'product_variants' | 'license_keys' | 'waitlist_restaurants' | 'reviews' | 'product_units' | 'gift_cards' | 'orders' | 'coupons' | 'tax_rates' | 'transactions' | 'loyalty_points' | 'loyalty_rewards' | 'shipping_methods' | 'shipping_rates' | 'carts' | 'delivery_routes' | 'cart_items' | 'subscribers' | 'subscriber_emails'

package/src/tables.ts

@@ -1,57 +0,0 @@
-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

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