@stacksjs/types 0.70.23 → 0.70.26

package/dist/{dns.d.ts → src/dns.d.ts}

@@ -1,6 +1,6 @@
 export declare interface ARecord {
   name: string | '@' | '*'
-  address: string 
+  address: string
   ttl?: number | 'auto'
 }
 export declare interface CNameRecord {
@@ -12,7 +12,7 @@ export declare interface MXRecord {
   name: string | '@'
   mailServer: string
   ttl: number | 'auto'
-  priority: number 
+  priority: number
 }
 export declare interface TxtRecord {
   name: string | '@'
@@ -21,13 +21,59 @@ export declare interface TxtRecord {
 }
 export declare interface AAAARecord {
   name: string | '@' | '*'
-  address: string 
+  address: string
   ttl: number | 'auto'
 }
-export declare type DnsRecord = ARecord | CNameRecord | MXRecord | TxtRecord | AAAARecord
-
-type CountryCode =
-  | 'AC'
+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'
@@ -278,15 +324,9 @@ type CountryCode =
   | 'ZA'
   | 'ZM'
   | 'ZW'
-  | string
-
-export interface ExtraParam {
-  Name: ExtraParamName
-  Value: ExtraParamValue
-}
-export type ExtraParamList = ExtraParam[]
-export type ExtraParamName =
-  | 'DUNS_NUMBER'
+  | string;
+export type ExtraParamList = ExtraParam[];
+export type ExtraParamName = | 'DUNS_NUMBER'
   | 'BRAND_NUMBER'
   | 'BIRTH_DEPARTMENT'
   | 'BIRTH_DATE_IN_YYYY_MM_DD'
@@ -317,46 +357,6 @@ export type ExtraParamName =
   | 'UK_COMPANY_NUMBER'
   | 'EU_COUNTRY_OF_CITIZENSHIP'
   | 'AU_PRIORITY_TOKEN'
-  | string
-export type ExtraParamValue = string
-
-export interface ContactInfo extends ContactDetail {
-  admin?: ContactDetail 
-  tech?: ContactDetail 
-}
-
-export interface DnsOptions {
-  driver: 'aws'
-  a: ARecord[]
-  aaaa: AAAARecord[]
-  cname: CNameRecord[]
-  mx: MXRecord[]
-  txt: TxtRecord[]
-  nameservers: string[]
-  contactInfo: Partial<ContactInfo>
-  redirects: string[]
-}
-
-export type DnsConfig = Partial<DnsOptions>
-
-export 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
-}
+  | string;
+export type ExtraParamValue = string;
+export type DnsConfig = Partial<DnsOptions>;

package/dist/src/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/src/email.d.ts

@@ -0,0 +1,201 @@
+/**
+ * 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[]
+  domain?: string
+  url: string
+  charset: string
+  server: EmailServerConfig
+  notifications?: EmailNotificationsConfig
+  default: 'log' | 'ses' | 'sendgrid' | 'mailgun' | 'mailtrap' | 'smtp'
+}
+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[]
+  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 }
+}
+// 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/src/env.d.ts

@@ -0,0 +1 @@
+

package/dist/{errors.d.ts → src/errors.d.ts}

@@ -1,14 +1,11 @@
-export declare type CommandError = Error
-
-export interface ErrorResponse {
-  status: number 
-  errors: string | object 
-  stack?: string 
+export declare interface ErrorResponse {
+  status: number
+  errors: string | object
+  stack?: string
   name: string
   message: string
 }
-
-export interface ErrorOptions {
+export declare interface ErrorOptions {
   messages: {
     'string': string
     'email': string
@@ -17,7 +14,6 @@ export interface ErrorOptions {
     'activeUrl': string
     'alpha': string
     'alphaNumeric': string
-    'minLength': string
     'maxLength': string
     'fixedLength': string
     'confirmed': string
@@ -38,9 +34,7 @@ export interface ErrorOptions {
     'mobile': string
     'passport': string
     'postalCode': string
-
     'boolean': string
-
     'number': string
     'min': string
     'max': string
@@ -49,7 +43,6 @@ export interface ErrorOptions {
     'negative': string
     'decimal': string
     'withoutDecimals': string
-
     'date': string
     'date.equals': string
     'date.after': string
@@ -59,33 +52,33 @@ export interface ErrorOptions {
     'date.sameAs': string
     'date.notSameAs': string
     'date.afterField': string
-
     'accepted': string
-
     'enum': string
-
     'literal': string
-
     'object': string
-
     'record': string
-    'record.minLength': string
+    'record.min': string
     'record.maxLength': string
     'record.fixedLength': string
-
     'array': string
-    'array.minLength': string
+    'array.min': string
     'array.maxLength': string
     'array.fixedLength': string
     'notEmpty': string
     'distinct': string
-
     'tuple': string
-
     'union': string
     'unionGroup': string
     'unionOfTypes': string
   }
 }
-
-export type ErrorConfig = Partial<ErrorOptions>
+// 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>;

package/dist/src/events.d.ts

@@ -0,0 +1,31 @@
+export type * from '../../../types/events';
+/**
+ * **Events**
+ *
+ * This configuration defines all of your events. 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.
+ *
+ * @example To fire an event, you may use any of the following approaches:
+ * ```ts
+ * dispatch('user:registered', { name: 'Chris', email: 'chris@stacksjs.com' })
+ *
+ * // alternatively, you may use the following:
+ * useEvent('user:registered', { name: 'Chris', email: 'chris@stacksjs.com' })
+ * events.emit('user:registered', { name: 'Chris', email: 'chris@stacksjs.com' })
+ * useEvents.emit('user:registered', { name: 'Chris', email: 'chris@stacksjs.com' })
+ * ```
+ *
+ * @example To capture an event, you may use any of the following approaches:
+ * ```ts
+ * listen('user:registered', (user) => sendWelcomeEmail(user))
+ *
+ * // alternatively, you may use the following:
+ * useListen('user:registered', (user) => sendWelcomeEmail(user))
+ * events.on('user:registered', (user) => sendWelcomeEmail(user))
+ * useEvents.on('user:registered', (user) => sendWelcomeEmail(user))
+ * ```
+ */
+export declare interface Events {
+  [key: string]: string[]
+}

package/dist/src/exit-code.d.ts

@@ -0,0 +1,10 @@
+/**
+ * CLI exit codes.
+ *
+ * @see https://nodejs.org/api/process.html#process_exit_codes
+ */
+export declare enum ExitCode {
+  Success = 0,
+  FatalError = 1,
+  InvalidArgument = 9,
+}

package/dist/{file-systems.d.ts → src/file-systems.d.ts}

@@ -1,13 +1,22 @@
+/**
+ * Describes a plain-text file.
+ */
 export declare interface TextFile {
   path: string
   data: string
 }
+/**
+ * Describes a JSON file.
+ */
 export declare interface JsonFile {
   path: string
   data: unknown
   indent: string
   newline: string | undefined
 }
+/**
+ * Describes a package.json file.
+ */
 export declare interface PackageJson {
   engines: {
     node: string
@@ -23,29 +32,24 @@ export declare interface FileSystemOptions {
       driver: 'local'
       root: string
     }
-
     public: {
       driver: 'public'
       root: string
       visibility?: 'public'
     }
-
     private: {
       driver: 'private'
       root: string
       visibility?: 'private'
     }
-
     efs: {
       driver: 'local'
       root: string
     }
-
     s3: {
       driver: 's3'
       root: string
     }
-
     [key: string]: {
       driver: string
       root: string
@@ -53,4 +57,4 @@ export declare interface FileSystemOptions {
     }
   }
 }
-export declare type FileSystemConfig = Partial<FileSystemOptions>
+export type FileSystemConfig = Partial<FileSystemOptions>;

package/dist/{git.d.ts → src/git.d.ts}

@@ -1,14 +1,18 @@
+/**
+ * **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.
+ */
 export declare interface GitOptions {
   hooks: GitHooks
-
   scopes: string[]
-
   types: {
     value: string
     name: string
     emoji: string
   }[]
-
   messages: {
     type: string
     scope: string
@@ -52,6 +56,5 @@ declare interface Hooks {
   'p4-pre-submit'?: string
   'post-index-change'?: string
 }
-export declare type GitConfig = Partial<GitOptions>
-
-export interface GitHooks extends Hooks {}
+export declare interface GitHooks extends Hooks {}
+export type GitConfig = Partial<GitOptions>;

package/dist/src/hashing.d.ts

@@ -0,0 +1,57 @@
+/**
+ * The Stacks runtime provides secure Bcrypt & Argon2 hashing for storing user passwords.
+ * If you are using one of the Laravel application starter kits, Bcrypt will be used for
+ * registration and authentication by default.
+ *
+ * Bcrypt is a great choice for hashing passwords because its "work factor" is adjustable, which
+ * means that the time it takes to generate a hash can be increased as hardware power increases.
+ * When hashing passwords, slow is good. The longer an algorithm takes to hash a password, the
+ * longer it takes malicious users to generate "rainbow tables" of all possible string hash
+ * values that may be used in brute force attacks against applications.
+ *
+ * @see https://stacksjs.com/docs/hashing
+ */
+export declare interface HashingOptions {
+  driver: 'argon2' | 'argon2id' | 'argon2i' | 'argon2d' | 'bcrypt'
+  bcrypt?: BcryptOptions
+  argon2?: ArgonOptions
+}
+/**
+ * **Bcrypt Options**
+ *
+ * Here you may specify the configuration options that should be used when
+ * passwords are hashed using the Bcrypt algorithm. This will allow you
+ * to control the amount of time it takes to hash the given password.
+ *
+ * @see https://stacksjs.com/docs/hashing
+ */
+export declare interface BcryptOptions {
+  rounds: number
+}
+/**
+ * **Argon Options**
+ *
+ * Here you may specify the configuration options that should be used when
+ * passwords are hashed using the Argon algorithm. These will allow you
+ * to control the amount of time it takes to hash the given password.
+ *
+ * @see https://stacksjs.com/docs/hashing
+ */
+export declare interface ArgonOptions {
+  memory?: number
+  time?: number
+}
+export type HashingConfig = Partial<HashingOptions>;
+export type HashAlgorithm = | 'md4'
+  | 'md5'
+  | 'sha1'
+  | 'sha256'
+  | 'sha384'
+  | 'sha512'
+  | 'ripemd128'
+  | 'ripemd160'
+  | 'tiger128'
+  | 'tiger160'
+  | 'tiger192'
+  | 'crc32'
+  | 'crc32b';

package/dist/src/helpers.d.ts

@@ -0,0 +1 @@
+export declare function getTypeName(v: any): string;