@one-format/http-plugin 0.0.0-stage → 1.1.0

package/README.md

@@ -1,3 +1,53 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# @one-format/http-plugin
+
+An official one-format plugin for formatting standard HTTP status codes.
+
+## Installation
+
+```bash
+npm install @one-format/http-plugin
+```
+
+## Usage
+
+The package exports a plugin object containing two tools:
+
+```ts
+import httpPlugin from "@one-format/http-plugin";
+
+httpPlugin.tools.codeToMessage(404);
+// "Not Found"
+
+httpPlugin.tools.codeToFormal(404);
+// "HTTP/404 Not Found"
+```
+
+Use the plugin with `@one-format/core` to expose its tools directly:
+
+```ts
+import adapter from "@one-format/core";
+import httpPlugin from "@one-format/http-plugin";
+
+const http = adapter(httpPlugin);
+
+http.codeToMessage(500); // "Internal Server Error"
+http.codeToFormal(201); // "HTTP/201 Created"
+```
+
+### Supported status codes
+
+The `HttpStatusCode` type covers the standard HTTP status codes in the
+informational (1xx), success (2xx), redirection (3xx), client error (4xx),
+and server error (5xx) ranges, including WebDAV and other registered codes.
+TypeScript will restrict tool inputs to the supported codes.
+
+### API
+
+- `tools.codeToMessage(code)` - returns the reason phrase for a status code.
+- `tools.codeToFormal(code)` - returns a formatted `HTTP/<code> <message>`
+  status line.
+- `metadata` - identifies the plugin and its version.
+
+## License
+
+EUPL-1.2

package/dist/index.d.ts

@@ -0,0 +1,25 @@
+import { type HttpStatusCode } from "./types.js";
+type PluginFn<Input = any, Output = any> = (input: Input) => Output;
+interface PluginMetadata {
+    name: string;
+    author: string;
+    version?: string;
+}
+interface PluginType<Tools extends Record<string, any>> {
+    metadata: PluginMetadata;
+    tools: {
+        [K in keyof Tools]: PluginFn<Tools[K]['input'], Tools[K]['output']>;
+    };
+}
+declare const httpPlugin: PluginType<{
+    codeToFormal: {
+        input: HttpStatusCode;
+        output: `HTTP/${HttpStatusCode} ${string}`;
+    };
+    codeToMessage: {
+        input: HttpStatusCode;
+        output: string;
+    };
+}>;
+export default httpPlugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAwB,KAAK,cAAc,EAAE,MAAM,YAAY,CAAC;AAEvE,KAAK,QAAQ,CAAC,KAAK,GAAG,GAAG,EAAE,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,EAAE,KAAK,KAAK,MAAM,CAAC;AAEpE,UAAU,cAAc;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AACD,UAAU,UAAU,CAAC,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAClD,QAAQ,EAAE,cAAc,CAAC;IACzB,KAAK,EAAE;SACF,CAAC,IAAI,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;KACtE,CAAC;CACL;AAGD,QAAA,MAAM,UAAU,EAAE,UAAU,CAAC;IACzB,YAAY,EAAE;QACN,KAAK,EAAE,cAAc,CAAC;QACtB,MAAM,EAAE,QAAQ,cAAc,IAAI,MAAM,EAAE,CAAA;KACjD,CAAC;IACF,aAAa,EAAE;QACX,KAAK,EAAE,cAAc,CAAC;QACtB,MAAM,EAAE,MAAM,CAAA;KACjB,CAAA;CACA,CAUJ,CAAA;eAEc,UAAU"}

package/dist/index.js

@@ -0,0 +1,14 @@
+import { HTTP_STATUS_MESSAGES } from "./types.js";
+const httpPlugin = {
+    "metadata": {
+        "author": "Vedansh Shetti <vedansh.shetti@gmail.com> - one-format Official Plugin",
+        "name": "One-Format Datetime",
+        "version": "1.1.0"
+    },
+    tools: {
+        codeToFormal: (code) => `HTTP/${code} ${HTTP_STATUS_MESSAGES[code]}`,
+        codeToMessage: (code) => HTTP_STATUS_MESSAGES[code]
+    }
+};
+export default httpPlugin;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAuB,MAAM,YAAY,CAAC;AAiBvE,MAAM,UAAU,GASP;IACL,UAAU,EAAE;QACR,QAAQ,EAAE,wEAAwE;QAClF,MAAM,EAAE,qBAAqB;QAC7B,SAAS,EAAE,OAAO;KACrB;IACD,KAAK,EAAE;QACH,YAAY,EAAE,CAAC,IAAoB,EAAE,EAAE,CAAC,QAAQ,IAAI,IAAI,oBAAoB,CAAC,IAAI,CAAC,EAAE;QACpF,aAAa,EAAE,CAAC,IAAoB,EAAE,EAAE,CAAC,oBAAoB,CAAC,IAAI,CAAC;KACtE;CACJ,CAAA;AAED,eAAe,UAAU,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Standard HTTP Status Codes as defined by IANA and RFC 9110.
+ */
+export type HttpStatusCode = 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 226 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 421 | 422 | 423 | 424 | 425 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 506 | 507 | 508 | 510 | 511;
+export declare const HTTP_STATUS_MESSAGES: Record<HttpStatusCode, string>;
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,cAAc,GAEtB,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GAGH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GAGH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GAGH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GAGH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,CAAC;AAIR,eAAO,MAAM,oBAAoB,EAAE,MAAM,CAAC,cAAc,EAAE,MAAM,CAwEtD,CAAC"}

package/dist/types.js

@@ -0,0 +1,70 @@
+export const HTTP_STATUS_MESSAGES = {
+    // 1xx: Informational
+    100: 'Continue',
+    101: 'Switching Protocols',
+    102: 'Processing',
+    103: 'Early Hints',
+    // 2xx: Success
+    200: 'OK',
+    201: 'Created',
+    202: 'Accepted',
+    203: 'Non-Authoritative Information',
+    204: 'No Content',
+    205: 'Reset Content',
+    206: 'Partial Content',
+    207: 'Multi-Status',
+    208: 'Already Reported',
+    226: 'IM Used',
+    // 3xx: Redirection
+    300: 'Multiple Choices',
+    301: 'Moved Permanently',
+    302: 'Found',
+    303: 'See Other',
+    304: 'Not Modified',
+    305: 'Use Proxy',
+    307: 'Temporary Redirect',
+    308: 'Permanent Redirect',
+    // 4xx: Client Error
+    400: 'Bad Request',
+    401: 'Unauthorized',
+    402: 'Payment Required',
+    403: 'Forbidden',
+    404: 'Not Found',
+    405: 'Method Not Allowed',
+    406: 'Not Acceptable',
+    407: 'Proxy Authentication Required',
+    408: 'Request Timeout',
+    409: 'Conflict',
+    410: 'Gone',
+    411: 'Length Required',
+    412: 'Precondition Failed',
+    413: 'Payload Too Large',
+    414: 'URI Too Long',
+    415: 'Unsupported Media Type',
+    416: 'Range Not Satisfiable',
+    417: 'Expectation Failed',
+    418: "I'm a teapot",
+    421: 'Misdirected Request',
+    422: 'Unprocessable Entity',
+    423: 'Locked',
+    424: 'Failed Dependency',
+    425: 'Too Early',
+    426: 'Upgrade Required',
+    428: 'Precondition Required',
+    429: 'Too Many Requests',
+    431: 'Request Header Fields Too Large',
+    451: 'Unavailable For Legal Reasons',
+    // 5xx: Server Error
+    500: 'Internal Server Error',
+    501: 'Not Implemented',
+    502: 'Bad Gateway',
+    503: 'Service Unavailable',
+    504: 'Gateway Timeout',
+    505: 'HTTP Version Not Supported',
+    506: 'Variant Also Negotiates',
+    507: 'Insufficient Storage',
+    508: 'Loop Detected',
+    510: 'Not Extended',
+    511: 'Network Authentication Required',
+};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AA8EA,MAAM,CAAC,MAAM,oBAAoB,GAAmC;IAClE,qBAAqB;IACrB,GAAG,EAAE,UAAU;IACf,GAAG,EAAE,qBAAqB;IAC1B,GAAG,EAAE,YAAY;IACjB,GAAG,EAAE,aAAa;IAElB,eAAe;IACf,GAAG,EAAE,IAAI;IACT,GAAG,EAAE,SAAS;IACd,GAAG,EAAE,UAAU;IACf,GAAG,EAAE,+BAA+B;IACpC,GAAG,EAAE,YAAY;IACjB,GAAG,EAAE,eAAe;IACpB,GAAG,EAAE,iBAAiB;IACtB,GAAG,EAAE,cAAc;IACnB,GAAG,EAAE,kBAAkB;IACvB,GAAG,EAAE,SAAS;IAEd,mBAAmB;IACnB,GAAG,EAAE,kBAAkB;IACvB,GAAG,EAAE,mBAAmB;IACxB,GAAG,EAAE,OAAO;IACZ,GAAG,EAAE,WAAW;IAChB,GAAG,EAAE,cAAc;IACnB,GAAG,EAAE,WAAW;IAChB,GAAG,EAAE,oBAAoB;IACzB,GAAG,EAAE,oBAAoB;IAEzB,oBAAoB;IACpB,GAAG,EAAE,aAAa;IAClB,GAAG,EAAE,cAAc;IACnB,GAAG,EAAE,kBAAkB;IACvB,GAAG,EAAE,WAAW;IAChB,GAAG,EAAE,WAAW;IAChB,GAAG,EAAE,oBAAoB;IACzB,GAAG,EAAE,gBAAgB;IACrB,GAAG,EAAE,+BAA+B;IACpC,GAAG,EAAE,iBAAiB;IACtB,GAAG,EAAE,UAAU;IACf,GAAG,EAAE,MAAM;IACX,GAAG,EAAE,iBAAiB;IACtB,GAAG,EAAE,qBAAqB;IAC1B,GAAG,EAAE,mBAAmB;IACxB,GAAG,EAAE,cAAc;IACnB,GAAG,EAAE,wBAAwB;IAC7B,GAAG,EAAE,uBAAuB;IAC5B,GAAG,EAAE,oBAAoB;IACzB,GAAG,EAAE,cAAc;IACnB,GAAG,EAAE,qBAAqB;IAC1B,GAAG,EAAE,sBAAsB;IAC3B,GAAG,EAAE,QAAQ;IACb,GAAG,EAAE,mBAAmB;IACxB,GAAG,EAAE,WAAW;IAChB,GAAG,EAAE,kBAAkB;IACvB,GAAG,EAAE,uBAAuB;IAC5B,GAAG,EAAE,mBAAmB;IACxB,GAAG,EAAE,iCAAiC;IACtC,GAAG,EAAE,+BAA+B;IAEpC,oBAAoB;IACpB,GAAG,EAAE,uBAAuB;IAC5B,GAAG,EAAE,iBAAiB;IACtB,GAAG,EAAE,aAAa;IAClB,GAAG,EAAE,qBAAqB;IAC1B,GAAG,EAAE,iBAAiB;IACtB,GAAG,EAAE,4BAA4B;IACjC,GAAG,EAAE,yBAAyB;IAC9B,GAAG,EAAE,sBAAsB;IAC3B,GAAG,EAAE,eAAe;IACpB,GAAG,EAAE,cAAc;IACnB,GAAG,EAAE,iCAAiC;CAC9B,CAAC"}

package/package.json

@@ -1,6 +1,22 @@
-{
-  "name": "@one-format/http-plugin",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+{
+  "name": "@one-format/http-plugin",
+  "version": "1.1.0",
+  "description": "",
+  "keywords": [
+    "http-formatting"
+  ],
+  "license": "EUPL-1.2",
+  "author": "Vedansh Shetti <vedansh.shetti@gmail.com>",
+  "type": "module",
+  "main": "dist/index.js",
+  "scripts": {
+    "test": "echo \"I didnt feel like writing tests, its just more code to maintain\"",
+    "prepublishOnly": "tsc",
+    "postpublish": "rimraf dist"
+  },
+  "devDependencies": {
+    "@types/node": "^26.6.5",
+    "rimraf": "^6.1.3",
+    "typescript": "^7.0.2"
+  }
+}

package/src/index.ts

@@ -0,0 +1,39 @@
+import { HTTP_STATUS_MESSAGES, type HttpStatusCode } from "./types.js";
+
+type PluginFn<Input = any, Output = any> = (input: Input) => Output;
+
+interface PluginMetadata {
+    name: string; // Plugin Name
+    author: string; // Author
+    version?: string; // Version Number, preferably SemVer.
+}
+interface PluginType<Tools extends Record<string, any>> {
+    metadata: PluginMetadata;
+    tools: {
+        [K in keyof Tools]: PluginFn<Tools[K]['input'], Tools[K]['output']>;
+    };
+}
+
+
+const httpPlugin: PluginType<{
+    codeToFormal: {
+            input: HttpStatusCode,
+            output: `HTTP/${HttpStatusCode} ${string}`
+    },
+    codeToMessage: {
+        input: HttpStatusCode,
+        output: string
+    }
+    }> = {
+    "metadata": {
+        "author": "Vedansh Shetti <vedansh.shetti@gmail.com> - one-format Official Plugin",
+        "name": "One-Format Datetime",
+        "version": "1.1.0"
+    },
+    tools: {
+        codeToFormal: (code: HttpStatusCode) => `HTTP/${code} ${HTTP_STATUS_MESSAGES[code]}`,
+        codeToMessage: (code: HttpStatusCode) => HTTP_STATUS_MESSAGES[code]
+    }
+}
+
+export default httpPlugin;

package/src/types.ts

@@ -0,0 +1,151 @@
+/**
+ * Standard HTTP Status Codes as defined by IANA and RFC 9110.
+ */
+export type HttpStatusCode = 
+  // 1xx: Informational
+  | 100 // Continue
+  | 101 // Switching Protocols
+  | 102 // Processing (WebDAV)
+  | 103 // Early Hints
+
+  // 2xx: Success
+  | 200 // OK
+  | 201 // Created
+  | 202 // Accepted
+  | 203 // Non-Authoritative Information
+  | 204 // No Content
+  | 205 // Reset Content
+  | 206 // Partial Content
+  | 207 // Multi-Status (WebDAV)
+  | 208 // Already Reported (WebDAV)
+  | 226 // IM Used
+
+  // 3xx: Redirection
+  | 300 // Multiple Choices
+  | 301 // Moved Permanently
+  | 302 // Found
+  | 303 // See Other
+  | 304 // Not Modified
+  | 305 // Use Proxy
+  | 307 // Temporary Redirect
+  | 308 // Permanent Redirect
+
+  // 4xx: Client Error
+  | 400 // Bad Request
+  | 401 // Unauthorized
+  | 402 // Payment Required
+  | 403 // Forbidden
+  | 404 // Not Found
+  | 405 // Method Not Allowed
+  | 406 // Not Acceptable
+  | 407 // Proxy Authentication Required
+  | 408 // Request Timeout
+  | 409 // Conflict
+  | 410 // Gone
+  | 411 // Length Required
+  | 412 // Precondition Failed
+  | 413 // Payload Too Large
+  | 414 // URI Too Long
+  | 415 // Unsupported Media Type
+  | 416 // Range Not Satisfiable
+  | 417 // Expectation Failed
+  | 418 // I'm a teapot (RFC 2324)
+  | 421 // Misdirected Request
+  | 422 // Unprocessable Entity (WebDAV)
+  | 423 // Locked (WebDAV)
+  | 424 // Failed Dependency (WebDAV)
+  | 425 // Too Early
+  | 426 // Upgrade Required
+  | 428 // Precondition Required
+  | 429 // Too Many Requests
+  | 431 // Request Header Fields Too Large
+  | 451 // Unavailable For Legal Reasons
+
+  // 5xx: Server Error
+  | 500 // Internal Server Error
+  | 501 // Not Implemented
+  | 502 // Bad Gateway
+  | 503 // Service Unavailable
+  | 504 // Gateway Timeout
+  | 505 // HTTP Version Not Supported
+  | 506 // Variant Also Negotiates
+  | 507 // Insufficient Storage (WebDAV)
+  | 508 // Loop Detected (WebDAV)
+  | 510 // Not Extended
+  | 511; // Network Authentication Required
+
+
+
+export const HTTP_STATUS_MESSAGES: Record<HttpStatusCode, string> = {
+  // 1xx: Informational
+  100: 'Continue',
+  101: 'Switching Protocols',
+  102: 'Processing',
+  103: 'Early Hints',
+
+  // 2xx: Success
+  200: 'OK',
+  201: 'Created',
+  202: 'Accepted',
+  203: 'Non-Authoritative Information',
+  204: 'No Content',
+  205: 'Reset Content',
+  206: 'Partial Content',
+  207: 'Multi-Status',
+  208: 'Already Reported',
+  226: 'IM Used',
+
+  // 3xx: Redirection
+  300: 'Multiple Choices',
+  301: 'Moved Permanently',
+  302: 'Found',
+  303: 'See Other',
+  304: 'Not Modified',
+  305: 'Use Proxy',
+  307: 'Temporary Redirect',
+  308: 'Permanent Redirect',
+
+  // 4xx: Client Error
+  400: 'Bad Request',
+  401: 'Unauthorized',
+  402: 'Payment Required',
+  403: 'Forbidden',
+  404: 'Not Found',
+  405: 'Method Not Allowed',
+  406: 'Not Acceptable',
+  407: 'Proxy Authentication Required',
+  408: 'Request Timeout',
+  409: 'Conflict',
+  410: 'Gone',
+  411: 'Length Required',
+  412: 'Precondition Failed',
+  413: 'Payload Too Large',
+  414: 'URI Too Long',
+  415: 'Unsupported Media Type',
+  416: 'Range Not Satisfiable',
+  417: 'Expectation Failed',
+  418: "I'm a teapot",
+  421: 'Misdirected Request',
+  422: 'Unprocessable Entity',
+  423: 'Locked',
+  424: 'Failed Dependency',
+  425: 'Too Early',
+  426: 'Upgrade Required',
+  428: 'Precondition Required',
+  429: 'Too Many Requests',
+  431: 'Request Header Fields Too Large',
+  451: 'Unavailable For Legal Reasons',
+
+  // 5xx: Server Error
+  500: 'Internal Server Error',
+  501: 'Not Implemented',
+  502: 'Bad Gateway',
+  503: 'Service Unavailable',
+  504: 'Gateway Timeout',
+  505: 'HTTP Version Not Supported',
+  506: 'Variant Also Negotiates',
+  507: 'Insufficient Storage',
+  508: 'Loop Detected',
+  510: 'Not Extended',
+  511: 'Network Authentication Required',
+} as const;

package/tsconfig.json

@@ -0,0 +1,37 @@
+{
+  "compilerOptions": {
+    // Environment Settings
+    "module": "nodenext",
+    "target": "esnext",
+    "lib": ["esnext"],
+    "types": ["node"],
+    
+    // Output Layout
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "sourceMap": true,
+    "declaration": true,
+    "declarationMap": true,
+
+    // Stricter Typechecking
+    "strict": true,
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": true,
+    "noImplicitReturns": true,
+    "noImplicitOverride": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true,
+    "noPropertyAccessFromIndexSignature": true,
+
+    // Module & Syntax
+    "verbatimModuleSyntax": true,
+    "isolatedModules": true,
+    "moduleDetection": "force",
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}