Skip to content

docs(0.2.0): document UnmatchedReason values + fix supported versions table #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BetelGuese merged 1 commit into from
Jul 9, 2026
Merged

docs(0.2.0): document UnmatchedReason values + fix supported versions table #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,22 @@ Validates the shape of a DCQL query. Throws `DcqlValidationError` with a `code`

Finds credentials that satisfy each query. Returns `{ satisfied, matches, unmatched }`. Never throws.

Each entry in `unmatched` carries an `UnmatchedReason`:

| Reason | Meaning |
| --- | --- |
| `format_mismatch` | candidate's `format` did not equal the query's `format` |
| `vct_mismatch` | candidate's `vct` was not in the query's `meta.vct_values` (sd-jwt-vc only) |
| `doctype_mismatch` | candidate's `doctype` was not equal to the query's `meta.doctype_value` (mso_mdoc only) |
| `missing_claims` | candidate is missing one or more claim paths required by the query |
| `value_mismatch` | a required claim is present but its value is not in the query's `values:` filter |
| `trusted_authority_mismatch` | none of the candidate's `trusted_authority_ids` are in the query's `trusted_authorities` filter |
| `no_credential_found` | the candidate credentials list was empty for this query (reserved for the empty-input case only since 0.2.0) |

When a query has multiple candidate credentials, `matchQuery` reports the LAST candidate's failure (DCQL does not specify candidate ordering — see the `matchQuery` JSDoc for details).

> **0.2.0 BREAKING:** prior to 0.2.0 every failure collapsed to `'no_credential_found'`. Callers reading `unmatched[].reason` need to switch on the new specific values.

### `buildSubmission(query: DcqlQuery, result: DcqlMatchResult): DcqlSubmission`

Builds a spec-shaped `{ [queryId]: credentialId | credentialId[] }` map. Throws `DcqlMatchError` if the result is not satisfied.
Expand Down
3 changes: 2 additions & 1 deletion SECURITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@

| Version | Supported |
| ------- | --------- |
| 0.1.x | Yes |
| 0.2.x | Yes |
| 0.1.x | No (superseded by 0.2.0; 0.2.0 is BREAKING — see CHANGELOG) |

Only the latest release receives security updates.

Expand Down
16 changes: 16 additions & 0 deletions src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,29 @@ export type DecodedCredential = {
trusted_authority_ids?: string[];
};

/**
* Reason a query did not match against the supplied credentials.
*
* Returned per-query in `DcqlMatchResult.unmatched[].reason`. When a query has
* multiple candidate credentials, `matchQuery` reports the LAST candidate's
* failure (DCQL does not specify candidate ordering — see `matchQuery` JSDoc).
*
* @see {@link matchQuery}
*/
export type UnmatchedReason =
/** The candidate credentials list was empty for this query. */
| 'no_credential_found'
/** Candidate's `format` did not equal the query's `format`. */
| 'format_mismatch'
/** Candidate's `vct` was not in the query's `meta.vct_values` (sd-jwt-vc only). */
| 'vct_mismatch'
/** Candidate's `doctype` was not equal to the query's `meta.doctype_value` (mso_mdoc only). */
| 'doctype_mismatch'
/** Candidate is missing one or more claim paths required by the query. */
| 'missing_claims'
/** A required claim is present, but its value is not in the query's `values:` filter. */
| 'value_mismatch'
/** None of the candidate's `trusted_authority_ids` are in the query's `trusted_authorities` filter. */
| 'trusted_authority_mismatch';

export type DcqlMatchResult = {
Expand Down