@credo-ts/core
Version:
<p align="center"> <br /> <img alt="Credo Logo" src="https://github.com/openwallet-foundation/credo-ts/blob/c7886cb8377ceb8ee4efe8d264211e561a75072d/images/credo-logo.png" height="250px" /> </p> <h1 align="center"><b>Credo - Core</b></h1
85 lines • 3.26 kB
text/typescript
import { JsonObject, NonEmptyArray } from "../../../types.mjs";
import { ClaimPath } from "../../sd-jwt-vc/disclosureFrame.mjs";
import { CredentialMultiInstanceUseMode } from "../../../utils/credentialUseTypes.mjs";
import { SdJwtVcRecord } from "../../sd-jwt-vc/repository/SdJwtVcRecord.mjs";
import "../../sd-jwt-vc/index.mjs";
import { MdocRecord } from "../../mdoc/repository/MdocRecord.mjs";
import { MdocNameSpaces } from "../../mdoc/MdocOptions.mjs";
import "../../mdoc/index.mjs";
import { ClaimFormat } from "../../vc/models/ClaimFormat.mjs";
import { W3cCredentialRecord } from "../../vc/repository/W3cCredentialRecord.mjs";
import { W3cV2CredentialRecord } from "../../vc/repository/W3cV2CredentialRecord.mjs";
import "../../vc/index.mjs";
import "../../../utils/credentialUse.mjs";
//#region src/modules/dcql/models/DcqlCredentialsForRequest.d.ts
/**
* What to disclose of a selectively disclosable credential (SD-JWT VC, W3C V2 SD-JWT VC).
*/
export type DcqlSelectiveDisclosure = {
/**
* The paths to the claims to disclose, each with everything below it, as in `disclosed_paths` of a
* DCQL claim set.
*/
disclosedPaths: ClaimPath[];
/**
* Not used for the disclosure when `disclosedPaths` is given.
*/
disclosedPayload?: JsonObject;
} | {
disclosedPaths?: undefined;
/**
* @deprecated Pass `disclosedPaths`, which will be required in the next breaking version. Disclosing
* based on the payload selects an array as a whole, which does not disclose the elements that are
* selectively disclosable on their own.
*/
disclosedPayload: JsonObject;
};
/**
* Mapping of credential query IDs to the selected credential record and the disclosed payload.
*/
export type DcqlCredentialsForRequest = Record<string, NonEmptyArray<{
claimFormat: ClaimFormat.MsoMdoc;
credentialRecord: MdocRecord;
disclosedPayload: MdocNameSpaces;
/**
* @default {@link CredentialMultiInstanceUseMode.NewOrFirst}
*/
useMode?: CredentialMultiInstanceUseMode;
} | ({
claimFormat: ClaimFormat.SdJwtDc;
credentialRecord: SdJwtVcRecord;
/**
* Additional payload that will be added to the Key Binding JWT. This can overwrite
* existing parameters for KB-JWT so ensure you are only using this for non-default properties.
*/
additionalPayload?: JsonObject;
/**
* @default {@link CredentialMultiInstanceUseMode.NewOrFirst}
*/
useMode?: CredentialMultiInstanceUseMode;
} & DcqlSelectiveDisclosure) | {
claimFormat: ClaimFormat.JwtVc | ClaimFormat.LdpVc;
credentialRecord: W3cCredentialRecord;
disclosedPayload: JsonObject;
/**
* @default {@link CredentialMultiInstanceUseMode.NewOrFirst}
*/
useMode?: CredentialMultiInstanceUseMode;
} | {
claimFormat: ClaimFormat.JwtW3cVc;
credentialRecord: W3cV2CredentialRecord;
disclosedPayload: JsonObject;
/**
* @default {@link CredentialMultiInstanceUseMode.NewOrFirst}
*/
useMode?: CredentialMultiInstanceUseMode;
} | ({
claimFormat: ClaimFormat.SdJwtW3cVc;
credentialRecord: W3cV2CredentialRecord;
/**
* @default {@link CredentialMultiInstanceUseMode.NewOrFirst}
*/
useMode?: CredentialMultiInstanceUseMode;
} & DcqlSelectiveDisclosure)>>;
//#endregion
//# sourceMappingURL=DcqlCredentialsForRequest.d.mts.map