Creates the route string as required by the oidc-provider library.
+ In case base URL is http://test.com/foo/, idpPath is /idp and relative is device/auth,
+ this would result in /foo/idp/device/auth.
+
+
+
Parameters
+
+
+
relative: string
+
+
+
Returns string
+
+
+
+
+
+
Private generateCookieKeys
+
+
generateCookieKeys(): Promise<string[]>
+
+
+
+
+
Returns Promise<string[]>
+
+
+
+
+
+
Private generateJwks
+
+
generateJwks(): Promise<{ keys: JWK[] }>
+
+
+
+
+
Returns Promise<{ keys: JWK[] }>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/classes/identity_identityproviderfactory.identityproviderfactory.html b/docs/classes/identity_identityproviderfactory.identityproviderfactory.html
new file mode 100644
index 000000000..753c90ba7
--- /dev/null
+++ b/docs/classes/identity_identityproviderfactory.identityproviderfactory.html
@@ -0,0 +1,305 @@
+
+
+
+
+
+ IdentityProviderFactory | Community Solid Server - v0.9.0
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/classes/index.authenticatedldphandler.html b/docs/classes/identity_identityproviderhttphandler.identityproviderhttphandler.html
similarity index 57%
rename from docs/classes/index.authenticatedldphandler.html
rename to docs/classes/identity_identityproviderhttphandler.identityproviderhttphandler.html
index c7ec830de..719a4befc 100644
--- a/docs/classes/index.authenticatedldphandler.html
+++ b/docs/classes/identity_identityproviderhttphandler.identityproviderhttphandler.html
@@ -3,8 +3,8 @@
- AuthenticatedLdpHandler | Community Solid Server - v0.8.1
-
+ IdentityProviderHttpHandler | Community Solid Server - v0.9.0
+
@@ -23,7 +23,7 @@
The central manager that connects all the necessary handlers to go from an incoming request to an executed operation.
+
Handles all requests relevant for the entire IDP interaction,
+ by sending them to either the stored InteractionHttpHandler,
+ or the generated {@link Provider} if the first does not support the request.
+
The InteractionHttpHandler would handle all requests where we need custom behaviour,
+ such as everything related to generating and validating an account.
+ The Provider handles all the default request such as the initial handshake.
+
This handler handles all requests since it assumes all those requests are relevant for the IDP interaction.
+ A RouterHandler should be used to filter out other requests.
Checks if the incoming request can be handled. The check is very non-restrictive and will usually be true.
- It is based on whether the incoming request can be parsed to an operation.
+
Checks if the input data can be handled by this class.
+ Throws an error if it can't handle the data.
The incoming request and response object to write to.
-
Returns Promise<void>
-
A promise resolving when the handling is finished.
@@ -319,14 +320,14 @@
Helper function that first runs the canHandle function followed by the handle function.
- Throws the error of the canHandle function if the data can't be handled,
- or returns the result of the handle function otherwise.
+ Throws the error of the canHandle function if the data can't be handled,
+ or returns the result of the handle function otherwise.
Helper function to create the function that will be put in url.
+ Needs to be done like this since the this reference is lost when passing this value along.
Helper function that first runs the canHandle function followed by the handle function.
+ Throws the error of the canHandle function if the data can't be handled,
+ or returns the result of the handle function otherwise.
Input data that will be handled if it can be handled.
+
+
+
+
Returns Promise<void>
+
A promise resolving if the input can be handled, rejecting with an Error if not.
+ Return value depends on the given type.
+
+
+
+
+
+
Private resetPassword
+
+
resetPassword(email: string): Promise<void>
+
+
+
+
+
+
+
Generates a record to reset the password for the given email address and then mails it.
+ In case there is no account, no error wil be thrown for privacy reasons.
+ Instead nothing will happen instead.
Helper function that first runs the canHandle function followed by the handle function.
+ Throws the error of the canHandle function if the data can't be handled,
+ or returns the result of the handle function otherwise.
Parses and validates the input form data.
+ Will throw an IdpInteractionError in case something is wrong.
+ All relevant data that was correct up to that point will be prefilled.
Helper function that first runs the canHandle function followed by the handle function.
+ Throws the error of the canHandle function if the data can't be handled,
+ or returns the result of the handle function otherwise.
Parses and validates the input form data.
+ Will throw an IdpInteractionError in case something is wrong.
+ All relevant data that was correct up to that point will be prefilled.
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/classes/index.staticassethandler.html b/docs/classes/identity_interaction_email_password_handler_resetpasswordhandler.resetpasswordhandler.html
similarity index 54%
rename from docs/classes/index.staticassethandler.html
rename to docs/classes/identity_interaction_email_password_handler_resetpasswordhandler.resetpasswordhandler.html
index 6641c3b3b..e5ff7730a 100644
--- a/docs/classes/index.staticassethandler.html
+++ b/docs/classes/identity_interaction_email_password_handler_resetpasswordhandler.resetpasswordhandler.html
@@ -3,8 +3,8 @@
- StaticAssetHandler | Community Solid Server - v0.8.1
-
+ ResetPasswordHandler | Community Solid Server - v0.9.0
+
@@ -23,7 +23,7 @@
Helper function that first runs the canHandle function followed by the handle function.
- Throws the error of the canHandle function if the data can't be handled,
- or returns the result of the handle function otherwise.
+ Throws the error of the canHandle function if the data can't be handled,
+ or returns the result of the handle function otherwise.
Handles the given input. This should only be done if the canHandle function returned true.
- Therefore, consider using the handleSafe function instead.
+
Handles the given input. This should only be done if the canHandle function returned true.
+ Therefore, consider using the handleSafe function instead.
Helper function that first runs the canHandle function followed by the handle function.
- Throws the error of the canHandle function if the data can't be handled,
- or returns the result of the handle function otherwise.
+ Throws the error of the canHandle function if the data can't be handled,
+ or returns the result of the handle function otherwise.
Helper function that first runs the canHandle function followed by the handle function.
- Throws the error of the canHandle function if the data can't be handled,
- or returns the result of the handle function otherwise.
+ Throws the error of the canHandle function if the data can't be handled,
+ or returns the result of the handle function otherwise.
Creates a Forgot Password Confirmation Record. This will be to remember that
+ a user has made a request to reset a password. Throws an error if the email doesn't
+ exist
Generates a ResourceIdentifier to store data for the given recordId.
+
+
+
Parameters
+
+
+
recordId: string
+
+
+
Returns string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/classes/index.representationconverter.html b/docs/classes/identity_interaction_interactionhttphandler.interactionhttphandler.html
similarity index 61%
rename from docs/classes/index.representationconverter.html
rename to docs/classes/identity_interaction_interactionhttphandler.interactionhttphandler.html
index 0ea1a1df7..189ed3ea7 100644
--- a/docs/classes/index.representationconverter.html
+++ b/docs/classes/identity_interaction_interactionhttphandler.interactionhttphandler.html
@@ -3,8 +3,8 @@
- RepresentationConverter | Community Solid Server - v0.8.1
-
+ InteractionHttpHandler | Community Solid Server - v0.9.0
+
@@ -23,7 +23,7 @@
Handles the given input. This should only be done if the canHandle function returned true.
- Therefore, consider using the handleSafe function instead.
+
Handles the given input. This should only be done if the canHandle function returned true.
+ Therefore, consider using the handleSafe function instead.
Helper function that first runs the canHandle function followed by the handle function.
- Throws the error of the canHandle function if the data can't be handled,
- or returns the result of the handle function otherwise.
+ Throws the error of the canHandle function if the data can't be handled,
+ or returns the result of the handle function otherwise.
Helper function that first runs the canHandle function followed by the handle function.
- Throws the error of the canHandle function if the data can't be handled,
- or returns the result of the handle function otherwise.
+ Throws the error of the canHandle function if the data can't be handled,
+ or returns the result of the handle function otherwise.
Helper function that first runs the canHandle function followed by the handle function.
- Throws the error of the canHandle function if the data can't be handled,
- or returns the result of the handle function otherwise.
+ Throws the error of the canHandle function if the data can't be handled,
+ or returns the result of the handle function otherwise.
A composite handler that will try to run all supporting handlers sequentially
- and return the value of the last supported handler.
- The canHandle check of this handler will always succeed.
+
Renders options using a given EJS template location and returns the result as a string.
+ This is useful for rendering emails.
Helper function that first runs the canHandle function followed by the handle function.
- Throws the error of the canHandle function if the data can't be handled,
- or returns the result of the handle function otherwise.
+ Throws the error of the canHandle function if the data can't be handled,
+ or returns the result of the handle function otherwise.
Parameters
-
input: TIn
+
input: T
Input data that will be handled if it can be handled.
-
Returns Promise<undefined | TOut>
+
Returns Promise<string>
A promise resolving if the input can be handled, rejecting with an Error if not.
Return value depends on the given type.
Handles the given input. This should only be done if the canHandle function returned true.
- Therefore, consider using the handleSafe function instead.
+
Handles the given input. This should only be done if the canHandle function returned true.
+ Therefore, consider using the handleSafe function instead.
Helper function that first runs the canHandle function followed by the handle function.
- Throws the error of the canHandle function if the data can't be handled,
- or returns the result of the handle function otherwise.
+ Throws the error of the canHandle function if the data can't be handled,
+ or returns the result of the handle function otherwise.
Updates the variables stored in the given agent.
- Can be used to set variables that are required for the Components.js instantiation
- but which should not be provided by the request.
- E.g.: The exact file path (when required) should be determined by the server to prevent abuse.
Handles the given input. This should only be done if the canHandle function returned true.
- Therefore, consider using the handleSafe function instead.
+
Handles the given input. This should only be done if the canHandle function returned true.
+ Therefore, consider using the handleSafe function instead.
Helper function that first runs the canHandle function followed by the handle function.
- Throws the error of the canHandle function if the data can't be handled,
- or returns the result of the handle function otherwise.
+ Throws the error of the canHandle function if the data can't be handled,
+ or returns the result of the handle function otherwise.
Helper function that first runs the canHandle function followed by the handle function.
+ Throws the error of the canHandle function if the data can't be handled,
+ or returns the result of the handle function otherwise.
Calls the renderHandler to render using the given response and props.
+ details typed as any since the interactionDetails output typings are not exposed.
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/classes/index.rootcontainerinitializer.html b/docs/classes/identity_interaction_util_initialinteractionhandler.initialinteractionhandler.html
similarity index 53%
rename from docs/classes/index.rootcontainerinitializer.html
rename to docs/classes/identity_interaction_util_initialinteractionhandler.initialinteractionhandler.html
index fec2d421e..7665c8380 100644
--- a/docs/classes/index.rootcontainerinitializer.html
+++ b/docs/classes/identity_interaction_util_initialinteractionhandler.initialinteractionhandler.html
@@ -3,8 +3,8 @@
- RootContainerInitializer | Community Solid Server - v0.8.1
-
+ InitialInteractionHandler | Community Solid Server - v0.9.0
+
@@ -23,7 +23,7 @@
Solid, §4.1: "When a server supports a data pod, it MUST provide one or more storages (pim:Storage) –
- a space of URIs in which data can be accessed. A storage is the root container for all of its contained resources."
- https://solid.github.io/specification/protocol#storage
+
Specifically, the prompt determines how the server should handle re-authentication and consent.
+
Since this class specifically redirects to render handlers,
+ it is advised to wrap it in a RouterHandler that only allows GET requests.
Helper function that first runs the canHandle function followed by the handle function.
- Throws the error of the canHandle function if the data can't be handled,
- or returns the result of the handle function otherwise.
+ Throws the error of the canHandle function if the data can't be handled,
+ or returns the result of the handle function otherwise.
Handles the given input. This should only be done if the canHandle function returned true.
- Therefore, consider using the handleSafe function instead.
Helper function that first runs the canHandle function followed by the handle function.
- Throws the error of the canHandle function if the data can't be handled,
- or returns the result of the handle function otherwise.
+ Throws the error of the canHandle function if the data can't be handled,
+ or returns the result of the handle function otherwise.
A MetadataWriter that takes a linking metadata predicates to Link header "rel" values.
- The values of the objects will be put in a Link header with the corresponding "rel" value.
+
Validates if a WebID can be registered based on whether it references this as an issuer.
Helper function that first runs the canHandle function followed by the handle function.
- Throws the error of the canHandle function if the data can't be handled,
- or returns the result of the handle function otherwise.
+ Throws the error of the canHandle function if the data can't be handled,
+ or returns the result of the handle function otherwise.
Handles the given input. This should only be done if the canHandle function returned true.
- Therefore, consider using the handleSafe function instead.
+
Handles the given input. This should only be done if the canHandle function returned true.
+ Therefore, consider using the handleSafe function instead.
Helper function that first runs the canHandle function followed by the handle function.
- Throws the error of the canHandle function if the data can't be handled,
- or returns the result of the handle function otherwise.
+ Throws the error of the canHandle function if the data can't be handled,
+ or returns the result of the handle function otherwise.
Verifies if the given credentials have access to the given permissions on the given resource.
- An {@link Error} with the necessary explanation will be thrown when permissions are not granted.
Handles the given input. This should only be done if the canHandle function returned true.
- Therefore, consider using the handleSafe function instead.
+
Handles the given input. This should only be done if the canHandle function returned true.
+ Therefore, consider using the handleSafe function instead.
Helper function that first runs the canHandle function followed by the handle function.
- Throws the error of the canHandle function if the data can't be handled,
- or returns the result of the handle function otherwise.
+ Throws the error of the canHandle function if the data can't be handled,
+ or returns the result of the handle function otherwise.
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/classes/index.subdomainidentifiergenerator.html b/docs/classes/identity_storage_expiringadapterfactory.expiringadapterfactory.html
similarity index 61%
rename from docs/classes/index.subdomainidentifiergenerator.html
rename to docs/classes/identity_storage_expiringadapterfactory.expiringadapterfactory.html
index c5a1fb1e6..d0677a208 100644
--- a/docs/classes/index.subdomainidentifiergenerator.html
+++ b/docs/classes/identity_storage_expiringadapterfactory.expiringadapterfactory.html
@@ -3,8 +3,8 @@
- SubdomainIdentifierGenerator | Community Solid Server - v0.8.1
-
+ ExpiringAdapterFactory | Community Solid Server - v0.9.0
+
@@ -23,7 +23,7 @@
This {@link Adapter} redirects the find call to its source adapter.
+ In case no client data was found in the source for the given WebId,
+ this class will do an HTTP GET request to that WebId.
+ If a valid solid:oidcRegistration triple is found there,
+ that data will be returned instead.
Validates if the quad object contains valid JSON with the required client_id.
+ In case of success, the AdapterPayload will be returned, otherwise an error will be thrown.
+
+
+
Parameters
+
+
+
quad: Quad
+
+
+
id: string
+
+
+
Returns AdapterPayload
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/classes/index.suffixidentifiergenerator.html b/docs/classes/identity_storage_wrappedfetchadapterfactory.wrappedfetchadapterfactory.html
similarity index 62%
rename from docs/classes/index.suffixidentifiergenerator.html
rename to docs/classes/identity_storage_wrappedfetchadapterfactory.wrappedfetchadapterfactory.html
index f6c6e9ef7..989e6704c 100644
--- a/docs/classes/index.suffixidentifiergenerator.html
+++ b/docs/classes/identity_storage_wrappedfetchadapterfactory.wrappedfetchadapterfactory.html
@@ -3,8 +3,8 @@
- SuffixIdentifierGenerator | Community Solid Server - v0.8.1
-
+ WrappedFetchAdapterFactory | Community Solid Server - v0.9.0
+
@@ -23,7 +23,7 @@
Generic run function for starting the server on the CLI from a given config
Made run to be non-async to lower the chance of unhandled promise rejection errors in the future.
Adds metadata related to this auxiliary resource,
+ in case this is required for this type of auxiliary resource.
+ The metadata that is added depends on the given identifier being an auxiliary or associated resource:
+ the metadata will be used to link to the other one, and potentially add extra typing info.
+
+
Used for:
+ Solid, §4.3.1: "For any defined auxiliary resource available for a given Solid resource, all representations of
+ that resource MUST include an HTTP Link header pointing to the location of each auxiliary resource."
+ https://solid.github.io/specification/protocol#auxiliary-resources-server
+
The above is an example of how that metadata would only be added in case the input is the associated identifier.
+
Parameters
@@ -236,10 +250,17 @@
+
+
+
Returns the identifier of the resource which this auxiliary resource is referring to.
+ This does not guarantee that this resource exists.
+
+
Parameters
@@ -259,10 +280,18 @@
+
+
+
Returns the identifier of the auxiliary resource corresponding to the given resource.
+ This does not guarantee that this auxiliary resource exists.
Returns all the identifiers of corresponding auxiliary resources.
+ This can be used when there are potentially multiple results.
+ In the case of a single result this should be an array containing the result of getAuxiliaryIdentifier.
+
+
Parameters
@@ -305,10 +342,18 @@
+
+
+
Checks if the input identifier corresponds to an auxiliary resource.
+ This does not check if that auxiliary resource exists,
+ only if the identifier indicates that there could be an auxiliary resource there.
+
+
Parameters
@@ -328,10 +373,17 @@
+
+
+
Whether this auxiliary resource in a root storage container.
+ If yes, this means they can't be deleted individually from such a container.
+
+
Returns boolean
@@ -345,10 +397,17 @@
+
+
+
Validates if the representation contains valid data for an auxiliary resource.
+ Should throw an error in case the data is invalid.
+
+
Parameters
diff --git a/docs/classes/ldp_auxiliary_linkmetadatagenerator.linkmetadatagenerator.html b/docs/classes/ldp_auxiliary_linkmetadatagenerator.linkmetadatagenerator.html
index 93b13ac1b..f9a9e899e 100644
--- a/docs/classes/ldp_auxiliary_linkmetadatagenerator.linkmetadatagenerator.html
+++ b/docs/classes/ldp_auxiliary_linkmetadatagenerator.linkmetadatagenerator.html
@@ -3,8 +3,8 @@
- LinkMetadataGenerator | Community Solid Server - v0.8.1
-
+ LinkMetadataGenerator | Community Solid Server - v0.9.0
+
@@ -23,7 +23,7 @@
Returns all the identifiers of corresponding auxiliary resources.
+ This can be used when there are potentially multiple results.
+ In the case of a single result this should be an array containing the result of getAuxiliaryIdentifier.
+
+
Parameters
@@ -241,7 +261,7 @@
Parameters
@@ -263,10 +283,18 @@
+
+
+
Checks if the input identifier corresponds to an auxiliary resource.
+ This does not check if that auxiliary resource exists,
+ only if the identifier indicates that there could be an auxiliary resource there.
+
+
Parameters
diff --git a/docs/classes/ldp_auxiliary_routingauxiliarystrategy.routingauxiliarystrategy.html b/docs/classes/ldp_auxiliary_routingauxiliarystrategy.routingauxiliarystrategy.html
index 0d7e761e7..d03cbc62d 100644
--- a/docs/classes/ldp_auxiliary_routingauxiliarystrategy.routingauxiliarystrategy.html
+++ b/docs/classes/ldp_auxiliary_routingauxiliarystrategy.routingauxiliarystrategy.html
@@ -3,8 +3,8 @@
- RoutingAuxiliaryStrategy | Community Solid Server - v0.8.1
-
+ RoutingAuxiliaryStrategy | Community Solid Server - v0.9.0
+
@@ -23,7 +23,7 @@
Adds metadata related to this auxiliary resource,
+ in case this is required for this type of auxiliary resource.
+ The metadata that is added depends on the given identifier being an auxiliary or associated resource:
+ the metadata will be used to link to the other one, and potentially add extra typing info.
+
+
Used for:
+ Solid, §4.3.1: "For any defined auxiliary resource available for a given Solid resource, all representations of
+ that resource MUST include an HTTP Link header pointing to the location of each auxiliary resource."
+ https://solid.github.io/specification/protocol#auxiliary-resources-server
+
The above is an example of how that metadata would only be added in case the input is the associated identifier.
+
Parameters
@@ -204,11 +218,18 @@
+
+
+
Returns the identifier of the resource which this auxiliary resource is referring to.
+ This does not guarantee that this resource exists.
+
+
Parameters
@@ -228,11 +249,19 @@
+
+
+
Returns the identifier of the auxiliary resource corresponding to the given resource.
+ This does not guarantee that this auxiliary resource exists.
Returns all the identifiers of corresponding auxiliary resources.
+ This can be used when there are potentially multiple results.
+ In the case of a single result this should be an array containing the result of getAuxiliaryIdentifier.
+
+
Parameters
@@ -272,7 +309,7 @@
Parameters
@@ -294,11 +331,19 @@
+
+
+
Checks if the input identifier corresponds to an auxiliary resource.
+ This does not check if that auxiliary resource exists,
+ only if the identifier indicates that there could be an auxiliary resource there.
+
+
Parameters
@@ -318,10 +363,17 @@
+
+
+
Whether this auxiliary resource in a root storage container.
+ If yes, this means they can't be deleted individually from such a container.
+
+
Parameters
@@ -341,10 +393,17 @@
+
+
+
Validates if the representation contains valid data for an auxiliary resource.
+ Should throw an error in case the data is invalid.
Returns all the identifiers of corresponding auxiliary resources.
+ This can be used when there are potentially multiple results.
+ In the case of a single result this should be an array containing the result of getAuxiliaryIdentifier.
+
+
Parameters
@@ -237,10 +260,18 @@
+
+
+
Checks if the input identifier corresponds to an auxiliary resource.
+ This does not check if that auxiliary resource exists,
+ only if the identifier indicates that there could be an auxiliary resource there.
+
+
Parameters
diff --git a/docs/classes/ldp_auxiliary_validator.validator.html b/docs/classes/ldp_auxiliary_validator.validator.html
index 8325960d0..572d4b0ec 100644
--- a/docs/classes/ldp_auxiliary_validator.validator.html
+++ b/docs/classes/ldp_auxiliary_validator.validator.html
@@ -3,8 +3,8 @@
- Validator | Community Solid Server - v0.8.1
-
+ Validator | Community Solid Server - v0.9.0
+
@@ -23,7 +23,7 @@
--
+
-
constructor
-
@@ -307,6 +307,7 @@
- Class
- Class with type parameter
+ - Constructor
- Method
@@ -314,7 +315,6 @@- Interface with type parameter
-- Inherited constructor
- Inherited method
diff --git a/docs/classes/authentication_credentialsextractor.credentialsextractor.html b/docs/classes/authentication_credentialsextractor.credentialsextractor.html index 133a8d8c3..91a7e6d3c 100644 --- a/docs/classes/authentication_credentialsextractor.credentialsextractor.html +++ b/docs/classes/authentication_credentialsextractor.credentialsextractor.html @@ -3,8 +3,8 @@ -CredentialsExtractor | Community Solid Server - v0.8.1
-
+ CredentialsExtractor | Community Solid Server - v0.9.0
+
@@ -23,7 +23,7 @@
- Preparing search index...
- The search index is not available
- Community Solid Server - v0.8.1 + Community Solid Server - v0.9.0