refactor: use typescript for types

.vscode/settings.json

@@ -33,6 +33,7 @@
     "camelcase",
     "cicid",
     "coeff",
+    "controle",
     "ecolyo",
     "ecolyodemo",
     "energie",
@@ -49,5 +50,6 @@
     "perim",
     "periode",
     "publiees"
-  ]
+  ],
+  "prettier.semi": true
 }

package.json

@@ -16,6 +16,12 @@
   "eslintConfig": {
     "extends": [
       "cozy-app"
+    ],
+    "prettier/prettier": [
+      "error",
+      {
+       "semi": true
+      }
     ]
   },
   "eslintIgnore": [

src/core/core.js

@@ -14,7 +14,7 @@ const ACCOUNT_ID = isLocal() ? 'default_account_id' : 'grdfgrandlyon'
 const manualExecution = process.env.COZY_JOB_MANUAL_EXECUTION === 'true'
 
 /**
- * @param {GRDFConsent[]} consents
+ * @param {import('../types').GRDFConsent[]} consents
  * @param {string} boUrlGRDF
  * @param {string} boToken
  * @returns {Promise<boolean>} Returns true if consent needs to be created. Returns false if consent is valid

src/index.js

@@ -52,8 +52,8 @@ module.exports = new BaseKonnector(start)
  * the account information come from ./konnector-dev-config.json file
  * cozyParameters are static parameters, independents from the account. Most often, it can be a
  * secret api key.
- * @param {fields} fields
- * @param {{secret: parameters}} cozyParameters
+ * @param {import('./types').fields} fields
+ * @param {{secret: import('./types').parameters}} cozyParameters
  */
 async function start(fields, cozyParameters) {
   log('info', `isManual execution: ${manualExecution}`)

src/requests/cozy.js

@@ -5,7 +5,7 @@ const cozyClient = require('cozy-konnector-libs/dist/libs/cozyclient')
 /**
  * Return account
  * @param {string} accountId
- * @returns {Promise<Account>}
+ * @returns {Promise<import('../types').Account>}
  */
 async function getAccount(accountId) {
   log('info', `getAccount: ${accountId}`)

src/requests/grdf.js

@@ -43,7 +43,7 @@ async function getAuthToken(client_id, client_secret) {
  *
  * @param {string} bearerToken
  * @param {string} pce
- * @returns {Promise<GRDFConsent[]>}
+ * @returns {Promise<import('../types').GRDFConsent[]>}
  */
 async function getConsents(bearerToken, pce) {
   try {

src/types.js

-/**
- * Cozy Fields definition
- * @typedef {object} fields
- * @property {string} pce
- * @property {string} email
- * @property {string} lastname
- * @property {string} firstname
- * @property {string} postalCode
- */
-
-/**
- * Cozy parameters definition
- * @typedef {object} parameters
- * @property {string} boBaseUrl
- * @property {string} boToken
- * @property {string} client_id
- * @property {string} client_secret
- */
-
-/**
- * Account definition
- * @typedef {object} Account
- * @property {AccountData} data
- * @property {object} auth
- * @property {object} cozyMetadata
- */
-
-/**
- * AccountData definition
- * @typedef {object} AccountData
- * @property {string | undefined} consentId
- */
-
-/**
- * GRDF Consents
- * Can be null but containing code_statut_traitement and message_retour_traitement if no consents
- * @typedef {Object} GRDFConsent
- * @property {string} id_droit_acces
- * @property {string} id_pce
- * @property {string} role_tiers
- * @property {string} raison_sociale_du_tiers
- * @property {string} nom_titulaire
- * @property {string} courriel_titulaire
- * @property {string} code_postal
- * @property {boolean} perim_donnees_contractuelles
- * @property {boolean} perim_donnees_techniques
- * @property {boolean} perim_donnees_informatives
- * @property {boolean} perim_donnees_publiees
- * @property {string} date_creation
- * @property {string} etat_droit_acces
- * @property {string|null} date_revocation
- * @property {string|null} source_revocation
- * @property {string|null} date_passage_a_obsolete
- * @property {string|null} source_passage_a_obsolete
- * @property {string|null} date_passage_a_refuse
- * @property {string} date_debut_droit_acces
- * @property {string} date_fin_droit_acces
- * @property {string} perim_donnees_conso_debut
- * @property {string} perim_donnees_conso_fin
- * @property {string|null} source_passage_a_refuse
- * @property {string} parcours
- * @property {string|null} statut_controle_preuve
- * @property {string|null} date_limite_transmission_preuve
- * @property {string|null} numero_telephone_mobile_titulaire
- * Default response from GRDF
- * @property {string} code_statut_traitement
- * @property {string} message_retour_traitement
- */

src/types.ts

+/* eslint-disable prettier/prettier */
+
+/**
+ * GRDF Consents
+ * Can be null but containing code_statut_traitement and message_retour_traitement if no consents
+ * */
+export type GRDFConsent = {
+  id_droit_acces: string
+  id_pce: string
+  role_tiers: string
+  raison_sociale_du_tiers: string
+  nom_titulaire: string
+  courriel_titulaire: string
+  code_postal: string
+  perim_donnees_contractuelles: boolean
+  perim_donnees_techniques: boolean
+  perim_donnees_informatives: boolean
+  perim_donnees_publiees: boolean
+  date_creation: string
+  etat_droit_acces: string
+  date_revocation: string | null
+  source_revocation: string | null
+  date_passage_a_obsolete: string | null
+  source_passage_a_obsolete: string | null
+  date_passage_a_refuse: string | null
+  date_debut_droit_acces: string
+  date_fin_droit_acces: string
+  perim_donnees_conso_debut: string
+  perim_donnees_conso_fin: string
+  source_passage_a_refuse: string | null
+  parcours: string
+  statut_controle_preuve: string | null
+  date_limite_transmission_preuve: string | null
+  numero_telephone_mobile_titulaire: string | null
+  /** Default response from GRDF */
+  code_statut_traitement: string
+  message_retour_traitement: string
+}
+
+/** Cozy Fields definition*/
+export type fields = {
+  pce: string
+  email: string
+  lastname: string
+  firstname: string
+  postalCode: string
+}
+
+/** Cozy parameters definition */
+export type parameters = {
+  boBaseUrl: string
+  boToken: string
+  client_id: string
+  client_secret: string
+}
+
+/** Account definition */
+export type Account = {
+  data: AccountData
+  auth: object
+  cozyMetadata: object
+}
+
+/** AccountData definition */
+export type AccountData = {
+  consentId: string | undefined
+}