Add core include json option (#808)

Author: hayes-mysten

packages/codegen/src/generate-utils.ts

@@ -169,11 +169,11 @@ export class MoveStruct<
 	T extends Record<string, BcsType<any>>,
 	const Name extends string = string,
 > extends BcsStruct<T, Name> {
-	async get<Include extends Omit<SuiClientTypes.ObjectInclude, 'content'> = {}>({
+	async get<Include extends Omit<SuiClientTypes.ObjectInclude, 'content' | 'json'> = {}>({
 		objectId,
 		...options
 	}: GetOptions<Include>): Promise<
-		SuiClientTypes.Object<Include & { content: true }> & { json: BcsStruct<T>['$inferType'] }
+		SuiClientTypes.Object<Include & { content: true, json: true }> & { json: BcsStruct<T>['$inferType'] }
 	> {
 		const [res] = await this.getMany<Include>({
 			...options,
@@ -183,11 +183,11 @@ export class MoveStruct<
 		return res;
 	}
 
-	async getMany<Include extends Omit<SuiClientTypes.ObjectInclude, 'content'> = {}>({
+	async getMany<Include extends Omit<SuiClientTypes.ObjectInclude, 'content' | 'json'> = {}>({
 		client,
 		...options
 	}: GetManyOptions<Include>): Promise<
-		Array<SuiClientTypes.Object<Include & { content: true }> & { json: BcsStruct<T>['$inferType'] }>
+		Array<SuiClientTypes.Object<Include & { content: true, json: true }> & { json: BcsStruct<T>['$inferType'] }>
 	> {
 		const response = (await client.core.getObjects({
 			...options,

packages/codegen/tests/generated/utils/index.ts

@@ -46,6 +46,25 @@ console.log(object.digest);
 console.log(object.type); // e.g., "0x2::coin::Coin<0x2::sui::SUI>"
 ```
 
+You can also fetch the JSON representation of the object's Move struct content:
+
+```typescript
+const { object } = await client.core.getObject({
+	objectId: '0x123...',
+	include: { json: true },
+});
+
+// Access the JSON representation
+console.log(object.json);
+```
+
+<Callout type="warn">
+The `json` field structure may vary between API implementations. For example, JSON-RPC returns UID
+fields as nested objects (`{ "id": { "id": "0x..." } }`), while gRPC and GraphQL flatten them
+(`{ "id": "0x..." }`). For consistent data across all clients, use `include: { content: true }` and
+parse the BCS data directly.
+</Callout>
+
 ### getObjects
 
 Fetch multiple objects in a single request.
@@ -395,11 +414,19 @@ Most methods accept an `include` parameter to control what data is returned:
 
 ```typescript
 {
-  content: boolean,          // BCS-encoded object content
+  content: boolean,             // BCS-encoded object content
   previousTransaction: boolean, // Digest of creating transaction
+  json: boolean,                // JSON representation of Move struct content
 }
 ```
 
+<Callout type="warn">
+	The `json` field returns the JSON representation of an object's Move struct content. **Warning:**
+	The exact shape and field names of this data may vary between different API implementations
+	(JSON-RPC vs gRPC or GraphQL). For consistent data across APIs, use the `content` field and parse
+	the BCS data directly.
+</Callout>
+
 ### Transaction Include Options
 
 ```typescript