@homeflow/next

HomeflowNEXT

API

The API module can only be used server-side. It will throw an error if you try to use it in a client component.

Setup

Instantiate a new instance of the API class in a suitable setup file.

import API from 'homeflownext/api';

const api = new API({
  hestiaURL: process.env.HESTIA_URL,
  hestiaKey: process.env.HESTIA_KEY,
  siteHost: process.env.SITE,
  log: true,
});

export default api;

Site

const site = await api.Site();

Content Chunks

// find a chunk by name
const homeHeroChunk = await api.ContentChunk.find({ name: 'home_hero' });

County

// find a county by url label (slug)
const county = await api.County.find({ urlLabel: 'aberdeenshire' });

Local Development

Tests may not run correctly on older Node versions. Make sure you run nvm use to use the Node version specified in the .nvmrc

Run yarn docs to generate documentation.

Tests

As this package is a combination of client-side and server-side components, Jest is configured to use different environments for each. For this to work, server-side test files must use the extension .node.spec.ts. Client-side tests should use .spec.ts.

Run yarn test to run all tests.

Use yarn test --coverage to generate a coverage report to identify areas of code missing tests.