hlquery-node-client 1.0.3 → 1.0.4

package/README.md

@@ -8,8 +8,8 @@
 
 [![Follow hlquery](https://img.shields.io/badge/Follow-%40hlquery-blue?logo=x&logoColor=white&labelColor=000000)](https://x.com/hlquery)
 [![Node build](https://img.shields.io/badge/Node%20build-passing-brightgreen?logo=node.js&logoColor=white&labelColor=000000)](https://github.com/hlquery/node-api/actions/workflows/ci.yml)
-[![node-api](https://img.shields.io/badge/GitHub-node--api-purple?logo=github&logoColor=white&labelColor=000000)](https://github.com/hlquery/node-api/stargazers)
-[![hlquery](https://img.shields.io/badge/GitHub-hlquery-blue?logo=github&logoColor=white&labelColor=000000)](https://github.com/hlquery/hlquery/stargazers)
+[![node-api](https://img.shields.io/badge/GitHub-node--api-purple?logo=github&logoColor=white&labelColor=000000)](https://github.com/hlquery/node-api)
+[![hlquery](https://img.shields.io/badge/GitHub-hlquery-blue?logo=github&logoColor=white&labelColor=000000)](https://github.com/hlquery/hlquery)
 [![License](https://img.shields.io/badge/License-BSD%203--Clause-a35a0f?logo=open-source-initiative&logoColor=white&labelColor=000000)](https://opensource.org/licenses/BSD-3-Clause)
 
 </div>
@@ -139,7 +139,7 @@ console.log(results.getBody());
 ```javascript
 const rows = await client.sql('SHOW COLLECTIONS;');
 const execResult = await client.execSql(
-  "INSERT INTO logs_archive (id, title) VALUES ('row-1', 'warm cache');"
+  "INSERT INTO books (id, title) VALUES ('book_4', 'Inserted via SQL');"
 );
 const books = await client.sqlSearch(
   'books',

package/example.js

@@ -161,11 +161,6 @@ async function main() {
     // Create client
     const client = new Client(baseUrl);
     
-    // Optional: Set authentication token if provided
-    // Uncomment and set token if your server requires authentication:
-    // const authToken = 'your_token_here';
-    // client.setAuthToken(authToken, 'bearer');
-    
     if (testToken) {
         client.setAuthToken(testToken, 'bearer');
         console.log(`Using authentication token: ${testToken.substring(0, 8)}...\n`);

package/examples/basic_usage.js

@@ -7,8 +7,15 @@
 const Client = require('../lib/Client');
 
 async function main() {
+    const baseUrl = process.argv[2] || process.env.HLQ_BASE_URL || process.env.HLQUERY_BASE_URL || 'http://localhost:9200';
+    const token = process.argv[3] || process.env.HLQUERY_TOKEN || null;
+
     // Initialize client
-    const client = new Client('http://localhost:9200');
+    const client = new Client(baseUrl);
+
+    if (token) {
+        client.setAuthToken(token, 'bearer');
+    }
     
     // Health check
     const health = await client.health();
@@ -22,14 +29,7 @@ async function main() {
         console.log(`Found ${body.collections ? body.collections.length : 0} collections`);
     }
     
-    // With authentication
-    const authenticatedClient = new Client('http://localhost:9200', {
-        token: 'your_token_here',
-        auth_method: 'bearer'
-    });
-    
-    // Or set token dynamically
-    client.setAuthToken('your_token_here', 'bearer');
+    console.log('Base URL:', baseUrl);
 }
 
 main().catch(console.error);

package/examples/collections.js

@@ -7,16 +7,19 @@
 const Client = require('../lib/Client');
 
 async function main() {
-    const client = new Client('http://localhost:9200');
+    const baseUrl = process.argv[2] || process.env.HLQ_BASE_URL || process.env.HLQUERY_BASE_URL || 'http://localhost:9200';
+    const token = process.argv[3] || process.env.HLQUERY_TOKEN || null;
+    const client = new Client(baseUrl);
+    const collectionName = `node_collections_example_${process.pid}`;
+
+    if (token) {
+        client.setAuthToken(token, 'bearer');
+    }
     
     // List collections
     const collections = await client.collections().list(0, 10);
     console.log('Collections:', collections.getBody());
     
-    // Get collection
-    const collection = await client.collections().get('my_collection');
-    console.log('Collection details:', collection.getBody());
-    
     // Create collection
     const schema = {
         fields: [
@@ -25,15 +28,19 @@ async function main() {
             { name: 'embedding', type: 'float[]' }
         ]
     };
-    const createResult = await client.collections().create('new_collection', schema);
+    const createResult = await client.collections().create(collectionName, schema);
     console.log('Create result:', createResult.getBody());
+
+    // Get collection
+    const collection = await client.collections().get(collectionName);
+    console.log('Collection details:', collection.getBody());
     
     // Get formatted fields
-    const fields = await client.collections().getFields('my_collection');
+    const fields = await client.collections().getFields(collectionName);
     console.log('Formatted fields:', fields.getBody());
     
     // Delete collection
-    const deleteResult = await client.collections().delete('collection_name');
+    const deleteResult = await client.collections().delete(collectionName);
     console.log('Delete result:', deleteResult.getBody());
 }
 

package/examples/csv.js

@@ -2,21 +2,23 @@
  * CSV Parsing Example
  *
  * Usage:
- *   node examples/csv.js <collection> <csv-path> [token]
+ *   node examples/csv.js <collection> <csv-path> [base-url] [token]
  */
 
 const path = require('path');
 const Client = require('../lib/Client');
 
 async function main() {
-    const [, , collectionName, csvPath, token] = process.argv;
+    const [, , collectionName, csvPath, baseUrlArg, tokenArg] = process.argv;
 
     if (!collectionName || !csvPath) {
-        console.error('Usage: node examples/csv.js <collection> <csv-path> [token]');
+        console.error('Usage: node examples/csv.js <collection> <csv-path> [base-url] [token]');
         process.exit(1);
     }
 
-    const client = new Client('http://localhost:9200');
+    const baseUrl = baseUrlArg || process.env.HLQ_BASE_URL || process.env.HLQUERY_BASE_URL || 'http://localhost:9200';
+    const token = tokenArg || process.env.HLQUERY_TOKEN || null;
+    const client = new Client(baseUrl);
 
     if (token) {
         client.setAuthToken(token, 'bearer');

package/examples/documents.js

@@ -7,38 +7,53 @@
 const Client = require('../lib/Client');
 
 async function main() {
-    const client = new Client('http://localhost:9200');
+    const baseUrl = process.argv[2] || process.env.HLQ_BASE_URL || process.env.HLQUERY_BASE_URL || 'http://localhost:9200';
+    const token = process.argv[3] || process.env.HLQUERY_TOKEN || null;
+    const client = new Client(baseUrl);
+    const collectionName = `node_documents_example_${process.pid}`;
+
+    if (token) {
+        client.setAuthToken(token, 'bearer');
+    }
+
+    await client.collections().delete(collectionName);
+    await client.collections().create(collectionName, {
+        fields: [
+            { name: 'title', type: 'string' },
+            { name: 'content', type: 'string' }
+        ]
+    });
+
+    // Add document
+    const newDoc = {
+        id: 'doc_1',
+        title: 'New Document',
+        content: 'Document content'
+    };
+    const addResult = await client.documents().add(collectionName, newDoc);
+    console.log('Add result:', addResult.getBody());
     
     // List documents
-    const docs = await client.documents().list('collection', {
+    const docs = await client.documents().list(collectionName, {
         offset: 0,
         limit: 10
     });
     console.log('Documents:', docs.getBody());
     
     // Get document
-    const doc = await client.documents().get('collection', 'doc_id');
+    const doc = await client.documents().get(collectionName, 'doc_1');
     console.log('Document:', doc.getBody());
     
-    // Add document
-    const newDoc = {
-        id: 'doc_1',
-        title: 'New Document',
-        content: 'Document content'
-    };
-    const addResult = await client.documents().add('collection', newDoc);
-    console.log('Add result:', addResult.getBody());
-    
     // Update document
     const updatedDoc = {
         title: 'Updated Document',
         content: 'Updated content'
     };
-    const updateResult = await client.documents().update('collection', 'doc_id', updatedDoc);
+    const updateResult = await client.documents().update(collectionName, 'doc_1', updatedDoc);
     console.log('Update result:', updateResult.getBody());
     
     // Delete document
-    const deleteResult = await client.documents().delete('collection', 'doc_id');
+    const deleteResult = await client.documents().delete(collectionName, 'doc_1');
     console.log('Delete result:', deleteResult.getBody());
     
     // Bulk import
@@ -47,8 +62,11 @@ async function main() {
         { id: 'doc2', title: 'Doc 2' },
         { id: 'doc3', title: 'Doc 3' }
     ];
-    const importResult = await client.documents().import('collection', bulkDocs);
+    const importResult = await client.documents().import(collectionName, bulkDocs);
     console.log('Import result:', importResult.getBody());
+
+    const cleanup = await client.collections().delete(collectionName);
+    console.log('Cleanup result:', cleanup.getBody());
 }
 
 main().catch(console.error);

package/examples/flush.js

@@ -12,7 +12,13 @@
 const Client = require('../lib/Client');
 
 async function main() {
-    const client = new Client('http://localhost:9200');
+    const baseUrl = process.argv[2] || process.env.HLQ_BASE_URL || process.env.HLQUERY_BASE_URL || 'http://localhost:9200';
+    const token = process.argv[3] || process.env.HLQUERY_TOKEN || null;
+    const client = new Client(baseUrl);
+
+    if (token) {
+        client.setAuthToken(token, 'bearer');
+    }
 
     console.log('='.repeat(70));
     console.log('FLUSH EXAMPLE');

package/examples/keys.js

@@ -6,13 +6,15 @@
 
 const Client = require('../index');
 
-// Replace with your hlquery master admin token
-const ADMIN_TOKEN = 'your_admin_token_here';
-const BASE_URL = 'http://localhost:9200';
+const ADMIN_TOKEN = process.argv[2] || process.env.HLQUERY_ADMIN_TOKEN || process.env.HLQUERY_TOKEN || null;
+const BASE_URL = process.argv[3] || process.env.HLQ_BASE_URL || process.env.HLQUERY_BASE_URL || 'http://localhost:9200';
 
 async function run() {
     try {
         const client = new Client(BASE_URL);
+        if (!ADMIN_TOKEN) {
+            throw new Error('Admin token required. Pass it as argv[2] or set HLQUERY_ADMIN_TOKEN.');
+        }
         client.setAuthToken(ADMIN_TOKEN);
 
         console.log('1. Creating a scoped search key for "products" collection...');

package/examples/pdf.js

@@ -3,21 +3,23 @@
  *
  * Usage:
  *   npm install
- *   node examples/pdf.js <collection> <pdf-path> [token]
+ *   node examples/pdf.js <collection> <pdf-path> [base-url] [token]
  */
 
 const path = require('path');
 const Client = require('../lib/Client');
 
 async function main() {
-    const [, , collectionName, pdfPath, token] = process.argv;
+    const [, , collectionName, pdfPath, baseUrlArg, tokenArg] = process.argv;
 
     if (!collectionName || !pdfPath) {
-        console.error('Usage: node examples/pdf.js <collection> <pdf-path> [token]');
+        console.error('Usage: node examples/pdf.js <collection> <pdf-path> [base-url] [token]');
         process.exit(1);
     }
 
-    const client = new Client('http://localhost:9200');
+    const baseUrl = baseUrlArg || process.env.HLQ_BASE_URL || process.env.HLQUERY_BASE_URL || 'http://localhost:9200';
+    const token = tokenArg || process.env.HLQUERY_TOKEN || null;
+    const client = new Client(baseUrl);
 
     if (token) {
         client.setAuthToken(token, 'bearer');

package/examples/search.js

@@ -7,18 +7,41 @@
 const Client = require('../lib/Client');
 
 async function main() {
-    const client = new Client('http://localhost:9200');
+    const baseUrl = process.argv[2] || process.env.HLQ_BASE_URL || process.env.HLQUERY_BASE_URL || 'http://localhost:9200';
+    const token = process.argv[3] || process.env.HLQUERY_TOKEN || null;
+    const collectionName = process.argv[4] || `node_search_example_${process.pid}`;
+    const client = new Client(baseUrl);
     const search = client.searchApi();
+
+    if (token) {
+        client.setAuthToken(token, 'bearer');
+    }
+
+    await client.collections().delete(collectionName);
+    await client.collections().create(collectionName, {
+        fields: [
+            { name: 'title', type: 'string' },
+            { name: 'content', type: 'string' },
+            { name: 'category', type: 'string' },
+            { name: 'price', type: 'float' },
+            { name: 'embedding', type: 'float[]' }
+        ]
+    });
+    await client.documents().import(collectionName, [
+        { id: 'prod_laptop_001', title: 'Laptop Computer', content: 'Portable work machine', category: 'electronics', price: 1299.99, embedding: [0.1, 0.2, 0.3, 0.4, 0.5] },
+        { id: 'prod_keyboard_001', title: 'Wireless Keyboard', content: 'Compact Bluetooth keyboard', category: 'electronics', price: 49.99, embedding: [0.2, 0.1, 0.4, 0.3, 0.5] },
+        { id: 'prod_notebook_001', title: 'Paper Notebook', content: 'Plain paper writing notebook', category: 'office', price: 9.99, embedding: [0.5, 0.4, 0.3, 0.2, 0.1] }
+    ]);
     
     // Simple search. The SDK uses the canonical /collections/{name}/search route.
-    const results = await search.search('collection_name', {
+    const results = await search.search(collectionName, {
         q: 'search query',
         query_by: 'title,content',
         limit: 10
     });
     
     // Search with filters
-    const filteredResults = await client.search('collection_name', {
+    const filteredResults = await client.search(collectionName, {
         q: 'query',
         query_by: 'title',
         filter_by: 'category:electronics',
@@ -28,49 +51,49 @@ async function main() {
     
     // Supported query semantics
     // Field-specific search
-    const fieldResults = await client.search('collection_name', {
+    const fieldResults = await client.search(collectionName, {
         q: 'title:laptop',
         query_by: 'title,content',
         limit: 10
     });
     
     // Boolean OR query
-    const orResults = await client.search('collection_name', {
+    const orResults = await client.search(collectionName, {
         q: 'title:laptop OR title:notebook',
         query_by: 'title,content',
         limit: 10
     });
     
     // Boolean NOT query
-    const notResults = await client.search('collection_name', {
+    const notResults = await client.search(collectionName, {
         q: 'title:laptop NOT title:refurbished',
         query_by: 'title,content',
         limit: 10
     });
     
     // Phrase search
-    const phraseResults = await client.search('collection_name', {
+    const phraseResults = await client.search(collectionName, {
         q: '"wireless keyboard"',
         query_by: 'title',
         limit: 10
     });
     
     // Wildcard search
-    const wildcardResults = await client.search('collection_name', {
+    const wildcardResults = await client.search(collectionName, {
         q: 'laptop*',
         query_by: 'title,content',
         limit: 10
     });
     
     // query_by restriction
-    const restrictedResults = await client.search('collection_name', {
+    const restrictedResults = await client.search(collectionName, {
         q: 'laptop',
         query_by: 'title',
         limit: 10
     });
     
     // Filter operators belong in filter_by
-    const combinedResults = await client.search('collection_name', {
+    const combinedResults = await client.search(collectionName, {
         q: '*',
         query_by: 'title,content',
         filter_by: 'price:>100&&category:electronics',
@@ -78,7 +101,7 @@ async function main() {
     });
     
     // Vector search
-    const vectorResults = await client.vectorSearch('collection_name', {
+    const vectorResults = await client.vectorSearch(collectionName, {
         body: {
             vector: [0.1, 0.2, 0.3, 0.4, 0.5],
             field_name: 'embedding',
@@ -91,11 +114,23 @@ async function main() {
     
     // Multi-search
     const multiResults = await search.multiSearch([
-        { collection: 'col1', q: 'query1', query_by: 'title' },
-        { collection: 'col2', q: 'query2', query_by: 'content' }
+        { collection: collectionName, q: 'laptop', query_by: 'title' },
+        { collection: collectionName, q: 'keyboard', query_by: 'content' }
     ]);
     
     console.log('Search results:', results.getBody());
+    console.log('Filtered results:', filteredResults.getBody());
+    console.log('Field results:', fieldResults.getBody());
+    console.log('Boolean OR results:', orResults.getBody());
+    console.log('Boolean NOT results:', notResults.getBody());
+    console.log('Phrase results:', phraseResults.getBody());
+    console.log('Wildcard results:', wildcardResults.getBody());
+    console.log('Restricted results:', restrictedResults.getBody());
+    console.log('Combined results:', combinedResults.getBody());
+    console.log('Vector results:', vectorResults.getBody());
+    console.log('Multi-search results:', multiResults.getBody());
+
+    await client.collections().delete(collectionName);
 }
 
 main().catch(console.error);

package/examples/sql.js

@@ -7,7 +7,28 @@
 const Client = require('../lib/Client');
 
 async function main() {
-    const client = new Client('http://localhost:9200');
+    const baseUrl = process.argv[2] || process.env.HLQ_BASE_URL || process.env.HLQUERY_BASE_URL || 'http://localhost:9200';
+    const token = process.argv[3] || process.env.HLQUERY_TOKEN || null;
+    const collectionName = `node_sql_example_${process.pid}`;
+    const client = new Client(baseUrl);
+
+    if (token) {
+        client.setAuthToken(token, 'bearer');
+    }
+
+    await client.collections().delete(collectionName);
+    await client.collections().create(collectionName, {
+        fields: [
+            { name: 'title', type: 'string' },
+            { name: 'category', type: 'string' },
+            { name: 'price', type: 'float' }
+        ]
+    });
+    await client.documents().import(collectionName, [
+        { id: 'book_1', title: 'Algebra Basics', category: 'math', price: 19.99 },
+        { id: 'book_2', title: 'Geometry Proofs', category: 'math', price: 29.99 },
+        { id: 'book_3', title: 'Cooking Basics', category: 'food', price: 14.99 }
+    ]);
 
     // Top-level SQL through /sql
     const rows = await client.sql('SHOW COLLECTIONS;');
@@ -15,17 +36,20 @@ async function main() {
 
     // Top-level SQL statement execution through POST /sql
     const execResult = await client.execSql(
-        "INSERT INTO logs_archive (id, title) VALUES ('row-1', 'warm cache');"
+        `INSERT INTO ${collectionName} (id, title, category, price) VALUES ('book_4', 'Inserted via SQL', 'ops', 39.99);`
     );
     console.log('Exec result:', execResult.getBody());
 
     // Collection-bound SQL SELECT through /collections/{name}/documents/search
-    const products = await client.sqlSearch(
-        'products',
-        'SELECT id, title, price FROM products WHERE price > 100 ORDER BY price DESC LIMIT 3;',
+    const books = await client.sqlSearch(
+        collectionName,
+        `SELECT id, title, price FROM ${collectionName} WHERE price > 10 ORDER BY price DESC LIMIT 3;`,
         { highlight: false }
     );
-    console.log('Products SQL results:', products.getBody());
+    console.log('Books SQL results:', books.getBody());
+
+    const cleanup = await client.collections().delete(collectionName);
+    console.log('Cleanup:', cleanup.getBody());
 }
 
 main().catch(console.error);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hlquery-node-client",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Node.js client library for hlquery search engine",
   "main": "index.js",
   "type": "commonjs",