@sugardarius/anzen 2.2.1 → 2.3.0

package/dist/types-D-blrRCr.d.cts

@@ -1,266 +0,0 @@
-/** The Standard Schema interface. */
-interface StandardSchemaV1<Input = unknown, Output = Input> {
-    /** The Standard Schema properties. */
-    readonly '~standard': StandardSchemaV1.Props<Input, Output>;
-}
-declare namespace StandardSchemaV1 {
-    /** The Standard Schema properties interface. */
-    interface Props<Input = unknown, Output = Input> {
-        /** The version number of the standard. */
-        readonly version: 1;
-        /** The vendor name of the schema library. */
-        readonly vendor: string;
-        /** Validates unknown input values. */
-        readonly validate: (value: unknown) => Result<Output> | Promise<Result<Output>>;
-        /** Inferred types associated with the schema. */
-        readonly types?: Types<Input, Output> | undefined;
-    }
-    /** The result interface of the validate function. */
-    type Result<Output> = SuccessResult<Output> | FailureResult;
-    /** The result interface if validation succeeds. */
-    interface SuccessResult<Output> {
-        /** The typed output value. */
-        readonly value: Output;
-        /** The non-existent issues. */
-        readonly issues?: undefined;
-    }
-    /** The result interface if validation fails. */
-    interface FailureResult {
-        /** The issues of failed validation. */
-        readonly issues: ReadonlyArray<Issue>;
-    }
-    /** The issue interface of the failure output. */
-    interface Issue {
-        /** The error message of the issue. */
-        readonly message: string;
-        /** The path of the issue, if any. */
-        readonly path?: ReadonlyArray<PropertyKey | PathSegment> | undefined;
-    }
-    /** The path segment interface of the issue. */
-    interface PathSegment {
-        /** The key representing a path segment. */
-        readonly key: PropertyKey;
-    }
-    /** The Standard Schema types interface. */
-    interface Types<Input = unknown, Output = Input> {
-        /** The input type of the schema. */
-        readonly input: Input;
-        /** The output type of the schema. */
-        readonly output: Output;
-    }
-    /** Infers the input type of a Standard Schema. */
-    type InferInput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['input'];
-    /** Infers the output type of a Standard Schema. */
-    type InferOutput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['output'];
-}
-type StandardSchemaDictionary<Input = Record<string, unknown>, Output extends Record<keyof Input, unknown> = Input> = {
-    [K in keyof Input]-?: StandardSchemaV1<Input[K], Output[K]>;
-};
-declare namespace StandardSchemaDictionary {
-    type InferInput<T extends StandardSchemaDictionary> = {
-        [K in keyof T]: StandardSchemaV1.InferInput<T[K]>;
-    };
-    type InferOutput<T extends StandardSchemaDictionary> = {
-        [K in keyof T]: StandardSchemaV1.InferOutput<T[K]>;
-    };
-}
-
-type EmptyObjectType = {};
-type UnwrapReadonlyObject<T> = T extends Readonly<infer U> ? U : T;
-type Awaitable<T> = T | PromiseLike<T>;
-type AuthContext = Record<string, unknown>;
-type TSegmentsDict = StandardSchemaDictionary;
-type TSearchParamsDict = StandardSchemaDictionary;
-type TBodySchema = StandardSchemaV1;
-type TFormDataDict = StandardSchemaDictionary;
-type AuthFunctionParams<TSegments extends TSegmentsDict | undefined, TSearchParams extends TSearchParamsDict | undefined, TBody extends TBodySchema | undefined, TFormData extends TFormDataDict | undefined> = {
-    /**
-     * ID for the route handler.
-     */
-    readonly id: string;
-    /**
-     * Parsed request url
-     */
-    readonly url: URL;
-    /**
-     * Original request
-     *
-     * Cloned from the incoming request to avoid side effects
-     * and to make it consumable in the `authorize` function.
-     * Due to `NextRequest` limitations as the req is cloned it's always a `Request`
-     */
-    req: Request;
-} & (TSegments extends TSegmentsDict ? {
-    /**
-     * Validated route dynamic segments
-     */
-    readonly segments: UnwrapReadonlyObject<StandardSchemaDictionary.InferOutput<TSegments>>;
-} : EmptyObjectType) & (TSearchParams extends TSearchParamsDict ? {
-    /**
-     * Validated search params
-     */
-    readonly searchParams: UnwrapReadonlyObject<StandardSchemaDictionary.InferOutput<TSearchParams>>;
-} : EmptyObjectType) & (TBody extends TBodySchema ? {
-    /**
-     * Validated request body
-     */
-    readonly body: StandardSchemaV1.InferOutput<TBody>;
-} : EmptyObjectType) & (TFormData extends TFormDataDict ? {
-    /**
-     * Validated form data
-     */
-    readonly formData: UnwrapReadonlyObject<StandardSchemaDictionary.InferOutput<TFormData>>;
-} : EmptyObjectType);
-type AuthFunction<AC extends AuthContext | undefined, TSegments extends TSegmentsDict | undefined, TSearchParams extends TSearchParamsDict | undefined, TBody extends TBodySchema | undefined, TFormData extends TFormDataDict | undefined> = (params: AuthFunctionParams<TSegments, TSearchParams, TBody, TFormData>) => Awaitable<AC | Response>;
-type BaseOptions = {
-    /**
-     * ID for the route handler.
-     * Used when logging in development or when `debug` is enabled.
-     *
-     * You can also use it to add extra logging or monitoring.
-     */
-    id?: string;
-    /**
-     * Callback triggered when the request fails.
-     * By default it returns a simple `500` response and the error is logged into the console.
-     *
-     * Use it if your handler use custom errors and
-     * you want to manage them properly by returning a proper response.
-     */
-    onErrorResponse?: (err: unknown) => Awaitable<Response>;
-    /**
-     * Use this options to enable debug mode.
-     * It will add logs in the handler to help you debug the request.
-     *
-     * By default it's set to `false` for production builds.
-     * In development builds, it will be `true` if `NODE_ENV` is not set to `production`.
-     */
-    debug?: boolean;
-};
-type OnValidationErrorResponse = (issues: readonly StandardSchemaV1.Issue[]) => Awaitable<Response>;
-type CreateSafeRouteHandlerOptions<AC extends AuthContext | undefined, TSegments extends TSegmentsDict | undefined, TSearchParams extends TSearchParamsDict | undefined, TBody extends TBodySchema | undefined, TFormData extends TFormDataDict | undefined> = BaseOptions & {
-    /**
-     * Dynamic route segments used for the route handler path.
-     * By design it will handler if the segments are a `Promise` or not.
-     *
-     * Please note the expected input is a `StandardSchemaDictionary`.
-     */
-    segments?: TSegments;
-    /**
-     * Callback triggered when dynamic segments validations returned issues.
-     * By default it returns a simple `400` response and issues are logged into the console.
-     */
-    onSegmentsValidationErrorResponse?: OnValidationErrorResponse;
-    /**
-     * Search params used in the route.
-     *
-     * Please note the expected input is a `StandardSchemaDictionary`.
-     */
-    searchParams?: TSearchParams;
-    /**
-     * Callback triggered when search params validations returned issues.
-     * By default it returns a simple `400` response and issues are logged into the console.
-     */
-    onSearchParamsValidationErrorResponse?: OnValidationErrorResponse;
-    /**
-     * Request body.
-     *
-     * Returns a `405` response if the request method is not `POST`, 'PUT' or 'PATCH'.
-     * Returns a `415`response if the request does not explicitly set the `Content-Type` to `application/json`.
-     *
-     * IMPORTANT: The body is parsed as JSON, so it must be a valid JSON object!
-     * IMPORTANT: Body shouldn't be used with `formData` at the same time. They are exclusive.
-     * Why making the distinction? `formData` is used as a `StandardSchemaDictionary` whereas `body` is used as a `StandardSchemaV1`.
-     */
-    body?: TBody;
-    /**
-     * Callback triggered when body validation returned issues.
-     * By default it returns a simple `400` response and issues are logged into the console.
-     */
-    onBodyValidationErrorResponse?: OnValidationErrorResponse;
-    /**
-     * Request form data.
-     *
-     * Returns a `405` response if the request method is not `POST`, 'PUT' or 'PATCH'.
-     * Returns a `415`response if the request does not explicitly set the `Content-Type` to `multipart/form-data`
-     * or to `application/x-www-form-urlencoded`.
-     *
-     * IMPORTANT: formData shouldn't be used with `body` at the same time. They are exclusive.
-     * Why making the distinction? `formData` is used as a `StandardSchemaDictionary` whereas `body` is used as a `StandardSchemaV1`.
-     */
-    formData?: TFormData;
-    /**
-     * Callback triggered when form data validation returned issues.
-     * By default it returns a simple `400` response and issues are logged into the console.
-     */
-    onFormDataValidationErrorResponse?: OnValidationErrorResponse;
-    /**
-     * Function to use to authorize the request.
-     * By default it always authorize the request.
-     *
-     * When returning a response, it will be used as the response for the request.
-     * Return a response when the request is not authorized.
-     */
-    authorize?: AuthFunction<AC, TSegments, TSearchParams, TBody, TFormData>;
-};
-type ProvidedRouteContext = {
-    /**
-     * Route dynamic segments as params
-     */
-    params: Awaitable<any> | undefined;
-};
-type CreateSafeRouteHandlerReturnType<TReq extends Request = Request> = (
-/**
- * Original request
- */
-req: TReq, 
-/**
- * Provided context added by Next.js itself
- */
-providedContext: ProvidedRouteContext) => Promise<Response | never>;
-type SafeRouteHandlerContext<AC extends AuthContext | undefined, TSegments extends TSegmentsDict | undefined, TSearchParams extends TSearchParamsDict | undefined, TBody extends TBodySchema | undefined, TFormData extends TFormDataDict | undefined> = {
-    /**
-     * Route handler ID
-     */
-    readonly id: string;
-    /**
-     * Parsed request url
-     */
-    readonly url: URL;
-} & (AC extends AuthContext ? {
-    /**
-     * Auth context
-     */
-    readonly auth: AC;
-} : EmptyObjectType) & (TSegments extends TSegmentsDict ? {
-    /**
-     * Validated route dynamic segments
-     */
-    readonly segments: UnwrapReadonlyObject<StandardSchemaDictionary.InferOutput<TSegments>>;
-} : EmptyObjectType) & (TSearchParams extends TSearchParamsDict ? {
-    /**
-     * Validated search params
-     */
-    readonly searchParams: UnwrapReadonlyObject<StandardSchemaDictionary.InferOutput<TSearchParams>>;
-} : EmptyObjectType) & (TBody extends TBodySchema ? {
-    /**
-     * Validated request body
-     */
-    readonly body: StandardSchemaV1.InferOutput<TBody>;
-} : EmptyObjectType) & (TFormData extends TFormDataDict ? {
-    /**
-     * Validated form data
-     */
-    readonly formData: UnwrapReadonlyObject<StandardSchemaDictionary.InferOutput<TFormData>>;
-} : EmptyObjectType);
-type SafeRouteHandler<AC extends AuthContext | undefined, TSegments extends TSegmentsDict | undefined, TSearchParams extends TSearchParamsDict | undefined, TBody extends TBodySchema | undefined, TFormData extends TFormDataDict | undefined, TReq extends Request = Request> = (
-/**
- * Safe route handler context
- */
-ctx: SafeRouteHandlerContext<AC, TSegments, TSearchParams, TBody, TFormData>, 
-/**
- * Original request
- */
-req: TReq) => Promise<Response | never>;
-
-export { type AuthContext as A, type BaseOptions as B, type CreateSafeRouteHandlerOptions as C, type EmptyObjectType as E, type OnValidationErrorResponse as O, type ProvidedRouteContext as P, type SafeRouteHandler as S, type TSegmentsDict as T, type UnwrapReadonlyObject as U, type TSearchParamsDict as a, type TBodySchema as b, type TFormDataDict as c, type CreateSafeRouteHandlerReturnType as d, type AuthFunction as e, type AuthFunctionParams as f, type Awaitable as g, type SafeRouteHandlerContext as h, StandardSchemaDictionary as i, StandardSchemaV1 as j };

package/dist/types-D-blrRCr.d.ts

@@ -1,266 +0,0 @@
-/** The Standard Schema interface. */
-interface StandardSchemaV1<Input = unknown, Output = Input> {
-    /** The Standard Schema properties. */
-    readonly '~standard': StandardSchemaV1.Props<Input, Output>;
-}
-declare namespace StandardSchemaV1 {
-    /** The Standard Schema properties interface. */
-    interface Props<Input = unknown, Output = Input> {
-        /** The version number of the standard. */
-        readonly version: 1;
-        /** The vendor name of the schema library. */
-        readonly vendor: string;
-        /** Validates unknown input values. */
-        readonly validate: (value: unknown) => Result<Output> | Promise<Result<Output>>;
-        /** Inferred types associated with the schema. */
-        readonly types?: Types<Input, Output> | undefined;
-    }
-    /** The result interface of the validate function. */
-    type Result<Output> = SuccessResult<Output> | FailureResult;
-    /** The result interface if validation succeeds. */
-    interface SuccessResult<Output> {
-        /** The typed output value. */
-        readonly value: Output;
-        /** The non-existent issues. */
-        readonly issues?: undefined;
-    }
-    /** The result interface if validation fails. */
-    interface FailureResult {
-        /** The issues of failed validation. */
-        readonly issues: ReadonlyArray<Issue>;
-    }
-    /** The issue interface of the failure output. */
-    interface Issue {
-        /** The error message of the issue. */
-        readonly message: string;
-        /** The path of the issue, if any. */
-        readonly path?: ReadonlyArray<PropertyKey | PathSegment> | undefined;
-    }
-    /** The path segment interface of the issue. */
-    interface PathSegment {
-        /** The key representing a path segment. */
-        readonly key: PropertyKey;
-    }
-    /** The Standard Schema types interface. */
-    interface Types<Input = unknown, Output = Input> {
-        /** The input type of the schema. */
-        readonly input: Input;
-        /** The output type of the schema. */
-        readonly output: Output;
-    }
-    /** Infers the input type of a Standard Schema. */
-    type InferInput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['input'];
-    /** Infers the output type of a Standard Schema. */
-    type InferOutput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['output'];
-}
-type StandardSchemaDictionary<Input = Record<string, unknown>, Output extends Record<keyof Input, unknown> = Input> = {
-    [K in keyof Input]-?: StandardSchemaV1<Input[K], Output[K]>;
-};
-declare namespace StandardSchemaDictionary {
-    type InferInput<T extends StandardSchemaDictionary> = {
-        [K in keyof T]: StandardSchemaV1.InferInput<T[K]>;
-    };
-    type InferOutput<T extends StandardSchemaDictionary> = {
-        [K in keyof T]: StandardSchemaV1.InferOutput<T[K]>;
-    };
-}
-
-type EmptyObjectType = {};
-type UnwrapReadonlyObject<T> = T extends Readonly<infer U> ? U : T;
-type Awaitable<T> = T | PromiseLike<T>;
-type AuthContext = Record<string, unknown>;
-type TSegmentsDict = StandardSchemaDictionary;
-type TSearchParamsDict = StandardSchemaDictionary;
-type TBodySchema = StandardSchemaV1;
-type TFormDataDict = StandardSchemaDictionary;
-type AuthFunctionParams<TSegments extends TSegmentsDict | undefined, TSearchParams extends TSearchParamsDict | undefined, TBody extends TBodySchema | undefined, TFormData extends TFormDataDict | undefined> = {
-    /**
-     * ID for the route handler.
-     */
-    readonly id: string;
-    /**
-     * Parsed request url
-     */
-    readonly url: URL;
-    /**
-     * Original request
-     *
-     * Cloned from the incoming request to avoid side effects
-     * and to make it consumable in the `authorize` function.
-     * Due to `NextRequest` limitations as the req is cloned it's always a `Request`
-     */
-    req: Request;
-} & (TSegments extends TSegmentsDict ? {
-    /**
-     * Validated route dynamic segments
-     */
-    readonly segments: UnwrapReadonlyObject<StandardSchemaDictionary.InferOutput<TSegments>>;
-} : EmptyObjectType) & (TSearchParams extends TSearchParamsDict ? {
-    /**
-     * Validated search params
-     */
-    readonly searchParams: UnwrapReadonlyObject<StandardSchemaDictionary.InferOutput<TSearchParams>>;
-} : EmptyObjectType) & (TBody extends TBodySchema ? {
-    /**
-     * Validated request body
-     */
-    readonly body: StandardSchemaV1.InferOutput<TBody>;
-} : EmptyObjectType) & (TFormData extends TFormDataDict ? {
-    /**
-     * Validated form data
-     */
-    readonly formData: UnwrapReadonlyObject<StandardSchemaDictionary.InferOutput<TFormData>>;
-} : EmptyObjectType);
-type AuthFunction<AC extends AuthContext | undefined, TSegments extends TSegmentsDict | undefined, TSearchParams extends TSearchParamsDict | undefined, TBody extends TBodySchema | undefined, TFormData extends TFormDataDict | undefined> = (params: AuthFunctionParams<TSegments, TSearchParams, TBody, TFormData>) => Awaitable<AC | Response>;
-type BaseOptions = {
-    /**
-     * ID for the route handler.
-     * Used when logging in development or when `debug` is enabled.
-     *
-     * You can also use it to add extra logging or monitoring.
-     */
-    id?: string;
-    /**
-     * Callback triggered when the request fails.
-     * By default it returns a simple `500` response and the error is logged into the console.
-     *
-     * Use it if your handler use custom errors and
-     * you want to manage them properly by returning a proper response.
-     */
-    onErrorResponse?: (err: unknown) => Awaitable<Response>;
-    /**
-     * Use this options to enable debug mode.
-     * It will add logs in the handler to help you debug the request.
-     *
-     * By default it's set to `false` for production builds.
-     * In development builds, it will be `true` if `NODE_ENV` is not set to `production`.
-     */
-    debug?: boolean;
-};
-type OnValidationErrorResponse = (issues: readonly StandardSchemaV1.Issue[]) => Awaitable<Response>;
-type CreateSafeRouteHandlerOptions<AC extends AuthContext | undefined, TSegments extends TSegmentsDict | undefined, TSearchParams extends TSearchParamsDict | undefined, TBody extends TBodySchema | undefined, TFormData extends TFormDataDict | undefined> = BaseOptions & {
-    /**
-     * Dynamic route segments used for the route handler path.
-     * By design it will handler if the segments are a `Promise` or not.
-     *
-     * Please note the expected input is a `StandardSchemaDictionary`.
-     */
-    segments?: TSegments;
-    /**
-     * Callback triggered when dynamic segments validations returned issues.
-     * By default it returns a simple `400` response and issues are logged into the console.
-     */
-    onSegmentsValidationErrorResponse?: OnValidationErrorResponse;
-    /**
-     * Search params used in the route.
-     *
-     * Please note the expected input is a `StandardSchemaDictionary`.
-     */
-    searchParams?: TSearchParams;
-    /**
-     * Callback triggered when search params validations returned issues.
-     * By default it returns a simple `400` response and issues are logged into the console.
-     */
-    onSearchParamsValidationErrorResponse?: OnValidationErrorResponse;
-    /**
-     * Request body.
-     *
-     * Returns a `405` response if the request method is not `POST`, 'PUT' or 'PATCH'.
-     * Returns a `415`response if the request does not explicitly set the `Content-Type` to `application/json`.
-     *
-     * IMPORTANT: The body is parsed as JSON, so it must be a valid JSON object!
-     * IMPORTANT: Body shouldn't be used with `formData` at the same time. They are exclusive.
-     * Why making the distinction? `formData` is used as a `StandardSchemaDictionary` whereas `body` is used as a `StandardSchemaV1`.
-     */
-    body?: TBody;
-    /**
-     * Callback triggered when body validation returned issues.
-     * By default it returns a simple `400` response and issues are logged into the console.
-     */
-    onBodyValidationErrorResponse?: OnValidationErrorResponse;
-    /**
-     * Request form data.
-     *
-     * Returns a `405` response if the request method is not `POST`, 'PUT' or 'PATCH'.
-     * Returns a `415`response if the request does not explicitly set the `Content-Type` to `multipart/form-data`
-     * or to `application/x-www-form-urlencoded`.
-     *
-     * IMPORTANT: formData shouldn't be used with `body` at the same time. They are exclusive.
-     * Why making the distinction? `formData` is used as a `StandardSchemaDictionary` whereas `body` is used as a `StandardSchemaV1`.
-     */
-    formData?: TFormData;
-    /**
-     * Callback triggered when form data validation returned issues.
-     * By default it returns a simple `400` response and issues are logged into the console.
-     */
-    onFormDataValidationErrorResponse?: OnValidationErrorResponse;
-    /**
-     * Function to use to authorize the request.
-     * By default it always authorize the request.
-     *
-     * When returning a response, it will be used as the response for the request.
-     * Return a response when the request is not authorized.
-     */
-    authorize?: AuthFunction<AC, TSegments, TSearchParams, TBody, TFormData>;
-};
-type ProvidedRouteContext = {
-    /**
-     * Route dynamic segments as params
-     */
-    params: Awaitable<any> | undefined;
-};
-type CreateSafeRouteHandlerReturnType<TReq extends Request = Request> = (
-/**
- * Original request
- */
-req: TReq, 
-/**
- * Provided context added by Next.js itself
- */
-providedContext: ProvidedRouteContext) => Promise<Response | never>;
-type SafeRouteHandlerContext<AC extends AuthContext | undefined, TSegments extends TSegmentsDict | undefined, TSearchParams extends TSearchParamsDict | undefined, TBody extends TBodySchema | undefined, TFormData extends TFormDataDict | undefined> = {
-    /**
-     * Route handler ID
-     */
-    readonly id: string;
-    /**
-     * Parsed request url
-     */
-    readonly url: URL;
-} & (AC extends AuthContext ? {
-    /**
-     * Auth context
-     */
-    readonly auth: AC;
-} : EmptyObjectType) & (TSegments extends TSegmentsDict ? {
-    /**
-     * Validated route dynamic segments
-     */
-    readonly segments: UnwrapReadonlyObject<StandardSchemaDictionary.InferOutput<TSegments>>;
-} : EmptyObjectType) & (TSearchParams extends TSearchParamsDict ? {
-    /**
-     * Validated search params
-     */
-    readonly searchParams: UnwrapReadonlyObject<StandardSchemaDictionary.InferOutput<TSearchParams>>;
-} : EmptyObjectType) & (TBody extends TBodySchema ? {
-    /**
-     * Validated request body
-     */
-    readonly body: StandardSchemaV1.InferOutput<TBody>;
-} : EmptyObjectType) & (TFormData extends TFormDataDict ? {
-    /**
-     * Validated form data
-     */
-    readonly formData: UnwrapReadonlyObject<StandardSchemaDictionary.InferOutput<TFormData>>;
-} : EmptyObjectType);
-type SafeRouteHandler<AC extends AuthContext | undefined, TSegments extends TSegmentsDict | undefined, TSearchParams extends TSearchParamsDict | undefined, TBody extends TBodySchema | undefined, TFormData extends TFormDataDict | undefined, TReq extends Request = Request> = (
-/**
- * Safe route handler context
- */
-ctx: SafeRouteHandlerContext<AC, TSegments, TSearchParams, TBody, TFormData>, 
-/**
- * Original request
- */
-req: TReq) => Promise<Response | never>;
-
-export { type AuthContext as A, type BaseOptions as B, type CreateSafeRouteHandlerOptions as C, type EmptyObjectType as E, type OnValidationErrorResponse as O, type ProvidedRouteContext as P, type SafeRouteHandler as S, type TSegmentsDict as T, type UnwrapReadonlyObject as U, type TSearchParamsDict as a, type TBodySchema as b, type TFormDataDict as c, type CreateSafeRouteHandlerReturnType as d, type AuthFunction as e, type AuthFunctionParams as f, type Awaitable as g, type SafeRouteHandlerContext as h, StandardSchemaDictionary as i, StandardSchemaV1 as j };