@gradientedge/cdk-utils-azure 2.27.0 → 2.28.0

package/dist/src/construct/event-handler/main.d.ts

@@ -22,6 +22,11 @@ export declare class AzureEventHandler extends AzureFunctionApp {
     eventGridEventSubscription: EventHandlerEventGridSubscription;
     eventGridTopic: Topic | Output<GetTopicResult>;
     serviceBus: EventHandlerServiceBus;
+    /**
+     * @summary Create a new AzureEventHandler
+     * @param id scoped id of the resource
+     * @param props the event handler properties
+     */
     constructor(id: string, props: AzureEventHandlerProps);
     /**
      * @summary Initialise and provision resources
@@ -59,6 +64,12 @@ export declare class AzureEventHandler extends AzureFunctionApp {
      * @summary Method to enable Microsoft Defender malware scanning on the data storage account
      */
     protected enableMalwareScanningOnDataStorageAccount(): void;
+    /**
+     * @summary Override to extend the function app site config with service bus connection strings
+     */
     protected createFunctionAppSiteConfig(): void;
+    /**
+     * @summary Override to extend the dashboard variables with service bus and event grid specifics
+     */
     protected dashboardVariables(): Record<string, any>;
 }

package/dist/src/construct/event-handler/main.js

@@ -22,6 +22,11 @@ export class AzureEventHandler extends AzureFunctionApp {
     eventGridEventSubscription;
     eventGridTopic;
     serviceBus;
+    /**
+     * @summary Create a new AzureEventHandler
+     * @param id scoped id of the resource
+     * @param props the event handler properties
+     */
     constructor(id, props) {
         super(id, props);
         this.props = props;
@@ -209,6 +214,9 @@ export class AzureEventHandler extends AzureFunctionApp {
             },
         });
     }
+    /**
+     * @summary Override to extend the function app site config with service bus connection strings
+     */
     createFunctionAppSiteConfig() {
         super.createFunctionAppSiteConfig();
         this.appEnvironmentVariables = {
@@ -227,6 +235,9 @@ export class AzureEventHandler extends AzureFunctionApp {
             },
         ];
     }
+    /**
+     * @summary Override to extend the dashboard variables with service bus and event grid specifics
+     */
     dashboardVariables() {
         const variables = super.dashboardVariables();
         return {

package/dist/src/construct/function-app/main.d.ts

@@ -42,6 +42,11 @@ export declare class AzureFunctionApp extends CommonAzureConstruct {
     dataStorageContainer: BlobContainer;
     applicationInsights: Output<GetComponentResult>;
     functionDashboard: Dashboard;
+    /**
+     * @summary Create a new AzureFunctionApp
+     * @param id scoped id of the resource
+     * @param props the function app properties
+     */
     constructor(id: string, props: AzureFunctionAppProps);
     /**
      * @summary Initialise and provision resources

package/dist/src/construct/function-app/main.js

@@ -47,6 +47,11 @@ export class AzureFunctionApp extends CommonAzureConstruct {
     dataStorageContainer;
     applicationInsights;
     functionDashboard;
+    /**
+     * @summary Create a new AzureFunctionApp
+     * @param id scoped id of the resource
+     * @param props the function app properties
+     */
     constructor(id, props) {
         super(id, props);
         this.props = props;

package/dist/src/construct/rest-api/main.d.ts

@@ -21,6 +21,11 @@ export declare class AzureRestApi extends CommonAzureConstruct {
     props: AzureRestApiProps;
     api: AzureApi;
     applicationInsights: Output<GetComponentResult>;
+    /**
+     * @summary Create a new AzureRestApi
+     * @param id scoped id of the resource
+     * @param props the REST API properties
+     */
     constructor(id: string, props: AzureRestApiProps);
     /**
      * @summary Initialise and provision resources

package/dist/src/construct/rest-api/main.js

@@ -24,6 +24,11 @@ export class AzureRestApi extends CommonAzureConstruct {
     props;
     api = {};
     applicationInsights;
+    /**
+     * @summary Create a new AzureRestApi
+     * @param id scoped id of the resource
+     * @param props the REST API properties
+     */
     constructor(id, props) {
         super(id, props);
         this.props = props;
@@ -70,6 +75,9 @@ export class AzureRestApi extends CommonAzureConstruct {
      */
     createApiManagement() {
         if (this.props.apiManagement.useExistingApiManagement) {
+            /* Import existing APIM service outputs from another Pulumi stack.
+               The output keys (apiId, apiName, apiResourceGroupName) must match
+               the registerOutputs call at the bottom of this method. */
             if (this.props.apiManagement.apiStackName) {
                 const apiStack = new pulumi.StackReference(this.props.apiManagement.apiStackName);
                 this.api.id = apiStack.getOutput('apiId');
@@ -98,6 +106,9 @@ export class AzureRestApi extends CommonAzureConstruct {
             this.api.id = this.api.apim.id;
             this.api.name = this.api.apim.name;
             this.api.resourceGroupName = this.resourceGroup.name;
+            /* Retrieve the APIM managed identity to grant Key Vault certificate access.
+               The identity must be resolved separately as it's not available until
+               the APIM service is created. */
             const apimIdentity = getApiManagementServiceOutput({
                 serviceName: this.api.apim.name,
                 resourceGroupName: this.resourceGroup.name,
@@ -111,6 +122,8 @@ export class AzureRestApi extends CommonAzureConstruct {
                 });
             }
         }
+        /* Register outputs for cross-stack consumption via StackReference.
+           These keys must match what consuming stacks expect in getOutput() calls. */
         this.registerOutputs({
             apiId: this.api.id,
             apiName: this.api.name,
@@ -165,6 +178,9 @@ export class AzureRestApi extends CommonAzureConstruct {
             allowTracing: false,
             scope: '/apis',
         });
+        /* Resolve the subscription's primary key through a double-async chain:
+           first resolve the APIM/resource group/subscription names, then fetch
+           the secrets from the Azure API to extract the primary key */
         const subscriptionKey = pulumi
             .all([this.api.apim.name, this.resourceGroup.name, apiManagementSubscription.name])
             .apply(([serviceName, resourceGroupName, subscriptionName]) => listSubscriptionSecretsOutput({

package/dist/src/construct/rest-api-function/main.d.ts

@@ -19,6 +19,11 @@ import { AzureApiFunction, AzureRestApiFunctionProps } from './types.js';
 export declare class AzureRestApiFunction extends AzureFunctionApp {
     props: AzureRestApiFunctionProps;
     api: AzureApiFunction;
+    /**
+     * @summary Create a new AzureRestApiFunction
+     * @param id scoped id of the resource
+     * @param props the REST API function properties
+     */
     constructor(id: string, props: AzureRestApiFunctionProps);
     /**
      * @summary Initialise and provision resources

package/dist/src/construct/rest-api-function/main.js

@@ -23,6 +23,11 @@ import { AzureFunctionApp } from '../function-app/index.js';
 export class AzureRestApiFunction extends AzureFunctionApp {
     props;
     api = {};
+    /**
+     * @summary Create a new AzureRestApiFunction
+     * @param id scoped id of the resource
+     * @param props the REST API function properties
+     */
     constructor(id, props) {
         super(id, props);
         this.props = props;

package/dist/src/construct/rest-api-with-cache/main.d.ts

@@ -18,6 +18,11 @@ import { AzureApiWithCache, AzureRestApiWithCacheProps } from './types.js';
 export declare class AzureRestApiWithCache extends AzureRestApi {
     props: AzureRestApiWithCacheProps;
     api: AzureApiWithCache;
+    /**
+     * @summary Create a new AzureRestApiWithCache
+     * @param id scoped id of the resource
+     * @param props the REST API with cache properties
+     */
     constructor(id: string, props: AzureRestApiWithCacheProps);
     /**
      * @summary Initialise and provision resources

package/dist/src/construct/rest-api-with-cache/main.js

@@ -18,6 +18,11 @@ import { AzureRestApi } from '../rest-api/main.js';
  */
 export class AzureRestApiWithCache extends AzureRestApi {
     props;
+    /**
+     * @summary Create a new AzureRestApiWithCache
+     * @param id scoped id of the resource
+     * @param props the REST API with cache properties
+     */
     constructor(id, props) {
         super(id, props);
         this.props = props;
@@ -50,6 +55,11 @@ export class AzureRestApiWithCache extends AzureRestApi {
      * @summary Method to create the Redis cache connection string secret in Key Vault
      */
     createRedisCacheSecret() {
+        /* Resolve the Redis connection string through a double-async chain:
+           first resolve the cluster/database/resource group names, then fetch
+           the database keys from the Azure API to build the connection string.
+           Port 10000 is the Azure Redis Enterprise port (not the standard 6379).
+           ssl=True and abortConnect=False are StackExchange.Redis connection params. */
         const connectionString = pulumi
             .all([
             this.api.redisCluster.hostName,
@@ -69,7 +79,10 @@ export class AzureRestApiWithCache extends AzureRestApi {
             properties: {
                 value: connectionString,
             },
-        }, { dependsOn: [this.api.redisCluster, this.api.redisDatabase, this.api.namedValueRoleAssignment] });
+        }, 
+        /* The role assignment must complete before writing the secret,
+           as Key Vault requires the identity to have access first */
+        { dependsOn: [this.api.redisCluster, this.api.redisDatabase, this.api.namedValueRoleAssignment] });
     }
     /**
      * @summary Method to create the API Management named value for the Redis cache secret

package/dist/src/construct/site-with-webapp/main.d.ts

@@ -21,6 +21,11 @@ export declare class SiteWithWebApp extends CommonAzureConstruct {
     props: SiteWithWebAppProps;
     applicationInsights: Output<GetComponentResult>;
     site: Site;
+    /**
+     * @summary Create a new SiteWithWebApp
+     * @param id scoped id of the resource
+     * @param props the site with web app properties
+     */
     constructor(id: string, props: SiteWithWebAppProps);
     /**
      * @summary Initialise and provision resources

package/dist/src/construct/site-with-webapp/main.js

@@ -23,6 +23,11 @@ export class SiteWithWebApp extends CommonAzureConstruct {
     props;
     applicationInsights;
     site = {};
+    /**
+     * @summary Create a new SiteWithWebApp
+     * @param id scoped id of the resource
+     * @param props the site with web app properties
+     */
     constructor(id, props) {
         super(id, props);
         this.props = props;

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

@@ -83,5 +83,10 @@ export declare class AzureAuthorisationManager {
      * @param resourceOptions Optional settings to control resource behaviour
      */
     grantRoleAssignmentToStorageTable(id: string, scope: CommonAzureConstruct, tableId: Input<string>, principalId: Input<string>, principalType: Input<PrincipalType>, roleDefinitionId: string, resourceOptions?: ResourceOptions): import("@pulumi/azure-native/authorization/roleAssignment.js").RoleAssignment;
+    /**
+     * @summary Method to resolve the full role definition ID from a subscription and role definition
+     * @param scope scope in which this resource is defined
+     * @param roleDefinitionId the role definition identifier to resolve
+     */
     resolveRoleDefinitionId(scope: CommonAzureConstruct, roleDefinitionId: RoleDefinitionId): string;
 }

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

@@ -123,6 +123,11 @@ export class AzureAuthorisationManager {
             scope: tableId,
         }, resourceOptions);
     }
+    /**
+     * @summary Method to resolve the full role definition ID from a subscription and role definition
+     * @param scope scope in which this resource is defined
+     * @param roleDefinitionId the role definition identifier to resolve
+     */
     resolveRoleDefinitionId(scope, roleDefinitionId) {
         if (!scope.props.subscriptionId)
             throw Error('Subscription id undefined');

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

@@ -1,10 +1,10 @@
 import { DashboardRenderer, MissingKeys, PaneTemplate, RenderParams } from './types.js';
 /** @category Service */
 export declare class AzureDashboardRenderer implements DashboardRenderer {
-    private readonly paneTemplatePath;
-    private readonly outputDir;
+    readonly paneTemplatePath: string;
+    readonly outputDir: string;
     constructor(basePath?: string, outputDir?: string);
-    private getPaneId;
+    protected getPaneId(id: string): PaneTemplate;
     getMissingProperties(template: PaneTemplate, properties?: RenderParams['properties']): MissingKeys;
     getMissingVariables(template: PaneTemplate, variables: RenderParams['variables']): MissingKeys;
     render(params: RenderParams): string;

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

@@ -1,5 +1,18 @@
 import { DashboardArgs } from '@pulumi/azure-native/portal/index.js';
 /** @category Interface */
+export type PaneClient = {
+    name: string;
+    domain: string;
+};
+/** @category Interface */
+export type PaneClientTemplate = {
+    rowTemplate: string;
+    prefix?: string;
+    separator?: string;
+    trailing?: string;
+    suffix?: string;
+};
+/** @category Interface */
 export type PaneTemplate = {
     dimensions: {
         height: number;
@@ -34,7 +47,16 @@ export type RenderParams = {
 };
 /** @category Interface */
 export interface DashboardRenderer {
+    /**
+     * @summary Render a dashboard template with the given parameters
+     * @param params the render parameters including panes, variables, and filters
+     */
     render(params: RenderParams): string;
+    /**
+     * @summary Render a dashboard template and write the output to a file
+     * @param filename the output file path
+     * @param params the render parameters including panes, variables, and filters
+     */
     renderToFile(filename: string, params: RenderParams): string;
 }
 /** @category Interface */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/cdk-utils-azure",
-  "version": "2.27.0",
+  "version": "2.28.0",
   "description": "Azure Pulumi utilities for @gradientedge/cdk-utils",
   "type": "module",
   "main": "dist/src/index.js",
@@ -17,13 +17,13 @@
     "@pulumi/archive": "0.3.7",
     "@pulumi/azure-native": "3.17.0",
     "@pulumi/azuread": "6.9.0",
-    "@pulumi/pulumi": "3.231.0",
+    "@pulumi/pulumi": "3.232.0",
     "@types/lodash": "4.17.24",
     "app-root-path": "3.1.0",
     "lodash": "4.18.1",
     "uuid": "14.0.0",
     "yaml": "2.8.3",
-    "@gradientedge/cdk-utils-common": "2.1.0"
+    "@gradientedge/cdk-utils-common": "2.2.0"
   },
   "keywords": [
     "gradientedge",