Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Inferable tRPC Adapter #272

Merged
merged 12 commits into from
Dec 11, 2024
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions connectors/trpc/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Dependencies
node_modules/

# Build output
dist/

# Environment variables
.env
.env.*

# IDE files
.vscode/
.idea/

# Logs
*.log
npm-debug.log*

# Coverage directory
coverage/

# OS files
.DS_Store
10 changes: 10 additions & 0 deletions connectors/trpc/.npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
src/
tests/
.eslintrc.json
.gitignore
tsconfig.json
jest.config.js
*.log
.DS_Store
coverage/
.env
108 changes: 108 additions & 0 deletions connectors/trpc/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
<p align="center">
<img src="https://a.inferable.ai/logo-hex.png" width="200" style="border-radius: 10px" />
</p>

# tRPC Adapter for Inferable

![npm version](https://badge.fury.io/js/@inferable/trpc-adapter.svg)
![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)

The Inferable tRPC Adapter allows you to expose your existing tRPC router endpoints as Inferable functions. This enables AI agents to interact with your tRPC API while preserving all your existing middleware and type safety.

## Installation

### npm

```bash
npm install @inferable/trpc-adapter
```

### yarn

```bash
yarn add @inferable/trpc-adapter
```

### pnpm

```bash
pnpm add @inferable/trpc-adapter
```

## Quick Start

Create your tRPC router with the Inferable plugin:

```ts
import { inferablePlugin } from "@inferable/trpc-adapter";

const t = initTRPC.create();
const withInferable = inferablePlugin();

const appRouter = t.router({
userById: t.procedure
.unstable_concat(withInferable) // It's safe to use unstable_concat - https://trpc.io/docs/faq#unstable
.input(z.object({ id: z.string() }))
.meta({ description: "Fetch a user by their ID" }) // This will be used to encrich the LLM context
.query(({ input }) => {
return users.find((user) => user.id === input.id);
}),
});
```

Create an Inferable service from your router:

```ts
import { createInferableService } from "@inferable/trpc-adapter";
import { Inferable } from "inferable";

const client = new Inferable({
apiSecret: process.env.INFERABLE_API_SECRET,
});

const service = createInferableService({
router: appRouter,
createCaller: t.createCallerFactory(appRouter),
name: "userService",
client,
});

// Start the service
await service.start();
```

3. Your tRPC procedures are now available as Inferable functions!

```ts
const result = await client.run({
initialPrompt: "Get the user with id 1",
resultSchema: z.object({
id: z.string(),
name: z.string(),
email: z.string(),
}),
});
```

## Technical Details

The plugin does two things:

1. It adds a `meta` field to the procedures with `{ inferable: { enabled: true } }`. This is used to identify the procedures that should be exposed as Inferable functions.
2. It adds a `ctx` field to the tRPC procedure so you can validate the context that's passed by Inferable in your down stream procedures or middleware.

- This allows you model [human in the loop](https://docs.inferable.ai/pages/human-in-the-loop) workflows where you can fire off a approval request to a human before the function is run.
johnjcsmith marked this conversation as resolved.
Show resolved Hide resolved
- It also allows you to handle [end-user authentication](https://docs.inferable.ai/pages/end-user-authentication) in your tRPC procedures.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#281 renames this to custom auth

- For more information on the context object, see the [context documentation](https://docs.inferable.ai/pages/context).

## Documentation

[Inferable documentation](https://docs.inferable.ai) contains all the information you need to get started with Inferable.

## Support

For support or questions, please create an issue in the repository.

## Contributing

Contributions to the Inferable tRPC Connector are welcome. Please ensure that your code adheres to the existing style and includes appropriate tests.
12 changes: 12 additions & 0 deletions connectors/trpc/eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import globals from "globals";
import pluginJs from "@eslint/js";
import tseslint from "typescript-eslint";


/** @type {import('eslint').Linter.Config[]} */
export default [
{files: ["**/*.{js,mjs,cjs,ts}"]},
{languageOptions: { globals: globals.browser }},
pluginJs.configs.recommended,
...tseslint.configs.recommended,
];
28 changes: 28 additions & 0 deletions connectors/trpc/eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"parser": "@typescript-eslint/parser",
"plugins": [
"@typescript-eslint"
],
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/recommended"
],
"env": {
"node": true,
"es6": true
},
"parserOptions": {
"ecmaVersion": 2020,
"sourceType": "module"
},
"rules": {
"@typescript-eslint/explicit-function-return-type": "warn",
"@typescript-eslint/no-explicit-any": "warn",
"@typescript-eslint/no-unused-vars": [
"error",
{
"argsIgnorePattern": "^_"
}
]
}
}
7 changes: 7 additions & 0 deletions connectors/trpc/jest.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
module.exports = {
preset: "ts-jest",
testEnvironment: "node",
roots: ["<rootDir>/src"],
testMatch: ["**/*.test.ts"],
collectCoverageFrom: ["src/**/*.ts", "!src/**/*.d.ts"],
};
Loading
Loading