From 1922eb00839f4318442b4844d86adab6fe4ac001 Mon Sep 17 00:00:00 2001 From: David Ludwig Date: Mon, 10 May 2021 16:32:51 +0000 Subject: [PATCH] Add RESTful package to webserver package --- packages/restful/package.json | 8 ++- packages/restful/yarn.lock | 92 ++++++++++++++++++++++++ packages/webserver/package.json | 1 + packages/webserver/src/response/index.ts | 52 +------------- 4 files changed, 103 insertions(+), 50 deletions(-) create mode 100644 packages/restful/yarn.lock diff --git a/packages/restful/package.json b/packages/restful/package.json index ae97901..bb2af1a 100644 --- a/packages/restful/package.json +++ b/packages/restful/package.json @@ -3,9 +3,15 @@ "version": "0.0.0", "main": "dist/lib/index.js", "types": "dist/typings/index.d.ts", + "module": "src/index.ts", "license": "MIT", "scripts": { "build": "yarn run clean && tsc", "clean": "rimraf ./dist" - } + }, + "devDependencies": { + "@types/node": "^15.0.1", + "rimraf": "^3.0.2", + "typescript": "^4.2.4" + } } diff --git a/packages/restful/yarn.lock b/packages/restful/yarn.lock new file mode 100644 index 0000000..ba28a31 --- /dev/null +++ b/packages/restful/yarn.lock @@ -0,0 +1,92 @@ +# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. +# yarn lockfile v1 + + +"@types/node@^15.0.1": + version "15.0.2" + resolved "https://registry.yarnpkg.com/@types/node/-/node-15.0.2.tgz#51e9c0920d1b45936ea04341aa3e2e58d339fb67" + integrity sha512-p68+a+KoxpoB47015IeYZYRrdqMUcpbK8re/zpFB8Ld46LHC1lPEbp3EXgkEhAYEcPvjJF6ZO+869SQ0aH1dcA== + +balanced-match@^1.0.0: + version "1.0.2" + resolved "https://registry.yarnpkg.com/balanced-match/-/balanced-match-1.0.2.tgz#e83e3a7e3f300b34cb9d87f615fa0cbf357690ee" + integrity sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw== + +brace-expansion@^1.1.7: + version "1.1.11" + resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-1.1.11.tgz#3c7fcbf529d87226f3d2f52b966ff5271eb441dd" + integrity sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA== + dependencies: + balanced-match "^1.0.0" + concat-map "0.0.1" + +concat-map@0.0.1: + version "0.0.1" + resolved "https://registry.yarnpkg.com/concat-map/-/concat-map-0.0.1.tgz#d8a96bd77fd68df7793a73036a3ba0d5405d477b" + integrity sha1-2Klr13/Wjfd5OnMDajug1UBdR3s= + +fs.realpath@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/fs.realpath/-/fs.realpath-1.0.0.tgz#1504ad2523158caa40db4a2787cb01411994ea4f" + integrity sha1-FQStJSMVjKpA20onh8sBQRmU6k8= + +glob@^7.1.3: + version "7.1.7" + resolved "https://registry.yarnpkg.com/glob/-/glob-7.1.7.tgz#3b193e9233f01d42d0b3f78294bbeeb418f94a90" + integrity sha512-OvD9ENzPLbegENnYP5UUfJIirTg4+XwMWGaQfQTY0JenxNvvIKP3U3/tAQSPIu/lHxXYSZmpXlUHeqAIdKzBLQ== + dependencies: + fs.realpath "^1.0.0" + inflight "^1.0.4" + inherits "2" + minimatch "^3.0.4" + once "^1.3.0" + path-is-absolute "^1.0.0" + +inflight@^1.0.4: + version "1.0.6" + resolved "https://registry.yarnpkg.com/inflight/-/inflight-1.0.6.tgz#49bd6331d7d02d0c09bc910a1075ba8165b56df9" + integrity sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk= + dependencies: + once "^1.3.0" + wrappy "1" + +inherits@2: + version "2.0.4" + resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.4.tgz#0fa2c64f932917c3433a0ded55363aae37416b7c" + integrity sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ== + +minimatch@^3.0.4: + version "3.0.4" + resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.0.4.tgz#5166e286457f03306064be5497e8dbb0c3d32083" + integrity sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA== + dependencies: + brace-expansion "^1.1.7" + +once@^1.3.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/once/-/once-1.4.0.tgz#583b1aa775961d4b113ac17d9c50baef9dd76bd1" + integrity sha1-WDsap3WWHUsROsF9nFC6753Xa9E= + dependencies: + wrappy "1" + +path-is-absolute@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/path-is-absolute/-/path-is-absolute-1.0.1.tgz#174b9268735534ffbc7ace6bf53a5a9e1b5c5f5f" + integrity sha1-F0uSaHNVNP+8es5r9TpanhtcX18= + +rimraf@^3.0.2: + version "3.0.2" + resolved "https://registry.yarnpkg.com/rimraf/-/rimraf-3.0.2.tgz#f1a5402ba6220ad52cc1282bac1ae3aa49fd061a" + integrity sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA== + dependencies: + glob "^7.1.3" + +typescript@^4.2.4: + version "4.2.4" + resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.2.4.tgz#8610b59747de028fda898a8aef0e103f156d0961" + integrity sha512-V+evlYHZnQkaz8TRBuxTA92yZBPotr5H+WhQ7bD3hZUndx5tGOa1fuCgeSjxAzM1RiN5IzvadIXTVefuuwZCRg== + +wrappy@1: + version "1.0.2" + resolved "https://registry.yarnpkg.com/wrappy/-/wrappy-1.0.2.tgz#b5243d8f3ec1aa35f1364605bc0d1036e30ab69f" + integrity sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8= diff --git a/packages/webserver/package.json b/packages/webserver/package.json index 75fd1af..09dce52 100644 --- a/packages/webserver/package.json +++ b/packages/webserver/package.json @@ -10,6 +10,7 @@ }, "devDependencies": { "@autoplex/microservice": "^0.0.0", + "@autoplex/restful": "^0.0.0", "@types/node": "^15.0.1", "rimraf": "^3.0.2", "typescript": "^4.2.4" diff --git a/packages/webserver/src/response/index.ts b/packages/webserver/src/response/index.ts index 4877523..8817305 100644 --- a/packages/webserver/src/response/index.ts +++ b/packages/webserver/src/response/index.ts @@ -1,56 +1,10 @@ +import { IResponse, Status, statusMessage } from "@autoplex/restful"; import { FastifyReply } from "fastify"; /** - * The basic response schema + * Re-export the RESTful response info for convenience */ -export interface IResponse { - result?: T, - status : string -} - -/** - * Supported status codes - */ -export enum Status { - Ok = 200, - BadRequest = 400, - Unauthorized = 401, - Forbidden = 403, - NotFound = 404, - Conflict = 409, - Gone = 410, - PayloadTooLarge = 413, - UnprocessableEntity = 422, - InternalServerError = 500 -} - -/** - * Create a response - */ -function statusMessage(status: Status): string { - switch(status) { - case Status.Ok: - return "OK" - case Status.BadRequest: - return "Bad Request"; - case Status.Unauthorized: - return "Unauthorized"; - case Status.Forbidden: - return "Forbidden"; - case Status.NotFound: - return "Not Found"; - case Status.Conflict: - return "Conflict"; - case Status.Gone: - return "Gone"; - case Status.PayloadTooLarge: - return "Payload Too Large"; - case Status.UnprocessableEntity: - return "Unprocessable Entity"; - case Status.InternalServerError: - return "Internal Server Error"; - } -} +export { IResponse, Status, statusMessage }; /** * Respond to a request