enhance: Entity.pk() default provided that uses id

reactive · Aug 14, 2024 · 6da505f · 6da505f
1 parent 3ce0bbf
commit 6da505f
Show file tree

Hide file tree

Showing 52 changed files with 341 additions and 599 deletions.
diff --git a/README.md b/README.md
@@ -45,10 +45,6 @@ For more details, see [the Installation docs page](https://dataclient.io/docs/ge
 class User extends Entity {
   id = '';
   username = '';
-
-  pk() {
-    return this.id;
-  }
 }
 
 class Article extends Entity {
@@ -58,10 +54,6 @@ class Article extends Entity {
   author = User.fromJS();
   createdAt = Temporal.Instant.fromEpochSeconds(0);
 
-  pk() {
-    return this.id;
-  }
-
   static schema = {
     author: User,
     createdAt: Temporal.Instant.from,

diff --git a/__tests__/new.ts b/__tests__/new.ts
@@ -162,10 +162,6 @@ export class User extends Entity {
   readonly username: string = '';
   readonly email: string = '';
   readonly isAdmin: boolean = false;
-
-  pk() {
-    return this.id?.toString();
-  }
 }
 export const UserResource = resource({
   path: 'http\\://test.com/user/:id',
@@ -179,10 +175,6 @@ export class Article extends Entity {
   readonly author: User | null = null;
   readonly tags: string[] = [];
 
-  pk() {
-    return this.id?.toString();
-  }
-
   static schema = {
     author: User,
   };
@@ -621,10 +613,6 @@ export abstract class UnionBase extends Entity {
   readonly id: string = '';
   readonly body: string = '';
   readonly type: string = '';
-
-  pk() {
-    return this.id;
-  }
 }
 export class FirstUnion extends UnionBase {
   readonly type = 'first';

diff --git a/docs/core/api/useCache.md b/docs/core/api/useCache.md
@@ -37,9 +37,7 @@ export class User extends Entity {
   id = '';
   name = '';
   isAdmin = false;
-  pk() {
-    return this.id;
-  }
+
   static key = 'User';
 }
 export const UserResource = resource({

diff --git a/docs/core/api/useDLE.md b/docs/core/api/useDLE.md
@@ -34,9 +34,6 @@ export class Profile extends Entity {
   fullName = '';
   bio = '';
 
-  pk() {
-    return this.id?.toString();
-  }
   static key = 'Profile';
 }
 
@@ -148,9 +145,6 @@ export class Profile extends Entity {
   fullName = '';
   bio = '';
 
-  pk() {
-    return this.id?.toString();
-  }
   static key = 'Profile';
 }
 
@@ -202,9 +196,6 @@ export class Post extends Entity {
   title = '';
   body = '';
 
-  pk() {
-    return this.id?.toString();
-  }
   static key = 'Post';
 }
 export const PostResource = resource({
@@ -224,9 +215,6 @@ export class User extends Entity {
     return `https://i.pravatar.cc/64?img=${this.id + 4}`;
   }
 
-  pk() {
-    return `${this.id}`;
-  }
   static key = 'User';
 }
 export const UserResource = resource({
@@ -272,9 +260,6 @@ export class PaginatedPost extends Entity {
   title = '';
   content = '';
 
-  pk() {
-    return this.id;
-  }
   static key = 'PaginatedPost';
 }
 

diff --git a/docs/core/api/useQuery.md b/docs/core/api/useQuery.md
@@ -95,9 +95,7 @@ export class User extends Entity {
   id = '';
   name = '';
   isAdmin = false;
-  pk() {
-    return this.id;
-  }
+
   static key = 'User';
 }
 export const UserResource = resource({

diff --git a/docs/core/api/useSubscription.md b/docs/core/api/useSubscription.md
@@ -91,7 +91,6 @@ function useSubscription<
 ### Only subscribe while element is visible
 
 ```tsx title="MasterPrice.tsx"
-import { useRef } from 'react';
 import { useSuspense, useSubscription } from '@data-client/react';
 import { getPrice } from 'api/Price';
 

diff --git a/docs/core/api/useSuspense.md b/docs/core/api/useSuspense.md
@@ -52,9 +52,6 @@ export class Profile extends Entity {
   fullName = '';
   bio = '';
 
-  pk() {
-    return this.id?.toString();
-  }
   static key = 'Profile';
 }
 
@@ -204,9 +201,6 @@ export class Profile extends Entity {
   fullName = '';
   bio = '';
 
-  pk() {
-    return this.id?.toString();
-  }
   static key = 'Profile';
 }
 
@@ -276,9 +270,6 @@ export class Post extends Entity {
   title = '';
   body = '';
 
-  pk() {
-    return this.id?.toString();
-  }
   static key = 'Post';
 }
 export const PostResource = resource({
@@ -298,9 +289,6 @@ export class User extends Entity {
     return `https://i.pravatar.cc/64?img=${this.id + 4}`;
   }
 
-  pk() {
-    return `${this.id}`;
-  }
   static key = 'User';
 }
 export const UserResource = resource({
@@ -336,15 +324,12 @@ When entities are stored in [nested structures](/rest/guides/relational-data#nes
 
 <TypeScriptEditor row={false}>
 
-```typescript title="api/Post" {15-19}
+```typescript title="api/Post" {12-16}
 export class PaginatedPost extends Entity {
   id = '';
   title = '';
   content = '';
 
-  pk() {
-    return this.id;
-  }
   static key = 'PaginatedPost';
 }
 

diff --git a/docs/core/concepts/error-policy.md b/docs/core/concepts/error-policy.md
@@ -49,9 +49,6 @@ delay: () => 150,
 export class TimedEntity extends Entity {
   id = '';
   updatedAt = Temporal.Instant.fromEpochSeconds(0);
-  pk() {
-    return this.id;
-  }
 
   static schema = {
     updatedAt: Temporal.Instant.from,

diff --git a/docs/core/concepts/expiry-policy.md b/docs/core/concepts/expiry-policy.md
@@ -74,9 +74,6 @@ export class TimedEntity extends Entity {
   id = '';
   updatedAt = Temporal.Instant.fromEpochSeconds(0);
 
-  pk() {
-    return this.id;
-  }
   static schema = {
     updatedAt: Temporal.Instant.from,
   };
@@ -216,9 +213,6 @@ delay: () => 150,
 export class TimedEntity extends Entity {
   id = '';
   updatedAt = Temporal.Instant.fromEpochSeconds(0);
-  pk() {
-    return this.id;
-  }
 
   static schema = {
     updatedAt: Temporal.Instant.from,
@@ -314,9 +308,6 @@ delay: () => 150,
 export class TimedEntity extends Entity {
   id = '';
   updatedAt = Temporal.Instant.fromEpochSeconds(0);
-  pk() {
-    return this.id;
-  }
 
   static schema = {
     updatedAt: Temporal.Instant.from,
@@ -378,9 +369,6 @@ delay: () => 150,
 export class TimedEntity extends Entity {
   id = '';
   updatedAt = Temporal.Instant.fromEpochSeconds(0);
-  pk() {
-    return this.id;
-  }
 
   static schema = {
     updatedAt: Temporal.Instant.from,
@@ -482,9 +470,6 @@ delay: () => 150,
 export class TimedEntity extends Entity {
   id = '';
   updatedAt = Temporal.Instant.fromEpochSeconds(0);
-  pk() {
-    return this.id;
-  }
 
   static schema = {
     updatedAt: Temporal.Instant.from,
@@ -595,9 +580,6 @@ delay: () => 150,
 export class TimedEntity extends Entity {
   id = '';
   updatedAt = Temporal.Instant.fromEpochSeconds(0);
-  pk() {
-    return this.id;
-  }
 
   static schema = {
     updatedAt: Temporal.Instant.from,

diff --git a/docs/core/concepts/validation.md b/docs/core/concepts/validation.md
@@ -45,12 +45,8 @@ delay: 150,
 
 ```typescript title="api/Article"
 export class Article extends Entity {
-  readonly id: string = '';
-  readonly title: string = '';
-
-  pk() {
-    return this.id;
-  }
+  id = '';
+  title = '';
 
   static validate(processedEntity) {
     if (!Object.hasOwn(processedEntity, 'title')) return 'missing title field';
@@ -79,7 +75,7 @@ render(<ArticlePage id="2" />);
 
 ### All fields check
 
-Here's a recipe for checking that every defined field is present.
+[validateRequired()](/rest/api/validateRequired) can be used to check if all defined fields are present.
 
 <HooksPlayground fixtures={[
 {
@@ -104,20 +100,11 @@ delay: 150,
 
 ```tsx title="api/Article"
 export class Article extends Entity {
-  readonly id: string = '';
-  readonly title: string = '';
-
-  pk() {
-    return this.id;
-  }
+  id = '';
+  title = '';
 
   static validate(processedEntity) {
-    if (
-      !Object.keys(this.defaults).every(key =>
-        Object.hasOwn(processedEntity, key),
-      )
-    )
-      return 'a field is missing';
+    return validateRequired(processedEntity, this.defaults);
   }
 }
 

diff --git a/docs/core/getting-started/data-dependency.md b/docs/core/getting-started/data-dependency.md
@@ -40,9 +40,6 @@ export class User extends Entity {
     return `https://i.pravatar.cc/64?img=${this.id + 4}`;
   }
 
-  pk() {
-    return this.id;
-  }
   static key = 'User';
 }
 export const UserResource = resource({
@@ -57,9 +54,6 @@ export class Post extends Entity {
   title = '';
   body = '';
 
-  pk() {
-    return this.id;
-  }
   static key = 'Post';
 
   static schema = {
@@ -322,9 +316,6 @@ export class Profile extends Entity {
   fullName = '';
   bio = '';
 
-  pk() {
-    return this.id?.toString();
-  }
   static key = 'Profile';
 }
 

diff --git a/docs/core/getting-started/mutations.md b/docs/core/getting-started/mutations.md
@@ -35,9 +35,7 @@ export class Todo extends Entity {
   userId = 0;
   title = '';
   completed = false;
-  pk() {
-    return `${this.id}`;
-  }
+
   static key = 'Todo';
 }
 export const TodoResource = resource({

diff --git a/docs/core/getting-started/resource.md b/docs/core/getting-started/resource.md
@@ -49,9 +49,6 @@ export class Todo extends Entity {
   title = '';
   completed = false;
 
-  pk() {
-    return `${this.id}`;
-  }
   static key = 'Todo';
 }
 

diff --git a/docs/core/guides/storybook.md b/docs/core/guides/storybook.md
@@ -36,9 +36,6 @@ export class Article extends Entity {
   author: number | null = null;
   contributors: number[] = [];
 
-  pk() {
-    return this.id?.toString();
-  }
   static key = 'Article';
 }
 export const ArticleResource = resource({

diff --git a/docs/core/shared/_VoteDemo.mdx b/docs/core/shared/_VoteDemo.mdx
@@ -13,9 +13,6 @@ export class Post extends Entity {
   body = '';
   votes = 0;
 
-  pk() {
-    return this.id;
-  }
   static key = 'Post';
 
   static schema = {

diff --git a/docs/core/shared/_useCancelling.mdx b/docs/core/shared/_useCancelling.mdx
@@ -8,9 +8,7 @@ export class Todo extends Entity {
   userId = 0;
   title = '';
   completed = false;
-  pk() {
-    return `${this.id}`;
-  }
+
   static key = 'Todo';
 }
 export const TodoResource = resource({