Skip to content

Commit 2d91f47

Browse files
authored
Release v3.0.0 (#696)
1 parent 9359f10 commit 2d91f47

File tree

59 files changed

+14866
-15463
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+14866
-15463
lines changed

.circleci/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ workflows:
2424
- ship/node-publish:
2525
node-version: 18.16.0
2626
pkg-manager: yarn
27-
publish-command: npm publish --tag v3-beta
27+
publish-command: npm publish
2828
requires:
2929
- build
3030
context:

CHANGELOG.md

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,49 @@
11
# Change Log
22

3+
## [v3.0.0](https://github.com/auth0/react-native-auth0/tree/v3.0.0) (2023-08-10)
4+
5+
[Full Changelog](https://github.com/auth0/react-native-auth0/compare/v2.17.4...v3.0.0)
6+
7+
💡 Check the [Migration Guide](MIGRATION_GUIDE.md) to understand the changes required to migrate your application to v3.
8+
9+
**Added**
10+
11+
- Credentials are returned as part of authorize methods in hooks
12+
- Support for organizations name in login
13+
- Added sample app in the repository
14+
- Expo plugin is updated to latest version
15+
- Added 'openid profile email' as mandatory scopes
16+
- Option to `forceRefresh` is added in `getCredentials`
17+
- Added `hasValidCredentials` to hooks
18+
- More options to authorize using Hooks
19+
- `authorizeWithSMS`
20+
- `authorizeWithEmail`
21+
- `authorizeWithOOB`
22+
- `authorizeWithOTP`
23+
- `authorizeWithRecoveryCode`
24+
25+
**Changed**
26+
27+
- Custom Scheme is now optional in Expo
28+
- Migrated the codebase to Typescript
29+
- Use Native SDKs ([Auth0.Android](https://github.com/auth0/Auth0.Android/) and [Auth0.Swift](https://github.com/auth0/Auth0.Swift)) for Web Authentication
30+
- `Credentials` object in Android will return `expiresIn` instead of `expiresAt`
31+
- `max_age` parameter is changed to `maxAge` in `WebAuth.authorize()`
32+
- `customScheme` is now part of `ClearSessionOptions` instead of `ClearSessionParameters` in `clearSession`
33+
- Minimum supported version for iOS is bumped to 13
34+
- Revoke Token and Change Password now return `void` instead of an empty object
35+
36+
**Removed**
37+
38+
- Removed the `type` property returned in the `Credentials` object in Android. Use `tokenType` instead.
39+
- `skipLegacyListener` has been removed in `authorize` and `clearSession`
40+
41+
**Security**
42+
43+
- chore(deps): bump word-wrap from 1.2.3 to 1.2.4 [\#682](https://github.com/auth0/react-native-auth0/pull/682) ([dependabot[bot]](https://github.com/apps/dependabot))
44+
- chore: Expand `.semgrepignore` exclusions to tests [\#679](https://github.com/auth0/react-native-auth0/pull/679) ([evansims](https://github.com/evansims))
45+
- chore(deps-dev): bump semver from 6.3.0 to 7.5.2 [\#657](https://github.com/auth0/react-native-auth0/pull/657) ([dependabot[bot]](https://github.com/apps/dependabot))
46+
347
## [v3.0.0-beta.3](https://github.com/auth0/react-native-auth0/tree/v3.0.0-beta.3) (2023-07-11)
448

549
[Full Changelog](https://github.com/auth0/react-native-auth0/compare/v3.0.0-beta.2...v3.0.0-beta.3)
@@ -16,7 +60,7 @@
1660

1761
**Added**
1862

19-
- \Credentials are returned as part of authorize methods in hooks
63+
- Credentials are returned as part of authorize methods in hooks
2064
- Added sample app in the repository
2165
- Expo plugin is updated to latest version
2266
- Added 'openid profile email' as mandatory scopes

README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,6 @@
77
[![Downloads][downloads-image]][downloads-url]
88
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fauth0%2Freact-native-auth0.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fauth0%2Freact-native-auth0?ref=badge_shield)
99

10-
| Exciting news! We have just released React Native Auth0 v3 BETA, packed with powerful features and improvements. [Check out the release for more details](https://github.com/auth0/react-native-auth0/releases/tag/v3.0.0-beta.2) |
11-
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
12-
1310
📚 [Documentation](#documentation) • 🚀 [Getting Started](#getting-started) • ⏭️ [Next Steps](#next-steps) • ❓ [FAQs](https://github.com/auth0/react-native-auth0/blob/master/FAQ.md) • ❓ [Feedback](#feedback)
1411

1512
## Documentation
@@ -43,11 +40,11 @@ First install the native library module:
4340

4441
### With [npm](https://www.npmjs.com)
4542

46-
`$ npm install react-native-auth0@v3-beta --save`
43+
`$ npm install react-native-auth0 --save`
4744

4845
### With [Yarn](https://yarnpkg.com/en/)
4946

50-
`$ yarn add react-native-auth0@v3-beta`
47+
`$ yarn add react-native-auth0`
5148

5249
Then, you need to run the following command to install the ios app pods with Cocoapods. That will auto-link the iOS library:
5350

docs/assets/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/classes/TimeoutError.html

Lines changed: 253 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -100,8 +100,8 @@ <h4>Hierarchy</h4>
100100
<li>
101101
Defined in
102102
<a
103-
href="https://github.com/auth0/react-native-auth0/blob/170164a/src/utils/fetchWithTimeout.ts#L3"
104-
>src/utils/fetchWithTimeout.ts:3</a
103+
href="https://github.com/auth0/react-native-auth0/blob/9b9ed243/src/utils/fetchWithTimeout.ts#L3"
104+
>utils/fetchWithTimeout.ts:3</a
105105
>
106106
</li>
107107
</ul>
@@ -239,8 +239,8 @@ <h4 class="tsd-returns-title">
239239
<li>
240240
Defined in
241241
<a
242-
href="https://github.com/auth0/react-native-auth0/blob/170164a/src/utils/fetchWithTimeout.ts#L4"
243-
>src/utils/fetchWithTimeout.ts:4</a
242+
href="https://github.com/auth0/react-native-auth0/blob/9b9ed243/src/utils/fetchWithTimeout.ts#L4"
243+
>utils/fetchWithTimeout.ts:4</a
244244
>
245245
</li>
246246
</ul>
@@ -490,6 +490,255 @@ <h3>
490490
><span>default</span></a
491491
>
492492
</li>
493+
<li>
494+
<a href="../interfaces/AuthorizeUrlOptions.html"
495+
><svg class="tsd-kind-icon" viewBox="0 0 24 24">
496+
<g id="icon-256">
497+
<rect
498+
fill="var(--color-icon-background)"
499+
stroke="var(--color-ts-interface)"
500+
stroke-width="1.5"
501+
x="1"
502+
y="1"
503+
width="22"
504+
height="22"
505+
rx="6"
506+
></rect>
507+
<path
508+
d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z"
509+
fill="var(--color-text)"
510+
></path>
511+
</g></svg
512+
><span>Authorize<wbr />Url<wbr />Options</span></a
513+
>
514+
</li>
515+
<li>
516+
<a href="../interfaces/ClearSessionOptions.html"
517+
><svg class="tsd-kind-icon" viewBox="0 0 24 24">
518+
<use href="#icon-256"></use></svg
519+
><span>Clear<wbr />Session<wbr />Options</span></a
520+
>
521+
</li>
522+
<li>
523+
<a href="../interfaces/ClearSessionParameters.html"
524+
><svg class="tsd-kind-icon" viewBox="0 0 24 24">
525+
<use href="#icon-256"></use></svg
526+
><span>Clear<wbr />Session<wbr />Parameters</span></a
527+
>
528+
</li>
529+
<li>
530+
<a href="../interfaces/CreateUserOptions.html"
531+
><svg class="tsd-kind-icon" viewBox="0 0 24 24">
532+
<use href="#icon-256"></use></svg
533+
><span>Create<wbr />User<wbr />Options</span></a
534+
>
535+
</li>
536+
<li>
537+
<a href="../interfaces/ExchangeNativeSocialOptions.html"
538+
><svg class="tsd-kind-icon" viewBox="0 0 24 24">
539+
<use href="#icon-256"></use></svg
540+
><span
541+
>Exchange<wbr />Native<wbr />Social<wbr />Options</span
542+
></a
543+
>
544+
</li>
545+
<li>
546+
<a href="../interfaces/ExchangeOptions.html"
547+
><svg class="tsd-kind-icon" viewBox="0 0 24 24">
548+
<use href="#icon-256"></use></svg
549+
><span>Exchange<wbr />Options</span></a
550+
>
551+
</li>
552+
<li>
553+
<a href="../interfaces/GetUserOptions.html"
554+
><svg class="tsd-kind-icon" viewBox="0 0 24 24">
555+
<use href="#icon-256"></use></svg
556+
><span>Get<wbr />User<wbr />Options</span></a
557+
>
558+
</li>
559+
<li>
560+
<a href="../interfaces/LoginWithEmailOptions.html"
561+
><svg class="tsd-kind-icon" viewBox="0 0 24 24">
562+
<use href="#icon-256"></use></svg
563+
><span>Login<wbr />With<wbr />Email<wbr />Options</span></a
564+
>
565+
</li>
566+
<li>
567+
<a href="../interfaces/LoginWithOOBOptions.html"
568+
><svg class="tsd-kind-icon" viewBox="0 0 24 24">
569+
<use href="#icon-256"></use></svg
570+
><span>Login<wbr />WithOOBOptions</span></a
571+
>
572+
</li>
573+
<li>
574+
<a href="../interfaces/LoginWithOTPOptions.html"
575+
><svg class="tsd-kind-icon" viewBox="0 0 24 24">
576+
<use href="#icon-256"></use></svg
577+
><span>Login<wbr />WithOTPOptions</span></a
578+
>
579+
</li>
580+
<li>
581+
<a href="../interfaces/LoginWithRecoveryCodeOptions.html"
582+
><svg class="tsd-kind-icon" viewBox="0 0 24 24">
583+
<use href="#icon-256"></use></svg
584+
><span
585+
>Login<wbr />With<wbr />Recovery<wbr />Code<wbr />Options</span
586+
></a
587+
>
588+
</li>
589+
<li>
590+
<a href="../interfaces/LoginWithSMSOptions.html"
591+
><svg class="tsd-kind-icon" viewBox="0 0 24 24">
592+
<use href="#icon-256"></use></svg
593+
><span>Login<wbr />WithSMSOptions</span></a
594+
>
595+
</li>
596+
<li>
597+
<a href="../interfaces/LogoutUrlOptions.html"
598+
><svg class="tsd-kind-icon" viewBox="0 0 24 24">
599+
<use href="#icon-256"></use></svg
600+
><span>Logout<wbr />Url<wbr />Options</span></a
601+
>
602+
</li>
603+
<li>
604+
<a href="../interfaces/MultifactorChallengeOptions.html"
605+
><svg class="tsd-kind-icon" viewBox="0 0 24 24">
606+
<use href="#icon-256"></use></svg
607+
><span>Multifactor<wbr />Challenge<wbr />Options</span></a
608+
>
609+
</li>
610+
<li>
611+
<a href="../interfaces/PasswordRealmOptions.html"
612+
><svg class="tsd-kind-icon" viewBox="0 0 24 24">
613+
<use href="#icon-256"></use></svg
614+
><span>Password<wbr />Realm<wbr />Options</span></a
615+
>
616+
</li>
617+
<li>
618+
<a href="../interfaces/PasswordlessWithEmailOptions.html"
619+
><svg class="tsd-kind-icon" viewBox="0 0 24 24">
620+
<use href="#icon-256"></use></svg
621+
><span
622+
>Passwordless<wbr />With<wbr />Email<wbr />Options</span
623+
></a
624+
>
625+
</li>
626+
<li>
627+
<a href="../interfaces/PasswordlessWithSMSOptions.html"
628+
><svg class="tsd-kind-icon" viewBox="0 0 24 24">
629+
<use href="#icon-256"></use></svg
630+
><span>Passwordless<wbr />WithSMSOptions</span></a
631+
>
632+
</li>
633+
<li>
634+
<a href="../interfaces/PatchUserOptions.html"
635+
><svg class="tsd-kind-icon" viewBox="0 0 24 24">
636+
<use href="#icon-256"></use></svg
637+
><span>Patch<wbr />User<wbr />Options</span></a
638+
>
639+
</li>
640+
<li>
641+
<a href="../interfaces/RefreshTokenOptions.html"
642+
><svg class="tsd-kind-icon" viewBox="0 0 24 24">
643+
<use href="#icon-256"></use></svg
644+
><span>Refresh<wbr />Token<wbr />Options</span></a
645+
>
646+
</li>
647+
<li>
648+
<a href="../interfaces/ResetPasswordOptions.html"
649+
><svg class="tsd-kind-icon" viewBox="0 0 24 24">
650+
<use href="#icon-256"></use></svg
651+
><span>Reset<wbr />Password<wbr />Options</span></a
652+
>
653+
</li>
654+
<li>
655+
<a href="../interfaces/RevokeOptions.html"
656+
><svg class="tsd-kind-icon" viewBox="0 0 24 24">
657+
<use href="#icon-256"></use></svg
658+
><span>Revoke<wbr />Options</span></a
659+
>
660+
</li>
661+
<li>
662+
<a href="../interfaces/UserInfoOptions.html"
663+
><svg class="tsd-kind-icon" viewBox="0 0 24 24">
664+
<use href="#icon-256"></use></svg
665+
><span>User<wbr />Info<wbr />Options</span></a
666+
>
667+
</li>
668+
<li>
669+
<a href="../interfaces/WebAuthorizeOptions.html"
670+
><svg class="tsd-kind-icon" viewBox="0 0 24 24">
671+
<use href="#icon-256"></use></svg
672+
><span>Web<wbr />Authorize<wbr />Options</span></a
673+
>
674+
</li>
675+
<li>
676+
<a href="../interfaces/WebAuthorizeParameters.html"
677+
><svg class="tsd-kind-icon" viewBox="0 0 24 24">
678+
<use href="#icon-256"></use></svg
679+
><span>Web<wbr />Authorize<wbr />Parameters</span></a
680+
>
681+
</li>
682+
<li>
683+
<a href="../types/Credentials.html"
684+
><svg class="tsd-kind-icon" viewBox="0 0 24 24">
685+
<g id="icon-4194304">
686+
<rect
687+
fill="var(--color-icon-background)"
688+
stroke="var(--color-ts-type-alias)"
689+
stroke-width="1.5"
690+
x="1"
691+
y="1"
692+
width="22"
693+
height="22"
694+
rx="6"
695+
></rect>
696+
<path
697+
d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z"
698+
fill="var(--color-text)"
699+
></path>
700+
</g></svg
701+
><span>Credentials</span></a
702+
>
703+
</li>
704+
<li>
705+
<a href="../types/MultifactorChallengeOOBResponse.html"
706+
><svg class="tsd-kind-icon" viewBox="0 0 24 24">
707+
<use href="#icon-4194304"></use></svg
708+
><span>Multifactor<wbr />ChallengeOOBResponse</span></a
709+
>
710+
</li>
711+
<li>
712+
<a
713+
href="../types/MultifactorChallengeOOBWithBindingResponse.html"
714+
><svg class="tsd-kind-icon" viewBox="0 0 24 24">
715+
<use href="#icon-4194304"></use></svg
716+
><span
717+
>Multifactor<wbr />ChallengeOOBWith<wbr />Binding<wbr />Response</span
718+
></a
719+
>
720+
</li>
721+
<li>
722+
<a href="../types/MultifactorChallengeOTPResponse.html"
723+
><svg class="tsd-kind-icon" viewBox="0 0 24 24">
724+
<use href="#icon-4194304"></use></svg
725+
><span>Multifactor<wbr />ChallengeOTPResponse</span></a
726+
>
727+
</li>
728+
<li>
729+
<a href="../types/MultifactorChallengeResponse.html"
730+
><svg class="tsd-kind-icon" viewBox="0 0 24 24">
731+
<use href="#icon-4194304"></use></svg
732+
><span>Multifactor<wbr />Challenge<wbr />Response</span></a
733+
>
734+
</li>
735+
<li>
736+
<a href="../types/User.html"
737+
><svg class="tsd-kind-icon" viewBox="0 0 24 24">
738+
<use href="#icon-4194304"></use></svg
739+
><span>User</span></a
740+
>
741+
</li>
493742
<li>
494743
<a href="../functions/Auth0Provider-1.html"
495744
><svg class="tsd-kind-icon" viewBox="0 0 24 24">

0 commit comments

Comments
 (0)