Skip to content

Commit

Permalink
Add @inngest/ai (#802)
Browse files Browse the repository at this point in the history
## Summary
<!-- Succinctly describe your change, providing context, what you've
changed, and why. -->

Adds the `@inngest/ai` package, exporting models, adapters, and types
for AI workflows.

## Checklist
<!-- Tick these items off as you progress. -->
<!-- If an item isn't applicable, ideally please strikeout the item by
wrapping it in "~~"" and suffix it with "N/A My reason for skipping
this." -->
<!-- e.g. "- [ ] ~~Added tests~~ N/A Only touches docs" -->

- [ ] ~Added a [docs PR](https://github.com/inngest/website) that
references this PR~ N/A
- [ ] ~Added unit/integration tests~ N/A Shifting packages
- [x] Added changesets if applicable
  • Loading branch information
jpwilliams authored Jan 16, 2025
1 parent 7459239 commit 32518bf
Show file tree
Hide file tree
Showing 25 changed files with 925 additions and 114 deletions.
5 changes: 5 additions & 0 deletions .changeset/six-roses-melt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"inngest": patch
---

Use `@inngest/ai` to expose AI models, adapters, and types
5 changes: 5 additions & 0 deletions .changeset/wild-buses-yawn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@inngest/ai": patch
---

Add `@inngest/ai`
3 changes: 3 additions & 0 deletions packages/ai/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
dist
node_modules
*.tgz
Empty file added packages/ai/CHANGELOG.md
Empty file.
1 change: 1 addition & 0 deletions packages/ai/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# @inngest/ai
13 changes: 13 additions & 0 deletions packages/ai/eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import pluginJs from "@eslint/js";
import eslintPluginPrettierRecommended from "eslint-plugin-prettier/recommended";
import globals from "globals";
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,
eslintPluginPrettierRecommended,
];
12 changes: 12 additions & 0 deletions packages/ai/jsr.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"$schema": "https://jsr.io/schema/config-file.v1.json",
"name": "@inngest/ai",
"description": "",
"version": "0.0.0",
"include": ["./src/**/*.ts"],
"exports": {
".": "./src/index.ts",
"./models": "./src/models/index.ts",
"./adapters": "./src/adapters/index.ts"
}
}
57 changes: 57 additions & 0 deletions packages/ai/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
{
"name": "@inngest/ai",
"version": "0.0.0",
"description": "",
"main": "dist/index.js",
"publishConfig": {
"registry": "https://registry.npmjs.org"
},
"scripts": {
"build": "tsc",
"postversion": "pnpm run build",
"release": "node ../../scripts/release/publish.js && pnpm dlx jsr publish --allow-slow-types --allow-dirty"
},
"files": [
"dist"
],
"exports": {
".": {
"require": "./dist/index.js",
"import": "./dist/index.js",
"types": "./dist/index.d.ts"
},
"./models": {
"require": "./dist/models/index.js",
"import": "./dist/models/index.js",
"types": "./dist/models/index.d.ts"
},
"./adapters": {
"require": "./dist/adapters/index.js",
"import": "./dist/adapters/index.js",
"types": "./dist/adapters/index.d.ts"
}
},
"keywords": [
"inngest",
"ai"
],
"homepage": "https://github.com/inngest/inngest-js/tree/main/packages/ai#readme",
"repository": {
"type": "git",
"url": "git+https://github.com/inngest/inngest-js.git",
"directory": "packages/ai"
},
"author": "Inngest Inc. <[email protected]>",
"license": "ISC",
"dependencies": {
"@types/node": "^22.10.5",
"typescript": "^5.7.3"
},
"devDependencies": {
"@eslint/js": "^9.7.0",
"eslint": "^9.18.0",
"eslint-plugin-prettier": "^5.2.1",
"globals": "^15.14.0",
"typescript-eslint": "^7.16.1"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ export interface AiAdapter {
/**
* The input to pass to the model.
*/
body: this[types]["input"]
body: this[types]["input"],
) => void;
}

Expand Down
File renamed without changes.
2 changes: 2 additions & 0 deletions packages/ai/src/adapters/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
export * from "./anthropic.js";
export * from "./openai.js";
File renamed without changes.
69 changes: 69 additions & 0 deletions packages/ai/src/env.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
export type EnvValue = string | undefined;
export type Env = Record<string, EnvValue>;

/**
* The Deno environment, which is not always available.
*/
declare const Deno: {
env: { toObject: () => Env };
};

/**
* The Netlify environment, which is not always available.
*/
declare const Netlify: {
env: { toObject: () => Env };
};

/**
* allProcessEnv returns the current process environment variables, or an empty
* object if they cannot be read, making sure we support environments other than
* Node such as Deno, too.
*
* Using this ensures we don't dangerously access `process.env` in environments
* where it may not be defined, such as Deno or the browser.
*/
export const allProcessEnv = (): Env => {
// Node, or Node-like environments
try {
if (process.env) {
return process.env;
}
} catch (_err) {
// noop
}

// Deno
try {
const env = Deno.env.toObject();

if (env) {
return env;
}
} catch (_err) {
// noop
}

// Netlify
try {
const env = Netlify.env.toObject();

if (env) {
return env;
}
} catch (_err) {
// noop
}

return {};
};

export const processEnv = (key: string): EnvValue => {
return allProcessEnv()[key];
};

export enum envKeys {
OpenAiApiKey = "OPENAI_API_KEY",
GeminiApiKey = "GEMINI_API_KEY",
AnthropicApiKey = "ANTHROPIC_API_KEY",
}
3 changes: 3 additions & 0 deletions packages/ai/src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export type { AiAdapter, AiAdapters } from "./adapter.js";
export * from "./adapters/index.js";
export * from "./models/index.js";
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import { envKeys } from "../../../helpers/consts.js";
import { processEnv } from "../../../helpers/env.js";
import { type AiAdapter } from "../adapter.js";
import { type AnthropicAiAdapter } from "../adapters/anthropic.js";
import { envKeys, processEnv } from "../env";

/**
* Create an Anthropic model using the Anthropic chat format.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import { envKeys } from "../../../helpers/consts.js";
import { processEnv } from "../../../helpers/env.js";
import { type AiAdapter } from "../adapter.js";
import { envKeys, processEnv } from "../env";
import { type OpenAi, openai } from "./openai.js";

/**
Expand Down
3 changes: 3 additions & 0 deletions packages/ai/src/models/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export * from "./anthropic";
export * from "./gemini";
export * from "./openai";
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import { envKeys } from "../../../helpers/consts.js";
import { processEnv } from "../../../helpers/env.js";
import { type AiAdapter } from "../adapter.js";
import { type OpenAiAiAdapter } from "../adapters/openai.js";
import { envKeys, processEnv } from "../env";

/**
* Create an OpenAI model using the OpenAI chat format.
Expand Down
111 changes: 111 additions & 0 deletions packages/ai/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
{
"compilerOptions": {
/* Visit https://aka.ms/tsconfig to read more about this file */

/* Projects */
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */

/* Language and Environment */
"target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */

/* Modules */
"module": "NodeNext" /* Specify what module code is generated. */,
"rootDir": "./src" /* Specify the root folder within your source files. */,
"moduleResolution": "NodeNext" /* Specify how TypeScript looks up a file from a given module specifier. */,
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
"types": [
"node"
] /* Specify type package names to be included without being referenced in a source file. */,
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
// "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
// "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */
// "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */
// "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
"resolveJsonModule": true /* Enable importing .json files. */,
// "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */

/* JavaScript Support */
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */

/* Emit */
"declaration": true /* Generate .d.ts files from TypeScript and JavaScript files in your project. */,
"declarationMap": true /* Create sourcemaps for d.ts files. */,
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
"sourceMap": true /* Create source map files for emitted JavaScript files. */,
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
"outDir": "./dist" /* Specify an output folder for all emitted files. */,
// "removeComments": true, /* Disable emitting comments. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */

/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,

/* Type Checking */
"strict": true /* Enable all strict type-checking options. */,
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
"strictNullChecks": true /* When type checking, take into account 'null' and 'undefined'. */,
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
"noUncheckedIndexedAccess": true /* Add 'undefined' to a type when accessed using an index. */,
"noImplicitOverride": true /* Ensure overriding members in derived classes are marked with an override modifier. */,
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */

/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
}
}
1 change: 1 addition & 0 deletions packages/inngest/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,7 @@
"trailingComma": "es5"
},
"dependencies": {
"@inngest/ai": "^0.0.0",
"@types/debug": "^4.1.12",
"canonicalize": "^1.0.8",
"chalk": "^4.1.2",
Expand Down
2 changes: 1 addition & 1 deletion packages/inngest/src/components/InngestStepTools.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/* eslint-disable @typescript-eslint/no-unsafe-assignment */
import { openai } from "@local/components/ai";
import { openai } from "@local";
import { EventSchemas } from "@local/components/EventSchemas";
import { type Inngest } from "@local/components/Inngest";
import { InngestFunction } from "@local/components/InngestFunction";
Expand Down
2 changes: 1 addition & 1 deletion packages/inngest/src/components/InngestStepTools.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { gemini, openai, type AiAdapter } from "@inngest/ai";
import { z } from "zod";
import { logPrefix } from "../helpers/consts.js";
import { type Jsonify } from "../helpers/jsonify.js";
Expand Down Expand Up @@ -30,7 +31,6 @@ import {
} from "./Inngest.js";
import { InngestFunction } from "./InngestFunction.js";
import { InngestFunctionReference } from "./InngestFunctionReference.js";
import { gemini, openai, type AiAdapter } from "./ai/index.js";

import { type InngestExecution } from "./execution/InngestExecution.js";

Expand Down
10 changes: 0 additions & 10 deletions packages/inngest/src/components/ai/index.ts

This file was deleted.

4 changes: 2 additions & 2 deletions packages/inngest/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,14 @@
* @module
*/

export * from "./components/ai/index.js";
export * from "@inngest/ai";
export {
EventSchemas,
type AssertInternalEventPayloads,
type Combine,
type LiteralZodEventSchema,
type StandardEventSchemaToPayload,
type StandardEventSchemas,
type StandardEventSchemaToPayload,
type ZodEventSchemas,
} from "./components/EventSchemas.js";
export type {
Expand Down
Loading

0 comments on commit 32518bf

Please sign in to comment.