Add 1 new function(s) or class(es) in README.md, Client.js, and Presets.js.

Author: cferrys

README.md

@@ -96,7 +96,16 @@ await client.updateCounters({ force: true }, 'GET');
 await client.repair({}, 'POST');
 ```
 
-The client also wraps readiness, startup, metrics, connection, storage, integrity, counter, user, key, module, and analytics routes through `client.system()`, `client.users()`, `client.keys()`, `client.modules()`, and `client.analytics()`.
+The client also wraps readiness, startup, metrics, cache, active configuration files, connection, storage, integrity, counter, user, key, module, analytics, and search-preset routes through `client.system()`, `client.users()`, `client.keys()`, `client.modules()`, `client.analytics()`, and `client.presets()`.
+
+```javascript
+await client.presets().update('catalog-default', {
+  q: '*',
+  query_by: 'title,description',
+  limit: 20
+});
+const preset = await client.presets().get('catalog-default');
+```
 
 Routes that do not have a dedicated wrapper can still be called through `executeRequest()`:
 
@@ -203,6 +212,15 @@ We welcome contributions from the community! All contributions must be released
 - Test and report bugs against the Node.js client
 - Improve Node.js-specific documentation and examples
 
+### Search all collections
+
+```javascript
+const result = await client.searchAll({ q: 'research', limit: 20 });
+const selected = await client.searchAll({ q: 'research', collections: 'universities,science' });
+```
+
+`globalSearch` remains available as an equivalent name. Results are globally merged and each hit includes `document._collection`.
+
 ### Community
 
 - 📖 [Documentation](https://docs.hlquery.com)

lib/Client.js

@@ -20,6 +20,7 @@ const System = require('./System');
 const Modules = require('./Modules');
 const Users = require('./Users');
 const Analytics = require('./Analytics');
+const Presets = require('./Presets');
 const { RouteCommand, ModuleRouteCommand } = require('./Route');
 const Config = require('../utils/Config');
 
@@ -57,6 +58,7 @@ class Client {
         this._modules = new Modules(this.request);
         this._users = new Users(this.request);
         this._analytics = new Analytics(this.request);
+        this._presets = new Presets(this.request);
     }
 
     /**
@@ -693,6 +695,15 @@ class Client {
         return this._analytics;
     }
 
+    /**
+     * Get search presets API instance.
+     *
+     * @returns {Presets}
+     */
+    presets() {
+        return this._presets;
+    }
+
     async analyticsClick(payload) {
         return await this._analytics.click(payload);
     }
@@ -760,6 +771,10 @@ class Client {
     async globalSearch(params = {}) {
         return await this._search.globalSearch(params);
     }
+
+    async searchAll(params = {}) {
+        return await this._search.searchAll(params);
+    }
 
     /**
      * Execute arbitrary HTTP request

lib/Presets.js

@@ -0,0 +1,41 @@
+/**
+ * hlquery Node.js Client - Search presets API
+ */
+
+const { requireNonEmptyString } = require('./Route');
+
+class Presets {
+    constructor(request) {
+        this.request = request;
+    }
+
+    async list() {
+        return await this.request.execute('GET', '/presets');
+    }
+
+    async get(name) {
+        requireNonEmptyString(name, 'Preset name');
+        return await this.request.execute('GET', `/presets/${encodeURIComponent(name)}`);
+    }
+
+    async create(name, preset) {
+        requireNonEmptyString(name, 'Preset name');
+        return await this.request.execute('POST', `/presets/${encodeURIComponent(name)}`, preset);
+    }
+
+    async update(name, preset) {
+        requireNonEmptyString(name, 'Preset name');
+        return await this.request.execute('PUT', `/presets/${encodeURIComponent(name)}`, preset);
+    }
+
+    async upsert(name, preset) {
+        return await this.update(name, preset);
+    }
+
+    async delete(name) {
+        requireNonEmptyString(name, 'Preset name');
+        return await this.request.execute('DELETE', `/presets/${encodeURIComponent(name)}`);
+    }
+}
+
+module.exports = Presets;

lib/Route.js

@@ -106,6 +106,7 @@ class ModuleRouteCommand extends RouteCommand {
 module.exports = {
     RouteCommand,
     ModuleRouteCommand,
+    requireNonEmptyString,
     cleanRoute,
     joinPath
 };

lib/Search.js

@@ -245,6 +245,11 @@ class Search {
 
         return await this.request.execute(method, '/search', body, queryParams);
     }
+
+    /** Alias for globalSearch: search one merged result set across all collections. */
+    async searchAll(params = {}) {
+        return await this.globalSearch(params);
+    }
 
     /**
      * Vector search

lib/System.js

@@ -122,6 +122,14 @@ class System {
         return await this.request.execute('GET', '/search-config');
     }
 
+    async configFiles() {
+        return await this.request.execute('GET', '/config-files');
+    }
+
+    async cache() {
+        return await this.request.execute('GET', '/cache');
+    }
+
     async updateCounters(params = {}, method = 'POST') {
         method = this._getOrPostMethod(method, 'Update counters');
         return await this.request.execute(method, '/update-counters', null, params);

lib/conformance.js

@@ -26,6 +26,8 @@ const NODE_CLIENT_ROUTE_COVERAGE = [
     { path: '/consistency', methods: ['GET'], status: 'supported', client: 'system.consistency' },
     { path: '/self-check', methods: ['GET'], status: 'supported', client: 'system.selfCheck' },
     { path: '/admin/storage_status', methods: ['GET'], status: 'supported', client: 'system.storageStatus' },
+    { path: '/config-files', methods: ['GET'], status: 'supported', client: 'system.configFiles' },
+    { path: '/cache', methods: ['GET'], status: 'supported', client: 'system.cache' },
     { path: '/links', methods: ['GET'], status: 'supported', client: 'client.links' },
     { path: '/links/ping', methods: ['GET'], status: 'supported', client: 'client.linksPing' },
     { path: '/links/connect', methods: ['POST'], status: 'supported', client: 'client.linksConnect' },
@@ -48,22 +50,38 @@ const NODE_CLIENT_ROUTE_COVERAGE = [
     { path: '/collections/{name}/documents/search', methods: ['GET', 'POST'], status: 'supported', client: 'search.searchLegacy' },
     { path: '/collections/{name}/vector_search', methods: ['GET', 'POST'], status: 'supported', client: 'search.vectorSearch' },
     { path: '/multi_search', methods: ['GET', 'POST'], status: 'supported', client: 'search.multiSearch' },
-    { path: '/search', methods: ['GET', 'POST'], status: 'supported', client: 'search.globalSearch' },
+    { path: '/search', methods: ['GET', 'POST'], status: 'supported', client: 'search.globalSearch/searchAll' },
     { path: '/sql', methods: ['GET', 'POST'], status: 'supported', client: 'system.sql/execSql' },
     { path: '/collections/{name}/documents/facet_counts', methods: ['GET', 'POST'], status: 'supported', client: 'documents.facetCounts' },
     { path: '/collections/{name}/documents/export', methods: ['GET', 'POST'], status: 'supported', client: 'documents.export' },
     { path: '/collections/{name}/synonyms', methods: ['GET'], status: 'supported', client: 'synonyms.list' },
     { path: '/collections/{name}/synonyms/{id}', methods: ['GET', 'POST', 'PUT', 'DELETE'], status: 'supported', client: 'synonyms.get/create/update/delete' },
+    { path: '/collections/{name}/synonym_sets', methods: ['GET'], status: 'omitted', reason: 'Compatibility alias; synonyms.list uses /collections/{name}/synonyms.' },
+    { path: '/collections/{name}/synonym_sets/{id}', methods: ['GET', 'POST', 'PUT', 'DELETE'], status: 'omitted', reason: 'Compatibility alias; synonym item methods use /collections/{name}/synonyms/{id}.' },
     { path: '/synonyms', methods: ['GET'], status: 'supported', client: 'synonyms.listAll' },
     { path: '/synonyms/global', methods: ['GET'], status: 'supported', client: 'synonyms.listGlobal' },
     { path: '/synonyms/global/{id}', methods: ['GET', 'POST', 'PUT', 'DELETE'], status: 'supported', client: 'synonyms.getGlobal/createGlobal/updateGlobal/deleteGlobal' },
+    { path: '/synonym_sets', methods: ['GET'], status: 'omitted', reason: 'Compatibility alias; synonyms.listAll uses /synonyms.' },
+    { path: '/synonym_sets/global', methods: ['GET'], status: 'omitted', reason: 'Compatibility alias; synonyms.listGlobal uses /synonyms/global.' },
+    { path: '/synonym_sets/global/{id}', methods: ['GET', 'POST', 'PUT', 'DELETE'], status: 'omitted', reason: 'Compatibility alias; global synonym methods use /synonyms/global/{id}.' },
+    { path: '/synonym_sets/global/items/{id}', methods: ['GET', 'POST', 'PUT', 'DELETE'], status: 'omitted', reason: 'Compatibility alias; global synonym methods use /synonyms/global/{id}.' },
     { path: '/collections/{name}/stopwords', methods: ['GET', 'POST'], status: 'supported', client: 'stopwords.list/create' },
     { path: '/collections/{name}/stopwords/{word}', methods: ['DELETE'], status: 'supported', client: 'stopwords.delete' },
+    { path: '/collections/{name}/stopword_sets', methods: ['GET', 'POST'], status: 'omitted', reason: 'Compatibility alias; stopword methods use /collections/{name}/stopwords.' },
+    { path: '/collections/{name}/stopword_sets/{word}', methods: ['DELETE'], status: 'omitted', reason: 'Compatibility alias; stopwords.delete uses /collections/{name}/stopwords/{word}.' },
     { path: '/stopwords', methods: ['GET'], status: 'supported', client: 'stopwords.listAll' },
     { path: '/stopwords/global', methods: ['GET', 'POST'], status: 'supported', client: 'stopwords.listGlobal/createGlobal' },
     { path: '/stopwords/global/{word}', methods: ['DELETE'], status: 'supported', client: 'stopwords.deleteGlobal' },
+    { path: '/stopword_sets', methods: ['GET'], status: 'omitted', reason: 'Compatibility alias; stopwords.listAll uses /stopwords.' },
+    { path: '/stopword_sets/global', methods: ['GET', 'POST'], status: 'omitted', reason: 'Compatibility alias; global stopword methods use /stopwords/global.' },
+    { path: '/stopword_sets/global/{word}', methods: ['DELETE'], status: 'omitted', reason: 'Compatibility alias; stopwords.deleteGlobal uses /stopwords/global/{word}.' },
+    { path: '/stopword_sets/global/items/{word}', methods: ['DELETE'], status: 'omitted', reason: 'Compatibility alias; stopwords.deleteGlobal uses /stopwords/global/{word}.' },
     { path: '/collections/{name}/overrides', methods: ['GET'], status: 'supported', client: 'overrides.list' },
     { path: '/collections/{name}/overrides/{id}', methods: ['GET', 'POST', 'PUT', 'DELETE'], status: 'supported', client: 'overrides.get/create/update/delete' },
+    { path: '/collections/{name}/curations', methods: ['GET'], status: 'omitted', reason: 'Compatibility alias; overrides.list uses /collections/{name}/overrides.' },
+    { path: '/collections/{name}/curations/{id}', methods: ['GET', 'POST', 'PUT', 'DELETE'], status: 'omitted', reason: 'Compatibility alias; override item methods use /collections/{name}/overrides/{id}.' },
+    { path: '/collections/{name}/curation_sets', methods: ['GET'], status: 'omitted', reason: 'Compatibility alias; overrides.list uses /collections/{name}/overrides.' },
+    { path: '/collections/{name}/curation_sets/{id}', methods: ['GET', 'POST', 'PUT', 'DELETE'], status: 'omitted', reason: 'Compatibility alias; override item methods use /collections/{name}/overrides/{id}.' },
     { path: '/aliases', methods: ['GET'], status: 'supported', client: 'aliases.list' },
     { path: '/aliases/{name}', methods: ['GET', 'POST', 'PUT', 'DELETE'], status: 'supported', client: 'aliases.get/create/update/delete' },
     { path: '/keys', methods: ['GET', 'POST'], status: 'supported', client: 'keys.list/create' },
@@ -77,6 +95,8 @@ const NODE_CLIENT_ROUTE_COVERAGE = [
     { path: '/search-config', methods: ['GET'], status: 'supported', client: 'system.searchConfig' },
     { path: '/ready', methods: ['GET'], status: 'supported', client: 'system.ready' },
     { path: '/repair', methods: ['GET', 'POST'], status: 'supported', client: 'system.repair' },
+    { path: '/presets', methods: ['GET'], status: 'supported', client: 'presets.list' },
+    { path: '/presets/{name}', methods: ['GET', 'POST', 'PUT', 'DELETE'], status: 'supported', client: 'presets.get/create/update/delete' },
     { path: '/modules', methods: ['GET'], status: 'supported', client: 'modules.list' },
     { path: '/modules/load', methods: ['POST'], status: 'omitted', reason: 'Prefix alias; modules.load(name) uses the explicit /loadmodule/{name} form.' },
     { path: '/modules/unload', methods: ['POST'], status: 'omitted', reason: 'Prefix alias; modules.unload(name) uses the explicit /unloadmodule/{name} form.' },

test/route-conformance.test.js

@@ -4,6 +4,7 @@ const assert = require('assert');
 const Request = require('../lib/Request');
 const Search = require('../lib/Search');
 const System = require('../lib/System');
+const Presets = require('../lib/Presets');
 const { NODE_CLIENT_ROUTE_COVERAGE } = require('../lib/conformance');
 
 class RecordingRequest {
@@ -41,6 +42,7 @@ async function main() {
     const recorder = new RecordingRequest();
     const search = new Search(recorder, null);
     const system = new System(recorder);
+    const presets = new Presets(recorder);
 
     assert.deepStrictEqual(route('/multi_search').methods, ['GET', 'POST']);
     await search.multiSearch([], 'GET');
@@ -50,6 +52,18 @@ async function main() {
     await search.multiSearch([], 'POST');
     assert.strictEqual(recorder.last().method, 'POST');
 
+    assert.deepStrictEqual(route('/search').methods, ['GET', 'POST']);
+    await search.searchAll({ q: 'research', collections: 'universities,science', limit: 20 });
+    assert.deepStrictEqual(recorder.last(), {
+        method: 'GET',
+        path: '/search',
+        body: null,
+        query: { q: 'research', collections: 'universities,science', limit: 20 }
+    });
+    await search.searchAll({ body: { q: 'research', collections: ['universities', 'science'] } });
+    assert.strictEqual(recorder.last().method, 'POST');
+    assert.strictEqual(recorder.last().path, '/search');
+
     for (const [path, invoke] of [
         ['/update-counters', method => system.updateCounters({ force: 1 }, method)],
         ['/repair', method => system.repair({ collection: 'books' }, method)]
@@ -62,6 +76,20 @@ async function main() {
         assert.strictEqual(recorder.last().method, 'POST');
     }
 
+    await system.configFiles();
+    assert.strictEqual(recorder.last().path, '/config-files');
+    await system.cache();
+    assert.strictEqual(recorder.last().path, '/cache');
+
+    await presets.list();
+    assert.deepStrictEqual(recorder.last(), {
+        method: 'GET', path: '/presets', body: null, query: {}
+    });
+    await presets.update('daily/research', { query_by: 'title' });
+    assert.strictEqual(recorder.last().method, 'PUT');
+    assert.strictEqual(recorder.last().path, '/presets/daily%2Fresearch');
+    await assert.rejects(presets.get('  '), /non-empty string/);
+
     const request = new Request('https://search.example.test', {
         token: 'secret-token'
     });