@verana-labs/vs-agent-sdk 2.0.0-dev.8 → 2.0.0-pr.767.1

package/build/utils/trustCredentialStore.d.ts

@@ -1,22 +1,91 @@
-import { DidRecord, W3cJsonLdVerifiableCredential, W3cJsonLdVerifiablePresentation } from '@credo-ts/core';
+import { DidRecord, W3cJsonLdVerifiableCredential, W3cJsonLdVerifiablePresentation, type W3cV2DataIntegritySecuredCredential, W3cV2DataIntegrityVerifiableCredential, W3cV2DataIntegrityVerifiablePresentation } from '@credo-ts/core';
 import { VsAgent } from '../agent/VsAgent';
-import { SelfTrDefaults } from './setupSelfTr';
+import { EcsClaims } from './ecsClaims';
+/**
+ * A trust credential the agent publishes from its DID Document: a VC Data Model 2.0 credential
+ * secured with a DataIntegrityProof, which is what the agent issues itself and receives over the
+ * RFC 0809 credential format, or a data model 1.1 credential carrying a linked data proof that an
+ * older issuer handed over.
+ */
+export type TrustCredential = W3cJsonLdVerifiableCredential | W3cV2DataIntegrityVerifiableCredential;
+export type TrustPresentation = W3cJsonLdVerifiablePresentation | W3cV2DataIntegrityVerifiablePresentation;
+/**
+ * Wraps a VC Data Model 2.0 credential in a data model 2.0 presentation secured with a
+ * DataIntegrityProof under the cryptosuite the agent is configured with, the counterpart of the
+ * linked data proof a data model 1.1 linked VP carries. The presentation is published from the DID
+ * Document rather than presented to a verifier, so there is no challenge to bind; its proof purpose
+ * is `authentication`, as Data Integrity defines for presentations.
+ */
+export declare function signLinkedDataIntegrityPresentation(agent: Pick<VsAgent, 'w3cV2Credentials' | 'context'>, options: {
+    id: string;
+    holder: string;
+    credential: W3cV2DataIntegrityVerifiableCredential;
+    verificationMethodId: string;
+}): Promise<W3cV2DataIntegrityVerifiablePresentation>;
 export declare function findMetadataEntry(didRecord: DidRecord, key: '_vt/vtc' | '_vt/jsc', id?: string, jsonSchemaRef?: string): any;
-export declare function saveMetadataEntry(agent: VsAgent, didRecord: DidRecord, credential: W3cJsonLdVerifiableCredential, verifiablePresentation: W3cJsonLdVerifiablePresentation, didDocumentServiceId: string, key: '_vt/vtc' | '_vt/jsc', publicApiBaseUrl: string): Promise<void>;
-export declare function deleteMetadataEntry(agent: VsAgent, id: string, didRecord: DidRecord, key: '_vt/vtc' | '_vt/jsc', publicApiBaseUrl: string): Promise<{
+export declare function saveMetadataEntry(agent: VsAgent, didRecord: DidRecord, credential: TrustCredential, verifiablePresentation: TrustPresentation, didDocumentServiceId: string, key: '_vt/vtc' | '_vt/jsc'): Promise<void>;
+export declare function deleteMetadataEntry(agent: VsAgent, id: string, didRecord: DidRecord, key: '_vt/vtc' | '_vt/jsc'): Promise<{
     schemaId: any;
 } | null>;
-export declare function createVtc(agent: VsAgent, publicApiBaseUrl: string, id: string, credential: W3cJsonLdVerifiableCredential): Promise<W3cJsonLdVerifiablePresentation>;
+export declare function createVtc(agent: VsAgent, publicApiBaseUrl: string, id: string, credential: TrustCredential): Promise<TrustPresentation>;
 export interface CreateJscOptions {
     schemaBaseId: string;
     jsonSchemaRef: string;
     precomputedDigestSRI?: string;
 }
-export declare function createJsc(agent: VsAgent, publicApiBaseUrl: string, ecsSchemas: Record<string, string>, options: CreateJscOptions): Promise<import("@credo-ts/core").W3cJsonCredential>;
-export declare function removeTrustCredential(agent: VsAgent, publicApiBaseUrl: string, schemaId: string, key: '_vt/jsc' | '_vt/vtc'): Promise<{
+export declare function createJsc(agent: VsAgent, publicApiBaseUrl: string, ecsSchemas: Record<string, string>, options: CreateJscOptions): Promise<W3cV2DataIntegritySecuredCredential & {
+    id: string;
+}>;
+export declare function removeTrustCredential(agent: VsAgent, schemaId: string, key: '_vt/jsc' | '_vt/vtc'): Promise<{
     schemaId: any;
 } | null>;
-export declare function removeStoredTrustCredential(agent: VsAgent, publicApiBaseUrl: string, credentialExchangeRecordId: string): Promise<string | undefined>;
+/**
+ * Removes the linked VP and the stored credential an exchange delivered, as
+ * [VSA-VTI-FLOW-OP-REVOKE] requires of the applicant. The credential is read from the RFC 0809
+ * format data of the exchange; exchanges earlier versions completed over other formats are not
+ * migrated. Returns the credential id, or `undefined` when none is found, in which case nothing is
+ * removed.
+ */
+export declare function removeStoredTrustCredential(agent: VsAgent, credentialExchangeRecordId: string): Promise<string | undefined>;
 export declare function migrateVtjscServiceIds(agent: VsAgent): Promise<void>;
+/**
+ * Takes the linked VPs of the given `_vt/jsc` entries out of the DID Document, publishing it once.
+ *
+ * The entries stay: `SelfTrController` serves them, and issued credentials name that URL in
+ * `credentialSchema.id`. Dropping one would 404 it and leave those credentials unverifiable.
+ */
+export declare function detachVtjscPublications(agent: VsAgent, schemaRefs: readonly string[]): Promise<string[]>;
+/**
+ * Puts a detached `_vt/jsc` entry back in the DID Document.
+ *
+ * The publication pass skips an entry whose digest still matches, so without this the agent would
+ * keep serving a VTJSC it never announces again.
+ */
+export declare function reattachVtjscPublication(agent: VsAgent, schemaRef: string): Promise<boolean>;
 export declare function getTrustMetadata(didRecord: DidRecord, key: '_vt/vtc' | '_vt/jsc', schemaId?: string): any;
-export declare function rebindEcsCredentialSchema(agent: VsAgent, publicApiBaseUrl: string, schemaId: string, schemaKey: string, defaults: SelfTrDefaults): Promise<void>;
+/**
+ * Stores the serialized SD-JWT VC Type Metadata of a VTJSC with its `_vt/jsc` entry, once. A
+ * stored document is never replaced: [VSA-PUB-VT-5] serves identical bytes while the schema exists.
+ * Returns false when the entry does not exist or already carries a document.
+ */
+export declare function saveVtjscTypeMetadata(agent: VsAgent, schemaRef: string, typeMetadata: string): Promise<boolean>;
+/**
+ * The stored Type Metadata of the `CredentialSchema` with the given on-chain id, as serialized.
+ * The `_vt/jsc` key of such a schema is `vpr:verana:{chainId}:cs:{id}`.
+ */
+export declare function findVtjscTypeMetadata(didRecord: DidRecord, chainId: string, credentialSchemaId: string): string | undefined;
+/**
+ * @param jsonSchemaCredentialId the VTJSC the Ecosystem published for this schema. Only the
+ * Ecosystem publishes it, so an agent that issues against another Corporation's Ecosystem must
+ * resolve it there — see resolveJsonSchemaCredentialId.
+ * @param issuerParticipantId this agent's ISSUER participant for the schema, which anchors the
+ * credential digest.
+ * @param schemaKey the ECS schema this agent issues against. Every ECS key is accepted; the caller
+ * reaches this function only for a schema the agent holds an active ISSUER entry on.
+ */
+export declare function rebindEcsCredentialSchema(agent: VsAgent, publicApiBaseUrl: string, schemaId: string, schemaKey: string, ecsClaims: EcsClaims, jsonSchemaCredentialId: string, issuerParticipantId: number, onChainJsonSchema?: string, effectiveUntil?: string): Promise<void>;
+/**
+ * Withdraws the ECS credentials anchored against `issuerParticipantId`, and the #whois entry
+ * when the Service credential is among them.
+ */
+export declare function withdrawSelfIssuedEcsCredentials(agent: VsAgent, issuerParticipantId: number): Promise<string[]>;