inibase 1.6.4 → 1.6.5

package/README.md

@@ -634,6 +634,11 @@ const users = await db.get("user", undefined, {
   columns: ["!username", "!address.street"],
 });
 
+// Columns accept dotted nested paths (e.g. "address.street" => nested field)
+const nested = await db.get("user", undefined, {
+  columns: ["address.street", "hobbies.name"],
+});
+
 // Get all columns explicitly with the "*" wildcard
 const all = await db.get("user", undefined, {
   columns: ["*"],

package/dist/index.d.ts

@@ -79,6 +79,16 @@ export default class Inibase {
     constructor(database: string, mainFolder?: string, language?: ErrorLang);
     createError(name: ErrorCode, variable?: string | number | (string | number)[]): Error;
     private validateName;
+    /**
+     * Validates column paths used in the `columns` option.
+     *
+     * Each column may be a nested path of dot-separated names
+     * (e.g. "address.street", "hobbies.name") and may optionally
+     * start with "!" for exclusion. The "*" wildcard (select all)
+     * and its "!*" counterpart are special values and are skipped.
+     * Every segment of a path is validated individually.
+     */
+    private validateColumns;
     private validateSchema;
     private getFileExtension;
     private schemaToIdsPath;

package/dist/index.js

@@ -64,6 +64,28 @@ export default class Inibase {
     validateName(name) {
         Utils.validateName(name, this.language);
     }
+    /**
+     * Validates column paths used in the `columns` option.
+     *
+     * Each column may be a nested path of dot-separated names
+     * (e.g. "address.street", "hobbies.name") and may optionally
+     * start with "!" for exclusion. The "*" wildcard (select all)
+     * and its "!*" counterpart are special values and are skipped.
+     * Every segment of a path is validated individually.
+     */
+    validateColumns(columns) {
+        for (const column of columns) {
+            if (column === "*" || column === "!*")
+                continue;
+            const path = column.startsWith("!") ? column.slice(1) : column;
+            for (const segment of path.split(".")) {
+                if (!segment)
+                    this.validateName(column);
+                else
+                    this.validateName(segment);
+            }
+        }
+    }
     validateSchema(schema) {
         Utils.validateSchema(schema, this.language);
     }
@@ -1109,9 +1131,7 @@ export default class Inibase {
             options.columns = Array.isArray(options.columns)
                 ? options.columns
                 : [options.columns];
-            for (const column of options.columns)
-                if (column !== "*")
-                    this.validateName(column);
+            this.validateColumns(options.columns);
             if (options.columns.length && !options.columns.includes("id"))
                 options.columns.push("id");
         }
@@ -1356,11 +1376,9 @@ export default class Inibase {
             };
         this.validateName(tableName);
         if (options.columns)
-            for (const column of (Array.isArray(options.columns)
+            this.validateColumns((Array.isArray(options.columns)
                 ? options.columns
-                : [options.columns]))
-                if (column !== "*")
-                    this.validateName(column);
+                : [options.columns]));
         const tablePath = join(this.databasePath, tableName);
         await this.getTable(tableName);
         if (!globalConfig[this.databasePath].tables?.get(tableName)?.schema)
@@ -1443,11 +1461,9 @@ export default class Inibase {
         const renameList = [];
         this.validateName(tableName);
         if (options.columns)
-            for (const column of (Array.isArray(options.columns)
+            this.validateColumns((Array.isArray(options.columns)
                 ? options.columns
-                : [options.columns]))
-                if (column !== "*")
-                    this.validateName(column);
+                : [options.columns]));
         const tablePath = join(this.databasePath, tableName);
         await this.throwErrorIfTableEmpty(tableName);
         let clonedData = structuredClone(data);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "inibase",
-  "version": "1.6.4",
+  "version": "1.6.5",
   "type": "module",
   "author": {
     "name": "Karim Amahtil",