fix(catalog): fix mandatory fields in interfaces

coveo · Sep 23, 2019 · 8bd363d · 8bd363d
1 parent 1a00187
commit 8bd363d
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 9 deletions.
diff --git a/src/resources/Catalogs/Catalog.ts b/src/resources/Catalogs/Catalog.ts
@@ -1,6 +1,6 @@
 import API from '../../APICore';
 import {PageModel} from '../BaseInterfaces';
-import {CatalogModel, CatalogsListOptions} from './Interfaces';
+import {CatalogModel, CatalogsListOptions, NewCatalogModel} from './Interfaces';
 
 export default class Catalog {
     static baseUrl = `/rest/organizations/${API.orgPlaceholder}/catalogs`;
@@ -11,7 +11,7 @@ export default class Catalog {
         return this.api.get<PageModel<CatalogModel>>(Catalog.baseUrl, options);
     }
 
-    create(catalog: CatalogModel) {
+    create(catalog: NewCatalogModel) {
         return this.api.post<CatalogModel>(Catalog.baseUrl, catalog);
     }
 

diff --git a/src/resources/Catalogs/Interfaces.ts b/src/resources/Catalogs/Interfaces.ts
@@ -4,23 +4,25 @@ export interface CatalogsListOptions {
 }
 
 export interface CatalogModel {
+    id: string;
+    name: string;
+    product: ProductHierarchyModel;
     availability?: AvailabilityHierarchyModel;
     description?: string;
-    id?: string;
-    name?: string;
-    product?: ProductHierarchyModel;
     variant?: VariantHierarchyModel;
 }
 
+export type NewCatalogModel = Omit<CatalogModel, 'id'>;
+
 export interface VariantHierarchyModel {
     fields: string[];
     idField: string;
     objectType: string;
 }
 
 export interface ProductHierarchyModel {
-    idField?: string;
-    objectType?: string;
+    idField: string;
+    objectType: string;
 }
 
 export interface AvailabilityHierarchyModel {

diff --git a/src/resources/Catalogs/tests/Catalog.spec.ts b/src/resources/Catalogs/tests/Catalog.spec.ts
@@ -1,6 +1,6 @@
 import API from '../../../APICore';
 import Catalog from '../Catalog';
-import {CatalogModel, CatalogsListOptions} from '../Interfaces';
+import {CatalogModel, CatalogsListOptions, NewCatalogModel} from '../Interfaces';
 
 jest.mock('../../../APICore');
 
@@ -29,8 +29,12 @@ describe('Catalog', () => {
 
     describe('create', () => {
         it('should make a POST call to the catalogs base url', () => {
-            const catalogModel: CatalogModel = {
+            const catalogModel: NewCatalogModel = {
                 name: 'New catalog',
+                product: {
+                    idField: '@uri',
+                    objectType: 'product',
+                },
             };
 
             catalog.create(catalogModel);
@@ -62,6 +66,10 @@ describe('Catalog', () => {
             const catalogModel: CatalogModel = {
                 id: 'catalog-to-update-id',
                 name: 'Catalog to be updated',
+                product: {
+                    idField: '@uri',
+                    objectType: 'product',
+                },
             };
 
             catalog.update(catalogModel);