@drax/settings-back 0.11.5 → 0.12.2

package/dist/factory/SettingServiceFactory.js

@@ -12,7 +12,8 @@ const SettingServiceFactory = (verbose = false) => {
                 break;
             case COMMON.DB_ENGINES.SQLITE:
                 const dbFile = DraxConfig.getOrLoad(CommonConfig.SqliteDbFile);
-                settingRepository = new SettingSqliteRepository(dbFile, verbose);
+                settingRepository = new SettingSqliteRepository(dbFile, true);
+                settingRepository.build();
                 break;
             default:
                 throw new Error("DraxConfig.DB_ENGINE must be one of " + Object.values(COMMON.DB_ENGINES).join(", "));

package/dist/model/SettingsModel.js

@@ -1,11 +1,12 @@
 import { mongoose } from '@drax/common-back';
 import uniqueValidator from 'mongoose-unique-validator';
+import mongooseLeanVirtuals from 'mongoose-lean-virtuals';
 const SettingSchema = new mongoose.Schema({
     key: { type: String, required: true, unique: true },
     value: { type: mongoose.Schema.Types.Mixed, required: false, unique: false },
     //valueList: [{type: String, required: false, unique: false}],
     label: { type: String, required: false },
-    group: { type: String, required: true },
+    category: { type: String, required: true },
     type: { type: String, default: "string", enum: ['string', 'longString', 'number', 'enum', 'boolean', 'password', 'stringList', 'numberList', 'enumList', 'ref', 'secret'], required: false, unique: false },
     options: [{ type: String }],
     regex: { type: String },
@@ -14,13 +15,12 @@ const SettingSchema = new mongoose.Schema({
     entityText: { type: String, required: false, unique: false },
     prefix: { type: String, required: false },
     suffix: { type: String, required: false },
-});
+}, { timestamps: true, toJSON: { virtuals: true }, toObject: { virtuals: true } });
 SettingSchema.virtual("id").get(function () {
     return this._id.toString();
 });
-SettingSchema.set('toJSON', { getters: true, virtuals: true });
-SettingSchema.set('toObject', { getters: true, virtuals: true });
 SettingSchema.plugin(uniqueValidator, { message: 'validation.unique' });
+SettingSchema.plugin(mongooseLeanVirtuals);
 const MODEL_NAME = 'Setting';
 const COLLECTION_NAME = 'settings';
 const SettingModel = mongoose.model(MODEL_NAME, SettingSchema, COLLECTION_NAME);

package/dist/repository/sqlite/SettingSqliteRepository.js

@@ -1,93 +1,77 @@
-import sqlite from "better-sqlite3";
-import { randomUUID } from "node:crypto";
-import { SqliteErrorToValidationError, SqliteTableBuilder, SqlQueryFilter, SqlSort } from "@drax/common-back";
-const tableFields = [
-    { name: "key", type: "TEXT", unique: true, primary: false },
-    { name: "value", type: "TEXT", unique: false, primary: false },
-];
-class SettingSqliteRepository {
-    constructor(dataBaseFile, verbose = false) {
-        this._searchFields = [];
-        this.dataBaseFile = dataBaseFile;
-        this._searchFields = ['_id', 'key'];
-        this.db = new sqlite(dataBaseFile, { verbose: verbose ? console.log : null });
-        this.table();
+import { AbstractSqliteRepository } from "@drax/crud-back";
+class SettingSqliteRepository extends AbstractSqliteRepository {
+    constructor() {
+        super(...arguments);
+        this.tableName = 'settings';
+        this.searchFields = [];
+        this.booleanFields = [];
+        this.identifier = '_id';
+        this.populateFields = [];
+        this.tableFields = [
+            { name: "key", type: "TEXT", unique: true, primary: false },
+            { name: "value", type: "TEXT", unique: false, primary: false },
+            { name: "label", type: "TEXT", unique: false, primary: false },
+            { name: "category", type: "TEXT", unique: false, primary: false },
+            { name: "type", type: "TEXT", unique: false, primary: false },
+            { name: "options", type: "TEXT", unique: false, primary: false },
+            { name: "regex", type: "TEXT", unique: false, primary: false },
+            { name: "entity", type: "TEXT", unique: false, primary: false },
+            { name: "entityValue", type: "TEXT", unique: false, primary: false },
+            { name: "entityText", type: "TEXT", unique: false, primary: false },
+            { name: "prefix", type: "TEXT", unique: false, primary: false },
+            { name: "suffix", type: "TEXT", unique: false, primary: false },
+        ];
     }
-    table() {
-        const builder = new SqliteTableBuilder(this.dataBaseFile, 'settings', tableFields, false);
-        builder.build('id');
-    }
-    async create(data) {
-        try {
-            if (!data.id) {
-                data.id = randomUUID();
-            }
-            // data.createdAt = (new Date().toISOString())
-            const fields = Object.keys(data)
-                .map(field => `${field}`)
-                .join(', ');
-            const values = Object.keys(data)
-                .map(field => `@${field}`)
-                .join(', ');
-            const stmt = this.db.prepare(`INSERT INTO settings (${fields}) VALUES (${values})`);
-            stmt.run(data);
-            return this.findById(data.id);
-        }
-        catch (e) {
-            console.log(e);
-            throw SqliteErrorToValidationError(e, data);
+    async updatePartial(id, data) {
+        let item = await this.findById(id);
+        if (!item) {
+            throw new Error('Setting not found');
         }
+        data = { ...item, ...data };
+        return await this.update(id, data);
     }
-    async update(id, data) {
-        try {
-            // data.updatedAt = (new Date().toISOString())
-            const setClauses = Object.keys(data)
-                .map(field => `${field} = @${field}`)
-                .join(', ');
-            data.id = id;
-            const stmt = this.db.prepare(`UPDATE settings SET ${setClauses} WHERE id = @id `);
-            stmt.run(data);
-            return this.findById(id);
-        }
-        catch (e) {
-            console.log(e);
-            throw SqliteErrorToValidationError(e, data);
+    async prepareData(data) {
+        if (data && data.options) {
+            data.options = JSON.stringify(data.options);
+        }
+        if (data.type === 'boolean') {
+            data.value = data.value ? 1 : 0;
+        }
+        if (data.type === 'stringList') {
+            data.value = data.value ? data.value.join(',') : '';
+        }
+        if (data.type === 'numberList') {
+            data.value = data.value ? data.value.join(',') : '';
+        }
+        if (data.type === 'enumList') {
+            data.value = data.value ? data.value.join(',') : '';
+        }
+        if (data.type === 'ref') {
+        }
+        if (data.type === 'secret') {
         }
     }
-    async paginate({ page = 1, limit = 5, orderBy = '', order = false, search = '', filters = [] }) {
-        const offset = page > 1 ? (page - 1) * limit : 0;
-        let where = "";
-        if (search) {
-            where = ` WHERE name LIKE '%${search}%'`;
-        }
-        where = SqlQueryFilter.applyFilters(where, filters);
-        const sort = SqlSort.applySort(orderBy, order);
-        const rCount = this.db.prepare('SELECT COUNT(*) as count FROM settings' + where).get();
-        where += sort;
-        const settings = this.db.prepare('SELECT * FROM settings ' + where + ' LIMIT ? OFFSET ?').all([limit, offset]);
-        return {
-            page: page,
-            limit: limit,
-            total: rCount.count,
-            items: settings
-        };
-    }
-    async delete(id) {
-        const stmt = this.db.prepare('DELETE FROM settings WHERE id = ?');
-        stmt.run(id);
-        return true;
-    }
-    async deleteAll() {
-        const stmt = this.db.prepare('DELETE FROM settings');
-        stmt.run();
-        return true;
-    }
-    async findById(id) {
-        const setting = this.db.prepare('SELECT * FROM settings WHERE id = ?').get(id);
-        if (setting) {
-            return setting;
+    async prepareItem(item) {
+        console.log('prepareItem', item);
+        if (item && item.options) {
+            item.options = JSON.parse(item.options);
+        }
+        if (item.type === 'boolean') {
+            item.value = item.value === 1 || item.value === '1' || item.value === '1.0';
+        }
+        if (item.type === 'stringList') {
+            item.value = item.value ? item.value.split(',') : [];
+        }
+        if (item.type === 'numberList') {
+            item.value = item.value ? item.value.split(',') : [];
+        }
+        if (item.type === 'enumList') {
+            item.value = item.value ? item.value.split(',') : [];
+        }
+        if (item.type === 'ref') {
+        }
+        if (item.type === 'secret') {
         }
-        return undefined;
     }
     async findByKey(key) {
         const setting = this.db.prepare('SELECT * FROM settings WHERE key = ?').get(key);
@@ -96,18 +80,6 @@ class SettingSqliteRepository {
         }
         return undefined;
     }
-    async fetchAll() {
-        const settings = this.db.prepare('SELECT * FROM settings').all();
-        return settings;
-    }
-    async search(value, limit = 1000) {
-        let where = "";
-        if (value && this._searchFields.length > 0) {
-            where = ` WHERE ${this._searchFields.map(field => `${field} LIKE '%${value}%'`).join(" OR ")}`;
-        }
-        const items = this.db.prepare(`SELECT * FROM settings ${where}`).all();
-        return items;
-    }
 }
 export default SettingSqliteRepository;
 export { SettingSqliteRepository };

package/dist/routes/SettingRoutes.js

@@ -1,10 +1,26 @@
 import SettingController from "../controller/SettingController.js";
 async function SettingsRoutes(fastify, options) {
     const controller = new SettingController();
-    fastify.get('/api/settings', (req, rep) => controller.fetchAll(req, rep));
-    fastify.get('/api/settings/grouped', (req, rep) => controller.fetchGrouped(req, rep));
-    fastify.get('/api/settings/:key', (req, rep) => controller.findByKey(req, rep));
-    fastify.patch('/api/settings/:id', (req, rep) => controller.updateValue(req, rep));
+    fastify.get('/api/settings', {
+        schema: {
+            tags: ['Settings'],
+        }
+    }, (req, rep) => controller.fetchAll(req, rep));
+    fastify.get('/api/settings/grouped', {
+        schema: {
+            tags: ['Settings'],
+        }
+    }, (req, rep) => controller.fetchGrouped(req, rep));
+    fastify.get('/api/settings/:key', {
+        schema: {
+            tags: ['Settings'],
+        }
+    }, (req, rep) => controller.findByKey(req, rep));
+    fastify.patch('/api/settings/:id', {
+        schema: {
+            tags: ['Settings'],
+        }
+    }, (req, rep) => controller.updateValue(req, rep));
 }
 export default SettingsRoutes;
 export { SettingsRoutes };

package/dist/services/SettingService.js

@@ -27,10 +27,10 @@ class SettingService extends AbstractService {
     async fetchGrouped() {
         const settings = await this._repository.fetchAll();
         return settings.reduce((acc, setting) => {
-            if (!acc[setting.group]) {
-                acc[setting.group] = [];
+            if (!acc[setting.category]) {
+                acc[setting.category] = [];
             }
-            acc[setting.group].push(setting);
+            acc[setting.category].push(setting);
             return acc;
         }, {});
     }
@@ -76,7 +76,7 @@ class SettingService extends AbstractService {
             const setting = await this._repository.findOneBy("key", data.key);
             if (setting) {
                 delete data.value;
-                return await this._repository.updatePartial(setting.id, data);
+                return await this._repository.updatePartial(setting._id, data);
             }
             else {
                 return await this._repository.create(data);

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.11.5",
+  "version": "0.12.2",
   "description": "Setting module for nice management options.",
   "main": "dist/index.js",
   "types": "types/index.d.ts",
@@ -28,11 +28,11 @@
   "author": "Cristian Incarnato & Drax Team",
   "license": "ISC",
   "dependencies": {
-    "@drax/common-back": "^0.11.3",
-    "@drax/crud-back": "^0.11.5",
-    "@drax/crud-share": "^0.11.5",
-    "@drax/email-back": "^0.11.3",
-    "@drax/identity-share": "^0.11.5",
+    "@drax/common-back": "^0.12.1",
+    "@drax/crud-back": "^0.12.2",
+    "@drax/crud-share": "^0.12.1",
+    "@drax/email-back": "^0.12.1",
+    "@drax/identity-share": "^0.12.1",
     "bcryptjs": "^2.4.3",
     "express-jwt": "^8.4.1",
     "graphql": "^16.8.2",
@@ -41,9 +41,8 @@
   },
   "peerDependencies": {
     "better-sqlite3": "^11.0.0",
-    "fastify": "^4.27.0",
+    "fastify": "^5.2.1",
     "mongoose": "^8.6.3",
-    "mongoose-paginate-v2": "^1.8.3",
     "mongoose-unique-validator": "^5.0.1"
   },
   "devDependencies": {
@@ -62,5 +61,5 @@
       "debug": "0"
     }
   },
-  "gitHead": "e67f10f0af29468c9d30f16135cfdbdff166d916"
+  "gitHead": "521b1a2066aaab3d6d6c062f36428effd517ad32"
 }

package/src/factory/SettingServiceFactory.ts

@@ -17,7 +17,8 @@ const SettingServiceFactory = (verbose: boolean = false): SettingService => {
                 break;
             case COMMON.DB_ENGINES.SQLITE:
                 const dbFile = DraxConfig.getOrLoad(CommonConfig.SqliteDbFile)
-                settingRepository = new SettingSqliteRepository(dbFile, verbose)
+                settingRepository = new SettingSqliteRepository(dbFile, true)
+                settingRepository.build()
                 break;
             default:
                 throw new Error("DraxConfig.DB_ENGINE must be one of " + Object.values(COMMON.DB_ENGINES).join(", "));

package/src/interfaces/ISettingRepository.ts

@@ -1,6 +1,6 @@
 import {ISetting, ISettingBase} from "@drax/settings-share";
-import {IDraxCrud} from "@drax/crud-share";
-interface ISettingRepository extends IDraxCrud<ISetting,ISettingBase,ISettingBase>{
+import {IDraxCrudRepository} from "@drax/crud-share";
+interface ISettingRepository extends IDraxCrudRepository<ISetting,ISettingBase,ISettingBase>{
 }
 
 export {ISettingRepository}

package/src/model/SettingsModel.ts

@@ -1,5 +1,6 @@
 import {mongoose} from '@drax/common-back';
 import uniqueValidator from 'mongoose-unique-validator';
+import mongooseLeanVirtuals from 'mongoose-lean-virtuals'
 import {ISetting} from "@drax/settings-share";
 
 
@@ -9,7 +10,7 @@ const SettingSchema = new mongoose.Schema<ISetting>({
     value: {type: mongoose.Schema.Types.Mixed, required: false, unique: false},
     //valueList: [{type: String, required: false, unique: false}],
     label: {type: String, required: false},
-    group: {type: String, required: true},
+    category: {type: String, required: true},
     type: {type: String, default: "string", enum: ['string','longString','number','enum','boolean', 'password', 'stringList','numberList', 'enumList', 'ref', 'secret'], required: false, unique: false},
     options: [{type: String}],
     regex: {type: String},
@@ -18,18 +19,14 @@ const SettingSchema = new mongoose.Schema<ISetting>({
     entityText: {type: String, required: false, unique: false},
     prefix: {type: String, required: false},
     suffix: {type: String, required: false},
-})
+}, {timestamps: true, toJSON: {  virtuals: true}, toObject: {virtuals: true} })
 
 SettingSchema.virtual("id").get(function () {
     return this._id.toString();
 });
 
-
-SettingSchema.set('toJSON', {getters: true, virtuals: true});
-
-SettingSchema.set('toObject', {getters: true, virtuals: true});
-
 SettingSchema.plugin(uniqueValidator, {message: 'validation.unique'});
+SettingSchema.plugin(mongooseLeanVirtuals);
 
 
 

package/src/repository/sqlite/SettingSqliteRepository.ts

@@ -1,146 +1,94 @@
 import {ISettingRepository} from '../../interfaces/ISettingRepository'
-import {UUID} from "crypto";
-import sqlite from "better-sqlite3";
-import {randomUUID} from "node:crypto";
-import {IDraxPaginateResult, IDraxPaginateOptions} from "@drax/crud-share";
 import {ISetting, ISettingBase} from "@drax/settings-share";
 import {
-    SqliteErrorToValidationError,
-    SqliteTableBuilder,
     SqliteTableField,
-    SqlQueryFilter,
-    SqlSort
 } from "@drax/common-back";
+import {AbstractSqliteRepository} from "@drax/crud-back";
 
-const tableFields: SqliteTableField[] = [
-    {name: "key", type: "TEXT", unique: true, primary: false},
-    {name: "value", type: "TEXT", unique: false, primary: false},
-]
 
-
-class SettingSqliteRepository implements ISettingRepository{
+class SettingSqliteRepository extends AbstractSqliteRepository<ISetting,ISettingBase, ISettingBase> implements ISettingRepository{
 
     protected db: any;
+    protected tableName: string = 'settings';
     protected dataBaseFile: string;
-    protected _searchFields: string[] = []
-
-    constructor(dataBaseFile:string, verbose:boolean = false) {
-        this.dataBaseFile = dataBaseFile;
-        this._searchFields = ['_id', 'key'];
-        this.db = new sqlite(dataBaseFile, {verbose: verbose ? console.log : null});
-        this.table()
-    }
-
-    table() {
-        const builder = new SqliteTableBuilder(
-            this.dataBaseFile,
-            'settings',
-            tableFields,
-            false);
-        builder.build('id')
-    }
-
-
-
-    async create(data: ISettingBase): Promise<ISetting> {
-        try{
-
-            if(!data.id){
-                data.id = randomUUID()
-            }
-
-            // data.createdAt = (new Date().toISOString())
-
-            const fields = Object.keys(data)
-                .map(field => `${field}`)
-                .join(', ');
-
-            const values = Object.keys(data)
-                .map(field => `@${field}`)
-                .join(', ');
-
-
-        const stmt = this.db.prepare(`INSERT INTO settings (${fields}) VALUES (${values})`);
-        stmt.run(data)
-        return this.findById(data.id as UUID)
-        }catch (e){
-            console.log(e)
-            throw SqliteErrorToValidationError(e, data)
+    protected searchFields: string[] = [];
+    protected booleanFields: string[] = [];
+    protected identifier: string = '_id';
+    protected populateFields = []
+    protected tableFields: SqliteTableField[] = [
+        {name: "key", type: "TEXT", unique: true, primary: false},
+        {name: "value", type: "TEXT", unique: false, primary: false},
+        {name: "label", type: "TEXT", unique: false, primary: false},
+        {name: "category", type: "TEXT", unique: false, primary: false},
+        {name: "type", type: "TEXT", unique: false, primary: false},
+        {name: "options", type: "TEXT", unique: false, primary: false},
+        {name: "regex", type: "TEXT", unique: false, primary: false},
+        {name: "entity", type: "TEXT", unique: false, primary: false},
+        {name: "entityValue", type: "TEXT", unique: false, primary: false},
+        {name: "entityText", type: "TEXT", unique: false, primary: false},
+        {name: "prefix", type: "TEXT", unique: false, primary: false},
+        {name: "suffix", type: "TEXT", unique: false, primary: false},
+    ]
+    protected verbose: boolean;
+
+
+    async updatePartial(id: string, data: any) {
+        let item = await this.findById(id)
+        if(!item){
+            throw new Error('Setting not found')
         }
+        data = {...item,...data}
+        return await this.update(id, data)
     }
 
-
-
-    async update(id: string, data: ISettingBase): Promise<ISetting> {
-        try{
-            // data.updatedAt = (new Date().toISOString())
-
-            const setClauses = Object.keys(data)
-                .map(field => `${field} = @${field}`)
-                .join(', ');
-
-            data.id = id
-
-            const stmt = this.db.prepare( `UPDATE settings SET ${setClauses} WHERE id = @id `);
-
-            stmt.run(data);
-
-            return this.findById(id)
-        }catch (e){
-            console.log(e)
-            throw SqliteErrorToValidationError(e, data)
+    async prepareData(data: any){
+        if(data && data.options){
+            data.options = JSON.stringify(data.options)
         }
-
-    }
-
-    async paginate({
-                       page= 1,
-                       limit= 5,
-                       orderBy= '',
-                       order= false,
-                       search= '',
-                       filters= []} : IDraxPaginateOptions): Promise<IDraxPaginateResult<ISetting>>{
-        const offset = page > 1 ? (page - 1) * limit : 0
-
-        let where=""
-        if (search) {
-            where = ` WHERE name LIKE '%${search}%'`
+        if(data.type === 'boolean'){
+            data.value = data.value ? 1 : 0
         }
+        if(data.type === 'stringList'){
+            data.value = data.value ? data.value.join(',') : ''
+        }
+        if(data.type === 'numberList'){
+            data.value = data.value ? data.value.join(',') : ''
+        }
+        if(data.type === 'enumList'){
+            data.value = data.value ? data.value.join(',') : ''
+        }
+        if(data.type === 'ref'){
 
-        where = SqlQueryFilter.applyFilters(where, filters)
-        const sort = SqlSort.applySort(orderBy, order)
-
-        const rCount = this.db.prepare('SELECT COUNT(*) as count FROM settings'+where).get();
-        where += sort
-        const settings = this.db.prepare('SELECT * FROM settings '  + where + ' LIMIT ? OFFSET ?').all([limit, offset]);
-
+        }
+        if(data.type === 'secret'){
 
-        return {
-            page: page,
-            limit: limit,
-            total: rCount.count,
-            items: settings
         }
     }
 
-    async delete(id: string): Promise<boolean> {
-        const stmt = this.db.prepare('DELETE FROM settings WHERE id = ?');
-        stmt.run(id);
-        return true
-    }
+    async prepareItem(item: any){
+        console.log('prepareItem', item)
+        if(item && item.options){
+           item.options = JSON.parse(item.options)
+        }
+        if(item.type === 'boolean'){
+            item.value = item.value === 1 || item.value === '1' || item.value === '1.0'
+        }
+        if(item.type === 'stringList'){
+            item.value = item.value ? item.value.split(',') : []
+        }
+        if(item.type === 'numberList'){
+            item.value = item.value ? item.value.split(',') : []
+        }
+        if(item.type === 'enumList'){
+            item.value = item.value ? item.value.split(',') : []
+        }
+        if(item.type === 'ref'){
 
-    async deleteAll(): Promise<boolean> {
-        const stmt = this.db.prepare('DELETE FROM settings');
-        stmt.run();
-        return true
-    }
+        }
+        if(item.type === 'secret'){
 
-    async findById(id: string): Promise<ISetting | null>{
-        const setting = this.db.prepare('SELECT * FROM settings WHERE id = ?').get(id);
-        if(setting){
-            return setting
         }
-        return undefined
+
     }
 
     async findByKey(key: string): Promise<ISetting | null>{
@@ -151,24 +99,6 @@ class SettingSqliteRepository implements ISettingRepository{
         return undefined
     }
 
-    async fetchAll(): Promise<ISetting[]>{
-        const settings = this.db.prepare('SELECT * FROM settings').all();
-        return settings
-    }
-
-
-    async search(value: any, limit: number = 1000): Promise<any[]>{
-        let where=""
-        if (value && this._searchFields.length > 0) {
-            where = ` WHERE ${this._searchFields.map(field => `${field} LIKE '%${value}%'`).join(" OR ")}`
-        }
-        const items = this.db.prepare(`SELECT * FROM settings ${where}`).all();
-        return items
-    }
-
-
-
-
 
 }
 

package/src/routes/SettingRoutes.ts

@@ -4,13 +4,29 @@ import SettingController from "../controller/SettingController.js";
 async function SettingsRoutes(fastify, options) {
     const controller: SettingController = new SettingController()
 
-    fastify.get('/api/settings', (req,rep) => controller.fetchAll(req,rep))
+    fastify.get('/api/settings', {
+        schema: {
+            tags: ['Settings'],
+        }
+    }, (req,rep) => controller.fetchAll(req,rep))
 
-    fastify.get('/api/settings/grouped', (req,rep) => controller.fetchGrouped(req,rep))
+    fastify.get('/api/settings/grouped', {
+        schema: {
+            tags: ['Settings'],
+        }
+    }, (req,rep) => controller.fetchGrouped(req,rep))
 
-    fastify.get('/api/settings/:key', (req,rep) => controller.findByKey(req,rep))
+    fastify.get('/api/settings/:key', {
+        schema: {
+            tags: ['Settings'],
+        }
+    }, (req,rep) => controller.findByKey(req,rep))
 
-    fastify.patch('/api/settings/:id', (req,rep) => controller.updateValue(req,rep))
+    fastify.patch('/api/settings/:id', {
+        schema: {
+            tags: ['Settings'],
+        }
+    }, (req,rep) => controller.updateValue(req,rep))
 }
 
 export default SettingsRoutes