Create action to test generated file matches

.github/workflows/test.yml

@@ -0,0 +1,29 @@
+name: Test
+on:
+  pull_request:
+    branches:
+      - "*"
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20.12.0
+      - name: Install dependencies
+        run: yarn install
+      - name: Generate API file
+        run: yarn generate
+      - name: Check generated files match
+        uses: tj-actions/verify-changed-files@v19
+        with:
+          files: |
+            src/Brevo.ts
+          fail-if-changed: true
+          fail-message: "Generate API file is different to the committed one. Please run `yarn generate` and commit the changes."

generate.ts

@@ -0,0 +1,21 @@
+import { generateApi } from "swagger-typescript-api";
+import path from "path";
+
+generateApi({
+  name: "Brevo.ts",
+  // @ts-ignore
+  apiClassName: "Brevo",
+  url: "https://api.brevo.com/v3/swagger_definition.yml",
+  output: path.resolve(__dirname, "src"),
+  httpClientType: "axios",
+  hooks: {
+    // Fix date example changing to current date on every run
+    onParseSchema: (schema) => {
+      if (schema.example && schema.example instanceof Date) {
+        schema.example = "2024-01-22T09:25:00.000Z";
+      }
+    },
+  },
+}).then(() => {
+  process.exit(0);
+});

package.json

@@ -9,15 +9,18 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
-    "clean": "rm -Rf node_modules/ *.js",
-    "build": "tsc"
+    "build": "tsc",
+    "generate": "ts-node generate.ts"
   },
   "author": "Brevo",
   "license": "MIT",
   "dependencies": {
     "axios": "^1.6.8"
   },
   "devDependencies": {
+    "@types/node": "^20.12.4",
+    "swagger-typescript-api": "^13.0.3",
+    "ts-node": "^10.9.2",
     "typescript": "^5.4.3"
   }
 }

src/Brevo.ts

@@ -958,7 +958,7 @@ export interface GetWhatsappCampaignOverview {
   campaignStatus: "draft" | "scheduled" | "pending" | "approved" | "running" | "suspended" | "rejected" | "sent";
   /**
    * UTC date-time on which WhatsApp campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format
-   * @example "2024-04-03T18:18:49.106Z"
+   * @example "2024-01-22T09:25:00.000Z"
    */
   scheduledAt?: string;
   /**
@@ -970,12 +970,12 @@ export interface GetWhatsappCampaignOverview {
   template: WhatsappCampTemplate;
   /**
    * Creation UTC date-time of the WhatsApp campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
-   * @example "2024-04-03T18:18:49.106Z"
+   * @example "2024-01-22T09:25:00.000Z"
    */
   createdAt: string;
   /**
    * UTC date-time of last modification of the WhatsApp campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
-   * @example "2024-04-03T18:18:49.106Z"
+   * @example "2024-01-22T09:25:00.000Z"
    */
   modifiedAt: string;
 }
@@ -1082,12 +1082,12 @@ export interface GetWATemplates {
     errorReason?: string;
     /**
      * Creation UTC date-time of the whatsApp template (YYYY-MM-DDTHH:mm:ss.SSSZ)
-     * @example "2024-04-03T18:18:49.106Z"
+     * @example "2024-01-22T09:25:00.000Z"
      */
     createdAt: string;
     /**
      * UTC date-time of last modification of the whatsApp template (YYYY-MM-DDTHH:mm:ss.SSSZ)
-     * @example "2024-04-03T18:18:49.106Z"
+     * @example "2024-01-22T09:25:00.000Z"
      */
     modifiedAt: string;
   }[];
@@ -1124,7 +1124,7 @@ export interface GetWhatsappCampaigns {
     campaignStatus: "draft" | "scheduled" | "pending" | "approved" | "running" | "suspended" | "rejected" | "sent";
     /**
      * UTC date-time on which WhatsApp campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format
-     * @example "2024-04-03T18:18:49.106Z"
+     * @example "2024-01-22T09:25:00.000Z"
      */
     scheduledAt: string;
     /**
@@ -1147,12 +1147,12 @@ export interface GetWhatsappCampaigns {
     stats?: WhatsappCampStats;
     /**
      * Creation UTC date-time of the WhatsApp campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
-     * @example "2024-04-03T18:18:49.106Z"
+     * @example "2024-01-22T09:25:00.000Z"
      */
     createdAt: string;
     /**
      * UTC date-time of last modification of the whatsApp template (YYYY-MM-DDTHH:mm:ss.SSSZ)
-     * @example "2024-04-03T18:18:49.106Z"
+     * @example "2024-01-22T09:25:00.000Z"
      */
     modifiedAt: string;
   }[];

tsconfig.json

@@ -1,19 +1,9 @@
 {
   "compilerOptions": {
+    "target": "es2016",
     "module": "commonjs",
-    "noImplicitAny": false,
-    "target": "ES6",
-    "allowSyntheticDefaultImports": true,
     "esModuleInterop": true,
     "strict": true,
-    "moduleResolution": "node",
-    "removeComments": true,
-    "sourceMap": true,
-    "noLib": false,
-    "declaration": true,
-    "lib": ["dom", "es6", "es5", "dom.iterable", "scripthost"],
-    "outDir": "dist",
-    "typeRoots": ["node_modules/@types"]
-  },
-  "exclude": ["dist", "node_modules"]
+    "skipLibCheck": true
+  }
 }