lattice

library0.98.0jsnpmunverified

JavaScript SDK for all OpenLattice REST APIs, version 0.98.0. Provides a thin wrapper around OpenLattice's REST endpoints to standardize data models and formats, simplifying reading and writing data. Uses Immutable.js (v4.0.0-rc.10) and lodash (>=4.17.21) as peer dependencies. Unlike raw REST calls, it handles normalization and offers a consistent API. Release cadence is irregular, tied to OpenLattice platform updates. Note that the immutable peer dependency uses a release candidate version, which may cause compatibility issues.

data

npm install lattice

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · LATTICE

lattice

datajavascriptv0.98.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default

✓ import LatticeClient from 'lattice'

✗ const LatticeClient = require('lattice').default

Default export. In CJS, you need .default.

LatticeClient

✓ import { LatticeClient } from 'lattice'

✗ import { LatticeClient } from 'lattice' is incorrect if using CJS require('lattice').LatticeClient

Named export for the client class.

Models

✓ import { Models } from 'lattice'

✗ const { Models } = require('lattice')

Models is a named export containing data model constructors.

Initializes the LatticeClient with authorization and searches an entity set.

import LatticeClient from 'lattice'; import { Map } from 'immutable'; const client = new LatticeClient({ baseUrl: 'https://api.openlattice.com', authorization: process.env.OPENLATTICE_AUTH_TOKEN || '' }); async function example() { const entities = await client.search.searchEntitySetData({ entitySetId: 'your-entity-set-id', filter: Map({}): any }); console.log('Entities:', entities); } example().catch(console.error);

Debug

Known issues

gotchaImmutable.js peer dependency uses version 4.0.0-rc.10 which is a release candidate and may have breaking changes in final release.

fix

Pin immutable to 4.0.0-rc.10 and monitor for updates.

affects: >=0.98.0

deprecatedSome API methods may be deprecated as OpenLattice updates their REST APIs.

fix

Check library documentation for latest method signatures.

affects: >=0.98.0

breakingVersion 0.98.0 may contain breaking changes from earlier 0.x versions due to rapid development.

fix

Review changelog before upgrading.

affects: >=0.98.0

Errors

Common errors & fixes

Cannot find module 'immutable'

Peer dependency immutable is not installed.

fix

npm install immutable@4.0.0-rc.10

UnhandledPromiseRejectionWarning: TypeError: client.search is not a function

Using the wrong client method or import path.

fix

Ensure you instantiate LatticeClient correctly and use methods as per documentation.

Upgrade

Version history

0.98.0latest on npm

Audit

Dependencies

immutablerequiredData structures are Immutable.js Record types

lodashrequiredUtility functions used internally

Agent activity

10 hits · last 30 days

node

Amazon

Resources

githubhttps://github.com/openlattice/lattice-js ↗

packagelattice ↗

homepagehttps://github.com/openlattice/lattice-js ↗