@stacksjs/types 0.52.10 → 0.56.3

package/dist/cli.d.ts

@@ -1,280 +0,0 @@
-/**
- * The parsed command-line arguments
- */
-import type { Ora } from 'ora';
-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 extends CliOptions {
-    type?: 'success' | 'error' | 'warning' | 'info';
-    startTime?: number;
-    useSeconds?: boolean;
-    isError?: boolean;
-    quiet?: boolean;
-}
-export interface IntroOptions {
-    /**
-     * @default true
-     */
-    showPerformance?: boolean;
-    /**
-     * @default false
-     */
-    quiet: 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 {
-    /**
-     * **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;
-}
-export type { Ora as SpinnerOptions } from 'ora';
-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 = {
-    [key in BuildOption]: boolean;
-} & CliOptions;
-export type AddOption = 'table' | 'calendar' | 'all';
-export type AddOptions = {
-    [key in AddOption]?: boolean;
-} & CliOptions;
-export type CreateStringOption = 'name';
-export type CreateBooleanOption = 'ui' | 'components' | 'web-components' | 'vue' | 'pages' | 'functions' | 'api' | 'database';
-export type CreateOptions = {
-    [key in CreateBooleanOption]: boolean;
-} & {
-    [key in CreateStringOption]: string;
-} & CliOptions;
-export type DevOption = 'components' | 'docs' | 'pages' | 'functions' | 'desktop' | 'all';
-export type DevOptions = {
-    [key in DevOption]: boolean;
-} & CliOptions;
-export type GeneratorOption = 'types' | 'entries' | 'webTypes' | 'customData' | 'ideHelpers' | 'vueCompatibility' | 'componentMeta';
-export type GeneratorOptions = {
-    [key in GeneratorOption]?: boolean;
-} & CliOptions;
-export type LintOption = 'fix';
-export type LintOptions = {
-    [key in LintOption]: boolean;
-} & CliOptions;
-export type MakeStringOption = 'name' | 'chat' | 'sms' | 'env';
-export type MakeBooleanOption = 'component' | 'page' | 'function' | 'language' | 'database' | 'migration' | 'factory' | 'notification' | 'stack';
-export type MakeOptions = {
-    [key in MakeBooleanOption]: boolean;
-} & {
-    [key in MakeStringOption]: string;
-} & CliOptions;
-export type UpgradeBoolean = 'framework' | 'dependencies' | 'packageManager' | 'node' | 'all' | 'force';
-export type UpgradeString = 'version';
-export type UpgradeOptions = {
-    [key in UpgradeBoolean]: boolean;
-} & {
-    [key in UpgradeString]: string;
-} & CliOptions;
-export type ExamplesString = 'version';
-export type ExamplesBoolean = 'components' | 'vue' | 'webComponents' | 'elements' | 'all' | 'force';
-export type ExamplesOption = ExamplesString & ExamplesBoolean | void;
-export type ExamplesOptions = {
-    [key in ExamplesString]: string;
-} & {
-    [key in ExamplesBoolean]: boolean;
-} & CliOptions;
-export type TestOptions = CliOptions & {
-    showReport?: boolean;
-};
-export interface CleanOptions extends CliOptions {
-}
-export interface CommitOptions extends CliOptions {
-}
-export interface KeyOptions extends CliOptions {
-}
-export interface FreshOptions extends CliOptions {
-}
-export interface InspireOptions extends CliOptions {
-}
-export interface ReleaseOptions extends CliOptions {
-}
-export interface PreinstallOptions extends CliOptions {
-}
-export interface PrepublishOptions extends CliOptions {
-}
-export interface TinkerOptions extends CliOptions {
-}
-export interface TypesOptions extends CliOptions {
-}
-export type LibEntryType = 'vue-components' | 'web-components' | 'functions' | 'all';
-/**
- * The available npm scripts within the Stacks toolkit.
- */
-export declare const enum NpmScript {
-    Build = "build",
-    BuildComponents = "build:components",
-    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 . ; npx publint",
-    LintFix = "eslint . --fix",
-    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",
-    UpgradePackageManager = "./.stacks/scripts/setup.sh +pnpm.io"
-}
-export 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",
-    DevDocs = "dev/docs",
-    Deploy = "deploy",
-    Fresh = "fresh",
-    GeneratePackageJsons = "generate/package-jsons",
-    GenerateSettings = "generate-settings",
-    GenerateOnboarding = "generate-onboarding",
-    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"
-}
-export type { CAC as CLI } from 'cac';

package/dist/cli.mjs

@@ -1,88 +0,0 @@
-export var NpmScript = /* @__PURE__ */ ((NpmScript2) => {
-  NpmScript2["Build"] = "build";
-  NpmScript2["BuildComponents"] = "build:components";
-  NpmScript2["BuildWebComponents"] = "build:web-components";
-  NpmScript2["BuildFunctions"] = "build:functions";
-  NpmScript2["BuildDocs"] = "build:docs";
-  NpmScript2["BuildStacks"] = "build:stacks";
-  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"] = "npx vitepress dev ./docs/src";
-  NpmScript2["DevDesktop"] = "dev:desktop";
-  NpmScript2["DevPages"] = "dev:pages";
-  NpmScript2["DevFunctions"] = "dev:functions";
-  NpmScript2["Fresh"] = "fresh";
-  NpmScript2["Lint"] = "eslint . ; npx publint";
-  NpmScript2["LintFix"] = "eslint . --fix";
-  NpmScript2["MakeStack"] = "make:stack";
-  NpmScript2["Test"] = "vitest --config vitest.config.ts";
-  NpmScript2["TestUnit"] = "vitest --config vitest.config.ts";
-  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-npx tsc --noEmit";
-  NpmScript2["Generate"] = "generate";
-  NpmScript2["GenerateTypes"] = "generate:types";
-  NpmScript2["GenerateEntries"] = "generate:entries";
-  NpmScript2["GenerateVueCompat"] = "generate:vue-compatibility";
-  NpmScript2["GenerateWebTypes"] = "generate:web-types";
-  NpmScript2["GenerateVsCodeCustomData"] = "generate:vscode-custom-data";
-  NpmScript2["GenerateIdeHelpers"] = "generate:ide-helpers";
-  NpmScript2["GenerateComponentMeta"] = "generate:component-meta";
-  NpmScript2["Release"] = "release";
-  NpmScript2["Commit"] = "commit";
-  NpmScript2["Example"] = "example";
-  NpmScript2["ExampleVue"] = "example:vue";
-  NpmScript2["ExampleWebComponents"] = "example:web-components";
-  NpmScript2["KeyGenerate"] = "key:generate";
-  NpmScript2["TypesFix"] = "types:fix";
-  NpmScript2["TypesGenerate"] = "types:generate";
-  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["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["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["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["Tinker"] = "tinker";
-  Action2["Typecheck"] = "typecheck";
-  Action2["Upgrade"] = "upgrade/index";
-  Action2["UpgradeNode"] = "upgrade/node";
-  Action2["UpgradePackageManager"] = "upgrade/package-manager";
-  return Action2;
-})(Action || {});

package/dist/components.d.ts

@@ -1,60 +0,0 @@
-export type { Options as ComponentOptions } from 'unplugin-vue-components';
-export interface TagOption {
-    /**
-     * **Tag Name**
-     *
-     * This is the name of the component to be included in your library build.
-     * When defining a tag, ensure that the name corresponds to a file within
-     * root component directory.
-     *
-     * @example
-     * {
-     *   tags: [{
-     *     name: 'HelloWorld' // results in `<HelloWorld />`
-     *   }]
-     * }
-     *
-     * @example
-     * {
-     *   tags: [{
-     *     name: ['HelloWorld', 'AppHelloWorld'] // results in `<AppHelloWorld />`
-     *   }]
-     * }
-     * @see https://stacksjs.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;
-    }[];
-}
-export type TagsOptions = TagOption[];

package/dist/cron-jobs.d.ts

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

@@ -1,6 +0,0 @@
-export interface DebugOptions {
-    driver?: string;
-    enabled: boolean;
-    host: string;
-    port: number;
-}

package/dist/deploy.d.ts

@@ -1,9 +0,0 @@
-/**
- * **Deploy Options**
- *
- * This configuration defines all of your deployment options. Because Stacks is fully-typed,
- * you may hover any of the options below and the definitions will be provided. In case
- * you have any questions, feel free to reach out via Discord or GitHub Discussions.
- */
-export interface DeployOptions {
-}

package/dist/dns.d.ts

@@ -1,43 +0,0 @@
-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,3 +0,0 @@
-import type { UserConfig } from 'vitepress';
-export type DocsConfig = UserConfig;
-export type DocsOptions = DocsConfig;

package/dist/errors.d.ts

@@ -1 +0,0 @@
-export { Err, Ok, Result, ResultAsync, } from 'neverthrow';

package/dist/errors.mjs

@@ -1,6 +0,0 @@
-export {
-  Err,
-  Ok,
-  Result,
-  ResultAsync
-} from "neverthrow";

package/dist/events.d.ts

@@ -1,22 +0,0 @@
-/**
- * **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
- * useEvent('user:registered', { name: 'Chris'})
- * dispatch('user:registered', { name: 'Chris'})
- * ````
-
- * @example To capture an event, you may use any of the following approaches:
- * ```ts
- * useListen('user:registered', (user) => console.log(user))
- * listen('user:registered', (user) => console.log(user))
- * ```
- */
-export interface Events {
-    [key: string]: any;
-}

package/dist/exit-code.d.ts

@@ -1,10 +0,0 @@
-/**
- * CLI exit codes.
- *
- * @see https://nodejs.org/api/process.html#process_exit_codes
- */
-export declare enum ExitCode {
-    Success = 0,
-    FatalError = 1,
-    InvalidArgument = 9
-}

package/dist/exit-code.mjs

@@ -1,6 +0,0 @@
-export var ExitCode = /* @__PURE__ */ ((ExitCode2) => {
-  ExitCode2[ExitCode2["Success"] = 0] = "Success";
-  ExitCode2[ExitCode2["FatalError"] = 1] = "FatalError";
-  ExitCode2[ExitCode2["InvalidArgument"] = 9] = "InvalidArgument";
-  return ExitCode2;
-})(ExitCode || {});

package/dist/fs.d.ts

@@ -1,22 +0,0 @@
-/**
- * Describes a plain-text file.
- */
-export interface TextFile {
-    path: string;
-    data: string;
-}
-/**
- * Describes a JSON file.
- */
-export interface JsonFile {
-    path: string;
-    data: unknown;
-    indent: string;
-    newline: string | undefined;
-}
-/**
- * Describes a package.json file.
- */
-export interface PackageJson {
-    packageManager: string;
-}