@xandeum/web3.js 0.6.0 → 0.8.0

package/docs/markdown/globals.md

@@ -1,8 +1,8 @@
-[**Xandeum Web3 Library v0.6.0**](README.md)
+[**Xandeum Web3 Library v0.8.0**](README.md)
 
 ***
 
-# Xandeum Web3 Library v0.6.0
+# Xandeum Web3 Library v0.8.0
 
 ## Functions
 
@@ -13,6 +13,7 @@
 - [createDirectory](functions/createDirectory.md)
 - [createFile](functions/createFile.md)
 - [exists](functions/exists.md)
+- [find](functions/find.md)
 - [getMetadata](functions/getMetadata.md)
 - [getXandeumResult](functions/getXandeumResult.md)
 - [listDirectoryEntry](functions/listDirectoryEntry.md)

package/docs/markdown/summary.md

@@ -0,0 +1,49 @@
+# Summary
+
+## Getting Started
+
+* [Introduction](README.md)
+* [Globals](globals.md)
+
+## Core Functions
+
+### File System Management
+
+* [bigbang](functions/bigbang.md)
+* [armageddon](functions/armageddon.md)
+
+### File Operations
+
+* [createFile](functions/createFile.md)
+* [removeFile](functions/removeFile.md)
+* [copyPath](functions/copyPath.md)
+* [renamePath](functions/renamePath.md)
+* [move](functions/move.md)
+
+### Directory Operations
+
+* [createDirectory](functions/createDirectory.md)
+* [removeDirectory](functions/removeDirectory.md)
+* [listDirectoryEntry](functions/listDirectoryEntry.md)
+
+### File Content Operations
+
+* [peek](functions/peek.md)
+* [poke](functions/poke.md)
+
+### Search & Query
+
+* [find](functions/find.md)
+
+### Metadata & Utilities
+
+* [exists](functions/exists.md)
+* [getMetadata](functions/getMetadata.md)
+* [getXandeumResult](functions/getXandeumResult.md)
+* [assignCoowner](functions/assignCoowner.md)
+
+### WebSocket Functions
+
+* [subscribeResult](functions/subscribeResult.md)
+* [unsubscribeResult](functions/unsubscribeResult.md)
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xandeum/web3.js",
-  "version": "0.6.0",
+  "version": "0.8.0",
   "description": "Xandeum javascript api",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/bigbang.ts

@@ -9,7 +9,7 @@ import { programId } from './const'
  * @param replica_count - A stringified integer representing the number of replicas for the new file system.
  * @returns A Promise that resolves to a Solana `Transaction` object containing the bigbang instruction.
  */
-export async function bigbang (replica_count:string,wallet: PublicKey): Promise<Transaction> {
+export async function bigbang(replica_count:string,wallet: PublicKey): Promise<Transaction> {
   const instructionData = Buffer.concat([
     Buffer.from(Int8Array.from([0]).buffer),
     Buffer.from(Uint8Array.of(...new BN(replica_count).toArray('le', 8)))

package/src/find.ts

@@ -0,0 +1,53 @@
+import { Connection } from "@solana/web3.js"
+
+export interface RpcRequest {
+  jsonrpc: string
+  id: number
+  method: string
+  params: any[]
+}
+
+/**
+ * Sends a JSON-RPC request to the Xandeum RPC endpoint to search for a file or directory
+ * within a specified path.
+ *
+ * This function calls the custom RPC method `find`, which is  return an array of
+ * directory entry metadata — names, types etc.
+ *
+ * @param connection - The solana web3 connection with Xandeum-compatible JSON-RPC endpoint (e.g., `'https://api.devnet.solana.com'`).
+ * @param path - The  filesystem path where the search will be performed (e.g., `/documents`).
+ * @param query - The query to search for (e.g., `'myfile.txt'`).
+ *
+ * @returns A `Promise<any>` resolving to the parsed JSON response from the RPC server,
+ *          typically including a `result` array containing directory entry objects.
+ */
+
+export async function find (
+  connection: Connection,
+  path: string,
+  query: string,
+): Promise<any> {
+  const url = connection.rpcEndpoint;
+  const requestBody: RpcRequest = {
+    jsonrpc: '2.0',
+    id: 1,
+    method: 'find',
+    params: [path,query]
+  }
+
+  const response = await fetch(url, {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json'
+    },
+    body: JSON.stringify(requestBody)
+  })
+
+  if (!response.ok) {
+    const errorText = await response.text(); 
+    return Error(`error! status: ${response.status}, message: ${errorText}`);
+  }
+
+  const data = await response.json()
+  return data
+}

package/src/index.ts

@@ -15,3 +15,4 @@ export * from "./assignCoowner";
 export {exists } from "./exists";
 export {listDirectoryEntry} from "./listDirectoryEntery";
 export {getMetadata} from "./getMetadata";
+export {find} from "./find";

package/typedoc.json

@@ -15,7 +15,7 @@
     "excludeInternal": true,
     "excludeNotDocumented": false,
     "gitRemote": "origin",
-    "gitRevision": "stuttgart",
+    "gitRevision": "master",
     "sourceLinkTemplate": "https://github.com/Xandeum/xandeum-web3.js/blob/{gitRevision}/{path}#L{line}",
     "visibilityFilters": {
       "protected": false,