Class TypeInfoORMService

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

Implements

TypeInfoORMAPI

Constructors

constructor

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

Methods

`Protected`applyStructuredFieldMap

applyStructuredFieldMap(
    typeName: string,
    where: Where,
    fieldMap?: Record<string, string>,
): Where
Parameters
- typeName: string
  Type name used for field qualification.
- where: Where
  Structured query to map.
- OptionalfieldMap: Record<string, string>
  Optional field mapping by type.
Returns Where
Mapped structured query.
- Defined in api/ORM/TypeInfoORMService.ts:789

`Protected`buildStructuredFields

buildStructuredFields(
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:746

`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:1286

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:1680

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:1309

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:1884

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:1423

`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:1146

`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:1205

`Protected`getIndexingRelationshipDriverInternal

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

`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:691

`Protected`indexFullTextDocument

indexFullTextDocument(
    typeName: string,
    item: Partial<TypeInfoDataItem>,
    indexFieldOverride?: string,
): Promise<void>
Parameters
- typeName: string
  Type name for index field resolution.
- item: Partial<TypeInfoDataItem>
  Item to index.
- OptionalindexFieldOverride: string
  Optional override for the index field.
Returns Promise<void>
Promise resolved once indexing is complete.
- Defined in api/ORM/TypeInfoORMService.ts:832

`Protected`indexStructuredDocument

indexStructuredDocument(
typeName: string,
item: Partial<TypeInfoDataItem>,
): Promise<void>
Parameters
- typeName: string
  Type name for field mapping.
- item: Partial<TypeInfoDataItem>
  Item to index.
Returns Promise<void>
Promise resolved once indexing is complete.
- Defined in api/ORM/TypeInfoORMService.ts:978

`Protected`isStructuredValue

isStructuredValue(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:737

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:1931

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:1625

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:1529

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:1707

`Protected`removeFullTextDocument

removeFullTextDocument(
    typeName: string,
    item: Partial<TypeInfoDataItem>,
    indexFieldOverride?: string,
): Promise<void>
Parameters
- typeName: string
  Type name for index field resolution.
- item: Partial<TypeInfoDataItem>
  Item to remove from the index.
- OptionalindexFieldOverride: string
  Optional override for the index field.
Returns Promise<void>
Promise resolved once removal is complete.
- Defined in api/ORM/TypeInfoORMService.ts:879

`Protected`removeStructuredDocument

removeStructuredDocument(
typeName: string,
item: Partial<TypeInfoDataItem>,
): Promise<void>
Parameters
- typeName: string
  Type name for field mapping.
- item: Partial<TypeInfoDataItem>
  Item to remove from the structured index.
Returns Promise<void>
Promise resolved once removal is complete.
- Defined in api/ORM/TypeInfoORMService.ts:1016

`Protected`replaceFullTextDocument

replaceFullTextDocument(
    typeName: string,
    previousItem: Partial<TypeInfoDataItem>,
    nextItem: Partial<TypeInfoDataItem>,
    indexFieldOverride?: string,
): Promise<void>
Parameters
- typeName: string
  Type name for index field resolution.
- previousItem: Partial<TypeInfoDataItem>
  Previous item state to remove from the index.
- nextItem: Partial<TypeInfoDataItem>
  Next item state to index.
- OptionalindexFieldOverride: string
  Optional override for the index field.
Returns Promise<void>
Promise resolved once replacement is complete.
- Defined in api/ORM/TypeInfoORMService.ts:926

`Protected`resolveFullTextIndexField

resolveFullTextIndexField(
typeName: string,
override?: string,
): string | undefined
Parameters
- typeName: string
  Type name used to resolve the default index field.
- Optionaloverride: string
  Optional override for the index field.
Returns string | undefined
Resolved index field name, if available.
- Defined in api/ORM/TypeInfoORMService.ts:716

update

update(
    typeName: string,
    item: TypeInfoDataItem,
    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.
- Optionalcontext: TypeInfoORMContext
Returns Promise<boolean>
True when the update succeeded.
Implementation of TypeInfoORMAPI.update
- Defined in api/ORM/TypeInfoORMService.ts:1770

`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:1109

`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:1053

`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:1242

Properties

`Protected`config

config: TypeInfoORMServiceConfig

ORM service configuration.

Class TypeInfoORMService

Implements

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns TypeInfoORMService

Methods

ProtectedapplyStructuredFieldMap

Parameters

Returns Where

ProtectedbuildStructuredFields

Parameters

Returns StructuredDocFieldsRecord

ProtectedcleanupRelationships

Parameters

Returns Promise<void>

create

Parameters

Returns Promise<any>

createRelationship

Parameters

Returns Promise<boolean>

delete

Parameters

Returns Promise<boolean>

deleteRelationship

Parameters

Returns Promise<DeleteRelationshipResults>

ProtectedgetCleanItem

Parameters

Returns Partial<TypeInfoDataItem>

ProtectedgetCleanSelectedFields

Parameters

Returns string[] | undefined

ProtectedgetIndexingRelationshipDriverInternal

Returns IndexingRelationshipDriver

ProtectedgetTypeInfo

Parameters

Returns TypeInfo

ProtectedindexFullTextDocument

Parameters

Returns Promise<void>

ProtectedindexStructuredDocument

Parameters

Returns Promise<void>

ProtectedisStructuredValue

Parameters

Returns value is WhereValue

list

Parameters

Returns Promise<ListItemsResults<Partial<TypeInfoDataItem>>>

listRelatedItems

Parameters

Returns Promise<{ cursor: string | undefined; items: Partial<TypeInfoDataItem>[] }>

listRelationships

Parameters

Returns Promise<ListItemsResults<ItemRelationshipInfo>>

read

Parameters

Returns Promise<Partial<TypeInfoDataItem>>

ProtectedremoveFullTextDocument

Parameters

Returns Promise<void>

ProtectedremoveStructuredDocument

Parameters

Returns Promise<void>

ProtectedreplaceFullTextDocument

Parameters

Returns Promise<void>

ProtectedresolveFullTextIndexField

Parameters

Returns string | undefined

update

Parameters

Returns Promise<boolean>

Protectedvalidate

`Protected`applyStructuredFieldMap

`Protected`buildStructuredFields

`Protected`cleanupRelationships

`Protected`getCleanItem

`Protected`getCleanSelectedFields

`Protected`getIndexingRelationshipDriverInternal

`Protected`getTypeInfo

`Protected`indexFullTextDocument

`Protected`indexStructuredDocument

`Protected`isStructuredValue

`Protected`removeFullTextDocument

`Protected`removeStructuredDocument

`Protected`replaceFullTextDocument

`Protected`resolveFullTextIndexField

`Protected`validate

`Protected`validateReadOperation

`Protected`validateRelationshipItem

`Protected`config