simpler-forge-apis

Experimental wrapper around the official Autodesk Forge SDK providing higher-level abstractions and (hopefully) an easier-to-work-with API.

Documentation: https://unpkg.com/simpler-forge-apis@latest/docs/index.html
Completeness: see STATUS.md

Motivation

With the official SDK you have to maintain access tokens yourself which can be a bit of a hassle, and you have to pass tokens to individual API calls. This library handles all of that for you:

// Using the official SDK

let internalAuthClient = new AuthClientTwoLegged(FORGE_CLIENT_ID, FORGE_CLIENT_SECRET, INTERNAL_TOKEN_SCOPES, true);

async function getInternalToken() {
    if (!internalAuthClient.isAuthorized()) {
        await internalAuthClient.authenticate();
    }
    return internalAuthClient.getCredentials();
}

const token = await getInternalToken();
console.log(await new DerivativesApi().getFormats({}, null, token));
console.log(await new DerivativesApi().getManifest(URN, {}, null, token));

// Using this library

const client = new ModelDerivativeClient({ client_id: FORGE_CLIENT_ID, client_secret: FORGE_CLIENT_SECRET });
console.log(await client.getFormats());
console.log(await client.getManifest(URN));

// Or, if you already have an existing token you want to reuse

const client = new ModelDerivativeClient({ access_token: ACCESS_TOKEN });
console.log(await client.getFormats());
console.log(await client.getManifest(URN));

The official SDK typically returns complete response objects (with body, status code, etc.), and when working with endpoints that return lists of data, it typically leaves the pagination or collection to you. This library takes care of that as well:

// Using the official SDK

const token = await getInternalToken();
let response = await new ObjectsApi().getObjects(BUCKET, { limit: 64 }, null, token);
let objects = response.body.items;
while (response.body.next) {
    const startAt = new URL(response.body.next).searchParams.get('startAt');
    response = await new ObjectsApi().getObjects(BUCKET, { limit: 64, startAt }, null, token);
    objects = objects.concat(response.body.items);
}
console.log(objects);

// Using this library

const client = new OSSClient({ client_id: FORGE_CLIENT_ID, client_secret: FORGE_CLIENT_SECRET });
console.log(await client.listObjects(BUCKET));

// Or, paging through the results using the `for await` loop

for await (const batch of client.enumerateObjects(BUCKET)) {
    console.log(batch);
}

When working with different regions, the official SDK sometimes expects these to be provided per each method call, and sometimes per each class instance. And when working with custom hosts, you need to pass in a custom ApiClient object. In this library the region and host are always defined per class instance:

// Using the official SDK

const token = await getInternalToken();
const apiClient = new ApiClient('https://developer-dev.api.autodesk.com');

const bucketsApi = new BucketsApi(apiClient);
let response = await bucketsApi.getBuckets({ limit: 64, region: 'EMEA' }, null, token);
let buckets = response.body.items;
while (response.body.next) {
    const startAt = new URL(response.body.next).searchParams.get('startAt') as string;
    response = await bucketsApi.getBuckets({ limit: 64, startAt, region: 'EMEA' }, null, credentials);
    buckets = buckets.concat(response.body.items);
}
console.log(buckets);

const derivativesApi = new DerivativesApi(apiClient, 'EMEA');
console.log(await derivativesApi.getManifest(URN, {}, null, token));

// Using this library

const options = { region: Region.EMEA, host: 'https://developer-dev.api.autodesk.com' };
const ossClient = new OSSClient({ client_id: FORGE_CLIENT_ID, client_secret: FORGE_CLIENT_SECRET }, options);
console.log(await ossClient.listBuckets());
const mdClient = new ModelDerivativeClient({ client_id: FORGE_CLIENT_ID, client_secret: FORGE_CLIENT_SECRET }, options);
console.log(await mdClient.getManifest(URN));

Usage

Install the library to your project:

# using npm
npm install simpler-forge-apis

# using yarn
yarn add simpler-forge-apis

Import the classes you'll be working with, for example:

// in JavaScript
const { DataManagementClient, ModelDerivativeClient, TwoLeggedAuthProvider } = require('simpler-forge-apis');

// in TypeScript
import { DataManagementClient, ModelDerivativeClient, TwoLeggedAuthProvider } from 'simpler-forge-apis';

Instantiate the clients with specific auth options:

// by passing in an existing access token
let dataManagementClient = new DataManagementClient({ access_token: FORGE_ACCESS_TOKEN });

// by passing in your application's client ID and secret (so each instance will generate its own tokens)
let dataManagementClient = new DataManagementClient({ client_id: FORGE_CLIENT_ID, client_secret: FORGE_CLIENT_SECRET });

// by passing in a shared 2-legged OAuth provider
let twoLeggedAuthProvider = new TwoLeggedAuthProvider(FORGE_CLIENT_ID, FORGE_CLIENT_SECRET);
let dataManagementClient = new DataManagementClient(twoLeggedAuthProvider);
let modelDerivativeClient = new ModelDerivativeClient(twoLeggedAuthProvider);

// by passing in a custom auth provider
const customAuthProvider = {
    async getToken(scopes) {
        // Get the token for the given set of scopes from somewhere, for example, from a database.
        // The returned object should contain 3 properties: `access_token` (the actual token string),
        // `token_type` (always "Bearer"), and `expires_in` (expiration time in seconds).
        return { access_token: '...', token_type: 'Bearer', expires_in: 3599 };
    }
};
let dataManagementClient = new DataManagementClient(customAuthProvider);

petrbroz/simpler-forge-apis

simpler-forge-apis

Motivation

Usage