dcql 0.2.2 → 0.2.4

package/src/vp-query/v-vp-query.ts

@@ -1,71 +0,0 @@
-import * as v from 'valibot';
-import { CredentialQuery } from '../credential-query/v-credential-query.js';
-import {
-  InvalidCredentialQueryIdError,
-  VpQueryCredentialSetError,
-  VpQueryNonUniqueCredentialQueryIdsError,
-} from '../e-vp-query.js';
-import { credentialSetIdRegex, getIdMetadata } from '../u-query.js';
-import { queryVerifiablePresentation } from './vp-query.js';
-
-export namespace VpQuery {
-  export const vModel = v.object({
-    credentials: v.pipe(v.array(CredentialQuery.vModel), v.nonEmpty()),
-    credential_sets: v.optional(
-      v.pipe(
-        v.array(v.array(v.pipe(v.string(), v.regex(credentialSetIdRegex)))),
-        v.nonEmpty()
-      )
-    ),
-  });
-  export type Input = v.InferInput<typeof vModel>;
-  export type Out = v.InferOutput<typeof vModel>;
-  export const validate = (vpQuery: Out) => {
-    validateUniqueCredentialQueryIds(vpQuery);
-    validateCredentialSets(vpQuery);
-  };
-  export const query = queryVerifiablePresentation;
-}
-export type VpQuery = VpQuery.Out;
-
-// --- validations --- //
-
-const validateUniqueCredentialQueryIds = (query: VpQuery.Out) => {
-  const ids = query.credentials.map(c => c.id);
-  const duplicates = ids.filter((id, index) => ids.indexOf(id) !== index);
-
-  if (duplicates.length > 0) {
-    throw new VpQueryNonUniqueCredentialQueryIdsError({
-      message: `Duplicate credential query ids found: ${duplicates.join(', ')}`,
-    });
-  }
-};
-
-const validateCredentialSets = (query: VpQuery.Out) => {
-  if (!query.credential_sets) return;
-
-  const credentialIds = new Set(query.credentials.map(c => c.id));
-  const undefinedCredentials: string[] = [];
-  for (const credential_set of query.credential_sets) {
-    for (const credential_id of credential_set) {
-      const { baseId, isRequiredIfPresent } = getIdMetadata(credential_id);
-
-      if (isRequiredIfPresent) {
-        throw new InvalidCredentialQueryIdError({
-          message:
-            'Invalid credential-query id. Required if present operator can only be applied to credential queries.',
-        });
-      }
-
-      if (!credentialIds.has(baseId)) {
-        undefinedCredentials.push(credential_id);
-      }
-    }
-  }
-
-  if (undefinedCredentials.length > 1) {
-    throw new VpQueryCredentialSetError({
-      message: `Credential set contains undefined credential id${undefinedCredentials.length === 1 ? '' : '`s'} '${undefinedCredentials.join(', ')}'`,
-    });
-  }
-};

package/src/vp-query/vp-query.fixtures.ts

@@ -1,178 +0,0 @@
-import type { VpQuery } from './v-vp-query.js';
-
-export const simple: VpQuery = {
-  credentials: [
-    {
-      id: 'my_credential',
-      format: 'vc+sd-jwt',
-      meta: {
-        vct_values: ['https://credentials.example.com/identity_credential'],
-      },
-      claims: [
-        { path: ['last_name'] },
-        { path: ['first_name'] },
-        { path: ['address', 'street_address'] },
-      ],
-    },
-  ],
-};
-
-export const matchingSimple: VpQuery = {
-  credentials: [
-    {
-      id: 'my_credential',
-      format: 'vc+sd-jwt',
-      meta: {
-        vct_values: ['https://credentials.example.com/identity_credential'],
-      },
-      claims: [
-        {
-          path: ['last_name'],
-          values: ['Doe'],
-        },
-        { path: ['first_name'] },
-        { path: ['address', 'street_address'] },
-        {
-          path: ['postal_code'],
-          values: ['90210', '90211'],
-        },
-      ],
-    },
-  ],
-};
-
-export const multiCredentials: VpQuery = {
-  credentials: [
-    {
-      id: 'pid',
-      format: 'vc+sd-jwt',
-      meta: {
-        vct_values: ['https://credentials.example.com/identity_credential'],
-      },
-      claims: [
-        { path: ['given_name'] },
-        { path: ['family_name'] },
-        { path: ['address', 'street_address'] },
-      ],
-    },
-    {
-      id: 'mdl',
-      format: 'mso_mdoc',
-      meta: {
-        doctype_values: ['org.iso.7367.1.mVR'],
-      },
-      claims: [
-        {
-          namespace: 'org.iso.7367.1',
-          claim_name: 'vehicle_holder',
-        },
-        {
-          namespace: 'org.iso.18013.5.1',
-          claim_name: 'first_name',
-        },
-      ],
-    },
-  ],
-};
-
-export const credentialAlternatives: VpQuery = {
-  credentials: [
-    {
-      id: 'pid',
-      format: 'vc+sd-jwt',
-      meta: {
-        vct_values: ['https://credentials.example.com/identity_credential'],
-      },
-      claims: [
-        { path: ['given_name'] },
-        { path: ['family_name'] },
-        { path: ['address', 'street_address'] },
-      ],
-    },
-    {
-      id: 'other_pid',
-      format: 'vc+sd-jwt',
-      meta: {
-        vct_values: ['https://othercredentials.example/pid'],
-      },
-      claims: [
-        { path: ['given_name'] },
-        { path: ['family_name'] },
-        { path: ['address', 'street_address'] },
-      ],
-    },
-    {
-      id: 'pid_reduced_cred_1',
-      format: 'vc+sd-jwt',
-      meta: {
-        vct_values: [
-          'https://credentials.example.com/reduced_identity_credential',
-        ],
-      },
-      claims: [{ path: ['family_name'] }, { path: ['given_name'] }],
-    },
-    {
-      id: 'pid_reduced_cred_2',
-      format: 'vc+sd-jwt',
-      meta: {
-        vct_values: ['https://cred.example/residence_credential'],
-      },
-      claims: [
-        { path: ['postal_code'] },
-        { path: ['locality'] },
-        { path: ['region'] },
-      ],
-    },
-    {
-      id: 'nice_to_have',
-      format: 'vc+sd-jwt',
-      meta: {
-        vct_values: ['https://company.example/company_rewards'],
-      },
-      claims: [
-        { id: 'current', path: ['rewards_number'] },
-        { id: 'legacy', path: ['legacy_system_rewards_number'] },
-      ],
-      claim_sets: [['current', 'legacy?']],
-    },
-  ],
-  credential_sets: [
-    // deliver the pid, or the other_pid, or both pid_reduced_cred1 + 2; nice_to_have is optional in all cases
-    ['pid', 'nice_to_have?'],
-    ['other_pid', 'nice_to_have?'],
-    ['pid_reduced_cred_1', 'pid_reduced_cred_2', 'nice_to_have?'],
-  ],
-};
-
-export const claimAlternatives: VpQuery = {
-  credentials: [
-    {
-      id: 'pid',
-      format: 'vc+sd-jwt',
-      meta: {
-        vct_values: ['https://credentials.example.com/identity_credential'],
-      },
-      // Comments in JSON to be removed before merging PR, they are just here to make Brian less sad
-      claims: [
-        // define claims, may add other properties like a purpose to each claims
-        {
-          id: 'a', // required for use in claim_sets below; if that is omitted, the id is optional
-          path: ['last_name'],
-        },
-        { id: 'b', path: ['postal_code'] },
-        { id: 'c', path: ['locality'] },
-        { id: 'd', path: ['region'] },
-        { id: 'e', path: ['date_of_birth'] },
-        { id: 'f', path: ['email'] },
-      ],
-      claim_sets: [
-        // defines the rules
-        // postal code or (locality and region), last_name, and date_of_birth are mandatory; email is optional
-        ['a', 'b', 'e', 'f?'],
-        ['a', 'c', 'd', 'e', 'f?'],
-
-        // Note: the ? to mark a claim as optional is syntactical sugar; the rules could be rewritten without it, but that would require a lot of repetition
-      ],
-    },
-  ],
-};

package/src/vp-query/vp-query.test.ts

@@ -1,156 +0,0 @@
-import { describe, it } from 'node:test';
-import * as v from 'valibot';
-import type { VpQueryResult } from './v-vp-query-result.js';
-import { VpQuery } from './v-vp-query.js';
-
-export class ResultBuilder {
-  private autoComplete: boolean;
-  constructor(private vpQueryResult: VpQueryResult) {
-    this.autoComplete = false;
-  }
-
-  disableAutoComplete(disabled?: boolean) {
-    this.autoComplete = !(disabled ?? true);
-  }
-
-  getSolutionSpace() {
-    const solutionSpace: {
-      credentialSetIndex: number;
-      claimSets: {
-        claimSetIndex: number;
-        credentialIndices: number[];
-      }[];
-    }[] = [];
-
-    for (const [
-      credentialSetIndex,
-      credentialSetResults,
-    ] of this.vpQueryResult.credential_sets_results.entries()) {
-      if (!credentialSetResults.areRequiredCredentialsPresent) continue;
-
-      const claimSets = credentialSetResults.credential_set_result.flatMap(
-        credentialSetResultsForCredential => {
-          return credentialSetResultsForCredential.claim_sets_results.flatMap(
-            (claimSetResults, claimSetIndex) => {
-              const credentialIndices = claimSetResults
-                .map((claimSetResultForCredential, credentialIndex) =>
-                  claimSetResultForCredential.areRequiredClaimsPresent
-                    ? credentialIndex
-                    : -1
-                )
-                .filter(index => index !== -1);
-
-              return credentialIndices.length > 0
-                ? [{ claimSetIndex, credentialIndices }]
-                : [];
-            }
-          );
-        }
-      );
-
-      if (claimSets.length > 0) {
-        solutionSpace.push({ credentialSetIndex, claimSets });
-      }
-    }
-
-    return solutionSpace;
-  }
-}
-
-export const simpleMdoc = {
-  credentials: [
-    {
-      id: 'my_credential',
-      format: 'mso_mdoc',
-      meta: {
-        doctype_values: ['org.iso.7367.1.mVR'],
-      },
-      claims: [
-        {
-          id: 'a',
-          namespace: 'org.iso.7367.1',
-          claim_name: 'vehicle_holder',
-        },
-        {
-          id: 'b',
-          namespace: 'org.iso.18013.5.1',
-          claim_name: 'first_name',
-        },
-        {
-          id: 'c',
-          namespace: 'org.iso.18013.5.1',
-          claim_name: 'invalid',
-        },
-      ],
-      claim_sets: [['a'], ['b'], ['c'], ['a', 'b?!']],
-    },
-    {
-      id: 'my_credential2',
-      format: 'mso_mdoc',
-      meta: {
-        doctype_values: ['org.iso.7367.1.mVR'],
-      },
-      claims: [
-        {
-          id: 'a',
-          namespace: 'org.iso.7367.1',
-          claim_name: 'vehicle_holder',
-        },
-        {
-          id: 'b',
-          namespace: 'org.iso.18013.5.1',
-          claim_name: 'first_name',
-        },
-        {
-          id: 'c',
-          namespace: 'org.iso.18013.5.1',
-          claim_name: 'invalid',
-        },
-      ],
-      claim_sets: [['a'], ['b'], ['c'], ['a', 'b?!']],
-    },
-  ],
-  credential_sets: [['my_credential?'], ['my_credential']],
-} satisfies VpQuery;
-
-const validMdoc = {
-  docType: 'org.iso.7367.1.mVR',
-  namespaces: {
-    'org.iso.7367.1': {
-      vehicle_holder: 'Martin Auer',
-      non_disclosed: 'secret',
-    },
-
-    'org.iso.18013.5.1': {
-      first_name: 'Martin Auer',
-    },
-  },
-};
-
-await describe('credential-parser', async () => {
-  await it('mdoc-credential-parser', _t => {
-    const query = v.parse(VpQuery.vModel, simpleMdoc);
-    VpQuery.validate(query);
-    const res = VpQuery.query(query, [
-      validMdoc,
-      {
-        docType: 'org.iso.7367.1.mVR',
-        namespaces: {
-          'org.iso.7367.1': {
-            non_disclosed: 'secret',
-          },
-
-          'org.iso.18013.5.1': {
-            first_name: 'Martin Auer',
-          },
-        },
-      },
-      { docType: 'some', namespaces: {} },
-    ]);
-
-    console.log(res);
-    const builder = new ResultBuilder(res);
-    const solutionSpace = builder.getSolutionSpace();
-    console.log(solutionSpace);
-  });
-});

package/src/vp-query/vp-query.ts

@@ -1,44 +0,0 @@
-import { queryCredentialSet } from '../credential-query/credential-query-result.js';
-import type { Mdoc } from '../u-query.js';
-import type { VpQueryResult } from './v-vp-query-result.js';
-import type { VpQuery } from './v-vp-query.js';
-
-export const queryVerifiablePresentation = (
-  vpQuery: VpQuery,
-  credentials: Mdoc[]
-): VpQueryResult => {
-  const credential_sets_results = (vpQuery.credential_sets ?? [undefined]).map(
-    credential_set => {
-      // TODO: SHOULD WE THROW IN CASE AN EMPTY CREDENTIAL_SET IS PASSED?
-      if (credential_set?.length === 0) {
-        return {
-          areRequiredCredentialsPresent: true,
-          credential_set_result: [],
-        };
-      }
-
-      const credentialSetQueryResult = queryCredentialSet(
-        vpQuery.credentials,
-        credentials,
-        credential_set as [string, ...string[]] | undefined
-      );
-
-      const areRequiredCredentialsPresent = credentialSetQueryResult.every(
-        credentialQueryResult =>
-          credentialQueryResult.isOptional ||
-          credentialQueryResult.claim_sets_results.some(claimSetResult =>
-            claimSetResult.some(
-              claimQueryResult => claimQueryResult.areRequiredClaimsPresent
-            )
-          )
-      );
-
-      return {
-        areRequiredCredentialsPresent,
-        credential_set_result: credentialSetQueryResult,
-      };
-    }
-  );
-
-  return { ...vpQuery, credential_sets_results };
-};

package/tsconfig.json

@@ -1,5 +0,0 @@
-{
-  "extends": "@ausweis/typescript/internal-package.json",
-  "include": ["src"],
-  "exclude": ["node_modules"]
-}