Method patch

libs/@local/graph/sdk/typescript/src/entity.ts:1177–1312

(
    graphAPI: GraphApi,
    authentication: AuthenticationContext,
    {
      entityTypeIds,
      propertyPatches,
      additionalAllowedPropertyBaseUrls,
      ...params
    }: PatchEntityParameters,
    /**
     * @todo H-3091: returning a specific 'this' will not be correct if the entityTypeId has been changed as part of
     *   the update. I tried using generics to enforce that a new EntityProperties must be provided if the entityTypeId
     *   is changed, but it isn't causing a compiler error:
     *
     *    public async patch<NewPropertyMap extends EntityProperties = PropertyMap>(
     *      // PatchEntityParams sets a specific VersionedUrl based on NewPropertyMap, but this is not enforced by the
     *   compiler params: PatchEntityParameters<NewPropertyMap>,
     *    )
     */
  )

  }

  public async patch(
    graphAPI: GraphApi,
    authentication: AuthenticationContext,
    {
      entityTypeIds,
      propertyPatches,
      additionalAllowedPropertyBaseUrls,
      ...params
    }: PatchEntityParameters,
    /**
     * @todo H-3091: returning a specific 'this' will not be correct if the entityTypeId has been changed as part of
     *   the update. I tried using generics to enforce that a new EntityProperties must be provided if the entityTypeId
     *   is changed, but it isn't causing a compiler error:
     *
     *    public async patch<NewPropertyMap extends EntityProperties = PropertyMap>(
     *      // PatchEntityParams sets a specific VersionedUrl based on NewPropertyMap, but this is not enforced by the
     *   compiler params: PatchEntityParameters<NewPropertyMap>,
     *    )
     */
  ): Promise<this> {
    if (propertyPatches) {
      const isUserEntity = this.metadata.entityTypeIds.some(
        (id) => extractBaseUrl(id) === userEntityTypeBaseUrl,
      );

      if (isUserEntity) {
        for (const patch of propertyPatches) {
          const targetBaseUrl = patch.path[0] as BaseUrl | undefined;
          if (targetBaseUrl === undefined) {
            throw new Error(
              "Cannot replace the entire property object on a user entity",
            );
          }

          if (
            !userSelfUpdatablePropertyBaseUrls.has(targetBaseUrl) &&
            !additionalAllowedPropertyBaseUrls?.has(targetBaseUrl)
          ) {
            throw new Error(
              `Property patch targeting '${targetBaseUrl}' is not allowed on a user entity. Allowed properties: ${[...userSelfUpdatablePropertyBaseUrls, ...(additionalAllowedPropertyBaseUrls ?? [])].join(", ")}`,
            );
          }

          if (targetBaseUrl === displayNamePropertyBaseUrl) {
            if (patch.op === "remove") {
              throw new Error("Cannot remove the display name of a user");
            }

            const rawName = patch.property.value;
            if (typeof rawName === "string") {
              const trimmedName = rawName.trim();
              const validation = validateDisplayName(trimmedName);
              if (validation !== true) {
                throw new Error(validation);
              }
              if (trimmedName !== rawName) {
                patch.property.value = trimmedName;
              }