Openassetio-manager-bal

Breaking changes

- Refactored entity reference handling, resulting in a change to exception message formatting for malformed entity references.

- Migrated `entityExists` to the batch-first callback based signature.

- Entity references returned from `register` will now contain a version specifier in the `v=<version>` query parameter. [49](https://github.com/OpenAssetIO/OpenAssetIO-Manager-BAL/pull/49)

- Added a runtime dependency on the `openassetio-mediacreation` package.

- Added validation to API methods to error on unsupported access modes. [57](https://github.com/OpenAssetIO/OpenAssetIO-Manager-BAL/issues/57)

- Minimum OpenAssetIO version increased to v1.0.0-alpha.14 due to breaking API changes. [1054](https://github.com/OpenAssetIO/OpenAssetIO/issues/1054)

New features

- The entity reference scheme consumed by BAL can be adjusted from the default of `bal` using the `entity_reference_url_scheme` setting. This must be set to a simple alphanumeric string.

- Added support for retrieving specific versions using the `v=<version>` query parameter in a BAL entity reference. When publishing, `preflight` will remove any explicit version specifier (as it will always produce a new version), and `register` will return an entity reference with the version specifier for the newly created version. [49](https://github.com/OpenAssetIO/OpenAssetIO-Manager-BAL/pull/49)

- Added support for resolving the OpenAssetIO-MediaCreation `VersionTrait`. [49](https://github.com/OpenAssetIO/OpenAssetIO-Manager-BAL/pull/49)

- Added support for querying entity versions using the OpenAssetIO-MediaCreation `EntityVersionsRelationshipSpecification` and `StableEntityVersionsRelationshipSpecification` with `getWithRelationship`. If the `specifiedVersion` property of the `VersionTrait` is set, then a reference for that version will be returned. [49](https://github.com/OpenAssetIO/OpenAssetIO-Manager-BAL/pull/49)

Bug fixes

- Added missing fixtures for the `openassetio.test.manager` API compliance suite test harness. [61](https://github.com/OpenAssetIO/OpenAssetIO-Manager-BAL/pull/61)

Breaking Changes

- Minimum OpenAssetIO version increased to `v1.0.0-alpha.13` due to API changes.
- Refactored error handling. `BatchElementError` messages have been reformatted when a referenced entity is missing from the library.

New Features

- Added support for `getWithRelationship[s]Paged` paged relationship query API. [46](https://github.com/OpenAssetIO/OpenAssetIO-Manager-BAL/issues/46)

New Features

- Added capability to artificially delay `resolve`, `preflight`, `entityExists`, `register` and `getRelatedReferences` in order to better simulate real-world workflows and better test scalability. New setting `simulated_query_latency_ms` added, defaulting to 10ms. [38](https://github.com/OpenAssetIO/OpenAssetIO-Manager-BAL/issues/38)

Improvements

- Moved `openassetio` dependency out of python project (`pyproject.toml`) and instead have it as a `requirements.txt` dependency. OpenAssetIO should be provided by the environment, and BAL enforcing this as part of its install led to inflexibility. [31](https://github.com/OpenAssetIO/OpenAssetIO-Manager-BAL/issues/31)

Bug fixes

- The `$BAL_LIBRARY_PATH` environment variable is now correctly considered when the `library_path` setting is not set/empty. [26](https://github.com/OpenAssetIO/OpenAssetIO-Manager-BAL/issues/26)

New features

- Variables are now expanded in any string properties of an entity's traits. Expansion occurs during resolve to allow for variation in the environment between calls. Note: Only the `$var` and `${var}` syntax is supported. You can escape a literal `$` using `$$`. In addition to the environment, a library can define arbtirary variables under the top level `variables` key. BAL also provides several implicit variables of its own:
- `bal_library_path` The absolute path to the current library.
- `bal_library_dir` The absolute path to the directory containing the current library. [22](https://github.com/OpenAssetIO/OpenAssetIO-Manager-BAL/issues/22)