@defjs/core 0.0.0-test-002 → 0.0.0-test-004

package/index.d.ts

@@ -1,227 +1,293 @@
-declare const HTTP_CONTEXT_TOKEN: unique symbol;
-export type HttpContextToken<T> = (() => T) & {
-	readonly [HTTP_CONTEXT_TOKEN]: () => T;
-};
-export declare function makeHttpContextToken<T>(defaultValue: () => T): HttpContextToken<T>;
-export declare function isHttpContextToken(value: unknown): value is HttpContextToken<unknown>;
-export type HttpContext = {
-	set<T>(token: HttpContextToken<T>, value: T): HttpContext;
-	get<T>(token: HttpContextToken<T>): T;
-	del(token: HttpContextToken<unknown>): HttpContext;
-	has(token: HttpContextToken<unknown>): boolean;
-	keys(): IterableIterator<HttpContextToken<unknown>>;
-};
-export declare function makeHttpContext(): HttpContext;
-export type ValidatorFn<T = unknown> = (value: T) => Error | null | undefined;
-export type AsyncValidatorFn<T = unknown> = (value: T) => Promise<Error | null | undefined>;
-export declare const required: ValidatorFn;
-export declare const requiredTrue: ValidatorFn;
-export declare const minLength: (min: number) => ValidatorFn;
-export declare const maxLength: (max: number) => ValidatorFn;
-export declare const min: (min: number) => ValidatorFn;
-export declare const max: (max: number) => ValidatorFn;
-export declare const pattern: (pattern: RegExp) => ValidatorFn;
-declare const FIELD: unique symbol;
-declare enum FieldType {
-	Json = 1,
-	Query = 2,
-	Param = 3,
-	Header = 4,
-	Form = 5,
-	Body = 6,
-	UrlForm = 7
-}
-export interface FieldMetadata<T = undefined> {
-	alias: Map<FieldType, string | undefined>;
-	validators: ValidatorFn<T>[];
-	asyncValidator: AsyncValidatorFn<T>[];
-}
-export type Field<T = undefined> = (() => T) & {
-	withJson(alias?: string): Field<T>;
-	withForm(alias?: string): Field<T>;
-	withQuery(alias?: string): Field<T>;
-	withParam(alias?: string): Field<T>;
-	withHeader(alias?: string): Field<T>;
-	withUrlForm(alias?: string): Field<T>;
-	withBody(): Field<T>;
-	withValidators(...fn: ValidatorFn<T>[]): Field<T>;
-	withAsyncValidators(...fn: AsyncValidatorFn<T>[]): Field<T>;
-	readonly [FIELD]: FieldMetadata<T>;
-};
-export declare function field(): Field;
-export declare function field<T>(): Field<T | undefined>;
-export declare function field<T>(defaultValue: T): Field<T>;
-export declare function validatorField(validators: ValidatorFn<any>[], value: unknown): void;
-export declare function asyncValidatorField(asyncValidator: AsyncValidatorFn<any>[], value: unknown): Promise<void>;
-export declare function isField(value: unknown): value is Field;
-export declare function isFieldGroup(value: unknown): value is Record<PropertyKey, Field>;
-export type HttpResponseBody = string | ArrayBuffer | Blob | object | null;
-export type HttpResponse<R> = {
-	readonly url: string;
-	readonly status: number;
-	readonly statusText: string;
-	readonly headers: Headers;
-	readonly body: R | null;
-};
-export type MakeResponseOptions<R> = {
-	status?: number;
-	statusText?: string;
-	url?: string;
-	headers?: Headers;
-	body?: R | null;
-};
-export type InterceptorFn = (req: HttpRequest, next: HttpHandler) => Promise<HttpResponse<unknown>>;
-export type BasicCredential = {
-	username: string;
-	password: string;
-};
-export type BasicAuthInterceptorOptions = {
-	encode?: (credential: BasicCredential) => string;
-};
-export declare function basicAuthInterceptor(fn: () => BasicCredential, options?: BasicAuthInterceptorOptions): InterceptorFn;
-export type HttpResponseType = "arraybuffer" | "blob" | "json" | "text";
-export interface HttpProgressEvent {
-	/**
-	 * Indicates whether the resources associated with Progress have a computable length.
-	 * Otherwise, the Progress.total attribute will be a meaningless value.
-	 */
-	readonly lengthComputable: boolean;
-	/** Indicates the workload of the underlying process. */
-	readonly loaded: number;
-	/**
-	 * The total size of the data being processed or transmitted.
-	 * If the Progress.lengthComputable attribute is false, this value is meaningless and should be ignored.
-	 */
-	readonly total: number;
-}
-export type HttpProgressFn = (event: HttpProgressEvent) => void;
-export type TransformResponseFn<Output = unknown> = (response: HttpResponse<unknown>) => Output;
-export interface HttpRequest {
-	host?: string;
-	method: string;
-	endpoint: string;
-	body?: Blob | ArrayBuffer | FormData | URLSearchParams | object | string | number | boolean | null;
-	headers?: Headers;
-	queryParams?: URLSearchParams;
-	/** default：json */
-	responseType?: HttpResponseType;
-	context?: HttpContext;
-	timeout?: number;
-	withCredentials?: boolean;
-	/** when use fetch handler, no upload progress */
-	uploadProgress?: HttpProgressFn;
-	downloadProgress?: HttpProgressFn;
-	/**
-	 * default：body
-	 */
-	observe?: "body" | "response";
-	abort?: AbortSignal;
-}
-export type RequestInputValue<T> = T extends Field<infer V> ? V : T extends {
-	[K in keyof T]: Field<any>;
-} ? {
-	[K in keyof T]: RequestInputValue<T[K]>;
-} : never;
-export type DoRequestOptions = {
-	abort?: AbortSignal;
-	handler?: HttpHandler;
-	client?: Client;
-	timeout?: number;
-};
-export type ObserveType<Observe, Output> = Observe extends "body" ? Output : Observe extends "response" ? HttpResponse<Output> : never;
-export type UseRequestFn<Input, Output, Observe> = {
-	doRequest: Input extends undefined ? (options?: DoRequestOptions) => Promise<ObserveType<Observe, Output>> : (input: RequestInputValue<Input>, options?: DoRequestOptions) => Promise<ObserveType<Observe, Output>>;
-	getInitValue: () => Input extends Field<infer V> ? V : Input extends {
-		[K in keyof Input]: Field<any>;
-	} ? {
-		[K in keyof Input]: RequestInputValue<Input[K]>;
-	} : undefined;
-	setUploadProgress: (fn: HttpProgressFn) => void;
-	setDownloadProgress: (fn: HttpProgressFn) => void;
-};
-export interface DefineRequest<Input extends Field<any> | Record<PropertyKey, Field<any>> | undefined = undefined, Output = unknown, Observe extends "body" | "response" = "body"> {
-	(): UseRequestFn<Input, Output, Observe>;
-	withField<I extends Field<any> | Record<PropertyKey, Field<any>>>(value: I): DefineRequest<I, Output, Observe>;
-	withInterceptors(value: InterceptorFn[]): DefineRequest<Input, Output, Observe>;
-	withContext(value: HttpContext): DefineRequest<Input, Output, Observe>;
-	withCredentials(value: boolean): DefineRequest<Input, Output, Observe>;
-	withValidators(value: (ValidatorFn<RequestInputValue<Input>> | AsyncValidatorFn<RequestInputValue<Input>>)[]): DefineRequest<Input, Output, Observe>;
-	withTransformResponse<O>(fn: TransformResponseFn<O>): DefineRequest<Input, O, Observe>;
-	withObserve(value: "body"): DefineRequest<Input, Output, "body">;
-	withObserve(value: "response"): DefineRequest<Input, Output, "response">;
-	withResponseType(value: "json"): DefineRequest<Input, Output, Observe>;
-	withResponseType(value: "text"): DefineRequest<Input, string, Observe>;
-	withResponseType(value: "blob"): DefineRequest<Input, Blob, Observe>;
-	withResponseType(value: "arraybuffer"): DefineRequest<Input, ArrayBuffer, Observe>;
-}
-export declare function defineRequest<Output>(method: string, endpoint: string): DefineRequest<undefined, Output>;
-export type HttpHandler = (req: HttpRequest) => Promise<HttpResponse<unknown>>;
-export interface FetchConfig {
-	/** A string indicating how the request will interact with the browser's cache to set request's cache. */
-	cache?: RequestCache;
-	/** A string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL. Sets request's credentials. */
-	credentials?: RequestCredentials;
-	/** A boolean to set request's keepalive. */
-	keepalive?: boolean;
-	/** A string to indicate whether the request will use CORS, or will be restricted to same-origin URLs. Sets request's mode. */
-	mode?: RequestMode;
-	priority?: RequestPriority;
-	/** A string indicating whether request follows redirects, results in an error upon encountering a redirect, or returns the redirect (in an opaque fashion). Sets request's redirect. */
-	redirect?: RequestRedirect;
-	/** A string whose value is a same-origin URL, "about:client", or the empty string, to set request's referrer. */
-	referrer?: string;
-	/** A referrer policy to set request's referrerPolicy. */
-	referrerPolicy?: ReferrerPolicy;
-}
-export declare const FETCH_CONFIG_KEY: HttpContextToken<FetchConfig>;
-export declare function fetchHandler(httpRequest: HttpRequest): Promise<HttpResponse<unknown>>;
-export interface ClientOptions {
-	host: string;
-	interceptors?: InterceptorFn[];
-	handler?: HttpHandler;
-}
-export interface ClientConfig {
-	host: string;
-	handler: HttpHandler;
-	interceptors?: InterceptorFn[];
-}
-declare const CLIENT: unique symbol;
-export type Client = {} & {
-	readonly [CLIENT]: ClientConfig;
-};
-export declare function isClient(value: unknown): value is Client;
-export declare function createClient(options: ClientOptions): Client;
-export declare function cloneClient(client: Client, options: Partial<ClientOptions>): Client;
-export declare function getGlobalClient(): Client;
-export declare function setGlobalClient(client: Client): void;
-export declare function restGlobalClient(): void;
-export declare function createGlobalClient(options: ClientOptions): void;
-export declare const ERR_ABORTED: Error;
-export declare const ERR_TIMEOUT: Error;
-export declare const ERR_NETWORK: Error;
-export declare const ERR_NOT_FOUND_HANDLER: Error;
-export declare const ERR_OBSERVE: Error;
-export declare const ERR_NOT_SET_ALIAS: Error;
-export declare const ERR_UNSUPPORTED_FIELD_TYPE: Error;
-export declare const ERR_INVALID_CLIENT: Error;
-export declare const ERR_NOT_FOUND_GLOBAL_CLIENT: Error;
-export declare const ERR_INVALID_HTTP_CONTEXT_TOKEN: Error;
-export declare const ERR_UNKNOWN: Error;
-export declare class HttpErrorResponse extends Error {
-	readonly status: number;
-	readonly statusText: string;
-	readonly url: string | null;
-	readonly headers: Headers;
-	readonly ok: boolean;
-	readonly body: unknown;
-	constructor(init: {
-		error?: Error | string | unknown;
-		status?: number;
-		statusText?: string;
-		url?: string;
-		headers?: Headers;
-		body?: unknown;
-	});
-}
+export declare type AsyncValidatorFn<T = unknown> = (value: T) => Promise<void>;
+
+export declare function basicAuthInterceptor(fn: () => BasicCredential, options?: BasicAuthInterceptorOptions): InterceptorFn;
+
+export declare type BasicAuthInterceptorOptions = {
+    encode?: (credential: BasicCredential) => string;
+};
+
+declare type BasicCredential = {
+    username: string;
+    password: string;
+};
+
+declare const CLIENT: unique symbol;
+
+export declare type Client = {
+    readonly [CLIENT]: ClientConfig;
+};
+
+export declare interface ClientConfig {
+    host: string;
+    strict: boolean;
+    handler: HttpHandler;
+    interceptors?: InterceptorFn[];
+}
+
+export declare interface ClientOptions {
+    host: string;
+    /** Default: true  */
+    strict?: boolean;
+    interceptors?: InterceptorFn[];
+    handler?: HttpHandler;
+}
+
+export declare function cloneClient(client: Client, options: Partial<ClientOptions>): Client;
+
+export declare function createClient(options: ClientOptions): Client;
+
+export declare function createGlobalClient(options: ClientOptions): void;
+
+declare interface DefineRequest<Input extends Field<any> | Record<PropertyKey, Field<any>> | undefined = undefined, Output = unknown, Observe extends 'body' | 'response' = 'body'> {
+    (): UseRequestFn<Input, Output, Observe>;
+    withField<I extends Field<any> | Record<PropertyKey, Field<any>>>(value: I): DefineRequest<I, Output, Observe>;
+    withInterceptors(value: InterceptorFn[]): DefineRequest<Input, Output, Observe>;
+    withContext(value: HttpContext): DefineRequest<Input, Output, Observe>;
+    withCredentials(value: boolean): DefineRequest<Input, Output, Observe>;
+    withValidators(value: (ValidatorFn<RequestInputValue<Input>> | AsyncValidatorFn<RequestInputValue<Input>>)[]): DefineRequest<Input, Output, Observe>;
+    withTransformResponse<O>(fn: TransformResponseFn<O>): DefineRequest<Input, O, Observe>;
+    withObserve(value: 'body'): DefineRequest<Input, Output, 'body'>;
+    withObserve(value: 'response'): DefineRequest<Input, Output, 'response'>;
+    withResponseType(value: 'json'): DefineRequest<Input, Output, Observe>;
+    withResponseType(value: 'text'): DefineRequest<Input, string, Observe>;
+    withResponseType(value: 'blob'): DefineRequest<Input, Blob, Observe>;
+    withResponseType(value: 'arraybuffer'): DefineRequest<Input, ArrayBuffer, Observe>;
+}
+
+export declare function defineRequest<Output>(method: string, endpoint: string): DefineRequest<undefined, Output>;
+
+export declare type DoRequestOptions = {
+    abort?: AbortSignal;
+    handler?: HttpHandler;
+    client?: Client;
+    timeout?: number;
+};
+
+export declare function doValid<T>(validators: (ValidatorFn<T> | AsyncValidatorFn<T>)[], value: T): Promise<void>;
+
+export declare const ERR_ABORTED: Error;
+
+export declare const ERR_INVALID_CLIENT: Error;
+
+export declare const ERR_INVALID_HTTP_CONTEXT_TOKEN: Error;
+
+export declare const ERR_NETWORK: Error;
+
+export declare const ERR_NOT_FOUND_GLOBAL_CLIENT: Error;
+
+export declare const ERR_NOT_FOUND_HANDLER: Error;
+
+export declare const ERR_NOT_SET_ALIAS: Error;
+
+export declare const ERR_OBSERVE: Error;
+
+export declare const ERR_TIMEOUT: Error;
+
+export declare const ERR_UNKNOWN: Error;
+
+export declare const ERR_UNSUPPORTED_FIELD_TYPE: Error;
+
+export declare function fetchHandler(httpRequest: HttpRequest): Promise<HttpResponse<unknown>>;
+
+declare const FIELD: unique symbol;
+
+export declare type Field<T = undefined> = (() => T) & {
+    withJson(alias?: string): Field<T>;
+    withForm(alias?: string): Field<T>;
+    withQuery(alias?: string): Field<T>;
+    withParam(alias?: string): Field<T>;
+    withHeader(alias?: string): Field<T>;
+    withUrlForm(alias?: string): Field<T>;
+    withBody(): Field<T>;
+    withValidators(...fn: ValidatorFn<T>[]): Field<T>;
+    withAsyncValidators(...fn: AsyncValidatorFn<T>[]): Field<T>;
+    readonly [FIELD]: FieldMetadata<T>;
+};
+
+export declare function field(): Field;
+
+export declare function field<T>(): Field<T | undefined>;
+
+export declare function field<T>(defaultValue: T): Field<T>;
+
+declare interface FieldMetadata<T = undefined> {
+    required: boolean;
+    alias: Map<FieldType, string | undefined>;
+    validators: ValidatorFn<T>[];
+    asyncValidator: AsyncValidatorFn<T>[];
+}
+
+declare enum FieldType {
+    Json = 0,
+    Query = 1,
+    Param = 2,
+    Header = 3,
+    Form = 4,
+    Body = 5,
+    UrlForm = 6
+}
+
+export declare function getGlobalClient(): Client;
+
+declare const HTTP_CONTEXT: unique symbol;
+
+declare const HTTP_CONTEXT_TOKEN: unique symbol;
+
+export declare type HttpContext = {
+    set<T>(token: HttpContextToken<T>, value: T): HttpContext;
+    get<T>(token: HttpContextToken<T>): T;
+    del(token: HttpContextToken<unknown>): HttpContext;
+    has(token: HttpContextToken<unknown>): boolean;
+    keys(): IterableIterator<HttpContextToken<unknown>>;
+    get length(): number;
+    readonly [HTTP_CONTEXT]: Map<HttpContextToken<unknown>, unknown>;
+};
+
+export declare type HttpContextToken<T> = (() => T) & {
+    readonly [HTTP_CONTEXT_TOKEN]: () => T;
+};
+
+export declare class HttpErrorResponse extends Error {
+    readonly status: number;
+    readonly statusText: string;
+    readonly url: string;
+    readonly headers: Headers;
+    readonly body: unknown;
+    constructor(init?: {
+        error?: Error | string | unknown;
+        status?: number;
+        statusText?: string;
+        url?: string;
+        headers?: Headers;
+        body?: unknown;
+    });
+}
+
+export declare type HttpHandler = (req: HttpRequest) => Promise<HttpResponse<unknown>>;
+
+export declare interface HttpProgressEvent {
+    /**
+     * Indicates whether the resources associated with Progress have a computable length.
+     * Otherwise, the Progress.total attribute will be a meaningless value.
+     */
+    readonly lengthComputable: boolean;
+    /** Indicates the workload of the underlying process. */
+    readonly loaded: number;
+    /**
+     * The total size of the data being processed or transmitted.
+     * If the Progress.lengthComputable attribute is false, this value is meaningless and should be ignored.
+     */
+    readonly total: number;
+}
+
+export declare type HttpProgressFn = (event: HttpProgressEvent) => void;
+
+export declare interface HttpRequest {
+    host?: string;
+    method: string;
+    endpoint: string;
+    body?: Blob | ArrayBuffer | FormData | URLSearchParams | object | string | number | boolean | null;
+    headers?: Headers;
+    queryParams?: URLSearchParams;
+    /** default：json */
+    responseType?: HttpResponseType;
+    context?: HttpContext;
+    timeout?: number;
+    withCredentials?: boolean;
+    /** when use fetch handler, no upload progress */
+    uploadProgress?: HttpProgressFn;
+    downloadProgress?: HttpProgressFn;
+    /**
+     * default：body
+     */
+    observe?: 'body' | 'response';
+    abort?: AbortSignal;
+}
+
+export declare type HttpResponse<R> = {
+    readonly url: string;
+    readonly status: number;
+    readonly statusText: string;
+    readonly headers: Headers;
+    readonly body: R | null;
+};
+
+export declare type HttpResponseBody = string | ArrayBuffer | Blob | object | null;
+
+export declare type HttpResponseType = 'arraybuffer' | 'blob' | 'json' | 'text';
+
+export declare type InterceptorFn = (req: HttpRequest, next: HttpHandler) => Promise<HttpResponse<unknown>>;
+
+export declare function isClient(value: unknown): value is Client;
+
+export declare function isField(value: unknown): value is Field;
+
+export declare function isFieldGroup(value: unknown): value is Record<PropertyKey, Field>;
+
+export declare function isHttpContextToken(value: unknown): value is HttpContextToken<unknown>;
+
+export declare function makeHttpContext(): HttpContext;
+
+export declare function makeHttpContext(entries?: readonly (readonly [HttpContextToken<unknown>, unknown])[]): HttpContext;
+
+export declare function makeHttpContext(context?: HttpContext): HttpContext;
+
+export declare function makeHttpContextToken<T>(defaultValue: () => T): HttpContextToken<T>;
+
+export declare type MakeResponseOptions<R> = {
+    status?: number;
+    statusText?: string;
+    url?: string;
+    headers?: Headers;
+    body?: R | null;
+};
+
+export declare const max: (max: number) => ValidatorFn;
+
+export declare const maxLength: (max: number) => ValidatorFn;
+
+export declare const min: (min: number) => ValidatorFn;
+
+export declare const minLength: (min: number) => ValidatorFn;
+
+declare type ObserveType<Observe, Output> = Observe extends 'body' ? Output : Observe extends 'response' ? HttpResponse<Output> : never;
+
+export declare const pattern: (pattern: RegExp) => ValidatorFn;
+
+export declare type RequestInputValue<T> = T extends Field<infer V> ? V : T extends {
+    [K in keyof T]: Field<any>;
+} ? {
+    [K in keyof T]: RequestInputValue<T[K]>;
+} : never;
+
+export declare const required: ValidatorFn;
+
+export declare const requiredTrue: ValidatorFn;
+
+export declare function restGlobalClient(): void;
+
+export declare function setGlobalClient(client: Client): void;
+
+declare type TransformResponseFn<Output = unknown> = (response: HttpResponse<unknown>) => Output;
+
+export declare type UseRequestFn<Input, Output, Observe> = {
+    doRequest: Input extends undefined ? (options?: DoRequestOptions) => Promise<ObserveType<Observe, Output>> : RequestInputValue<Input> extends RequestInputValue<Input> | undefined ? (input?: RequestInputValue<Input>, options?: DoRequestOptions) => Promise<ObserveType<Observe, Output>> : (input: RequestInputValue<Input>, options?: DoRequestOptions) => Promise<ObserveType<Observe, Output>>;
+    getInitValue: () => Input extends Field<infer V> ? V : Input extends {
+        [K in keyof Input]: Field<any>;
+    } ? {
+        [K in keyof Input]: RequestInputValue<Input[K]>;
+    } : undefined;
+    setUploadProgress: (fn: HttpProgressFn) => void;
+    setDownloadProgress: (fn: HttpProgressFn) => void;
+};
+
+export declare type ValidatorFn<T = unknown> = (value: T) => void;
+
+export { }
 
-export {};
+
+declare module 'vitest' {
+    interface ProvidedContext {
+        testServerHost: string;
+    }
+}