Update vehicle service, add updated patchEquipment

Author: jgreaves8

dist/Client.d.ts

@@ -59,7 +59,7 @@ export declare class Client {
     submissions(): SubmissionsService;
     permissions(): PermissionsService;
     groups(groupId?: string): GroupsService;
-    vehicles(): VehiclesService;
+    vehicles(vehicleId?: string): VehiclesService;
     vehicleManufacturers(): VehicleManufacturersService;
     vehicleCategories(): VehicleCategoriesService;
     vehicleModels(): VehicleModelsService;

dist/Client.js

@@ -120,8 +120,8 @@ export class Client {
     groups(groupId) {
         return new GroupsService(this, groupId);
     }
-    vehicles() {
-        return new VehiclesService(this);
+    vehicles(vehicleId) {
+        return new VehiclesService(this, vehicleId);
     }
     vehicleManufacturers() {
         return new VehicleManufacturersService(this);
@@ -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',
+                credentials: 'include', // @todo only required for cookie based auth,
                 headers: headers,
             });
             let json = await fetchResponse.json();

dist/index.js

@@ -1637,8 +1637,9 @@ class GroupsService extends BaseService {
 
 // src/services/VehiclesService.ts
 class VehiclesService extends BaseService {
-  constructor(client) {
-    super(client, "/v3/orgs/:orgId/assets/vehicles");
+  constructor(client, vehicleId) {
+    const endpoint = vehicleId ? `/v3/orgs/:orgId/assets/vehicles/${vehicleId}` : `/v3/orgs/:orgId/assets/vehicles`;
+    super(client, endpoint);
   }
   async enquiry(registration) {
     const enquiryEndpoint = "/v3/assets/vehicles/enquiries";
@@ -1659,28 +1660,10 @@ 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;
+  async patchEquipment(equipmentItems) {
+    const jsonApiSerializer = new JsonApiSerializer(this.hydrator.getModelMap());
+    const payload = jsonApiSerializer.buildRelationshipPayload(new Equipment, equipmentItems);
+    return await this.client.makePatchRequest(`${this.endpoint}/relationships/equipment`, payload);
   }
 }
 
@@ -1995,8 +1978,8 @@ class Client {
   groups(groupId) {
     return new GroupsService(this, groupId);
   }
-  vehicles() {
-    return new VehiclesService(this);
+  vehicles(vehicleId) {
+    return new VehiclesService(this, vehicleId);
   }
   vehicleManufacturers() {
     return new VehicleManufacturersService(this);

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 | undefined;
+            id?: string;
             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,25 +3,10 @@ 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;
-                }>;
-            };
-        };
-    };
-};
+import { Equipment } from "../models/Equipment";
 export declare class VehiclesService extends BaseService<Vehicle> {
-    constructor(client: Client);
+    constructor(client: Client, vehicleId?: string);
     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;
+    patchEquipment(equipmentItems: Array<Equipment>): Promise<any>;
 }
-export {};

dist/services/VehiclesService.js

@@ -2,9 +2,12 @@ import { Client } from "../Client";
 import { BaseService } from "./BaseService";
 import { Vehicle } from "../models/Vehicle";
 import { Hydrator } from "../utils/Hydrator";
+import { Equipment } from "../models/Equipment";
+import { JsonApiSerializer } from "../utils/JsonSerializer";
 export class VehiclesService extends BaseService {
-    constructor(client) {
-        super(client, "/v3/orgs/:orgId/assets/vehicles");
+    constructor(client, vehicleId) {
+        const endpoint = vehicleId ? `/v3/orgs/:orgId/assets/vehicles/${vehicleId}` : `/v3/orgs/:orgId/assets/vehicles`;
+        super(client, endpoint);
     }
     async enquiry(registration) {
         const enquiryEndpoint = '/v3/assets/vehicles/enquiries';
@@ -25,29 +28,9 @@ 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;
+    async patchEquipment(equipmentItems) {
+        const jsonApiSerializer = new JsonApiSerializer(this.hydrator.getModelMap());
+        const payload = jsonApiSerializer.buildRelationshipPayload(new Equipment, equipmentItems);
+        return await this.client.makePatchRequest(`${this.endpoint}/relationships/equipment`, payload);
     }
 }

dist/utils/Requests.js

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

src/Client.ts

@@ -149,8 +149,8 @@ export class Client {
         return new GroupsService(this, groupId);
     }
 
-    public vehicles(): VehiclesService {
-        return new VehiclesService(this);
+    public vehicles(vehicleId?: string): VehiclesService {
+        return new VehiclesService(this, vehicleId);
     }
 
     public vehicleManufacturers(): VehicleManufacturersService {

src/services/VehiclesService.ts

@@ -4,25 +4,13 @@ import {Vehicle} from "../models/Vehicle";
 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;
-                }>;
-            }
-        }
-    }
-};
+import { Equipment } from "@models/Equipment";
+import { JsonApiSerializer } from "@utils/JsonSerializer";
 
 export class VehiclesService extends BaseService<Vehicle> {
-    constructor(client: Client) {
-        super(client, "/v3/orgs/:orgId/assets/vehicles");
+    constructor(client: Client, vehicleId?: string) {
+        const endpoint = vehicleId ? `/v3/orgs/:orgId/assets/vehicles/${vehicleId}` : `/v3/orgs/:orgId/assets/vehicles`;
+        super(client, endpoint);
     }
 
     async enquiry(registration: string): Promise<InternalResponse<any[]>> {
@@ -50,32 +38,10 @@ 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);
+    public async patchEquipment(equipmentItems: Array<Equipment>) {
+        const jsonApiSerializer = new JsonApiSerializer(this.hydrator.getModelMap());
+        const payload = jsonApiSerializer.buildRelationshipPayload(new Equipment, equipmentItems);
+        return await this.client.makePatchRequest(`${this.endpoint}/relationships/equipment`, 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;
-    }
 }