chore(types): fix types and add type check (#374)

Author: LiteSun

.github/workflows/typecheck.yaml

@@ -0,0 +1,25 @@
+name: Typecheck
+permissions:
+  contents: read
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 'lts/*'
+      - uses: pnpm/action-setup@v4
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Run TypeScript Type Check
+        run: npx nx run-many --target=typecheck --all --skip-nx-cache
+

.vscode/settings.json

@@ -1,3 +1,4 @@
 {
-  "editor.formatOnSave": true
+  "editor.formatOnSave": true,
+  "files.insertFinalNewline": true
 }

apps/cli/eslint.config.ts

@@ -13,6 +13,9 @@ export default config([
           ignoredFiles: [
             '{projectRoot}/eslint.config.{js,cjs,mjs,ts,cts,mts}',
             '{projectRoot}/vite.config.{js,ts,mjs,mts}',
+            '{projectRoot}/vitest.config.{js,ts,mjs,mts}',
+            '{projectRoot}/webpack.config.{js,ts}',
+            '{projectRoot}/e2e/**/*',
           ],
         },
       ],

apps/cli/package.json

@@ -6,13 +6,33 @@
     "@api7/adc-backend-apisix-standalone": "workspace:*",
     "@api7/adc-converter-openapi": "workspace:*",
     "@api7/adc-differ": "workspace:*",
-    "@api7/adc-sdk": "workspace:*",
     "@types/express": "^5.0.3",
     "@types/supertest": "^6.0.3",
-    "supertest": "^7.1.4"
+    "supertest": "^7.1.4",
+    "vitest": "^3.0.0",
+    "@nx/webpack": "21.6.4",
+    "webpack": "5.101.3",
+    "terser-webpack-plugin": "^5.3.14"
   },
   "dependencies": {
     "express": "^5.1.0",
-    "winston": "^3.17.0"
+    "winston": "^3.17.0",
+    "axios": "^1.13.1",
+    "rxjs": "^7.8.1",
+    "pluralize": "^8.0.0",
+    "listr2": "^8.2.1",
+    "commander": "^13.1.0",
+    "js-yaml": "^4.1.0",
+    "lodash": "^4.17.21",
+    "chalk": "^4.1.2",
+    "parse-duration": "^1.1.0",
+    "qs": "^6.12.1",
+    "dotenv": "^16.4.5",
+    "zod": "^4.0.10",
+    "source-map-support": "^0.5.21",
+    "agentkeepalive": "^4.6.0",
+    "glob": "^11.0.3",
+    "signale": "^1.4.0",
+    "@api7/adc-sdk": "workspace:*"
   }
 }

apps/cli/src/command/helper.ts

@@ -8,7 +8,7 @@ import parseDuration from 'parse-duration';
 import qs from 'qs';
 
 export interface BaseOptions {
-  verbose: boolean;
+  verbose: number;
 }
 export class BaseCommand<
   OPTS extends BaseOptions = BaseOptions,

apps/cli/src/command/lint.command.ts

@@ -1,9 +1,5 @@
-import * as ADCSDK from '@api7/adc-sdk';
-import { Listr, ListrTask } from 'listr2';
-import pluralize from 'pluralize';
-import { ZodError } from 'zod';
+import { Listr } from 'listr2';
 
-import { check } from '../linter';
 import { LintTask, LoadLocalConfigurationTask } from '../tasks';
 import { SignaleRenderer } from '../utils/listr';
 import { BaseCommand } from './helper';

apps/cli/src/command/typing.d.ts

@@ -9,6 +9,9 @@ export type BackendOptions = {
   server: string;
   token: string;
   gatewayGroup: string;
+  cacheKey: string;
+  httpAgent: httpAgent;
+  httpsAgent: httpsAgent;
 
   labelSelector?: Record<string, string>;
   includeResourceType?: Array<ADCSDK.ResourceType>;

apps/cli/src/command/utils.spec.ts

@@ -49,7 +49,7 @@ describe('CLI utils', () => {
               name: 'Test Stream Route',
             },
           ],
-        },
+        } as ADCSDK.Configuration,
         { test1: 'test1', test2: 'test2' },
       ),
     ).toEqual({
@@ -147,7 +147,7 @@ describe('CLI utils', () => {
               labels: { test: 'test' },
             },
           ],
-        },
+        } as ADCSDK.Configuration,
         { test1: 'test1', test2: 'test2' },
       ),
     ).toEqual({
@@ -201,7 +201,7 @@ describe('CLI utils', () => {
   });
 
   it('should remove metadata from dump result', () => {
-    const config: ADCSDK.Configuration = {
+    const config = {
       services: [
         {
           name: 'TestService1',
@@ -232,7 +232,7 @@ describe('CLI utils', () => {
           metadata: { id: 'test_ssl' },
         },
       ],
-    };
+    } as unknown as ADCSDK.Configuration;
     recursiveRemoveMetadataField(config);
     expect(config).toEqual({
       services: [

apps/cli/src/command/utils.ts

@@ -62,7 +62,12 @@ export const toKVConfiguration = (
       ) {
         return [
           resourceType,
-          Object.fromEntries(resources.map((item) => [item.name, item])),
+          Object.fromEntries(
+            (Array.isArray(resources) ? resources : []).map((item) => [
+              item.name,
+              item,
+            ]),
+          ),
         ];
       } else {
         throw new Error(
@@ -120,52 +125,6 @@ export const mergeKVConfigurations = (
   return baseConfiguration;
 };
 
-export const mergeConfigurations = (
-  ...fileContents: Array<ADCSDK.Configuration>
-) => {
-  const result: ADCSDK.Configuration = {
-    services: [],
-    ssls: [],
-    consumers: [],
-    global_rules: {},
-    plugin_metadata: {},
-
-    routes: [],
-    stream_routes: [],
-    /* consumer_groups: [],
-    plugin_configs: [],
-    upstreams: [], */
-  };
-
-  fileContents.forEach((config) => {
-    config.services && result.services.push(...config.services);
-    config.ssls && result.ssls.push(...config.ssls);
-    config.consumers && result.consumers.push(...config.consumers);
-    config.global_rules &&
-      Object.keys(config.global_rules).forEach((globalRuleName: string) => {
-        result.global_rules[globalRuleName] =
-          config.global_rules[globalRuleName];
-      });
-    config.plugin_metadata &&
-      Object.keys(config.plugin_metadata).forEach(
-        (pluginMetadataName: string) => {
-          result.plugin_metadata[pluginMetadataName] =
-            config.plugin_metadata[pluginMetadataName];
-        },
-      );
-
-    config.routes && result.routes.push(...config.routes);
-    config.stream_routes && result.stream_routes.push(...config.stream_routes);
-    /* config.consumer_groups &&
-      result.consumer_groups.push(...config.consumer_groups);
-    config.plugin_configs &&
-      result.plugin_configs.push(...config.plugin_configs);
-    config.upstreams && result.upstreams.push(...config.upstreams); */
-  });
-
-  return result;
-};
-
 export const filterConfiguration = (
   configuration: ADCSDK.Configuration,
   rules: Record<string, string>,
@@ -332,7 +291,7 @@ export const resortConfiguration = (
         ];
       return [
         key,
-        value.sort((a, b) => {
+        (Array.isArray(value) ? value : []).sort((a, b) => {
           // sort nested resources
           if (key === 'services') {
             if (a.routes) a.routes.sort((x, y) => x.name.localeCompare(y.name));

apps/cli/src/linter/specs/consumer.spec.ts

@@ -52,7 +52,6 @@ describe('Consumer Linter', () => {
     },
     {
       name: 'should check consumer credentials (unsupported type)',
-      //@ts-expect-error for test
       input: {
         consumers: [
           {