@graphprotocol/grc-20 0.0.7 → 0.0.8

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

@@ -0,0 +1,45 @@
+import { expect, it } from 'vitest';
+import { make, remove, reorder } from './relation.js';
+import { Position, PositionRange } from './position.js';
+import { RELATION_INDEX } from './ids/system.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,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEjD,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/scheme.d.ts

@@ -1,10 +1,79 @@
+/**
+ * This module provides utility functions for working with Graph URIs in TypeScript.
+ *
+ * @since 0.0.6
+ */
 type GraphUri = `graph://${string}`;
 type SchemeQueryParams = {
     spaceId?: string;
-    versionId?: string;
 };
+/**
+ * Encodes an entity id into a Graph URI. Optionally, you can specify a space id to be included in the URI.
+ *
+ * @example
+ * ```ts
+ * const uri = GraphUrl.fromEntityId('entity-id');
+ * console.log(uri); // graph://entity-id
+ *
+ * const uriWithSpaceId = GraphUrl.fromEntityId('entity-id', { spaceId: 'space-id' });
+ * console.log(uriWithSpaceId); // graph://entity-id?s=space-id
+ * ```
+ *
+ * @param entityId base58 encoded v4 uuid
+ * @param params optional params: {@link SchemeQueryParams}
+ * @returns Graph URI: {@link GraphUri}
+ */
 export declare function fromEntityId(entityId: string, params?: SchemeQueryParams): GraphUri;
+/**
+ * Returns true if the provided value is a valid Graph URI.
+ *
+ * @example
+ * ```ts
+ * const shouldBeTrue = GraphUrl.isValid('graph://entity-id');
+ * console.log(shouldBeTrue); // true
+ *
+ * const shouldBeFalse = GraphUrl.isValid('entity-id');
+ * console.log(shouldBeFalse); // false
+ * ```
+ *
+ * @param value – Graph URI: {@link GraphUri}
+ * @returns – `true` if the value is a valid Graph URI, `false` otherwise
+ */
 export declare function isValid(value: string): value is GraphUri;
+/**
+ * Decodes the entity id from a Graph URI. Throws an error if the URI is not valid.
+ *
+ * @example
+ * ```ts
+ * const entityId = GraphUrl.toEntityId('graph://entity-id');
+ * console.log(entityId); // entity-id
+ *
+ * const entityIdWithSpaceId = GraphUrl.toEntityId('graph://entity-id?s=space-id');
+ * console.log(entityIdWithSpaceId); // entity-id
+ *
+ * const entityId = GraphUrl.toEntityId('invalid-uri'); // throws
+ * ```
+ *
+ * @param uri – Graph URI: {@link GraphUri}
+ * @returns – base58 encoded v4 uuid representing an entity
+ * @throws Error if the URI is not valid
+ */
 export declare function toEntityId(uri: GraphUri): string;
+/**
+ * Decodes the space id from a Graph URI. Throws an error if the URI is not valid.
+ *
+ * @example
+ * ```ts
+ * const spaceId = GraphUrl.toSpaceId('graph://entity-id?s=space-id');
+ * console.log(spaceId); // space-id
+ *
+ * const spaceId = GraphUrl.toSpaceId('graph://entity-id'); // throws
+ * ```
+ *
+ * @param uri – Graph URI: {@link GraphUri}
+ * @returns – base58 encoded v4 uuid representing a space
+ * @throws Error if the URI is not valid
+ */
+export declare function toSpaceId(uri: GraphUri): string;
 export {};
 //# sourceMappingURL=scheme.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"scheme.d.ts","sourceRoot":"","sources":["../../../src/core/scheme.ts"],"names":[],"mappings":"AAAA,KAAK,QAAQ,GAAG,WAAW,MAAM,EAAE,CAAC;AAEpC,KAAK,iBAAiB,GAAG;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAE,iBAAsB,GAAG,QAAQ,CAYvF;AAED,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,QAAQ,CAExD;AAED,wBAAgB,UAAU,CAAC,GAAG,EAAE,QAAQ,GAAG,MAAM,CAQhD"}
+{"version":3,"file":"scheme.d.ts","sourceRoot":"","sources":["../../../src/core/scheme.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,KAAK,QAAQ,GAAG,WAAW,MAAM,EAAE,CAAC;AAEpC,KAAK,iBAAiB,GAAG;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAKF;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAE,iBAAsB,GAAG,QAAQ,CAYvF;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,QAAQ,CAExD;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,QAAQ,GAAG,MAAM,CAQhD;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,QAAQ,GAAG,MAAM,CAS/C"}

package/dist/src/core/scheme.js

@@ -1,21 +1,100 @@
+/**
+ * This module provides utility functions for working with Graph URIs in TypeScript.
+ *
+ * @since 0.0.6
+ */
+const SPACE_SEARCH_PARAM = 's';
+const SCHEME_PREFIX = 'graph';
+/**
+ * Encodes an entity id into a Graph URI. Optionally, you can specify a space id to be included in the URI.
+ *
+ * @example
+ * ```ts
+ * const uri = GraphUrl.fromEntityId('entity-id');
+ * console.log(uri); // graph://entity-id
+ *
+ * const uriWithSpaceId = GraphUrl.fromEntityId('entity-id', { spaceId: 'space-id' });
+ * console.log(uriWithSpaceId); // graph://entity-id?s=space-id
+ * ```
+ *
+ * @param entityId base58 encoded v4 uuid
+ * @param params optional params: {@link SchemeQueryParams}
+ * @returns Graph URI: {@link GraphUri}
+ */
 export function fromEntityId(entityId, params = {}) {
     if (isValid(entityId)) {
-        throw new Error('The passed in entityId should not start with graph://');
+        throw new Error(`The passed in entityId should not start with ${SCHEME_PREFIX}://`);
     }
-    let uri = `graph://${entityId}`;
+    let uri = `${SCHEME_PREFIX}://${entityId}`;
     if (params.spaceId) {
-        uri = `${uri}?s=${params.spaceId}`;
+        uri = `${uri}?${SPACE_SEARCH_PARAM}=${params.spaceId}`;
     }
     return uri;
 }
+/**
+ * Returns true if the provided value is a valid Graph URI.
+ *
+ * @example
+ * ```ts
+ * const shouldBeTrue = GraphUrl.isValid('graph://entity-id');
+ * console.log(shouldBeTrue); // true
+ *
+ * const shouldBeFalse = GraphUrl.isValid('entity-id');
+ * console.log(shouldBeFalse); // false
+ * ```
+ *
+ * @param value – Graph URI: {@link GraphUri}
+ * @returns – `true` if the value is a valid Graph URI, `false` otherwise
+ */
 export function isValid(value) {
-    return value.startsWith('graph://');
+    return value.startsWith(`${SCHEME_PREFIX}://`);
 }
+/**
+ * Decodes the entity id from a Graph URI. Throws an error if the URI is not valid.
+ *
+ * @example
+ * ```ts
+ * const entityId = GraphUrl.toEntityId('graph://entity-id');
+ * console.log(entityId); // entity-id
+ *
+ * const entityIdWithSpaceId = GraphUrl.toEntityId('graph://entity-id?s=space-id');
+ * console.log(entityIdWithSpaceId); // entity-id
+ *
+ * const entityId = GraphUrl.toEntityId('invalid-uri'); // throws
+ * ```
+ *
+ * @param uri – Graph URI: {@link GraphUri}
+ * @returns – base58 encoded v4 uuid representing an entity
+ * @throws Error if the URI is not valid
+ */
 export function toEntityId(uri) {
-    const entity = uri.split('graph://')?.[1]?.split('?')[0];
+    const entity = uri.split(`${SCHEME_PREFIX}://`)?.[1]?.split('?')[0];
     if (!entity) {
         throw new Error(`Could not parse entity id from provided URI: ${uri}`);
     }
     return entity;
 }
+/**
+ * Decodes the space id from a Graph URI. Throws an error if the URI is not valid.
+ *
+ * @example
+ * ```ts
+ * const spaceId = GraphUrl.toSpaceId('graph://entity-id?s=space-id');
+ * console.log(spaceId); // space-id
+ *
+ * const spaceId = GraphUrl.toSpaceId('graph://entity-id'); // throws
+ * ```
+ *
+ * @param uri – Graph URI: {@link GraphUri}
+ * @returns – base58 encoded v4 uuid representing a space
+ * @throws Error if the URI is not valid
+ */
+export function toSpaceId(uri) {
+    const url = new URL(uri);
+    const searchParams = url.searchParams;
+    if (!searchParams.has(SPACE_SEARCH_PARAM)) {
+        throw new Error(`Could not parse space id from provided URI: ${uri}`);
+    }
+    return searchParams.get(SPACE_SEARCH_PARAM);
+}
 //# sourceMappingURL=scheme.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"scheme.js","sourceRoot":"","sources":["../../../src/core/scheme.ts"],"names":[],"mappings":"AAOA,MAAM,UAAU,YAAY,CAAC,QAAgB,EAAE,SAA4B,EAAE;IAC3E,IAAI,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;IAC3E,CAAC;IAED,IAAI,GAAG,GAAa,WAAW,QAAQ,EAAE,CAAC;IAE1C,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,GAAG,GAAG,GAAG,GAAG,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;IACrC,CAAC;IAED,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,KAAa;IACnC,OAAO,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;AACtC,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,GAAa;IACtC,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAEzD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,gDAAgD,GAAG,EAAE,CAAC,CAAC;IACzE,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}
+{"version":3,"file":"scheme.js","sourceRoot":"","sources":["../../../src/core/scheme.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAQH,MAAM,kBAAkB,GAAG,GAAG,CAAC;AAC/B,MAAM,aAAa,GAAG,OAAO,CAAC;AAE9B;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,YAAY,CAAC,QAAgB,EAAE,SAA4B,EAAE;IAC3E,IAAI,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,gDAAgD,aAAa,KAAK,CAAC,CAAC;IACtF,CAAC;IAED,IAAI,GAAG,GAAa,GAAG,aAAa,MAAM,QAAQ,EAAE,CAAC;IAErD,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,GAAG,GAAG,GAAG,GAAG,IAAI,kBAAkB,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;IACzD,CAAC;IAED,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,OAAO,CAAC,KAAa;IACnC,OAAO,KAAK,CAAC,UAAU,CAAC,GAAG,aAAa,KAAK,CAAC,CAAC;AACjD,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,UAAU,CAAC,GAAa;IACtC,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,aAAa,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAEpE,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,gDAAgD,GAAG,EAAE,CAAC,CAAC;IACzE,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,SAAS,CAAC,GAAa;IACrC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;IACzB,MAAM,YAAY,GAAG,GAAG,CAAC,YAAY,CAAC;IAEtC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,kBAAkB,CAAC,EAAE,CAAC;QAC1C,MAAM,IAAI,KAAK,CAAC,+CAA+C,GAAG,EAAE,CAAC,CAAC;IACxE,CAAC;IAED,OAAO,YAAY,CAAC,GAAG,CAAC,kBAAkB,CAAW,CAAC;AACxD,CAAC"}

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

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

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

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

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

@@ -0,0 +1,34 @@
+import { describe, expect, it } from 'vitest';
+import { fromEntityId, toEntityId, toSpaceId } from './scheme.js';
+describe('fromEntityId', () => {
+    it('should return a valid graph uri', () => {
+        const uri = fromEntityId('test-entity-id');
+        expect(uri).toBe('graph://test-entity-id');
+    });
+    it('should return a valid graph uri with space id', () => {
+        const uri = fromEntityId('test-entity-id', { spaceId: 'test-space-id' });
+        expect(uri).toBe('graph://test-entity-id?s=test-space-id');
+    });
+    it('should throw error if entity id starts with graph://', () => {
+        expect(() => fromEntityId('graph://test-entity-id')).toThrowError();
+    });
+});
+describe('toEntityId', () => {
+    it('should return the entity id', () => {
+        const entityId = toEntityId('graph://test-entity-id');
+        expect(entityId).toBe('test-entity-id');
+    });
+    it('should throw error if entity id is not valid', () => {
+        expect(() => toEntityId('invalid id')).toThrowError();
+    });
+});
+describe('toSpaceId', () => {
+    it('should return the space id', () => {
+        const spaceId = toSpaceId('graph://test-entity-id?s=test-space-id');
+        expect(spaceId).toBe('test-space-id');
+    });
+    it('should throw error if space id is not valid', () => {
+        expect(() => toSpaceId('graph://test-entity-id')).toThrowError();
+    });
+});
+//# sourceMappingURL=scheme.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"scheme.test.js","sourceRoot":"","sources":["../../../src/core/scheme.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGlE,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;QACzC,MAAM,GAAG,GAAG,YAAY,CAAC,gBAAgB,CAAC,CAAC;QAC3C,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;QACvD,MAAM,GAAG,GAAG,YAAY,CAAC,gBAAgB,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC,CAAC;QACzE,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC9D,MAAM,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,wBAAwB,CAAC,CAAC,CAAC,YAAY,EAAE,CAAC;IACtE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;QACrC,MAAM,QAAQ,GAAG,UAAU,CAAC,wBAAwB,CAAC,CAAC;QACtD,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACtD,MAAM,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,YAAwB,CAAC,CAAC,CAAC,YAAY,EAAE,CAAC;IACpE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACzB,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;QACpC,MAAM,OAAO,GAAG,SAAS,CAAC,wCAAwC,CAAC,CAAC;QACpE,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACrD,MAAM,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,wBAAwB,CAAC,CAAC,CAAC,YAAY,EAAE,CAAC;IACnE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

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

@@ -1,14 +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';
 interface CreateTripleArgs {
     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 CreateTripleArgs}
+ * @returns – {@link SetTripleOp}
+ */
 export declare function make(args: CreateTripleArgs): SetTripleOp;
 interface DeleteTripleArgs {
     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 DeleteTripleArgs}
+ * @returns – {@link DeleteTripleOp}
+ */
 export declare function remove(args: DeleteTripleArgs): 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,OAAO,KAAK,EAAE,cAAc,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEtE,UAAU,gBAAgB;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;CACd;AAED,wBAAgB,IAAI,CAAC,IAAI,EAAE,gBAAgB,GAAG,WAAW,CASxD;AAED,UAAU,gBAAgB;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,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,UAAU,gBAAgB;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;CACd;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,IAAI,CAAC,IAAI,EAAE,gBAAgB,GAAG,WAAW,CASxD;AAED,UAAU,gBAAgB;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,gBAAgB,GAAG,cAAc,CAQ7D"}

package/dist/src/core/triple.js

@@ -1,3 +1,25 @@
+/**
+ * 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 CreateTripleArgs}
+ * @returns – {@link SetTripleOp}
+ */
 export function make(args) {
     return {
         type: 'SET_TRIPLE',
@@ -8,6 +30,20 @@ export function make(args) {
         },
     };
 }
+/**
+ * Generates op for deleting a Triple.
+ *
+ * @example
+ * ```ts
+ * const op = Triple.remove({
+ *   attributeId: 'attribute-id',
+ *   entityId: 'entity-id',
+ * });
+ * ```
+ *
+ * @param args – {@link DeleteTripleArgs}
+ * @returns – {@link DeleteTripleOp}
+ */
 export function remove(args) {
     return {
         type: 'DELETE_TRIPLE',

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

@@ -1 +1 @@
-{"version":3,"file":"triple.js","sourceRoot":"","sources":["../../../src/core/triple.ts"],"names":[],"mappings":"AAQA,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,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,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"}

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/id.d.ts

@@ -1,3 +1,9 @@
+/**
+ * This module provides utility functions for working knowledge graph
+ * identifiers in TypeScript.
+ *
+ * @since 0.0.6
+ */
 /**
  * Generates a globally unique knowledge graph identifier.
  *

package/dist/src/id.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"id.d.ts","sourceRoot":"","sources":["../../src/id.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;GAYG;AACH,wBAAgB,IAAI,WAInB"}
+{"version":3,"file":"id.d.ts","sourceRoot":"","sources":["../../src/id.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAMH;;;;;;;;;;;;GAYG;AACH,wBAAgB,IAAI,WAenB"}

package/dist/src/id.js

@@ -1,3 +1,9 @@
+/**
+ * This module provides utility functions for working knowledge graph
+ * identifiers in TypeScript.
+ *
+ * @since 0.0.6
+ */
 import { v4 as uuidv4 } from 'uuid';
 import { encodeBase58 } from './core/base58.js';
 /**
@@ -16,6 +22,15 @@ import { encodeBase58 } from './core/base58.js';
 export function make() {
     const uuid = uuidv4();
     const stripped = uuid.replaceAll(/-/g, '');
-    return encodeBase58(stripped);
+    const id = encodeBase58(stripped);
+    // In extremely rare occasions the id generator may result in ids that are
+    // 21 characters instead of 22. Theoretically the smallest length the id can
+    // generate is 16 characters, but only in specifically engineered cases.
+    //
+    // If this occurs we can generate again until we get a valid id.
+    if (id.length === 22) {
+        return id;
+    }
+    return make();
 }
 //# sourceMappingURL=id.js.map

package/dist/src/id.js.map

@@ -1 +1 @@
-{"version":3,"file":"id.js","sourceRoot":"","sources":["../../src/id.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AAEpC,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAEhD;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,IAAI;IAClB,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC;IACtB,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAC3C,OAAO,YAAY,CAAC,QAAQ,CAAC,CAAC;AAChC,CAAC"}
+{"version":3,"file":"id.js","sourceRoot":"","sources":["../../src/id.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AAEpC,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAEhD;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,IAAI;IAClB,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC;IACtB,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAC3C,MAAM,EAAE,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;IAElC,0EAA0E;IAC1E,4EAA4E;IAC5E,wEAAwE;IACxE,EAAE;IACF,gEAAgE;IAChE,IAAI,EAAE,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;QACrB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,OAAO,IAAI,EAAE,CAAC;AAChB,CAAC"}

package/dist/src/id.test.d.ts

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

package/dist/src/id.test.d.ts.map

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

package/dist/src/id.test.js

@@ -0,0 +1,11 @@
+import { expect, it } from 'vitest';
+import { BASE58_ALLOWED_CHARS } from './core/base58.js';
+import { make } from './id.js';
+// @NOTE this would be a good candidate for DST-style tests
+it('should generate valid base58 encoded id with length of 22', () => {
+    const id = make();
+    expect(id).toBeTypeOf('string');
+    expect(id.length).toBe(22);
+    expect(id.split('').every(char => BASE58_ALLOWED_CHARS.includes(char))).toBe(true);
+});
+//# sourceMappingURL=id.test.js.map

package/dist/src/id.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"id.test.js","sourceRoot":"","sources":["../../src/id.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAEpC,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAE/B,2DAA2D;AAC3D,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;IACnE,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC;IAClB,MAAM,CAAC,EAAE,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAChC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC3B,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACrF,CAAC,CAAC,CAAC"}

package/dist/src/image.d.ts

@@ -1,2 +1,8 @@
+/**
+ * This module provides utility functions for working with knowledge graph
+ * images in TypeScript.
+ *
+ * @since 0.0.6
+ */
 export * as Image from './core/image.js';
 //# sourceMappingURL=image.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"image.d.ts","sourceRoot":"","sources":["../../src/image.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,iBAAiB,CAAC"}
+{"version":3,"file":"image.d.ts","sourceRoot":"","sources":["../../src/image.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,KAAK,KAAK,MAAM,iBAAiB,CAAC"}

package/dist/src/image.js

@@ -1,2 +1,8 @@
+/**
+ * This module provides utility functions for working with knowledge graph
+ * images in TypeScript.
+ *
+ * @since 0.0.6
+ */
 export * as Image from './core/image.js';
 //# sourceMappingURL=image.js.map

package/dist/src/image.js.map

@@ -1 +1 @@
-{"version":3,"file":"image.js","sourceRoot":"","sources":["../../src/image.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,iBAAiB,CAAC"}
+{"version":3,"file":"image.js","sourceRoot":"","sources":["../../src/image.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,KAAK,KAAK,MAAM,iBAAiB,CAAC"}

package/dist/src/position.d.ts

@@ -1,2 +1,7 @@
+/**
+ * This module provides utility functions for working with fractional indexes in TypeScript.
+ *
+ * @since 0.0.6
+ */
 export { PositionRange, Position } from './core/position.js';
 //# sourceMappingURL=position.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"position.d.ts","sourceRoot":"","sources":["../../src/position.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC"}
+{"version":3,"file":"position.d.ts","sourceRoot":"","sources":["../../src/position.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/src/position.js

@@ -1,2 +1,7 @@
+/**
+ * This module provides utility functions for working with fractional indexes in TypeScript.
+ *
+ * @since 0.0.6
+ */
 export { PositionRange, Position } from './core/position.js';
 //# sourceMappingURL=position.js.map

package/dist/src/position.js.map

@@ -1 +1 @@
-{"version":3,"file":"position.js","sourceRoot":"","sources":["../../src/position.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC"}
+{"version":3,"file":"position.js","sourceRoot":"","sources":["../../src/position.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/src/proto/gen/src/proto/ipfs_pb.d.ts

@@ -1,5 +1,5 @@
-import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage } from "@bufbuild/protobuf";
-import { Message, proto3 } from "@bufbuild/protobuf";
+import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage } from '@bufbuild/protobuf';
+import { Message, proto3 } from '@bufbuild/protobuf';
 /**
  * @generated from enum OpType
  */