@stacksjs/types 0.59.10 → 0.61.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/types",
   "type": "module",
-  "version": "0.59.10",
+  "version": "0.61.0",
   "description": "The Stacks framework types.",
   "author": "Chris Breuer",
   "license": "MIT",
@@ -46,42 +46,39 @@
   },
   "peerDependencies": {
     "@stacksjs/validation": "latest",
-    "neverthrow": "^6.1.0"
+    "neverthrow": "^6.2.1"
   },
   "dependencies": {
-    "@mdit-vue/plugin-component": "^2.0.0",
-    "@mdit-vue/plugin-frontmatter": "^2.0.0",
-    "@mdit-vue/types": "^2.0.0",
+    "@mdit-vue/plugin-component": "^2.1.3",
+    "@mdit-vue/plugin-frontmatter": "^2.1.3",
+    "@mdit-vue/types": "^2.1.0",
     "@rollup/pluginutils": "^5.1.0",
     "@stacksjs/validation": "latest",
     "@types/aws4": "^1.11.6",
-    "@types/bcryptjs": "^2.4.6",
-    "@types/bun": "^1.0.8",
+    "@types/bun": "^1.1.2",
     "@types/crypto-js": "^4.2.2",
-    "@types/eslint": "^8.56.5",
     "@types/fs-extra": "^11.0.4",
-    "@types/markdown-it-link-attributes": "^3.0.4",
+    "@types/markdown-it-link-attributes": "^3.0.5",
     "@types/minimatch": "^5.1.2",
-    "@types/node": "^20.11.24",
     "@types/nprogress": "^0.2.3",
-    "@vinejs/vine": "^1.7.1",
+    "@vinejs/vine": "^2.0.0",
     "cac": "^6.7.14",
-    "markdown-it": "^14.0.0",
-    "meilisearch": "^0.37.0",
-    "neverthrow": "^6.1.0",
+    "markdown-it": "^14.1.0",
+    "meilisearch": "^0.40.0",
+    "neverthrow": "^6.2.1",
     "ora": "^8.0.1",
-    "unocss": "^0.58.5",
-    "unplugin-auto-import": "^0.17.5",
-    "unplugin-vue-components": "^0.26.0",
-    "vite": "^5.1.5",
-    "vite-plugin-inspect": "^0.8.3",
-    "vite-plugin-pwa": "^0.19.2",
-    "vite-ssg": "^0.23.6",
-    "vitepress": "1.0.0-rc.44",
-    "vue": "^3.4.21"
+    "unocss": "^0.60.3",
+    "unplugin-auto-import": "^0.17.6",
+    "unplugin-vue-components": "^0.27.0",
+    "vite": "^5.2.11",
+    "vite-plugin-inspect": "^0.8.4",
+    "vite-plugin-pwa": "^0.20.0",
+    "vite-ssg": "^0.23.7",
+    "vitepress": "1.2.2",
+    "vue": "^3.4.27"
   },
   "devDependencies": {
-    "aws-cdk-lib": "^2.131.0",
-    "typescript": "^5.3.3"
+    "aws-cdk-lib": "^2.142.1",
+    "typescript": "^5.4.5"
   }
 }

package/src/ai.ts

@@ -1,4 +1,5 @@
-type AiModel = 'amazon.titan-embed-text-v1'
+type AiModel =
+  | 'amazon.titan-embed-text-v1'
   | 'amazon.titan-text-lite-v1'
   | 'amazon.titan-text-express-v1'
   | 'amazon.titan-embed-image-v1'

package/src/api.ts

@@ -27,6 +27,18 @@ export interface ApiOptions {
    */
   prefix: string
 
+  middleware: string[]
+
+  routes:
+    | {
+        index: boolean
+        show: boolean
+        store: boolean
+        update: boolean
+        destroy: boolean
+      }
+    | boolean
+
   /**
    * **API Prewarm**
    *

package/src/chat.ts

@@ -1,4 +1,4 @@
-interface ChatOptions {}
+type ChatOptions = {}
 export type { ChatOptions }
 
 export type ChatConfig = ChatOptions

package/src/cli.ts

@@ -193,43 +193,90 @@ export type ActionOptions = {
   domains?: boolean
   count?: number
   dryRun?: boolean // used in buddy release
-} & CliOptions & DomainsOptions
-
-export type BuildOption = 'components' | 'vueComponents' | 'webComponents' | 'elements' | 'functions' | 'docs' | 'views' | 'stacks' | 'all' | 'buddy' | 'server'
+} & CliOptions &
+  DomainsOptions
+
+export type BuildOption =
+  | 'components'
+  | 'vueComponents'
+  | 'webComponents'
+  | 'elements'
+  | 'functions'
+  | 'docs'
+  | 'views'
+  | 'stacks'
+  | 'all'
+  | 'buddy'
+  | 'server'
 export type BuildOptions = {
-  [key in BuildOption]: boolean;
+  [key in BuildOption]: boolean
 } & CliOptions
 
 export type AddOption = 'table' | 'calendar' | 'all'
 export type AddOptions = {
-  [key in AddOption]?: boolean;
+  [key in AddOption]?: boolean
 } & CliOptions
 
 export type CreateStringOption = 'name'
-export type CreateBooleanOption = 'ui' | 'components' | 'web-components' | 'vue' | 'views' | 'functions' | 'api' | 'database'
+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 DevOption =
+  | 'components'
+  | 'docs'
+  | 'frontend'
+  | 'api'
+  | 'desktop'
+  | 'all'
+  | 'email'
+  | 'system-tray'
+  | 'interactive'
+  | 'verbose'
 export type DevOptions = {
-  [key in DevOption]: boolean;
+  [key in DevOption]: boolean
 } & CliOptions
 
-export type GeneratorOption = 'types' | 'entries' | 'webTypes' | 'customData' | 'ideHelpers' | 'componentMeta' | 'coreSymlink' | 'pkgxConfig'
+export type GeneratorOption =
+  | 'types'
+  | 'entries'
+  | 'webTypes'
+  | 'customData'
+  | 'ideHelpers'
+  | 'componentMeta'
+  | 'coreSymlink'
+  | 'pkgxConfig'
 export type GeneratorOptions = {
-  [key in GeneratorOption]?: boolean;
+  [key in GeneratorOption]?: boolean
 } & CliOptions
 
 export type LintOption = 'fix'
 export type LintOptions = {
-  [key in LintOption]: boolean;
+  [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 MakeBooleanOption =
+  | 'component'
+  | 'page'
+  | 'function'
+  | 'language'
+  | 'database'
+  | 'migration'
+  | 'model'
+  | 'notification'
+  | 'stack'
 export type MakeOptions = {
   [key in MakeBooleanOption]: boolean
 } & {
@@ -241,18 +288,18 @@ export type UpgradeBoolean = 'framework' | 'dependencies' | 'bun' | 'shell' | 'b
 export type UpgradeString = 'version'
 
 export type UpgradeOptions = {
-  [key in UpgradeBoolean]: boolean;
+  [key in UpgradeBoolean]: boolean
 } & {
-  [key in UpgradeString]: string;
+  [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 ExamplesOption = ExamplesString & ExamplesBoolean
 export type ExamplesOptions = {
-  [key in ExamplesString]: string;
+  [key in ExamplesString]: string
 } & {
-  [key in ExamplesBoolean]: boolean;
+  [key in ExamplesBoolean]: boolean
 } & CliOptions
 export type TestOptions = CliOptions & {
   showReport?: boolean
@@ -299,34 +346,36 @@ export type DomainsOptions = CliOptions & {
   contactType?: string
 }
 
-export interface CleanOptions extends CliOptions { }
+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 CommitOptions extends CliOptions {}
+export interface KeyOptions extends CliOptions {}
 export interface FreshOptions extends CliOptions {
   dryRun?: boolean
   quiet?: boolean
 }
-export interface MigrateOptions extends CliOptions { }
-export interface InspireOptions extends CliOptions { }
-export interface InstallOptions extends CliOptions { }
+export interface MigrateOptions extends CliOptions {
+  diff?: boolean
+}
+export interface InspireOptions extends CliOptions {}
+export interface InstallOptions extends CliOptions {}
 export interface ReleaseOptions extends CliOptions {
   dryRun?: boolean
 }
 export interface ProjectsOptions extends CliOptions {
   list?: boolean
 }
-export interface PreinstallOptions extends CliOptions { }
-export interface PrepublishOptions extends CliOptions { }
+export interface PreinstallOptions extends CliOptions {}
+export interface PrepublishOptions extends CliOptions {}
 export interface PortsOptions extends CliOptions {
   ports?: Partial<Ports>
 }
-export interface TinkerOptions extends CliOptions { }
-export interface TypesOptions extends CliOptions { }
+export interface TinkerOptions extends CliOptions {}
+export interface TypesOptions extends CliOptions {}
 
 export type LibEntryType = 'vue-components' | 'web-components' | 'functions' | 'all'
 

package/src/cloud.ts

@@ -1,32 +1,256 @@
-import type { ApiOptions } from './api'
+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'
+  | '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'
+  | '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'
+  | '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'
 
@@ -35,7 +259,8 @@ export interface CloudOptions {
 
   driver: 'aws'
 
-  // eslint-disable-next-line ts/ban-types
+  api: ApiConfig
+
   storage: {}
 
   /**
@@ -96,8 +321,6 @@ export interface CloudOptions {
     }
   }
 
-  api: ApiOptions
-
   ai: boolean
   cli: boolean
   docs: boolean

package/src/database.ts

@@ -1,12 +1,6 @@
 export interface DatabaseOptions {
   default: string
 
-  /**
-   * The name of the database to use.
-   * @default stacks
-   */
-  name: string
-
   connections: {
     mysql?: {
       url?: string
@@ -24,11 +18,27 @@ export interface DatabaseOptions {
       prefix?: string
     }
 
-    planetscale?: object
-    postgres?: object
+    dynamodb?: {
+      key?: string
+      secret?: string
+      region?: string
+      prefix?: string
+      endpoint?: string
+    }
+
+    postgres?: {
+      url?: string
+      host?: string
+      port?: number
+      name?: string
+      username?: string
+      password?: string
+      prefix?: string
+    }
   }
 
   migrations: string
+  migrationLocks: string
 }
 
 export type DatabaseConfig = Partial<DatabaseOptions>