@redis/search 1.1.2 → 1.1.4

package/README.md

@@ -12,7 +12,7 @@ For complete examples, see [`search-hashes.js`](https://github.com/redis/node-re
 
 #### Creating an Index
 
-Before we can perform any searches, we need to tell RediSearch how to index our data, and which Redis keys to find that data in.  The [FT.CREATE](https://oss.redis.com/redisearch/Commands/#ftcreate) command creates a RediSearch index.  Here's how to use it to create an index we'll call `idx:animals` where we want to index hashes containing `name`, `species` and `age` fields, and whose key names in Redis begin with the prefix `noderedis:animals`:
+Before we can perform any searches, we need to tell RediSearch how to index our data, and which Redis keys to find that data in.  The [FT.CREATE](https://redis.io/commands/ft.create) command creates a RediSearch index.  Here's how to use it to create an index we'll call `idx:animals` where we want to index hashes containing `name`, `species` and `age` fields, and whose key names in Redis begin with the prefix `noderedis:animals`:
 
 ```javascript
 await client.ft.create('idx:animals', {
@@ -28,11 +28,11 @@ await client.ft.create('idx:animals', {
 });
 ```
 
-See the [`FT.CREATE` documentation](https://oss.redis.com/redisearch/Commands/#ftcreate) for information about the different field types and additional options.
+See the [`FT.CREATE` documentation](https://redis.io/commands/ft.create/#description) for information about the different field types and additional options.
 
 #### Querying the Index
 
-Once we've created an index, and added some data to Redis hashes whose keys begin with the prefix `noderedis:animals`, we can start writing some search queries.  RediSearch supports a rich query syntax for full-text search, faceted search, aggregation and more.  Check out the [`FT.SEARCH` documentation](https://oss.redis.com/redisearch/Commands/#ftsearch) and the [query syntax reference](https://oss.redis.com/redisearch/Query_Syntax/) for more information.
+Once we've created an index, and added some data to Redis hashes whose keys begin with the prefix `noderedis:animals`, we can start writing some search queries.  RediSearch supports a rich query syntax for full-text search, faceted search, aggregation and more.  Check out the [`FT.SEARCH` documentation](https://redis.io/commands/ft.search) and the [query syntax reference](https://redis.io/docs/interact/search-and-query/query) for more information.
 
 Let's write a query to find all the animals where the `species` field has the value `dog`:
 
@@ -112,7 +112,7 @@ Note that we're using JSON Path to specify where the fields to index are in our
 
 Now we have an index and some data stored as JSON documents in Redis (see the [JSON package documentation](https://github.com/redis/node-redis/tree/master/packages/json) for examples of how to store JSON), we can write some queries...
 
-We'll use the [RediSearch query language](https://oss.redis.com/redisearch/Query_Syntax/) and [`FT.SEARCH`](https://oss.redis.com/redisearch/Commands/#ftsearch) command.  Here's a query to find users under the age of 30:
+We'll use the [RediSearch query language](https://redis.io/docs/interact/search-and-query/query) and [`FT.SEARCH`](https://redis.io/commands/ft.search) command.  Here's a query to find users under the age of 30:
 
 ```javascript
 await client.ft.search('idx:users', '@age:[0 30]');

package/dist/commands/AGGREGATE.d.ts

@@ -99,6 +99,7 @@ export interface AggregateOptions {
     STEPS?: Array<GroupByStep | SortStep | ApplyStep | LimitStep | FilterStep>;
     PARAMS?: Params;
     DIALECT?: number;
+    TIMEOUT?: number;
 }
 export declare const FIRST_KEY_INDEX = 1;
 export declare const IS_READ_ONLY = true;

package/dist/commands/AGGREGATE.js

@@ -10,7 +10,7 @@ var AggregateSteps;
     AggregateSteps["APPLY"] = "APPLY";
     AggregateSteps["LIMIT"] = "LIMIT";
     AggregateSteps["FILTER"] = "FILTER";
-})(AggregateSteps = exports.AggregateSteps || (exports.AggregateSteps = {}));
+})(AggregateSteps || (exports.AggregateSteps = AggregateSteps = {}));
 var AggregateGroupByReducers;
 (function (AggregateGroupByReducers) {
     AggregateGroupByReducers["COUNT"] = "COUNT";
@@ -26,7 +26,7 @@ var AggregateGroupByReducers;
     AggregateGroupByReducers["TO_LIST"] = "TOLIST";
     AggregateGroupByReducers["FIRST_VALUE"] = "FIRST_VALUE";
     AggregateGroupByReducers["RANDOM_SAMPLE"] = "RANDOM_SAMPLE";
-})(AggregateGroupByReducers = exports.AggregateGroupByReducers || (exports.AggregateGroupByReducers = {}));
+})(AggregateGroupByReducers || (exports.AggregateGroupByReducers = AggregateGroupByReducers = {}));
 exports.FIRST_KEY_INDEX = 1;
 exports.IS_READ_ONLY = true;
 function transformArguments(index, query, options) {
@@ -92,6 +92,9 @@ function pushAggregatehOptions(args, options) {
     if (options?.DIALECT) {
         args.push('DIALECT', options.DIALECT.toString());
     }
+    if (options?.TIMEOUT !== undefined) {
+        args.push('TIMEOUT', options.TIMEOUT.toString());
+    }
     return args;
 }
 exports.pushAggregatehOptions = pushAggregatehOptions;

package/dist/commands/CURSOR_READ.d.ts

@@ -1,5 +1,8 @@
 import { RedisCommandArgument, RedisCommandArguments } from '@redis/client/dist/lib/commands';
 export declare const FIRST_KEY_INDEX = 1;
 export declare const IS_READ_ONLY = true;
-export declare function transformArguments(index: RedisCommandArgument, cursor: number): RedisCommandArguments;
+interface CursorReadOptions {
+    COUNT?: number;
+}
+export declare function transformArguments(index: RedisCommandArgument, cursor: number, options?: CursorReadOptions): RedisCommandArguments;
 export { transformReply } from './AGGREGATE_WITHCURSOR';

package/dist/commands/CURSOR_READ.js

@@ -3,13 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.transformReply = exports.transformArguments = exports.IS_READ_ONLY = exports.FIRST_KEY_INDEX = void 0;
 exports.FIRST_KEY_INDEX = 1;
 exports.IS_READ_ONLY = true;
-function transformArguments(index, cursor) {
-    return [
+function transformArguments(index, cursor, options) {
+    const args = [
         'FT.CURSOR',
         'READ',
         index,
         cursor.toString()
     ];
+    if (options?.COUNT) {
+        args.push('COUNT', options.COUNT.toString());
+    }
+    return args;
 }
 exports.transformArguments = transformArguments;
 var AGGREGATE_WITHCURSOR_1 = require("./AGGREGATE_WITHCURSOR");

package/dist/commands/SEARCH.d.ts

@@ -34,6 +34,7 @@ export interface SearchOptions {
     };
     PARAMS?: Params;
     DIALECT?: number;
+    TIMEOUT?: number;
 }
 export declare function transformArguments(index: string, query: string, options?: SearchOptions): RedisCommandArguments;
 export type SearchRawReply = Array<any>;

package/dist/commands/SEARCH_NOCONTENT.d.ts

@@ -0,0 +1,10 @@
+import { RedisCommandArguments } from "@redis/client/dist/lib/commands";
+import { SearchOptions, SearchRawReply } from "./SEARCH";
+export declare const FIRST_KEY_INDEX = 1;
+export declare const IS_READ_ONLY = true;
+export declare function transformArguments(index: string, query: string, options?: SearchOptions): RedisCommandArguments;
+export interface SearchNoContentReply {
+    total: number;
+    documents: Array<string>;
+}
+export declare function transformReply(reply: SearchRawReply): SearchNoContentReply;

package/dist/commands/SEARCH_NOCONTENT.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformReply = exports.transformArguments = exports.IS_READ_ONLY = exports.FIRST_KEY_INDEX = void 0;
+const _1 = require(".");
+exports.FIRST_KEY_INDEX = 1;
+exports.IS_READ_ONLY = true;
+function transformArguments(index, query, options) {
+    return (0, _1.pushSearchOptions)(['FT.SEARCH', index, query, 'NOCONTENT'], options);
+}
+exports.transformArguments = transformArguments;
+;
+function transformReply(reply) {
+    return {
+        total: reply[0],
+        documents: reply.slice(1)
+    };
+}
+exports.transformReply = transformReply;

package/dist/commands/index.d.ts

@@ -20,6 +20,7 @@ import * as INFO from './INFO';
 import * as PROFILESEARCH from './PROFILE_SEARCH';
 import * as PROFILEAGGREGATE from './PROFILE_AGGREGATE';
 import * as SEARCH from './SEARCH';
+import * as SEARCH_NOCONTENT from './SEARCH_NOCONTENT';
 import * as SPELLCHECK from './SPELLCHECK';
 import * as SUGADD from './SUGADD';
 import * as SUGDEL from './SUGDEL';
@@ -78,6 +79,8 @@ declare const _default: {
     profileAggregate: typeof PROFILEAGGREGATE;
     SEARCH: typeof SEARCH;
     search: typeof SEARCH;
+    SEARCH_NOCONTENT: typeof SEARCH_NOCONTENT;
+    searchNoContent: typeof SEARCH_NOCONTENT;
     SPELLCHECK: typeof SPELLCHECK;
     spellCheck: typeof SPELLCHECK;
     SUGADD: typeof SUGADD;

package/dist/commands/index.js

@@ -23,6 +23,7 @@ const INFO = require("./INFO");
 const PROFILESEARCH = require("./PROFILE_SEARCH");
 const PROFILEAGGREGATE = require("./PROFILE_AGGREGATE");
 const SEARCH = require("./SEARCH");
+const SEARCH_NOCONTENT = require("./SEARCH_NOCONTENT");
 const SPELLCHECK = require("./SPELLCHECK");
 const SUGADD = require("./SUGADD");
 const SUGDEL = require("./SUGDEL");
@@ -80,6 +81,8 @@ exports.default = {
     profileAggregate: PROFILEAGGREGATE,
     SEARCH,
     search: SEARCH,
+    SEARCH_NOCONTENT,
+    searchNoContent: SEARCH_NOCONTENT,
     SPELLCHECK,
     spellCheck: SPELLCHECK,
     SUGADD,
@@ -130,7 +133,7 @@ var RedisSearchLanguages;
     RedisSearchLanguages["TAMIL"] = "Tamil";
     RedisSearchLanguages["TURKISH"] = "Turkish";
     RedisSearchLanguages["CHINESE"] = "Chinese";
-})(RedisSearchLanguages = exports.RedisSearchLanguages || (exports.RedisSearchLanguages = {}));
+})(RedisSearchLanguages || (exports.RedisSearchLanguages = RedisSearchLanguages = {}));
 function pushSortByProperty(args, sortBy) {
     if (typeof sortBy === 'string') {
         args.push(sortBy);
@@ -172,19 +175,19 @@ var SchemaFieldTypes;
     SchemaFieldTypes["GEO"] = "GEO";
     SchemaFieldTypes["TAG"] = "TAG";
     SchemaFieldTypes["VECTOR"] = "VECTOR";
-})(SchemaFieldTypes = exports.SchemaFieldTypes || (exports.SchemaFieldTypes = {}));
+})(SchemaFieldTypes || (exports.SchemaFieldTypes = SchemaFieldTypes = {}));
 var SchemaTextFieldPhonetics;
 (function (SchemaTextFieldPhonetics) {
     SchemaTextFieldPhonetics["DM_EN"] = "dm:en";
     SchemaTextFieldPhonetics["DM_FR"] = "dm:fr";
     SchemaTextFieldPhonetics["FM_PT"] = "dm:pt";
     SchemaTextFieldPhonetics["DM_ES"] = "dm:es";
-})(SchemaTextFieldPhonetics = exports.SchemaTextFieldPhonetics || (exports.SchemaTextFieldPhonetics = {}));
+})(SchemaTextFieldPhonetics || (exports.SchemaTextFieldPhonetics = SchemaTextFieldPhonetics = {}));
 var VectorAlgorithms;
 (function (VectorAlgorithms) {
     VectorAlgorithms["FLAT"] = "FLAT";
     VectorAlgorithms["HNSW"] = "HNSW";
-})(VectorAlgorithms = exports.VectorAlgorithms || (exports.VectorAlgorithms = {}));
+})(VectorAlgorithms || (exports.VectorAlgorithms = VectorAlgorithms = {}));
 function pushSchema(args, schema) {
     for (const [field, fieldOptions] of Object.entries(schema)) {
         args.push(field);
@@ -362,6 +365,9 @@ function pushSearchOptions(args, options) {
     if (options?.RETURN?.length === 0) {
         args.preserve = true;
     }
+    if (options?.TIMEOUT !== undefined) {
+        args.push('TIMEOUT', options.TIMEOUT.toString());
+    }
     return args;
 }
 exports.pushSearchOptions = pushSearchOptions;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redis/search",
-  "version": "1.1.2",
+  "version": "1.1.4",
   "license": "MIT",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -18,12 +18,24 @@
   "devDependencies": {
     "@istanbuljs/nyc-config-typescript": "^1.0.2",
     "@redis/test-utils": "*",
-    "@types/node": "^18.14.1",
+    "@types/node": "^20.6.2",
     "nyc": "^15.1.0",
-    "release-it": "^15.6.0",
+    "release-it": "^16.1.5",
     "source-map-support": "^0.5.21",
     "ts-node": "^10.9.1",
-    "typedoc": "^0.23.25",
-    "typescript": "^4.9.5"
-  }
+    "typedoc": "^0.25.1",
+    "typescript": "^5.2.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/redis/node-redis.git"
+  },
+  "bugs": {
+    "url": "https://github.com/redis/node-redis/issues"
+  },
+  "homepage": "https://github.com/redis/node-redis/tree/master/packages/search",
+  "keywords": [
+    "redis",
+    "RediSearch"
+  ]
 }