rads-db 3.0.0 → 3.0.2

package/dist/index.d.ts

@@ -139,6 +139,8 @@ interface UiDecoratorArgs<T = any> {
     iconField?: keyof T;
     /** Search operator that's used in simple search by name. Defaults to 'istartsWith' */
     searchOperator?: 'startsWith' | 'istartsWith' | 'contains' | 'icontains';
+    /** Defines section name in rads-ui where this entity will be grouped under */
+    group?: string;
 }
 interface EntityDecoratorArgs {
     driver?: string;

package/drivers/azureCosmos.cjs

@@ -12,7 +12,17 @@ const databaseClientCache = {};
 const containerClientCache = {};
 const simpleSubclauseRegex = /^[a-z0-9_@]+.[a-z0-9_@]+ = [a-z0-9_@.]+$/i;
 var _default = options => (schema, entity) => {
-  const client = getCosmosContainerClient(options);
+  const normalizedOptions = {
+    databaseName: "main",
+    containerName: "main",
+    createDatabaseIfNotExists: false,
+    options: {},
+    ...options
+  };
+  const client = getCosmosContainerClient(normalizedOptions);
+  if (options.createDatabaseIfNotExists) {
+    createDatabaseIfNotExists(normalizedOptions, client.database.client);
+  }
   async function getItemByIds(ids, ctx) {
     const {
       query,
@@ -442,11 +452,6 @@ function getCosmosQueryWhereInner(ctx, parameters, whereArgs) {
   return fn(ctx, parameters, whereArgs);
 }
 function getCosmosContainerClient(options) {
-  options = {
-    databaseName: "main",
-    containerName: "main",
-    ...options
-  };
   const {
     databaseName,
     containerName,
@@ -459,11 +464,6 @@ function getCosmosContainerClient(options) {
   return containerClientCache[key];
 }
 function getCosmosDatabaseClient(options) {
-  options = {
-    databaseName: "main",
-    containerName: "main",
-    ...options
-  };
   const {
     databaseName,
     endpoint
@@ -475,11 +475,6 @@ function getCosmosDatabaseClient(options) {
   return databaseClientCache[key];
 }
 function getCosmosAccountClient(options) {
-  options = {
-    databaseName: "main",
-    containerName: "main",
-    ...options
-  };
   const {
     endpoint,
     accountKey
@@ -500,4 +495,17 @@ function getWhereNameOperatorPair(whereKey) {
     return ["_type", operator];
   }
   return whereKey.split("_");
+}
+async function createDatabaseIfNotExists(options, client) {
+  try {
+    await client.databases.createIfNotExists({
+      id: options.databaseName
+    });
+    await client.database(options.databaseName).containers.create({
+      id: options.containerName,
+      partitionKey: "/_partition"
+    });
+  } catch (e) {
+    console.error("Error initializing CosmosDb: ", e);
+  }
 }

package/drivers/azureCosmos.d.ts

@@ -1,9 +1,15 @@
 import type { CosmosClientOptions } from '@azure/cosmos';
 interface AzureCosmosDriverOptions {
+    /** HTTPS endpoint of your cosmosdb instance. For example, https://mydb.documents.azure.com:443/ */
     endpoint: string;
-    accountKey?: string;
+    /** Account key for your cosmosdb instance. Available in Azure Portal => CosmosDB => Keys => Primary Key */
+    accountKey: string;
+    /** Defaults to "main" */
     databaseName?: string;
+    /** Defaults to "main" */
     containerName?: string;
+    /** Creates database and/or container if they don't exist */
+    createDatabaseIfNotExists?: boolean;
     options?: Omit<CosmosClientOptions, 'key' | 'endpoint'>;
 }
 declare const _default: (options: AzureCosmosDriverOptions) => (schema: Schema, entity: string) => MinimalDriver;

package/drivers/azureCosmos.mjs

@@ -5,7 +5,17 @@ const databaseClientCache = {};
 const containerClientCache = {};
 const simpleSubclauseRegex = /^[a-z0-9_@]+.[a-z0-9_@]+ = [a-z0-9_@.]+$/i;
 export default (options) => (schema, entity) => {
-  const client = getCosmosContainerClient(options);
+  const normalizedOptions = {
+    databaseName: "main",
+    containerName: "main",
+    createDatabaseIfNotExists: false,
+    options: {},
+    ...options
+  };
+  const client = getCosmosContainerClient(normalizedOptions);
+  if (options.createDatabaseIfNotExists) {
+    createDatabaseIfNotExists(normalizedOptions, client.database.client);
+  }
   async function getItemByIds(ids, ctx) {
     const { query, parameters } = getCosmosQuery(schema, entity, { where: { id_in: ids } });
     const response = client.items.query({
@@ -279,7 +289,6 @@ function getCosmosQueryWhereInner(ctx, parameters, whereArgs) {
   return fn(ctx, parameters, whereArgs);
 }
 function getCosmosContainerClient(options) {
-  options = { databaseName: "main", containerName: "main", ...options };
   const { databaseName, containerName, endpoint } = options;
   const key = `${endpoint}|${databaseName}|${containerName}`;
   if (!containerClientCache[key]) {
@@ -288,7 +297,6 @@ function getCosmosContainerClient(options) {
   return containerClientCache[key];
 }
 function getCosmosDatabaseClient(options) {
-  options = { databaseName: "main", containerName: "main", ...options };
   const { databaseName, endpoint } = options;
   const key = `${endpoint}|${databaseName}`;
   if (!databaseClientCache[key]) {
@@ -297,7 +305,6 @@ function getCosmosDatabaseClient(options) {
   return databaseClientCache[key];
 }
 function getCosmosAccountClient(options) {
-  options = { databaseName: "main", containerName: "main", ...options };
   const { endpoint, accountKey } = options;
   const key = endpoint;
   if (!cosmosClientCache[key]) {
@@ -312,3 +319,11 @@ function getWhereNameOperatorPair(whereKey) {
   }
   return whereKey.split("_");
 }
+async function createDatabaseIfNotExists(options, client) {
+  try {
+    await client.databases.createIfNotExists({ id: options.databaseName });
+    await client.database(options.databaseName).containers.create({ id: options.containerName, partitionKey: "/_partition" });
+  } catch (e) {
+    console.error("Error initializing CosmosDb: ", e);
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rads-db",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "files": [
     "dist",
     "drivers",