@pagopa/dx-savemoney 0.1.6 → 0.2.0

package/src/schema.ts

@@ -0,0 +1,134 @@
+/**
+ * Zod schemas for the SaveMoney YAML configuration file.
+ *
+ * The entire config is represented by a single `ConfigSchema` composed of
+ * sub-schemas.  All types used at runtime are derived from these schemas via
+ * `z.infer<>` so the source of truth is always the schema.
+ *
+ * YAML structure:
+ * ```yaml
+ * azure:
+ *   subscriptionIds:
+ *     - xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+ *   preferredLocation: italynorth  # optional
+ *   timespanDays: 30               # optional
+ *   thresholds:                    # optional – omit to keep built-in defaults
+ *     vm:
+ *       cpuPercent: 5
+ * ```
+ */
+
+import { z } from "zod";
+
+// ── per-resource threshold sub-schemas ──────────────────────────────────────
+
+const VmThresholdsSchema = z
+  .object({
+    /** CPU threshold (%) below which usage is flagged as low. Default: 1 */
+    cpuPercent: z.number().default(1),
+    /** Network inbound threshold (bytes/day) below which traffic is flagged as low. Default: 3 MB */
+    networkInBytesPerDay: z.number().default(1024 * 1024 * 3),
+  })
+  .strict();
+
+const AppServiceThresholdsSchema = z
+  .object({
+    /** CPU threshold (%) below which usage is flagged as very low. Default: 5 */
+    cpuPercent: z.number().default(5),
+    /** Memory threshold (%) below which usage is flagged as very low. Default: 10 */
+    memoryPercent: z.number().default(10),
+    /** CPU threshold (%) for Premium-tier plans below which over-provisioning is flagged. Default: 10 */
+    premiumCpuPercent: z.number().default(10),
+  })
+  .strict();
+
+const ContainerAppThresholdsSchema = z
+  .object({
+    /** CPU threshold (nanoCores) below which usage is flagged as very low. Default: 1 000 000 (0.001 cores) */
+    cpuNanoCores: z.number().default(1_000_000),
+    /** Memory threshold (bytes) below which usage is flagged as very low. Default: 10 MB */
+    memoryBytes: z.number().default(10_485_760),
+    /** Combined Rx+Tx network threshold (bytes/day) below which traffic is flagged as very low. Default: ~33 KB */
+    networkBytes: z.number().default(34_000),
+  })
+  .strict();
+
+const StorageThresholdsSchema = z
+  .object({
+    /** Average daily transaction count below which the account is flagged. Default: 10 */
+    transactionsPerDay: z.number().default(10),
+  })
+  .strict();
+
+const PublicIpThresholdsSchema = z
+  .object({
+    /** DDoS inbound bytes/day threshold below which traffic is flagged as very low. Default: ~332 KB */
+    bytesInDDoS: z.number().default(340_000),
+  })
+  .strict();
+
+const StaticSiteThresholdsSchema = z
+  .object({
+    /** Total bytes sent below which data transfer is flagged as very low. Default: 1 MB */
+    bytesSent: z.number().default(1_048_576),
+    /** Total site hits below which traffic is flagged as very low. Default: 100 */
+    siteHits: z.number().default(100),
+  })
+  .strict();
+
+// ── composed thresholds schema ───────────────────────────────────────────────
+
+export const ThresholdsSchema = z
+  .object({
+    appService: AppServiceThresholdsSchema.optional().transform((v) =>
+      AppServiceThresholdsSchema.parse(v ?? {}),
+    ),
+    containerApp: ContainerAppThresholdsSchema.optional().transform((v) =>
+      ContainerAppThresholdsSchema.parse(v ?? {}),
+    ),
+    publicIp: PublicIpThresholdsSchema.optional().transform((v) =>
+      PublicIpThresholdsSchema.parse(v ?? {}),
+    ),
+    staticSite: StaticSiteThresholdsSchema.optional().transform((v) =>
+      StaticSiteThresholdsSchema.parse(v ?? {}),
+    ),
+    storage: StorageThresholdsSchema.optional().transform((v) =>
+      StorageThresholdsSchema.parse(v ?? {}),
+    ),
+    vm: VmThresholdsSchema.optional().transform((v) =>
+      VmThresholdsSchema.parse(v ?? {}),
+    ),
+  })
+  .strict();
+
+// ── top-level config schema ──────────────────────────────────────────────────
+
+const AzureSectionSchema = z
+  .object({
+    preferredLocation: z.string().default("italynorth"),
+    subscriptionIds: z
+      .array(z.string())
+      .min(
+        1,
+        "Config file must contain at least one entry in 'azure.subscriptionIds'",
+      ),
+    thresholds: ThresholdsSchema.optional().transform((v) =>
+      ThresholdsSchema.parse(v ?? {}),
+    ),
+    timespanDays: z.number().int().positive().default(30),
+  })
+  .strict();
+
+/**
+ * Single Zod schema representing the entire YAML configuration file.
+ * Use `ConfigSchema.parse(rawYaml)` to validate and apply defaults.
+ */
+export const ConfigSchema = z.object({ azure: AzureSectionSchema }).strict();
+
+// ── inferred types ───────────────────────────────────────────────────────────
+
+/** Fully-resolved configuration (all defaults applied). */
+export type Config = z.infer<typeof ConfigSchema>;
+
+/** Fully-resolved thresholds (all defaults applied). */
+export type Thresholds = z.infer<typeof ThresholdsSchema>;

package/src/types.ts

@@ -2,6 +2,8 @@
  * Common types shared across all cloud providers
  */
 
+import { ThresholdsSchema } from "./schema.js";
+
 export type AnalysisResult = {
   costRisk: CostRisk;
   reason: string;
@@ -18,6 +20,18 @@ export type BaseConfig = {
 
 export type CostRisk = "high" | "low" | "medium";
 
+/**
+ * Configurable thresholds used during resource analysis.
+ * Derived from `ThresholdsSchema` — the schema is the single source of truth.
+ */
+export type { Thresholds } from "./schema.js";
+
+/**
+ * Default threshold values — produced by parsing an empty object through
+ * `ThresholdsSchema`, which applies all schema-defined defaults.
+ */
+export const DEFAULT_THRESHOLDS = ThresholdsSchema.parse({});
+
 /**
  * Merges analysis results, preserving existing reasons and combining suspectedUnused flags.
  */