Class AuthorizationResultBasedUpdateMutator<TFields, TIDField, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>

Mutator for updating an existing entity.

Type Parameters

TFields extends Record<string, any>
TIDField extends keyof NonNullable<Pick<TFields, TSelectedFields>>
TViewerContext extends ViewerContext
TEntity extends Entity<TFields, TIDField, TViewerContext, TSelectedFields>
TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TIDField, TViewerContext, TEntity, TSelectedFields>
TSelectedFields extends keyof TFields

Hierarchy (View Summary)

AuthorizationResultBasedBaseMutator<
    TFields,
    TIDField,
    TViewerContext,
    TEntity,
    TPrivacyPolicy,
    TSelectedFields,
>
- AuthorizationResultBasedUpdateMutator

Index

Constructors

constructor

new AuthorizationResultBasedUpdateMutator<
    TFields extends Record<string, any>,
    TIDField extends string | number | symbol,
    TViewerContext extends ViewerContext,
    TEntity extends Entity<TFields, TIDField, TViewerContext, TSelectedFields>,
    TPrivacyPolicy extends
        EntityPrivacyPolicy<
            TFields,
            TIDField,
            TViewerContext,
            TEntity,
            TSelectedFields,
        >,
    TSelectedFields extends string
    | number
    | symbol,
>(
    companionProvider: EntityCompanionProvider,
    viewerContext: TViewerContext,
    queryContext: EntityQueryContext,
    entityConfiguration: EntityConfiguration<TFields, TIDField>,
    entityClass: IEntityClass<
        TFields,
        TIDField,
        TViewerContext,
        TEntity,
        TPrivacyPolicy,
        TSelectedFields,
    >,
    privacyPolicy: TPrivacyPolicy,
    mutationValidators: EntityMutationValidatorConfiguration<
        TFields,
        TIDField,
        TViewerContext,
        TEntity,
        TSelectedFields,
    >,
    mutationTriggers: EntityMutationTriggerConfiguration<
        TFields,
        TIDField,
        TViewerContext,
        TEntity,
        TSelectedFields,
    >,
    entityLoaderFactory: EntityLoaderFactory<
        TFields,
        TIDField,
        TViewerContext,
        TEntity,
        TPrivacyPolicy,
        TSelectedFields,
    >,
    databaseAdapter: EntityDatabaseAdapter<TFields, TIDField>,
    metricsAdapter: IEntityMetricsAdapter,
    originalEntity: TEntity,
    cascadingDeleteCause: EntityCascadingDeletionInfo | null,
): AuthorizationResultBasedUpdateMutator<
    TFields,
    TIDField,
    TViewerContext,
    TEntity,
    TPrivacyPolicy,
    TSelectedFields,
>
Type Parameters
- TFields extends Record<string, any>
- TIDField extends string | number | symbol
- TViewerContext extends ViewerContext
- TEntity extends Entity<TFields, TIDField, TViewerContext, TSelectedFields>
- TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TIDField, TViewerContext, TEntity, TSelectedFields>
- TSelectedFields extends string | number | symbol
Parameters
- companionProvider: EntityCompanionProvider
- viewerContext: TViewerContext
- queryContext: EntityQueryContext
- entityConfiguration: EntityConfiguration<TFields, TIDField>
- entityClass: IEntityClass<
      TFields,
      TIDField,
      TViewerContext,
      TEntity,
      TPrivacyPolicy,
      TSelectedFields,
  >
- privacyPolicy: TPrivacyPolicy
- mutationValidators: EntityMutationValidatorConfiguration<
      TFields,
      TIDField,
      TViewerContext,
      TEntity,
      TSelectedFields,
  >
- mutationTriggers: EntityMutationTriggerConfiguration<
      TFields,
      TIDField,
      TViewerContext,
      TEntity,
      TSelectedFields,
  >
- entityLoaderFactory: EntityLoaderFactory<
      TFields,
      TIDField,
      TViewerContext,
      TEntity,
      TPrivacyPolicy,
      TSelectedFields,
  >
- databaseAdapter: EntityDatabaseAdapter<TFields, TIDField>
- metricsAdapter: IEntityMetricsAdapter
- originalEntity: TEntity
- cascadingDeleteCause: EntityCascadingDeletionInfo | null
Returns AuthorizationResultBasedUpdateMutator<
    TFields,
    TIDField,
    TViewerContext,
    TEntity,
    TPrivacyPolicy,
    TSelectedFields,
>
Overrides AuthorizationResultBasedBaseMutator.constructor
- Defined in packages/entity/src/AuthorizationResultBasedEntityMutator.ts:444

Properties

`Protected` `Readonly`companionProvider

companionProvider: EntityCompanionProvider

`Protected` `Readonly`databaseAdapter

databaseAdapter: EntityDatabaseAdapter<TFields, TIDField>

`Protected` `Readonly`entityClass

entityClass: IEntityClass<
    TFields,
    TIDField,
    TViewerContext,
    TEntity,
    TPrivacyPolicy,
    TSelectedFields,
>

`Protected` `Readonly`entityConfiguration

entityConfiguration: EntityConfiguration<TFields, TIDField>

`Protected` `Readonly`entityLoaderFactory

entityLoaderFactory: EntityLoaderFactory<
    TFields,
    TIDField,
    TViewerContext,
    TEntity,
    TPrivacyPolicy,
    TSelectedFields,
>

`Protected` `Readonly`metricsAdapter

metricsAdapter: IEntityMetricsAdapter

`Protected` `Readonly`mutationTriggers

mutationTriggers: EntityMutationTriggerConfiguration<
    TFields,
    TIDField,
    TViewerContext,
    TEntity,
    TSelectedFields,
>

`Protected` `Readonly`mutationValidators

mutationValidators: EntityMutationValidatorConfiguration<
    TFields,
    TIDField,
    TViewerContext,
    TEntity,
    TSelectedFields,
>

`Protected` `Readonly`privacyPolicy

privacyPolicy: TPrivacyPolicy

`Protected` `Readonly`queryContext

queryContext: EntityQueryContext

`Protected` `Readonly`viewerContext

viewerContext: TViewerContext

Methods

`Protected`executeMutationTriggersAsync

executeMutationTriggersAsync(
    triggers:
        | EntityMutationTrigger<
            TFields,
            TIDField,
            TViewerContext,
            TEntity,
            TSelectedFields,
        >[]
        | undefined,
    queryContext: EntityTransactionalQueryContext,
    entity: TEntity,
    mutationInfo: EntityTriggerMutationInfo<
        TFields,
        TIDField,
        TViewerContext,
        TEntity,
        TSelectedFields,
    >,
): Promise<void>
Parameters
- triggers:
      | EntityMutationTrigger<
          TFields,
          TIDField,
          TViewerContext,
          TEntity,
          TSelectedFields,
      >[]
      | undefined
- queryContext: EntityTransactionalQueryContext
- entity: TEntity
- mutationInfo: EntityTriggerMutationInfo<
      TFields,
      TIDField,
      TViewerContext,
      TEntity,
      TSelectedFields,
  >
Returns Promise<void>
Inherited from AuthorizationResultBasedBaseMutator.executeMutationTriggersAsync
- Defined in packages/entity/src/AuthorizationResultBasedEntityMutator.ts:219

`Protected`executeMutationValidatorsAsync

executeMutationValidatorsAsync(
    validators:
        | EntityMutationValidator<
            TFields,
            TIDField,
            TViewerContext,
            TEntity,
            TSelectedFields,
        >[]
        | undefined,
    queryContext: EntityTransactionalQueryContext,
    entity: TEntity,
    mutationInfo: EntityValidatorMutationInfo<
        TFields,
        TIDField,
        TViewerContext,
        TEntity,
        TSelectedFields,
    >,
): Promise<void>
Parameters
- validators:
      | EntityMutationValidator<
          TFields,
          TIDField,
          TViewerContext,
          TEntity,
          TSelectedFields,
      >[]
      | undefined
- queryContext: EntityTransactionalQueryContext
- entity: TEntity
- mutationInfo: EntityValidatorMutationInfo<
      TFields,
      TIDField,
      TViewerContext,
      TEntity,
      TSelectedFields,
  >
Returns Promise<void>
Inherited from AuthorizationResultBasedBaseMutator.executeMutationValidatorsAsync
- Defined in packages/entity/src/AuthorizationResultBasedEntityMutator.ts:194

`Protected`executeNonTransactionalMutationTriggersAsync

executeNonTransactionalMutationTriggersAsync(
    triggers:
        | EntityNonTransactionalMutationTrigger<
            TFields,
            TIDField,
            TViewerContext,
            TEntity,
            TSelectedFields,
        >[]
        | undefined,
    entity: TEntity,
    mutationInfo: EntityTriggerMutationInfo<
        TFields,
        TIDField,
        TViewerContext,
        TEntity,
        TSelectedFields,
    >,
): Promise<void>
Parameters
- triggers:
      | EntityNonTransactionalMutationTrigger<
          TFields,
          TIDField,
          TViewerContext,
          TEntity,
          TSelectedFields,
      >[]
      | undefined
- entity: TEntity
- mutationInfo: EntityTriggerMutationInfo<
      TFields,
      TIDField,
      TViewerContext,
      TEntity,
      TSelectedFields,
  >
Returns Promise<void>
Inherited from AuthorizationResultBasedBaseMutator.executeNonTransactionalMutationTriggersAsync
- Defined in packages/entity/src/AuthorizationResultBasedEntityMutator.ts:243

setField

setField<K extends string | number | symbol>(
fieldName: K,
value: TFields[K],
): this
Set the value for entity field.
Type Parameters
- K extends string | number | symbol
Parameters
- fieldName: K
  entity field being updated
- value: TFields[K]
  value for entity field
Returns this
- Defined in packages/entity/src/AuthorizationResultBasedEntityMutator.ts:507

updateAsync

updateAsync(): Promise<Result<TEntity>>
Commit the changes to the entity after authorizing against update privacy rules. Invalidates all caches for pre-update entity.

Returns Promise<Result<TEntity>>
authorized updated entity result, where result error can be UnauthorizedError
- Defined in packages/entity/src/AuthorizationResultBasedEntityMutator.ts:518

`Protected`validateFields

validateFields(fields: Partial<TFields>): void
Parameters
- fields: Partial<TFields>
Returns void
Inherited from AuthorizationResultBasedBaseMutator.validateFields
- Defined in packages/entity/src/AuthorizationResultBasedEntityMutator.ts:174

Class AuthorizationResultBasedUpdateMutator<TFields, TIDField, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AuthorizationResultBasedUpdateMutator< TFields, TIDField, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields,>

Properties

Protected ReadonlycompanionProvider

Protected ReadonlydatabaseAdapter

Protected ReadonlyentityClass

Protected ReadonlyentityConfiguration

Protected ReadonlyentityLoaderFactory

Protected ReadonlymetricsAdapter

Protected ReadonlymutationTriggers

Protected ReadonlymutationValidators

Protected ReadonlyprivacyPolicy

Protected ReadonlyqueryContext

Protected ReadonlyviewerContext

Methods

ProtectedexecuteMutationTriggersAsync

Parameters

Returns Promise<void>

ProtectedexecuteMutationValidatorsAsync

Parameters

Returns Promise<void>

ProtectedexecuteNonTransactionalMutationTriggersAsync

Parameters

Returns Promise<void>

setField

Type Parameters

Parameters

Returns this

updateAsync

Returns Promise<Result<TEntity>>

ProtectedvalidateFields

Parameters

Returns void

Settings

On This Page

Returns AuthorizationResultBasedUpdateMutator<
TFields,
TIDField,
TViewerContext,
TEntity,
TPrivacyPolicy,
TSelectedFields,
>

`Protected` `Readonly`companionProvider

`Protected` `Readonly`databaseAdapter

`Protected` `Readonly`entityClass

`Protected` `Readonly`entityConfiguration

`Protected` `Readonly`entityLoaderFactory

`Protected` `Readonly`metricsAdapter

`Protected` `Readonly`mutationTriggers

`Protected` `Readonly`mutationValidators

`Protected` `Readonly`privacyPolicy

`Protected` `Readonly`queryContext

`Protected` `Readonly`viewerContext

`Protected`executeMutationTriggersAsync

`Protected`executeMutationValidatorsAsync

`Protected`executeNonTransactionalMutationTriggersAsync

`Protected`validateFields