@depup/typesense 3.0.5-depup.1 → 3.1.0-depup.0

package/src/Typesense/Document.ts

@@ -5,6 +5,12 @@ import Documents, {
   DocumentSchema,
   DocumentWriteParameters,
 } from "./Documents";
+import { normalizeArrayableParams } from "./Utils";
+
+export interface DocumentsRetrieveParameters {
+  include_fields?: string | string[];
+  exclude_fields?: string | string[];
+}
 
 export class Document<T extends DocumentSchema = object> {
   constructor(
@@ -13,8 +19,10 @@ export class Document<T extends DocumentSchema = object> {
     private apiCall: ApiCall
   ) {}
 
-  async retrieve(): Promise<T> {
-    return this.apiCall.get<T>(this.endpointPath());
+  async retrieve(options?: DocumentsRetrieveParameters): Promise<T> {
+    const queryParams = normalizeArrayableParams(options ?? {})
+    
+    return this.apiCall.get<T>(this.endpointPath(), queryParams);
   }
 
   async delete(options?: DeleteQuery): Promise<T> {

package/src/Typesense/Documents.ts

@@ -214,12 +214,15 @@ export default class Documents<T extends DocumentSchema = object>
     super(collectionName, apiCall, configuration);
   }
 
-  async create(document: T, options: DocumentWriteParameters = {}): Promise<T> {
+  async create(
+    document: T,
+    options: Omit<DocumentWriteParameters, "action"> = {},
+  ): Promise<T> {
     if (!document) throw new Error("No document provided");
     return this.apiCall.post<T>(this.endpointPath(), document, options);
   }
 
-  async upsert(document: T, options: DocumentWriteParameters = {}): Promise<T> {
+  async upsert(document: T, options: Omit<DocumentWriteParameters, "action"> = {}): Promise<T> {
     if (!document) throw new Error("No document provided");
     return this.apiCall.post<T>(
       this.endpointPath(),
@@ -232,10 +235,10 @@ export default class Documents<T extends DocumentSchema = object>
     document: T,
     options: UpdateByFilterParameters,
   ): Promise<UpdateByFilterResponse>;
-  async update(document: T, options: DocumentWriteParameters): Promise<T>;
+  async update(document: T, options: Omit<DocumentWriteParameters, "action">): Promise<T>;
   async update(
     document: T,
-    options: DocumentWriteParameters | UpdateByFilterParameters = {},
+    options: Omit<DocumentWriteParameters, "action"> | UpdateByFilterParameters = {},
   ): Promise<UpdateByFilterResponse | T> {
     if (!document) throw new Error("No document provided");
 
@@ -254,6 +257,35 @@ export default class Documents<T extends DocumentSchema = object>
     }
   }
 
+  async emplace(
+    document: T,
+    options: UpdateByFilterParameters,
+  ): Promise<UpdateByFilterResponse>;
+  async emplace(
+    document: T,
+    options: Omit<DocumentWriteParameters, "action">,
+  ): Promise<T>;
+  async emplace(
+    document: T,
+    options: Omit<DocumentWriteParameters, "action"> | UpdateByFilterParameters = {},
+  ): Promise<UpdateByFilterResponse | T> {
+    if (!document) throw new Error("No document provided");
+
+    if (options["filter_by"] != null) {
+      return this.apiCall.patch<T>(
+        this.endpointPath(),
+        document,
+        Object.assign({}, options),
+      );
+    } else {
+      return this.apiCall.post<T>(
+        this.endpointPath(),
+        document,
+        Object.assign({}, options, { action: "emplace" }),
+      );
+    }
+  }
+
   async delete(
     query: DeleteQuery = {} as DeleteQuery,
   ): Promise<DeleteResponse<T>> {

package/src/Typesense/MultiSearch.ts

@@ -87,9 +87,14 @@ export default class MultiSearch {
     }
 
     const normalizedSearchRequests: Omit<typeof searchRequests, "searches"> & {
+      remove_duplicates?: boolean;
       searches: ExtractBaseTypes<SearchParams<T[number], Infix>>[];
     } = {
       union: searchRequests.union,
+      remove_duplicates:
+        "remove_duplicates" in searchRequests
+          ? searchRequests.remove_duplicates
+          : undefined,
       searches: searchRequests.searches.map(
         normalizeArrayableParams<
           T[number],
@@ -124,8 +129,8 @@ export default class MultiSearch {
     );
   }
 
-  private isStreamingRequest(commonParams: { streamConfig?: unknown }) {
-    return commonParams.streamConfig !== undefined;
+  private isStreamingRequest(commonParams: { conversation_stream?: boolean }) {
+    return commonParams.conversation_stream === true;
   }
 
   private hasAnySearchObjectPagination(searchRequests: MultiSearchRequestsSchema<DocumentSchema, string>) {

package/src/Typesense/Types.ts

@@ -202,9 +202,22 @@ export interface SearchableDocuments<
 }
 
 export interface WriteableDocuments<T> {
-  create(document: T, options: DocumentWriteParameters): Promise<T>;
-  upsert(document: T, options: DocumentWriteParameters): Promise<T>;
-  update(document: T, options: DocumentWriteParameters): Promise<T>;
+  create(
+    document: T,
+    options: Omit<DocumentWriteParameters, "action">,
+  ): Promise<T>;
+  upsert(
+    document: T,
+    options: Omit<DocumentWriteParameters, "action">,
+  ): Promise<T>;
+  update(
+    document: T,
+    options: Omit<DocumentWriteParameters, "action">,
+  ): Promise<T>;
+  emplace(
+    document: T,
+    options: Omit<DocumentWriteParameters, "action">,
+  ): Promise<T>;
   delete(query: DeleteQuery): Promise<DeleteResponse>;
   import(
     documents: T[] | string,
@@ -245,6 +258,7 @@ export interface MultiSearchRequestsWithUnionSchema<
   Infix extends string,
 > extends SearchesMultiSearchesRequestSchema<T, Infix> {
   union: true;
+  remove_duplicates?: boolean;
 }
 
 export interface MultiSearchRequestsWithoutUnionSchema<
@@ -263,7 +277,14 @@ export type MultiSearchRequestsSchema<
 
 export interface UnionSearchResponse<T extends DocumentSchema>
   extends Omit<SearchResponse<T>, "request_params"> {
-  union_request_params: SearchResponseRequestParams[];
+  union_request_params: UnionSearchResponseRequestParams[];
+}
+
+type AllRequiredBut<T, K extends keyof T> = Required<Omit<T, K>> & Pick<T, K>;
+
+export interface UnionSearchResponseRequestParams
+  extends AllRequiredBut<SearchResponseRequestParams, "voice_query"> {
+  found: number;
 }
 
 export type MultiSearchResponse<