Add header input type to support multi headers

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vacasaoss/ts-force-project",
-  "version": "3.4.4",
+  "version": "3.4.5",
   "description": "",
   "scripts": {
     "postinstall": "cd ts-force && npm install && npm run build && cd ../ts-force-gen && npm install",

ts-force-gen/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vacasaoss/ts-force-gen",
-  "version": "3.4.4",
+  "version": "3.4.5",
   "description": "Code generation for ts-force",
   "main": "build/index.js",
   "typings": "build/index.d.ts",

ts-force/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vacasaoss/ts-force",
-  "version": "3.4.4",
+  "version": "3.4.5",
   "description": "a typescript client for connecting with salesforce APIs",
   "main": "build/index.js",
   "typings": "build/index.d.ts",

ts-force/src/rest/restHeader.ts

@@ -0,0 +1,30 @@
+export type SforceMru = {
+  updateMru: boolean;
+};
+export type PackageVersion = {
+  package: string;
+  version: string;
+};
+
+export type GenericHeader = {
+  header: string;
+  value: string;
+};
+
+export type RequestHeadersInput = {
+  'Sforce-Auto-Assign'?: boolean;
+  'Sforce-Mru'?: SforceMru;
+  'x-sfdc-packageversion'?: PackageVersion;
+  'If-Modified-Since'?: Date;
+  'If-Unmodified-Since'?: Date;
+  'If-Match'?: string[];
+  'If-None-Match'?: string[];
+  'Generic-Header'?: GenericHeader;
+};
+
+export const ConditionalRequestHeaders: (keyof RequestHeadersInput)[] = [
+  'If-Match',
+  'If-None-Match',
+  'If-Modified-Since',
+  'If-Unmodified-Since',
+];

ts-force/src/rest/restObject.ts

@@ -10,11 +10,10 @@ import {
 import { Rest } from './rest';
 import { getSFieldProps, SalesforceFieldType, SFieldProperties } from './sObjectDecorators';
 import { SObject } from './sObject';
-import { CompositeError, StandardRestError } from './errors';
+import { CompositeError, ConditionalError, StandardRestError } from './errors';
 import { FieldProps } from '..';
 import { CalendarDate, calendarToString, getCalendarDate } from '../utils/calendarDate';
-import { AxiosRequestHeaders, AxiosResponse } from 'axios';
-import { STATUS_CODES } from 'http';
+import { RequestHeadersInput, ConditionalRequestHeaders, SforceMru, PackageVersion, GenericHeader } from './restHeader';
 
 export interface DMLResponse {
   id: string;
@@ -229,27 +228,29 @@ export abstract class RestObject extends SObject {
    * @returns {Promise<void>}
    * @memberof RestObject
    */
-  public async update(opts?: { 
-      refresh?: boolean; 
-      sendAllFields?: boolean;
-      ifModifiedSince?: Date;
-      ifUnmodifiedSince?: Date;
-     }): Promise<this> {
+  public async update(opts?: { refresh?: boolean; sendAllFields?: boolean; headers?: RequestHeadersInput[] }): Promise<this> {
     opts = opts || {};
     if (this.id == null) {
       throw new Error('Must have Id to update!');
     }
     if (opts.refresh === true) {
       return this.updateComposite(opts.sendAllFields);
     } else {
-      const headers = {};
-      if (opts.ifModifiedSince) headers['If-Modified-Since'] = opts.ifModifiedSince.toUTCString()
-      if (opts.ifUnmodifiedSince) headers['If-Unmodified-Since'] = opts.ifUnmodifiedSince.toUTCString()
+      const headerOutput = this.setHeader(opts.headers);
       const response = await this._client.request.patch(
         `${this.attributes.url}/${this.id}`,
         this.toJson({ dmlMode: opts.sendAllFields ? 'update' : 'update_modified_only' }),
-        { headers }
+        { headers: headerOutput }
       );
+
+      // Check if it contains Conditional Request Headers and deal with errors
+      const containsConditionalHeader = Object.keys(opts.headers).some((key) =>
+        ConditionalRequestHeaders.includes(key as keyof RequestHeadersInput)
+      );
+      if (containsConditionalHeader && (response.status === 304 || response.status === 412)) {
+        throw new ConditionalError('Conditions not met');
+      }
+
       this._modified.clear();
     }
     return this;
@@ -497,4 +498,38 @@ export abstract class RestObject extends SObject {
       throw e;
     }
   }
+
+  private setHeader(headersInput: RequestHeadersInput[]) {
+    const headers = {};
+    for (const header of headersInput) {
+      for (const [name, value] of Object.entries(header)) {
+        switch (name) {
+          case 'Sforce-Auto-Assign':
+            headers[name] = value.toString();
+            break;
+          case 'If-Match':
+          case 'If-None-Match':
+            headers[name] = `"${(value as string[]).join('", "')}"`;
+            break;
+          case 'If-Modified-Since':
+          case 'If-Unmodified-Since':
+            headers[name] = (value as Date).toUTCString();
+            break;
+          case 'Sforce-Mru':
+            headers[name] = `updateMru=${(value as SforceMru).updateMru}`;
+            break;
+          case 'x-sfdc-packageversion':
+            const packageDetail = value as PackageVersion;
+            headers[`x-sfdc-packageversion-${packageDetail.package}`] = packageDetail.version;
+            break;
+          case 'Generic-Header':
+          default:
+            const defaultValue = value as GenericHeader;
+            headers[defaultValue.header] = defaultValue.value;
+            break;
+        }
+      }
+    }
+    return headers;
+  }
 }