@stacksjs/types 0.51.0 → 0.52.0

package/README.md

@@ -38,7 +38,7 @@ pnpm test
 
 Please see our [releases](https://github.com/stacksjs/stacks/releases) page for more information on what has changed recently.
 
-## 💪🏼 Contributing
+## 🚜 Contributing
 
 Please review the [Contributing Guide](https://github.com/stacksjs/contributing) for details.
 

package/dist/app.d.ts

@@ -1,7 +1,7 @@
 /**
  * **Application Options**
  *
- * This configuration defines all of your application options. Because Stacks is full-typed,
+ * This configuration defines all of your application 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.
  */
@@ -30,12 +30,11 @@ export interface AppOptions {
      * **Application URL**
      *
      * This URL is used by the console to properly generate URLs when using
-     * the Artisan command line tool. You should set this to the root of
-     * your application so that it is used when running Artisan tasks.
+     * the Buddy command line tool. You should set this to the root of
+     * your application so that it is used when running Buddy tasks.
      *
      * @default string "https://localhost"
-     * @example
-     * https://hello-world.test
+     * @example "https://hello-world.test"
      */
     url?: string;
     /**
@@ -98,16 +97,6 @@ export interface AppOptions {
      * @default string "en"
      */
     fallbackLocale: 'en';
-    /**
-     * **Integrated Development Environment**
-     *
-     * Currently, only VS Code is fully supported. While you may use Stacks with
-     * any editor, some of its tooling is VS Code specific. Hence, for the
-     * best experience, VS Code is currently the recommended editor.
-     *
-     * @default string "vscode"
-     */
-    editor: string;
     /**
      * **Cipher**
      *

package/dist/auto-imports.d.ts

@@ -1,2 +1 @@
-import type { Options } from 'unplugin-auto-import/types';
-export type AutoImportsOptions = Options;
+export type { Options as AutoImportsOptions } from 'unplugin-auto-import/types';

package/dist/build.d.ts

@@ -1,2 +1,2 @@
 export type { UserConfig as ViteConfig } from 'vite';
-export { type ViteSSGContext } from 'vite-ssg';
+export type { ViteSSGContext } from 'vite-ssg';

package/dist/build.mjs

@@ -1 +0,0 @@
-export {} from "vite-ssg";

package/dist/cache.d.ts

@@ -0,0 +1,69 @@
+export interface CacheOptions {
+    /**
+     * **Cache Driver**
+     *
+     * This value determines the cache driver that will be used by your application to store
+     * cached data. By default, Stacks uses the "redis" driver, which stores cached data in
+     * in a self-configufed Redis instance. You may use any of the other drivers provided
+     * by Stacks or write your own custom driver.
+     *
+     * @default "redis"
+     * @example "redis"
+     * @example "memcached"
+     * @example "dynamodb"
+     *
+     * @see https://stacks.js.org/docs/cache
+     */
+    driver: string;
+    /**
+     * **Cache Prefix**
+     *
+     * This value determines the prefix that will be used when storing items in the cache. This
+     * prefix may be useful when multiple applications are sharing the same cache driver so that
+     * they may avoid collisions when attempting to retrieve items from the cache.
+     *
+     * @default string "stacks"
+     * @example "stacks"
+     *
+     * @see https://stacks.js.org/docs/cache
+     */
+    prefix: string;
+    /**
+     * **Cache TTL**
+     *
+     * This value determines the default time to live for items stored in the cache. This value
+     * may be overridden when storing items in the cache. If no value is specified, the cache
+     * driver will default to a reasonable time to live for the given item.
+     *
+     * @default number 3600
+     * @example 3600
+     * @example 3600 * 24
+     * @example -1 (never expires)
+     */
+    ttl: number;
+    drivers: {
+        redis?: {
+            connection: string;
+            /**
+             * **Redis Host**
+             *
+             * This value determines the host that will be used to connect to the Redis server.
+             *
+             * @default string "localhost"
+             * @example "localhost"
+             */
+            host: string;
+            /**
+             * **Redis Port**
+             *
+             * This value determines the port that will be used to connect to the Redis server.
+             *
+             * @default number 6379
+             * @example 6379
+             */
+            port: number;
+        };
+        memcached?: {};
+        dynamodb?: {};
+    };
+}

package/dist/cdn.d.ts

@@ -0,0 +1,15 @@
+export interface CdnOptions {
+    /**
+     * **CDN Driver**
+     *
+     * This value determines the default CDN driver that will be used when interacting with the
+     * CDN service. This value may be overridden when interacting with the CDN service.
+     *
+     * @default "cloudfront"
+     * @example "cloudfront"
+     * @example "fastly" wip
+     *
+     * @see https://stacks.js.org/docs/cdn
+     */
+    driver: string;
+}

package/dist/cli.d.ts

@@ -2,11 +2,10 @@
  * The parsed command-line arguments
  */
 import type { Ora } from 'ora';
-export interface StacksOptions {
-    componentsSrcPath?: string;
-    dtsPath?: string;
-    extensions?: string[];
-}
+import type { ExecaReturnValue } from 'execa';
+import type { Err, Ok } from './errors';
+export type CommandReturnValue = ExecaReturnValue<string>;
+export type CommandResult = Ok<ExecaReturnValue<string>, Error | void> | Err<ExecaReturnValue<string>, Error | string | void>;
 export interface OutroOptions {
     startTime?: number;
     useSeconds?: boolean;
@@ -19,26 +18,25 @@ export interface IntroOptions {
     showPerformance?: boolean;
 }
 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**
-     *
-     * 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**
+     * **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."
+     * 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
      */
@@ -84,11 +82,22 @@ 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';
 export type BuildOptions = {
@@ -117,19 +126,19 @@ export type LintOption = 'fix';
 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;
-export type UpdateString = 'version';
-export type UpdateBoolean = 'framework' | 'dependencies' | 'packageManager' | 'node' | 'all' | 'force';
-export type UpdateOptions = {
-    [key in UpdateString]: string;
+export type UpgradeBoolean = 'framework' | 'dependencies' | 'packageManager' | 'node' | 'all' | 'force';
+export type UpgradeString = 'version';
+export type UpgradeOptions = {
+    [key in UpgradeBoolean]: boolean;
 } & {
-    [key in UpdateBoolean]: boolean;
+    [key in UpgradeString]: string;
 } & CliOptions;
 export type ExamplesString = 'version';
 export type ExamplesBoolean = 'components' | 'vue' | 'webComponents' | 'elements' | 'all' | 'force';
@@ -150,12 +159,16 @@ 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';
@@ -169,20 +182,15 @@ export declare 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",
@@ -190,7 +198,7 @@ export declare 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",
@@ -209,37 +217,48 @@ export declare const enum NpmScript {
     TypesGenerate = "types:generate",
     Preinstall = "preinstall",
     Prepublish = "prepublish",
-    Wip = "wip"
+    Wip = "wip",
+    UpgradeNode = "./.stacks/scripts/setup.sh +nodejs.org",
+    UpgradePackageManager = "./.stacks/scripts/setup.sh +pnpm.io"
 }
 export declare const enum Action {
     Bump = "bump",
-    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",
     BuildDocs = "build-docs",
     BuildFunctionLib = "build-function-lib",
     Changelog = "changelog",
+    Clean = "clean",
+    DevComponents = "dev/components",
+    DevDocs = "dev/docs",
+    Deploy = "deploy",
     Fresh = "fresh",
     GeneratePackageJsons = "generate-package-jsons",
     GenerateSettings = "generate-settings",
     GenerateOnboarding = "generate-onboarding",
-    Lint = "lint",
-    LintFix = "lint-fix",
+    Inspire = "inspire",
+    KeyGenerate = "key-generate",
+    MakeNotification = "make-notification",
+    Migrate = "migrate",
+    Seed = "seed",
+    Lint = "lint/index",
+    LintFix = "lint/fix",
+    Prepublish = "prepublish",
+    Release = "release",
+    ShowFeatureTestReport = "show-feature-test-report",
     Test = "test",
     TestUi = "test-ui",
     TestUnit = "test-unit",
     TestFeature = "test-feature",
     TestCoverage = "test-coverage",
-    ShowFeatureTestReport = "show-feature-test-report",
+    Tinker = "tinker",
     Typecheck = "typecheck",
-    KeyGenerate = "key-generate",
-    MakeNotification = "make-notification",
-    DevComponents = "dev-components"
+    Upgrade = "upgrade/index",
+    UpgradeNode = "upgrade/node",
+    UpgradePackageManager = "upgrade/package-manager"
 }
 export type { CAC as CLI } from 'cac';
-export type { ExecaReturnValue as CommandResult } from 'execa';

package/dist/cli.mjs

@@ -5,20 +5,15 @@ export var NpmScript = /* @__PURE__ */ ((NpmScript2) => {
   NpmScript2["BuildFunctions"] = "build:functions";
   NpmScript2["BuildDocs"] = "build:docs";
   NpmScript2["BuildStacks"] = "build:stacks";
-  NpmScript2["Clean"] = "rimraf ./pnpm-lock.yaml ./node_modules/ ./.stacks/**/node_modules";
+  NpmScript2["Clean"] = "rimraf ./pnpm-lock.yaml ./node_modules/ ./.stacks/**/node_modules ./.stacks/**/dist";
   NpmScript2["Dev"] = "dev";
   NpmScript2["DevComponents"] = "vite --config ./core/build/src/vue-components.ts";
-  NpmScript2["DevDocs"] = "dev:docs";
+  NpmScript2["DevDocs"] = "npx vitepress dev ./docs/src";
   NpmScript2["DevDesktop"] = "dev:desktop";
   NpmScript2["DevPages"] = "dev:pages";
   NpmScript2["DevFunctions"] = "dev:functions";
   NpmScript2["Fresh"] = "fresh";
-  NpmScript2["Update"] = "update";
-  NpmScript2["UpdateDependencies"] = "pnpm update";
-  NpmScript2["UpdateFramework"] = "update:framework";
-  NpmScript2["UpdatePackageManager"] = "update:package-manager";
-  NpmScript2["UpdateNode"] = "pnpm env use";
-  NpmScript2["Lint"] = "eslint .";
+  NpmScript2["Lint"] = "eslint . ; npx publint";
   NpmScript2["LintFix"] = "eslint . --fix";
   NpmScript2["MakeStack"] = "make:stack";
   NpmScript2["Test"] = "vitest --config vitest.config.ts";
@@ -26,7 +21,7 @@ export var NpmScript = /* @__PURE__ */ ((NpmScript2) => {
   NpmScript2["TestFeature"] = "playwright test --config playwright.config.ts";
   NpmScript2["TestUi"] = "vitest --config vitest.config.ts --ui";
   NpmScript2["TestCoverage"] = "vitest --config vitest.config.ts --coverage";
-  NpmScript2["TestTypes"] = "vue-tsc --noEmit";
+  NpmScript2["TestTypes"] = "vue-npx tsc --noEmit";
   NpmScript2["Generate"] = "generate";
   NpmScript2["GenerateTypes"] = "generate:types";
   NpmScript2["GenerateEntries"] = "generate:entries";
@@ -46,36 +41,48 @@ export var NpmScript = /* @__PURE__ */ ((NpmScript2) => {
   NpmScript2["Preinstall"] = "preinstall";
   NpmScript2["Prepublish"] = "prepublish";
   NpmScript2["Wip"] = "wip";
+  NpmScript2["UpgradeNode"] = "./.stacks/scripts/setup.sh +nodejs.org";
+  NpmScript2["UpgradePackageManager"] = "./.stacks/scripts/setup.sh +pnpm.io";
   return NpmScript2;
 })(NpmScript || {});
 export var Action = /* @__PURE__ */ ((Action2) => {
   Action2["Bump"] = "bump";
-  Action2["Release"] = "release";
-  Action2["Prepublish"] = "prepublish";
-  Action2["BuildStacks"] = "build-stacks";
+  Action2["BuildStacks"] = "build/stacks";
   Action2["BuildComponentLibs"] = "build-component-libs";
   Action2["BuildVueComponentLib"] = "build-vue-component-lib";
   Action2["BuildWebComponentLib"] = "build-web-component-lib";
   Action2["BuildCli"] = "build-cli";
-  Action2["BuildCore"] = "build-core";
+  Action2["BuildCore"] = "build/core";
   Action2["BuildDocs"] = "build-docs";
   Action2["BuildFunctionLib"] = "build-function-lib";
   Action2["Changelog"] = "changelog";
+  Action2["Clean"] = "clean";
+  Action2["DevComponents"] = "dev/components";
+  Action2["DevDocs"] = "dev/docs";
+  Action2["Deploy"] = "deploy";
   Action2["Fresh"] = "fresh";
   Action2["GeneratePackageJsons"] = "generate-package-jsons";
   Action2["GenerateSettings"] = "generate-settings";
   Action2["GenerateOnboarding"] = "generate-onboarding";
-  Action2["Lint"] = "lint";
-  Action2["LintFix"] = "lint-fix";
+  Action2["Inspire"] = "inspire";
+  Action2["KeyGenerate"] = "key-generate";
+  Action2["MakeNotification"] = "make-notification";
+  Action2["Migrate"] = "migrate";
+  Action2["Seed"] = "seed";
+  Action2["Lint"] = "lint/index";
+  Action2["LintFix"] = "lint/fix";
+  Action2["Prepublish"] = "prepublish";
+  Action2["Release"] = "release";
+  Action2["ShowFeatureTestReport"] = "show-feature-test-report";
   Action2["Test"] = "test";
   Action2["TestUi"] = "test-ui";
   Action2["TestUnit"] = "test-unit";
   Action2["TestFeature"] = "test-feature";
   Action2["TestCoverage"] = "test-coverage";
-  Action2["ShowFeatureTestReport"] = "show-feature-test-report";
+  Action2["Tinker"] = "tinker";
   Action2["Typecheck"] = "typecheck";
-  Action2["KeyGenerate"] = "key-generate";
-  Action2["MakeNotification"] = "make-notification";
-  Action2["DevComponents"] = "dev-components";
+  Action2["Upgrade"] = "upgrade/index";
+  Action2["UpgradeNode"] = "upgrade/node";
+  Action2["UpgradePackageManager"] = "upgrade/package-manager";
   return Action2;
 })(Action || {});

package/dist/components.d.ts

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

package/dist/cron-jobs.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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/dist/database.d.ts

@@ -1,2 +1,32 @@
-import type { PrismaClient } from '@prisma/client';
-export type DatabaseClient = PrismaClient;
+import type { Model } from './model';
+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>;
+    factory: (modelName: string, fileName: string, path: string) => Promise<void>;
+}

package/dist/deploy.d.ts

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

package/dist/dns.d.ts

@@ -0,0 +1,43 @@
+export interface ARecord {
+    name: string | '@' | '*';
+    address: string;
+    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;
+}
+export interface TxtRecord {
+    name: string | '@';
+    ttl: number | 'auto';
+    content: string;
+}
+export interface AAAARecord {
+    name: string | '@' | '*';
+    address: string;
+    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/dist/docs.d.ts

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

package/dist/events.d.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/dist/git.d.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/dist/index.d.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';