@jpoly1219/context-extractor 0.1.1 → 0.2.0

package/README.md

@@ -2,7 +2,9 @@
 
 Extract relevant context from a codebase using a type-directed approach.
 
-## npm Installation
+## Installation
+
+### npm
 
 Recommended.
 
@@ -10,7 +12,7 @@ Recommended.
 npm i @jpoly1219/context-extractor
 ```
 
-## Manual Installation
+### Manual
 
 Not recommended. If the above steps do not work, please leave a GitHub issue.
 
@@ -68,7 +70,7 @@ dune build
 
 Ignore the wildcard build errors. The command is meant to setup the modules and imports.
 
-Almost there! Create a `credentials.json` file following the steps at the **credentials.json** section below in the README.
+Almost there! Create a `config.json` file following the steps at the **config.json** section below in the README.
 
 Finally, build and run.
 
@@ -84,29 +86,50 @@ node dist/runner.js
 1. Determine the type of the hole.
 2. Extract relevant types.
 3. Extract relevant headers.
+4. Optionally complete the hole with an LLM.
 
-This library exposes the API `extractWithNew`, which has the following definition:
+This library exposes two methods `extractContext` and `completeWithLLM`, which have the following definitions:
 
 ```ts
-const extractWithNew = async (
+const extractContext = async (
+  language: Language,
+  sketchPath: string,
+  repoPath: string,
+): Promise<Context | null>;
+
+const completeWithLLM = async (
+  ctx: Context,
   language: Language,
   sketchPath: string,
-  credentialsPath: string
-) => {};
+  configPath: string
+): Promise<string>;
 
 enum Language {
   TypeScript,
-  OCaml,
+  OCaml
+}
+
+interface Context {
+  holeType: string,
+  relevantTypes: Map<Filepath, RelevantType[]>,
+  relevantHeaders: Map<Filepath, RelevantHeader[]>
 }
+
+type Filepath = string;
+type RelevantType = string;
+type RelevantHeader = string;
 ```
 
-`sketchPath` is the full path to your `sketch.ts` or `sketch.ml` file.
-`credentialsPath` is the full path to your `credentials.json`.
+- `sketchPath` is the full path to your sketch file with the typed hole construct (`_()` for TypeScript, `_` for OCaml). This is NOT prefixed with `file://`.
+- `repoPath` is the full path to your repository root.
+- `configPath` is the full path to your `config.json`.
+- `null` values will only be set if something goes wrong internally.
+- `ctx` is the result from `extractContext`.
 
-### credentials.json
+### config.json
 
 The extractor calls OpenAI for code completion.
-For this you need a `credentials.json` file that holds your specific OpenAI parameters.
+For this you need a `config.json` file that holds your specific OpenAI parameters.
 
 The json has the following format:
 
@@ -123,8 +146,19 @@ The json has the following format:
 }
 ```
 
+Internally, this is how the credentials are populated when creating a new OpenAI client.
+
+```ts
+const openai = new OpenAI({
+  apiKey,
+  baseURL: `${apiBase}/openai/deployments/${deployment}`,
+  defaultQuery: { "api-version": apiVersion },
+  defaultHeaders: { "api-key": apiKey }
+})
+```
+
 ## Trying out the VSCode extension
 
 We have a Visual Studio Code extension that provides a frontend to this project.
 
-The extension is not publicly available, so you would need to request for a .vsix package.
+The extension is not publicly available -- contact me at `jpoly@umich.edu` to request for a .vsix package.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jpoly1219/context-extractor",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Extract relevant context from an incomplete program sketch.",
   "repository": {
     "type": "git",