Skip to content
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.

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

Build a fides-types.d.ts type declaration file to include alongside our FidesJS developer docs #4772

Merged
merged 4 commits into from
Apr 3, 2024

Conversation

NevilleS
Copy link
Contributor

@NevilleS NevilleS commented Apr 2, 2024

Description Of Changes

This adds a new dist/fides-types.d.ts file to our build outputs in fides-js that includes just the documented types that we use to build the developer docs here: https://ethyca.com/docs/dev-docs/js/reference

As 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 on npm, 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

  • Enable stripInternal in the tsconfig to tell Typescript not to emit internal types in any type declarations
  • Use @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

  • Run turbo build in the fides-js project and check the dist/fides-types.d.ts output 👍

Pre-Merge Checklist

Copy link

vercel bot commented Apr 2, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
fides-plus-nightly ⬜️ Ignored (Inspect) Visit Preview Apr 2, 2024 11:14pm

Copy link

cypress bot commented Apr 2, 2024

Passing run #7037 ↗︎

0 4 0 0 Flakiness 0

Details:

Merge 9065494 into 71a1d7e...
Project: fides Commit: 9fda75e1e6 ℹ️
Status: Passed Duration: 00:34 💡
Started: Apr 2, 2024 11:25 PM Ended: Apr 2, 2024 11:26 PM

Review all test suite changes for PR #4772 ↗︎

Copy link
Contributor

@gilluminate gilluminate left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love the renaming and love that we're exporting the type definitions.

@NevilleS NevilleS merged commit 18fd8b7 into main Apr 3, 2024
13 checks passed
@NevilleS NevilleS deleted the ns-fides-js-doc-types branch April 3, 2024 14:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants