♻️ Move back to cjs and use lowdb v1

Author: BetaHuhn

README.md

@@ -36,6 +36,12 @@ Then import it into your project:
 import * as DetaOrm from 'deta-base-orm'
 ```
 
+Or:
+
+```ts
+const DetaOrm = require('deta-base-orm')
+```
+
 ### Example
 
 Here's a quick example to help you get started!

example/index.js

@@ -1,4 +1,5 @@
-import * as DetaOrm from '../lib/index'
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const DetaOrm = require('../lib/index') // const DetaOrm = require('deta-base-orm')
 
 const run = async () => {
 	// Create the model

lib/Base.js

@@ -1,3 +1,4 @@
+"use strict";
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -7,28 +8,30 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Base = void 0;
 /* eslint-disable valid-jsdoc */
-import { Deta } from 'deta';
-import { generateKey } from './random';
-import { OfflineDB } from './Offline';
-import { Schema } from './Schema';
-import { Document } from './Document';
+const deta_1 = require("deta");
+const random_1 = require("./random");
+const Offline_1 = require("./Offline");
+const Schema_1 = require("./Schema");
+const Document_1 = require("./Document");
 /**
  * Create and interact with a Deta Base
 */
-export class Base {
+class Base {
     /**
      * Create a new Base with the provided name, schema and options
      * @param {string} name Name of the Base
      * @param {BaseOptions} opts Options object
     */
     constructor(name, schema, opts) {
         this._baseName = name;
-        if (schema instanceof Schema) {
+        if (schema instanceof Schema_1.Schema) {
             this._baseSchema = schema;
         }
         else {
-            this._baseSchema = new Schema(schema);
+            this._baseSchema = new Schema_1.Schema(schema);
         }
         // Parse options
         const ascending = (opts === null || opts === void 0 ? void 0 : opts.descending) !== true;
@@ -37,7 +40,7 @@ export class Base {
         const storagePath = (opts === null || opts === void 0 ? void 0 : opts.storagePath) || '.deta-base-orm';
         this._opts = { ascending, timestamp, offline, storagePath };
         if (this._opts.offline) {
-            this._db = new OfflineDB(this._opts.storagePath, this._baseName);
+            this._db = new Offline_1.OfflineDB(this._opts.storagePath, this._baseName);
             return;
         }
         // Reuse Deta Base
@@ -47,7 +50,7 @@ export class Base {
             return;
         }
         // Create new Deta Base instance
-        const deta = Deta();
+        const deta = deta_1.Deta();
         this._db = deta.Base(name);
     }
     /**
@@ -57,12 +60,12 @@ export class Base {
      */
     create(rawData) {
         // Set configs
-        Document._baseName = this._baseName;
-        Document._db = this._db;
-        Document._opts = this._opts;
+        Document_1.Document._baseName = this._baseName;
+        Document_1.Document._db = this._db;
+        Document_1.Document._opts = this._opts;
         // Auto generate a key if is missing
         if (!rawData.key) {
-            rawData.key = generateKey(this._opts.ascending);
+            rawData.key = random_1.generateKey(this._opts.ascending);
         }
         // Add timestamp to document
         if (this._opts.timestamp && rawData.createdAt === undefined) {
@@ -76,7 +79,7 @@ export class Base {
         }
         const data = validated.result;
         // Create new document with data
-        return new Document(data, this._baseSchema);
+        return new Document_1.Document(data, this._baseSchema);
     }
     /**
      * Helper function to create and immediately save a new document
@@ -258,3 +261,4 @@ export class Base {
         });
     }
 }
+exports.Base = Base;

lib/Document.js

@@ -1,3 +1,4 @@
+"use strict";
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -7,15 +8,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Document = void 0;
 /* eslint-disable @typescript-eslint/explicit-module-boundary-types */
 /* eslint-disable valid-jsdoc */
-import { Deta } from 'deta';
-import { generateKey } from './random';
+const deta_1 = require("deta");
+const random_1 = require("./random");
 /**
  * Represents a Document with all of its data and methods
  * @internal
 */
-export class Document {
+class Document {
     /**
      * Create a new Document instance with the provided data.
      *
@@ -24,7 +27,7 @@ export class Document {
     */
     constructor(data, _baseSchema) {
         Object.assign(this, data);
-        this.key = this.key || generateKey(Document._opts.ascending);
+        this.key = this.key || random_1.generateKey(Document._opts.ascending);
         // Add timestamp to document
         if (Document._opts.timestamp && this.createdAt === undefined) {
             this.createdAt = Date.now();
@@ -65,7 +68,7 @@ export class Document {
             if (!baseName)
                 throw new Error(`Can't populate this path because it doesn't have a baseName defined`);
             // Create new Deta Base instance
-            const deta = Deta();
+            const deta = deta_1.Deta();
             const db = deta.Base(baseName);
             const key = this[path];
             const rawData = yield db.get(key);
@@ -104,3 +107,4 @@ export class Document {
         });
     }
 }
+exports.Document = Document;

lib/Offline.d.ts

@@ -1,8 +1,6 @@
-import { Low, Adapter } from 'lowdb';
-import lodash from 'lodash';
-declare class LowDash<T> extends Low<T> {
-    chain?: lodash.CollectionChain<any> & lodash.FunctionChain<any> & lodash.ObjectChain<any> & lodash.PrimitiveChain<any> & lodash.StringChain;
-    constructor(adapter: Adapter<T>);
+import low from 'lowdb';
+interface DbSchema {
+    [k: string]: [any];
 }
 /**
  * Mocks the Deta Base SDK with a local database
@@ -12,8 +10,11 @@ declare class LowDash<T> extends Low<T> {
  * Note: Not all methods are implemented, only the ones need by deta-base-orm
  */
 export declare class OfflineDB {
-    db: LowDash<any>;
+    _db?: low.LowdbAsync<DbSchema>;
+    _adapter: any;
     _didLoad: boolean;
+    _filePath: string;
+    _baseName: string;
     constructor(storagePath?: string, fileName?: string);
     /**
      * Create a new instance of the OfflineDB with the file loaded automatically
@@ -40,7 +41,7 @@ export declare class OfflineDB {
      * Lists all items in the database
      * @returns All items in the database
      */
-    list(): Promise<any[] | undefined>;
+    list(): Promise<DbSchema | undefined>;
     /**
      * Implements the get API
      * @param key The key of the item to be retrieved

lib/Offline.js

@@ -1,3 +1,4 @@
+"use strict";
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -7,36 +8,38 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OfflineDB = void 0;
 /* eslint-disable valid-jsdoc */
 /* eslint-disable @typescript-eslint/explicit-module-boundary-types */
-import { join } from 'path';
-import fs from 'fs';
-import { Low, JSONFile } from 'lowdb';
-import lodash from 'lodash';
-class LowDash extends Low {
-    constructor(adapter) {
-        super(adapter);
-    }
-}
+const path_1 = require("path");
+const fs_1 = __importDefault(require("fs"));
+const lowdb_1 = __importDefault(require("lowdb"));
+const FileAsync_1 = __importDefault(require("lowdb/adapters/FileAsync"));
+const lodash_1 = require("lodash");
 /**
  * Mocks the Deta Base SDK with a local database
  *
  * It uses a local JSON file for each Base.
  *
  * Note: Not all methods are implemented, only the ones need by deta-base-orm
  */
-export class OfflineDB {
+class OfflineDB {
     constructor(storagePath = '.deta-base-orm', fileName = 'base') {
-        const folderExists = fs.existsSync(storagePath);
+        const folderExists = fs_1.default.existsSync(storagePath);
         if (!folderExists) {
             if (storagePath !== '.deta-base-orm') {
                 throw new Error(`The folder "${storagePath}" does not exist, please create it manually`);
             }
-            fs.mkdirSync(storagePath);
+            fs_1.default.mkdirSync(storagePath);
         }
-        const file = join(storagePath, `${fileName}.json`);
-        const adapter = new JSONFile(file);
-        this.db = new LowDash(adapter);
+        const file = path_1.join(storagePath, `${fileName}.json`);
+        this._baseName = fileName;
+        this._filePath = file;
+        this._adapter = new FileAsync_1.default(file);
         this._didLoad = false;
     }
     /**
@@ -57,11 +60,11 @@ export class OfflineDB {
      */
     init() {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.db.read();
-            if (this.db.data === null) {
-                this.db.data = [];
+            this._db = yield lowdb_1.default(this._adapter);
+            yield this._db.read();
+            if (this._db.get(this._baseName).value() === undefined) {
+                yield this._db.set(this._baseName, []).write();
             }
-            this.db.chain = lodash.chain(this.db.data);
             this._didLoad = true;
         });
     }
@@ -81,10 +84,10 @@ export class OfflineDB {
      * @returns The inserted data
      */
     put(data) {
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
             yield this.check();
-            this.db.data.push(data);
-            yield this.db.write();
+            yield ((_a = this._db) === null || _a === void 0 ? void 0 : _a.get(this._baseName).push(data).write());
             return data;
         });
     }
@@ -96,7 +99,7 @@ export class OfflineDB {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             yield this.check();
-            return (_a = this.db.chain) === null || _a === void 0 ? void 0 : _a.value();
+            return (_a = this._db) === null || _a === void 0 ? void 0 : _a.value();
         });
     }
     /**
@@ -108,7 +111,7 @@ export class OfflineDB {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             yield this.check();
-            return ((_a = this.db.chain) === null || _a === void 0 ? void 0 : _a.find({ key }).value()) || null;
+            return ((_a = this._db) === null || _a === void 0 ? void 0 : _a.get(this._baseName).find({ key }).value()) || null;
         });
     }
     /**
@@ -124,8 +127,8 @@ export class OfflineDB {
             let results = [];
             query.forEach((query) => {
                 var _a;
-                const items = (_a = this.db.chain) === null || _a === void 0 ? void 0 : _a.filter(query).value();
-                results = lodash.unionBy(results, items, 'key');
+                const items = (_a = this._db) === null || _a === void 0 ? void 0 : _a.get(this._baseName).filter(query).value();
+                results = lodash_1.unionBy(results, items, 'key');
             });
             if (!results) {
                 return { items: [], count: 0, last: undefined };
@@ -143,8 +146,7 @@ export class OfflineDB {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             yield this.check();
-            (_a = this.db.chain) === null || _a === void 0 ? void 0 : _a.remove({ key }).value();
-            yield this.db.write();
+            yield ((_a = this._db) === null || _a === void 0 ? void 0 : _a.get(this._baseName).remove({ key }).write());
             return null;
         });
     }
@@ -158,9 +160,9 @@ export class OfflineDB {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             yield this.check();
-            (_a = this.db.chain) === null || _a === void 0 ? void 0 : _a.update(key, updates).value();
-            yield this.db.write();
+            yield ((_a = this._db) === null || _a === void 0 ? void 0 : _a.get(this._baseName).update(key, updates).write());
             return null;
         });
     }
 }
+exports.OfflineDB = OfflineDB;

lib/Schema.js

@@ -1,8 +1,11 @@
-import { Base } from './Base';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Schema = void 0;
+const Base_1 = require("./Base");
 /**
  * Create a schema for your Base
 */
-export class Schema {
+class Schema {
     constructor(schema) {
         this.schema = this.parse(schema);
     }
@@ -20,7 +23,7 @@ export class Schema {
                 };
                 // Parse Base shorthand notation
             }
-            else if (value instanceof Base) {
+            else if (value instanceof Base_1.Base) {
                 parsedSchema[key] = {
                     __end: true,
                     type: 'base',
@@ -127,3 +130,4 @@ export class Schema {
         return { errors, result: result };
     }
 }
+exports.Schema = Schema;

lib/index.js

@@ -1,6 +1,13 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Schema = exports.Base = void 0;
 /* eslint-disable valid-jsdoc */
-import dotenv from 'dotenv';
-import { Base } from './Base';
-import { Schema } from './Schema';
-dotenv.config();
-export { Base, Schema };
+const dotenv_1 = __importDefault(require("dotenv"));
+const Base_1 = require("./Base");
+Object.defineProperty(exports, "Base", { enumerable: true, get: function () { return Base_1.Base; } });
+const Schema_1 = require("./Schema");
+Object.defineProperty(exports, "Schema", { enumerable: true, get: function () { return Schema_1.Schema; } });
+dotenv_1.default.config();