@alwatr/http-primer 1.0.0

package/README.md

@@ -0,0 +1,65 @@
+# HTTP Primer
+
+Essential HTTP utilities for TypeScript, including types for HTTP methods, status codes, and headers.
+
+## Installation
+
+```bash
+npm install @alwatr/http-primer
+```
+
+## Usage
+
+### HTTP Methods
+
+```typescript
+import {HttpMethods} from '@alwatr/http-primer';
+
+const method = HttpMethods.GET;
+```
+
+### HTTP Status Codes
+
+```typescript
+import {HttpStatusCodes} from '@alwatr/http-primer';
+
+const statusCode = HttpStatusCodes.Success_200_OK;
+```
+
+### HTTP Headers
+
+```typescript
+import {HttpRequestHeaders, HttpResponseHeaders} from '@alwatr/http-primer';
+
+const requestHeaders: HttpRequestHeaders = {
+  accept: 'application/json',
+  authorization: 'Bearer my-token',
+};
+
+const responseHeaders: HttpResponseHeaders = {
+  'content-type': 'application/json',
+  'content-length': 1234,
+};
+```
+
+### MIME Types
+
+```typescript
+import {MimeTypes} from '@alwatr/http-essentials';
+
+const contentType = MimeTypes.JSON; // 'application/json'
+```
+
+## Sponsors
+
+The following companies, organizations, and individuals support Nanolib ongoing maintenance and development. Become a Sponsor to get your logo on our README and website.
+
+[![Exir Studio](https://avatars.githubusercontent.com/u/181194967?s=200&v=4)](https://exirstudio.com)
+
+### Contributing
+
+Contributions are welcome! Please read our [contribution guidelines](https://github.com/Alwatr/.github/blob/next/CONTRIBUTING.md) before submitting a pull request.
+
+### License
+
+This project is licensed under the [AGPL-3.0 License](LICENSE).

package/dist/constant.d.ts

@@ -0,0 +1,458 @@
+/**
+ * Object representing standard HTTP methods.
+ */
+export declare const HttpMethods: {
+    /**
+     * GET: Requests a representation of the specified resource.
+     */
+    readonly GET: "GET";
+    /**
+     * HEAD: Asks for a response identical to that of a GET request, but without the response body.
+     */
+    readonly HEAD: "HEAD";
+    /**
+     * POST: Submits data to be processed (e.g., from an HTML form) to the identified resource.
+     */
+    readonly POST: "POST";
+    /**
+     * PUT: Uploads a representation of the specified URI.
+     */
+    readonly PUT: "PUT";
+    /**
+     * DELETE: Deletes the specified resource.
+     */
+    readonly DELETE: "DELETE";
+    /**
+     * CONNECT: Establishes a tunnel to the server identified by the target resource.
+     */
+    readonly CONNECT: "CONNECT";
+    /**
+     * OPTIONS: Describes the communication options for the target resource.
+     */
+    readonly OPTIONS: "OPTIONS";
+    /**
+     * TRACE: Performs a message loop-back test along the path to the target resource.
+     */
+    readonly TRACE: "TRACE";
+    /**
+     * PATCH: Applies partial modifications to a resource.
+     */
+    readonly PATCH: "PATCH";
+};
+/**
+ * Object representing standard HTTP status codes.
+ */
+export declare const HttpStatusCodes: {
+    /**
+     * 100 Continue: The server has received the request headers and the client should proceed to send the request body.
+     */
+    readonly Info_100_Continue: 100;
+    /**
+     * 101 Switching Protocols: The server understands and is willing to comply with the clients request to switch protocols.
+     */
+    readonly Info_101_Switching_Protocols: 101;
+    /**
+     * 102 Processing: The server has received and is processing the request, but no response is available yet.
+     */
+    readonly Info_102_Processing: 102;
+    /**
+     * 103 Early Hints: The server is sending some response headers before the final HTTP message.
+     */
+    readonly Info_103_Early_Hints: 103;
+    /**
+     * 200 OK: The request has succeeded.
+     */
+    readonly Success_200_OK: 200;
+    /**
+     * 201 Created: The request has been fulfilled and resulted in a new resource being created.
+     */
+    readonly Success_201_Created: 201;
+    /**
+     * 202 Accepted: The request has been accepted for processing, but the processing has not been completed.
+     */
+    readonly Success_202_Accepted: 202;
+    /**
+     * 203 Non-Authoritative Information: The server is a transforming proxy that received a 200 OK
+     * from the origin server but is returning a modified version of the origins response.
+     */
+    readonly Success_203_Non_Authoritative_Information: 203;
+    /**
+     * 204 No Content: The server successfully processed the request and is not returning any content.
+     */
+    readonly Success_204_No_Content: 204;
+    /**
+     * 205 Reset Content: The server successfully processed the request,
+     * asks that the client reset its document view, and is not returning any content.
+     */
+    readonly Success_205_Reset_Content: 205;
+    /**
+     * 206 Partial Content: The server is delivering only part of the resource due to a range header sent by the client.
+     */
+    readonly Success_206_Partial_Content: 206;
+    /**
+     * 207 Multi-Status: The message body that follows is an XML message
+     * and can contain a number of separate response codes, depending on how many sub-requests were made.
+     */
+    readonly Success_207_Multi_Status: 207;
+    /**
+     * 208 Already Reported: The members of a DAV binding have already been enumerated
+     * in a preceding part of the (multi-status) response, and are not being included again.
+     */
+    readonly Success_208_Already_Reported: 208;
+    /**
+     * 226 IM Used: The server has fulfilled a request for the resource, and the response is a representation
+     * of the result of one or more instance-manipulations applied to the current instance.
+     */
+    readonly Success_226_IM_Used: 226;
+    /**
+     * 300 Multiple Choices: The request has more than one possible response.
+     */
+    readonly Redirect_300_Multiple_Choices: 300;
+    /**
+     * 301 Moved Permanently: The URL of the requested resource has been changed permanently.
+     */
+    readonly Redirect_301_Moved_Permanently: 301;
+    /**
+     * 302 Found: The URL of the requested resource has been changed temporarily.
+     */
+    readonly Redirect_302_Found: 302;
+    /**
+     * 303 See Other: The response to the request can be found under another URI using a GET method.
+     */
+    readonly Redirect_303_See_Other: 303;
+    /**
+     * 304 Not Modified: The resource has not been modified since the version specified
+     * by the request headers If-Modified-Since or If-None-Match.
+     */
+    readonly Redirect_304_Not_Modified: 304;
+    /**
+     * 305 Use Proxy: The requested resource is only available through a proxy, the address for which is provided in the response.
+     */
+    readonly Redirect_305_Use_Proxy: 305;
+    /**
+     * 306 Switch Proxy: No longer used. Originally meant "Subsequent requests should use the specified proxy."
+     */
+    readonly Redirect_306_Switch_Proxy: 306;
+    /**
+     * 307 Temporary Redirect: The server sends this response to direct the client
+     * to get the requested resource at another URI with the same method that was used in the prior request.
+     */
+    readonly Redirect_307_Temporary_Redirect: 307;
+    /**
+     * 308 Permanent Redirect: This means that the resource is now permanently located at another URI,
+     * specified by the Location: HTTP Response header.
+     */
+    readonly Redirect_308_Permanent_Redirect: 308;
+    /**
+     * 400 Bad Request: The server cannot or will not process the request due to something that is perceived to be a client error.
+     */
+    readonly Error_Client_400_Bad_Request: 400;
+    /**
+     * 401 Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.
+     */
+    readonly Error_Client_401_Unauthorized: 401;
+    /**
+     * 402 Payment Required: Reserved for future use.
+     */
+    readonly Error_Client_402_Payment_Required: 402;
+    /**
+     * 403 Forbidden: The client does not have access rights to the content, so the server is refusing to give the requested resource.
+     */
+    readonly Error_Client_403_Forbidden: 403;
+    /**
+     * 404 Not Found: The server can not find the requested resource.
+     */
+    readonly Error_Client_404_Not_Found: 404;
+    /**
+     * 405 Method Not Allowed: The request method is known by the server but is not supported by the target resource.
+     */
+    readonly Error_Client_405_Method_Not_Allowed: 405;
+    /**
+     * 406 Not Acceptable: The target resource does not have a current representation that would be acceptable
+     * to the user agent, according to the proactive negotiation header fields received in the request,
+     * and the server is unwilling to supply a default representation.
+     */
+    readonly Error_Client_406_Not_Acceptable: 406;
+    /**
+     * 407 Proxy Authentication Required: Similar to 401 Unauthorized,
+     * but it indicates that the client needs to authenticate itself in order to use a proxy.
+     */
+    readonly Error_Client_407_Proxy_Authentication_Required: 407;
+    /**
+     * 408 Request Timeout: The server timed out waiting for the request.
+     */
+    readonly Error_Client_408_Request_Timeout: 408;
+    /**
+     * 409 Conflict: The request could not be processed because of conflict in the request, such as an edit conflict.
+     */
+    readonly Error_Client_409_Conflict: 409;
+    /**
+     * 410 Gone: The requested resource is no longer available and will not be available again.
+     */
+    readonly Error_Client_410_Gone: 410;
+    /**
+     * 411 Length Required: The server refuses to accept the request without a defined Content-Length header.
+     */
+    readonly Error_Client_411_Length_Required: 411;
+    /**
+     * 412 Precondition Failed: One or more conditions given in the request header fields evaluated to false when tested on the server.
+     */
+    readonly Error_Client_412_Precondition_Failed: 412;
+    /**
+     * 413 Payload Too Large: The server is refusing to process a request because the request payload is larger
+     * than the server is willing or able to process.
+     */
+    readonly Error_Client_413_Payload_Too_Large: 413;
+    /**
+     * 414 URI Too Long: The server is refusing to service the request because the URI is longer than the server is willing to interpret.
+     */
+    readonly Error_Client_414_URI_Too_Long: 414;
+    /**
+     * 415 Unsupported Media Type: 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.
+     */
+    readonly Error_Client_415_Unsupported_Media_Type: 415;
+    /**
+     * 416 Range Not Satisfiable: The client has asked for a portion of the file, but the server cannot supply that portion.
+     */
+    readonly Error_Client_416_Range_Not_Satisfiable: 416;
+    /**
+     * 417 Expectation Failed: The server cannot meet the requirements of the Expect request-header field.
+     */
+    readonly Error_Client_417_Expectation_Failed: 417;
+    /**
+     * 421 Misdirected Request: The request was directed at a server that is not able to produce a response.
+     */
+    readonly Error_Client_421_Misdirected_Request: 421;
+    /**
+     * 422 Unprocessable Entity: The request was well-formed but was unable to be followed due to semantic errors.
+     */
+    readonly Error_Client_422_Unprocessable_Entity: 422;
+    /**
+     * 423 Locked: The resource that is being accessed is locked.
+     */
+    readonly Error_Client_423_Locked: 423;
+    /**
+     * 424 Failed Dependency: The request failed due to a failure of a previous request.
+     */
+    readonly Error_Client_424_Failed_Dependency: 424;
+    /**
+     * 425 Too Early: The server is unwilling to risk processing a request that might be replayed.
+     */
+    readonly Error_Client_425_Too_Early: 425;
+    /**
+     * 426 Upgrade Required: The server refuses to perform the request using the current protocol
+     * but might be willing to do so after the client upgrades to a different protocol.
+     */
+    readonly Error_Client_426_Upgrade_Required: 426;
+    /**
+     * 428 Precondition Required: The origin server requires the request to be conditional.
+     */
+    readonly Error_Client_428_Precondition_Required: 428;
+    /**
+     * 429 Too Many Requests: The user has sent too many requests in a given amount of time ("rate limiting").
+     */
+    readonly Error_Client_429_Too_Many_Requests: 429;
+    /**
+     * 431 Request Header Fields Too Large: The server is unwilling to process the request because its header fields are too large.
+     */
+    readonly Error_Client_431_Request_Header_Fields_Too_Large: 431;
+    /**
+     * 451 Unavailable For Legal Reasons: The user requests an illegal resource, such as a web page censored by a government.
+     */
+    readonly Error_Client_451_Unavailable_For_Legal_Reasons: 451;
+    /**
+     * 500 Internal Server Error: A generic error message, given when no more specific message is suitable.
+     */
+    readonly Error_Server_500_Internal_Server_Error: 500;
+    /**
+     * 501 Not Implemented: The server either does not recognize the request method, or it lacks the ability to fulfill the request.
+     */
+    readonly Error_Server_501_Not_Implemented: 501;
+    /**
+     * 502 Bad Gateway: The server was acting as a gateway or proxy and received an invalid response from the upstream server.
+     */
+    readonly Error_Server_502_Bad_Gateway: 502;
+    /**
+     * 503 Service Unavailable: The server is currently unavailable (because it is overloaded or down for maintenance).
+     */
+    readonly Error_Server_503_Service_Unavailable: 503;
+    /**
+     * 504 Gateway Timeout: The server was acting as a gateway or proxy and did not receive a timely response from the upstream server.
+     */
+    readonly Error_Server_504_Gateway_Timeout: 504;
+    /**
+     * 505 HTTP Version Not Supported: The server does not support the HTTP protocol version used in the request.
+     */
+    readonly Error_Server_505_HTTP_Version_Not_Supported: 505;
+    /**
+     * 506 Variant Also Negotiates: Transparent content negotiation for the request results in a circular reference.
+     */
+    readonly Error_Server_506_Variant_Also_Negotiates: 506;
+    /**
+     * 507 Insufficient Storage: The server is unable to store the representation needed to complete the request.
+     */
+    readonly Error_Server_507_Insufficient_Storage: 507;
+    /**
+     * 508 Loop Detected: The server detected an infinite loop while processing the request.
+     */
+    readonly Error_Server_508_Loop_Detected: 508;
+    /**
+     * 510 Not Extended: Further extensions to the request are required for the server to fulfill it.
+     */
+    readonly Error_Server_510_Not_Extended: 510;
+    /**
+     * 511 Network Authentication Required: The client needs to authenticate to gain network access.
+     */
+    readonly Error_Server_511_Network_Authentication_Required: 511;
+};
+/**
+ * Object representing standard HTTP status messages.
+ */
+export declare const HttpStatusMessages: {
+    100: string;
+    101: string;
+    102: string;
+    103: string;
+    200: string;
+    201: string;
+    202: string;
+    203: string;
+    204: string;
+    205: string;
+    206: string;
+    207: string;
+    208: string;
+    226: string;
+    300: string;
+    301: string;
+    302: string;
+    303: string;
+    304: string;
+    305: string;
+    307: string;
+    308: string;
+    400: string;
+    401: string;
+    402: string;
+    403: string;
+    404: string;
+    405: string;
+    406: string;
+    407: string;
+    408: string;
+    409: string;
+    410: string;
+    411: string;
+    412: string;
+    413: string;
+    414: string;
+    415: string;
+    416: string;
+    417: string;
+    418: string;
+    421: string;
+    422: string;
+    423: string;
+    424: string;
+    425: string;
+    426: string;
+    428: string;
+    429: string;
+    431: string;
+    451: string;
+    500: string;
+    501: string;
+    502: string;
+    503: string;
+    504: string;
+    505: string;
+    506: string;
+    507: string;
+    508: string;
+    509: string;
+    510: string;
+    511: string;
+};
+/**
+ * Type representing standard HTTP status codes.
+ */
+export type HttpStatusCode = keyof typeof HttpStatusMessages;
+/**
+ * Object representing standard MIME types.
+ */
+export declare const MimeTypes: {
+    readonly AAC: "audio/aac";
+    readonly ABW: "application/x-abiword";
+    readonly ARC: "application/x-freearc";
+    readonly AVI: "video/x-msvideo";
+    readonly AZW: "application/vnd.amazon.ebook";
+    readonly BIN: "application/octet-stream";
+    readonly BMP: "image/bmp";
+    readonly BZ: "application/x-bzip";
+    readonly BZ2: "application/x-bzip2";
+    readonly CSH: "application/x-csh";
+    readonly CSS: "text/css";
+    readonly CSV: "text/csv";
+    readonly DOC: "application/msword";
+    readonly DOCX: "application/vnd.openxmlformats-officedocument.wordprocessingml.document";
+    readonly EOT: "application/vnd.ms-fontobject";
+    readonly EPUB: "application/epub+zip";
+    readonly GZ: "application/gzip";
+    readonly GIF: "image/gif";
+    readonly HTML: "text/html";
+    readonly ICO: "image/vnd.microsoft.icon";
+    readonly ICS: "text/calendar";
+    readonly JAR: "application/java-archive";
+    readonly JPEG: "image/jpeg";
+    readonly JS: "text/javascript";
+    readonly JSON: "application/json";
+    readonly JSONLD: "application/ld+json";
+    readonly MID: "audio/midi";
+    readonly MIDI: "audio/midi";
+    readonly MJS: "text/javascript";
+    readonly MP3: "audio/mpeg";
+    readonly MP4: "video/mp4";
+    readonly MPEG: "video/mpeg";
+    readonly MPKG: "application/vnd.apple.installer+xml";
+    readonly ODP: "application/vnd.oasis.opendocument.presentation";
+    readonly ODS: "application/vnd.oasis.opendocument.spreadsheet";
+    readonly ODT: "application/vnd.oasis.opendocument.text";
+    readonly OGA: "audio/ogg";
+    readonly OGV: "video/ogg";
+    readonly OGX: "application/ogg";
+    readonly OPUS: "audio/opus";
+    readonly OTF: "font/otf";
+    readonly PNG: "image/png";
+    readonly PDF: "application/pdf";
+    readonly PHP: "application/x-httpd-php";
+    readonly PPT: "application/vnd.ms-powerpoint";
+    readonly PPTX: "application/vnd.openxmlformats-officedocument.presentationml.presentation";
+    readonly RAR: "application/vnd.rar";
+    readonly RTF: "application/rtf";
+    readonly SH: "application/x-sh";
+    readonly SVG: "image/svg+xml";
+    readonly SWF: "application/x-shockwave-flash";
+    readonly TAR: "application/x-tar";
+    readonly TIFF: "image/tiff";
+    readonly TS: "video/mp2t";
+    readonly TTF: "font/ttf";
+    readonly TXT: "text/plain";
+    readonly VS: "application/x-sh";
+    readonly WAV: "audio/wav";
+    readonly WEBA: "audio/webm";
+    readonly WEBM: "video/webm";
+    readonly WEBP: "image/webp";
+    readonly WOFF: "font/woff";
+    readonly WOFF2: "font/woff2";
+    readonly XHTML: "application/xhtml+xml";
+    readonly XLS: "application/vnd.ms-excel";
+    readonly XLSX: "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
+    readonly XML: "application/xml";
+    readonly XUL: "application/vnd.mozilla.xul+xml";
+    readonly ZIP: "application/zip";
+    readonly '3GP': "video/3gpp";
+    readonly '3G2': "video/3gpp2";
+    readonly '7Z': "application/x-7z-compressed";
+};
+//# sourceMappingURL=constant.d.ts.map

package/dist/constant.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constant.d.ts","sourceRoot":"","sources":["../src/constant.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,WAAW;IACtB;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;CAEK,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,eAAe;IAC1B;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;;OAIG;;IAGH;;;OAGG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;CAEK,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgE9B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,OAAO,kBAAkB,CAAC;AAE7D;;GAEG;AACH,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyEZ,CAAC"}