Add Types [ci skip]

brooketopcoder · brooketopcoder · commit b973e425280e · 2022-12-20T21:23:13.000Z
diff --git a/types/src/lib/app-context/app-context.functions.d.ts b/types/src/lib/app-context/app-context.functions.d.ts
@@ -13,6 +13,7 @@ export declare const buildContext: (newConfig: Partial<NavigationAppProps>, prev
     toolConfig: {
         name: any;
         root: any;
+        fullFooter: any;
     };
     supportMeta: any;
 };
diff --git a/types/src/lib/app-context/tool-config.model.d.ts b/types/src/lib/app-context/tool-config.model.d.ts
@@ -1,4 +1,5 @@
 export interface ToolConfig {
     name: string;
     root: string;
+    fullFooter?: boolean;
 }
diff --git a/types/src/lib/config/nav-menu/footer-nav-items.d.ts b/types/src/lib/config/nav-menu/footer-nav-items.d.ts
@@ -13,5 +13,7 @@ export declare const footerNavItems: {
         icon?: string;
         action?: string;
         url?: string;
+        authenticatedPath?: string;
+        groupOrder?: number;
     }[];
 };
diff --git a/types/src/lib/config/nav-menu/marketing-nav-items.d.ts b/types/src/lib/config/nav-menu/marketing-nav-items.d.ts
@@ -11,6 +11,8 @@ export declare const marketingNavItems: {
                 icon?: string;
                 action?: string;
                 url?: string;
+                authenticatedPath?: string;
+                groupOrder?: number;
             })[];
             description?: string;
             host?: string;
@@ -20,6 +22,8 @@ export declare const marketingNavItems: {
             icon?: string;
             action?: string;
             url?: string;
+            authenticatedPath?: string;
+            groupOrder?: number;
         })[];
         description?: string;
         host?: string;
@@ -29,5 +33,7 @@ export declare const marketingNavItems: {
         icon?: string;
         action?: string;
         url?: string;
+        authenticatedPath?: string;
+        groupOrder?: number;
     }[];
 };
diff --git a/types/src/lib/config/nav-menu/tool-selector-nav-items.d.ts b/types/src/lib/config/nav-menu/tool-selector-nav-items.d.ts
@@ -1,5 +1,5 @@
 export declare const toolSelectorNavItems: {
-    children: {
+    children: ({
         label: string;
         children: ({
             label: string;
@@ -17,5 +17,17 @@ export declare const toolSelectorNavItems: {
                 type: string;
             }[];
         })[];
-    }[];
+    } | {
+        label: string;
+        children: {
+            label: string;
+            groupOrder: number;
+            children: {
+                label: string;
+                url: string;
+                icon: string;
+                description: string;
+            }[];
+        }[];
+    })[];
 };
diff --git a/types/src/lib/functions/footer-navigation.provider.d.ts b/types/src/lib/functions/footer-navigation.provider.d.ts
@@ -1,2 +1,2 @@
 import type { NavMenuItem } from './nav-menu-item.model';
-export declare function getFooterNavItems(): NavMenuItem[];
+export declare function getFooterNavItems(isAuthenticated: boolean): NavMenuItem[];
diff --git a/types/src/lib/functions/marketing-navigation.provider.d.ts b/types/src/lib/functions/marketing-navigation.provider.d.ts
@@ -1,3 +1,3 @@
 import type { NavMenuItem } from './nav-menu-item.model';
-export declare function getMainNavItems(): NavMenuItem[];
-export declare function getActiveRoute(index?: number): NavMenuItem[];
+export declare function getMainNavItems(isAuthenticated: boolean): NavMenuItem[];
+export declare function getActiveRoute(navItems: NavMenuItem[], index?: number): NavMenuItem[];
diff --git a/types/src/lib/functions/nav-menu-item.model.d.ts b/types/src/lib/functions/nav-menu-item.model.d.ts
@@ -8,4 +8,6 @@ export interface NavMenuItem {
     icon?: string;
     action?: string;
     url?: string;
+    authenticatedPath?: string;
+    groupOrder?: number;
 }
diff --git a/types/src/lib/functions/tool-navigation.provider.d.ts b/types/src/lib/functions/tool-navigation.provider.d.ts
@@ -1,2 +1,2 @@
 import type { NavMenuItem } from './nav-menu-item.model';
-export declare function getMainNavItems(): NavMenuItem[];
+export declare function getMainNavItems(isAuthenticated: boolean): NavMenuItem[];
diff --git a/types/src/lib/utils/routes.d.ts b/types/src/lib/utils/routes.d.ts
@@ -1,4 +1,14 @@
 import type { NavMenuItem } from 'lib/functions/nav-menu-item.model';
+/**
+ * Parses the passed nav menu items and
+ * based on the `isAuthenticated` param
+ * activates the `authenticatedPath` for a nav menu item
+ * @param isAuthenticated
+ * @param navigationItem
+ * @param depth
+ * @returns NavMenuItem.children
+ */
+export declare const activateAuthenticatedRoutes: (isAuthenticated: boolean, { children }: NavMenuItem, depth?: number) => NavMenuItem[];
 /**
  * Matches the current route to a navigation menu item
  *  and returns the full trail to the matched route (eg. [parent, matchedRoute])
@@ -13,4 +23,4 @@ export declare const matchRoutes: (navMenu: NavMenuItem, path: string) => NavMen
  * @param trailLevel The trail level of the active route to return
  * @returns
  */
-export declare function getActiveRoute(navMenu: NavMenuItem, trailLevel?: number): NavMenuItem[];
+export declare function getActiveRoute(navMenuItems: NavMenuItem[], trailLevel?: number): NavMenuItem[];
diff --git a/types/src/lib/utils/use-storage.d.ts b/types/src/lib/utils/use-storage.d.ts
@@ -0,0 +1,14 @@
+import { type Writable } from "svelte/store";
+declare type StorageType = 'localStorage' | 'sessionStorage';
+/**
+ * Creates a writable storage that will automatically
+ * write and read the value to and from local/session storage
+ * @param type Type of storage to use: local or session storage
+ * @param key The key to save the storred value to
+ * @param initialValue An initial value in case the storage is empty
+ * @returns
+ */
+export declare const useStorage: <T>(type: StorageType, key: string, initialValue: T) => Writable<T>;
+export declare const useLocalStorage: <T>(key: string, initialValue: T) => Writable<T>;
+export declare const useSessionStorage: <T>(key: string, initialValue: T) => Writable<T>;
+export {};
diff --git a/types/src/main.d.ts b/types/src/main.d.ts
@@ -6,6 +6,7 @@ export declare type NavigationAppProps = {
     type?: NavigationType;
     toolName?: string;
     toolRoot?: string;
+    fullFooter?: boolean;
     handleNavigation?: NavigationHandler;
     onReady?: () => void;
     user?: AuthUser;

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`export interface ToolConfig {`
`2`	`2`	`name: string;`
`3`	`3`	`root: string;`
	`4`	`+ fullFooter?: boolean;`
`4`	`5`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`import type { NavMenuItem } from './nav-menu-item.model';`
`2`		`-export declare function getFooterNavItems(): NavMenuItem[];`
	`2`	`+export declare function getFooterNavItems(isAuthenticated: boolean): NavMenuItem[];`
Original file line number	Diff line number	Diff line change
`@@ -8,4 +8,6 @@ export interface NavMenuItem {`
`8`	`8`	`icon?: string;`
`9`	`9`	`action?: string;`
`10`	`10`	`url?: string;`
	`11`	`+ authenticatedPath?: string;`
	`12`	`+ groupOrder?: number;`
`11`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`import type { NavMenuItem } from './nav-menu-item.model';`
`2`		`-export declare function getMainNavItems(): NavMenuItem[];`
	`2`	`+export declare function getMainNavItems(isAuthenticated: boolean): NavMenuItem[];`