@antfly/sdk 0.0.7 → 0.0.8

package/dist/index.js

@@ -106,14 +106,87 @@ var AntflyClient = class {
       },
       /**
        * Lookup a specific key in a table
+       * @param tableName - Name of the table
+       * @param key - Key of the record to lookup
+       * @param options - Optional parameters
+       * @param options.fields - Comma-separated list of fields to include (e.g., "title,author,metadata.tags")
        */
-      lookup: async (tableName, key) => {
+      lookup: async (tableName, key, options) => {
         const { data, error } = await this.client.GET("/tables/{tableName}/lookup/{key}", {
-          params: { path: { tableName, key } }
+          params: {
+            path: { tableName, key },
+            query: options?.fields ? { fields: options.fields } : void 0
+          }
         });
         if (error) throw new Error(`Key lookup failed: ${error.error}`);
         return data;
       },
+      /**
+       * Scan keys in a table within a key range
+       * Returns documents as an async iterable, streaming results as NDJSON.
+       * @param tableName - Name of the table
+       * @param request - Scan request with optional key range, field projection, and filtering
+       * @returns AsyncGenerator yielding documents with their keys
+       */
+      scan: (tableName, request) => {
+        const config = this.config;
+        async function* scanGenerator() {
+          const headers = {
+            "Content-Type": "application/json",
+            Accept: "application/x-ndjson"
+          };
+          if (config.auth) {
+            const auth = btoa(`${config.auth.username}:${config.auth.password}`);
+            headers["Authorization"] = `Basic ${auth}`;
+          }
+          Object.assign(headers, config.headers);
+          const response = await fetch(`${config.baseUrl}/tables/${tableName}/lookup`, {
+            method: "POST",
+            headers,
+            body: JSON.stringify(request || {})
+          });
+          if (!response.ok) {
+            const errorText = await response.text();
+            throw new Error(`Scan failed: ${response.status} ${errorText}`);
+          }
+          if (!response.body) {
+            throw new Error("Response body is null");
+          }
+          const reader = response.body.getReader();
+          const decoder = new TextDecoder();
+          let buffer = "";
+          while (true) {
+            const { done, value } = await reader.read();
+            if (done) break;
+            buffer += decoder.decode(value, { stream: true });
+            const lines = buffer.split("\n");
+            buffer = lines.pop() || "";
+            for (const line of lines) {
+              if (line.trim()) {
+                yield JSON.parse(line);
+              }
+            }
+          }
+          if (buffer.trim()) {
+            yield JSON.parse(buffer);
+          }
+        }
+        return scanGenerator();
+      },
+      /**
+       * Scan keys in a table and collect all results into an array
+       * Convenience method that consumes the scan AsyncGenerator
+       * @param tableName - Name of the table
+       * @param request - Scan request with optional key range, field projection, and filtering
+       * @returns Promise with array of all matching documents
+       */
+      scanAll: async (tableName, request) => {
+        const results = [];
+        for await (const doc of this.tables.scan(tableName, request)) {
+          results.push(doc);
+        }
+        return results;
+      },
       /**
        * RAG (Retrieval-Augmented Generation) query on a specific table with streaming or citations
        * @param tableName - Name of the table to query

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antfly/sdk",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "description": "TypeScript SDK for Antfly API",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -13,43 +13,38 @@
       "require": "./dist/index.cjs"
     }
   },
-  "files": ["dist", "README.md", "LICENSE"],
-  "scripts": {
-    "build": "tsup src/index.ts --format cjs,esm --dts --clean",
-    "prepare": "npm run build",
-    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "test:ui": "vitest --ui",
-    "test:coverage": "vitest run --coverage",
-    "test:ts": "tsc --noEmit",
-    "typecheck": "tsc --noEmit",
-    "lint": "biome check .",
-    "lint:fix": "biome check . --write",
-    "format": "biome format --write .",
-    "generate": "npx openapi-typescript ../openapi.yaml -o ./src/antfly-api.d.ts --default-non-nullable=false && npx openapi-typescript ../bleve-query-openapi.yaml --client fetch -o ./src/bleve-query.d.ts --default-non-nullable=false",
-    "prepublishOnly": "npm run test:ts && npm run lint && npm run test && npm run build",
-    "example:node": "tsx examples/node-example.ts"
-  },
-  "keywords": ["antfly", "sdk", "typescript", "api", "client", "database", "vector", "search"],
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "antfly",
+    "sdk",
+    "typescript",
+    "api",
+    "client",
+    "database",
+    "vector",
+    "search"
+  ],
   "author": "Antfly Contributors",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/antflydb/antfly-ts.git"
+    "url": "git+https://github.com/antflydb/antfly-ts.git",
+    "directory": "packages/sdk"
   },
   "bugs": {
     "url": "https://github.com/antflydb/antfly-ts/issues"
   },
-  "homepage": "https://github.com/antflydb/antfly-ts#readme",
+  "homepage": "https://github.com/antflydb/antfly-ts/tree/main/packages/sdk#readme",
   "devDependencies": {
-    "@biomejs/biome": "^2.3.8",
-    "@types/node": "^24.10.1",
+    "@types/node": "^25.0.2",
     "@vitest/ui": "^4.0.15",
     "openapi-typescript": "^7.10.1",
     "tsup": "^8.5.1",
     "tsx": "^4.21.0",
-    "typescript": "^5.9.3",
     "vitest": "^4.0.15"
   },
   "dependencies": {
@@ -57,5 +52,19 @@
   },
   "engines": {
     "node": ">=18"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts --clean",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:ui": "vitest --ui",
+    "test:coverage": "vitest run --coverage",
+    "typecheck": "tsc --noEmit",
+    "lint": "biome check . --write",
+    "format": "biome format --write .",
+    "generate": "openapi-typescript ../../../openapi.yaml -o ./src/antfly-api.d.ts --default-non-nullable=false && openapi-typescript ../../../bleve-query-openapi.yaml --client fetch -o ./src/bleve-query.d.ts --default-non-nullable=false",
+    "clean": "rm -rf dist",
+    "example:node": "tsx examples/node-example.ts"
   }
-}
+}