@arkiv-network/sdk 0.0.36-dev.6 → 0.1.1-dev.0

package/dist/queryBuilder-D38MYG7o.d.ts

@@ -0,0 +1,320 @@
+import { i as MimeType, t as Entity } from "./entity-CMRcjXBK.js";
+import { Account, Chain, Client, Hex, RpcSchema, Transport } from "viem";
+
+//#region src/types/rpcSchema.d.ts
+type RpcEntity = {
+  key: Hex;
+  contentType: MimeType;
+  value: string;
+  expiresAt: bigint;
+  owner: Hex;
+  stringAttributes?: [{
+    key: string;
+    value: string;
+  }];
+  numericAttributes?: [{
+    key: string;
+    value: number;
+  }];
+};
+type RpcQueryOptions = {
+  atBlock?: number;
+  includeData?: RpcIncludeData;
+  resultsPerPage?: number;
+  cursor?: string;
+};
+type RpcIncludeData = {
+  key: boolean;
+  attributes: boolean;
+  payload: boolean;
+  contentType: boolean;
+  expiration: boolean;
+  owner: boolean;
+};
+type ArkivRpcSchema = [{
+  Method: "golembase_getStorageValue";
+  Parameters?: [entityId: Hex];
+  ReturnType: string;
+}, {
+  Method: "arkiv_query";
+  Parameters?: [query: string, queryOptions?: RpcQueryOptions];
+  ReturnType: {
+    data: [RpcEntity];
+    blockNumber: bigint;
+    cursor: string;
+  };
+}, {
+  Method: "arkiv_getBlockTiming";
+  Parameters?: [];
+  ReturnType: {
+    current_block: bigint;
+    current_block_time: number;
+    duration: number;
+  };
+}, {
+  Method: "arkiv_getEntityCount";
+  Parameters?: [];
+  ReturnType: number;
+}];
+//#endregion
+//#region src/clients/baseClient.d.ts
+type ArkivClient<transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined, accountOrAddress extends Account | undefined = Account | undefined, rpcSchema extends RpcSchema | undefined = ArkivRpcSchema> = Client<transport, chain, accountOrAddress, rpcSchema>;
+//#endregion
+//#region src/query/predicate.d.ts
+type PredicateType = "eq" | "neq" | "gt" | "gte" | "lt" | "lte" | "not";
+type PredicateContainerType = "or" | "and";
+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)] }
+ *
+ */
+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)] }
+ *
+ */
+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" }
+ */
+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" }
+ */
+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" }
+ */
+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" }
+ */
+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" }
+ */
+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" }
+ */
+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: "" }
+ */
+declare function not(key: string): Predicate;
+//#endregion
+//#region src/query/queryResult.d.ts
+declare class QueryResult {
+  entities: Entity[];
+  private _endOfIteration;
+  private _cursor;
+  private _limit;
+  private _validAtBlock;
+  private _queryBuilder;
+  get queryBuilder(): QueryBuilder;
+  get cursor(): string | undefined;
+  constructor(entities: Entity[], queryBuilder: QueryBuilder, cursor: string | undefined, limit: number | undefined, validAtBlock: bigint | undefined);
+  next(): Promise<void>;
+  hasNextPage(): boolean;
+}
+//#endregion
+//#region src/query/queryBuilder.d.ts
+/**
+ * QueryBuilder is a helper class to build queries to the Arkiv DBChains.
+ * It can be used to fetch entities from the Arkiv DBChains. It follows the Builder pattern allowing chaining of methods.
+ * @param client - The Arkiv client
+ * @returns The QueryBuilder instance {@link QueryBuilder}
+ */
+declare class QueryBuilder {
+  private _client;
+  private _ownedBy;
+  private _validAtBlock;
+  private _withAttributes;
+  private _withMetadata;
+  private _withPayload;
+  private _limit;
+  private _cursor;
+  private _predicates;
+  constructor(client: ArkivClient);
+  /**
+   * Sets the ownedBy filter
+   * @param ownedBy - The address of the owner
+   * @returns The QueryBuilder instance
+   *
+   * @example
+   * const builder = new QueryBuilder(client)
+   * builder.ownedBy("0x1234567890123456789012345678901234567890")
+   */
+  ownedBy(ownedBy: Hex): this;
+  /**
+   * Sets the withAttributes flag which will return the attributes for the entities if true
+   * @param withAttributes - The boolean value to set
+   * @returns The QueryBuilder instance
+   *
+   * @example
+   * const builder = new QueryBuilder(client)
+   * builder.withAttributes(true)
+   */
+  withAttributes(withAttributes?: boolean): this;
+  /**
+   * Sets the withMetadata flag which will return the metadata (like owner, expiredAt, etc.) for the entities if true
+   * @param withMetadata - The boolean value to set
+   * @returns The QueryBuilder instance
+   *
+   * @example
+   * const builder = new QueryBuilder(client)
+   * builder.withMetadata(true)
+   */
+  withMetadata(withMetadata?: boolean): this;
+  /**
+   * Sets the withPayload flag which will return the payload for the entities if true
+   * @param withPayload - The boolean value to set
+   * @returns The QueryBuilder instance
+   *
+   * @example
+   * const builder = new QueryBuilder(client)
+   * builder.withPayload(true)
+   */
+  withPayload(withPayload?: boolean): this;
+  /**
+   * Sets the limit for the query
+   * @param limit - The number of entities to return
+   * @returns The QueryBuilder instance
+   *
+   * @example
+   * const builder = new QueryBuilder(client)
+   * builder.limit(10)
+   */
+  limit(limit: number): this;
+  /**
+   * Sets the cursor for the query - it is advances setting which rather shouldn't be used manually but it is provided from query result if limit is used (pagination).
+   * @param cursor - The cursor to set which tells to RPC Query server where to start or continue the query.
+   * @returns The QueryBuilder instance
+   *
+   * @example
+   * const builder = new QueryBuilder(client)
+   * builder.offset(10)
+   */
+  cursor(cursor: string): this;
+  /**
+   * Sets the validAtBlock for the query which tells at which block height the state we are intested.
+   * If not set, the latest block is  used.
+   * @param validAtBlock - The block number to set
+   * @returns The QueryBuilder instance
+   *
+   * @example
+   * const builder = new QueryBuilder(client)
+   * builder.validAtBlock(10000)
+   */
+  validAtBlock(validAtBlock: bigint): this;
+  /**
+   * Sets the predicates for the query limiting the results. It can be a single predicate or an array of predicates combined with 'and'.
+   * Predicates can be nested using 'or' and 'and' predicates.
+   * @param predicates - The predicates to set
+   * @returns The QueryBuilder instance
+   *
+   * @example
+   * const builder = new QueryBuilder(client)
+   * builder.where(eq("name", "John"))
+   * builder.where([eq("name", "John"), eq("age", 30)])
+   * builder.where([eq("name", "John"), or([eq("age", 30), eq("age", 31)])])
+   * builder.where([eq("name", "John"), and([eq("age", 30), eq("age", 31)])])
+   * builder.where([eq("name", "John"), or([eq("age", 30), and([eq("age", 31), eq("age", 32)])])])
+   * builder.where([eq("name", "John"), and([eq("age", 30), or([eq("age", 31), eq("age", 32)])])])
+   * builder.where([eq("name", "John"), and([eq("age", 30), or([eq("age", 31), and([eq("age", 32), eq("age", 33)])])])])
+   */
+  where(predicates: Predicate[] | Predicate): this;
+  /**
+   * Fetches the entities from the query. Re
+   * It will return a QueryResult instance which can be used to fetch the next and previous pages.
+   * @returns The QueryResult instance {@link QueryResult}
+   *
+   * @example
+   * const builder = new QueryBuilder(client)
+   * const result = await builder.where(eq("name", "John")).fetch()
+   * // result = { entities: [Entity, Entity, Entity], next: async () => QueryResult, previous: async () => QueryResult }
+   */
+  fetch(): Promise<QueryResult>;
+  /**
+   * Counts the entities from the query.
+   * @returns The number of entities
+   *
+   * @example
+   * const builder = new QueryBuilder(client)
+   * const result = await builder.where(eq("name", "John")).count()
+   * // result = 10
+   */
+  count(): Promise<1>;
+}
+//#endregion
+export { PredicateType as a, gt as c, lte as d, neq as f, ArkivRpcSchema as g, ArkivClient as h, PredicateContainerType as i, gte as l, or as m, QueryResult as n, and as o, not as p, Predicate as r, eq as s, QueryBuilder as t, lt as u };
+//# sourceMappingURL=queryBuilder-D38MYG7o.d.ts.map

package/dist/queryBuilder-D38MYG7o.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryBuilder-D38MYG7o.d.ts","names":[],"sources":["../src/types/rpcSchema.ts","../src/clients/baseClient.ts","../src/query/predicate.ts","../src/query/queryResult.ts","../src/query/queryBuilder.ts"],"sourcesContent":[],"mappings":";;;;KAGY,SAAA;OACL;EADK,WAAA,EAEG,QAFM;EACd,KAAA,EAAA,MAAA;EACQ,SAAA,EAAA,MAAA;EAGN,KAAA,EAAA,GAAA;EAAG,gBAAA,CAAA,EAAA,CAAA;IAKA,GAAA,EAAA,MAAA;IAOA,KAAA,EAAA,MAAc;EASd,CAAA,CAAA;EAGgB,iBAAA,CAAA,EAAA,CAAA;IAKoB,GAAA,EAAA,MAAA;IAEnC,KAAA,EAAA,MAAA;EAAS,CAAA,CAAA;;KA1BV,eAAA;;ECVA,WAAA,CAAA,EDYI,cCZO;EACH,cAAA,CAAA,EAAA,MAAA;EAAY,MAAA,CAAA,EAAA,MAAA;CAChB;AAAoB,KDexB,cAAA,GCfwB;EACT,GAAA,EAAA,OAAA;EAAsB,UAAA,EAAA,OAAA;EAC7B,OAAA,EAAA,OAAA;EAAwB,WAAA,EAAA,OAAA;EACjC,UAAA,EAAA,OAAA;EAAW,KAAA,EAAA,OAAA;CAAO;AAAkB,KDqBnC,cAAA,GCrBmC,CAA3C;EAAM,MAAA,EAAA,2BAAA;0BDwBkB;;GEhChB;EACA,MAAA,EAAA,aAAsB;EAEtB,UAAS,CAAA,EAAA,CAAA,KAAA,EAAA,MAAA,EAAA,YAAA,GFkC2B,eElC3B,CAAA;EAET,UAAA,EAAA;IAKA,IAAA,EAAA,CF6BC,SE7BD,CAAA;IACM,WAAA,EAAA,MAAA;IAAS,MAAA,EAAA,MAAA;EAcX,CAAE;AAeF,CAAA,EAcA;EAcA,MAAG,EAAA,sBAAgD;EAcnD,UAAE,CAAA,EAAuC,EAAA;EAczC,UAAG,EAAA;IAcD,aAAuC,EAAA,MAAS;IAc/C,kBAAuC,EAAS,MAAA;IAahD,QAAA,EAAe,MAAA;;;ECrIrB,MAAA,EAAA,sBAAW;EACZ,UAAA,CAAA,EAAA,EAAA;EAQU,UAAA,EAAA,MAAA;AASR,CAAA,CACI;;;KFpBN,8BACQ,YAAY,yBAChB,oBAAoB,4CACT,sBAAsB,uCAC7B,wBAAwB,kBACxC,OAAO,WAAW,OAAO,kBAAkB;;;KCRnC,aAAA;KACA,sBAAA;KAEA,SAAA;QAEA;EFFA,GAAA,EAAA,MAAA;EACL,KAAA,EAAA,MAAA,GAAA,MAAA;CACQ,GAAA;EAGN,IAAA,EEEG,sBFFH;EAAG,UAAA,EEGM,SFHN,EAAA;AAKZ,CAAA;AAOA;AASA;;;;;;;;AC1BA;;AACgC,iBCqBhB,EAAA,CDrBgB,UAAA,ECqBD,SDrBC,EAAA,CAAA,ECqBa,SDrBb;;;;;;;;;;;;AAItB,iBCgCM,GAAA,CDhCN,UAAA,ECgCsB,SDhCtB,EAAA,CAAA,ECgCoC,SDhCpC;;;;ACRV;AACA;AAEA;;;;;AAsBgB,iBA6BA,EAAA,CA7Be,GAAA,EAAc,MAAA,EAAA,KAAS,EAAA,MAAA,GAAA,MAAA,CAAA,EA6BG,SA7BH;AAetD;AAcA;AAcA;AAcA;AAcA;AAcA;AAcA;AAaA;;;iBArEgB,GAAA,uCAA0C;AChE1D;;;;;;;;;;ACSa,iBFqEG,EAAA,CErES,GAAA,EAAA,MAAA,EAAA,KAAA,EAAA,MAAA,GAAA,MAAA,CAAA,EFqEgC,SErEhC;;;;;;;;;;;iBFmFT,GAAA,uCAA0C;;;;;;;;;;;iBAc1C,EAAA,uCAAyC;;;;;;;;;;;iBAczC,GAAA,uCAA0C;;;;;;;;;;iBAa1C,GAAA,eAAkB;;;cCrIrB,WAAA;YACD;EHFA,QAAA,eAAS;EACd,QAAA,OAAA;EACQ,QAAA,MAAA;EAGN,QAAA,aAAA;EAAG,QAAA,aAAA;EAKA,IAAA,YAAA,CAAA,CAAe,EGAL,YHEN;EAKJ,IAAA,MAAA,CAAA,CAAA,EAAA,MAAc,GAAA,SAAA;EASd,WAAA,CAAA,QAAc,EGPZ,MHOY,EAAA,EAAA,YAAA,EGNR,YHMQ,EAAA,MAAA,EAAA,MAAA,GAAA,SAAA,EAAA,KAAA,EAAA,MAAA,GAAA,SAAA,EAAA,YAAA,EAAA,MAAA,GAAA,SAAA;EAGE,IAAA,CAAA,CAAA,EGIhB,OHJgB,CAAA,IAAA,CAAA;EAKoB,WAAA,CAAA,CAAA,EAAA,OAAA;;;;AAlChD;;;;;AAUA;AAOY,cIPC,YAAA,CJOa;EASd,QAAA,OAAA;EAGgB,QAAA,QAAA;EAKoB,QAAA,aAAA;EAEnC,QAAA,eAAA;EAAS,QAAA,aAAA;;;;ECpCV,QAAA,WAAW;EACH,WAAA,CAAA,MAAA,EGoBE,WHpBF;EAAY;;;;;;;;;EAIH,OAAA,CAAA,OAAA,EG8BV,GH9BU,CAAA,EAAA,IAAA;EAAkB;;;;;;ACR/C;AACA;AAEA;EAEY,cAAA,CAAA,cAAA,CAAA,EAAA,OAAA,CAAA,EAAA,IAAA;EAKA;;;AAeZ;AAeA;AAcA;AAcA;AAcA;AAcA;EAcgB,YAAE,CAAA,YAAgD,CAAT,EAAS,OAAA,CAAA,EAAA,IAAA;EAclD;AAahB;;;;ACrIA;;;;EAmBkB,WAAA,CAAA,WAAA,CAAA,EAAA,OAAA,CAAA,EAAA,IAAA;EAaN;;;;;ACvBZ;;;;EAmIkC,KAAA,CAAA,KAAA,EAAA,MAAA,CAAA,EAAA,IAAA;EAmBrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBAnBO,cAAc;;;;;;;;;;;WAmBrB,QAAA;;;;;;;;;;WA+BA"}

package/dist/queryBuilder-DU4RQa7H.d.cts

@@ -0,0 +1,320 @@
+import { i as MimeType, t as Entity } from "./entity-Dgf1SSpi.cjs";
+import { Account, Chain, Client, Hex, RpcSchema, Transport } from "viem";
+
+//#region src/types/rpcSchema.d.ts
+type RpcEntity = {
+  key: Hex;
+  contentType: MimeType;
+  value: string;
+  expiresAt: bigint;
+  owner: Hex;
+  stringAttributes?: [{
+    key: string;
+    value: string;
+  }];
+  numericAttributes?: [{
+    key: string;
+    value: number;
+  }];
+};
+type RpcQueryOptions = {
+  atBlock?: number;
+  includeData?: RpcIncludeData;
+  resultsPerPage?: number;
+  cursor?: string;
+};
+type RpcIncludeData = {
+  key: boolean;
+  attributes: boolean;
+  payload: boolean;
+  contentType: boolean;
+  expiration: boolean;
+  owner: boolean;
+};
+type ArkivRpcSchema = [{
+  Method: "golembase_getStorageValue";
+  Parameters?: [entityId: Hex];
+  ReturnType: string;
+}, {
+  Method: "arkiv_query";
+  Parameters?: [query: string, queryOptions?: RpcQueryOptions];
+  ReturnType: {
+    data: [RpcEntity];
+    blockNumber: bigint;
+    cursor: string;
+  };
+}, {
+  Method: "arkiv_getBlockTiming";
+  Parameters?: [];
+  ReturnType: {
+    current_block: bigint;
+    current_block_time: number;
+    duration: number;
+  };
+}, {
+  Method: "arkiv_getEntityCount";
+  Parameters?: [];
+  ReturnType: number;
+}];
+//#endregion
+//#region src/clients/baseClient.d.ts
+type ArkivClient<transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined, accountOrAddress extends Account | undefined = Account | undefined, rpcSchema extends RpcSchema | undefined = ArkivRpcSchema> = Client<transport, chain, accountOrAddress, rpcSchema>;
+//#endregion
+//#region src/query/predicate.d.ts
+type PredicateType = "eq" | "neq" | "gt" | "gte" | "lt" | "lte" | "not";
+type PredicateContainerType = "or" | "and";
+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)] }
+ *
+ */
+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)] }
+ *
+ */
+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" }
+ */
+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" }
+ */
+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" }
+ */
+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" }
+ */
+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" }
+ */
+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" }
+ */
+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: "" }
+ */
+declare function not(key: string): Predicate;
+//#endregion
+//#region src/query/queryResult.d.ts
+declare class QueryResult {
+  entities: Entity[];
+  private _endOfIteration;
+  private _cursor;
+  private _limit;
+  private _validAtBlock;
+  private _queryBuilder;
+  get queryBuilder(): QueryBuilder;
+  get cursor(): string | undefined;
+  constructor(entities: Entity[], queryBuilder: QueryBuilder, cursor: string | undefined, limit: number | undefined, validAtBlock: bigint | undefined);
+  next(): Promise<void>;
+  hasNextPage(): boolean;
+}
+//#endregion
+//#region src/query/queryBuilder.d.ts
+/**
+ * QueryBuilder is a helper class to build queries to the Arkiv DBChains.
+ * It can be used to fetch entities from the Arkiv DBChains. It follows the Builder pattern allowing chaining of methods.
+ * @param client - The Arkiv client
+ * @returns The QueryBuilder instance {@link QueryBuilder}
+ */
+declare class QueryBuilder {
+  private _client;
+  private _ownedBy;
+  private _validAtBlock;
+  private _withAttributes;
+  private _withMetadata;
+  private _withPayload;
+  private _limit;
+  private _cursor;
+  private _predicates;
+  constructor(client: ArkivClient);
+  /**
+   * Sets the ownedBy filter
+   * @param ownedBy - The address of the owner
+   * @returns The QueryBuilder instance
+   *
+   * @example
+   * const builder = new QueryBuilder(client)
+   * builder.ownedBy("0x1234567890123456789012345678901234567890")
+   */
+  ownedBy(ownedBy: Hex): this;
+  /**
+   * Sets the withAttributes flag which will return the attributes for the entities if true
+   * @param withAttributes - The boolean value to set
+   * @returns The QueryBuilder instance
+   *
+   * @example
+   * const builder = new QueryBuilder(client)
+   * builder.withAttributes(true)
+   */
+  withAttributes(withAttributes?: boolean): this;
+  /**
+   * Sets the withMetadata flag which will return the metadata (like owner, expiredAt, etc.) for the entities if true
+   * @param withMetadata - The boolean value to set
+   * @returns The QueryBuilder instance
+   *
+   * @example
+   * const builder = new QueryBuilder(client)
+   * builder.withMetadata(true)
+   */
+  withMetadata(withMetadata?: boolean): this;
+  /**
+   * Sets the withPayload flag which will return the payload for the entities if true
+   * @param withPayload - The boolean value to set
+   * @returns The QueryBuilder instance
+   *
+   * @example
+   * const builder = new QueryBuilder(client)
+   * builder.withPayload(true)
+   */
+  withPayload(withPayload?: boolean): this;
+  /**
+   * Sets the limit for the query
+   * @param limit - The number of entities to return
+   * @returns The QueryBuilder instance
+   *
+   * @example
+   * const builder = new QueryBuilder(client)
+   * builder.limit(10)
+   */
+  limit(limit: number): this;
+  /**
+   * Sets the cursor for the query - it is advances setting which rather shouldn't be used manually but it is provided from query result if limit is used (pagination).
+   * @param cursor - The cursor to set which tells to RPC Query server where to start or continue the query.
+   * @returns The QueryBuilder instance
+   *
+   * @example
+   * const builder = new QueryBuilder(client)
+   * builder.offset(10)
+   */
+  cursor(cursor: string): this;
+  /**
+   * Sets the validAtBlock for the query which tells at which block height the state we are intested.
+   * If not set, the latest block is  used.
+   * @param validAtBlock - The block number to set
+   * @returns The QueryBuilder instance
+   *
+   * @example
+   * const builder = new QueryBuilder(client)
+   * builder.validAtBlock(10000)
+   */
+  validAtBlock(validAtBlock: bigint): this;
+  /**
+   * Sets the predicates for the query limiting the results. It can be a single predicate or an array of predicates combined with 'and'.
+   * Predicates can be nested using 'or' and 'and' predicates.
+   * @param predicates - The predicates to set
+   * @returns The QueryBuilder instance
+   *
+   * @example
+   * const builder = new QueryBuilder(client)
+   * builder.where(eq("name", "John"))
+   * builder.where([eq("name", "John"), eq("age", 30)])
+   * builder.where([eq("name", "John"), or([eq("age", 30), eq("age", 31)])])
+   * builder.where([eq("name", "John"), and([eq("age", 30), eq("age", 31)])])
+   * builder.where([eq("name", "John"), or([eq("age", 30), and([eq("age", 31), eq("age", 32)])])])
+   * builder.where([eq("name", "John"), and([eq("age", 30), or([eq("age", 31), eq("age", 32)])])])
+   * builder.where([eq("name", "John"), and([eq("age", 30), or([eq("age", 31), and([eq("age", 32), eq("age", 33)])])])])
+   */
+  where(predicates: Predicate[] | Predicate): this;
+  /**
+   * Fetches the entities from the query. Re
+   * It will return a QueryResult instance which can be used to fetch the next and previous pages.
+   * @returns The QueryResult instance {@link QueryResult}
+   *
+   * @example
+   * const builder = new QueryBuilder(client)
+   * const result = await builder.where(eq("name", "John")).fetch()
+   * // result = { entities: [Entity, Entity, Entity], next: async () => QueryResult, previous: async () => QueryResult }
+   */
+  fetch(): Promise<QueryResult>;
+  /**
+   * Counts the entities from the query.
+   * @returns The number of entities
+   *
+   * @example
+   * const builder = new QueryBuilder(client)
+   * const result = await builder.where(eq("name", "John")).count()
+   * // result = 10
+   */
+  count(): Promise<1>;
+}
+//#endregion
+export { PredicateType as a, gt as c, lte as d, neq as f, ArkivRpcSchema as g, ArkivClient as h, PredicateContainerType as i, gte as l, or as m, QueryResult as n, and as o, not as p, Predicate as r, eq as s, QueryBuilder as t, lt as u };
+//# sourceMappingURL=queryBuilder-DU4RQa7H.d.cts.map

package/dist/queryBuilder-DU4RQa7H.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryBuilder-DU4RQa7H.d.cts","names":[],"sources":["../src/types/rpcSchema.ts","../src/clients/baseClient.ts","../src/query/predicate.ts","../src/query/queryResult.ts","../src/query/queryBuilder.ts"],"sourcesContent":[],"mappings":";;;;KAGY,SAAA;OACL;EADK,WAAA,EAEG,QAFM;EACd,KAAA,EAAA,MAAA;EACQ,SAAA,EAAA,MAAA;EAGN,KAAA,EAAA,GAAA;EAAG,gBAAA,CAAA,EAAA,CAAA;IAKA,GAAA,EAAA,MAAA;IAOA,KAAA,EAAA,MAAc;EASd,CAAA,CAAA;EAGgB,iBAAA,CAAA,EAAA,CAAA;IAKoB,GAAA,EAAA,MAAA;IAEnC,KAAA,EAAA,MAAA;EAAS,CAAA,CAAA;;KA1BV,eAAA;;ECVA,WAAA,CAAA,EDYI,cCZO;EACH,cAAA,CAAA,EAAA,MAAA;EAAY,MAAA,CAAA,EAAA,MAAA;CAChB;AAAoB,KDexB,cAAA,GCfwB;EACT,GAAA,EAAA,OAAA;EAAsB,UAAA,EAAA,OAAA;EAC7B,OAAA,EAAA,OAAA;EAAwB,WAAA,EAAA,OAAA;EACjC,UAAA,EAAA,OAAA;EAAW,KAAA,EAAA,OAAA;CAAO;AAAkB,KDqBnC,cAAA,GCrBmC,CAA3C;EAAM,MAAA,EAAA,2BAAA;0BDwBkB;;GEhChB;EACA,MAAA,EAAA,aAAsB;EAEtB,UAAS,CAAA,EAAA,CAAA,KAAA,EAAA,MAAA,EAAA,YAAA,GFkC2B,eElC3B,CAAA;EAET,UAAA,EAAA;IAKA,IAAA,EAAA,CF6BC,SE7BD,CAAA;IACM,WAAA,EAAA,MAAA;IAAS,MAAA,EAAA,MAAA;EAcX,CAAE;AAeF,CAAA,EAcA;EAcA,MAAG,EAAA,sBAAgD;EAcnD,UAAE,CAAA,EAAuC,EAAA;EAczC,UAAG,EAAA;IAcD,aAAuC,EAAA,MAAS;IAc/C,kBAAuC,EAAS,MAAA;IAahD,QAAA,EAAe,MAAA;;;ECrIrB,MAAA,EAAA,sBAAW;EACZ,UAAA,CAAA,EAAA,EAAA;EAQU,UAAA,EAAA,MAAA;AASR,CAAA,CACI;;;KFpBN,8BACQ,YAAY,yBAChB,oBAAoB,4CACT,sBAAsB,uCAC7B,wBAAwB,kBACxC,OAAO,WAAW,OAAO,kBAAkB;;;KCRnC,aAAA;KACA,sBAAA;KAEA,SAAA;QAEA;EFFA,GAAA,EAAA,MAAA;EACL,KAAA,EAAA,MAAA,GAAA,MAAA;CACQ,GAAA;EAGN,IAAA,EEEG,sBFFH;EAAG,UAAA,EEGM,SFHN,EAAA;AAKZ,CAAA;AAOA;AASA;;;;;;;;AC1BA;;AACgC,iBCqBhB,EAAA,CDrBgB,UAAA,ECqBD,SDrBC,EAAA,CAAA,ECqBa,SDrBb;;;;;;;;;;;;AAItB,iBCgCM,GAAA,CDhCN,UAAA,ECgCsB,SDhCtB,EAAA,CAAA,ECgCoC,SDhCpC;;;;ACRV;AACA;AAEA;;;;;AAsBgB,iBA6BA,EAAA,CA7Be,GAAA,EAAc,MAAA,EAAA,KAAS,EAAA,MAAA,GAAA,MAAA,CAAA,EA6BG,SA7BH;AAetD;AAcA;AAcA;AAcA;AAcA;AAcA;AAcA;AAaA;;;iBArEgB,GAAA,uCAA0C;AChE1D;;;;;;;;;;ACSa,iBFqEG,EAAA,CErES,GAAA,EAAA,MAAA,EAAA,KAAA,EAAA,MAAA,GAAA,MAAA,CAAA,EFqEgC,SErEhC;;;;;;;;;;;iBFmFT,GAAA,uCAA0C;;;;;;;;;;;iBAc1C,EAAA,uCAAyC;;;;;;;;;;;iBAczC,GAAA,uCAA0C;;;;;;;;;;iBAa1C,GAAA,eAAkB;;;cCrIrB,WAAA;YACD;EHFA,QAAA,eAAS;EACd,QAAA,OAAA;EACQ,QAAA,MAAA;EAGN,QAAA,aAAA;EAAG,QAAA,aAAA;EAKA,IAAA,YAAA,CAAA,CAAe,EGAL,YHEN;EAKJ,IAAA,MAAA,CAAA,CAAA,EAAA,MAAc,GAAA,SAAA;EASd,WAAA,CAAA,QAAc,EGPZ,MHOY,EAAA,EAAA,YAAA,EGNR,YHMQ,EAAA,MAAA,EAAA,MAAA,GAAA,SAAA,EAAA,KAAA,EAAA,MAAA,GAAA,SAAA,EAAA,YAAA,EAAA,MAAA,GAAA,SAAA;EAGE,IAAA,CAAA,CAAA,EGIhB,OHJgB,CAAA,IAAA,CAAA;EAKoB,WAAA,CAAA,CAAA,EAAA,OAAA;;;;AAlChD;;;;;AAUA;AAOY,cIPC,YAAA,CJOa;EASd,QAAA,OAAA;EAGgB,QAAA,QAAA;EAKoB,QAAA,aAAA;EAEnC,QAAA,eAAA;EAAS,QAAA,aAAA;;;;ECpCV,QAAA,WAAW;EACH,WAAA,CAAA,MAAA,EGoBE,WHpBF;EAAY;;;;;;;;;EAIH,OAAA,CAAA,OAAA,EG8BV,GH9BU,CAAA,EAAA,IAAA;EAAkB;;;;;;ACR/C;AACA;AAEA;EAEY,cAAA,CAAA,cAAA,CAAA,EAAA,OAAA,CAAA,EAAA,IAAA;EAKA;;;AAeZ;AAeA;AAcA;AAcA;AAcA;AAcA;EAcgB,YAAE,CAAA,YAAgD,CAAT,EAAS,OAAA,CAAA,EAAA,IAAA;EAclD;AAahB;;;;ACrIA;;;;EAmBkB,WAAA,CAAA,WAAA,CAAA,EAAA,OAAA,CAAA,EAAA,IAAA;EAaN;;;;;ACvBZ;;;;EAmIkC,KAAA,CAAA,KAAA,EAAA,MAAA,CAAA,EAAA,IAAA;EAmBrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBAnBO,cAAc;;;;;;;;;;;WAmBrB,QAAA;;;;;;;;;;WA+BA"}