feat: oa v4 (alpha)

[HJunyuan]

What does this PR do?

• feat: introduce OA v4 (alpha) to wrap and sign VCs with DIDs
• ci: create alpha release based on alpha branch

Caveat

• OA v4 (alpha) schema does not support document store issuance yet - on hold as not crucial at the moment
• Tests are still WIP

[github-actions]

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

eslint

src/4.0/schema/schema.test.ts|377 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|383 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|399 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|415 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|431 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|449 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|469 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|490 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|491 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|500 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|533 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|553 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|588 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|623 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|646 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|669 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|694 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|695 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|700 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|709 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|718 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|723 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|728 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|735 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|756 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|779 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|799 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|820 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|840 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|861 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|883 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|884 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|895 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|920 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|947 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|948 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|957 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|966 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|976 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|996 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|1017 col 3| Some tests seem to be commented
src/4.0/schema/schema.test.ts|1038 col 3| Some tests seem to be commented
src/4.0/wrap.ts|15 col 3| 'options' is defined but never used. Allowed unused args must match /^_/u.
src/shared/@types/wrap.ts|15 col 18| An empty interface is equivalent to {}.

[cavacado]

talked to kyle about this, perhaps could be expressed clearer with just an iteration over the Sets since they preserve insertion order.

the reason why he did this is so to guarantee that the order will not be affected once the Set has been coerced into an Array, and he was cautious about it since sets in general are known to be unordered in other languages.

[cavacado]

once you've made the pushes and github services are restored lets merge this.

[superical]

Just a small thing, I notice you have another part below at around line 36-40 doing something quite similar. You see if you want to create function for convenience sake. For eg:

function mergeDocSet<T extends string>(existing: T | T[], required: T[]): T[] {
  const set = new Set(required);
  if (typeof existing === "string") {
    set.add(existing);
  } else if (Array.isArray(existing)) {
    existing.forEach((item) => set.add(item));
  }
  return Array.from(set);
}

Then you turn this part into just:

document["@context"] = mergeDocSet(document["@context"], ["https://www.w3.org/2018/credentials/v1", ContextUrl.v4_alpha]);

[HJunyuan]

Thanks for this suggestion! As discussed, we can improve on this in the subsequent alpha version

[superical]

Assuming if we use the above helper function, we can turn this part into just this:

document["type"] = mergeDocSet(document["type"], ["VerifiableCredential", "OpenAttestationCredential"]);

[github-actions]

🎉 This PR is included in version 6.8.0-alpha.1 🎉

The release is available on:

• npm package (@alpha dist-tag)
• GitHub release

Your semantic-release bot 📦🚀