@cfworker/cosmos 1.12.0 → 1.13.0

package/README.md

@@ -44,10 +44,14 @@ import { CosmosClient } from '@cfworker/cosmos';
 
 // 🚨️ Do not commit your Cosmos DB master key to source control!
 // Use a bundler like Rollup, Parcel, or Webpack to interpolate your master key at build-time.
-const masterKey = '...top secret master key copied from the azure portal...';
+const accountKey = '...top secret master key copied from the azure portal...';
 const endpoint = 'https://xxxxxxxxxxxx.documents.azure.com';
 
-const client = new CosmosClient({ endpoint, masterKey });
+const client = new CosmosClient({ endpoint, accountKey });
+
+// or
+
+const client = new CosmosClient({ connectionString });
 ```
 
 ### Specify consistency level
@@ -58,7 +62,7 @@ You may override the default value when constructing the CosmosClient.
 ```ts
 const consistencyLevel = 'Eventual';
 
-const client = new CosmosClient({ endpoint, masterKey, consistencyLevel });
+const client = new CosmosClient({ endpoint, accountKey, consistencyLevel });
 ```
 
 Most methods on CosmosClient accept a `consistencyLevel` argument to enable overriding the client's consistency level on a case-by-case basis.
@@ -76,7 +80,7 @@ You may specify default values for these arguments when constructing the CosmosC
 const dbId = 'my-db';
 const collId = 'my-coll';
 
-const client = new CosmosClient({ endpoint, masterKey, dbId, collId });
+const client = new CosmosClient({ endpoint, accountKey, dbId, collId });
 ```
 
 ### Authenticating with resource tokens

package/dist/client.d.ts

@@ -1,15 +1,17 @@
 import { FeedResponse, ItemResponse } from './response.js';
 import { RetryPolicy } from './retry.js';
 import { SessionContainer } from './session.js';
-import { Collection, ConsistencyLevel, Database, Document, IndexingDirective, IndexingPolicy, OfferType, PartitionKeyDefinition, Resource } from './types.js';
-export interface CosmosClientConfig {
-    endpoint: string;
-    masterKey: string;
+import { Collection, ConnectionInfo, ConsistencyLevel, Database, Document, IndexingDirective, IndexingPolicy, OfferType, PartitionKeyDefinition, Resource } from './types.js';
+export declare type CosmosClientConfig = (ConnectionInfo & CosmosClientConfigBase) | ({
+    connectionString: string;
+} & CosmosClientConfigBase);
+interface CosmosClientConfigBase {
     retryPolicy?: RetryPolicy;
     consistencyLevel?: ConsistencyLevel;
     dbId?: string;
     collId?: string;
     sessions?: SessionContainer;
+    enableCrossPartitionQueries?: boolean;
     fetch?: typeof fetch;
 }
 export declare class CosmosClient {
@@ -19,6 +21,7 @@ export declare class CosmosClient {
     private readonly consistencyLevel;
     private readonly dbId;
     private readonly collId;
+    private readonly enableCrossPartitionQueries;
     private readonly systemFetch;
     readonly sessions: SessionContainer;
     requestCharges: number;

package/dist/client.js

@@ -2,19 +2,27 @@ import { FeedResponse, ItemResponse } from './response.js';
 import { defaultRetryPolicy } from './retry.js';
 import { DefaultSessionContainer } from './session.js';
 import { getSigner } from './signer.js';
-import { assertArg, escapeNonASCII, uri } from './util.js';
+import { assertArg, escapeNonASCII, parseConnectionString, uri } from './util.js';
 export class CosmosClient {
     constructor(config) {
         this.requestCharges = 0;
         this.retries = { count: 0, delayMs: 0 };
-        this.endpoint = config.endpoint;
-        this.signer = getSigner(config.masterKey);
+        let { endpoint, accountKey } = 'connectionString' in config
+            ? parseConnectionString(config.connectionString)
+            : config;
+        if (endpoint.endsWith('/')) {
+            endpoint = endpoint.slice(0, -1);
+        }
+        this.endpoint = endpoint;
+        this.signer = getSigner(accountKey);
         this.retryPolicy = config.retryPolicy ?? defaultRetryPolicy;
         this.consistencyLevel = config.consistencyLevel ?? 'Session';
         this.dbId = config.dbId;
         this.collId = config.collId;
+        this.enableCrossPartitionQueries =
+            config.enableCrossPartitionQueries ?? true;
         this.sessions = config.sessions ?? new DefaultSessionContainer();
-        this.systemFetch = config.fetch ?? fetch.bind(self);
+        this.systemFetch = config.fetch ?? fetch.bind(globalThis);
     }
     async getDatabases(args = {}) {
         const url = this.endpoint + `/dbs`;
@@ -147,7 +155,7 @@ export class CosmosClient {
         assertArg('dbId', dbId);
         assertArg('collId', collId);
         const headers = Object.assign({
-            enableCrossPartition: false,
+            enableCrossPartition: this.enableCrossPartitionQueries,
             enableScan: false,
             maxItems: -1,
             populateMetrics: false,

package/dist/signer.d.ts

@@ -9,4 +9,4 @@ export declare class Signer {
         resourceId: string;
     };
 }
-export declare function getSigner(masterkey: string): Signer;
+export declare function getSigner(accountKey: string): Signer;

package/dist/signer.js

@@ -35,9 +35,9 @@ export class Signer {
     }
 }
 const signers = {};
-export function getSigner(masterkey) {
-    if (!signers[masterkey]) {
-        signers[masterkey] = new Signer(masterkey);
+export function getSigner(accountKey) {
+    if (!signers[accountKey]) {
+        signers[accountKey] = new Signer(accountKey);
     }
-    return signers[masterkey];
+    return signers[accountKey];
 }

package/dist/types.d.ts

@@ -56,3 +56,7 @@ export interface Collection extends PersistedResource {
     _udfs: 'udfs/';
     _conflicts: 'conflicts/';
 }
+export interface ConnectionInfo {
+    endpoint: string;
+    accountKey: string;
+}

package/dist/util.d.ts

@@ -1,3 +1,5 @@
+import { ConnectionInfo } from './types';
 export declare function escapeNonASCII(s: string): string;
 export declare function assertArg(name: string, value: any): asserts value;
 export declare function uri(strings: TemplateStringsArray, ...values: any[]): string;
+export declare function parseConnectionString(connString: string): ConnectionInfo;

package/dist/util.js

@@ -13,3 +13,24 @@ export function uri(strings, ...values) {
     }
     return s;
 }
+export function parseConnectionString(connString) {
+    const props = {};
+    connString.split(';').forEach(kv => {
+        const pos = kv.indexOf('=');
+        if (pos < 1) {
+            return;
+        }
+        const key = kv.slice(0, pos);
+        const val = kv.slice(pos + 1);
+        if (key && val) {
+            props[key] = val;
+        }
+    });
+    if (!props.AccountEndpoint || !props.AccountKey) {
+        throw new Error('Invalid connection string');
+    }
+    return {
+        endpoint: props.AccountEndpoint,
+        accountKey: props.AccountKey
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cfworker/cosmos",
-  "version": "1.12.0",
+  "version": "1.13.0",
   "description": "Azure Cosmos DB client for Cloudflare Workers and service workers",
   "keywords": [
     "azure",
@@ -37,16 +37,16 @@
     "test": "cfworker test test/**/*.spec.ts"
   },
   "dependencies": {
-    "@cfworker/worker-types": "^1.12.0",
+    "@cfworker/worker-types": "^1.12.1",
     "@cloudflare/workers-types": "^2.2.2",
-    "base64-arraybuffer": "^1.0.1"
+    "base64-arraybuffer": "^1.0.2"
   },
   "devDependencies": {
-    "@cfworker/dev": "^1.12.0",
-    "@types/chai": "^4.2.22",
-    "@types/mocha": "^9.0.0",
-    "chai": "^4.3.4",
-    "mocha": "^9.1.3",
-    "typescript": "^4.5.2"
+    "@cfworker/dev": "^1.14.0",
+    "@types/chai": "^4.3.0",
+    "@types/mocha": "^9.1.0",
+    "chai": "^4.3.6",
+    "mocha": "^9.2.1",
+    "typescript": "^4.5.5"
   }
 }

package/src/client.ts

@@ -4,6 +4,7 @@ import { DefaultSessionContainer, SessionContainer } from './session.js';
 import { getSigner, Signer } from './signer.js';
 import {
   Collection,
+  ConnectionInfo,
   ConsistencyLevel,
   Database,
   Document,
@@ -13,21 +14,25 @@ import {
   PartitionKeyDefinition,
   Resource
 } from './types.js';
-import { assertArg, escapeNonASCII, uri } from './util.js';
-
-export interface CosmosClientConfig {
-  /**
-   * Cosmos DB endpoint.
-   * @example
-   * "https://xxxxxxxxxx.documents.azure.com"
-   */
-  endpoint: string;
-
-  /**
-   * Cosmos DB master key.
-   */
-  masterKey: string;
-
+import {
+  assertArg,
+  escapeNonASCII,
+  parseConnectionString,
+  uri
+} from './util.js';
+
+export type CosmosClientConfig =
+  | (ConnectionInfo & CosmosClientConfigBase)
+  | ({
+      /**
+       * Cosmos DB connection string.
+       * @example
+       * "AccountEndpoint=https://xxxxxxxxxx.documents.azure.com:443/;accountKey=xxxxxxxxxx;"
+       */
+      connectionString: string;
+    } & CosmosClientConfigBase);
+
+interface CosmosClientConfigBase {
   /**
    * The retry policy to use when requests are throttled.
    */
@@ -54,6 +59,11 @@ export interface CosmosClientConfig {
    */
   sessions?: SessionContainer;
 
+  /**
+   * Enables cross partition queries. This can be overriden on individual queries. Defaults to true.
+   */
+  enableCrossPartitionQueries?: boolean;
+
   /**
    * System fetch function
    */
@@ -67,20 +77,30 @@ export class CosmosClient {
   private readonly consistencyLevel: ConsistencyLevel;
   private readonly dbId: string | undefined;
   private readonly collId: string | undefined;
+  private readonly enableCrossPartitionQueries: boolean;
   private readonly systemFetch: typeof fetch;
   public readonly sessions: SessionContainer;
   public requestCharges = 0;
   public retries = { count: 0, delayMs: 0 };
 
   constructor(config: CosmosClientConfig) {
-    this.endpoint = config.endpoint;
-    this.signer = getSigner(config.masterKey);
+    let { endpoint, accountKey } =
+      'connectionString' in config
+        ? parseConnectionString(config.connectionString)
+        : config;
+    if (endpoint.endsWith('/')) {
+      endpoint = endpoint.slice(0, -1);
+    }
+    this.endpoint = endpoint;
+    this.signer = getSigner(accountKey);
     this.retryPolicy = config.retryPolicy ?? defaultRetryPolicy;
     this.consistencyLevel = config.consistencyLevel ?? 'Session';
     this.dbId = config.dbId;
     this.collId = config.collId;
+    this.enableCrossPartitionQueries =
+      config.enableCrossPartitionQueries ?? true;
     this.sessions = config.sessions ?? new DefaultSessionContainer();
-    this.systemFetch = config.fetch ?? fetch.bind(self);
+    this.systemFetch = config.fetch ?? fetch.bind(globalThis);
   }
 
   public async getDatabases(
@@ -270,7 +290,7 @@ export class CosmosClient {
 
     const headers = Object.assign(
       {
-        enableCrossPartition: false,
+        enableCrossPartition: this.enableCrossPartitionQueries,
         enableScan: false,
         maxItems: -1,
         populateMetrics: false,

package/src/signer.ts

@@ -55,9 +55,9 @@ export class Signer {
 
 const signers: Record<string, Signer> = {};
 
-export function getSigner(masterkey: string) {
-  if (!signers[masterkey]) {
-    signers[masterkey] = new Signer(masterkey);
+export function getSigner(accountKey: string) {
+  if (!signers[accountKey]) {
+    signers[accountKey] = new Signer(accountKey);
   }
-  return signers[masterkey];
+  return signers[accountKey];
 }

package/src/types.ts

@@ -66,3 +66,17 @@ export interface Collection extends PersistedResource {
   _udfs: 'udfs/';
   _conflicts: 'conflicts/';
 }
+
+export interface ConnectionInfo {
+  /**
+   * Cosmos DB endpoint.
+   * @example
+   * "https://xxxxxxxxxx.documents.azure.com"
+   */
+  endpoint: string;
+
+  /**
+   * Cosmos DB key.
+   */
+  accountKey: string;
+}

package/src/util.ts

@@ -1,3 +1,5 @@
+import { ConnectionInfo } from './types';
+
 /**
  * Escape non-ASCII characters as \uXXXX
  */
@@ -29,3 +31,29 @@ export function uri(strings: TemplateStringsArray, ...values: any[]) {
   }
   return s;
 }
+
+/**
+ * Parses a connection string for Cosmos DB.
+ * @param connString Cosmos DB connection string.
+ */
+export function parseConnectionString(connString: string): ConnectionInfo {
+  const props: Record<string, string> = {};
+  connString.split(';').forEach(kv => {
+    const pos = kv.indexOf('=');
+    if (pos < 1) {
+      return;
+    }
+    const key = kv.slice(0, pos);
+    const val = kv.slice(pos + 1);
+    if (key && val) {
+      props[key] = val;
+    }
+  });
+  if (!props.AccountEndpoint || !props.AccountKey) {
+    throw new Error('Invalid connection string');
+  }
+  return {
+    endpoint: props.AccountEndpoint,
+    accountKey: props.AccountKey
+  };
+}