@hortiview/modulebase 0.0.13925 → 0.0.14044

package/dist/lib/components/ModuleBase.d.ts

@@ -2,13 +2,35 @@ import { QueryClient } from '@tanstack/react-query';
 import { RouteObject } from 'react-router';
 import { BaseProps } from '../types/BaseProps';
 import { EnvConfig } from '../types/Environment';
-/**
- * Main component of the module. This component is used to create a module with a router and a signalR provider.
- */
-export declare const ModuleBase: ({ props, routes, env, useSignalR, queryClient, }: {
+type ModuleBaseProps = {
+    /**
+     * Properties that are passed to the Base component by the host application, {@link BaseProps}
+     */
     props: BaseProps;
+    /**
+     * Routes that are used in the module, {@link RouteObject}
+     */
     routes: RouteObject[];
+    /**
+     * @deprecated
+     * Environment configuration that is used to configure the module, {@link EnvConfig}.
+     * New way to pass environment variables is through the base props:
+     * Setup the environment variables in the host application (module edit in the vendor section).
+     * They are then passed to the module within the base props.
+     */
     env?: EnvConfig;
+    /**
+     * If true, the module will use the SignalR provider to connect to the module API.
+     */
     useSignalR?: boolean;
+    /**
+     * Query client that is used to provide the module with a query client, {@link QueryClient}.
+     * If not provided, the default query client will be used.
+     */
     queryClient?: QueryClient;
-}) => import("react/jsx-runtime").JSX.Element;
+};
+/**
+ * Main component of the module. This component is used to create a module with a router and a signalR provider.
+ */
+export declare const ModuleBase: ({ props, routes, env, useSignalR, queryClient, }: ModuleBaseProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/lib/components/ModuleCore.d.ts

@@ -2,12 +2,31 @@ import { QueryClient } from '@tanstack/react-query';
 import { BaseProps } from '../types/BaseProps';
 import { EnvConfig } from '../types/Environment';
 export declare const ModuleQueryClient: QueryClient;
-/**
- * Minimal component to create a module with a query client and a signalR provider (to use module api)
- */
-export declare const ModuleCore: ({ props, env, queryClient, children, }: {
+type ModuleCoreProps = {
+    /**
+     * Properties that are passed to the Base component by the host application, {@link BaseProps}
+     */
     props: BaseProps;
+    /**
+     * @deprecated
+     * Environment configuration that is used to configure the module, {@link EnvConfig}.
+     * New way to pass environment variables is through the base props:
+     * Setup the environment variables in the host application (module edit in the vendor section).
+     * They are then passed to the module within the base props.
+     */
     env?: EnvConfig;
+    /**
+     * Query client that is used to provide the module with a query client, {@link QueryClient}.
+     * If not provided, the default query client will be used.
+     */
     queryClient?: QueryClient;
+    /**
+     * Children components that are rendered within the module core
+     */
     children: React.ReactNode;
-}) => import("react/jsx-runtime").JSX.Element;
+};
+/**
+ * Minimal component to create a module with a query client and a signalR provider (to use module api)
+ */
+export declare const ModuleCore: ({ props, env, queryClient, children, }: ModuleCoreProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/lib/constants.d.ts

@@ -1,4 +1,4 @@
-import { BaseProps } from './main';
+import { BaseProps } from './types/BaseProps';
 export declare const REQUIRED_PROPS: (keyof BaseProps)[];
 export declare const RETRIES = 1;
 export declare const RETRY_HTTP_STATUS_CODES: {

package/dist/lib/hooks/useStores.d.ts

@@ -20,9 +20,10 @@ export declare const useBaseProps: () => Pick<import('../main').DeprecatedBasePr
     logEvent?: (event: import('../main').AppInsightsEvent, customProperties?: import('../main').AppInsightsProperties) => void;
     logError?: (exception: import('../main').AppInsightsException) => void;
     throwError?: (message: string, code: number) => void;
+    environmentVariables?: import('../main').EnvironmentVariable[];
 } & {
     setBaseProps: (props: import('../main').BaseProps) => void;
-}, keyof import('../main').DeprecatedBaseProps | "modulePermissionToken" | "moduleId" | "organizationId" | "basePath" | "currentNavigationPath" | "sourcePath" | "currentLanguage" | "currentLanguageId" | "alertRules" | "commonOptions" | "riseNotification" | "navigateInHortiview" | "addBreadcrumbTranslation" | "showSnackbar" | "showMessage" | "logEvent" | "logError" | "throwError">;
+}, keyof import('../main').DeprecatedBaseProps | "modulePermissionToken" | "moduleId" | "organizationId" | "basePath" | "currentNavigationPath" | "sourcePath" | "currentLanguage" | "currentLanguageId" | "alertRules" | "commonOptions" | "riseNotification" | "navigateInHortiview" | "addBreadcrumbTranslation" | "showSnackbar" | "showMessage" | "logEvent" | "logError" | "throwError" | "environmentVariables">;
 export declare const useConfig: () => Pick<{
     environment: import('../main').HortiViewEnvironments;
     setEnvironment: (environment: import('../main').HortiViewEnvironments) => void;

package/dist/lib/main.d.ts

@@ -5,6 +5,7 @@ export type * from './types/BaseProps';
 export type * from './types/CommonOptions';
 export type * from './types/Deprecated';
 export type * from './types/Environment';
+export type * from './types/EnvironmentVariable';
 export type * from './types/ModuleApi';
 export type * from './types/Requests';
 export type * from './types/ServiceBus';

package/dist/lib/types/BaseProps.d.ts

@@ -1,6 +1,7 @@
 import { AppInsightsEvent, AppInsightsException, AppInsightsProperties } from './AppInsights';
 import { AllDropdownsData, CommonOption } from './CommonOptions';
 import { DeprecatedBaseProps } from './Deprecated';
+import { EnvironmentVariable } from './EnvironmentVariable';
 import { AlertServiceBusMessage } from './ServiceBus';
 import { SystemMessage } from './SystemMessage';
 /**
@@ -37,4 +38,5 @@ export type BaseProps = DeprecatedBaseProps & {
     logEvent?: (event: AppInsightsEvent, customProperties?: AppInsightsProperties) => void;
     logError?: (exception: AppInsightsException) => void;
     throwError?: (message: string, code: number) => void;
+    environmentVariables?: EnvironmentVariable[];
 };

package/dist/lib/types/EnvironmentVariable.d.ts

@@ -0,0 +1,6 @@
+export type EnvironmentVariable = {
+    id?: string;
+    appEnvironmentId: string;
+    key: string;
+    value: string;
+};

package/dist/types/EnvironmentVariable.js

@@ -0,0 +1 @@
+

package/dist/utils/helper.js

@@ -24,7 +24,7 @@ const h = /^[v^~<>=]*?(\d+)(?:\.([x*]|\d+)(?:\.([x*]|\d+)(?:\.([x*]|\d+))?(?:-([
 }, g = (r, e) => {
   const n = u(r), t = u(e), i = n.pop(), o = t.pop(), s = l(n, t);
   return s !== 0 ? s : i && o ? l(i.split("."), o.split(".")) : i || o ? i ? -1 : 1 : 0;
-}, p = "0.0.13925", w = (r) => d.every((e) => v(e, r)), v = (r, e) => {
+}, p = "0.0.14044", w = (r) => d.every((e) => v(e, r)), v = (r, e) => {
   if (!e[r]) {
     if (e.throwError)
       return e.throwError(`Missing required prop: ${r}`, 404), !1;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hortiview/modulebase",
   "description": "This is a base module for hortiview",
-  "version": "0.0.13925",
+  "version": "0.0.14044",
   "type": "module",
   "author": "Falk Menge <falk.menge.ext@bayer.com>",
   "contributors": [