lint & couple comments addressed

Author: naronchen

packages/scenes-client/README.md

@@ -11,7 +11,7 @@ import { SceneClient } from "@itwin/scenes-client";
 
 const client = new SceneClient(
   getAccessToken: async () => "<itwin_platform_auth_token>",
-  baseUrl: HOST_URL, // default prod: https://itwinscenes-eus.bentley.com
+  baseUrl: HOST_URL, // default prod: https://api.bentley.com/scenes
 );
 
 const scene = await client.getScene({

packages/scenes-client/src/api/sceneObjectApi.ts

@@ -17,6 +17,7 @@ import {
   DeleteObjectParams,
   DeleteObjectsParams,
   GetObjectsParams,
+  PatchObjectParam,
 } from "../models/index";
 import { iteratePagedEndpoint, batched } from "../utilities";
 import { callApi, AuthArgs } from "./apiFetch";
@@ -72,12 +73,12 @@ export async function getObjects({
   iTwinId,
   top,
   skip,
-  orderBy: kind,
+  orderBy,
   getAccessToken,
   baseUrl,
 }: GetObjectsParams & AuthArgs): Promise<SceneObjectListResponse> {
   return callApi<SceneObjectListResponse>({
-    endpoint: `/${sceneId}/objects?iTwinId=${iTwinId}&$top=${top}&$skip=${skip}&orderBy=${kind}`,
+    endpoint: `/${sceneId}/objects?iTwinId=${iTwinId}&$top=${top}&$skip=${skip}&orderBy=${orderBy}`,
     getAccessToken,
     baseUrl,
     postProcess: async (response) => {
@@ -208,6 +209,54 @@ export async function postObjects({
   };
 }
 
+/**
+ * Updates a single scene object by its ID.
+ * @param params - {@link PatchObjectParam}
+ * @returns Updated scene object details.
+ * @throws {ScenesApiError} If the API call fails or the response format is invalid.
+ */
+export async function patchObject({
+  sceneId,
+  iTwinId,
+  objectId,
+  object,
+  getAccessToken,
+  baseUrl,
+}: PatchObjectParam & AuthArgs): Promise<SceneObjectResponse> {
+  return callApi<SceneObjectResponse>({
+    endpoint: `/${sceneId}/objects/${objectId}?iTwinId=${iTwinId}`,
+    getAccessToken,
+    baseUrl,
+    postProcess: async (response) => {
+      const responseJson = await response.json();
+      if (!response.ok) {
+        const err = responseJson.error as ScenesErrorResponse;
+        throw new ScenesApiError(err, response.status);
+      }
+      if (!isSceneObjectResponse(responseJson)) {
+        throw new ScenesApiError(
+          {
+            code: "InvalidResponse", //@naron: this seemed repetitive
+            message: "Error updating scene object: unexpected response format",
+          },
+          response.status,
+        );
+      }
+      return responseJson;
+    },
+    fetchOptions: {
+      method: "PATCH",
+      body: JSON.stringify(object, (_, value) =>
+        value === undefined ? null : value,
+      ),
+    },
+    additionalHeaders: {
+      Accept: "application/vnd.bentley.itwin-platform.v1+json",
+      "Content-Type": "application/json",
+    },
+  });
+}
+
 /**
  * Updates one or multiple scene objects.
  * @param params - {@link PatchObjectsParams}

packages/scenes-client/src/client.ts

@@ -16,6 +16,7 @@ import {
   patchObjects,
   getAllObjects,
   getObjects,
+  patchObject,
 } from "./api/sceneObjectApi";
 import {
   SceneListResponse,
@@ -39,6 +40,7 @@ import {
   DeleteObjectsParams,
   GetScenesParams,
   GetObjectsParams,
+  PatchObjectParam,
 } from "./models/index";
 
 type AccessTokenFn = () => Promise<string>;
@@ -251,7 +253,7 @@ export class SceneClient {
    * Create one or multiple scene objects.
    * @param params.iTwinId – The iTwin’s unique identifier.
    * @param params.sceneId – The scene’s unique identifier.
-   * @param params.objects – Array of SceneObjectCreateDTO to create.
+   * @param params.objects – Array of {@link SceneObjectCreateDTO} to create.
    * @returns Created scene objects details in list.
    * @throws {ScenesApiError} If the API call fails or the response format is invalid.
    */
@@ -267,11 +269,31 @@ export class SceneClient {
     });
   }
 
+  /**
+   * Update a single scene object by its ID.
+   * @param params.iTwinId – The iTwin’s unique identifier.
+   * @param params.sceneId – The scene’s unique identifier.
+   * @param params.objectId – The object’s unique identifier.
+   * @param params.object – The {@link SceneObjectUpdateDTO} to update.
+   * @returns Updated scene object details.
+   * @throws {ScenesApiError} If the API call fails or the response format is invalid.
+   */
+  async patchObject(params: PatchObjectParam): Promise<SceneObjectResponse> {
+    return patchObject({
+      iTwinId: params.iTwinId,
+      sceneId: params.sceneId,
+      objectId: params.objectId,
+      object: params.object,
+      getAccessToken: this.getAccessToken,
+      baseUrl: this.baseUrl,
+    });
+  }
+
   /**
    * Update one or multiple scene objects.
    * @param params.iTwinId – The iTwin’s unique identifier.
    * @param params.sceneId – The scene’s unique identifier.
-   * @param params.objects – Array of SceneObjectUpdateById to update.
+   * @param params.objects – Array of {@link SceneObjectUpdateById} to update.
    * @returns Updated scene objects details.
    * @throws {ScenesApiError} If the API call fails or the response format is invalid.
    */

packages/scenes-client/src/models/apiParams.ts

@@ -2,7 +2,10 @@
 
 import { GetObjectsOptions } from "./object/GetObjectsOptions";
 import { BulkSceneObjectCreateDTO } from "./object/sceneObjectCreate.dto";
-import { BulkSceneObjectUpdate } from "./object/sceneObjectUpdate.dto";
+import {
+  BulkSceneObjectUpdate,
+  SceneObjectUpdateDTO,
+} from "./object/sceneObjectUpdate.dto";
 import { GetScenesOptions } from "./scene/GetScenesOptions";
 import { SceneCreateDTO } from "./scene/sceneCreate.dto";
 import { SceneUpdateDTO } from "./scene/sceneUpdate.dto";
@@ -22,6 +25,7 @@ export type GetObjectParams = ObjectParams;
 export type GetObjectsParams = SceneParams & Omit<GetObjectsOptions, "delayMs">;
 export type GetAllObjectsParams = SceneParams & GetObjectsOptions;
 export type PostObjectsParams = SceneParams & BulkSceneObjectCreateDTO;
+export type PatchObjectParam = ObjectParams & { object: SceneObjectUpdateDTO };
 export type PatchObjectsParams = SceneParams & BulkSceneObjectUpdate;
 export type DeleteObjectParams = ObjectParams;
 export type DeleteObjectsParams = SceneParams & { objectIds: string[] };

packages/scenes-client/tests/integration.test.ts

@@ -180,18 +180,28 @@ describe("Scenes Objects operations", () => {
     obj2 = repo.id;
   });
 
+  it("patch object", async () => {
+    const p1 = await client.patchObject({
+      iTwinId: ITWIN_ID,
+      sceneId: SCENE_ID,
+      objectId: obj1,
+      object: { displayName: "Layer1Up" },
+    });
+    expect(p1.object.displayName).toBe("Layer1Up");
+  });
+
   it("patches objects", async () => {
     const p1 = await client.patchObjects({
       iTwinId: ITWIN_ID,
       sceneId: SCENE_ID,
       objects: [
         {
           id: obj1,
-          displayName: "Layer1Up",
+          displayName: "Layer1Up squared",
         },
       ],
     });
-    expect(p1.objects[0].displayName).toBe("Layer1Up");
+    expect(p1.objects[0].displayName).toBe("Layer1Up squared");
 
     const pAll = await client.patchObjects({
       iTwinId: ITWIN_ID,

packages/scenes-client/tests/unit.test.ts

@@ -249,6 +249,32 @@ describe("Scene Object Operations", () => {
     });
   });
 
+  it("patchObject()", async () => {
+    fetchMock.mockImplementation(() =>
+      createSuccessfulResponse(exampleSceneObjectResponse),
+    );
+    const client = new SceneClient(getAccessToken);
+    await client.patchObject({
+      iTwinId: "itw-1",
+      sceneId: "scene-1",
+      objectId: "object-1",
+      object: {
+        displayName: "UpdatedObject1",
+      },
+    });
+    verifyFetch(fetchMock, {
+      url: `${BASE_DOMAIN}/scene-1/objects/object-1?iTwinId=itw-1`,
+      headers: {
+        "Content-Type": "application/json",
+        Accept: "application/vnd.bentley.itwin-platform.v1+json",
+      },
+      method: "PATCH",
+      body: JSON.stringify({
+        displayName: "UpdatedObject1",
+      }),
+    });
+  });
+
   it("patchObjects()", async () => {
     fetchMock.mockImplementation(() =>
       createSuccessfulResponse({ objects: [] }),