Auraxium

Changes

- `auraxium.Client.get_by_name()` now supports looking up `ps2.World` name instance (see 66)
- Extraneous fields are now ignored as part of payload validation. No warning is emitted for this in client code
- The deprecation of the legacy utility methods `Ps2Object.get_*()` has been pushed back to Version 0.4
- Team ID has been added for the `Death` and `VehicleDestroy` ESS payloads (see 69)

Fixes

- Dummy URLs generated as part of error messages no longer trigger default service ID warnings
- Addressed several issues related to documentation accuracy and unresolved references
- Fixed optional ESS payload arguments not defaulting for newer versions of Pydantic

Known issues

- The `auraxium.types.CensusData` type alias is not resolvable in the Docs as part of function signatures

- Fixed error when manually defining event stream triggers defined with string event names and world ID filters and applied (66, 67).
- Fixed ESS `Trigger` instances not auto-inserting `logicalAndCharactersWithWorlds=true` for custom `GainExperience` event filters.
- Removed code and documentation references to the removed `ContinentUnlock` ESS event.
- The `Weapon.datasheet()` and `Item.datasheet()` now return `None` for missing records rather than throwing `NotFoundError`.

This version addresses several issues related to recent API changes, as well as a number of performance and bugfixes.

Features

- Experimental support for third-party endpoints has been introduced to the REST and WSS endpoints (57)
Note that these endpoints are currently still compared against the API spec of the Census, making this support limited to endpoints that exactly mirror the DBG Census. Larger fixes to support custom endpoints and data types seamlessly is planned, proper documentation will be created once this has been established.

Example for REST clients with endpoint fall-through

All requests will first be made to the first entry in the list, then fail over to the next one on error.

py
DBG_CENSUS = 'http://census.daybreakgames.com'
FALLBACK_ENDPOINT = 'https://my.custom.endpoint.xyz'

async with auraxium.Client(endpoints=[DBG_CENSUS, FALLBACK_ENDPOINT]) as client:
...


Example for ESS clients (only 1 endpoint supported)

Known working endpoints are available in the `auraxium.endpoints` namespace.

py
import auraxium
from auraxium import event
from auraxium.endpoints import NANITE_SYSTEMS

async def main():
async with auraxium.EventClient(ess_endpoint=NANITE_SYSTEMS) as client:
...


Fixes

- Resolved an issue with the `Character.items()` helper when accessing internal/removed items for which no `Item` type exists (58)
- `Client.get_by_name(ps2.Character, 'Higby')` will now target the `character.name.first_lower` field instead of using a case-insensitive query (61)
- Added guard against spurious errors on shutdown on Python <3.11 (60)

This version temporarily rolls back the API SSL certificate expiration test bypass while a long-term solution is worked on.

- Disabled the `no_ssl_certs` parameter (see 56)

Client code using the above parameter will see a `FutureWarning` to inform them that it has no effect in this version. No modification to client code is required at this point and the warning may be ignored.

This version introduces a workaround for the PS2 API occasionally letting its SSL certifications expire, which would cause SSL verifications errors when attempting to use the `auraxium.EventClient` websocket.

- Introduced the `no_ssl_certs` field to allow disabling SSL verification (see 55)

The above flag can be used as follows to use the ESS client even when the SSL certs are expired:
py
client = event.EventClient(service_id='s:example', no_ssl_certs=True)

Minor fix to address the `websockets` version being pinned to 8.1.