Merge pull request #4 from inaiat/chore/update-libs-and-put-papr-as-peer-dep

Chore/update libs and put papr as peer dep

Author: inaiat

BUILD_SHA

@@ -0,0 +1 @@
+327d547f9a182c658c5ef4585679f38867499101

README.md

@@ -1,4 +1,5 @@
 # fastify-papr
+![Statements](https://img.shields.io/badge/statements-98.75%25-brightgreen.svg?style=flat) ![Branches](https://img.shields.io/badge/branches-85%25-yellow.svg?style=flat) ![Functions](https://img.shields.io/badge/functions-100%25-brightgreen.svg?style=flat) ![Lines](https://img.shields.io/badge/lines-98.75%25-brightgreen.svg?style=flat)
 
 A fastify Papr plugin integration.
 
@@ -71,4 +72,10 @@ export default userRoute
 
 ## Papr Documentation
 
-Read the documentation at: [plexinc.github.io/papr](https://plexinc.github.io/papr/)
+Read the documentation at: [plexinc.github.io/papr](https://plexinc.github.io/papr/)
+
+## ESM Only
+
+This package only supports to be directly imported in a ESM context.
+
+For informations on how to use it in a CommonJS context, please check [this page](https://gist.github.com/ShogunPanda/fe98fd23d77cdfb918010dbc42f4504d).

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@inaiat/fastify-papr",
-  "version": "0.0.9",
+  "version": "1.0.0",
   "description": "Fastify Papr Plugin Integration",
   "type": "module",
   "engines": {
@@ -12,7 +12,9 @@
     "test": "xo && ava",
     "build": "rimraf ./dist && mkdir dist && tsc --outDir dist && git rev-parse HEAD > BUILD_SHA",
     "lint": "xo --fix",
-    "prepublishOnly": "npm run build"
+    "coverage": "xo && c8 ava",
+    "prepublishOnly": "npm run build",
+    "make-badges": "istanbul-badges-readme"
   },
   "repository": {
     "type": "git",
@@ -44,28 +46,28 @@
   ],
   "homepage": "https://github.com/inaiat/fastify-papr.git",
   "dependencies": {
-    "fastify-plugin": "^4.2.0",
-    "papr": "^7.2.1"
+    "fastify-plugin": "^4.2.1"
   },
   "peerDependencies": {
-    "fastify": "^4.5.0",
-    "mongodb": "^4.8.1"
+    "fastify": "^4.5.3",
+    "mongodb": "^4.9.0",
+    "papr": "^7.x"
   },
   "devDependencies": {
     "@swc/cli": "^0.1.57",
-    "@swc/core": "^1.2.237",
-    "@swc/helpers": "^0.4.6",
-    "@types/node": "^18.7.6",
+    "@swc/core": "^1.2.245",
+    "@swc/helpers": "^0.4.11",
+    "@types/node": "^18.7.14",
     "@types/semver": "^7.3.12",
-    "ava": "^4.3.1",
+    "ava": "^4.3.3",
     "c8": "^7.12.0",
-    "fastify": "^4.5.0",
     "mongodb-memory-server": "^8.8.0",
     "rimraf": "^3.0.2",
     "semver": "^7.3.7",
     "ts-node": "^10.9.1",
-    "typescript": "^4.7.4",
-    "xo": "^0.51.0"
+    "typescript": "^4.8.2",
+    "xo": "^0.52.2",
+    "istanbul-badges-readme": "^1.8.2"
   },
   "files": [
     "dist"
@@ -81,6 +83,13 @@
       "--loader=ts-node/esm"
     ]
   },
+  "c8": {
+    "reporter": [
+      "text",
+      "json-summary",
+      "lcov"
+    ]
+  },
   "xo": {
     "semicolon": false,
     "ignores": [
@@ -102,7 +111,8 @@
       "@typescript-eslint/no-redundant-type-constituents": "off",
       "no-lone-blocks": "off",
       "unicorn/no-await-expression-member": "off",
-      "@typescript-eslint/naming-convention": "off"
+      "@typescript-eslint/naming-convention": "off",
+      "@typescript-eslint/consistent-type-definitions": "off"
     }
   },
   "config": {

package.json

@@ -1,6 +1,6 @@
 import fp from 'fastify-plugin'
-import {BaseSchema, Model} from 'papr'
-import {FastifyPaprOptions, PaprModels} from './types.js'
+import type {BaseSchema, Model} from 'papr'
+import type {FastifyPaprOptions, PaprModels} from './types.js'
 import {paprHelper} from './papr-helper.js'
 
 export const asModel = <TSchema extends BaseSchema>(
@@ -22,7 +22,7 @@ const fastifyPaprPlugin = fp<FastifyPaprOptions>(
 			}
 
 			if (fastify.papr[name]) {
-				throw new Error('Connection name already registered: ' + name)
+				throw new Error(`Connection name already registered: ${name}`)
 			}
 
 			fastify.papr[name] = models as Model<any, any> & PaprModels

src/index.ts

@@ -1,7 +1,8 @@
-import {FastifyInstance} from 'fastify'
-import {Db} from 'mongodb'
-import Papr, {BaseSchema} from 'papr'
-import {ModelRegistrationPair, PaprModels} from './types.js'
+import type {FastifyInstance} from 'fastify'
+import type {Db} from 'mongodb'
+import type {BaseSchema} from 'papr'
+import Papr from 'papr'
+import type {ModelRegistrationPair, PaprModels} from './types.js'
 
 export const paprHelper = (fastify: FastifyInstance, db: Db) => {
 	const papr = new Papr()

src/papr-helper.ts

@@ -1,6 +1,6 @@
 import type {Model} from 'papr'
 import type {Db} from 'mongodb'
-import {asModel} from './index.js'
+import type {asModel} from './index.js'
 
 export type PaprModelItem = ReturnType<typeof asModel>
 

src/types.ts

@@ -1,5 +1,6 @@
 import {fastify} from 'fastify'
-import anyTest, {TestFn} from 'ava'
+import type {TestFn} from 'ava'
+import anyTest from 'ava'
 import {MongoMemoryServer} from 'mongodb-memory-server'
 import {MongoClient} from 'mongodb'
 

tests/helpers/server.ts

@@ -1,4 +1,5 @@
-import {Model, schema, types} from 'papr'
+import type {Model} from 'papr'
+import {schema, types} from 'papr'
 import test from 'ava'
 import {MongoClient, MongoServerError} from 'mongodb'
 import fastifyPaprPlugin, {asModel} from '../src/index.js'

tests/muliple.col.test.ts

@@ -1,4 +1,5 @@
-import {Model, schema, types} from 'papr'
+import type {Model} from 'papr'
+import {schema, types} from 'papr'
 import test from 'ava'
 import {MongoClient} from 'mongodb'
 import fastifyPaprPlugin, {asModel} from '../src/index.js'

tests/multi.db.test.ts

@@ -1,4 +1,5 @@
-import {Model, schema, types, BaseSchema} from 'papr'
+import type {Model} from 'papr'
+import {schema, types, BaseSchema} from 'papr'
 import {MongoServerError} from 'mongodb'
 import fastifyPaprPlugin, {asModel} from '../src/index.js'
 import {getConfiguredTestServer, test} from './helpers/server.js'

tests/simple.test.ts

@@ -1,4 +1,5 @@
-import {Model, schema, types} from 'papr'
+import type {Model} from 'papr'
+import {schema, types} from 'papr'
 import {MongoServerError} from 'mongodb'
 import fastifyPaprPlugin, {asModel} from '../src/index.js'
 import {SimpleDocFailedValidationError} from '../src/simple-doc-failed-validation.js'