Class TypeInfoORMService

TypeInfo-driven ORM service with optional DAC and indexing integrations.

Implements

TypeInfoORMAPI

Index

Constructors

Methods

addOperationObserver buildIndexValueFields buildIndexWriteContext cleanupOrphanedIndexState cleanupRelationships cleanupRemovedTypeIndexState create createRelationship decodeFullScanCompareCursor delete deleteRelationship emitIndexWrite emitListRoutingDecision emitOperationObservation encodeFullScanCompareCursor getCleanItem getCleanSelectedFields getIndexedFieldCapabilities getIndexedItemSnapshot getIndexingRelationshipDriverInternal getIndexMaintenanceTypeDescriptors getObservedOperationQueryFingerprint getObservedOperationTypeName getTypeInfo indexItemIndexes inspectStoredTypeIndexesPage isIndexValue list listByFullScanAndCompare listRelatedItems listRelationships listStructuredIndexDocuments listTextIndexDocuments mutateItemIndexPlan read reconcileStoredTypeIndexesPage reindexStoredItem reindexStoredType removeItemIndexes replaceItemIndexes resolveIndexFields resolveIndexOrderBy update validate validateDeleteOperation validateReadOperation validateRelationshipItem validateUpdateConfig verifyStoredItemForIndexMaintenance verifyStoredItemIndexesForMaintenance wrapObservedOperation

Properties

config

Constructors

constructor

new TypeInfoORMService(config: TypeInfoORMServiceConfig): TypeInfoORMService
Parameters
- config: TypeInfoORMServiceConfig
  ORM service configuration.
Returns TypeInfoORMService
- Defined in api/ORM/TypeInfoORMService.ts:913

Methods

addOperationObserver

addOperationObserver(observer: TypeInfoORMOperationObserver): () => void
Subscribe to public ORM operation observations.

This allows optional systems such as Health to attach to an already configured ORM instance without rebuilding its application configuration.
Parameters
- observer: TypeInfoORMOperationObserver
  Observation callback.
Returns () => void
Function that removes the observer.
- Defined in api/ORM/TypeInfoORMService.ts:670

`Protected`buildIndexValueFields

buildIndexValueFields(
typeName: string,
item: Partial<TypeInfoDataItem>,
): StructuredDocFieldsRecord
Parameters
- typeName: string
  Type name for field mapping.
- item: Partial<TypeInfoDataItem>
  Item to extract structured fields from.
Returns StructuredDocFieldsRecord
Structured fields record for indexing.
- Defined in api/ORM/TypeInfoORMService.ts:1524

`Protected`buildIndexWriteContext

buildIndexWriteContext(typeName: string): StructuredWriteContext
Build qualified Link & Lock field metadata, including optional fields.
Parameters
- typeName: string
Returns StructuredWriteContext
- Defined in api/ORM/TypeInfoORMService.ts:1572

cleanupOrphanedIndexState

cleanupOrphanedIndexState(
    typeName: string,
    primaryFieldValue: LiteralValue,
    config?: TypeInfoORMOrphanIndexCleanupConfig,
): Promise<TypeInfoORMOrphanIndexCleanupResult>
Safely clean orphaned index state for exactly one type+id.

The method refuses destructive cleanup without a strongly consistent canonical read. It rechecks canonical state after destructive phases and reindexes a concurrently-created item before returning.
Parameters
- typeName: string
  TypeInfo type being repaired.
- primaryFieldValue: LiteralValue
  Canonical item identifier.
- config: TypeInfoORMOrphanIndexCleanupConfig = {}
  Guard data captured during the audit.
Returns Promise<TypeInfoORMOrphanIndexCleanupResult>
Guarded cleanup outcome.
- Defined in api/ORM/TypeInfoORMService.ts:1756

`Protected`cleanupRelationships

cleanupRelationships(
relationshipOriginatingItem: ItemRelationshipOriginatingItemInfo,
): Promise<void>
Parameters
- relationshipOriginatingItem: ItemRelationshipOriginatingItemInfo
  Relationship originating item used for cleanup.
Returns Promise<void>
Promise resolved once cleanup is complete.
- Defined in api/ORM/TypeInfoORMService.ts:2970

cleanupRemovedTypeIndexState

cleanupRemovedTypeIndexState(
primaryFieldValue: LiteralValue,
config: TypeInfoORMRemovedTypeIndexCleanupConfig,
): Promise<TypeInfoORMRemovedTypeIndexCleanupResult>
Remove one removed-Type index identity after the schema removal has been independently confirmed by Health monitoring.

This method never touches canonical data. It only removes index artifacts belonging to the prior type namespace.
Parameters
- primaryFieldValue: LiteralValue
  Persisted document identity.
- config: TypeInfoORMRemovedTypeIndexCleanupConfig
  Prior type descriptor and audited index state.
Returns Promise<TypeInfoORMRemovedTypeIndexCleanupResult>
- Defined in api/ORM/TypeInfoORMService.ts:2241

create

create(typeName: string, item: TypeInfoDataItem): Promise<any>
Create a new item of the given type.
Parameters
- typeName: string
  Type name to create.
- item: TypeInfoDataItem
  Item payload to create.
Returns Promise<any>
Primary field value for the created item.
Implementation of TypeInfoORMAPI.create
- Defined in api/ORM/TypeInfoORMService.ts:3370

createRelationship

createRelationship(
relationshipItem: BaseItemRelationshipInfo,
context?: TypeInfoORMContext,
): Promise<boolean>
Create a new relationship between two items.
Parameters
- relationshipItem: BaseItemRelationshipInfo
  Relationship item to create.
  
  When DAC is enabled and getOwnerPrefix is configured, relationship creation requires:
  
  relationship permission on the relationship resource path, and
  
  endpoint ownership permission for both from and to items.
- Optionalcontext: TypeInfoORMContext
Returns Promise<boolean>
True when the relationship was created.
Implementation of TypeInfoORMAPI.createRelationship
- Defined in api/ORM/TypeInfoORMService.ts:2993

`Protected`decodeFullScanCompareCursor

decodeFullScanCompareCursor(cursor?: string): number
Parameters
- Optionalcursor: string
  Cursor from list config.
Returns number
Decoded offset for full-scan compare pagination.
- Defined in api/ORM/TypeInfoORMService.ts:1382

delete

delete(
    typeName: string,
    primaryFieldValue: any,
    context?: TypeInfoORMContext,
): Promise<boolean>
Delete an existing item of the given type.
Parameters
- typeName: string
  Type name to delete.
- primaryFieldValue: any
  Primary field value to delete.
- Optionalcontext: TypeInfoORMContext
Returns Promise<boolean>
True when the delete succeeded.
Implementation of TypeInfoORMAPI.delete
- Defined in api/ORM/TypeInfoORMService.ts:3575

deleteRelationship

deleteRelationship(
relationshipItem: BaseItemRelationshipInfo,
context?: TypeInfoORMContext,
): Promise<DeleteRelationshipResults>
Delete a relationship between two items.
Parameters
- relationshipItem: BaseItemRelationshipInfo
  Relationship item to delete.
  
  When DAC is enabled and getOwnerPrefix is configured, relationship deletion requires:
  
  relationship permission on the relationship resource path, and
  
  endpoint ownership permission for both from and to items.
- Optionalcontext: TypeInfoORMContext
Returns Promise<DeleteRelationshipResults>
Deletion results including whether items remain.
Implementation of TypeInfoORMAPI.deleteRelationship
- Defined in api/ORM/TypeInfoORMService.ts:3110

`Protected`emitIndexWrite

emitIndexWrite(
    typeName: string,
    docId: string,
    action: "upsert" | "remove",
    fieldCount: number,
): void
Emit structured index write observability events without impacting behavior.
Parameters
- typeName: string
  Type being indexed.
- docId: string
  Indexed document id.
- action: "upsert" | "remove"
  Structured indexing action.
- fieldCount: number
  Number of indexed fields in the write payload.
Returns void
- Defined in api/ORM/TypeInfoORMService.ts:879

`Protected`emitListRoutingDecision

emitListRoutingDecision(
    typeName: string,
    path: "indexed" | "fullScanCompare" | "canonicalDriverList",
    reason:
        | "indexedExpression"
        | "noCriteria"
        | "criteriaWithoutIndexedPath"
        | "indexedPathFailedOrUnsupported",
    criteriaCount: number,
    plan?: IndexSearchDiagnostics,
): void
Emit list routing decision observability events without impacting runtime behavior.
Parameters
- typeName: string
  Type being listed.
- path: "indexed" | "fullScanCompare" | "canonicalDriverList"
  Selected routing path.
- reason:
      | "indexedExpression"
      | "noCriteria"
      | "criteriaWithoutIndexedPath"
      | "indexedPathFailedOrUnsupported"
  Why this path was selected.
- criteriaCount: number
  Number of criteria considered.
- Optionalplan: IndexSearchDiagnostics
Returns void
- Defined in api/ORM/TypeInfoORMService.ts:834

`Protected`emitOperationObservation

emitOperationObservation(event: TypeInfoORMOperationObservation): Promise<void>
Emit a public ORM operation observation without impacting runtime behavior.
Parameters
- event: TypeInfoORMOperationObservation
Returns Promise<void>
- Defined in api/ORM/TypeInfoORMService.ts:649

`Protected`encodeFullScanCompareCursor

encodeFullScanCompareCursor(offset: number): string
Parameters
- offset: number
  Next offset in filtered/sorted results.
Returns string
Encoded cursor for full-scan compare pagination.
- Defined in api/ORM/TypeInfoORMService.ts:1372

`Protected`getCleanItem

getCleanItem(
    typeName: string,
    item: Partial<TypeInfoDataItem>,
    dacFieldResources?: Partial<Record<string, DACAccessResult>>,
    selectedFields?: string[],
): Partial<TypeInfoDataItem>
Parameters
- typeName: string
  Type name used to look up TypeInfo.
- item: Partial<TypeInfoDataItem>
  Item to clean.
- OptionaldacFieldResources: Partial<Record<string, DACAccessResult>>
  Optional DAC field resource map.
- OptionalselectedFields: string[]
  Optional selected fields to include.
Returns Partial<TypeInfoDataItem>
Cleaned item with selected fields and DAC constraints applied.
- Defined in api/ORM/TypeInfoORMService.ts:2828

`Protected`getCleanSelectedFields

getCleanSelectedFields(
typeName: string,
selectedFields?: string[],
): string[] | undefined
Parameters
- typeName: string
  Type name used to look up TypeInfo.
- OptionalselectedFields: string[]
  Optional selected fields to include.
Returns string[] | undefined
Sanitized selected fields or undefined for all fields.
- Defined in api/ORM/TypeInfoORMService.ts:2887

`Protected`getIndexedFieldCapabilities

getIndexedFieldCapabilities(
typeName: string,
): Record<string, IndexedFieldCapabilities>
Resolve all configured field capabilities for a type.
Parameters
- typeName: string
Returns Record<string, IndexedFieldCapabilities>
- Defined in api/ORM/TypeInfoORMService.ts:1320

`Protected`getIndexedItemSnapshot

getIndexedItemSnapshot(
typeName: string,
item: Partial<TypeInfoDataItem>,
): Partial<TypeInfoDataItem>
Parameters
- typeName: string
  Type name used to clean the item.
- item: Partial<TypeInfoDataItem>
  Item snapshot to normalize.
Returns Partial<TypeInfoDataItem>
Item snapshot normalized for indexing operations.
- Defined in api/ORM/TypeInfoORMService.ts:2321

`Protected`getIndexingRelationshipDriverInternal

getIndexingRelationshipDriverInternal(): IndexingRelationshipDriver
Returns IndexingRelationshipDriver
Indexing relationship driver for relation indexing.
- Defined in api/ORM/TypeInfoORMService.ts:1275

getIndexMaintenanceTypeDescriptors

getIndexMaintenanceTypeDescriptors(): TypeInfoORMIndexMaintenanceTypeDescriptor[]
Return all TypeInfo types known to this ORM for index maintenance.

Returns TypeInfoORMIndexMaintenanceTypeDescriptor[]
Type descriptors derived from current ORM/index configuration.
- Defined in api/ORM/TypeInfoORMService.ts:1597

`Protected`getObservedOperationQueryFingerprint

getObservedOperationQueryFingerprint(
operation: TypeInfoORMOperationName,
args: unknown[],
): string | undefined
Build a non-sensitive fingerprint for public ORM query shape.
Parameters
- operation: TypeInfoORMOperationName
- args: unknown[]
Returns string | undefined
- Defined in api/ORM/TypeInfoORMService.ts:705

`Protected`getObservedOperationTypeName

getObservedOperationTypeName(args: unknown[]): string | undefined
Resolve a non-sensitive TypeInfo type name from a public ORM argument list.
Parameters
- args: unknown[]
Returns string | undefined
- Defined in api/ORM/TypeInfoORMService.ts:683

`Protected`getTypeInfo

getTypeInfo(typeName: string): TypeInfo
Parameters
- typeName: string
  Type name to resolve.
Returns TypeInfo
Type info for the requested type.
- Defined in api/ORM/TypeInfoORMService.ts:1297

indexItemIndexes

indexItemIndexes(
    typeName: string,
    item: Partial<TypeInfoDataItem>,
    config?: TypeInfoORMManualIndexingConfig,
): Promise<void>
Write the provided item snapshot into the configured indexes.

Use this when data was created or modified outside TypeInfoORMService.
Parameters
- typeName: string
  Type name for the indexed item.
- item: Partial<TypeInfoDataItem>
  Item snapshot to index.
- config: TypeInfoORMManualIndexingConfig = {}
  Optional field overrides.
Returns Promise<void>
Promise resolved when manual indexing completes.
- Defined in api/ORM/TypeInfoORMService.ts:2470

inspectStoredTypeIndexesPage

inspectStoredTypeIndexesPage(
typeName: string,
config?: TypeInfoORMInspectStoredTypeIndexesPageConfig,
): Promise<TypeInfoORMInspectStoredTypeIndexesPageResult>
Inspect one bounded page of canonical items against current index mirrors.

This catches the inverse of orphaned indexes: canonical items whose current structured or text index state is missing or stale. Inspection is non-destructive. Health callers should strongly revalidate an unhealthy item through verifyStoredItemIndexesForMaintenance before applying repair.
Parameters
- typeName: string
  Current TypeInfo type.
- config: TypeInfoORMInspectStoredTypeIndexesPageConfig = {}
  Paging options.
Returns Promise<TypeInfoORMInspectStoredTypeIndexesPageResult>
Bounded inspection results and continuation state.
- Defined in api/ORM/TypeInfoORMService.ts:2109

`Protected`isIndexValue

isIndexValue(value: unknown): value is WhereValue
Parameters
- value: unknown
  Value to check.
Returns value is WhereValue
True when the value is a supported structured value.
- Defined in api/ORM/TypeInfoORMService.ts:1515

list

list(
    typeName: string,
    config: ListItemsConfig,
    selectedFields?: string[],
    context?: TypeInfoORMContext,
): Promise<ListItemsResults<Partial<TypeInfoDataItem>>>
List items of the given type, with the given criteria.
Parameters
- typeName: string
  Type name to list.
- config: ListItemsConfig
  List configuration and criteria.
- OptionalselectedFields: string[]
  Optional fields to select.
- Optionalcontext: TypeInfoORMContext
Returns Promise<ListItemsResults<Partial<TypeInfoDataItem>>>
List results with items and cursor.
Implementation of TypeInfoORMAPI.list
- Defined in api/ORM/TypeInfoORMService.ts:3617

`Protected`listByFullScanAndCompare

listByFullScanAndCompare(
    typeName: string,
    config: ListItemsConfig,
    cleanSelectedFields: string[] | undefined,
    useDAC: boolean,
    context?: TypeInfoORMContext,
): Promise<ListItemsResults<Partial<TypeInfoDataItem>>>
Execute a criteria list via full scan + in-memory compare.

This is the universal fallback strategy for criteria/operators that are not supported by indexed query planners.
Parameters
- typeName: string
  Type name to list.
- config: ListItemsConfig
  Original list config.
- cleanSelectedFields: string[] | undefined
  Selected fields for cleaned response.
- useDAC: boolean
  Whether DAC checks are enabled.
- Optionalcontext: TypeInfoORMContext
  Optional request context.
Returns Promise<ListItemsResults<Partial<TypeInfoDataItem>>>
List results with cursor.
- Defined in api/ORM/TypeInfoORMService.ts:1417

listRelatedItems

listRelatedItems(
    config: ListRelationshipsConfig,
    selectedFields?: string[],
    context?: TypeInfoORMContext,
): Promise<
    { cursor: string
    | undefined; items: Partial<TypeInfoDataItem>[] },
>
List related items for the relationship origin.
Parameters
- config: ListRelationshipsConfig
  Relationship list configuration.
- OptionalselectedFields: string[]
  Optional fields to select on related items.
- Optionalcontext: TypeInfoORMContext
Returns Promise<{ cursor: string | undefined; items: Partial<TypeInfoDataItem>[] }>
Items and cursor for related items.
Implementation of TypeInfoORMAPI.listRelatedItems
- Defined in api/ORM/TypeInfoORMService.ts:3315

listRelationships

listRelationships(
config: ListRelationshipsConfig,
context?: TypeInfoORMContext,
): Promise<ListItemsResults<ItemRelationshipInfo>>
List the relationships for a given item.
Parameters
- config: ListRelationshipsConfig
  Relationship list configuration.
- Optionalcontext: TypeInfoORMContext
Returns Promise<ListItemsResults<ItemRelationshipInfo>>
Relationship items and paging cursor.
Implementation of TypeInfoORMAPI.listRelationships
- Defined in api/ORM/TypeInfoORMService.ts:3219

listStructuredIndexDocuments

listStructuredIndexDocuments(
options?: StructuredDocumentListOptions,
): Promise<StructuredDocumentPage | undefined>
Enumerate bounded structured document mirrors when supported.
Parameters
- options: StructuredDocumentListOptions = {}
  Paging options.
Returns Promise<StructuredDocumentPage | undefined>
Structured index document page, or undefined when unsupported.
- Defined in api/ORM/TypeInfoORMService.ts:1694

listTextIndexDocuments

listTextIndexDocuments(
options?: TextIndexDocumentListOptions,
): Promise<TextIndexDocumentPage | undefined>
Enumerate bounded full-text document mirrors when supported.
Parameters
- options: TextIndexDocumentListOptions = {}
  Paging options.
Returns Promise<TextIndexDocumentPage | undefined>
Full-text document page, or undefined when unsupported.
- Defined in api/ORM/TypeInfoORMService.ts:1704

`Protected`mutateItemIndexPlan

mutateItemIndexPlan(
    typeName: string,
    action:
        | { fields?: string[]; next: Partial<TypeInfoDataItem>; type: "index" }
        | {
            fields?: string[];
            previous: Partial<TypeInfoDataItem>;
            type: "remove";
        }
        | {
            next: Partial<TypeInfoDataItem>;
            nextFields?: string[];
            previous: Partial<TypeInfoDataItem>;
            previousFields?: string[];
            type: "replace";
        },
): Promise<void>
Parameters
- typeName: string
- action:
      | { fields?: string[]; next: Partial<TypeInfoDataItem>; type: "index" }
      | {
          fields?: string[];
          previous: Partial<TypeInfoDataItem>;
          type: "remove";
      }
      | {
          next: Partial<TypeInfoDataItem>;
          nextFields?: string[];
          previous: Partial<TypeInfoDataItem>;
          previousFields?: string[];
          type: "replace";
      }
Returns Promise<void>
Promise resolved once indexing is complete.
- Defined in api/ORM/TypeInfoORMService.ts:2335

read

read(
    typeName: string,
    primaryFieldValue: any,
    selectedFields?: string[],
    context?: TypeInfoORMContext,
): Promise<Partial<TypeInfoDataItem>>
Read an existing item of the given type.
Parameters
- typeName: string
  Type name to read.
- primaryFieldValue: any
  Primary field value to fetch.
- OptionalselectedFields: string[]
  Optional fields to select.
- Optionalcontext: TypeInfoORMContext
Returns Promise<Partial<TypeInfoDataItem>>
Cleaned item data.
Implementation of TypeInfoORMAPI.read
- Defined in api/ORM/TypeInfoORMService.ts:3393

reconcileStoredTypeIndexesPage

reconcileStoredTypeIndexesPage(
typeName: string,
config?: TypeInfoORMReconcileStoredTypeIndexesPageConfig,
): Promise<TypeInfoORMReconcileStoredTypeIndexesPageResult>
Reconcile one bounded page of canonical items after an index-relevant TypeInfo schema change.

Structured writes replace the persisted structured mirror, which removes fields no longer indexed. Full-text fields removed from the schema are deleted through document-level maintenance before current fields are reindexed.
Parameters
- typeName: string
  Current TypeInfo type.
- config: TypeInfoORMReconcileStoredTypeIndexesPageConfig = {}
  Previous schema descriptor and paging state.
Returns Promise<TypeInfoORMReconcileStoredTypeIndexesPageResult>
Processed count and continuation token.
- Defined in api/ORM/TypeInfoORMService.ts:2176

reindexStoredItem

reindexStoredItem(
    typeName: string,
    primaryFieldValue: LiteralValue,
    config?: TypeInfoORMReindexStoredItemConfig,
): Promise<boolean>
Reindex the current stored item using the configured driver.

When no previous snapshot is supplied, the current stored item is used for both removal and indexing to refresh existing postings without duplication. Supply previousItem when an out-of-band update changed indexed field values, otherwise stale index entries cannot be removed safely.
Parameters
- typeName: string
  Type name to reindex.
- primaryFieldValue: LiteralValue
  Primary field value for the stored item.
- config: TypeInfoORMReindexStoredItemConfig = {}
  Optional previous snapshot and indexed field overrides.
Returns Promise<boolean>
True when reindexing completed.
- Defined in api/ORM/TypeInfoORMService.ts:2567

reindexStoredType

reindexStoredType(
typeName: string,
config?: TypeInfoORMReindexStoredTypeConfig,
): Promise<TypeInfoORMReindexStoredTypeResults>
Reindex all currently stored items for a type.

This is intended for maintenance passes after out-of-band writes or schema/index configuration changes. Deleted items still require explicit cleanup via removeItemIndexes, because index removal needs a prior snapshot of indexed field values. For out-of-band updates that changed indexed values, provide previousItemsByPrimaryField.
Parameters
- typeName: string
  Type name to reindex.
- config: TypeInfoORMReindexStoredTypeConfig = {}
  Paging, previous snapshots, and indexed field overrides.
Returns Promise<TypeInfoORMReindexStoredTypeResults>
Count of processed stored items.
- Defined in api/ORM/TypeInfoORMService.ts:2598

removeItemIndexes

removeItemIndexes(
    typeName: string,
    item: Partial<TypeInfoDataItem>,
    config?: TypeInfoORMManualIndexingConfig,
): Promise<void>
Remove the provided item snapshot from the configured indexes.

Use this when data was deleted outside TypeInfoORMService.
Parameters
- typeName: string
  Type name for the indexed item.
- item: Partial<TypeInfoDataItem>
  Item snapshot to remove from the indexes.
- config: TypeInfoORMManualIndexingConfig = {}
  Optional field overrides.
Returns Promise<void>
Promise resolved when index cleanup completes.
- Defined in api/ORM/TypeInfoORMService.ts:2498

replaceItemIndexes

replaceItemIndexes(
    typeName: string,
    previousItem: Partial<TypeInfoDataItem>,
    nextItem: Partial<TypeInfoDataItem>,
    config?: TypeInfoORMReplaceIndexingConfig,
): Promise<void>
Replace one indexed item snapshot with another.

Use this when an existing stored item changed outside TypeInfoORMService or when a schema/config change requires removing old indexed fields and indexing a new field set.
Parameters
- typeName: string
  Type name for the indexed item.
- previousItem: Partial<TypeInfoDataItem>
  Previous item snapshot to remove.
- nextItem: Partial<TypeInfoDataItem>
  Next item snapshot to index.
- config: TypeInfoORMReplaceIndexingConfig = {}
  Optional previous/next field overrides.
Returns Promise<void>
Promise resolved when replacement indexing completes.
- Defined in api/ORM/TypeInfoORMService.ts:2529

`Protected`resolveIndexFields

resolveIndexFields(typeName: string, override?: string[]): string[]
Resolve deterministic, deduplicated fields for mutation operations.
Parameters
- typeName: string
- Optionaloverride: string[]
Returns string[]
- Defined in api/ORM/TypeInfoORMService.ts:1326

`Protected`resolveIndexOrderBy

resolveIndexOrderBy(
typeName: string,
sortFields: SortField[] | undefined,
): { field: string; optional?: boolean; reverse?: boolean } | undefined
Resolve one globally ordered value capability.
Parameters
- typeName: string
- sortFields: SortField[] | undefined
Returns { field: string; optional?: boolean; reverse?: boolean } | undefined
- Defined in api/ORM/TypeInfoORMService.ts:1339

update

update(
    typeName: string,
    item: TypeInfoDataItem,
    updateConfig?: TypeInfoORMUpdateConfig,
    context?: TypeInfoORMContext,
): Promise<boolean>
Update an existing item of the given type.

This update will always act as a patch. Use null to signify the deletion of a field. Assign values to all fields to perform a replacement.

The item must always contain its primary field value.
Parameters
- typeName: string
  Type name to update.
- item: TypeInfoDataItem
  Item payload to update.
- OptionalupdateConfig: TypeInfoORMUpdateConfig
  Optional per-field operator config.
- Optionalcontext: TypeInfoORMContext
Returns Promise<boolean>
True when the update succeeded.
Implementation of TypeInfoORMAPI.update
- Defined in api/ORM/TypeInfoORMService.ts:3457

`Protected`validate

validate(
    typeName: string,
    item: TypeInfoDataItem,
    typeOperation: TypeOperation,
    itemIsPartial?: boolean,
): void
Parameters
- typeName: string
  Type name to validate.
- item: TypeInfoDataItem
  Item to validate.
- typeOperation: TypeOperation
  Operation being validated.
- OptionalitemIsPartial: boolean
  Whether the item is a partial update.
Returns void
Nothing (throws on invalid items).
- Defined in api/ORM/TypeInfoORMService.ts:2700

`Protected`validateDeleteOperation

validateDeleteOperation(typeName: string, primaryFieldValue: any): void
Validate a delete operation against only the item's primary field.

Delete receives an identity, not a complete item. The primary field still needs its normal operation and value validation, but unrelated required fields must not participate.
Parameters
- typeName: string
- primaryFieldValue: any
Returns void
- Defined in api/ORM/TypeInfoORMService.ts:2741

`Protected`validateReadOperation

validateReadOperation(typeName: string, selectedFields?: string[]): void
Parameters
- typeName: string
  Type name to validate for read.
- OptionalselectedFields: string[]
  Optional selected fields to validate.
Returns void
Nothing (throws on invalid operations).
- Defined in api/ORM/TypeInfoORMService.ts:2639

`Protected`validateRelationshipItem

validateRelationshipItem(
relationshipItem: ItemRelationshipInfoType,
omitFields: ItemRelationshipInfoKeys[],
): void
Parameters
- relationshipItem: ItemRelationshipInfoType
  Relationship item to validate.
- omitFields: ItemRelationshipInfoKeys[]
  Relationship fields to omit from validation.
Returns void
Nothing (throws on invalid relationships).
- Defined in api/ORM/TypeInfoORMService.ts:2924

`Protected`validateUpdateConfig

validateUpdateConfig(
    typeName: string,
    item: TypeInfoDataItem,
    updateConfig?: TypeInfoORMUpdateConfig,
): void
Validate update operator config against the target TypeInfo fields.
Parameters
- typeName: string
- item: TypeInfoDataItem
- OptionalupdateConfig: TypeInfoORMUpdateConfig
Returns void
- Defined in api/ORM/TypeInfoORMService.ts:2775

verifyStoredItemForIndexMaintenance

verifyStoredItemForIndexMaintenance(
typeName: string,
primaryFieldValue: LiteralValue,
): Promise<TypeInfoORMIndexMaintenanceVerification>
Verify canonical item existence for index maintenance.

Drivers with a strong-read capability are preferred. Best-effort reads are still useful for diagnostics but must not authorize destructive healing.
Parameters
- typeName: string
  TypeInfo type to verify.
- primaryFieldValue: LiteralValue
  Canonical item identifier.
Returns Promise<TypeInfoORMIndexMaintenanceVerification>
Existence result and the consistency level used.
- Defined in api/ORM/TypeInfoORMService.ts:1719

verifyStoredItemIndexesForMaintenance

verifyStoredItemIndexesForMaintenance(
typeName: string,
primaryFieldValue: LiteralValue,
): Promise<TypeInfoORMStoredItemIndexVerification>
Strongly revalidate one canonical item's current index state when the configured driver supports it.
Parameters
- typeName: string
  Current TypeInfo type.
- primaryFieldValue: LiteralValue
  Canonical primary-field value.
Returns Promise<TypeInfoORMStoredItemIndexVerification>
Canonical existence, consistency level, and current index issues.
- Defined in api/ORM/TypeInfoORMService.ts:2064

`Protected`wrapObservedOperation

wrapObservedOperation<Args extends unknown[], Result>(
operation: TypeInfoORMOperationName,
target: (...args: Args) => Promise<Result>,
): (...args: Args) => Promise<Result>
Wrap one public ORM method with lightweight duration/result observation.
Type Parameters
- Args extends unknown[]
- Result
Parameters
- operation: TypeInfoORMOperationName
- target: (...args: Args) => Promise<Result>
Returns (...args: Args) => Promise<Result>
- Defined in api/ORM/TypeInfoORMService.ts:786

Properties

`Protected`config

config: TypeInfoORMServiceConfig

ORM service configuration.

Class TypeInfoORMService

Implements

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns TypeInfoORMService

Methods

addOperationObserver

Parameters

Returns () => void

ProtectedbuildIndexValueFields

Parameters

Returns StructuredDocFieldsRecord

ProtectedbuildIndexWriteContext

Parameters

Returns StructuredWriteContext

cleanupOrphanedIndexState

Parameters

Returns Promise<TypeInfoORMOrphanIndexCleanupResult>

ProtectedcleanupRelationships

Parameters

Returns Promise<void>

cleanupRemovedTypeIndexState

Parameters

Returns Promise<TypeInfoORMRemovedTypeIndexCleanupResult>

create

Parameters

Returns Promise<any>

createRelationship

Parameters

Returns Promise<boolean>

ProtecteddecodeFullScanCompareCursor

Parameters

Returns number

delete

Parameters

Returns Promise<boolean>

deleteRelationship

Parameters

Returns Promise<DeleteRelationshipResults>

ProtectedemitIndexWrite

Parameters

Returns void

ProtectedemitListRoutingDecision

Parameters

Returns void

ProtectedemitOperationObservation

Parameters

Returns Promise<void>

ProtectedencodeFullScanCompareCursor

Parameters

Returns string

ProtectedgetCleanItem

Parameters

Returns Partial<TypeInfoDataItem>

ProtectedgetCleanSelectedFields

Parameters

Returns string[] | undefined

ProtectedgetIndexedFieldCapabilities

Parameters

Returns Record<string, IndexedFieldCapabilities>

ProtectedgetIndexedItemSnapshot

Parameters

Returns Partial<TypeInfoDataItem>

ProtectedgetIndexingRelationshipDriverInternal

Returns IndexingRelationshipDriver

getIndexMaintenanceTypeDescriptors

Returns TypeInfoORMIndexMaintenanceTypeDescriptor[]

ProtectedgetObservedOperationQueryFingerprint

Parameters

Returns string | undefined

ProtectedgetObservedOperationTypeName

Parameters

Returns string | undefined

ProtectedgetTypeInfo

Parameters

`Protected`buildIndexValueFields

`Protected`buildIndexWriteContext

`Protected`cleanupRelationships

`Protected`decodeFullScanCompareCursor

`Protected`emitIndexWrite

`Protected`emitListRoutingDecision

`Protected`emitOperationObservation

`Protected`encodeFullScanCompareCursor

`Protected`getCleanItem

`Protected`getCleanSelectedFields

`Protected`getIndexedFieldCapabilities

`Protected`getIndexedItemSnapshot

`Protected`getIndexingRelationshipDriverInternal

`Protected`getObservedOperationQueryFingerprint

`Protected`getObservedOperationTypeName

`Protected`getTypeInfo

`Protected`isIndexValue

`Protected`listByFullScanAndCompare

`Protected`mutateItemIndexPlan

`Protected`resolveIndexFields

`Protected`resolveIndexOrderBy

`Protected`validate

`Protected`validateDeleteOperation

`Protected`validateReadOperation

`Protected`validateRelationshipItem