Skip to content

Commit

Permalink
feat: Add WACI PEx QR generator for React
Browse files Browse the repository at this point in the history
  • Loading branch information
nklomp committed Feb 11, 2022
1 parent fd2fa02 commit 7850e34
Show file tree
Hide file tree
Showing 16 changed files with 13 additions and 12 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Connect for Verifiable Presentations, with the help of
our [Presentation-Exchange library](https://github.com/Sphereon-Opensource/pe-js).

## WACI PEx
The [waci-pex](./packages/waci-pex/README.md) is a Veramo plugin to generate a QR Code using the [WACI Presentation Exchange](https://identity.foundation/waci-presentation-exchange/#step-1-generate-qr-code) specification.
The [waci-pex-qr-react](./packages/waci-pex-qr-react/README.md) is a Veramo plugin to generate a QR Code using the [WACI Presentation Exchange](https://identity.foundation/waci-presentation-exchange/#step-1-generate-qr-code) specification.

## DID resolution

Expand Down
2 changes: 1 addition & 1 deletion packages/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@
{ "path": "vc-api-verifier" },
{ "path": "vc-handler-ld-local" },
{ "path": "did-auth-siop-op-authenticator" },
{ "path": "waci-pex" }
{ "path": "waci-pex-qr-react" }
]
}
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<h1 align="center">
<br>
<a href="https://www.sphereon.com"><img src="https://sphereon.com/content/themes/sphereon/assets/img/logo.svg" alt="Sphereon" width="400"></a>
<br>waci-pex (Typescript)
<br>waci-pex-qr-react (Typescript)
<br>
</h1>

Expand All @@ -12,7 +12,7 @@

---

# waci-pex
# waci-pex-qr-react

A `Sphereon SSI-SDK` plugin to create an SSI QR code and to verify using `SIOPv2` or `OIDC4`. This plugin component is only supporting react and react-native frameworks.

Expand All @@ -21,7 +21,7 @@ It will be possible in future to request the issuer to issue credentials.
### Installation

```shell
yarn add @sphereon/ssi-sdk-waci-pex
yarn add @sphereon/ssi-sdk-waci-pex-qr-react
```

### Build
Expand Down Expand Up @@ -49,7 +49,7 @@ The data fields will need to be passed in `SsiQrCodeProps.authenticationRequestO
#### Importing the plugin

```
import {SsiQrCodeProvider} from "@sphereon/ssi-sdk-waci-pex";
import {SsiQrCodeProvider} from "@sphereon/ssi-sdk-waci-pex-qr-react";
// Include in the interface
// const agent = createAgent<... SsiQrCodeProvider>
Expand All @@ -74,7 +74,7 @@ The function declared in agent can be imported for usage like below:

```
import { createSsiQrCode } from '../agent';
import {QRContent, QRMode, QRType} from "@sphereon/ssi-sdk-waci-pex";
import {QRContent, QRMode, QRType} from "@sphereon/ssi-sdk-waci-pex-qr-react";
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ agent:
$args:
- schemaValidation: false
plugins:
- $require: ./packages/waci-pex/dist#SsiQrCodeProvider
- $require: ./packages/waci-pex-qr-react/dist#SsiQrCodeProvider
$args:
- ssiQrCodeProps
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import ssiQrCodeProviderLogic from './shared/ssiQrCodeProviderLogic'
let agent: any

const setup = async (): Promise<boolean> => {
const config = getConfig('packages/waci-pex/__tests__/agent.yml')
const config = getConfig('packages/waci-pex-qr-react/__tests__/agent.yml')
const {localAgent} = createObjects(config, {localAgent: '/agent'})
agent = localAgent

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@sphereon/ssi-sdk-waci-pex",
"name": "@sphereon/ssi-sdk-waci-pex-qr-react",
"version": "0.3.3",
"description": "WACI PEx SSI QR Code provider",
"description": "WACI PEx QR Code provider (react)",
"source": "src/index.ts",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down Expand Up @@ -50,6 +50,7 @@
"Sphereon",
"SSI",
"DIF",
"React",
"WACI PEx",
"QR Code"
]
Expand Down
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2612,7 +2612,7 @@
dependencies:
"@sinonjs/commons" "^1.7.0"

"@sphereon/[email protected]":
"@sphereon/[email protected]", "@sphereon/did-auth-siop@^0.2.7":
version "0.2.7"
resolved "https://registry.yarnpkg.com/@sphereon/did-auth-siop/-/did-auth-siop-0.2.7.tgz#8ab3507583216a7a5e698af3f5e3cf8a0c9fee7b"
integrity sha512-OfSch21HZjfsmn1yGAUcinlm4Rc8hrNlFjgcBLyInhDNGWDgdsNYz90swb90/Q6siiZGRynOpPAmt3b2mCtvpg==
Expand Down

0 comments on commit 7850e34

Please sign in to comment.