@sphereon/ssi-sdk-ext.did-utils 0.28.1-feature.oyd.cmsm.improv.20 → 0.28.1-next.53

package/src/types.ts

@@ -1,7 +1,7 @@
-import { TKeyType } from '@sphereon/ssi-sdk-ext.key-utils'
-import { IAgentContext, IDIDManager, IIdentifier, IKeyManager, IResolver } from '@veramo/core'
-import { JWTHeader, JWTPayload, JWTVerifyOptions } from 'did-jwt'
-import { Resolvable } from 'did-resolver'
+import type { TKeyType } from '@sphereon/ssi-sdk-ext.key-utils'
+import type { IAgentContext, IDIDManager, IIdentifier, IKeyManager, IResolver } from '@veramo/core'
+import type { JWTHeader, JWTPayload, JWTVerifyOptions } from 'did-jwt'
+import type { Resolvable } from 'did-resolver'
 
 export enum SupportedDidMethodEnum {
   DID_ETHR = 'ethr',

package/dist/did-functions.d.ts

@@ -1,190 +0,0 @@
-import { JwkKeyUse, TKeyType } from '@sphereon/ssi-sdk-ext.key-utils';
-import { JWK } from '@sphereon/ssi-types';
-import { DIDDocument, DIDDocumentSection, DIDResolutionResult, IAgentContext, IDIDManager, IIdentifier, IKey, IResolver } from '@veramo/core';
-import { _ExtendedIKey, _ExtendedVerificationMethod, _NormalizedVerificationMethod } from '@veramo/utils';
-import { Signer } from 'did-jwt';
-import { DIDResolutionOptions, Resolvable, VerificationMethod } from 'did-resolver';
-import { CreateIdentifierOpts, CreateOrGetIdentifierOpts, GetOrCreateResult, GetSignerArgs, IdentifierProviderOpts, IDIDOptions, SignJwtArgs } from './types';
-export declare const getAuthenticationKey: ({ identifier, offlineWhenNoDIDRegistered, noVerificationMethodFallback, keyType, controllerKey, }: {
-    identifier: IIdentifier;
-    keyType?: TKeyType;
-    offlineWhenNoDIDRegistered?: boolean;
-    noVerificationMethodFallback?: boolean;
-    controllerKey?: boolean;
-}, context: IAgentContext<IResolver & IDIDManager>) => Promise<_ExtendedIKey>;
-export declare const getFirstKeyWithRelation: ({ identifier, offlineWhenNoDIDRegistered, noVerificationMethodFallback, keyType, controllerKey, vmRelationship, }: {
-    identifier: IIdentifier;
-    keyType?: TKeyType;
-    offlineWhenNoDIDRegistered?: boolean;
-    noVerificationMethodFallback?: boolean;
-    controllerKey?: boolean;
-    vmRelationship: DIDDocumentSection;
-}, context: IAgentContext<IResolver & IDIDManager>) => Promise<_ExtendedIKey>;
-export declare const getOrCreatePrimaryIdentifier: (context: IAgentContext<IDIDManager>, opts?: CreateOrGetIdentifierOpts) => Promise<GetOrCreateResult<IIdentifier>>;
-export declare const getPrimaryIdentifier: (context: IAgentContext<IDIDManager>, opts?: IdentifierProviderOpts) => Promise<IIdentifier | undefined>;
-export declare const createIdentifier: (context: IAgentContext<IDIDManager>, opts?: CreateIdentifierOpts) => Promise<IIdentifier>;
-export declare const getFirstKeyWithRelationFromDIDDoc: ({ identifier, vmRelationship, keyType, errorOnNotFound, didDocument, controllerKey, }: {
-    identifier: IIdentifier;
-    controllerKey?: boolean;
-    vmRelationship?: DIDDocumentSection;
-    keyType?: TKeyType;
-    errorOnNotFound?: boolean;
-    didDocument?: DIDDocument;
-}, context: IAgentContext<IResolver & IDIDManager>) => Promise<_ExtendedIKey | undefined>;
-export declare const getEthereumAddressFromKey: ({ key }: {
-    key: IKey;
-}) => any;
-export declare const getControllerKey: ({ identifier }: {
-    identifier: IIdentifier;
-}) => IKey;
-export declare const getKeys: ({ jwkThumbprint, kms, identifier, kmsKeyRef, keyType, controllerKey, }: {
-    identifier: IIdentifier;
-    kmsKeyRef?: string;
-    keyType?: TKeyType;
-    kms?: string;
-    jwkThumbprint?: string;
-    controllerKey?: boolean;
-}) => IKey[];
-/**
- * Dereferences keys from DID document and normalizes them for easy comparison.
- *
- * When dereferencing keyAgreement keys, only Ed25519 and X25519 curves are supported.
- * Other key types are omitted from the result and Ed25519 keys are converted to X25519
- *
- * @returns a Promise that resolves to the list of dereferenced keys.
- *
- * @beta This API may change without a BREAKING CHANGE notice.
- */
-export declare function dereferenceDidKeysWithJwkSupport(didDocument: DIDDocument, section: DIDDocumentSection | undefined, context: IAgentContext<IResolver>): Promise<_NormalizedVerificationMethod[]>;
-export declare function jwkTtoPublicKeyHex(jwk: JWK): string;
-/**
- * Converts the publicKey of a VerificationMethod to hex encoding (publicKeyHex)
- *
- * @param pk - the VerificationMethod to be converted
- * @param convert - when this flag is set to true, Ed25519 keys are converted to their X25519 pairs
- * @returns the hex encoding of the public key
- *
- * @beta This API may change without a BREAKING CHANGE notice.
- */
-export declare function extractPublicKeyHexWithJwkSupport(pk: _ExtendedVerificationMethod, convert?: boolean): string;
-export declare function isEvenHexString(hex: string): boolean;
-/**
- * Converts the publicKey of a VerificationMethod to hex encoding (publicKeyHex)
- *
- * @param pk - the VerificationMethod to be converted
- * @param convert - when this flag is set to true, Ed25519 keys are converted to their X25519 pairs
- * @returns the hex encoding of the public key
- *
- * @beta This API may change without a BREAKING CHANGE notice.
- */
-export declare function extractPublicKeyHex(pk: _ExtendedVerificationMethod, convert?: boolean): string;
-export declare function verificationMethodToJwk(vm: VerificationMethod): JWK;
-export type DidDocumentJwks = Record<Exclude<DIDDocumentSection, 'publicKey' | 'service'>, Array<JWK>>;
-export declare function didDocumentToJwks(didDocument: DIDDocument): DidDocumentJwks;
-/**
- * Maps the keys of a locally managed {@link @veramo/core#IIdentifier | IIdentifier} to the corresponding
- * {@link did-resolver#VerificationMethod | VerificationMethod} entries from the DID document.
- *
- * @param identifier - the identifier to be mapped
- * @param section - the section of the DID document to be mapped (see
- *   {@link https://www.w3.org/TR/did-core/#verification-relationships | verification relationships}), but can also be
- *   `verificationMethod` to map all the keys.
- * @param didDocument
- * @param context - the veramo agent context, which must contain a {@link @veramo/core#IResolver | IResolver}
- *   implementation that can resolve the DID document of the identifier.
- *
- * @returns an array of mapped keys. The corresponding verification method is added to the `meta.verificationMethod`
- *   property of the key.
- *
- * @beta This API may change without a BREAKING CHANGE notice.
- */
-export declare function mapIdentifierKeysToDocWithJwkSupport({ identifier, vmRelationship, didDocument, }: {
-    identifier: IIdentifier;
-    vmRelationship?: DIDDocumentSection;
-    didDocument?: DIDDocument;
-}, context: IAgentContext<IResolver & IDIDManager>): Promise<_ExtendedIKey[]>;
-export declare function getAgentDIDMethods(context: IAgentContext<IDIDManager>): Promise<string[]>;
-export declare function getDID(idOpts: {
-    identifier: IIdentifier | string;
-}): string;
-export declare function toDID(identifier: string | IIdentifier | Partial<IIdentifier>): string;
-export declare function toDIDs(identifiers?: (string | IIdentifier | Partial<IIdentifier>)[]): string[];
-export declare function getKey({ identifier, vmRelationship, kmsKeyRef, }: {
-    identifier: IIdentifier;
-    vmRelationship?: DIDDocumentSection;
-    kmsKeyRef?: string;
-}, context: IAgentContext<IResolver & IDIDManager>): Promise<IKey>;
-/**
- * Get the real kid as used in JWTs. This is the kid in the VM or in the JWT, not the kid in the Veramo/Sphereon keystore. That was just a poorly chosen name
- * @param key
- * @param idOpts
- * @param context
- */
-export declare function determineKid({ key, idOpts, }: {
-    key: IKey;
-    idOpts: {
-        identifier: IIdentifier | string;
-        kmsKeyRef?: string;
-    };
-}, context: IAgentContext<IResolver & IDIDManager>): Promise<string>;
-export declare function getSupportedDIDMethods(didOpts: IDIDOptions, context: IAgentContext<IDIDManager>): Promise<string[]>;
-export declare function getAgentResolver(context: IAgentContext<IResolver & IDIDManager>, opts?: {
-    localResolution?: boolean;
-    uniresolverResolution?: boolean;
-    resolverResolution?: boolean;
-}): Resolvable;
-export declare class AgentDIDResolver implements Resolvable {
-    private readonly context;
-    private readonly resolverResolution;
-    private readonly uniresolverResolution;
-    private readonly localResolution;
-    constructor(context: IAgentContext<IResolver & IDIDManager>, opts?: {
-        uniresolverResolution?: boolean;
-        localResolution?: boolean;
-        resolverResolution?: boolean;
-    });
-    resolve(didUrl: string, options?: DIDResolutionOptions): Promise<DIDResolutionResult>;
-}
-/**
- * Please note that this is not an exact representation of the actual DID Document.
- *
- * We try to do our best, to map keys onto relevant verification methods and relationships, but we simply lack the context
- * of the actual DID method here. Do not relly on this method for DID resolution. It is only handy for offline use cases
- * when no DID Document is cached. For DID:WEB it does provide an accurate representation!
- *
- * @param identifier
- * @param opts
- */
-export declare function toDidDocument(identifier?: IIdentifier, opts?: {
-    did?: string;
-    use?: JwkKeyUse[];
-}): DIDDocument | undefined;
-export declare function toDidResolutionResult(identifier?: IIdentifier, opts?: {
-    did?: string;
-    supportedMethods?: string[];
-}): DIDResolutionResult;
-export declare function asDidWeb(hostnameOrDID: string): Promise<string>;
-/**
- * @deprecated Replaced by the new signer service
- */
-export declare const signDidJWT: (args: SignJwtArgs) => Promise<string>;
-/**
- * @deprecated Replaced by the new signer service
- */
-export declare const getDidSigner: (args: GetSignerArgs & {
-    idOpts: {
-        /**
-         * @deprecated
-         */
-        identifier: IIdentifier | string;
-        /**
-         * @deprecated
-         */
-        verificationMethodSection?: DIDDocumentSection;
-        /**
-         * @deprecated
-         */
-        kmsKeyRef?: string;
-    };
-}) => Promise<Signer>;
-//# sourceMappingURL=did-functions.d.ts.map

package/dist/did-functions.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"did-functions.d.ts","sourceRoot":"","sources":["../src/did-functions.ts"],"names":[],"mappings":"AAEA,OAAO,EAGH,SAAS,EAIT,QAAQ,EAEX,MAAM,iCAAiC,CAAA;AAGxC,OAAO,EAAC,GAAG,EAAC,MAAM,qBAAqB,CAAA;AAEvC,OAAO,EACH,WAAW,EACX,kBAAkB,EAClB,mBAAmB,EACnB,aAAa,EACb,WAAW,EACX,WAAW,EACX,IAAI,EACJ,SAAS,EACZ,MAAM,cAAc,CAAA;AACrB,OAAO,EACH,aAAa,EACb,2BAA2B,EAC3B,6BAA6B,EAMhC,MAAM,eAAe,CAAA;AACtB,OAAO,EAAY,MAAM,EAAC,MAAM,SAAS,CAAA;AACzC,OAAO,EAAC,oBAAoB,EAAc,UAAU,EAAE,kBAAkB,EAAC,MAAM,cAAc,CAAA;AAI7F,OAAO,EACH,oBAAoB,EACpB,yBAAyB,EAEzB,iBAAiB,EACjB,aAAa,EAEb,sBAAsB,EACtB,WAAW,EACX,WAAW,EAEd,MAAM,SAAS,CAAA;AAEhB,eAAO,MAAM,oBAAoB,sGAO1B;IACC,UAAU,EAAE,WAAW,CAAA;IACvB,OAAO,CAAC,EAAE,QAAQ,CAAA;IAClB,0BAA0B,CAAC,EAAE,OAAO,CAAA;IACpC,4BAA4B,CAAC,EAAE,OAAO,CAAA;IACtC,aAAa,CAAC,EAAE,OAAO,CAAA;CAC1B,WACQ,aAAa,CAAC,SAAS,GAAG,WAAW,CAAC,KAChD,OAAO,CAAC,aAAa,CAYvB,CAAA;AACD,eAAO,MAAM,uBAAuB,sHAQ7B;IACC,UAAU,EAAE,WAAW,CAAA;IACvB,OAAO,CAAC,EAAE,QAAQ,CAAA;IAClB,0BAA0B,CAAC,EAAE,OAAO,CAAA;IACpC,4BAA4B,CAAC,EAAE,OAAO,CAAA;IACtC,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,cAAc,EAAE,kBAAkB,CAAA;CACrC,WACQ,aAAa,CAAC,SAAS,GAAG,WAAW,CAAC,KAChD,OAAO,CAAC,aAAa,CAyEvB,CAAA;AAED,eAAO,MAAM,4BAA4B,YAC5B,aAAa,CAAC,WAAW,CAAC,SAC5B,yBAAyB,KACjC,OAAO,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAmBxC,CAAA;AAED,eAAO,MAAM,oBAAoB,YAAmB,aAAa,CAAC,WAAW,CAAC,SAAS,sBAAsB,KAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAM9I,CAAA;AAED,eAAO,MAAM,gBAAgB,YAAmB,aAAa,CAAC,WAAW,CAAC,SAAS,oBAAoB,KAAG,OAAO,CAAC,WAAW,CAO5H,CAAA;AAED,eAAO,MAAM,iCAAiC,0FAQvC;IACC,UAAU,EAAE,WAAW,CAAA;IACvB,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,cAAc,CAAC,EAAE,kBAAkB,CAAA;IACnC,OAAO,CAAC,EAAE,QAAQ,CAAA;IAClB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,WAAW,CAAC,EAAE,WAAW,CAAA;CAC5B,WACQ,aAAa,CAAC,SAAS,GAAG,WAAW,CAAC,KAChD,OAAO,CAAC,aAAa,GAAG,SAAS,CAgBnC,CAAA;AAED,eAAO,MAAM,yBAAyB,YAAW;IAAE,GAAG,EAAE,IAAI,CAAA;CAAE,QAS7D,CAAA;AAED,eAAO,MAAM,gBAAgB,mBAAkB;IAAE,UAAU,EAAE,WAAW,CAAA;CAAE,SAMzE,CAAA;AAED,eAAO,MAAM,OAAO,2EAOO;IACvB,UAAU,EAAE,WAAW,CAAA;IACvB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,QAAQ,CAAA;IAClB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,aAAa,CAAC,EAAE,OAAO,CAAA;CAC1B,WAOA,CAAA;AAGD;;;;;;;;;GASG;AACH,wBAAsB,gCAAgC,CAClD,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,kBAAkB,YAAiB,EAC5C,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,GAClC,OAAO,CAAC,6BAA6B,EAAE,CAAC,CAkC1C;AAED,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM,CAOnD;AAED;;;;;;;;GAQG;AACH,wBAAgB,iCAAiC,CAAC,EAAE,EAAE,2BAA2B,EAAE,OAAO,UAAQ,GAAG,MAAM,CA4B1G;AAED,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,WAG1C;AAMD;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CAAC,EAAE,EAAE,2BAA2B,EAAE,OAAO,GAAE,OAAe,GAAG,MAAM,CAiBrG;AAyBD,wBAAgB,uBAAuB,CAAC,EAAE,EAAE,kBAAkB,GAAG,GAAG,CAWnE;AAcD,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,kBAAkB,EAAE,WAAW,GAAG,SAAS,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAA;AAEtG,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,WAAW,GAAG,eAAe,CAY3E;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,oCAAoC,CACtD,EACI,UAAU,EACV,cAAqC,EACrC,WAAW,GACd,EAAE;IACC,UAAU,EAAE,WAAW,CAAA;IACvB,cAAc,CAAC,EAAE,kBAAkB,CAAA;IACnC,WAAW,CAAC,EAAE,WAAW,CAAA;CAC5B,EACD,OAAO,EAAE,aAAa,CAAC,SAAS,GAAG,WAAW,CAAC,GAChD,OAAO,CAAC,aAAa,EAAE,CAAC,CA0C1B;AA6BD,wBAAsB,kBAAkB,CAAC,OAAO,EAAE,aAAa,CAAC,WAAW,CAAC,qBAE3E;AAED,wBAAgB,MAAM,CAAC,MAAM,EAAE;IAAE,UAAU,EAAE,WAAW,GAAG,MAAM,CAAA;CAAE,GAAG,MAAM,CAO3E;AAED,wBAAgB,KAAK,CAAC,UAAU,EAAE,MAAM,GAAG,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,GAAG,MAAM,CAQrF;AAED,wBAAgB,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,MAAM,GAAG,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,CAK9F;AAED,wBAAsB,MAAM,CACxB,EACI,UAAU,EACV,cAAiC,EACjC,SAAS,GACZ,EAAE;IACC,UAAU,EAAE,WAAW,CAAA;IACvB,cAAc,CAAC,EAAE,kBAAkB,CAAA;IACnC,SAAS,CAAC,EAAE,MAAM,CAAA;CACrB,EACD,OAAO,EAAE,aAAa,CAAC,SAAS,GAAG,WAAW,CAAC,GAChD,OAAO,CAAC,IAAI,CAAC,CAmCf;AAuBD;;;;;GAKG;AACH,wBAAsB,YAAY,CAC9B,EACI,GAAG,EACH,MAAM,GACT,EAAE;IACC,GAAG,EAAE,IAAI,CAAA;IACT,MAAM,EAAE;QAAE,UAAU,EAAE,WAAW,GAAG,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;CACnE,EACD,OAAO,EAAE,aAAa,CAAC,SAAS,GAAG,WAAW,CAAC,GAChD,OAAO,CAAC,MAAM,CAAC,CAkBjB;AAED,wBAAsB,sBAAsB,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,aAAa,CAAC,WAAW,CAAC,qBAErG;AAED,wBAAgB,gBAAgB,CAC5B,OAAO,EAAE,aAAa,CAAC,SAAS,GAAG,WAAW,CAAC,EAC/C,IAAI,CAAC,EAAE;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B,kBAAkB,CAAC,EAAE,OAAO,CAAA;CAC/B,GACF,UAAU,CAEZ;AAED,qBAAa,gBAAiB,YAAW,UAAU;IAC/C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAwC;IAChE,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAS;IAC5C,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAS;IAC/C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAS;gBAGrC,OAAO,EAAE,aAAa,CAAC,SAAS,GAAG,WAAW,CAAC,EAC/C,IAAI,CAAC,EAAE;QAAE,qBAAqB,CAAC,EAAE,OAAO,CAAC;QAAC,eAAe,CAAC,EAAE,OAAO,CAAC;QAAC,kBAAkB,CAAC,EAAE,OAAO,CAAA;KAAE;IAQjG,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,mBAAmB,CAAC;CAmE9F;AAED;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CACzB,UAAU,CAAC,EAAE,WAAW,EACxB,IAAI,CAAC,EAAE;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,GAAG,CAAC,EAAE,SAAS,EAAE,CAAA;CACpB,GACF,WAAW,GAAG,SAAS,CAwFzB;AAED,wBAAgB,qBAAqB,CACjC,UAAU,CAAC,EAAE,WAAW,EACxB,IAAI,CAAC,EAAE;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAA;CAC9B,GACF,mBAAmB,CAiBrB;AAED,wBAAsB,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CASrE;AAED;;GAEG;AACH,eAAO,MAAM,UAAU,SAAgB,WAAW,KAAG,OAAO,CAAC,MAAM,CAQlE,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,YAAY,SACf,aAAa,GAAG;IAClB,MAAM,EAAE;QACJ;;WAEG;QACH,UAAU,EAAE,WAAW,GAAG,MAAM,CAAA;QAChC;;WAEG;QACH,yBAAyB,CAAC,EAAE,kBAAkB,CAAA;QAC9C;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAA;KACrB,CAAA;CACJ,KACF,OAAO,CAAC,MAAM,CAsBhB,CAAA"}