@gradientedge/cdk-utils-azure 2.33.0 → 2.35.0

package/dist/src/services/application-insights/renderer.d.ts

@@ -1,7 +1,28 @@
 import { WorkbookRenderer } from './types.js';
+/**
+ * Renders Azure Application Insights workbook templates from YAML to JSON
+ * - Reads YAML templates from a configurable template directory
+ * - Compiles templates using Lodash template interpolation
+ * - Writes rendered JSON output to an artifacts directory
+ * @category Service
+ */
 export declare class AzureWorkbookRenderer implements WorkbookRenderer {
+    /** Absolute path to the directory containing workbook YAML templates */
     readonly templatePath: string;
+    /** Absolute path to the directory where rendered output files are written */
     readonly outputDir: string;
+    /**
+     * @summary Create a new AzureWorkbookRenderer
+     * @param basePath optional base path for workbook templates; defaults to '<appRoot>/template/workbook'
+     * @param outputDir optional output directory for rendered files; defaults to '<appRoot>/.artifacts'
+     */
     constructor(basePath?: string, outputDir?: string);
+    /**
+     * @summary Render a workbook template to a JSON file
+     * @param filename the output filename slug (used as '<filename>-workbook.json')
+     * @param templateId the template identifier to locate in the template directory
+     * @param variables the variables to substitute into the template using Lodash interpolation
+     * @returns the absolute path to the rendered output file
+     */
     renderToFile(filename: string, templateId: string, variables: Record<string, string>): string;
 }

package/dist/src/services/application-insights/renderer.js

@@ -3,13 +3,34 @@ import path from 'node:path';
 import appRoot from 'app-root-path';
 import { parse } from 'yaml';
 import _ from 'lodash';
+/**
+ * Renders Azure Application Insights workbook templates from YAML to JSON
+ * - Reads YAML templates from a configurable template directory
+ * - Compiles templates using Lodash template interpolation
+ * - Writes rendered JSON output to an artifacts directory
+ * @category Service
+ */
 export class AzureWorkbookRenderer {
+    /** Absolute path to the directory containing workbook YAML templates */
     templatePath;
+    /** Absolute path to the directory where rendered output files are written */
     outputDir;
+    /**
+     * @summary Create a new AzureWorkbookRenderer
+     * @param basePath optional base path for workbook templates; defaults to '<appRoot>/template/workbook'
+     * @param outputDir optional output directory for rendered files; defaults to '<appRoot>/.artifacts'
+     */
     constructor(basePath, outputDir) {
         this.templatePath = basePath ?? path.join(appRoot.path, 'template', 'workbook');
         this.outputDir = outputDir ?? path.join(appRoot.path, '.artifacts');
     }
+    /**
+     * @summary Render a workbook template to a JSON file
+     * @param filename the output filename slug (used as '<filename>-workbook.json')
+     * @param templateId the template identifier to locate in the template directory
+     * @param variables the variables to substitute into the template using Lodash interpolation
+     * @returns the absolute path to the rendered output file
+     */
     renderToFile(filename, templateId, variables) {
         const templateFilePath = `${this.templatePath}/${templateId}.yaml`;
         const templateContent = fs.readFileSync(templateFilePath, 'utf-8');

package/dist/src/services/application-insights/types.d.ts

@@ -1,18 +1,44 @@
 import { ComponentArgs, ComponentCurrentBillingFeatureArgs, WorkbookArgs } from '@pulumi/azure-native/applicationinsights/index.js';
-/** @category Interface */
+/**
+ * Properties for configuring Application Insights billing features
+ * @see [Pulumi Azure Native Application Insights Billing Feature]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/insights/componentcurrentbillingfeature/}
+ * @category Interface
+ */
 export interface ComponentCurrentBillingFeatureProps extends ComponentCurrentBillingFeatureArgs {
 }
-/** @category Interface */
+/**
+ * Properties for creating an Application Insights workbook
+ * @see [Pulumi Azure Native Application Insights Workbook]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/applicationinsights/workbook/}
+ * @category Interface
+ */
 export interface WorkbookProps extends WorkbookArgs {
+    /** Short slug identifier used as the workbook output filename */
     slug: string;
+    /** Template identifier used to locate the YAML workbook template */
     templateId: string;
+    /** Variables to substitute into the workbook template */
     variables: Record<string, any>;
 }
-/** @category Interface */
+/**
+ * Properties for creating an Application Insights component
+ * @see [Pulumi Azure Native Application Insights Component]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/insights/component/}
+ * @category Interface
+ */
 export interface ApplicationInsightsProps extends ComponentArgs {
+    /** Optional billing feature configuration for the component */
     billingFeatures?: ComponentCurrentBillingFeatureProps;
 }
-/** @category Interface */
+/**
+ * Interface for rendering workbook templates to files
+ * @category Interface
+ */
 export interface WorkbookRenderer {
+    /**
+     * Render a workbook template to a file
+     * @param filename the output filename slug
+     * @param templateId the template identifier to locate
+     * @param variables the variables to substitute into the template
+     * @returns the absolute path to the rendered output file
+     */
     renderToFile(filename: string, templateId: string, variables: Record<string, any>): string;
 }

package/dist/src/services/authorisation/constants.d.ts

@@ -4,11 +4,18 @@
  */
 /** @category Enum */
 export declare enum RoleDefinitionId {
+    /** Read-only access to Azure App Configuration key-values */
     APP_CONFIGURATION_DATA_READER = "/providers/Microsoft.Authorization/roleDefinitions/516239f1-63e1-4d78-a4de-a74fb236a071",
+    /** Full access to Azure App Configuration key-values */
     APP_CONFIGURATION_DATA_OWNER = "/providers/Microsoft.Authorization/roleDefinitions/5ae67dd6-50cb-40e7-96ff-dc2bfa4b606b",
+    /** Allows sending events to Event Grid topics */
     EVENTGRID_DATA_SENDER = "/providers/Microsoft.Authorization/roleDefinitions/d5a91429-5739-47e2-a06b-3470a27159e7",
+    /** Read certificates from Azure Key Vault */
     KEY_VAULT_CERTIFICATE_USER = "/providers/Microsoft.Authorization/roleDefinitions/db79e9a7-68ee-4b58-9aeb-b90e7c24fcba",
+    /** Read secrets from Azure Key Vault */
     KEY_VAULT_SECRETS_USER = "/providers/Microsoft.Authorization/roleDefinitions/4633458b-17de-408a-b874-0445c86b69e6",
+    /** Read, write, and delete Azure Storage blob data */
     STORAGE_BLOB_DATA_CONTRIBUTOR = "/providers/Microsoft.Authorization/roleDefinitions/ba92f5b4-2d11-453d-a403-e96b0029c9fe",
+    /** Read, write, and delete Azure Storage table data */
     STORAGE_TABLE_DATA_CONTRIBUTOR = "/providers/Microsoft.Authorization/roleDefinitions/0a9a7e1f-b9d0-4cc4-a60d-0319b160aaa3"
 }

package/dist/src/services/authorisation/constants.js

@@ -5,11 +5,18 @@
 /** @category Enum */
 export var RoleDefinitionId;
 (function (RoleDefinitionId) {
+    /** Read-only access to Azure App Configuration key-values */
     RoleDefinitionId["APP_CONFIGURATION_DATA_READER"] = "/providers/Microsoft.Authorization/roleDefinitions/516239f1-63e1-4d78-a4de-a74fb236a071";
+    /** Full access to Azure App Configuration key-values */
     RoleDefinitionId["APP_CONFIGURATION_DATA_OWNER"] = "/providers/Microsoft.Authorization/roleDefinitions/5ae67dd6-50cb-40e7-96ff-dc2bfa4b606b";
+    /** Allows sending events to Event Grid topics */
     RoleDefinitionId["EVENTGRID_DATA_SENDER"] = "/providers/Microsoft.Authorization/roleDefinitions/d5a91429-5739-47e2-a06b-3470a27159e7";
+    /** Read certificates from Azure Key Vault */
     RoleDefinitionId["KEY_VAULT_CERTIFICATE_USER"] = "/providers/Microsoft.Authorization/roleDefinitions/db79e9a7-68ee-4b58-9aeb-b90e7c24fcba";
+    /** Read secrets from Azure Key Vault */
     RoleDefinitionId["KEY_VAULT_SECRETS_USER"] = "/providers/Microsoft.Authorization/roleDefinitions/4633458b-17de-408a-b874-0445c86b69e6";
+    /** Read, write, and delete Azure Storage blob data */
     RoleDefinitionId["STORAGE_BLOB_DATA_CONTRIBUTOR"] = "/providers/Microsoft.Authorization/roleDefinitions/ba92f5b4-2d11-453d-a403-e96b0029c9fe";
+    /** Read, write, and delete Azure Storage table data */
     RoleDefinitionId["STORAGE_TABLE_DATA_CONTRIBUTOR"] = "/providers/Microsoft.Authorization/roleDefinitions/0a9a7e1f-b9d0-4cc4-a60d-0319b160aaa3";
 })(RoleDefinitionId || (RoleDefinitionId = {}));

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

@@ -1,4 +1,8 @@
 import { RoleAssignmentArgs } from '@pulumi/azure-native/authorization/index.js';
-/** @category Interface */
+/**
+ * Properties for creating an Azure role assignment
+ * @see [Pulumi Azure Native Role Assignment]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/authorization/roleassignment/}
+ * @category Interface
+ */
 export interface RoleAssignmentProps extends RoleAssignmentArgs {
 }

package/dist/src/services/cosmosdb/constants.d.ts

@@ -1,10 +1,22 @@
-/** @category Enum */
+/**
+ * CosmosDB SQL role definition types
+ * @see https://learn.microsoft.com/en-us/azure/cosmos-db/how-to-setup-rbac
+ * @category Enum
+ */
 export declare enum CosmosRoleDefinition {
+    /** Full read-write access to CosmosDB SQL data */
     CONTRIBUTOR = "CONTRIBUTOR",
+    /** Read-only access to CosmosDB SQL data */
     READER = "READER"
 }
-/** @category Enum */
+/**
+ * Built-in CosmosDB SQL role definition GUIDs
+ * @see https://learn.microsoft.com/en-us/azure/cosmos-db/how-to-setup-rbac#built-in-role-definitions
+ * @category Enum
+ */
 export declare enum CosmosRoleDefinitionId {
+    /** Built-in Cosmos DB Data Contributor role GUID */
     CONTRIBUTOR = "00000000-0000-0000-0000-000000000001",
+    /** Built-in Cosmos DB Data Reader role GUID */
     READER = "00000000-0000-0000-0000-000000000002"
 }

package/dist/src/services/cosmosdb/constants.js

@@ -1,12 +1,24 @@
-/** @category Enum */
+/**
+ * CosmosDB SQL role definition types
+ * @see https://learn.microsoft.com/en-us/azure/cosmos-db/how-to-setup-rbac
+ * @category Enum
+ */
 export var CosmosRoleDefinition;
 (function (CosmosRoleDefinition) {
+    /** Full read-write access to CosmosDB SQL data */
     CosmosRoleDefinition["CONTRIBUTOR"] = "CONTRIBUTOR";
+    /** Read-only access to CosmosDB SQL data */
     CosmosRoleDefinition["READER"] = "READER";
 })(CosmosRoleDefinition || (CosmosRoleDefinition = {}));
-/** @category Enum */
+/**
+ * Built-in CosmosDB SQL role definition GUIDs
+ * @see https://learn.microsoft.com/en-us/azure/cosmos-db/how-to-setup-rbac#built-in-role-definitions
+ * @category Enum
+ */
 export var CosmosRoleDefinitionId;
 (function (CosmosRoleDefinitionId) {
+    /** Built-in Cosmos DB Data Contributor role GUID */
     CosmosRoleDefinitionId["CONTRIBUTOR"] = "00000000-0000-0000-0000-000000000001";
+    /** Built-in Cosmos DB Data Reader role GUID */
     CosmosRoleDefinitionId["READER"] = "00000000-0000-0000-0000-000000000002";
 })(CosmosRoleDefinitionId || (CosmosRoleDefinitionId = {}));

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

@@ -1,13 +1,29 @@
 import { DatabaseAccountArgs, SqlResourceSqlContainerArgs, SqlResourceSqlDatabaseArgs, SqlResourceSqlRoleAssignmentArgs } from '@pulumi/azure-native/cosmosdb/index.js';
-/** @category Interface */
+/**
+ * Properties for creating a CosmosDB database account
+ * @see [Pulumi Azure Native CosmosDB Database Account]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/documentdb/databaseaccount/}
+ * @category Interface
+ */
 export interface CosmosdbAccountProps extends DatabaseAccountArgs {
 }
-/** @category Interface */
+/**
+ * Properties for creating a CosmosDB SQL database
+ * @see [Pulumi Azure Native CosmosDB SQL Database]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/documentdb/sqlresourcesqldatabase/}
+ * @category Interface
+ */
 export interface CosmosdbSqlDatabaseProps extends SqlResourceSqlDatabaseArgs {
 }
-/** @category Interface */
+/**
+ * Properties for creating a CosmosDB SQL container
+ * @see [Pulumi Azure Native CosmosDB SQL Container]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/documentdb/sqlresourcesqlcontainer/}
+ * @category Interface
+ */
 export interface CosmosdbSqlContainerProps extends SqlResourceSqlContainerArgs {
 }
-/** @category Interface */
+/**
+ * Properties for creating a CosmosDB SQL role assignment
+ * @see [Pulumi Azure Native CosmosDB SQL Role Assignment]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/documentdb/sqlresourcesqlroleassignment/}
+ * @category Interface
+ */
 export interface SqlResourceSqlRoleAssignmentProps extends SqlResourceSqlRoleAssignmentArgs {
 }

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

@@ -1,13 +1,29 @@
 import { RecordSetArgs, ZoneArgs } from '@pulumi/azure-native/dns/index.js';
-/** @category Interface */
+/**
+ * Properties for creating a DNS zone
+ * @see [Pulumi Azure Native DNS Zone]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/network/zone/}
+ * @category Interface
+ */
 export interface DnsZoneProps extends ZoneArgs {
 }
-/** @category Interface */
+/**
+ * Properties for creating a DNS A record
+ * @see [Pulumi Azure Native DNS Record Set]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/network/recordset/}
+ * @category Interface
+ */
 export interface DnsARecordProps extends RecordSetArgs {
 }
-/** @category Interface */
+/**
+ * Properties for creating a DNS CNAME record
+ * @see [Pulumi Azure Native DNS Record Set]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/network/recordset/}
+ * @category Interface
+ */
 export interface DnsCnameRecordProps extends RecordSetArgs {
 }
-/** @category Interface */
+/**
+ * Properties for creating a DNS TXT record
+ * @see [Pulumi Azure Native DNS Record Set]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/network/recordset/}
+ * @category Interface
+ */
 export interface DnsTxtRecordProps extends RecordSetArgs {
 }

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

@@ -1,16 +1,36 @@
 import { EventSubscriptionArgs, GetTopicOutputArgs, SystemTopicArgs, SystemTopicEventSubscriptionArgs, TopicArgs } from '@pulumi/azure-native/eventgrid/index.js';
-/** @category Interface */
+/**
+ * Properties for creating an EventGrid topic
+ * @see [Pulumi Azure Native Event Grid Topic]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/eventgrid/topic/}
+ * @category Interface
+ */
 export interface EventgridTopicProps extends TopicArgs {
 }
-/** @category Interface */
+/**
+ * Properties for creating an EventGrid event subscription
+ * @see [Pulumi Azure Native Event Grid Event Subscription]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/eventgrid/eventsubscription/}
+ * @category Interface
+ */
 export interface EventgridEventSubscriptionProps extends EventSubscriptionArgs {
 }
-/** @category Interface */
+/**
+ * Properties for creating an EventGrid system topic
+ * @see [Pulumi Azure Native Event Grid System Topic]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/eventgrid/systemtopic/}
+ * @category Interface
+ */
 export interface EventgridSystemTopicProps extends SystemTopicArgs {
 }
-/** @category Interface */
+/**
+ * Properties for creating an EventGrid system topic event subscription
+ * @see [Pulumi Azure Native Event Grid System Topic Event Subscription]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/eventgrid/systemtopiceventsubscription/}
+ * @category Interface
+ */
 export interface EventgridSystemTopicEventSubscriptionProps extends SystemTopicEventSubscriptionArgs {
 }
-/** @category Interface */
+/**
+ * Properties for resolving an existing EventGrid topic
+ * @see [Pulumi Azure Native Event Grid Topic]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/eventgrid/topic/}
+ * @category Interface
+ */
 export interface ResolveEventgridTopicProps extends GetTopicOutputArgs {
 }

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

@@ -1,23 +1,47 @@
 import { input } from '@pulumi/azure-native/types/index.js';
 import { WebAppArgs, WebAppFunctionArgs } from '@pulumi/azure-native/web/index.js';
-/** @category Interface */
+/**
+ * Properties for creating an Azure Function App
+ * @see [Pulumi Azure Native Function App]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/web/webapp/}
+ * @category Interface
+ */
 export interface FunctionAppProps extends WebAppArgs {
+    /** Optional display name for the function app */
     name?: string;
 }
-/** @category Interface */
+/**
+ * Properties for creating an individual function within a Function App
+ * @see [Pulumi Azure Native Function Envelope]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/web/webappfunction/}
+ * @category Interface
+ */
 export interface FunctionProps extends WebAppFunctionArgs {
+    /** Function name */
     name: string;
+    /** The resource ID of the parent function app */
     functionAppId: string;
+    /** Programming language of the function */
     language?: string;
+    /** Function configuration JSON (bindings, etc.) */
     configJson?: any;
+    /** Test data for the function */
     testData?: string;
+    /** Whether the function is enabled */
     enabled?: boolean;
 }
-/** @category Interface */
+/**
+ * Properties for creating an Azure Function App with Flex Consumption hosting
+ * @see [Pulumi Azure Native Function App (Flex Consumption)]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/web/webapp/}
+ * @category Interface
+ */
 export interface FunctionAppFlexConsumptionProps extends WebAppArgs {
+    /** Optional display name for the function app */
     name?: string;
+    /** Runtime configuration (language and version) */
     runtime?: input.web.FunctionsRuntimeArgs;
+    /** Scale and concurrency configuration (instance memory, max instances) */
     scaleAndConcurrency?: input.web.FunctionsScaleAndConcurrencyArgs;
+    /** Storage authentication type for deployment storage */
     storageAuthenticationType?: string;
+    /** Storage container type for deployment storage */
     storageContainerType?: string;
 }

package/dist/src/services/key-vault/types.d.ts

@@ -1,7 +1,15 @@
 import { SecretArgs, VaultArgs } from '@pulumi/azure-native/keyvault/index.js';
-/** @category Interface */
+/**
+ * Properties for creating an Azure Key Vault
+ * @see [Pulumi Azure Native Key Vault]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/keyvault/vault/}
+ * @category Interface
+ */
 export interface KeyVaultProps extends VaultArgs {
 }
-/** @category Interface */
+/**
+ * Properties for creating an Azure Key Vault secret
+ * @see [Pulumi Azure Native Key Vault Secret]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/keyvault/secret/}
+ * @category Interface
+ */
 export interface SecretProps extends SecretArgs {
 }

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

@@ -1,4 +1,8 @@
 import { DiagnosticSettingArgs } from '@pulumi/azure-native/monitor/index.js';
-/** @category Interface */
+/**
+ * Properties for creating an Azure Monitor diagnostic setting
+ * @see [Pulumi Azure Native Monitor Diagnostic Settings]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/insights/diagnosticsetting/}
+ * @category Interface
+ */
 export interface MonitorDiagnosticSettingProps extends DiagnosticSettingArgs {
 }

package/dist/src/services/operational-insights/types.d.ts

@@ -1,7 +1,15 @@
 import { TableArgs, WorkspaceArgs } from '@pulumi/azure-native/operationalinsights/index.js';
-/** @category Interface */
+/**
+ * Properties for creating a Log Analytics workspace
+ * @see [Pulumi Azure Native Operational Insights Workspace]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/operationalinsights/workspace/}
+ * @category Interface
+ */
 export interface WorkspaceProps extends WorkspaceArgs {
 }
-/** @category Interface */
+/**
+ * Properties for creating a Log Analytics workspace table
+ * @see [Pulumi Azure Native Operational Insights Table]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/operationalinsights/table/}
+ * @category Interface
+ */
 export interface WorkspaceTableProps extends TableArgs {
 }

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

@@ -1,6 +1,21 @@
-/** @category Service */
+/**
+ * Custom error class for dashboard template rendering failures
+ * - Thrown when required variables or properties are missing from a template
+ * - Use {@link TemplateError.isInstance} for type-safe error checking
+ * @category Service
+ */
 export declare class TemplateError extends Error {
+    /** Discriminator flag for identifying TemplateError instances */
     readonly isTemplateError = true;
+    /**
+     * @summary Create a new TemplateError
+     * @param message descriptive error message indicating the rendering failure
+     */
     constructor(message: string);
+    /**
+     * @summary Type guard to check if an unknown error is a TemplateError
+     * @param error the error to check
+     * @returns true if the error is a TemplateError instance
+     */
     static isInstance(error: unknown): error is TemplateError;
 }

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

@@ -1,10 +1,25 @@
-/** @category Service */
+/**
+ * Custom error class for dashboard template rendering failures
+ * - Thrown when required variables or properties are missing from a template
+ * - Use {@link TemplateError.isInstance} for type-safe error checking
+ * @category Service
+ */
 export class TemplateError extends Error {
+    /** Discriminator flag for identifying TemplateError instances */
     isTemplateError = true;
+    /**
+     * @summary Create a new TemplateError
+     * @param message descriptive error message indicating the rendering failure
+     */
     constructor(message) {
         super(message);
         this.name = 'TemplateError';
     }
+    /**
+     * @summary Type guard to check if an unknown error is a TemplateError
+     * @param error the error to check
+     * @returns true if the error is a TemplateError instance
+     */
     static isInstance(error) {
         return error instanceof Object && 'isTemplateError' in error && error.isTemplateError === true;
     }

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

@@ -1,12 +1,55 @@
 import { DashboardRenderer, MissingKeys, PaneTemplate, RenderParams } from './types.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 declare class AzureDashboardRenderer implements DashboardRenderer {
+    /** Absolute path to the directory containing pane YAML templates */
     readonly paneTemplatePath: string;
+    /** Absolute path to the directory where rendered dashboard files are written */
     readonly outputDir: string;
+    /**
+     * @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?: string, outputDir?: string);
+    /**
+     * @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
+     */
     protected getPaneId(id: string): 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: PaneTemplate, properties?: RenderParams['properties']): MissingKeys;
+    /**
+     * @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: PaneTemplate, variables: RenderParams['variables']): MissingKeys;
+    /**
+     * @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: RenderParams): string;
+    /**
+     * @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: string, params: RenderParams): string;
 }

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)) {