Merge pull request #5 from cortexclick/jeremy/lint

Use the same eslint config as API

.eslintignore

@@ -0,0 +1,2 @@
+node_modules
+**/*.js

.eslintrc

@@ -0,0 +1,27 @@
+{
+    "root": true,
+    "parser": "@typescript-eslint/parser",
+    "plugins": [
+        "@typescript-eslint"
+    ],
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/eslint-recommended",
+        "plugin:@typescript-eslint/recommended",
+        "prettier"
+    ],
+    "rules": {
+        "@typescript-eslint/no-unused-vars": [
+            "error",
+            {
+                "args": "all",
+                "argsIgnorePattern": "^_",
+                "caughtErrors": "all",
+                "caughtErrorsIgnorePattern": "^_",
+                "destructuredArrayIgnorePattern": "^_",
+                "varsIgnorePattern": "^_",
+                "ignoreRestSiblings": true
+            }
+        ]
+    }
+}

.github/workflows/ci.yml

@@ -19,8 +19,8 @@ jobs:
       - name: Set up Node
         uses: actions/setup-node@v4
         with:
-          node-version: '20'
-          cache: 'npm'
+          node-version: "20"
+          cache: "npm"
 
       - name: Install dependencies
         run: npm install
@@ -38,11 +38,11 @@ jobs:
       - name: Set up Node
         uses: actions/setup-node@v4
         with:
-          node-version: '20'
-          cache: 'npm'
+          node-version: "20"
+          cache: "npm"
 
       - name: Install dependencies
         run: npm install
 
       - name: Build
-        run: npm run build
+        run: npm run build

.prettierignore

@@ -0,0 +1 @@
+node_modules

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["esbenp.prettier-vscode"]
+}

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  }
+}

README.md

@@ -25,4 +25,4 @@ This repo uses `vitest` to run tests. There is a pulumi environment called `npm-
 
 ```console
 $ pulumi env run npm-test npm run test
-```
+```

api-client.ts

@@ -3,45 +3,47 @@ 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) { }
-
-    async POST(path: string, body?: any) {
-        return this.makeRequest("POST", path, body);
-    }
-
-    async PUT(path: string, body?: any) {
-        return this.makeRequest("PUT", path, body);
-    }
-
-    async GET(path: string, body?: any) {
-        return this.makeRequest("GET", path, body);
-    }
-
-    async DELETE(path: string, body?: any) {
-        return this.makeRequest("DELETE", path, body);
-    }
-
-    async POSTForm(path: string, form: FormData) {
-        return fetch(`${this.apiUrl}/org/${this.org}${path}`, {
-            method: "POST",
-            headers: {
-                "Authorization": `Bearer ${this.accessToken}`
-            },
-            body: form,
-        })
-    }
-
-    private async makeRequest(method: Method, path: string, body?: any) {
-        return fetch(`${this.apiUrl}/org/${this.org}${path}`, {
-            method,
-            headers: {
-                "Authorization": `Bearer ${this.accessToken}`,
-                'Content-Type': 'application/json'
-            },
-            body: body ? JSON.stringify(body) : undefined,
-        })
-    }
-
-}
+  constructor(
+    private org: string,
+    private apiUrl: string,
+    private accessToken: string,
+  ) {}
+
+  async POST(path: string, body?: any) {
+    return this.makeRequest("POST", path, body);
+  }
+
+  async PUT(path: string, body?: any) {
+    return this.makeRequest("PUT", path, body);
+  }
+
+  async GET(path: string, body?: any) {
+    return this.makeRequest("GET", path, body);
+  }
+
+  async DELETE(path: string, body?: any) {
+    return this.makeRequest("DELETE", path, body);
+  }
+
+  async POSTForm(path: string, form: FormData) {
+    return fetch(`${this.apiUrl}/org/${this.org}${path}`, {
+      method: "POST",
+      headers: {
+        Authorization: `Bearer ${this.accessToken}`,
+      },
+      body: form,
+    });
+  }
+
+  private async makeRequest(method: Method, path: string, body?: any) {
+    return fetch(`${this.apiUrl}/org/${this.org}${path}`, {
+      method,
+      headers: {
+        Authorization: `Bearer ${this.accessToken}`,
+        "Content-Type": "application/json",
+      },
+      body: body ? JSON.stringify(body) : undefined,
+    });
+  }
+}

catalog.test.ts

@@ -1,4 +1,4 @@
-import { expect, test, afterEach } from 'vitest'
+import { expect, test, afterEach } from "vitest";
 import { CortexClient } from "./index";
 import { Catalog, CatalogConfig } from "./catalog";
 
@@ -15,15 +15,13 @@ afterEach(async () => {
     if (catalog) {
       await catalog.delete();
     }
-  }
-  catch {
-    // probably catalog has already been deleted by a test, so ignore 
+  } catch {
+    // probably catalog has already been deleted by a test, so ignore
   }
 });
 
-test('Catalog CRUD', async () => {
-
-  const catalogName = `catalog-${Math.floor(Math.random() * 10000)}`
+test("Catalog CRUD", async () => {
+  const catalogName = `catalog-${Math.floor(Math.random() * 10000)}`;
 
   const config: CatalogConfig = {
     description: "foo bar",
@@ -39,8 +37,8 @@ test('Catalog CRUD', async () => {
   expect(catalog.config.description).toBe(config.description);
 
   // update
-  config.description = "buzz 123"
-  config.instructions = ["1", "2", "3"]
+  config.description = "buzz 123";
+  config.instructions = ["1", "2", "3"];
   catalog = await client.configureCatalog(catalogName, config);
 
   catalog = await client.getCatalog(catalogName);
@@ -54,16 +52,20 @@ test('Catalog CRUD', async () => {
 
   // list
   const catalogList = await client.listCatalogs();
-  const catalogFromList = catalogList.find(c => c.name === catalogName);
+  const catalogFromList = catalogList.find((c) => c.name === catalogName);
   expect(catalogFromList).toBeDefined();
   expect(catalogFromList?.documentCount).toBe(0);
   expect(catalogFromList?.description).toBe(config.description);
   // get catalog from list result
   const getCatalogFromList = await catalogFromList?.Catalog();
-  expect(getCatalogFromList?.config.instructions).toStrictEqual(config.instructions);
+  expect(getCatalogFromList?.config.instructions).toStrictEqual(
+    config.instructions,
+  );
 
-  // delete 
+  // delete
   await catalog.delete();
   // assert that the get fails
-  await expect(async () => { await client.getCatalog(catalogName) }).rejects.toThrowError("Failed to get catalog: Not Found");
+  await expect(async () => {
+    await client.getCatalog(catalogName);
+  }).rejects.toThrowError("Failed to get catalog: Not Found");
 });