[Search] Fix calculated types (Azure#25999)

Author: dgetu

sdk/search/search-documents/CHANGELOG.md

@@ -8,6 +8,7 @@
 
 ### Bugs Fixed
 
+- Fix compiler errors when using `SearchClient` without defined model. [#25999](https://github.com/Azure/azure-sdk-for-js/pull/25999)
 - Fix all clients adding one or more duplicate user agents. [#26298](https://github.com/Azure/azure-sdk-for-js/pull/26298)
 - Fix serializerOptions and onResponse options for SearchClient methods. [#26327](https://github.com/Azure/azure-sdk-for-js/pull/26327)
 

sdk/search/search-documents/README.md

@@ -318,19 +318,23 @@ main();
 
 #### Querying with TypeScript
 
-In TypeScript `SearchClient` takes a generic parameter that is the model shape of your index documents. This allows you to perform strongly typed lookup of fields returned in results. TypeScript is also able to check for fields returned when specifying a `select` parameter.
+In TypeScript, `SearchClient` takes a generic parameter that is the model shape of your index documents. This allows you to perform strongly typed lookup of fields returned in results. TypeScript is also able to check for fields returned when specifying a `select` parameter.
 
 ```ts
 import { SearchClient, AzureKeyCredential } from "@azure/search-documents";
 
 // An example schema for documents in the index
 interface Hotel {
-  HotelId: string;
-  HotelName: string;
-  Description: string;
-  ParkingIncluded: boolean;
-  LastRenovationDate: Date;
-  Rating: number;
+  hotelId?: string;
+  hotelName?: string | null;
+  description?: string | null;
+  parkingIncluded?: boolean | null;
+  lastRenovationDate?: Date | null;
+  rating?: number | null;
+  rooms?: Array<{
+    beds?: number | null;
+    description?: string | null;
+  } | null;>
 }
 
 const client = new SearchClient<Hotel>(
@@ -343,13 +347,22 @@ async function main() {
   const searchResults = await client.search("wifi -luxury", {
     // Only fields in Hotel can be added to this array.
     // TS will complain if one is misspelled.
-    select: ["HotelId", "HotelName", "Rating"],
+    select: ["hotelId", "hotelName", "rooms/beds"],
   });
 
+  // These are other ways to declare the correct type for `select`.
+  const select = ["hotelId", "hotelName", "rooms/beds"] as const;
+  // This declaration lets you opt out of narrowing the TypeScript type of your documents,
+  // though the Cognitive Search service will still only return these fields.
+  const selectWide: SelectFields<Hotel>[] = ["hotelId", "hotelName", "rooms/beds"];
+  // This is an invalid declaration. Passing this to `select` will result in a compiler error
+  // unless you opt out of including the model in the client constructor.
+  const selectInvalid = ["hotelId", "hotelName", "rooms/beds"];
+
   for await (const result of searchResults.results) {
-    // result.document has HotelId, HotelName, and Rating.
-    // Trying to access result.document.Description would emit a TS error.
-    console.log(result.document.HotelName);
+    // result.document has hotelId, hotelName, and rating.
+    // Trying to access result.document.description would emit a TS error.
+    console.log(result.document.hotelName);
   }
 }
 
@@ -371,7 +384,7 @@ async function main() {
   const searchResults = await client.search("WiFi", {
     filter: odata`Rooms/any(room: room/BaseRate lt ${baseRateMax}) and Rating ge ${ratingMin}`,
     orderBy: ["Rating desc"],
-    select: ["HotelId", "HotelName", "Rating"],
+    select: ["hotelId", "hotelName", "rating"],
   });
   for await (const result of searchResults.results) {
     // Each result will have "HotelId", "HotelName", and "Rating"
@@ -394,17 +407,17 @@ const client = new SearchClient("<endpoint>", "<indexName>", new AzureKeyCredent
 
 async function main() {
   const searchResults = await client.search("WiFi", {
-    facets: ["Category,count:3,sort:count", "Rooms/BaseRate,interval:100"],
+    facets: ["category,count:3,sort:count", "rooms/baseRate,interval:100"],
   });
   console.log(searchResults.facets);
   // Output will look like:
   // {
-  //   'Rooms/BaseRate': [
+  //   'rooms/baseRate': [
   //     { count: 16, value: 0 },
   //     { count: 17, value: 100 },
   //     { count: 17, value: 200 }
   //   ],
-  //   Category: [
+  //   category: [
   //     { count: 5, value: 'Budget' },
   //     { count: 5, value: 'Luxury' },
   //     { count: 5, value: 'Resort and Spa' }

sdk/search/search-documents/review/search-documents.api.md

@@ -11,7 +11,7 @@
 import { GeographyPoint } from "@azure/search-documents";
 
 export interface Hotel {
-  hotelId: string;
+  hotelId?: string;
   hotelName?: string | null;
   description?: string | null;
   descriptionFr?: string | null;

sdk/search/search-documents/samples-dev/interfaces.ts

@@ -0,0 +1,110 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+/**
+ * @summary Demonstrates the SearchClient.
+ */
+
+import {
+  AzureKeyCredential,
+  SearchClient,
+  GeographyPoint,
+  SearchIndexClient,
+  SelectFields,
+} from "@azure/search-documents";
+import { createIndex, WAIT_TIME, delay } from "./setup";
+import { Hotel } from "./interfaces";
+
+import * as dotenv from "dotenv";
+dotenv.config();
+
+/**
+ * This sample is to demonstrate the use of SearchClient.
+ */
+const endpoint = process.env.ENDPOINT || "";
+const apiKey = process.env.SEARCH_API_ADMIN_KEY || "";
+const TEST_INDEX_NAME = "example-index-sample-2";
+
+async function main() {
+  if (!endpoint || !apiKey) {
+    console.log("Make sure to set valid values for endpoint and apiKey with proper authorization.");
+    return;
+  }
+
+  const credential = new AzureKeyCredential(apiKey);
+
+  // The client can optionally be instantiated with a model type for a more rich typing experience.
+  // For the best experience, ensure that every property of the model type can be assigned `null`
+  // except for the document key. All properties should be optional, but you may mark properties as
+  // non-optional when your queries always select them.
+  const searchClient: SearchClient<Hotel> = new SearchClient<Hotel>(
+    endpoint,
+    TEST_INDEX_NAME,
+    credential
+  );
+
+  const indexClient: SearchIndexClient = new SearchIndexClient(endpoint, credential);
+  await createIndex(indexClient, TEST_INDEX_NAME);
+  await delay(WAIT_TIME);
+
+  const uploadResult = await searchClient.mergeOrUploadDocuments([
+    {
+      hotelId: "1",
+      description:
+        "Best hotel in town if you like luxury hotels. They have an amazing infinity pool, a spa, " +
+        "and a really helpful concierge. The location is perfect -- right downtown, close to all " +
+        "the tourist attractions. We highly recommend this hotel.",
+      descriptionFr:
+        "Meilleur hôtel en ville si vous aimez les hôtels de luxe. Ils ont une magnifique piscine " +
+        "à débordement, un spa et un concierge très utile. L'emplacement est parfait – en plein " +
+        "centre, à proximité de toutes les attractions touristiques. Nous recommandons fortement " +
+        "cet hôtel.",
+      hotelName: "Fancy Stay",
+      category: "Luxury",
+      tags: ["pool", "view", "wifi", "concierge"],
+      parkingIncluded: false,
+      lastRenovationDate: new Date(2010, 5, 27),
+      rating: 5,
+      location: new GeographyPoint({
+        longitude: -122.131577,
+        latitude: 47.678581,
+      }),
+    },
+  ]);
+
+  const uploadsSucceeded = uploadResult.results.every((result) => result.succeeded);
+
+  if (!uploadsSucceeded) {
+    console.log("Some documents failed to be indexed.");
+  }
+
+  await delay(WAIT_TIME);
+
+  // These fields will be searched against.
+  const searchFields: SelectFields<Hotel>[] = ["description", "rooms/description"];
+
+  // If you specify your selected fields either inline or as shown below, your documents will be
+  // returned with their type narrowed to those fields. If you'd like to build your selected fields
+  // dynamically, or you'd like to opt out of narrowing the document type, you can declare your
+  // selected fields with type `SelectFields<TModel>[]` as shown with `searchFields` above.
+  // You can permanently opt out of document type narrowing by omitting the model type parameter
+  // from the client constructor. In that case, you can use the `string[]` type.
+  const select = ["hotelName"] as const;
+
+  const searchResults = await searchClient.search("luxury", {
+    select,
+    searchFields,
+    includeTotalCount: true,
+  });
+
+  console.log(`Result count: ${searchResults.count}`);
+
+  for await (const result of searchResults.results) {
+    const name = result.document.hotelName;
+    console.log(name);
+  }
+
+  await indexClient.deleteIndex(TEST_INDEX_NAME);
+}
+
+main();

sdk/search/search-documents/samples-dev/searchClientOperations.ts

@@ -12,7 +12,7 @@ import { Hotel } from "./interfaces";
 export const WAIT_TIME = 4000;
 
 export const documentKeyRetriever: (document: Hotel) => string = (document: Hotel): string => {
-  return document.hotelId;
+  return document.hotelId!;
 };
 
 /**

sdk/search/search-documents/samples-dev/setup.ts

@@ -41,6 +41,8 @@ export {
   SearchIndexingBufferedSenderMergeOrUploadDocumentsOptions,
   SearchIndexingBufferedSenderUploadDocumentsOptions,
   SearchPick,
+  SearchFieldArray,
+  SelectArray,
   SelectFields,
   SuggestNarrowedModel,
   UnionToIntersection,