@sprucelabs/heartwood-view-controllers 129.4.3 → 129.5.0

package/README.md

@@ -3,6 +3,8 @@
 <h1 align="center">
 Spruce XP Documentation
 </h1>
+
+[![AI TDD Contributor](https://regressionproof.ai/badge.svg)](https://regressionproof.ai)
 <h3 align="center">Spruce XP is an Experience Platform built to create unforgettable experiences and long-lasting relationships.
 </h3>
 <p align="center">
@@ -19,6 +21,4 @@ Spruce XP Documentation
 </p>
 
 ### Dependencies
-[Arkit diagram here](docs/dependencies.md).
-
-[![AI TDD Contributor](https://regressionproof.ai/badge.svg)](https://regressionproof.ai)
+[Arkit diagram here](docs/dependencies.md).

package/build/.spruce/schemas/heartwoodViewControllers/v2021_02_11/navigation.schema.js

@@ -39,6 +39,14 @@ const navigationSchema = {
             isArray: true,
             options: { valueType: `HeartwoodTypes.NavigationItem`, }
         },
+        /** Set refresh permissions handler. The handler you pass here will be called when the navigation asks to refresh permissions. */
+        'setRefreshPermissionsHandler': {
+            label: 'Set refresh permissions handler',
+            type: 'raw',
+            isRequired: true,
+            hint: 'The handler you pass here will be called when the navigation asks to refresh permissions.',
+            options: { valueType: `(cb: HeartwoodTypes.RefreshNavigationPermissionsHandler) => void`, }
+        },
         /** . */
         'additionalValidRoutes': {
             type: 'schema',

package/build/.spruce/schemas/schemas.types.d.ts

@@ -4264,6 +4264,8 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
             /** Controller. */
             'controller'?: (HeartwoodTypes.ViewController<HeartwoodTypes.Navigation>) | undefined | null;
             'buttons'?: (HeartwoodTypes.NavigationItem)[] | undefined | null;
+            /** Set refresh permissions handler. The handler you pass here will be called when the navigation asks to refresh permissions. */
+            'setRefreshPermissionsHandler': ((cb: HeartwoodTypes.RefreshNavigationPermissionsHandler) => void);
             'additionalValidRoutes'?: SpruceSchemas.HeartwoodViewControllers.v2021_02_11.NavigationRoute[] | undefined | null;
         }
         interface NavigationSchema extends SpruceSchema.Schema {
@@ -4304,6 +4306,16 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
                         valueType: `HeartwoodTypes.NavigationItem`;
                     };
                 };
+                /** Set refresh permissions handler. The handler you pass here will be called when the navigation asks to refresh permissions. */
+                'setRefreshPermissionsHandler': {
+                    label: 'Set refresh permissions handler';
+                    type: 'raw';
+                    isRequired: true;
+                    hint: 'The handler you pass here will be called when the navigation asks to refresh permissions.';
+                    options: {
+                        valueType: `(cb: HeartwoodTypes.RefreshNavigationPermissionsHandler) => void`;
+                    };
+                };
                 /** . */
                 'additionalValidRoutes': {
                     type: 'schema';

package/build/esm/.spruce/schemas/heartwoodViewControllers/v2021_02_11/navigation.schema.js

@@ -34,6 +34,14 @@ const navigationSchema = {
             isArray: true,
             options: { valueType: `HeartwoodTypes.NavigationItem`, }
         },
+        /** Set refresh permissions handler. The handler you pass here will be called when the navigation asks to refresh permissions. */
+        'setRefreshPermissionsHandler': {
+            label: 'Set refresh permissions handler',
+            type: 'raw',
+            isRequired: true,
+            hint: 'The handler you pass here will be called when the navigation asks to refresh permissions.',
+            options: { valueType: `(cb: HeartwoodTypes.RefreshNavigationPermissionsHandler) => void`, }
+        },
         /** . */
         'additionalValidRoutes': {
             type: 'schema',

package/build/esm/.spruce/schemas/schemas.types.d.ts

@@ -4264,6 +4264,8 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
             /** Controller. */
             'controller'?: (HeartwoodTypes.ViewController<HeartwoodTypes.Navigation>) | undefined | null;
             'buttons'?: (HeartwoodTypes.NavigationItem)[] | undefined | null;
+            /** Set refresh permissions handler. The handler you pass here will be called when the navigation asks to refresh permissions. */
+            'setRefreshPermissionsHandler': ((cb: HeartwoodTypes.RefreshNavigationPermissionsHandler) => void);
             'additionalValidRoutes'?: SpruceSchemas.HeartwoodViewControllers.v2021_02_11.NavigationRoute[] | undefined | null;
         }
         interface NavigationSchema extends SpruceSchema.Schema {
@@ -4304,6 +4306,16 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
                         valueType: `HeartwoodTypes.NavigationItem`;
                     };
                 };
+                /** Set refresh permissions handler. The handler you pass here will be called when the navigation asks to refresh permissions. */
+                'setRefreshPermissionsHandler': {
+                    label: 'Set refresh permissions handler';
+                    type: 'raw';
+                    isRequired: true;
+                    hint: 'The handler you pass here will be called when the navigation asks to refresh permissions.';
+                    options: {
+                        valueType: `(cb: HeartwoodTypes.RefreshNavigationPermissionsHandler) => void`;
+                    };
+                };
                 /** . */
                 'additionalValidRoutes': {
                     type: 'schema';

package/build/esm/schemas/v2021_02_11/navigation.builder.d.ts

@@ -28,6 +28,15 @@ declare const _default: {
                 valueType: string;
             };
         };
+        setRefreshPermissionsHandler: {
+            type: "raw";
+            label: string;
+            hint: string;
+            isRequired: true;
+            options: {
+                valueType: string;
+            };
+        };
         additionalValidRoutes: {
             type: "schema";
             isArray: true;

package/build/esm/schemas/v2021_02_11/navigation.builder.js

@@ -35,6 +35,15 @@ export default buildSchema({
                 valueType: 'HeartwoodTypes.NavigationItem',
             },
         },
+        setRefreshPermissionsHandler: {
+            type: 'raw',
+            label: 'Set refresh permissions handler',
+            hint: 'The handler you pass here will be called when the navigation asks to refresh permissions.',
+            isRequired: true,
+            options: {
+                valueType: '(cb: HeartwoodTypes.RefreshNavigationPermissionsHandler) => void',
+            },
+        },
         additionalValidRoutes: {
             type: 'schema',
             isArray: true,

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

@@ -21,6 +21,8 @@ declare const navigationAssert: {
     hasAdditionalValidRoutes(vc: ViewController<Navigation>, routes: NavigationRoute[]): void;
     isHidden(vc: ViewController<Navigation>): void;
     isVisible(vc: ViewController<Navigation>): void;
+    assertActionDoesNotRefreshPermissions(vc: ViewController<Navigation>, action: () => Promise<void> | void): Promise<void>;
+    assertActionRefreshesPermissions(vc: ViewController<Navigation>, action: () => Promise<void> | void): Promise<void>;
 };
 export default navigationAssert;
 export declare function getButtonFromNav(vc: ViewController<Navigation>, id: string): any;

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

@@ -1,3 +1,12 @@
+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 { assertOptions } from '@sprucelabs/schema';
 import { assert } from '@sprucelabs/test-utils';
 import renderUtil from '../../utilities/render.utility.js';
@@ -86,6 +95,30 @@ const navigationAssert = {
         const isVisible = typeof model.isVisible === 'undefined' || model.isVisible;
         assert.isTruthy(isVisible, `Your navigation should be visible! Try calling 'this.navigationVc.show()'.`);
     },
+    assertActionDoesNotRefreshPermissions(vc, action) {
+        return __awaiter(this, void 0, void 0, function* () {
+            assertOptions({ vc, action }, ['vc', 'action']);
+            try {
+                yield this.assertActionRefreshesPermissions(vc, action);
+            }
+            catch (err) {
+                return;
+            }
+            assert.fail('I expected the action to not refresh permissions but it did! Make sure you are calling the "setRefreshPermissionsHandler" function in your navigation\'s view model and that you call the provided function to trigger a permissions refresh.');
+        });
+    },
+    assertActionRefreshesPermissions(vc, action) {
+        return __awaiter(this, void 0, void 0, function* () {
+            assertOptions({ vc, action }, ['vc', 'action']);
+            const model = renderUtil.render(vc);
+            let didRefresh = false;
+            model.setRefreshPermissionsHandler(() => {
+                didRefresh = true;
+            });
+            yield action();
+            assert.isTrue(didRefresh, `I expected the action to refresh permissions but it did not! Make sure you are calling the 'setRefreshPermissionsHandler' function in your navigation's view model and that you call the provided function to trigger a permissions refresh.`);
+        });
+    },
 };
 export default navigationAssert;
 export function getButtonFromNav(vc, id) {

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

@@ -30,7 +30,7 @@ import ListViewController, { ListViewControllerOptions } from '../viewController
 import ListRowViewController from '../viewControllers/list/ListRow.vc';
 import LoginCardViewController, { LoginCardViewControllerOptions } from '../viewControllers/LoginCard.vc';
 import MapViewController, { MapViewControllerOptions } from '../viewControllers/Map.vc';
-import NavigationViewController from '../viewControllers/navigation/Navigation.vc';
+import NavigationViewController, { NavigationViewControllerOptions } from '../viewControllers/navigation/Navigation.vc';
 import PagerViewController, { PagerViewControllerOptions } from '../viewControllers/pagers/Pager.vc';
 import PolarAreaViewController, { PolarAreaViewControllerOptions } from '../viewControllers/PolarAreaViewController.vc';
 import ProgressNavigatorViewController, { ProgressNavigatorViewControllerOptions } from '../viewControllers/progressNavigator/ProgressNavigator.vc';
@@ -403,7 +403,7 @@ export interface ViewControllerOptionsMap {
     form: FormViewControllerOptions<any>;
     list: ListViewControllerOptions;
     map: MapViewControllerOptions;
-    navigation: Navigation;
+    navigation: NavigationViewControllerOptions;
     pager: PagerViewControllerOptions;
     progress: ProgressViewControllerOptions;
     ratings: RatingsViewControllerOptions;
@@ -667,3 +667,4 @@ export interface AppControllerLoadOptions {
 export interface ChartViewController<ViewModel extends Record<string, any>> extends ViewController<ViewModel> {
     setDataSets(dataSets: ChartDataSet[]): void;
 }
+export type RefreshNavigationPermissionsHandler = () => void | Promise<void>;

package/build/esm/viewControllers/navigation/Navigation.vc.d.ts

@@ -2,11 +2,14 @@ import { Navigation, NavigationButton, NavigationItem, ViewControllerOptions } f
 import AbstractViewController from '../Abstract.vc';
 export default class NavigationViewController extends AbstractViewController<Navigation> {
     private model;
-    constructor(options: ViewControllerOptions);
+    private refreshPermissionsHandler?;
+    constructor(options: ViewControllerOptions & NavigationViewControllerOptions);
     hide(): void;
     show(): void;
     setButtons(buttons: NavigationButton[]): void;
     setShouldRenderButtonLabels(shouldRender: boolean): void;
     updateButton(id: string, updates: Partial<NavigationItem>): void;
+    refreshPermissions(): Promise<void>;
     render(): Navigation;
 }
+export type NavigationViewControllerOptions = Omit<Navigation, 'setRefreshPermissionsHandler'>;

package/build/esm/viewControllers/navigation/Navigation.vc.js

@@ -1,10 +1,21 @@
+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 SpruceError from '../../errors/SpruceError.js';
 import removeUniversalViewOptions from '../../utilities/removeUniversalViewOptions.js';
 import AbstractViewController from '../Abstract.vc.js';
 export default class NavigationViewController extends AbstractViewController {
     constructor(options) {
         super(options);
-        this.model = removeUniversalViewOptions(options);
+        this.model = Object.assign(Object.assign({}, removeUniversalViewOptions(options)), { setRefreshPermissionsHandler: (cb) => {
+                this.refreshPermissionsHandler = cb;
+            } });
     }
     hide() {
         this.model.isVisible = false;
@@ -37,6 +48,12 @@ export default class NavigationViewController extends AbstractViewController {
         buttons[idx] = button;
         this.triggerRender();
     }
+    refreshPermissions() {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            yield ((_a = this.refreshPermissionsHandler) === null || _a === void 0 ? void 0 : _a.call(this));
+        });
+    }
     render() {
         return Object.assign({ controller: this }, this.model);
     }

package/build/schemas/v2021_02_11/navigation.builder.d.ts

@@ -28,6 +28,15 @@ declare const _default: {
                 valueType: string;
             };
         };
+        setRefreshPermissionsHandler: {
+            type: "raw";
+            label: string;
+            hint: string;
+            isRequired: true;
+            options: {
+                valueType: string;
+            };
+        };
         additionalValidRoutes: {
             type: "schema";
             isArray: true;

package/build/schemas/v2021_02_11/navigation.builder.js

@@ -40,6 +40,15 @@ exports.default = (0, schema_1.buildSchema)({
                 valueType: 'HeartwoodTypes.NavigationItem',
             },
         },
+        setRefreshPermissionsHandler: {
+            type: 'raw',
+            label: 'Set refresh permissions handler',
+            hint: 'The handler you pass here will be called when the navigation asks to refresh permissions.',
+            isRequired: true,
+            options: {
+                valueType: '(cb: HeartwoodTypes.RefreshNavigationPermissionsHandler) => void',
+            },
+        },
         additionalValidRoutes: {
             type: 'schema',
             isArray: true,

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

@@ -21,6 +21,8 @@ declare const navigationAssert: {
     hasAdditionalValidRoutes(vc: ViewController<Navigation>, routes: NavigationRoute[]): void;
     isHidden(vc: ViewController<Navigation>): void;
     isVisible(vc: ViewController<Navigation>): void;
+    assertActionDoesNotRefreshPermissions(vc: ViewController<Navigation>, action: () => Promise<void> | void): Promise<void>;
+    assertActionRefreshesPermissions(vc: ViewController<Navigation>, action: () => Promise<void> | void): Promise<void>;
 };
 export default navigationAssert;
 export declare function getButtonFromNav(vc: ViewController<Navigation>, id: string): any;

package/build/tests/utilities/navigationAssert.js

@@ -86,6 +86,26 @@ const navigationAssert = {
         const isVisible = typeof model.isVisible === 'undefined' || model.isVisible;
         test_utils_1.assert.isTruthy(isVisible, `Your navigation should be visible! Try calling 'this.navigationVc.show()'.`);
     },
+    async assertActionDoesNotRefreshPermissions(vc, action) {
+        (0, schema_1.assertOptions)({ vc, action }, ['vc', 'action']);
+        try {
+            await this.assertActionRefreshesPermissions(vc, action);
+        }
+        catch (err) {
+            return;
+        }
+        test_utils_1.assert.fail('I expected the action to not refresh permissions but it did! Make sure you are calling the "setRefreshPermissionsHandler" function in your navigation\'s view model and that you call the provided function to trigger a permissions refresh.');
+    },
+    async assertActionRefreshesPermissions(vc, action) {
+        (0, schema_1.assertOptions)({ vc, action }, ['vc', 'action']);
+        const model = render_utility_1.default.render(vc);
+        let didRefresh = false;
+        model.setRefreshPermissionsHandler(() => {
+            didRefresh = true;
+        });
+        await action();
+        test_utils_1.assert.isTrue(didRefresh, `I expected the action to refresh permissions but it did not! Make sure you are calling the 'setRefreshPermissionsHandler' function in your navigation's view model and that you call the provided function to trigger a permissions refresh.`);
+    },
 };
 exports.default = navigationAssert;
 function getButtonFromNav(vc, id) {

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

@@ -30,7 +30,7 @@ import ListViewController, { ListViewControllerOptions } from '../viewController
 import ListRowViewController from '../viewControllers/list/ListRow.vc';
 import LoginCardViewController, { LoginCardViewControllerOptions } from '../viewControllers/LoginCard.vc';
 import MapViewController, { MapViewControllerOptions } from '../viewControllers/Map.vc';
-import NavigationViewController from '../viewControllers/navigation/Navigation.vc';
+import NavigationViewController, { NavigationViewControllerOptions } from '../viewControllers/navigation/Navigation.vc';
 import PagerViewController, { PagerViewControllerOptions } from '../viewControllers/pagers/Pager.vc';
 import PolarAreaViewController, { PolarAreaViewControllerOptions } from '../viewControllers/PolarAreaViewController.vc';
 import ProgressNavigatorViewController, { ProgressNavigatorViewControllerOptions } from '../viewControllers/progressNavigator/ProgressNavigator.vc';
@@ -403,7 +403,7 @@ export interface ViewControllerOptionsMap {
     form: FormViewControllerOptions<any>;
     list: ListViewControllerOptions;
     map: MapViewControllerOptions;
-    navigation: Navigation;
+    navigation: NavigationViewControllerOptions;
     pager: PagerViewControllerOptions;
     progress: ProgressViewControllerOptions;
     ratings: RatingsViewControllerOptions;
@@ -667,3 +667,4 @@ export interface AppControllerLoadOptions {
 export interface ChartViewController<ViewModel extends Record<string, any>> extends ViewController<ViewModel> {
     setDataSets(dataSets: ChartDataSet[]): void;
 }
+export type RefreshNavigationPermissionsHandler = () => void | Promise<void>;

package/build/viewControllers/navigation/Navigation.vc.d.ts

@@ -2,11 +2,14 @@ import { Navigation, NavigationButton, NavigationItem, ViewControllerOptions } f
 import AbstractViewController from '../Abstract.vc';
 export default class NavigationViewController extends AbstractViewController<Navigation> {
     private model;
-    constructor(options: ViewControllerOptions);
+    private refreshPermissionsHandler?;
+    constructor(options: ViewControllerOptions & NavigationViewControllerOptions);
     hide(): void;
     show(): void;
     setButtons(buttons: NavigationButton[]): void;
     setShouldRenderButtonLabels(shouldRender: boolean): void;
     updateButton(id: string, updates: Partial<NavigationItem>): void;
+    refreshPermissions(): Promise<void>;
     render(): Navigation;
 }
+export type NavigationViewControllerOptions = Omit<Navigation, 'setRefreshPermissionsHandler'>;

package/build/viewControllers/navigation/Navigation.vc.js

@@ -9,7 +9,12 @@ const Abstract_vc_1 = __importDefault(require("../Abstract.vc"));
 class NavigationViewController extends Abstract_vc_1.default {
     constructor(options) {
         super(options);
-        this.model = (0, removeUniversalViewOptions_1.default)(options);
+        this.model = {
+            ...(0, removeUniversalViewOptions_1.default)(options),
+            setRefreshPermissionsHandler: (cb) => {
+                this.refreshPermissionsHandler = cb;
+            },
+        };
     }
     hide() {
         this.model.isVisible = false;
@@ -44,6 +49,9 @@ class NavigationViewController extends Abstract_vc_1.default {
         buttons[idx] = button;
         this.triggerRender();
     }
+    async refreshPermissions() {
+        await this.refreshPermissionsHandler?.();
+    }
     render() {
         return { controller: this, ...this.model };
     }

package/package.json

@@ -24,7 +24,7 @@
   },
   "license": "MIT",
   "description": "All the power of Heartwood in one, convenient package.",
-  "version": "129.4.3",
+  "version": "129.5.0",
   "skill": {
     "namespace": "HeartwoodViewControllers",
     "commandOverrides": {