@metarisc/metarisc-js 0.0.1-alpha.6 → 0.0.1-alpha.60

package/.eslintrc

@@ -2,7 +2,9 @@
     "root": true,
     "parser": "@typescript-eslint/parser",
     "plugins": [
-        "@typescript-eslint"
+        "@typescript-eslint",
+        "unused-imports",
+        "import"
     ],
     "extends": [
         "eslint:recommended",
@@ -10,6 +12,9 @@
         "plugin:@typescript-eslint/recommended"
     ],
     "rules": {
-        "no-multiple-empty-lines": [1, { "max": 1, "maxEOF": 0, "maxBOF": 0 }]
+        "@typescript-eslint/no-explicit-any": ["off"],
+        "no-multiple-empty-lines": [1, { "max": 1, "maxEOF": 0, "maxBOF": 0 }],
+        "unused-imports/no-unused-imports": "error",
+        "import/no-duplicates": ["error", {"considerQueryString": true, "prefer-inline": true}]
     }
 }

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,61 @@ 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))

package/lib/api/AnomaliesAPI.d.ts

@@ -0,0 +1,30 @@
+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.
+     * @param anomalieId
+     */
+    deleteAnomalie(anomalieId: string): Promise<AxiosResponse<void>>;
+    /**
+     * Détails d'une anomalie type DECI.
+     * @param anomalieId
+     */
+    getAnomalie(anomalieId: string): Promise<AxiosResponse<AnomalieDECI>>;
+    /**
+     * Liste des anomalies.
+     * @param page Numéro de page
+     * @param perPage Limite le nombre d'objets retournés. La limite est comprise entre 1 et 100, la valeur par défaut étant de 10.
+     * @param texte Filtre sur le texte de l'anomalie
+     */
+    paginateAnomalies(page?: number, perPage?: number, texte?: string): Collection<AnomalieDECI>;
+    /**
+     * Ajout d'une nouvelle anomalie DECI type pour une organisation.
+     * @param anomalieDECI
+     */
+    postAnomalie(anomalieDECI?: AnomalieDECI): Promise<AxiosResponse<AnomalieDECI>>;
+}

package/lib/api/AnomaliesAPI.js

@@ -0,0 +1,69 @@
+"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.
+     * @param anomalieId
+     */
+    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}'),
+            headers: {},
+            params: {},
+            body: utils_1.Utils.payloadFilter({})
+        });
+    }
+    /**
+     * Détails d'une anomalie type DECI.
+     * @param anomalieId
+     */
+    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}'),
+            headers: {},
+            params: {},
+            body: utils_1.Utils.payloadFilter({})
+        });
+    }
+    /**
+     * Liste des anomalies.
+     * @param page Numéro de page
+     * @param perPage Limite le nombre d'objets retournés. La limite est comprise entre 1 et 100, la valeur par défaut étant de 10.
+     * @param texte Filtre sur le texte de l'anomalie
+     */
+    paginateAnomalies(page, perPage, texte) {
+        const pathVariable = {};
+        return this.collect({
+            method: 'GET',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/anomalies'),
+            headers: {},
+            params: { 'page': page?.toString(), 'per_page': perPage?.toString(), 'texte': texte },
+            body: utils_1.Utils.payloadFilter({})
+        });
+    }
+    /**
+     * Ajout d'une nouvelle anomalie DECI type pour une organisation.
+     * @param anomalieDECI
+     */
+    async postAnomalie(anomalieDECI) {
+        const pathVariable = {};
+        return this.request({
+            method: 'POST',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/anomalies'),
+            headers: {},
+            params: {},
+            body: utils_1.Utils.payloadFilter({ 'code': anomalieDECI?.code, 'texte': anomalieDECI?.texte, 'indice_de_gravite': anomalieDECI?.indice_de_gravite })
+        });
+    }
+}
+exports.AnomaliesAPI = AnomaliesAPI;

package/lib/api/CommissionsAPI.d.ts

@@ -0,0 +1,68 @@
+import { Core, MetariscConfig } from "../core";
+import type { AxiosResponse } from "axios";
+import { Client } from "../client";
+import { Collection } from "../collection";
+import { Commission } from '../model/Commission';
+import { PassageCommission } from '../model/PassageCommission';
+import { PassageCommissionDossier } from '../model/PassageCommissionDossier';
+export declare class CommissionsAPI extends Core {
+    constructor(config: MetariscConfig, client?: Client);
+    /**
+     * Récupération des détails de la commission.
+     * @param commissionId
+     */
+    getCommission(commissionId: string): Promise<AxiosResponse<Commission>>;
+    /**
+     * Récupération d'une date de passage en commission.
+     * @param commissionId
+     * @param dateId
+     */
+    getCommissionDate(commissionId: string, dateId: string): Promise<AxiosResponse<PassageCommission>>;
+    /**
+     * Liste des commissions.
+     * @param page Numéro de page
+     * @param perPage Limite le nombre d'objets retournés. La limite est comprise entre 1 et 100, la valeur par défaut étant de 10.
+     */
+    paginateCommissions(page?: number, perPage?: number): Collection<Commission>;
+    /**
+     * Récupération de la liste des dates de passage de la commission.
+     * @param commissionId
+     * @param page Numéro de page
+     * @param perPage Limite le nombre d'objets retournés. La limite est comprise entre 1 et 100, la valeur par défaut étant de 10.
+     */
+    paginateCommissionDates(commissionId: string, page?: number, perPage?: number): Collection<PassageCommission>;
+    /**
+     * Mise à jour des détails d'un dossier lié à une date de passage en commission
+     * @param commissionId
+     * @param dateId
+     * @param dossierId
+     * @param passageCommissionDossier
+     */
+    updateCommissionDateDossier(commissionId: string, dateId: string, dossierId: string, passageCommissionDossier?: PassageCommissionDossier): Collection<PassageCommissionDossier>;
+    /**
+     * Récupération d'une liste de dossiers à l'ordre du jour liés à une date de passage en commission.
+     * @param commissionId
+     * @param dateId
+     * @param page Numéro de page
+     * @param perPage Limite le nombre d'objets retournés. La limite est comprise entre 1 et 100, la valeur par défaut étant de 10.
+     */
+    paginateCommissionDateDossiers(commissionId: string, dateId: string, page?: number, perPage?: number): Collection<PassageCommissionDossier>;
+    /**
+     * Ajoute une commission.
+     * @param commission
+     */
+    postCommission(commission?: Commission): Promise<AxiosResponse<Commission>>;
+    /**
+     * Ajout d'une date de passage en commission.
+     * @param commissionId
+     * @param passageCommission
+     */
+    postCommissionDate(commissionId: string, passageCommission?: PassageCommission): Promise<AxiosResponse<PassageCommission>>;
+    /**
+     * Ajout d'un dossier à l'ordre du jour d'un passage en commission.
+     * @param commissionId
+     * @param dateId
+     * @param passageCommissionDossier
+     */
+    postCommissionDateDossier(commissionId: string, dateId: string, passageCommissionDossier?: PassageCommissionDossier): Promise<AxiosResponse<PassageCommissionDossier>>;
+}

package/lib/api/CommissionsAPI.js

@@ -0,0 +1,150 @@
+"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.
+     * @param commissionId
+     */
+    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}'),
+            headers: {},
+            params: {},
+            body: utils_1.Utils.payloadFilter({})
+        });
+    }
+    /**
+     * Récupération d'une date de passage en commission.
+     * @param commissionId
+     * @param dateId
+     */
+    async getCommissionDate(commissionId, dateId) {
+        const pathVariable = { 'commission_id': (new String(commissionId)).toString(), 'date_id': (new String(dateId)).toString() };
+        return this.request({
+            method: 'GET',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions/{commission_id}/dates/{date_id}'),
+            headers: {},
+            params: {},
+            body: utils_1.Utils.payloadFilter({})
+        });
+    }
+    /**
+     * Liste des commissions.
+     * @param page Numéro de page
+     * @param perPage Limite le nombre d'objets retournés. La limite est comprise entre 1 et 100, la valeur par défaut étant de 10.
+     */
+    paginateCommissions(page, perPage) {
+        const pathVariable = {};
+        return this.collect({
+            method: 'GET',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions'),
+            headers: {},
+            params: { 'page': page?.toString(), 'per_page': perPage?.toString() },
+            body: utils_1.Utils.payloadFilter({})
+        });
+    }
+    /**
+     * Récupération de la liste des dates de passage de la commission.
+     * @param commissionId
+     * @param page Numéro de page
+     * @param perPage Limite le nombre d'objets retournés. La limite est comprise entre 1 et 100, la valeur par défaut étant de 10.
+     */
+    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'),
+            headers: {},
+            params: { 'page': page?.toString(), 'per_page': perPage?.toString() },
+            body: utils_1.Utils.payloadFilter({})
+        });
+    }
+    /**
+     * Mise à jour des détails d'un dossier lié à une date de passage en commission
+     * @param commissionId
+     * @param dateId
+     * @param dossierId
+     * @param passageCommissionDossier
+     */
+    updateCommissionDateDossier(commissionId, dateId, dossierId, passageCommissionDossier) {
+        const pathVariable = { 'commission_id': (new String(commissionId)).toString(), 'date_id': (new String(dateId)).toString(), 'dossier_id': (new String(dossierId)).toString() };
+        return this.collect({
+            method: 'POST',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions/{commission_id}/dates/{date_id}/ordre_du_jour/{dossier_id}'),
+            headers: {},
+            params: {},
+            body: utils_1.Utils.payloadFilter({ 'id': passageCommissionDossier?.id, 'dossier': passageCommissionDossier?.dossier, 'dossier_id': passageCommissionDossier?.dossier_id, 'avis': passageCommissionDossier?.avis, 'statut': passageCommissionDossier?.statut })
+        });
+    }
+    /**
+     * Récupération d'une liste de dossiers à l'ordre du jour liés à une date de passage en commission.
+     * @param commissionId
+     * @param dateId
+     * @param page Numéro de page
+     * @param perPage Limite le nombre d'objets retournés. La limite est comprise entre 1 et 100, la valeur par défaut étant de 10.
+     */
+    paginateCommissionDateDossiers(commissionId, dateId, page, perPage) {
+        const pathVariable = { 'commission_id': (new String(commissionId)).toString(), 'date_id': (new String(dateId)).toString() };
+        return this.collect({
+            method: 'GET',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions/{commission_id}/dates/{date_id}/ordre_du_jour'),
+            headers: {},
+            params: { 'page': page?.toString(), 'per_page': perPage?.toString() },
+            body: utils_1.Utils.payloadFilter({})
+        });
+    }
+    /**
+     * Ajoute une commission.
+     * @param commission
+     */
+    async postCommission(commission) {
+        const pathVariable = {};
+        return this.request({
+            method: 'POST',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions'),
+            headers: {},
+            params: {},
+            body: utils_1.Utils.payloadFilter({ 'id': commission?.id, 'type': commission?.type, 'libelle': commission?.libelle })
+        });
+    }
+    /**
+     * Ajout d'une date de passage en commission.
+     * @param commissionId
+     * @param passageCommission
+     */
+    async postCommissionDate(commissionId, passageCommission) {
+        const pathVariable = { 'commission_id': (new String(commissionId)).toString() };
+        return this.request({
+            method: 'POST',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions/{commission_id}/dates'),
+            headers: {},
+            params: {},
+            body: utils_1.Utils.payloadFilter({ 'id': passageCommission?.id, 'date_debut': passageCommission?.date_debut ? utils_1.Utils.formatDate(passageCommission?.date_debut) : undefined, 'date_fin': passageCommission?.date_fin ? utils_1.Utils.formatDate(passageCommission?.date_fin) : undefined, 'type': passageCommission?.type, 'libelle': passageCommission?.libelle })
+        });
+    }
+    /**
+     * Ajout d'un dossier à l'ordre du jour d'un passage en commission.
+     * @param commissionId
+     * @param dateId
+     * @param passageCommissionDossier
+     */
+    async postCommissionDateDossier(commissionId, dateId, passageCommissionDossier) {
+        const pathVariable = { 'commission_id': (new String(commissionId)).toString(), 'date_id': (new String(dateId)).toString() };
+        return this.request({
+            method: 'POST',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions/{commission_id}/dates/{date_id}/ordre_du_jour'),
+            headers: {},
+            params: {},
+            body: utils_1.Utils.payloadFilter({ 'id': passageCommissionDossier?.id, 'dossier': passageCommissionDossier?.dossier, 'dossier_id': passageCommissionDossier?.dossier_id, 'avis': passageCommissionDossier?.avis, 'statut': passageCommissionDossier?.statut })
+        });
+    }
+}
+exports.CommissionsAPI = CommissionsAPI;

package/lib/api/ContactsAPI.d.ts

@@ -0,0 +1,30 @@
+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.
+     * @param contactId
+     */
+    deleteContact(contactId: string): Promise<AxiosResponse<void>>;
+    /**
+     * Récupération d'une fiche contact.
+     * @param contactId
+     */
+    getContact(contactId: string): Promise<AxiosResponse<Contact>>;
+    /**
+     * Récupération de la liste des contacts.
+     * @param page Numéro de page
+     * @param perPage Limite le nombre d'objets retournés. La limite est comprise entre 1 et 100, la valeur par défaut étant de 10.
+     */
+    paginateContacts(page?: number, perPage?: number): Collection<Contact>;
+    /**
+     * Mise à jour d'une fiche contact existante.
+     * @param contactId
+     * @param contact
+     */
+    updateContact(contactId: string, contact?: Contact): Promise<AxiosResponse<Contact>>;
+}

package/lib/api/ContactsAPI.js

@@ -0,0 +1,69 @@
+"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.
+     * @param contactId
+     */
+    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}'),
+            headers: {},
+            params: {},
+            body: utils_1.Utils.payloadFilter({})
+        });
+    }
+    /**
+     * Récupération d'une fiche contact.
+     * @param contactId
+     */
+    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}'),
+            headers: {},
+            params: {},
+            body: utils_1.Utils.payloadFilter({})
+        });
+    }
+    /**
+     * Récupération de la liste des contacts.
+     * @param page Numéro de page
+     * @param perPage Limite le nombre d'objets retournés. La limite est comprise entre 1 et 100, la valeur par défaut étant de 10.
+     */
+    paginateContacts(page, perPage) {
+        const pathVariable = {};
+        return this.collect({
+            method: 'GET',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/contacts'),
+            headers: {},
+            params: { 'page': page?.toString(), 'per_page': perPage?.toString() },
+            body: utils_1.Utils.payloadFilter({})
+        });
+    }
+    /**
+     * Mise à jour d'une fiche contact existante.
+     * @param contactId
+     * @param contact
+     */
+    async updateContact(contactId, contact) {
+        const pathVariable = { 'contact_id': (new String(contactId)).toString() };
+        return this.request({
+            method: 'POST',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/contacts/{contact_id}'),
+            headers: {},
+            params: {},
+            body: utils_1.Utils.payloadFilter({ 'id': contact?.id, 'nom': contact?.nom, 'prenom': contact?.prenom, 'fonction': contact?.fonction, 'telephone_fixe': contact?.telephone_fixe, 'telephone_portable': contact?.telephone_portable, 'telephone_fax': contact?.telephone_fax, 'adresse': contact?.adresse, 'site_web_url': contact?.site_web_url, 'civilite': contact?.civilite, 'societe': contact?.societe, 'email': contact?.email, 'observations': contact?.observations })
+        });
+    }
+}
+exports.ContactsAPI = ContactsAPI;