v1.0.0

1.0.0 (2023-11-01)

Bug Fixes

• #68 - allow extra properties for v2 issuers (65eedbf)
• 🐛 node version to lts (#209) (245196b)
• $template can be a string for schema v2 (e39bc58)
• add guard and utils (7546878)
• allow last field of an object to be obfuscated (a0c783f)
• better type guards (673b193)
• build umd from esm output (1ba0450)
• bump deps (#236) (4f2badb)
• change node-fetch to cross-fetch (6d6ed36)
• change sh to js (c0c6403)
• circleci-context (#198) (7e5c2a7)
• combine log lines for easier searching (4f4bf3d)
• deployment (#200) (b00b462)
• export sign types (abaab60)
• export signer (#163) (4c5a281)
• improve obfuscateDocument function type (e6b4d8a)
• include scripts folder (0e19d93)
• jsonld security issue (#162) (4ca5a65)
• loose json schema validation (e58aaeb)
• move context to schemata repository (ad617d1)
• node document loader not available in browser (#168) (b38f34c)
• pre-load only at first call (63c39fc)
• publish (b630af9)
• publish (81a63c3)
• refactoring types and functions (#142) (16a20aa)
• release (54e85c4)
• rename isSignedWrappedDocument to isSignedWrappedV2Document (d7454fc)
• rename unwrapped to raw (b5f8242)
• replace jsonld by our own esm-free implementation (27d013d)
• revert "feat: add schema url" (706dc3d)
• revert esm changes (295ac47)
• run postinstall only locally (90d9f08)
• stringify errors to properly log them (990397e)
• throw error get issuer address (#158) (f131e3e)
• trigger release (bded014)
• update jsonld to v5 (#165) (3855407)
• update wallet type (#220) (8783b3e)
• use apache license 2.0 (a6b6783)
• use root dir to get rid of src extra folder in dist/types (f55ae0d)
• use schema v2 as default schema (9fd59ac)
• utils (#243) (b7a26fe)
• v3 cred needs OpenAttestationCredential type (5c842bf)

chore

• update to npm 7, drop cjs support (e6333d2)

Features

• #72 - add getIssuerAddress helper (2a5297e)
• 🎸 add a sign method to append signed proofs (#92) (4fbc2c2)
• 🎸 add ocsp responder to revocation type (#208) (74f61d0)
• 🎸 add W3C-DID as supported type for issuer identityProof (66725bf)
• add chainDetail optional field into schema (#216) (a0478a5)
• add diagnose (57f1903)
• add getMerkleRoot (#152) (d79cb49)
• add isSignedWrappedDocument helper (038bdef)
• add mimetypes (#116) (2b239b2)
• add oa-did-sign into the codebase (d2de7b9)
• add schema url (32e8b89)
• add support for different revocation types for v2 and v3 (#150) (53a7968)
• add utils to extract v2/v3 template data (2fa596e)
• added getAssetId and getTargetHash (#174) (8badabf)
• added isDocumentRevokable and test cases (#192) (99fbcba)
• added utils function to update form for v2 and v3 (#219) (05c5894)
• allow ethers signer (55e0796)
• defining schema for document with did signature (#145) (7055930), closes #146
• ethers v5 latest (#253) (7c36aab)
• extending v2 with did and dns-did (#127) (e286ec7)
• fix broken v3 schema link (#223) (1100b01)
• init release (#4) (1d91eea)
• multiple proofs (#130) (81936b6)
• open-attestation v3 (f553343)
• publishing schema (#76) (3e9b73b)
• remove update form (#246) (8e18314)
• removed legacy document signing in favor of DID signing (#131) (e421956)
• revert empty fields (#128) (4d64cba)
• strict schema typing (#79) (16ad48f)
• stricter schema for WrappedDocument (#80) (75497e6)
• trigger release (64f6f95)
• trigger release (a1e06fa)
• update schema to use w3c structure (83ca301)
• updated schema id to url (#77) (93fd9a8)
• use js-sha (d2860c9)
• use js-sha (#42) (d6c5c96)
• using identifier in identityProof (#147) (bcb38d5)
• util get obfuscated (#159) (d0b95d3)

BREAKING CHANGES

• drop cjs support, drop node 10 support
• The graphiteWidth option has been removed.

• behaviour of the type guard is much more restrictive than before. While we could imagine this as a fix, I think it's actually quite a major change in behaviour and should be tagged as is.
• ProofType, SignatureAlgorithm and ProofPurpose enums are not available anymore. They have been transformed to literal.
• rename VerifiableCredentialProofBase to VerifiableCredentialWrappedProof
• rename VerifiableCredentialProofSigned to VerifiableCredentialSignedProof

improved the following methods:

• isWrappedV3Document
• isWrappedV2Document
• isSignedWrappedV2Document
• isSignedWrappedV3Document

• Signed document in the previous format is no longer supported

Co-authored-by: Raymond Yeh [email protected]

• New schema to be w3c compliant

Changes are:

• issuers is not an array anymore. Consequence, proof.value is not an array anymore
• issuer.id is a new mandatory field which must be an URI
• issuer.identityProof.subject has been remove because it's not needed anymore
• @context has been added for w3c compliance to help consumer provide terminology. It's an optional field
• id has been updated to follow w3c compliance. It's an optional uri about the subject of the VC
• reference has been added and is equal to the previous id
• type has been added as the type of the VC (w3c compliance)
• validFrom has been added (w3c compliance)
• validUntil has been added (w3c compliance). It's an optional field
• attachments.type has been updated to follow w3c compliance. It refers to a valid evidence type.
• attachments.mimeType has been added and is equal to the previous attachments.type
• rename $template to template

Adding v2 schema which is a simple version of schema used in tradetrust
and opencerts

Generate types from schema. Types are exported

Update wording:

• sign => wrap
• SignedDocument => WrappedDocument