Enhancement/generate query params

package.json

@@ -18,9 +18,11 @@
     "test:e2e": "behave features",
     "type-check": "vue-tsc --noEmit -p tsconfig.vitest.json --composite false",
     "vibe-check": "npx vite-bundle-visualizer",
-    "generate-openapi-client": "openapi-generator-cli generate",
+    "generate:openapi-types": "yarn generate:openapi-client && yarn generate:query-types",
+    "generate:openapi-client": "openapi-generator-cli generate",
     "generate-osidb-mock": "msw-auto-mock ./openapi.yml -o src/mock-server --regex -t flaws,trackers,auth,labels --base-url http://localhost:3000",
     "generate-mock-worker": "msw init",
+    "generate:query-types": "npx ts-node scripts/get-osidb-query-params.ts",
     "lint": "yarn lint-style && yarn lint-ts-vue",
     "lint-ts-vue": "eslint .",
     "lint-fix": "eslint --fix .",
@@ -55,6 +57,7 @@
     "@stylistic/eslint-plugin": "^2.7.1",
     "@tsconfig/node18": "^18.2.2",
     "@types/eslint__js": "^8.42.3",
+    "@types/js-yaml": "^4.0.9",
     "@types/jsdom": "^21.1.3",
     "@types/luxon": "^3.3.2",
     "@types/node": "^20.4.0",
@@ -80,6 +83,7 @@
     "eslint-plugin-vitest": "^0.5.4",
     "eslint-plugin-vue": "^9.27.0",
     "eslint-processor-vue-blocks": "^0.1.2",
+    "js-yaml": "^4.1.0",
     "jsdom": "^22.1.0",
     "msw": "^2.1.2",
     "npm-run-all2": "^6.0.6",

scripts/get-osidb-query-params.ts

@@ -0,0 +1,98 @@
+
+
+import * as fs from 'fs';
+import * as yaml from 'js-yaml';
+import * as path from 'path';
+
+// Basic types for OpenAPI specification
+interface Parameter {
+  name: string;
+  in: 'query' | 'header' | 'path' | 'cookie';
+  description?: string;
+  required?: boolean;
+  schema?: any;
+}
+
+interface Operation {
+  parameters?: Parameter[];
+  summary?: string;
+  description?: string;
+}
+
+interface PathItem {
+  get?: Operation;
+  post?: Operation;
+  put?: Operation;
+  delete?: Operation;
+  patch?: Operation;
+}
+
+interface OpenAPIObject {
+  paths: {
+    [path: string]: PathItem;
+  };
+}
+
+/**
+ * Converts an API path to a PascalCase type name.
+ * Example: /osidb/api/v1/flaws/{uuid}/comments -> GetOsidbApiV1FlawsByUuidCommentsQueryParams
+ */
+function pathToTypeName(method: string, apiPath: string): string {
+  const cleanedPath = apiPath
+    .replace(/[^a-zA-Z0-9/_{}]/g, '') // Remove special characters except slashes and braces
+    .replace(/{/g, 'By/') // Replace { with By/ for path parameters
+    .replace(/}/g, ''); // Remove }
+
+  const parts = cleanedPath.split('/').filter(Boolean);
+  const pascalCaseName = parts
+    .map((part) => part.charAt(0).toUpperCase() + part.slice(1))
+    .join('');
+
+  return `${method.charAt(0).toUpperCase() + method.slice(1)}${pascalCaseName}QueryParams`;
+}
+
+
+const openapiPath = path.resolve(__dirname, '../openapi.yml');
+const outputPath = path.resolve(__dirname, '../src/types/osidb-query-params.ts');
+
+try {
+  const fileContents = fs.readFileSync(openapiPath, 'utf8');
+  const data = yaml.load(fileContents) as OpenAPIObject;
+
+  if (!data.paths) {
+    throw new Error('No paths found in openapi.yml');
+  }
+
+  const typeStrings: string[] = [];
+
+  for (const [apiPath, pathItem] of Object.entries(data.paths)) {
+    if (apiPath.includes('osidb') && pathItem.get) {
+      const parameters = pathItem.get.parameters;
+      if (parameters) {
+        const queryParams = parameters.filter((p) => p.in === 'query');
+        if (queryParams.length > 0) {
+          const typeName = pathToTypeName('get', apiPath);
+          let typeString = `/**\n * Query parameters for GET ${apiPath}\n */\n`;
+          typeString += `export type ${typeName} = {\n`;
+          queryParams.forEach((p) => {
+            const description = p.description ? ` // ${p.description.replace(/\n/g, ' ')}` : '';
+            typeString += `  '${p.name}'?: string;${description}\n`;
+          });
+          typeString += '};\n';
+          typeStrings.push(typeString);
+        }
+      }
+    }
+  }
+
+  const outputContent =
+`// This file is auto-generated by scripts/get-osidb-query-params.ts\n// Do not edit this file manually.\n\n${typeStrings.join('\n')}\n`;
+
+  fs.writeFileSync(outputPath, outputContent);
+  console.log(`Successfully generated query parameter types at: ${outputPath}`);
+
+} catch (e) {
+  console.error('Error processing openapi.yml:', e);
+  process.exit(1);
+}
+

src/services/AffectService.ts

@@ -3,11 +3,11 @@ import { createCatchHandler, createSuccessHandler } from '@/composables/service-
 import { isCveValid } from '@/utils/helpers';
 import { osidbFetch } from '@/services/OsidbAuthService';
 import type { ZodAffectType, ZodAffectCVSSType } from '@/types/';
-
+import type { GetOsidbApiV1AffectsQueryParams } from '@/types/';
 import { beforeFetch } from './FlawService';
 
 export async function getAffects(cveOrUuid: string) {
-  const field = isCveValid(cveOrUuid) ? 'cve_id' : 'flaw__uuid';
+  const field: GetOsidbApiV1AffectsQueryParams = isCveValid(cveOrUuid) ? 'flaw__cve_id' : 'flaw__uuid';
   return osidbFetch({
     method: 'get',
     url: '/osidb/api/v1/affects',

src/types/index.ts

@@ -1,3 +1,7 @@
+export type {
+  GetOsidbApiV1AffectsQueryParams,
+} from '@/types/osidb-query-params';
+
 export type {
   AffectCVSSSchemaType,
   AffectSchemaType,