export RediSearchSchema type (#1825)

* export RediSearchSchema type

* export SearchOptions and SearchReply

Author: leibale

packages/search/lib/commands/ALTER.ts

@@ -1,6 +1,6 @@
-import { CreateSchema, pushSchema } from '.';
+import { RediSearchSchema, pushSchema } from '.';
 
-export function transformArguments(index: string, schema: CreateSchema): Array<string> {
+export function transformArguments(index: string, schema: RediSearchSchema): Array<string> {
     const args = ['FT.ALTER', index, 'SCHEMA', 'ADD'];
     pushSchema(args, schema);
 

packages/search/lib/commands/CREATE.ts

@@ -1,5 +1,5 @@
 import { pushOptionalVerdictArgument } from '@node-redis/client/dist/lib/commands/generic-transformers';
-import { RedisSearchLanguages, PropertyName, CreateSchema, pushSchema } from '.';
+import { RedisSearchLanguages, PropertyName, RediSearchSchema, pushSchema } from '.';
 
 interface CreateOptions {
     ON?: 'HASH' | 'JSON';
@@ -20,7 +20,7 @@ interface CreateOptions {
     STOPWORDS?: string | Array<string>;
 }
 
-export function transformArguments(index: string, schema: CreateSchema, options?: CreateOptions): Array<string> {
+export function transformArguments(index: string, schema: RediSearchSchema, options?: CreateOptions): Array<string> {
     const args = ['FT.CREATE', index];
 
     if (options?.ON) {

packages/search/lib/commands/index.ts

@@ -204,15 +204,15 @@ type CreateSchemaTagField = CreateSchemaField<SchemaFieldTypes.TAG, {
     CASESENSITIVE?: true;
 }>;
 
-export interface CreateSchema {
+export interface RediSearchSchema {
     [field: string]:
         CreateSchemaTextField |
         CreateSchemaNumericField |
         CreateSchemaGeoField |
         CreateSchemaTagField
 }
 
-export function pushSchema(args: RedisCommandArguments, schema: CreateSchema) {
+export function pushSchema(args: RedisCommandArguments, schema: RediSearchSchema) {
     for (const [field, fieldOptions] of Object.entries(schema)) {
         args.push(field);
 
@@ -396,7 +396,6 @@ export interface SearchReply {
     }>;
 }
 
-
 export interface ProfileOptions {
     LIMITED?: true;
 }

packages/search/lib/index.ts

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