Merge pull request #547 from kubeshop/feat/dry-run-config-types

Feat/dry run config types

.changeset/mighty-pets-pump.md

@@ -0,0 +1,5 @@
+---
+"@monokle/types": minor
+---
+
+add dry-run config types

packages/types/dry-run.ts

@@ -0,0 +1,57 @@
+export type DryRunConfigKind = 'kustomize' | 'helm';
+
+type Args = Array<Array<[string]>>;
+
+interface BaseConfig {
+  workdir?: string;
+  kind: DryRunConfigKind;
+  version?: string;
+  command?: string;
+}
+
+interface HelmConfig extends BaseConfig {
+  kind: 'helm';
+  command?: 'template';
+  values?: string[];
+  output?: string;
+  set?: {
+    [k: string]: unknown;
+  };
+  args?: Args;
+}
+
+interface KustomizeConfig extends BaseConfig {
+  kind: 'kustomize';
+  command?: 'build';
+  env?: {
+    [k: string]: unknown;
+  };
+  enableHelm?: boolean;
+  output?: string;
+  reorder?: 'legacy' | 'none';
+  args?: Args;
+}
+
+export interface DryRunHelmConfig extends HelmConfig {
+  postRender?: Array<HelmConfig | Omit<DryRunKustomizeConfig, 'postRender'>>
+}
+
+export interface DryRunKustomizeConfig extends KustomizeConfig {
+  postRender?: Array<Omit<DryRunHelmConfig, 'postRender'> | Omit<DryRunKustomizeConfig, 'postRender'>>
+}
+
+export type DryRunConfig = DryRunKustomizeConfig | DryRunHelmConfig;
+
+export interface DryRunConfigObject<
+  T extends DryRunConfig = DryRunConfig
+> {
+  [key: string]: unknown;
+  apiVersion: string;
+  kind: 'DryRun';
+  metadata: {
+    name: string;
+    [k: string]: unknown;
+  };
+  include?: string[]; // regex of involved files, when changed it automatically re-renders
+  data: T;
+}

packages/types/index.d.ts

@@ -64,3 +64,9 @@ export interface FingerprintSuppression extends ExternalSuppression {
   kind: 'external';
   fingerprint: string;
 }
+
+/**
+ * Dry-run configs
+ */
+
+export type * from './dry-run'