@sphereon/ssi-sdk.presentation-exchange 0.11.1-next.106

package/dist/types/IPresentationExchange.d.ts

@@ -0,0 +1,81 @@
+import { DIDDocumentSection, FindCredentialsArgs, IAgentContext, IDataStoreORM, IDIDManager, IIdentifier, IPluginMethodMap, PresentationPayload } from '@veramo/core';
+import { W3CVerifiableCredential, W3CVerifiablePresentation } from '@sphereon/ssi-types';
+import { IKeyValueStore, IValueData } from '@sphereon/ssi-sdk.kv-store-temp';
+import { IPresentationDefinition, PEVersion, SelectResults } from '@sphereon/pex';
+import { Format, InputDescriptorV1, InputDescriptorV2 } from '@sphereon/pex-models';
+export interface IPresentationExchange extends IPluginMethodMap {
+    pexStoreGetDefinition(args: IDefinitionGetArgs): Promise<IPresentationDefinition | undefined>;
+    pexStoreHasDefinition(args: IDefinitionExistsArgs): Promise<boolean>;
+    pexStorePersistDefinition(args: IDefinitionPersistArgs): Promise<IValueData<IPresentationDefinition>>;
+    pexStoreRemoveDefinition(args: IDefinitionRemoveArgs): Promise<boolean>;
+    pexStoreClearDefinitions(args: IDefinitionsClearArgs): Promise<boolean>;
+    pexDefinitionVersion(presentationDefinition: IPresentationDefinition): Promise<VersionDiscoveryResult>;
+    pexDefinitionFilterCredentials(args: IDefinitionCredentialFilterArgs, context: IRequiredContext): Promise<IPEXFilterResult>;
+    pexDefinitionFilterCredentialsPerInputDescriptor(args: IDefinitionCredentialFilterArgs, context: IRequiredContext): Promise<IPEXFilterResultWithInputDescriptor[]>;
+}
+export interface IDefinitionGetArgs {
+    definitionId: string;
+    storeId?: string;
+    namespace?: string;
+}
+export type IDefinitionExistsArgs = IDefinitionGetArgs;
+export type IDefinitionClearArgs = IDefinitionGetArgs;
+export type IDefinitionRemoveArgs = IDefinitionGetArgs;
+export type IDefinitionImportArgs = IDefinitionPersistArgs;
+export interface IDefinitionPersistArgs {
+    definition: IPresentationDefinition;
+    definitionId?: string;
+    overwriteExisting?: boolean;
+    validation?: boolean;
+    ttl?: number;
+    storeId?: string;
+    namespace?: string;
+}
+export interface IDefinitionsClearArgs {
+    storeId?: string;
+}
+export interface IDefinitionCredentialFilterArgs {
+    presentationDefinition: IPresentationDefinition;
+    credentialFilterOpts?: {
+        verifiableCredentials?: W3CVerifiableCredential[];
+        filter?: FindCredentialsArgs;
+    };
+    holderDIDs?: (string | IIdentifier)[];
+    limitDisclosureSignatureSuites?: string[];
+    restrictToFormats?: Format;
+    restrictToDIDMethods?: string[];
+}
+export interface PEXOpts {
+    defaultStore?: string;
+    defaultNamespace?: string;
+    stores?: Map<string, IKeyValueStore<IPresentationDefinition>> | IKeyValueStore<IPresentationDefinition>;
+    importDefinitions?: IDefinitionImportArgs[];
+}
+export interface IPEXOptions {
+    definition?: IPresentationDefinition;
+    definitionId: string;
+}
+export interface IPEXFilterResultWithInputDescriptor extends IPEXFilterResult {
+    inputDescriptor: InputDescriptorV1 | InputDescriptorV2;
+}
+export interface IPEXFilterResult {
+    id: string;
+    selectResults: SelectResults;
+    filteredCredentials: W3CVerifiableCredential[];
+}
+export interface IIdentifierOpts {
+    identifier: IIdentifier | string;
+    verificationMethodSection?: DIDDocumentSection;
+    kid?: string;
+}
+export interface VersionDiscoveryResult {
+    version?: PEVersion;
+    error?: string;
+}
+export type IPEXPresentationSignCallback = (args: IPEXPresentationSignCallBackParams) => Promise<W3CVerifiablePresentation>;
+export interface IPEXPresentationSignCallBackParams {
+    presentation: PresentationPayload;
+    presentationDefinition: IPresentationDefinition;
+}
+export type IRequiredContext = IAgentContext<IDataStoreORM & IDIDManager>;
+//# sourceMappingURL=IPresentationExchange.d.ts.map

package/dist/types/IPresentationExchange.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IPresentationExchange.d.ts","sourceRoot":"","sources":["../../src/types/IPresentationExchange.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,mBAAmB,EACnB,aAAa,EACb,aAAa,EACb,WAAW,EACX,WAAW,EACX,gBAAgB,EAChB,mBAAmB,EACpB,MAAM,cAAc,CAAA;AACrB,OAAO,EAAE,uBAAuB,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAA;AACxF,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAA;AAC5E,OAAO,EAAE,uBAAuB,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AACjF,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAEnF,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC7D,qBAAqB,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,uBAAuB,GAAG,SAAS,CAAC,CAAA;IAE7F,qBAAqB,CAAC,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAEpE,yBAAyB,CAAC,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,UAAU,CAAC,uBAAuB,CAAC,CAAC,CAAA;IAErG,wBAAwB,CAAC,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAEvE,wBAAwB,CAAC,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAEvE,oBAAoB,CAAC,sBAAsB,EAAE,uBAAuB,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAEtG,8BAA8B,CAAC,IAAI,EAAE,+BAA+B,EAAE,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAE3H,gDAAgD,CAC9C,IAAI,EAAE,+BAA+B,EACrC,OAAO,EAAE,gBAAgB,GACxB,OAAO,CAAC,mCAAmC,EAAE,CAAC,CAAA;CAClD;AAED,MAAM,WAAW,kBAAkB;IACjC,YAAY,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,MAAM,qBAAqB,GAAG,kBAAkB,CAAA;AACtD,MAAM,MAAM,oBAAoB,GAAG,kBAAkB,CAAA;AACrD,MAAM,MAAM,qBAAqB,GAAG,kBAAkB,CAAA;AAEtD,MAAM,MAAM,qBAAqB,GAAG,sBAAsB,CAAA;AAE1D,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,uBAAuB,CAAA;IACnC,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC,OAAO,CAAC,EAAE,MAAM,CAAA;CAEjB;AAED,MAAM,WAAW,+BAA+B;IAC9C,sBAAsB,EAAE,uBAAuB,CAAA;IAC/C,oBAAoB,CAAC,EAAE;QAAE,qBAAqB,CAAC,EAAE,uBAAuB,EAAE,CAAC;QAAC,MAAM,CAAC,EAAE,mBAAmB,CAAA;KAAE,CAAA;IAC1G,UAAU,CAAC,EAAE,CAAC,MAAM,GAAG,WAAW,CAAC,EAAE,CAAA;IACrC,8BAA8B,CAAC,EAAE,MAAM,EAAE,CAAA;IACzC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAA;CAChC;AAED,MAAM,WAAW,OAAO;IACtB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,MAAM,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,uBAAuB,CAAC,CAAC,GAAG,cAAc,CAAC,uBAAuB,CAAC,CAAA;IACvG,iBAAiB,CAAC,EAAE,qBAAqB,EAAE,CAAA;CAC5C;AAED,MAAM,WAAW,WAAW;IAE1B,UAAU,CAAC,EAAE,uBAAuB,CAAA;IACpC,YAAY,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,mCAAoC,SAAQ,gBAAgB;IAC3E,eAAe,EAAE,iBAAiB,GAAG,iBAAiB,CAAA;CACvD;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,aAAa,EAAE,aAAa,CAAA;IAC5B,mBAAmB,EAAE,uBAAuB,EAAE,CAAA;CAC/C;AAED,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,WAAW,GAAG,MAAM,CAAA;IAChC,yBAAyB,CAAC,EAAE,kBAAkB,CAAA;IAC9C,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,sBAAsB;IACrC,OAAO,CAAC,EAAE,SAAS,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,MAAM,4BAA4B,GAAG,CAAC,IAAI,EAAE,kCAAkC,KAAK,OAAO,CAAC,yBAAyB,CAAC,CAAA;AAE3H,MAAM,WAAW,kCAAkC;IACjD,YAAY,EAAE,mBAAmB,CAAA;IACjC,sBAAsB,EAAE,uBAAuB,CAAA;CAChD;AAED,MAAM,MAAM,gBAAgB,GAAG,aAAa,CAAC,aAAa,GAAG,WAAW,CAAC,CAAA"}

package/dist/types/IPresentationExchange.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IPresentationExchange.js.map

package/dist/types/IPresentationExchange.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IPresentationExchange.js","sourceRoot":"","sources":["../../src/types/IPresentationExchange.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@sphereon/ssi-sdk.presentation-exchange",
+  "version": "0.11.1-next.106+62d7281",
+  "source": "src/index.ts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "veramo": {
+    "pluginInterfaces": {
+      "IPresentationExchange": "./src/types/IPresentationExchange.ts"
+    }
+  },
+  "scripts": {
+    "build": "tsc --build",
+    "build:clean": "tsc --build --clean && tsc --build"
+  },
+  "dependencies": {
+    "@sphereon/pex": "2.0.1",
+    "@sphereon/pex-models": "^2.0.2",
+    "@sphereon/ssi-sdk-ext.did-utils": "^0.12.0",
+    "@sphereon/ssi-sdk.kv-store-temp": "0.11.1-next.106+62d7281",
+    "@sphereon/ssi-types": "0.11.1-next.106+62d7281",
+    "@veramo/core": "4.2.0"
+  },
+  "devDependencies": {
+    "@sphereon/did-uni-client": "^0.6.0",
+    "@sphereon/ssi-sdk.agent-config": "0.11.1-next.106+62d7281",
+    "@types/json-buffer": "^3.0.0",
+    "@veramo/did-provider-key": "4.2.0",
+    "@veramo/did-resolver": "4.2.0",
+    "@veramo/remote-client": "4.2.0",
+    "@veramo/remote-server": "4.2.0",
+    "@veramo/utils": "4.2.0",
+    "did-resolver": "^4.1.0",
+    "nock": "^13.2.1"
+  },
+  "resolutions": {
+    "@veramo/utils": "4.2.0"
+  },
+  "files": [
+    ".yalc/**/*",
+    "dist/**/*",
+    "src/**/*",
+    "README.md",
+    "plugin.schema.json",
+    "LICENSE"
+  ],
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": "git@github.com:Sphereon-Opensource/SSI-SDK.git",
+  "author": "Sphereon <dev@sphereon.com>",
+  "license": "Apache-2.0",
+  "keywords": [
+    "Sphereon",
+    "SSI",
+    "Veramo",
+    "DID",
+    "SIOP",
+    "SIOPv2",
+    "OIDC4VP",
+    "Presentation Exchange",
+    "OpenID Connect",
+    "Authenticator"
+  ],
+  "gitHead": "62d728147f0b25f82f6589598cb37ec971e1f9df"
+}

package/plugin.schema.json

@@ -0,0 +1,329 @@
+{
+  "IDidAuthSiopOpAuthenticator": {
+    "components": {
+      "schemas": {
+        "IGetSiopSessionArgs": {
+          "type": "object",
+          "properties": {
+            "sessionId": {
+              "type": "string"
+            },
+            "additionalProperties": false
+          },
+          "required": ["sessionId"],
+          "description": "Arguments needed for {@link DidAuthSiopOpAuthenticator.getSessionForSiop } "
+        },
+        "IRegisterSiopSessionArgs": {
+          "type": "object",
+          "properties": {
+            "identifier": {
+              "type": "object",
+              "properties": {
+                "did": {
+                  "type": "string"
+                },
+                "alias": {
+                  "type": "string"
+                },
+                "provider": {
+                  "type": "string"
+                },
+                "controllerKeyId": {
+                  "type": "string"
+                },
+                "keys": {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "additionalProperties": true
+                    }
+                  }
+                },
+                "services": {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "additionalProperties": true
+                    }
+                  }
+                }
+              },
+              "additionalProperties": false,
+              "required": ["did", "provider", "keys", "services"]
+            },
+            "sessionId": {
+              "type": "string"
+            },
+            "expiresIn": {
+              "type": "number"
+            },
+            "additionalProperties": false
+          },
+          "required": ["identifier"],
+          "description": "Arguments needed for {@link DidAuthSiopOpAuthenticator.registerSessionForSiop } "
+        },
+        "IRemoveSiopSessionArgs": {
+          "type": "object",
+          "properties": {
+            "sessionId": {
+              "type": "string"
+            },
+            "additionalProperties": false
+          },
+          "required": ["sessionId"],
+          "description": "Arguments needed for {@link DidAuthSiopOpAuthenticator.removeSessionForSiop } "
+        },
+        "IAuthenticateWithSiopArgs": {
+          "type": "object",
+          "properties": {
+            "sessionId": {
+              "type": "string"
+            },
+            "stateId": {
+              "type": "string"
+            },
+            "redirectUrl": {
+              "type": "string"
+            },
+            "additionalProperties": false
+          },
+          "required": ["sessionId", "stateId", "redirectUrl"],
+          "description": "Arguments needed for {@link DidAuthSiopOpAuthenticator.authenticateWithSiop } "
+        },
+        "IResponse": {
+          "type": "object",
+          "properties": {
+            "status": {
+              "type": "number"
+            },
+            "additionalProperties": true
+          },
+          "required": ["status"],
+          "description": "Result of {@link DidAuthSiopOpAuthenticator.authenticateWithSiop & DidAuthSiopOpAuthenticator.sendSiopAuthenticationResponse } "
+        },
+        "IGetSiopAuthenticationRequestFromRpArgs": {
+          "type": "object",
+          "properties": {
+            "sessionId": {
+              "type": "string"
+            },
+            "stateId": {
+              "type": "string"
+            },
+            "redirectUrl": {
+              "type": "string"
+            },
+            "additionalProperties": false
+          },
+          "required": ["sessionId", "stateId", "redirectUrl"],
+          "description": "Arguments needed for {@link DidAuthSiopOpAuthenticator.getSiopAuthenticationRequestFromRP } "
+        },
+        "ParsedAuthenticationRequestURI": {
+          "type": "object",
+          "properties": {
+            "jwt": {
+              "type": "string"
+            },
+            "requestPayload": {
+              "type": "object",
+              "properties": {
+                "additionalProperties": true
+              }
+            },
+            "registration": {
+              "type": "object",
+              "properties": {
+                "additionalProperties": true
+              }
+            },
+            "additionalProperties": false
+          },
+          "required": ["jwt", "requestPayload", "registration"],
+          "description": "Result of {@link DidAuthSiopOpAuthenticator.getSiopAuthenticationRequestFromRP } "
+        },
+        "IGetSiopAuthenticationRequestDetailsArgs": {
+          "type": "object",
+          "properties": {
+            "sessionId": {
+              "type": "string"
+            },
+            "verifiedAuthenticationRequest": {
+              "type": "object",
+              "properties": {
+                "additionalProperties": true
+              }
+            },
+            "credentialFilter": {
+              "type": "object",
+              "properties": {
+                "additionalProperties": true
+              }
+            },
+            "additionalProperties": false
+          },
+          "required": ["sessionId", "verifiedAuthenticationRequest"],
+          "description": "Arguments needed for {@link DidAuthSiopOpAuthenticator.getSiopAuthenticationRequestDetails } "
+        },
+        "IAuthRequestDetails": {
+          "type": "object",
+          "properties": {
+            "id": {
+              "type": "string"
+            },
+            "alsoKnownAs": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "vpResponseOpts": {
+              "type": "object",
+              "properties": {
+                "additionalProperties": true
+              }
+            },
+            "additionalProperties": false
+          },
+          "required": ["id", "vpResponseOpts"],
+          "description": "Result of {@link DidAuthSiopOpAuthenticator.getSiopAuthenticationRequestDetails } "
+        },
+        "IVerifySiopAuthenticationRequestUriArgs": {
+          "type": "object",
+          "properties": {
+            "sessionId": {
+              "type": "string"
+            },
+            "ParsedAuthenticationRequestURI": {
+              "type": "object",
+              "properties": {
+                "additionalProperties": true
+              }
+            },
+            "additionalProperties": false
+          },
+          "required": ["sessionId", "ParsedAuthenticationRequestURI"],
+          "description": "Arguments needed for {@link DidAuthSiopOpAuthenticator.verifySiopAuthenticationRequestURI } "
+        },
+        "VerifiedAuthorizationRequest": {
+          "type": "object",
+          "properties": {
+            "payload": {
+              "type": "object",
+              "properties": {
+                "additionalProperties": true
+              }
+            },
+            "presentationDefinitions": {
+              "type": "object",
+              "properties": {
+                "additionalProperties": true
+              }
+            },
+            "verifyOpts": {
+              "type": "object",
+              "properties": {
+                "additionalProperties": true
+              }
+            },
+            "additionalProperties": false
+          },
+          "required": ["payload", "verifyOpts"],
+          "description": "Result of {@link DidAuthSiopOpAuthenticator.verifySiopAuthenticationRequestURI } "
+        },
+        "ISendSiopAuthenticationResponseArgs": {
+          "type": "object",
+          "properties": {
+            "sessionId": {
+              "type": "string"
+            },
+            "verifiedAuthenticationRequest": {
+              "type": "object",
+              "properties": {
+                "additionalProperties": true
+              }
+            },
+            "verifiablePresentationResponse": {
+              "type": "object",
+              "properties": {
+                "additionalProperties": true
+              }
+            },
+            "additionalProperties": false
+          },
+          "required": ["sessionId", "verifiedAuthenticationRequest"],
+          "description": "Arguments needed for {@link DidAuthSiopOpAuthenticator.sendSiopAuthenticationResponse } "
+        }
+      },
+      "methods": {
+        "getSessionForSiop": {
+          "description": "Get SIOP session",
+          "arguments": {
+            "$ref": "#/components/schemas/IGetSiopSessionArgs"
+          },
+          "returnType": "object"
+        },
+        "registerSessionForSiop": {
+          "description": "Register SIOP session",
+          "arguments": {
+            "$ref": "#/components/schemas/IRegisterSiopSessionArgs"
+          },
+          "returnType": "object"
+        },
+        "removeSessionForSiop": {
+          "description": "Remove SIOP session",
+          "arguments": {
+            "$ref": "#/components/schemas/IRemoveSiopSessionArgs"
+          },
+          "returnType": "boolean"
+        },
+        "authenticateWithSiop": {
+          "description": "Authenticate using DID Auth SIOP",
+          "arguments": {
+            "$ref": "#/components/schemas/IAuthenticateWithSiopArgs"
+          },
+          "returnType": {
+            "$ref": "#/components/schemas/Response"
+          }
+        },
+        "getSiopAuthenticationRequestFromRP": {
+          "description": "Get authentication request from RP",
+          "arguments": {
+            "$ref": "#/components/schemas/IGetSiopAuthenticationRequestFromRpArgs"
+          },
+          "returnType": {
+            "$ref": "#/components/schemas/ParsedAuthenticationRequestURI"
+          }
+        },
+        "getSiopAuthenticationRequestDetails": {
+          "description": "Get authentication request details",
+          "arguments": {
+            "$ref": "#/components/schemas/IGetSiopAuthenticationRequestDetailsArgs"
+          },
+          "returnType": {
+            "$ref": "#/components/schemas/IAuthRequestDetails"
+          }
+        },
+        "verifySiopAuthenticationRequestURI": {
+          "description": "Verify authentication request URI",
+          "arguments": {
+            "$ref": "#/components/schemas/IVerifySiopAuthenticationRequestUriArgs"
+          },
+          "returnType": {
+            "$ref": "#/components/schemas/VerifiedAuthorizationRequest"
+          }
+        },
+        "sendSiopAuthenticationResponse": {
+          "description": "Send authentication response",
+          "arguments": {
+            "$ref": "#/components/schemas/ISendSiopAuthenticationResponseArgs"
+          },
+          "returnType": {
+            "$ref": "#/components/schemas/IRequiredContext"
+          }
+        }
+      }
+    }
+  }
+}