add build and lint workflow in CI, fix lint errors

.github/workflows/ci.yml

@@ -0,0 +1,43 @@
+name: CI
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint:
+    name: lint
+    runs-on: ubuntu-latest
+    if: github.repository == 'cortexclick/cortex-sdk'
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Check types
+        run: npm run lint
+  build:
+    name: build
+    runs-on: ubuntu-latest
+    if: github.repository == 'cortexclick/cortex-sdk'
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - name: Build
+        run: npm run build

.gitignore

@@ -1 +1,4 @@
-*.js
+*.js
+node_modules
+
+!eslint.config.js

api-client.ts

@@ -1,5 +1,9 @@
 type Method = "POST" | "GET" | "PUT" | "DELETE";
 
+// body can be any object
+/* eslint-disable  @typescript-eslint/no-explicit-any */
+
+
 export class CortexApiClient {
     constructor(private org: string, private apiUrl: string, private accessToken: string) { }
 

catalog.test.ts

@@ -1,4 +1,4 @@
-import { expect, test, beforeEach, afterEach } from 'vitest'
+import { expect, test, afterEach } from 'vitest'
 import { CortexClient } from "./index";
 import { Catalog, CatalogConfig } from "./catalog";
 

catalog.ts

@@ -75,7 +75,7 @@ export class Catalog {
             throw new Error(`Failed to list catalog: ${res.statusText}`);
         }
         const body = await res.json();
-        for(let catalog of body.catalogs) {
+        for(const catalog of body.catalogs) {
             result.push({
                 name: catalog.name,
                 description: catalog.description,
@@ -111,7 +111,7 @@ export class Catalog {
         let hasText = false;
         let hasFile = false;
         let hasJson = false; 
-        for(let doc of batch) {
+        for(const doc of batch) {
             switch(doc.contentType) {
                 case "markdown":
                 case "text":
@@ -124,6 +124,7 @@ export class Catalog {
                     hasFile = true;
                     break;
                 default:
+                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
                     throw new Error(`unsupported content type: ${(doc as any).contentType}`);
             }
         }
@@ -172,7 +173,7 @@ export class Catalog {
     }
 
     async listDocuments(paginationOpts?: DocumentPaginationOpts): Promise<DocumentListResult> {
-        let { page, pageSize } = paginationOpts || { page: 1, pageSize: 50};
+        const { page, pageSize } = paginationOpts || { page: 1, pageSize: 50};
         const nextPageOpts: DocumentPaginationOpts = { page: page+1, pageSize };
         const nextPage = () => {
             return this.listDocuments(nextPageOpts);
@@ -192,6 +193,7 @@ export class Catalog {
         };
     }
 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     jsonIndexer(documents: any[], opts?: JSONIndexerOpts) {
         return new JSONIndexer(this, documents, opts);
     }
@@ -218,9 +220,8 @@ export class Catalog {
 const mapBatch = async (batch: DocumentBatch) => {
     const blobs: Promise<Blob>[] = [];
     const documents: DocumentInput[] = [];
-    let isFileUpload = false;
 
-    for(let doc of batch) {
+    for(const doc of batch) {
         switch(doc.contentType) {
             case "markdown":
             case "text":
@@ -235,14 +236,14 @@ const mapBatch = async (batch: DocumentBatch) => {
                 });
                 break;
             case "file":
-                isFileUpload = true;
                 blobs.push(fs.openAsBlob(doc.filePath));
                 documents.push({
                     ...doc,
                     content: undefined,
                 });
                 break;
             default:
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
                 throw new Error(`unsupported content type: ${(doc as any).contentType}`);
         }
     }

chat.test.ts

@@ -1,6 +1,6 @@
 import { expect, test } from 'vitest'
 import { CortexClient, TextDocument } from "./index";
-import { Catalog, CatalogConfig } from "./catalog";
+import { CatalogConfig } from "./catalog";
 import { Readable } from "stream";
 
 const client = new CortexClient({
@@ -27,7 +27,7 @@ test('e2e catalog, cortex, and sync chat', { timeout: 60000 }, async () => {
   };
 
   // create
-  let catalog = await client.configureCatalog(catalogName, config);
+  const catalog = await client.configureCatalog(catalogName, config);
 
   const documents: TextDocument[] = [
     {
@@ -64,10 +64,10 @@ test('e2e catalog, cortex, and sync chat', { timeout: 60000 }, async () => {
 
   // get chat
   const getChatRes = await client.getChat(chat.id);
-  expect(chat.messages.length).toBe(2);
-  expect(chat.title).toBe(chatInput)
+  expect(getChatRes.messages.length).toBe(2);
+  expect(getChatRes.title).toBe(chatInput)
 
-  const response = await chat.respond({ message: "what about customer verticals" });
+  await chat.respond({ message: "what about customer verticals" });
   expect(chat.messages.length).toBe(4);
 
 
@@ -95,7 +95,7 @@ test('streaming chat', { timeout: 60000 }, async () => {
   };
 
   // create
-  let catalog = await client.configureCatalog(catalogName, config);
+  const catalog = await client.configureCatalog(catalogName, config);
 
   const documents: TextDocument[] = [
     {

chat.ts

@@ -44,8 +44,6 @@ export type Message = {
     message: string;
 };
 
-export type ListChatsResult = {};
-
 export class Chat {
     private constructor(private apiClient: CortexApiClient, readonly id: string, readonly title: string, readonly messages: Message[]) {
     }
@@ -116,10 +114,6 @@ export class Chat {
         return new Chat(client, id, body.title, body.messages);
     }
 
-    static async list(): Promise<ListChatsResult[]> {
-        return [];
-    }
-
     async respond(opts: RespondChatOptsSync): Promise<string>;
     async respond(opts: RespondChatOptsStreaming): Promise<StreamingChatResult>;
     async respond(opts: RespondChatOptsSync | RespondChatOptsStreaming): Promise<string | StreamingChatResult> {

content.test.ts

@@ -27,7 +27,7 @@ test('e2e catalog, cortex, and sync content generation workflow', {timeout: 1200
   };
 
   // create
-  let catalog = await client.configureCatalog(catalogName, config);
+  const catalog = await client.configureCatalog(catalogName, config);
 
   const documents: TextDocument[] = [
     {
@@ -124,7 +124,7 @@ test('test streaming content', {timeout: 120000}, async () => {
   };
 
   // create
-  let catalog = await client.configureCatalog(catalogName, config);
+  const catalog = await client.configureCatalog(catalogName, config);
 
   const documents: TextDocument[] = [
     {

content.ts

@@ -85,8 +85,6 @@ export class Content {
     static async create(opts: CreateContentOptsSync): Promise<Content>;
     static async create(opts: CreateContentOptsStreaming): Promise<StreamingContentResult>;
     static async create(opts: CreateContentOptsSync | CreateContentOptsStreaming): Promise<Content | StreamingContentResult> {
-        const { client, cortex, title, prompt, stream} = opts;
-
         // note: this if statement is annoying but is necessary to appropriately narrow the return type
         if(isCreateContentOptsSync(opts)) {
             return this.createContentSync(opts);
@@ -187,7 +185,6 @@ export class Content {
         const reader = res.body!.getReader();
         const decoder = new TextDecoder('utf-8');
 
-        const id: string = res.headers.get("id") || "";
         const version: number = parseInt(res.headers.get("version") || "0");
         const commands: ContentCommand[] = JSON.parse(res.headers.get("commands") || "[]");
         this._version = version;

cortex.test.ts

@@ -17,7 +17,7 @@ test('can get and set OrgConfig', async () => {
     rules: ["never say anything disparaging about AI or LLMs", "do not offer discounts"],
   }
 
-  const orgConfig = await client.configureOrg(orgConfigOpts);
+  await client.configureOrg(orgConfigOpts);
 
   const getOrgConfig = await client.getOrgConfig();
   expect(getOrgConfig.companyName).toBe(orgConfigOpts.companyName)

document.test.ts

@@ -1,6 +1,6 @@
 import { expect, test } from 'vitest'
 import { CortexClient } from "./index";
-import { Catalog, CatalogConfig } from "./catalog";
+import { CatalogConfig } from "./catalog";
 import { FileDocument, JSONDocument, TextDocument } from './document';
 
 const client = new CortexClient({
@@ -19,7 +19,7 @@ test('Test upsertDocuments inline text batch', async () => {
     instructions: ["a", "b"],
   };
 
-  let catalog = await client.configureCatalog(catalogName, config);
+  const catalog = await client.configureCatalog(catalogName, config);
 
   const docs: TextDocument[] = [
     {
@@ -55,7 +55,7 @@ test('Test upsertDocuments inline JSON batch', async () => {
     instructions: ["a", "b"],
   };
 
-  let catalog = await client.configureCatalog(catalogName, config);
+  const catalog = await client.configureCatalog(catalogName, config);
 
   const docs: JSONDocument[] = [
     {
@@ -97,7 +97,7 @@ test('Test upsertDocuments with files and catalog.truncate', { timeout: 20000 },
     instructions: ["a", "b"],
   };
 
-  let catalog = await client.configureCatalog(catalogName, config);
+  const catalog = await client.configureCatalog(catalogName, config);
 
   const docs: FileDocument[] = [
     {
@@ -138,7 +138,7 @@ test('Test update documents', {timeout: 10000}, async () => {
     instructions: ["a", "b"],
   };
 
-  let catalog = await client.configureCatalog(catalogName, config);
+  const catalog = await client.configureCatalog(catalogName, config);
 
   const docs: TextDocument[] = [
     {
@@ -185,7 +185,7 @@ test('Test get and delete documents', {timeout: 10000}, async () => {
     instructions: ["a", "b"],
   };
 
-  let catalog = await client.configureCatalog(catalogName, config);
+  const catalog = await client.configureCatalog(catalogName, config);
 
   const docs: TextDocument[] = [
     {
@@ -234,7 +234,7 @@ test('Test catalog.listDocuments', { timeout: 10000 } ,async () => {
     instructions: ["a", "b"],
   };
 
-  let catalog = await client.configureCatalog(catalogName, config);
+  const catalog = await client.configureCatalog(catalogName, config);
 
   const docs: JSONDocument[] = [
   ];

eslint.config.js

@@ -0,0 +1,14 @@
+import globals from "globals";
+import pluginJs from "@eslint/js";
+import tseslint from "typescript-eslint";
+
+
+export default [
+  {files: ["**/*.{ts}"]},
+  {languageOptions: { globals: globals.node }},
+  ...tseslint.configs.recommended,
+  { rules: {
+    "@typescript-eslint/no-unused-vars": 0
+  }},
+{ignores: ["**/*.js"]}
+];

indexers/directory-indexer.ts

@@ -2,8 +2,6 @@ import * as fs from 'node:fs';
 import { Catalog } from "../catalog.js";
 import { FileDocument } from '../document.js';
 
-const apiUrl = process.env.HOST === "prod" ? "https://api.cortexclick.com" : "http://localhost:3001"
-
 export type DirectoryIndexerOpts = {
     rootDir: string;
     urlBase?: string;
@@ -15,7 +13,6 @@ export type DirectoryIndexerOpts = {
 }
 
 export class DirectoryIndexer {
-    private outstandingRequests: Promise<any>[] = [];
     private parallelism = 25;
     private rootDir: string;
     private urlBase?: string;
@@ -55,9 +52,9 @@ export class DirectoryIndexer {
     }
 
     private async processDirectory(docPathList: string[], sitePathList: string[]) {
-        let fileList = fs.readdirSync(docPathList.join("/"));
+        const fileList = fs.readdirSync(docPathList.join("/"));
 
-        for (let f of fileList) {
+        for (const f of fileList) {
             const path = [...docPathList, f].join("/")
             const stat = fs.lstatSync(path)
             if (stat.isDirectory() && this.includeDirectory(f)) {

indexers/indexers.test.ts

@@ -1,7 +1,7 @@
 import { expect, test, beforeEach, afterEach } from 'vitest'
 import { CortexClient } from "../index";
 import { Catalog, CatalogConfig } from "../catalog";
-import { FileDocument, JSONDocument, TextDocument } from '../document';
+import { JSONDocument } from '../document';
 
 const client = new CortexClient({
   accessToken: process.env.CORTEX_ACCESS_TOKEN || "",
@@ -17,7 +17,7 @@ beforeEach(async () => {
     instructions: ["a", "b"],
   };
 
-  let catalogName = `catalog-${Math.floor(Math.random() * 10000)}`;
+  const catalogName = `catalog-${Math.floor(Math.random() * 10000)}`;
   catalog = await client.configureCatalog(catalogName, config);
 });