@stacksjs/types 0.52.10 → 0.56.3

package/dist/index.d.ts

@@ -1,39 +1,2111 @@
-export * from './app';
-export * from './auto-imports';
-export * from './build';
-export * from './cache';
-export * from './cdn';
-export * from './cli';
-export * from './components';
-export * from './cron-jobs';
-export * from './database';
-export * from './debug';
-export * from './deploy';
-export * from './dns';
-export * from './docs';
-export * from './errors';
-export * from './events';
-export * from './exit-code';
-export * from './fs';
-export * from './git';
-export * from './hashing';
-export * from './i18n';
-export * from './inspect';
-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';
+export { Options as AutoImportsOptions } from 'unplugin-auto-import/types';
+export { UserConfig as ViteConfig } from 'vite';
+import { ViteSSGContext } from 'vite-ssg';
+export { ViteSSGContext } from 'vite-ssg';
+import { Ora } from 'ora';
+export { Ora as SpinnerOptions } from 'ora';
+import { ExecaReturnValue } from 'execa';
+import { Ok, Err } from 'neverthrow';
+export { Err, Ok, Result, ResultAsync } from 'neverthrow';
+import { VineString, VineNumber, VineBoolean } from '@vinejs/vine';
+import { Settings, MeiliSearch, IndexOptions, EnqueuedTask, Index, IndexesResults, DocumentOptions, SearchParams, Hits, SearchResponse } from 'meilisearch';
+export { EnqueuedTask, Hits, Index, IndexOptions, IndexesResults, MeiliSearch, DocumentOptions as RecordOptions, Settings as SearchEngineSettings, SearchParams, SearchResponse } from 'meilisearch';
+import { UserConfig } from 'vitepress';
+import { Options } from 'vite-plugin-inspect';
+import { UserOptions } from 'vite-plugin-vue-layouts';
+import { Dinero } from '@stacksjs/utils';
+import { IEmailOptions } from '@novu/stateless';
+export { IChatOptions as ChatOptions, ISendMessageSuccessResponse as SendMessageSuccessResponse, ISmsOptions as SmsOptions } from '@novu/stateless';
+import { Options as Options$1 } from 'vite-plugin-pwa';
+export { Ref } from 'vue';
+import { UserShortcuts } from 'unocss';
+export { CAC as CLI } from 'cac';
+export { Options as ComponentOptions } from 'unplugin-vue-components';
+
+/**
+ * **Application Options**
+ *
+ * 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.
+ */
+interface AppOptions {
+    /**
+     * **Application Name**
+     *
+     * This value is the name of your application. This value is used when the
+     * framework needs to place the application's name in a log or any
+     * other location as required by the application or its packages.
+     *
+     * @default string "Stacks"
+     */
+    name: string;
+    /**
+     * **Application Environment**
+     *
+     * This value determines the "environment" your application is currently
+     * running in. This may determine how you prefer to configure various
+     * services the application utilizes. Set this in your ".env" file
+     *
+     * @default "local"
+     */
+    env: 'local' | 'development' | 'staging' | 'production';
+    /**
+     * **Application URL**
+     *
+     * This URL is used by the console to properly generate URLs when using
+     * 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://stacks.test"
+     * @example "https://my-project.test"
+     */
+    url: string;
+    /**
+     * **Application Debug Mode**
+     *
+     * When your application is in debug mode, detailed error messages with
+     * stack traces will be shown on every error that occurs within your
+     * application. If disabled, a simple generic error page is shown.
+     *
+     * @default true
+     */
+    debug: boolean;
+    /**
+     * **Application Port**
+     *
+     * This port is used when Stacks creates a server you. You should set
+     * a port that's not already in use by your machine. Stacks defaults
+     * to a memorable port that likely is free on your end: 3333.
+     *
+     * @default number 3333
+     */
+    port: number;
+    /**
+     * **Encryption Key**
+     *
+     * This key is used by the Stacks encrypter service and should be set to
+     * a random, 32 character string, otherwise these encrypted strings will
+     * not be safe. Please do this before deploying an application!
+     */
+    key?: string;
+    /**
+     * **Application Timezone**
+     *
+     * Here you may specify the default timezone for your application, which
+     * will be used by Stacks and date-time functions. We have gone ahead
+     * and set this to a sensible default for you out of the box.
+     *
+     * @default string "UTC"
+     */
+    timezone?: string;
+    /**
+     * **Application Locale Configuration**
+     *
+     * The application locale determines the default locale that will be used
+     * by the translation service provider. You are free to set this value
+     * to any of the locales which will be supported by the application.
+     *
+     * @default string "en"
+     * @example
+     * de // ./lang/de.yml needs to be present for this
+     */
+    locale?: string;
+    /**
+     * **Application Fallback Locale**
+     *
+     * The fallback locale determines the locale to use when the current one
+     * is not available. You may change the value to correspond to any of
+     * the language folders that are provided through your application.
+     *
+     * @default string "en"
+     */
+    fallbackLocale: 'en';
+    /**
+     * **Cipher**
+     *
+     * Description WIP.
+     *
+     * @default string "aes-256-cbc"
+     */
+    cipher: string;
+}
+
+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?: {};
+    };
+}
+
+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;
+}
+
+declare class ValidationError extends Error {
+    messages: any;
+    status: number;
+    code: string;
+    constructor(messages: any, options?: ErrorOptions);
+    get [Symbol.toStringTag](): string;
+    toString(): string;
+}
+type StacksError = Error | ValidationError;
+
+/**
+ * The parsed command-line arguments
+ */
+
+type CommandReturnValue = ExecaReturnValue<string>;
+type CommandResult = Ok<ExecaReturnValue<string>, Error | void> | Err<ExecaReturnValue<string>, Error | string | void>;
+interface OutroOptions extends CliOptions {
+    type?: 'success' | 'error' | 'warning' | 'info';
+    startTime?: number;
+    useSeconds?: boolean;
+    isError?: boolean;
+    quiet?: boolean;
+}
+interface IntroOptions {
+    /**
+     * @default true
+     */
+    showPerformance?: boolean;
+    /**
+     * @default false
+     */
+    quiet: boolean;
+}
+type SpinnerOptions = Ora;
+type CliOptionsKeys = keyof CliOptions;
+/**
+ * The CLI Options used in `./config/cli.ts`.
+ */
+interface UserCliOptions {
+    name?: string;
+    command?: string;
+    description?: string;
+}
+/**
+ * The options to pass to the CLI.
+ */
+interface CliOptions {
+    /**
+     * **Quiet Output**
+     *
+     * When your application is in "quiet"-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
+     */
+    quiet?: boolean;
+    /**
+     * **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;
+    /**
+     * **Current Work Directory**
+     *
+     * Based on the `cwd` value, that's where the command...
+     *
+     * @default projectPath()
+     */
+    cwd?: string;
+    /**
+     * **Should show loading animation spinner?**
+     *
+     * Should the command show a loading animation?
+     * Please note, when debug mode is enabled,
+     * the animation will not show.
+     *
+     * @default true
+     */
+    showSpinner?: boolean | SpinnerOptions;
+    /**
+     * **Spinner Text**
+     *
+     * The text to show when the spinner is shown.
+     *
+     * @default 'Executing...'
+     */
+    spinnerText?: string;
+    /**
+     * **Should the command be run inside a shell?**
+     *
+     * If `true`, runs `command` inside of a shell. Uses `/bin/sh` on UNIX and `cmd.exe`
+     * on Windows. A different shell can be specified as a string. The shell should
+     * understand the `-c` switch on UNIX or `/d /s /c` on Windows.
+     *
+     * We recommend against using this option since it is:
+     *  - not cross-platform, encouraging shell-specific syntax.
+     *  - slower, because of the additional shell interpretation.
+     *  - unsafe, potentially allowing command injection.
+     *
+     * @default false
+     */
+    shell?: boolean;
+    /**
+     * **Encoding**
+     *
+     * Encoding type
+     *
+     * @default 'utf-8'
+     */
+    encoding?: string;
+}
+
+type ActionOption = 'types';
+/**
+ * The options to pass to the Action.
+ */
+type ActionOptions = {
+    [key in ActionOption]?: boolean;
+} & CliOptions;
+type BuildOption = 'components' | 'vueComponents' | 'webComponents' | 'elements' | 'functions' | 'docs' | 'pages' | 'stacks' | 'all';
+type BuildOptions = {
+    [key in BuildOption]: boolean;
+} & CliOptions;
+type AddOption = 'table' | 'calendar' | 'all';
+type AddOptions = {
+    [key in AddOption]?: boolean;
+} & CliOptions;
+type CreateStringOption = 'name';
+type CreateBooleanOption = 'ui' | 'components' | 'web-components' | 'vue' | 'pages' | 'functions' | 'api' | 'database';
+type CreateOptions = {
+    [key in CreateBooleanOption]: boolean;
+} & {
+    [key in CreateStringOption]: string;
+} & CliOptions;
+type DevOption = 'components' | 'docs' | 'pages' | 'functions' | 'desktop' | 'all';
+type DevOptions = {
+    [key in DevOption]: boolean;
+} & CliOptions;
+type GeneratorOption = 'types' | 'entries' | 'webTypes' | 'customData' | 'ideHelpers' | 'vueCompatibility' | 'componentMeta';
+type GeneratorOptions = {
+    [key in GeneratorOption]?: boolean;
+} & CliOptions;
+type LintOption = 'fix';
+type LintOptions = {
+    [key in LintOption]: boolean;
+} & CliOptions;
+type MakeStringOption = 'name' | 'chat' | 'sms' | 'env';
+type MakeBooleanOption = 'component' | 'page' | 'function' | 'language' | 'database' | 'migration' | 'factory' | 'notification' | 'stack';
+type MakeOptions = {
+    [key in MakeBooleanOption]: boolean;
+} & {
+    [key in MakeStringOption]: string;
+} & CliOptions;
+type UpgradeBoolean = 'framework' | 'dependencies' | 'packageManager' | 'node' | 'all' | 'force';
+type UpgradeString = 'version';
+type UpgradeOptions = {
+    [key in UpgradeBoolean]: boolean;
+} & {
+    [key in UpgradeString]: string;
+} & CliOptions;
+type ExamplesString = 'version';
+type ExamplesBoolean = 'components' | 'vue' | 'webComponents' | 'elements' | 'all' | 'force';
+type ExamplesOption = ExamplesString & ExamplesBoolean | void;
+type ExamplesOptions = {
+    [key in ExamplesString]: string;
+} & {
+    [key in ExamplesBoolean]: boolean;
+} & CliOptions;
+type TestOptions = CliOptions & {
+    showReport?: boolean;
+};
+interface CleanOptions extends CliOptions {
+}
+interface CommitOptions extends CliOptions {
+}
+interface KeyOptions extends CliOptions {
+}
+interface FreshOptions extends CliOptions {
+}
+interface InspireOptions extends CliOptions {
+}
+interface ReleaseOptions extends CliOptions {
+}
+interface PreinstallOptions extends CliOptions {
+}
+interface PrepublishOptions extends CliOptions {
+}
+interface TinkerOptions extends CliOptions {
+}
+interface TypesOptions extends CliOptions {
+}
+type LibEntryType = 'vue-components' | 'web-components' | 'functions' | 'all';
+/**
+ * The available npm scripts within the Stacks toolkit.
+ */
+declare const enum NpmScript {
+    Build = "build",
+    BuildComponents = "vite build --config ./core/build/src/vue-components.ts",
+    BuildWebComponents = "build:web-components",
+    BuildFunctions = "build:functions",
+    BuildDocs = "build:docs",
+    BuildStacks = "build:stacks",
+    Clean = "rimraf pnpm-lock.yaml node_modules/ .stacks/**/node_modules .stacks/**/dist",
+    Dev = "dev",
+    DevComponents = "vite --config ./core/build/src/vue-components.ts",
+    DevDocs = "npx vitepress dev ./docs/src",
+    DevDesktop = "dev:desktop",
+    DevPages = "dev:pages",
+    DevFunctions = "dev:functions",
+    Fresh = "fresh",
+    Lint = "eslint .",
+    LintFix = "eslint . --fix",
+    LintPackageJson = "npx publint",
+    MakeStack = "make:stack",
+    Test = "vitest --config vitest.config.ts",
+    TestUnit = "vitest --config vitest.config.ts",
+    TestFeature = "playwright test --config playwright.config.ts",
+    TestUi = "vitest --config vitest.config.ts --ui",
+    TestCoverage = "vitest --config vitest.config.ts --coverage",
+    TestTypes = "vue-npx tsc --noEmit",
+    Generate = "generate",
+    GenerateTypes = "generate:types",
+    GenerateEntries = "generate:entries",
+    GenerateVueCompat = "generate:vue-compatibility",
+    GenerateWebTypes = "generate:web-types",
+    GenerateVsCodeCustomData = "generate:vscode-custom-data",
+    GenerateIdeHelpers = "generate:ide-helpers",
+    GenerateComponentMeta = "generate:component-meta",
+    Release = "release",
+    Commit = "commit",
+    Example = "example",
+    ExampleVue = "example:vue",
+    ExampleWebComponents = "example:web-components",
+    KeyGenerate = "key:generate",
+    TypesFix = "types:fix",
+    TypesGenerate = "types:generate",
+    Preinstall = "preinstall",
+    Prepublish = "prepublish",
+    Wip = "wip",
+    UpgradeNode = "./.stacks/scripts/setup.sh +nodejs.org",
+    UpgradeDependencies = "pnpm up"
+}
+declare const enum Action {
+    Bump = "bump",
+    BuildStacks = "build/stacks",
+    BuildComponentLibs = "build/component-libs",
+    BuildVueComponentLib = "build-vue-component-lib",
+    BuildWebComponentLib = "build-web-component-lib",
+    BuildCli = "build-cli",
+    BuildCore = "build/core",
+    BuildDocs = "build-docs",
+    BuildFunctionLib = "build-function-lib",
+    Changelog = "changelog",
+    Clean = "clean",
+    DevComponents = "dev/components",
+    Dev = "dev/index",
+    DevDocs = "dev/docs",
+    Deploy = "deploy",
+    Fresh = "fresh",
+    GenerateLibraryEntries = "generate/lib-entries",
+    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",
+    Tinker = "tinker",
+    Typecheck = "typecheck",
+    Upgrade = "upgrade/index",
+    UpgradeNode = "upgrade/node",
+    UpgradePackageManager = "upgrade/package-manager"
+}
+
+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.dev/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.dev/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.dev/docs/components
+     */
+    attributes?: {
+        name: string;
+        description: string;
+    }[];
+}
+type TagsOptions = TagOption[];
+
+/**
+ * Cron Job Options.
+ */
+interface JobOptions {
+    /**
+     * The name of the job.
+     */
+    name?: string;
+    action?: string | Function;
+    run?: string | Function;
+    schedule?: string;
+    description?: string;
+    enabled?: boolean;
+    timezone?: string;
+    active?: boolean;
+    tries?: number;
+    backoff?: number | number[];
+}
+type Job = JobOptions;
+type Jobs = Job[];
+interface CronJobOptions extends Omit<JobOptions, 'schedule'> {
+    schedule: string;
+}
+type CronJob = CronJobOptions;
+type CronJobs = CronJob[];
+declare enum Every {
+    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 * * * *"
+}
+
+interface AuthOptions {
+}
+interface SeedOptions {
+    count: number;
+}
+interface TimestampOptions {
+    createdAt?: string;
+    updatedAt?: string;
+    deletedAt?: string;
+}
+interface Base {
+}
+/**
+ * Model.
+ */
+interface Model extends Base {
+    name?: string;
+    table?: string;
+    fields: Fields;
+    hasOne?: string;
+    hasMany?: string;
+    belongsToMany?: string;
+    hasThrough?: {
+        model: string;
+        through: string;
+        using: string;
+    };
+    authenticatable?: boolean | AuthOptions;
+    seedable?: boolean | SeedOptions;
+    searchable?: boolean | Settings;
+    useSeed?: boolean | SeedOptions;
+    useSearch?: boolean | Settings;
+    useSearchEngine?: boolean | Settings;
+    useTimestamps?: boolean | TimestampOptions;
+}
+interface Fields {
+    [key: string]: {
+        default?: boolean;
+        unique?: boolean;
+        required?: boolean;
+        factory?: () => any;
+        validator?: {
+            rule: VineString | VineNumber | VineBoolean | Date | Nullable<any>;
+            message: string;
+        };
+    };
+}
+
+type DatabaseClient = any;
+interface DatabaseOptions {
+    default: string;
+    connections: {
+        mysql: {
+            url?: string;
+            host?: string;
+            port?: number;
+            client?: DatabaseClient;
+            name?: string;
+            username?: string;
+            password?: string;
+            prefix?: string;
+        };
+        sqlite: {
+            url?: string;
+            database?: string;
+            prefix?: string;
+        };
+        planetscale: {};
+        postgres: {};
+    };
+    migrations: string;
+}
+interface FactoryOptions {
+    name: string;
+    count?: number;
+    items: object;
+    columns: object;
+}
+interface SchemaOptions {
+    database: string;
+}
+interface DatabaseDriver {
+    client: DatabaseClient;
+    migrate: (models: Model[], path: string, options?: SchemaOptions) => Promise<void>;
+    factory: (modelName: string, fileName: string, path: string) => Promise<void>;
+}
+
+interface DebugOptions {
+    driver?: string;
+    enabled: boolean;
+    host: string;
+    port: number;
+}
+
+/**
+ * **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.
+ */
+interface DeployOptions {
+}
+
+interface ARecord {
+    name: string | '@' | '*';
+    address: string;
+    ttl?: number | 'auto';
+}
+interface CNameRecord {
+    name: string;
+    target: string;
+    ttl: number | 'auto';
+}
+interface MXRecord {
+    name: string | '@';
+    mailServer: string;
+    ttl: number | 'auto';
+    priority: number;
+}
+interface TxtRecord {
+    name: string | '@';
+    ttl: number | 'auto';
+    content: string;
+}
+interface AAAARecord {
+    name: string | '@' | '*';
+    address: string;
+    ttl: number | 'auto';
+}
+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
+   */
+interface DnsOptions {
+    a?: ARecord[];
+    aaaa?: AAAARecord[];
+    cname?: CNameRecord[];
+    mx?: MXRecord[];
+    txt?: TxtRecord[];
+}
+
+type DocsConfig = UserConfig;
+type DocsOptions = DocsConfig;
+
+/**
+ * **Events**
+ *
+ * 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.
+ *
+ * @example To fire an event, you may use any of the following approaches:
+ * ```ts
+ * dispatch('user:registered', { name: 'Chris', email: 'chris@stacksjs.dev' })
+ *
+ * // alternatively, you may use the following:
+ * useEvent('user:registered', { name: 'Chris', email: 'chris@stacksjs.dev' })
+ * events.emit('user:registered', { name: 'Chris', email: 'chris@stacksjs.dev' })
+ * useEvents.emit('user:registered', { name: 'Chris', email: 'chris@stacksjs.dev' })
+ * ````
+
+ * @example To capture an event, you may use any of the following approaches:
+ * ```ts
+ * listen('user:registered', (user) => sendWelcomeEmail(user))
+ *
+ * // alternatively, you may use the following:
+ * useListen('user:registered', (user) => sendWelcomeEmail(user))
+ * events.on('user:registered', (user) => sendWelcomeEmail(user))
+ * useEvents.on('user:registered', (user) => sendWelcomeEmail(user))
+ * ```
+ */
+interface Events {
+    [key: string]: (...args: any[]) => Function;
+}
+
+/**
+ * CLI exit codes.
+ *
+ * @see https://nodejs.org/api/process.html#process_exit_codes
+ */
+declare enum ExitCode {
+    Success = 0,
+    FatalError = 1,
+    InvalidArgument = 9
+}
+
+/**
+ * Describes a plain-text file.
+ */
+interface TextFile {
+    path: string;
+    data: string;
+}
+/**
+ * Describes a JSON file.
+ */
+interface JsonFile {
+    path: string;
+    data: unknown;
+    indent: string;
+    newline: string | undefined;
+}
+/**
+ * Describes a package.json file.
+ */
+interface PackageJson {
+    engines: {
+        node: string;
+        pnpm: string;
+    };
+    version: string;
+    packageManager: string;
+}
+
+/**
+ * **Git Options**
+ *
+ * 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.
+ */
+interface GitOptions {
+    /**
+     * **Git Hooks**
+     *
+     * The git hooks to use.
+     *
+     * @see https://git-scm.com/docs/githooks
+     * @example
+     * ```ts
+     * git: {
+     *   hooks: {
+     *    'pre-commit': 'lint-staged',
+     *   }
+     * }
+     * ```
+     */
+    hooks: GitHooks;
+    /**
+     * **Git Commit Scopes**
+     *
+     * The git commit scopes to use.
+     *
+     * @see https://stacksjs.dev/docs/git/scopes
+     * @example
+     * git: [
+     *   scopes: [
+     *     '', 'ci', 'deps', 'dx', 'release', 'readme', 'test', 'actions', 'build', 'cli',
+     *     'config', 'examples', 'functions', 'modules', 'views', 'router', 'scripts',
+     *     'ui', 'utils', 'arrays', 'collections', 'fs', 'objects', 'strings',
+     *   ]
+     * ]
+     */
+    scopes: string[];
+    /**
+     * **Git Commit Types**
+     *
+     * The git commit types to use.
+     *
+     * @default array
+     * @see https://stacksjs.dev/docs/git/types
+     * @see https://www.conventionalcommits.org/en/v1.0.0/
+     * @example
+     * ```ts
+     * git: [
+     *   types: [
+     *     'build', 'chore', 'ci', 'docs', 'feat', 'fix', 'perf', 'refactor', 'revert', 'style', 'test',
+     *    ]
+     * ]
+     * ```
+     */
+    types: {
+        value: string;
+        name: string;
+        emoji: string;
+    }[];
+    /**
+     * **Messages—Options**
+     *
+     * The git messages/prompts to use.
+     *
+     * @default object
+     * @example
+     * ```ts
+     * messages: {
+     *   type: 'Select the type of change that you\'re committing:',
+     *   scope: 'Denote the SCOPE of this change:',
+     *   subject: 'Write a SHORT, IMPERATIVE tense description of the change:\n',
+     *   body: 'Provide a LONGER description of the change (optional). Use "|" to break new line:\n',
+     *   breaking: 'List any BREAKING CHANGES (optional):\n',
+     *   footer: 'List any ISSUES CLOSED by this change (optional). E.g.: #31, #34:\n',
+     *   confirmCommit: 'Are you sure you want to proceed with the commit above?',
+     * }
+     * ```
+     * @see https://stacksjs.dev/docs/git/messages
+     */
+    messages: {
+        type: string;
+        scope: string;
+        customScope: string;
+        subject: string;
+        body: string;
+        breaking: string;
+        footerPrefixesSelect: string;
+        customFooterPrefixes: string;
+        footer: string;
+        confirmCommit: string;
+    };
+}
+interface Hooks {
+    'applypatch-msg'?: string;
+    'pre-applypatch'?: string;
+    'post-applypatch'?: string;
+    'pre-commit'?: string;
+    'pre-merge-commit'?: string;
+    'prepare-commit-msg'?: string;
+    'commit-msg'?: string;
+    'post-commit'?: string;
+    'pre-rebase'?: string;
+    'post-checkout'?: string;
+    'post-merge'?: string;
+    'pre-push'?: string;
+    'pre-receive'?: string;
+    'update'?: string;
+    'proc-receive'?: string;
+    'post-receive'?: string;
+    'post-update'?: string;
+    'reference-transaction'?: string;
+    'push-to-checkout'?: string;
+    'pre-auto-gc'?: string;
+    'post-rewrite'?: string;
+    'sendemail-validate'?: string;
+    'fsmonitor-watchman'?: string;
+    'p4-changelist'?: string;
+    'p4-prepare-changelist'?: string;
+    'p4-post-changelist'?: string;
+    'p4-pre-submit'?: string;
+    'post-index-change'?: string;
+}
+interface GitHooks extends Hooks {
+}
+
+/**
+ * The Stacks runtime provides secure Bcrypt & Argon2 hashing for storing user passwords.
+ * If you are using one of the Laravel application starter kits, Bcrypt will be used for
+ * registration and authentication by default.
+ *
+ * Bcrypt is a great choice for hashing passwords because its "work factor" is adjustable, which
+ * means that the time it takes to generate a hash can be increased as hardware power increases.
+ * When hashing passwords, slow is good. The longer an algorithm takes to hash a password, the
+ * longer it takes malicious users to generate "rainbow tables" of all possible string hash
+ * values that may be used in brute force attacks against applications.
+ *
+ * @see https://stacksjs.dev/docs/hashing
+ */
+interface HashingOptions {
+    /**
+     * **Hashing Driver**
+     *
+     * This option controls the default hash driver that will be used to hash
+     * passwords for your application. By default, the bcrypt algorithm is
+     * used; however, you remain free to modify this option if you wish.
+     *
+     * @see https://stacksjs.dev/docs/hashing
+     */
+    driver: 'argon' | 'bcrypt';
+    /**
+     * **Bcrypt Option**
+     *
+     * Here you may specify the configuration options that should be used when
+     * passwords are hashed using the Bcrypt algorithm. This will allow you
+     * to control the amount of time it takes to hash the given password.
+     *
+     * @see https://stacksjs.dev/docs/hashing
+     */
+    bcrypt?: BcryptOptions;
+    /**
+     * **Argon Options**
+     *
+     * Here you may specify the configuration options that should be used when
+     * passwords are hashed using the Argon algorithm. These will allow you
+     * to control the amount of time it takes to hash the given password.
+     *
+     * @see https://stacksjs.dev/docs/hashing
+     */
+    argon?: ArgonOptions;
+}
+/**
+ * **Bcrypt Options**
+ *
+ * Here you may specify the configuration options that should be used when
+ * passwords are hashed using the Bcrypt algorithm. This will allow you
+ * to control the amount of time it takes to hash the given password.
+ *
+ * @see https://stacksjs.dev/docs/hashing
+ */
+interface BcryptOptions {
+    /**
+     * Bcrypt salt rounds.
+     *
+     * @default number 10
+     * @see https://stacksjs.dev/docs/hashing
+     */
+    rounds?: number;
+}
+/**
+ * **Argon Options**
+ *
+ * Here you may specify the configuration options that should be used when
+ * passwords are hashed using the Argon algorithm. These will allow you
+ * to control the amount of time it takes to hash the given password.
+ *
+ * @see https://stacksjs.dev/docs/hashing
+ */
+interface ArgonOptions {
+    /**
+     * **Argon Memory**
+     *
+     * Amount of memory (in kibibytes) to use.
+     *
+     * @default number 65536
+     * @see https://stacksjs.dev/docs/hashing
+     */
+    memory?: number;
+    /**
+     * **Argon Parallelism**
+     *
+     * Degree of parallelism (i.e. number of threads).
+     *
+     * @default number 1
+     * @see https://stacksjs.dev/docs/hashing
+     */
+    threads?: number;
+    /**
+     * **Argon time**
+     *
+     * Execution time.
+     *
+     * @default number 1
+     * @see https://stacksjs.dev/docs/hashing
+     */
+    time?: number;
+}
+type HashAlgorithm = 'md4' | 'md5' | 'sha1' | 'sha256' | 'sha384' | 'sha512' | 'ripemd128' | 'ripemd160' | 'tiger128' | 'tiger160' | 'tiger192' | 'crc32' | 'crc32b';
+
+interface VitePluginVueI18nOptions {
+    forceStringify?: boolean;
+    runtimeOnly?: boolean;
+    compositionOnly?: boolean;
+    fullInstall?: boolean;
+    include?: string | string[];
+    defaultSFCLang?: 'json' | 'json5' | 'yml' | 'yaml';
+    globalSFCScope?: boolean;
+    useVueI18nImportName?: boolean;
+}
+/**
+ * **Internationalization Options**
+ *
+ * The i18n option.
+ *
+ * @see https://github.com/intlify/bundle-tools/blob/main/packages/vite-plugin-vue-i18n/src/options.ts
+ */
+type i18nOptions = VitePluginVueI18nOptions;
+
+/**
+ * **Inspect Options**
+ *
+ * The inspect options.
+ *
+ * @see https://github.com/intlify/bundle-tools/blob/main/packages/vite-plugin-vue-i18n/src/options.ts
+ */
+type InspectOptions = Options;
+
+/**
+ * **Layout Options**
+ *
+ * The layout options.
+ */
+type LayoutOptions = UserOptions;
+
+/**
+ * **Library Options**
+ *
+ * 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.
+ */
+interface LibraryOptions {
+    /**
+     * The base name of your library/libraries.
+     */
+    name: string;
+    /**
+     * The name of your organization (parent).
+     */
+    parentName: string | null;
+    /**
+     * The package registry to use.
+     */
+    packageRegistry: 'npm';
+    /**
+     * The path of your repository.
+     *
+     * @example
+     * "your-org/your-repo"
+     */
+    repository: string;
+    /**
+     * The list of accepted SPDX licenses.
+     * When developing OS packages, you may want to utilize an OSI approved license.
+     *
+     * @example
+     * "MIT"
+     * @see https://opensource.org/licenses
+     */
+    license: LicenseType;
+    /**
+     * The author's name of the library.
+     */
+    author: string;
+    /**
+     * A list of all the contributors.
+     */
+    contributors: string[];
+    /**
+     * The default language used within your stack.
+     */
+    defaultLanguage: LanguageCode;
+    /**
+     * The Vue component library options.
+     */
+    vueComponents: LibraryBuildOptions;
+    /**
+     * The Web Component library options.
+     */
+    webComponents: LibraryBuildOptions;
+    /**
+     * The Web Component library options.
+     */
+    functions: LibraryBuildOptions;
+}
+/**
+ * The list of available options to build your library.
+ */
+interface LibraryBuildOptions {
+    /**
+     * The name of your library as published to npm.
+     */
+    name: string;
+    /**
+     * The description of your library as published to npm.
+     */
+    description: string;
+    /**
+     * The keywords of your library as published to npm.
+     */
+    keywords: string[];
+    /**
+     * Should your library generate a sourcemap?
+     * @default false
+     */
+    shouldGenerateSourcemap?: boolean;
+    /**
+     * This is where you define the functions/composables that need to be included
+     * in your library. For example, including your `counter` function to be
+     * built would require `../functions/counter.ts` to be present.
+     */
+    functions?: string[];
+    /**
+     * This is where you define the components that need to be included in
+     * your library. For example, including your `HelloWorld` to be built
+     * would require `../components/HelloWorld.vue` to be present.
+     *
+     * @example
+     * {
+     *   tags: [{
+     *     name: 'HelloWorld' // export { default as HelloWorld } from './components/HelloWorld.vue'
+     *   }]
+     * }
+     *
+     * @example
+     * {
+     *   tags: [{
+     *     name: ['HelloWorld', 'AppHelloWorld'] // export { default as AppHelloWorld } from './components/HelloWorld.vue'
+     *   }]
+     * }
+     */
+    tags?: TagsOptions;
+}
+/**
+ * The name of your "Stack" which generally is your library name
+ * or a concatenation of your organization & library name.
+ */
+type StackName = string;
+/**
+ * The list of accepted SPDX licenses.
+ * When developing OS packages, you may want to utilize an OSI approved license.
+ * @see https://opensource.org/licenses
+ */
+type LicenseType = 'CC-BY-NC-ND-2.0' | 'SGI-B-2.0' | 'LPPL-1.3c' | 'NIST-PD-fallback' | 'libtiff' | 'XSkat' | 'PDDL-1.0' | 'KiCad-libraries-exception' | 'CC-BY-NC-SA-1.0' | 'GFDL-1.1-no-invariants-only' | 'Xerox' | 'LPPL-1.1' | 'VOSTROM' | 'UCL-1.0' | 'ADSL' | 'OSL-2.0' | 'AAL' | 'FDK-AAC' | 'W3C-20150513' | 'AFL-1.1' | 'W3C' | 'Sleepycat' | 'CECILL-1.1' | 'mpich2' | 'SISSL' | 'NLOD-1.0' | 'ANTLR-PD' | 'GPL-3.0-only' | 'gnuplot' | 'NLOD-2.0' | 'BSD-3-Clause-Open-MPI' | 'LiLiQ-P-1.1' | 'BSD-3-Clause-Clear' | 'FSFUL' | 'CC-BY-NC-SA-2.0-UK' | 'CERN-OHL-S-2.0' | 'Spencer-94' | 'CERN-OHL-1.2' | 'GFDL-1.1-or-later' | 'AGPL-1.0-or-later' | 'Wsuipa' | 'AML' | 'BSD-2-Clause' | 'DSDP' | 'CC-BY-2.5' | 'MIT-CMU' | 'Beerware' | 'Sendmail' | 'TU-Berlin-1.0' | 'CNRI-Jython' | 'mplus' | 'CPOL-1.02' | 'BSD-3-Clause-No-Nuclear-License-2014' | 'ISC' | 'CC-BY-SA-4.0' | 'Eurosym' | 'LGPL-3.0-only' | 'OLDAP-1.3' | 'GFDL-1.1-invariants-or-later' | 'Glulxe' | 'SimPL-2.0' | 'CDLA-Permissive-2.0' | 'GPL-2.0-with-font-exception' | 'OGL-UK-2.0' | 'CC-BY-SA-3.0-DE' | 'CC-BY-ND-1.0' | 'GFDL-1.1' | 'CC-BY-4.0' | 'OpenSSL' | 'TU-Berlin-2.0' | 'DOC' | 'GFDL-1.2-no-invariants-or-later' | 'QPL-1.0' | 'OLDAP-2.8' | 'OML' | 'OLDAP-2.7' | 'NIST-PD' | 'Bitstream-Vera' | 'GFDL-1.2-or-later' | 'OFL-1.1-RFN' | 'Bahyph' | 'Barr' | 'COIL-1.0' | 'GFDL-1.3' | 'CECILL-B' | 'JPNIC' | 'Zed' | 'ICU' | 'CC-BY-NC-SA-2.5' | 'CC-BY-ND-3.0-DE' | 'bzip2-1.0.5' | 'SPL-1.0' | 'YPL-1.0' | 'OSET-PL-2.1' | 'Noweb' | 'RPSL-1.0' | 'BSD-3-Clause-LBNL' | 'CDLA-Sharing-1.0' | 'CECILL-1.0' | 'AMPAS' | 'APAFML' | 'CC-BY-ND-3.0' | 'D-FSL-1.0' | 'CC-BY-NC-3.0' | 'libpng-2.0' | 'PolyForm-Noncommercial-1.0.0' | 'dvipdfm' | 'GFDL-1.3-or-later' | 'OGTSL' | 'NPL-1.1' | 'GPL-3.0' | 'CERN-OHL-P-2.0' | 'BlueOak-1.0.0' | 'AGPL-3.0-or-later' | 'blessing' | 'ImageMagick' | 'APSL-2.0' | 'MIT-advertising' | 'curl' | 'CC0-1.0' | 'Zimbra-1.4' | 'SSPL-1.0' | 'psutils' | 'CC-BY-SA-2.0-UK' | 'PSF-2.0' | 'Net-SNMP' | 'NAIST-2003' | 'GFDL-1.2-invariants-or-later' | 'SGI-B-1.0' | 'NBPL-1.0' | 'GFDL-1.2-invariants-only' | 'W3C-19980720' | 'OFL-1.0-no-RFN' | 'NetCDF' | 'TMate' | 'NOSL' | 'CNRI-Python-GPL-Compatible' | 'BSD-1-Clause' | 'CC-BY-NC-SA-3.0-DE' | 'BSD-3-Clause-Modification' | 'GLWTPL' | 'GFDL-1.3-only' | 'OLDAP-2.2' | 'CC-BY-ND-4.0' | 'CC-BY-NC-ND-3.0-DE' | 'EUPL-1.0' | 'Linux-OpenIB' | 'LGPL-2.0-or-later' | 'OSL-1.1' | 'Spencer-86' | 'LGPL-2.0' | 'CC-PDDC' | 'CC-BY-NC-ND-3.0' | 'CDL-1.0' | 'Elastic-2.0' | 'CC-BY-2.0' | 'BSD-3-Clause-No-Military-License' | 'IJG' | 'LPPL-1.3a' | 'SAX-PD' | 'BitTorrent-1.0' | 'OLDAP-2.0' | 'Giftware' | 'C-UDA-1.0' | 'LGPL-2.0+' | 'Rdisc' | 'GPL-2.0-with-classpath-exception' | 'CC-BY-3.0-US' | 'CDDL-1.0' | 'Xnet' | 'CPL-1.0' | 'LGPL-3.0-or-later' | 'NASA-1.3' | 'BUSL-1.1' | 'etalab-2.0' | 'MIT-open-group' | 'OLDAP-1.4' | 'GFDL-1.1-invariants-only' | 'RPL-1.1' | 'CC-BY-NC-ND-2.5' | 'FSFULLR' | 'Saxpath' | 'NTP-0' | 'SISSL-1.2' | 'GPL-3.0-or-later' | 'Apache-1.1' | 'CC-BY-SA-2.1-JP' | 'AGPL-3.0-only' | 'GPL-2.0-with-autoconf-exception' | 'Artistic-2.0' | 'App-s2p' | 'Unicode-DFS-2015' | 'diffmark' | 'SNIA' | 'CC-BY-SA-2.5' | 'Linux-man-pages-copyleft' | 'HPND-sell-variant' | 'ZPL-2.1' | 'BSD-4-Clause-UC' | 'LAL-1.2' | 'AGPL-1.0-only' | 'MIT-enna' | 'Condor-1.1' | 'Naumen' | 'GFDL-1.3-no-invariants-or-later' | 'RPL-1.5' | 'PolyForm-Small-Business-1.0.0' | 'EFL-1.0' | 'MirOS' | 'CC-BY-2.5-AU' | 'Afmparse' | 'MPL-2.0-no-copyleft-exception' | 'LiLiQ-Rplus-1.1' | 'AFL-1.2' | 'OSL-1.0' | 'GPL-1.0-only' | 'APSL-1.0' | 'OGL-Canada-2.0' | 'CPAL-1.0' | 'Latex2e' | 'Zend-2.0' | 'Unlicense' | 'xpp' | 'CC-BY-NC-1.0' | 'GPL-3.0-with-autoconf-exception' | 'CC-BY-NC-SA-3.0' | 'TCP-wrappers' | 'SCEA' | 'SSH-short' | 'CC-BY-3.0-NL' | 'SchemeReport' | 'CC-BY-3.0' | 'MPL-2.0' | 'Unicode-TOU' | 'CC-BY-NC-ND-1.0' | 'Entessa' | 'BSD-3-Clause-No-Nuclear-License' | 'SWL' | 'GFDL-1.2-no-invariants-only' | 'Parity-7.0.0' | 'OLDAP-2.2.1' | 'SGI-B-1.1' | 'FTL' | 'OLDAP-2.4' | 'CC-BY-NC-4.0' | 'bzip2-1.0.6' | 'copyleft-next-0.3.0' | 'MakeIndex' | 'NRL' | 'GFDL-1.3-invariants-or-later' | 'CC-BY-NC-2.0' | 'SugarCRM-1.1.3' | 'AFL-2.1' | 'GPL-2.0-only' | 'GFDL-1.3-invariants-only' | 'TORQUE-1.1' | 'Ruby' | 'X11' | 'Borceux' | 'Libpng' | 'X11-distribute-modifications-variant' | 'Frameworx-1.0' | 'NCGL-UK-2.0' | 'CECILL-2.1' | 'CC-BY-3.0-AT' | 'CNRI-Python' | 'NCSA' | 'gSOAP-1.3b' | 'EUPL-1.1' | 'AMDPLPA' | 'Imlib2' | 'CDDL-1.1' | 'WTFPL' | 'LPL-1.0' | 'EPL-1.0' | 'BSD-3-Clause-Attribution' | 'OSL-3.0' | 'RHeCos-1.1' | 'PHP-3.0' | 'BSD-Protection' | 'CC-BY-NC-3.0-DE' | 'APL-1.0' | 'EUDatagrid' | 'GPL-1.0' | 'SHL-0.5' | 'CC-BY-SA-2.0' | 'CC-BY-SA-3.0-AT' | 'CC-BY-NC-SA-3.0-IGO' | 'Adobe-2006' | 'Newsletr' | 'Nunit' | 'Multics' | 'OGL-UK-1.0' | 'Vim' | 'eCos-2.0' | 'Zimbra-1.3' | 'eGenix' | 'IBM-pibs' | 'BitTorrent-1.1' | 'OFL-1.1-no-RFN' | 'psfrag' | 'CC-BY-ND-2.0' | 'SHL-0.51' | 'FreeBSD-DOC' | 'Python-2.0' | 'Mup' | 'BSD-4-Clause-Shortened' | 'CC-BY-NC-SA-4.0' | 'HPND' | 'OLDAP-2.6' | 'MPL-1.1' | 'GPL-2.0-with-GCC-exception' | 'HaskellReport' | 'ECL-1.0' | 'LGPL-2.1-or-later' | 'OFL-1.0' | 'APSL-1.1' | 'MITNFA' | 'CECILL-2.0' | 'Crossword' | 'Aladdin' | 'Baekmuk' | 'XFree86-1.1' | 'GPL-1.0-or-later' | 'CERN-OHL-W-2.0' | 'CC-BY-SA-1.0' | 'NTP' | 'PHP-3.01' | 'OCLC-2.0' | 'CC-BY-3.0-DE' | 'CC-BY-NC-2.5' | 'Zlib' | 'CATOSL-1.1' | 'LGPL-3.0+' | 'CAL-1.0' | 'NPL-1.0' | 'SMLNJ' | 'GPL-2.0+' | 'OLDAP-2.5' | 'JasPer-2.0' | 'GPL-2.0-or-later' | 'BSD-2-Clause-Patent' | 'MS-RL' | 'CUA-OPL-1.0' | 'IPA' | 'NLPL' | 'O-UDA-1.0' | 'MIT-Modern-Variant' | 'OLDAP-1.2' | 'BSD-2-Clause-FreeBSD' | 'Info-ZIP' | 'CC-BY-NC-SA-2.0-FR' | '0BSD' | 'Unicode-DFS-2016' | 'OFL-1.0-RFN' | 'Intel' | 'AFL-2.0' | 'GL2PS' | 'TAPR-OHL-1.0' | 'Apache-1.0' | 'MTLL' | 'Motosoto' | 'RSA-MD' | 'Community-Spec-1.0' | 'ODC-By-1.0' | 'zlib-acknowledgement' | 'DL-DE-BY-2.0' | 'VSL-1.0' | 'LiLiQ-R-1.1' | 'OPL-1.0' | 'GPL-3.0+' | 'MulanPSL-2.0' | 'APSL-1.2' | 'OGDL-Taiwan-1.0' | 'RSCPL' | 'OGC-1.0' | 'EFL-2.0' | 'CAL-1.0-Combined-Work-Exception' | 'MS-PL' | 'Plexus' | 'Sendmail-8.23' | 'Cube' | 'JSON' | 'EUPL-1.2' | 'Adobe-Glyph' | 'FreeImage' | 'Watcom-1.0' | 'Jam' | 'Hippocratic-2.1' | 'OLDAP-2.0.1' | 'CC-BY-NC-SA-2.0' | 'Nokia' | 'OCCT-PL' | 'ErlPL-1.1' | 'TOSL' | 'OSL-2.1' | 'ClArtistic' | 'xinetd' | 'GPL-3.0-with-GCC-exception' | 'ODbL-1.0' | 'MIT' | 'LGPL-2.1+' | 'LGPL-2.1-only' | 'CrystalStacker' | 'ECL-2.0' | 'LPPL-1.0' | 'iMatix' | 'CC-BY-NC-ND-3.0-IGO' | 'BSD-Source-Code' | 'Parity-6.0.0' | 'TCL' | 'Arphic-1999' | 'CC-BY-SA-3.0' | 'Caldera' | 'AGPL-1.0' | 'IPL-1.0' | 'LAL-1.3' | 'EPICS' | 'NGPL' | 'DRL-1.0' | 'BSD-2-Clause-NetBSD' | 'ZPL-1.1' | 'GD' | 'LPPL-1.2' | 'Dotseqn' | 'Spencer-99' | 'OLDAP-2.3' | 'YPL-1.1' | 'Fair' | 'Qhull' | 'GFDL-1.1-no-invariants-or-later' | 'CECILL-C' | 'MulanPSL-1.0' | 'OLDAP-1.1' | 'OLDAP-2.1' | 'LPL-1.02' | 'UPL-1.0' | 'Abstyles' | 'ZPL-2.0' | 'MIT-0' | 'LGPL-2.0-only' | 'GFDL-1.3-no-invariants-only' | 'AGPL-3.0' | 'EPL-2.0' | 'AFL-3.0' | 'CDLA-Permissive-1.0' | 'Artistic-1.0' | 'CC-BY-NC-ND-4.0' | 'HTMLTIDY' | 'Glide' | 'FSFAP' | 'LGPLLR' | 'OGL-UK-3.0' | 'GFDL-1.2' | 'SSH-OpenSSH' | 'GFDL-1.1-only' | 'MIT-feh' | 'MPL-1.0' | 'PostgreSQL' | 'OLDAP-2.2.2' | 'SMPPL' | 'OFL-1.1' | 'Leptonica' | 'CERN-OHL-1.1' | 'BSD-3-Clause-No-Nuclear-Warranty' | 'CC-BY-ND-2.5' | 'CC-BY-1.0' | 'GFDL-1.2-only' | 'OPUBL-1.0' | 'libselinux-1.0' | 'BSD-3-Clause' | 'ANTLR-PD-fallback' | 'copyleft-next-0.3.1' | 'GPL-1.0+' | 'wxWindows' | 'LGPL-3.0' | 'LGPL-2.1' | 'StandardML-NJ' | 'BSD-4-Clause' | 'GPL-2.0-with-bison-exception' | 'Apache-2.0' | 'Artistic-1.0-cl8' | 'GPL-2.0' | 'Intel-ACPI' | 'BSL-1.0' | 'Artistic-1.0-Perl' | 'BSD-2-Clause-Views' | 'Interbase-1.0' | 'NPOSL-3.0';
+/**
+ * The list of accepted language codes.
+ * @see https://meta.wikimedia.org/wiki/Template:List_of_language_names_ordered_by_code
+ */
+type LanguageCode = 'aa' | 'ab' | 'af' | 'ak' | 'als' | 'am' | 'an' | 'ang' | 'ang' | 'ar' | 'arc' | 'as' | 'ast' | 'av' | 'awa' | 'ay' | 'az' | 'ba' | 'bar' | 'bat-smg' | 'bcl' | 'be' | 'be-x-old' | 'bg' | 'bh' | 'bi' | 'bm' | 'bn' | 'bo' | 'bpy' | 'br' | 'brx' | 'bs' | 'bug' | 'bxr' | 'ca' | 'cdo' | 'ce' | 'ceb' | 'ch' | 'cho' | 'chr' | 'chy' | 'ckb' | 'co' | 'cr' | 'cs' | 'csb' | 'cu' | 'cv' | 'cy' | 'da' | 'de' | 'diq' | 'dsb' | 'dv' | 'dz' | 'ee' | 'el' | 'en' | 'eo' | 'es' | 'et' | 'eu' | 'ext' | 'fa' | 'ff' | 'fi' | 'fiu-vro' | 'fj' | 'fo' | 'fr' | 'frp' | 'fur' | 'fy' | 'ga' | 'gan' | 'gbm' | 'gd' | 'gil' | 'gl' | 'gn' | 'got' | 'gu' | 'gv' | 'ha' | 'hak' | 'haw' | 'he' | 'hi' | 'ho' | 'hr' | 'ht' | 'hu' | 'hy' | 'hz' | 'ia' | 'id' | 'ie' | 'ig' | 'ii' | 'ik' | 'ilo' | 'inh' | 'io' | 'is' | 'it' | 'iu' | 'ja' | 'jbo' | 'jv' | 'ka' | 'kg' | 'ki' | 'kj' | 'kk' | 'kl' | 'km' | 'kn' | 'khw' | 'ko' | 'kr' | 'ks' | 'ksh' | 'ku' | 'kv' | 'kw' | 'ky' | 'la' | 'lad' | 'lan' | 'lb' | 'lg' | 'li' | 'lij' | 'lmo' | 'ln' | 'lo' | 'lzz' | 'lt' | 'lv' | 'map-bms' | 'mg' | 'man' | 'mh' | 'mi' | 'min' | 'mk' | 'ml' | 'mn' | 'mo' | 'mr' | 'mrh' | 'ms' | 'mt' | 'mus' | 'mwl' | 'my' | 'na' | 'nah' | 'nap' | 'nd' | 'nds' | 'nds-nl' | 'ne' | 'new' | 'ng' | 'nl' | 'nn' | 'no' | 'nr' | 'nso' | 'nrm' | 'nv' | 'ny' | 'oc' | 'oj' | 'om' | 'or' | 'os' | 'pa' | 'pag' | 'pam' | 'pap' | 'pdc' | 'pi' | 'pih' | 'pl' | 'pms' | 'ps' | 'pt' | 'qu' | 'rm' | 'rmy' | 'rn' | 'ro' | 'roa-rup' | 'ru' | 'rw' | 'sa' | 'sc' | 'scn' | 'sco' | 'sd' | 'se' | 'sg' | 'sh' | 'si' | 'sk' | 'sl' | 'sm' | 'sn' | 'so' | 'sq' | 'sr' | 'ss' | 'st' | 'su' | 'sv' | 'sw' | 'ta' | 'te' | 'tet' | 'tg' | 'th' | 'ti' | 'tk' | 'tl' | 'tlh' | 'tn' | 'to' | 'tpi' | 'tr' | 'ts' | 'tt' | 'tum' | 'tw' | 'ty' | 'udm' | 'ug' | 'uk' | 'ur' | 'uz' | 'uz_AF' | 've' | 'vi' | 'vec' | 'vls' | 'vo' | 'wa' | 'war' | 'wo' | 'xal' | 'xh' | 'xmf' | 'yi' | 'yo' | 'za' | 'zh' | 'zh-classical' | 'zh-min-nan' | 'zh-yue' | 'zu';
+
+/**
+ * The npm package manifest (package.json)
+ */
+interface Manifest {
+    name: string;
+    version: string;
+    description: string;
+    [key: string]: unknown;
+}
+
+type Money = Dinero<number>;
+
+interface NotificationOptions {
+    default: 'email' | 'sms' | 'chat' | string;
+    email: {
+        default: 'emailjs' | 'mailgun' | 'mailjet' | 'mandrill' | 'netcore' | 'nodemailer' | 'postmark' | 'sendgrid' | 'ses' | string;
+        from: {
+            name: string;
+            address: string;
+        };
+        drivers: {
+            smtp: {
+                host: string;
+                port: number;
+                secure: boolean;
+                auth: {
+                    user: string;
+                    pass: string;
+                };
+            };
+            sendgrid: {
+                key: string;
+                senderName: string;
+            };
+            emailjs: {
+                host: string;
+                user: string;
+                password: string;
+                port: number;
+                secure: boolean;
+            };
+            mailgun: {
+                key: string;
+                domain: string;
+                username: string;
+            };
+            mailjet: {
+                key: string;
+                secret: string;
+            };
+            mandrill: {
+                key: string;
+            };
+            netcore: {
+                key: string;
+            };
+            nodemailer: {
+                host: string;
+                user: string;
+                password: string;
+                port: number;
+                secure: boolean;
+            };
+            postmark: {
+                key: string;
+            };
+            ses: {
+                region: string;
+                key: string;
+                secret: string;
+            };
+        };
+    };
+    sms: {
+        default: 'twilio' | 'nexmo' | 'gupshup' | 'plivo' | 'sms77' | 'sns' | 'telnyx' | 'termii' | string;
+        from: string;
+        drivers: {
+            twilio: {
+                sid: string;
+                authToken: string;
+            };
+            nexmo: {
+                key: string;
+                secret: string;
+            };
+            gupshup: {
+                user: string;
+                password: string;
+            };
+            plivo: {
+                sid: string;
+                authToken: string;
+            };
+            sms77: {
+                key: string;
+            };
+            sns: {
+                region: string;
+                key: string;
+                secret: string;
+            };
+            telnyx: {
+                key: string;
+                messageProfileId: string;
+            };
+            termii: {
+                key: string;
+            };
+        };
+    };
+    chat: {
+        default: 'slack' | 'msTeams' | 'discord' | string;
+        from: string;
+        drivers: {
+            slack?: {
+                appId: string;
+                clientId: string;
+                secret: string;
+            };
+            msTeams?: {
+                appId: string;
+                clientId: string;
+                secret: string;
+            };
+            discord?: {};
+        };
+    };
+}
+interface FCMPushNotificationOptions {
+    eventName: string;
+    to: {
+        subscriberId: string;
+    };
+    payload: {
+        deviceTokens: Array<string>;
+        badge: boolean;
+        clickAction: string;
+        color: string;
+        icon: string;
+        sound: string;
+    };
+}
+interface ExpoPushNotificationOptions {
+    eventName: string;
+    to: {
+        subscriberId: string;
+    };
+    payload: {
+        to: string[];
+        data: Object;
+        title: string;
+        body: string;
+        ttl: number;
+        expiration: number;
+        priority: 'default' | 'normal' | 'high';
+        subtitle: string;
+        sound: 'default' | null;
+        badge: number;
+        channelId: string;
+        categoryId: string;
+        mutableContent: boolean;
+    };
+}
+
+type EmailOptions = Omit<IEmailOptions, 'from'> & {
+    from: {
+        name?: string;
+        address?: string;
+    };
+    domain?: string;
+    mailboxes?: {
+        [key: string]: string;
+    };
+};
+
+interface PagesOption {
+    onboarding: {
+        path: string;
+        pages: string[];
+    };
+    settings: {
+        path: string;
+        pages: string[];
+    };
+}
+
+interface PaymentOptions {
+    driver: 'stripe';
+}
+interface ChargeOptions {
+    currency?: string;
+    source?: string;
+    description?: string;
+    chargeId?: string;
+    limit?: number;
+    metadata?: object;
+    searchOptions: {
+        query?: string;
+        limit?: number;
+    };
+}
+interface CustomerOptions {
+    description?: string;
+    address?: string;
+    email?: string;
+    metadata?: object;
+    name?: string;
+    payment_method?: string;
+    shipping: string;
+    listOptions?: {
+        created?: object;
+        ending_before?: string;
+        limit?: number;
+        starting_after?: string;
+        test_clock?: string;
+    };
+    searchOptions?: {
+        query?: string;
+        limit?: number;
+        page?: number;
+    };
+}
+interface DisputeOptions {
+    dp_id?: string;
+    metadata?: object;
+    listOptions?: {
+        charge?: string;
+        payment_intent?: string;
+        created?: string;
+        ending_before?: string;
+        limit?: number;
+        starting_after?: string;
+    };
+}
+interface EventOptions {
+    event_id?: string;
+    listOptions?: {
+        created?: object;
+        delivery_success?: boolean;
+        ending_before?: string;
+        limit?: number;
+        starting_after?: string;
+        type?: string;
+    };
+}
+
+type MaybePromise<T> = T | Promise<T>;
+
+/**
+ * **PWA Options**
+ *
+ * The PWA options.
+ */
+type PwaOptions = Options$1;
+
+interface QueueOptions {
+    default: 'sync' | 'database' | 'redis' | 'sqs';
+    connections: {
+        sync: {
+            driver: 'sync';
+        };
+        database: {
+            driver: 'database';
+            table: 'jobs';
+            queue: 'default';
+            retry_after: 90;
+        };
+        redis: {
+            driver: 'redis';
+            connection: 'default';
+            queue: 'default';
+            retry_after: 90;
+        };
+        sqs: {
+            driver: 'sqs';
+            key: '';
+            secret: '';
+            prefix: '';
+            suffix: '';
+            queue: 'default';
+            region: 'us-east-1';
+        };
+    };
+    failed: {
+        driver: 'database';
+        database: 'mysql';
+        table: 'failed_jobs';
+    };
+}
+
+interface NitroEventHandler {
+    /**
+       * Path prefix or route
+       *
+       * If an empty string used, will be used as a middleware
+       */
+    route?: string;
+    /**
+       * Specifies this is a middleware handler.
+       * Middleware are called on every route and should normally return nothing to pass to the next handlers
+       */
+    middleware?: boolean;
+    /**
+       * Use lazy loading to import handler
+       */
+    lazy?: boolean;
+    /**
+       * Path to event handler
+       *
+       */
+    handler: string;
+    /**
+       * Router method matcher
+       */
+    method?: string;
+}
+type HttpMethod = 'get' | 'post' | 'put' | 'patch' | 'delete' | 'before' | 'after' | 'view';
+type RouteCallback = (params: Record<string, any>) => any;
+interface Route {
+    method: HttpMethod;
+    pattern: RegExp;
+    callback: RouteCallback;
+    paramNames: string[];
+}
+interface Middleware {
+    before?: RouteCallback;
+    after?: RouteCallback;
+}
+interface RouteGroupOptions {
+    prefix?: string;
+    middleware?: Middleware[];
+}
+
+type Search = any;
+type Page = any;
+type Pages = Page[];
+type Filter = any;
+type Filters = Filter[];
+type Result = any;
+type Results = Result[];
+type SearchFilter = any;
+type SearchFilters = SearchFilter[];
+type Sorts = any;
+type Sort = any;
+interface SearchEngineOptions {
+    /**
+     * **Search Engine Driver**
+     *
+     * The search engine to utilize.
+     *
+     * @default string 'meilisearch'
+     * @see https://stacksjs.dev/docs/search-engine
+     */
+    driver: 'meilisearch' | 'algolia';
+    meilisearch?: {
+        host: string;
+        apiKey: string;
+    };
+}
+interface ServicesOptions {
+    algolia?: {
+        appId: string;
+        apiKey: string;
+    };
+    meilisearch?: {
+        appId: string;
+        apiKey: string;
+    };
+    stripe?: {
+        appId: string;
+        apiKey: string;
+    };
+    planetscale?: {
+        appId: string;
+        apiKey: string;
+    };
+    supabase?: {
+        appId: string;
+        apiKey: string;
+    };
+    aws?: {
+        appId: string;
+        apiKey: string;
+    };
+    novu?: {
+        key: string;
+    };
+}
+interface StorageOptions {
+    /**
+     * **Storage Driver**
+     *
+     * The storage driver to utilize.
+     *
+     * @default string 's3'
+     * @see https://stacksjs.dev/docs/storage
+     */
+    driver: 's3' | 'local';
+}
+interface MeiliSearchOptions {
+    apiKey: string;
+    host: string;
+}
+interface SearchEngineDriver {
+    client: MeiliSearch;
+    createIndex: (name: string, options?: IndexOptions) => MaybePromise<EnqueuedTask>;
+    getIndex: (name: string) => MaybePromise<Index>;
+    updateIndex?: (name: string, options: IndexOptions) => MaybePromise<EnqueuedTask>;
+    deleteIndex?: (name: string) => MaybePromise<EnqueuedTask>;
+    updateIndexSettings: (name: string, settings: Settings) => MaybePromise<EnqueuedTask>;
+    listAllIndexes: () => MaybePromise<IndexesResults<Index[]>>;
+    listAllIndices: () => MaybePromise<IndexesResults<Index[]>>;
+    getRecord?: (key: string) => MaybePromise<any>;
+    getRecords?: (key: string) => MaybePromise<DocumentOptions>;
+    createRecord?: (record: any, indexName: string, options: DocumentOptions) => MaybePromise<EnqueuedTask>;
+    createRecords?: (records: any, indexName: string, options: DocumentOptions) => MaybePromise<EnqueuedTask>;
+    createOrReplaceRecord?: (record: any, indexName: string, options: DocumentOptions) => MaybePromise<EnqueuedTask>;
+    createOrUpdateRecord?: (record: any, indexName: string, options: DocumentOptions) => MaybePromise<EnqueuedTask>;
+    deleteRecord?: (recordId: string | number, indexName: string) => MaybePromise<EnqueuedTask>;
+    deleteAllRecords?: (indexName: string) => MaybePromise<EnqueuedTask>;
+    batchDeleteRecords?: (recordIds: string[] | number[], indexName: string) => MaybePromise<EnqueuedTask>;
+    search?: (query: string, indexName: string, options: SearchParams) => MaybePromise<Search>;
+    calculatePagination: Pages;
+    currentPage: Page;
+    filterName: string;
+    filters: Filters;
+    goToNextPage: () => Page;
+    goToPage: (pageNumber: number) => Page;
+    goToPrevPage: () => Page;
+    hits: Hits;
+    index: Index;
+    lastPage: Page;
+    perPage: number;
+    query: string;
+    results: Results;
+    searchFilters: SearchFilters;
+    searchParams: SearchParams;
+    setTotalHits: number;
+    sort: Sort;
+    sorts: Sorts;
+    totalPages: number;
+}
+type SearchEngineDriverFactory<T> = (opts?: T) => SearchEngineDriver;
+/**
+ * This interface is used to unify the persisting of data to localStorage
+ */
+interface SearchEngineStorage {
+    /**
+     * The search engine index name.
+     * i.e. the type of table, like `users`, `posts`, `products`, etc.
+     */
+    index?: string;
+    /**
+     * The search engine results object.
+     */
+    results?: SearchResponse;
+    /**
+     * The search engine hits object.
+     */
+    hits?: Hits;
+    /**
+     * The number of hits to be returned per page.
+     *
+     * @default number 20
+     */
+    perPage: number;
+    /**
+     * The current page number.
+     *
+     * @default number 1
+     */
+    currentPage: number;
+}
+
+type UserModule = (ctx: ViteSSGContext) => void;
+
+/**
+ * **Stacks Options**
+ *
+ * This configuration defines all of your Stacks 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.
+ */
+interface StacksOptions {
+    /**
+     * **Application Options**
+     *
+     * 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.
+     */
+    app: Partial<AppOptions>;
+    /**
+     * **Cache Options**
+     *
+     * This configuration defines all of your Cache 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.
+     */
+    cache: Partial<CacheOptions>;
+    /**
+     * **CDN Options**
+     *
+     * This configuration defines all of your CDN 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.
+     */
+    cdn: Partial<CdnOptions>;
+    /**
+     * **CLI Options**
+     *
+     * This configuration defines all of your CLI 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.
+     */
+    cli: Partial<UserCliOptions>;
+    /**
+     * **Database Options**
+     *
+     * This configuration defines all of your Database 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.
+     */
+    database: Partial<DatabaseOptions>;
+    /**
+     * **Debug Options**
+     *
+     * This configuration defines all of your Debug 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.
+     */
+    debug: Partial<DebugOptions>;
+    /**
+     * **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.
+     */
+    dns: Partial<DnsOptions>;
+    /**
+     * **Docs Options**
+     *
+     * This configuration defines all of your Docs 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.
+     */
+    docs: Partial<DocsOptions>;
+    /**
+     * **Email Options**
+     *
+     * This configuration defines all of your Email 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.
+     */
+    email: Partial<EmailOptions>;
+    /**
+     * **Git Options**
+     *
+     * 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.
+     */
+    git: Partial<GitOptions>;
+    /**
+     * **Hashing Options**
+     *
+     * This configuration defines all of your Hashing 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.
+     */
+    hashing: Partial<HashingOptions>;
+    /**
+     * **Library Options**
+     *
+     * 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.
+     */
+    library: Partial<LibraryOptions>;
+    /**
+     * **Notification Options**
+     *
+     * This configuration defines all of your Notification 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.
+     */
+    notification: Partial<NotificationOptions>;
+    /**
+     * **Payment Options**
+     *
+     * This configuration defines all of your Payment 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.
+     */
+    payment: Partial<PaymentOptions>;
+    /**
+     * **Search Engine Options**
+     *
+     * This configuration defines all of your Search Engine 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.
+     */
+    searchEngine: Partial<SearchEngineOptions>;
+    /**
+     * **Services Options**
+     *
+     * This configuration defines all of your Services 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.
+     */
+    services: Partial<ServicesOptions>;
+    /**
+     * **Storage Options**
+     *
+     * This configuration defines all of your Storage 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.
+     */
+    /**
+     * **UI Options**
+     *
+     * This configuration defines all of your UI 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.
+     */
+    ui: Partial<UiOptions>;
+}
+type ResolvedStacksOptions = Required<StacksOptions>;
+
+/**
+ * the TableStore interface is primarily used to unify the persisting of data to localStorage
+ */
+interface TableStore {
+    /**
+     * The search engine index name.
+     * i.e. the type of table, like `users`, `posts`, `products`, etc.
+     */
+    index: string;
+    /**
+     * The search engine results object.
+     */
+    results?: SearchResponse<Record<string, any>>;
+    /**
+     * The search engine hits object.
+     */
+    hits?: Hits;
+    columns: string[];
+    source?: string;
+    password?: string;
+    searchable?: string | boolean;
+    query?: string;
+    sortable?: string | boolean;
+    sort?: string;
+    sorts?: string | string[];
+    filterable?: string | boolean;
+    filters?: string | string[];
+    filterValue?: any[];
+    actionable?: string | boolean;
+    actions?: string | string[];
+    perPage: number;
+    selectable?: string | boolean;
+    selectedRows?: number[] | string[];
+    selectedAll?: boolean;
+    goToNextPage: number;
+    goToPage: number;
+    goToPrevPage: number;
+    lastPageNumber: number;
+    searchFilters?: object;
+    searchParams?: object;
+    setTotalHits: number;
+    /**
+     *
+     * The current page number
+     * @default 1
+     * @type {number}
+     * @memberof TableStore
+     * @example 1
+     */
+    currentPage: number;
+}
+
+type Font = 'inter' | 'mona' | 'hubot';
+type Icon = 'heroicon-outline' | 'heroicon-solid';
+type WebFontsProviders = 'google' | 'bunny' | 'fontshare';
+interface FontInfo {
+    title: string;
+    text: string;
+}
+type FontFor = 'email' | 'desktop' | 'mobile' | 'web';
+interface WebFontMeta {
+    name: string;
+    weights?: (string | number)[];
+    italic?: boolean;
+    provider?: WebFontsProviders;
+}
+/**
+ * **UI Engine Options**
+ *
+ * This type defines all of your UI Engine 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.
+ */
+interface UiOptions {
+    /**
+     * **Shortcuts**
+     *
+     * Shortcuts provide you with the ability to combine
+     * utility names for reusability purposes.
+     *
+     * @example
+     * ```
+     * shortcuts: {
+     *   'btn': 'px-4 py-2 rounded text-white bg-blue-500',
+     *   'btn-lg': 'btn px-6 py-3',
+     * }
+     * ```
+     */
+    shortcuts: Shortcuts;
+    /**
+     * **Safelist**
+     *
+     * Use the `safelist` option to ensure the generation of
+     * those utility classes. This is useful when certain
+     * class names don’t exist in your content files.
+     *
+     * @example
+     * ```ts
+     * safelist: [
+     *   'btn',
+     *   'btn-lg',
+     *   'btn-blue',
+     *   'btn-blue-500',
+     * ]
+     */
+    safelist: string;
+    /**
+     * **Trigger String**
+     *
+     * The "trigger string" defines the class name markup
+     * you want to add into your components.
+     *
+     * @default ':stx:'
+     *
+     * @example
+     * ```ts
+     * trigger: ':stx:'
+     * ```
+     */
+    trigger?: string;
+    /**
+     * **Class Prefix**
+     *
+     * The prefix for the compiled class name. When transforming
+     * all utility classes into a single class, this prefix
+     * will be added to the generated CSS class name.
+     *
+     * @default 'stx-'
+     *
+     * @example
+     * ```ts
+     * prefix: 'stx-'
+     * ```
+     */
+    classPrefix?: string;
+    /**
+     * **Hash Function**
+     *
+     * The hash function used to generate the class name.
+     *
+     * @example
+     * ```ts
+     * hash: (str: string) => {
+     *   return str
+     *     .split('')
+     *     .reduce((a, b) => {
+     *       a = ((a << 5) - a) + b.charCodeAt(0)
+     *       return a & a
+     *     }, 0)
+     *     .toString(36)
+     * }
+     */
+    hashFn?: (str: string) => string;
+    /**
+     * **CSS Resets—Preset**
+     *
+     * Define a standard of reset CSS stylesheets. By default, the Tailwind
+     * reset styles are utilized. You may set this value to `null`
+     * if you prefer not applying any default stylesheets.
+     *
+     * @url https://www.npmjs.com/package/@unocss/reset
+     * @todo preset needs to be added via a Vite plugin on development & build
+     * @example
+     * ```ts
+     * reset: 'tailwind'
+     * ```
+     */
+    reset?: ResetPreset;
+    /**
+     * **Fonts**
+     *
+     * Define the fonts you want to use. By default, Stacks provides support
+     * for several local font providers. You may set this value to
+     * `null` if you prefer not utilize any local fonts.
+     *
+     * @see https://stacks.ow3.org/fonts
+     * @example applies the same font for all platforms _(web, email, desktop, and mobile)_
+     * ```ts
+     * fonts: {
+     *   title: 'Mona',
+     *   text: 'Hubot'
+     * }
+     * ```
+     * @example
+     * ```ts
+     * fonts: {
+     *   web: {
+     *     title: 'Inter',
+     *     text: 'Mona'
+     *   },
+     *   desktop: {
+     *     title: 'Mona',
+     *     text: 'Inter'
+     *   },
+     * }
+     * ```
+     */
+    fonts?: Record<FontFor, FontInfo> | {
+        [key in FontFor]: FontInfo;
+    };
+    useWebFonts?: boolean | WebFontsProviders;
+    /**
+     * **Icon Sets**
+     *
+     * This value defines the icon sets you want to use. When using icons, they
+     * are displayed utilizing a technique called "icons in pure css."
+     * Learn more here https://antfu.me/posts/icons-in-pure-css.
+     *
+     * @see https://stacks.ow3.org/config/icons — list of available icon sets
+     * @todo implement this into Vite build flow
+     * @example
+     * ```ts
+     * icons: ['heroicons']
+     * ```
+     * @example
+     * ```html
+     * <i class="i-heroicons-outline-book-open w-8 h-8 text-gray-500" aria-hidden="true" />
+     * ```
+     */
+    icons: Icon | Icon[];
+}
+type Shortcuts = UserShortcuts;
+/**
+ * **Style Reset — Preset**
+ *
+ * This value sets the "reset preset." A preset defines certain
+ * CSS defaults to be applied.
+ *
+ * @default "tailwind"
+ */
+type ResetPreset = 'tailwind' | 'normalize' | 'sanitize' | 'eric-meyer' | 'antfu' | null;
+
+/**
+ * Null or whatever.
+ */
+type Nullable<T> = T | null | undefined;
+/**
+ * Function
+ */
+type Fn<T = void> = () => T;
+/**
+ * Array, or not yet
+ */
+type Arrayable<T> = T | Array<T>;
+/**
+ * Constructor.
+ */
+type Constructor<T = void> = new (...args: any[]) => T;
+/**
+ * Defines an intersection type of all union items.
+ *
+ * @param U Union of any types that will be intersected.
+ * @returns U items intersected
+ * @see https://stackoverflow.com/a/50375286/9259330
+ */
+type UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends ((k: infer I) => void) ? I : never;
+type MergeInsertions<T> = T extends object ? {
+    [K in keyof T]: MergeInsertions<T[K]>;
+} : T;
+type DeepMerge<F, S> = MergeInsertions<{
+    [K in keyof F | keyof S]: K extends keyof S & keyof F ? DeepMerge<F[K], S[K]> : K extends keyof S ? S[K] : K extends keyof F ? F[K] : never;
+}>;
+
+export { AAAARecord, ARecord, Action, ActionOption, ActionOptions, AddOption, AddOptions, AppOptions, ArgonOptions, Arrayable, AuthOptions, BcryptOptions, BuildOption, BuildOptions, CNameRecord, CacheOptions, CdnOptions, ChargeOptions, CleanOptions, CliOptions, CliOptionsKeys, CommandResult, CommandReturnValue, CommitOptions, Constructor, CreateBooleanOption, CreateOptions, CreateStringOption, CronJob, CronJobOptions, CronJobs, CustomerOptions, DatabaseClient, DatabaseDriver, DatabaseOptions, DebugOptions, DeepMerge, DeployOptions, DevOption, DevOptions, DisputeOptions, DnsOptions, DnsRecord, DocsConfig, DocsOptions, EmailOptions, EventOptions, Events, Every, ExamplesBoolean, ExamplesOption, ExamplesOptions, ExamplesString, ExitCode, ExpoPushNotificationOptions, FCMPushNotificationOptions, FactoryOptions, Fields, Fn, Font, FontFor, FontInfo, FreshOptions, GeneratorOption, GeneratorOptions, GitHooks, GitOptions, HashAlgorithm, HashingOptions, HttpMethod, Icon, InspectOptions, InspireOptions, IntroOptions, Job, JobOptions, Jobs, JsonFile, KeyOptions, LanguageCode, LayoutOptions, LibEntryType, LibraryBuildOptions, LibraryOptions, LicenseType, LintOption, LintOptions, MXRecord, MakeBooleanOption, MakeOptions, MakeStringOption, Manifest, MaybePromise, MeiliSearchOptions, MergeInsertions, Middleware, Model, Money, NitroEventHandler, NotificationOptions, NpmScript, Nullable, OutroOptions, PackageJson, PagesOption, PaymentOptions, PreinstallOptions, PrepublishOptions, PwaOptions, QueueOptions, ReleaseOptions, ResetPreset, ResolvedStacksOptions, Route, RouteCallback, RouteGroupOptions, SchemaOptions, SearchEngineDriver, SearchEngineDriverFactory, SearchEngineOptions, SearchEngineStorage, SeedOptions, ServicesOptions, Shortcuts, StackName, StacksError, StacksOptions, StorageOptions, TableStore, TagOption, TagsOptions, TestOptions, TextFile, TimestampOptions, TinkerOptions, TxtRecord, TypesOptions, UiOptions, UnionToIntersection, UpgradeBoolean, UpgradeOptions, UpgradeString, UserCliOptions, UserModule, ValidationError, WebFontMeta, WebFontsProviders, i18nOptions };