@arkiv-network/sdk 0.0.36-dev.0 → 0.0.36-dev.4

package/dist/_esm/query/engine.js

@@ -0,0 +1,73 @@
+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(" && ");
+}
+export 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(queryOptions)}`);
+    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/_esm/query/engine.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine.js","sourceRoot":"","sources":["../../../src/query/engine.ts"],"names":[],"mappings":"AAKA,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;AAED,MAAM,CAAC,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,CAAC,wBAAwB,KAAK,mBAAmB,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,CAAC,CAAA;IAE7F,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/_esm/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/_esm/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/_esm/query/errors.js

@@ -0,0 +1,21 @@
+export class NoMoreResultsError extends Error {
+    constructor() {
+        super("No more results");
+    }
+}
+export class NoCursorOrLimitError extends Error {
+    constructor() {
+        super("Cursor and limit must be defined to fetch next");
+    }
+}
+export class OffsetCannotBeLessThanZeroError extends Error {
+    constructor() {
+        super("Offset cannot be less than 0");
+    }
+}
+export class NoEntityFoundError extends Error {
+    constructor() {
+        super("No entity found");
+    }
+}
+//# sourceMappingURL=errors.js.map

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

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

package/dist/_esm/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/_esm/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/_esm/query/index.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","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/_esm/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/_esm/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"}

package/dist/_esm/query/predicate.js

@@ -0,0 +1,119 @@
+/**
+ * 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 function or(predicates) {
+    return { type: "or", predicates };
+}
+/**
+ * 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 function and(predicates) {
+    return { type: "and", predicates };
+}
+/**
+ * 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 function eq(key, value) {
+    return { type: "eq", key, value };
+}
+/**
+ * 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 function neq(key, value) {
+    return { type: "neq", key, value };
+}
+/**
+ * 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 function gt(key, value) {
+    return { type: "gt", key, value };
+}
+/**
+ * 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 function gte(key, value) {
+    return { type: "gte", key, value };
+}
+/**
+ * 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 function lt(key, value) {
+    return { type: "lt", key, value };
+}
+/**
+ * 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 function lte(key, value) {
+    return { type: "lte", key, value };
+}
+/**
+ * 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 function not(key) {
+    return { type: "not", key, value: "" };
+}
+//# sourceMappingURL=predicate.js.map

package/dist/_esm/query/predicate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"predicate.js","sourceRoot":"","sources":["../../../src/query/predicate.ts"],"names":[],"mappings":"AAcA;;;;;;;;;;GAUG;AACH,MAAM,UAAU,EAAE,CAAC,UAAuB;IACzC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,CAAA;AAClC,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,GAAG,CAAC,UAAuB;IAC1C,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,EAAE,CAAA;AACnC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,EAAE,CAAC,GAAW,EAAE,KAAsB;IACrD,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,CAAA;AAClC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,GAAG,CAAC,GAAW,EAAE,KAAsB;IACtD,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAA;AACnC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,EAAE,CAAC,GAAW,EAAE,KAAsB;IACrD,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,CAAA;AAClC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,GAAG,CAAC,GAAW,EAAE,KAAsB;IACtD,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAA;AACnC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,EAAE,CAAC,GAAW,EAAE,KAAsB;IACrD,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,CAAA;AAClC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,GAAG,CAAC,GAAW,EAAE,KAAsB;IACtD,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAA;AACnC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,GAAG,CAAC,GAAW;IAC9B,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,EAAE,CAAA;AACvC,CAAC"}

package/dist/_esm/query/queryBuilder.d.ts

@@ -0,0 +1,132 @@
+import type { Hex } from "viem";
+import type { ArkivClient } from "../clients/baseClient";
+import type { Predicate } from "./predicate";
+import { QueryResult } from "./queryResult";
+/**
+ * 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}
+ */
+export declare class QueryBuilder {
+    private _client;
+    private _ownedBy;
+    private _validAtBlock;
+    private _withAnnotations;
+    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 withAnnotations flag which will return the annotations for the entities if true
+     * @param withAnnotations - The boolean value to set
+     * @returns The QueryBuilder instance
+     *
+     * @example
+     * const builder = new QueryBuilder(client)
+     * builder.withAnnotations(true)
+     */
+    withAnnotations(withAnnotations?: 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>;
+}
+//# sourceMappingURL=queryBuilder.d.ts.map

package/dist/_esm/query/queryBuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryBuilder.d.ts","sourceRoot":"","sources":["../../../src/query/queryBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,MAAM,CAAA;AAC/B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAGxD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAE3C;;;;;GAKG;AACH,qBAAa,YAAY;IACxB,OAAO,CAAC,OAAO,CAAa;IAC5B,OAAO,CAAC,QAAQ,CAAiB;IACjC,OAAO,CAAC,aAAa,CAAoB;IACzC,OAAO,CAAC,gBAAgB,CAAqB;IAC7C,OAAO,CAAC,aAAa,CAAqB;IAC1C,OAAO,CAAC,YAAY,CAAqB;IACzC,OAAO,CAAC,MAAM,CAAoB;IAClC,OAAO,CAAC,OAAO,CAAoB;IACnC,OAAO,CAAC,WAAW,CAAa;gBAEpB,MAAM,EAAE,WAAW;IAK/B;;;;;;;;OAQG;IACH,OAAO,CAAC,OAAO,EAAE,GAAG;IAKpB;;;;;;;;OAQG;IACH,eAAe,CAAC,eAAe,GAAE,OAAc;IAK/C;;;;;;;;OAQG;IACH,YAAY,CAAC,YAAY,GAAE,OAAc;IAKzC;;;;;;;;OAQG;IACH,WAAW,CAAC,WAAW,GAAE,OAAc;IAKvC;;;;;;;;OAQG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM;IAKnB;;;;;;;;OAQG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM;IAKrB;;;;;;;;;OASG;IACH,YAAY,CAAC,YAAY,EAAE,MAAM;IAKjC;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,UAAU,EAAE,SAAS,EAAE,GAAG,SAAS;IASzC;;;;;;;;;OASG;IACG,KAAK;IAsBX;;;;;;;;OAQG;IACG,KAAK;CAcX"}