Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: credential branding update #592

Merged

Conversation

amanji
Copy link
Contributor

@amanji amanji commented Jan 17, 2023

Summary of Changes

Credential branding updated to align with Aries RFC 0755.

This PR constitutes a breaking change to the following items:

Configuration

OCABundle is now OCABundleResolver (hooks have been renamed accordingly). It requires an OCABundleResolver (renamed from DefaultOCABundleResolver) and is initialized in the application configuration with optional OCABundleResolverOptions as follows:

  OCABundleResolver: new oca.OCABundleResolver(require('./assets/oca-bundles.json'), {
    cardOverlayType: oca.CardOverlayType.CardLayout10,
  }),

For reference the OCABundleResolverOptions are:

export interface OCABundleResolverOptions {
  language?: string
  cardOverlayType?: CardOverlayType
}

The cardOverlayType is optional and will default to the new credential card layout CardLayout11.
You can additionally pass a language option although this will default to 'en'. This language parameter can be changed when calling the resolve method. If no language parameter is provided then the default setting of 'en' will be used.

Note: You must initialize the resolve with the fallback cardOverlayType like the example above if you want to retain the older credential card layout

Note: bundles are no longer passed into the resolver with load methods. They are provided during class construction to make the OCA resolver easier to reason about.

Related Issues

N/A

Pull Request Checklist

Tick all boxes below to demonstrate that you have completed the respective task. If the item does not apply to your this PR check it anyway to make it apparent that there's nothing to do.

  • All commits contain a DCO Signed-off-by line (we use the DCO GitHub app to enforce this);
  • Updated LICENSE-3RD-PARTY.md for any added dependencies or vendored components;
  • Updated documentation as needed for changed code and new or modified features;
  • Added sufficient tests so that overall code coverage is not reduced.

If you have any questions to any of the points above, just submit and ask! This checklist is here to help you, not to deter you from contributing!

Pro Tip 🤓

  • Read our contribution guide at least once; it will save you a few review cycles!
  • Your PR will likely not be reviewed until all the above boxes are checked and all automated tests have passed.

PR template adapted from the Python attrs project.

Signed-off-by: Akiff Manji <amanji@petridish.dev>
Signed-off-by: Akiff Manji <amanji@petridish.dev>
Signed-off-by: Akiff Manji <amanji@petridish.dev>
Signed-off-by: Akiff Manji <amanji@petridish.dev>
Signed-off-by: Akiff Manji <amanji@petridish.dev>
Signed-off-by: Akiff Manji <amanji@petridish.dev>
Signed-off-by: Akiff Manji <amanji@petridish.dev>
Signed-off-by: Akiff Manji <amanji@petridish.dev>
Signed-off-by: Akiff Manji <amanji@petridish.dev>
Signed-off-by: Akiff Manji <amanji@petridish.dev>
Signed-off-by: Akiff Manji <amanji@petridish.dev>
Signed-off-by: Akiff Manji <amanji@petridish.dev>
Signed-off-by: Akiff Manji <amanji@petridish.dev>
Signed-off-by: Akiff Manji <amanji@petridish.dev>
Signed-off-by: Akiff Manji <amanji@petridish.dev>
Signed-off-by: Akiff Manji <amanji@petridish.dev>
Signed-off-by: Akiff Manji <amanji@petridish.dev>
Signed-off-by: Akiff Manji <amanji@petridish.dev>
Signed-off-by: Akiff Manji <amanji@petridish.dev>
Signed-off-by: Akiff Manji <amanji@petridish.dev>
Signed-off-by: Akiff Manji <amanji@petridish.dev>
Signed-off-by: Akiff Manji <amanji@petridish.dev>
Signed-off-by: Akiff Manji <amanji@petridish.dev>
Signed-off-by: Akiff Manji <amanji@petridish.dev>
Signed-off-by: Akiff Manji <amanji@petridish.dev>
Signed-off-by: Akiff Manji <amanji@petridish.dev>
@amanji amanji marked this pull request as ready for review January 19, 2023 01:14
Signed-off-by: Akiff Manji <amanji@petridish.dev>
Signed-off-by: Akiff Manji <amanji@petridish.dev>
Signed-off-by: Akiff Manji <amanji@petridish.dev>
Signed-off-by: Akiff Manji <amanji@petridish.dev>
Signed-off-by: Akiff Manji <amanji@petridish.dev>
@amanji amanji marked this pull request as ready for review January 31, 2023 02:15
amanji and others added 7 commits January 31, 2023 07:49
Signed-off-by: Akiff Manji <amanji@petridish.dev>
Signed-off-by: Akiff Manji <amanji@petridish.dev>
Signed-off-by: Akiff Manji <amanji@petridish.dev>
Signed-off-by: Akiff Manji <amanji@petridish.dev>
…es-mobile-agent-react-native into credential-branding-2.0
Signed-off-by: Akiff Manji <amanji@petridish.dev>
@amanji amanji added the hold label Feb 1, 2023
@amanji amanji removed the hold label Feb 10, 2023
jleach
jleach previously approved these changes Feb 13, 2023
Signed-off-by: Akiff Manji <amanji@petridish.dev>
@amanji amanji requested a review from jleach February 15, 2023 19:50
@amanji amanji merged commit 540317e into openwallet-foundation:main Feb 15, 2023
@amanji amanji deleted the credential-branding-2.0 branch June 19, 2024 15:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants