@gradientedge/cdk-utils-azure 2.32.0 → 2.34.0

package/dist/src/services/portal/renderer.js

@@ -4,20 +4,45 @@ import appRoot from 'app-root-path';
 import _ from 'lodash';
 import { parse } from 'yaml';
 import { TemplateError } from './error.js';
-/** @category Service */
+/**
+ * Renders Azure Portal dashboard templates from YAML pane definitions into JSON
+ * - Reads pane templates from a configurable template directory
+ * - Compiles templates using Lodash template interpolation with `{{}}` delimiters
+ * - Validates required variables and properties before rendering
+ * - Assembles multiple panes into a single dashboard JSON structure
+ * @category Service
+ */
 export class AzureDashboardRenderer {
+    /** Absolute path to the directory containing pane YAML templates */
     paneTemplatePath;
+    /** Absolute path to the directory where rendered dashboard files are written */
     outputDir;
+    /**
+     * @summary Create a new AzureDashboardRenderer
+     * @param basePath optional base path for pane templates; defaults to '<appRoot>/template/dashboard'
+     * @param outputDir optional output directory for rendered files; defaults to '<appRoot>/.artifacts'
+     */
     constructor(basePath, outputDir) {
         this.paneTemplatePath = basePath ?? path.join(appRoot.path, 'template', 'dashboard');
         this.outputDir = outputDir ?? path.join(appRoot.path, '.artifacts');
     }
+    /**
+     * @summary Load and parse a pane template by its identifier
+     * @param id the pane template identifier (corresponds to a YAML filename without extension)
+     * @returns the parsed pane template including dimensions, properties, variables, and template content
+     */
     getPaneId(id) {
         const panePath = `${this.paneTemplatePath}/${id}.yaml`;
         const paneFileContent = fs.readFileSync(panePath, 'utf-8');
         const paneTemplate = parse(paneFileContent);
         return paneTemplate;
     }
+    /**
+     * @summary Check for required properties that are missing from the render parameters
+     * @param template the pane template defining required properties
+     * @param properties the provided properties to check against the template
+     * @returns an object indicating which required property keys are missing
+     */
     getMissingProperties(template, properties = []) {
         const keys = Object.keys(template.properties ?? {}).filter(key => !(key in properties));
         return {
@@ -25,6 +50,12 @@ export class AzureDashboardRenderer {
             hasMissingKeys: keys.length !== 0,
         };
     }
+    /**
+     * @summary Check for required variables that are missing from the render parameters
+     * @param template the pane template defining required variables
+     * @param variables the provided variables to check against the template
+     * @returns an object indicating which required variable keys are missing
+     */
     getMissingVariables(template, variables) {
         const keys = Object.keys(template.variables ?? {}).filter(key => !(key in variables));
         return {
@@ -32,6 +63,12 @@ export class AzureDashboardRenderer {
             hasMissingKeys: keys.length !== 0,
         };
     }
+    /**
+     * @summary Render a complete dashboard from multiple pane templates
+     * @param params render parameters including panes, variables, properties, and optional filter settings
+     * @returns the rendered dashboard JSON string
+     * @throws {@link TemplateError} if required variables or properties are missing
+     */
     render(params) {
         _.templateSettings.interpolate = /{{([\s\S]+?)}}/g;
         // if client is used instead of hosts
@@ -143,6 +180,12 @@ export class AzureDashboardRenderer {
         };
         return JSON.stringify(dashboard, null, 2);
     }
+    /**
+     * @summary Render a dashboard and write the output to a template file
+     * @param filename the output filename (used as '<filename>.tftpl')
+     * @param params render parameters including panes, variables, properties, and optional filter settings
+     * @returns the absolute path to the rendered output file
+     */
     renderToFile(filename, params) {
         const templateOutput = this.render(params);
         if (!fs.existsSync(this.outputDir)) {

package/dist/src/services/portal/types.d.ts

@@ -1,48 +1,92 @@
 import { DashboardArgs } from '@pulumi/azure-native/portal/index.js';
-/** @category Interface */
+/**
+ * Client metadata for dashboard pane rendering
+ * @category Interface
+ */
 export type PaneClient = {
+    /** Client display name */
     name: string;
+    /** Client domain */
     domain: string;
 };
-/** @category Interface */
+/**
+ * Template configuration for rendering client rows in a pane
+ * @category Interface
+ */
 export type PaneClientTemplate = {
+    /** Template string for each row */
     rowTemplate: string;
+    /** Optional prefix before the first row */
     prefix?: string;
+    /** Separator between rows */
     separator?: string;
+    /** Trailing content after the last row */
     trailing?: string;
+    /** Optional suffix after all rows */
     suffix?: string;
 };
-/** @category Interface */
+/**
+ * Structure of a parsed YAML pane template file
+ * @category Interface
+ */
 export type PaneTemplate = {
+    /** Pane dimensions for dashboard layout */
     dimensions: {
         height: number;
     };
+    /** Required properties that must be provided for template substitution */
     properties: Record<string, string>;
+    /** Required variables that must be provided for template substitution */
     variables: Record<string, string>;
+    /** The Lodash-compatible template string */
     template: string;
 };
-/** @category Interface */
+/**
+ * Result of checking for missing required keys in a template
+ * @category Interface
+ */
 export type MissingKeys = {
+    /** List of missing key names */
     keys: Array<string>;
+    /** Whether any required keys are missing */
     hasMissingKeys: boolean;
 };
-/** @category Interface */
+/**
+ * Configuration for a single dashboard pane
+ * @category Interface
+ */
 export type Pane = {
+    /** Pane template identifier (corresponds to a YAML filename) */
     id: string;
+    /** Optional pane-specific properties to pass to the template */
     properties?: Record<string, string | number | Array<string | number>>;
 };
-/** @category Interface */
+/**
+ * Filter configuration for dashboard time range and locale
+ * @category Interface
+ */
 export type Filter = {
+    /** Locale for the dashboard display (e.g. 'en-us') */
     locale?: string;
+    /** Time format for the dashboard (e.g. 'utc') */
     timeFormat?: string;
+    /** Time granularity for the dashboard (e.g. 'auto') */
     timeGranularity?: string;
+    /** Relative time range for the dashboard (e.g. '4h') */
     timeRelative?: string;
 };
-/** @category Interface */
+/**
+ * Parameters for rendering a dashboard from pane templates
+ * @category Interface
+ */
 export type RenderParams = {
+    /** List of panes to render in the dashboard */
     panes: Array<Pane>;
+    /** Variables to substitute into pane templates */
     variables: Record<string, any>;
+    /** Optional properties to pass to pane templates */
     properties?: Record<string, any>;
+    /** Optional filter configuration for the dashboard */
     filter?: Filter;
 };
 /** @category Interface */
@@ -59,11 +103,20 @@ export interface DashboardRenderer {
      */
     renderToFile(filename: string, params: RenderParams): string;
 }
-/** @category Interface */
+/**
+ * Properties for creating an Azure Portal dashboard
+ * @see [Pulumi Azure Native Portal Dashboard]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/portal/dashboard/}
+ * @category Interface
+ */
 export interface PortalDashboardProps extends DashboardArgs {
+    /** Display name shown in the Azure Portal */
     displayName: string;
+    /** List of pane configurations to render in the dashboard */
     panes: Array<Pane>;
+    /** Variables to substitute into pane templates */
     variables: Record<string, string>;
+    /** Optional filter configuration for the dashboard */
     filter?: Filter;
+    /** When false, skips dashboard creation */
     enabled?: boolean;
 }

package/dist/src/services/redis/types.d.ts

@@ -1,12 +1,25 @@
 import { DatabaseArgs, RedisEnterpriseArgs } from '@pulumi/azure-native/redisenterprise/index.js';
-/** @category Interface */
+/**
+ * Properties for creating an Azure Managed Redis (Enterprise) cluster
+ * @see [Pulumi Azure Native Redis Enterprise]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/redisenterprise/redisenterprise/}
+ * @category Interface
+ */
 export interface RedisEnterpriseClusterProps extends RedisEnterpriseArgs {
 }
-/** @category Interface */
+/**
+ * Properties for creating a Redis Enterprise database
+ * @see [Pulumi Azure Native Redis Enterprise Database]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/redisenterprise/database/}
+ * @category Interface
+ */
 export interface RedisDatabaseProps extends DatabaseArgs {
 }
-/** @category Interface */
+/**
+ * Result object containing the provisioned Redis Enterprise cluster and database
+ * @category Interface
+ */
 export interface ManagedRedisResult {
+    /** The provisioned Redis Enterprise cluster */
     cluster: import('@pulumi/azure-native/redisenterprise/index.js').RedisEnterprise;
+    /** The provisioned Redis Enterprise database */
     database: import('@pulumi/azure-native/redisenterprise/index.js').Database;
 }

package/dist/src/services/resource-group/types.d.ts

@@ -1,4 +1,8 @@
 import { ResourceGroupArgs } from '@pulumi/azure-native/resources/index.js';
-/** @category Interface */
+/**
+ * Properties for creating an Azure Resource Group
+ * @see [Pulumi Azure Native Resource Group]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/resources/resourcegroup/}
+ * @category Interface
+ */
 export interface ResourceGroupProps extends ResourceGroupArgs {
 }

package/dist/src/services/security-center/types.d.ts

@@ -1,4 +1,8 @@
 import { DefenderForStorageArgs } from '@pulumi/azure-native/security/index.js';
-/** @category Interface */
+/**
+ * Properties for creating a Microsoft Defender for Storage configuration
+ * @see [Pulumi Azure Native Defender For Storage]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/security/defenderforstorage/}
+ * @category Interface
+ */
 export interface DefenderForStorageProps extends DefenderForStorageArgs {
 }

package/dist/src/services/servicebus/types.d.ts

@@ -1,16 +1,36 @@
 import { GetQueueOutputArgs, NamespaceArgs, QueueArgs, SubscriptionArgs, TopicArgs } from '@pulumi/azure-native/servicebus/index.js';
-/** @category Interface */
+/**
+ * Properties for creating a Service Bus namespace
+ * @see [Pulumi Azure Native Service Bus Namespace]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/servicebus/namespace/}
+ * @category Interface
+ */
 export interface ServiceBusNamespaceProps extends NamespaceArgs {
 }
-/** @category Interface */
+/**
+ * Properties for creating a Service Bus topic
+ * @see [Pulumi Azure Native Service Bus Topic]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/servicebus/topic/}
+ * @category Interface
+ */
 export interface ServiceBusTopicProps extends TopicArgs {
 }
-/** @category Interface */
+/**
+ * Properties for creating a Service Bus queue
+ * @see [Pulumi Azure Native Service Bus Queue]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/servicebus/queue/}
+ * @category Interface
+ */
 export interface ServiceBusQueueProps extends QueueArgs {
 }
-/** @category Interface */
+/**
+ * Properties for creating a Service Bus subscription
+ * @see [Pulumi Azure Native Service Bus Subscription]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/servicebus/subscription/}
+ * @category Interface
+ */
 export interface ServiceBusSubscriptionProps extends SubscriptionArgs {
 }
-/** @category Interface */
+/**
+ * Properties for resolving an existing Service Bus queue
+ * @see [Pulumi Azure Native Service Bus Queue]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/servicebus/queue/}
+ * @category Interface
+ */
 export interface ResolveServicebusQueueProps extends GetQueueOutputArgs {
 }

package/dist/src/services/storage/types.d.ts

@@ -1,28 +1,60 @@
 import { BlobArgs, BlobContainerArgs, BlobServicePropertiesArgs, ListStorageAccountSASArgs, ManagementPolicyArgs, StorageAccountArgs, TableArgs } from '@pulumi/azure-native/storage/index.js';
 import { BaseAzureConfigProps } from '../../types/index.js';
-/** @category Interface */
+/**
+ * Properties for creating an Azure Storage account
+ * @see [Pulumi Azure Native Storage Account]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/storage/storageaccount/}
+ * @category Interface
+ */
 export interface StorageAccountProps extends StorageAccountArgs {
+    /** Blob service properties (e.g. delete retention policy) */
     blobProperties?: BlobServicePropertiesArgs;
+    /** When true, skips creating the default BlobServiceProperties resource */
     skipBlobServiceProperties?: boolean;
 }
-/** @category Interface */
+/**
+ * Properties for creating an Azure Storage blob container
+ * @see [Pulumi Azure Native Blob Container]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/storage/blobcontainer/}
+ * @category Interface
+ */
 export interface StorageContainerProps extends BlobContainerArgs, BaseAzureConfigProps {
 }
-/** @category Interface */
+/**
+ * Properties for creating an Azure Storage blob
+ * @see [Pulumi Azure Native Blob]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/storage/blob/}
+ * @category Interface
+ */
 export interface StorageBlobProps extends BaseAzureConfigProps, BlobArgs {
+    /** When true, skips resource name formatting on the blob name */
     skipBlobNameFormatting?: boolean;
 }
-/** @category Interface */
+/**
+ * Properties for creating an Azure Storage management policy
+ * @see [Pulumi Azure Native Storage Management Policy]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/storage/managementpolicy/}
+ * @category Interface
+ */
 export interface ManagementPolicyProps extends ManagementPolicyArgs {
 }
-/** @category Interface */
+/**
+ * Properties for creating an Azure Storage table
+ * @see [Pulumi Azure Native Storage Table]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/storage/table/}
+ * @category Interface
+ */
 export interface StorageTableProps extends TableArgs {
 }
-/** @category Interface */
+/**
+ * Properties for generating a container-level SAS token
+ * @see [Pulumi Azure Native Storage Account SAS]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/storage/liststorageaccountsas/}
+ * @category Interface
+ */
 export interface ContainerSasTokenProps extends ListStorageAccountSASArgs {
+    /** Resource group containing the storage account */
     resourceGroupName: string;
+    /** Optional container name for scoping the SAS token */
     containerName?: string;
+    /** When false, allows both HTTP and HTTPS protocols; defaults to HTTPS only */
     httpsOnly?: boolean;
+    /** SAS start date in 'YYYY-MM-DD' format; defaults to today */
     start?: string;
+    /** SAS expiry date in 'YYYY-MM-DD' format; defaults to 7 days from now */
     expiry?: string;
 }

package/dist/src/types/index.d.ts

@@ -1,5 +1,9 @@
 import * as pulumi from '@pulumi/pulumi';
-/** @category Interface */
+/**
+ * Base properties shared by Azure configuration interfaces that require a resource group
+ * @category Interface
+ */
 export interface BaseAzureConfigProps {
+    /** The Azure resource group name in which the resource is deployed */
     resourceGroupName: pulumi.Input<string>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/cdk-utils-azure",
-  "version": "2.32.0",
+  "version": "2.34.0",
   "description": "Azure Pulumi utilities for @gradientedge/cdk-utils",
   "type": "module",
   "main": "dist/src/index.js",
@@ -22,8 +22,8 @@
     "app-root-path": "3.1.0",
     "lodash": "4.18.1",
     "uuid": "14.0.0",
-    "yaml": "2.8.4",
-    "@gradientedge/cdk-utils-common": "2.2.1"
+    "yaml": "2.9.0",
+    "@gradientedge/cdk-utils-common": "2.3.0"
   },
   "keywords": [
     "gradientedge",