[Docs] Update API reference

FoalTS · Dec 5, 2019 · 7355068 · 7355068
1 parent 145b6b0
commit 7355068
Show file tree

Hide file tree

Showing 14 changed files with 96 additions and 78 deletions.
diff --git a/docs/api/social/classes/_abstract_provider_service_.abstractprovider.md b/docs/api/social/classes/_abstract_provider_service_.abstractprovider.md
@@ -58,7 +58,7 @@ Abstract class that any social provider must inherit from.
 
 **● authEndpoint**: *`string`*
 
-*Defined in [abstract-provider.service.ts:117](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L117)*
+*Defined in [abstract-provider.service.ts:133](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L133)*
 
 URL of the authorization endpoint from which we retrieve an authorization code.
 
@@ -75,7 +75,7 @@ ___
 
 **● configInstance**: *`Config`*
 
-*Defined in [abstract-provider.service.ts:90](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L90)*
+*Defined in [abstract-provider.service.ts:106](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L106)*
 
 ___
 <a id="configpaths"></a>
@@ -84,7 +84,7 @@ ___
 
 **● configPaths**: *`object`*
 
-*Defined in [abstract-provider.service.ts:104](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L104)*
+*Defined in [abstract-provider.service.ts:120](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L120)*
 
 Configuration paths from which the client ID, client secret and redirect URI must be retrieved.
 
@@ -109,7 +109,7 @@ ___
 
 **● defaultScopes**: *`string`[]* =  []
 
-*Defined in [abstract-provider.service.ts:135](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L135)*
+*Defined in [abstract-provider.service.ts:151](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L151)*
 
 Default scopes requested by the social provider.
 
@@ -124,7 +124,7 @@ ___
 
 **● scopeSeparator**: *`string`* = " "
 
-*Defined in [abstract-provider.service.ts:144](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L144)*
+*Defined in [abstract-provider.service.ts:160](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L160)*
 
 Character used to separate the scopes in the URL.
 
@@ -139,7 +139,7 @@ ___
 
 **● tokenEndpoint**: *`string`*
 
-*Defined in [abstract-provider.service.ts:126](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L126)*
+*Defined in [abstract-provider.service.ts:142](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L142)*
 
 URL of the token endpoint from which we retrieve an access token.
 
@@ -159,7 +159,7 @@ ___
 
 **get config**(): `object`
 
-*Defined in [abstract-provider.service.ts:146](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L146)*
+*Defined in [abstract-provider.service.ts:162](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L162)*
 
 **Returns:** `object`
 
@@ -173,7 +173,7 @@ ___
 
 ▸ **getState**(): `Promise`<`string`>
 
-*Defined in [abstract-provider.service.ts:268](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L268)*
+*Defined in [abstract-provider.service.ts:284](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L284)*
 
 **Returns:** `Promise`<`string`>
 
@@ -184,7 +184,7 @@ ___
 
 ▸ **getTokens**(ctx: *`Context`*): `Promise`<[SocialTokens](../interfaces/_abstract_provider_service_.socialtokens.md)>
 
-*Defined in [abstract-provider.service.ts:219](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L219)*
+*Defined in [abstract-provider.service.ts:235](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L235)*
 
 Function to use in the controller method that handles the provider redirection.
 
@@ -208,7 +208,7 @@ ___
 
 ▸ **getUserInfo**<`UserInfo`>(ctx: *`Context`*, params?: *[UserInfoParameters]()*): `Promise`<[UserInfoAndTokens](../interfaces/_abstract_provider_service_.userinfoandtokens.md)<`UserInfo`>>
 
-*Defined in [abstract-provider.service.ts:262](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L262)*
+*Defined in [abstract-provider.service.ts:278](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L278)*
 
 Function to use in the controller method that handles the provider redirection.
 
@@ -238,7 +238,7 @@ ___
 
 ▸ **getUserInfoFromTokens**(tokens: *[SocialTokens](../interfaces/_abstract_provider_service_.socialtokens.md)*, params?: *[UserInfoParameters]()*): `any`
 
-*Defined in [abstract-provider.service.ts:165](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L165)*
+*Defined in [abstract-provider.service.ts:181](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L181)*
 
 Retrieve user information from the tokens returned by the authorization server.
 
@@ -265,7 +265,7 @@ ___
 
 ▸ **redirect**(__namedParameters?: *`object`*, params?: *[AuthParameters]()*): `Promise`<`HttpResponseRedirect`>
 
-*Defined in [abstract-provider.service.ts:175](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L175)*
+*Defined in [abstract-provider.service.ts:191](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L191)*
 
 Returns an HttpResponseRedirect object to use to redirect the user to the social provider's authorization page.
 

diff --git a/docs/api/social/classes/_abstract_provider_service_.authorizationerror.md b/docs/api/social/classes/_abstract_provider_service_.authorizationerror.md
@@ -42,7 +42,7 @@ Error thrown if the authorization server returns an error.
 
 ⊕ **new AuthorizationError**(error: *`string`*, errorDescription?: *`undefined` \| `string`*, errorUri?: *`undefined` \| `string`*): [AuthorizationError](_abstract_provider_service_.authorizationerror.md)
 
-*Defined in [abstract-provider.service.ts:50](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L50)*
+*Defined in [abstract-provider.service.ts:56](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L56)*
 
 **Parameters:**
 
@@ -64,7 +64,7 @@ ___
 
 **● error**: *`string`*
 
-*Defined in [abstract-provider.service.ts:52](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L52)*
+*Defined in [abstract-provider.service.ts:58](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L58)*
 
 ___
 <a id="errordescription"></a>
@@ -73,7 +73,7 @@ ___
 
 **● errorDescription**: *`undefined` \| `string`*
 
-*Defined in [abstract-provider.service.ts:53](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L53)*
+*Defined in [abstract-provider.service.ts:59](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L59)*
 
 ___
 <a id="erroruri"></a>
@@ -82,7 +82,7 @@ ___
 
 **● errorUri**: *`undefined` \| `string`*
 
-*Defined in [abstract-provider.service.ts:54](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L54)*
+*Defined in [abstract-provider.service.ts:60](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L60)*
 
 ___
 <a id="message"></a>
@@ -100,11 +100,11 @@ ___
 
 ###  name
 
-**● name**: *`string`*
+**● name**: *"AuthorizationError"* = "AuthorizationError"
 
-*Inherited from Error.name*
+*Overrides Error.name*
 
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/social/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:963*
+*Defined in [abstract-provider.service.ts:56](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L56)*
 
 ___
 <a id="stack"></a>

diff --git a/docs/api/social/classes/_abstract_provider_service_.invalidstateerror.md b/docs/api/social/classes/_abstract_provider_service_.invalidstateerror.md
@@ -18,6 +18,10 @@ Error thrown if the state does not match.
 
 ## Index
 
+### Constructors
+
+* [constructor](_abstract_provider_service_.invalidstateerror.md#constructor)
+
 ### Properties
 
 * [message](_abstract_provider_service_.invalidstateerror.md#message)
@@ -27,6 +31,20 @@ Error thrown if the state does not match.
 
 ---
 
+## Constructors
+
+<a id="constructor"></a>
+
+###  constructor
+
+⊕ **new InvalidStateError**(): [InvalidStateError](_abstract_provider_service_.invalidstateerror.md)
+
+*Defined in [abstract-provider.service.ts:42](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L42)*
+
+**Returns:** [InvalidStateError](_abstract_provider_service_.invalidstateerror.md)
+
+___
+
 ## Properties
 
 <a id="message"></a>
@@ -44,11 +62,11 @@ ___
 
 ###  name
 
-**● name**: *`string`*
+**● name**: *"InvalidStateError"* = "InvalidStateError"
 
-*Inherited from Error.name*
+*Overrides Error.name*
 
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/social/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:963*
+*Defined in [abstract-provider.service.ts:42](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L42)*
 
 ___
 <a id="stack"></a>

diff --git a/docs/api/social/classes/_abstract_provider_service_.tokenerror.md b/docs/api/social/classes/_abstract_provider_service_.tokenerror.md
@@ -40,7 +40,7 @@ Error thrown if the token endpoint does not return a 2xx response.
 
 ⊕ **new TokenError**(error: *`any`*): [TokenError](_abstract_provider_service_.tokenerror.md)
 
-*Defined in [abstract-provider.service.ts:67](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L67)*
+*Defined in [abstract-provider.service.ts:79](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L79)*
 
 **Parameters:**
 
@@ -60,7 +60,7 @@ ___
 
 **● error**: *`any`*
 
-*Defined in [abstract-provider.service.ts:68](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L68)*
+*Defined in [abstract-provider.service.ts:81](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L81)*
 
 ___
 <a id="message"></a>
@@ -78,11 +78,11 @@ ___
 
 ###  name
 
-**● name**: *`string`*
+**● name**: *"TokenError"* = "TokenError"
 
-*Inherited from Error.name*
+*Overrides Error.name*
 
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/social/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:963*
+*Defined in [abstract-provider.service.ts:79](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L79)*
 
 ___
 <a id="stack"></a>

diff --git a/docs/api/social/classes/_facebook_provider_service_.facebookprovider.md b/docs/api/social/classes/_facebook_provider_service_.facebookprovider.md
@@ -51,7 +51,7 @@ Facebook social provider.
 
 *Overrides [AbstractProvider](_abstract_provider_service_.abstractprovider.md).[authEndpoint](_abstract_provider_service_.abstractprovider.md#authendpoint)*
 
-*Defined in [facebook-provider.service.ts:38](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/facebook-provider.service.ts#L38)*
+*Defined in [facebook-provider.service.ts:43](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/facebook-provider.service.ts#L43)*
 
 ___
 <a id="configinstance"></a>
@@ -62,7 +62,7 @@ ___
 
 *Inherited from [AbstractProvider](_abstract_provider_service_.abstractprovider.md).[configInstance](_abstract_provider_service_.abstractprovider.md#configinstance)*
 
-*Defined in [abstract-provider.service.ts:90](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L90)*
+*Defined in [abstract-provider.service.ts:106](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L106)*
 
 ___
 <a id="defaultscopes"></a>
@@ -73,7 +73,7 @@ ___
 
 *Overrides [AbstractProvider](_abstract_provider_service_.abstractprovider.md).[defaultScopes](_abstract_provider_service_.abstractprovider.md#defaultscopes)*
 
-*Defined in [facebook-provider.service.ts:44](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/facebook-provider.service.ts#L44)*
+*Defined in [facebook-provider.service.ts:49](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/facebook-provider.service.ts#L49)*
 
 ___
 <a id="fields"></a>
@@ -82,7 +82,7 @@ ___
 
 **● fields**: *`string`[]* =  [ 'id', 'name', 'email' ]
 
-*Defined in [facebook-provider.service.ts:42](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/facebook-provider.service.ts#L42)*
+*Defined in [facebook-provider.service.ts:47](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/facebook-provider.service.ts#L47)*
 
 ___
 <a id="scopeseparator"></a>
@@ -93,7 +93,7 @@ ___
 
 *Inherited from [AbstractProvider](_abstract_provider_service_.abstractprovider.md).[scopeSeparator](_abstract_provider_service_.abstractprovider.md#scopeseparator)*
 
-*Defined in [abstract-provider.service.ts:144](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L144)*
+*Defined in [abstract-provider.service.ts:160](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L160)*
 
 Character used to separate the scopes in the URL.
 
@@ -110,7 +110,7 @@ ___
 
 *Overrides [AbstractProvider](_abstract_provider_service_.abstractprovider.md).[tokenEndpoint](_abstract_provider_service_.abstractprovider.md#tokenendpoint)*
 
-*Defined in [facebook-provider.service.ts:39](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/facebook-provider.service.ts#L39)*
+*Defined in [facebook-provider.service.ts:44](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/facebook-provider.service.ts#L44)*
 
 ___
 <a id="userinfoendpoint"></a>
@@ -119,7 +119,7 @@ ___
 
 **● userInfoEndpoint**: *`string`* = "https://graph.facebook.com/v5.0/me"
 
-*Defined in [facebook-provider.service.ts:40](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/facebook-provider.service.ts#L40)*
+*Defined in [facebook-provider.service.ts:45](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/facebook-provider.service.ts#L45)*
 
 ___
 
@@ -133,7 +133,7 @@ ___
 
 *Inherited from [AbstractProvider](_abstract_provider_service_.abstractprovider.md).[getTokens](_abstract_provider_service_.abstractprovider.md#gettokens)*
 
-*Defined in [abstract-provider.service.ts:219](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L219)*
+*Defined in [abstract-provider.service.ts:235](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L235)*
 
 Function to use in the controller method that handles the provider redirection.
 
@@ -159,7 +159,7 @@ ___
 
 *Inherited from [AbstractProvider](_abstract_provider_service_.abstractprovider.md).[getUserInfo](_abstract_provider_service_.abstractprovider.md#getuserinfo)*
 
-*Defined in [abstract-provider.service.ts:262](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L262)*
+*Defined in [abstract-provider.service.ts:278](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L278)*
 
 Function to use in the controller method that handles the provider redirection.
 
@@ -191,7 +191,7 @@ ___
 
 *Overrides [AbstractProvider](_abstract_provider_service_.abstractprovider.md).[getUserInfoFromTokens](_abstract_provider_service_.abstractprovider.md#getuserinfofromtokens)*
 
-*Defined in [facebook-provider.service.ts:46](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/facebook-provider.service.ts#L46)*
+*Defined in [facebook-provider.service.ts:51](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/facebook-provider.service.ts#L51)*
 
 **Parameters:**
 
@@ -211,7 +211,7 @@ ___
 
 *Inherited from [AbstractProvider](_abstract_provider_service_.abstractprovider.md).[redirect](_abstract_provider_service_.abstractprovider.md#redirect)*
 
-*Defined in [abstract-provider.service.ts:175](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/abstract-provider.service.ts#L175)*
+*Defined in [abstract-provider.service.ts:191](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/abstract-provider.service.ts#L191)*
 
 Returns an HttpResponseRedirect object to use to redirect the user to the social provider's authorization page.
 
@@ -242,15 +242,15 @@ ___
 
 *Overrides [AbstractProvider](_abstract_provider_service_.abstractprovider.md).[configPaths](_abstract_provider_service_.abstractprovider.md#configpaths)*
 
-*Defined in [facebook-provider.service.ts:32](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/facebook-provider.service.ts#L32)*
+*Defined in [facebook-provider.service.ts:37](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/facebook-provider.service.ts#L37)*
 
 <a id="configpaths.clientid"></a>
 
 ####  clientId
 
 **● clientId**: *`string`* = "settings.social.facebook.clientId"
 
-*Defined in [facebook-provider.service.ts:33](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/facebook-provider.service.ts#L33)*
+*Defined in [facebook-provider.service.ts:38](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/facebook-provider.service.ts#L38)*
 
 ___
 <a id="configpaths.clientsecret"></a>
@@ -259,7 +259,7 @@ ___
 
 **● clientSecret**: *`string`* = "settings.social.facebook.clientSecret"
 
-*Defined in [facebook-provider.service.ts:34](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/facebook-provider.service.ts#L34)*
+*Defined in [facebook-provider.service.ts:39](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/facebook-provider.service.ts#L39)*
 
 ___
 <a id="configpaths.redirecturi"></a>
@@ -268,7 +268,7 @@ ___
 
 **● redirectUri**: *`string`* = "settings.social.facebook.redirectUri"
 
-*Defined in [facebook-provider.service.ts:35](https://github.com/FoalTS/foal/blob/70cc46bd/packages/social/src/facebook-provider.service.ts#L35)*
+*Defined in [facebook-provider.service.ts:40](https://github.com/FoalTS/foal/blob/145b6b04/packages/social/src/facebook-provider.service.ts#L40)*
 
 ___