@sphereon/ssi-types 0.30.1-unstable.4 → 0.30.1

package/src/types/did.ts

@@ -1,268 +1,268 @@
-export enum IProofPurpose {
-  verificationMethod = 'verificationMethod',
-  assertionMethod = 'assertionMethod',
-  authentication = 'authentication',
-  keyAgreement = 'keyAgreement',
-  contractAgreement = 'contactAgreement',
-  capabilityInvocation = 'capabilityInvocation',
-  capabilityDelegation = 'capabilityDelegation',
-}
-
-export enum IProofType {
-  Ed25519Signature2018 = 'Ed25519Signature2018',
-  Ed25519Signature2020 = 'Ed25519Signature2020',
-  EcdsaSecp256k1Signature2019 = 'EcdsaSecp256k1Signature2019',
-  EcdsaSecp256k1RecoverySignature2020 = 'EcdsaSecp256k1RecoverySignature2020',
-  JsonWebSignature2020 = 'JsonWebSignature2020',
-  RsaSignature2018 = 'RsaSignature2018',
-  GpgSignature2020 = 'GpgSignature2020',
-  JcsEd25519Signature2020 = 'JcsEd25519Signature2020',
-  BbsBlsSignatureProof2020 = 'BbsBlsSignatureProof2020',
-  BbsBlsBoundSignatureProof2020 = 'BbsBlsBoundSignatureProof2020',
-  JwtProof2020 = 'JwtProof2020',
-  SdJwtProof2024 = 'SdJwtProof2024',
-  MdocProof2024 = 'MsoMdocProof2024',
-}
-
-export interface IParsedDID {
-  did: string
-  didUrl: string
-  method: string
-  id: string
-  path?: string
-  fragment?: string
-  query?: string
-  params?: {
-    [index: string]: string
-  }
-}
-
-export const parseDid = (did: string): IParsedDID => {
-  const parsedDid = parse(did)
-  if (parsedDid === null) {
-    throw new Error('invalid did')
-  }
-
-  return parsedDid
-}
-
-const parse = (didUrl: string): IParsedDID | null => {
-  const PCT_ENCODED = '(?:%[0-9a-fA-F]{2})'
-  const ID_CHAR = `(?:[a-zA-Z0-9._-]|${PCT_ENCODED})`
-  const METHOD = '([a-z0-9]+)'
-  const METHOD_ID = `((?:${ID_CHAR}*:)*(${ID_CHAR}+))`
-  const PARAM_CHAR = '[a-zA-Z0-9_.:%-]'
-  const PARAM = `;${PARAM_CHAR}+=${PARAM_CHAR}*`
-  const PARAMS = `((${PARAM})*)`
-  const PATH = `(/[^#?]*)?`
-  const QUERY = `([?][^#]*)?`
-  const FRAGMENT = `(#.*)?`
-  const DID_MATCHER = new RegExp(`^did:${METHOD}:${METHOD_ID}${PARAMS}${PATH}${QUERY}${FRAGMENT}$`)
-
-  if (didUrl === '' || !didUrl) return null
-  const sections = didUrl.match(DID_MATCHER)
-  if (sections) {
-    const parts: IParsedDID = {
-      did: `did:${sections[1]}:${sections[2]}`,
-      method: sections[1],
-      id: sections[2],
-      didUrl,
-    }
-    if (sections[4]) {
-      const params = sections[4].slice(1).split(';')
-      parts.params = {}
-      for (const p of params) {
-        const kv = p.split('=')
-        parts.params[kv[0]] = kv[1]
-      }
-    }
-    if (sections[6]) parts.path = sections[6]
-    if (sections[7]) parts.query = sections[7].slice(1)
-    if (sections[8]) parts.fragment = sections[8].slice(1)
-    return parts
-  }
-
-  return null
-}
-
-// Copied from did-resolver, so we have types without external dep
-
-// Copyright 2018 Consensys AG
-
-// Licensed under the Apache License, Version 2.0(the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-
-// http://www.apache.org/licenses/LICENSE-2.0
-
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-/**
- * Defines an object type that can be extended with other properties.
- */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type Extensible = Record<string, any>
-
-/**
- * Defines the result of a DID resolution operation.
- *
- * @see {@link Resolvable.resolve}
- * @see {@link https://www.w3.org/TR/did-core/#did-resolution}
- */
-export interface DIDResolutionResult {
-  '@context'?: 'https://w3id.org/did-resolution/v1' | string | string[]
-  didResolutionMetadata: DIDResolutionMetadata
-  didDocument: DIDDocument | null
-  didDocumentMetadata: DIDDocumentMetadata
-}
-
-/**
- * Describes the options forwarded to the resolver when executing a {@link Resolvable.resolve} operation.
- *
- * @see {@link https://www.w3.org/TR/did-core/#did-resolution-options}
- */
-export interface DIDResolutionOptions extends Extensible {
-  accept?: string
-}
-
-/**
- * Encapsulates the resolution metadata resulting from a {@link Resolvable.resolve} operation.
- *
- * @see {@link https://www.w3.org/TR/did-core/#did-resolution-metadata}
- */
-export interface DIDResolutionMetadata extends Extensible {
-  contentType?: string
-  error?: 'invalidDid' | 'notFound' | 'representationNotSupported' | 'unsupportedDidMethod' | string
-}
-
-/**
- * Represents metadata about the DID document resulting from a {@link Resolvable.resolve} operation.
- *
- * @see {@link https://www.w3.org/TR/did-core/#did-document-metadata}
- */
-export interface DIDDocumentMetadata extends Extensible {
-  created?: string
-  updated?: string
-  deactivated?: boolean
-  versionId?: string
-  nextUpdate?: string
-  nextVersionId?: string
-  equivalentId?: string
-  canonicalId?: string
-}
-
-/**
- * Represents the Verification Relationship between a DID subject and a Verification Method.
- *
- * @see {@link https://www.w3.org/TR/did-core/#verification-relationships}
- */
-export type KeyCapabilitySection = 'authentication' | 'assertionMethod' | 'keyAgreement' | 'capabilityInvocation' | 'capabilityDelegation'
-
-/**
- * Represents a DID document.
- *
- * @see {@link https://www.w3.org/TR/did-core/#did-document-properties}
- */
-export type DIDDocument = {
-  '@context'?: 'https://www.w3.org/ns/did/v1' | string | string[]
-  id: string
-  alsoKnownAs?: string[]
-  controller?: string | string[]
-  verificationMethod?: VerificationMethod[]
-  service?: Service[]
-  /**
-   * @deprecated
-   */
-  publicKey?: VerificationMethod[]
-} & {
-  [x in KeyCapabilitySection]?: (string | VerificationMethod)[]
-}
-
-/**
- * Represents a Service entry in a {@link https://www.w3.org/TR/did-core/#did-document-properties | DID document}.
- *
- * @see {@link https://www.w3.org/TR/did-core/#services}
- * @see {@link https://www.w3.org/TR/did-core/#service-properties}
- */
-export interface Service {
-  id: string
-  type: string
-  serviceEndpoint: ServiceEndpoint | ServiceEndpoint[]
-
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  [x: string]: any
-}
-
-/**
- * Represents an endpoint of a Service entry in a DID document.
- *
- * @see {@link https://www.w3.org/TR/did-core/#dfn-serviceendpoint}
- * @see {@link https://www.w3.org/TR/did-core/#services}
- */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type ServiceEndpoint = string | Record<string, any>
-
-/**
- * Encapsulates a JSON web key type that includes only the public properties that
- * can be used in DID documents.
- *
- * The private properties are intentionally omitted to discourage the use
- * (and accidental disclosure) of private keys in DID documents.
- *
- * @see {@link https://www.rfc-editor.org/rfc/rfc7517 | RFC7517 JsonWebKey (JWK)}
- */
-export interface JsonWebKey extends Extensible {
-  alg?: string
-  crv?: string
-  e?: string
-  ext?: boolean
-  key_ops?: string[]
-  kid?: string
-  kty: string
-  n?: string
-  use?: string
-  x?: string
-  y?: string
-}
-
-/**
- * Represents the properties of a Verification Method listed in a DID document.
- *
- * This data type includes public key representations that are no longer present in the spec but are still used by
- * several DID methods / resolvers and kept for backward compatibility.
- *
- * @see {@link https://www.w3.org/TR/did-core/#verification-methods}
- * @see {@link https://www.w3.org/TR/did-core/#verification-method-properties}
- */
-export interface VerificationMethod {
-  id: string
-  type: string
-  controller: string
-  publicKeyBase58?: string
-  publicKeyBase64?: string
-  publicKeyJwk?: JsonWebKey
-  publicKeyHex?: string
-  publicKeyMultibase?: string
-  blockchainAccountId?: string
-  ethereumAddress?: string
-
-  // ConditionalProof2022 subtypes
-  conditionOr?: VerificationMethod[]
-  conditionAnd?: VerificationMethod[]
-  threshold?: number
-  conditionThreshold?: VerificationMethod[]
-  conditionWeightedThreshold?: ConditionWeightedThreshold[]
-  conditionDelegated?: string
-  relationshipParent?: string[]
-  relationshipChild?: string[]
-  relationshipSibling?: string[]
-}
-
-export interface ConditionWeightedThreshold {
-  condition: VerificationMethod
-  weight: number
-}
+export enum IProofPurpose {
+  verificationMethod = 'verificationMethod',
+  assertionMethod = 'assertionMethod',
+  authentication = 'authentication',
+  keyAgreement = 'keyAgreement',
+  contractAgreement = 'contactAgreement',
+  capabilityInvocation = 'capabilityInvocation',
+  capabilityDelegation = 'capabilityDelegation',
+}
+
+export enum IProofType {
+  Ed25519Signature2018 = 'Ed25519Signature2018',
+  Ed25519Signature2020 = 'Ed25519Signature2020',
+  EcdsaSecp256k1Signature2019 = 'EcdsaSecp256k1Signature2019',
+  EcdsaSecp256k1RecoverySignature2020 = 'EcdsaSecp256k1RecoverySignature2020',
+  JsonWebSignature2020 = 'JsonWebSignature2020',
+  RsaSignature2018 = 'RsaSignature2018',
+  GpgSignature2020 = 'GpgSignature2020',
+  JcsEd25519Signature2020 = 'JcsEd25519Signature2020',
+  BbsBlsSignatureProof2020 = 'BbsBlsSignatureProof2020',
+  BbsBlsBoundSignatureProof2020 = 'BbsBlsBoundSignatureProof2020',
+  JwtProof2020 = 'JwtProof2020',
+  SdJwtProof2024 = 'SdJwtProof2024',
+  MdocProof2024 = 'MsoMdocProof2024',
+}
+
+export interface IParsedDID {
+  did: string
+  didUrl: string
+  method: string
+  id: string
+  path?: string
+  fragment?: string
+  query?: string
+  params?: {
+    [index: string]: string
+  }
+}
+
+export const parseDid = (did: string): IParsedDID => {
+  const parsedDid = parse(did)
+  if (parsedDid === null) {
+    throw new Error('invalid did')
+  }
+
+  return parsedDid
+}
+
+const parse = (didUrl: string): IParsedDID | null => {
+  const PCT_ENCODED = '(?:%[0-9a-fA-F]{2})'
+  const ID_CHAR = `(?:[a-zA-Z0-9._-]|${PCT_ENCODED})`
+  const METHOD = '([a-z0-9]+)'
+  const METHOD_ID = `((?:${ID_CHAR}*:)*(${ID_CHAR}+))`
+  const PARAM_CHAR = '[a-zA-Z0-9_.:%-]'
+  const PARAM = `;${PARAM_CHAR}+=${PARAM_CHAR}*`
+  const PARAMS = `((${PARAM})*)`
+  const PATH = `(/[^#?]*)?`
+  const QUERY = `([?][^#]*)?`
+  const FRAGMENT = `(#.*)?`
+  const DID_MATCHER = new RegExp(`^did:${METHOD}:${METHOD_ID}${PARAMS}${PATH}${QUERY}${FRAGMENT}$`)
+
+  if (didUrl === '' || !didUrl) return null
+  const sections = didUrl.match(DID_MATCHER)
+  if (sections) {
+    const parts: IParsedDID = {
+      did: `did:${sections[1]}:${sections[2]}`,
+      method: sections[1],
+      id: sections[2],
+      didUrl,
+    }
+    if (sections[4]) {
+      const params = sections[4].slice(1).split(';')
+      parts.params = {}
+      for (const p of params) {
+        const kv = p.split('=')
+        parts.params[kv[0]] = kv[1]
+      }
+    }
+    if (sections[6]) parts.path = sections[6]
+    if (sections[7]) parts.query = sections[7].slice(1)
+    if (sections[8]) parts.fragment = sections[8].slice(1)
+    return parts
+  }
+
+  return null
+}
+
+// Copied from did-resolver, so we have types without external dep
+
+// Copyright 2018 Consensys AG
+
+// Licensed under the Apache License, Version 2.0(the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+
+// http://www.apache.org/licenses/LICENSE-2.0
+
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/**
+ * Defines an object type that can be extended with other properties.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type Extensible = Record<string, any>
+
+/**
+ * Defines the result of a DID resolution operation.
+ *
+ * @see {@link Resolvable.resolve}
+ * @see {@link https://www.w3.org/TR/did-core/#did-resolution}
+ */
+export interface DIDResolutionResult {
+  '@context'?: 'https://w3id.org/did-resolution/v1' | string | string[]
+  didResolutionMetadata: DIDResolutionMetadata
+  didDocument: DIDDocument | null
+  didDocumentMetadata: DIDDocumentMetadata
+}
+
+/**
+ * Describes the options forwarded to the resolver when executing a {@link Resolvable.resolve} operation.
+ *
+ * @see {@link https://www.w3.org/TR/did-core/#did-resolution-options}
+ */
+export interface DIDResolutionOptions extends Extensible {
+  accept?: string
+}
+
+/**
+ * Encapsulates the resolution metadata resulting from a {@link Resolvable.resolve} operation.
+ *
+ * @see {@link https://www.w3.org/TR/did-core/#did-resolution-metadata}
+ */
+export interface DIDResolutionMetadata extends Extensible {
+  contentType?: string
+  error?: 'invalidDid' | 'notFound' | 'representationNotSupported' | 'unsupportedDidMethod' | string
+}
+
+/**
+ * Represents metadata about the DID document resulting from a {@link Resolvable.resolve} operation.
+ *
+ * @see {@link https://www.w3.org/TR/did-core/#did-document-metadata}
+ */
+export interface DIDDocumentMetadata extends Extensible {
+  created?: string
+  updated?: string
+  deactivated?: boolean
+  versionId?: string
+  nextUpdate?: string
+  nextVersionId?: string
+  equivalentId?: string
+  canonicalId?: string
+}
+
+/**
+ * Represents the Verification Relationship between a DID subject and a Verification Method.
+ *
+ * @see {@link https://www.w3.org/TR/did-core/#verification-relationships}
+ */
+export type KeyCapabilitySection = 'authentication' | 'assertionMethod' | 'keyAgreement' | 'capabilityInvocation' | 'capabilityDelegation'
+
+/**
+ * Represents a DID document.
+ *
+ * @see {@link https://www.w3.org/TR/did-core/#did-document-properties}
+ */
+export type DIDDocument = {
+  '@context'?: 'https://www.w3.org/ns/did/v1' | string | string[]
+  id: string
+  alsoKnownAs?: string[]
+  controller?: string | string[]
+  verificationMethod?: VerificationMethod[]
+  service?: Service[]
+  /**
+   * @deprecated
+   */
+  publicKey?: VerificationMethod[]
+} & {
+  [x in KeyCapabilitySection]?: (string | VerificationMethod)[]
+}
+
+/**
+ * Represents a Service entry in a {@link https://www.w3.org/TR/did-core/#did-document-properties | DID document}.
+ *
+ * @see {@link https://www.w3.org/TR/did-core/#services}
+ * @see {@link https://www.w3.org/TR/did-core/#service-properties}
+ */
+export interface Service {
+  id: string
+  type: string
+  serviceEndpoint: ServiceEndpoint | ServiceEndpoint[]
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  [x: string]: any
+}
+
+/**
+ * Represents an endpoint of a Service entry in a DID document.
+ *
+ * @see {@link https://www.w3.org/TR/did-core/#dfn-serviceendpoint}
+ * @see {@link https://www.w3.org/TR/did-core/#services}
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type ServiceEndpoint = string | Record<string, any>
+
+/**
+ * Encapsulates a JSON web key type that includes only the public properties that
+ * can be used in DID documents.
+ *
+ * The private properties are intentionally omitted to discourage the use
+ * (and accidental disclosure) of private keys in DID documents.
+ *
+ * @see {@link https://www.rfc-editor.org/rfc/rfc7517 | RFC7517 JsonWebKey (JWK)}
+ */
+export interface JsonWebKey extends Extensible {
+  alg?: string
+  crv?: string
+  e?: string
+  ext?: boolean
+  key_ops?: string[]
+  kid?: string
+  kty: string
+  n?: string
+  use?: string
+  x?: string
+  y?: string
+}
+
+/**
+ * Represents the properties of a Verification Method listed in a DID document.
+ *
+ * This data type includes public key representations that are no longer present in the spec but are still used by
+ * several DID methods / resolvers and kept for backward compatibility.
+ *
+ * @see {@link https://www.w3.org/TR/did-core/#verification-methods}
+ * @see {@link https://www.w3.org/TR/did-core/#verification-method-properties}
+ */
+export interface VerificationMethod {
+  id: string
+  type: string
+  controller: string
+  publicKeyBase58?: string
+  publicKeyBase64?: string
+  publicKeyJwk?: JsonWebKey
+  publicKeyHex?: string
+  publicKeyMultibase?: string
+  blockchainAccountId?: string
+  ethereumAddress?: string
+
+  // ConditionalProof2022 subtypes
+  conditionOr?: VerificationMethod[]
+  conditionAnd?: VerificationMethod[]
+  threshold?: number
+  conditionThreshold?: VerificationMethod[]
+  conditionWeightedThreshold?: ConditionWeightedThreshold[]
+  conditionDelegated?: string
+  relationshipParent?: string[]
+  relationshipChild?: string[]
+  relationshipSibling?: string[]
+}
+
+export interface ConditionWeightedThreshold {
+  condition: VerificationMethod
+  weight: number
+}

package/src/types/generic.ts

@@ -1,48 +1,48 @@
-/**
- * Accept a Type or a Promise of that Type.
- *
- * @internal
- */
-export type OrPromise<T> = T | Promise<T>
-export type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>
-
-export type BearerTokenArg = (() => Promise<string>) | string
-
-/**
- * Generic structure used for validations. For instance for X509 and JWs signature checks. Allows us to create multilevel structures for complex validations
- */
-export type IValidationResult = {
-  /**
-   * The name of the validation or its subsystem. Mainly used for information purposes. Not assumed to be unique
-   */
-  name: string
-
-  /**
-   * Whether the validation was successful or not
-   */
-  error: boolean
-
-  /**
-   * Whether an error can be ignored or not (up to processing logic)
-   */
-  critical: boolean
-
-  /**
-   * Any status/info message about the validation
-   */
-  message: string
-
-  /**
-   * The date and time of the validation
-   */
-  verificationTime: Date
-}
-
-export type IValidationResults = {
-  /**
-   * Global derived error state for easy access
-   */
-  error: boolean
-
-  verifications: Array<IValidationResult>
-}
+/**
+ * Accept a Type or a Promise of that Type.
+ *
+ * @internal
+ */
+export type OrPromise<T> = T | Promise<T>
+export type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>
+
+export type BearerTokenArg = (() => Promise<string>) | string
+
+/**
+ * Generic structure used for validations. For instance for X509 and JWs signature checks. Allows us to create multilevel structures for complex validations
+ */
+export type IValidationResult = {
+  /**
+   * The name of the validation or its subsystem. Mainly used for information purposes. Not assumed to be unique
+   */
+  name: string
+
+  /**
+   * Whether the validation was successful or not
+   */
+  error: boolean
+
+  /**
+   * Whether an error can be ignored or not (up to processing logic)
+   */
+  critical: boolean
+
+  /**
+   * Any status/info message about the validation
+   */
+  message: string
+
+  /**
+   * The date and time of the validation
+   */
+  verificationTime: Date
+}
+
+export type IValidationResults = {
+  /**
+   * Global derived error state for easy access
+   */
+  error: boolean
+
+  verifications: Array<IValidationResult>
+}

package/src/types/index.ts

@@ -1,9 +1,9 @@
-export * from './did'
-export * from './pex'
-export * from './vc'
-export * from './generic'
-export * from './sd-jwt-vc'
-export * from './w3c-vc'
-export * from './jose'
-export * from './cose'
-export * from './mso_mdoc'
+export * from './did'
+export * from './pex'
+export * from './vc'
+export * from './generic'
+export * from './sd-jwt-vc'
+export * from './w3c-vc'
+export * from './jose'
+export * from './cose'
+export * from './mso_mdoc'