@interop/wallet-core 0.1.0 → 0.2.0

package/dist/request/exchangeClient.js

@@ -0,0 +1,212 @@
+/**
+ * The `interact.service` type naming an endpoint that accepts a Verifiable
+ * Presentation over plain HTTP POST, with no mediator in between.
+ */
+const PRESENTATION_SERVICE_TYPE = 'UnmediatedHttpPresentationService2021';
+/**
+ * The exchange URL a CHAPI request defers to, if any. Present when the verifier
+ * or issuer chose an exchange-based protocol, in which case the request's VPR
+ * (or store) body is empty and everything of substance lives behind this URL.
+ *
+ * Two protocol handles carry such a URL: the classic `vcapi` key, and the
+ * `interact` key of the newer `chapi.interact()` API (a "meta" protocol whose
+ * URL is opaque -- the underlying exchange is negotiated behind it, exactly as
+ * with `vcapi`). Both are plain HTTP exchange endpoints the wallet POSTs to, so
+ * they are handled identically here; `interact` is preferred when a request
+ * carries both.
+ *
+ * @param options {object}
+ * @param [options.protocols] {CHAPIProtocols}
+ * @returns {string | undefined}
+ */
+export function vcApiExchangeUrl({ protocols }) {
+    const candidates = [protocols?.interact, protocols?.vcapi];
+    return candidates.find(url => typeof url === 'string' && url.length > 0);
+}
+/**
+ * POSTs a JSON body to an exchange endpoint and parses the reply. A 2xx with an
+ * empty body is normal (a completed exchange), and yields `{}`.
+ *
+ * @param options {object}
+ * @param options.url {string}
+ * @param options.body {object}
+ * @param options.fetch {FetchLike}
+ * @returns {Promise<VCAPIExchangeResponse>}
+ */
+async function postToExchange({ url, body, fetch }) {
+    const response = await fetch(url, {
+        method: 'POST',
+        headers: { 'content-type': 'application/json', accept: 'application/json' },
+        body: JSON.stringify(body)
+    });
+    if (!response.ok) {
+        throw new Error(`The exchange at ${url} responded ${response.status} ` +
+            `${response.statusText}.`);
+    }
+    const text = await response.text();
+    if (!text) {
+        return {};
+    }
+    try {
+        return JSON.parse(text);
+    }
+    catch (err) {
+        throw new Error(`The exchange at ${url} returned malformed JSON.`, {
+            cause: err
+        });
+    }
+}
+/**
+ * Opens the exchange and retrieves the Verifiable Presentation Request the
+ * verifier is actually asking for. The wallet begins an exchange by POSTing an
+ * empty body; the reply carries the VPR.
+ *
+ * @param options {object}
+ * @param options.exchangeUrl {string}
+ * @param [options.fetch] {FetchLike}
+ * @returns {Promise<IVPRDetails>}
+ */
+export async function startExchange({ exchangeUrl, fetch = globalThis.fetch }) {
+    const { verifiablePresentationRequest } = await beginExchange({
+        exchangeUrl,
+        fetch
+    });
+    if (!verifiablePresentationRequest) {
+        throw new Error(`The exchange at ${exchangeUrl} did not return a ` +
+            'verifiablePresentationRequest.');
+    }
+    return verifiablePresentationRequest;
+}
+/**
+ * Opens an exchange: the wallet's first message is always an empty JSON body,
+ * whether the exchange goes on to request a presentation (a verifier) or to
+ * offer one (an issuer).
+ *
+ * @param options {object}
+ * @param options.exchangeUrl {string}
+ * @param [options.fetch] {FetchLike}
+ * @returns {Promise<VCAPIExchangeResponse>}
+ */
+export async function beginExchange({ exchangeUrl, fetch = globalThis.fetch }) {
+    return postToExchange({ url: exchangeUrl, body: {}, fetch });
+}
+/**
+ * Reply inspection shared by both exchange directions. This wallet answers a
+ * single round, so a reply carrying a further `verifiablePresentationRequest` is
+ * a multi-step exchange it cannot continue: throw rather than pretend the
+ * exchange closed. A reply without one is a completed round and returns
+ * normally.
+ */
+function assertExchangeComplete({ reply, exchangeUrl }) {
+    if (reply.verifiablePresentationRequest) {
+        throw new Error(`The exchange at ${exchangeUrl} asked for a further presentation; ` +
+            'multi-step exchanges are not supported.');
+    }
+}
+/**
+ * Delivers the wallet's composed presentation to a verifier's exchange and
+ * confirms the exchange finished. The exchange, not the CHAPI channel, is the
+ * verifier's system of record, so an unfinished (multi-step) reply is a failed
+ * delivery.
+ *
+ * @param options {object}
+ * @param options.request {IVPRDetails} - The VPR the exchange handed back.
+ * @param options.exchangeUrl {string}
+ * @param options.verifiablePresentation {IVerifiablePresentation}
+ * @param [options.fetch] {FetchLike}
+ * @returns {Promise<void>}
+ */
+export async function deliverPresentation({ request, exchangeUrl, verifiablePresentation, fetch = globalThis.fetch }) {
+    const reply = await submitPresentation({
+        request,
+        exchangeUrl,
+        verifiablePresentation,
+        fetch
+    });
+    assertExchangeComplete({ reply, exchangeUrl });
+}
+/**
+ * Answers an issuance exchange's holder-binding step: POSTs the wallet's
+ * DID-Auth presentation and collects the credentials the issuer hands back in
+ * return. A reply carrying yet another `verifiablePresentationRequest` means a
+ * further round this wallet does not answer.
+ *
+ * @param options {object}
+ * @param options.request {IVPRDetails} - The VPR the exchange opened with.
+ * @param options.exchangeUrl {string}
+ * @param options.verifiablePresentation {IVerifiablePresentation} - The signed
+ *   DID-Auth presentation proving control of the holder DID.
+ * @param [options.fetch] {FetchLike}
+ * @returns {Promise<IVerifiablePresentation>} The offered presentation.
+ */
+export async function collectIssuedPresentation({ request, exchangeUrl, verifiablePresentation, fetch = globalThis.fetch }) {
+    const reply = await submitPresentation({
+        request,
+        exchangeUrl,
+        verifiablePresentation,
+        fetch
+    });
+    if (reply.verifiablePresentation) {
+        return reply.verifiablePresentation;
+    }
+    assertExchangeComplete({ reply, exchangeUrl });
+    throw new Error(`The exchange at ${exchangeUrl} offered no verifiablePresentation.`);
+}
+/**
+ * Where to POST the composed presentation: the VPR's unmediated HTTP
+ * presentation service, when it names one, else the exchange URL itself (which
+ * every exchange accepts, and which is all vcplayground.org's VPR offers).
+ *
+ * @param options {object}
+ * @param options.request {IVPRDetails}
+ * @param options.exchangeUrl {string}
+ * @returns {string}
+ */
+export function presentationEndpointFor({ request, exchangeUrl }) {
+    const services = request.interact?.service ?? [];
+    const unmediated = services.find(({ type, serviceEndpoint }) => type === PRESENTATION_SERVICE_TYPE && !!serviceEndpoint);
+    return unmediated?.serviceEndpoint ?? exchangeUrl;
+}
+/**
+ * Delivers the wallet's composed presentation to the exchange and returns the
+ * raw reply. The exchange is complete unless the reply carries a further
+ * `verifiablePresentationRequest`; the finalize helpers (`deliverPresentation`,
+ * `collectIssuedPresentation`) inspect the reply via `assertExchangeComplete`.
+ *
+ * @param options {object}
+ * @param options.request {IVPRDetails} - The VPR the exchange handed back.
+ * @param options.exchangeUrl {string}
+ * @param options.verifiablePresentation {IVerifiablePresentation}
+ * @param [options.fetch] {FetchLike}
+ * @returns {Promise<VCAPIExchangeResponse>}
+ */
+export async function submitPresentation({ request, exchangeUrl, verifiablePresentation, fetch = globalThis.fetch }) {
+    return postToExchange({
+        url: presentationEndpointFor({ request, exchangeUrl }),
+        body: { verifiablePresentation },
+        fetch
+    });
+}
+/**
+ * Sends the whole Wallet Response object -- a VP and/or delegated `zcap`s -- to
+ * an exchanger endpoint (DCW's response envelope, which threads the grants
+ * *beside* the VP rather than embedding them inside it). Returns the parsed JSON
+ * reply, or `null` for an empty body. Kept alongside `submitPresentation` (whose
+ * envelope carries only the VP) because the two apps POST different shapes.
+ *
+ * @param options {object}
+ * @param options.exchangeUrl {string}
+ * @param options.payload {{ verifiablePresentation?, zcap? }}
+ * @param [options.fetch] {FetchLike}
+ * @returns {Promise<unknown>}
+ */
+export async function sendToExchanger({ exchangeUrl, payload, fetch = globalThis.fetch }) {
+    const response = await fetch(exchangeUrl, {
+        method: 'POST',
+        headers: { 'Content-Type': 'application/json' },
+        body: JSON.stringify(payload)
+    });
+    const text = await response.text();
+    return text ? JSON.parse(text) : null;
+}
+//# sourceMappingURL=exchangeClient.js.map

package/dist/request/exchangeClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exchangeClient.js","sourceRoot":"","sources":["../../src/request/exchangeClient.ts"],"names":[],"mappings":"AAgCA;;;GAGG;AACH,MAAM,yBAAyB,GAAG,uCAAuC,CAAA;AAEzE;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,gBAAgB,CAAC,EAC/B,SAAS,EAGV;IACC,MAAM,UAAU,GAAG,CAAC,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,CAAC,CAAA;IAC1D,OAAO,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;AAC1E,CAAC;AAED;;;;;;;;;GASG;AACH,KAAK,UAAU,cAAc,CAAC,EAC5B,GAAG,EACH,IAAI,EACJ,KAAK,EAKN;IACC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;QAChC,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,EAAE,kBAAkB,EAAE;QAC3E,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;KAC3B,CAAC,CAAA;IACF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CACb,mBAAmB,GAAG,cAAc,QAAQ,CAAC,MAAM,GAAG;YACpD,GAAG,QAAQ,CAAC,UAAU,GAAG,CAC5B,CAAA;IACH,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;IAClC,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,EAAE,CAAA;IACX,CAAC;IACD,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAA0B,CAAA;IAClD,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,mBAAmB,GAAG,2BAA2B,EAAE;YACjE,KAAK,EAAE,GAAG;SACX,CAAC,CAAA;IACJ,CAAC;AACH,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,EAClC,WAAW,EACX,KAAK,GAAG,UAAU,CAAC,KAAK,EAIzB;IACC,MAAM,EAAE,6BAA6B,EAAE,GAAG,MAAM,aAAa,CAAC;QAC5D,WAAW;QACX,KAAK;KACN,CAAC,CAAA;IACF,IAAI,CAAC,6BAA6B,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CACb,mBAAmB,WAAW,oBAAoB;YAChD,gCAAgC,CACnC,CAAA;IACH,CAAC;IACD,OAAO,6BAA6B,CAAA;AACtC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,EAClC,WAAW,EACX,KAAK,GAAG,UAAU,CAAC,KAAK,EAIzB;IACC,OAAO,cAAc,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAA;AAC9D,CAAC;AAED;;;;;;GAMG;AACH,SAAS,sBAAsB,CAAC,EAC9B,KAAK,EACL,WAAW,EAIZ;IACC,IAAI,KAAK,CAAC,6BAA6B,EAAE,CAAC;QACxC,MAAM,IAAI,KAAK,CACb,mBAAmB,WAAW,qCAAqC;YACjE,yCAAyC,CAC5C,CAAA;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,EACxC,OAAO,EACP,WAAW,EACX,sBAAsB,EACtB,KAAK,GAAG,UAAU,CAAC,KAAK,EAMzB;IACC,MAAM,KAAK,GAAG,MAAM,kBAAkB,CAAC;QACrC,OAAO;QACP,WAAW;QACX,sBAAsB;QACtB,KAAK;KACN,CAAC,CAAA;IACF,sBAAsB,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAAA;AAChD,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAAC,EAC9C,OAAO,EACP,WAAW,EACX,sBAAsB,EACtB,KAAK,GAAG,UAAU,CAAC,KAAK,EAMzB;IACC,MAAM,KAAK,GAAG,MAAM,kBAAkB,CAAC;QACrC,OAAO;QACP,WAAW;QACX,sBAAsB;QACtB,KAAK;KACN,CAAC,CAAA;IACF,IAAI,KAAK,CAAC,sBAAsB,EAAE,CAAC;QACjC,OAAO,KAAK,CAAC,sBAAsB,CAAA;IACrC,CAAC;IACD,sBAAsB,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAAA;IAC9C,MAAM,IAAI,KAAK,CACb,mBAAmB,WAAW,qCAAqC,CACpE,CAAA;AACH,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,uBAAuB,CAAC,EACtC,OAAO,EACP,WAAW,EAIZ;IACC,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,EAAE,OAAO,IAAI,EAAE,CAAA;IAChD,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,CAC9B,CAAC,EAAE,IAAI,EAAE,eAAe,EAAE,EAAE,EAAE,CAC5B,IAAI,KAAK,yBAAyB,IAAI,CAAC,CAAC,eAAe,CAC1D,CAAA;IACD,OAAO,UAAU,EAAE,eAAe,IAAI,WAAW,CAAA;AACnD,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,EACvC,OAAO,EACP,WAAW,EACX,sBAAsB,EACtB,KAAK,GAAG,UAAU,CAAC,KAAK,EAMzB;IACC,OAAO,cAAc,CAAC;QACpB,GAAG,EAAE,uBAAuB,CAAC,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC;QACtD,IAAI,EAAE,EAAE,sBAAsB,EAAE;QAChC,KAAK;KACN,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,EACpC,WAAW,EACX,OAAO,EACP,KAAK,GAAG,UAAU,CAAC,KAAK,EAQzB;IACC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,WAAW,EAAE;QACxC,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;QAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;KAC9B,CAAC,CAAA;IACF,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;IAClC,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;AACvC,CAAC"}

package/dist/request/index.d.ts

@@ -0,0 +1,35 @@
+/*!
+ * Copyright (c) 2026 Interop Alliance. All rights reserved.
+ */
+/**
+ * The `@interop/wallet-core/request` subpath: wallet-request / exchange-protocol
+ * handling shared by the Interop wallet apps (DCW and Freewallet).
+ *
+ * - `types` re-exports the VPR message vocabulary from
+ *   `@interop/data-integrity-core` and declares the request-local types (CHAPI
+ *   events, the classified-request profile, and the `PresentationSigner` /
+ *   `FetchLike` / `RequestProcessors` injection seams).
+ * - `parse` / `classify` turn a raw URL, JSON string, or CHAPI event into a
+ *   typed message and dispatch on what it asks for.
+ * - `matching` filters stored credentials against a QueryByExample (both the
+ *   jsonpath deep matcher and the type/issuer matcher).
+ * - `presentationSuite` negotiates the response cryptosuite; `composeVp` builds
+ *   the (optionally signed, optionally grant-embedding) response VP.
+ * - `exchangeClient` is the fetch-injectable VC-API exchange client;
+ *   `interactionUrl` resolves VCALM `interaction:` URLs.
+ * - `processRequest` is the pure request-to-response pipeline, with the
+ *   app-side side effects injected.
+ *
+ * The signing / document-loader dependency graph lives entirely behind this
+ * subpath; `@interop/wallet-core`'s plaintext consumers never pull it in.
+ */
+export * from './types.js';
+export * from './parse.js';
+export * from './classify.js';
+export * from './matching.js';
+export * from './presentationSuite.js';
+export * from './composeVp.js';
+export * from './exchangeClient.js';
+export * from './interactionUrl.js';
+export * from './processRequest.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/request/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/request/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,eAAe,CAAA;AAC7B,cAAc,eAAe,CAAA;AAC7B,cAAc,wBAAwB,CAAA;AACtC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,qBAAqB,CAAA;AACnC,cAAc,qBAAqB,CAAA;AACnC,cAAc,qBAAqB,CAAA"}

package/dist/request/index.js

@@ -0,0 +1,35 @@
+/*!
+ * Copyright (c) 2026 Interop Alliance. All rights reserved.
+ */
+/**
+ * The `@interop/wallet-core/request` subpath: wallet-request / exchange-protocol
+ * handling shared by the Interop wallet apps (DCW and Freewallet).
+ *
+ * - `types` re-exports the VPR message vocabulary from
+ *   `@interop/data-integrity-core` and declares the request-local types (CHAPI
+ *   events, the classified-request profile, and the `PresentationSigner` /
+ *   `FetchLike` / `RequestProcessors` injection seams).
+ * - `parse` / `classify` turn a raw URL, JSON string, or CHAPI event into a
+ *   typed message and dispatch on what it asks for.
+ * - `matching` filters stored credentials against a QueryByExample (both the
+ *   jsonpath deep matcher and the type/issuer matcher).
+ * - `presentationSuite` negotiates the response cryptosuite; `composeVp` builds
+ *   the (optionally signed, optionally grant-embedding) response VP.
+ * - `exchangeClient` is the fetch-injectable VC-API exchange client;
+ *   `interactionUrl` resolves VCALM `interaction:` URLs.
+ * - `processRequest` is the pure request-to-response pipeline, with the
+ *   app-side side effects injected.
+ *
+ * The signing / document-loader dependency graph lives entirely behind this
+ * subpath; `@interop/wallet-core`'s plaintext consumers never pull it in.
+ */
+export * from './types.js';
+export * from './parse.js';
+export * from './classify.js';
+export * from './matching.js';
+export * from './presentationSuite.js';
+export * from './composeVp.js';
+export * from './exchangeClient.js';
+export * from './interactionUrl.js';
+export * from './processRequest.js';
+//# sourceMappingURL=index.js.map

package/dist/request/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/request/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,eAAe,CAAA;AAC7B,cAAc,eAAe,CAAA;AAC7B,cAAc,wBAAwB,CAAA;AACtC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,qBAAqB,CAAA;AACnC,cAAc,qBAAqB,CAAA;AACnC,cAAc,qBAAqB,CAAA"}

package/dist/request/interactionUrl.d.ts

@@ -0,0 +1,53 @@
+/*!
+ * Copyright (c) 2026 Interop Alliance. All rights reserved.
+ */
+/**
+ * VCALM `interaction:` URL handling: detecting an interaction URL, normalizing
+ * it to its inner HTTPS URL, and fetching the protocols map it advertises. An
+ * interaction URL is a level of indirection a verifier / issuer hands the wallet
+ * (over a deep link or QR code) that resolves to a `protocols` map naming the
+ * real exchange endpoints.
+ *
+ * Ported verbatim from DCW's `app/lib/interactionUrl.ts`, with the network
+ * transport injected ({@link FetchLike}, default `globalThis.fetch`).
+ */
+import type { FetchLike } from './types.js';
+/**
+ * Detects whether a URL is a VCALM interaction URL.
+ *
+ * Two formats:
+ * - `interaction:` scheme: `interaction:https://example.com/path?iuv=1`
+ * - HTTPS URL with an `iuv` query param: `https://example.com/path?iuv=1`
+ *
+ * @param url {string}
+ * @returns {boolean}
+ */
+export declare function isInteractionUrl(url: string): boolean;
+/**
+ * Normalizes any interaction URL to the inner HTTPS interaction URL. Accepts any
+ * URL that passed {@link isInteractionUrl}.
+ *
+ * - `interaction:https://...?iuv=1` strips the prefix
+ * - `interaction:https%3A%2F%2F...` strips the prefix and decodes (URL-encoded
+ *   after `interaction:` is non-standard, but handled for robustness)
+ * - `https://...?iuv=1` is returned as-is
+ *
+ * @param url {string}
+ * @returns {string}
+ */
+export declare function parseInteractionUrl(url: string): string;
+/**
+ * Fetches the interaction protocols response from a VCALM interaction URL. Sends
+ * GET with `Accept: application/json` per the VCALM spec, and returns the
+ * protocols map. Logs a warning if the `iuv` param value is not `1`; throws if
+ * the response is not ok or the `protocols` key is missing.
+ *
+ * @param interactionUrl {string}
+ * @param [options] {object}
+ * @param [options.fetch] {FetchLike}
+ * @returns {Promise<Record<string, string>>}
+ */
+export declare function fetchInteractionProtocols(interactionUrl: string, { fetch }?: {
+    fetch?: FetchLike;
+}): Promise<Record<string, string>>;
+//# sourceMappingURL=interactionUrl.d.ts.map

package/dist/request/interactionUrl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interactionUrl.d.ts","sourceRoot":"","sources":["../../src/request/interactionUrl.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH;;;;;;;;;GASG;AACH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAI3C;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAUrD;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAWvD;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,yBAAyB,CAC7C,cAAc,EAAE,MAAM,EACtB,EAAE,KAAwB,EAAE,GAAE;IAAE,KAAK,CAAC,EAAE,SAAS,CAAA;CAAO,GACvD,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CA+BjC"}

package/dist/request/interactionUrl.js

@@ -0,0 +1,83 @@
+const INTERACTION_SCHEME_PREFIX = 'interaction:';
+/**
+ * Detects whether a URL is a VCALM interaction URL.
+ *
+ * Two formats:
+ * - `interaction:` scheme: `interaction:https://example.com/path?iuv=1`
+ * - HTTPS URL with an `iuv` query param: `https://example.com/path?iuv=1`
+ *
+ * @param url {string}
+ * @returns {boolean}
+ */
+export function isInteractionUrl(url) {
+    if (url.startsWith(INTERACTION_SCHEME_PREFIX)) {
+        return true;
+    }
+    try {
+        const parsed = new URL(url);
+        return parsed.searchParams.has('iuv');
+    }
+    catch {
+        return false;
+    }
+}
+/**
+ * Normalizes any interaction URL to the inner HTTPS interaction URL. Accepts any
+ * URL that passed {@link isInteractionUrl}.
+ *
+ * - `interaction:https://...?iuv=1` strips the prefix
+ * - `interaction:https%3A%2F%2F...` strips the prefix and decodes (URL-encoded
+ *   after `interaction:` is non-standard, but handled for robustness)
+ * - `https://...?iuv=1` is returned as-is
+ *
+ * @param url {string}
+ * @returns {string}
+ */
+export function parseInteractionUrl(url) {
+    if (!url.startsWith(INTERACTION_SCHEME_PREFIX)) {
+        return url;
+    }
+    const inner = url.slice(INTERACTION_SCHEME_PREFIX.length);
+    // Non-standard: the inner URL may be URL-encoded after the `interaction:`
+    // prefix.
+    if (inner.startsWith('http%3A') || inner.startsWith('https%3A')) {
+        return decodeURIComponent(inner);
+    }
+    return inner;
+}
+/**
+ * Fetches the interaction protocols response from a VCALM interaction URL. Sends
+ * GET with `Accept: application/json` per the VCALM spec, and returns the
+ * protocols map. Logs a warning if the `iuv` param value is not `1`; throws if
+ * the response is not ok or the `protocols` key is missing.
+ *
+ * @param interactionUrl {string}
+ * @param [options] {object}
+ * @param [options.fetch] {FetchLike}
+ * @returns {Promise<Record<string, string>>}
+ */
+export async function fetchInteractionProtocols(interactionUrl, { fetch = globalThis.fetch } = {}) {
+    try {
+        const parsed = new URL(interactionUrl);
+        const iuv = parsed.searchParams.get('iuv');
+        if (iuv && iuv !== '1') {
+            console.warn(`[fetchInteractionProtocols] Unexpected iuv value "${iuv}" ` +
+                '(expected "1"). Proceeding anyway.');
+        }
+    }
+    catch {
+        throw new Error(`Invalid interaction URL: ${interactionUrl}`);
+    }
+    const response = await fetch(interactionUrl, {
+        headers: { Accept: 'application/json' }
+    });
+    if (!response.ok) {
+        throw new Error(`Interaction URL fetch failed: ${response.status} ${response.statusText}`);
+    }
+    const body = await response.json();
+    if (!body.protocols || typeof body.protocols !== 'object') {
+        throw new Error('Interaction URL response missing "protocols" map.');
+    }
+    return body.protocols;
+}
+//# sourceMappingURL=interactionUrl.js.map

package/dist/request/interactionUrl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interactionUrl.js","sourceRoot":"","sources":["../../src/request/interactionUrl.ts"],"names":[],"mappings":"AAeA,MAAM,yBAAyB,GAAG,cAAc,CAAA;AAEhD;;;;;;;;;GASG;AACH,MAAM,UAAU,gBAAgB,CAAC,GAAW;IAC1C,IAAI,GAAG,CAAC,UAAU,CAAC,yBAAyB,CAAC,EAAE,CAAC;QAC9C,OAAO,IAAI,CAAA;IACb,CAAC;IACD,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAA;QAC3B,OAAO,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;IACvC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,mBAAmB,CAAC,GAAW;IAC7C,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,yBAAyB,CAAC,EAAE,CAAC;QAC/C,OAAO,GAAG,CAAA;IACZ,CAAC;IACD,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAA;IACzD,0EAA0E;IAC1E,UAAU;IACV,IAAI,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QAChE,OAAO,kBAAkB,CAAC,KAAK,CAAC,CAAA;IAClC,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC7C,cAAsB,EACtB,EAAE,KAAK,GAAG,UAAU,CAAC,KAAK,KAA4B,EAAE;IAExD,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,cAAc,CAAC,CAAA;QACtC,MAAM,GAAG,GAAG,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;QAC1C,IAAI,GAAG,IAAI,GAAG,KAAK,GAAG,EAAE,CAAC;YACvB,OAAO,CAAC,IAAI,CACV,qDAAqD,GAAG,IAAI;gBAC1D,oCAAoC,CACvC,CAAA;QACH,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,KAAK,CAAC,4BAA4B,cAAc,EAAE,CAAC,CAAA;IAC/D,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,cAAc,EAAE;QAC3C,OAAO,EAAE,EAAE,MAAM,EAAE,kBAAkB,EAAE;KACxC,CAAC,CAAA;IAEF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CACb,iCAAiC,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,EAAE,CAC1E,CAAA;IACH,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;IAElC,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,OAAO,IAAI,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC;QAC1D,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAA;IACtE,CAAC;IAED,OAAO,IAAI,CAAC,SAAS,CAAA;AACvB,CAAC"}

package/dist/request/matching.d.ts

@@ -0,0 +1,69 @@
+import type { IVerifiableCredential } from './types.js';
+import type { IQueryByExample } from './types.js';
+export { issuerId, typeArray } from '@interop/data-integrity-core/guards';
+/**
+ * Whether a credential matches a QueryByExample `example` object, by the DCW
+ * deep-matching algorithm: every key of the example is resolved as a JSONPath
+ * against the credential and compared. Array example values require the
+ * credential to contain (at least) every listed value; object example values
+ * recurse; literal example values compare by strict equality. An empty example
+ * matches any credential.
+ *
+ * @param vprExample {Record<string, unknown>} - The QueryByExample `example`.
+ * @param credential {IVerifiableCredential} - The stored credential to test.
+ * @param [credentialPath] {string} - JSONPath root into the credential
+ *   (defaults to `$`); used internally when recursing into nested objects.
+ * @returns {boolean}
+ */
+export declare function credentialMatchesVprExampleQuery(vprExample: Record<string, unknown>, credential: IVerifiableCredential, credentialPath?: string): boolean;
+/**
+ * Filters credentials to those matching a `QueryByExample`, using the deep
+ * matcher. Each of the query's `credentialQuery` details contributes its
+ * `example`; a credential is included when it matches any of them. A malformed
+ * query with no example matches nothing.
+ *
+ * @param credentials {IVerifiableCredential[]}
+ * @param query {IQueryByExample}
+ * @returns {IVerifiableCredential[]}
+ */
+export declare function filterCredentialsByExample(credentials: IVerifiableCredential[], query: IQueryByExample): IVerifiableCredential[];
+/**
+ * The credentials matching any of the given QueryByExample queries by the
+ * type-and-issuer algorithm. Only queries whose `example` carries a `type`
+ * constrain the result; a query with no example type matches nothing here (the
+ * caller keeps its list-all behavior when *no* query specifies a type).
+ *
+ * @param options {object}
+ * @param options.credentials {IVerifiableCredential[]}
+ * @param options.queries {IQueryByExample[]}
+ * @returns {IVerifiableCredential[]}
+ */
+export declare function vcMatchesFor({ credentials, queries }: {
+    credentials: IVerifiableCredential[];
+    queries: IQueryByExample[];
+}): IVerifiableCredential[];
+/**
+ * Whether any of the QueryByExample queries pins an example `type` (and so
+ * should filter the share list). When false, the caller keeps showing all
+ * stored credentials.
+ *
+ * @param queries {IQueryByExample[]}
+ * @returns {boolean}
+ */
+export declare function hasTypedExample(queries: IQueryByExample[]): boolean;
+/**
+ * Whether any typed example in the query set explicitly lists the given
+ * credential `type`. Lets the caller distinguish a request that actually asks
+ * for a particular type (e.g. a LoginCredential) from a generic, untyped "any
+ * VC" request.
+ *
+ * @param options {object}
+ * @param options.queries {IQueryByExample[]}
+ * @param options.type {string}
+ * @returns {boolean}
+ */
+export declare function requestsCredentialType({ queries, type }: {
+    queries: IQueryByExample[];
+    type: string;
+}): boolean;
+//# sourceMappingURL=matching.d.ts.map

package/dist/request/matching.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"matching.d.ts","sourceRoot":"","sources":["../../src/request/matching.ts"],"names":[],"mappings":"AAsBA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAA;AACvD,OAAO,KAAK,EAAoB,eAAe,EAAE,MAAM,YAAY,CAAA;AAMnE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAA;AAEzE;;;;;;;;;;;;;GAaG;AACH,wBAAgB,gCAAgC,CAC9C,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACnC,UAAU,EAAE,qBAAqB,EACjC,cAAc,SAAM,GACnB,OAAO,CAoCT;AAeD;;;;;;;;;GASG;AACH,wBAAgB,0BAA0B,CACxC,WAAW,EAAE,qBAAqB,EAAE,EACpC,KAAK,EAAE,eAAe,GACrB,qBAAqB,EAAE,CAgBzB;AAiCD;;;;;;;;;;GAUG;AACH,wBAAgB,YAAY,CAAC,EAC3B,WAAW,EACX,OAAO,EACR,EAAE;IACD,WAAW,EAAE,qBAAqB,EAAE,CAAA;IACpC,OAAO,EAAE,eAAe,EAAE,CAAA;CAC3B,GAAG,qBAAqB,EAAE,CAQ1B;AAqBD;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,eAAe,EAAE,GAAG,OAAO,CAEnE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,sBAAsB,CAAC,EACrC,OAAO,EACP,IAAI,EACL,EAAE;IACD,OAAO,EAAE,eAAe,EAAE,CAAA;IAC1B,IAAI,EAAE,MAAM,CAAA;CACb,GAAG,OAAO,CAIV"}