@sphereon/ssi-sdk.vc-status-list 0.33.1-feature.vcdm2.tsup.32 → 0.33.1-next.3

package/dist/index.d.ts

@@ -1,275 +1,5 @@
-import { IIdentifierResolution } from '@sphereon/ssi-sdk-ext.identifier-resolution';
-import { StatusListIndexingDirection, StatusPurpose2021, StatusListType, IIssuer, ProofFormat, StatusListDriverType, StatusListCredential, StatusListCredentialIdMode, ICredentialStatus, OrPromise, ICredential, IVerifiableCredential } from '@sphereon/ssi-types';
-import { IPluginMethodMap, IAgentContext, ICredentialIssuer, ICredentialVerifier, IKeyManager, ICredentialPlugin, CredentialPayload } from '@veramo/core';
-import { DataSource } from 'typeorm';
-import { BitsPerStatus } from '@sd-jwt/jwt-status-list';
-import { SdJwtVcPayload } from '@sd-jwt/sd-jwt-vc';
-import { StatusListOpts } from '@sphereon/oid4vci-common';
-import { StatusMethod } from 'credential-status';
-
-declare enum StatusOAuth {
-    Valid = 0,
-    Invalid = 1,
-    Suspended = 2
-}
-declare enum Status2021 {
-    Valid = 0,
-    Invalid = 1
-}
-type StatusList2021Args = {
-    indexingDirection: StatusListIndexingDirection;
-    statusPurpose?: StatusPurpose2021;
-};
-type OAuthStatusListArgs = {
-    bitsPerStatus?: BitsPerStatus;
-    expiresAt?: Date;
-};
-type BaseCreateNewStatusListArgs = {
-    type: StatusListType;
-    id: string;
-    issuer: string | IIssuer;
-    correlationId?: string;
-    length?: number;
-    proofFormat?: ProofFormat;
-    keyRef?: string;
-    statusList2021?: StatusList2021Args;
-    oauthStatusList?: OAuthStatusListArgs;
-    driverType?: StatusListDriverType;
-};
-type UpdateStatusList2021Args = {
-    statusPurpose: StatusPurpose2021;
-};
-type UpdateOAuthStatusListArgs = {
-    bitsPerStatus: BitsPerStatus;
-    expiresAt?: Date;
-};
-interface UpdateStatusListFromEncodedListArgs {
-    type?: StatusListType;
-    statusListIndex: number | string;
-    value: boolean;
-    proofFormat?: ProofFormat;
-    keyRef?: string;
-    correlationId?: string;
-    encodedList: string;
-    issuer: string | IIssuer;
-    id: string;
-    statusList2021?: UpdateStatusList2021Args;
-    oauthStatusList?: UpdateOAuthStatusListArgs;
-}
-interface UpdateStatusListFromStatusListCredentialArgs {
-    statusListCredential: StatusListCredential;
-    keyRef?: string;
-    statusListIndex: number | string;
-    value: number | Status2021 | StatusOAuth;
-}
-interface StatusListResult {
-    encodedList: string;
-    statusListCredential: StatusListCredential;
-    length: number;
-    type: StatusListType;
-    proofFormat: ProofFormat;
-    id: string;
-    statuslistContentType: string;
-    issuer: string | IIssuer;
-    statusList2021?: StatusList2021Details;
-    oauthStatusList?: OAuthStatusDetails;
-    correlationId?: string;
-    driverType?: StatusListDriverType;
-    credentialIdMode?: StatusListCredentialIdMode;
-}
-interface StatusList2021Details {
-    indexingDirection: StatusListIndexingDirection;
-    statusPurpose?: StatusPurpose2021;
-}
-interface OAuthStatusDetails {
-    bitsPerStatus?: BitsPerStatus;
-    expiresAt?: Date;
-}
-interface StatusList2021EntryCredentialStatus extends ICredentialStatus {
-    type: 'StatusList2021Entry';
-    statusPurpose: StatusPurpose2021;
-    statusListIndex: string;
-    statusListCredential: string;
-}
-interface StatusListOAuthEntryCredentialStatus extends ICredentialStatus {
-    type: 'OAuthStatusListEntry';
-    bitsPerStatus: number;
-    statusListIndex: string;
-    statusListCredential: string;
-    expiresAt?: Date;
-}
-interface StatusList2021ToVerifiableCredentialArgs {
-    issuer: string | IIssuer;
-    id: string;
-    type?: StatusListType;
-    proofFormat?: ProofFormat;
-    keyRef?: string;
-    encodedList: string;
-    statusPurpose: StatusPurpose2021;
-}
-interface CreateStatusListArgs {
-    issuer: string | IIssuer;
-    id: string;
-    proofFormat?: ProofFormat;
-    keyRef?: string;
-    correlationId?: string;
-    length?: number;
-    statusList2021?: StatusList2021Args;
-    oauthStatusList?: OAuthStatusListArgs;
-}
-interface UpdateStatusListIndexArgs {
-    statusListCredential: StatusListCredential;
-    statusListIndex: number | string;
-    value: number | Status2021 | StatusOAuth;
-    keyRef?: string;
-    expiresAt?: Date;
-}
-interface CheckStatusIndexArgs {
-    statusListCredential: StatusListCredential;
-    statusListIndex: string | number;
-}
-interface ToStatusListDetailsArgs {
-    statusListPayload: StatusListCredential;
-    correlationId?: string;
-    driverType?: StatusListDriverType;
-}
 /**
- * The interface definition for a plugin that can add statuslist info to a credential
- *
- * @remarks Please see {@link https://www.w3.org/TR/vc-data-model | W3C Verifiable Credentials data model}
- *
- * @beta This API is likely to change without a BREAKING CHANGE notice
  */
-interface IStatusListPlugin extends IPluginMethodMap {
-    /**
-     * Create a new status list
-     *
-     * @param args Status list information like type and size
-     * @param context - This reserved param is automatically added and handled by the framework, *do not override*
-     *
-     * @returns - The details of the newly created status list
-     */
-    slCreateStatusList(args: CreateNewStatusListArgs, context: IRequiredContext): Promise<StatusListResult>;
-    /**
-     * Ensures status list info like index and list id is added to a credential
-     *
-     * @param args - Arguments necessary to add the statuslist info.
-     * @param context - This reserved param is automatically added and handled by the framework, *do not override*
-     *
-     * @returns - a promise that resolves to the credential now with status support
-     *
-     * @beta This API is likely to change without a BREAKING CHANGE notice
-     */
-    slAddStatusToCredential(args: IAddStatusToCredentialArgs, context: IRequiredContext): Promise<CredentialWithStatusSupport>;
-    slAddStatusToSdJwtCredential(args: IAddStatusToSdJwtCredentialArgs, context: IRequiredContext): Promise<SdJwtVcPayload>;
-    /**
-     * Get the status list using the configured driver for the SL. Normally a correlationId or id should suffice. Optionally accepts a dbName/datasource
-     * @param args
-     * @param context
-     */
-    slGetStatusList(args: GetStatusListArgs, context: IRequiredContext): Promise<StatusListResult>;
-    /**
-     * Import status lists when noy yet present
-     *
-     * @param imports Array of status list information like type and size
-     * @param context - This reserved param is automatically added and handled by the framework, *do not override*
-     */
-    slImportStatusLists(imports: Array<CreateNewStatusListArgs>, context: IRequiredContext): Promise<boolean>;
-}
-type CreateNewStatusListFuncArgs = BaseCreateNewStatusListArgs;
-type CreateNewStatusListArgs = BaseCreateNewStatusListArgs & {
-    dbName?: string;
-    dataSource?: OrPromise<DataSource>;
-    isDefault?: boolean;
-};
-type IAddStatusToCredentialArgs = Omit<IIssueCredentialStatusOpts, 'dataSource'> & {
-    credential: CredentialWithStatusSupport;
-};
-type IAddStatusToSdJwtCredentialArgs = Omit<IIssueCredentialStatusOpts, 'dataSource'> & {
-    credential: SdJwtVcPayload;
-};
-interface IIssueCredentialStatusOpts {
-    dataSource?: DataSource;
-    statusLists?: Array<StatusListOpts>;
-    credentialId?: string;
-    value?: string;
-}
-type GetStatusListArgs = {
-    id?: string;
-    correlationId?: string;
-    dataSource?: OrPromise<DataSource>;
-    dbName?: string;
-};
-type CredentialWithStatusSupport = ICredential | CredentialPayload | IVerifiableCredential;
-type SignedStatusListData = {
-    statusListCredential: StatusListCredential;
-    encodedList: string;
-};
-type IRequiredPlugins = ICredentialPlugin & IIdentifierResolution;
-type IRequiredContext = IAgentContext<ICredentialIssuer & ICredentialVerifier & IIdentifierResolution & IKeyManager & ICredentialPlugin>;
-
-declare function fetchStatusListCredential(args: {
-    statusListCredential: string;
-}): Promise<StatusListCredential>;
-declare function statusPluginStatusFunction(args: {
-    documentLoader: any;
-    suite: any;
-    mandatoryCredentialStatus?: boolean;
-    verifyStatusListCredential?: boolean;
-    verifyMatchingIssuers?: boolean;
-    errorUnknownListType?: boolean;
-}): StatusMethod;
-/**
- * Function that can be used together with @digitalbazar/vc and @digitialcredentials/vc
- * @param args
- */
-declare function vcLibCheckStatusFunction(args: {
-    mandatoryCredentialStatus?: boolean;
-    verifyStatusListCredential?: boolean;
-    verifyMatchingIssuers?: boolean;
-    errorUnknownListType?: boolean;
-}): (args: {
-    credential: StatusListCredential;
-    documentLoader: any;
-    suite: any;
-}) => Promise<{
-    verified: boolean;
-    error?: any;
-}>;
-declare function checkStatusForCredential(args: {
-    credential: StatusListCredential;
-    documentLoader: any;
-    suite: any;
-    mandatoryCredentialStatus?: boolean;
-    verifyStatusListCredential?: boolean;
-    verifyMatchingIssuers?: boolean;
-    errorUnknownListType?: boolean;
-}): Promise<{
-    verified: boolean;
-    error?: any;
-}>;
-declare function simpleCheckStatusFromStatusListUrl(args: {
-    statusListCredential: string;
-    statusPurpose?: StatusPurpose2021;
-    type?: StatusListType | 'StatusList2021Entry';
-    id?: string;
-    statusListIndex: string;
-}): Promise<number | Status2021 | StatusOAuth>;
-declare function checkStatusIndexFromStatusListCredential(args: {
-    statusListCredential: StatusListCredential;
-    statusPurpose?: StatusPurpose2021;
-    type?: StatusListType | 'StatusList2021Entry';
-    id?: string;
-    statusListIndex: string | number;
-}): Promise<number | Status2021 | StatusOAuth>;
-declare function createNewStatusList(args: CreateNewStatusListFuncArgs, context: IAgentContext<ICredentialPlugin & IIdentifierResolution>): Promise<StatusListResult>;
-declare function updateStatusIndexFromStatusListCredential(args: UpdateStatusListIndexArgs, context: IAgentContext<ICredentialPlugin & IIdentifierResolution>): Promise<StatusListResult>;
-declare function statusListCredentialToDetails(args: {
-    statusListCredential: StatusListCredential;
-    correlationId?: string;
-    driverType?: StatusListDriverType;
-}): Promise<StatusListResult>;
-declare function updateStatusListIndexFromEncodedList(args: UpdateStatusListFromEncodedListArgs, context: IAgentContext<ICredentialPlugin & IIdentifierResolution>): Promise<StatusListResult>;
-declare function statusList2021ToVerifiableCredential(args: StatusList2021ToVerifiableCredentialArgs, context: IAgentContext<ICredentialPlugin & IIdentifierResolution>): Promise<StatusListCredential>;
-
-export { type BaseCreateNewStatusListArgs, type CheckStatusIndexArgs, type CreateNewStatusListArgs, type CreateNewStatusListFuncArgs, type CreateStatusListArgs, type CredentialWithStatusSupport, type GetStatusListArgs, type IAddStatusToCredentialArgs, type IAddStatusToSdJwtCredentialArgs, type IIssueCredentialStatusOpts, type IRequiredContext, type IRequiredPlugins, type IStatusListPlugin, type OAuthStatusListArgs, type SignedStatusListData, Status2021, type StatusList2021Args, type StatusList2021EntryCredentialStatus, type StatusList2021ToVerifiableCredentialArgs, type StatusListOAuthEntryCredentialStatus, type StatusListResult, StatusOAuth, type ToStatusListDetailsArgs, type UpdateOAuthStatusListArgs, type UpdateStatusList2021Args, type UpdateStatusListFromEncodedListArgs, type UpdateStatusListFromStatusListCredentialArgs, type UpdateStatusListIndexArgs, checkStatusForCredential, checkStatusIndexFromStatusListCredential, createNewStatusList, fetchStatusListCredential, simpleCheckStatusFromStatusListUrl, statusList2021ToVerifiableCredential, statusListCredentialToDetails, statusPluginStatusFunction, updateStatusIndexFromStatusListCredential, updateStatusListIndexFromEncodedList, vcLibCheckStatusFunction };
+export * from './types';
+export * from './functions';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;GACG;AAEH,cAAc,SAAS,CAAA;AACvB,cAAc,aAAa,CAAA"}