@warlock.js/core 4.0.48 → 4.0.59

package/esm/http/request.d.ts

@@ -0,0 +1,380 @@
+/// <reference types="node" />
+import { trans } from "@mongez/localization";
+import type { LogLevel } from "@warlock.js/logger";
+import { BaseValidator } from "@warlock.js/seal";
+import type { FastifyRequest } from "fastify";
+import { type IncomingHttpHeaders } from "node:http2";
+import type { Middleware, Route } from "../router";
+import { Response } from "./response";
+import type { RequestEvent } from "./types";
+import { UploadedFile } from "./uploaded-file";
+type StandardHeaders = {
+    [K in keyof IncomingHttpHeaders as string extends K ? never : number extends K ? never : K]: IncomingHttpHeaders[K];
+};
+type HeaderKeys = keyof StandardHeaders;
+export declare class Request<User = any, RequestValidation = any> {
+    /**
+     * Fastify Request object
+     */
+    baseRequest: FastifyRequest;
+    /**
+     * Response Object
+     */
+    response: Response;
+    /**
+     * Route Object
+     */
+    route: Route;
+    /**
+     * Parsed Request Payload
+     */
+    protected payload: any;
+    /**
+     * Current user
+     */
+    user?: User;
+    /**
+     * Decoded access token payload (set by auth middleware)
+     */
+    decodedAccessToken?: any;
+    /**
+     * Current request instance
+     */
+    static current: Request;
+    /**
+     * Translation method
+     * Type of it is the same as the type of trans function
+     */
+    trans: ReturnType<typeof trans>;
+    /**
+     * Alias to trans method
+     */
+    t: ReturnType<typeof trans>;
+    /**
+     * Dynamic properties index signature
+     *
+     * This allows attaching custom properties to the request instance,
+     * commonly used during validation middleware to attach fetched models.
+     *
+     * @example
+     * // In validation middleware:
+     * const post = await Post.find(request.int("id"));
+     * if (!post) return response.notFound();
+     * request.post = post; // Attach the model to the request
+     *
+     * // In route handler:
+     * const post = request.post;
+     * // Work with the pre-fetched model
+     */
+    [key: string]: any;
+    /**
+     * Locale code
+     */
+    protected _locale: string;
+    /**
+     * Validated data
+     */
+    protected validatedData?: RequestValidation;
+    /**
+     * Request id
+     */
+    id: string;
+    /**
+     * Set request handler
+     */
+    setRequest(request: FastifyRequest): this;
+    /**
+     * Translate from the given locale code
+     */
+    transFrom(localeCode: string, keyword: string, placeholders?: any): any;
+    /**
+     * Get current locale code
+     */
+    get locale(): string;
+    /**
+     * Set locale code
+     */
+    set locale(localeCode: string);
+    /**
+     * Get locale code that will be used for translation
+     */
+    get localized(): any;
+    /**
+     * Set locale code
+     */
+    setLocaleCode(localeCode: string): this;
+    /**
+     * Get current locale code or return default locale code
+     */
+    getLocaleCode(defaultLocaleCode?: string): string;
+    /**
+     * Get http protocol
+     */
+    get protocol(): any;
+    /**
+     * Validate the given validation schema
+     */
+    validate(validation: BaseValidator, selectedInputs?: string[]): Promise<any>;
+    /**
+     * Clear current user
+     */
+    clearCurrentUser(): void;
+    /**
+     * Get value of the given header
+     */
+    header<TCustomHeader extends string = HeaderKeys>(name: TCustomHeader | HeaderKeys, defaultValue?: any): any;
+    /**
+     * Get the current request domain
+     */
+    get domain(): any;
+    /**
+     * Get hostname
+     */
+    get hostname(): any;
+    /**
+     * Get request origin
+     */
+    get origin(): string;
+    /**
+     * Get the domain of the origin
+     */
+    get originDomain(): string;
+    /**
+     * Get authorization header value
+     */
+    get authorizationValue(): string;
+    /**
+     * Get access token from Authorization header
+     *
+     * If the Authorization header does not start with `Bearer` value then return null
+     */
+    get accessToken(): string | undefined;
+    /**
+     * Get the authorization header
+     */
+    get authorization(): any;
+    /**
+     * Get current request method
+     */
+    get method(): string;
+    /**
+     * Parse the payload and merge it from the request body, params and query string
+     */
+    protected parsePayload(): void;
+    /**
+     * Parse body payload
+     */
+    protected parseBody(data: any): any;
+    /**
+     * Parse the given data
+     */
+    protected parseValue(data: any): any;
+    /**
+     * Set route handler
+     */
+    setRoute(route: Route): this;
+    /**
+     * Trigger an http event
+     */
+    trigger(eventName: RequestEvent, ...args: any[]): any;
+    /**
+     * Listen to the given event
+     */
+    on(eventName: RequestEvent, callback: any): any;
+    /**
+     * Make a log message
+     */
+    log(message: any, level?: LogLevel): void;
+    /**
+     * Get current request path
+     */
+    get path(): any;
+    /**
+     * {@alias}
+     */
+    get url(): any;
+    /**
+     * Get full url
+     */
+    get fullUrl(): string;
+    /**
+     * Run middleware
+     */
+    runMiddleware(): Promise<any[] | Response | Record<string, any>>;
+    /**
+     * Get route handler
+     */
+    getHandler(): import("../router").RouteHandler;
+    /**
+     * Get inputs that has been validated only
+     * You can also pass an array of inputs to get only the validated inputs
+     */
+    validated<Output = RequestValidation>(inputs?: string[]): Output;
+    /**
+     * Get inputs that has been validated except the given inputs
+     */
+    validatedExcept(...inputs: string[]): RequestValidation;
+    /**
+     * Set validated data
+     */
+    setValidatedData(data: RequestValidation): void;
+    /**
+     * Execute the request
+     */
+    execute(): Promise<any[] | Response | Record<string, any>>;
+    /**
+     * Execute middleware list of current route
+     */
+    protected executeMiddleware(): Promise<void | any[] | Response | Record<string, any>>;
+    /**
+     * Collect middlewares for current route
+     */
+    protected collectMiddlewares(): Middleware[];
+    /**
+     * Get request input value from query string, params or body
+     */
+    input(key: string, defaultValue?: any): any;
+    /**
+     * Get email input value, this will lowercase the value
+     */
+    email(key?: string, defaultValue?: string): string;
+    /**
+     * @alias input
+     */
+    get(key: string, defaultValue?: any): any;
+    /**
+     * Determine if request has input value
+     */
+    has(key: string): boolean;
+    /**
+     * Set request input value
+     */
+    set(key: string, value: any): this;
+    /**
+     * Set the given value if the request does not have the input
+     */
+    setDefault(key: string, value: any): this;
+    /**
+     * Unset request payload keys
+     */
+    unset(...keys: string[]): this;
+    /**
+     * Get request body
+     */
+    get body(): any;
+    /**
+     * Set request body value
+     */
+    setBody(key: string, value: any): this;
+    /**
+     * Get body inputs except files
+     */
+    get bodyInputs(): any;
+    /**
+     * Get request file in UploadedFile instance
+     */
+    file(key: string): UploadedFile | undefined;
+    /**
+     * Get uploaded files from the request for the given name
+     * If the given name is not present in the request, return an empty array
+     */
+    files(name: string): UploadedFile[];
+    /**
+     * Get request params
+     */
+    get params(): any;
+    /**
+     * Set request params value
+     */
+    setParam(key: string, value: any): this;
+    /**
+     * Get request query
+     */
+    get query(): any;
+    /**
+     * Set request query value
+     */
+    setQuery(key: string, value: any): this;
+    /**
+     * Get all inputs
+     */
+    all(): any;
+    /**
+     * Get all inputs except params
+     */
+    allExceptParams(): any;
+    /**
+     * Get all heavy inputs except params
+     */
+    heavyExceptParams(): any;
+    /**
+     * Get only heavy inputs, the input with a value
+     */
+    heavy(): any;
+    /**
+     * Get only the given keys from the request data
+     */
+    only(keys: string[]): any;
+    /**
+     * Pluck the given keys from the request data
+     */
+    pluck(keys: string[]): any;
+    /**
+     * Get all request inputs except the given keys
+     */
+    except(keys: string[]): any;
+    /**
+     * Get boolean input value
+     */
+    bool(key: string, defaultValue?: boolean): boolean;
+    /**
+     * Get integer input value
+     */
+    int(key: string, defaultValue?: number): number;
+    /**
+     * Shorthand getter to get id param
+     */
+    get idParam(): number;
+    /**
+     * Get string input value
+     */
+    string(key: string, defaultValue?: string): string;
+    /**
+     * Get float input value
+     */
+    float(key: string, defaultValue?: number): number;
+    /**
+     * Get number input value
+     */
+    number(key: string, defaultValue?: number): number;
+    /**
+     * Get request ip
+     */
+    get ip(): any;
+    /**
+     * Detect proper ip
+     */
+    detectIp(): any;
+    /**
+     * An alias to detectIp
+     */
+    get realIp(): any;
+    /**
+     * Get request ips
+     */
+    get ips(): any;
+    /**
+     * Get request referer
+     */
+    get referer(): any;
+    /**
+     * Get user agent
+     */
+    get userAgent(): any;
+    /**
+     * Get request headers
+     */
+    get headers(): any;
+}
+export {};
+//# sourceMappingURL=request.d.ts.map

package/esm/http/request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../src/http/request.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,KAAK,EAAa,MAAM,sBAAsB,CAAC;AAGxD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAEnD,OAAO,EAAE,aAAa,EAAK,MAAM,kBAAkB,CAAC;AACpD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAC9C,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAEtD,OAAO,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAGnD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C,KAAK,eAAe,GAAG;KAGpB,CAAC,IAAI,MAAM,mBAAmB,IAAI,MAAM,SAAS,CAAC,GAC/C,KAAK,GACL,MAAM,SAAS,CAAC,GACd,KAAK,GACL,CAAC,GAAG,mBAAmB,CAAC,CAAC,CAAC;CACjC,CAAC;AAEF,KAAK,UAAU,GAAG,MAAM,eAAe,CAAC;AAExC,qBAAa,OAAO,CAAC,IAAI,GAAG,GAAG,EAAE,iBAAiB,GAAG,GAAG;IACtD;;OAEG;IACI,WAAW,EAAG,cAAc,CAAC;IAEpC;;OAEG;IACI,QAAQ,EAAG,QAAQ,CAAC;IAE3B;;OAEG;IACI,KAAK,EAAG,KAAK,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,OAAO,EAAE,GAAG,CAAM;IAE5B;;OAEG;IACI,IAAI,CAAC,EAAE,IAAI,CAAC;IAEnB;;OAEG;IACI,kBAAkB,CAAC,EAAE,GAAG,CAAC;IAEhC;;OAEG;IACH,OAAc,OAAO,EAAE,OAAO,CAAC;IAE/B;;;OAGG;IACI,KAAK,EAAE,UAAU,CAAC,OAAO,KAAK,CAAC,CAAS;IAE/C;;OAEG;IACI,CAAC,EAAE,UAAU,CAAC,OAAO,KAAK,CAAC,CAAS;IAE3C;;;;;;;;;;;;;;;OAeG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,OAAO,SAAM;IAEvB;;OAEG;IACH,SAAS,CAAC,aAAa,CAAC,EAAE,iBAAiB,CAAC;IAE5C;;OAEG;IACI,EAAE,SAAqB;IAE9B;;OAEG;IACI,UAAU,CAAC,OAAO,EAAE,cAAc;IAYzC;;OAEG;IACI,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,GAAG;IAIxE;;OAEG;IACH,IAAW,MAAM,IASa,MAAM,CALnC;IAED;;OAEG;IACH,IAAW,MAAM,CAAC,UAAU,EAAE,MAAM,EAEnC;IAED;;OAEG;IACH,IAAW,SAAS,QAQnB;IAED;;OAEG;IACI,aAAa,CAAC,UAAU,EAAE,MAAM;IAMvC;;OAEG;IACI,aAAa,CAAC,iBAAiB,GAAE,MAA6C;IAIrF;;OAEG;IACH,IAAW,QAAQ,QAElB;IAED;;OAEG;IACU,QAAQ,CAAC,UAAU,EAAE,aAAa,EAAE,cAAc,CAAC,EAAE,MAAM,EAAE;IAI1E;;OAEG;IACI,gBAAgB;IAIvB;;OAEG;IACI,MAAM,CAAC,aAAa,SAAS,MAAM,GAAG,UAAU,EACrD,IAAI,EAAE,aAAa,GAAG,UAAU,EAChC,YAAY,GAAE,GAAU;IAK1B;;OAEG;IACH,IAAW,MAAM,QAEhB;IAED;;OAEG;IACH,IAAW,QAAQ,QAElB;IAED;;OAEG;IACH,IAAW,MAAM,WAEhB;IAED;;OAEG;IACH,IAAW,YAAY,WAQtB;IAED;;OAEG;IACH,IAAW,kBAAkB,IAAI,MAAM,CAUtC;IAED;;;;OAIG;IACH,IAAW,WAAW,IAAI,MAAM,GAAG,SAAS,CAU3C;IAED;;OAEG;IACH,IAAW,aAAa,QAEvB;IAED;;OAEG;IACH,IAAW,MAAM,IAAI,MAAM,CAE1B;IAED;;OAEG;IACH,SAAS,CAAC,YAAY;IAYtB;;OAEG;IACH,SAAS,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG;IA0F7B;;OAEG;IACH,SAAS,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG;IAmB9B;;OAEG;IACI,QAAQ,CAAC,KAAK,EAAE,KAAK;IAS5B;;OAEG;IACI,OAAO,CAAC,SAAS,EAAE,YAAY,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE;IAItD;;OAEG;IACI,EAAE,CAAC,SAAS,EAAE,YAAY,EAAE,QAAQ,EAAE,GAAG;IAIhD;;OAEG;IACI,GAAG,CAAC,OAAO,EAAE,GAAG,EAAE,KAAK,GAAE,QAAiB;IAcjD;;OAEG;IACH,IAAW,IAAI,QAEd;IAED;;OAEG;IACH,IAAW,GAAG,QAEb;IAED;;OAEG;IACH,IAAW,OAAO,WAEjB;IAED;;OAEG;IACU,aAAa;IAsB1B;;OAEG;IACI,UAAU;IAIjB;;;OAGG;IACI,SAAS,CAAC,MAAM,GAAG,iBAAiB,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM;IAQvE;;OAEG;IACI,eAAe,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,iBAAiB;IAI9D;;OAEG;IACI,gBAAgB,CAAC,IAAI,EAAE,iBAAiB;IAI/C;;OAEG;IACU,OAAO;IAcpB;;OAEG;cACa,iBAAiB;IAqCjC;;OAEG;IACH,SAAS,CAAC,kBAAkB,IAAI,UAAU,EAAE;IAW5C;;OAEG;IACI,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,GAAG;IAI5C;;OAEG;IACI,KAAK,CAAC,GAAG,GAAE,MAAgB,EAAE,YAAY,GAAE,MAAW,GAAG,MAAM;IAItE;;OAEG;IACI,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,GAAG;IAI1C;;OAEG;IACI,GAAG,CAAC,GAAG,EAAE,MAAM;IAItB;;OAEG;IACI,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAMlC;;OAEG;IACI,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAQzC;;OAEG;IACI,KAAK,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE;IAM9B;;OAEG;IACH,IAAW,IAAI,QAEd;IAED;;OAEG;IACI,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAMtC;;OAEG;IACH,IAAW,UAAU,QAcpB;IAED;;OAEG;IACI,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;IAMlD;;;OAGG;IACI,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,EAAE;IAI1C;;OAEG;IACH,IAAW,MAAM,QAEhB;IAED;;OAEG;IACI,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAMvC;;OAEG;IACH,IAAW,KAAK,QAEf;IAED;;OAEG;IACI,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAMvC;;OAEG;IACI,GAAG;IAIV;;OAEG;IACI,eAAe;IAOtB;;OAEG;IACI,iBAAiB;IAgBxB;;OAEG;IACI,KAAK;IAgBZ;;OAEG;IACI,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE;IAI1B;;OAEG;IACI,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE;IAQ3B;;OAEG;IACI,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE;IAI5B;;OAEG;IACI,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,UAAQ;IAkB7C;;OAEG;IACI,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,GAAE,MAAU,GAAG,MAAM;IAMzD;;OAEG;IACH,IAAW,OAAO,WAEjB;IAED;;OAEG;IACI,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,GAAE,MAAW,GAAG,MAAM;IAM7D;;OAEG;IACI,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,GAAE,MAAU,GAAG,MAAM;IAM3D;;OAEG;IACI,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,GAAE,MAAU,GAAG,MAAM;IAM5D;;OAEG;IACH,IAAW,EAAE,QAEZ;IAED;;OAEG;IACI,QAAQ;IAcf;;OAEG;IACH,IAAW,MAAM,QAEhB;IAED;;OAEG;IACH,IAAW,GAAG,QAEb;IAED;;OAEG;IACH,IAAW,OAAO,QAEjB;IAED;;OAEG;IACH,IAAW,SAAS,QAEnB;IAED;;OAEG;IACH,IAAW,OAAO,QAEjB;CACF"}