Added patch for vehicle equipment

Author: pjrctrlhub

dist/Client.js

@@ -231,7 +231,7 @@ export class Client {
         try {
             // @todo switch on cookie, "X-Session-Token" or client_credentials
             const fetchResponse = await fetch(url, {
-                credentials: 'include', // @todo only required for cookie based auth,
+                credentials: 'include',
                 headers: headers,
             });
             let json = await fetchResponse.json();

dist/index.js

@@ -1482,15 +1482,13 @@ class BaseService extends RequestBuilder {
     };
   }
   async create(model, params) {
-    if (params) {
-    }
+    if (params) {}
     const jsonApiSerializer = new JsonApiSerializer(this.hydrator.getModelMap());
     const payload = jsonApiSerializer.buildCreatePayload(model);
     return await this.client.makePostRequest(this.endpoint, payload);
   }
   async update(id, model, params) {
-    if (params) {
-    }
+    if (params) {}
     const jsonApiSerializer = new JsonApiSerializer(this.hydrator.getModelMap());
     const payload = jsonApiSerializer.buildUpdatePayload(model);
     return await this.client.makePatchRequest(`${this.endpoint}/${id}`, payload);
@@ -1661,6 +1659,29 @@ class VehiclesService extends BaseService {
     resp.data = hydrator.hydrateResponse(resp.data, resp.included);
     return resp;
   }
+  async patchEquipment(vehicleId, equipment) {
+    const payload = this.buildEquipmentRelationshipPayload(vehicleId, equipment, "equipment-items");
+    payload.data.id = vehicleId;
+    return await this.client.makePatchRequest(`${this.endpoint}/${vehicleId}`, payload);
+  }
+  buildEquipmentRelationshipPayload(vehicleId, relationships, relationshipType) {
+    const data = relationships.filter((relationship) => relationship !== undefined).map((relationship) => ({
+      type: relationshipType,
+      id: relationship
+    }));
+    const payload = {
+      data: {
+        id: vehicleId,
+        type: "vehicles",
+        relationships: {
+          equipment: {
+            data
+          }
+        }
+      }
+    };
+    return payload;
+  }
 }
 
 // src/services/EquipmentService.ts
@@ -2132,9 +2153,6 @@ class ClientConfig {
 }
 // src/models/Organisation.ts
 class Organisation extends BaseModel {
-  constructor() {
-    super(...arguments);
-  }
   type = "organisations";
   static relationships = [];
 }

dist/services/BaseService.d.ts

@@ -13,15 +13,15 @@ export declare class BaseService<T extends Model> extends RequestBuilder {
     constructor(client: Client, endpoint: string);
     convertToJsonApi(model: Model): {
         data: {
-            id?: string;
+            id?: string | undefined;
             type: string;
             attributes: Record<string, any>;
             relationships?: Record<string, {
                 data: {
                     type: string;
                     id: string;
                 };
-            }>;
+            }> | undefined;
         };
     };
     get(): Promise<InternalResponse<T[]>>;

dist/services/VehiclesService.d.ts

@@ -3,8 +3,25 @@ import { BaseService } from "./BaseService";
 import { Vehicle } from "../models/Vehicle";
 import type { InternalResponse } from '../types/Response';
 import type { MotRecord } from "../models/MotRecord";
+type JsonApiRelationshipsPayload = {
+    data: {
+        id: string;
+        type: string;
+        relationships: {
+            equipment: {
+                data: Array<{
+                    type: string;
+                    id: string;
+                }>;
+            };
+        };
+    };
+};
 export declare class VehiclesService extends BaseService<Vehicle> {
     constructor(client: Client);
     enquiry(registration: string): Promise<InternalResponse<any[]>>;
     motRecords(vehicleId: string): Promise<InternalResponse<MotRecord[]>>;
+    patchEquipment(vehicleId: string, equipment: Array<string>): Promise<any>;
+    buildEquipmentRelationshipPayload(vehicleId: string, relationships: Array<string>, relationshipType: string): JsonApiRelationshipsPayload;
 }
+export {};

dist/services/VehiclesService.js

@@ -25,4 +25,29 @@ export class VehiclesService extends BaseService {
         resp.data = hydrator.hydrateResponse(resp.data, resp.included);
         return resp;
     }
+    async patchEquipment(vehicleId, equipment) {
+        const payload = this.buildEquipmentRelationshipPayload(vehicleId, equipment, 'equipment-items');
+        payload.data.id = vehicleId;
+        return await this.client.makePatchRequest(`${this.endpoint}/${vehicleId}`, payload);
+    }
+    buildEquipmentRelationshipPayload(vehicleId, relationships, relationshipType) {
+        const data = relationships
+            .filter(relationship => relationship !== undefined)
+            .map(relationship => ({
+            type: relationshipType,
+            id: relationship,
+        }));
+        const payload = {
+            data: {
+                id: vehicleId,
+                type: 'vehicles',
+                relationships: {
+                    equipment: {
+                        data: data
+                    }
+                }
+            }
+        };
+        return payload;
+    }
 }

dist/utils/Requests.js

@@ -12,7 +12,7 @@ export class Requests {
     }
     static buildInternalResponse(fetchResponse, json) {
         return {
-            ok: fetchResponse.ok, // @todo convert to own version
+            ok: fetchResponse.ok,
             statusCode: fetchResponse.status,
             headers: fetchResponse.headers,
             meta: json?.meta || null,
@@ -29,7 +29,7 @@ export class Requests {
     static buildInternalErrorResponse(error) {
         return {
             ok: false,
-            statusCode: error.statusCode || 0, // If there's no response, status code is 0
+            statusCode: error.statusCode || 0,
             headers: error.headers,
             data: null,
             errors: {

src/services/VehiclesService.ts

@@ -5,6 +5,21 @@ import type { InternalResponse } from '../types/Response';
 import { Hydrator } from "@utils/Hydrator";
 import type { MotRecord } from "@models/MotRecord";
 
+type JsonApiRelationshipsPayload = {
+    data: {
+        id: string,
+        type: string,
+       relationships: {
+        equipment: {
+            data: Array<{
+                type: string;
+                id: string;
+                }>;
+            }
+        }
+    }
+};
+
 export class VehiclesService extends BaseService<Vehicle> {
     constructor(client: Client) {
         super(client, "/v3/orgs/:orgId/assets/vehicles");
@@ -34,4 +49,33 @@ export class VehiclesService extends BaseService<Vehicle> {
 
         return resp;
     }
+
+    public async patchEquipment(vehicleId: string, equipment: Array<string>) {
+        const payload = this.buildEquipmentRelationshipPayload(vehicleId, equipment, 'equipment-items');
+        payload.data.id = vehicleId;
+        return await this.client.makePatchRequest(`${this.endpoint}/${vehicleId}`, payload);
+    }
+
+    buildEquipmentRelationshipPayload(vehicleId: string, relationships: Array<string>, relationshipType: string): JsonApiRelationshipsPayload {
+        const data = relationships
+            .filter(relationship => relationship !== undefined)
+            .map(relationship => ({
+                type: relationshipType,
+                id: relationship,
+            }));
+
+        const payload: JsonApiRelationshipsPayload = {
+            data: {
+                id: vehicleId,
+                type: 'vehicles',
+                relationships: {
+                    equipment: {
+                        data: data
+                        }
+                    }
+                }
+            };
+
+        return payload;
+    }
 }