@empathyco/x-components 3.0.0-alpha.236 → 3.0.0-alpha.237

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file. See
 [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.0.0-alpha.237](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.236...@empathyco/x-components@3.0.0-alpha.237) (2022-12-01)
+
+### Features
+
+- **recommendations:** add `updateRecommendation` mutation (#891)
+  ([0e9ceec](https://github.com/empathyco/x/commit/0e9ceec145458a55ccbe4abf8e7b49f64d1717ae))
+
+# Change Log
+
+All notable changes to this project will be documented in this file. See
+[Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
 ## [3.0.0-alpha.236](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.235...@empathyco/x-components@3.0.0-alpha.236) (2022-11-29)
 
 ### Features

package/docs/API-reference/api/x-components.recommendationsmutations.md

@@ -19,4 +19,5 @@ export interface RecommendationsMutations extends StatusMutations
 |  --- | --- |
 |  [setParams(params)](./x-components.recommendationsmutations.setparams.md) | Sets the extra params of the module. |
 |  [setRecommendations(recommendations)](./x-components.recommendationsmutations.setrecommendations.md) | Sets the recommendations of the module. |
+|  [updateRecommendation(recommendation)](./x-components.recommendationsmutations.updaterecommendation.md) | Updates a recommendation with new fields. |
 

package/docs/API-reference/api/x-components.recommendationsmutations.updaterecommendation.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [RecommendationsMutations](./x-components.recommendationsmutations.md) &gt; [updateRecommendation](./x-components.recommendationsmutations.updaterecommendation.md)
+
+## RecommendationsMutations.updateRecommendation() method
+
+Updates a recommendation with new fields.
+
+<b>Signature:</b>
+
+```typescript
+updateRecommendation(recommendation: Partial<Result> & Pick<Result, 'id'>): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  recommendation | Partial&lt;Result&gt; &amp; Pick&lt;Result, 'id'&gt; | A recommendation containing at least an id and the properties to modify. |
+
+<b>Returns:</b>
+
+void
+

package/js/x-modules/recommendations/store/module.js

@@ -29,6 +29,12 @@ const recommendationsXStoreModule = {
         setStatus,
         setParams(state, params) {
             state.params = params;
+        },
+        updateRecommendation(state, recommendation) {
+            const stateRecommendation = state.recommendations.find(stateRecommendation => recommendation.id === stateRecommendation.id);
+            if (stateRecommendation) {
+                Object.assign(stateRecommendation, recommendation);
+            }
         }
     },
     actions: {

package/js/x-modules/recommendations/store/module.js.map

@@ -1 +1 @@
-{"version":3,"file":"module.js","sources":["../../../../../src/x-modules/recommendations/store/module.ts"],"sourcesContent":["import { setStatus } from '../../../store/utils/status-store.utils';\nimport {\n  cancelFetchAndSaveRecommendations,\n  fetchAndSaveRecommendations\n} from './actions/fetch-and-save-recommendations.action';\nimport { fetchRecommendations } from './actions/fetch-recommendations.action';\nimport { RECOMMENDATIONS_ORIGIN } from './constants';\nimport { request } from './getters/request.getter';\nimport { RecommendationsXStoreModule } from './types';\n\n/**\n * {@link XStoreModule} For the recommendations module.\n *\n * @internal\n */\nexport const recommendationsXStoreModule: RecommendationsXStoreModule = {\n  state: () => ({\n    config: {\n      maxItemsToRequest: 24\n    },\n    origin: RECOMMENDATIONS_ORIGIN,\n    status: 'initial',\n    recommendations: [],\n    params: {}\n  }),\n  getters: {\n    request\n  },\n  mutations: {\n    setRecommendations(state, recommendations) {\n      state.recommendations = recommendations;\n    },\n    setStatus,\n    setParams(state, params) {\n      state.params = params;\n    }\n  },\n  actions: {\n    cancelFetchAndSaveRecommendations,\n    fetchRecommendations,\n    fetchAndSaveRecommendations\n  }\n};\n"],"names":[],"mappings":";;;;;;AAUA;;;;;MAKa,2BAA2B,GAAgC;IACtE,KAAK,EAAE,OAAO;QACZ,MAAM,EAAE;YACN,iBAAiB,EAAE,EAAE;SACtB;QACD,MAAM,EAAE,sBAAsB;QAC9B,MAAM,EAAE,SAAS;QACjB,eAAe,EAAE,EAAE;QACnB,MAAM,EAAE,EAAE;KACX,CAAC;IACF,OAAO,EAAE;QACP,OAAO;KACR;IACD,SAAS,EAAE;QACT,kBAAkB,CAAC,KAAK,EAAE,eAAe;YACvC,KAAK,CAAC,eAAe,GAAG,eAAe,CAAC;SACzC;QACD,SAAS;QACT,SAAS,CAAC,KAAK,EAAE,MAAM;YACrB,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;SACvB;KACF;IACD,OAAO,EAAE;QACP,iCAAiC;QACjC,oBAAoB;QACpB,2BAA2B;KAC5B;;;;;"}
+{"version":3,"file":"module.js","sources":["../../../../../src/x-modules/recommendations/store/module.ts"],"sourcesContent":["import { setStatus } from '../../../store/utils/status-store.utils';\nimport {\n  cancelFetchAndSaveRecommendations,\n  fetchAndSaveRecommendations\n} from './actions/fetch-and-save-recommendations.action';\nimport { fetchRecommendations } from './actions/fetch-recommendations.action';\nimport { RECOMMENDATIONS_ORIGIN } from './constants';\nimport { request } from './getters/request.getter';\nimport { RecommendationsXStoreModule } from './types';\n\n/**\n * {@link XStoreModule} For the recommendations module.\n *\n * @internal\n */\nexport const recommendationsXStoreModule: RecommendationsXStoreModule = {\n  state: () => ({\n    config: {\n      maxItemsToRequest: 24\n    },\n    origin: RECOMMENDATIONS_ORIGIN,\n    status: 'initial',\n    recommendations: [],\n    params: {}\n  }),\n  getters: {\n    request\n  },\n  mutations: {\n    setRecommendations(state, recommendations) {\n      state.recommendations = recommendations;\n    },\n    setStatus,\n    setParams(state, params) {\n      state.params = params;\n    },\n    updateRecommendation(state, recommendation) {\n      const stateRecommendation = state.recommendations.find(\n        stateRecommendation => recommendation.id === stateRecommendation.id\n      );\n      if (stateRecommendation) {\n        Object.assign(stateRecommendation, recommendation);\n      }\n    }\n  },\n  actions: {\n    cancelFetchAndSaveRecommendations,\n    fetchRecommendations,\n    fetchAndSaveRecommendations\n  }\n};\n"],"names":[],"mappings":";;;;;;AAUA;;;;;MAKa,2BAA2B,GAAgC;IACtE,KAAK,EAAE,OAAO;QACZ,MAAM,EAAE;YACN,iBAAiB,EAAE,EAAE;SACtB;QACD,MAAM,EAAE,sBAAsB;QAC9B,MAAM,EAAE,SAAS;QACjB,eAAe,EAAE,EAAE;QACnB,MAAM,EAAE,EAAE;KACX,CAAC;IACF,OAAO,EAAE;QACP,OAAO;KACR;IACD,SAAS,EAAE;QACT,kBAAkB,CAAC,KAAK,EAAE,eAAe;YACvC,KAAK,CAAC,eAAe,GAAG,eAAe,CAAC;SACzC;QACD,SAAS;QACT,SAAS,CAAC,KAAK,EAAE,MAAM;YACrB,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;SACvB;QACD,oBAAoB,CAAC,KAAK,EAAE,cAAc;YACxC,MAAM,mBAAmB,GAAG,KAAK,CAAC,eAAe,CAAC,IAAI,CACpD,mBAAmB,IAAI,cAAc,CAAC,EAAE,KAAK,mBAAmB,CAAC,EAAE,CACpE,CAAC;YACF,IAAI,mBAAmB,EAAE;gBACvB,MAAM,CAAC,MAAM,CAAC,mBAAmB,EAAE,cAAc,CAAC,CAAC;aACpD;SACF;KACF;IACD,OAAO,EAAE;QACP,iCAAiC;QACjC,oBAAoB;QACpB,2BAA2B;KAC5B;;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empathyco/x-components",
-  "version": "3.0.0-alpha.236",
+  "version": "3.0.0-alpha.237",
   "description": "Empathy X Components",
   "author": "Empathy Systems Corporation S.L.",
   "license": "Apache-2.0",
@@ -135,5 +135,5 @@
     "access": "public",
     "directory": "dist"
   },
-  "gitHead": "634a16e805abc8871a8bcce33adeaf4afb7b68d3"
+  "gitHead": "1495e90ffaf7dbb91980a98698974b6d82d75a67"
 }

package/report/x-components.api.json

@@ -34872,6 +34872,82 @@
                 }
               ],
               "name": "setRecommendations"
+            },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@empathyco/x-components!RecommendationsMutations#updateRecommendation:member(1)",
+              "docComment": "/**\n * Updates a recommendation with new fields.\n *\n * @param recommendation - A recommendation containing at least an id and the properties to modify.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "updateRecommendation(recommendation: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Partial",
+                  "canonicalReference": "!Partial:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Result",
+                  "canonicalReference": "@empathyco/x-components!Result:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "> & "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Pick",
+                  "canonicalReference": "!Pick:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Result",
+                  "canonicalReference": "@empathyco/x-components!Result:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", 'id'>"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 10,
+                "endIndex": 11
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "recommendation",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 9
+                  }
+                }
+              ],
+              "name": "updateRecommendation"
             }
           ],
           "extendsTokenRanges": [

package/report/x-components.api.md

@@ -3305,6 +3305,7 @@ export interface RecommendationsGetters {
 export interface RecommendationsMutations extends StatusMutations {
     setParams(params: Dictionary<unknown>): void;
     setRecommendations(recommendations: Result[]): void;
+    updateRecommendation(recommendation: Partial<Result> & Pick<Result, 'id'>): void;
 }
 
 // @public

package/types/x-modules/recommendations/store/module.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"module.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/recommendations/store/module.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,2BAA2B,EAAE,MAAM,SAAS,CAAC;AAEtD;;;;GAIG;AACH,eAAO,MAAM,2BAA2B,EAAE,2BA2BzC,CAAC"}
+{"version":3,"file":"module.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/recommendations/store/module.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,2BAA2B,EAAE,MAAM,SAAS,CAAC;AAEtD;;;;GAIG;AACH,eAAO,MAAM,2BAA2B,EAAE,2BAmCzC,CAAC"}

package/types/x-modules/recommendations/store/types.d.ts

@@ -45,6 +45,13 @@ export interface RecommendationsMutations extends StatusMutations {
      * @param params - The new extra params.
      */
     setParams(params: Dictionary<unknown>): void;
+    /**
+     * Updates a recommendation with new fields.
+     *
+     * @param recommendation - A recommendation containing at least an id
+     * and the properties to modify.
+     */
+    updateRecommendation(recommendation: Partial<Result> & Pick<Result, 'id'>): void;
 }
 /**
  * Recommendations store actions.

package/types/x-modules/recommendations/store/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/recommendations/store/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AACpE,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9D,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,yCAAyC,CAAC;AACvF,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAExD;;;;GAIG;AACH,MAAM,WAAW,oBAAqB,SAAQ,WAAW;IACvD,sDAAsD;IACtD,MAAM,EAAE,qBAAqB,CAAC;IAC9B,uDAAuD;IACvD,MAAM,EAAE,MAAM,CAAC;IACf,yCAAyC;IACzC,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,8CAA8C;IAC9C,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,qEAAqE;IACrE,OAAO,EAAE,sBAAsB,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAyB,SAAQ,eAAe;IAC/D;;;;OAIG;IACH,kBAAkB,CAAC,eAAe,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IACpD;;;;OAIG;IACH,SAAS,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;CAC9C;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,iCAAiC,IAAI,IAAI,CAAC;IAC1C;;OAEG;IACH,2BAA2B,CAAC,OAAO,EAAE,sBAAsB,GAAG,IAAI,GAAG,IAAI,CAAC;IAC1E;;;;OAIG;IACH,oBAAoB,CAAC,OAAO,EAAE,sBAAsB,GAAG,IAAI,GAAG,MAAM,EAAE,CAAC;CACxE;AAED;;;;GAIG;AACH,oBAAY,2BAA2B,GAAG,YAAY,CACpD,oBAAoB,EACpB,sBAAsB,EACtB,wBAAwB,EACxB,sBAAsB,CACvB,CAAC;AAEF;;;;GAIG;AACH,oBAAY,4BAA4B,GAAG,cAAc,CACvD,oBAAoB,EACpB,sBAAsB,EACtB,wBAAwB,EACxB,sBAAsB,CACvB,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/recommendations/store/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AACpE,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9D,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,yCAAyC,CAAC;AACvF,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAExD;;;;GAIG;AACH,MAAM,WAAW,oBAAqB,SAAQ,WAAW;IACvD,sDAAsD;IACtD,MAAM,EAAE,qBAAqB,CAAC;IAC9B,uDAAuD;IACvD,MAAM,EAAE,MAAM,CAAC;IACf,yCAAyC;IACzC,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,8CAA8C;IAC9C,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,qEAAqE;IACrE,OAAO,EAAE,sBAAsB,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAyB,SAAQ,eAAe;IAC/D;;;;OAIG;IACH,kBAAkB,CAAC,eAAe,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IACpD;;;;OAIG;IACH,SAAS,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;IAC7C;;;;;OAKG;IACH,oBAAoB,CAAC,cAAc,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,IAAI,CAAC;CAClF;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,iCAAiC,IAAI,IAAI,CAAC;IAC1C;;OAEG;IACH,2BAA2B,CAAC,OAAO,EAAE,sBAAsB,GAAG,IAAI,GAAG,IAAI,CAAC;IAC1E;;;;OAIG;IACH,oBAAoB,CAAC,OAAO,EAAE,sBAAsB,GAAG,IAAI,GAAG,MAAM,EAAE,CAAC;CACxE;AAED;;;;GAIG;AACH,oBAAY,2BAA2B,GAAG,YAAY,CACpD,oBAAoB,EACpB,sBAAsB,EACtB,wBAAwB,EACxB,sBAAsB,CACvB,CAAC;AAEF;;;;GAIG;AACH,oBAAY,4BAA4B,GAAG,cAAc,CACvD,oBAAoB,EACpB,sBAAsB,EACtB,wBAAwB,EACxB,sBAAsB,CACvB,CAAC"}