@arkiv-network/sdk 0.0.36-dev.6 → 0.1.0

package/src/query/engine.ts

@@ -4,108 +4,109 @@ import type { RpcQueryOptions } from "../types/rpcSchema"
 import type { Predicate } from "./predicate"
 
 function processPredicates(predicates: Predicate[]): string {
-	const processValue = (value: string | number) => {
-		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(" && ")
+  const processValue = (value: string | number) => {
+    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: 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
-	},
+  client: ArkivClient,
+  queryParams: {
+    predicates: Predicate[]
+    limit: number | undefined
+    cursor: string | undefined
+    ownedBy: Hex | undefined
+    validAtBlock?: bigint | undefined
+    withAttributes?: boolean | undefined
+    withMetadata?: boolean | undefined
+    withPayload?: boolean | undefined
+  },
 ) {
-	const {
-		predicates,
-		limit,
-		cursor,
-		ownedBy,
-		validAtBlock,
-		withAnnotations,
-		withMetadata,
-		withPayload,
-	} = queryParams
+  const {
+    predicates,
+    limit,
+    cursor,
+    ownedBy,
+    validAtBlock,
+    withAttributes,
+    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}`,
-	)
+  console.debug(
+    `Processing query with params: predicates: ${predicates}, cursor: ${cursor}, limit: ${limit}, ownedBy: ${ownedBy}, validAtBlock: ${validAtBlock}, withAttributes: ${withAttributes}, withMetadata: ${withMetadata}, withPayload: ${withPayload}`,
+  )
 
-	let query = processPredicates(predicates)
-	if (ownedBy) {
-		query += ` && $owner=${ownedBy}`
-	}
+  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)
-	}
+  // remove leading and trailing spaces and leading &&
+  query = query.trim()
+  if (query.startsWith("&& ")) {
+    query = query.slice(3)
+  }
 
-	const queryOptions: RpcQueryOptions = {
-		includeData: {
-			key: true,
-			annotations: withAnnotations ?? false,
-			payload: withPayload ?? false,
-			expiration: withMetadata ?? false,
-			owner: withMetadata ?? false,
-		},
-	}
+  const queryOptions: RpcQueryOptions = {
+    includeData: {
+      key: true,
+      attributes: withAttributes ?? false,
+      payload: withPayload ?? false,
+      contentType: withMetadata ?? false,
+      expiration: withMetadata ?? false,
+      owner: withMetadata ?? false,
+    },
+  }
 
-	if (validAtBlock !== undefined) {
-		queryOptions.atBlock = Number(validAtBlock)
-	}
-	if (limit !== undefined) {
-		queryOptions.resultsPerPage = limit
-	}
-	if (cursor !== undefined) {
-		queryOptions.cursor = cursor
-	}
+  if (validAtBlock !== undefined) {
+    queryOptions.atBlock = Number(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 })}`,
-	)
+  console.debug(
+    `Built query to send: ${query}, queryOptions: ${JSON.stringify({ includeData: queryOptions.includeData, 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)
+  const result = await client.request({
+    method: "arkiv_query",
+    params: [query, queryOptions],
+  })
+  console.debug("Raw result from query: ", result)
 
-	return result
+  return result
 }

package/src/query/errors.ts

@@ -1,23 +1,23 @@
 export class NoMoreResultsError extends Error {
-	constructor() {
-		super("No more results")
-	}
+  constructor() {
+    super("No more results")
+  }
 }
 
 export class NoCursorOrLimitError extends Error {
-	constructor() {
-		super("Cursor and limit must be defined to fetch next")
-	}
+  constructor() {
+    super("Cursor and limit must be defined to fetch next")
+  }
 }
 
 export class OffsetCannotBeLessThanZeroError extends Error {
-	constructor() {
-		super("Offset cannot be less than 0")
-	}
+  constructor() {
+    super("Offset cannot be less than 0")
+  }
 }
 
 export class NoEntityFoundError extends Error {
-	constructor() {
-		super("No entity found")
-	}
+  constructor() {
+    super("No entity found")
+  }
 }

package/src/query/predicate.ts

@@ -2,15 +2,15 @@ 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[]
-	  }
+  | {
+      type: PredicateType
+      key: string
+      value: string | number
+    }
+  | {
+      type: PredicateContainerType
+      predicates: Predicate[]
+    }
 
 /**
  * Creates an OR predicate
@@ -24,7 +24,7 @@ export type Predicate =
  *
  */
 export function or(predicates: Predicate[]): Predicate {
-	return { type: "or", predicates }
+  return { type: "or", predicates }
 }
 
 /**
@@ -39,7 +39,7 @@ export function or(predicates: Predicate[]): Predicate {
  *
  */
 export function and(predicates: Predicate[]): Predicate {
-	return { type: "and", predicates }
+  return { type: "and", predicates }
 }
 
 /**
@@ -53,7 +53,7 @@ export function and(predicates: Predicate[]): Predicate {
  * // result = { type: "eq", key: "name", value: "John" }
  */
 export function eq(key: string, value: string | number): Predicate {
-	return { type: "eq", key, value }
+  return { type: "eq", key, value }
 }
 
 /**
@@ -67,7 +67,7 @@ export function eq(key: string, value: string | number): Predicate {
  * // result = { type: "neq", key: "name", value: "John" }
  */
 export function neq(key: string, value: string | number): Predicate {
-	return { type: "neq", key, value }
+  return { type: "neq", key, value }
 }
 
 /**
@@ -81,7 +81,7 @@ export function neq(key: string, value: string | number): Predicate {
  * // result = { type: "gt", key: "name", value: "John" }
  */
 export function gt(key: string, value: string | number): Predicate {
-	return { type: "gt", key, value }
+  return { type: "gt", key, value }
 }
 
 /**
@@ -95,7 +95,7 @@ export function gt(key: string, value: string | number): Predicate {
  * // result = { type: "gte", key: "name", value: "John" }
  */
 export function gte(key: string, value: string | number): Predicate {
-	return { type: "gte", key, value }
+  return { type: "gte", key, value }
 }
 
 /**
@@ -109,7 +109,7 @@ export function gte(key: string, value: string | number): Predicate {
  * // result = { type: "lt", key: "name", value: "John" }
  */
 export function lt(key: string, value: string | number): Predicate {
-	return { type: "lt", key, value }
+  return { type: "lt", key, value }
 }
 
 /**
@@ -123,7 +123,7 @@ export function lt(key: string, value: string | number): Predicate {
  * // result = { type: "lte", key: "name", value: "John" }
  */
 export function lte(key: string, value: string | number): Predicate {
-	return { type: "lte", key, value }
+  return { type: "lte", key, value }
 }
 
 /**
@@ -136,5 +136,5 @@ export function lte(key: string, value: string | number): Predicate {
  * // result = { type: "not", key: "name", value: "" }
  */
 export function not(key: string): Predicate {
-	return { type: "not", key, value: "" }
+  return { type: "not", key, value: "" }
 }