feat: Improve AWSIntegrationServices type

Author: wafuwafu13

awsintegrations.ts

@@ -1,5 +1,48 @@
 import { PayloadType } from "./mackerel.ts";
 
+const awsServices = [
+  "EC2",
+  "ELB",
+  "ALB",
+  "RDS",
+  "Redshift",
+  "ElastiCache",
+  "SQS",
+  "Lambda",
+  "NLB",
+  "DynamoDB",
+  "CloudFront",
+  "APIGateway",
+  "Kinesis",
+  "S3",
+  "ES",
+  "ECSCluster",
+  "SES",
+  "States",
+  "EFS",
+  "Firehose",
+  "Batch",
+  "WAF",
+  "Billing",
+  "Route53",
+  "Connect",
+  "DocDB",
+  "CodeBuild",
+] as const;
+
+type AWSService = typeof awsServices[number];
+
+type AWSIntegrationService = {
+  enable: boolean;
+  role: string | null;
+  excludedMetrics: string[];
+  retireAutomatically?: boolean;
+};
+
+export type AWSIntegrationServices = {
+  [S in AWSService]?: AWSIntegrationService;
+};
+
 export type AWSIntegration = {
   id: string;
   name: string;
@@ -10,14 +53,7 @@ export type AWSIntegration = {
   region: string;
   includedTags: string;
   excludedTags: string;
-  services: Record<string, AWSIntegrationService>;
-};
-
-export type AWSIntegrationService = {
-  enable: boolean;
-  role: string | null;
-  excludedMetrics: string[];
-  retireAutomatically?: boolean;
+  services: AWSIntegrationServices;
 };
 
 export type RegisterAWSIntegrationParam = {
@@ -30,7 +66,7 @@ export type RegisterAWSIntegrationParam = {
   region: string;
   includedTags: string;
   excludedTags: string;
-  services: Record<string, AWSIntegrationService>;
+  services: AWSIntegrationServices;
 };
 
 export type UpdateAWSIntegrationParam =
@@ -40,7 +76,9 @@ export type UpdateAWSIntegrationParam =
     "name" | "memo" | "region" | "includedTags" | "excludedTags" | "services"
   >;
 
-export type ListAWSIntegrationExcludableMetrics = Record<string, string[]>;
+export type ListAWSIntegrationExcludableMetrics = {
+  [S in AWSService]?: string[];
+};
 
 export const listAwsIntegrationSettings = async (
   urlFor: (path: string) => URL,

awsintegrations_test.ts

@@ -41,7 +41,7 @@ Deno.test("listAwsIntegrationSettings", async () => {
   const client = new Mackerel.Client(dummyApiKey, dummyBaseurl);
   const resp = await client.listAwsIntegrationSettings();
   assertEquals(resp[0].name, "test-aws-integration");
-  assertEquals(resp[0].services["EC2"].retireAutomatically, false);
+  assertEquals(resp[0].services["EC2"]!.retireAutomatically, false);
   mf.uninstall();
 });
 
@@ -80,7 +80,7 @@ Deno.test("getAwsIntegrationSettings", async () => {
   const client = new Mackerel.Client(dummyApiKey, dummyBaseurl);
   const resp = await client.getAwsIntegrationSettings(awsIntegrationID);
   assertEquals(resp.id, awsIntegrationID);
-  assertEquals(resp.services["EC2"].retireAutomatically, false);
+  assertEquals(resp.services["EC2"]!.retireAutomatically, false);
   mf.uninstall();
 });
 
@@ -124,7 +124,7 @@ Deno.test("registerAwsIntegrationSettings", async () => {
   const client = new Mackerel.Client(dummyApiKey, dummyBaseurl);
   const resp = await client.registerAwsIntegrationSettings(registerParam);
   assertEquals(resp.id, "testid");
-  assertEquals(resp.services["S3"].enable, true);
+  assertEquals(resp.services["S3"]!.enable, true);
   mf.uninstall();
 });
 
@@ -174,7 +174,7 @@ Deno.test("updateAwsIntegrationSettings", async () => {
     updateParam,
   );
   assertEquals(resp.id, "testid");
-  assertEquals(resp.services["ALB"].enable, true);
+  assertEquals(resp.services["ALB"]!.enable, true);
   mf.uninstall();
 });
 
@@ -213,7 +213,7 @@ Deno.test("deleteAwsIntegrationSettings", async () => {
   const client = new Mackerel.Client(dummyApiKey, dummyBaseurl);
   const resp = await client.deleteAwsIntegrationSettings(awsIntegrationID);
   assertEquals(resp.id, awsIntegrationID);
-  assertEquals(resp.services["EC2"].retireAutomatically, false);
+  assertEquals(resp.services["EC2"]!.retireAutomatically, false);
   mf.uninstall();
 });
 
@@ -251,6 +251,6 @@ Deno.test("listExcludableMetricsForAwsIntegration", async () => {
   );
   const client = new Mackerel.Client(dummyApiKey, dummyBaseurl);
   const resp = await client.listExcludableMetricsForAwsIntegration();
-  assertEquals(resp["ELB"][1], "testmetrics2");
+  assertEquals(resp["ELB"]![1], "testmetrics2");
   mf.uninstall();
 });

mackerel.ts

@@ -7,7 +7,7 @@ import {
 } from "./service.ts";
 import {
   AWSIntegration,
-  AWSIntegrationService,
+  AWSIntegrationServices,
   deleteAwsIntegrationSettings,
   generateAwsIntegrationExternalID,
   getAwsIntegrationSettings,
@@ -38,7 +38,7 @@ type ErrorType = {
 export type PayloadType =
   | Record<
     never | string,
-    never | string | number | null | Record<string, AWSIntegrationService>
+    never | string | number | null | AWSIntegrationServices
   >
   | null;