Fulcrum Core

The JavaScript object model for Fulcrum.

This library provides a comprehensive object model for Fulcrum data, including:

• Form and record parsing
• Record titles and address formatting
• Date, time, and number localization
• Choice and classification set lookups
• Visibility, requirement, and validation rules
• Default values and emptiness definitions
• JSON serialization and calculation fields
• Support for record links and repeatables

Development

Prerequisites

• Node.js 22+
• yarn

Setup

# Install dependencies
yarn install

Build

# Build the project
yarn build

Tests

# Run all tests
yarn test

Console

Starts an interactive node terminal with the library available for use:

./console

Install

yarn add @fulcrumapp/fulcrum-core
# or
npm install @fulcrumapp/fulcrum-core

Usage

import { Form, Record } from '@fulcrumapp/fulcrum-core';

const form = new Form(formAttributes);
const record = new Record(recordAttributes, form);

// Access record data
console.log(record.id);
console.log(record.formValues.get('field_key').displayValue);

Release

All verison updates are done automatically via CI, please do not change the version value in package.json manually.