@newskit-render/shared-components 3.12.1 → 3.13.0-alpha.1

package/README.md

@@ -226,6 +226,19 @@ interface ContentListViewProps {
 
 `ContentListView` uses some components internally and exports 3 additional components: `ListItem`, `DateItemButtons` and `DateItemStatus`.
 
+## filterListItems
+
+This function filters a list of items based on specified criteria. It accepts two arguments:
+- ListItems: Array with list items
+- data: The data which will be used for filtering
+
+List items contains filter object that contains two attributes:
+- dataPath - The path to the field in the data object used for filtering the items.
+- showOnTrue - Set to true if you want the item to be included in the filtered list when the dataPath returns true.
+Set to false if you want the item to be excluded from the filtered list.
+
+The function will return an item if filter is not provided, or the provided data path does not exist in the data object.
+
 ## ListItem
 
 This is the regular list item. It is used in `my-account` main pages and takes the following

package/dist/cjs/ContentListView/index.d.ts

@@ -5,3 +5,4 @@ export * from './DateItemStatus';
 export * from './types';
 export * from './defaults';
 export * from './style-presets';
+export * from './utils';

package/dist/cjs/ContentListView/index.js

@@ -21,4 +21,5 @@ __exportStar(require("./DateItemStatus"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./defaults"), exports);
 __exportStar(require("./style-presets"), exports);
+__exportStar(require("./utils"), exports);
 //# sourceMappingURL=index.js.map

package/dist/cjs/ContentListView/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/ContentListView/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAiC;AACjC,6CAA0B;AAC1B,oDAAiC;AACjC,mDAAgC;AAChC,0CAAuB;AACvB,6CAA0B;AAC1B,kDAA+B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/ContentListView/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAiC;AACjC,6CAA0B;AAC1B,oDAAiC;AACjC,mDAAgC;AAChC,0CAAuB;AACvB,6CAA0B;AAC1B,kDAA+B;AAC/B,0CAAuB"}

package/dist/cjs/ContentListView/types.d.ts

@@ -9,6 +9,10 @@ export interface LabelIcon {
         stylePreset?: MQ<string>;
     } & LogicalProps;
 }
+export interface ListItemTypeFilter {
+    dataPath: string;
+    showOnTrue?: boolean;
+}
 export interface ListItemType {
     href?: string;
     label: string;
@@ -31,6 +35,7 @@ export interface ListItemType {
     };
     'data-testid'?: string;
     tooltip?: ListItemTooltip;
+    filter?: ListItemTypeFilter;
 }
 export interface ListItemTooltip {
     content: string;

package/dist/cjs/ContentListView/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/ContentListView/types.ts"],"names":[],"mappings":";;;AAuDA,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,4CAAuB,CAAA;IACvB,4CAAuB,CAAA;IACvB,4CAAuB,CAAA;AACzB,CAAC,EAJW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAI5B"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/ContentListView/types.ts"],"names":[],"mappings":";;;AA4DA,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,4CAAuB,CAAA;IACvB,4CAAuB,CAAA;IACvB,4CAAuB,CAAA;AACzB,CAAC,EAJW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAI5B"}

package/dist/cjs/ContentListView/utils.d.ts

@@ -0,0 +1,2 @@
+import { ListItemType } from './types';
+export declare const filterListItems: <T>(items: ListItemType[], data: T) => ListItemType[];

package/dist/cjs/ContentListView/utils.js

@@ -0,0 +1,23 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.filterListItems = void 0;
+var lodash_get_1 = __importDefault(require("lodash.get"));
+var filterListItems = function (items, data) {
+    return items.filter(function (item) {
+        if (!item.filter) {
+            return true;
+        }
+        var value = (0, lodash_get_1.default)(data, item.filter.dataPath, 'NOT AVAILABLE');
+        if (value === 'NOT AVAILABLE')
+            return true;
+        if (value === false) {
+            return true;
+        }
+        return item.filter.showOnTrue ? value === true : value !== true;
+    });
+};
+exports.filterListItems = filterListItems;
+//# sourceMappingURL=utils.js.map

package/dist/cjs/ContentListView/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/ContentListView/utils.ts"],"names":[],"mappings":";;;;;;AAAA,0DAA4B;AAGrB,IAAM,eAAe,GAAG,UAC7B,KAAqB,EACrB,IAAO;IAEP,OAAO,KAAK,CAAC,MAAM,CAAC,UAAC,IAAI;QACvB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YAChB,OAAO,IAAI,CAAA;SACZ;QAED,IAAM,KAAK,GAAG,IAAA,oBAAG,EAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAA;QAE9D,IAAI,KAAK,KAAK,eAAe;YAAE,OAAO,IAAI,CAAA;QAE1C,IAAI,KAAK,KAAK,KAAK,EAAE;YACnB,OAAO,IAAI,CAAA;SACZ;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,KAAK,KAAK,IAAI,CAAA;IACjE,CAAC,CAAC,CAAA;AACJ,CAAC,CAAA;AAnBY,QAAA,eAAe,mBAmB3B"}

package/dist/esm/ContentListView/index.d.ts

@@ -5,3 +5,4 @@ export * from './DateItemStatus';
 export * from './types';
 export * from './defaults';
 export * from './style-presets';
+export * from './utils';

package/dist/esm/ContentListView/index.js

@@ -5,4 +5,5 @@ export * from './DateItemStatus';
 export * from './types';
 export * from './defaults';
 export * from './style-presets';
+export * from './utils';
 //# sourceMappingURL=index.js.map

package/dist/esm/ContentListView/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/ContentListView/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA;AACjC,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,kBAAkB,CAAA;AAChC,cAAc,SAAS,CAAA;AACvB,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/ContentListView/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA;AACjC,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,kBAAkB,CAAA;AAChC,cAAc,SAAS,CAAA;AACvB,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,SAAS,CAAA"}

package/dist/esm/ContentListView/types.d.ts

@@ -9,6 +9,10 @@ export interface LabelIcon {
         stylePreset?: MQ<string>;
     } & LogicalProps;
 }
+export interface ListItemTypeFilter {
+    dataPath: string;
+    showOnTrue?: boolean;
+}
 export interface ListItemType {
     href?: string;
     label: string;
@@ -31,6 +35,7 @@ export interface ListItemType {
     };
     'data-testid'?: string;
     tooltip?: ListItemTooltip;
+    filter?: ListItemTypeFilter;
 }
 export interface ListItemTooltip {
     content: string;

package/dist/esm/ContentListView/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/ContentListView/types.ts"],"names":[],"mappings":"AAuDA,MAAM,CAAN,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,4CAAuB,CAAA;IACvB,4CAAuB,CAAA;IACvB,4CAAuB,CAAA;AACzB,CAAC,EAJW,iBAAiB,KAAjB,iBAAiB,QAI5B"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/ContentListView/types.ts"],"names":[],"mappings":"AA4DA,MAAM,CAAN,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,4CAAuB,CAAA;IACvB,4CAAuB,CAAA;IACvB,4CAAuB,CAAA;AACzB,CAAC,EAJW,iBAAiB,KAAjB,iBAAiB,QAI5B"}

package/dist/esm/ContentListView/utils.d.ts

@@ -0,0 +1,2 @@
+import { ListItemType } from './types';
+export declare const filterListItems: <T>(items: ListItemType[], data: T) => ListItemType[];

package/dist/esm/ContentListView/utils.js

@@ -0,0 +1,16 @@
+import get from 'lodash.get';
+export var filterListItems = function (items, data) {
+    return items.filter(function (item) {
+        if (!item.filter) {
+            return true;
+        }
+        var value = get(data, item.filter.dataPath, 'NOT AVAILABLE');
+        if (value === 'NOT AVAILABLE')
+            return true;
+        if (value === false) {
+            return true;
+        }
+        return item.filter.showOnTrue ? value === true : value !== true;
+    });
+};
+//# sourceMappingURL=utils.js.map

package/dist/esm/ContentListView/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/ContentListView/utils.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,YAAY,CAAA;AAG5B,MAAM,CAAC,IAAM,eAAe,GAAG,UAC7B,KAAqB,EACrB,IAAO;IAEP,OAAO,KAAK,CAAC,MAAM,CAAC,UAAC,IAAI;QACvB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YAChB,OAAO,IAAI,CAAA;SACZ;QAED,IAAM,KAAK,GAAG,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAA;QAE9D,IAAI,KAAK,KAAK,eAAe;YAAE,OAAO,IAAI,CAAA;QAE1C,IAAI,KAAK,KAAK,KAAK,EAAE;YACnB,OAAO,IAAI,CAAA;SACZ;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,KAAK,KAAK,IAAI,CAAA;IACjE,CAAC,CAAC,CAAA;AACJ,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@newskit-render/shared-components",
-  "version": "3.12.1",
+  "version": "3.13.0-alpha.1",
   "description": "Newskit Render Shared Components",
   "author": "",
   "license": "UNLICENSED",
@@ -37,6 +37,7 @@
     "@newskit-themes/tls": "0.0.0",
     "cookie": "0.5.0",
     "cross-fetch": "3.1.5",
+    "lodash.get": "4.4.2",
     "react-dates": "21.8.0",
     "striptags": "3.2.0"
   },