Skip to content

Commit

Permalink
update(docs)
Browse files Browse the repository at this point in the history
  • Loading branch information
pragmatos committed Jan 28, 2023
1 parent 1f13a6f commit c9aa2d7
Show file tree
Hide file tree
Showing 284 changed files with 14,567 additions and 0 deletions.
21 changes: 21 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.idea
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Website

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

### Installation

```
$ yarn
```

### Local Development

```
$ yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

Using SSH:

```
$ USE_SSH=true yarn deploy
```

Not using SSH:

```
$ GIT_USER=<Your GitHub username> yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
3 changes: 3 additions & 0 deletions babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};
15 changes: 15 additions & 0 deletions docs/api/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
id: index
title: API Reference
hide_title: true
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->


## API Reference

## Packages

| Package | Description |
| --- | --- |
| [@iden3/polygonid-js-sdk](./polygonid-js-sdk.md) | |
27 changes: 27 additions & 0 deletions docs/api/polygonid-js-sdk.abstractprivatekeystore.get.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
id: polygonid-js-sdk.abstractprivatekeystore.get
title: AbstractPrivateKeyStore.get() method
hide_title: true
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->


## AbstractPrivateKeyStore.get() method

<b>Signature:</b>

```typescript
abstract get(args: {
alias: string;
}): Promise<string>;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| args | { alias: string; } | |

<b>Returns:</b>

Promise&lt;string&gt;
28 changes: 28 additions & 0 deletions docs/api/polygonid-js-sdk.abstractprivatekeystore.import.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
id: polygonid-js-sdk.abstractprivatekeystore.import
title: AbstractPrivateKeyStore.import() method
hide_title: true
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->


## AbstractPrivateKeyStore.import() method

<b>Signature:</b>

```typescript
abstract import(args: {
alias: string;
key: string;
}): Promise<void>;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| args | { alias: string; key: string; } | |

<b>Returns:</b>

Promise&lt;void&gt;
22 changes: 22 additions & 0 deletions docs/api/polygonid-js-sdk.abstractprivatekeystore.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
id: polygonid-js-sdk.abstractprivatekeystore
title: AbstractPrivateKeyStore class
hide_title: true
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->


## AbstractPrivateKeyStore class

<b>Signature:</b>

```typescript
export declare abstract class AbstractPrivateKeyStore
```

## Methods

| Method | Modifiers | Description |
| --- | --- | --- |
| [get(args)](./polygonid-js-sdk.abstractprivatekeystore.get.md) | <code>abstract</code> | |
| [import(args)](./polygonid-js-sdk.abstractprivatekeystore.import.md) | <code>abstract</code> | |
24 changes: 24 additions & 0 deletions docs/api/polygonid-js-sdk.authhandler._constructor_.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
id: polygonid-js-sdk.authhandler._constructor_
title: AuthHandler.(constructor)
hide_title: true
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->


## AuthHandler.(constructor)

Constructs a new instance of the `AuthHandler` class

<b>Signature:</b>

```typescript
constructor(_packerMgr: IPackageManger, _proofService: IProofService);
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| \_packerMgr | IPackageManger | |
| \_proofService | IProofService | |
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
id: polygonid-js-sdk.authhandler.handleauthorizationrequest
title: AuthHandler.handleAuthorizationRequest() method
hide_title: true
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->


## AuthHandler.handleAuthorizationRequest() method

<b>Signature:</b>

```typescript
handleAuthorizationRequest(did: DID, request: Uint8Array): Promise<{
token: string;
authRequest: AuthorizationRequestMessage;
authResponse: AuthorizationResponseMessage;
}>;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| did | DID | |
| request | Uint8Array | |

<b>Returns:</b>

Promise&lt;{ token: string; authRequest: AuthorizationRequestMessage; authResponse: AuthorizationResponseMessage; }&gt;
28 changes: 28 additions & 0 deletions docs/api/polygonid-js-sdk.authhandler.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
id: polygonid-js-sdk.authhandler
title: AuthHandler class
hide_title: true
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->


## AuthHandler class

<b>Signature:</b>

```typescript
export declare class AuthHandler implements IAuthHandler
```
<b>Implements:</b> [IAuthHandler](./polygonid-js-sdk.iauthhandler.md)
## Constructors
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(\_packerMgr, \_proofService)](./polygonid-js-sdk.authhandler._constructor_.md) | | Constructs a new instance of the <code>AuthHandler</code> class |
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
| [handleAuthorizationRequest(did, request)](./polygonid-js-sdk.authhandler.handleauthorizationrequest.md) | | |
24 changes: 24 additions & 0 deletions docs/api/polygonid-js-sdk.bjjprovider._constructor_.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
id: polygonid-js-sdk.bjjprovider._constructor_
title: BjjProvider.(constructor)
hide_title: true
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->


## BjjProvider.(constructor)

Constructs a new instance of the `BjjProvider` class

<b>Signature:</b>

```typescript
constructor(keyType: KmsKeyType, keyStore: AbstractPrivateKeyStore);
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| keyType | [KmsKeyType](./polygonid-js-sdk.kmskeytype.md) | |
| keyStore | [AbstractPrivateKeyStore](./polygonid-js-sdk.abstractprivatekeystore.md) | |
15 changes: 15 additions & 0 deletions docs/api/polygonid-js-sdk.bjjprovider.keytype.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
id: polygonid-js-sdk.bjjprovider.keytype
title: BjjProvider.keyType property
hide_title: true
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->


## BjjProvider.keyType property

<b>Signature:</b>

```typescript
keyType: KmsKeyType;
```
36 changes: 36 additions & 0 deletions docs/api/polygonid-js-sdk.bjjprovider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
id: polygonid-js-sdk.bjjprovider
title: BjjProvider class
hide_title: true
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->


## BjjProvider class

<b>Signature:</b>

```typescript
export declare class BjjProvider implements IKeyProvider
```
<b>Implements:</b> [IKeyProvider](./polygonid-js-sdk.ikeyprovider.md)
## Constructors
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(keyType, keyStore)](./polygonid-js-sdk.bjjprovider._constructor_.md) | | Constructs a new instance of the <code>BjjProvider</code> class |
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [keyType](./polygonid-js-sdk.bjjprovider.keytype.md) | | [KmsKeyType](./polygonid-js-sdk.kmskeytype.md) | |
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
| [newPrivateKeyFromSeed(key)](./polygonid-js-sdk.bjjprovider.newprivatekeyfromseed.md) | | |
| [publicKey(keyId)](./polygonid-js-sdk.bjjprovider.publickey.md) | | |
| [sign(keyId, data)](./polygonid-js-sdk.bjjprovider.sign.md) | | |
25 changes: 25 additions & 0 deletions docs/api/polygonid-js-sdk.bjjprovider.newprivatekeyfromseed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
id: polygonid-js-sdk.bjjprovider.newprivatekeyfromseed
title: BjjProvider.newPrivateKeyFromSeed() method
hide_title: true
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->


## BjjProvider.newPrivateKeyFromSeed() method

<b>Signature:</b>

```typescript
newPrivateKeyFromSeed(key: Uint8Array): Promise<KmsKeyId>;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| key | Uint8Array | |

<b>Returns:</b>

Promise&lt;[KmsKeyId](./polygonid-js-sdk.kmskeyid.md)&gt;
25 changes: 25 additions & 0 deletions docs/api/polygonid-js-sdk.bjjprovider.publickey.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
id: polygonid-js-sdk.bjjprovider.publickey
title: BjjProvider.publicKey() method
hide_title: true
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->


## BjjProvider.publicKey() method

<b>Signature:</b>

```typescript
publicKey(keyId: KmsKeyId): Promise<PublicKey>;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| keyId | [KmsKeyId](./polygonid-js-sdk.kmskeyid.md) | |

<b>Returns:</b>

Promise&lt;PublicKey&gt;
Loading

0 comments on commit c9aa2d7

Please sign in to comment.