Add Cosmos DB extension v4 types

And some missing properties for extension v3 types

Author: ejizba

src/app.ts

@@ -3,6 +3,7 @@
 
 import {
     CosmosDBFunctionOptions,
+    CosmosDBTrigger,
     EventGridFunctionOptions,
     EventHubFunctionOptions,
     FunctionOptions,
@@ -18,8 +19,8 @@ import {
 } from '@azure/functions';
 import * as coreTypes from '@azure/functions-core';
 import { CoreInvocationContext, FunctionCallback } from '@azure/functions-core';
-import { returnBindingKey, version } from './constants';
 import { InvocationModel } from './InvocationModel';
+import { returnBindingKey, version } from './constants';
 import * as output from './output';
 import * as trigger from './trigger';
 import { isTrigger } from './utils/isTrigger';
@@ -174,21 +175,58 @@ export function eventGrid(name: string, options: EventGridFunctionOptions): void
 }
 
 export function cosmosDB(name: string, options: CosmosDBFunctionOptions): void {
-    generic(name, {
-        trigger: trigger.cosmosDB({
+    let cosmosTrigger: CosmosDBTrigger;
+    if ('connectionStringSetting' in options) {
+        cosmosTrigger = trigger.cosmosDB({
+            checkpointDocumentCount: options.checkpointDocumentCount,
+            checkpointInterval: options.checkpointInterval,
             collectionName: options.collectionName,
             connectionStringSetting: options.connectionStringSetting,
             createLeaseCollectionIfNotExists: options.createLeaseCollectionIfNotExists,
             databaseName: options.databaseName,
+            feedPollDelay: options.feedPollDelay,
             id: options.id,
+            leaseAcquireInterval: options.leaseAcquireInterval,
             leaseCollectionName: options.leaseCollectionName,
             leaseCollectionPrefix: options.leaseCollectionPrefix,
             leaseCollectionThroughput: options.leaseCollectionThroughput,
             leaseConnectionStringSetting: options.leaseConnectionStringSetting,
             leaseDatabaseName: options.leaseDatabaseName,
+            leaseExpirationInterval: options.leaseExpirationInterval,
+            leaseRenewInterval: options.leaseRenewInterval,
+            maxItemsPerInvocation: options.maxItemsPerInvocation,
             partitionKey: options.partitionKey,
+            preferredLocations: options.preferredLocations,
             sqlQuery: options.sqlQuery,
-        }),
+            startFromBeginning: options.startFromBeginning,
+            useMultipleWriteLocations: options.useMultipleWriteLocations,
+        });
+    } else {
+        cosmosTrigger = trigger.cosmosDB({
+            connection: options.connection,
+            containerName: options.containerName,
+            createLeaseContainerIfNotExists: options.createLeaseContainerIfNotExists,
+            databaseName: options.databaseName,
+            feedPollDelay: options.feedPollDelay,
+            id: options.id,
+            leaseAcquireInterval: options.leaseAcquireInterval,
+            leaseConnection: options.leaseConnection,
+            leaseContainerName: options.leaseContainerName,
+            leaseContainerPrefix: options.leaseContainerPrefix,
+            leaseDatabaseName: options.leaseDatabaseName,
+            leaseExpirationInterval: options.leaseExpirationInterval,
+            leaseRenewInterval: options.leaseRenewInterval,
+            leasesContainerThroughput: options.leasesContainerThroughput,
+            maxItemsPerInvocation: options.maxItemsPerInvocation,
+            partitionKey: options.partitionKey,
+            preferredLocations: options.preferredLocations,
+            sqlQuery: options.sqlQuery,
+            startFromBeginning: options.startFromBeginning,
+            startFromTime: options.startFromTime,
+        });
+    }
+    generic(name, {
+        trigger: cosmosTrigger,
         ...options,
     });
 }

types/cosmosDB.d.ts

@@ -0,0 +1,36 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the MIT License.
+
+import {
+    CosmosDBv3FunctionOptions,
+    CosmosDBv3Handler,
+    CosmosDBv3Input,
+    CosmosDBv3InputOptions,
+    CosmosDBv3Output,
+    CosmosDBv3OutputOptions,
+    CosmosDBv3Trigger,
+    CosmosDBv3TriggerOptions,
+} from './cosmosDB.v3';
+import {
+    CosmosDBv4FunctionOptions,
+    CosmosDBv4Handler,
+    CosmosDBv4Input,
+    CosmosDBv4InputOptions,
+    CosmosDBv4Output,
+    CosmosDBv4OutputOptions,
+    CosmosDBv4Trigger,
+    CosmosDBv4TriggerOptions,
+} from './cosmosDB.v4';
+
+export type CosmosDBHandler = CosmosDBv3Handler | CosmosDBv4Handler;
+
+export type CosmosDBFunctionOptions = CosmosDBv3FunctionOptions | CosmosDBv4FunctionOptions;
+
+export type CosmosDBInputOptions = CosmosDBv3InputOptions | CosmosDBv4InputOptions;
+export type CosmosDBInput = CosmosDBv3Input | CosmosDBv4Input;
+
+export type CosmosDBTriggerOptions = CosmosDBv3TriggerOptions | CosmosDBv4TriggerOptions;
+export type CosmosDBTrigger = CosmosDBv3Trigger | CosmosDBv4Trigger;
+
+export type CosmosDBOutputOptions = CosmosDBv3OutputOptions | CosmosDBv4OutputOptions;
+export type CosmosDBOutput = CosmosDBv3Output | CosmosDBv4Output;

types/cosmosDB.v3.d.ts

@@ -4,15 +4,15 @@
 import { FunctionInput, FunctionOptions, FunctionOutput, FunctionResult, FunctionTrigger } from './index';
 import { InvocationContext } from './InvocationContext';
 
-export type CosmosDBHandler = (documents: unknown[], context: InvocationContext) => FunctionResult;
+export type CosmosDBv3Handler = (documents: unknown[], context: InvocationContext) => FunctionResult;
 
-export interface CosmosDBFunctionOptions extends CosmosDBTriggerOptions, Partial<FunctionOptions> {
-    handler: CosmosDBHandler;
+export interface CosmosDBv3FunctionOptions extends CosmosDBv3TriggerOptions, Partial<FunctionOptions> {
+    handler: CosmosDBv3Handler;
 
-    trigger?: CosmosDBTrigger;
+    trigger?: CosmosDBv3Trigger;
 }
 
-export interface CosmosDBInputOptions {
+export interface CosmosDBv3InputOptions {
     /**
      * An app setting (or environment variable) with the Cosmos DB connection string
      */
@@ -45,10 +45,16 @@ export interface CosmosDBInputOptions {
      * Don't set both the id and sqlQuery properties. If you don't set either one, the entire collection is retrieved.
      */
     sqlQuery?: string;
+
+    /**
+     * Defines preferred locations (regions) for geo-replicated database accounts in the Azure Cosmos DB service.
+     * Values should be comma-separated. For example, East US,South Central US,North Europe
+     */
+    preferredLocations?: string;
 }
-export type CosmosDBInput = FunctionInput & CosmosDBInputOptions;
+export type CosmosDBv3Input = FunctionInput & CosmosDBv3InputOptions;
 
-export interface CosmosDBTriggerOptions extends CosmosDBInputOptions {
+export interface CosmosDBv3TriggerOptions extends CosmosDBv3InputOptions {
     /**
      * The name of an app setting that contains the connection string to the service which holds the lease collection.
      * If not set it will connect to the service defined by `connectionStringSetting`
@@ -80,10 +86,64 @@ export interface CosmosDBTriggerOptions extends CosmosDBInputOptions {
      * Using a prefix allows two separate Azure Functions to share the same Lease collection by using different prefixes.
      */
     leaseCollectionPrefix?: string;
+
+    /**
+     * The time (in milliseconds) for the delay between polling a partition for new changes on the feed, after all current changes are drained.
+     * Default is 5,000 milliseconds, or 5 seconds.
+     */
+    feedPollDelay?: number;
+
+    /**
+     * When set, it defines, in milliseconds, the interval to kick off a task to compute if partitions are distributed evenly among known host instances.
+     * Default is 13000 (13 seconds).
+     */
+    leaseAcquireInterval?: number;
+
+    /**
+     * When set, it defines, in milliseconds, the interval for which the lease is taken on a lease representing a partition.
+     * If the lease is not renewed within this interval, it will cause it to expire and ownership of the partition will move to another instance.
+     * Default is 60000 (60 seconds).
+     */
+    leaseExpirationInterval?: number;
+
+    /**
+     * When set, it defines, in milliseconds, the renew interval for all leases for partitions currently held by an instance.
+     * Default is 17000 (17 seconds).
+     */
+    leaseRenewInterval?: number;
+
+    /**
+     * When set, it defines, in milliseconds, the interval between lease checkpoints. Default is always after each Function call.
+     */
+    checkpointInterval?: number;
+
+    /**
+     * Customizes the amount of documents between lease checkpoints. Default is after every function call.
+     */
+    checkpointDocumentCount?: number;
+
+    /**
+     * When set, this property sets the maximum number of items received per Function call.
+     * If operations in the monitored container are performed through stored procedures, transaction scope is preserved when reading items from the change feed.
+     * As a result, the number of items received could be higher than the specified value so that the items changed by the same transaction are returned as part of one atomic batch.
+     */
+    maxItemsPerInvocation?: number;
+
+    /**
+     * This option tells the Trigger to read changes from the beginning of the container's change history instead of starting at the current time.
+     * Reading from the beginning only works the first time the trigger starts, as in subsequent runs, the checkpoints are already stored.
+     * Setting this option to true when there are leases already created has no effect.
+     */
+    startFromBeginning?: boolean;
+
+    /**
+     * Enables multi-region accounts for writing to the leases collection.
+     */
+    useMultipleWriteLocations?: boolean;
 }
-export type CosmosDBTrigger = FunctionTrigger & CosmosDBTriggerOptions;
+export type CosmosDBv3Trigger = FunctionTrigger & CosmosDBv3TriggerOptions;
 
-export interface CosmosDBOutputOptions {
+export interface CosmosDBv3OutputOptions {
     /**
      * An app setting (or environment variable) with the Cosmos DB connection string
      */
@@ -114,5 +174,16 @@ export interface CosmosDBOutputOptions {
      * When createIfNotExists is true, it defines the [throughput](https://docs.microsoft.com/azure/cosmos-db/set-throughput) of the created collection
      */
     collectionThroughput?: number;
+
+    /**
+     * Defines preferred locations (regions) for geo-replicated database accounts in the Azure Cosmos DB service.
+     * Values should be comma-separated. For example, East US,South Central US,North Europe
+     */
+    preferredLocations?: string;
+
+    /**
+     * When set to true along with preferredLocations, supports multi-region writes in the Azure Cosmos DB service.
+     */
+    useMultipleWriteLocations?: boolean;
 }
-export type CosmosDBOutput = FunctionOutput & CosmosDBOutputOptions;
+export type CosmosDBv3Output = FunctionOutput & CosmosDBv3OutputOptions;