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

Add correct TS .d.ts type declarations #75

Merged
merged 10 commits into from
Oct 11, 2023
Merged

Add correct TS .d.ts type declarations #75

merged 10 commits into from
Oct 11, 2023

Conversation

RJFelix
Copy link
Contributor

@RJFelix RJFelix commented Oct 11, 2023

Normal
Closes DEV-721

  • Generate more correct (or less incorrect) .d.ts files during build
    • I couldn't get index.d.ts to correctly import @userfront/core, so to get those type declarations to flow through, I added a manually adjusted index.d.ts file
  • Update JSDocs so that correct (or less incorrect) types are emitted by the auto generator
  • Incidentally, add link to dashboard/toolkit page in deprecated Userfront.build warning

Confirmed working in a fresh React TypeScript project - errors are resolved and type annotations are present as expected in VS Code for both the Toolkit components and re-exported CoreJS.

@RJFelix RJFelix requested a review from tyrw October 11, 2023 00:40
@vercel
Copy link

vercel bot commented Oct 11, 2023

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

Name Status Preview Comments Updated (UTC)
vercel-toolkit-react-dev-app ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 11, 2023 1:03am
vercel-toolkit-react-storybook ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 11, 2023 1:03am

@github-actions
Copy link
Contributor

github-actions bot commented Oct 11, 2023

Coverage Summary for `package`

Status Category Percentage Covered / Total
🔵 Lines 68.81% 3169 / 4605
🔵 Statements 68.81% 3169 / 4605
🔵 Functions 49.71% 88 / 177
🔵 Branches 62.38% 131 / 210
File Coverage
File Stmts % Branch % Funcs % Lines Uncovered Lines
package/src/components/AlternativeButton.jsx 69.23% 100% 0% 69.23% 8-11
package/src/components/BackButton.jsx 39.47% 100% 0% 39.47% 14-36
package/src/components/ContinueButton.jsx 47.36% 100% 0% 47.36% 8-17
package/src/components/Divider.jsx 54.16% 100% 0% 54.16% 12-22
package/src/components/ErrorMessage.jsx 92.59% 33.33% 100% 92.59% 16-17
package/src/components/IconButton.jsx 28.57% 100% 0% 28.57% 15-16, 19-28, 47-136, 147-159
package/src/components/InfoMessage.jsx 45.83% 100% 0% 45.83% 10-22
package/src/components/PhoneNumberInput.jsx 69.44% 0% 0% 69.44% 24-34
package/src/components/RetryButton.jsx 61.11% 100% 0% 61.11% 10-16
package/src/components/SecuredByUserfront.jsx 100% 100% 100% 100%
package/src/components/SubmitButton.jsx 100% 100% 100% 100%
package/src/components/TestModeNotice.jsx 66.66% 50% 50% 66.66% 16-18, 20-21, 28-34
package/src/components/Input/BackupCodeInput.jsx 100% 100% 100% 100%
package/src/components/Input/BaseInput.jsx 93.54% 33.33% 100% 93.54% 27-28
package/src/components/Input/EmailInput.jsx 100% 100% 100% 100%
package/src/components/Input/EmailOrUsernameInput.jsx 100% 100% 100% 100%
package/src/components/Input/PasswordInput.jsx 90.9% 0% 0% 90.9% 20-23
package/src/components/Input/TotpCodeInput.jsx 100% 100% 100% 100%
package/src/components/Input/VerificationCodeInput.jsx 100% 100% 100% 100%
package/src/components/Input/index.jsx 88% 100% 50% 88% 23-25
package/src/forms/UniversalForm.jsx 52.83% 7.4% 100% 52.83% 172-174, 190-208, 211-221, 223-235, 241-251, 253-265, 269-276, 288-294, 296-302, 304-310, 314-318, 320-326, 328-332, 334-340, 342-346, 350-354, 356-362, 364-368, 370-376, 378-382, 386-390, 392-398, 400-403, 407-420, 422-435, 437-441, 445-451, 453-459, 461-467, 469-475, 477-481, 484-488, 495-499, 503-507, 520-527, 530-533, 537-540, 544-548
package/src/models/config/actions.ts 67% 97.82% 89.74% 67% 63-77, 79-92, 96-101, 130-131, 159-169, 174-180, 196-201, 207-213, 218-222, 229-235, 243-248, 265-266, 283-285, 313-326, 338-339, 351-355, 375-376, 379-394
package/src/models/config/guards.ts 80.15% 100% 55.88% 80.15% 44, 48, 55-60, 68, 73, 78, 85-91, 96, 101, 106-107, 117, 121, 125
package/src/models/config/utils.ts 91.71% 100% 78.57% 91.71% 108-118, 123-124, 134
package/src/models/forms/universal.ts 91.59% 100% 5% 91.59% 95-96, 121-126, 131-132, 162-167, 171-172, 174-175, 177-178, 180-181, 183-184, 186-187, 238, 324-330, 614-622, 636-646, 752-759
package/src/models/views/emailCode.ts 96.8% 50% 100% 96.8% 37-38, 40-41
package/src/models/views/emailLink.ts 88.23% 28.57% 100% 88.23% 37-42, 49-50, 52-53, 94-95, 97-98
package/src/models/views/password.ts 75.26% 100% 0% 75.26% 42-64
package/src/models/views/selectFactor.ts 100% 100% 100% 100%
package/src/models/views/setNewPassword.ts 78.94% 100% 0% 78.94% 35-50
package/src/models/views/setUpTotp.ts 89.91% 100% 0% 89.91% 55-66
package/src/models/views/smsCode.ts 96.87% 50% 100% 96.87% 40-41, 43-44
package/src/models/views/totpCode.ts 66.66% 100% 0% 66.66% 37-61, 89-109
package/src/services/logging.js 38.46% 100% 0% 38.46% 5-6, 9-10, 13-15, 18-26
package/src/services/userfront.ts 65.88% 53.33% 60% 65.88% 49-62, 74-78, 83-85, 101-102, 104-108, 111-113, 128-129, 147-170
package/src/utils/hooks.js 80% 77.77% 100% 80% 12, 19-20, 22-23
package/src/views/AlreadyLoggedIn.jsx 77.77% 100% 0% 77.77% 6-7
package/src/views/EmailLinkSent.jsx 50% 100% 0% 50% 15-30
package/src/views/EnterEmail.jsx 71.42% 50% 50% 71.42% 20-33
package/src/views/EnterPhone.jsx 42.1% 100% 0% 42.1% 15-36
package/src/views/EnterTotpCode.jsx 18.11% 100% 0% 18.11% 22-125
package/src/views/EnterVerificationCode.jsx 34.78% 100% 0% 34.78% 15-44
package/src/views/GeneralErrorMessage.jsx 65% 100% 0% 65% 12-18
package/src/views/LogInWithPassword.jsx 28.33% 100% 0% 28.33% 16-58
package/src/views/Message.jsx 81.81% 100% 0% 81.81% 8-9
package/src/views/Placeholder.jsx 75% 100% 0% 75% 5-6
package/src/views/SelectFactor.jsx 26.8% 100% 0% 26.8% 25-95
package/src/views/SetNewPassword.jsx 62.36% 100% 50% 62.36% 19-53
package/src/views/SetNewPasswordSuccess.jsx 75% 100% 0% 75% 5-6
package/src/views/SetUpTotp.jsx 34.61% 100% 0% 34.61% 17-50
package/src/views/SetUpTotpSuccess.jsx 36.11% 100% 0% 36.11% 12-34
package/src/views/SignUpWithPassword.jsx 20.4% 100% 0% 20.4% 19-96
package/src/views/Success.jsx 50% 100% 0% 50% 10-20
package/src/views/TotpErrorMessage.jsx 48.48% 100% 0% 48.48% 15-31

package/src/index.js Outdated Show resolved Hide resolved
Copy link
Member

@tyrw tyrw left a comment

Choose a reason for hiding this comment

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

Looks good to publish, especially as alpha. Can you let me know when it's published / tested and I'll reach out to the customer.

@github-actions
Copy link
Contributor

Published version 1.0.2-alpha.8 to npm.

@stephencattaneo stephencattaneo deleted the add-types branch August 20, 2024 21:17
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