🎨 use the TS output directory for publishing

Author: ianardee

.github/workflows/license.yml

@@ -13,7 +13,7 @@ jobs:
 
     steps:
       - name: Check out Git repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Set up Node.js
         uses: actions/setup-node@v3
@@ -22,7 +22,7 @@ jobs:
           cache: "npm"
 
       - name: Install Node.js dependencies
-        run: npm install
+        run: npm ci
 
       - name: Install NPM License Checker
         run: npm install -g license-checker

.github/workflows/linting.yml

@@ -10,7 +10,7 @@ jobs:
 
     steps:
       - name: Check out Git repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Set up Node.js
         uses: actions/setup-node@v2
@@ -19,7 +19,7 @@ jobs:
           cache: "npm"
 
       - name: Install Node.js dependencies
-        run: npm install
+        run: npm ci
 
       - name: Test lint
         run: npm run lint

.github/workflows/publish.yml

@@ -14,7 +14,7 @@ jobs:
 
     steps:
       - name: Check out Git repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Set up Node.js
         uses: actions/setup-node@v3
@@ -23,7 +23,13 @@ jobs:
           cache: "npm"
 
       - name: Install Node.js dependencies
-        run: npm install
+        run: npm ci
 
-      - name: Publish dry run
-        run: npm publish --dry-run
+      - name: Build
+        run: npm run build
+
+      - name: Publish
+        run: |
+          cd ./dist
+          npm set "//registry.npmjs.org/:_authToken" ${{ secrets.NPM_PUBLISH_TOKEN }}
+          npm publish

.github/workflows/test.yml

@@ -16,7 +16,7 @@ jobs:
 
     steps:
       - name: Check out Git repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           submodules: recursive
 
@@ -29,7 +29,7 @@ jobs:
       - name: Install Node.js dependencies
         run: |
           npm install npm@latest -g
-          npm install
+          npm ci
 
       - name: Compilation
         run: npm run build

README.md

@@ -13,39 +13,43 @@ npm install mindee
 
 Finally, Node.js away!
 
-### 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({
     accountName: "john",
     documentType: "wsnine",
 });
 
 // Load a file from disk and parse it
 const customResponse = mindeeClient.docFromPath("/path/to/the/wsnine.jpg")
-  .parse(CustomResponse, {docType: "wsnine"});
+  .parse(mindee.CustomResponse, {docType: "wsnine"});
 
 // Print a brief summary of the parsed data
 customResponse.then((resp) => {

bin/mindee

@@ -1,3 +1,5 @@
 #!/usr/bin/env node
 
-require('../src/cli').cli();
+import { cli } from "../src/cli";
+
+cli();

bin/mindee.ts

@@ -1,26 +1,27 @@
 {
   "name": "mindee",
-  "version": "2.0.0",
+  "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",
+    "build": "tsc --build && cp LICENSE README.md CHANGELOG.md ./dist",
     "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.'",
+    "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": [
-    "dist/",
-    "bin/",
+    "src/*",
+    "bin/*",
     "LICENSE",
     "README.md",
     "CHANGELOG.md"
   ],
   "engines": {
-    "node": ">= 14.0.0"
+    "node": ">= 14"
   },
   "repository": {
     "type": "git",
@@ -36,7 +37,6 @@
   },
   "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",

package-lock.json

@@ -1,23 +1,25 @@
 {
-  "extends": "@tsconfig/node16/tsconfig.json",
   "compilerOptions": {
-    "lib": ["ES2015"],
-    "target": "ES2015",
+    "lib": ["ES2020"],
     "module": "commonjs",
-    "moduleResolution": "node",
+    "target": "ES2020",
+
     "strict": true,
     "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "node",
+
     "resolveJsonModule": true,
     "declaration": true,
     "outDir": "dist",
-    "rootDir": "./",
     "baseUrl": "./",
     "sourceMap": false,
     "newLine": "lf",
     "paths": {
-        "@mindee/*": ["./src/*"],
-      }
+      "@mindee/*": ["src/*"],
+    }
   },
-  "include": ["./src/**/*", "./bin/**/*"],
+  "include": ["./src/**/*", "./bin/**/*", "LICENSE"],
   "exclude": ["./node_modules/", "./dist/", "./tests/"]
 }