@stacksjs/types 0.67.0 → 0.68.0

package/dist/email.d.ts

@@ -1,11 +1,16 @@
-export interface EmailOptions {
-	from: {
-		name: string;
-		address: string;
-	};
-	mailboxes: string[];
-	url: string;
-	charset: string;
-	server: { scan?: boolean };
+export declare interface EmailOptions {
+  from: {
+    name: string
+    address: string
+  }
+
+  mailboxes: string[]
+
+  url: string
+  charset: string 
+
+  server: {
+    scan?: boolean
+  }
 }
-export type EmailConfig = Partial<EmailOptions>;
+export declare type EmailConfig = Partial<EmailOptions>

package/dist/errors.d.ts

@@ -1,70 +1,88 @@
-export type CommandError = Error;
-export interface ErrorOptions {
-	messages: {
-		"string": string;
-		"email": string;
-		"regex": string;
-		"url": string;
-		"activeUrl": string;
-		"alpha": string;
-		"alphaNumeric": string;
-		"minLength": string;
-		"maxLength": string;
-		"fixedLength": string;
-		"confirmed": string;
-		"endsWith": string;
-		"startsWith": string;
-		"sameAs": string;
-		"notSameAs": string;
-		"in": string;
-		"notIn": string;
-		"ipAddress": string;
-		"uuid": string;
-		"ascii": string;
-		"creditCard": string;
-		"hexCode": string;
-		"iban": string;
-		"jwt": string;
-		"coordinates": string;
-		"mobile": string;
-		"passport": string;
-		"postalCode": string;
-		"boolean": string;
-		"number": string;
-		"min": string;
-		"max": string;
-		"range": string;
-		"positive": string;
-		"negative": string;
-		"decimal": string;
-		"withoutDecimals": string;
-		"date": string;
-		"date.equals": string;
-		"date.after": string;
-		"date.before": string;
-		"date.afterOrEqual": string;
-		"date.beforeOrEqual": string;
-		"date.sameAs": string;
-		"date.notSameAs": string;
-		"date.afterField": string;
-		"accepted": string;
-		"enum": string;
-		"literal": string;
-		"object": string;
-		"record": string;
-		"record.minLength": string;
-		"record.maxLength": string;
-		"record.fixedLength": string;
-		"array": string;
-		"array.minLength": string;
-		"array.maxLength": string;
-		"array.fixedLength": string;
-		"notEmpty": string;
-		"distinct": string;
-		"tuple": string;
-		"union": string;
-		"unionGroup": string;
-		"unionOfTypes": string;
-	};
+export declare type CommandError = Error
+export declare interface ErrorResponse {
+  status: number 
+  errors: string | object 
+  stack?: string 
+  name: string
+  message: string
 }
-export type ErrorConfig = Partial<ErrorOptions>;
+export declare interface ErrorOptions {
+  messages: {
+    'string': string
+    'email': string
+    'regex': string
+    'url': string
+    'activeUrl': string
+    'alpha': string
+    'alphaNumeric': string
+    'minLength': string
+    'maxLength': string
+    'fixedLength': string
+    'confirmed': string
+    'endsWith': string
+    'startsWith': string
+    'sameAs': string
+    'notSameAs': string
+    'in': string
+    'notIn': string
+    'ipAddress': string
+    'uuid': string
+    'ascii': string
+    'creditCard': string
+    'hexCode': string
+    'iban': string
+    'jwt': string
+    'coordinates': string
+    'mobile': string
+    'passport': string
+    'postalCode': string
+
+    'boolean': string
+
+    'number': string
+    'min': string
+    'max': string
+    'range': string
+    'positive': string
+    'negative': string
+    'decimal': string
+    'withoutDecimals': string
+
+    'date': string
+    'date.equals': string
+    'date.after': string
+    'date.before': string
+    'date.afterOrEqual': string
+    'date.beforeOrEqual': string
+    'date.sameAs': string
+    'date.notSameAs': string
+    'date.afterField': string
+
+    'accepted': string
+
+    'enum': string
+
+    'literal': string
+
+    'object': string
+
+    'record': string
+    'record.minLength': string
+    'record.maxLength': string
+    'record.fixedLength': string
+
+    'array': string
+    'array.minLength': string
+    'array.maxLength': string
+    'array.fixedLength': string
+    'notEmpty': string
+    'distinct': string
+
+    'tuple': string
+
+    'union': string
+    'unionGroup': string
+    'unionOfTypes': string
+  }
+}
+export declare type ErrorConfig = Partial<ErrorOptions>

package/dist/events.d.ts

@@ -1,30 +1,3 @@
-/**
-* **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.org' })
-*
-* // alternatively, you may use the following:
-* useEvent('user:registered', { name: 'Chris', email: 'chris@stacksjs.org' })
-* events.emit('user:registered', { name: 'Chris', email: 'chris@stacksjs.org' })
-* useEvents.emit('user:registered', { name: 'Chris', email: 'chris@stacksjs.org' })
-* ```
-*
-* @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))
-* ```
-*/
-export interface Events {
-	[key: string]: string[];
-}
+export declare interface Events {
+  [key: string]: string[]
+}

package/dist/exit-code.d.ts

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

package/dist/file-systems.d.ts

@@ -1,60 +1,56 @@
-/**
-* Describes a plain-text file.
-*/
-export interface TextFile {
-	path: string;
-	data: string;
+export declare interface TextFile {
+  path: string
+  data: string
 }
-/**
-* Describes a JSON file.
-*/
-export interface JsonFile {
-	path: string;
-	data: unknown;
-	indent: string;
-	newline: string | undefined;
+export declare 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;
+export declare interface PackageJson {
+  engines: {
+    node: string
+    pnpm: string
+  }
+  version: string
+  packageManager: string
 }
-export interface FileSystemOptions {
-	default: string;
-	disks: {
-		local: {
-			driver: "local";
-			root: string;
-		};
-		public: {
-			driver: "public";
-			root: string;
-			visibility?: "public";
-		};
-		private: {
-			driver: "private";
-			root: string;
-			visibility?: "private";
-		};
-		efs: {
-			driver: "local";
-			root: string;
-		};
-		s3: {
-			driver: "s3";
-			root: string;
-		};
-		[key: string]: {
-			driver: string;
-			root: string;
-			visibility?: "public" | "private";
-		};
-	};
+export declare interface FileSystemOptions {
+  default: string
+  disks: {
+    local: {
+      driver: 'local'
+      root: string
+    }
+
+    public: {
+      driver: 'public'
+      root: string
+      visibility?: 'public'
+    }
+
+    private: {
+      driver: 'private'
+      root: string
+      visibility?: 'private'
+    }
+
+    efs: {
+      driver: 'local'
+      root: string
+    }
+
+    s3: {
+      driver: 's3'
+      root: string
+    }
+
+    [key: string]: {
+      driver: string
+      root: string
+      visibility?: 'public' | 'private'
+    }
+  }
 }
-export type FileSystemConfig = Partial<FileSystemOptions>;
+export declare type FileSystemConfig = Partial<FileSystemOptions>

package/dist/git.d.ts

@@ -1,128 +1,56 @@
-/**
-* **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;
-	};
+export declare interface GitOptions {
+  hooks: GitHooks
+
+  scopes: string[]
+
+  types: {
+    value: string
+    name: string
+    emoji: string
+  }[]
+
+  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;
+declare 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 {};
+export declare type GitConfig = Partial<GitOptions>
+export declare interface GitHooks extends Hooks {}

package/dist/hashing.d.ts

@@ -1,100 +1,33 @@
-/**
-* 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 declare interface HashingOptions {
+  driver: 'argon2' | 'argon2id' | 'argon2i' | 'argon2d' | 'bcrypt'
+
+  bcrypt?: BcryptOptions
+
+  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;
+export declare type HashingConfig = Partial<HashingOptions>
+export declare interface BcryptOptions {
+  rounds: number
+
+  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 time**
-	*
-	* Execution time.
-	*
-	* @default number 1
-	* @see https://stacksjs.org/docs/hashing
-	*/
-	time?: number;
+export declare interface ArgonOptions {
+  memory?: number
+
+
+  time?: number
 }
-export type HashAlgorithm = "md4" | "md5" | "sha1" | "sha256" | "sha384" | "sha512" | "ripemd128" | "ripemd160" | "tiger128" | "tiger160" | "tiger192" | "crc32" | "crc32b";
+export declare type HashAlgorithm =
+  | 'md4'
+  | 'md5'
+  | 'sha1'
+  | 'sha256'
+  | 'sha384'
+  | 'sha512'
+  | 'ripemd128'
+  | 'ripemd160'
+  | 'tiger128'
+  | 'tiger160'
+  | 'tiger192'
+  | 'crc32'
+  | 'crc32b'

package/dist/helpers.d.ts

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