v3.7.0

Release Notes for did-resolver v3.7.0

Key changes

This release addresses feedback regarding the current state that dealing with DID-Linked Resources (DLR) typically requires two API calls:

1. One to resolve the DID Document and its metadata, which contains the DLR metadata too
2. One to fetch the resource itself
3. If just fetching a DLR, the DLR and DLR metadata need to be fetched separately

This release allows, for certain Accept header profiles, for both the DLR and its metadata to be fetched in a single call. We've also maintained backwards compatibility with current behaviour when no specific header is provided or DID Documents/DLRs fetched in the browser.

Supporting more granular ways of fetching DID Documents and DID-Linked Resources will offer developers greater control when fetching resolution/dereferencing results.

For DID Resolution

1. Accept: application/ld+json;profile="https://w3id.org/did-resolution": Returns DID Document + DID Document metadata with DID-Linked Resource metadata
2. Accept: application/did+json, application/did, or application/did+ld+json: Returns DID Document only, no DID Document metadata
3. Accept: */* or accessing via browser: → Returns DID Document + DID Document metadata with DID-Linked Resource metadata
4. Query parameter resourceMetadata=false: Returns DID Document + DID Document metadata without DID-Linked Resource metadata

For DID URL Dereferencing

1. Accept: application/ld+json;profile="https://w3id.org/did-url-dereferencing": Returns DID-Linked Resource (Base64-encoded) and its metadata in a single response
2. Accept: */*, specific Accept header (e.g., Accept: application/json), or accessing via browser: Keeps existing behaviour, returning only the DID-Linked Resource

General improvements

1. When specifying multiple acceptable values in Accept header, you can now use q values to prioritise preferred IANA media types in response and this will be respected.
2. If DID-Linked Resource queries are ambiguous, an invalidDidUrl error is now thrown instead of attempting to resolve to first matching DID-Linked Resource
3. DID-Linked Resource metadata is now consistently returned in contentMetadata rather than contentStream. Only the actual DID-Linked Resource, if requested in body in Base64-encoding, is returned in contentStream

What's Changed

• chore(deps): Bump golang.org/x/crypto from 0.23.0 to 0.31.0 in the go_modules group across 1 directory by @dependabot in #319
• chore(deps): Bump github.com/lestrrat-go/jwx from 1.2.29 to 1.2.30 by @dependabot in #308
• chore(deps): Bump github.com/go-resty/resty/v2 from 2.13.1 to 2.16.2 by @dependabot in #316
• chore(deps): Bump github.com/rs/zerolog from 1.32.0 to 1.33.0 by @dependabot in #307
• chore(deps-dev): Bump semantic-release from 24.1.0 to 24.2.0 by @dependabot in #313
• chore(deps): version upgrades [DEV-4716] by @sownak in #323
• build: Update direct protobuf pulsar API + Go version by @Eengineer1 in #333
• build(deps): cheqd-node/api v2.3.4-develop.1 by @ankurdotb in #335
• feat: DIDResolution header changes [DEV-4721] by @sownak in #336
• fix: Correct handling for metadata and resourceMetadata query params + other fixes [DEV-4758] by @DaevMithran in #340
• fix: resourceMetadata handing bugs [DEV-4759] by @sownak in #343
• test: Add did_doc w3iddidres tests [DEV-4761] by @DaevMithran in #346
• fix: Migrate resource metadata from contentStream to contentMetadata [DEV-4767] by @DaevMithran in #348
• fix: errors for ambiguous queries [DEV-4762] by @sownak in #347
• chore(deps): Bump google.golang.org/protobuf from 1.36.1 to 1.36.5 by @dependabot in #345

New Contributors

• @sownak made their first contribution in #323

Full Changelog: v3.6.2...v3.7.0

v3.7.0-develop.4

Release Notes for did-resolver v3.7.0-develop.4

What's Changed

• fix: errors for ambiguous queries [DEV-4762] by @sownak in #347

Full Changelog: v3.7.0-develop.3...v3.7.0-develop.4

v3.7.0-develop.3

Release Notes for did-resolver v3.7.0-develop.3

What's Changed

• test: Add did_doc w3iddidres tests [DEV-4761] by @DaevMithran in #346
• fix: Migrate resource metadata from contentStream to contentMetadata [DEV-4767] by @DaevMithran in #348

Full Changelog: v3.7.0-develop.2...v3.7.0-develop.3

v3.7.0-develop.2

Release Notes for did-resolver v3.7.0-develop.2

What's Changed

• fix: resourceMetadata handing bugs [DEV-4759] by @sownak in #343

Full Changelog: v3.7.0-develop.1...v3.7.0-develop.2

v3.7.0-develop.1

Release Notes for did-resolver v3.7.0-develop.1

What's Changed

• feat: DIDResolution header changes [DEV-4721] by @sownak in #336
• fix: Correct handling for metadata and resourceMetadata query params + other fixes [DEV-4758] by @DaevMithran in #340

Full Changelog: v3.6.3-develop.2...v3.7.0-develop.1

v3.6.3-develop.2

Release Notes for did-resolver v3.6.3-develop.2

What's Changed

• build(deps): cheqd-node/api v2.3.4-develop.1 by @ankurdotb in #335

Full Changelog: v3.6.3-develop.1...v3.6.3-develop.2

v3.6.3-develop.1

Release Notes for did-resolver v3.6.3-develop.1

What's Changed

• chore(deps): Bump golang.org/x/crypto from 0.23.0 to 0.31.0 in the go_modules group across 1 directory by @dependabot in #319
• chore(deps): Bump github.com/lestrrat-go/jwx from 1.2.29 to 1.2.30 by @dependabot in #308
• chore(deps): Bump github.com/go-resty/resty/v2 from 2.13.1 to 2.16.2 by @dependabot in #316
• chore(deps): Bump github.com/rs/zerolog from 1.32.0 to 1.33.0 by @dependabot in #307
• chore(deps-dev): Bump semantic-release from 24.1.0 to 24.2.0 by @dependabot in #313
• chore(deps): version upgrades [DEV-4716] by @sownak in #323
• build: Update direct protobuf pulsar API + Go version by @Eengineer1 in #333

New Contributors

• @sownak made their first contribution in #323

Full Changelog: v3.6.2...v3.6.3-develop.1

v3.6.2

Release Notes for did-resolver v3.6.2

What's Changed

• chore(deps): Bump golang.org/x/net from 0.22.0 to 0.23.0 in the go_modules group across 1 directory by @dependabot in #272
• chore(deps): Bump github.com/onsi/gomega from 1.32.0 to 1.33.0 by @dependabot in #274
• chore(deps): Bump github.com/labstack/echo/v4 from 4.11.4 to 4.12.0 by @dependabot in #273
• chore(dev-deps): Bump CI and release dependencies by @ankurdotb in #298
• chore(deps): Bump github/super-linter from 6 to 7 by @dependabot in #299
• chore(deps): Bump goreleaser/goreleaser-action from 5 to 6 by @dependabot in #291
• chore(deps): Bump golangci/golangci-lint-action from 4 to 6 by @dependabot in #282
• chore(deps): Bump github.com/go-resty/resty/v2 from 2.12.0 to 2.13.1 by @dependabot in #285
• fix: Fix jsonld errors in didDocument [DEV-4360] by @DaevMithran in #297
• chore(deps): Bump google.golang.org/protobuf from 1.33.0 to 1.34.2 by @dependabot in #292
• chore(deps): Bump ginkgo to v2.20.1, gomega to v1.34.1 by @ankurdotb in #303

Full Changelog: v3.6.1...v3.6.2

v3.6.2-develop.1

Release Notes for did-resolver v3.6.2-develop.1

What's Changed

• chore(deps): Bump golang.org/x/net from 0.22.0 to 0.23.0 in the go_modules group across 1 directory by @dependabot in #272
• chore(deps): Bump github.com/onsi/gomega from 1.32.0 to 1.33.0 by @dependabot in #274
• chore(deps): Bump github.com/labstack/echo/v4 from 4.11.4 to 4.12.0 by @dependabot in #273
• chore(dev-deps): Bump CI and release dependencies by @ankurdotb in #298
• chore(deps): Bump github/super-linter from 6 to 7 by @dependabot in #299
• chore(deps): Bump goreleaser/goreleaser-action from 5 to 6 by @dependabot in #291
• chore(deps): Bump golangci/golangci-lint-action from 4 to 6 by @dependabot in #282
• chore(deps): Bump github.com/go-resty/resty/v2 from 2.12.0 to 2.13.1 by @dependabot in #285
• fix: Fix jsonld errors in didDocument [DEV-4360] by @DaevMithran in #297

Full Changelog: v3.6.1...v3.6.2-develop.1

v3.6.1

Release Notes for did-resolver v3.6.1

What's Changed

• chore(deps): Bump github.com/go-resty/resty/v2 from 2.11.0 to 2.12.0 by @dependabot in #270
• chore(deps): Bump github.com/cheqd/cheqd-node/api/v2 from 2.2.0-develop.1 to 2.2.0 by @dependabot in #271

Full Changelog: v3.6.0...v3.6.1