Add missing types for metadata. #197

typesense · Apr 10, 2024 · 0c06636 · 0c06636
1 parent c228d6c
commit 0c06636
Show file tree

Hide file tree

Showing 8 changed files with 32 additions and 16 deletions.
diff --git a/dist/typesense.js.map b/dist/typesense.js.map
diff --git a/dist/typesense.min.js.map b/dist/typesense.min.js.map
diff --git a/lib/Typesense/Collections.d.ts b/lib/Typesense/Collections.d.ts
@@ -7,6 +7,7 @@ export interface CollectionCreateSchema {
     symbols_to_index?: string[];
     token_separators?: string[];
     enable_nested_fields?: boolean;
+    metadata?: object;
 }
 export interface CollectionCreateOptions {
     src_name?: string;

diff --git a/lib/Typesense/Collections.js.map b/lib/Typesense/Collections.js.map
diff --git a/lib/Typesense/Overrides.d.ts b/lib/Typesense/Overrides.d.ts
@@ -1,14 +1,17 @@
 import ApiCall from "./ApiCall";
 import { OverrideSchema } from "./Override";
 export interface OverrideRuleQuerySchema {
-    query: string;
-    match: "exact" | "contains";
+    query?: string;
+    match?: "exact" | "contains";
 }
 export interface OverrideRuleFilterSchema {
-    filter_by: string;
+    filter_by?: string;
+}
+export interface OverrideRuleTagsSchema {
+    tags?: string[];
 }
 export interface OverrideCreateSchema {
-    rule: OverrideRuleQuerySchema | OverrideRuleFilterSchema;
+    rule: OverrideRuleQuerySchema & OverrideRuleFilterSchema & OverrideRuleTagsSchema;
     filter_by?: string;
     sort_by?: string;
     remove_matched_tokens?: boolean;
@@ -24,6 +27,7 @@ export interface OverrideCreateSchema {
     effective_from_ts?: number;
     effective_to_ts?: number;
     stop_processing?: boolean;
+    metadata?: object;
 }
 export interface OverridesRetrieveSchema {
     overrides: OverrideSchema[];

diff --git a/lib/Typesense/Overrides.js.map b/lib/Typesense/Overrides.js.map
diff --git a/src/Typesense/Collections.ts b/src/Typesense/Collections.ts
@@ -8,6 +8,7 @@ export interface CollectionCreateSchema {
   symbols_to_index?: string[];
   token_separators?: string[];
   enable_nested_fields?: boolean;
+  metadata?: object;
 }
 
 export interface CollectionCreateOptions {
@@ -21,7 +22,7 @@ export default class Collections {
 
   async create(
     schema: CollectionCreateSchema,
-    options: CollectionCreateOptions = {}
+    options: CollectionCreateOptions = {},
   ): Promise<CollectionSchema> {
     return this.apiCall.post<CollectionSchema>(RESOURCEPATH, schema, options);
   }

diff --git a/src/Typesense/Overrides.ts b/src/Typesense/Overrides.ts
@@ -5,16 +5,22 @@ import { OverrideSchema } from "./Override";
 const RESOURCEPATH = "/overrides";
 
 export interface OverrideRuleQuerySchema {
-  query: string;
-  match: "exact" | "contains";
+  query?: string;
+  match?: "exact" | "contains";
 }
 
 export interface OverrideRuleFilterSchema {
-  filter_by: string;
+  filter_by?: string;
+}
+
+export interface OverrideRuleTagsSchema {
+  tags?: string[];
 }
 
 export interface OverrideCreateSchema {
-  rule: OverrideRuleQuerySchema | OverrideRuleFilterSchema;
+  rule: OverrideRuleQuerySchema &
+    OverrideRuleFilterSchema &
+    OverrideRuleTagsSchema;
   filter_by?: string;
   sort_by?: string;
   remove_matched_tokens?: boolean;
@@ -28,22 +34,26 @@ export interface OverrideCreateSchema {
   effective_from_ts?: number;
   effective_to_ts?: number;
   stop_processing?: boolean;
+  metadata?: object;
 }
 
 export interface OverridesRetrieveSchema {
   overrides: OverrideSchema[];
 }
 
 export default class Overrides {
-  constructor(private collectionName: string, private apiCall: ApiCall) {}
+  constructor(
+    private collectionName: string,
+    private apiCall: ApiCall,
+  ) {}
 
   async upsert(
     overrideId: string,
-    params: OverrideCreateSchema
+    params: OverrideCreateSchema,
   ): Promise<OverrideSchema> {
     return this.apiCall.put<OverrideSchema>(
       this.endpointPath(overrideId),
-      params
+      params,
     );
   }