Add bearer token (#24)

* Add Bearer Token Management

* 1.9.0

---------

Co-authored-by: Borja Toron-Antons <[email protected]>

Author: miquelgall

package-lock.json

@@ -5,7 +5,7 @@
     ],
     "name": "@ofs-users/proxy",
     "type": "module",
-    "version": "1.8.3",
+    "version": "1.9.0",
     "description": "A Javascript proxy to access Oracle Field Service via REST API",
     "main": "dist/ofs.es.js",
     "module": "dist/ofs.es.js",

package.json

@@ -28,9 +28,13 @@ export class OFS {
     public set credentials(v: OFSCredentials) {
         this._credentials = v;
         this._hash = OFS.authenticateUser(v);
-        this._baseURL = new URL(
-            `https://${this.instance}.${OFS.DEFAULT_DOMAIN}`
-        );
+        if ("baseURL" in v && v.baseURL != "") {
+            this._baseURL = new URL(v.baseURL!);
+        } else {
+            this._baseURL = new URL(
+                `https://${this.instance}.${OFS.DEFAULT_DOMAIN}`
+            );
+        }
     }
 
     public get authorization(): string {
@@ -42,18 +46,24 @@ export class OFS {
     }
 
     public get instance(): string {
-        return this.credentials.instance;
+        return this.credentials.instance || "";
+    }
+    public get baseURL(): string {
+        return this.credentials.baseURL || "";
     }
-
     private static authenticateUser(credentials: OFSCredentials): string {
-        var token =
-            credentials.clientId +
-            "@" +
-            credentials.instance +
-            ":" +
-            credentials.clientSecret;
-        var hash = Buffer.from(token).toString("base64");
-        return "Basic " + hash;
+        if ("token" in credentials && credentials.token != "") {
+            return "Bearer " + credentials.token;
+        } else {
+            var token =
+                credentials.clientId +
+                "@" +
+                credentials.instance +
+                ":" +
+                credentials.clientSecret;
+            var hash = Buffer.from(token).toString("base64");
+            return "Basic " + hash;
+        }
     }
 
     private _get(

src/OFS.ts

@@ -6,9 +6,11 @@
 import { off } from "process";
 
 export type OFSCredentials = {
-    instance: string;
-    clientId: string;
-    clientSecret: string;
+    instance?: string;
+    clientId?: string;
+    clientSecret?: string;
+    token?: string;
+    baseURL?: string;
 };
 
 export interface OFSResponseInterface {

src/model.ts

@@ -6,15 +6,20 @@
 import { createReadStream, readFileSync } from "fs";
 import { OFSCredentials } from "../../src/model";
 import { OFS } from "../../src/OFS";
-import myCredentials from "../credentials_test.json";
+import myCredentials from "../credentials_test_app.json";
+import myOldCredentials from "../credentials_test.json";
 import { th } from "@faker-js/faker";
 
 var myProxy: OFS;
 
 // Setup info
 beforeAll(() => {
     myProxy = new OFS(myCredentials);
-    expect(myProxy.instance).toBe(myCredentials.instance);
+    if ("instance" in myCredentials) {
+        expect(myProxy.instance).toBe(myCredentials.instance);
+    } else {
+        expect(myProxy.baseURL).toBe(myProxy.baseURL);
+    }
 });
 
 // Teardown info
@@ -28,7 +33,24 @@ afterAll(() => {
 test("Get Subscriptions", async () => {
     //const myProxy = new OFS(myCredentials);
     var result = await myProxy.getSubscriptions();
-    expect(myProxy.instance).toBe(myCredentials.instance);
+    try {
+        expect(result.status).toBe(200);
+    } catch (error) {
+        console.error(result);
+        throw error;
+    }
+});
+
+test("Get Subscriptions with old credentials style", async () => {
+    //const myProxy = new OFS(myCredentials);
+    var myProxyOld = new OFS(myOldCredentials);
+    var result = await myProxyOld.getSubscriptions();
+    try {
+        expect(result.status).toBe(200);
+    } catch (error) {
+        console.error(result);
+        throw error;
+    }
 });
 
 test("Update Plugin (path)", async () => {

test/general/base.test.ts

@@ -14,7 +14,11 @@ var myProxy: OFS;
 // Setup info
 beforeAll(() => {
     myProxy = new OFS(myCredentials);
-    expect(myProxy.instance).toBe(myCredentials.instance);
+    if ("instance" in myCredentials) {
+        expect(myProxy.instance).toBe(myCredentials.instance);
+    } else {
+        expect(myProxy.baseURL).toBe(myProxy.baseURL);
+    }
 });
 
 // Teardown info

test/general/core.activities.test.ts

@@ -28,7 +28,11 @@ TEST_CONFIG.set("23.11", {
 // Setup info
 beforeAll(() => {
     myProxy = new OFS(myCredentials);
-    expect(myProxy.instance).toBe(myCredentials.instance);
+    if ("instance" in myCredentials) {
+        expect(myProxy.instance).toBe(myCredentials.instance);
+    } else {
+        expect(myProxy.baseURL).toBe(myProxy.baseURL);
+    }
     var default_version: string = test_info.ofsVersion;
     testConfig = TEST_CONFIG.get(default_version); // TODO: Store in jest config
 });