https://github.com/dronedeploy/function-wrapper
Javascript module to interact with dronedeploy api from within a dronedeploy function.
https://github.com/dronedeploy/function-wrapper
owner-magic-ai tier3
Last synced: 5 months ago
JSON representation
Javascript module to interact with dronedeploy api from within a dronedeploy function.
- Host: GitHub
- URL: https://github.com/dronedeploy/function-wrapper
- Owner: dronedeploy
- License: mit
- Created: 2018-04-30T16:50:20.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2026-01-13T16:43:25.000Z (5 months ago)
- Last Synced: 2026-01-13T18:42:54.908Z (5 months ago)
- Topics: owner-magic-ai, tier3
- Language: JavaScript
- Homepage:
- Size: 619 KB
- Stars: 2
- Watchers: 55
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Drondeploy Functions API
========================
Installation
============
Install via
`npm install --save @dronedeploy/function-wrapper`
How to use this repo in your DroneDeploy function
==========
In your index.js
Import the module like so
```javascript
const bootstrap = require('@dronedeploy/function-wrapper');
```
or with Typescript:
```typescript
import bootstrap from "@dronedeploy/function-wrapper";
```
The bootstrap method handles
- Authentication
- Default HTTP responses for auth failure, and OPTIONS routes
- Setting up CORS Headers
The ctx object will have all the api methods available
and references to the jwt token in both raw and decrypted form.
The recommended usage is to import a file named handler.js, where most of the developers code lives. handler.js should expose one public method
```javascript
// handler.js
module.exports = (req, res, ctx) => {
}
```
```javascript
// index.js
exports.dronedeploy = bootstrap((ctx) => (req, res) => handler(req, res, ctx));
```
Temporarily for testing purposes you can override the `ctx.originalToken`, if you set `MOCK_TOKEN=true` and `AUTH_REQUIRED=false` in the `.env` file.
Api Methods
================
table(tableId)
Methods on the table object
- addRow(externalKey, data)
- editRow(externalKey, data)
- upsertRow(externalKey, data) // subject to change
Example Response for add, edit, upsert
```javascript
{ ok: true,
data:
{ id: 'TableData:5ae711f72852b900016b0895',
application: { id: 'Application:lonvecnbfyvovfqsvbxz' },
data: { name: 'Michael Hernandez' },
externalKey: 'mhernandez+test@dronedeploy.com-user-information',
table: { id: 'Table:5ada2d8f27b7b90001b9c40a' }
}
}
```
- getRow(externalKey)
Example Response for get
```javascript
{ ok: true, data: { name: 'Michael Hernandez' } }
```
- deleteRows(externalKeys)
Example Response for delete
```javascript
{ ok: true, data: { count: 1 } }
```
Example handler showing the aformentioned methods in use, also see file `examples/basic.js`
```javascript
function handler(req, res, ctx) {
// this is for mocking token.
ctx.originalToken = process.argv[2] // or switch this out for yours.;
// Get the users tables
let users = ctx
.datastore
.table('Table:5ada2d8f27b7b90001b9c40a');
users
// .addRow('mhernandez+test@dronedeploy.com', {name: 'Michaxel Hernandez'})
// .editRow('mhernandez+test@dronedeploy.com', {name: 'Michaxel Hernandez'})
.upsertRow('mhernandez+test@dronedeploy.com', {name: 'Michaxel Hernandez'})
.then(result => {
console.log(util.inspect(result, {depth: 20, colors: true}));
})
.then(() => {
users
.getRowByExternalId('mhernandez+test@dronedeploy.com')
.then((result) => {
console.log(util.inspect(result, {depth: 20, colors: true}));
})
})
.catch(e => {
console.log(e);
});
}
```
Or TypeScript (see `examples-typescript/basic-typescript.ts`:
```typescript
async function handler(req: Request, res: Response, ctx: Context) {
// this is for mocking token.
ctx.originalToken = process.argv[2];
return ctx
.as(ownerJWT, true)
.datastore
.ensure('zqyjaheaxvszfgrtdiep', 'new_table_1', 'mydescription',
[{
input: {
columnType: "TEXT",
name: "name",
textLength: 255,
description: "Users name",
}
}])
.then((tableId: string) => findTableByName(ctx, 'new_table_1', tableId))
.then((tableId: string) => ctx.datastore.table(tableId))
.then((users: Table) => {
users
.upsertRow('mhernandez+test@dronedeploy.com', {name: 'Michaxel Hernandez'})
.then((result: DatastoreResponse) => {
console.log(inspect(result, {depth: 20, colors: true}));
})
.then(() => {
users
.getRowByExternalId('mhernandez+test@dronedeploy.com')
.then((result) => {
console.log(inspect(result, {depth: 20, colors: true}));
})
})
.catch(e => {
console.log(e);
});
}).catch(console.error);
}
export default async function func(req: Request, res: Response) {
return bootstrap(config, req, res, (err: Error, ctx: Context) => {
// Common headers should have been set automatically.
// Common requests like OPTIONS should have been handled automatically.
if (err) {
console.error(err, err.stack);
console.warn('An error occurred during the bootstrapping process. A default response has been sent and code paths have been stopped.');
return;
}
return handler(req, res, ctx);
});
}
```
Configuration
================
Configuration in `.env` file:
- `AUTH_REQUIRED=`, set to false for testing or if your function does not use dd's api's
- `MOCK_TOKEN=`, // set to true to allow token
- `CORS_HEADERS=` // add custom headers that should be allowed past cors here
- `IGNORE_AUTH_ROUTES=` // add routes to ignore while checking auth
Example
```
AUTH_REQUIRED=false
MOCK_TOKEN=true
CORS_HEADERS=x-custom-token,x-some-other-allowed-header
IGNORE_AUTH_ROUTES=/route/1,/route/2
```
These env variables can be also set in the code:
```javascript
process.env.AUTH_REQUIRED = false
process.env.MOCK_TOCKEN = true
process.env.CORS_HEADERS = ['x-custom-token', 'x-some-other-allowed-header']
process.env.AUTH_REQUIRED = ['/route/1', '/route/2']
```