Expose warnings in upsertDocuments API result (#40)

* Expose warnings in upsertDocuments API result * Improve error message * Switch to cortexes API path * Fix up status code expectations
cortexclick · Jul 30, 2024 · a2efb7b · a2efb7b
1 parent 879972e
commit a2efb7b
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 20 deletions.
diff --git a/src/catalog.ts b/src/catalog.ts
@@ -39,6 +39,8 @@ export type DocumentPaginationOpts = {
 
 export type CreateCatalogConfig = CatalogConfig & { catalogName: string };
 
+export type UpsertDocumentsResult = { warnings: string[] };
+
 export class Catalog {
   private deleted = false;
   private constructor(
@@ -49,7 +51,7 @@ export class Catalog {
 
   static async get(apiClient: CortexApiClient, name: string): Promise<Catalog> {
     const res = await apiClient.GET(`/catalogs/${name}`);
-    if (res.status !== 200) {
+    if (res.status > 201) {
       throw new Error(`Failed to get catalog: ${res.statusText}`);
     }
     const body = await res.json();
@@ -77,7 +79,7 @@ export class Catalog {
       res = await apiClient.PUT(`/catalogs/${name}`, config);
     }
 
-    if (res.status !== 200) {
+    if (res.status > 201) {
       throw new Error(`Failed to configure catalog: ${res.statusText}`);
     }
     return new Catalog(config, apiClient, name);
@@ -119,12 +121,14 @@ export class Catalog {
   public async truncate() {
     this.checkDeleted();
     const res = await this.apiClient.POST(`/catalogs/${this.name}/truncate`);
-    if (res.status !== 200) {
+    if (res.status > 201) {
       throw new Error(`Failed to get catalog: ${res.statusText}`);
     }
   }
 
-  public async upsertDocuments(batch: DocumentBatch) {
+  public async upsertDocuments(
+    batch: DocumentBatch,
+  ): Promise<UpsertDocumentsResult> {
     if (batch.length === 0) {
       throw new Error("Document batch must not be empty");
     }
@@ -135,8 +139,9 @@ export class Catalog {
     let hasJson = false;
     let hasUrl = false;
     let hasSitemapUrl = false;
-    for (const doc of batch) {
-      switch (doc.contentType) {
+    for (const [index, doc] of batch.entries()) {
+      const contentType = doc.contentType;
+      switch (contentType) {
         case "markdown":
         case "text":
           hasText = true;
@@ -155,8 +160,7 @@ export class Catalog {
           break;
         default:
           throw new Error(
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            `unsupported content type: ${(doc as any).contentType}`,
+            `Unsupported content type: ${contentType} for document at index ${index}`,
           );
       }
     }
@@ -192,6 +196,10 @@ export class Catalog {
     if (res.status > 202) {
       throw new Error(`Failed to upsert documents: ${res.statusText}`);
     }
+
+    const body = await res.json();
+
+    return { warnings: body?.warnings ?? [] };
   }
 
   async delete() {

diff --git a/src/content.ts b/src/content.ts
@@ -376,7 +376,7 @@ export class Content {
       `/content/${this._id}/version/${version}`,
     );
 
-    if (res.status !== 200) {
+    if (res.status > 201) {
       throw new Error(`Failed to revert content: ${res.statusText}`);
     }
 
@@ -391,7 +391,7 @@ export class Content {
       status,
     });
 
-    if (res.status !== 200) {
+    if (res.status > 201) {
       throw new Error(`Failed to set content status: ${res.statusText}`);
     }
 
@@ -408,7 +408,7 @@ export class Content {
       publishTarget,
     });
 
-    if (res.status !== 200) {
+    if (res.status > 201) {
       throw new Error(`Failed to publish content: ${res.statusText}`);
     }
 
@@ -421,7 +421,7 @@ export class Content {
   async unpublish() {
     const res = await this.apiClient.POST(`/content/${this._id}/unpublish`);
 
-    if (res.status !== 200) {
+    if (res.status > 201) {
       throw new Error(`Failed to unpublish content: ${res.statusText}`);
     }
 

diff --git a/src/cortex.ts b/src/cortex.ts
@@ -111,7 +111,7 @@ export class Cortex {
   ) {}
 
   static async get(apiClient: CortexApiClient, name: string): Promise<Cortex> {
-    const res = await apiClient.GET(`/cortex-config/${name}`);
+    const res = await apiClient.GET(`/cortexes/${name}`);
     if (res.status !== 200) {
       throw new Error(`Failed to get cortex: ${res.statusText}`);
     }
@@ -162,15 +162,15 @@ export class Cortex {
       personality: config.customizations?.personality,
       rules: config.customizations?.rules,
     };
-    const getRes = await apiClient.GET(`/cortex-config/${name}`);
+    const getRes = await apiClient.GET(`/cortexes/${name}`);
     let res: Response;
     if (getRes.status !== 200) {
-      res = await apiClient.POST("/cortex-config", input);
+      res = await apiClient.POST("/cortexes", input);
     } else {
-      res = await apiClient.PUT(`/cortex-config/${name}`, input);
+      res = await apiClient.PUT(`/cortexes/${name}`, input);
     }
 
-    if (res.status !== 200) {
+    if (res.status > 201) {
       throw new Error(`Failed to configure cortex: ${res.statusText}`);
     }
     return new Cortex(config, apiClient, name);
@@ -179,7 +179,7 @@ export class Cortex {
   async delete() {
     this.checkDeleted();
     this.deleted = true;
-    await this.apiClient.DELETE(`/cortex-config/${this.name}`);
+    await this.apiClient.DELETE(`/cortexes/${this.name}`);
     return;
   }
 

diff --git a/src/document.ts b/src/document.ts
@@ -103,7 +103,7 @@ export class Document {
     const res = await this.apiClient.DELETE(
       `/catalogs/${this.catalog.name}/documents/${encodeURIComponent(this.documentId)}`,
     );
-    if (res.status !== 200) {
+    if (res.status > 201) {
       throw new Error(`Failed to delete document: ${res.statusText}`);
     }
   }

diff --git a/src/org.ts b/src/org.ts
@@ -58,7 +58,7 @@ export class OrgConfig {
       res = await client.PUT("/org-config", config);
     }
 
-    if (res.status !== 200) {
+    if (res.status > 201) {
       throw new Error(`Failed to configure org: ${res.statusText}`);
     }