@sprucelabs/heartwood-view-controllers 111.1.51 → 111.1.52

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

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const schema_1 = require("@sprucelabs/schema");
 const navigationButton_schema_1 = __importDefault(require("./navigationButton.schema"));
+const navigationRoute_schema_1 = __importDefault(require("./navigationRoute.schema"));
 const navigationSchema = {
     id: 'navigation',
     version: 'v2021_02_11',
@@ -39,6 +40,13 @@ const navigationSchema = {
             isArray: true,
             options: { schema: navigationButton_schema_1.default, }
         },
+        /** . */
+        'additionalValidRoutes': {
+            type: 'schema',
+            isArray: true,
+            minArrayLength: 0,
+            options: { schema: navigationRoute_schema_1.default, }
+        },
     }
 };
 schema_1.SchemaRegistry.getInstance().trackSchema(navigationSchema);

package/build/.spruce/schemas/heartwoodViewControllers/v2021_02_11/navigationRoute.schema.d.ts

@@ -0,0 +1,3 @@
+import { SpruceSchemas } from '../../schemas.types';
+declare const navigationRouteSchema: SpruceSchemas.HeartwoodViewControllers.v2021_02_11.NavigationRouteSchema;
+export default navigationRouteSchema;

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

@@ -0,0 +1,30 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const schema_1 = require("@sprucelabs/schema");
+const permissionContractReference_schema_1 = __importDefault(require("./permissionContractReference.schema"));
+const routerDestination_schema_1 = __importDefault(require("./routerDestination.schema"));
+const navigationRouteSchema = {
+    id: 'navigationRoute',
+    version: 'v2021_02_11',
+    namespace: 'HeartwoodViewControllers',
+    name: '',
+    moduleToImportFromWhenRemote: '@sprucelabs/heartwood-view-controllers',
+    fields: {
+        /** . */
+        'viewPermissionContract': {
+            type: 'schema',
+            options: { schema: permissionContractReference_schema_1.default, }
+        },
+        /** . */
+        'destination': {
+            type: 'schema',
+            isRequired: true,
+            options: { schema: routerDestination_schema_1.default, }
+        },
+    }
+};
+schema_1.SchemaRegistry.getInstance().trackSchema(navigationRouteSchema);
+exports.default = navigationRouteSchema;

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

@@ -2930,6 +2930,38 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
         interface PermissionContractReferenceEntity extends SchemaEntity<SpruceSchemas.HeartwoodViewControllers.v2021_02_11.PermissionContractReferenceSchema> {
         }
     }
+    namespace SpruceSchemas.HeartwoodViewControllers.v2021_02_11 {
+        interface NavigationRoute {
+            'viewPermissionContract'?: SpruceSchemas.HeartwoodViewControllers.v2021_02_11.PermissionContractReference | undefined | null;
+            'destination': SpruceSchemas.HeartwoodViewControllers.v2021_02_11.RouterDestination;
+        }
+        interface NavigationRouteSchema extends SpruceSchema.Schema {
+            id: 'navigationRoute';
+            version: 'v2021_02_11';
+            namespace: 'HeartwoodViewControllers';
+            name: '';
+            moduleToImportFromWhenRemote: '@sprucelabs/heartwood-view-controllers';
+            fields: {
+                /** . */
+                'viewPermissionContract': {
+                    type: 'schema';
+                    options: {
+                        schema: SpruceSchemas.HeartwoodViewControllers.v2021_02_11.PermissionContractReferenceSchema;
+                    };
+                };
+                /** . */
+                'destination': {
+                    type: 'schema';
+                    isRequired: true;
+                    options: {
+                        schema: SpruceSchemas.HeartwoodViewControllers.v2021_02_11.RouterDestinationSchema;
+                    };
+                };
+            };
+        }
+        interface NavigationRouteEntity extends SchemaEntity<SpruceSchemas.HeartwoodViewControllers.v2021_02_11.NavigationRouteSchema> {
+        }
+    }
     namespace SpruceSchemas.HeartwoodViewControllers.v2021_02_11 {
         interface NavigationButton {
             /** Line icon. */
@@ -3438,6 +3470,7 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
             /** Controller. */
             'controller'?: (HeartwoodTypes.ViewController<HeartwoodTypes.Navigation>) | undefined | null;
             'buttons'?: SpruceSchemas.HeartwoodViewControllers.v2021_02_11.NavigationButton[] | undefined | null;
+            'additionalValidRoutes'?: SpruceSchemas.HeartwoodViewControllers.v2021_02_11.NavigationRoute[] | undefined | null;
         }
         interface NavigationSchema extends SpruceSchema.Schema {
             id: 'navigation';
@@ -3477,6 +3510,15 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
                         schema: SpruceSchemas.HeartwoodViewControllers.v2021_02_11.NavigationButtonSchema;
                     };
                 };
+                /** . */
+                'additionalValidRoutes': {
+                    type: 'schema';
+                    isArray: true;
+                    minArrayLength: 0;
+                    options: {
+                        schema: SpruceSchemas.HeartwoodViewControllers.v2021_02_11.NavigationRouteSchema;
+                    };
+                };
             };
         }
         interface NavigationEntity extends SchemaEntity<SpruceSchemas.HeartwoodViewControllers.v2021_02_11.NavigationSchema> {

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

@@ -1,5 +1,6 @@
 import { SchemaRegistry } from '@sprucelabs/schema';
 import navigationButtonSchema_v2021_02_11 from './navigationButton.schema.js';
+import navigationRouteSchema_v2021_02_11 from './navigationRoute.schema.js';
 const navigationSchema = {
     id: 'navigation',
     version: 'v2021_02_11',
@@ -34,6 +35,13 @@ const navigationSchema = {
             isArray: true,
             options: { schema: navigationButtonSchema_v2021_02_11, }
         },
+        /** . */
+        'additionalValidRoutes': {
+            type: 'schema',
+            isArray: true,
+            minArrayLength: 0,
+            options: { schema: navigationRouteSchema_v2021_02_11, }
+        },
     }
 };
 SchemaRegistry.getInstance().trackSchema(navigationSchema);

package/build/esm/.spruce/schemas/heartwoodViewControllers/v2021_02_11/navigationRoute.schema.d.ts

@@ -0,0 +1,3 @@
+import { SpruceSchemas } from '../../schemas.types';
+declare const navigationRouteSchema: SpruceSchemas.HeartwoodViewControllers.v2021_02_11.NavigationRouteSchema;
+export default navigationRouteSchema;

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

@@ -0,0 +1,25 @@
+import { SchemaRegistry } from '@sprucelabs/schema';
+import permissionContractReferenceSchema_v2021_02_11 from './permissionContractReference.schema.js';
+import routerDestinationSchema_v2021_02_11 from './routerDestination.schema.js';
+const navigationRouteSchema = {
+    id: 'navigationRoute',
+    version: 'v2021_02_11',
+    namespace: 'HeartwoodViewControllers',
+    name: '',
+    moduleToImportFromWhenRemote: '@sprucelabs/heartwood-view-controllers',
+    fields: {
+        /** . */
+        'viewPermissionContract': {
+            type: 'schema',
+            options: { schema: permissionContractReferenceSchema_v2021_02_11, }
+        },
+        /** . */
+        'destination': {
+            type: 'schema',
+            isRequired: true,
+            options: { schema: routerDestinationSchema_v2021_02_11, }
+        },
+    }
+};
+SchemaRegistry.getInstance().trackSchema(navigationRouteSchema);
+export default navigationRouteSchema;

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

@@ -2930,6 +2930,38 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
         interface PermissionContractReferenceEntity extends SchemaEntity<SpruceSchemas.HeartwoodViewControllers.v2021_02_11.PermissionContractReferenceSchema> {
         }
     }
+    namespace SpruceSchemas.HeartwoodViewControllers.v2021_02_11 {
+        interface NavigationRoute {
+            'viewPermissionContract'?: SpruceSchemas.HeartwoodViewControllers.v2021_02_11.PermissionContractReference | undefined | null;
+            'destination': SpruceSchemas.HeartwoodViewControllers.v2021_02_11.RouterDestination;
+        }
+        interface NavigationRouteSchema extends SpruceSchema.Schema {
+            id: 'navigationRoute';
+            version: 'v2021_02_11';
+            namespace: 'HeartwoodViewControllers';
+            name: '';
+            moduleToImportFromWhenRemote: '@sprucelabs/heartwood-view-controllers';
+            fields: {
+                /** . */
+                'viewPermissionContract': {
+                    type: 'schema';
+                    options: {
+                        schema: SpruceSchemas.HeartwoodViewControllers.v2021_02_11.PermissionContractReferenceSchema;
+                    };
+                };
+                /** . */
+                'destination': {
+                    type: 'schema';
+                    isRequired: true;
+                    options: {
+                        schema: SpruceSchemas.HeartwoodViewControllers.v2021_02_11.RouterDestinationSchema;
+                    };
+                };
+            };
+        }
+        interface NavigationRouteEntity extends SchemaEntity<SpruceSchemas.HeartwoodViewControllers.v2021_02_11.NavigationRouteSchema> {
+        }
+    }
     namespace SpruceSchemas.HeartwoodViewControllers.v2021_02_11 {
         interface NavigationButton {
             /** Line icon. */
@@ -3438,6 +3470,7 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
             /** Controller. */
             'controller'?: (HeartwoodTypes.ViewController<HeartwoodTypes.Navigation>) | undefined | null;
             'buttons'?: SpruceSchemas.HeartwoodViewControllers.v2021_02_11.NavigationButton[] | undefined | null;
+            'additionalValidRoutes'?: SpruceSchemas.HeartwoodViewControllers.v2021_02_11.NavigationRoute[] | undefined | null;
         }
         interface NavigationSchema extends SpruceSchema.Schema {
             id: 'navigation';
@@ -3477,6 +3510,15 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
                         schema: SpruceSchemas.HeartwoodViewControllers.v2021_02_11.NavigationButtonSchema;
                     };
                 };
+                /** . */
+                'additionalValidRoutes': {
+                    type: 'schema';
+                    isArray: true;
+                    minArrayLength: 0;
+                    options: {
+                        schema: SpruceSchemas.HeartwoodViewControllers.v2021_02_11.NavigationRouteSchema;
+                    };
+                };
             };
         }
         interface NavigationEntity extends SchemaEntity<SpruceSchemas.HeartwoodViewControllers.v2021_02_11.NavigationSchema> {

package/build/esm/index.d.ts

@@ -195,4 +195,5 @@ export { default as barChartDataSetSchema } from './.spruce/schemas/heartwoodVie
 export { default as navigationButtonDropdownSchema } from './.spruce/schemas/heartwoodViewControllers/v2021_02_11/navigationButtonDropdown.schema';
 export { default as navigationDropdownButtonSchema } from './.spruce/schemas/heartwoodViewControllers/v2021_02_11/navigationDropdownButton.schema';
 export { default as routerDestinationSchema } from './.spruce/schemas/heartwoodViewControllers/v2021_02_11/routerDestination.schema';
+export { default as navigationRouteSchema } from './.spruce/schemas/heartwoodViewControllers/v2021_02_11/navigationRoute.schema';
 export * from './toolBelts/ToolBeltStateMachine';

package/build/esm/index.js

@@ -194,4 +194,5 @@ export { default as barChartDataSetSchema } from './.spruce/schemas/heartwoodVie
 export { default as navigationButtonDropdownSchema } from './.spruce/schemas/heartwoodViewControllers/v2021_02_11/navigationButtonDropdown.schema.js';
 export { default as navigationDropdownButtonSchema } from './.spruce/schemas/heartwoodViewControllers/v2021_02_11/navigationDropdownButton.schema.js';
 export { default as routerDestinationSchema } from './.spruce/schemas/heartwoodViewControllers/v2021_02_11/routerDestination.schema.js';
+export { default as navigationRouteSchema } from './.spruce/schemas/heartwoodViewControllers/v2021_02_11/navigationRoute.schema.js';
 export * from './toolBelts/ToolBeltStateMachine.js';

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

@@ -563,6 +563,60 @@ declare const _default: {
                 };
             };
         };
+        additionalValidRoutes: {
+            type: "schema";
+            isArray: true;
+            minArrayLength: number;
+            options: {
+                schema: {
+                    id: string;
+                    fields: {
+                        viewPermissionContract: {
+                            type: "schema";
+                            options: {
+                                schema: {
+                                    id: string;
+                                    name: string;
+                                    fields: {
+                                        id: {
+                                            type: "raw";
+                                            options: {
+                                                valueType: string;
+                                            };
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                        destination: {
+                            type: "schema";
+                            isRequired: true;
+                            options: {
+                                schema: {
+                                    id: string;
+                                    name: string;
+                                    fields: {
+                                        id: {
+                                            type: "raw";
+                                            isRequired: true;
+                                            options: {
+                                                valueType: string;
+                                            };
+                                        };
+                                        args: {
+                                            type: "raw";
+                                            options: {
+                                                valueType: string;
+                                            };
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
     };
 };
 export default _default;

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

@@ -1,5 +1,7 @@
 import { buildSchema } from '@sprucelabs/schema';
 import navigationButtonBuilder from './navigationButton.builder.js';
+import permissionContractReferenceBuilder from './permissionContractReference.builder.js';
+import routerDestinationBuilder from './routerDestination.builder.js';
 export default buildSchema({
     id: 'navigation',
     name: 'Navigation',
@@ -34,5 +36,30 @@ export default buildSchema({
                 schema: navigationButtonBuilder,
             },
         },
+        additionalValidRoutes: {
+            type: 'schema',
+            isArray: true,
+            minArrayLength: 0,
+            options: {
+                schema: buildSchema({
+                    id: 'navigationRoute',
+                    fields: {
+                        viewPermissionContract: {
+                            type: 'schema',
+                            options: {
+                                schema: permissionContractReferenceBuilder,
+                            },
+                        },
+                        destination: {
+                            type: 'schema',
+                            isRequired: true,
+                            options: {
+                                schema: routerDestinationBuilder,
+                            },
+                        },
+                    },
+                }),
+            },
+        },
     },
 });

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

@@ -1,5 +1,5 @@
 import { PermissionContractId } from '@sprucelabs/mercury-types';
-import { AppController, Navigation, SkillViewController, SkillViewControllerId, ViewController } from '../../types/heartwood.types';
+import { AppController, Navigation, NavigationRoute, SkillViewController, SkillViewControllerId, ViewController } from '../../types/heartwood.types';
 declare const navigationAssert: {
     rendersButton(vc: ViewController<Navigation>, id: string): void;
     buttonRedirectsTo(options: {
@@ -17,5 +17,6 @@ declare const navigationAssert: {
     appDoesNotRenderNavigation(vc: Pick<AppController, "renderNavigation">): void;
     skillViewDoesNotRenderNavigation(vc: Pick<SkillViewController, "renderNavigation">): void;
     buttonRequiresViewPermissions(vc: ViewController<Navigation>, button: string, permissionContractId: PermissionContractId): void;
+    hasAdditionalValidRoutes(vc: ViewController<Navigation>, routes: NavigationRoute[]): void;
 };
 export default navigationAssert;

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

@@ -16,6 +16,7 @@ const navigationAssert = {
         }
     },
     rendersButtons(vc, ids) {
+        assertOptions({ vc, buttons: ids }, ['vc', 'buttons']);
         ids.forEach((id) => this.rendersButton(vc, id));
     },
     rendersButtonLabels(vc) {
@@ -51,11 +52,28 @@ const navigationAssert = {
         const match = getButtonFromNav(vc, button);
         assert.isEqual((_a = match.viewPermissionContract) === null || _a === void 0 ? void 0 : _a.id, permissionContractId, 'Your button did not have the view permission contract set to what I expected!');
     },
+    hasAdditionalValidRoutes(vc, routes) {
+        assertOptions({ vc, routes }, ['vc', 'routes']);
+        const model = renderUtil.render(vc);
+        assert.isEqualDeep(model.additionalValidRoutes, routes, `I did not find the valid routes I expected. Make sure you set 'additionalValidRoutes' in your navigation's view model (constructor options).`);
+    },
 };
 export default navigationAssert;
 function getButtonFromNav(vc, id) {
+    var _a, _b, _c, _d;
     const model = renderUtil.render(vc);
-    const buttons = model.buttons;
+    if ((_a = model.buttons) === null || _a === void 0 ? void 0 : _a[0].dropdown) {
+        const button = (_c = (_b = model.buttons[0].dropdown) === null || _b === void 0 ? void 0 : _b.items) === null || _c === void 0 ? void 0 : _c.find((b) => b.id === id);
+        assert.isTruthy(button);
+        return;
+    }
+    const buttons = (_d = model.buttons) === null || _d === void 0 ? void 0 : _d.reduce((acc, b) => {
+        var _a, _b;
+        if (b.dropdown) {
+            return [...acc, ...((_b = (_a = b === null || b === void 0 ? void 0 : b.dropdown) === null || _a === void 0 ? void 0 : _a.items) !== null && _b !== void 0 ? _b : [])];
+        }
+        return [...acc, b];
+    }, []);
     const button = buttons === null || buttons === void 0 ? void 0 : buttons.find((b) => b.id === id);
     assert.isTruthy(button, `I could not find a button with the id "${id}" in your navigation!`);
     return button;

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

@@ -169,6 +169,7 @@ export type BarChart = SpruceSchemas.HeartwoodViewControllers.v2021_02_11.BarCha
 export type BarChartDataSet = SpruceSchemas.HeartwoodViewControllers.v2021_02_11.BarChartDataSet;
 export type BarChartDataPoint = SpruceSchemas.HeartwoodViewControllers.v2021_02_11.BarChartDataPoint;
 export type Form<S extends Schema = any> = SpruceSchemas.HeartwoodViewControllers.v2021_02_11.Form<S>;
+export type NavigationRoute = SpruceSchemas.HeartwoodViewControllers.v2021_02_11.NavigationRoute;
 export type LayoutStyle = NonNullable<SpruceSchemas.HeartwoodViewControllers.v2021_02_11.SkillView['layout']>;
 export type ListColumnWidth = NonNullable<List['columnWidths']>[number];
 export type TriggerRender = () => void;

package/build/index.d.ts

@@ -195,4 +195,5 @@ export { default as barChartDataSetSchema } from './.spruce/schemas/heartwoodVie
 export { default as navigationButtonDropdownSchema } from './.spruce/schemas/heartwoodViewControllers/v2021_02_11/navigationButtonDropdown.schema';
 export { default as navigationDropdownButtonSchema } from './.spruce/schemas/heartwoodViewControllers/v2021_02_11/navigationDropdownButton.schema';
 export { default as routerDestinationSchema } from './.spruce/schemas/heartwoodViewControllers/v2021_02_11/routerDestination.schema';
+export { default as navigationRouteSchema } from './.spruce/schemas/heartwoodViewControllers/v2021_02_11/navigationRoute.schema';
 export * from './toolBelts/ToolBeltStateMachine';

package/build/index.js

@@ -20,7 +20,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.dialogSchema = exports.buttonSchema = exports.lineIconSchema = exports.fancyIconSchema = exports.selectInputSchema = exports.skillViewSchema = exports.bigFormSchema = exports.calendarEventColorsSchema = exports.buildSkillView = exports.buildForm = exports.buildBigForm = exports.AuthenticatorImpl = exports.PolarAreaViewController = exports.MockActiveRecordCard = exports.activeRecordCardAssert = exports.buildActiveRecordList = exports.buildActiveRecordCard = exports.AbstractInputViewController = exports.AutocompleteInputViewController = exports.AbstractCalendarEventViewController = exports.RatingsViewController = exports.ProgressViewController = exports.StatsViewController = exports.FeedViewController = exports.ActiveRecordListViewController = exports.ActiveRecordCardViewController = exports.TalkingSprucebotViewController = exports.ButtonBarViewController = exports.CalendarViewController = exports.SwipeCardViewControllerImpl = exports.SwipeViewControllerImpl = exports.PagerViewController = exports.ProgressNavigatorViewController = exports.CountdownTimerViewController = exports.FormBuilderCardViewControllerImpl = exports.LoginViewController = exports.BarChartViewController = exports.ToolBeltViewController = exports.FormViewControllerImpl = exports.ListCellViewController = exports.ListRowViewController = exports.ListViewController = exports.NavigationViewController = exports.DialogViewController = exports.ConfirmViewController = exports.CardViewControllerImpl = exports.ButtonGroupViewController = exports.AbstractAppController = exports.AbstractViewController = exports.AbstractSkillViewController = void 0;
 exports.ratingsInputSchema = exports.listRatingsInputSchema = exports.ratingsSchema = exports.progressSchema = exports.statsStatSchema = exports.statsSchema = exports.toggleInputSchema = exports.listToggleInputSchema = exports.addressInputSchema = exports.buttonBarButtonSchema = exports.buttonBarSchema = exports.toolBeltToolSchema = exports.toolBeltSchema = exports.calendarTimeSchema = exports.calendarPersonSchema = exports.calendarSchema = exports.themePropsSchema = exports.themeSchema = exports.cardFooterButtonSchema = exports.criticalErrorSchema = exports.sprucebotTypedMessageSentenceSchema = exports.sprucebotTypedMessageAvatarSchema = exports.selectInputChoiceSchema = exports.calendarEventColorOverrideSchema = exports.portalSchema = exports.listTextInputSchema = exports.listSelectInputSchema = exports.listCellButtonSchema = exports.dropdownButtonSchema = exports.bigFormSectionSchema = exports.textInputSchema = exports.phoneInputSchema = exports.inputSchema = exports.dropdownSchema = exports.sprucebotTypedMessageSchema = exports.talkingSprucebotSchema = exports.sprucebotAvatarSchema = exports.formBuilderImportExportObjectSchema = exports.listCellSchema = exports.listRowSchema = exports.listSchema = exports.layoutSchema = exports.cardSectionSchema = exports.cardHeaderSchema = exports.cardFooterSchema = exports.cardBodySchema = exports.cardSchema = exports.formSectionSchema = exports.formSchema = exports.textSchema = void 0;
 exports.barChartAssert = exports.progressNavigatorAssert = exports.countdownTimerInteractor = exports.countdownTimerAssert = exports.calendarInteractor = exports.interactor = exports.normalizeScopeFromVc = exports.autocompleteInteractor = exports.formAssert = exports.autocompleteAssert = exports.listAssert = exports.buttonAssert = exports.deviceAssert = exports.navigationAssert = exports.toolBeltAssert = exports.toastAssert = exports.vcPluginAssert = exports.vcDurationAssert = exports.pagerAssert = exports.vcAssert = exports.vcAssertUtil = exports.feedAssert = exports.feedInteractor = exports.normalizeFormSectionFieldNamesUtil = exports.ViewControllerError = exports.SpyDevice = exports.StubStorage = exports.ViewControllerFactory = exports.ViewControllerImporter = exports.ViewControllerExporter = exports.pagerSchema = exports.polarAreaDataItemSchema = exports.polarAreaSchema = exports.inputButtonSchema = exports.mapPinSchema = exports.mapSchema = exports.latLngSchema = exports.formBuilderImportExportPageSchema = exports.autocompleteSuggestionSchema = exports.autocompleteInputSchema = exports.feedSchema = exports.calendarShiftSchema = exports.receiptTotalSchema = exports.receiptSectionSchema = exports.receiptLineItemSchema = exports.receiptHeaderSchema = exports.receiptSchema = exports.listDateInputSchema = exports.calendarSelectedDateSchema = exports.calendarEventSchema = void 0;
-exports.routerDestinationSchema = exports.navigationDropdownButtonSchema = exports.navigationButtonDropdownSchema = exports.barChartDataSetSchema = exports.barChartDataPointSchema = exports.barChartSchema = exports.progressDetailsSchema = exports.progressNavigatorStepSchema = exports.progressNavigatorSchema = exports.countdownTimerSchema = exports.permissionContractReferenceSchema = exports.navigationButtonSchema = exports.navigationSchema = exports.ToolBeltStateMachine = exports.removeUniversalViewOptions = exports.buildSkillViewLayout = exports.splitCardsIntoLayouts = exports.listUtil = exports.mapInteractor = exports.mapAssert = exports.renderUtil = exports.routerTestPatcher = exports.dialogTestPatcher = exports.confirmTestPatcher = exports.calendarSeeder = exports.interactionUtil = void 0;
+exports.navigationRouteSchema = exports.routerDestinationSchema = exports.navigationDropdownButtonSchema = exports.navigationButtonDropdownSchema = exports.barChartDataSetSchema = exports.barChartDataPointSchema = exports.barChartSchema = exports.progressDetailsSchema = exports.progressNavigatorStepSchema = exports.progressNavigatorSchema = exports.countdownTimerSchema = exports.permissionContractReferenceSchema = exports.navigationButtonSchema = exports.navigationSchema = exports.ToolBeltStateMachine = exports.removeUniversalViewOptions = exports.buildSkillViewLayout = exports.splitCardsIntoLayouts = exports.listUtil = exports.mapInteractor = exports.mapAssert = exports.renderUtil = exports.routerTestPatcher = exports.dialogTestPatcher = exports.confirmTestPatcher = exports.calendarSeeder = exports.interactionUtil = void 0;
 __exportStar(require("./constants"), exports);
 __exportStar(require("./types/heartwood.types"), exports);
 __exportStar(require("./utilities/removeUniversalViewOptions"), exports);
@@ -393,4 +393,6 @@ var navigationDropdownButton_schema_1 = require("./.spruce/schemas/heartwoodView
 Object.defineProperty(exports, "navigationDropdownButtonSchema", { enumerable: true, get: function () { return __importDefault(navigationDropdownButton_schema_1).default; } });
 var routerDestination_schema_1 = require("./.spruce/schemas/heartwoodViewControllers/v2021_02_11/routerDestination.schema");
 Object.defineProperty(exports, "routerDestinationSchema", { enumerable: true, get: function () { return __importDefault(routerDestination_schema_1).default; } });
+var navigationRoute_schema_1 = require("./.spruce/schemas/heartwoodViewControllers/v2021_02_11/navigationRoute.schema");
+Object.defineProperty(exports, "navigationRouteSchema", { enumerable: true, get: function () { return __importDefault(navigationRoute_schema_1).default; } });
 __exportStar(require("./toolBelts/ToolBeltStateMachine"), exports);

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

@@ -563,6 +563,60 @@ declare const _default: {
                 };
             };
         };
+        additionalValidRoutes: {
+            type: "schema";
+            isArray: true;
+            minArrayLength: number;
+            options: {
+                schema: {
+                    id: string;
+                    fields: {
+                        viewPermissionContract: {
+                            type: "schema";
+                            options: {
+                                schema: {
+                                    id: string;
+                                    name: string;
+                                    fields: {
+                                        id: {
+                                            type: "raw";
+                                            options: {
+                                                valueType: string;
+                                            };
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                        destination: {
+                            type: "schema";
+                            isRequired: true;
+                            options: {
+                                schema: {
+                                    id: string;
+                                    name: string;
+                                    fields: {
+                                        id: {
+                                            type: "raw";
+                                            isRequired: true;
+                                            options: {
+                                                valueType: string;
+                                            };
+                                        };
+                                        args: {
+                                            type: "raw";
+                                            options: {
+                                                valueType: string;
+                                            };
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
     };
 };
 export default _default;

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

@@ -5,6 +5,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const schema_1 = require("@sprucelabs/schema");
 const navigationButton_builder_1 = __importDefault(require("./navigationButton.builder"));
+const permissionContractReference_builder_1 = __importDefault(require("./permissionContractReference.builder"));
+const routerDestination_builder_1 = __importDefault(require("./routerDestination.builder"));
 exports.default = (0, schema_1.buildSchema)({
     id: 'navigation',
     name: 'Navigation',
@@ -39,5 +41,30 @@ exports.default = (0, schema_1.buildSchema)({
                 schema: navigationButton_builder_1.default,
             },
         },
+        additionalValidRoutes: {
+            type: 'schema',
+            isArray: true,
+            minArrayLength: 0,
+            options: {
+                schema: (0, schema_1.buildSchema)({
+                    id: 'navigationRoute',
+                    fields: {
+                        viewPermissionContract: {
+                            type: 'schema',
+                            options: {
+                                schema: permissionContractReference_builder_1.default,
+                            },
+                        },
+                        destination: {
+                            type: 'schema',
+                            isRequired: true,
+                            options: {
+                                schema: routerDestination_builder_1.default,
+                            },
+                        },
+                    },
+                }),
+            },
+        },
     },
 });

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

@@ -1,5 +1,5 @@
 import { PermissionContractId } from '@sprucelabs/mercury-types';
-import { AppController, Navigation, SkillViewController, SkillViewControllerId, ViewController } from '../../types/heartwood.types';
+import { AppController, Navigation, NavigationRoute, SkillViewController, SkillViewControllerId, ViewController } from '../../types/heartwood.types';
 declare const navigationAssert: {
     rendersButton(vc: ViewController<Navigation>, id: string): void;
     buttonRedirectsTo(options: {
@@ -17,5 +17,6 @@ declare const navigationAssert: {
     appDoesNotRenderNavigation(vc: Pick<AppController, "renderNavigation">): void;
     skillViewDoesNotRenderNavigation(vc: Pick<SkillViewController, "renderNavigation">): void;
     buttonRequiresViewPermissions(vc: ViewController<Navigation>, button: string, permissionContractId: PermissionContractId): void;
+    hasAdditionalValidRoutes(vc: ViewController<Navigation>, routes: NavigationRoute[]): void;
 };
 export default navigationAssert;

package/build/tests/utilities/navigationAssert.js

@@ -20,6 +20,7 @@ const navigationAssert = {
         }
     },
     rendersButtons(vc, ids) {
+        (0, schema_1.assertOptions)({ vc, buttons: ids }, ['vc', 'buttons']);
         ids.forEach((id) => this.rendersButton(vc, id));
     },
     rendersButtonLabels(vc) {
@@ -52,11 +53,26 @@ const navigationAssert = {
         const match = getButtonFromNav(vc, button);
         test_utils_1.assert.isEqual(match.viewPermissionContract?.id, permissionContractId, 'Your button did not have the view permission contract set to what I expected!');
     },
+    hasAdditionalValidRoutes(vc, routes) {
+        (0, schema_1.assertOptions)({ vc, routes }, ['vc', 'routes']);
+        const model = render_utility_1.default.render(vc);
+        test_utils_1.assert.isEqualDeep(model.additionalValidRoutes, routes, `I did not find the valid routes I expected. Make sure you set 'additionalValidRoutes' in your navigation's view model (constructor options).`);
+    },
 };
 exports.default = navigationAssert;
 function getButtonFromNav(vc, id) {
     const model = render_utility_1.default.render(vc);
-    const buttons = model.buttons;
+    if (model.buttons?.[0].dropdown) {
+        const button = model.buttons[0].dropdown?.items?.find((b) => b.id === id);
+        test_utils_1.assert.isTruthy(button);
+        return;
+    }
+    const buttons = model.buttons?.reduce((acc, b) => {
+        if (b.dropdown) {
+            return [...acc, ...(b?.dropdown?.items ?? [])];
+        }
+        return [...acc, b];
+    }, []);
     const button = buttons?.find((b) => b.id === id);
     test_utils_1.assert.isTruthy(button, `I could not find a button with the id "${id}" in your navigation!`);
     return button;

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

@@ -169,6 +169,7 @@ export type BarChart = SpruceSchemas.HeartwoodViewControllers.v2021_02_11.BarCha
 export type BarChartDataSet = SpruceSchemas.HeartwoodViewControllers.v2021_02_11.BarChartDataSet;
 export type BarChartDataPoint = SpruceSchemas.HeartwoodViewControllers.v2021_02_11.BarChartDataPoint;
 export type Form<S extends Schema = any> = SpruceSchemas.HeartwoodViewControllers.v2021_02_11.Form<S>;
+export type NavigationRoute = SpruceSchemas.HeartwoodViewControllers.v2021_02_11.NavigationRoute;
 export type LayoutStyle = NonNullable<SpruceSchemas.HeartwoodViewControllers.v2021_02_11.SkillView['layout']>;
 export type ListColumnWidth = NonNullable<List['columnWidths']>[number];
 export type TriggerRender = () => void;

package/package.json

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