chore: more type and format extraction methods

Author: nklomp

packages/common/lib/functions/IssuerMetadataUtils.ts

@@ -1,12 +1,4 @@
-import {
-  CredentialDefinitionV1_0_13,
-  CredentialOfferFormat,
-  CredentialOfferPayload,
-  JsonLdIssuerCredentialDefinition,
-  UniformCredentialOfferPayload,
-  UniformCredentialOfferRequest,
-  VCI_LOG_COMMON,
-} from '../index';
+import { getTypesFromObject, VCI_LOG_COMMON } from '../index';
 import {
   AuthorizationServerMetadata,
   CredentialConfigurationSupported,
@@ -157,33 +149,6 @@ export function getSupportedCredential(opts?: {
   throw Error(`Either < v11 configurations or V13 configurations should have been filtered at this point`);
 }
 
-export function getTypesFromCredentialSupported(
-  credentialSupported: CredentialConfigurationSupported,
-  opts?: { filterVerifiableCredential: boolean },
-) {
-  let types: string[] = [];
-  if (
-    credentialSupported.format === 'jwt_vc_json' ||
-    credentialSupported.format === 'jwt_vc' ||
-    credentialSupported.format === 'jwt_vc_json-ld' ||
-    credentialSupported.format === 'ldp_vc'
-  ) {
-    types = getTypesFromObject(credentialSupported) ?? [];
-  } else if (credentialSupported.format === 'vc+sd-jwt') {
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore
-    types = [credentialSupported.vct];
-  }
-
-  if (!types || types.length === 0) {
-    throw Error('Could not deduce types from credential supported');
-  }
-  if (opts?.filterVerifiableCredential) {
-    return types.filter((type) => type !== 'VerifiableCredential');
-  }
-  return types;
-}
-
 export function credentialsSupportedV8ToV13(supportedV8: CredentialSupportedTypeV1_0_08): Record<string, CredentialConfigurationSupported> {
   const credentialConfigsSupported: Record<string, CredentialConfigurationSupported> = {};
   Object.entries(supportedV8).flatMap((entry) => {
@@ -238,47 +203,3 @@ export function getIssuerName(
   }
   return url;
 }
-
-/**
- * The specs had many places where types could be expressed. This method ensures we get them in any way possible
- * @param subject
- */
-export function getTypesFromObject(
-  subject: CredentialConfigurationSupported | CredentialOfferFormat | CredentialDefinitionV1_0_13 | JsonLdIssuerCredentialDefinition | string,
-): string[] | undefined {
-  if (subject === undefined) {
-    return undefined;
-  } else if (typeof subject === 'string') {
-    return [subject];
-  } else if ('credential_definition' in subject && subject.credential_definition) {
-    return getTypesFromObject(subject.credential_definition);
-  } else if ('types' in subject && subject.types) {
-    return Array.isArray(subject.types) ? subject.types : [subject.types];
-  } else if ('type' in subject && subject.type) {
-    return Array.isArray(subject.type) ? subject.type : [subject.type];
-  } else if ('vct' in subject && subject.vct) {
-    return [subject.vct];
-  }
-  VCI_LOG_COMMON.warning('Could not deduce credential types. Probably a failure down the line will happen!');
-  return undefined;
-}
-
-export function getTypesFromCredentialOffer(
-  offer: UniformCredentialOfferRequest | CredentialOfferPayload | UniformCredentialOfferPayload,
-): Array<Array<string>> | undefined {
-  if ('credentials' in offer && Array.isArray(offer.credentials)) {
-    return offer.credentials.map((cred) => getTypesFromObject(cred)).filter((cred): cred is string[] => cred !== undefined);
-  } else if ('credential_configuration_ids' in offer && Array.isArray(offer.credential_configuration_ids)) {
-    return offer.credential_configuration_ids.map((id) => [id]);
-  } else if ('credential_offer' in offer && offer.credential_offer) {
-    return getTypesFromCredentialOffer(offer.credential_offer);
-  } else if ('credential_type' in offer && offer.credential_type) {
-    if (typeof offer.credential_type === 'string') {
-      return [[offer.credential_type]];
-    } else if (Array.isArray(offer.credential_type)) {
-      return [offer.credential_type];
-    }
-  }
-  VCI_LOG_COMMON.warning('Could not deduce credential types from offer. Probably a failure down the line will happen!');
-  return undefined;
-}

packages/common/lib/functions/TypeConversionUtils.ts

@@ -1,3 +1,92 @@
+import { AuthorizationDetails, CredentialOfferPayload, UniformCredentialOfferPayload, UniformCredentialOfferRequest, VCI_LOG_COMMON } from '../index';
+import { CredentialConfigurationSupported, CredentialDefinitionV1_0_13, CredentialOfferFormat, JsonLdIssuerCredentialDefinition } from '../types';
+
 export const getNumberOrUndefined = (input?: string): number | undefined => {
   return input && !isNaN(+input) ? +input : undefined;
 };
+
+/**
+ * The specs had many places where types could be expressed. This method ensures we get them in any way possible
+ * @param subject
+ */
+export function getTypesFromObject(
+  subject: CredentialConfigurationSupported | CredentialOfferFormat | CredentialDefinitionV1_0_13 | JsonLdIssuerCredentialDefinition | string,
+): string[] | undefined {
+  if (subject === undefined) {
+    return undefined;
+  } else if (typeof subject === 'string') {
+    return [subject];
+  } else if ('credential_definition' in subject && subject.credential_definition) {
+    return getTypesFromObject(subject.credential_definition);
+  } else if ('types' in subject && subject.types) {
+    return Array.isArray(subject.types) ? subject.types : [subject.types];
+  } else if ('type' in subject && subject.type) {
+    return Array.isArray(subject.type) ? subject.type : [subject.type];
+  } else if ('vct' in subject && subject.vct) {
+    return [subject.vct];
+  }
+  VCI_LOG_COMMON.warning('Could not deduce credential types. Probably a failure down the line will happen!');
+  return undefined;
+}
+
+export function getTypesFromCredentialOffer(
+  offer: UniformCredentialOfferRequest | CredentialOfferPayload | UniformCredentialOfferPayload,
+  opts?: { configIdAsType?: boolean },
+): Array<Array<string>> | undefined {
+  const { configIdAsType = false } = { ...opts };
+  if ('credentials' in offer && Array.isArray(offer.credentials)) {
+    return offer.credentials.map((cred) => getTypesFromObject(cred)).filter((cred): cred is string[] => cred !== undefined);
+  } else if (configIdAsType && 'credential_configuration_ids' in offer && Array.isArray(offer.credential_configuration_ids)) {
+    return offer.credential_configuration_ids.map((id) => [id]);
+  } else if ('credential_offer' in offer && offer.credential_offer) {
+    return getTypesFromCredentialOffer(offer.credential_offer, opts);
+  } else if ('credential_type' in offer && offer.credential_type) {
+    if (typeof offer.credential_type === 'string') {
+      return [[offer.credential_type]];
+    } else if (Array.isArray(offer.credential_type)) {
+      return [offer.credential_type];
+    }
+  }
+  VCI_LOG_COMMON.warning('Could not deduce credential types from offer. Probably a failure down the line will happen!');
+  return undefined;
+}
+
+export function getTypesFromAuthorizationDetails(authDetails: AuthorizationDetails, opts?: { configIdAsType?: boolean }): string[] | undefined {
+  const { configIdAsType = false } = { ...opts };
+  if (typeof authDetails === 'string') {
+    return [authDetails];
+  } else if ('types' in authDetails && Array.isArray(authDetails.types)) {
+    return authDetails.types;
+  } else if (configIdAsType && authDetails.credential_configuration_id) {
+    return [authDetails.credential_configuration_id];
+  }
+
+  return undefined;
+}
+
+export function getTypesFromCredentialSupported(
+  credentialSupported: CredentialConfigurationSupported,
+  opts?: { filterVerifiableCredential: boolean },
+) {
+  let types: string[] = [];
+  if (
+    credentialSupported.format === 'jwt_vc_json' ||
+    credentialSupported.format === 'jwt_vc' ||
+    credentialSupported.format === 'jwt_vc_json-ld' ||
+    credentialSupported.format === 'ldp_vc'
+  ) {
+    types = getTypesFromObject(credentialSupported) ?? [];
+  } else if (credentialSupported.format === 'vc+sd-jwt') {
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    types = [credentialSupported.vct];
+  }
+
+  if (!types || types.length === 0) {
+    throw Error('Could not deduce types from credential supported');
+  }
+  if (opts?.filterVerifiableCredential) {
+    return types.filter((type) => type !== 'VerifiableCredential');
+  }
+  return types;
+}