From b9a38d9ecc07cb090dbb78b411229a57051ef974 Mon Sep 17 00:00:00 2001
From: build-pipeline <build-token>
Date: Wed, 27 Sep 2023 15:12:42 +0000
Subject: [PATCH] publish: Merge branch 'eslint-jsdoc' into 'dev'
generated from commit 24753cdaddfaab8f5e17ab4d8d873887e2e3860f
---
...527a.js => ecolyo.0e7075395106b365ed5f.js} | 8 +-
...25c4.js => ecolyo.bfd96d472461bdf5b54d.js} | 14 +-
...bbdf.js => ecolyo.4824f2d68a0d314b7c80.js} | 13 -
...be5b.js => ecolyo.956a8c573a35bacc88c0.js} | 278 ++----------------
index.html | 2 +-
services/aggregatorUsageEvents/ecolyo.js | 216 +-------------
services/consumptionAlert/ecolyo.js | 31 +-
.../enedisHalfHourMonthlyAnalysis/ecolyo.js | 71 +----
services/fluidsPrices/ecolyo.js | 45 +--
services/monthlyReportNotification/ecolyo.js | 34 +--
10 files changed, 73 insertions(+), 639 deletions(-)
rename 1/{ecolyo.1a5ceac1d989c9e1527a.js => ecolyo.0e7075395106b365ed5f.js} (99%)
rename 7/{ecolyo.9377682bc269ccdf25c4.js => ecolyo.bfd96d472461bdf5b54d.js} (99%)
rename 9/{ecolyo.30da7dc1931663d9bbdf.js => ecolyo.4824f2d68a0d314b7c80.js} (95%)
rename app/{ecolyo.30a9d64fd26b85d9be5b.js => ecolyo.956a8c573a35bacc88c0.js} (99%)
diff --git a/1/ecolyo.1a5ceac1d989c9e1527a.js b/1/ecolyo.0e7075395106b365ed5f.js
similarity index 99%
rename from 1/ecolyo.1a5ceac1d989c9e1527a.js
rename to 1/ecolyo.0e7075395106b365ed5f.js
index caaf7f54a..db6ca62bc 100644
--- a/1/ecolyo.1a5ceac1d989c9e1527a.js
+++ b/1/ecolyo.0e7075395106b365ed5f.js
@@ -7038,10 +7038,10 @@ var ConnectionResult = function ConnectionResult(_ref) {
var consentError = konnectorError === _enums.KonnectorUpdate.ERROR_CONSENT_FORM_GAS || konnectorError === _enums.KonnectorUpdate.ERROR_UPDATE_OAUTH;
/**
* Get Konnector state, possible values:
- * * partner maintenance
- * * error state
- * * outdated
- * * last update date
+ * - partner maintenance
+ * - error state
+ * - outdated
+ * - last update date
*/
var getConnectionStatus = function getConnectionStatus() {
diff --git a/7/ecolyo.9377682bc269ccdf25c4.js b/7/ecolyo.bfd96d472461bdf5b54d.js
similarity index 99%
rename from 7/ecolyo.9377682bc269ccdf25c4.js
rename to 7/ecolyo.bfd96d472461bdf5b54d.js
index caa6995c1..720c08806 100644
--- a/7/ecolyo.9377682bc269ccdf25c4.js
+++ b/7/ecolyo.bfd96d472461bdf5b54d.js
@@ -534,7 +534,6 @@ var FluidPricesService = /*#__PURE__*/function () {
}
/**
* Get all prices available in database
- * @returns {FluidPrice[]}
*/
@@ -574,9 +573,6 @@ var FluidPricesService = /*#__PURE__*/function () {
}()
/**
* Get a price according to a fluidType and a data. This method return the nearest and valid price for the given date.
- * @param {FluidType} fluidType
- * @param {DateTime} date
- * @returns {FluidPrice}
*/
}, {
@@ -623,7 +619,6 @@ var FluidPricesService = /*#__PURE__*/function () {
}()
/**
* Get current prices for all fluidTypes.
- * @returns {FluidPrice[]}
*/
}, {
@@ -779,8 +774,7 @@ var FluidPricesService = /*#__PURE__*/function () {
}()
/**
* Check if a fluidprice exists in db
- * @param {FluidPrice} fluidPrice
- * @returns {FluidPrice | null} price or null
+ * @returns {Promise<FluidPrice | null>} price or null
*/
}, {
@@ -835,8 +829,7 @@ var FluidPricesService = /*#__PURE__*/function () {
}()
/**
* Creates a new fluidPrice
- * @param {FluidPrice} fluidPrice
- * @returns {FluidPrice | null} price or null
+ * @returns {Promise<FluidPrice | null>} price or null
*/
}, {
@@ -885,9 +878,6 @@ var FluidPricesService = /*#__PURE__*/function () {
}()
/**
* Updates a price in db
- * @param {FluidPrice} doc
- * @param {Partial<FluidPrice>} attributes
- * @returns {FluidPrice | null}
*/
}, {
diff --git a/9/ecolyo.30da7dc1931663d9bbdf.js b/9/ecolyo.4824f2d68a0d314b7c80.js
similarity index 95%
rename from 9/ecolyo.30da7dc1931663d9bbdf.js
rename to 9/ecolyo.4824f2d68a0d314b7c80.js
index 6e05ee027..5a9fc229e 100644
--- a/9/ecolyo.30da7dc1931663d9bbdf.js
+++ b/9/ecolyo.4824f2d68a0d314b7c80.js
@@ -91,7 +91,6 @@ var EnedisMonthlyAnalysisDataService = /*#__PURE__*/function () {
}
/**
* Retrieve all exploration entities from db
- * @returns {EnedisMonthlyAnalysisData[]}
*/
@@ -130,8 +129,6 @@ var EnedisMonthlyAnalysisDataService = /*#__PURE__*/function () {
}()
/**
* getLastEnedisMonthlyAnalysis
- * @param {Client} client
- * @returns {Promise<EnedisMonthlyAnalysisData[]>}
*/
}, {
@@ -171,8 +168,6 @@ var EnedisMonthlyAnalysisDataService = /*#__PURE__*/function () {
}()
/**
* Aggregates Enedis Analysis data in order to create Dataload injectable in graph component
- * @param {EnedisMonthlyAnalysisData} data
- * @returns {AggregatedEnedisMonthlyDataloads}
*/
}, {
@@ -180,9 +175,6 @@ var EnedisMonthlyAnalysisDataService = /*#__PURE__*/function () {
value:
/**
* Get an enedis monthly analysis for given month and year
- * @param {number} year
- * @param {number} month
- * @returns {Promise<EnedisMonthlyAnalysisData[]>}
*/
function () {
var _getEnedisMonthlyAnalysisByDate = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(year, month) {
@@ -222,8 +214,6 @@ var EnedisMonthlyAnalysisDataService = /*#__PURE__*/function () {
}()
/**
* Creates a new EnedisMonthlyAnalysis
- * @param {EnedisMonthlyAnalysisData} newEnedisMonthlyAnalysisData
- * @returns {Promise<EnedisMonthlyAnalysisData | null>}
*/
}, {
@@ -272,9 +262,6 @@ var EnedisMonthlyAnalysisDataService = /*#__PURE__*/function () {
}()
/**
* Get Max power for a given month and year
- * @param {number} year
- * @param {number} month
- * @returns {Promise<MaxPowerEntity[]>}
*/
}, {
diff --git a/app/ecolyo.30a9d64fd26b85d9be5b.js b/app/ecolyo.956a8c573a35bacc88c0.js
similarity index 99%
rename from app/ecolyo.30a9d64fd26b85d9be5b.js
rename to app/ecolyo.956a8c573a35bacc88c0.js
index 926e6e8ae..3d1f00b9a 100644
--- a/app/ecolyo.30a9d64fd26b85d9be5b.js
+++ b/app/ecolyo.956a8c573a35bacc88c0.js
@@ -64,7 +64,7 @@
/******/
/******/ // script path function
/******/ function jsonpScriptSrc(chunkId) {
-/******/ return __webpack_require__.p + "" + ({}[chunkId]||chunkId) + "/ecolyo." + {"1":"1a5ceac1d989c9e1527a","2":"62e5292a592368584bc8","4":"ed87413fc9f81039a5c7","5":"d5601eac9d2424eaf101","6":"19b72783897b01dc97e2","7":"9377682bc269ccdf25c4","8":"cd70845caf52d7dce840","9":"30da7dc1931663d9bbdf","10":"2946952809565809b75b"}[chunkId] + ".js"
+/******/ return __webpack_require__.p + "" + ({}[chunkId]||chunkId) + "/ecolyo." + {"1":"0e7075395106b365ed5f","2":"62e5292a592368584bc8","4":"ed87413fc9f81039a5c7","5":"d5601eac9d2424eaf101","6":"19b72783897b01dc97e2","7":"bfd96d472461bdf5b54d","8":"cd70845caf52d7dce840","9":"4824f2d68a0d314b7c80","10":"2946952809565809b75b"}[chunkId] + ".js"
/******/ }
/******/
/******/ // The require function
@@ -2759,8 +2759,6 @@ var ProfileService = /*#__PURE__*/function () {
}
/**
* Retrieve Profile from the ProfileEntity
- * @param {ProfileEntity} profileEntity
- * @returns {Profile}
*/
}, {
@@ -4200,7 +4198,6 @@ var ProfileEcogestureService = /*#__PURE__*/function () {
}
/**
* Retrieve the ProfileEcogesture from db
- * @returns {ProfileEcogesture}
*/
@@ -4249,7 +4246,6 @@ var ProfileEcogestureService = /*#__PURE__*/function () {
}()
/**
* Saves ProfileEcogesture in database
- * @returns {ProfileEcogesture}
*/
}, {
@@ -4741,7 +4737,6 @@ var ActionService = /*#__PURE__*/function () {
}
/**
* Get the list of available actions
- * @returns {Promise<Ecogesture[]>}
*/
@@ -4810,8 +4805,7 @@ var ActionService = /*#__PURE__*/function () {
return getAvailableActionList;
}()
/**
- * Get default eocgestures
- * @returns {Promise<Ecogesture[]>}
+ * Get default ecogestures
*/
}, {
@@ -4845,9 +4839,7 @@ var ActionService = /*#__PURE__*/function () {
return getDefaultActions;
}()
- /** Complete the list with unfinished default ecogestures
- * @returns {Promise<Ecogesture[]>}
- */
+ /** Complete the list with unfinished default ecogestures */
}, {
key: "keepListComplete",
@@ -4886,13 +4878,6 @@ var ActionService = /*#__PURE__*/function () {
return keepListComplete;
}()
- /**
- *
- * @param {Ecogesture[]} filteredList
- * @param {Ecogesture[]} actionList
- * @returns {Ecogesture[]}
- */
-
}, {
key: "completeWithNoSeason",
value: function completeWithNoSeason(filteredList, actionList) {
@@ -4915,8 +4900,6 @@ var ActionService = /*#__PURE__*/function () {
}
/**
* filterBySeason - Filter action list depending on current season
- * @param {Ecogesture[]} actionList
- * @returns {Ecogesture[]}
*/
}, {
@@ -4945,8 +4928,6 @@ var ActionService = /*#__PURE__*/function () {
}
/**
* getCustomActions - Filter action by fluid and season and sort them by difficulty first and efficiency second
- * @param {FluidType[]} connectedFluids
- * @returns {Promise<Ecogesture[]>}
*/
}, {
@@ -5015,8 +4996,6 @@ var ActionService = /*#__PURE__*/function () {
}()
/**
* launchAction - parse ecogesture to UserAction and launch it
- * @param {Ecogesture} Ecogesture
- * @returns {UserAction}
*/
}, {
@@ -5033,8 +5012,7 @@ var ActionService = /*#__PURE__*/function () {
}
/**
* awaitNotificationAction
- * @param {UserAction} UserAction
- * @returns {UserAction} - updated user action
+ * @returns {UserAction} updated user action
*/
}, {
@@ -5048,8 +5026,7 @@ var ActionService = /*#__PURE__*/function () {
}
/**
* endAction
- * @param {UserAction} UserAction
- * @returns {UserAction} - updated user action
+ * @returns {UserAction} updated user action
*/
}, {
@@ -5063,8 +5040,6 @@ var ActionService = /*#__PURE__*/function () {
}
/**
* isActionDone - Set Action state to notification if progress > actionDuration
- * @param {UserChallenge} currentChallenge
- * @returns {Promise<UserChallenge | null>}
*/
}, {
@@ -7304,7 +7279,6 @@ var ProfileTypeService = /*#__PURE__*/function () {
}
/**
* calculateWarmingCorrectedConsumption
- * @param {number} estimatedConsumption
* @returns {number} - Corrected consumption
*/
@@ -7367,10 +7341,8 @@ var ProfileTypeService = /*#__PURE__*/function () {
}
/**
* calculateWarmingMonthConsumption
- @param {number} correctedConsumption
- @param {number} number
@returns {number} monthConsumption
- */
+ */
}, {
key: "calculateWarmingMonthConsumption",
@@ -7405,8 +7377,6 @@ var ProfileTypeService = /*#__PURE__*/function () {
}()
/**
* getMonthHeating
- * @param {ProfileType} profileType
- * @param {number} month
* @returns {number} Month heating consumption in kw/h
*/
@@ -7444,9 +7414,6 @@ var ProfileTypeService = /*#__PURE__*/function () {
}()
/**
* Calculate water raw needs by month
- *
- * @param {ProfileType} profileType
- * @param {number} month
* @returns {number} rawConsumption
*/
@@ -7470,9 +7437,6 @@ var ProfileTypeService = /*#__PURE__*/function () {
}
/**
* Calculate spread water needs by month
- *
- * @param {ProfileType} profileType
- * @param {number} month
* @returns {number} spreadConsumption
*/
@@ -7495,9 +7459,6 @@ var ProfileTypeService = /*#__PURE__*/function () {
}
/**
* Calculate total ecs consumption by month
- *
- * @param {number} spreadConsumption
- * @param {ProfileType} profileType
* @returns {number} monthEcsConsumption
*/
@@ -7522,9 +7483,6 @@ var ProfileTypeService = /*#__PURE__*/function () {
}
/**
* Get ECS consumption by month
- *
- * @param {ProfileType} profileType
- * @param {number} month
* @returns {number} monthEcsConsumption
*/
@@ -7537,8 +7495,6 @@ var ProfileTypeService = /*#__PURE__*/function () {
}
/**
* Get cooking consumption by month
- * @param {ProfileType} profileType
- * @param {number} month
* @returns {number} monthCookingConsumption
*/
@@ -7558,8 +7514,6 @@ var ProfileTypeService = /*#__PURE__*/function () {
}
/**
* Get specific electricity consumption by month
- * @param {ProfileType} profileType
- * @param {number} month
* @returns {number} monthElectricSpecificConsumption
*/
@@ -7579,8 +7533,6 @@ var ProfileTypeService = /*#__PURE__*/function () {
}
/**
* Get cold water consumption by month
- * @param {ProfileType} profileType
- * @param {number} month
* @returns {number} monthColdWaterConsumption
*/
@@ -7606,9 +7558,7 @@ var ProfileTypeService = /*#__PURE__*/function () {
}
/**
* getDetailsMonthlyForecast
- * @param {FluidType} fluidType
- * @param {number} month
- * @returns {number} DetailsMonthlyForecast
+ * @returns DetailsMonthlyForecast
*/
}, {
@@ -7681,13 +7631,6 @@ var ProfileTypeService = /*#__PURE__*/function () {
return getDetailsMonthlyForecast;
}()
- /**
- * getFluidForecast
- * @param {FluidType} fluidType
- * @param {number} month
- @returns {FluidForecast} fluidForecast
- */
-
}, {
key: "getFluidForecast",
value: function () {
@@ -7732,8 +7675,7 @@ var ProfileTypeService = /*#__PURE__*/function () {
}()
/**
* getMonthlyForecast
- * @param {number} month
- * @returns {MonthlyForecast} MonthlyForecast
+ * @returns {Promise<MonthlyForecast>} MonthlyForecast
*/
}, {
@@ -7783,9 +7725,7 @@ var ProfileTypeService = /*#__PURE__*/function () {
}()
/**
* Try to fetch dju from remote doctype, if no data or error, return default data
- * @param {Client} client
- * @param {number} month
- * @returns {number} monthDju
+ * @returns {Promise<number>} monthDju
*/
}], [{
@@ -7793,7 +7733,6 @@ var ProfileTypeService = /*#__PURE__*/function () {
value:
/**
* checkConsistency
- * @param {ProfileType} profileType
* @returns {ProfileType} consistent profile type
*/
function checkConsistency(profileType) {
@@ -9406,13 +9345,10 @@ var ConsumptionDataManager = /*#__PURE__*/function () {
}()
/**
* Retrieves an array of fluid types that have incomplete data for a given month.
- *
+ *
* Data is incomplete if at least one daily data is missing for the month.
- *
- * @param {FluidType[]} fluidTypes
* @param {DateTime} month - The month for which to check the data completeness.
- * @returns {Promise<FluidType[]>}
- */
+ */
}, {
key: "getFluidsWithIncompleteData",
@@ -9823,7 +9759,6 @@ var ConsumptionDataManager = /*#__PURE__*/function () {
}
/**
* getLastHourData
- * @param {Client} client
* @param {number} month number
* @returns {Promise<DataloadEntity[]>} usageEvent added
*/
@@ -9871,8 +9806,6 @@ var ConsumptionDataManager = /*#__PURE__*/function () {
}()
/**
* Get the first entry of a given data doctype (enedis, grdf, egl)
- * @param doctype
- * @returns
*/
}, {
@@ -10497,7 +10430,6 @@ var QuizService = /*#__PURE__*/function () {
}
/**
* Retrieve all quiz entities from db
- * @returns {QuizEntity[]}
*/
@@ -10536,9 +10468,7 @@ var QuizService = /*#__PURE__*/function () {
}()
/**
* Retrieve quiz entities from db given the id
- *
* @param {string} quizId - ID of the searched quiz
- * @returns {QuizEntity}
*/
}, {
@@ -10639,7 +10569,6 @@ var QuizService = /*#__PURE__*/function () {
* Return quiz created from quiz entity
* @param {QuizEntity[]} quizEntityList - userQuiz to update
* @param {string} searchId - userQuiz to update
- * @returns {UserQuiz}
*/
}, {
@@ -10677,8 +10606,6 @@ var QuizService = /*#__PURE__*/function () {
}
/**
* Return UserQuestion created from QuestionEntity
- * @param {QuestionEntity}
- * @returns {UserQuestion}
*/
}, {
@@ -10692,8 +10619,6 @@ var QuizService = /*#__PURE__*/function () {
}
/**
* Return UserCustomQuestion created from CustomQuestionEntity
- * @param {CustomQuestionEntity}
- * @returns {UserCustomQuestion}
*/
}, {
@@ -10707,8 +10632,6 @@ var QuizService = /*#__PURE__*/function () {
}
/**
* Return UserQuiz created from QuizEntity
- * @param {QuizEntity}
- * @returns {UserQuiz}
*/
}, {
@@ -10738,7 +10661,6 @@ var QuizService = /*#__PURE__*/function () {
/**
* Return quiz with updated state to UserQuizState.ONGOING and randomize question and answers
* @param {UserQuiz} userQuiz - userQuiz to update
- * @returns {UserQuiz}
*/
}, {
@@ -10780,7 +10702,6 @@ var QuizService = /*#__PURE__*/function () {
/**
* Return quiz with updated state to UserQuizState.UNLOCKED and updated questions with false result
* @param {UserQuiz} userQuiz - userQuiz to update
- * @returns {UserQuiz}
*/
}, {
@@ -10824,7 +10745,6 @@ var QuizService = /*#__PURE__*/function () {
/**
* Return quiz with updated state to UserQuizState.DONE
* @param {UserQuiz} userQuiz - userQuiz to update
- * @returns {UserQuiz}
*/
}, {
@@ -10858,9 +10778,6 @@ var QuizService = /*#__PURE__*/function () {
/**
* Return quiz with result and updated question or customQuestion if no index is passed
* @param {UserQuiz} userQuiz - userQuiz to update
- * @returns {UserQuiz}
- * @returns {questionIndex}
- * @returns {questionResult}
*/
}, {
@@ -10907,9 +10824,6 @@ var QuizService = /*#__PURE__*/function () {
}()
/**
* Build a custom question with the customQuestionEntity
- * @param customQuestionEntity
- * @param fluidType
- * @returns {QuestionEntity}
*/
}, {
@@ -11015,9 +10929,6 @@ var QuizService = /*#__PURE__*/function () {
}()
/**
* Get the interval needed for the further calculs
- * @param interval
- * @param period
- * @returns {TimePeriod}
*/
}, {
@@ -11070,10 +10981,6 @@ var QuizService = /*#__PURE__*/function () {
* Finds max load on given past time period
* when no max load is found looks x month/year back for a max value
* if nothing is found fall back on most recent data
- * @param timeStep
- * @param interval
- * @param fluidType
- * @returns {Promise<IntervalAnswer>}
*/
}, {
@@ -11221,11 +11128,6 @@ var QuizService = /*#__PURE__*/function () {
}()
/**
* Calcul the average value on a given period
- * @param timeStep
- * @param interval
- * @param fluidType
- * @param weekday
- * @returns {Promise<number>}
*/
}, {
@@ -11288,9 +11190,6 @@ var QuizService = /*#__PURE__*/function () {
}()
/**
* Generate wrong date answer following the right one
- * @param rightDate
- * @param interval
- * @returns {Answer[]}
*/
}, {
@@ -11369,9 +11268,6 @@ var QuizService = /*#__PURE__*/function () {
}
/**
* Generate wrong value answer following the right one
- * @param maxLoad
- * @param unit
- * @returns {Answer[]}
*/
}, {
@@ -14791,7 +14687,6 @@ var ConverterService = /*#__PURE__*/function () {
* @param {FluidConfig} fluidConfig - Fluid configuration
* @param {number} load - Load value
* @param {number} [price] - Price if exist
- * @returns {number}
*/
}, {
@@ -15754,7 +15649,7 @@ var _logger = _interopRequireDefault(__webpack_require__("gjtA"));
* Logs the time spend and add "in xx ms"
* @param {string} scope string Migration | Initialization | ...
* @param startTime number raw duration in ms
- * @output [Scope] Finished in XXX ms
+ * @description [Scope] Finished in XXX ms
* @example
* logDuration("[Migration] Finished", 764745674); // [Migration] Finished in 685 ms
*/
@@ -15992,7 +15887,6 @@ var ProfileEcogestureFormService = /*#__PURE__*/function () {
}
/**
* getNextFormStep
- * @param {EcogestureStepForm} step
* @returns {EcogestureStepForm} next step
*/
@@ -16019,7 +15913,6 @@ var ProfileEcogestureFormService = /*#__PURE__*/function () {
}
/**
* getPreviousFormStep
- * @param {EcogestureStepForm} step
* @returns {EcogestureStepForm} previous step
*/
@@ -16042,8 +15935,6 @@ var ProfileEcogestureFormService = /*#__PURE__*/function () {
}
/**
* getAnswerForStep
- * @param {EcogestureStepForm} step
- * @returns {EcogestureFormAnswer}
*/
}], [{
@@ -17913,8 +17804,7 @@ var KonnectorStatusService = /*#__PURE__*/function () {
}
/**
* Return a FluidType array containing each konnector fluid with a account
- * @param void
- * @return {Promise<FluidType[]>} configured FluidTypes array
+ * @returns {Promise<FluidType[]>} configured FluidTypes array
*/
@@ -18021,9 +17911,6 @@ var DateChartService = /*#__PURE__*/function () {
value:
/**
* Define a time period for a given slide defined by its index
- * @param referenceDate
- * @param timeStep
- * @param index
*/
function defineTimePeriod(referenceDate, timeStep, index) {
var date;
@@ -18126,7 +18013,6 @@ var DateChartService = /*#__PURE__*/function () {
* @param {DateTime} referenceDate - reference date
* @param {TimeStep} timeStep - time step
* @param {number} index - index
- * @returns {DateTime}
*/
}, {
@@ -18140,7 +18026,6 @@ var DateChartService = /*#__PURE__*/function () {
* @param {DateTime} referenceDate - reference date
* @param {TimeStep} timeStep - time step
* @param {number} index - index
- * @returns {DateTime}
*/
}, {
@@ -18327,8 +18212,6 @@ var DateChartService = /*#__PURE__*/function () {
}
/**
* Checks if the last data date is outdated and returns the number of missing days
- * @param {DateTime | null} lastDataDate
- * @param {FluidType} fluidType
* @returns {number| null} - The number of missing days
*/
@@ -19231,7 +19114,6 @@ var DuelService = /*#__PURE__*/function () {
/**
* Retrieve period with data based on lastDataDate of the fluids
* @param {FluidStatus[]} fluidStatus - status of fluids
- * @param {Duel} userDuel
* @returns {TimePeriod} - true when deleted with success
*/
@@ -19283,10 +19165,6 @@ var DuelService = /*#__PURE__*/function () {
}()
/**
* Check all period until find one with no empty value or return false
- * @param period
- * @param fluidType
- * @param duration
- * @returns {Promise<false | TimePeriod>}
*/
}, {
@@ -19367,7 +19245,6 @@ var DuelService = /*#__PURE__*/function () {
}()
/**
* Retrieve all duel entities from db
- * @returns {DuelEntity[]}
*/
}, {
@@ -19405,9 +19282,7 @@ var DuelService = /*#__PURE__*/function () {
}()
/**
* Retrieve duel entities from db given the id
- *
* @param {string} duelId - ID of the searched duel
- * @returns {DuelEntity}
*/
}, {
@@ -19543,7 +19418,6 @@ var DuelService = /*#__PURE__*/function () {
/**
* Return duel with updated state to UserDuelState.UNLOCKED
* @param {UserDuel} userDuel - userDuel to unlock
- * @returns {UserDuel}
*/
}, {
@@ -19586,9 +19460,8 @@ var DuelService = /*#__PURE__*/function () {
return fluidTypes.sort();
}
/**
- * Return duel with updated thrshold and fluidTypes
+ * Return duel with updated threshold and fluidTypes
* @param {UserDuel} userDuel - userDuel to update
- * @returns {UserDuel}
*/
}, {
@@ -19670,7 +19543,6 @@ var DuelService = /*#__PURE__*/function () {
/**
* Return duel with updated state to UserDuelState.ONGOING and startDate
* @param {UserDuel} userDuel - userDuel to update
- * @returns {UserDuel}
*/
}, {
@@ -19707,7 +19579,6 @@ var DuelService = /*#__PURE__*/function () {
/**
* Return duel with updated state to UserDuelState.DONE
* @param {UserDuel} userDuel - userDuel to update
- * @returns {UserDuel}
*/
}, {
@@ -19741,7 +19612,6 @@ var DuelService = /*#__PURE__*/function () {
/**
* Return duel with updated state to UserDuelState.UNLOCKED
* @param {UserDuel} userDuel - userDuel to reset
- * @returns {UserDuel}
*/
}, {
@@ -19776,7 +19646,6 @@ var DuelService = /*#__PURE__*/function () {
/**
* Return duel created from duel entity
* @param {DuelEntity} duel - userDuel to update
- * @returns {Duel}
*/
}, {
@@ -19799,7 +19668,6 @@ var DuelService = /*#__PURE__*/function () {
* Return duel created from duel entity
* @param {DuelEntity[]} duelEntityList - userDuel to update
* @param {string} searchId - userDuel to update
- * @returns {UserDuel}
*/
}, {
@@ -22097,8 +21965,6 @@ var ProfileTypeEntityService = /*#__PURE__*/function () {
* Retrieves ProfileType from the PROFILETYPE_DOCTYPE
* When called with date parameter, fetches closest profileType to the date
* When called without parameters, fetches last profileType in doctype
- * @param {DateTime} date
- * @returns {ProfileType}
*/
@@ -22218,8 +22084,6 @@ var ProfileTypeEntityService = /*#__PURE__*/function () {
* Retrieves all ProfileTypes from the PROFILETYPE_DOCTYPE
* When called with period parameter, returns all profileTypes found for this period or null
* When called without parameters, returns all profileTypes or null if none exist
- * @param {TimePeriod} timePeriod
- * @returns {ProfileType}
*/
}, {
@@ -22316,7 +22180,6 @@ var ProfileTypeEntityService = /*#__PURE__*/function () {
}()
/**
* Saves profileType in database
- * @returns {ProfileType}
*/
}, {
@@ -22370,7 +22233,6 @@ var ProfileTypeEntityService = /*#__PURE__*/function () {
}()
/**
* Deletes Array of ProfileTypes
- * @returns {boolean}
*/
}, {
@@ -22450,8 +22312,6 @@ var ProfileTypeEntityService = /*#__PURE__*/function () {
}()
/**
* Retrieves ProfileType from the ProfileTypeEntity
- * @param {ProfileType} profileTypeEntity
- * @returns {ProfileType}
*/
}, {
@@ -23073,7 +22933,8 @@ function getKonnectorSlug(fluidType) {
throw new Error('unknown fluidtype');
}
}
-/** Return lowercase fluidtype
+/**
+ * Return lowercase fluidtype
* @example FluidType.ELECTRICITY => 'electricity'
*/
@@ -23156,7 +23017,7 @@ function getRelationshipHasMany(doc, relName) {
/**
* Get many relations in doc
* @param {object} doc - DocumentEntity
- * @param {Array<[relName: string]: Array<Relation>>} relNameList - Array of name of the relations
+ * @param relNameList - Array of name of the relations
*/
@@ -23167,8 +23028,6 @@ function getRelationships(doc, relNameList) {
}
/**
* Import a svg file with format : id.svg
- * @param id
- * @param pathType
*/
@@ -23225,7 +23084,7 @@ var getMonthFullName = function getMonthFullName(month) {
};
/**
* Return month string according to month index
- * @Note Equivalent to date.monthLong
+ * @variation Equivalent to date.monthLong
* @param date - DateTime
* @returns month in french
*/
@@ -23337,7 +23196,6 @@ var getTodayDate = function getTodayDate() {
};
/**
* Formats an array of strings into a list with commas and an "et" (and) before the last element.
- *
* @param {string[]} array - The array of strings to be formatted.
* @returns {string} The formatted list string.
*
@@ -23346,7 +23204,6 @@ var getTodayDate = function getTodayDate() {
* If the array has two elements, they are joined with " et " (and).
* If the array has more than two elements, all but the last element are joined with commas,
* and " et " (and) is placed before the last element.
- *
* @example
* // Returns "pomme, banane et cerise"
* formatListWithAnd(['pomme', 'banane', 'cerise']);
@@ -23696,9 +23553,6 @@ var UsageEventService = /*#__PURE__*/function () {
key: "addEvent",
value:
/**
- * addEvent
- * @param {Client} client
- * @param {AddEventParams} params
* @returns {Promise<UsageEvent>} usageEvent added
*/
function () {
@@ -23739,9 +23593,6 @@ var UsageEventService = /*#__PURE__*/function () {
return addEvent;
}()
/**
- * addEvent
- * @param {Client} client
- * @param {AddEventParams} params
* @returns {Promise<UsageEvent>} usageEvent added
*/
@@ -23784,13 +23635,6 @@ var UsageEventService = /*#__PURE__*/function () {
return addEventIfDoesntExist;
}()
- /**
- *
- * @param {Client} client
- * @param {string} konnectorSlug
- * @returns
- */
-
}, {
key: "updateConnectionAttemptEvent",
value: function () {
@@ -23864,9 +23708,6 @@ var UsageEventService = /*#__PURE__*/function () {
return updateConnectionAttemptEvent;
}()
/**
- * updateUsageEventsAggregated
- * @param {Client} client
- * @param {string[]} ids
* @returns {Promise<boolean>} return true if all events are updated
*/
@@ -23948,9 +23789,6 @@ var UsageEventService = /*#__PURE__*/function () {
return updateUsageEventsAggregated;
}()
/**
- * getEvents
- * @param {Client} client
- * @param {MongoSelector} filterParams
* @returns {Promise<UsageEvent[]>} usageEvent added
*/
@@ -24002,8 +23840,6 @@ var UsageEventService = /*#__PURE__*/function () {
}()
/**
* Retrieve UsageEvent from the UsageEventEntity
- * @param {UsageEventEntity} usageEventEntity
- * @returns {UsageEvent}
*/
}, {
@@ -27416,7 +27252,6 @@ var ChallengeService = /*#__PURE__*/function () {
* Retrieve list of Userchallenge and unlock the current challenge if the last one is done
* If all challenges are locked, then unlock the first one
* @param {UserChallenge[]} userChallenges - status of fluids
- * @returns {UserChallenge[]}
*/
@@ -27441,7 +27276,6 @@ var ChallengeService = /*#__PURE__*/function () {
/**
* Retrieve UserChallenge from the UserChallengeEntity
* @param {UserChallengeEntity} userChallenges - status of fluids
- * @returns {UserChallenge}
*/
}, {
@@ -27471,7 +27305,6 @@ var ChallengeService = /*#__PURE__*/function () {
/**
* Retrieve UserChallenge from the UserChallengeEntity
* @param {UserChallengeEntity} userChallenges - status of fluids
- * @returns {UserChallenge}
*/
}, {
@@ -27505,7 +27338,6 @@ var ChallengeService = /*#__PURE__*/function () {
/**
*
* @param {UserExploration | ExplorationEntity} exploration - Exploration to be tested
- * @param {FluidStatus[]} fluidStatus
* @returns {boolean} isValid
*/
@@ -27544,7 +27376,6 @@ var ChallengeService = /*#__PURE__*/function () {
/**
*
* @param {ChallengeEntity} challenge - get all relations entities of a challenge
- * @returns {RelationEntitiesObject}
*/
}, {
@@ -27582,12 +27413,6 @@ var ChallengeService = /*#__PURE__*/function () {
}()
/**
* Get a UserChallenge from its Entity and verify the exploration if there is a condition and if it's verified
- * @param {UserExploration} exploration
- * @param {ChallengeEntity} challenge
- * @param {UserDuel} duel
- * @param {UserQuiz} quiz
- * @param {FluidStatus[]} fluidStatus
- * @returns {UserChallenge}
*/
}, {
@@ -27645,13 +27470,6 @@ var ChallengeService = /*#__PURE__*/function () {
/**
* The whole exploration process, checks if the exploration fluid condition exists and is valid for each existing
* Exploration related to given challenge
- * @param {ExplorationEntity[] | undefined} explorationEntities
- * @param {Relation[]} explorationEntityRelation
- * @param {ChallengeEntity} challenge
- * @param {UserDuel} duel
- * @param {UserQuiz} quiz
- * @param {UserChallenge[]} buildList
- * @param {FluidStatus[]} fluidStatus
* @returns {UserChallenge[]} - buildList
*/
@@ -27733,10 +27551,6 @@ var ChallengeService = /*#__PURE__*/function () {
}()
/**
* Checks if the exploration condition exists and is valid when updating the buildList
- * @param {UserChallenge} userChallenge
- * @param {ChallengeEntity[]} challengeEntityList
- * @param {FluidStatus[]} fluidStatus
- * @returns {UserChallenge}
*/
}, {
@@ -27853,8 +27667,6 @@ var ChallengeService = /*#__PURE__*/function () {
}()
/**
* Retrieve UserChallenge list with all challenges
- * @param {FluidStatus[]} fluidStatus
- * @returns {UserChallenge[]}
*/
}, {
@@ -28074,7 +27886,6 @@ var ChallengeService = /*#__PURE__*/function () {
}()
/**
* Retrieve all ChallengeEntities
- * @returns {ChallengeEntity[]}
*/
}, {
@@ -28112,7 +27923,6 @@ var ChallengeService = /*#__PURE__*/function () {
}()
/**
* Delete all ChallengeEntities
- * @returns {boolean}
* @throws {Error}
*/
@@ -28207,7 +28017,6 @@ var ChallengeService = /*#__PURE__*/function () {
}()
/**
* Retrieve all UserChallengeEntities
- * @returns {UserChallenge[]}
*/
}, {
@@ -28314,7 +28123,6 @@ var ChallengeService = /*#__PURE__*/function () {
}()
/**
* Start UserChallenge and retrieve updated UserChallenge
- * @returns {UserChallenge}
* @throws {Error}
*/
@@ -28649,7 +28457,6 @@ var ChallengeService = /*#__PURE__*/function () {
* Retrieve the dataload for a UserChallenge with duel ongoing
* @param {UserChallenge} userChallenge - userChallenge to update
* @param {UserChallengeUpdateFlag} flag - update flag
- * @returns {Dataload[]}
*/
}, {
@@ -28707,7 +28514,6 @@ var ChallengeService = /*#__PURE__*/function () {
* Define if challenge is done and if is win or lost
* @param {UserChallenge} userChallenge - current userChallenge
* @param {Dataload[]} dataloads - dataloads of current challenge
- * @returns {boolean, boolean}
*/
}, {
@@ -29306,7 +29112,6 @@ function currentSchemaVersion(_x) {
/**
* Retrieve all documents of a given doctype
* @param _client cozyClient
- * @param doctype
* @returns all documents of given doctype
*/
@@ -29341,8 +29146,6 @@ function getDocs(_x2, _x3, _x4) {
}
/**
* Update schema version
- * @param _client
- * @param targetSchemaVersion
*/
@@ -29387,8 +29190,6 @@ function updateSchemaVersion(_x5, _x6) {
}
/**
* Save updated docs
- * @param _client
- * @param docs
* @returns Promise<MigrationResult>
*/
@@ -29571,9 +29372,6 @@ var initSchemaDoctype = /*#__PURE__*/function () {
}();
/**
* Run migration
- * @param migration
- * @param _client
- * @returnsPromise<MigrationResult>
*/
@@ -34125,7 +33923,6 @@ var ProfileTypeFormService = /*#__PURE__*/function () {
}
/**
* getNextFormStep
- * @param {ProfileTypeStepForm} step
* @returns {ProfileTypeStepForm} next step
*/
@@ -34194,7 +33991,6 @@ var ProfileTypeFormService = /*#__PURE__*/function () {
}
/**
* getPreviousFormStep
- * @param {ProfileTypeStepForm} step
* @returns {ProfileTypeStepForm} previous step
*/
@@ -34259,8 +34055,7 @@ var ProfileTypeFormService = /*#__PURE__*/function () {
}
/**
* getAnswerForStep
- * @param {ProfileTypeStepForm} step
- * @returns {ProfileTypeAnswer}
+ * @returns {ProfileTypeAnswer} - answer type
*/
}], [{
@@ -36287,7 +36082,6 @@ var EcogestureService = /*#__PURE__*/function () {
}()
/**
* @param {string} ids - ecogestures ids
- * @returns {Promise<Ecogesture[]>}
*/
}, {
@@ -36489,9 +36283,6 @@ var EcogestureService = /*#__PURE__*/function () {
}()
/**
* Removes ecogestures from the list that doesn't fit with user's usages
- * @param {Ecogesture[]} ecogestureList
- * @param {ProfileEcogesture} profileEcogesture
- * @returns {Ecogesture[]}
*/
}, {
@@ -36523,9 +36314,6 @@ var EcogestureService = /*#__PURE__*/function () {
}
/**
* Removes ecogesture from the list that depends on equipment the user hasn't
- * @param {Ecogesture[]} ecogestureList
- * @param {ProfileEcogesture} profileEcogesture
- * @returns {Ecogesture[]}
*/
}, {
@@ -36568,8 +36356,6 @@ var EcogestureService = /*#__PURE__*/function () {
}
/**
* Return a filtered list according to ecogesture profile, the list is sorted by low difficulty and high efficiency
- * @param {ProfileEcogesture} profileEcogesture
- * @returns {Ecogesture[]}
*/
}, {
@@ -36855,7 +36641,6 @@ var TermsService = /*#__PURE__*/function () {
}
/**
* Gets the last term doctype
- * @returns {Term}
*/
@@ -36895,10 +36680,7 @@ var TermsService = /*#__PURE__*/function () {
return getLastTerm;
}()
- /**
- * Checks if the last term has been accepted by user
- * @returns {boolean}
- */
+ /** Checks if the last term has been accepted by user */
}, {
key: "isLastTermValidated",
@@ -36945,10 +36727,7 @@ var TermsService = /*#__PURE__*/function () {
return isLastTermValidated;
}()
- /**
- * Compares the version number in the last term with the current app CGU version in the manifest
- * @returns {boolean}
- */
+ /** Compares the version number in the last term with the current app CGU version in the manifest */
}, {
key: "isConsentVersionUpToDate",
@@ -37045,8 +36824,6 @@ var TermsService = /*#__PURE__*/function () {
}()
/**
* Creates a new term
- * @param newTerm
- * @returns
*/
}, {
@@ -38072,7 +37849,6 @@ var ExplorationService = /*#__PURE__*/function () {
}
/**
* Retrieve all exploration entities from db
- * @returns {ExplorationEntity[]}
*/
@@ -38111,9 +37887,7 @@ var ExplorationService = /*#__PURE__*/function () {
}()
/**
* Retrieve exploration entities from db given the id
- *
* @param {string} explorationId - ID of the searched exploration
- * @returns {ExplorationEntity}
*/
}, {
@@ -38236,7 +38010,6 @@ var ExplorationService = /*#__PURE__*/function () {
* Return exploration created from exploration entity
* @param {ExplorationEntity[]} explorationEntityList - userExploration to update
* @param {string} searchId - userExploration to update
- * @returns {UserExploration}
*/
}, {
@@ -38273,8 +38046,6 @@ var ExplorationService = /*#__PURE__*/function () {
}
/**
* Return UserExploration created from ExplorationEntity
- * @param {ExplorationEntity}
- * @returns {UserExploration}
*/
}, {
@@ -38292,7 +38063,6 @@ var ExplorationService = /*#__PURE__*/function () {
/**
* Return exploration with updated state to UserExplorationState.ONGOING
* @param {UserExploration} userExploration - userExploration to update
- * @returns {UserExploration}
*/
}, {
@@ -38326,7 +38096,6 @@ var ExplorationService = /*#__PURE__*/function () {
/**
* Return exploration with updated state to UserExplorationState.NOTIFICATION
* @param {UserExploration} userExploration - userExploration to update
- * @returns {UserExploration}
*/
}, {
@@ -38362,7 +38131,6 @@ var ExplorationService = /*#__PURE__*/function () {
/**
* Return exploration with updated state to UserExplorationState.DONE
* @param {UserExploration} userExploration - userExploration to update
- * @returns {UserExploration}
*/
}, {
@@ -38379,9 +38147,6 @@ var ExplorationService = /*#__PURE__*/function () {
/**
* Return updated exploration
* @param {UserExploration} userExploration - userExploration to update
- * @returns {UserExploration}
- * @returns {questionIndex}
- * @returns {questionResult}
*/
}, {
@@ -38417,7 +38182,6 @@ var ExplorationService = /*#__PURE__*/function () {
* Return updated UserChallenge with updated UserExploration
* @param {UserChallenge} currentChallenge - currentUserChallenge ongoing
* @param {string} explorationID - Id of the exploration
- * @returns {UserChallenge}
*/
}, {
diff --git a/index.html b/index.html
index 2c247f0e2..2ee102dbb 100644
--- a/index.html
+++ b/index.html
@@ -1 +1 @@
-<!DOCTYPE html><html lang="{{.Locale}}"><head><meta charset="utf-8"><title>Ecolyo</title><link rel="icon" type="image/png" href="/favicon-32x32.png" sizes="32x32"><link rel="icon" type="image/png" href="/favicon-16x16.png" sizes="16x16"><!-- PWA Manifest --><link rel="manifest" href="/manifest.json" crossorigin="use-credentials"><link rel="mask-icon" href="/safari-pinned-tab.svg" color="#297EF2"><meta name="viewport" content="width=device-width,height=device-height,initial-scale=1,viewport-fit=cover"><!-- PWA Chrome --><link rel="icon" sizes="192x192" href="/android-chrome-192x192.png"><link rel="icon" sizes="512x512" href="/android-chrome-512x512.png"><!-- PWA iOS --><link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png"><link rel="apple-touch-startup-image" href="/apple-touch-icon.png"><meta name="apple-mobile-web-app-title" content="Ecolyo"><meta name="apple-mobile-web-app-capable" content="yes"><meta name="apple-mobile-web-app-status-bar-style" content="black"><!-- PWA Colors --><meta name="theme-color" content="#343641"><meta name="background-color" content="#121212">{{.ThemeCSS}} {{.CozyBar}}<script src="//{{.Domain}}/assets/js/piwik.js"></script></head><body><div role="application" class="application" data-cozy="{{.CozyData}}"><script src="vendors/ecolyo.fbf1f65c47dc10085503.js"></script><script src="app/ecolyo.30a9d64fd26b85d9be5b.js"></script></div></body></html>
\ No newline at end of file
+<!DOCTYPE html><html lang="{{.Locale}}"><head><meta charset="utf-8"><title>Ecolyo</title><link rel="icon" type="image/png" href="/favicon-32x32.png" sizes="32x32"><link rel="icon" type="image/png" href="/favicon-16x16.png" sizes="16x16"><!-- PWA Manifest --><link rel="manifest" href="/manifest.json" crossorigin="use-credentials"><link rel="mask-icon" href="/safari-pinned-tab.svg" color="#297EF2"><meta name="viewport" content="width=device-width,height=device-height,initial-scale=1,viewport-fit=cover"><!-- PWA Chrome --><link rel="icon" sizes="192x192" href="/android-chrome-192x192.png"><link rel="icon" sizes="512x512" href="/android-chrome-512x512.png"><!-- PWA iOS --><link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png"><link rel="apple-touch-startup-image" href="/apple-touch-icon.png"><meta name="apple-mobile-web-app-title" content="Ecolyo"><meta name="apple-mobile-web-app-capable" content="yes"><meta name="apple-mobile-web-app-status-bar-style" content="black"><!-- PWA Colors --><meta name="theme-color" content="#343641"><meta name="background-color" content="#121212">{{.ThemeCSS}} {{.CozyBar}}<script src="//{{.Domain}}/assets/js/piwik.js"></script></head><body><div role="application" class="application" data-cozy="{{.CozyData}}"><script src="vendors/ecolyo.fbf1f65c47dc10085503.js"></script><script src="app/ecolyo.956a8c573a35bacc88c0.js"></script></div></body></html>
\ No newline at end of file
diff --git a/services/aggregatorUsageEvents/ecolyo.js b/services/aggregatorUsageEvents/ecolyo.js
index 078b8ec65..f6be319de 100644
--- a/services/aggregatorUsageEvents/ecolyo.js
+++ b/services/aggregatorUsageEvents/ecolyo.js
@@ -437,7 +437,6 @@ const calculateConnectedKonnectorPerDay = async client => {
};
/**
* Build indicator group string with handling of : ECS, heating for gas and electricity.
- *
* @param client Client
* @param fluidType FluidType
* @returns Promise<string>
@@ -551,8 +550,7 @@ const getConsumptionValue = async (client, fluidType) => {
};
/**
* Send an indicator on the consumption variation in % for each fluid type.
- * @param client
- * @group [{ slug }, { seniority (in month) }, { profile (ECS, chauffage, etc...) }],
+ * @description [{ slug }, { seniority (in month) }, { profile (ECS, chauffage, etc...) }],
*/
@@ -599,7 +597,7 @@ const calculateConsumptionVariation = async client => {
// eslint-disable-next-line camelcase
fluid_usage: await buildProfileWithFluidType(client, (0, _utils.getFluidType)(_enums.FluidType[fluidType]))
}
- }; // if user wasnt connected during current month, dont send indicator
+ }; // if user wasn't connected during current month, dont send indicator
const events = await _usageEvent.default.getEvents(client, {
eventDate: {
@@ -44640,7 +44638,6 @@ class ChallengeService {
* Retrieve list of Userchallenge and unlock the current challenge if the last one is done
* If all challenges are locked, then unlock the first one
* @param {UserChallenge[]} userChallenges - status of fluids
- * @returns {UserChallenge[]}
*/
@@ -44663,7 +44660,6 @@ class ChallengeService {
/**
* Retrieve UserChallenge from the UserChallengeEntity
* @param {UserChallengeEntity} userChallenges - status of fluids
- * @returns {UserChallenge}
*/
@@ -44692,7 +44688,6 @@ class ChallengeService {
/**
* Retrieve UserChallenge from the UserChallengeEntity
* @param {UserChallengeEntity} userChallenges - status of fluids
- * @returns {UserChallenge}
*/
@@ -44725,7 +44720,6 @@ class ChallengeService {
/**
*
* @param {UserExploration | ExplorationEntity} exploration - Exploration to be tested
- * @param {FluidStatus[]} fluidStatus
* @returns {boolean} isValid
*/
@@ -44743,7 +44737,6 @@ class ChallengeService {
/**
*
* @param {ChallengeEntity} challenge - get all relations entities of a challenge
- * @returns {RelationEntitiesObject}
*/
@@ -44760,12 +44753,6 @@ class ChallengeService {
}
/**
* Get a UserChallenge from its Entity and verify the exploration if there is a condition and if it's verified
- * @param {UserExploration} exploration
- * @param {ChallengeEntity} challenge
- * @param {UserDuel} duel
- * @param {UserQuiz} quiz
- * @param {FluidStatus[]} fluidStatus
- * @returns {UserChallenge}
*/
@@ -44788,13 +44775,6 @@ class ChallengeService {
/**
* The whole exploration process, checks if the exploration fluid condition exists and is valid for each existing
* Exploration related to given challenge
- * @param {ExplorationEntity[] | undefined} explorationEntities
- * @param {Relation[]} explorationEntityRelation
- * @param {ChallengeEntity} challenge
- * @param {UserDuel} duel
- * @param {UserQuiz} quiz
- * @param {UserChallenge[]} buildList
- * @param {FluidStatus[]} fluidStatus
* @returns {UserChallenge[]} - buildList
*/
@@ -44816,10 +44796,6 @@ class ChallengeService {
}
/**
* Checks if the exploration condition exists and is valid when updating the buildList
- * @param {UserChallenge} userChallenge
- * @param {ChallengeEntity[]} challengeEntityList
- * @param {FluidStatus[]} fluidStatus
- * @returns {UserChallenge}
*/
@@ -44859,8 +44835,6 @@ class ChallengeService {
}
/**
* Retrieve UserChallenge list with all challenges
- * @param {FluidStatus[]} fluidStatus
- * @returns {UserChallenge[]}
*/
@@ -44925,7 +44899,6 @@ class ChallengeService {
}
/**
* Retrieve all ChallengeEntities
- * @returns {ChallengeEntity[]}
*/
@@ -44938,7 +44911,6 @@ class ChallengeService {
}
/**
* Delete all ChallengeEntities
- * @returns {boolean}
* @throws {Error}
*/
@@ -44965,7 +44937,6 @@ class ChallengeService {
}
/**
* Retrieve all UserChallengeEntities
- * @returns {UserChallenge[]}
*/
@@ -45014,7 +44985,6 @@ class ChallengeService {
}
/**
* Start UserChallenge and retrieve updated UserChallenge
- * @returns {UserChallenge}
* @throws {Error}
*/
@@ -45250,7 +45220,6 @@ class ChallengeService {
* Retrieve the dataload for a UserChallenge with duel ongoing
* @param {UserChallenge} userChallenge - userChallenge to update
* @param {UserChallengeUpdateFlag} flag - update flag
- * @returns {Dataload[]}
*/
@@ -45276,7 +45245,6 @@ class ChallengeService {
* Define if challenge is done and if is win or lost
* @param {UserChallenge} userChallenge - current userChallenge
* @param {Dataload[]} dataloads - dataloads of current challenge
- * @returns {boolean, boolean}
*/
@@ -97444,13 +97412,10 @@ class ConsumptionDataManager {
}
/**
* Retrieves an array of fluid types that have incomplete data for a given month.
- *
+ *
* Data is incomplete if at least one daily data is missing for the month.
- *
- * @param {FluidType[]} fluidTypes
* @param {DateTime} month - The month for which to check the data completeness.
- * @returns {Promise<FluidType[]>}
- */
+ */
async getFluidsWithIncompleteData(fluidTypes, month) {
@@ -97604,7 +97569,6 @@ class ConsumptionDataManager {
}
/**
* getLastHourData
- * @param {Client} client
* @param {number} month number
* @returns {Promise<DataloadEntity[]>} usageEvent added
*/
@@ -97627,8 +97591,6 @@ class ConsumptionDataManager {
}
/**
* Get the first entry of a given data doctype (enedis, grdf, egl)
- * @param doctype
- * @returns
*/
@@ -97930,9 +97892,6 @@ var _fluidConfig = _interopRequireDefault(__webpack_require__(749));
class DateChartService {
/**
* Define a time period for a given slide defined by its index
- * @param referenceDate
- * @param timeStep
- * @param index
*/
defineTimePeriod(referenceDate, timeStep, index) {
let date;
@@ -98035,7 +97994,6 @@ class DateChartService {
* @param {DateTime} referenceDate - reference date
* @param {TimeStep} timeStep - time step
* @param {number} index - index
- * @returns {DateTime}
*/
@@ -98048,7 +98006,6 @@ class DateChartService {
* @param {DateTime} referenceDate - reference date
* @param {TimeStep} timeStep - time step
* @param {number} index - index
- * @returns {DateTime}
*/
@@ -98229,8 +98186,6 @@ class DateChartService {
}
/**
* Checks if the last data date is outdated and returns the number of missing days
- * @param {DateTime | null} lastDataDate
- * @param {FluidType} fluidType
* @returns {number| null} - The number of missing days
*/
@@ -98543,7 +98498,8 @@ function getKonnectorSlug(fluidType) {
throw new Error('unknown fluidtype');
}
}
-/** Return lowercase fluidtype
+/**
+ * Return lowercase fluidtype
* @example FluidType.ELECTRICITY => 'electricity'
*/
@@ -98622,7 +98578,7 @@ function getRelationshipHasMany(doc, relName) {
/**
* Get many relations in doc
* @param {object} doc - DocumentEntity
- * @param {Array<[relName: string]: Array<Relation>>} relNameList - Array of name of the relations
+ * @param relNameList - Array of name of the relations
*/
@@ -98633,8 +98589,6 @@ function getRelationships(doc, relNameList) {
}
/**
* Import a svg file with format : id.svg
- * @param id
- * @param pathType
*/
@@ -98662,7 +98616,7 @@ const getMonthFullName = month => {
};
/**
* Return month string according to month index
- * @Note Equivalent to date.monthLong
+ * @variation Equivalent to date.monthLong
* @param date - DateTime
* @returns month in french
*/
@@ -98761,7 +98715,6 @@ const getTodayDate = () => _luxon.DateTime.local().setZone('utc', {
}).startOf('day');
/**
* Formats an array of strings into a list with commas and an "et" (and) before the last element.
- *
* @param {string[]} array - The array of strings to be formatted.
* @returns {string} The formatted list string.
*
@@ -98770,7 +98723,6 @@ const getTodayDate = () => _luxon.DateTime.local().setZone('utc', {
* If the array has two elements, they are joined with " et " (and).
* If the array has more than two elements, all but the last element are joined with commas,
* and " et " (and) is placed before the last element.
- *
* @example
* // Returns "pomme, banane et cerise"
* formatListWithAnd(['pomme', 'banane', 'cerise']);
@@ -100088,7 +100040,6 @@ class ConverterService {
* @param {FluidConfig} fluidConfig - Fluid configuration
* @param {number} load - Load value
* @param {number} [price] - Price if exist
- * @returns {number}
*/
@@ -100604,7 +100555,6 @@ class DuelService {
/**
* Retrieve period with data based on lastDataDate of the fluids
* @param {FluidStatus[]} fluidStatus - status of fluids
- * @param {Duel} userDuel
* @returns {TimePeriod} - true when deleted with success
*/
@@ -100631,10 +100581,6 @@ class DuelService {
}
/**
* Check all period until find one with no empty value or return false
- * @param period
- * @param fluidType
- * @param duration
- * @returns {Promise<false | TimePeriod>}
*/
@@ -100665,7 +100611,6 @@ class DuelService {
}
/**
* Retrieve all duel entities from db
- * @returns {DuelEntity[]}
*/
@@ -100678,9 +100623,7 @@ class DuelService {
}
/**
* Retrieve duel entities from db given the id
- *
* @param {string} duelId - ID of the searched duel
- * @returns {DuelEntity}
*/
@@ -100723,7 +100666,6 @@ class DuelService {
/**
* Return duel with updated state to UserDuelState.UNLOCKED
* @param {UserDuel} userDuel - userDuel to unlock
- * @returns {UserDuel}
*/
@@ -100745,9 +100687,8 @@ class DuelService {
return fluidTypes.sort();
}
/**
- * Return duel with updated thrshold and fluidTypes
+ * Return duel with updated threshold and fluidTypes
* @param {UserDuel} userDuel - userDuel to update
- * @returns {UserDuel}
*/
@@ -100789,7 +100730,6 @@ class DuelService {
/**
* Return duel with updated state to UserDuelState.ONGOING and startDate
* @param {UserDuel} userDuel - userDuel to update
- * @returns {UserDuel}
*/
@@ -100806,7 +100746,6 @@ class DuelService {
/**
* Return duel with updated state to UserDuelState.DONE
* @param {UserDuel} userDuel - userDuel to update
- * @returns {UserDuel}
*/
@@ -100820,7 +100759,6 @@ class DuelService {
/**
* Return duel with updated state to UserDuelState.UNLOCKED
* @param {UserDuel} userDuel - userDuel to reset
- * @returns {UserDuel}
*/
@@ -100835,7 +100773,6 @@ class DuelService {
/**
* Return duel created from duel entity
* @param {DuelEntity} duel - userDuel to update
- * @returns {Duel}
*/
@@ -100857,7 +100794,6 @@ class DuelService {
* Return duel created from duel entity
* @param {DuelEntity[]} duelEntityList - userDuel to update
* @param {string} searchId - userDuel to update
- * @returns {UserDuel}
*/
@@ -101039,7 +100975,6 @@ class QuizService {
}
/**
* Retrieve all quiz entities from db
- * @returns {QuizEntity[]}
*/
@@ -101052,9 +100987,7 @@ class QuizService {
}
/**
* Retrieve quiz entities from db given the id
- *
* @param {string} quizId - ID of the searched quiz
- * @returns {QuizEntity}
*/
@@ -101089,7 +101022,6 @@ class QuizService {
* Return quiz created from quiz entity
* @param {QuizEntity[]} quizEntityList - userQuiz to update
* @param {string} searchId - userQuiz to update
- * @returns {UserQuiz}
*/
@@ -101124,8 +101056,6 @@ class QuizService {
}
/**
* Return UserQuestion created from QuestionEntity
- * @param {QuestionEntity}
- * @returns {UserQuestion}
*/
@@ -101138,8 +101068,6 @@ class QuizService {
}
/**
* Return UserCustomQuestion created from CustomQuestionEntity
- * @param {CustomQuestionEntity}
- * @returns {UserCustomQuestion}
*/
@@ -101152,8 +101080,6 @@ class QuizService {
}
/**
* Return UserQuiz created from QuizEntity
- * @param {QuizEntity}
- * @returns {UserQuiz}
*/
@@ -101179,7 +101105,6 @@ class QuizService {
/**
* Return quiz with updated state to UserQuizState.ONGOING and randomize question and answers
* @param {UserQuiz} userQuiz - userQuiz to update
- * @returns {UserQuiz}
*/
@@ -101198,7 +101123,6 @@ class QuizService {
/**
* Return quiz with updated state to UserQuizState.UNLOCKED and updated questions with false result
* @param {UserQuiz} userQuiz - userQuiz to update
- * @returns {UserQuiz}
*/
@@ -101221,7 +101145,6 @@ class QuizService {
/**
* Return quiz with updated state to UserQuizState.DONE
* @param {UserQuiz} userQuiz - userQuiz to update
- * @returns {UserQuiz}
*/
@@ -101235,9 +101158,6 @@ class QuizService {
/**
* Return quiz with result and updated question or customQuestion if no index is passed
* @param {UserQuiz} userQuiz - userQuiz to update
- * @returns {UserQuiz}
- * @returns {questionIndex}
- * @returns {questionResult}
*/
@@ -101265,9 +101185,6 @@ class QuizService {
}
/**
* Build a custom question with the customQuestionEntity
- * @param customQuestionEntity
- * @param fluidType
- * @returns {QuestionEntity}
*/
@@ -101328,9 +101245,6 @@ class QuizService {
}
/**
* Get the interval needed for the further calculs
- * @param interval
- * @param period
- * @returns {TimePeriod}
*/
@@ -101382,10 +101296,6 @@ class QuizService {
* Finds max load on given past time period
* when no max load is found looks x month/year back for a max value
* if nothing is found fall back on most recent data
- * @param timeStep
- * @param interval
- * @param fluidType
- * @returns {Promise<IntervalAnswer>}
*/
@@ -101482,11 +101392,6 @@ class QuizService {
}
/**
* Calcul the average value on a given period
- * @param timeStep
- * @param interval
- * @param fluidType
- * @param weekday
- * @returns {Promise<number>}
*/
@@ -101524,9 +101429,6 @@ class QuizService {
}
/**
* Generate wrong date answer following the right one
- * @param rightDate
- * @param interval
- * @returns {Answer[]}
*/
@@ -101604,9 +101506,6 @@ class QuizService {
}
/**
* Generate wrong value answer following the right one
- * @param maxLoad
- * @param unit
- * @returns {Answer[]}
*/
@@ -101685,7 +101584,6 @@ class ActionService {
}
/**
* Get the list of available actions
- * @returns {Promise<Ecogesture[]>}
*/
@@ -101712,8 +101610,7 @@ class ActionService {
return actionsList;
}
/**
- * Get default eocgestures
- * @returns {Promise<Ecogesture[]>}
+ * Get default ecogestures
*/
@@ -101722,9 +101619,7 @@ class ActionService {
const defaultActions = await this._ecogestureService.getEcogesturesByIds(actionIds);
return defaultActions;
}
- /** Complete the list with unfinished default ecogestures
- * @returns {Promise<Ecogesture[]>}
- */
+ /** Complete the list with unfinished default ecogestures */
async keepListComplete(actionList) {
@@ -101738,13 +101633,6 @@ class ActionService {
return actionList;
}
- /**
- *
- * @param {Ecogesture[]} filteredList
- * @param {Ecogesture[]} actionList
- * @returns {Ecogesture[]}
- */
-
completeWithNoSeason(filteredList, actionList) {
if (filteredList.length < 3) {
@@ -101764,8 +101652,6 @@ class ActionService {
}
/**
* filterBySeason - Filter action list depending on current season
- * @param {Ecogesture[]} actionList
- * @returns {Ecogesture[]}
*/
@@ -101787,8 +101673,6 @@ class ActionService {
}
/**
* getCustomActions - Filter action by fluid and season and sort them by difficulty first and efficiency second
- * @param {FluidType[]} connectedFluids
- * @returns {Promise<Ecogesture[]>}
*/
@@ -101812,8 +101696,6 @@ class ActionService {
}
/**
* launchAction - parse ecogesture to UserAction and launch it
- * @param {Ecogesture} Ecogesture
- * @returns {UserAction}
*/
@@ -101829,8 +101711,7 @@ class ActionService {
}
/**
* awaitNotificationAction
- * @param {UserAction} UserAction
- * @returns {UserAction} - updated user action
+ * @returns {UserAction} updated user action
*/
@@ -101843,8 +101724,7 @@ class ActionService {
}
/**
* endAction
- * @param {UserAction} UserAction
- * @returns {UserAction} - updated user action
+ * @returns {UserAction} updated user action
*/
@@ -101857,8 +101737,6 @@ class ActionService {
}
/**
* isActionDone - Set Action state to notification if progress > actionDuration
- * @param {UserChallenge} currentChallenge
- * @returns {Promise<UserChallenge | null>}
*/
@@ -102063,7 +101941,6 @@ class EcogestureService {
}
/**
* @param {string} ids - ecogestures ids
- * @returns {Promise<Ecogesture[]>}
*/
@@ -102120,9 +101997,6 @@ class EcogestureService {
}
/**
* Removes ecogestures from the list that doesn't fit with user's usages
- * @param {Ecogesture[]} ecogestureList
- * @param {ProfileEcogesture} profileEcogesture
- * @returns {Ecogesture[]}
*/
@@ -102153,9 +102027,6 @@ class EcogestureService {
}
/**
* Removes ecogesture from the list that depends on equipment the user hasn't
- * @param {Ecogesture[]} ecogestureList
- * @param {ProfileEcogesture} profileEcogesture
- * @returns {Ecogesture[]}
*/
@@ -102175,8 +102046,6 @@ class EcogestureService {
}
/**
* Return a filtered list according to ecogesture profile, the list is sorted by low difficulty and high efficiency
- * @param {ProfileEcogesture} profileEcogesture
- * @returns {Ecogesture[]}
*/
@@ -102236,7 +102105,7 @@ var _logger = _interopRequireDefault(__webpack_require__(923));
* Logs the time spend and add "in xx ms"
* @param {string} scope string Migration | Initialization | ...
* @param startTime number raw duration in ms
- * @output [Scope] Finished in XXX ms
+ * @description [Scope] Finished in XXX ms
* @example
* logDuration("[Migration] Finished", 764745674); // [Migration] Finished in 685 ms
*/
@@ -102771,7 +102640,6 @@ class ExplorationService {
}
/**
* Retrieve all exploration entities from db
- * @returns {ExplorationEntity[]}
*/
@@ -102784,9 +102652,7 @@ class ExplorationService {
}
/**
* Retrieve exploration entities from db given the id
- *
* @param {string} explorationId - ID of the searched exploration
- * @returns {ExplorationEntity}
*/
@@ -102821,7 +102687,6 @@ class ExplorationService {
* Return exploration created from exploration entity
* @param {ExplorationEntity[]} explorationEntityList - userExploration to update
* @param {string} searchId - userExploration to update
- * @returns {UserExploration}
*/
@@ -102855,8 +102720,6 @@ class ExplorationService {
}
/**
* Return UserExploration created from ExplorationEntity
- * @param {ExplorationEntity}
- * @returns {UserExploration}
*/
@@ -102873,7 +102736,6 @@ class ExplorationService {
/**
* Return exploration with updated state to UserExplorationState.ONGOING
* @param {UserExploration} userExploration - userExploration to update
- * @returns {UserExploration}
*/
@@ -102887,7 +102749,6 @@ class ExplorationService {
/**
* Return exploration with updated state to UserExplorationState.NOTIFICATION
* @param {UserExploration} userExploration - userExploration to update
- * @returns {UserExploration}
*/
@@ -102903,7 +102764,6 @@ class ExplorationService {
/**
* Return exploration with updated state to UserExplorationState.DONE
* @param {UserExploration} userExploration - userExploration to update
- * @returns {UserExploration}
*/
@@ -102919,9 +102779,6 @@ class ExplorationService {
/**
* Return updated exploration
* @param {UserExploration} userExploration - userExploration to update
- * @returns {UserExploration}
- * @returns {questionIndex}
- * @returns {questionResult}
*/
@@ -102938,7 +102795,6 @@ class ExplorationService {
* Return updated UserChallenge with updated UserExploration
* @param {UserChallenge} currentChallenge - currentUserChallenge ongoing
* @param {string} explorationID - Id of the exploration
- * @returns {UserChallenge}
*/
@@ -119294,8 +119150,6 @@ class ProfileService {
}
/**
* Retrieve Profile from the ProfileEntity
- * @param {ProfileEntity} profileEntity
- * @returns {Profile}
*/
@@ -119400,8 +119254,6 @@ class ProfileTypeEntityService {
* Retrieves ProfileType from the PROFILETYPE_DOCTYPE
* When called with date parameter, fetches closest profileType to the date
* When called without parameters, fetches last profileType in doctype
- * @param {DateTime} date
- * @returns {ProfileType}
*/
@@ -119466,8 +119318,6 @@ class ProfileTypeEntityService {
* Retrieves all ProfileTypes from the PROFILETYPE_DOCTYPE
* When called with period parameter, returns all profileTypes found for this period or null
* When called without parameters, returns all profileTypes or null if none exist
- * @param {TimePeriod} timePeriod
- * @returns {ProfileType}
*/
@@ -119514,7 +119364,6 @@ class ProfileTypeEntityService {
}
/**
* Saves profileType in database
- * @returns {ProfileType}
*/
@@ -119535,7 +119384,6 @@ class ProfileTypeEntityService {
}
/**
* Deletes Array of ProfileTypes
- * @returns {boolean}
*/
@@ -119558,8 +119406,6 @@ class ProfileTypeEntityService {
}
/**
* Retrieves ProfileType from the ProfileTypeEntity
- * @param {ProfileType} profileTypeEntity
- * @returns {ProfileType}
*/
@@ -119626,7 +119472,6 @@ class TermsService {
}
/**
* Gets the last term doctype
- * @returns {Term}
*/
@@ -119639,10 +119484,7 @@ class TermsService {
} = await this._client.query(query);
return terms;
}
- /**
- * Checks if the last term has been accepted by user
- * @returns {boolean}
- */
+ /** Checks if the last term has been accepted by user */
async isLastTermValidated() {
@@ -119654,10 +119496,7 @@ class TermsService {
} = await this._client.query(query);
if (terms !== null && terms !== void 0 && terms.accepted) return true;else return false;
}
- /**
- * Compares the version number in the last term with the current app CGU version in the manifest
- * @returns {boolean}
- */
+ /** Compares the version number in the last term with the current app CGU version in the manifest */
async isConsentVersionUpToDate() {
@@ -119680,8 +119519,6 @@ class TermsService {
}
/**
* Creates a new term
- * @param newTerm
- * @returns
*/
@@ -119755,9 +119592,6 @@ const logStack = _cozyLogger.default.namespace('usageEventService');
class UsageEventService {
/**
- * addEvent
- * @param {Client} client
- * @param {AddEventParams} params
* @returns {Promise<UsageEvent>} usageEvent added
*/
static async addEvent(client, params) {
@@ -119775,9 +119609,6 @@ class UsageEventService {
return this.parseUsageEventEntityToUsageEvent(data);
}
/**
- * addEvent
- * @param {Client} client
- * @param {AddEventParams} params
* @returns {Promise<UsageEvent>} usageEvent added
*/
@@ -119791,13 +119622,6 @@ class UsageEventService {
return null;
}
- /**
- *
- * @param {Client} client
- * @param {string} konnectorSlug
- * @returns
- */
-
static async updateConnectionAttemptEvent(client, konnectorSlug) {
try {
@@ -119834,9 +119658,6 @@ class UsageEventService {
}
}
/**
- * updateUsageEventsAggregated
- * @param {Client} client
- * @param {string[]} ids
* @returns {Promise<boolean>} return true if all events are updated
*/
@@ -119861,9 +119682,6 @@ class UsageEventService {
}
}
/**
- * getEvents
- * @param {Client} client
- * @param {MongoSelector} filterParams
* @returns {Promise<UsageEvent[]>} usageEvent added
*/
@@ -119882,8 +119700,6 @@ class UsageEventService {
}
/**
* Retrieve UsageEvent from the UsageEventEntity
- * @param {UsageEventEntity} usageEventEntity
- * @returns {UsageEvent}
*/
diff --git a/services/consumptionAlert/ecolyo.js b/services/consumptionAlert/ecolyo.js
index 2b995cdb9..72159e6e5 100644
--- a/services/consumptionAlert/ecolyo.js
+++ b/services/consumptionAlert/ecolyo.js
@@ -95518,13 +95518,10 @@ class ConsumptionDataManager {
}
/**
* Retrieves an array of fluid types that have incomplete data for a given month.
- *
+ *
* Data is incomplete if at least one daily data is missing for the month.
- *
- * @param {FluidType[]} fluidTypes
* @param {DateTime} month - The month for which to check the data completeness.
- * @returns {Promise<FluidType[]>}
- */
+ */
async getFluidsWithIncompleteData(fluidTypes, month) {
@@ -95678,7 +95675,6 @@ class ConsumptionDataManager {
}
/**
* getLastHourData
- * @param {Client} client
* @param {number} month number
* @returns {Promise<DataloadEntity[]>} usageEvent added
*/
@@ -95701,8 +95697,6 @@ class ConsumptionDataManager {
}
/**
* Get the first entry of a given data doctype (enedis, grdf, egl)
- * @param doctype
- * @returns
*/
@@ -96004,9 +95998,6 @@ var _fluidConfig = _interopRequireDefault(__webpack_require__(749));
class DateChartService {
/**
* Define a time period for a given slide defined by its index
- * @param referenceDate
- * @param timeStep
- * @param index
*/
defineTimePeriod(referenceDate, timeStep, index) {
let date;
@@ -96109,7 +96100,6 @@ class DateChartService {
* @param {DateTime} referenceDate - reference date
* @param {TimeStep} timeStep - time step
* @param {number} index - index
- * @returns {DateTime}
*/
@@ -96122,7 +96112,6 @@ class DateChartService {
* @param {DateTime} referenceDate - reference date
* @param {TimeStep} timeStep - time step
* @param {number} index - index
- * @returns {DateTime}
*/
@@ -96303,8 +96292,6 @@ class DateChartService {
}
/**
* Checks if the last data date is outdated and returns the number of missing days
- * @param {DateTime | null} lastDataDate
- * @param {FluidType} fluidType
* @returns {number| null} - The number of missing days
*/
@@ -96617,7 +96604,8 @@ function getKonnectorSlug(fluidType) {
throw new Error('unknown fluidtype');
}
}
-/** Return lowercase fluidtype
+/**
+ * Return lowercase fluidtype
* @example FluidType.ELECTRICITY => 'electricity'
*/
@@ -96696,7 +96684,7 @@ function getRelationshipHasMany(doc, relName) {
/**
* Get many relations in doc
* @param {object} doc - DocumentEntity
- * @param {Array<[relName: string]: Array<Relation>>} relNameList - Array of name of the relations
+ * @param relNameList - Array of name of the relations
*/
@@ -96707,8 +96695,6 @@ function getRelationships(doc, relNameList) {
}
/**
* Import a svg file with format : id.svg
- * @param id
- * @param pathType
*/
@@ -96736,7 +96722,7 @@ const getMonthFullName = month => {
};
/**
* Return month string according to month index
- * @Note Equivalent to date.monthLong
+ * @variation Equivalent to date.monthLong
* @param date - DateTime
* @returns month in french
*/
@@ -96835,7 +96821,6 @@ const getTodayDate = () => _luxon.DateTime.local().setZone('utc', {
}).startOf('day');
/**
* Formats an array of strings into a list with commas and an "et" (and) before the last element.
- *
* @param {string[]} array - The array of strings to be formatted.
* @returns {string} The formatted list string.
*
@@ -96844,7 +96829,6 @@ const getTodayDate = () => _luxon.DateTime.local().setZone('utc', {
* If the array has two elements, they are joined with " et " (and).
* If the array has more than two elements, all but the last element are joined with commas,
* and " et " (and) is placed before the last element.
- *
* @example
* // Returns "pomme, banane et cerise"
* formatListWithAnd(['pomme', 'banane', 'cerise']);
@@ -98162,7 +98146,6 @@ class ConverterService {
* @param {FluidConfig} fluidConfig - Fluid configuration
* @param {number} load - Load value
* @param {number} [price] - Price if exist
- * @returns {number}
*/
@@ -99150,8 +99133,6 @@ class ProfileService {
}
/**
* Retrieve Profile from the ProfileEntity
- * @param {ProfileEntity} profileEntity
- * @returns {Profile}
*/
diff --git a/services/enedisHalfHourMonthlyAnalysis/ecolyo.js b/services/enedisHalfHourMonthlyAnalysis/ecolyo.js
index 0129f7e2c..019aadab5 100644
--- a/services/enedisHalfHourMonthlyAnalysis/ecolyo.js
+++ b/services/enedisHalfHourMonthlyAnalysis/ecolyo.js
@@ -95518,13 +95518,10 @@ class ConsumptionDataManager {
}
/**
* Retrieves an array of fluid types that have incomplete data for a given month.
- *
+ *
* Data is incomplete if at least one daily data is missing for the month.
- *
- * @param {FluidType[]} fluidTypes
* @param {DateTime} month - The month for which to check the data completeness.
- * @returns {Promise<FluidType[]>}
- */
+ */
async getFluidsWithIncompleteData(fluidTypes, month) {
@@ -95678,7 +95675,6 @@ class ConsumptionDataManager {
}
/**
* getLastHourData
- * @param {Client} client
* @param {number} month number
* @returns {Promise<DataloadEntity[]>} usageEvent added
*/
@@ -95701,8 +95697,6 @@ class ConsumptionDataManager {
}
/**
* Get the first entry of a given data doctype (enedis, grdf, egl)
- * @param doctype
- * @returns
*/
@@ -96004,9 +95998,6 @@ var _fluidConfig = _interopRequireDefault(__webpack_require__(749));
class DateChartService {
/**
* Define a time period for a given slide defined by its index
- * @param referenceDate
- * @param timeStep
- * @param index
*/
defineTimePeriod(referenceDate, timeStep, index) {
let date;
@@ -96109,7 +96100,6 @@ class DateChartService {
* @param {DateTime} referenceDate - reference date
* @param {TimeStep} timeStep - time step
* @param {number} index - index
- * @returns {DateTime}
*/
@@ -96122,7 +96112,6 @@ class DateChartService {
* @param {DateTime} referenceDate - reference date
* @param {TimeStep} timeStep - time step
* @param {number} index - index
- * @returns {DateTime}
*/
@@ -96303,8 +96292,6 @@ class DateChartService {
}
/**
* Checks if the last data date is outdated and returns the number of missing days
- * @param {DateTime | null} lastDataDate
- * @param {FluidType} fluidType
* @returns {number| null} - The number of missing days
*/
@@ -96617,7 +96604,8 @@ function getKonnectorSlug(fluidType) {
throw new Error('unknown fluidtype');
}
}
-/** Return lowercase fluidtype
+/**
+ * Return lowercase fluidtype
* @example FluidType.ELECTRICITY => 'electricity'
*/
@@ -96696,7 +96684,7 @@ function getRelationshipHasMany(doc, relName) {
/**
* Get many relations in doc
* @param {object} doc - DocumentEntity
- * @param {Array<[relName: string]: Array<Relation>>} relNameList - Array of name of the relations
+ * @param relNameList - Array of name of the relations
*/
@@ -96707,8 +96695,6 @@ function getRelationships(doc, relNameList) {
}
/**
* Import a svg file with format : id.svg
- * @param id
- * @param pathType
*/
@@ -96736,7 +96722,7 @@ const getMonthFullName = month => {
};
/**
* Return month string according to month index
- * @Note Equivalent to date.monthLong
+ * @variation Equivalent to date.monthLong
* @param date - DateTime
* @returns month in french
*/
@@ -96835,7 +96821,6 @@ const getTodayDate = () => _luxon.DateTime.local().setZone('utc', {
}).startOf('day');
/**
* Formats an array of strings into a list with commas and an "et" (and) before the last element.
- *
* @param {string[]} array - The array of strings to be formatted.
* @returns {string} The formatted list string.
*
@@ -96844,7 +96829,6 @@ const getTodayDate = () => _luxon.DateTime.local().setZone('utc', {
* If the array has two elements, they are joined with " et " (and).
* If the array has more than two elements, all but the last element are joined with commas,
* and " et " (and) is placed before the last element.
- *
* @example
* // Returns "pomme, banane et cerise"
* formatListWithAnd(['pomme', 'banane', 'cerise']);
@@ -98162,7 +98146,6 @@ class ConverterService {
* @param {FluidConfig} fluidConfig - Fluid configuration
* @param {number} load - Load value
* @param {number} [price] - Price if exist
- * @returns {number}
*/
@@ -99393,26 +99376,15 @@ const logStack = _cozyLogger.default.namespace('report');
/**
* Gets the minimum consumption value in a month
- * @param weekEndValuesArray
- * @param weekValuesArray
- * @returns number
*/
-const getMinMonthlyLoad = (weekEndValuesArray, weekValuesArray, numberofDaysInMonth) => {
+const getMinMonthlyLoad = (weekEndValuesArray, weekValuesArray, numberOfDaysInMonth) => {
const totalArray = (0, _lodash.union)(...weekEndValuesArray, ...weekValuesArray);
const filteredTotal = totalArray.filter(val => val !== -1 && val !== 0);
const talonCons = Math.min(...filteredTotal);
- const minCons = talonCons * 48 * numberofDaysInMonth;
+ const minCons = talonCons * 48 * numberOfDaysInMonth;
logStack('info', `Minimum value is ${minCons} `);
return minCons;
};
-/**
- *
- * @param monthlyArray
- * @param dataChart
- * @param isWeekend
- * @returns
- */
-
const populateArrayWithTotalData = (monthlyArray, dataChart, isWeekend) => {
let halfHourDayData;
@@ -99437,13 +99409,7 @@ const populateArrayWithTotalData = (monthlyArray, dataChart, isWeekend) => {
});
}
};
-/**
- * Gets max Power value for a given month
- * @param month
- * @param year
- * @param client
- * @returns
- */
+/** Gets max Power value for a given month */
const getMonthMaxPower = async (month, year, client) => {
@@ -99462,10 +99428,6 @@ const getMonthMaxPower = async (month, year, client) => {
};
/**
* Get the average arrays of half-hour value on a given month
- * @param client
- * @param month
- * @param year
- * @returns {Promise<MonthlyAveragesLoads>}
*/
@@ -99535,8 +99497,6 @@ const getEnedisMonthAnalysisData = async (client, month, year) => {
/**
* Synchronize enedis monthly analysis with database depending on if the service has already ran
* and if the enedis minute tracking has been activated
- * @param {Client} client
- * @returns
*/
@@ -99723,7 +99683,6 @@ class EnedisMonthlyAnalysisDataService {
}
/**
* Retrieve all exploration entities from db
- * @returns {EnedisMonthlyAnalysisData[]}
*/
@@ -99736,8 +99695,6 @@ class EnedisMonthlyAnalysisDataService {
}
/**
* getLastEnedisMonthlyAnalysis
- * @param {Client} client
- * @returns {Promise<EnedisMonthlyAnalysisData[]>}
*/
@@ -99752,16 +99709,11 @@ class EnedisMonthlyAnalysisDataService {
}
/**
* Aggregates Enedis Analysis data in order to create Dataload injectable in graph component
- * @param {EnedisMonthlyAnalysisData} data
- * @returns {AggregatedEnedisMonthlyDataloads}
*/
/**
* Get an enedis monthly analysis for given month and year
- * @param {number} year
- * @param {number} month
- * @returns {Promise<EnedisMonthlyAnalysisData[]>}
*/
async getEnedisMonthlyAnalysisByDate(year, month) {
const query = (0, _cozyClient.Q)(_doctypes.ENEDIS_MONTHLY_ANALYSIS_DATA_DOCTYPE).where({
@@ -99777,8 +99729,6 @@ class EnedisMonthlyAnalysisDataService {
}
/**
* Creates a new EnedisMonthlyAnalysis
- * @param {EnedisMonthlyAnalysisData} newEnedisMonthlyAnalysisData
- * @returns {Promise<EnedisMonthlyAnalysisData | null>}
*/
@@ -99800,9 +99750,6 @@ class EnedisMonthlyAnalysisDataService {
}
/**
* Get Max power for a given month and year
- * @param {number} year
- * @param {number} month
- * @returns {Promise<MaxPowerEntity[]>}
*/
diff --git a/services/fluidsPrices/ecolyo.js b/services/fluidsPrices/ecolyo.js
index 66066669f..dd953b84d 100644
--- a/services/fluidsPrices/ecolyo.js
+++ b/services/fluidsPrices/ecolyo.js
@@ -95518,13 +95518,10 @@ class ConsumptionDataManager {
}
/**
* Retrieves an array of fluid types that have incomplete data for a given month.
- *
+ *
* Data is incomplete if at least one daily data is missing for the month.
- *
- * @param {FluidType[]} fluidTypes
* @param {DateTime} month - The month for which to check the data completeness.
- * @returns {Promise<FluidType[]>}
- */
+ */
async getFluidsWithIncompleteData(fluidTypes, month) {
@@ -95678,7 +95675,6 @@ class ConsumptionDataManager {
}
/**
* getLastHourData
- * @param {Client} client
* @param {number} month number
* @returns {Promise<DataloadEntity[]>} usageEvent added
*/
@@ -95701,8 +95697,6 @@ class ConsumptionDataManager {
}
/**
* Get the first entry of a given data doctype (enedis, grdf, egl)
- * @param doctype
- * @returns
*/
@@ -96004,9 +95998,6 @@ var _fluidConfig = _interopRequireDefault(__webpack_require__(749));
class DateChartService {
/**
* Define a time period for a given slide defined by its index
- * @param referenceDate
- * @param timeStep
- * @param index
*/
defineTimePeriod(referenceDate, timeStep, index) {
let date;
@@ -96109,7 +96100,6 @@ class DateChartService {
* @param {DateTime} referenceDate - reference date
* @param {TimeStep} timeStep - time step
* @param {number} index - index
- * @returns {DateTime}
*/
@@ -96122,7 +96112,6 @@ class DateChartService {
* @param {DateTime} referenceDate - reference date
* @param {TimeStep} timeStep - time step
* @param {number} index - index
- * @returns {DateTime}
*/
@@ -96303,8 +96292,6 @@ class DateChartService {
}
/**
* Checks if the last data date is outdated and returns the number of missing days
- * @param {DateTime | null} lastDataDate
- * @param {FluidType} fluidType
* @returns {number| null} - The number of missing days
*/
@@ -96617,7 +96604,8 @@ function getKonnectorSlug(fluidType) {
throw new Error('unknown fluidtype');
}
}
-/** Return lowercase fluidtype
+/**
+ * Return lowercase fluidtype
* @example FluidType.ELECTRICITY => 'electricity'
*/
@@ -96696,7 +96684,7 @@ function getRelationshipHasMany(doc, relName) {
/**
* Get many relations in doc
* @param {object} doc - DocumentEntity
- * @param {Array<[relName: string]: Array<Relation>>} relNameList - Array of name of the relations
+ * @param relNameList - Array of name of the relations
*/
@@ -96707,8 +96695,6 @@ function getRelationships(doc, relNameList) {
}
/**
* Import a svg file with format : id.svg
- * @param id
- * @param pathType
*/
@@ -96736,7 +96722,7 @@ const getMonthFullName = month => {
};
/**
* Return month string according to month index
- * @Note Equivalent to date.monthLong
+ * @variation Equivalent to date.monthLong
* @param date - DateTime
* @returns month in french
*/
@@ -96835,7 +96821,6 @@ const getTodayDate = () => _luxon.DateTime.local().setZone('utc', {
}).startOf('day');
/**
* Formats an array of strings into a list with commas and an "et" (and) before the last element.
- *
* @param {string[]} array - The array of strings to be formatted.
* @returns {string} The formatted list string.
*
@@ -96844,7 +96829,6 @@ const getTodayDate = () => _luxon.DateTime.local().setZone('utc', {
* If the array has two elements, they are joined with " et " (and).
* If the array has more than two elements, all but the last element are joined with commas,
* and " et " (and) is placed before the last element.
- *
* @example
* // Returns "pomme, banane et cerise"
* formatListWithAnd(['pomme', 'banane', 'cerise']);
@@ -98162,7 +98146,6 @@ class ConverterService {
* @param {FluidConfig} fluidConfig - Fluid configuration
* @param {number} load - Load value
* @param {number} [price] - Price if exist
- * @returns {number}
*/
@@ -99451,8 +99434,6 @@ const getRemotePricesByFluid = async (client, fluidType) => {
};
/**
* Synchro the remote prices with database and returns a date where we have to relaunch aggregation if a price has been edited in backoffice
- * @param {Client} client
- * @param {FluidType} fluidType
* @returns {string | null} the oldest startDate
*/
@@ -99796,7 +99777,6 @@ class FluidPricesService {
}
/**
* Get all prices available in database
- * @returns {FluidPrice[]}
*/
@@ -99810,9 +99790,6 @@ class FluidPricesService {
}
/**
* Get a price according to a fluidType and a data. This method return the nearest and valid price for the given date.
- * @param {FluidType} fluidType
- * @param {DateTime} date
- * @returns {FluidPrice}
*/
@@ -99834,7 +99811,6 @@ class FluidPricesService {
}
/**
* Get current prices for all fluidTypes.
- * @returns {FluidPrice[]}
*/
@@ -99901,8 +99877,7 @@ class FluidPricesService {
}
/**
* Check if a fluidprice exists in db
- * @param {FluidPrice} fluidPrice
- * @returns {FluidPrice | null} price or null
+ * @returns {Promise<FluidPrice | null>} price or null
*/
@@ -99922,8 +99897,7 @@ class FluidPricesService {
}
/**
* Creates a new fluidPrice
- * @param {FluidPrice} fluidPrice
- * @returns {FluidPrice | null} price or null
+ * @returns {Promise<FluidPrice | null>} price or null
*/
@@ -99945,9 +99919,6 @@ class FluidPricesService {
}
/**
* Updates a price in db
- * @param {FluidPrice} doc
- * @param {Partial<FluidPrice>} attributes
- * @returns {FluidPrice | null}
*/
diff --git a/services/monthlyReportNotification/ecolyo.js b/services/monthlyReportNotification/ecolyo.js
index b87911b28..a688d76e0 100644
--- a/services/monthlyReportNotification/ecolyo.js
+++ b/services/monthlyReportNotification/ecolyo.js
@@ -95518,13 +95518,10 @@ class ConsumptionDataManager {
}
/**
* Retrieves an array of fluid types that have incomplete data for a given month.
- *
+ *
* Data is incomplete if at least one daily data is missing for the month.
- *
- * @param {FluidType[]} fluidTypes
* @param {DateTime} month - The month for which to check the data completeness.
- * @returns {Promise<FluidType[]>}
- */
+ */
async getFluidsWithIncompleteData(fluidTypes, month) {
@@ -95678,7 +95675,6 @@ class ConsumptionDataManager {
}
/**
* getLastHourData
- * @param {Client} client
* @param {number} month number
* @returns {Promise<DataloadEntity[]>} usageEvent added
*/
@@ -95701,8 +95697,6 @@ class ConsumptionDataManager {
}
/**
* Get the first entry of a given data doctype (enedis, grdf, egl)
- * @param doctype
- * @returns
*/
@@ -96004,9 +95998,6 @@ var _fluidConfig = _interopRequireDefault(__webpack_require__(749));
class DateChartService {
/**
* Define a time period for a given slide defined by its index
- * @param referenceDate
- * @param timeStep
- * @param index
*/
defineTimePeriod(referenceDate, timeStep, index) {
let date;
@@ -96109,7 +96100,6 @@ class DateChartService {
* @param {DateTime} referenceDate - reference date
* @param {TimeStep} timeStep - time step
* @param {number} index - index
- * @returns {DateTime}
*/
@@ -96122,7 +96112,6 @@ class DateChartService {
* @param {DateTime} referenceDate - reference date
* @param {TimeStep} timeStep - time step
* @param {number} index - index
- * @returns {DateTime}
*/
@@ -96303,8 +96292,6 @@ class DateChartService {
}
/**
* Checks if the last data date is outdated and returns the number of missing days
- * @param {DateTime | null} lastDataDate
- * @param {FluidType} fluidType
* @returns {number| null} - The number of missing days
*/
@@ -96617,7 +96604,8 @@ function getKonnectorSlug(fluidType) {
throw new Error('unknown fluidtype');
}
}
-/** Return lowercase fluidtype
+/**
+ * Return lowercase fluidtype
* @example FluidType.ELECTRICITY => 'electricity'
*/
@@ -96696,7 +96684,7 @@ function getRelationshipHasMany(doc, relName) {
/**
* Get many relations in doc
* @param {object} doc - DocumentEntity
- * @param {Array<[relName: string]: Array<Relation>>} relNameList - Array of name of the relations
+ * @param relNameList - Array of name of the relations
*/
@@ -96707,8 +96695,6 @@ function getRelationships(doc, relNameList) {
}
/**
* Import a svg file with format : id.svg
- * @param id
- * @param pathType
*/
@@ -96736,7 +96722,7 @@ const getMonthFullName = month => {
};
/**
* Return month string according to month index
- * @Note Equivalent to date.monthLong
+ * @variation Equivalent to date.monthLong
* @param date - DateTime
* @returns month in french
*/
@@ -96835,7 +96821,6 @@ const getTodayDate = () => _luxon.DateTime.local().setZone('utc', {
}).startOf('day');
/**
* Formats an array of strings into a list with commas and an "et" (and) before the last element.
- *
* @param {string[]} array - The array of strings to be formatted.
* @returns {string} The formatted list string.
*
@@ -96844,7 +96829,6 @@ const getTodayDate = () => _luxon.DateTime.local().setZone('utc', {
* If the array has two elements, they are joined with " et " (and).
* If the array has more than two elements, all but the last element are joined with commas,
* and " et " (and) is placed before the last element.
- *
* @example
* // Returns "pomme, banane et cerise"
* formatListWithAnd(['pomme', 'banane', 'cerise']);
@@ -98162,7 +98146,6 @@ class ConverterService {
* @param {FluidConfig} fluidConfig - Fluid configuration
* @param {number} load - Load value
* @param {number} [price] - Price if exist
- * @returns {number}
*/
@@ -99150,8 +99133,6 @@ class ProfileService {
}
/**
* Retrieve Profile from the ProfileEntity
- * @param {ProfileEntity} profileEntity
- * @returns {Profile}
*/
@@ -164653,7 +164634,6 @@ const logStack = _cozyLogger.default.namespace('report');
/**
* Get consumption value for all fluid if exist
- * @param client
* @param fluidType - FluidType
*/
const getConsumptionValue = async (client, fluidType, period) => {
@@ -164685,8 +164665,6 @@ const getConsumptionValue = async (client, fluidType, period) => {
};
/**
* Build consumption text to attach in email. According to client consumption, display electricity and/or gaz and/or water
- * @param client
- * @returns string
*/
--
GitLab