npm

Need private packages and team management tools?Check out npm Orgs. »

coda-js

1.0.3 • Public • Published

Coda - Node API

An eloquent Node API for interacting with your Coda Docs. This API utilizes the Coda REST API (beta).


Features

  • list or get specific Folder, Section, Doc, Table, Column, and Row information
  • query, insert, update, or delete table data
  • more formatting options than Coda's REST API for inserting or retrieving row values
  • an eloquent API (see examples)

Installing

Using npm:

$ npm install --save coda-js

Usage

This API uses the same method names as found in the Coda Docs (beta). Review them for additional methods. Note that using item IDs is best (doesn't change), but each parameter that accepts an ID also accepts the name for convenience. All methods can be used from the base instance or from their respective parent. For example:

// uses two requests, but makes sense when you don't know all information ahead of time
const doc = await coda.getDoc('O7d9JvX0GY');
const table = await doc.getTable('grid-_14oaR8gdM');

could be consolidated into:

// uses only one request, which is best when you already know the exact IDs to get the item(s) directly
await coda.getTable('O7d9JvX0GY', 'grid-_14oaR8gdM');

Notice

Be aware that inserting, updating, and deleting methods are not synchronous. They return true if the operation successfully added the request to Coda's API queue. It does not directly mean that the operation was successful or that it is complete. Because of this, it is strongly discouraged (in Coda docs) to query after performing one of these operations because the inserted/updated/deleted data may not have been processed yet.

Token

Generate your token in your Coda profile settings. Notice: Everyone with this token has full access to all your docs! It is recommended to not use this client-side or anywhere your API token could be found.

TODOs

  • pull from process.env.CODA_API_TOKEN if not passed into constructor
  • create tests (may be difficult because of non-synchronous nature of Coda API and also non-private API tokens)
  • add formulas and controls API
  • error handling (throw exception for API user to handle - pass reason; see possible error codes under each request)

Examples

Please note that the examples are currently only displaying async/await usage. You may use any strategy to handle the returned promises.

Testing Connection

import Coda from 'coda-js';
 
const coda = new Coda('**********-********-*********'); // insert your token
 
// trick for using async in a script
(async () => {
 
    const whoAmI = await coda.whoAmI();
    console.log(whoAmI);
 
})().catch(error => console.log(error));

Retrieving Data (List/Get)

const docs = await coda.listDocs();
console.log(docs);
 
const firstDoc = docs[0];
const firstDocTables = await firstDoc.listTables();
console.log(firstDocTables);
 
const someTableColumns = firstDocTables[0].listColumns();
console.log( columns.map(column => column.name) ); // list column names
 
const table = docs.getTable('grid-**********'); // insert/inject table name or ID here
const rows = await table.listRows({
    useColumnNames: true, // param to display column names rather than key
});
const firstRow = rows[0];
console.log(firstRow.values); // column/value pairs
console.log(firstRow.listValues()); // each column is object with column and value properties

Inserting

Inserting also has a second parameter of keyColumns that allows for an "upsert". See Coda documentation for details.

// inserting using object
await table.insertRows([
    { 
        'Name': 'Jacob',
        'Action': 'Take out the trash',
        'Completed': true,
    },
]);
 
// inserting via column objects
await table.insertRows([
    [
        { column: 'Name', value: 'Alexis' },
        { column: 'Action', value: 'Do the dishes' },
    ],
    [
        { column: 'Name', value: 'Parker' },
        { column: 'Action', value: 'Make dinner' },
        { column: 'Completed', value: true },
    ],
]);

Updating

// updating (using column name instead of ID)
await table.updateRow('i-cpDDo9hAEU', {
    'Completed': false,
});
 
// updating via column objects
await table.updateRow('i-dF2-OoiiUi', [
    { column: 'Action', value: 'Make the bed' },
]);
 
// updating off of an already fetched row
await row2.update({ 
    'ai-dRD9afcc8': 'To the moon, Alice!',
});

Deleting

// delete row directly
const row4 = await table.getRow('i-Ef2-OoZxIi');
await row4.delete();
 
// delete row from table
await table.deleteRow('i-cpDDoshUEU');

install

npm i coda-js

Downloadsweekly downloads

56

version

1.0.3

license

ISC

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability