feat: prepare package for first release (#13)

Author: magicmatatjahu

.gitignore

@@ -3,3 +3,5 @@ node_modules
 .DS_Store
 coverage
 lib
+esm
+cjs

CODEOWNERS

@@ -0,0 +1,8 @@
+# This file provides an overview of code owners in this repository.
+
+# Each line is a file pattern followed by one or more owners.
+# The last matching pattern has the most precedence.
+# For more details, read the following article on GitHub: https://help.github.com/articles/about-codeowners/.
+
+# The default owners are automatically added as reviewers when you open a pull request unless different owners are specified in the file.
+* @imabp @magicmatatjahu @asyncapi-bot-eve

README.md

@@ -1,3 +1,63 @@
-# AsyncAPI Problem interface
+# AsyncAPI Problem
 
-comes from https://github.com/asyncapi/community/discussions/300
+Library that implements the Problem interface. Reference https://www.rfc-editor.org/rfc/rfc7807.
+
+<!-- toc is generated with GitHub Actions do not remove toc markers -->
+
+<!-- toc -->
+
+- [Installation](#installation)
+- [Examples](#examples)
+  * [Simple example](#simple-example)
+  * [Mixin example](#mixin-example)
+- [Develop](#develop)
+- [Contributing](#contributing)
+
+<!-- tocstop -->
+
+## Installation
+
+```bash
+npm install @asyncapi/problem
+// OR
+yarn add @asyncapi/problem
+```
+
+## Examples
+
+### Simple example
+
+```ts
+import { Problem } from '@asyncapi/problem';
+
+const problem = new Problem({ type: 'https://example.com/problem', title: 'Example problem' });
+console.log(problem.get('type'));
+
+// Output:
+// https://example.com/problem
+```
+
+### Mixin example
+
+```ts
+import { ProblemMixin } from '@asyncapi/problem';
+
+class MyProblem extends ProblemMixin({ typePrefix: 'https://example.com' }) {}
+
+const problem = new MyProblem({ type: 'problem', title: 'Example problem' });
+console.log(problem.get('type'));
+
+// Output:
+// https://example.com/problem
+```
+
+## Develop
+
+1. Write code and tests in the `__tests__` folder.
+2. Make sure all tests pass by `npm test` command.
+3. Make sure code can be transformed to JS by `npm run build` command.
+4. Make sure code is well formatted and secure by `npm run lint:fix` command.
+
+## Contributing
+
+Read [CONTRIBUTING](./CONTRIBUTING.md) guide.

package.json

@@ -2,15 +2,6 @@
   "name": "@asyncapi/problem",
   "version": "0.0.1",
   "description": "AsyncAPI Problem interface",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
-  "scripts": {
-    "build": "tsc",
-    "test": "cross-env CI=true jest --coverage",
-    "lint": "eslint --no-error-on-unmatched-pattern --max-warnings 0 --config \".eslintrc\" \".\"",
-    "lint:fix": "eslint --no-error-on-unmatched-pattern --max-warnings 0 --config \".eslintrc\" \".\" --fix",
-    "generate:readme:toc": "markdown-toc -i \"README.md\""
-  },
   "bugs": {
     "url": "https://github.com/asyncapi/problem/issues"
   },
@@ -23,6 +14,29 @@
   },
   "license": "Apache-2.0",
   "homepage": "https://github.com/asyncapi/problem",
+  "sideEffects": false,
+  "main": "cjs/index.js",
+  "module": "esm/index.js",
+  "types": "esm/index.d.ts",
+  "files": [
+    "/esm",
+    "/cjs",
+    "/browser",
+    "LICENSE",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "npm run build:esm && npm run build:cjs",
+    "build:dev": "npm run build:esm",
+    "build:esm": "tsc",
+    "build:cjs": "tsc --project ./tsconfig.cjs.json",
+    "test": "cross-env CI=true jest --coverage",
+    "lint": "eslint --no-error-on-unmatched-pattern --max-warnings 0 --config \".eslintrc\" \".\"",
+    "lint:fix": "eslint --no-error-on-unmatched-pattern --max-warnings 0 --config \".eslintrc\" \".\" --fix",
+    "generate:readme:toc": "markdown-toc -i \"README.md\"",
+    "generate:assets": "npm run build && npm run generate:readme:toc",
+    "prepublishOnly": "npm run generate:assets"
+  },
   "devDependencies": {
     "@jest/types": "^29.3.1",
     "@types/jest": "^29.2.5",

src/problem.ts

@@ -50,7 +50,7 @@ export class Problem<T extends Record<string, unknown> = {}> extends Error {
     if (typeof keyOrObject !== 'string') {
       return Object.assign(this.problem, keyOrObject);
     }
-    return this.problem[keyOrObject] = value;
+    return this.problem[keyOrObject] = value as (ProblemInterface & T)[K];
   }
 
   copy(options?: CopyProblemOptions<Array<keyof Omit<ProblemInterface & T, 'type' | 'title'>>>): Problem {

tsconfig.cjs.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "outDir": "./cjs"
+  }
+}

tsconfig.json

@@ -1,18 +1,27 @@
 {
   "compilerOptions": {
-    "outDir": "./lib",
-    "rootDir": "./src",
-    "module": "commonjs",
+    "outDir": "./esm",
+    "baseUrl": "./src",
+    "target": "es6",
+    "module": "esnext",
+    "lib": [
+      "esnext",
+      "DOM"
+    ],
     "declaration": true,
-    "noImplicitAny": false,
-    "noUnusedLocals": false,
-    "removeComments": true,
-    "noLib": false,
-    "target": "ES2015",
-    "sourceMap": true,
     "allowJs": true,
-    "lib": ["ESNext"]
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "noFallthroughCasesInSwitch": true,
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "sourceMap": true,
   },
-  "include": ["src/*.ts", "src/**/*.ts"],
-  "exclude": ["node_modules"]
+  "include": [
+    "src"
+  ]
 }