@tomsd/mongodbclient 3.0.7 → 3.0.9

package/.eslintrc.js

@@ -0,0 +1,19 @@
+module.exports = {
+  env: {
+    es2021: true,
+    node: true
+  },
+  extends: [
+    'standard-with-typescript',
+    'prettier'
+  ],
+  overrides: [
+  ],
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+    project: './tsconfig.base.json'
+  },
+  rules: {
+  }
+}

package/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Use Node.js
+      uses: actions/setup-node@v1
+      with:
+        node-version: '16.x'
+
+    - name: npm ci and build and test
+      run: |
+        npm install
+        npm run build
+        npm test

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx lint-staged

package/README.md

@@ -1,6 +1,7 @@
 # @tomsd/mongodbclient
 
-It's a handy mongodb client for easy-use.
+It's a handy mongodb client for easy-use.  
+See [mongodbclient.netlify.app](https://mongodbclient.netlify.app/) for details.
 
 ![npm](https://img.shields.io/npm/v/@tomsd/mongodbclient)
 ![NPM](https://img.shields.io/npm/l/@tomsd/mongodbclient)

package/dist/cjs/mongodbclient.js

@@ -10,13 +10,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MClient = exports.MongoConnection = void 0;
-/*!
- * @license mongodbclient
- * (c) 2020 tom
- * License: MIT
-*/
-const MongoClient = require("mongodb").MongoClient;
 const uuid_1 = require("uuid");
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const MongoClient = require("mongodb").MongoClient;
 class MongoConnection {
     constructor(client, db, collection) {
         this._client = client;
@@ -51,15 +47,13 @@ class MClient {
     }
     connect() {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.getConnected();
+            return yield this.getConnected();
         });
     }
     getConnected() {
         return __awaiter(this, void 0, void 0, function* () {
             const client = new MongoClient(this.m_uri, { useUnifiedTopology: true });
-            return client
-                .connect()
-                .then((client) => {
+            return client.connect().then((client) => {
                 const db = client.db(this.m_db);
                 const collection = db.collection(this.m_collection);
                 return new MongoConnection(client, db, collection);
@@ -73,9 +67,6 @@ class MClient {
             try {
                 return yield connection.collection.updateOne({ _id: savingObj._id }, { $set: savingObj }, { upsert: true, writeConcern: { w: 1 } });
             }
-            catch (e) {
-                throw e;
-            }
             finally {
                 connection.client.close();
             }
@@ -85,13 +76,7 @@ class MClient {
         return __awaiter(this, void 0, void 0, function* () {
             const connection = yield this.getConnected();
             try {
-                return yield connection
-                    .collection
-                    .find(condition, opt)
-                    .toArray();
-            }
-            catch (e) {
-                throw e;
+                return yield connection.collection.find(condition, opt).toArray();
             }
             finally {
                 connection.client.close();
@@ -104,9 +89,6 @@ class MClient {
             try {
                 return (yield connection.collection.distinct(key, condition));
             }
-            catch (e) {
-                throw e;
-            }
             finally {
                 connection.client.close();
             }
@@ -116,10 +98,9 @@ class MClient {
         return __awaiter(this, void 0, void 0, function* () {
             const connection = yield this.getConnected();
             try {
-                return yield connection.collection.deleteMany(condition, { writeConcern: { w: 1 } });
-            }
-            catch (e) {
-                throw e;
+                return yield connection.collection.deleteMany(condition, {
+                    writeConcern: { w: 1 },
+                });
             }
             finally {
                 connection.client.close();
@@ -132,9 +113,6 @@ class MClient {
             try {
                 return yield connection.collection.stats();
             }
-            catch (e) {
-                throw e;
-            }
             finally {
                 connection.client.close();
             }
@@ -146,9 +124,6 @@ class MClient {
             try {
                 return (yield connection.collection.countDocuments(condition));
             }
-            catch (e) {
-                throw e;
-            }
             finally {
                 connection.client.close();
             }
@@ -157,13 +132,11 @@ class MClient {
     insertMany(items) {
         return __awaiter(this, void 0, void 0, function* () {
             const connection = yield this.getConnected();
-            const savingItems = items.map(item => (Object.assign({ _id: (0, uuid_1.v4)() }, item)));
+            const savingItems = items.map((item) => (Object.assign({ _id: (0, uuid_1.v4)() }, item)));
             try {
-                return yield connection.collection
-                    .insertMany(savingItems, { writeConcern: { w: 1 } });
-            }
-            catch (e) {
-                throw e;
+                return yield connection.collection.insertMany(savingItems, {
+                    writeConcern: { w: 1 },
+                });
             }
             finally {
                 connection.client.close();
@@ -176,9 +149,6 @@ class MClient {
             try {
                 return yield connection.db.stats();
             }
-            catch (e) {
-                throw e;
-            }
             finally {
                 connection.client.close();
             }
@@ -190,9 +160,6 @@ class MClient {
             try {
                 return yield connection.db.collections();
             }
-            catch (e) {
-                throw e;
-            }
             finally {
                 connection.client.close();
             }

package/dist/esm/mongodbclient.d.ts

@@ -2,22 +2,22 @@
  * @license mongodbclient
  * (c) 2020 tom
  * License: MIT
-*/
+ */
+import { Db, Collection, CollStats, DeleteResult, Document, InsertManyResult, UpdateResult, WithId } from "mongodb";
 declare const MongoClient: any;
-import { Db, Collection, CollStats, WithId, Document, InsertManyResult, UpdateResult, DeleteResult } from "mongodb";
 export declare class MongoConnection {
-    private _client;
-    private _db;
-    private _collection;
+    private readonly _client;
+    private readonly _db;
+    private readonly _collection;
     constructor(client: typeof MongoClient, db: Db, collection: Collection);
     get client(): typeof MongoClient;
     get db(): Db;
     get collection(): Collection;
 }
 export declare class MClient {
-    private m_uri;
-    private m_db;
-    private m_collection;
+    private readonly m_uri;
+    private readonly m_db;
+    private readonly m_collection;
     constructor(uri: string, db: string, collection: string);
     get uri(): string;
     get db(): string;
@@ -25,7 +25,7 @@ export declare class MClient {
     connect(): Promise<MongoConnection>;
     protected getConnected(): Promise<MongoConnection>;
     upsert(pobj: any): Promise<UpdateResult>;
-    read(condition?: any, opt?: any): Promise<WithId<Document>[]>;
+    read(condition?: any, opt?: any): Promise<Array<WithId<Document>>>;
     distinct(key: string, condition?: any): Promise<any[]>;
     remove(condition: any): Promise<DeleteResult>;
     stats(): Promise<CollStats>;

package/dist/esm/mongodbclient.js

@@ -7,13 +7,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-/*!
- * @license mongodbclient
- * (c) 2020 tom
- * License: MIT
-*/
-const MongoClient = require("mongodb").MongoClient;
 import { v4 as uuidv4 } from "uuid";
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const MongoClient = require("mongodb").MongoClient;
 export class MongoConnection {
     constructor(client, db, collection) {
         this._client = client;
@@ -47,15 +43,13 @@ export class MClient {
     }
     connect() {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.getConnected();
+            return yield this.getConnected();
         });
     }
     getConnected() {
         return __awaiter(this, void 0, void 0, function* () {
             const client = new MongoClient(this.m_uri, { useUnifiedTopology: true });
-            return client
-                .connect()
-                .then((client) => {
+            return client.connect().then((client) => {
                 const db = client.db(this.m_db);
                 const collection = db.collection(this.m_collection);
                 return new MongoConnection(client, db, collection);
@@ -69,9 +63,6 @@ export class MClient {
             try {
                 return yield connection.collection.updateOne({ _id: savingObj._id }, { $set: savingObj }, { upsert: true, writeConcern: { w: 1 } });
             }
-            catch (e) {
-                throw e;
-            }
             finally {
                 connection.client.close();
             }
@@ -81,13 +72,7 @@ export class MClient {
         return __awaiter(this, void 0, void 0, function* () {
             const connection = yield this.getConnected();
             try {
-                return yield connection
-                    .collection
-                    .find(condition, opt)
-                    .toArray();
-            }
-            catch (e) {
-                throw e;
+                return yield connection.collection.find(condition, opt).toArray();
             }
             finally {
                 connection.client.close();
@@ -100,9 +85,6 @@ export class MClient {
             try {
                 return (yield connection.collection.distinct(key, condition));
             }
-            catch (e) {
-                throw e;
-            }
             finally {
                 connection.client.close();
             }
@@ -112,10 +94,9 @@ export class MClient {
         return __awaiter(this, void 0, void 0, function* () {
             const connection = yield this.getConnected();
             try {
-                return yield connection.collection.deleteMany(condition, { writeConcern: { w: 1 } });
-            }
-            catch (e) {
-                throw e;
+                return yield connection.collection.deleteMany(condition, {
+                    writeConcern: { w: 1 },
+                });
             }
             finally {
                 connection.client.close();
@@ -128,9 +109,6 @@ export class MClient {
             try {
                 return yield connection.collection.stats();
             }
-            catch (e) {
-                throw e;
-            }
             finally {
                 connection.client.close();
             }
@@ -142,9 +120,6 @@ export class MClient {
             try {
                 return (yield connection.collection.countDocuments(condition));
             }
-            catch (e) {
-                throw e;
-            }
             finally {
                 connection.client.close();
             }
@@ -153,13 +128,11 @@ export class MClient {
     insertMany(items) {
         return __awaiter(this, void 0, void 0, function* () {
             const connection = yield this.getConnected();
-            const savingItems = items.map(item => (Object.assign({ _id: uuidv4() }, item)));
+            const savingItems = items.map((item) => (Object.assign({ _id: uuidv4() }, item)));
             try {
-                return yield connection.collection
-                    .insertMany(savingItems, { writeConcern: { w: 1 } });
-            }
-            catch (e) {
-                throw e;
+                return yield connection.collection.insertMany(savingItems, {
+                    writeConcern: { w: 1 },
+                });
             }
             finally {
                 connection.client.close();
@@ -172,9 +145,6 @@ export class MClient {
             try {
                 return yield connection.db.stats();
             }
-            catch (e) {
-                throw e;
-            }
             finally {
                 connection.client.close();
             }
@@ -186,9 +156,6 @@ export class MClient {
             try {
                 return yield connection.db.collections();
             }
-            catch (e) {
-                throw e;
-            }
             finally {
                 connection.client.close();
             }

package/package.json

@@ -1,15 +1,36 @@
 {
   "name": "@tomsd/mongodbclient",
-  "version": "3.0.7",
+  "version": "3.0.9",
   "description": "It's a handy mongodb client for easy-use.",
   "main": "dist/cjs/mongodbclient.js",
   "module": "dist/esm/mongodbclient.js",
   "types": "dist/esm/mongodbclient.d.ts",
   "scripts": {
     "build": "tsc --project tsconfig.cjs.json && tsc --project tsconfig.esm.json",
+    "format": "npm run format:src && npm run format:test",
+    "format:document": "prettier --write docs/**/*.html",
+    "format:src": "prettier --write src/**/*.ts",
+    "format:test": "prettier --write test/**/*.ts",
+    "lint:src": "eslint src/**/*.ts",
+    "lint:test": "eslint test/**/*.ts",
+    "prepare": "husky install",
+    "serve:doc": "mdbook --serve --directory docs",
     "test": "exit 0",
     "test_with_dburi": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' mocha -r ts-node/register \"test/test.ts\" --timeout 30000"
   },
+  "lint-staged": {
+    "docs/**/*.html": [
+      "npm run format:document"
+    ],
+    "src/**/*.ts": [
+      "npm run lint:src",
+      "npm run format:src"
+    ],
+    "test/**/*.ts": [
+      "npm run lint:test",
+      "npm run format:test"
+    ]
+  },
   "keywords": [
     "mongodb"
   ],
@@ -24,12 +45,23 @@
     "uuid": "^8.3.2"
   },
   "devDependencies": {
+    "@tomsd/md-book": "^0.16.0",
     "@types/mocha": "^9.1.1",
     "@types/node": "^14.14.5",
     "@types/uuid": "^8.3.4",
+    "@typescript-eslint/eslint-plugin": "^5.38.0",
     "dotenv": "^16.0.1",
+    "eslint": "^8.24.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-config-standard-with-typescript": "^23.0.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-n": "^15.3.0",
+    "eslint-plugin-promise": "^6.0.1",
+    "husky": "^8.0.1",
+    "lint-staged": "^13.0.3",
     "mocha": "^7.0.1",
+    "prettier": "^2.7.1",
     "ts-node": "^10.8.1",
-    "typescript": "^4.7.4"
+    "typescript": "^4.8.3"
   }
 }

package/test/test.ts

@@ -1,11 +1,9 @@
-// @ts-ignore
-import dotenv from "dotenv";
-dotenv.config();
-
-import {describe, it } from "mocha";
+import { describe, it } from "mocha";
 import { MClient } from "../src/mongodbclient";
 import { strict as assert } from "assert";
 import { v4 as uuidv4 } from "uuid";
+import dotenv from "dotenv";
+dotenv.config();
 
 const mongouri = process.env.MONGODB_URI as string;
 const dbName = uuidv4();
@@ -14,10 +12,10 @@ const collName = uuidv4();
 const mdbc = new MClient(mongouri, dbName, collName);
 
 const items = [
-  {name:"alice"},
-  {name:"bob"},
-  {name:"charlie"},
-  {name:"alice"}
+  { name: "alice" },
+  { name: "bob" },
+  { name: "charlie" },
+  { name: "alice" },
 ];
 
 describe("MClient", () => {
@@ -33,14 +31,19 @@ describe("MClient", () => {
 
   it("read()", async () => {
     const docs = await mdbc.read();
-    const getNames = (items: any[]) =>
-      Array.from(new Set(items.map(({ name }) => name))).sort().join("\n");
+    const getNames = (items: any[]): string =>
+      Array.from(new Set(items.map(({ name }) => name)))
+        .sort((a, b) => (a > b ? 1 : -1))
+        .join("\n");
     assert.equal(getNames(docs), getNames(docs));
   });
 
   it("upsert()", async () => {
     const docs = await mdbc.read();
-    const { modifiedCount } = await mdbc.upsert({ _id: docs[0]._id, name: "david" });
+    const { modifiedCount } = await mdbc.upsert({
+      _id: docs[0]._id,
+      name: "david",
+    });
     assert.equal(modifiedCount, 1);
   });
 
@@ -60,8 +63,8 @@ describe("MClient", () => {
   });
 
   it("count()", async () => {
-    const n = await mdbc.count({name:"alice"});
-    assert.equal(n,1);
+    const n = await mdbc.count({ name: "alice" });
+    assert.equal(n, 1);
   });
 
   it("remove()", async () => {

package/dist/cjs/mongodbclient.d.ts

@@ -1,37 +0,0 @@
-/*!
- * @license mongodbclient
- * (c) 2020 tom
- * License: MIT
-*/
-declare const MongoClient: any;
-import { Db, Collection, CollStats, WithId, Document, InsertManyResult, UpdateResult, DeleteResult } from "mongodb";
-export declare class MongoConnection {
-    private _client;
-    private _db;
-    private _collection;
-    constructor(client: typeof MongoClient, db: Db, collection: Collection);
-    get client(): typeof MongoClient;
-    get db(): Db;
-    get collection(): Collection;
-}
-export declare class MClient {
-    private m_uri;
-    private m_db;
-    private m_collection;
-    constructor(uri: string, db: string, collection: string);
-    get uri(): string;
-    get db(): string;
-    get collection(): string;
-    connect(): Promise<MongoConnection>;
-    protected getConnected(): Promise<MongoConnection>;
-    upsert(pobj: any): Promise<UpdateResult>;
-    read(condition?: any, opt?: any): Promise<WithId<Document>[]>;
-    distinct(key: string, condition?: any): Promise<any[]>;
-    remove(condition: any): Promise<DeleteResult>;
-    stats(): Promise<CollStats>;
-    count(condition?: any): Promise<number>;
-    insertMany(items: any[]): Promise<InsertManyResult<Document>>;
-    dbStats(): Promise<Document>;
-    getCollections(): Promise<Collection[]>;
-}
-export default MClient;