Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
16 changes: 10 additions & 6 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
name: Build the website
permissions:
contents: read
on:
workflow_dispatch:
pull_request:
Expand All @@ -8,16 +10,18 @@ jobs:
docs:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
with:
fetch-depth: 0
- uses: pnpm/action-setup@v4
- name: 'setup node with cache'
uses: actions/setup-node@v4
persist-credentials: false
- uses: pnpm/action-setup@41ff72655975bd51cab0327fa583b6e92b6d3061 # v4.2.0
with:
node-version: 20
version: 10
- name: 'Setup Node.js with pnpm cache'
uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
with:
node-version: 22
cache: 'pnpm'
- run: pnpm add -g pnpm
- run: pnpm install
- name: 'Docusaurus build'
run: |
Expand Down
20 changes: 12 additions & 8 deletions .github/workflows/rebuild-api.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
name: Trigger API reference docs rebuild
permissions:
contents: read
on:
workflow_dispatch:
repository_dispatch:
Expand All @@ -7,17 +9,19 @@ jobs:
docs:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
with:
fetch-depth: 0
persist-credentials: false
token: ${{secrets.GH_TOKEN}}
- uses: pnpm/action-setup@v4
- name: 'setup node with cache'
uses: actions/setup-node@v4
- uses: pnpm/action-setup@41ff72655975bd51cab0327fa583b6e92b6d3061 # v4.2.0
with:
node-version: 20
version: 10
- name: 'Setup Node.js with pnpm cache'
uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
with:
node-version: 22
cache: 'pnpm'
- run: pnpm add -g pnpm
- name: 'build veramo API docs'
run: |
pnpm install
Expand All @@ -34,12 +38,12 @@ jobs:
git remote set-url origin https://x-access-token:${{ secrets.GH_TOKEN }}@github.com/$GITHUB_REPOSITORY
- name: 'Commit changes and tag the new version'
run: |
git clone -b main https://github.com/uport-project/veramo.git veramo
git clone -b main https://github.com/decentralized-identity/veramo.git veramo
RELEASE_VERSION=`echo "console.log(require('./veramo/lerna.json').version)" | node`
if [ "${GITHUB_REF}" != "refs/heads/main" ]; then
RELEASE_VERSION="${RELEASE_VERSION}-preview-${GITHUB_SHA}"
fi
yarn version --no-git-tag-version --new-version "$RELEASE_VERSION"
pnpm version --no-git-tag-version --new-version "$RELEASE_VERSION"
git status
echo Deploying docs for version v$RELEASE_VERSION
git add .
Expand Down
6 changes: 3 additions & 3 deletions blog/2021-04-27-new-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This new release brings together a bunch of fixes and features that we've been w
the community (thank you for your contributions!).

You can get a detailed list of changes in
the [release description](https://github.com/uport-project/veramo/releases/tag/v1.2.0). Depending on how you're
the [release description](https://github.com/decentralized-identity/veramo/releases/tag/v1.2.0). Depending on how you're
using `Veramo` you might be impacted by some breaking changes that had to be added in this release.

## Veramo uses the latest DID spec
Expand Down Expand Up @@ -128,6 +128,6 @@ const myKeyDid = await agent.didManagerCreate({ provider: 'did:key' })

---

As always, if there are any issues, [let us know abut them](https://github.com/uport-project/veramo/issues), and if
there are questions, please use the [discussions page](https://github.com/uport-project/veramo/discussions) to get them
As always, if there are any issues, [let us know about them](https://github.com/decentralized-identity/veramo/issues), and if
there are questions, please use the [discussions page](https://github.com/decentralized-identity/veramo/discussions) to get them
answered and stay tuned for more.
6 changes: 3 additions & 3 deletions blog/2021-07-14-veramo-2.0-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This new release brings together a bunch of fixes and features that we've been w
the community (thank you for your contributions!).

You can get a detailed list of changes in
the [release description](https://github.com/uport-project/veramo/releases/tag/v2.0.0). Depending on how you're
the [release description](https://github.com/decentralized-identity/veramo/releases/tag/v2.0.0). Depending on how you're
using `Veramo` you might be impacted by some breaking changes that had to be added in this release.

## Added support for DIDComm v2
Expand Down Expand Up @@ -141,6 +141,6 @@ set that up.

---

As always, if there are any issues, [let us know abut them](https://github.com/uport-project/veramo/issues), and if
there are questions, please use the [discussions page](https://github.com/uport-project/veramo/discussions) to get them
As always, if there are any issues, [let us know abut them](https://github.com/decentralized-identity/veramo/issues), and if
Copy link

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo in link text: 'abut' should be 'about'.

Suggested change
As always, if there are any issues, [let us know abut them](https://github.com/decentralized-identity/veramo/issues), and if
As always, if there are any issues, [let us know about them](https://github.com/decentralized-identity/veramo/issues), and if

Copilot uses AI. Check for mistakes.
there are questions, please use the [discussions page](https://github.com/decentralized-identity/veramo/discussions) to get them
answered and stay tuned for more.
10 changes: 5 additions & 5 deletions blog/2021-09-20-veramo-3.0-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This new release brings together a bunch of fixes and features that we've been w
the community (thank you for your contributions!).

You can get a detailed list of changes in
the [release description](https://github.com/uport-project/veramo/releases/tag/v3.0.0). Depending on how you're
the [release description](https://github.com/decentralized-identity/veramo/releases/tag/v3.0.0). Depending on how you're
using `Veramo` you might be impacted by some breaking changes that had to be added in this release.

In Veramo 3.0 we've separated some responsibilities of different plugins that deal with key management. This enables
Expand Down Expand Up @@ -48,7 +48,7 @@ database connection is made.

This also means that **`keyManagerGet()` **no longer returns private keys\*\*. If your use-case requires that you export
keys from Veramo, please raise an issue, or contact us on the
[github discussions](https://github.com/uport-project/veramo/discussions) page.
[github discussions](https://github.com/decentralized-identity/veramo/discussions) page.

## Ok, so how does it affect me?

Expand Down Expand Up @@ -152,7 +152,7 @@ keys in their new location.

### I was using my own `AbstractKeyManagementSystem`, what do I do now?

In that case, **congrats!** [Let us know](https://github.com/uport-project/veramo/discussions/categories/show-and-tell)
In that case, **congrats!** [Let us know](https://github.com/decentralized-identity/veramo/discussions/categories/show-and-tell)
about it.

The most important thing to keep in mind is that `KeyManager` **no longer holds any private key material**. It only
Expand All @@ -166,6 +166,6 @@ meta-data when it creates or imports it, before returning the descriptor to the

---

As always, if there are any issues, [let us know abut them](https://github.com/uport-project/veramo/issues), and if
there are questions, please use the [discussions page](https://github.com/uport-project/veramo/discussions) to get them
As always, if there are any issues, [let us know abut them](https://github.com/decentralized-identity/veramo/issues), and if
there are questions, please use the [discussions page](https://github.com/decentralized-identity/veramo/discussions) to get them
answered and stay tuned for more.
36 changes: 33 additions & 3 deletions docs/api/core-types.authorizeddidcontext.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,36 @@ export interface AuthorizedDIDContext extends IAgentContext<{}>

## Properties

| Property | Modifiers | Type | Description |
| -------------------------------------------------------------------- | --------- | ------ | ------------------------- |
| [authorizedDID?](./core-types.authorizeddidcontext.authorizeddid.md) | | string | **_(BETA)_** _(Optional)_ |
<table><thead><tr><th>

Property

</th><th>

Modifiers

</th><th>

Type

</th><th>

Description

</th></tr></thead>
<tbody><tr><td>

[authorizedDID?](./core-types.authorizeddidcontext.authorizeddid.md)

</td><td>

</td><td>

string

</td><td>

**_(BETA)_** _(Optional)_

</td></tr>
</tbody></table>
148 changes: 138 additions & 10 deletions docs/api/core-types.credentialpayload.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,141 @@ export interface CredentialPayload

## Properties

| Property | Modifiers | Type | Description |
| ------------------------------------------------------------------------- | --------- | ---------------------------------------------------------------------- | ------------------------- |
| ["@context"?](./core-types.credentialpayload.__context_.md) | | [ContextType](./core-types.contexttype.md) | **_(BETA)_** _(Optional)_ |
| [credentialStatus?](./core-types.credentialpayload.credentialstatus.md) | | [CredentialStatusReference](./core-types.credentialstatusreference.md) | **_(BETA)_** _(Optional)_ |
| [credentialSubject?](./core-types.credentialpayload.credentialsubject.md) | | [CredentialSubject](./core-types.credentialsubject.md) | **_(BETA)_** _(Optional)_ |
| [expirationDate?](./core-types.credentialpayload.expirationdate.md) | | [DateType](./core-types.datetype.md) | **_(BETA)_** _(Optional)_ |
| [id?](./core-types.credentialpayload.id.md) | | string | **_(BETA)_** _(Optional)_ |
| [issuanceDate?](./core-types.credentialpayload.issuancedate.md) | | [DateType](./core-types.datetype.md) | **_(BETA)_** _(Optional)_ |
| [issuer](./core-types.credentialpayload.issuer.md) | | [IssuerType](./core-types.issuertype.md) | **_(BETA)_** |
| [type?](./core-types.credentialpayload.type.md) | | string\[\] | **_(BETA)_** _(Optional)_ |
<table><thead><tr><th>

Property

</th><th>

Modifiers

</th><th>

Type

</th><th>

Description

</th></tr></thead>
<tbody><tr><td>

["@context"?](./core-types.credentialpayload.__context_.md)

</td><td>

</td><td>

[ContextType](./core-types.contexttype.md)

</td><td>

**_(BETA)_** _(Optional)_

</td></tr>
<tr><td>

[credentialStatus?](./core-types.credentialpayload.credentialstatus.md)

</td><td>

</td><td>

[CredentialStatusReference](./core-types.credentialstatusreference.md)

</td><td>

**_(BETA)_** _(Optional)_

</td></tr>
<tr><td>

[credentialSubject?](./core-types.credentialpayload.credentialsubject.md)

</td><td>

</td><td>

[CredentialSubject](./core-types.credentialsubject.md)

</td><td>

**_(BETA)_** _(Optional)_

</td></tr>
<tr><td>

[expirationDate?](./core-types.credentialpayload.expirationdate.md)

</td><td>

</td><td>

[DateType](./core-types.datetype.md)

</td><td>

**_(BETA)_** _(Optional)_

</td></tr>
<tr><td>

[id?](./core-types.credentialpayload.id.md)

</td><td>

</td><td>

string

</td><td>

**_(BETA)_** _(Optional)_

</td></tr>
<tr><td>

[issuanceDate?](./core-types.credentialpayload.issuancedate.md)

</td><td>

</td><td>

[DateType](./core-types.datetype.md)

</td><td>

**_(BETA)_** _(Optional)_

</td></tr>
<tr><td>

[issuer](./core-types.credentialpayload.issuer.md)

</td><td>

</td><td>

[IssuerType](./core-types.issuertype.md)

</td><td>

**_(BETA)_**

</td></tr>
<tr><td>

[type?](./core-types.credentialpayload.type.md)

</td><td>

</td><td>

string\[\]

</td><td>

**_(BETA)_** _(Optional)_

</td></tr>
</tbody></table>
2 changes: 1 addition & 1 deletion docs/api/core-types.credentialstatus.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ hide_title: true

Represents the result of a status check.

Implementations MUST populate the `revoked` boolean property, but they can return additional metadata that is method specific.
Implementations MUST populate the `revoked` boolean property, but they can return additional metadata that is method-specific.

**Signature:**

Expand Down
36 changes: 33 additions & 3 deletions docs/api/core-types.credentialstatusgenerateargs.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,36 @@ export interface CredentialStatusGenerateArgs

## Properties

| Property | Modifiers | Type | Description |
| --------------------------------------------------------- | --------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------- |
| [type](./core-types.credentialstatusgenerateargs.type.md) | | string | **_(BETA)_** The credential status type (aka credential status method) to be used in the <code>credentialStatus</code> generation. |
<table><thead><tr><th>

Property

</th><th>

Modifiers

</th><th>

Type

</th><th>

Description

</th></tr></thead>
<tbody><tr><td>

[type](./core-types.credentialstatusgenerateargs.type.md)

</td><td>

</td><td>

string

</td><td>

**_(BETA)_** The credential status type (aka credential status method) to be used in the `credentialStatus` generation.

</td></tr>
</tbody></table>
Loading