@bigbinary/neeto-filters-frontend 3.1.2 → 3.2.0-beta.0

package/README.md

@@ -126,6 +126,7 @@ export default App;
 - `childrenKeys`: The list of keys which has to be cleared from url during clear filters operation.
 - `entity`: The entity associated with the filters.
 - `defaultSegmentName`: The name of segment which results all entities without applying any filter. Default name is "All results".
+- `customFilters`: To specify the custom components specific to the host application. This should be same as `children` passed to the `Filters` component.
 
 All these props must be same as that passed to the `Filters` component. The
 option to save filters as segments will be enabled only when the entity prop is
@@ -184,6 +185,8 @@ export default App;
 - `entity`: The entity associated with the segments.
 - `setIsPaneOpen`: To trigger the isOpen state of the filters pane.
 - `defaultSegmentName`: The name of segment which results all entities without applying any filter. Default name is "All results".
+- `customFilters`: To specify the custom components specific to the host application. This should be same as `children` passed to the `Filters` component.
+- `childrenKeys`: The list of keys which has to be cleared from url during clear filters operation.
 
 The "columns" prop must be same as that passed to the `Filters` component.
 

package/app/javascript/src/translations/en.json

@@ -4,6 +4,7 @@
       "clearFilters": "Clear filters",
       "columns": "Columns",
       "delete": "Delete",
+      "edit": "Edit",
       "done": "Done",
       "filter": "Filter",
       "filters": "Filters",
@@ -46,21 +47,24 @@
     },
     "segments": {
       "addNewSegment": "Add new segment",
-      "deleteAlertMessage": "You are permanently deleting the segment <strong>{{entity}}</strong>. This can't be undone.",
+      "saveAsNewSegment": "Add as new segment",
+      "editSegment": "Edit segment",
+      "deleteAlertMessage": "You are permanently deleting the segment <strong>{{entity,anyCase}}</strong>. This can't be undone.",
       "deleteAlertTitle": "Delete segment?",
       "manageSegments": "Manage segments",
       "name": "Segment name",
       "noSegmentsFound": "No segments found",
       "saveSegment": "Save segment",
-      "saveAsSegment": "Save as segment",
-      "saveAsNewSegment": "Save as new segment",
+      "updateSegment": "Update segment",
       "searchSegments": "Search segments",
       "segmentName": "Segment name",
       "showLess": "See less",
       "showMoreNumbers": "See {{entity}} more",
-      "updateSegment": "Update segment?",
-      "updateSegmentMessage": "You are trying to update the current segment.",
-      "reservedNameErrorMessage": "This name is reserved. Please choose another name."
+      "nameIsRequired": "Segment name is required",
+      "reservedNameErrorMessage": "This name is reserved. Please choose another name.",
+      "addFilter": "Add filter",
+      "newFilter": "New filter",
+      "selectFilter": "Select filter"
     },
     "labels": {
       "keyword": "Keyword"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigbinary/neeto-filters-frontend",
-  "version": "3.1.2",
+  "version": "3.2.0-beta.0",
   "description": "Manage filters across neeto products.",
   "license": "UNLICENSED",
   "homepage": "https://github.com/bigbinary/neeto-filters-nano",
@@ -48,15 +48,15 @@
     "@babel/preset-typescript": "7.23.2",
     "@babel/runtime": "7.23.2",
     "@bigbinary/babel-preset-neeto": "1.0.6",
-    "@bigbinary/eslint-plugin-neeto": "1.1.41",
+    "@bigbinary/eslint-plugin-neeto": "1.1.42",
     "@bigbinary/neeto-audit-frontend": "2.0.9",
     "@bigbinary/neeto-cist": "1.0.8",
-    "@bigbinary/neeto-commons-frontend": "3.1.10",
-    "@bigbinary/neeto-filters-frontend": "3.0.15",
+    "@bigbinary/neeto-commons-frontend": "3.1.17",
+    "@bigbinary/neeto-filters-frontend": "3.1.3",
     "@bigbinary/neeto-hotkeys": "^1.0.1",
     "@bigbinary/neeto-icons": "1.17.11",
     "@bigbinary/neeto-molecules": "1.6.3",
-    "@bigbinary/neetoui": "6.1.2",
+    "@bigbinary/neetoui": "6.2.2",
     "@emotion/is-prop-valid": "1.2.0",
     "@faker-js/faker": "8.2.0",
     "@honeybadger-io/js": "6.5.3",
@@ -154,12 +154,12 @@
   },
   "peerDependencies": {
     "@bigbinary/neeto-cist": "latest",
-    "@bigbinary/neeto-commons-frontend": "3.1.10",
-    "@bigbinary/neeto-filters-frontend": "3.0.15",
+    "@bigbinary/neeto-commons-frontend": "3.1.17",
+    "@bigbinary/neeto-filters-frontend": "3.1.3",
     "@bigbinary/neeto-hotkeys": "^1.0.1",
     "@bigbinary/neeto-icons": "1.17.11",
     "@bigbinary/neeto-molecules": "1.6.3",
-    "@bigbinary/neetoui": "6.1.2",
+    "@bigbinary/neetoui": "6.2.2",
     "@honeybadger-io/js": "^6.5.3",
     "@honeybadger-io/react": "^6.1.9",
     "axios": "^1.6.0",

package/types.d.ts

@@ -1,6 +1,12 @@
 import React from "react";
 import { ButtonProps, PaneProps } from "@bigbinary/neetoui";
-import { UseQueryResult, UseQueryOptions, UseMutationOptions, UseMutationResult, MutationOptions } from "react-query";
+import {
+  UseQueryResult,
+  UseQueryOptions,
+  UseMutationOptions,
+  UseMutationResult,
+  MutationOptions,
+} from "react-query";
 
 interface labelAndValue {
   label: string | number;
@@ -11,10 +17,10 @@ type helpIconProps = {
   icon?: string;
   onClick?: () => void;
   tooltipProps: {
-    content: string,
-    position?: string,
-  }
-}
+    content: string;
+    position?: string;
+  };
+};
 interface ColumnType {
   suffixComponent?: React.ComponentType<any>;
   helpIconProps?: helpIconProps;
@@ -41,9 +47,9 @@ interface KeywordType {
 }
 
 interface SegmentType {
-    id: string,
-    name: string,
-    filters: filters[]
+  id: string;
+  name: string;
+  filters: filters[];
 }
 
 type condition = {
@@ -116,6 +122,7 @@ export function Bar(props: {
   onSelectorsChange?: (selectors: selectors) => void;
   childrenKeys?: string[];
   defaultSegmentName?: string;
+  customFilters?: React.ReactNode;
   [otherProps: string]: any;
 }): JSX.Element;
 
@@ -124,6 +131,8 @@ export function Segments(props: {
   columns: ColumnType[];
   setIsFilterPaneOpen: (boolean) => void;
   defaultSegmentName?: string;
+  customFilters?: React.ReactNode;
+  childrenKeys?: string[];
 }): JSX.Element;
 
 export function buildFiltersFromURL(
@@ -144,33 +153,40 @@ type FieldType = {
   displayOrder?: number;
   ownerType?: string;
   ownerId?: string;
-}
+};
 
 export function buildFilterColumnsFromFields(args: {
-  fields: Array<FieldType>,
-  selectedFields?: string[],
-  showRuleSelector?: boolean,
-  groupName?: string
+  fields: Array<FieldType>;
+  selectedFields?: string[];
+  showRuleSelector?: boolean;
+  groupName?: string;
 }): ColumnType[];
 
-export function useFetchSegments(args: {
-  entity: string,
-  searchTerm?: string,
-}, options?: UseQueryOptions):  UseQueryResult<SegmentType[]>
+export function useFetchSegments(
+  args: {
+    entity: string;
+    searchTerm?: string;
+  },
+  options?: UseQueryOptions
+): UseQueryResult<SegmentType[]>;
 
 export function buildUrlFromSegment(args: {
-  columns: ColumnType[],
-  filters: filters[],
-  id: string
+  columns: ColumnType[];
+  filters: filters[];
+  id: string;
 }): string;
 
-export function useDestroySegment(options?: UseMutationOptions): UseMutationResult<TData, TError, TVariables, TContext>;
+export function useDestroySegment(
+  options?: UseMutationOptions
+): UseMutationResult<TData, TError, TVariables, TContext>;
 
-export function useUpdateSegment(options?: UseMutationOptions): UseMutationResult<TData, TError, TVariables, TContext>;
+export function useUpdateSegment(
+  options?: UseMutationOptions
+): UseMutationResult<TData, TError, TVariables, TContext>;
 
 export function buildUrlFromFilters(args: {
-  columns: ColumnType[],
-  filters: filters[],
-  isClearAll?: boolean,
-  childrenKeys?: string[]
+  columns: ColumnType[];
+  filters: filters[];
+  isClearAll?: boolean;
+  childrenKeys?: string[];
 }): string;