@stacksjs/types 0.53.1 → 0.56.21

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/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/fs.d.ts

@@ -1,27 +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 {
-    engines: {
-        node: string;
-        pnpm: string;
-    };
-    version: string;
-    packageManager: string;
-}

package/dist/git.d.ts

@@ -1,128 +0,0 @@
-/**
- * **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.
- */
-export 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', 'pages', '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;
-}
-export interface GitHooks extends Hooks {
-}
-export {};

package/dist/hashing.d.ts

@@ -1,102 +0,0 @@
-/**
- * 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
- */
-export 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
- */
-export 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
- */
-export 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;
-}
-export type HashAlgorithm = 'md4' | 'md5' | 'sha1' | 'sha256' | 'sha384' | 'sha512' | 'ripemd128' | 'ripemd160' | 'tiger128' | 'tiger160' | 'tiger192' | 'crc32' | 'crc32b';

package/dist/i18n.d.ts

@@ -1,19 +0,0 @@
-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
- */
-export type i18nOptions = VitePluginVueI18nOptions;
-export {};

package/dist/index.d.ts

@@ -1,39 +0,0 @@
-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';

package/dist/inspect.d.ts

@@ -1,9 +0,0 @@
-import type { Options } from 'vite-plugin-inspect';
-/**
- * **Inspect Options**
- *
- * The inspect options.
- *
- * @see https://github.com/intlify/bundle-tools/blob/main/packages/vite-plugin-vue-i18n/src/options.ts
- */
-export type InspectOptions = Options;

package/dist/layout.d.ts

@@ -1,7 +0,0 @@
-import type { UserOptions } from 'vite-plugin-vue-layouts';
-/**
- * **Layout Options**
- *
- * The layout options.
- */
-export type LayoutOptions = UserOptions;