feat: add deleteEntity

Author: nikgraf

.changeset/whole-years-trade.md

@@ -0,0 +1,5 @@
+---
+"@graphprotocol/grc-20": minor
+---
+
+add Graph.deleteEntity

package.json

@@ -31,9 +31,10 @@
   "dependencies": {
     "@bufbuild/protobuf": "^1.9.0",
     "@changesets/cli": "^2.27.12",
+    "effect": "^3.13.6",
     "ethers": "^5.7.2",
     "fflate": "^0.8.2",
-    "effect": "^3.13.6",
+    "graphql-request": "^7.1.2",
     "image-size": "^2.0.0",
     "permissionless": "^0.2.35",
     "position-strings": "^2.0.1",

pnpm-lock.yaml

@@ -0,0 +1,43 @@
+import { beforeEach, describe, expect, it, vi } from 'vitest';
+import { Id } from '../id.js';
+import { deleteEntity } from './delete-entity.js';
+
+describe('deleteEntity', () => {
+  beforeEach(() => {
+    // mock graphql request
+    vi.mock('graphql-request', () => ({
+      request: vi.fn().mockResolvedValue({
+        entity: {
+          attributes: [
+            {
+              attribute: Id("X2gz1QCwFju9FwE8MUgbFi"),
+            },
+          ],
+          relations: [
+            {
+              id: Id("U4WBHFMVfWXM18vGn25Fv3"),
+            },
+          ],
+        },
+      }),
+      gql: vi.fn(),
+    }));
+  });
+
+  it('should delete an entity from the graph', async () => {
+    const { ops } = await deleteEntity({ id: Id("CffgzbUGPbAadPhAvi9HVy"), space: Id("3JqLpajfPwQJMRT3drhvPu") });
+    expect(ops).toEqual([
+      {
+        type: 'DELETE_TRIPLE',
+        triple: {
+          attribute: 'X2gz1QCwFju9FwE8MUgbFi',
+          entity: 'CffgzbUGPbAadPhAvi9HVy'
+        }
+      },
+      {
+        type: 'DELETE_RELATION',
+        relation: { id: 'U4WBHFMVfWXM18vGn25Fv3' }
+      }
+    ])
+  })
+})

src/graph/delete-entity.test.ts

@@ -0,0 +1,60 @@
+import { gql, request } from 'graphql-request';
+import { Relation } from '../relation.js';
+import { Triple } from '../triple.js';
+import type { Op } from '../types.js';
+
+const ENDPOINT = 'https://kg.thegraph.com/graphql';
+
+const deleteEntityQueryDocument = gql`
+query deleteEntity($spaceId: String!, $id: String!) {
+  entity(spaceId: $spaceId, id: $id) {
+    attributes {
+      attribute
+    }
+    relations {
+      id
+    }
+  }
+}
+`;
+
+type DeleteEntityResult = {
+  entity: {
+    attributes: {
+      attribute: string;
+    }[];
+    relations: {
+      id: string;
+    }[];
+  } | null;
+};
+
+/**
+ * Deletes an entity from the graph.
+ * 
+ * @example
+ * ```ts
+ * const { ops } = await deleteEntity({ id: entityId, space: spaceId });
+ * ```
+ * 
+ * @param id - The id of the entity to delete.
+ * @param space - The space of the entity to delete.
+ * @returns The operations to delete the entity.
+ */
+export const deleteEntity = async ({ id, space }: { id: string; space: string }) => {
+  const result = await request<DeleteEntityResult>(ENDPOINT, deleteEntityQueryDocument, {
+    id,
+    spaceId: space,
+  });
+  if (result.entity === null) {
+    throw new Error('Entity not found');
+  }
+  const ops: Op[] = [];
+  for (const attribute of result.entity.attributes) {
+    ops.push(Triple.remove({ attributeId: attribute.attribute, entityId: id }));
+  }
+  for (const relation of result.entity.relations) {
+    ops.push(Relation.remove(relation.id));
+  }
+  return { ops };
+};

src/graph/delete-entity.ts

@@ -3,3 +3,4 @@ export * from './create-image.js';
 export * from './create-property.js';
 export * from './create-space.js';
 export * from './create-type.js';
+export * from './delete-entity.js';