@sprucelabs/spruce-heartwood-utils 7.6.2 → 7.8.1

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

@@ -1,20 +1,21 @@
 import { SkillViewController } from '@sprucelabs/heartwood-view-controllers';
 import { SkillEventContract } from '@sprucelabs/mercury-types';
-import { ViewFixture } from '@sprucelabs/spruce-test-fixtures';
+import { ArgsFromSvc, ViewFixture } from '@sprucelabs/spruce-test-fixtures';
 declare type EventNames = keyof SkillEventContract['eventSignatures'];
-export interface AssertRendersRemoteCardsOptions {
-    vc: SkillViewController;
+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(options: AssertRendersRemoteCardsOptions): Promise<void>;
+    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

@@ -9,13 +9,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { AbstractViewController, vcAssert, } from '@sprucelabs/heartwood-view-controllers';
 import { assertOptions } from '@sprucelabs/schema';
-import { eventFaker } from '@sprucelabs/spruce-test-fixtures';
+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, vc, expectedTarget, expectedPayload, fqen, shouldInvoke } = assertOptions(options, ['vc', 'fqen', 'views']);
+            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();
@@ -25,7 +29,7 @@ const remoteVcAssert = {
             let passedPayload;
             yield eventFaker.on(fqen, 
             //@ts-ignore
-            ({ target, payload }) => __awaiter(this, void 0, void 0, function* () {
+            ({ target, payload } = {}) => __awaiter(this, void 0, void 0, function* () {
                 passedTarget = target;
                 passedPayload = payload;
                 wasHit = true;
@@ -53,7 +57,7 @@ const remoteVcAssert = {
                     source,
                 };
             });
-            yield views.load(vc);
+            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!');
@@ -63,7 +67,7 @@ const remoteVcAssert = {
             }
             let cards = [];
             try {
-                cards = vcAssert.assertSkillViewRendersCards(vc, [vc1Id, vc2Id]);
+                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:

package/build/esm/viewControllers/CardRegistrar.js

@@ -40,9 +40,13 @@ export default class CardRegistrar {
                 const { each, controllerOptionsHandler, target, payload } = options !== null && options !== void 0 ? options : {};
                 const targetAndPayload = target || payload ? { target, payload } : undefined;
                 const cards = [];
-                yield this.client.emitAndFlattenResponses(this.eventName, targetAndPayload, ({ payload }) => __awaiter(this, void 0, void 0, function* () {
+                yield this.client.emitAndFlattenResponses(this.eventName, targetAndPayload, (targetAndPayload) => __awaiter(this, void 0, void 0, function* () {
                     var _a;
+                    const { payload } = targetAndPayload !== null && targetAndPayload !== void 0 ? targetAndPayload : {};
                     const vcIds = this.vcIdsTransformer(payload);
+                    if (!Array.isArray(vcIds)) {
+                        throw 'Your vcIdsTransform MUST return an array!';
+                    }
                     const responseCards = [];
                     for (const id of vcIds) {
                         try {

package/build/tests/remoteVcAssert.d.ts

@@ -1,20 +1,21 @@
 import { SkillViewController } from '@sprucelabs/heartwood-view-controllers';
 import { SkillEventContract } from '@sprucelabs/mercury-types';
-import { ViewFixture } from '@sprucelabs/spruce-test-fixtures';
+import { ArgsFromSvc, ViewFixture } from '@sprucelabs/spruce-test-fixtures';
 declare type EventNames = keyof SkillEventContract['eventSignatures'];
-export interface AssertRendersRemoteCardsOptions {
-    vc: SkillViewController;
+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(options: AssertRendersRemoteCardsOptions): Promise<void>;
+    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

@@ -8,7 +8,11 @@ const test_1 = require("@sprucelabs/test");
 const remoteVcAssert = {
     async assertSkillViewRendersRemoteCards(options) {
         var _a;
-        const { views, vc, expectedTarget, expectedPayload, fqen, shouldInvoke } = (0, schema_1.assertOptions)(options, ['vc', 'fqen', 'views']);
+        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();
@@ -18,7 +22,7 @@ const remoteVcAssert = {
         let passedPayload;
         await spruce_test_fixtures_1.eventFaker.on(fqen, 
         //@ts-ignore
-        async ({ target, payload }) => {
+        async ({ target, payload } = {}) => {
             passedTarget = target;
             passedPayload = payload;
             wasHit = true;
@@ -46,7 +50,7 @@ const remoteVcAssert = {
                 source,
             };
         });
-        await views.load(vc);
+        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!');
@@ -56,7 +60,7 @@ const remoteVcAssert = {
         }
         let cards = [];
         try {
-            cards = heartwood_view_controllers_1.vcAssert.assertSkillViewRendersCards(vc, [vc1Id, vc2Id]);
+            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:

package/build/viewControllers/CardRegistrar.js

@@ -35,9 +35,13 @@ class CardRegistrar {
             const { each, controllerOptionsHandler, target, payload } = options !== null && options !== void 0 ? options : {};
             const targetAndPayload = target || payload ? { target, payload } : undefined;
             const cards = [];
-            await this.client.emitAndFlattenResponses(this.eventName, targetAndPayload, async ({ payload }) => {
+            await this.client.emitAndFlattenResponses(this.eventName, targetAndPayload, async (targetAndPayload) => {
                 var _a;
+                const { payload } = targetAndPayload !== null && targetAndPayload !== void 0 ? targetAndPayload : {};
                 const vcIds = this.vcIdsTransformer(payload);
+                if (!Array.isArray(vcIds)) {
+                    throw 'Your vcIdsTransform MUST return an array!';
+                }
                 const responseCards = [];
                 for (const id of vcIds) {
                     try {

package/package.json

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