@stacksjs/types 0.70.88 → 0.70.91

package/dist/dependencies.d.ts

@@ -0,0 +1,17 @@
+/**
+ * **Dependencies Manager**
+ *
+ * This configuration defines all of your dependencies 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 declare interface DependenciesOptions {
+  'bun.sh': string | '0.7.1'
+  'sqlite.org'?: string | '^3.42.0'
+  'mysql.com'?: string | '^8.0.33'
+  'mariadb.org'?: string | '^10.6.5'
+  'postgresql.org'?: string | '^14.1'
+  'redis.io'?: string | '^7.0.11'
+  'aws.amazon.com/cli'?: string | '^2.12.7'
+}
+export type DependenciesConfig = DependenciesOptions;

package/dist/deploy.d.ts

@@ -0,0 +1,16 @@
+import type { CliOptions } from './cli';
+/**
+ * **Deploy Options**
+ *
+ * This configuration defines all of your deployment 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 declare interface DeployOptions extends CliOptions {
+  domain?: string
+  deploy?: boolean
+  prod?: boolean
+  dev?: boolean
+  staging?: boolean
+  yes?: boolean
+}

package/dist/dns.d.ts

@@ -0,0 +1,362 @@
+export declare interface ARecord {
+  name: string | '@' | '*'
+  address: string
+  ttl?: number | 'auto'
+}
+export declare interface CNameRecord {
+  name: string
+  target: string
+  ttl: number | 'auto'
+}
+export declare interface MXRecord {
+  name: string | '@'
+  mailServer: string
+  ttl: number | 'auto'
+  priority: number
+}
+export declare interface TxtRecord {
+  name: string | '@'
+  ttl: number | 'auto'
+  content: string
+}
+export declare interface AAAARecord {
+  name: string | '@' | '*'
+  address: string
+  ttl: number | 'auto'
+}
+export declare interface ExtraParam {
+  Name: ExtraParamName
+  Value: ExtraParamValue
+}
+export declare interface ContactInfo extends ContactDetail {
+  admin?: ContactDetail
+  tech?: ContactDetail
+}
+/**
+ * **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.
+ *
+ * @see https://stacksjs.com/docs/dns
+ */
+export declare interface DnsOptions {
+  driver: 'aws'
+  a: ARecord[]
+  aaaa: AAAARecord[]
+  cname: CNameRecord[]
+  mx: MXRecord[]
+  txt: TxtRecord[]
+  nameservers: string[]
+  contactInfo: Partial<ContactInfo>
+  redirects: string[]
+}
+export declare interface ContactDetail {
+  firstName: string
+  lastName: string
+  contactType: 'PERSON' | 'COMPANY' | 'ASSOCIATION' | 'PUBLIC_BODY' | 'RESELLER' | string
+  organizationName: string
+  addressLine1: string
+  addressLine2: string
+  city: string
+  state: string
+  countryCode: CountryCode
+  zip: string
+  phoneNumber: string
+  email: string
+  fax: string
+  extraParams: string
+  privacy: boolean
+  privacyAdmin: boolean
+  privacyTech: boolean
+  privacyRegistrant: boolean
+}
+export type DnsRecord = ARecord | CNameRecord | MXRecord | TxtRecord | AAAARecord;
+declare type CountryCode = | 'AC'
+  | 'AD'
+  | 'AE'
+  | 'AF'
+  | 'AG'
+  | 'AI'
+  | 'AL'
+  | 'AM'
+  | 'AN'
+  | 'AO'
+  | 'AQ'
+  | 'AR'
+  | 'AS'
+  | 'AT'
+  | 'AU'
+  | 'AW'
+  | 'AX'
+  | 'AZ'
+  | 'BA'
+  | 'BB'
+  | 'BD'
+  | 'BE'
+  | 'BF'
+  | 'BG'
+  | 'BH'
+  | 'BI'
+  | 'BJ'
+  | 'BL'
+  | 'BM'
+  | 'BN'
+  | 'BO'
+  | 'BQ'
+  | 'BR'
+  | 'BS'
+  | 'BT'
+  | 'BV'
+  | 'BW'
+  | 'BY'
+  | 'BZ'
+  | 'CA'
+  | 'CC'
+  | 'CD'
+  | 'CF'
+  | 'CG'
+  | 'CH'
+  | 'CI'
+  | 'CK'
+  | 'CL'
+  | 'CM'
+  | 'CN'
+  | 'CO'
+  | 'CR'
+  | 'CU'
+  | 'CV'
+  | 'CW'
+  | 'CX'
+  | 'CY'
+  | 'CZ'
+  | 'DE'
+  | 'DJ'
+  | 'DK'
+  | 'DM'
+  | 'DO'
+  | 'DZ'
+  | 'EC'
+  | 'EE'
+  | 'EG'
+  | 'EH'
+  | 'ER'
+  | 'ES'
+  | 'ET'
+  | 'FI'
+  | 'FJ'
+  | 'FK'
+  | 'FM'
+  | 'FO'
+  | 'FR'
+  | 'GA'
+  | 'GB'
+  | 'GD'
+  | 'GE'
+  | 'GF'
+  | 'GG'
+  | 'GH'
+  | 'GI'
+  | 'GL'
+  | 'GM'
+  | 'GN'
+  | 'GP'
+  | 'GQ'
+  | 'GR'
+  | 'GS'
+  | 'GT'
+  | 'GU'
+  | 'GW'
+  | 'GY'
+  | 'HK'
+  | 'HM'
+  | 'HN'
+  | 'HR'
+  | 'HT'
+  | 'HU'
+  | 'ID'
+  | 'IE'
+  | 'IL'
+  | 'IM'
+  | 'IN'
+  | 'IO'
+  | 'IQ'
+  | 'IR'
+  | 'IS'
+  | 'IT'
+  | 'JE'
+  | 'JM'
+  | 'JO'
+  | 'JP'
+  | 'KE'
+  | 'KG'
+  | 'KH'
+  | 'KI'
+  | 'KM'
+  | 'KN'
+  | 'KP'
+  | 'KR'
+  | 'KW'
+  | 'KY'
+  | 'KZ'
+  | 'LA'
+  | 'LB'
+  | 'LC'
+  | 'LI'
+  | 'LK'
+  | 'LR'
+  | 'LS'
+  | 'LT'
+  | 'LU'
+  | 'LV'
+  | 'LY'
+  | 'MA'
+  | 'MC'
+  | 'MD'
+  | 'ME'
+  | 'MF'
+  | 'MG'
+  | 'MH'
+  | 'MK'
+  | 'ML'
+  | 'MM'
+  | 'MN'
+  | 'MO'
+  | 'MP'
+  | 'MQ'
+  | 'MR'
+  | 'MS'
+  | 'MT'
+  | 'MU'
+  | 'MV'
+  | 'MW'
+  | 'MX'
+  | 'MY'
+  | 'MZ'
+  | 'NA'
+  | 'NC'
+  | 'NE'
+  | 'NF'
+  | 'NG'
+  | 'NI'
+  | 'NL'
+  | 'NO'
+  | 'NP'
+  | 'NR'
+  | 'NU'
+  | 'NZ'
+  | 'OM'
+  | 'PA'
+  | 'PE'
+  | 'PF'
+  | 'PG'
+  | 'PH'
+  | 'PK'
+  | 'PL'
+  | 'PM'
+  | 'PN'
+  | 'PR'
+  | 'PS'
+  | 'PT'
+  | 'PW'
+  | 'PY'
+  | 'QA'
+  | 'RE'
+  | 'RO'
+  | 'RS'
+  | 'RU'
+  | 'RW'
+  | 'SA'
+  | 'SB'
+  | 'SC'
+  | 'SD'
+  | 'SE'
+  | 'SG'
+  | 'SH'
+  | 'SI'
+  | 'SJ'
+  | 'SK'
+  | 'SL'
+  | 'SM'
+  | 'SN'
+  | 'SO'
+  | 'SR'
+  | 'SS'
+  | 'ST'
+  | 'SV'
+  | 'SX'
+  | 'SY'
+  | 'SZ'
+  | 'TC'
+  | 'TD'
+  | 'TF'
+  | 'TG'
+  | 'TH'
+  | 'TJ'
+  | 'TK'
+  | 'TL'
+  | 'TM'
+  | 'TN'
+  | 'TO'
+  | 'TP'
+  | 'TR'
+  | 'TT'
+  | 'TV'
+  | 'TW'
+  | 'TZ'
+  | 'UA'
+  | 'UG'
+  | 'US'
+  | 'UY'
+  | 'UZ'
+  | 'VA'
+  | 'VC'
+  | 'VE'
+  | 'VG'
+  | 'VI'
+  | 'VN'
+  | 'VU'
+  | 'WF'
+  | 'WS'
+  | 'YE'
+  | 'YT'
+  | 'ZA'
+  | 'ZM'
+  | 'ZW'
+  | string;
+export type ExtraParamList = ExtraParam[];
+export type ExtraParamName = | 'DUNS_NUMBER'
+  | 'BRAND_NUMBER'
+  | 'BIRTH_DEPARTMENT'
+  | 'BIRTH_DATE_IN_YYYY_MM_DD'
+  | 'BIRTH_COUNTRY'
+  | 'BIRTH_CITY'
+  | 'DOCUMENT_NUMBER'
+  | 'AU_ID_NUMBER'
+  | 'AU_ID_TYPE'
+  | 'CA_LEGAL_TYPE'
+  | 'CA_BUSINESS_ENTITY_TYPE'
+  | 'CA_LEGAL_REPRESENTATIVE'
+  | 'CA_LEGAL_REPRESENTATIVE_CAPACITY'
+  | 'ES_IDENTIFICATION'
+  | 'ES_IDENTIFICATION_TYPE'
+  | 'ES_LEGAL_FORM'
+  | 'FI_BUSINESS_NUMBER'
+  | 'FI_ID_NUMBER'
+  | 'FI_NATIONALITY'
+  | 'FI_ORGANIZATION_TYPE'
+  | 'IT_NATIONALITY'
+  | 'IT_PIN'
+  | 'IT_REGISTRANT_ENTITY_TYPE'
+  | 'RU_PASSPORT_DATA'
+  | 'SE_ID_NUMBER'
+  | 'SG_ID_NUMBER'
+  | 'VAT_NUMBER'
+  | 'UK_CONTACT_TYPE'
+  | 'UK_COMPANY_NUMBER'
+  | 'EU_COUNTRY_OF_CITIZENSHIP'
+  | 'AU_PRIORITY_TOKEN'
+  | string;
+export type ExtraParamValue = string;
+export type DnsConfig = Partial<DnsOptions>;

package/dist/docs.d.ts

@@ -0,0 +1,23 @@
+import type { BunPressOptions } from '@stacksjs/bunpress';
+export declare interface DocsUserConfig extends BunPressOptions {
+  deploy?: boolean
+}
+export declare interface SocialLink {
+  icon: SocialLinkIcon
+  link: string
+  ariaLabel?: string
+}
+export type DocsConfig = DocsUserConfig;
+export type DocsOptions = Partial<DocsConfig>;
+export declare enum SocialLinkIcon {
+  Bluesky = 'bluesky',
+  Discord = 'discord',
+  Facebook = 'facebook',
+  GitHub = 'github',
+  Instagram = 'instagram',
+  LinkedIn = 'linkedin',
+  Mastodon = 'mastodon',
+  Slack = 'slack',
+  Twitter = 'twitter',
+  YouTube = 'youtube',
+}

package/dist/email.d.ts

@@ -0,0 +1,207 @@
+/**
+ * i18n bag passed to STX email templates at render time. Stacks emails
+ * are STX, not vue-email — keys/values are user-defined per template.
+ * The shape is intentionally open: each template declares its own
+ * placeholders and the renderer interpolates them as-is.
+ */
+export declare interface I18n {
+  [key: string]: unknown
+}
+export declare interface AutoResponderConfig {
+  enabled: boolean
+  subject: string
+  body: string
+  schedule?: {
+    start?: string
+    end?: string
+  }
+}
+export declare interface EmailFilterRule {
+  field: 'from' | 'to' | 'subject' | 'body'
+  operator: 'contains' | 'equals' | 'startsWith' | 'endsWith' | 'regex'
+  value: string
+  action: 'move' | 'delete' | 'forward' | 'label'
+  actionValue?: string
+}
+export declare interface MailboxConfig {
+  email?: string
+  address?: string
+  displayName?: string
+  password?: string
+  forwardTo?: string[]
+  autoResponder?: AutoResponderConfig
+  filters?: EmailFilterRule[]
+}
+export declare interface MailServerInstanceConfig {
+  type?: 't4g.nano' | 't4g.micro' | 't4g.small' | 't4g.medium' | 't3.nano' | 't3.micro' | 't3.small' | 't3.medium' | 't3.large' | 't3.xlarge'
+  spot?: boolean
+  diskSize?: number
+  keyPair?: string
+}
+export declare interface MailServerPortsConfig {
+  smtp?: number
+  smtps?: number
+  submission?: number
+  imap?: number
+  imaps?: number
+  pop3?: number
+  pop3s?: number
+  smtpStartTls?: number
+}
+export declare interface MailServerFeaturesConfig {
+  imap?: boolean
+  pop3?: boolean
+  webmail?: boolean
+  calDAV?: boolean
+  cardDAV?: boolean
+  activeSync?: boolean
+}
+/**
+ * Patterns for matching emails to categories
+ */
+export declare interface CategoryPatterns {
+  domains?: string[]
+  substrings?: string[]
+  headers?: Record<string, string[]>
+}
+/**
+ * Configuration for automatic email categorization
+ */
+export declare interface EmailCategorizationConfig {
+  enabled?: boolean
+  social?: CategoryPatterns
+  forums?: CategoryPatterns
+  updates?: CategoryPatterns
+  promotions?: CategoryPatterns
+}
+export declare interface EmailServerConfig {
+  enabled: boolean
+  scan?: boolean
+  mode?: 'serverless' | 'server'
+  storage?: {
+    bucket?: string
+    retentionDays?: number
+    archiveAfterDays?: number
+  }
+  forwarding?: Record<string, string[]>
+  autoResponders?: AutoResponderConfig[]
+  instance?: MailServerInstanceConfig
+  ports?: MailServerPortsConfig
+  features?: MailServerFeaturesConfig
+  subdomain?: string
+  categorization?: EmailCategorizationConfig
+}
+export declare interface EmailNotificationsConfig {
+  newEmail?: boolean
+  bounces?: boolean
+  complaints?: boolean
+}
+export declare interface EmailOptions {
+  from: {
+    name: string
+    address: string
+  }
+  mailboxes: string[] | MailboxConfig[]
+  forwards?: Record<string, string[]>
+  domain?: string
+  url: string
+  charset: string
+  server: EmailServerConfig
+  notifications?: EmailNotificationsConfig
+  default: 'log' | 'capture' | 'ses' | 'sendgrid' | 'mailgun' | 'mailtrap' | 'smtp'
+  suppressionPolicy?: 'strict' | 'transactional-allowed' | 'off'
+  unsubscribeRoute?: string
+}
+export declare interface MailtrapConfig extends EmailDriverConfig {
+  token: string
+  inboxId?: number
+}
+export declare interface EmailResult {
+  message: string
+  success: boolean
+  provider: string
+  messageId?: string
+  metadata?: Record<string, unknown>
+}
+// Base configuration interface
+export declare interface EmailDriverConfig {
+  maxRetries?: number
+  retryTimeout?: number
+}
+/** Options for email template rendering */
+export declare interface EmailTemplateOptions {
+  variables?: Record<string, string | number | boolean | undefined | null>
+  layout?: string | false
+  subject?: string
+}
+// Email driver interface
+export declare interface EmailDriver {
+  name: string
+  send: (message: EmailMessage, options?: EmailTemplateOptions) => Promise<EmailResult>
+  configure: (config: EmailDriverConfig) => void
+}
+export declare interface EmailMessage {
+  from?: EmailAddress
+  to: string | string[] | EmailAddress[]
+  cc?: string | string[] | EmailAddress[]
+  bcc?: string | string[] | EmailAddress[]
+  replyTo?: EmailAddress | EmailAddress[] | string | string[]
+  subject: string
+  template?: string
+  html?: string
+  text?: string
+  attachments?: EmailAttachment[]
+  headers?: Record<string, string>
+  onSuccess?: () => Promise<{ message: string }> | { message: string }
+  onError?: (error: Error) => Promise<{ message: string }> | { message: string }
+  handle?: () => Promise<{ message: string }> | { message: string }
+  idempotencyKey?: string
+  tag?: 'transactional' | 'broadcast'
+}
+// Email interfaces
+export declare interface EmailAddress {
+  address: string
+  name?: string
+}
+export declare interface EmailAttachment {
+  filename: string
+  content: string | Uint8Array
+  contentType?: string
+  encoding?: 'base64' | 'binary' | 'hex' | 'utf8'
+}
+// Helper functions for all drivers
+export declare interface SESConfig extends EmailDriverConfig {
+  region: string
+  credentials?: {
+    accessKeyId: string
+    secretAccessKey: string
+  }
+}
+// SendGrid implementation
+export declare interface SendGridConfig extends EmailDriverConfig {
+  apiKey: string
+}
+export declare interface RenderOptions {
+  props?: Record<string, unknown>
+  i18n?: I18n
+}
+export declare interface MailtrapSuccessResponse {
+  success: boolean
+  message_ids: string[]
+  errors?: never
+}
+export declare interface MailtrapErrorResponse {
+  success: false
+  errors: {
+    email?: string[]
+    message?: string[]
+    [key: string]: string[] | undefined
+  }
+  message_ids?: never
+}
+/**
+ * Email category types for automatic email categorization (Gmail-style)
+ */
+export type EmailCategory = 'social' | 'forums' | 'updates' | 'promotions' | 'primary';
+export type EmailConfig = Partial<EmailOptions>;
+export type MailtrapResponse = MailtrapSuccessResponse | MailtrapErrorResponse;

package/dist/env.d.ts

@@ -0,0 +1 @@
+

package/dist/errors.d.ts

@@ -0,0 +1,84 @@
+export declare interface ErrorResponse {
+  status: number
+  errors: string | object
+  stack?: string
+  name: string
+  message: string
+}
+export declare interface ErrorOptions {
+  messages: {
+    'string': string
+    'email': string
+    'regex': string
+    'url': string
+    'activeUrl': string
+    'alpha': string
+    'alphaNumeric': string
+    'maxLength': string
+    'fixedLength': string
+    'confirmed': string
+    'endsWith': string
+    'startsWith': string
+    'sameAs': string
+    'notSameAs': string
+    'in': string
+    'notIn': string
+    'ipAddress': string
+    'uuid': string
+    'ascii': string
+    'creditCard': string
+    'hexCode': string
+    'iban': string
+    'jwt': string
+    'coordinates': string
+    'mobile': string
+    'passport': string
+    'postalCode': string
+    'boolean': string
+    'number': string
+    'min': string
+    'max': string
+    'range': string
+    'positive': string
+    'negative': string
+    'decimal': string
+    'withoutDecimals': string
+    'date': string
+    'date.equals': string
+    'date.after': string
+    'date.before': string
+    'date.afterOrEqual': string
+    'date.beforeOrEqual': string
+    'date.sameAs': string
+    'date.notSameAs': string
+    'date.afterField': string
+    'accepted': string
+    'enum': string
+    'literal': string
+    'object': string
+    'record': string
+    'record.min': string
+    'record.maxLength': string
+    'record.fixedLength': string
+    'array': string
+    'array.min': string
+    'array.maxLength': string
+    'array.fixedLength': string
+    'notEmpty': string
+    'distinct': string
+    'tuple': string
+    'union': string
+    'unionGroup': string
+    'unionOfTypes': string
+  }
+}
+// export declare class ValidationError extends Error {
+//   messages: any
+//   status: number
+//   code: string
+//   constructor(messages: any, options?: ErrorOptions)
+//   get [Symbol.toStringTag](): string
+//   toString(): string
+// }
+export type CommandError = Error;
+export type ErrorConfig = Partial<ErrorOptions>;