Added test cases for query, stored procedures. and updated README.md …

…for hierarchical partition containers.

Added hierarchical partition support for change feed api.

Added utilities for type checks for PartitionKey

Added typeChecks.ts to skip strict typechecks.

Added @remark annotation, notifying PartitionKeyDefinition as no longer part of PartitionKey

exporting newly added types to top level index.ts

sdk/cosmosdb/cosmos/README.md

@@ -101,7 +101,7 @@ The following sections provide several code snippets covering some of the most c
 - [Query documents](#query-the-database)
 - [Read an item](#read-an-item)
 - [Delete an item](#delete-an-data)
-
+- [CRUD on Container with hierarchical partition key](#container-hierarchical-partition-key)
 ### Create a database
 
 After authenticating your [CosmosClient](https://docs.microsoft.com/javascript/api/@azure/cosmos/cosmosclient?view=azure-node-latest), you can work with any resource in the account. The code snippet below creates a SQL API database.
@@ -144,7 +144,46 @@ To read a single item from a container, use [Item.read](https://docs.microsoft.c
 ```js
 await container.item("1").read();
 ```
-
+### CRUD on Container with hierarchical partition key
+```js
+const containerDefinition = {
+  id: "Test Database",
+  partitionKey: {
+    paths: ["/name", "/address/zip"],
+    version: PartitionKeyDefinitionVersion.V2,
+    kind: PartitionKeyKind.MultiHash,
+  },
+}
+const { container } = await database.containers.createIfNotExists(containerDefinition);
+console.log(container.id);
+```
+#### Insert an item with hierarchical partition key
+```js
+const item = {
+  id: 1,
+  name: 'foo',
+  address: {
+    zip: 100
+  },
+  active: true
+}
+await container.items.create(item);
+```
+#### Read an item with hierarchical partition key
+```js
+To read a single item from a container with hierarchical partition key defines as `paths: ["/name", "/address/zip"],`
+await container.item("1", ["foo", 100]).read();
+```
+#### Query an item with hierarchical partition key
+```js
+const { resources } = await container.items
+  .query("SELECT * from c WHERE c.active = true", {
+          partitionKey: ["foo", 100],
+        })
+  .fetchAll();
+for (const item of resources) {
+  console.log(`${item.name}, ${item.address.zip} `);
+}
 ### Delete an item
 
 To delete items from a container, use [Item.delete](https://docs.microsoft.com/javascript/api/@azure/cosmos/item?view=azure-node-latest#delete-requestoptions-).

sdk/cosmosdb/cosmos/review/cosmos.api.md

@@ -908,9 +908,9 @@ export class Items {
     constructor(container: Container, clientContext: ClientContext);
     batch(operations: OperationInput[], partitionKey?: PartitionKey, options?: RequestOptions): Promise<Response_2<OperationResponse[]>>;
     bulk(operations: OperationInput[], bulkOptions?: BulkOptions, options?: RequestOptions): Promise<OperationResponse[]>;
-    changeFeed(partitionKey: string | number | boolean, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>;
+    changeFeed(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>;
     changeFeed(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>;
-    changeFeed<T>(partitionKey: string | number | boolean, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>;
+    changeFeed<T>(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>;
     changeFeed<T>(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>;
     // (undocumented)
     readonly container: Container;
@@ -920,11 +920,11 @@ export class Items {
     readAll(options?: FeedOptions): QueryIterator<ItemDefinition>;
     readAll<T extends ItemDefinition>(options?: FeedOptions): QueryIterator<T>;
     // @deprecated
-    readChangeFeed(partitionKey: string | number | boolean, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>;
+    readChangeFeed(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>;
     // @deprecated
     readChangeFeed(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>;
     // @deprecated
-    readChangeFeed<T>(partitionKey: string | number | boolean, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>;
+    readChangeFeed<T>(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>;
     // @deprecated
     readChangeFeed<T>(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>;
     upsert(body: unknown, options?: RequestOptions): Promise<ItemResponse<ItemDefinition>>;

sdk/cosmosdb/cosmos/src/ChangeFeedIterator.ts

@@ -6,6 +6,7 @@ import { ChangeFeedResponse } from "./ChangeFeedResponse";
 import { Resource } from "./client";
 import { ClientContext } from "./ClientContext";
 import { Constants, ResourceType, StatusCodes } from "./common";
+import { PartitionKey } from "./documents";
 import { FeedOptions } from "./request";
 import { Response } from "./request";
 
@@ -28,7 +29,7 @@ export class ChangeFeedIterator<T> {
     private clientContext: ClientContext,
     private resourceId: string,
     private resourceLink: string,
-    private partitionKey: string | number | boolean,
+    private partitionKey: PartitionKey,
     private changeFeedOptions: ChangeFeedOptions
   ) {
     // partition key XOR partition key range id

sdk/cosmosdb/cosmos/src/client/Item/Items.ts

@@ -24,18 +24,15 @@ import {
   decorateBatchOperation,
   splitBatchBasedOnBodySize,
 } from "../../utils/batch";
-import { assertNotUndefined } from "../../utils/typeChecks";
+import { assertNotUndefined, isPrimitivePartitionKeyValue } from "../../utils/typeChecks";
 import { hashPartitionKey } from "../../utils/hashing/hash";
 import { PartitionKey, PartitionKeyDefinition } from "../../documents";
 
 /**
  * @hidden
  */
 function isChangeFeedOptions(options: unknown): options is ChangeFeedOptions {
-  const optionsType = typeof options;
-  return (
-    options && !(optionsType === "string" || optionsType === "boolean" || optionsType === "number")
-  );
+  return options && !(isPrimitivePartitionKeyValue(options) || Array.isArray(options));
 }
 
 /**
@@ -126,7 +123,7 @@ export class Items {
    * ```
    */
   public readChangeFeed(
-    partitionKey: string | number | boolean,
+    partitionKey: PartitionKey,
     changeFeedOptions?: ChangeFeedOptions
   ): ChangeFeedIterator<any>;
   /**
@@ -140,7 +137,7 @@ export class Items {
    * @deprecated Use `changeFeed` instead.
    */
   public readChangeFeed<T>(
-    partitionKey: string | number | boolean,
+    partitionKey: PartitionKey,
     changeFeedOptions?: ChangeFeedOptions
   ): ChangeFeedIterator<T>;
   /**
@@ -149,7 +146,7 @@ export class Items {
    */
   public readChangeFeed<T>(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>;
   public readChangeFeed<T>(
-    partitionKeyOrChangeFeedOptions?: string | number | boolean | ChangeFeedOptions,
+    partitionKeyOrChangeFeedOptions?: PartitionKey | ChangeFeedOptions,
     changeFeedOptions?: ChangeFeedOptions
   ): ChangeFeedIterator<T> {
     if (isChangeFeedOptions(partitionKeyOrChangeFeedOptions)) {
@@ -171,7 +168,7 @@ export class Items {
    * ```
    */
   public changeFeed(
-    partitionKey: string | number | boolean,
+    partitionKey: PartitionKey,
     changeFeedOptions?: ChangeFeedOptions
   ): ChangeFeedIterator<any>;
   /**
@@ -182,18 +179,18 @@ export class Items {
    * Create a `ChangeFeedIterator` to iterate over pages of changes
    */
   public changeFeed<T>(
-    partitionKey: string | number | boolean,
+    partitionKey: PartitionKey,
     changeFeedOptions?: ChangeFeedOptions
   ): ChangeFeedIterator<T>;
   /**
    * Create a `ChangeFeedIterator` to iterate over pages of changes
    */
   public changeFeed<T>(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>;
   public changeFeed<T>(
-    partitionKeyOrChangeFeedOptions?: string | number | boolean | ChangeFeedOptions,
+    partitionKeyOrChangeFeedOptions?: PartitionKey | ChangeFeedOptions,
     changeFeedOptions?: ChangeFeedOptions
   ): ChangeFeedIterator<T> {
-    let partitionKey: string | number | boolean;
+    let partitionKey: PartitionKey;
     if (!changeFeedOptions && isChangeFeedOptions(partitionKeyOrChangeFeedOptions)) {
       partitionKey = undefined;
       changeFeedOptions = partitionKeyOrChangeFeedOptions;

sdk/cosmosdb/cosmos/src/documents/PartitionKey.ts

@@ -3,6 +3,12 @@
 
 import { NonePartitionKeyLiteral, NullPartitionKeyLiteral } from "./PartitionKeyInternal";
 
+/**
+ * PartitionKey of a container.
+ * @remarks
+ * - PartitionKeyDefinition is no longer part of PartitionKey. So please use PartitionKeyDefinition
+ * type directly where appropriate.
+ */
 export type PartitionKey = PrimitivePartitionKeyValue | PrimitivePartitionKeyValue[];
 
 /**

sdk/cosmosdb/cosmos/src/index.ts

@@ -48,7 +48,12 @@ export {
   IndexKind,
   Location,
   PartitionKey,
+  PrimitivePartitionKeyValue,
+  NullPartitionKeyType,
+  NonePartitionKeyType,
+  PartitionKeyKind,
   PartitionKeyDefinition,
+  PartitionKeyDefinitionVersion,
   PermissionMode,
   TriggerOperation,
   TriggerType,

sdk/cosmosdb/cosmos/src/utils/typeChecks.ts

@@ -1,6 +1,14 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
+import {
+  NonePartitionKeyLiteral,
+  NonePartitionKeyType,
+  NullPartitionKeyLiteral,
+  NullPartitionKeyType,
+  PrimitivePartitionKeyValue,
+} from "../documents";
+
 /**
  * A type which could be any type but undefined
  */
@@ -19,3 +27,39 @@ export function assertNotUndefined<T>(value: T, msg?: string): NonUndefinable<T>
   }
   throw new Error(msg || "Unexpected 'undefined' value encountered");
 }
+
+/**
+ * Check for value being PrimitivePartitionKeyValue.
+ * @internal
+ */
+export function isPrimitivePartitionKeyValue(value: unknown): value is PrimitivePartitionKeyValue {
+  return (
+    isWellDefinedPartitionKeyValue(value) ||
+    isNonePartitionKeyValue(value) ||
+    isNullPartitionKeyValue(value)
+  );
+}
+
+/**
+ * Check for value being string, number or boolean.
+ * @internal
+ */
+export function isWellDefinedPartitionKeyValue(value: unknown): value is string | number | boolean {
+  return typeof value === "string" || typeof value === "boolean" || typeof value === "number";
+}
+
+/**
+ * Check for value being NonePartitionKeyType.
+ * @internal
+ */
+export function isNonePartitionKeyValue(value: unknown): value is NonePartitionKeyType {
+  return value !== undefined && JSON.stringify(value) === JSON.stringify(NonePartitionKeyLiteral);
+}
+
+/**
+ * Check for value being NullPartitionKeyType.
+ * @internal
+ */
+export function isNullPartitionKeyValue(value: unknown): value is NullPartitionKeyType {
+  return value === NullPartitionKeyLiteral;
+}