@geoprotocol/geo-sdk 0.1.1

package/dist/src/full-flow-test.test.js

@@ -0,0 +1,142 @@
+import { createPublicClient, encodeAbiParameters, encodeFunctionData, http, keccak256, toHex } from 'viem';
+import { privateKeyToAccount } from 'viem/accounts';
+import { it } from 'vitest';
+import { SpaceRegistryAbi } from './abis/index.js';
+import { createEntity } from './graph/create-entity.js';
+import { publishEdit } from './ipfs.js';
+import { getWalletClient } from './smart-wallet.js';
+// Contract addresses for testnet
+// Note: These should be imported from contracts.ts once it's exported
+const SPACE_REGISTRY_ADDRESS = '0xB01683b2f0d38d43fcD4D9aAB980166988924132';
+const EMPTY_SPACE_ID = '0x00000000000000000000000000000000';
+const ZERO_ADDRESS = '0x0000000000000000000000000000000000000000';
+// Action constants
+const EDITS_PUBLISHED = keccak256(toHex('GOVERNANCE.EDITS_PUBLISHED'));
+/**
+ * Converts a bytes16 hex space ID to a UUID string (without dashes).
+ */
+function hexToUuid(hex) {
+    // Remove 0x prefix and trailing zeros (bytes16 is 32 hex chars)
+    return hex.slice(2, 34).toLowerCase();
+}
+it.skip('should create a space and publish an edit', async () => {
+    // IMPORTANT: Replace with your actual private key for testing
+    // You can get your private key using https://www.geobrowser.io/export-wallet
+    const addressPrivateKey = '0xTODO';
+    const { address } = privateKeyToAccount(addressPrivateKey);
+    console.log('address', address);
+    // Get wallet client for testnet
+    const walletClient = await getWalletClient({
+        privateKey: addressPrivateKey,
+    });
+    const account = walletClient.account;
+    if (!account) {
+        throw new Error('Wallet client account is undefined');
+    }
+    // Create a public client for reading contract state
+    const rpcUrl = walletClient.chain?.rpcUrls?.default?.http?.[0];
+    if (!rpcUrl) {
+        throw new Error('Wallet client RPC URL is undefined');
+    }
+    const publicClient = createPublicClient({
+        transport: http(rpcUrl),
+    });
+    // Check if a personal space already exists for this address
+    let spaceIdHex = (await publicClient.readContract({
+        address: SPACE_REGISTRY_ADDRESS,
+        abi: SpaceRegistryAbi,
+        functionName: 'addressToSpaceId',
+        args: [account.address],
+    }));
+    console.log('existing spaceIdHex', spaceIdHex);
+    // Create a personal space if one doesn't exist
+    if (spaceIdHex.toLowerCase() === EMPTY_SPACE_ID.toLowerCase()) {
+        console.log('Creating personal space...');
+        const createSpaceTxHash = await walletClient.sendTransaction({
+            // @ts-expect-error - viem type mismatch for account
+            account: walletClient.account,
+            to: SPACE_REGISTRY_ADDRESS,
+            value: 0n,
+            data: encodeFunctionData({
+                abi: SpaceRegistryAbi,
+                functionName: 'registerSpaceId',
+                args: [
+                    keccak256(toHex('EOA_SPACE')), // _type
+                    encodeAbiParameters([{ type: 'string' }], ['1.0.0']), // _version
+                ],
+            }),
+        });
+        console.log('createSpaceTxHash', createSpaceTxHash);
+        await publicClient.waitForTransactionReceipt({ hash: createSpaceTxHash });
+        // Re-fetch the space ID after creation
+        spaceIdHex = (await publicClient.readContract({
+            address: SPACE_REGISTRY_ADDRESS,
+            abi: SpaceRegistryAbi,
+            functionName: 'addressToSpaceId',
+            args: [account.address],
+        }));
+        console.log('new spaceIdHex', spaceIdHex);
+    }
+    if (spaceIdHex.toLowerCase() === EMPTY_SPACE_ID.toLowerCase()) {
+        throw new Error(`Failed to create personal space for address ${account.address}`);
+    }
+    const spaceId = hexToUuid(spaceIdHex);
+    console.log('spaceId (UUID)', spaceId);
+    // Verify the space address exists
+    const spaceAddress = (await publicClient.readContract({
+        address: SPACE_REGISTRY_ADDRESS,
+        abi: SpaceRegistryAbi,
+        functionName: 'spaceIdToAddress',
+        args: [spaceIdHex],
+    }));
+    if (spaceAddress.toLowerCase() === ZERO_ADDRESS.toLowerCase()) {
+        throw new Error(`Space ${spaceId} not found in registry (spaceIdHex=${spaceIdHex})`);
+    }
+    console.log('spaceAddress', spaceAddress);
+    // Create an entity with some data
+    const { ops, id: entityId } = createEntity({
+        name: 'Test Entity',
+        description: 'Created via full-flow test',
+    });
+    console.log('entityId', entityId);
+    // Publish the edit to IPFS
+    const { cid, editId } = await publishEdit({
+        name: 'Test Edit',
+        ops,
+        author: account.address,
+        network: 'TESTNET',
+    });
+    console.log('cid', cid);
+    console.log('editId', editId);
+    // Publish edit on-chain via SpaceRegistry.enter(...)
+    // SpaceRegistry.enter expects `bytes data`; we ABI-encode the CID as a single string
+    const enterData = encodeAbiParameters([{ type: 'string' }], [cid]);
+    const calldata = encodeFunctionData({
+        abi: SpaceRegistryAbi,
+        functionName: 'enter',
+        args: [
+            spaceIdHex, // fromSpaceId (bytes16)
+            spaceIdHex, // toSpaceId (bytes16)
+            EDITS_PUBLISHED, // action
+            '0x0000000000000000000000000000000000000000000000000000000000000000', // topic
+            enterData, // data
+            '0x',
+        ],
+    });
+    const publishTxHash = await walletClient.sendTransaction({
+        // @ts-expect-error - viem type mismatch for account
+        account: walletClient.account,
+        chain: walletClient.chain ?? null,
+        to: SPACE_REGISTRY_ADDRESS,
+        value: 0n,
+        data: calldata,
+    });
+    console.log('publishTxHash', publishTxHash);
+    const publishReceipt = await publicClient.waitForTransactionReceipt({ hash: publishTxHash });
+    console.log('publishReceipt status', publishReceipt.status);
+    if (publishReceipt.status === 'reverted') {
+        throw new Error(`Publish transaction reverted: ${publishTxHash}`);
+    }
+    console.log('Successfully published edit to space', spaceId);
+}, 60000);
+//# sourceMappingURL=full-flow-test.test.js.map

package/dist/src/full-flow-test.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"full-flow-test.test.js","sourceRoot":"","sources":["../../src/full-flow-test.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,kBAAkB,EAAY,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AACrH,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,iCAAiC;AACjC,sEAAsE;AACtE,MAAM,sBAAsB,GAAG,4CAAqD,CAAC;AACrF,MAAM,cAAc,GAAG,oCAA2C,CAAC;AACnE,MAAM,YAAY,GAAG,4CAAmD,CAAC;AAEzE,mBAAmB;AACnB,MAAM,eAAe,GAAG,SAAS,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC,CAAC;AAEvE;;GAEG;AACH,SAAS,SAAS,CAAC,GAAQ;IACzB,gEAAgE;IAChE,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;AACxC,CAAC;AAED,EAAE,CAAC,IAAI,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;IAC9D,8DAA8D;IAC9D,6EAA6E;IAC7E,MAAM,iBAAiB,GAAG,QAAyB,CAAC;IACpD,MAAM,EAAE,OAAO,EAAE,GAAG,mBAAmB,CAAC,iBAAiB,CAAC,CAAC;IAE3D,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAEhC,gCAAgC;IAChC,MAAM,YAAY,GAAG,MAAM,eAAe,CAAC;QACzC,UAAU,EAAE,iBAAiB;KAC9B,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC;IACrC,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACxD,CAAC;IAED,oDAAoD;IACpD,MAAM,MAAM,GAAG,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAC/D,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACxD,CAAC;IAED,MAAM,YAAY,GAAG,kBAAkB,CAAC;QACtC,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC;KACxB,CAAC,CAAC;IAEH,4DAA4D;IAC5D,IAAI,UAAU,GAAG,CAAC,MAAM,YAAY,CAAC,YAAY,CAAC;QAChD,OAAO,EAAE,sBAAsB;QAC/B,GAAG,EAAE,gBAAgB;QACrB,YAAY,EAAE,kBAAkB;QAChC,IAAI,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC;KACxB,CAAC,CAAQ,CAAC;IAEX,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,UAAU,CAAC,CAAC;IAE/C,+CAA+C;IAC/C,IAAI,UAAU,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,WAAW,EAAE,EAAE,CAAC;QAC9D,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;QAE1C,MAAM,iBAAiB,GAAG,MAAM,YAAY,CAAC,eAAe,CAAC;YAC3D,oDAAoD;YACpD,OAAO,EAAE,YAAY,CAAC,OAAO;YAC7B,EAAE,EAAE,sBAAsB;YAC1B,KAAK,EAAE,EAAE;YACT,IAAI,EAAE,kBAAkB,CAAC;gBACvB,GAAG,EAAE,gBAAgB;gBACrB,YAAY,EAAE,iBAAiB;gBAC/B,IAAI,EAAE;oBACJ,SAAS,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,EAAE,QAAQ;oBACvC,mBAAmB,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,WAAW;iBAClE;aACF,CAAC;SACH,CAAC,CAAC;QAEH,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,iBAAiB,CAAC,CAAC;QAEpD,MAAM,YAAY,CAAC,yBAAyB,CAAC,EAAE,IAAI,EAAE,iBAAiB,EAAE,CAAC,CAAC;QAE1E,uCAAuC;QACvC,UAAU,GAAG,CAAC,MAAM,YAAY,CAAC,YAAY,CAAC;YAC5C,OAAO,EAAE,sBAAsB;YAC/B,GAAG,EAAE,gBAAgB;YACrB,YAAY,EAAE,kBAAkB;YAChC,IAAI,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC;SACxB,CAAC,CAAQ,CAAC;QAEX,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,UAAU,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,UAAU,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,WAAW,EAAE,EAAE,CAAC;QAC9D,MAAM,IAAI,KAAK,CAAC,+CAA+C,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED,MAAM,OAAO,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;IACtC,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;IAEvC,kCAAkC;IAClC,MAAM,YAAY,GAAG,CAAC,MAAM,YAAY,CAAC,YAAY,CAAC;QACpD,OAAO,EAAE,sBAAsB;QAC/B,GAAG,EAAE,gBAAgB;QACrB,YAAY,EAAE,kBAAkB;QAChC,IAAI,EAAE,CAAC,UAAU,CAAC;KACnB,CAAC,CAAQ,CAAC;IAEX,IAAI,YAAY,CAAC,WAAW,EAAE,KAAK,YAAY,CAAC,WAAW,EAAE,EAAE,CAAC;QAC9D,MAAM,IAAI,KAAK,CAAC,SAAS,OAAO,sCAAsC,UAAU,GAAG,CAAC,CAAC;IACvF,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;IAE1C,kCAAkC;IAClC,MAAM,EAAE,GAAG,EAAE,EAAE,EAAE,QAAQ,EAAE,GAAG,YAAY,CAAC;QACzC,IAAI,EAAE,aAAa;QACnB,WAAW,EAAE,4BAA4B;KAC1C,CAAC,CAAC;IAEH,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IAElC,2BAA2B;IAC3B,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,MAAM,WAAW,CAAC;QACxC,IAAI,EAAE,WAAW;QACjB,GAAG;QACH,MAAM,EAAE,OAAO,CAAC,OAAO;QACvB,OAAO,EAAE,SAAS;KACnB,CAAC,CAAC;IAEH,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACxB,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAE9B,qDAAqD;IACrD,qFAAqF;IACrF,MAAM,SAAS,GAAG,mBAAmB,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAEnE,MAAM,QAAQ,GAAG,kBAAkB,CAAC;QAClC,GAAG,EAAE,gBAAgB;QACrB,YAAY,EAAE,OAAO;QACrB,IAAI,EAAE;YACJ,UAAU,EAAE,wBAAwB;YACpC,UAAU,EAAE,sBAAsB;YAClC,eAAe,EAAE,SAAS;YAC1B,oEAA2E,EAAE,QAAQ;YACrF,SAAS,EAAE,OAAO;YAClB,IAAW;SACZ;KACF,CAAC,CAAC;IAEH,MAAM,aAAa,GAAG,MAAM,YAAY,CAAC,eAAe,CAAC;QACvD,oDAAoD;QACpD,OAAO,EAAE,YAAY,CAAC,OAAO;QAC7B,KAAK,EAAE,YAAY,CAAC,KAAK,IAAI,IAAI;QACjC,EAAE,EAAE,sBAAsB;QAC1B,KAAK,EAAE,EAAE;QACT,IAAI,EAAE,QAAQ;KACf,CAAC,CAAC;IAEH,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,aAAa,CAAC,CAAC;IAE5C,MAAM,cAAc,GAAG,MAAM,YAAY,CAAC,yBAAyB,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC;IAC7F,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;IAE5D,IAAI,cAAc,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;QACzC,MAAM,IAAI,KAAK,CAAC,iCAAiC,aAAa,EAAE,CAAC,CAAC;IACpE,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,sCAAsC,EAAE,OAAO,CAAC,CAAC;AAC/D,CAAC,EAAE,KAAK,CAAC,CAAC"}

package/dist/src/graph/constants.d.ts

@@ -0,0 +1,4 @@
+import type { Network } from "../types.js";
+export declare const TESTNET_API_ORIGIN = "https://testnet-api.geobrowser.io";
+export declare function getApiOrigin(network: Network): string;
+//# sourceMappingURL=constants.d.ts.map

package/dist/src/graph/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/graph/constants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAE3C,eAAO,MAAM,kBAAkB,sCAAsC,CAAC;AAEtE,wBAAgB,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAKrD"}

package/dist/src/graph/constants.js

@@ -0,0 +1,8 @@
+export const TESTNET_API_ORIGIN = 'https://testnet-api.geobrowser.io';
+export function getApiOrigin(network) {
+    if (network === 'TESTNET') {
+        return TESTNET_API_ORIGIN;
+    }
+    throw new Error(`Network ${network} not supported`);
+}
+//# sourceMappingURL=constants.js.map

package/dist/src/graph/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/graph/constants.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,kBAAkB,GAAG,mCAAmC,CAAC;AAEtE,MAAM,UAAU,YAAY,CAAC,OAAgB;IAC3C,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,WAAW,OAAO,gBAAgB,CAAC,CAAC;AACtD,CAAC"}

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

@@ -0,0 +1,54 @@
+import type { CreateResult, EntityParams } from '../types.js';
+/**
+ * Creates an entity with the given name, description, cover, properties, and types.
+ * All IDs passed to this function (cover, types, property IDs, relation IDs, etc.) are validated.
+ * If any invalid ID is provided, the function will throw an error.
+ *
+ * @example
+ * ```ts
+ * const { id, ops } = createEntity({
+ *   id: entityId, // optional and will be generated if not provided
+ *   name: 'name of the entity',
+ *   description: 'description of the entity',
+ *   cover: imageEntityId,
+ *   types: [typeEntityId1, typeEntityId2],
+ *   values: [
+ *     {
+ *       property: propertyId,
+ *       value: 'value of the property'
+ *     }
+ *   ],
+ *   relations: {
+ *     [relationPropertyId]: {
+ *       toEntity: 'id of the entity',
+ *       id: 'id of the relation', // optional
+ *       toSpace: 'id of the to space', // optional
+ *       fromSpace: 'id of the from space', // optional
+ *       fromVersion: 'id of the from version', // optional
+ *       toVersion: 'id of the to version', // optional
+ *       position: positionString, // optional
+ *       entityId: 'id of the relation entity', // optional and will be generated if not provided
+ *       entityName: 'name of the relation entity', // optional
+ *       entityDescription: 'description of the relation entity', // optional
+ *       entityCover: 'id of the cover', // optional
+ *       entityValues: [ // optional values for the relation entity
+ *         { property: propertyId, value: 'value of the property' },
+ *       ],
+ *       entityRelations: { // same structure as `relations` and can be nested
+ *         [relationPropertyId]: {
+ *           toEntity: 'id of the entity',
+ *           id: 'id of the relation', // optional
+ *           position: positionString, // optional
+ *         },
+ *       },
+ *       entityTypes: [typeEntityId1, typeEntityId2], // optional
+ *     },
+ *   },
+ * });
+ * ```
+ * @param params – {@link EntityParams}
+ * @returns – {@link CreateResult}
+ * @throws Will throw an error if any provided ID is invalid
+ */
+export declare const createEntity: ({ id: providedId, name, description, cover, values, relations, types, }: EntityParams) => CreateResult;
+//# sourceMappingURL=create-entity.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"create-entity.d.ts","sourceRoot":"","sources":["../../../src/graph/create-entity.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAG9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,eAAO,MAAM,YAAY,GAAI,yEAQ1B,YAAY,KAAG,YA+MjB,CAAC"}

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

@@ -0,0 +1,272 @@
+import { createEntity as grcCreateEntity, createRelation as grcCreateRelation, languages, } from '@geoprotocol/grc-20';
+import { COVER_PROPERTY, DESCRIPTION_PROPERTY, NAME_PROPERTY, TYPES_PROPERTY } from '../core/ids/system.js';
+import { Id } from '../id.js';
+import { assertValid, generate, toGrcId } from '../id-utils.js';
+import { createRelation } from './create-relation.js';
+/**
+ * Creates an entity with the given name, description, cover, properties, and types.
+ * All IDs passed to this function (cover, types, property IDs, relation IDs, etc.) are validated.
+ * If any invalid ID is provided, the function will throw an error.
+ *
+ * @example
+ * ```ts
+ * const { id, ops } = createEntity({
+ *   id: entityId, // optional and will be generated if not provided
+ *   name: 'name of the entity',
+ *   description: 'description of the entity',
+ *   cover: imageEntityId,
+ *   types: [typeEntityId1, typeEntityId2],
+ *   values: [
+ *     {
+ *       property: propertyId,
+ *       value: 'value of the property'
+ *     }
+ *   ],
+ *   relations: {
+ *     [relationPropertyId]: {
+ *       toEntity: 'id of the entity',
+ *       id: 'id of the relation', // optional
+ *       toSpace: 'id of the to space', // optional
+ *       fromSpace: 'id of the from space', // optional
+ *       fromVersion: 'id of the from version', // optional
+ *       toVersion: 'id of the to version', // optional
+ *       position: positionString, // optional
+ *       entityId: 'id of the relation entity', // optional and will be generated if not provided
+ *       entityName: 'name of the relation entity', // optional
+ *       entityDescription: 'description of the relation entity', // optional
+ *       entityCover: 'id of the cover', // optional
+ *       entityValues: [ // optional values for the relation entity
+ *         { property: propertyId, value: 'value of the property' },
+ *       ],
+ *       entityRelations: { // same structure as `relations` and can be nested
+ *         [relationPropertyId]: {
+ *           toEntity: 'id of the entity',
+ *           id: 'id of the relation', // optional
+ *           position: positionString, // optional
+ *         },
+ *       },
+ *       entityTypes: [typeEntityId1, typeEntityId2], // optional
+ *     },
+ *   },
+ * });
+ * ```
+ * @param params – {@link EntityParams}
+ * @returns – {@link CreateResult}
+ * @throws Will throw an error if any provided ID is invalid
+ */
+export const createEntity = ({ id: providedId, name, description, cover, values, relations, types, }) => {
+    if (providedId)
+        assertValid(providedId, '`id` in `createEntity`');
+    if (cover)
+        assertValid(cover, '`cover` in `createEntity`');
+    for (const valueEntry of values ?? []) {
+        assertValid(valueEntry.property, '`values` in `createEntity`');
+        // Validate IDs in typed values
+        if (valueEntry.type === 'text' && valueEntry.language) {
+            assertValid(valueEntry.language, '`language` in `values` in `createEntity`');
+        }
+        if (valueEntry.type === 'float64' && valueEntry.unit) {
+            assertValid(valueEntry.unit, '`unit` in `values` in `createEntity`');
+        }
+    }
+    // we only assert Ids one level deep for a better experience here, but multiple levels deep are
+    // asserted since we use createRelation and createEntity internally
+    for (const [key, relationEntry] of Object.entries(relations ?? {})) {
+        assertValid(key, '`relations` in `createEntity`');
+        if (Array.isArray(relationEntry)) {
+            for (const relation of relationEntry) {
+                assertValid(relation.toEntity, '`toEntity` in `relations` in `createEntity`');
+                if (relation.toSpace)
+                    assertValid(relation.toSpace, '`toSpace` in `relations` in `createEntity`');
+                if (relation.fromSpace)
+                    assertValid(relation.fromSpace, '`fromSpace` in `relations` in `createEntity`');
+                if (relation.fromVersion)
+                    assertValid(relation.fromVersion, '`fromVersion` in `relations` in `createEntity`');
+                if (relation.toVersion)
+                    assertValid(relation.toVersion, '`toVersion` in `relations` in `createEntity`');
+                if (relation.entityId)
+                    assertValid(relation.entityId, '`entityId` in `relations` in `createEntity`');
+                if (relation.entityCover)
+                    assertValid(relation.entityCover, '`entityCover` in `relations` in `createEntity`');
+            }
+        }
+        else {
+            assertValid(relationEntry.toEntity, '`toEntity` in `relations` in `createEntity`');
+            if (relationEntry.toSpace)
+                assertValid(relationEntry.toSpace, '`toSpace` in `relations` in `createEntity`');
+            if (relationEntry.fromSpace)
+                assertValid(relationEntry.fromSpace, '`fromSpace` in `relations` in `createEntity`');
+            if (relationEntry.fromVersion)
+                assertValid(relationEntry.fromVersion, '`fromVersion` in `relations` in `createEntity`');
+            if (relationEntry.toVersion)
+                assertValid(relationEntry.toVersion, '`toVersion` in `relations` in `createEntity`');
+            if (relationEntry.entityId)
+                assertValid(relationEntry.entityId, '`entityId` in `relations` in `createEntity`');
+            if (relationEntry.entityCover)
+                assertValid(relationEntry.entityCover, '`entityCover` in `relations` in `createEntity`');
+        }
+    }
+    for (const typeId of types ?? []) {
+        assertValid(typeId, '`types` in `createEntity`');
+    }
+    const id = providedId ?? generate();
+    let ops = [];
+    const newValues = [];
+    if (name) {
+        newValues.push({
+            property: toGrcId(NAME_PROPERTY),
+            value: {
+                type: 'text',
+                value: name,
+                language: languages.english(),
+            },
+        });
+    }
+    if (description) {
+        newValues.push({
+            property: toGrcId(DESCRIPTION_PROPERTY),
+            value: {
+                type: 'text',
+                value: description,
+                language: languages.english(),
+            },
+        });
+    }
+    for (const valueEntry of values ?? []) {
+        const property = toGrcId(valueEntry.property);
+        if (valueEntry.type === 'text') {
+            newValues.push({
+                property,
+                value: {
+                    type: 'text',
+                    value: valueEntry.value,
+                    language: valueEntry.language ? toGrcId(valueEntry.language) : languages.english(),
+                },
+            });
+        }
+        else if (valueEntry.type === 'float64') {
+            newValues.push({
+                property,
+                value: {
+                    type: 'float64',
+                    value: valueEntry.value,
+                    ...(valueEntry.unit ? { unit: toGrcId(valueEntry.unit) } : {}),
+                },
+            });
+        }
+        else if (valueEntry.type === 'bool') {
+            newValues.push({
+                property,
+                value: {
+                    type: 'bool',
+                    value: valueEntry.value,
+                },
+            });
+        }
+        else if (valueEntry.type === 'point') {
+            newValues.push({
+                property,
+                value: {
+                    type: 'point',
+                    lon: valueEntry.lon,
+                    lat: valueEntry.lat,
+                    ...(valueEntry.alt !== undefined ? { alt: valueEntry.alt } : {}),
+                },
+            });
+        }
+        else if (valueEntry.type === 'date') {
+            newValues.push({
+                property,
+                value: {
+                    type: 'date',
+                    value: valueEntry.value,
+                },
+            });
+        }
+        else if (valueEntry.type === 'time') {
+            newValues.push({
+                property,
+                value: {
+                    type: 'time',
+                    value: valueEntry.value,
+                },
+            });
+        }
+        else if (valueEntry.type === 'datetime') {
+            newValues.push({
+                property,
+                value: {
+                    type: 'datetime',
+                    value: valueEntry.value,
+                },
+            });
+        }
+        else if (valueEntry.type === 'schedule') {
+            newValues.push({
+                property,
+                value: {
+                    type: 'schedule',
+                    value: valueEntry.value,
+                },
+            });
+        }
+        else {
+            // Exhaustive check - this will cause a TypeScript error if a new type is added
+            // to TypedValue but not handled here
+            const exhaustiveCheck = valueEntry;
+            throw new Error(`Unsupported value type: ${exhaustiveCheck.type}`);
+        }
+    }
+    ops.push(grcCreateEntity({
+        id: toGrcId(id),
+        values: newValues,
+    }));
+    if (cover) {
+        ops.push(grcCreateRelation({
+            id: toGrcId(generate()),
+            entity: toGrcId(generate()),
+            from: toGrcId(id),
+            to: toGrcId(cover),
+            relationType: toGrcId(COVER_PROPERTY),
+        }));
+    }
+    if (types) {
+        for (const typeId of types) {
+            ops.push(grcCreateRelation({
+                id: toGrcId(generate()),
+                entity: toGrcId(generate()),
+                from: toGrcId(id),
+                to: toGrcId(typeId),
+                relationType: toGrcId(TYPES_PROPERTY),
+            }));
+        }
+    }
+    for (const [typeId, value] of Object.entries(relations ?? {})) {
+        const relationsEntries = Array.isArray(value) ? value : [value];
+        for (const relation of relationsEntries) {
+            const relationId = relation.id ?? generate();
+            const relationEntityId = relation.entityId ?? generate();
+            const { ops: relationOps } = createRelation({
+                id: relationId,
+                fromEntity: id,
+                toEntity: relation.toEntity,
+                type: Id(typeId),
+                position: relation.position,
+                fromSpace: relation.fromSpace,
+                toSpace: relation.toSpace,
+                fromVersion: relation.fromVersion,
+                toVersion: relation.toVersion,
+                entityId: relationEntityId,
+                entityName: relation.entityName,
+                entityDescription: relation.entityDescription,
+                entityCover: relation.entityCover,
+                entityValues: relation.entityValues,
+                entityRelations: relation.entityRelations,
+                entityTypes: relation.entityTypes,
+            });
+            ops = ops.concat(relationOps);
+        }
+    }
+    return { id: Id(id), ops };
+};
+//# sourceMappingURL=create-entity.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"create-entity.js","sourceRoot":"","sources":["../../../src/graph/create-entity.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,YAAY,IAAI,eAAe,EAC/B,cAAc,IAAI,iBAAiB,EACnC,SAAS,GAEV,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAC5G,OAAO,EAAE,EAAE,EAAE,MAAM,UAAU,CAAC;AAC9B,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAEhE,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,EAC3B,EAAE,EAAE,UAAU,EACd,IAAI,EACJ,WAAW,EACX,KAAK,EACL,MAAM,EACN,SAAS,EACT,KAAK,GACQ,EAAgB,EAAE;IAC/B,IAAI,UAAU;QAAE,WAAW,CAAC,UAAU,EAAE,wBAAwB,CAAC,CAAC;IAClE,IAAI,KAAK;QAAE,WAAW,CAAC,KAAK,EAAE,2BAA2B,CAAC,CAAC;IAC3D,KAAK,MAAM,UAAU,IAAI,MAAM,IAAI,EAAE,EAAE,CAAC;QACtC,WAAW,CAAC,UAAU,CAAC,QAAQ,EAAE,4BAA4B,CAAC,CAAC;QAC/D,+BAA+B;QAC/B,IAAI,UAAU,CAAC,IAAI,KAAK,MAAM,IAAI,UAAU,CAAC,QAAQ,EAAE,CAAC;YACtD,WAAW,CAAC,UAAU,CAAC,QAAQ,EAAE,0CAA0C,CAAC,CAAC;QAC/E,CAAC;QACD,IAAI,UAAU,CAAC,IAAI,KAAK,SAAS,IAAI,UAAU,CAAC,IAAI,EAAE,CAAC;YACrD,WAAW,CAAC,UAAU,CAAC,IAAI,EAAE,sCAAsC,CAAC,CAAC;QACvE,CAAC;IACH,CAAC;IACD,+FAA+F;IAC/F,mEAAmE;IACnE,KAAK,MAAM,CAAC,GAAG,EAAE,aAAa,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC,EAAE,CAAC;QACnE,WAAW,CAAC,GAAG,EAAE,+BAA+B,CAAC,CAAC;QAClD,IAAI,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;YACjC,KAAK,MAAM,QAAQ,IAAI,aAAa,EAAE,CAAC;gBACrC,WAAW,CAAC,QAAQ,CAAC,QAAQ,EAAE,6CAA6C,CAAC,CAAC;gBAC9E,IAAI,QAAQ,CAAC,OAAO;oBAAE,WAAW,CAAC,QAAQ,CAAC,OAAO,EAAE,4CAA4C,CAAC,CAAC;gBAClG,IAAI,QAAQ,CAAC,SAAS;oBAAE,WAAW,CAAC,QAAQ,CAAC,SAAS,EAAE,8CAA8C,CAAC,CAAC;gBACxG,IAAI,QAAQ,CAAC,WAAW;oBAAE,WAAW,CAAC,QAAQ,CAAC,WAAW,EAAE,gDAAgD,CAAC,CAAC;gBAC9G,IAAI,QAAQ,CAAC,SAAS;oBAAE,WAAW,CAAC,QAAQ,CAAC,SAAS,EAAE,8CAA8C,CAAC,CAAC;gBACxG,IAAI,QAAQ,CAAC,QAAQ;oBAAE,WAAW,CAAC,QAAQ,CAAC,QAAQ,EAAE,6CAA6C,CAAC,CAAC;gBACrG,IAAI,QAAQ,CAAC,WAAW;oBAAE,WAAW,CAAC,QAAQ,CAAC,WAAW,EAAE,gDAAgD,CAAC,CAAC;YAChH,CAAC;QACH,CAAC;aAAM,CAAC;YACN,WAAW,CAAC,aAAa,CAAC,QAAQ,EAAE,6CAA6C,CAAC,CAAC;YACnF,IAAI,aAAa,CAAC,OAAO;gBAAE,WAAW,CAAC,aAAa,CAAC,OAAO,EAAE,4CAA4C,CAAC,CAAC;YAC5G,IAAI,aAAa,CAAC,SAAS;gBAAE,WAAW,CAAC,aAAa,CAAC,SAAS,EAAE,8CAA8C,CAAC,CAAC;YAClH,IAAI,aAAa,CAAC,WAAW;gBAC3B,WAAW,CAAC,aAAa,CAAC,WAAW,EAAE,gDAAgD,CAAC,CAAC;YAC3F,IAAI,aAAa,CAAC,SAAS;gBAAE,WAAW,CAAC,aAAa,CAAC,SAAS,EAAE,8CAA8C,CAAC,CAAC;YAClH,IAAI,aAAa,CAAC,QAAQ;gBAAE,WAAW,CAAC,aAAa,CAAC,QAAQ,EAAE,6CAA6C,CAAC,CAAC;YAC/G,IAAI,aAAa,CAAC,WAAW;gBAC3B,WAAW,CAAC,aAAa,CAAC,WAAW,EAAE,gDAAgD,CAAC,CAAC;QAC7F,CAAC;IACH,CAAC;IACD,KAAK,MAAM,MAAM,IAAI,KAAK,IAAI,EAAE,EAAE,CAAC;QACjC,WAAW,CAAC,MAAM,EAAE,2BAA2B,CAAC,CAAC;IACnD,CAAC;IAED,MAAM,EAAE,GAAG,UAAU,IAAI,QAAQ,EAAE,CAAC;IACpC,IAAI,GAAG,GAAc,EAAE,CAAC;IAExB,MAAM,SAAS,GAA4B,EAAE,CAAC;IAC9C,IAAI,IAAI,EAAE,CAAC;QACT,SAAS,CAAC,IAAI,CAAC;YACb,QAAQ,EAAE,OAAO,CAAC,aAAa,CAAC;YAChC,KAAK,EAAE;gBACL,IAAI,EAAE,MAAM;gBACZ,KAAK,EAAE,IAAI;gBACX,QAAQ,EAAE,SAAS,CAAC,OAAO,EAAE;aAC9B;SACF,CAAC,CAAC;IACL,CAAC;IACD,IAAI,WAAW,EAAE,CAAC;QAChB,SAAS,CAAC,IAAI,CAAC;YACb,QAAQ,EAAE,OAAO,CAAC,oBAAoB,CAAC;YACvC,KAAK,EAAE;gBACL,IAAI,EAAE,MAAM;gBACZ,KAAK,EAAE,WAAW;gBAClB,QAAQ,EAAE,SAAS,CAAC,OAAO,EAAE;aAC9B;SACF,CAAC,CAAC;IACL,CAAC;IACD,KAAK,MAAM,UAAU,IAAI,MAAM,IAAI,EAAE,EAAE,CAAC;QACtC,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAE9C,IAAI,UAAU,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YAC/B,SAAS,CAAC,IAAI,CAAC;gBACb,QAAQ;gBACR,KAAK,EAAE;oBACL,IAAI,EAAE,MAAM;oBACZ,KAAK,EAAE,UAAU,CAAC,KAAK;oBACvB,QAAQ,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,EAAE;iBACnF;aACF,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,UAAU,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YACzC,SAAS,CAAC,IAAI,CAAC;gBACb,QAAQ;gBACR,KAAK,EAAE;oBACL,IAAI,EAAE,SAAS;oBACf,KAAK,EAAE,UAAU,CAAC,KAAK;oBACvB,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBAC/D;aACF,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,UAAU,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YACtC,SAAS,CAAC,IAAI,CAAC;gBACb,QAAQ;gBACR,KAAK,EAAE;oBACL,IAAI,EAAE,MAAM;oBACZ,KAAK,EAAE,UAAU,CAAC,KAAK;iBACxB;aACF,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,UAAU,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YACvC,SAAS,CAAC,IAAI,CAAC;gBACb,QAAQ;gBACR,KAAK,EAAE;oBACL,IAAI,EAAE,OAAO;oBACb,GAAG,EAAE,UAAU,CAAC,GAAG;oBACnB,GAAG,EAAE,UAAU,CAAC,GAAG;oBACnB,GAAG,CAAC,UAAU,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,UAAU,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBACjE;aACF,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,UAAU,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YACtC,SAAS,CAAC,IAAI,CAAC;gBACb,QAAQ;gBACR,KAAK,EAAE;oBACL,IAAI,EAAE,MAAM;oBACZ,KAAK,EAAE,UAAU,CAAC,KAAK;iBACxB;aACF,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,UAAU,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YACtC,SAAS,CAAC,IAAI,CAAC;gBACb,QAAQ;gBACR,KAAK,EAAE;oBACL,IAAI,EAAE,MAAM;oBACZ,KAAK,EAAE,UAAU,CAAC,KAAK;iBACxB;aACF,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,UAAU,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YAC1C,SAAS,CAAC,IAAI,CAAC;gBACb,QAAQ;gBACR,KAAK,EAAE;oBACL,IAAI,EAAE,UAAU;oBAChB,KAAK,EAAE,UAAU,CAAC,KAAK;iBACxB;aACF,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,UAAU,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YAC1C,SAAS,CAAC,IAAI,CAAC;gBACb,QAAQ;gBACR,KAAK,EAAE;oBACL,IAAI,EAAE,UAAU;oBAChB,KAAK,EAAE,UAAU,CAAC,KAAK;iBACxB;aACF,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,+EAA+E;YAC/E,qCAAqC;YACrC,MAAM,eAAe,GAAU,UAAU,CAAC;YAC1C,MAAM,IAAI,KAAK,CAAC,2BAA4B,eAAoC,CAAC,IAAI,EAAE,CAAC,CAAC;QAC3F,CAAC;IACH,CAAC;IAED,GAAG,CAAC,IAAI,CACN,eAAe,CAAC;QACd,EAAE,EAAE,OAAO,CAAC,EAAE,CAAC;QACf,MAAM,EAAE,SAAS;KAClB,CAAC,CACH,CAAC;IAEF,IAAI,KAAK,EAAE,CAAC;QACV,GAAG,CAAC,IAAI,CACN,iBAAiB,CAAC;YAChB,EAAE,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC;YACvB,MAAM,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC;YAC3B,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC;YACjB,EAAE,EAAE,OAAO,CAAC,KAAK,CAAC;YAClB,YAAY,EAAE,OAAO,CAAC,cAAc,CAAC;SACtC,CAAC,CACH,CAAC;IACJ,CAAC;IAED,IAAI,KAAK,EAAE,CAAC;QACV,KAAK,MAAM,MAAM,IAAI,KAAK,EAAE,CAAC;YAC3B,GAAG,CAAC,IAAI,CACN,iBAAiB,CAAC;gBAChB,EAAE,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC;gBACvB,MAAM,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC;gBAC3B,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC;gBACjB,EAAE,EAAE,OAAO,CAAC,MAAM,CAAC;gBACnB,YAAY,EAAE,OAAO,CAAC,cAAc,CAAC;aACtC,CAAC,CACH,CAAC;QACJ,CAAC;IACH,CAAC;IAED,KAAK,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC,EAAE,CAAC;QAC9D,MAAM,gBAAgB,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAChE,KAAK,MAAM,QAAQ,IAAI,gBAAgB,EAAE,CAAC;YACxC,MAAM,UAAU,GAAG,QAAQ,CAAC,EAAE,IAAI,QAAQ,EAAE,CAAC;YAC7C,MAAM,gBAAgB,GAAG,QAAQ,CAAC,QAAQ,IAAI,QAAQ,EAAE,CAAC;YACzD,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,cAAc,CAAC;gBAC1C,EAAE,EAAE,UAAU;gBACd,UAAU,EAAE,EAAE;gBACd,QAAQ,EAAE,QAAQ,CAAC,QAAQ;gBAC3B,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC;gBAChB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;gBAC3B,SAAS,EAAE,QAAQ,CAAC,SAAS;gBAC7B,OAAO,EAAE,QAAQ,CAAC,OAAO;gBACzB,WAAW,EAAE,QAAQ,CAAC,WAAW;gBACjC,SAAS,EAAE,QAAQ,CAAC,SAAS;gBAC7B,QAAQ,EAAE,gBAAgB;gBAC1B,UAAU,EAAE,QAAQ,CAAC,UAAU;gBAC/B,iBAAiB,EAAE,QAAQ,CAAC,iBAAiB;gBAC7C,WAAW,EAAE,QAAQ,CAAC,WAAW;gBACjC,YAAY,EAAE,QAAQ,CAAC,YAAY;gBACnC,eAAe,EAAE,QAAQ,CAAC,eAAe;gBACzC,WAAW,EAAE,QAAQ,CAAC,WAAW;aAClC,CAAC,CAAC;YACH,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED,OAAO,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC;AAC7B,CAAC,CAAC"}

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

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

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

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