@xpadev-net/niconicomments 0.2.65 → 0.2.67

package/dist/bundle.d.ts

@@ -8,19 +8,66 @@ export type IssueReason = "any" | "array" | "bigint" | "blob" | "boolean" | "dat
  * Issue origin type.
  */
 export type IssueOrigin = "key" | "value";
+/**
+ * Unknown path item type.
+ */
+export type UnknownPathItem = {
+	type: "unknown";
+	input: unknown;
+	key: unknown;
+	value: unknown;
+};
+/**
+ * Path item type.
+ */
+export type PathItem = ArrayPathItem | MapPathItem | ObjectPathItem | RecordPathItem | SetPathItem | TuplePathItem | UnknownPathItem;
 /**
  * Issue type.
  */
 export type Issue = {
+	/**
+	 * The issue reason.
+	 */
 	reason: IssueReason;
+	/**
+	 * The validation name.
+	 */
 	validation: string;
+	/**
+	 * The issue origin.
+	 */
 	origin: IssueOrigin;
+	/**
+	 * The error message.
+	 */
 	message: string;
-	input: any;
+	/**
+	 * The input data.
+	 */
+	input: unknown;
+	/**
+	 * The validation requirement
+	 */
+	requirement?: unknown;
+	/**
+	 * The issue path.
+	 */
 	path?: PathItem[];
+	/**
+	 * The sub issues.
+	 */
 	issues?: Issues;
+	/**
+	 * Whether it was abort early.
+	 */
 	abortEarly?: boolean;
+	/**
+	 * Whether the pipe was abort early.
+	 */
 	abortPipeEarly?: boolean;
+	/**
+	 * Whether the pipe was skipped.
+	 */
 	skipPipe?: boolean;
 };
 /**
@@ -30,30 +77,92 @@ export type Issues = [
 	Issue,
 	...Issue[]
 ];
+/**
+ * Error message type.
+ */
+export type ErrorMessage = string | (() => string);
+/**
+ * Resolve type.
+ *
+ * Hint: This type has no effect and is only used so that TypeScript displays
+ * the final type in the preview instead of the utility types used.
+ */
+export type Resolve<T> = T;
+/**
+ * Resolve object type.
+ *
+ * Hint: This type has no effect and is only used so that TypeScript displays
+ * the final type in the preview instead of the utility types used.
+ */
+export type ResolveObject<T> = Resolve<{
+	[k in keyof T]: T[k];
+}>;
 /**
  * Parse info type.
  */
 export type ParseInfo = Partial<Pick<Issue, "origin" | "abortEarly" | "abortPipeEarly" | "skipPipe">>;
 /**
- * Path item type.
+ * Typed schema result type.
  */
-export type PathItem = ObjectPathItem | RecordPathItem | TuplePathItem | MapPathItem | SetPathItem | ArrayPathItem;
+export type TypedSchemaResult<TOutput> = {
+	/**
+	 * Whether is's typed.
+	 */
+	typed: true;
+	/**
+	 * The parse output.
+	 */
+	output: TOutput;
+	/**
+	 * The parse issues.
+	 */
+	issues?: Issues;
+};
 /**
- * Parse result type.
+ * Untyped parse result type.
  */
-export type _ParseResult<TOutput> = {
-	output: TOutput;
-	issues?: undefined;
-} | {
-	output?: undefined;
+export type UntypedSchemaResult = {
+	/**
+	 * Whether is's typed.
+	 */
+	typed: false;
+	/**
+	 * The parse output.
+	 */
+	output: unknown;
+	/**
+	 * The parse issues.
+	 */
 	issues: Issues;
 };
+/**
+ * Schema result type.
+ */
+export type SchemaResult<TOutput> = TypedSchemaResult<TOutput> | UntypedSchemaResult;
 /**
  * Base schema type.
  */
 export type BaseSchema<TInput = any, TOutput = TInput> = {
+	/**
+	 * Whether it's async.
+	 */
 	async: false;
-	_parse(input: unknown, info?: ParseInfo): _ParseResult<TOutput>;
+	/**
+	 * Parses unknown input based on its schema.
+	 *
+	 * @param input The input to be parsed.
+	 * @param info The parse info.
+	 *
+	 * @returns The parse result.
+	 *
+	 * @internal
+	 */
+	_parse(input: unknown, info?: ParseInfo): SchemaResult<TOutput>;
+	/**
+	 * Input and output type.
+	 *
+	 * @internal
+	 */
 	_types?: {
 		input: TInput;
 		output: TOutput;
@@ -63,8 +172,26 @@ export type BaseSchema<TInput = any, TOutput = TInput> = {
  * Base schema async type.
  */
 export type BaseSchemaAsync<TInput = any, TOutput = TInput> = {
+	/**
+	 * Whether it's async.
+	 */
 	async: true;
-	_parse(input: unknown, info?: ParseInfo): Promise<_ParseResult<TOutput>>;
+	/**
+	 * Parses unknown input based on its schema.
+	 *
+	 * @param input The input to be parsed.
+	 * @param info The parse info.
+	 *
+	 * @returns The parse result.
+	 *
+	 * @internal
+	 */
+	_parse(input: unknown, info?: ParseInfo): Promise<SchemaResult<TOutput>>;
+	/**
+	 * Input and output type.
+	 *
+	 * @internal
+	 */
 	_types?: {
 		input: TInput;
 		output: TOutput;
@@ -79,42 +206,173 @@ export type Input<TSchema extends BaseSchema | BaseSchemaAsync> = NonNullable<TS
  */
 export type Output<TSchema extends BaseSchema | BaseSchemaAsync> = NonNullable<TSchema["_types"]>["output"];
 /**
- * Resolve type.
- *
- * Hint: This type has no effect and is only used so that TypeScript displays
- * the final type in the preview instead of the utility types used.
+ * Valid action result type.
  */
-export type Resolve<T> = T;
+export type ValidActionResult<TOutput> = {
+	/**
+	 * The pipe output.
+	 */
+	output: TOutput;
+	/**
+	 * The pipe issues.
+	 */
+	issues?: undefined;
+};
 /**
- * Resolve object type.
- *
- * Hint: This type has no effect and is only used so that TypeScript displays
- * the final type in the preview instead of the utility types used.
+ * Invalid action result type.
  */
-export type ResolveObject<T> = Resolve<{
-	[k in keyof T]: T[k];
-}>;
+export type InvalidActionResult = {
+	/**
+	 * The pipe output.
+	 */
+	output?: undefined;
+	/**
+	 * The pipe issues.
+	 */
+	issues: Pick<Issue, "validation" | "message" | "input" | "requirement" | "path">[];
+};
+/**
+ * Pipe action result type.
+ */
+export type PipeActionResult<TOutput> = ValidActionResult<TOutput> | InvalidActionResult;
+/**
+ * Base validation type.
+ */
+export type BaseValidation<TInput = any> = {
+	/**
+	 * Whether it's async.
+	 */
+	async: false;
+	/**
+	 * The error message.
+	 */
+	message: ErrorMessage;
+	/**
+	 * Parses unknown input based on its requirement.
+	 *
+	 * @param input The input to be parsed.
+	 *
+	 * @returns The parse result.
+	 *
+	 * @internal
+	 */
+	_parse(input: TInput): PipeActionResult<TInput>;
+};
+/**
+ * Base validation async type.
+ */
+export type BaseValidationAsync<TInput = any> = {
+	/**
+	 * Whether it's async.
+	 */
+	async: true;
+	/**
+	 * The error message.
+	 */
+	message: ErrorMessage;
+	/**
+	 * Parses unknown input based on its requirement.
+	 *
+	 * @param input The input to be parsed.
+	 *
+	 * @returns The parse result.
+	 *
+	 * @internal
+	 */
+	_parse(input: TInput): Promise<PipeActionResult<TInput>>;
+};
+/**
+ * Base transformation type.
+ */
+export type BaseTransformation<TInput = any> = {
+	/**
+	 * Whether it's async.
+	 */
+	async: false;
+	/**
+	 * Parses unknown input based on its requirement.
+	 *
+	 * @param input The input to be parsed.
+	 *
+	 * @returns The parse result.
+	 *
+	 * @internal
+	 */
+	_parse(input: TInput): PipeActionResult<TInput>;
+};
+/**
+ * Base transformation async type.
+ */
+export type BaseTransformationAsync<TInput = any> = {
+	/**
+	 * Whether it's async.
+	 */
+	async: true;
+	/**
+	 * Parses unknown input based on its requirement.
+	 *
+	 * @param input The input to be parsed.
+	 *
+	 * @returns The parse result.
+	 *
+	 * @internal
+	 */
+	_parse(input: TInput): Promise<PipeActionResult<TInput>>;
+};
+/**
+ * Pipe type.
+ */
+export type Pipe<TInput> = (BaseValidation<TInput> | BaseTransformation<TInput>)[];
+/**
+ * Pipe async type.
+ */
+export type PipeAsync<TInput> = (BaseValidation<TInput> | BaseValidationAsync<TInput> | BaseTransformation<TInput> | BaseTransformationAsync<TInput>)[];
 /**
  * Array schema type.
  */
 export type ArraySchema<TItem extends BaseSchema, TOutput = Output<TItem>[]> = BaseSchema<Input<TItem>[], TOutput> & {
+	/**
+	 * The schema type.
+	 */
 	type: "array";
+	/**
+	 * The array item schema.
+	 */
 	item: TItem;
+	/**
+	 * The error message.
+	 */
+	message: ErrorMessage;
+	/**
+	 * The validation and transformation pipeline.
+	 */
+	pipe: Pipe<Output<TItem>[]> | undefined;
 };
 /**
  * Array path item type.
  */
 export type ArrayPathItem = {
 	type: "array";
-	input: any[];
+	input: unknown[];
 	key: number;
-	value: any;
+	value: unknown;
 };
 /**
  * Boolean schema type.
  */
 export type BooleanSchema<TOutput = boolean> = BaseSchema<boolean, TOutput> & {
+	/**
+	 * The schema type.
+	 */
 	type: "boolean";
+	/**
+	 * The error message.
+	 */
+	message: ErrorMessage;
+	/**
+	 * The validation and transformation pipeline.
+	 */
+	pipe: Pipe<boolean> | undefined;
 };
 /**
  * Enum type.
@@ -127,15 +385,35 @@ export type Enum = {
  * Native enum schema type.
  */
 export type EnumSchema<TEnum extends Enum, TOutput = TEnum[keyof TEnum]> = BaseSchema<TEnum[keyof TEnum], TOutput> & {
+	/**
+	 * The schema type.
+	 */
 	type: "enum";
+	/**
+	 * The enum value.
+	 */
 	enum: TEnum;
+	/**
+	 * The error message.
+	 */
+	message: ErrorMessage;
 };
 /**
  * Native enum schema async type.
  */
 export type EnumSchemaAsync<TEnum extends Enum, TOutput = TEnum[keyof TEnum]> = BaseSchemaAsync<TEnum[keyof TEnum], TOutput> & {
+	/**
+	 * The schema type.
+	 */
 	type: "enum";
+	/**
+	 * The enum value.
+	 */
 	enum: TEnum;
+	/**
+	 * The error message.
+	 */
+	message: ErrorMessage;
 };
 /**
  * Intersect options async type.
@@ -175,8 +453,18 @@ export type IntersectOptions = [
  * Intersect schema type.
  */
 export type IntersectSchema<TOptions extends IntersectOptions, TOutput = IntersectOutput<TOptions>> = BaseSchema<IntersectInput<TOptions>, TOutput> & {
+	/**
+	 * The schema type.
+	 */
 	type: "intersect";
+	/**
+	 * The intersect options.
+	 */
 	options: TOptions;
+	/**
+	 * The error message.
+	 */
+	message: ErrorMessage;
 };
 /**
  * Literal type.
@@ -186,43 +474,87 @@ export type Literal = number | string | boolean | symbol | bigint;
  * Literal schema type.
  */
 export type LiteralSchema<TLiteral extends Literal, TOutput = TLiteral> = BaseSchema<TLiteral, TOutput> & {
+	/**
+	 * The schema type.
+	 */
 	type: "literal";
+	/**
+	 * The literal value.
+	 */
 	literal: TLiteral;
+	/**
+	 * The error message.
+	 */
+	message: ErrorMessage;
 };
 /**
  * Map path item type.
  */
 export type MapPathItem = {
 	type: "map";
-	input: Map<any, any>;
-	key: any;
-	value: any;
+	input: Map<unknown, unknown>;
+	key: unknown;
+	value: unknown;
 };
 /**
  * Never schema type.
  */
 export type NeverSchema = BaseSchema<never> & {
+	/**
+	 * The schema type.
+	 */
 	type: "never";
+	/**
+	 * The error message.
+	 */
+	message: ErrorMessage;
 };
 /**
  * Never schema async type.
  */
 export type NeverSchemaAsync = BaseSchemaAsync<never> & {
+	/**
+	 * The schema type.
+	 */
 	type: "never";
+	/**
+	 * The error message.
+	 */
+	message: ErrorMessage;
 };
 /**
  * Nullable schema type.
  */
-export type NullableSchema<TWrapped extends BaseSchema, TDefault extends Input<TWrapped> | undefined = undefined, TOutput = TDefault extends Input<TWrapped> ? Output<TWrapped> : Output<TWrapped> | null> = BaseSchema<Input<TWrapped> | null, TOutput> & {
+export type NullableSchema<TWrapped extends BaseSchema, TDefault extends Input<TWrapped> | (() => Input<TWrapped> | undefined) | undefined = undefined, TOutput = TDefault extends Input<TWrapped> ? Output<TWrapped> : Output<TWrapped> | null> = BaseSchema<Input<TWrapped> | null, TOutput> & {
+	/**
+	 * The schema type.
+	 */
 	type: "nullable";
+	/**
+	 * The wrapped schema.
+	 */
 	wrapped: TWrapped;
-	getDefault: () => TDefault;
+	/**
+	 * The default value.
+	 */
+	default: TDefault;
 };
 /**
  * Number schema type.
  */
 export type NumberSchema<TOutput = number> = BaseSchema<number, TOutput> & {
+	/**
+	 * The schema type.
+	 */
 	type: "number";
+	/**
+	 * The error message.
+	 */
+	message: ErrorMessage;
+	/**
+	 * The validation and transformation pipeline.
+	 */
+	pipe: Pipe<number> | undefined;
 };
 /**
  * Object entries async type.
@@ -233,9 +565,9 @@ export type ObjectEntriesAsync = Record<string, BaseSchema | BaseSchemaAsync>;
  */
 export type ObjectPathItem = {
 	type: "object";
-	input: Record<string, any>;
+	input: Record<string, unknown>;
 	key: string;
-	value: any;
+	value: unknown;
 };
 /**
  * Required object keys type.
@@ -277,17 +609,43 @@ export type ObjectEntries = Record<string, BaseSchema>;
  * Object schema type.
  */
 export type ObjectSchema<TEntries extends ObjectEntries, TRest extends BaseSchema | undefined = undefined, TOutput = ObjectOutput<TEntries, TRest>> = BaseSchema<ObjectInput<TEntries, TRest>, TOutput> & {
+	/**
+	 * The schema type.
+	 */
 	type: "object";
+	/**
+	 * The object entries schema.
+	 */
 	entries: TEntries;
+	/**
+	 * The object rest schema.
+	 */
 	rest: TRest;
+	/**
+	 * The error message.
+	 */
+	message: ErrorMessage;
+	/**
+	 * The validation and transformation pipeline.
+	 */
+	pipe: Pipe<ObjectOutput<TEntries, TRest>> | undefined;
 };
 /**
  * Optional schema type.
  */
-export type OptionalSchema<TWrapped extends BaseSchema, TDefault extends Input<TWrapped> | undefined = undefined, TOutput = TDefault extends Input<TWrapped> ? Output<TWrapped> : Output<TWrapped> | undefined> = BaseSchema<Input<TWrapped> | undefined, TOutput> & {
+export type OptionalSchema<TWrapped extends BaseSchema, TDefault extends Input<TWrapped> | (() => Input<TWrapped> | undefined) | undefined = undefined, TOutput = TDefault extends Input<TWrapped> ? Output<TWrapped> : Output<TWrapped> | undefined> = BaseSchema<Input<TWrapped> | undefined, TOutput> & {
+	/**
+	 * The schema type.
+	 */
 	type: "optional";
+	/**
+	 * The wrapped schema.
+	 */
 	wrapped: TWrapped;
-	getDefault: () => TDefault;
+	/**
+	 * Returns the default value.
+	 */
+	default: TDefault;
 };
 /**
  * Picklist options type.
@@ -302,28 +660,70 @@ export type PicklistOptions<TOption extends string = string> = Readonly<[
 /**
  * Picklist schema type.
  */
-export type PicklistSchema<Toptions extends PicklistOptions, TOutput = Toptions[number]> = BaseSchema<Toptions[number], TOutput> & {
+export type PicklistSchema<TOptions extends PicklistOptions, TOutput = TOptions[number]> = BaseSchema<TOptions[number], TOutput> & {
+	/**
+	 * The schema type.
+	 */
 	type: "picklist";
-	options: Toptions;
+	/**
+	 * The picklist options.
+	 */
+	options: TOptions;
+	/**
+	 * The error message.
+	 */
+	message: ErrorMessage;
 };
 /**
  * Picklist schema async type.
  */
 export type PicklistSchemaAsync<TOptions extends PicklistOptions, TOutput = TOptions[number]> = BaseSchemaAsync<TOptions[number], TOutput> & {
+	/**
+	 * The schema type.
+	 */
 	type: "picklist";
+	/**
+	 * The picklist value.
+	 */
 	options: TOptions;
+	/**
+	 * The error message.
+	 */
+	message: ErrorMessage;
 };
 /**
  * String schema type.
  */
 export type StringSchema<TOutput = string> = BaseSchema<string, TOutput> & {
+	/**
+	 * The schema type.
+	 */
 	type: "string";
+	/**
+	 * The error message.
+	 */
+	message: ErrorMessage;
+	/**
+	 * The validation and transformation pipeline.
+	 */
+	pipe: Pipe<string> | undefined;
 };
 /**
  * String schema async type.
  */
 export type StringSchemaAsync<TOutput = string> = BaseSchemaAsync<string, TOutput> & {
+	/**
+	 * The schema type.
+	 */
 	type: "string";
+	/**
+	 * The error message.
+	 */
+	message: ErrorMessage;
+	/**
+	 * The validation and transformation pipeline.
+	 */
+	pipe: PipeAsync<string> | undefined;
 };
 /**
  * Union options type.
@@ -337,8 +737,18 @@ export type UnionOptions = [
  * Union schema type.
  */
 export type UnionSchema<TOptions extends UnionOptions, TOutput = Output<TOptions[number]>> = BaseSchema<Input<TOptions[number]>, TOutput> & {
+	/**
+	 * The schema type.
+	 */
 	type: "union";
+	/**
+	 * The union options.
+	 */
 	options: TOptions;
+	/**
+	 * The error message.
+	 */
+	message: ErrorMessage;
 };
 /**
  * Union options async type.
@@ -352,8 +762,18 @@ export type UnionOptionsAsync = [
  * Union schema async type.
  */
 export type UnionSchemaAsync<TOptions extends UnionOptionsAsync, TOutput = Output<TOptions[number]>> = BaseSchemaAsync<Input<TOptions[number]>, TOutput> & {
+	/**
+	 * The schema type.
+	 */
 	type: "union";
+	/**
+	 * The union options.
+	 */
 	options: TOptions;
+	/**
+	 * The error message.
+	 */
+	message: ErrorMessage;
 };
 /**
  * Record key type.
@@ -364,14 +784,14 @@ export type RecordKeyAsync = EnumSchema<any, string | number | symbol> | EnumSch
  */
 export type RecordPathItem = {
 	type: "record";
-	input: Record<string | number | symbol, any>;
+	input: Record<string | number | symbol, unknown>;
 	key: string | number | symbol;
-	value: any;
+	value: unknown;
 };
 /**
  * Partial key schema type.
  */
-export type PartialKeySchema = PicklistSchema<any> | PicklistSchemaAsync<any> | EnumSchema<any> | EnumSchemaAsync<any> | UnionSchema<any>;
+export type PartialKeySchema = PicklistSchema<any> | PicklistSchemaAsync<any> | EnumSchema<any> | EnumSchemaAsync<any> | UnionSchema<any> | UnionSchemaAsync<any>;
 /**
  * Record input inference type.
  */
@@ -388,18 +808,35 @@ export type RecordKey = EnumSchema<any, string | number | symbol> | PicklistSche
  * Record schema type.
  */
 export type RecordSchema<TKey extends RecordKey, TValue extends BaseSchema, TOutput = RecordOutput<TKey, TValue>> = BaseSchema<RecordInput<TKey, TValue>, TOutput> & {
+	/**
+	 * The schema type.
+	 */
 	type: "record";
+	/**
+	 * The record key schema.
+	 */
 	key: TKey;
+	/**
+	 * The record value schema.
+	 */
 	value: TValue;
+	/**
+	 * The error message.
+	 */
+	message: ErrorMessage;
+	/**
+	 * The validation and transformation pipeline.
+	 */
+	pipe: Pipe<RecordOutput<TKey, TValue>> | undefined;
 };
 /**
  * Set path item type.
  */
 export type SetPathItem = {
 	type: "set";
-	input: Set<any>;
+	input: Set<unknown>;
 	key: number;
-	value: any;
+	value: unknown;
 };
 /**
  * Tuple path item type.
@@ -407,17 +844,24 @@ export type SetPathItem = {
 export type TuplePathItem = {
 	type: "tuple";
 	input: [
-		any,
-		...any[]
+		unknown,
+		...unknown[]
 	];
 	key: number;
-	value: any;
+	value: unknown;
 };
 /**
  * Unknown schema type.
  */
 export type UnknownSchema<TOutput = unknown> = BaseSchema<unknown, TOutput> & {
+	/**
+	 * The schema type.
+	 */
 	type: "unknown";
+	/**
+	 * The validation and transformation pipeline.
+	 */
+	pipe: Pipe<unknown> | undefined;
 };
 export type ButtonList = {
 	left: ButtonPartLeft;