@metarisc/metarisc-js 0.0.1-alpha.27 → 0.0.1-alpha.29

package/lib/collection.d.ts

@@ -37,6 +37,6 @@ export declare class Collection<T> {
     /**
      * Generates an array with all results set.
      */
-    autoPagingIteratorToArray(): Promise<Array<T>>;
+    autoPagingIteratorToArray(limit?: number): Promise<Array<T>>;
 }
 export {};

package/lib/collection.js

@@ -24,8 +24,8 @@ class Collection {
      * Generates an iterator to automatically iterate over all pages in a result set.
      */
     async *autoPagingIterator() {
-        let current_page = this.config.params && 'page' in this.config.params ? parseInt(this.config.params['page'].toString()) : 1;
-        const per_page = this.config.params && 'per_page' in this.config.params ? parseInt(this.config.params['per_page'].toString()) : 100;
+        let current_page = this.config.params && 'page' in this.config.params && this.config.params['page'] !== undefined ? parseInt(this.config.params['page'].toString()) : 1;
+        const per_page = this.config.params && 'per_page' in this.config.params && this.config.params['per_page'] !== undefined ? parseInt(this.config.params['per_page'].toString()) : 100;
         while (true) {
             const response = await this.fetchPage(current_page, per_page);
             for (const element of response.data.data) {
@@ -40,11 +40,18 @@ class Collection {
     /**
      * Generates an array with all results set.
      */
-    async autoPagingIteratorToArray() {
+    async autoPagingIteratorToArray(limit) {
         const generator = this.autoPagingIterator();
         const results = [];
+        limit = limit ?? 10000;
+        if (limit > 10000) {
+            throw Error('You cannot specify a limit of more than 10,000 items to fetch in `autoPagingIteratorToArray`; use `autoPagingIterator` to iterate through longer lists.');
+        }
         for await (const item of generator) {
             results.push(item);
+            if (results.length >= limit) {
+                break;
+            }
         }
         return results;
     }

package/lib/model/AdressePostale.d.ts

@@ -7,4 +7,6 @@ export type AdressePostale = {
     'voie'?: string;
     'code_insee'?: string;
     'arrondissement'?: string;
+    'latitude'?: number;
+    'longitude'?: number;
 };

package/lib/model/Contact.d.ts

@@ -3,7 +3,9 @@ export type Contact = {
     'nom'?: string;
     'prenom'?: string;
     'fonction'?: string;
-    'telephone'?: string;
+    'telephone_fixe'?: string;
+    'telephone_portable'?: string;
+    'telephone_fax'?: string;
     'adresse'?: string;
     'site_web_url'?: string;
     'civilite'?: string;

package/lib/model/DescriptifTechniqueDECIBase.d.ts

@@ -6,7 +6,13 @@ export type DescriptifTechniqueDECIBase = {
     'est_reglementaire'?: boolean;
     'domanialite'?: DomanialiteEnum;
     'est_conforme_rddeci'?: boolean;
+    /**
+    * - Performance nulle = 0 - Performance restreinte = 1 - Performance bonne = 2 - Performance inconnue = -1
+    */
     'performance_theorique'?: number;
+    /**
+    * - Performance nulle = 0 - Performance restreinte = 1 - Performance bonne = 2 - Performance inconnue = -1
+    */
     'performance_reelle'?: number;
     'observations_generales'?: string;
     'date'?: Date;

package/lib/model/DescriptifTechniquePIBI.d.ts

@@ -1,6 +1,5 @@
 import { DescriptifTechniqueDECIBase } from '../model/DescriptifTechniqueDECIBase';
 export type DescriptifTechniquePIBI = DescriptifTechniqueDECIBase & {
-    'numero_serie_appareil'?: string;
     /**
     * Surpression mesurée en bar
     */

package/lib/model/PEI.d.ts

@@ -11,26 +11,9 @@ export type PEI = {
     'genre'?: GenreEnum;
     'numero'?: string;
     'numero_compteur'?: string;
+    'numero_serie_appareil'?: string;
 };
 export declare enum GenreEnum {
-    Pi1x65 = "PI1x65",
-    Pi1x65Pi2x45 = "PI1x65+PI2x45",
-    Pi1x100 = "PI1x100",
-    Pi2x100 = "PI2x100",
-    Bi1x65 = "BI1x65",
-    Bi1x80 = "BI1x80",
-    Bi1x100 = "BI1x100",
-    Bi2x100 = "BI2x100",
-    PointAspiration = "POINT_ASPIRATION",
-    CiterneAerienne = "CITERNE_AERIENNE",
-    CiterneEnterree = "CITERNE_ENTERREE",
-    CiterneSemiEnterree = "CITERNE_SEMI_ENTERREE",
-    CiterneSouple = "CITERNE_SOUPLE",
-    ReserveAerienne = "RESERVE_AERIENNE",
-    PoteauRelais = "POTEAU_RELAIS",
-    PuisardAspiration = "PUISARD_ASPIRATION",
-    PriseDeportee = "PRISE_DEPORTEE",
-    PoteauAspiration1x100 = "POTEAU_ASPIRATION_1x100",
-    PoteauAspiration2x100 = "POTEAU_ASPIRATION_2x100",
-    BoucheAspiration1x100 = "BOUCHE_ASPIRATION_1x100"
+    Pibi = "PIBI",
+    Pena = "PENA"
 }

package/lib/model/PEI.js

@@ -3,24 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.GenreEnum = void 0;
 var GenreEnum;
 (function (GenreEnum) {
-    GenreEnum["Pi1x65"] = "PI1x65";
-    GenreEnum["Pi1x65Pi2x45"] = "PI1x65+PI2x45";
-    GenreEnum["Pi1x100"] = "PI1x100";
-    GenreEnum["Pi2x100"] = "PI2x100";
-    GenreEnum["Bi1x65"] = "BI1x65";
-    GenreEnum["Bi1x80"] = "BI1x80";
-    GenreEnum["Bi1x100"] = "BI1x100";
-    GenreEnum["Bi2x100"] = "BI2x100";
-    GenreEnum["PointAspiration"] = "POINT_ASPIRATION";
-    GenreEnum["CiterneAerienne"] = "CITERNE_AERIENNE";
-    GenreEnum["CiterneEnterree"] = "CITERNE_ENTERREE";
-    GenreEnum["CiterneSemiEnterree"] = "CITERNE_SEMI_ENTERREE";
-    GenreEnum["CiterneSouple"] = "CITERNE_SOUPLE";
-    GenreEnum["ReserveAerienne"] = "RESERVE_AERIENNE";
-    GenreEnum["PoteauRelais"] = "POTEAU_RELAIS";
-    GenreEnum["PuisardAspiration"] = "PUISARD_ASPIRATION";
-    GenreEnum["PriseDeportee"] = "PRISE_DEPORTEE";
-    GenreEnum["PoteauAspiration1x100"] = "POTEAU_ASPIRATION_1x100";
-    GenreEnum["PoteauAspiration2x100"] = "POTEAU_ASPIRATION_2x100";
-    GenreEnum["BoucheAspiration1x100"] = "BOUCHE_ASPIRATION_1x100";
+    GenreEnum["Pibi"] = "PIBI";
+    GenreEnum["Pena"] = "PENA";
 })(GenreEnum = exports.GenreEnum || (exports.GenreEnum = {}));

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.27",
+  "version": "0.0.1-alpha.29",
   "scripts": {
     "lint": "eslint . --ext .ts --fix",
     "compile": "tsc",

package/src/collection.ts

@@ -50,8 +50,8 @@ export class Collection<T>
      */
     async * autoPagingIterator() : AsyncGenerator<T, void, unknown>
     {
-        let current_page : number = this.config.params && 'page' in this.config.params ? parseInt(this.config.params['page'].toString()) : 1;
-        const per_page : number = this.config.params && 'per_page' in  this.config.params ? parseInt(this.config.params['per_page'].toString()) : 100;
+        let current_page : number = this.config.params && 'page' in this.config.params && this.config.params['page'] !== undefined ? parseInt(this.config.params['page'].toString()) : 1;
+        const per_page : number = this.config.params && 'per_page' in  this.config.params && this.config.params['per_page'] !== undefined ? parseInt(this.config.params['per_page'].toString()) : 100;
 
         while (true) {
             const response = <AxiosResponse<PaginationResults<T>>> await this.fetchPage(current_page, per_page);
@@ -71,13 +71,24 @@ export class Collection<T>
     /**
      * Generates an array with all results set.
      */
-    async autoPagingIteratorToArray() : Promise<Array<T>>
+    async autoPagingIteratorToArray(limit?: number) : Promise<Array<T>>
     {
         const generator = this.autoPagingIterator();
         const results = [];
+        
+        limit = limit ?? 10000;
+
+        if (limit > 10000) {
+            throw Error(
+                'You cannot specify a limit of more than 10,000 items to fetch in `autoPagingIteratorToArray`; use `autoPagingIterator` to iterate through longer lists.'
+            );
+        }
 
         for await (const item of generator) {
             results.push(item);
+            if (results.length >= limit) {
+                break;
+            }
         }
 
         return results;

package/src/model/AdressePostale.ts

@@ -7,4 +7,6 @@ export type AdressePostale = {
     'voie'?: string;
     'code_insee'?: string;
     'arrondissement'?: string;
+    'latitude'?: number;
+    'longitude'?: number;
 };

package/src/model/Contact.ts

@@ -3,7 +3,9 @@ export type Contact = {
     'nom'?: string;
     'prenom'?: string;
     'fonction'?: string;
-    'telephone'?: string;
+    'telephone_fixe'?: string;
+    'telephone_portable'?: string;
+    'telephone_fax'?: string;
     'adresse'?: string;
     'site_web_url'?: string;
     'civilite'?: string;

package/src/model/DescriptifTechniqueDECIBase.ts

@@ -7,7 +7,13 @@ export type DescriptifTechniqueDECIBase = {
     'est_reglementaire'?: boolean;
     'domanialite'?: DomanialiteEnum;
     'est_conforme_rddeci'?: boolean;
+    /**
+    * - Performance nulle = 0 - Performance restreinte = 1 - Performance bonne = 2 - Performance inconnue = -1
+    */
     'performance_theorique'?: number;
+    /**
+    * - Performance nulle = 0 - Performance restreinte = 1 - Performance bonne = 2 - Performance inconnue = -1
+    */
     'performance_reelle'?: number;
     'observations_generales'?: string;
     'date'?: Date;

package/src/model/DescriptifTechniquePIBI.ts

@@ -1,7 +1,6 @@
 import { DescriptifTechniqueDECIBase } from '../model/DescriptifTechniqueDECIBase';
 
 export type DescriptifTechniquePIBI = DescriptifTechniqueDECIBase & { 
-    'numero_serie_appareil'?: string;
     /**
     * Surpression mesurée en bar
     */

package/src/model/PEI.ts

@@ -12,27 +12,10 @@ export type PEI = {
     'genre'?: GenreEnum;
     'numero'?: string;
     'numero_compteur'?: string;
+    'numero_serie_appareil'?: string;
 };
 
 export enum GenreEnum {
-    Pi1x65 = 'PI1x65',
-    Pi1x65Pi2x45 = 'PI1x65+PI2x45',
-    Pi1x100 = 'PI1x100',
-    Pi2x100 = 'PI2x100',
-    Bi1x65 = 'BI1x65',
-    Bi1x80 = 'BI1x80',
-    Bi1x100 = 'BI1x100',
-    Bi2x100 = 'BI2x100',
-    PointAspiration = 'POINT_ASPIRATION',
-    CiterneAerienne = 'CITERNE_AERIENNE',
-    CiterneEnterree = 'CITERNE_ENTERREE',
-    CiterneSemiEnterree = 'CITERNE_SEMI_ENTERREE',
-    CiterneSouple = 'CITERNE_SOUPLE',
-    ReserveAerienne = 'RESERVE_AERIENNE',
-    PoteauRelais = 'POTEAU_RELAIS',
-    PuisardAspiration = 'PUISARD_ASPIRATION',
-    PriseDeportee = 'PRISE_DEPORTEE',
-    PoteauAspiration1x100 = 'POTEAU_ASPIRATION_1x100',
-    PoteauAspiration2x100 = 'POTEAU_ASPIRATION_2x100',
-    BoucheAspiration1x100 = 'BOUCHE_ASPIRATION_1x100'
+    Pibi = 'PIBI',
+    Pena = 'PENA'
 }