@arkiv-network/sdk 0.3.1 → 0.3.2-dev.1

package/dist/{queryBuilder-DU4RQa7H.d.cts → queryBuilder-DkhyyeFr.d.cts}

@@ -1,65 +1,6 @@
-import { i as MimeType, t as Entity } from "./entity-Dgf1SSpi.cjs";
-import { Account, Chain, Client, Hex, RpcSchema, Transport } from "viem";
+import { g as ArkivClient, t as Entity } from "./entity-jTQZmEAd.cjs";
+import { Hex } 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";
@@ -197,6 +138,7 @@ declare class QueryResult {
 declare class QueryBuilder {
   private _client;
   private _ownedBy;
+  private _orderBy;
   private _validAtBlock;
   private _withAttributes;
   private _withMetadata;
@@ -215,6 +157,20 @@ declare class QueryBuilder {
    * builder.ownedBy("0x1234567890123456789012345678901234567890")
    */
   ownedBy(ownedBy: Hex): this;
+  /**
+   * Sets the orderBy for the query.
+   * It can be called multiple times to order by multiple attributes.
+   * The order of the attributes is important. The first attribute is the primary order by attribute.
+   * @param attributeName - The name of the attribute to order by
+   * @param attributeType - The type of the attribute to order by (string or number)
+   * @param descending - The boolean value to set the order by descending
+   * @returns The QueryBuilder instance
+   *
+   * @example
+   * const builder = new QueryBuilder(client)
+   * builder.orderBy("name", "string", true)
+   */
+  orderBy(attributeName: string, attributeType: "string" | "number", descending?: boolean | undefined): this;
   /**
    * Sets the withAttributes flag which will return the attributes for the entities if true
    * @param withAttributes - The boolean value to set
@@ -316,5 +272,5 @@ declare class QueryBuilder {
   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
+export { PredicateType as a, gt as c, lte as d, neq as f, 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-DkhyyeFr.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"queryBuilder-DkhyyeFr.d.cts","names":[],"sources":["../src/query/predicate.ts","../src/query/queryResult.ts","../src/query/queryBuilder.ts"],"sourcesContent":[],"mappings":";;;;KAAY,aAAA;KACA,sBAAA;KAEA,SAAA;QAEA;EALA,GAAA,EAAA,MAAA;EACA,KAAA,EAAA,MAAA,GAAA,MAAA;AAEZ,CAAA,GAAY;EAEA,IAAA,EAKA,sBALA;EAKA,UAAA,EACM,SADN,EAAA;CACM;;AAclB;AAeA;AAcA;AAcA;AAcA;AAcA;AAcA;AAcA;AAaA;;iBAhHgB,EAAA,aAAe,cAAc;;ACrB7C;;;;;;;;;;ACUa,iBF0BG,GAAA,CE1BS,UAAA,EF0BO,SE1BP,EAAA,CAAA,EF0BqB,SE1BrB;;;;;;;;;;;iBFwCT,EAAA,uCAAyC;;;;;;;;;;;iBAczC,GAAA,uCAA0C;;;;;;;;;;;iBAc1C,EAAA,uCAAyC;;;;;;;;;;;iBAczC,GAAA,uCAA0C;;;;;;;;;;;iBAc1C,EAAA,uCAAyC;;;;;;;;;;;iBAczC,GAAA,uCAA0C;;;;;;;;;;iBAa1C,GAAA,eAAkB;;;cCrIrB,WAAA;YACD;EDLA,QAAA,eAAa;EACb,QAAA,OAAA;EAEA,QAAA,MAAS;EAET,QAAA,aAAA;EAKA,QAAA,aAAA;EACM,IAAA,YAAA,CAAA,CAAA,ECEI,YDFJ;EAAS,IAAA,MAAA,CAAA,CAAA,EAAA,MAAA,GAAA,SAAA;EAcX,WAAE,CAAA,QAAa,ECHjB,MDG+B,EAAA,EAAA,YAAS,ECFpC,YDEoC,EAAA,MAAA,EAAA,MAAA,GAAA,SAAA,EAAA,KAAA,EAAA,MAAA,GAAA,SAAA,EAAA,YAAA,EAAA,MAAA,GAAA,SAAA;EAetC,IAAA,CAAA,CAAG,ECJP,ODIO,CAAA,IAAa,CAAA;EAchB,WAAE,CAAA,CAAA,EAAA,OAAuC;AAczD;;;AApEA;AACA;AAEA;;;;AAQ2B,cEGd,YAAA,CFHc;EAcX,QAAE,OAAA;EAeF,QAAG,QAAA;EAcH,QAAE,QAAA;EAcF,QAAG,aAAuC;EAc1C,QAAE,eAAuC;EAczC,QAAG,aAAuC;EAc1C,QAAE,YAAuC;EAczC,QAAG,MAAA;EAaH,QAAG,OAAA;;sBE/GG;;ADtBtB;;;;;;;;mBCoCmB;;AA1BnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBAiKoB,cAAc;;;;;;;;;;;WAmBrB,QAAA;;;;;;;;;;WAgCA"}

package/dist/types/index.d.cts

@@ -1,2 +1,2 @@
-import { i as MimeType, n as TxParams, r as Attribute, t as Entity } from "../entity-Dgf1SSpi.cjs";
-export { Attribute, Entity, MimeType, TxParams };
+import { _ as ArkivRpcSchema, a as MutateEntitiesReturnType, b as RpcQueryOptions, c as ExtendEntityParameters, d as DeleteEntityReturnType, f as CreateEntityParameters, h as ChangeOwnershipReturnType, i as MutateEntitiesParameters, l as ExtendEntityReturnType, m as ChangeOwnershipParameters, n as TxParams, o as UpdateEntityParameters, p as CreateEntityReturnType, r as Attribute, s as UpdateEntityReturnType, t as Entity, u as DeleteEntityParameters, v as RpcEntity, x as MimeType, y as RpcIncludeData } from "../entity-jTQZmEAd.cjs";
+export { ArkivRpcSchema, Attribute, ChangeOwnershipParameters, ChangeOwnershipReturnType, CreateEntityParameters, CreateEntityReturnType, DeleteEntityParameters, DeleteEntityReturnType, Entity, ExtendEntityParameters, ExtendEntityReturnType, MimeType, MutateEntitiesParameters, MutateEntitiesReturnType, RpcEntity, RpcIncludeData, RpcQueryOptions, TxParams, UpdateEntityParameters, UpdateEntityReturnType };

package/dist/types/index.d.ts

@@ -1,2 +1,2 @@
-import { i as MimeType, n as TxParams, r as Attribute, t as Entity } from "../entity-CMRcjXBK.js";
-export { Attribute, Entity, MimeType, TxParams };
+import { _ as ArkivRpcSchema, a as MutateEntitiesReturnType, b as RpcQueryOptions, c as ExtendEntityParameters, d as DeleteEntityReturnType, f as CreateEntityParameters, h as ChangeOwnershipReturnType, i as MutateEntitiesParameters, l as ExtendEntityReturnType, m as ChangeOwnershipParameters, n as TxParams, o as UpdateEntityParameters, p as CreateEntityReturnType, r as Attribute, s as UpdateEntityReturnType, t as Entity, u as DeleteEntityParameters, v as RpcEntity, x as MimeType, y as RpcIncludeData } from "../entity-DvQtQL8v.js";
+export { ArkivRpcSchema, Attribute, ChangeOwnershipParameters, ChangeOwnershipReturnType, CreateEntityParameters, CreateEntityReturnType, DeleteEntityParameters, DeleteEntityReturnType, Entity, ExtendEntityParameters, ExtendEntityReturnType, MimeType, MutateEntitiesParameters, MutateEntitiesReturnType, RpcEntity, RpcIncludeData, RpcQueryOptions, TxParams, UpdateEntityParameters, UpdateEntityReturnType };

package/dist/utils/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/utils/expirationTime.ts","../../src/utils/payload.ts"],"sourcesContent":[],"mappings":";;;cAEa;;;EAAA,SAAA,EAAA,CAAA,KAUZ,EAAA,MAAA,EAAA,GADkB,MAAI;;;;ECTP,SAAA,EAAA,CAAA,KAAa,EAAA,MAAA,EAAgB,GAAA,MAAA;EAI7B,UAAA,EAAA,CAAA,MAAe,EAAA,MAAA,EAAgB,GAAA,MAAA;mBDK5B;;;;iBCTH,aAAA,gBAA6B;iBAI7B,eAAA,gBAA+B"}
+{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/utils/expirationTime.ts","../../src/utils/payload.ts"],"sourcesContent":[],"mappings":";;;cAEa;;;EAAA,SAAA,EAAA,CAAA,KAUZ,EAAA,MAAA,EAAA,GADkB,MAAI;;;;ECTP,SAAA,EAAA,CAAA,KAAa,EAAA,MAAA,EAAA,GAAgB,MAAA;EAI7B,UAAA,EAAA,CAAA,MAAe,EAAA,MAAA,EAAA,GAAgB,MAAA;mBDK5B;;;;iBCTH,aAAA,gBAA6B;iBAI7B,eAAA,gBAA+B"}

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/utils/expirationTime.ts","../../src/utils/payload.ts"],"sourcesContent":[],"mappings":";;;cAEa;;;EAAA,SAAA,EAAA,CAAA,KAUZ,EAAA,MAAA,EAAA,GADkB,MAAI;;;;ECTP,SAAA,EAAA,CAAA,KAAa,EAAA,MAAA,EAAA,GAAgB,MAAA;EAI7B,UAAA,EAAA,CAAA,MAAe,EAAA,MAAA,EAAA,GAAgB,MAAA;mBDK5B;;;;iBCTH,aAAA,gBAA6B;iBAI7B,eAAA,gBAA+B"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/utils/expirationTime.ts","../../src/utils/payload.ts"],"sourcesContent":[],"mappings":";;;cAEa;;;EAAA,SAAA,EAAA,CAAA,KAUZ,EAAA,MAAA,EAAA,GADkB,MAAI;;;;ECTP,SAAA,EAAA,CAAA,KAAa,EAAA,MAAA,EAAgB,GAAA,MAAA;EAI7B,UAAA,EAAA,CAAA,MAAe,EAAA,MAAA,EAAgB,GAAA,MAAA;mBDK5B;;;;iBCTH,aAAA,gBAA6B;iBAI7B,eAAA,gBAA+B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkiv-network/sdk",
-  "version": "0.3.1",
+  "version": "0.3.2-dev.1",
   "description": "TypeScript client library for Arkiv's blockchains interactions",
   "type": "module",
   "target": "esnext",

package/src/index.ts

@@ -1,5 +1,4 @@
-// Export all public APIs
-
+// Re-export commonly used viem types for convenience
 export type {
   Account,
   Address,
@@ -9,13 +8,36 @@ export type {
   RpcSchema,
   Transport,
 } from "viem"
-// Re-export commonly used viem types for convenience
+
 export { http, toBytes, toHex, toRlp, webSocket } from "viem"
+
+// export main arkiv stuff
 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 { Attribute } from "./types/attributes"
-export type { Entity } from "./types/entity"
-export type { ArkivRpcSchema } from "./types/rpcSchema"
+
+// re-export arkiv types in main index file
+export type {
+  ArkivRpcSchema,
+  Attribute,
+  ChangeOwnershipParameters,
+  ChangeOwnershipReturnType,
+  CreateEntityParameters,
+  CreateEntityReturnType,
+  DeleteEntityParameters,
+  DeleteEntityReturnType,
+  Entity,
+  ExtendEntityParameters,
+  ExtendEntityReturnType,
+  MimeType,
+  MutateEntitiesParameters,
+  MutateEntitiesReturnType,
+  RpcEntity,
+  RpcIncludeData,
+  RpcQueryOptions,
+  TxParams,
+  UpdateEntityParameters,
+  UpdateEntityReturnType,
+} from "./types"

package/src/query/engine.test.ts

@@ -15,6 +15,7 @@ describe("processQuery tests", () => {
       limit: undefined,
       cursor: undefined,
       ownedBy: undefined,
+      orderBy: undefined,
       validAtBlock: undefined,
       withAttributes: undefined,
       withMetadata: undefined,
@@ -53,6 +54,7 @@ describe("processQuery tests", () => {
       limit: undefined,
       cursor: undefined,
       ownedBy: undefined,
+      orderBy: undefined,
       validAtBlock: undefined,
       withAttributes: undefined,
       withMetadata: undefined,
@@ -92,6 +94,7 @@ describe("processQuery tests", () => {
       limit: undefined,
       cursor: undefined,
       ownedBy: undefined,
+      orderBy: undefined,
       validAtBlock: undefined,
       withAttributes: undefined,
       withMetadata: undefined,
@@ -131,6 +134,7 @@ describe("processQuery tests", () => {
       limit: undefined,
       cursor: undefined,
       ownedBy: undefined,
+      orderBy: undefined,
       validAtBlock: undefined,
       withAttributes: undefined,
       withMetadata: undefined,
@@ -176,6 +180,7 @@ describe("processQuery tests", () => {
       limit: undefined,
       cursor: undefined,
       ownedBy: undefined,
+      orderBy: undefined,
       validAtBlock: undefined,
       withAttributes: undefined,
       withMetadata: undefined,
@@ -203,6 +208,7 @@ describe("processQuery tests", () => {
     const predicates = [{ type: "eq" as const, key: "key", value: "value" }]
     await processQuery(client, {
       predicates,
+      orderBy: undefined,
       limit: undefined,
       cursor: undefined,
       ownedBy: "0x123",
@@ -232,6 +238,7 @@ describe("processQuery tests", () => {
       predicates,
       limit: undefined,
       cursor: undefined,
+      orderBy: undefined,
       validAtBlock: undefined,
       withAttributes: undefined,
       withMetadata: undefined,
@@ -256,12 +263,74 @@ describe("processQuery tests", () => {
     })
   })
 
+  it("should process simple predicates with orderBy", async () => {
+    const predicates = [{ type: "eq" as const, key: "key", value: "value" }]
+    await processQuery(client, {
+      predicates,
+      orderBy: [{ name: "key", type: "string", descending: true }],
+      limit: undefined,
+      cursor: undefined,
+      ownedBy: undefined,
+    })
+
+    expect(client.request).lastCalledWith({
+      method: "arkiv_query",
+      params: [
+        `key = "value"`,
+        {
+          orderBy: [{ name: "key", type: "string", descending: true }],
+          includeData: {
+            key: true,
+            attributes: false,
+            contentType: false,
+            payload: false,
+            expiration: false,
+            owner: false,
+          },
+        },
+      ],
+    })
+  })
+
+  it("should process only orderBy", async () => {
+    const predicates = [] as Predicate[]
+    await processQuery(client, {
+      predicates,
+      limit: undefined,
+      cursor: undefined,
+      ownedBy: undefined,
+      orderBy: [{ name: "key", type: "string", descending: true }],
+      validAtBlock: undefined,
+      withAttributes: undefined,
+      withMetadata: undefined,
+    })
+
+    expect(client.request).lastCalledWith({
+      method: "arkiv_query",
+      params: [
+        "",
+        {
+          orderBy: [{ name: "key", type: "string", descending: true }],
+          includeData: {
+            key: true,
+            attributes: false,
+            contentType: false,
+            payload: false,
+            expiration: false,
+            owner: false,
+          },
+        },
+      ],
+    })
+  })
+
   it("should process simple predicate with validAtBlock and paging", async () => {
     const predicates = [{ type: "eq" as const, key: "key", value: "value" }]
     await processQuery(client, {
       predicates,
       limit: 10,
       cursor: undefined,
+      orderBy: undefined,
       validAtBlock: 123n,
       ownedBy: "0x123",
     })

package/src/query/engine.ts

@@ -1,6 +1,6 @@
 import type { Hex } from "viem"
 import type { ArkivClient } from "../clients/baseClient"
-import type { RpcQueryOptions } from "../types/rpcSchema"
+import type { RpcOrderByAttribute, RpcQueryOptions } from "../types/rpcSchema"
 import type { Predicate } from "./predicate"
 
 function processPredicates(predicates: Predicate[]): string {
@@ -45,6 +45,7 @@ export async function processQuery(
     limit: number | undefined
     cursor: string | undefined
     ownedBy: Hex | undefined
+    orderBy: RpcOrderByAttribute[] | undefined
     validAtBlock?: bigint | undefined
     withAttributes?: boolean | undefined
     withMetadata?: boolean | undefined
@@ -56,6 +57,7 @@ export async function processQuery(
     limit,
     cursor,
     ownedBy,
+    orderBy,
     validAtBlock,
     withAttributes,
     withMetadata,
@@ -63,7 +65,7 @@ export async function processQuery(
   } = queryParams
 
   console.debug(
-    `Processing query with params: predicates: ${predicates}, cursor: ${cursor}, limit: ${limit}, ownedBy: ${ownedBy}, validAtBlock: ${validAtBlock}, withAttributes: ${withAttributes}, withMetadata: ${withMetadata}, withPayload: ${withPayload}`,
+    `Processing query with params: predicates: ${JSON.stringify(predicates)}, cursor: ${cursor}, limit: ${limit}, ownedBy: ${ownedBy}, orderBy: ${JSON.stringify(orderBy)}, validAtBlock: ${validAtBlock}, withAttributes: ${withAttributes}, withMetadata: ${withMetadata}, withPayload: ${withPayload}`,
   )
 
   let query = processPredicates(predicates)
@@ -97,9 +99,12 @@ export async function processQuery(
   if (cursor !== undefined) {
     queryOptions.cursor = cursor
   }
+  if (orderBy !== undefined) {
+    queryOptions.orderBy = orderBy
+  }
 
   console.debug(
-    `Built query to send: ${query}, queryOptions: ${JSON.stringify({ includeData: queryOptions.includeData, atBlock: queryOptions.atBlock?.toString(), resultsPerPage: queryOptions.resultsPerPage, cursor: queryOptions.cursor })}`,
+    `Built query to send: ${query}, queryOptions: ${JSON.stringify({ includeData: queryOptions.includeData, atBlock: queryOptions.atBlock?.toString(), orderBy: queryOptions.orderBy, resultsPerPage: queryOptions.resultsPerPage, cursor: queryOptions.cursor })}`,
   )
 
   const result = await client.request({

package/src/query/queryBuilder.test.ts

@@ -46,6 +46,7 @@ describe("QueryBuilder", () => {
         limit: undefined,
         offset: undefined,
         ownedBy: undefined,
+        orderBy: undefined,
         validBeforeBlock: undefined,
         withAttributes: undefined,
         withMetadata: undefined,
@@ -67,6 +68,7 @@ describe("QueryBuilder", () => {
         limit: undefined,
         offset: undefined,
         ownedBy: undefined,
+        orderBy: undefined,
         validBeforeBlock: undefined,
         withAttributes: undefined,
         withMetadata: undefined,
@@ -96,6 +98,7 @@ describe("QueryBuilder", () => {
         limit: undefined,
         offset: undefined,
         ownedBy: undefined,
+        orderBy: undefined,
         validBeforeBlock: undefined,
         withAttributes: undefined,
         withMetadata: undefined,
@@ -117,6 +120,7 @@ describe("QueryBuilder", () => {
         limit: undefined,
         offset: undefined,
         ownedBy: undefined,
+        orderBy: undefined,
         validBeforeBlock: undefined,
         withAttributes: undefined,
         withMetadata: undefined,
@@ -141,6 +145,7 @@ describe("QueryBuilder", () => {
         limit: undefined,
         offset: undefined,
         ownedBy: undefined,
+        orderBy: undefined,
         validBeforeBlock: undefined,
         withAttributes: undefined,
         withMetadata: undefined,
@@ -164,6 +169,7 @@ describe("QueryBuilder", () => {
         limit: undefined,
         offset: undefined,
         ownedBy: owner,
+        orderBy: undefined,
         validBeforeBlock: undefined,
         withAttributes: undefined,
         withMetadata: undefined,
@@ -171,6 +177,27 @@ describe("QueryBuilder", () => {
       })
     })
 
+    test("orderBy() sets orderBy", async () => {
+      mockProcessQuery.mockResolvedValue({
+        data: [],
+      })
+
+      const builder = new QueryBuilder(mockClient)
+      await builder.orderBy("name", "string", true).fetch()
+
+      expect(mockProcessQuery).toHaveBeenCalledWith(mockClient, {
+        predicates: [],
+        limit: undefined,
+        offset: undefined,
+        ownedBy: undefined,
+        orderBy: [{ name: "name", type: "string", desc: true }],
+        validAtBlock: undefined,
+        withAttributes: undefined,
+        withMetadata: undefined,
+        withPayload: undefined,
+      })
+    })
+
     test("limit() sets limit", async () => {
       mockProcessQuery.mockResolvedValue({
         data: [],
@@ -184,6 +211,7 @@ describe("QueryBuilder", () => {
         limit: 10,
         offset: undefined,
         ownedBy: undefined,
+        orderBy: undefined,
         validBeforeBlock: undefined,
         withAttributes: undefined,
         withMetadata: undefined,
@@ -204,6 +232,7 @@ describe("QueryBuilder", () => {
         limit: undefined,
         cursor: "0xABC123",
         ownedBy: undefined,
+        orderBy: undefined,
         validAtBlock: undefined,
         withAttributes: undefined,
         withMetadata: undefined,
@@ -224,6 +253,7 @@ describe("QueryBuilder", () => {
         limit: undefined,
         offset: undefined,
         ownedBy: undefined,
+        orderBy: undefined,
         validBeforeBlock: undefined,
         withAttributes: true,
         withMetadata: undefined,
@@ -244,6 +274,7 @@ describe("QueryBuilder", () => {
         limit: undefined,
         cursor: undefined,
         ownedBy: undefined,
+        orderBy: undefined,
         validBeforeBlock: undefined,
         withAttributes: false,
         withMetadata: undefined,
@@ -264,6 +295,7 @@ describe("QueryBuilder", () => {
         limit: undefined,
         cursor: undefined,
         ownedBy: undefined,
+        orderBy: undefined,
         validAtBlock: undefined,
         withAttributes: undefined,
         withMetadata: true,
@@ -284,6 +316,7 @@ describe("QueryBuilder", () => {
         limit: undefined,
         cursor: undefined,
         ownedBy: undefined,
+        orderBy: undefined,
         validAtBlock: undefined,
         withAttributes: undefined,
         withMetadata: false,
@@ -304,6 +337,7 @@ describe("QueryBuilder", () => {
         limit: undefined,
         cursor: undefined,
         ownedBy: undefined,
+        orderBy: undefined,
         validAtBlock: undefined,
         withAttributes: undefined,
         withMetadata: undefined,

package/src/query/queryBuilder.ts

@@ -1,5 +1,6 @@
 import type { Hex } from "viem"
 import type { ArkivClient } from "../clients/baseClient"
+import type { RpcOrderByAttribute } from "../types/rpcSchema"
 import { entityFromRpcResult } from "../utils/entities"
 import { processQuery } from "./engine"
 import type { Predicate } from "./predicate"
@@ -14,6 +15,7 @@ import { QueryResult } from "./queryResult"
 export class QueryBuilder {
   private _client: ArkivClient
   private _ownedBy: Hex | undefined
+  private _orderBy: RpcOrderByAttribute[] | undefined
   private _validAtBlock: bigint | undefined
   private _withAttributes: boolean | undefined
   private _withMetadata: boolean | undefined
@@ -41,6 +43,35 @@ export class QueryBuilder {
     return this
   }
 
+  /**
+   * Sets the orderBy for the query.
+   * It can be called multiple times to order by multiple attributes.
+   * The order of the attributes is important. The first attribute is the primary order by attribute.
+   * @param attributeName - The name of the attribute to order by
+   * @param attributeType - The type of the attribute to order by (string or number)
+   * @param descending - The boolean value to set the order by descending
+   * @returns The QueryBuilder instance
+   *
+   * @example
+   * const builder = new QueryBuilder(client)
+   * builder.orderBy("name", "string", true)
+   */
+  orderBy(
+    attributeName: string,
+    attributeType: "string" | "number",
+    descending: boolean | undefined = undefined,
+  ) {
+    if (!this._orderBy) {
+      this._orderBy = []
+    }
+    this._orderBy.push({
+      name: attributeName,
+      type: attributeType === "number" ? "numeric" : attributeType,
+      desc: !!descending,
+    } as RpcOrderByAttribute)
+    return this
+  }
+
   /**
    * Sets the withAttributes flag which will return the attributes for the entities if true
    * @param withAttributes - The boolean value to set
@@ -167,6 +198,7 @@ export class QueryBuilder {
       limit: this._limit,
       cursor: this._cursor,
       ownedBy: this._ownedBy,
+      orderBy: this._orderBy,
       validAtBlock: this._validAtBlock,
       withAttributes: this._withAttributes,
       withMetadata: this._withMetadata,
@@ -198,6 +230,7 @@ export class QueryBuilder {
       limit: this._limit,
       cursor: this._cursor,
       ownedBy: this._ownedBy,
+      orderBy: undefined,
       validAtBlock: this._validAtBlock,
       withAttributes: false,
       withMetadata: false,

package/src/types/index.ts

@@ -1,4 +1,17 @@
+export type {
+  ChangeOwnershipParameters,
+  ChangeOwnershipReturnType,
+} from "../actions/wallet/changeOwnership"
+export type { CreateEntityParameters, CreateEntityReturnType } from "../actions/wallet/createEntity"
+export type { DeleteEntityParameters, DeleteEntityReturnType } from "../actions/wallet/deleteEntity"
+export type { ExtendEntityParameters, ExtendEntityReturnType } from "../actions/wallet/extendEntity"
+export type {
+  MutateEntitiesParameters,
+  MutateEntitiesReturnType,
+} from "../actions/wallet/mutateEntities"
+export type { UpdateEntityParameters, UpdateEntityReturnType } from "../actions/wallet/updateEntity"
 export type { Attribute } from "./attributes"
 export type { Entity } from "./entity"
 export type { MimeType } from "./mimeTypes"
+export type { ArkivRpcSchema, RpcEntity, RpcIncludeData, RpcQueryOptions } from "./rpcSchema"
 export type { TxParams } from "./txParams"

package/src/types/rpcSchema.ts

@@ -11,9 +11,16 @@ export type RpcEntity = {
   numericAttributes?: [{ key: string; value: number }]
 }
 
+export type RpcOrderByAttribute = {
+  name: string
+  type: "string" | "numeric"
+  desc: boolean
+}
+
 export type RpcQueryOptions = {
   atBlock?: number
   includeData?: RpcIncludeData
+  orderBy?: RpcOrderByAttribute[]
   resultsPerPage?: number
   cursor?: string
 }

package/dist/entity-CMRcjXBK.d.ts

@@ -1,41 +0,0 @@
-import { Hex } from "viem";
-
-//#region src/types/mimeTypes.d.ts
-type MimeType = "text/plain" | "text/html" | "text/css" | "text/csv" | "text/xml" | "text/javascript" | "application/json" | "application/xml" | "application/pdf" | "application/zip" | "application/gzip" | "application/octet-stream" | "application/javascript" | "application/x-www-form-urlencoded" | "image/png" | "image/jpeg" | "image/webp" | "image/gif" | "image/svg+xml" | "audio/mpeg" | "audio/wav" | "audio/ogg" | "video/mp4" | "video/webm" | "video/ogg" | "multipart/form-data";
-//#endregion
-//#region src/types/attributes.d.ts
-type Attribute = {
-  key: string;
-  value: string | number;
-};
-//#endregion
-//#region src/types/txParams.d.ts
-type TxParams = {
-  gas?: bigint;
-  nonce?: number;
-  gasPrice?: bigint;
-  maxFeePerGas?: never;
-  maxPriorityFeePerGas?: never;
-} | {
-  gas?: bigint;
-  nonce?: number;
-  maxFeePerGas?: bigint;
-  maxPriorityFeePerGas?: bigint;
-  gasPrice?: never;
-};
-//#endregion
-//#region src/types/entity.d.ts
-declare class Entity {
-  key: Hex;
-  owner: Hex;
-  expiresAtBlock: bigint;
-  payload: Uint8Array;
-  attributes: Attribute[];
-  contentType: MimeType;
-  constructor(key: Hex, contentType: MimeType, owner: Hex, expiresAtBlock: bigint, payload: Uint8Array, attributes: Attribute[]);
-  toText(): string;
-  toJson(): any;
-}
-//#endregion
-export { MimeType as i, TxParams as n, Attribute as r, Entity as t };
-//# sourceMappingURL=entity-CMRcjXBK.d.ts.map

package/dist/entity-CMRcjXBK.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"entity-CMRcjXBK.d.ts","names":[],"sources":["../src/types/mimeTypes.ts","../src/types/attributes.ts","../src/types/txParams.ts","../src/types/entity.ts"],"sourcesContent":[],"mappings":";;;KAAY,QAAA;;;KCAA,SAAA;;;ADAZ,CAAA;;;KEAY,QAAA;;;EFAA,QAAA,CAAA,EAAQ,MAAA;;;;ECAR,GAAA,CAAA,EAAA,MAAS;;;;ECAT,QAAA,CAAA,EAAQ,KAAA;;;;AFAR,cGIC,MAAA,CHJO;OGKb;SACE;;EFNG,OAAA,EEQD,UFRU;cESP;eACC;mBAGN,kBACQ,iBACN,sCAEE,wBACG;EDlBJ,MAAA,CAAA,CAAA,EAAA,MAAQ"}