Refer to "non-compact" as "full" and don't use "channel root" term

Applies suggestions from REST SDK usage docs PR [1]

[1] ably/docs#3258 (comment)

Author: VeskeR

liveobjects.d.ts

@@ -73,7 +73,7 @@ export type BatchFunction<T extends LiveObject> = (ctx: BatchContext<T>) => void
 export declare interface RestObject {
   /**
    * Reads object data from the channel in compact object response format.
-   * Uses the channel's root object as the entrypoint when no objectId is provided.
+   * If no `objectId` is provided then the entire channel object is returned.
    *
    * Returns a {@link RestObjectGetCompactResult} representing the logical structure of your data as a JSON-like value.
    * {@link LiveMap} instances appear as JSON objects with their entries, and {@link LiveCounter} instances appear
@@ -89,7 +89,7 @@ export declare interface RestObject {
   get(params?: RestObjectGetCompactParams): Promise<RestObjectGetCompactResult>;
   /**
    * Reads object data from the channel in full object response format.
-   * Uses the channel's root object as the entrypoint when no objectId is provided.
+   * If no `objectId` is provided then the entire channel object is returned.
    *
    * Returns a {@link RestObjectGetFullResult} with full object metadata and decoded object data values
    * (`bytes` decoded to `Buffer`/`ArrayBuffer`, `json` decoded to native objects/arrays).
@@ -104,7 +104,7 @@ export declare interface RestObject {
   get(params: RestObjectGetFullParams): Promise<RestObjectGetFullResult>;
   /**
    * Reads object data from the channel.
-   * Uses the channel's root object as the entrypoint when no objectId is provided.
+   * If no `objectId` is provided then the entire channel object is returned.
    *
    * When `compact` is `true` (the default), returns a {@link RestObjectGetCompactResult} representing the logical
    * structure of your data as a JSON-like value. {@link LiveMap} instances appear as JSON objects with their entries,
@@ -390,9 +390,9 @@ export interface RestObjectPublishResult {
  * Request parameters for {@link RestObject.get}.
  */
 export interface RestObjectGetParams {
-  /** The unique identifier of the object instance to fetch. If omitted, fetches from the channel's root object. */
+  /** The unique identifier of the object instance to fetch. If omitted, fetches from the channel object. */
   objectId?: string;
-  /** A dot-separated path to return a subset of the object. Evaluated relative to the root or the specified objectId. */
+  /** A dot-separated path to return a subset of the object. Evaluated relative to the channel object or the specified objectId. */
   path?: string;
   /** When true (default), returns a values-only representation. When false, includes object IDs and type metadata. */
   compact?: boolean;
@@ -500,7 +500,7 @@ export type AnyRestLiveObject = {
 };
 
 /**
- * A decoded leaf data value in the non-compact {@link RestObject.get} responses.
+ * A decoded leaf data value in the full {@link RestObject.get} responses.
  */
 type RestObjectData = Omit<ObjectData, 'value'>;
 

src/plugins/liveobjects/restobject.ts

@@ -40,7 +40,7 @@ const mapSemanticsWireToPublic: Record<WireObjectsMapSemantics, ObjectsMapSemant
   [WireObjectsMapSemantics.LWW]: 'lww',
 };
 
-/** Wire format for a non-compact GET response: either a live object or a typed leaf value. */
+/** Wire format for a full GET response: either a live object or a typed leaf value. */
 type WireRestObjectGetFullResult = WireRestLiveObject | WireObjectData;
 
 type WireRestLiveObject = WireRestLiveMap | WireRestLiveCounter | WireAnyRestLiveObject;
@@ -127,7 +127,7 @@ export class RestObject implements PublicRestObject {
       return decoded as RestObjectGetCompactResult;
     }
 
-    // Non-compact mode: response is a live object (map/counter) or a typed leaf ObjectData.
+    // Full mode: response is a live object (map/counter) or a typed leaf ObjectData.
     // Decode wire values using objectmessage decoding.
     return this._decodeFullResponseNode(decoded as WireRestObjectGetFullResult, format);
   }

test/package/browser/template/src/index-liveobjects.ts

@@ -131,10 +131,10 @@ globalThis.testAblyPackage = async function () {
   // check RestObject is accessible on a REST channel
   const restObject: RestObject = restChannel.object;
 
-  // check get() returns correct types for compact and non-compact
+  // check get() returns correct types for compact and full responses
   const compactResult: RestObjectGetCompactResult = await restObject.get();
   const compactWithParam: RestObjectGetCompactResult = await restObject.get({ compact: true });
-  const nonCompactResult: RestObjectGetFullResult = await restObject.get({ compact: false });
+  const fullResult: RestObjectGetFullResult = await restObject.get({ compact: false });
 
   // check publish() returns correct type
   const publishResult: RestObjectPublishResult = await restObject.publish({