@inrupt/solid-client-authn-browser 1.11.9-alpha.1 → 1.11.9-alpha.4

package/docs/api/source/api/index.md

@@ -1,251 +0,0 @@
-@inrupt/solid-client-authn-browser
-
-# @inrupt/solid-client-authn-browser
-
-## Table of contents
-
-### Classes
-
-- [ConfigurationError](classes/ConfigurationError.md)
-- [InMemoryStorage](classes/InMemoryStorage.md)
-- [NotImplementedError](classes/NotImplementedError.md)
-- [Session](classes/Session.md)
-
-### Interfaces
-
-- [ILoginInputOptions](interfaces/ILoginInputOptions.md)
-- [ISessionInfo](interfaces/ISessionInfo.md)
-- [ISessionOptions](interfaces/ISessionOptions.md)
-- [IStorage](interfaces/IStorage.md)
-
-### Functions
-
-- [fetch](index.md#fetch)
-- [getClientAuthenticationWithDependencies](index.md#getclientauthenticationwithdependencies)
-- [getDefaultSession](index.md#getdefaultsession)
-- [handleIncomingRedirect](index.md#handleincomingredirect)
-- [login](index.md#login)
-- [logout](index.md#logout)
-- [onLogin](index.md#onlogin)
-- [onLogout](index.md#onlogout)
-- [onSessionRestore](index.md#onsessionrestore)
-
-## Functions
-
-### fetch
-
-▸ `Const` **fetch**(`url`, `init?`): `Promise`<`Response`\>
-
-This function's signature is equal to `window.fetch`, but if the current user is authenticated
-(see [login](classes/Session.md#login) and [handleIncomingRedirect](classes/Session.md#handleincomingredirect)), requests made using it will include that user's
-credentials. If not, this will behave just like the regular `window.fetch`.
-
-**`see`** [https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/fetch](https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/fetch)
-
-**`since`** 1.3.0
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `url` | `RequestInfo` |
-| `init?` | `RequestInit` |
-
-#### Returns
-
-`Promise`<`Response`\>
-
-#### Defined in
-
-[browser/src/defaultSession.ts:51](https://github.com/inrupt/solid-client-authn-js/blob/9b3ed957/packages/browser/src/defaultSession.ts#L51)
-
-___
-
-### getClientAuthenticationWithDependencies
-
-▸ **getClientAuthenticationWithDependencies**(`dependencies`): `ClientAuthentication`
-
-**`deprecated`** This function will be removed from the external API in an upcoming release.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `dependencies` | `Object` |
-| `dependencies.insecureStorage?` | [`IStorage`](interfaces/IStorage.md) |
-| `dependencies.secureStorage?` | [`IStorage`](interfaces/IStorage.md) |
-
-#### Returns
-
-`ClientAuthentication`
-
-#### Defined in
-
-[browser/src/dependencies.ts:52](https://github.com/inrupt/solid-client-authn-js/blob/9b3ed957/packages/browser/src/dependencies.ts#L52)
-
-___
-
-### getDefaultSession
-
-▸ **getDefaultSession**(): [`Session`](classes/Session.md)
-
-Obtain the [Session](classes/Session.md) used when not explicitly instantiating one yourself.
-
-When using the top-level exports [fetch](classes/Session.md#fetch), [login](classes/Session.md#login), [logout](classes/Session.md#logout),
-[handleIncomingRedirect](classes/Session.md#handleincomingredirect), [onLogin](classes/Session.md#onlogin) and [onLogout](classes/Session.md#onlogout), these apply to an
-implicitly-instantiated [Session](classes/Session.md).
-This function returns a reference to that Session in order to obtain e.g. the current user's
-WebID.
-
-**`since`** 1.3.0
-
-#### Returns
-
-[`Session`](classes/Session.md)
-
-#### Defined in
-
-[browser/src/defaultSession.ts:36](https://github.com/inrupt/solid-client-authn-js/blob/9b3ed957/packages/browser/src/defaultSession.ts#L36)
-
-___
-
-### handleIncomingRedirect
-
-▸ `Const` **handleIncomingRedirect**(`inputOptions?`): `Promise`<`undefined` \| [`ISessionInfo`](interfaces/ISessionInfo.md)\>
-
-Completes the login process by processing the information provided by the Solid identity provider through redirect.
-
-**`since`** 1.3.0
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `inputOptions` | `string` \| `IHandleIncomingRedirectOptions` |
-
-#### Returns
-
-`Promise`<`undefined` \| [`ISessionInfo`](interfaces/ISessionInfo.md)\>
-
-#### Defined in
-
-[browser/src/defaultSession.ts:85](https://github.com/inrupt/solid-client-authn-js/blob/9b3ed957/packages/browser/src/defaultSession.ts#L85)
-
-___
-
-### login
-
-▸ `Const` **login**(`options`): `Promise`<`void`\>
-
-Triggers the login process. Note that this method will redirect the user away from your app.
-
-**`since`** 1.3.0
-
-#### 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](classes/Session.md#handleincomingredirect).
-
-#### Defined in
-
-[browser/src/defaultSession.ts:63](https://github.com/inrupt/solid-client-authn-js/blob/9b3ed957/packages/browser/src/defaultSession.ts#L63)
-
-___
-
-### logout
-
-▸ `Const` **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.
-
-**`since`** 1.3.0
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Defined in
-
-[browser/src/defaultSession.ts:74](https://github.com/inrupt/solid-client-authn-js/blob/9b3ed957/packages/browser/src/defaultSession.ts#L74)
-
-___
-
-### onLogin
-
-▸ `Const` **onLogin**(`callback`): `void`
-
-Register a callback function to be called when a user completes login.
-
-The callback is called when [handleIncomingRedirect](classes/Session.md#handleincomingredirect) completes successfully.
-
-**`since`** 1.3.0
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `callback` | () => `unknown` | The function called when a user completes login. |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[browser/src/defaultSession.ts:100](https://github.com/inrupt/solid-client-authn-js/blob/9b3ed957/packages/browser/src/defaultSession.ts#L100)
-
-___
-
-### onLogout
-
-▸ `Const` **onLogout**(`callback`): `void`
-
-Register a callback function to be called when a user logs out:
-
-**`since`** 1.3.0
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `callback` | () => `unknown` | The function called when a user completes logout. |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[browser/src/defaultSession.ts:111](https://github.com/inrupt/solid-client-authn-js/blob/9b3ed957/packages/browser/src/defaultSession.ts#L111)
-
-___
-
-### onSessionRestore
-
-▸ `Const` **onSessionRestore**(`callback`): `void`
-
-Register a callback function to be called when a session is restored:
-
-**`since`** 1.3.0
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `callback` | (`currentUrl`: `string`) => `unknown` | The function called when a session is restored. |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[browser/src/defaultSession.ts:122](https://github.com/inrupt/solid-client-authn-js/blob/9b3ed957/packages/browser/src/defaultSession.ts#L122)

package/docs/api/source/api/interfaces/ILoginInputOptions.md

@@ -1,109 +0,0 @@
-[@inrupt/solid-client-authn-browser](../index.md) / ILoginInputOptions
-
-# Interface: ILoginInputOptions
-
-## Table of contents
-
-### Properties
-
-- [clientId](ILoginInputOptions.md#clientid)
-- [clientName](ILoginInputOptions.md#clientname)
-- [clientSecret](ILoginInputOptions.md#clientsecret)
-- [oidcIssuer](ILoginInputOptions.md#oidcissuer)
-- [redirectUrl](ILoginInputOptions.md#redirecturl)
-- [refreshToken](ILoginInputOptions.md#refreshtoken)
-- [tokenType](ILoginInputOptions.md#tokentype)
-
-### Methods
-
-- [handleRedirect](ILoginInputOptions.md#handleredirect)
-
-## Properties
-
-### clientId
-
-• `Optional` **clientId**: `string`
-
-#### Defined in
-
-core/dist/ILoginInputOptions.d.ts:4
-
-___
-
-### clientName
-
-• `Optional` **clientName**: `string`
-
-#### Defined in
-
-core/dist/ILoginInputOptions.d.ts:6
-
-___
-
-### clientSecret
-
-• `Optional` **clientSecret**: `string`
-
-#### Defined in
-
-core/dist/ILoginInputOptions.d.ts:5
-
-___
-
-### oidcIssuer
-
-• `Optional` **oidcIssuer**: `string`
-
-#### Defined in
-
-core/dist/ILoginInputOptions.d.ts:2
-
-___
-
-### redirectUrl
-
-• `Optional` **redirectUrl**: `string`
-
-#### Defined in
-
-core/dist/ILoginInputOptions.d.ts:3
-
-___
-
-### refreshToken
-
-• `Optional` **refreshToken**: `string`
-
-#### Defined in
-
-core/dist/ILoginInputOptions.d.ts:9
-
-___
-
-### tokenType
-
-• `Optional` **tokenType**: ``"DPoP"`` \| ``"Bearer"``
-
-#### Defined in
-
-core/dist/ILoginInputOptions.d.ts:8
-
-## Methods
-
-### handleRedirect
-
-▸ `Optional` **handleRedirect**(`redirectUrl`): `unknown`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `redirectUrl` | `string` |
-
-#### Returns
-
-`unknown`
-
-#### Defined in
-
-core/dist/ILoginInputOptions.d.ts:7

package/docs/api/source/api/interfaces/ISessionInfo.md

@@ -1,63 +0,0 @@
-[@inrupt/solid-client-authn-browser](../index.md) / ISessionInfo
-
-# Interface: ISessionInfo
-
-## Table of contents
-
-### Properties
-
-- [clientAppId](ISessionInfo.md#clientappid)
-- [expirationDate](ISessionInfo.md#expirationdate)
-- [isLoggedIn](ISessionInfo.md#isloggedin)
-- [sessionId](ISessionInfo.md#sessionid)
-- [webId](ISessionInfo.md#webid)
-
-## Properties
-
-### clientAppId
-
-• `Optional` **clientAppId**: `string`
-
-#### Defined in
-
-core/dist/sessionInfo/ISessionInfo.d.ts:4
-
-___
-
-### expirationDate
-
-• `Optional` **expirationDate**: `number`
-
-#### Defined in
-
-core/dist/sessionInfo/ISessionInfo.d.ts:6
-
-___
-
-### isLoggedIn
-
-• **isLoggedIn**: `boolean`
-
-#### Defined in
-
-core/dist/sessionInfo/ISessionInfo.d.ts:2
-
-___
-
-### sessionId
-
-• **sessionId**: `string`
-
-#### Defined in
-
-core/dist/sessionInfo/ISessionInfo.d.ts:5
-
-___
-
-### webId
-
-• `Optional` **webId**: `string`
-
-#### Defined in
-
-core/dist/sessionInfo/ISessionInfo.d.ts:3

package/docs/api/source/api/interfaces/ISessionOptions.md

@@ -1,60 +0,0 @@
-[@inrupt/solid-client-authn-browser](../index.md) / ISessionOptions
-
-# Interface: ISessionOptions
-
-## Table of contents
-
-### Properties
-
-- [clientAuthentication](ISessionOptions.md#clientauthentication)
-- [insecureStorage](ISessionOptions.md#insecurestorage)
-- [secureStorage](ISessionOptions.md#securestorage)
-- [sessionInfo](ISessionOptions.md#sessioninfo)
-
-## Properties
-
-### clientAuthentication
-
-• **clientAuthentication**: `default`
-
-An instance of the library core. Typically obtained using `getClientAuthenticationWithDependencies`.
-
-#### Defined in
-
-[browser/src/Session.ts:55](https://github.com/inrupt/solid-client-authn-js/blob/9b3ed957/packages/browser/src/Session.ts#L55)
-
-___
-
-### insecureStorage
-
-• **insecureStorage**: [`IStorage`](IStorage.md)
-
-A storage where non-sensitive information may be stored, potentially longer-lived than the secure storage.
-
-#### Defined in
-
-[browser/src/Session.ts:47](https://github.com/inrupt/solid-client-authn-js/blob/9b3ed957/packages/browser/src/Session.ts#L47)
-
-___
-
-### secureStorage
-
-• **secureStorage**: [`IStorage`](IStorage.md)
-
-A private storage, unreachable to other scripts on the page. Typically in-memory.
-
-#### Defined in
-
-[browser/src/Session.ts:43](https://github.com/inrupt/solid-client-authn-js/blob/9b3ed957/packages/browser/src/Session.ts#L43)
-
-___
-
-### sessionInfo
-
-• **sessionInfo**: [`ISessionInfo`](ISessionInfo.md)
-
-Details about the current session
-
-#### Defined in
-
-[browser/src/Session.ts:51](https://github.com/inrupt/solid-client-authn-js/blob/9b3ed957/packages/browser/src/Session.ts#L51)

package/docs/api/source/api/interfaces/IStorage.md

@@ -1,76 +0,0 @@
-[@inrupt/solid-client-authn-browser](../index.md) / IStorage
-
-# Interface: IStorage
-
-## Implemented by
-
-- [`InMemoryStorage`](../classes/InMemoryStorage.md)
-
-## Table of contents
-
-### Methods
-
-- [delete](IStorage.md#delete)
-- [get](IStorage.md#get)
-- [set](IStorage.md#set)
-
-## Methods
-
-### delete
-
-▸ **delete**(`key`): `Promise`<`void`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `key` | `string` |
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Defined in
-
-core/dist/storage/IStorage.d.ts:4
-
-___
-
-### get
-
-▸ **get**(`key`): `Promise`<`undefined` \| `string`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `key` | `string` |
-
-#### Returns
-
-`Promise`<`undefined` \| `string`\>
-
-#### Defined in
-
-core/dist/storage/IStorage.d.ts:2
-
-___
-
-### set
-
-▸ **set**(`key`, `value`): `Promise`<`void`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `key` | `string` |
-| `value` | `string` |
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Defined in
-
-core/dist/storage/IStorage.d.ts:3

package/docs/api/source/functions.md

@@ -1,3 +0,0 @@
-# Functions
-
-## Table of contents

package/docs/api/source/index.rst

@@ -1,13 +0,0 @@
-:orphan:
-
-==============================
-solid-client-authn-browser API
-==============================
-
-.. COMMENT: If we want left hand side in specific order, we'll have to be specific in the toctree.  For now, will just use the default alphabetical order.
-
-.. toctree::
-   :glob:
-   :titlesonly:
-
-   **

package/examples/demoAuthentiationMonitor/index.js

@@ -1,34 +0,0 @@
-const express = require("express");
-
-const port = 3000;
-
-const app = express();
-app.use(express.urlencoded({ extended: true }));
-app.use(express.json());
-
-app.get("/", async (req, res) => {
-  try {
-    res.send("Success!").status(200);
-  } catch (err) {
-    res.send(err.message).status(500);
-  }
-});
-
-app.post("/register_pod", async (req, res) => {
-  try {
-    res.send("Success!").status(201);
-  } catch (err) {
-    res.send(err.message).status(500);
-  }
-});
-
-const server = app.listen(port, () =>
-  console.log(`Listening on port: [${port}]...`)
-);
-
-process.on("SIGTERM", () => {
-  console.info("SIGTERM signal received, closing HTTP server...");
-  server.close(() => {
-    console.log("...HTTP server closed.");
-  });
-});