@learncard/cli 3.3.176 → 3.3.177

package/CHANGELOG.md

@@ -1,5 +1,56 @@
 # @learncard/cli
 
+## 3.3.177
+
+### Patch Changes
+
+-   [#1240](https://github.com/learningeconomy/LearnCard/pull/1240) [`3a05603c72d76020b43ec6bbd5e31b2b31c0fd2b`](https://github.com/learningeconomy/LearnCard/commit/3a05603c72d76020b43ec6bbd5e31b2b31c0fd2b) Thanks [@gerardopar](https://github.com/gerardopar)! - feat: [LC-1812][LC-1855] - Add Render Method Plugin + Render Method Toggle
+
+    Adds `@learncard/render-method-plugin` for attaching and reading W3C `renderMethod` entries on Verifiable Credentials. The plugin is registered as part of the default LearnCard wallet stack.
+
+    **Write side** (`wallet.invoke`): `attachRenderMethod`, `buildTemplateRenderMethod`.
+
+    **Read side** (`wallet.invoke` and direct imports):
+
+    -   String-based sugar (most common case): `findTemplateRenderMethod(vc, suite | suites[])`, `findTemplateRenderMethods(vc, suite | suites[])`.
+    -   Backward-compatible alias: `getSvgMustacheRenderMethod`.
+    -   Predicate-based escape hatch: `findRenderMethod`, `findRenderMethods`.
+    -   Raw access: `getRenderMethods` (unwraps `CertifiedBoostCredential`, normalizes object↔array).
+    -   Data shaping: `buildRenderData(vc, renderProperty?)` (Mustache context with `vc` / `credential` / `credentialSubjects` aliases, RFC 6901 overlay).
+    -   Exported type guards: `isTemplateRenderMethod`, `isSvgMustacheRenderMethod`.
+
+    The pure data-shaping helpers (Mustache context, JSON Pointer overlay, boost unwrapping) moved out of `apps/learn-card-app/src/helpers/renderMethod.helpers.ts` into the plugin; the app now only owns the SVG-specific render pipeline (Mustache hydration + DOMPurify sanitization + React display).
+
+    **`@learncard/types`**: `TemplateRenderMethodValidator` widened — `renderSuite` and `outputPreference.mediaType` are now `z.string()` (were `z.literal('svg-mustache')` and `z.literal('image/svg+xml')`). The literals couldn't express the W3C spec's openness to other suites/types and made the plugin's "future-extensible" read API contradictory. Backward-compatible: all existing literal values still validate.
+
+    Behavior:
+
+    -   `attachRenderMethod` is **opt-in**: calling it without a config returns the VC unchanged. Pass `{ templateId: DEFAULT_TEMPLATE_ID }` or a custom `{ templateId | templateValue }` to actually attach a render method. This avoids polluting every issued credential's `@context` with the render-method JSON-LD context URL.
+    -   `templateId` must be an `http://` or `https://` URL. Empty values, `javascript:`, `file:`, `data:` and other schemes are rejected at the plugin boundary.
+    -   `templateValue` is URL-encoded into a `data:image/svg+xml,` URI. Empty or whitespace-only values are rejected.
+    -   The `useRenderMethodEnabled` LaunchDarkly flag gates display only (the `RenderMethodDisplay` component, the `BoostDisplayStyleSelector`, the `getSvgMustacheRenderMethod` lookup). It does not gate the write path.
+
+    Known risk:
+
+    -   The JSON-LD context URL (`https://digitalbazaar.github.io/vc-render-method-context/contexts/v2rc2.jsonld`) is a community-group draft, not a finalized W3C TR. VCs issued with this context depend on the URL remaining stable. Follow-up work will bundle the context locally and migrate to the W3C TR URL when published.
+
+    Types:
+
+    -   `@learncard/types` adds `TemplateRenderMethod`, `RenderMethod`, and a top-level `renderMethod` field on `UnsignedVC`.
+    -   `learn-card-base` extends `BespokeLearnCard` to include `RenderMethodPlugin`, making `wallet.invoke.attachRenderMethod` and `wallet.invoke.buildTemplateRenderMethod` type-safe across the codebase.
+
+-   Updated dependencies [[`3a05603c72d76020b43ec6bbd5e31b2b31c0fd2b`](https://github.com/learningeconomy/LearnCard/commit/3a05603c72d76020b43ec6bbd5e31b2b31c0fd2b), [`37439411ac68618fc27898ac4c0f48dbef4e424b`](https://github.com/learningeconomy/LearnCard/commit/37439411ac68618fc27898ac4c0f48dbef4e424b), [`37439411ac68618fc27898ac4c0f48dbef4e424b`](https://github.com/learningeconomy/LearnCard/commit/37439411ac68618fc27898ac4c0f48dbef4e424b)]:
+    -   @learncard/types@5.16.0
+    -   @learncard/render-method-plugin@2.0.0
+    -   @learncard/init@2.3.19
+    -   @learncard/core@9.4.19
+    -   @learncard/didkit-plugin@1.8.10
+    -   @learncard/learn-cloud-plugin@2.3.24
+    -   @learncard/ler-rs-plugin@0.1.10
+    -   @learncard/linked-claims-plugin@0.2.19
+    -   @learncard/open-badge-v2-plugin@1.1.20
+    -   @learncard/simple-signing-plugin@1.1.23
+
 ## 3.3.176
 
 ### Patch Changes

package/dist/index.js

@@ -15,6 +15,7 @@ var figlet = require('figlet');
 var commander = require('commander');
 var clipboard = require('clipboardy');
 var lerRsPlugin = require('@learncard/ler-rs-plugin');
+var renderMethodPlugin = require('@learncard/render-method-plugin');
 var crypto = require('crypto');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
@@ -31,7 +32,7 @@ var crypto__default = /*#__PURE__*/_interopDefaultLegacy(crypto);
 const generateRandomSeed = () => crypto__default["default"].randomBytes(32).toString("hex");
 
 var name = "@learncard/cli";
-var version = "3.3.176";
+var version = "3.3.177";
 var description = "Command Line Interface for LearnCard";
 var main = "dist/index.js";
 var bin = "dist/index.js";
@@ -48,6 +49,7 @@ var dependencies = {
 	"@learncard/learn-cloud-plugin": "workspace:*",
 	"@learncard/ler-rs-plugin": "workspace:*",
 	"@learncard/linked-claims-plugin": "workspace:*",
+	"@learncard/render-method-plugin": "workspace:*",
 	"@learncard/open-badge-v2-plugin": "workspace:*",
 	"@learncard/simple-signing-plugin": "workspace:*",
 	"@learncard/types": "workspace:*",
@@ -148,6 +150,9 @@ commander.program.version(packageJson.version).argument("[seed]").action(async (
   globalThis.learnCard = await globalThis.learnCard.addPlugin(
     openBadgeV2Plugin.openBadgeV2Plugin(globalThis.learnCard)
   );
+  globalThis.learnCard = await globalThis.learnCard.addPlugin(
+    renderMethodPlugin.getRenderMethodPlugin(globalThis.learnCard)
+  );
   globalThis.types = types__default["default"];
   globalThis.getTestCache = core.getTestCache;
   globalThis.copy = copyFunction;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@learncard/cli",
-  "version": "3.3.176",
+  "version": "3.3.177",
   "description": "Command Line Interface for LearnCard",
   "main": "dist/index.js",
   "bin": "dist/index.js",
@@ -15,15 +15,16 @@
     "pretty-repl": "^3.1.1",
     "rollup": "^2.80.0",
     "rollup-plugin-esbuild": "^4.9.1",
-    "@learncard/didkit-plugin": "^1.8.9",
-    "@learncard/init": "^2.3.18",
-    "@learncard/learn-cloud-plugin": "2.3.23",
-    "@learncard/ler-rs-plugin": "0.1.9",
-    "@learncard/linked-claims-plugin": "0.2.18",
-    "@learncard/open-badge-v2-plugin": "1.1.19",
-    "@learncard/simple-signing-plugin": "1.1.22",
-    "@learncard/types": "5.15.0",
-    "@learncard/core": "9.4.18"
+    "@learncard/core": "9.4.19",
+    "@learncard/didkit-plugin": "^1.8.10",
+    "@learncard/init": "^2.3.19",
+    "@learncard/learn-cloud-plugin": "2.3.24",
+    "@learncard/linked-claims-plugin": "0.2.19",
+    "@learncard/ler-rs-plugin": "0.1.10",
+    "@learncard/render-method-plugin": "2.0.0",
+    "@learncard/open-badge-v2-plugin": "1.1.20",
+    "@learncard/simple-signing-plugin": "1.1.23",
+    "@learncard/types": "5.16.0"
   },
   "devDependencies": {
     "@types/cors": "^2.8.12",

package/src/index.tsx

@@ -14,6 +14,7 @@ import { program } from 'commander';
 import clipboard from 'clipboardy';
 
 import { getLerRsPlugin } from '@learncard/ler-rs-plugin';
+import { getRenderMethodPlugin } from '@learncard/render-method-plugin';
 
 import { generateRandomSeed } from './random';
 
@@ -92,6 +93,11 @@ program
             openBadgeV2Plugin(globalThis.learnCard)
         );
 
+        // Add Render Method plugin for attaching W3C renderMethod to VCs
+        globalThis.learnCard = await globalThis.learnCard.addPlugin(
+            getRenderMethodPlugin(globalThis.learnCard)
+        );
+
         globalThis.types = types;
         globalThis.getTestCache = getTestCache;