# copilot-js

> copilot-js is a library that provides an autocompletion for LLM.

Latest version **1.1.0** (published 2024-01-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install copilot-js
pnpm add copilot-js
yarn add copilot-js
bun add copilot-js
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2024-01-24 |
| First published | 2023-09-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 109.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Maintainers | norami |
| Keywords | copilot, llm, completion, chatgpt, openai |

## Links

- npm: https://www.npmjs.com/package/copilot-js
- Repository: https://github.com/honeysol/copilot-js
- Homepage: https://github.com/honeysol/copilot-js#readme
- Issues: https://github.com/honeysol/copilot-js/issues
- npm.io page: https://npm.io/package/copilot-js

## Recent versions

- 1.1.0 (latest) — 2024-01-24
- 1.0.9 — 2024-01-11
- 1.0.8 — 2024-01-05
- 1.0.7 — 2024-01-05
- 1.0.6 — 2024-01-05
- 1.0.5 — 2023-09-08
- 1.0.4 — 2023-09-04
- 1.0.3 — 2023-09-04
- 1.0.2 — 2023-09-03
- 1.0.1 — 2023-09-03
- 1.0.0 — 2023-09-02

## README

# copilot-js

copilot-js is a library that provides an autocompletion for LLM. 

# Background
LLM has changed people's work and lives significantly. However, it does not always return the correct answer and has limited applications. Copilot UI dramatically expands the applications of LLM by allowing collaboration between LLM and humans. For this, high-quality Copilot components are essential for the development of humans with LLM.

# Features
- Easy-to-use UI specialized for natural language input
- Support for text-only or text-containing HTML
- Provide helpers

# Remark
This library converts pure DOM element into copilot.
If you want to use it with React, use [copilot-react](../copilot-react/README.md).

# Demo
See [/packages/demo](../demo/README.md)

# Guide for users

## normal state:
| Key | Action |
|-----|--------|
| Ctrl+Enter | Start completion |

## completion state:
| Key | Action |
|-----|--------|
| Esc | Collapse completion |
| Character Key | Collapse completion and insert pressed key |

Unlike Github copilot, you can perform operations such as arrow keys, copy, and paste even during completion.


# Guide for developers

## Installation

To install copilot-js, you can use npm:

npm i copilot-js

## Step 1 Create a completion handler.

Use helpers in "./dist/helper/*" or write a handler by yourself.
See samples in files: 

| API sample | Description |
|--------------|-------------|
| [/packages/demo/src/api/completion_sse.ts](../demo/src/api/completion_sse.ts) | API sample for fetch() that responds to server-sent event (can also be used for OpenAI API)|
| [/packages/demo/src/api/completion_text.ts](../demo/src/api/completion_text.ts) | API sample for fetch() that responds to text stream |
| [/packages/demo/src/api/completion_openai.ts](../demo/src/api/completion_openai.ts) | API sample for OpenAI official library |

## Step 2 Create a copilot object.

```ts
const copilot = new CopilotEngine({
  handler: callCompletion, // handler to completion API
  onChange: (text) => console.log(text), // event handler to get content
  value: value, // initial value
  container: document.getElementById("#container"),
})
```

## Step 3 Change parameter in runtime (if needed)

All constructor parameters except `container` can be changed in runtime.

```ts
copilot.handler = newHandler;
copilot.onChange =  (text) => console.log("new event handler", text);
copilot.value = value;
```

When `value` changes, the cursor and completion state will be reset.

# Examples

See [/packages/demo/src/index.tsx](/../demo/src/index.tsx)

# API Reference

## CopilotEngine

Engine to handle completion. You can convert any DIV element to a completion-enabled editor.

### Constructor

```ts
new CopilotEngine(params: {
  value: string;
  textOnly?: boolean = true;
  onChange?: (value: string) => void;
  delay?: number;
  handler: CompletionHandler;
  errorHandler?: ErrorHandler;
  element: HTMLDivElement
}): CopilotEngine

interface CopilotEngine {
  value: string;
  textOnly?: boolean;
  onChange?: (value: string) => void;
  delay?: number;
  handler: CompletionHandler;
  errorHandler?: ErrorHandler;
}

type CompletionHandler = (params: {
  precedingText?: string | undefined;
  followingText?: string | undefined;
  callback: (output: string) => void;
}) => StreamState;

type StreamState = {
  abort: () => void;
  promise: Promise<void>;
};

type ErrorHandler = (error: any) => void;

```
### Parameters

- `params`: An object with the following properties:
  - `handler`: Completion handler.
  - `element`  The DIV element to be converted to a completion-enabled editor
  - `value`: Initial value.
  - `textOnly` (optional): If true, only text can be inserted. Default true.
  - `onChange` (optional): Callback when the value is changed.
  - `delay` (optional): Delay to start automatic completion. If not specified, completion will not start automatically.
  - `errorHandler` (optional): Error handler, callback error in CompletionHandler.


### Fields

- `handler`: Completion handler.
- `element`  The DIV element to be converted to a completion-enabled editor
- `value`: Initial value.
- `textOnly` (optional): If true, only text can be inserted. Default true.
- `onChange` (optional): Callback when the value is changed.
- `delay` (optional): Delay to start automatic completion. If not specified, completion will not start automatically.
- `errorHandler` (optional): Error handler, callback error in CompletionHandler.

---
_Source: https://npm.io/package/copilot-js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._