@common-stack/core 8.0.1-alpha.0 → 8.2.1-alpha.0

package/LICENSE

@@ -1,21 +1,34 @@
-The MIT License
-
-Copyright (c) 2017 CDMBase LLC.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+PROPRIETARY LICENSE
+
+Copyright (c) 2017-2025 CDMBase LLC. All Rights Reserved.
+
+This software and associated documentation files (the "Software") are the 
+proprietary and confidential information of CDMBase LLC ("Confidential Information").
+
+NOTICE: All information contained herein is, and remains the property of 
+CDMBase LLC. The intellectual and technical concepts contained herein are 
+proprietary to CDMBase LLC and may be covered by U.S. and Foreign Patents, 
+patents in process, and are protected by trade secret or copyright law.
+
+Dissemination of this information or reproduction of this material is strictly 
+forbidden unless prior written permission is obtained from CDMBase LLC.
+
+NO LICENSE, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, TO ANY INTELLECTUAL 
+PROPERTY RIGHTS ARE GRANTED BY THIS DOCUMENT.
+
+RESTRICTIONS:
+1. You may NOT use, copy, modify, merge, publish, distribute, sublicense, 
+   and/or sell copies of the Software without explicit written permission 
+   from CDMBase LLC.
+2. You may NOT reverse engineer, decompile, or disassemble the Software.
+3. You may NOT remove or alter any proprietary notices or labels on the Software.
+4. The Software is licensed, not sold.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 
+CDMBASE LLC BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN 
+AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+For licensing inquiries, please contact: legal@cdmbase.com

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

@@ -4,3 +4,4 @@ export * from './rollupRouteGenerated';
 export * from './routeJson';
 export * from './viteSettings';
 export * from './wrapperRouteOptions';
+export * from './routeMobileAdditions';

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

@@ -1,3 +1,4 @@
+import { IPermissionsFlattenedKeys } from 'common';
 export declare enum IMenuPosition {
     Logo = "LOGO",
     Upper = "UPPER",
@@ -70,7 +71,7 @@ export interface IMenuDataItem {
     /**
      * @name permissions to determine whether to render menu or not
      */
-    authority?: string[];
+    authority?: IPermissionsFlattenedKeys[];
     /**
      * @name priority of the menu to display in the order. Lower values shows first.
      */
@@ -79,5 +80,20 @@ export interface IMenuDataItem {
      * The path displayed by the menuItem's tooltip
      */
     tooltip?: string;
+    /**
+     * @name System Type
+     * @description Determines visibility based on user role - 'system' for admin only, 'user' for common users and owners
+     */
+    systemType?: 'system' | 'user';
+    /**
+     * @name Category
+     * @description Main category for hierarchical organization (e.g., 'communication', 'administration', 'business', 'content')
+     */
+    category?: string;
+    /**
+     * @name Sub Category
+     * @description Sub-category for more granular organization (e.g., 'email', 'chat' under 'communication')
+     */
+    subCategory?: string;
     [key: string]: any;
 }

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

@@ -1 +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"}
+{"version":3,"file":"menu.js","sources":["../../../src/component/interfaces/menu.ts"],"sourcesContent":[null],"names":[],"mappings":"IACY,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/routeCompute.d.ts

@@ -14,7 +14,7 @@ export interface IRouteModule extends IMenuDataItem, IGeneratedWrapperOptions {
      * @name Path
      * @description The path of the route.
      */
-    path?: string;
+    path: string;
     /**
      * @name Index Route
      * @description Indicates if this is an index route.
@@ -47,7 +47,7 @@ export interface IRouteModule extends IMenuDataItem, IGeneratedWrapperOptions {
      * @description Dynamic import of the Dialog component for modal routes.
      */
     dialog?: () => Promise<{
-        default: LazyExoticComponent<ComponentType<any>>;
+        default: LazyExoticComponent<ComponentType<any>> | ComponentType<any>;
     }>;
     /**
      * @name Nested Routes
@@ -88,7 +88,7 @@ export interface IRouteModule extends IMenuDataItem, IGeneratedWrapperOptions {
      * @name Authentication Requirement
      * @description Indicates if authentication is required for the route.
      */
-    auth?: boolean;
+    auth?: boolean | 'optional';
     /**
      * @name Props
      * @description Extra properties for the route, including initial parameters and UI options.
@@ -163,6 +163,21 @@ export interface IRouteModule extends IMenuDataItem, IGeneratedWrapperOptions {
      * @description Key for the previous step in a multi-step process, such as onboarding.
      */
     prev?: string;
+    /**
+     * @name System Type
+     * @description Determines visibility based on user role - 'system' for admin only, 'user' for common users and owners
+     */
+    systemType?: 'system' | 'user';
+    /**
+     * @name Category
+     * @description Main category for hierarchical organization (e.g., 'communication', 'administration', 'business', 'content')
+     */
+    category?: string;
+    /**
+     * @name Sub Category
+     * @description Sub-category for more granular organization (e.g., 'email', 'chat' under 'communication')
+     */
+    subCategory?: string;
     /**
      * @name Additional Properties
      * @description Allows additional properties to be added as needed.

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

@@ -1,9 +1,15 @@
 import { IRollupBuildGenerated } from './rollupRouteGenerated';
 import { IRouteModule } from './routeCompute';
+/**
+ * @name IBaseRouteMap
+ * @description Base interface for route mapping that can be shared across platforms
+ */
+export interface IBaseRouteMap<T = unknown, R = IRouteModule> {
+    [key: string]: R & T;
+}
+export type IRouteMap<T = unknown> = IBaseRouteMap<T, Omit<IRouteModule, 'path'> & Partial<Pick<IRouteModule, 'path'>>>;
 /**
  * @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;
-}>;
+export type IComputedRoutesArray = Array<IRouteMap<IRollupBuildGenerated>>;

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

@@ -0,0 +1,50 @@
+import { IRouteModule as IBaseRouteModule } from './routeCompute';
+export interface IReactNavigationProps {
+    initialParams?: Record<string, any>;
+    initialRouteName?: string;
+    component?: React.ComponentType<any> | React.ReactNode;
+    unauthenticatedComponent?: React.ComponentType<any> | React.ReactNode;
+    options?: {
+        headerShown?: boolean;
+        headerTitle?: string;
+        tabBarLabel?: string;
+        tabBarIcon?: string | ((props: {
+            color: string;
+        }) => JSX.Element);
+        tabBarActiveTintColor?: string;
+        tabBarInactiveTintColor?: string;
+        drawerIcon?: string;
+        drawerStyle?: Record<string, any>;
+        gestureEnabled?: boolean;
+        swipeEnabled?: boolean;
+        title?: string;
+    };
+    screenOptions?: ((options: any) => Record<string, any>) | Record<string, any>;
+    drawerContent?: (props: any) => JSX.Element;
+    tabBar?: (props: any) => JSX.Element;
+}
+/**
+ * Interface extending IRouteModule with mobile-specific navigation properties
+ */
+export interface IRouteMobileAdditions extends IBaseRouteModule {
+    /**
+     * @name Container
+     * @description Navigation container function (Stack, Drawer, or BottomTab navigator)
+     */
+    container?: any;
+    /**
+     * @name Route Name
+     * @description Name of the route for navigation
+     */
+    name?: string;
+    /**
+     * @name Navigation Props
+     * @description Extended props specific to mobile navigation
+     */
+    props?: IReactNavigationProps;
+    /**
+     * @name With Life Cycle Interaction
+     * @description Whether to enable life cycle interaction
+     */
+    withLifeCycleInteraction?: any;
+}

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

@@ -42,4 +42,28 @@ export interface IViteSettings {
      * @default: false
      */
     _useFutureCommonPackage?: boolean;
+    /**
+     * @name overrideRoutes Configuration
+     * @description Override routes by replacing old routes with new routes.
+     * Can be specified as a single mapping object or an array of mappings.
+     * @example
+     * // Single mapping
+     * overrideRoutes: {
+     *     oldRoute: '/0/:routeToReplace',
+     *     newRoute: '/',
+     * }
+     *
+     * // Multiple mappings
+     * overrideRoutes: [
+     *     { oldRoute: '/0/:routeToReplace', newRoute: '/' },
+     *     { oldRoute: '/nested/path', newRoute: '/simple' }
+     * ]
+     */
+    overrideRoutes?: {
+        oldRoute: string;
+        newRoute: string;
+    } | Array<{
+        oldRoute: string;
+        newRoute: string;
+    }>;
 }

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

@@ -1,3 +1,4 @@
+import { ContributionExtensionName, ContributionSchemaId, IPermissionsFlattenedKeys, IConfigurationsFlattenedKeys } from 'common';
 import { IAuthorityConfig } from './authority';
 import { IRollupBuildGenerated } from './rollupRouteGenerated';
 import { IViteSettings } from './viteSettings';
@@ -38,6 +39,16 @@ export interface IResourceParams {
      * @description Path related to the resource.
      */
     path?: string;
+    /**
+     * @name Extension Name
+     * @description Name of the extension for resource identification in dataLoader.
+     */
+    extensionName?: ContributionExtensionName;
+    /**
+     * @name Schema ID
+     * @description Schema identifier for configuration and preferences input.
+     */
+    schemaId?: ContributionSchemaId;
     isExternal?: boolean;
     organization?: string;
     resourceGroup?: string;
@@ -68,7 +79,7 @@ export interface IGeneratedWrapperOptions {
      * @name Authority
      * @description List of permissions required to access the route.
      */
-    authority?: string[];
+    authority?: IPermissionsFlattenedKeys[];
     /**
      * @name Additional Parameters
      * @description Additional parameters for resource configuration.
@@ -77,19 +88,20 @@ export interface IGeneratedWrapperOptions {
         /**
          * @name Resource Parameters
          * @description Parameters specific to resource handling.
+         * Can be a single IResourceParams object or an array of IResourceParams objects.
          */
-        resourceParams?: IResourceParams;
+        resourceParams?: IResourceParams | IResourceParams[];
     };
     /**
      * @name Configurations
      * @description Configuration keys related to the route.
      */
-    configurations?: string[];
+    configurations?: IConfigurationsFlattenedKeys[] | ['*'];
     /**
      * @name Extra Permissions
      * @description Additional permissions required for the UI.
      */
-    extraPermissions?: string[];
+    extraPermissions?: IPermissionsFlattenedKeys[] | ['*'];
     /**
      * @name Resource Endpoint
      * @description Designates the route as a resource endpoint.
@@ -124,15 +136,25 @@ export interface IGeneratedWrapperOptions {
      * @name Extra Links
      * @description Additional links for the route.
      */
-    extraLink?: any[];
+    extraLinks?: any[];
     /**
      * @name Authority Configuration
      * @description Configuration for authority and permission checks.
      */
     authorityConfig?: IAuthorityConfig;
+    /**
+     * @name Extension Name
+     * @description Name of the extension for resource identification in dataLoader.
+     */
+    extensionName?: string;
+    /**
+     * @name Schema ID
+     * @description Schema identifier for configuration and preferences input.
+     */
+    schemaId?: string;
     /**
      * @name _useFutureCommonPackage Configuration
-     * @description Whether the package is using common package or not
+     * @description Whether the package is using `common` package or not
      * @default: false
      */
     _useFutureCommonPackage?: boolean;

package/lib/constants/types.d.ts

@@ -4,6 +4,8 @@ export declare const CommonType: {
     HEMERA: string;
     MOLECULER_BROKER: string;
     PUBSUB: string;
+    REDIS_CLIENT: symbol;
+    INNGEST_CLIENT: string;
 };
 export declare const TaggedType: {
     MICROSERVICE: string;

package/lib/constants/types.js

@@ -4,6 +4,8 @@ const CommonType = {
     HEMERA: 'HEMERA',
     MOLECULER_BROKER: 'MOLECULER_BROKER',
     PUBSUB: 'PUBSUB',
+    REDIS_CLIENT: Symbol.for('REDIS_CLIENT'),
+    INNGEST_CLIENT: 'INNGEST_CLIENT',
 };
 const TaggedType = {
     MICROSERVICE: 'MICROSERVICE',

package/lib/constants/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sources":["../../src/constants/types.ts"],"sourcesContent":[null],"names":[],"mappings":"AACa,MAAA,UAAU,GAAG;AACtB,IAAA,MAAM,EAAE,QAAQ;AAChB,IAAA,WAAW,EAAE,aAAa;AAC1B,IAAA,MAAM,EAAE,QAAQ;AAChB,IAAA,gBAAgB,EAAE,kBAAkB;AACpC,IAAA,MAAM,EAAE,QAAQ;EACnB;AAEY,MAAA,UAAU,GAAG;AACtB,IAAA,YAAY,EAAE,cAAc;EAC/B;AAEY,MAAA,WAAW,GAAG;;AAEvB,IAAA,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;AAC5B,IAAA,YAAY,EAAE,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC;AACxC,IAAA,UAAU,EAAE,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC;AACpC,IAAA,mBAAmB,EAAE,MAAM,CAAC,GAAG,CAAC,qBAAqB,CAAC;AACtD,IAAA,aAAa,EAAE,MAAM,CAAC,GAAG,CAAC,eAAe,CAAC;AAC1C,IAAA,YAAY,EAAE,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC;EAC1C;AAEW,MAAA,aAAa,GAAG;AACzB,IAAA,UAAU,EAAE,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC;AACpC,IAAA,WAAW,EAAE,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC;AACtC,IAAA,UAAU,EAAE,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC;"}
+{"version":3,"file":"types.js","sources":["../../src/constants/types.ts"],"sourcesContent":[null],"names":[],"mappings":"AAAa,MAAA,UAAU,GAAG;AACtB,IAAA,MAAM,EAAE,QAAQ;AAChB,IAAA,WAAW,EAAE,aAAa;AAC1B,IAAA,MAAM,EAAE,QAAQ;AAChB,IAAA,gBAAgB,EAAE,kBAAkB;AACpC,IAAA,MAAM,EAAE,QAAQ;AAChB,IAAA,YAAY,EAAE,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC;AACxC,IAAA,cAAc,EAAE,gBAAgB;EAClC;AAEW,MAAA,UAAU,GAAG;AACtB,IAAA,YAAY,EAAE,cAAc;EAC9B;AAEW,MAAA,WAAW,GAAG;;AAEvB,IAAA,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;AAC5B,IAAA,YAAY,EAAE,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC;AACxC,IAAA,UAAU,EAAE,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC;AACpC,IAAA,mBAAmB,EAAE,MAAM,CAAC,GAAG,CAAC,qBAAqB,CAAC;AACtD,IAAA,aAAa,EAAE,MAAM,CAAC,GAAG,CAAC,eAAe,CAAC;AAC1C,IAAA,YAAY,EAAE,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC;EAC1C;AAEW,MAAA,aAAa,GAAG;AACzB,IAAA,UAAU,EAAE,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC;AACpC,IAAA,WAAW,EAAE,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC;AACtC,IAAA,UAAU,EAAE,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC;"}

package/lib/index.d.ts

@@ -2,3 +2,4 @@ export * from './field-error';
 export * from './interfaces';
 export * from './constants';
 export * from './utils';
+export * from './component';

package/lib/index.js

@@ -1 +1 @@
-export{FieldError}from'./field-error.js';export{ClientTypes,CommonType,ElectronTypes,TaggedType}from'./constants/types.js';export{getEnvironment}from'./utils/getEnvironment.js';export{getGlobalVariable,setGlobalVariable}from'./utils/globalVariable.js';//# sourceMappingURL=index.js.map
+export{FieldError}from'./field-error.js';export{ClientTypes,CommonType,ElectronTypes,TaggedType}from'./constants/types.js';export{getEnvironment}from'./utils/getEnvironment.js';export{getGlobalVariable,setGlobalVariable}from'./utils/globalVariable.js';export{IMenuPosition}from'./component/interfaces/menu.js';//# sourceMappingURL=index.js.map

package/package.json

@@ -1,8 +1,8 @@
 {
     "name": "@common-stack/core",
-    "version": "8.0.1-alpha.0",
+    "version": "8.2.1-alpha.0",
     "description": "Common core for higher packages to depend on",
-    "license": "ISC",
+    "license": "UNLICENSED",
     "author": "CDMBase LLC",
     "type": "module",
     "main": "lib/index.js",
@@ -20,11 +20,14 @@
         "test:watch": "npm test -- --watch",
         "watch": "yarn build:lib:watch"
     },
+    "devDependencies": {
+        "common": "8.2.1-alpha.0"
+    },
     "publishConfig": {
         "access": "public"
     },
     "typescript": {
         "definition": "lib/index.d.ts"
     },
-    "gitHead": "73d9088ae254fbc43425eed5c9f5cd95bd66e921"
+    "gitHead": "b46db06f987271c3a2e050f081e266d3a01b285b"
 }

package/lib/index.component.js

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

package/lib/index.component.js.map

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