refactor

- index to mod
- 処理をcoreに分離

Author: HikaruEgashira

README.md

@@ -1,5 +1,10 @@
 # gpt
 
+OpenAI API made easy !!
+now deno support !
+
+<https://beta.openai.com/docs>
+
 ## install
 
 ```bash
@@ -37,3 +42,9 @@ async function main() {
 }
 main();
 ```
+
+## deno
+
+```ts
+import { openai } from 'https://cdn.skypack.dev/@hikae/gpt?dts'
+```

example/classification.ts

@@ -1,4 +1,4 @@
-import { openai, App } from "../src/fp";
+import { openai, App } from "@hikae/gpt";
 
 export const classification = async (app: App) => {
     const result = await openai.classification({

example/completion.ts

@@ -1,5 +1,4 @@
-import { App, openai } from "../src/index";
-import { CompletionOpts } from "../src/types/index";
+import { App, openai, CompletionOpts } from "@hikae/gpt";
 
 export const completion = async (app: App) => {
     const completionOpts: CompletionOpts = {

deno/.vscode/settings.json example/deno/.vscode/settings.json

@@ -1,4 +1,5 @@
 import { App, openai } from "https://cdn.skypack.dev/@hikae/gpt?dts";
+import "https://deno.land/x/dotenv/load.ts";
 
 const key = Deno.env.get("OPENAI_API_KEY");
 if (!key) {
@@ -18,5 +19,5 @@ const result = await openai.classification({
     model: "ada",
 })(app);
 
-console.log(result.selected_examples);
+console.log(result.label);
 // result = 'Positive'

deno/main.ts example/deno/main.ts

@@ -1,4 +1,4 @@
-import { App, openai } from "../src/index";
+import { App, openai } from "@hikae/gpt";
 
 export const engine = async (app: App) => {
     const result = await openai.engine()(app);

example/engine.ts

@@ -1,4 +1,4 @@
-import { openai } from "../src/index";
+import { openai } from "@hikae/gpt";
 import { classification } from "./classification";
 import { completion } from "./completion";
 import { engine } from "./engine";

example/main.ts

@@ -1,5 +1,4 @@
-import { App, openai } from "../src/index";
-import { SearchOpts } from "../src/types/index";
+import { App, openai, SearchOpts } from "@hikae/gpt";
 
 export const search = async (app: App) => {
     const searchOpts: SearchOpts = {

example/search.ts

@@ -2,7 +2,8 @@
     "scripts": {
         "test": "jest",
         "dev": "esmo example/main.ts",
-        "build": "rimraf dist && tsup src/index.ts --dts --format cjs,esm",
+        "dev:deno": "deno run --unstable -A example/deno/main.ts",
+        "build": "rimraf dist && tsup src/mod.ts --dts --format cjs,esm",
         "package-check": "npx @skypack/package-check"
     },
     "dependencies": {
@@ -23,18 +24,18 @@
         "typescript": "^4.4.2"
     },
     "name": "@hikae/gpt",
-    "version": "0.0.9",
+    "version": "0.0.10",
     "description": "A framework to build OpenAPI apps using nodejs",
     "keywords": [
         "gpt3"
     ],
-    "main": "dist/index.js",
-    "module": "dist/index.mjs",
-    "types": "dist/index.d.ts",
+    "main": "dist/mod.js",
+    "module": "dist/mod.mjs",
+    "types": "dist/mod.d.ts",
     "exports": {
-        "require": "./dist/index.js",
-        "import": "./dist/index.mjs",
-        "default": "./dist/index.mjs"
+        "require": "./dist/mod.js",
+        "import": "./dist/mod.mjs",
+        "default": "./dist/mod.mjs"
     },
     "files": [
         "dist"

package.json

@@ -6,7 +6,7 @@ import {
     engineListURL,
     engineURL,
     searchURL,
-} from "./lib/index";
+} from "./lib/mod";
 import {
     Completion,
     CompletionOpts,
@@ -16,7 +16,14 @@ import {
     ListEngine,
     Search,
     SearchOpts,
-} from "./types";
+} from "./types/mod";
+import {
+    classification,
+    completion,
+    engine,
+    listEngines,
+    search,
+} from "./core/mod";
 import { Options } from "ky";
 
 /** App initialization options */
@@ -54,11 +61,7 @@ export class App {
      * @link https://beta.openai.com/docs/guides/completion/completion
      */
     async completion(opts: CompletionOpts) {
-        const url = completionURL(this.engineId);
-        const options: Options = {
-            json: opts,
-        };
-        return await this.api.post(url, options).json<Completion>();
+        return completion(opts)({ api: this.api, engineId: this.engineId });
     }
 
     // search
@@ -68,11 +71,7 @@ export class App {
      * @link https://beta.openai.com/docs/guides/search/search
      */
     async search(opts: SearchOpts) {
-        const url = searchURL(this.engineId);
-        const options: Options = {
-            json: opts,
-        };
-        return await this.api.post(url, options).json<Search>();
+        return search(opts)({ api: this.api, engineId: this.engineId });
     }
 
     // Classification
@@ -82,11 +81,7 @@ export class App {
      * @link https://beta.openai.com/docs/api-reference/classifications/create
      */
     async classification(opts: ClassificationOpts) {
-        const url = classificationsURL();
-        const options: Options = {
-            json: opts,
-        };
-        return await this.api.post(url, options).json<Classification>();
+        return classification(opts)({ api: this.api, engineId: this.engineId });
     }
 
     // Engines
@@ -96,16 +91,14 @@ export class App {
      * @link https://beta.openai.com/docs/api-reference/engines/list
      */
     async listEngines() {
-        const url = engineListURL();
-        return await this.api.get(url).json<ListEngine>();
+        return listEngines()({ api: this.api, engineId: this.engineId });
     }
 
     /**
      * Retrieve engine OR get current engine
      * @link https://beta.openai.com/docs/api-reference/engines/retrieve
      */
     async engine(engineId?: string) {
-        const url = engineURL(engineId ?? this.engineId);
-        return await this.api.get(url).json<Engine>();
+        return engine()({ api: this.api, engineId: engineId ?? this.engineId });
     }
 }

src/class.ts

@@ -0,0 +1,18 @@
+import { ClassificationOpts, App, Classification } from "dist";
+import { Options } from "ky";
+import { classificationsURL } from "~/lib/mod";
+
+/**
+ * Create Classification
+ * @link https://beta.openai.com/docs/api-reference/classifications/create
+ */
+export const classification =
+    (opts: ClassificationOpts) =>
+    async ({ api }: App) => {
+        const url = classificationsURL();
+        const options: Options = {
+            json: opts,
+        };
+        const res = await api.post(url, options).json<Classification>();
+        return res;
+    };

src/core/classification.ts

@@ -0,0 +1,18 @@
+import { CompletionOpts, App, Completion } from "dist";
+import { Options } from "ky";
+import { completionURL } from "~/lib/mod";
+
+/**
+ * Completion
+ * @link https://beta.openai.com/docs/guides/completion/completion
+ */
+export const completion =
+    (opts: CompletionOpts) =>
+    async ({ api, engineId }: App) => {
+        const url = completionURL(engineId);
+        const options: Options = {
+            json: opts,
+        };
+        const data = await api.post(url, options).json<Completion>();
+        return data;
+    };

src/core/completion.ts

@@ -0,0 +1,26 @@
+import { App, ListEngine, Engine } from "~/mod";
+import { engineListURL, engineURL } from "~/lib/mod";
+
+/**
+ * List engines
+ * @link https://beta.openai.com/docs/api-reference/engines/list
+ */
+export const listEngines =
+    () =>
+    async ({ api }: App) => {
+        const url = engineListURL();
+        const res = await api.get(url).json<ListEngine>();
+        return res;
+    };
+
+/**
+ * Retrieve engine
+ * @link https://beta.openai.com/docs/api-reference/engines/retrieve
+ */
+export const engine =
+    () =>
+    async ({ api, engineId }: App) => {
+        const url = engineURL(engineId);
+        const res = api.get(url).json<Engine>();
+        return res;
+    };

src/core/engine.ts

@@ -0,0 +1,4 @@
+export * from "./classification";
+export * from "./completion";
+export * from "./engine";
+export * from "./search";

src/core/mod.ts

@@ -0,0 +1,18 @@
+import { SearchOpts, App, Search } from "dist";
+import { Options } from "ky";
+import { searchURL } from "~/lib/mod";
+
+/**
+ * Search
+ * @link https://beta.openai.com/docs/guides/search/search
+ */
+export const search =
+    (opts: SearchOpts) =>
+    async ({ api, engineId }: App) => {
+        const url = searchURL(engineId);
+        const options: Options = {
+            json: opts,
+        };
+        const res = await api.post(url, options).json<Search>();
+        return res;
+    };

src/core/search.ts

@@ -1,23 +1,11 @@
+import { createApi, DEFAULT_ENGINE } from "./lib/mod";
 import {
-    createApi,
-    classificationsURL,
-    completionURL,
-    DEFAULT_ENGINE,
-    engineListURL,
-    engineURL,
-    searchURL,
-} from "./lib/index";
-import {
-    Completion,
-    CompletionOpts,
-    Classification,
-    ClassificationOpts,
-    Engine,
-    ListEngine,
-    Search,
-    SearchOpts,
-} from "./types/index";
-import { Options } from "ky";
+    classification,
+    completion,
+    engine,
+    listEngines,
+    search,
+} from "./core/mod";
 
 /**
  * A OpenAPI App
@@ -31,75 +19,6 @@ const app = (apiKey: string, engineId = DEFAULT_ENGINE): App => ({
     engineId,
 });
 
-/**
- * Completion
- * @link https://beta.openai.com/docs/guides/completion/completion
- */
-const completion =
-    (opts: CompletionOpts) =>
-    async ({ api, engineId }: App) => {
-        const url = completionURL(engineId);
-        const options: Options = {
-            json: opts,
-        };
-        const data = await api.post(url, options).json<Completion>();
-        return data;
-    };
-
-/**
- * Search
- * @link https://beta.openai.com/docs/guides/search/search
- */
-const search =
-    (opts: SearchOpts) =>
-    async ({ api, engineId }: App) => {
-        const url = searchURL(engineId);
-        const options: Options = {
-            json: opts,
-        };
-        const res = await api.post(url, options).json<Search>();
-        return res;
-    };
-
-/**
- * Create Classification
- * @link https://beta.openai.com/docs/api-reference/classifications/create
- */
-const classification =
-    (opts: ClassificationOpts) =>
-    async ({ api }: App) => {
-        const url = classificationsURL();
-        const options: Options = {
-            json: opts,
-        };
-        const res = await api.post(url, options).json<Classification>();
-        return res;
-    };
-
-/**
- * List engines
- * @link https://beta.openai.com/docs/api-reference/engines/list
- */
-const listEngines =
-    () =>
-    async ({ api }: App) => {
-        const url = engineListURL();
-        const res = await api.get(url).json<ListEngine>();
-        return res;
-    };
-
-/**
- * Retrieve engine
- * @link https://beta.openai.com/docs/api-reference/engines/retrieve
- */
-const engine =
-    () =>
-    async ({ api, engineId }: App) => {
-        const url = engineURL(engineId);
-        const res = api.get(url).json<Engine>();
-        return res;
-    };
-
 export const openai = {
     app,
     completion,