@hortiview/modulebase 0.0.1

package/dist/hooks/useEntity.d.ts

@@ -0,0 +1,186 @@
+import { Block, BlockPlantLayout, Farm, FarmOrgEntity, Field, ModuleEntity, Season } from '../types/ModuleApi';
+type HortiviewDataAreaGroup = 'FarmOrganization' | 'FarmMember';
+type ModuleDataAreaGroup = 'ModuleDepended';
+type FarmOrganizationEntities = 'farms' | 'fields' | 'zones' | 'irrigation_stations' | 'farm_organizations' | 'alert_rules';
+type FarmMemberEntities = 'farm_members';
+type ModuleDependendEntities = 'Season' | 'BlockPlantLayout' | (string & {});
+type HortiviewDataAreaEntity<T extends HortiviewDataAreaGroup | ModuleDataAreaGroup> = T extends 'FarmOrganization' ? FarmOrganizationEntities : T extends 'FarmMember' ? FarmMemberEntities : T extends 'ModuleDepended' ? ModuleDependendEntities : never;
+type ResultMap<T extends FarmMemberEntities | FarmOrganizationEntities | ModuleDependendEntities> = T extends 'zones' ? Block : T extends 'fields' ? Field : T extends 'farms' ? Farm : T extends 'irrigation_stations' ? {
+    id: string;
+} : T extends 'farm_organizations' ? {
+    id: string;
+} : T extends 'alert_rules' ? {
+    id: string;
+} : T extends 'Season' ? Season : T extends 'BlockPlantLayout' ? BlockPlantLayout : never;
+export declare const FarmOrgEntitiesTypeResultMap: Record<FarmOrganizationEntities, string>;
+export declare const FarmMemberEntitiesTypeResultMap: Record<FarmMemberEntities, string>;
+export declare const ModuleDependedEntityTypeResultMap: Record<ModuleDependendEntities, string>;
+export declare const AllEntitiesTypeResultMap: {
+    Season: string;
+    BlockPlantLayout: string;
+    farm_members: string;
+    farms: string;
+    fields: string;
+    zones: string;
+    irrigation_stations: string;
+    farm_organizations: string;
+    alert_rules: string;
+};
+export declare const useEntity: <K extends HortiviewDataAreaGroup | ModuleDataAreaGroup, E extends HortiviewDataAreaEntity<K>>(group: K, entity: E) => {
+    data: ResultMap<E>[];
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: true;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: import('@tanstack/query-core').RefetchOptions) => Promise<import('@tanstack/query-core').QueryObserverResult<FarmOrgEntity[] | ModuleEntity[], Error>>;
+    fetchStatus: import('@tanstack/query-core').FetchStatus;
+    promise: Promise<FarmOrgEntity[] | ModuleEntity[]>;
+} | {
+    data: ResultMap<E>[];
+    error: null;
+    isError: false;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: false;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: import('@tanstack/query-core').RefetchOptions) => Promise<import('@tanstack/query-core').QueryObserverResult<FarmOrgEntity[] | ModuleEntity[], Error>>;
+    fetchStatus: import('@tanstack/query-core').FetchStatus;
+    promise: Promise<FarmOrgEntity[] | ModuleEntity[]>;
+} | {
+    data: ResultMap<E>[];
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: true;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: import('@tanstack/query-core').RefetchOptions) => Promise<import('@tanstack/query-core').QueryObserverResult<FarmOrgEntity[] | ModuleEntity[], Error>>;
+    fetchStatus: import('@tanstack/query-core').FetchStatus;
+    promise: Promise<FarmOrgEntity[] | ModuleEntity[]>;
+} | {
+    data: ResultMap<E>[];
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoading: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: import('@tanstack/query-core').RefetchOptions) => Promise<import('@tanstack/query-core').QueryObserverResult<FarmOrgEntity[] | ModuleEntity[], Error>>;
+    fetchStatus: import('@tanstack/query-core').FetchStatus;
+    promise: Promise<FarmOrgEntity[] | ModuleEntity[]>;
+} | {
+    data: ResultMap<E>[];
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isLoading: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: import('@tanstack/query-core').RefetchOptions) => Promise<import('@tanstack/query-core').QueryObserverResult<FarmOrgEntity[] | ModuleEntity[], Error>>;
+    fetchStatus: import('@tanstack/query-core').FetchStatus;
+    promise: Promise<FarmOrgEntity[] | ModuleEntity[]>;
+} | {
+    data: ResultMap<E>[];
+    isError: false;
+    error: null;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: true;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: import('@tanstack/query-core').RefetchOptions) => Promise<import('@tanstack/query-core').QueryObserverResult<FarmOrgEntity[] | ModuleEntity[], Error>>;
+    fetchStatus: import('@tanstack/query-core').FetchStatus;
+    promise: Promise<FarmOrgEntity[] | ModuleEntity[]>;
+};
+export {};

package/dist/hooks/useEntity.js

@@ -0,0 +1,58 @@
+import { u as f } from "../useQuery-znAyMQW1.js";
+import { useMemo as g } from "react";
+import { useBasePropsStore as l } from "../stores/BasePropsStore.js";
+import { universalSelector as p } from "../types/Requests.js";
+import { g as b, a as R } from "../fetches-DUCQo_6B.js";
+import { useOption as y, useModuleDependency as k } from "./useOption.js";
+const F = {
+  farms: "farm",
+  fields: "field",
+  zones: "block",
+  irrigation_stations: "irrigationStation",
+  farm_organizations: "farmOrg",
+  alert_rules: "farmAlertRule"
+}, Q = {
+  farm_members: "member"
+}, q = {
+  Season: "season",
+  BlockPlantLayout: "blockPlantLayout"
+}, A = {
+  ...F,
+  ...Q,
+  ...q
+}, B = (t, e) => {
+  const a = l((r) => r.moduleId), o = l((r) => r.organizationId), { data: i } = y("DataAreaGroup"), { data: u } = y("DataAreaEntity"), { data: n } = k(), d = t === "ModuleDepended", E = g(() => {
+    if (d)
+      return n ? n.find((s) => s.registeredEntityName === e)?.id : void 0;
+    if (!i || !u) return;
+    const r = i.find((s) => s.key === t)?.id;
+    return r ? u.find((s) => s.description === r && s.value === e)?.id : void 0;
+  }, [d, i, u, n, e, t]), c = D(a, E, o, d), M = (c.data ?? []).map((r) => {
+    const m = A[e];
+    return r[m];
+  });
+  return {
+    ...c,
+    data: M
+  };
+}, D = (t, e, a, o) => {
+  const i = f({
+    queryKey: [t, a, e],
+    queryFn: () => b(t ?? "", e ?? ""),
+    enabled: o && !!t && !!e && !!a,
+    select: (n) => p(n)
+  }), u = f({
+    queryKey: [t, a, e],
+    queryFn: () => R(t ?? "", e ?? ""),
+    enabled: !o && !!t && !!e && !!a,
+    select: (n) => p(n)
+  });
+  return o ? i : u;
+};
+export {
+  A as AllEntitiesTypeResultMap,
+  Q as FarmMemberEntitiesTypeResultMap,
+  F as FarmOrgEntitiesTypeResultMap,
+  q as ModuleDependedEntityTypeResultMap,
+  B as useEntity
+};

package/dist/hooks/useNavigate.d.ts

@@ -0,0 +1,5 @@
+/**
+ *
+ * @returns A function to navigate to a specific path
+ */
+export declare const useNavigate: () => (path: string) => void;

package/dist/hooks/useNavigate.js

@@ -0,0 +1,27 @@
+import { useEffect as o, useCallback as s } from "react";
+import { u as v } from "../chunk-IR6S3I6Y-BvQXS3A3.js";
+import { useBasePropsStore as r } from "../stores/BasePropsStore.js";
+const m = () => {
+  const e = r(
+    (t) => t.currentNavigationPath
+  ), a = r(
+    (t) => t.navigateTo
+  ), i = r(
+    (t) => t.navigateInHortiview
+  ), n = v();
+  return o(() => {
+    e && n(e, { replace: !0 });
+  }, [e, n]), s(
+    (t) => {
+      if (i) {
+        i(t);
+        return;
+      }
+      a && a(t);
+    },
+    [i, a]
+  );
+};
+export {
+  m as useNavigate
+};

package/dist/hooks/useOption.d.ts

@@ -0,0 +1,17 @@
+import { UseQueryResult } from '@tanstack/react-query';
+import { CommonOption, CommonOptionType } from '../types/CommonOptions';
+import { RegisterOption } from '../types/ModuleApi';
+/**
+ * Custom hook to fetch and manage options for a dropdown.
+ *
+ * @param dropdown - The key of the dropdown option to fetch from the common options.
+ * @returns A query object from `useQuery` containing the fetched dropdown options.
+ *
+ * This hook first attempts to retrieve the dropdown options from the HortiView-platform (module-property `commonOptions`).
+ * If the options are not available locally, it fetches them from a common API endpoint.
+ *
+ * The query key is set to the dropdown key, and the query function either resolves the local option
+ * or fetches it from the API. The result is then processed by a universal selector.
+ */
+export declare const useOption: (dropdown: keyof typeof CommonOptionType) => UseQueryResult<CommonOption[], Error>;
+export declare const useModuleDependency: () => UseQueryResult<RegisterOption[], Error>;

package/dist/hooks/useOption.js

@@ -0,0 +1,23 @@
+import { u as s } from "../useQuery-znAyMQW1.js";
+import { b as u, f as c, c as i } from "../fetches-DUCQo_6B.js";
+import { useBasePropsStore as t } from "../stores/BasePropsStore.js";
+import { universalSelector as m } from "../types/Requests.js";
+const y = (o) => {
+  const r = t((n) => n.commonOptions), e = u(r, o);
+  return s({
+    queryKey: [o],
+    queryFn: () => e ? Promise.resolve(e) : c(`${o}/dropdown`),
+    select: (n) => m(n)
+  });
+}, f = () => {
+  const o = t((e) => e.moduleId), r = t((e) => e.organizationId);
+  return s({
+    queryKey: [o, r],
+    queryFn: () => i(`ModuleDependencies/${o}`),
+    select: (e) => m(e)
+  });
+};
+export {
+  f as useModuleDependency,
+  y as useOption
+};

package/dist/hooks/useSignalRMessages.d.ts

@@ -0,0 +1,6 @@
+import { SignalRMessage } from '../provider/SignalR/signalR';
+/**
+ * hook to react on messages from signalR
+ * @param callback callback function to be called when a message is received
+ */
+export declare const useSignalRMessages: (callback: (message: SignalRMessage) => void) => void;

package/dist/hooks/useSignalRMessages.js

@@ -0,0 +1,13 @@
+import { SignalRModuleContext as i } from "../provider/SignalR/SignalRProvider.js";
+const s = (e) => {
+  i.useSignalREffect(
+    "ModuleApiPushNotification",
+    (...[o]) => {
+      e(o);
+    },
+    [e]
+  );
+};
+export {
+  s as useSignalRMessages
+};

package/dist/hooks/useStores.d.ts

@@ -0,0 +1,29 @@
+export declare const useBaseProps: () => Pick<import('../types/Deprecated').DeprecatedBaseProps & {
+    modulePermissionToken?: string;
+    moduleId?: string;
+    organizationId?: string;
+    basePath?: string;
+    currentNavigationPath?: string;
+    sourcePath?: string | null;
+    currentLanguage?: string;
+    currentLanguageId?: string;
+    alertRules?: string;
+    commonOptions?: import('../types/CommonOptions').AllDropdownsData<import('../types/CommonOptions').CommonOption>["items"];
+    navigateInHortiview?: (path: string) => void;
+    addBreadcrumbTranslation?: (translation: {
+        key: string;
+        value: string;
+    }) => void;
+    showSnackbar?: (message: string, icon?: string) => void;
+    showMessage?: (message: import('../types/SystemMessage').SystemMessage) => void;
+    logEvent?: (event: import('../types/AppInsights').AppInsightsEvent, customProperties?: import('../types/AppInsights').AppInsightsProperties) => void;
+    logError?: (exception: import('../types/AppInsights').AppInsightsException) => void;
+    throwError?: (message: string, code: number) => void;
+} & {
+    setBaseProps: (props: import('../main').BaseProps) => void;
+}, keyof import('../types/Deprecated').DeprecatedBaseProps | "modulePermissionToken" | "moduleId" | "organizationId" | "basePath" | "currentNavigationPath" | "sourcePath" | "currentLanguage" | "currentLanguageId" | "alertRules" | "commonOptions" | "navigateInHortiview" | "addBreadcrumbTranslation" | "showSnackbar" | "showMessage" | "logEvent" | "logError" | "throwError">;
+export declare const useConfig: () => Pick<{
+    environment?: import('../types/Environment').HortiViewEnvironments;
+    setEnvironment: (environment: import('../types/Environment').HortiViewEnvironments) => void;
+    addEnvironment: (customEnv: import('../types/Environment').CustomEnv) => void;
+}, "environment">;