@common-stack/core 6.0.2-alpha.1 → 6.0.6-alpha.104

package/lib/component/index.d.ts

@@ -0,0 +1 @@
+export * from './interfaces';

package/lib/component/interfaces/authority.d.ts

@@ -0,0 +1,12 @@
+export declare enum IPermissionBehavior {
+    hide = 0,
+    showUnAuthorized = 1,
+    showAlternative = 2
+}
+export interface IAuthorityConfig {
+    behavior?: IPermissionBehavior;
+    requireAllPermissions?: boolean;
+    customCheck?: (permissions: any, configurations: any) => boolean;
+    visibilityCheck?: (visibility: any) => string;
+    visibilityConfigKey?: string;
+}

package/lib/component/interfaces/index.d.ts

@@ -0,0 +1,6 @@
+export * from './menu';
+export * from './routeCompute';
+export * from './rollupRouteGenerated';
+export * from './routeJson';
+export * from './viteSettings';
+export * from './wrapperRouteOptions';

package/lib/component/interfaces/menu.d.ts

@@ -0,0 +1,83 @@
+export declare enum IMenuPosition {
+    Logo = "LOGO",
+    Upper = "UPPER",
+    Middle = "MIDDLE",
+    Lower = "LOWER",
+    Bottom = "BOTTOM"
+}
+export interface IMenuDataItem {
+    /**
+     * @name submenu
+     */
+    children?: IMenuDataItem[];
+    /**
+     * @name Hide child nodes in the menu
+     */
+    hideChildrenInMenu?: boolean;
+    /**
+     * @name hideSelf and children in menu
+     */
+    hideInMenu?: boolean;
+    /**
+     * @name Icon
+     * @description Icon settings for the route, including name and properties such as size.
+     */
+    icon?: string | {
+        name: string;
+        props?: Record<string, any>;
+        style?: Record<string, any>;
+    };
+    /**
+     * @name Internationalization key for custom menus
+     */
+    locale?: string | false;
+    /**
+     * @name The name of the menu
+     */
+    name?: string;
+    /**
+     * @name is used to calibrate the selected value, default is path
+     */
+    key?: string;
+    /**
+     * @name disable menu option
+     */
+    disabled?: boolean;
+    /**
+     * Disable menu tooltip menu option
+     */
+    disabledTooltip?: boolean;
+    /**
+     * @name path
+     */
+    path?: string;
+    /**
+     * @name custom parent node
+     * @description When this node is selected, the node of parentKeys is also selected
+     */
+    parentKeys?: string[];
+    /**
+     * @name hides itself and elevates child nodes to its level
+     */
+    flatMenu?: boolean;
+    /** @name Specify the external link opening mode, same as a tag */
+    target?: string;
+    /**
+     * @name position of the Menu
+     * @enum IMenuPosition
+     */
+    position?: IMenuPosition;
+    /**
+     * @name permissions to determine whether to render menu or not
+     */
+    authority?: string[];
+    /**
+     * @name priority of the menu to display in the order. Lower values shows first.
+     */
+    priority?: number;
+    /**
+     * The path displayed by the menuItem's tooltip
+     */
+    tooltip?: string;
+    [key: string]: any;
+}

package/lib/component/interfaces/menu.js

@@ -0,0 +1,8 @@
+var IMenuPosition;
+(function (IMenuPosition) {
+    IMenuPosition["Logo"] = "LOGO";
+    IMenuPosition["Upper"] = "UPPER";
+    IMenuPosition["Middle"] = "MIDDLE";
+    IMenuPosition["Lower"] = "LOWER";
+    IMenuPosition["Bottom"] = "BOTTOM";
+})(IMenuPosition || (IMenuPosition = {}));export{IMenuPosition};//# sourceMappingURL=menu.js.map

package/lib/component/interfaces/menu.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"menu.js","sources":["../../../src/component/interfaces/menu.ts"],"sourcesContent":[null],"names":[],"mappings":"IAAY,cAMX;AAND,CAAA,UAAY,aAAa,EAAA;AACrB,IAAA,aAAA,CAAA,MAAA,CAAA,GAAA,MAAa,CAAA;AACb,IAAA,aAAA,CAAA,OAAA,CAAA,GAAA,OAAe,CAAA;AACf,IAAA,aAAA,CAAA,QAAA,CAAA,GAAA,QAAiB,CAAA;AACjB,IAAA,aAAA,CAAA,OAAA,CAAA,GAAA,OAAe,CAAA;AACf,IAAA,aAAA,CAAA,QAAA,CAAA,GAAA,QAAiB,CAAA;AACrB,CAAC,EANW,aAAa,KAAb,aAAa,GAMxB,EAAA,CAAA,CAAA"}

package/lib/component/interfaces/rollupRouteGenerated.d.ts

@@ -0,0 +1,35 @@
+export interface IRoutePageExportFlags {
+    hasLoader?: boolean;
+    hasAction?: boolean;
+    hasClientLoader?: boolean;
+    hasClientAction?: boolean;
+    hasComponent?: boolean;
+    hasErrorBoundary?: boolean;
+    /**
+     * @name Query Params Generator
+     * @description Indicates if the route uses a query parameters generator.
+     */
+    queryParamsGenerator?: boolean;
+    hasLinks?: boolean;
+    hasMeta?: boolean;
+    hasHydrateFallback?: boolean;
+    hasShouldRevalidate?: boolean;
+    hasHandle?: boolean;
+    hasHeaders?: boolean;
+    disableQueryGenerator?: boolean;
+}
+export interface ILoaderReturnInfo {
+    returnType?: 'json' | 'defer' | '';
+    hasOptions?: boolean;
+    keys?: string[];
+}
+export interface IRollupBuildGenerated extends IRoutePageExportFlags {
+    queries?: Record<string, string | object>;
+    componentPath?: string;
+    loaderReturnInfo?: ILoaderReturnInfo;
+    /**
+     * @name Dialog Path
+     * @description Path to the dialog component for modal routes.
+     */
+    dialogPath?: string;
+}

package/lib/component/interfaces/routeCompute.d.ts

@@ -0,0 +1,171 @@
+import type { LoaderFunction, ActionFunction } from '@remix-run/router';
+import type { FunctionComponent, LazyExoticComponent, ComponentType } from 'react';
+import { IMenuDataItem } from './menu';
+import { IGeneratedWrapperOptions } from './wrapperRouteOptions';
+export interface IComponent extends FunctionComponent {
+    getInitialProps?: Function;
+    preload?: () => Promise<any>;
+}
+/**
+ * Interface defining the structure for route modules.
+ */
+export interface IRouteModule extends IMenuDataItem, IGeneratedWrapperOptions {
+    /**
+     * @name Path
+     * @description The path of the route.
+     */
+    path?: string;
+    /**
+     * @name Index Route
+     * @description Indicates if this is an index route.
+     */
+    index?: boolean;
+    /**
+     * @name Exact Match
+     * @description Specifies exact matching for the route path.
+     */
+    exact?: boolean;
+    /**
+     * @name Redirect Path
+     * @description Path to redirect to.
+     */
+    redirect?: string;
+    /**
+     * @name Component
+     * @description Dynamic import of the Component to render for the route.
+     */
+    component?: () => Promise<{
+        default: ComponentType<any>;
+    }>;
+    /**
+     * @name Modal Route
+     * @description Indicates if the route should be displayed as a modal.
+     */
+    modal?: boolean;
+    /**
+     * @name Dialog
+     * @description Dynamic import of the Dialog component for modal routes.
+     */
+    dialog?: () => Promise<{
+        default: LazyExoticComponent<ComponentType<any>>;
+    }>;
+    /**
+     * @name Nested Routes
+     * @description Nested routes under the current route.
+     */
+    routes?: IRouteModule[];
+    /**
+     * @name Route Key
+     * @description Unique key for the route.
+     */
+    key?: string;
+    /**
+     * @name Strict Match
+     * @description Applies strict matching to trailing slashes.
+     */
+    strict?: boolean;
+    /**
+     * @name Case-Sensitive Route
+     * @description Indicates if the route is case-sensitive.
+     */
+    sensitive?: boolean;
+    /**
+     * @name Wrapper Components
+     * @description Wrapper components to wrap the route's component.
+     */
+    wrappers?: any[];
+    /**
+     * @name Data Loader
+     * @description Function to load data for the route.
+     */
+    loader?: LoaderFunction;
+    /**
+     * @name Action Handler
+     * @description Function to handle actions on the route.
+     */
+    action?: ActionFunction;
+    /**
+     * @name Authentication Requirement
+     * @description Indicates if authentication is required for the route.
+     */
+    auth?: boolean;
+    /**
+     * @name Props
+     * @description Extra properties for the route, including initial parameters and UI options.
+     */
+    props?: {
+        initialParams?: Record<string, any>;
+        options?: Record<string, any>;
+    };
+    /**
+     * @name Import Paths
+     * @description Additional import paths for route components based on user roles or other conditions.
+     */
+    importPaths?: Record<string, string> | Record<string, () => Promise<{
+        default: React.ComponentType<any>;
+    }>>;
+    /**
+     * @name Unauthenticated Component
+     * @description Component path or import for unauthenticated users.
+     */
+    unauthenticatedComponent?: string;
+    /**
+     * @name Options
+     * @description Additional options for the route, such as header settings and color configuration.
+     */
+    options?: {
+        headerShown?: boolean;
+        title?: string;
+        /**
+         * @name Description
+         * @description Description text for display in onboarding or account sections.
+         */
+        description?: string;
+        headerBackTitle?: string;
+        tabBarActiveTintColor?: string;
+        tabBarInactiveTintColor?: string;
+        tabBarLabel?: string;
+        priority?: number;
+        presentation?: string;
+        /**
+         * @name Next Step
+         * @description Key for the next step in a multi-step process, such as onboarding.
+         */
+        next?: string;
+        /**
+         * @name Previous Step
+         * @description Key for the previous step in a multi-step process, such as onboarding.
+         */
+        prev?: string;
+    };
+    /**
+     * @name Initial Parameters
+     * @description Initial parameters to pass into the route when loading.
+     */
+    initialParams?: Record<string, any>;
+    /**
+     * @name Title
+     * @description Title for display in UI sections like onboarding.
+     */
+    title?: string;
+    /**
+     * @name Description
+     * @description Description text for display in onboarding or account sections.
+     */
+    description?: string;
+    /**
+     * @name Next Step
+     * @description Key for the next step in a multi-step process, such as onboarding.
+     */
+    next?: string;
+    /**
+     * @name Previous Step
+     * @description Key for the previous step in a multi-step process, such as onboarding.
+     */
+    prev?: string;
+    /**
+     * @name Additional Properties
+     * @description Allows additional properties to be added as needed.
+     */
+    [k: string]: any;
+}

package/lib/component/interfaces/routeJson.d.ts

@@ -0,0 +1,9 @@
+import { IRollupBuildGenerated } from './rollupRouteGenerated';
+import { IRouteModule } from './routeCompute';
+/**
+ * @name IComputedRoutesArray
+ * @description Represents an array of route objects, each containing dynamic keys mapped to route configurations. This is the `routes.json` file generated from rollup build
+ */
+export type IComputedRoutesArray = Array<{
+    [key: string]: IRouteModule & IRollupBuildGenerated;
+}>;

package/lib/component/interfaces/viteSettings.d.ts

@@ -0,0 +1,39 @@
+/**
+ *
+ *
+ * const settings: ISettings = {
+ *   componentReplacement: {
+ *       enabled: true,
+ *       replacements: {
+ *           '*': "path/to/globalReplacementComponent.js", // Global replacement component for all routes
+ *           '/home': "path/to/homeReplacementComponent.js",
+ *           '/about': "path/to/aboutReplacementComponent.js",
+ *           '/contact': "path/to/contactReplacementComponent.js"
+ *       },
+ *       excludeRoutes: ['/contact', '/settings'] // Exclude these routes from replacement
+ *   },
+ *   // other settings
+ * };
+ */
+export interface IViteSettings {
+    disableLoader?: boolean;
+    disableAction?: boolean;
+    disableClientLoader?: boolean;
+    disableErrorBoundary?: boolean;
+    disableLinks?: boolean;
+    disableMeta?: boolean;
+    disableHydrateFallback?: boolean;
+    disableShouldRevalidate?: boolean;
+    disableHandle?: boolean;
+    disableHeaders?: boolean;
+    disableClientAction?: boolean;
+    disableExtraProps?: boolean;
+    disableClientMiddlewares?: boolean;
+    componentReplacement?: {
+        enabled?: boolean;
+        replacements?: {
+            [routeKey: string]: string;
+        };
+        excludeRoutes?: string[];
+    };
+}

package/lib/component/interfaces/wrapperRouteOptions.d.ts

@@ -0,0 +1,134 @@
+import { IAuthorityConfig } from './authority';
+import { IRollupBuildGenerated } from './rollupRouteGenerated';
+import { IViteSettings } from './viteSettings';
+export interface IWrapperConfigPaths {
+    configPermissionWrapper?: string;
+    authMiddlware?: string;
+    configurationMiddlewareExec?: string;
+    lifecycleMiddleware?: string;
+    middlewareExec?: string;
+    clientMiddlewareExec?: string;
+    withErrorHandlerUtil?: string;
+}
+export interface IWrapperBuildOptions {
+    suffix?: string;
+    requireAuth?: boolean;
+    authStrategy?: boolean | string | null;
+    settings?: IViteSettings;
+    paths?: IWrapperConfigPaths;
+}
+export interface IResourceParams {
+    /**
+     * @name Fragment
+     * @description Fragment of the resource path.
+     */
+    fragment?: string;
+    /**
+     * @name Query Parameters
+     * @description Query parameters for resource handling.
+     */
+    query?: Record<string, string>;
+    /**
+     * @name Configuration Key
+     * @description Configuration key for resource parameters.
+     */
+    configKey?: string;
+    /**
+     * @name Resource Path
+     * @description Path related to the resource.
+     */
+    path?: string;
+    isExternal: boolean;
+    organization?: string;
+    projectId?: string;
+    resourceType?: string;
+    resourceId?: string;
+}
+/**
+ * @name IMissingWrapperOptions
+ * @description Fields missing from IWrapperOptions that exist in IOptions.
+ */
+export interface IGeneratedWrapperOptions {
+    /**
+     * @name Wrapper Component Paths
+     * @description Array of wrapper component paths for consistent layout.
+     */
+    wrapperPaths?: string[];
+    /**
+     * @name Middlewares
+     * @description Array of middleware functions for the route.
+     */
+    middlewares?: any[];
+    /**
+     * @name Client Middlewares
+     * @description Array of client-side middleware paths applied to the route.
+     */
+    clientMiddlewares?: string[];
+    /**
+     * @name Authority
+     * @description List of permissions required to access the route.
+     */
+    authority?: string[];
+    /**
+     * @name Additional Parameters
+     * @description Additional parameters for resource configuration.
+     */
+    extraParams?: {
+        /**
+         * @name Resource Parameters
+         * @description Parameters specific to resource handling.
+         */
+        resourceParams?: IResourceParams;
+    };
+    /**
+     * @name Configurations
+     * @description Configuration keys related to the route.
+     */
+    configurations?: string[];
+    /**
+     * @name Extra Permissions
+     * @description Additional permissions required for the UI.
+     */
+    extraPermissions?: string[];
+    /**
+     * @name Resource Endpoint
+     * @description Designates the route as a resource endpoint.
+     */
+    isResourceRoute?: boolean;
+    /**
+     * @name Extra Properties
+     * @description Additional properties for the route component.
+     */
+    extraProps?: any;
+    /**
+     * @name Server-Side Code
+     * @description Indicates if the route has server-side code.
+     */
+    hasServerCode?: boolean;
+    /**
+     * @name Component Path
+     * @description The file path to the route's component.
+     */
+    componentPath?: string;
+    /**
+     * @name Resource URI
+     * @description URI representing the resource associated with the route.
+     */
+    resourceUri?: string;
+    /**
+     * @name Extra Icons
+     * @description Additional icons for the route.
+     */
+    extraIcons?: any[];
+    /**
+     * @name Extra Links
+     * @description Additional links for the route.
+     */
+    extraLink?: any[];
+    /**
+     * @name Authority Configuration
+     * @description Configuration for authority and permission checks.
+     */
+    authorityConfig?: IAuthorityConfig;
+}
+export type IWrapperOptions = IWrapperBuildOptions & IRollupBuildGenerated & IGeneratedWrapperOptions;

package/lib/index.component.d.ts

@@ -0,0 +1 @@
+export * from './component';

package/lib/index.component.js

@@ -0,0 +1 @@
+export{IMenuPosition}from'./component/interfaces/menu.js';//# sourceMappingURL=index.component.js.map

package/lib/index.component.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.component.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@common-stack/core",
-    "version": "6.0.2-alpha.1",
+    "version": "6.0.6-alpha.104",
     "description": "Common core for higher packages to depend on",
     "license": "ISC",
     "author": "CDMBase LLC",
@@ -26,5 +26,5 @@
     "typescript": {
         "definition": "lib/index.d.ts"
     },
-    "gitHead": "c13fa6b22a45926ce70f69b5d1215bad58bf40bb"
+    "gitHead": "b0c1313acf4b328cbd1df20c9648b4415104ae81"
 }