@metarisc/metarisc-js 0.0.1-alpha.5 → 0.0.1-alpha.51

package/.eslintrc

@@ -2,11 +2,19 @@
     "root": true,
     "parser": "@typescript-eslint/parser",
     "plugins": [
-        "@typescript-eslint"
+        "@typescript-eslint",
+        "unused-imports",
+        "import"
     ],
     "extends": [
         "eslint:recommended",
         "plugin:@typescript-eslint/eslint-recommended",
         "plugin:@typescript-eslint/recommended"
-    ]
+    ],
+    "rules": {
+        "@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: npm run lint
-      
-      - 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,3 +1,72 @@
 # 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.
+
+## NPM
+
+Vous pouvez installer la librairie en utilisant [NPM](https://www.npmjs.com). Exécutez la commande suivante dans votre projet :
+
+```bash
+npm i @metarisc/metarisc-js
+```
+
+Pour utiliser la librairie, il suffit de l'importer comme ceci :
+
+```ts
+import { Metarisc } from '@metarisc/metarisc-js';
+```
+
+## Utilisation
+
+### Requêtes
+
+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.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.
+     * @param anomalieId Identifiant unique de l'anomalie
+     */
+    deleteAnomalie(anomalieId: string): Promise<AxiosResponse<void>>;
+    /**
+     * Détails d'une anomalie.
+     * @param anomalieId Identifiant unique de l'anomalie
+     */
+    getAnomalie(anomalieId: string): Promise<AxiosResponse<AnomalieDECI>>;
+    /**
+     * Liste des anomalies.
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     * @param texte Filtre sur le texte
+     */
+    paginateAnomalies(page?: number, perPage?: number, texte?: string): Collection<AnomalieDECI>;
+    /**
+     * Ajout d'une nouvelle anomalie.
+     * @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.
+     * @param anomalieId Identifiant unique de l'anomalie
+     */
+    async deleteAnomalie(anomalieId) {
+        const pathVariable = { 'anomalie_id': anomalieId };
+        return this.request({
+            method: 'DELETE',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/anomalies/{anomalie_id}'),
+            headers: {},
+            params: {},
+            body: {}
+        });
+    }
+    /**
+     * Détails d'une anomalie.
+     * @param anomalieId Identifiant unique de l'anomalie
+     */
+    async getAnomalie(anomalieId) {
+        const pathVariable = { 'anomalie_id': anomalieId };
+        return this.request({
+            method: 'GET',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/anomalies/{anomalie_id}'),
+            headers: {},
+            params: {},
+            body: {}
+        });
+    }
+    /**
+     * Liste des anomalies.
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     * @param texte Filtre sur le texte
+     */
+    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: {}
+        });
+    }
+    /**
+     * Ajout d'une nouvelle anomalie.
+     * @param anomalieDECI
+     */
+    async postAnomalie(anomalieDECI) {
+        const pathVariable = {};
+        return this.request({
+            method: 'POST',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/anomalies'),
+            headers: {},
+            params: {},
+            body: { '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';
+import { PostCommissionDateDossierRequest } from '../model/PostCommissionDateDossierRequest';
+import { PostCommissionDateRequest } from '../model/PostCommissionDateRequest';
+import { PostCommissionRequest } from '../model/PostCommissionRequest';
+export declare class CommissionsAPI extends Core {
+    constructor(config: MetariscConfig, client?: Client);
+    /**
+     * Suppression d'une commission.
+     * @param commissionId Identifiant unique de la commission
+     */
+    deleteCommission(commissionId: string): Promise<AxiosResponse<void>>;
+    /**
+     * Récupération des détails de la commission.
+     * @param commissionId Identifiant unique de la commission
+     */
+    getCommission(commissionId: string): Promise<AxiosResponse<Commission>>;
+    /**
+     * Récupération d'une date de passage en commission.
+     * @param commissionId Identifiant unique de la commission
+     * @param dateId Identifiant unique du passage en commission
+     */
+    getCommissionDate(commissionId: string, dateId: string): Promise<AxiosResponse<PassageCommission>>;
+    /**
+     * Récupération d'une liste de dossiers à l'ordre du jour liés à une date de passage en commission.
+     * @param commissionId Identifiant unique de la commission
+     * @param dateId Identifiant unique du passage en commission
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginateCommissionDateDossiers(commissionId: string, dateId: string, page?: number, perPage?: number): Collection<PassageCommissionDossier>;
+    /**
+     * Récupération de la liste des dates de passage de la commission.
+     * @param commissionId Identifiant unique de la commission
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginateCommissionDates(commissionId: string, page?: number, perPage?: number): Collection<PassageCommission>;
+    /**
+     * Liste des commissions.
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginateCommissions(page?: number, perPage?: number): Collection<Commission>;
+    /**
+     * Ajoute une commission.
+     * @param postCommissionRequest
+     */
+    postCommission(postCommissionRequest?: PostCommissionRequest): Promise<AxiosResponse<Commission>>;
+    /**
+     * Ajout d'une date de passage en commission.
+     * @param commissionId Identifiant unique de la commission
+     * @param postCommissionDateRequest
+     */
+    postCommissionDate(commissionId: string, postCommissionDateRequest?: PostCommissionDateRequest): Promise<AxiosResponse<PassageCommission>>;
+    /**
+     * Ajout d'un dossier à l'ordre du jour d'un passage en commission.
+     * @param commissionId Identifiant unique de la commission
+     * @param dateId Identifiant unique du passage en commission
+     * @param postCommissionDateDossierRequest
+     */
+    postCommissionDateDossier(commissionId: string, dateId: string, postCommissionDateDossierRequest?: PostCommissionDateDossierRequest): Promise<AxiosResponse<PassageCommissionDossier>>;
+}

package/lib/api/CommissionsAPI.js

@@ -0,0 +1,147 @@
+"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);
+    }
+    /**
+     * Suppression d'une commission.
+     * @param commissionId Identifiant unique de la commission
+     */
+    async deleteCommission(commissionId) {
+        const pathVariable = { 'commission_id': commissionId };
+        return this.request({
+            method: 'DELETE',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions/{commission_id}'),
+            headers: {},
+            params: {},
+            body: {}
+        });
+    }
+    /**
+     * Récupération des détails de la commission.
+     * @param commissionId Identifiant unique de la commission
+     */
+    async getCommission(commissionId) {
+        const pathVariable = { 'commission_id': commissionId };
+        return this.request({
+            method: 'GET',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions/{commission_id}'),
+            headers: {},
+            params: {},
+            body: {}
+        });
+    }
+    /**
+     * Récupération d'une date de passage en commission.
+     * @param commissionId Identifiant unique de la commission
+     * @param dateId Identifiant unique du passage en commission
+     */
+    async getCommissionDate(commissionId, dateId) {
+        const pathVariable = { 'commission_id': commissionId, 'date_id': dateId };
+        return this.request({
+            method: 'GET',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions/{commission_id}/dates/{date_id}'),
+            headers: {},
+            params: {},
+            body: {}
+        });
+    }
+    /**
+     * Récupération d'une liste de dossiers à l'ordre du jour liés à une date de passage en commission.
+     * @param commissionId Identifiant unique de la commission
+     * @param dateId Identifiant unique du passage en commission
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginateCommissionDateDossiers(commissionId, dateId, page, perPage) {
+        const pathVariable = { 'commission_id': commissionId, 'date_id': dateId };
+        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: {}
+        });
+    }
+    /**
+     * Récupération de la liste des dates de passage de la commission.
+     * @param commissionId Identifiant unique de la commission
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginateCommissionDates(commissionId, page, perPage) {
+        const pathVariable = { 'commission_id': commissionId };
+        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: {}
+        });
+    }
+    /**
+     * Liste des commissions.
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    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: {}
+        });
+    }
+    /**
+     * Ajoute une commission.
+     * @param postCommissionRequest
+     */
+    async postCommission(postCommissionRequest) {
+        const pathVariable = {};
+        return this.request({
+            method: 'POST',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions'),
+            headers: {},
+            params: {},
+            body: { 'type': postCommissionRequest?.type, 'libelle': postCommissionRequest?.libelle }
+        });
+    }
+    /**
+     * Ajout d'une date de passage en commission.
+     * @param commissionId Identifiant unique de la commission
+     * @param postCommissionDateRequest
+     */
+    async postCommissionDate(commissionId, postCommissionDateRequest) {
+        const pathVariable = { 'commission_id': commissionId };
+        return this.request({
+            method: 'POST',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions/{commission_id}/dates'),
+            headers: {},
+            params: {},
+            body: { 'libelle': postCommissionDateRequest?.libelle, 'type': postCommissionDateRequest?.type, 'date_de_debut': postCommissionDateRequest?.date_de_debut, 'date_de_fin': postCommissionDateRequest?.date_de_fin }
+        });
+    }
+    /**
+     * Ajout d'un dossier à l'ordre du jour d'un passage en commission.
+     * @param commissionId Identifiant unique de la commission
+     * @param dateId Identifiant unique du passage en commission
+     * @param postCommissionDateDossierRequest
+     */
+    async postCommissionDateDossier(commissionId, dateId, postCommissionDateDossierRequest) {
+        const pathVariable = { 'commission_id': commissionId, 'date_id': dateId };
+        return this.request({
+            method: 'POST',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/commissions/{commission_id}/dates/{date_id}/ordre_du_jour'),
+            headers: {},
+            params: {},
+            body: { 'dossier_id': postCommissionDateDossierRequest?.dossier_id }
+        });
+    }
+}
+exports.CommissionsAPI = CommissionsAPI;

package/lib/api/DossiersAPI.d.ts

@@ -0,0 +1,84 @@
+import { Core, MetariscConfig } from "../core";
+import type { AxiosResponse } from "axios";
+import { Client } from "../client";
+import { Collection } from "../collection";
+import { Dossier } from '../model/Dossier';
+import { PostDossierRequest } from '../model/PostDossierRequest';
+import { UpdateDossierWorkflowsDetailsRequest } from '../model/UpdateDossierWorkflowsDetailsRequest';
+import { Workflow } from '../model/Workflow';
+import { Tag } from '../model/Tag';
+import { PieceJointe } from '../model/PieceJointe';
+export declare class DossiersAPI extends Core {
+    constructor(config: MetariscConfig, client?: Client);
+    /**
+     * Récupération de l'ensemble des données d'un dossier.
+     * @param dossierId Identifiant unique du Dossier
+     */
+    getDossier(dossierId: string): Promise<AxiosResponse<Dossier>>;
+    /**
+     * Récupération des détails d'un workflow.
+     * @param dossierId Identifiant unique du Dossier
+     * @param workflowId Identifiant unique du Workflow
+     */
+    getDossierWorkflowsDetails(dossierId: string, workflowId: string): Promise<AxiosResponse<Workflow>>;
+    /**
+     * Récupération de la liste des contacts d'un dossier.
+     * @param dossierId Identifiant unique du Dossier
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginateDossierContacts(dossierId: string, page?: number, perPage?: number): Collection<Workflow>;
+    /**
+     * Récupération de la liste des documents d'un dossier.
+     * @param dossierId Identifiant unique du Dossier
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginateDossierDocuments(dossierId: string, page?: number, perPage?: number): Collection<Workflow>;
+    /**
+     * Récupération de la liste des tags d'un dossier.
+     * @param dossierId Identifiant unique du Dossier
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginateDossierTags(dossierId: string, page?: number, perPage?: number): Collection<Tag>;
+    /**
+     * Liste des documents liés à un workflow.
+     * @param dossierId Identifiant unique du Dossier
+     * @param workflowId Identifiant unique du Workflow
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginateDossierWorkflowDocuments(dossierId: string, workflowId: string, page?: number, perPage?: number): Collection<PieceJointe>;
+    /**
+     * Récupération de la liste des workflows d'un dossier.
+     * @param dossierId Identifiant unique du Dossier
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginateDossierWorkflows(dossierId: string, page?: number, perPage?: number): Collection<Workflow>;
+    /**
+     * Récupération de la liste des dossiers selon des critères de recherche.
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginateDossiers(page?: number, perPage?: number): Collection<Dossier>;
+    /**
+     * TODO : Modification d'un dossier existant.
+     * @param dossierId Identifiant unique du Dossier
+     * @param dossier
+     */
+    patchDossier(dossierId: string, dossier?: Dossier): Promise<AxiosResponse<Dossier>>;
+    /**
+     * Création d'un nouveau dossier.
+     * @param postDossierRequest
+     */
+    postDossier(postDossierRequest?: PostDossierRequest): Promise<AxiosResponse<Dossier>>;
+    /**
+     * Mise à jour d'un workflow.
+     * @param dossierId Identifiant unique du Dossier
+     * @param workflowId Identifiant unique du Workflow
+     * @param updateDossierWorkflowsDetailsRequest
+     */
+    updateDossierWorkflowsDetails(dossierId: string, workflowId: string, updateDossierWorkflowsDetailsRequest?: UpdateDossierWorkflowsDetailsRequest): Promise<AxiosResponse<Workflow>>;
+}