Function updateEntity

apps/hash-api/src/graph/knowledge/primitive/entity.ts:471–536

(
  ...args: Parameters<UpdateEntityFunction<Properties>>
)

 * Update an entity.
 */
export const updateEntity = async <
  Properties extends TypeIdsAndPropertiesForEntity,
>(
  ...args: Parameters<UpdateEntityFunction<Properties>>
): ReturnType<UpdateEntityFunction<Properties>> => {
  const [context, authentication, params] = args;
  const { entity, entityTypeIds, propertyPatches } = params;

  for (const beforeUpdateHook of beforeUpdateEntityHooks) {
    if (entity.metadata.entityTypeIds.includes(beforeUpdateHook.entityTypeId)) {
      await beforeUpdateHook.callback({
        context,
        previousEntity: entity,
        propertyPatches: propertyPatches ?? [],
        authentication,
      });
    }
  }

  const { graphApi } = context;
  const { actorId } = authentication;

  /**
   * The SDK's patch method auto-enforces the base user property whitelist.
   * Here we extend it with properties that have special authorization
   * (validated by the before-update hook which runs above).
   *
   * - enabledFeatureFlags: the hook checks admin privileges
   * - shortname: the hook allows it only for incomplete users (first-time signup)
   */
  const additionalAllowedUrls = new Set([enabledFeatureFlagsPropertyBaseUrl]);

  const { shortname } = simplifyProperties<UserProperties>(
    entity.properties as UserProperties,
  );
  if (!shortname) {
    additionalAllowedUrls.add(shortnamePropertyBaseUrl);
  }

  const updatedEntity = await entity.patch(
    graphApi,
    { actorId },
    {
      entityTypeIds,
      draft: params.draft,
      propertyPatches,
      provenance: context.provenance,
      archived: params.archived,
      additionalAllowedPropertyBaseUrls: additionalAllowedUrls,
    },
  );

  for (const afterUpdateHook of afterUpdateEntityHooks) {
    if (entity.metadata.entityTypeIds.includes(afterUpdateHook.entityTypeId)) {
      void afterUpdateHook.callback({
        context,
        previousEntity: entity,
        propertyPatches: propertyPatches ?? [],