goby-database 1.0.9 → 2.0.10

package/src/sandbox.ts

@@ -0,0 +1,107 @@
+import { readable_junctionlist } from './utils.js';
+
+console.log('--------------------------------------------------------')
+console.log('SANDBOX: running test...\n')
+
+
+import Project from './index.js';
+const project=new Project(':memory:');
+
+console.log('--------------------------------------------------------')
+console.log('SANDBOX: setting up book-author-script schema\n')
+project.action_edit_class_schema({
+    class_edits:[
+        {type:'create',class_name:'author'},
+        {type:'create',class_name:'book'},
+        {type:'create',class_name:'script'}
+    ],
+    property_edits:[
+        {type:'create',class_name:'author',prop_name:'age',config:{type:'data',data_type:'number',max_values:1}},
+        {type:'create',class_name:'author',prop_name:'works',config:{type:'relation',max_values:null}},
+        {type:'create',class_name:'author',prop_name:'books read',config:{type:'relation',max_values:null}},
+        {type:'create',class_name:'book',prop_name:'author',config:{type:'relation',max_values:1}}
+    ],
+    relationship_edits:[
+        { type:'create', sides:[{class_name:'author',prop_name:'works'}, {class_name:'book',prop_name:'author'}] },
+        { type:'create', sides:[{class_name:'author',prop_name:'works'}, {class_name:'script'}] },
+        { type:'create',sides:[{class_name:'author',prop_name:'books read'},{class_name:'book'}]}
+    ]
+})
+console.log(project.junction_cache.map(a=>a.sides));
+
+console.log('--------------------------------------------------------')
+console.log('SANDBOX: adding items to classes\n')
+project.action_add_row(1);
+project.action_add_row(2);
+project.action_add_row(2);
+project.action_add_row(3);
+
+console.log('--------------------------------------------------------')
+console.log('SANDBOX: making connections between items in classes\n')
+project.action_make_relation({
+    class_id:1,
+    prop_id:3,
+    item_id:1
+},{
+    class_id:2,
+    prop_id:2,
+    item_id:2
+})
+project.action_make_relation({
+    class_id:1,
+    prop_id:3,
+    item_id:1
+},{
+    class_id:2,
+    prop_id:2,
+    item_id:3
+})
+
+project.action_make_relation({
+    class_id:1,
+    prop_id:3,
+    item_id:1
+},{
+    class_id:3,
+    item_id:4
+})
+project.action_make_relation({
+    class_id:1,
+    prop_id:4,
+    item_id:1
+},{
+    class_id:2,
+    item_id:2
+})
+
+project.refresh_caches(['classlist','items','junctions']);
+
+
+console.log('--------------------------------------------------------')
+console.log('SANDBOX: deleting author property in books\n')
+
+project.action_edit_class_schema(
+    {
+        property_edits:[
+            {
+                type:'delete',
+                class_id:2,
+                prop_id:2
+            },
+            {
+                type:'create',
+                class_id:2,
+                prop_name:'author2',
+                config:{
+                    type:'relation',
+                    max_values:1
+                }
+            }
+        ],
+        relationship_edits:[
+            {type:'create',sides:[{class_id:1,prop_id:3},{class_id:2,prop_name:'author2'}]}
+        ]
+    }
+)
+
+console.log(readable_junctionlist(project.junction_cache,project.class_cache));

package/src/types.ts

@@ -0,0 +1,218 @@
+export type SQLTableType = 'system' | 'class' | 'properties' | 'junction' | 'workspace';
+
+export type SQLClassListRow = {
+    id: number;
+    name: string;
+    metadata: string; // JSON string
+  };
+
+export type SQLJunctonListRow = {
+    id: number;
+    sides: string; //JSON string
+    metadata: string; // JSON string
+  };
+
+export type RelationshipSideBase = {
+  class_id?:number;
+  prop_id?:number;
+  class_name?:string;
+  prop_name?:string;
+}
+
+export type RelationshipSide = RelationshipSideBase & {
+    class_id:number;
+};
+
+export type RelationTarget = {
+  class_id:number;
+  prop_id?:number | null;
+  junction_id:number;
+}
+
+
+export type ItemRelationSide = RelationshipSide & {
+  item_id:number;
+}
+
+
+type RelationCreate = {
+  type:'create',
+  sides:[
+    RelationshipSideBase,
+    RelationshipSideBase
+  ]
+}
+
+type RelationDelete = {
+  type:'delete',
+  id:number
+}
+
+type RelationTransfer = {
+  type:'transfer',
+  id:number,
+  sides:[
+    RelationshipSide,
+    RelationshipSide
+  ],
+  // ; to allow conversion from two-way to one-way relation (and one way to two-way?)
+  new_sides:[
+    RelationshipSideBase,
+    RelationshipSideBase
+  ]
+}
+
+
+export type RelationEdit = RelationCreate | RelationDelete | RelationTransfer;
+
+export type RelationEditValidSides = (RelationCreate & {sides:JunctionSides})| (RelationTransfer & {sides:JunctionSides, new_sides:JunctionSides}) | RelationDelete;
+
+type PropertyCreate ={
+  type:'create',
+  prop_name:string
+  class_id?:number,
+  class_name?:string,
+  config:PropertyDefinition
+}
+
+type PropertyDelete = {
+  type:'delete',
+  class_id:number
+  prop_id:number
+}
+
+type PropertyModify ={
+  type:'modify',
+  prop_id:number,
+  class_id:number
+  config:PropertyDefinition
+}
+
+export type PropertyEdit = PropertyCreate | PropertyDelete | PropertyModify
+
+type ClassCreate = {
+  type:'create',
+  class_name:string
+}
+
+type ClassDelete = {
+  type:'delete',
+  class_id:number
+}
+
+type ClassModify = {
+  type:'modify_attribute';
+  class_id:number;
+  attribute:{
+    // NOTE: for future defining, this should be one of a list of possible values
+    name:string;
+    // ... and this should be conditioned by the name
+    value:any;
+  }
+}
+
+export type ClassEdit = ClassCreate | ClassDelete | ClassModify;
+
+export type ClassMetadata ={
+  style:{
+    color?:string
+  }
+}
+
+export type PropertyType = 'data' | 'relation';
+
+export type BinaryBoolean = 0 | 1;
+
+// null if no max value
+export type MaxValues = number | null;
+
+export type BaseProperty={
+  id:number,
+  name:string,
+  type:PropertyType,
+  max_values:MaxValues
+}
+
+
+export type RelationDefinition = {
+  type:'relation';
+  relation_targets:RelationTarget[];
+  data_type?:never;
+}
+
+export type RelationProperty = BaseProperty & RelationDefinition;
+
+export type DataType = 'string' |'resource' | 'number';
+
+export type DataDefinition = {
+  type:'data';
+  data_type:DataType;
+  relation_targets?:never;
+}
+
+export type DataProperty = BaseProperty & DataDefinition;
+
+export type Property = RelationProperty | DataProperty;
+
+export type PropertyDefinition = {max_values:MaxValues} & ({type:'relation'} | DataDefinition);
+
+
+export type ClassRow={ [key: string]: any };
+
+export type ClassData ={
+  id:number;
+  name:string;
+  metadata:ClassMetadata;
+  items:ClassRow[];
+  properties:Property[];
+};
+
+export type ClassList =ClassData[];
+
+
+
+export type JunctionSides =[RelationshipSide,RelationshipSide];
+
+export type JunctionTable ={
+  id:number,
+  sides:JunctionSides,
+  metadata:{}
+}
+
+
+export type JunctionList =JunctionTable[];
+
+
+export type SQLApplicationWindow ={
+  id:number;
+  type:string;
+  open:BinaryBoolean;
+  metadata:string; // JSON string
+}
+export type ApplicationWindow ={
+  id:number;
+  type:string;
+  open:BinaryBoolean;
+  metadata:{}; 
+}
+
+// maybe elaborate this in the future
+export type ThingType = 'item' | 'class';
+
+export type BaseWorkspaceBlock = {
+  /** this is the ID of the display element in the workspace, generated by the workspace table */
+  block_id:number; 
+  
+  thing_type:ThingType;
+
+  /** this is the ID of the class, item, or other “thing” represented in the data */
+  thing_id:number;
+}
+
+export type SQLWorkspaceBlockRow = BaseWorkspaceBlock & {
+  metadata:string; // json string
+}
+
+export type WorkspaceBlock = BaseWorkspaceBlock & {
+  metadata:{};
+}

package/src/unit-tests.ts

@@ -0,0 +1,117 @@
+import { JunctionSides } from "./types";
+import { partial_relation_match } from "./utils.js";
+
+testRelationMatching();
+
+function testRelationMatching() {
+  const test1_old: JunctionSides = [
+    { class_id: 1, prop_id: 100 },
+    { class_id: 2, prop_id: 200 },
+  ];
+
+  const test1_new: JunctionSides = [
+    { class_id: 1, prop_id: 100 },
+    { class_id: 2, prop_id: 300 },
+  ];
+
+  const test2_old: JunctionSides = [
+    { class_id: 1, prop_id: 100 },
+    { class_id: 2, prop_id: 200 },
+  ];
+  const test2_new: JunctionSides = [
+    { class_id: 1, prop_id: 300 },
+    { class_id: 2, prop_id: 400 },
+  ];
+
+  // Case 3: Non-matching classes
+  const test3_old: JunctionSides = [
+    { class_id: 1, prop_id: 100 },
+    { class_id: 2, prop_id: 200 },
+  ];
+  const test3_new: JunctionSides = [
+    { class_id: 3, prop_id: 100 },
+    { class_id: 4, prop_id: 200 },
+  ];
+
+  const test4a_old: JunctionSides = [
+    { class_id: 1, prop_id: 100 },
+    { class_id: 1, prop_id: 200 },
+  ];
+  const test4a_new: JunctionSides = [
+    { class_id: 1, prop_id: 100 },
+    { class_id: 1, prop_id: 300 },
+  ];
+
+  // Case 4b: Same class on both sides with no matching properties
+  const test4b_old: JunctionSides = [
+    { class_id: 1, prop_id: 100 },
+    { class_id: 1, prop_id: 200 },
+  ];
+  const test4b_new: JunctionSides = [
+    { class_id: 1, prop_id: 300 },
+    { class_id: 1, prop_id: 400 },
+  ];
+
+  // Case 5: Reversed order matching
+  const test5_old: JunctionSides = [
+    { class_id: 1, prop_id: 100 },
+    { class_id: 2, prop_id: 200 },
+  ];
+  const test5_new: JunctionSides = [
+    { class_id: 2, prop_id: 200 },
+    { class_id: 1, prop_id: 300 },
+  ];
+
+  // Case 6: Undefined property IDs
+  const test6_old: JunctionSides = [
+    { class_id: 1 },
+    { class_id: 2, prop_id: 200 },
+  ];
+  const test6_new: JunctionSides = [
+    { class_id: 1, prop_id: 100 },
+    { class_id: 2 },
+  ];
+
+  // Case 7: Undefined property IDs on same side
+  const test7_old: JunctionSides = [
+    { class_id: 1 },
+    { class_id: 2, prop_id: 200 },
+  ];
+  const test7_new: JunctionSides = [
+    { class_id: 1 },
+    { class_id: 2, prop_id: 100 },
+  ];
+
+  console.log(
+    "same class, at least one prop (expect true)",
+    partial_relation_match(test1_new, test1_old)
+  );
+  console.log(
+    "same class, no props  (expect false)",
+    partial_relation_match(test2_old, test2_new)
+  );
+  console.log(
+    "different classes (expect false)",
+    partial_relation_match(test3_old, test3_new)
+  );
+  console.log(
+    "only one class, matching prop (expect true)",
+    partial_relation_match(test4a_new, test4a_old)
+  );
+  console.log(
+    "only one class, no props (expect false)",
+    partial_relation_match(test4b_old, test4b_new)
+  );
+  console.log(
+    "reversed class order, prop matching (expect true)",
+    partial_relation_match(test5_new, test5_old)
+  );
+  console.log(
+    "undefined prop (expect false)",
+    partial_relation_match(test6_old, test6_new)
+  );
+  console.log(
+    "undefined prop 2 (expect false)",
+    partial_relation_match(test7_old, test7_new)
+  );
+}

package/src/utils.ts

@@ -0,0 +1,133 @@
+import { JunctionSides, RelationshipSide,MaxValues,RelationshipSideBase, RelationEdit, RelationEditValidSides,ClassData,JunctionList } from "./types";
+
+
+export function defined<T>(v:T):v is NonNullable<T>{
+    return v!==undefined && v!==null;
+}
+
+
+// given the type above,
+// check if two relations share class ids on both sides
+// and share a property id on at least one side
+// note: it’s possible for both sides of a relation to have the same class id
+
+export function partial_relation_match(old_relation:JunctionSides,new_relation:JunctionSides):boolean{
+
+    // find class id matches in old for each side of new relation
+    let new_side_matches_in_old=[
+        [0,1].filter((i)=> old_relation[i].class_id==new_relation[0].class_id),
+        [0,1].filter((i)=> old_relation[i].class_id==new_relation[1].class_id)
+    ];
+
+    // for each match in the first side of the new relation
+    for(let match_index of new_side_matches_in_old[0]){
+
+        // converts 0 to 1 and 1 to 0, to get opposite side
+        let opposite_index=Math.abs(match_index-1);
+
+        // if this check passes, the relations share class IDs on both sides
+        if(new_side_matches_in_old[1].includes(opposite_index)){
+            // class match A
+            let match_a_new=new_relation[0];
+            let match_a_old=old_relation[match_index];
+
+            // class match B
+            let match_b_new=new_relation[1];
+            let match_b_old=old_relation[opposite_index];;
+            
+            // should return true if the properties match on at least one side
+            if(properties_exist_and_match(match_a_new,match_a_old) || properties_exist_and_match(match_b_new,match_b_old)){
+                return true;
+            }
+        }
+
+    }     
+
+    // if no matches found, return false found, 
+    return false;
+
+ }
+
+ function properties_exist_and_match(a:RelationshipSide,b:RelationshipSide){
+    return defined(a.prop_id) && defined(b.prop_id) && a.prop_id == b.prop_id;
+}
+
+function properties_match(a:RelationshipSide,b:RelationshipSide){
+    if(!defined(a.prop_id) && !defined(b.prop_id)) return true;
+    else return a.prop_id == b.prop_id;
+
+    // return defined(a.prop_id) && defined(b.prop_id) && a.prop_id == b.prop_id;
+}
+
+ export function side_match(x:RelationshipSide,y:RelationshipSide){
+    return x.class_id==y.class_id&&properties_match(x,y);
+ };
+
+ export function full_relation_match(a:JunctionSides,b:JunctionSides):boolean{
+    return (side_match(a[0],b[0])&&side_match(a[1],b[1])) ||
+           (side_match(a[0],b[1])&&side_match(a[1],b[0]));
+ }
+
+export function valid_sides(sides:[RelationshipSideBase,RelationshipSideBase]):sides is [RelationshipSide,RelationshipSide]{
+    return defined(sides[0].class_id) && defined(sides[1].class_id)
+}
+
+export function two_way(sides:JunctionSides){
+    return defined(sides[0].prop_id) && defined(sides[1].prop_id);
+}
+
+export function edit_has_valid_sides(edit:RelationEdit):edit is RelationEditValidSides{
+    switch(edit.type){
+        case 'create':
+            if(valid_sides(edit.sides)) return true;
+            break;
+        case 'transfer':
+            if(valid_sides(edit.sides)&&valid_sides(edit.new_sides)) return true;
+            break;
+        case 'delete':{
+            return true;
+        }
+    }
+    return false;
+}
+
+
+
+ export function can_have_multiple_values(max_values:MaxValues){
+    return max_values==null || max_values>1;
+ }
+
+export function junction_col_name(class_id:number,prop_id:number | undefined | null):string{
+    let prop_str=defined(prop_id)?`_prop_${prop_id}`:``
+    return `class_${class_id}${prop_str}`;
+}
+
+
+export function readable_side(side:RelationshipSide,classlist:ClassData[]){
+    let matching_class=classlist.find(c=>c.id==side.class_id);
+    let matching_prop=side.prop_id?(matching_class?.properties?.find(p=>p.id==side.prop_id)?.name || ''):'';
+    
+    matching_prop=matching_prop?`.[${matching_prop}]`:'';
+
+
+    return `${matching_class?.name || ''}${matching_prop}`;
+}
+
+function readable_sides(sides:JunctionSides,classlist:ClassData[]){
+    return `${readable_side(sides[0],classlist)} <-> ${readable_side(sides[1],classlist)}`
+}
+
+
+export function readable_edit(edit:RelationEditValidSides,classlist:ClassData[]){
+    if(edit.type=='delete') return `deletion of relation ${edit.id}`;
+    else if (edit.type=='transfer') return `transfer of (${readable_sides(edit.sides,classlist)}) to (${readable_sides(edit.new_sides,classlist)})`;
+    else if (edit.type=='create') return `creation of (${readable_sides(edit.sides,classlist)})`;
+}
+
+
+export function readable_junctionlist(relationships:JunctionList,classlist:ClassData[]){
+
+    return relationships.map((r)=>{
+        return readable_sides(r.sides,classlist)
+    })
+}