# forge-server-utils > Tools for accessing Autodesk Forge APIs from Node.js apps and from browser. Latest version **9.0.5** (published 2024-01-24) · MIT license · 0 weekly downloads ## Install ```sh npm install forge-server-utils pnpm add forge-server-utils yarn add forge-server-utils bun add forge-server-utils ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 9.0.5 | | Published | 2024-01-24 | | First published | 2019-07-31 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 8 | | Unpacked size | 5.5 MB | | Known vulnerabilities | 0 (+7 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 41 | | Author | Petr Broz | | Maintainers | petrbroz | | Keywords | autodesk, forge, api, node.js, typescript | ## Links - npm: https://www.npmjs.com/package/forge-server-utils - Repository: https://github.com/petrbroz/forge-server-utils - Homepage: https://github.com/petrbroz/forge-server-utils#readme - Issues: https://github.com/petrbroz/forge-server-utils/issues - npm.io page: https://npm.io/package/forge-server-utils ## Dependencies (8) - [axios](https://npm.io/package/axios.md) ^1.4.0 - [adm-zip](https://npm.io/package/adm-zip.md) ^0.4.13 - [fs-extra](https://npm.io/package/fs-extra.md) ^8.1.0 - [form-data](https://npm.io/package/form-data.md) ^2.5.1 - [retry-axios](https://npm.io/package/retry-axios.md) ^2.6.0 - [@types/adm-zip](https://npm.io/package/@types/adm-zip.md) ^0.4.32 - [@types/fs-extra](https://npm.io/package/@types/fs-extra.md) ^8.0.0 - [node-polyfill-webpack-plugin](https://npm.io/package/node-polyfill-webpack-plugin.md) ^3.0.0 ## Alternatives - [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads - [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads - [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads - [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads - [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads ## Recent versions - 9.0.5 (latest) — 2024-01-24 - 9.0.0 — 2022-08-19 - 8.4.0 — 2022-07-04 - 8.3.5 — 2022-01-05 - 8.3.4 — 2021-11-01 - 8.3.3 — 2021-09-27 - 8.3.2 — 2021-03-09 - 8.3.1 — 2021-02-04 - 8.3.0 — 2021-02-04 - 8.2.2 — 2021-01-06 - 8.2.1 — 2020-11-20 - 8.2.0 — 2020-10-29 - 8.1.7 — 2020-09-11 - 8.1.6 — 2020-08-12 - 8.1.5 — 2020-07-21 - … 46 more at https://npm.io/package/forge-server-utils/versions ## README # forge-server-utils ![Publish to NPM](https://github.com/petrbroz/forge-server-utils/workflows/Publish%20to%20NPM/badge.svg) [![npm version](https://badge.fury.io/js/forge-server-utils.svg)](https://badge.fury.io/js/forge-server-utils) ![node](https://img.shields.io/node/v/forge-server-utils.svg) ![npm downloads](https://img.shields.io/npm/dw/forge-server-utils.svg) ![platforms](https://img.shields.io/badge/platform-windows%20%7C%20osx%20%7C%20linux-lightgray.svg) [![license](https://img.shields.io/badge/license-MIT-blue.svg)](http://opensource.org/licenses/MIT) Unofficial tools for accessing [Autodesk Forge](https://developer.autodesk.com/) APIs from Node.js applications and from browsers, built using [TypeScript](https://www.typescriptlang.org) and modern language features like [async/await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function) or [generators](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function*). ![Autodesk Forge](docs/logo.png) ## Usage ### Server Side The TypeScript implementation is transpiled into CommonJS JavaScript module with type definition files, so you can use it both in Node.js projects, and in TypeScript projects: ```js // JavaScript const { DataManagementClient } = require('forge-server-utils'); ``` ```ts // TypeScript import { DataManagementClient, IBucket, IObject, IResumableUploadRange, DataRetentionPolicy } from 'forge-server-utils'; ``` #### Authentication If you need to generate [2-legged tokens](https://forge.autodesk.com/en/docs/oauth/v2/tutorials/get-2-legged-token) manually, you can use the `AuthenticationClient` class: ```js const { AuthenticationClient } = require('forge-server-utils'); const { FORGE_CLIENT_ID, FORGE_CLIENT_SECRET } = process.env; const auth = new AuthenticationClient(FORGE_CLIENT_ID, FORGE_CLIENT_SECRET); const authentication = await auth.authenticate(['bucket:read', 'data:read']); console.log('2-legged token', authentication.access_token); ``` Other API clients in this library are typically configured using a simple JavaScript object containing either `client_id` and `client_secret` properties (for 2-legged authentication), or a single `token` property (for authentication using a pre-generated access token): ```js const { DataManagementClient, BIM360Client } = require('forge-server-utils'); const dm = new DataManagementClient({ client_id: '...', client_secret: '...' }); const bim360 = new BIM360Client({ token: '...' }); ``` #### Data Management ```js const { DataManagementClient } = require('forge-server-utils'); const { FORGE_CLIENT_ID, FORGE_CLIENT_SECRET } = process.env; const data = new DataManagementClient({ client_id: FORGE_CLIENT_ID, client_secret: FORGE_CLIENT_SECRET }); const buckets = await data.listBuckets(); console.log('Buckets', buckets.map(bucket => bucket.bucketKey).join(',')); const objects = await data.listObjects('foo-bucket'); console.log('Objects', objects.map(object => object.objectId).join(',')); ``` #### Model Derivatives ```js const { ModelDerivativeClient } = require('forge-server-utils'); const { FORGE_CLIENT_ID, FORGE_CLIENT_SECRET } = process.env; const derivatives = new ModelDerivativeClient({ client_id: FORGE_CLIENT_ID, client_secret: FORGE_CLIENT_SECRET }); const job = await derivatives.submitJob('', [{ type: 'svf', views: ['2d', '3d'] }]); console.log('Job', job); ``` #### Design Automation ```js const { DesignAutomationClient } = require('forge-server-utils'); const { FORGE_CLIENT_ID, FORGE_CLIENT_SECRET } = process.env; const client = new DesignAutomationClient({ client_id: FORGE_CLIENT_ID, client_secret: FORGE_CLIENT_SECRET }); const bundles = await client.listAppBundles(); console.log('App bundles', bundles); ``` #### Reality Capture ```js const { OutputFormat, RealityCaptureClient, SceneType } = require('forge-server-utils'); const { FORGE_CLIENT_ID, FORGE_CLIENT_SECRET } = process.env; const recap = new RealityCaptureClient({ client_id: FORGE_CLIENT_ID, client_secret: FORGE_CLIENT_SECRET }); const options = { scenename: '', scenetype: SceneType.Aerial, format: OutputFormat.RecapPhotoMesh, callback: '' }; const photoscene = await recap.createPhotoScene(options); console.log('Photoscene', photoscene); ``` ### Client Side (experimental) The transpiled output from TypeScript is also bundled using [webpack](https://webpack.js.org), so you can use the same functionality in a browser. There is a caveat, unfortunately: at the moment it is not possible to request Forge access tokens from the browser due to [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) limitations, so when creating instances of the various clients, instead of providing client ID and secret you will have to provide the token directly. ```html ``` Note that you can also request a specific version of the library from CDN by appending `@` to the npm package name, for example, `https://cdn.jsdelivr.net/npm/forge-server-utils@4.0.0/dist/browser/forge-server-utils.js`. ## Testing ```bash export FORGE_CLIENT_ID= export FORGE_CLIENT_SECRET= export FORGE_BUCKET= export FORGE_MODEL_URN= yarn run build # Transpile TypeScript into JavaScript yarn test ``` --- _Source: https://npm.io/package/forge-server-utils · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._