@stacksjs/types 0.58.48 → 0.58.49

package/src/cli.ts

@@ -0,0 +1,305 @@
+import type { BunFile } from 'bun'
+
+type ArrayBufferView = TypedArray | DataView
+
+export type { Subprocess, SyncSubprocess } from 'bun'
+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
+export type Err = 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
+
+export interface OutroOptions extends CliOptions {
+  type?: 'success' | 'error' | 'warning' | 'info'
+  startTime?: number
+  useSeconds?: boolean
+  quiet?: boolean
+  message?: string
+}
+
+export interface IntroOptions {
+  /**
+   * @default true
+   */
+  showPerformance?: boolean
+
+  /**
+   * @default false
+   */
+  quiet: boolean
+}
+
+// type SpinnerOptions = Ora
+
+export type CliOptionsKeys = keyof CliOptions
+
+/**
+ * The options to pass to the CLI.
+ */
+export interface CliOptions {
+  /**
+   * **Verbose Output**
+   *
+   * When your application is in "verbose"-mode, a different level of,
+   * information like useful outputs for debugging reasons, will be
+   * shown. When disabled, it defaults to the "normal experience."
+   *
+   * @default false
+   */
+  verbose?: boolean
+
+  /**
+   * **Silent Mode**
+   *
+   * When you are using "silent"-mode, the CLI will not output anything
+   * to the console. This is useful when you want to run the CLI in
+   * the background.
+   *
+   * @default false
+   */
+  silent?: boolean
+
+  /**
+   * **Current Work Directory**
+   *
+   * Based on the `cwd` value, that's where the command...
+   *
+   * @default projectPath()
+   */
+  cwd?: string
+
+  /**
+   * @default 'pipe'
+   */
+  stdin?: stdin
+
+  /**
+   * @default 'pipe'
+   */
+  stdout?: stdout
+
+  /**
+   * @default 'inherit'
+   */
+  stderr?: stderr
+
+  env?: Record<string, string | undefined>
+
+  /**
+   * Runs the action in interactive/detached mode.
+   * @default false
+   */
+  background?: boolean
+
+  startTime?: number
+
+  /**
+   * Include the localhost URL in the output.
+   * @default false
+   */
+  withLocalhost?: boolean
+}
+
+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
+} & CliOptions & DomainsOptions
+
+export type BuildOption = 'components' | 'vueComponents' | 'webComponents' | 'elements' | 'functions' | 'docs' | 'views' | 'stacks' | 'all' | 'buddy'
+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'
+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'
+export type MakeOptions = {
+  [key in MakeBooleanOption]: boolean
+} & {
+  [key in MakeStringOption]: string
+} & CliOptions
+
+export type UpgradeBoolean = 'framework' | 'dependencies' | 'packageManager' | 'node' | 'all' | 'force'
+export type UpgradeString = 'version'
+
+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 | void
+export type ExamplesOptions = {
+  [key in ExamplesString]: string;
+} & {
+  [key in ExamplesBoolean]: boolean;
+} & CliOptions
+export type TestOptions = CliOptions & {
+  showReport?: 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 interface CleanOptions extends CliOptions { }
+export interface CloudCliOptions extends CliOptions {
+  ssh?: boolean
+  connect?: boolean
+  jumpBox?: boolean
+}
+export interface CommitOptions extends CliOptions { }
+export interface KeyOptions extends CliOptions { }
+export interface FreshOptions extends CliOptions { }
+export interface MigrateOptions extends CliOptions { }
+export interface InspireOptions extends CliOptions { }
+export interface InstallOptions extends CliOptions { }
+export interface ReleaseOptions extends CliOptions { }
+export interface PreinstallOptions extends CliOptions { }
+export interface PrepublishOptions extends CliOptions { }
+export interface TinkerOptions extends CliOptions { }
+export interface TypesOptions extends CliOptions { }
+
+export type LibEntryType = 'vue-components' | 'web-components' | 'functions' | 'all'
+
+export type { CAC as CLI } from 'cac'

package/src/cloud.ts

@@ -0,0 +1,85 @@
+import type { ApiOptions } 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'
+
+export interface CloudOptions {
+  driver: 'aws'
+
+  // eslint-disable-next-line ts/ban-types
+  storage: {}
+
+  /**
+   * **Firewall Settings**
+   *
+   * These settings are used to configure the firewall.
+   *
+   * @see https://stacksjs.org/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
+
+  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[]
+    }
+  }
+
+  api: ApiOptions
+
+  ai: boolean
+  cli: boolean
+  docs: boolean
+  fileSystem: boolean
+}
+
+export type CloudConfig = Partial<CloudOptions>

package/src/components.ts

@@ -0,0 +1,64 @@
+export type { Options as ComponentOptions } from 'unplugin-vue-components'
+
+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.org/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.org/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.org/docs/components
+   */
+  attributes?: {
+    name: string
+    description: string
+  }[]
+}
+
+export type TagsOptions = TagOption[]

package/src/configure.ts

@@ -0,0 +1,6 @@
+export interface ConfigureOptions {
+  aws: boolean
+  verbose: boolean
+}
+
+export type ConfigureConfig = Partial<ConfigureOptions>

package/src/cron-jobs.ts

@@ -0,0 +1,44 @@
+/**
+ * Cron Job Options.
+ */
+export interface JobOptions {
+  /**
+   * The name of the job.
+   */
+  name?: string
+
+  handle: string | Function
+  action?: string
+  description?: string
+  timezone?: string
+  tries?: number
+  backoff?: number | number[]
+  enabled?: boolean
+}
+
+export type JobConfig = JobOptions
+export type Job = JobOptions
+export type Jobs = Job[]
+export type CronJob = Job
+export type CronJobs = Jobs
+
+// 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 = '* * * * *',
+  Hour = '0 * * * *',
+  HalfHour = '0,30 * * * *',
+  Day = '0 0 * * *',
+  Month = '0 0 1 * *',
+  Week = '0 0 * * 0',
+  Year = '0 0 1 1 *',
+  FifthMinute = '*/5 * * * *',
+  TenthMinute = '*/10 * * * *',
+}

package/src/database.ts

@@ -0,0 +1,45 @@
+export interface DatabaseOptions {
+  default: string
+
+  /**
+   * The name of the database to use.
+   * @default stacks
+   */
+  name: string
+
+  connections: {
+    mysql?: {
+      url?: string
+      host?: string
+      port?: number
+      name?: string
+      username?: string
+      password?: string
+      prefix?: string
+    }
+
+    sqlite: {
+      url?: string
+      database?: string
+      prefix?: string
+    }
+
+    planetscale?: object
+    postgres?: object
+  }
+
+  migrations: string
+}
+
+export type DatabaseConfig = Partial<DatabaseOptions>
+
+export interface FactoryOptions {
+  name: string
+  count?: number
+  items: object
+  columns: object
+}
+
+export interface SchemaOptions {
+  database: string
+}

package/src/dependencies.ts

@@ -0,0 +1,69 @@
+/**
+ * **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 interface DependenciesOptions {
+  /**
+   * **Bun**
+   *
+   * @default '0.7.1'
+   * @link https://bun.sh
+   */
+  'bun.sh': string | '0.7.1'
+
+  /**
+   * **SQLite**
+   *
+   * @default '^3.42.0'
+   * @link https://sqlite.org
+   */
+  'sqlite.org'?: string | '^3.42.0'
+
+  /**
+   * **MySQL**
+   *
+   * @default '^8.0.33'
+   * @link https://mysql.org
+   */
+  'mysql.com'?: string | '^8.0.33'
+
+  /**
+   * **MariaDB**
+   *
+   * @default '^10.6.5'
+   * @link https://mariadb.org
+   */
+  'mariadb.org'?: string | '^10.6.5'
+
+  /**
+   * **PostgreSQL**
+   *
+   * @default '^14.1'
+   * @link https://postgresql.org
+   */
+  'postgresql.org'?: string | '^14.1'
+
+  /**
+   * **Redis**
+   *
+   * @default '^7.0.11'
+   * @link https://redis.io
+   */
+  'redis.io'?: string | '^7.0.11'
+
+  /**
+   * **AWS CLI**
+   *
+   * This dependency is only required if you are making use of the AWS driver
+   * (i.e. the Stacks generated cloud may make use of it).
+   *
+   * @default '^2.12.7'
+   * @link https://aws.amazon.com/cli
+   */
+  'aws.amazon.com/cli'?: string | '^2.12.7'
+}
+
+export type DependenciesConfig = DependenciesOptions

package/src/deploy.ts

@@ -0,0 +1,13 @@
+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 interface DeployOptions extends CliOptions {
+  domain?: string
+  deploy?: boolean
+}