Add initial version

Author: flaviouk

.github/workflows/main.yml

@@ -0,0 +1,42 @@
+name: CI
+on: [push]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Begin CI...
+        uses: actions/checkout@v2
+
+      - name: Use Node 12
+        uses: actions/setup-node@v1
+        with:
+          node-version: 12.x
+
+      - name: Use cached node_modules
+        uses: actions/cache@v1
+        with:
+          path: node_modules
+          key: nodeModules-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            nodeModules-
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+        env:
+          CI: true
+
+      - name: Lint
+        run: yarn lint
+        env:
+          CI: true
+
+      - name: Test
+        run: yarn test --ci --coverage --maxWorkers=2
+        env:
+          CI: true
+
+      - name: Build
+        run: yarn build
+        env:
+          CI: true

.gitignore

@@ -0,0 +1,5 @@
+*.log
+.DS_Store
+node_modules
+dist
+.idea

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Flávio Carvalho
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,137 @@
+# simple-http-status
+
+## Why
+
+Heavily inspired by [Django Rest Framework](https://www.django-rest-framework.org/api-guide/status-codes)
+
+Using bare status codes in your responses isn't recommended. This package includes a set of named constants that you can use to make your code more obvious and readable.
+
+## Getting started
+
+```js
+yarn add simple-http-status
+```
+
+## Usage
+
+```ts
+import { Status } from 'simple-http-status';
+
+app.get('/', (req, res, next) => {
+  res.status(Status.HTTP_200_OK).send('Hello world');
+});
+```
+
+### Informational - 1xx
+
+This class of status code indicates a provisional response.
+
+```js
+HTTP_100_CONTINUE;
+HTTP_101_SWITCHING_PROTOCOLS;
+```
+
+### Successful - 2xx
+
+This class of status code indicates that the client's request was successfully received, understood, and accepted.
+
+```js
+HTTP_200_OK;
+HTTP_201_CREATED;
+HTTP_202_ACCEPTED;
+HTTP_203_NON_AUTHORITATIVE_INFORMATION;
+HTTP_204_NO_CONTENT;
+HTTP_205_RESET_CONTENT;
+HTTP_206_PARTIAL_CONTENT;
+HTTP_207_MULTI_STATUS;
+HTTP_208_ALREADY_REPORTED;
+HTTP_226_IM_USED;
+```
+
+### Redirection - 3xx
+
+This class of status code indicates that further action needs to be taken by the user agent in order to fulfill the request.
+
+```js
+HTTP_300_MULTIPLE_CHOICES;
+HTTP_301_MOVED_PERMANENTLY;
+HTTP_302_FOUND;
+HTTP_303_SEE_OTHER;
+HTTP_304_NOT_MODIFIED;
+HTTP_305_USE_PROXY;
+HTTP_306_RESERVED;
+HTTP_307_TEMPORARY_REDIRECT;
+HTTP_308_PERMANENT_REDIRECT;
+```
+
+### Client Error - 4xx
+
+The 4xx class of status code is intended for cases in which the client seems to have erred. Except when responding to a HEAD request, the server SHOULD include an entity containing an explanation of the error situation, and whether it is a temporary or permanent condition.
+
+```js
+HTTP_400_BAD_REQUEST;
+HTTP_401_UNAUTHORIZED;
+HTTP_402_PAYMENT_REQUIRED;
+HTTP_403_FORBIDDEN;
+HTTP_404_NOT_FOUND;
+HTTP_405_METHOD_NOT_ALLOWED;
+HTTP_406_NOT_ACCEPTABLE;
+HTTP_407_PROXY_AUTHENTICATION_REQUIRED;
+HTTP_408_REQUEST_TIMEOUT;
+HTTP_409_CONFLICT;
+HTTP_410_GONE;
+HTTP_411_LENGTH_REQUIRED;
+HTTP_412_PRECONDITION_FAILED;
+HTTP_413_REQUEST_ENTITY_TOO_LARGE;
+HTTP_414_REQUEST_URI_TOO_LONG;
+HTTP_415_UNSUPPORTED_MEDIA_TYPE;
+HTTP_416_REQUESTED_RANGE_NOT_SATISFIABLE;
+HTTP_417_EXPECTATION_FAILED;
+HTTP_422_UNPROCESSABLE_ENTITY;
+HTTP_423_LOCKED;
+HTTP_424_FAILED_DEPENDENCY;
+HTTP_426_UPGRADE_REQUIRED;
+HTTP_428_PRECONDITION_REQUIRED;
+HTTP_429_TOO_MANY_REQUESTS;
+HTTP_431_REQUEST_HEADER_FIELDS_TOO_LARGE;
+HTTP_451_UNAVAILABLE_FOR_LEGAL_REASONS;
+```
+
+### Server Error - 5xx
+
+Response status codes beginning with the digit "5" indicate cases in which the server is aware that it has erred or is incapable of performing the request. Except when responding to a HEAD request, the server SHOULD include an entity containing an explanation of the error situation, and whether it is a temporary or permanent condition.
+
+```js
+HTTP_500_INTERNAL_SERVER_ERROR;
+HTTP_501_NOT_IMPLEMENTED;
+HTTP_502_BAD_GATEWAY;
+HTTP_503_SERVICE_UNAVAILABLE;
+HTTP_504_GATEWAY_TIMEOUT;
+HTTP_505_HTTP_VERSION_NOT_SUPPORTED;
+HTTP_506_VARIANT_ALSO_NEGOTIATES;
+HTTP_507_INSUFFICIENT_STORAGE;
+HTTP_508_LOOP_DETECTED;
+HTTP_509_BANDWIDTH_LIMIT_EXCEEDED;
+HTTP_510_NOT_EXTENDED;
+HTTP_511_NETWORK_AUTHENTICATION_REQUIRED;
+```
+
+### Helper functions
+
+The following helper functions are available for identifying the category of the response code.
+
+```js
+import {
+  isInformational,
+  isSuccess,
+  isRedirect,
+  isClientError,
+  isServerError,
+} from 'simple-http-status';
+
+isInformational(); // 1xx
+isSuccess(); // 2xx
+isRedirect(); // 3xx
+isClientError(); // 4xx
+isServerError(); // 5xx
+```

package.json

@@ -0,0 +1,41 @@
+{
+  "name": "simple-http-status",
+  "version": "1.0.0",
+  "author": "Flávio Carvalho",
+  "module": "dist/simple-http-status.esm.js",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "engines": {
+    "node": ">=10"
+  },
+  "scripts": {
+    "start": "tsdx watch",
+    "build": "tsdx build",
+    "test": "tsdx test",
+    "lint": "tsdx lint",
+    "prepare": "tsdx build"
+  },
+  "peerDependencies": {},
+  "husky": {
+    "hooks": {
+      "pre-commit": "tsdx lint"
+    }
+  },
+  "prettier": {
+    "printWidth": 80,
+    "semi": true,
+    "singleQuote": true,
+    "trailingComma": "es5"
+  },
+  "devDependencies": {
+    "husky": "^4.2.5",
+    "tsdx": "^0.13.2",
+    "tslib": "^2.0.0",
+    "typescript": "^3.9.7"
+  }
+}

src/index.ts

@@ -0,0 +1,81 @@
+export enum Status {
+  // Informational
+  HTTP_100_CONTINUE = 100,
+  HTTP_101_SWITCHING_PROTOCOLS = 101,
+
+  // Successful
+  HTTP_200_OK = 200,
+  HTTP_201_CREATED = 201,
+  HTTP_202_ACCEPTED = 202,
+  HTTP_203_NON_AUTHORITATIVE_INFORMATION = 203,
+  HTTP_204_NO_CONTENT = 204,
+  HTTP_205_RESET_CONTENT = 205,
+  HTTP_206_PARTIAL_CONTENT = 206,
+  HTTP_207_MULTI_STATUS = 207,
+  HTTP_208_ALREADY_REPORTED = 208,
+  HTTP_226_IM_USED = 226,
+
+  // Redirection
+  HTTP_300_MULTIPLE_CHOICES = 300,
+  HTTP_301_MOVED_PERMANENTLY = 301,
+  HTTP_302_FOUND = 302,
+  HTTP_303_SEE_OTHER = 303,
+  HTTP_304_NOT_MODIFIED = 304,
+  HTTP_305_USE_PROXY = 305,
+  HTTP_306_RESERVED = 306,
+  HTTP_307_TEMPORARY_REDIRECT = 307,
+  HTTP_308_PERMANENT_REDIRECT = 308,
+
+  // Client Error
+  HTTP_400_BAD_REQUEST = 400,
+  HTTP_401_UNAUTHORIZED = 401,
+  HTTP_402_PAYMENT_REQUIRED = 402,
+  HTTP_403_FORBIDDEN = 403,
+  HTTP_404_NOT_FOUND = 404,
+  HTTP_405_METHOD_NOT_ALLOWED = 405,
+  HTTP_406_NOT_ACCEPTABLE = 406,
+  HTTP_407_PROXY_AUTHENTICATION_REQUIRED = 407,
+  HTTP_408_REQUEST_TIMEOUT = 408,
+  HTTP_409_CONFLICT = 409,
+  HTTP_410_GONE = 410,
+  HTTP_411_LENGTH_REQUIRED = 411,
+  HTTP_412_PRECONDITION_FAILED = 412,
+  HTTP_413_REQUEST_ENTITY_TOO_LARGE = 413,
+  HTTP_414_REQUEST_URI_TOO_LONG = 414,
+  HTTP_415_UNSUPPORTED_MEDIA_TYPE = 415,
+  HTTP_416_REQUESTED_RANGE_NOT_SATISFIABLE = 416,
+  HTTP_417_EXPECTATION_FAILED = 417,
+  HTTP_422_UNPROCESSABLE_ENTITY = 422,
+  HTTP_423_LOCKED = 423,
+  HTTP_424_FAILED_DEPENDENCY = 424,
+  HTTP_426_UPGRADE_REQUIRED = 426,
+  HTTP_428_PRECONDITION_REQUIRED = 428,
+  HTTP_429_TOO_MANY_REQUESTS = 429,
+  HTTP_431_REQUEST_HEADER_FIELDS_TOO_LARGE = 431,
+  HTTP_451_UNAVAILABLE_FOR_LEGAL_REASONS = 451,
+
+  // Server Error
+  HTTP_500_INTERNAL_SERVER_ERROR = 500,
+  HTTP_501_NOT_IMPLEMENTED = 501,
+  HTTP_502_BAD_GATEWAY = 502,
+  HTTP_503_SERVICE_UNAVAILABLE = 503,
+  HTTP_504_GATEWAY_TIMEOUT = 504,
+  HTTP_505_HTTP_VERSION_NOT_SUPPORTED = 505,
+  HTTP_506_VARIANT_ALSO_NEGOTIATES = 506,
+  HTTP_507_INSUFFICIENT_STORAGE = 507,
+  HTTP_508_LOOP_DETECTED = 508,
+  HTTP_509_BANDWIDTH_LIMIT_EXCEEDED = 509,
+  HTTP_510_NOT_EXTENDED = 510,
+  HTTP_511_NETWORK_AUTHENTICATION_REQUIRED = 511,
+}
+
+export const isInformational = (status: number) =>
+  status >= 100 && status < 200;
+
+export const isSuccess = (status: number) => status >= 200 && status < 300;
+
+export const isRedirect = (status: number) => status >= 300 && status < 400;
+
+export const isClientError = (status: number) => status >= 400 && status < 500;
+
+export const isServerError = (status: number) => status >= 500 && status < 600;