@alneas/data-access API Reference

@alneas/data-access API Reference

FUNCTION normalizePopulateOptions

Normalizes PopulateOptions (including legacy field name support).

export function normalizePopulateOptions(p: PopulateOptions):

Parameters

Parameter	Type	Required	Description
p	PopulateOptions	Yes

Returns

• Type: { collection: string; localRef: string; foreignRef: string; as: string; unwind: boolean; }

---

TYPE FetchLike

Standard fetch call signature; custom transports need no runtime-specific helper properties.

type FetchLike

---

TYPE Filter

Filter criteria for record retrieval.

Filter operators align with regional-edi x-rules:

• $eq (eq): Equals
• $neq (neq): Not equals
• $lt (lt), $lte (lte): Less than / Less than or equal to
• $gt (gt), $gte (gte): Greater than / Greater than or equal to
• $in (in): Included in array
• $nin (nin): Not included in array
• $regex: Regular expression match

type Filter

---

TYPE DocType

regional-edi document type. Used for filtering and validation by doc_type.

type DocType

---

INTERFACE QueryOptions

Search query options.

interface QueryOptions

---

INTERFACE PopulateOptions

Configuration for populating related data. Field names are based on regional-edi terminology.

interface PopulateOptions

---

INTERFACE DataAccessAdapter

Abstract adapter interface for data access.

interface DataAccessAdapter

---

INTERFACE OperationResult

Represents outcome details of a database operation.

interface OperationResult

---

INTERFACE SearchableSelectOption

Represents a single search candidate option.

interface SearchableSelectOption

---

INTERFACE HeaderMapping

Definition for mapping a CSV column to a database field.

interface HeaderMapping

---

INTERFACE UploadProgress

Represents upload progress and results.

interface UploadProgress

---

FUNCTION getAdapterCacheScope

Opaque, runtime-local identity; never derives cache keys from credentials or user data.

export function getAdapterCacheScope(adapter: object &

Parameters

Parameter	Type	Required	Description
adapter	object & { readonly cacheScope?: string; }	Yes

Returns

• Type: string

---