Skip to content

Commit

Permalink
chore(release): release 5.0.0
Browse files Browse the repository at this point in the history
# [5.0.0](v4.0.0...v5.0.0) (2024-02-28)

### Bug Fixes

* add reference app + mediator live mode ([#177](#177)) ([6ebf48a](6ebf48a))
* e2e tests improvement ([#178](#178)) ([eb6a5ab](eb6a5ab))
* key's id name according to the DID Peer new specs [#126](#126) ([#148](#148)) ([a851b69](a851b69))
* Manually generating the missing changelog and breaking changes b… ([#167](#167)) ([24ecc04](24ecc04))
* Recover JTI field correctly. Allowing to regenerate the original JWT string ([#171](#171)) ([913f3fa](913f3fa))

* feat!: Implementing Pluto Repositories (#160) ([ce7669f](ce7669f)), closes [#160](#160)

### BREAKING CHANGES

* - Domain.Credential now has uuid (string) as an optional attribute in the class
- Change StorePrismDID Function parameters, removing keyPathIndex and privateKeyMetadataId which were not in use
- Small change in the getCredentialMetadata and getLinkSecret to return null when not found
- Change Pluto interface to use CredentialMetadata class VS what it was using before.
- Change Pluto interface, storeMediator now accepts a Mediator class and not 3 attributes, mediator, host and routing
- Rename storePrivateKeys to storePrivateKey
- Change Pluto interface, using Domain.PrismDID instead of Domain.PrismDID which is being removed
- Added new properties to handle Anoncreds credentials properties.
- Re-implemented Pluto which is now available again to all the users.

import SDK from "@atala/prism-wallet-sdk";
import IndexDB from "@pluto-encrypted/indexdb";

const store = new SDK.Store({
name: "test",
storage: IndexDB,
password: Buffer.from("demoapp").toString("hex")
});
const pluto = new SDK.Pluto(store, apollo);

Migrations, schemas, queries and error handling have been moved to the SDK again but user's which were using the existing storages can just pass the indexDB pluto-encrypted storage and it will integrate with the new db schemas, migrations, etc
  • Loading branch information
atala-dev authored and elribonazo committed May 3, 2024
1 parent 670f23e commit 60ba1ce
Show file tree
Hide file tree
Showing 258 changed files with 6,948 additions and 2,581 deletions.
39 changes: 39 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,42 @@
# [5.0.0](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/compare/v4.0.0...v5.0.0) (2024-02-28)


### Bug Fixes

* add reference app + mediator live mode ([#177](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/issues/177)) ([6ebf48a](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/commit/6ebf48a637c0990cf53c7ca5197fa15b1553a07c))
* e2e tests improvement ([#178](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/issues/178)) ([eb6a5ab](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/commit/eb6a5ab7c6ca45481f9743480bf840a59889ff13))
* key's id name according to the DID Peer new specs [#126](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/issues/126) ([#148](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/issues/148)) ([a851b69](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/commit/a851b696eab02a8cc47f1affca03ad9b178082d9))
* Manually generating the missing changelog and breaking changes b… ([#167](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/issues/167)) ([24ecc04](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/commit/24ecc040b5d42a77fc591c01fe3fdbe54d89bb6f))
* Recover JTI field correctly. Allowing to regenerate the original JWT string ([#171](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/issues/171)) ([913f3fa](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/commit/913f3fa96fe003f21a4a22eeac989d5fa004dba9))


* feat!: Implementing Pluto Repositories (#160) ([ce7669f](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/commit/ce7669ffb09be4cefe257fc592f36451e748d443)), closes [#160](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/issues/160)


### BREAKING CHANGES

* - Domain.Credential now has uuid (string) as an optional attribute in the class
- Change StorePrismDID Function parameters, removing keyPathIndex and privateKeyMetadataId which were not in use
- Small change in the getCredentialMetadata and getLinkSecret to return null when not found
- Change Pluto interface to use CredentialMetadata class VS what it was using before.
- Change Pluto interface, storeMediator now accepts a Mediator class and not 3 attributes, mediator, host and routing
- Rename storePrivateKeys to storePrivateKey
- Change Pluto interface, using Domain.PrismDID instead of Domain.PrismDID which is being removed
- Added new properties to handle Anoncreds credentials properties.
- Re-implemented Pluto which is now available again to all the users.

import SDK from "@atala/prism-wallet-sdk";
import IndexDB from "@pluto-encrypted/indexdb";

const store = new SDK.Store({
name: "test",
storage: IndexDB,
password: Buffer.from("demoapp").toString("hex")
});
const pluto = new SDK.Pluto(store, apollo);

Migrations, schemas, queries and error handling have been moved to the SDK again but user's which were using the existing storages can just pass the indexDB pluto-encrypted storage and it will integrate with the new db schemas, migrations, etc

# [4.0.0](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/compare/v3.1.0...v4.0.0) (2024-02-02)

* fix: removing terser to allow an unminified build that is easier to d… by @elribonazo in https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/pull/127
Expand Down
39 changes: 15 additions & 24 deletions docs/sdk/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@input-output-hk/atala-prism-wallet-sdk / [Exports](modules.md)
@atala/prism-wallet-sdk / [Exports](modules.md)

# Atala PRISM TypeScript SDK

Expand Down Expand Up @@ -40,10 +40,6 @@ or with yarn
yarn add @atala/prism-wallet-sdk
```

> **Note for Webpack:**
>
> The application builds code with wasm files for DIDComm and Anoncreds for both browsers and nodejs. When webpack builds public website the wasm files need to be copied manually into the public folder. See examples
### Running a demo project

#### Building from source
Expand All @@ -66,44 +62,39 @@ npm i
npm run build
```

### For NodeJS CJS

After building `prism-wallet-sdk`, cd into `{path}/demos/node-cjs` or use visual studio debugger "CJS DEMO":
### Running the sample applications
We have enabled sample implementations for browser (react or nextjs) and nodejs.
In order to run each demo, make sure the whole SDK is built from source, then cd into the demo.

Nodejs CommonJS
```bash
cd demos/node-cjs
npm i
npm run start
```

> **Note:**
>
> The installation in the `{path}/demos/node-cjs` directory requires the `build` folder from the wallet-sdk to be available.
### For NodeJS ESM

After building `prism-wallet-sdk`, cd into `{path}/demos/node-esm` or use visual studio debugger "ESM DEMO":

Nodejs Module
```bash
cd demos/node-esm
npm i
npm run start
```

> **Note:**
>
> The installation in the `{path}/demos/node-esm` directory requires the `build` folder from the wallet-sdk to be available.
### For browser

After building `prism-wallet-sdk`, cd into the demo directory `{path}/demos/browser`

Browser React
```bash
cd demos/browser
npm i
npm run start
```

Browser NextJS
```bash
cd demos/next
npm i
npm run build # becuase Error: ENOENT: no such file or directory, open '/.../atala-prism-wallet-sdk-ts/demos/next/.next/BUILD_ID']
npm run start
```

### Implementing storage for the SDK
This SDK exposes Pluto, a storage interface that should be implemented by the user, in the most appropriate way for a particular use case.

Expand Down
Loading

0 comments on commit 60ba1ce

Please sign in to comment.