@graphprotocol/grc-20 0.0.7 → 0.0.8

package/dist/src/core/blocks/data.d.ts

@@ -1,3 +1,9 @@
+/**
+ * This module provides utility functions for working with data blocks
+ * in TypeScript.
+ *
+ * @since 0.0.6
+ */
 import type { CreateRelationOp, SetTripleOp } from '../../types.js';
 type DataBlockSourceType = 'QUERY' | 'COLLECTION' | 'GEO';
 type DataBlockArgs = {
@@ -6,6 +12,23 @@ type DataBlockArgs = {
     position?: string;
     name?: string;
 };
+/**
+ * Returns the ops to create an entity representing a Data Block.
+ *
+ * @example
+ * ```ts
+ * const ops = DataBlock.make({
+ *   fromId: 'from-id',
+ *   sourceType: 'COLLECTION',
+ *   // optional
+ *   position: 'position-string',
+ *   name: 'name',
+ * });
+ * ```
+ *
+ * @param param args {@link TextBlockArgs}
+ * @returns ops – The ops for the Data Block entity: {@link Op}[]
+ */
 export declare function make({ fromId, sourceType, position, name }: DataBlockArgs): (SetTripleOp | CreateRelationOp)[];
 export {};
 //# sourceMappingURL=data.d.ts.map

package/dist/src/core/blocks/data.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"data.d.ts","sourceRoot":"","sources":["../../../../src/core/blocks/data.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAEpE,KAAK,mBAAmB,GAAG,OAAO,GAAG,YAAY,GAAG,KAAK,CAAC;AAa1D,KAAK,aAAa,GAAG;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,mBAAmB,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAE3G,wBAAgB,IAAI,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,aAAa,GAAG,CAAC,WAAW,GAAG,gBAAgB,CAAC,EAAE,CAuC9G"}
+{"version":3,"file":"data.d.ts","sourceRoot":"","sources":["../../../../src/core/blocks/data.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH,OAAO,KAAK,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAEpE,KAAK,mBAAmB,GAAG,OAAO,GAAG,YAAY,GAAG,KAAK,CAAC;AAa1D,KAAK,aAAa,GAAG;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,mBAAmB,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAE3G;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,IAAI,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,aAAa,GAAG,CAAC,WAAW,GAAG,gBAAgB,CAAC,EAAE,CAuC9G"}

package/dist/src/core/blocks/data.js

@@ -1,3 +1,9 @@
+/**
+ * This module provides utility functions for working with data blocks
+ * in TypeScript.
+ *
+ * @since 0.0.6
+ */
 import { make as makeId } from '../../id.js';
 import { Relation } from '../../relation.js';
 import { SYSTEM_IDS } from '../../system-ids.js';
@@ -11,6 +17,23 @@ function getSourceTypeId(sourceType) {
             return SYSTEM_IDS.QUERY_DATA_SOURCE;
     }
 }
+/**
+ * Returns the ops to create an entity representing a Data Block.
+ *
+ * @example
+ * ```ts
+ * const ops = DataBlock.make({
+ *   fromId: 'from-id',
+ *   sourceType: 'COLLECTION',
+ *   // optional
+ *   position: 'position-string',
+ *   name: 'name',
+ * });
+ * ```
+ *
+ * @param param args {@link TextBlockArgs}
+ * @returns ops – The ops for the Data Block entity: {@link Op}[]
+ */
 export function make({ fromId, sourceType, position, name }) {
     const newBlockId = makeId();
     const dataBlockType = Relation.make({

package/dist/src/core/blocks/data.js.map

@@ -1 +1 @@
-{"version":3,"file":"data.js","sourceRoot":"","sources":["../../../../src/core/blocks/data.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,IAAI,MAAM,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAKjD,SAAS,eAAe,CAAC,UAA+B;IACtD,QAAQ,UAAU,EAAE,CAAC;QACnB,KAAK,YAAY;YACf,OAAO,UAAU,CAAC,sBAAsB,CAAC;QAC3C,KAAK,KAAK;YACR,OAAO,UAAU,CAAC,sBAAsB,CAAC;QAC3C,KAAK,OAAO;YACV,OAAO,UAAU,CAAC,iBAAiB,CAAC;IACxC,CAAC;AACH,CAAC;AAID,MAAM,UAAU,IAAI,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAiB;IACxE,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC;IAE5B,MAAM,aAAa,GAAG,QAAQ,CAAC,IAAI,CAAC;QAClC,MAAM,EAAE,UAAU;QAClB,cAAc,EAAE,UAAU,CAAC,eAAe;QAC1C,IAAI,EAAE,UAAU,CAAC,UAAU;KAC5B,CAAC,CAAC;IAEH,MAAM,mBAAmB,GAAG,QAAQ,CAAC,IAAI,CAAC;QACxC,MAAM,EAAE,UAAU;QAClB,cAAc,EAAE,UAAU,CAAC,8BAA8B;QACzD,IAAI,EAAE,eAAe,CAAC,UAAU,CAAC;KAClC,CAAC,CAAC;IAEH,MAAM,iBAAiB,GAAG,QAAQ,CAAC,IAAI,CAAC;QACtC,MAAM;QACN,cAAc,EAAE,UAAU,CAAC,MAAM;QACjC,IAAI,EAAE,UAAU;QAChB,QAAQ;KACT,CAAC,CAAC;IAEH,MAAM,GAAG,GAAuC,CAAC,aAAa,EAAE,mBAAmB,EAAE,iBAAiB,CAAC,CAAC;IAExG,IAAI,IAAI,EAAE,CAAC;QACT,GAAG,CAAC,IAAI,CAAC;YACP,IAAI,EAAE,YAAY;YAClB,MAAM,EAAE;gBACN,SAAS,EAAE,UAAU,CAAC,cAAc;gBACpC,MAAM,EAAE,UAAU;gBAClB,KAAK,EAAE;oBACL,IAAI,EAAE,MAAM;oBACZ,KAAK,EAAE,IAAI;iBACZ;aACF;SACF,CAAC,CAAC;IACL,CAAC;IAED,OAAO,GAAG,CAAC;AACb,CAAC"}
+{"version":3,"file":"data.js","sourceRoot":"","sources":["../../../../src/core/blocks/data.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,IAAI,IAAI,MAAM,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAKjD,SAAS,eAAe,CAAC,UAA+B;IACtD,QAAQ,UAAU,EAAE,CAAC;QACnB,KAAK,YAAY;YACf,OAAO,UAAU,CAAC,sBAAsB,CAAC;QAC3C,KAAK,KAAK;YACR,OAAO,UAAU,CAAC,sBAAsB,CAAC;QAC3C,KAAK,OAAO;YACV,OAAO,UAAU,CAAC,iBAAiB,CAAC;IACxC,CAAC;AACH,CAAC;AAID;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,IAAI,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAiB;IACxE,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC;IAE5B,MAAM,aAAa,GAAG,QAAQ,CAAC,IAAI,CAAC;QAClC,MAAM,EAAE,UAAU;QAClB,cAAc,EAAE,UAAU,CAAC,eAAe;QAC1C,IAAI,EAAE,UAAU,CAAC,UAAU;KAC5B,CAAC,CAAC;IAEH,MAAM,mBAAmB,GAAG,QAAQ,CAAC,IAAI,CAAC;QACxC,MAAM,EAAE,UAAU;QAClB,cAAc,EAAE,UAAU,CAAC,8BAA8B;QACzD,IAAI,EAAE,eAAe,CAAC,UAAU,CAAC;KAClC,CAAC,CAAC;IAEH,MAAM,iBAAiB,GAAG,QAAQ,CAAC,IAAI,CAAC;QACtC,MAAM;QACN,cAAc,EAAE,UAAU,CAAC,MAAM;QACjC,IAAI,EAAE,UAAU;QAChB,QAAQ;KACT,CAAC,CAAC;IAEH,MAAM,GAAG,GAAuC,CAAC,aAAa,EAAE,mBAAmB,EAAE,iBAAiB,CAAC,CAAC;IAExG,IAAI,IAAI,EAAE,CAAC;QACT,GAAG,CAAC,IAAI,CAAC;YACP,IAAI,EAAE,YAAY;YAClB,MAAM,EAAE;gBACN,SAAS,EAAE,UAAU,CAAC,cAAc;gBACpC,MAAM,EAAE,UAAU;gBAClB,KAAK,EAAE;oBACL,IAAI,EAAE,MAAM;oBACZ,KAAK,EAAE,IAAI;iBACZ;aACF;SACF,CAAC,CAAC;IACL,CAAC;IAED,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/src/core/blocks/data.test.d.ts

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

package/dist/src/core/blocks/data.test.d.ts.map

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

package/dist/src/core/blocks/data.test.js

@@ -0,0 +1,58 @@
+import { expect, it } from 'vitest';
+import { make } from './data.js';
+import { SYSTEM_IDS } from '~/src/system-ids.js';
+it('should generate ops for a data block entity', () => {
+    const ops = make({
+        fromId: 'test-entity-id',
+        sourceType: 'QUERY',
+        position: 'test-position',
+    });
+    const [blockTypeOp, blockSourceTypeOp, blockRelationOp] = ops;
+    expect(blockTypeOp?.type).toBe('CREATE_RELATION');
+    if (blockTypeOp?.type === 'CREATE_RELATION') {
+        expect(blockTypeOp?.relation.type).toBe(SYSTEM_IDS.TYPES_ATTRIBUTE);
+        expect(blockTypeOp?.relation.toEntity).toBe(SYSTEM_IDS.DATA_BLOCK);
+    }
+    expect(blockSourceTypeOp?.type).toBe('CREATE_RELATION');
+    if (blockSourceTypeOp?.type === 'CREATE_RELATION') {
+        expect(blockSourceTypeOp?.relation.type).toBe(SYSTEM_IDS.DATA_SOURCE_TYPE_RELATION_TYPE);
+        expect(blockSourceTypeOp?.relation.toEntity).toBe(SYSTEM_IDS.QUERY_DATA_SOURCE);
+    }
+    expect(blockRelationOp?.type).toBe('CREATE_RELATION');
+    if (blockRelationOp?.type === 'CREATE_RELATION') {
+        expect(blockRelationOp?.relation.type).toBe(SYSTEM_IDS.BLOCKS);
+        expect(blockRelationOp?.relation.fromEntity).toBe('test-entity-id');
+    }
+    expect(ops.length).toBe(3);
+});
+it('should generate ops for a data block entity with a name', () => {
+    const ops = make({
+        fromId: 'test-entity-id',
+        sourceType: 'QUERY',
+        position: 'test-position',
+        name: 'test-name',
+    });
+    const [blockTypeOp, blockSourceTypeOp, blockRelationOp, blockNameOp] = ops;
+    expect(blockTypeOp?.type).toBe('CREATE_RELATION');
+    if (blockTypeOp?.type === 'CREATE_RELATION') {
+        expect(blockTypeOp?.relation.type).toBe(SYSTEM_IDS.TYPES_ATTRIBUTE);
+        expect(blockTypeOp?.relation.toEntity).toBe(SYSTEM_IDS.DATA_BLOCK);
+    }
+    expect(blockSourceTypeOp?.type).toBe('CREATE_RELATION');
+    if (blockSourceTypeOp?.type === 'CREATE_RELATION') {
+        expect(blockSourceTypeOp?.relation.type).toBe(SYSTEM_IDS.DATA_SOURCE_TYPE_RELATION_TYPE);
+        expect(blockSourceTypeOp?.relation.toEntity).toBe(SYSTEM_IDS.QUERY_DATA_SOURCE);
+    }
+    expect(blockRelationOp?.type).toBe('CREATE_RELATION');
+    if (blockRelationOp?.type === 'CREATE_RELATION') {
+        expect(blockRelationOp?.relation.type).toBe(SYSTEM_IDS.BLOCKS);
+        expect(blockRelationOp?.relation.fromEntity).toBe('test-entity-id');
+    }
+    expect(blockNameOp?.type).toBe('SET_TRIPLE');
+    if (blockNameOp?.type === 'SET_TRIPLE') {
+        expect(blockNameOp?.triple.attribute).toBe(SYSTEM_IDS.NAME_ATTRIBUTE);
+        expect(blockNameOp?.triple.value.type).toBe('TEXT');
+        expect(blockNameOp?.triple.value.value).toBe('test-name');
+    }
+});
+//# sourceMappingURL=data.test.js.map

package/dist/src/core/blocks/data.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"data.test.js","sourceRoot":"","sources":["../../../../src/core/blocks/data.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;IACrD,MAAM,GAAG,GAAG,IAAI,CAAC;QACf,MAAM,EAAE,gBAAgB;QACxB,UAAU,EAAE,OAAO;QACnB,QAAQ,EAAE,eAAe;KAC1B,CAAC,CAAC;IAEH,MAAM,CAAC,WAAW,EAAE,iBAAiB,EAAE,eAAe,CAAC,GAAG,GAAG,CAAC;IAE9D,MAAM,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAClD,IAAI,WAAW,EAAE,IAAI,KAAK,iBAAiB,EAAE,CAAC;QAC5C,MAAM,CAAC,WAAW,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;QACpE,MAAM,CAAC,WAAW,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IACxD,IAAI,iBAAiB,EAAE,IAAI,KAAK,iBAAiB,EAAE,CAAC;QAClD,MAAM,CAAC,iBAAiB,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,8BAA8B,CAAC,CAAC;QACzF,MAAM,CAAC,iBAAiB,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;IAClF,CAAC;IAED,MAAM,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IACtD,IAAI,eAAe,EAAE,IAAI,KAAK,iBAAiB,EAAE,CAAC;QAChD,MAAM,CAAC,eAAe,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAC/D,MAAM,CAAC,eAAe,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACtE,CAAC;IAED,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAC7B,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,yDAAyD,EAAE,GAAG,EAAE;IACjE,MAAM,GAAG,GAAG,IAAI,CAAC;QACf,MAAM,EAAE,gBAAgB;QACxB,UAAU,EAAE,OAAO;QACnB,QAAQ,EAAE,eAAe;QACzB,IAAI,EAAE,WAAW;KAClB,CAAC,CAAC;IAEH,MAAM,CAAC,WAAW,EAAE,iBAAiB,EAAE,eAAe,EAAE,WAAW,CAAC,GAAG,GAAG,CAAC;IAE3E,MAAM,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAClD,IAAI,WAAW,EAAE,IAAI,KAAK,iBAAiB,EAAE,CAAC;QAC5C,MAAM,CAAC,WAAW,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;QACpE,MAAM,CAAC,WAAW,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IACxD,IAAI,iBAAiB,EAAE,IAAI,KAAK,iBAAiB,EAAE,CAAC;QAClD,MAAM,CAAC,iBAAiB,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,8BAA8B,CAAC,CAAC;QACzF,MAAM,CAAC,iBAAiB,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;IAClF,CAAC;IAED,MAAM,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IACtD,IAAI,eAAe,EAAE,IAAI,KAAK,iBAAiB,EAAE,CAAC;QAChD,MAAM,CAAC,eAAe,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAC/D,MAAM,CAAC,eAAe,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACtE,CAAC;IAED,MAAM,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC7C,IAAI,WAAW,EAAE,IAAI,KAAK,YAAY,EAAE,CAAC;QACvC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;QACtE,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACpD,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAC5D,CAAC;AACH,CAAC,CAAC,CAAC"}

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

@@ -1,3 +1,9 @@
+/**
+ * This module provides utility functions for working with image blocks
+ * in TypeScript.
+ *
+ * @since 0.0.6
+ */
 /**
  * Image entities and Image Blocks are functionally the same thing. The
  * relation consuming the entity is what gives it contextual meaning. e.g.,

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

@@ -1 +1 @@
-{"version":3,"file":"image.d.ts","sourceRoot":"","sources":["../../../../src/core/blocks/image.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"image.d.ts","sourceRoot":"","sources":["../../../../src/core/blocks/image.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;;;GAMG;AACH,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC"}

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

@@ -1,3 +1,9 @@
+/**
+ * This module provides utility functions for working with image blocks
+ * in TypeScript.
+ *
+ * @since 0.0.6
+ */
 /**
  * Image entities and Image Blocks are functionally the same thing. The
  * relation consuming the entity is what gives it contextual meaning. e.g.,

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

@@ -1 +1 @@
-{"version":3,"file":"image.js","sourceRoot":"","sources":["../../../../src/core/blocks/image.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"image.js","sourceRoot":"","sources":["../../../../src/core/blocks/image.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;;;GAMG;AACH,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC"}

package/dist/src/core/blocks/text.d.ts

@@ -1,9 +1,31 @@
+/**
+ * This module provides utility functions for working with text blocks
+ * in TypeScript.
+ *
+ * @since 0.0.6
+ */
 import type { Op } from '../../types.js';
 type TextBlockArgs = {
     fromId: string;
     text: string;
     position?: string;
 };
+/**
+ * Returns the ops to create an entity representing a Text Block.
+ *
+ * @example
+ * ```ts
+ * const ops = TextBlock.make({
+ *   fromId: 'from-id',
+ *   text: 'text',
+ *   // optional
+ *   position: 'position-string',
+ * });
+ * ```
+ *
+ * @param param args {@link TextBlockArgs}
+ * @returns ops – The ops for the Text Block entity: {@link Op}[]
+ */
 export declare function make({ fromId, text, position }: TextBlockArgs): Op[];
 export {};
 //# sourceMappingURL=text.d.ts.map

package/dist/src/core/blocks/text.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"text.d.ts","sourceRoot":"","sources":["../../../../src/core/blocks/text.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAEzC,KAAK,aAAa,GAAG;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEzE,wBAAgB,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,aAAa,GAAG,EAAE,EAAE,CA6BpE"}
+{"version":3,"file":"text.d.ts","sourceRoot":"","sources":["../../../../src/core/blocks/text.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAEzC,KAAK,aAAa,GAAG;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEzE;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,aAAa,GAAG,EAAE,EAAE,CA6BpE"}

package/dist/src/core/blocks/text.js

@@ -1,6 +1,28 @@
+/**
+ * This module provides utility functions for working with text blocks
+ * in TypeScript.
+ *
+ * @since 0.0.6
+ */
 import { make as makeId } from '../../id.js';
 import { Relation } from '../../relation.js';
 import { SYSTEM_IDS } from '../../system-ids.js';
+/**
+ * Returns the ops to create an entity representing a Text Block.
+ *
+ * @example
+ * ```ts
+ * const ops = TextBlock.make({
+ *   fromId: 'from-id',
+ *   text: 'text',
+ *   // optional
+ *   position: 'position-string',
+ * });
+ * ```
+ *
+ * @param param args {@link TextBlockArgs}
+ * @returns ops – The ops for the Text Block entity: {@link Op}[]
+ */
 export function make({ fromId, text, position }) {
     const newBlockId = makeId();
     const textBlockType = Relation.make({

package/dist/src/core/blocks/text.js.map

@@ -1 +1 @@
-{"version":3,"file":"text.js","sourceRoot":"","sources":["../../../../src/core/blocks/text.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,IAAI,MAAM,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAKjD,MAAM,UAAU,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAiB;IAC5D,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC;IAE5B,MAAM,aAAa,GAAG,QAAQ,CAAC,IAAI,CAAC;QAClC,MAAM,EAAE,UAAU;QAClB,cAAc,EAAE,UAAU,CAAC,eAAe;QAC1C,IAAI,EAAE,UAAU,CAAC,UAAU;KAC5B,CAAC,CAAC;IAEH,MAAM,qBAAqB,GAAG;QAC5B,IAAI,EAAE,YAAY;QAClB,MAAM,EAAE;YACN,SAAS,EAAE,UAAU,CAAC,gBAAgB;YACtC,MAAM,EAAE,UAAU;YAClB,KAAK,EAAE;gBACL,IAAI,EAAE,MAAM;gBACZ,KAAK,EAAE,IAAI;aACZ;SACF;KACO,CAAC;IAEX,MAAM,iBAAiB,GAAG,QAAQ,CAAC,IAAI,CAAC;QACtC,MAAM;QACN,cAAc,EAAE,UAAU,CAAC,MAAM;QACjC,IAAI,EAAE,UAAU;QAChB,QAAQ;KACT,CAAC,CAAC;IAEH,OAAO,CAAC,aAAa,EAAE,qBAAqB,EAAE,iBAAiB,CAAC,CAAC;AACnE,CAAC"}
+{"version":3,"file":"text.js","sourceRoot":"","sources":["../../../../src/core/blocks/text.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,IAAI,IAAI,MAAM,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAKjD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAiB;IAC5D,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC;IAE5B,MAAM,aAAa,GAAG,QAAQ,CAAC,IAAI,CAAC;QAClC,MAAM,EAAE,UAAU;QAClB,cAAc,EAAE,UAAU,CAAC,eAAe;QAC1C,IAAI,EAAE,UAAU,CAAC,UAAU;KAC5B,CAAC,CAAC;IAEH,MAAM,qBAAqB,GAAG;QAC5B,IAAI,EAAE,YAAY;QAClB,MAAM,EAAE;YACN,SAAS,EAAE,UAAU,CAAC,gBAAgB;YACtC,MAAM,EAAE,UAAU;YAClB,KAAK,EAAE;gBACL,IAAI,EAAE,MAAM;gBACZ,KAAK,EAAE,IAAI;aACZ;SACF;KACO,CAAC;IAEX,MAAM,iBAAiB,GAAG,QAAQ,CAAC,IAAI,CAAC;QACtC,MAAM;QACN,cAAc,EAAE,UAAU,CAAC,MAAM;QACjC,IAAI,EAAE,UAAU;QAChB,QAAQ;KACT,CAAC,CAAC;IAEH,OAAO,CAAC,aAAa,EAAE,qBAAqB,EAAE,iBAAiB,CAAC,CAAC;AACnE,CAAC"}

package/dist/src/core/blocks/text.test.d.ts

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

package/dist/src/core/blocks/text.test.d.ts.map

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

package/dist/src/core/blocks/text.test.js

@@ -0,0 +1,29 @@
+import { expect, it } from 'vitest';
+import { make } from './text.js';
+import { SYSTEM_IDS } from '~/src/system-ids.js';
+it('should generate ops for a text block entity', () => {
+    const ops = make({
+        fromId: 'test-entity-id',
+        text: 'test-text',
+        position: 'test-position',
+    });
+    const [blockTypeOp, blockMarkdownTextOp, blockRelationOp] = ops;
+    expect(blockTypeOp?.type).toBe('CREATE_RELATION');
+    if (blockTypeOp?.type === 'CREATE_RELATION') {
+        expect(blockTypeOp?.relation.type).toBe(SYSTEM_IDS.TYPES_ATTRIBUTE);
+        expect(blockTypeOp?.relation.toEntity).toBe(SYSTEM_IDS.TEXT_BLOCK);
+    }
+    expect(blockMarkdownTextOp?.type).toBe('SET_TRIPLE');
+    if (blockMarkdownTextOp?.type === 'SET_TRIPLE') {
+        expect(blockMarkdownTextOp?.triple.attribute).toBe(SYSTEM_IDS.MARKDOWN_CONTENT);
+        expect(blockMarkdownTextOp?.triple.value.type).toBe('TEXT');
+        expect(blockMarkdownTextOp?.triple.value.value).toBe('test-text');
+    }
+    expect(blockRelationOp?.type).toBe('CREATE_RELATION');
+    if (blockRelationOp?.type === 'CREATE_RELATION') {
+        expect(blockRelationOp?.relation.type).toBe(SYSTEM_IDS.BLOCKS);
+        expect(blockRelationOp?.relation.fromEntity).toBe('test-entity-id');
+    }
+    expect(ops.length).toBe(3);
+});
+//# sourceMappingURL=text.test.js.map

package/dist/src/core/blocks/text.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"text.test.js","sourceRoot":"","sources":["../../../../src/core/blocks/text.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;IACrD,MAAM,GAAG,GAAG,IAAI,CAAC;QACf,MAAM,EAAE,gBAAgB;QACxB,IAAI,EAAE,WAAW;QACjB,QAAQ,EAAE,eAAe;KAC1B,CAAC,CAAC;IAEH,MAAM,CAAC,WAAW,EAAE,mBAAmB,EAAE,eAAe,CAAC,GAAG,GAAG,CAAC;IAEhE,MAAM,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAClD,IAAI,WAAW,EAAE,IAAI,KAAK,iBAAiB,EAAE,CAAC;QAC5C,MAAM,CAAC,WAAW,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;QACpE,MAAM,CAAC,WAAW,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACrD,IAAI,mBAAmB,EAAE,IAAI,KAAK,YAAY,EAAE,CAAC;QAC/C,MAAM,CAAC,mBAAmB,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;QAChF,MAAM,CAAC,mBAAmB,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC5D,MAAM,CAAC,mBAAmB,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACpE,CAAC;IAED,MAAM,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IACtD,IAAI,eAAe,EAAE,IAAI,KAAK,iBAAiB,EAAE,CAAC;QAChD,MAAM,CAAC,eAAe,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAC/D,MAAM,CAAC,eAAe,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACtE,CAAC;IAED,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAC7B,CAAC,CAAC,CAAC"}

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

@@ -1,3 +1,9 @@
+/**
+ * This module provides utility functions for working with knowledge graph
+ * images in TypeScript.
+ *
+ * @since 0.0.6
+ */
 import type { CreateRelationOp, SetTripleOp } from '../types.js';
 type MakeImageReturnType = {
     imageId: string;
@@ -6,7 +12,15 @@ type MakeImageReturnType = {
 /**
  * Creates an entity representing an Image.
  *
- * @returns ops: The SET_TRIPLE ops for an Image entity
+ * @example
+ * ```ts
+ * const { imageId, ops } = Image.make('https://example.com/image.png');
+ * console.log(imageId); // 'gw9uTVTnJdhtczyuzBkL3X'
+ * console.log(ops); // [...]
+ * ```
+ *
+ * @returns imageId – base58 encoded v4 uuid representing the image entity: {@link MakeImageReturnType}
+ * @returns ops – The ops for the Image entity: {@link MakeImageReturnType}
  */
 export declare function make(src: string): MakeImageReturnType;
 export {};

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

@@ -1 +1 @@
-{"version":3,"file":"image.d.ts","sourceRoot":"","sources":["../../../src/core/image.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAM,WAAW,EAAE,MAAM,aAAa,CAAC;AAErE,KAAK,mBAAmB,GAAG;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,CAAC,gBAAgB,EAAE,WAAW,CAAC,CAAC;CACtC,CAAC;AAEF;;;;GAIG;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;AAKH,OAAO,KAAK,EAAE,gBAAgB,EAAM,WAAW,EAAE,MAAM,aAAa,CAAC;AAErE,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"}

package/dist/src/core/image.js

@@ -1,10 +1,24 @@
+/**
+ * This module provides utility functions for working with knowledge graph
+ * images in TypeScript.
+ *
+ * @since 0.0.6
+ */
 import { make as makeId } from '../id.js';
 import { Relation } from '../relation.js';
 import { SYSTEM_IDS } from '../system-ids.js';
 /**
  * Creates an entity representing an Image.
  *
- * @returns ops: The SET_TRIPLE ops for an Image entity
+ * @example
+ * ```ts
+ * const { imageId, ops } = Image.make('https://example.com/image.png');
+ * console.log(imageId); // 'gw9uTVTnJdhtczyuzBkL3X'
+ * console.log(ops); // [...]
+ * ```
+ *
+ * @returns imageId – base58 encoded v4 uuid representing the image entity: {@link MakeImageReturnType}
+ * @returns ops – The ops for the Image entity: {@link MakeImageReturnType}
  */
 export function make(src) {
     const entityId = makeId();

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

@@ -1 +1 @@
-{"version":3,"file":"image.js","sourceRoot":"","sources":["../../../src/core/image.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,IAAI,MAAM,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAQ9C;;;;GAIG;AACH,MAAM,UAAU,IAAI,CAAC,GAAW;IAC9B,MAAM,QAAQ,GAAG,MAAM,EAAE,CAAC;IAE1B,OAAO;QACL,OAAO,EAAE,QAAQ;QACjB,GAAG,EAAE;YACH,QAAQ,CAAC,IAAI,CAAC;gBACZ,MAAM,EAAE,QAAQ;gBAChB,IAAI,EAAE,UAAU,CAAC,UAAU;gBAC3B,cAAc,EAAE,UAAU,CAAC,eAAe;aAC3C,CAAC;YACF;gBACE,IAAI,EAAE,YAAY;gBAClB,MAAM,EAAE;oBACN,MAAM,EAAE,QAAQ;oBAChB,SAAS,EAAE,UAAU,CAAC,mBAAmB;oBACzC,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,EAAE,IAAI,IAAI,MAAM,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAQ9C;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,IAAI,CAAC,GAAW;IAC9B,MAAM,QAAQ,GAAG,MAAM,EAAE,CAAC;IAE1B,OAAO;QACL,OAAO,EAAE,QAAQ;QACjB,GAAG,EAAE;YACH,QAAQ,CAAC,IAAI,CAAC;gBACZ,MAAM,EAAE,QAAQ;gBAChB,IAAI,EAAE,UAAU,CAAC,UAAU;gBAC3B,cAAc,EAAE,UAAU,CAAC,eAAe;aAC3C,CAAC;YACF;gBACE,IAAI,EAAE,YAAY;gBAClB,MAAM,EAAE;oBACN,MAAM,EAAE,QAAQ;oBAChB,SAAS,EAAE,UAAU,CAAC,mBAAmB;oBACzC,KAAK,EAAE;wBACL,IAAI,EAAE,KAAK;wBACX,KAAK,EAAE,GAAG;qBACX;iBACF;aACF;SACF;KACF,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,26 @@
+import { expect, it } from 'vitest';
+import { make } from './image.js';
+import { SYSTEM_IDS } from '../system-ids.js';
+import { INITIAL_RELATION_INDEX_VALUE } from '~/constants.js';
+it('should generate ops for an image entity', () => {
+    const { imageId, ops } = make('https://example.com/image.png');
+    const [createRelationOp, setTripleOp] = ops;
+    // 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(SYSTEM_IDS.TYPES_ATTRIBUTE);
+    expect(createRelationOp.relation.fromEntity).toBe(imageId);
+    expect(createRelationOp.relation.toEntity).toBe(SYSTEM_IDS.IMAGE_TYPE);
+    expect(createRelationOp.relation.index).toBe(INITIAL_RELATION_INDEX_VALUE);
+    expect(setTripleOp).toEqual({
+        type: 'SET_TRIPLE',
+        triple: {
+            attribute: SYSTEM_IDS.IMAGE_URL_ATTRIBUTE,
+            entity: imageId,
+            value: {
+                type: 'URL',
+                value: 'https://example.com/image.png',
+            },
+        },
+    });
+});
+//# 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,IAAI,EAAE,MAAM,YAAY,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,4BAA4B,EAAE,MAAM,gBAAgB,CAAC;AAE9D,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,UAAU,CAAC,eAAe,CAAC,CAAC;IACxE,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,UAAU,CAAC,UAAU,CAAC,CAAC;IACvE,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,UAAU,CAAC,mBAAmB;YACzC,MAAM,EAAE,OAAO;YACf,KAAK,EAAE;gBACL,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE,+BAA+B;aACvC;SACF;KACF,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

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

@@ -1,3 +1,8 @@
+/**
+ * This module provides utility functions for working with fractional indexes in TypeScript.
+ *
+ * @since 0.0.6
+ */
 import { PositionSource } from 'position-strings';
 export declare const Position: PositionSource;
 export declare const PositionRange: {

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

@@ -1 +1 @@
-{"version":3,"file":"position.d.ts","sourceRoot":"","sources":["../../../src/core/position.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,eAAO,MAAM,QAAQ,gBAAuB,CAAC;AAE7C,eAAO,MAAM,aAAa;;;CAGzB,CAAC"}
+{"version":3,"file":"position.d.ts","sourceRoot":"","sources":["../../../src/core/position.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,eAAO,MAAM,QAAQ,gBAAuB,CAAC;AAE7C,eAAO,MAAM,aAAa;;;CAGzB,CAAC"}

package/dist/src/core/position.js

@@ -1,3 +1,8 @@
+/**
+ * This module provides utility functions for working with fractional indexes in TypeScript.
+ *
+ * @since 0.0.6
+ */
 import { PositionSource } from 'position-strings';
 export const Position = new PositionSource();
 export const PositionRange = {

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

@@ -1 +1 @@
-{"version":3,"file":"position.js","sourceRoot":"","sources":["../../../src/core/position.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,MAAM,CAAC,MAAM,QAAQ,GAAG,IAAI,cAAc,EAAE,CAAC;AAE7C,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,KAAK,EAAE,cAAc,CAAC,KAAK;IAC3B,IAAI,EAAE,cAAc,CAAC,IAAI;CAC1B,CAAC"}
+{"version":3,"file":"position.js","sourceRoot":"","sources":["../../../src/core/position.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,MAAM,CAAC,MAAM,QAAQ,GAAG,IAAI,cAAc,EAAE,CAAC;AAE7C,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,KAAK,EAAE,cAAc,CAAC,KAAK;IAC3B,IAAI,EAAE,cAAc,CAAC,IAAI;CAC1B,CAAC"}

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

@@ -1,5 +1,19 @@
+/**
+ * This module provides utility functions for working with Relations in TypeScript.
+ *
+ * @since 0.0.6
+ */
 import { SYSTEM_IDS } 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
+ */
 interface CreateRelationArgs {
     relationId?: string;
     fromId: string;
@@ -7,7 +21,36 @@ interface CreateRelationArgs {
     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 CreateRelationArgs}
+ * @returns – {@link CreateRelationOp}
+ */
 export declare function make(args: CreateRelationArgs): 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;
 interface ReorderRelationArgs {
     relationId: string;
@@ -25,6 +68,21 @@ type ReorderRelationOp = {
         };
     };
 };
+/**
+ * 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 ReorderRelationArgs}
+ * @returns – {@link ReorderRelationOp}
+ */
 export declare function reorder(args: ReorderRelationArgs): 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":"AAEA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAGtE,UAAU,kBAAkB;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;AAED,wBAAgB,IAAI,CAAC,IAAI,EAAE,kBAAkB,GAAG,gBAAgB,CAa/D;AAED,wBAAgB,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,gBAAgB,CAO3D;AAED,UAAU,mBAAmB;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,KAAK,iBAAiB,GAAG;IACvB,IAAI,EAAE,YAAY,CAAC;IACnB,MAAM,EAAE;QACN,SAAS,EAAE,OAAO,UAAU,CAAC,cAAc,CAAC;QAC5C,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE;YACL,IAAI,EAAE,MAAM,CAAC;YACb,KAAK,EAAE,MAAM,CAAC;SACf,CAAC;KACH,CAAC;CACH,CAAC;AAEF,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,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAGtE;;;;;;;;GAQG;AACH,UAAU,kBAAkB;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;AAED;;;;;;;;;;;;;;;;;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,UAAU,mBAAmB;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,KAAK,iBAAiB,GAAG;IACvB,IAAI,EAAE,YAAY,CAAC;IACnB,MAAM,EAAE;QACN,SAAS,EAAE,OAAO,UAAU,CAAC,cAAc,CAAC;QAC5C,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"}

package/dist/src/core/relation.js

@@ -1,7 +1,30 @@
+/**
+ * This module provides utility functions for working with Relations in TypeScript.
+ *
+ * @since 0.0.6
+ */
 import { INITIAL_RELATION_INDEX_VALUE } from '../../constants.js';
 import { make as makeId } from '../id.js';
 import { SYSTEM_IDS } 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 CreateRelationArgs}
+ * @returns – {@link CreateRelationOp}
+ */
 export function make(args) {
     const newEntityId = args.relationId ?? makeId();
     return {
@@ -15,6 +38,17 @@ export function make(args) {
         },
     };
 }
+/**
+ * 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',
@@ -23,6 +57,21 @@ export function remove(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 ReorderRelationArgs}
+ * @returns – {@link ReorderRelationOp}
+ */
 export function reorder(args) {
     const newIndex = Position.createBetween(args.beforeIndex, args.afterIndex);
     return {

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

@@ -1 +1 @@
-{"version":3,"file":"relation.js","sourceRoot":"","sources":["../../../src/core/relation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,MAAM,oBAAoB,CAAC;AAClE,OAAO,EAAE,IAAI,IAAI,MAAM,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE9C,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAUzC,MAAM,UAAU,IAAI,CAAC,IAAwB;IAC3C,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,IAAI,MAAM,EAAE,CAAC;IAEhD,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,MAAM,UAAU,MAAM,CAAC,UAAkB;IACvC,OAAO;QACL,IAAI,EAAE,iBAAiB;QACvB,QAAQ,EAAE;YACR,EAAE,EAAE,UAAU;SACf;KACF,CAAC;AACJ,CAAC;AAoBD,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,UAAU,CAAC,cAAc;YACpC,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,IAAI,IAAI,MAAM,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE9C,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAmBzC;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,IAAI,CAAC,IAAwB;IAC3C,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,IAAI,MAAM,EAAE,CAAC;IAEhD,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,UAAU,CAAC,cAAc;YACpC,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":""}