Merge branch 'release/v0.2.0'

Author: petrbroz

README.md

@@ -26,11 +26,20 @@ for await (const buckets of await data.buckets()) {
     console.log('Buckets', buckets.map(bucket => bucket.bucketKey).join(','));
 }
 // List objects in bucket
-for await (const objects of data.objects("foo-bucket")) {
+for await (const objects of data.objects('foo-bucket')) {
     console.log('Objects', objects.map(object => object.objectId).join(','));
 }
 ```
 
+### Model Derivatives
+
+```js
+const { ModelDerivativeClient, AuthenticationClient } = require('autodesk-forge-tools');
+const derivatives = new ModelDerivativeClient(new AuthenticationClient());
+const job = await derivatives.submitJob('<your-document-urn>', [{ type: 'svf', views: ['2d', '3d'] }]);
+console.log('Job', job);
+```
+
 ## Testing
 
 ```bash

docs/tutorials/deriv-basic.md

@@ -0,0 +1,8 @@
+# Basic usage of model derivative APIs
+
+```js
+const { ModelDerivativeClient, AuthenticationClient } = require('autodesk-forge-tools');
+const derivatives = new ModelDerivativeClient(new AuthenticationClient());
+const job = await derivatives.submitJob('<your-document-urn>', [{ type: 'svf', views: ['2d', '3d'] }]);
+console.log('Job', job);
+```

docs/tutorials/index.json

@@ -4,5 +4,8 @@
     },
     "data-basic": {
         "title": "Basic Data Management"
+    },
+    "deriv-basic": {
+        "title": "Basic Model Derivatives"
     }
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "autodesk-forge-tools",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Tools for accessing Autodesk Forge APIs from Node.js apps.",
   "main": "src/index.js",
   "scripts": {

src/data.js

@@ -9,6 +9,7 @@ const WriteTokenScopes = ['bucket:create', 'data:write'];
 
 /**
  * Client providing access to Autodesk Forge {@link https://forge.autodesk.com/en/docs/data/v2|data management APIs}.
+ * @tutorial data-basic
  */
 class DataManagementClient {
     /**

src/deriv.js

@@ -0,0 +1,65 @@
+const { get, post, put } = require('./request');
+const { AuthenticationClient } = require('./auth');
+
+const RootPath = '/modelderivative/v2';
+const ReadTokenScopes = ['data:read'];
+const WriteTokenScopes = ['data:read', 'data:write', 'data:create'];
+
+/**
+ * Client providing access to Autodesk Forge
+ * {@link https://forge.autodesk.com/en/docs/model-derivative/v2|model derivative APIs}.
+ * @tutorial deriv-basic
+ */
+class ModelDerivativeClient {
+    /**
+     * Initializes new client with specific Forge app credentials.
+     * @param {AuthenticationClient} auth Authentication client used to obtain tokens
+     * for all requests.
+     */
+    constructor(auth) {
+        this.auth = auth;
+    }
+
+    /**
+     * Gets a list of supported translation formats.
+     * ({@link https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/formats-GET|docs}).
+     * @async
+     * @yields {Promise<object>} Dictionary of all supported output formats
+     * mapped to arrays of formats these outputs can be obtained from.
+     * @throws Error when the request fails, for example, due to insufficient rights.
+     */
+    async formats() {
+        const authentication = await this.auth.authenticate(ReadTokenScopes);
+        const response = await get(`${RootPath}/designdata/formats`, { 'Authorization': 'Bearer ' + authentication.access_token });
+        return response.formats;
+    }
+
+    /**
+     * Submits a translation job
+     * ({@link https://forge.autodesk.com/en/docs/model-derivative/v2/reference/http/job-POST|docs}).
+     * @async
+     * @param {string} urn Document to be translated.
+     * @param {object[]} outputs List of requested output formats. Currently the one
+     * supported format is `{ type: 'svf', views: ['2d', '3d'] }`.
+     * @returns {Promise<object>} Translation job details, with properties 'result',
+     * 'urn', and 'acceptedJobs'.
+     * @throws Error when the request fails, for example, due to insufficient rights.
+     */
+    async submitJob(urn, outputs) {
+        const authentication = await this.auth.authenticate(WriteTokenScopes);
+        const params = {
+            input: {
+                urn: urn
+            },
+            output: {
+                formats: outputs
+            }
+        };
+        const response = await post(`${RootPath}/designdata/job`, { json: params }, { 'Authorization': 'Bearer ' + authentication.access_token });
+        return response;
+    }
+}
+
+module.exports = {
+    ModelDerivativeClient
+};

src/index.js

@@ -1,7 +1,9 @@
 const { AuthenticationClient } = require('./auth');
 const { DataManagementClient } = require('./data');
+const { ModelDerivativeClient } = require('./deriv');
 
 module.exports = {
     AuthenticationClient,
-    DataManagementClient
+    DataManagementClient,
+    ModelDerivativeClient
 };

test/data.js

@@ -11,12 +11,14 @@ describe('DataManagementClient', function() {
         const auth = new AuthenticationClient(FORGE_CLIENT_ID, FORGE_CLIENT_SECRET);
         this.client = new DataManagementClient(auth);
         this.bucket = FORGE_BUCKET;
+        this.timeout(5000); // Increase timeout to 5 seconds
     });
 
     describe('buckets()', function() {
         it('should return a list of buckets', async function() {
-            for await (const buckets of this.client.buckets()) {
+            for await (const buckets of this.client.buckets(8)) {
                 assert(buckets.length > 0);
+                break; // Skip additional pages
             }
         });
     });
@@ -52,7 +54,7 @@ describe('DataManagementClient', function() {
 
     describe('objects()', function() {
         it('should return a list of objects', async function() {
-            for await (const objects of this.client.objects(this.bucket)) {
+            for await (const objects of this.client.objects(this.bucket, 8)) {
                 assert(objects.length > 0);
                 break; // Skip additional pages
             }

test/deriv.js

@@ -0,0 +1,29 @@
+const assert = require('assert');
+
+const { AuthenticationClient, ModelDerivativeClient } = require('..');
+
+describe('ModelDerivativeClient', function() {
+    beforeEach(function() {
+        const { FORGE_CLIENT_ID, FORGE_CLIENT_SECRET } = process.env;
+        assert(FORGE_CLIENT_ID);
+        assert(FORGE_CLIENT_SECRET);
+        const auth = new AuthenticationClient(FORGE_CLIENT_ID, FORGE_CLIENT_SECRET);
+        this.client = new ModelDerivativeClient(auth);
+        this.urn = 'dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6cGV0cmJyb3otZGF0YXNhbXBsZXMvYmFzaWMucnZ0';
+    });
+
+    describe('formats()', function() {
+        it('should return a list of formats', async function() {
+            const formats = await this.client.formats();
+            assert(formats);
+        });
+    });
+
+    describe('submitJob()', function() {
+        it('should return a job info', async function() {
+            const job = await this.client.submitJob(this.urn, [{ type: 'svf', views: ['2d', '3d'] }]);
+            assert(job);
+            assert(job.result);
+        });
+    });
+});