@geoprotocol/geo-sdk 0.1.1

package/dist/src/idv2.d.ts

@@ -0,0 +1,27 @@
+import { Brand } from 'effect';
+export type Id = string & Brand.Brand<'Id'>;
+export type IdBase64 = string & Brand.Brand<'IdBase64'>;
+export declare const Id: Brand.Brand.Constructor<Id>;
+export declare const IdBase64: Brand.Brand.Constructor<IdBase64>;
+/**
+ * Generates a globally unique knowledge graph identifier.
+ *
+ * @example
+ * ```
+ * import { ID } from '@graphprotocol/grc-20'
+ *
+ * const id = ID.generate();
+ * console.log(id)
+ * ```
+ *
+ * @returns v4 UUID
+ */
+export declare function generate(): Id;
+export declare function isValid(id: string): boolean;
+export declare function isValidBase64(id: string): boolean;
+export declare function assertValid(id: string, sourceHint?: string): void;
+export declare function toBytes(id: Id): Uint8Array;
+export declare function fromBytes(bytes: Uint8Array): Id;
+export declare function toBase64(id: Id): IdBase64;
+export declare function fromBase64(id: IdBase64): Id;
+//# sourceMappingURL=idv2.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"idv2.d.ts","sourceRoot":"","sources":["../../src/idv2.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAS/B,MAAM,MAAM,EAAE,GAAG,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AAE5C,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;AAExD,eAAO,MAAM,EAAE,6BAGd,CAAC;AAEF,eAAO,MAAM,QAAQ,mCAGpB,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,wBAAgB,QAAQ,IAAI,EAAE,CAG7B;AAED,wBAAgB,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAE3C;AAED,wBAAgB,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAQjD;AAED,wBAAgB,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,QAI1D;AAED,wBAAgB,OAAO,CAAC,EAAE,EAAE,EAAE,GAAG,UAAU,CAE1C;AAED,wBAAgB,SAAS,CAAC,KAAK,EAAE,UAAU,GAAG,EAAE,CAE/C;AAID,wBAAgB,QAAQ,CAAC,EAAE,EAAE,EAAE,GAAG,QAAQ,CAoBzC;AAED,wBAAgB,UAAU,CAAC,EAAE,EAAE,QAAQ,GAAG,EAAE,CAqB3C"}

package/dist/src/idv2.js

@@ -0,0 +1,88 @@
+import { Brand } from 'effect';
+/**
+ * This module provides utility functions for working knowledge graph
+ * identifiers in TypeScript.
+ */
+import { parse as uuidParse, stringify as uuidStringify, validate as uuidValidate, v4 as uuidv4 } from 'uuid';
+export const Id = Brand.refined(id => isValid(id), id => Brand.error(`Expected ${id} to be a valid Id`));
+export const IdBase64 = Brand.refined(id => isValidBase64(id), id => Brand.error(`Expected ${id} to be a valid IdBase64`));
+/**
+ * Generates a globally unique knowledge graph identifier.
+ *
+ * @example
+ * ```
+ * import { ID } from '@graphprotocol/grc-20'
+ *
+ * const id = ID.generate();
+ * console.log(id)
+ * ```
+ *
+ * @returns v4 UUID
+ */
+export function generate() {
+    const uuid = uuidv4();
+    return Id(uuid);
+}
+export function isValid(id) {
+    return uuidValidate(id);
+}
+export function isValidBase64(id) {
+    try {
+        // @ts-expect-error
+        const uuid = fromBase64(id);
+        return isValid(uuid);
+    }
+    catch (error) {
+        return false;
+    }
+}
+export function assertValid(id, sourceHint) {
+    if (!isValid(id)) {
+        throw new Error(`Invalid id: "${id}"${sourceHint ? ` for ${sourceHint}` : ''}`);
+    }
+}
+export function toBytes(id) {
+    return uuidParse(id);
+}
+export function fromBytes(bytes) {
+    return Id(uuidStringify(bytes));
+}
+const base64Chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/';
+export function toBase64(id) {
+    const bytes = toBytes(id);
+    let result = '';
+    let i;
+    for (i = 0; i < bytes.length; i += 3) {
+        const a = bytes[i];
+        const b = bytes[i + 1] ?? 0;
+        const c = bytes[i + 2] ?? 0;
+        // @ts-expect-error
+        const triple = (a << 16) | (b << 8) | c;
+        result += base64Chars[(triple >> 18) & 0x3f];
+        result += base64Chars[(triple >> 12) & 0x3f];
+        result += i + 1 < bytes.length ? base64Chars[(triple >> 6) & 0x3f] : '=';
+        result += i + 2 < bytes.length ? base64Chars[triple & 0x3f] : '=';
+    }
+    return IdBase64(result);
+}
+export function fromBase64(id) {
+    const bytes = [];
+    for (let i = 0; i < id.length; i += 4) {
+        // @ts-expect-error
+        const c1 = base64Chars.indexOf(id[i]);
+        // @ts-expect-error
+        const c2 = base64Chars.indexOf(id[i + 1]);
+        // @ts-expect-error
+        const c3 = base64Chars.indexOf(id[i + 2]);
+        // @ts-expect-error
+        const c4 = base64Chars.indexOf(id[i + 3]);
+        const triple = (c1 << 18) | (c2 << 12) | ((c3 & 63) << 6) | (c4 & 63);
+        bytes.push((triple >> 16) & 0xff);
+        if (c3 !== -1 && c3 !== 64)
+            bytes.push((triple >> 8) & 0xff);
+        if (c4 !== -1 && c4 !== 64)
+            bytes.push(triple & 0xff);
+    }
+    return fromBytes(new Uint8Array(bytes));
+}
+//# sourceMappingURL=idv2.js.map

package/dist/src/idv2.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"idv2.js","sourceRoot":"","sources":["../../src/idv2.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAE/B;;;GAGG;AAEH,OAAO,EAAE,KAAK,IAAI,SAAS,EAAE,SAAS,IAAI,aAAa,EAAE,QAAQ,IAAI,YAAY,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AAM9G,MAAM,CAAC,MAAM,EAAE,GAAG,KAAK,CAAC,OAAO,CAC7B,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,EACjB,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,YAAY,EAAE,mBAAmB,CAAC,CACrD,CAAC;AAEF,MAAM,CAAC,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CACnC,EAAE,CAAC,EAAE,CAAC,aAAa,CAAC,EAAE,CAAC,EACvB,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,YAAY,EAAE,yBAAyB,CAAC,CAC3D,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,QAAQ;IACtB,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC;IACtB,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC;AAClB,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,EAAU;IAChC,OAAO,YAAY,CAAC,EAAE,CAAC,CAAC;AAC1B,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,EAAU;IACtC,IAAI,CAAC;QACH,mBAAmB;QACnB,MAAM,IAAI,GAAG,UAAU,CAAC,EAAE,CAAC,CAAC;QAC5B,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC;IACvB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,EAAU,EAAE,UAAmB;IACzD,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,gBAAgB,EAAE,IAAI,UAAU,CAAC,CAAC,CAAC,QAAQ,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAClF,CAAC;AACH,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,EAAM;IAC5B,OAAO,SAAS,CAAC,EAAE,CAAC,CAAC;AACvB,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,KAAiB;IACzC,OAAO,EAAE,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;AAClC,CAAC;AAED,MAAM,WAAW,GAAG,kEAAkE,CAAC;AAEvF,MAAM,UAAU,QAAQ,CAAC,EAAM;IAC7B,MAAM,KAAK,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC;IAC1B,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,IAAI,CAAS,CAAC;IAEd,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QACrC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACnB,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;QAC5B,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;QAE5B,mBAAmB;QACnB,MAAM,MAAM,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QAExC,MAAM,IAAI,WAAW,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;QAC7C,MAAM,IAAI,WAAW,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;QAC7C,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QACzE,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;IACpE,CAAC;IAED,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC1B,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,EAAY;IACrC,MAAM,KAAK,GAAG,EAAE,CAAC;IAEjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QACtC,mBAAmB;QACnB,MAAM,EAAE,GAAG,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QACtC,mBAAmB;QACnB,MAAM,EAAE,GAAG,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC1C,mBAAmB;QACnB,MAAM,EAAE,GAAG,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC1C,mBAAmB;QACnB,MAAM,EAAE,GAAG,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAE1C,MAAM,MAAM,GAAG,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;QAEtE,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;QAClC,IAAI,EAAE,KAAK,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE;YAAE,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;QAC7D,IAAI,EAAE,KAAK,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE;YAAE,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IACxD,CAAC;IAED,OAAO,SAAS,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;AAC1C,CAAC"}

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

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

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

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

package/dist/src/idv2.test.js

@@ -0,0 +1,26 @@
+import { expect, it } from 'vitest';
+import { Id, generate, isValid, toBase64 } from './idv2.js';
+it('should generate valid uuid', () => {
+    const id = generate();
+    expect(id).toBeTypeOf('string');
+    expect(id.length).toBe(36);
+    expect(id).toMatch(/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/);
+});
+it('should validate uuid', () => {
+    expect(isValid(generate())).toBe(true);
+    expect(isValid(generate())).toBe(true);
+    expect(isValid(generate())).toBe(true);
+    expect(isValid('3af3e22d-2169-4a07-8681-516710b7ecf1')).toBe(true);
+});
+it('should not validate invalid id', () => {
+    expect(isValid('invalid-id')).toBe(false);
+    expect(isValid('0123456789012345678901')).toBe(false);
+});
+it('should convert id to base64', () => {
+    const id = Id('3af3e22d-2169-4a07-8681-516710b7ecf1');
+    const base64 = toBase64(id);
+    expect(base64).toBeTypeOf('string');
+    expect(base64).toBe('OvPiLSFpSgeGgVFnELfs8Q==');
+    expect(toBase64(Id('1d501a3a-d6ce-4693-bc90-d25286f21c7e'))).toBe('HVAaOtbORpO8kNJShvIcfg==');
+});
+//# sourceMappingURL=idv2.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"idv2.test.js","sourceRoot":"","sources":["../../src/idv2.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAEpC,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAE5D,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;IACpC,MAAM,EAAE,GAAG,QAAQ,EAAE,CAAC;IACtB,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,CAAC,OAAO,CAAC,+EAA+E,CAAC,CAAC;AACtG,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;IAC9B,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvC,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvC,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvC,MAAM,CAAC,OAAO,CAAC,sCAAsC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACrE,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;IACxC,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC1C,MAAM,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACxD,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;IACrC,MAAM,EAAE,GAAG,EAAE,CAAC,sCAAsC,CAAC,CAAC;IACtD,MAAM,MAAM,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC5B,MAAM,CAAC,MAAM,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACpC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;IAChD,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,sCAAsC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;AAChG,CAAC,CAAC,CAAC"}

package/dist/src/image.d.ts

@@ -0,0 +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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +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

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

package/dist/src/internal/uuid.d.ts

@@ -0,0 +1,11 @@
+/**
+ * If `id` looks like a UUID without dashes (32 hex chars), convert it to the
+ * dashed UUID format. Otherwise returns `null`.
+ */
+export declare function dashlessUuidToDashed(id: string): string | null;
+/**
+ * `uuid.parse` accepts the dashed UUID format, so normalize canonical (dashless)
+ * UUIDs into the dashed representation, leaving other inputs unchanged.
+ */
+export declare function normalizeUuidForParse(id: string): string;
+//# sourceMappingURL=uuid.d.ts.map

package/dist/src/internal/uuid.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uuid.d.ts","sourceRoot":"","sources":["../../../src/internal/uuid.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAG9D;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAExD"}

package/dist/src/internal/uuid.js

@@ -0,0 +1,18 @@
+const UUID_DASHLESS_REGEX = /^[0-9a-fA-F]{32}$/;
+/**
+ * If `id` looks like a UUID without dashes (32 hex chars), convert it to the
+ * dashed UUID format. Otherwise returns `null`.
+ */
+export function dashlessUuidToDashed(id) {
+    if (!UUID_DASHLESS_REGEX.test(id))
+        return null;
+    return `${id.slice(0, 8)}-${id.slice(8, 12)}-${id.slice(12, 16)}-${id.slice(16, 20)}-${id.slice(20)}`;
+}
+/**
+ * `uuid.parse` accepts the dashed UUID format, so normalize canonical (dashless)
+ * UUIDs into the dashed representation, leaving other inputs unchanged.
+ */
+export function normalizeUuidForParse(id) {
+    return dashlessUuidToDashed(id) ?? id;
+}
+//# sourceMappingURL=uuid.js.map

package/dist/src/internal/uuid.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uuid.js","sourceRoot":"","sources":["../../../src/internal/uuid.ts"],"names":[],"mappings":"AAAA,MAAM,mBAAmB,GAAG,mBAAmB,CAAC;AAEhD;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAAC,EAAU;IAC7C,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;QAAE,OAAO,IAAI,CAAC;IAC/C,OAAO,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC;AACxG,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,qBAAqB,CAAC,EAAU;IAC9C,OAAO,oBAAoB,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC;AACxC,CAAC"}

package/dist/src/ipfs.d.ts

@@ -0,0 +1,98 @@
+/**
+ * This module provides utility functions for interacting with the default
+ * IPFS gateway in TypeScript.
+ *
+ * @since 0.1.1
+ */
+import { type Op } from '@geoprotocol/grc-20';
+import type { Id } from './id.js';
+import type { Network } from './types.js';
+type PublishEditProposalParams = {
+    name: string;
+    ops: Op[];
+    author: `0x${string}`;
+    network?: Network;
+};
+type PublishEditResult = {
+    cid: string;
+    editId: Id;
+};
+/**
+ * Generates correct GRC-20 v2 binary encoding for an Edit and uploads it to IPFS.
+ *
+ * @example
+ * ```ts
+ * import { IPFS } from '@geoprotocol/geo-sdk';
+ *
+ * const { cid, editId } = await IPFS.publishEdit({
+ *   name: 'Edit name',
+ *   ops: ops,
+ *   author: '0x000000000000000000000000000000000000',
+ * });
+ * ```
+ *
+ * @param args arguments for publishing an edit to IPFS {@link PublishEditProposalParams}
+ * @returns - {@link PublishEditResult}
+ */
+export declare function publishEdit(args: PublishEditProposalParams): Promise<PublishEditResult>;
+type PublishImageParams = {
+    blob: Blob;
+} | {
+    url: string;
+};
+export declare function uploadImage(params: PublishImageParams, network?: Network, alternativeGateway?: boolean): Promise<{
+    cid: `ipfs://${string}`;
+    dimensions: {
+        width: number;
+        height: number;
+    };
+} | {
+    cid: `ipfs://${string}`;
+    dimensions?: undefined;
+}>;
+/**
+ * Uploads a CSV file to IPFS and returns the CID. This CSV
+ * file will be compressed using gzip before being uploaded.
+ *
+ * @example
+ * ```ts
+ * const file = Bun.file('cities.csv');
+ * const fileText = await file.text();
+ *
+ * const cid = await Ipfs.uploadCSV(fileText);
+ * ```
+ *
+ * @example
+ * ```ts
+ * import { Csv } from '@geoprotocol/geo-sdk';
+ *
+ * const csvString = Csv.stringify({
+ *   data: Array.from({ length: 151_000 }, (_, i: number) => [i.toString(), (i * 2).toString(), (i * 3).toString()]),
+ *   metadata: {
+ *     filetype: 'CSV',
+ *     columns: [
+ *       {
+ *         id: 'foo',
+ *         type: 'TEXT',
+ *       },
+ *       {
+ *         id: 'bar',
+ *         type: 'NUMBER',
+ *       },
+ *       {
+ *         id: 'baz',
+ *         type: 'TEXT',
+ *       },
+ *     ],
+ *   },
+ * })
+ *
+ * const cid = await Ipfs.uploadCSV(csvString);
+ * ```
+ *
+ * @param csvString The CSV to upload as a string
+ * @returns IPFS CID representing the uploaded file prefixed with `ipfs://`
+ */
+export declare function uploadCSV(csvString: string, network?: Network): Promise<`ipfs://${string}`>;
+export {};
+//# sourceMappingURL=ipfs.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ipfs.d.ts","sourceRoot":"","sources":["../../src/ipfs.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAKL,KAAK,EAAE,EAER,MAAM,qBAAqB,CAAC;AAO7B,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAc1C,KAAK,yBAAyB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,EAAE,EAAE,CAAC;IACV,MAAM,EAAE,KAAK,MAAM,EAAE,CAAC;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,KAAK,iBAAiB,GAAG;IAEvB,GAAG,EAAE,MAAM,CAAC;IAEZ,MAAM,EAAE,EAAE,CAAC;CACZ,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,WAAW,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CA8B7F;AAED,KAAK,kBAAkB,GACnB;IACE,IAAI,EAAE,IAAI,CAAC;CACZ,GACD;IACE,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEN,wBAAsB,WAAW,CAAC,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,kBAAkB,CAAC,EAAE,OAAO;;;;;;;;;GAkC5G;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,wBAAsB,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,MAAM,EAAE,CAAC,CAUjG"}

package/dist/src/ipfs.js

@@ -0,0 +1,192 @@
+/**
+ * This module provides utility functions for interacting with the default
+ * IPFS gateway in TypeScript.
+ *
+ * @since 0.1.1
+ */
+import { derivedUuidFromString, encodeEdit, randomId, } from '@geoprotocol/grc-20';
+import { Micro } from 'effect';
+import { gzipSync } from 'fflate';
+import { imageSize } from 'image-size';
+import { getApiOrigin } from './graph/constants.js';
+import { fromBytes } from './id-utils.js';
+class IpfsUploadError extends Error {
+    _tag = 'IpfsUploadError';
+}
+/**
+ * Converts a hex string (like an ethereum address) to a GRC-20 Id.
+ * Uses derived UUID since ethereum addresses (20 bytes) don't fit directly into UUIDs (16 bytes).
+ */
+function hexToGrcId(hex) {
+    return derivedUuidFromString(hex);
+}
+/**
+ * Generates correct GRC-20 v2 binary encoding for an Edit and uploads it to IPFS.
+ *
+ * @example
+ * ```ts
+ * import { IPFS } from '@geoprotocol/geo-sdk';
+ *
+ * const { cid, editId } = await IPFS.publishEdit({
+ *   name: 'Edit name',
+ *   ops: ops,
+ *   author: '0x000000000000000000000000000000000000',
+ * });
+ * ```
+ *
+ * @param args arguments for publishing an edit to IPFS {@link PublishEditProposalParams}
+ * @returns - {@link PublishEditResult}
+ */
+export async function publishEdit(args) {
+    const { name, ops, author, network = 'TESTNET' } = args;
+    // Generate a new edit ID
+    const editId = randomId();
+    // Build the GRC-20 v2 Edit structure
+    const grcEdit = {
+        id: editId,
+        name,
+        authors: [hexToGrcId(author)],
+        createdAt: BigInt(Date.now()) * 1000n, // Convert to microseconds
+        ops,
+    };
+    // Encode to binary format
+    const binary = encodeEdit(grcEdit);
+    // Create a copy to ensure we have a regular ArrayBuffer for Blob compatibility
+    const binaryArray = new Uint8Array(binary);
+    const blob = new Blob([binaryArray], { type: 'application/octet-stream' });
+    const formData = new FormData();
+    formData.append('file', blob);
+    const cid = await Micro.runPromise(uploadBinary(formData, network));
+    // Convert the GrcId back to a grc-20-ts Id string
+    const editIdString = fromBytes(editId);
+    return { cid, editId: editIdString };
+}
+export async function uploadImage(params, network, alternativeGateway) {
+    const formData = new FormData();
+    let blob;
+    if ('blob' in params) {
+        blob = params.blob;
+    }
+    else {
+        // fetch the image and upload it to IPFS
+        const response = await fetch(params.url);
+        blob = await response.blob();
+    }
+    formData.append('file', blob);
+    const buffer = new Uint8Array(await blob.arrayBuffer());
+    let dimensions;
+    try {
+        dimensions = imageSize(buffer);
+    }
+    catch (_error) { }
+    const cid = await Micro.runPromise(uploadFile(formData, network, alternativeGateway));
+    if (dimensions) {
+        return {
+            cid,
+            dimensions: {
+                width: dimensions.width,
+                height: dimensions.height,
+            },
+        };
+    }
+    return {
+        cid,
+    };
+}
+/**
+ * Uploads a CSV file to IPFS and returns the CID. This CSV
+ * file will be compressed using gzip before being uploaded.
+ *
+ * @example
+ * ```ts
+ * const file = Bun.file('cities.csv');
+ * const fileText = await file.text();
+ *
+ * const cid = await Ipfs.uploadCSV(fileText);
+ * ```
+ *
+ * @example
+ * ```ts
+ * import { Csv } from '@geoprotocol/geo-sdk';
+ *
+ * const csvString = Csv.stringify({
+ *   data: Array.from({ length: 151_000 }, (_, i: number) => [i.toString(), (i * 2).toString(), (i * 3).toString()]),
+ *   metadata: {
+ *     filetype: 'CSV',
+ *     columns: [
+ *       {
+ *         id: 'foo',
+ *         type: 'TEXT',
+ *       },
+ *       {
+ *         id: 'bar',
+ *         type: 'NUMBER',
+ *       },
+ *       {
+ *         id: 'baz',
+ *         type: 'TEXT',
+ *       },
+ *     ],
+ *   },
+ * })
+ *
+ * const cid = await Ipfs.uploadCSV(csvString);
+ * ```
+ *
+ * @param csvString The CSV to upload as a string
+ * @returns IPFS CID representing the uploaded file prefixed with `ipfs://`
+ */
+export async function uploadCSV(csvString, network) {
+    const encoder = new TextEncoder();
+    const csvStringBytes = encoder.encode(csvString);
+    const blob = await gzipSync(csvStringBytes);
+    const formData = new FormData();
+    // @ts-expect-error - this is a type missmatch which is fine
+    formData.append('file', new Blob([blob], { type: 'text/csv' }));
+    return await Micro.runPromise(uploadBinary(formData, network));
+}
+function uploadBinary(formData, network = 'TESTNET') {
+    return Micro.gen(function* () {
+        const result = yield* Micro.tryPromise({
+            try: () => fetch(`${getApiOrigin(network)}/ipfs/upload-edit`, {
+                method: 'POST',
+                body: formData,
+            }),
+            catch: error => new IpfsUploadError(`Could not upload data to IPFS: ${error}`),
+        });
+        const maybeCid = yield* Micro.tryPromise({
+            try: async () => {
+                const { cid } = await result.json();
+                return cid;
+            },
+            catch: error => new IpfsUploadError(`Could not parse response from IPFS: ${error}`),
+        });
+        return maybeCid;
+    });
+}
+function uploadFile(formData, network = 'TESTNET', alternativeGateway) {
+    return Micro.gen(function* () {
+        let apiUrl = `${getApiOrigin(network)}/ipfs/upload-file`;
+        if (alternativeGateway) {
+            apiUrl = `${getApiOrigin('TESTNET')}/ipfs/upload-file-alternative-gateway`;
+        }
+        const result = yield* Micro.tryPromise({
+            try: () => fetch(apiUrl, {
+                method: 'POST',
+                body: formData,
+            }),
+            catch: error => {
+                return new IpfsUploadError(`Could not upload file to IPFS: ${error}`);
+            },
+        });
+        const maybeCid = yield* Micro.tryPromise({
+            try: async () => {
+                const { cid } = await result.json();
+                return cid;
+            },
+            catch: error => new IpfsUploadError(`Could not parse response from IPFS: ${error}`),
+        });
+        return maybeCid;
+    });
+}
+//# sourceMappingURL=ipfs.js.map

package/dist/src/ipfs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ipfs.js","sourceRoot":"","sources":["../../src/ipfs.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EACL,qBAAqB,EACrB,UAAU,EAIV,QAAQ,GACT,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAC/B,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAClC,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAI1C,MAAM,eAAgB,SAAQ,KAAK;IACxB,IAAI,GAAG,iBAAiB,CAAC;CACnC;AAED;;;GAGG;AACH,SAAS,UAAU,CAAC,GAAkB;IACpC,OAAO,qBAAqB,CAAC,GAAG,CAAC,CAAC;AACpC,CAAC;AAgBD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,IAA+B;IAC/D,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,GAAG,SAAS,EAAE,GAAG,IAAI,CAAC;IAExD,yBAAyB;IACzB,MAAM,MAAM,GAAG,QAAQ,EAAE,CAAC;IAE1B,qCAAqC;IACrC,MAAM,OAAO,GAAY;QACvB,EAAE,EAAE,MAAM;QACV,IAAI;QACJ,OAAO,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAC7B,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,GAAG,KAAK,EAAE,0BAA0B;QACjE,GAAG;KACJ,CAAC;IAEF,0BAA0B;IAC1B,MAAM,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAEnC,+EAA+E;IAC/E,MAAM,WAAW,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;IAC3C,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,CAAC,WAAW,CAAC,EAAE,EAAE,IAAI,EAAE,0BAA0B,EAAE,CAAC,CAAC;IAC3E,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;IAChC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAE9B,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;IAEpE,kDAAkD;IAClD,MAAM,YAAY,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;IAEvC,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC;AACvC,CAAC;AAUD,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,MAA0B,EAAE,OAAiB,EAAE,kBAA4B;IAC3G,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;IAChC,IAAI,IAAU,CAAC;IACf,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC;QACrB,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;IACrB,CAAC;SAAM,CAAC;QACN,wCAAwC;QACxC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACzC,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IAC/B,CAAC;IAED,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAE9B,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IACxD,IAAI,UAAyD,CAAC;IAC9D,IAAI,CAAC;QACH,UAAU,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAAC,OAAO,MAAM,EAAE,CAAC,CAAA,CAAC;IAEnB,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,QAAQ,EAAE,OAAO,EAAE,kBAAkB,CAAC,CAAC,CAAC;IAEtF,IAAI,UAAU,EAAE,CAAC;QACf,OAAO;YACL,GAAG;YACH,UAAU,EAAE;gBACV,KAAK,EAAE,UAAU,CAAC,KAAK;gBACvB,MAAM,EAAE,UAAU,CAAC,MAAM;aAC1B;SACF,CAAC;IACJ,CAAC;IAED,OAAO;QACL,GAAG;KACJ,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,SAAiB,EAAE,OAAiB;IAClE,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;IAClC,MAAM,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACjD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,cAAc,CAAC,CAAC;IAE5C,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;IAChC,4DAA4D;IAC5D,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;IAEhE,OAAO,MAAM,KAAK,CAAC,UAAU,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;AACjE,CAAC;AAED,SAAS,YAAY,CAAC,QAAkB,EAAE,UAAmB,SAAS;IACpE,OAAO,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC;QACxB,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC;YACrC,GAAG,EAAE,GAAG,EAAE,CACR,KAAK,CAAC,GAAG,YAAY,CAAC,OAAO,CAAC,mBAAmB,EAAE;gBACjD,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,QAAQ;aACf,CAAC;YACJ,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,IAAI,eAAe,CAAC,kCAAkC,KAAK,EAAE,CAAC;SAC/E,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC;YACvC,GAAG,EAAE,KAAK,IAAI,EAAE;gBACd,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;gBACpC,OAAO,GAAG,CAAC;YACb,CAAC;YACD,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,IAAI,eAAe,CAAC,uCAAuC,KAAK,EAAE,CAAC;SACpF,CAAC,CAAC;QAEH,OAAO,QAA8B,CAAC;IACxC,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,UAAU,CAAC,QAAkB,EAAE,UAAmB,SAAS,EAAE,kBAA4B;IAChG,OAAO,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC;QACxB,IAAI,MAAM,GAAG,GAAG,YAAY,CAAC,OAAO,CAAC,mBAAmB,CAAC;QACzD,IAAI,kBAAkB,EAAE,CAAC;YACvB,MAAM,GAAG,GAAG,YAAY,CAAC,SAAS,CAAC,uCAAuC,CAAC;QAC7E,CAAC;QAED,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC;YACrC,GAAG,EAAE,GAAG,EAAE,CACR,KAAK,CAAC,MAAM,EAAE;gBACZ,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,QAAQ;aACf,CAAC;YACJ,KAAK,EAAE,KAAK,CAAC,EAAE;gBACb,OAAO,IAAI,eAAe,CAAC,kCAAkC,KAAK,EAAE,CAAC,CAAC;YACxE,CAAC;SACF,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC;YACvC,GAAG,EAAE,KAAK,IAAI,EAAE;gBACd,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;gBACpC,OAAO,GAAG,CAAC;YACb,CAAC;YACD,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,IAAI,eAAe,CAAC,uCAAuC,KAAK,EAAE,CAAC;SACpF,CAAC,CAAC;QAEH,OAAO,QAA8B,CAAC;IACxC,CAAC,CAAC,CAAC;AACL,CAAC"}

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

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

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

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