normalized nested expand items

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.9.1
+
+- Normalized nested `expand` items to `Record|Array<Record>` instances.
+
+
 ## 0.9.0
 
 - Added `pb.health.check()` that checks the health status of the API service (_available in PocketBase v0.10.0_)

dist/pocketbase.cjs.d.ts

@@ -50,6 +50,11 @@ declare class Record extends BaseModel {
     load(data: {
         [key: string]: any;
     }): void;
+    /**
+     * Loads the provided expand items and recursively normalizes each
+     * item to a `Record|Array<Record>`.
+     */
+    private loadExpand;
 }
 declare class Admin extends BaseModel {
     avatar: number;

dist/pocketbase.es.d.mts

@@ -50,6 +50,11 @@ declare class Record extends BaseModel {
     load(data: {
         [key: string]: any;
     }): void;
+    /**
+     * Loads the provided expand items and recursively normalizes each
+     * item to a `Record|Array<Record>`.
+     */
+    private loadExpand;
 }
 declare class Admin extends BaseModel {
     avatar: number;

dist/pocketbase.iife.d.ts

@@ -50,6 +50,11 @@ declare class Record extends BaseModel {
     load(data: {
         [key: string]: any;
     }): void;
+    /**
+     * Loads the provided expand items and recursively normalizes each
+     * item to a `Record|Array<Record>`.
+     */
+    private loadExpand;
 }
 declare class Admin extends BaseModel {
     avatar: number;

dist/pocketbase.umd.d.ts

@@ -50,6 +50,11 @@ declare class Record extends BaseModel {
     load(data: {
         [key: string]: any;
     }): void;
+    /**
+     * Loads the provided expand items and recursively normalizes each
+     * item to a `Record|Array<Record>`.
+     */
+    private loadExpand;
 }
 declare class Admin extends BaseModel {
     avatar: number;

package.json

@@ -1,5 +1,5 @@
 {
-    "version": "0.9.0",
+    "version": "0.9.1",
     "name": "pocketbase",
     "description": "PocketBase JavaScript SDK",
     "author": "Gani Georgiev",

src/models/Record.ts

@@ -14,6 +14,25 @@ export default class Record extends BaseModel {
         // normalize common fields
         this.collectionId   = typeof data.collectionId   === 'string' ? data.collectionId   : '';
         this.collectionName = typeof data.collectionName === 'string' ? data.collectionName : '';
-        this.expand         = typeof data.expand === 'object' && data.expand !== null ? data.expand : {};
+
+        // normalize expand items
+        this.loadExpand(data.expand);
+    }
+
+    /**
+     * Loads the provided expand items and recursively normalizes each
+     * item to a `Record|Array<Record>`.
+     */
+    private loadExpand(expand: { [key: string]: any }) {
+        expand = expand || {};
+        this.expand = {};
+
+        for (const key in expand) {
+            if (Array.isArray(expand[key])) {
+                this.expand[key] = expand[key].map((data: any) => new Record(data || {}));
+            } else {
+                this.expand[key] = new Record(expand[key] || {});
+            }
+        }
     }
 }

tests/models/Record.spec.ts

@@ -0,0 +1,36 @@
+import { assert } from 'chai';
+import Record     from '@/models/Record';
+
+describe('Record', function() {
+    describe('test Record data load and expand initialization', function () {
+        const data = {
+            id: "test_id",
+            collectionId: "test_collectionId",
+            collectionName: "test_collectionName",
+            custom: "test_custom",
+            expand: {
+                one: {
+                    id: "one_id",
+                    expand: {
+                        sub: [{id: "sub.a"}, {id: "sub.b"}]
+                    },
+                },
+                many: [{id: "multi_id"}],
+            }
+        };
+
+        const model = new Record(data);
+
+        assert.equal(model.id, data.id);
+        assert.equal(model.collectionId, data.collectionId);
+        assert.equal(model.collectionName, data.collectionName);
+        assert.equal(model.custom, data.custom);
+        assert.instanceOf(model.expand?.one, Record);
+        assert.equal((model.expand.one as any).id, data.expand.one.id);
+        assert.equal((model.expand.one as any).expand.sub.length, 2);
+        assert.instanceOf((model.expand.one as any).expand.sub[0], Record);
+        assert.instanceOf((model.expand.one as any).expand.sub[1], Record);
+        assert.equal((model.expand.many as any).length, 1);
+        assert.instanceOf((model.expand.many as any)[0], Record);
+    });
+});