docs(types): deprecate function-types in favor of @tailor-platform/sdk#190
Merged
Conversation
Document that @tailor-platform/sdk now covers the same tailor.*/tailordb.* runtime surface, and add a migration guide (tsconfig types swap plus typed-import alternative). Note the one known gap: tailor.aigateway has no SDK runtime equivalent yet.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
packages/types/README.mdto mark@tailor-platform/function-typesas deprecated, since@tailor-platform/sdk's@tailor-platform/sdk/runtime/@tailor-platform/sdk/runtime/globalsmodules now cover the sametailor.*/tailordb.*runtime surface (secretmanager, authconnection, iconv, idp, workflow, context, and the TailorDB file API), including a compatibility shim for the legacy capitalizedTailordb.Clientnamespace.tsconfig.jsontypesentry from@tailor-platform/function-typesto@tailor-platform/sdk/runtime/globals, or (recommended) switch to named imports from@tailor-platform/sdk/runtimeinstead of relying on ambient globals.tailor.aigateway.get(name)has no equivalent yet in@tailor-platform/sdk's runtime module, so callers of that API should keep this package installed alongside the SDK until that's added.Verified that
@tailor-platform/sdk's runtime module is a superset of this package'stailor.d.ts(aside from the notedaigatewaygap) by building the SDK from source, type-checking sample usage of every namespace against the built declarations, and running its runtime test suite (all green).