enhance: Remove name in toJSON() for Entities

ntucker · ntucker · commit 501cb82c9990 · 2024-07-21T13:57:41.000+02:00
diff --git a/.changeset/five-meals-refuse.md b/.changeset/five-meals-refuse.md
@@ -0,0 +1,7 @@
+---
+'@data-client/endpoint': patch
+'@data-client/graphql': patch
+'@data-client/rest': patch
+---
+
+Remove name in toJSON() for Entities
diff --git a/.changeset/four-berries-jog.md b/.changeset/four-berries-jog.md
@@ -0,0 +1,7 @@
+---
+'@data-client/endpoint': patch
+'@data-client/graphql': patch
+'@data-client/rest': patch
+---
+
+Add toString() to Collection
diff --git a/packages/endpoint/src/schemas/Collection.ts b/packages/endpoint/src/schemas/Collection.ts
@@ -121,11 +121,14 @@ export default class CollectionSchema<
     return this.schema.schema;
   }
 
+  toString() {
+    return this.key;
+  }
+
   toJSON() {
     return {
-      name: `Collection(${this.schema.schema.name})`,
-      schema: this.schema.schema.toJSON(),
       key: this.key,
+      schema: this.schema.schema.toJSON(),
     };
   }
 
diff --git a/packages/endpoint/src/schemas/EntitySchema.ts b/packages/endpoint/src/schemas/EntitySchema.ts
@@ -28,9 +28,8 @@ export default function EntitySchema<TBase extends Constructor>(
 
     static toJSON() {
       return {
-        name: this.name,
-        schema: this.schema,
         key: this.key,
+        schema: this.schema,
       };
     }
 
diff --git a/packages/endpoint/src/schemas/__tests__/__snapshots__/All.test.ts.snap b/packages/endpoint/src/schemas/__tests__/__snapshots__/All.test.ts.snap
@@ -284,9 +284,8 @@ See https://dataclient.io/rest/api/RestEndpoint#parseResponse for more informati
 
   Schema: [
   {
-    "name": "User",
-    "schema": {},
-    "key": "User"
+    "key": "User",
+    "schema": {}
   }
 ]
   Input: "[{"id":5}]""
@@ -297,9 +296,8 @@ exports[`AllSchema normalization (%s) should throw a custom error if data loads
 
           Schema: [
   {
-    "name": "User",
-    "schema": {},
-    "key": "User"
+    "key": "User",
+    "schema": {}
   }
 ]
           Input: "abc""
diff --git a/packages/endpoint/src/schemas/__tests__/__snapshots__/Array.test.js.snap b/packages/endpoint/src/schemas/__tests__/__snapshots__/Array.test.js.snap
@@ -446,9 +446,8 @@ See https://dataclient.io/rest/api/RestEndpoint#parseResponse for more informati
 
   Schema: [
   {
-    "name": "User",
-    "schema": {},
-    "key": "User"
+    "key": "User",
+    "schema": {}
   }
 ]
   Input: "[{"id":5}]""
@@ -459,9 +458,8 @@ exports[`ArraySchema normalization (plain) Object should throw a custom error if
 
           Schema: [
   {
-    "name": "User",
-    "schema": {},
-    "key": "User"
+    "key": "User",
+    "schema": {}
   }
 ]
           Input: "abc""
@@ -913,9 +911,8 @@ See https://dataclient.io/rest/api/RestEndpoint#parseResponse for more informati
 
   Schema: [
   {
-    "name": "User",
-    "schema": {},
-    "key": "User"
+    "key": "User",
+    "schema": {}
   }
 ]
   Input: "[{"id":5}]""
@@ -926,9 +923,8 @@ exports[`ArraySchema normalization (schema) Object should throw a custom error i
 
           Schema: [
   {
-    "name": "User",
-    "schema": {},
-    "key": "User"
+    "key": "User",
+    "schema": {}
   }
 ]
           Input: "abc""
diff --git a/packages/endpoint/src/schemas/__tests__/__snapshots__/Collection.test.ts.snap b/packages/endpoint/src/schemas/__tests__/__snapshots__/Collection.test.ts.snap
@@ -318,13 +318,11 @@ exports[`CollectionSchema normalization should throw a custom error if data load
 "Unexpected input given to normalize. Expected type to be "object", found "string".
 
           Schema: {
-  "name": "Collection(Todo)",
+  "key": "[Todo]",
   "schema": {
-    "name": "Todo",
-    "schema": {},
-    "key": "Todo"
-  },
-  "key": "[Todo]"
+    "key": "Todo",
+    "schema": {}
+  }
 }
           Input: "abc""
 `;
@@ -333,13 +331,11 @@ exports[`CollectionSchema normalization should throw a custom error if data load
 "Unexpected input given to normalize. Expected type to be "object", found "null".
 
           Schema: {
-  "name": "Collection(Todo)",
+  "key": "[Todo]",
   "schema": {
-    "name": "Todo",
-    "schema": {},
-    "key": "Todo"
-  },
-  "key": "[Todo]"
+    "key": "Todo",
+    "schema": {}
+  }
 }
           Input: "null""
 `;
diff --git a/packages/endpoint/src/schemas/__tests__/__snapshots__/Entity.test.ts.snap b/packages/endpoint/src/schemas/__tests__/__snapshots__/Entity.test.ts.snap
@@ -549,9 +549,8 @@ exports[`Entity normalization should throw a custom error if data loads with str
 
           Schema: {
   "data": {
-    "name": "MyEntity",
-    "schema": {},
-    "key": "MyEntity"
+    "key": "MyEntity",
+    "schema": {}
   }
 }
           Input: "hibho""
diff --git a/packages/endpoint/src/schemas/__tests__/__snapshots__/EntitySchema.test.ts.snap b/packages/endpoint/src/schemas/__tests__/__snapshots__/EntitySchema.test.ts.snap
@@ -561,9 +561,8 @@ exports[`EntitySchema normalization should throw a custom error if data loads wi
 
           Schema: {
   "data": {
-    "name": "EntityMixin",
-    "schema": {},
-    "key": "MyData"
+    "key": "MyData",
+    "schema": {}
   }
 }
           Input: "hibho""
diff --git a/packages/react/src/__tests__/__snapshots__/integration-endpoint.web.tsx.snap b/packages/react/src/__tests__/__snapshots__/integration-endpoint.web.tsx.snap
@@ -196,15 +196,13 @@ exports[`DataProvider useSuspense() should throw errors on malformed response 1`
 [Error: Error processing GET http://test.com/article-cooler/878
 
 Full Schema: {
-  "name": "CoolerArticle",
+  "key": "CoolerArticle",
   "schema": {
     "author": {
-      "name": "User",
-      "schema": {},
-      "key": "User"
+      "key": "User",
+      "schema": {}
     }
-  },
-  "key": "CoolerArticle"
+  }
 }
 
 Error:
@@ -417,15 +415,13 @@ exports[`ExternalDataProvider useSuspense() should throw errors on malformed res
 [Error: Error processing GET http://test.com/article-cooler/878
 
 Full Schema: {
-  "name": "CoolerArticle",
+  "key": "CoolerArticle",
   "schema": {
     "author": {
-      "name": "User",
-      "schema": {},
-      "key": "User"
+      "key": "User",
+      "schema": {}
     }
-  },
-  "key": "CoolerArticle"
+  }
 }
 
 Error:
diff --git a/packages/react/src/__tests__/__snapshots__/integration-optimistic-endpoint.web.tsx.snap b/packages/react/src/__tests__/__snapshots__/integration-optimistic-endpoint.web.tsx.snap
@@ -4,9 +4,8 @@ exports[`CacheProvider Optimistic Updates race conditions should error when user
 [Error: Error processing toggle [5]
 
 Full Schema: {
-  "name": "Toggle",
-  "schema": {},
-  "key": "Toggle"
+  "key": "Toggle",
+  "schema": {}
 }
 
 Error:
@@ -17,9 +16,8 @@ exports[`ExternalDataProvider Optimistic Updates race conditions should error wh
 [Error: Error processing toggle [5]
 
 Full Schema: {
-  "name": "Toggle",
-  "schema": {},
-  "key": "Toggle"
+  "key": "Toggle",
+  "schema": {}
 }
 
 Error:
diff --git a/packages/react/src/hooks/__tests__/__snapshots__/useSuspense.native.tsx.snap b/packages/react/src/hooks/__tests__/__snapshots__/useSuspense.native.tsx.snap
@@ -4,15 +4,13 @@ exports[`useSuspense() errors should throw error when response is {} when expect
 [Error: Error processing GET http://test.com/article-cooler/400
 
 Full Schema: {
-  "name": "CoolerArticle",
+  "key": "CoolerArticle",
   "schema": {
     "author": {
-      "name": "User",
-      "schema": {},
-      "key": "User"
+      "key": "User",
+      "schema": {}
     }
-  },
-  "key": "CoolerArticle"
+  }
 }
 
 Error:
@@ -31,15 +29,13 @@ exports[`useSuspense() errors should throw error when response is array when exp
 [Error: Error processing GET http://test.com/article-cooler/400
 
 Full Schema: {
-  "name": "CoolerArticle",
+  "key": "CoolerArticle",
   "schema": {
     "author": {
-      "name": "User",
-      "schema": {},
-      "key": "User"
+      "key": "User",
+      "schema": {}
     }
-  },
-  "key": "CoolerArticle"
+  }
 }
 
 Error:
@@ -58,15 +54,13 @@ exports[`useSuspense() errors should throw error when response is number when ex
 [Error: Error processing GET http://test.com/article-cooler/400
 
 Full Schema: {
-  "name": "CoolerArticle",
+  "key": "CoolerArticle",
   "schema": {
     "author": {
-      "name": "User",
-      "schema": {},
-      "key": "User"
+      "key": "User",
+      "schema": {}
     }
-  },
-  "key": "CoolerArticle"
+  }
 }
 
 Error:
@@ -85,15 +79,13 @@ exports[`useSuspense() errors should throw error when response is string when ex
 [Error: Error processing GET http://test.com/article-cooler/400
 
 Full Schema: {
-  "name": "CoolerArticle",
+  "key": "CoolerArticle",
   "schema": {
     "author": {
-      "name": "User",
-      "schema": {},
-      "key": "User"
+      "key": "User",
+      "schema": {}
     }
-  },
-  "key": "CoolerArticle"
+  }
 }
 
 Error:
diff --git a/packages/react/src/hooks/__tests__/__snapshots__/useSuspense.web.tsx.snap b/packages/react/src/hooks/__tests__/__snapshots__/useSuspense.web.tsx.snap
@@ -4,15 +4,13 @@ exports[`useSuspense() errors should throw error when response is {} when expect
 [Error: Error processing GET http://test.com/article-cooler/400
 
 Full Schema: {
-  "name": "CoolerArticle",
+  "key": "CoolerArticle",
   "schema": {
     "author": {
-      "name": "User",
-      "schema": {},
-      "key": "User"
+      "key": "User",
+      "schema": {}
     }
-  },
-  "key": "CoolerArticle"
+  }
 }
 
 Error:
@@ -31,15 +29,13 @@ exports[`useSuspense() errors should throw error when response is array when exp
 [Error: Error processing GET http://test.com/article-cooler/400
 
 Full Schema: {
-  "name": "CoolerArticle",
+  "key": "CoolerArticle",
   "schema": {
     "author": {
-      "name": "User",
-      "schema": {},
-      "key": "User"
+      "key": "User",
+      "schema": {}
     }
-  },
-  "key": "CoolerArticle"
+  }
 }
 
 Error:
@@ -58,15 +54,13 @@ exports[`useSuspense() errors should throw error when response is number when ex
 [Error: Error processing GET http://test.com/article-cooler/400
 
 Full Schema: {
-  "name": "CoolerArticle",
+  "key": "CoolerArticle",
   "schema": {
     "author": {
-      "name": "User",
-      "schema": {},
-      "key": "User"
+      "key": "User",
+      "schema": {}
     }
-  },
-  "key": "CoolerArticle"
+  }
 }
 
 Error:
@@ -85,15 +79,13 @@ exports[`useSuspense() errors should throw error when response is string when ex
 [Error: Error processing GET http://test.com/article-cooler/400
 
 Full Schema: {
-  "name": "CoolerArticle",
+  "key": "CoolerArticle",
   "schema": {
     "author": {
-      "name": "User",
-      "schema": {},
-      "key": "User"
+      "key": "User",
+      "schema": {}
     }
-  },
-  "key": "CoolerArticle"
+  }
 }
 
 Error:
diff --git a/packages/react/src/hooks/__tests__/useController/__snapshots__/set.tsx.snap b/packages/react/src/hooks/__tests__/useController/__snapshots__/set.tsx.snap

Original file line number	Diff line number	Diff line change
`@@ -28,9 +28,8 @@ export default function EntitySchema<TBase extends Constructor>(`
`28`	`28`
`29`	`29`	`static toJSON() {`
`30`	`30`	`return {`
`31`		`- name: this.name,`
`32`		`- schema: this.schema,`
`33`	`31`	`key: this.key,`
	`32`	`+ schema: this.schema,`
`34`	`33`	`};`
`35`	`34`	`}`
`36`	`35`
Original file line number	Diff line number	Diff line change
`@@ -284,9 +284,8 @@ See https://dataclient.io/rest/api/RestEndpoint#parseResponse for more informati`
`284`	`284`
`285`	`285`	`Schema: [`
`286`	`286`	`{`
`287`		`- "name": "User",`
`288`		`- "schema": {},`
`289`		`- "key": "User"`
	`287`	`+ "key": "User",`
	`288`	`+ "schema": {}`
`290`	`289`	`}`
`291`	`290`	`]`
`292`	`291`	`Input: "[{"id":5}]""`
@@ -297,9 +296,8 @@ exports[`AllSchema normalization (%s) should throw a custom error if data loads
`297`	`296`
`298`	`297`	`Schema: [`
`299`	`298`	`{`
`300`		`- "name": "User",`
`301`		`- "schema": {},`
`302`		`- "key": "User"`
	`299`	`+ "key": "User",`
	`300`	`+ "schema": {}`
`303`	`301`	`}`
`304`	`302`	`]`
`305`	`303`	`Input: "abc""`
Original file line number	Diff line number	Diff line change
`@@ -446,9 +446,8 @@ See https://dataclient.io/rest/api/RestEndpoint#parseResponse for more informati`
`446`	`446`
`447`	`447`	`Schema: [`
`448`	`448`	`{`
`449`		`- "name": "User",`
`450`		`- "schema": {},`
`451`		`- "key": "User"`
	`449`	`+ "key": "User",`
	`450`	`+ "schema": {}`
`452`	`451`	`}`
`453`	`452`	`]`
`454`	`453`	`Input: "[{"id":5}]""`
@@ -459,9 +458,8 @@ exports[`ArraySchema normalization (plain) Object should throw a custom error if
`459`	`458`
`460`	`459`	`Schema: [`
`461`	`460`	`{`
`462`		`- "name": "User",`
`463`		`- "schema": {},`
`464`		`- "key": "User"`
	`461`	`+ "key": "User",`
	`462`	`+ "schema": {}`
`465`	`463`	`}`
`466`	`464`	`]`
`467`	`465`	`Input: "abc""`
`@@ -913,9 +911,8 @@ See https://dataclient.io/rest/api/RestEndpoint#parseResponse for more informati`
`913`	`911`
`914`	`912`	`Schema: [`
`915`	`913`	`{`
`916`		`- "name": "User",`
`917`		`- "schema": {},`
`918`		`- "key": "User"`
	`914`	`+ "key": "User",`
	`915`	`+ "schema": {}`
`919`	`916`	`}`
`920`	`917`	`]`
`921`	`918`	`Input: "[{"id":5}]""`
@@ -926,9 +923,8 @@ exports[`ArraySchema normalization (schema) Object should throw a custom error i
`926`	`923`
`927`	`924`	`Schema: [`
`928`	`925`	`{`
`929`		`- "name": "User",`
`930`		`- "schema": {},`
`931`		`- "key": "User"`
	`926`	`+ "key": "User",`
	`927`	`+ "schema": {}`
`932`	`928`	`}`
`933`	`929`	`]`
`934`	`930`	`Input: "abc""`
Original file line number	Diff line number	Diff line change
@@ -549,9 +549,8 @@ exports[`Entity normalization should throw a custom error if data loads with str
`549`	`549`
`550`	`550`	`Schema: {`
`551`	`551`	`"data": {`
`552`		`- "name": "MyEntity",`
`553`		`- "schema": {},`
`554`		`- "key": "MyEntity"`
	`552`	`+ "key": "MyEntity",`
	`553`	`+ "schema": {}`
`555`	`554`	`}`
`556`	`555`	`}`
`557`	`556`	`Input: "hibho""`
Original file line number	Diff line number	Diff line change
@@ -561,9 +561,8 @@ exports[`EntitySchema normalization should throw a custom error if data loads wi
`561`	`561`
`562`	`562`	`Schema: {`
`563`	`563`	`"data": {`
`564`		`- "name": "EntityMixin",`
`565`		`- "schema": {},`
`566`		`- "key": "MyData"`
	`564`	`+ "key": "MyData",`
	`565`	`+ "schema": {}`
`567`	`566`	`}`
`568`	`567`	`}`
`569`	`568`	`Input: "hibho""`