@metarisc/metarisc-js 0.0.1-alpha.11 → 0.0.1-alpha.111

package/.eslintrc

@@ -1,15 +1,74 @@
 {
-    "root": true,
-    "parser": "@typescript-eslint/parser",
-    "plugins": [
-        "@typescript-eslint"
-    ],
-    "extends": [
-        "eslint:recommended",
-        "plugin:@typescript-eslint/eslint-recommended",
-        "plugin:@typescript-eslint/recommended"
-    ],
-    "rules": {
-        "no-multiple-empty-lines": [1, { "max": 1, "maxEOF": 0, "maxBOF": 0 }]
-    }
-}
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "plugins": [
+    "@typescript-eslint",
+    "unused-imports",
+    "import"
+  ],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "rules": {
+    "@typescript-eslint/no-explicit-any": [
+      "off"
+    ],
+    "@typescript-eslint/ban-types": [
+      "error", {
+        "extendDefaults": true,
+        "types": {
+          "{}": false
+        }
+      }
+    ],
+    "no-multiple-empty-lines": [
+      "warn", {
+        "max": 1,
+        "maxEOF": 0,
+        "maxBOF": 0
+      }
+    ],
+    "unused-imports/no-unused-imports": [
+      "error"
+    ],
+    "import/no-duplicates": [
+      "error", {
+        "considerQueryString": true,
+        "prefer-inline": true
+      }
+    ],
+    "comma-dangle": [
+      "error", {
+        "arrays": "never",
+        "objects": "never",
+        "imports": "never",
+        "exports": "never",
+        "functions": "never"
+      }
+    ],
+    "space-in-parens": [
+      "error", "never"
+    ],
+    "no-multi-spaces": [
+      "error"
+    ],
+    "space-before-function-paren": [
+      "error", {
+        "anonymous": "never",
+        "named": "never",
+        "asyncArrow": "always"
+      }
+    ],
+    "space-before-blocks": [
+      "error", "always"
+    ],
+    "object-curly-spacing": [
+      "error", "always"
+    ],
+    "array-bracket-spacing": [
+      "error", "never"
+    ]
+  }
+}

package/.github/workflows/main.yml

@@ -3,6 +3,8 @@ name: "CI"
 on:
   push:
     branches: [ main ]
+  pull_request:
+    branches: [ main ]
 
 jobs:
 
@@ -19,11 +21,7 @@ jobs:
           registry-url: 'https://registry.npmjs.org'
 
       - run: npm install
-      
-      - run: npm run compile
 
       - run: npx eslint . --ext .ts
-      
-      - run: npm publish --access=public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - run: npm run compile

package/.github/workflows/publish.yml

@@ -0,0 +1,32 @@
+name: "NPM Publish"
+
+on: workflow_dispatch
+
+jobs:
+
+  build:
+  
+    runs-on: ubuntu-latest
+
+    steps:
+
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-node@v3
+        with:
+          registry-url: 'https://registry.npmjs.org'
+
+      - run: npm install
+
+      - run: npm run compile
+
+      - name: Bump package version
+        run: |
+          git config --global user.name github-actions
+          git config --global user.email github-actions@github.com
+          npm version prerelease --preid alpha
+          git push origin main --follow-tags --force
+      
+      - run: npm publish --access=public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/README.md

@@ -1,4 +1,3 @@
-
 # Metarisc JS
 
 La librairie Metarisc JS offre un accès simple et pratique à l'API Metarisc à partir d'applications écrites en langage JS. Elle comprend un ensemble de classes et de fonctions pour l'ensemble des ressources de l'API.
@@ -13,20 +12,92 @@ npm i @metarisc/metarisc-js
 
 Pour utiliser la librairie, il suffit de l'importer comme ceci :
 
-```php
-import { Metarisc } from '@metarisc/metarisc-js';';
+```ts
+import { Metarisc } from "@metarisc/metarisc-js";
 ```
 
 ## Utilisation
 
 ### Requêtes
 
-Pour effectuer une requête sur Metarisc, qu'elle soit simple ou paginés (voir la [documentation](http://metarisc.fr/docs/api/#/#pagination)), faites de cette manière :
+Pour effectuer une requête sur Metarisc, il faut tout d'adord initialisé le client metarisc de cette manière :
+
+```ts
+const m = new Metarisc({
+    metarisc_url: "https://api.metarisc.fr"
+});
+
+await m.authenticate(AuthMethod.CLIENT_CREDENTIALS, {
+    scope: 'openid profile email',
+    client_id: "client_id",
+    client_secret: "client_secret"
+});
+
+m.dossiers.getDossier("123456");
+```
+
+Ensuite vous pouvez faire vos requêtes.
+
+#### Requêtes simple
+
+Pour faire un appel API après initialisation du client, vous pouvez utiliser l'accès rapide à l'API souhaitée.
+
+Exemple :
+
+```ts
+m.dossiers.getDossier("123456");
+```
+
+Le type de retour d'une requête simple est :
+
+```ts
+Promise<AxiosResponse<T>>;
+```
+
+(voir les documentations suivantes [Promise](https://developer.mozilla.org/fr/docs/Web/JavaScript/Reference/Global_Objects/Promise) et [AxiosResponse](https://axios-http.com/docs/res_schema))
+
+#### Requêtes paginées
+
+Pour récupérer des résultats paginés Metarisc (voir la [documentation](http://metarisc.fr/docs/api/#/#pagination)), il suffit de faire appel à l'api souhaitée de la même manière que pour une requête simple.
 
 Exemple :
 
 ```ts
 const m = new Metarisc(config);
-m.NotificationsAPI.getNotification('123456');
 m.NotificationsAPI.paginateNotifications();
-```
+```
+
+Le type de retour d'une requête paginée est :
+
+```ts
+AsyncGenerator<T>;
+```
+
+(voir la documentation suivante [AsyncGenerator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/AsyncGenerator))
+
+#### Écouteur d'événements pour les requêtes
+
+Il est possible d'ajouter un écouteur d'événements sur chaque requête effectuée par le client Metarisc. Pour ce faire, vous pouvez utiliser la méthode on() de l'objet core, en spécifiant le nom de l'événement on("request", function)
+
+```ts
+m.on("request", (config: Event): void => {
+    //Action à effectuer à chaque requête
+});
+```
+
+Cet écouteur est particulièrement utile pour effectuer des vérifications, comme la validation du token d'authentification avant l'envoi de chaque requête.
+
+La fonction de rappel (callback) reçoit en paramètre un objet Event. Cet objet contient une propriété detail, où sont stockées toutes les informations relatives à la requête entrante.
+
+```ts
+m.on("request", (config: Event): void => {
+    console.log(config.detail); // Retourne un objet de type RequestConfig
+    //{
+    //body?: any;
+    //headers?: { [name: string]: string | string[] };
+    //params?: { [param: string]: string | string[] };
+    //endpoint?: string;
+    //method?: string;
+    //}
+});
+```

package/lib/api/AnomaliesAPI.d.ts

@@ -0,0 +1,24 @@
+import { Core, MetariscConfig } from "../core";
+import type { AxiosResponse } from "axios";
+import { Client } from "../client";
+import { Collection } from "../collection";
+import { AnomalieDECI } from '../model/AnomalieDECI';
+export declare class AnomaliesAPI extends Core {
+    constructor(config: MetariscConfig, client?: Client);
+    /**
+     * Suppression d'une anomalie DECI type dans la bibliothèque DECI.
+     */
+    deleteAnomalie(anomalieId: string): Promise<AxiosResponse<void>>;
+    /**
+     * Détails d'une anomalie type DECI présente dans la bibliothèque DECI.
+     */
+    getAnomalie(anomalieId: string): Promise<AxiosResponse<AnomalieDECI>>;
+    /**
+     * Retourne une liste des anomalies types dans la bibliothèque DECI.
+     */
+    paginateAnomalies(sort?: 'code' | '-code', texte?: string, code?: number): Collection<AnomalieDECI>;
+    /**
+     * Ajout d'une nouvelle anomalie DECI type dans la bibliothèque DECI.
+     */
+    postAnomalie(params: any): Promise<AxiosResponse<AnomalieDECI>>;
+}

package/lib/api/AnomaliesAPI.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AnomaliesAPI = void 0;
+// File generated from our OpenAPI spec
+const core_1 = require("../core");
+const utils_1 = require("../utils");
+class AnomaliesAPI extends core_1.Core {
+    constructor(config, client) {
+        super(config, client);
+    }
+    /**
+     * Suppression d'une anomalie DECI type dans la bibliothèque DECI.
+     */
+    deleteAnomalie(anomalieId) {
+        const pathVariable = { 'anomalie_id': (new String(anomalieId)).toString() };
+        return this.request({
+            method: 'DELETE',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/anomalies/{anomalie_id}'),
+            transformResponse: [(data) => {
+                    if (!data)
+                        return data;
+                    const parsedData = JSON.parse(data);
+                    return parsedData;
+                }]
+        });
+    }
+    /**
+     * Détails d'une anomalie type DECI présente dans la bibliothèque DECI.
+     */
+    getAnomalie(anomalieId) {
+        const pathVariable = { 'anomalie_id': (new String(anomalieId)).toString() };
+        return this.request({
+            method: 'GET',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/anomalies/{anomalie_id}'),
+            transformResponse: [(data) => {
+                    if (!data)
+                        return data;
+                    const parsedData = JSON.parse(data);
+                    return parsedData;
+                }]
+        });
+    }
+    /**
+     * Retourne une liste des anomalies types dans la bibliothèque DECI.
+     */
+    paginateAnomalies(sort, texte, code) {
+        const pathVariable = {};
+        return this.collect({
+            method: 'GET',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/anomalies'),
+            params: utils_1.Utils.payloadFilter({
+                'sort': sort === undefined ? undefined : (new String(sort)).toString(),
+                'texte': texte === undefined ? undefined : (new String(texte)).toString(),
+                'code': code === undefined ? undefined : (new String(code)).toString()
+            }),
+            transformResponse: [(data) => {
+                    if (!data)
+                        return data;
+                    const parsedData = JSON.parse(data);
+                    return parsedData;
+                }]
+        });
+    }
+    /**
+     * Ajout d'une nouvelle anomalie DECI type dans la bibliothèque DECI.
+     */
+    postAnomalie(params) {
+        const pathVariable = {};
+        return this.request({
+            method: 'POST',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/anomalies'),
+            transformResponse: [(data) => {
+                    if (!data)
+                        return data;
+                    const parsedData = JSON.parse(data);
+                    return parsedData;
+                }],
+            body: utils_1.Utils.payloadFilter(params)
+        });
+    }
+}
+exports.AnomaliesAPI = AnomaliesAPI;

package/lib/api/CommissionsAPI.d.ts

@@ -0,0 +1,55 @@
+import { Core, MetariscConfig } from "../core";
+import type { AxiosResponse } from "axios";
+import { Client } from "../client";
+import { Collection } from "../collection";
+import { Commission } from '../model/Commission';
+import { CommissionMembre } from '../model/CommissionMembre';
+import { CommissionPreferences } from '../model/CommissionPreferences';
+import { PassageCommission } from '../model/PassageCommission';
+export declare class CommissionsAPI extends Core {
+    constructor(config: MetariscConfig, client?: Client);
+    /**
+     * Récupération des détails de la commission.
+     */
+    getCommission(commissionId: string): Promise<AxiosResponse<Commission>>;
+    /**
+     * Récupération des préférences de la commission.
+     */
+    getCommissionPreferences(commissionId: string): Promise<AxiosResponse<CommissionPreferences>>;
+    /**
+     * Liste des commissions.
+     */
+    paginateCommissions(libelle?: string, type?: 'Sous-commission départementale' | 'Commission communale' | 'Commission intercommunale' | 'Commission d\'arrondissement' | 'CoDERST'): Collection<Commission>;
+    /**
+     * Récupération de la liste des dates de passage de la commission. Cela peut représenter une visite périodique sur site de la commission, ou un passage en salle.
+     */
+    paginateCommissionDates(commissionId: string, fromDate?: Date, type?: 'salle' | 'visite_reception_travaux_en_groupe_de_visite' | 'visite_reception_avant_ouverture_en_groupe_de_visite' | 'visite_periodique_en_groupe_de_visite' | 'visite_inopinee_en_groupe_de_visite' | 'visite_controle_en_groupe_de_visite' | 'visite_chantier_en_groupe_de_visite' | 'visite_conseil_en_groupe_de_visite' | 'visite_reception_travaux_en_pleniere' | 'visite_reception_avant_ouverture_en_pleniere' | 'visite_periodique_en_pleniere' | 'visite_inopinee_en_pleniere' | 'visite_controle_en_pleniere' | 'visite_chantier_en_pleniere' | 'visite_conseil_en_pleniere'): Collection<PassageCommission>;
+    /**
+     * Récupération de la liste des membres de la commission.
+     */
+    paginateCommissionMembres(commissionId: string, commission?: string): Collection<CommissionMembre>;
+    /**
+     * Modification d'une commission existant en définissant les valeurs des paramètres transmis. Tous les paramètres non fournis resteront inchangés.
+     */
+    patchCommission(commissionId: string, params: any): Promise<AxiosResponse<Commission>>;
+    /**
+     * Modification d'un passage en commission existant en définissant les valeurs des paramètres transmis. Tous les paramètres non fournis resteront inchangés.
+     */
+    patchPassageDatesCommission(commissionId: string, passageId: string, params: any): Promise<AxiosResponse<PassageCommission>>;
+    /**
+     * Ajoute une commission.
+     */
+    postCommission(params: any): Promise<AxiosResponse<Commission>>;
+    /**
+     * Ajout d'une date de passage en commission.
+     */
+    postCommissionDate(commissionId: string, params: any): Promise<AxiosResponse<PassageCommission>>;
+    /**
+     * Ajout d'un membre dans la commission.
+     */
+    postMembresCommission(commissionId: string, params: any): Promise<AxiosResponse<CommissionMembre>>;
+    /**
+     * Mise à jour des préférences de la commission en définissant les valeurs des paramètres transmis. Tous les paramètres non fournis resteront inchangés.
+     */
+    postCommissionPreferences(commissionId: string, params: any): Promise<AxiosResponse<CommissionPreferences>>;
+}

package/lib/api/CommissionsAPI.js

@@ -0,0 +1,205 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommissionsAPI = void 0;
+// File generated from our OpenAPI spec
+const core_1 = require("../core");
+const utils_1 = require("../utils");
+class CommissionsAPI extends core_1.Core {
+    constructor(config, client) {
+        super(config, client);
+    }
+    /**
+     * Récupération des détails de la commission.
+     */
+    getCommission(commissionId) {
+        const pathVariable = { 'commission_id': (new String(commissionId)).toString() };
+        return this.request({
+            method: 'GET',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions/{commission_id}'),
+            transformResponse: [(data) => {
+                    if (!data)
+                        return data;
+                    const parsedData = JSON.parse(data);
+                    return parsedData;
+                }]
+        });
+    }
+    /**
+     * Récupération des préférences de la commission.
+     */
+    getCommissionPreferences(commissionId) {
+        const pathVariable = { 'commission_id': (new String(commissionId)).toString() };
+        return this.request({
+            method: 'GET',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions/{commission_id}/preferences'),
+            transformResponse: [(data) => {
+                    if (!data)
+                        return data;
+                    const parsedData = JSON.parse(data);
+                    return parsedData;
+                }]
+        });
+    }
+    /**
+     * Liste des commissions.
+     */
+    paginateCommissions(libelle, type) {
+        const pathVariable = {};
+        return this.collect({
+            method: 'GET',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions'),
+            params: utils_1.Utils.payloadFilter({
+                'libelle': libelle === undefined ? undefined : (new String(libelle)).toString(),
+                'type': type === undefined ? undefined : (new String(type)).toString()
+            }),
+            transformResponse: [(data) => {
+                    if (!data)
+                        return data;
+                    const parsedData = JSON.parse(data);
+                    return parsedData;
+                }]
+        });
+    }
+    /**
+     * Récupération de la liste des dates de passage de la commission. Cela peut représenter une visite périodique sur site de la commission, ou un passage en salle.
+     */
+    paginateCommissionDates(commissionId, fromDate, type) {
+        const pathVariable = { 'commission_id': (new String(commissionId)).toString() };
+        return this.collect({
+            method: 'GET',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions/{commission_id}/dates'),
+            params: utils_1.Utils.payloadFilter({
+                'from_date': fromDate === undefined ? undefined : utils_1.Utils.formatDate(fromDate),
+                'type': type === undefined ? undefined : (new String(type)).toString()
+            }),
+            transformResponse: [(data) => {
+                    if (!data)
+                        return data;
+                    const parsedData = JSON.parse(data);
+                    return parsedData;
+                }]
+        });
+    }
+    /**
+     * Récupération de la liste des membres de la commission.
+     */
+    paginateCommissionMembres(commissionId, commission) {
+        const pathVariable = { 'commission_id': (new String(commissionId)).toString() };
+        return this.collect({
+            method: 'GET',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions/{commission_id}/membres'),
+            params: utils_1.Utils.payloadFilter({
+                'commission': commission === undefined ? undefined : (new String(commission)).toString()
+            }),
+            transformResponse: [(data) => {
+                    if (!data)
+                        return data;
+                    const parsedData = JSON.parse(data);
+                    return parsedData;
+                }]
+        });
+    }
+    /**
+     * Modification d'une commission existant en définissant les valeurs des paramètres transmis. Tous les paramètres non fournis resteront inchangés.
+     */
+    patchCommission(commissionId, params) {
+        const pathVariable = { 'commission_id': (new String(commissionId)).toString() };
+        return this.request({
+            method: 'PATCH',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions/{commission_id}'),
+            transformResponse: [(data) => {
+                    if (!data)
+                        return data;
+                    const parsedData = JSON.parse(data);
+                    return parsedData;
+                }],
+            body: utils_1.Utils.payloadFilter(params)
+        });
+    }
+    /**
+     * Modification d'un passage en commission existant en définissant les valeurs des paramètres transmis. Tous les paramètres non fournis resteront inchangés.
+     */
+    patchPassageDatesCommission(commissionId, passageId, params) {
+        const pathVariable = { 'commission_id': (new String(commissionId)).toString(), 'passage_id': (new String(passageId)).toString() };
+        return this.request({
+            method: 'PATCH',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions/{commission_id}/dates/{passage_id}'),
+            transformResponse: [(data) => {
+                    if (!data)
+                        return data;
+                    const parsedData = JSON.parse(data);
+                    return parsedData;
+                }],
+            body: utils_1.Utils.payloadFilter(params)
+        });
+    }
+    /**
+     * Ajoute une commission.
+     */
+    postCommission(params) {
+        const pathVariable = {};
+        return this.request({
+            method: 'POST',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions'),
+            transformResponse: [(data) => {
+                    if (!data)
+                        return data;
+                    const parsedData = JSON.parse(data);
+                    return parsedData;
+                }],
+            body: utils_1.Utils.payloadFilter(params)
+        });
+    }
+    /**
+     * Ajout d'une date de passage en commission.
+     */
+    postCommissionDate(commissionId, params) {
+        const pathVariable = { 'commission_id': (new String(commissionId)).toString() };
+        return this.request({
+            method: 'POST',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions/{commission_id}/dates'),
+            transformResponse: [(data) => {
+                    if (!data)
+                        return data;
+                    const parsedData = JSON.parse(data);
+                    return parsedData;
+                }],
+            body: utils_1.Utils.payloadFilter(params)
+        });
+    }
+    /**
+     * Ajout d'un membre dans la commission.
+     */
+    postMembresCommission(commissionId, params) {
+        const pathVariable = { 'commission_id': (new String(commissionId)).toString() };
+        return this.request({
+            method: 'POST',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions/{commission_id}/membres'),
+            transformResponse: [(data) => {
+                    if (!data)
+                        return data;
+                    const parsedData = JSON.parse(data);
+                    return parsedData;
+                }],
+            body: utils_1.Utils.payloadFilter(params)
+        });
+    }
+    /**
+     * Mise à jour des préférences de la commission en définissant les valeurs des paramètres transmis. Tous les paramètres non fournis resteront inchangés.
+     */
+    postCommissionPreferences(commissionId, params) {
+        const pathVariable = { 'commission_id': (new String(commissionId)).toString() };
+        return this.request({
+            method: 'POST',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions/{commission_id}/preferences'),
+            transformResponse: [(data) => {
+                    if (!data)
+                        return data;
+                    const parsedData = JSON.parse(data);
+                    return parsedData;
+                }],
+            body: utils_1.Utils.payloadFilter(params)
+        });
+    }
+}
+exports.CommissionsAPI = CommissionsAPI;

package/lib/api/CommissionsMembresAPI.d.ts

@@ -0,0 +1,24 @@
+import { Core, MetariscConfig } from "../core";
+import type { AxiosResponse } from "axios";
+import { Client } from "../client";
+import { Collection } from "../collection";
+import { CommissionMembre } from '../model/CommissionMembre';
+export declare class CommissionsMembresAPI extends Core {
+    constructor(config: MetariscConfig, client?: Client);
+    /**
+     * Suppression d'un membre de commission existant.
+     */
+    deleteMembre(membreId: string): Promise<AxiosResponse<void>>;
+    /**
+     * Récupération d'une fiche d'un membre d'une commission.
+     */
+    getMembre(membreId: string): Promise<AxiosResponse<CommissionMembre>>;
+    /**
+     * Récupération de la liste membres des commissions.
+     */
+    paginateMembres(): Collection<CommissionMembre>;
+    /**
+     * Mise à jour d'un membre de commission existant en définissant les valeurs des paramètres transmis. Tous les paramètres non fournis resteront inchangés.
+     */
+    updateMembre(membreId: string, params: any): Promise<AxiosResponse<CommissionMembre>>;
+}