Build a fides-types.d.ts
type declaration file to include alongside our FidesJS developer docs
#4772
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.
Description Of Changes
This adds a new
dist/fides-types.d.ts
file to our build outputs infides-js
that includes just the documented types that we use to build the developer docs here: https://ethyca.com/docs/dev-docs/js/referenceAs a next step, we could host the most recent
fides-types.d.ts
on the docs site so that customer developers could download these and use them! Technically the right thing to do is to publish these onnpm
, but let's not overengineer it too much... yet 😉.Basically: I can tinker with how to distribute these types next, but first want to get the build reviewed and working.
Code Changes
stripInternal
in the tsconfig to tell Typescript not to emit internal types in any type declarations@internal
tag instead of@private
tag in TSDoc comments to specify types that shouldn't be documented (in either the SDK docs or the type declarations!)Steps to Confirm
turbo build
in thefides-js
project and check thedist/fides-types.d.ts
output 👍Pre-Merge Checklist
CHANGELOG.md