@learncard/helpers 1.4.0 → 1.5.0

package/dist/credential-refresh.d.ts

@@ -0,0 +1,58 @@
+import { type SupportedCredentialRefreshService } from '@learncard/types';
+/**
+ * Canonical helpers for credential refresh (LC-2117, LC-2135, LC-2136).
+ *
+ * These helpers are storage-independent: they select a supported refresh service,
+ * normalize issuer/effective-time identity, and provide deterministic canonicalization
+ * plus a proof-insensitive content comparison used by both the holder SDK and the
+ * brain-service publication pipeline.
+ */
+type RefreshableCredential = Record<string, unknown> & {
+    refreshService?: unknown;
+    issuer?: string | {
+        id?: unknown;
+    } | null;
+    validFrom?: unknown;
+    issuanceDate?: unknown;
+    proof?: unknown;
+};
+/**
+ * Selects the first supported refresh service from a credential's `refreshService`.
+ *
+ * Accepts a single service object or an array. An array is treated as ordered: the
+ * first entry whose type is supported is selected. Supported types are
+ * `1EdTechCredentialRefresh` and `LearnCardCredentialRefresh2026`.
+ *
+ * @returns the supported service, or `undefined` when none is present/supported
+ */
+export declare const getSupportedRefreshService: (vc: RefreshableCredential) => SupportedCredentialRefreshService | undefined;
+/**
+ * Normalizes a credential's issuer to its identifier.
+ *
+ * Handles both the string form (`issuer: 'did:example:x'`) and the object form
+ * (`issuer: { id: 'did:example:x', ... }`).
+ */
+export declare const getCredentialIssuerId: (vc: RefreshableCredential) => string | undefined;
+/**
+ * Returns the credential's effective timestamp in milliseconds since the epoch.
+ *
+ * Prefers VCDM 2.0 `validFrom` and falls back to VCDM 1.1 `issuanceDate`. Returns
+ * `undefined` when no parseable timestamp exists.
+ */
+export declare const getCredentialEffectiveTime: (vc: RefreshableCredential) => number | undefined;
+/**
+ * Deterministically canonicalizes a JSON-like value: object keys are recursively
+ * sorted, array order is preserved, and primitives pass through unchanged.
+ */
+export declare const canonicalizeCredentialContent: <T>(value: T) => T;
+/** Serializes a value to a deterministic canonical JSON string */
+export declare const canonicalizeCredentialJson: (value: unknown) => string;
+/**
+ * Proof-insensitive content comparison for refresh changed-content detection.
+ *
+ * Only the top-level `proof` property is excluded; everything else (subject claims,
+ * identifiers, timestamps, services) participates in the comparison.
+ */
+export declare const credentialContentsEqual: (first: RefreshableCredential, second: RefreshableCredential) => boolean;
+export {};
+//# sourceMappingURL=credential-refresh.d.ts.map

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

@@ -0,0 +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"}