@sprucelabs/spruce-heartwood-utils 29.6.1 → 29.7.0

package/build/__tests__/support/MockRemoteViewControllerFactory.d.ts

@@ -3,9 +3,11 @@ import { RemoteFactoryOptions, RemoteViewControllerFactory } from '../../skillVi
 export default class MockRemoteViewControllerFactory implements RemoteViewControllerFactory {
     private static instance?;
     private loadedControllers;
-    private remoteControllerOptions?;
+    private lastRemoteCostructorOptions?;
+    private constructorOptionsById;
     private views;
     private static controllers?;
+    private static wasReset;
     constructor(options: RemoteFactoryOptions);
     fetchRemoteController(_name: string): Promise<(new () => ViewController<any>) & {
         id: string;
@@ -13,13 +15,14 @@ export default class MockRemoteViewControllerFactory implements RemoteViewContro
     Controller<N extends keyof ViewControllerMap, O extends ControllerOptions<N>>(_name: N, _options: O): ViewControllerMap[N];
     static dropInRemoteController(id: string, Class: new (args: any) => ViewController<any>): void;
     private static dropInControllers;
-    assertSkillViewRendersRemoteCard(vc: SkillViewController, id: string): void;
+    assertSkillViewRendersRemoteCard(vc: SkillViewController, name: string, id?: string): void;
     static reset(): void;
     static getInstance(): MockRemoteViewControllerFactory;
     getTheme(_namespace?: string | undefined): undefined;
     assertDidNotFetchRemoteController(id: string): void;
-    assertFetchedRemoteController(id: string, options?: Record<string, any>): void;
+    assertFetchedRemoteController(name: string, options?: Record<string, any>): void;
+    assertRemoteCardConstructorOptionsEqual(id: string, expected: Record<string, any>): void;
     hasController(name: string): boolean;
-    RemoteController(name: string, options: Record<string, any>): Promise<any>;
+    RemoteController(id: string, options: Record<string, any>): Promise<any>;
 }
 export type MockDroppedInControllers = Record<string, new (args: any) => ViewController<any>>;

package/build/__tests__/support/MockRemoteViewControllerFactory.js

@@ -5,12 +5,13 @@ const test_utils_1 = require("@sprucelabs/test-utils");
 class MockRemoteViewControllerFactory {
     constructor(options) {
         this.loadedControllers = {};
+        this.constructorOptionsById = {};
         MockRemoteViewControllerFactory.instance = this;
         this.views = options.vcFactory;
         MockRemoteViewControllerFactory.dropInControllers(this);
     }
     fetchRemoteController(_name) {
-        throw new Error('Not implemented in mock.');
+        throw new Error('Not implemented in mock. Maybe you meant to use this.remote.RemoteController(..)?');
     }
     Controller(_name, _options) {
         return {};
@@ -34,20 +35,41 @@ class MockRemoteViewControllerFactory {
             }
         }
     }
-    assertSkillViewRendersRemoteCard(vc, id) {
+    assertSkillViewRendersRemoteCard(vc, name, id) {
+        var _a;
+        const Class = (_a = MockRemoteViewControllerFactory.controllers) === null || _a === void 0 ? void 0 : _a[name];
+        test_utils_1.assert.isTruthy(Class, `You did not drop in a remote card with the name '${name}'! Try MockRemoteViewControllerFactory.dropInRemoteController('${name}', Class) in your beforeEach().`);
         const cards = heartwood_view_controllers_1.vcAssert.assertSkillViewRendersCards(vc);
+        const cardsWithNoControllers = cards.filter((c) => !c);
+        test_utils_1.assert.isLength(cardsWithNoControllers, 0, `Your remote card did not render with a controller. Try extending CardViewControllerImpl or rendering a CardViewController in your card's render() method:\n\npublic render() {
+	return this.cardVc.render()
+}`);
+        const cardsAndParents = [];
+        for (const card of cards) {
+            cardsAndParents.push(card);
+            // @ts-ignore
+            if (card.getParent) {
+                //@ts-ignore
+                cardsAndParents.push(card.getParent());
+            }
+        }
         //@ts-ignore
-        const match = cards.find((c) => c.id === id);
-        test_utils_1.assert.isTruthy(match, `Could not find the remote card with the id '${id}'!`);
-        heartwood_view_controllers_1.vcAssert.assertControllerInstanceOf(match, MockRemoteViewControllerFactory.controllers[id]);
+        let match = cardsAndParents.find((c) => c.id === name);
+        test_utils_1.assert.isTruthy(match, `Could not find the remote card with the id '${name}' Make sure your are rendering it!`);
+        if (id) {
+            match = heartwood_view_controllers_1.vcAssert.assertSkillViewRendersCard(vc, id);
+        }
+        heartwood_view_controllers_1.vcAssert.assertControllerInstanceOf(match, Class);
     }
     static reset() {
         delete this.instance;
         delete this.controllers;
+        this.wasReset = true;
     }
     static getInstance() {
+        test_utils_1.assert.isTruthy(this.wasReset, `You must reset your MockRemoteViewControllerFactory before getting an instance. Try MockRemoteViewControllerFactory.reset() in your test's beforeEach().`);
         if (!this.instance) {
-            throw 'You did not create a RemoveViewControllerFactory instance (and setup the mock factory). In your test try RemoteViewControllerFactoryImpl.Class = MockRemoteViewControllerFactory and in your skill view try this.remove = RemoteViewControllerFactoryImpl.Factory(...)';
+            test_utils_1.assert.fail('You did not create a RemoveViewControllerFactory instance (and setup the mock factory). In your test try RemoteViewControllerFactoryImpl.Class = MockRemoteViewControllerFactory and in your skill view try this.remote = RemoteViewControllerFactoryImpl.Factory(...)');
         }
         return this.instance;
     }
@@ -63,21 +85,28 @@ class MockRemoteViewControllerFactory {
         }
         test_utils_1.assert.fail(`You fetched the controller with the id '${id}' but you should not have.`);
     }
-    assertFetchedRemoteController(id, options) {
-        test_utils_1.assert.isTrue(this.hasController(id), `You never tried to fetch a controller with the id '${id}'. Try remoteViews.RemoteController(...)`);
+    assertFetchedRemoteController(name, options) {
+        test_utils_1.assert.isTrue(this.hasController(name), `You never tried to fetch a controller with the name '${name}'. Try remote.RemoteController(...)`);
         if (options) {
-            test_utils_1.assert.isEqualDeep(this.remoteControllerOptions, options, `You did not pass the expected options to remoteViews.RemoteController(${id}, options)`);
+            test_utils_1.assert.isEqualDeep(this.lastRemoteCostructorOptions, options, `You did not pass the expected options to remote.RemoteController(${name}, options)`);
         }
     }
+    assertRemoteCardConstructorOptionsEqual(id, expected) {
+        test_utils_1.assert.isEqualDeep(this.constructorOptionsById[id], expected, `The constructor options for the remote card with id '${id}' do not match the expected options. Make sure the card you are rendering has an id using this.views.Controller('card', { id })`);
+    }
     hasController(name) {
         var _a;
         return (_a = this.loadedControllers[name]) !== null && _a !== void 0 ? _a : false;
     }
-    async RemoteController(name, options) {
-        this.loadedControllers[name] = true;
-        this.remoteControllerOptions = options;
-        return this.views.Controller(name, options);
+    async RemoteController(id, options) {
+        var _a, _b;
+        test_utils_1.assert.isTruthy((_a = MockRemoteViewControllerFactory.controllers) === null || _a === void 0 ? void 0 : _a[id], `Could not find a remote card with the id '${id}'! Try MockRemoteViewControllerFactory.dropInRemoteController('${id}', Class) in your beforeEach().`);
+        this.loadedControllers[id] = true;
+        this.constructorOptionsById[(_b = options.id) !== null && _b !== void 0 ? _b : id] = options;
+        this.lastRemoteCostructorOptions = options;
+        return this.views.Controller(id, options);
     }
 }
+MockRemoteViewControllerFactory.wasReset = false;
 exports.default = MockRemoteViewControllerFactory;
 //# sourceMappingURL=MockRemoteViewControllerFactory.js.map

package/build/esm/__tests__/support/MockRemoteViewControllerFactory.d.ts

@@ -3,9 +3,11 @@ import { RemoteFactoryOptions, RemoteViewControllerFactory } from '../../skillVi
 export default class MockRemoteViewControllerFactory implements RemoteViewControllerFactory {
     private static instance?;
     private loadedControllers;
-    private remoteControllerOptions?;
+    private lastRemoteCostructorOptions?;
+    private constructorOptionsById;
     private views;
     private static controllers?;
+    private static wasReset;
     constructor(options: RemoteFactoryOptions);
     fetchRemoteController(_name: string): Promise<(new () => ViewController<any>) & {
         id: string;
@@ -13,13 +15,14 @@ export default class MockRemoteViewControllerFactory implements RemoteViewContro
     Controller<N extends keyof ViewControllerMap, O extends ControllerOptions<N>>(_name: N, _options: O): ViewControllerMap[N];
     static dropInRemoteController(id: string, Class: new (args: any) => ViewController<any>): void;
     private static dropInControllers;
-    assertSkillViewRendersRemoteCard(vc: SkillViewController, id: string): void;
+    assertSkillViewRendersRemoteCard(vc: SkillViewController, name: string, id?: string): void;
     static reset(): void;
     static getInstance(): MockRemoteViewControllerFactory;
     getTheme(_namespace?: string | undefined): undefined;
     assertDidNotFetchRemoteController(id: string): void;
-    assertFetchedRemoteController(id: string, options?: Record<string, any>): void;
+    assertFetchedRemoteController(name: string, options?: Record<string, any>): void;
+    assertRemoteCardConstructorOptionsEqual(id: string, expected: Record<string, any>): void;
     hasController(name: string): boolean;
-    RemoteController(name: string, options: Record<string, any>): Promise<any>;
+    RemoteController(id: string, options: Record<string, any>): Promise<any>;
 }
 export type MockDroppedInControllers = Record<string, new (args: any) => ViewController<any>>;

package/build/esm/__tests__/support/MockRemoteViewControllerFactory.js

@@ -9,15 +9,16 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { vcAssert, } from '@sprucelabs/heartwood-view-controllers';
 import { assert } from '@sprucelabs/test-utils';
-export default class MockRemoteViewControllerFactory {
+class MockRemoteViewControllerFactory {
     constructor(options) {
         this.loadedControllers = {};
+        this.constructorOptionsById = {};
         MockRemoteViewControllerFactory.instance = this;
         this.views = options.vcFactory;
         MockRemoteViewControllerFactory.dropInControllers(this);
     }
     fetchRemoteController(_name) {
-        throw new Error('Not implemented in mock.');
+        throw new Error('Not implemented in mock. Maybe you meant to use this.remote.RemoteController(..)?');
     }
     Controller(_name, _options) {
         return {};
@@ -41,20 +42,41 @@ export default class MockRemoteViewControllerFactory {
             }
         }
     }
-    assertSkillViewRendersRemoteCard(vc, id) {
+    assertSkillViewRendersRemoteCard(vc, name, id) {
+        var _a;
+        const Class = (_a = MockRemoteViewControllerFactory.controllers) === null || _a === void 0 ? void 0 : _a[name];
+        assert.isTruthy(Class, `You did not drop in a remote card with the name '${name}'! Try MockRemoteViewControllerFactory.dropInRemoteController('${name}', Class) in your beforeEach().`);
         const cards = vcAssert.assertSkillViewRendersCards(vc);
+        const cardsWithNoControllers = cards.filter((c) => !c);
+        assert.isLength(cardsWithNoControllers, 0, `Your remote card did not render with a controller. Try extending CardViewControllerImpl or rendering a CardViewController in your card's render() method:\n\npublic render() {
+	return this.cardVc.render()
+}`);
+        const cardsAndParents = [];
+        for (const card of cards) {
+            cardsAndParents.push(card);
+            // @ts-ignore
+            if (card.getParent) {
+                //@ts-ignore
+                cardsAndParents.push(card.getParent());
+            }
+        }
         //@ts-ignore
-        const match = cards.find((c) => c.id === id);
-        assert.isTruthy(match, `Could not find the remote card with the id '${id}'!`);
-        vcAssert.assertControllerInstanceOf(match, MockRemoteViewControllerFactory.controllers[id]);
+        let match = cardsAndParents.find((c) => c.id === name);
+        assert.isTruthy(match, `Could not find the remote card with the id '${name}' Make sure your are rendering it!`);
+        if (id) {
+            match = vcAssert.assertSkillViewRendersCard(vc, id);
+        }
+        vcAssert.assertControllerInstanceOf(match, Class);
     }
     static reset() {
         delete this.instance;
         delete this.controllers;
+        this.wasReset = true;
     }
     static getInstance() {
+        assert.isTruthy(this.wasReset, `You must reset your MockRemoteViewControllerFactory before getting an instance. Try MockRemoteViewControllerFactory.reset() in your test's beforeEach().`);
         if (!this.instance) {
-            throw 'You did not create a RemoveViewControllerFactory instance (and setup the mock factory). In your test try RemoteViewControllerFactoryImpl.Class = MockRemoteViewControllerFactory and in your skill view try this.remove = RemoteViewControllerFactoryImpl.Factory(...)';
+            assert.fail('You did not create a RemoveViewControllerFactory instance (and setup the mock factory). In your test try RemoteViewControllerFactoryImpl.Class = MockRemoteViewControllerFactory and in your skill view try this.remote = RemoteViewControllerFactoryImpl.Factory(...)');
         }
         return this.instance;
     }
@@ -70,21 +92,29 @@ export default class MockRemoteViewControllerFactory {
         }
         assert.fail(`You fetched the controller with the id '${id}' but you should not have.`);
     }
-    assertFetchedRemoteController(id, options) {
-        assert.isTrue(this.hasController(id), `You never tried to fetch a controller with the id '${id}'. Try remoteViews.RemoteController(...)`);
+    assertFetchedRemoteController(name, options) {
+        assert.isTrue(this.hasController(name), `You never tried to fetch a controller with the name '${name}'. Try remote.RemoteController(...)`);
         if (options) {
-            assert.isEqualDeep(this.remoteControllerOptions, options, `You did not pass the expected options to remoteViews.RemoteController(${id}, options)`);
+            assert.isEqualDeep(this.lastRemoteCostructorOptions, options, `You did not pass the expected options to remote.RemoteController(${name}, options)`);
         }
     }
+    assertRemoteCardConstructorOptionsEqual(id, expected) {
+        assert.isEqualDeep(this.constructorOptionsById[id], expected, `The constructor options for the remote card with id '${id}' do not match the expected options. Make sure the card you are rendering has an id using this.views.Controller('card', { id })`);
+    }
     hasController(name) {
         var _a;
         return (_a = this.loadedControllers[name]) !== null && _a !== void 0 ? _a : false;
     }
-    RemoteController(name, options) {
+    RemoteController(id, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            this.loadedControllers[name] = true;
-            this.remoteControllerOptions = options;
-            return this.views.Controller(name, options);
+            var _a, _b;
+            assert.isTruthy((_a = MockRemoteViewControllerFactory.controllers) === null || _a === void 0 ? void 0 : _a[id], `Could not find a remote card with the id '${id}'! Try MockRemoteViewControllerFactory.dropInRemoteController('${id}', Class) in your beforeEach().`);
+            this.loadedControllers[id] = true;
+            this.constructorOptionsById[(_b = options.id) !== null && _b !== void 0 ? _b : id] = options;
+            this.lastRemoteCostructorOptions = options;
+            return this.views.Controller(id, options);
         });
     }
 }
+MockRemoteViewControllerFactory.wasReset = false;
+export default MockRemoteViewControllerFactory;

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@sprucelabs/spruce-heartwood-utils",
 	"description": "Heartwood Utilities",
-	"version": "29.6.1",
+	"version": "29.7.0",
 	"skill": {
 		"namespace": "heartwood"
 	},