1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 | 1x 1x 1x 1x 1x 1x 1x 14x 1x 1x 1x 1x 1x 36x 1x 1x 1x 1x 1x 1x 40x 136x 136x 128x 8x 8x 8x 1x 1x 1x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x | 'use strict'; import * as express from 'express'; import 'multer'; import { InternalServer } from './server-container'; import { HttpMethod, ServiceFactory } from './server-types'; import * as _ from 'lodash'; import * as fs from 'fs-extra'; import * as YAML from 'yamljs'; import * as path from 'path'; /** * The Http server main class. */ export class Server { /** * Create the routes for all classes decorated with our decorators */ static buildServices(router: express.Router, ...types: any[]) { const iternalServer: InternalServer = new InternalServer(router); iternalServer.buildServices(types); } /** * Return all paths accepted by the Server */ static getPaths(): Array<string> { const result = new Array<string>(); InternalServer.getPaths().forEach(value => { result.push(value); }); return result; } /** * Register a custom serviceFactory. It will be used to instantiate the service Objects * If You plan to use a custom serviceFactory, You must ensure to call this method before any typescript-rest service declaration. */ static registerServiceFactory(serviceFactory: ServiceFactory) { InternalServer.serviceFactory = serviceFactory; } /** * Configure the Server to use [typescript-ioc](https://github.com/thiagobustamante/typescript-ioc) * to instantiate the service objects. * If You plan to use IoC, You must ensure to call this method before any typescript-rest service declaration. */ static useIoC() { const ioc = require('typescript-ioc'); Server.registerServiceFactory({ create: (serviceClass) => { return ioc.Container.get(serviceClass); }, getTargetClass: (serviceClass: Function) => { let typeConstructor: any = serviceClass; if (typeConstructor['name'] && typeConstructor['name'] !== 'ioc_wrapper') { return <FunctionConstructor>typeConstructor; } while (typeConstructor = typeConstructor['__parent']) { Eif (typeConstructor['name'] && typeConstructor['name'] !== 'ioc_wrapper') { return <FunctionConstructor>typeConstructor; } } throw TypeError('Can not identify the base Type for requested target'); } }); } /** * Return the set oh HTTP verbs configured for the given path * @param path The path to search HTTP verbs */ static getHttpMethods(path: string): Array<HttpMethod> { const result = new Array<HttpMethod>(); InternalServer.getHttpMethods(path).forEach(value => { result.push(value); }); return result; } /** * A string used for signing cookies. This is optional and if not specified, * will not parse signed cookies. * @param secret the secret used to sign */ static setCookiesSecret(secret: string) { InternalServer.cookiesSecret = secret; } /** * Specifies a function that will be used to decode a cookie's value. * This function can be used to decode a previously-encoded cookie value * into a JavaScript string. * The default function is the global decodeURIComponent, which will decode * any URL-encoded sequences into their byte representations. * * NOTE: if an error is thrown from this function, the original, non-decoded * cookie value will be returned as the cookie's value. * @param decoder The decoder function */ static setCookiesDecoder(decoder: (val: string) => string) { InternalServer.cookiesDecoder = decoder; } /** * Set where to store the uploaded files * @param dest Destination folder */ static setFileDest(dest: string) { InternalServer.fileDest = dest; } /** * Set a Function to control which files are accepted to upload * @param filter The filter function */ static setFileFilter(filter: (req: Express.Request, file: Express.Multer.File, callback: (error: Error, acceptFile: boolean) => void) => void) { InternalServer.fileFilter = filter; } /** * Set the limits of uploaded data * @param limit The data limit */ static setFileLimits(limit: number) { InternalServer.fileLimits = limit; } /** * Creates and endpoint to publish the swagger documentation. * @param router Express router * @param filePath the path to a swagger file (json or yaml) * @param endpoint where to publish the docs * @param host the hostname of the service * @param schemes the schemes used by the server */ static swagger(router: express.Router, filePath: string, endpoint: string, host?: string, schemes?: string[]) { const swaggerUi = require('swagger-ui-express'); Eif (_.startsWith(filePath, '.')) { filePath = path.join(process.cwd(), filePath); } let swaggerDocument: any; Eif (_.endsWith(filePath, '.yml') || _.endsWith(filePath, '.yaml')) { swaggerDocument = YAML.load(filePath); } else { swaggerDocument = fs.readJSONSync(filePath); } Eif (host) { swaggerDocument.host = host; } Eif (schemes) { swaggerDocument.schemes = schemes; } router.get(path.join('/', endpoint, 'json'), (req, res, next) => { res.send(swaggerDocument); }); router.get(path.join('/', endpoint, 'yaml'), (req, res, next) => { res.set('Content-Type', 'text/vnd.yaml'); res.send(YAML.stringify(swaggerDocument, 1000)); }); router.use(path.join('/', endpoint), swaggerUi.serve, swaggerUi.setup(swaggerDocument)); } } |