@capsitech/react-utilities 0.1.4 → 0.1.5

package/lib/Utilities/RouteUtils.d.ts

@@ -1,120 +1,129 @@
-import React from "react";
-import { RouteProps } from "react-router-dom";
-export declare enum FeatureStatus {
-    placeholder = 0,
-    alpha = 1,
-    beta = 2,
-    release = 3
-}
-export interface IRouteProps extends RouteProps {
-    name?: string;
-    path?: string;
-    url?: string;
-    key?: string | number;
-    icon?: string;
-    isCategory?: boolean;
-    children?: React.ReactNode;
-    /**
-     * The component to render for this route's content (or a loading placeholder if `getComponent` is provided).
-     */
-    component?: any;
-    /**
-     * Function that loads the component asynchronously.
-     * Notify when loading has finished using `cb`.
-     * If `component` is provided, it will be rendered while waiting for the callback.
-     */
-    getComponent?: (cb: (component: any) => void) => void;
-    /**
-     * User roles to check for route rendering
-     */
-    roles?: string[];
-    /**
-     * Practice features to check for route rendering
-     */
-    features?: number[];
-    /**
-     * Business types to check for route rendering
-     */
-    businessTypes?: number[];
-    /**
-     * User config/tags to check for route rendering
-     */
-    userConfig?: string[];
-    /**
-     * User params to check for route rendering
-     */
-    userParams?: string[];
-    /**
-     * Other tags to check for route rendering
-     */
-    tags?: string[];
-    /**
-     * Sub/inner links
-     */
-    links?: IRouteProps[];
-    /**
-     * Other URL to show this link as active
-     */
-    activeUrl?: string;
-    /**
-     * Other URLs to show this link as active
-     */
-    activeUrls?: string[];
-    /**
-     * Default expanded or collapsed
-     */
-    isExpanded?: boolean;
-    /**
-     * Feature status (to show bedge on link)
-     */
-    status?: FeatureStatus;
-}
-export interface IRouteGroupProps {
-    /**
-     * Links to render within this group
-     */
-    links: IRouteProps[];
-    /**
-     * User roles to check for route rendering
-     */
-    roles?: string[];
-    /**
-     * Practice features to check for route rendering
-     */
-    features?: number[];
-    /**
-     * User config/tags to check for route rendering
-     */
-    userConfig?: string[];
-    /**
-     * Other tags to check for route rendering
-     */
-    tags?: string[];
-    /**
-     * Other URL to show this link as active
-     */
-    activeUrls?: string[];
-    /**
-     * Default expanded or collapsed
-     */
-    isExpanded?: boolean;
-}
-declare class RouteUtilsBase {
-    private hasValidRole;
-    private hasValidFeatures;
-    private hasValidBusinessType;
-    private hasValidUserConfig;
-    private hasValidUserParam;
-    private hasValidTags;
-    private isValidLink;
-    private getPath;
-    getRoutesFromGroups: (groups: IRouteGroupProps[], SecureRoute: any, roles?: string[], features?: number[], businessType?: number, userConfig?: any, userParams?: any, tags?: any, trimUrl?: string) => any[];
-    getRoutesFromGroup: (links: IRouteProps[], SecureRoute: any, roles?: string[], features?: number[], businessType?: number, userConfig?: any, userParams?: any, tags?: any, trimUrl?: string) => any[];
-    getLinksFromGroups: (links: IRouteGroupProps[], roles?: string[], features?: number[], businessType?: number, userConfig?: any, userParams?: any, currentPath?: string, params?: any, tags?: any) => IRouteGroupProps[];
-    getLinksFromGroup: (links: IRouteProps[], roles?: string[], features?: number[], businessType?: number, userConfig?: any, userParams?: any, currentPath?: string, params?: any, tags?: any) => IRouteProps[];
-    getRoutesFromLinks: (links: IRouteProps[], SecureRoute: any, roles?: string[], features?: number[], businessType?: number, userConfig?: any, userParams?: any, tags?: any, trimUrl?: string) => any[];
-    getLinksFromLinks: (links: IRouteProps[], roles?: string[], features?: number[], businessType?: number, userConfig?: any, userParams?: any, currentPath?: string, params?: any, tags?: any) => IRouteProps[];
-    getSelectedNavKey: (pagesGroup: IRouteGroupProps[], currentPath: string) => string | number | undefined;
-}
-export declare const RouteUtils: RouteUtilsBase;
-export {};
+import React from "react";
+export declare enum FeatureStatus {
+    placeholder = 0,
+    alpha = 1,
+    beta = 2,
+    release = 3
+}
+export interface IRouteProps {
+    name?: string;
+    path?: string;
+    url?: string;
+    key?: string | number;
+    icon?: string;
+    isCategory?: boolean;
+    children?: React.ReactNode;
+    /**
+     * The component to render for this route's content (or a loading placeholder if `getComponent` is provided).
+     */
+    component?: any;
+    /**
+     * Function that loads the component asynchronously.
+     * Notify when loading has finished using `cb`.
+     * If `component` is provided, it will be rendered while waiting for the callback.
+     */
+    getComponent?: (cb: (component: any) => void) => void;
+    /**
+     * User roles to check for route rendering
+     */
+    roles?: string[];
+    /**
+     * User permissions to check for route rendering
+     */
+    permissions?: string[];
+    /**
+     * Practice features to check for route rendering
+     */
+    features?: number[];
+    /**
+     * Business types to check for route rendering
+     */
+    businessTypes?: number[];
+    /**
+     * User config/tags to check for route rendering
+     */
+    userConfig?: string[];
+    /**
+     * User params to check for route rendering
+     */
+    userParams?: string[];
+    /**
+     * Other tags to check for route rendering
+     */
+    tags?: string[];
+    /**
+     * Sub/inner links
+     */
+    links?: IRouteProps[];
+    /**
+     * Other URL to show this link as active
+     */
+    activeUrl?: string;
+    /**
+     * Other URLs to show this link as active
+     */
+    activeUrls?: string[];
+    /**
+     * Default expanded or collapsed
+     */
+    isExpanded?: boolean;
+    /**
+     * Feature status (to show bedge on link)
+     */
+    status?: FeatureStatus;
+}
+export interface IRouteGroupProps {
+    /**
+     * Links to render within this group
+     */
+    links: IRouteProps[];
+    /**
+     * User roles to check for route rendering
+     */
+    roles?: string[];
+    /**
+     * User permissions to check for route rendering
+     */
+    permissions?: string[];
+    /**
+     * Practice features to check for route rendering
+     */
+    features?: number[];
+    /**
+     * User config/tags to check for route rendering
+     */
+    userConfig?: string[];
+    /**
+     * Other tags to check for route rendering
+     */
+    tags?: string[];
+    /**
+     * Other URL to show this link as active
+     */
+    activeUrls?: string[];
+    /**
+     * Default expanded or collapsed
+     */
+    isExpanded?: boolean;
+}
+declare class RouteUtilsBase {
+    private hasValidRole;
+    private hasValidPermission;
+    private hasValidRoleOrPermission;
+    private hasValidFeatures;
+    private hasValidBusinessType;
+    private hasValidUserConfig;
+    private hasValidUserParam;
+    private hasValidTags;
+    private isValidLink;
+    private getPath;
+    getRoutesFromGroups: (groups: IRouteGroupProps[], SecureRoute: any, userRoles?: string[], userPermissions?: string[], features?: number[], businessType?: number, userConfig?: any, userParams?: any, tags?: any, trimUrl?: string) => any[];
+    getRoutesFromGroup: (links: IRouteProps[], SecureRoute: any, userRoles?: string[], userPermissions?: string[], features?: number[], businessType?: number, userConfig?: any, userParams?: any, tags?: any, trimUrl?: string) => any[];
+    getLinksFromGroups: (links: IRouteGroupProps[], userRoles?: string[], userPermissions?: string[], features?: number[], businessType?: number, userConfig?: any, userParams?: any, currentPath?: string, params?: any, tags?: any) => IRouteGroupProps[];
+    getLinksFromGroup: (links: IRouteProps[], userRoles?: string[], userPermissions?: string[], features?: number[], businessType?: number, userConfig?: any, userParams?: any, currentPath?: string, params?: any, tags?: any) => IRouteProps[];
+    getRoutesFromLinks: (links: IRouteProps[], SecureRoute: any, userRoles?: string[], userPermissions?: string[], features?: number[], businessType?: number, userConfig?: any, userParams?: any, tags?: any, trimUrl?: string) => any[];
+    getLinksFromLinks: (links: IRouteProps[], userRoles?: string[], userPermissions?: string[], features?: number[], businessType?: number, userConfig?: any, userParams?: any, currentPath?: string, params?: any, tags?: any) => IRouteProps[];
+    getSelectedNavKey: (pagesGroup: IRouteGroupProps[], currentPath: string) => string | number | undefined;
+}
+export declare const RouteUtils: RouteUtilsBase;
+export {};