raain-model 3.1.3 → 3.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (123) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/README.md +39 -28
  3. package/api/common/Pagination.d.ts +13 -0
  4. package/api/common/Pagination.js +3 -0
  5. package/api/common/Pagination.js.map +1 -0
  6. package/api/common/index.d.ts +1 -0
  7. package/api/common/index.js +18 -0
  8. package/api/common/index.js.map +1 -0
  9. package/api/gauges/RaainApiGaugesFindAllMineRequest.d.ts +5 -0
  10. package/api/gauges/RaainApiGaugesFindAllMineRequest.js +3 -0
  11. package/api/gauges/RaainApiGaugesFindAllMineRequest.js.map +1 -0
  12. package/api/gauges/RaainApiGaugesFindMeasuresRequest.d.ts +4 -0
  13. package/api/gauges/RaainApiGaugesFindMeasuresRequest.js +3 -0
  14. package/api/gauges/RaainApiGaugesFindMeasuresRequest.js.map +1 -0
  15. package/api/gauges/RaainApiGaugesFindOneRequest.d.ts +5 -0
  16. package/api/gauges/RaainApiGaugesFindOneRequest.js +3 -0
  17. package/api/gauges/RaainApiGaugesFindOneRequest.js.map +1 -0
  18. package/api/gauges/RaainApiGaugesUpdateRequestBody.d.ts +3 -0
  19. package/api/gauges/RaainApiGaugesUpdateRequestBody.js +3 -0
  20. package/api/gauges/RaainApiGaugesUpdateRequestBody.js.map +1 -0
  21. package/api/gauges/RaainApiGaugesUpsertMeasureRequestBody.d.ts +4 -0
  22. package/api/gauges/RaainApiGaugesUpsertMeasureRequestBody.js +3 -0
  23. package/api/gauges/RaainApiGaugesUpsertMeasureRequestBody.js.map +1 -0
  24. package/api/index.d.ts +20 -0
  25. package/api/index.js +44 -0
  26. package/api/index.js.map +1 -0
  27. package/api/notifications/RaainApiNotificationsAddRequestBody.d.ts +4 -0
  28. package/api/notifications/RaainApiNotificationsAddRequestBody.js +3 -0
  29. package/api/notifications/RaainApiNotificationsAddRequestBody.js.map +1 -0
  30. package/api/notifications/RaainApiNotificationsFindAllMineRequest.d.ts +4 -0
  31. package/api/notifications/RaainApiNotificationsFindAllMineRequest.js +3 -0
  32. package/api/notifications/RaainApiNotificationsFindAllMineRequest.js.map +1 -0
  33. package/api/radars/RaainApiRadarsFindAllMineRequest.d.ts +4 -0
  34. package/api/radars/RaainApiRadarsFindAllMineRequest.js +3 -0
  35. package/api/radars/RaainApiRadarsFindAllMineRequest.js.map +1 -0
  36. package/api/radars/RaainApiRadarsFindMeasuresRequest.d.ts +5 -0
  37. package/api/radars/RaainApiRadarsFindMeasuresRequest.js +3 -0
  38. package/api/radars/RaainApiRadarsFindMeasuresRequest.js.map +1 -0
  39. package/api/radars/RaainApiRadarsUpdateRequestBody.d.ts +4 -0
  40. package/api/radars/RaainApiRadarsUpdateRequestBody.js +3 -0
  41. package/api/radars/RaainApiRadarsUpdateRequestBody.js.map +1 -0
  42. package/api/radars/RaainApiRadarsUpsertMeasureRequestBody.d.ts +4 -0
  43. package/api/radars/RaainApiRadarsUpsertMeasureRequestBody.js +3 -0
  44. package/api/radars/RaainApiRadarsUpsertMeasureRequestBody.js.map +1 -0
  45. package/api/rains/RaainApiRainsAddHistoryRequestBody.d.ts +5 -0
  46. package/api/rains/RaainApiRainsAddHistoryRequestBody.js +3 -0
  47. package/api/rains/RaainApiRainsAddHistoryRequestBody.js.map +1 -0
  48. package/api/rains/RaainApiRainsFindAllMineRequest.d.ts +7 -0
  49. package/api/rains/RaainApiRainsFindAllMineRequest.js +3 -0
  50. package/api/rains/RaainApiRainsFindAllMineRequest.js.map +1 -0
  51. package/api/rains/RaainApiRainsFindAllRelatedHistoriesRequest.d.ts +8 -0
  52. package/api/rains/RaainApiRainsFindAllRelatedHistoriesRequest.js +3 -0
  53. package/api/rains/RaainApiRainsFindAllRelatedHistoriesRequest.js.map +1 -0
  54. package/api/rains/RaainApiRainsFindOneRequest.d.ts +8 -0
  55. package/api/rains/RaainApiRainsFindOneRequest.js +3 -0
  56. package/api/rains/RaainApiRainsFindOneRequest.js.map +1 -0
  57. package/api/rains/RaainApiRainsGetCountsRequest.d.ts +4 -0
  58. package/api/rains/RaainApiRainsGetCountsRequest.js +3 -0
  59. package/api/rains/RaainApiRainsGetCountsRequest.js.map +1 -0
  60. package/api/rains/RaainApiRainsUpdateRequestBody.d.ts +9 -0
  61. package/api/rains/RaainApiRainsUpdateRequestBody.js +3 -0
  62. package/api/rains/RaainApiRainsUpdateRequestBody.js.map +1 -0
  63. package/api/teams/RaainApiTeamsFindAllMineRequest.d.ts +4 -0
  64. package/api/teams/RaainApiTeamsFindAllMineRequest.js +3 -0
  65. package/api/teams/RaainApiTeamsFindAllMineRequest.js.map +1 -0
  66. package/api/teams/RaainApiTeamsUpdateRequestBody.d.ts +4 -0
  67. package/api/teams/RaainApiTeamsUpdateRequestBody.js +3 -0
  68. package/api/teams/RaainApiTeamsUpdateRequestBody.js.map +1 -0
  69. package/bpInfo.js +1 -1
  70. package/gauge/GaugeMeasure.d.ts +2 -1
  71. package/gauge/GaugeMeasure.js +2 -1
  72. package/gauge/GaugeMeasure.js.map +1 -1
  73. package/gauge/GaugeNode.d.ts +4 -0
  74. package/gauge/GaugeNode.js +4 -0
  75. package/gauge/GaugeNode.js.map +1 -1
  76. package/gauge/GaugeNodeMap.d.ts +2 -1
  77. package/gauge/GaugeNodeMap.js +2 -1
  78. package/gauge/GaugeNodeMap.js.map +1 -1
  79. package/index.d.ts +1 -0
  80. package/index.js +1 -0
  81. package/index.js.map +1 -1
  82. package/organization/EventNode.d.ts +3 -1
  83. package/organization/EventNode.js +3 -1
  84. package/organization/EventNode.js.map +1 -1
  85. package/organization/PeopleNode.d.ts +0 -3
  86. package/organization/PeopleNode.js +0 -3
  87. package/organization/PeopleNode.js.map +1 -1
  88. package/organization/TeamNode.d.ts +5 -1
  89. package/organization/TeamNode.js +5 -1
  90. package/organization/TeamNode.js.map +1 -1
  91. package/package.json +1 -1
  92. package/polar/PolarMeasureValueMap.js +6 -4
  93. package/polar/PolarMeasureValueMap.js.map +1 -1
  94. package/radar/RadarMeasure.d.ts +3 -1
  95. package/radar/RadarMeasure.js +3 -1
  96. package/radar/RadarMeasure.js.map +1 -1
  97. package/radar/RadarNode.d.ts +4 -2
  98. package/radar/RadarNode.js +4 -2
  99. package/radar/RadarNode.js.map +1 -1
  100. package/radar/RadarNodeMap.d.ts +0 -3
  101. package/radar/RadarNodeMap.js +0 -3
  102. package/radar/RadarNodeMap.js.map +1 -1
  103. package/rain/RainComputation.d.ts +2 -3
  104. package/rain/RainComputation.js +2 -3
  105. package/rain/RainComputation.js.map +1 -1
  106. package/rain/RainComputationCumulative.d.ts +3 -3
  107. package/rain/RainComputationCumulative.js +3 -3
  108. package/rain/RainComputationMap.d.ts +3 -4
  109. package/rain/RainComputationMap.js +3 -4
  110. package/rain/RainComputationMap.js.map +1 -1
  111. package/rain/RainComputationQuality.d.ts +3 -1
  112. package/rain/RainComputationQuality.js +3 -1
  113. package/rain/RainComputationQuality.js.map +1 -1
  114. package/rain/RainMeasure.d.ts +1 -1
  115. package/rain/RainMeasure.js +1 -1
  116. package/rain/RainNode.d.ts +3 -1
  117. package/rain/RainNode.js +3 -1
  118. package/rain/RainNode.js.map +1 -1
  119. package/rain/RainSpeed.d.ts +1 -1
  120. package/rain/RainSpeed.js +1 -1
  121. package/rain/RainSpeedMap.d.ts +4 -1
  122. package/rain/RainSpeedMap.js +13 -1
  123. package/rain/RainSpeedMap.js.map +1 -1
package/CHANGELOG.md CHANGED
@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
7
7
 
8
8
  ## [Unreleased]
9
9
 
10
+ ### Added
11
+
12
+ - API contracts: requests arguments and bodies
13
+
14
+ ## [3.1.4] - 2025-11-24
15
+
10
16
  ### Fixed
11
17
 
12
18
  - PolarMeasureValueMap filtering with bad values
package/README.md CHANGED
@@ -37,11 +37,11 @@ yarn add raain-model
37
37
  ## 📖 Quick Start
38
38
 
39
39
  ```typescript
40
- import {RainNode, RadarNode, GaugeNode, RainComputationMap} from 'raain-model';
40
+ import {RainNode, RadarNode, GaugeNode} from 'raain-model';
41
41
 
42
42
  // Create a radar node
43
43
  const radarNode = new RadarNode({
44
- id: 'radar1',
44
+ id: 'parisR',
45
45
  latitude: 48.8566,
46
46
  longitude: 2.3522,
47
47
  name: 'Paris Radar',
@@ -50,21 +50,24 @@ const radarNode = new RadarNode({
50
50
 
51
51
  // Create a rain gauge node
52
52
  const gaugeNode = new GaugeNode({
53
- id: 'gauge1',
53
+ id: 'parisG',
54
54
  latitude: 48.8566,
55
55
  longitude: 2.3522,
56
- name: 'Paris Gauge',
56
+ name: 'One Paris Gauge',
57
57
  team: null
58
58
  });
59
59
 
60
- // Create a rain node with radar coverage
60
+ // Create a rain node
61
61
  const rainNode = new RainNode({
62
- id: 'rain1',
62
+ id: 'parisZ',
63
63
  name: 'Paris Rain Zone',
64
64
  team: null,
65
65
  radars: [radarNode],
66
66
  gauges: [gaugeNode]
67
67
  });
68
+
69
+ // ...
70
+
68
71
  ```
69
72
 
70
73
  ## 📚 Documentation
@@ -83,28 +86,36 @@ and [API swagger](https://api.sandbox.radartorain.com/v3/docs).
83
86
 
84
87
  The following table lists which REST API endpoints return or accept which model classes in this library:
85
88
 
86
- | API endpoint (pattern) | Exposes model class | Notes |
87
- |---------------------------------------------------------------|-----------------------------|------------------------------------------|
88
- | `api/radars/:id` | `RadarNode` | Radar station metadata |
89
- | `api/radars/:id/measures/:measureId` | `RadarMeasure` | Single radar measure with polar data |
90
- | `api/radars/:id/measures?begin=...&end=...` | `RadarMeasure[]` | List of radar measures for date range |
91
- | `api/gauges/:id` | `GaugeNode` | Rain gauge metadata |
92
- | `api/gauges/:id/measures?begin=...&end=...` | `GaugeMeasure[]` | List of gauge measures for date range |
93
- | `api/gauges/:id?format=map&begin=...` | `GaugeNodeMap` | Gauge data as map over time window |
94
- | `api/rains/:id` | `RainNode` | Rain zone entity |
95
- | `api/rains/:id/computations/:computationId` | `RainComputation` | One computation result |
96
- | `api/rains/:id/computations?format=id&begin=...` | `RainComputation[]` | List of computations (IDs) |
97
- | `api/rains/:id/computations/:computationId?format=map` | `RainComputationMap` | Computation as cartesian map |
98
- | `api/rains/:id/computations?format=map&begin=...` | `RainComputationMap[]` | List of maps over period |
99
- | `api/rains/:id/computations/:computationId/speeds` | `RainSpeedMap` | Rain speed map for a computation |
100
- | `api/rains/:id/computations/:computationId/compares?date=...` | `RainComputationQuality[]` | Quality/compare metrics (radar vs gauge) |
101
- | `api/rains/:id/cumulative/:cumulativeId` | `RainComputationCumulative` | Cumulative computation |
102
- | `api/notifications` | `EventNode[]` | List of user notifications |
103
- | `api/teams/:id` | `TeamNode` | Team/organization entity |
104
- | `api/teams?name=...` | `TeamNode` | Team lookup by name |
105
- | `api/teams/:id/people` | `PeopleNode[]` | People related to a team |
106
-
107
- **Note**: All endpoints are prefixed with the API version (e.g., `/v3/api/...`).
89
+ <!-- MODEL_MAPPING_TABLE_START -->
90
+
91
+ | API endpoint (pattern) | Exposes model class | Notes |
92
+ |--------------------------------------------------------------------|-----------------------------|-----------------------------------------------------|
93
+ | `/radars` | `RadarNode[]` | Search for radars |
94
+ | `/radars/:id` | `RadarNode` | Get a radar by ID |
95
+ | `/radars/:id/measures` | `RadarMeasure[]` | Get radar measures |
96
+ | `/radars/:id/measures/:measureId` | `RadarMeasure` | Get a radar measure by ID |
97
+ | `/gauges` | `GaugeNode[]` | Search for gauges |
98
+ | `/gauges/:id` | `GaugeNode` | Get a gauge by ID |
99
+ | `/gauges/:id?format=cartesian-map` | `GaugeNodeMap` | Get a gauge by ID (format=cartesian-map) |
100
+ | `/gauges/:id/measures` | `GaugeMeasure[]` | Get gauge measures |
101
+ | `/rains` | `RainNode[]` | Search for rain zones |
102
+ | `/rains/:id` | `RainNode` | Get a rain zone by ID |
103
+ | `/rains/:id/computations/:computationId` | `RainComputation` | |
104
+ | `/rains/:id/computations/:computationId?format=cartesian-map` | `RainComputationMap` | (format=cartesian-map) |
105
+ | `/rains/:id/computations/:computationId/compares` | `RainComputationQuality[]` | (Admin) Get cumulative qualities |
106
+ | `/rains/:id/computations/:computationId/speeds` | `RainSpeedMap` | |
107
+ | `/rains/:id/cumulatives/:cumulativeId` | `RainComputationCumulative` | Get a cumulative computation |
108
+ | `/rains/:id/cumulatives/:cumulativeId?format=cartesian-map` | `RainComputationMap` | Get a cumulative computation (format=cartesian-map) |
109
+ | `/rains/:id/cumulatives/:cumulativeId/compares` | `RainComputationQuality[]` | Get cumulative quality metrics |
110
+ | `/rains/:id/cumulatives/:cumulativeId/cumulative/:cumulativeHours` | `RainComputationCumulative` | Get cumulative computation data |
111
+ | `/notifications` | `EventNode[]` | Get all notifications |
112
+ | `/notifications/:id` | `EventNode` | Get a notification by ID |
113
+ | `/teams` | `TeamNode[]` | Search for teams |
114
+ | `/teams/:id` | `TeamNode` | Get a team by ID |
115
+
116
+ <!-- MODEL_MAPPING_TABLE_END -->
117
+
118
+ **Note**: All endpoints are prefixed with the API version (e.g., `/v3/...`).
108
119
 
109
120
  ### Core Model Categories
110
121
 
@@ -0,0 +1,13 @@
1
+ export interface PaginationRequest {
2
+ page: number;
3
+ limit: number;
4
+ }
5
+ export interface PaginatedResponse<T> {
6
+ data: T[];
7
+ page: number;
8
+ limit: number;
9
+ total: number;
10
+ totalPages: number;
11
+ hasNext: boolean;
12
+ hasPrev: boolean;
13
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=Pagination.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Pagination.js","sourceRoot":"","sources":["../../../src/api/common/Pagination.ts"],"names":[],"mappings":""}
@@ -0,0 +1 @@
1
+ export * from './Pagination';
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./Pagination"), exports);
18
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/common/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B"}
@@ -0,0 +1,5 @@
1
+ import { PaginationRequest } from '../common';
2
+ export interface RaainApiGaugesFindAllMineRequest extends PaginationRequest {
3
+ name: string;
4
+ aroundLatLng: string;
5
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=RaainApiGaugesFindAllMineRequest.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RaainApiGaugesFindAllMineRequest.js","sourceRoot":"","sources":["../../../src/api/gauges/RaainApiGaugesFindAllMineRequest.ts"],"names":[],"mappings":""}
@@ -0,0 +1,4 @@
1
+ export interface RaainApiGaugesFindMeasuresRequest {
2
+ begin: string;
3
+ end: string;
4
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=RaainApiGaugesFindMeasuresRequest.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RaainApiGaugesFindMeasuresRequest.js","sourceRoot":"","sources":["../../../src/api/gauges/RaainApiGaugesFindMeasuresRequest.ts"],"names":[],"mappings":""}
@@ -0,0 +1,5 @@
1
+ export interface RaainApiGaugesFindOneRequest {
2
+ format: string;
3
+ begin: string;
4
+ end: string;
5
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=RaainApiGaugesFindOneRequest.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RaainApiGaugesFindOneRequest.js","sourceRoot":"","sources":["../../../src/api/gauges/RaainApiGaugesFindOneRequest.ts"],"names":[],"mappings":""}
@@ -0,0 +1,3 @@
1
+ export interface RaainApiGaugesUpdateRequestBody {
2
+ configurationAsJSON: string;
3
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=RaainApiGaugesUpdateRequestBody.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RaainApiGaugesUpdateRequestBody.js","sourceRoot":"","sources":["../../../src/api/gauges/RaainApiGaugesUpdateRequestBody.ts"],"names":[],"mappings":""}
@@ -0,0 +1,4 @@
1
+ export interface RaainApiGaugesUpsertMeasureRequestBody {
2
+ date: string;
3
+ values: number[];
4
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=RaainApiGaugesUpsertMeasureRequestBody.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RaainApiGaugesUpsertMeasureRequestBody.js","sourceRoot":"","sources":["../../../src/api/gauges/RaainApiGaugesUpsertMeasureRequestBody.ts"],"names":[],"mappings":""}
package/api/index.d.ts ADDED
@@ -0,0 +1,20 @@
1
+ export * from './common';
2
+ export * from './teams/RaainApiTeamsFindAllMineRequest';
3
+ export * from './teams/RaainApiTeamsUpdateRequestBody';
4
+ export * from './radars/RaainApiRadarsFindAllMineRequest';
5
+ export * from './radars/RaainApiRadarsFindMeasuresRequest';
6
+ export * from './radars/RaainApiRadarsUpdateRequestBody';
7
+ export * from './radars/RaainApiRadarsUpsertMeasureRequestBody';
8
+ export * from './gauges/RaainApiGaugesFindOneRequest';
9
+ export * from './gauges/RaainApiGaugesFindAllMineRequest';
10
+ export * from './gauges/RaainApiGaugesFindMeasuresRequest';
11
+ export * from './gauges/RaainApiGaugesUpdateRequestBody';
12
+ export * from './gauges/RaainApiGaugesUpsertMeasureRequestBody';
13
+ export * from './rains/RaainApiRainsFindOneRequest';
14
+ export * from './rains/RaainApiRainsGetCountsRequest';
15
+ export * from './rains/RaainApiRainsFindAllMineRequest';
16
+ export * from './rains/RaainApiRainsUpdateRequestBody';
17
+ export * from './rains/RaainApiRainsAddHistoryRequestBody';
18
+ export * from './rains/RaainApiRainsFindAllRelatedHistoriesRequest';
19
+ export * from './notifications/RaainApiNotificationsAddRequestBody';
20
+ export * from './notifications/RaainApiNotificationsFindAllMineRequest';
package/api/index.js ADDED
@@ -0,0 +1,44 @@
1
+ "use strict";
2
+ // Public API request contracts
3
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
4
+ if (k2 === undefined) k2 = k;
5
+ var desc = Object.getOwnPropertyDescriptor(m, k);
6
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
7
+ desc = { enumerable: true, get: function() { return m[k]; } };
8
+ }
9
+ Object.defineProperty(o, k2, desc);
10
+ }) : (function(o, m, k, k2) {
11
+ if (k2 === undefined) k2 = k;
12
+ o[k2] = m[k];
13
+ }));
14
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
15
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
16
+ };
17
+ Object.defineProperty(exports, "__esModule", { value: true });
18
+ // Common
19
+ __exportStar(require("./common"), exports);
20
+ // Teams
21
+ __exportStar(require("./teams/RaainApiTeamsFindAllMineRequest"), exports);
22
+ __exportStar(require("./teams/RaainApiTeamsUpdateRequestBody"), exports);
23
+ // Radars
24
+ __exportStar(require("./radars/RaainApiRadarsFindAllMineRequest"), exports);
25
+ __exportStar(require("./radars/RaainApiRadarsFindMeasuresRequest"), exports);
26
+ __exportStar(require("./radars/RaainApiRadarsUpdateRequestBody"), exports);
27
+ __exportStar(require("./radars/RaainApiRadarsUpsertMeasureRequestBody"), exports);
28
+ // Gauges
29
+ __exportStar(require("./gauges/RaainApiGaugesFindOneRequest"), exports);
30
+ __exportStar(require("./gauges/RaainApiGaugesFindAllMineRequest"), exports);
31
+ __exportStar(require("./gauges/RaainApiGaugesFindMeasuresRequest"), exports);
32
+ __exportStar(require("./gauges/RaainApiGaugesUpdateRequestBody"), exports);
33
+ __exportStar(require("./gauges/RaainApiGaugesUpsertMeasureRequestBody"), exports);
34
+ // Rains
35
+ __exportStar(require("./rains/RaainApiRainsFindOneRequest"), exports);
36
+ __exportStar(require("./rains/RaainApiRainsGetCountsRequest"), exports);
37
+ __exportStar(require("./rains/RaainApiRainsFindAllMineRequest"), exports);
38
+ __exportStar(require("./rains/RaainApiRainsUpdateRequestBody"), exports);
39
+ __exportStar(require("./rains/RaainApiRainsAddHistoryRequestBody"), exports);
40
+ __exportStar(require("./rains/RaainApiRainsFindAllRelatedHistoriesRequest"), exports);
41
+ // Notifications
42
+ __exportStar(require("./notifications/RaainApiNotificationsAddRequestBody"), exports);
43
+ __exportStar(require("./notifications/RaainApiNotificationsFindAllMineRequest"), exports);
44
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":";AAAA,+BAA+B;;;;;;;;;;;;;;;;AAE/B,SAAS;AACT,2CAAyB;AAEzB,QAAQ;AACR,0EAAwD;AACxD,yEAAuD;AAEvD,SAAS;AACT,4EAA0D;AAC1D,6EAA2D;AAC3D,2EAAyD;AACzD,kFAAgE;AAEhE,SAAS;AACT,wEAAsD;AACtD,4EAA0D;AAC1D,6EAA2D;AAC3D,2EAAyD;AACzD,kFAAgE;AAEhE,QAAQ;AACR,sEAAoD;AACpD,wEAAsD;AACtD,0EAAwD;AACxD,yEAAuD;AACvD,6EAA2D;AAC3D,sFAAoE;AAEpE,gBAAgB;AAChB,sFAAoE;AACpE,0FAAwE"}
@@ -0,0 +1,4 @@
1
+ export interface RaainApiNotificationsAddRequestBody {
2
+ rain: string;
3
+ message: string;
4
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=RaainApiNotificationsAddRequestBody.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RaainApiNotificationsAddRequestBody.js","sourceRoot":"","sources":["../../../src/api/notifications/RaainApiNotificationsAddRequestBody.ts"],"names":[],"mappings":""}
@@ -0,0 +1,4 @@
1
+ import { PaginationRequest } from '../common';
2
+ export interface RaainApiNotificationsFindAllMineRequest extends PaginationRequest {
3
+ rain: string;
4
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=RaainApiNotificationsFindAllMineRequest.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RaainApiNotificationsFindAllMineRequest.js","sourceRoot":"","sources":["../../../src/api/notifications/RaainApiNotificationsFindAllMineRequest.ts"],"names":[],"mappings":""}
@@ -0,0 +1,4 @@
1
+ import { PaginationRequest } from '../common';
2
+ export interface RaainApiRadarsFindAllMineRequest extends PaginationRequest {
3
+ name: string;
4
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=RaainApiRadarsFindAllMineRequest.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RaainApiRadarsFindAllMineRequest.js","sourceRoot":"","sources":["../../../src/api/radars/RaainApiRadarsFindAllMineRequest.ts"],"names":[],"mappings":""}
@@ -0,0 +1,5 @@
1
+ export interface RaainApiRadarsFindMeasuresRequest {
2
+ begin: string;
3
+ end: string;
4
+ withValues: boolean | string;
5
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=RaainApiRadarsFindMeasuresRequest.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RaainApiRadarsFindMeasuresRequest.js","sourceRoot":"","sources":["../../../src/api/radars/RaainApiRadarsFindMeasuresRequest.ts"],"names":[],"mappings":""}
@@ -0,0 +1,4 @@
1
+ export interface RaainApiRadarsUpdateRequestBody {
2
+ name: string;
3
+ configurationAsJSON: string;
4
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=RaainApiRadarsUpdateRequestBody.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RaainApiRadarsUpdateRequestBody.js","sourceRoot":"","sources":["../../../src/api/radars/RaainApiRadarsUpdateRequestBody.ts"],"names":[],"mappings":""}
@@ -0,0 +1,4 @@
1
+ export interface RaainApiRadarsUpsertMeasureRequestBody {
2
+ date: string;
3
+ values: any[];
4
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=RaainApiRadarsUpsertMeasureRequestBody.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RaainApiRadarsUpsertMeasureRequestBody.js","sourceRoot":"","sources":["../../../src/api/radars/RaainApiRadarsUpsertMeasureRequestBody.ts"],"names":[],"mappings":""}
@@ -0,0 +1,5 @@
1
+ export interface RaainApiRainsAddHistoryRequestBody {
2
+ date: string;
3
+ format: string;
4
+ confName: string;
5
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=RaainApiRainsAddHistoryRequestBody.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RaainApiRainsAddHistoryRequestBody.js","sourceRoot":"","sources":["../../../src/api/rains/RaainApiRainsAddHistoryRequestBody.ts"],"names":[],"mappings":""}
@@ -0,0 +1,7 @@
1
+ import { PaginationRequest } from '../common';
2
+ export interface RaainApiRainsFindAllMineRequest extends PaginationRequest {
3
+ name: string;
4
+ date: string;
5
+ latLng1: string;
6
+ latLng2: string;
7
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=RaainApiRainsFindAllMineRequest.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RaainApiRainsFindAllMineRequest.js","sourceRoot":"","sources":["../../../src/api/rains/RaainApiRainsFindAllMineRequest.ts"],"names":[],"mappings":""}
@@ -0,0 +1,8 @@
1
+ export interface RaainApiRainsFindAllRelatedHistoriesRequest {
2
+ forced: boolean | string;
3
+ configuration: any;
4
+ begin: string;
5
+ end: string;
6
+ format: string;
7
+ periodBegin: string;
8
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=RaainApiRainsFindAllRelatedHistoriesRequest.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RaainApiRainsFindAllRelatedHistoriesRequest.js","sourceRoot":"","sources":["../../../src/api/rains/RaainApiRainsFindAllRelatedHistoriesRequest.ts"],"names":[],"mappings":""}
@@ -0,0 +1,8 @@
1
+ export interface RaainApiRainsFindOneRequest {
2
+ format: string;
3
+ forced: boolean | string;
4
+ begin: string;
5
+ end: string;
6
+ provider: string;
7
+ timeStepInMinutes: string;
8
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=RaainApiRainsFindOneRequest.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RaainApiRainsFindOneRequest.js","sourceRoot":"","sources":["../../../src/api/rains/RaainApiRainsFindOneRequest.ts"],"names":[],"mappings":""}
@@ -0,0 +1,4 @@
1
+ export interface RaainApiRainsGetCountsRequest {
2
+ begin: string;
3
+ range: 'year' | 'month' | 'day' | 'hour';
4
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=RaainApiRainsGetCountsRequest.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RaainApiRainsGetCountsRequest.js","sourceRoot":"","sources":["../../../src/api/rains/RaainApiRainsGetCountsRequest.ts"],"names":[],"mappings":""}
@@ -0,0 +1,9 @@
1
+ export interface RaainApiRainsUpdateRequestBody {
2
+ name: string;
3
+ radars: any[];
4
+ gauges: any[];
5
+ configurationAsJSON: string;
6
+ radarMeasuresToIdentifyEchoes: any[];
7
+ radarMeasuresToLearn: any[];
8
+ confName: string;
9
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=RaainApiRainsUpdateRequestBody.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RaainApiRainsUpdateRequestBody.js","sourceRoot":"","sources":["../../../src/api/rains/RaainApiRainsUpdateRequestBody.ts"],"names":[],"mappings":""}
@@ -0,0 +1,4 @@
1
+ import { PaginationRequest } from '../common';
2
+ export interface RaainApiTeamsFindAllMineRequest extends PaginationRequest {
3
+ name: string;
4
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=RaainApiTeamsFindAllMineRequest.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RaainApiTeamsFindAllMineRequest.js","sourceRoot":"","sources":["../../../src/api/teams/RaainApiTeamsFindAllMineRequest.ts"],"names":[],"mappings":""}
@@ -0,0 +1,4 @@
1
+ export interface RaainApiTeamsUpdateRequestBody {
2
+ description: string;
3
+ contracts: any;
4
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=RaainApiTeamsUpdateRequestBody.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"RaainApiTeamsUpdateRequestBody.js","sourceRoot":"","sources":["../../../src/api/teams/RaainApiTeamsUpdateRequestBody.ts"],"names":[],"mappings":""}
package/bpInfo.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.bpInfo = void 0;
4
- exports.bpInfo = { version: 'v3.1.3' };
4
+ exports.bpInfo = { version: 'v3.1.5' };
5
5
  //# sourceMappingURL=bpInfo.js.map
@@ -3,7 +3,8 @@ import { IPolarMeasureValue } from '../polar';
3
3
  import { ICartesianMeasureValue } from '../cartesian';
4
4
  import { RaainNodeType } from '../organization/RaainNodeType';
5
5
  /**
6
- * api/gauges/:id/measures?begin=...&end=...
6
+ * @external
7
+ * - API: /gauges/:id/measures
7
8
  */
8
9
  export declare class GaugeMeasure extends Measure {
9
10
  static TYPE: RaainNodeType;
@@ -5,7 +5,8 @@ const organization_1 = require("../organization");
5
5
  const GaugeNode_1 = require("./GaugeNode");
6
6
  const RaainNodeType_1 = require("../organization/RaainNodeType");
7
7
  /**
8
- * api/gauges/:id/measures?begin=...&end=...
8
+ * @external
9
+ * - API: /gauges/:id/measures
9
10
  */
10
11
  class GaugeMeasure extends organization_1.Measure {
11
12
  constructor(json) {
@@ -1 +1 @@
1
- {"version":3,"file":"GaugeMeasure.js","sourceRoot":"","sources":["../../src/gauge/GaugeMeasure.ts"],"names":[],"mappings":";;;AAAA,kDAA8C;AAG9C,2CAAsC;AACtC,iEAA4D;AAE5D;;GAEG;AACH,MAAa,YAAa,SAAQ,sBAAO;IAKrC,YAAY,IAOX;QACG,KAAK,CAAC,IAAI,CAAC,CAAC;QACZ,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACpD,CAAC;IACL,CAAC;IAEM,MAAM,CAAC,OAAkC;QAC5C,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACnC,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAS,CAAC,IAAI,CAAC,CAAC;QAC/C,IAAI,SAAS,EAAE,CAAC;YACZ,IAAI,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC,KAAK,EAAE,CAAC;QACtC,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAES,aAAa,CAAC,aAAoB;QACxC,IAAI,CAAC,aAAa,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/C,OAAO,EAAE,CAAC;QACd,CAAC;QAED,OAAO,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YAC3B,IAAI,CAAC,YAAY,mBAAI,EAAE,CAAC;gBACpB,OAAO,CAAC,CAAC;YACb,CAAC;iBAAM,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;gBACvB,OAAO,IAAI,qBAAS,CAAC;oBACjB,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE;oBACvB,QAAQ,EAAE,CAAC;oBACX,SAAS,EAAE,CAAC;oBACZ,IAAI,EAAE,CAAC,CAAC,IAAI;oBACZ,IAAI,EAAE,CAAC,CAAC,IAAI;iBACf,CAAC,CAAC;YACP,CAAC;iBAAM,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,CAAC;gBACnB,OAAO,IAAI,qBAAS,CAAC;oBACjB,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,QAAQ;oBAC7B,QAAQ,EAAE,CAAC;oBACX,SAAS,EAAE,CAAC;oBACZ,IAAI,EAAE,CAAC,CAAC,IAAI;oBACZ,IAAI,EAAE,CAAC,CAAC,IAAI;iBACf,CAAC,CAAC;YACP,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAES,WAAW;QACjB,OAAO,YAAY,CAAC,IAAI,CAAC;IAC7B,CAAC;;AA1DL,oCA2DC;AA1DiB,iBAAI,GAAG,6BAAa,CAAC,YAAY,CAAC"}
1
+ {"version":3,"file":"GaugeMeasure.js","sourceRoot":"","sources":["../../src/gauge/GaugeMeasure.ts"],"names":[],"mappings":";;;AAAA,kDAA8C;AAG9C,2CAAsC;AACtC,iEAA4D;AAE5D;;;GAGG;AACH,MAAa,YAAa,SAAQ,sBAAO;IAKrC,YAAY,IAOX;QACG,KAAK,CAAC,IAAI,CAAC,CAAC;QACZ,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACpD,CAAC;IACL,CAAC;IAEM,MAAM,CAAC,OAAkC;QAC5C,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACnC,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAS,CAAC,IAAI,CAAC,CAAC;QAC/C,IAAI,SAAS,EAAE,CAAC;YACZ,IAAI,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC,KAAK,EAAE,CAAC;QACtC,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAES,aAAa,CAAC,aAAoB;QACxC,IAAI,CAAC,aAAa,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/C,OAAO,EAAE,CAAC;QACd,CAAC;QAED,OAAO,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YAC3B,IAAI,CAAC,YAAY,mBAAI,EAAE,CAAC;gBACpB,OAAO,CAAC,CAAC;YACb,CAAC;iBAAM,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;gBACvB,OAAO,IAAI,qBAAS,CAAC;oBACjB,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE;oBACvB,QAAQ,EAAE,CAAC;oBACX,SAAS,EAAE,CAAC;oBACZ,IAAI,EAAE,CAAC,CAAC,IAAI;oBACZ,IAAI,EAAE,CAAC,CAAC,IAAI;iBACf,CAAC,CAAC;YACP,CAAC;iBAAM,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,CAAC;gBACnB,OAAO,IAAI,qBAAS,CAAC;oBACjB,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,QAAQ;oBAC7B,QAAQ,EAAE,CAAC;oBACX,SAAS,EAAE,CAAC;oBACZ,IAAI,EAAE,CAAC,CAAC,IAAI;oBACZ,IAAI,EAAE,CAAC,CAAC,IAAI;iBACf,CAAC,CAAC;YACP,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAES,WAAW;QACjB,OAAO,YAAY,CAAC,IAAI,CAAC;IAC7B,CAAC;;AA1DL,oCA2DC;AA1DiB,iBAAI,GAAG,6BAAa,CAAC,YAAY,CAAC"}
@@ -18,6 +18,10 @@ import { RaainNodeType } from '../organization/RaainNodeType';
18
18
  * description: 'Main rain gauge station'
19
19
  * });
20
20
  * ```
21
+ *
22
+ * @external
23
+ * - API: /gauges
24
+ * - API: /gauges/:id
21
25
  */
22
26
  export declare class GaugeNode extends RaainNode {
23
27
  /** Type identifier for gauge nodes */