@harperdb/nextjs

A HarperDB Component for running and developing Next.js apps.

Most Next.js features are supported as we rely on the Next.js Server provided by Next.js to run your application.

Tip

Watch a walkthrough of this component in action here: Next.js on HarperDB | Step-by-Step Guide for Next Level Next.js Performance

Usage

Note

This guide assumes you're already familiar with HarperDb Components. Please review the documentation, or check out the HarperDB Next.js Example for more information.

1. Install:

npm install @harperdb/nextjs

2. Add to config.yaml:

'@harperdb/nextjs':
  package: '@harperdb/nextjs'
  files: '/*'

3. Run your app with HarperDB:

harperdb run nextjs-app

Alternatively, you can use the included harperdb-nextjs CLI:

harperdb-nextjs build | dev | start

4. Within any server side code paths, you can use HarperDB Globals after importing the HarperDB package:

// app/actions.js
'use server';

import('harperdb');

export async function listDogs() {
	const dogs = [];
	for await (const dog of tables.Dog.search()) {
		dogs.push({ id: dog.id, name: dog.name });
	}
	return dogs;
}

export async function getDog(id) {
	return tables.Dog.get(id);
}

// app/dogs/[id]/page.jsx
import { getDog, listDogs } from '@/app/actions';

export async function generateStaticParams() {
	const dogs = await listDogs();

	return dogs;
}

export default async function Dog({ params }) {
	const dog = await getDog(params.id);

	return (
		<section>
			<h1>{dog.name}</h1>
			<p>Breed: {dog.get('breed')}</p>
			<p>Woof!</p>
		</section>
	);
}

HarperDB relies on native dependencies and must be configured as an external package. In Next.js v14, update the next.config.js webpack option with:

	webpack: (config) => {
		config.externals.push({
			harperdb: 'commonjs harperdb',
		});

		return config;
	},

Options

All configuration options are optional

buildCommand: string

Specify a custom build command. Defaults to next build.

Note: the extension will skip building if the prebuilt option is set to true

buildOnly: boolean

Build the Next.js application and then exit (including shutting down HarperDB). Defaults to false.

dev: boolean

Enables Next.js dev mode. Defaults to false.

port: number

Specify a port for the Next.js server. Defaults to the HarperDB default port (generally 9926).

prebuilt: boolean

When enabled, the extension will look for a .next directory in the root of the component and skip executing the buildCommand. Defaults to false.

securePort: number

Specify a secure port for the Next.js server. Defaults to the HarperDB default secure port.

CLI

This package includes a CLI (harperdb-nextjs) that is meant to replace certain functions of the Next.js CLI. It will launch HarperDB and set sensible configuration values.

Available commands include:

dev

Launches the application in Next.js development mode, and enables HMR for instantaneous updates when modifying application code.

Note

Dev mode for Next.js v13+ relies on WebSockets. If you encounter an Invalid WebSocket frame: error, disable any other WebSocket services on the Next.js port. This commonly can be the HarperDB MQTT WebSocket service, which can be configured under the mqtt option within harperdb-config.yaml.

build

Builds the application and then exits the process.

start

Launches the application in Next.js production mode.

help

Lists available CLI commands.