@hortiview/modulebase 0.0.1

package/dist/provider/SignalR/signalR.d.ts

@@ -0,0 +1,53 @@
+/**
+ * SignalR message interface, contains property bag for additional data
+ */
+export interface SignalRMessage {
+    messageId: string;
+    messageType: keyof typeof MessageType;
+    entityId: string;
+    entityType: keyof typeof EntityType;
+    operationType: keyof typeof OperationType;
+    message: string;
+    propertyBag: PropertyBag;
+}
+/**
+ * Property bag interface
+ * Contains key value pairs with additional data, cant be different for each message
+ */
+interface PropertyBag extends Record<string, string> {
+}
+/**
+ * Enum for the possible operation types
+ */
+export declare enum OperationType {
+    Create = "Create",
+    Read = "Read",
+    Update = "Update",
+    Delete = "Delete"
+}
+/**
+ * Enum for the possible message types
+ * currently not in use
+ */
+export declare enum MessageType {
+    Notification = "Notification",
+    Alert = "Alert"
+}
+/**
+ * Enum for the possible entity types
+ * the entity type is used to determine the target of the message
+ * please check which kind of entity types are available in the platform and add them here
+ * of course you can add more entity types if needed for your module
+ */
+export declare enum EntityType {
+    Block = "Block",
+    Field = "Field"
+}
+/**
+ * the mapping list of notification icons for the different entity types
+ * the icon is used to display the notification in the notification center
+ * please check which icons are available in the platform and add them here
+ * of course you can add more icons if needed for your module
+ */
+export declare const NotificationIcons: Record<keyof typeof EntityType, string>;
+export {};

package/dist/provider/SignalR/signalR.js

@@ -0,0 +1,11 @@
+var r = /* @__PURE__ */ ((e) => (e.Create = "Create", e.Read = "Read", e.Update = "Update", e.Delete = "Delete", e))(r || {}), t = /* @__PURE__ */ ((e) => (e.Notification = "Notification", e.Alert = "Alert", e))(t || {}), l = /* @__PURE__ */ ((e) => (e.Block = "Block", e.Field = "Field", e))(l || {});
+const a = {
+  Block: "border_clear",
+  Field: "grass"
+};
+export {
+  l as EntityType,
+  t as MessageType,
+  a as NotificationIcons,
+  r as OperationType
+};

package/dist/react-QiIgv49H.js

@@ -0,0 +1,27 @@
+import a from "react";
+const S = (t) => {
+  let e;
+  const n = /* @__PURE__ */ new Set(), c = (s, u) => {
+    const o = typeof s == "function" ? s(e) : s;
+    if (!Object.is(o, e)) {
+      const f = e;
+      e = u ?? (typeof o != "object" || o === null) ? o : Object.assign({}, e, o), n.forEach((g) => g(e, f));
+    }
+  }, i = () => e, r = { setState: c, getState: i, getInitialState: () => b, subscribe: (s) => (n.add(s), () => n.delete(s)) }, b = e = t(c, i, r);
+  return r;
+}, d = (t) => t ? S(t) : S, I = (t) => t;
+function j(t, e = I) {
+  const n = a.useSyncExternalStore(
+    t.subscribe,
+    () => e(t.getState()),
+    () => e(t.getInitialState())
+  );
+  return a.useDebugValue(n), n;
+}
+const l = (t) => {
+  const e = d(t), n = (c) => j(e, c);
+  return Object.assign(n, e), n;
+}, x = (t) => t ? l(t) : l;
+export {
+  x as c
+};

package/dist/stores/BasePropsStore.d.ts

@@ -0,0 +1,6 @@
+import { BaseProps } from '../types/BaseProps';
+type BasePropsStore = BaseProps & {
+    setBaseProps: (props: BaseProps) => void;
+};
+export declare const useBasePropsStore: import('zustand/react').UseBoundStore<import('zustand/vanilla').StoreApi<BasePropsStore>>;
+export {};

package/dist/stores/BasePropsStore.js

@@ -0,0 +1,7 @@
+import { c as o } from "../react-QiIgv49H.js";
+const t = o((e) => ({
+  setBaseProps: (s) => e({ ...s })
+}));
+export {
+  t as useBasePropsStore
+};

package/dist/stores/EnvironmentStore.d.ts

@@ -0,0 +1,8 @@
+import { CustomEnv, HortiViewEnvironments } from '../types/Environment';
+type EnvironmentStore = {
+    environment?: HortiViewEnvironments;
+    setEnvironment: (environment: HortiViewEnvironments) => void;
+    addEnvironment: (customEnv: CustomEnv) => void;
+};
+export declare const useEnvironmentStore: import('zustand/react').UseBoundStore<import('zustand/vanilla').StoreApi<EnvironmentStore>>;
+export {};

package/dist/stores/EnvironmentStore.js

@@ -0,0 +1,9 @@
+import { c as r } from "../react-QiIgv49H.js";
+const i = r((e) => ({
+  environment: void 0,
+  setEnvironment: (n) => e({ environment: n }),
+  addEnvironment: (n) => e((o) => ({ environment: { ...n, ...o.environment } }))
+}));
+export {
+  i as useEnvironmentStore
+};

package/dist/types/AppInsights.d.ts

@@ -0,0 +1,12 @@
+export type AppInsightsEvent = {
+    name: string;
+    properties?: AppInsightsProperties;
+};
+export type AppInsightsException = {
+    id?: string;
+    exception: Error;
+    properties?: AppInsightsProperties;
+};
+export type AppInsightsProperties = {
+    [key: string]: unknown;
+};

package/dist/types/AppInsights.js

@@ -0,0 +1 @@
+

package/dist/types/BaseProps.d.ts

@@ -0,0 +1,38 @@
+import { AppInsightsEvent, AppInsightsException, AppInsightsProperties } from './AppInsights';
+import { AllDropdownsData, CommonOption } from './CommonOptions';
+import { DeprecatedBaseProps } from './Deprecated';
+import { SystemMessage } from './SystemMessage';
+/**
+ * Properties that are passed to the Base component by the host application
+ * @param token authentication user token
+ * @param modulePermissionToken token for the module, to communicate with the module api
+ * @param moduleId id of the module
+ * @param basePath base path of the module (that is part of the URL and will be used for routing)
+ * @param organizationId id of the organization, where the module is used
+ * @param config configuration object that is used to configure the module
+ * @param navigateTo function to navigate to a specific route to trigger the routing in the host application
+ * @param addTranslation function to add a translation to the i18n instance of the host application
+ * @param currentNavigationPath current path of the route, that is changed, when the host application navigates
+ */
+export type BaseProps = DeprecatedBaseProps & {
+    modulePermissionToken?: string;
+    moduleId?: string;
+    organizationId?: string;
+    basePath?: string;
+    currentNavigationPath?: string;
+    sourcePath?: string | null;
+    currentLanguage?: string;
+    currentLanguageId?: string;
+    alertRules?: string;
+    commonOptions?: AllDropdownsData<CommonOption>["items"];
+    navigateInHortiview?: (path: string) => void;
+    addBreadcrumbTranslation?: (translation: {
+        key: string;
+        value: string;
+    }) => void;
+    showSnackbar?: (message: string, icon?: string) => void;
+    showMessage?: (message: SystemMessage) => void;
+    logEvent?: (event: AppInsightsEvent, customProperties?: AppInsightsProperties) => void;
+    logError?: (exception: AppInsightsException) => void;
+    throwError?: (message: string, code: number) => void;
+};

package/dist/types/BaseProps.js

@@ -0,0 +1 @@
+

package/dist/types/CommonOptions.d.ts

@@ -0,0 +1,61 @@
+export interface CommonOption {
+    id: string;
+    value?: string;
+    description?: string;
+    key?: string;
+    parent?: string;
+    icon?: string;
+}
+export interface CommonOptionOdata extends DropdownData<CommonOption> {
+}
+export interface AllCommonOptionsOdata extends AllDropdownsData<CommonOption> {
+}
+export interface AllDropdownsData<T> {
+    count: number;
+    totalCount: number;
+    items: Partial<Record<keyof typeof CommonOptionType, T[]>>;
+}
+export interface DropdownData<T> {
+    count: number;
+    totalCount: number;
+    items: T[];
+}
+export declare enum CommonOptionType {
+    Category = 0,
+    Requirement = 1,
+    Country = 2,
+    CountryCode = 3,
+    Crop = 4,
+    CropType = 5,
+    CropVariety = 6,
+    Currency = 7,
+    DataAreaEntity = 8,
+    DataAreaGroup = 9,
+    FieldAutomationLevelType = 10,
+    FieldCoverageType = 11,
+    FieldSecurityLevelType = 12,
+    FieldShadingType = 13,
+    FieldSowingType = 14,
+    FieldSubstrateType = 15,
+    FieldTechnologyType = 16,
+    Gender = 17,
+    GrowingEnvironment = 18,
+    Language = 19,
+    ModuleHostingType = 20,
+    ModuleType = 21,
+    ModuleState = 22,
+    Region = 23,
+    Rootstock = 24,
+    Salutation = 25,
+    SeasonState = 26,
+    SensorName = 27,
+    SensorState = 28,
+    TermAndCondition = 29,
+    PackageState = 30,
+    DocumentType = 31,
+    ModuleFederationType = 32,
+    PaymentCycle = 33,
+    PaymentMethod = 34,
+    PlantFamily = 35,
+    AlertCriteriaName = 36
+}

package/dist/types/CommonOptions.js

@@ -0,0 +1,4 @@
+var e = /* @__PURE__ */ ((a) => (a[a.Category = 0] = "Category", a[a.Requirement = 1] = "Requirement", a[a.Country = 2] = "Country", a[a.CountryCode = 3] = "CountryCode", a[a.Crop = 4] = "Crop", a[a.CropType = 5] = "CropType", a[a.CropVariety = 6] = "CropVariety", a[a.Currency = 7] = "Currency", a[a.DataAreaEntity = 8] = "DataAreaEntity", a[a.DataAreaGroup = 9] = "DataAreaGroup", a[a.FieldAutomationLevelType = 10] = "FieldAutomationLevelType", a[a.FieldCoverageType = 11] = "FieldCoverageType", a[a.FieldSecurityLevelType = 12] = "FieldSecurityLevelType", a[a.FieldShadingType = 13] = "FieldShadingType", a[a.FieldSowingType = 14] = "FieldSowingType", a[a.FieldSubstrateType = 15] = "FieldSubstrateType", a[a.FieldTechnologyType = 16] = "FieldTechnologyType", a[a.Gender = 17] = "Gender", a[a.GrowingEnvironment = 18] = "GrowingEnvironment", a[a.Language = 19] = "Language", a[a.ModuleHostingType = 20] = "ModuleHostingType", a[a.ModuleType = 21] = "ModuleType", a[a.ModuleState = 22] = "ModuleState", a[a.Region = 23] = "Region", a[a.Rootstock = 24] = "Rootstock", a[a.Salutation = 25] = "Salutation", a[a.SeasonState = 26] = "SeasonState", a[a.SensorName = 27] = "SensorName", a[a.SensorState = 28] = "SensorState", a[a.TermAndCondition = 29] = "TermAndCondition", a[a.PackageState = 30] = "PackageState", a[a.DocumentType = 31] = "DocumentType", a[a.ModuleFederationType = 32] = "ModuleFederationType", a[a.PaymentCycle = 33] = "PaymentCycle", a[a.PaymentMethod = 34] = "PaymentMethod", a[a.PlantFamily = 35] = "PlantFamily", a[a.AlertCriteriaName = 36] = "AlertCriteriaName", a))(e || {});
+export {
+  e as CommonOptionType
+};

package/dist/types/Deprecated.d.ts

@@ -0,0 +1,93 @@
+import { SystemMessage } from './SystemMessage';
+/**
+ * @deprecated should not be used anymore, will be removed in the near future (max 2 months)
+ */
+export type DeprecatedBaseProps = {
+    /**
+     * AlertRules, only for AlertRuleForcer to test
+     */
+    allAlertRules?: {
+        [moduleId: string]: string;
+    };
+    /**
+     * @deprecated use module-api and `modulePermissionToken` instead
+     */
+    token?: string;
+    /**
+     * @deprecated Not needed anymore
+     */
+    config?: RemoteComponentConfig;
+    /**
+     * @deprecated
+     */
+    addNotification?: (notification: OldAlertDto) => void;
+    /**
+     * @deprecated Use `showMessage` instead
+     */
+    addMessage?: (message: SystemMessage) => void;
+    /**
+     * @deprecated Use `addBreadcrumbTranslation` instead
+     */
+    addTranslation?: (translation: {
+        key: string;
+        value: string;
+    }) => void;
+    /**
+     * @deprecated Use `navigateInHortiview` instead
+     */
+    navigateTo?: (path: string) => void;
+};
+/**
+ * @deprecated should not be used anymore
+ */
+export type RemoteComponentConfig = {
+    isBaseModule?: boolean;
+    /**
+     * The relative path to the shared module, e.g. ./MyModule
+     */
+    module: string;
+    /**
+     * The path to the remote container entry. The url were the app is running or the path to location of the remote js file, e.g. http://localhost:3000/remoteEntry.js
+     */
+    path: string;
+    /**
+     * name of the remote app, like sprayingbook
+     */
+    scope: string;
+    /**
+     * name of the module
+     */
+    name?: string;
+    /**
+     * name of the icon
+     */
+    icon?: string;
+    /**
+     * if the module has an error
+     */
+    error?: boolean;
+    /**
+     * the short name of the module
+     */
+    shortName: string;
+    /**
+     * the id of the module - used as alias
+     */
+    id: string;
+};
+/**
+ * @deprecated should not be used anymore
+ */
+export type OldAlertDto = {
+    id: string;
+    farmOrganizationId: string;
+    moduleName: string;
+    criteriaIcon?: string | null | JSX.Element;
+    criteriaName: string;
+    description: string | JSX.Element;
+    timeStamp: Date;
+    isRead: boolean;
+    isSnoozed: boolean;
+    title: string;
+    link?: string;
+};

package/dist/types/Deprecated.js

@@ -0,0 +1 @@
+

package/dist/types/Environment.d.ts

@@ -0,0 +1,17 @@
+export interface HortiViewEnvironments {
+    COMMON_API: string;
+    MODULE_AUTH_API: string;
+    API_PREFIX: string;
+    ENVIRONMENT: string;
+    [customkey: string]: string;
+}
+export interface CustomWindow extends Window {
+    __env__?: HortiViewEnvironments;
+}
+export type Environments = 'DEVELOPMENT' | 'TEST' | 'BAYER-TEST' | 'BAYER-DEMO' | 'BAYER-PROD';
+export type EnvConfig = {
+    [key in Environments]: CustomEnv;
+};
+export type CustomEnv = {
+    [key: string]: string;
+};

package/dist/types/Environment.js

@@ -0,0 +1 @@
+

package/dist/types/ModuleApi.d.ts

@@ -0,0 +1,80 @@
+export type RegisterOption = {
+    moduleId: string;
+    registeredEntityName: string;
+    id: string;
+};
+export interface ModuleEntity {
+    season: Season | undefined;
+    blockPlantLayout: BlockPlantLayout | undefined;
+}
+/**
+ * the basic interface for the module apis farm organization entities
+ */
+export interface FarmOrgEntity {
+    block: Block | undefined;
+    farm: Farm | undefined;
+    field: Field | undefined;
+    farmOrg: {
+        id: string;
+    } | undefined;
+    irrigationStation: {
+        id: string;
+    } | undefined;
+    farmAlertRule: {
+        id: string;
+    } | undefined;
+    id: string;
+}
+export type Block = {
+    id: string;
+    fieldId: string;
+    blockName?: string;
+    shortName?: string;
+    area?: number;
+    fieldPercentage?: number;
+    tagID?: string;
+    description?: string;
+    length?: number;
+    width?: number;
+    rows?: number;
+    /** Stringyfied Position, only used in BE */
+    location?: string;
+    /**Position will be transformed from the Location string, only internally used*/
+    position?: {
+        row: number;
+        column: number;
+    };
+};
+/**
+ * farm dto (only necessary fields - for now)
+ */
+export interface Farm {
+    id: string;
+    farmName: string;
+    description: string;
+    fields: Field[];
+}
+export interface Field {
+    id: string;
+    name: string;
+    description: string;
+    farmId: string;
+    fieldCoverageId: string;
+    blocks: Block[];
+}
+export interface Season {
+    id: string;
+    cropSeasonName: string;
+    startDate: Date;
+    plantingDate: Date | null;
+    cropId: string;
+    cropTypeId: string;
+    cropVarietyId: string;
+    rootstockId: string;
+    farmId: string;
+    fieldId: string;
+    seasonStateId?: string;
+}
+export interface BlockPlantLayout {
+    id: string;
+}

package/dist/types/ModuleApi.js

@@ -0,0 +1 @@
+

package/dist/types/Requests.d.ts

@@ -0,0 +1,49 @@
+import { Expand, Filter, Select } from 'odata-query';
+export type RequestConfig = {
+    redirect: "follow";
+    credentials: "omit";
+    headers: RequestHeader;
+    method: "GET" | "POST" | "PATCH" | "DELETE" | "PUT";
+    body?: string | FormData;
+};
+export type RequestHeader = Headers & {
+    "Content-Type"?: "application/json";
+    orgId?: string;
+    Authorization?: string;
+    Permission?: string;
+    "Api-Version"?: "1.0" | "2.0";
+    languageId?: string;
+};
+export type InternalError = {
+    status: number;
+    title: string;
+    detail: string;
+    stack?: string;
+};
+export type Query = {
+    filter?: Filter<unknown>;
+    orderBy?: string[];
+    expand?: string | string[] | Expand<unknown>;
+    select?: Select<unknown>;
+    count?: boolean | Filter<unknown>;
+    pagination?: Pagination;
+    top?: number;
+    skip?: number;
+    overwrite?: string;
+};
+export type Pagination = {
+    top?: number;
+    skip?: number;
+    pageSize?: number;
+};
+export type BaseResponse<T> = T | T[] | {
+    value: T | T[];
+} | {
+    items: T | T[];
+};
+/**
+ * a universal selector that can be used for all fetches
+ * @param data - the data to select from
+ * @returns
+ */
+export declare const universalSelector: <T>(data: BaseResponse<T>) => T | T[];

package/dist/types/Requests.js

@@ -0,0 +1,4 @@
+const r = (e) => typeof e == "string" || typeof e == "boolean" || typeof e == "number" ? e : typeof e == "object" && "value" in e ? e.value : typeof e == "object" && "items" in e ? e.items : (Array.isArray(e), e);
+export {
+  r as universalSelector
+};

package/dist/types/SystemMessage.d.ts

@@ -0,0 +1,14 @@
+export type SystemMessage = {
+    id: string;
+    title: string;
+    description: string | JSX.Element;
+    timeStamp: string | Date;
+    isRead: boolean;
+    isSnoozed: boolean;
+    icon?: {
+        name: string;
+        danger?: boolean;
+    };
+    link?: string;
+    action?: () => void;
+};

package/dist/types/SystemMessage.js

@@ -0,0 +1 @@
+