docs: Update Entity docstring

Author: ntucker

.changeset/stupid-sloths-wash.md

@@ -0,0 +1,5 @@
+---
+'@data-client/endpoint': patch
+---
+
+Update Entity docstring

packages/endpoint/src/schema.js

@@ -6,5 +6,5 @@ export { default as All } from './schemas/All.js';
 export { default as Object } from './schemas/Object.js';
 export { default as Invalidate } from './schemas/Invalidate.js';
 export { default as Collection } from './schemas/Collection.js';
-export { default as Entity } from './schemas/EntitySchema.js';
+export { default as Entity } from './schemas/EntityMixin.js';
 export { default as Query } from './schemas/Query.js';

packages/endpoint/src/schemas/Entity.ts

@@ -10,7 +10,7 @@ const EmptyBase = class {} as any as abstract new (...args: any[]) => {
 };
 
 /**
- * Represents data that should be deduped by specifying a primary key.
+ * Entity defines a single (globally) unique object.
  * @see https://dataclient.io/rest/api/Entity
  */
 export default abstract class Entity extends EntityMixin(EmptyBase) {

packages/endpoint/src/schemas/EntitySchema.ts renamed to packages/endpoint/src/schemas/EntityMixin.ts

@@ -9,15 +9,15 @@ import type {
 import { AbstractInstanceType } from '../normal.js';
 
 /**
- * Represents data that should be deduped by specifying a primary key.
+ * Entity defines a single (globally) unique object.
  * @see https://dataclient.io/rest/api/schema.Entity
  */
 export default function EntityMixin<TBase extends Constructor>(
   Base: TBase,
   options: EntityOptions<InstanceType<TBase>> = {},
 ) {
   /**
-   * Represents data that should be deduped by specifying a primary key.
+   * Entity defines a single (globally) unique object.
    * @see https://dataclient.io/rest/api/Entity
    */
   abstract class EntityMixin extends Base {

website/src/components/Playground/editor-types/@data-client/endpoint.d.ts

@@ -1106,7 +1106,7 @@ declare const Entity_base: IEntityClass<abstract new (...args: any[]) => {
     pk(parent?: any, key?: string, args?: readonly any[]): string | number | undefined;
 });
 /**
- * Represents data that should be deduped by specifying a primary key.
+ * Entity defines a single (globally) unique object.
  * @see https://dataclient.io/rest/api/Entity
  */
 declare abstract class Entity extends Entity_base {

website/src/components/Playground/editor-types/@data-client/graphql.d.ts

@@ -1106,7 +1106,7 @@ declare const Entity_base: IEntityClass<abstract new (...args: any[]) => {
     pk(parent?: any, key?: string, args?: readonly any[]): string | number | undefined;
 });
 /**
- * Represents data that should be deduped by specifying a primary key.
+ * Entity defines a single (globally) unique object.
  * @see https://dataclient.io/rest/api/Entity
  */
 declare abstract class Entity extends Entity_base {

website/src/components/Playground/editor-types/@data-client/rest.d.ts

@@ -1104,7 +1104,7 @@ declare const Entity_base: IEntityClass<abstract new (...args: any[]) => {
     pk(parent?: any, key?: string, args?: readonly any[]): string | number | undefined;
 });
 /**
- * Represents data that should be deduped by specifying a primary key.
+ * Entity defines a single (globally) unique object.
  * @see https://dataclient.io/rest/api/Entity
  */
 declare abstract class Entity extends Entity_base {

website/src/components/Playground/editor-types/globals.d.ts

@@ -1108,7 +1108,7 @@ declare const Entity_base: IEntityClass<abstract new (...args: any[]) => {
     pk(parent?: any, key?: string, args?: readonly any[]): string | number | undefined;
 });
 /**
- * Represents data that should be deduped by specifying a primary key.
+ * Entity defines a single (globally) unique object.
  * @see https://dataclient.io/rest/api/Entity
  */
 declare abstract class Entity extends Entity_base {