@metarisc/metarisc-js 0.0.1-alpha.7 → 0.0.1-alpha.71

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

@@ -19,11 +19,5 @@ 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: npx eslint . --ext .ts

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,88 @@ 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",
+    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,28 @@
+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(page?: number, perPage?: number, sort?: string, texte?: string, code?: string): Collection<AnomalieDECI>;
+    /**
+     * Ajout d'une nouvelle anomalie DECI type dans la bibliothèque DECI.
+     */
+    postAnomalie(params: {
+        code: number;
+        texte: string;
+        indice_de_gravite: number;
+    }): Promise<AxiosResponse<AnomalieDECI>>;
+}

package/lib/api/AnomaliesAPI.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AnomaliesAPI = void 0;
+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.
+     */
+    async deleteAnomalie(anomalieId) {
+        const pathVariable = { 'anomalie_id': (new String(anomalieId)).toString() };
+        return this.request({
+            method: 'DELETE',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/anomalies/{anomalie_id}'),
+            params: {},
+            body: utils_1.Utils.payloadFilter({})
+        });
+    }
+    /**
+     * Détails d'une anomalie type DECI présente dans la bibliothèque DECI.
+     */
+    async getAnomalie(anomalieId) {
+        const pathVariable = { 'anomalie_id': (new String(anomalieId)).toString() };
+        return this.request({
+            method: 'GET',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/anomalies/{anomalie_id}'),
+            params: {},
+            body: utils_1.Utils.payloadFilter({})
+        });
+    }
+    /**
+     * Retourne une liste des anomalies types dans la bibliothèque DECI.
+     */
+    paginateAnomalies(page, perPage, sort, texte, code) {
+        const pathVariable = {};
+        return this.collect({
+            method: 'GET',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/anomalies'),
+            params: { 'page': page?.toString(), 'per_page': perPage?.toString(), 'sort': sort, 'texte': texte, 'code': code }
+        });
+    }
+    /**
+     * Ajout d'une nouvelle anomalie DECI type dans la bibliothèque DECI.
+     */
+    async postAnomalie(params) {
+        const pathVariable = {};
+        return this.request({
+            method: 'POST',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/anomalies'),
+            params: {},
+            body: utils_1.Utils.payloadFilter(params)
+        });
+    }
+}
+exports.AnomaliesAPI = AnomaliesAPI;

package/lib/api/CommissionsAPI.d.ts

@@ -0,0 +1,59 @@
+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(page?: number, perPage?: number): Collection<Commission>;
+    /**
+     * Récupération de la liste des dates de passage de la commission.
+     */
+    paginateCommissionDates(commissionId: string, page?: number, perPage?: number): Collection<PassageCommission>;
+    /**
+     * Récupération de la liste des membres de la commission.
+     */
+    paginateCommissionMembres(commissionId: string, page?: number, perPage?: number): Collection<CommissionMembre>;
+    /**
+     * Ajoute une commission.
+     */
+    postCommission(params: {
+        type: string;
+        libelle: string;
+        presidence_id?: string;
+    }): Promise<AxiosResponse<Commission>>;
+    /**
+     * Ajout d'une date de passage en commission.
+     */
+    postCommissionDate(commissionId: string, params: {
+        date_debut: Date;
+        date_fin: Date;
+        type: string;
+        libelle: string;
+    }): Promise<AxiosResponse<PassageCommission>>;
+    /**
+     * Ajout d'un membre dans la commission.
+     */
+    postMembresCommission(commissionId: string, params: {
+        titre: string;
+        presence_obligatoire: boolean;
+    }): Promise<AxiosResponse<CommissionMembre>>;
+    /**
+     * Mise à jour des préférences de la commission.
+     */
+    postCommissionPreferences(commissionId: string): Promise<AxiosResponse<CommissionPreferences>>;
+}

package/lib/api/CommissionsAPI.js

@@ -0,0 +1,116 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommissionsAPI = void 0;
+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.
+     */
+    async getCommission(commissionId) {
+        const pathVariable = { 'commission_id': (new String(commissionId)).toString() };
+        return this.request({
+            method: 'GET',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions/{commission_id}'),
+            params: {},
+            body: utils_1.Utils.payloadFilter({})
+        });
+    }
+    /**
+     * Récupération des préférences de la commission.
+     */
+    async 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'),
+            params: {},
+            body: utils_1.Utils.payloadFilter({})
+        });
+    }
+    /**
+     * Liste des commissions.
+     */
+    paginateCommissions(page, perPage) {
+        const pathVariable = {};
+        return this.collect({
+            method: 'GET',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions'),
+            params: { 'page': page?.toString(), 'per_page': perPage?.toString() }
+        });
+    }
+    /**
+     * Récupération de la liste des dates de passage de la commission.
+     */
+    paginateCommissionDates(commissionId, page, perPage) {
+        const pathVariable = { 'commission_id': (new String(commissionId)).toString() };
+        return this.collect({
+            method: 'GET',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions/{commission_id}/dates'),
+            params: { 'page': page?.toString(), 'per_page': perPage?.toString() }
+        });
+    }
+    /**
+     * Récupération de la liste des membres de la commission.
+     */
+    paginateCommissionMembres(commissionId, page, perPage) {
+        const pathVariable = { 'commission_id': (new String(commissionId)).toString() };
+        return this.collect({
+            method: 'GET',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions/{commission_id}/membres'),
+            params: { 'page': page?.toString(), 'per_page': perPage?.toString() }
+        });
+    }
+    /**
+     * Ajoute une commission.
+     */
+    async postCommission(params) {
+        const pathVariable = {};
+        return this.request({
+            method: 'POST',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions'),
+            params: {},
+            body: utils_1.Utils.payloadFilter(params)
+        });
+    }
+    /**
+     * Ajout d'une date de passage en commission.
+     */
+    async 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'),
+            params: {},
+            body: utils_1.Utils.payloadFilter(params)
+        });
+    }
+    /**
+     * Ajout d'un membre dans la commission.
+     */
+    async 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'),
+            params: {},
+            body: utils_1.Utils.payloadFilter(params)
+        });
+    }
+    /**
+     * Mise à jour des préférences de la commission.
+     */
+    async postCommissionPreferences(commissionId) {
+        const pathVariable = { 'commission_id': (new String(commissionId)).toString() };
+        return this.request({
+            method: 'POST',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions/{commission_id}/preferences'),
+            params: {},
+            body: utils_1.Utils.payloadFilter({})
+        });
+    }
+}
+exports.CommissionsAPI = CommissionsAPI;

package/lib/api/CommissionsMembresAPI.d.ts

@@ -0,0 +1,27 @@
+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(page?: number, perPage?: number): Collection<CommissionMembre>;
+    /**
+     * Mise à jour d'un membre de commission existant.
+     */
+    updateMembre(membreId: string, params: {
+        titre?: string;
+        presence_obligatoire?: boolean;
+    }): Promise<AxiosResponse<CommissionMembre>>;
+}

package/lib/api/CommissionsMembresAPI.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommissionsMembresAPI = void 0;
+const core_1 = require("../core");
+const utils_1 = require("../utils");
+class CommissionsMembresAPI extends core_1.Core {
+    constructor(config, client) {
+        super(config, client);
+    }
+    /**
+     * Suppression d'un membre de commission existant.
+     */
+    async deleteMembre(membreId) {
+        const pathVariable = { 'membre_id': (new String(membreId)).toString() };
+        return this.request({
+            method: 'DELETE',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions_membres/{membre_id}'),
+            params: {},
+            body: utils_1.Utils.payloadFilter({})
+        });
+    }
+    /**
+     * Récupération d'une fiche d'un membre d'une commission.
+     */
+    async getMembre(membreId) {
+        const pathVariable = { 'membre_id': (new String(membreId)).toString() };
+        return this.request({
+            method: 'GET',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions_membres/{membre_id}'),
+            params: {},
+            body: utils_1.Utils.payloadFilter({})
+        });
+    }
+    /**
+     * Récupération de la liste membres des commissions.
+     */
+    paginateMembres(page, perPage) {
+        const pathVariable = {};
+        return this.collect({
+            method: 'GET',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions_membres'),
+            params: { 'page': page?.toString(), 'per_page': perPage?.toString() }
+        });
+    }
+    /**
+     * Mise à jour d'un membre de commission existant.
+     */
+    async updateMembre(membreId, params) {
+        const pathVariable = { 'membre_id': (new String(membreId)).toString() };
+        return this.request({
+            method: 'POST',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions_membres/{membre_id}'),
+            params: {},
+            body: utils_1.Utils.payloadFilter(params)
+        });
+    }
+}
+exports.CommissionsMembresAPI = CommissionsMembresAPI;

package/lib/api/ContactsAPI.d.ts

@@ -0,0 +1,37 @@
+import { Core, MetariscConfig } from "../core";
+import type { AxiosResponse } from "axios";
+import { Client } from "../client";
+import { Collection } from "../collection";
+import { Contact } from '../model/Contact';
+export declare class ContactsAPI extends Core {
+    constructor(config: MetariscConfig, client?: Client);
+    /**
+     * Suppression d'une fiche contact existante.
+     */
+    deleteContact(contactId: string): Promise<AxiosResponse<void>>;
+    /**
+     * Récupération d'une fiche contact.
+     */
+    getContact(contactId: string): Promise<AxiosResponse<Contact>>;
+    /**
+     * Récupération de la liste des contacts.
+     */
+    paginateContacts(page?: number, perPage?: number): Collection<Contact>;
+    /**
+     * Mise à jour d'une fiche contact existante.
+     */
+    updateContact(contactId: string, params: {
+        nom?: string;
+        prenom?: string;
+        fonction?: string;
+        telephone_fixe?: string;
+        telephone_portable?: string;
+        telephone_fax?: string;
+        adresse?: string;
+        site_web_url?: string;
+        civilite?: string;
+        societe?: string;
+        email?: string;
+        observations?: string;
+    }): Promise<AxiosResponse<Contact>>;
+}

package/lib/api/ContactsAPI.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContactsAPI = void 0;
+const core_1 = require("../core");
+const utils_1 = require("../utils");
+class ContactsAPI extends core_1.Core {
+    constructor(config, client) {
+        super(config, client);
+    }
+    /**
+     * Suppression d'une fiche contact existante.
+     */
+    async deleteContact(contactId) {
+        const pathVariable = { 'contact_id': (new String(contactId)).toString() };
+        return this.request({
+            method: 'DELETE',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/contacts/{contact_id}'),
+            params: {},
+            body: utils_1.Utils.payloadFilter({})
+        });
+    }
+    /**
+     * Récupération d'une fiche contact.
+     */
+    async getContact(contactId) {
+        const pathVariable = { 'contact_id': (new String(contactId)).toString() };
+        return this.request({
+            method: 'GET',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/contacts/{contact_id}'),
+            params: {},
+            body: utils_1.Utils.payloadFilter({})
+        });
+    }
+    /**
+     * Récupération de la liste des contacts.
+     */
+    paginateContacts(page, perPage) {
+        const pathVariable = {};
+        return this.collect({
+            method: 'GET',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/contacts'),
+            params: { 'page': page?.toString(), 'per_page': perPage?.toString() }
+        });
+    }
+    /**
+     * Mise à jour d'une fiche contact existante.
+     */
+    async updateContact(contactId, params) {
+        const pathVariable = { 'contact_id': (new String(contactId)).toString() };
+        return this.request({
+            method: 'POST',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/contacts/{contact_id}'),
+            params: {},
+            body: utils_1.Utils.payloadFilter(params)
+        });
+    }
+}
+exports.ContactsAPI = ContactsAPI;