mindee - npm Package Compare versions

Comparing version 2.0.0 to 2.0.1

CHANGELOG.md

 # CHANGELOG
 
-## v2.0.0 (2022-08-26)
+## v2.0.1 - 2022-10-13
+### Fixes
+* :bug: Fix for packaging and documentation related to commonJS imports
+
+## v2.0.0 - 2022-08-26
 ### Note
@@ -5,0 +9,0 @@ This is a complete rewrite in TypeScript!

package.json

 {
-  "name": "mindee",
-  "version": "2.0.0",
-  "description": "Mindee Client Library for Node.js",
-  "main": "src/index.js",
-  "license": "MIT",
-  "scripts": {
-    "build": "tsc --build",
-    "clean": "rm -rf ./dist",
-    "test": "mocha 'tests/**/*.spec.ts'",
-    "lint-fix": "eslint 'src/**/*.ts' --fix",
-    "lint": "eslint 'src/**/*.ts' --report-unused-disable-directives && echo 'Your .ts files look good.'",
-    "docs": "jsdoc -r src -d docs"
-  },
-  "files": [
-    "dist/",
-    "bin/",
-    "LICENSE",
-    "README.md",
-    "CHANGELOG.md"
-  ],
-  "engines": {
-    "node": ">= 14.0.0"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/mindee/mindee-api-nodejs.git"
-  },
-  "author": {
-    "name": "Mindee",
-    "email": "[e-mail]",
-    "url": "https://mindee.com/"
-  },
-  "bugs": {
-    "url": "https://github.com/mindee/mindee-api-nodejs/issues"
-  },
-  "homepage": "https://mindee.com/",
-  "devDependencies": {
-    "@tsconfig/node16": "^1.0.3",
-    "@types/chai": "^4.3.1",
-    "@types/mocha": "^9.1.1",
-    "@types/node": "^17.0.38",
-    "@typescript-eslint/eslint-plugin": "^5.30.0",
-    "@typescript-eslint/parser": "^5.30.0",
-    "chai": "^4.3.6",
-    "eslint": "^8.18.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-prettier": "^4.1.0",
-    "jsdoc": "^3.6.10",
-    "mocha": "^10.0.0",
-    "prettier": "^2.7.1",
-    "ts-node": "^10.8.1",
-    "typescript": "^4.7.4"
-  },
-  "dependencies": {
-    "commander": "^9.4.0",
-    "file-type": "^16.5.4",
-    "form-data": "^3.0.1",
-    "mrz": "^3.1.4",
-    "pdf-lib": "^1.17.1"
-  },
-  "keywords": [
-    "typescript",
-    "mindee",
-    "api",
-    "client",
-    "client library",
-    "nodejs"
-  ]
+    "name": "mindee",
+    "version": "2.0.1",
+    "description": "Mindee Client Library for Node.js",
+    "main": "src/index.js",
+    "bin": "bin/mindee.js",
+    "license": "MIT",
+    "scripts": {
+        "build": "tsc --build && cp LICENSE README.md CHANGELOG.md ./dist",
+        "clean": "rm -rf ./dist",
+        "test": "mocha 'tests/**/*.spec.ts'",
+        "lint-fix": "eslint '**/*.ts' --fix",
+        "lint": "eslint '**/*.ts' --report-unused-disable-directives && echo 'Your .ts files look good.'",
+        "docs": "jsdoc -r src -d docs"
+    },
+    "files": [
+        "src/*",
+        "bin/*",
+        "LICENSE",
+        "README.md",
+        "CHANGELOG.md"
+    ],
+    "engines": {
+        "node": ">= 14"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/mindee/mindee-api-nodejs.git"
+    },
+    "author": {
+        "name": "Mindee",
+        "email": "[e-mail]",
+        "url": "https://mindee.com/"
+    },
+    "bugs": {
+        "url": "https://github.com/mindee/mindee-api-nodejs/issues"
+    },
+    "homepage": "https://mindee.com/",
+    "devDependencies": {
+        "@types/chai": "^4.3.1",
+        "@types/mocha": "^9.1.1",
+        "@types/node": "^17.0.38",
+        "@typescript-eslint/eslint-plugin": "^5.30.0",
+        "@typescript-eslint/parser": "^5.30.0",
+        "chai": "^4.3.6",
+        "eslint": "^8.18.0",
+        "eslint-config-prettier": "^8.5.0",
+        "eslint-plugin-prettier": "^4.1.0",
+        "jsdoc": "^3.6.10",
+        "mocha": "^10.0.0",
+        "prettier": "^2.7.1",
+        "ts-node": "^10.8.1",
+        "typescript": "^4.7.4"
+    },
+    "dependencies": {
+        "commander": "^9.4.0",
+        "file-type": "^16.5.4",
+        "form-data": "^3.0.1",
+        "mrz": "^3.1.4",
+        "pdf-lib": "^1.17.1"
+    },
+    "keywords": [
+        "typescript",
+        "mindee",
+        "api",
+        "client",
+        "client library",
+        "nodejs"
+    ]
 }

README.md

@@ -16,27 +16,31 @@ # Mindee API Helper Library for Node.js
 
-### Off-the-Shelf Document
+### Off-the-Shelf Documents
 
-```ts
-import { Client, InvoiceResponse } from "mindee";
+```js
+const mindee = require("mindee");
+// for TS or modules:
+// import * as mindee from "mindee";
 
 // Init a new client
-const mindeeClient = new Client({apiKey: "my-api-key"});
+const mindeeClient = new mindee.Client({apiKey: "my-api-key"});
 
 // Load a file from disk and parse it
 const invoiceResponse = mindeeClient.docFromPath("/path/to/the/invoice.pdf")
-  .parse(InvoiceResponse);
+    .parse(mindee.InvoiceResponse);
 
 // Print a brief summary of the parsed data
 invoiceResponse.then((resp) => {
-  console.log(resp.document);
+    console.log(resp.document);
 });
 ```
 
-### Custom Document (API Builder)
+### Custom Documents (API Builder)
 
-```ts
-import { Client, CustomResponse } from "mindee";
+```js
+const mindee = require("mindee");
+// for TS or modules:
+// import * as mindee from "mindee";
 
 // Init a new client and add your document endpoint
-const mindeeClient = new Client({apiKey: "my-api-key"})
+const mindeeClient = new mindee.Client({apiKey: "my-api-key"})
   .addEndpoint({
@@ -49,3 +53,3 @@ accountName: "john",
 const customResponse = mindeeClient.docFromPath("/path/to/the/wsnine.jpg")
-  .parse(CustomResponse, {docType: "wsnine"});
+  .parse(mindee.CustomResponse, {docType: "wsnine"});
 
@@ -52,0 +56,0 @@ // Print a brief summary of the parsed data

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Dev dependency count

14

decreased by-6.67%

Number of lines in readme file

71

increased by5.97%

Worsened metrics

Total package byte prevSize

138059

decreased by-4.32%

Lines of code

3320

decreased by-1.4%

No dependency changes