@geoprotocol/geo-sdk 0.1.1

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

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

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

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

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

@@ -0,0 +1,26 @@
+/**
+ * This module provides utility functions for working with fractional indexes in TypeScript.
+ *
+ * @since 0.0.6
+ */
+export declare function generateBetween(first: string | null, second: string | null): string;
+/**
+ * Generates a random position with jittering.
+ *
+ * @returns A random position as a string.
+ */
+export declare function generate(): string;
+type MaybePosition = string | null;
+export declare function compare(a: MaybePosition, b: MaybePosition): number;
+/**
+ * Sorts a list of positions in ascending order. In
+ * the knowledge graph positions are optional. This
+ * function sorts null positions so they are always
+ * at the bottom.
+ *
+ * @param positions - The list of positions to sort.
+ * @returns The sorted list of positions.
+ */
+export declare function sort(positions: MaybePosition[]): MaybePosition[];
+export {};
+//# sourceMappingURL=position.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"position.d.ts","sourceRoot":"","sources":["../../../src/core/position.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,UAE1E;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,IAAI,MAAM,CAEjC;AAED,KAAK,aAAa,GAAG,MAAM,GAAG,IAAI,CAAC;AAEnC,wBAAgB,OAAO,CAAC,CAAC,EAAE,aAAa,EAAE,CAAC,EAAE,aAAa,UAOzD;AAED;;;;;;;;GAQG;AACH,wBAAgB,IAAI,CAAC,SAAS,EAAE,aAAa,EAAE,GAAG,aAAa,EAAE,CAEhE"}

package/dist/src/core/position.js

@@ -0,0 +1,41 @@
+/**
+ * This module provides utility functions for working with fractional indexes in TypeScript.
+ *
+ * @since 0.0.6
+ */
+import { generateJitteredKeyBetween } from 'fractional-indexing-jittered';
+export function generateBetween(first, second) {
+    return generateJitteredKeyBetween(first, second);
+}
+/**
+ * Generates a random position with jittering.
+ *
+ * @returns A random position as a string.
+ */
+export function generate() {
+    return generateBetween(null, null);
+}
+export function compare(a, b) {
+    // This ALWAYS puts nulls at the bottom, regardless of what
+    // fractional indexes exist
+    if (a === null && b === null)
+        return 0;
+    if (a === null)
+        return 1; // a goes to bottom
+    if (b === null)
+        return -1; // b goes to bottom
+    return a.localeCompare(b);
+}
+/**
+ * Sorts a list of positions in ascending order. In
+ * the knowledge graph positions are optional. This
+ * function sorts null positions so they are always
+ * at the bottom.
+ *
+ * @param positions - The list of positions to sort.
+ * @returns The sorted list of positions.
+ */
+export function sort(positions) {
+    return positions.sort(compare);
+}
+//# sourceMappingURL=position.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"position.js","sourceRoot":"","sources":["../../../src/core/position.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAE1E,MAAM,UAAU,eAAe,CAAC,KAAoB,EAAE,MAAqB;IACzE,OAAO,0BAA0B,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;AACnD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,QAAQ;IACtB,OAAO,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AACrC,CAAC;AAID,MAAM,UAAU,OAAO,CAAC,CAAgB,EAAE,CAAgB;IACxD,2DAA2D;IAC3D,2BAA2B;IAC3B,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,IAAI;QAAE,OAAO,CAAC,CAAC;IACvC,IAAI,CAAC,KAAK,IAAI;QAAE,OAAO,CAAC,CAAC,CAAC,mBAAmB;IAC7C,IAAI,CAAC,KAAK,IAAI;QAAE,OAAO,CAAC,CAAC,CAAC,CAAC,mBAAmB;IAC9C,OAAO,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;AAC5B,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,IAAI,CAAC,SAA0B;IAC7C,OAAO,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AACjC,CAAC"}

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

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

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

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

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

@@ -0,0 +1,126 @@
+import { describe, expect, it } from 'vitest';
+import { generate, sort } from './position.js'; // Adjust import path as needed
+describe('fractional index default generation', () => {
+    it('should generate a random position', () => {
+        const a = generate();
+        const b = generate();
+        expect(a).not.toEqual(b);
+    });
+});
+describe('fractional index sorting', () => {
+    describe('sort function', () => {
+        it('should handle empty array', () => {
+            const result = sort([]);
+            expect(result).toEqual([]);
+        });
+        it('should handle array with only nulls', () => {
+            const positions = [null, null, null];
+            const result = sort(positions);
+            expect(result).toEqual([null, null, null]);
+        });
+        it('should handle array with only strings', () => {
+            const positions = ['c', 'a', 'b'];
+            const result = sort(positions);
+            expect(result).toEqual(['a', 'b', 'c']);
+        });
+        it('should put null values at the bottom when mixed with strings', () => {
+            const positions = ['b', null, 'a', null, 'c'];
+            const result = sort(positions);
+            expect(result).toEqual(['a', 'b', 'c', null, null]);
+        });
+        it('should sort fractional indexes correctly', () => {
+            const positions = ['a1', 'a0', 'a2'];
+            const result = sort(positions);
+            expect(result).toEqual(['a0', 'a1', 'a2']);
+        });
+        it('should handle complex fractional indexes', () => {
+            const positions = ['a0V', 'a0', 'a0G', 'a1'];
+            const result = sort(positions);
+            expect(result).toEqual(['a0', 'a0G', 'a0V', 'a1']);
+        });
+        it('should maintain stable sort for identical values', () => {
+            const positions = ['a0', 'a0', 'a1'];
+            const result = sort(positions);
+            expect(result).toEqual(['a0', 'a0', 'a1']);
+        });
+        it('should handle single null value', () => {
+            const positions = [null];
+            const result = sort(positions);
+            expect(result).toEqual([null]);
+        });
+        it('should handle single string value', () => {
+            const positions = ['a0'];
+            const result = sort(positions);
+            expect(result).toEqual(['a0']);
+        });
+        it('should sort with nulls at bottom regardless of position in input', () => {
+            const positions1 = [null, 'a', 'b'];
+            const positions2 = ['a', null, 'b'];
+            const positions3 = ['a', 'b', null];
+            const expected = ['a', 'b', null];
+            expect(sort(positions1)).toEqual(expected);
+            expect(sort(positions2)).toEqual(expected);
+            expect(sort(positions3)).toEqual(expected);
+        });
+        it('should handle very long fractional indexes', () => {
+            const positions = [`a0${'x'.repeat(50)}`, 'a0', `a0${'y'.repeat(30)}`];
+            const result = sort(positions);
+            expect(result).toEqual(['a0', `a0${'x'.repeat(50)}`, `a0${'y'.repeat(30)}`]);
+        });
+        it('should handle mixed case and special characters', () => {
+            const positions = ['Z', 'a', 'A', 'z'];
+            const result = sort(positions);
+            // JavaScript's localeCompare should handle this correctly
+            expect(result).toEqual(['a', 'A', 'z', 'Z']);
+        });
+        it('should handle large arrays efficiently', () => {
+            const positions = [];
+            // Create a large array with mixed values
+            for (let i = 100; i >= 0; i--) {
+                positions.push(`a${i}`);
+                if (i % 10 === 0)
+                    positions.push(null);
+            }
+            const result = sort(positions);
+            // Check that all string values are sorted before nulls
+            const stringValues = result.filter(p => p !== null);
+            const nullValues = result.filter(p => p === null);
+            // String values should be sorted
+            for (let i = 1; i < stringValues.length; i++) {
+                const left = stringValues[i - 1];
+                const right = stringValues[i];
+                if (left && right) {
+                    expect(left.localeCompare(right)).toBeLessThanOrEqual(0);
+                }
+            }
+            // All nulls should be at the end
+            const firstNullIndex = result.indexOf(null);
+            if (firstNullIndex !== -1) {
+                expect(result.slice(firstNullIndex)).toEqual(nullValues);
+            }
+        });
+        it('should handle edge case fractional indexes that might cause sorting issues', () => {
+            const positions = [
+                'z'.repeat(10), // Very "high" value
+                'a0',
+                null,
+                '', // Empty string
+                'a',
+            ];
+            const result = sort(positions);
+            // Empty string should come first, then sorted strings, then nulls
+            expect(result[0]).toBe('');
+            expect(result[result.length - 1]).toBe(null);
+            // Check that non-null, non-empty strings are sorted
+            const nonEmptyStrings = result.filter(p => p !== null && p !== '');
+            for (let i = 1; i < nonEmptyStrings.length; i++) {
+                const left = nonEmptyStrings[i - 1];
+                const right = nonEmptyStrings[i];
+                if (left && right) {
+                    expect(left.localeCompare(right)).toBeLessThanOrEqual(0);
+                }
+            }
+        });
+    });
+});
+//# sourceMappingURL=position.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"position.test.js","sourceRoot":"","sources":["../../../src/core/position.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC,CAAC,+BAA+B;AAE/E,QAAQ,CAAC,qCAAqC,EAAE,GAAG,EAAE;IACnD,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC3C,MAAM,CAAC,GAAG,QAAQ,EAAE,CAAC;QACrB,MAAM,CAAC,GAAG,QAAQ,EAAE,CAAC;QACrB,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3B,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;IACxC,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAC7B,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;YACnC,MAAM,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC;YACxB,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;YAC7C,MAAM,SAAS,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;YACrC,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;YAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;YAC/C,MAAM,SAAS,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;YAClC,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;YAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8DAA8D,EAAE,GAAG,EAAE;YACtE,MAAM,SAAS,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;YAC9C,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;YAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;YAClD,MAAM,SAAS,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;YACrC,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;YAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;YAClD,MAAM,SAAS,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;YAC7C,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;YAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;QACrD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;YAC1D,MAAM,SAAS,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;YACrC,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;YAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;YACzC,MAAM,SAAS,GAAG,CAAC,IAAI,CAAC,CAAC;YACzB,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;YAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;YAC3C,MAAM,SAAS,GAAG,CAAC,IAAI,CAAC,CAAC;YACzB,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;YAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kEAAkE,EAAE,GAAG,EAAE;YAC1E,MAAM,UAAU,GAAG,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;YACpC,MAAM,UAAU,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;YACpC,MAAM,UAAU,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;YAEpC,MAAM,QAAQ,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;YAElC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAC3C,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAC3C,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;YACpD,MAAM,SAAS,GAAG,CAAC,KAAK,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,KAAK,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;YACvE,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;YAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,KAAK,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAC/E,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;YACzD,MAAM,SAAS,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;YACvC,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;YAC/B,0DAA0D;YAC1D,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;YAChD,MAAM,SAAS,GAAsB,EAAE,CAAC;YAExC,yCAAyC;YACzC,KAAK,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC9B,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACxB,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC;oBAAE,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACzC,CAAC;YAED,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;YAE/B,uDAAuD;YACvD,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,CAAa,CAAC;YAChE,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;YAElD,iCAAiC;YACjC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC7C,MAAM,IAAI,GAAG,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;gBACjC,MAAM,KAAK,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;gBAE9B,IAAI,IAAI,IAAI,KAAK,EAAE,CAAC;oBAClB,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;gBAC3D,CAAC;YACH,CAAC;YAED,iCAAiC;YACjC,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC5C,IAAI,cAAc,KAAK,CAAC,CAAC,EAAE,CAAC;gBAC1B,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAC3D,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4EAA4E,EAAE,GAAG,EAAE;YACpF,MAAM,SAAS,GAAG;gBAChB,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,oBAAoB;gBACpC,IAAI;gBACJ,IAAI;gBACJ,EAAE,EAAE,eAAe;gBACnB,GAAG;aACJ,CAAC;YAEF,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;YAE/B,kEAAkE;YAClE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAC3B,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAE7C,oDAAoD;YACpD,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,EAAE,CAAa,CAAC;YAC/E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,eAAe,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAChD,MAAM,IAAI,GAAG,eAAe,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;gBACpC,MAAM,KAAK,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC;gBAEjC,IAAI,IAAI,IAAI,KAAK,EAAE,CAAC;oBAClB,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;gBAC3D,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

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

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

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

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

package/dist/src/core/relation.js

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,78 @@
+/**
+ * This module provides utility functions for working with Graph URIs in TypeScript.
+ *
+ * @since 0.0.6
+ */
+import type { GraphUri } from '../types.js';
+type SchemeQueryParams = {
+    spaceId?: 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
+ */
+export declare function toSpaceId(uri: GraphUri): string | null;
+export {};
+//# sourceMappingURL=scheme.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"scheme.d.ts","sourceRoot":"","sources":["../../../src/core/scheme.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAE5C,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;;;;;;;;;;;;;GAaG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,QAAQ,GAAG,MAAM,GAAG,IAAI,CAStD"}