@redis/search 1.1.5 → 1.2.0

package/dist/commands/AGGREGATE.d.ts

@@ -94,7 +94,8 @@ type LoadField = PropertyName | {
     AS?: string;
 };
 export interface AggregateOptions {
-    VERBATIM?: true;
+    VERBATIM?: boolean;
+    ADDSCORES?: boolean;
     LOAD?: LoadField | Array<LoadField>;
     STEPS?: Array<GroupByStep | SortStep | ApplyStep | LimitStep | FilterStep>;
     PARAMS?: Params;

package/dist/commands/AGGREGATE.js

@@ -37,6 +37,9 @@ function pushAggregatehOptions(args, options) {
     if (options?.VERBATIM) {
         args.push('VERBATIM');
     }
+    if (options?.ADDSCORES) {
+        args.push('ADDSCORES');
+    }
     if (options?.LOAD) {
         args.push('LOAD');
         (0, _1.pushArgumentsWithLength)(args, () => {

package/dist/commands/index.d.ts

@@ -145,16 +145,19 @@ export declare enum SchemaFieldTypes {
     NUMERIC = "NUMERIC",
     GEO = "GEO",
     TAG = "TAG",
-    VECTOR = "VECTOR"
+    VECTOR = "VECTOR",
+    GEOSHAPE = "GEOSHAPE"
 }
 type CreateSchemaField<T extends SchemaFieldTypes, E = Record<PropertyKey, unknown>> = T | ({
     type: T;
     AS?: string;
+    INDEXMISSING?: boolean;
 } & E);
-type CreateSchemaCommonField<T extends SchemaFieldTypes, E = Record<PropertyKey, unknown>> = CreateSchemaField<T, ({
-    SORTABLE?: true | 'UNF';
-    NOINDEX?: true;
-} & E)>;
+type CommonFieldArguments = {
+    SORTABLE?: boolean | 'UNF';
+    NOINDEX?: boolean;
+};
+type CreateSchemaCommonField<T extends SchemaFieldTypes, E = Record<PropertyKey, unknown>> = CreateSchemaField<T, (CommonFieldArguments & E)>;
 export declare enum SchemaTextFieldPhonetics {
     DM_EN = "dm:en",
     DM_FR = "dm:fr",
@@ -166,6 +169,7 @@ type CreateSchemaTextField = CreateSchemaCommonField<SchemaFieldTypes.TEXT, {
     WEIGHT?: number;
     PHONETIC?: SchemaTextFieldPhonetics;
     WITHSUFFIXTRIE?: boolean;
+    INDEXEMPTY?: boolean;
 }>;
 type CreateSchemaNumericField = CreateSchemaCommonField<SchemaFieldTypes.NUMERIC>;
 type CreateSchemaGeoField = CreateSchemaCommonField<SchemaFieldTypes.GEO>;
@@ -173,6 +177,7 @@ type CreateSchemaTagField = CreateSchemaCommonField<SchemaFieldTypes.TAG, {
     SEPARATOR?: string;
     CASESENSITIVE?: true;
     WITHSUFFIXTRIE?: boolean;
+    INDEXEMPTY?: boolean;
 }>;
 export declare enum VectorAlgorithms {
     FLAT = "FLAT",
@@ -193,8 +198,16 @@ type CreateSchemaHNSWVectorField = CreateSchemaVectorField<VectorAlgorithms.HNSW
     EF_CONSTRUCTION?: number;
     EF_RUNTIME?: number;
 }>;
+export declare const SCHEMA_GEO_SHAPE_COORD_SYSTEM: {
+    readonly SPHERICAL: "SPHERICAL";
+    readonly FLAT: "FLAT";
+};
+export type SchemaGeoShapeFieldCoordSystem = typeof SCHEMA_GEO_SHAPE_COORD_SYSTEM[keyof typeof SCHEMA_GEO_SHAPE_COORD_SYSTEM];
+type CreateSchemaGeoShapeField = CreateSchemaCommonField<SchemaFieldTypes.GEOSHAPE, {
+    COORD_SYSTEM?: SchemaGeoShapeFieldCoordSystem;
+}>;
 export interface RediSearchSchema {
-    [field: string]: CreateSchemaTextField | CreateSchemaNumericField | CreateSchemaGeoField | CreateSchemaTagField | CreateSchemaFlatVectorField | CreateSchemaHNSWVectorField;
+    [field: string]: CreateSchemaTextField | CreateSchemaNumericField | CreateSchemaGeoField | CreateSchemaTagField | CreateSchemaFlatVectorField | CreateSchemaHNSWVectorField | CreateSchemaGeoShapeField;
 }
 export declare function pushSchema(args: RedisCommandArguments, schema: RediSearchSchema): void;
 export type Params = Record<string, RedisCommandArgument | number>;

package/dist/commands/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.transformProfile = exports.pushSearchOptions = exports.pushParamsArgs = exports.pushSchema = exports.VectorAlgorithms = exports.SchemaTextFieldPhonetics = exports.SchemaFieldTypes = exports.pushArgumentsWithLength = exports.pushSortByArguments = exports.pushSortByProperty = exports.RedisSearchLanguages = void 0;
+exports.transformProfile = exports.pushSearchOptions = exports.pushParamsArgs = exports.pushSchema = exports.SCHEMA_GEO_SHAPE_COORD_SYSTEM = exports.VectorAlgorithms = exports.SchemaTextFieldPhonetics = exports.SchemaFieldTypes = exports.pushArgumentsWithLength = exports.pushSortByArguments = exports.pushSortByProperty = exports.RedisSearchLanguages = void 0;
 const _LIST = require("./_LIST");
 const ALTER = require("./ALTER");
 const AGGREGATE_WITHCURSOR = require("./AGGREGATE_WITHCURSOR");
@@ -175,7 +175,19 @@ var SchemaFieldTypes;
     SchemaFieldTypes["GEO"] = "GEO";
     SchemaFieldTypes["TAG"] = "TAG";
     SchemaFieldTypes["VECTOR"] = "VECTOR";
+    SchemaFieldTypes["GEOSHAPE"] = "GEOSHAPE";
 })(SchemaFieldTypes || (exports.SchemaFieldTypes = SchemaFieldTypes = {}));
+function pushCommonFieldArguments(args, fieldOptions) {
+    if (fieldOptions.SORTABLE) {
+        args.push('SORTABLE');
+        if (fieldOptions.SORTABLE === 'UNF') {
+            args.push('UNF');
+        }
+    }
+    if (fieldOptions.NOINDEX) {
+        args.push('NOINDEX');
+    }
+}
 var SchemaTextFieldPhonetics;
 (function (SchemaTextFieldPhonetics) {
     SchemaTextFieldPhonetics["DM_EN"] = "dm:en";
@@ -188,6 +200,10 @@ var VectorAlgorithms;
     VectorAlgorithms["FLAT"] = "FLAT";
     VectorAlgorithms["HNSW"] = "HNSW";
 })(VectorAlgorithms || (exports.VectorAlgorithms = VectorAlgorithms = {}));
+exports.SCHEMA_GEO_SHAPE_COORD_SYSTEM = {
+    SPHERICAL: 'SPHERICAL',
+    FLAT: 'FLAT'
+};
 function pushSchema(args, schema) {
     for (const [field, fieldOptions] of Object.entries(schema)) {
         args.push(field);
@@ -213,10 +229,15 @@ function pushSchema(args, schema) {
                 if (fieldOptions.WITHSUFFIXTRIE) {
                     args.push('WITHSUFFIXTRIE');
                 }
+                pushCommonFieldArguments(args, fieldOptions);
+                if (fieldOptions.INDEXEMPTY) {
+                    args.push('INDEXEMPTY');
+                }
+                break;
+            case SchemaFieldTypes.NUMERIC:
+            case SchemaFieldTypes.GEO:
+                pushCommonFieldArguments(args, fieldOptions);
                 break;
-            // case SchemaFieldTypes.NUMERIC:
-            // case SchemaFieldTypes.GEO:
-            //     break;
             case SchemaFieldTypes.TAG:
                 if (fieldOptions.SEPARATOR) {
                     args.push('SEPARATOR', fieldOptions.SEPARATOR);
@@ -227,6 +248,10 @@ function pushSchema(args, schema) {
                 if (fieldOptions.WITHSUFFIXTRIE) {
                     args.push('WITHSUFFIXTRIE');
                 }
+                pushCommonFieldArguments(args, fieldOptions);
+                if (fieldOptions.INDEXEMPTY) {
+                    args.push('INDEXEMPTY');
+                }
                 break;
             case SchemaFieldTypes.VECTOR:
                 args.push(fieldOptions.ALGORITHM);
@@ -254,16 +279,16 @@ function pushSchema(args, schema) {
                             break;
                     }
                 });
-                continue; // vector fields do not contain SORTABLE and NOINDEX options
-        }
-        if (fieldOptions.SORTABLE) {
-            args.push('SORTABLE');
-            if (fieldOptions.SORTABLE === 'UNF') {
-                args.push('UNF');
-            }
+                break;
+            case SchemaFieldTypes.GEOSHAPE:
+                if (fieldOptions.COORD_SYSTEM !== undefined) {
+                    args.push('COORD_SYSTEM', fieldOptions.COORD_SYSTEM);
+                }
+                pushCommonFieldArguments(args, fieldOptions);
+                break;
         }
-        if (fieldOptions.NOINDEX) {
-            args.push('NOINDEX');
+        if (fieldOptions.INDEXMISSING) {
+            args.push('INDEXMISSING');
         }
     }
 }

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 export { default } from './commands';
-export { RediSearchSchema, SchemaFieldTypes, SchemaTextFieldPhonetics, SearchReply, VectorAlgorithms } from './commands';
-export { AggregateSteps, AggregateGroupByReducers } from './commands/AGGREGATE';
+export { RediSearchSchema, RedisSearchLanguages, SchemaFieldTypes, SchemaTextFieldPhonetics, SearchReply, VectorAlgorithms } from './commands';
+export { AggregateGroupByReducers, AggregateSteps } from './commands/AGGREGATE';
 export { SearchOptions } from './commands/SEARCH';

package/dist/index.js

@@ -1,12 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AggregateGroupByReducers = exports.AggregateSteps = exports.VectorAlgorithms = exports.SchemaTextFieldPhonetics = exports.SchemaFieldTypes = exports.default = void 0;
+exports.AggregateSteps = exports.AggregateGroupByReducers = exports.VectorAlgorithms = exports.SchemaTextFieldPhonetics = exports.SchemaFieldTypes = exports.RedisSearchLanguages = exports.default = void 0;
 var commands_1 = require("./commands");
 Object.defineProperty(exports, "default", { enumerable: true, get: function () { return commands_1.default; } });
 var commands_2 = require("./commands");
+Object.defineProperty(exports, "RedisSearchLanguages", { enumerable: true, get: function () { return commands_2.RedisSearchLanguages; } });
 Object.defineProperty(exports, "SchemaFieldTypes", { enumerable: true, get: function () { return commands_2.SchemaFieldTypes; } });
 Object.defineProperty(exports, "SchemaTextFieldPhonetics", { enumerable: true, get: function () { return commands_2.SchemaTextFieldPhonetics; } });
 Object.defineProperty(exports, "VectorAlgorithms", { enumerable: true, get: function () { return commands_2.VectorAlgorithms; } });
 var AGGREGATE_1 = require("./commands/AGGREGATE");
-Object.defineProperty(exports, "AggregateSteps", { enumerable: true, get: function () { return AGGREGATE_1.AggregateSteps; } });
 Object.defineProperty(exports, "AggregateGroupByReducers", { enumerable: true, get: function () { return AGGREGATE_1.AggregateGroupByReducers; } });
+Object.defineProperty(exports, "AggregateSteps", { enumerable: true, get: function () { return AGGREGATE_1.AggregateSteps; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redis/search",
-  "version": "1.1.5",
+  "version": "1.2.0",
   "license": "MIT",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",