npm - @inrupt/solid-client-authn-browser - Versions diffs - 1.11.9-alpha.0 → 1.11.9-alpha.3 - Mend

@inrupt/solid-client-authn-browser 1.11.9-alpha.0 → 1.11.9-alpha.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (262) hide show

package/docs/api/build/source/classes/Session.md DELETED Viewed

@@ -1,907 +0,0 @@
-[@inrupt/solid-client-authn-browser](../index.md) / Session
-# Class: Session
-A [Session](Session.md) object represents a user's session on an application. The session holds state, as it stores information enabling acces to private resources after login for instance.
-## Hierarchy
-- `EventEmitter`
-  ↳ **`Session`**
-## Table of contents
-### Constructors
-- [constructor](Session.html#constructor)
-### Properties
-- [clientAuthentication](Session.html#clientauthentication)
-- [info](Session.html#info)
-- [tmpFetchWithCookies](Session.html#tmpfetchwithcookies)
-- [tokenRequestInProgress](Session.html#tokenrequestinprogress)
-- [captureRejectionSymbol](Session.html#capturerejectionsymbol)
-- [captureRejections](Session.html#capturerejections)
-- [defaultMaxListeners](Session.html#defaultmaxlisteners)
-- [errorMonitor](Session.html#errormonitor)
-### Methods
-- [addListener](Session.html#addlistener)
-- [emit](Session.html#emit)
-- [eventNames](Session.html#eventnames)
-- [fetch](Session.html#fetch)
-- [getMaxListeners](Session.html#getmaxlisteners)
-- [handleIncomingRedirect](Session.html#handleincomingredirect)
-- [listenerCount](Session.html#listenercount)
-- [listeners](Session.html#listeners)
-- [login](Session.html#login)
-- [logout](Session.html#logout)
-- [off](Session.html#off)
-- [on](Session.html#on)
-- [onError](Session.html#onerror)
-- [onLogin](Session.html#onlogin)
-- [onLogout](Session.html#onlogout)
-- [onSessionExpiration](Session.html#onsessionexpiration)
-- [onSessionRestore](Session.html#onsessionrestore)
-- [once](Session.html#once)
-- [prependListener](Session.html#prependlistener)
-- [prependOnceListener](Session.html#prependoncelistener)
-- [rawListeners](Session.html#rawlisteners)
-- [removeAllListeners](Session.html#removealllisteners)
-- [removeListener](Session.html#removelistener)
-- [setMaxListeners](Session.html#setmaxlisteners)
-- [setSessionInfo](Session.html#setsessioninfo)
-- [getEventListener](Session.html#geteventlistener)
-- [listenerCount](Session.html#listenercount)
-- [on](Session.html#on)
-- [once](Session.html#once)
-## Constructors
-### constructor
-• **new Session**(`sessionOptions?`, `sessionId?`)
-Session object constructor. Typically called as follows:
-```typescript
-const session = new Session();
-```
-See also [getDefaultSession](https://docs.inrupt.com/developer-tools/api/javascript/solid-client-authn-browser/functions.html#getdefaultsession).
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `sessionOptions` | `Partial`<[`ISessionOptions`](../interfaces/ISessionOptions.md)\> | The options enabling the correct instantiation of the session. Either both storages or clientAuthentication are required. For more information, see [ISessionOptions](../interfaces/ISessionOptions.md). |
-| `sessionId?` | `string` | A string uniquely identifying the session. |
-#### Overrides
-EventEmitter.constructor
-#### Defined in
-[browser/src/Session.ts:173](https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/Session.ts#L173)
-## Properties
-### clientAuthentication
-• `Private` **clientAuthentication**: `default`
-#### Defined in
-[browser/src/Session.ts:151](https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/Session.ts#L151)
-___
-### info
-• `Readonly` **info**: [`ISessionInfo`](../interfaces/ISessionInfo.md)
-Information regarding the current session.
-#### Defined in
-[browser/src/Session.ts:149](https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/Session.ts#L149)
-___
-### tmpFetchWithCookies
-• `Private` **tmpFetchWithCookies**: `boolean` = `false`
-#### Defined in
-[browser/src/Session.ts:156](https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/Session.ts#L156)
-___
-### tokenRequestInProgress
-• `Private` **tokenRequestInProgress**: `boolean` = `false`
-#### Defined in
-[browser/src/Session.ts:153](https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/Session.ts#L153)
-___
-### captureRejectionSymbol
-▪ `Static` `Readonly` **captureRejectionSymbol**: typeof [`captureRejectionSymbol`](Session.html#capturerejectionsymbol)
-#### Inherited from
-EventEmitter.captureRejectionSymbol
-#### Defined in
-browser/node_modules/@types/node/events.d.ts:46
-___
-### captureRejections
-▪ `Static` **captureRejections**: `boolean`
-Sets or gets the default captureRejection value for all emitters.
-#### Inherited from
-EventEmitter.captureRejections
-#### Defined in
-browser/node_modules/@types/node/events.d.ts:52
-___
-### defaultMaxListeners
-▪ `Static` **defaultMaxListeners**: `number`
-#### Inherited from
-EventEmitter.defaultMaxListeners
-#### Defined in
-browser/node_modules/@types/node/events.d.ts:53
-___
-### errorMonitor
-▪ `Static` `Readonly` **errorMonitor**: typeof [`errorMonitor`](Session.html#errormonitor)
-This symbol shall be used to install a listener for only monitoring `'error'`
-events. Listeners installed using this symbol are called before the regular
-`'error'` listeners are called.
-Installing a listener using this symbol does not change the behavior once an
-`'error'` event is emitted, therefore the process will still crash if no
-regular `'error'` listener is installed.
-#### Inherited from
-EventEmitter.errorMonitor
-#### Defined in
-browser/node_modules/@types/node/events.d.ts:45
-## Methods
-### addListener
-▸ **addListener**(`event`, `listener`): [`Session`](Session.md)
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `event` | `string` \| `symbol` |
-| `listener` | (...`args`: `any`[]) => `void` |
-#### Returns
-[`Session`](Session.md)
-#### Inherited from
-EventEmitter.addListener
-#### Defined in
-browser/node_modules/@types/node/events.d.ts:72
-___
-### emit
-▸ **emit**(`event`, ...`args`): `boolean`
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `event` | `string` \| `symbol` |
-| `...args` | `any`[] |
-#### Returns
-`boolean`
-#### Inherited from
-EventEmitter.emit
-#### Defined in
-browser/node_modules/@types/node/events.d.ts:82
-___
-### eventNames
-▸ **eventNames**(): (`string` \| `symbol`)[]
-#### Returns
-(`string` \| `symbol`)[]
-#### Inherited from
-EventEmitter.eventNames
-#### Defined in
-browser/node_modules/@types/node/events.d.ts:87
-___
-### fetch
-▸ **fetch**(`url`, `init?`): `Promise`<`Response`\>
-Fetches data using available login information. If the user is not logged in, this will behave as a regular `fetch`. The signature of this method is identical to the [canonical `fetch`](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API).
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `url` | `RequestInfo` | The URL from which data should be fetched. |
-| `init?` | `RequestInit` | Optional parameters customizing the request, by specifying an HTTP method, headers, a body, etc. Follows the [WHATWG Fetch Standard](https://fetch.spec.whatwg.org/). |
-#### Returns
-`Promise`<`Response`\>
-#### Defined in
-[browser/src/Session.ts:265](https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/Session.ts#L265)
-___
-### getMaxListeners
-▸ **getMaxListeners**(): `number`
-#### Returns
-`number`
-#### Inherited from
-EventEmitter.getMaxListeners
-#### Defined in
-browser/node_modules/@types/node/events.d.ts:79
-___
-### handleIncomingRedirect
-▸ **handleIncomingRedirect**(`inputOptions?`): `Promise`<`undefined` \| [`ISessionInfo`](../interfaces/ISessionInfo.md)\>
-Completes the login process by processing the information provided by the
-Solid identity provider through redirect.
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `inputOptions` | `string` \| `IHandleIncomingRedirectOptions` |
-#### Returns
-`Promise`<`undefined` \| [`ISessionInfo`](../interfaces/ISessionInfo.md)\>
-#### Defined in
-[browser/src/Session.ts:292](https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/Session.ts#L292)
-___
-### listenerCount
-▸ **listenerCount**(`event`): `number`
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `event` | `string` \| `symbol` |
-#### Returns
-`number`
-#### Inherited from
-EventEmitter.listenerCount
-#### Defined in
-browser/node_modules/@types/node/events.d.ts:83
-___
-### listeners
-▸ **listeners**(`event`): `Function`[]
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `event` | `string` \| `symbol` |
-#### Returns
-`Function`[]
-#### Inherited from
-EventEmitter.listeners
-#### Defined in
-browser/node_modules/@types/node/events.d.ts:80
-___
-### login
-▸ **login**(`options`): `Promise`<`void`\>
-Triggers the login process. Note that this method will redirect the user away from your app.
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `options` | [`ILoginInputOptions`](../interfaces/ILoginInputOptions.md) | Parameter to customize the login behaviour. In particular, two options are mandatory: `options.oidcIssuer`, the user's identity provider, and `options.redirectUrl`, the URL to which the user will be redirected after logging in their identity provider. |
-#### Returns
-`Promise`<`void`\>
-This method should redirect the user away from the app: it does not return anything. The login process is completed by [`handleIncomingRedirect`](Session.html#handleincomingredirect).
-#### Defined in
-[browser/src/Session.ts:242](https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/Session.ts#L242)
-___
-### logout
-▸ **logout**(): `Promise`<`void`\>
-Logs the user out of the application. This does not log the user out of their Solid identity provider, and should not redirect the user away.
-#### Returns
-`Promise`<`void`\>
-#### Defined in
-[browser/src/Session.ts:279](https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/Session.ts#L279)
-___
-### off
-▸ **off**(`event`, `listener`): [`Session`](Session.md)
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `event` | `string` \| `symbol` |
-| `listener` | (...`args`: `any`[]) => `void` |
-#### Returns
-[`Session`](Session.md)
-#### Inherited from
-EventEmitter.off
-#### Defined in
-browser/node_modules/@types/node/events.d.ts:76
-___
-### on
-▸ **on**(`event`, `listener`): [`Session`](Session.md)
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `event` | `string` \| `symbol` |
-| `listener` | (...`args`: `any`[]) => `void` |
-#### Returns
-[`Session`](Session.md)
-#### Inherited from
-EventEmitter.on
-#### Defined in
-browser/node_modules/@types/node/events.d.ts:73
-___
-### onError
-▸ **onError**(`callback`): `void`
-Register a callback function to be called when a user logs out:
-**`since`** 1.11.0
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `callback` | (`error`: ``null`` \| `string`, `errorDescription?`: ``null`` \| `string`) => `unknown` | The function called when an error occurs. |
-#### Returns
-`void`
-#### Defined in
-[browser/src/Session.ts:465](https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/Session.ts#L465)
-___
-### onLogin
-▸ **onLogin**(`callback`): `void`
-Register a callback function to be called when a user completes login.
-The callback is called when [handleIncomingRedirect](Session.html#handleincomingredirect) completes successfully.
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `callback` | () => `unknown` | The function called when a user completes login. |
-#### Returns
-`void`
-#### Defined in
-[browser/src/Session.ts:446](https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/Session.ts#L446)
-___
-### onLogout
-▸ **onLogout**(`callback`): `void`
-Register a callback function to be called when a user logs out:
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `callback` | () => `unknown` | The function called when a user completes logout. |
-#### Returns
-`void`
-#### Defined in
-[browser/src/Session.ts:455](https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/Session.ts#L455)
-___
-### onSessionExpiration
-▸ **onSessionExpiration**(`callback`): `void`
-Register a callback that runs when the session expires and can no longer
-make authenticated requests, but following a user logout.
-**`since`** 1.11.0
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `callback` | () => `unknown` | The function that runs on session expiration. |
-#### Returns
-`void`
-#### Defined in
-[browser/src/Session.ts:492](https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/Session.ts#L492)
-___
-### onSessionRestore
-▸ **onSessionRestore**(`callback`): `void`
-Register a callback function to be called when a session is restored.
-Note: the callback will be called with the saved value of the 'current URL'
-at the time the session was restored.
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `callback` | (`currentUrl`: `string`) => `unknown` | The function called when a user's already logged-in session is restored, e.g., after a silent authentication is completed after a page refresh. |
-#### Returns
-`void`
-#### Defined in
-[browser/src/Session.ts:482](https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/Session.ts#L482)
-___
-### once
-▸ **once**(`event`, `listener`): [`Session`](Session.md)
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `event` | `string` \| `symbol` |
-| `listener` | (...`args`: `any`[]) => `void` |
-#### Returns
-[`Session`](Session.md)
-#### Inherited from
-EventEmitter.once
-#### Defined in
-browser/node_modules/@types/node/events.d.ts:74
-___
-### prependListener
-▸ **prependListener**(`event`, `listener`): [`Session`](Session.md)
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `event` | `string` \| `symbol` |
-| `listener` | (...`args`: `any`[]) => `void` |
-#### Returns
-[`Session`](Session.md)
-#### Inherited from
-EventEmitter.prependListener
-#### Defined in
-browser/node_modules/@types/node/events.d.ts:85
-___
-### prependOnceListener
-▸ **prependOnceListener**(`event`, `listener`): [`Session`](Session.md)
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `event` | `string` \| `symbol` |
-| `listener` | (...`args`: `any`[]) => `void` |
-#### Returns
-[`Session`](Session.md)
-#### Inherited from
-EventEmitter.prependOnceListener
-#### Defined in
-browser/node_modules/@types/node/events.d.ts:86
-___
-### rawListeners
-▸ **rawListeners**(`event`): `Function`[]
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `event` | `string` \| `symbol` |
-#### Returns
-`Function`[]
-#### Inherited from
-EventEmitter.rawListeners
-#### Defined in
-browser/node_modules/@types/node/events.d.ts:81
-___
-### removeAllListeners
-▸ **removeAllListeners**(`event?`): [`Session`](Session.md)
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `event?` | `string` \| `symbol` |
-#### Returns
-[`Session`](Session.md)
-#### Inherited from
-EventEmitter.removeAllListeners
-#### Defined in
-browser/node_modules/@types/node/events.d.ts:77
-___
-### removeListener
-▸ **removeListener**(`event`, `listener`): [`Session`](Session.md)
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `event` | `string` \| `symbol` |
-| `listener` | (...`args`: `any`[]) => `void` |
-#### Returns
-[`Session`](Session.md)
-#### Inherited from
-EventEmitter.removeListener
-#### Defined in
-browser/node_modules/@types/node/events.d.ts:75
-___
-### setMaxListeners
-▸ **setMaxListeners**(`n`): [`Session`](Session.md)
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `n` | `number` |
-#### Returns
-[`Session`](Session.md)
-#### Inherited from
-EventEmitter.setMaxListeners
-#### Defined in
-browser/node_modules/@types/node/events.d.ts:78
-___
-### setSessionInfo
-▸ `Private` **setSessionInfo**(`sessionInfo`): `void`
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `sessionInfo` | [`ISessionInfo`](../interfaces/ISessionInfo.md) & { `isLoggedIn`: ``true``  } |
-#### Returns
-`void`
-#### Defined in
-[browser/src/Session.ts:496](https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/packages/browser/src/Session.ts#L496)
-___
-### getEventListener
-▸ `Static` **getEventListener**(`emitter`, `name`): `Function`[]
-Returns a list listener for a specific emitter event name.
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `emitter` | `DOMEventTarget` \| `EventEmitter` |
-| `name` | `string` \| `symbol` |
-#### Returns
-`Function`[]
-#### Inherited from
-EventEmitter.getEventListener
-#### Defined in
-browser/node_modules/@types/node/events.d.ts:34
-___
-### listenerCount
-▸ `Static` **listenerCount**(`emitter`, `event`): `number`
-**`deprecated`** since v4.0.0
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `emitter` | `EventEmitter` |
-| `event` | `string` \| `symbol` |
-#### Returns
-`number`
-#### Inherited from
-EventEmitter.listenerCount
-#### Defined in
-browser/node_modules/@types/node/events.d.ts:30
-___
-### on
-▸ `Static` **on**(`emitter`, `event`, `options?`): `AsyncIterableIterator`<`any`\>
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `emitter` | `EventEmitter` |
-| `event` | `string` |
-| `options?` | `StaticEventEmitterOptions` |
-#### Returns
-`AsyncIterableIterator`<`any`\>
-#### Inherited from
-EventEmitter.on
-#### Defined in
-browser/node_modules/@types/node/events.d.ts:27
-___
-### once
-▸ `Static` **once**(`emitter`, `event`, `options?`): `Promise`<`any`[]\>
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `emitter` | `NodeEventTarget` |
-| `event` | `string` \| `symbol` |
-| `options?` | `StaticEventEmitterOptions` |
-#### Returns
-`Promise`<`any`[]\>
-#### Inherited from
-EventEmitter.once
-#### Defined in
-browser/node_modules/@types/node/events.d.ts:25
-▸ `Static` **once**(`emitter`, `event`, `options?`): `Promise`<`any`[]\>
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `emitter` | `DOMEventTarget` |
-| `event` | `string` |
-| `options?` | `StaticEventEmitterOptions` |
-#### Returns
-`Promise`<`any`[]\>
-#### Inherited from
-EventEmitter.once
-#### Defined in
-browser/node_modules/@types/node/events.d.ts:26