functional-models-orm-json 3.0.0

package/README.md

@@ -0,0 +1,22 @@
+# Functional Models ORM JSON
+
+![Unit Tests](https://github.com/monolithst/functional-models-orm-json/actions/workflows/ut.yml/badge.svg?branch=master)
+![Feature Tests](https://github.com/monolithst/functional-models-orm-json/actions/workflows/feature.yml/badge.svg?branch=master)
+[![Coverage Status](https://coveralls.io/repos/github/monolithst/functional-models-orm-json/badge.svg?branch=master)](https://coveralls.io/github/monolithst/functional-models-orm-json?branch=master)
+
+A [Functional Models](https://monolithst.github.io/functional-models/) datastoreAdapter implementation for json file databases.
+
+## Example
+
+```javascript
+const { jsonClient } = require('jsondb')
+const { createOrm } = require('functional-models')
+const { datastoreAdapter: jsonAdapter } = require('functional-models-orm-json')
+
+const filePathToJsonFile = ''
+const datastoreAdapter = jsonAdapter({
+  filePath: filePathToJsonFile,
+})
+
+const orm = createOrm({ datastoreAdapter })
+```

package/datastoreAdapter.d.ts

@@ -0,0 +1,11 @@
+import { DataDescription, DatastoreAdapter, ModelType } from 'functional-models';
+type WithRequired<T, K extends keyof T> = T & {
+    [P in K]-?: T[P];
+};
+type Props = {
+    filePath: string;
+    getCollectionNameForModel?: <T extends DataDescription>(model: ModelType<T>) => string;
+    fs?: any;
+};
+declare const create: ({ filePath, getCollectionNameForModel, fs, }: Props) => WithRequired<DatastoreAdapter, "bulkInsert" | "count" | "bulkDelete">;
+export { create };

package/datastoreAdapter.js

@@ -0,0 +1,103 @@
+"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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.create = void 0;
+const functional_models_orm_memory_1 = require("functional-models-orm-memory");
+const node_fs_1 = require("node:fs");
+const path_1 = require("path");
+const lib_1 = require("./lib");
+const loadDatabaseFromFile = (fs, filePath) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const data = yield fs.readFile(filePath, 'utf-8');
+        return JSON.parse(data);
+    }
+    catch (error) {
+        /* istanbul ignore next */
+        // eslint-disable-next-line functional/no-conditional-statements
+        if (error.code === 'ENOENT') {
+            return {};
+        }
+        throw error;
+    }
+});
+const saveDatabaseToFile = (fs, filePath, database) => __awaiter(void 0, void 0, void 0, function* () {
+    const dir = (0, path_1.dirname)(filePath);
+    yield fs.mkdir(dir, { recursive: true });
+    yield fs.writeFile(filePath, JSON.stringify(database, null, 2), 'utf-8');
+});
+/* istanbul ignore next */
+const create = ({ filePath, getCollectionNameForModel = lib_1.getCollectionNameForModel, fs = node_fs_1.promises, }) => {
+    let memoryAdapter = null;
+    const ensureInitialized = () => __awaiter(void 0, void 0, void 0, function* () {
+        if (memoryAdapter) {
+            return;
+        }
+        const fileData = yield loadDatabaseFromFile(fs, filePath);
+        memoryAdapter = functional_models_orm_memory_1.datastoreAdapter.create({
+            seedData: fileData,
+            getCollectionNameForModel,
+        });
+    });
+    const getMemoryAdapter = () => __awaiter(void 0, void 0, void 0, function* () {
+        yield ensureInitialized();
+        if (!memoryAdapter) {
+            /* istanbul ignore next */
+            throw new Error('Memory adapter not initialized');
+        }
+        return memoryAdapter;
+    });
+    const persistToFile = () => __awaiter(void 0, void 0, void 0, function* () {
+        yield saveDatabaseToFile(fs, filePath, (yield getMemoryAdapter()).getRecords());
+    });
+    return {
+        save: (instance) => __awaiter(void 0, void 0, void 0, function* () {
+            const adapter = yield getMemoryAdapter();
+            const result = yield adapter.save(instance);
+            yield persistToFile();
+            return result;
+        }),
+        delete: (model, id) => __awaiter(void 0, void 0, void 0, function* () {
+            yield ensureInitialized();
+            const adapter = yield getMemoryAdapter();
+            yield adapter.delete(model, id);
+            yield persistToFile();
+        }),
+        retrieve: (model, primaryKey) => __awaiter(void 0, void 0, void 0, function* () {
+            yield ensureInitialized();
+            const adapter = yield getMemoryAdapter();
+            return adapter.retrieve(model, primaryKey);
+        }),
+        search: (model, query) => __awaiter(void 0, void 0, void 0, function* () {
+            yield ensureInitialized();
+            const adapter = yield getMemoryAdapter();
+            return adapter.search(model, query);
+        }),
+        count: (model) => __awaiter(void 0, void 0, void 0, function* () {
+            yield ensureInitialized();
+            const adapter = yield getMemoryAdapter();
+            return adapter.count(model);
+        }),
+        bulkInsert: (model, instances) => __awaiter(void 0, void 0, void 0, function* () {
+            yield ensureInitialized();
+            const adapter = yield getMemoryAdapter();
+            yield adapter.bulkInsert(model, instances);
+            yield persistToFile();
+        }),
+        bulkDelete: (model, ids) => __awaiter(void 0, void 0, void 0, function* () {
+            yield ensureInitialized();
+            const adapter = yield getMemoryAdapter();
+            yield adapter.bulkDelete(model, ids);
+            yield persistToFile();
+        }),
+    };
+};
+exports.create = create;
+//# sourceMappingURL=datastoreAdapter.js.map

package/datastoreAdapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"datastoreAdapter.js","sourceRoot":"","sources":["../src/datastoreAdapter.ts"],"names":[],"mappings":";;;;;;;;;;;;AAYA,+EAAyF;AACzF,qCAA4C;AAC5C,+BAA8B;AAC9B,+BAA0E;AAY1E,MAAM,oBAAoB,GAAG,CAC3B,EAAO,EACP,QAAgB,EACuC,EAAE;IACzD,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;QACjD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IACzB,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QACpB,0BAA0B;QAC1B,gEAAgE;QAChE,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC5B,OAAO,EAAE,CAAA;QACX,CAAC;QACD,MAAM,KAAK,CAAA;IACb,CAAC;AACH,CAAC,CAAA,CAAA;AAED,MAAM,kBAAkB,GAAG,CACzB,EAAO,EACP,QAAgB,EAChB,QAAqD,EACtC,EAAE;IACjB,MAAM,GAAG,GAAG,IAAA,cAAO,EAAC,QAAQ,CAAC,CAAA;IAC7B,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;IACxC,MAAM,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,CAAA;AAC1E,CAAC,CAAA,CAAA;AAED,0BAA0B;AAC1B,MAAM,MAAM,GAAG,CAAC,EACd,QAAQ,EACR,yBAAyB,GAAG,+BAAqB,EACjD,EAAE,GAAG,kBAAM,GACL,EAGN,EAAE;IACF,IAAI,aAAa,GACf,IAAI,CAAA;IAEN,MAAM,iBAAiB,GAAG,GAAS,EAAE;QACnC,IAAI,aAAa,EAAE,CAAC;YAClB,OAAM;QACR,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,oBAAoB,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAA;QACzD,aAAa,GAAG,+CAAsB,CAAC,MAAM,CAAC;YAC5C,QAAQ,EAAE,QAAQ;YAClB,yBAAyB;SAC1B,CAAC,CAAA;IACJ,CAAC,CAAA,CAAA;IAED,MAAM,gBAAgB,GAAG,GAAS,EAAE;QAClC,MAAM,iBAAiB,EAAE,CAAA;QACzB,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,0BAA0B;YAC1B,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAA;QACnD,CAAC;QACD,OAAO,aAAa,CAAA;IACtB,CAAC,CAAA,CAAA;IAED,MAAM,aAAa,GAAG,GAAS,EAAE;QAC/B,MAAM,kBAAkB,CACtB,EAAE,EACF,QAAQ,EACR,CAAC,MAAM,gBAAgB,EAAE,CAAC,CAAC,UAAU,EAAE,CACxC,CAAA;IACH,CAAC,CAAA,CAAA;IAED,OAAO;QACL,IAAI,EAAE,CACJ,QAA8B,EACE,EAAE;YAClC,MAAM,OAAO,GAAG,MAAM,gBAAgB,EAAE,CAAA;YACxC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YAC3C,MAAM,aAAa,EAAE,CAAA;YACrB,OAAO,MAAM,CAAA;QACf,CAAC,CAAA;QACD,MAAM,EAAE,CACN,KAAsB,EACtB,EAAkB,EACH,EAAE;YACjB,MAAM,iBAAiB,EAAE,CAAA;YACzB,MAAM,OAAO,GAAG,MAAM,gBAAgB,EAAE,CAAA;YACxC,MAAM,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;YAC/B,MAAM,aAAa,EAAE,CAAA;QACvB,CAAC,CAAA;QACD,QAAQ,EAAE,CACR,KAAsB,EACtB,UAA0B,EACa,EAAE;YACzC,MAAM,iBAAiB,EAAE,CAAA;YACzB,MAAM,OAAO,GAAG,MAAM,gBAAgB,EAAE,CAAA;YACxC,OAAO,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC,CAAA;QAC5C,CAAC,CAAA;QACD,MAAM,EAAE,CACN,KAAsB,EACtB,KAAgB,EACuB,EAAE;YACzC,MAAM,iBAAiB,EAAE,CAAA;YACzB,MAAM,OAAO,GAAG,MAAM,gBAAgB,EAAE,CAAA;YACxC,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;QACrC,CAAC,CAAA;QACD,KAAK,EAAE,CACL,KAAsB,EACL,EAAE;YACnB,MAAM,iBAAiB,EAAE,CAAA;YACzB,MAAM,OAAO,GAAG,MAAM,gBAAgB,EAAE,CAAA;YACxC,OAAO,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;QAC7B,CAAC,CAAA;QACD,UAAU,EAAE,CACV,KAAsB,EACtB,SAA0C,EAC3B,EAAE;YACjB,MAAM,iBAAiB,EAAE,CAAA;YACzB,MAAM,OAAO,GAAG,MAAM,gBAAgB,EAAE,CAAA;YACxC,MAAM,OAAO,CAAC,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC,CAAA;YAC1C,MAAM,aAAa,EAAE,CAAA;QACvB,CAAC,CAAA;QACD,UAAU,EAAE,CACV,KAAsB,EACtB,GAA8B,EACf,EAAE;YACjB,MAAM,iBAAiB,EAAE,CAAA;YACzB,MAAM,OAAO,GAAG,MAAM,gBAAgB,EAAE,CAAA;YACxC,MAAM,OAAO,CAAC,UAAU,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;YACpC,MAAM,aAAa,EAAE,CAAA;QACvB,CAAC,CAAA;KACF,CAAA;AACH,CAAC,CAAA;AAEQ,wBAAM"}

package/index.d.ts

@@ -0,0 +1,3 @@
+import * as datastoreAdapter from './datastoreAdapter';
+export { getCollectionNameForModel } from './lib';
+export { datastoreAdapter };

package/index.js

@@ -0,0 +1,41 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.datastoreAdapter = exports.getCollectionNameForModel = void 0;
+const datastoreAdapter = __importStar(require("./datastoreAdapter"));
+exports.datastoreAdapter = datastoreAdapter;
+var lib_1 = require("./lib");
+Object.defineProperty(exports, "getCollectionNameForModel", { enumerable: true, get: function () { return lib_1.getCollectionNameForModel; } });
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qEAAsD;AAI7C,4CAAgB;AAFzB,6BAAiD;AAAxC,gHAAA,yBAAyB,OAAA"}

package/lib.d.ts

@@ -0,0 +1,2 @@
+import { DataDescription, ModelType } from 'functional-models';
+export declare const getCollectionNameForModel: <T extends DataDescription>(model: ModelType<T>) => string;

package/lib.js

@@ -0,0 +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.getCollectionNameForModel = void 0;
+const kebabCase_1 = __importDefault(require("lodash/kebabCase"));
+const getCollectionNameForModel = (model) => {
+    const name = model.getName().replaceAll('@', '').replaceAll('/', '-');
+    return (0, kebabCase_1.default)(name).toLowerCase();
+};
+exports.getCollectionNameForModel = getCollectionNameForModel;
+//# sourceMappingURL=lib.js.map

package/lib.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lib.js","sourceRoot":"","sources":["../src/lib.ts"],"names":[],"mappings":";;;;;;AACA,iEAAwC;AAEjC,MAAM,yBAAyB,GAAG,CACvC,KAAmB,EACnB,EAAE;IACF,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;IACrE,OAAO,IAAA,mBAAS,EAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAA;AACtC,CAAC,CAAA;AALY,QAAA,yBAAyB,6BAKrC"}

package/package.json

@@ -0,0 +1,109 @@
+{
+  "name": "functional-models-orm-json",
+  "version": "3.0.0",
+  "description": "An ORM for functional-models that uses json files.",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "scripts": {
+    "build": "rm -Rf ./dist && tsc && cp package.json ./dist && cp README.md ./dist",
+    "build:watch": "nodemon -e '*' --watch ./src --exec npm run build",
+    "commit": "cz",
+    "coverage": "nyc --all --reporter=lcov npm test",
+    "dist": "npm run build && cd dist && npm publish",
+    "eslint": "eslint .",
+    "prettier": "prettier --write .",
+    "prettier:check": "prettier -c .",
+    "test": "mocha -r ts-node/register test/**/*.test.ts",
+    "test:coverage": "nyc npm run test",
+    "test:features": "TS_NODE_PROJECT=tsconfig.cucumber.json ./node_modules/.bin/cucumber-js --require ./features/step_definitions/steps.ts --require-module ts-node/register"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/monolithst/functional-models-orm-json.git"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
+  },
+  "keywords": [
+    "orm",
+    "json",
+    "nodejs",
+    "functional"
+  ],
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/monolithst/functional-models-orm-json/issues"
+  },
+  "author": "Mike Cornwell",
+  "nyc": {
+    "branches": 100,
+    "lines": 100,
+    "functions": 100,
+    "statements": 100,
+    "extends": "@istanbuljs/nyc-config-typescript",
+    "check-coverage": true,
+    "all": true,
+    "include": [
+      "src/**/!(*.test.*).[tj]s?(x)"
+    ],
+    "exclude": [
+      "src/_tests_/**/*.*",
+      "node_modules",
+      ".nyc_output",
+      "coverage",
+      ".git",
+      ".github",
+      "features"
+    ],
+    "reporter": [
+      "html",
+      "lcov",
+      "text",
+      "text-summary"
+    ],
+    "report-dir": "coverage"
+  },
+  "dependencies": {
+    "functional-models": "^3.6.4",
+    "functional-models-orm-memory": "^3.0.5",
+    "lodash": "^4.17.21"
+  },
+  "devDependencies": {
+    "@cucumber/cucumber": "^11.2.0",
+    "@eslint/compat": "^1.2.0",
+    "@eslint/eslintrc": "^3.1.0",
+    "@eslint/js": "^9.12.0",
+    "@istanbuljs/nyc-config-typescript": "^1.0.2",
+    "@types/chai": "^4.3.16",
+    "@types/chai-as-promised": "^7.1.8",
+    "@types/lodash": "^4.17.1",
+    "@types/mocha": "^10.0.10",
+    "@types/sinon": "^17.0.3",
+    "@typescript-eslint/eslint-plugin": "^8.20.0",
+    "@typescript-eslint/parser": "^8.20.0",
+    "chai": "^4.3.0",
+    "chai-as-promised": "^7.1.2",
+    "cz-conventional-changelog": "^3.3.0",
+    "eslint": "^9.18.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-import-resolver-typescript": "^3.6.3",
+    "eslint-plugin-functional": "~7.1.0",
+    "eslint-plugin-import": "^2.31.0",
+    "mocha": "^10.4.0",
+    "nodemon": "^3.1.9",
+    "nyc": "^15.1.0",
+    "prettier-plugin-organize-imports": "^3.2.4",
+    "proxyquire": "^2.1.3",
+    "sinon": "^11.1.2",
+    "source-map-support": "^0.5.21",
+    "ts-node": "^10.9.2",
+    "tsx": "^4.19.2",
+    "typescript": "^5.7.2"
+  },
+  "homepage": "https://github.com/monolithst/functional-models-orm-json#readme"
+}