From 5b9a8485b0338801f55835a94e458918cd4ebcfb Mon Sep 17 00:00:00 2001 From: Akira HIGUCHI Date: Thu, 2 Jul 2026 14:50:23 +0900 Subject: [PATCH] docs(types): remove aigateway gap note now that sdk covers it @tailor-platform/sdk@1.73.0 added aigateway.get(name) to @tailor-platform/sdk/runtime, closing the one gap noted in the deprecation README. Update the typed-import example to include it and drop the now-stale 'known gap' section. --- .changeset/remove-aigateway-gap.md | 5 +++++ packages/types/README.md | 9 +++------ 2 files changed, 8 insertions(+), 6 deletions(-) create mode 100644 .changeset/remove-aigateway-gap.md diff --git a/.changeset/remove-aigateway-gap.md b/.changeset/remove-aigateway-gap.md new file mode 100644 index 0000000..0fcde4f --- /dev/null +++ b/.changeset/remove-aigateway-gap.md @@ -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`). diff --git a/packages/types/README.md b/packages/types/README.md index 8ef568c..9667d79 100644 --- a/packages/types/README.md +++ b/packages/types/README.md @@ -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` @@ -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