@graphprotocol/grc-20 0.6.4 → 0.8.0

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

@@ -1 +1 @@
-{"version":3,"file":"image.d.ts","sourceRoot":"","sources":["../../../src/core/image.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH,OAAO,KAAK,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAEjE,KAAK,mBAAmB,GAAG;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,CAAC,gBAAgB,EAAE,WAAW,CAAC,CAAC;CACtC,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,wBAAgB,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,mBAAmB,CAwBrD"}
+{"version":3,"file":"image.d.ts","sourceRoot":"","sources":["../../../src/core/image.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,KAAK,EAAE,EAAY,MAAM,UAAU,CAAC;AAG7C,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,aAAa,CAAC;AAEtC,KAAK,mBAAmB,GAAG;IACzB,EAAE,EAAE,EAAE,CAAC;IACP,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;CAChB,CAAC;AAEF,KAAK,eAAe,GAAG;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,CAAC,EAAE;QACX,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,wBAAgB,IAAI,CAAC,EAAE,GAAG,EAAE,UAAU,EAAE,EAAE,eAAe,GAAG,mBAAmB,CAkD9E"}

package/dist/src/core/image.js

@@ -12,36 +12,61 @@ import { SystemIds } from '../system-ids.js';
  *
  * @example
  * ```ts
- * const { imageId, ops } = Image.make('https://example.com/image.png');
- * console.log(imageId); // 'gw9uTVTnJdhtczyuzBkL3X'
+ * const { id, ops } = Image.make({ cid: 'https://example.com/image.png', dimensions: { width: 100, height: 100 } });
+ * console.log(id); // 'gw9uTVTnJdhtczyuzBkL3X'
  * console.log(ops); // [...]
  * ```
  *
- * @returns imageId – base58 encoded v4 uuid representing the image entity: {@link MakeImageReturnType}
+ * @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(src) {
+export function make({ cid, dimensions }) {
     const entityId = generate();
-    return {
-        imageId: entityId,
-        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: src,
-                    },
+    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

@@ -1 +1 @@
-{"version":3,"file":"image.js","sourceRoot":"","sources":["../../../src/core/image.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAQ7C;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,IAAI,CAAC,GAAW;IAC9B,MAAM,QAAQ,GAAG,QAAQ,EAAE,CAAC;IAE5B,OAAO;QACL,OAAO,EAAE,QAAQ;QACjB,GAAG,EAAE;YACH,QAAQ,CAAC,IAAI,CAAC;gBACZ,MAAM,EAAE,QAAQ;gBAChB,IAAI,EAAE,SAAS,CAAC,UAAU;gBAC1B,cAAc,EAAE,SAAS,CAAC,cAAc;aACzC,CAAC;YACF;gBACE,IAAI,EAAE,YAAY;gBAClB,MAAM,EAAE;oBACN,MAAM,EAAE,QAAQ;oBAChB,SAAS,EAAE,SAAS,CAAC,kBAAkB;oBACvC,KAAK,EAAE;wBACL,IAAI,EAAE,KAAK;wBACX,KAAK,EAAE,GAAG;qBACX;iBACF;aACF;SACF;KACF,CAAC;AACJ,CAAC"}
+{"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;AAgB7C;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,IAAI,CAAC,EAAE,GAAG,EAAE,UAAU,EAAmB;IACvD,MAAM,QAAQ,GAAG,QAAQ,EAAE,CAAC;IAC5B,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.js

@@ -3,24 +3,50 @@ 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 { imageId, ops } = make('https://example.com/image.png');
-    const [createRelationOp, setTripleOp] = ops;
+    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(createRelationOp.type).toEqual('CREATE_RELATION');
-    expect(createRelationOp.relation.type).toBe(SystemIds.TYPES_PROPERTY);
-    expect(createRelationOp.relation.fromEntity).toBe(imageId);
-    expect(createRelationOp.relation.toEntity).toBe(SystemIds.IMAGE_TYPE);
-    expect(createRelationOp.relation.index).toBe(INITIAL_RELATION_INDEX_VALUE);
-    expect(setTripleOp).toEqual({
-        type: 'SET_TRIPLE',
-        triple: {
-            attribute: SystemIds.IMAGE_URL_PROPERTY,
-            entity: imageId,
-            value: {
-                type: 'URL',
-                value: 'https://example.com/image.png',
-            },
-        },
-    });
+    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

@@ -1 +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,OAAO,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,+BAA+B,CAAC,CAAC;IAC/D,MAAM,CAAC,gBAAgB,EAAE,WAAW,CAAC,GAAG,GAAG,CAAC;IAE5C,8EAA8E;IAC9E,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACzD,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;IACtE,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC3D,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IACtE,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;IAE3E,MAAM,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC;QAC1B,IAAI,EAAE,YAAY;QAClB,MAAM,EAAE;YACN,SAAS,EAAE,SAAS,CAAC,kBAAkB;YACvC,MAAM,EAAE,OAAO;YACf,KAAK,EAAE;gBACL,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE,+BAA+B;aACvC;SACF;KACF,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
+{"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

@@ -14,7 +14,7 @@ import type { CreateRelationOp, DeleteRelationOp } from '../types.js';
  * @param relationTypeId - base58 encoded v4 uuid
  * @param position - optional fractional index using position-strings
  */
-type CreateRelationArgs = {
+type CreateRelationParams = {
     relationId?: string;
     fromId: string;
     toId: string;
@@ -36,10 +36,10 @@ type CreateRelationArgs = {
  * });
  * ```
  *
- * @param args {@link CreateRelationArgs}
+ * @param args {@link CreateRelationParams}
  * @returns – {@link CreateRelationOp}
  */
-export declare function make(args: CreateRelationArgs): CreateRelationOp;
+export declare function make(args: CreateRelationParams): CreateRelationOp;
 /**
  * Generates ops for deleting a Relation.
  *
@@ -52,7 +52,7 @@ export declare function make(args: CreateRelationArgs): CreateRelationOp;
  * @returns – {@link DeleteRelationOp}
  */
 export declare function remove(relationId: string): DeleteRelationOp;
-type ReorderRelationArgs = {
+type ReorderRelationParams = {
     relationId: string;
     beforeIndex?: string;
     afterIndex?: string;
@@ -80,9 +80,9 @@ type ReorderRelationOp = {
  * });
  * ```
  *
- * @param args {@link ReorderRelationArgs}
+ * @param args {@link ReorderRelationParams}
  * @returns – {@link ReorderRelationOp}
  */
-export declare function reorder(args: ReorderRelationArgs): ReorderRelationOp;
+export declare function reorder(args: ReorderRelationParams): ReorderRelationOp;
 export {};
 //# sourceMappingURL=relation.d.ts.map

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

@@ -1 +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,kBAAkB,GAAG;IACxB,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,kBAAkB,GAAG,gBAAgB,CAa/D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,gBAAgB,CAO3D;AAED,KAAK,mBAAmB,GAAG;IACzB,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,mBAAmB,GAAG,iBAAiB,CAcpE"}
+{"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

@@ -22,7 +22,7 @@ import { Position } from './position.js';
  * });
  * ```
  *
- * @param args {@link CreateRelationArgs}
+ * @param args {@link CreateRelationParams}
  * @returns – {@link CreateRelationOp}
  */
 export function make(args) {
@@ -69,7 +69,7 @@ export function remove(relationId) {
  * });
  * ```
  *
- * @param args {@link ReorderRelationArgs}
+ * @param args {@link ReorderRelationParams}
  * @returns – {@link ReorderRelationOp}
  */
 export function reorder(args) {

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

@@ -1 +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,IAAwB;IAC3C,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,IAAyB;IAC/C,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"}
+{"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/triple.d.ts

@@ -4,7 +4,7 @@
  * @since 0.0.6
  */
 import type { DeleteTripleOp, SetTripleOp, Value } from '../types.js';
-type CreateTripleArgs = {
+type CreateTripleParams = {
     attributeId: string;
     entityId: string;
     value: Value;
@@ -23,11 +23,11 @@ type CreateTripleArgs = {
  *   },
  * });
  * ```
- * @param args – {@link CreateTripleArgs}
+ * @param args – {@link CreateTripleParams}
  * @returns – {@link SetTripleOp}
  */
-export declare function make(args: CreateTripleArgs): SetTripleOp;
-type DeleteTripleArgs = {
+export declare function make(args: CreateTripleParams): SetTripleOp;
+type DeleteTripleParams = {
     attributeId: string;
     entityId: string;
 };
@@ -42,9 +42,9 @@ type DeleteTripleArgs = {
  * });
  * ```
  *
- * @param args – {@link DeleteTripleArgs}
+ * @param args – {@link DeleteTripleParams}
  * @returns – {@link DeleteTripleOp}
  */
-export declare function remove(args: DeleteTripleArgs): DeleteTripleOp;
+export declare function remove(args: DeleteTripleParams): DeleteTripleOp;
 export {};
 //# sourceMappingURL=triple.d.ts.map

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

@@ -1 +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,gBAAgB,GAAG;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;CACd,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,IAAI,CAAC,IAAI,EAAE,gBAAgB,GAAG,WAAW,CASxD;AAED,KAAK,gBAAgB,GAAG;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,gBAAgB,GAAG,cAAc,CAQ7D"}
+{"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

@@ -17,7 +17,7 @@
  *   },
  * });
  * ```
- * @param args – {@link CreateTripleArgs}
+ * @param args – {@link CreateTripleParams}
  * @returns – {@link SetTripleOp}
  */
 export function make(args) {
@@ -41,7 +41,7 @@ export function make(args) {
  * });
  * ```
  *
- * @param args – {@link DeleteTripleArgs}
+ * @param args – {@link DeleteTripleParams}
  * @returns – {@link DeleteTripleOp}
  */
 export function remove(args) {

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

@@ -1 +1 @@
-{"version":3,"file":"triple.js","sourceRoot":"","sources":["../../../src/core/triple.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAUH;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,IAAI,CAAC,IAAsB;IACzC,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,IAAsB;IAC3C,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"}
+{"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/encodings/get-calldata-for-space-governance-type.d.ts

@@ -1,8 +1,8 @@
-type GovernanceTypeCalldataArgs = {
+type GovernanceTypeCalldataParams = {
     type: 'PUBLIC' | 'PERSONAL';
     cid: string;
     spacePluginAddress: string;
 };
-export declare function getCalldataForSpaceGovernanceType(args: GovernanceTypeCalldataArgs): `0x${string}`;
+export declare function getCalldataForSpaceGovernanceType(args: GovernanceTypeCalldataParams): `0x${string}`;
 export {};
 //# sourceMappingURL=get-calldata-for-space-governance-type.d.ts.map

package/dist/src/encodings/get-calldata-for-space-governance-type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-calldata-for-space-governance-type.d.ts","sourceRoot":"","sources":["../../../src/encodings/get-calldata-for-space-governance-type.ts"],"names":[],"mappings":"AAIA,KAAK,0BAA0B,GAAG;IAChC,IAAI,EAAE,QAAQ,GAAG,UAAU,CAAC;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,kBAAkB,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,wBAAgB,iCAAiC,CAAC,IAAI,EAAE,0BAA0B,iBAejF"}
+{"version":3,"file":"get-calldata-for-space-governance-type.d.ts","sourceRoot":"","sources":["../../../src/encodings/get-calldata-for-space-governance-type.ts"],"names":[],"mappings":"AAIA,KAAK,4BAA4B,GAAG;IAClC,IAAI,EAAE,QAAQ,GAAG,UAAU,CAAC;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,kBAAkB,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,wBAAgB,iCAAiC,CAAC,IAAI,EAAE,4BAA4B,iBAenF"}

package/dist/src/encodings/get-calldata-for-space-governance-type.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-calldata-for-space-governance-type.js","sourceRoot":"","sources":["../../../src/encodings/get-calldata-for-space-governance-type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,MAAM,CAAC;AAEvD,OAAO,EAAE,aAAa,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAQxE,MAAM,UAAU,iCAAiC,CAAC,IAAgC;IAChF,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,QAAQ;YACX,OAAO,kBAAkB,CAAC;gBACxB,YAAY,EAAE,cAAc;gBAC5B,GAAG,EAAE,aAAa;gBAClB,IAAI,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,kBAAmC,CAAC;aAClF,CAAC,CAAC;QACL,KAAK,UAAU;YACb,OAAO,kBAAkB,CAAC;gBACxB,YAAY,EAAE,aAAa;gBAC3B,GAAG,EAAE,qBAAqB;gBAC1B,IAAI,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,kBAAmC,CAAC;aAC3D,CAAC,CAAC;IACP,CAAC;AACH,CAAC"}
+{"version":3,"file":"get-calldata-for-space-governance-type.js","sourceRoot":"","sources":["../../../src/encodings/get-calldata-for-space-governance-type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,MAAM,CAAC;AAEvD,OAAO,EAAE,aAAa,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAQxE,MAAM,UAAU,iCAAiC,CAAC,IAAkC;IAClF,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,QAAQ;YACX,OAAO,kBAAkB,CAAC;gBACxB,YAAY,EAAE,cAAc;gBAC5B,GAAG,EAAE,aAAa;gBAClB,IAAI,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,kBAAmC,CAAC;aAClF,CAAC,CAAC;QACL,KAAK,UAAU;YACb,OAAO,kBAAkB,CAAC;gBACxB,YAAY,EAAE,aAAa;gBAC3B,GAAG,EAAE,qBAAqB;gBAC1B,IAAI,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,kBAAmC,CAAC;aAC3D,CAAC,CAAC;IACP,CAAC;AACH,CAAC"}

package/dist/src/graph/create-entity.d.ts

@@ -1,14 +1,48 @@
-import type { DefaultProperties, Op, PropertiesParam } from '../types.js';
-type Params = DefaultProperties & {
+import type { CreateResult, DefaultProperties, PropertiesParam } from '../types.js';
+type CreateEntityParams = DefaultProperties & {
     properties?: PropertiesParam;
     types?: Array<string>;
 };
 /**
  * Creates an entity with the given name, description, cover, properties, and types.
+ * All IDs passed to this function (cover, types, property IDs, relation IDs, etc.) are validated.
+ * If any invalid ID is provided, the function will throw an error.
+ *
+ * @example
+ * ```ts
+ * const { id, ops } = createEntity({
+ *   name: 'name of the entity',
+ *   description: 'description of the entity',
+ *   cover: imageEntityId,
+ *   types: [typeEntityId1, typeEntityId2],
+ *   properties: {
+ *     // value property like text, number, url, time, point, checkbox
+ *     [propertyId]: {
+ *       type: 'TEXT', // TEXT | NUMBER | URL | TIME | POINT | CHECKBOX,
+ *       value: 'value of the property',
+ *     },
+ *     // relation property
+ *     [propertyId]: {
+ *       to: 'id of the entity',
+ *       relationId: 'id of the relation', // optional
+ *       position: positionString, // optional
+ *       properties: { // optional properties for the relation
+ *         [propertyId]: {
+ *           type: 'TEXT', // TEXT | NUMBER | URL | TIME | POINT | CHECKBOX,
+ *           value: 'value of the property',
+ *         },
+ *         [propertyId]: {
+ *           to: 'id of the entity',
+ *         },
+ *       },
+ *     },
+ *   },
+ * });
+ * ```
+ * @param params – {@link CreateEntityParams}
+ * @returns – {@link CreateResult}
+ * @throws Will throw an error if any provided ID is invalid
  */
-export declare const createEntity: ({ name, description, cover, properties, types }: Params) => {
-    id: string;
-    ops: Op[];
-};
+export declare const createEntity: ({ name, description, cover, properties, types }: CreateEntityParams) => CreateResult;
 export {};
 //# sourceMappingURL=create-entity.d.ts.map

package/dist/src/graph/create-entity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create-entity.d.ts","sourceRoot":"","sources":["../../../src/graph/create-entity.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,iBAAiB,EAAE,EAAE,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAG1E,KAAK,MAAM,GAAG,iBAAiB,GAAG;IAChC,UAAU,CAAC,EAAE,eAAe,CAAC;IAC7B,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,YAAY,oDAAqD,MAAM;;;CAuBnF,CAAC"}
+{"version":3,"file":"create-entity.d.ts","sourceRoot":"","sources":["../../../src/graph/create-entity.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,iBAAiB,EAAM,eAAe,EAAE,MAAM,aAAa,CAAC;AAGxF,KAAK,kBAAkB,GAAG,iBAAiB,GAAG;IAC5C,UAAU,CAAC,EAAE,eAAe,CAAC;IAC7B,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACvB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,eAAO,MAAM,YAAY,oDAAqD,kBAAkB,KAAG,YAwBlG,CAAC"}

package/dist/src/graph/create-entity.js

@@ -1,10 +1,47 @@
 import { TYPES_PROPERTY } from '../core/ids/system.js';
-import { generate } from '../id.js';
+import { assertValid, generate } from '../id.js';
 import { Relation } from '../relation.js';
 import { createDefaultProperties } from './helpers/create-default-properties.js';
 import { createProperties } from './helpers/create-properties.js';
 /**
  * Creates an entity with the given name, description, cover, properties, and types.
+ * All IDs passed to this function (cover, types, property IDs, relation IDs, etc.) are validated.
+ * If any invalid ID is provided, the function will throw an error.
+ *
+ * @example
+ * ```ts
+ * const { id, ops } = createEntity({
+ *   name: 'name of the entity',
+ *   description: 'description of the entity',
+ *   cover: imageEntityId,
+ *   types: [typeEntityId1, typeEntityId2],
+ *   properties: {
+ *     // value property like text, number, url, time, point, checkbox
+ *     [propertyId]: {
+ *       type: 'TEXT', // TEXT | NUMBER | URL | TIME | POINT | CHECKBOX,
+ *       value: 'value of the property',
+ *     },
+ *     // relation property
+ *     [propertyId]: {
+ *       to: 'id of the entity',
+ *       relationId: 'id of the relation', // optional
+ *       position: positionString, // optional
+ *       properties: { // optional properties for the relation
+ *         [propertyId]: {
+ *           type: 'TEXT', // TEXT | NUMBER | URL | TIME | POINT | CHECKBOX,
+ *           value: 'value of the property',
+ *         },
+ *         [propertyId]: {
+ *           to: 'id of the entity',
+ *         },
+ *       },
+ *     },
+ *   },
+ * });
+ * ```
+ * @param params – {@link CreateEntityParams}
+ * @returns – {@link CreateResult}
+ * @throws Will throw an error if any provided ID is invalid
  */
 export const createEntity = ({ name, description, cover, properties, types }) => {
     const id = generate();
@@ -13,6 +50,7 @@ export const createEntity = ({ name, description, cover, properties, types }) =>
     // add property "Types" to the provided types
     if (types) {
         for (const typeId of types) {
+            assertValid(typeId);
             const typeRelationOp = Relation.make({
                 fromId: id,
                 relationTypeId: TYPES_PROPERTY,

package/dist/src/graph/create-entity.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-entity.js","sourceRoot":"","sources":["../../../src/graph/create-entity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,OAAO,EAAE,uBAAuB,EAAE,MAAM,wCAAwC,CAAC;AACjF,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAMlE;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAU,EAAE,EAAE;IACtF,MAAM,EAAE,GAAG,QAAQ,EAAE,CAAC;IACtB,MAAM,GAAG,GAAc,EAAE,CAAC;IAE1B,GAAG,CAAC,IAAI,CAAC,GAAG,uBAAuB,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IAEjF,6CAA6C;IAC7C,IAAI,KAAK,EAAE,CAAC;QACV,KAAK,MAAM,MAAM,IAAI,KAAK,EAAE,CAAC;YAC3B,MAAM,cAAc,GAAG,QAAQ,CAAC,IAAI,CAAC;gBACnC,MAAM,EAAE,EAAE;gBACV,cAAc,EAAE,cAAc;gBAC9B,IAAI,EAAE,MAAM;aACb,CAAC,CAAC;YACH,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;IAED,IAAI,UAAU,EAAE,CAAC;QACf,GAAG,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;IAC9D,CAAC;IAED,OAAO,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC;AACrB,CAAC,CAAC"}
+{"version":3,"file":"create-entity.js","sourceRoot":"","sources":["../../../src/graph/create-entity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,OAAO,EAAE,uBAAuB,EAAE,MAAM,wCAAwC,CAAC;AACjF,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAMlE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAsB,EAAgB,EAAE;IAChH,MAAM,EAAE,GAAG,QAAQ,EAAE,CAAC;IACtB,MAAM,GAAG,GAAc,EAAE,CAAC;IAE1B,GAAG,CAAC,IAAI,CAAC,GAAG,uBAAuB,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IAEjF,6CAA6C;IAC7C,IAAI,KAAK,EAAE,CAAC;QACV,KAAK,MAAM,MAAM,IAAI,KAAK,EAAE,CAAC;YAC3B,WAAW,CAAC,MAAM,CAAC,CAAC;YACpB,MAAM,cAAc,GAAG,QAAQ,CAAC,IAAI,CAAC;gBACnC,MAAM,EAAE,EAAE;gBACV,cAAc,EAAE,cAAc;gBAC9B,IAAI,EAAE,MAAM;aACb,CAAC,CAAC;YACH,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;IAED,IAAI,UAAU,EAAE,CAAC;QACf,GAAG,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;IAC9D,CAAC;IAED,OAAO,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC;AACrB,CAAC,CAAC"}

package/dist/src/graph/create-entity.test.js

@@ -1,9 +1,13 @@
 import { describe, expect, it } from 'vitest';
 import { AUTHORS_PROPERTY, CLAIM_TYPE, DISCLAIMER_PROPERTY, NEWS_STORY_TYPE, ROLES_PROPERTY, WEB_URL_PROPERTY, } from '../core/ids/content.js';
 import { NAME_PROPERTY, TYPES_PROPERTY } from '../core/ids/system.js';
-import { generate } from '../id.js';
+import { Id, generate } from '../id.js';
 import { createEntity } from './create-entity.js';
 describe('createEntity', () => {
+    const someAuthorId = Id('M5uDP7nCw3nvfQPUryn9gx');
+    const someRoleId = Id('GscJ2GELQjmLoaVrYyR3xm');
+    const someRoleId2 = Id('VdTsW1mGiy1XSooJaBBLc4');
+    const coverId = Id('6wMJ7P1AHpu8EWFX3roMye');
     it('creates a basic entity without properties', async () => {
         const entity = createEntity({});
         expect(entity).toBeDefined();
@@ -93,8 +97,8 @@ describe('createEntity', () => {
     it('creates an entity with relations', async () => {
         const entity = createEntity({
             properties: {
-                [AUTHORS_PROPERTY]: { to: 'some-author-id' },
-                [ROLES_PROPERTY]: [{ to: 'some-role-id' }, { to: 'some-role-id-2' }],
+                [AUTHORS_PROPERTY]: { to: someAuthorId },
+                [ROLES_PROPERTY]: [{ to: someRoleId }, { to: someRoleId2 }],
             },
         });
         expect(entity).toBeDefined();
@@ -108,7 +112,7 @@ describe('createEntity', () => {
                     fromEntity: entity.id,
                     id: entity.ops[0]?.relation?.id,
                     index: entity.ops[0]?.relation?.index,
-                    toEntity: 'some-author-id',
+                    toEntity: someAuthorId,
                     type: AUTHORS_PROPERTY,
                 },
                 type: 'CREATE_RELATION',
@@ -121,7 +125,7 @@ describe('createEntity', () => {
                     fromEntity: entity.id,
                     id: entity.ops[1]?.relation?.id,
                     index: entity.ops[1]?.relation?.index,
-                    toEntity: 'some-role-id',
+                    toEntity: someRoleId,
                     type: ROLES_PROPERTY,
                 },
                 type: 'CREATE_RELATION',
@@ -134,7 +138,7 @@ describe('createEntity', () => {
                     fromEntity: entity.id,
                     id: entity.ops[2]?.relation?.id,
                     index: entity.ops[2]?.relation?.index,
-                    toEntity: 'some-role-id-2',
+                    toEntity: someRoleId2,
                     type: ROLES_PROPERTY,
                 },
                 type: 'CREATE_RELATION',
@@ -146,8 +150,8 @@ describe('createEntity', () => {
         const firstRoleRelationId = generate();
         const entity = createEntity({
             properties: {
-                [AUTHORS_PROPERTY]: { to: 'some-author-id', relationId: authorRelationId },
-                [ROLES_PROPERTY]: [{ to: 'some-role-id', relationId: firstRoleRelationId }, { to: 'some-role-id-2' }],
+                [AUTHORS_PROPERTY]: { to: someAuthorId, relationId: authorRelationId },
+                [ROLES_PROPERTY]: [{ to: someRoleId, relationId: firstRoleRelationId }, { to: someRoleId2 }],
             },
         });
         expect(entity.ops[0]?.type).toBe('CREATE_RELATION');
@@ -157,7 +161,7 @@ describe('createEntity', () => {
                     fromEntity: entity.id,
                     id: authorRelationId,
                     index: entity.ops[0]?.relation?.index,
-                    toEntity: 'some-author-id',
+                    toEntity: someAuthorId,
                     type: AUTHORS_PROPERTY,
                 },
                 type: 'CREATE_RELATION',
@@ -170,7 +174,7 @@ describe('createEntity', () => {
                     fromEntity: entity.id,
                     id: firstRoleRelationId,
                     index: entity.ops[1]?.relation?.index,
-                    toEntity: 'some-role-id',
+                    toEntity: someRoleId,
                     type: ROLES_PROPERTY,
                 },
                 type: 'CREATE_RELATION',
@@ -184,15 +188,15 @@ describe('createEntity', () => {
         const entity = createEntity({
             properties: {
                 [AUTHORS_PROPERTY]: {
-                    to: 'some-author-id',
+                    to: someAuthorId,
                     relationId: authorRelationId,
                     properties: {
                         [ROLES_PROPERTY]: {
-                            to: 'some-role-id',
+                            to: someRoleId,
                             relationId: roleRelationId,
                             properties: {
                                 [NEWS_STORY_TYPE]: {
-                                    to: 'some-role-id-2',
+                                    to: someRoleId2,
                                     relationId: newsStoryRelationId,
                                 },
                                 [WEB_URL_PROPERTY]: {
@@ -212,7 +216,7 @@ describe('createEntity', () => {
                     fromEntity: entity.id,
                     id: authorRelationId,
                     index: entity.ops[0]?.relation?.index,
-                    toEntity: 'some-author-id',
+                    toEntity: someAuthorId,
                     type: AUTHORS_PROPERTY,
                 },
                 type: 'CREATE_RELATION',
@@ -225,7 +229,7 @@ describe('createEntity', () => {
                     fromEntity: entity.id,
                     id: roleRelationId,
                     index: entity.ops[1]?.relation?.index,
-                    toEntity: 'some-role-id',
+                    toEntity: someRoleId,
                     type: ROLES_PROPERTY,
                 },
                 type: 'CREATE_RELATION',
@@ -238,7 +242,7 @@ describe('createEntity', () => {
                     fromEntity: entity.id,
                     id: newsStoryRelationId,
                     index: entity.ops[2]?.relation?.index,
-                    toEntity: 'some-role-id-2',
+                    toEntity: someRoleId2,
                     type: NEWS_STORY_TYPE,
                 },
                 type: 'CREATE_RELATION',
@@ -260,13 +264,13 @@ describe('createEntity', () => {
         const entity = createEntity({
             name: 'Yummy Coffee',
             description: 'A delicious coffee shop with great food and great coffee',
-            cover: 'image-id',
+            cover: coverId,
             types: [CLAIM_TYPE, NEWS_STORY_TYPE],
             properties: {
                 [DISCLAIMER_PROPERTY]: { value: 'Test Entity', type: 'TEXT' },
                 [WEB_URL_PROPERTY]: { value: 'https://example.com', type: 'URL' },
-                [AUTHORS_PROPERTY]: { to: 'some-author-id' },
-                [ROLES_PROPERTY]: { to: 'some-role-id' },
+                [AUTHORS_PROPERTY]: { to: someAuthorId },
+                [ROLES_PROPERTY]: { to: someRoleId },
             },
         });
         expect(entity).toBeDefined();