@stacksjs/types 0.70.85 → 0.70.87

package/src/sms.ts

@@ -1,265 +0,0 @@
-/**
- * SMS Service Configuration Types
- * Supports Twilio, Vonage, and AWS providers
- */
-
-// =============================================================================
-// Core SMS Types
-// =============================================================================
-
-export type SmsProvider = 'twilio' | 'vonage' | 'pinpoint' | 'sns'
-
-export interface SmsMessage {
-  /**
-   * Recipient phone number (E.164 format recommended)
-   */
-  to: string | string[]
-
-  /**
-   * Message body
-   */
-  body: string
-
-  /**
-   * Sender ID or phone number
-   */
-  from?: string
-
-  /**
-   * Optional media URLs (MMS)
-   */
-  mediaUrls?: string[]
-
-  /**
-   * Callback URL for status updates
-   */
-  statusCallback?: string
-
-  /**
-   * Additional provider-specific options
-   */
-  options?: Record<string, unknown>
-}
-
-export interface SmsSendResult {
-  success: boolean
-  messageId?: string
-  status?: SmsStatus
-  to: string
-  error?: string
-  provider: SmsProvider
-  segments?: number
-  price?: number
-  currency?: string
-}
-
-export type SmsStatus =
-  | 'queued'
-  | 'sending'
-  | 'sent'
-  | 'delivered'
-  | 'failed'
-  | 'undelivered'
-  | 'unknown'
-
-export interface SmsStatusUpdate {
-  messageId: string
-  to: string
-  status: SmsStatus
-  timestamp: Date
-  errorCode?: string
-  errorMessage?: string
-}
-
-// =============================================================================
-// Provider Configurations
-// =============================================================================
-
-export interface TwilioConfig {
-  accountSid: string
-  authToken: string
-  from?: string
-  messagingServiceSid?: string
-  statusCallback?: string
-}
-
-export interface VonageConfig {
-  apiKey: string
-  apiSecret: string
-  from?: string
-  applicationId?: string
-  privateKey?: string
-}
-
-export interface AwsSmsConfig {
-  region: string
-  accessKeyId?: string
-  secretAccessKey?: string
-  senderId?: string
-  originationNumber?: string
-}
-
-// =============================================================================
-// SMS Options (Main Config)
-// =============================================================================
-
-export interface SmsTemplateConfig {
-  name: string
-  body: string
-  variables?: string[]
-}
-
-export interface SmsOptOutConfig {
-  enabled: boolean
-  keywords: string[]
-}
-
-export interface SmsTwoWayConfig {
-  enabled: boolean
-  webhookUrl?: string
-  snsTopicArn?: string
-}
-
-export interface SmsInboxConfig {
-  enabled: boolean
-  bucket: string
-  prefix?: string
-  retentionDays?: number
-}
-
-export interface SmsOptions {
-  /**
-   * Enable SMS functionality
-   */
-  enabled: boolean
-
-  /**
-   * Default SMS provider
-   */
-  provider: SmsProvider
-
-  /**
-   * Default sender ID or phone number
-   */
-  from?: string
-
-  /**
-   * Default country code for phone number formatting
-   */
-  defaultCountryCode?: string
-
-  /**
-   * Message type (affects pricing and delivery)
-   */
-  messageType?: 'TRANSACTIONAL' | 'PROMOTIONAL'
-
-  /**
-   * Provider-specific configurations
-   */
-  drivers: {
-    twilio?: TwilioConfig
-    vonage?: VonageConfig
-    pinpoint?: AwsSmsConfig
-    sns?: AwsSmsConfig
-  }
-
-  /**
-   * Opt-out handling configuration
-   */
-  optOut?: SmsOptOutConfig
-
-  /**
-   * Two-way messaging configuration
-   */
-  twoWay?: SmsTwoWayConfig
-
-  /**
-   * Message templates
-   */
-  templates?: SmsTemplateConfig[]
-
-  /**
-   * Inbox configuration for storing received messages
-   */
-  inbox?: SmsInboxConfig
-
-  /**
-   * Max monthly spend limit
-   */
-  maxSpendPerMonth?: number
-}
-
-export type SmsConfig = Partial<SmsOptions>
-
-// =============================================================================
-// SMS Driver Interface
-// =============================================================================
-
-export interface SmsDriver {
-  /**
-   * Send an SMS message
-   */
-  send(message: SmsMessage): Promise<SmsSendResult>
-
-  /**
-   * Send multiple SMS messages
-   */
-  sendBulk(messages: SmsMessage[]): Promise<SmsSendResult[]>
-
-  /**
-   * Get message status
-   */
-  getStatus?(messageId: string): Promise<SmsStatusUpdate>
-
-  /**
-   * Verify a phone number
-   */
-  verify?(phoneNumber: string): Promise<{ valid: boolean, carrier?: string, type?: string }>
-
-  /**
-   * Get account balance/usage
-   */
-  getBalance?(): Promise<{ balance: number, currency: string }>
-}
-
-// =============================================================================
-// Verification Types (for 2FA/OTP)
-// =============================================================================
-
-export interface VerificationRequest {
-  to: string
-  channel?: 'sms' | 'call' | 'whatsapp'
-  codeLength?: number
-  locale?: string
-  customMessage?: string
-}
-
-export interface VerificationResult {
-  success: boolean
-  verificationId?: string
-  status: 'pending' | 'approved' | 'denied' | 'expired'
-  error?: string
-}
-
-export interface VerificationCheckRequest {
-  verificationId?: string
-  to: string
-  code: string
-}
-
-export interface SmsVerificationDriver {
-  /**
-   * Start a verification (send OTP)
-   */
-  startVerification(request: VerificationRequest): Promise<VerificationResult>
-
-  /**
-   * Check a verification code
-   */
-  checkVerification(request: VerificationCheckRequest): Promise<VerificationResult>
-
-  /**
-   * Cancel a pending verification
-   */
-  cancelVerification?(verificationId: string): Promise<boolean>
-}

package/src/stack-extensions.ts

@@ -1,184 +0,0 @@
-/**
- * Known top-level directories in a Stacks project that a stack extension can provide.
- * Uses `(string & {})` to allow custom directories while still providing autocomplete.
- */
-export type StackDirectory =
-  | 'app'
-  | 'config'
-  | 'database'
-  | 'resources'
-  | 'routes'
-  | 'public'
-  | 'locales'
-  | 'docs'
-  | (string & {})
-
-// ─── Stack Extensions Registry ──────────────────────────────────────────────
-//
-// This is the central registry of known stack extensions. Third-party authors
-// can submit a PR to add their stack here. Once merged, all Stacks users get
-// autocomplete and type safety for the new stack name.
-//
-// To add your stack, add a new entry below following the pattern:
-//   'your-stack-name': { package: '@your-org/your-stack', description: '...' },
-//
-// Requirements for PRs:
-//   - The package must be published to npm
-//   - The package.json must contain a valid `stacks` field with a `name`
-//   - The description should be concise (under 80 chars)
-// ─────────────────────────────────────────────────────────────────────────────
-
-interface StackRegistryEntry {
-  /** The npm package name */
-  package: string
-  /** A short description of what this stack provides */
-  description: string
-  /** GitHub repository (e.g. 'stacksjs/blog-stack') */
-  github?: string
-}
-
-/**
- * The central registry of known stack extensions.
- *
- * Third-party stack authors: submit a PR to add your stack here.
- * Once merged, all Stacks users will get autocomplete for your stack name.
- */
-export const stackExtensionRegistry = {
-  // ── Community Stacks ────────────────────────────────────────────────────
-  // Add your stack here via PR! Follow the pattern:
-  //   'your-stack': { package: '@your-org/your-stack', description: 'What it does' },
-  //
-  // Once merged, all Stacks users get autocomplete for your stack name.
-} as const satisfies Record<string, StackRegistryEntry>
-
-/**
- * All known stack extension names, derived from the registry.
- * Uses `(string & {})` to also accept any custom/unregistered stack name.
- */
-export type KnownStackName = keyof typeof stackExtensionRegistry | (string & {})
-
-/**
- * Metadata for a stack extension, defined in the `stacks` field of a stack's package.json.
- *
- * @example
- * ```json
- * {
- *   "name": "@stacksjs/blog",
- *   "stacks": {
- *     "name": "blog",
- *     "description": "Blog functionality for Stacks",
- *     "directories": ["app", "config", "database", "resources"]
- *   }
- * }
- * ```
- */
-export interface StackMeta {
-  /** Short identifier for the stack (e.g. 'blog', 'commerce') */
-  name: KnownStackName
-  /** Human-readable description of what this stack provides */
-  description?: string
-  /** Semver version of the stack */
-  version?: string
-  /** Which top-level directories this stack provides. Defaults to all known directories if omitted. */
-  directories?: StackDirectory[]
-  /** Lifecycle hooks that run during install/uninstall */
-  hooks?: {
-    preInstall?: string
-    postInstall?: string
-    preUninstall?: string
-    postUninstall?: string
-  }
-}
-
-export type ConflictStrategy = 'skip' | 'overwrite' | 'backup'
-
-/** Tracks a single installed stack in the lock file */
-export interface StackManifestEntry {
-  /** The npm package name (e.g. '@stacksjs/blog') */
-  packageName: string
-  /** The stack's short name */
-  name: string
-  /** Installed version */
-  version: string
-  /** ISO timestamp of when this stack was installed */
-  installedAt: string
-  /** All files that were copied into the project, relative to project root */
-  files: string[]
-  /** Files that were skipped due to conflicts */
-  skipped: string[]
-  /** The conflict strategy used during this install */
-  conflictStrategy: ConflictStrategy
-}
-
-/** The stacks.lock.json file format */
-export interface StackLock {
-  version: 1
-  generatedAt: string
-  stacks: Record<string, StackManifestEntry>
-}
-
-export interface StackInstallOptions {
-  /** The stack name or package name to install */
-  name: KnownStackName
-  /** How to handle file conflicts. Defaults to 'skip'. */
-  conflict?: ConflictStrategy
-  /** Force overwrite all files (shorthand for conflict: 'overwrite') */
-  force?: boolean
-  /** Show what would happen without making changes */
-  dryRun?: boolean
-  /** Enable verbose output */
-  verbose?: boolean
-}
-
-export interface StackUninstallOptions {
-  /** The stack name or package name to uninstall */
-  name: KnownStackName
-  /** Force removal even if files were modified after install */
-  force?: boolean
-  /** Enable verbose output */
-  verbose?: boolean
-}
-
-/** Display format for the `stack:list` command */
-export interface StackListEntry {
-  name: string
-  packageName: string
-  version: string
-  description?: string
-  installed: boolean
-  installedAt?: string
-  fileCount?: number
-}
-
-/**
- * A stack extension entry in the registry (`config/stacks.ts`).
- *
- * Can be either:
- * - A string (the stack name or package name)
- * - A full object with name, URL, and GitHub repository
- *
- * @example
- * ```ts
- * export default [
- *   'blog',                                    // shorthand — autocomplete from registry
- *   '@stacksjs/commerce',                      // scoped package shorthand
- *   { name: 'analytics', github: 'stacksjs/analytics-stack' },
- * ] satisfies StackExtensionRegistry
- * ```
- */
-export interface StackExtensionEntry {
-  /** The stack name or package name */
-  name: KnownStackName
-  /** The stack's website URL */
-  url?: string
-  /** GitHub repository (e.g. 'stacksjs/blog-stack') */
-  github?: string
-  /** npm package name if different from the name */
-  package?: string
-}
-
-/**
- * The registry type for `config/stacks.ts`.
- * Accepts both string shorthands and full objects.
- */
-export type StackExtensionRegistry = (KnownStackName | StackExtensionEntry)[]