timonel 2.8.0 → 2.8.3

package/dist/lib/rutter.d.ts

@@ -5,13 +5,6 @@ import type { ServiceAccount, Ingress } from 'cdk8s-plus-33';
 import type { AWSALBIngressSpec, AWSEBSStorageClassSpec, AWSECRServiceAccountSpec, AWSEFSStorageClassSpec, AWSIRSAServiceAccountSpec } from './resources/cloud/aws/awsResources.js';
 import type { KarpenterEC2NodeClassSpec, KarpenterNodeClaimSpec, KarpenterNodePoolSpec } from './resources/cloud/aws/karpenterResources.js';
 import type { HelperDefinition } from './utils/helmHelpers.js';
-/**
- * Rutter class with modular architecture
- * Provides a clean API while delegating to specialized resource providers
- * Maintains full backward compatibility with the original Rutter class
- *
- * @since 2.4.0
- */
 export declare class Rutter {
     private static readonly HELPER_NAME;
     private readonly app;
@@ -24,168 +17,13 @@ export declare class Rutter {
     private readonly props;
     private readonly assets;
     constructor(props: RutterProps);
-    /**
-     * Creates an AWS EBS StorageClass
-     * @param spec - EBS StorageClass specification
-     * @returns Created StorageClass ApiObject
-     *
-     * @example
-     * ```typescript
-     * rutter.addAWSEBSStorageClass({
-     *   name: 'fast-ebs',
-     *   volumeType: 'gp3',
-     *   encrypted: true,
-     *   allowVolumeExpansion: true
-     * });
-     * ```
-     *
-     * @since 1.0.0
-     */
     addAWSEBSStorageClass(spec: AWSEBSStorageClassSpec): ApiObject;
-    /**
-     * Creates an AWS EFS StorageClass
-     * @param spec - EFS StorageClass specification
-     * @returns Created StorageClass ApiObject
-     *
-     * @example
-     * ```typescript
-     * rutter.addAWSEFSStorageClass({
-     *   name: 'efs-storage',
-     *   fileSystemId: 'fs-12345678',
-     *   directoryPerms: '0755'
-     * });
-     * ```
-     *
-     * @since 1.0.0
-     */
     addAWSEFSStorageClass(spec: AWSEFSStorageClassSpec): ApiObject;
-    /**
-     * Creates an AWS IRSA ServiceAccount
-     * @param spec - IRSA ServiceAccount specification
-     * @returns Created ServiceAccount ApiObject
-     *
-     * @example
-     * ```typescript
-     * rutter.addAWSIRSAServiceAccount({
-     *   name: 'my-service-account',
-     *   roleArn: 'arn:aws:iam::ACCOUNT_ID:role/MyRole'
-     * });
-     * ```
-     *
-     * @since 1.0.0
-     */
     addAWSIRSAServiceAccount(spec: AWSIRSAServiceAccountSpec): ServiceAccount;
-    /**
-     * Creates an AWS ALB Ingress
-     * @param spec - ALB Ingress specification
-     * @returns Created Ingress ApiObject
-     *
-     * @example
-     * ```typescript
-     * rutter.addAWSALBIngress({
-     *   name: 'web-ingress',
-     *   rules: [{
-     *     paths: [{
-     *       path: '/',
-     *       pathType: 'Prefix',
-     *       backend: { service: { name: 'web-service', port: { number: 80 } } }
-     *     }]
-     *   }],
-     *   scheme: 'internet-facing'
-     * });
-     * ```
-     *
-     * @since 1.0.0
-     */
     addAWSALBIngress(spec: AWSALBIngressSpec): Ingress;
-    /**
-     * Creates a Karpenter NodePool resource
-     * @param spec - NodePool specification
-     * @returns Created NodePool ApiObject
-     *
-     * @example
-     * ```typescript
-     * rutter.addKarpenterNodePool({
-     *   name: 'default-nodepool',
-     *   template: {
-     *     spec: {
-     *       nodeClassRef: {
-     *         apiVersion: 'karpenter.k8s.aws/v1beta1',
-     *         kind: 'EC2NodeClass',
-     *         name: 'default'
-     *       }
-     *     }
-     *   }
-     * });
-     * ```
-     *
-     * @since 2.7.0
-     */
     addKarpenterNodePool(spec: KarpenterNodePoolSpec): ApiObject;
-    /**
-     * Creates a Karpenter NodeClaim resource
-     * @param spec - NodeClaim specification
-     * @returns Created NodeClaim ApiObject
-     *
-     * @example
-     * ```typescript
-     * rutter.addKarpenterNodeClaim({
-     *   name: 'my-node-claim',
-     *   nodeClassRef: {
-     *     apiVersion: 'karpenter.k8s.aws/v1beta1',
-     *     kind: 'EC2NodeClass',
-     *     name: 'default'
-     *   }
-     * });
-     * ```
-     *
-     * @since 2.7.0
-     */
     addKarpenterNodeClaim(spec: KarpenterNodeClaimSpec): ApiObject;
-    /**
-     * Creates a Karpenter EC2NodeClass resource
-     * @param spec - EC2NodeClass specification
-     * @returns Created EC2NodeClass ApiObject
-     *
-     * @example
-     * ```typescript
-     * rutter.addKarpenterEC2NodeClass({
-     *   name: 'default',
-     *   amiFamily: 'AL2',
-     *   subnetSelectorTerms: [{ tags: { 'karpenter.sh/discovery': 'my-cluster' } }],
-     *   securityGroupSelectorTerms: [{ tags: { 'karpenter.sh/discovery': 'my-cluster' } }]
-     * });
-     * ```
-     *
-     * @since 2.7.0
-     */
     addKarpenterEC2NodeClass(spec: KarpenterEC2NodeClassSpec): ApiObject;
-    /**
-     * Creates a Karpenter NodePool with optimized disruption settings for cost efficiency
-     * @param spec - NodePool specification with disruption optimization
-     * @returns Created NodePool ApiObject
-     *
-     * @example
-     * ```typescript
-     * rutter.addKarpenterNodePoolWithDisruption({
-     *   name: 'cost-optimized',
-     *   nodeClassRef: {
-     *     apiVersion: 'karpenter.k8s.aws/v1beta1',
-     *     kind: 'EC2NodeClass',
-     *     name: 'default'
-     *   },
-     *   consolidationPolicy: 'WhenEmptyOrUnderutilized',
-     *   consolidateAfter: '30s',
-     *   expireAfter: '24h',
-     *   disruptionBudgets: [
-     *     { nodes: '20%' },
-     *     { nodes: '0', schedule: '0 9 * * 1-5', duration: '8h' }
-     *   ]
-     * });
-     * ```
-     *
-     * @since 2.7.1
-     */
     addKarpenterNodePoolWithDisruption(spec: {
         name: string;
         nodeClassRef: {
@@ -211,33 +49,6 @@ export declare class Rutter {
         labels?: Record<string, string>;
         annotations?: Record<string, string>;
     }): ApiObject;
-    /**
-     * Creates a Karpenter NodePool with scheduling constraints and priorities
-     * @param spec - NodePool specification with scheduling optimization
-     * @returns Created NodePool ApiObject
-     *
-     * @example
-     * ```typescript
-     * rutter.addKarpenterNodePoolWithScheduling({
-     *   name: 'gpu-workloads',
-     *   nodeClassRef: {
-     *     apiVersion: 'karpenter.k8s.aws/v1beta1',
-     *     kind: 'EC2NodeClass',
-     *     name: 'gpu-nodeclass'
-     *   },
-     *   requirements: [
-     *     { key: 'node.kubernetes.io/instance-type', operator: 'In', values: ['g4dn.xlarge', 'g4dn.2xlarge'] }
-     *   ],
-     *   taints: [
-     *     { key: 'nvidia.com/gpu', effect: 'NoSchedule' }
-     *   ],
-     *   terminationGracePeriod: '60s',
-     *   weight: 100
-     * });
-     * ```
-     *
-     * @since 2.7.1
-     */
     addKarpenterNodePoolWithScheduling(spec: {
         name: string;
         nodeClassRef: {
@@ -266,150 +77,20 @@ export declare class Rutter {
         labels?: Record<string, string>;
         annotations?: Record<string, string>;
     }): ApiObject;
-    /**
-     * Creates a ServiceAccount with ECR access annotations
-     * @param spec - ECR ServiceAccount specification
-     * @returns Created ServiceAccount ApiObject
-     *
-     * @example
-     * ```typescript
-     * rutter.addAWSECRServiceAccount({
-     *   name: 'ecr-service-account',
-     *   roleArn: 'arn:aws:iam::ACCOUNT_ID:role/ECRAccessRole'
-     * });
-     * ```
-     *
-     * @since 2.7.0
-     */
     addAWSECRServiceAccount(spec: AWSECRServiceAccountSpec): ServiceAccount;
-    /**
-     * Adds a Kubernetes manifest to the chart using CDK8S
-     *
-     * This method allows you to add any Kubernetes manifest (CRDs, custom resources, etc.)
-     * either as YAML strings or as objects. The manifest will be processed using CDK8S
-     * for better type safety and validation.
-     *
-     * @param yamlOrObject - Kubernetes manifest as YAML string or object
-     * @param id - Unique identifier for the manifest (required for multiple manifests)
-     *
-     * @example
-     * ```typescript
-     * // Using YAML string for CRD
-     * rutter.addManifest(`
-     * apiVersion: apiextensions.k8s.io/v1
-     * kind: CustomResourceDefinition
-     * metadata:
-     *   name: example.com
-     * spec:
-     *   group: example.com
-     *   versions: []
-     * `, 'my-crd');
-     *
-     * // Using object for any Kubernetes resource
-     * rutter.addManifest({
-     *   apiVersion: 'v1',
-     *   kind: 'ConfigMap',
-     *   metadata: { name: 'my-config' },
-     *   data: { key: 'value' }
-     * }, 'my-configmap');
-     * ```
-     *
-     * @since 3.0.0
-     * @note Consider using cdk8s-plus constructs for better type safety when available
-     */
     addManifest(yamlOrObject: string | Record<string, unknown>, id: string): ApiObject;
-    /**
-     * Adds a Kubernetes manifest wrapped in a Helm conditional
-     *
-     * This method creates a manifest that will only be rendered if the specified
-     * condition evaluates to true. The condition is checked against .Values in Helm.
-     *
-     * @param manifestObject - JavaScript object representing the Kubernetes manifest
-     * @param condition - Path to the condition value in .Values (e.g., 'createNamespace')
-     * @param id - Unique identifier for this manifest within the chart
-     * @returns The created ApiObject instance
-     * @throws {Error} If the manifest structure is incorrect or condition path is invalid
-     *
-     * @example
-     * ```typescript
-     * // Add a namespace that's only created if .Values.createNamespace is true
-     * rutter.addConditionalManifest(
-     *   {
-     *     apiVersion: 'v1',
-     *     kind: 'Namespace',
-     *     metadata: {
-     *       name: valuesRef('namespace'),
-     *       labels: {
-     *         environment: conditionalRef('environment', 'environment')
-     *       }
-     *     }
-     *   },
-     *   'createNamespace',
-     *   'namespace'
-     * );
-     * ```
-     *
-     * @since 2.7.4
-     */
     addConditionalManifest(manifestObject: Record<string, unknown>, condition: string, id: string): ApiObject;
-    /**
-     * Validates the structure of a Kubernetes manifest object
-     * @param manifest - The manifest object to validate
-     * @private
-     * @since 3.0.0
-     */
     private validateManifestStructure;
-    /**
-     * Gets chart metadata
-     * @returns Chart metadata
-     *
-     * @since 1.0.0
-     */
     getMeta(): ChartMetadata;
-    /**
-     * Gets default values
-     * @returns Default values object
-     *
-     * @since 1.0.0
-     */
     getDefaultValues(): Record<string, unknown>;
-    /**
-     * Gets environment-specific values
-     * @returns Environment values object
-     *
-     * @since 1.0.0
-     */
     getEnvValues(): Record<string, Record<string, unknown>>;
-    /**
-     * Gets all assets (CRDs, etc.)
-     * @returns Array of assets
-     *
-     * @since 1.0.0
-     */
     getAssets(): Array<{
         id: string;
         yaml: string;
         target: string;
     }>;
-    /**
-     * Converts the chart to SynthAsset array for HelmChartWriter
-     * @returns Array of synthesized assets
-     *
-     * @since 2.4.0
-     */
     private toSynthArray;
-    /**
-     * Process YAML content to remove quotes from Helm templates
-     * This fixes the issue where YAML.stringify adds quotes around Helm template expressions
-     * Removes quotes from all Helm template expressions
-     */
     private processHelmTemplates;
-    /**
-     * Writes the Helm chart to the specified output directory
-     * @param outDir - Output directory path
-     *
-     * @since 1.0.0
-     */
     write(outDir: string): void;
 }
 export interface ChartMetadata {
@@ -432,14 +113,9 @@ export interface RutterProps {
     envValues?: Record<string, Record<string, unknown>>;
     namespace?: string;
     chartProps?: ChartProps;
-    /** Custom Helm helpers content or definitions */
     helpersTpl?: string | HelperDefinition[];
-    /** Cloud provider for default helpers */
     cloudProvider?: 'aws';
-    /** Custom prefix for manifest files */
     manifestPrefix?: string;
-    /** Combine all resources into single manifest file */
     singleManifestFile?: boolean;
 }
 export type { AWSEBSStorageClassSpec, AWSEFSStorageClassSpec, AWSIRSAServiceAccountSpec, AWSALBIngressSpec, } from './resources/cloud/aws/awsResources.js';
-//# sourceMappingURL=rutter.d.ts.map