@sphereon/ssi-sdk.linked-vp 0.34.1-feature.SSISDK.82.linkedVP.325

package/dist/index.d.ts

@@ -0,0 +1,447 @@
+import { IPluginMethodMap, IAgentContext, IAgentPlugin } from '@veramo/core';
+import { IIdentifierResolution } from '@sphereon/ssi-sdk-ext.identifier-resolution';
+import { ICredentialStore } from '@sphereon/ssi-sdk.credential-store';
+import { VcdmCredentialPlugin } from '@sphereon/ssi-sdk.credential-vcdm';
+import { IKeyManager } from '@veramo/core/src/types/IKeyManager';
+
+var ILinkedVPManager$1 = {
+	components: {
+		schemas: {
+			GeneratePresentationArgs: {
+				type: "object",
+				properties: {
+					linkedVpId: {
+						type: "string"
+					}
+				},
+				required: [
+					"linkedVpId"
+				],
+				additionalProperties: false
+			},
+			LinkedVPPresentation: {
+				anyOf: [
+					{
+						type: "string"
+					},
+					{
+						$ref: "#/components/schemas/Record<string,any>"
+					}
+				]
+			},
+			"Record<string,any>": {
+				type: "object"
+			},
+			GetServiceEntriesArgs: {
+				type: "object",
+				properties: {
+					tenantId: {
+						type: "string"
+					}
+				},
+				additionalProperties: false
+			},
+			LinkedVPServiceEntry: {
+				type: "object",
+				properties: {
+					id: {
+						type: "string"
+					},
+					type: {
+						type: "string",
+						"const": "LinkedVerifiablePresentation"
+					},
+					serviceEndpoint: {
+						type: "string"
+					}
+				},
+				required: [
+					"id",
+					"type",
+					"serviceEndpoint"
+				],
+				additionalProperties: false
+			},
+			HasLinkedVPEntryArgs: {
+				type: "object",
+				properties: {
+					linkedVpId: {
+						type: "string"
+					}
+				},
+				required: [
+					"linkedVpId"
+				],
+				additionalProperties: false
+			},
+			PublishCredentialArgs: {
+				type: "object",
+				properties: {
+					digitalCredentialId: {
+						type: "string"
+					},
+					linkedVpId: {
+						type: "string"
+					},
+					tenantId: {
+						type: "string"
+					}
+				},
+				required: [
+					"digitalCredentialId"
+				],
+				additionalProperties: false
+			},
+			LinkedVPEntry: {
+				type: "object",
+				properties: {
+					id: {
+						type: "string"
+					},
+					linkedVpId: {
+						type: "string"
+					},
+					tenantId: {
+						type: "string"
+					},
+					linkedVpFrom: {
+						type: "string",
+						format: "date-time"
+					},
+					createdAt: {
+						type: "string",
+						format: "date-time"
+					}
+				},
+				required: [
+					"id",
+					"linkedVpId",
+					"createdAt"
+				],
+				additionalProperties: false
+			},
+			UnpublishCredentialArgs: {
+				type: "object",
+				properties: {
+					linkedVpId: {
+						type: "string"
+					}
+				},
+				required: [
+					"linkedVpId"
+				],
+				additionalProperties: false
+			}
+		},
+		methods: {
+			lvpGeneratePresentation: {
+				description: "Generate and return a Verifiable Presentation for a published LinkedVP This is the main endpoint handler for GET /linked-vp/",
+				"arguments": {
+					$ref: "#/components/schemas/GeneratePresentationArgs"
+				},
+				returnType: {
+					$ref: "#/components/schemas/LinkedVPPresentation"
+				}
+			},
+			lvpGetServiceEntries: {
+				description: "Get LinkedVP service entries for a DID to be added to a DID Document This is useful when generating DID Documents with toDidDocument",
+				"arguments": {
+					$ref: "#/components/schemas/GetServiceEntriesArgs"
+				},
+				returnType: {
+					type: "array",
+					items: {
+						$ref: "#/components/schemas/LinkedVPServiceEntry"
+					}
+				}
+			},
+			lvpHasEntry: {
+				description: "Check if a LinkedVP entry exists by linkedVpId",
+				"arguments": {
+					$ref: "#/components/schemas/HasLinkedVPEntryArgs"
+				},
+				returnType: {
+					type: "boolean"
+				}
+			},
+			lvpPublishCredential: {
+				description: "Publish a credential as a LinkedVP by adding it to the holder's DID Document",
+				"arguments": {
+					$ref: "#/components/schemas/PublishCredentialArgs"
+				},
+				returnType: {
+					$ref: "#/components/schemas/LinkedVPEntry"
+				}
+			},
+			lvpUnpublishCredential: {
+				description: "Unpublish a credential by removing its LinkedVP entry from the DID Document",
+				"arguments": {
+					$ref: "#/components/schemas/UnpublishCredentialArgs"
+				},
+				returnType: {
+					type: "boolean"
+				}
+			}
+		}
+	}
+};
+var plugin_schema = {
+	ILinkedVPManager: ILinkedVPManager$1
+};
+
+declare const LOGGER_NAMESPACE = "sphereon:linked-vp";
+type LinkedVPPresentation = string | Record<string, any>;
+interface ILinkedVPManager extends IPluginMethodMap {
+    /**
+     * Publish a credential as a LinkedVP by adding it to the holder's DID Document
+     * @param args - Publication arguments including credential ID and scope configuration
+     * @param context - Agent context
+     */
+    lvpPublishCredential(args: PublishCredentialArgs, context: RequiredContext): Promise<LinkedVPEntry>;
+    /**
+     * Unpublish a credential by removing its LinkedVP entry from the DID Document
+     * @param args - Unpublish arguments
+     * @param context - Agent context
+     */
+    lvpUnpublishCredential(args: UnpublishCredentialArgs, context: RequiredContext): Promise<boolean>;
+    /**
+     * Check if a LinkedVP entry exists by linkedVpId
+     * @param args - Query arguments
+     * @param context - Agent context
+     */
+    lvpHasEntry(args: HasLinkedVPEntryArgs, context: RequiredContext): Promise<boolean>;
+    /**
+     * Get LinkedVP service entries for a DID to be added to a DID Document
+     * This is useful when generating DID Documents with toDidDocument
+     * @param args - Query arguments for the DID
+     * @param context - Agent context
+     */
+    lvpGetServiceEntries(args: GetServiceEntriesArgs, context: RequiredContext): Promise<Array<LinkedVPServiceEntry>>;
+    /**
+     * Generate and return a Verifiable Presentation for a published LinkedVP
+     * This is the main endpoint handler for GET /linked-vp/{linkedVpId}
+     * @param args - Generation arguments
+     * @param context - Agent context
+     */
+    lvpGeneratePresentation(args: GeneratePresentationArgs, context: RequiredContext): Promise<LinkedVPPresentation>;
+}
+type PublishCredentialArgs = {
+    digitalCredentialId: string;
+    linkedVpId?: string;
+};
+type UnpublishCredentialArgs = {
+    linkedVpId: string;
+};
+type HasLinkedVPEntryArgs = {
+    linkedVpId: string;
+};
+type GetServiceEntriesArgs = {
+    tenantId?: string;
+};
+type GeneratePresentationArgs = {
+    linkedVpId: string;
+};
+type LinkedVPEntry = {
+    id: string;
+    linkedVpId: string;
+    tenantId?: string;
+    linkedVpFrom?: Date;
+    createdAt: Date;
+};
+type LinkedVPServiceEntry = {
+    id: string;
+    type: 'LinkedVerifiablePresentation';
+    serviceEndpoint: string;
+};
+type RequiredContext = IAgentContext<IIdentifierResolution & ICredentialStore & IKeyManager & VcdmCredentialPlugin>;
+
+declare const linkedVPManagerMethods: Array<string>;
+/**
+ * {@inheritDoc ILinkedVPManager}
+ */
+declare class LinkedVPManager implements IAgentPlugin {
+    readonly schema: {
+        components: {
+            schemas: {
+                GeneratePresentationArgs: {
+                    type: string;
+                    properties: {
+                        linkedVpId: {
+                            type: string;
+                        };
+                    };
+                    required: string[];
+                    additionalProperties: boolean;
+                };
+                LinkedVPPresentation: {
+                    anyOf: ({
+                        type: string;
+                        $ref?: undefined;
+                    } | {
+                        $ref: string;
+                        type?: undefined;
+                    })[];
+                };
+                "Record<string,any>": {
+                    type: string;
+                };
+                GetServiceEntriesArgs: {
+                    type: string;
+                    properties: {
+                        tenantId: {
+                            type: string;
+                        };
+                    };
+                    additionalProperties: boolean;
+                };
+                LinkedVPServiceEntry: {
+                    type: string;
+                    properties: {
+                        id: {
+                            type: string;
+                        };
+                        type: {
+                            type: string;
+                            const: string;
+                        };
+                        serviceEndpoint: {
+                            type: string;
+                        };
+                    };
+                    required: string[];
+                    additionalProperties: boolean;
+                };
+                HasLinkedVPEntryArgs: {
+                    type: string;
+                    properties: {
+                        linkedVpId: {
+                            type: string;
+                        };
+                    };
+                    required: string[];
+                    additionalProperties: boolean;
+                };
+                PublishCredentialArgs: {
+                    type: string;
+                    properties: {
+                        digitalCredentialId: {
+                            type: string;
+                        };
+                        linkedVpId: {
+                            type: string;
+                        };
+                        tenantId: {
+                            type: string;
+                        };
+                    };
+                    required: string[];
+                    additionalProperties: boolean;
+                };
+                LinkedVPEntry: {
+                    type: string;
+                    properties: {
+                        id: {
+                            type: string;
+                        };
+                        linkedVpId: {
+                            type: string;
+                        };
+                        tenantId: {
+                            type: string;
+                        };
+                        linkedVpFrom: {
+                            type: string;
+                            format: string;
+                        };
+                        createdAt: {
+                            type: string;
+                            format: string;
+                        };
+                    };
+                    required: string[];
+                    additionalProperties: boolean;
+                };
+                UnpublishCredentialArgs: {
+                    type: string;
+                    properties: {
+                        linkedVpId: {
+                            type: string;
+                        };
+                    };
+                    required: string[];
+                    additionalProperties: boolean;
+                };
+            };
+            methods: {
+                lvpGeneratePresentation: {
+                    description: string;
+                    arguments: {
+                        $ref: string;
+                    };
+                    returnType: {
+                        $ref: string;
+                    };
+                };
+                lvpGetServiceEntries: {
+                    description: string;
+                    arguments: {
+                        $ref: string;
+                    };
+                    returnType: {
+                        type: string;
+                        items: {
+                            $ref: string;
+                        };
+                    };
+                };
+                lvpHasEntry: {
+                    description: string;
+                    arguments: {
+                        $ref: string;
+                    };
+                    returnType: {
+                        type: string;
+                    };
+                };
+                lvpPublishCredential: {
+                    description: string;
+                    arguments: {
+                        $ref: string;
+                    };
+                    returnType: {
+                        $ref: string;
+                    };
+                };
+                lvpUnpublishCredential: {
+                    description: string;
+                    arguments: {
+                        $ref: string;
+                    };
+                    returnType: {
+                        type: string;
+                    };
+                };
+            };
+        };
+    };
+    readonly methods: ILinkedVPManager;
+    private readonly holderDids;
+    constructor(options: {
+        holderDids: Record<string, string>;
+    });
+    private lvpPublishCredential;
+    private lvpUnpublishCredential;
+    private lvpHasEntry;
+    private lvpGetServiceEntries;
+    private lvpGeneratePresentation;
+    private getHolderDid;
+    private parseTenantFromLinkedVpId;
+    private generateLinkedVpId;
+    private ensureLinkedVpIdUnique;
+    private buildLinkedVpId;
+    private getBaseUrlFromDid;
+    private buildServiceEndpoint;
+    private credentialToServiceEntry;
+}
+
+export { type GeneratePresentationArgs, type GetServiceEntriesArgs, type HasLinkedVPEntryArgs, type ILinkedVPManager, LOGGER_NAMESPACE, type LinkedVPEntry, LinkedVPManager, type LinkedVPPresentation, type LinkedVPServiceEntry, type PublishCredentialArgs, type RequiredContext, type UnpublishCredentialArgs, linkedVPManagerMethods, plugin_schema as schema };