@pagopa/selfcare-common-frontend 1.5.2 → 1.5.6

package/CHANGELOG.md

@@ -4,8 +4,32 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [v1.5.6](https://github.com/pagopa/selfcare-common-frontend/compare/v1.5.5...v1.5.6)
+
+- added useReduxCachedValue overloaded versions [`#31`](https://github.com/pagopa/selfcare-common-frontend/pull/31)
+
+#### [v1.5.5](https://github.com/pagopa/selfcare-common-frontend/compare/v1.5.4...v1.5.5)
+
+> 15 February 2022
+
+- useReduxCachedValueTranscoded transcode function will accept retrieverServiceArgs [`#30`](https://github.com/pagopa/selfcare-common-frontend/pull/30)
+
+#### [v1.5.4](https://github.com/pagopa/selfcare-common-frontend/compare/v1.5.3...v1.5.4)
+
+> 15 February 2022
+
+- fixed useReduxCachedValueTranscoded parameters types [`#29`](https://github.com/pagopa/selfcare-common-frontend/pull/29)
+
+#### [v1.5.3](https://github.com/pagopa/selfcare-common-frontend/compare/v1.5.2...v1.5.3)
+
+> 15 February 2022
+
+- added useReduxCachedValueTranscoded [`#28`](https://github.com/pagopa/selfcare-common-frontend/pull/28)
+
 #### [v1.5.2](https://github.com/pagopa/selfcare-common-frontend/compare/v1.5.1...v1.5.2)
 
+> 14 February 2022
+
 - Fixed useReduxCachedValue setterAction type [`#27`](https://github.com/pagopa/selfcare-common-frontend/pull/27)
 - Bump follow-redirects from 1.14.7 to 1.14.8 [`#26`](https://github.com/pagopa/selfcare-common-frontend/pull/26)
 

package/README.md

@@ -204,17 +204,32 @@ Cached values are stored using useRef, so they are local to the component using
 The sorting actually is applied using string representation
 
 ## useReduxCachedValue
-It will return a method that only at the very first invocation it will call the retrieverService only the first time, storing the obtained values, and returning always cached values.
+See [useReduxCachedValueParametricRetrieverTranscoded](#usereduxcachedvaluetranscoded) when there is not RETRIEVER_ARGS and RETRIEVED_VALUE === RETRIEVER_ARGS
+
+## useReduxCachedValueParametricRetriever
+See [useReduxCachedValueParametricRetrieverTranscoded](#usereduxcachedvaluetranscoded) when RETRIEVED_VALUE === RETRIEVER_ARGS
+
+## useReduxCachedValueTranscoded
+See [useReduxCachedValueParametricRetrieverTranscoded](#usereduxcachedvaluetranscoded) when there is not RETRIEVER_ARGS
+
+## useReduxCachedValueParametricRetrieverTranscoded
+It will return a method that will call the retrieverService only when there are not storing values, or a condition on them is not more verified.
 See useReduxCachedValue.test.tsx file for an example.
 
+Given the following type parametes:
+* RETRIEVED_VALUE the type desired
+* STORED_VALUE the type stored
+
 The arguments to provide to the custom hook are the following:
 
 | Prop | Type | Mandatory | Description |
 |------|------|-----------|-------------|
 | entity | string | Y | The name of the entity, used just for logging purpose |
-| retrieverService | () => Promise`<T>` | Y | The service that will retrieve the value |
-| reduxSelector | (state: any) => T | undefined | Y | The selector to verify if a value already exists |
-| reduxSetterAction | (value: T) => PayloadAction`<any>` | Y | The action to store the value |
+| retrieverService | (retrieverServiceArgs: RETRIEVER_ARGS) => Promise`<RETRIEVED_VALUE>` | Y | The service that will retrieve the value |
+| reduxSelector | (state: any) => STORED_VALUE | undefined | Y | The selector to read the value from redux |
+| reduxSetterAction | (value: RETRIEVED_VALUE, retrieverServiceArgs: RETRIEVER_ARGS) => PayloadAction`<STORED_VALUE>` | Y | The action to store the value |
+| selectedValue2RetrievedValue | (value: STORED_VALUE, args: RETRIEVER_ARGS) => RETRIEVED_VALUE | Y | A function called to transform STORED_VALUE into RETRIEVED_VALUE and called when hitting the cache |
+| selectedValuePredicate2Retrieve | (value: STORED_VALUE, retrieverServiceArgs: RETRIEVER_ARGS) => boolean | N | An optional predicate evaluated when reduxSelector returned some value in order to compare it against the retrieverServiceArgs and evaluate if retrieverService should be called again |
 | alwaysRetrieve | boolean | N | If true, it will always retrieve and store the new value |
 
 # Features

package/build.info

@@ -1,2 +1,2 @@
-20220214.2 - selfcare-common-frontend.deploy(20361)
-tags/v1.5.2^0 e3f44b5032269a2cdb3136c6fd00f4a803d7457d
+20220215.4 - selfcare-common-frontend.deploy(20523)
+tags/v1.5.6^0 a10eb0eb4a982c94dbdc31dd302451d6f6b9ac4d

package/hooks/useReduxCachedValue.d.ts

@@ -1,4 +1,14 @@
 import { PayloadAction } from '@reduxjs/toolkit';
-/** It will return a method that only at the very first invocation it will call the retrieverService only the first time, storing the obtained values, and returning always cached values */
-declare const useReduxCachedValue: <T extends any[] | Record<string, any>>(entity: string, retrieverService: () => Promise<T>, reduxSelector: (state: any) => T | undefined, reduxSetterAction: (value: T) => PayloadAction<any>, alwaysRetrieve?: boolean | undefined) => () => Promise<T>;
+/** @see {useReduxCachedValue} when there is not RETRIEVER_ARGS and RETRIEVED_VALUE === STORED_VALUE */
+declare const useReduxCachedValue: <RETRIEVED_VALUE extends Record<string, any>>(entity: string, retrieverService: () => Promise<RETRIEVED_VALUE>, reduxSelector: (state: any) => RETRIEVED_VALUE | undefined, reduxSetterAction: (value: RETRIEVED_VALUE) => PayloadAction<any>, selectedValuePredicate2Retrieve?: ((value: RETRIEVED_VALUE) => boolean) | undefined, alwaysRetrieve?: boolean | undefined) => () => Promise<RETRIEVED_VALUE>;
+/** @see {useReduxCachedValueParametricRetrieverTranscoded} when there is not RETRIEVER_ARGS */
+export declare const useReduxCachedValueTranscoded: <RETRIEVED_VALUE, STORED_VALUE>(entity: string, retrieverService: () => Promise<RETRIEVED_VALUE>, reduxSelector: (state: any) => STORED_VALUE | undefined, reduxSetterAction: (value: RETRIEVED_VALUE) => {
+    payload: STORED_VALUE;
+    type: string;
+}, selectedValue2RetrievedValue: (value: STORED_VALUE) => RETRIEVED_VALUE, selectedValuePredicate2Retrieve?: ((value: STORED_VALUE) => boolean) | undefined, alwaysRetrieve?: boolean | undefined) => () => Promise<RETRIEVED_VALUE>;
+/** It will return a method that will call the retrieverService only when there are not storing values, or a condition on them is not more verified */
+export declare const useReduxCachedValueParametricRetrieverTranscoded: <RETRIEVED_VALUE, STORED_VALUE, RETRIEVER_ARGS>(entity: string, retrieverService: (retrieverServiceArgs: RETRIEVER_ARGS) => Promise<RETRIEVED_VALUE>, reduxSelector: (state: any) => STORED_VALUE | undefined, reduxSetterAction: (value: RETRIEVED_VALUE, retrieverServiceArgs: RETRIEVER_ARGS) => {
+    payload: STORED_VALUE;
+    type: string;
+}, selectedValue2RetrievedValue: (value: STORED_VALUE, args: RETRIEVER_ARGS) => RETRIEVED_VALUE, selectedValuePredicate2Retrieve?: ((value: STORED_VALUE, args: RETRIEVER_ARGS) => boolean) | undefined, alwaysRetrieve?: boolean | undefined) => (retrieverServiceArgs: RETRIEVER_ARGS) => Promise<RETRIEVED_VALUE>;
 export default useReduxCachedValue;

package/hooks/useReduxCachedValue.js

@@ -1,39 +1,55 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.useReduxCachedValueParametricRetrieverTranscoded = exports.useReduxCachedValueTranscoded = void 0;
 const tslib_1 = require("tslib");
 const react_redux_1 = require("react-redux");
 const constants_1 = require("../utils/constants");
 const useLoading_1 = (0, tslib_1.__importDefault)(require("./useLoading"));
-/** It will return a method that only at the very first invocation it will call the retrieverService only the first time, storing the obtained values, and returning always cached values */
-const useReduxCachedValue = (
+/** @see {useReduxCachedValue} when there is not RETRIEVER_ARGS and RETRIEVED_VALUE === STORED_VALUE */
+const useReduxCachedValue = (entity, retrieverService, reduxSelector, reduxSetterAction, selectedValuePredicate2Retrieve, alwaysRetrieve) => useReduxCachedValueParametricRetriever(entity, retrieverService, reduxSelector, reduxSetterAction, selectedValuePredicate2Retrieve, alwaysRetrieve);
+/** @see {useReduxCachedValueParametricRetrieverTranscoded} when RETRIEVED_VALUE === STORED_VALUE */
+const useReduxCachedValueParametricRetriever = (entity, retrieverService, reduxSelector, reduxSetterAction, selectedValuePredicate2Retrieve, alwaysRetrieve) => (0, exports.useReduxCachedValueParametricRetrieverTranscoded)(entity, retrieverService, reduxSelector, reduxSetterAction, (value) => value, selectedValuePredicate2Retrieve, alwaysRetrieve);
+/** @see {useReduxCachedValueParametricRetrieverTranscoded} when there is not RETRIEVER_ARGS */
+const useReduxCachedValueTranscoded = (entity, retrieverService, reduxSelector, reduxSetterAction, selectedValue2RetrievedValue, selectedValuePredicate2Retrieve, alwaysRetrieve) => (0, exports.useReduxCachedValueParametricRetrieverTranscoded)(entity, retrieverService, reduxSelector, reduxSetterAction, selectedValue2RetrievedValue, selectedValuePredicate2Retrieve, alwaysRetrieve);
+exports.useReduxCachedValueTranscoded = useReduxCachedValueTranscoded;
+/** It will return a method that will call the retrieverService only when there are not storing values, or a condition on them is not more verified */
+const useReduxCachedValueParametricRetrieverTranscoded = (
 /** The name of the entity, used just for logging purpose */
 entity, 
 /** The service that will retrieve the value */
 retrieverService, 
-/** The selector to verify if a value already exists */
+/** The selector to read the value from redux */
 reduxSelector, 
-/** The action to store the value */
+/** The action to store the new value */
 reduxSetterAction, 
+/** A function called to transform STORED_VALUE into RETRIEVED_VALUE and called when hitting the cache */
+selectedValue2RetrievedValue, 
+/** An optional predicate evaluated when reduxSelector returned some value in order to compare it against the retrieverServiceArgs and evaluate if retrieverService should be called again  */
+selectedValuePredicate2Retrieve, 
 /** If true, it will always retrieve and store the new value */
 alwaysRetrieve) => {
     const dispatch = (0, react_redux_1.useDispatch)();
     const entities = (0, react_redux_1.useSelector)(reduxSelector);
-    const setEntities = (value) => dispatch(reduxSetterAction(value));
+    const setEntities = (value, retrieverServiceArgs) => dispatch(reduxSetterAction(value, retrieverServiceArgs));
     const setLoading = (0, useLoading_1.default)(`${constants_1.LOADING_TASK_RETRIEVE_CACHED_VALUES}_${entity}`);
-    return () => {
-        if (alwaysRetrieve || !entities) {
+    return (retrieverServiceArgs) => {
+        if (alwaysRetrieve ||
+            !entities ||
+            (selectedValuePredicate2Retrieve &&
+                selectedValuePredicate2Retrieve(entities, retrieverServiceArgs))) {
             setLoading(true);
-            return retrieverService()
+            return retrieverService(retrieverServiceArgs)
                 .then((e) => {
-                setEntities(e);
+                setEntities(e, retrieverServiceArgs);
                 return e;
             })
                 .finally(() => setLoading(false));
         }
         else {
-            return new Promise((resolve) => resolve(entities));
+            return new Promise((resolve) => resolve(selectedValue2RetrievedValue(entities, retrieverServiceArgs)));
         }
     };
 };
+exports.useReduxCachedValueParametricRetrieverTranscoded = useReduxCachedValueParametricRetrieverTranscoded;
 exports.default = useReduxCachedValue;
 //# sourceMappingURL=useReduxCachedValue.js.map

package/hooks/useReduxCachedValue.js.map

@@ -1 +1 @@
-{"version":3,"file":"useReduxCachedValue.js","sourceRoot":"","sources":["../../src/lib/hooks/useReduxCachedValue.tsx"],"names":[],"mappings":";;;AACA,6CAAuD;AACvD,kDAAyE;AACzE,2EAAsC;AAEtC,4LAA4L;AAC5L,MAAM,mBAAmB,GAAG;AAC1B,4DAA4D;AAC5D,MAAc;AACd,+CAA+C;AAC/C,gBAAkC;AAClC,uDAAuD;AACvD,aAA4C;AAC5C,oCAAoC;AACpC,iBAAmD;AACnD,+DAA+D;AAC/D,cAAwB,EACJ,EAAE;IACtB,MAAM,QAAQ,GAAG,IAAA,yBAAW,GAAE,CAAC;IAC/B,MAAM,QAAQ,GAAG,IAAA,yBAAW,EAAC,aAAa,CAAC,CAAC;IAC5C,MAAM,WAAW,GAAG,CAAC,KAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC;IAErE,MAAM,UAAU,GAAG,IAAA,oBAAU,EAAC,GAAG,+CAAmC,IAAI,MAAM,EAAE,CAAC,CAAC;IAElF,OAAO,GAAe,EAAE;QACtB,IAAI,cAAc,IAAI,CAAC,QAAQ,EAAE;YAC/B,UAAU,CAAC,IAAI,CAAC,CAAC;YACjB,OAAO,gBAAgB,EAAE;iBACtB,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;gBACV,WAAW,CAAC,CAAC,CAAC,CAAC;gBACf,OAAO,CAAC,CAAC;YACX,CAAC,CAAC;iBACD,OAAO,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;SACrC;aAAM;YACL,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;SACpD;IACH,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF,kBAAe,mBAAmB,CAAC"}
+{"version":3,"file":"useReduxCachedValue.js","sourceRoot":"","sources":["../../src/lib/hooks/useReduxCachedValue.tsx"],"names":[],"mappings":";;;;AACA,6CAAuD;AACvD,kDAAyE;AACzE,2EAAsC;AAEtC,uGAAuG;AACvG,MAAM,mBAAmB,GAAG,CAC1B,MAAc,EACd,gBAAgD,EAChD,aAA0D,EAC1D,iBAAiE,EACjE,+BAAqE,EACrE,cAAwB,EACU,EAAE,CACpC,sCAAsC,CACpC,MAAM,EACN,gBAAgB,EAChB,aAAa,EACb,iBAAiB,EACjB,+BAA+B,EAC/B,cAAc,CACmB,CAAC;AAEtC,oGAAoG;AACpG,MAAM,sCAAsC,GAAG,CAC7C,MAAc,EACd,gBAAoF,EACpF,aAA0D,EAC1D,iBAGuB,EACvB,+BAA2F,EAC3F,cAAwB,EAC8C,EAAE,CACxE,IAAA,wDAAgD,EAC9C,MAAM,EACN,gBAAgB,EAChB,aAAa,EACb,iBAAiB,EACjB,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,EAChB,+BAA+B,EAC/B,cAAc,CACf,CAAC;AAEJ,+FAA+F;AACxF,MAAM,6BAA6B,GAAG,CAC3C,MAAc,EACd,gBAAgD,EAChD,aAAuD,EACvD,iBAA0E,EAC1E,4BAAsE,EACtE,+BAAkE,EAClE,cAAwB,EACU,EAAE,CACpC,IAAA,wDAAgD,EAC9C,MAAM,EACN,gBAAgB,EAChB,aAAa,EACb,iBAAiB,EACjB,4BAA4B,EAC5B,+BAA+B,EAC/B,cAAc,CACmB,CAAC;AAjBzB,QAAA,6BAA6B,iCAiBJ;AAEtC,sJAAsJ;AAC/I,MAAM,gDAAgD,GAAG;AAK9D,4DAA4D;AAC5D,MAAc;AACd,+CAA+C;AAC/C,gBAAoF;AACpF,gDAAgD;AAChD,aAAuD;AACvD,wCAAwC;AACxC,iBAGgC;AAChC,yGAAyG;AACzG,4BAA4F;AAC5F,8LAA8L;AAC9L,+BAAwF;AACxF,+DAA+D;AAC/D,cAAwB,EAC8C,EAAE;IACxE,MAAM,QAAQ,GAAG,IAAA,yBAAW,GAAE,CAAC;IAC/B,MAAM,QAAQ,GAAG,IAAA,yBAAW,EAAC,aAAa,CAAC,CAAC;IAC5C,MAAM,WAAW,GAAG,CAAC,KAAsB,EAAE,oBAAoC,EAAE,EAAE,CACnF,QAAQ,CAAC,iBAAiB,CAAC,KAAK,EAAE,oBAAoB,CAAC,CAAC,CAAC;IAE3D,MAAM,UAAU,GAAG,IAAA,oBAAU,EAAC,GAAG,+CAAmC,IAAI,MAAM,EAAE,CAAC,CAAC;IAElF,OAAO,CAAC,oBAAoC,EAA4B,EAAE;QACxE,IACE,cAAc;YACd,CAAC,QAAQ;YACT,CAAC,+BAA+B;gBAC9B,+BAA+B,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAAC,EAClE;YACA,UAAU,CAAC,IAAI,CAAC,CAAC;YACjB,OAAO,gBAAgB,CAAC,oBAAoB,CAAC;iBAC1C,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;gBACV,WAAW,CAAC,CAAC,EAAE,oBAAoB,CAAC,CAAC;gBACrC,OAAO,CAAC,CAAC;YACX,CAAC,CAAC;iBACD,OAAO,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;SACrC;aAAM;YACL,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAC7B,OAAO,CAAC,4BAA4B,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAAC,CACtE,CAAC;SACH;IACH,CAAC,CAAC;AACJ,CAAC,CAAC;AAlDW,QAAA,gDAAgD,oDAkD3D;AAEF,kBAAe,mBAAmB,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pagopa/selfcare-common-frontend",
   "description": "Shared React components for the pagopa selfcare project",
-  "version": "1.5.2",
+  "version": "1.5.6",
   "license": "MIT",
   "repository": "https://github.com/pagopa/selfcare-common-frontend",
   "author": "https://www.pagopa.gov.it",