@hortiview/shared-components 2.13.0 → 2.15.0

package/dist/components/GenericTable/Mobile/GenericCard.js

@@ -4,7 +4,7 @@ import "../../../index.es-CeQB6igi.js";
 import "../../../index.es-SjZ_-d7U.js";
 import "react";
 import "../../OverflowTooltip/OverflowTooltip.js";
-import { G } from "../../../GenericCard-CeqYrtLH.js";
+import { G } from "../../../GenericCard-IWX-Bmb_.js";
 export {
   G as GenericCard
 };

package/dist/components/GenericTable/Mobile/GenericCard.test.js

@@ -1,6 +1,6 @@
 import { jsx as n } from "react/jsx-runtime";
 import { a as c, s as o } from "../../../react.esm-Bm0cAgpZ.js";
-import { G as i } from "../../../GenericCard-CeqYrtLH.js";
+import { G as i } from "../../../GenericCard-IWX-Bmb_.js";
 import { d as m, t as s, g as e } from "../../../vi.bdSIJ99Y-B308Q-4w.js";
 m("GenericCard", () => {
   const d = {

package/dist/components/GenericTable/Mobile/GenericCardList.js

@@ -1,25 +1,25 @@
 import { jsx as r } from "react/jsx-runtime";
-import { G as c } from "../../../index.es-oxil0uFe.js";
-import { P as l } from "../../../index.es-BanVdXEd.js";
+import { G as l } from "../../../index.es-oxil0uFe.js";
+import { P as c } from "../../../index.es-BanVdXEd.js";
 import { a as o } from "../../../index.es-SjZ_-d7U.js";
-import { s as i, G as m } from "../../../GenericCard-CeqYrtLH.js";
-const u = ({
+import { s as e, G as m } from "../../../GenericCard-IWX-Bmb_.js";
+const g = ({
   columns: n,
-  data: e,
+  data: t,
   hiddenColumns: a = [],
-  noContentText: d
-}) => e?.length === 0 ? /* @__PURE__ */ r("div", { "data-testid": "empty-generic-card-list", className: i.emptyContainer, children: /* @__PURE__ */ r(l, { variant: "standard", style: { textAlign: "center" }, className: i.empty, children: /* @__PURE__ */ r(o, { children: d }) }) }) : (
+  noContentText: s
+}) => t?.length === 0 ? /* @__PURE__ */ r("div", { "data-testid": "empty-generic-card-list", className: e.emptyContainer, children: /* @__PURE__ */ r(c, { variant: "standard", style: { textAlign: "center" }, className: e.empty, children: /* @__PURE__ */ r(o, { children: s }) }) }) : (
   // needs the div to surround the Group by an element with display: block to avoid visual errors
-  /* @__PURE__ */ r("div", { "data-testid": "generic-card-list", style: { width: "100%" }, children: /* @__PURE__ */ r(c, { fullWidth: !0, direction: "vertical", primaryAlign: "center", secondaryAlign: "center", children: e?.map((t, s) => /* @__PURE__ */ r(
+  /* @__PURE__ */ r("div", { className: e.fullWidth, children: /* @__PURE__ */ r(l, { fullWidth: !0, direction: "vertical", primaryAlign: "center", secondaryAlign: "center", children: t?.map((i, d) => /* @__PURE__ */ r(
     m,
     {
-      item: t,
+      item: i,
       columns: n,
       hiddenColumns: a
     },
-    t.id ?? s
+    i.id ?? d
   )) }) })
 );
 export {
-  u as GenericCardList
+  g as GenericCardList
 };

package/dist/components/PermissionChecks/PermissionService.d.ts

@@ -1,5 +1,11 @@
 import { HVPermissions, PermissionsByEntity } from '../../types/Permission';
 
+type EntityIdType = 'General' | 'Plattform' | (string & Record<never, never>);
+export type IsAllowedProps = {
+    neededPermissions: HVPermissions[];
+    entityIds: EntityIdType | EntityIdType[];
+    areAllPermissionsNeeded?: boolean;
+};
 /**
  * Hook to check if the current user has the required permissions.
  * Must be used within a PermissionProvider.
@@ -7,18 +13,18 @@ import { HVPermissions, PermissionsByEntity } from '../../types/Permission';
  * @example
  * ```tsx
  * const isAllowed = useIsAllowed();
- * const canEdit = isAllowed([Permission.BlocksUpdate], farmId);
+ * const canEdit = isAllowed({ neededPermissions: [Permission.BlocksUpdate], entityIds: farmId });
+ * const canEditMultiple = isAllowed({ neededPermissions: [Permission.BlocksUpdate], entityIds: [farmId1, farmId2] });
  * ```
  *
- * If the given entity id not matches with an userpermissions object entry, false is returned.
- * Otherwise it checks the given neededPermission against the users permissions for the found entity.
- * @param neededPermissions the permissions needed at the point the method is called
- * @param entityId - the entity id, the permission is for (FarmOrganizationId, VendorOrganizationId or FarmId)
- * @param needAllPermissions a flag to determine if all given permissions are needed (AND) or only one of them (OR)
- * @param currentUserPermissions - optional parameter to pass the user permissions directly, e.g. after a permission update
+ * If the given entity ids do not match any user permissions object entry, false is returned.
+ * Otherwise it checks the given neededPermissions against the user's permissions for the found entities.
+ * @param neededPermissions - the permissions needed at the point the method is called
+ * @param entityIds - the entity id(s), the permission is for (FarmOrganizationId, VendorOrganizationId or FarmId)
+ * @param areAllPermissionsNeeded - a flag to determine if all given permissions are needed (AND) or only one of them (OR)
  * @returns true if the user has one of the (OR) or all (AND) needed permissions, false otherwise
  */
-export declare const useIsAllowed: () => (neededPermissions: HVPermissions[], entityId: string | undefined, needAllPermissions?: boolean, currentUserPermissions?: PermissionsByEntity) => boolean;
+export declare const useIsAllowed: () => ({ neededPermissions, entityIds, areAllPermissionsNeeded }: IsAllowedProps) => boolean;
 /**
  * Extracts and parses permissions from a module permission token.
  *
@@ -33,3 +39,4 @@ export declare const useIsAllowed: () => (neededPermissions: HVPermissions[], en
 export declare const getPermissionsFromModulePermissionToken: ({ permissionToken, }: {
     permissionToken?: string;
 }) => PermissionsByEntity;
+export {};

package/dist/components/PermissionChecks/PermissionService.js

@@ -1,28 +1,26 @@
-import { j as l } from "../../index-CuHybtft.js";
-import { useCallback as a } from "react";
-import { usePermissionContext as c } from "../SharedComponentsPermissionProvider/PermissionContext.js";
-const y = () => {
-  const { userPermissions: s, activeOrganizationId: e } = c();
-  return a(
-    (t, o, m = !1, u) => {
-      if (t.length === 0) return !0;
-      const r = u ?? s, n = [
-        ...r?.[o ?? e ?? ""] ?? [],
-        ...r?.General ?? [],
-        ...r?.Plattform ?? []
-      ];
-      return n ? m ? t.every((i) => n.includes(i)) : t.some((i) => n.includes(i)) : !1;
+import { j as i } from "../../index-CuHybtft.js";
+import { useCallback as l } from "react";
+import { usePermissionContext as u } from "../SharedComponentsPermissionProvider/PermissionContext.js";
+const f = () => {
+  const { userPermissions: s } = u();
+  return l(
+    ({ neededPermissions: r, entityIds: e, areAllPermissionsNeeded: n = !1 }) => {
+      if (r.length === 0) return !0;
+      const t = (Array.isArray(e) ? e : [e]).flatMap(
+        (o) => s?.[o] ?? []
+      );
+      return t.length === 0 ? !1 : n ? r.every((o) => t.includes(o)) : r.some((o) => t.includes(o));
     },
-    [e, s]
+    [s]
   );
-}, I = ({
+}, p = ({
   permissionToken: s
 }) => {
   if (!s || s === "") return;
-  const e = l(s), t = e.ModuleRolesAndPermissions.FarmOrganizationId, o = e.ModuleRolesAndPermissions.ExecuteEndpointPermissionNames;
-  return { [t]: [...o] };
+  const r = i(s), e = r.ModuleRolesAndPermissions.FarmOrganizationId, n = r.ModuleRolesAndPermissions.ExecuteEndpointPermissionNames;
+  return { [e]: n };
 };
 export {
-  I as getPermissionsFromModulePermissionToken,
-  y as useIsAllowed
+  p as getPermissionsFromModulePermissionToken,
+  f as useIsAllowed
 };

package/dist/components/PermissionChecks/PermissionService.test.js

@@ -1,10 +1,10 @@
-import { r as m } from "../../react.esm-Bm0cAgpZ.js";
-import { createPermissionWrapper as l } from "../../test-utils.js";
+import { r as d } from "../../react.esm-Bm0cAgpZ.js";
+import { createPermissionWrapper as m } from "../../test-utils.js";
 import { HVMainPermissions as i } from "../../types/Permission.js";
-import { useIsAllowed as u, getPermissionsFromModulePermissionToken as a } from "./PermissionService.js";
-import { d, t, g as o } from "../../vi.bdSIJ99Y-B308Q-4w.js";
-d("Test PermissionService", () => {
-  d("Test isAllowed", () => {
+import { useIsAllowed as l, getPermissionsFromModulePermissionToken as a } from "./PermissionService.js";
+import { d as u, t, g as o } from "../../vi.bdSIJ99Y-B308Q-4w.js";
+u("Test PermissionService", () => {
+  u("Test isAllowed", () => {
     const n = [
       i.FarmOrganizationsRead,
       i.FarmOrganizationsUpdate
@@ -12,8 +12,8 @@ d("Test PermissionService", () => {
     t("should return true if the user has all (AND) needed permissions", () => {
       const {
         result: { current: s }
-      } = m(() => u(), {
-        wrapper: l({
+      } = d(() => l(), {
+        wrapper: m({
           userPermissions: {
             [e]: [
               i.FarmOrganizationsRead,
@@ -21,43 +21,51 @@ d("Test PermissionService", () => {
             ]
           }
         })
-      }), r = s(n, e, !0);
+      }), r = s({
+        neededPermissions: n,
+        entityIds: e,
+        areAllPermissionsNeeded: !0
+      });
       o(r).toBe(!0);
     }), t("should return true if the user has one of the (OR) needed permissions", () => {
       const {
         result: { current: s }
-      } = m(() => u(), {
-        wrapper: l({
+      } = d(() => l(), {
+        wrapper: m({
           userPermissions: {
             [e]: [i.BlocksCreate, i.FarmOrganizationsRead]
           }
         })
-      }), r = s(n, e);
+      }), r = s({ neededPermissions: n, entityIds: e });
       o(r).toBe(!0);
     }), t("should return true if neededPermissions array is empty", () => {
       const {
         result: { current: s }
-      } = m(() => u(), {
-        wrapper: l({
+      } = d(() => l(), {
+        wrapper: m({
           userPermissions: {
             [e]: []
           }
         })
-      }), r = s([], e, !0);
+      }), r = s({
+        neededPermissions: [],
+        entityIds: e,
+        areAllPermissionsNeeded: !0
+      });
       o(r).toBe(!0);
     }), t("should return false if given entity id not matching with any userPermissions entry", () => {
       const {
         result: { current: s }
-      } = m(() => u(), {
-        wrapper: l({
+      } = d(() => l(), {
+        wrapper: m({
           userPermissions: {
             456: [i.BlocksCreate]
           }
         })
-      }), r = s(n, e);
+      }), r = s({ neededPermissions: n, entityIds: e });
       o(r).toBe(!1);
     });
-  }), d("Test getPermissionsFromModulePermissionToken", () => {
+  }), u("Test getPermissionsFromModulePermissionToken", () => {
     const n = `
 eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJNb2R1bGVSb2xlc0FuZFBlcm1pc3Npb25zIjp7IkZhcm1Pcmdhbml6YXRpb25JZCI6IjJmZDJjMGIwLTUwNjEtNGQ0NS1hYzI1LWQxY2E0YWNkNzMzOCIsIlVzZXJJZCI6Ijc5M2IxZmFlLTg0ODItNGVkMy1hYjczLTQ1NzFhMDViYjEyYiIsIk1vZHVsZUlkIjoiMTIzNDUtNjc4OTAtYWJjZGUtZWZnaGkiLCJSb2xlTmFtZXMiOlsiRmFybSBNYW5hZ2VyIiwiRmFybSBXb3JrZXIiXSwiRXhlY3V0ZUVuZHBvaW50UGVybWlzc2lvbk5hbWVzIjpbImJsb2Nrcy1yZWFkIiwiYmxvY2tzLXVwZGF0ZSIsImZhcm1zLXJlYWQiXX19.test-signature
     `;

package/dist/main.d.ts

@@ -62,6 +62,7 @@ export { Allowed } from './components/Allowed/Allowed';
 export { AllowedButton } from './components/AllowedButton/AllowedButton';
 export { AllowedIconButton } from './components/AllowedIconButton/AllowedIconButton';
 export { getPermissionsFromModulePermissionToken, useIsAllowed, } from './components/PermissionChecks/PermissionService';
+export type { IsAllowedProps } from './components/PermissionChecks/PermissionService';
 export { SharedComponentsPermissionProvider } from './components/SharedComponentsPermissionProvider/SharedComponentsPermissionProvider';
 export { createPermissionWrapper, renderWithPermissions } from './test-utils';
 export { HVMainPermissions } from './types/Permission';

package/dist/types/ListElement.d.ts

@@ -80,6 +80,7 @@ export type BaseListElement = {
     value?: string;
     /**
      * the list element is disabled if this is true
+     * If the user does not have the required permissions the element please use the `permissions` property instead
      */
     disabled?: boolean;
     /**
@@ -104,6 +105,10 @@ export type BaseListElement = {
      * a custom class name for the list item
      */
     listItemClassName?: string;
+    /**
+     * whether the user has the permission to view this element, if false the element will not be shown
+     */
+    isAllowed?: boolean;
 };
 /**
  * The list element to use with BaseView and ListArea, it is an extension of the BaseListElement to handle grouped lists

package/dist/types/Permission.d.ts

@@ -25,9 +25,9 @@ export type ModulePermissionTokenParsed = {
     };
 };
 /**
- * Type representing all possible permissions in the system.
+ * Type representing all possible permissions in the system.p
  */
-export type HVPermissions = HVMainPermissions | `${string}`;
+export type HVPermissions = `${HVMainPermissions}` | (string & Record<never, never>);
 /**
  * Enum for all main permissions available in the HortiView platform.
  */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hortiview/shared-components",
   "description": "This is a shared component library. It should used in the HortiView platform and its modules.",
-  "version": "2.13.0",
+  "version": "2.15.0",
   "type": "module",
   "repository": "https://dev.azure.com/sdundc/HV%20Platform/_git/HortiView-Frontend-Shared",
   "author": "Falk Menge <falk.menge.ext@bayer.com>",

package/dist/GenericCard-CeqYrtLH.js

@@ -1,89 +0,0 @@
-import { jsx as r, jsxs as d, Fragment as C } from "react/jsx-runtime";
-import { C as h, a as m, b as T, c as g, d as v } from "./index.es-BPv5dCFQ.js";
-import { G as b, a as x, b as c } from "./index.es-CeQB6igi.js";
-import { d as f } from "./index.es-SjZ_-d7U.js";
-import { useMemo as w } from "react";
-import { OverflowTooltip as l } from "./components/OverflowTooltip/OverflowTooltip.js";
-import './assets/GenericCard.css';const u = "_cardTitle_ny9m0_1", B = "_cardBody_ny9m0_5", N = "_cardContent_ny9m0_10", $ = "_row_ny9m0_14", G = "_font_ny9m0_18", k = "_fontHeader_ny9m0_23", H = "_title_ny9m0_27", S = "_emptyContainer_ny9m0_33", A = "_empty_ny9m0_33", n = {
-  cardTitle: u,
-  cardBody: B,
-  cardContent: N,
-  row: $,
-  font: G,
-  fontHeader: k,
-  title: H,
-  emptyContainer: S,
-  empty: A
-}, _ = {
-  desktopCol: 6,
-  phoneCol: 2,
-  tabletCol: 4,
-  verticalAlign: "bottom"
-}, W = ({ item: e, columns: t, hiddenColumns: o }) => {
-  const i = t.find((a) => a.asCardTitle), y = t.find((a) => a.asCardSubtitle), p = w(
-    () => t.filter(
-      (a) => !a.asCardTitle && !a.asCardSubtitle && a.id !== "actions"
-    ),
-    [t]
-  );
-  return /* @__PURE__ */ r(
-    h,
-    {
-      variant: "raised",
-      "data-testid": `card${i ? "-" + e[i.accessor] : ""}`,
-      children: /* @__PURE__ */ d(m, { className: n.cardContent, "data-testid": "card-content", children: [
-        /* @__PURE__ */ r(j, { item: e, titleColumn: i, subTitleColumn: y }),
-        /* @__PURE__ */ r(T, { className: n.cardBody, "data-testid": "card-body", children: /* @__PURE__ */ r(b, { fullHeight: !0, fullWidth: !0, variant: "none", children: p.map((a) => o?.includes(a.id) ? null : /* @__PURE__ */ d(x, { className: n.row, "data-testid": "row", children: [
-          /* @__PURE__ */ r(c, { horizontalAlign: "right", ..._, children: /* @__PURE__ */ d(
-            f,
-            {
-              level: 2,
-              themeColor: "text-secondary-on-background",
-              className: `${n.font} ${n.fontHeader}`,
-              tag: "div",
-              children: [
-                a.header,
-                ":"
-              ]
-            }
-          ) }),
-          /* @__PURE__ */ r(c, { horizontalAlign: "left", ..._, children: /* @__PURE__ */ r(s, { column: a, item: e }) })
-        ] }, a.id)) }) })
-      ] })
-    }
-  );
-}, j = ({ item: e, titleColumn: t, subTitleColumn: o }) => {
-  const i = e.actions;
-  return !t && !o && !i ? null : /* @__PURE__ */ d(C, { children: [
-    /* @__PURE__ */ r(
-      g,
-      {
-        "data-testid": "card-title",
-        className: n.cardTitle,
-        primaryText: t !== void 0 && /* @__PURE__ */ r(s, { column: t, item: e, isTitle: !0 }),
-        secondaryText: o !== void 0 && /* @__PURE__ */ r(s, { column: o, item: e, isTitle: !0 }),
-        trailingBlock: i,
-        trailingBlockType: i ? "title-actions" : void 0
-      }
-    ),
-    /* @__PURE__ */ r(v, {})
-  ] });
-}, s = ({ item: e, column: t, isTitle: o = !1 }) => t.cellTemplate ? t.cellTemplate({ row: { original: e } }) : o ? /* @__PURE__ */ r(
-  l,
-  {
-    id: `tip_${t.id}_${e[t.accessor]}`,
-    text: e[t.accessor],
-    children: /* @__PURE__ */ r("span", { className: n.title, children: e[t.accessor] })
-  }
-) : /* @__PURE__ */ r(
-  l,
-  {
-    id: `tip_${t.id}_${e[t.accessor]}`,
-    text: e[t.accessor],
-    children: /* @__PURE__ */ r(f, { level: 2, themeColor: "text-primary-on-background", className: n.font, children: e[t.accessor] })
-  }
-);
-export {
-  W as G,
-  n as s
-};