@spinajs/http 2.0.180 → 2.0.181

package/lib/mjs/response-methods/notAllowed.js

@@ -1,17 +1,17 @@
-import { HTTP_STATUS_CODE } from '../interfaces.js';
-import { httpResponse } from '../responses.js';
-import { ErrorResponse } from './errorResponse.js';
-/**
- * Internall response function.
- * Returns HTTP 403 FORBIDDEN ERROR
- * @param err - error to send
- */
-export class NotAllowed extends ErrorResponse {
-    constructor(data) {
-        super(data);
-    }
-    async execute(_req, _res) {
-        return await httpResponse(this.responseData, HTTP_STATUS_CODE.NOT_ALLOWED, 'not-allowed.pug');
-    }
-}
+import { HTTP_STATUS_CODE } from '../interfaces.js';
+import { httpResponse } from '../responses.js';
+import { ErrorResponse } from './errorResponse.js';
+/**
+ * Internall response function.
+ * Returns HTTP 403 FORBIDDEN ERROR
+ * @param err - error to send
+ */
+export class NotAllowed extends ErrorResponse {
+    constructor(data) {
+        super(data);
+    }
+    async execute(_req, _res) {
+        return await httpResponse(this.responseData, HTTP_STATUS_CODE.NOT_ALLOWED, 'not-allowed.pug');
+    }
+}
 //# sourceMappingURL=notAllowed.js.map

package/lib/mjs/response-methods/notFound.d.ts

@@ -1,13 +1,13 @@
-/// <reference types="qs" />
-import * as express from 'express';
-import { ErrorResponse } from './errorResponse.js';
-/**
- * Internall response function.
- * Returns HTTP 404 NOT FOUND ERROR
- * @param err - error to send
- */
-export declare class NotFound extends ErrorResponse {
-    constructor(data?: any);
-    execute(_req: express.Request, _res: express.Response): Promise<(req: express.Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>, res: express.Response<any, Record<string, any>>) => void>;
-}
+/// <reference types="qs" />
+import * as express from 'express';
+import { ErrorResponse } from './errorResponse.js';
+/**
+ * Internall response function.
+ * Returns HTTP 404 NOT FOUND ERROR
+ * @param err - error to send
+ */
+export declare class NotFound extends ErrorResponse {
+    constructor(data?: any);
+    execute(_req: express.Request, _res: express.Response): Promise<(req: express.Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>, res: express.Response<any, Record<string, any>>) => void>;
+}
 //# sourceMappingURL=notFound.d.ts.map

package/lib/mjs/response-methods/notFound.js

@@ -1,17 +1,17 @@
-import { HTTP_STATUS_CODE } from '../interfaces.js';
-import { httpResponse } from '../responses.js';
-import { ErrorResponse } from './errorResponse.js';
-/**
- * Internall response function.
- * Returns HTTP 404 NOT FOUND ERROR
- * @param err - error to send
- */
-export class NotFound extends ErrorResponse {
-    constructor(data) {
-        super(data);
-    }
-    async execute(_req, _res) {
-        return await httpResponse(this.responseData, HTTP_STATUS_CODE.NOT_FOUND, 'notFound.pug');
-    }
-}
+import { HTTP_STATUS_CODE } from '../interfaces.js';
+import { httpResponse } from '../responses.js';
+import { ErrorResponse } from './errorResponse.js';
+/**
+ * Internall response function.
+ * Returns HTTP 404 NOT FOUND ERROR
+ * @param err - error to send
+ */
+export class NotFound extends ErrorResponse {
+    constructor(data) {
+        super(data);
+    }
+    async execute(_req, _res) {
+        return await httpResponse(this.responseData, HTTP_STATUS_CODE.NOT_FOUND, 'notFound.pug');
+    }
+}
 //# sourceMappingURL=notFound.js.map

package/lib/mjs/response-methods/ok.d.ts

@@ -1,13 +1,13 @@
-/// <reference types="qs" />
-import * as express from 'express';
-import { Response } from '../interfaces.js';
-/**
- * Internall response function.
- * Returns HTTP 200 OK response with json content
- * @param data - data to send
- */
-export declare class Ok extends Response {
-    constructor(data?: any);
-    execute(_req: express.Request, _res: express.Response): Promise<(req: express.Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>, res: express.Response<any, Record<string, any>>) => void>;
-}
+/// <reference types="qs" />
+import * as express from 'express';
+import { Response } from '../interfaces.js';
+/**
+ * Internall response function.
+ * Returns HTTP 200 OK response with json content
+ * @param data - data to send
+ */
+export declare class Ok extends Response {
+    constructor(data?: any);
+    execute(_req: express.Request, _res: express.Response): Promise<(req: express.Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>, res: express.Response<any, Record<string, any>>) => void>;
+}
 //# sourceMappingURL=ok.d.ts.map

package/lib/mjs/response-methods/ok.js

@@ -1,16 +1,16 @@
-import { HTTP_STATUS_CODE, Response } from '../interfaces.js';
-import { httpResponse } from '../responses.js';
-/**
- * Internall response function.
- * Returns HTTP 200 OK response with json content
- * @param data - data to send
- */
-export class Ok extends Response {
-    constructor(data) {
-        super(data);
-    }
-    async execute(_req, _res) {
-        return await httpResponse(this.responseData, HTTP_STATUS_CODE.OK, 'ok.pug');
-    }
-}
+import { HTTP_STATUS_CODE, Response } from '../interfaces.js';
+import { httpResponse } from '../responses.js';
+/**
+ * Internall response function.
+ * Returns HTTP 200 OK response with json content
+ * @param data - data to send
+ */
+export class Ok extends Response {
+    constructor(data) {
+        super(data);
+    }
+    async execute(_req, _res) {
+        return await httpResponse(this.responseData, HTTP_STATUS_CODE.OK, 'ok.pug');
+    }
+}
 //# sourceMappingURL=ok.js.map

package/lib/mjs/response-methods/redirect.d.ts

@@ -1,13 +1,13 @@
-import * as express from 'express';
-import { Response } from '../interfaces.js';
-/**
- * Redirects to another route ( simple alias for request.redirect for api consistency)
- *
- * @param url - url path to another location
- */
-export declare class Redirect extends Response {
-    protected url: string;
-    constructor(url: any);
-    execute(_req: express.Request, res: express.Response): Promise<void>;
-}
+import * as express from 'express';
+import { Response } from '../interfaces.js';
+/**
+ * Redirects to another route ( simple alias for request.redirect for api consistency)
+ *
+ * @param url - url path to another location
+ */
+export declare class Redirect extends Response {
+    protected url: string;
+    constructor(url: any);
+    execute(_req: express.Request, res: express.Response): Promise<void>;
+}
 //# sourceMappingURL=redirect.d.ts.map

package/lib/mjs/response-methods/redirect.js

@@ -1,16 +1,16 @@
-import { Response } from '../interfaces.js';
-/**
- * Redirects to another route ( simple alias for request.redirect for api consistency)
- *
- * @param url - url path to another location
- */
-export class Redirect extends Response {
-    constructor(url) {
-        super(null);
-        this.url = url;
-    }
-    async execute(_req, res) {
-        res.redirect(this.url);
-    }
-}
+import { Response } from '../interfaces.js';
+/**
+ * Redirects to another route ( simple alias for request.redirect for api consistency)
+ *
+ * @param url - url path to another location
+ */
+export class Redirect extends Response {
+    constructor(url) {
+        super(null);
+        this.url = url;
+    }
+    async execute(_req, res) {
+        res.redirect(this.url);
+    }
+}
 //# sourceMappingURL=redirect.js.map

package/lib/mjs/response-methods/serverError.d.ts

@@ -1,13 +1,13 @@
-/// <reference types="qs" />
-import * as express from 'express';
-import { ErrorResponse } from './errorResponse.js';
-/**
- * Internall response function.
- * Returns HTTP 500 INTERNAL SERVER ERROR
- * @param err - error to send
- */
-export declare class ServerError extends ErrorResponse {
-    constructor(data: any);
-    execute(_req: express.Request, _res: express.Response): Promise<(req: express.Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>, res: express.Response<any, Record<string, any>>) => void>;
-}
+/// <reference types="qs" />
+import * as express from 'express';
+import { ErrorResponse } from './errorResponse.js';
+/**
+ * Internall response function.
+ * Returns HTTP 500 INTERNAL SERVER ERROR
+ * @param err - error to send
+ */
+export declare class ServerError extends ErrorResponse {
+    constructor(data: any);
+    execute(_req: express.Request, _res: express.Response): Promise<(req: express.Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>, res: express.Response<any, Record<string, any>>) => void>;
+}
 //# sourceMappingURL=serverError.d.ts.map

package/lib/mjs/response-methods/serverError.js

@@ -1,17 +1,17 @@
-import { HTTP_STATUS_CODE } from '../interfaces.js';
-import { httpResponse } from '../responses.js';
-import { ErrorResponse } from './errorResponse.js';
-/**
- * Internall response function.
- * Returns HTTP 500 INTERNAL SERVER ERROR
- * @param err - error to send
- */
-export class ServerError extends ErrorResponse {
-    constructor(data) {
-        super(data);
-    }
-    async execute(_req, _res) {
-        return await httpResponse({ error: this.responseData }, HTTP_STATUS_CODE.INTERNAL_ERROR, 'serverError.pug');
-    }
-}
+import { HTTP_STATUS_CODE } from '../interfaces.js';
+import { httpResponse } from '../responses.js';
+import { ErrorResponse } from './errorResponse.js';
+/**
+ * Internall response function.
+ * Returns HTTP 500 INTERNAL SERVER ERROR
+ * @param err - error to send
+ */
+export class ServerError extends ErrorResponse {
+    constructor(data) {
+        super(data);
+    }
+    async execute(_req, _res) {
+        return await httpResponse({ error: this.responseData }, HTTP_STATUS_CODE.INTERNAL_ERROR, 'serverError.pug');
+    }
+}
 //# sourceMappingURL=serverError.js.map

package/lib/mjs/response-methods/template.d.ts

@@ -1,16 +1,16 @@
-/// <reference types="qs" />
-import { fs } from '@spinajs/fs';
-import * as express from 'express';
-import { HTTP_STATUS_CODE, ITemplateResponseOptions, Response } from '../interfaces.js';
-/**
- * HTML resposne with HTML from pug file
- */
-export declare class TemplateResponse extends Response {
-    protected file: string;
-    protected status: HTTP_STATUS_CODE;
-    protected fsTemplates: fs;
-    protected templateFile: string | ITemplateResponseOptions;
-    constructor(file: string | ITemplateResponseOptions, model: any, status?: HTTP_STATUS_CODE);
-    execute(_req: express.Request, _res: express.Response): Promise<(req: express.Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>, res: express.Response<any, Record<string, any>>) => void>;
-}
+/// <reference types="qs" />
+import { fs } from '@spinajs/fs';
+import * as express from 'express';
+import { HTTP_STATUS_CODE, ITemplateResponseOptions, Response } from '../interfaces.js';
+/**
+ * HTML resposne with HTML from pug file
+ */
+export declare class TemplateResponse extends Response {
+    protected file: string;
+    protected status: HTTP_STATUS_CODE;
+    protected fsTemplates: fs;
+    protected templateFile: string | ITemplateResponseOptions;
+    constructor(file: string | ITemplateResponseOptions, model: any, status?: HTTP_STATUS_CODE);
+    execute(_req: express.Request, _res: express.Response): Promise<(req: express.Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>, res: express.Response<any, Record<string, any>>) => void>;
+}
 //# sourceMappingURL=template.d.ts.map

package/lib/mjs/response-methods/template.js

@@ -1,30 +1,30 @@
-import { DI } from '@spinajs/di';
-import { IOFail } from '@spinajs/exceptions';
-import _ from 'lodash';
-import { HTTP_STATUS_CODE, Response } from '../interfaces.js';
-import { htmlResponse } from '../responses.js';
-/**
- * HTML resposne with HTML from pug file
- */
-export class TemplateResponse extends Response {
-    constructor(file, model, status) {
-        super(model);
-        this.status = null;
-        this.fsTemplates = _.isString(file)
-            ? DI.resolve('__file_provider__', ['__fs_http_templates__'])
-            : DI.resolve('__file_provider__', [file.provider]);
-        this.templateFile = file;
-        this.status = status;
-    }
-    async execute(_req, _res) {
-        if (!this.fsTemplates) {
-            const provider = _.isString(this.templateFile) ? '__fs_http_templates__' : this.templateFile.provider;
-            throw new IOFail(`Cannot find template file provider ${provider}. Please check configuration for provider or make sure that __fs_http_templates__ is configured.`);
-        }
-        this.file = _.isString(this.templateFile)
-            ? await this.fsTemplates.download(this.templateFile)
-            : await this.fsTemplates.download(this.templateFile.template);
-        return await htmlResponse(this.file, this.responseData, this.status ? this.status : HTTP_STATUS_CODE.OK);
-    }
-}
+import { DI } from '@spinajs/di';
+import { IOFail } from '@spinajs/exceptions';
+import _ from 'lodash';
+import { HTTP_STATUS_CODE, Response } from '../interfaces.js';
+import { htmlResponse } from '../responses.js';
+/**
+ * HTML resposne with HTML from pug file
+ */
+export class TemplateResponse extends Response {
+    constructor(file, model, status) {
+        super(model);
+        this.status = null;
+        this.fsTemplates = _.isString(file)
+            ? DI.resolve('__file_provider__', ['__fs_http_templates__'])
+            : DI.resolve('__file_provider__', [file.provider]);
+        this.templateFile = file;
+        this.status = status;
+    }
+    async execute(_req, _res) {
+        if (!this.fsTemplates) {
+            const provider = _.isString(this.templateFile) ? '__fs_http_templates__' : this.templateFile.provider;
+            throw new IOFail(`Cannot find template file provider ${provider}. Please check configuration for provider or make sure that __fs_http_templates__ is configured.`);
+        }
+        this.file = _.isString(this.templateFile)
+            ? await this.fsTemplates.download(this.templateFile)
+            : await this.fsTemplates.download(this.templateFile.template);
+        return await htmlResponse(this.file, this.responseData, this.status ? this.status : HTTP_STATUS_CODE.OK);
+    }
+}
 //# sourceMappingURL=template.js.map

package/lib/mjs/response-methods/unauthorized.d.ts

@@ -1,13 +1,13 @@
-/// <reference types="qs" />
-import * as express from 'express';
-import { ErrorResponse } from './errorResponse.js';
-/**
- * Internall response function.
- * Returns HTTP 401 UNAHTORIZED response with json content
- * @param data - data to send
- */
-export declare class Unauthorized extends ErrorResponse {
-    constructor(data: any);
-    execute(_req: express.Request, _res: express.Response): Promise<(req: express.Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>, res: express.Response<any, Record<string, any>>) => void>;
-}
+/// <reference types="qs" />
+import * as express from 'express';
+import { ErrorResponse } from './errorResponse.js';
+/**
+ * Internall response function.
+ * Returns HTTP 401 UNAHTORIZED response with json content
+ * @param data - data to send
+ */
+export declare class Unauthorized extends ErrorResponse {
+    constructor(data: any);
+    execute(_req: express.Request, _res: express.Response): Promise<(req: express.Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>, res: express.Response<any, Record<string, any>>) => void>;
+}
 //# sourceMappingURL=unauthorized.d.ts.map

package/lib/mjs/response-methods/unauthorized.js

@@ -1,17 +1,17 @@
-import { HTTP_STATUS_CODE } from '../interfaces.js';
-import { httpResponse } from '../responses.js';
-import { ErrorResponse } from './errorResponse.js';
-/**
- * Internall response function.
- * Returns HTTP 401 UNAHTORIZED response with json content
- * @param data - data to send
- */
-export class Unauthorized extends ErrorResponse {
-    constructor(data) {
-        super(data);
-    }
-    async execute(_req, _res) {
-        return await httpResponse(this.responseData, HTTP_STATUS_CODE.UNAUTHORIZED, 'responses/unauthorized');
-    }
-}
+import { HTTP_STATUS_CODE } from '../interfaces.js';
+import { httpResponse } from '../responses.js';
+import { ErrorResponse } from './errorResponse.js';
+/**
+ * Internall response function.
+ * Returns HTTP 401 UNAHTORIZED response with json content
+ * @param data - data to send
+ */
+export class Unauthorized extends ErrorResponse {
+    constructor(data) {
+        super(data);
+    }
+    async execute(_req, _res) {
+        return await httpResponse(this.responseData, HTTP_STATUS_CODE.UNAUTHORIZED, 'responses/unauthorized');
+    }
+}
 //# sourceMappingURL=unauthorized.js.map

package/lib/mjs/response-methods/validationError.d.ts

@@ -1,13 +1,13 @@
-/// <reference types="qs" />
-import * as express from 'express';
-import { ErrorResponse } from './errorResponse.js';
-/**
- * Internall response function.
- * Returns HTTP 400 BAD REQUEST ERROR
- * @param err - error to send
- */
-export declare class ValidationError extends ErrorResponse {
-    constructor(data: any);
-    execute(_req: express.Request, _res: express.Response): Promise<(req: express.Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>, res: express.Response<any, Record<string, any>>) => void>;
-}
+/// <reference types="qs" />
+import * as express from 'express';
+import { ErrorResponse } from './errorResponse.js';
+/**
+ * Internall response function.
+ * Returns HTTP 400 BAD REQUEST ERROR
+ * @param err - error to send
+ */
+export declare class ValidationError extends ErrorResponse {
+    constructor(data: any);
+    execute(_req: express.Request, _res: express.Response): Promise<(req: express.Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>, res: express.Response<any, Record<string, any>>) => void>;
+}
 //# sourceMappingURL=validationError.d.ts.map

package/lib/mjs/response-methods/validationError.js

@@ -1,17 +1,17 @@
-import { HTTP_STATUS_CODE } from '../interfaces.js';
-import { httpResponse } from '../responses.js';
-import { ErrorResponse } from './errorResponse.js';
-/**
- * Internall response function.
- * Returns HTTP 400 BAD REQUEST ERROR
- * @param err - error to send
- */
-export class ValidationError extends ErrorResponse {
-    constructor(data) {
-        super(data);
-    }
-    async execute(_req, _res) {
-        return await httpResponse(this.responseData, HTTP_STATUS_CODE.BAD_REQUEST, 'validationError.pug');
-    }
-}
+import { HTTP_STATUS_CODE } from '../interfaces.js';
+import { httpResponse } from '../responses.js';
+import { ErrorResponse } from './errorResponse.js';
+/**
+ * Internall response function.
+ * Returns HTTP 400 BAD REQUEST ERROR
+ * @param err - error to send
+ */
+export class ValidationError extends ErrorResponse {
+    constructor(data) {
+        super(data);
+    }
+    async execute(_req, _res) {
+        return await httpResponse(this.responseData, HTTP_STATUS_CODE.BAD_REQUEST, 'validationError.pug');
+    }
+}
 //# sourceMappingURL=validationError.js.map

package/lib/mjs/responses.d.ts

@@ -1,35 +1,35 @@
-import * as express from 'express';
-import { HTTP_STATUS_CODE } from './interfaces.js';
-/**
- * Sends data & sets proper header as json
- *
- * @param model - data to send
- * @param status - status code
- */
-export declare function jsonResponse(model: any, status?: HTTP_STATUS_CODE): (_req: express.Request, res: express.Response) => void;
-/**
- * Sends data & sets proper header as json
- *
- * @param model - data to send
- * @param status - status code
- */
-export declare function textResponse(model: any, status?: HTTP_STATUS_CODE): (_req: express.Request, res: express.Response) => void;
-/**
- * Sends html response & sets proper header. If template is not avaible, handles proper error rendering.
- *
- * @param file - template file path
- * @param model - data passed to template
- * @param status - optional status code
- */
-export declare function htmlResponse(file: string, model: any, status?: HTTP_STATUS_CODE): (req: express.Request, res: express.Response) => void;
-/**
- * Default response handling. Checks `Accept` header & matches proper response
- * For now its supports html & json responses
- *
- * @param model - data to send
- * @param code - status code
- * @param template - template to render without extension eg. `views/responses/ok`. It will try to match .pug, .xml or whatever to match response
- *                  to `Accept` header
- */
-export declare function httpResponse(model: any, code: HTTP_STATUS_CODE, template: string): (req: express.Request, res: express.Response) => void;
+import * as express from 'express';
+import { HTTP_STATUS_CODE } from './interfaces.js';
+/**
+ * Sends data & sets proper header as json
+ *
+ * @param model - data to send
+ * @param status - status code
+ */
+export declare function jsonResponse(model: any, status?: HTTP_STATUS_CODE): (_req: express.Request, res: express.Response) => void;
+/**
+ * Sends data & sets proper header as json
+ *
+ * @param model - data to send
+ * @param status - status code
+ */
+export declare function textResponse(model: any, status?: HTTP_STATUS_CODE): (_req: express.Request, res: express.Response) => void;
+/**
+ * Sends html response & sets proper header. If template is not avaible, handles proper error rendering.
+ *
+ * @param file - template file path
+ * @param model - data passed to template
+ * @param status - optional status code
+ */
+export declare function htmlResponse(file: string, model: any, status?: HTTP_STATUS_CODE): (req: express.Request, res: express.Response) => void;
+/**
+ * Default response handling. Checks `Accept` header & matches proper response
+ * For now its supports html & json responses
+ *
+ * @param model - data to send
+ * @param code - status code
+ * @param template - template to render without extension eg. `views/responses/ok`. It will try to match .pug, .xml or whatever to match response
+ *                  to `Accept` header
+ */
+export declare function httpResponse(model: any, code: HTTP_STATUS_CODE, template: string): (req: express.Request, res: express.Response) => void;
 //# sourceMappingURL=responses.d.ts.map