feat: update to the osm-api version v11.2.0

JulianWowra · Nov 26, 2023 · 39200b4 · 39200b4
1 parent 3361e10
commit 39200b4
Show file tree

Hide file tree

Showing 9 changed files with 152 additions and 110 deletions.
diff --git a/insomnia.yml b/insomnia.yml
diff --git a/src/api/box/_boxModels.ts b/src/api/box/_boxModels.ts
@@ -17,7 +17,7 @@ export type BoxData = {
 	currentLocation: BoxLocation;
 	loc: BoxLoc[];
 	updatedAt: RFC3339Date;
-	sensors: Sensor<Measurement | LastMeasurement | Measurement['_id']>[];
+	sensors: Sensor<Measurement | LastMeasurement | Measurement['_id'] | null>[];
 	lastMeasurementAt?: RFC3339Date;
 };
 
@@ -93,7 +93,7 @@ export type TTN = {
  * @linkcode https://github.com/sensebox/openSenseMap-API/blob/2e645bdc4c80e668720b5eaaf384a35d2909569e/packages/models/src/sensor/sensor.js#L8
  * @linkcode https://github.com/sensebox/openSenseMap-API/blob/2e645bdc4c80e668720b5eaaf384a35d2909569e/packages/models/src/box/box.js#L1057
  */
-export type Sensor<T extends Measurement | LastMeasurement | Measurement['_id'] | undefined> = {
+export type Sensor<T extends Measurement | LastMeasurement | Measurement['_id'] | null | undefined> = {
 	_id: OpenSenseMapID;
 	title: string;
 	unit: string;

diff --git a/src/api/box/_index.ts b/src/api/box/_index.ts
@@ -6,6 +6,7 @@ export * from './_boxModels';
 export * from './claimBox';
 export * from './createTransfer';
 export * from './deleteBox';
+export * from './getAllTags';
 export * from './getBox';
 export * from './getBoxLocations';
 export * from './getBoxes';

diff --git a/src/api/box/deleteBox.ts b/src/api/box/deleteBox.ts
@@ -2,7 +2,6 @@ import axios from 'axios';
 import { OpenSenseMapID } from '../globalTypes';
 
 /**
- * ❗❗ BREAKING CHANGE!
  * @see https://docs.opensensemap.org/#api-Boxes-deleteBox
  */
 export async function deleteBox(senseBoxId: OpenSenseMapID, password: string, authorization: string): Promise<DeleteBoxResult> {

diff --git a/src/api/box/getAllTags.ts b/src/api/box/getAllTags.ts
@@ -0,0 +1,16 @@
+import axios from 'axios';
+
+/**
+ * @see https://docs.opensensemap.org/#api-Boxes-getAllTags
+ */
+export async function getAllTags(): Promise<GetAllTagsResult> {
+	return (await axios.get(`https://api.opensensemap.org/tags`)).data;
+}
+
+/**
+ * @linkcode https://github.com/sensebox/openSenseMap-API/blob/11695a33cf0260a62aecbefd76c46735b690be62/packages/api/lib/controllers/boxesController.js#L704C5-L704C5
+ */
+export type GetAllTagsResult = {
+	code: 'Ok';
+	data: string[];
+};
diff --git a/src/api/box/postNewBox.ts b/src/api/box/postNewBox.ts
@@ -33,10 +33,15 @@ export async function postNewBox(
 }
 
 export type PostNewBoxOptions = {
+	description?: string;
 	grouptag?: string;
 	model?: BoxModel;
 	sensors?: PostNewBoxSensor[];
 	sensorTemplates?: SensorTemplates[];
+	serialPort?: 'Serial1' | 'Serial2';
+	soilDigitalPort?: 'A' | 'B' | 'C';
+	soundMeterPort?: 'A' | 'B' | 'C';
+	windSpeedPort?: 'A' | 'B' | 'C';
 	mqtt?: MQTT;
 	ttn?: TTN;
 	useAuth?: boolean;

diff --git a/src/api/user/_userModels.ts b/src/api/user/_userModels.ts
@@ -11,6 +11,7 @@ export type UserData = {
 	boxes: OpenSenseMapID[];
 	sharedBoxes?: OpenSenseMapID[];
 	emailIsConfirmed: boolean;
+	integrations?: object;
 };
 
 /**

diff --git a/src/api/user/register.ts b/src/api/user/register.ts
@@ -21,7 +21,8 @@ export async function register(userName: UserName, email: string, password: stri
 }
 
 export type RegisterOptions = {
-	language: Language;
+	language?: Language;
+	integrations?: object;
 };
 
 /**

diff --git a/src/api/user/updateUser.ts b/src/api/user/updateUser.ts
@@ -28,6 +28,7 @@ export type UpdateUserOptions = {
 	language?: Language;
 	name?: string;
 	newPassword?: string;
+	integrations?: object;
 };
 
 export type UpdateUserResult = UpdateUserResultResultUpdated | UpdateUserResultUserNotUpdated;
@@ -47,12 +48,9 @@ export type UpdateUserResultResultUpdated = {
 };
 
 /**
- * @linkcode https://github.com/sensebox/openSenseMap-API/blob/2e645bdc4c80e668720b5eaaf384a35d2909569e/packages/models/src/user/user.js#L533
+ * @linkcode https://github.com/sensebox/openSenseMap-API/blob/11695a33cf0260a62aecbefd76c46735b690be62/packages/api/lib/controllers/usersController.js#L320
  */
 export type UpdateUserResultUserNotUpdated = {
 	code: 'Ok';
-	message: 'User successfully saved.';
-	data: {
-		me: { updated: false };
-	};
+	message: 'No changed properties supplied. User remains unchanged.';
 };