Merge pull request #2 from lastmile-ai/pr2

RFC Cleanup Configuration and naming
lastmile-ai · May 5, 2023 · 010a631 · 010a631
2 parents 0feff7b + bf58f63
commit 010a631
Show file tree

Hide file tree

Showing 128 changed files with 1,007 additions and 1,027 deletions.
diff --git a/README.md b/README.md
@@ -19,13 +19,9 @@ npm install lastmileai
 This library needs to be configured with your API Token (aka API key) obtained above. You can store the API key in an environment variable or alternative secure storage that can be accessed in your server-side code. For example, to initialize the library with the API key loaded from environment variable:
 
 ```javascript
-import { Configuration, LastMileAIApi } from "lastmileai";
+import { LastMile } from "lastmileai";
 
-const configuration = new Configuration({
-    apiKey: process.env.LASTMILEAI_API_KEY ?? "",
-});
-
-const lastmile = new LastMileAIApi(configuration);
+const lastmile = new LastMile({apiKey: process.env.LASTMILEAI_API_KEY ?? ""});
 ```
 
 ## Completions -- Open AI Models

diff --git a/__tests__/embeddings.test.ts b/__tests__/embeddings.test.ts
@@ -1,13 +1,8 @@
 import * as dotenv from 'dotenv'
-import { LastMileAIApi, Visibility } from '../api';
-import { Configuration } from '../configuration';
+import { LastMile, Visibility } from '../api';
 dotenv.config()
 
-const configuration = new Configuration({
-    apiKey: process.env.LASTMILEAI_API_KEY ?? "",
-});
-
-const lastMileAIApi = new LastMileAIApi(configuration);
+const lastMileAIApi = new LastMile({apiKey: process.env.LASTMILEAI_API_KEY ?? ""});
 
 describe('Embeddings API Methods', () => {
     test('createEmbeddingCollection', async () => {

diff --git a/__tests__/helpers.test.ts b/__tests__/helpers.test.ts
@@ -1,13 +1,8 @@
 import * as dotenv from 'dotenv'
-import { LastMileAIApi } from '../api';
-import { Configuration } from '../configuration';
+import { LastMile } from '../api';
 dotenv.config()
 
-const configuration = new Configuration({
-    apiKey: process.env.LASTMILEAI_API_KEY ?? "",
-});
-
-const lastMileAIApi = new LastMileAIApi(configuration);
+const lastMileAIApi = new LastMile({apiKey: process.env.LASTMILEAI_API_KEY ?? ""});
 
 describe('Helper API Methods', () => {
     test('apiHealth', async () => {

diff --git a/__tests__/trials.test.ts b/__tests__/trials.test.ts
@@ -1,13 +1,8 @@
 import * as dotenv from "dotenv";
-import { LastMileAIApi, Visibility } from "../api";
-import { Configuration } from "../configuration";
+import { LastMile } from "../api";
 dotenv.config();
 
-const configuration = new Configuration({
-  apiKey: process.env.LASTMILEAI_API_KEY ?? "",
-});
-
-const lastMileAIApi = new LastMileAIApi(configuration);
+const lastMileAIApi = new LastMile({apiKey: process.env.LASTMILEAI_API_KEY ?? ""});
 
 describe("Trials API Methods", () => {
   test("createTrial", async () => {

diff --git a/api.ts b/api.ts
@@ -7,6 +7,7 @@ import {
 } from "openai";
 import { JSONArray, JSONValue } from "./common";
 import { Configuration } from "./configuration";
+import packageJson = require("./package.json");
 
 /**
  * GENERAL TYPES
@@ -2293,16 +2294,27 @@ export type UpdateWorkspaceResponse = Workspace;
  */
 
 /**
- * LastMileAIApi - API for interfacing with LastMileAI
+ * LastMile - API for interfacing with LastMileAI
  * @export
- * @class LastMileAIApi
+ * @class LastMile
  */
-export class LastMileAIApi {
+export class LastMile {
   protected configuration: Configuration;
   protected defaultHeaders: undefined;
 
   constructor(configuration: Configuration) {
     this.configuration = configuration;
+    if (!this.configuration.defaultAxiosConfig) {
+      this.configuration.defaultAxiosConfig = {
+        baseURL: 'https://lastmileai.dev/api/',
+            headers: {
+                'User-Agent': `LastMileAI/NodeJS/${packageJson.version}`,
+                'Accept': 'application/json',
+                'Content-Type': 'application/json',
+                'Authorization': `Bearer ${this.configuration.apiKey}`,
+            }
+      };
+    }
   }
 
   /**
@@ -2316,10 +2328,10 @@ export class LastMileAIApi {
   public async apiHealth(): Promise<{ status: string }> {
     // Only need the 'User-Agent' header from the default config
     let headers;
-    if (this.configuration.defaultAxiosConfig.headers) {
+    if (this.configuration.defaultAxiosConfig?.headers) {
       headers = {
         "User-Agent":
-          this.configuration.defaultAxiosConfig.headers["User-Agent"],
+          this.configuration.defaultAxiosConfig?.headers["User-Agent"],
       };
     }
     const res = await axios.get("health", {

diff --git a/configuration.ts b/configuration.ts
@@ -1,11 +1,6 @@
 import { AxiosRequestConfig } from "axios";
-import packageJson = require("./package.json");
 
-export interface ConfigurationParameters {
-    apiKey: string;
-}
-
-export class Configuration {
+export type Configuration = {
     /**
      * LastMileAI API Key
      * @memberof Configuration
@@ -16,18 +11,5 @@ export class Configuration {
      * Default config for axios requests
      * @memberof Configuration
      */
-    defaultAxiosConfig: AxiosRequestConfig;
-
-    constructor(param: ConfigurationParameters) {
-        this.apiKey = param.apiKey;
-        this.defaultAxiosConfig = {
-            baseURL: 'https://lastmileai.dev/api/',
-            headers: {
-                'User-Agent': `LastMileAI/NodeJS/${packageJson.version}`,
-                'Accept': 'application/json',
-                'Content-Type': 'application/json',
-                'Authorization': `Bearer ${this.apiKey}`,
-            }
-        };
-    }
-}
+    defaultAxiosConfig?: AxiosRequestConfig;
+}
diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css
@@ -1,14 +1,20 @@
 :root {
-    --light-hl-0: #000000;
-    --dark-hl-0: #D4D4D4;
-    --light-hl-1: #098658;
-    --dark-hl-1: #B5CEA8;
-    --light-hl-2: #795E26;
-    --dark-hl-2: #DCDCAA;
-    --light-hl-3: #001080;
-    --dark-hl-3: #9CDCFE;
-    --light-hl-4: #0000FF;
-    --dark-hl-4: #569CD6;
+    --light-hl-0: #795E26;
+    --dark-hl-0: #DCDCAA;
+    --light-hl-1: #000000;
+    --dark-hl-1: #D4D4D4;
+    --light-hl-2: #A31515;
+    --dark-hl-2: #CE9178;
+    --light-hl-3: #AF00DB;
+    --dark-hl-3: #C586C0;
+    --light-hl-4: #001080;
+    --dark-hl-4: #9CDCFE;
+    --light-hl-5: #0000FF;
+    --dark-hl-5: #569CD6;
+    --light-hl-6: #0070C1;
+    --dark-hl-6: #4FC1FF;
+    --light-hl-7: #098658;
+    --dark-hl-7: #B5CEA8;
     --light-code-background: #FFFFFF;
     --dark-code-background: #1E1E1E;
 }
@@ -19,6 +25,9 @@
     --hl-2: var(--light-hl-2);
     --hl-3: var(--light-hl-3);
     --hl-4: var(--light-hl-4);
+    --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
     --code-background: var(--light-code-background);
 } }
 
@@ -28,6 +37,9 @@
     --hl-2: var(--dark-hl-2);
     --hl-3: var(--dark-hl-3);
     --hl-4: var(--dark-hl-4);
+    --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
     --code-background: var(--dark-code-background);
 } }
 
@@ -37,6 +49,9 @@
     --hl-2: var(--light-hl-2);
     --hl-3: var(--light-hl-3);
     --hl-4: var(--light-hl-4);
+    --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
     --code-background: var(--light-code-background);
 }
 
@@ -46,6 +61,9 @@
     --hl-2: var(--dark-hl-2);
     --hl-3: var(--dark-hl-3);
     --hl-4: var(--dark-hl-4);
+    --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
     --code-background: var(--dark-code-background);
 }
 
@@ -54,4 +72,7 @@
 .hl-2 { color: var(--hl-2); }
 .hl-3 { color: var(--hl-3); }
 .hl-4 { color: var(--hl-4); }
+.hl-5 { color: var(--hl-5); }
+.hl-6 { color: var(--hl-6); }
+.hl-7 { color: var(--hl-7); }
 pre, code { background: var(--code-background); }
diff --git a/docs/assets/search.js b/docs/assets/search.js