@hortiview/modulebase 0.0.16348 → 0.0.20524

package/dist/lib/constants.d.ts

@@ -1,6 +1,5 @@
 import { BaseProps } from './types/BaseProps';
 export declare const REQUIRED_PROPS: (keyof BaseProps)[];
-export declare const RETRIES = 1;
 export declare const RETRY_HTTP_STATUS_CODES: {
     /**
      * The server timed out waiting for the request.

package/dist/lib/enum/ActionStorage.d.ts

@@ -0,0 +1,7 @@
+export declare enum ActionState {
+    ENQUEUED = "ENQUEUED",
+    PENDING = "PENDING",
+    RESOLVING = "RESOLVING",
+    SUCCESS = "RESOLVED",
+    ERROR = "REJECTED"
+}

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

@@ -1,7 +1,10 @@
-export declare const useCustom: <T>({ endpoint, queryKey, token, selector, enabled, }: {
+type UseCustomParams<T> = {
     endpoint: string;
     queryKey: (string | undefined)[];
     token?: string;
-    selector?: (data: any) => T;
+    selector?: (data: unknown) => T;
     enabled?: boolean;
-}) => import('@tanstack/react-query').UseQueryResult<T, Error>;
+    noAuth?: boolean;
+};
+export declare const useCustom: <T>({ endpoint, queryKey, token, selector, enabled, noAuth, }: UseCustomParams<T>) => import('@tanstack/react-query').UseQueryResult<import('@tanstack/query-core').NoInfer<T>, Error>;
+export {};

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

@@ -1,8 +1,14 @@
 import { UseMutationResult } from '@tanstack/react-query';
 import { BaseResponse, httpMethod } from '../types/Requests';
-export declare const useCustomMutation: <Input, Output>({ endpoint, method, token, headers, }: {
+export type UseCustomMutationParams = {
     endpoint: string;
-    method: Omit<httpMethod, "GET">;
+    method: Omit<httpMethod, 'GET'>;
     token?: string;
     headers?: Headers;
-}) => UseMutationResult<BaseResponse<Output>, Error, Input, unknown>;
+    noAuth?: boolean;
+};
+export type CustomMutationInput<Input> = {
+    input: Input;
+    replaceEndpointWith?: string;
+};
+export declare const useCustomMutation: <Input, Output>({ endpoint, method, token, headers, noAuth, }: UseCustomMutationParams) => UseMutationResult<BaseResponse<Output>, Error, CustomMutationInput<Input>, unknown>;

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

@@ -1,25 +1,5 @@
-import { Block, BlockPlantLayout, Farm, FarmAlertRule, FarmOrganization, FarmOrgEntity, Field, IrrigationStation, 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' ? IrrigationStation : T extends 'farm_organizations' ? FarmOrganization : T extends 'alert_rules' ? FarmAlertRule : T extends 'Season' ? Season : T extends 'BlockPlantLayout' ? BlockPlantLayout : unknown;
-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;
-};
+import { HortiviewDataAreaEntity, HortiviewDataAreaGroup, ModuleDataAreaGroup, ResultMap } from '../types/Entities';
+import { FarmOrgEntity, ModuleEntity } from '../types/ModuleApi';
 export declare const useEntity: <K extends HortiviewDataAreaGroup | ModuleDataAreaGroup, E extends HortiviewDataAreaEntity<K>>(group: K, entity: E, enabled?: boolean, shouldGetRawData?: boolean) => {
     data: ResultMap<E>[];
     error: Error;
@@ -43,6 +23,7 @@ export declare const useEntity: <K extends HortiviewDataAreaGroup | ModuleDataAr
     isPaused: boolean;
     isRefetching: boolean;
     isStale: boolean;
+    isEnabled: 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[]>;
@@ -69,6 +50,7 @@ export declare const useEntity: <K extends HortiviewDataAreaGroup | ModuleDataAr
     isPaused: boolean;
     isRefetching: boolean;
     isStale: boolean;
+    isEnabled: 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[]>;
@@ -95,6 +77,7 @@ export declare const useEntity: <K extends HortiviewDataAreaGroup | ModuleDataAr
     isPaused: boolean;
     isRefetching: boolean;
     isStale: boolean;
+    isEnabled: 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[]>;
@@ -121,6 +104,7 @@ export declare const useEntity: <K extends HortiviewDataAreaGroup | ModuleDataAr
     isPaused: boolean;
     isRefetching: boolean;
     isStale: boolean;
+    isEnabled: 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[]>;
@@ -147,6 +131,7 @@ export declare const useEntity: <K extends HortiviewDataAreaGroup | ModuleDataAr
     isPaused: boolean;
     isRefetching: boolean;
     isStale: boolean;
+    isEnabled: 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[]>;
@@ -173,8 +158,15 @@ export declare const useEntity: <K extends HortiviewDataAreaGroup | ModuleDataAr
     isPaused: boolean;
     isRefetching: boolean;
     isStale: boolean;
+    isEnabled: 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 {};
+/**
+ * Returns a function to get the entity id based on the group and entity name.
+ * Needs to return a function to get an entity id out of a list of entities, see useOffline
+ * @param group
+ * @returns
+ */
+export declare const useEntityId: (group: HortiviewDataAreaGroup | ModuleDataAreaGroup) => ((entity: HortiviewDataAreaEntity<typeof group>) => string | undefined);

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

@@ -0,0 +1,15 @@
+import { HortiviewDataAreaEntity, HortiviewDataAreaGroup, ModuleDataAreaGroup } from '../types/Entities';
+export declare const useOffline: () => {
+    prefetchCustom: <T>({ queryKey, endpoint, token, noAuth, }: {
+        queryKey: (string | undefined)[];
+        endpoint: string;
+        token?: string;
+        noAuth?: boolean;
+        selector?: (data: unknown) => T;
+    }) => Promise<void>;
+    prefetch: <T>({ queryKey, queryFn, }: {
+        queryKey: (string | undefined)[];
+        queryFn: () => Promise<T>;
+    }) => Promise<void>;
+    usePrefetchEntity: <K extends HortiviewDataAreaGroup | ModuleDataAreaGroup, E extends HortiviewDataAreaEntity<K>>(group: K, ...entities: E[]) => "Prefetch failed: no moduleId" | undefined;
+};

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

@@ -1,4 +1,5 @@
 export declare const useBaseProps: () => Pick<import('../main').DeprecatedBaseProps & {
+    isOnline?: boolean;
     modulePermissionToken?: string;
     moduleId?: string;
     organizationId?: string;
@@ -7,8 +8,8 @@ export declare const useBaseProps: () => Pick<import('../main').DeprecatedBasePr
     sourcePath?: string | null;
     currentLanguage?: string;
     currentLanguageId?: string;
-    alertRules?: string;
     commonOptions?: import('../main').AllDropdownsData<import('../main').CommonOption>["items"];
+    refreshModulePermissionToken?: () => Promise<string | undefined>;
     riseNotification?: (message: import('../main').AlertServiceBusMessage) => Promise<unknown>;
     navigateInHortiview?: (path: string) => void;
     addBreadcrumbTranslation?: (translation: {
@@ -17,13 +18,20 @@ export declare const useBaseProps: () => Pick<import('../main').DeprecatedBasePr
     }, hide?: boolean) => void;
     showSnackbar?: (message: string, icon?: string) => void;
     showMessage?: (message: import('../main').SystemMessage) => void;
+    pendingActions?: import('../main').ActionItem[];
+    getPendingActions?: () => import('../main').ActionItem[];
+    resolveAction?: (key: string, result?: string) => void;
+    startResolvingAction?: (key: string) => void;
+    addAction?: (functionName: string, args: unknown[], key?: string) => void;
+    getActions?: () => import('../main').ActionItem[];
+    getActionByKey?: (key: string) => import('../main').ActionItem | undefined;
     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" | "environmentVariables">;
+}, keyof import('../main').DeprecatedBaseProps | "isOnline" | "modulePermissionToken" | "moduleId" | "organizationId" | "basePath" | "currentNavigationPath" | "sourcePath" | "currentLanguage" | "currentLanguageId" | "commonOptions" | "refreshModulePermissionToken" | "riseNotification" | "navigateInHortiview" | "addBreadcrumbTranslation" | "showSnackbar" | "showMessage" | "pendingActions" | "getPendingActions" | "resolveAction" | "startResolvingAction" | "addAction" | "getActions" | "getActionByKey" | "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

@@ -10,7 +10,10 @@ export type * from './types/ModuleApi';
 export type * from './types/Requests';
 export type * from './types/ServiceBus';
 export type * from './types/SystemMessage';
+export type * from './types/ActionStorage';
+export * from './enum/ActionStorage';
 export { useBreadcrumbTranslation } from './hooks/useBreadcrumbTranslation';
+export { useOffline } from './hooks/useOffline';
 export { useSignalRMessages } from './hooks/useSignalRMessages';
 export * from './module-router';
 export { useNavigate } from './module-router';
@@ -20,5 +23,6 @@ export { useCustomMutation } from './hooks/useCustomMutation';
 export { useEntity } from './hooks/useEntity';
 export { useOption } from './hooks/useOption';
 export { useNotification, useServiceBus } from './hooks/useServiceBus';
+export { QueryClient, useInfiniteQuery, useMutation, useQuery, useQueryClient } from '@tanstack/react-query';
 export { mutateOnCustomApi } from './utils/fetches';
 export * from './utils/helper';

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

@@ -0,0 +1,8 @@
+import { ActionState } from '../enum/ActionStorage';
+export type ActionItem = {
+    functionName: string;
+    args: unknown[];
+    dateAdded: string;
+    state: ActionState;
+    key: string;
+};

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

@@ -1,3 +1,4 @@
+import { ActionItem } from './ActionStorage';
 import { AppInsightsEvent, AppInsightsException, AppInsightsProperties } from './AppInsights';
 import { AllDropdownsData, CommonOption } from './CommonOptions';
 import { DeprecatedBaseProps } from './Deprecated';
@@ -17,6 +18,7 @@ import { SystemMessage } from './SystemMessage';
  * @param currentNavigationPath current path of the route, that is changed, when the host application navigates
  */
 export type BaseProps = DeprecatedBaseProps & {
+    isOnline?: boolean;
     modulePermissionToken?: string;
     moduleId?: string;
     organizationId?: string;
@@ -25,8 +27,8 @@ export type BaseProps = DeprecatedBaseProps & {
     sourcePath?: string | null;
     currentLanguage?: string;
     currentLanguageId?: string;
-    alertRules?: string;
     commonOptions?: AllDropdownsData<CommonOption>['items'];
+    refreshModulePermissionToken?: () => Promise<string | undefined>;
     riseNotification?: (message: AlertServiceBusMessage) => Promise<unknown>;
     navigateInHortiview?: (path: string) => void;
     addBreadcrumbTranslation?: (translation: {
@@ -35,6 +37,13 @@ export type BaseProps = DeprecatedBaseProps & {
     }, hide?: boolean) => void;
     showSnackbar?: (message: string, icon?: string) => void;
     showMessage?: (message: SystemMessage) => void;
+    pendingActions?: ActionItem[];
+    getPendingActions?: () => ActionItem[];
+    resolveAction?: (key: string, result?: string) => void;
+    startResolvingAction?: (key: string) => void;
+    addAction?: (functionName: string, args: unknown[], key?: string) => void;
+    getActions?: () => ActionItem[];
+    getActionByKey?: (key: string) => ActionItem | undefined;
     logEvent?: (event: AppInsightsEvent, customProperties?: AppInsightsProperties) => void;
     logError?: (exception: AppInsightsException) => void;
     throwError?: (message: string, code: number) => void;

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

@@ -42,6 +42,10 @@ export type DeprecatedBaseProps = {
      * @deprecated Use `navigateInHortiview` instead
      */
     navigateTo?: (path: string) => void;
+    /**
+     * @deprecated modules need to call their own rules directly
+     */
+    alertRules?: string;
 };
 /**
  * @deprecated should not be used anymore

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

@@ -0,0 +1,22 @@
+import { Block, BlockPlantLayout, Farm, FarmAlertRule, FarmOrganization, Field, IrrigationStation, Season } from '../types/ModuleApi';
+export type HortiviewDataAreaGroup = 'FarmOrganization' | 'FarmMember';
+export type ModuleDataAreaGroup = 'ModuleDepended';
+export type FarmOrganizationEntities = 'farms' | 'fields' | 'zones' | 'irrigation_stations' | 'farm_organizations' | 'alert_rules';
+export type FarmMemberEntities = 'farm_members';
+export type ModuleDependendEntities = 'Season' | 'BlockPlantLayout' | (string & {});
+export type HortiviewDataAreaEntity<T extends HortiviewDataAreaGroup | ModuleDataAreaGroup> = T extends 'FarmOrganization' ? FarmOrganizationEntities : T extends 'FarmMember' ? FarmMemberEntities : T extends 'ModuleDepended' ? ModuleDependendEntities : never;
+export type ResultMap<T extends FarmMemberEntities | FarmOrganizationEntities | ModuleDependendEntities> = T extends 'zones' ? Block : T extends 'fields' ? Field : T extends 'farms' ? Farm : T extends 'irrigation_stations' ? IrrigationStation : T extends 'farm_organizations' ? FarmOrganization : T extends 'alert_rules' ? FarmAlertRule : T extends 'Season' ? Season : T extends 'BlockPlantLayout' ? BlockPlantLayout : unknown;
+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;
+};

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

@@ -1,4 +1,3 @@
-import { Expand, Filter, Select } from 'odata-query';
 export type RequestConfig = {
     redirect: 'follow';
     credentials: 'omit';
@@ -20,22 +19,6 @@ export type InternalError = {
     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[];
 } | {

package/dist/lib/utils/IndexedDbService.d.ts

@@ -0,0 +1,33 @@
+/**
+ * The interface for the IndexedDb communication object.
+ * It is used in the TanstackQuery Persistent Query Provider.
+ *
+ * @see TanstackQuery {@link https://tanstack.com/query}
+ */
+interface IndexedDbStorage {
+    /**
+     * the getter takes a key and returns the value behind the key from the IndexedDB
+     * @param key
+     * @returns a Promise containing the data behind the key or null
+     */
+    getItem: (key: string) => Promise<string | undefined | null>;
+    /**
+     * the setter adds some values to the IndexedDB with the given key as the key in the IndexedDB.
+     * @param key
+     * @returns
+     */
+    setItem: (key: string, value: string) => Promise<unknown>;
+    /**
+     * the remove fundtion takes a key and deletes the value behind the key from the IndexedDB
+     * @param key
+     * @returns
+     */
+    removeItem: (key: string) => Promise<void>;
+}
+/**
+ * This object is the implementation of the {@link IndexedDbStorage} interface using the idb-keyval package
+ *
+ * @see idb-keyval {@link https://www.npmjs.com/package/idb-keyval?activeTab=readme}
+ */
+export declare const indexedDbStorage: IndexedDbStorage;
+export {};

package/dist/lib/utils/api.d.ts

@@ -1,20 +1,13 @@
-import { BaseResponse, httpMethod, Query, RequestConfig } from '../types/Requests';
-export declare const getConfig: (token: string, organizationId?: string, languageId?: string, method?: httpMethod, customHeaders?: Headers) => RequestConfig;
+import { BaseResponse, httpMethod, RequestConfig } from '../types/Requests';
+export declare const getConfig: (token?: string, organizationId?: string, languageId?: string, method?: httpMethod, customHeaders?: Headers) => RequestConfig;
 /**
- * a fetch function to handle requests and returns the response. if the response is unauthorized, it tries to refresh the token and retries the request
+ * a fetch function to handle requests and returns the response. if the response is unauthorized, it tries to refresh the module permission token and retries the request.
+ * During the refresh process, all the incoming requests will be put on hold (sleep) until the process is finished to prevent multiple parallel token refresh calls.
+ * if the token refresh fails, all the incoming requests will throw an unauthorized error until a successful token refresh happens.
  * @param url - the complete url build by {@link prependBaseUrl}
  * @param config - the request config including auth headers
- * @param throwFullMessage - if the full error message should be thrown or only the message behind the status code
- * @param withResponseHandling - if the response should be handled by the {@link handleResponse} method or not ("hide" the error)
- * @param tries - the number of retries, default is 1
+ * @param isRetryEnabled - if the request should be retried on network errors or specific HTTP status codes
  * @returns
  */
-export declare const fetchWithErrorHandling: <T>(url: string, config: RequestConfig, tries?: number, withResponseHandling?: boolean) => Promise<BaseResponse<T>>;
+export declare const fetchWithErrorHandling: <T>(url: string, config: RequestConfig, isRetryEnabled?: boolean) => Promise<BaseResponse<T>>;
 export declare const handleResponse: (response: Response) => Promise<any>;
-/**
- * a helper function to format the query string
- * @param query - the query object to format
- * @param withApiVersion - if the api version should be added to the query string
- * @returns
- */
-export declare const formatQuery: (query?: Query, withApiVersion?: boolean) => string;

package/dist/lib/utils/baseFetches.d.ts

@@ -1,4 +1,4 @@
-import { BaseResponse, httpMethod, Query } from '../types/Requests';
+import { BaseResponse, httpMethod } from '../types/Requests';
 /**
  * a fetch function to handle CUD requests and returns the response.
  * @param url endpoint to fetch (CUD) data from
@@ -8,7 +8,7 @@ import { BaseResponse, httpMethod, Query } from '../types/Requests';
  * @param headers (optional) custom headers to use
  * @returns Promise<BaseResponse<R>> response from the fetch
  */
-export declare const baseMutation: <T, R>(url: string, data: T, method: Omit<httpMethod, "GET">, customToken?: string, headers?: Headers) => Promise<BaseResponse<R>>;
+export declare const baseMutation: <T, R>(url: string, data: T, method: Omit<httpMethod, "GET">, customToken?: string, headers?: Headers, noAuth?: boolean) => Promise<BaseResponse<R>>;
 /**
  * a fetch function to handle GET requests and returns the response.
  * @param url url to GET data from
@@ -16,4 +16,5 @@ export declare const baseMutation: <T, R>(url: string, data: T, method: Omit<htt
  * @param customToken token to use (default is the modulePermissionToken)
  * @returns Promise<BaseResponse<T>> response from the fetch
  */
-export declare const baseFetch: <T>(url: string, query: Query, customToken?: string) => Promise<BaseResponse<T>>;
+export declare const baseFetch: <T>(url: string, //endpoint to fetch modulApi/getEntities/{moduleId}
+customToken?: string, noAuth?: boolean) => Promise<BaseResponse<T>>;

package/dist/lib/utils/fetches.d.ts

@@ -1,5 +1,5 @@
 import { httpMethod } from '../types/Requests';
-export declare const mutateOnCustomApi: <T, R>(endpoint: string, data: T, method?: Omit<httpMethod, "GET">, token?: string, headers?: Headers) => Promise<import('../main').BaseResponse<R>>;
+export declare const mutateOnCustomApi: <T, R>(endpoint: string, data: T, method?: Omit<httpMethod, "GET">, token?: string, headers?: Headers, noAuth?: boolean) => Promise<import('../main').BaseResponse<R>>;
 /**
  * a fetch function to get a certain farmorganization entity from the moduleApi (will be used in useEntity)
  * @param moduleId moduleID to get the entity from
@@ -28,7 +28,7 @@ export declare const getModuleDependedEntitiesRaw: <T>(moduleId: string, entityI
  * @param token token to use (default is the modulePermissionToken)
  * @returns Promise<BaseResponse<T>> response from the fetch
  */
-export declare const fetchFromCustomApi: <T>(endpoint: string, token?: string) => Promise<import('../main').BaseResponse<T>>;
+export declare const fetchFromCustomApi: <T>(endpoint: string, token?: string, noAuth?: boolean) => Promise<import('../main').BaseResponse<T>>;
 /**
  *  a fetch function to handle GET requests and returns the response.
  * @param endpoint endpoint of moduleApi to fetch data from

package/dist/lib/utils/helper.d.ts

@@ -26,3 +26,4 @@ export declare const checkVersion: (environmentVariables?: HortiViewEnvironments
  */
 export declare const universalSelector: <T>(data: BaseResponse<T>) => T | T[];
 export declare const checkConfig: <T extends EnvConfig>(config: T & Record<Exclude<keyof T, Environments>, never>) => T;
+export declare const getModuleQueryKey: (queryKey: (string | undefined)[]) => (string | undefined)[];