fix: add interface for catalogContent

[CIUG-791]
coveo · Mar 19, 2024 · ea03e8f · ea03e8f
1 parent bdc96cf
commit ea03e8f
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 3 deletions.
diff --git a/src/resources/Catalogs/CatalogContent.ts b/src/resources/Catalogs/CatalogContent.ts
@@ -1,5 +1,6 @@
 import API from '../../APICore.js';
 import Resource from '../Resource.js';
+import {CatalogMetadata, CatalogMetadataName} from './CatalogInterfaces.js';
 
 export type ObjectType = {
     objectType: string;
@@ -9,14 +10,18 @@ export default class CatalogContent extends Resource {
     static baseUrl = `/rest/organizations/${API.orgPlaceholder}/catalogcontent/source`;
 
     getObjectTypes(sourceId: string) {
-        return this.api.get(`${CatalogContent.baseUrl}/${sourceId}/objecttypes`);
+        return this.api.get<string[]>(`${CatalogContent.baseUrl}/${sourceId}/objecttypes`);
     }
 
     getMetadataValues(sourceId: string, objectType: ObjectType) {
-        return this.api.get(this.buildPath(`${CatalogContent.baseUrl}/${sourceId}/metadatavalues`, objectType));
+        return this.api.get<CatalogMetadata>(
+            this.buildPath(`${CatalogContent.baseUrl}/${sourceId}/metadatavalues`, objectType),
+        );
     }
 
     getMetadata(sourceId: string, objectType: ObjectType) {
-        return this.api.get(this.buildPath(`${CatalogContent.baseUrl}/${sourceId}/metadata`, objectType));
+        return this.api.get<CatalogMetadataName>(
+            this.buildPath(`${CatalogContent.baseUrl}/${sourceId}/metadata`, objectType),
+        );
     }
 }
diff --git a/src/resources/Catalogs/CatalogInterfaces.ts b/src/resources/Catalogs/CatalogInterfaces.ts
@@ -426,3 +426,19 @@ export interface CatalogFieldStatsOptions {
      */
     forceRefresh?: boolean;
 }
+
+export interface CatalogMetadata {
+    /**
+     * Metadata seen on catalog documents with a sample of values.
+     */
+    metadataValuesByName: {
+        [name: string]: string[];
+    };
+}
+
+export interface CatalogMetadataName {
+    /**
+     * Metadata name seen on catalog documents.
+     */
+    metadataNames: string[];
+}