npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ts-chat

v0.0.15

Published

`ts-chat` is a TypeScript plugin that adds support for generating OpenAI's GPT Functions from native TypeScript functions, types and comments.

Downloads

22

Readme

ts-chat

ts-chat is a TypeScript plugin that adds support for generating OpenAI's GPT Functions from native TypeScript functions, types and comments.

import { ChatClient, system, user } from "ts-chat";

const client = new ChatClient({
  apiKey: process.env.OPEN_AI_KEY,
});

await client.chat(
  {
    /**
     * Adds two numbers.
     *
     * @param a the first number
     * @param b the second number
     */
    add: (a: number, b: number) => a + b,
  },
  {
    messages: [
      system`You are a calculator.`,
      user`what is the sum of 1 and 2?`,
    ],
  }
);

Types and comments can be used fluidly and natively. E.g. here's how we can define integers and natural numbers. Constraints are parsed from the comments and can be extended/overriden:

/**
 * @type int
 */
type int = number;

/**
 * @min 1
 */
type nat = int;

Use interfaces to describe well-typed structured data with well-constrained properties:

interface Person {
  /**
   * @pattern [a-zA-z]+
   * @minLength 3
   */
  name: string;
}

Installation

First, install ts-chat:

npm install ts-chat

Next, you need to configure ts-patch to enable plugin support in the TypeScript compiler and configure the ts-chat/plugin.

There are two options for this set up:

  1. permanently patch using the NPM prepare script
  2. patch when you run (e.g. when running ts-node, tsc, jest, etc.)

Option 1 - permanently patch

Run the setup script to install ts-patch, configure prepare and install ts-chat/plugin in tsconfig.json

npx ts-chat setup

This script performs the following steps:

  1. Installs ts-node and ts-patch
  2. Add the prepare script to your package.json to run the ts-patch install whenever you install dependencies:
"scripts": {
  "prepare": "ts-patch install"
}
  1. Add the ts-chat/plugin to your tsconfig.json - without this, the chat function can not receive the JSON schema and descriptions of your functions.
{
  "compilerOptions": {
    "plugins": [
      {
        "transform": "ts-chat/plugin"
      }
    ]
  }
}

Option 2 - "Live Compiler"

From ts-patch's documentation on "Live Compilation":

The live compiler patches on-the-fly, each time it is run.

Via commandline: Simply use tspc (instead of tsc)

With tools such as ts-node, webpack, ts-jest, etc: specify the compiler as ts-patch/compiler

Example:

ts-node-esm --compiler ts-patch/compiler ./src/index.ts

How it Works

Functions are converted into their corresponding OpenAI Function definition:

{
  "name": "add",
  "description": "Adds two numbers",
  "parameters": {
    "type": "object",
    "properties": {
      "a": { "type": "number", "description": "first argument" },
      "b": { "type": "number", "description": "second arguments" }
    }
  }
}

The descriptions are derived from the typedoc comments and the parameters JSON schema is derived from the types of the Function's arguments.