@graphprotocol/grc-20 0.28.0 → 0.29.0

package/dist/src/core/image.js

@@ -0,0 +1,76 @@
+/**
+ * This module provides utility functions for working with knowledge graph
+ * images in TypeScript.
+ *
+ * @since 0.0.6
+ */
+import { generate } from '../id.js';
+import { Relation } from '../relation.js';
+import { SystemIds } from '../system-ids.js';
+/**
+ * Creates an entity representing an Image.
+ *
+ * @example
+ * ```ts
+ * const { id, ops } = Image.make({
+ *   cid: 'https://example.com/image.png',
+ *   dimensions: { width: 100, height: 100 },
+ *   id: imageId, // optional and will be generated if not provided
+ * });
+ * console.log(id); // 'gw9uTVTnJdhtczyuzBkL3X'
+ * console.log(ops); // [...]
+ * ```
+ *
+ * @returns id – base58 encoded v4 uuid representing the image entity: {@link MakeImageReturnType}
+ * @returns ops – The ops for the Image entity: {@link MakeImageReturnType}
+ */
+export function make({ cid, dimensions, id }) {
+    const entityId = id ?? generate();
+    const ops = [
+        Relation.make({
+            fromId: entityId,
+            toId: SystemIds.IMAGE_TYPE,
+            relationTypeId: SystemIds.TYPES_PROPERTY,
+        }),
+        {
+            type: 'SET_TRIPLE',
+            triple: {
+                entity: entityId,
+                attribute: SystemIds.IMAGE_URL_PROPERTY,
+                value: {
+                    type: 'URL',
+                    value: cid,
+                },
+            },
+        },
+    ];
+    if (dimensions) {
+        ops.push({
+            type: 'SET_TRIPLE',
+            triple: {
+                entity: entityId,
+                attribute: SystemIds.IMAGE_HEIGHT_PROPERTY,
+                value: {
+                    type: 'NUMBER',
+                    value: dimensions.height.toString(),
+                },
+            },
+        });
+        ops.push({
+            type: 'SET_TRIPLE',
+            triple: {
+                entity: entityId,
+                attribute: SystemIds.IMAGE_WIDTH_PROPERTY,
+                value: {
+                    type: 'NUMBER',
+                    value: dimensions.width.toString(),
+                },
+            },
+        });
+    }
+    return {
+        id: entityId,
+        ops,
+    };
+}
+//# sourceMappingURL=image.js.map

package/dist/src/core/image.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"image.js","sourceRoot":"","sources":["../../../src/core/image.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAW,QAAQ,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAiB7C;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,IAAI,CAAC,EAAE,GAAG,EAAE,UAAU,EAAE,EAAE,EAAmB;IAC3D,MAAM,QAAQ,GAAG,EAAE,IAAI,QAAQ,EAAE,CAAC;IAClC,MAAM,GAAG,GAAc;QACrB,QAAQ,CAAC,IAAI,CAAC;YACZ,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,SAAS,CAAC,UAAU;YAC1B,cAAc,EAAE,SAAS,CAAC,cAAc;SACzC,CAAC;QACF;YACE,IAAI,EAAE,YAAY;YAClB,MAAM,EAAE;gBACN,MAAM,EAAE,QAAQ;gBAChB,SAAS,EAAE,SAAS,CAAC,kBAAkB;gBACvC,KAAK,EAAE;oBACL,IAAI,EAAE,KAAK;oBACX,KAAK,EAAE,GAAG;iBACX;aACF;SACF;KACF,CAAC;IAEF,IAAI,UAAU,EAAE,CAAC;QACf,GAAG,CAAC,IAAI,CAAC;YACP,IAAI,EAAE,YAAY;YAClB,MAAM,EAAE;gBACN,MAAM,EAAE,QAAQ;gBAChB,SAAS,EAAE,SAAS,CAAC,qBAAqB;gBAC1C,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,KAAK,EAAE,UAAU,CAAC,MAAM,CAAC,QAAQ,EAAE;iBACpC;aACF;SACF,CAAC,CAAC;QACH,GAAG,CAAC,IAAI,CAAC;YACP,IAAI,EAAE,YAAY;YAClB,MAAM,EAAE;gBACN,MAAM,EAAE,QAAQ;gBAChB,SAAS,EAAE,SAAS,CAAC,oBAAoB;gBACzC,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC,QAAQ,EAAE;iBACnC;aACF;SACF,CAAC,CAAC;IACL,CAAC;IAED,OAAO;QACL,EAAE,EAAE,QAAQ;QACZ,GAAG;KACJ,CAAC;AACJ,CAAC"}

package/dist/src/core/image.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=image.test.d.ts.map

package/dist/src/core/image.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"image.test.d.ts","sourceRoot":"","sources":["../../../src/core/image.test.ts"],"names":[],"mappings":""}

package/dist/src/core/image.test.js

@@ -0,0 +1,52 @@
+import { expect, it } from 'vitest';
+import { INITIAL_RELATION_INDEX_VALUE } from '~/constants.js';
+import { SystemIds } from '../system-ids.js';
+import { make } from './image.js';
+it('should generate ops for an image entity', () => {
+    const { id, ops } = make({ cid: 'https://example.com/image.png' });
+    // We check each field individually since we don't know the id of the relation
+    expect(typeof id).toBe('string');
+    expect(ops.length).toBe(2);
+    if (ops[0]?.type === 'CREATE_RELATION') {
+        expect(ops[0].relation.type).toBe(SystemIds.TYPES_PROPERTY);
+        expect(ops[0].relation.fromEntity).toBe(id);
+        expect(ops[0].relation.toEntity).toBe(SystemIds.IMAGE_TYPE);
+        expect(ops[0].relation.index).toBe(INITIAL_RELATION_INDEX_VALUE);
+    }
+    if (ops[1]?.type === 'SET_TRIPLE') {
+        expect(ops[1].triple.attribute).toBe(SystemIds.IMAGE_URL_PROPERTY);
+        expect(ops[1].triple.entity).toBe(id);
+        expect(ops[1].triple.value.type).toBe('URL');
+        expect(ops[1].triple.value.value).toBe('https://example.com/image.png');
+    }
+});
+it('should generate ops for an image entity with dimensions', () => {
+    const { id, ops } = make({ cid: 'https://example.com/image.png', dimensions: { width: 200, height: 100 } });
+    expect(typeof id).toBe('string');
+    expect(ops.length).toBe(4);
+    if (ops[0]?.type === 'CREATE_RELATION') {
+        expect(ops[0].relation.type).toBe(SystemIds.TYPES_PROPERTY);
+        expect(ops[0].relation.fromEntity).toBe(id);
+        expect(ops[0].relation.toEntity).toBe(SystemIds.IMAGE_TYPE);
+        expect(ops[0].relation.index).toBe(INITIAL_RELATION_INDEX_VALUE);
+    }
+    if (ops[1]?.type === 'SET_TRIPLE') {
+        expect(ops[1].triple.attribute).toBe(SystemIds.IMAGE_URL_PROPERTY);
+        expect(ops[1].triple.entity).toBe(id);
+        expect(ops[1].triple.value.type).toBe('URL');
+        expect(ops[1].triple.value.value).toBe('https://example.com/image.png');
+    }
+    if (ops[2]?.type === 'SET_TRIPLE') {
+        expect(ops[2].triple.attribute).toBe(SystemIds.IMAGE_HEIGHT_PROPERTY);
+        expect(ops[2].triple.entity).toBe(id);
+        expect(ops[2].triple.value.type).toBe('NUMBER');
+        expect(ops[2].triple.value.value).toBe('100');
+    }
+    if (ops[3]?.type === 'SET_TRIPLE') {
+        expect(ops[3].triple.attribute).toBe(SystemIds.IMAGE_WIDTH_PROPERTY);
+        expect(ops[3].triple.entity).toBe(id);
+        expect(ops[3].triple.value.type).toBe('NUMBER');
+        expect(ops[3].triple.value.value).toBe('200');
+    }
+});
+//# sourceMappingURL=image.test.js.map

package/dist/src/core/image.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"image.test.js","sourceRoot":"","sources":["../../../src/core/image.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,4BAA4B,EAAE,MAAM,gBAAgB,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAElC,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;IACjD,MAAM,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,EAAE,GAAG,EAAE,+BAA+B,EAAE,CAAC,CAAC;IAEnE,8EAA8E;IAC9E,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACjC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC3B,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,KAAK,iBAAiB,EAAE,CAAC;QACvC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;QAC5D,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC5C,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QAC5D,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;IACnE,CAAC;IAED,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,KAAK,YAAY,EAAE,CAAC;QAClC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;QACnE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACtC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC7C,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;IAC1E,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,yDAAyD,EAAE,GAAG,EAAE;IACjE,MAAM,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,EAAE,GAAG,EAAE,+BAA+B,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IAE5G,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACjC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC3B,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,KAAK,iBAAiB,EAAE,CAAC;QACvC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;QAC5D,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC5C,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QAC5D,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;IACnE,CAAC;IACD,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,KAAK,YAAY,EAAE,CAAC;QAClC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;QACnE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACtC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC7C,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;IAC1E,CAAC;IACD,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,KAAK,YAAY,EAAE,CAAC;QAClC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC;QACtE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACtC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAChD,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChD,CAAC;IACD,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,KAAK,YAAY,EAAE,CAAC;QAClC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;QACrE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACtC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAChD,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChD,CAAC;AACH,CAAC,CAAC,CAAC"}

package/dist/src/core/relation.d.ts

@@ -0,0 +1,88 @@
+/**
+ * This module provides utility functions for working with Relations in TypeScript.
+ *
+ * @since 0.0.6
+ */
+import { SystemIds } from '../system-ids.js';
+import type { CreateRelationOp, DeleteRelationOp } from '../types.js';
+/**
+ * Arguments for creating a new Relation.
+ *
+ * @param relationId - optional base58 encoded v4 uuid
+ * @param fromId - base58 encoded v4 uuid
+ * @param toId - base58 encoded v4 uuid
+ * @param relationTypeId - base58 encoded v4 uuid
+ * @param position - optional fractional index using position-strings
+ */
+type CreateRelationParams = {
+    relationId?: string;
+    fromId: string;
+    toId: string;
+    relationTypeId: string;
+    position?: string;
+};
+/**
+ * Generates ops for a new Relation.
+ *
+ * @example
+ * ```ts
+ * const ops = Relation.make({
+ *   fromId: 'from-id',
+ *   toId: 'to-id',
+ *   relationTypeId: 'relation-type-id',
+ *   // optional
+ *   relationId: 'relation-id',
+ *   position: 'position-string',
+ * });
+ * ```
+ *
+ * @param args {@link CreateRelationParams}
+ * @returns – {@link CreateRelationOp}
+ */
+export declare function make(args: CreateRelationParams): CreateRelationOp;
+/**
+ * Generates ops for deleting a Relation.
+ *
+ * @example
+ * ```ts
+ * const op = Relation.remove('relation-id');
+ * ```
+ *
+ * @param relationId – base58 encoded v4 uuid representing the relation's entity id
+ * @returns – {@link DeleteRelationOp}
+ */
+export declare function remove(relationId: string): DeleteRelationOp;
+type ReorderRelationParams = {
+    relationId: string;
+    beforeIndex?: string;
+    afterIndex?: string;
+};
+type ReorderRelationOp = {
+    type: 'SET_TRIPLE';
+    triple: {
+        attribute: typeof SystemIds.RELATION_INDEX;
+        entity: string;
+        value: {
+            type: 'TEXT';
+            value: string;
+        };
+    };
+};
+/**
+ * Generates op for reordering a Relation using position-strings
+ *
+ * @example
+ * ```ts
+ * const op = Relation.reorder({
+ *   relationId: 'relation-id',
+ *   beforeIndex: 'before-position',
+ *   afterIndex: 'after-position',
+ * });
+ * ```
+ *
+ * @param args {@link ReorderRelationParams}
+ * @returns – {@link ReorderRelationOp}
+ */
+export declare function reorder(args: ReorderRelationParams): ReorderRelationOp;
+export {};
+//# sourceMappingURL=relation.d.ts.map

package/dist/src/core/relation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"relation.d.ts","sourceRoot":"","sources":["../../../src/core/relation.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAGtE;;;;;;;;GAQG;AACH,KAAK,oBAAoB,GAAG;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,IAAI,CAAC,IAAI,EAAE,oBAAoB,GAAG,gBAAgB,CAajE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,gBAAgB,CAO3D;AAED,KAAK,qBAAqB,GAAG;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,KAAK,iBAAiB,GAAG;IACvB,IAAI,EAAE,YAAY,CAAC;IACnB,MAAM,EAAE;QACN,SAAS,EAAE,OAAO,SAAS,CAAC,cAAc,CAAC;QAC3C,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE;YACL,IAAI,EAAE,MAAM,CAAC;YACb,KAAK,EAAE,MAAM,CAAC;SACf,CAAC;KACH,CAAC;CACH,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,OAAO,CAAC,IAAI,EAAE,qBAAqB,GAAG,iBAAiB,CActE"}

package/dist/src/core/relation.js

@@ -0,0 +1,89 @@
+/**
+ * This module provides utility functions for working with Relations in TypeScript.
+ *
+ * @since 0.0.6
+ */
+import { INITIAL_RELATION_INDEX_VALUE } from '../../constants.js';
+import { generate } from '../id.js';
+import { SystemIds } from '../system-ids.js';
+import { Position } from './position.js';
+/**
+ * Generates ops for a new Relation.
+ *
+ * @example
+ * ```ts
+ * const ops = Relation.make({
+ *   fromId: 'from-id',
+ *   toId: 'to-id',
+ *   relationTypeId: 'relation-type-id',
+ *   // optional
+ *   relationId: 'relation-id',
+ *   position: 'position-string',
+ * });
+ * ```
+ *
+ * @param args {@link CreateRelationParams}
+ * @returns – {@link CreateRelationOp}
+ */
+export function make(args) {
+    const newEntityId = args.relationId ?? generate();
+    return {
+        type: 'CREATE_RELATION',
+        relation: {
+            id: newEntityId,
+            type: args.relationTypeId,
+            fromEntity: args.fromId,
+            toEntity: args.toId,
+            index: args.position ?? INITIAL_RELATION_INDEX_VALUE,
+        },
+    };
+}
+/**
+ * Generates ops for deleting a Relation.
+ *
+ * @example
+ * ```ts
+ * const op = Relation.remove('relation-id');
+ * ```
+ *
+ * @param relationId – base58 encoded v4 uuid representing the relation's entity id
+ * @returns – {@link DeleteRelationOp}
+ */
+export function remove(relationId) {
+    return {
+        type: 'DELETE_RELATION',
+        relation: {
+            id: relationId,
+        },
+    };
+}
+/**
+ * Generates op for reordering a Relation using position-strings
+ *
+ * @example
+ * ```ts
+ * const op = Relation.reorder({
+ *   relationId: 'relation-id',
+ *   beforeIndex: 'before-position',
+ *   afterIndex: 'after-position',
+ * });
+ * ```
+ *
+ * @param args {@link ReorderRelationParams}
+ * @returns – {@link ReorderRelationOp}
+ */
+export function reorder(args) {
+    const newIndex = Position.createBetween(args.beforeIndex, args.afterIndex);
+    return {
+        type: 'SET_TRIPLE',
+        triple: {
+            attribute: SystemIds.RELATION_INDEX,
+            entity: args.relationId,
+            value: {
+                type: 'TEXT',
+                value: newIndex,
+            },
+        },
+    };
+}
+//# sourceMappingURL=relation.js.map

package/dist/src/core/relation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"relation.js","sourceRoot":"","sources":["../../../src/core/relation.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,4BAA4B,EAAE,MAAM,oBAAoB,CAAC;AAClE,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACpC,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAE7C,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAmBzC;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,IAAI,CAAC,IAA0B;IAC7C,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,IAAI,QAAQ,EAAE,CAAC;IAElD,OAAO;QACL,IAAI,EAAE,iBAAiB;QACvB,QAAQ,EAAE;YACR,EAAE,EAAE,WAAW;YACf,IAAI,EAAE,IAAI,CAAC,cAAc;YACzB,UAAU,EAAE,IAAI,CAAC,MAAM;YACvB,QAAQ,EAAE,IAAI,CAAC,IAAI;YACnB,KAAK,EAAE,IAAI,CAAC,QAAQ,IAAI,4BAA4B;SACrD;KACF,CAAC;AACJ,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,MAAM,CAAC,UAAkB;IACvC,OAAO;QACL,IAAI,EAAE,iBAAiB;QACvB,QAAQ,EAAE;YACR,EAAE,EAAE,UAAU;SACf;KACF,CAAC;AACJ,CAAC;AAoBD;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,OAAO,CAAC,IAA2B;IACjD,MAAM,QAAQ,GAAG,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAE3E,OAAO;QACL,IAAI,EAAE,YAAY;QAClB,MAAM,EAAE;YACN,SAAS,EAAE,SAAS,CAAC,cAAc;YACnC,MAAM,EAAE,IAAI,CAAC,UAAU;YACvB,KAAK,EAAE;gBACL,IAAI,EAAE,MAAM;gBACZ,KAAK,EAAE,QAAQ;aAChB;SACF;KACF,CAAC;AACJ,CAAC"}

package/dist/src/core/relation.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=relation.test.d.ts.map

package/dist/src/core/relation.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"relation.test.d.ts","sourceRoot":"","sources":["../../../src/core/relation.test.ts"],"names":[],"mappings":""}

package/dist/src/core/relation.test.js

@@ -0,0 +1,45 @@
+import { expect, it } from 'vitest';
+import { RELATION_INDEX } from './ids/system.js';
+import { Position, PositionRange } from './position.js';
+import { make, remove, reorder } from './relation.js';
+it('should generate CreateRelationOp for CREATE_RELATION', () => {
+    const op = make({
+        relationId: 'test-relation-id',
+        fromId: 'test-entity-id',
+        relationTypeId: 'test-relation-type-id',
+        toId: 'test-entity-id',
+        position: 'test-position',
+    });
+    expect(op).toEqual({
+        type: 'CREATE_RELATION',
+        relation: {
+            id: 'test-relation-id',
+            type: 'test-relation-type-id',
+            fromEntity: 'test-entity-id',
+            toEntity: 'test-entity-id',
+            index: 'test-position',
+        },
+    });
+});
+it('should generate DeleteRelationOp for DELETE_RELATION', () => {
+    const op = remove('test-relation-id');
+    expect(op).toEqual({
+        type: 'DELETE_RELATION',
+        relation: {
+            id: 'test-relation-id',
+        },
+    });
+});
+it('should generate Op that places the fractional indexer between the two provided values', () => {
+    const op = reorder({
+        relationId: 'test-relation-id',
+        beforeIndex: PositionRange.FIRST,
+        afterIndex: PositionRange.LAST,
+    });
+    expect(op.type).toBe('SET_TRIPLE');
+    expect(op.triple.attribute).toBe(RELATION_INDEX);
+    expect(op.triple.entity).toBe('test-relation-id');
+    expect(op.triple.value.type).toBe('TEXT');
+    // @TODO how do we test that the resulting value is in-between the two indexes?
+});
+//# sourceMappingURL=relation.test.js.map

package/dist/src/core/relation.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"relation.test.js","sourceRoot":"","sources":["../../../src/core/relation.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AACxD,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAEtD,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;IAC9D,MAAM,EAAE,GAAG,IAAI,CAAC;QACd,UAAU,EAAE,kBAAkB;QAC9B,MAAM,EAAE,gBAAgB;QACxB,cAAc,EAAE,uBAAuB;QACvC,IAAI,EAAE,gBAAgB;QACtB,QAAQ,EAAE,eAAe;KAC1B,CAAC,CAAC;IAEH,MAAM,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC;QACjB,IAAI,EAAE,iBAAiB;QACvB,QAAQ,EAAE;YACR,EAAE,EAAE,kBAAkB;YACtB,IAAI,EAAE,uBAAuB;YAC7B,UAAU,EAAE,gBAAgB;YAC5B,QAAQ,EAAE,gBAAgB;YAC1B,KAAK,EAAE,eAAe;SACvB;KACF,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;IAC9D,MAAM,EAAE,GAAG,MAAM,CAAC,kBAAkB,CAAC,CAAC;IAEtC,MAAM,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC;QACjB,IAAI,EAAE,iBAAiB;QACvB,QAAQ,EAAE;YACR,EAAE,EAAE,kBAAkB;SACvB;KACF,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,uFAAuF,EAAE,GAAG,EAAE;IAC/F,MAAM,EAAE,GAAG,OAAO,CAAC;QACjB,UAAU,EAAE,kBAAkB;QAC9B,WAAW,EAAE,aAAa,CAAC,KAAK;QAChC,UAAU,EAAE,aAAa,CAAC,IAAI;KAC/B,CAAC,CAAC;IAEH,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACnC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACjD,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAClD,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC1C,+EAA+E;AACjF,CAAC,CAAC,CAAC"}

package/dist/src/core/triple.d.ts

@@ -0,0 +1,50 @@
+/**
+ * This module provides utility functions for working with Triples in TypeScript.
+ *
+ * @since 0.0.6
+ */
+import type { DeleteTripleOp, SetTripleOp, Value } from '../types.js';
+type CreateTripleParams = {
+    attributeId: string;
+    entityId: string;
+    value: Value;
+};
+/**
+ * Generates op for creating a new Triple.
+ *
+ * @example
+ * ```ts
+ * const op = Triple.make({
+ *   attributeId: 'attribute-id',
+ *   entityId: 'entity-id',
+ *   value: {
+ *     type: 'TEXT',
+ *     value: 'value',
+ *   },
+ * });
+ * ```
+ * @param args – {@link CreateTripleParams}
+ * @returns – {@link SetTripleOp}
+ */
+export declare function make(args: CreateTripleParams): SetTripleOp;
+type DeleteTripleParams = {
+    attributeId: string;
+    entityId: string;
+};
+/**
+ * Generates op for deleting a Triple.
+ *
+ * @example
+ * ```ts
+ * const op = Triple.remove({
+ *   attributeId: 'attribute-id',
+ *   entityId: 'entity-id',
+ * });
+ * ```
+ *
+ * @param args – {@link DeleteTripleParams}
+ * @returns – {@link DeleteTripleOp}
+ */
+export declare function remove(args: DeleteTripleParams): DeleteTripleOp;
+export {};
+//# sourceMappingURL=triple.d.ts.map

package/dist/src/core/triple.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"triple.d.ts","sourceRoot":"","sources":["../../../src/core/triple.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEtE,KAAK,kBAAkB,GAAG;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;CACd,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,IAAI,CAAC,IAAI,EAAE,kBAAkB,GAAG,WAAW,CAS1D;AAED,KAAK,kBAAkB,GAAG;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,kBAAkB,GAAG,cAAc,CAQ/D"}

package/dist/src/core/triple.js

@@ -0,0 +1,56 @@
+/**
+ * This module provides utility functions for working with Triples in TypeScript.
+ *
+ * @since 0.0.6
+ */
+/**
+ * Generates op for creating a new Triple.
+ *
+ * @example
+ * ```ts
+ * const op = Triple.make({
+ *   attributeId: 'attribute-id',
+ *   entityId: 'entity-id',
+ *   value: {
+ *     type: 'TEXT',
+ *     value: 'value',
+ *   },
+ * });
+ * ```
+ * @param args – {@link CreateTripleParams}
+ * @returns – {@link SetTripleOp}
+ */
+export function make(args) {
+    return {
+        type: 'SET_TRIPLE',
+        triple: {
+            attribute: args.attributeId,
+            entity: args.entityId,
+            value: args.value,
+        },
+    };
+}
+/**
+ * Generates op for deleting a Triple.
+ *
+ * @example
+ * ```ts
+ * const op = Triple.remove({
+ *   attributeId: 'attribute-id',
+ *   entityId: 'entity-id',
+ * });
+ * ```
+ *
+ * @param args – {@link DeleteTripleParams}
+ * @returns – {@link DeleteTripleOp}
+ */
+export function remove(args) {
+    return {
+        type: 'DELETE_TRIPLE',
+        triple: {
+            attribute: args.attributeId,
+            entity: args.entityId,
+        },
+    };
+}
+//# sourceMappingURL=triple.js.map

package/dist/src/core/triple.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"triple.js","sourceRoot":"","sources":["../../../src/core/triple.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAUH;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,IAAI,CAAC,IAAwB;IAC3C,OAAO;QACL,IAAI,EAAE,YAAY;QAClB,MAAM,EAAE;YACN,SAAS,EAAE,IAAI,CAAC,WAAW;YAC3B,MAAM,EAAE,IAAI,CAAC,QAAQ;YACrB,KAAK,EAAE,IAAI,CAAC,KAAK;SAClB;KACF,CAAC;AACJ,CAAC;AAOD;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,MAAM,CAAC,IAAwB;IAC7C,OAAO;QACL,IAAI,EAAE,eAAe;QACrB,MAAM,EAAE;YACN,SAAS,EAAE,IAAI,CAAC,WAAW;YAC3B,MAAM,EAAE,IAAI,CAAC,QAAQ;SACtB;KACF,CAAC;AACJ,CAAC"}

package/dist/src/core/triple.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=triple.test.d.ts.map

package/dist/src/core/triple.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"triple.test.d.ts","sourceRoot":"","sources":["../../../src/core/triple.test.ts"],"names":[],"mappings":""}

package/dist/src/core/triple.test.js

@@ -0,0 +1,37 @@
+import { expect, it } from 'vitest';
+import { make, remove } from './triple.js';
+it('should generate SetTripleOp for SET_TRIPLE', () => {
+    const op = make({
+        attributeId: 'test-attribute-id',
+        entityId: 'test-entity-id',
+        value: {
+            type: 'TEXT',
+            value: 'test value',
+        },
+    });
+    expect(op).toEqual({
+        type: 'SET_TRIPLE',
+        triple: {
+            attribute: 'test-attribute-id',
+            entity: 'test-entity-id',
+            value: {
+                type: 'TEXT',
+                value: 'test value',
+            },
+        },
+    });
+});
+it('should generate DeleteTripleOp for DELETE_TRIPLE', () => {
+    const op = remove({
+        attributeId: 'test-attribute-id',
+        entityId: 'test-entity-id',
+    });
+    expect(op).toEqual({
+        type: 'DELETE_TRIPLE',
+        triple: {
+            attribute: 'test-attribute-id',
+            entity: 'test-entity-id',
+        },
+    });
+});
+//# sourceMappingURL=triple.test.js.map

package/dist/src/core/triple.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"triple.test.js","sourceRoot":"","sources":["../../../src/core/triple.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAE3C,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;IACpD,MAAM,EAAE,GAAG,IAAI,CAAC;QACd,WAAW,EAAE,mBAAmB;QAChC,QAAQ,EAAE,gBAAgB;QAC1B,KAAK,EAAE;YACL,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,YAAY;SACpB;KACF,CAAC,CAAC;IAEH,MAAM,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC;QACjB,IAAI,EAAE,YAAY;QAClB,MAAM,EAAE;YACN,SAAS,EAAE,mBAAmB;YAC9B,MAAM,EAAE,gBAAgB;YACxB,KAAK,EAAE;gBACL,IAAI,EAAE,MAAM;gBACZ,KAAK,EAAE,YAAY;aACpB;SACF;KACF,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;IAC1D,MAAM,EAAE,GAAG,MAAM,CAAC;QAChB,WAAW,EAAE,mBAAmB;QAChC,QAAQ,EAAE,gBAAgB;KAC3B,CAAC,CAAC;IAEH,MAAM,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC;QACjB,IAAI,EAAE,eAAe;QACrB,MAAM,EAAE;YACN,SAAS,EAAE,mBAAmB;YAC9B,MAAM,EAAE,gBAAgB;SACzB;KACF,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/src/encodings/get-register-space-calldata.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Get the calldata for registering a space ID.
+ *
+ * This function encodes the `registerSpaceId` function call for the Space Registry contract.
+ * It is called by a space contract to register itself with the Space Registry.
+ * The space ID is deterministically derived from the caller's address and nonce.
+ *
+ * @returns Encoded calldata for the transaction
+ *
+ * @example
+ * ```ts
+ * import { getRegisterSpaceCalldata, TESTNET } from '@graphprotocol/grc-20';
+ * import { createWalletClient, http } from 'viem';
+ *
+ * const calldata = getRegisterSpaceCalldata();
+ *
+ * // Using viem
+ * const hash = await walletClient.sendTransaction({
+ *   to: TESTNET.SPACE_REGISTRY_ADDRESS,
+ *   data: calldata,
+ * });
+ *
+ * // Using wagmi
+ * const { sendTransaction } = useSendTransaction();
+ * sendTransaction({
+ *   to: TESTNET.SPACE_REGISTRY_ADDRESS,
+ *   data: calldata,
+ * });
+ * ```
+ */
+export declare function getRegisterSpaceCalldata(): `0x${string}`;
+//# sourceMappingURL=get-register-space-calldata.d.ts.map

package/dist/src/encodings/get-register-space-calldata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-register-space-calldata.d.ts","sourceRoot":"","sources":["../../../src/encodings/get-register-space-calldata.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,wBAAwB,IAAI,KAAK,MAAM,EAAE,CAKxD"}

package/dist/src/encodings/get-register-space-calldata.js

@@ -0,0 +1,39 @@
+import { encodeFunctionData } from 'viem';
+import { SpaceRegistryAbi } from '../abis/index.js';
+/**
+ * Get the calldata for registering a space ID.
+ *
+ * This function encodes the `registerSpaceId` function call for the Space Registry contract.
+ * It is called by a space contract to register itself with the Space Registry.
+ * The space ID is deterministically derived from the caller's address and nonce.
+ *
+ * @returns Encoded calldata for the transaction
+ *
+ * @example
+ * ```ts
+ * import { getRegisterSpaceCalldata, TESTNET } from '@graphprotocol/grc-20';
+ * import { createWalletClient, http } from 'viem';
+ *
+ * const calldata = getRegisterSpaceCalldata();
+ *
+ * // Using viem
+ * const hash = await walletClient.sendTransaction({
+ *   to: TESTNET.SPACE_REGISTRY_ADDRESS,
+ *   data: calldata,
+ * });
+ *
+ * // Using wagmi
+ * const { sendTransaction } = useSendTransaction();
+ * sendTransaction({
+ *   to: TESTNET.SPACE_REGISTRY_ADDRESS,
+ *   data: calldata,
+ * });
+ * ```
+ */
+export function getRegisterSpaceCalldata() {
+    return encodeFunctionData({
+        abi: SpaceRegistryAbi,
+        functionName: 'registerSpaceId',
+    });
+}
+//# sourceMappingURL=get-register-space-calldata.js.map

package/dist/src/encodings/get-register-space-calldata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-register-space-calldata.js","sourceRoot":"","sources":["../../../src/encodings/get-register-space-calldata.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,MAAM,CAAC;AAE1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,UAAU,wBAAwB;IACtC,OAAO,kBAAkB,CAAC;QACxB,GAAG,EAAE,gBAAgB;QACrB,YAAY,EAAE,iBAAiB;KAChC,CAAC,CAAC;AACL,CAAC"}

package/dist/src/encodings/get-register-space-calldata.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=get-register-space-calldata.test.d.ts.map

package/dist/src/encodings/get-register-space-calldata.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-register-space-calldata.test.d.ts","sourceRoot":"","sources":["../../../src/encodings/get-register-space-calldata.test.ts"],"names":[],"mappings":""}