Type Alias TypeInfoORMClientAPI

Client-safe TypeInfoORM API shape derived from TypeInfoORMAPI.

This type is intentionally explicit and does not include any context?: TypeInfoORMContext arguments so app-side callers cannot pass server DAC context.

type TypeInfoORMClientAPI = {
    create: (typeName: string, item: TypeInfoDataItem) => Promise<any>;
    createRelationship: (
        relationshipItem: BaseItemRelationshipInfo,
    ) => Promise<boolean>;
    delete: (typeName: string, primaryFieldValue: any) => Promise<boolean>;
    deleteRelationship: (
        relationshipItem: BaseItemRelationshipInfo,
    ) => Promise<DeleteRelationshipResults>;
    list: (
        typeName: string,
        config: ListItemsConfig,
        selectedFields?: (keyof TypeInfoDataItem)[],
    ) => Promise<ListItemsResults<Partial<TypeInfoDataItem>>>;
    listRelatedItems: (
        config: ListRelationshipsConfig,
        selectedFields?: (keyof TypeInfoDataItem)[],
    ) => Promise<ListItemsResults<Partial<TypeInfoDataItem>>>;
    listRelationships: (
        config: ListRelationshipsConfig,
    ) => Promise<ListItemsResults<ItemRelationshipInfo>>;
    read: (
        typeName: string,
        primaryFieldValue: any,
        selectedFields?: (keyof TypeInfoDataItem)[],
    ) => Promise<Partial<TypeInfoDataItem>>;
    update: (
        typeName: string,
        item: TypeInfoDataItem,
        updateConfig?: TypeInfoORMUpdateConfig,
    ) => Promise<boolean>;
}

Implemented by

TypeInfoORMClient

Index

Properties

create createRelationship delete deleteRelationship list listRelatedItems listRelationships read update

Properties

create

create: (typeName: string, item: TypeInfoDataItem) => Promise<any>

Create an item.

Type Declaration

- (typeName: string, item: TypeInfoDataItem): Promise<any>
- Parameters
  - typeName: string
    Type name to create.
  - item: TypeInfoDataItem
    Item payload to create.
  Returns Promise<any>
  The created item result.

createRelationship

createRelationship: (
relationshipItem: BaseItemRelationshipInfo,
) => Promise<boolean>

Create a relationship record.

Type Declaration

- (relationshipItem: BaseItemRelationshipInfo): Promise<boolean>
- Parameters
  - relationshipItem: BaseItemRelationshipInfo
    Relationship payload to create.
  Returns Promise<boolean>
  Whether the create succeeded.

delete

delete: (typeName: string, primaryFieldValue: any) => Promise<boolean>

Delete an item by primary field value.

Type Declaration

- (typeName: string, primaryFieldValue: any): Promise<boolean>
- Parameters
  - typeName: string
    Type name to delete.
  - primaryFieldValue: any
    Primary field value to delete.
  Returns Promise<boolean>
  Whether the delete succeeded.

deleteRelationship

deleteRelationship: (
relationshipItem: BaseItemRelationshipInfo,
) => Promise<DeleteRelationshipResults>

Delete a relationship record.

Type Declaration

- (relationshipItem: BaseItemRelationshipInfo): Promise<DeleteRelationshipResults>
- Parameters
  - relationshipItem: BaseItemRelationshipInfo
    Relationship payload to delete.
  Returns Promise<DeleteRelationshipResults>
  Results describing deletion outcome.

list

list: (
    typeName: string,
    config: ListItemsConfig,
    selectedFields?: (keyof TypeInfoDataItem)[],
) => Promise<ListItemsResults<Partial<TypeInfoDataItem>>>

List items matching the configuration.

Type Declaration

- (
      typeName: string,
      config: ListItemsConfig,
      selectedFields?: (keyof TypeInfoDataItem)[],
  ): Promise<ListItemsResults<Partial<TypeInfoDataItem>>>
- Parameters
  - typeName: string
    Type name to list.
  - config: ListItemsConfig
    List configuration.
  - OptionalselectedFields: (keyof TypeInfoDataItem)[]
    Optional fields to project.
  Returns Promise<ListItemsResults<Partial<TypeInfoDataItem>>>
  List results.

listRelatedItems

listRelatedItems: (
config: ListRelationshipsConfig,
selectedFields?: (keyof TypeInfoDataItem)[],
) => Promise<ListItemsResults<Partial<TypeInfoDataItem>>>

List related items for a relationship query.

Type Declaration

- (
  config: ListRelationshipsConfig,
  selectedFields?: (keyof TypeInfoDataItem)[],
  ): Promise<ListItemsResults<Partial<TypeInfoDataItem>>>
- Parameters
  - config: ListRelationshipsConfig
    Relationship list configuration.
  - OptionalselectedFields: (keyof TypeInfoDataItem)[]
    Optional fields to project.
  Returns Promise<ListItemsResults<Partial<TypeInfoDataItem>>>
  Related item list results.

listRelationships

listRelationships: (
config: ListRelationshipsConfig,
) => Promise<ListItemsResults<ItemRelationshipInfo>>

List relationships matching the query.

Type Declaration

- (
  config: ListRelationshipsConfig,
  ): Promise<ListItemsResults<ItemRelationshipInfo>>
- Parameters
  - config: ListRelationshipsConfig
    Relationship list configuration.
  Returns Promise<ListItemsResults<ItemRelationshipInfo>>
  Relationship list results.

read

read: (
    typeName: string,
    primaryFieldValue: any,
    selectedFields?: (keyof TypeInfoDataItem)[],
) => Promise<Partial<TypeInfoDataItem>>

Read an item by primary field value.

Type Declaration

- (
      typeName: string,
      primaryFieldValue: any,
      selectedFields?: (keyof TypeInfoDataItem)[],
  ): Promise<Partial<TypeInfoDataItem>>
- Parameters
  - typeName: string
    Type name to read.
  - primaryFieldValue: any
    Primary field value to lookup.
  - OptionalselectedFields: (keyof TypeInfoDataItem)[]
    Optional fields to project.
  Returns Promise<Partial<TypeInfoDataItem>>
  Retrieved item data.

update

update: (
    typeName: string,
    item: TypeInfoDataItem,
    updateConfig?: TypeInfoORMUpdateConfig,
) => Promise<boolean>

Update an item.

Type Declaration

- (
      typeName: string,
      item: TypeInfoDataItem,
      updateConfig?: TypeInfoORMUpdateConfig,
  ): Promise<boolean>
- Parameters
  - typeName: string
    Type name to update.
  - item: TypeInfoDataItem
    Updated item payload.
  - OptionalupdateConfig: TypeInfoORMUpdateConfig
    Optional per-field operator config.
  Returns Promise<boolean>
  Whether the update succeeded.

Type Alias TypeInfoORMClientAPI

Implemented by

Index

Properties

Properties

create

Type Declaration

Parameters

Returns Promise<any>

createRelationship

Type Declaration

Parameters

Returns Promise<boolean>

delete

Type Declaration

Parameters

Returns Promise<boolean>

deleteRelationship

Type Declaration

Parameters

Returns Promise<DeleteRelationshipResults>

list

Type Declaration

Parameters

Returns Promise<ListItemsResults<Partial<TypeInfoDataItem>>>

listRelatedItems

Type Declaration

Parameters

Returns Promise<ListItemsResults<Partial<TypeInfoDataItem>>>

listRelationships

Type Declaration

Parameters

Returns Promise<ListItemsResults<ItemRelationshipInfo>>

read

Type Declaration

Parameters

Returns Promise<Partial<TypeInfoDataItem>>

update

Type Declaration

Parameters

Returns Promise<boolean>

Settings

On This Page