@sprucelabs/spruce-heartwood-utils 7.5.0 → 7.7.0

package/build/esm/index-module.d.ts

@@ -1,2 +1,3 @@
 export { default as RemoteViewControllerFactory } from './viewControllers/RemoteViewControllerFactory';
 export { default as CardRegistrar } from './viewControllers/CardRegistrar';
+export { default as remoteVcAssert } from './tests/remoteVcAssert';

package/build/esm/index-module.js

@@ -1,2 +1,3 @@
 export { default as RemoteViewControllerFactory } from './viewControllers/RemoteViewControllerFactory.js';
 export { default as CardRegistrar } from './viewControllers/CardRegistrar.js';
+export { default as remoteVcAssert } from './tests/remoteVcAssert.js';

package/build/esm/tests/remoteVcAssert.d.ts

@@ -0,0 +1,21 @@
+import { SkillViewController } from '@sprucelabs/heartwood-view-controllers';
+import { SkillEventContract } from '@sprucelabs/mercury-types';
+import { ArgsFromSvc, ViewFixture } from '@sprucelabs/spruce-test-fixtures';
+declare type EventNames = keyof SkillEventContract['eventSignatures'];
+export interface AssertRendersRemoteCardsOptions<Svc extends SkillViewController = SkillViewController> {
+    svc: Svc;
+    fqen: EventNames;
+    views: ViewFixture;
+    expectedTarget?: Record<string, any>;
+    expectedPayload?: Record<string, any>;
+    loadArgs?: ArgsFromSvc<Svc>;
+    shouldInvoke?: {
+        methodName: string;
+        expectedParams?: any[];
+    };
+}
+declare const remoteVcAssert: {
+    assertSkillViewRendersRemoteCards<Svc extends SkillViewController<Record<string, any>> = SkillViewController<Record<string, any>>>(options: AssertRendersRemoteCardsOptions<Svc>): Promise<void>;
+};
+export declare function generateId(): string;
+export default remoteVcAssert;

package/build/esm/tests/remoteVcAssert.js

@@ -0,0 +1,143 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { AbstractViewController, vcAssert, } from '@sprucelabs/heartwood-view-controllers';
+import { assertOptions } from '@sprucelabs/schema';
+import { eventFaker, } from '@sprucelabs/spruce-test-fixtures';
+import { assert } from '@sprucelabs/test';
+const remoteVcAssert = {
+    assertSkillViewRendersRemoteCards(options) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const { views, svc: svc, expectedTarget, expectedPayload, fqen, shouldInvoke, loadArgs, } = assertOptions(options, [
+                'svc',
+                'fqen',
+                'views',
+            ]);
+            const factory = views.getFactory();
+            factory.setController('heartwood.error-card', ThrowingErrorCardVc);
+            const vc1Id = generateId();
+            const vc2Id = generateId();
+            let wasHit = false;
+            let passedTarget;
+            let passedPayload;
+            yield eventFaker.on(fqen, 
+            //@ts-ignore
+            ({ target, payload }) => __awaiter(this, void 0, void 0, function* () {
+                passedTarget = target;
+                passedPayload = payload;
+                wasHit = true;
+                return {
+                    vcIds: ['assert.' + vc1Id, 'assert.' + vc2Id],
+                };
+            }));
+            yield eventFaker.on('heartwood.get-skill-views::v2021_02_11', () => {
+                const source = [
+                    generateVcSource({
+                        vcId: vc1Id,
+                        count: 1,
+                        stubMethod: shouldInvoke === null || shouldInvoke === void 0 ? void 0 : shouldInvoke.methodName,
+                    }),
+                    generateVcSource({
+                        vcId: vc2Id,
+                        count: 2,
+                        stubMethod: shouldInvoke === null || shouldInvoke === void 0 ? void 0 : shouldInvoke.methodName,
+                    }),
+                    `heartwood({ TestEventViewController1, TestEventViewController2 })`,
+                ].join('\n');
+                return {
+                    id: generateId(),
+                    ids: [vc1Id, vc2Id],
+                    source,
+                };
+            });
+            yield views.load(svc, loadArgs);
+            assert.isTrue(wasHit, `You did not load any remote cards. Next step is to add the following to your skill view's load():\n\nconst registrar = new CardRegistrar(...)\nconst cards = await registrar.fetch(...)\n\nAlso, make sure you create the new event that you'll emit when trying to fetch remote cards, something like 'my-skill.register-cards::v2020_02_02'\n\n`);
+            if (expectedTarget) {
+                assert.isEqualDeep(passedTarget, expectedTarget, 'The target you passed did not match!');
+            }
+            if (expectedPayload) {
+                assert.isEqualDeep(passedPayload, expectedPayload, 'The payload you passed did not match!');
+            }
+            let cards = [];
+            try {
+                cards = vcAssert.assertSkillViewRendersCards(svc, [vc1Id, vc2Id]);
+            }
+            catch (err) {
+                assert.fail(`You didn't drop in the cards to your skill view! Make sure your vcIdsTransformer looks something like:
+
+vcIdsTransformer: (payload) => {
+	return payload.vcIds
+} 
+
+You'll also want to add the cards to a local prop like:
+
+this.cards.push(...cards)
+
+Then make sure you render the cards like:
+
+public render() {
+	return {
+		layouts: splitCardsIntoLayouts(this.cards.map((c) => c.render()))
+	}
+}
+
+The original error is: ${(_a = err.stack) !== null && _a !== void 0 ? _a : err.message}
+`);
+            }
+            if (shouldInvoke) {
+                const { methodName, expectedParams } = shouldInvoke;
+                assert.isTrue(
+                //@ts-ignore
+                cards.filter((c) => c.wasHit).length === cards.length, `You gotta call cardVc.${methodName}(...) on all the cards you get back!`);
+                if (expectedParams) {
+                    //@ts-ignore
+                    const passed = cards[0].passedParams;
+                    assert.isEqualDeep(passed, expectedParams, `You didn't pass the expected params to ${methodName}!`);
+                }
+            }
+        });
+    },
+};
+function generateVcSource(options) {
+    const { vcId, count, stubMethod } = options;
+    return [
+        `class TestEventViewController${count} {
+			alert = function() {}
+			${stubMethod !== null && stubMethod !== void 0 ? stubMethod : 'noop'} = function () {
+				this.wasHit = true
+				this.passedParams = Array.prototype.slice.call(arguments)
+			}
+			render = function() {
+				return {
+					id: '${vcId}',
+					controller: this,
+				}
+			}
+		}`,
+        `TestEventViewController${count}.id = '${vcId}'`,
+    ].join('\n\n');
+}
+export function generateId() {
+    return `${Math.round(new Date().getTime() * (Math.random() * 100))}`;
+}
+class ThrowingErrorCardVc extends AbstractViewController {
+    constructor(options) {
+        super(options);
+        //@ts-ignore
+        if (options.error) {
+            //@ts-ignore
+            throw options.error;
+        }
+    }
+    render() {
+        return {};
+    }
+}
+export default remoteVcAssert;

package/build/esm/viewControllers/CardRegistrar.js

@@ -62,7 +62,11 @@ export default class CardRegistrar {
             }
             catch (err) {
                 console.error(err);
-                return [this.remoteVcFactory.Controller('heartwood.error-card', {})];
+                return [
+                    this.remoteVcFactory.Controller('heartwood.error-card', {
+                        error: err,
+                    }),
+                ];
             }
         });
     }

package/build/index-module.d.ts

@@ -1,2 +1,3 @@
 export { default as RemoteViewControllerFactory } from './viewControllers/RemoteViewControllerFactory';
 export { default as CardRegistrar } from './viewControllers/CardRegistrar';
+export { default as remoteVcAssert } from './tests/remoteVcAssert';

package/build/index-module.js

@@ -3,9 +3,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CardRegistrar = exports.RemoteViewControllerFactory = void 0;
+exports.remoteVcAssert = exports.CardRegistrar = exports.RemoteViewControllerFactory = void 0;
 var RemoteViewControllerFactory_1 = require("./viewControllers/RemoteViewControllerFactory");
 Object.defineProperty(exports, "RemoteViewControllerFactory", { enumerable: true, get: function () { return __importDefault(RemoteViewControllerFactory_1).default; } });
 var CardRegistrar_1 = require("./viewControllers/CardRegistrar");
 Object.defineProperty(exports, "CardRegistrar", { enumerable: true, get: function () { return __importDefault(CardRegistrar_1).default; } });
+var remoteVcAssert_1 = require("./tests/remoteVcAssert");
+Object.defineProperty(exports, "remoteVcAssert", { enumerable: true, get: function () { return __importDefault(remoteVcAssert_1).default; } });
 //# sourceMappingURL=index-module.js.map

package/build/tests/remoteVcAssert.d.ts

@@ -0,0 +1,21 @@
+import { SkillViewController } from '@sprucelabs/heartwood-view-controllers';
+import { SkillEventContract } from '@sprucelabs/mercury-types';
+import { ArgsFromSvc, ViewFixture } from '@sprucelabs/spruce-test-fixtures';
+declare type EventNames = keyof SkillEventContract['eventSignatures'];
+export interface AssertRendersRemoteCardsOptions<Svc extends SkillViewController = SkillViewController> {
+    svc: Svc;
+    fqen: EventNames;
+    views: ViewFixture;
+    expectedTarget?: Record<string, any>;
+    expectedPayload?: Record<string, any>;
+    loadArgs?: ArgsFromSvc<Svc>;
+    shouldInvoke?: {
+        methodName: string;
+        expectedParams?: any[];
+    };
+}
+declare const remoteVcAssert: {
+    assertSkillViewRendersRemoteCards<Svc extends SkillViewController<Record<string, any>> = SkillViewController<Record<string, any>>>(options: AssertRendersRemoteCardsOptions<Svc>): Promise<void>;
+};
+export declare function generateId(): string;
+export default remoteVcAssert;

package/build/tests/remoteVcAssert.js

@@ -0,0 +1,137 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateId = void 0;
+const heartwood_view_controllers_1 = require("@sprucelabs/heartwood-view-controllers");
+const schema_1 = require("@sprucelabs/schema");
+const spruce_test_fixtures_1 = require("@sprucelabs/spruce-test-fixtures");
+const test_1 = require("@sprucelabs/test");
+const remoteVcAssert = {
+    async assertSkillViewRendersRemoteCards(options) {
+        var _a;
+        const { views, svc: svc, expectedTarget, expectedPayload, fqen, shouldInvoke, loadArgs, } = (0, schema_1.assertOptions)(options, [
+            'svc',
+            'fqen',
+            'views',
+        ]);
+        const factory = views.getFactory();
+        factory.setController('heartwood.error-card', ThrowingErrorCardVc);
+        const vc1Id = generateId();
+        const vc2Id = generateId();
+        let wasHit = false;
+        let passedTarget;
+        let passedPayload;
+        await spruce_test_fixtures_1.eventFaker.on(fqen, 
+        //@ts-ignore
+        async ({ target, payload }) => {
+            passedTarget = target;
+            passedPayload = payload;
+            wasHit = true;
+            return {
+                vcIds: ['assert.' + vc1Id, 'assert.' + vc2Id],
+            };
+        });
+        await spruce_test_fixtures_1.eventFaker.on('heartwood.get-skill-views::v2021_02_11', () => {
+            const source = [
+                generateVcSource({
+                    vcId: vc1Id,
+                    count: 1,
+                    stubMethod: shouldInvoke === null || shouldInvoke === void 0 ? void 0 : shouldInvoke.methodName,
+                }),
+                generateVcSource({
+                    vcId: vc2Id,
+                    count: 2,
+                    stubMethod: shouldInvoke === null || shouldInvoke === void 0 ? void 0 : shouldInvoke.methodName,
+                }),
+                `heartwood({ TestEventViewController1, TestEventViewController2 })`,
+            ].join('\n');
+            return {
+                id: generateId(),
+                ids: [vc1Id, vc2Id],
+                source,
+            };
+        });
+        await views.load(svc, loadArgs);
+        test_1.assert.isTrue(wasHit, `You did not load any remote cards. Next step is to add the following to your skill view's load():\n\nconst registrar = new CardRegistrar(...)\nconst cards = await registrar.fetch(...)\n\nAlso, make sure you create the new event that you'll emit when trying to fetch remote cards, something like 'my-skill.register-cards::v2020_02_02'\n\n`);
+        if (expectedTarget) {
+            test_1.assert.isEqualDeep(passedTarget, expectedTarget, 'The target you passed did not match!');
+        }
+        if (expectedPayload) {
+            test_1.assert.isEqualDeep(passedPayload, expectedPayload, 'The payload you passed did not match!');
+        }
+        let cards = [];
+        try {
+            cards = heartwood_view_controllers_1.vcAssert.assertSkillViewRendersCards(svc, [vc1Id, vc2Id]);
+        }
+        catch (err) {
+            test_1.assert.fail(`You didn't drop in the cards to your skill view! Make sure your vcIdsTransformer looks something like:
+
+vcIdsTransformer: (payload) => {
+	return payload.vcIds
+} 
+
+You'll also want to add the cards to a local prop like:
+
+this.cards.push(...cards)
+
+Then make sure you render the cards like:
+
+public render() {
+	return {
+		layouts: splitCardsIntoLayouts(this.cards.map((c) => c.render()))
+	}
+}
+
+The original error is: ${(_a = err.stack) !== null && _a !== void 0 ? _a : err.message}
+`);
+        }
+        if (shouldInvoke) {
+            const { methodName, expectedParams } = shouldInvoke;
+            test_1.assert.isTrue(
+            //@ts-ignore
+            cards.filter((c) => c.wasHit).length === cards.length, `You gotta call cardVc.${methodName}(...) on all the cards you get back!`);
+            if (expectedParams) {
+                //@ts-ignore
+                const passed = cards[0].passedParams;
+                test_1.assert.isEqualDeep(passed, expectedParams, `You didn't pass the expected params to ${methodName}!`);
+            }
+        }
+    },
+};
+function generateVcSource(options) {
+    const { vcId, count, stubMethod } = options;
+    return [
+        `class TestEventViewController${count} {
+			alert = function() {}
+			${stubMethod !== null && stubMethod !== void 0 ? stubMethod : 'noop'} = function () {
+				this.wasHit = true
+				this.passedParams = Array.prototype.slice.call(arguments)
+			}
+			render = function() {
+				return {
+					id: '${vcId}',
+					controller: this,
+				}
+			}
+		}`,
+        `TestEventViewController${count}.id = '${vcId}'`,
+    ].join('\n\n');
+}
+function generateId() {
+    return `${Math.round(new Date().getTime() * (Math.random() * 100))}`;
+}
+exports.generateId = generateId;
+class ThrowingErrorCardVc extends heartwood_view_controllers_1.AbstractViewController {
+    constructor(options) {
+        super(options);
+        //@ts-ignore
+        if (options.error) {
+            //@ts-ignore
+            throw options.error;
+        }
+    }
+    render() {
+        return {};
+    }
+}
+exports.default = remoteVcAssert;
+//# sourceMappingURL=remoteVcAssert.js.map

package/build/viewControllers/CardRegistrar.js

@@ -57,7 +57,11 @@ class CardRegistrar {
         }
         catch (err) {
             console.error(err);
-            return [this.remoteVcFactory.Controller('heartwood.error-card', {})];
+            return [
+                this.remoteVcFactory.Controller('heartwood.error-card', {
+                    error: err,
+                }),
+            ];
         }
     }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sprucelabs/spruce-heartwood-utils",
   "description": "Heartwood Utilities",
-  "version": "7.5.0",
+  "version": "7.7.0",
   "skill": {
     "namespace": "heartwood"
   },
@@ -29,7 +29,11 @@
     "build/ThemeManager.js",
     "build/ThemeManager.d.ts",
     "build/esm/ThemeManager.js",
-    "build/esm/ThemeManager.d.ts"
+    "build/esm/ThemeManager.d.ts",
+    "build/tests/remoteVcAssert.js",
+    "build/tests/remoteVcAssert.d.ts",
+    "build/esm/tests/remoteVcAssert.js",
+    "build/esm/tests/remoteVcAssert.d.ts"
   ],
   "keywords": [],
   "scripts": {
@@ -38,7 +42,11 @@
   "dependencies": {
     "@sprucelabs/heartwood-view-controllers": "latest",
     "@sprucelabs/mercury-client": "latest",
-    "@sprucelabs/spruce-event-utils": "latest"
+    "@sprucelabs/mercury-types": "latest",
+    "@sprucelabs/schema": "latest",
+    "@sprucelabs/spruce-event-utils": "latest",
+    "@sprucelabs/spruce-test-fixtures": "latest",
+    "@sprucelabs/test": "latest"
   },
   "engines": {
     "node": "16.x",