feat: add draft of first utlity functions

Author: nikgraf

index.ts

@@ -14,7 +14,11 @@ export * as ID from './src/id.js';
  *
  * @since 0.0.6
  */
-export { BASE58_ALLOWED_CHARS, decodeBase58ToUUID, encodeBase58 } from './src/core/base58.js';
+export {
+  BASE58_ALLOWED_CHARS,
+  decodeBase58ToUUID,
+  encodeBase58,
+} from './src/core/base58.js';
 
 export {
   getAcceptEditorArguments,
@@ -33,7 +37,7 @@ export {
  */
 export { Account } from './src/account.js';
 
-export { TextBlock, DataBlock, ImageBlock } from './src/blocks.js';
+export { DataBlock, ImageBlock, TextBlock } from './src/blocks.js';
 
 /**
  * This module provides utility functions for working with knowledge graph
@@ -69,7 +73,7 @@ export { GraphUrl } from './src/scheme.js';
 /**
  * Provides ids for commonly used entities across the Knowledge Graph.
  */
-export { SYSTEM_IDS, NETWORK_IDS, CONTENT_IDS } from './src/system-ids.js';
+export { CONTENT_IDS, NETWORK_IDS, SYSTEM_IDS } from './src/system-ids.js';
 
 export { getChecksumAddress } from './src/core/get-checksum-address.js';
 
@@ -80,3 +84,10 @@ export { getChecksumAddress } from './src/core/get-checksum-address.js';
  * @since 0.1.1
  */
 export * as IPFS from './src/ipfs.js';
+
+/**
+ * This module provides high-level utility functions for working with the Knowledge Graph API.
+ *
+ * @since 0.5.0
+ */
+export * as Graph from './src/graph/index.js';

package.json

@@ -7,9 +7,7 @@
   "main": "./dist/index.js",
   "ascMain": "./dist/index.js",
   "type": "module",
-  "files": [
-    "dist"
-  ],
+  "files": ["dist"],
   "exports": {
     "./package.json": "./package.json",
     ".": "./dist/index.js",
@@ -47,6 +45,5 @@
     "@bufbuild/buf": "^1.31.0",
     "@bufbuild/protoc-gen-es": "^1.9.0",
     "typescript": "^5.4.5"
-  },
-  "packageManager": "[email protected]"
+  }
 }

src/graph/constants.ts

@@ -0,0 +1 @@
+export const DEFAULT_API_HOST = 'https://api-testnet.grc-20.thegraph.com';

src/graph/create-entity.ts

@@ -0,0 +1,75 @@
+import { publishEdit } from '../ipfs.js';
+import { Triple } from '../triple.js';
+import type { SetTripleOp } from '../types.js';
+import { DEFAULT_API_HOST } from './constants.js';
+
+type Params = {
+  id: string;
+  spaceId: string;
+  accountId: string;
+  data: {
+    [filedName: string]: string;
+  };
+  mapping: {
+    [filedName: string]: string;
+  };
+  options?: {
+    apiHost?: string;
+    network?: 'TESTNET' | 'MAINNET';
+  };
+};
+
+export const createEntity = async ({ id, data, spaceId, accountId, mapping, options }: Params) => {
+  const ops: SetTripleOp[] = [];
+  const apiHost = options?.apiHost || DEFAULT_API_HOST;
+  const network = options?.network || 'TESTNET';
+  for (const [fieldName, value] of Object.entries(data)) {
+    const attributeId = mapping[fieldName];
+    if (!attributeId) {
+      throw new Error(`Attribute ID for field ${fieldName} not found`);
+    }
+    let attributeValueType: 'TEXT' | 'CHECKBOX' | 'NUMBER' | 'URL' | 'POINT';
+    switch (typeof value) {
+      case 'string':
+        attributeValueType = 'TEXT';
+        break;
+      case 'boolean':
+        attributeValueType = 'CHECKBOX';
+        break;
+      case 'number':
+        attributeValueType = 'NUMBER';
+        break;
+      default:
+        throw new Error('Not implemented value type');
+    }
+    const setTripleOp: SetTripleOp = Triple.make({
+      entityId: id,
+      attributeId,
+      value: {
+        type: attributeValueType,
+        value,
+      },
+    });
+
+    ops.push(setTripleOp);
+  }
+
+  const cid = await publishEdit({
+    name: 'Edit name',
+    ops,
+    author: accountId,
+  });
+
+  const result = await fetch(`${apiHost}/space/${spaceId}/edit/calldata`, {
+    method: 'POST',
+    body: JSON.stringify({
+      cid: cid,
+      network,
+    }),
+  });
+
+  const jsonResult = await result.json();
+  return jsonResult;
+
+  // TODO add walletClient.sendTransaction
+};

src/graph/create-space.ts

@@ -0,0 +1,26 @@
+import { DEFAULT_API_HOST } from './constants.js';
+
+type Params = {
+  editorAddress: string;
+  name: string;
+  options?: {
+    apiHost?: string;
+  };
+};
+
+export const createSpace = async (params: Params) => {
+  const apiHost = params.options?.apiHost || DEFAULT_API_HOST;
+  const result = await fetch(`${apiHost}/deploy`, {
+    method: 'POST',
+    body: JSON.stringify({
+      spaceName: params.name,
+      initialEditorAddress: params.editorAddress,
+    }),
+    headers: {
+      'Content-Type': 'application/json',
+    },
+  });
+
+  const { spaceId } = await result.json();
+  return { id: spaceId };
+};

src/graph/index.ts

@@ -0,0 +1,2 @@
+export * from './create-entity.js';
+export * from './create-space.js';