@arkiv-network/sdk 0.0.36-dev.1 → 0.0.36-dev.5

package/dist/_cjs/clients/decorators/arkivPublic.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.publicArkivActions = publicArkivActions;
+const getBlockTiming_1 = require("../../actions/public/getBlockTiming");
+const getEntity_1 = require("../../actions/public/getEntity");
+const getEntityCount_1 = require("../../actions/public/getEntityCount");
+const query_1 = require("../../actions/public/query");
+const subscribeEntityEvents_1 = require("../../actions/public/subscribeEntityEvents");
+const queryBuilder_1 = require("../../query/queryBuilder");
+function publicArkivActions(client) {
+    return {
+        getEntity: (key) => (0, getEntity_1.getEntity)(client, key),
+        query: (rawQuery) => (0, query_1.query)(client, rawQuery),
+        buildQuery: () => new queryBuilder_1.QueryBuilder(client),
+        getBlockTiming: () => (0, getBlockTiming_1.getBlockTiming)(client),
+        getEntityCount: () => (0, getEntityCount_1.getEntityCount)(client),
+        subscribeEntityEvents: ({ onError, onEntityCreated, onEntityUpdated, onEntityDeleted, onEntityExpired, onEntityExpiresInExtended, }, pollingInterval, fromBlock) => (0, subscribeEntityEvents_1.subscribeEntityEvents)(client, {
+            onError,
+            onEntityCreated,
+            onEntityUpdated,
+            onEntityDeleted,
+            onEntityExpired,
+            onEntityExpiresInExtended,
+        }, pollingInterval, fromBlock),
+    };
+}
+//# sourceMappingURL=arkivPublic.js.map

package/dist/_cjs/clients/decorators/arkivPublic.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"arkivPublic.js","sourceRoot":"","sources":["../../../../src/clients/decorators/arkivPublic.ts"],"names":[],"mappings":";;AAgKA,gDA4CC;AA3MD,wEAAoE;AACpE,8DAA0D;AAC1D,wEAAoE;AACpE,sDAAkD;AAClD,sFAAkF;AAClF,2DAAuD;AA0JvD,SAAgB,kBAAkB,CAIhC,MAAyC;IAC1C,OAAO;QACN,SAAS,EAAE,CAAC,GAAQ,EAAE,EAAE,CAAC,IAAA,qBAAS,EAAC,MAAM,EAAE,GAAG,CAAC;QAC/C,KAAK,EAAE,CAAC,QAAgB,EAAE,EAAE,CAAC,IAAA,aAAK,EAAC,MAAM,EAAE,QAAQ,CAAC;QACpD,UAAU,EAAE,GAAG,EAAE,CAAC,IAAI,2BAAY,CAAC,MAAM,CAAC;QAC1C,cAAc,EAAE,GAAG,EAAE,CAAC,IAAA,+BAAc,EAAC,MAAM,CAAC;QAC5C,cAAc,EAAE,GAAG,EAAE,CAAC,IAAA,+BAAc,EAAC,MAAM,CAAC;QAC5C,qBAAqB,EAAE,CACtB,EACC,OAAO,EACP,eAAe,EACf,eAAe,EACf,eAAe,EACf,eAAe,EACf,yBAAyB,GAQzB,EACD,eAAwB,EACxB,SAAkB,EACjB,EAAE,CACH,IAAA,6CAAqB,EACpB,MAAM,EACN;YACC,OAAO;YACP,eAAe;YACf,eAAe;YACf,eAAe;YACf,eAAe;YACf,yBAAyB;SACzB,EACD,eAAe,EACf,SAAS,CACT;KACF,CAAA;AACF,CAAC"}

package/dist/_cjs/clients/decorators/arkivWallet.d.ts

@@ -0,0 +1,167 @@
+import type { Account, Chain, Client, Transport, WalletActions } from "viem";
+import { type CreateEntityParameters, type CreateEntityReturnType } from "../../actions/wallet/createEntity";
+import type { DeleteEntityParameters, DeleteEntityReturnType } from "../../actions/wallet/deleteEntity";
+import type { ExtendEntityParameters, ExtendEntityReturnType } from "../../actions/wallet/extendEntity";
+import type { MutateEntitiesParameters, MutateEntitiesReturnType } from "../../actions/wallet/mutateEntities";
+import type { UpdateEntityParameters, UpdateEntityReturnType } from "../../actions/wallet/updateEntity";
+import type { TxParams } from "../../types";
+import type { PublicArkivActions } from "./arkivPublic";
+export type WalletArkivActions<transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined> = PublicArkivActions<transport, chain, account> & Pick<WalletActions<chain, account>, "sendTransaction" | "sendTransactionSync" | "sendRawTransaction" | "sendRawTransactionSync" | "signMessage" | "signTransaction"> & {
+    /**
+     * Returns the entity with the given key.
+     *
+     * - Docs: https://docs.golemdb.io/ts-sdk/actions/public/getEntity
+     * - JSON-RPC Methods: [`golembase_getStorageValue`](https://docs.golemdb.io/dev/json-rpc-api/#golembase_getstoragevalue)
+     * - JSON-RPC Methods: [`golembase_getEntityMetaData`](https://docs.golemdb.io/dev/json-rpc-api/#golembase_getEntityMetaData)
+     *
+     * @param args - {entityKey}
+     * @returns The entity with the given key. {@link Entity}
+     *
+     * @example
+     * import { createPublicClient, http } from 'arkiv'
+     * import { kaolin } from 'arkiv/chains'
+     *
+     * const client = createPublicClient({
+     *   chain: kaolin,
+     *   transport: http(),
+     * })
+     * const { entityKey, txHash } = await client.createEntity({
+     *   payload: toBytes(JSON.stringify({ entity: { entityType: "testType", entityId: "testId" } })),
+     *   annotations: [{ key: "testKey", value: "testValue" }],
+     *   expiresIn: 1000,
+     * })
+     * console.log("entityKey", entityKey)
+     * console.log("txHash", txHash)
+     * // {
+     * //   entityKey: "0x123",
+     * //   txHash: "0x123",
+     * // }
+     */
+    createEntity: (data: CreateEntityParameters, txParams?: TxParams) => Promise<CreateEntityReturnType>;
+    /**
+     * Updates the entity with the given key.
+     *
+     * - Docs: https://docs.golemdb.io/ts-sdk/actions/wallet/updateEntity
+     * - JSON-RPC Methods: [`golembase_updateEntity`](https://docs.golemdb.io/dev/json-rpc-api/#golembase_updateEntity)
+     *
+     * @param args - {entityKey, data}
+     * @returns The entity with the given key. {@link Entity}
+     *
+     * @example
+     * import { createWalletClient, http } from 'arkiv'
+     * import { kaolin } from 'arkiv/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: kaolin,
+     *   transport: http(),
+     * })
+     */
+    updateEntity: (data: UpdateEntityParameters, txParams?: TxParams) => Promise<UpdateEntityReturnType>;
+    /**
+     * Deletes the entity with the given key.
+     *
+     * - Docs: https://docs.golemdb.io/ts-sdk/actions/wallet/deleteEntity
+     * - JSON-RPC Methods: [`golembase_deleteEntity`](https://docs.golemdb.io/dev/json-rpc-api/#golembase_deleteEntity)
+     *
+     * @param args - {entityKey}
+     * @returns The entity with the given key. {@link Entity}
+     *
+     * @example
+     * import { createWalletClient, http } from 'arkiv'
+     * import { kaolin } from 'arkiv/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: kaolin,
+     *   transport: http(),
+     * })
+     * const { entityKey, txHash } = await client.deleteEntity({ entityKey: "0x123" })
+     * console.log("entityKey", entityKey)
+     * console.log("txHash", txHash)
+     * // {
+     * //   entityKey: "0x123",
+     * //   txHash: "0x123",
+     * // }
+     */
+    deleteEntity: (data: DeleteEntityParameters, txParams?: TxParams) => Promise<DeleteEntityReturnType>;
+    /**
+     * Extends the entity with the given key.
+     *
+     * - Docs: https://docs.golemdb.io/ts-sdk/actions/wallet/extendEntity
+     * - JSON-RPC Methods: [`golembase_extendEntity`](https://docs.golemdb.io/dev/json-rpc-api/#golembase_extendEntity)
+     *
+     * @param args - {entityKey, data}
+     * @returns The entity with the given key. {@link Entity}
+     *
+     * @example
+     * import { createWalletClient, http } from 'arkiv'
+     * import { kaolin } from 'arkiv/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: kaolin,
+     *   transport: http(),
+     * })
+     * const { entityKey, txHash } = await client.extendEntity("0x123", {
+     *   expiresIn: 1000,
+     * })
+     * console.log("entityKey", entityKey)
+     * console.log("txHash", txHash)
+     * // {
+     * //   entityKey: "0x123",
+     * //   txHash: "0x123",
+     * // }
+     */
+    extendEntity: (data: ExtendEntityParameters, txParams?: TxParams) => Promise<ExtendEntityReturnType>;
+    /**
+     * Mutates the entities with the given keys.
+     *
+     * - Docs: https://docs.golemdb.io/ts-sdk/actions/wallet/mutateEntities
+     * - JSON-RPC Methods: [`golembase_mutateEntities`](https://docs.golemdb.io/dev/json-rpc-api/#golembase_mutateEntities)
+     *
+     * @param args - {data}
+     * @returns The entity with the given key. {@link Entity}
+     *
+     * @example
+     * import { createWalletClient, http } from 'arkiv'
+     * import { kaolin } from 'arkiv/chains'
+     *
+     * const client = createWalletClient({
+     *   chain: kaolin,
+     *   transport: http(),
+     * })
+     * const { entityKey, txHash } = await client.mutateEntities({
+     *   creates: [{
+     *     payload: toBytes(JSON.stringify({ entity: { entityType: "testType", entityId: "testId" } })),
+     *     annotations: [{ key: "testKey", value: "testValue" }],
+     *     expiresIn: 1000,
+     *   }],
+     *   updates: [{
+     *     entityKey: "0x123",
+     *     payload: toBytes(JSON.stringify({ entity: { entityType: "testType", entityId: "testId" } })),
+     *     annotations: [{ key: "testKey", value: "testValue" }],
+     *     expiresIn: 1000,
+     *   }],
+     *   deletes: [{
+     *     entityKey: "0x321",
+     *   }],
+     *   extensions: [{
+     *     entityKey: "0x1234",
+     *     expiresIn: 1000,
+     *   }],
+     * })
+     * console.log("entityKey", entityKey)
+     * console.log("txHash", txHash)
+     * // {
+     * //   entityKey: "0x123",
+     * //   txHash: "0x123",
+     * // }
+     */
+    mutateEntities: (data: MutateEntitiesParameters, txParams?: TxParams) => Promise<MutateEntitiesReturnType>;
+};
+export declare function walletArkivActions<transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined>(client: Client<transport, chain, account>): {
+    createEntity: (data: CreateEntityParameters, txParams?: TxParams) => Promise<CreateEntityReturnType>;
+    updateEntity: (data: UpdateEntityParameters, txParams?: TxParams) => Promise<UpdateEntityReturnType>;
+    deleteEntity: (data: DeleteEntityParameters, txParams?: TxParams) => Promise<DeleteEntityReturnType>;
+    extendEntity: (data: ExtendEntityParameters, txParams?: TxParams) => Promise<ExtendEntityReturnType>;
+    mutateEntities: (data: MutateEntitiesParameters, txParams?: TxParams) => Promise<MutateEntitiesReturnType>;
+};
+//# sourceMappingURL=arkivWallet.d.ts.map

package/dist/_cjs/clients/decorators/arkivWallet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"arkivWallet.d.ts","sourceRoot":"","sources":["../../../../src/clients/decorators/arkivWallet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,MAAM,CAAA;AAC5E,OAAO,EACN,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAE3B,MAAM,mCAAmC,CAAA;AAC1C,OAAO,KAAK,EACX,sBAAsB,EACtB,sBAAsB,EACtB,MAAM,mCAAmC,CAAA;AAE1C,OAAO,KAAK,EACX,sBAAsB,EACtB,sBAAsB,EACtB,MAAM,mCAAmC,CAAA;AAE1C,OAAO,KAAK,EACX,wBAAwB,EACxB,wBAAwB,EACxB,MAAM,qCAAqC,CAAA;AAE5C,OAAO,KAAK,EACX,sBAAsB,EACtB,sBAAsB,EACtB,MAAM,mCAAmC,CAAA;AAG1C,OAAO,KAAK,EAAU,QAAQ,EAAE,MAAM,aAAa,CAAA;AACnD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAEvD,MAAM,MAAM,kBAAkB,CAC7B,SAAS,SAAS,SAAS,GAAG,SAAS,EACvC,KAAK,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACnD,OAAO,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,IACtD,kBAAkB,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,GAChD,IAAI,CACH,aAAa,CAAC,KAAK,EAAE,OAAO,CAAC,EAC3B,iBAAiB,GACjB,qBAAqB,GACrB,oBAAoB,GACpB,wBAAwB,GACxB,aAAa,GACb,iBAAiB,CACnB,GAAG;IACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,YAAY,EAAE,CACb,IAAI,EAAE,sBAAsB,EAC5B,QAAQ,CAAC,EAAE,QAAQ,KACf,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAEpC;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,EAAE,CACb,IAAI,EAAE,sBAAsB,EAC5B,QAAQ,CAAC,EAAE,QAAQ,KACf,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAEpC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,YAAY,EAAE,CACb,IAAI,EAAE,sBAAsB,EAC5B,QAAQ,CAAC,EAAE,QAAQ,KACf,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,YAAY,EAAE,CACb,IAAI,EAAE,sBAAsB,EAC5B,QAAQ,CAAC,EAAE,QAAQ,KACf,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,cAAc,EAAE,CACf,IAAI,EAAE,wBAAwB,EAC9B,QAAQ,CAAC,EAAE,QAAQ,KACf,OAAO,CAAC,wBAAwB,CAAC,CAAA;CACtC,CAAA;AAEF,wBAAgB,kBAAkB,CACjC,SAAS,SAAS,SAAS,GAAG,SAAS,EACvC,KAAK,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACnD,OAAO,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,EACxD,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC;yBAEpB,sBAAsB,aAAa,QAAQ;yBAE3C,sBAAsB,aAAa,QAAQ;yBAE3C,sBAAsB,aAAa,QAAQ;yBAE3C,sBAAsB,aAAa,QAAQ;2BAEzC,wBAAwB,aAAa,QAAQ;EAGrE"}

package/dist/_cjs/clients/decorators/arkivWallet.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.walletArkivActions = walletArkivActions;
+const createEntity_1 = require("../../actions/wallet/createEntity");
+const deleteEntity_1 = require("../../actions/wallet/deleteEntity");
+const extendEntity_1 = require("../../actions/wallet/extendEntity");
+const mutateEntities_1 = require("../../actions/wallet/mutateEntities");
+const updateEntity_1 = require("../../actions/wallet/updateEntity");
+function walletArkivActions(client) {
+    return {
+        createEntity: (data, txParams) => (0, createEntity_1.createEntity)(client, data, txParams),
+        updateEntity: (data, txParams) => (0, updateEntity_1.updateEntity)(client, data, txParams),
+        deleteEntity: (data, txParams) => (0, deleteEntity_1.deleteEntity)(client, data, txParams),
+        extendEntity: (data, txParams) => (0, extendEntity_1.extendEntity)(client, data, txParams),
+        mutateEntities: (data, txParams) => (0, mutateEntities_1.mutateEntities)(client, data, txParams),
+    };
+}
+//# sourceMappingURL=arkivWallet.js.map

package/dist/_cjs/clients/decorators/arkivWallet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"arkivWallet.js","sourceRoot":"","sources":["../../../../src/clients/decorators/arkivWallet.ts"],"names":[],"mappings":";;AAsNA,gDAiBC;AAtOD,oEAI0C;AAK1C,oEAAgE;AAKhE,oEAAgE;AAKhE,wEAAoE;AAKpE,oEAAgE;AA6LhE,SAAgB,kBAAkB,CAIhC,MAAyC;IAC1C,OAAO;QACN,YAAY,EAAE,CAAC,IAA4B,EAAE,QAAmB,EAAE,EAAE,CACnE,IAAA,2BAAY,EAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC;QACrC,YAAY,EAAE,CAAC,IAA4B,EAAE,QAAmB,EAAE,EAAE,CACnE,IAAA,2BAAY,EAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC;QACrC,YAAY,EAAE,CAAC,IAA4B,EAAE,QAAmB,EAAE,EAAE,CACnE,IAAA,2BAAY,EAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC;QACrC,YAAY,EAAE,CAAC,IAA4B,EAAE,QAAmB,EAAE,EAAE,CACnE,IAAA,2BAAY,EAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC;QACrC,cAAc,EAAE,CAAC,IAA8B,EAAE,QAAmB,EAAE,EAAE,CACvE,IAAA,+BAAc,EAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC;KACvC,CAAA;AACF,CAAC"}

package/dist/_cjs/consts.d.ts

@@ -0,0 +1,3 @@
+export declare const ARKIV_ADDRESS: `0x${string}`;
+export declare const BLOCK_TIME = 2;
+//# sourceMappingURL=consts.d.ts.map

package/dist/_cjs/consts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"consts.d.ts","sourceRoot":"","sources":["../../src/consts.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,aAAa,EAAmD,KAAK,MAAM,EAAE,CAAA;AAC1F,eAAO,MAAM,UAAU,IAAI,CAAA"}

package/dist/_cjs/consts.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BLOCK_TIME = exports.ARKIV_ADDRESS = void 0;
+exports.ARKIV_ADDRESS = "0x0000000000000000000000000000000060138453";
+exports.BLOCK_TIME = 2; // 2 seconds
+//# sourceMappingURL=consts.js.map

package/dist/_cjs/consts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"consts.js","sourceRoot":"","sources":["../../src/consts.ts"],"names":[],"mappings":";;;AAAa,QAAA,aAAa,GAAG,4CAA6D,CAAA;AAC7E,QAAA,UAAU,GAAG,CAAC,CAAA,CAAC,YAAY"}

package/dist/_cjs/index.d.ts

@@ -0,0 +1,11 @@
+export type { Account, Address, Chain, Hex, PublicClientConfig, RpcSchema, Transport, } from "viem";
+export { http, toBytes, toHex, toRlp, webSocket } from "viem";
+export type { ArkivClient } from "./clients/baseClient";
+export type { PublicArkivClient } from "./clients/createPublicClient";
+export { createPublicClient } from "./clients/createPublicClient";
+export type { WalletArkivClient } from "./clients/createWalletClient";
+export { createWalletClient } from "./clients/createWalletClient";
+export type { Annotation } from "./types/annotation";
+export type { Entity } from "./types/entity";
+export type { ArkivRpcSchema } from "./types/rpcSchema";
+//# sourceMappingURL=index.d.ts.map

package/dist/_cjs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,YAAY,EACX,OAAO,EACP,OAAO,EACP,KAAK,EACL,GAAG,EACH,kBAAkB,EAClB,SAAS,EACT,SAAS,GACT,MAAM,MAAM,CAAA;AAEb,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,MAAM,CAAA;AAC7D,YAAY,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AACvD,YAAY,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAA;AACrE,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAA;AACjE,YAAY,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAA;AACrE,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAA;AACjE,YAAY,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AACpD,YAAY,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAC5C,YAAY,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA"}

package/dist/_cjs/index.js

@@ -0,0 +1,16 @@
+"use strict";
+// Export all public APIs
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createWalletClient = exports.createPublicClient = exports.webSocket = exports.toRlp = exports.toHex = exports.toBytes = exports.http = void 0;
+// Re-export commonly used viem types for convenience
+var viem_1 = require("viem");
+Object.defineProperty(exports, "http", { enumerable: true, get: function () { return viem_1.http; } });
+Object.defineProperty(exports, "toBytes", { enumerable: true, get: function () { return viem_1.toBytes; } });
+Object.defineProperty(exports, "toHex", { enumerable: true, get: function () { return viem_1.toHex; } });
+Object.defineProperty(exports, "toRlp", { enumerable: true, get: function () { return viem_1.toRlp; } });
+Object.defineProperty(exports, "webSocket", { enumerable: true, get: function () { return viem_1.webSocket; } });
+var createPublicClient_1 = require("./clients/createPublicClient");
+Object.defineProperty(exports, "createPublicClient", { enumerable: true, get: function () { return createPublicClient_1.createPublicClient; } });
+var createWalletClient_1 = require("./clients/createWalletClient");
+Object.defineProperty(exports, "createWalletClient", { enumerable: true, get: function () { return createWalletClient_1.createWalletClient; } });
+//# sourceMappingURL=index.js.map

package/dist/_cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA,yBAAyB;;;AAWzB,qDAAqD;AACrD,6BAA6D;AAApD,4FAAA,IAAI,OAAA;AAAE,+FAAA,OAAO,OAAA;AAAE,6FAAA,KAAK,OAAA;AAAE,6FAAA,KAAK,OAAA;AAAE,iGAAA,SAAS,OAAA;AAG/C,mEAAiE;AAAxD,wHAAA,kBAAkB,OAAA;AAE3B,mEAAiE;AAAxD,wHAAA,kBAAkB,OAAA"}

package/dist/_cjs/query/engine.d.ts

@@ -0,0 +1,18 @@
+import type { Hex } from "viem";
+import type { ArkivClient } from "../clients/baseClient";
+import type { Predicate } from "./predicate";
+export declare function processQuery(client: ArkivClient, queryParams: {
+    predicates: Predicate[];
+    limit: number | undefined;
+    cursor: string | undefined;
+    ownedBy: Hex | undefined;
+    validAtBlock?: bigint | undefined;
+    withAnnotations?: boolean | undefined;
+    withMetadata?: boolean | undefined;
+    withPayload?: boolean | undefined;
+}): Promise<{
+    data: [import("../types/rpcSchema").RpcEntity];
+    blockNumber: bigint;
+    cursor: string;
+}>;
+//# sourceMappingURL=engine.d.ts.map

package/dist/_cjs/query/engine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine.d.ts","sourceRoot":"","sources":["../../../src/query/engine.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,MAAM,CAAA;AAC/B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAqC5C,wBAAsB,YAAY,CACjC,MAAM,EAAE,WAAW,EACnB,WAAW,EAAE;IACZ,UAAU,EAAE,SAAS,EAAE,CAAA;IACvB,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B,OAAO,EAAE,GAAG,GAAG,SAAS,CAAA;IACxB,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACjC,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACrC,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAClC,WAAW,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;CACjC;;;;GA2DD"}

package/dist/_cjs/query/engine.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.processQuery = processQuery;
+function processPredicates(predicates) {
+    const processValue = (value) => {
+        if (typeof value === "string") {
+            return `"${value}"`;
+        }
+        return value;
+    };
+    return predicates
+        .map((predicate) => {
+        switch (predicate.type) {
+            case "eq":
+                return `${predicate.key} = ${processValue(predicate.value)}`;
+            case "neq":
+                return `${predicate.key} != ${processValue(predicate.value)}`;
+            case "gt":
+                return `${predicate.key} > ${processValue(predicate.value)}`;
+            case "gte":
+                return `${predicate.key} >= ${processValue(predicate.value)}`;
+            case "lt":
+                return `${predicate.key} < ${processValue(predicate.value)}`;
+            case "lte":
+                return `${predicate.key} <= ${processValue(predicate.value)}`;
+            case "not":
+                return `!${predicate.key}`;
+            case "or":
+                return `(${predicate.predicates.map((predicate) => processPredicates([predicate])).join(" || ")})`;
+            case "and":
+                return `(${predicate.predicates.map((predicate) => processPredicates([predicate])).join(" && ")})`;
+            default:
+                return "";
+        }
+    })
+        .join(" && ");
+}
+async function processQuery(client, queryParams) {
+    const { predicates, limit, cursor, ownedBy, validAtBlock, withAnnotations, withMetadata, withPayload, } = queryParams;
+    console.debug(`Processing query with params: predicates: ${predicates}, cursor: ${cursor}, limit: ${limit}, ownedBy: ${ownedBy}, validAtBlock: ${validAtBlock}, withAnnotations: ${withAnnotations}, withMetadata: ${withMetadata}, withPayload: ${withPayload}`);
+    let query = processPredicates(predicates);
+    if (ownedBy) {
+        query += ` && $owner=${ownedBy}`;
+    }
+    // remove leading and trailing spaces and leading &&
+    query = query.trim();
+    if (query.startsWith("&& ")) {
+        query = query.slice(3);
+    }
+    const queryOptions = {
+        includeData: {
+            key: true,
+            annotations: withAnnotations ?? false,
+            payload: withPayload ?? false,
+            expiration: withMetadata ?? false,
+            owner: withMetadata ?? false,
+        },
+    };
+    if (validAtBlock !== undefined) {
+        queryOptions.atBlock = validAtBlock;
+    }
+    if (limit !== undefined) {
+        queryOptions.resultsPerPage = limit;
+    }
+    if (cursor !== undefined) {
+        queryOptions.cursor = cursor;
+    }
+    console.debug(`Built query to send: ${query}, queryOptions: ${JSON.stringify({ atBlock: queryOptions.atBlock?.toString(), resultsPerPage: queryOptions.resultsPerPage, cursor: queryOptions.cursor })}`);
+    const result = await client.request({
+        method: "arkiv_query",
+        params: [query, queryOptions],
+    });
+    console.debug("Raw result from query: ", result);
+    return result;
+}
+//# sourceMappingURL=engine.js.map

package/dist/_cjs/query/engine.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine.js","sourceRoot":"","sources":["../../../src/query/engine.ts"],"names":[],"mappings":";;AAwCA,oCAsEC;AAzGD,SAAS,iBAAiB,CAAC,UAAuB;IACjD,MAAM,YAAY,GAAG,CAAC,KAAsB,EAAE,EAAE;QAC/C,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC/B,OAAO,IAAI,KAAK,GAAG,CAAA;QACpB,CAAC;QACD,OAAO,KAAK,CAAA;IACb,CAAC,CAAA;IACD,OAAO,UAAU;SACf,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE;QAClB,QAAQ,SAAS,CAAC,IAAI,EAAE,CAAC;YACxB,KAAK,IAAI;gBACR,OAAO,GAAG,SAAS,CAAC,GAAG,MAAM,YAAY,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAA;YAC7D,KAAK,KAAK;gBACT,OAAO,GAAG,SAAS,CAAC,GAAG,OAAO,YAAY,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAA;YAC9D,KAAK,IAAI;gBACR,OAAO,GAAG,SAAS,CAAC,GAAG,MAAM,YAAY,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAA;YAC7D,KAAK,KAAK;gBACT,OAAO,GAAG,SAAS,CAAC,GAAG,OAAO,YAAY,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAA;YAC9D,KAAK,IAAI;gBACR,OAAO,GAAG,SAAS,CAAC,GAAG,MAAM,YAAY,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAA;YAC7D,KAAK,KAAK;gBACT,OAAO,GAAG,SAAS,CAAC,GAAG,OAAO,YAAY,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAA;YAC9D,KAAK,KAAK;gBACT,OAAO,IAAI,SAAS,CAAC,GAAG,EAAE,CAAA;YAC3B,KAAK,IAAI;gBACR,OAAO,IAAI,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,iBAAiB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAA;YACnG,KAAK,KAAK;gBACT,OAAO,IAAI,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,iBAAiB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAA;YACnG;gBACC,OAAO,EAAE,CAAA;QACX,CAAC;IACF,CAAC,CAAC;SACD,IAAI,CAAC,MAAM,CAAC,CAAA;AACf,CAAC;AAEM,KAAK,UAAU,YAAY,CACjC,MAAmB,EACnB,WASC;IAED,MAAM,EACL,UAAU,EACV,KAAK,EACL,MAAM,EACN,OAAO,EACP,YAAY,EACZ,eAAe,EACf,YAAY,EACZ,WAAW,GACX,GAAG,WAAW,CAAA;IAEf,OAAO,CAAC,KAAK,CACZ,6CAA6C,UAAU,aAAa,MAAM,YAAY,KAAK,cAAc,OAAO,mBAAmB,YAAY,sBAAsB,eAAe,mBAAmB,YAAY,kBAAkB,WAAW,EAAE,CAClP,CAAA;IAED,IAAI,KAAK,GAAG,iBAAiB,CAAC,UAAU,CAAC,CAAA;IACzC,IAAI,OAAO,EAAE,CAAC;QACb,KAAK,IAAI,cAAc,OAAO,EAAE,CAAA;IACjC,CAAC;IAED,oDAAoD;IACpD,KAAK,GAAG,KAAK,CAAC,IAAI,EAAE,CAAA;IACpB,IAAI,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7B,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACvB,CAAC;IAED,MAAM,YAAY,GAAoB;QACrC,WAAW,EAAE;YACZ,GAAG,EAAE,IAAI;YACT,WAAW,EAAE,eAAe,IAAI,KAAK;YACrC,OAAO,EAAE,WAAW,IAAI,KAAK;YAC7B,UAAU,EAAE,YAAY,IAAI,KAAK;YACjC,KAAK,EAAE,YAAY,IAAI,KAAK;SAC5B;KACD,CAAA;IAED,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;QAChC,YAAY,CAAC,OAAO,GAAG,YAAY,CAAA;IACpC,CAAC;IACD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACzB,YAAY,CAAC,cAAc,GAAG,KAAK,CAAA;IACpC,CAAC;IACD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QAC1B,YAAY,CAAC,MAAM,GAAG,MAAM,CAAA;IAC7B,CAAC;IAED,OAAO,CAAC,KAAK,CACZ,wBAAwB,KAAK,mBAAmB,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,YAAY,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE,cAAc,EAAE,YAAY,CAAC,cAAc,EAAE,MAAM,EAAE,YAAY,CAAC,MAAM,EAAE,CAAC,EAAE,CACzL,CAAA;IAED,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QACnC,MAAM,EAAE,aAAa;QACrB,MAAM,EAAE,CAAC,KAAK,EAAE,YAAY,CAAC;KAC7B,CAAC,CAAA;IACF,OAAO,CAAC,KAAK,CAAC,yBAAyB,EAAE,MAAM,CAAC,CAAA;IAEhD,OAAO,MAAM,CAAA;AACd,CAAC"}

package/dist/_cjs/query/errors.d.ts

@@ -0,0 +1,13 @@
+export declare class NoMoreResultsError extends Error {
+    constructor();
+}
+export declare class NoCursorOrLimitError extends Error {
+    constructor();
+}
+export declare class OffsetCannotBeLessThanZeroError extends Error {
+    constructor();
+}
+export declare class NoEntityFoundError extends Error {
+    constructor();
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/_cjs/query/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../src/query/errors.ts"],"names":[],"mappings":"AAAA,qBAAa,kBAAmB,SAAQ,KAAK;;CAI5C;AAED,qBAAa,oBAAqB,SAAQ,KAAK;;CAI9C;AAED,qBAAa,+BAAgC,SAAQ,KAAK;;CAIzD;AAED,qBAAa,kBAAmB,SAAQ,KAAK;;CAI5C"}

package/dist/_cjs/query/errors.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NoEntityFoundError = exports.OffsetCannotBeLessThanZeroError = exports.NoCursorOrLimitError = exports.NoMoreResultsError = void 0;
+class NoMoreResultsError extends Error {
+    constructor() {
+        super("No more results");
+    }
+}
+exports.NoMoreResultsError = NoMoreResultsError;
+class NoCursorOrLimitError extends Error {
+    constructor() {
+        super("Cursor and limit must be defined to fetch next");
+    }
+}
+exports.NoCursorOrLimitError = NoCursorOrLimitError;
+class OffsetCannotBeLessThanZeroError extends Error {
+    constructor() {
+        super("Offset cannot be less than 0");
+    }
+}
+exports.OffsetCannotBeLessThanZeroError = OffsetCannotBeLessThanZeroError;
+class NoEntityFoundError extends Error {
+    constructor() {
+        super("No entity found");
+    }
+}
+exports.NoEntityFoundError = NoEntityFoundError;
+//# sourceMappingURL=errors.js.map

package/dist/_cjs/query/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../../src/query/errors.ts"],"names":[],"mappings":";;;AAAA,MAAa,kBAAmB,SAAQ,KAAK;IAC5C;QACC,KAAK,CAAC,iBAAiB,CAAC,CAAA;IACzB,CAAC;CACD;AAJD,gDAIC;AAED,MAAa,oBAAqB,SAAQ,KAAK;IAC9C;QACC,KAAK,CAAC,gDAAgD,CAAC,CAAA;IACxD,CAAC;CACD;AAJD,oDAIC;AAED,MAAa,+BAAgC,SAAQ,KAAK;IACzD;QACC,KAAK,CAAC,8BAA8B,CAAC,CAAA;IACtC,CAAC;CACD;AAJD,0EAIC;AAED,MAAa,kBAAmB,SAAQ,KAAK;IAC5C;QACC,KAAK,CAAC,iBAAiB,CAAC,CAAA;IACzB,CAAC;CACD;AAJD,gDAIC"}

package/dist/_cjs/query/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./errors";
+export * from "./predicate";
+export * from "./queryBuilder";
+export * from "./queryResult";
+//# sourceMappingURL=index.d.ts.map

package/dist/_cjs/query/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/query/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,eAAe,CAAA"}

package/dist/_cjs/query/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./errors"), exports);
+__exportStar(require("./predicate"), exports);
+__exportStar(require("./queryBuilder"), exports);
+__exportStar(require("./queryResult"), exports);
+//# sourceMappingURL=index.js.map

package/dist/_cjs/query/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/query/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAwB;AACxB,8CAA2B;AAC3B,iDAA8B;AAC9B,gDAA6B"}

package/dist/_cjs/query/predicate.d.ts

@@ -0,0 +1,111 @@
+export type PredicateType = "eq" | "neq" | "gt" | "gte" | "lt" | "lte" | "not";
+export type PredicateContainerType = "or" | "and";
+export type Predicate = {
+    type: PredicateType;
+    key: string;
+    value: string | number;
+} | {
+    type: PredicateContainerType;
+    predicates: Predicate[];
+};
+/**
+ * Creates an OR predicate
+ * @param predicates - The predicates to combine
+ * @returns The OR predicate
+ *
+ * @example
+ * const predicates = [eq("name", "John"), eq("age", 30)]
+ * const result = or(predicates)
+ * // result = { type: "or", predicates: [eq("name", "John"), eq("age", 30)] }
+ *
+ */
+export declare function or(predicates: Predicate[]): Predicate;
+/**
+ * Creates an AND predicate
+ * @param predicates - The predicates to combine
+ * @returns The AND predicate
+ *
+ * @example
+ * const predicates = [eq("name", "John"), eq("age", 30)]
+ * const result = and(predicates)
+ * // result = { type: "and", predicates: [eq("name", "John"), eq("age", 30)] }
+ *
+ */
+export declare function and(predicates: Predicate[]): Predicate;
+/**
+ * Creates an equality predicate
+ * @param key - The key to compare
+ * @param value - The value to compare
+ * @returns The equality predicate
+ *
+ * @example
+ * const predicate = eq("name", "John")
+ * // result = { type: "eq", key: "name", value: "John" }
+ */
+export declare function eq(key: string, value: string | number): Predicate;
+/**
+ * Creates a not equal predicate
+ * @param key - The key to compare
+ * @param value - The value to compare
+ * @returns The not equal predicate
+ *
+ * @example
+ * const predicate = neq("name", "John")
+ * // result = { type: "neq", key: "name", value: "John" }
+ */
+export declare function neq(key: string, value: string | number): Predicate;
+/**
+ * Creates a greater than predicate
+ * @param key - The key to compare
+ * @param value - The value to compare
+ * @returns The greater than predicate
+ *
+ * @example
+ * const predicate = gt("name", "John")
+ * // result = { type: "gt", key: "name", value: "John" }
+ */
+export declare function gt(key: string, value: string | number): Predicate;
+/**
+ * Creates a greater than or equal predicate
+ * @param key - The key to compare
+ * @param value - The value to compare
+ * @returns The greater than or equal predicate
+ *
+ * @example
+ * const predicate = gte("name", "John")
+ * // result = { type: "gte", key: "name", value: "John" }
+ */
+export declare function gte(key: string, value: string | number): Predicate;
+/**
+ * Creates a less than predicate
+ * @param key - The key to compare
+ * @param value - The value to compare
+ * @returns The less than predicate
+ *
+ * @example
+ * const predicate = lt("name", "John")
+ * // result = { type: "lt", key: "name", value: "John" }
+ */
+export declare function lt(key: string, value: string | number): Predicate;
+/**
+ * Creates a less than or equal predicate
+ * @param key - The key to compare
+ * @param value - The value to compare
+ * @returns The less than or equal predicate
+ *
+ * @example
+ * const predicate = lte("name", "John")
+ * // result = { type: "lte", key: "name", value: "John" }
+ */
+export declare function lte(key: string, value: string | number): Predicate;
+/**
+ * Creates a not predicate
+ * @param key - The key to compare
+ * @returns The not predicate
+ *
+ * @example
+ * const predicate = not("name")
+ * // result = { type: "not", key: "name", value: "" }
+ */
+export declare function not(key: string): Predicate;
+//# sourceMappingURL=predicate.d.ts.map

package/dist/_cjs/query/predicate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"predicate.d.ts","sourceRoot":"","sources":["../../../src/query/predicate.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,KAAK,GAAG,KAAK,CAAA;AAC9E,MAAM,MAAM,sBAAsB,GAAG,IAAI,GAAG,KAAK,CAAA;AAEjD,MAAM,MAAM,SAAS,GAClB;IACA,IAAI,EAAE,aAAa,CAAA;IACnB,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;CACrB,GACD;IACA,IAAI,EAAE,sBAAsB,CAAA;IAC5B,UAAU,EAAE,SAAS,EAAE,CAAA;CACtB,CAAA;AAEJ;;;;;;;;;;GAUG;AACH,wBAAgB,EAAE,CAAC,UAAU,EAAE,SAAS,EAAE,GAAG,SAAS,CAErD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,GAAG,CAAC,UAAU,EAAE,SAAS,EAAE,GAAG,SAAS,CAEtD;AAED;;;;;;;;;GASG;AACH,wBAAgB,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAEjE;AAED;;;;;;;;;GASG;AACH,wBAAgB,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAElE;AAED;;;;;;;;;GASG;AACH,wBAAgB,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAEjE;AAED;;;;;;;;;GASG;AACH,wBAAgB,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAElE;AAED;;;;;;;;;GASG;AACH,wBAAgB,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAEjE;AAED;;;;;;;;;GASG;AACH,wBAAgB,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAElE;AAED;;;;;;;;GAQG;AACH,wBAAgB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAE1C"}