@stacksjs/types 0.58.72 → 0.59.1

package/dist/git.d.ts

@@ -0,0 +1,129 @@
+/**
+ * **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.org/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.org/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.org/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 type GitConfig = Partial<GitOptions>;
+export interface GitHooks extends Hooks {
+}
+export {};

package/dist/hashing.d.ts

@@ -0,0 +1,109 @@
+/**
+ * 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.org/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.org/docs/hashing
+     */
+    driver: 'argon2' | 'argon2id' | 'argon2i' | 'argon2d' | '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.org/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.org/docs/hashing
+     */
+    argon2?: ArgonOptions;
+}
+export type HashingConfig = Partial<HashingOptions>;
+/**
+ * **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.org/docs/hashing
+ */
+export interface BcryptOptions {
+    /**
+     * Bcrypt salt rounds.
+     *
+     * @default number 10
+     * @see https://stacksjs.org/docs/hashing
+     */
+    rounds: number;
+    /**
+     * Bcrypt cost. This is a number between 4-31.
+     * @default number 4
+     * @see https://stacksjs.org/docs/hashing
+     */
+    cost: 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.org/docs/hashing
+ */
+export interface ArgonOptions {
+    /**
+     * **Argon Memory**
+     *
+     * Amount of memory (in kibibytes) to use.
+     *
+     * @default number 65536
+     * @see https://stacksjs.org/docs/hashing
+     */
+    memory?: number;
+    /**
+     * **Argon Parallelism**
+     *
+     * Degree of parallelism (i.e. number of threads).
+     *
+     * @default number 1
+     * @see https://stacksjs.org/docs/hashing
+     */
+    threads?: number;
+    /**
+     * **Argon time**
+     *
+     * Execution time.
+     *
+     * @default number 1
+     * @see https://stacksjs.org/docs/hashing
+     */
+    time?: number;
+}
+export type HashAlgorithm = 'md4' | 'md5' | 'sha1' | 'sha256' | 'sha384' | 'sha512' | 'ripemd128' | 'ripemd160' | 'tiger128' | 'tiger160' | 'tiger192' | 'crc32' | 'crc32b';

package/dist/helpers.d.ts

@@ -0,0 +1 @@
+export declare function getTypeName(v: any): string;

package/dist/i18n.d.ts

@@ -0,0 +1,19 @@
+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

@@ -0,0 +1,58 @@
+export * from './ai';
+export * from './analytics';
+export * from './api';
+export * from './app';
+export * from './auto-imports';
+export * from './binary';
+export * from './build';
+export * from './cache';
+export * from './cdn';
+export * from './chat';
+export * from './cli';
+export * from './cloud';
+export * from './components';
+export * from './configure';
+export * from './cron-jobs';
+export * from './database';
+export * from './dependencies';
+export * from './deploy';
+export * from './dns';
+export * from './docs';
+export * from './errors';
+export * from './email';
+export * from './env';
+export * from './events';
+export * from './exit-code';
+export * from './file-systems';
+export * from './git';
+export * from './hashing';
+export * from './i18n';
+export * from './inspect';
+export * from './library';
+export * from './logger';
+export * from './manifest';
+export * from './model';
+export * from './money';
+export * from './notifications';
+export * from './pages';
+export * from './payments';
+export * from './ports';
+export * from './promise';
+export * from './pwa';
+export * from './push';
+export * from './queue';
+export * from './reactivity';
+export * from './router';
+export * from './scheduler';
+export * from './search-engine';
+export * from './security';
+export * from './services';
+export * from './sms';
+export * from './ssg';
+export * from './storage';
+export * from './stacks';
+export * from './team';
+export * from './tables';
+export * from './ui';
+export * from './utils';
+export * from './helpers';