Skip to content

Commit c0168fe

Browse files
evansimsevansims
authored
Release 8.0.0-BETA3 (#555)
* Release 8.0.0-BETA3 * misc: Remove whitespace in PR template
1 parent eb759f8 commit c0168fe

File tree

5 files changed

+59
-4
lines changed

5 files changed

+59
-4
lines changed

‎.github/ISSUE_TEMPLATE/Bug Report.yml

+1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ body:
1111
label: SDK Version
1212
description: What version of our SDK are you running? (`composer show | grep auth0/auth0-php`)
1313
options:
14+
- 8.0.0-BETA3
1415
- 8.0.0-BETA2
1516
- 8.0.0-BETA1
1617
- 7.9.1

‎.github/PULL_REQUEST_TEMPLATE.md

-1
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,4 @@ Resolves #
2727
### Contributor Checklist
2828

2929
- [ ] I have read the [Auth0 general contribution guidelines](https://github.com/auth0/open-source-template/blob/master/GENERAL-CONTRIBUTING.md)
30-
3130
- [ ] I have read the [Auth0 Code of Conduct](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md)

‎CHANGELOG.md

+45
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,50 @@
11
# CHANGELOG
22

3+
## [8.0.0-BETA3](https://github.com/auth0/auth0-PHP/tree/8.0.0-BETA3) (2021-09-03)
4+
5+
[Full Changelog](https://github.com/auth0/auth0-PHP/compare/7.9.0...8.0.0-BETA3)
6+
7+
**BEFORE YOU UPGRADE**
8+
9+
- This is a major release that includes breaking changes. Please see [UPGRADE.md](UPGRADE.md) before upgrading. This release will require changes to your application.
10+
- The SDK no longer specifically relies on Guzzle for network requests. Options for supplying your libraries of choice have been added through [PSR-18](https://www.php-fig.org/psr/psr-18/) and [PSR-17](https://www.php-fig.org/psr/psr-17/) configuration options.
11+
- PHP 7.4 is now the minimum supported PHP version, but we encourage using PHP 8.0. PHP 7.4 will be the last supported 7.x release. This library follows [the official support schedule for PHP](https://www.php.net/supported-versions.php).
12+
13+
**Changes Since BETA2**
14+
15+
- Cookie namespace prefixes are now configurable from `SdkConfiguration` interface. [#534](https://github.com/auth0/auth0-PHP/pull/534) ([Nyholm](https://github.com/Nyholm))
16+
- Improvements to and standardization of variable filtering rules. [#535](https://github.com/auth0/auth0-PHP/pull/535) ([evansims](https://github.com/evansims))
17+
- Fixed Management API calls incorrectly converted child arrays into objects. [#541](https://github.com/auth0/auth0-PHP/pull/541) ([evansims](https://github.com/evansims))
18+
- Fixed explicit `SdkConfiguration` object reference passing on arguments. [#548](https://github.com/auth0/auth0-PHP/pull/548) ([Nyholm](https://github.com/Nyholm))
19+
- Performance improvements to session/cookie transient storage. [#542](https://github.com/auth0/auth0-PHP/pull/542) ([evansims](https://github.com/evansims))
20+
- Add new `MemoryStore` storage medium for tests. [#544](https://github.com/auth0/auth0-PHP/pull/544) ([Nyholm](https://github.com/Nyholm))
21+
- Add new `Psr6Store` storage medium. [#549](https://github.com/auth0/auth0-PHP/pull/549) ([Nyholm](https://github.com/Nyholm))
22+
- Delay restoring session state (no longer occurs during constructor initialization; now just-in-time.) [#550](https://github.com/auth0/auth0-PHP/pull/550) ([evansims](https://github.com/evansims))
23+
- Improve support for custom domains with new `customDomain` option in `SdkConfiguration` [#554](https://github.com/auth0/auth0-PHP/pull/554) ([evansims](https://github.com/evansims))
24+
- Support for Actions API endpoints in Management SDK [#551](https://github.com/auth0/auth0-PHP/pull/551) ([evansims](https://github.com/evansims))
25+
- Expand test coverage to 100% and transition to PEST test framework [#552](https://github.com/auth0/auth0-PHP/pull/552) ([evansims](https://github.com/evansims))
26+
27+
**8.0 Highlights**
28+
29+
- Updated SDK API for more intuitive use and improved usability. Now follows fluent interface principles.
30+
- Updated SDK API designed with PHP 8.0's named arguments as the encouraged interface method.
31+
- New configuration object, SdkConfiguration, allows for dynamic changes within your application.
32+
- Updated PHP language support, including typed properties and return types, are now used throughout the SDK.
33+
- Added support for the following PHP-FIG standards interfaces:
34+
- [PSR-6](https://www.php-fig.org/psr/psr-6/) caches are now used for caching JWKs and Management API tokens.
35+
- [PSR-7](https://www.php-fig.org/psr/psr-7/) HTTP messages are now returned by methods that initiate network requests.
36+
- [PSR-14](https://www.php-fig.org/psr/psr-14/) events are now raised, allowing for deeper integration into the SDK's behavior.
37+
- [PSR-17](https://www.php-fig.org/psr/psr-17/) HTTP factories are now used during network requests for generating PSR-7 messages.
38+
- [PSR-18](https://www.php-fig.org/psr/psr-18/) HTTP clients are now supported, allowing you to choose your network client.
39+
- Improved Token handling system.
40+
- Encrypted session cookies, with cookies being the default session handler. PHP sessions may be phased out in a future release.
41+
- New Management API auto-pagination helper for iterating through API results.
42+
- [PKCE](https://auth0.com/docs/flows/call-your-api-using-the-authorization-code-flow-with-pkce) is now enabled by default.
43+
44+
For a complete overview of API changes, please see [UPGRADE.md](UPGRADE.md).
45+
46+
For guidance on using the new configuration interface or SDK API, please see [README.md](README.md).
47+
348
## [8.0.0-BETA2](https://github.com/auth0/auth0-PHP/tree/8.0.0-BETA2) (2021-08-06)
449

550
[Full Changelog](https://github.com/auth0/auth0-PHP/compare/7.9.0...8.0.0-BETA2)

‎README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ To get started, you'll need to create a [free Auth0 account](https://auth0.com/s
5757
The supported method of SDK installation is through [Composer](https://getcomposer.org/). From your terminal shell, `cd` into your project directory and issue the following command:
5858

5959
```bash
60-
$ composer require auth0/auth0-php:8.0.0-BETA2
60+
$ composer require auth0/auth0-php:8.0.0-BETA3
6161
```
6262

6363
You can find guidance on installing Composer [here](https://getcomposer.org/doc/00-intro.md).
@@ -166,7 +166,8 @@ The following options are available for your configuration:
166166
| Option Name | Allowed Types | Required | Default | Description |
167167
| ----------------------- | ---------------------------------- | ---------------------- | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
168168
| `strategy` | `string` | | `webapp` | The type of application you are integrating the SDK for: `api` (for API-only uses, like authorizing endpoints), `management` (for uses where only the Management API endpoints will be used), or `webapp` (general use of all features) are allowed. The `strategy` determines what types of configuration options will be required at initialization. See the `required` column of this table to decide what configuration options you should be passing at initialization for your use case. |
169-
| `domain` | `string`,`null` | `api`, `webapp` | `null` | Domain, found in your Auth0 Application settings. |
169+
| `domain` | `string`,`null` | `api`, `webapp` | `null` | Your Auth0 tenant domain, found in your Auth0 Application settings. |
170+
| `customDomain` | `string`,`null` | | `null` | If you have configured Auth0 to use a custom domain, you should also configure it here. |
170171
| `clientId` | `string`,`null` | `management`, `webapp` | `null` | Client ID, found in the Auth0 Application settings. |
171172
| `clientSecret` | `string`,`null` | `webapp` | `null` | Client Secret, found in the Auth0 Application settings. |
172173
| `audience` | `array<string>`,`null` | `api` | `null` | One or more API identifiers, found in your Auth0 API settings. The SDK uses the first value for building links. If provided, at least one of these values must match the 'aud' claim to validate an ID Token successfully. When no audiene is specified, the `clientId` will be used to verify `aud` claims. |

‎UPGRADE.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Our version 8 release includes many significant improvements:
66

77
- Adoption of [modern PHP language features](https://stitcher.io/blog/new-in-php-74) including typed properties, null coalescing assignment operators, and array spreading.
88
- Support for custom [PSR-18](https://www.php-fig.org/psr/psr-18/) and [PSR-17](https://www.php-fig.org/psr/psr-17/) factories for customizing network requests. [PSR-7](https://www.php-fig.org/psr/psr-7/) responses are also now returned throughout the SDK.
9-
- The codebase has been streamlined, offering a cleaner API and improved performance.
9+
- [PSR-4](https://www.php-fig.org/psr/psr-4/) event hooks are now supported throughout the SDK.
1010
- [Fluent interface](https://en.wikipedia.org/wiki/Fluent_interface#PHP) throughout the SDK, offering simplified usage.
1111
- Optional auto-pagination of Management API endpoints that support pagination.
1212
- [PKCE](https://auth0.com/docs/flows/call-your-api-using-the-authorization-code-flow-with-pkce) is now enabled by default.
@@ -20,6 +20,10 @@ As is to be expected with a major release, there are breaking changes in this up
2020
- 7.4 will be the final release in PHP's 7.x branch. This SDK will only support PHP 8.0+ after 7.4 leaves [supported status](https://www.php.net/supported-versions.php) in November 2022.
2121
- We strongly encourage you to make use of PHP 8.0's new [named arguments language feature](https://stitcher.io/blog/php-8-named-arguments). Once 7.4 support ends, we will no longer consider method argument order changes to be a breaking change.
2222

23+
### Session Storage Chan ges Require User Reauthentication
24+
25+
The new default session storage medium in 8.0 are encrypted cookies. Upgrading to 8.0 from 7.x will require your application's users to re-authenticate.
26+
2327
### Class and Method Changes
2428

2529
### Potentially Breaking Changes
@@ -132,6 +136,11 @@ These classes were updated in SDK 8.0:
132136
- Public method 'getHttpClient()' added.
133137
- Public method `getResponsePaginator()` added.
134138

139+
- Class `Auth0\SDK\API\Management\Tenants` updated:
140+
141+
- Public method `get` renamed to `getSettings`.
142+
- Public method `update` renamed to `updateSettings`.
143+
135144
- Class `Auth0\SDK\API\Management\GenericResource` renamed to `Auth0\SDK\API\Management\ManagementEndpoint`, and:
136145

137146
- Constructor updated to require an `HttpClient` instance; previously expected an `ApiClient` instance.

0 commit comments

Comments
 (0)