@interop/vc 11.0.0

package/dist/CredentialIssuancePurpose.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CredentialIssuancePurpose.js","sourceRoot":"","sources":["../src/CredentialIssuancePurpose.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,MAAM,4BAA4B,CAAA;AAM9C,OAAO,MAAM,MAAM,iBAAiB,CAAA;AAEpC,MAAM,EACJ,QAAQ,EAAE,EAAE,qBAAqB,EAAE,EACpC,GAAG,KAAK,CAAA;AAET;;;;GAIG;AACH,MAAM,OAAO,yBAA0B,SAAQ,qBAAqB;IAClE;;;;;;;OAOG;IACH,YAAY,EACV,UAAU,EACV,IAAI,EACJ,iBAAiB,KAKf,EAAE;QACJ,KAAK,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,iBAAiB,EAAE,CAAC,CAAA;IAChD,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,QAAQ,CACZ,KAAa,EACb,EACE,QAAQ,EACR,KAAK,EACL,kBAAkB,EAClB,cAAc,EAMf;QAED,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,QAAQ,CAAC,KAAK,EAAE;gBACzC,QAAQ;gBACR,KAAK;gBACL,kBAAkB;gBAClB,cAAc;aACf,CAAC,CAAA;YAEF,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;gBAClB,MAAM,MAAM,CAAC,KAAK,CAAA;YACpB,CAAC;YAED,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;YAEnD,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACnC,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAA;YACnD,CAAC;YAED,MAAM,QAAQ,GAAG,OAAO,MAAM,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;YAEzE,MAAM,UAAU,GAAG,MAAM,CAAC,UAAyC,CAAA;YACnE,IAAI,UAAU,EAAE,EAAE,KAAK,QAAQ,EAAE,CAAC;gBAChC,MAAM,IAAI,KAAK,CACb,kEAAkE,CACnE,CAAA;YACH,CAAC;YAED,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;QACxB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAc,EAAE,CAAA;QAChD,CAAC;IACH,CAAC;CACF"}

package/dist/contexts/index.d.ts

@@ -0,0 +1,2 @@
+export declare const contexts: Map<string, unknown>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/contexts/index.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,QAAQ,sBAA6B,CAAA"}

package/dist/contexts/index.js

@@ -0,0 +1,15 @@
+/*!
+ * Copyright (c) 2019-2023 Digital Bazaar, Inc. All rights reserved.
+ */
+import { contexts as credentialsContexts } from 'credentials-context';
+import { contexts as credentialsV2Contexts } from '@digitalcredentials/credentials-v2-context';
+export const contexts = new Map();
+// adds the _contexts to the contexts map
+function addContexts(_contexts) {
+    for (const [url, context] of _contexts.entries()) {
+        contexts.set(url, context);
+    }
+}
+addContexts(credentialsContexts);
+addContexts(credentialsV2Contexts);
+//# sourceMappingURL=index.js.map

package/dist/contexts/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/contexts/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,QAAQ,IAAI,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AACrE,OAAO,EAAE,QAAQ,IAAI,qBAAqB,EAAE,MAAM,4CAA4C,CAAA;AAE9F,MAAM,CAAC,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAmB,CAAA;AAElD,yCAAyC;AACzC,SAAS,WAAW,CAAC,SAA+B;IAClD,KAAK,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,SAAS,CAAC,OAAO,EAAE,EAAE,CAAC;QACjD,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;IAC5B,CAAC;AACH,CAAC;AAED,WAAW,CAAC,mBAAmB,CAAC,CAAA;AAChC,WAAW,CAAC,qBAAqB,CAAC,CAAA"}

package/dist/documentLoader.d.ts

@@ -0,0 +1,6 @@
+/*!
+ * Copyright (c) 2019-2023 Digital Bazaar, Inc. All rights reserved.
+ */
+import type { RemoteDocument } from '@interop/jsonld-signatures';
+export declare function documentLoader(url: string): Promise<RemoteDocument>;
+//# sourceMappingURL=documentLoader.d.ts.map

package/dist/documentLoader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentLoader.d.ts","sourceRoot":"","sources":["../src/documentLoader.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAIhE,wBAAsB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAUzE"}

package/dist/documentLoader.js

@@ -0,0 +1,14 @@
+// load locally embedded contexts
+import { contexts } from './contexts/index.js';
+export async function documentLoader(url) {
+    const context = contexts.get(url);
+    if (context !== undefined) {
+        return {
+            contextUrl: null,
+            documentUrl: url,
+            document: context
+        };
+    }
+    throw new Error(`Document loader unable to load URL "${url}".`);
+}
+//# sourceMappingURL=documentLoader.js.map

package/dist/documentLoader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentLoader.js","sourceRoot":"","sources":["../src/documentLoader.ts"],"names":[],"mappings":"AAIA,iCAAiC;AACjC,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAA;AAE9C,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,GAAW;IAC9C,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IACjC,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,OAAO;YACL,UAAU,EAAE,IAAI;YAChB,WAAW,EAAE,GAAG;YAChB,QAAQ,EAAE,OAAO;SAClB,CAAA;IACH,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,uCAAuC,GAAG,IAAI,CAAC,CAAA;AACjE,CAAC"}

package/dist/helpers.d.ts

@@ -0,0 +1,42 @@
+import type { IVerifiableCredential } from '@interop/data-integrity-core';
+export declare const CREDENTIALS_CONTEXT_V1_URL: string;
+export declare const CREDENTIALS_CONTEXT_V2_URL: string;
+export declare const dateRegex: RegExp;
+/**
+ * Asserts that a context array's first item is a credentials context.
+ *
+ * @throws {Error} If the first context is not a credentials context.
+ */
+export declare function assertCredentialContext({ context }: {
+    context: unknown[];
+}): void;
+/**
+ * Throws if a Date is not in the correct format.
+ *
+ * @throws {Error} Throws if the date is not a proper date string.
+ */
+export declare function assertDateString({ credential, prop }: {
+    credential: Record<string, unknown>;
+    prop: string;
+}): void;
+/**
+ * Checks if a VC is using a specific context version.
+ *
+ * @returns True if the first context matches the version.
+ */
+export declare function checkContextVersion({ credential, version }: {
+    credential?: IVerifiableCredential;
+    version: number;
+}): boolean;
+/**
+ * Compares two times with consideration of max clock skew.
+ *
+ * `maxClockSkew` is in seconds. Returns a number greater than, equal to, or
+ * less than zero, comparable to a sort comparator.
+ */
+export declare function compareTime({ t1, t2, maxClockSkew }: {
+    t1: Date | number;
+    t2: Date | number;
+    maxClockSkew: number;
+}): number;
+//# sourceMappingURL=helpers.d.ts.map

package/dist/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAA;AAEzE,eAAO,MAAM,0BAA0B,EAAE,MACgB,CAAA;AACzD,eAAO,MAAM,0BAA0B,EAAE,MACG,CAAA;AAK5C,eAAO,MAAM,SAAS,QAMrB,CAAA;AASD;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,EACtC,OAAO,EACR,EAAE;IACD,OAAO,EAAE,OAAO,EAAE,CAAA;CACnB,GAAG,IAAI,CASP;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,EAC/B,UAAU,EACV,IAAI,EACL,EAAE;IACD,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACnC,IAAI,EAAE,MAAM,CAAA;CACb,GAAG,IAAI,CAKP;AAgBD;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,EAClC,UAAU,EACV,OAAO,EACR,EAAE;IACD,UAAU,CAAC,EAAE,qBAAqB,CAAA;IAClC,OAAO,EAAE,MAAM,CAAA;CAChB,GAAG,OAAO,CAEV;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,EAC1B,EAAE,EACF,EAAE,EACF,YAAY,EACb,EAAE;IACD,EAAE,EAAE,IAAI,GAAG,MAAM,CAAA;IACjB,EAAE,EAAE,IAAI,GAAG,MAAM,CAAA;IACjB,YAAY,EAAE,MAAM,CAAA;CACrB,GAAG,MAAM,CAST"}

package/dist/helpers.js

@@ -0,0 +1,79 @@
+/*!
+ * Copyright (c) 2023 Digital Bazaar, Inc. All rights reserved.
+ */
+import * as credentialsContext from 'credentials-context';
+import * as credentialsContextV2 from '@digitalcredentials/credentials-v2-context';
+export const CREDENTIALS_CONTEXT_V1_URL = credentialsContext.constants.CREDENTIALS_CONTEXT_V1_URL;
+export const CREDENTIALS_CONTEXT_V2_URL = credentialsContextV2.constants.CONTEXT_URL;
+// Z and T must be uppercase
+// xml schema date time RegExp
+// @see https://www.w3.org/TR/xmlschema11-2/#dateTime
+export const dateRegex = new RegExp('-?([1-9][0-9]{3,}|0[0-9]{3})' +
+    '-(0[1-9]|1[0-2])' +
+    '-(0[1-9]|[12][0-9]|3[01])' +
+    'T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](.[0-9]+)?|(24:00:00(.0+)?))' +
+    '(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?');
+// entries should be in ascending version order
+// so v1 is entry 0
+const credentialContextUrls = new Set([
+    CREDENTIALS_CONTEXT_V1_URL,
+    CREDENTIALS_CONTEXT_V2_URL
+]);
+/**
+ * Asserts that a context array's first item is a credentials context.
+ *
+ * @throws {Error} If the first context is not a credentials context.
+ */
+export function assertCredentialContext({ context }) {
+    // ensure first context is credentials context url
+    if (credentialContextUrls.has(context[0]) === false) {
+        // throw if the first context is not a credentials context
+        throw new Error(`"${CREDENTIALS_CONTEXT_V1_URL}" or "${CREDENTIALS_CONTEXT_V2_URL}"` +
+            ' needs to be first in the list of contexts.');
+    }
+}
+/**
+ * Throws if a Date is not in the correct format.
+ *
+ * @throws {Error} Throws if the date is not a proper date string.
+ */
+export function assertDateString({ credential, prop }) {
+    const value = credential[prop];
+    if (!dateRegex.test(value)) {
+        throw new Error(`"${prop}" must be a valid date: ${value}`);
+    }
+}
+/**
+ * Turns the first context in a VC into a numbered version.
+ *
+ * @returns A number representing the version.
+ */
+function getContextVersion({ credential }) {
+    const firstContext = credential?.['@context']?.[0];
+    return [...credentialContextUrls].indexOf(firstContext) + 1;
+}
+/**
+ * Checks if a VC is using a specific context version.
+ *
+ * @returns True if the first context matches the version.
+ */
+export function checkContextVersion({ credential, version }) {
+    return getContextVersion({ credential }) === version;
+}
+/**
+ * Compares two times with consideration of max clock skew.
+ *
+ * `maxClockSkew` is in seconds. Returns a number greater than, equal to, or
+ * less than zero, comparable to a sort comparator.
+ */
+export function compareTime({ t1, t2, maxClockSkew }) {
+    const ms1 = Number(t1);
+    const ms2 = Number(t2);
+    // `maxClockSkew` is in seconds, so transform to milliseconds
+    if (Math.abs(ms1 - ms2) < maxClockSkew * 1000) {
+        // times are equal within the max clock skew
+        return 0;
+    }
+    return ms1 < ms2 ? -1 : 1;
+}
+//# sourceMappingURL=helpers.js.map

package/dist/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,kBAAkB,MAAM,qBAAqB,CAAA;AACzD,OAAO,KAAK,oBAAoB,MAAM,4CAA4C,CAAA;AAIlF,MAAM,CAAC,MAAM,0BAA0B,GACrC,kBAAkB,CAAC,SAAS,CAAC,0BAA0B,CAAA;AACzD,MAAM,CAAC,MAAM,0BAA0B,GACrC,oBAAoB,CAAC,SAAS,CAAC,WAAW,CAAA;AAE5C,4BAA4B;AAC5B,8BAA8B;AAC9B,qDAAqD;AACrD,MAAM,CAAC,MAAM,SAAS,GAAG,IAAI,MAAM,CACjC,8BAA8B;IAC5B,kBAAkB;IAClB,2BAA2B;IAC3B,wEAAwE;IACxE,gDAAgD,CACnD,CAAA;AAED,+CAA+C;AAC/C,mBAAmB;AACnB,MAAM,qBAAqB,GAAG,IAAI,GAAG,CAAS;IAC5C,0BAA0B;IAC1B,0BAA0B;CAC3B,CAAC,CAAA;AAEF;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CAAC,EACtC,OAAO,EAGR;IACC,kDAAkD;IAClD,IAAI,qBAAqB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAW,CAAC,KAAK,KAAK,EAAE,CAAC;QAC9D,0DAA0D;QAC1D,MAAM,IAAI,KAAK,CACb,IAAI,0BAA0B,SAAS,0BAA0B,GAAG;YAClE,6CAA6C,CAChD,CAAA;IACH,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,EAC/B,UAAU,EACV,IAAI,EAIL;IACC,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,CAAA;IAC9B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAe,CAAC,EAAE,CAAC;QACrC,MAAM,IAAI,KAAK,CAAC,IAAI,IAAI,2BAA2B,KAAK,EAAE,CAAC,CAAA;IAC7D,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,SAAS,iBAAiB,CAAC,EACzB,UAAU,EAGX;IACC,MAAM,YAAY,GAAG,UAAU,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IAClD,OAAO,CAAC,GAAG,qBAAqB,CAAC,CAAC,OAAO,CAAC,YAAsB,CAAC,GAAG,CAAC,CAAA;AACvE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,EAClC,UAAU,EACV,OAAO,EAIR;IACC,OAAO,iBAAiB,CAAC,EAAE,UAAU,EAAE,CAAC,KAAK,OAAO,CAAA;AACtD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,EAC1B,EAAE,EACF,EAAE,EACF,YAAY,EAKb;IACC,MAAM,GAAG,GAAG,MAAM,CAAC,EAAE,CAAC,CAAA;IACtB,MAAM,GAAG,GAAG,MAAM,CAAC,EAAE,CAAC,CAAA;IACtB,6DAA6D;IAC7D,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,YAAY,GAAG,IAAI,EAAE,CAAC;QAC9C,4CAA4C;QAC5C,OAAO,CAAC,CAAA;IACV,CAAC;IACD,OAAO,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AAC3B,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,279 @@
+import type { DocumentLoader, LinkedDataProof, LinkedDataSignature, ProofPurpose } from '@interop/jsonld-signatures';
+import type { IVerifiableCredential, IVerifiablePresentation } from '@interop/data-integrity-core';
+import { CredentialIssuancePurpose } from './CredentialIssuancePurpose.js';
+export { dateRegex } from './helpers.js';
+export declare const defaultDocumentLoader: DocumentLoader;
+export { CredentialIssuancePurpose };
+/** A verifiable credential. */
+export type VerifiableCredential = IVerifiableCredential;
+/** A verifiable presentation. */
+export type VerifiablePresentation = IVerifiablePresentation;
+/** A verifiable presentation (signed or unsigned). */
+export type Presentation = IVerifiablePresentation;
+/** A single entry in a fine-grained verification result `log`. */
+export interface LogEntry {
+    /** Check identifier (for example `valid_signature`). */
+    id: string;
+    /** Whether the check passed. */
+    valid: boolean;
+}
+/** The result of verifying a single credential. */
+export interface VerifyCredentialResult {
+    /** True if verified, false if not. */
+    verified: boolean;
+    /** Credential status check result. */
+    statusResult?: any;
+    /** Per-proof verification results. */
+    results?: any[];
+    /** Fine-grained check log. */
+    log?: LogEntry[];
+    /** The source credential, present when `includeCredentials` is `true`. */
+    credential?: VerifiableCredential;
+    /** The verified credential's id. */
+    credentialId?: string;
+    /** Set if verification failed. */
+    error?: Error;
+}
+/** The result of verifying a presentation. */
+export interface VerifyPresentationResult {
+    /** True if verified, false if not. */
+    verified: boolean;
+    /** Presentation proof result. */
+    presentationResult?: any;
+    /** Per-credential verification results. */
+    credentialResults?: VerifyCredentialResult[];
+    /** Present on the error and unsigned-presentation return paths. */
+    results?: any[];
+    /** Set if verification failed. */
+    error?: Error;
+}
+/** A function for checking credential status. */
+export type CheckStatus = (options: any) => Promise<any>;
+/** Options for {@link issue}. */
+export interface IssueCredentialOptions {
+    credential?: VerifiableCredential;
+    suite?: LinkedDataSignature;
+    purpose?: ProofPurpose;
+    documentLoader?: DocumentLoader;
+    now?: string | Date;
+    maxClockSkew?: number;
+}
+/** Options for {@link derive}. */
+export interface DeriveOptions {
+    verifiableCredential?: VerifiableCredential;
+    suite?: LinkedDataProof;
+    documentLoader?: DocumentLoader;
+}
+/** Options for {@link verifyCredential}. */
+export interface VerifyCredentialOptions {
+    credential?: VerifiableCredential;
+    suite?: LinkedDataProof | LinkedDataProof[];
+    purpose?: ProofPurpose;
+    controller?: object;
+    documentLoader?: DocumentLoader;
+    checkStatus?: CheckStatus;
+    now?: string | Date;
+    maxClockSkew?: number;
+}
+/** Options for {@link verify}. */
+export interface VerifyPresentationOptions {
+    presentation?: VerifiablePresentation;
+    suite?: LinkedDataProof | LinkedDataProof[];
+    unsignedPresentation?: boolean;
+    presentationPurpose?: ProofPurpose;
+    challenge?: string;
+    controller?: object;
+    domain?: string;
+    documentLoader?: DocumentLoader;
+    checkStatus?: CheckStatus;
+    now?: string | Date;
+    maxClockSkew?: number;
+    includeCredentials?: boolean;
+}
+/** Options for {@link createPresentation}. */
+export interface CreatePresentationOptions {
+    verifiableCredential?: VerifiableCredential | VerifiableCredential[];
+    id?: string;
+    holder?: string;
+    now?: string | Date;
+    version?: number;
+    verify?: boolean;
+    maxClockSkew?: number;
+}
+/** Options for {@link signPresentation}. */
+export interface SignPresentationOptions {
+    presentation?: Presentation;
+    suite?: LinkedDataSignature;
+    purpose?: ProofPurpose;
+    domain?: string;
+    challenge?: string;
+    documentLoader?: DocumentLoader;
+}
+/** Options for {@link _checkCredential}. */
+export interface CheckCredentialOptions {
+    credential: VerifiableCredential;
+    log?: LogEntry[];
+    now?: string | Date;
+    mode?: string;
+    maxClockSkew?: number;
+}
+/**
+ * Issues a verifiable credential (by taking a base credential document,
+ * and adding a digital signature to it).
+ *
+ * @param options - The options to use.
+ * @param options.credential - Base credential document.
+ * @param options.suite - Signature suite (with private key material or an API
+ *   to use it), passed in to `sign()`.
+ * @param options.purpose - A ProofPurpose. If not specified, a default purpose
+ *   will be created.
+ * @param options.documentLoader - A document loader.
+ * @param options.now - A string representing date time in ISO 8601 format or an
+ *   instance of Date. Defaults to current date time.
+ * @param options.maxClockSkew - A maximum number of seconds that clocks may be
+ *   skewed when checking date-times against `now`.
+ *
+ * @throws {Error} If missing required properties.
+ *
+ * @returns Resolves on completion.
+ */
+export declare function issue({ credential, suite, purpose, documentLoader, now, maxClockSkew }?: IssueCredentialOptions): Promise<VerifiableCredential>;
+/**
+ * Derives a proof from the given verifiable credential, resulting in a new
+ * verifiable credential. This method is usually used to generate selective
+ * disclosure and / or unlinkable proofs.
+ *
+ * @param options - The options to use.
+ * @param options.verifiableCredential - The verifiable credential containing a
+ *   base proof to derive another proof from.
+ * @param options.suite - Derived proof signature suite.
+ * @param options.documentLoader - A document loader.
+ *
+ * @throws {Error} If missing required properties.
+ *
+ * @returns Resolves on completion.
+ */
+export declare function derive({ verifiableCredential, suite, documentLoader }?: DeriveOptions): Promise<VerifiableCredential>;
+/**
+ * Verifies a verifiable presentation:
+ *   - Checks that the presentation is well-formed
+ *   - Checks the proofs (for example, checks digital signatures against the
+ *     provided public keys).
+ *
+ * @param options - The options to use.
+ * @param options.presentation - Verifiable presentation, signed or unsigned,
+ *   that may contain within it a verifiable credential.
+ * @param options.suite - One or more signature suites that are supported by the
+ *   caller's use case. This is an explicit design decision -- the calling code
+ *   must specify which signature types (ed25519, RSA, etc) are allowed.
+ *   Although it is expected that the secure resolution/fetching of the public
+ *   key material (to verify against) is to be handled by the documentLoader,
+ *   the suite param can optionally include the key directly.
+ * @param options.unsignedPresentation - By default, this function assumes that
+ *   a presentation is signed (and will return an error if a `proof` section is
+ *   missing). Set this to `true` if you're using an unsigned presentation.
+ * @param options.presentationPurpose - Optional proof purpose (a default one
+ *   will be created if not passed in).
+ * @param options.challenge - Required if purpose is not passed in.
+ * @param options.controller - A controller.
+ * @param options.domain - A domain.
+ * @param options.documentLoader - A document loader.
+ * @param options.checkStatus - Optional function for checking credential status
+ *   if `credentialStatus` is present on the credential.
+ * @param options.now - A string representing date time in ISO 8601 format or an
+ *   instance of Date. Defaults to current date time.
+ * @param options.maxClockSkew - A maximum number of seconds that clocks may be
+ *   skewed when checking date-times against `now`.
+ * @param options.includeCredentials - Set to `true` to include each verified
+ *   `credential` in its entry in `credentialResults`. Defaults to `true` to
+ *   preserve backwards compatibility; set to `false` to omit them.
+ *
+ * @returns The verification result.
+ */
+export declare function verify(options?: VerifyPresentationOptions): Promise<VerifyPresentationResult>;
+/**
+ * Verifies a verifiable credential:
+ *   - Checks that the credential is well-formed
+ *   - Checks the proofs (for example, checks digital signatures against the
+ *     provided public keys).
+ *
+ * @param options - The options.
+ * @param options.credential - Verifiable credential.
+ * @param options.suite - One or more signature suites that are supported by the
+ *   caller's use case. This is an explicit design decision -- the calling code
+ *   must specify which signature types (ed25519, RSA, etc) are allowed.
+ *   Although it is expected that the secure resolution/fetching of the public
+ *   key material (to verify against) is to be handled by the documentLoader,
+ *   the suite param can optionally include the key directly.
+ * @param options.purpose - Optional proof purpose (a default one will be
+ *   created if not passed in).
+ * @param options.documentLoader - A document loader.
+ * @param options.checkStatus - Optional function for checking credential status
+ *   if `credentialStatus` is present on the credential.
+ * @param options.now - A string representing date time in ISO 8601 format or an
+ *   instance of Date. Defaults to current date time.
+ * @param options.maxClockSkew - A maximum number of seconds that clocks may be
+ *   skewed when checking date-times against `now`.
+ *
+ * @returns The verification result.
+ */
+export declare function verifyCredential(options?: VerifyCredentialOptions): Promise<VerifyCredentialResult>;
+/**
+ * Creates an unsigned presentation from a given verifiable credential.
+ *
+ * @param options - Options to use.
+ * @param options.verifiableCredential - One or more verifiable credential.
+ * @param options.id - Optional VP id.
+ * @param options.holder - Optional presentation holder url.
+ * @param options.now - A string representing date time in ISO 8601 format or an
+ *   instance of Date. Defaults to current date time.
+ * @param options.version - The VC context version to use.
+ * @param options.verify - If set to true, throw verification errors for
+ *   individual VCs (such as when the VC is expired, etc).
+ * @param options.maxClockSkew - A maximum number of seconds that clocks may be
+ *   skewed when checking date-times against `now`.
+ *
+ * @throws {TypeError} If verifiableCredential param is missing.
+ * @throws {Error} If the credential (or the presentation params) are missing
+ *   required properties.
+ *
+ * @returns The credential wrapped inside of a VerifiablePresentation.
+ */
+export declare function createPresentation({ verifiableCredential, id, holder, now, version, verify, maxClockSkew }?: CreatePresentationOptions): Presentation;
+/**
+ * Signs a given presentation.
+ *
+ * @param options - Options to use.
+ * @param options.presentation - A presentation.
+ * @param options.suite - Passed in to `sign()`.
+ * @param options.purpose - A ProofPurpose. If not specified, a default purpose
+ *   will be created with the domain and challenge options.
+ * @param options.domain - A domain.
+ * @param options.challenge - A required challenge.
+ * @param options.documentLoader - A document loader.
+ *
+ * @returns A VerifiablePresentation with a proof.
+ */
+export declare function signPresentation(options?: SignPresentationOptions): Promise<VerifiablePresentation>;
+/**
+ * @param presentation - An object that could be a presentation.
+ *
+ * @throws {Error}
+ */
+export declare function _checkPresentation(presentation: Presentation): void;
+/**
+ * @param options - The options.
+ * @param options.credential - An object that could be a VerifiableCredential.
+ * @param options.log - Optional events log, for fine-grained verification
+ *   result reporting.
+ * @param options.now - A string representing date time in ISO 8601 format or an
+ *   instance of Date. Defaults to current date time.
+ * @param options.mode - The mode of operation for this validation function,
+ *   either `issue` or `verify`.
+ * @param options.maxClockSkew - A maximum number of seconds that clocks may be
+ *   skewed when checking date-times against `now`.
+ *
+ * @throws {Error}
+ */
+export declare function _checkCredential({ credential, log, now, mode, maxClockSkew }: CheckCredentialOptions): void;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAwCA,OAAO,KAAK,EAEV,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,YAAY,EACb,MAAM,4BAA4B,CAAA;AAEnC,OAAO,KAAK,EAEV,qBAAqB,EACrB,uBAAuB,EACxB,MAAM,8BAA8B,CAAA;AAUrC,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAA;AAI1E,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AACxC,eAAO,MAAM,qBAAqB,EAAE,cACQ,CAAA;AAC5C,OAAO,EAAE,yBAAyB,EAAE,CAAA;AAEpC,+BAA+B;AAC/B,MAAM,MAAM,oBAAoB,GAAG,qBAAqB,CAAA;AAExD,iCAAiC;AACjC,MAAM,MAAM,sBAAsB,GAAG,uBAAuB,CAAA;AAE5D,sDAAsD;AACtD,MAAM,MAAM,YAAY,GAAG,uBAAuB,CAAA;AAKlD,kEAAkE;AAClE,MAAM,WAAW,QAAQ;IACvB,wDAAwD;IACxD,EAAE,EAAE,MAAM,CAAA;IACV,gCAAgC;IAChC,KAAK,EAAE,OAAO,CAAA;CACf;AAED,mDAAmD;AACnD,MAAM,WAAW,sBAAsB;IACrC,sCAAsC;IACtC,QAAQ,EAAE,OAAO,CAAA;IACjB,sCAAsC;IACtC,YAAY,CAAC,EAAE,GAAG,CAAA;IAClB,sCAAsC;IACtC,OAAO,CAAC,EAAE,GAAG,EAAE,CAAA;IACf,8BAA8B;IAC9B,GAAG,CAAC,EAAE,QAAQ,EAAE,CAAA;IAChB,0EAA0E;IAC1E,UAAU,CAAC,EAAE,oBAAoB,CAAA;IACjC,oCAAoC;IACpC,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,kCAAkC;IAClC,KAAK,CAAC,EAAE,KAAK,CAAA;CACd;AAED,8CAA8C;AAC9C,MAAM,WAAW,wBAAwB;IACvC,sCAAsC;IACtC,QAAQ,EAAE,OAAO,CAAA;IACjB,iCAAiC;IACjC,kBAAkB,CAAC,EAAE,GAAG,CAAA;IACxB,2CAA2C;IAC3C,iBAAiB,CAAC,EAAE,sBAAsB,EAAE,CAAA;IAC5C,mEAAmE;IACnE,OAAO,CAAC,EAAE,GAAG,EAAE,CAAA;IACf,kCAAkC;IAClC,KAAK,CAAC,EAAE,KAAK,CAAA;CACd;AAED,iDAAiD;AACjD,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC,CAAA;AAExD,iCAAiC;AACjC,MAAM,WAAW,sBAAsB;IACrC,UAAU,CAAC,EAAE,oBAAoB,CAAA;IACjC,KAAK,CAAC,EAAE,mBAAmB,CAAA;IAC3B,OAAO,CAAC,EAAE,YAAY,CAAA;IACtB,cAAc,CAAC,EAAE,cAAc,CAAA;IAC/B,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,kCAAkC;AAClC,MAAM,WAAW,aAAa;IAC5B,oBAAoB,CAAC,EAAE,oBAAoB,CAAA;IAC3C,KAAK,CAAC,EAAE,eAAe,CAAA;IACvB,cAAc,CAAC,EAAE,cAAc,CAAA;CAChC;AAED,4CAA4C;AAC5C,MAAM,WAAW,uBAAuB;IACtC,UAAU,CAAC,EAAE,oBAAoB,CAAA;IACjC,KAAK,CAAC,EAAE,eAAe,GAAG,eAAe,EAAE,CAAA;IAC3C,OAAO,CAAC,EAAE,YAAY,CAAA;IACtB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,cAAc,CAAC,EAAE,cAAc,CAAA;IAC/B,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,kCAAkC;AAClC,MAAM,WAAW,yBAAyB;IACxC,YAAY,CAAC,EAAE,sBAAsB,CAAA;IACrC,KAAK,CAAC,EAAE,eAAe,GAAG,eAAe,EAAE,CAAA;IAC3C,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAC9B,mBAAmB,CAAC,EAAE,YAAY,CAAA;IAClC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,cAAc,CAAC,EAAE,cAAc,CAAA;IAC/B,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,kBAAkB,CAAC,EAAE,OAAO,CAAA;CAC7B;AAED,8CAA8C;AAC9C,MAAM,WAAW,yBAAyB;IACxC,oBAAoB,CAAC,EAAE,oBAAoB,GAAG,oBAAoB,EAAE,CAAA;IACpE,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,4CAA4C;AAC5C,MAAM,WAAW,uBAAuB;IACtC,YAAY,CAAC,EAAE,YAAY,CAAA;IAC3B,KAAK,CAAC,EAAE,mBAAmB,CAAA;IAC3B,OAAO,CAAC,EAAE,YAAY,CAAA;IACtB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,cAAc,CAAC,EAAE,cAAc,CAAA;CAChC;AAED,4CAA4C;AAC5C,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,oBAAoB,CAAA;IAChC,GAAG,CAAC,EAAE,QAAQ,EAAE,CAAA;IAChB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAsB,KAAK,CAAC,EAC1B,UAAU,EACV,KAAK,EACL,OAAyC,EACzC,cAAsC,EACtC,GAAG,EACH,YAAkB,EACnB,GAAE,sBAA2B,GAAG,OAAO,CAAC,oBAAoB,CAAC,CA6B7D;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,MAAM,CAAC,EAC3B,oBAAoB,EACpB,KAAK,EACL,cAAsC,EACvC,GAAE,aAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAgBpD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAsB,MAAM,CAC1B,OAAO,GAAE,yBAA8B,GACtC,OAAO,CAAC,wBAAwB,CAAC,CAgBnC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAsB,gBAAgB,CACpC,OAAO,GAAE,uBAA4B,GACpC,OAAO,CAAC,sBAAsB,CAAC,CAcjC;AAmGD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,kBAAkB,CAAC,EACjC,oBAAoB,EACpB,EAAE,EACF,MAAM,EACN,GAAG,EACH,OAAa,EACb,MAAa,EACb,YAAkB,EACnB,GAAE,yBAA8B,GAAG,YAAY,CAoC/C;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,gBAAgB,CACpC,OAAO,GAAE,uBAA4B,GACpC,OAAO,CAAC,sBAAsB,CAAC,CAmBjC;AA8GD;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI,CAanE;AAOD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,gBAAgB,CAAC,EAC/B,UAAU,EACV,GAAQ,EACR,GAAgB,EAChB,IAAe,EACf,YAAkB,EACnB,EAAE,sBAAsB,GAAG,IAAI,CAyJ/B"}