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

package/docs/api/build/source/functions.md

@@ -1,235 +0,0 @@
-# Functions
-
-## Table of contents
-
-### Functions
-
-- [fetch](functions.html#fetch)
-- [getClientAuthenticationWithDependencies](functions.html#getclientauthenticationwithdependencies)
-- [getDefaultSession](functions.html#getdefaultsession)
-- [handleIncomingRedirect](functions.html#handleincomingredirect)
-- [login](functions.html#login)
-- [logout](functions.html#logout)
-- [onLogin](functions.html#onlogin)
-- [onLogout](functions.html#onlogout)
-- [onSessionRestore](functions.html#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.html#login) and [handleIncomingRedirect](classes/Session.html#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/4bd2cf13/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/4bd2cf13/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.html#fetch), [login](classes/Session.html#login), [logout](classes/Session.html#logout),
-[handleIncomingRedirect](classes/Session.html#handleincomingredirect), [onLogin](classes/Session.html#onlogin) and [onLogout](classes/Session.html#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/4bd2cf13/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/4bd2cf13/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.html#handleincomingredirect).
-
-#### Defined in
-
-[browser/src/defaultSession.ts:63](https://github.com/inrupt/solid-client-authn-js/blob/4bd2cf13/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/4bd2cf13/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.html#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/4bd2cf13/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/4bd2cf13/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/4bd2cf13/packages/browser/src/defaultSession.ts#L122)

package/docs/api/build/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/docs/api/build/source/interfaces/ILoginInputOptions.md

@@ -1,109 +0,0 @@
-[@inrupt/solid-client-authn-browser](../index.md) / ILoginInputOptions
-
-# Interface: ILoginInputOptions
-
-## Table of contents
-
-### Properties
-
-- [clientId](ILoginInputOptions.html#clientid)
-- [clientName](ILoginInputOptions.html#clientname)
-- [clientSecret](ILoginInputOptions.html#clientsecret)
-- [oidcIssuer](ILoginInputOptions.html#oidcissuer)
-- [redirectUrl](ILoginInputOptions.html#redirecturl)
-- [refreshToken](ILoginInputOptions.html#refreshtoken)
-- [tokenType](ILoginInputOptions.html#tokentype)
-
-### Methods
-
-- [handleRedirect](ILoginInputOptions.html#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/build/source/interfaces/ISessionInfo.md

@@ -1,63 +0,0 @@
-[@inrupt/solid-client-authn-browser](../index.md) / ISessionInfo
-
-# Interface: ISessionInfo
-
-## Table of contents
-
-### Properties
-
-- [clientAppId](ISessionInfo.html#clientappid)
-- [expirationDate](ISessionInfo.html#expirationdate)
-- [isLoggedIn](ISessionInfo.html#isloggedin)
-- [sessionId](ISessionInfo.html#sessionid)
-- [webId](ISessionInfo.html#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/build/source/interfaces/ISessionOptions.md

@@ -1,60 +0,0 @@
-[@inrupt/solid-client-authn-browser](../index.md) / ISessionOptions
-
-# Interface: ISessionOptions
-
-## Table of contents
-
-### Properties
-
-- [clientAuthentication](ISessionOptions.html#clientauthentication)
-- [insecureStorage](ISessionOptions.html#insecurestorage)
-- [secureStorage](ISessionOptions.html#securestorage)
-- [sessionInfo](ISessionOptions.html#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/4bd2cf13/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/4bd2cf13/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/4bd2cf13/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/4bd2cf13/packages/browser/src/Session.ts#L51)

package/docs/api/build/source/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.html#delete)
-- [get](IStorage.html#get)
-- [set](IStorage.html#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/conf.py

@@ -1,135 +0,0 @@
-# Configuration file for the Sphinx documentation builder.
-#
-# This file only contains a selection of the most common options. For a full
-# list see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
-
-# -- Path setup --------------------------------------------------------------
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
-
-# -- Project information -----------------------------------------------------
-
-import datetime
-
-copyright = u'{0} Inrupt Inc.'.format(datetime.date.today().year)
-
-# -- General configuration ---------------------------------------------------
-
-
-# -- product name -----
-# -- Separately update code samples and toc links and docs-navbar since not using substitutions--
-
-name = 'solid-client-authn-browser'
-repo_name = 'solid-client-authn-js'
-
-
-pygments_style = 'sphinx'
-
-# -- Using .txt instead of .rst for restructured text -----------------------
-source_suffix = {
-    '.rst': 'restructuredtext',
-    '.md': 'markdown',
-}
-
-# -- Add lexers
-from sphinx.highlighting import lexers
-
-highlight_language = 'javascript'
-
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-extensions = [
-    'sphinx.ext.extlinks',
-    'sphinx.ext.todo',
-    'myst_parser',
-]
-
-extlinks = {
-    'apimodule': ('./api/module',''),
-}
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['./build/docs-assets/_templates']
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['./source/reference/api']
-
-# -- Options for HTML output -------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
-#html_theme = 'alabaster'
-
-html_theme = 'inrupt'
-html_theme_path = ['./build/docs-assets/themes']
-
-html_copy_source = False
-
-html_title = 'Inrupt {0} API Documentation'.format(name)
-
-# These theme options are declared in ./themes/inrupt/theme.conf
-# as well as some for pydata_sphinx_theme
-
-html_theme_options = {
-    'project_title': 'Inrupt {0} API'.format(name),
-    'banner': False,
-    'banner_msg': '',
-    'robots_index': True,
-    'github_editable': False,
-    'github_org': 'inrupt',
-    'github_repo': repo_name,
-    'github_branch': 'main',
-    'docs_project': 'developer-tools/api/javascript/{0}'.format(name),
-    'show_api_menu': True,
-    
-    # below are pydata_sphinx_theme
-    "footer_items": [ "copyright.html"],
-    "navbar_align": "left",
-    "icon_links": [
-        {
-            "name": "Inrupt on Twitter",
-            "url": "https://twitter.com/inrupt",
-            "icon": "fab fa-twitter-square",
-        },
-        {
-            "name": "Inrupt on LinkedIn",
-            "url": "https://www.linkedin.com/company/inrupt/",
-            "icon": "fab fa-linkedin",
-        },
-        {
-            "name": "Solid forum",
-            "url": "https://forum.solidproject.org/",
-            "icon": "fas fa-users",
-        },
-    ],
-    "favicons": [
-        {
-         "rel": "icon",
-         "sizes": "16x16",
-         "href": "https://docs.inrupt.com/inrupt_stickers_v2-03.png",
-        },
-    ],
-}
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['./build/docs-assets/_static']
-
-html_sidebars = {
-    '**': [  'search-field.html',  'docs-sidebar.html'],
-}
-
-locale_dirs = ['locale/']   # path is example but recommended.
-gettext_compact = False     # optional.