@stacksjs/types 0.70.86 → 0.70.87

package/src/cloud.ts

@@ -1,381 +0,0 @@
-import type { ApiConfig } from './api'
-import type { FirewallConfig } from './security'
-
-export type CountryCode =
-  | 'AD'
-  | 'AE'
-  | 'AF'
-  | 'AG'
-  | 'AI'
-  | 'AL'
-  | 'AM'
-  | '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'
-  | 'TR'
-  | 'TT'
-  | 'TV'
-  | 'TW'
-  | 'TZ'
-  | 'UA'
-  | 'UG'
-  | 'UM'
-  | 'US'
-  | 'UY'
-  | 'UZ'
-  | 'VA'
-  | 'VC'
-  | 'VE'
-  | 'VG'
-  | 'VI'
-  | 'VN'
-  | 'VU'
-  | 'WF'
-  | 'WS'
-  | 'YE'
-  | 'YT'
-  | 'ZA'
-  | 'ZM'
-  | 'ZW'
-
-type Environment = 'development' | 'staging' | 'production'
-
-interface SiteConfig {
-  domain: string
-  path: string
-}
-
-type InfrastructureOptions = Partial<{
-  type: 'serverless' // | 'server' coming soon
-  driver: 'aws'
-  api: ApiConfig
-  storage: object
-
-  /**
-   * **Firewall Settings**
-   *
-   * These settings are used to configure the firewall.
-   *
-   * @see https://stacksjs.com/docs/cloud#firewall
-   *
-   * @example
-   * ```ts
-   * firewall: {
-   *   enabled: true, // default: true
-   *   countryCodes: ['RU', 'IN'], // default: []
-   *   ipAddresses: ['56.123.456.789'], // default: []
-   *   queryString: ['foo', 'bar'], // default: []
-   *   httpHeaders: ['x-foo', 'x-bar'], // default: []
-   *   rateLimitPerMinute: 1000, // default: 1000
-   *   useIpReputationLists: true, // default: true
-   *   useKnownBadInputsRuleSet: true // default: true
-   * },
-   * ```
-   */
-  firewall: FirewallConfig
-
-  /**
-   * **Environments**
-   *
-   * These are the environments that your cloud will deploy.
-   *
-   * @example
-   * ```ts
-   * environments: ['production', 'staging', 'development']
-   * ```
-   */
-  environments: Environment[]
-
-  cdn: {
-    allowedMethods: 'GET_HEAD' | 'GET_HEAD_OPTIONS' | 'ALL'
-    cachedMethods: 'GET_HEAD' | 'GET_HEAD_OPTIONS'
-    minTtl: number
-    defaultTtl: number
-    maxTtl: number
-    compress: boolean
-    priceClass?: 'PriceClass_100' | 'PriceClass_200' | 'PriceClass_All'
-    originShieldRegion: string
-    cookieBehavior: 'none' | 'allowList' | 'all'
-
-    allowList: {
-      cookies: string[]
-      headers: string[]
-      queryStrings: string[]
-    }
-
-    realtimeLogs: {
-      enabled: boolean
-      samplingRate: number
-    }
-  }
-
-  ai: boolean
-  cli: boolean
-  docs: boolean
-  fileSystem: boolean
-
-  /**
-   * **Tunnel Configuration**
-   *
-   * Deploy a custom tunnel server for sharing local dev servers.
-   * Only needed for custom domains — localtunnel.dev is the shared default.
-   *
-   * @example
-   * ```ts
-   * tunnel: {
-   *   enabled: true,
-   *   domain: 'tunnel.mycompany.com',
-   *   ssl: { enabled: true },
-   * }
-   * ```
-   */
-  tunnel: TunnelCloudConfig
-}>
-
-export interface TunnelCloudConfig {
-  /** Enable custom tunnel server deployment (opt-in) */
-  enabled: boolean
-  /** Custom domain for the tunnel server (must NOT be localtunnel.dev) */
-  domain?: string
-  /** AWS region to deploy to */
-  region?: string
-  /** EC2 instance type */
-  instanceType?: string
-  /** Resource name prefix */
-  prefix?: string
-  /** SSL configuration */
-  ssl?: {
-    enabled: boolean
-    porkbunApiKey?: string
-    porkbunSecretKey?: string
-  }
-}
-
-export interface CloudOptions {
-  sites: {
-    root: string
-    path: string
-    [site: string]: string | SiteConfig
-  }
-
-  infrastructure: InfrastructureOptions
-  cdn: any
-  api: any
-  firewall: any
-}
-
-export type CloudConfig = Partial<CloudOptions>

package/src/cms.ts

@@ -1,14 +0,0 @@
-/**
- * **CMS Options**
- *
- * Top-level feature gate plus any future CMS-wide settings. The CMS bundle
- * (Post / Page / Author / Comment / Tag / Category models + edit dashboards)
- * stays inert at boot when `enabled` is `false`.
- */
-export interface CmsOptions {
-  enabled?: boolean
-  /** Optional deploy-target gate, e.g. `['production']`. */
-  env?: string[]
-}
-
-export type CmsConfig = Partial<CmsOptions>

package/src/commerce.ts

@@ -1,18 +0,0 @@
-/**
- * **Commerce Options**
- *
- * Top-level feature gate plus storefront defaults. The commerce bundle
- * (Order / Cart / Product / Customer / Coupon / GiftCard / Shipping models +
- * storefront API) stays inert at boot when `enabled` is `false`.
- */
-export interface CommerceOptions {
-  enabled?: boolean
-  /** Optional deploy-target gate, e.g. `['production']`. */
-  env?: string[]
-  /** Default storefront currency (ISO 4217), e.g. `'USD'`. */
-  currency?: string
-  /** Default tax rate applied when no product/region rule overrides. */
-  defaultTaxRate?: number
-}
-
-export type CommerceConfig = Partial<CommerceOptions>

package/src/components.ts

@@ -1,62 +0,0 @@
-export interface TagOption {
-  /**
-   * **Tag Name**
-   *
-   * This is the name of the component to be included in your library build.
-   * When defining a tag, ensure that the name corresponds to a file within
-   * root component directory.
-   *
-   * @example
-   * {
-   *   tags: [{
-   *     name: 'HelloWorld' // results in `<HelloWorld />`
-   *   }]
-   * }
-   *
-   * @example
-   * {
-   *   tags: [{
-   *     name: ['HelloWorld', 'AppHelloWorld'] // results in `<AppHelloWorld />`
-   *   }]
-   * }
-   * @see https://stacksjs.com/docs/components
-   */
-  name: string | string[]
-
-  /**
-   * **Tag Description**
-   *
-   * This is the description of your component. This value is
-   * used when to provide additional information to IDEs.
-   *
-   * @example
-   * {
-   *   name: 'HelloWorld' // results in `<HelloWorld />`
-   * }
-   * @see https://stacksjs.com/docs/components
-   */
-  description?: string
-
-  /**
-   * **Tag Attributes**
-   *
-   * These are your component's attributes. While it’s an optional field, you should aim
-   * to define all of your component attributes here, to provide as much context
-   * to your IDEs as possible, when actually using the library as an end-user.
-   *
-   * @example
-   * {
-   *   attributes: {
-   *     name: 'greeting',
-   *     description: 'The way to greet the user.',
-   *   }
-   * }
-   * @see https://stacksjs.com/docs/components
-   */
-  attributes?: {
-    name: string
-    description: string
-  }[]
-}
-
-export type TagsOptions = TagOption[]

package/src/configure.ts

@@ -1,13 +0,0 @@
-export interface ConfigureOptions {
-  aws: boolean
-  profile: string
-  project: boolean
-  verbose: boolean
-  accessKeyId: string
-  secretAccessKey: string
-  region: string
-  output: string
-  quiet: boolean
-}
-
-export type ConfigureConfig = Partial<ConfigureOptions>

package/src/cors.ts

@@ -1,86 +0,0 @@
-/**
- * CORS configuration types (stacksjs/stacks#1859 H-2).
- *
- * Lives in `@stacksjs/types` so userland `config/cors.ts` files can
- * `import type { CorsConfig } from '@stacksjs/types'` and get full
- * IntelliSense, and so the Cors middleware can read
- * `config.cors` with proper typing instead of an `as any` cast.
- */
-
-/**
- * Raw CORS configuration — every field optional. Defaults fill in
- * any field that's missing when the middleware resolves config.
- *
- * @example
- * ```ts
- * // config/cors.ts
- * import type { CorsConfig } from '@stacksjs/types'
- *
- * export default {
- *   origin: ['https://app.example.com', 'https://admin.example.com'],
- *   credentials: true,
- *   methods: ['GET', 'POST', 'PUT', 'DELETE'],
- *   allowedHeaders: ['Content-Type', 'Authorization', 'X-CSRF-Token'],
- *   maxAge: 600,
- * } satisfies CorsConfig
- * ```
- */
-export interface CorsConfig {
-  /**
-   * Allowed origins.
-   *
-   * - `'*'` permits any origin (incompatible with `credentials: true`).
-   * - A string array enumerates the explicit allow-list; the request's
-   *   `Origin` header is reflected verbatim when it matches.
-   * - A predicate function lets you implement dynamic allow-lists
-   *   (e.g. wildcards, regex, environment-dependent).
-   */
-  origin?: '*' | string[] | ((origin: string) => boolean)
-
-  /**
-   * HTTP methods the server accepts cross-origin. Echoed back in
-   * preflight `Access-Control-Allow-Methods` responses.
-   */
-  methods?: string[]
-
-  /**
-   * Request headers the browser is allowed to send cross-origin.
-   * Echoed back in preflight `Access-Control-Allow-Headers` responses.
-   */
-  allowedHeaders?: string[]
-
-  /**
-   * Response headers the browser is allowed to expose to JS via
-   * `fetch(...).then(r => r.headers.get(...))`. Anything not listed
-   * here is hidden from the SPA even though it's on the wire.
-   */
-  exposedHeaders?: string[]
-
-  /**
-   * Whether cookies / Authorization headers may be included
-   * cross-origin. **Setting this to `true` is incompatible with
-   * `origin: '*'`** — the spec requires an explicit origin.
-   */
-  credentials?: boolean
-
-  /**
-   * How long the browser may cache the preflight response, in
-   * seconds. Default 86_400 (24h). Lower values cost more preflights
-   * but pick up policy changes faster.
-   */
-  maxAge?: number
-}
-
-/**
- * Resolved CORS configuration with all defaults applied. This is the
- * shape the middleware passes through `applyCorsHeaders` /
- * `buildPreflightResponse`.
- */
-export interface ResolvedCorsConfig {
-  origin: '*' | string[] | ((origin: string) => boolean)
-  methods: string[]
-  allowedHeaders: string[]
-  exposedHeaders: string[]
-  credentials: boolean
-  maxAge: number
-}

package/src/cron-jobs.ts

@@ -1,146 +0,0 @@
-import type { IntRange } from '@stacksjs/cron'
-
-export type Job = JobOptions
-export type Jobs = Job[]
-export type CronJob = Job
-export type CronJobs = Jobs
-
-export enum Every {
-  Second = '* * * * * *',
-  FiveSeconds = '*/5 * * * * *',
-  TenSeconds = '*/10 * * * * *',
-  ThirtySeconds = '*/30 * * * * *',
-  Minute = '* * * * *',
-  TwoMinutes = '*/2 * * * *',
-  FiveMinutes = '*/5 * * * *',
-  TenMinutes = '*/10 * * * *',
-  FifteenMinutes = '*/15 * * * *',
-  ThirtyMinutes = '*/30 * * * *',
-  Hour = '0 * * * *',
-  HalfHour = '0,30 * * * *',
-  Day = '0 0 * * *',
-  Week = '0 0 * * 0',
-  Weekday = '0 0 * * 1-5',
-  Weekend = '0 0 * * 0,6',
-  Month = '0 0 1 * *',
-  Year = '0 0 1 1 *',
-}
-
-export type JobHandler = (_data?: any) => Promise<any> | any
-
-/**
- * Represents different backoff strategies for job retries
- */
-type BackoffStrategy = 'fixed' | 'exponential' | 'linear' | 'random'
-
-export interface JitterConfig {
-  /**
-   * Enable/disable jitter
-   */
-  enabled: boolean
-  /**
-   * Maximum percentage of variation (0-1)
-   */
-  factor?: number
-  /**
-   * Minimum delay in milliseconds
-   */
-  minDelay?: number
-  /**
-   * Maximum delay in milliseconds
-   */
-  maxDelay?: number
-}
-
-export interface BackoffConfig {
-  /**
-   * The strategy to use for calculating delay between retries
-   */
-  strategy: BackoffStrategy
-  /**
-   * Initial delay in milliseconds
-   */
-  initialDelay: number
-  /**
-   * For exponential/linear backoff: the multiplier/increment to apply
-   */
-  factor?: number
-  /**
-   * Maximum delay between retries in milliseconds
-   */
-  maxDelay?: number
-  /**
-   * Jitter configuration to add randomness to delays
-   */
-  jitter?: JitterConfig
-}
-
-export interface JobOptions {
-  /**
-   * The name of the job
-   */
-  name?: string
-  /**
-   * Job handler function or identifier string
-   */
-  handle?: string | JobHandler
-  /**
-   * Action identifier
-   */
-  action?: string
-  /**
-   * Job description
-   */
-  description?: string
-  /**
-   * Queue name
-   */
-  queue?: string
-  /**
-   * Timezone for scheduling
-   */
-  timezone?: string
-  /**
-   * Number of retry attempts. Must be between 0 and 185
-   */
-  tries?: IntRange<0, 185>
-  /**
-   * Simple backoff configuration using delay values
-   * Can be a single number for fixed delay,
-   * or an array of delays for custom retry delays
-   */
-  backoff?: number | number[]
-  /**
-   * Advanced backoff configuration
-   */
-  backoffConfig?: BackoffConfig
-  /**
-   * Rate limiting configuration
-   * Can be a string like "5/minute" or an Every object
-   */
-  rate?: string | Every
-  /**
-   * Whether the job is enabled
-   */
-  enabled?: boolean
-  /**
-   * Maximum execution time in milliseconds
-   */
-  timeout?: number
-  /**
-   * Unique job key to prevent duplicates
-   */
-  key?: string
-  /**
-   * Time-to-live in seconds for the job key
-   */
-  ttl?: number
-  /**
-   * Whether to run the job immediately when added
-   */
-  immediate?: boolean
-  /**
-   * Custom metadata for the job
-   */
-  meta?: Record<string, any>
-}