@hortiview/shared-components 2.11.2 → 2.12.0

package/dist/test-utils.d.ts

@@ -0,0 +1,82 @@
+import { RenderOptions, RenderResult } from '@testing-library/react';
+import { default as React, ReactElement } from 'react';
+import { PermissionsByEntity } from './types/Permission';
+
+interface CustomRenderOptions extends Omit<RenderOptions, 'wrapper'> {
+    /**
+     * Mock user permissions for testing.
+     * @example
+     * ```tsx
+     * {
+     *   'farm-id-123': [Permission.FarmsUpdate, Permission.FarmsRead],
+     *   'General': [Permission.CurrentUserRead],
+     * }
+     * ```
+     */
+    userPermissions?: PermissionsByEntity;
+    /**
+     * Mock active organization ID for testing.
+     */
+    activeOrganizationId?: string;
+}
+/**
+ * Custom render function that wraps components with the SharedComponentsPermissionProvider.
+ * Use this in tests instead of the default render from @testing-library/react when testing
+ * components that use permission-gated features (AllowedButton, AllowedIconButton, useIsAllowed).
+ *
+ * @example
+ * ```tsx
+ * import { renderWithPermissions } from './test-utils';
+ * import { Permission } from './types/Permission';
+ *
+ * test('renders edit button when user has permission', () => {
+ *   renderWithPermissions(<MyComponent farmId="farm-123" />, {
+ *     userPermissions: {
+ *       'farm-123': [Permission.FarmsUpdate, Permission.FarmsRead],
+ *     },
+ *     activeOrganizationId: 'farm-123',
+ *   });
+ *
+ *   expect(screen.getByText('Edit Farm')).toBeInTheDocument();
+ * });
+ * ```
+ *
+ * @param componentToRender - The React component to render
+ * @param options - Custom render options including userPermissions and activeOrganizationId
+ * @returns The result from @testing-library/react render
+ */
+export declare const renderWithPermissions: (componentToRender: ReactElement, { userPermissions, activeOrganizationId, ...renderOptions }?: CustomRenderOptions) => RenderResult;
+/**
+ * Creates a wrapper component with the SharedComponentsPermissionProvider for use with renderHook.
+ * Use this when testing hooks that depend on permission context (like useIsAllowed).
+ *
+ * @example
+ * ```tsx
+ * import { renderHook } from '@testing-library/react';
+ * import { createPermissionWrapper } from './test-utils';
+ * import { Permission } from './types/Permission';
+ *
+ * test('hook returns true when user has permission', () => {
+ *   const { result } = renderHook(() => useIsAllowed(), {
+ *     wrapper: createPermissionWrapper({
+ *       userPermissions: {
+ *         'farm-123': [Permission.FarmsUpdate],
+ *       },
+ *     }),
+ *   });
+ *
+ *   expect(result.current([Permission.FarmsUpdate], 'farm-123')).toBe(true);
+ * });
+ * ```
+ *
+ * @param userPermissions - Mock user permissions for testing
+ * @param activeOrganizationId - Mock active organization ID for testing
+ * @returns A wrapper component for renderHook
+ */
+export declare const createPermissionWrapper: ({ userPermissions, activeOrganizationId, }?: {
+    userPermissions?: PermissionsByEntity;
+    activeOrganizationId?: string;
+}) => ({ children }: {
+    children: React.ReactNode;
+}) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/test-utils.js

@@ -0,0 +1,32 @@
+import { jsx as i } from "react/jsx-runtime";
+import { a as t } from "./react.esm-BbMrgZCM.js";
+import { SharedComponentsPermissionProvider as n } from "./components/SharedComponentsPermissionProvider/SharedComponentsPermissionProvider.js";
+const a = (r, {
+  userPermissions: e = {},
+  activeOrganizationId: o = void 0,
+  ...s
+} = {}) => t(
+  /* @__PURE__ */ i(
+    n,
+    {
+      userPermissions: e,
+      activeOrganizationId: o,
+      children: r
+    }
+  ),
+  s
+), c = ({
+  userPermissions: r = {},
+  activeOrganizationId: e = void 0
+} = {}) => ({ children: o }) => /* @__PURE__ */ i(
+  n,
+  {
+    userPermissions: r,
+    activeOrganizationId: e,
+    children: o
+  }
+);
+export {
+  c as createPermissionWrapper,
+  a as renderWithPermissions
+};

package/dist/types/Permission.d.ts

@@ -0,0 +1,153 @@
+/**
+ * Type representing user permissions mapped by entity IDs.
+ *
+ * @remarks
+ * The keys are entity IDs (e.g., FarmOrganizationId, VendorOrganizationId) and the values are arrays of permission strings associated with those entities.
+ * @example
+ * {
+ *  "0000-0000-0000-0000": ["read", "write", "delete"],
+ *  "0000-0000-0000-0001": ["read", "delete"],
+ * }
+ */
+export type PermissionsByEntity = {
+    [entityId: string]: string[];
+} | undefined;
+/**
+ * Type representing the structure of a parsed module permission token.
+ */
+export type ModulePermissionTokenParsed = {
+    ModuleRolesAndPermissions: {
+        FarmOrganizationId: string;
+        UserId: string;
+        ModuleId: string;
+        RoleNames: string[];
+        ExecuteEndpointPermissionNames: string[];
+    };
+};
+/**
+ * Type representing all possible permissions in the system.
+ */
+export type HVPermissions = HVMainPermissions | `${string}`;
+/**
+ * Enum for all main permissions available in the HortiView platform.
+ */
+export declare enum HVMainPermissions {
+    RoleHVAdmin = "HVAdmin",
+    RoleHVDeveloper = "HVDeveloper",
+    FarmManager = "Farm Manager",
+    FarmWorker = "Farm Worker",
+    Agronomist = "Agronomist",
+    Advisor = "Advisor",
+    FarmOrganizationMember = "Farm Organization Member",
+    FarmOrganizationAdmin = "Organization Administrator",
+    Developer = "Developer",
+    LeadDeveloper = "Lead Developer",
+    BusinessManager = "Business Manager",
+    BusinessOwner = "Business Owner",
+    VendorOrganizationMember = "Vendor Organization Member",
+    BlocksCreate = "blocks-create",
+    BlocksDelete = "blocks-delete",
+    BlocksRead = "blocks-read",
+    BlocksUpdate = "blocks-update",
+    CurrentUserRead = "current-user-read",
+    CurrentUserUpdate = "current-user-update",
+    FarmAlertRulesCreate = "farmalertrules-create",
+    FarmAlertRulesDelete = "farmalertrules-delete",
+    FarmAlertRulesRead = "farmalertrules-read",
+    FarmAlertRulesUpdate = "farmalertrules-update",
+    FarmAlertsCreate = "farmalerts-create",
+    FarmAlertsDelete = "farmalerts-delete",
+    FarmAlertsRead = "farmalerts-read",
+    FarmAlertsUpdate = "farmalerts-update",
+    FarmBillingInformationsCreate = "farm_billing_informations-create",
+    FarmBillingInformationsDelete = "farm_billing_informations-delete",
+    FarmBillingInformationsRead = "farm_billing_informations-read",
+    FarmBillingInformationsUpdate = "farm_billing_informations-update",
+    FarmMembersCreate = "farmmembers-create",
+    FarmMembersDelete = "farmmembers-delete",
+    FarmMembersRead = "farmmembers-read",
+    FarmMembersUpdate = "farmmembers-update",
+    FarmOrganizationMembersCreate = "farmorganizationmembers-create",
+    FarmOrganizationMembersDelete = "farmorganizationmembers-delete",
+    FarmOrganizationMembersRead = "farmorganizationmembers-read",
+    FarmOrganizationMembersUpdate = "farmorganizationmembers-update",
+    FarmOrganizationModuleRead = "farm_organization_module-read",
+    FarmOrganizationsCreate = "farm_organizations-create",
+    FarmOrganizationsDelete = "farm_organizations-delete",
+    FarmOrganizationsRead = "farm_organizations-read",
+    FarmOrganizationsUpdate = "farm_organizations-update",
+    FarmRolesRead = "farm_roles-read",
+    FarmTagsCreate = "farmtags-create",
+    FarmTagsDelete = "farmtags-delete",
+    FarmTagsRead = "farmtags-read",
+    FarmTagsUpdate = "farmtags-update",
+    FarmsCreate = "farms-create",
+    FarmsDelete = "farms-delete",
+    FarmsRead = "farms-read",
+    FarmsUpdate = "farms-update",
+    FieldMembersCreate = "fieldmembers-create",
+    FieldMembersDelete = "fieldmembers-delete",
+    FieldMembersRead = "fieldmembers-read",
+    FieldMembersUpdate = "fieldmembers-update",
+    FieldsCreate = "fields-create",
+    FieldsDelete = "fields-delete",
+    FieldsRead = "fields-read",
+    FieldsUpdate = "fields-update",
+    InviteUserToOrganization = "invite-user-to-organization",
+    InvitedUsersCreate = "invitedusers-create",
+    InvitedUsersDelete = "invitedusers-delete",
+    InvitedUsersRead = "invitedusers-read",
+    InvitedUsersUpdate = "invitedusers-update",
+    InvoiceRead = "invoice-read",
+    IrrigationStationsCreate = "irrigationstations-create",
+    IrrigationStationsDelete = "irrigationstations-delete",
+    IrrigationStationsRead = "irrigationstations-read",
+    IrrigationStationsUpdate = "irrigationstations-update",
+    LegalAddressCreate = "legal_address-create",
+    LegalAddressDelete = "legal_address-delete",
+    LegalAddressRead = "legal_address-read",
+    LegalAddressUpdate = "legal_address-update",
+    LoginUser = "login-user",
+    MapProxyRead = "mapproxy-read",
+    ModuleMetricsRead = "module_metrics-read",
+    ModuleRatingsCreate = "module_ratings-create",
+    ModuleRatingsDelete = "module_ratings-delete",
+    ModuleRatingsRead = "module_ratings-read",
+    ModuleRatingsUpdate = "module_ratings-update",
+    ModuleReviewRequestsRead = "module_review_requests-read",
+    ModulesCreate = "modules-create",
+    ModulesDelete = "modules-delete",
+    ModulesPublish = "modules-publish",
+    ModulesRead = "modules-read",
+    ModulesRequestReview = "modules-request_review",
+    ModulesSearch = "modules-search",
+    ModulesSuspend = "modules-suspend",
+    ModulesUpdate = "modules-update",
+    OrganizationModulesCreate = "organization_modules-create",
+    OrganizationModulesDelete = "organization_modules-delete",
+    PaymentDetailsUpdate = "payment_details-update",
+    ProfilesDelete = "profiles-delete",
+    ProfilesUpdate = "profiles-update",
+    RegisterUser = "register-user",
+    ResetPassword = "reset-password",
+    SubscriptionsRead = "subscriptions-read",
+    SuperUser = "superuser",
+    UserRoleUpdate = "user_role-update",
+    UsersCreate = "users-create",
+    UsersDelete = "users-delete",
+    UsersRead = "users-read",
+    UsersUpdate = "users-update",
+    VendorBillingInformationsCreate = "vendor_billing_informations-create",
+    VendorBillingInformationsDelete = "vendor_billing_informations-delete",
+    VendorBillingInformationsRead = "vendor_billing_informations-read",
+    VendorBillingInformationsUpdate = "vendor_billing_informations-update",
+    VendorOrganizationMembersCreate = "vendor_members-create",
+    VendorOrganizationMembersDelete = "vendor_members-delete",
+    VendorOrganizationMembersRead = "vendor_members-read",
+    VendorOrganizationMembersUpdate = "vendor_members-update",
+    VendorOrganizationsCreate = "vendor_organizations-create",
+    VendorOrganizationsDelete = "vendor_organizations-delete",
+    VendorOrganizationsRead = "vendor_organizations-read",
+    VendorOrganizationsUpdate = "vendor_organizations-update",
+    WeatherProxyRead = "weatherproxy-read"
+}

package/dist/types/Permission.js

@@ -0,0 +1,4 @@
+var r = /* @__PURE__ */ ((e) => (e.RoleHVAdmin = "HVAdmin", e.RoleHVDeveloper = "HVDeveloper", e.FarmManager = "Farm Manager", e.FarmWorker = "Farm Worker", e.Agronomist = "Agronomist", e.Advisor = "Advisor", e.FarmOrganizationMember = "Farm Organization Member", e.FarmOrganizationAdmin = "Organization Administrator", e.Developer = "Developer", e.LeadDeveloper = "Lead Developer", e.BusinessManager = "Business Manager", e.BusinessOwner = "Business Owner", e.VendorOrganizationMember = "Vendor Organization Member", e.BlocksCreate = "blocks-create", e.BlocksDelete = "blocks-delete", e.BlocksRead = "blocks-read", e.BlocksUpdate = "blocks-update", e.CurrentUserRead = "current-user-read", e.CurrentUserUpdate = "current-user-update", e.FarmAlertRulesCreate = "farmalertrules-create", e.FarmAlertRulesDelete = "farmalertrules-delete", e.FarmAlertRulesRead = "farmalertrules-read", e.FarmAlertRulesUpdate = "farmalertrules-update", e.FarmAlertsCreate = "farmalerts-create", e.FarmAlertsDelete = "farmalerts-delete", e.FarmAlertsRead = "farmalerts-read", e.FarmAlertsUpdate = "farmalerts-update", e.FarmBillingInformationsCreate = "farm_billing_informations-create", e.FarmBillingInformationsDelete = "farm_billing_informations-delete", e.FarmBillingInformationsRead = "farm_billing_informations-read", e.FarmBillingInformationsUpdate = "farm_billing_informations-update", e.FarmMembersCreate = "farmmembers-create", e.FarmMembersDelete = "farmmembers-delete", e.FarmMembersRead = "farmmembers-read", e.FarmMembersUpdate = "farmmembers-update", e.FarmOrganizationMembersCreate = "farmorganizationmembers-create", e.FarmOrganizationMembersDelete = "farmorganizationmembers-delete", e.FarmOrganizationMembersRead = "farmorganizationmembers-read", e.FarmOrganizationMembersUpdate = "farmorganizationmembers-update", e.FarmOrganizationModuleRead = "farm_organization_module-read", e.FarmOrganizationsCreate = "farm_organizations-create", e.FarmOrganizationsDelete = "farm_organizations-delete", e.FarmOrganizationsRead = "farm_organizations-read", e.FarmOrganizationsUpdate = "farm_organizations-update", e.FarmRolesRead = "farm_roles-read", e.FarmTagsCreate = "farmtags-create", e.FarmTagsDelete = "farmtags-delete", e.FarmTagsRead = "farmtags-read", e.FarmTagsUpdate = "farmtags-update", e.FarmsCreate = "farms-create", e.FarmsDelete = "farms-delete", e.FarmsRead = "farms-read", e.FarmsUpdate = "farms-update", e.FieldMembersCreate = "fieldmembers-create", e.FieldMembersDelete = "fieldmembers-delete", e.FieldMembersRead = "fieldmembers-read", e.FieldMembersUpdate = "fieldmembers-update", e.FieldsCreate = "fields-create", e.FieldsDelete = "fields-delete", e.FieldsRead = "fields-read", e.FieldsUpdate = "fields-update", e.InviteUserToOrganization = "invite-user-to-organization", e.InvitedUsersCreate = "invitedusers-create", e.InvitedUsersDelete = "invitedusers-delete", e.InvitedUsersRead = "invitedusers-read", e.InvitedUsersUpdate = "invitedusers-update", e.InvoiceRead = "invoice-read", e.IrrigationStationsCreate = "irrigationstations-create", e.IrrigationStationsDelete = "irrigationstations-delete", e.IrrigationStationsRead = "irrigationstations-read", e.IrrigationStationsUpdate = "irrigationstations-update", e.LegalAddressCreate = "legal_address-create", e.LegalAddressDelete = "legal_address-delete", e.LegalAddressRead = "legal_address-read", e.LegalAddressUpdate = "legal_address-update", e.LoginUser = "login-user", e.MapProxyRead = "mapproxy-read", e.ModuleMetricsRead = "module_metrics-read", e.ModuleRatingsCreate = "module_ratings-create", e.ModuleRatingsDelete = "module_ratings-delete", e.ModuleRatingsRead = "module_ratings-read", e.ModuleRatingsUpdate = "module_ratings-update", e.ModuleReviewRequestsRead = "module_review_requests-read", e.ModulesCreate = "modules-create", e.ModulesDelete = "modules-delete", e.ModulesPublish = "modules-publish", e.ModulesRead = "modules-read", e.ModulesRequestReview = "modules-request_review", e.ModulesSearch = "modules-search", e.ModulesSuspend = "modules-suspend", e.ModulesUpdate = "modules-update", e.OrganizationModulesCreate = "organization_modules-create", e.OrganizationModulesDelete = "organization_modules-delete", e.PaymentDetailsUpdate = "payment_details-update", e.ProfilesDelete = "profiles-delete", e.ProfilesUpdate = "profiles-update", e.RegisterUser = "register-user", e.ResetPassword = "reset-password", e.SubscriptionsRead = "subscriptions-read", e.SuperUser = "superuser", e.UserRoleUpdate = "user_role-update", e.UsersCreate = "users-create", e.UsersDelete = "users-delete", e.UsersRead = "users-read", e.UsersUpdate = "users-update", e.VendorBillingInformationsCreate = "vendor_billing_informations-create", e.VendorBillingInformationsDelete = "vendor_billing_informations-delete", e.VendorBillingInformationsRead = "vendor_billing_informations-read", e.VendorBillingInformationsUpdate = "vendor_billing_informations-update", e.VendorOrganizationMembersCreate = "vendor_members-create", e.VendorOrganizationMembersDelete = "vendor_members-delete", e.VendorOrganizationMembersRead = "vendor_members-read", e.VendorOrganizationMembersUpdate = "vendor_members-update", e.VendorOrganizationsCreate = "vendor_organizations-create", e.VendorOrganizationsDelete = "vendor_organizations-delete", e.VendorOrganizationsRead = "vendor_organizations-read", e.VendorOrganizationsUpdate = "vendor_organizations-update", e.WeatherProxyRead = "weatherproxy-read", e))(r || {});
+export {
+  r as HVMainPermissions
+};

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.11.2",
+  "version": "2.12.0",
   "type": "module",
   "repository": "https://dev.azure.com/sdundc/HV%20Platform/_git/HortiView-Frontend-Shared",
   "author": "Falk Menge <falk.menge.ext@bayer.com>",
@@ -86,6 +86,7 @@
     "glob": "^10.3.10",
     "husky": "^9.1.7",
     "jsdom": "^24.0.0",
+    "jwt-decode": "^4.0.0",
     "lodash": "^4.17.21",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",