@learncard/helpers 1.5.0 → 1.6.0

package/dist/credential-refresh.d.ts

@@ -1,4 +1,4 @@
-import { type SupportedCredentialRefreshService } from '@learncard/types';
+import { type ManagedCredentialRefreshService, type SupportedCredentialRefreshService } from '@learncard/types';
 /**
  * Canonical helpers for credential refresh (LC-2117, LC-2135, LC-2136).
  *
@@ -47,6 +47,63 @@ export declare const getCredentialEffectiveTime: (vc: RefreshableCredential) =>
 export declare const canonicalizeCredentialContent: <T>(value: T) => T;
 /** Serializes a value to a deterministic canonical JSON string */
 export declare const canonicalizeCredentialJson: (value: unknown) => string;
+/** IRI the managed refresh service type term must resolve to. */
+export declare const MANAGED_REFRESH_TYPE_IRI = "https://learncard.com/refresh#LearnCardCredentialRefresh2026";
+/** OBv3-namespaced IRI for the authorization term of a managed refresh service. */
+export declare const MANAGED_REFRESH_AUTHORIZATION_IRI = "https://purl.imsglobal.org/spec/ob/v3p0#authorization";
+/** IRI for the LearnCard DID-auth scheme of a managed refresh service. */
+export declare const MANAGED_REFRESH_DID_AUTH_IRI = "https://docs.learncard.com/definitions#LearnCardDIDAuth";
+/**
+ * Inline JSON-LD context fragment required to sign credentials carrying a
+ * LearnCard-managed `LearnCardCredentialRefresh2026` refresh service.
+ *
+ * Neither VCDM 1.1 (which defines only `ManualRefreshService2018`), VCDM 2.0, nor the
+ * live OBv3/CLR contexts define the term `LearnCardCredentialRefresh2026` (nor the
+ * LearnCard `authorization` / `LearnCardDIDAuth` extension terms), so DIDKit's
+ * data-loss detection refuses to sign unless issuers define these terms inline.
+ */
+export declare const MANAGED_REFRESH_SERVICE_CONTEXT: {
+    readonly LearnCardCredentialRefresh2026: "https://learncard.com/refresh#LearnCardCredentialRefresh2026";
+    readonly authorization: {
+        readonly '@id': "https://purl.imsglobal.org/spec/ob/v3p0#authorization";
+        readonly '@context': {
+            readonly LearnCardDIDAuth: "https://docs.learncard.com/definitions#LearnCardDIDAuth";
+        };
+    };
+};
+type CredentialWithOptionalRefreshService = {
+    refreshService?: unknown;
+};
+/**
+ * Returns the LearnCard-managed refresh services carried by a credential.
+ *
+ * Accepts a single service object or an array; standard 1EdTech services and unknown
+ * entries are ignored.
+ */
+export declare const getManagedRefreshServices: (vc: CredentialWithOptionalRefreshService) => ManagedCredentialRefreshService[];
+/**
+ * Ensures a credential carrying a LearnCard-managed refresh service also carries the
+ * inline JSON-LD context needed to sign it.
+ *
+ * - Credentials without a managed service are returned **by reference**, untouched.
+ * - The input is never mutated; a shallow-extended copy is returned when a fragment
+ *   must be appended.
+ * - Equivalent existing definitions are idempotent (no duplicate fragment).
+ * - Incomplete mappings are completed with only the missing terms.
+ * - Conflicting definitions (same term, different IRI) throw a clear error instead of
+ *   silently signing an unexpected expansion.
+ */
+export declare const prepareManagedRefreshContext: <T>(credential: T) => T;
+/**
+ * Injects an allocated managed refresh service into an unsigned credential so the
+ * service becomes part of the signed payload.
+ *
+ * The managed service is made primary: any existing refresh services (for example a
+ * standard `1EdTechCredentialRefresh` service) are kept unchanged after it. Injecting
+ * a second, different managed service is rejected. The required inline context is
+ * prepared via {@link prepareManagedRefreshContext}.
+ */
+export declare const injectManagedRefreshService: <T>(credential: T, refreshService: ManagedCredentialRefreshService) => T;
 /**
  * Proof-insensitive content comparison for refresh changed-content detection.
  *

package/dist/credential-refresh.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"credential-refresh.d.ts","sourceRoot":"","sources":["../src/credential-refresh.ts"],"names":[],"mappings":"AAAA,OAAO,EAEH,KAAK,iCAAiC,EACzC,MAAM,kBAAkB,CAAC;AAE1B;;;;;;;GAOG;AAEH,KAAK,qBAAqB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IACnD,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,GAAG;QAAE,EAAE,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAC1C,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,KAAK,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,0BAA0B,GACnC,IAAI,qBAAqB,KAC1B,iCAAiC,GAAG,SActC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,GAAI,IAAI,qBAAqB,KAAG,MAAM,GAAG,SAO1E,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B,GAAI,IAAI,qBAAqB,KAAG,MAAM,GAAG,SAQ/E,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,6BAA6B,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,CAiB3D,CAAC;AAEF,kEAAkE;AAClE,eAAO,MAAM,0BAA0B,GAAI,OAAO,OAAO,KAAG,MACJ,CAAC;AAEzD;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB,GAChC,OAAO,qBAAqB,EAC5B,QAAQ,qBAAqB,KAC9B,OAWF,CAAC"}
+{"version":3,"file":"credential-refresh.d.ts","sourceRoot":"","sources":["../src/credential-refresh.ts"],"names":[],"mappings":"AAAA,OAAO,EAGH,KAAK,+BAA+B,EACpC,KAAK,iCAAiC,EACzC,MAAM,kBAAkB,CAAC;AAE1B;;;;;;;GAOG;AAEH,KAAK,qBAAqB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IACnD,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,GAAG;QAAE,EAAE,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAC1C,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,KAAK,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,0BAA0B,GACnC,IAAI,qBAAqB,KAC1B,iCAAiC,GAAG,SActC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,GAAI,IAAI,qBAAqB,KAAG,MAAM,GAAG,SAO1E,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B,GAAI,IAAI,qBAAqB,KAAG,MAAM,GAAG,SAQ/E,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,6BAA6B,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,CAiB3D,CAAC;AAEF,kEAAkE;AAClE,eAAO,MAAM,0BAA0B,GAAI,OAAO,OAAO,KAAG,MACJ,CAAC;AAUzD,iEAAiE;AACjE,eAAO,MAAM,wBAAwB,iEAC6B,CAAC;AAEnE,mFAAmF;AACnF,eAAO,MAAM,iCAAiC,0DACa,CAAC;AAE5D,0EAA0E;AAC1E,eAAO,MAAM,4BAA4B,4DACoB,CAAC;AAE9D;;;;;;;;GAQG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;CAMlC,CAAC;AAIX,KAAK,oCAAoC,GAAG;IACxC,cAAc,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAC;AA4CF;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,GAClC,IAAI,oCAAoC,KACzC,+BAA+B,EAYjC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,4BAA4B,GAAI,CAAC,EAAE,YAAY,CAAC,KAAG,CAqF/D,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,2BAA2B,GAAI,CAAC,EACzC,YAAY,CAAC,EACb,gBAAgB,+BAA+B,KAChD,CAoCF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB,GAChC,OAAO,qBAAqB,EAC5B,QAAQ,qBAAqB,KAC9B,OAWF,CAAC"}