initial commit

Author: Dominik Zogg

.gitignore

@@ -0,0 +1,3 @@
+dist
+node_modules
+package-lock.json

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2021 Dominik Zogg
+
+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,35 @@
+# psr-http-message
+
+## Description
+
+Common Http-message Interface ([PHP FIG][2] [PSR-7][3]).
+
+This are the differences to the PHP version:
+ * `ServerRequestInterface` does not contain `getServerParams` and `withUploadedFiles` / `getUploadedFiles`
+ * `StreamInterface` is missing, duplex streams are used for `getBody` on `MessageInterface`.
+ * `UploadedFileInterface` is missing
+
+## Requirements
+
+ * node: 12
+
+## Installation
+
+Through [NPM](https://www.npmjs.com) as [@chubbyjs/psr-http-message][1].
+
+```sh
+npm i @chubbyjs/[email protected]
+```
+
+## Copyright
+
+Typescript:
+ * 2021 Dominik Zogg
+
+PHP:
+ * 2014 PHP Framework Interoperability Group
+
+[1]: https://www.npmjs.com/package/@chubbyjs/psr-http-message
+
+[2]: https://www.php-fig.org/
+[3]: https://www.php-fig.org/psr/psr-7/

package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@chubbyjs/psr-http-message",
+  "version": "1.0.0",
+  "description": "Common Http-message Interface (PHP FIG PSR-7).",
+  "keywords": [
+    "psr",
+    "psr-7",
+    "http-message-interface"
+  ],
+  "author": "Dominik Zogg",
+  "license": "MIT",
+  "repository": "chubbyjs/psr-http-message",
+  "scripts": {
+    "cs-fix": "prettier --write src",
+    "cs": "prettier --check src",
+    "build": "tsc",
+    "prepare": "rm -Rf dist && npm run build && npm run cs"
+  },
+  "prettier": {
+    "printWidth": 120,
+    "tabWidth": 4,
+    "singleQuote": true,
+    "trailingComma": "all"
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=12"
+  },
+  "devDependencies": {
+    "@types/node": "12",
+    "prettier": "2.1.2",
+    "typescript": "^4.0.5"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

src/MessageInterface.ts

@@ -0,0 +1,17 @@
+import { Duplex } from 'stream';
+
+interface MessageInterface {
+    getProtocolVersion(): string;
+    withProtocolVersion(version: string): MessageInterface;
+    getHeaders(): Map<string, Array<string>>;
+    hasHeader(name: string): boolean;
+    getHeader(name: string): Array<string>;
+    getHeaderLine(name: string): string;
+    withHeader(name: string, value: Array<string> | string): MessageInterface;
+    withAddedHeader(name: string, value: Array<string> | string): MessageInterface;
+    withoutHeader(name: string): MessageInterface;
+    getBody(): Duplex;
+    withBody(body: Duplex): MessageInterface;
+}
+
+export default MessageInterface;

src/RequestInterface.ts

@@ -0,0 +1,13 @@
+import MessageInterface from './MessageInterface';
+import UriInterface from './UriInterface';
+
+interface RequestInterface extends MessageInterface {
+    getRequestTarget(): string;
+    withRequestTarget(requestTarget: string): RequestInterface;
+    getMethod(): string;
+    withMethod(name: string): RequestInterface;
+    getUri(): UriInterface;
+    withUri(uri: UriInterface, preserveHost?: boolean): RequestInterface;
+}
+
+export default RequestInterface;

src/ResponseInterface.ts

@@ -0,0 +1,9 @@
+import MessageInterface from './MessageInterface';
+
+interface ResponseInterface extends MessageInterface {
+    getStatusCode(): number;
+    withStatus(code: number, reasonPhrase?: string): ResponseInterface;
+    getReasonPhrase(): string;
+}
+
+export default ResponseInterface;

src/ServerRequestInterface.ts

@@ -0,0 +1,19 @@
+import RequestInterface from './RequestInterface';
+
+export type QueryParams = Map<string, string | Array<string> | QueryParams>;
+export type ParsedBody = Map<string, ParsedBody> | Array<ParsedBody> | string | number | boolean | null;
+
+interface ServerRequestInterface extends RequestInterface {
+    getCookieParams(): Map<string, string>;
+    withCookieParams(cookieParams: Map<string, string>): ServerRequestInterface;
+    getQueryParams(): QueryParams;
+    withQueryParams(queryParams: QueryParams): ServerRequestInterface;
+    getParsedBody(): ParsedBody | undefined;
+    withParsedBody(parsedBody: ParsedBody | undefined): ServerRequestInterface;
+    getAttributes(): Map<string, unknown>;
+    getAttribute(name: string, defaultValue: unknown): unknown;
+    withAttribute(name: string, value: unknown): ServerRequestInterface;
+    withoutAttribute(name: string): ServerRequestInterface;
+}
+
+export default ServerRequestInterface;

src/UriInterface.ts

@@ -0,0 +1,20 @@
+interface UriInterface {
+    getSchema(): string;
+    getAuthority(): string;
+    getUserInfo(): string;
+    getHost(): string;
+    getPort(): number | undefined;
+    getPath(): string;
+    getQuery(): string;
+    getFragment(): string;
+    withScheme(scheme: string): UriInterface;
+    withUserInfo(user: string, password?: string): UriInterface;
+    withHost(scheme: string): UriInterface;
+    withPort(port?: number): UriInterface;
+    withPath(scheme: string): UriInterface;
+    withQuery(scheme: string): UriInterface;
+    withFragment(scheme: string): UriInterface;
+    toString(): string;
+}
+
+export default UriInterface;

tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "target": "es2019",
+    "module": "commonjs",
+    "outDir": "dist",
+    "strict": true,
+    "declaration": true,
+  },
+  "include": ["src"]
+}