@salesforce/state-managers-uiapi

Reactive state managers for Lightning Web Components that wrap Salesforce UI API and Apex adapters. Each state manager exposes status, error, data, and config setter functions, and is built on @lwc/state and @salesforce/lds-adapters-uiapi / @salesforce/lds-adapters-apex.

Installation

npm install @salesforce/state-managers-uiapi

Available state managers

| Export | Description | Config | Optional | Exposed to lightning namespace | | ----------------------------------------------------- | ------------------------------------------------------------------ | -------------------------------------- | --------------------------------------------------------- | ------------------------------ | | smApex | Invoke an Apex method. | classname, method, parameters | namespace | | | smLayout | Record or form layout for an object. | objectApiName, layoutType, mode | recordTypeId | ✅ | | smLayoutUserState | User layout state (e.g. collapsed sections). | objectApiName, recordTypeId | formFactor, layoutType, mode | | | smObjectInfo | Metadata for a single object. | objectApiName | — | ✅ | | smObjectInfos | Metadata for multiple objects. | objectApiNames | — | ✅ | | smRecord | A single record’s data. Requires fields and/or optionalFields. | recordId | fields, optionalFields | ✅ | | smRecordActions | Actions for one or more records. | recordIds | sections | | | smRecordAvatars | Avatar data for records. | recordIds | formFactor | | | smRelatedListActions | Actions for a related list. | recordIds, relatedListId | — | | | smRelatedListInfo | Metadata for one related list. | parentObjectApiName, relatedListId | recordTypeId | ✅ | | smRelatedListRecords | Records in a related list. | parentRecordId, relatedListId | fields, optionalFields, pageSize, sortBy, where | ✅ | | smRelatedListsInfo | Metadata for all related lists of a parent object. | parentObjectApiName | recordTypeId | ✅ |

Each state manager is exported as a default (e.g. smRecord) and has an internal variant (e.g. smRecord_internal) for testing or advanced use.

Usage

import { smRecord, smObjectInfo, smApex } from '@salesforce/state-managers-uiapi';

Development

# Install dependencies
npm install

# Build the package
npm run build

# Run tests
npm test

License

See LICENSE.txt for details.