Merge branch 'release/3.0.0'.

Author: petrbroz

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "forge-nodejs-utils",
-  "version": "2.2.0",
+  "version": "3.0.0",
   "description": "Tools for accessing Autodesk Forge APIs from Node.js apps.",
   "main": "dist/index.js",
   "scripts": {

package.json

@@ -1,4 +1,5 @@
-import { DefaultHost, post } from './common';
+import * as querystring from 'querystring';
+import fetch from 'node-fetch';
 
 const RootPath = `/authentication/v1`;
 
@@ -12,10 +13,8 @@ export interface ITwoLeggedToken {
     expires_in: number;
 }
 
-export interface IThreeLeggedToken {
-    access_token: string;
+export interface IThreeLeggedToken extends ITwoLeggedToken {
     refresh_token: string;
-    expires_in: number;
 }
 
 /**
@@ -36,13 +35,31 @@ export class AuthenticationClient {
      * @param {string} client_secret Forge application client secret.
      * @param {string} [host="https://developer.api.autodesk.com"] Forge API host.
      */
-    constructor(client_id: string, client_secret: string, host = DefaultHost) {
+    constructor(client_id: string, client_secret: string, host: string = 'https://developer.api.autodesk.com') {
         this.client_id = client_id;
         this.client_secret = client_secret;
         this.host = host;
         this._cached = {};
     }
 
+    // Helper method for POST requests with urlencoded params
+    protected async post(endpoint: string, params: any, headers: { [name: string]: string } = {}) {
+        const options = {
+            method: 'POST',
+            headers: headers,
+            body: querystring.stringify(params)
+        };
+        options.headers['Content-Type'] = 'application/x-www-form-urlencoded';
+        const response = await fetch(this.host + RootPath + endpoint, options);
+        if (response.ok) {
+            const json = await response.json();
+            return json;
+        } else {
+            const msg = await response.text();
+            throw new Error(msg);
+        }
+    }
+
     /**
      * Retrieves 2-legged access token for a specific set of scopes
      * ({@link https://forge.autodesk.com/en/docs/oauth/v2/reference/http/authenticate-POST|docs}).
@@ -75,7 +92,7 @@ export class AuthenticationClient {
         };
         const cache = this._cached[key] = {
             expires_at: Number.MAX_VALUE,
-            promise: post(`${this.host}${RootPath}/authenticate`, { urlencoded: params }).then((resp) => {
+            promise: this.post('/authenticate', params).then((resp) => {
                 this._cached[key].expires_at = Date.now() + resp.expires_in * 1000;
                 return resp.access_token;
             })
@@ -113,7 +130,7 @@ export class AuthenticationClient {
             'code': code,
             'redirect_uri': redirectUri
         };
-        const token = await post(`${this.host}${RootPath}/gettoken`, { urlencoded: params });
+        const token = await this.post(`/gettoken`, params);
         return token;
     }
 }

src/authentication.ts

@@ -1,4 +1,7 @@
-import { get, DefaultHost } from './common';
+import { Region } from './common';
+import { ForgeClient, IAuthOptions } from './common';
+
+const ReadTokenScopes = ['data:read'];
 
 interface IHub {
     type: string;
@@ -44,24 +47,17 @@ interface IVersion {
  * Client providing access to Autodesk Forge
  * {@link https://forge.autodesk.com/en/docs/bim360/v1|BIM360 APIs}.
  */
-export class BIM360Client {
-    private token: string;
-    private host: string;
-
+export class BIM360Client extends ForgeClient {
     /**
      * Initializes new client with specific authentication method.
-     * @param {string} token Authentication token.
+     * @param {IAuthOptions} auth Authentication object,
+     * containing either `client_id` and `client_secret` properties (for 2-legged authentication),
+     * or a single `token` property (for 2-legged or 3-legged authentication with pre-generated access token).
      * @param {string} [host="https://developer.api.autodesk.com"] Forge API host.
+     * @param {Region} [region="US"] Forge availability region ("US" or "EMEA").
      */
-    constructor(token: string, host = DefaultHost) {
-        this.token = token;
-        this.host = host;
-    }
-
-    // Helper method for GET requests
-    private async _get(endpoint: string, headers: { [name: string]: string } = {}) {
-        headers['Authorization'] = 'Bearer ' + this.token;
-        return get(this.host + endpoint, headers);
+    constructor(auth: IAuthOptions, host?: string, region?: Region) {
+        super('', auth, host, region);
     }
 
     // Hub APIs
@@ -73,7 +69,7 @@ export class BIM360Client {
      * @returns {Promise<IHub[]>} List of hubs.
      */
     async hubs(): Promise<IHub[]> {
-        const response = await this._get(`/project/v1/hubs`);
+        const response = await this.get(`/project/v1/hubs`, {}, ReadTokenScopes);
         return response.data;
     }
 
@@ -84,7 +80,7 @@ export class BIM360Client {
      * @returns {Promise<IHub>} Hub or null if there isn't one.
      */
     async hub(id: string): Promise<IHub> {
-        const response = await this._get(`/project/v1/hubs/${id}`);
+        const response = await this.get(`/project/v1/hubs/${id}`, {}, ReadTokenScopes);
         return response.data;
     }
 
@@ -95,7 +91,7 @@ export class BIM360Client {
      * @returns {Promise<IProject[]>} List of projects.
      */
     async projects(hub: string): Promise<IProject[]> {
-        const response = await this._get(`/project/v1/hubs/${hub}/projects`);
+        const response = await this.get(`/project/v1/hubs/${hub}/projects`, {}, ReadTokenScopes);
         return response.data;
     }
 
@@ -107,7 +103,7 @@ export class BIM360Client {
      * @returns {Promise<IFolder[]>} List of folder records.
      */
     async folders(hub: string, project: string): Promise<IFolder[]> {
-        const response = await this._get(`/project/v1/hubs/${hub}/projects/${project}/topFolders`);
+        const response = await this.get(`/project/v1/hubs/${hub}/projects/${project}/topFolders`, {}, ReadTokenScopes);
         return response.data;
     }
 
@@ -119,7 +115,7 @@ export class BIM360Client {
      * @returns {Promise<IItem[]>} List of folder contents.
      */
     async contents(project: string, folder: string): Promise<IItem[]> {
-        const response = await this._get(`/data/v1/projects/${project}/folders/${folder}/contents`);
+        const response = await this.get(`/data/v1/projects/${project}/folders/${folder}/contents`, {}, ReadTokenScopes);
         return response.data;
     }
 
@@ -131,7 +127,7 @@ export class BIM360Client {
      * @returns {Promise<IVersion[]>} List of item versions.
      */
     async versions(project: string, item: string): Promise<IVersion[]> {
-        const response = await this._get(`/data/v1/projects/${project}/items/${item}/versions`);
+        const response = await this.get(`/data/v1/projects/${project}/items/${item}/versions`, {}, ReadTokenScopes);
         return response.data;
     }
 
@@ -143,7 +139,7 @@ export class BIM360Client {
      * @returns {Promise<IVersion>} Tip version of the item.
      */
     async tip(project: string, item: string): Promise<IVersion> {
-        const response = await this._get(`/data/v1/projects/${project}/items/${item}/tip`);
+        const response = await this.get(`/data/v1/projects/${project}/items/${item}/tip`, {}, ReadTokenScopes);
         return response.data;
     }
 }