beanbagdb 0.5.76 → 0.5.80

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "beanbagdb",
-  "version": "0.5.76",
+  "version": "0.5.80",
   "description": "A JS library to introduce a schema layer to a No-SQL local database",
   "main": "src/index.js",
   "module": "src/index.js",

package/src/index.js

@@ -269,7 +269,7 @@ export class BeanBagDB {
     let app_doc = { ... app_data.meta, version: latest_version}
     try {
       // modify the app setting doc 
-      await this.modify_setting(app_data.meta.name,{value: app_doc,},"update")   
+      await this.modify_setting(app_data.meta.name,app_doc,"update")   
       
       // add a new log 
       let new_log_doc =  this._get_blank_doc("system_log")
@@ -451,6 +451,11 @@ export class BeanBagDB {
     //   }
     // }
 
+    // system generated schemas cannot be edited 
+    if(full_doc.schema=="schema"&&full_doc.data.system_generated==true){
+      throw new DocUpdateError("System schemas cannot be updated using this API");
+    }
+
     // update new value depending on settings.non_editable_fields (if does not exists, all fields are editable)
     let all_fields = Object.keys(schema.schema.properties);
     let unedit_fields = schema.settings["non_editable_fields"];
@@ -462,7 +467,7 @@ export class BeanBagDB {
       //  todo : what if additionalField are allowed ??
       let updated_data = { ...full_doc.data, ...allowed_updates };
 
-      this.util_validate_data(schema.schema, updated_data);
+      updated_data = this.util_validate_data(schema.schema, updated_data);
   
       // primary key check if multiple records can  be created
       if (schema.settings["primary_keys"].length > 0) {
@@ -489,7 +494,7 @@ export class BeanBagDB {
       let m_sch = sys_sch.editable_metadata_schema;
       let editable_fields = Object.keys(m_sch["properties"]);
       let allowed_meta = this.util_filter_object(updates.meta, editable_fields);
-      this.util_validate_data(m_sch, allowed_meta);
+      allowed_meta = this.util_validate_data(m_sch, allowed_meta);
       // if update has a link ,then check if it already exists 
       if (allowed_meta.link){
         let search = await this.search({ selector: {"meta.link":allowed_meta.link} })
@@ -652,6 +657,7 @@ export class BeanBagDB {
               system_defined : doc.data.system_generated,
               description: doc.data.description,
               link: doc.meta.link,
+              title:doc.data.title,
               _id:doc._id
             })
           })
@@ -951,9 +957,9 @@ async _upgrade_schema_in_bulk(schemas,log_upgrade=false,log_message="Schema Upgr
    * @returns {Object}
    */
   _get_blank_schema_doc(schema_name, schema_object, data) {
-    this.util_validate_data(schema_object, data);
+    let new_data = this.util_validate_data(schema_object, data);
     let obj = this._get_blank_doc(schema_name);
-    obj["data"] = data;
+    obj["data"] = new_data;
     return obj;
   }
 
@@ -1024,11 +1030,13 @@ async _upgrade_schema_in_bulk(schemas,log_upgrade=false,log_message="Schema Upgr
     if (sch_search.docs.length == 0) {throw new DocCreationError(`The schema "${schema}" does not exists`)}
     let schemaDoc = sch_search.docs[0]["data"];
     // validate data
-    this.util_validate_data(schemaDoc.schema, data);
+    if(!schemaDoc.active){throw new DocCreationError(`The schema "${schema}" is not active`)}
+
+    let new_data = this.util_validate_data(schemaDoc.schema, data);
 
     // validate meta
-    if(Object.keys.length>0){
-      this.util_validate_data(sys_sch.editable_metadata_schema, meta)
+    if(Object.keys(meta).length>0){
+      meta = this.util_validate_data(sys_sch.editable_metadata_schema, meta)
     }
     
 
@@ -1042,25 +1050,25 @@ async _upgrade_schema_in_bulk(schemas,log_upgrade=false,log_message="Schema Upgr
     // @TODO : for schema dos: settings fields must be in schema field
     if (schema == "schema") {
       //more checks are required
-      this.util_validate_schema_object(data);
+      this.util_validate_schema_object(new_data);
     }
     // @TODO : check if single record setting is set to true
     //console.log(schemaDoc)
     // duplicate check
     if (schemaDoc.settings["primary_keys"].length > 0) {
       let primary_obj = { schema: schema };
-      schemaDoc.settings["primary_keys"].map((ky) => {primary_obj["data." + ky] = data[ky];});
+      schemaDoc.settings["primary_keys"].map((ky) => {primary_obj["data." + ky] = new_data[ky];});
       let prim_search = await this.search({ selector: primary_obj });
       if (prim_search.docs.length > 0) {
         throw new DocCreationError(`Document with the given primary key (${schemaDoc.settings["primary_keys"].join(",")}) already exists in the schema "${schema}"`);
       }
     }
     // encrypt if required
-    let new_data = { ...data };
+
     if (schemaDoc.settings["encrypted_fields"].length > 0) {
       // todo test if encryption is successful 
       for (let itm of schemaDoc.settings["encrypted_fields"]) {
-        new_data[itm] = await this.utils.encrypt(data[itm], this.encryption_key);
+        new_data[itm] = await this.utils.encrypt(new_data[itm], this.encryption_key);
       }
     }
 
@@ -1124,16 +1132,18 @@ async _upgrade_schema_in_bulk(schemas,log_upgrade=false,log_message="Schema Upgr
 
 
   /**
-   * Validates a data object against a provided JSON schema
+   * Validates a data object against a provided JSON schema and returns a valid data object (with default value for missing field for which default values are defined in the schema )
    * It relies on the external API provided by the user
    * @param {Object} schema_obj - The JSON schema object to validate against
    * @param {Object} data_obj - The data object to validate
    * @throws {Error} If the data object does not conform to the schema
    */
   util_validate_data(schema_obj, data_obj) {
-    const { valid, validate } = this.utils.validate_schema(schema_obj,data_obj)
+    const { valid, validate , data} = this.utils.validate_schema(schema_obj,data_obj)
     if (!valid) {
       throw new ValidationError(validate.errors);
+    }else{
+      return data
     }
   }
 
@@ -1248,10 +1258,21 @@ async _upgrade_schema_in_bulk(schemas,log_upgrade=false,log_message="Schema Upgr
  *                  "banana-earth-rain".
  *
  */
-    util_generate_random_link() {
-      // prettier-ignore
-      const dictionary = ['rain', 'mars', 'banana', 'earth', 'kiwi', 'mercury', 'fuji', 'hurricane', 'matterhorn', 'snow', 'saturn', 'jupiter', 'peach', 'wind', 'pluto', 'apple', 'k2', 'storm', 'venus', 'denali', 'cloud', 'sunshine', 'mango', 'drizzle', 'pineapple', 'aconcagua', 'gasherbrum', 'apricot', 'neptune', 'fog', 'orange', 'blueberry', 'kilimanjaro', 'uranus', 'grape', 'storm', 'montblanc', 'lemon', 'chooyu', 'raspberry', 'cherry', 'thunder', 'vinson', 'breeze', 'elbrus', 'everest', 'parbat', 'makalu', 'nanga', 'kangchenjunga', 'lightning', 'cyclone', 'comet', 'asteroid', 'pomegranate', 'nectarine', 'clementine', 'strawberry', 'tornado', 'avalanche', 'andes', 'rockies', 'himalayas', 'pyrenees', 'carpathians', 'cascade', 'etna', 'vesuvius', 'volcano', 'tundra', 'whirlwind', 'iceberg', 'eclipse', 'zephyr', 'tropic', 'monsoon', 'aurora'];
-      return Array.from({ length: 3 },() => dictionary[Math.floor(Math.random() * dictionary.length)]).join("-");
+    util_generate_random_link(type=1) {
+      const options = {
+        0:()=>{
+          // prettier-ignore
+          const dictionary = ['rain', 'mars', 'banana', 'earth', 'kiwi', 'mercury', 'fuji', 'hurricane', 'matterhorn', 'snow', 'saturn', 'jupiter', 'peach', 'wind', 'pluto', 'apple', 'k2', 'storm', 'venus', 'denali', 'cloud', 'sunshine', 'mango', 'drizzle', 'pineapple', 'aconcagua', 'gasherbrum', 'apricot', 'neptune', 'fog', 'orange', 'blueberry', 'kilimanjaro', 'uranus', 'grape', 'storm', 'montblanc', 'lemon', 'chooyu', 'raspberry', 'cherry', 'thunder', 'vinson', 'breeze', 'elbrus', 'everest', 'parbat', 'makalu', 'nanga', 'kangchenjunga', 'lightning', 'cyclone', 'comet', 'asteroid', 'pomegranate', 'nectarine', 'clementine', 'strawberry', 'tornado', 'avalanche', 'andes', 'rockies', 'himalayas', 'pyrenees', 'carpathians', 'cascade', 'etna', 'vesuvius', 'volcano', 'tundra', 'whirlwind', 'iceberg', 'eclipse', 'zephyr', 'tropic', 'monsoon', 'aurora'];
+          return Array.from({ length: 3 },() => dictionary[Math.floor(Math.random() * dictionary.length)]).join("-");
+        },
+        1:()=>{
+          const length = Math.floor(Math.random() * 3) + 6; // Random length: 6, 7, or 8
+          const hexNumber = Math.floor(Math.random() * Math.pow(16, length)).toString(16);
+          return hexNumber.padStart(length, '0'); // Ensure it has the desired length
+          
+        }
+      }
+      return options[type]()
     }
 }
 

package/src/system_schema.js

@@ -6,9 +6,11 @@ export const default_app = {
   schemas:[
     {
       name: "schema",
+      active:true,
       description:"Meta-schema or the schema for defining other schemas",
       system_generated:true,
-      version:0.85,
+      version:0.87,
+      title:"Schema document",
       schema: {
         type: "object",
         additionalProperties: false,
@@ -18,6 +20,11 @@ export const default_app = {
             type:"boolean",
             default:false
           },
+          active:{
+            title:"This indicates where new documents can be created using this schema or not. Old documents can still be edited",
+            type:"boolean",
+            default:false
+          },
           version: {
             type: "number",
             title:"Version",
@@ -33,6 +40,13 @@ export const default_app = {
             pattern: "^[a-zA-Z][a-zA-Z0-9_]*$",
             description:"This is the name of the schema.It cannot be changed later"
           },
+          title:{
+            type:"string",
+            title:"Title",
+            minLength:0,
+            maxLength:1000,
+            description:"A title to display with records."
+          },
           description:{
             type:"string",
             title:"About",
@@ -47,6 +61,7 @@ export const default_app = {
             minProperties: 1,
             maxProperties: 50,
             description:"This must be a valid JSON Schema which will be used to validate documents created with this schema.See this https://tour.json-schema.org/",
+            default:{}
           },
           settings: {
             type: "object",
@@ -98,20 +113,22 @@ export const default_app = {
             required :["primary_keys","non_editable_fields","encrypted_fields"]
           },
         },
-        required: ["name","description","schema", "settings"],
+        required: ["name","description","schema", "settings","title"],
       },
       settings: {
         primary_keys: ["name"],
-        non_editable_fields:[],
+        non_editable_fields:["system_generated"],
         encrypted_fields:[],
-        display_fields:["name","version","description"]
+        display_fields:["name","version","description","title","active"]
       },
     },
     {
       system_generated:true,
-      version:0.61,
+      version:0.63,
       description:"To store user defined key. this can include anything like API tokens etc. There is a special method to fetch this. The values are encrypted",
       name: "system_key",
+      title:"System key",
+      active:true,
       schema: {
         type: "object",
         additionalProperties: true,
@@ -144,10 +161,12 @@ export const default_app = {
       },
     },
     {
-      version:0.65,
+      version:0.67,
       system_generated:true,
       description:"The system relies on these settings for proper functioning or enabling optional features.",
       name: "system_setting",
+      title:"System Setting",
+      active:true,
       schema: {
         required:["name","value"],
         type: "object",
@@ -172,8 +191,10 @@ export const default_app = {
     },
     {
       name:"system_edge_constraint",
+      title:"Edge constraint",
       system_generated:true,
-      version:0.50,
+      active:true,
+      version:0.52,
       description: "To define edge constraints for simple directed graph of records.",
       schema:{
         type: "object",
@@ -224,8 +245,10 @@ export const default_app = {
     },
     {
       name:"system_edge",
+      title:"Edge in the system graph",
+      active:true,
       system_generated:true,
-      version:0.50,
+      version:0.52,
       description: "To define edges in the simple directed graph of records.",
       schema:{
         type: "object",
@@ -251,8 +274,10 @@ export const default_app = {
     },
     {
       name:"system_media",
+      title:"Media content",
+      active:true,
       system_generated:true,
-      version:0.60,
+      version:0.62,
       description: "To store images as Base64",
       schema:{
         type: "object",
@@ -282,7 +307,9 @@ export const default_app = {
     {
       name:"system_log",
       system_generated:true,
-      version:0.50,
+      title:"System log",
+      active:true,
+      version:0.52,
       description: "To define edges in the simple directed graph of records.",
       schema:{
         type: "object",

package/test/edges.test.js

@@ -180,6 +180,7 @@ describe("Edge insertion test", async () => {
         {
           name: "player",
           description:"Player",
+          title:"Player",
           schema: {
             additionalProperties:true,
             type:"object",
@@ -198,6 +199,7 @@ describe("Edge insertion test", async () => {
         {
           name: "team",
           description:"Team",
+          title:"Team",
           schema: {
             additionalProperties:true,
             type:"object",
@@ -216,6 +218,7 @@ describe("Edge insertion test", async () => {
         {
           name: "match",
           description:"Match",
+          title:"Match",
           schema: {
             type:"object",
             additionalProperties:true,

package/test/operations.test.js

@@ -35,6 +35,7 @@ describe("Schema doc insertion gives errors when", async () => {
       {
         name: "",
         description: "",
+        title:"",
         schema: {},
         settings: {},
       },
@@ -45,6 +46,7 @@ describe("Schema doc insertion gives errors when", async () => {
         name: "nos",
         description: "",
         schema: {},
+        title:"",
         settings: {},
       },
     ],
@@ -54,6 +56,7 @@ describe("Schema doc insertion gives errors when", async () => {
         name: "contact",
         description: "",
         schema: {},
+        title:"",
         settings: {},
       },
     ],
@@ -62,6 +65,7 @@ describe("Schema doc insertion gives errors when", async () => {
       {
         name: "contact",
         description: "This can be left blank",
+        title:"something",
         settings: {},
       },
     ],
@@ -370,6 +374,28 @@ describe("Schema doc insertion gives errors when", async () => {
         },
       },
     ],
+    [
+      "title missing",
+      {
+        name: "contact",
+        description: "This can be left blank",
+        schema: {
+          type: "object",
+          properties: {
+            name: { type: "string" },
+            address: { type: "object" },
+            secret: { type: "string" },
+          },
+          additionalProperties: true,
+        },
+        settings: {
+          primary_keys: ["name"],
+          non_editable_fields: ["mobile"],
+          single_record: false,
+          encrypted_fields: ["name"],
+        },
+      },
+    ],
   ];
 
   before(async () => {
@@ -537,7 +563,9 @@ describe("Doc insertion tests", async () => {
 
   const test_schema = {
     name:"book",
+    active:true,
     description:"Test schema 1",
+    title:"Book",
     schema: {
       $schema: "http://json-schema.org/draft-07/schema#",
       type: "object",
@@ -733,6 +761,8 @@ describe("Doc insertion tests", async () => {
 describe("Doc insertion tests with encryption", async () => {
   const test_schema = {
     name:"book",
+    title:"Book",
+    active:true,
     description:"Test schema 1",
     schema: {
       $schema: "http://json-schema.org/draft-07/schema#",
@@ -930,6 +960,8 @@ describe("Doc read tests", async () => {
   const test_schema = {
     name:"book",
     description:"Test schema 1",
+    title:"Book",
+    active:true,
     schema: {
       $schema: "http://json-schema.org/draft-07/schema#",
       type: "object",
@@ -1119,6 +1151,8 @@ describe("Doc update tests", async () => {
   const test_schema = {
     name:"book",
     description:"Test schema 1",
+    title:"Book",
+    active:true,
     schema: {
       $schema: "http://json-schema.org/draft-07/schema#",
       type: "object",
@@ -1361,7 +1395,9 @@ describe("Doc delete tests", async () => {
 
   const test_schema = {
     name:"book",
+    active:true,
     description:"Test schema 1",
+    title:"Book",
     schema: {
       $schema: "http://json-schema.org/draft-07/schema#",
       type: "object",
@@ -1528,6 +1564,8 @@ describe("Doc search tests", async () => {
 
   const test_schema = {
     name:"book",
+    title:"Book",
+    active:true,
     description:"Test schema 1",
     schema: {
       $schema: "http://json-schema.org/draft-07/schema#",

package/test/pouchdb.js

@@ -69,10 +69,12 @@ const pdb = new PouchDB(dbname);
         // @TODO ping the database to check connectivity when class is ready to use
       },
       validate_schema: (schema_obj, data_obj)=>{
-        const ajv = new Ajv({code: {esm: true}})  // options can be passed, e.g. {allErrors: true}
+        const ajv = new Ajv({code: {esm: true},strict:false,useDefaults:true})  // options can be passed, e.g. {allErrors: true}
+        const data_copy = {...data_obj}
         const validate = ajv.compile(schema_obj);
-        const valid = validate(data_obj);
-        return {valid,validate}
+        const valid = validate(data_copy);
+
+        return {valid,validate,data:data_copy}
       }
     },
   }

package/test/test1.js

@@ -5,157 +5,116 @@ import {BeanBagDB}  from '../src/index.js';
 import {text_command} from "../src/plugins/text_command.js"
 
 (async()=>{
-
-  // let schema_docs_invalid = [
-  //   {
-  //     name: "",
-  //     description: "",
-  //     schema: {},
-  //     settings: {},
-  //   }
-  //   ]
-//   let doc_obj = get_pdb_doc("test_database_27","qwertyuiopaqwsde1254")
-//   let database1 = new BeanBagDB(doc_obj);
-//   // await database.ready()
-//   // let a = await database.create("schema",schema_docs_invalid[0])
-
-//   const test_schema = {
-//     name:"book",
-//     description:"Test schema 1",
-//     schema: {
-//       $schema: "http://json-schema.org/draft-07/schema#",
-//       type: "object",
-//       properties: {
-//         title: {
-//           type: "string",
-//           minLength: 1,
-//           description: "The title of the book",
-//         },
-//         author: {
-//           type: "string",
-//           minLength: 1,
-//           description: "The author of the book",
-//         },
-//         isbn: {
-//           type: "string",
-//           pattern: "^(97(8|9))?\\d{9}(\\d|X)$",
-//           description: "The ISBN of the book, can be 10 or 13 digits",
-//         },
-//         publicationYear: {
-//           type: "integer",
-//           minimum: 1450,
-//           maximum: 2024,
-//           description:
-//             "The year the book was published (between 1450 and 2024)",
-//         },
-//         genre: {
-//           type: "string",
-//           enum: [
-//             "Fiction",
-//             "Non-Fiction",
-//             "Science",
-//             "History",
-//             "Fantasy",
-//             "Biography",
-//             "Children",
-//             "Mystery",
-//             "Horror",
-//           ],
-//           description: "The genre of the book",
-//         },
-//         language: {
-//           type: "string",
-//           description: "The language of the book",
-//           default: "English",
-//         },
-//         publisher: {
-//           type: "string",
-//           description: "The publisher of the book",
-//           minLength: 1,
-//         },
-//         pages: {
-//           type: "integer",
-//           minimum: 1,
-//           description: "The number of pages in the book",
-//         },
-//         secret: {
-//           type: "string",
-//           description: "Super secret related to the book",
-//           minLength: 1,
-//         },
-//       },
-//       required: ["title", "author", "isbn", "publicationYear", "genre"],
-//       additionalProperties: false,
-//     },
-//     settings : {
-//       primary_keys:['title','author'],
-//       encrypted_fields:['secret'],
-//       non_editable_fields:[],
-//       single_record:false
-//     }
-//   };
-
-
-//   await database1.ready(); // Ensure the database is ready before running tests
- 
-//   try {
-//     //console.log(test_schema)
-//     let a = await database1.create("schema",test_schema)
-
-//   } catch (error) {
-//     console.log("error in before")
-//     console.log(error)
-//   }
-
-//   const book1 = {
-//     title: "Harry Potter",
-//     author: "J.K. Rowling",
-//     isbn: "9780439139601",
-//     publicationYear: 1999,
-//     genre: "Fantasy",
-//     publisher: "ABC DEF",
-//     secret: "Super secret 1"
-// };
-
-// let d 
-//   try {
-//     d = await database1.create("book", book1,{link:"sample1"});   
-//     console.log(d)
-//     let rec = await database1.read({"_id":d._id});   
-//     console.log(rec)
-
-//     let e = await database1.create("book", {...book1,title:"Something"},{link:"sample2"});   
-//     console.log(e)
-
-//   } catch (error) {
-//     console.log(error)
-//     throw error
-//   }
-
-
-//   try {
-//     let s = await database1.search({selector:{}})
-//     console.log(s.docs.length)
-//     //console.log( JSON.stringify(s,null,2))
-//   } catch (error) {
-//     console.log(error)
-//   }
-
-
 let database; // this is the global db object
 let doc_obj = get_pdb_doc("test_database_40", "qwertyuiopaqwsde1254");
 database = new BeanBagDB(doc_obj);
 await database.ready(); // Ensure the database is ready before running tests
-await database.load_plugin("txtcmd",text_command)
-console.log()
-let command = await database.plugins["txtcmd"].parse_and_run("new/schema")
-console.log(command)
-let command2 = await database.plugins["txtcmd"].parse_and_run("new")
-console.log(command2)
-let command3 = await database.plugins["txtcmd"].parse_and_run("open/link/thunder-kangchenjunga-mango")
-console.log(command3)
-let command4 = await database.plugins["txtcmd"].parse_and_run("tool/info")
-console.log(command4)
+// await database.load_plugin("txtcmd",text_command)
+// console.log()
+// let command = await database.plugins["txtcmd"].parse_and_run("new/schema")
+// console.log(command)
+// let command2 = await database.plugins["txtcmd"].parse_and_run("new")
+// console.log(command2)
+// let command3 = await database.plugins["txtcmd"].parse_and_run("open/link/thunder-kangchenjunga-mango")
+// console.log(command3)
+// let command4 = await database.plugins["txtcmd"].parse_and_run("tool/info")
+// console.log(command4)
+const test_schema = {
+  name:"book",
+  title:"Book",
+  description:"Test schema 1",
+  schema: {
+    $schema: "http://json-schema.org/draft-07/schema#",
+    type: "object",
+    properties: {
+      title: {
+        type: "string",
+        minLength: 1,
+        description: "The title of the book",
+      },
+      author: {
+        type: "string",
+        minLength: 1,
+        description: "The author of the book",
+      },
+      isbn: {
+        type: "string",
+        pattern: "^(97(8|9))?\\d{9}(\\d|X)$",
+        description: "The ISBN of the book, can be 10 or 13 digits",
+      },
+      publicationYear: {
+        type: "integer",
+        minimum: 1450,
+        maximum: 2024,
+        description:
+          "The year the book was published (between 1450 and 2024)",
+      },
+      genre: {
+        type: "string",
+        enum: [
+          "Fiction",
+          "Non-Fiction",
+          "Science",
+          "History",
+          "Fantasy",
+          "Biography",
+          "Children",
+          "Mystery",
+          "Horror",
+        ],
+        description: "The genre of the book",
+      },
+      language: {
+        type: "string",
+        description: "The language of the book",
+        default: "English",
+      },
+      publisher: {
+        type: "string",
+        description: "The publisher of the book",
+        minLength: 1,
+      },
+      pages: {
+        type: "integer",
+        minimum: 1,
+        description: "The number of pages in the book",
+      },
+      secret: {
+        type: "string",
+        description: "Super secret related to the book",
+        minLength: 1,
+      },
+    },
+    required: ["title", "author", "isbn", "publicationYear", "genre"],
+    additionalProperties: false,
+  },
+  settings : {
+    primary_keys:['title','author'],
+    encrypted_fields:['secret'],
+    non_editable_fields:[],
+    single_record:false
+  }
+};
+
+try {
+      //console.log(test_schema)
+      let a = await database.create("schema",test_schema)
+      console.log(a)
+    } catch (error) {
+      console.log("error in before")
+      console.log(error)
+    }
+  
+
+    // try {
+    //   //console.log(test_schema)
+    //   let a = await database.update({link:"7f82b8"},{meta:{tags:["sample"]}})
+    //   console.log(a)
+    // } catch (error) {
+    //   console.log("error in before")
+    //   console.log(error)
+    // }
+
 })()