@metarisc/metarisc-js 0.0.1-alpha.65 → 0.0.1-alpha.67

package/README.md

@@ -13,7 +13,7 @@ npm i @metarisc/metarisc-js
 Pour utiliser la librairie, il suffit de l'importer comme ceci :
 
 ```ts
-import { Metarisc } from '@metarisc/metarisc-js';
+import { Metarisc } from "@metarisc/metarisc-js";
 ```
 
 ## Utilisation
@@ -24,9 +24,9 @@ Pour effectuer une requête sur Metarisc, il faut tout d'adord initialisé le cl
 
 ```ts
 const m = new Metarisc({
-  metarisc_url: "https://api.metarisc.fr",
-  client_id: "CLIENT_ID",
-  client_secret: "CLIENT_SECRET"
+    metarisc_url: "https://api.metarisc.fr",
+    client_id: "CLIENT_ID",
+    client_secret: "CLIENT_SECRET"
 });
 
 m.dossiers.getDossier("123456");
@@ -69,4 +69,31 @@ Le type de retour d'une requête paginée est :
 AsyncGenerator<T>;
 ```
 
-(voir la documentation suivante [AsyncGenerator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/AsyncGenerator))
+(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/HealthcheckAPI.d.ts

@@ -0,0 +1,10 @@
+import { Core, MetariscConfig } from "../core";
+import type { AxiosResponse } from "axios";
+import { Client } from "../client";
+export declare class HealthcheckAPI extends Core {
+    constructor(config: MetariscConfig, client?: Client);
+    /**
+     * Assurez-vous que tous nos services sont opérationnels en effectuant des appels API vers le point de terminaison de contrôle d'intégrité. Ce point de terminaison exécute des contrôles d'intégrité et renvoie un état qui vous indique si le service Metarisc est fonctionnel ou non.
+     */
+    verify(): Promise<AxiosResponse<void>>;
+}

package/lib/api/HealthcheckAPI.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HealthcheckAPI = void 0;
+const core_1 = require("../core");
+const utils_1 = require("../utils");
+class HealthcheckAPI extends core_1.Core {
+    constructor(config, client) {
+        super(config, client);
+    }
+    /**
+     * Assurez-vous que tous nos services sont opérationnels en effectuant des appels API vers le point de terminaison de contrôle d'intégrité. Ce point de terminaison exécute des contrôles d'intégrité et renvoie un état qui vous indique si le service Metarisc est fonctionnel ou non.
+     */
+    async verify() {
+        const pathVariable = {};
+        return this.request({
+            method: 'GET',
+            endpoint: utils_1.Utils.constructPath(pathVariable, '/healthcheck'),
+            params: {},
+            body: utils_1.Utils.payloadFilter({})
+        });
+    }
+}
+exports.HealthcheckAPI = HealthcheckAPI;

package/lib/core.d.ts

@@ -29,8 +29,11 @@ export interface OAuth2Options {
 export declare class Core {
     protected client: Client;
     protected config: MetariscConfig;
+    protected requestEvent: EventTarget;
     constructor(config: MetariscConfig, client?: Client);
     request<T>(config: RequestConfig): Promise<AxiosResponse<T>>;
+    protected emit(eventName: EventEnum, payload: unknown): void;
+    on(eventName: EventEnum, callback: (event: Event) => void): void;
     collect<T>(config: RequestConfig): Collection<T>;
     authenticate(auth_method: AuthMethod, options: OAuth2Options): Promise<GrantResponse>;
     refreshToken(): Promise<RefreshResponse>;
@@ -38,4 +41,7 @@ export declare class Core {
     setRefreshToken(refresh_token: string): void;
     setActiveOrganisation(orgId: string): void;
 }
+export declare enum EventEnum {
+    request = "request"
+}
 export {};

package/lib/core.js

@@ -1,16 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Core = void 0;
+exports.EventEnum = exports.Core = void 0;
 const client_1 = require("./client");
 const collection_1 = require("./collection");
 class Core {
     constructor(config, client) {
+        this.requestEvent = new EventTarget();
         this.config = config;
         this.client = client ?? new client_1.Client(config);
     }
     async request(config) {
+        this.emit(EventEnum.request, config);
         return this.client.request(config);
     }
+    emit(eventName, payload) {
+        this.requestEvent.dispatchEvent(new CustomEvent(eventName, { detail: payload }));
+    }
+    on(eventName, callback) {
+        this.requestEvent.addEventListener(eventName, callback);
+    }
     collect(config) {
         return new collection_1.Collection(this, {
             endpoint: config.endpoint || "/",
@@ -35,3 +43,7 @@ class Core {
     }
 }
 exports.Core = Core;
+var EventEnum;
+(function (EventEnum) {
+    EventEnum["request"] = "request";
+})(EventEnum = exports.EventEnum || (exports.EventEnum = {}));

package/lib/index.d.ts

@@ -16,6 +16,7 @@ export { DossiersAPI } from './api/DossiersAPI';
 export { ERPAPI } from './api/ERPAPI';
 export { EvenementsAPI } from './api/EvenementsAPI';
 export { FeedAPI } from './api/FeedAPI';
+export { HealthcheckAPI } from './api/HealthcheckAPI';
 export { MoiAPI } from './api/MoiAPI';
 export { NotificationsAPI } from './api/NotificationsAPI';
 export { OrdresDuJourAPI } from './api/OrdresDuJourAPI';

package/lib/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WorkflowsAPI = exports.UtilisateursAPI = exports.TournesDECIAPI = exports.PrescriptionsAPI = exports.PingAPI = exports.PEIAPI = exports.OrganisationsAPI = exports.OrdresDuJourAPI = exports.NotificationsAPI = exports.MoiAPI = exports.FeedAPI = exports.EvenementsAPI = exports.ERPAPI = exports.DossiersAPI = exports.DocumentsAPI = exports.DatesPassageCommissionAPI = exports.ControlesPeiAPI = exports.ContactsAPI = exports.CommissionsAPI = exports.AnomaliesAPI = exports.Tus = exports.Utils = exports.Client = exports.AuthMethod = exports.Collection = exports.Core = exports.SessionExpiredError = exports.OAuth2 = exports.Metarisc = void 0;
+exports.WorkflowsAPI = exports.UtilisateursAPI = exports.TournesDECIAPI = exports.PrescriptionsAPI = exports.PingAPI = exports.PEIAPI = exports.OrganisationsAPI = exports.OrdresDuJourAPI = exports.NotificationsAPI = exports.MoiAPI = exports.HealthcheckAPI = exports.FeedAPI = exports.EvenementsAPI = exports.ERPAPI = exports.DossiersAPI = exports.DocumentsAPI = exports.DatesPassageCommissionAPI = exports.ControlesPeiAPI = exports.ContactsAPI = exports.CommissionsAPI = exports.AnomaliesAPI = exports.Tus = exports.Utils = exports.Client = exports.AuthMethod = exports.Collection = exports.Core = exports.SessionExpiredError = exports.OAuth2 = exports.Metarisc = void 0;
 var metarisc_1 = require("./metarisc");
 Object.defineProperty(exports, "Metarisc", { enumerable: true, get: function () { return metarisc_1.Metarisc; } });
 var oauth2_1 = require("./auth/oauth2");
@@ -38,6 +38,8 @@ var EvenementsAPI_1 = require("./api/EvenementsAPI");
 Object.defineProperty(exports, "EvenementsAPI", { enumerable: true, get: function () { return EvenementsAPI_1.EvenementsAPI; } });
 var FeedAPI_1 = require("./api/FeedAPI");
 Object.defineProperty(exports, "FeedAPI", { enumerable: true, get: function () { return FeedAPI_1.FeedAPI; } });
+var HealthcheckAPI_1 = require("./api/HealthcheckAPI");
+Object.defineProperty(exports, "HealthcheckAPI", { enumerable: true, get: function () { return HealthcheckAPI_1.HealthcheckAPI; } });
 var MoiAPI_1 = require("./api/MoiAPI");
 Object.defineProperty(exports, "MoiAPI", { enumerable: true, get: function () { return MoiAPI_1.MoiAPI; } });
 var NotificationsAPI_1 = require("./api/NotificationsAPI");

package/lib/metarisc.d.ts

@@ -11,6 +11,7 @@ import { DossiersAPI } from './api/DossiersAPI';
 import { ERPAPI } from './api/ERPAPI';
 import { EvenementsAPI } from './api/EvenementsAPI';
 import { FeedAPI } from './api/FeedAPI';
+import { HealthcheckAPI } from './api/HealthcheckAPI';
 import { MoiAPI } from './api/MoiAPI';
 import { NotificationsAPI } from './api/NotificationsAPI';
 import { OrdresDuJourAPI } from './api/OrdresDuJourAPI';
@@ -33,6 +34,7 @@ export declare class Metarisc extends Core {
     anomalies?: AnomaliesAPI;
     supports_reglementaires?: PrescriptionsAPI;
     feed?: FeedAPI;
+    healthcheck?: HealthcheckAPI;
     tournees_deci?: TournesDECIAPI;
     organisations?: OrganisationsAPI;
     pei?: PEIAPI;

package/lib/metarisc.js

@@ -13,6 +13,7 @@ const DossiersAPI_1 = require("./api/DossiersAPI");
 const ERPAPI_1 = require("./api/ERPAPI");
 const EvenementsAPI_1 = require("./api/EvenementsAPI");
 const FeedAPI_1 = require("./api/FeedAPI");
+const HealthcheckAPI_1 = require("./api/HealthcheckAPI");
 const MoiAPI_1 = require("./api/MoiAPI");
 const NotificationsAPI_1 = require("./api/NotificationsAPI");
 const OrdresDuJourAPI_1 = require("./api/OrdresDuJourAPI");
@@ -52,6 +53,8 @@ class Metarisc extends core_1.Core {
                         return new PrescriptionsAPI_1.PrescriptionsAPI(config, tmpClient);
                     case 'feed':
                         return new FeedAPI_1.FeedAPI(config, tmpClient);
+                    case 'healthcheck':
+                        return new HealthcheckAPI_1.HealthcheckAPI(config, tmpClient);
                     case 'tournees_deci':
                         return new TournesDECIAPI_1.TournesDECIAPI(config, tmpClient);
                     case 'organisations':

package/package.json

@@ -2,7 +2,7 @@
   "name": "@metarisc/metarisc-js",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
-  "version": "0.0.1-alpha.65",
+  "version": "0.0.1-alpha.67",
   "scripts": {
     "lint": "eslint . --ext .ts --fix",
     "compile": "tsc",

package/src/api/HealthcheckAPI.ts

@@ -0,0 +1,25 @@
+import { Core, MetariscConfig } from "../core";
+import { Utils } from "../utils";
+import type { AxiosResponse } from "axios";
+import { Client } from "../client";
+
+export class HealthcheckAPI extends Core {
+    constructor(config: MetariscConfig, client?: Client) {
+        super(config, client);
+    }
+    
+    /**
+     * Assurez-vous que tous nos services sont opérationnels en effectuant des appels API vers le point de terminaison de contrôle d'intégrité. Ce point de terminaison exécute des contrôles d'intégrité et renvoie un état qui vous indique si le service Metarisc est fonctionnel ou non.
+     */
+    async verify(): Promise<AxiosResponse<void>>
+    {
+        const pathVariable = { };
+        return this.request({
+            method: 'GET',
+            endpoint: Utils.constructPath(pathVariable, '/healthcheck'),
+            params: { },
+            body: Utils.payloadFilter({})
+        });
+    }
+    
+}

package/src/core.ts

@@ -29,6 +29,7 @@ export interface OAuth2Options {
 export class Core {
     protected client: Client;
     protected config: MetariscConfig;
+    protected requestEvent = new EventTarget();
 
     constructor(config: MetariscConfig, client?: Client) {
         this.config = config;
@@ -36,9 +37,20 @@ export class Core {
     }
 
     async request<T>(config: RequestConfig): Promise<AxiosResponse<T>> {
+        this.emit(EventEnum.request, config);
         return this.client.request<T>(config);
     }
 
+    protected emit(eventName: EventEnum, payload: unknown) {
+        this.requestEvent.dispatchEvent(
+            new CustomEvent(eventName, { detail: payload })
+        );
+    }
+
+    on(eventName: EventEnum, callback: (event: Event) => void): void {
+        this.requestEvent.addEventListener(eventName, callback);
+    }
+
     collect<T>(config: RequestConfig): Collection<T> {
         return new Collection<T>(this, {
             endpoint: config.endpoint || "/",
@@ -70,3 +82,7 @@ export class Core {
         this.client.setActiveOrganisation(orgId);
     }
 }
+
+export enum EventEnum {
+    request = "request"
+}

package/src/index.ts

@@ -27,6 +27,8 @@ export { EvenementsAPI } from './api/EvenementsAPI';
 
 export { FeedAPI } from './api/FeedAPI';
 
+export { HealthcheckAPI } from './api/HealthcheckAPI';
+
 export { MoiAPI } from './api/MoiAPI';
 
 export { NotificationsAPI } from './api/NotificationsAPI';

package/src/metarisc.ts

@@ -22,6 +22,8 @@ import { EvenementsAPI } from './api/EvenementsAPI';
 
 import { FeedAPI } from './api/FeedAPI';
 
+import { HealthcheckAPI } from './api/HealthcheckAPI';
+
 import { MoiAPI } from './api/MoiAPI';
 
 import { NotificationsAPI } from './api/NotificationsAPI';
@@ -67,6 +69,8 @@ export class Metarisc extends Core
     
     public feed?: FeedAPI;
     
+    public healthcheck?: HealthcheckAPI;
+    
     public tournees_deci?: TournesDECIAPI;
     
     public organisations?: OrganisationsAPI;
@@ -131,6 +135,9 @@ export class Metarisc extends Core
                     case 'feed':
                         return new FeedAPI(config, tmpClient);
                     
+                    case 'healthcheck':
+                        return new HealthcheckAPI(config, tmpClient);
+                    
                     case 'tournees_deci':
                         return new TournesDECIAPI(config, tmpClient);