@sprucelabs/heartwood-view-controllers 111.1.33 → 111.1.35

package/build/esm/tests/utilities/buttonAssert.d.ts

@@ -1,4 +1,4 @@
-import { Button, Card, FormViewController, Navigation, ViewController } from '../../types/heartwood.types';
+import { Button, Card, FormViewController, Navigation, SkillViewController, ViewController } from '../../types/heartwood.types';
 import BigFormViewController from '../../viewControllers/BigForm.vc';
 import ButtonBarViewController from '../../viewControllers/ButtonBar.vc';
 import ButtonGroupViewController from '../../viewControllers/ButtonGroup.vc';
@@ -20,7 +20,7 @@ declare const buttonAssert: {
     buttonIsSelected(vc: ViewController<Card>, id: string): void;
 };
 export default buttonAssert;
-export declare function pluckButtons(vc: ViewController<Card> | ViewController<Navigation> | FormViewController<any> | BigFormViewController<any>, ids: string[]): {
+export declare function pluckButtons(vc: ViewController<Card> | ViewController<Navigation> | FormViewController<any> | BigFormViewController<any> | SkillViewController, ids: string[]): {
     found: string[];
     missing: string[];
     foundButtons: Button[];

package/build/esm/tests/utilities/buttonAssert.js

@@ -114,9 +114,26 @@ const buttonAssert = {
 };
 export default buttonAssert;
 export function pluckButtons(vc, ids) {
-    var _a, _b, _c, _d;
+    var _a;
     assertOptions({ vc, ids }, ['vc', 'ids']);
     const model = renderUtil.render(vc);
+    //@ts-ignore
+    if (model.layouts) {
+        const sv = model;
+        for (const layout of (_a = sv.layouts) !== null && _a !== void 0 ? _a : []) {
+            const cards = layout === null || layout === void 0 ? void 0 : layout.cards;
+            for (const card of cards !== null && cards !== void 0 ? cards : []) {
+                const results = pluckButtonsFromViewModel(card, ids);
+                if (results.found.length > 0) {
+                    return results;
+                }
+            }
+        }
+    }
+    return pluckButtonsFromViewModel(model, ids);
+}
+function pluckButtonsFromViewModel(model, ids) {
+    var _a, _b, _c, _d;
     const buttons = [
         //@ts-ignore
         ...((_d = (_b = (_a = model.criticalError) === null || _a === void 0 ? void 0 : _a.buttons) !== null && _b !== void 0 ? _b : (_c = model.footer) === null || _c === void 0 ? void 0 : _c.buttons) !== null && _d !== void 0 ? _d : []),

package/build/esm/tests/utilities/interactor.js

@@ -66,7 +66,7 @@ const interactor = {
     },
     clickButton(vc, buttonId) {
         return __awaiter(this, void 0, void 0, function* () {
-            const match = pluckButtonFromCard(vc, buttonId);
+            const match = pluckButtonFromView(vc, buttonId);
             yield this.click(match);
         });
     },
@@ -86,7 +86,7 @@ const interactor = {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b;
             assertOptions({ vc, buttonId }, ['vc', 'buttonId']);
-            const button = pluckButtonFromCard(vc, buttonId);
+            const button = pluckButtonFromView(vc, buttonId);
             assert.isTrue(button.shouldShowHintIcon, `Make sure have 'shouldShowHintIcon' set to true in your button: '${buttonId}'`);
             assert.isFunction(button.onClickHintIcon, `You gotta set 'onClickHintIcon' on your button with the id: '${(_a = button.id) !== null && _a !== void 0 ? _a : '***missing***'}'`);
             return (_b = button.onClickHintIcon) === null || _b === void 0 ? void 0 : _b.call(button);
@@ -412,7 +412,7 @@ const interactor = {
     },
 };
 export default interactor;
-function pluckButtonFromCard(vc, buttonId) {
+function pluckButtonFromView(vc, buttonId) {
     const { foundButtons } = pluckButtons(vc, [buttonId]);
     const match = foundButtons[0];
     assert.isTruthy(match, `Could not find a button in '${getVcName(vc)}' with the id '${buttonId}'`);

package/build/esm/tests/utilities/navigationAssert.d.ts

@@ -1,5 +1,5 @@
 import { PermissionContractId } from '@sprucelabs/mercury-types';
-import { Navigation, SkillViewController, SkillViewControllerId, ViewController } from '../../types/heartwood.types';
+import { AppController, Navigation, SkillViewController, SkillViewControllerId, ViewController } from '../../types/heartwood.types';
 declare const navigationAssert: {
     rendersButton(vc: ViewController<Navigation>, id: string): void;
     buttonRedirectsTo(options: {
@@ -12,7 +12,9 @@ declare const navigationAssert: {
     }): void;
     rendersButtons(vc: ViewController<Navigation>, ids: string[]): void;
     rendersButtonLabels(vc: ViewController<Navigation>): void;
-    skillViewRendersNavigation(vc: Pick<SkillViewController, "renderNavigation">): ViewController<import("@sprucelabs/mercury-types").SpruceSchemas.HeartwoodViewControllers.v2021_02_11.Navigation>;
+    skillViewRendersNavigation(vc: Pick<SkillViewController, "renderNavigation">, msg?: string): ViewController<import("@sprucelabs/mercury-types").SpruceSchemas.HeartwoodViewControllers.v2021_02_11.Navigation>;
+    appRendersNavigation(vc: Pick<AppController, "renderNavigation">): ViewController<import("@sprucelabs/mercury-types").SpruceSchemas.HeartwoodViewControllers.v2021_02_11.Navigation>;
+    appDoesNotRenderNavigation(vc: Pick<AppController, "renderNavigation">): void;
     skillViewDoesNotRenderNavigation(vc: Pick<SkillViewController, "renderNavigation">): void;
     buttonRequiresViewPermissions(vc: ViewController<Navigation>, button: string, permissionContractId: PermissionContractId): void;
 };

package/build/esm/tests/utilities/navigationAssert.js

@@ -22,12 +22,20 @@ const navigationAssert = {
         const model = renderUtil.render(vc);
         assert.isTrue(model.shouldRenderButtonLabels, `Your navigation should render button labels but it is not! Try shouldRenderButtonLabels: true`);
     },
-    skillViewRendersNavigation(vc) {
+    skillViewRendersNavigation(vc, msg) {
         var _a;
         const nav = (_a = vc.renderNavigation) === null || _a === void 0 ? void 0 : _a.call(vc);
-        assert.isTruthy(nav, `Your skill view did not render a navigation! Implement renderNavigation() and use this.Controller('navigation', {}) to render one.`);
+        assert.isTruthy(nav, msg !== null && msg !== void 0 ? msg : `Your skill view did not render a navigation! Implement renderNavigation() and use this.Controller('navigation', {}) to render one.`);
         return nav.controller;
     },
+    appRendersNavigation(vc) {
+        return this.skillViewRendersNavigation(vc, `Your AppController did not render a navigation! Implement renderNavigation() and use this.Controller('navigation', {}) to render one.`);
+    },
+    appDoesNotRenderNavigation(vc) {
+        var _a;
+        const nav = (_a = vc.renderNavigation) === null || _a === void 0 ? void 0 : _a.call(vc);
+        assert.isNull(nav, `Your AppController should not render a navigation! Implement renderNavigation() and return null.`);
+    },
     skillViewDoesNotRenderNavigation(vc) {
         var _a;
         const nav = (_a = vc.renderNavigation) === null || _a === void 0 ? void 0 : _a.call(vc);

package/build/esm/types/heartwood.types.d.ts

@@ -517,7 +517,7 @@ export interface ActiveRecordSearchOptions {
 export interface AppController {
     renderNavigation?(): Navigation | null | undefined;
     renderToolBelt?(): ToolBelt | null | undefined;
-    load?(options: AppControllerLoadOptions): Promise<void>;
+    load(options: AppControllerLoadOptions): Promise<void>;
 }
 export type BuiltAppController = AppController & {
     id: string;

package/build/esm/viewControllers/Abstract.ac.d.ts

@@ -1,5 +1,9 @@
-import { AppController, ViewControllerOptions } from '../types/heartwood.types';
+import { AppController, AppControllerLoadOptions, ControllerOptions, ViewControllerId, ViewControllerMap, ViewControllerOptions, ViewControllerPlugins } from '../types/heartwood.types';
 export default abstract class AbstractAppController implements AppController {
     static id: string;
-    constructor(_options: ViewControllerOptions);
+    protected plugins: ViewControllerPlugins;
+    private views;
+    constructor(options: ViewControllerOptions);
+    load(options: AppControllerLoadOptions): Promise<void>;
+    Controller<N extends ViewControllerId, O extends ControllerOptions<N>>(id: N, options: O): ViewControllerMap[N];
 }

package/build/esm/viewControllers/Abstract.ac.js

@@ -1,3 +1,22 @@
+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());
+    });
+};
 export default class AbstractAppController {
-    constructor(_options) { }
+    constructor(options) {
+        const { plugins, vcFactory } = options;
+        this.plugins = plugins;
+        this.views = vcFactory;
+    }
+    load(options) {
+        return __awaiter(this, void 0, void 0, function* () { });
+    }
+    Controller(id, options) {
+        return this.views.Controller(id, options);
+    }
 }

package/build/tests/utilities/buttonAssert.d.ts

@@ -1,4 +1,4 @@
-import { Button, Card, FormViewController, Navigation, ViewController } from '../../types/heartwood.types';
+import { Button, Card, FormViewController, Navigation, SkillViewController, ViewController } from '../../types/heartwood.types';
 import BigFormViewController from '../../viewControllers/BigForm.vc';
 import ButtonBarViewController from '../../viewControllers/ButtonBar.vc';
 import ButtonGroupViewController from '../../viewControllers/ButtonGroup.vc';
@@ -20,7 +20,7 @@ declare const buttonAssert: {
     buttonIsSelected(vc: ViewController<Card>, id: string): void;
 };
 export default buttonAssert;
-export declare function pluckButtons(vc: ViewController<Card> | ViewController<Navigation> | FormViewController<any> | BigFormViewController<any>, ids: string[]): {
+export declare function pluckButtons(vc: ViewController<Card> | ViewController<Navigation> | FormViewController<any> | BigFormViewController<any> | SkillViewController, ids: string[]): {
     found: string[];
     missing: string[];
     foundButtons: Button[];

package/build/tests/utilities/buttonAssert.js

@@ -116,6 +116,22 @@ exports.default = buttonAssert;
 function pluckButtons(vc, ids) {
     (0, schema_1.assertOptions)({ vc, ids }, ['vc', 'ids']);
     const model = render_utility_1.default.render(vc);
+    //@ts-ignore
+    if (model.layouts) {
+        const sv = model;
+        for (const layout of sv.layouts ?? []) {
+            const cards = layout?.cards;
+            for (const card of cards ?? []) {
+                const results = pluckButtonsFromViewModel(card, ids);
+                if (results.found.length > 0) {
+                    return results;
+                }
+            }
+        }
+    }
+    return pluckButtonsFromViewModel(model, ids);
+}
+function pluckButtonsFromViewModel(model, ids) {
     const buttons = [
         //@ts-ignore
         ...(model.criticalError?.buttons ?? model.footer?.buttons ?? []),

package/build/tests/utilities/interactor.js

@@ -59,7 +59,7 @@ const interactor = {
         });
     },
     async clickButton(vc, buttonId) {
-        const match = pluckButtonFromCard(vc, buttonId);
+        const match = pluckButtonFromView(vc, buttonId);
         await this.click(match);
     },
     async clickButtonInGroup(buttonGroupVc, buttonIdOrIdx) {
@@ -74,7 +74,7 @@ const interactor = {
     },
     async clickButtonHint(vc, buttonId) {
         (0, schema_1.assertOptions)({ vc, buttonId }, ['vc', 'buttonId']);
-        const button = pluckButtonFromCard(vc, buttonId);
+        const button = pluckButtonFromView(vc, buttonId);
         test_utils_1.assert.isTrue(button.shouldShowHintIcon, `Make sure have 'shouldShowHintIcon' set to true in your button: '${buttonId}'`);
         test_utils_1.assert.isFunction(button.onClickHintIcon, `You gotta set 'onClickHintIcon' on your button with the id: '${button.id ?? '***missing***'}'`);
         return button.onClickHintIcon?.();
@@ -330,7 +330,7 @@ const interactor = {
     },
 };
 exports.default = interactor;
-function pluckButtonFromCard(vc, buttonId) {
+function pluckButtonFromView(vc, buttonId) {
     const { foundButtons } = (0, buttonAssert_1.pluckButtons)(vc, [buttonId]);
     const match = foundButtons[0];
     test_utils_1.assert.isTruthy(match, `Could not find a button in '${(0, assertSupport_1.getVcName)(vc)}' with the id '${buttonId}'`);

package/build/tests/utilities/navigationAssert.d.ts

@@ -1,5 +1,5 @@
 import { PermissionContractId } from '@sprucelabs/mercury-types';
-import { Navigation, SkillViewController, SkillViewControllerId, ViewController } from '../../types/heartwood.types';
+import { AppController, Navigation, SkillViewController, SkillViewControllerId, ViewController } from '../../types/heartwood.types';
 declare const navigationAssert: {
     rendersButton(vc: ViewController<Navigation>, id: string): void;
     buttonRedirectsTo(options: {
@@ -12,7 +12,9 @@ declare const navigationAssert: {
     }): void;
     rendersButtons(vc: ViewController<Navigation>, ids: string[]): void;
     rendersButtonLabels(vc: ViewController<Navigation>): void;
-    skillViewRendersNavigation(vc: Pick<SkillViewController, "renderNavigation">): ViewController<import("@sprucelabs/mercury-types").SpruceSchemas.HeartwoodViewControllers.v2021_02_11.Navigation>;
+    skillViewRendersNavigation(vc: Pick<SkillViewController, "renderNavigation">, msg?: string): ViewController<import("@sprucelabs/mercury-types").SpruceSchemas.HeartwoodViewControllers.v2021_02_11.Navigation>;
+    appRendersNavigation(vc: Pick<AppController, "renderNavigation">): ViewController<import("@sprucelabs/mercury-types").SpruceSchemas.HeartwoodViewControllers.v2021_02_11.Navigation>;
+    appDoesNotRenderNavigation(vc: Pick<AppController, "renderNavigation">): void;
     skillViewDoesNotRenderNavigation(vc: Pick<SkillViewController, "renderNavigation">): void;
     buttonRequiresViewPermissions(vc: ViewController<Navigation>, button: string, permissionContractId: PermissionContractId): void;
 };

package/build/tests/utilities/navigationAssert.js

@@ -26,11 +26,19 @@ const navigationAssert = {
         const model = render_utility_1.default.render(vc);
         test_utils_1.assert.isTrue(model.shouldRenderButtonLabels, `Your navigation should render button labels but it is not! Try shouldRenderButtonLabels: true`);
     },
-    skillViewRendersNavigation(vc) {
+    skillViewRendersNavigation(vc, msg) {
         const nav = vc.renderNavigation?.();
-        test_utils_1.assert.isTruthy(nav, `Your skill view did not render a navigation! Implement renderNavigation() and use this.Controller('navigation', {}) to render one.`);
+        test_utils_1.assert.isTruthy(nav, msg ??
+            `Your skill view did not render a navigation! Implement renderNavigation() and use this.Controller('navigation', {}) to render one.`);
         return nav.controller;
     },
+    appRendersNavigation(vc) {
+        return this.skillViewRendersNavigation(vc, `Your AppController did not render a navigation! Implement renderNavigation() and use this.Controller('navigation', {}) to render one.`);
+    },
+    appDoesNotRenderNavigation(vc) {
+        const nav = vc.renderNavigation?.();
+        test_utils_1.assert.isNull(nav, `Your AppController should not render a navigation! Implement renderNavigation() and return null.`);
+    },
     skillViewDoesNotRenderNavigation(vc) {
         const nav = vc.renderNavigation?.();
         test_utils_1.assert.isNull(nav, `Your skill view should not render a navigation! Implement renderNavigation() and return null.`);

package/build/types/heartwood.types.d.ts

@@ -517,7 +517,7 @@ export interface ActiveRecordSearchOptions {
 export interface AppController {
     renderNavigation?(): Navigation | null | undefined;
     renderToolBelt?(): ToolBelt | null | undefined;
-    load?(options: AppControllerLoadOptions): Promise<void>;
+    load(options: AppControllerLoadOptions): Promise<void>;
 }
 export type BuiltAppController = AppController & {
     id: string;

package/build/viewControllers/Abstract.ac.d.ts

@@ -1,5 +1,9 @@
-import { AppController, ViewControllerOptions } from '../types/heartwood.types';
+import { AppController, AppControllerLoadOptions, ControllerOptions, ViewControllerId, ViewControllerMap, ViewControllerOptions, ViewControllerPlugins } from '../types/heartwood.types';
 export default abstract class AbstractAppController implements AppController {
     static id: string;
-    constructor(_options: ViewControllerOptions);
+    protected plugins: ViewControllerPlugins;
+    private views;
+    constructor(options: ViewControllerOptions);
+    load(options: AppControllerLoadOptions): Promise<void>;
+    Controller<N extends ViewControllerId, O extends ControllerOptions<N>>(id: N, options: O): ViewControllerMap[N];
 }

package/build/viewControllers/Abstract.ac.js

@@ -1,6 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 class AbstractAppController {
-    constructor(_options) { }
+    constructor(options) {
+        const { plugins, vcFactory } = options;
+        this.plugins = plugins;
+        this.views = vcFactory;
+    }
+    async load(options) { }
+    Controller(id, options) {
+        return this.views.Controller(id, options);
+    }
 }
 exports.default = AbstractAppController;

package/package.json

@@ -13,7 +13,7 @@
   "sideEffects": false,
   "license": "MIT",
   "description": "All the power of Heartwood in one, convenient package.",
-  "version": "111.1.33",
+  "version": "111.1.35",
   "skill": {
     "namespace": "HeartwoodViewControllers",
     "commandOverrides": {