@learncard/vc-plugin 1.5.12 → 1.6.0

package/src/types.ts

@@ -6,6 +6,7 @@ import {
     VerificationCheck,
     DidDocument,
     JWKWithPrivateKey,
+    CredentialRefreshResult,
 } from '@learncard/types';
 import { Plugin, LearnCard } from '@learncard/core';
 import { ProofOptions, InputMetadata } from '@learncard/didkit-plugin';
@@ -53,6 +54,41 @@ export type VCPluginMethods = {
     getTestVc: (subject?: string) => UnsignedVC;
     getTestVp: (credential?: VC) => Promise<UnsignedVP>;
     getDidAuthVp: (options?: ProofOptions) => Promise<VP | string>;
+    refreshCredential: (
+        credential: VC,
+        options?: RefreshCredentialOptions
+    ) => Promise<CredentialRefreshResult>;
+};
+
+/**
+ * Options for the generic holder-side credential refresh primitive.
+ *
+ * @group VC Plugin
+ */
+export type RefreshCredentialOptions = {
+    /** Previously seen ETag validator for the credential; sent as `If-None-Match` */
+    etag?: string;
+    /** Per-request timeout in milliseconds (default 10_000) */
+    timeoutMs?: number;
+    /** Maximum number of followed redirects (default 3) */
+    maxRedirects?: number;
+    /** Maximum accepted response size in bytes (default 1 MiB) */
+    maxResponseBytes?: number;
+    /**
+     * Explicit local-development opt-in allowing plain-HTTP endpoints. HTTPS is required
+     * unless this is set.
+     */
+    allowInsecureHttp?: boolean;
+    /**
+     * Explicit local-development opt-in allowing private, loopback, or link-local
+     * endpoint addresses. Never enable this for credentials from untrusted issuers.
+     */
+    allowPrivateAddresses?: boolean;
+    /**
+     * Hostname resolution override used for SSRF checks. Defaults to Node's DNS resolver
+     * in Node runtimes; browsers skip DNS resolution and reject only unsafe host literals.
+     */
+    resolveHost?: (hostname: string) => Promise<string[]>;
 };
 
 /** @group VC Plugin */

package/src/vc.ts

@@ -2,6 +2,7 @@ import { issueCredential } from './issueCredential';
 import { verifyCredential } from './verifyCredential';
 import { issuePresentation } from './issuePresentation';
 import { verifyPresentation } from './verifyPresentation';
+import { refreshCredential } from './refreshCredential';
 
 import { VCDependentLearnCard, VCPlugin } from './types';
 import { UnsignedVP } from '@learncard/types';
@@ -20,6 +21,7 @@ export const getVCPlugin = (learnCard: VCDependentLearnCard): VCPlugin => {
             verifyCredential: verifyCredential(learnCard),
             issuePresentation: issuePresentation(learnCard),
             verifyPresentation: verifyPresentation(learnCard),
+            refreshCredential: refreshCredential(learnCard),
             getTestVc: (_learnCard, subject = 'did:example:d23dd687a7dc6787646f2eb98d0') => {
                 const did = _learnCard.id.did();