@hortiview/default-components 1.4.4 → 1.5.1

package/README.md

@@ -68,6 +68,7 @@ This library provides form components using [react-hook-form](https://react-hook
    1. [PlatformHealthCheck](#platformhealthcheck)
 1. [ImpatienceLoadingSpinner](#impatienceloadingspinner)
 1. [OfflineView](#offlineview)
+1. [DefaultAllowedComponent](#defaultallowedcomponent)
 
 ## Available Components
 
@@ -221,3 +222,53 @@ import { OfflineView } from '@hortiview/default-components';
 
 <OfflineView />;
 ```
+
+### DefaultAllowedComponent
+
+The `DefaultAllowedComponent` is a permission-aware wrapper that displays its children only if the user has the required permissions for a given entity. It uses the default disclaimer text with internationalization support. This component is useful for conditionally rendering content based on user rights in the HortiView platform.
+
+**Note:**
+Wrap your usage in `SharedComponentsPermissionProvider` to provide the permission context. The default disclaimer text is automatically internationalized when `useChangeDefaultComponentsLanguage` is used.
+
+**Props:**
+
+- `neededPermissions`: Array of permissions required to view the content (e.g., `[HVMainPermissions.FarmsRead]`).
+- `entityIds`: The entity ID for which permissions are checked (e.g., `'farm-org-123'`).
+- `disclaimer`: If true, shows a disclaimer when permissions are missing.
+- `children`: The content to render if the user has the required permissions.
+
+**Usage Example:**
+
+```tsx
+import { DefaultAllowedComponent } from '@hortiview/default-components';
+import {
+  InfoCard,
+  HVMainPermissions,
+  SharedComponentsPermissionProvider,
+  ModulePadding,
+} from '@hortiview/shared-components';
+
+const userPermissions = {
+  'farm-org-123': [HVMainPermissions.FarmsRead, HVMainPermissions.FarmsUpdate],
+};
+const activeOrganizationId = 'farm-org-123';
+
+<SharedComponentsPermissionProvider
+  userPermissions={userPermissions}
+  activeOrganizationId={activeOrganizationId}
+>
+  <DefaultAllowedComponent
+    neededPermissions={[HVMainPermissions.FarmsRead]}
+    entityIds='farm-org-123'
+    disclaimer={false}
+  >
+    <ModulePadding>
+      <InfoCard
+        title='You can see this content because you have the required FarmsRead permission!'
+        subtitle='Permission Granted'
+        type='done'
+      />
+    </ModulePadding>
+  </DefaultAllowedComponent>
+</SharedComponentsPermissionProvider>;
+```

package/dist/components/DefaultAllowedComponent/DefaultAllowedComponent.d.ts

@@ -0,0 +1,11 @@
+import { Allowed } from '@hortiview/shared-components';
+import { default as React } from 'react';
+
+export type DefaultAllowedComponentProps = Omit<React.ComponentProps<typeof Allowed>, 'disclaimerText'>;
+/**
+ * Default allowed component for the HortiView frontend.
+ * It provides a default disclaimer text using internationalization.
+ * @param param0
+ * @returns
+ */
+export declare const DefaultAllowedComponent: ({ ...props }: DefaultAllowedComponentProps) => import("react/jsx-runtime").JSX.Element;

package/dist/components/DefaultAllowedComponent/DefaultAllowedComponent.js

@@ -0,0 +1,11 @@
+import { jsx as o } from "react/jsx-runtime";
+import { Allowed as e } from "@hortiview/shared-components";
+import { InternationalizationWrapper as n } from "../InternationalizationWrapper/InternationalizationWrapper.js";
+import { u as i } from "../../useTranslation-DGtUf8nl.js";
+const s = ({ ...r }) => {
+  const { t } = i();
+  return /* @__PURE__ */ o(n, { children: /* @__PURE__ */ o(e, { ...r, disclaimerText: t("allowedComponent.disclaimerText") }) });
+};
+export {
+  s as DefaultAllowedComponent
+};