@gradientedge/cdk-utils-azure 2.0.0 → 2.1.0

package/dist/src/services/operational-insights/main.js

@@ -1,6 +1,6 @@
 import { Table, Workspace, WorkspaceSkuNameEnum } from '@pulumi/azure-native/operationalinsights/index.js';
 /**
- * @classdesc Provides operations on Azure Log Analytics Workspace using Pulumi
+ * Provides operations on Azure Log Analytics Workspace using Pulumi
  * - A new instance of this class is injected into {@link CommonAzureConstruct} constructor.
  * - If a custom construct extends {@link CommonAzureConstruct}, an instance is available within the context.
  * @example
@@ -15,6 +15,7 @@ import { Table, Workspace, WorkspaceSkuNameEnum } from '@pulumi/azure-native/ope
  *   }
  * }
  * ```
+ * @category Service
  */
 export class AzureOperationalInsightsManager {
     /**

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

@@ -1,5 +1,7 @@
 import { TableArgs, WorkspaceArgs } from '@pulumi/azure-native/operationalinsights/index.js';
+/** @category Interface */
 export interface WorkspaceProps extends WorkspaceArgs {
 }
+/** @category Interface */
 export interface WorkspaceTableProps extends TableArgs {
 }

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

@@ -1,3 +1,4 @@
+/** @category Service */
 export declare class TemplateError extends Error {
     readonly isTemplateError = true;
     constructor(message: string);

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

@@ -1,3 +1,4 @@
+/** @category Service */
 export class TemplateError extends Error {
     isTemplateError = true;
     constructor(message) {

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

@@ -3,7 +3,7 @@ import { CommonAzureConstruct } from '../../index.js';
 import { AzureDashboardRenderer } from './renderer.js';
 import { PortalDashboardProps } from './types.js';
 /**
- * @classdesc Provides operations on Azure Portal Dashboards using Pulumi
+ * Provides operations on Azure Portal Dashboards using Pulumi
  * - A new instance of this class is injected into {@link CommonAzureConstruct} constructor.
  * - If a custom construct extends {@link CommonAzureConstruct}, an instance is available within the context.
  * @example
@@ -18,6 +18,7 @@ import { PortalDashboardProps } from './types.js';
  *   }
  * }
  * ```
+ * @category Service
  */
 export declare class AzurePortalManager {
     /**

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

@@ -2,7 +2,7 @@ import fs from 'fs';
 import { Dashboard } from '@pulumi/azure-native/portal/index.js';
 import { AzureDashboardRenderer } from './renderer.js';
 /**
- * @classdesc Provides operations on Azure Portal Dashboards using Pulumi
+ * Provides operations on Azure Portal Dashboards using Pulumi
  * - A new instance of this class is injected into {@link CommonAzureConstruct} constructor.
  * - If a custom construct extends {@link CommonAzureConstruct}, an instance is available within the context.
  * @example
@@ -17,6 +17,7 @@ import { AzureDashboardRenderer } from './renderer.js';
  *   }
  * }
  * ```
+ * @category Service
  */
 export class AzurePortalManager {
     /**

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

@@ -1,4 +1,5 @@
 import { DashboardRenderer, MissingKeys, PaneTemplate, RenderParams } from './types.js';
+/** @category Service */
 export declare class AzureDashboardRenderer implements DashboardRenderer {
     private readonly paneTemplatePath;
     private readonly outputDir;

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

@@ -4,6 +4,7 @@ import appRoot from 'app-root-path';
 import _ from 'lodash';
 import { parse } from 'yaml';
 import { TemplateError } from './error.js';
+/** @category Service */
 export class AzureDashboardRenderer {
     paneTemplatePath;
     outputDir;

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

@@ -1,4 +1,5 @@
 import { DashboardArgs } from '@pulumi/azure-native/portal/index.js';
+/** @category Interface */
 export type PaneTemplate = {
     dimensions: {
         height: number;
@@ -7,30 +8,36 @@ export type PaneTemplate = {
     variables: Record<string, string>;
     template: string;
 };
+/** @category Interface */
 export type MissingKeys = {
     keys: Array<string>;
     hasMissingKeys: boolean;
 };
+/** @category Interface */
 export type Pane = {
     id: string;
     properties?: Record<string, string | number | Array<string | number>>;
 };
+/** @category Interface */
 export type Filter = {
     locale?: string;
     timeFormat?: string;
     timeGranularity?: string;
     timeRelative?: string;
 };
+/** @category Interface */
 export type RenderParams = {
     panes: Array<Pane>;
     variables: Record<string, any>;
     properties?: Record<string, any>;
     filter?: Filter;
 };
+/** @category Interface */
 export interface DashboardRenderer {
     render(params: RenderParams): string;
     renderToFile(filename: string, params: RenderParams): string;
 }
+/** @category Interface */
 export interface PortalDashboardProps extends DashboardArgs {
     displayName: string;
     panes: Array<Pane>;

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

@@ -2,7 +2,7 @@ import { ResourceOptions } from '@pulumi/pulumi';
 import { CommonAzureConstruct } from '../../common/index.js';
 import { RedisProps } from './types.js';
 /**
- * @classdesc Provides operations on Azure Redis using Pulumi
+ * Provides operations on Azure Redis using Pulumi
  * - A new instance of this class is injected into {@link CommonAzureConstruct} constructor.
  * - If a custom construct extends {@link CommonAzureConstruct}, an instance is available within the context.
  * @example
@@ -17,6 +17,7 @@ import { RedisProps } from './types.js';
  *   }
  * }
  * ```
+ * @category Service
  */
 export declare class AzureRedisManager {
     /**

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

@@ -1,6 +1,6 @@
 import { Redis, SkuFamily, SkuName } from '@pulumi/azure-native/redis/index.js';
 /**
- * @classdesc Provides operations on Azure Redis using Pulumi
+ * Provides operations on Azure Redis using Pulumi
  * - A new instance of this class is injected into {@link CommonAzureConstruct} constructor.
  * - If a custom construct extends {@link CommonAzureConstruct}, an instance is available within the context.
  * @example
@@ -15,6 +15,7 @@ import { Redis, SkuFamily, SkuName } from '@pulumi/azure-native/redis/index.js';
  *   }
  * }
  * ```
+ * @category Service
  */
 export class AzureRedisManager {
     /**

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

@@ -1,3 +1,4 @@
 import { RedisArgs } from '@pulumi/azure-native/redis/index.js';
+/** @category Interface */
 export interface RedisProps extends RedisArgs {
 }

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

@@ -2,7 +2,7 @@ import { ResourceOptions } from '@pulumi/pulumi';
 import { CommonAzureConstruct } from '../../common/index.js';
 import { ResourceGroupProps } from './types.js';
 /**
- * @classdesc Provides operations on Azure Resource Group using Pulumi
+ * Provides operations on Azure Resource Group using Pulumi
  * - A new instance of this class is injected into {@link CommonAzureConstruct} constructor.
  * - If a custom construct extends {@link CommonAzureConstruct}, an instance is available within the context.
  * @example
@@ -17,6 +17,7 @@ import { ResourceGroupProps } from './types.js';
  *   }
  * }
  * ```
+ * @category Service
  */
 export declare class AzureResourceGroupManager {
     /**

package/dist/src/services/resource-group/main.js

@@ -1,6 +1,6 @@
 import { getResourceGroupOutput, ResourceGroup } from '@pulumi/azure-native/resources/index.js';
 /**
- * @classdesc Provides operations on Azure Resource Group using Pulumi
+ * Provides operations on Azure Resource Group using Pulumi
  * - A new instance of this class is injected into {@link CommonAzureConstruct} constructor.
  * - If a custom construct extends {@link CommonAzureConstruct}, an instance is available within the context.
  * @example
@@ -15,6 +15,7 @@ import { getResourceGroupOutput, ResourceGroup } from '@pulumi/azure-native/reso
  *   }
  * }
  * ```
+ * @category Service
  */
 export class AzureResourceGroupManager {
     /**

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

@@ -1,3 +1,4 @@
 import { ResourceGroupArgs } from '@pulumi/azure-native/resources/index.js';
+/** @category Interface */
 export interface ResourceGroupProps extends ResourceGroupArgs {
 }

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

@@ -2,7 +2,7 @@ import { ResourceOptions } from '@pulumi/pulumi';
 import { CommonAzureConstruct } from '../../common/index.js';
 import { DefenderForStorageProps } from './types.js';
 /**
- * @classdesc Provides operations on Azure Security Center using Pulumi
+ * Provides operations on Azure Security Center using Pulumi
  * - A new instance of this class is injected into {@link CommonAzureConstruct} constructor.
  * - If a custom construct extends {@link CommonAzureConstruct}, an instance is available within the context.
  * @example
@@ -17,6 +17,7 @@ import { DefenderForStorageProps } from './types.js';
  *   }
  * }
  * ```
+ * @category Service
  */
 export declare class AzureSecurityCentermanager {
     /**

package/dist/src/services/security-center/main.js

@@ -1,6 +1,6 @@
 import { DefenderForStorage } from '@pulumi/azure-native/security/index.js';
 /**
- * @classdesc Provides operations on Azure Security Center using Pulumi
+ * Provides operations on Azure Security Center using Pulumi
  * - A new instance of this class is injected into {@link CommonAzureConstruct} constructor.
  * - If a custom construct extends {@link CommonAzureConstruct}, an instance is available within the context.
  * @example
@@ -15,6 +15,7 @@ import { DefenderForStorage } from '@pulumi/azure-native/security/index.js';
  *   }
  * }
  * ```
+ * @category Service
  */
 export class AzureSecurityCentermanager {
     /**

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

@@ -1,3 +1,4 @@
 import { DefenderForStorageArgs } from '@pulumi/azure-native/security/index.js';
+/** @category Interface */
 export interface DefenderForStorageProps extends DefenderForStorageArgs {
 }

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

@@ -2,7 +2,7 @@ import { ResourceOptions } from '@pulumi/pulumi';
 import { CommonAzureConstruct } from '../../common/index.js';
 import { ResolveServicebusQueueProps, ServiceBusNamespaceProps, ServiceBusQueueProps, ServiceBusSubscriptionProps, ServiceBusTopicProps } from './types.js';
 /**
- * @classdesc Provides operations on Azure Servicebus using Pulumi
+ * Provides operations on Azure Servicebus using Pulumi
  * - A new instance of this class is injected into {@link CommonAzureConstruct} constructor.
  * - If a custom construct extends {@link CommonAzureConstruct}, an instance is available within the context.
  * @example
@@ -17,6 +17,7 @@ import { ResolveServicebusQueueProps, ServiceBusNamespaceProps, ServiceBusQueueP
  *   }
  * }
  * ```
+ * @category Service
  */
 export declare class AzureServiceBusManager {
     /**

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

@@ -1,6 +1,6 @@
 import { getQueueOutput, ManagedServiceIdentityType, Namespace, Queue, SkuName, Subscription, Topic, } from '@pulumi/azure-native/servicebus/index.js';
 /**
- * @classdesc Provides operations on Azure Servicebus using Pulumi
+ * Provides operations on Azure Servicebus using Pulumi
  * - A new instance of this class is injected into {@link CommonAzureConstruct} constructor.
  * - If a custom construct extends {@link CommonAzureConstruct}, an instance is available within the context.
  * @example
@@ -15,6 +15,7 @@ import { getQueueOutput, ManagedServiceIdentityType, Namespace, Queue, SkuName,
  *   }
  * }
  * ```
+ * @category Service
  */
 export class AzureServiceBusManager {
     /**

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

@@ -1,11 +1,16 @@
 import { GetQueueOutputArgs, NamespaceArgs, QueueArgs, SubscriptionArgs, TopicArgs } from '@pulumi/azure-native/servicebus/index.js';
+/** @category Interface */
 export interface ServiceBusNamespaceProps extends NamespaceArgs {
 }
+/** @category Interface */
 export interface ServiceBusTopicProps extends TopicArgs {
 }
+/** @category Interface */
 export interface ServiceBusQueueProps extends QueueArgs {
 }
+/** @category Interface */
 export interface ServiceBusSubscriptionProps extends SubscriptionArgs {
 }
+/** @category Interface */
 export interface ResolveServicebusQueueProps extends GetQueueOutputArgs {
 }

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

@@ -4,7 +4,7 @@ import { ResourceOptions } from '@pulumi/pulumi';
 import { CommonAzureConstruct } from '../../common/index.js';
 import { ContainerSasTokenProps, ManagementPolicyProps, StorageAccountProps, StorageBlobProps, StorageContainerProps, StorageTableProps } from './types.js';
 /**
- * @classdesc Provides operations on Azure Storage using Pulumi
+ * Provides operations on Azure Storage using Pulumi
  * - A new instance of this class is injected into {@link CommonAzureConstruct} constructor.
  * - If a custom construct extends {@link CommonAzureConstruct}, an instance is available within the context.
  * @example
@@ -19,6 +19,7 @@ import { ContainerSasTokenProps, ManagementPolicyProps, StorageAccountProps, Sto
  *   }
  * }
  * ```
+ * @category Service
  */
 export declare class AzureStorageManager {
     /**
@@ -51,7 +52,6 @@ export declare class AzureStorageManager {
     /**
      * @summary Generates a container-level SAS token for an existing Azure Storage container.
      *
-     * @description
      * This method generates a Shared Access Signature (SAS) token for secure container access.
      * The token is generated using Pulumi's listStorageAccountSAS function.
      *

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

@@ -1,7 +1,7 @@
 import { Blob, BlobContainer, BlobServiceProperties, HttpProtocol, Kind, listStorageAccountSAS, ManagementPolicy, Permissions, Services, SignedResourceTypes, SkuName, StorageAccount, Table, } from '@pulumi/azure-native/storage/index.js';
 import * as pulumi from '@pulumi/pulumi';
 /**
- * @classdesc Provides operations on Azure Storage using Pulumi
+ * Provides operations on Azure Storage using Pulumi
  * - A new instance of this class is injected into {@link CommonAzureConstruct} constructor.
  * - If a custom construct extends {@link CommonAzureConstruct}, an instance is available within the context.
  * @example
@@ -16,6 +16,7 @@ import * as pulumi from '@pulumi/pulumi';
  *   }
  * }
  * ```
+ * @category Service
  */
 export class AzureStorageManager {
     /**
@@ -109,7 +110,6 @@ export class AzureStorageManager {
     /**
      * @summary Generates a container-level SAS token for an existing Azure Storage container.
      *
-     * @description
      * This method generates a Shared Access Signature (SAS) token for secure container access.
      * The token is generated using Pulumi's listStorageAccountSAS function.
      *

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

@@ -1,16 +1,22 @@
 import { BlobArgs, BlobContainerArgs, BlobServicePropertiesArgs, ListStorageAccountSASArgs, ManagementPolicyArgs, StorageAccountArgs, TableArgs } from '@pulumi/azure-native/storage/index.js';
 import { BaseAzureConfigProps } from '../../types/index.js';
+/** @category Interface */
 export interface StorageAccountProps extends StorageAccountArgs {
     blobProperties?: BlobServicePropertiesArgs;
 }
+/** @category Interface */
 export interface StorageContainerProps extends BlobContainerArgs, BaseAzureConfigProps {
 }
+/** @category Interface */
 export interface StorageBlobProps extends BaseAzureConfigProps, BlobArgs {
 }
+/** @category Interface */
 export interface ManagementPolicyProps extends ManagementPolicyArgs {
 }
+/** @category Interface */
 export interface StorageTableProps extends TableArgs {
 }
+/** @category Interface */
 export interface ContainerSasTokenProps extends ListStorageAccountSASArgs {
     resourceGroupName: string;
     containerName?: string;

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

@@ -1,4 +1,5 @@
 import * as pulumi from '@pulumi/pulumi';
+/** @category Interface */
 export interface BaseAzureConfigProps {
     resourceGroupName: pulumi.Input<string>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/cdk-utils-azure",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Azure Pulumi utilities for @gradientedge/cdk-utils",
   "type": "module",
   "main": "dist/src/index.js",
@@ -16,13 +16,20 @@
   "dependencies": {
     "@pulumi/archive": "0.3.7",
     "@pulumi/azure-native": "3.16.0",
-    "@pulumi/pulumi": "3.228.0",
+    "@pulumi/pulumi": "3.229.0",
     "@types/lodash": "4.17.24",
     "app-root-path": "3.1.0",
     "lodash": "4.18.1",
     "yaml": "2.8.3",
-    "@gradientedge/cdk-utils-common": "2.0.0"
+    "@gradientedge/cdk-utils-common": "2.1.0"
   },
+  "keywords": [
+    "gradientedge",
+    "azure",
+    "pulumi",
+    "iac",
+    "typescript"
+  ],
   "publishConfig": {
     "access": "public"
   },
@@ -32,6 +39,10 @@
     "url": "git+https://github.com/gradientedge/cdk-utils.git",
     "directory": "packages/azure"
   },
+  "typedocOptions": {
+    "gitRevision": "main",
+    "sourceLinkTemplate": "https://github.com/gradientedge/cdk-utils/blob/main/{path}#L{line}"
+  },
   "scripts": {
     "build": "tsc",
     "build:production": "tsc -p tsconfig.prd.json",