feat: js docs (#13)

* feat: initial js docs

* feat: add examples to relations

* feat: add examples to triples

* feat: graphuri scheme docs

* feat: add js docs for dynamic entities

* feat: add changeset

Author: baiirun

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "restricted",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

.changeset/smart-rings-cry.md

@@ -0,0 +1,5 @@
+---
+'@graphprotocol/grc-20': patch
+---
+
+Adds JS Doc comments to APIs

abis.ts

@@ -1 +1,7 @@
+/**
+ * This module provides ABIs for known smart contracts used in the knowledge graph.
+ *
+ * @since 0.0.6
+ */
+
 export * from './src/abis/index.js';

constants.ts

@@ -1,3 +1,9 @@
+/**
+ * This module provides common constants used in the knowledge graph.
+ *
+ * @since 0.0.6
+ */
+
 import { Position, PositionRange } from './src/position.js';
 
 export const INITIAL_RELATION_INDEX_VALUE = Position.createBetween(PositionRange.FIRST);

contracts.ts

@@ -1,6 +1,13 @@
-// GOVERNANCE PLUGIN ADDRESSES
-// from the plugin-repo-info.json in geo-contracts after deploying
-// Jul 15, 2024 – L3 Testnet
+/**
+ * This module provides the known contract addresses for smart contracts
+ * used in the knowledge graph.
+ *
+ * @since 0.0.6
+ */
+
+/**
+ * Mainnet contract addresses
+ */
 export const MAINNET = {
   SPACE_PLUGIN_REPO_ADDRESS: '0xd9559df98e4103CDf0A119d4bff1537B383E462c',
   PERSONAL_SPACE_ADMIN_PLUGIN_REPO_ADDRESS: '0xa00870c6501349E126E71Dc1705fBaa2B5aeac0d',
@@ -10,6 +17,9 @@ export const MAINNET = {
   PLUGIN_SETUP_PROCESSOR_ADDRESS: '0xfcC0Aba63c1F1f887099EAB0d1A624A5B7A82Fc2',
 };
 
+/**
+ * Testnet contract addresses
+ */
 export const TESTNET = {
   SPACE_PLUGIN_REPO_ADDRESS: '0x0701454b0e80C53Ee8c3e0805616424758D7E7Fd',
   PERSONAL_SPACE_ADMIN_PLUGIN_REPO_ADDRESS: '0xAe8Ac47e5f3bDa62F6D1BD140AB8e1926D867355',

index.ts

@@ -1,7 +1,21 @@
 export * from './src/types.js';
 
+/**
+ * This module provides utility functions for working knowledge graph
+ * identifiers in TypeScript.
+ *
+ * @since 0.0.6
+ */
 export * as ID from './src/id.js';
+
+/**
+ * This module provides utility functions for working with base58 ids
+ * in TypeScript.
+ *
+ * @since 0.0.6
+ */
 export { BASE58_ALLOWED_CHARS, decodeBase58ToUUID, encodeBase58 } from './src/core/base58.js';
+
 export {
   getAcceptEditorArguments,
   getAcceptSubspaceArguments,
@@ -10,12 +24,51 @@ export {
   getRemoveEditorArguments,
   getRemoveSubspaceArguments,
 } from './src/encodings/index.js';
+
+/**
+ * This module provides utility functions for working with knowledge graph
+ * images in TypeScript.
+ *
+ * @since 0.0.6
+ */
 export { Account } from './src/account.js';
-export { TextBlock, DataBlock } from './src/blocks.js';
+
+export { TextBlock, DataBlock, ImageBlock } from './src/blocks.js';
+
+/**
+ * This module provides utility functions for working with knowledge graph
+ * images in TypeScript.
+ *
+ * @since 0.0.6
+ */
 export { Image } from './src/image.js';
+
 export { Position, PositionRange } from './src/position.js';
+
+/**
+ * This module provides utility functions for working with Triples in TypeScript.
+ *
+ * @since 0.0.6
+ */
 export { Triple } from './src/triple.js';
+
+/**
+ * This module provides utility functions for working with Relations in TypeScript.
+ *
+ * @since 0.0.6
+ */
 export { Relation } from './src/relation.js';
+
+/**
+ * This module provides utility functions for working with Graph URIs in TypeScript.
+ *
+ * @since 0.0.6
+ */
 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 { getChecksumAddress } from './src/core/get-checksum-address.js';

package.json

@@ -1,13 +1,15 @@
 {
   "name": "@graphprotocol/grc-20",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "license": "MIT",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",
   "ascMain": "./dist/index.js",
   "type": "module",
-  "files": ["dist"],
+  "files": [
+    "dist"
+  ],
   "exports": {
     "./package.json": "./package.json",
     ".": "./dist/index.js",
@@ -26,6 +28,7 @@
   "dependencies": {
     "@biomejs/biome": "^1.9.4",
     "@bufbuild/protobuf": "^1.9.0",
+    "@changesets/cli": "^2.27.12",
     "@ethersproject/abi": "^5.6.4",
     "@ethersproject/providers": "^5.6.8",
     "@types/uuid": "^9.0.8",
@@ -43,5 +46,5 @@
     "prettier": "^3.2.5",
     "typescript": "^5.4.5"
   },
-  "packageManager": "[email protected]" 
+  "packageManager": "[email protected]"
 }