Fix a TS error when using Inngest in projects with composite setting
#460
Conversation
This file contains 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
🦋 Changeset detectedLatest commit: 414e637 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
jpwilliams
added
Bug
|
Thanks, @MonsterDeveloper. Let's get a CI check added for this, eh? |
Merged
jpwilliams
pushed a commit
that referenced
this pull request
Jan 12, 2024
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## inngest@3.10.0 ### Minor Changes - [#449](#449) [`a452cf1`](a452cf1) Thanks [@jpwilliams](https://github.com/jpwilliams)! - Add `referenceFunction()`, allowing easier, typed invocation of functions across apps and languages - [#459](#459) [`eec41d2`](eec41d2) Thanks [@jpwilliams](https://github.com/jpwilliams)! - Add new `Inngest.Any` and `InngestFunction.Any` type helpers ### Patch Changes - [#460](#460) [`a225206`](a225206) Thanks [@MonsterDeveloper](https://github.com/MonsterDeveloper)! - Add exports for `FinishedEventPayload` and `Context` types to fix a TypeScript error when using Inngest in projects with `composite` setting in `tsconfig`. Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
3 tasks
3 tasks
jpwilliams
added a commit
that referenced
this pull request
Feb 26, 2024
… issues (#501) ## Summary <!-- Succinctly describe your change, providing context, what you've changed, and why. --> We've seen some issues crop up when `composite: true` is present in `tsconfig.json` files. This PR adds a `composite: true` project where we test the Inngest package for compliance for the types that it exports. We purposefully want to limit the number of types exported from the main `"inngest"` entrypoint, as each type exported here becomes part of the public API, where changing those types is a breaking change. Therefore, the composite check gives us a (albeit inaccurate) test that can stop us shipping these dangerous changes. ## 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 Bug fix and testing - [x] Added unit/integration tests - [x] Added changesets if applicable ## Related <!-- A space for any related links, issues, or PRs. --> <!-- Linear issues are autolinked. --> <!-- e.g. - INN-123 --> <!-- GitHub issues/PRs can be linked using shorthand. --> <!-- e.g. "- inngest/inngest#123" --> <!-- Feel free to remove this section if there are no applicable related links.--> - #384 - #385 - #437 - #460
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
This PR Adds some type exports to
index.tsthat fix a TS error in composite projects.After changes to the
types.tsthe issue #384 appeared again. This PR is similar to #385 - it fixes the TS error by adding necessary exports to theindex.tsChecklist
Added a docs PR that references this PRN/A no docs neededAdded unit/integration testsN/A not testableRelated
compositesetting #385composite#384