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

reactive · Aug 14, 2024 · fd5b296 · fd5b296
1 parent d2898c6
commit fd5b296
Show file tree

Hide file tree

Showing 37 changed files with 327 additions and 489 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/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/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/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/_useLoading.mdx b/docs/core/shared/_useLoading.mdx
@@ -13,9 +13,6 @@ export class Post extends Entity {
   body = '';
   votes = 0;
 
-  pk() {
-    return this.id;
-  }
   static key = 'Post';
 
   get img() {

diff --git a/docs/rest/README.md b/docs/rest/README.md
@@ -40,6 +40,8 @@ export class User extends Entity {
   pk() {
     return this.id;
   }
+
+  static key = 'User';
 }
 ```
 
@@ -59,12 +61,12 @@ export class Article extends Entity {
     return this.id;
   }
 
+  static key = 'Article';
+
   static schema = {
     author: User,
     createdAt: Temporal.Instant.from,
   };
-
-  static key = 'Article';
 }
 
 export const ArticleResource = resource({
@@ -263,14 +265,20 @@ resolves to the new Resource created by the API. It will automatically be added
 import { useController } from '@data-client/react';
 import { Article, ArticleResource } from 'api/article';
 
-export default function ArticleWithDelete({ article }: { article: Article }) {
+export default function ArticleWithDelete({
+  article,
+}: {
+  article: Article;
+}) {
   const ctrl = useController();
   return (
     <article>
       <h2>{article.title}</h2>
       <div>{article.content}</div>
       <button
-        onClick={() => ctrl.fetch(ArticleResource.delete, { id: article.id })}
+        onClick={() =>
+          ctrl.fetch(ArticleResource.delete, { id: article.id })
+        }
       >
         Delete
       </button>