@stacksjs/types 0.70.23 → 0.70.25

package/dist/src/cli.d.ts

@@ -0,0 +1,308 @@
+import type { BunFile } from 'bun';
+import type { Ports } from './ports';
+export type { ErrorLike, SpawnOptions, Subprocess, SyncSubprocess } from 'bun';
+export type { CAC as CLI } from 'cac';
+export declare interface OutroOptions extends CliOptions {
+  type?: 'success' | 'error' | 'warning' | 'info'
+  startTime?: number
+  useSeconds?: boolean
+  quiet?: boolean
+  message?: string
+}
+export declare interface IntroOptions {
+  showPerformance?: boolean
+  quiet: boolean
+}
+/**
+ * The options to pass to the CLI.
+ */
+export declare interface CliOptions {
+  verbose?: boolean
+  silent?: boolean
+  quiet?: boolean
+  cwd?: string
+  stdio?: [In, Out, Out]
+  stdin?: stdin
+  stdout?: stdout
+  stderr?: stderr
+  env?: Record<string, string | undefined>
+  background?: boolean
+  timeoutMs?: number
+  startTime?: number
+  withLocalhost?: boolean
+  input?: string | ArrayBufferView | ReadableStream | Blob | Response | Request
+  project?: string
+}
+export declare interface CleanOptions extends CliOptions {}
+export declare interface CloudCliOptions extends CliOptions {
+  ssh?: boolean
+  connect?: boolean
+  jumpBox?: boolean
+  invalidateCache?: boolean
+  paths?: string
+  diff?: boolean
+}
+export declare interface CommitOptions extends CliOptions {}
+export declare interface FreshOptions extends CliOptions {
+  dryRun?: boolean
+  quiet?: boolean
+}
+export declare interface InspireOptions extends CliOptions {}
+export declare interface InstallOptions extends CliOptions {}
+export declare interface KeyOptions extends CliOptions {}
+export declare interface MigrateOptions extends CliOptions {
+  diff?: boolean
+}
+export declare interface CliQueueOptions extends CliOptions {
+  queue?: string
+  id?: string | number
+  all?: boolean
+  force?: boolean
+  connection?: string
+}
+export declare interface ReleaseOptions extends CliOptions {
+  dryRun?: boolean
+  bump?: 'patch' | 'minor' | 'major' | 'prepatch' | 'preminor' | 'premajor' | 'prerelease' | string
+}
+export declare interface ProjectsOptions extends CliOptions {
+  list?: boolean
+}
+export declare interface PreinstallOptions extends CliOptions {}
+export declare interface PrepublishOptions extends CliOptions {}
+export declare interface PortsOptions extends CliOptions {
+  ports?: Partial<Ports>
+}
+export declare interface SaasOptions extends CliOptions {}
+export declare interface SearchCommandOptions extends CliOptions {
+  model: string
+  settings: boolean
+  flush: boolean
+}
+export declare interface ScheduleOptions extends CliOptions {}
+export declare interface TinkerOptions extends CliOptions {
+  eval?: string | boolean
+  print?: string | boolean
+  noBanner?: boolean
+  preload?: string
+}
+export declare interface TypesOptions extends CliOptions {}
+declare type ArrayBufferView = NodeJS.TypedArray | DataView;
+export type Readable = | 'pipe'
+  | 'inherit'
+  | 'ignore'
+  | null // equivalent to 'ignore'
+  | undefined // to use default
+  | BunFile
+  | ArrayBufferView
+  | number;
+export type Writable = | 'pipe'
+  | 'inherit'
+  | 'ignore'
+  | null // equivalent to 'ignore'
+  | undefined // to use default
+  | BunFile
+  | ArrayBufferView
+  | number
+  | ReadableStream
+  | Blob
+  | Response
+  | Request;
+export type In = Readable;
+export type Out = Writable;
+/**
+ * The file descriptor for the standard input. It may be:
+ *
+ * - `"ignore"`, `null`, `undefined`: The process will have no standard input
+ * - `"pipe"`: The process will have a new {@link FileSink} for standard input
+ * - `"inherit"`: The process will inherit the standard input of the current process
+ * - `ArrayBufferView`, `Blob`: The process will read from the buffer
+ * - `number`: The process will read from the file descriptor
+ *
+ * @default "ignore"
+ */
+export type stdin = 'ignore' | 'inherit' | 'pipe' | ArrayBufferView | number | null | undefined;
+/**
+ * The file descriptor for the standard output. It may be:
+ *
+ * - `"pipe"`, `undefined`: The process will have a {@link ReadableStream} for standard output/error
+ * - `"ignore"`, `null`: The process will have no standard output/error
+ * - `"inherit"`: The process will inherit the standard output/error of the current process
+ * - `ArrayBufferView`: The process write to the preallocated buffer. Not implemented.
+ * - `number`: The process will write to the file descriptor
+ *
+ * @default "pipe"
+ */
+export type stdout = 'ignore' | 'inherit' | 'pipe' | ArrayBufferView | number;
+/**
+ * The file descriptor for the standard error. It may be:
+ *
+ * - `"pipe"`, `undefined`: The process will have a {@link ReadableStream} for standard output/error
+ * - `"ignore"`, `null`: The process will have no standard output/error
+ * - `"inherit"`: The process will inherit the standard output/error of the current process
+ * - `ArrayBufferView`: The process write to the preallocated buffer. Not implemented.
+ * - `number`: The process will write to the file descriptor
+ *
+ * @default "inherit" for `spawn`
+ * "pipe" for `spawnSync`
+ */
+export type stderr = 'ignore' | 'inherit' | 'pipe' | ArrayBufferView | number;
+// type SpinnerOptions = Ora
+export type CliOptionsKeys = keyof CliOptions;
+export type CliConfig = CliOptions;
+// export type { Ora as SpinnerOptions } from 'ora'
+// the `domains` option is only available for the `deploy` command
+// the `count` option is only available for the `seed` command
+export type ActionOption = 'types' | 'domains' | 'count';
+/**
+ * The options to pass to the Action.
+ */
+export type ActionOptions = {
+  types?: boolean
+  domains?: boolean
+  count?: number
+  dryRun?: boolean // used in buddy release
+} & CliOptions &
+DomainsOptions;
+export type BuildOption = | 'components'
+  | 'webComponents'
+  | 'elements'
+  | 'functions'
+  | 'docs'
+  | 'views'
+  | 'stacks'
+  | 'all'
+  | 'buddy'
+  | 'server';
+export type BuildOptions = {
+  [key in BuildOption]: boolean
+} & CliOptions;
+export type AddOption = 'table' | 'calendar' | 'all';
+export type AddOptions = {
+  [key in AddOption]?: boolean
+} & CliOptions;
+export type CreateStringOption = 'name';
+export type CreateBooleanOption = | 'ui'
+  | 'components'
+  | 'web-components'
+  | 'vue'
+  | 'views'
+  | 'functions'
+  | 'api'
+  | 'database';
+export type CreateOptions = {
+  [key in CreateBooleanOption]: boolean
+} & {
+  [key in CreateStringOption]: string
+} & CliOptions;
+export type DevOption = | 'components'
+  | 'docs'
+  | 'frontend'
+  | 'api'
+  | 'desktop'
+  | 'all'
+  | 'email'
+  | 'system-tray'
+  | 'interactive'
+  | 'verbose';
+export type DevOptions = {
+  [key in DevOption]: boolean
+} & CliOptions;
+export type GeneratorOption = | 'types'
+  | 'entries'
+  | 'webTypes'
+  | 'customData'
+  | 'ideHelpers'
+  | 'componentMeta'
+  | 'coreSymlink'
+  | 'openApiSpec'
+  | 'pantryConfig'
+  | 'openapi'
+  | 'modelFiles';
+export type GeneratorOptions = {
+  [key in GeneratorOption]?: boolean
+} & CliOptions;
+export type LintOption = 'fix';
+export type LintOptions = {
+  [key in LintOption]: boolean
+} & CliOptions;
+export type MakeStringOption = 'name' | 'chat' | 'sms' | 'env';
+export type MakeBooleanOption = | 'component'
+  | 'page'
+  | 'function'
+  | 'language'
+  | 'database'
+  | 'migration'
+  | 'model'
+  | 'notification'
+  | 'stack'
+  | 'middleware'
+  | 'dryRun'
+  | 'withValidation'
+  | 'withAuth';
+export type MakeOptions = {
+  [key in MakeBooleanOption]: boolean
+} & {
+  [key in MakeStringOption]: string
+} & CliOptions;
+export type UpgradeBoolean = 'framework' | 'dependencies' | 'bun' | 'shell' | 'binary' | 'all' | 'force' | 'canary' | 'stable' | 'noPostinstall' | 'postinstall';
+export type UpgradeString = 'version' | 'from';
+export type UpgradeOptions = {
+  [key in UpgradeBoolean]?: boolean
+} & {
+  [key in UpgradeString]?: string
+} & CliOptions;
+export type ExamplesString = 'version';
+export type ExamplesBoolean = 'components' | 'vue' | 'webComponents' | 'elements' | 'all' | 'force';
+export type ExamplesOption = ExamplesString & ExamplesBoolean;
+export type ExamplesOptions = {
+  [key in ExamplesString]: string
+} & {
+  [key in ExamplesBoolean]: boolean
+} & CliOptions;
+export type TestingOptions = CliOptions & {
+  ui?: boolean
+  feature?: boolean
+  unit?: boolean
+}
+export type DomainsOptions = CliOptions & {
+  domain?: string
+  yes?: boolean
+  years?: number
+  privacy?: boolean
+  autoRenew?: boolean
+  registrantFirstName?: string
+  registrantLastName?: string
+  registrantOrganization?: string
+  registrantAddress?: string
+  registrantCity?: string
+  registrantState?: string
+  registrantCountry?: string
+  registrantZip?: string
+  registrantPhone?: string
+  registrantEmail?: string
+  adminFirstName?: string
+  adminLastName?: string
+  adminOrganization?: string
+  adminAddress?: string
+  adminCity?: string
+  adminState?: string
+  adminCountry?: string
+  adminZip?: string
+  adminPhone?: string
+  adminEmail?: string
+  techFirstName?: string
+  techLastName?: string
+  techOrganization?: string
+  techAddress?: string
+  techCity?: string
+  techState?: string
+  techCountry?: string
+  techZip?: string
+  techPhone?: string
+  techEmail?: string
+  privacyAdmin?: boolean
+  privacyTech?: boolean
+  privacyRegistrant?: boolean
+  contactType?: string
+}
+export type LibEntryType = 'web-components' | 'functions' | 'all';

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

@@ -1,8 +1,33 @@
 import type { ApiConfig } from './api';
 import type { FirewallConfig } from './security';
-
-export declare type CountryCode =
-  | 'AD'
+declare interface SiteConfig {
+  domain: string
+  path: string
+}
+export declare interface TunnelCloudConfig {
+  enabled: boolean
+  domain?: string
+  region?: string
+  instanceType?: string
+  prefix?: string
+  ssl?: {
+    enabled: boolean
+    porkbunApiKey?: string
+    porkbunSecretKey?: string
+  }
+}
+export declare interface CloudOptions {
+  sites: {
+    root: string
+    path: string
+    [site: string]: string | SiteConfig
+  }
+  infrastructure: InfrastructureOptions
+  cdn: any
+  api: any
+  firewall: any
+}
+export type CountryCode = | 'AD'
   | 'AE'
   | 'AF'
   | 'AG'
@@ -250,23 +275,47 @@ export declare type CountryCode =
   | 'YT'
   | 'ZA'
   | 'ZM'
-  | 'ZW'
-
-type Environment = 'development' | 'staging' | 'production'
-
-interface SiteConfig {
-  domain: string
-  path: string
-}
-
-type InfrastructureOptions = Partial<{
-  type: 'serverless' 
+  | 'ZW';
+declare type Environment = 'development' | 'staging' | 'production';
+declare 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: {
@@ -296,16 +345,22 @@ type InfrastructureOptions = Partial<{
   cli: boolean
   docs: boolean
   fileSystem: boolean
-}>
-
-export interface CloudOptions {
-  sites: {
-    root: string
-    path: string
-    [site: string]: string | SiteConfig
-  }
-
-  infrastructure: InfrastructureOptions
-}
 
-export type CloudConfig = Partial<CloudOptions>
+  /**
+   * **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 type CloudConfig = Partial<CloudOptions>;

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

@@ -1,12 +1,9 @@
-export type { Options as ComponentOptions } from 'unplugin-vue-components'
 export declare interface TagOption {
   name: string | string[]
-
   description?: string
-
   attributes?: {
     name: string
     description: string
   }[]
 }
-export declare type TagsOptions = TagOption[]
+export type TagsOptions = TagOption[];

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

@@ -9,4 +9,4 @@ export declare interface ConfigureOptions {
   output: string
   quiet: boolean
 }
-export declare type ConfigureConfig = Partial<ConfigureOptions>
+export type ConfigureConfig = Partial<ConfigureOptions>;

package/dist/{cron-jobs.d.ts → src/cron-jobs.d.ts}

@@ -1,51 +1,18 @@
 import type { IntRange } from '@stacksjs/cron';
-
-export declare 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
-
-type BackoffStrategy = 'fixed' | 'exponential' | 'linear' | 'random'
-
-export interface JitterConfig {
+export declare interface JitterConfig {
   enabled: boolean
   factor?: number
   minDelay?: number
   maxDelay?: number
 }
-
-export interface BackoffConfig {
+export declare interface BackoffConfig {
   strategy: BackoffStrategy
   initialDelay: number
   factor?: number
   maxDelay?: number
   jitter?: JitterConfig
 }
-
-export interface JobOptions {
+export declare interface JobOptions {
   name?: string
   handle?: string | JobHandler
   action?: string
@@ -62,4 +29,33 @@ export interface JobOptions {
   ttl?: number
   immediate?: boolean
   meta?: Record<string, any>
-}
+}
+export type Job = JobOptions;
+export type Jobs = Job[];
+export type CronJob = Job;
+export type CronJobs = Jobs;
+export type JobHandler = (_data?: any) => Promise<any> | any;
+/**
+ * Represents different backoff strategies for job retries
+ */
+declare type BackoffStrategy = 'fixed' | 'exponential' | 'linear' | 'random';
+export declare 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 *',
+}

package/dist/src/dashboard.d.ts

@@ -0,0 +1,33 @@
+/**
+ * **Dashboard Options**
+ *
+ * Controls which sections render in the `buddy dev --dashboard` sidebar.
+ * Every section defaults to enabled — set a flag to `false` in
+ * `config/dashboard.ts` to hide it (for example, projects that don't
+ * use commerce features set `commerce.enabled: false`).
+ *
+ * The `data` section is always visible (it's where every project's
+ * userland models live). It exposes per-row toggles for the basic
+ * built-in rows so a project can drop, say, the newsletter Subscribers
+ * row when there's no newsletter without losing the model viewer.
+ */
+export declare interface DashboardOptions {
+  sections?: {
+    library?: { enabled?: boolean }
+    content?: { enabled?: boolean }
+    commerce?: { enabled?: boolean }
+    marketing?: { enabled?: boolean }
+    analytics?: { enabled?: boolean }
+    management?: { enabled?: boolean }
+    utilities?: { enabled?: boolean }
+    data?: {
+      dashboard?: { enabled?: boolean }
+      activity?: { enabled?: boolean }
+      users?: { enabled?: boolean }
+      teams?: { enabled?: boolean }
+      subscribers?: { enabled?: boolean }
+      allModels?: { enabled?: boolean }
+    }
+  }
+}
+export type DashboardConfig = Partial<DashboardOptions>;

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

@@ -1,6 +1,7 @@
+import type { SupportedDialect } from 'bun-query-builder';
 export declare interface DatabaseOptions {
-  default: string
-
+  default: SupportedDialect
+  logging?: boolean
   connections: {
     mysql?: {
       url?: string
@@ -11,13 +12,11 @@ export declare interface DatabaseOptions {
       password?: string
       prefix?: string
     }
-
     sqlite: {
       url?: string
       database?: string
       prefix?: string
     }
-
     dynamodb?: {
       key?: string
       secret?: string
@@ -25,7 +24,6 @@ export declare interface DatabaseOptions {
       prefix?: string
       endpoint?: string
     }
-
     postgres?: {
       url?: string
       host?: string
@@ -36,19 +34,29 @@ export declare interface DatabaseOptions {
       prefix?: string
     }
   }
-
   migrations: string
   migrationLocks: string
+  queryLogging?: {
+    enabled: boolean
+    slowThreshold: number
+    retention: number
+    pruneFrequency: number
+    excludedQueries?: string[]
+    analysis?: {
+      enabled: boolean
+      analyzeAll: boolean
+      explainPlan: boolean
+      suggestions: boolean
+    }
+  }
 }
-export declare type DatabaseConfig = Partial<DatabaseOptions>
-
-export interface FactoryOptions {
+export declare interface FactoryOptions {
   name: string
   count?: number
   items: object
   columns: object
 }
-
-export interface SchemaOptions {
+export declare interface SchemaOptions {
   database: string
-}
+}
+export type DatabaseConfig = Partial<DatabaseOptions>;

package/dist/src/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/src/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
+}