@nmshd/typescript-rest 3.0.5

package/dist/server/model/errors.js

@@ -0,0 +1,178 @@
+'use strict';
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotImplementedError = exports.InternalServerError = exports.UnprocessableEntityError = exports.UnsupportedMediaTypeError = exports.GoneError = exports.ConflictError = exports.NotAcceptableError = exports.MethodNotAllowedError = exports.NotFoundError = exports.ForbiddenError = exports.UnauthorizedError = exports.BadRequestError = exports.HttpError = void 0;
+/**
+ * The Base class for all HTTP errors
+ */
+class HttpError extends Error {
+    constructor(name, message) {
+        super(message);
+        this.message = message;
+        this.name = name;
+    }
+}
+exports.HttpError = HttpError;
+/**
+ * Represents a BAD REQUEST error. The request could not be understood by the
+ * server due to malformed syntax. The client SHOULD NOT repeat the request
+ * without modifications.
+ */
+class BadRequestError extends HttpError {
+    constructor(message) {
+        super('BadRequestError', message || 'Bad Request');
+        Object.setPrototypeOf(this, BadRequestError.prototype);
+        this.statusCode = 400;
+    }
+}
+exports.BadRequestError = BadRequestError;
+/**
+ * Represents an UNAUTHORIZED error. The request requires user authentication. The response
+ * MUST include a WWW-Authenticate header field containing a challenge applicable to the
+ * requested resource.
+ */
+class UnauthorizedError extends HttpError {
+    constructor(message) {
+        super('UnauthorizedError', message || 'Unauthorized');
+        Object.setPrototypeOf(this, UnauthorizedError.prototype);
+        this.statusCode = 401;
+    }
+}
+exports.UnauthorizedError = UnauthorizedError;
+/**
+ * Represents a FORBIDDEN error. The server understood the request, but is refusing to
+ * fulfill it. Authorization will not help and the request SHOULD NOT be repeated.
+ */
+class ForbiddenError extends HttpError {
+    constructor(message) {
+        super('ForbiddenError', message || 'Forbidden');
+        Object.setPrototypeOf(this, ForbiddenError.prototype);
+        this.statusCode = 403;
+    }
+}
+exports.ForbiddenError = ForbiddenError;
+/**
+ * Represents a NOT FOUND error. The server has not found anything matching
+ * the Request-URI. No indication is given of whether the condition is temporary
+ * or permanent. The 410 (GoneError) status code SHOULD be used if the server knows,
+ * through some internally configurable mechanism, that an old resource is permanently
+ * unavailable and has no forwarding address.
+ *
+ * This error is commonly used when
+ * the server does not wish to reveal exactly why the request has been refused,
+ * or when no other response is applicable.
+ */
+class NotFoundError extends HttpError {
+    constructor(message) {
+        super('NotFoundError', message || 'Not Found');
+        Object.setPrototypeOf(this, NotFoundError.prototype);
+        this.statusCode = 404;
+    }
+}
+exports.NotFoundError = NotFoundError;
+/**
+ * Represents a METHOD NOT ALLOWED error. The method specified in the Request-Line is not allowed for
+ * the resource identified by the Request-URI. The response MUST include an Allow header
+ * containing a list of valid methods for the requested resource.
+ */
+class MethodNotAllowedError extends HttpError {
+    constructor(message) {
+        super('MethodNotAllowedError', message || 'Method Not Allowed');
+        Object.setPrototypeOf(this, MethodNotAllowedError.prototype);
+        this.statusCode = 405;
+    }
+}
+exports.MethodNotAllowedError = MethodNotAllowedError;
+/**
+ * Represents a NOT ACCEPTABLE error. The resource identified by the request is only capable of
+ * generating response entities which have content characteristics not acceptable according
+ * to the accept headers sent in the request.
+ */
+class NotAcceptableError extends HttpError {
+    constructor(message) {
+        super('NotAcceptableError', message || 'Not Acceptable');
+        Object.setPrototypeOf(this, NotAcceptableError.prototype);
+        this.statusCode = 406;
+    }
+}
+exports.NotAcceptableError = NotAcceptableError;
+/**
+ * Represents a CONFLICT error. The request could not be completed due to a
+ * conflict with the current state of the resource.
+ */
+class ConflictError extends HttpError {
+    constructor(message) {
+        super('ConflictError', message || 'Conflict');
+        Object.setPrototypeOf(this, ConflictError.prototype);
+        this.statusCode = 409;
+    }
+}
+exports.ConflictError = ConflictError;
+/**
+ * Represents a GONE error. The requested resource is no longer available at the server
+ * and no forwarding address is known. This condition is expected to be considered
+ * permanent. Clients with link editing capabilities SHOULD delete references to
+ * the Request-URI after user approval. If the server does not know, or has
+ * no facility to determine, whether or not the condition is permanent, the
+ * error 404 (NotFoundError) SHOULD be used instead. This response is
+ * cacheable unless indicated otherwise.
+ */
+class GoneError extends HttpError {
+    constructor(message) {
+        super('GoneError', message || 'Gone');
+        Object.setPrototypeOf(this, GoneError.prototype);
+        this.statusCode = 410;
+    }
+}
+exports.GoneError = GoneError;
+/**
+ * Represents an UNSUPPORTED MEDIA TYPE error. The server is refusing to service the request
+ * because the entity of the request is in a format not supported by the requested resource
+ * for the requested method.
+ */
+class UnsupportedMediaTypeError extends HttpError {
+    constructor(message) {
+        super('UnsupportedMediaTypeError', message || 'Unsupported Media Type');
+        Object.setPrototypeOf(this, UnsupportedMediaTypeError.prototype);
+        this.statusCode = 415;
+    }
+}
+exports.UnsupportedMediaTypeError = UnsupportedMediaTypeError;
+/**
+ * Represents a UNPROCESSABLE ENTITY error. The server understands the content type of the request entity
+ * (hence a 415 Unsupported Media Type status code is inappropriate), and the syntax of the request entity is correct
+ * (thus a 400 Bad Request status code is inappropriate) but was unable to process the contained instructions.
+ */
+class UnprocessableEntityError extends HttpError {
+    constructor(message) {
+        super('UnprocessableEntityError', message || 'Unprocessable Entity');
+        Object.setPrototypeOf(this, UnprocessableEntityError.prototype);
+        this.statusCode = 422;
+    }
+}
+exports.UnprocessableEntityError = UnprocessableEntityError;
+/**
+ * Represents an INTERNAL SERVER error. The server encountered an unexpected condition
+ * which prevented it from fulfilling the request.
+ */
+class InternalServerError extends HttpError {
+    constructor(message) {
+        super('InternalServerError', message || 'Internal Server Error');
+        Object.setPrototypeOf(this, InternalServerError.prototype);
+        this.statusCode = 500;
+    }
+}
+exports.InternalServerError = InternalServerError;
+/**
+ * Represents a NOT IMPLEMENTED error. The server does not support the functionality required
+ *  to fulfill the request. This is the appropriate response when the server does not recognize
+ * the request method and is not capable of supporting it for any resource.
+ */
+class NotImplementedError extends HttpError {
+    constructor(message) {
+        super('NotImplementedError', message || 'Not Implemented');
+        Object.setPrototypeOf(this, NotImplementedError.prototype);
+        this.statusCode = 501;
+    }
+}
+exports.NotImplementedError = NotImplementedError;
+//# sourceMappingURL=errors.js.map

package/dist/server/model/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../../src/server/model/errors.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;AAEb;;GAEG;AACH,MAAsB,SAAU,SAAQ,KAAK;IAGzC,YACI,IAAY,EACL,OAAe;QAEtB,KAAK,CAAC,OAAO,CAAC,CAAC;QAFR,YAAO,GAAP,OAAO,CAAQ;QAGtB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACrB,CAAC;CACJ;AAVD,8BAUC;AAED;;;;GAIG;AACH,MAAa,eAAgB,SAAQ,SAAS;IAC1C,YAAY,OAAgB;QACxB,KAAK,CAAC,iBAAiB,EAAE,OAAO,IAAI,aAAa,CAAC,CAAC;QACnD,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC;QACvD,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;IAC1B,CAAC;CACJ;AAND,0CAMC;AAED;;;;GAIG;AACH,MAAa,iBAAkB,SAAQ,SAAS;IAC5C,YAAY,OAAgB;QACxB,KAAK,CAAC,mBAAmB,EAAE,OAAO,IAAI,cAAc,CAAC,CAAC;QACtD,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,iBAAiB,CAAC,SAAS,CAAC,CAAC;QACzD,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;IAC1B,CAAC;CACJ;AAND,8CAMC;AAED;;;GAGG;AACH,MAAa,cAAe,SAAQ,SAAS;IACzC,YAAY,OAAgB;QACxB,KAAK,CAAC,gBAAgB,EAAE,OAAO,IAAI,WAAW,CAAC,CAAC;QAChD,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,cAAc,CAAC,SAAS,CAAC,CAAC;QACtD,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;IAC1B,CAAC;CACJ;AAND,wCAMC;AAED;;;;;;;;;;GAUG;AACH,MAAa,aAAc,SAAQ,SAAS;IACxC,YAAY,OAAgB;QACxB,KAAK,CAAC,eAAe,EAAE,OAAO,IAAI,WAAW,CAAC,CAAC;QAC/C,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;QACrD,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;IAC1B,CAAC;CACJ;AAND,sCAMC;AAED;;;;GAIG;AACH,MAAa,qBAAsB,SAAQ,SAAS;IAChD,YAAY,OAAgB;QACxB,KAAK,CAAC,uBAAuB,EAAE,OAAO,IAAI,oBAAoB,CAAC,CAAC;QAChE,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,qBAAqB,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;IAC1B,CAAC;CACJ;AAND,sDAMC;AAED;;;;GAIG;AACH,MAAa,kBAAmB,SAAQ,SAAS;IAC7C,YAAY,OAAgB;QACxB,KAAK,CAAC,oBAAoB,EAAE,OAAO,IAAI,gBAAgB,CAAC,CAAC;QACzD,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,kBAAkB,CAAC,SAAS,CAAC,CAAC;QAC1D,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;IAC1B,CAAC;CACJ;AAND,gDAMC;AACD;;;GAGG;AACH,MAAa,aAAc,SAAQ,SAAS;IACxC,YAAY,OAAgB;QACxB,KAAK,CAAC,eAAe,EAAE,OAAO,IAAI,UAAU,CAAC,CAAC;QAC9C,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;QACrD,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;IAC1B,CAAC;CACJ;AAND,sCAMC;AAED;;;;;;;;GAQG;AACH,MAAa,SAAU,SAAQ,SAAS;IACpC,YAAY,OAAgB;QACxB,KAAK,CAAC,WAAW,EAAE,OAAO,IAAI,MAAM,CAAC,CAAC;QACtC,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC;QACjD,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;IAC1B,CAAC;CACJ;AAND,8BAMC;AAED;;;;GAIG;AACH,MAAa,yBAA0B,SAAQ,SAAS;IACpD,YAAY,OAAgB;QACxB,KAAK,CAAC,2BAA2B,EAAE,OAAO,IAAI,wBAAwB,CAAC,CAAC;QACxE,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,yBAAyB,CAAC,SAAS,CAAC,CAAC;QACjE,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;IAC1B,CAAC;CACJ;AAND,8DAMC;AAED;;;;GAIG;AACH,MAAa,wBAAyB,SAAQ,SAAS;IACnD,YAAY,OAAgB;QACxB,KAAK,CAAC,0BAA0B,EAAE,OAAO,IAAI,sBAAsB,CAAC,CAAC;QACrE,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,wBAAwB,CAAC,SAAS,CAAC,CAAC;QAChE,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;IAC1B,CAAC;CACJ;AAND,4DAMC;AAED;;;GAGG;AACH,MAAa,mBAAoB,SAAQ,SAAS;IAC9C,YAAY,OAAgB;QACxB,KAAK,CAAC,qBAAqB,EAAE,OAAO,IAAI,uBAAuB,CAAC,CAAC;QACjE,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,mBAAmB,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;IAC1B,CAAC;CACJ;AAND,kDAMC;AAED;;;;GAIG;AACH,MAAa,mBAAoB,SAAQ,SAAS;IAC9C,YAAY,OAAgB;QACxB,KAAK,CAAC,qBAAqB,EAAE,OAAO,IAAI,iBAAiB,CAAC,CAAC;QAC3D,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,mBAAmB,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;IAC1B,CAAC;CACJ;AAND,kDAMC"}

package/dist/server/model/metadata.d.ts

@@ -0,0 +1,91 @@
+import { HttpMethod, ParserType, ServiceProcessor } from './server-types';
+export interface ServiceProperty {
+    type: ParamType;
+    name: string;
+    propertyType: any;
+}
+/**
+ * Metadata for REST service classes
+ */
+export declare class ServiceClass {
+    [key: string]: any;
+    targetClass: any;
+    path: string;
+    authenticator: Record<string, Array<string>>;
+    preProcessors: Array<ServiceProcessor>;
+    postProcessors: Array<ServiceProcessor>;
+    methods: Map<string, ServiceMethod>;
+    bodyParserOptions: any;
+    bodyParserType: ParserType;
+    languages: Array<string>;
+    accepts: Array<string>;
+    properties: Map<string, ServiceProperty>;
+    isAbstract: boolean;
+    ignoreNextMiddlewares: boolean;
+    constructor(targetClass: any);
+    addProperty(key: string, property: ServiceProperty): void;
+    hasProperties(): boolean;
+}
+/**
+ * Metadata for REST service methods
+ */
+export declare class ServiceMethod {
+    [key: string]: any;
+    name: string;
+    path: string;
+    authenticator: Record<string, Array<string>>;
+    resolvedPath: string;
+    httpMethod: HttpMethod;
+    parameters: Array<MethodParam>;
+    mustParseCookies: boolean;
+    files: Array<FileParam>;
+    mustParseBody: boolean;
+    bodyParserOptions: any;
+    bodyParserType: ParserType;
+    mustParseForms: boolean;
+    acceptMultiTypedParam: boolean;
+    languages: Array<string>;
+    accepts: Array<string>;
+    resolvedLanguages: Array<string>;
+    resolvedAccepts: Array<string>;
+    preProcessors: Array<ServiceProcessor>;
+    postProcessors: Array<ServiceProcessor>;
+    ignoreNextMiddlewares: boolean;
+}
+/**
+ * Metadata for File parameters on REST methods
+ */
+export declare class FileParam {
+    name: string;
+    singleFile: boolean;
+    constructor(name: string, singleFile: boolean);
+}
+/**
+ * Metadata for REST service method parameters
+ */
+export declare class MethodParam {
+    name: string;
+    type: Function;
+    paramType: ParamType;
+    constructor(name: string, type: Function, paramType: ParamType);
+}
+/**
+ * Enumeration of accepted parameter types
+ */
+export declare enum ParamType {
+    path = "path",
+    query = "query",
+    header = "header",
+    cookie = "cookie",
+    form = "form",
+    body = "body",
+    param = "param",
+    file = "file",
+    files = "files",
+    context = "context",
+    context_request = "context_request",
+    context_response = "context_response",
+    context_next = "context_next",
+    context_accept = "context_accept",
+    context_accept_language = "context_accept_language"
+}

package/dist/server/model/metadata.js

@@ -0,0 +1,80 @@
+'use strict';
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParamType = exports.MethodParam = exports.FileParam = exports.ServiceMethod = exports.ServiceClass = void 0;
+/**
+ * Metadata for REST service classes
+ */
+class ServiceClass {
+    constructor(targetClass) {
+        this.isAbstract = false;
+        this.ignoreNextMiddlewares = false;
+        this.targetClass = targetClass;
+        this.methods = new Map();
+        this.properties = new Map();
+    }
+    addProperty(key, property) {
+        this.properties.set(key, property);
+    }
+    hasProperties() {
+        return this.properties && this.properties.size > 0;
+    }
+}
+exports.ServiceClass = ServiceClass;
+/**
+ * Metadata for REST service methods
+ */
+class ServiceMethod {
+    constructor() {
+        this.parameters = new Array();
+        this.mustParseCookies = false;
+        this.files = new Array();
+        this.mustParseBody = false;
+        this.mustParseForms = false;
+        this.acceptMultiTypedParam = false;
+        this.ignoreNextMiddlewares = false;
+    }
+}
+exports.ServiceMethod = ServiceMethod;
+/**
+ * Metadata for File parameters on REST methods
+ */
+class FileParam {
+    constructor(name, singleFile) {
+        this.name = name;
+        this.singleFile = singleFile;
+    }
+}
+exports.FileParam = FileParam;
+/**
+ * Metadata for REST service method parameters
+ */
+class MethodParam {
+    constructor(name, type, paramType) {
+        this.name = name;
+        this.type = type;
+        this.paramType = paramType;
+    }
+}
+exports.MethodParam = MethodParam;
+/**
+ * Enumeration of accepted parameter types
+ */
+var ParamType;
+(function (ParamType) {
+    ParamType["path"] = "path";
+    ParamType["query"] = "query";
+    ParamType["header"] = "header";
+    ParamType["cookie"] = "cookie";
+    ParamType["form"] = "form";
+    ParamType["body"] = "body";
+    ParamType["param"] = "param";
+    ParamType["file"] = "file";
+    ParamType["files"] = "files";
+    ParamType["context"] = "context";
+    ParamType["context_request"] = "context_request";
+    ParamType["context_response"] = "context_response";
+    ParamType["context_next"] = "context_next";
+    ParamType["context_accept"] = "context_accept";
+    ParamType["context_accept_language"] = "context_accept_language";
+})(ParamType || (exports.ParamType = ParamType = {}));
+//# sourceMappingURL=metadata.js.map

package/dist/server/model/metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../../src/server/model/metadata.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;AAUb;;GAEG;AACH,MAAa,YAAY;IAgBrB,YAAY,WAAgB;QAFrB,eAAU,GAAY,KAAK,CAAC;QAC5B,0BAAqB,GAAY,KAAK,CAAC;QAE1C,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,EAAyB,CAAC;QAChD,IAAI,CAAC,UAAU,GAAG,IAAI,GAAG,EAA2B,CAAC;IACzD,CAAC;IAEM,WAAW,CAAC,GAAW,EAAE,QAAyB;QACrD,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IACvC,CAAC;IAEM,aAAa;QAChB,OAAO,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,GAAG,CAAC,CAAC;IACvD,CAAC;CACJ;AA7BD,oCA6BC;AAED;;GAEG;AACH,MAAa,aAAa;IAA1B;QAQW,eAAU,GAAuB,IAAI,KAAK,EAAe,CAAC;QAC1D,qBAAgB,GAAY,KAAK,CAAC;QAClC,UAAK,GAAqB,IAAI,KAAK,EAAa,CAAC;QACjD,kBAAa,GAAY,KAAK,CAAC;QAG/B,mBAAc,GAAY,KAAK,CAAC;QAChC,0BAAqB,GAAY,KAAK,CAAC;QAOvC,0BAAqB,GAAY,KAAK,CAAC;IAClD,CAAC;CAAA;AAvBD,sCAuBC;AAED;;GAEG;AACH,MAAa,SAAS;IAGlB,YAAY,IAAY,EAAE,UAAmB;QACzC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IACjC,CAAC;CACJ;AAPD,8BAOC;AAED;;GAEG;AACH,MAAa,WAAW;IAIpB,YAAY,IAAY,EAAE,IAAc,EAAE,SAAoB;QAC1D,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC/B,CAAC;CACJ;AATD,kCASC;AAED;;GAEG;AACH,IAAY,SAgBX;AAhBD,WAAY,SAAS;IACjB,0BAAa,CAAA;IACb,4BAAe,CAAA;IACf,8BAAiB,CAAA;IACjB,8BAAiB,CAAA;IACjB,0BAAa,CAAA;IACb,0BAAa,CAAA;IACb,4BAAe,CAAA;IACf,0BAAa,CAAA;IACb,4BAAe,CAAA;IACf,gCAAmB,CAAA;IACnB,gDAAmC,CAAA;IACnC,kDAAqC,CAAA;IACrC,0CAA6B,CAAA;IAC7B,8CAAiC,CAAA;IACjC,gEAAmD,CAAA;AACvD,CAAC,EAhBW,SAAS,yBAAT,SAAS,QAgBpB"}

package/dist/server/model/return-types.d.ts

@@ -0,0 +1,86 @@
+import { ReferencedResource } from './server-types';
+/**
+ * Inform that a new resource was created. Server will
+ * add a Location header and set status to 201
+ */
+export declare class NewResource<T> extends ReferencedResource<T> {
+    /**
+     * Constructor. Receives the location of the new resource created.
+     * @param location To be added to the Location header on response
+     * @param body To be added to the response body
+     */
+    constructor(location: string, body?: T);
+}
+/**
+ * Inform that the request was accepted but is not completed.
+ * A Location header should inform the location where the user
+ * can monitor his request processing status.
+ */
+export declare class RequestAccepted<T> extends ReferencedResource<T> {
+    /**
+     * Constructor. Receives the location where information about the
+     * request processing can be found.
+     * @param location To be added to the Location header on response
+     * @param body To be added to the response body
+     */
+    constructor(location: string, body?: T);
+}
+/**
+ * Inform that the resource has permanently
+ * moved to a new location, and that future references should use a
+ * new URI with their requests.
+ */
+export declare class MovedPermanently<T> extends ReferencedResource<T> {
+    /**
+     * Constructor. Receives the location where the resource can be found.
+     * @param location To be added to the Location header on response
+     * @param body To be added to the response body
+     */
+    constructor(location: string, body?: T);
+}
+/**
+ * Inform that the resource has temporarily
+ * moved to another location, but that future references should
+ * still use the original URI to access the resource.
+ */
+export declare class MovedTemporarily<T> extends ReferencedResource<T> {
+    /**
+     * Constructor. Receives the location where the resource can be found.
+     * @param location To be added to the Location header on response
+     * @param body To be added to the response body
+     */
+    constructor(location: string, body?: T);
+}
+/**
+ * Used to download a resource.
+ */
+export declare class DownloadResource {
+    filePath: string;
+    fileName: string;
+    /**
+     * Constructor.
+     * @param filePath The file path to download.
+     * @param fileName The file name
+     */
+    constructor(filePath: string, fileName: string);
+}
+/**
+ * Used to download binary data as a file.
+ */
+export declare class DownloadBinaryData {
+    content: Buffer;
+    mimeType: string;
+    fileName?: string;
+    /**
+     * Constructor. Receives the location of the resource.
+     * @param content The binary data to be downloaded as a file.
+     * @param mimeType The mime-type to be passed on Content-Type header.
+     * @param fileName The file name
+     */
+    constructor(content: Buffer, mimeType: string, fileName?: string);
+}
+/**
+ * If returned by a service, no response will be sent to client. Use it
+ * if you want to send the response by yourself.
+ */
+export declare const NoResponse: {};

package/dist/server/model/return-types.js

@@ -0,0 +1,110 @@
+'use strict';
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NoResponse = exports.DownloadBinaryData = exports.DownloadResource = exports.MovedTemporarily = exports.MovedPermanently = exports.RequestAccepted = exports.NewResource = void 0;
+const server_types_1 = require("./server-types");
+/**
+ * Inform that a new resource was created. Server will
+ * add a Location header and set status to 201
+ */
+class NewResource extends server_types_1.ReferencedResource {
+    /**
+     * Constructor. Receives the location of the new resource created.
+     * @param location To be added to the Location header on response
+     * @param body To be added to the response body
+     */
+    constructor(location, body) {
+        super(location, 201);
+        this.body = body;
+    }
+}
+exports.NewResource = NewResource;
+/**
+ * Inform that the request was accepted but is not completed.
+ * A Location header should inform the location where the user
+ * can monitor his request processing status.
+ */
+class RequestAccepted extends server_types_1.ReferencedResource {
+    /**
+     * Constructor. Receives the location where information about the
+     * request processing can be found.
+     * @param location To be added to the Location header on response
+     * @param body To be added to the response body
+     */
+    constructor(location, body) {
+        super(location, 202);
+        this.body = body;
+    }
+}
+exports.RequestAccepted = RequestAccepted;
+/**
+ * Inform that the resource has permanently
+ * moved to a new location, and that future references should use a
+ * new URI with their requests.
+ */
+class MovedPermanently extends server_types_1.ReferencedResource {
+    /**
+     * Constructor. Receives the location where the resource can be found.
+     * @param location To be added to the Location header on response
+     * @param body To be added to the response body
+     */
+    constructor(location, body) {
+        super(location, 301);
+        this.body = body;
+    }
+}
+exports.MovedPermanently = MovedPermanently;
+/**
+ * Inform that the resource has temporarily
+ * moved to another location, but that future references should
+ * still use the original URI to access the resource.
+ */
+class MovedTemporarily extends server_types_1.ReferencedResource {
+    /**
+     * Constructor. Receives the location where the resource can be found.
+     * @param location To be added to the Location header on response
+     * @param body To be added to the response body
+     */
+    constructor(location, body) {
+        super(location, 302);
+        this.body = body;
+    }
+}
+exports.MovedTemporarily = MovedTemporarily;
+/**
+ * Used to download a resource.
+ */
+class DownloadResource {
+    /**
+     * Constructor.
+     * @param filePath The file path to download.
+     * @param fileName The file name
+     */
+    constructor(filePath, fileName) {
+        this.filePath = filePath;
+        this.fileName = fileName;
+    }
+}
+exports.DownloadResource = DownloadResource;
+/**
+ * Used to download binary data as a file.
+ */
+class DownloadBinaryData {
+    /**
+     * Constructor. Receives the location of the resource.
+     * @param content The binary data to be downloaded as a file.
+     * @param mimeType The mime-type to be passed on Content-Type header.
+     * @param fileName The file name
+     */
+    constructor(content, mimeType, fileName) {
+        this.content = content;
+        this.mimeType = mimeType;
+        this.fileName = fileName;
+    }
+}
+exports.DownloadBinaryData = DownloadBinaryData;
+/**
+ * If returned by a service, no response will be sent to client. Use it
+ * if you want to send the response by yourself.
+ */
+exports.NoResponse = {};
+//# sourceMappingURL=return-types.js.map

package/dist/server/model/return-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"return-types.js","sourceRoot":"","sources":["../../../src/server/model/return-types.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;AAEb,iDAAoD;AAEpD;;;GAGG;AACH,MAAa,WAAe,SAAQ,iCAAqB;IACrD;;;;OAIG;IACH,YAAY,QAAgB,EAAE,IAAQ;QAClC,KAAK,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACrB,CAAC;CACJ;AAVD,kCAUC;AAED;;;;GAIG;AACH,MAAa,eAAmB,SAAQ,iCAAqB;IACzD;;;;;OAKG;IACH,YAAY,QAAgB,EAAE,IAAQ;QAClC,KAAK,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACrB,CAAC;CACJ;AAXD,0CAWC;AAED;;;;GAIG;AACH,MAAa,gBAAoB,SAAQ,iCAAqB;IAC1D;;;;OAIG;IACH,YAAY,QAAgB,EAAE,IAAQ;QAClC,KAAK,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACrB,CAAC;CACJ;AAVD,4CAUC;AAED;;;;GAIG;AACH,MAAa,gBAAoB,SAAQ,iCAAqB;IAC1D;;;;OAIG;IACH,YAAY,QAAgB,EAAE,IAAQ;QAClC,KAAK,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACrB,CAAC;CACJ;AAVD,4CAUC;AAED;;GAEG;AACH,MAAa,gBAAgB;IACzB;;;;OAIG;IACH,YACW,QAAgB,EAChB,QAAgB;QADhB,aAAQ,GAAR,QAAQ,CAAQ;QAChB,aAAQ,GAAR,QAAQ,CAAQ;IACxB,CAAC;CACP;AAVD,4CAUC;AAED;;GAEG;AACH,MAAa,kBAAkB;IAC3B;;;;;OAKG;IACH,YACW,OAAe,EACf,QAAgB,EAChB,QAAiB;QAFjB,YAAO,GAAP,OAAO,CAAQ;QACf,aAAQ,GAAR,QAAQ,CAAQ;QAChB,aAAQ,GAAR,QAAQ,CAAS;IACzB,CAAC;CACP;AAZD,gDAYC;AAED;;;GAGG;AACU,QAAA,UAAU,GAAG,EAAE,CAAC"}

package/dist/server/model/server-types.d.ts

@@ -0,0 +1,118 @@
+import * as express from 'express';
+/**
+ * Limits for file uploads
+ */
+export interface FileLimits {
+    /** Max field name size (Default: 100 bytes) */
+    fieldNameSize?: number;
+    /** Max field value size (Default: 1MB) */
+    fieldSize?: number;
+    /** Max number of non- file fields (Default: Infinity) */
+    fields?: number;
+    /** For multipart forms, the max file size (in bytes)(Default: Infinity) */
+    fileSize?: number;
+    /** For multipart forms, the max number of file fields (Default: Infinity) */
+    files?: number;
+    /** For multipart forms, the max number of parts (fields + files)(Default: Infinity) */
+    parts?: number;
+    /** For multipart forms, the max number of header key=> value pairs to parse Default: 2000(same as node's http). */
+    headerPairs?: number;
+}
+/**
+ * The supported HTTP methods.
+ */
+export declare enum HttpMethod {
+    GET = "GET",
+    POST = "POST",
+    PUT = "PUT",
+    DELETE = "DELETE",
+    HEAD = "HEAD",
+    OPTIONS = "OPTIONS",
+    PATCH = "PATCH"
+}
+/**
+ * Represents the current context of the request being handled.
+ */
+export declare class ServiceContext {
+    /**
+     * The resolved language to be used in the current request handling.
+     */
+    language: string;
+    /**
+     * The preferred media type to be used in the current request handling.
+     */
+    accept: string;
+    /**
+     * The request object.
+     */
+    request: express.Request;
+    /**
+     * The response object
+     */
+    response: express.Response;
+    /**
+     * The next function. It can be used to delegate to the next middleware
+     * registered the processing of the current request.
+     */
+    next: express.NextFunction;
+}
+/**
+ * Used to create a reference to a resource.
+ */
+export declare abstract class ReferencedResource<T> {
+    location: string;
+    statusCode: number;
+    /**
+     * the body to be sent
+     */
+    body: T;
+    /**
+     * Constructor. Receives the location of the resource.
+     * @param location To be added to the Location header on response
+     * @param statusCode the response status code to be sent
+     */
+    constructor(location: string, statusCode: number);
+}
+/**
+ * The factory used to instantiate the object services
+ */
+export interface ServiceFactory {
+    /**
+     * Create a new service object. Called before each request handling.
+     */
+    create: (serviceClass: Function, context: ServiceContext) => any;
+    /**
+     * Return the type used to handle requests to the target service.
+     * By default, returns the serviceClass received, but you can use this
+     * to implement IoC integrations, once some frameworks like typescript-ioc or
+     * Inversify can override constructors for injectable types.
+     */
+    getTargetClass: (serviceClass: Function) => FunctionConstructor;
+}
+/**
+ * An optional authenticator for rest services
+ */
+export interface ServiceAuthenticator {
+    /**
+     * Get the user list of roles.
+     */
+    getRoles: (req: express.Request, res: express.Response) => Array<string>;
+    /**
+     * Initialize the authenticator
+     */
+    initialize(router: express.Router): void;
+    /**
+     * Retrieve the middleware used to authenticate users.
+     */
+    getMiddleware(): express.RequestHandler;
+}
+export type ServiceProcessor = (req: express.Request, res?: express.Response) => void | Promise<void>;
+export type ParameterConverter = (paramValue: any) => any;
+/**
+ * The types of parsers to parse the message body
+ */
+export declare enum ParserType {
+    json = "json",
+    text = "text",
+    raw = "raw"
+}