Skip to content

docs(types): remove aigateway gap note now that sdk covers it #193

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.

Sign up for GitHub

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

Merged
toiroakr merged 1 commit into from
Jul 2, 2026
Merged

docs(types): remove aigateway gap note now that sdk covers it #193

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions .changeset/remove-aigateway-gap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@tailor-platform/function-types": patch
---

Remove the "known gap" note about `tailor.aigateway` from the deprecation README now that `@tailor-platform/sdk@1.73.0` adds a runtime wrapper for it (`aigateway.get(name)`, imported from `@tailor-platform/sdk/runtime`).
9 changes: 3 additions & 6 deletions packages/types/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Deprecated.** These types are now built into [`@tailor-platform/sdk`](https://www.npmjs.com/package/@tailor-platform/sdk), which exposes the same `tailor.*` / `tailordb.*` runtime surface plus typed wrappers you can import directly instead of relying on ambient globals. New projects should use `@tailor-platform/sdk` instead of this package; existing projects should migrate using the steps below.

This package will no longer receive updates for new runtime APIs (e.g. it never picked up `tailor.aigateway.get()`, while `@tailor-platform/sdk` will keep gaining new runtime APIs).
This package will no longer receive updates for new runtime APIs, while `@tailor-platform/sdk` will keep gaining new runtime APIs.

## Migrating to `@tailor-platform/sdk`

Expand Down Expand Up @@ -33,15 +33,12 @@ This package will no longer receive updates for new runtime APIs (e.g. it never
Instead of relying on the ambient `tailor` / `tailordb` globals, `@tailor-platform/sdk/runtime` exposes the same APIs as regular imports, which is easier to trace and doesn't require the `tsconfig.json` `types` change above:

```typescript
import { iconv, secretmanager, idp, workflow, context, authconnection, file } from "@tailor-platform/sdk/runtime";
import { iconv, secretmanager, idp, workflow, context, authconnection, aigateway, file } from "@tailor-platform/sdk/runtime";

const secret = await secretmanager.getSecret("my-vault", "API_KEY");
const gateway = await aigateway.get("my-aigateway");
```

### Known gap: `tailor.aigateway`

`@tailor-platform/sdk` does not yet expose a runtime equivalent of `tailor.aigateway.get(name)`. If your code uses it, keep this package installed alongside `@tailor-platform/sdk` for that one namespace until the SDK adds support, or reach out to the SDK team if you need this migrated sooner.

## Legacy usage (this package)

```sh
Expand Down