goby-database 2.1.18 → 2.1.20

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import type { Database as DatabaseType, Statement } from 'better-sqlite3';
-import type { SQLTableType, SQLClassListRow, SQLJunctonListRow, JunctionSides, JunctionList, ClassList, Property, DataType, ItemRelationSide, SQLApplicationWindow, ApplicationWindow, WorkspaceBlock, ClassData, ClassRow, ClassEdit, RelationEdit, PropertyEdit, MaxValues, PropertyType, RelationProperty, DataProperty, RelationEditValidSides } from './types.js';
+import type { SQLTableType, SQLClassListRow, SQLJunctonListRow, JunctionSides, JunctionList, ClassList, Property, DataType, ItemRelationSide, SQLApplicationWindow, ApplicationWindow, WorkspaceBlock, ClassData, ClassEdit, RelationEdit, PropertyEdit, MaxValues, PropertyType, RelationProperty, DataProperty, RelationEditValidSides, ItemPagination, PaginatedItems } from './types.js';
 export default class Project {
     db: DatabaseType;
     run: {
@@ -19,10 +19,6 @@ export default class Project {
         }>;
     };
     class_cache: ClassList;
-    item_cache: {
-        class_id: number;
-        items: ClassRow[];
-    }[];
     junction_cache: JunctionList;
     constructor(source: string);
     get_latest_table_row_id(table_name: string): number | null;
@@ -81,12 +77,19 @@ export default class Project {
         value: any;
     }[]): void;
     action_make_relations(relations: [input_1: ItemRelationSide, input_2: ItemRelationSide][]): void;
-    retrieve_class_items({ class_id, class_name, class_data }: {
+    retrieve_class_items({ class_id, class_name, class_data, pagination }: {
         class_id: number;
         class_name?: string;
         class_data?: ClassData;
-    }): ClassRow[];
-    retrieve_all_classes(): ClassData[];
+        pagination?: ItemPagination;
+    }): PaginatedItems;
+    retrieve_all_classes(include?: {
+        all_items?: ItemPagination;
+        items_by_class?: {
+            class_id: number;
+            pagination: ItemPagination;
+        }[];
+    }): ClassData[];
     parse_sql_prop(class_id: number, sql_prop: {
         id: number;
         type: PropertyType;

package/dist/index.js

@@ -6,7 +6,6 @@ const real_data_types = ['number'];
 export default class Project {
     constructor(source) {
         this.class_cache = [];
-        this.item_cache = [];
         this.junction_cache = [];
         this.db = new Database(source);
         //checks if goby has been initialized, initializes if not
@@ -52,7 +51,7 @@ export default class Project {
             create_window: this.db.prepare(`INSERT INTO system_windows (type,open, metadata) VALUES (@type, @open, @meta)`),
             get_windows: this.db.prepare(`SELECT id, type, open, metadata FROM system_windows`)
         };
-        this.refresh_caches(['classlist', 'items', 'junctions']);
+        this.refresh_caches(['classlist', 'junctions']);
         // commenting this out until I figure out my transaction / one-step-undo functionality
         //if I understand transactions correctly, a new one will begin with every user action while committing the one before, meaning I'll need to have the first begin here
         // this.run.begin.run();
@@ -108,18 +107,6 @@ export default class Project {
         if (caches.includes('classlist')) {
             this.class_cache = this.retrieve_all_classes();
         }
-        if (caches.includes('items')) {
-            let refreshed_items = [];
-            for (let class_data of this.class_cache) {
-                let items = this.retrieve_class_items({ class_id: class_data.id });
-                refreshed_items.push({
-                    class_id: class_data.id,
-                    items
-                });
-                class_data.items = items;
-            }
-            this.item_cache = refreshed_items;
-        }
         if (caches.includes('junctions')) {
             this.junction_cache = this.get_junctions();
         }
@@ -149,6 +136,10 @@ export default class Project {
         const class_meta = {
             style: {
                 color: '#b5ffd5'
+            },
+            label: {
+                // TODO: build functionality to change label property in the future
+                properties: [1]
             }
         };
         // create entry for class in classlist
@@ -705,7 +696,6 @@ export default class Project {
         //get the last item in class table order and use it to get the order for the new item
         const new_order = this.get_next_order(`[class_${class_name}]`);
         this.db.prepare(`INSERT INTO [class_${class_name}] (system_id, system_order) VALUES (${root_id},${new_order})`).run();
-        this.refresh_caches(['items']);
         return root_id;
     }
     get_next_order(table_name) {
@@ -740,7 +730,6 @@ export default class Project {
         const set_statements = sql_column_inserts.map((p) => `${p.column_name} = ?`).join(',');
         const insert_statement = `UPDATE [class_${class_data.name}] SET ${set_statements} WHERE system_id=${item_id}`;
         this.db.prepare(insert_statement).run(params);
-        this.refresh_caches(['items']);
         function validate(input, data_type, max_values) {
             const multiple = max_values == null || max_values > 1;
             const values = multiple ? input : [input];
@@ -804,65 +793,93 @@ export default class Project {
                 throw Error('Something went wrong - junction table for relationship not found');
             }
         }
-        this.refresh_caches(['items']);
         // NOTE: should this trigger a refresh to items?
     }
-    retrieve_class_items({ class_id, class_name, class_data }) {
+    // MARKER: modify item retrieval
+    retrieve_class_items({ class_id, class_name, class_data, pagination = {} }) {
+        var _a, _b, _c, _d;
+        const pagination_defaults = {
+            page_size: null,
+            property_range: 'all'
+        };
+        pagination = Object.assign(Object.assign({}, pagination_defaults), pagination);
+        const slim = pagination.property_range == 'slim';
         if (class_name == undefined || class_data == undefined) {
             class_data = this.lookup_class(class_id);
             class_name = class_data.name;
         }
         ;
         const class_string = `[class_${class_name}]`;
-        // //joined+added at beginning of the query, built from relations
+        // joined+added at beginning of the query, built from relations
         const cte_strings = [];
-        // //joined+added near the end of the query, built from relations
+        // joined+added near the end of the query, built from relations
         const cte_joins = [];
-        // //joined+added between SELECT and FROM, built from relations
+        // joined+added between SELECT and FROM, built from relations
         const relation_selections = [];
+        // NOTE: in the future, if a property_range is defined, first filter class_data.properties by those IDs
         let relation_properties = class_data.properties.filter(a => a.type == 'relation');
-        for (let prop of relation_properties) {
-            const target_selects = [];
-            let property_junction_column_name = junction_col_name(class_id, prop.id);
-            if (prop.relation_targets.length > 0) {
-                for (let i = 0; i < prop.relation_targets.length; i++) {
-                    // find the side that does not match both the class and prop IDs
-                    let target = prop.relation_targets[i];
-                    if (target) {
-                        let target_junction_column_name = junction_col_name(target.class_id, target.prop_id);
-                        let junction_id = target.junction_id;
-                        let target_select = `SELECT "${property_junction_column_name}", json_object('class_id',${target.class_id},'id',"${target_junction_column_name}") AS target_data FROM junction_${junction_id}`;
-                        target_selects.push(target_select);
-                    }
-                    else {
-                        throw Error('Something went wrong trying to retrieve relationship data');
+        if (!slim) {
+            for (let prop of relation_properties) {
+                const target_selects = [];
+                let property_junction_column_name = junction_col_name(class_id, prop.id);
+                if (prop.relation_targets.length > 0) {
+                    for (let i = 0; i < prop.relation_targets.length; i++) {
+                        // find the side that does not match both the class and prop IDs
+                        let target = prop.relation_targets[i];
+                        const target_class = this.class_cache.find((a) => a.id == (target === null || target === void 0 ? void 0 : target.class_id));
+                        if (target && target_class) {
+                            let target_junction_column_name = junction_col_name(target.class_id, target.prop_id);
+                            // NOTE: as mentioned elsewhere, possibly allow multiple label props
+                            const target_label_id = (_b = (_a = target_class === null || target_class === void 0 ? void 0 : target_class.metadata) === null || _a === void 0 ? void 0 : _a.label) === null || _b === void 0 ? void 0 : _b.properties[0];
+                            const target_label = target_class === null || target_class === void 0 ? void 0 : target_class.properties.find((p) => p.id == target_label_id);
+                            const label_sql_string = target_label ? `,'user_${target_label.name}',target_class."user_${target_label.name}"` : '';
+                            let junction_id = target.junction_id;
+                            let target_select = `
+                            SELECT 
+                                "${property_junction_column_name}", 
+                                json_object('class_id',${target.class_id},'id',junction."${target_junction_column_name}"${label_sql_string}) AS target_data 
+                                FROM junction_${junction_id} AS junction
+                                LEFT JOIN "class_${target_class === null || target_class === void 0 ? void 0 : target_class.name}" AS target_class ON junction."${target_junction_column_name}" =  target_class.system_id
+                            `;
+                            target_selects.push(target_select);
+                        }
+                        else {
+                            throw Error('Something went wrong trying to retrieve relationship data');
+                        }
                     }
+                    // uses built-in aggregate json function instead of group_concat craziness
+                    const cte = `[${prop.id}_cte] AS (
+                        SELECT "${property_junction_column_name}", json_group_array( json(target_data) ) AS [user_${prop.name}]
+                        FROM 
+                        (
+                            ${target_selects.join(` 
+                            UNION 
+                            `)}
+                        )
+                        GROUP BY "${property_junction_column_name}"
+                    )`;
+                    cte_strings.push(cte);
+                    relation_selections.push(`[${prop.id}_cte].[user_${prop.name}]`);
+                    cte_joins.push(`LEFT JOIN [${prop.id}_cte] ON [${prop.id}_cte]."${property_junction_column_name}" = ${class_string}.system_id`);
+                }
+                else {
+                    relation_selections.push(`'[]' AS [user_${prop.name}]`);
                 }
-                // uses built-in aggregate json function instead of group_concat craziness
-                const cte = `[${prop.id}_cte] AS (
-                    SELECT "${property_junction_column_name}", json_group_array( json(target_data) ) AS [user_${prop.name}]
-                    FROM 
-                    (
-                        ${target_selects.join(` 
-                        UNION 
-                        `)}
-                    )
-                    GROUP BY "${property_junction_column_name}"
-                )`;
-                cte_strings.push(cte);
-                relation_selections.push(`[${prop.id}_cte].[user_${prop.name}]`);
-                cte_joins.push(`LEFT JOIN [${prop.id}_cte] ON [${prop.id}_cte]."${property_junction_column_name}" = ${class_string}.system_id`);
-            }
-            else {
-                relation_selections.push(`'[]' AS [user_${prop.name}]`);
             }
         }
         let orderby = `ORDER BY ${class_string}.system_order`;
+        let table_selection = `[class_${class_name}].*`;
+        if (slim) {
+            const label_prop_ids = (_d = (_c = class_data.metadata.label) === null || _c === void 0 ? void 0 : _c.properties) !== null && _d !== void 0 ? _d : [];
+            const label_props = class_data.properties.filter((p) => label_prop_ids.includes(p.id));
+            const label_prop_sql_string = label_props.map((p) => `[user_${p.name}]`).join(',');
+            table_selection = `system_id,system_order,${label_prop_sql_string}`;
+        }
         let comma_break = `,
             `;
         let query = `
             ${cte_strings.length > 0 ? "WITH " + cte_strings.join(comma_break) : ''}
-            SELECT [class_${class_name}].* ${relation_selections.length > 0 ? ', ' + relation_selections.join(`, `) : ''}
+            SELECT ${table_selection} ${relation_selections.length > 0 ? ', ' + relation_selections.join(`, `) : ''}
             FROM [class_${class_name}]
             ${cte_joins.join(' ')}
             ${orderby}`;
@@ -879,19 +896,31 @@ export default class Project {
                 }
             }
         });
-        return items;
+        return Object.assign(Object.assign({}, pagination), { loaded: items });
     }
-    retrieve_all_classes() {
+    // include:{
+    //     class_id:number;
+    //     pagination:ItemPagination
+    // }[] = []
+    // MARKER: modify item retrieval
+    retrieve_all_classes(include = {}) {
         const classes_data = this.run.get_all_classes.all();
         return classes_data.map(({ id, name, metadata }) => {
-            var _a;
-            let existing_items = this.item_cache.find((itemlist) => itemlist.class_id == id);
+            var _a, _b, _c;
             let properties_sql = this.db.prepare(`SELECT * FROM class_${id}_properties`).all() || [];
             let properties = properties_sql.map((sql_prop) => this.parse_sql_prop(id, sql_prop));
+            const pagination = (_a = include.all_items) !== null && _a !== void 0 ? _a : (_c = (_b = include.items_by_class) === null || _b === void 0 ? void 0 : _b.find(((a) => a.class_id == id))) === null || _c === void 0 ? void 0 : _c.pagination;
+            const items = pagination ? this.retrieve_class_items({
+                class_id: id,
+                class_name: name,
+                pagination
+            }) : {
+                loaded: []
+            };
             return {
                 id,
                 name,
-                items: (_a = existing_items === null || existing_items === void 0 ? void 0 : existing_items.items) !== null && _a !== void 0 ? _a : [],
+                items,
                 properties,
                 metadata: JSON.parse(metadata)
             };
@@ -948,9 +977,15 @@ export default class Project {
             ON system_root.id = workspace_${id}.thing_id
             WHERE workspace_${id}.type = 'item';
         `).all();
+        // MARKER: modify item retrieval
         // get any relevant classes
-        const classes = this.class_cache.filter((cls) => blocks.some((block) => block.type == 'class' && block.thing_id == cls.id));
-        // NOTE: could possibly add class items as well in the future
+        const items_by_class = blocks.filter((b) => b.type == 'class').map((b) => ({
+            class_id: b.thing_id,
+            pagination: {
+                page_size: null
+            }
+        }));
+        const classes = this.retrieve_all_classes({ items_by_class });
         return {
             blocks,
             items,

package/dist/types.d.ts

@@ -96,6 +96,9 @@ export type ClassMetadata = {
     style: {
         color?: string;
     };
+    label?: {
+        properties: number[];
+    };
 };
 export type PropertyType = 'data' | 'relation';
 export type BinaryBoolean = 0 | 1;
@@ -132,10 +135,18 @@ export type ClassData = {
     id: number;
     name: string;
     metadata: ClassMetadata;
-    items: ClassRow[];
+    items: PaginatedItems;
     properties: Property[];
 };
 export type ClassList = ClassData[];
+export type ItemPagination = {
+    page_size?: number | null;
+    page_range?: [start: number, end?: number];
+    property_range?: number[] | 'slim' | 'all';
+};
+export type PaginatedItems = ItemPagination & {
+    loaded: ClassRow[];
+};
 export type JunctionSides = [RelationshipSide, RelationshipSide];
 export type JunctionTable = {
     id: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "goby-database",
-  "version": "2.1.18",
+  "version": "2.1.20",
   "description": "This will hold the core better-sqlite3-powered application for creating and modifying goby databases",
   "main": "dist/index.js",
   "files": [
@@ -10,10 +10,7 @@
     "!dist/utils.js.map",
     "!dist/sandbox.js",
     "!dist/sandbox.d.ts",
-    "!dist/sandbox.js.map",
-    "!dist/unit-tests.js",
-    "!dist/unit-tests.d.ts",
-    "!dist/unit-tests.js.map"
+    "!dist/sandbox.js.map"
   ],
   "types": "dist/index.d.ts",
   "scripts": {