update docs

masa-finance · Nov 18, 2022 · 153348f · 153348f
1 parent d4bdf53
commit 153348f
Show file tree

Hide file tree

Showing 20 changed files with 80 additions and 22 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [v0.5.3](https://github.com/masa-finance/masa-sdk/compare/v0.5.2...v0.5.3)
+
+> 18 November 2022
+
+- update docs [`bec71c8`](https://github.com/masa-finance/masa-sdk/commit/bec71c8820393d7acfada9abf495de4890cd9e8e)
+- properly type session [`4135a14`](https://github.com/masa-finance/masa-sdk/commit/4135a1468d43d1b17ee6de4768ef20a8a6779f65)
+- fix env [`0a7e922`](https://github.com/masa-finance/masa-sdk/commit/0a7e922539599c20902dcc0392f47e933cb235be)
+
 #### [v0.5.2](https://github.com/masa-finance/masa-sdk/compare/v0.5.1...v0.5.2)
 
 > 16 November 2022

diff --git a/docs/README.md b/docs/README.md
@@ -1,5 +1,5 @@
 # Masa SDK
- - v0.5.2 / [Exports](modules.md)
+ - v0.5.3 / [Exports](modules.md)
 
 ---
 

diff --git a/docs/classes/Masa.md b/docs/classes/Masa.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.5.2](../README.md) / [Exports](../modules.md) / Masa
+ - v0.5.3](../README.md) / [Exports](../modules.md) / Masa
 
 # Class: Masa
 
@@ -128,7 +128,7 @@ ___
 | Name | Type |
 | :------ | :------ |
 | `checkLogin` | () => `Promise`<`boolean`\> |
-| `getSession` | () => `Promise`<`any`\> |
+| `getSession` | () => `Promise`<`undefined` \| [`ISession`](../interfaces/ISession.md)\> |
 | `login` | () => `Promise`<`undefined` \| { `address`: `string` ; `cookie`: `string` ; `userId`: `string` \| `BigNumber`  }\> |
 | `logout` | () => `Promise`<`undefined` \| { `status`: `string`  }\> |
 | `sessionLogout` | () => `Promise`<`undefined` \| { `status`: `string`  }\> |

diff --git a/docs/classes/MasaClient.md b/docs/classes/MasaClient.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.5.2](../README.md) / [Exports](../modules.md) / MasaClient
+ - v0.5.3](../README.md) / [Exports](../modules.md) / MasaClient
 
 # Class: MasaClient
 
@@ -117,11 +117,11 @@ ___
 
 ### sessionCheck
 
-▸ **sessionCheck**(): `Promise`<`any`\>
+▸ **sessionCheck**(): `Promise`<`undefined` \| [`ISession`](../interfaces/ISession.md)\>
 
 #### Returns
 
-`Promise`<`any`\>
+`Promise`<`undefined` \| [`ISession`](../interfaces/ISession.md)\>
 
 ___
 

diff --git a/docs/classes/MasaContracts.md b/docs/classes/MasaContracts.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.5.2](../README.md) / [Exports](../modules.md) / MasaContracts
+ - v0.5.3](../README.md) / [Exports](../modules.md) / MasaContracts
 
 # Class: MasaContracts
 

diff --git a/docs/interfaces/Addresses.md b/docs/interfaces/Addresses.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.5.2](../README.md) / [Exports](../modules.md) / Addresses
+ - v0.5.3](../README.md) / [Exports](../modules.md) / Addresses
 
 # Interface: Addresses
 

diff --git a/docs/interfaces/Attribute.md b/docs/interfaces/Attribute.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.5.2](../README.md) / [Exports](../modules.md) / Attribute
+ - v0.5.3](../README.md) / [Exports](../modules.md) / Attribute
 
 # Interface: Attribute
 

diff --git a/docs/interfaces/BaseResult.md b/docs/interfaces/BaseResult.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.5.2](../README.md) / [Exports](../modules.md) / BaseResult
+ - v0.5.3](../README.md) / [Exports](../modules.md) / BaseResult
 
 # Interface: BaseResult
 

diff --git a/docs/interfaces/Create2FAResult.md b/docs/interfaces/Create2FAResult.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.5.2](../README.md) / [Exports](../modules.md) / Create2FAResult
+ - v0.5.3](../README.md) / [Exports](../modules.md) / Create2FAResult
 
 # Interface: Create2FAResult
 

diff --git a/docs/interfaces/CreateSoulNameResult.md b/docs/interfaces/CreateSoulNameResult.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.5.2](../README.md) / [Exports](../modules.md) / CreateSoulNameResult
+ - v0.5.3](../README.md) / [Exports](../modules.md) / CreateSoulNameResult
 
 # Interface: CreateSoulNameResult
 

diff --git a/docs/interfaces/I2fa.md b/docs/interfaces/I2fa.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.5.2](../README.md) / [Exports](../modules.md) / I2FA
+ - v0.5.3](../README.md) / [Exports](../modules.md) / I2FA
 
 # Interface: I2FA
 

diff --git a/docs/interfaces/ICreditScore.md b/docs/interfaces/ICreditScore.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.5.2](../README.md) / [Exports](../modules.md) / ICreditScore
+ - v0.5.3](../README.md) / [Exports](../modules.md) / ICreditScore
 
 # Interface: ICreditScore
 

diff --git a/docs/interfaces/IIdentity.md b/docs/interfaces/IIdentity.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.5.2](../README.md) / [Exports](../modules.md) / IIdentity
+ - v0.5.3](../README.md) / [Exports](../modules.md) / IIdentity
 
 # Interface: IIdentity
 

diff --git a/docs/interfaces/IIdentityContracts.md b/docs/interfaces/IIdentityContracts.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.5.2](../README.md) / [Exports](../modules.md) / IIdentityContracts
+ - v0.5.3](../README.md) / [Exports](../modules.md) / IIdentityContracts
 
 # Interface: IIdentityContracts
 

diff --git a/docs/interfaces/ISession.md b/docs/interfaces/ISession.md
@@ -0,0 +1,49 @@
+[# Masa SDK
+ - v0.5.3](../README.md) / [Exports](../modules.md) / ISession
+
+# Interface: ISession
+
+## Table of contents
+
+### Properties
+
+- [challenge](ISession.md#challenge)
+- [cookie](ISession.md#cookie)
+- [user](ISession.md#user)
+
+## Properties
+
+### challenge
+
+• **challenge**: `string`
+
+___
+
+### cookie
+
+• **cookie**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `domain` | `string` |
+| `expires` | `string` |
+| `httpOnly` | `boolean` |
+| `originalMaxAge` | `number` |
+| `path` | `string` |
+| `sameSite` | `string` |
+| `secure` | `boolean` |
+
+___
+
+### user
+
+• **user**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `address` | `string` |
+| `userId` | `string` |
diff --git a/docs/interfaces/ISoulName.md b/docs/interfaces/ISoulName.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.5.2](../README.md) / [Exports](../modules.md) / ISoulName
+ - v0.5.3](../README.md) / [Exports](../modules.md) / ISoulName
 
 # Interface: ISoulName
 

diff --git a/docs/interfaces/LoadContractArgs.md b/docs/interfaces/LoadContractArgs.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.5.2](../README.md) / [Exports](../modules.md) / LoadContractArgs
+ - v0.5.3](../README.md) / [Exports](../modules.md) / LoadContractArgs
 
 # Interface: LoadContractArgs
 

diff --git a/docs/interfaces/MasaArgs.md b/docs/interfaces/MasaArgs.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.5.2](../README.md) / [Exports](../modules.md) / MasaArgs
+ - v0.5.3](../README.md) / [Exports](../modules.md) / MasaArgs
 
 # Interface: MasaArgs
 

diff --git a/docs/interfaces/MasaConfig.md b/docs/interfaces/MasaConfig.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.5.2](../README.md) / [Exports](../modules.md) / MasaConfig
+ - v0.5.3](../README.md) / [Exports](../modules.md) / MasaConfig
 
 # Interface: MasaConfig
 

diff --git a/docs/modules.md b/docs/modules.md
@@ -1,8 +1,8 @@
 [# Masa SDK
- - v0.5.2](README.md) / Exports
+ - v0.5.3](README.md) / Exports
 
 # # Masa SDK
- - v0.5.2
+ - v0.5.3
 
 ## Table of contents
 
@@ -23,6 +23,7 @@
 - [ICreditScore](interfaces/ICreditScore.md)
 - [IIdentity](interfaces/IIdentity.md)
 - [IIdentityContracts](interfaces/IIdentityContracts.md)
+- [ISession](interfaces/ISession.md)
 - [ISoulName](interfaces/ISoulName.md)
 - [LoadContractArgs](interfaces/LoadContractArgs.md)
 - [MasaArgs](interfaces/MasaArgs.md)