chore(CamelCatalog): Add Catalog index typings

fix: #5
KaotoIO · May 22, 2024 · 8c490a7 · 8c490a7
1 parent ed74d48
commit 8c490a7
Show file tree

Hide file tree

Showing 5 changed files with 52 additions and 35 deletions.
diff --git a/packages/camel-catalog/kaoto-camel-catalog-maven-plugin/pom.xml b/packages/camel-catalog/kaoto-camel-catalog-maven-plugin/pom.xml
@@ -76,6 +76,34 @@
           </mojoDependencies>
         </configuration>
       </plugin>
+      <plugin>
+        <groupId>cz.habarta.typescript-generator</groupId>
+        <artifactId>typescript-generator-maven-plugin</artifactId>
+        <version>3.2.1263</version>
+        <executions>
+          <execution>
+            <id>generate</id>
+            <phase>process-classes</phase>
+            <goals>
+              <goal>generate</goal>
+            </goals>
+          </execution>
+        </executions>
+        <configuration>
+          <jsonLibrary>jackson2</jsonLibrary>
+          <generateNpmPackageJson>false</generateNpmPackageJson>
+          <outputKind>module</outputKind>
+          <outputFileType>declarationFile</outputFileType>
+          <generateJaxrsApplicationInterface>true</generateJaxrsApplicationInterface>
+          <classesFromAutomaticJaxrsApplication>true</classesFromAutomaticJaxrsApplication>
+          <restNamespacing>perResource</restNamespacing>
+
+          <outputFile>../dist/types/catalog-index.d.ts</outputFile>
+          <classPatterns>
+            <classPattern>io.kaoto.camelcatalog.Index</classPattern>
+          </classPatterns>
+        </configuration>
+      </plugin>
     </plugins>
   </build>
 </project>
diff --git a/packages/camel-catalog/src/json-schema-to-typescript.mts b/packages/camel-catalog/src/json-schema-to-typescript.mts
@@ -15,8 +15,8 @@ import index from '../dist/index.json' assert { type: 'json' };
 const ensureTypesFolder = async () => {
   const typesFolder = resolve('./dist/types');
 
-  await rimraf(typesFolder);
-  await mkdir(typesFolder);
+  await rimraf(typesFolder, { filter: (path) => !path.includes('catalog-index.d.ts') });
+  await mkdir(typesFolder, { recursive: true });
 };
 
 /** Function to compile a JSON schema file to a TypeScript file */
@@ -50,7 +50,7 @@ const addTitleToDefinitions = (schema: JSONSchema) => {
 async function main() {
   await ensureTypesFolder();
 
-  const exportedFiles: string[] = [];
+  const exportedFiles: string[] = ['catalog-index'];
 
   console.log('---');
   const targetSchemaNames = [

diff --git a/packages/ui/src/models/camel-catalog-index.ts b/packages/ui/src/models/camel-catalog-index.ts
@@ -1,36 +1,24 @@
+import { Entry, Index } from '@kaoto/camel-catalog/types';
 import { ICamelComponentDefinition } from './camel-components-catalog';
-import { ICamelProcessorDefinition } from './camel-processors-catalog';
-import { ICamelLanguageDefinition } from './camel-languages-catalog';
 import { ICamelDataformatDefinition } from './camel-dataformats-catalog';
+import { ICamelLanguageDefinition } from './camel-languages-catalog';
+import { ICamelLoadBalancerDefinition } from './camel-loadbalancers-catalog';
+import { ICamelProcessorDefinition } from './camel-processors-catalog';
 import { CatalogKind } from './catalog-kind';
 import { IKameletDefinition } from './kamelets-catalog';
-import { ICamelLoadBalancerDefinition } from './camel-loadbalancers-catalog';
-
-export interface CamelCatalogIndex {
-  catalogs: Catalogs;
-  schemas: Record<string, SchemaEntry>;
-}
-
-export interface Catalogs {
-  models: CatalogEntry;
-  components: CatalogEntry;
-  languages: CatalogEntry;
-  dataformats: CatalogEntry;
-  kamelets: CatalogEntry;
-  kameletBoundaries: CatalogEntry;
-  patterns: CatalogEntry;
-  entities: CatalogEntry;
-  loadbalancers: CatalogEntry;
-}
-
-export interface CatalogEntry {
-  name: string;
-  version: string;
-  file: string;
-}
 
-export interface SchemaEntry extends CatalogEntry {
-  description: string;
+export interface CamelCatalogIndex extends Omit<Index, 'catalogs'> {
+  catalogs: {
+    models: Entry;
+    components: Entry;
+    languages: Entry;
+    dataformats: Entry;
+    kamelets: Entry;
+    kameletBoundaries: Entry;
+    patterns: Entry;
+    entities: Entry;
+    loadbalancers: Entry;
+  };
 }
 
 export type ComponentsCatalogTypes =

diff --git a/packages/ui/src/utils/catalog-schema-loader.test.ts b/packages/ui/src/utils/catalog-schema-loader.test.ts
@@ -1,4 +1,4 @@
-import { SchemaEntry } from '../models';
+import { Entry } from '@kaoto/camel-catalog/types';
 import { CatalogSchemaLoader } from './catalog-schema-loader';
 
 describe('CatalogSchemaLoader', () => {
@@ -38,7 +38,7 @@ describe('CatalogSchemaLoader', () => {
   });
 
   describe('getSchemasFiles', () => {
-    const schemasEntries: Record<string, SchemaEntry> = {
+    const schemasEntries: Record<string, Entry> = {
       rest: {
         description: 'description-1',
         file: 'file-1.json',

diff --git a/packages/ui/src/utils/catalog-schema-loader.ts b/packages/ui/src/utils/catalog-schema-loader.ts
@@ -1,4 +1,5 @@
-import { KaotoSchemaDefinition, SchemaEntry } from '../models';
+import { Entry } from '@kaoto/camel-catalog/types';
+import { KaotoSchemaDefinition } from '../models';
 
 export class CatalogSchemaLoader {
   /** The `.` is required to support relative routes in GitHub pages */
@@ -12,7 +13,7 @@ export class CatalogSchemaLoader {
     return { body, uri: response.url };
   }
 
-  static getSchemasFiles(basePath: string, schemaFiles: Record<string, SchemaEntry>): Promise<KaotoSchemaDefinition>[] {
+  static getSchemasFiles(basePath: string, schemaFiles: Record<string, Entry>): Promise<KaotoSchemaDefinition>[] {
     return Object.entries(schemaFiles).map(async ([name, schemaDef]) => {
       const fetchedSchema = await this.fetchFile(`${basePath}/${schemaDef.file}`);
       const tags = [];