stacks 0.51.0 → 0.52.0

package/core/types/src/cli.ts

@@ -3,12 +3,11 @@
  */
 
 import type { Ora } from 'ora'
+import type { ExecaReturnValue } from 'execa'
+import type { Err, Ok } from './errors'
 
-export interface StacksOptions {
-  componentsSrcPath?: string
-  dtsPath?: string
-  extensions?: string[]
-}
+export type CommandReturnValue = ExecaReturnValue<string>
+export type CommandResult = Ok<ExecaReturnValue<string>, Error | void> | Err<ExecaReturnValue<string>, Error | string | void>
 
 export interface OutroOptions {
   startTime?: number
@@ -25,27 +24,27 @@ export interface IntroOptions {
 
 type SpinnerOptions = Ora
 
+export type CliOptionsKeys = keyof CliOptions
+
+/**
+ * The CLI Options used in `./config/cli.ts`.
+ */
+export interface UserCliOptions {
+  name?: string
+  command?: string
+  description?: string
+}
+
 /**
  * The options to pass to the CLI.
  */
 export interface CliOptions {
   /**
-   * **CLI Debug Level**
+   * **Verbose Output**
    *
-   * When your application is in debug mode, a different level
-   * of information, like stack traces, will be shown. When
-   * disabled, it defaults to the "normal experience."
-   *
-   * @default false
-   */
-  debug?: boolean
-
-  /**
-   * **Verbosity Mode**
-   *
-   * 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."
+   * 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
    */
@@ -95,13 +94,26 @@ export interface CliOptions {
    * @default false
    */
   shell?: boolean
+
+  /**
+   * **Encoding**
+   *
+   * Encoding type
+   *
+   * @default 'utf-8'
+   */
+  encoding?: string
 }
 
 export type { Ora as SpinnerOptions } from 'ora'
 
-export type ActionsOption = 'types'
-export type ActionsOptions = {
-  [key in ActionsOption]?: boolean;
+export type ActionOption = 'types'
+
+/**
+ * The options to pass to the Action.
+ */
+export type ActionOptions = {
+  [key in ActionOption]?: boolean;
 } & CliOptions
 
 export type BuildOption = 'components' | 'vueComponents' | 'webComponents' | 'elements' | 'functions' | 'docs' | 'pages' | 'stacks' | 'all'
@@ -119,8 +131,8 @@ export type CreateBooleanOption = 'ui' | 'components' | 'web-components' | 'vue'
 export type CreateOptions = {
   [key in CreateBooleanOption]: boolean
 } & {
-  [key in CreateStringOption]: string
-} & CliOptions
+    [key in CreateStringOption]: string
+  } & CliOptions
 
 export type DevOption = 'components' | 'docs' | 'pages' | 'functions' | 'desktop' | 'all'
 export type DevOptions = {
@@ -137,21 +149,22 @@ export type LintOptions = {
   [key in LintOption]: boolean;
 } & CliOptions
 
-export type MakeStringOption = 'name' | 'chat' | 'sms'
+export type MakeStringOption = 'name' | 'chat' | 'sms' | 'env'
 export type MakeBooleanOption = 'component' | 'page' | 'function' | 'language' | 'database' | 'migration' | 'factory' | 'notification' | 'stack'
 export type MakeOptions = {
   [key in MakeBooleanOption]: boolean
 } & {
-  [key in MakeStringOption]: string
-} & CliOptions
+    [key in MakeStringOption]: string
+  } & CliOptions
+
+export type UpgradeBoolean = 'framework' | 'dependencies' | 'packageManager' | 'node' | 'all' | 'force'
+export type UpgradeString = 'version'
 
-export type UpdateString = 'version'
-export type UpdateBoolean = 'framework' | 'dependencies' | 'packageManager' | 'node' | 'all' | 'force'
-export type UpdateOptions = {
-  [key in UpdateString]: string;
+export type UpgradeOptions = {
+  [key in UpgradeBoolean]: boolean;
 } & {
-  [key in UpdateBoolean]: boolean;
-} & CliOptions
+    [key in UpgradeString]: string;
+  } & CliOptions
 
 export type ExamplesString = 'version'
 export type ExamplesBoolean = 'components' | 'vue' | 'webComponents' | 'elements' | 'all' | 'force'
@@ -159,20 +172,22 @@ export type ExamplesOption = ExamplesString & ExamplesBoolean | void
 export type ExamplesOptions = {
   [key in ExamplesString]: string;
 } & {
-  [key in ExamplesBoolean]: boolean;
-} & CliOptions
+    [key in ExamplesBoolean]: boolean;
+  } & CliOptions
 export type TestOptions = CliOptions & {
   showReport?: boolean
 }
 
-export interface CleanOptions extends CliOptions {}
-export interface CommitOptions extends CliOptions {}
-export interface KeyOptions extends CliOptions {}
-export interface FreshOptions extends CliOptions {}
-export interface ReleaseOptions extends CliOptions {}
-export interface PreinstallOptions extends CliOptions {}
-export interface PrepublishOptions extends CliOptions {}
-export interface TypesOptions extends CliOptions {}
+export interface CleanOptions extends CliOptions { }
+export interface CommitOptions extends CliOptions { }
+export interface KeyOptions extends CliOptions { }
+export interface FreshOptions extends CliOptions { }
+export interface InspireOptions 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'
 
@@ -186,20 +201,15 @@ export const enum NpmScript {
   BuildFunctions = 'build:functions',
   BuildDocs = 'build:docs',
   BuildStacks = 'build:stacks',
-  Clean = 'rimraf ./pnpm-lock.yaml ./node_modules/ ./.stacks/**/node_modules',
+  Clean = 'rimraf ./pnpm-lock.yaml ./node_modules/ ./.stacks/**/node_modules ./.stacks/**/dist',
   Dev = 'dev',
   DevComponents = 'vite --config ./core/build/src/vue-components.ts',
-  DevDocs = 'dev:docs',
+  DevDocs = 'npx vitepress dev ./docs/src',
   DevDesktop = 'dev:desktop',
   DevPages = 'dev:pages',
   DevFunctions = 'dev:functions',
   Fresh = 'fresh',
-  Update = 'update',
-  UpdateDependencies = 'pnpm update',
-  UpdateFramework = 'update:framework',
-  UpdatePackageManager = 'update:package-manager',
-  UpdateNode = 'pnpm env use',
-  Lint = 'eslint .',
+  Lint = 'eslint . ; npx publint',
   LintFix = 'eslint . --fix',
   MakeStack = 'make:stack',
   Test = 'vitest --config vitest.config.ts',
@@ -207,7 +217,7 @@ export const enum NpmScript {
   TestFeature = 'playwright test --config playwright.config.ts',
   TestUi = 'vitest --config vitest.config.ts --ui',
   TestCoverage = 'vitest --config vitest.config.ts --coverage',
-  TestTypes = 'vue-tsc --noEmit',
+  TestTypes = 'vue-npx tsc --noEmit',
   Generate = 'generate',
   GenerateTypes = 'generate:types',
   GenerateEntries = 'generate:entries',
@@ -227,38 +237,49 @@ export const enum NpmScript {
   Preinstall = 'preinstall',
   Prepublish = 'prepublish',
   Wip = 'wip',
+  UpgradeNode = './.stacks/scripts/setup.sh +nodejs.org',
+  UpgradePackageManager = './.stacks/scripts/setup.sh +pnpm.io',
 }
 
 export const enum Action {
   Bump = 'bump', // wip - changelog action
-  Release = 'release',
-  Prepublish = 'prepublish',
-  BuildStacks = 'build-stacks',
+  BuildStacks = 'build/stacks',
   BuildComponentLibs = 'build-component-libs',
   BuildVueComponentLib = 'build-vue-component-lib',
   BuildWebComponentLib = 'build-web-component-lib',
   BuildCli = 'build-cli',
-  BuildCore = 'build-core', // ✅
+  BuildCore = 'build/core', // wip
   BuildDocs = 'build-docs',
   BuildFunctionLib = 'build-function-lib',
   Changelog = 'changelog', // wip
-  Fresh = 'fresh', // ✅
-  GeneratePackageJsons = 'generate-package-jsons', // ✅
+  Clean = 'clean', // wip
+  DevComponents = 'dev/components', // wip
+  DevDocs = 'dev/docs', // wip
+  Deploy = 'deploy', // wip
+  Fresh = 'fresh', // wip
+  GeneratePackageJsons = 'generate-package-jsons', // wip
   GenerateSettings = 'generate-settings',
   GenerateOnboarding = 'generate-onboarding',
-  Lint = 'lint', // ✅
-  LintFix = 'lint-fix', // ✅
-  Test = 'test', // ✅
-  TestUi = 'test-ui', // ✅
-  TestUnit = 'test-unit', // ✅
-  TestFeature = 'test-feature', // wip
-  TestCoverage = 'test-coverage', // ✅
-  ShowFeatureTestReport = 'show-feature-test-report', // wip
-  Typecheck = 'typecheck', // wip
+  Inspire = 'inspire', // wip
   KeyGenerate = 'key-generate', // wip
   MakeNotification = 'make-notification', // wip
-  DevComponents = 'dev-components', // wip
+  Migrate = 'migrate', // wip
+  Seed = 'seed', // wip
+  Lint = 'lint/index', // wip
+  LintFix = 'lint/fix', // wip
+  Prepublish = 'prepublish', // wip
+  Release = 'release', // wip
+  ShowFeatureTestReport = 'show-feature-test-report', // wip
+  Test = 'test', // wip
+  TestUi = 'test-ui', // wip
+  TestUnit = 'test-unit', // wip
+  TestFeature = 'test-feature', // wip
+  TestCoverage = 'test-coverage', // wip
+  Tinker = 'tinker',
+  Typecheck = 'typecheck', // wip
+  Upgrade = 'upgrade/index', // wip
+  UpgradeNode = 'upgrade/node', // wip
+  UpgradePackageManager = 'upgrade/package-manager', // wip
 }
 
 export type { CAC as CLI } from 'cac'
-export type { ExecaReturnValue as CommandResult } from 'execa'

package/core/types/src/components.ts

@@ -1,4 +1,4 @@
-import type { Options } from 'unplugin-vue-components'
+export type { Options as ComponentOptions } from 'unplugin-vue-components'
 
 export interface TagOption {
   /**
@@ -62,5 +62,3 @@ export interface TagOption {
 }
 
 export type TagsOptions = TagOption[]
-
-export type ComponentOptions = Options

package/core/types/src/cron-jobs.ts

@@ -0,0 +1,17 @@
+/**
+ * Cron Job Options.
+ */
+export interface CronJobOptions {
+  /**
+   * The name of the cron job.
+   */
+  name?: string
+  function: string
+  schedule: string
+  description?: string
+  enabled?: boolean
+  timezone?: string
+}
+
+export type CronJob = CronJobOptions
+export type CronJobs = CronJob[]

package/core/types/src/database.ts

@@ -1,3 +1,40 @@
-import type { PrismaClient } from '@prisma/client'
+import type { Model } from './model'
 
-export type DatabaseClient = PrismaClient
+export type DatabaseClient = any
+
+export interface DatabaseOptions {
+  driver: string
+
+  drivers: {
+    mysql: {
+      url?: string
+      host?: string
+      port?: number
+      client?: DatabaseClient
+      name: string
+      username?: string
+      password?: string
+    }
+
+    planetscale: {}
+    postgres: {}
+  }
+}
+
+export interface FactoryOptions {
+  name: string
+  count?: number
+  items: object
+  columns: object
+}
+
+export interface SchemaOptions {
+  database: string
+}
+
+export interface DatabaseDriver {
+  client: DatabaseClient
+  migrate: (models: Model[], path: string, options?: SchemaOptions) => Promise<void>
+  // seed: (modelName: string, data: SeedData) => Promise<void>
+  factory: (modelName: string, fileName: string, path: string) => Promise<void>
+}

package/core/types/src/deploy.ts

@@ -1,11 +1,8 @@
-export interface DeployOptions {
-  /**
-   * **Deployment Host**
-   *
-   * The host to deploy to.
-   *
-   * @default string 'netlify'
-   * @see https://stacksjs.dev/docs/components
-   */
-  driver: 'netlify' | 'vercel'
-}
+/**
+ * **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 {}

package/core/types/src/dns.ts

@@ -0,0 +1,49 @@
+export interface ARecord {
+  name: string | '@' | '*'
+  address: string // IPv4
+  ttl?: number | 'auto'
+}
+
+export interface CNameRecord {
+  name: string
+  target: string
+  ttl: number | 'auto'
+}
+
+export interface MXRecord {
+  name: string | '@'
+  mailServer: string
+  ttl: number | 'auto'
+  priority: number // 0-65535
+}
+
+export interface TxtRecord {
+  name: string | '@'
+  ttl: number | 'auto'
+  content: string
+}
+
+export interface AAAARecord {
+  name: string | '@' | '*'
+  address: string // IPv6
+  ttl: number | 'auto'
+}
+
+export type DnsRecord = ARecord | CNameRecord | MXRecord | TxtRecord | AAAARecord
+
+/**
+   * **DNS Options**
+   *
+   * This configuration defines all of your DNS 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.
+   *
+   * @see https://stacksjs.dev/docs/dns
+   */
+export interface DnsOptions {
+  a?: ARecord[]
+  aaaa?: AAAARecord[]
+  cname?: CNameRecord[]
+  mx?: MXRecord[]
+  txt?: TxtRecord[]
+}

package/core/types/src/docs.ts

@@ -1,3 +1,5 @@
 import type { UserConfig } from 'vitepress'
 
 export type DocsConfig = UserConfig
+
+export type DocsOptions = DocsConfig

package/core/types/src/events.ts

@@ -1,7 +1,7 @@
 /**
  * **Events**
  *
- * This configuration defines all of your events. Because Stacks is full-typed, you may
+ * This configuration defines all of your events. 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.
  *

package/core/types/src/git.ts

@@ -1,7 +1,7 @@
 /**
  * **Git Options**
  *
- * This configuration defines all of your git options. Because Stacks is full-typed, you may
+ * This configuration defines all of your git 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.
  */

package/core/types/src/index.ts

@@ -1,11 +1,15 @@
 export * from './app'
 export * from './auto-imports'
 export * from './build'
-export * from './components'
+export * from './cache'
+export * from './cdn'
 export * from './cli'
+export * from './components'
+export * from './cron-jobs'
 export * from './database'
-export * from './deploy'
 export * from './debug'
+export * from './deploy'
+export * from './dns'
 export * from './docs'
 export * from './errors'
 export * from './events'
@@ -19,13 +23,17 @@ export * from './layout'
 export * from './library'
 export * from './manifest'
 export * from './markdown'
+export * from './model'
 export * from './notifications'
 export * from './pages'
+export * from './payments'
 export * from './promise'
 export * from './pwa'
 export * from './reactivity'
+export * from './router'
 export * from './search-engine'
 export * from './ssg'
+export * from './stacks'
 export * from './tables'
 export * from './ui'
 export * from './utils'

package/core/types/src/library.ts

@@ -3,7 +3,7 @@ import type { TagsOptions } from './components'
 /**
  * **Library Options**
  *
- * This configuration defines all of your library options. Because Stacks is full-typed, you
+ * This configuration defines all of your library 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.
  */
@@ -18,6 +18,11 @@ export interface LibraryOptions {
    */
   parentName: string | null
 
+  /**
+   * The package registry to use.
+   */
+  packageRegistry: 'npm'
+
   /**
    * The path of your repository.
    *

package/core/types/src/model.ts

@@ -0,0 +1,46 @@
+import type { ZodBoolean as Boolean, ZodDate as Date, ZodNumber as Number, ZodString as String } from 'zod'
+import type { SearchIndexSettings } from './search-engine'
+
+export interface SeedOptions {
+  count: number
+}
+
+export interface TimestampOptions {
+  createdAt?: string // defaults to 'created_at'
+  updatedAt?: string
+  deletedAt?: string
+}
+
+/**
+ * Model.
+ */
+export interface Model {
+  name?: string // defaults to the file name of the model
+  table?: string // defaults to the lowercase, plural name of the model
+  fields: Fields
+  hasOne?: string
+  hasMany?: string
+  belongsToMany?: string
+  hasThrough?: {
+    model: string
+    through: string
+    using: string
+  }
+  seedable?: boolean | SeedOptions
+  useSeed?: boolean | SeedOptions
+  searchable?: boolean | SearchIndexSettings
+  useSearch?: boolean | SearchIndexSettings
+  useTimestamps?: boolean | TimestampOptions
+  // useSoftDeletes?: boolean | SoftDeleteOptions
+}
+
+export interface Fields {
+  [key: string]: {
+    type: string
+    default?: boolean
+    unique?: boolean
+    required?: boolean
+    factory?: () => any
+    validation?: String | Number | Boolean | Date
+  }
+}