From 86da9348de0ea8568dc8c0e248714c4fbb7f8b0e Mon Sep 17 00:00:00 2001 From: joachimvh Date: Wed, 22 May 2024 07:00:59 +0000 Subject: [PATCH] deploy: cb38613b4cea7f4e808b30a69f1d9aecbb9506e2 --- 7.x/docs/.nojekyll | 1 + 7.x/docs/assets/custom.css | 4 + 7.x/docs/assets/highlight.css | 120 + 7.x/docs/assets/main.js | 59 + 7.x/docs/assets/navigation.js | 1 + 7.x/docs/assets/search.js | 1 + 7.x/docs/assets/style.css | 1383 ++++++ .../classes/AbsolutePathInteractionRoute.html | 159 + 7.x/docs/classes/AcceptPreferenceParser.html | 181 + 7.x/docs/classes/AccessChecker.html | 175 + 7.x/docs/classes/AccountInitializer.html | 224 + 7.x/docs/classes/AccountPromptFactory.html | 252 + 7.x/docs/classes/AcpHeaderHandler.html | 218 + 7.x/docs/classes/AcpReader.html | 326 ++ .../ActivityNotificationGenerator.html | 200 + .../AddRemoveNotificationGenerator.html | 201 + 7.x/docs/classes/AgentAccessChecker.html | 171 + 7.x/docs/classes/AgentClassAccessChecker.html | 171 + 7.x/docs/classes/AgentGroupAccessChecker.html | 219 + 7.x/docs/classes/AllStaticReader.html | 191 + 7.x/docs/classes/AllowAcceptHeaderWriter.html | 374 ++ 7.x/docs/classes/App.html | 158 + 7.x/docs/classes/AppRunner.html | 369 ++ 7.x/docs/classes/ArrayUnionHandler.html | 244 + 7.x/docs/classes/AssetPathExtractor.html | 201 + 7.x/docs/classes/AsyncHandler.html | 243 + 7.x/docs/classes/AtomicFileDataAccessor.html | 438 ++ 7.x/docs/classes/AuthAuxiliaryReader.html | 250 + 7.x/docs/classes/AuthorizationParser.html | 210 + 7.x/docs/classes/AuthorizedRouteHandler.html | 212 + 7.x/docs/classes/Authorizer.html | 174 + 7.x/docs/classes/AuthorizingHttpHandler.html | 250 + .../classes/AuxiliaryLinkMetadataWriter.html | 231 + 7.x/docs/classes/AuxiliaryReader.html | 242 + 7.x/docs/classes/BadRequestHttpError.html | 238 + 7.x/docs/classes/Base64EncodingStorage.html | 279 ++ 7.x/docs/classes/BaseAccountIdRoute.html | 158 + 7.x/docs/classes/BaseAccountStore.html | 295 ++ 7.x/docs/classes/BaseChannelType.html | 347 ++ .../classes/BaseClientCredentialsIdRoute.html | 153 + .../classes/BaseClientCredentialsStore.html | 332 ++ 7.x/docs/classes/BaseComponentsJsFactory.html | 171 + 7.x/docs/classes/BaseCookieStore.html | 219 + 7.x/docs/classes/BaseEmailSender.html | 204 + .../classes/BaseFileIdentifierMapper.html | 464 ++ 7.x/docs/classes/BaseForgotPasswordStore.html | 198 + 7.x/docs/classes/BaseIdentifierStrategy.html | 195 + 7.x/docs/classes/BaseLogger.html | 279 ++ 7.x/docs/classes/BaseLoginAccountStorage.html | 607 +++ 7.x/docs/classes/BasePasswordIdRoute.html | 152 + 7.x/docs/classes/BasePasswordStore.html | 425 ++ 7.x/docs/classes/BasePodCreator.html | 291 ++ 7.x/docs/classes/BasePodIdRoute.html | 152 + 7.x/docs/classes/BasePodStore.html | 426 ++ 7.x/docs/classes/BaseReadWriteLocker.html | 383 ++ 7.x/docs/classes/BaseResourceStore.html | 284 ++ 7.x/docs/classes/BaseResourcesGenerator.html | 330 ++ 7.x/docs/classes/BaseRouterHandler.html | 252 + 7.x/docs/classes/BaseServerFactory.html | 160 + 7.x/docs/classes/BaseStateHandler.html | 217 + .../BaseTypedRepresentationConverter.html | 233 + 7.x/docs/classes/BaseUrlExtractor.html | 191 + 7.x/docs/classes/BaseUrlHandler.html | 188 + 7.x/docs/classes/BaseUrlRouterRule.html | 236 + 7.x/docs/classes/BaseUrlVerifier.html | 208 + 7.x/docs/classes/BaseWebIdLinkRoute.html | 152 + 7.x/docs/classes/BaseWebIdStore.html | 326 ++ 7.x/docs/classes/BasicConditions.html | 193 + 7.x/docs/classes/BasicConditionsParser.html | 246 + 7.x/docs/classes/BasicETagHandler.html | 183 + 7.x/docs/classes/BasicRepresentation.html | 301 ++ 7.x/docs/classes/BasicRequestParser.html | 220 + 7.x/docs/classes/BasicResponseWriter.html | 212 + 7.x/docs/classes/BearerWebIdExtractor.html | 192 + .../classes/BinarySliceResourceStore.html | 325 ++ 7.x/docs/classes/BodyParser.html | 175 + 7.x/docs/classes/BooleanHandler.html | 214 + 7.x/docs/classes/CachedHandler.html | 273 ++ 7.x/docs/classes/CachedJwkGenerator.html | 184 + 7.x/docs/classes/CachedResourceSet.html | 148 + 7.x/docs/classes/CancelOidcHandler.html | 171 + 7.x/docs/classes/ChainedConverter.html | 419 ++ 7.x/docs/classes/ChainedTemplateEngine.html | 227 + 7.x/docs/classes/CliExtractor.html | 184 + 7.x/docs/classes/CliResolver.html | 119 + .../classes/ClientCredentialsAdapter.html | 271 ++ .../ClientCredentialsAdapterFactory.html | 155 + .../ClientCredentialsDetailsHandler.html | 206 + 7.x/docs/classes/ClientIdAdapter.html | 295 ++ 7.x/docs/classes/ClientIdAdapterFactory.html | 146 + 7.x/docs/classes/ClientInfoHandler.html | 190 + 7.x/docs/classes/ClusterManager.html | 213 + .../classes/CombinedShorthandResolver.html | 190 + .../classes/ComposedAuxiliaryStrategy.html | 336 ++ .../classes/ComposedNotificationHandler.html | 213 + 7.x/docs/classes/ConditionalHandler.html | 266 ++ 7.x/docs/classes/ConditionsParser.html | 173 + 7.x/docs/classes/ConfigPodInitializer.html | 215 + 7.x/docs/classes/ConfigPodManager.html | 196 + 7.x/docs/classes/ConflictHttpError.html | 228 + 7.x/docs/classes/ConsentHandler.html | 251 + 7.x/docs/classes/ConstantConverter.html | 233 + 7.x/docs/classes/ConstantMetadataWriter.html | 193 + 7.x/docs/classes/ContainerInitializer.html | 218 + 7.x/docs/classes/ContainerPathStorage.html | 288 ++ .../classes/ContainerToTemplateConverter.html | 301 ++ 7.x/docs/classes/ContentLengthParser.html | 198 + .../classes/ContentTypeMetadataWriter.html | 176 + 7.x/docs/classes/ContentTypeParser.html | 186 + 7.x/docs/classes/ContentTypeReplacer.html | 243 + 7.x/docs/classes/ContextDocumentLoader.html | 140 + 7.x/docs/classes/ControlHandler.html | 277 ++ 7.x/docs/classes/ConvertingErrorHandler.html | 247 + .../ConvertingNotificationSerializer.html | 200 + .../ConvertingOperationHttpHandler.html | 200 + 7.x/docs/classes/ConvertingPatcher.html | 242 + 7.x/docs/classes/ConvertingRouterRule.html | 251 + .../classes/CookieInteractionHandler.html | 212 + 7.x/docs/classes/CookieMetadataWriter.html | 208 + 7.x/docs/classes/CookieParser.html | 208 + 7.x/docs/classes/CorsHandler.html | 250 + 7.x/docs/classes/CreateAccountHandler.html | 265 ++ .../CreateClientCredentialsHandler.html | 235 + 7.x/docs/classes/CreateModesExtractor.html | 199 + 7.x/docs/classes/CreatePasswordHandler.html | 226 + 7.x/docs/classes/CreatePodHandler.html | 268 ++ .../classes/CreatedResponseDescription.html | 129 + 7.x/docs/classes/CredentialsExtractor.html | 177 + 7.x/docs/classes/DPoPWebIdExtractor.html | 208 + 7.x/docs/classes/DataAccessorBasedStore.html | 851 ++++ .../DeleteClientCredentialsHandler.html | 199 + .../classes/DeleteNotificationGenerator.html | 173 + 7.x/docs/classes/DeleteOperationHandler.html | 191 + 7.x/docs/classes/DeleteParentExtractor.html | 213 + 7.x/docs/classes/DeletePasswordHandler.html | 199 + .../DynamicJsonToTemplateConverter.html | 240 + 7.x/docs/classes/EjsTemplateEngine.html | 217 + 7.x/docs/classes/EmailSender.html | 173 + 7.x/docs/classes/EqualReadWriteLocker.html | 240 + 7.x/docs/classes/ErrorHandler.html | 176 + 7.x/docs/classes/ErrorToJsonConverter.html | 230 + 7.x/docs/classes/ErrorToQuadConverter.html | 215 + .../classes/ErrorToTemplateConverter.html | 264 ++ 7.x/docs/classes/ExpiringAdapter.html | 311 ++ 7.x/docs/classes/ExpiringAdapterFactory.html | 134 + 7.x/docs/classes/ExtensionBasedMapper.html | 507 +++ .../classes/ExtensionBasedMapperFactory.html | 118 + .../classes/ExtensionBasedTemplateEngine.html | 209 + 7.x/docs/classes/FileDataAccessor.html | 561 +++ 7.x/docs/classes/FileSizeReporter.html | 233 + .../classes/FileSystemResourceLocker.html | 356 ++ .../classes/FilterMetadataDataAccessor.html | 374 ++ 7.x/docs/classes/FilterPattern.html | 137 + 7.x/docs/classes/FinalizableHandler.html | 182 + 7.x/docs/classes/Finalizer.html | 173 + 7.x/docs/classes/FixedContentTypeMapper.html | 504 ++ 7.x/docs/classes/ForbiddenHttpError.html | 228 + 7.x/docs/classes/ForgetWebIdHandler.html | 191 + 7.x/docs/classes/ForgotPasswordHandler.html | 264 ++ 7.x/docs/classes/FormToJsonConverter.html | 216 + 7.x/docs/classes/FoundHttpError.html | 239 + 7.x/docs/classes/GeneratedPodManager.html | 157 + 7.x/docs/classes/GetOperationHandler.html | 200 + 7.x/docs/classes/GlobalQuotaStrategy.html | 227 + 7.x/docs/classes/GreedyReadWriteLocker.html | 354 ++ .../classes/HandlebarsTemplateEngine.html | 217 + .../classes/HandlerServerConfigurator.html | 245 + 7.x/docs/classes/HashEncodingStorage.html | 282 ++ 7.x/docs/classes/HashMap.html | 346 ++ 7.x/docs/classes/HeadOperationHandler.html | 200 + 7.x/docs/classes/HeaderHandler.html | 193 + 7.x/docs/classes/HtmlViewEntry.html | 121 + 7.x/docs/classes/HtmlViewHandler.html | 232 + 7.x/docs/classes/HttpError.html | 289 ++ 7.x/docs/classes/HttpHandler.html | 180 + 7.x/docs/classes/IdInteractionRoute.html | 203 + 7.x/docs/classes/IdentifierMap.html | 298 ++ 7.x/docs/classes/IdentifierSetMultiMap.html | 445 ++ 7.x/docs/classes/IdentityProviderFactory.html | 409 ++ .../classes/IdentityProviderHttpHandler.html | 213 + .../classes/ImmutableMetadataPatcher.html | 218 + 7.x/docs/classes/InMemoryDataAccessor.html | 418 ++ .../classes/IndexRepresentationStore.html | 355 ++ 7.x/docs/classes/InitializableHandler.html | 182 + 7.x/docs/classes/Initializer.html | 188 + 7.x/docs/classes/InteractionHandler.html | 175 + 7.x/docs/classes/InteractionRouteHandler.html | 213 + .../classes/IntermediateCreateExtractor.html | 224 + 7.x/docs/classes/InternalServerError.html | 228 + 7.x/docs/classes/JsonConversionHandler.html | 204 + 7.x/docs/classes/JsonFileStorage.html | 302 ++ 7.x/docs/classes/JsonInteractionHandler.html | 210 + .../classes/JsonLdNotificationSerializer.html | 171 + 7.x/docs/classes/JsonResourceStorage.html | 332 ++ 7.x/docs/classes/KeyExtractor.html | 200 + 7.x/docs/classes/KeyValueChannelStorage.html | 299 ++ 7.x/docs/classes/LazyLoggerFactory.html | 173 + 7.x/docs/classes/LinkMetadataGenerator.html | 201 + 7.x/docs/classes/LinkRelMetadataWriter.html | 203 + 7.x/docs/classes/LinkRelObject.html | 195 + 7.x/docs/classes/LinkRelParser.html | 212 + 7.x/docs/classes/LinkWebIdHandler.html | 253 ++ .../classes/ListeningActivityHandler.html | 224 + .../classes/LocationInteractionHandler.html | 210 + .../classes/LockingInteractionHandler.html | 209 + 7.x/docs/classes/LockingResourceStore.html | 441 ++ 7.x/docs/classes/LoggerInitializer.html | 182 + 7.x/docs/classes/LogoutHandler.html | 191 + 7.x/docs/classes/MappedMetadataWriter.html | 196 + 7.x/docs/classes/MarkdownToHtmlConverter.html | 230 + 7.x/docs/classes/MaxKeyLengthStorage.html | 319 ++ 7.x/docs/classes/MemoryMapStorage.html | 227 + 7.x/docs/classes/MemoryResourceLocker.html | 199 + 7.x/docs/classes/MetadataGenerator.html | 173 + 7.x/docs/classes/MetadataParser.html | 195 + 7.x/docs/classes/MetadataWriter.html | 186 + 7.x/docs/classes/MethodFilterHandler.html | 233 + 7.x/docs/classes/MethodModesExtractor.html | 198 + .../classes/MethodNotAllowedHttpError.html | 238 + 7.x/docs/classes/ModesExtractor.html | 178 + 7.x/docs/classes/ModifiedMetadataWriter.html | 176 + 7.x/docs/classes/ModuleVersionVerifier.html | 193 + 7.x/docs/classes/MonitoringStore.html | 1082 +++++ .../classes/MovedPermanentlyHttpError.html | 239 + 7.x/docs/classes/N3PatchBodyParser.html | 265 ++ 7.x/docs/classes/N3PatchModesExtractor.html | 201 + 7.x/docs/classes/N3Patcher.html | 244 + .../classes/NoCheckOwnershipValidator.html | 193 + 7.x/docs/classes/NotFoundHttpError.html | 228 + 7.x/docs/classes/NotImplementedHttpError.html | 229 + 7.x/docs/classes/NotificationDescriber.html | 203 + 7.x/docs/classes/NotificationEmitter.html | 174 + 7.x/docs/classes/NotificationGenerator.html | 176 + 7.x/docs/classes/NotificationHandler.html | 174 + 7.x/docs/classes/NotificationSerializer.html | 176 + 7.x/docs/classes/NotificationSubscriber.html | 259 ++ .../classes/NotificationUnsubscriber.html | 198 + 7.x/docs/classes/OAuthHttpError.html | 270 ++ 7.x/docs/classes/OidcControlHandler.html | 256 ++ 7.x/docs/classes/OidcHttpHandler.html | 197 + 7.x/docs/classes/OkResponseDescription.html | 140 + 7.x/docs/classes/OperationHandler.html | 178 + 7.x/docs/classes/OperationHttpHandler.html | 181 + 7.x/docs/classes/OperationRouterHandler.html | 243 + 7.x/docs/classes/OriginalUrlExtractor.html | 206 + 7.x/docs/classes/OwnerMetadataWriter.html | 211 + 7.x/docs/classes/OwnerPermissionReader.html | 253 ++ 7.x/docs/classes/OwnershipValidator.html | 185 + 7.x/docs/classes/ParallelHandler.html | 204 + 7.x/docs/classes/ParentContainerReader.html | 288 ++ 7.x/docs/classes/ParsingHttpHandler.html | 260 ++ 7.x/docs/classes/PartialReadWriteLocker.html | 309 ++ 7.x/docs/classes/PassthroughAdapter.html | 248 + .../classes/PassthroughAdapterFactory.html | 140 + 7.x/docs/classes/PassthroughConverter.html | 171 + 7.x/docs/classes/PassthroughDataAccessor.html | 338 ++ .../classes/PassthroughKeyValueStorage.html | 281 ++ 7.x/docs/classes/PassthroughStore.html | 321 ++ 7.x/docs/classes/PasswordLoginHandler.html | 278 ++ 7.x/docs/classes/PatchHandler.html | 183 + 7.x/docs/classes/PatchOperationHandler.html | 198 + 7.x/docs/classes/PatchingStore.html | 324 ++ 7.x/docs/classes/PathBasedReader.html | 246 + .../classes/PermissionBasedAuthorizer.html | 288 ++ 7.x/docs/classes/PermissionReader.html | 182 + 7.x/docs/classes/PickWebIdHandler.html | 232 + 7.x/docs/classes/PlainJsonLdFilter.html | 216 + 7.x/docs/classes/PodCreator.html | 173 + 7.x/docs/classes/PodQuotaStrategy.html | 262 ++ .../classes/PodStorageLocationStrategy.html | 140 + 7.x/docs/classes/PostOperationHandler.html | 198 + .../classes/PreconditionFailedHttpError.html | 228 + 7.x/docs/classes/PreferenceParser.html | 183 + 7.x/docs/classes/PreferenceSupport.html | 146 + 7.x/docs/classes/ProcessHandler.html | 251 + 7.x/docs/classes/PromptFactory.html | 173 + 7.x/docs/classes/PromptHandler.html | 203 + .../classes/PublicCredentialsExtractor.html | 164 + 7.x/docs/classes/PutOperationHandler.html | 207 + 7.x/docs/classes/QuadToRdfConverter.html | 230 + 7.x/docs/classes/QuotaStrategy.html | 224 + 7.x/docs/classes/QuotaValidator.html | 190 + 7.x/docs/classes/RangeMetadataWriter.html | 195 + .../classes/RangeNotSatisfiedHttpError.html | 237 + 7.x/docs/classes/RangePreferenceParser.html | 181 + 7.x/docs/classes/RawBodyParser.html | 183 + 7.x/docs/classes/RdfPatcher.html | 198 + 7.x/docs/classes/RdfStorePatcher.html | 171 + 7.x/docs/classes/RdfToQuadConverter.html | 231 + 7.x/docs/classes/RdfValidator.html | 191 + 7.x/docs/classes/ReadOnlyStore.html | 313 ++ 7.x/docs/classes/RecordObject.html | 105 + 7.x/docs/classes/RedirectHttpError.html | 279 ++ 7.x/docs/classes/RedirectingErrorHandler.html | 172 + 7.x/docs/classes/RedirectingHttpHandler.html | 286 ++ 7.x/docs/classes/RedisLocker.html | 488 ++ 7.x/docs/classes/RegexRouterRule.html | 256 ++ 7.x/docs/classes/RegexRule.html | 118 + .../classes/RelativePathInteractionRoute.html | 188 + 7.x/docs/classes/RepresentationConverter.html | 177 + .../RepresentationConvertingStore.html | 379 ++ 7.x/docs/classes/RepresentationMetadata.html | 766 ++++ .../classes/RepresentationPatchHandler.html | 200 + 7.x/docs/classes/RepresentationPatcher.html | 187 + 7.x/docs/classes/RequestParser.html | 173 + 7.x/docs/classes/ResetPasswordHandler.html | 242 + .../classes/ResetResponseDescription.html | 124 + 7.x/docs/classes/ResolveLoginHandler.html | 258 ++ 7.x/docs/classes/ResponseDescription.html | 142 + 7.x/docs/classes/ResponseWriter.html | 188 + 7.x/docs/classes/RootFilePathHandler.html | 206 + .../classes/RootStorageLocationStrategy.html | 133 + 7.x/docs/classes/RouterHandler.html | 251 + 7.x/docs/classes/RouterRule.html | 191 + .../RoutingAuxiliaryIdentifierStrategy.html | 227 + .../classes/RoutingAuxiliaryStrategy.html | 334 ++ 7.x/docs/classes/RoutingResourceStore.html | 322 ++ 7.x/docs/classes/SafeErrorHandler.html | 207 + .../classes/SeededAccountInitializer.html | 212 + 7.x/docs/classes/SequenceHandler.html | 206 + 7.x/docs/classes/ServerConfigurator.html | 174 + 7.x/docs/classes/ServerInitializer.html | 229 + 7.x/docs/classes/ShorthandExtractor.html | 175 + 7.x/docs/classes/ShorthandResolver.html | 175 + .../classes/SingleContainerJsonStorage.html | 334 ++ .../classes/SingleRootIdentifierStrategy.html | 213 + 7.x/docs/classes/SliceStream.html | 4044 +++++++++++++++++ 7.x/docs/classes/SlugParser.html | 198 + 7.x/docs/classes/SparqlDataAccessor.html | 607 +++ 7.x/docs/classes/SparqlUpdateBodyParser.html | 184 + .../classes/SparqlUpdateModesExtractor.html | 304 ++ 7.x/docs/classes/SparqlUpdatePatcher.html | 311 ++ 7.x/docs/classes/StateHandler.html | 185 + .../classes/StateNotificationGenerator.html | 200 + 7.x/docs/classes/StaticAssetEntry.html | 119 + 7.x/docs/classes/StaticAssetHandler.html | 283 ++ 7.x/docs/classes/StaticFolderGenerator.html | 156 + 7.x/docs/classes/StaticHandler.html | 197 + .../classes/StaticInteractionHandler.html | 185 + 7.x/docs/classes/StaticStorageDescriber.html | 208 + 7.x/docs/classes/StaticTemplateEngine.html | 218 + 7.x/docs/classes/StaticThrowHandler.html | 182 + 7.x/docs/classes/StorageDescriber.html | 174 + .../classes/StorageDescriptionAdvertiser.html | 208 + .../classes/StorageDescriptionHandler.html | 228 + .../classes/StreamingHttp2023Emitter.html | 199 + ...StreamingHttpListeningActivityHandler.html | 223 + 7.x/docs/classes/StreamingHttpMap.html | 456 ++ .../classes/StreamingHttpMetadataWriter.html | 212 + .../classes/StreamingHttpRequestHandler.html | 269 ++ .../SubdomainExtensionBasedMapper.html | 551 +++ .../classes/SubdomainIdentifierGenerator.html | 167 + .../classes/SubdomainIdentifierStrategy.html | 220 + .../classes/SubfolderResourcesGenerator.html | 167 + .../SuffixAuxiliaryIdentifierStrategy.html | 218 + .../classes/SuffixIdentifierGenerator.html | 159 + 7.x/docs/classes/TargetExtractor.html | 182 + .../classes/TargetExtractorErrorHandler.html | 199 + 7.x/docs/classes/TemplateEngine.html | 186 + 7.x/docs/classes/TemplatedPodGenerator.html | 211 + 7.x/docs/classes/TokenOwnershipValidator.html | 287 ++ .../classes/TypedNotificationHandler.html | 199 + .../classes/TypedRepresentationConverter.html | 192 + 7.x/docs/classes/UnauthorizedHttpError.html | 228 + .../classes/UnionCredentialsExtractor.html | 259 ++ 7.x/docs/classes/UnionHandler.html | 280 ++ 7.x/docs/classes/UnionPermissionReader.html | 271 ++ 7.x/docs/classes/UnionPreferenceParser.html | 243 + 7.x/docs/classes/UnlinkWebIdHandler.html | 199 + .../UnsecureConstantCredentialsExtractor.html | 201 + 7.x/docs/classes/UnsecureWebIdExtractor.html | 183 + .../classes/UnsecureWebSocketsProtocol.html | 227 + 7.x/docs/classes/UnsupportedAsyncHandler.html | 174 + .../UnsupportedMediaTypeHttpError.html | 228 + 7.x/docs/classes/UpdateOwnerHandler.html | 240 + 7.x/docs/classes/UpdatePasswordHandler.html | 221 + 7.x/docs/classes/V6MigrationInitializer.html | 331 ++ 7.x/docs/classes/ValidatingDataAccessor.html | 343 ++ 7.x/docs/classes/Validator.html | 174 + 7.x/docs/classes/VariableHandler.html | 193 + 7.x/docs/classes/VariableSetter.html | 222 + 7.x/docs/classes/VersionHandler.html | 191 + 7.x/docs/classes/ViewInteractionHandler.html | 194 + 7.x/docs/classes/VoidLocker.html | 217 + 7.x/docs/classes/VoidLogger.html | 245 + 7.x/docs/classes/VoidLoggerFactory.html | 133 + 7.x/docs/classes/WacAllowHttpHandler.html | 243 + 7.x/docs/classes/WacAllowMetadataWriter.html | 213 + 7.x/docs/classes/WaterfallHandler.html | 220 + 7.x/docs/classes/WebAclReader.html | 389 ++ 7.x/docs/classes/WebSocket2023Emitter.html | 199 + 7.x/docs/classes/WebSocket2023Handler.html | 173 + 7.x/docs/classes/WebSocket2023Listener.html | 216 + 7.x/docs/classes/WebSocket2023Storer.html | 226 + 7.x/docs/classes/WebSocketAdvertiser.html | 193 + .../classes/WebSocketChannel2023Type.html | 336 ++ 7.x/docs/classes/WebSocketHandler.html | 174 + 7.x/docs/classes/WebSocketMap.html | 456 ++ .../classes/WebSocketServerConfigurator.html | 198 + 7.x/docs/classes/WebhookChannel2023Type.html | 366 ++ 7.x/docs/classes/WebhookEmitter.html | 229 + 7.x/docs/classes/WebhookWebId.html | 192 + 7.x/docs/classes/WinstonLogger.html | 282 ++ 7.x/docs/classes/WinstonLoggerFactory.html | 167 + 7.x/docs/classes/WorkerManager.html | 182 + .../WrappedExpiringReadWriteLocker.html | 289 ++ 7.x/docs/classes/WrappedExpiringStorage.html | 390 ++ 7.x/docs/classes/WrappedIndexedStorage.html | 1018 +++++ 7.x/docs/classes/WrappedSetMultiMap.html | 486 ++ 7.x/docs/classes/WrappingLogger.html | 283 ++ 7.x/docs/classes/WwwAuthMetadataWriter.html | 195 + 7.x/docs/classes/YargsCliExtractor.html | 227 + 7.x/docs/classes/YargsParameter.html | 128 + 7.x/docs/enums/AccessMode.html | 113 + 7.x/docs/enums/AclMode.html | 81 + 7.x/docs/functions/absoluteFilePath.html | 79 + 7.x/docs/functions/addGeneratedResources.html | 87 + 7.x/docs/functions/addHeader.html | 77 + 7.x/docs/functions/addResourceMetadata.html | 81 + 7.x/docs/functions/addTemplateMetadata.html | 86 + 7.x/docs/functions/allFulfilled.html | 81 + 7.x/docs/functions/assertAccountId.html | 73 + 7.x/docs/functions/assertOidcInteraction.html | 78 + 7.x/docs/functions/assertReadConditions.html | 94 + 7.x/docs/functions/asyncToArray.html | 78 + 7.x/docs/functions/cleanPreferences.html | 79 + 7.x/docs/functions/cloneRepresentation.html | 78 + 7.x/docs/functions/concat.html | 81 + 7.x/docs/functions/createAggregateError.html | 78 + 7.x/docs/functions/createErrorMessage.html | 73 + .../createGenericEventEmitterClass.html | 81 + 7.x/docs/functions/createSubdomainRegexp.html | 85 + 7.x/docs/functions/createVocabulary.html | 84 + .../functions/decodeUriPathComponents.html | 80 + .../functions/encodeUriPathComponents.html | 79 + 7.x/docs/functions/endOfStream.html | 70 + 7.x/docs/functions/ensureLeadingSlash.html | 79 + 7.x/docs/functions/ensureTrailingSlash.html | 79 + 7.x/docs/functions/errorTermsToMetadata.html | 83 + 7.x/docs/functions/extendVocabulary.html | 90 + 7.x/docs/functions/extractErrorTerms.html | 79 + 7.x/docs/functions/extractScheme.html | 82 + 7.x/docs/functions/fetchDataset.html | 74 + 7.x/docs/functions/filter.html | 106 + 7.x/docs/functions/filterHandlers.html | 89 + 7.x/docs/functions/find.html | 107 + 7.x/docs/functions/findHandler.html | 90 + 7.x/docs/functions/finishInteraction.html | 86 + 7.x/docs/functions/forgetWebId.html | 83 + 7.x/docs/functions/generateChannel.html | 75 + .../functions/generateHttpErrorClass.html | 86 + 7.x/docs/functions/generateHttpErrorUri.html | 73 + .../generateRedirectHttpErrorClass.html | 82 + 7.x/docs/functions/generateWebSocketUrl.html | 76 + 7.x/docs/functions/getAccessControl.html | 81 + .../functions/getAccessControlResource.html | 81 + .../getAccessControlledResources.html | 76 + 7.x/docs/functions/getBestPreference.html | 84 + 7.x/docs/functions/getConversionTarget.html | 88 + 7.x/docs/functions/getDefault.html | 142 + 7.x/docs/functions/getExtension.html | 77 + 7.x/docs/functions/getLoggerFor.html | 82 + 7.x/docs/functions/getMatcher.html | 81 + 7.x/docs/functions/getModuleRoot.html | 68 + 7.x/docs/functions/getPolicy.html | 81 + 7.x/docs/functions/getRelativeUrl.html | 87 + 7.x/docs/functions/getSingleItem.html | 78 + 7.x/docs/functions/getTemplateFilePath.html | 74 + 7.x/docs/functions/getTypeWeight.html | 83 + .../functions/getWeightedPreferences.html | 84 + 7.x/docs/functions/guardStream.html | 87 + 7.x/docs/functions/guardedStreamFrom.html | 81 + 7.x/docs/functions/hasScheme.html | 82 + 7.x/docs/functions/identifierHashFn.html | 73 + 7.x/docs/functions/importOidcProvider.html | 74 + 7.x/docs/functions/isContainerIdentifier.html | 76 + 7.x/docs/functions/isContainerPath.html | 76 + 7.x/docs/functions/isError.html | 73 + 7.x/docs/functions/isGuarded.html | 78 + 7.x/docs/functions/isHttpRequest.html | 73 + 7.x/docs/functions/isHttpsServer.html | 73 + 7.x/docs/functions/isInternalContentType.html | 78 + 7.x/docs/functions/isPromise.html | 81 + .../functions/isRepresentationMetadata.html | 73 + 7.x/docs/functions/isResourceIdentifier.html | 73 + 7.x/docs/functions/isSystemError.html | 70 + 7.x/docs/functions/isTerm.html | 74 + 7.x/docs/functions/isUrl.html | 77 + 7.x/docs/functions/isValidFileName.html | 77 + 7.x/docs/functions/isValidVariable.html | 74 + .../functions/isWebSocket2023Channel.html | 70 + 7.x/docs/functions/isWebhook2023Channel.html | 70 + 7.x/docs/functions/joinFilePath.html | 82 + 7.x/docs/functions/joinUrl.html | 88 + .../listSingleThreadedComponents.html | 82 + 7.x/docs/functions/map.html | 108 + .../functions/matchesAuthorizationScheme.html | 82 + .../functions/matchesMediaPreferences.html | 81 + 7.x/docs/functions/matchesMediaType.html | 83 + 7.x/docs/functions/modify.html | 87 + 7.x/docs/functions/modulePath.html | 74 + 7.x/docs/functions/msToDuration.html | 78 + 7.x/docs/functions/normalizeFilePath.html | 77 + 7.x/docs/functions/parseAccept.html | 83 + 7.x/docs/functions/parseAcceptCharset.html | 83 + 7.x/docs/functions/parseAcceptDateTime.html | 83 + 7.x/docs/functions/parseAcceptEncoding.html | 83 + 7.x/docs/functions/parseAcceptLanguage.html | 83 + 7.x/docs/functions/parseContentType.html | 80 + 7.x/docs/functions/parseForwarded.html | 77 + 7.x/docs/functions/parseLinkHeader.html | 77 + 7.x/docs/functions/parseParameters.html | 88 + 7.x/docs/functions/parsePath.html | 88 + 7.x/docs/functions/parseQuads.html | 82 + 7.x/docs/functions/parseSchema.html | 78 + 7.x/docs/functions/parseWebSocketRequest.html | 81 + 7.x/docs/functions/pipeSafely.html | 105 + 7.x/docs/functions/preferencesToString.html | 76 + 7.x/docs/functions/promiseSome.html | 82 + 7.x/docs/functions/readJsonStream.html | 77 + 7.x/docs/functions/readPackageJson.html | 68 + 7.x/docs/functions/readTemplate.html | 73 + 7.x/docs/functions/readableToQuads.html | 77 + 7.x/docs/functions/readableToString.html | 77 + 7.x/docs/functions/reduce.html | 152 + .../functions/resetInternalLoggerFactory.html | 74 + 7.x/docs/functions/resolveAssetPath.html | 75 + 7.x/docs/functions/resolveModulePath.html | 73 + 7.x/docs/functions/resolvePromiseOrValue.html | 95 + 7.x/docs/functions/responseToDataset.html | 80 + 7.x/docs/functions/sanitizeUrlPart.html | 77 + 7.x/docs/functions/serializeQuads.html | 82 + .../functions/setGlobalLoggerFactory.html | 77 + 7.x/docs/functions/setSafeInterval.html | 100 + 7.x/docs/functions/sortedAsyncMerge.html | 100 + 7.x/docs/functions/splitAndClean.html | 77 + 7.x/docs/functions/splitCommaSeparated.html | 77 + 7.x/docs/functions/termToInt.html | 81 + 7.x/docs/functions/toCanonicalUriPath.html | 80 + 7.x/docs/functions/toComponentsJsType.html | 87 + 7.x/docs/functions/toLiteral.html | 81 + 7.x/docs/functions/toNamedTerm.html | 106 + 7.x/docs/functions/toObjectTerm.html | 115 + 7.x/docs/functions/toPredicateTerm.html | 106 + .../functions/transformQuotedStrings.html | 85 + 7.x/docs/functions/transformSafely.html | 87 + 7.x/docs/functions/trimLeadingSlashes.html | 77 + 7.x/docs/functions/trimTrailingSlashes.html | 77 + 7.x/docs/functions/uniqueQuads.html | 77 + 7.x/docs/functions/updateModifiedDate.html | 81 + 7.x/docs/functions/validateWithError.html | 82 + 7.x/docs/functions/verifyAccountId.html | 82 + 7.x/docs/index.html | 126 + 7.x/docs/interfaces/AccessCheckerArgs.html | 108 + .../interfaces/AccountInitializerArgs.html | 138 + 7.x/docs/interfaces/AccountStore.html | 184 + 7.x/docs/interfaces/AdapterFactory.html | 110 + 7.x/docs/interfaces/AlgJwk.html | 304 ++ 7.x/docs/interfaces/AppRunnerInput.html | 147 + .../interfaces/AsyncTransformOptions.html | 426 ++ 7.x/docs/interfaces/AtomicDataAccessor.html | 347 ++ 7.x/docs/interfaces/AtomicResourceStore.html | 303 ++ 7.x/docs/interfaces/AuthorizerInput.html | 108 + .../AuthorizingHttpHandlerArgs.html | 128 + .../AuxiliaryIdentifierStrategy.html | 204 + 7.x/docs/interfaces/AuxiliaryStrategy.html | 324 ++ 7.x/docs/interfaces/BasePodCreatorArgs.html | 130 + .../interfaces/BaseRouterHandlerArgs.html | 130 + .../interfaces/BaseServerFactoryOptions.html | 123 + .../interfaces/BasicConditionsOptions.html | 106 + .../interfaces/BasicRequestParserArgs.html | 117 + 7.x/docs/interfaces/BodyParserArgs.html | 99 + 7.x/docs/interfaces/CliOptions.html | 106 + 7.x/docs/interfaces/ClientCredentials.html | 113 + .../interfaces/ClientCredentialsStore.html | 223 + 7.x/docs/interfaces/ComponentsJsFactory.html | 128 + .../ComposedNotificationHandlerArgs.html | 106 + 7.x/docs/interfaces/Conditions.html | 159 + .../interfaces/ConstantConverterOptions.html | 132 + .../interfaces/ContainerInitializerArgs.html | 138 + 7.x/docs/interfaces/ConvertingStoreEntry.html | 92 + 7.x/docs/interfaces/CookieStore.html | 192 + 7.x/docs/interfaces/DataAccessor.html | 346 ++ 7.x/docs/interfaces/ETagHandler.html | 183 + 7.x/docs/interfaces/EmailArgs.html | 106 + 7.x/docs/interfaces/EmailSenderArgs.html | 106 + 7.x/docs/interfaces/ErrorHandlerArgs.html | 92 + .../interfaces/ExpiringReadWriteLocker.html | 203 + 7.x/docs/interfaces/ExpiringStorage.html | 260 ++ 7.x/docs/interfaces/FileIdentifierMapper.html | 158 + .../FileIdentifierMapperFactory.html | 114 + 7.x/docs/interfaces/Finalizable.html | 105 + .../interfaces/ForgotPasswordHandlerArgs.html | 133 + 7.x/docs/interfaces/ForgotPasswordStore.html | 169 + 7.x/docs/interfaces/Forwarded.html | 122 + 7.x/docs/interfaces/GenericEventEmitter.html | 446 ++ 7.x/docs/interfaces/HttpErrorClass.html | 153 + 7.x/docs/interfaces/HttpErrorOptions.html | 103 + 7.x/docs/interfaces/HttpHandlerInput.html | 94 + 7.x/docs/interfaces/HttpServerFactory.html | 101 + 7.x/docs/interfaces/IdentifierGenerator.html | 135 + 7.x/docs/interfaces/IdentifierStrategy.html | 191 + .../IdentityProviderFactoryArgs.html | 188 + .../IdentityProviderHttpHandlerArgs.html | 108 + 7.x/docs/interfaces/IndexedStorage.html | 507 +++ 7.x/docs/interfaces/Initializable.html | 104 + .../interfaces/InteractionHandlerInput.html | 109 + 7.x/docs/interfaces/InteractionRoute.html | 150 + .../JsonInteractionHandlerInput.html | 139 + 7.x/docs/interfaces/JsonRepresentation.html | 103 + 7.x/docs/interfaces/JsonView.html | 117 + 7.x/docs/interfaces/JwkGenerator.html | 131 + 7.x/docs/interfaces/KeyValueStorage.html | 224 + 7.x/docs/interfaces/LinkWebIdHandlerArgs.html | 139 + 7.x/docs/interfaces/LogMetadata.html | 98 + 7.x/docs/interfaces/Logger.html | 284 ++ 7.x/docs/interfaces/LoggerFactory.html | 114 + 7.x/docs/interfaces/LoginStorage.html | 524 +++ 7.x/docs/interfaces/MetadataWriterInput.html | 92 + 7.x/docs/interfaces/NotificationChannel.html | 209 + .../NotificationChannelStorage.html | 222 + .../interfaces/NotificationChannelType.html | 218 + .../interfaces/NotificationEmitterInput.html | 92 + .../interfaces/NotificationHandlerInput.html | 106 + .../NotificationSerializerInput.html | 92 + .../NotificationSubscriberArgs.html | 151 + 7.x/docs/interfaces/OAuthErrorFields.html | 113 + 7.x/docs/interfaces/Operation.html | 132 + .../interfaces/OperationHandlerInput.html | 85 + .../interfaces/OperationHttpHandlerInput.html | 103 + .../interfaces/OriginalUrlExtractorArgs.html | 98 + .../interfaces/ParsingHttpHandlerArgs.html | 118 + .../interfaces/PasswordLoginHandlerArgs.html | 99 + 7.x/docs/interfaces/PasswordStore.html | 318 ++ 7.x/docs/interfaces/Patch.html | 133 + .../interfaces/PermissionReaderInput.html | 99 + 7.x/docs/interfaces/PodCreatorInput.html | 122 + 7.x/docs/interfaces/PodCreatorOutput.html | 118 + 7.x/docs/interfaces/PodGenerator.html | 116 + 7.x/docs/interfaces/PodManager.html | 119 + 7.x/docs/interfaces/PodSettings.html | 145 + 7.x/docs/interfaces/PodStore.html | 300 ++ 7.x/docs/interfaces/ProviderFactory.html | 106 + 7.x/docs/interfaces/RdfStorePatcherInput.html | 110 + 7.x/docs/interfaces/ReadWriteLocker.html | 179 + .../interfaces/RedirectHttpErrorClass.html | 161 + 7.x/docs/interfaces/RedisSettings.html | 106 + 7.x/docs/interfaces/Representation.html | 131 + .../RepresentationConverterArgs.html | 108 + .../RepresentationPatcherInput.html | 104 + .../interfaces/RepresentationPreferences.html | 133 + 7.x/docs/interfaces/Resource.html | 92 + 7.x/docs/interfaces/ResourceIdentifier.html | 92 + 7.x/docs/interfaces/ResourceLink.html | 118 + 7.x/docs/interfaces/ResourceLocker.html | 145 + 7.x/docs/interfaces/ResourceSet.html | 115 + 7.x/docs/interfaces/ResourceStore.html | 311 ++ 7.x/docs/interfaces/ResourcesGenerator.html | 120 + 7.x/docs/interfaces/RouterHandlerArgs.html | 136 + .../SeededAccountInitializerArgs.html | 118 + 7.x/docs/interfaces/SetMultiMap.html | 474 ++ 7.x/docs/interfaces/SimpleLogger.html | 123 + 7.x/docs/interfaces/SingleThreaded.html | 76 + 7.x/docs/interfaces/Size.html | 96 + 7.x/docs/interfaces/SizeReporter.html | 196 + 7.x/docs/interfaces/SliceStreamOptions.html | 432 ++ 7.x/docs/interfaces/SparqlUpdatePatch.html | 141 + .../interfaces/StorageLocationStrategy.html | 111 + .../interfaces/StreamingHttpEmitterInput.html | 92 + .../SubfolderResourcesGeneratorArgs.html | 133 + 7.x/docs/interfaces/SubscriptionService.html | 111 + 7.x/docs/interfaces/SystemError.html | 192 + 7.x/docs/interfaces/TemplateEngineInput.html | 101 + 7.x/docs/interfaces/TemplateOptions.html | 106 + 7.x/docs/interfaces/TemplatePath.html | 92 + 7.x/docs/interfaces/TemplateString.html | 85 + .../TemplatedResourcesGenerator.html | 127 + .../V6MigrationInitializerArgs.html | 159 + .../interfaces/WacAllowHttpHandlerArgs.html | 106 + 7.x/docs/interfaces/WebIdStore.html | 221 + .../interfaces/WebSocket2023HandlerInput.html | 92 + 7.x/docs/interfaces/WebSocketChannel2023.html | 217 + .../interfaces/WebSocketHandlerInput.html | 92 + 7.x/docs/interfaces/WebhookChannel2023.html | 217 + 7.x/docs/modules.html | 892 ++++ 7.x/docs/types/AccessMap.html | 64 + 7.x/docs/types/AccountIdKey.html | 61 + 7.x/docs/types/AccountIdRoute.html | 64 + 7.x/docs/types/AccountInteractionResults.html | 69 + 7.x/docs/types/AccountLoginStorage.html | 70 + 7.x/docs/types/AccountSettings.html | 66 + 7.x/docs/types/AclPermissionSet.html | 61 + 7.x/docs/types/ActivityEmitter.html | 65 + 7.x/docs/types/ArrayElement.html | 66 + 7.x/docs/types/AsyncHandlerInput.html | 66 + 7.x/docs/types/AsyncHandlerOutput.html | 66 + 7.x/docs/types/ChangeMap.html | 66 + 7.x/docs/types/ClientCredentialsIdRoute.html | 64 + 7.x/docs/types/CreateTypeObject.html | 70 + 7.x/docs/types/Credentials.html | 84 + 7.x/docs/types/CredentialsIdKey.html | 61 + 7.x/docs/types/EmptyMapConstructor.html | 72 + 7.x/docs/types/EmptyObject.html | 61 + 7.x/docs/types/Expires.html | 73 + 7.x/docs/types/ExtendedRoute.html | 71 + 7.x/docs/types/Guarded.html | 71 + 7.x/docs/types/HttpRequest.html | 64 + 7.x/docs/types/HttpResponse.html | 64 + 7.x/docs/types/IndexRelation.html | 86 + 7.x/docs/types/IndexTypeCollection.html | 69 + 7.x/docs/types/IndexTypeDescription.html | 69 + 7.x/docs/types/IndexedQuery.html | 83 + 7.x/docs/types/Interaction.html | 61 + 7.x/docs/types/Json.html | 64 + 7.x/docs/types/LogLevel.html | 64 + 7.x/docs/types/LoginOutputType.html | 78 + 7.x/docs/types/MapEntry.html | 66 + 7.x/docs/types/MapKey.html | 66 + 7.x/docs/types/MapValue.html | 66 + 7.x/docs/types/MetadataGraph.html | 61 + 7.x/docs/types/MetadataIdentifier.html | 61 + 7.x/docs/types/MetadataRecord.html | 61 + 7.x/docs/types/MetadataValue.html | 61 + 7.x/docs/types/ModifyOptions.html | 82 + 7.x/docs/types/OptionalKey.html | 69 + 7.x/docs/types/PartialVocabulary.html | 80 + 7.x/docs/types/PasswordIdKey.html | 61 + 7.x/docs/types/PasswordIdRoute.html | 64 + 7.x/docs/types/PatchHandlerInput.html | 75 + 7.x/docs/types/PermissionMap.html | 64 + 7.x/docs/types/PermissionSet.html | 64 + 7.x/docs/types/PodIdKey.html | 61 + 7.x/docs/types/PodIdRoute.html | 64 + 7.x/docs/types/PromiseOrValue.html | 66 + 7.x/docs/types/RouteParameter.html | 69 + 7.x/docs/types/StringKey.html | 69 + 7.x/docs/types/Template.html | 61 + 7.x/docs/types/TemplateFileName.html | 61 + 7.x/docs/types/TypeObject.html | 75 + 7.x/docs/types/ValidatorInput.html | 68 + 7.x/docs/types/ValuePreference.html | 72 + 7.x/docs/types/ValuePreferences.html | 76 + 7.x/docs/types/ValueType.html | 69 + 7.x/docs/types/ValueTypeDescription.html | 73 + 7.x/docs/types/VirtualKey.html | 69 + 7.x/docs/types/VirtualObject.html | 71 + 7.x/docs/types/Vocabulary.html | 77 + 7.x/docs/types/VocabularyLocal.html | 69 + 7.x/docs/types/VocabularyTerm.html | 69 + 7.x/docs/types/VocabularyValue.html | 69 + 7.x/docs/types/WebIdLinkKey.html | 61 + 7.x/docs/types/WebIdLinkRoute.html | 64 + 7.x/docs/types/YargsOptions.html | 61 + 7.x/docs/variables/ACCOUNT_ID_KEY.html | 61 + 7.x/docs/variables/ACCOUNT_PROMPT.html | 66 + .../ACCOUNT_SETTINGS_REMEMBER_LOGIN.html | 64 + .../ACCOUNT_STORAGE_DESCRIPTION.html | 66 + 7.x/docs/variables/ACCOUNT_TYPE.html | 61 + 7.x/docs/variables/ACL.html | 61 + 7.x/docs/variables/ACP.html | 61 + 7.x/docs/variables/APPLICATION_JSON.html | 61 + 7.x/docs/variables/APPLICATION_LD_JSON.html | 61 + .../variables/APPLICATION_OCTET_STREAM.html | 61 + .../variables/APPLICATION_SPARQL_UPDATE.html | 61 + .../APPLICATION_X_WWW_FORM_URLENCODED.html | 61 + 7.x/docs/variables/AS.html | 61 + 7.x/docs/variables/AUTH.html | 61 + 7.x/docs/variables/BaseActivityEmitter.html | 72 + ...LIENT_CREDENTIALS_STORAGE_DESCRIPTION.html | 72 + .../CLIENT_CREDENTIALS_STORAGE_TYPE.html | 61 + 7.x/docs/variables/CONTENT_LENGTH.html | 61 + 7.x/docs/variables/CONTENT_LENGTH_TERM.html | 61 + 7.x/docs/variables/CONTENT_TYPE.html | 61 + 7.x/docs/variables/CONTENT_TYPE_TERM.html | 61 + 7.x/docs/variables/DC.html | 61 + 7.x/docs/variables/DEFAULT_CUSTOM_TYPES.html | 70 + .../DEFAULT_NOTIFICATION_FEATURES.html | 64 + .../variables/DEFAULT_SUBSCRIPTION_SHACL.html | 77 + 7.x/docs/variables/FOAF.html | 61 + 7.x/docs/variables/HH.html | 61 + 7.x/docs/variables/HTTP.html | 61 + 7.x/docs/variables/IANA.html | 61 + 7.x/docs/variables/INDEX_ID_KEY.html | 64 + 7.x/docs/variables/INTERNAL_ALL.html | 61 + 7.x/docs/variables/INTERNAL_ERROR.html | 61 + 7.x/docs/variables/INTERNAL_QUADS.html | 61 + 7.x/docs/variables/JSON_LD.html | 61 + 7.x/docs/variables/LDP.html | 61 + 7.x/docs/variables/LOG_LEVELS.html | 61 + 7.x/docs/variables/MA.html | 61 + 7.x/docs/variables/NOTIFY.html | 61 + 7.x/docs/variables/OIDC.html | 61 + .../variables/OWNER_STORAGE_DESCRIPTION.html | 70 + 7.x/docs/variables/OWNER_STORAGE_TYPE.html | 61 + 7.x/docs/variables/PASSWORD_METHOD.html | 64 + .../PASSWORD_STORAGE_DESCRIPTION.html | 72 + 7.x/docs/variables/PASSWORD_STORAGE_TYPE.html | 61 + 7.x/docs/variables/PIM.html | 61 + .../variables/POD_STORAGE_DESCRIPTION.html | 68 + 7.x/docs/variables/POD_STORAGE_TYPE.html | 61 + 7.x/docs/variables/POSIX.html | 61 + 7.x/docs/variables/PREFERRED_PREFIX.html | 61 + 7.x/docs/variables/PREFERRED_PREFIX_TERM.html | 61 + 7.x/docs/variables/RDF.html | 61 + 7.x/docs/variables/RDFS.html | 61 + 7.x/docs/variables/SOLID.html | 61 + 7.x/docs/variables/SOLID_AS.html | 61 + 7.x/docs/variables/SOLID_ERROR.html | 61 + 7.x/docs/variables/SOLID_ERROR_TERM.html | 61 + 7.x/docs/variables/SOLID_HTTP.html | 61 + 7.x/docs/variables/SOLID_META.html | 61 + 7.x/docs/variables/TEMPLATE-1.html | 61 + 7.x/docs/variables/TEMPLATE_VARIABLE.html | 61 + 7.x/docs/variables/TEXT_HTML.html | 61 + 7.x/docs/variables/TEXT_MARKDOWN.html | 61 + 7.x/docs/variables/TEXT_N3.html | 61 + 7.x/docs/variables/TEXT_TURTLE.html | 61 + 7.x/docs/variables/UNIT_BYTES.html | 61 + 7.x/docs/variables/URL_SCHEMA.html | 61 + 7.x/docs/variables/VANN.html | 61 + 7.x/docs/variables/VCARD.html | 61 + .../variables/WEBID_STORAGE_DESCRIPTION.html | 68 + 7.x/docs/variables/WEBID_STORAGE_TYPE.html | 61 + 7.x/docs/variables/XSD.html | 61 + 7.x/docs/variables/modulePathPlaceholder.html | 65 + 825 files changed, 145258 insertions(+) create mode 100644 7.x/docs/.nojekyll create mode 100644 7.x/docs/assets/custom.css create mode 100644 7.x/docs/assets/highlight.css create mode 100644 7.x/docs/assets/main.js create mode 100644 7.x/docs/assets/navigation.js create mode 100644 7.x/docs/assets/search.js create mode 100644 7.x/docs/assets/style.css create mode 100644 7.x/docs/classes/AbsolutePathInteractionRoute.html create mode 100644 7.x/docs/classes/AcceptPreferenceParser.html create mode 100644 7.x/docs/classes/AccessChecker.html create mode 100644 7.x/docs/classes/AccountInitializer.html create mode 100644 7.x/docs/classes/AccountPromptFactory.html create mode 100644 7.x/docs/classes/AcpHeaderHandler.html create mode 100644 7.x/docs/classes/AcpReader.html create mode 100644 7.x/docs/classes/ActivityNotificationGenerator.html create mode 100644 7.x/docs/classes/AddRemoveNotificationGenerator.html create mode 100644 7.x/docs/classes/AgentAccessChecker.html create mode 100644 7.x/docs/classes/AgentClassAccessChecker.html create mode 100644 7.x/docs/classes/AgentGroupAccessChecker.html create mode 100644 7.x/docs/classes/AllStaticReader.html create mode 100644 7.x/docs/classes/AllowAcceptHeaderWriter.html create mode 100644 7.x/docs/classes/App.html create mode 100644 7.x/docs/classes/AppRunner.html create mode 100644 7.x/docs/classes/ArrayUnionHandler.html create mode 100644 7.x/docs/classes/AssetPathExtractor.html create mode 100644 7.x/docs/classes/AsyncHandler.html create mode 100644 7.x/docs/classes/AtomicFileDataAccessor.html create mode 100644 7.x/docs/classes/AuthAuxiliaryReader.html create mode 100644 7.x/docs/classes/AuthorizationParser.html create mode 100644 7.x/docs/classes/AuthorizedRouteHandler.html create mode 100644 7.x/docs/classes/Authorizer.html create mode 100644 7.x/docs/classes/AuthorizingHttpHandler.html create mode 100644 7.x/docs/classes/AuxiliaryLinkMetadataWriter.html create mode 100644 7.x/docs/classes/AuxiliaryReader.html create mode 100644 7.x/docs/classes/BadRequestHttpError.html create mode 100644 7.x/docs/classes/Base64EncodingStorage.html create mode 100644 7.x/docs/classes/BaseAccountIdRoute.html create mode 100644 7.x/docs/classes/BaseAccountStore.html create mode 100644 7.x/docs/classes/BaseChannelType.html create mode 100644 7.x/docs/classes/BaseClientCredentialsIdRoute.html create mode 100644 7.x/docs/classes/BaseClientCredentialsStore.html create mode 100644 7.x/docs/classes/BaseComponentsJsFactory.html create mode 100644 7.x/docs/classes/BaseCookieStore.html create mode 100644 7.x/docs/classes/BaseEmailSender.html create mode 100644 7.x/docs/classes/BaseFileIdentifierMapper.html create mode 100644 7.x/docs/classes/BaseForgotPasswordStore.html create mode 100644 7.x/docs/classes/BaseIdentifierStrategy.html create mode 100644 7.x/docs/classes/BaseLogger.html create mode 100644 7.x/docs/classes/BaseLoginAccountStorage.html create mode 100644 7.x/docs/classes/BasePasswordIdRoute.html create mode 100644 7.x/docs/classes/BasePasswordStore.html create mode 100644 7.x/docs/classes/BasePodCreator.html create mode 100644 7.x/docs/classes/BasePodIdRoute.html create mode 100644 7.x/docs/classes/BasePodStore.html create mode 100644 7.x/docs/classes/BaseReadWriteLocker.html create mode 100644 7.x/docs/classes/BaseResourceStore.html create mode 100644 7.x/docs/classes/BaseResourcesGenerator.html create mode 100644 7.x/docs/classes/BaseRouterHandler.html create mode 100644 7.x/docs/classes/BaseServerFactory.html create mode 100644 7.x/docs/classes/BaseStateHandler.html create mode 100644 7.x/docs/classes/BaseTypedRepresentationConverter.html create mode 100644 7.x/docs/classes/BaseUrlExtractor.html create mode 100644 7.x/docs/classes/BaseUrlHandler.html create mode 100644 7.x/docs/classes/BaseUrlRouterRule.html create mode 100644 7.x/docs/classes/BaseUrlVerifier.html create mode 100644 7.x/docs/classes/BaseWebIdLinkRoute.html create mode 100644 7.x/docs/classes/BaseWebIdStore.html create mode 100644 7.x/docs/classes/BasicConditions.html create mode 100644 7.x/docs/classes/BasicConditionsParser.html create mode 100644 7.x/docs/classes/BasicETagHandler.html create mode 100644 7.x/docs/classes/BasicRepresentation.html create mode 100644 7.x/docs/classes/BasicRequestParser.html create mode 100644 7.x/docs/classes/BasicResponseWriter.html create mode 100644 7.x/docs/classes/BearerWebIdExtractor.html create mode 100644 7.x/docs/classes/BinarySliceResourceStore.html create mode 100644 7.x/docs/classes/BodyParser.html create mode 100644 7.x/docs/classes/BooleanHandler.html create mode 100644 7.x/docs/classes/CachedHandler.html create mode 100644 7.x/docs/classes/CachedJwkGenerator.html create mode 100644 7.x/docs/classes/CachedResourceSet.html create mode 100644 7.x/docs/classes/CancelOidcHandler.html create mode 100644 7.x/docs/classes/ChainedConverter.html create mode 100644 7.x/docs/classes/ChainedTemplateEngine.html create mode 100644 7.x/docs/classes/CliExtractor.html create mode 100644 7.x/docs/classes/CliResolver.html create mode 100644 7.x/docs/classes/ClientCredentialsAdapter.html create mode 100644 7.x/docs/classes/ClientCredentialsAdapterFactory.html create mode 100644 7.x/docs/classes/ClientCredentialsDetailsHandler.html create mode 100644 7.x/docs/classes/ClientIdAdapter.html create mode 100644 7.x/docs/classes/ClientIdAdapterFactory.html create mode 100644 7.x/docs/classes/ClientInfoHandler.html create mode 100644 7.x/docs/classes/ClusterManager.html create mode 100644 7.x/docs/classes/CombinedShorthandResolver.html create mode 100644 7.x/docs/classes/ComposedAuxiliaryStrategy.html create mode 100644 7.x/docs/classes/ComposedNotificationHandler.html create mode 100644 7.x/docs/classes/ConditionalHandler.html create mode 100644 7.x/docs/classes/ConditionsParser.html create mode 100644 7.x/docs/classes/ConfigPodInitializer.html create mode 100644 7.x/docs/classes/ConfigPodManager.html create mode 100644 7.x/docs/classes/ConflictHttpError.html create mode 100644 7.x/docs/classes/ConsentHandler.html create mode 100644 7.x/docs/classes/ConstantConverter.html create mode 100644 7.x/docs/classes/ConstantMetadataWriter.html create mode 100644 7.x/docs/classes/ContainerInitializer.html create mode 100644 7.x/docs/classes/ContainerPathStorage.html create mode 100644 7.x/docs/classes/ContainerToTemplateConverter.html create mode 100644 7.x/docs/classes/ContentLengthParser.html create mode 100644 7.x/docs/classes/ContentTypeMetadataWriter.html create mode 100644 7.x/docs/classes/ContentTypeParser.html create mode 100644 7.x/docs/classes/ContentTypeReplacer.html create mode 100644 7.x/docs/classes/ContextDocumentLoader.html create mode 100644 7.x/docs/classes/ControlHandler.html create mode 100644 7.x/docs/classes/ConvertingErrorHandler.html create mode 100644 7.x/docs/classes/ConvertingNotificationSerializer.html create mode 100644 7.x/docs/classes/ConvertingOperationHttpHandler.html create mode 100644 7.x/docs/classes/ConvertingPatcher.html create mode 100644 7.x/docs/classes/ConvertingRouterRule.html create mode 100644 7.x/docs/classes/CookieInteractionHandler.html create mode 100644 7.x/docs/classes/CookieMetadataWriter.html create mode 100644 7.x/docs/classes/CookieParser.html create mode 100644 7.x/docs/classes/CorsHandler.html create mode 100644 7.x/docs/classes/CreateAccountHandler.html create mode 100644 7.x/docs/classes/CreateClientCredentialsHandler.html create mode 100644 7.x/docs/classes/CreateModesExtractor.html create mode 100644 7.x/docs/classes/CreatePasswordHandler.html create mode 100644 7.x/docs/classes/CreatePodHandler.html create mode 100644 7.x/docs/classes/CreatedResponseDescription.html create mode 100644 7.x/docs/classes/CredentialsExtractor.html create mode 100644 7.x/docs/classes/DPoPWebIdExtractor.html create mode 100644 7.x/docs/classes/DataAccessorBasedStore.html create mode 100644 7.x/docs/classes/DeleteClientCredentialsHandler.html create mode 100644 7.x/docs/classes/DeleteNotificationGenerator.html create mode 100644 7.x/docs/classes/DeleteOperationHandler.html create mode 100644 7.x/docs/classes/DeleteParentExtractor.html create mode 100644 7.x/docs/classes/DeletePasswordHandler.html create mode 100644 7.x/docs/classes/DynamicJsonToTemplateConverter.html create mode 100644 7.x/docs/classes/EjsTemplateEngine.html create mode 100644 7.x/docs/classes/EmailSender.html create mode 100644 7.x/docs/classes/EqualReadWriteLocker.html create mode 100644 7.x/docs/classes/ErrorHandler.html create mode 100644 7.x/docs/classes/ErrorToJsonConverter.html create mode 100644 7.x/docs/classes/ErrorToQuadConverter.html create mode 100644 7.x/docs/classes/ErrorToTemplateConverter.html create mode 100644 7.x/docs/classes/ExpiringAdapter.html create mode 100644 7.x/docs/classes/ExpiringAdapterFactory.html create mode 100644 7.x/docs/classes/ExtensionBasedMapper.html create mode 100644 7.x/docs/classes/ExtensionBasedMapperFactory.html create mode 100644 7.x/docs/classes/ExtensionBasedTemplateEngine.html create mode 100644 7.x/docs/classes/FileDataAccessor.html create mode 100644 7.x/docs/classes/FileSizeReporter.html create mode 100644 7.x/docs/classes/FileSystemResourceLocker.html create mode 100644 7.x/docs/classes/FilterMetadataDataAccessor.html create mode 100644 7.x/docs/classes/FilterPattern.html create mode 100644 7.x/docs/classes/FinalizableHandler.html create mode 100644 7.x/docs/classes/Finalizer.html create mode 100644 7.x/docs/classes/FixedContentTypeMapper.html create mode 100644 7.x/docs/classes/ForbiddenHttpError.html create mode 100644 7.x/docs/classes/ForgetWebIdHandler.html create mode 100644 7.x/docs/classes/ForgotPasswordHandler.html create mode 100644 7.x/docs/classes/FormToJsonConverter.html create mode 100644 7.x/docs/classes/FoundHttpError.html create mode 100644 7.x/docs/classes/GeneratedPodManager.html create mode 100644 7.x/docs/classes/GetOperationHandler.html create mode 100644 7.x/docs/classes/GlobalQuotaStrategy.html create mode 100644 7.x/docs/classes/GreedyReadWriteLocker.html create mode 100644 7.x/docs/classes/HandlebarsTemplateEngine.html create mode 100644 7.x/docs/classes/HandlerServerConfigurator.html create mode 100644 7.x/docs/classes/HashEncodingStorage.html create mode 100644 7.x/docs/classes/HashMap.html create mode 100644 7.x/docs/classes/HeadOperationHandler.html create mode 100644 7.x/docs/classes/HeaderHandler.html create mode 100644 7.x/docs/classes/HtmlViewEntry.html create mode 100644 7.x/docs/classes/HtmlViewHandler.html create mode 100644 7.x/docs/classes/HttpError.html create mode 100644 7.x/docs/classes/HttpHandler.html create mode 100644 7.x/docs/classes/IdInteractionRoute.html create mode 100644 7.x/docs/classes/IdentifierMap.html create mode 100644 7.x/docs/classes/IdentifierSetMultiMap.html create mode 100644 7.x/docs/classes/IdentityProviderFactory.html create mode 100644 7.x/docs/classes/IdentityProviderHttpHandler.html create mode 100644 7.x/docs/classes/ImmutableMetadataPatcher.html create mode 100644 7.x/docs/classes/InMemoryDataAccessor.html create mode 100644 7.x/docs/classes/IndexRepresentationStore.html create mode 100644 7.x/docs/classes/InitializableHandler.html create mode 100644 7.x/docs/classes/Initializer.html create mode 100644 7.x/docs/classes/InteractionHandler.html create mode 100644 7.x/docs/classes/InteractionRouteHandler.html create mode 100644 7.x/docs/classes/IntermediateCreateExtractor.html create mode 100644 7.x/docs/classes/InternalServerError.html create mode 100644 7.x/docs/classes/JsonConversionHandler.html create mode 100644 7.x/docs/classes/JsonFileStorage.html create mode 100644 7.x/docs/classes/JsonInteractionHandler.html create mode 100644 7.x/docs/classes/JsonLdNotificationSerializer.html create mode 100644 7.x/docs/classes/JsonResourceStorage.html create mode 100644 7.x/docs/classes/KeyExtractor.html create mode 100644 7.x/docs/classes/KeyValueChannelStorage.html create mode 100644 7.x/docs/classes/LazyLoggerFactory.html create mode 100644 7.x/docs/classes/LinkMetadataGenerator.html create mode 100644 7.x/docs/classes/LinkRelMetadataWriter.html create mode 100644 7.x/docs/classes/LinkRelObject.html create mode 100644 7.x/docs/classes/LinkRelParser.html create mode 100644 7.x/docs/classes/LinkWebIdHandler.html create mode 100644 7.x/docs/classes/ListeningActivityHandler.html create mode 100644 7.x/docs/classes/LocationInteractionHandler.html create mode 100644 7.x/docs/classes/LockingInteractionHandler.html create mode 100644 7.x/docs/classes/LockingResourceStore.html create mode 100644 7.x/docs/classes/LoggerInitializer.html create mode 100644 7.x/docs/classes/LogoutHandler.html create mode 100644 7.x/docs/classes/MappedMetadataWriter.html create mode 100644 7.x/docs/classes/MarkdownToHtmlConverter.html create mode 100644 7.x/docs/classes/MaxKeyLengthStorage.html create mode 100644 7.x/docs/classes/MemoryMapStorage.html create mode 100644 7.x/docs/classes/MemoryResourceLocker.html create mode 100644 7.x/docs/classes/MetadataGenerator.html create mode 100644 7.x/docs/classes/MetadataParser.html create mode 100644 7.x/docs/classes/MetadataWriter.html create mode 100644 7.x/docs/classes/MethodFilterHandler.html create mode 100644 7.x/docs/classes/MethodModesExtractor.html create mode 100644 7.x/docs/classes/MethodNotAllowedHttpError.html create mode 100644 7.x/docs/classes/ModesExtractor.html create mode 100644 7.x/docs/classes/ModifiedMetadataWriter.html create mode 100644 7.x/docs/classes/ModuleVersionVerifier.html create mode 100644 7.x/docs/classes/MonitoringStore.html create mode 100644 7.x/docs/classes/MovedPermanentlyHttpError.html create mode 100644 7.x/docs/classes/N3PatchBodyParser.html create mode 100644 7.x/docs/classes/N3PatchModesExtractor.html create mode 100644 7.x/docs/classes/N3Patcher.html create mode 100644 7.x/docs/classes/NoCheckOwnershipValidator.html create mode 100644 7.x/docs/classes/NotFoundHttpError.html create mode 100644 7.x/docs/classes/NotImplementedHttpError.html create mode 100644 7.x/docs/classes/NotificationDescriber.html create mode 100644 7.x/docs/classes/NotificationEmitter.html create mode 100644 7.x/docs/classes/NotificationGenerator.html create mode 100644 7.x/docs/classes/NotificationHandler.html create mode 100644 7.x/docs/classes/NotificationSerializer.html create mode 100644 7.x/docs/classes/NotificationSubscriber.html create mode 100644 7.x/docs/classes/NotificationUnsubscriber.html create mode 100644 7.x/docs/classes/OAuthHttpError.html create mode 100644 7.x/docs/classes/OidcControlHandler.html create mode 100644 7.x/docs/classes/OidcHttpHandler.html create mode 100644 7.x/docs/classes/OkResponseDescription.html create mode 100644 7.x/docs/classes/OperationHandler.html create mode 100644 7.x/docs/classes/OperationHttpHandler.html create mode 100644 7.x/docs/classes/OperationRouterHandler.html create mode 100644 7.x/docs/classes/OriginalUrlExtractor.html create mode 100644 7.x/docs/classes/OwnerMetadataWriter.html create mode 100644 7.x/docs/classes/OwnerPermissionReader.html create mode 100644 7.x/docs/classes/OwnershipValidator.html create mode 100644 7.x/docs/classes/ParallelHandler.html create mode 100644 7.x/docs/classes/ParentContainerReader.html create mode 100644 7.x/docs/classes/ParsingHttpHandler.html create mode 100644 7.x/docs/classes/PartialReadWriteLocker.html create mode 100644 7.x/docs/classes/PassthroughAdapter.html create mode 100644 7.x/docs/classes/PassthroughAdapterFactory.html create mode 100644 7.x/docs/classes/PassthroughConverter.html create mode 100644 7.x/docs/classes/PassthroughDataAccessor.html create mode 100644 7.x/docs/classes/PassthroughKeyValueStorage.html create mode 100644 7.x/docs/classes/PassthroughStore.html create mode 100644 7.x/docs/classes/PasswordLoginHandler.html create mode 100644 7.x/docs/classes/PatchHandler.html create mode 100644 7.x/docs/classes/PatchOperationHandler.html create mode 100644 7.x/docs/classes/PatchingStore.html create mode 100644 7.x/docs/classes/PathBasedReader.html create mode 100644 7.x/docs/classes/PermissionBasedAuthorizer.html create mode 100644 7.x/docs/classes/PermissionReader.html create mode 100644 7.x/docs/classes/PickWebIdHandler.html create mode 100644 7.x/docs/classes/PlainJsonLdFilter.html create mode 100644 7.x/docs/classes/PodCreator.html create mode 100644 7.x/docs/classes/PodQuotaStrategy.html create mode 100644 7.x/docs/classes/PodStorageLocationStrategy.html create mode 100644 7.x/docs/classes/PostOperationHandler.html create mode 100644 7.x/docs/classes/PreconditionFailedHttpError.html create mode 100644 7.x/docs/classes/PreferenceParser.html create mode 100644 7.x/docs/classes/PreferenceSupport.html create mode 100644 7.x/docs/classes/ProcessHandler.html create mode 100644 7.x/docs/classes/PromptFactory.html create mode 100644 7.x/docs/classes/PromptHandler.html create mode 100644 7.x/docs/classes/PublicCredentialsExtractor.html create mode 100644 7.x/docs/classes/PutOperationHandler.html create mode 100644 7.x/docs/classes/QuadToRdfConverter.html create mode 100644 7.x/docs/classes/QuotaStrategy.html create mode 100644 7.x/docs/classes/QuotaValidator.html create mode 100644 7.x/docs/classes/RangeMetadataWriter.html create mode 100644 7.x/docs/classes/RangeNotSatisfiedHttpError.html create mode 100644 7.x/docs/classes/RangePreferenceParser.html create mode 100644 7.x/docs/classes/RawBodyParser.html create mode 100644 7.x/docs/classes/RdfPatcher.html create mode 100644 7.x/docs/classes/RdfStorePatcher.html create mode 100644 7.x/docs/classes/RdfToQuadConverter.html create mode 100644 7.x/docs/classes/RdfValidator.html create mode 100644 7.x/docs/classes/ReadOnlyStore.html create mode 100644 7.x/docs/classes/RecordObject.html create mode 100644 7.x/docs/classes/RedirectHttpError.html create mode 100644 7.x/docs/classes/RedirectingErrorHandler.html create mode 100644 7.x/docs/classes/RedirectingHttpHandler.html create mode 100644 7.x/docs/classes/RedisLocker.html create mode 100644 7.x/docs/classes/RegexRouterRule.html create mode 100644 7.x/docs/classes/RegexRule.html create mode 100644 7.x/docs/classes/RelativePathInteractionRoute.html create mode 100644 7.x/docs/classes/RepresentationConverter.html create mode 100644 7.x/docs/classes/RepresentationConvertingStore.html create mode 100644 7.x/docs/classes/RepresentationMetadata.html create mode 100644 7.x/docs/classes/RepresentationPatchHandler.html create mode 100644 7.x/docs/classes/RepresentationPatcher.html create mode 100644 7.x/docs/classes/RequestParser.html create mode 100644 7.x/docs/classes/ResetPasswordHandler.html create mode 100644 7.x/docs/classes/ResetResponseDescription.html create mode 100644 7.x/docs/classes/ResolveLoginHandler.html create mode 100644 7.x/docs/classes/ResponseDescription.html create mode 100644 7.x/docs/classes/ResponseWriter.html create mode 100644 7.x/docs/classes/RootFilePathHandler.html create mode 100644 7.x/docs/classes/RootStorageLocationStrategy.html create mode 100644 7.x/docs/classes/RouterHandler.html create mode 100644 7.x/docs/classes/RouterRule.html create mode 100644 7.x/docs/classes/RoutingAuxiliaryIdentifierStrategy.html create mode 100644 7.x/docs/classes/RoutingAuxiliaryStrategy.html create mode 100644 7.x/docs/classes/RoutingResourceStore.html create mode 100644 7.x/docs/classes/SafeErrorHandler.html create mode 100644 7.x/docs/classes/SeededAccountInitializer.html create mode 100644 7.x/docs/classes/SequenceHandler.html create mode 100644 7.x/docs/classes/ServerConfigurator.html create mode 100644 7.x/docs/classes/ServerInitializer.html create mode 100644 7.x/docs/classes/ShorthandExtractor.html create mode 100644 7.x/docs/classes/ShorthandResolver.html create mode 100644 7.x/docs/classes/SingleContainerJsonStorage.html create mode 100644 7.x/docs/classes/SingleRootIdentifierStrategy.html create mode 100644 7.x/docs/classes/SliceStream.html create mode 100644 7.x/docs/classes/SlugParser.html create mode 100644 7.x/docs/classes/SparqlDataAccessor.html create mode 100644 7.x/docs/classes/SparqlUpdateBodyParser.html create mode 100644 7.x/docs/classes/SparqlUpdateModesExtractor.html create mode 100644 7.x/docs/classes/SparqlUpdatePatcher.html create mode 100644 7.x/docs/classes/StateHandler.html create mode 100644 7.x/docs/classes/StateNotificationGenerator.html create mode 100644 7.x/docs/classes/StaticAssetEntry.html create mode 100644 7.x/docs/classes/StaticAssetHandler.html create mode 100644 7.x/docs/classes/StaticFolderGenerator.html create mode 100644 7.x/docs/classes/StaticHandler.html create mode 100644 7.x/docs/classes/StaticInteractionHandler.html create mode 100644 7.x/docs/classes/StaticStorageDescriber.html create mode 100644 7.x/docs/classes/StaticTemplateEngine.html create mode 100644 7.x/docs/classes/StaticThrowHandler.html create mode 100644 7.x/docs/classes/StorageDescriber.html create mode 100644 7.x/docs/classes/StorageDescriptionAdvertiser.html create mode 100644 7.x/docs/classes/StorageDescriptionHandler.html create mode 100644 7.x/docs/classes/StreamingHttp2023Emitter.html create mode 100644 7.x/docs/classes/StreamingHttpListeningActivityHandler.html create mode 100644 7.x/docs/classes/StreamingHttpMap.html create mode 100644 7.x/docs/classes/StreamingHttpMetadataWriter.html create mode 100644 7.x/docs/classes/StreamingHttpRequestHandler.html create mode 100644 7.x/docs/classes/SubdomainExtensionBasedMapper.html create mode 100644 7.x/docs/classes/SubdomainIdentifierGenerator.html create mode 100644 7.x/docs/classes/SubdomainIdentifierStrategy.html create mode 100644 7.x/docs/classes/SubfolderResourcesGenerator.html create mode 100644 7.x/docs/classes/SuffixAuxiliaryIdentifierStrategy.html create mode 100644 7.x/docs/classes/SuffixIdentifierGenerator.html create mode 100644 7.x/docs/classes/TargetExtractor.html create mode 100644 7.x/docs/classes/TargetExtractorErrorHandler.html create mode 100644 7.x/docs/classes/TemplateEngine.html create mode 100644 7.x/docs/classes/TemplatedPodGenerator.html create mode 100644 7.x/docs/classes/TokenOwnershipValidator.html create mode 100644 7.x/docs/classes/TypedNotificationHandler.html create mode 100644 7.x/docs/classes/TypedRepresentationConverter.html create mode 100644 7.x/docs/classes/UnauthorizedHttpError.html create mode 100644 7.x/docs/classes/UnionCredentialsExtractor.html create mode 100644 7.x/docs/classes/UnionHandler.html create mode 100644 7.x/docs/classes/UnionPermissionReader.html create mode 100644 7.x/docs/classes/UnionPreferenceParser.html create mode 100644 7.x/docs/classes/UnlinkWebIdHandler.html create mode 100644 7.x/docs/classes/UnsecureConstantCredentialsExtractor.html create mode 100644 7.x/docs/classes/UnsecureWebIdExtractor.html create mode 100644 7.x/docs/classes/UnsecureWebSocketsProtocol.html create mode 100644 7.x/docs/classes/UnsupportedAsyncHandler.html create mode 100644 7.x/docs/classes/UnsupportedMediaTypeHttpError.html create mode 100644 7.x/docs/classes/UpdateOwnerHandler.html create mode 100644 7.x/docs/classes/UpdatePasswordHandler.html create mode 100644 7.x/docs/classes/V6MigrationInitializer.html create mode 100644 7.x/docs/classes/ValidatingDataAccessor.html create mode 100644 7.x/docs/classes/Validator.html create mode 100644 7.x/docs/classes/VariableHandler.html create mode 100644 7.x/docs/classes/VariableSetter.html create mode 100644 7.x/docs/classes/VersionHandler.html create mode 100644 7.x/docs/classes/ViewInteractionHandler.html create mode 100644 7.x/docs/classes/VoidLocker.html create mode 100644 7.x/docs/classes/VoidLogger.html create mode 100644 7.x/docs/classes/VoidLoggerFactory.html create mode 100644 7.x/docs/classes/WacAllowHttpHandler.html create mode 100644 7.x/docs/classes/WacAllowMetadataWriter.html create mode 100644 7.x/docs/classes/WaterfallHandler.html create mode 100644 7.x/docs/classes/WebAclReader.html create mode 100644 7.x/docs/classes/WebSocket2023Emitter.html create mode 100644 7.x/docs/classes/WebSocket2023Handler.html create mode 100644 7.x/docs/classes/WebSocket2023Listener.html create mode 100644 7.x/docs/classes/WebSocket2023Storer.html create mode 100644 7.x/docs/classes/WebSocketAdvertiser.html create mode 100644 7.x/docs/classes/WebSocketChannel2023Type.html create mode 100644 7.x/docs/classes/WebSocketHandler.html create mode 100644 7.x/docs/classes/WebSocketMap.html create mode 100644 7.x/docs/classes/WebSocketServerConfigurator.html create mode 100644 7.x/docs/classes/WebhookChannel2023Type.html create mode 100644 7.x/docs/classes/WebhookEmitter.html create mode 100644 7.x/docs/classes/WebhookWebId.html create mode 100644 7.x/docs/classes/WinstonLogger.html create mode 100644 7.x/docs/classes/WinstonLoggerFactory.html create mode 100644 7.x/docs/classes/WorkerManager.html create mode 100644 7.x/docs/classes/WrappedExpiringReadWriteLocker.html create mode 100644 7.x/docs/classes/WrappedExpiringStorage.html create mode 100644 7.x/docs/classes/WrappedIndexedStorage.html create mode 100644 7.x/docs/classes/WrappedSetMultiMap.html create mode 100644 7.x/docs/classes/WrappingLogger.html create mode 100644 7.x/docs/classes/WwwAuthMetadataWriter.html create mode 100644 7.x/docs/classes/YargsCliExtractor.html create mode 100644 7.x/docs/classes/YargsParameter.html create mode 100644 7.x/docs/enums/AccessMode.html create mode 100644 7.x/docs/enums/AclMode.html create mode 100644 7.x/docs/functions/absoluteFilePath.html create mode 100644 7.x/docs/functions/addGeneratedResources.html create mode 100644 7.x/docs/functions/addHeader.html create mode 100644 7.x/docs/functions/addResourceMetadata.html create mode 100644 7.x/docs/functions/addTemplateMetadata.html create mode 100644 7.x/docs/functions/allFulfilled.html create mode 100644 7.x/docs/functions/assertAccountId.html create mode 100644 7.x/docs/functions/assertOidcInteraction.html create mode 100644 7.x/docs/functions/assertReadConditions.html create mode 100644 7.x/docs/functions/asyncToArray.html create mode 100644 7.x/docs/functions/cleanPreferences.html create mode 100644 7.x/docs/functions/cloneRepresentation.html create mode 100644 7.x/docs/functions/concat.html create mode 100644 7.x/docs/functions/createAggregateError.html create mode 100644 7.x/docs/functions/createErrorMessage.html create mode 100644 7.x/docs/functions/createGenericEventEmitterClass.html create mode 100644 7.x/docs/functions/createSubdomainRegexp.html create mode 100644 7.x/docs/functions/createVocabulary.html create mode 100644 7.x/docs/functions/decodeUriPathComponents.html create mode 100644 7.x/docs/functions/encodeUriPathComponents.html create mode 100644 7.x/docs/functions/endOfStream.html create mode 100644 7.x/docs/functions/ensureLeadingSlash.html create mode 100644 7.x/docs/functions/ensureTrailingSlash.html create mode 100644 7.x/docs/functions/errorTermsToMetadata.html create mode 100644 7.x/docs/functions/extendVocabulary.html create mode 100644 7.x/docs/functions/extractErrorTerms.html create mode 100644 7.x/docs/functions/extractScheme.html create mode 100644 7.x/docs/functions/fetchDataset.html create mode 100644 7.x/docs/functions/filter.html create mode 100644 7.x/docs/functions/filterHandlers.html create mode 100644 7.x/docs/functions/find.html create mode 100644 7.x/docs/functions/findHandler.html create mode 100644 7.x/docs/functions/finishInteraction.html create mode 100644 7.x/docs/functions/forgetWebId.html create mode 100644 7.x/docs/functions/generateChannel.html create mode 100644 7.x/docs/functions/generateHttpErrorClass.html create mode 100644 7.x/docs/functions/generateHttpErrorUri.html create mode 100644 7.x/docs/functions/generateRedirectHttpErrorClass.html create mode 100644 7.x/docs/functions/generateWebSocketUrl.html create mode 100644 7.x/docs/functions/getAccessControl.html create mode 100644 7.x/docs/functions/getAccessControlResource.html create mode 100644 7.x/docs/functions/getAccessControlledResources.html create mode 100644 7.x/docs/functions/getBestPreference.html create mode 100644 7.x/docs/functions/getConversionTarget.html create mode 100644 7.x/docs/functions/getDefault.html create mode 100644 7.x/docs/functions/getExtension.html create mode 100644 7.x/docs/functions/getLoggerFor.html create mode 100644 7.x/docs/functions/getMatcher.html create mode 100644 7.x/docs/functions/getModuleRoot.html create mode 100644 7.x/docs/functions/getPolicy.html create mode 100644 7.x/docs/functions/getRelativeUrl.html create mode 100644 7.x/docs/functions/getSingleItem.html create mode 100644 7.x/docs/functions/getTemplateFilePath.html create mode 100644 7.x/docs/functions/getTypeWeight.html create mode 100644 7.x/docs/functions/getWeightedPreferences.html create mode 100644 7.x/docs/functions/guardStream.html create mode 100644 7.x/docs/functions/guardedStreamFrom.html create mode 100644 7.x/docs/functions/hasScheme.html create mode 100644 7.x/docs/functions/identifierHashFn.html create mode 100644 7.x/docs/functions/importOidcProvider.html create mode 100644 7.x/docs/functions/isContainerIdentifier.html create mode 100644 7.x/docs/functions/isContainerPath.html create mode 100644 7.x/docs/functions/isError.html create mode 100644 7.x/docs/functions/isGuarded.html create mode 100644 7.x/docs/functions/isHttpRequest.html create mode 100644 7.x/docs/functions/isHttpsServer.html create mode 100644 7.x/docs/functions/isInternalContentType.html create mode 100644 7.x/docs/functions/isPromise.html create mode 100644 7.x/docs/functions/isRepresentationMetadata.html create mode 100644 7.x/docs/functions/isResourceIdentifier.html create mode 100644 7.x/docs/functions/isSystemError.html create mode 100644 7.x/docs/functions/isTerm.html create mode 100644 7.x/docs/functions/isUrl.html create mode 100644 7.x/docs/functions/isValidFileName.html create mode 100644 7.x/docs/functions/isValidVariable.html create mode 100644 7.x/docs/functions/isWebSocket2023Channel.html create mode 100644 7.x/docs/functions/isWebhook2023Channel.html create mode 100644 7.x/docs/functions/joinFilePath.html create mode 100644 7.x/docs/functions/joinUrl.html create mode 100644 7.x/docs/functions/listSingleThreadedComponents.html create mode 100644 7.x/docs/functions/map.html create mode 100644 7.x/docs/functions/matchesAuthorizationScheme.html create mode 100644 7.x/docs/functions/matchesMediaPreferences.html create mode 100644 7.x/docs/functions/matchesMediaType.html create mode 100644 7.x/docs/functions/modify.html create mode 100644 7.x/docs/functions/modulePath.html create mode 100644 7.x/docs/functions/msToDuration.html create mode 100644 7.x/docs/functions/normalizeFilePath.html create mode 100644 7.x/docs/functions/parseAccept.html create mode 100644 7.x/docs/functions/parseAcceptCharset.html create mode 100644 7.x/docs/functions/parseAcceptDateTime.html create mode 100644 7.x/docs/functions/parseAcceptEncoding.html create mode 100644 7.x/docs/functions/parseAcceptLanguage.html create mode 100644 7.x/docs/functions/parseContentType.html create mode 100644 7.x/docs/functions/parseForwarded.html create mode 100644 7.x/docs/functions/parseLinkHeader.html create mode 100644 7.x/docs/functions/parseParameters.html create mode 100644 7.x/docs/functions/parsePath.html create mode 100644 7.x/docs/functions/parseQuads.html create mode 100644 7.x/docs/functions/parseSchema.html create mode 100644 7.x/docs/functions/parseWebSocketRequest.html create mode 100644 7.x/docs/functions/pipeSafely.html create mode 100644 7.x/docs/functions/preferencesToString.html create mode 100644 7.x/docs/functions/promiseSome.html create mode 100644 7.x/docs/functions/readJsonStream.html create mode 100644 7.x/docs/functions/readPackageJson.html create mode 100644 7.x/docs/functions/readTemplate.html create mode 100644 7.x/docs/functions/readableToQuads.html create mode 100644 7.x/docs/functions/readableToString.html create mode 100644 7.x/docs/functions/reduce.html create mode 100644 7.x/docs/functions/resetInternalLoggerFactory.html create mode 100644 7.x/docs/functions/resolveAssetPath.html create mode 100644 7.x/docs/functions/resolveModulePath.html create mode 100644 7.x/docs/functions/resolvePromiseOrValue.html create mode 100644 7.x/docs/functions/responseToDataset.html create mode 100644 7.x/docs/functions/sanitizeUrlPart.html create mode 100644 7.x/docs/functions/serializeQuads.html create mode 100644 7.x/docs/functions/setGlobalLoggerFactory.html create mode 100644 7.x/docs/functions/setSafeInterval.html create mode 100644 7.x/docs/functions/sortedAsyncMerge.html create mode 100644 7.x/docs/functions/splitAndClean.html create mode 100644 7.x/docs/functions/splitCommaSeparated.html create mode 100644 7.x/docs/functions/termToInt.html create mode 100644 7.x/docs/functions/toCanonicalUriPath.html create mode 100644 7.x/docs/functions/toComponentsJsType.html create mode 100644 7.x/docs/functions/toLiteral.html create mode 100644 7.x/docs/functions/toNamedTerm.html create mode 100644 7.x/docs/functions/toObjectTerm.html create mode 100644 7.x/docs/functions/toPredicateTerm.html create mode 100644 7.x/docs/functions/transformQuotedStrings.html create mode 100644 7.x/docs/functions/transformSafely.html create mode 100644 7.x/docs/functions/trimLeadingSlashes.html create mode 100644 7.x/docs/functions/trimTrailingSlashes.html create mode 100644 7.x/docs/functions/uniqueQuads.html create mode 100644 7.x/docs/functions/updateModifiedDate.html create mode 100644 7.x/docs/functions/validateWithError.html create mode 100644 7.x/docs/functions/verifyAccountId.html create mode 100644 7.x/docs/index.html create mode 100644 7.x/docs/interfaces/AccessCheckerArgs.html create mode 100644 7.x/docs/interfaces/AccountInitializerArgs.html create mode 100644 7.x/docs/interfaces/AccountStore.html create mode 100644 7.x/docs/interfaces/AdapterFactory.html create mode 100644 7.x/docs/interfaces/AlgJwk.html create mode 100644 7.x/docs/interfaces/AppRunnerInput.html create mode 100644 7.x/docs/interfaces/AsyncTransformOptions.html create mode 100644 7.x/docs/interfaces/AtomicDataAccessor.html create mode 100644 7.x/docs/interfaces/AtomicResourceStore.html create mode 100644 7.x/docs/interfaces/AuthorizerInput.html create mode 100644 7.x/docs/interfaces/AuthorizingHttpHandlerArgs.html create mode 100644 7.x/docs/interfaces/AuxiliaryIdentifierStrategy.html create mode 100644 7.x/docs/interfaces/AuxiliaryStrategy.html create mode 100644 7.x/docs/interfaces/BasePodCreatorArgs.html create mode 100644 7.x/docs/interfaces/BaseRouterHandlerArgs.html create mode 100644 7.x/docs/interfaces/BaseServerFactoryOptions.html create mode 100644 7.x/docs/interfaces/BasicConditionsOptions.html create mode 100644 7.x/docs/interfaces/BasicRequestParserArgs.html create mode 100644 7.x/docs/interfaces/BodyParserArgs.html create mode 100644 7.x/docs/interfaces/CliOptions.html create mode 100644 7.x/docs/interfaces/ClientCredentials.html create mode 100644 7.x/docs/interfaces/ClientCredentialsStore.html create mode 100644 7.x/docs/interfaces/ComponentsJsFactory.html create mode 100644 7.x/docs/interfaces/ComposedNotificationHandlerArgs.html create mode 100644 7.x/docs/interfaces/Conditions.html create mode 100644 7.x/docs/interfaces/ConstantConverterOptions.html create mode 100644 7.x/docs/interfaces/ContainerInitializerArgs.html create mode 100644 7.x/docs/interfaces/ConvertingStoreEntry.html create mode 100644 7.x/docs/interfaces/CookieStore.html create mode 100644 7.x/docs/interfaces/DataAccessor.html create mode 100644 7.x/docs/interfaces/ETagHandler.html create mode 100644 7.x/docs/interfaces/EmailArgs.html create mode 100644 7.x/docs/interfaces/EmailSenderArgs.html create mode 100644 7.x/docs/interfaces/ErrorHandlerArgs.html create mode 100644 7.x/docs/interfaces/ExpiringReadWriteLocker.html create mode 100644 7.x/docs/interfaces/ExpiringStorage.html create mode 100644 7.x/docs/interfaces/FileIdentifierMapper.html create mode 100644 7.x/docs/interfaces/FileIdentifierMapperFactory.html create mode 100644 7.x/docs/interfaces/Finalizable.html create mode 100644 7.x/docs/interfaces/ForgotPasswordHandlerArgs.html create mode 100644 7.x/docs/interfaces/ForgotPasswordStore.html create mode 100644 7.x/docs/interfaces/Forwarded.html create mode 100644 7.x/docs/interfaces/GenericEventEmitter.html create mode 100644 7.x/docs/interfaces/HttpErrorClass.html create mode 100644 7.x/docs/interfaces/HttpErrorOptions.html create mode 100644 7.x/docs/interfaces/HttpHandlerInput.html create mode 100644 7.x/docs/interfaces/HttpServerFactory.html create mode 100644 7.x/docs/interfaces/IdentifierGenerator.html create mode 100644 7.x/docs/interfaces/IdentifierStrategy.html create mode 100644 7.x/docs/interfaces/IdentityProviderFactoryArgs.html create mode 100644 7.x/docs/interfaces/IdentityProviderHttpHandlerArgs.html create mode 100644 7.x/docs/interfaces/IndexedStorage.html create mode 100644 7.x/docs/interfaces/Initializable.html create mode 100644 7.x/docs/interfaces/InteractionHandlerInput.html create mode 100644 7.x/docs/interfaces/InteractionRoute.html create mode 100644 7.x/docs/interfaces/JsonInteractionHandlerInput.html create mode 100644 7.x/docs/interfaces/JsonRepresentation.html create mode 100644 7.x/docs/interfaces/JsonView.html create mode 100644 7.x/docs/interfaces/JwkGenerator.html create mode 100644 7.x/docs/interfaces/KeyValueStorage.html create mode 100644 7.x/docs/interfaces/LinkWebIdHandlerArgs.html create mode 100644 7.x/docs/interfaces/LogMetadata.html create mode 100644 7.x/docs/interfaces/Logger.html create mode 100644 7.x/docs/interfaces/LoggerFactory.html create mode 100644 7.x/docs/interfaces/LoginStorage.html create mode 100644 7.x/docs/interfaces/MetadataWriterInput.html create mode 100644 7.x/docs/interfaces/NotificationChannel.html create mode 100644 7.x/docs/interfaces/NotificationChannelStorage.html create mode 100644 7.x/docs/interfaces/NotificationChannelType.html create mode 100644 7.x/docs/interfaces/NotificationEmitterInput.html create mode 100644 7.x/docs/interfaces/NotificationHandlerInput.html create mode 100644 7.x/docs/interfaces/NotificationSerializerInput.html create mode 100644 7.x/docs/interfaces/NotificationSubscriberArgs.html create mode 100644 7.x/docs/interfaces/OAuthErrorFields.html create mode 100644 7.x/docs/interfaces/Operation.html create mode 100644 7.x/docs/interfaces/OperationHandlerInput.html create mode 100644 7.x/docs/interfaces/OperationHttpHandlerInput.html create mode 100644 7.x/docs/interfaces/OriginalUrlExtractorArgs.html create mode 100644 7.x/docs/interfaces/ParsingHttpHandlerArgs.html create mode 100644 7.x/docs/interfaces/PasswordLoginHandlerArgs.html create mode 100644 7.x/docs/interfaces/PasswordStore.html create mode 100644 7.x/docs/interfaces/Patch.html create mode 100644 7.x/docs/interfaces/PermissionReaderInput.html create mode 100644 7.x/docs/interfaces/PodCreatorInput.html create mode 100644 7.x/docs/interfaces/PodCreatorOutput.html create mode 100644 7.x/docs/interfaces/PodGenerator.html create mode 100644 7.x/docs/interfaces/PodManager.html create mode 100644 7.x/docs/interfaces/PodSettings.html create mode 100644 7.x/docs/interfaces/PodStore.html create mode 100644 7.x/docs/interfaces/ProviderFactory.html create mode 100644 7.x/docs/interfaces/RdfStorePatcherInput.html create mode 100644 7.x/docs/interfaces/ReadWriteLocker.html create mode 100644 7.x/docs/interfaces/RedirectHttpErrorClass.html create mode 100644 7.x/docs/interfaces/RedisSettings.html create mode 100644 7.x/docs/interfaces/Representation.html create mode 100644 7.x/docs/interfaces/RepresentationConverterArgs.html create mode 100644 7.x/docs/interfaces/RepresentationPatcherInput.html create mode 100644 7.x/docs/interfaces/RepresentationPreferences.html create mode 100644 7.x/docs/interfaces/Resource.html create mode 100644 7.x/docs/interfaces/ResourceIdentifier.html create mode 100644 7.x/docs/interfaces/ResourceLink.html create mode 100644 7.x/docs/interfaces/ResourceLocker.html create mode 100644 7.x/docs/interfaces/ResourceSet.html create mode 100644 7.x/docs/interfaces/ResourceStore.html create mode 100644 7.x/docs/interfaces/ResourcesGenerator.html create mode 100644 7.x/docs/interfaces/RouterHandlerArgs.html create mode 100644 7.x/docs/interfaces/SeededAccountInitializerArgs.html create mode 100644 7.x/docs/interfaces/SetMultiMap.html create mode 100644 7.x/docs/interfaces/SimpleLogger.html create mode 100644 7.x/docs/interfaces/SingleThreaded.html create mode 100644 7.x/docs/interfaces/Size.html create mode 100644 7.x/docs/interfaces/SizeReporter.html create mode 100644 7.x/docs/interfaces/SliceStreamOptions.html create mode 100644 7.x/docs/interfaces/SparqlUpdatePatch.html create mode 100644 7.x/docs/interfaces/StorageLocationStrategy.html create mode 100644 7.x/docs/interfaces/StreamingHttpEmitterInput.html create mode 100644 7.x/docs/interfaces/SubfolderResourcesGeneratorArgs.html create mode 100644 7.x/docs/interfaces/SubscriptionService.html create mode 100644 7.x/docs/interfaces/SystemError.html create mode 100644 7.x/docs/interfaces/TemplateEngineInput.html create mode 100644 7.x/docs/interfaces/TemplateOptions.html create mode 100644 7.x/docs/interfaces/TemplatePath.html create mode 100644 7.x/docs/interfaces/TemplateString.html create mode 100644 7.x/docs/interfaces/TemplatedResourcesGenerator.html create mode 100644 7.x/docs/interfaces/V6MigrationInitializerArgs.html create mode 100644 7.x/docs/interfaces/WacAllowHttpHandlerArgs.html create mode 100644 7.x/docs/interfaces/WebIdStore.html create mode 100644 7.x/docs/interfaces/WebSocket2023HandlerInput.html create mode 100644 7.x/docs/interfaces/WebSocketChannel2023.html create mode 100644 7.x/docs/interfaces/WebSocketHandlerInput.html create mode 100644 7.x/docs/interfaces/WebhookChannel2023.html create mode 100644 7.x/docs/modules.html create mode 100644 7.x/docs/types/AccessMap.html create mode 100644 7.x/docs/types/AccountIdKey.html create mode 100644 7.x/docs/types/AccountIdRoute.html create mode 100644 7.x/docs/types/AccountInteractionResults.html create mode 100644 7.x/docs/types/AccountLoginStorage.html create mode 100644 7.x/docs/types/AccountSettings.html create mode 100644 7.x/docs/types/AclPermissionSet.html create mode 100644 7.x/docs/types/ActivityEmitter.html create mode 100644 7.x/docs/types/ArrayElement.html create mode 100644 7.x/docs/types/AsyncHandlerInput.html create mode 100644 7.x/docs/types/AsyncHandlerOutput.html create mode 100644 7.x/docs/types/ChangeMap.html create mode 100644 7.x/docs/types/ClientCredentialsIdRoute.html create mode 100644 7.x/docs/types/CreateTypeObject.html create mode 100644 7.x/docs/types/Credentials.html create mode 100644 7.x/docs/types/CredentialsIdKey.html create mode 100644 7.x/docs/types/EmptyMapConstructor.html create mode 100644 7.x/docs/types/EmptyObject.html create mode 100644 7.x/docs/types/Expires.html create mode 100644 7.x/docs/types/ExtendedRoute.html create mode 100644 7.x/docs/types/Guarded.html create mode 100644 7.x/docs/types/HttpRequest.html create mode 100644 7.x/docs/types/HttpResponse.html create mode 100644 7.x/docs/types/IndexRelation.html create mode 100644 7.x/docs/types/IndexTypeCollection.html create mode 100644 7.x/docs/types/IndexTypeDescription.html create mode 100644 7.x/docs/types/IndexedQuery.html create mode 100644 7.x/docs/types/Interaction.html create mode 100644 7.x/docs/types/Json.html create mode 100644 7.x/docs/types/LogLevel.html create mode 100644 7.x/docs/types/LoginOutputType.html create mode 100644 7.x/docs/types/MapEntry.html create mode 100644 7.x/docs/types/MapKey.html create mode 100644 7.x/docs/types/MapValue.html create mode 100644 7.x/docs/types/MetadataGraph.html create mode 100644 7.x/docs/types/MetadataIdentifier.html create mode 100644 7.x/docs/types/MetadataRecord.html create mode 100644 7.x/docs/types/MetadataValue.html create mode 100644 7.x/docs/types/ModifyOptions.html create mode 100644 7.x/docs/types/OptionalKey.html create mode 100644 7.x/docs/types/PartialVocabulary.html create mode 100644 7.x/docs/types/PasswordIdKey.html create mode 100644 7.x/docs/types/PasswordIdRoute.html create mode 100644 7.x/docs/types/PatchHandlerInput.html create mode 100644 7.x/docs/types/PermissionMap.html create mode 100644 7.x/docs/types/PermissionSet.html create mode 100644 7.x/docs/types/PodIdKey.html create mode 100644 7.x/docs/types/PodIdRoute.html create mode 100644 7.x/docs/types/PromiseOrValue.html create mode 100644 7.x/docs/types/RouteParameter.html create mode 100644 7.x/docs/types/StringKey.html create mode 100644 7.x/docs/types/Template.html create mode 100644 7.x/docs/types/TemplateFileName.html create mode 100644 7.x/docs/types/TypeObject.html create mode 100644 7.x/docs/types/ValidatorInput.html create mode 100644 7.x/docs/types/ValuePreference.html create mode 100644 7.x/docs/types/ValuePreferences.html create mode 100644 7.x/docs/types/ValueType.html create mode 100644 7.x/docs/types/ValueTypeDescription.html create mode 100644 7.x/docs/types/VirtualKey.html create mode 100644 7.x/docs/types/VirtualObject.html create mode 100644 7.x/docs/types/Vocabulary.html create mode 100644 7.x/docs/types/VocabularyLocal.html create mode 100644 7.x/docs/types/VocabularyTerm.html create mode 100644 7.x/docs/types/VocabularyValue.html create mode 100644 7.x/docs/types/WebIdLinkKey.html create mode 100644 7.x/docs/types/WebIdLinkRoute.html create mode 100644 7.x/docs/types/YargsOptions.html create mode 100644 7.x/docs/variables/ACCOUNT_ID_KEY.html create mode 100644 7.x/docs/variables/ACCOUNT_PROMPT.html create mode 100644 7.x/docs/variables/ACCOUNT_SETTINGS_REMEMBER_LOGIN.html create mode 100644 7.x/docs/variables/ACCOUNT_STORAGE_DESCRIPTION.html create mode 100644 7.x/docs/variables/ACCOUNT_TYPE.html create mode 100644 7.x/docs/variables/ACL.html create mode 100644 7.x/docs/variables/ACP.html create mode 100644 7.x/docs/variables/APPLICATION_JSON.html create mode 100644 7.x/docs/variables/APPLICATION_LD_JSON.html create mode 100644 7.x/docs/variables/APPLICATION_OCTET_STREAM.html create mode 100644 7.x/docs/variables/APPLICATION_SPARQL_UPDATE.html create mode 100644 7.x/docs/variables/APPLICATION_X_WWW_FORM_URLENCODED.html create mode 100644 7.x/docs/variables/AS.html create mode 100644 7.x/docs/variables/AUTH.html create mode 100644 7.x/docs/variables/BaseActivityEmitter.html create mode 100644 7.x/docs/variables/CLIENT_CREDENTIALS_STORAGE_DESCRIPTION.html create mode 100644 7.x/docs/variables/CLIENT_CREDENTIALS_STORAGE_TYPE.html create mode 100644 7.x/docs/variables/CONTENT_LENGTH.html create mode 100644 7.x/docs/variables/CONTENT_LENGTH_TERM.html create mode 100644 7.x/docs/variables/CONTENT_TYPE.html create mode 100644 7.x/docs/variables/CONTENT_TYPE_TERM.html create mode 100644 7.x/docs/variables/DC.html create mode 100644 7.x/docs/variables/DEFAULT_CUSTOM_TYPES.html create mode 100644 7.x/docs/variables/DEFAULT_NOTIFICATION_FEATURES.html create mode 100644 7.x/docs/variables/DEFAULT_SUBSCRIPTION_SHACL.html create mode 100644 7.x/docs/variables/FOAF.html create mode 100644 7.x/docs/variables/HH.html create mode 100644 7.x/docs/variables/HTTP.html create mode 100644 7.x/docs/variables/IANA.html create mode 100644 7.x/docs/variables/INDEX_ID_KEY.html create mode 100644 7.x/docs/variables/INTERNAL_ALL.html create mode 100644 7.x/docs/variables/INTERNAL_ERROR.html create mode 100644 7.x/docs/variables/INTERNAL_QUADS.html create mode 100644 7.x/docs/variables/JSON_LD.html create mode 100644 7.x/docs/variables/LDP.html create mode 100644 7.x/docs/variables/LOG_LEVELS.html create mode 100644 7.x/docs/variables/MA.html create mode 100644 7.x/docs/variables/NOTIFY.html create mode 100644 7.x/docs/variables/OIDC.html create mode 100644 7.x/docs/variables/OWNER_STORAGE_DESCRIPTION.html create mode 100644 7.x/docs/variables/OWNER_STORAGE_TYPE.html create mode 100644 7.x/docs/variables/PASSWORD_METHOD.html create mode 100644 7.x/docs/variables/PASSWORD_STORAGE_DESCRIPTION.html create mode 100644 7.x/docs/variables/PASSWORD_STORAGE_TYPE.html create mode 100644 7.x/docs/variables/PIM.html create mode 100644 7.x/docs/variables/POD_STORAGE_DESCRIPTION.html create mode 100644 7.x/docs/variables/POD_STORAGE_TYPE.html create mode 100644 7.x/docs/variables/POSIX.html create mode 100644 7.x/docs/variables/PREFERRED_PREFIX.html create mode 100644 7.x/docs/variables/PREFERRED_PREFIX_TERM.html create mode 100644 7.x/docs/variables/RDF.html create mode 100644 7.x/docs/variables/RDFS.html create mode 100644 7.x/docs/variables/SOLID.html create mode 100644 7.x/docs/variables/SOLID_AS.html create mode 100644 7.x/docs/variables/SOLID_ERROR.html create mode 100644 7.x/docs/variables/SOLID_ERROR_TERM.html create mode 100644 7.x/docs/variables/SOLID_HTTP.html create mode 100644 7.x/docs/variables/SOLID_META.html create mode 100644 7.x/docs/variables/TEMPLATE-1.html create mode 100644 7.x/docs/variables/TEMPLATE_VARIABLE.html create mode 100644 7.x/docs/variables/TEXT_HTML.html create mode 100644 7.x/docs/variables/TEXT_MARKDOWN.html create mode 100644 7.x/docs/variables/TEXT_N3.html create mode 100644 7.x/docs/variables/TEXT_TURTLE.html create mode 100644 7.x/docs/variables/UNIT_BYTES.html create mode 100644 7.x/docs/variables/URL_SCHEMA.html create mode 100644 7.x/docs/variables/VANN.html create mode 100644 7.x/docs/variables/VCARD.html create mode 100644 7.x/docs/variables/WEBID_STORAGE_DESCRIPTION.html create mode 100644 7.x/docs/variables/WEBID_STORAGE_TYPE.html create mode 100644 7.x/docs/variables/XSD.html create mode 100644 7.x/docs/variables/modulePathPlaceholder.html diff --git a/7.x/docs/.nojekyll b/7.x/docs/.nojekyll new file mode 100644 index 000000000..e2ac6616a --- /dev/null +++ b/7.x/docs/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/7.x/docs/assets/custom.css b/7.x/docs/assets/custom.css new file mode 100644 index 000000000..24616e25d --- /dev/null +++ b/7.x/docs/assets/custom.css @@ -0,0 +1,4 @@ +.tsd-page-toolbar, +.tsd-page-title { + background-color: #7E56C2; +} diff --git a/7.x/docs/assets/highlight.css b/7.x/docs/assets/highlight.css new file mode 100644 index 000000000..adb6db7ab --- /dev/null +++ b/7.x/docs/assets/highlight.css @@ -0,0 +1,120 @@ +:root { + --light-hl-0: #000000; + --dark-hl-0: #D4D4D4; + --light-hl-1: #A31515; + --dark-hl-1: #CE9178; + --light-hl-2: #0000FF; + --dark-hl-2: #569CD6; + --light-hl-3: #0070C1; + --dark-hl-3: #4FC1FF; + --light-hl-4: #795E26; + --dark-hl-4: #DCDCAA; + --light-hl-5: #001080; + --dark-hl-5: #9CDCFE; + --light-hl-6: #008000; + --dark-hl-6: #6A9955; + --light-hl-7: #000000FF; + --dark-hl-7: #D4D4D4; + --light-hl-8: #098658; + --dark-hl-8: #B5CEA8; + --light-hl-9: #AF00DB; + --dark-hl-9: #C586C0; + --light-hl-10: #EE0000; + --dark-hl-10: #D7BA7D; + --light-hl-11: #811F3F; + --dark-hl-11: #D16969; + --light-hl-12: #000000; + --dark-hl-12: #C8C8C8; + --light-hl-13: #267F99; + --dark-hl-13: #4EC9B0; + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); + --hl-12: var(--light-hl-12); + --hl-13: var(--light-hl-13); + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); + --hl-12: var(--dark-hl-12); + --hl-13: var(--dark-hl-13); + --code-background: var(--dark-code-background); +} } + +:root[data-theme='light'] { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); + --hl-12: var(--light-hl-12); + --hl-13: var(--light-hl-13); + --code-background: var(--light-code-background); +} + +:root[data-theme='dark'] { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); + --hl-12: var(--dark-hl-12); + --hl-13: var(--dark-hl-13); + --code-background: var(--dark-code-background); +} + +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } +.hl-7 { color: var(--hl-7); } +.hl-8 { color: var(--hl-8); } +.hl-9 { color: var(--hl-9); } +.hl-10 { color: var(--hl-10); } +.hl-11 { color: var(--hl-11); } +.hl-12 { color: var(--hl-12); } +.hl-13 { color: var(--hl-13); } +pre, code { background: var(--code-background); } diff --git a/7.x/docs/assets/main.js b/7.x/docs/assets/main.js new file mode 100644 index 000000000..d0aa8d5f9 --- /dev/null +++ b/7.x/docs/assets/main.js @@ -0,0 +1,59 @@ +"use strict"; +"use strict";(()=>{var Pe=Object.create;var ne=Object.defineProperty;var Ie=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Ie(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Pe(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),v=s.str.charAt(1),f;v in s.node.edges?f=s.node.edges[v]:(f=new t.TokenSet,s.node.edges[v]=f),s.str.length==1&&(f.final=!0),i.push({node:f,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ce(l.parent,i)}.${d}`);let v=document.createElement("li");v.classList.value=l.classes??"";let f=document.createElement("a");f.href=r.base+l.url,f.innerHTML=u+d,v.append(f),e.appendChild(v)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var Be={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Be[e])}var C=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",pe="mousemove",B="mouseup",J={x:0,y:0},fe=!1,ee=!1,He=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(He=!0,F="touchstart",pe="touchmove",B="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(pe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{ee=!1});document.addEventListener("click",t=>{fe&&(t.preventDefault(),t.stopImmediatePropagation(),fe=!1)});var X=class extends C{constructor(n){super(n);this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(F,r=>this.onDocumentPointerDown(r)),document.addEventListener(B,r=>this.onDocumentPointerUp(r))}setActive(n){if(this.active==n)return;this.active=n,document.documentElement.classList.toggle("has-"+this.className,n),this.el.classList.toggle("active",n);let r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(n){D||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(n){if(!D&&this.active&&n.target.closest(".col-sidebar")){let r=n.target.closest("a");if(r){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),r.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ve=document.head.appendChild(document.createElement("style"));ve.dataset.for="filters";var Y=class extends C{constructor(n){super(n);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ve.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.checked}setLocalStorage(n){Q.setItem(this.key,n.toString()),this.value=n,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(n=>{n.style.display="block";let r=Array.from(n.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);n.style.display=r?"none":"block"})}};var Z=class extends C{constructor(n){super(n);this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let r=Q.getItem(this.key);this.el.open=r?r==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let i=this.summary.querySelector("a");i&&i.addEventListener("click",()=>{location.assign(i.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.href===r.href&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/7.x/docs/assets/navigation.js b/7.x/docs/assets/navigation.js new file mode 100644 index 000000000..705f0c834 --- /dev/null +++ b/7.x/docs/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA52dXXfjNpKG/0uuZzczyUx2d+7Uttx2IltuSe5Ozp49PrQIy4wpUkNS7nb27H9fgJREfFS9VcpNOsf14gEF4qMAAoX//t/vOvOt++6f303Wa9O2t3VuvvvLd7use7F/M9V+234/Wv79pduW1vxaVPl3//zP//uLl7qkk5ZCuqe2LvedubepbqrONNm6K+pqUdu/jbB1mbWtsTigDvP42w/h063NrrtvzLNpTLW26ZvWNASf1Enktr14MetXDngyC5x6X3U3VdEVWVn8wcAijYJ439TbXXdlC6pu3llmoMLU3bXJctNcZ1Ve0k8ZKgTaoteSmMGE03fFW9G939Vd8VysM1cZPprK1gv7OygmkMN88nxhtvWb0WYE9TCnjak6qVIlGpF44ZJqsKlQZH9s6v1Ow06FkF2Wy84W3JqtIaFAYNVfh8Y91M0vTdExTEoI2bsdwdnthDSLfVWRT3A0wfRNk70/VLZS8c0wlkCeTdK5TnX6rWv6ToAAJhpMfK/W/MN5Vkjp6m2xvipKc5l12VB1yGcjdZC8714m+29FWWTNO1vDUpHErJvij761s0NMKtIwTd4PcnyJkjoVGdFUhKLaXHfdTny2UIfJh0KfFdXrremy3L5Wts3yYlUe/NtXv/kPme3v/7U3bed+4LRpqEpKiDCzNT/9fVqt69wW3NK2t2xDuESkTOIePYmc8bNSjZLo8se8XiHRLl4y2wWWq/cdA/MEIqss3LjWmNz+Y/2mFv5qTn12LqAkaK2Yg/XQ6sqmaH9uWXeOEcrs+rUw6JFHgcSabrOiXJqKbFORQGK5Hv2mL6XnwjS32W7HQSmlSK+bTW2HtLb9Wjc5+PWEUGKPz7K0o2VnNszLSnUSeVZvNlwpDDYFoai85sj2K4RQYh8LCTaySKRlgjd01ru5r3Pb+GjPPbQrSPiH1urfWMOfV+t+mRup+pFvVtN+OCGSmW29b9aodwgkWl4L5k+0TiS7guYnpolE4i1N82Ya2NcGEpFnZyu8BxcrJJob+6xDsWtMa7uQ3p28qCv7NKSTJKWQcntoSjA3iBUKGiyH0a4gDe90sS+Z2hlIFLzPpuk7ZJZ2FEisL+bpJndOKeghQo2KCBriaBdIxdq++bxwVaAlUb7gDBY36yFlIne6yjaongQKkRbWfAYYihTM3qGHPzvQKIit9d7sq2RmO4QIMk3WmKavF6j9EipILSo7L1qWxVocHhglpNf5O1uiJxsm1KXJ+MWR0I5IF9n6xeQsKDDLnJ+/voJRL9XIxFOhmo4DehLMq9amnBc5v2yTSCDvJSsqk4MxKVYoaCuz3ZV2jJxW1jMlqhspg9yyAO3CtwoUV8rlG/kzR6PACGeFkzzb0eXGKP8MnfVuhARn5XVpOjvla/l6hRPIed3kQmGdBGewhKKJdQpy9VwLZeBJMG/fdm6aW2XkXDC0Q1K9fXItZvlSN92LzRnUY04q8Hd1a/LTYho/HWalGr7/oYUvY16M8zj4LRnvtaYaFZF1mM7xlaz2udi4uSb6ekipVFS+lkUKiWadALQ+mkgEnvPS0Pvw7BKpy2z3AwaqWKLhScvWtE4gd254a6T3nKhUVPdth10OolQq6qo+Dsa4gFm1lIt9yzNTbboX0JRikYLpJsuKV0hLlXzhiUeJkmcnL2W2FohHkcj81l3W6/3WFV1NfyEhZRK3qWEv6tkFkqseRbXpuwpEJHQ6sj9MLO2cH7Q4mEKX23znfH43IqFvaVivy8k2YTsvgPCDRMdDCzCUClPdhwZvbw8oCVop0+VmnapkKt+YRyumNMBDHo2Q4Zatj1/aeBihkqmJky7wOb2ck9sx1qJZGaGSqcdPBMJjRzIFtxaRtZ6WH5d2Lk27boodvVTFa4Ucju8Cl26iQtTL+/peWl9KNZDo7eFwq5rciietg2RTmnNqMtbLOSm3iwGxnMc4DuBfEetksu2z7A9Gr5WSabhCSyRlkPteZdti/XNbVyp/E+tRTtPfW2kNKpFAHvparvxSPv3XPivFT3+UClKhX6X1pnrdqnYlDd4HpVJQP+0ztL5IqRRURf3hlJD+bVc01g9iV6oiwRksdqWK1mGynSe0tpfoO1RuxwWlOpcKHpoV6/MQGylQo1zkvYjn7EJ02qWdItg5WU3XtFgh0t7bzmyPS/5cX8ApBbpbUjx4xWIZMFo5Bzv1sP8lnJ7AjDmVm3hlTyX/tT3VKIgAJKX/1n/nOK0WMO2K1kFy3TwVuXVMwMJaqhGIG9P13hpfeolGIo7bpyA0kQncrTi0ECLM3Fc5LEvfjkgHF87kaAmVEGFmJ7t7hAgyy/opKz/t6y7j1+YJEWQ2xuTvoktCyhB3+DlPdi4t9e+cUqY3w56eYXF7z3jsrBTz2xdxPy8hkpi2l6A51gDT2oKXqxOlkqhgF5b6bNC1NX0uzNdp1VFeQmDWcPgnCgWYxXYMqj4BLu0p1/FucvmcXKrBRG/fLAXzzDrO0nS3+7IrBJ4nk7nd+31TvxU58BwZ4Tls+IaAGOax3e4752kcHSJ2AZZTQnp1a7b2V2KPjFJham6+hZuhmFUYTonph09T0EejVCoqhEkMeeX5vDXnuCVqsNozPH2SrckLNwnt1wTBag0Qi3lYH3cY65jejxAh5uiOtaigSZnE7ec23OgaCSSWpjbQOok8y7Vfl5BaysXfcseWRyRCzF/MO6hgvlWgfM7K/fEQD/twtA6RZ9kf78MZCHaMSCSQ550oA+u3pEziLkwpfYgiZQru/Ol3syb2AwZmBYf7pBWYJQ6eScYKTGvtxNgtZx3OcQMqrYT0emhdmjbPa4Uc7J83ygxoqYIv7MilVJjqGgscWxOJwLOjG/jlnhlx+rWRXGpClApTm9e8/lqtajctAOsKjBCzv9kubdiHwnZ6hAgye6/O/koeGClkmrR6SKkwVexBz+o9R+eY7p5Cu4bE1h59vTHdS50PS5Rs3SZEMlP6Gk6pZKr1J/pYBwYtdrFSyJeeV/+kde6miXIbJ3UCeV+az4NfyZ/3IWWYa/vAujks3VCNMRRg1pvJ763HnrmzvOU7ek+cFPHvfuwnl+iwRSJR8KTXT8oUXPB8wnPVfbCR+Vfbs7Qvxc66lEVO90KsFPM7adE4kQi8m+2uNG5HHWydjFBgn2YRw6aRJ7JcKZmWO90WHdlMCZGWCUaOs3dNqHaKn7lDXDuXO38WF6TYP6le2ajTkh+qVsn2lYg+d0E/QOUN7ZBU5Gtp32iqkYhwnS8SQNarasMWKYNccV3+nDV53d7Sc3eUnvTCwWtaB8lNsXHfVR/gqWNKBamuX5ecCUIkMt3QW7TOSeBiyZAykSsMV+eNU3YEz8rS8I0oEggs0x+HGHbtc7+alAncVoomlGoEopuUip8iaR0mt2330tT7zQu7pSfVnEdkV7FYqZIPJraUSknFnyAYoZJ9XAxk57m8VpkD47LHConmNi/0gVNADU5VmGqdXEAbrSJFHlZImcjlZzyBWeC89Jux+N4kEEDWqaftE6BQZ6xUx2cf9oy+/r5YC6uksQLSStvZDh8NhpUGAhdLIA9Ey9FFyrEqYXtJrBBoh3Z9XIWFXEaLc2gV22woFaQ2Zn081HmVFSWc2wGxkIcQ4fac2Lajdrnfue2HCHeQYF7tuny+RAO7QEJBbdXRbAcheqDRDDn7p7JY685X8Fqcg6ZKpiLEdBujV/UifwbeQKrBRNjM1W28FwLPN7Qj0iKrNuKBL0IkMu2keGkLunULj6Ah81oxB7kxkzLM/YrW+wIz5OTP7KLcaBMIvUeAML5AYIlnAVKNQAS1z7dCits5V5XvjGcUmDFnbb1F7qOub8WUvLCjCjqBn0g0PPEILiNUsuFckNZJ5JabBHpGzNiYb+jQaySQWYAipi9tz/KmjJ+P1DgXZZi5PxFdjkzCzyegXJ/PsbeXMjjq9GQ8W+O1Z+aghEtcGL5MHblsYfrY4MIGf0olUlXLq5xSoLvoNXiqTogEpuphz3xOGBBOHwtuUded2/zmWj//i1ORxFRPx4AY5wGXl9WryrDL1vXWVuV2FR0jFGmi/MppzslRn88ZdGHHEKVC1GX2bLBLECsgzdiZUq65H4VTYrrt4qzvzD9qKMAs+eDIeSdGBrXwoyMJ5B1Dd4H5aapREfm4YWfFC1vailaa0ycDt0jFrvjyWjkH1xVpWi9Sw1xcxEsrNNmWgI5GzNhvuKF5tEHCLmv+VeJl+VQjEx921icyaCpJ67RkaRMJr9XmwPpQhAgyYUxnbTznXqfc8MBrpRyKdX+HC3OgKlYoafC3hxqZeFWXuWmEH5/IZK7wkOrn02zd5ZQy/dB5gY05tE4mS6clKZWC+tLU/LG6VIOJ8m8/51d72t7DnuT9PJHuq4D6vFxAYTBSzHcjxGFt44e//vAju7WKU6rp+q31qmTqfMkDgrFCTxPWeYFYncfxCh9V+YRimMf+Ka+31o/RBeCAclU+ozuDulugPjMX4GLxYiGP534c0FwoAcQ4j+fn4ttZ0z0xiZyf8tUwUsRfZS5uA3CsIsEZLDzhA2KYhzBu6Ueso9IFWgClSsogt341lWazFiOEbHdfh2q7KqcU6eqF3T97d8hDlZ1upgNfHkgZ5ronUH1wZaUiny1v7b2KvU7eLELKZK74fZCUYW4pnthLNZjYmvW+MacQyspXJqfS5CrFJaR1SvLSfSjq2vum7up1XUJ6pBVyGLZSmBxfoskIlexbdxDctWrYKoEc5tNPn/vejn/8RCMTxU8MpAxxP/90W2yaw2FOsMxG6yB56OKtJ4jXX2idggxgUvqmgIEXIoGGtTT0zCS0Q5IQDOCzOgqAC+aimanTOkiui5z7eDzaZAJ9g99o0xHY/U+JBPG+ZOv+eB/80E6INExpQkbrMNkKnrOS38YeKyDNPE3WJTcs+1aBMvTvcI5OqdRU/tcSKjV1mL6L2KNMze2/EEnUQaRiosUbQqRiHoJKuCehr5nllCq6/L7OeVfkKolvVVE0n6eAWMjjpa5fNWVK6BRk1Ko8u4LUu3osp7dCSmE90rriuvDArOawHTmlgtS6eQXXAgVmyGn6sAnH8LHi6RmsPyMn9lsfrVOQ+/BUJpfAoUzBhSHOUo1ItD+KrVSBHZK+fnUHGMRhl5Ih7m9Zs2nxVWmJROS582ZbQz5gaEekwV/uj22bZmJTjbCi6h0Ba/8+UYXIH/7xU4iMNhAgLiFVwKOdFimS2GQRgZgTYj4KnAyLYOXm56+vNKQ3wcS73WJf9RcO7fYdDQkkEOZmsqsmq9rnutnOd9ENpT6TUkJ0V2+LNT0Z87mJTIYyG2gSKthCE2FPx5BAoYYaDS7cJ8tXa1aOM1Eskwe5KNfImWx0cA0yvPSbLZZUJkGDrWmQmygldHDzNGonnFjIwL+uV8ATUhEebC1FJUNIIfy014SHBhIEs8MZ+umjWYCEt4dwrFB1FpLvd2gphLtLEl0cmfbnFo0uhE7E0ncvsm9KSIOzS6+3Dsj05dYJJLz3D9YGRixkkNzVB0qDFgsZ+Pvjo60/ITwRYrC71QrUu9GOMOJorB2HyavCPQ57UXiEcTeusG/gZBURw6UtGDRqIM77VMrzIhEESpM6n6uZ0NH4ZMJFYMnZVohzW9GDANQ75lEp4blg1N0BPc7mdM8Egz3ZIYa6G4GtDqxanwXfsgmdgP2aNbnJOdhgRYj+Q3yxnr65a6bihSAPRugQ9vQl68LNOkliKFHB0BARiyTg4c3xU4BYJAEDP5AlBiqEhBtVPKi4S4XDQhf/vGkDExuebUNAf042mumWkAZmx6xu+XSwshXDvHjrDMtTYFT8WY2vxIxWiY9OOtJc4oBjCKSDePPPDPRSNuEmGpYeyiSo+5TJopwRAr6+4vbrCxCIjdHjsWBsnhAXx4ZmGxAlhOB6k57/9HmjXcBsmKGIWqqlEqOuGKz6J6giPSUTkgr6aEwICheE+dpP6BDWn74dPv2QWEJ3JhYVAi8/M5Pw0xbOIf28xeMPLgtf7JxYm4HYq3FibQZjSEtdHpFenc0pAiXbI/BylEkflLJ30K4KU+Y0OhZB4DEaC006WlUI8e2RSh1a42uyapgFEaKRfWmcGGWQRgNk8bQUw9NAbQBPizUZ8LMt9TyrP6vGIKwFJo12nvJ1gFRC9Gm5HEBDjQ4333cybxAJQOz68PvAE1Dy2T3EkJ/dE4jbJ2crKVPFRruE4StUrahL3EVbPgfdsRXiolA+fE2ghBCsWMI6Y+kqCX/DLwzQUgnewrcbKDBKnEHoZw/Mnn62mwN6fTZyTWDlZ2Ry2viu+SWeGmcxfMFliINRAxhXLyBqlGmgbiIEcU6gAqEGxd/7QcNsnYYka1dh2D5N/VkdHRUjeNwhsQiq+sh71gdeLpIFS0cJcEbELqaAy+xgijCFu4gAzId9AQa5cAurl8a5F/SScSjBsD/o+uIMUsL0Su4IQN/IHYHGQA9oXTiVQWgcoYBmxiqIlCL4+GBNAJ8Y752JFae5rBpmwR/w5BsNTiNkdzrJ7ZbLC2ZEIHQQ29/JHp3G8XGjHWHCY5F8SRM6DRZV5UijwblIU5DlBBqQrTi21kDUINHAcuVYAfQoG/o8EVtVeTnKhDi1webAaCHeLbnyo/JoFiDJAQa+xrJqVRbevnNM94QqsP65z3jmaKc8x41kcOtcv5EiGOu795057o9NB/m//td//O0fP4SE3sPIfzHvBORkU3OizzcRifpuw7K8zz2mtU5Ly2EToTIHep09YIOVdo6azgkDIjMhJGjluDoTeNxHXGiXeUNEj+SD+xEXmEVa02Tv0+GuqgTl2USOd9A1am0HWCw4hxgvKqVIckUpYbrmuDFEOzsZREK8bY9pKZxO5Pf3P7uvE3FY4QM3sit46fbGE4rZ04goZA8T2yXedLvr3M2X/da8Zh8eXBiQhERFpYvNM4kUtwfKJKV1+LOcunO7x+hKERgl0sd9tDtnYBz+LKX2gtzEBM+kowxhTGnMYJM4h6voy2hdbAAFRhXJVf+LuizNmuWFEjWVjA8bYdnwsAzX5J/2pknajG+TOaeRMcWcTBLFbTmIk7u/Sens2Dkzb/634SHt8e+K9EU1dNDhJ9oTxjdLNNsnRLtlB8zx74r0RA82/FWRtt8jQaTu/y6mP96m22S7lwTiG7UkarUyxLELlSxzCFzP8QarlkUXl28USe4S2fQgxYHkGyXSIMtK4vV7JolyuJDsc73OnvZlllbERCATh0+J5NAaGPUkcvyJzDJtDIJO+nSJQCSeHF3CBwuMehLhUp/lT9/XTMHXyjKv2eKu1SXd1PaBzbwhm0tolVh9hsQRzoEVWiXWsCpDFM7JIBGOqzAx4Ph3bXq3y/vOPjTHOdpFHutZ633qUywXslGEVgVr790UQ8B885m0pLuM7SoeNWafDGoC8Kwojcgtmm5PduWjRcmgq0NgFEnsYKAfBUalW8FPnK3IrKetbGfIw5xVzyK7p8gs0frVR/e5k3h3vk3NIfve0Cqx+mPtjIvh28Q1i4uL+cPd6vHm8vGX6W8j6e0QbKn9PlSEvB8p1P1ifnu/QqhBoUAtp6vVzd3H5eNieju9/TBdPM7mH2/uEJtJoslsNV9MPk4fL6fLi8XN/epmjjNK5YpMVr/dTxHV2SFmRqeewUT3dKJ7lOj+fnZzMXE/6/HnJVMUkUaJm12qiAeZEjq/WE3dS1lMJ7cS2dcq8cv7yeLT7PHh/nKyol8gJ1Zm8Ovjly9fHq/mi9vHh8Vsencxv5xeShmRiVCGS5K4REkeVtdkIvt3kMwdFWfXfUcKIQPQi9nN1LaRi8X00v57M5kttY1Wl/LPZc01aSEJymx+t3JJ7Rv9SJd+qFCjHlfTBdk6CJkCyv5yz67EiE92EgHg5QVFuLxASaZXk4eZfUsP9t3c9rmQbYTSKbB389XN1bG1Xk0nq4cF5pMJFBktHz6cqvHj8poZJ3g1yOJqPrmiYO7vINk1WXGvUWW9Xq3Ikcr9HSS7mdxNqGTu7yjZ3eX0V+D4+HaIsbXybjJ7nMzIMvftGsx0sZgvIKhXaFCfHiaXZG0LFQDlBmA7EFOMgwkknl2Sb9P+GSWaf7S90OfpjHzw0QoQt2RtuEV1oW92ZC0YLCDp/IbudtzfUbIvd9Y3VQ5frFidAddVpyqAvJ8sl1/mi8vH2+nqek7WikiigSnLAOnPyYYrCVKIwDfkeGX/jBLN9b+Xlirh7K+c63/gfHnzK82wBpRwMb2yfdT08tH9H8OINGfgWFeBFALw4pIc1+yfcSKyZ3J/B8mW89kN2WB6g5TwkXbcjzYxOTumeGYdhC38WCPiuMF+tIoI28eQXf1oBYjV9PZ+xkzmjrZ/+5sC8Ph5sriZfJhB0kkEgb+u7A+/Jd2Ik1EC3E4Wv1zabp2FHAUS6O5HFnH3o5TY+q0rrkROZgB5uLtZPX74bUV7y6MVIRazx+XF9ZR2B0YrQHye3JHl6P6Okl1MFmRj7w0g4Zfphxv1AMGK1Rlwg0SqAshfl+RPtX8GibZ1vh8uhr0vs7V56fdOUxhSCMDZU1uX++HrSrgb+Hlf9XsO2u9jTYj76e8+Lj+e2fN25ZJMSojB11Gs8AB2TYQKjwHHfNIABAEqlmHo8fOUAI1lCFqWV/vyuShLf2+QR/PsCNO2pulO+zlJUigRYfMiX5MbVWJkJBTB7qQgFTYu5oY6iHURSut+fyONG+0Asy5NRh9mG1GxBuLqynBHCH1iIkPQulpnHcnpLShpv9Vwstk0ZuPOIoSHHzwQoROxverWtG2wZTeG+ioRSUSZis6JxnguhZjV6Wa0hdmYbzs+h0gogqkPiTGT+6QY4HKzrnPz0BSuSx4jQlJURgrgtiZr4YwUwvP5c3xBrw88mSGk3TdmZjsEF83OvlNy6EpVInLVZEUpMwMZgroK7r7BtqsajRGUDmH7jaa4MsUajHN99fT0EAwvFMnA5frFbMnmHwgA6Nl06xcXirI1ZCfn2xGmKDvaeRgsYtLDJiiyYEIFRFXkQOz+LiRLImyGqckAmzGkaF+E4TsRIWDtLhaMLnXwUKMZQDYHJzAJTjSCIokCxkURSJkoiABG2w5PBbY6BVaKf5BmoAmDQGZ1Og/10MDi9nUQ2x1C/NdV19QMMtScgUsP/fNYOgYAxJfCNAXpcTYfXNxsYtdXwA5FGDjEe3BbHocbPRlkLMPQS/Oc7UuOdbBixOkaXAZysmPMIeQa7YD6doy5jS+XDyC31K3yCaKfQi/qmiuWUYBB93VZrMmR+WTEgOHIxJthW6qvwKjh6P5NZ0iXKxBgkL8dk1swIGQC9H1n+5ti88IV+SjAoEFjcmHORisR2p3J4V1WzyxBzEF31dQ8yhcB4EvW8g7WyQgAxenkwLX1Yq/IJhxrEG7r4jK4yf8xRBEJTFQI2Y6x14mDEB6VEurAXDWOJBDGzp0PJpg4OQjmJyePg0UA8iyYD2FPhBGgdghCzIMOAgjqXcgqK10J2rcR7jD2gYQQgg9b5WnYwQgB4cIKmpJxWgHPBxkK0TjKUIQlw1P4PDY+RQQKNwv7hHSjcJSUGYZ6A0zYb5hP9/f7iEAiw453mwLYUQJhQVADMAehlRLaxQfQgCMdwP5eFxUaeX27gGHe5sEEEpdF24WRgPACEdKDbLYZueq2jU8ORYmcg9ceb1EawuSwQySvlrPob2UW3AxGqoRzfWasQbj+8BwJ6S046Z6vZ6MVIdpVfbmPo7B6EM8OMFXdbPugK6jiJyIA3LkbiNy0bkeOlp5ZB7HNtmFWp1KVDnnpQgAUdK0lZDro1K3UBmF6SOhRpoPOssq6rPQSPyGToIK/EGskHHEFRgRjrsFIUe6oCf8JMpJIsNP5PLLfiCQyjG4TJ6ME+LTPcv5BequE6LtN0ovyzBLkNMYCX5YUInCxM8vs2ZRkNzhaEWLsuld1HOnKY6UyCO1d1WXNNPLRDCBuOHXn+/mZaagQUPfZ+tW20TCKQMjyJAIsPRcakujzoQnGuXCrmq2hkUQF419hrIG4fE+v6w0WmNSOA8d5D3MZgY/j1DiLunwzk9am5bqHWCPjbqFPkIhkIHcqOoGiA9IxuI9XYj0L/ptRIgLANnNB3/5wK2zu2D+FiyQIdoy6z9bnUAFR3ceyflJUIFqJ0a5P7Ovcm39ONWD6EgRzkTrzPpDTrWloPyHWINyuLLpJlV+4XRckyxdIIDsR2WZLY8cUtw+JxYUyALWlsV3VNxVZTU5GBKgvsqquirULxV9wLS1VYaR3XSTnWKUqiJy520foqnEyQoCb5ufcWoRnhpDh6DZPGe0QY6dmubuwwvCkQIJgx0uRP+3rrl/FDePLeUxSqUHz3kwkgbBi6++KoOevqUpABpsieGYkA9B9VVgHj+0tPTOC9JF4+0AyhckvGZ8kVQHk2xACwnwpDheSUMREhIC2339+h7v1IkkC+5//B+l4Av9RBAEA" \ No newline at end of file diff --git a/7.x/docs/assets/search.js b/7.x/docs/assets/search.js new file mode 100644 index 000000000..50932c7a1 --- /dev/null +++ b/7.x/docs/assets/search.js @@ -0,0 +1 @@ +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA8y9a3McN5L3+1U2hm93NJZn7L28OjRN25yRLC5JybHxxAlHqbtI1qjZ1VPdTUn7xPnup6qvuOTln6hs7rySzUYif0AlErcE8H//0LWfl3/4z//zf//wqZlP//Cfr7/993/9w7x6qv/wn3/4oa66uvut/ng1vfyy6qrJqu3+8K9/WHez/sfJrFou6+WfqESvHldPsz7lLk2f+g//37/uNXz3+tuDhkk7X666tS3js1gqUPKvf1j0MvMVx36EeP3Nt385UMzah4faAnAQOOpeLad/bJZ/XHTtqp6s6mkpy3PdNfdfDSwHAYKlea5WtYHk22/+cvz6k2r+SzWfzmrLlwlkir5LRPBoVf/orfu2urfr3wll36OZP/bfymYb337zH//2+rtjg7no6mkv2FSz5YFr9XXRUwW/iM3v+++++/P3h/x+/32QVrI6O6Si6zWEYsy6ehiSQmpe7dOqyl7tuDwKt9W6y/GPrw3qd7xMwT8PX7YI4dVe1AaSV0rEM5k1+Jc4JH7ZT7FVu6+Iby1VsCMWCw9/j4TjVSBuBFI+SrNcroMOSKY6JH7Zj7JVu6+MP1vqYEfMFH5QXoTwaitpxCA+RTDkCcT4IQ+VyGXIw2bMDnmkroUsi7mzF5jIzt6LiOn8eRyi8/dlIQcDGo9pMKAwhYb643V7rYzM8yQuRspkC43KCWrGK7Rd89DMq9n7bmYu4RkjjIyQcUJmpM4xmcbpOAUzd+EojDMXkQN0IKy9qHMFXDvjLDjVyjzBqpd0DLJuk1uQrSFwCtfrj7NmAvVhfFIXJ6FkX9SfCaWzmYUGp5iHnYNvHGo9mfvY0loijRirKZMxQ3yhUb+fN+0csmk2pYtJy7lD3R9fFM5w2qePzTz/LirLXsyJY1mvPlSztRkkkEO6PYQr6v229tctrVyBHN8R/otkxvZPyfoA7WOaXYCZjfGTUCWejqqazS5KKy2RfamPLLhSqDJNnhRqLZEjXdaTdVdfDJ6qmq9An6oLOblXUBHoaYGycqtExBprAWWUC+b9ypmZaQCOK00MxpJivgYlVUZnY9gkHw1/9wJ3PbY2GYdjq1Gj77HZKuGGlNULOpmrq7GsYiCVMWrGLkEZZ+0qj9Hoy2bvNgrFLRTM4kv0iw3JaTavW0vQWM4nk3q5vHisJ58Im4l+dWkaeY5FLSLGNhseRWF2qxADY3YEgHG0a9BOGh1LYLI1luK772kTO+8ejoOeZr6qu/tqkuIMiURri7d+JzM8x7NtarpF56SMym4dfFNd5y75SKXUsFHXzQ0TYYTQWQz7v4rHyJL4uA062zLfkZfC2HgZGKW/wPUKjourB7v3MtYC7UTEmrB5EoknM8KLIU/AEvN0fubI5F1uk0ShCgyTw0KsEydQTJStmzI7tdYMb6xy7dgtViTLzPbnrl0vALPN0/mZLZM3tOrBFaLATDkMxExxgmb5tn76WHfv7jcyNpRcGFm7MBLe16vJ43+tq2m+FiTCRXIn4FIaOGtFZQ3calN8A5ftyt7ARbJwHjV7206PTPV8/TSMyTZ/lcey34dtd9W1MyGTs2MSbii35eAjPPsU13X31CyXTTu/rdNQvfRnmT2ObOotblAuRzZlibwim+iMIb9GsjPD8GW77iZknA4DcBBAWqmFpKu3WYcfUceJpRyY8Dgv7gupSz0WAj6ui1Gv9Dh23Vwcl6jfGsclWkkYx1XP6lV9vZEUAp2oVD7RXGzOWEAXiW9rmgKCqW2aWKTGKQDZW6eJqtmsBdw3dXfbp1zVD0R8GQ9HSnswopFegi3pwV4WBi7eiwfQQr7s2umoL43AFvil2U7gSK6Gpaanetr033brf3h3IqR1cSpa/pBrkQpU0KhVJnvTLiBccs1axVvamnQJG+2edTKLk8a4QIej25nqdgp4GOejwiguqJiEdEQgjckdgTYVOCVlunGCiYZliiGVdexwGh9Ij6dgDBIcTHvpJ83QaUANDaXf1qvHdqqZHJHIx/C4jKHOjmQv6OV4Cnv3pjChDYGvF9U5Wwi4RsCqV9yxXTfdABT9tmagWEnQGH7983W1mjwqrYFM5dIc+Jyh9kDjFzQIgcPeIjQqsElIdaO2CRMD0ygEAKVVFGgnm4VKYGoXGlUaT0MuBe9/QFeD+wHQVM7kbJdE2tVPVoOD/KvFop5rGg6JynR8HqpSUbFPU6ZhshknKioOicp0TDfTZEXHIZFBR742v0lUHTeq9ovyu7+LtpPmJi3z42v8fK45Z/QbvHNw21fSP2bvF1N9/4BP6tKpKNlDPYtQmoLuRSOy9zEQH9jRqPWl9jZ2GqbL0VCUfsfO0Sy3MmaSQPA036tXsF4s2m7biZnhAtlT8W3XHa/my7qzm3wmfirKX9s8YECH20qdhumxWl6082mz6j1sHi+gN4FY+mSM2y9TBHgUPRnd1nqK6I6ip6JjB7SYfzONarGeKgoWX9z0I04yUHz3i1OQeJgbFpl0QLOdikhUGQ9CqFqrCb/RlqiOkyL2hWlvOyr4O1e9TeeiF9hlTAiKdxYpFiwAP9KvRZ1pWuptyzmOf4lorlgjKeFS4u1kp/f0q16H2raSxC4ED/Xq8v6+by3Nc33dzppJQ7jbBISR8eI5n/czqN7Grw6GhhDRUi5Mw9T9fNL9WK0qDSRO6mMjwtGY2D4KjsVALZI5lEK0SuOBlFz7938JLeHtsJIT9AT36/lkMyL60/FHsReLs9vY6lc6t+1vhsx2cYZJGGCUZ5SkNOubOtmL5VXsk5aqmtXTfRZLQF2YHF5AOJ/NblfVqplwo5P4d58xCpEnNlJJYJk+dEEu3ojaUxHIU7A0UC9KYWh9KaZR8FBkzdv9lKXktLfiS2/zWTxJeIxuvXpsu+Z/6u5qvlgfTSI8AhYnwY/QaUfLiHyxg2UJM7sA9o9138/W250nmCATGwVRPVfNrPo4q6lBnIbCCJuBQqd2SJUb3uEnH1cWZ1d2gOlIa2/QqX57W1a1cw4sUW09hAvqpd0HqdvmOSj9sRF9aWZN1X3lesb4dydzyvPEesYE1jiTp9Ra5/MYQYdX5tkhLdQbY/qrfTJ+ek2hUGLjqLAmRqBoYwRM433/p31ScopJqc6FHOtgWJseNkx7oYMEhsVIOrJJDphqsQVe2GAnjEtkbcXoF9l2FDjHd5/ndXfssBkXSaZycZR8zpC7pPFtTlNAMLpOE82indILkwJPIIM0ChNP1fejrC8VmBI5d65h7al6qEvQclEPOsThC1CK2zdpH/z4dUscmxX0BzI+Vp0RbQTMTAepE1Dxbl/yP2bnX2A5ZBegWo+pI1BbW3i58UZoWIeqml6K6Q7IVC7dAZ8z1B3Q+LbuQEAwdgcmGmY8LdCYRtUmFmDvSuAq3sfSGKFrp3ku7cZpi/aNE90I5H5OQIjF3OtkWG7fpI/XkACwTNKdrZpODymlLUIBks/CnXaz1rXo6hWh0NQW5HzcuYVL0AXPar//3N5S6avPtdZqu/Vc83FRR7d6/KFaDjstjN+Nfnfq3PI8wW4thrV2aIRac1cGEXzsk7zv8nBAEuGYGGsGEMGiT0Y5FUL/Puk47VinRKhXuyNI49OwWbtNAhY7kXAs/dC7GZrTWZTekUNyglQLLHB/BmtgHB9rEUaXx7aK0Nkd+pxNWmFXhU3p4wDF3DFXyBbF6BRlFKt7tFJJ4e4Kmj3aHaGD3JgMpjk0K0VXDzHY28iIy66z2xOVwUnqa9iEbbpN/Kg0TNRo6UxOQtwshzTDPG1SUSHyCmsufhJKwZErnsTu0svaCO3ckXZic/MIXRAnka72sNESZEK3mAk+dyhygi5FcfyEQANGUahAZJ/LDYlOsZ1i20nBTK54sOW0qjpyKR5ehfdjULzC2DEftpS7eblGtUIylYsp8jnjz3jBRig94cUx5M93ye89GHie6u4h6MXfVgvm9SyajRZHutgxlGMQvfgMD49J7Wn0o2PjvZ9kemWPjY30g2qlnYZGf2CM2Vb2e1zMwXmrlWd/VAx048NYT49gy9K4BUWOiGTLwa3RbIx6c0QbTMJGtTEkxsg2mEMMxmBpCkIxZCY0fLQsvg3WvA1XWz3iugMJ51qIdnTCEyoqEyHpYb+GAGO3GDejzbChv36xbmLLCtzpb/XH88mM8aPhjy4ONMsQ8pwRo81l5gqNvhLRXU1mrG/KAeLUSGtEGKQF1JzBvmYK1wMVwcdUAh64h2gHgjRyjuLYDKw+pEc9qEqJ04/gQDqqHEDpoRBdm4gOYQqVK80lvMo9rYerQ/tJrQ2IEfOi2pxunG0PlSI4aXpfjpvhWcBl84yYRy7hxbIfngyLuNVwCHQ4+1Y/keFEtAXx0n6Ms1XN3J1AMYWpvRj44QzRs5rHMbgvIQcwnD8xjVw4hujQ425gc8V7/OhsHpscX9gfTD/Pp0TdGZsVNy3gSxsctv7uuz8fa+j334er1xzpXh1yNEO+Ysprqmjm0GVRWaQzmP8EVb3c1fUfv3Wsbfb9yGHj0sesuZz+KaqahNtX9PdFFU2Xl7fq2/XHv/ezi/HOg8ron6KSKbZ9Hf+l1Jjz0iqdAtQV2DuAdf/zu8/zaJiBqzhjxJUq8fhaOsf+G70GPM4hN7JArJO52cZyTK/mN23LXFNA8hKiL15nKcOhvr4x1FdWEG7OOJ2+rVfVNLwCSEeMpV68hgL18EjhkEPIzlTKczVrptXKghSIvHh17HUfDAXwfoccDuB+I1Hz+BM6Rutfb+LYExkPveCY0z7S/Keq1KWhY365saV1RPm/VKXiaPLfTZ3CKceQxpHj/559sqNGYGSOjhWjV0nbp0W7CRvUrsxgU7rshsi5Y4+UskUpXyVXsIqXzM2sT7thwc/1vO5T2muQyuAkpLtO204YCp6ErOXmLCAgIX8Szo6eIYCUmbQXY7ZiLvRoIKtx/c+JMl9HL8LkF8/MnPLwAHVGplWnkrrk+1y8IvElGzOhuC4BEpoWJwq+MzP7hz8xuARgJqPm2iAUMuE282TTXFsnws91IW8cDJDeNPNPb9XOl0zlMjDic4YGRTQ+FzjSJ7YA7NIjHYyJAxiYCVTFgzKNEQkkELiUiAKTdn7zU7IX8y5oQY2Q26FqrZj2RVVbit+kVJruaZqtsckqjw6ONQo3gxjbPPCm4UjBvQvpZI6oKd5M7z+wc6PwRxcDzDKEuouIkTvY186f625FjP5InYe0WJAhQ4AYV65ecbmILr5REaU1tye8tKQRcyU22S/3zUPTbderZv6ARJsc0FQRHzPH1GDGr5eSaRLp/f1WuqM82EgspCXzdhTcOIH35i6vceuUvpwcm9uj3LZJ/qj61mf7hsrGp/2jmDehob30bfx8RwFwltMJWqbkYmHHelJ3Ot6JerlOX4fpspQkI5pWkqx86kKSzAavI1m5pGUkGQlZRbLSsItIMoq6hmTlsDumU7mjEw0PXKMqfJitHmVs2IK9BY+v6HFRAQX1bB8SOG68Iz1L+Gr2+v6++WKZsqgSLl0spgV7SlstItfpbgRL0Q7SmA+yUJY4I5DaOFVxpiae0x2DzU9UirkxhwRS26YpY+pad0l4ReOTFBvxf/zb6++OzuGw2BLfvDVE+Sz/FP8oOhwx2IjN7UwJSk3o2BCFRVcve4l4ZKxpfZXJIRD7OFp1twjnaPRPrDIEfQ2/ruu7qAuu6Eq96IgFz9GrnaULu/qqroNWcoF1/OoqqT04rPFDO/16XXXLujvvHsg42zgFfkxjd3EdmOXZMTndHhJQJU4N1fqkzfl4tUH7OybKvuDxJ5cWmGRX1AQDWnMbzPSbG6GunWmFqWpjM0T1ku2Q1m1qiKT+0Ih+/fP1MMkWbClL4WJSdK5FlpUXwWxgHA1pZ0W6GfNiFCtbeLDWxfDrJi2qOZJA4kckFnGwBoO8Ov7nH19rx4vy3MiMOE8+rWf1iliYLYJ8dcxtFKw2FJz3ksQ9CWXMx9xOydy382mzIu/jKMOOMnQmz26q+K91RTwxxoCHAmMbVEbyoeqa4YVhE00o5Er03Dvn+6+m2olFXGmEnlV0u6YOVqKJdrqqz0IfG/3qs6eV5VjUt8bYXAQlffUWgWC8e4vTDsXF5Nq1wBhEmxAZQ9S4PTQGLzEdG8OV2hYcw331cKW5T/2P2fvFsGckWDadzGdNmc+6yNaZEtmMXoIyWr/KAxqmWE/qCNdGwTRGCUFplSX6yaahM5jaiG4t4VS9WjaTi8MQhZu1U6l8JvBsztCWC41vaxgCgrFdmGjqu+pha+EmpFjMhwtabuCRlHZi0r4Z7f7YW+4v9L2fAkYuigza7HTDByiDCyXd2YRFKqGN2der7LZELyFp9mRbTdJaXnTGWvF2J3F0Nh8nlXW8QXjZwkiXAnsTPwbSFN2sUGIJ9hjedc1DM69m77vZ5ZdVVw1fn9tt4NLi+w7C6S1Uj3aGK6wDtnDsGtFktp7W/7WuNyEkzfyhAI/Koxwv8BVU8sx+qEQuPoPNGBobkezlR/x4mOITfiZC3k4AQtlAigkRL8dTKeMmi27e1ws2ZPb39tog/a1WIyafq9lQ0Jjvqu6hXvHtOPndpQlTeRb1+im82RBoErMNgBxMYyAhjD2+iYA0QIHCZHs8SfoszCHknBlyEmlczI/LF34WJgVnvPPwnMnbaoHrPwogblgmQZ8+IUGAp09AzfKDHvRXKHrQw1QT7IMeQm2YH/QQrCSeeK16mTf1/GH1yM+90jRe0y8y39IZWFYQ25oTi2NccZJJwEkYTaI0DINmcSLKfJWSuaitJripoFQb1tmgZCV5w7j7uqjlZnFM4dkoklzHNImgCEVmmKJgRqhrVU0wq4NSA0RrQDI/uhZKjI+kiU2v/dTwVnf80cngkgzBmwQDRjZsY0hDDUEonce0yOiD0Y+ZdapctWhdl2TMWVkL7BgtLWPCdImN1kt/8eQiqJt6xlhu9KuL6eY5whc+HTFtgwRCpXF4gGnfJqLaDkUQpkZaD8eAXt+U6AeubVK1ydc1pV+56JomsMTs9Uxkqc3XMpHfPm9E7zbnbDiO7a+ejSjI0dKIdpiMGT9XszVbl6HGfcIRuurFY/1Ud1X+pCShL0w8Qmc1m7Wf3zRL5DudhYltOiMjbTe/ng+ZbYxL1ZsKGByETFJNp3cte5adqoFEwFjzxJ1lTFcT/+zSTIgsR11VVuoNSY7iS8qKegAKofB6smJ/zDMUXUwmeuTrWdXM/7ps52+mP23eactoshQuJkfnCnnnHNk2zGFUG4c6EgViaAyFMtyAtQ7Dpl+q5WZa9mXVuxz6DhOuLjhpxL/CjLwj4KzD7AuMX4lsjuKXMrVI0XLDiNLZ+oGLIj385BM5GmdXFi16pDVGiCbKrVGhlF4oBjPRq8VdqnqEiNO0fs0WjJaSjvQkS2qL7iS/brjdNJnUi9V1V9/XvciEW9uhk/lsOvFZFxk0UyLjBpAApe0BmfQL20BSvdh3ggpqhd4MUmvGth+kcUXDHc1MT2KgfqY53ii8zGFk84Abhh8D3bl7mSFogDfV/KFWrZBM5XQaisu58FQUVRzr+SQWST2nZNAunVfi66Tg3JK5RpjzS0qtGM8xyVShib6fDxvrmomSqVxMlM8Zmh7S+JxRtE8fm3le+yLDXgQbpmo80Uh5+2mJ66IEoECGJ/oXyTpsVca2I6nSzO3IxMR4FrXSTkNTzWYXJZWUyL3ExxQckFp5JgekUoV34gyHK26299FsE7J345Ap8Vj1FROhiak4y8Vpl8QUiIFacK4XpCLkPbCe6GVpECqT9kCacCdrQChC3gPrY34IGASKJEtR0tOWUeKsmedJ/M5Z5tnihyxjamP71Sikhqscj4O42CasgYlt14OMacUal9B8PajYhgyYE9+CPciItqwxMY24kAY+K0uQIAdlIb3KWU/qw5Qd9DTUAn/Kk60J+xFP1kbCKb3oX/1dq8GrilPCcR/e5ZuPMXrM3p2001N0FztDTOzHzfVZ7xbDA1O9s+OO8dPJXIxOyBrq05kSMF532WeV17fEsJdA/K3KAjYBsU7U60RsFEwjkBAU71+in2wGOoOpPeiWEjSMn+uV2iqINC5NgssXag8UuKkxsNotLcFAIV0fwrKol4cYicCGyX8ZtVUa9DNNklWutEezZrIxKtpNLVGxjqAZDreMqO2QSuTSENmMoZZIspuaIq/f0hYtHFJj5GnsrVFhApuj8H3U9mghYBokr15pkXbdZJPU9JvapMYUXvuRJIvfGwgvu6AS4ouo7V7clvdZKEd/ALoEtAtS3c9JXI/N7Yj3CoxuZpYm5kHC3T+BNjU/BvrWB68mB/aB18Ptp6oVkql8gkzYnLGoWhLfGFnLI1ijay00dK8swFi6ZY0EDbsRvo7aCZoYuIAbHkCLObZrp0NtNAJbvI1mIWHTbJf6NJFK5NMwuYyxdkmxG5slC2BtlQYWplGyKKY2KXOgTZL/LnqLNBBwDZJVr7VHs266OSr6ba1RsYywMa6Btpin8WmKTL5YSyTAjQ2RU29thzgJ0ww5EFMrxCn224fsZW8sECE5ng11EKy16P4B18+5B0655h2smmnnIGu3+QbZTuJ7SZ7rbnjl87Lr2o7zDnQyFwchZA1eHUGWgN/2HlLbingWSiFtwcakhi5IaIXhCzbC5WP7+XZVTT7ddRXxlrLEl4m60OE3v/DfVPUoNgr+1hsWQb/6xqyfu3NGYci8SzlHvQ3x2ST9se9KmlkeWisB0fInsJqu7uVv6uWidzJG00lFfeiChcQwCReJmabBlw/rQRLO8myfnLaODJVRKjyOSKvVnkeUFAc9nNivufdmeB8m9d/jvB7q68YSMB4P8nM+uklvB/u4AoY4CGnadP1EQRs7MemcApP4vAtDlOhCFQQrSWRq32vkYAOWBAjtpFMJARO0pFIYw5c0suhke5+1aJ9pAp9T7lSm0Hg+4zWecCcVW8+5gwy1uV7PEhFk5IDSKKN0mqdofC4QQbcBkCTanQCgTuFmANom7fcDmEpP3xIg1IDtrgDBNvh70UV/IKR1cQ1a/pCXkApU0lhVKL3dEn6kgFI7X6GCQgctilnLbqIvGQEU8GA30ps9TzEJcjO9ixcA7Sy8QmS4v217j8P2varfhkyJiz7odC6OQMobu72eKQTXP64Xi7brq+5tvXpsiWdiRSBCGukqjYzVJuVwp68RLxb0IYOe0EaptMezuXzCgnELqOQj40awV/tcivGUZ6cXLXGxoxmyFVZEHBjXDohrZ0Lo7h8JUrv8R20IydPXwz1iuwswi1wJk4NPo41Ym+WwTczd7ilCpqKnoVsXw61Pzjb4g1K6WPYkfNtTG4WAqfAJCB/q+bAFuVVi40tFT0m3kSjE28uegE+4Y0wcNtkvGbNxSbeM6T7Yds2YPnSK3mD60syaqvs6XPi7v4iVG9XyaX1Gtkr+4NtMfIFsa2IqjnF5rICs2ouw8SgqJJUF1PDstMtFPWnum0k5LJHDiVi73VWxd+TgXONMpP0YsRe7FDr15S4zifSCl9ZmC17yKqwp5kUvqLaML3tB9hYHDC1X1XyleFg6mVfAEJc1GjBElYBpXo+bnocMYWApjjJgYIDMA4aZ8DhqmIlBvxhsw3+XkreWzLXCBb8oNWN9dUmxHvrVL7290Cm9moyQ+9jXwMYaroSGvw7mYL5iHY15LczDiPVaKn09DDTlzYtamhXniZwMmMnY8LoY5u+1V8ZohpLXxkY2Gw4Gen1sfGNh66LwNTKHJiLXSMHrZFDD2L0vo7QMMpVL0+Bztjy8BM4v1XfEyNll4Xtio+a8Ek/RC2ujmqtAg712NrbBSlZS+vrZ6Car1krJa2hQo+1tcbFZepfaLJXIpcmyGUMtlmQXZy9Ue+UZQhmktSo80BNQPIzcOiy6hUew+O9hfwrLXBv0g1RKjdiepVKYgsDzOBF7fwWRDA8/79KYeyDjs46Kto8KSZArZ+NMAIFQEQDx3Bznd07gcZxmfaNbmk8bG+VrMC/jpV98bm5su4a6unba3Dd6Z0cm8zE+PusyI6RLZDQDAUrrdEz6hcYg1Yu9URTUCm2cas3YjFTjyt5qUSyVSONzloLJt/yVllETGBbHOH2RSeDXYgraiUGz8lKMTwsx1wT/SoxT21CsJDzF0Rtf9VD/WC8nXbMYduzOp5vjhOSLhUJin9MdmgLspIdUJuOpDxXIegKkgG25lWE3jXXIPAdkAlbCut33fa6vq1UeOamDJuKOlND5EZVPO0tSwCKcK9Fbg/2MSXFt0edNwBqznT0B7S5wY79Vk01Uj9LF08lcXJeQdVFHz5TIZtASlGLKNv3VZHbXXtfdU7NcNsTjxBJILos0exvf9mT9EPO1HJ6XqJ5s34+QPgEj6whENrMLKLEssvHr1mVq9ipX1OA/fz5frx619k6l8mnubM7QEIXGZ2PciL5UANilhyxU4YCcDE+i+RiLdqF5CN/C3jrsNUI3Dq1WbG1Ds5dwR33jrab7a0SCbjSD5JP67K7L2WN77Hxp2OFytVovL9opsZerAEWi4I6umS9bJUbpyJViX7YirhMwhbdBf0IsmUzlYsR8zpD90vh20xUwCqzWRMUarMBktlUTkZXGlyS6q2VZrxD75BI63dYiZA5ZKVsOu6HKMAW2amVjzVUmM1uslauAyZ0nNl3Eak9lsKNs1cdMTRZaSCAZo8EOC7XbNI/Rmr9Uuk3OTMyINC6GxeVreaw0ArctF7PqjavEBpIneQbMEmVyyHRR5rK9M0l8I/XuDoN++X3NXDn2wCauWXrTktNe8qglZyOEp+f2Pf2boaUFKl3aKFPDrWw8BXtVHGRrXvqZi+JcLA4ytp1ZLrp+NDJfVeSwgkjj6f2zfC3ePwK3dKuscrFbNWhlhxKsZnUoYdD+sZlXXb73yOo+pC/R/O33377+y1F3s7x8WqwMyo8CRdqDuMXr6AqYIJ5v8wMemyiFBh6zsk9CtnyIndIK/ZQlBkKrI6yiWGFqFbRGyhQsKkNjYNxaoNjg1GDzKGrZBY5MUemgjjeRAg+CqRSMpMRxsEq/D1XGqd6m3/Z+PZ8MPyz/xCUVDefbb/7j315/d+wR90JX0z6bISTu2DEOFx4do0KPCYry/1DN1jWT9ea3olxv6knbTZlstz8W5ftzVy0emWw3v8mNMxo+i1/zOMgyf0l8OM1mDa6YkCUwxg0KENbQQRMP/e6NhGN5+sbG0uQXIkkgDXoFkkoRDfWX9erdc911zbTOLxAQKyYW9Cf7x7oiLi2TkPYShZabjhRzH4h9p0CslCT5QiWO4iyW8yCpptP/6qvYRHGUcSSwmUUg5MHQ1U/tc22uiEjMl8NWHbGc01exfhDXOigovpP++7azf4BAyN9rbot3PpsVVMpWyqNeHitblWzTe2h+qFfWwh9EnPRblfv1E9b+wU9zcFWHFSIW9W8RD+V0meip2mspICXtwxiPhSaFfBOGzInl3ce/9xOCUqKDtCvXm3r+QMRYAkwHyeI2GU9fNxPp68Pbe0ePvJ3Bpj+L00vxmm0hvzPlRu2MES6OrN25MCVl4eZ9z8Tah6Du1T49pFS5O/tz3Tw8rgzKDwKF2vklT8ow2RU11EzjZyrCzwpnfSZ+Y74MDMTkcXjykrygQOE4Sjqh9O6iXjVPJXUSiDrB9D+202b+UAATiDrBzKr5w7p6KKmZQNQJphsOXBaQ7OXKMUS/aATRnlLg89iWg6mc9bwpaUsh0qtdHkVc2tsEVbcqcGcx3z4TJ8BkO2HZrrtJTSzwx1sJaTJ54Tzy8qyGqD5MCtKnNMhtVCbPs0V6ADSuzgyXLtdtL/KP2fvF4ArZndwsEV6qavZQf+zILTQ617OjBF20nLhgx5DRbd5chmGMIKeB4HcXGQzjZjQMIuw5MiTWTWoJJbT/w2PtFMvhR9M29WM71TM7OySkrfzIxQ0DNw9PAYoOCQsVLeQRbaItTl2osp85TpuN0wY0RokLFX5sp6QxJqp2yQxKgk3S9/NlPVl39W/1x9t28qleLa+7dtVO2nxZj0/qslmqZA9tmAqlsW2aajDGjVM714K6h0GjyjpfflGqoKaa5Wp45yRfbFYrK5B0YwMjSVWrUmOX7TRMRKmGokQy2zna+X7AdfE4DFfzjSMNicrhNF9QiILF6s0UEYtZf/iYzGTSruerPlXf3/+0eVSReASESOTiGtmMsXdjKHabO+QBrC/FGFg+1x+vprdkEAnPEwkhpmoh2t7rbUWKpU7D9Gv1ZEfaCTkQQY+7sDTaqy4G3dV0GiU3UBCi3jXTq/htsM8PvUe6bya7RQU7J5+JN7HwPA5vXPZ3cczWRT+Io1iY7SUcpQ2GFzdUk8d6+tfPn37evgNH3aiQJXHpGJhssQsacmp+tQTWvE07VuOnOu9dOY3btIjh4/p3967BDMf0vhw74T4pjBKJONOsP86aiQkmkBjNkgYaXG/l/2awlVSqwE4zik0RrRCBUAlDsFS0XUtdfe0d1XMzrbudqzrvHshlCiG5YVGYHAYbtJylOdCVIJWN81XTarE6pCxiy7Jwg/tYLev33ayI6ijrhtM208k1s76v8gTCbkAb/dVmY+SmXa/I/TAVjMjEDXAya3qZi67eiFazZTwXsGCyWbnBpp2YhY7q0Ebi/J0aH1mYkgz86umx/Xy7qiaf7nqzKayuNAs3uLrr2m47nC6rtSQDN7COPpxuQcuyGAUXDMgZiayHZtK5DM2lvKHxOVcI28qNiGFcvDES0aMECIwfHvBjRyNd/wnum3xeo322rcwJeJiBC8QljFjc+NKxCwRGDVrciLLhC4REjlvcmNgRDMQmDl38LF8exGAtQR+9uPFyk3ER0DYjNxKRQxkIix3D+NUWPZrBKo0fxrjxkQMaiI4dybixMWMaiE4YzLjxLXbJzJ3pXsqHKV+IKcGKBUvHQMRt4WU4mewJ6mrSd9Prrr4cDHl/KU++nS5jMlmcgLaZN8OJHPMoKZI7icVtHGi9fZP1b/VXYxWS8qeov+X25vm79lOd36UkV2Eiegpb3Hyh3pQuZlXzZLXCTPgUhJsWWTCMigVPWXcbHaV1dxA+JeHGUZQSHoSdCINl6/PZQ7iRECwbbH8xxfIq2YibUjsQmpLc0wuUwBt6CLFtMw3ZsCG3J0SN0N4Eoxo90SBr3cXU//FbSP2rCFiohnyvSCXSN4pOUhEHtdqpjqwejsD0spgcveQftmSIVxJv9hoXqOASoTAm8AWLeHHSTgZG+EREsBThtXvMimt4x5thsTVvxsnQXskXmmTwHRbakDXVWktO5UNq8mzRkEm32oWoXB3jOo/HipIU8hHd6EzVMn4D7pjl4Tc0s+chQumrRJmkEDP+89HpnF9cvHv/693vt5d3d1e//nz7+83l28u3P1ze/P7m3c9Xvx4UPVddU32cDaMBWUI+cJWcjd7h3tarVTN/SE96J7+OPRtNZaedjU4B2dWOp/rpY929aR+aOa72VSoHQcinlfeJud3U8HfcYWznAVB+Z4e0cmk2gHYHwenTHEMkt0PkveOurjGAKP0LFfqoUx/lRdIBLHdWdXOmylQDqcgLVUKkdl8Pf8HqIUaWfePdu5vzny9///Hy9uLm6vru6p3oF/PU5Z4Lz171ZEJhTF7NjIR6OSG3/PRyfN12TXq9/ZgtTeAyIiczRW/ZrpmmAD6wQCiW9p+pNwwgAm67iEaw7ROhDMMSaFPNmv8hztzQHLHESBbwQQUCQ39NAdKZ9LyK+cldL6qT6ABlvUAPiOqmex9ZPdb9wDUuPdtBVbp5CmyzN+4ZDdbmrG9osO0wcbIXwpmd5Hc3F5vmCXvYELbAvWV67d4NIFit8igQUvs24TjN5M4Ppj5Iba1x9ZZBRiF/oB3U1dX3Xb3MQ1pIfcfEo3RO61mN1ukhrdmGk2a5GVYFTZgzaSKdWzPl8oabK1UI+7iIxTAPj2w8zXy4mC/fG9KYjnIEF/0oloVMcnAslujoxjPVXxZNciEHhBXJneArVttU5B64CBYLetVZ4lbum3lN3mIpokVypW2PGI1ezaf1F6MfiAQdWUowvAio64JF9dJ9wUbdXFfK6ta6VIPu++FPJuU7CTftV8Td1SrAlXBzuJGBurRY9qp+td9n9VNTz4xfIJByoRCGOoI/Uoc8BoJeqGusne5RyNEH7dLeNU91uzYaBpPDSfqRyWM9+bRLaqSMJU9DN6ur+bv1amGuwkjQjS3YVKFmvsHKNDrxTXYZkhmYkKE+AaOnCujSOqtP31wIRQ+U/MYKqJ13lu4FXekbB3EZV/x6eTzjlPRqE07nYu7U7Yv6PVTUPSNT3KQHkNQrjt+5sFtt2oZgKLbjE3eB7v77+vKgPt8EGX6W974Df7LxPOlcPShS+DvuUYhpgpQnMj2IQO2fRtKpN7tIOoBlih+NSkWIbDQqLZC6V8GgfV/4199gpd8QczPqZBwkKqfGPy9a+h3AvgL+HSv/HpupgnAiJmpPJ2AvWvRe+eG78x44lqvYMjOdaa427U1ftMxB//oabOlCD8vcSJ+rTadbL1rmZVBm0L6XfJn50JtcM7G88aIlx0JxIjk5FIcfY1BdSzbIeNHCR8MOYYiVdGvJyIP49vFyG/AB8mW2/wUr2EDo8wfCGLb4Qi8frv6oXW266vPifX0PcHAHYD3suXk3GK8Aae4oX/l5aYe4IThYAzjqOZCrEaTkgDqKv4SH1IyGq2l44iHKevOTNeD26sff/3b538KEYpugDDU+6ZXAbn6UZxV0dFWaLxGLgOReEGEVZmuNsdpTC4duqZsPOO3H9Ob4CoXkabjF3sQSSjjQRBcxhsuS3BlzKpHLp2czxq5jpNj5z/+hqT8bCI4S47XPoshKXfc+fZFmZBNdVK1dcPMvkuVZ4CopmpNHTMReAFS6xViyYeUWYwdMJG6RJzQeqrKwbGP1bnYhwVycH4/Gyb9ANfKBgcK3NgcH2j8sGSCofVxTkKDCFAxvLt5cXfaDl4ubyx/7f6/O39weArqZBVRFAh1XCdnIcfuYoEcIv0GTFs0PlpZz/tXHeuYC+Gqf1RhM5XGyaj9e8SEOszsh9bLuJ7MrH+RDXifk3dz274O7z8qZNo1Gxu7e4pP6xSjz2ePhynRp7CGQEow5CtJGJcZTC1gFodUmLu0IicRWdphE5UOPlUhowAETGwcbnS1AqIHaJoJh3euHr2+i7gkliWV9iaSYGZ2JipsZRyWEPorOSI9+tHFI8e4CBxL6bqsP8ciOWCVFh3dK2jd7jEdv4+YDPQBfvHIYJKUWOtOfTauSGQy9PsklM61UqrrEivdevRQVlA8NRqxoykQla5tWOnmVU+YrW+9ECMNYvzQ5tceRJcKjdBpy24bO8KwRxtEZJzTb03UqUzpUbTyh0NUqswZUbT5b1FUDU0JUfTLt03VrcztBsWi1fLCqfTIEBXEWDhLVrgoOA5QB9IAjJgMhHIUaroJEyGj1RaomAAGiQ+mMwsKIVZWOo02M2jD6BatrhwJEDksVti+QOfBnxBj/RSoJCwNicigNCBox4XiRSonDg4SAejqPPFAo3K1NZc63zxjkuwJMQp9dWylzbOeWK4dxF1MEMT7VYWUS3lqVuczvrVrJwNcKlM845rkCgFg/aCjziScNrTW2+cemfydSuh1pBNy+KG1EPAidDjLZ8h0uUDRCHoTAHcoCy/rh6/tex0U7tVZgJnxSxqakCezlTkM2+PK1uWkcpU5DNa37DqYlXo8UqY5Sp6Hq6uf2U/3D15+7KpqWYnS5tBslMoDgbjhW0p90OGF+/ksrnF9HPu799ELOkd2632NEOD+xmbELzbUOXInXCrKcXK3C2OPGjwKdqONV3tROpX6sV1UzW7JRnXL607RtQkdZ204KN3LiQGGNnT9ghKWtmqxI11ZdyE/vw5TxWx4kwfmhmEmEV9mZLyQSwg+hSrRHIo6pOTooEa89W3wibqNZjHsmK0e7c8kd495FFYYIeLZkJTHhMpTVJxbxSQMygNE+HiuiRB038qlH+W0fesZtl9CbvDZKbzjNIeNi5zqsRGLovQyk9SJFPFoMu/JJC6PZy2pNiGtHaq4gwh1pLUEH8uNmTR7uQOTkLh0IoALqQJSSjXN9EOQY1+dET7u+InqL64PpEUeD0CqOpoyHdzRQBZodzZhaIx0NXnMmR4PbZuBo3rQPvQFxfiX61cWN5DlCXiPGLDgzR+pVDstl7YejQJoLAaC0Dkgb3xioEptt31Bi0tTZUpssm6eI40E3J/G31/VFd1Vtw0CTX8vPXfHZaYerUkA40kxVCRw+SqXlUzv7p1UMCIFIKUHgmW7qZTt73l6lyPknIo2Ll+Ly1Z5GJKekVEFs82QWxzg5NpCIB6VZHvicdCGV5OGFb4YdisaZEH/P4ihe36AZO/DMgtjPOxdy0ncRSEYtXEVg0Mv3jbytmHtIs6WQ/aRiLabeUmlP4TJlNZ/Us3fNdMKuTKYpfBYjyVyL3p3Ni2BcLqFRtBUSVKuwKMLUgX0dxFYD9NKHVAu21Q6BJt86vJrft/JmYZDCcXswzdWwIRgiM73UgnlfV2HIxfBNKJoK33bKYKCNJkCrtrWUf4nCzSS4BoTtI6YWCjaMGCsJG0BvcbVwAVL0s4/p51lidh+Tlho9ob3Q4jkeyNwJDM3WIX0P9WoTSQVpDBL7lXg7nsMh4vTeHFdD7Ho1IZ/j4WliKT8mwQ1RrcLugww2STsg1i5t3odtq4Hr+antegP8bdi05NxPnsTFBTHZQm6IoC50RRxFmTsSuRCXxOEobgnXyxs/+z3MDcBaC2QjkGvC1BBkawkaw3XXPi3Ybjj61aUJ5DlC1h9j2paPCJWm+1og3YtNos1uVP5wDkGQpB/DgTQygkBpX5A2vmlR39ncqgwlJhsUW2pTW2K/f9iMmsknsUdJE/g0JipTrD2lvMYmRSq2tSqQQIhNoinM0Ugoidav0jhlvarABMXl0CxaJA6qlXMypFLNz4A6BVdDtwK7tzGVnnY4Qg3YfI7AElxOcPlUNbPbet7b13n3QF6okSTBryOoB8F+QH3fPKD5nsUy9AdPme2HgTXV2vnoVD6kZirjsV2Sh+tBlFc7eTOPsku5aLtRWDt5b6xqvSIf60KxdvIOWM4mtSE7vDkwAnFbRKb61sugyx0L+WqX2yhSzQz7rP2Ad7mdEni5yeDX8BCyhh2JWD1beptWkDLrQ5LfXQaKVJ7wNVkhrG2YSKo135UJ6B9S3HXVfDk4NBQkF3IkIixMhGHMq4QDvQIzYwDuvQQ0ylcG5lZYdE8gXHL2ckCm9OYbARlbSBr8sB7Trq77TD+3HTOdYdK5OQAub9gRUIXgzF+4sZblsF9XayBareibT1marYAPSTJnS96nhXDUh2rNFPStqwKAfNGqQbdwuymrHrjaVCYIrrS/Pr+9/e3dzY/aDfpkOrE9Skrk2/Kl5OWxmob8teBNsTzSHHIEzKt9BnYkYMg6WMkYuCAPd77nvre5b+pRfEEe7nzS2wEwoB60ayRMel29vz1NTzuij4X6MmG4Tag2D7hH9/AufTtGUc2GTZT5NN904UBCCVcW7TZ8AqbsEnyojxUG/gQIMPSHtAr3p1ONQr82fdRYpmAUA+nb3gN1GXVuit5YxEW/dHc+S4BcmY996WHNpXv6sOljJhUZ6ML7QkJ0JM+w6jMc+ZoY7C+RGUmwDeFBdR9Sj9QqjKXLRtHY1xcn+dQ3L5rmGzwdO9FnvZ15qs/SpDsy4l6MbRemqyfNYgip1PM7C9MKK5Tp2mTUn64//r2eIMqOKQtVreoviJ5dskIlu3rWlOSfQ1MSjDSlxVzvhVx4EVey5VGLeA4LeOXLlsiSpYtm0pt4LBkyBIEHkZYKAwu2rhQmV80nS1BAxvoKlLz+gm7Fqfr1m56pLA70bJWQ3qhoOezkFQFckE7XAXsnOn/9d+mK3IkrIbr121QL2YXf6TnqfXLqwZ7oN7HB8blSj/Qkv8pNmVnmkJ7kseRfstRR9ABPCs5P7665d21I/SXP7YAs8is7JE3Z4zo8D7XG/Pby7pd3P0prcdsUssUGvZDa/xT2PPzbC/b1gbG+hdWoe9dYVH5ZgelZjH3KCQob9COv+c4U7kKoVREZAFkUOUG5A7WH8n8Dlj9EFutBeJGleHHmZHWRPLvCP+VDVYb22oqwUKQ0RsM60Sl8Qa5eH3omjoEogRAzl61fyYDQ8tUJKibUqw3AYvGImIt+i5fRZBRlFe0Ehd9qPPgNtIvYgZpH3/Zx9wnKHL+ww79ipYyz8yti9wLsMWAqlc9pYDZnwz2wKb5tu05AKLr1FaRZRPZhgEoFke2qIjLpZlSRzH4PKk9muP6UZMJuPQX1i5edkuqhO05B7drVpnQrKrzR1FQjwkWmQq0U3F8qWHB2banm1MhULk6Nz9lwN6mLGxFIStxIEZl0y6ibG9HI8KtES5qxSbt2cahTMy6oEeGaUK9mrFKxK/C7tNyeHpsYXxOhmxKsQ2hR/FJoWCpuHluyEZHB0bk4Ia7qp8Wsb5GX84dmXkKXZeAEVhN7gjhVLO2E1NXLehX7RJwoEh4BlFzDkaXPvACZyqWz5HOG7+PI8W0zAAHBOAMw0chdtwBV0nWbyCSXA/BpvsaJkvE6AKDgbpzYKMcDgHEex4mK8D0AFON0ypmgOZ0ApM3pTPqF63AY9cCNOLD24bzZzVC/b6kgRgEiFXT/LvJ1PZzHLrqxx/it2Et7xO9lvrdHpCK26MKbTrlRKpcWH6SSNyKjGvibkanlw6xApeNmmQkbNluhqDuaYSTurmYrUHgzDZE8M2Iqkcsgi80Yu6WGYrcNsXgA4wjLwiIPsHikkvGVwoXdFsMSqTfGGLTT92CLH0i4CNvyPcTb3HkA+Dp38W1RC6h0wbvUlLAb3sdgQvf/sITGME0LC3YLPI9mvwberRqFK434b22/1sj8YemrjZSPa7veSGkT8TsYtbpKQCVy6b/YjKH+i2S39V88gP3xC5hF7r94pJL+y8KFLA/wdOWrAwoj1MfyXFofa9HOv8bBKNef44B1d2FaA0Iq5/1FxHcwuNZd8hCG8StxL2GIX8r6FIbYtgI3+37TDWp+lkzl4mj5nCFPS+PbXK2AYDpCbWKRXa2AVOJri8joZTuAzLJyp5FBLlZg0nysST/jZAX1ipc1aefdmdSGzP6soEZIh6bWismjqVTB+tgmir6dbgI4WnZlLE+Fr4l97GXfd2S0M5Pt2VGENgUCmrtuYPPC5X1Tdz9vjza15FYjB0KLj4Xq6lm1ap7rzd2l0TEJAIkSHgtEXB8MkDB3CJchLFo7QCBToj49IHRImDXP+Ge/Y0FxlviJoCOprfOmlBpnSJj+tM1LAFRjH08gNXyJRmvx48n41i9xyc1+PJVwgziFo90fXsyR+QGJgnQARQzwrTAJAXIljKpvf+p2SH11sD9IPyvqXx8byzNUyj69J8n2DFmfDvOnQWpXCvlej5Si7FIP8KvwN3qQH8V+nQfFER6ufKdfEPiu8G7Ad/C1gHRKURF6I6CQtXoZIFMAsNM0QbzSxsxcHiNusAOogMvrUK7AMt799uvljWZ2eSLU8GJJ2fTYtB7GJ2eumR9fDGkMUIrx6nPm7yEY7YrHZtl8nBVXzqujvC9XP/QYUVd76fFM+SRGHD45X+EYZmiZvhRf3BgptN/ZqGgWr2uMVBfc1KjofqrmFVbsY0ov3Wkj43VTzWmcbvVCyEh/4V2QOYNhwG+8AVLRJV3+GDcn4N5HRRd75WOkSL3tUdGyPeD+gzzlz07T/6CMV1DNfRrmWtNM6S7pqPp897mfcCEKw7TlGreBF5uMAJ1x6nKtXf3UPsNa49QjWoY2rRp/UyLkB6QplcP9iIQ/DDrxTTW+rVdV/yWr34Yc8k9ApHHp0rl8oZ6dArd18Kx64xKlgYRdbWJZzEtOBprdoOJ2NazoPORv57FQuaAHG9JFskhKT2nQzLsF3l7N3sFcE6STUGrD5CsUojDE/bBEczVfrOnLdOIk5oD2YKqj5HoGzPgTXkb15h9U6y7xKIXx9FfTKE93QZXLbSQlfRqB0hoIWBXTJvNuvVJtZpvGcFQ3mhtrWZ7Jk+EMlVfK7DKzWsXlMlAtYDShVtRqAKVvmvkno+KdiF15eFSC3yZ13iJFt0fFGNoRi/njF/KLt5qAbSYPvXQM8/iNA1p/7H/4wz/IKhV6XaJlRk2MzOHroAg96qVfe5myixHhKbxbsYKbEIXbrfYi6h2I6YIBqxdbL3ArZqQOuMtuLxxjCkWPVixEDHHBwrXAgybgQs+wrBs43miThRLJqpR1Ek8D3qoCrnAMzHiHxxSVWqFhCZAFGrfiBsqQG0z3siEjG8KSrw+xGMjykFuZA2XIraV72ZCRHvZc7GMJuKjvNIHLEIjM1HL3XlsY5k0rNm24oATsGgzNIC/AjKHghrUsx1HAk+QwUhdv+EtoMiHnuuFuTWfr5qrknkGVpJnfTh7rpwrkCJKPpLBcdNjaoupRrfL1hq0plh7VqV5qmHqm0vsMwdJLVxmSNVByiyHNkrxT0NIPH7Qlbx7kzSvIreClA765xj97xgGUPW3QjnrVoHV40EAlUN4yaF2eMaAo8oNnm/GJfOosTOJ45CzL1nDeLKK2jgE49cZRgIlEOstFktjPcDEkhgNcOQh2egvRLB7dyhVD57YQvcOs8sPuOd5rIsaXA8jlsO0vnEw7Tka0j8KzZPj3EQ6Scd+o4BQZ12YC53T+cdnO1sOBs9Xj1TAxqybDHf50M5ISuzgsVQHkusQysWdBiU5Cx1mwhzky5wFSQT2oDkb1p2Np+N5U56H71pKvFhrvevXYdkM82SYV17vSyXwMls8aM1W6BLb5vgRhmvWrNEhPI9EovY2tNjraRwnqO76vR26+seEt23U3sfEdRE4FCPaLolWb+8YSqyL7R92yTH2k/jkDV3M1VXvHPImLi2GyhdwLQS2cX4FV7xIjLgUnaKa/hkEjGsMhuS9FPV+uu/q2zzPv5TiUWGY0DzQC4Fi0fh/XzPf2nG69j1e0x0srm9+vq67/vzCQcru8Ev9oWrK5/LIargEmV22i3+Rcgx1x1jUEWx0m35Dux10z9wwU2gD/DdCNG1GxtnmeCe+B2dMVqSWqJIApnqoSDqr17ecsgyM20wslAtyIl0nn0x8JeWOdElMI0zBPpNDHeSN4mHGdCAQM7GxE4EBO/lbkSG4EBzMhECGUGUERATl4BChMo0fAaqI7Hrc3QEDLLFJilyasKgDvfhTKZBlm6jiGAWcJVRfIFNAl4o6U0FBQB9QGBCU0/PBQ59F7Z5AoOPf92+UPV+ptBnki9Fh5LCkfK2fTehwrlzPXjpXzxTAeK4cwlGPlfB7l9xpgXPo5BwtbsoX7m3wbz/Fnty3cJEt4CzcgtR/nTpWaD3Tr2qUj3al6+6FuXb92vDllKDvgTHKgR5xTBOCQs66PO3qcKtMOH+uamuUQ94RW7zHxGJ3DjuOQEX0QOFUaph6jVTg6njVf/fC4ri95cFnSpzy3DJZPPACcFbHoCDDaUthDwHRrMR8DpjmCBSGiCwjWDcAeADlJYGmRJDW61kEo0s8TBELCiYLMBwhqVRfgWsi9Nj3kPJA8IAqnCGL3IxDo3se1wAd1+nGCQPQIaT7jY3R9roXFTvoEUvJZH/6Fe6O/dS1k/LA9vxQZyGWv2oeebfjOm7S79Q7u0mEqHe7thGuH2YzVi4dJdAag3RwbeWwWH/rh3JS7eZhnIeXHY2WhdhAMGW9XiiBfN8xDABcOmzHYzRYFQ37m1YLB3foAsUg3P1iAgvlnmjQbBaUJXOagZKbQLDTjtc1DacWmmShKwN2KTCOI9yIXMwheScZR3NF4MjYGmOYxRgCjFMI9yDSHdhPyOBJ6dV8gscQioyTavTQ0DnQpjYUJio6mWbTYaFQrs4pCK1XWUVCd/KyY8ZnmebGt9OTMWKoB09xYssnwQMR8pnVTeRKfAxF0ttiBiJza7oY4ALMjMtIwxyIkGtPBCIkGOp7AkGjHE2C9wiEAzibshwCMtUAfAhBrwnYIQOaJo6J+2x9CzQ/GhT+ZIq0OglSoVfyj6ZAck2+20oflbt5pibO17bYcqQsOzVHaSw7OYSTy4TmKpewAHUsTHeFv56uunXH9Rfyzy+cmssQO78ek3JLYNlW+B8Go3SdGvDFGwMQxUfql8CVcO3o4maoANVQJ08odwyZUaoewIX3Nkjl5Tyg8piVqmQgSwwj2b4xcWOyNEDoh0y2x2whQ3SZbHeO5nuruwVZRqYQnjXRonrVX25F51k9Ejnd4ejuIweFdMJ3QyRkLmYNumSmH1T1KIEZHaSMS33iXufR33kfTSQ+7a19Pedy9hA3ubEQyoNuxkbAdkIShdkUlDIxj0TmMLka3osDZ/NKrGdZ6LnvHlC9VRb+6uJU8R8iXxJimuHVCYx6tbtZ138zo4FVCXZDWqJH4UFxnkPzu+rHMrj+FZQ+gLa7m0/oLpjhIjbgskGFVPy1mvejl/KGZ89YTkWQyJ+DJh0MiCjpT4SlA/03bhOq2Qb2MtyaVKk4a1DiEUtztKhHTm0g41rrQTwg1YOoeJJJ4KSnoQpJ1pOCXkgN7O9Xs7etMUjyWoV0Ms5aQG8z9LJSkrYorB4fSTCdURcJAmbwLlnhPvQikx3EDKPT5Oq5nO9EExzq1AY8mFTtW25DYh0Y/P6Z5XE8O7RTZWN8n8nwftI4+r271jmm69+v55g/LP5Hp5BMnUVBis3yUFWRp4Mzb7qFexU/QBtkef4X991+X7fymXnT1sq9L1rnmqXCv/felKc+zXXraCRG43FHn3ZshFtWBTIH64IzT+cXFu/e/3v1+ffPu7fXdAeF4uCZOYNoKOt956uAsV71cz1bHgeW2N2fTwRtEQ2kv2vlz3S0FN06mcvHkfM7QZIXGty1SCQimFSoTy2STcGWq67NQyIMI7N0kInXyYGJg+jQBQJlIFGgnezKVwNSZqVSJ8zYMwIXkuDvvfeRjS44vtezPDqL89zCOd1dVxxznUGEOom4wUkcnoqg9nhFE6/q0j6T3gf6zJZULnTEV4ImzJhVMnzmBSEnPC8yg6GRufa/nTIopUVF/4zejslEJPZDTzKqEh+2THGdYOlfSK0VBqUlrGn4zHdeDMlODWw9Y9qNApCLtuNNBaA/GnDNoJ5uJBNDc+aQ+Zw/k7LFTCHxpjOcRFBjbyQQzFTMd0KhMcwKICo2B1r6dOha303BR4AqKFg9eyEHHY0MstshsyJbiBt7/8QFr33RKr+Yt5I62bqYobOOefDIX9OwgBbYiG9NuvMYcKZHJEtmT8PGuRyKzeh6VCXc8olUhfsfGwrsdCUT3OiUUnNPRSaw+R7eh8PX0fq6khPnmSVycDJNt0ZSBKEVpaCaHVRyeibMJ73ZzdWV/thum4d4vZ1CM0xecgwvn5UCQkF7xQu9iY6JiakFz0uJqnYDlYFuOFQ+4dcKUHowXzc/2XrzEE/rI22H/ZgKMyriELv5SzBwak7Hl4ILp6uWizzb/CDJKIIaMMAAqxC/JTEqfbmXgPbXylcz+uqx2yKaD1JCpASH2FDSjD/Lm4Af/XUEiS6ihfBizD0gpNQ25We2gCZKlVgfXmFam8VEqlSZn0UeaM6/TZMT8tw5Nt6k/A/6fTuZjynzWmEnTJTCatgBhM3GNBjV1qVZ0kzdRcKYvIGhNoEA/3RRUBluT0LiCMKNeaFknT8wew4yCX9G4peftZSn1b83q8bLrgqZwzDZLI2YeBNu8v3nz++3FL5dvzw+5HgNtjj/CYS+/theP9eTTO/2KGDali3eQcy+aUvNFs63OK2jS4jwxmUaokFarUCkN10zBezDty5kHjIU1RPoVqJZMrgWyqnB5Sm9ZJ2pSnm3Jw1D8LGR04zG0Gk8Oej3AzzZho7xrP9VzwDKZdC7mKeUNDQi5Qti8u4hh9O1GIu6echHJdmG5kaj+smiSUycQVCTnw4U0Y5FJ6QGNBA/1aiMRXnMDYcSCJ6ib/TrsRszKFoue5MstC8ACqRMwrR679nM8MoeoIrkTcPFdp+wrzf1nUesjOy+gBZp6MIAsCL46n1aLfpL3UzX0E+QtqnEKPBBre2fz7dbX7jIB8z9jZGk3lBTBHq6FEmgRXEk+ZCHowcTFrKmHkNC0mvY2kvzuMnig8sTu80hgbYMFUq1xkAAS8OciuLKbTkTwFNnBYgxgl9Ja65G2zWLLzfR+nxzTTEiNq4HoO2z+gTh2KQv3FkEc7n4ZCmjsu9DgV1svhhOEGNIhLdYdGKz0h6/v+6wv2ilYOZnMKYgaQ+PZJ3flGFziGjXgY2JXhmnde+U2HzaTDMfErgxd/dyPLH74+nNX4Y4lFxrLJHSb6SCGIUNGMoWdaDyEsPel+RimrENLOcb0azkT8boSM8yD8CxjPVt9YZ4+onF2+ARgYL+Xw5y/mT9w1Zb87mKxVJ6QqaawtmEfqdY47AMJyOEGqZ8fbmSNAtTNrUeR6m3rUDxBvJYxeNq/1V9/Qr99LOBIst4NDCwwmYwnTzM1oQTJHSk+GRA+naIW6KEmXQX5ULNAIzkBIvWJEyCDNmEgy+plBrLlBMTAVVLejC45N0gktVKDxAKd2qCQ1C0NCgsYuAE629OlA3TQz/MdNzfwpJOdohs3DzyZEozr1uKR1JjezWPQKVaRZdCp11VgGtd9DsMq9/rhkQPLk7iYBJMtZA4EtWV0xalW13PKGJhxPUcBjOlhDqQv5TiU7hTXS/aonFaxU7XpFPpVSTvQtZo5iN5VQRA6WFw719dIbU/qbnDNXO/OadY6eFyz1sdzBGg3L7d70bVyHS+b8kSO1tz98kUZ6/KsqxlWKns/rFWXpSuGCMPtzf2lZvvn4dlnU+mU+HYneUc8lj9/SXxYdKYoDM6iz+Jz2/HvhUo8qbALUDu9GL40/Z6rSBNKeqDUT1VDvnArUeyFPD9O6XdxwoiGciBCNqKzqQ+8eZ448xx5Ehf/zWQLOW6C2rYQyik3roXiHOLjFRxNwbMVOBHtmzQk3im5MOXuSQWi/ZIHTeyhNJDcNXl+JfMHcichp5wchWFNXyRAgic5BiVuEtfLh7OxPswcyWatBTKITa4JU/yazBNeJT/tBZrV1+uufW6mdffLarXYHVPiBnmKCD7aW+wyEOLmEF1neT60yWhlZTeM86eBrIjcI0EOeI/JEUor2lF+NFZ4FT0vldm9kNZlqKLlD41ZpALZBi8qjnEUU0DGtTwYUWpyfF9RQCq9ywV8V+vTXAWEafuD6aiGN5YMepAAAxvZEtCHGtRvaH+xobSm6CcTsNqyvZ0AEQZHeZunRbt9HGEvcuA8nuXNE8GnbwchyUMnv/scCyTyhDxxCmvzvqRao8cFCTQvS6KUeVaeCL2JyuoFQI3yTVwOrd1UcvYiJI9WLVhFFG65XvYDtLfVvKIj+8OfncIrsyzBsMqI1HpCIVdquj4W095PlT/VHfHaLaH+mNZP/2SXig73Juo9Sj+KIzLv5aL6PP/NUBmJgNECkmvlbpv5w6y+e+zqalpTQc25fkJoHMN11zxVZNwypfyYepzWbQ2CSg+JjTqDgcCqvWj7bn7eSyz/urwLz2IdBwJ5ItGPBNnPmuUq/i7HnAhFUnJRZbgCwRhPMI2NU8CDmm11c442+tXFz+Y5Qm42xlT8DFyYs0wCcTYcCzKIIBiUIQSkjR9AUIU2Dx8MJSYHD2ypTUMHliJoJz8182Elb7hhh2okwc/4Ctz9VgjK8CxITH/PkNB+gJTVp50YDQUPjLRLCJJyU508iYtzYLKFPARBLX/PyEY0glgGmwCJRIiz4GAUj4Hr5d0G+yXMvsNaC6QDkWvC5EVkO8mbAW/9vkY/5j7qI2rphx79fUuNu/A+Z1CrZEzjbUg6LXj5ZdVV3EG+w49eJwPjDItsKGI2mxHBYLYkhIAxply90Z5w3aRJcfpNVsUyxK9s/nfVPSzfLTaTiwPI9mHN8Cd4BrARuq66/v+omLr4ZxeDJbKEuviE1LKHT6kUA4wwXW3yGSR1x7RGjeH4treR9NMHo8Pjr/jodr0Mj1vwmZ3tE3Lz8gMYe7KjayaraBFI0BalLlU5a6vpT137dDl/RnTGyUuV1vPnD1V33dX3zRdEa5LeojZtxWK/k6Xwa8t4D5QZPOP0ohr9OiQ87x5Sy1cYcjFs3G7iei6AevYkQrpHhkWZR8Bat3HV/91X9TNsH5EIsuqC07CDFI7FPFIxfg9yyCB+E9O4QbTX8F2JzQrh8ARF1czrbngF8JY5bccndXEaSvZF41ehdNz59Xp1U2/PLVzO++6mzhuxBkpmgbVpiBfZRNIYgW1b8Z4JOyhzgkQDHXshhh10sk9bYqEHyVPipgZbYqEnbEKPlb3NbGVORbQsqKPlSetoWs9q4j0pDeogdiquutDn1byj8/qGfe83+/rz0bfavyiRw4s100/117t2G7103xT4llz+xdCbg9a7lro8V0PP5U+KHkyMP3z/tnnodu+fqkfw+NT4xLn3GutFOoDCdZwl8vQYXCgWg/W8fWAm/HoGqEjaCyk44lNYV1kOXmiTzSVaF129MdxqthwBKeTlh1tX84PVlJj2WZ6FF9y8/nw++ktTmTgC3o5stHkWXnDLT82i93f3TfcU3+lucSl5HmPwwhepSIGsf6CTucwZhayxF6noEtjmWhKEKXDPRsPaBsIlGoUXIdHrIGxMd+NWb1Rrh+qMa+NeZEyXiLAJfaEXndorQo0S6Q79iOmOEQPle0QvPr5vRAjlTtGRkeweQUK2XxzBB72IJ2BpL+KZ9DfL3UcwIYRS2MqgjWq7kl5ClkqehI5/S1EiM6/Il1gS/bahak22tw3VFhgMsvpukN++C390GVBlGULDqIiRcSSfiFFAru0T3OkjOqf1fbWerT5Us3X+UXPlSfIRFIiLyvUrjgnRxTct4suaGxReWrIZcSU2NR7uu4dXu/TZrK6r1SPfcPIkLs2HyRa72iWnNjQlTjPeoHD9u3YypIU5YpnRPND1GAyKdj0GrFe4HoOzA/v1GMZaoK/HEGvCdj2GaCVBI/yhWtbvuxnfBNMELg2QzBRqfhmvYvwtcfMmrT2WQExfYEEMn8ZQzB7VyRs9U/dmk7eVnjR4qQZM5i5ZRRhF8dh/3CF73tzzJD5RE3S2ZdESeSnMRsDymM0Ap2GaAYdijAK2cpAGKbOYTFLkiQLO26ePzbyeHgSGfc/ZM3XokkvpE4ou5o4dqGaLwnjpbvc7caRXpgkFy1mg8HQZRHHXZgohTF/5PvaY/bIaooPokVqyRdQjtkT5drb5nKbZGJsL5DLKjcTNOMY2G7y5OFLIPn20SaKmeL5Y5GP7xcJn6rrLB5ur9iCM522kC1X3OuJE0GyQ13jPnsk76AuTjNSmnCc/ViN/ipzXFEc8rSpijnFQsP+5IN+WN6Oz3a9QruFN14vFzXo+r7ur+WJ9pA6v9Y1S4CE1wwGMurvu2kXdrcLYNDnvM0KOLVSIzoeF3jcPqPJD6jEqn6uuGY6k/tD/1MyZe8MJ5YTcGIzl3juh+kOBMYqr8OyAorNKDw1g6mLnuk1EtY3tL16ONsgNdbc7NFtkQqLKFIxA6YzfZVjnIQeJwm0SvEzEHpZafftUhVp6xItZc/t1PgEKc0w5ShumaWzNAYrChIW6HobVwMmnvo+7rVeryEsxSkmJcSU9XJ0j9MpEuQmxsTXOzhG4mg8EXFplvV0UuM18NgNCpPfxDttywRxEeheO3X42PXDOv8g2oWcNXHad3gkkaUv1E+vvH/rZBhlwnvzuufoe5WlZfD/AMt3cx20yTO8xsWHJXSPYvSpHhbSREFF6fw4ThC8BM+QgAUwDD16/Ye8j1o9tfWga1Z2PxO5LNz6wkkv7HlTpS7Y9KBuIbzThl5SPv/ksIif5oc+bawvFE+VWlkRpnLpY61Jfkk9VUyIm/dHOwDA7vW6nUtg2lchpP4DJGNwKINhtPooHMN5mbGEZnHDN3WfMEyViiAO1UG3XKbjgTvFLRXLeXF27HqYGdrBM0IEM283hiNSNHFy3tIfDfqmC7RtrbTA7N3KNGDdtZKbwNpz9+UDgyB+XFl+dTIekaObk8DQpMV0MBmQRRmPBFIs0HmsMwsZX2Rn2Yj4QD3WflnvnTwYJRf1qJJkumKqFmDo44BSzjAKJxx9Zcsp/ZIm8xh90xuj4I2c3jz8YAPv4A2aJG6eOkrdKsf+EOQ6XZBBP+YpfJpDyZsp9hk5EOwsfHmGVQf5gpqWGAiI7jg8LOAJjUPQRGKxbHIFxtlsyAjPWBjcCE2vEOgITmcKX8fYpuBu3owT4WOsYNYBlehYJ0B8/Zj0qRu/eFrVq92/HwgEt3W1Gydkn4YhELt0mmzH2CBzFrn1n8jZuniOVwzpRhQx6F4xF0h4EM+gWXgLjv4z9CTBzbdBvfyk1Ynv0S7EdqolILcO7QYwJzRvV5zh0NeX9LdLNumiWDczDrlhzerMZj0tGlaVwMS06V8jR5sji5IRbkWQIUiFkbCcRIYbGoCiuFdbKNy/uK5gbmbEGSIMXa8Fk9qKFBMb/tp2uZ/WH7W0c7D4ymcqlEfA5Qw2BxrfPuAQM85SrhKkAyIkGaZwCjNJATdr5RipZibmhFtQI2VjVWjE1WJUqfBOsrqf1NH/EnFsBl9LjM7Pg+hlylqRqOUtyoE1GLBy7Lr5cfm676Qi2NAtHuHZ6McQd0avVAFko74e13d37qZnV18yugo6W5TEOLzyQw4hkrZBL6HM8R8oc6qDYcthWk2UQ44qylYls+BgZ2+L5DstKR7d9DI9v9I58efMH4eh270fGeADY+LmmP4oQOh4mkilDEiuDcFxOriD7qbmi2qGPrQE1ZDu9BthW5L67Z3lOnaVwcthUrqCnTpGtLppUbfbNIMVyk5Cb2TMwqRDWZkGiBXVbBgOywO/JwGuknXyq6QtruOoIJXxZNgltn8WBAXOeJIPqNUGt2Zupil712VRYs+Soaa9Q4KFNdc+4ZqH+jT5ZsMZwgbP6n69v5IXANIXPAieZK7bAmSFz54JNJTq7ty1qChTffv/t67/AC600Db/QClPkx2De0N0T9zFimQKCYF2iT/O2XlXTalVR88ngZ8N+cPZ0vZAj8HR9yMh1ZA15CjZTtk1nURM/7P60mKVfK3rW/fi75SA1eXw5y+xsm5BxuSGafbucVKZtk0dCAxxrYkx9OdUUWkfFtUPXyx+/VzQldRI/PBgdP2N01dm5M/fibFTsC/StVqAtEFOkz1VHXoQfqtulOWGBBg378rxWC7ThYcMd7ltN2y7NCcszaNiX5y9acTY4THH6ccfHdqnqOyY7YaF2Sg7f6RutYHsqpmzT+uNadQ37RCcs10aF5jZ3AlscbjLSzGZc93nQtk90wgJtVOw/079rRdoC8edemXHO8Se3065hGdCDrlmFRSO1sO/hNEmdj67hoV4N4w9VyzEdMiDW9dbkSehUq9wX6Vqi3oFTInYPuo7IY3M6RJet60jdKKdG86O6ptipcXpkr6ZriT0Np0V2NaSWsPH/1lWLRTN/YBxA/LOLEyCyhBxBQmpbT6SUEouJkD7V+TDKRmqinQGlK3cI0sIHpp10EpTyzFGM1006D0p35kDG6+acCqWecizjCWhnQ+nPHc547bQTorTnjqhMezY/TdeBsgERsswW79VRaztituDSDrOsYxvfsXqx4etePCI+svz56KXfvPv59zeXHy7f3B5g9heh9SyHH8V6/fab//i31999G36yN/VzfTzeORBvSrb5s5jX9+H5otWuNIHPu1/PJ5sX3/8U/oxmuaxXP8/aj9WMtqpj5nRCVE1X9/JXwzed66r4xLIxh0/Ktc2U6byPP7l03El2RcHbAa2hQ001S52proHuSFMdtk5U10p2oKlSU+ep6yQ7zlSnqdPUdXIdZqrW2lnqmumOMtVr6yR1rXQHmWq1dY6kVrrRc5skWQpnF2DehMqRbSN4RrXtuUiBAd/84SoBGSGItRBOy5q+Rts5NysLf/WZlGU5YnOyCNM4JctVmj4mp1ufnpGKzWVEJme5JuPcDNFNT81y1baZGaKZnpjlmm3zMkQzOy3LlZtnZYh+ZlKWazfOyRDdzJQs122ckXFtmXNLXNdDJfJ3UuYOiGTnXFY0hdH179Ob/ZbWD22vRL9S21lcG5GUO5PUNwpQSPdo57jrqvlyCIDLb9HVWCJRopaIgELNhvLbRLlD5/HPbrsrSZZFc7SE3BYQR0Fgl0kWH+Ymy116lWT5AW6+5CUXScqHtm/adrWPFucsjEjjYmZcvpATpsC5YLQ+2dtqsTAU7SySQRyfzIMYPMuiWL1BM2/6/Lcw27+5JshGoNSGqSUothJOh3erllxTSH73mQoTeZYtiSXwZiOgSexvP2Mc3PPhFITxfgMTAf3sNE9he2+aJfk+DKb8UM2a6T7tAea4vJukEO0uWJe/u3x7/eb87vKQ43FVfv/TH19bM/v9w/nN1fkPb6RcD2nw1eddHsPDBELD2/7s2u6CLLH1p5iUC8VKP6akNkgMrT6BBDPi6W1a/Qx+dRvT3fZz5a6ZYuqDxKMILN4l1K/0r5g+3atGdlbsVJFSix4tL3mRQ8u/fzJlOT7x8dclN8Fn0rlNYri84XgxqhCcyS82rtrGcRRCLF8niozh47qZTblnWUSsRPIEbLsrHOnJD8sVSJV+syjWf/3xvp1N6264s33dTerlz/ubJdk7G2QRPHIgPSFj1EEemQlrQisbg7WqnxazvoYv5w/NnD5GgNBl2ZwG8suqng8Xc4znDHJyRX3anTa5XQ12+1D+vYmMXEHZC6QhOvkeaQNS0onkAqTDyJO5dSFM1nAPQpTAtrslQRhPMdt4uDN8EpDtIJ+Nh3FNCJbgjtzpMp9kAiT9kBcj64wQRNEBeRHSN2VLWJa7slUWfIjC4UAjFJyhb8Z9suVPG+9pAkkl/etn1d7trPZNM/9kM/dU9ARfr2vXiyF3ekTOfr9Q7HQ2tZcosq1A+HSE2YlhC2Eg7E+4t+yG2cHRWkQDr7PoXNHbJ/x8N3rswTbdpS7LJ8dp5ZMmecKEhhyr+rWgYyqDAzu5blpNp7uvUk8P34lYPSXTycHI4ZXq055pc+9fPggNbyPPk/l8WC5j/cNS5PYPq+rXjxZTWRCfNj49vX3s7bolT/2zUJHY/0q1HAnUO+iJLAJ+2hz7X0Q7DH/3McAsR93yIkh73fIatSqNJAkTC2sy64QDgv1veA02h4+p5ncWpWV2dfdwjLquXgwx//NVtWIWQGKVWXpYLVVlxHyc0AxOx2FDLB50i504apSads00CXnKB4bXtQ0fa7IdwvMLIGQql/UPPmfs6jYSn7VndaVHwCGlkSGeiXE/S2emYwJfJunBhs1WBSq13ai1Exrr+uO0faqauTReOkAJiX1MV1OAWbBUJsZIhscFrysqjFBnCmUhC8H4RA9XQKdeGiRldSwjtwY0eayfPPheHXIag7kvLO+3iOsV7ay7fHxJQQ+h0uqOAjPE+KRDPsDHiYBhPtp4Yx/GbVRQjFxaLw8m5o86MLZAIzpiDa28O7bzLvcipMOVOSNZPz642cl0SKtDaisy8Pv75gvWQzMpnYxbyh00ba4oQsdsBdnJYKah86CGITIBZmEkET2xyAK5YeA7BSa63xmYkgsdey4ylYtp8jlDZknj27Z8BQTjjq+JJnnvHmZK5JDGYuJ6VoKyBbRc1J1ue+P+8dF7izVFgici24tcUzdwq3iJtDtj+oY7AEa93l5Og7lkAUd1xypBsL52SIsttAnJfVbcNAWG0ruswcE82hRVykhZNu4/4xD82szpCMHgZ/wbRGMTIbN8QJIsfh/IGEWf649X5IZKpmmfsljVfs0L0hYkLla4+QdRtktYrKjuZ5UzSNM+ZbGqtplOrpbLNb2rkOmLkpuUBiOwi43n79NxscNpApdxF5kpNOTKeG2jLVqxcaCFMiykQS1NkoggnR5K07XrwRC4wQvNkwm5EumrDwxV6ZIDSkaHptEwlqA0QT9xSp2aozEtJ0hvbzeBOziETggegUjj4hS4fCG/QIHbXAOr3ugdDCS0mbEgFkszUADNkEUqbokyH9gYeItR24OiPx4Cpi0h7pWRNkBcJMkEu9iLQpbAEH1BqwOCL/aCR0S6Bs/Xq8e2a/6n70h+Wa0Wu/k5d+qGT22q4c0aVDVbXm5Xreg5laLrjMmHrhGhmFyMdjutxwFmOXihLeruqVkO0ek3dTWlbV+DI/Lwwqt2EmVgkbQXUrsYHEpf2HTpygBG5DEGL+jYaYHMo9LJXLp3IWuoh2dKYOvkJQjTPXI2GtEfQRWkOSIvUsYlIYyCL/KiY70Swie6Iy9CwjEhbIxH8qJifRPCJjqlEYTIEX6JSznKb9NfTYeXVevl8u1gxXftJXk1o/gJmRz864q/fkB0IeZrCEq+IHkdgf4VTdcS6FzB4HM413Ebvrn6Ljm7H3TPXFp84PnY89izPtuL0ZbMFoGB+FSTp1FkhK2QD8CkDp6hhQl2Uj4Ii/svdoKtkBNAn8nisWPW+hWOULYcJzlffSs+V5ylcDtVnecKH6iOke1nqQnVBceoIYrtFuqaXj/hqyGUQXoKmEe6ooRAsV9OwlEQaze39FPMXK3EMnbrYAlS128AeedWP2Gz3HVd26QXkgWxKV2aqZw71Fz5otiarYJibL4IVX4lN3NNrYIWi/rxxQMMZgCvsD2ahu5mquVj+/l2VU0+3fWTv3z8p8Bl0l6MyAwDqrhRVk+4o83c4G0/V6B24rTGSOVwkhrj5xkaonmqUfg1ydkG9EVNEw6ILphzBLOSq/liTY6F0zT4HKOr/7EODyJomZ4dBRgjTnH5jaJF3xOQA1pO80HCrjrsJ4UlS+91SnhxUrSYMbN4h6l7+YoLssziopluuw7LAzRBdAXrkOQmaUbhBazB7/LVAck7ZlS+26fMxuWYtLswy+1PYp5Z0ZfJgDwt+u53+NaEQYaeXSYeAp9gEhumCbSaNTaRyNntm6iAfm07Nc8ioqfr/d1hZRbocNjE+Hc4rATb8z8LZekq4Etj7wgVGKpHlFxKARrfVapsRJ85Gi7oTKn0mSOmErl0r2zGRf0sWRZzhyswmXteCxHTBfM4xr7YzkJ2yhqPqXfWmMLIm6pbYjEjdErzkHrIhgnz4RWcpcJMvAxdGC7qeJjeCYEEEk8i64Gz90m/DZ+zoIISaQ8kJNxCgoJDLXSswLfmibPWlCdx8atMttDaHUFtW7TjlJtCKnAKurlqMHw79WAiW6yGxDZVn1oiG61eTWxr9aBSQxE4rsIwBJEM6Y05HmVl0Ko3nTZi6m/4gSy53mylosMgZCYh8GEUET9+Y32fefRmrR9yvCRXj2m0JLer8LC/voV0or0j66aRVFyPtWm/RenRewuGTQVPDtIoHZfD4XXw36rJ+WzWfgZG8ExS/5BvSZEt3psrXXGwt4gGRnoboZAwbxELjvE2giHDexEMHt8DYOFbtnnqrKkRaVw8LZcv9pAtAW4b5LPqbQ9w4xxQ1DRfKeUh0wZGJV6apSsKljZwqZHSLFlhmLSBTZ0CsGyFcwCZDenJWSJlFmDQXE2n+9TsfewsBi3sXDf8mItvhOZBl/lbkaMd5XuZhjsKUTjeqT/etpNP9UrbiyET4mOdz3txW95noRxjr2QJGIz14qHrPUQ6c8VYMuFCoLBvTtLmVpEk8OmVqUyLZj8Zv70d0iz2RgiScN6SxDDOemwMtBcQOGwugGchDRCYjQtpfc1yTFCnVCDj4FHDMQZ2FpBxoZMqmi14EiMzNaPC4MQCEsC1+K2vFNeU3NgdVzpAKws3gNrp7rKUN+1kM1RlH+Dik/psCMnZYxtDfGmYRvbA3iGh8TwYb5CA2JIb31Y7ieMNlQWYZCZj6i8wn+H1etR+hLQuBqTlD1mQVCBu36oXscPspBDLwZjspqMymmwHrLnsCYmdzI/1ctI1HwlMOpnPXgCfteEViawEjKH004wn4iJogWEvgViJygLtAAgwSu9t07+/x/Cuaxaz2lYruax//Qj7NZLN2PdsCr4avV+ifjnbnolq2VFDVpvwSRqvpdnKhR1vFF7mMLL5gg3Xj4ExRjcztBvgQlqqZVP6m2SWO9ilcEXhzrKtqEvZFBLL1WxmogV1m7MCtMDvcDbzTDG/lEOFgl5kJQ6FsCTSs4xiQVxKDqIOCowU0MBVYVKHrdJCTWG96W6Qq7tyf8jRBSv82twsWPsumZolU2nh04GKbFMOfbqBnogxM6nPTDEZkuWjO7XzyeKXzY4m15elCVy6MDJT7MKzlJebBlVdXwvCnV0kQS6FeGSUacktWtAwQXJPis0mO4iwT+upv1qt+u5uvYIhIoGRJND1WiSFdrEWqFO4popuE/YLqkylp6+mEmrAdimVYBPRfevdkvM/wW8urifND7xg/QjIxeUYynAWJ0ZsmiaA3jWUtOtPkh+TTkgEpEVlBEpjogsLtqO8uOYmBOgXWg9TWlPDYQwuPP0v9tr+XXZhfw11CY+bRHl/QDmhQ1Kk1YzpBux9wMgOwMX7j3X9Pn4fcfrbxb/zPrfV5XxFXL6WJnBcjE8yNSzDB7zsCaNZn/CZfNSJ1h5LjNN+38zoh65o1UFyu176Y/KLYmkS7w9asAyWUXOD5mqxiN470tQHAvi+AUIyrGG9rVaTR7yKz2IZX576y6Lp2L2VnOWY3peDCbHhMEzh2SIF9SxDwTeiJH3Z+pntT4B3SFe5fqJchEtdKbtfRB0BC5KodnFvMlcN7UuCX+Gi6r/vL8yYR/gSiZzv11B3/bg6Kdjx49ozFTV4Pn2uu1VDnWkm0vhGCSb52qIDA3BuPWiTjhonsAShCPL9ZRpTvF2KgsbZ6ZqB+LrsS5TH1aE1IcfT0bVRFkdHW0q0SNsPD5vV11/bYS13u9jLv0skpnZavtU0gGu5UrFMO5EAkWU3soisvqse+FV0lS8W96SEFyD1r6p2wEVM7EKsCqSuyhbTMAujIJFxlRS0ttAlTKc39VP7XIM+QUzu4xR0FZhXkEtmcwsAk8kvFLGJjgEgLPAMKCfqGpBvq/uGIirOOQBImncYwUO7B5jJ5h9gqwscxI/1rF6B3kFI6+IatPyL4umkApoNXCdUrbuAhzFtFUax62IS0qhBGpNFY4ShOWOGfDoTdjZeJ7M1G6wbE2O6NqN1piHN19dwLSY7rHWADphP6rZGPnZYJpSGXd4YHsE1wxzE0PUtG9X+cd7bOj9Po6HFsm586LrkiC7BziGvztq7Sm1V0K2/wmrKvGpp6q0u2vlmSWf+EErd9jlXM/IZRE3AKfQFUALGwyjls7kEDMzkGEoJJ1u50k90Fso7c8LxLxCnOp4tJWNjgBAsNTBoDBMTrYNzGUN4cAsMXMdfl+38zRR0G1JiF5ehKiga/YpltJmVDqiYVAkL3/iA+jL3juW1RRo8WmMmY0cZg1MDdGL2diAhOX56YB5kUqLkLMmANimpZFy309f5vJ4VMR1lR+Ewk23B+5zQ73h7HK/27duyXTyg0fd586iTbgfvonJFj/n8Vn98bNtP337z7Z8vkmYVvumTJxMtN7nSbBDdiQ05UA03T4U7Ku4IEZPnmRjETeBy4/N6Pr1rLYoPEmNVN1OL2k1qeJsdRFi1i2ZiqvWdgDfIcrWdJeBfYSdwApBudc7dYseh7ES8YXpLs6HsBbxBOuPX6U7zcarJpF6YKuQg4V4j9aRunuufuvbJVDGRmLvx9t+fPhwqOTN65j4Spc9udfnUmD5WIOOBE8fWJQnvqHNDdDKvCDsuazTIjiqBLTRYgrBfvGfg2XhrLiBAokoEwQBAA9nn+uPV1IS0l3BhiYaXzbxZpeM3hCiWK7SfiGTVbqe3JoxAyINh0j4thj3TkhrJZT1aFXnWUKyRdIyatqh/sXk3CY68HUSC468G8YdbPlYT2xfcS7wc3n+tq2kenK4y7sVeBPS+rlZr6uyJhBkInQoyjfcPLtIwoWaipeMAhe+27IOnki9Snc/93H/a9yu3649llcpk8CLw/xhq6q4t8eGZ6IsA19ubMN6SV0ZIuImgk+ESg9hhhEzt1sU/ew5awywtg9U9adEgNVJaNjhV9DfL5RrUf0hqGPQp2sWBZ6S8YMCp6P775098ZA6FkAj4kWzORlaSS4s4ouSjKPDjOHkLUDeSMa388aNMpX7yCNbHHfJhdFrP9zDfPHdjv0n2v/nR04UdM7Q4sC0jNxtYdyv+8wUKDwkNBptqNhhOoBkzG1GX2jTCmi05ogaWVjLbrMQlRpt9a+po5tBDC/1vlsj3cGaase10Zshu7pEZgNLXGgCW7bnPt9XCgBPKgI1N4jEdFs1g0NOigG7guGhuG+XnReHakA+MMjVSdmKUYaJeXRqS7pYM9ZeX0sT4hqUQwCDnroYv8CXhx5LAQ1A0jOExKAmH85bCom+WyN9bQvejwPZXfLuDwDSulZbd+MDjGKMn7Cy6xxh734LCxBrqm2a5GqY4Mt0+lb+pRjnbe/YD/oiuPUYY07drNMvtXa0WnKOIuWfXaB4RHxXTHEXcaT5WS/ImLYHmKOJBU+LUEutFZsg4A+LGqM/jqV13XBRBueeirIRzXcPNx5r5btP4u60gX7vT2oGPcFmh+jEOSyaB3FWIMsJZKSTYrChiGTMpymjMDTNEsTRLWfNk1i7ry83FatOtDLlaz9gpKexcN6DjjLjGDQaRb6W7sfx7lTuxjCiIWt2/NnQQCPu8Y9QqlUz0Yt+HW+Ld8iiYvk971EGmkyeClCsWW2X/o6/z3Wc4blozMLMGIzSpg/ZtKlet9N2opOp9Uj/9D8Qh2Vz1A30ctljrEtK6dNZaTckF+ETrNpWf1unmJgRA8SGht27UwOLUfhSTWV1BLXuXzvGLLyEndbZP56e5T9k19JZ6ovuY0lf711txkBDp36f1I/hUf0WU75I5Wnw/j2j6ju5vmP4kuR/HczVbQ5//kNBZN/j1w7R+BPdtd1lNyPi8RP8x5Tjt33/7+i/BtKH5H8Tj7pL5lfv/9EKboIH/F9D++z7x72MZoinT/1m1t71HmT/cVQ8QRpB+NEl6TOs4NlYOamUJLUe1tsL6Ya0snctxLTpX9cBWDl189IIh4A5flIKwB7gY/bYjXDCGdIiL+xbWY1wwjHSQi4ExH+WywAiHuXgc63EuGEg60MXgmI904e3I/KWsx7pgFPFgFwNjP9qF2410KJQzm/xYqCcOe6xLwLEd7IJxZvLRLgZoVnC4S0SilmCAA15kQt+lmTGHvOhyFK6QOx300pgsh5gEMPAYk6mGuCM7AsboQzsmQO7YjgA4+uCOCZA9uiMQjj+8Y0dkT3NonOMPc5hgpSM8AqrLIR5TQ9aP8Qi45Qd5rIzyUR4Z0ekwjwkZPc4jkLsf6DEVQD/SI6A7HuoxQUsHWqW+gDrS6smlHTcS2EoPHJn4gEO44piHP4Y7ljJ6jburq6dm/vDLarXYBYmykZ9sYpfITzl3NfKTLwm7FrLoO4VemL3gSyHKMhgBFt0EHKSXoua5hC4jcjFz8A5gphy2EbkMYhyRW5mWm/TUxo+MFcohwREAF3bvrwSlhJBYGaQ7f0XbKbjxt6R2mPt+9Roy3varshGRG/wKdpICDqWIOLYRcP3/7B+L4Z/ZBKT8/Ymoye5c2OKO8DQy4hi3Y6UFfZAMPMohmYm5u9xxXNu17jbWeBQZrsYVkNbMupw3J+LxZVLjAYVRtGDfoPiBcR1FWQ3rvQZSy+VdCNLWOLev+givSDoy06JouozfEFFHU1ii6gzauVfHGQRb5BPKQUXY0QiWKDtUOxVpR2u3RNuh2qmIO1q7JeoO1c5E3tEAxug7G4PFEEui8FAaOhKP8QymaDzYIsiIPMYmTFF5KAEXmUczWKPzLBR0hB7PYYvSQ0nISD0awhStB7cQKWKPaSIlUXsoDxO5R5MYo/dMDAbrsEfxoSRcJB/NYY3mkyiAiD6mI7NE9aH1IET20RQF0X0CiyHCj8EpivKTiNgBbb2qptWq+m3ITetsorQnGObm+dtXKpICjVifoHDGrEpgZNwBWxXNdsy2gGzY2b/u6vvmix0ukvXjM8/fKTbLoi1GAs7NSXsfNyO31JQ+D+drq3z2zdsa56J2R96gBdY4rb+LIvK3u6ikQCNcFIUzxkVhZOByKQU3apEUo0PdFIU3zk1hfA/Cq6MK3oPxlsOSb8s/L6R/3FD2RHyTrp72wr2e5eU2xKCoydK5nMoi6+6pWS6bdn5TV9OSmiVyOBFrtV49tl3Z949k/fjMnTzFZunkMZJDaUdU1OnqCRyCkI1j3BDE8h31IQj/LcuHIALhf/zb6++Ow4L9BkEaHjIE4S7/lPwqDjb+fMz0h36czmX8XPUe9OOsz5xIBY9mfv89CizWMz07SNCtg0Imy/bj5U/n79/c/f7ru7urn64uzu+u3v36+0+X53fvby5vCSAxPVqh+0xu3/9we3Fzdb3J5PaX84s3gsY8sXxvw3ff/fl7vYKV3LV6FkrCuOv/px98ruovq2KWV78fc7BCvdoVh2MbVUmvSqtKoVpV3RBbu/74934ovHx3Xw5I5OTMurkKZlpOeJB35uonEv2IZPW1nCzIwYEtmDkOrmoX2EOesUl+d5khUnlqW7XkXCyFtxwbISHU0yIF2skzIaR29ShIgXb6wAepXj/nUaqfDujnIfQg/gIS9qgGyQGd0MAoLOcwSBbh+EUBgXSki1SPnOTCSy+c8OAKDx7sKOCBjm+QWOZTGwV0ytkMkstwJKOAiD14QXtT7QkxUKt4rILUzJ6mKNCuHZpgejPsyTLBdyWd9K306F6awK2bzjKFVm8zXtuSLa3YuE6LMjxaqtR4UyzKwN1ISTPYrqMUGJCFIqkaSr4/uOjC2J55pcVWenJ5RaoB05qKxBKcf7roXccwDQkfDd9JnHcPRwcYnApSRPCzUPlau1ELs+QeVoNWPnyh3crGrLc7wNXJupSV7Cjvi3VXPaRdhhktymM0XtCrCVJZIxTSuvR1Wv5QtycVyLy5pRJZN7cK6ITNLRXPvLlVwJc2OxiOam++ZETLw+mYJjeWEOx79bagXghfwMOMP1QYZShSTEKOBUAa07AAtK7Acf6t/vphCIncTRxumdEjnczFXQpZQ56SKYFtmiBBGCcLNh5uuC4B2Qbt1vqZfDLXz07EhUY9ESKhpOdCRmk+n+UTdEX5VsRDP3UeRFKengop17xeTCviLIik/CDioZ85iyLpJ06kjNXPrdDoGOJy2cj20CxLuEKpk7TRN70H6IWsreUo5uPHgm4NPiJ+0lPh4w+CO539dj3ubT/hTXdx2pFuSydnZeJW6pDTr2hX53JW2+14ttOJbNdD2H7nrr2PWjuernY/UI2wBWuA4Vwg7T2CBRwiGb7WR993zGWZXnccFo6iRbbiEbViUItFMXetMq85u1W5UDV7iTKrOr9DuVw1d2WypDy7MblQPXtBMqs8vx+5UDV3HTKrObsNuVAxf/kxq5q4+7i01PJl6nzhgbvULWbH3rjMW11+4fII5fR6t6hcWN42KJ8Jtymz6mfUZco4gNJxpMtDMhGySpSsYKOFhWf9QiHACFMbyC5C7o9/KSB6NRSEr5pwPcIGJS1LvHQF9Sz7Ovq+sI6G4nAec4qORODVkxetoB7klRKoLGQxFIOpmGRVx4CkLO68aPVsWfb28+8ldbQrDlNNyeKTAU1Zg3rRatqy7Kvp25Jq2hWH7hnCQLXbuntuJiQmkQzvC7LoeiDjMzWgniI3zWlY1cKcxqB0EsRvWbTHcqMxdhGrJoSjTIl6ZeDBVQiT1DTkoGJoQRVoOC1XIpemz9EUDUU2mSWl4hoIEfyLkiJxwC9UaQFK0cBkk1NYHnbVIIl3RQHV0NcXqqg9R1H3u8nmUBJujk8F56J4UJzuC1VVyFLUDW+yikrEdRhMRDFKigYXv1DFJTgFY+FNXmmp6E2iUHrr7z4SWwJkKpftIT5naG+IxmftZP5cd1SAk0xxEEL2GExEy2A8kIfiC1SpoAcZsvUhICmBQybt/CaH9KXMOxwFNUJub6i1YtrbUKmYYaL2tgOXFh8o6u8piDrQ5xTYQskTBjuP9uAEAsL4Uu5FByKNux+F3nFALbD4iQCeaFQ7LXs2gYUx7taaSVR/MfZ1AoWI8RW77VLIV4RpcV8BbRBmWRt2CaMijPMMOYbFMyAg1W6b2k4SSPqgPO0uQLOjBJLlKIy/5GKTTnVAwXwwAW2DxeEbxvBwJx7AX46JbvEJE/cMD1eIGH+5W7j7yJ8Z41PjPlNZ+VRUQAugQqHgWZMFiZw9jQSSrmCzsGmXsI3DZG9dMyCK966NwyMuWjOAMVetjUNKgyQNPFSk5DiYp+rLj+sOmuhQQLH4GCimwzwKiO7ymMy920yyNq/XBCWwRfJKEMY4XhsP5Z+hmmEcM7ZWA3BBC1vE9ype2QKYkIsyRbzyOzJtpOr1mBJl4c2YNkLhUkyJzXwfpo2Ki2mXkGwR7TYeymMjTJyrHsFlHWKnSIa1VF0/f1EoZDwnqRNsGpS5hFEzIfRLqVMQ+msVz0Joy2a6/ffzJdbxhwndu/4sc3PnH5WjvPvPQUYMABAmxOnlUOVuj2GyOpgcyeBiEAasQRN2M6pJ47WjNmquhoqbNWdN0TMDFX8Hlfv9U/jdU/JNxmPuIfK4g2jE7UvQzUs+upmrpWn9xrukSYbQsIaZBnQPDJfQxeDEzKEegy0HchwKw+CvKM38spWGeSRX5jG9iwsQgQ1T+VbqDSVWEqaByhhKn1XGQDZUhMPUaBG2YO15uNvspl33k3PlqjIyIb7inL72BOVMPvUUFpamB48hYwjUMeRihGo2az/X07d1P+WZGqv5LBP2A7quVo+/9n8pRArFC6GSSzOjtFmjyVK49CJ0rsX3W8dFkJvFm3r+wFw2TRClQs5M3HF9hkY8pz+Gg2ksCo7QSryo7ESnpIka4E39cJk/ByVXVSY8npEeC8RBIFqzS6WcqZhxgWjkuHuzj4u0aoAHAMYaYK9OZWvBfHcqa8nRnZKbPYJm/vBuUW/XSIcXbPir+KTkLt0BoAK8XFIsmXmnBeQy7biUMbaHtOVf6YzIxJUYvjsRqFXg+sQSKsYVIUiKXxrDw9yjiDIZr1JE7S9wGYek8mCRTubiIoSsIdfAlMBsvCKHarQqhWHEKpHgw9Z/kWzFhssNZiVQZETriKiMcyVSw2DXF7gQ9uVBgdExUMGGIfI4fMvAGWr1+ujZEZjpyPS2BncUJTxkR6YzmTow3S6DjuumnjZdX/e7Vxq5jotO5tJxCVlDHRdTAtv2qgQhba5mY0EbTbdLnTsvCSiU8mdKV0cRImpt1Itn++IfH04lceWyp/iGy0VvpvXubXXbh0xE/emGW+DWy4t2mrsdiSwSc6ECh4+iN1CHjzYKpouQEJQ5jk3/ff+nvYSJIhH0/z5CZ6XXjqmz0rmCDSJoc2jExhDnatTcRUcTFRfdDBH2qAz7U2LNO+xVGfapXFD0PSv7fpUnmLh3VbJvVQwXDvHEJQn/lYjCBQhoFqUOBnLdhWOAcasgRYsfDmsep1vqGLXCcYqFDY/1jBMuY4xdvTjRooXjWsXplyg8ViZOuCAxZh1i/PLD2FUHn8UGliIYtp2v2qdm8mO1qs4nfUe4pEdWeSrDGdLMEesZF2xnEgU5AqHXIKk42t1HRAbHojAVNFzsxhx/53iOIv8ElbOD0e9pIzLYF4SvmrfC7QAC0VvqaoD/zSraA+kXtdHVdCgQX1UXj81s2mdiJAvE/jmqag+k35VIV9WhQExVfR5K9GM7WT8NuRjYUsF/guqKkPYV9pq/1o7IJy6VVGcX7XxVNXN6vikShpL/LLV2YDpU2zfmajuWS6q3Eh+WCv6z1Frqx16bWmdcKqbOttcc39RJuDpAmEn+E9RazKRfPEnkkxSLXkrYyv3UzGpyNLcfWtLJXBYXhKyhVQamBNxyQ/20GNIOExoTSiKIrDioZNHAnu5fEDS+gymvJ2ZXTcIAjiyKky8bYLez67fVYmEEzURPBQwuLYktoHBKg1Kl0wiEqWweYSDKej6QqrDjM5Blg2WQrHC0bPId+TgLdh6lAy0TX9FXHTOgQemYkQOCN2roYLC74bBkvqKoGN1e6EXcW/ShBqHyz7yTfhHs5z6D+6+XX5rlsGF5+WVVz5fUzRsSPJ/Hy9X8j8W1/uML1HiwdKgtGp5guRDtVcMyjRzWj1gMdFsGxDrukxYaXuRzXN7DRwanLjq+eOe8bIcPQU5dBfiinPtyXOk8yb0arIttp1hmM437Tl8blkW0UyyfWcaZp68Nw+LYKZbFTKPak9aGddHLvtylLnSdZImrfHFr5HJN8UJNCYOyIjN6LQZkAhddLMstJZq5hRV8SaVQKzvNti2bFGpnF0hsSyMl2uUF1DFLp07LMOYFmGIGow1gnZ/Tcop5IaXQEuklkxGLJYUcQ1J7m0ykkO0Gi2faRGi33Vc7GCXqSaevI3msIBXW23DfgL3KEinnb3lTfbYjxULORBuPbmdKxTypqun0ul02X4xUhJgnFbr46LfsWN6vFrRGaGURHWnGg/h+ErH/JtpwnknqNbCXskeH+FxpmIH2/UaC7NtEmqMcaMQ6l20AJtLBQ7ESKnFQpmNBwzMjVz/hmX39qfBTJsJu3zN57amsVZ0FgoVbCvbqFGd6ciM1b7Hb6YTZoMhm3WovIpM6RY3OvDVb2ICLGcs2kIvqUZr7avVoDhCwE+rzMhGycKsbcztB7341f1s/9fMLsV+nErn06GzGUF9OsjPetdk8C3Lf1N3tqut99cNXAwwpjPQCFsLhuvfcTniofXoHDnENGSTRNlpJ8W0ZmArp5bqmzntrDOTVUdwKtC+Kue8TzFld6VQ+EdS/8fq1FU+jdrZ/EAnUNS8jBdsDiBTqCqiFQh6E8xzY8NtMwg+8FRR9yG1mKbARbGXUQqL0wjwKuEJqYWmWQ6rL3i2Z+p5IysHZp63ol75bq7rJowUqETsB1fVGzlpZmeAJyAqYHGnCsdt1n9vqsWvXD4/i8I1J5zKCk/KGBnFcIayzZBEEmiLbqAzdgIiG9QQlPHxnoAPp/YGRiB80yRakjpuMHNzQSaTQRk92BrZz1DjU3rHEUsposN7aXjfssE6rG3VkZ2RRBg8iDjh+ALxf+PRTL/ePmejr8yQubp7JFvLwBLUtroZTboyswTnq+XTRNoQn50gCAaSPx0mAZQuOqXjRAqe7r1eTR8MHO6b35Xio58OVnQa7DSVGs6DPmHFtSO3jcO1c98bXg9yzmTSz3YigXe0/TARs1yEQqL0GTqAMuzgIcMRl5GCHoyKGOhI1UphtAhtV4BRKJ85hgP23yTpv6lnvVqbxBXeAhSZyo/0VtNwL8rxK/v+Pr7WFYCJjJU/O7W/+8eZ+tcvVCz5fTI7fEd/m7F6KQ76nKwfn/n+lLssFuoBf8dty8WbXLPfZXx3GQ/gQihb2JVxuUl7sB9IwXC53Cq7b3g9OVj931SK/wEEmiyVPwXY1X9adtcIOQqcjMvd5jPApCH/c9GtGsoPQKYjeL/ri1lsV57P83nQZLZc+HWNJK4glndn6aedtqfcgZU/Ft62FAriD4PgJY7CO8qGaNX2+zfxBXEuhk7mspwhZQ2sqTAmYQcbzNrWRI5RCql9lMsxRJC5snlJAw8/cVBx99mb7Yuw2h0QyPhDQVmn8Uodo3uYAQBsVtwQiMVkD/8xE7JBAoTKH0hWYfRFbWaCfud7YBR2l3swBfjYyZVFBgisM7NP54ofAm0nvkqbN8IzR8t1i888BM34PmkiJ3wTyVA0rusvLu+rBmP1ZLEo7TaYg3HpAu3pbzpNJeyA9tdNh1ji9beb0cXCxhhJhD6D1fBRSLl4KFT8SHibOmlPyu8sAjMoTGnmlsNwWUm9D3JMRpO5YANvRAlmoRiqyFDRNY5sU1Ze1RFsTlMtfYuPWFicSFLYzrr/afVC2p5esQF2LF+ohbeSXWqsIEvg18zRTvJ2HvEJEGGvZmeZj6nFa1SadaYbbNKB92f+zH8EMJ7kZo84YKDk7STDQITqNoCMDuwzLgKbEUxY7SUEv6CJLvaNUYsgvlbtFQTXqFOEeUbq0qNQbksrRS3oUpdrWWiCe4tLth/LHAQ7qjdPb0jgrNrtD2gOgtcmp06oxlNsTlrmLIi/sXOhApX7HUygdsnJnltiOQCLCuwHnqsgU6xflhXnk3OxQp77rs53e1P8/c2/b5UaOmw3/l/ir41WR9Xp/c/yy46w99rZ7dpOzJ8dH0yrbitVSR1J7xnn+/FNFlrqLKAAEStROvsy4RZC4ii8AeREk7/btoSvIPSfcjc7v7R574zSWIdVUKK5EOjXiv48KZuufi+ozoks8AbigAPESaRbW3f3xTLBhCcnRwkno+7MBTwo5u/WFbLGwZ0bD5OYiI54Yk8FSvjp2Hkb0ITINTtXbZJqxMzJ/L772OyEr2txBgSTmDS1UZM4meHXRybhiZWyyFMPNSWA6yMkKeMwg2cVjkAiHMwEkOnylmonhiquNPDgt1dm/GP0Be8QE1zoST1nnQ9Qy/pwKjgRkSYnm3u3N9wX/vV1/+Ypc/4ZDwvKlxNVX/r+1h+mmMt1Wg3hKFPv2dve9/bel6wfSqplkSonouPzWTVvbOyGWkXhKFG4J/6N3K7peg+VLietwf3e36wQeJaXI8Jype/SD0Id9+7ntCkCoZLqD47lTYmQmKJxlVk1IOCwhK3g4LrfHBzlmA5SSlfMdN9xN4GzxT26iUSPkpxBgVswV7TyWVSygRgvldr396/1ysz7+0IMJ8qaB026Xv276d6lX6+XVcvul1XeHJ2gZiRpufTgfH17IfIDjST0Un45yKJFmWo+WKpvXTyArJ/a4am5mP7WeUgyfqVfyCBQj+aQ4epPUZbnGjoTQbTHKkhTNDhjuCJJH8XNRSJc6RI3E1zpS3dRiB1ccW+3otOLOnNOs8+ZcLwhNj/eS17vr9vauP5LCWiFSOJVB4hVIbRP9TfPPAsfBzT4VPAfxcRB8tf3S5ZyBdlLApZBGzF68xfUWUIJRboZiCCUWSY2INk4ROHE7pcZyCvo8bdCgTiMCCyvjUq35cFXRQ+aZiJFSLoj57e5mufkZO3gpAjvOfqmxzGwzCeyjbIuJjaKfA5rbb4qjlu41pYCt2XgS9Qlq0yk1Vn5SI7JY2vmNqBuAqc7gSK7aLscNMcMBMskmNli54vkMBB53te+WCBnJwAjzSe0HjUvblVFcwm1TBRLe0eOVI/LvQv2MW0eVC7y5SjM5RBntk5E5vxcMIrfcfJDqCdO85/fScjR2Nu1y+0jhPvbSz/fbG7f2/RMUYW1DGYRtPZLrSLlBuqJQn6Fd8ahxQYWafgcHYcYDDaGMonBvtvvnPq6X++5vvHgoJVXwEKq3Wi/5WiIk5ygKejauoReRFr0+vOlJyu1yM+rLSPmonFTJ3eMnX++65et6+wVRgUjxZD70v78fT4dL3+6WK8oDQ6l0PhgtWe6FJ/A5P/w7tv/GgjjlEds1Bk9geTddqgbLID+zJkaN/vJH94/1zb8fuoErYJh48STdQKBC1B8iXzaPtZGAm8XbiNEKJ0uiWow/TT4LFTGFkkCKzKZm1tKpt1DTblWX083B5yHud63R6ZcE6Sjz5RAyk1V5O6tWlPLxPDJvr/b7XbcE7TPRRg0TSmLKyIJFBgzFrhtyNIDIQNPobh9lFQDCXJKOGsEkpcFoSCnoLw1IjvaiUSahuzTtG+EGaKQz6S0NNtoBMmNPfQeHfiSihjE2GlXmMNbRpkbwr/dLJi4ZE0ppBKcFa4xgiH2WEUQAyIwgpVtpcBD9CQ2OCKTA4CAoUxocUTvKDA6C9DyDI8IWNThYP59rcBS9njM4ZM+fY3BITKMYxNPsjAk9BCKaM8rr7SlzEDMUKfwJkhEf9hA9SSGs2pPoQYUEy3kWlHbynG8MQos+4TurFqaMV/z78YgBofqpZ4vzFpRgSg93BldBfsc8loIHNIuf0CIkh6kMIztY06Gkx7C0bbmRnA7ndIDL8OHDPGX90ZFD0VGhjBoSYFPMBufxT9r6ic8KLxiJoQUrmB1eMgJD276yWWLayAstxuhsUcXMpkQWnzWmY+4kHXHk1F/v9rcxyg6RSeLKqXJFXhwDrjNOpPqIXeI1S00SqT2FNVJA5AwRiTGJDVK0YMT8kDhnWh4FMuZ5erJ369+l1/Z11NRE+rvKykQ62MjAvFvuv612v22vdz91umgjQ8glMTRc2SJjQ33EvBUDC2fWgiGOT2IQWVwRo6isIcYwsihSGEclVM5AsliTGElly0YMJYt3prFUIqQNJj9K1UZz1phADadgXKiMp6AD4m/v0tYTE0piOsmCSbvJfTn6LTojRQOKWCiNbtEbsmf3UH1toN0zViOqvhnBNO6YPTl9vbtafaa75VQkSackihW5cgQ1a/ixOMkYDiynxI2z2CSDgwIUGRryOmH8NqU7hcvWNpoOYRJHLW+7iI+mUM50z3JctNEjx5va5Gl7OGrw+F6uMnd8xxoZu04ktqk/FUli7IhiRcYOQR25zoMIRKZATLJJzByLSmLmKDQRMyevDcbMUbpTmDk5QM7MUQiTmDl520XMHIVyppmT46LNHDnS1GZO28NRM8f3cpWZ4/GMggmI+xef77+ggQWMuDzIYD19LlOh4skafzAz+HzmqwhQ+yDLLGCTIpKBu0PmpBpkd8TMdAassYsU3kF8yauHZ904zI6cVFfPzrhxNiEuypEmvG823TWzqW+X1V0qq7pP++J3ac+/R5urkQvc/Jzs1ue0Nz7Pve05de0RAzD5rc+Jb3y+yG3PM2567i+ILvNX25vdar398rHr68svU7SoVJJhSJcsvsd+Cp9ojuPu5/a3v7TTO5cYEKM89MT+DETv9+sv6+1yo4YVZkyDLXwYAn8YkQFFv4coWwKpqm58hluAzYvLhpEKx9clflk/gcOLXwDHQVcfh0vVxwp/nZyBsiKfJj8fTZdlv0acKgPnMUsaPOg9eH2UJWVsMaFkR9PRgnX33Y2xE7bj165O0EBUGsIoi8yYRfCIugENB+sFc7WTfodWr3Y7Ojyc1+FAzXE6mn5D+Bwa0rkuR1NtmMehkWkcjgYF5m9oFBp3o0GBeRumlS5UF4SvoYEoXU0My/gZtt/v1ntkBj1+yyoUYU06WdmR8iZVPf4ciJEYhF8U6jS9nFYvfg2MgCB4Awzk7HETnz8eYDHdmuF1oc/vIJw+vxR/fo+b2q8Kx1RMvXJEXagSPIroo4Ag64CdOq0C5gwxDNp544WqYoAheCcQ5D7hx2euPy0PX2MsASKTZN5KlSuatmLAiRYnLpEn1SsfiOKRyGaMJBb1hFGFhpsvMpDmTBcV7UXMFklA504WFVWGzRVJXBonqsCAzRRJDBpPpsCAzRPp9rlMPRCzRBKG0qUpkFDLUBKK1qfwWOyjuX3z88tX//HpzctPf3n1nw9wvi/36/7xkcOfxsmReWpTZcVjuX9bbu7dg4Mv28PNfn0X7PH2DunwJ0xkng6qYFVp/mh2aNp8eaMUVYk9hPe//ndnT0CBjwmq8l7s2+WxJUuFyaqy/eWK029/+F1V2pvtqv2db31MZJ6OF7vNpr3hVDxK6DW0q7/et3tYLeMkvszR0nDIxKwMQwl5gMeq/dytTqlbC5BSnwQ58AkTgKuflvJ642s1kH8EmTq/7UaAyybFE2b5J1bESHF8ig4KGINmq0IH5o+ogNhSDf1y5Yod0w6nORf/3NHyPKPX5zAnvTwnyBlMNZxWXvxbR0xMJh7eDBPTXwEp1T3I/hO/ttf48LkL6ec6nMz3vlmJ+/Kj+D/5qzulDx8uNl4ntNRaTt6vOYrzIt98GPXrWvq9B7pfd0mv1+1G3LdH8v/cr3ZaH9yUuI8/4FVTjPjUYbIc+ydMV0Z8IsOrTqYqMwlFDENsB/IiHw7YQ3Fv58nD/jj76/WmpYhDkJ6ENMTKFBGGECxprInXHlHFyrcehRg2u5tvCGGJIniQTaz/zTTIPIrjDR5ZPgdPlHVDQXBTI6EujF1DdXFTTqEujEVDdXGuUaiLYMtQdRHTLNRIsWKoyphVlPeUXrKPrtxMKW2qzwRZEvbb+7tVl1ELCMmVdiyhd2FzdXO+dQFO4/SKH+c4gEwy54GVK3YgELhux4lUr9xxUiAh9lJIJIK9lJlIpo+xS1oFeYR9Ph6RU0GRxByLUCflXFCdMQcj1Ek5Gbz503wn42xQtQKHI9TMOR1UtcTxyHvUSfKVFgaaN3mfPziH8udHXYqegWRNju9b++N6F5l5ouimGZNjezw2eb3D9stJbNOMSbCNdiK6Ut0mGbMVAUTkexEEMYmVx1pJiFG/rqVUxnceYE59lBiqmzPQF/pcUVTYJCdNOxP0HKqb8w0X+twRQ0dTFjAnw9DRDBWqPuKWLvTRsqA3mHU2R4ViiHnFC326OMgN5uZ5qnfL37sMb9vtF/p0BiKTZMlBlSu8RnEKXLfkINUrlxwKJMTMgkSinE4okNyOROV4QK7kqDpz/LW/6mr9uxxTkCcFouiyhIMys79Gl1+kTm5iodCJLYXobplGJ7EUItVGfI5CM7UUIlXHjL5C92/75d2H5Q/04VBSf5gpeS/vOlEn+vf18euLr+3NN1XvAxkvhE0LKZV1GrvK9na3//FueUf6SSCQxklihco8JMRLzfyWx6VQ7SAqYTwZ7XFjhypnLZ1QG2rOUW2sLRdqQ40qqo21qEJtlDnFWzJiS4U6SUOKKo1aUabH4rfYUsv7Ew5aNMngjBQfu08FNUjM1+lmlTFwysmlCFd0aMdAcYNcjwAb7jEE3MDXI8BMQLRhktYBYRZiICIGQo+DMhUxIDGjoUdCHjWKQVGfOJqDjTt4FAc45/yREGUYMu7O0o2a00eLD7+yxpWlQabFPJEccWyZJ/ZiOAcFzx4lWUUn9onQdwem9rS+O2Q+L9M38oV/7xYGd+2KOot96ji4WBIfyBQtmqYSX6DjcjgQSjpHh4fwvRwezu9OptE6NMf1rbJyTjmSYIl6fw4J5/l1mjGvz2nmPL5OM+bt2a6Q7JsJL88pj3h4nX7Ku3MAYp5dh2DfLR6+t95orqhNZg4OUcBFRsYvW+9tphRQZIiMM6ZHtj68mgFrnCs9puMOTjVEdm2U6xKYXmKkCQ/opZw8iaJh51ByOM/8//41i22pEUUFpUhnYPPhRadoEpjK+dsZaGMTvHloJ2eD1/vjPXaY9zFBd9bYZ0MP3gZp507yp4XFpvohNKIB13DuTep5tqbbJswUbQR3NuCq3Sypw7mntHMrbVpYrNJCaGSvd9JCXc8exAUqp5V3zmcOqoUHSQGGE26iEr5NhpAYxrMu779mc8BEzNE5dfPMn9+6AKqbr+sNHGY0rJP0P7+zOM0PB9l0FeFRJ+gqIYhn3wAzIwOSspsAQHLrEUM05SWIiwCAU1VcBqBkJdDj2HJSgjxwpuAkMAjzKAkZmu/cfgiDCeRTTFNluNa91AxcIN9lcNHTUxKSdmkhbr316mV//8M6mErIGhBkTY5uv9u5G/f/tlR19zBbelSDeVK14ThTCkSAjZncUiKAJLipRIUCuyREYh8FF4WocDB8nPbCCpVehoHUXh4xo971VZ5GO8NBaq8W0OoNj/jLlPPH/JWjjuNAZxy0V2mHV1kI1Meus1Dr1ypPoznC/c456a/Sf9whN4UJQIB8aeZipjRZPvWYc9xlOkzwKFanQGkZhyyXwdNfE3C901YTzHg5bFftzW6vG9qTnJdB96JfifkerIUHsl4Inz+mut5+8TWhxTjNfgGc/lS5i3vQ4AuzXbB9r+bMb7HMlxohfcYJ+SkdJCDzBTC6hVHXVGcsq2DuC6B0kwEv2Rtb/UQizHsBhIfd5nsb3hEpmeONc12mBzpBLF6K73ujbBezKi/b9q73T+pVGJ79YjjPwPhPwdc100x4o5yJ2Dbwllx/r8fj+ep3fWb80TdMMAnZyRYuflQO/Q4d5ckDUbKeWkz9c0pX7f/ct4fjL1dvlNgmmS+DsZ/a9/J32DVaPEKQ9TL47rfftrvftu/a1XrZj+tXvx/b7QHzmDxYrpzLIL9tj8v+eMrH+8/Y8UEe7iSzhBEUIAwM2e3y7pf95nr3mrpGLYJxmn32WEZxBU//zAQHy0jW1ijil7ub+9suyxmAQRGXwTusZDrhfiy83u9uO91KwFQZF6vhUz+73unBItnT9NXHNWG7n12Ho9wXa+9Tv5oFMsz8z+qTM0YRWcjFMD//tVtP3B/nGNBp7ouh9OvZ7zNRgtyXQXla1p4BlSjiMnjXh3eDk56BdJI53RxktBh4mOT0+VbEQgATSrIIIAsWLQBQ7FT0z/3huLvFn25nUAS5JBMsPaaHHHpgQdYE6PQTFhrhWZMVDc6I46IRznRaSmwSh8ViPMdZabB2w219R6+daIyTjEmwSZbuNCbBsp19Q0wDLrKGp0Eq1u/JwLKLeRqqeCGfDKh8VU+jnreiP+cTdIvnuPVEF86p8fGL6DhI+QI6WdXKVqcauxpzASl7Bb9MZSucXqImrlpyuRqtVNFSNWVPYNdXLFzx2iolXHb1wsIVL1qSwRWtuGjM6tVWMuCRpRcNWbHsOsvXRdZgr5f90me6O8jIXmxFNi5/9sLs9EG6+MM4HD4KUYhkdPnu6Yret+vt451io4sux+lsjYMDXqfVuKjMJ4E8/mkBUELt5PUTVin6+olW5c2jW5VpDTPMV/w4cIVVPJZXqR13F3YjdaRfvY8Kbr4k5gwSDXJmO8IbSe+ClSOJHeFFS5p8Dl1p+PRbClW2dfXPqLQASfwcIVVt4QfJOzR0RhHYEn8kfA4zVnzM/nNfk6aNEDRzevWpmOkTmqOJwuv17+1qtG4h6FpcLMn0gClaNDMgvkDhS4RIUJfC0VE6ZD0PQuzac8CCbJfA1UGZAWucKxGqGat1DuF5O8nnokWXEDq4KtpWh1dE1HNoo1T9WXXJkfOROpxDz+vGC0Esc7jOpZZ1ACPkMgc0Fb2sA8wSzBzcNBSz0lyKSWbWfKanmedZAJJolox+NdU8DyNPNkuAJqKb1fB51jaCfB5vO8txkcytwGOdz92qIbPsbQRyGv5WDZllQyOQ01ChOsgiFpfDnZbH1YGPMLkc7FRcbtypjBZpH+9/Xe1uu4EkCq1hpZMs2eIaRCs3/rOY2ctDxjnIYAGSIJdZSPftF+SghgDhKePFkPVV8GG5Rw5XCevvlDklQtFdfhp8Mc6EL+vxM4lKPNx8bW+TIHz2UNRZQCN3I+27SXsStENBibGqph0C2HODnKXdVbMmlcGdszSdhXY/uFx81ikyUGEBl61Zdoohq9pZobmz8IqYEwFodawjO9uYW/US0ko+FjXcVfrPiQQjCj5DEZWYBL6EVhLAPpddmj3FYEgmod9JwTXNm7txlJPEQiZhnmZBlxNQgu+4AA91llkl6SiFSVWzUmch5skpBexEHFUiV3DerEyx6XKRvsTzbrJGmUe/za1+ltKSVXwaZmvWB4jYIsFXpCWNZn1KhDsSfEQqCknsHUZMUjf4vrf743r7pdPdrTqnE4qJRBLGCC9VxBJNIetmSIRq5S0MYhR3qnp98igu4VLEKG68oBzHOENSJC7W5bafPxzxm0AJQEi+pLhW7efl/QYPBCEghVnORRPGqi63Py23q40YyziDftyAe0k1ir8m1fpx+Vmpecgh87ZsbxiZxTe3t/fH5a+bdmSZ0VFMCSYxkmzhIltJfofOZPJAlJZTi4kyoDwonR3VYnq4GOW470r6Mo2h58Eh2S+Bcn2S7+Q644mc/uVhYvkT4RQau8gIiNo8LRLC9PEwIhZwHgbUEEpwqOyhpEeNzOLPlrKDDylJDF9YmsjSPULTmTagSmnLolrb7ZduiR7T+iAlGV1RnV/abdvZlXi9jgXnahYOZNii0ZEb1UUMVaAoMjajWpwbiSk5CSWpw261tvnRzVNWa/xuU6B7Kp4EBWOE0BpWWR1ce/hylJPwfWT/Znt3Dx9hmqSzhkfwWg5eYOwVqSlManc4fBBVoPMZ8iAqqzqy34ucD5OgEBwT0yIJB5UExHSEafWPvNhYfNK7x4lJfNmkQNKdcUMmwKy2vggG1ACfi4CwyVP1iFlOoxu1WJR+ldEiMIw71tXqMzU/ekxK0qlAcaIZ0gidbooElSnnSHG91AoPKtat6VC9wgEzqd/ofCWujRgcUFVkxiLVgw4EXJdqGOD6x4ebV5/7u4HbQSr03ePTsohcssPOVNmiQ8/YB4g8mQgB78o0yg+9oE75Kcs85aGpG4tiPW2cnsroTcqc5Uwh+DnmAUGidqlCHLThmIJQOlYVAsqkUCi0doVCEtyccLdvD10O9yxC1MSQ0uluVWA1yO5YID9JbXQiaCKmRw1kH+SYg2hSwjnQxuYJyzDtu5hUGlNFljzPYKGfozdbDCq98dJgokwYDUhryPRocHMWQ6QzahFUkS5LrVFp0Ut1XtH6NfLlyNpJsviIgNEuRtS4yMVJBJhysSLBNXNIxVbe5+FQmZszOYi5tSQd6udyBLLeNT7I1WX9n80v7kEWykshMmkObRHlyo5qIcCVgcqUeuWIViAhNmNIJKptGR6HcMjQbRIlIBT6CdNBKo/YDIXm9WEsLEcwyZe4RdaHl+7J0zfbQ7tHTkXRuEC+5Lhe7G7vdoe1rrLGmRIjOkVcaltwku9CuOa1I5H7QhhntCmWNTE6fKuTRKTZ9FTbJtRhR+yTylNHvMbIRf95s/t1ufnr/Y6J9kFkkrhoqlyRi8aAM4dz5MoHaUnD8xhgTPt1J7bpWuam/eXQTt9EJQFhWWWTB0Ud7du7HRpAS8Ia5ZB1SgWazfp2PbVvJJSTeAock5MI35frTR9D5Kpf1WqTrMnxtYfj+raT+Lj+XwU0kCs5Kn8DnxP98/0Sef6XHvjTnEn61nh7fLfirR0USLNNjhUqsnMTvFEmV/dlT9CMEusnRba8uWkPB3GljMTPRKE0wDic+dZXiuzQLvc3Xz+sb0+PjsqAIdlSthrpEHA0am8gxYG7AhyEzg8oek7ECZA9Z6YHkCJjzT8Oapbtl+KJGn7CDM61+lwfGpl83t6nN/YKS8/Zj/OGqXSMqjXiA1I0GiW6lENPPe7mYIg4jqRe4/yBrxn1as3RIa4d36L+B97e/mW/udrddz356h4h+iYSSQY1Xqr4me0QMrNQ/RiEvUS0jzNInL8YiYukmUZnEzAepM/FIOFxCQwRFles9XP3k6oNxhmSfj/No1N9Ub3jpGwLlLdi20PFWrFoRmEyj8ccXb2/2h7xm/UxOXloDBl/RhYbiT9DYVPK7+96X/3ia3vzDY/NYVDAvPPgoMfoGbOLCSU+TD/H+KLYiVrvo+r9WJ6aPhpFmEtiAjSYhlPYuEmiQYFsCVDpDlErzbNGN22hafVaI63BIznMfr6p1rdO5LB5AoMd68dj2m3ffm67bDftR2+epmtDKJGGeENLlTFvE8hUDM2D4NRsEPrDLCLeRoqGvguDrgvVXRgckpDY8sniShnJz2iRINjsS/s76qQeUhKFko1LE0aOnaCRC3rsGl2gaXplrkrHAbWeQEckmB7TMWkCerYA0hM2x4w5AgSr2UdElSr2EIW6913adCChyk+i52kXR8FhdR4/TyTTS0YBIkqjoX8ijbf9bjk+u0C1BvIJa/y4O136JcMRyCfEwUYYkq2gDCskR8DYoDC2JLEZEVoQ9pvOGVJnzxXnD6z4mEqhF+9OCXpSrBP1lxj2HOgVxZpDgSQdCi1U+NgbwEt4h8/cG5o8DCKrxIRI0a2/bDv7+Hq3WbX7qQ/DYcE8KfGcbqv9gL+GgcEBWc5EA/cXftkiOyo4kEdpdY+BWtHNA1Iru3Ug1Xqz3Nzcd26qffH1fvtNAQDNeB4Wdg8FRyHaRlG0gN8iUjXDOMu5vXBEqQYgRixj/7ucMr0f92OslCf3XN91IKggktvd/TZS+IOMqHj7aLx/+fnN9ad/+8/rVx8fFHxf7tf9BuLhT4+JbEXA2py4GABZ5GHAxUehoeAKjNoJok9I33ElFZ6e1i1Fmp+dYNKfzPVMnZG6xCe7zjd8ci7+ZK6jMyaSBaOwkMkrYqo7+hjNuAwEOnXEBbPZLDSRyU5eIWOt8cemg/wBYCae5W8+ZJ4KP3lIThfREhYpmr8CpCQdxYXmALUjYYn/IxFIlkOY/gjNINNHL/7QmlYvADVfjS7G6C9XLchoHCNv+fy4u13fXLX+QrCQexmNMkRM5Tuvosf5KQ1PsNyyCsC+TW9g5MDivggra/p91Eg9qxqx3P8nqnEC7FSN2UJVj9MPpGazq9UppwpomO//RN2NIMWcPlbG+IvIHfD+1Nqs+ppk/T9RZSGq+PwAKwh8GVF1t7vV+vOPWVU3yfp/oupCVKeqq1VVB76MqLqvy8Osegvz/Z+otBGk+PIMLWX0TXRUJu7Bx2FicueticpEvlgalUlVOZgmTXtCRD/VCWbpp+cuERT8tGUWFnoCEMHC+/5ZWDAnGkFB+c9Z+gm/FIHAuKRZKAgTH0HBWHcpimD4r7fL/Y+Pm/VNzAoQgmmMAVf4rG088ruosxH4ZSA8MOWNIAJMWvPBwlNYEWVtUV2WhUO7VtkzUtrqY60/i3TOTECLjrWBLLo5SwktupiFZAHOnLtrMcbsJ4tx5iRZi1HgdfkxM3vhLRnS40Dx5c3X9qFffWynu5oTiTQh4mipsvjwCWSdtSJUc2ZqGm0sxXDTC4q/fhA+F4HYHBI4JJNhtgZGHezl8rh8PhwQd8//4dMMXCxJV2OKFvU34gt0EwoOhHI6ocNDnuXnEClP9OsQCe494LDNvv1AWW/3v683696UzgGJ5U6PMfrqFwdx5ptfUYRi48OBk1ggHZL4pJrDI59S61Bxs0G2fwmWxTok8RkLh0dOFuhQReZ6bP+WLZh1eCLzYw6PkEbQ4Tldw/Zmeiu4BBOaPZEXIm6aI9+RkuCMvSt1Ns5unP+829926v63XZ3eoNNaCrSEC6HtN3fPR0yWcgnUv/VrlllIYc6LoXs5C9nLy6HyO/n9y/TL9bbdq/Hh+S+BdN/e7r73Zu6uG6Xzmpks4hJ47+8Gw+Jr5l3vNdbt6uUSuQ2TA82Xcwnk/pKOX67e6FY8o1yXtPQfN/dfZtn4IeNFamzTLrdqYONcl2vH3gT/sl/PaMvHnJdA11/eO/Rp9Clydqk2yXsZ23gGRCTzZWrxardzZ/ux6+L4OgxzXqgGP+x3d+3+xdf1ZtUVoa3CSe5LoDx0/Xzzw9+I/Py0vj7Np3XzyWhRlxvnV+3N/f6w/v7oKnTQuVIugbpbaT6/Oa6/r48/ZjlzPH96pqHT81AXJ4VaoFgBaVibESH6Zrtqfw8XyzglSgkmIUXZwkW0KPkdFO3Xy//c/1uHZZxP0hhaXLftar28Wm4Ru8wDCzImQqakrHiActJKi8ydoW4PH5hrNCJ1hxVwidYliBoe3bk71trq5FhSHumcHWstOo6j5NHN2bHWooswcjzAmTvW6uHCs5iRoTJvx1qLMc7/RsbM7B1ryZAe+c+3u5tv/f1FbNQSJpTEb5IFi3wmil23kUgDUG4jarAQHZfGotpM19XKzbeps+EqxcunxhHfHqQxzd0cjOATuxQamWTbTYMiPoOhschnLxpEnDNjWkyw3aZBETe2zNC6SL1E3CgNR7itpcEScZc0FuGWn7IH9+LM/hrbgyd5k9jmAGFv4fpAnHGXuLrX9Ci6hPRoPX3x6ve79d5lmTkIIsWkx/3bcn18vetDTtrl7fXu1XZ6jzaNFs2cxkuPJkbvdtt1l3y6HnaCD6QnmQ5hZYpmQhCsbuKBqlXNOWj9YjeKgpB4UKHuuPNEEcj9phAH5zJRBBJvKdQdcUuoeqFHEiKIu2q8M6ZuhYhTREEI/aEQQXu7Pr742vNdU9uHqg8zJByV68NftrvftiTNi6KZZjoPETwe/HZ9OLZbZIJAjZFRBtlCWYhF2kUVS3SxZmnPHCSTavdhA7pmmORJWx+fPwurwwleoDaebzanj5uumpkaAfmSItvoAG0uhWO//E1bN2GOpGha7I0e0qxeqk1eBHd2idrlxeQKrwR4Os95126VNnWa6RKY3nemaxYukDFt7/neifebZMKeHMifjWR8a3xX1PHrfnf/hbiTFwokWYaghcqujId4dQsRXLFg/0iIQbwYwYFIViNS7fHlCI5Bvh6RIuEWJDgGyYpEqj2yJMEBCNckUgyRxQCOQbgakGKIL4yIwZGiP4Qm53jzlWQ9gtRExgaWKLQ0Y5iUj+mF/NVhIsVAXrKioXDoOtgEibh3CWpBrvXcnXpRZfB2d4Jpzp68CIfEAk/QzL8JTYSJt8UTNHMiAkQ4olZ5AmXm3r8IjcQ2Tvty8pYKn/dYdjPQzQ/cSgapSazktEThwx5jmDM6HaJX4v1FeiOdDFEt9Psi7RGbjGgX2mSR9niXRgDIfT2FQeIXMMVn+gVRlXB+AcE0xy+IcMT9AoJmvl8gmyqwNuOiwcOFCDxGOpE1imkQWifus3SBPAJIyoieWeiiZ8gFOGceJZ+Fd30SnFelYfaLodzdH8+CCfJfsDa5GF5RfepjeKVI1UYuilbORczCyM9Louhk85QZuCS+O4pO48tn9MT51Xa+r59Rpbzvj2KeNxeYgTM6ZY1CnblOmoU2OsWNu6J50dJitKNb0LFLs0aXu0pvzNLcYTvrpib8jibpHbWcytj10UFe9EZas2iqrHicw/lwgXfLuwcovYLDnx5+Z6sSbZ1gxol9WHSSqb+X/qxwVirWS91ijPL4rfNhKWnvmz8rqvUC1TPnNvmwmFT3yM+MPb5AnShuiQ9zJ7kffn6g8QWqQnv7e1hEqnvf58c7X6BKtLe6h0Ukuc9dcXyB9/zJK0d1ezvIH723vX8xcxIQPJkoIUJpeBSqYBl9gmGnonOod2Nx9YO4aPnJo5BP80kwolmZAoVg7UtiUcw7FIjYlS6JReTKFCgE61oSi2LCoUAUW26RcKTeTYEltpgisUjdiq4HKy3Vk1GWBKM6fPqi64b/c98ejj8dj3ev9nv0mYqJjHyNcOh61P3hxW41/V6q3CePef41Ezsv7EsITPfI3UIkmHv8OqFzMawPbzonscSihEkoQZ4UiFjHroATmxVjRYw+Ru97SUyyt1PErXRe771Ev7lZ3h8UYE7iyXG0faKuYsZZkuO5pS7kIeHcMlfwzEADbPy27fd/yGuCSFRIzplcbqTyxhff77afN+sbxgVMJJI4ALzUeeZ/+g0K408A0Zh+sX7G8BMwZph9Do3I6EehxEz+tICzDD6BR/RGgrRlzump6fsJbuipelCZeTEG2sgTOPQmXoyFNPAEFLV555DojDuBKJ1pZ4f32NSE1vzz/fbG3Rj9pyGFteKjgoYj5n2Wd+3hML638bHMqRDvJEYO6PVu/+t6tWq3tAeaiiRxQUSx83wQ8hkKJ0RB0XghOQLGDVFAZvghFo/IEcXBxDwRUsJZrohCJPFF8vY5q89eoL/g7oisC5U/kqOgHRKFRO+R5GhIl0SBUfskFovOKVGY0nklvuICc3+/XXGmfpycyMxPipxr4gPoKvM+haAz7RLNrFmfAphl0gkcQnPOgYib8iD3mWZ8ikRmwiXtsNnd4Cw8pnYknLIvzB4PiXFQrgOpf6XbkGjnXMYUwRx3IUHBuIopiBlugsCgdRFTLCndA2U48gnEB7HxMwCPSw1MTLqWmeR90WeQKHGC4qCrh2zv78JHfkYb5lBG7uvCMRUrEhlY45aZQBUPpahifDzNUT4ZQVHd6DCSqh5NV+iZimySAu7rIR20zDejHzDD/81wfed4HJmzUWnD/UrUpah00N5D5DhUukgfIXEPMU06T3COE4giwYxkaISxoR23vrGuyJeq6pIermD2H9EJFwB6ZYg9iejU2BWoWhoJxuuNTfNB7lnT/AgYlbmb1AKwD9ft/vZwvZuMpse5BCYmnbC0vx/3y5vjq4cisPKhjI7Zff7ly779cmJvSW43FBOzu2/6ptguNx/b/fd2j3tSRCbJwp8qd97qH/sSBQVAgtHwAAoMzFyDhDKDEeARiWgBAZyY0cCKOIsgIDHJXoQRt9J5vfcS/QafWNH1oVq1K3DQky8Si379rsBDTtBIOOqVPI9GN4kjUaVb00cqb3wjc3v8ulv9vDs+32x2v7UM/UtKJnEIfOnz3AL9bQrnEAGmcRFqPIyjiMCa4S4k6EROQwwt5jrogs5yIBF8oqvBtS156zIgNx/yWB6zJcKRYgRerr/jDi7WXio3p8ZEO7sILr3Lm9OrcBcT71Y69ydBpnOCEYTpXKGoUoMnCr63qw/dWm257QrY/GAcIiWZxiGypc90iOS3aRwiD0zlELV4OIfIw5rjEAXoZA5RCi3qEMmCznOIPD7ZWxnKliQ3YiNg1HuyamQpxuTl0BEuMtKCOhepxcS4SB7XDBepxUa7SB6a3kUKkCldJI8woYuUVOrIRXbONBIqNJFI4hLxUue5wuk3KFwgAUTj+sT6GZdHwJjh6jg0IhcXhRJzbdMCznJpBB6JKxO3zDk9NX0/wR0DVQ8qhyDGQDsCAofeAYixkIafgKI2+BwSnaEnEKUz8GylhYb9ze3dpr3tsnFUICGXysiTZc829ehX6Qw+DUpp9jVYeONPQ5rnAiLIpI5AAkvgDtBiznUKNDaha9C03vm9/FL9inQWTP1oXYYGD+s4aEyz3IcGF+dEaFhzXEkEldqh0OiSupUY7FFM0fvn98evTuD1ut2s0KgiKCP3KG3gqGJFPjmJ4+N8ApVT+mnVHm726zvqJjkGAMh6HpjDzQ4P+sEBnMTPVHr0d5xIlQ7ieqWjWYoToycnYXKSCFCkSEm4FgCqd1iYXomfIhWHxm257cb/bv8DjEdO+zTPOQgYB4kpn+EXZThwd4jWvsoLyrTTzg9DoPd5wt5AORO0G2g9HIlB59gwLOn8GV1R46ec9m03BFfr3ma/Xq433DqJkU2yVoqVP2+9xH2hYs0UBadZN83AxNjzKLQZ6ycZQtEaSgEvto7iijprLRXFKHpvTN+qaUbDJfsd7kzi9aXyLDNw0W4mik3vc2bgIx1QFJ7aG8nQ6VxTFGU6PyWs3PGNrP3V5N1y7ePyuD58XnM+ixZN4rIixc/zWMznKRxWDJrGX+kRMe4qBmyGtxLhEzkrObjoHd10SWe5qhhC0bXA6vZMMgYu2N9wNxWtK5WX0qOinVQMmd5H6dGRLioGTu2hRNh0DiqGMZ1/khmX6dHvq3a17lzb4/VZsSPgeAbxAahJ9mmdQYkkdBJeqoRRmiKeYQ5x7bK35Wj1suguQjka1TVLM2d2cd1zrK0UDWFkiRbQ2VYpBsak4jhmWFIpFtqA4lD0dpNBojSXOKKEVpKDGrwSxFrF4J0HvTmUn81mSk8yhuac3eYwqabrKjD82W4O05yZegya/BUQCa74QzpoKeeeBefAUZ7pvFobN+fHH4djextOAcaXco7S+QnAaNhiZY4+WFokfJlp3+JjH5b35FEWb8gxPsp7EZZgouuGu5xBoGjVHtD36SaKBsHZijrXtt2JNJ0kZ6tabz/LNA2CsxXdLY9fRYoGwfmKdntZKw2CsxUdfhxulpuNSNejrErdaBXwy3Z5f/y626//l6PFUKkkjBhd8jwyDP8eBQ/GANL4VBUOZrXEwJnhTmOoRJyXCFLMk+KFnMV0MbgkyztVi53boy/Tj/AFF1cvqkWXCgu98GLw6BdfKkzkAoyBpF6ExRDpFmIMsnSLsWglBg7jcH/X+7h29a6bZi6vu1HOOQ5GOpEDiWmY60i471Q5lChAnWOZgYt1MFF4sxyNDKXQ4Sggxh0PV9iZDiiKU+aIZrRwqhFy2X5IOah4vSkd1QxsnMOK4pvjuGZgZBxYFOIMRyZDqHVoUaQpHZuwkkcO7vl+v/zxy3a92/603K427XScTyRYRya1HnipIosxhUy0zs3u9tf1dtrDSd0ncbr+pTiCfvzVJ0+jbgkgI/mZPUFeRctBQlxJowyygSXG8lUF5OuFUCw3mxfaSgF5Lt1o/tM/Lj8rK2vIkaLCmiorHgf688OP7c0g9mZ7d/9IHfWTkw4VTI9srdKlv78/8sV7AfG28DjrtDJHiWmMHixQZu/GGPXjeKoT7apajdRonahDBuo8XXiHJ/RN+rpAZ/Ao7263aZekUwyTk3QOpEjZU6ohUnKX/ssX2Xc8eRCVuUGZftIHYgh4Bzh5a5lEIBwiaM1HB4lMK9N16S9nO69Gr0LnjP41fr50efO1XVGjJUhNMlimJcreoQxgUotL/IFyRCXyIjndS0W6P+PHsxDdn6eHss7UfdMLiWp6EDxHs3BootpjI1OkkxggiMLI+BBp+9Ie/9L+EDXso6jM/or0f+5+etkejustHquFdjCYJSEexiySLaCavpI9Pnxz2QfWLzek5ZqIpDFfeLHSt3QhaqUhI5TrrJkcRfcx49dKozAe5C+CoxtbWig+y0XQ/G25uVdXzSlTWkTDIFO2FsyVFlNng9aHr25ky+CMMpyNROqiqLEc91Ni7Zy55BuGm0lq9St1J9Db2fCbbw/i8qqH2c7uC2XQJycT3ccAslEq6ymCAjfHdv8TXCCNyxwLiLkNfxvu63HmSQ0iMkkcHFWu4sbtEDi9RcDctY3ox27ZpvuEAgnhbEkgKm/L4xAaKrpNopZKoZ8wFaTyiK1QaO6HnheXaw/yJG4JxmhHakM104300fF1Bsv9crNpyckuSE9iCLAyZefFAVgtr4QqVhJLNAbhkMO/PjrchHqJocZ8eRqNaJdmtKq6M9Puwc0cu5v2cCB7cpCcpiNPixTeexAgpbiXzf2hG7/vltslRtOiymEWUY8WoSF8GYZC5cZk2tvf25v7Y/t++2G/vl3up8s1DAeS6SxE0gGONUx8fIu0UsMbURkb3dKvfOVrUfqZj+Lp6pozMeSX6ywM2QtHBuZj+z/37fampSwMSE9iYrAyRTYGgtX6SlSx0lfSGCSdmkEw46uFgxevb3WAg+rL0Y7NfL2qZzP9YNy1j8vjmtz0DlLTdOtJibJOHcAkuvR3lD9DNH5XcGaUZlFHnqqOdWOJNqYTI7Wr78LyL8Y7MPXVuu5Ltfik815/3e9+43vwWCRhN54Uq+jLAWouLlOse3q1Kbczw6KQd+4pDFEPl+iNdXOk9mf2dXktMB2eqokZvZ7qG8FZBCZKM3mA5rzYzLPCIWdGQmr17zsvud63z0enDmkEgbDEeUgQrL9sd3v/grOkFoD4GSiEg00a9qnVSJgVUXCnVhcbx3lGCKe6lokg5PPjj88MFU0SJUr1dvwIFRttScglMmZ02dpTKlTw4MSLv+sWmdhWKgsG5JSN9Rg28bDnaklgAVQ4SGPAgIjahRkIiMERRaEcJ9H+Mxoyf1+6Q/AbkqmHAkkGCVqoaHRM8OqCUHHFyjBUKQZy9oGjULIgDArhICRaITr6pJqJYcd9fSKd6EDj9LLBC1x7j+O4l4f2zarLsv68bvcfj/1Jqy9TShkXSxPXTRcti+/Gv4Co6sHMHB5zqACh2VPg+tIeP7icL3bb47Kb5uhwodlT4Fofrna7maCmeVMguvHlIZHyfEc6ZZqLYXSfETNgRvezKMdLuMNEd9O4Bk0vZb9Zep2WHMdwHvtfSwWgZ8jnENXGjCIBXMUgumi1TXGcqs1oqg35HGq9TQxyAVbpGL9ohQEQp9rKNbUFP4TaiIbWRwAvanwuWjkn7bGrEJD8D8AJrnm9/bJp+2oTzCA44TT8c0yBjInmvonoE792vuOX/ZQtiyN6zCnad5mBjVhSxKEplxdCbNq5WBynwtfNwRib/8QBSi3kHHSCWWMcYMTtsdz8DMzk/E00gKeGNAG+wKjd/7ra3XZaJDaNlk1j0iLlyywa80FagxbDo7RnemT79kv7ux7XKduFUFFGNgZLa2NFyNQmNoZSY2H1CKMGNgZPbF/12CTmNQbvHOuqR0wbV4EpUdpW2TgBXNNVu1z9vS/r7e7mG8EnAJlkLBNWbuxGZfxIP/Ih5HrhfntUfuuTMFMKTEEn+W19/NqL9lJyUCAXTaMIUSxv3M6xHsg0o8SsK5Dt2007SOuQTTMmRta3wZt+ybddbl6cOomuCbHsiVF2Ju+h9AjPisIk8ycfCbe71frzD6dMDi/MlNxibJTGYhO3E+y1Ssru9yCm63bjbDL/osSlh0R3/gTVNmKLX/1+t953CxHK9Y04HEJUzhujpl2oQGbhqa/RE1ZiLDHmiioo+B6mwqZdWoMS79l/UJU9/BhnjLlae/wmfCb36n/ul5vYVA4TSjKXIwsWrYdR7DpbTAMQGGMFFvmsjUYkG9RKHLQT4IEIxooSyQwQUbuv6S2jQfF6vWn9EwtXrT/2RQwMSjDJ4GALFw0Q8jt07AcPREl9aDEtj53o3fFjezx2Jm66HObBTXNLZsj6erv59v7OXWGgrrxxzkthe73brGa06yjjJZB9XneLl/5qeiWwcb5EuEKm7bflZrP7jQha5rHBvInwia5TVyB7Fvz1r1lsXkYWzZQaYQu0A/kh12xThzEDShSPudKgOO769M9drg/j945kYCaZLzEYTnd2zzNv09yXwLjero9rZxKU8IKMaVr0ZJxm2rRkOG7uD8fd7fvti91t54Zv1we1mcVLSOUIRrOtP+/bdvUjtgZBpZLMs+iSRZMsHD4VDUZcOsZgYG+JQyZYKjz7Tuzj/efP6+lWHAMpyHUBVI4118MKs6XBNYcOZSCeSYjOQovdAyiASN4FeC4ujqplcM0ha/W9Tm19xFs8LAepqkCWP2CQkgTCOcgkLAuD6VzOW11xNOERqTk9763GNgfWedx3tHWDW/Zud/sfEUYEE0ripcmChRftIdh1LAgNQMmA6LDoapkdT8gVb3Ik99u+6BfdAu/X5c037B5CCtI0ZwJsoiUljSm2nNRop5aStPbYMlKjvXPXvQDuTmkIIFuK3hLev9cvrGJzelwsiblgipZeyod9ATONxluAwzHOJWmAKKY5k1UO4JmzVR1eblrIgZwzL9S1Ljcx5PtZgpmhrhLZqSGHddbcUFeNhC/jUJ07O9RXHj09jNWefn6oRzcL2HkzxDjIUYCEIDDiYgER8/dMz9/NPzvw4SIBD2ds3l6wShSBDdKAhrALrtaHyW5hAGwkIO9+/f8Od10JH/btmJdiS34yzUV96Rg1NQU/9PF+t0R1T3SPxM9Qetfl/G23XwmVjsTPULr6VajOCSoVjeapTobw7KO0JDNSWJ5oGjoGqFuuTtQpV6kCzfteJK74JCaZ4kq1Xv0m1OsEU2pGXTCum3a8c7THAiEmGObFPgiQUKaQRMJZwbOQ0CEEEwzaqAFce7jH1i3gjq0TfLFZt8i6ZTrmkSyJ0HSLtQd/iVH+EyzTDCmReJZADmQsnwjHEI7werlB2JkJCiA9H4MoWINV/2z8Rzw6Y1wWWcysFeMEpXA+HW0afqmFqpVMWqN6KaZwajwjBKFAF8ULIs6CpwMFupgQiIk6QdSDQCMZ6EBa3nO03XQ1tO9FBH4vkD3DlASLCnTTI5ibinc8Qq8OOiRfpKBbzokgkymNm6Eg6wkqOZkKR0cEQ3yMXODDB6WShWqQ+QQWX3T8fb+8u2tXscMkp/7NiydZmghUyG7H479Mt4CRgNLenDcT39x20R4imIev7cXxx04lGIPsiXHKZxoSpKLJx3xs9HxECi4+RZmHrh3EP/g4vPnNHJQhcY3yHjkycH/brVeEMXtMSmK4QHEiIzVCpzNIUJnS+KB65QMEahcNBplOuuNjSuOdHK/hUQf5aXn4+m55N1E3/J6ka4zLEvWLEyiiU3wVYH7yKCQZXAKNr6c2faLwtfTdz6k+0VIVURibCj5k8fCIvtelRpUpmgtyEHzZXmBW2YdY2Yf5Za+6qSPyLFVQ/IPMLA1ueRQZLoPIrPI7of26jbTso9AsHd+wF+YDBd/gw/KK0t0LOpHyH2Rmafi8279a3kwPfAQqHoXEOkqT5aNgc2x5HnZUblke+YZ/dG6gmzfu9v/F6/h0kvs01/T+47j7eOynH9fLLzFlI1GNvtEjxeuHQJefQgP8+EwxFOGX+yPH9xhEg7mSIDWJE5yWKHKFIUyF9Ub0QRvOxRqI9GKWHdEL7fvZejGrj+iFtv9svYRHQFQjfuFs7bi3wPrVxGecrZvyJIh2zJ+crR/1Mojyia85WzPhgRDdiB86WzvlnRD1mI+apV/gubDBBv3X2d/OeDVEP+Hb5qBQeDwMCOn3ZmFBXdbH9vjufnNc865rJJXYhcGSla5sDH+WS5von+faZDhedQZtunXKgznluQAi3ulOwMxzvgIcvBOe4JjnjAU4lqtpyAGDw4tfAEd0cjCBMnuSIEaj7rphtgvgik1ippZl5mRG0nMOOvv55JThAljiE6wJmvkTLSGeH52cGtEp0wUwRSaBEzgzJ4OS0bU+HNfdEvQvSkQg3wWQRaerE0yzp61SNNpeNM50AUzxKfUE0fypNYFHNcWeutJ5U21B3Yim3BM8Z029cVSzpuBTYGdOxXFsI4LKH3hCaCmfwM66R8V0c7SX7edlpwop6jGRLc4smiorHifyz/f75Y9Xm/a2HQVD9jsFhz+Nk1Rlvrq9O/54/+t/tzewyFGKqsSuZsdxib4w/6O2nL8Fr7I/lOR+1pYVzpseynI/62usy/kCWVaNai6UEC/WwC4RX+CT2IWfCFSmklwHh1cRDTU1TuPHALfpRRUW+5AQGhXsNVo1RBQ9g0sGUtlpL46Ms7rdfRd/37MH8VmaxzFzGF0wireS8gTwVTBJWezmHmFfhWFimKpTfFhGv4U2ztaDo7d8QyvAaUZX/Bf80pO+h8+tRZ/7AFMwKDj13IBI/KWdqnjM3zhXj406yoSsiTnd1GL4gp87Uhl/1W+ce4yVat2DcPwj69xLtnCvLP66XNDGB2a2CFfSnG5sCX3BTx3UPYzahehrTyCZ7w1X6jEI0yX6hb/ZKXz4atk4fgRKjWZsDc6OLWrxfcnxPNJ5qgCZrQ7QElUAFvsckEiQROLP9toeDLesxQeI3LeKuznOIVz6i8fd3MgG9yNQ6lwdoCs4ELEwlcTfPKh7GNgy430CSS32pxQEh0EQ0pL4qx81xkLvxllHn8UeReB29qYiKY8czNrTQ1AT7XqD3iZD65bfxSPHcCuv1Ce34thRVn90U5PSzwVcqjTie0CMWn7CK9eNbVRSarlVolwjtiVJaeQCQ+Uasc1HSiO3apJrJLYZKaWRAFWtXl1nkiyg5AjwrUPSgrCBs4oWRjcJyTZmV05yrdR2IKU3tpDRacY3/jjd/JJCrh3d4qMUs4HFip7NbeaRXVuymJBjILbtKO2R2bxSr6q14zNruXZqK47SHZvf8poFm26ks+CCs+Xfy2yvUZoF81v5/IffSCMhiAK5eRSjie6Lr/2Dravr9vZus+y9w5fuzwkYVCrJdJcuWTTjxeFTi7f1/nBUf+GTMJtkDqpCdeOFvdB05HMVBHMmx9blWbX7dvVz/6cCGciXAlc4+Vhuf1puVxsVqHGmeb0JTOa1AL4m1/5x+XkGgiGXbP892l/Gb+b99yFiSCYSSYwIXqrsqbwJZGIoUA/GE7p1z8RzKCSdjgAR6XDibx+eR++POx/b7QF974aAgGdF6kRy5aa4mmj7QHUV1DYkwcKMVLbZVKOUbcrxCD21Qv+2a8zrc8Jpxm1Mwayny9lvPKeHR9FqO/sM1NJuHq/ZqDecg4iyT1E4iKli+/tsbPhAFOLTjUlhPwzO//dafl3uY36UEkwyLNnChVcGEN+hdK48Ep2PFWCSdGUeUsTjautFYpZ4QEn9r7YKafsU6WJqbzyvcVFbIGlglR2QNPrIBnw8Lo/rm8j4x4SSjH2yYNG4R7ETffs4SCkgjLJIRvwcNNr6fjLJmACZcBAxbRV17hoEhCWk1UesoF43OlBj+lWDNIopDLi9hp3Xh4+eflZFJZ8y9a9DBkRLWOYpmS97FGd6yujpwodSR7vpoYQ82vQ4p+Qnk1x47wCw+W/7MH4dFtHfp+u/q69qUalPQA7+ixzYiGrxBz0BOVSqsar0ff7N9u4eDSVGxOQV2/mObvaBRwtRBT8ZZeI/boxc6mwkAFB3owAwcuoRd34BRz5jNY0axnOdVJr53VmOKsF682xnlchNkTjC80tjnxFYlOAgE5SSHpDqn+eaOMDHksfJbJF2dD7qw4e3b148v37z/udP//7x/c8PxX5f7tfLXzf9OSkgMqfoty8lpQ9ScxS8f3H96vrTx+urV8/fRbSMReeo+vjh+dVf33765cPL59evIroC2TnK/uPT3//+90+v31+9+/TL1dtXP794//LVy4hSNI9U+fWr/7j+9NP1u7eIkoc0VWHvnl/95eX7v2ONH6SrCv3ZUsX9bFUFXf9ydf0Wa8ZRqrTANz9fv7r6+fnbT8/fYtU3TlYX+ddfnr/8yBXqBNTFvrq6en/FFesEpMW+fPX6+S9vrz+9+OXj9ft3n67/88MrDDMmNv+AnKDc2Fk5FDd1fuRmM0P1M59Nrj5yiG55s5+HguYQZqC4bY/LOTCGfOfgGLnFz+3x5uvL5XE5Dnx8dIvjZLmnPdx1edvrHV3uREZauH9y5c/ttptm3Lz63n31q9v1sZsWv+gzIpr4DHPPyarKfxKRiQywSO5IjeDrJ0QcW2UgYvL103K1ers+HPsiNGU/CfPhdYLh1wfmSyDEWgcrY/wFROWMrneXAALXuf8Tq2K3FZy6wnLvtvS332gx3KgaIO3337SC4yl4DdxEDnLPGh+TrH9IvYQoHo4s6WoIfArVXz5/1jWZk/9jesvnz4KjmWhn6UCzfeX5ZnOqKJSSirQUyP4H9pkxEsH5PrrfBJ9E1N1mVpVt/uia2sAKok98YmVsYtWyX/42szOFGf+YbjTCIDgriXag8WdQp6I7WRWuIcMfUie97vgtB1h2hzoyesJ33DUdePqS+x8wihyI+GUI3Ejy30FU092+vWu382a707x/SFUBGIJLULCi4Mfw9fW+mx+dU2cg/x9Zb2MoghtVmLoLPoqyTH2+fltVZ7uDbH+MlXpAEL+tA7VVj1+AsgPrw5/vl/vV6AXZ0TX/pzQp1fClF/947JbXt0hxo1TVxjkE6PfLldCO++X28Hm3v/3r/e7YrvyuM8Z+4ILz+UJRyU+ItMhKmshFfCs5Vz7gd+DNxvvsocgEsKPXe91tuhF0G2w7p/mGoOCLfMmofx7uNuvj8+3qxaZdYk9uBOnSTt/hPLQflvvur+N42vpYLJBQFfz85qa9wzrOKHVGgS++9v+OlDsIzSj+1fZmtxqHs6Dln6RmKHi73HaW7gtmARCpGQpeLo/t9fo2ouAkJVWwXK1+aper0bzisdiHNBXaFz6w4xq3hlBEVfTr3f43ymuFAqpi366338hKABLSgm+Xx5uv7eH5/fHrbr/+X/fQ5MfuF7T9aGGpuq/LA1n6Q5o4tmxaz6M5i6yOwwBw9A64sKAnv9L3Fjzioc5+7tB5MdDwmYltjar4ujugCzugYxCbqaQP1N4JtJzk5GqCrnmH9kH+hpvxVth6c0THik8Q71DttjdLzOD7BDmaLWYP+p/lG3Gr+xs82KVPkBZzcKH4zw8/tjfv2j3qCqCI2Ez3Oa537jZhzFKPklWT7H8/jPZX/Ay7/0kKa9tNdtwj50wo0kRGWvh/79Zbptxxsrgafz3sNvds5BQUkRbdbg/3+/Z6v1xvugnEx04aKx2Rki9l1rdBxhaf+U6kdF/wtnNz0Q8YC2nwj/OR8EMh8SK0PT4cgsFWoaNkMeLdi+V2t13fLDe/7NdEf5kKSYtftd1ksx0yvdjd3u22xHKGkJQ3rFQRISlVtD70M7v+RPmeqC0gMaPgxxvj+eIf5cTV9Hu3gLs5kvOoID0FMzAt8En4U4QHCIVD+NSRM/nHoViePRSghhRd0R+wuYAU15A9AarQply1m246/j04vxhYlZGALjTn4/2vq91t11ev2i/t79iUDJVT2MN3u9X9pr3a7YinDh7Txasal4MY24+JigCo3eZ7+44rdSKjLPx5J3Tky34Q0YRIf1jefOsW8sEEKoySHklIQxsfq/BDz0J93W3Gi9LH2DdUTjOvwrvzkCK3yh/2u9v1AbMnD2nK5hpyvd+HT0xM2iyUEy/3fa6PO5xGeUwVTyg3m9f3m27ds0FJiXGyal5OVIOfoc/79kPb9Z5+Hv7X++UKc/6hgIpBoYp8TJQWd79d/889Wd4oVTyJa/e317s3W5TqPqXxVMbopM9rt8LtBl733+kb9UFqknM+0xJFJ3VDmNRc4D58XYbR+Sh6hr67bjXdTZORM8GIxrHwGTp34k/czfzCUee46qbp+9V7XOU4MUnXmBQo6hkBRooRvups7P3+pn3XHper5Sj6OuCGoZR4iN910q17UmXdrl4u0WNGUyEFo306n8Tjh1Li6dumWxVdtV0PPXR16shabPI2lZKTPZ0p7iaWy1W3mlmtw2d/xqTPVExM8X7crG9avysLHxYaX8g9kZKTvofjco8/W4MX+uSUAe+4CGBq03+Lv6xCqPXi5yoNrriUfCx3yyWvdnybxKPgxD6M0pLYG1ie7MqIEUCq5pwRiat7kHvUxN24JNC8b/tlVU81fVtPrx2eAIDi6XH0Y1mBYxA/B0dwwPXTwwZ2HEQgq2n7QOOv6+1y/8MJxlWGwsm+2jt+IYZQOBmGm6/tzbdXW0HjjyTP0Q4Ws/2q8noHLnwIV7NjEc062eejJvRAQlNwv64mg45CAQVn8rH7vE375tiioUzjdPECaX3nToFvsI2bx0R1RBNZJpBQRXG1Q6TW626JiVUAlJFT0Kv3n8nWGqWKJzBuD+369KnMHAYVlE9jpjZRVPaTuH3Ev0AfRCgBEY94xkt5/Apq531zf0CvNGFQnfL8YdXiAMTYdTy/x07Hcr3Y3d4uP7ZdKcsjSgkhUmIGZ7ntZvn/21PNH8Zz61HhoYScyPvbcrNeTa4oGtN5gYS8YJxodL+LSefD9e7l/Z5aaI2T5biu2z1miXyCfIOwr4wVUdYoVV6gX5mTJT4my4t86661x5rhIU1e2IcTL0NCDCTk5OSx91Zv+uH7HcUKJHR7LX/b3Sx/vd8s95i/hCKK/cLOcbFFQxEVB4yU7PnfmeX1FmG93JDFTtJnon3b/WtDQnapM0vGyHCQOrPkoDfDgqMdeXytygvsUo7uV3kBH9ACPogLwC7DeC6+tOP5L9c/YQV0P0uLePkCKeDlC2n21++fv0YK6H+WFvET9gk/iT/gp+trrBH6n6VFvHn+83OkiP5naRH9LUWf3mL38Awp0oLevsS+pvtVWsA77FPeiT/k5/fXb17/J1KET5AW8/4N2rH6n6VFfHiD3dvU/Sou4P3HN/+BFdH/Li3k6iXWv7tfFQVgg7z/WVrEx/dv32Bdy/2uKuQTanBOSbqiqIuCRqkzCvx0/eoKa3cooiuaMBKPibri3r26xkbZY6K0uL89/xm7Bav/WVzEi+dXWOdwv0sL+Y+PWBHdr9ICXrz/+frVz9ef3r76+c+oTwoF5hVL9Q1ESqugv1OIKblPnlNkDPGDjNimXb163Q2CVy8/9f/CzRsQmVs0hR2Vw5T819Nuib9qf/+X//f//cv3du+CPf/fv5hn9lnTSX5et5tVJ/gPr7/L2q2z+9X8fw1pf2v73Ypewov8afEvT/+xeFovnlVV/V//9fQfpxwuwf3gxLLur+ypyZ9ViyoQywIx0/1lntriWdGUgZgJxGz3l31aFc/KsgnEbCCWd3/lT039rCrC0vJArOj+Kp6a5tmiMYFYEYiV3V8lJlYGYlX3V/W0rJ5VdRGIVYFY3f1V96UVTVhvdSDWNco/Gqx6m7B6F1RxGWgH1xCLp2X2zGZAMmyK/g6ef2QZpjsLWyOzpPKwPfpLbf6RGbTIsEmyvuoztImzsFX6Y+OE8rBdsr7+sxxVHjZNf5r6H1nxtLTPchs2dRa2TtaQ3Tpsn/7OCLwrmrB9TEZ1RgNGiqG6owlbx/RtkJXYd5uweUxOfY0JW8e41qmw1jFh65iSGqkmbB1TkSM/bBxTkzUZto1pyJoM28YuqJq0YdtYN3ZqrCZt2DjWUDVpgSGzFEgbto0lbZkN28YW5NeETWP7BshQ22LDtrEV+TVh29i+BcwCM342bBzbN4FBjYsNWyfv28CYp2XnorKwC+Vh8+QZae7D1skNVel52Dp53wbGYt+TA0+TU7Weh82T941gUCuUh+2Tl1St52Hz5KTHycPmyWtqjOVh6+Tk0MnDxilIs1aEbVNkVP0UYdsUbgZQYPVThI1TWKp+irBtipz67ALMAwrya8KmKUpyxhA2TVGRnx02TeGapsQMZRG2TUG6nCJsm5JsmzJsm5J0OWXYNiXpcsqwaUo3biqsEcuwbUrXNvXTqhvdi7DzlmHjlG7gNFgNlWCeVlLjoQxbp+zbwKKT1zJsnrKmKr0MW6ckR04Ztk5Ftk4Vtk5FjpwqbJ2qbwOLmtQqbJ6KHDlV2DpVTn1NFTZORY6cKmybipxEV2AW7doGnSpWYdtUZNtUYdtUZNtUYdvUfQtYi+muw8ap+yawqDWvw9apDVVDddg4taVqqA4bp+6bwKKWsg5bp+7bwKIzwDpsntpN19CBW4ftU7v2QedCNVjokO1Th+1T961gm6d5+awswoFbhw3UuMGDLmKasIEack7QhO3TkHOCJmyfhmyfJmyfxs3Y0PHYhO3TFFQNNWHzNCVZQ03YPE1F11DYPI2bT5unRd19UBZKgqVoQ9YlXIwuqMr0SWNR0rz5pLGoG0LosPRpY1nSxPmksWhOVpVPG8s6O5dj7sqnjWXpxvJpY9mKqlqfNBat6boFi9NFQ9ctaDHHEuQF5jSzCYNAczmQQshIq5dBDiEjV0IZZBEycrKdQRrBkQU5avoySCRk5IQ7g1RCRg+vDJIJGblgzSCbkJEeKgN8QmbIRWsGGIXMEQc5atQzAzkfcuGaAVohc+QBUQeAWMgMuXrNALWQGZKNywC3kBlyMpEBdiFzJEKOuqsMEAyZZxjQhXEGOIbMkwzoFDIDNEPm2IQCJ9QA05A5PqHorHIxNR6Aa8gcpVDYp3nzLLOg0Sxk6twow0kwwDhkjlgoCpSDA6RD5riFAh9ngHfIHLtQ4P0RMA8ZTT1kgHvIHMNA9EfAPmSWdGUZoB+ynPZlgH/IHM1Q4J0MUBCZ5yDwTgZYiMxxDeUCbYgcMqzONuKdDFARmSMcSoKOBY3mOIcSd76Aj8gc7VDinQxQEpljHvAxDEiJzHEPJTrhzQAvkTn6Ae83gJnIHAGB0gMZ4CYyx0CUeC8H7ETmSIgS7+WAoMgcD4HPwbICEuO0fQQsRebIiBLvj4CoyDxTgfdHwFVkjpGocKMH2IrMkRIV3h8BYZE5XqLC+yPgLLKSnNhngLXIaNoiA7xF5tiJCu/lgLnIHD9R4b0ccBeZYygqvOuWcD/D0Rd4JwMERuZoigrvZIDCyBxTUeG9AbAYWUnvawAeI3N0BeElAJWRVSTTlAEyI6vomSNgM7KKXJFlgM/IHG1R4b0cUBqZYy5QGikDpEbmuIsaN9AV3IXqm6XGBwRgNjJHYNTmaVk+62a2QBY0WUU3GaA3sprknjLAb2Q13WKA4MhqepgBiiNzTEaNDzPAcmQ1uSmVAZojc2QGbskBz5E5NqPGF3KA6cgcn1HjayPAdWQ1vToDbEfmOI0aH+eA78gcq1Hj4xwwHhlNeWSA88gauskA65E5cqPGrQcgPrKGbjLAfGQN3WSA+8gcw1E32EZQBtiPzHEcDT4gAf+ROZajydDmBQxI1tALNMCBGEd0NAbrYQaQIMYxHQ06HgxgQcyCNIwGkCBmQRpGA0gQ44iOBnVmBpAgZkHSVQZwIMbxHPiuLqBAjOM58BFpAAdiFjRnZQAJYhb0NjAgQYwjOhrUSxtAghjHdDT4rjpgQYyjOhp09BpAgxjHdTToODOABzEZuao2gAcxGbkrbAANYhzX0aA+0gAexGTk8swAGsRk5OajATSI8VEVi8XTIn9WGggBNJpjO7IF6lANDK5goism4RWOCVmgs1EDQyx8jMUCH8EwyoImQwyMszB0s8FAC8d4ZAt8CMNgC0O3Gwy3MHS7wYALR3jgK3ADyBBjyWW1AVyI8WEXC3xcAjLE+MiLBRHuAiNjfLPhIxPQIYaOwDCADTF0DIYBZIjxURgLfMADNsRYcqffADbEOMYDn5IawIYY68dbgwU8GcCHmJxcWRvAhxg6IMMAOsTQIRkGsCEmp70aIEOMIzyyDF2pGsCGmJx2a4AMMY7wwONcDCBDjCM8MjyOzgA2xDjKI8Mj5AzgQ4zjPPDIGAP4EEMHahjAh5iCtpGADzE+WAONjzGADzEF3WyADjGFbzbcmgI+xBR0swE+xBT0bATQIaZgZiOADjGO8sAnmwbQIaagZyOADTGO8cjwgEUD6BDjOI8sw20kIERMSU8hASFiSrrVAB9iSt9quOUFhIgp6VYDfIgp6VYDdIgp/VjD7TngQ0xJ88UG8CHG8yF46J8BjIjxoR347BQwIsbRHnjcjwGUiKloGwkoEeMjPPDgPgNIEVP5qFzcSgJWxDjqI8Mj9wzgRYzjPjKDmzNAjBhHfmQGH/WAGTE+6AOPozOAGjEVyfYbQI2YmtxWM4AaMY7/yPBQNQPIEeMYkKxraITKMYAeMTUZT20AO2I8O2IqvFzQdo4EIcoFLVf7lqvxckHLeYIELxcG7/p2a/ByQbt5hgQvF7SbJ0hQjsYAgsQ4FiSzC9S4A4rEOB4ExwAoEuNokMxmeLmg4RwRQpQLms2Hh1icSgAsiWnIcHgDSBLjiJDMWrxc0HANeV7BAJLEOCaE6uuAJrEL8uCCBSyJXWR0X7eAJrELst0soEmsjxXB+7oFRIldkO1mAU9iPU+C93ULmBK7INvNAqbELny7obbPAqrELsjoKwuYEuvoENxvWUCVWEeHZBal/S3gSqwPGLEl1tEsIEusP3aCx6BZwJbYzA85IiQfNN1w+gTtlxYQJtYfQCE6G6BMbMZYSws4E+s5E6JbANbE+qMouK2ygDexnjfBDZAFvIn1vAluVSzgTazJaFNhAXNiPXNi8ZMFgDmxhgzUsoA3sf54So7OUyxgTqyjR4jODKgTa8hwbguIE2vIQC0LiBNryJ1tC4gTaxpmNMHTKpZcgFt4XsWSC3ALD6xYcnJpJ0dWyDWBhYdWrG8y/JwHPLhiyTWBhUdXPGvSN29nLyvQH+HpFUeNEJ8G2sySsVoWHmCxZHCdBZSJ9ZQJHrloAWliczK6zgLSxDpmJOvDEZFuA2gTm1vG+gHixObMtNIC4sR64oSwfoA6sf5UC2H9AHdiPXeS4+MCcCfWcyd4rJ8F3InNyd1SC6gT60NJiFoG5IktmLmlBfSJLQxjrwF/Yv1xF8JeAwbFegaFsNeAQbGeQSFqGXAotiiZbgRYFFtUTDcCNIotaqYbAR7F+lMwRDcCTIr1TAoeAWkBk2JLevwBHsWWfvzhsw/ApNiSG3+AS7ElN/4Al2JLbvwBNsWW3PgDfIr1fAoeCmkBn2JLcoVgAZ1iPZ1SLJ6W+bOytkAYtJ6jTLIiw9hpC/gUW3FTTUCo2Io+pQkIFes4E9wxADrF0odmLCBTbEWf1QRUivVUSoFSKRZQKdZTKYV9WjbPKjj7AVSK9VRKkT8tFpNYUwuoFOujTPpwH6x+QcvV9EwFkCm2pmcqgEqxNT1TAUSKpc/SWECkWE+k4BGsFhAptqZnKoBIsY4rIT4MtFpNz1MAjWI9jYLH0FpAo1iaRrGARrGNH2u4RQM8ivU8Ch7DagGPYh1ZkpW4YwRMivVMCh7FagGTYn20CR7GagGXYj2XgsexWsCl2IaML7eAS7GeS8FjXi3gUmxDr8kBl2IdXYKS3xYwKTl96CYHTEq+oE9KAx4lX5AhQjngUXLPo+ABujngUfIFGSOUAx4lX5AxQjlgUfIFOdpywKLkC3K05YBDyRfkSi4HHErueJIMDxHOAYmSZ6R9zAGFkmdkkHIOCJTcEyhlhZ6YBwRKTp+6yQF9knv6BA8nzgF9knv6BI8nzgF9kmd0qwHyJM/IA9U5oE5yT51UqMXJAXWS0xd55IA4yemrPHJAm+R0uEkOSJOcvs4jB5RJ7ikTPKY6B6RJbujQ8hxwJvlwrYfBFgI5IE1yH2+C3gGSA9Ykp8NNcsCa5IYO7coBbZJ72oTCC5qNDjjJAW2S07RJDmiT3NLNBmiT3AebVBabx+aAOMktbR4BbZJb8ux1DmiT3JJEVw5Ik9zSAw2QJrn1Aw2/0wLQJrmlBxq8+MPTJnjUfA7v/sjpoQZv/8jJ7e8c3v9Bx5rkkwtAXIvhcfs5vASEjjXJ4S0gObn9ncN7QHLapcGbQHKS6MrhXSA5SXTlgCrJPVWCn0fIAVWSF+RCOwdESV7QF7YAmiQvyIVaDkiSvKDvbAEUSe4pEvzwRA4okrygL24BBEnuCZIKvdUiBwRJXpCx5TmgR/KC3PHOATmSl+SOdw6okdxTIzVKwOeAHMlLcnGdA2ok99eFoF0cECO5J0bqDK0wQIzkJXlUKge0SF7SUxBAiuQlbRkBJZL7a0NqdGmSA1Ikp8/c5IASyT0lUqPr+xxQIrmnRGrcPANKJPeUSI3bXECK5D7KBD/CkANaJPdRJvgZhhwQI7mPMqnRe2FyQI3kFT3eADGSV+T2TQ5okbyiRxsgRfKKtpCAEsk9JVLj82JAiuQ1bSEBKZLX5MWJOSBF8pqe8gNSJPekSIMPeECK5DU9DwGkSF6TC+sckCK5Yz6yBp/sAlokp68ayQEpktfkwjoHpEje0DNHQInk9NmbHBAiOX32Jgd0SO7pkAY3I4AOyenDNzkgQ/KGto+ACskb2j4CKiRvaPsIiJDcEyENbscAFZI3tH0EVEixYK4lA/eSLch5YwGokIKmQgpAhRSeCsHP0xSACiloKqQAVEixoK8qBVRIQVMhBaBCigV9SxmgQgofToKfkSkAGVIs6KvKABVSOL4Dj6guABdSeC4EjXsuABlS0BeQFIAKKWgqpABUSOHYDjzuuQBMSEGfvCkAD1L4MBL8UFEBmJDCh5Hgy8kCcCFFxgy0AnAhhedCcOdbADak8GEkOMtSAD6k8GEk+O5BARiRwoeR4MemCsCJFHQYSQEYkcKHkRAVByiRwlMiRMUBSqTwlAhRcYATKTwnQlUcaD9TcxUH2o+++LQApEhhaUMJSJHC0jc4AlKk8GdwGrweAC1SWOYaR9By9AmcApAihaUNJSBFCktORgpAihT+NhL8bFwBaJHCkpORApAihb8NFT/wVgBapMjpNgOkSEGTIgUgRYqcdm6AFCn8raj4ibsC0CJFTjs3QIoU/mpUohYALVL4OBKc5S4AMVLk5LS/AMRIkZPT/gIQIwVNjBTwmtTCuzd0BlfAq1JpYqSAl6X6AzhElcH7Un0ECVFl8M7Ugh5rk1tT6bEG700t6LEGb0517IfBj1QW8PZUf33qIkfNNLxAtfCjDb3fuwD0SFGSezQFoEcK+kqSApAjRUkSWgUgRwr6BE4ByJHCX6aKn30sADlS0CdwCkCOFPQJnAKQI0VZMR0S0CNFSZKQBSBHCvpe1QKQI0VFEloFoEYKf/oGP/9ZAGqkoKNFCkCMFBVJaBWAFimqnKkwQIsU9DWrBSBFioq+ohiQIkXFXFIMWqzy4wzlQQtAixT0jSQFoEUKx3zgFQZIkaLOmAoDtEjhaZEFGu1UAGKkqEnquADESFGTMT4FoEWKmp7/A1qkcNyHwY+rFoAYKWpyT60AtEjhaRE8WrYAxEjh2A9qxguokcLxHyZDL88oADlS0ORIAciRgr6NtQDkSEHfx1oAaqRw/IfBT9cWgBwp/M0k+CHUAtAjReNbDl/vA4KkcCyIwd+XKABFUniKBA/lKgBFUvhokazE4uoKQJKUC9KzlYAkKel4kRKQJOWCbLkSkCQlfT1JCSiScuFbDr9RHJAkJX0/SQlIkpImSUpAkpR0vEgJSJKSjhcpAUVSLnyLoQa1BCRJSceLlIAjKel4kRJQJKXjQYhOUwKSpHRMCDHgS0CTlBlpJUvAkpQZ6dlKwJKUGf0OD+BIysyPNHS9VgKOpMzoO94BQ1JmzDgrAUNSDgwJyjeUgCEpDT3SAD9SGnqkAXakNPRIA+xI6QgQgx8GLgE7Uhp6pAFupHT0h8HPDZeAGyn9YzD4ueEScCOlIeOOS8CMlMbfmGDRdgPcSGn9wyOoTS8BO1Jaz0mivGgJ+JGSPmtTAnakdBSIMeiUvgT8SGl92xHvLoC2czSIMbjlARxJaX3r4QMJsCSlI0IM8a4CYElK/2QM/mxBCXiS0vMk+KsAJeBJSponKQFPUuYkt1UCnqTM/ZUX6LSgBExJmZPcVgl4kjInHykpAU9SOioEP+tcApqk9NEj+FnREtAkZe4bDu/EgCgpaaKkBERJmZPRCCUgSsqCXLyVgCYp/b2t+LMGJSBKyoJcvJWAJikL/+gPGtlWApqkLGgXB2iSkn5dpgQ0SUnTJCWgSUpPk+AnYEtAk5QF7eIASVLSF5WU8J0Z5qEZ+NJMSQ80+NZM6QcabnLgezMlPdDggzM+ggQPuSnhmzN0BEk5eXSGnkrCZ2foCJISvjvjeBCDn3kt4dszdARJCUiScoggQeNoSkCTlBU9mQQkSUnfUVICkqSkj9SUgCQpKzJSqwQUSVn597VwfwJIkpKOHCkBSVI6JsTkuOsBNElJx46UgCQp6btJSkCSlPTdJCUgSUpPkuAnTktAkpSeJMlR8rQEJEnpmBDitFAJaJLScSEGP1lYAqKkpA/VlIAoKelDNSWgSUr6UE0JaJKyppdtgCQpffQIfta0BCRJ2dDLNkCRlA39FBegSMqG3NkuAUVS0hRJCSiS0lMk+FHJElAkJf1uTQkIkrIhKeQS0CNlQ7cYIEfKhiSQS0CNlA25WVMCYqRy7IfBj3VWgBqpFuRmTQWokWpBxmhVgBqpHP+B30lbAW6k8txIjjq0CnAjFR1AUgFupKK5kQpwIxUdQFIBbqRyBIjBX8yoADtS0QEkFeBGqowM0qoAN1J5bgR/iKMC7Ejl2RH83GUF2JEqI11aBbiRin7DpgLcSOUIEFOgxrwC7EhFP2JTAXak8uxIgV5yVwF2pMpIl1YBdqTKSJdWAW6kol+xqQAzUhnfaujipALcSEU/Y1MBbqRyBIgpyqd5/awuwPAB7EjlY0dw71cBdqQyvt3Q/dYK8COV50fwk5cV4Ecq+jxNBdiRyl/fSn0eaDl/oIb6PNB2nh8hPg/wI5XnR/CzohXgRyr69dwK8COV5VoP8COV5VoP8COV5VoP8COV50dK3KoBfqSi37SpADtSWa71ADtSWa71ADtS5VzrAX6kyv0thbjFBAxJldOtB/iRKif3SSvAj1Q5M5WsAENS5eRSuwIESZWT+6QVoEeqnPZygByp/Eu7JfpyQwXokYq+i6QC9EhFX+NaAXqkoq9xrQA5UhVk7E8FyJHKkyP4+ekKkCNVQcb+VIAcqQputAF6pPIHbIiODgiSyhMkJbq6qQBBUg3P8Ba4MGi3gmGTK0CSVD6OhMAMaJKqzJjaAERJ5YkS4gMBUVL5ozbEBwKqpPJUCX5NRwWoksrHk1AfCFrQR5RQHwhasORaEBAmVcm1ICBMKseKGPy0dgUf7HWsiMFfdKrgo73Dva64O4cP91a+BXHnCN/u9bEl+OtLFXy/10eX4EeFK/iGb0Uu5yr4im9FLueqyTu+TERQBZ/y9fEllUF7HHzO1/EjBn+tqQLkSeUjTPBDqhWgTyp/8Aa/cqYC9Enl6RP8mGoF6JOq9q2H9zhAn1SePsGPU1aAPqn84zf4EcUKECiVjzTBH0KqAIVSOZ7E1At0sAISpXJMicGJxQrQKJWnUfDzcRWgUSofa4K/GlQBIqVybImpO2tkn3V+GAiDFnR8ianR6OoKkCmVY0xM7aZk1oDOD+iUytMpdYXDAC3oI07wN3YqQKhUnlDBD5JVgFKpfMQJfo6rAqRK5ZgT05MPyBgEtErlI07wo0kVIFZqT6zg79zUgFipHXti8CM0NaBWavq21xpQK7WjTwx+gqUG3EpN3/ZaA2al9lEn+JnMGnArtX8XBz/pUQN2pV741sNf5Qb8Su35laZ+Wi6e5YsGCNdA2Lce2olqwLDUjkaxC7QT1YBjqR2NYvEY8RpwLLWjUSweHV0DjqV2RIrF44JrwLLUGd1+gGWpHZFiF+g1fzVgWWpHpVj8SZIa8Cy1o1IsHpZbA56ldmSKxUNSa8C01I5OsYsas8w14Fpq49sPb2zAttSOULF4KGIN2Jbasy341K8GfEs98C3o1K8GfEvto1HwqV8N+Jba8y341K8GfEvt+RY8YrwGfEvtSBWboU6tBoxL7UgVm6G3ktSAcakdqWIz9KLGGjAutb/5Fb9DqwaMS219C+L2EzAutaNVLP58RA04l5o+sVMDxqW2ZFRDDfiW2hZMXwZ8S+0oFZuh1/zVgG+pLXn6owZ8S21JlrMGbEttfcvhAxWwLXVO8pw14Frq3LcbOguoAddS01xLDbiWmuZaasC11I5O6doA9SGAa6kdoWIN+o5GDdiW2lEqFo8CqwHfUtPXmdSAb6kdpWLxgLEa8C21I1Us/tBEDRiXmmZcasC41AUZ3FADxqV2tIrFY8tqwLnUBT3eAONSO1rFGnQmWwPOpS58y6E3ktaAc6kL33LdTLZrZmuBMGg5R6tYPLasBpxLXfi2w/0S4FxqR6tYiz62UwPOpXa0irW42QacS+1oFYvHltWAc6kdrWLx+3VrwLnUjlaxFt1nqQHnUnvOBV8u14BzqR2tYvF7w2vAudSOVrH41ag14FxqR6tYW2Er4BpwLnVZM30DcC516VuwRh0v4FzqijlfUAPOpfacCx6VWwPOpR44F5ShrQHnUle+BfEuCjiXuiJZzxowLnVF3mxYA8alrkqmxwHOpXa0is3xUQI4l9rRKlT3BJxL7c/0EN0TcC51vWC6J+Bc6jpjuifgXOraMN0TcC61o1Wo7gk4l9rRKlT3BJxL7TkXonsCzqUeTvfg3RNwLrXnXIjuCTiX2tEqFo95qgHnUjtaxeb49BRwLrWjVSweR1QDzqV2tIrNcacGOJfa0So2x2ecgHOpHa1i8XCbGnAutaNVLB7CUgPOpXa0isVjPWrAudSOVrH4ddg14FxqR6tYPNChBpxL7WgVi4ck1IBzqR2tYvGQhBpwLo2jVYgZQQM4l2aR0Z2/AZxLszBcyQYIW9oVN4B1aWjWpQGsS7Mo6PlAA1iXhn5jpwGcS7OoaHPbAM6lod/YaQDj0izI2IgG8C0NHdHSALalyciZZwO4lsZzLQV6GqUBXEvjuRbcVjSAa2lorqUBXEvjuZYCtRQN4Foaz7XggR8N4Foaz7Xg13g3gGtpPNeC36LdAK6l8VwLHqDRAK6lMeSrVg1gWhrPtBRo+FYDmJbGkSm2RBdbDWBaGkemdGaiKCasTAOIlsbQjQdolsYxKbbEhzKgWRpDDzlAsjSeZCnxzgZIloY+9NMAiqXxFAu+Zd0AiqWxdMMBgqWxXMMBgqXxBAt+P3gDCJaGJlgaQLA0NMHSAIKl8QQLPg1qAMHSeIKlRA+ZNIBgaegHdhpAsDSeYMH7JGBYGs+wEB0NMCyNo1Go3gM4loZ+mLgBDEtD34vSAIalcTSKxXeTG8CxNPS9KA1gWJqcazjAsDSeYSnR0ysNYFia3A+5+mlRdv4eCoOm8zEt+MZXAziWxnMsJT44AMfSOCKlc0l58yyzoDIAydI4JsXi298NoFka+tRPA0iWpiDpsQaQLI0nWfBN9QaQLE3BNR4gWRpPsvTb38j8C5AsjSdZ8O3vBpAsjSdZKpTubgDJ0niSpUKJ9AaQLI3jUYgRDTiWpmR2ZRvAsTQ+roXob4BjaTzHUpUYe9wAjqUpfQNW6PcBjqUp/a4suoXbAI6l8RxLhU+gAcfSOBqF6PaAYmk8xVI1TwvzrM5hNYP28xQLfk9vAyiWxrEotsZ7M6BYGseiWHzDvgEUS1P5BQI+WQEUS+MpFsIUAYqlqejZCqBYGk+xEL0IkCxNRc9WAMXSeIqFMHCAYmkqerYCCJbGcShEpwD8SlPTkxXArjSeXcGDJxrArjSeXcFvDG4Au9J4doWwLIBdaWq64QC30jj6hBrRgFtparrhALPS1BUzkgCz0tR0wwFepRliWXDbBniVpqFbDrAqzRDJgndgwKo09GvFDeBUmiGOBbdrgFNp6NeKG8CoNP5SWdwfAEKloR8rbgCd0jSMsQRsSkO/VdwALqVpOFcHuJRsQT9WPKQFwhntZYbUQJxsuiEtELa0nxlSA3Gy+Ya0QNgNPPwK8CE1EHcuD78EfEgNxN3ww68BH1IDcef38JioITUQ954PZeiG1LE4faHKkBYIu/Zs0DC4ITUQd0a0D6NCxWGLeqoFD6QaUgNxcvkwpAXCrkUbi93/NKQG4q5FG3RDYEgNxCtq5jykBcKuPXECY0gNxBt6CjGkjsUNSZkNaYGwb0+UvxxSA3HyvOWQFgiTJy6HtEDYTUfxYLAhNRD3rUmMIANbk2ZghrRA2I3O/ubW6axmSA3EXWs2Dd7HDWxNR7bkC5SsHVLH4j7chWh7C5vTP9qDR5wNqYE4uTQc0gJhcnE4pAXCfg8eXfENqYG4p9NQpmVIDcTJ8ypDWiBc0XOHITUQd8dpFyiHMqQG4r450YjHIXUsntMLxSExkM5Ifz8kBtLM4Mxha9KP+gxpgbC7B3WBzoWH1EDcnTzCAwOH1EDcnbHFQwOH1ECcPDk2pAXCNeevctianrGh/FUOW9PHxeBxikNqIO5msXhg/5AaiBvODhWwRX2EDGEpCtiknr+hrFYBm9Tf20JZrQI2qedw8K3pITUQZ4doARu1IKe2Q1og3HDjuYBNWjKz2xI2qL/slhr8JWzQkpndlrA5S3rjYkgMpJnJbQkb01/oQpiVErZlyfjOErako2xy/G7UITUQJzcNh7RAmHytZEgbC3tGBw/fG1ID8YzrsBVsSc/q4OvyITUQd0fi+xtYsbFZwcas/Nh8mpdI01ewNf19uP3AxzphBZvTcTh5H66BisMG9Y8FZSgbO6QG4s57ZsSIqGCT+otfMpQ3GVLH4o7QyTN0oTqkBuJueGaEY6lho9bMbKiGTeoZH6p/1bBJh4gaon/VsE39M0JZhc+Hatimdcl0mBo2ae2blBijNWxS+j2hIS0QZsZoDZvTB9ZQldLA5vRX53ZVjq5VGtic9PW5Q1ogTF5aMaQFwuS1FUNaIOyaEr9LckgNxMmrK4a0QJhZdTawHX14DdVjG9iSnhQiGwe0ZeZfGyIaJ4O8UOZ5IWI1nkFeKKMv1B3SAmG6LTPICmULui0zyAplC9+W+PIqg6xQtqDbMoOcULZggk2H1EC8Zuu7huLkTXZD2lg4I8O9h7RAmAy7GdICYbdEwUPUh9RAnIwBGNICYb/kxCfAGeSDsoy8BGhIC4TJa4CGtECYvCJhSAuEXTvicfhDaiDekJOxDDJBmT/sRMzxM8gFZf7aXTwef0gNxH1b4qu8DLJBGf040ZAWCJMRHUNaIOzJA6LhIReUmZLrJ5ANygwZ1zGkBcJ+uYnTaRnkgjIflUOQjBnkgjL6oaIhLRBmxiUkgjLr2xKfKWWQCsro2JwhLRAmbwcd0gJh8tKSIS0QJm8IHdICYTfrwe8FHlIDcXrWk0ESKPNBOng84ZA6Fs9phjaDHFBGh+kMaYEwGagzpAXCzk/iB1SG1ECcZtszSAFlPlyHqhFIAWX0BTRDWiDsWxLf38ggBZT5V57xm5iH1EDcLUnwu5iH1LE4fTRqSAuEmTEJ6Z/METw5fhZnSA3EmTEJ2Z/Msz9U80D2J6MfNxrSAmHGV0LmJysYXwl5n6zwLUn4Ssj8ZAV5pdCQNhYuycdXhrRA2I1J/ELpITUQZ2avkPfJSmb2CmmfrGRmr5D2yRyzk+M3Ww+pgTgze4W8T1bSK5EMsj5Zya1EMsj7ZCVrXSHzk3nmh1paQOYnq8grooa0QJim2DPI+mQVTbFnkPPJHK2T4xd5D6mBuG9LwptB0iejY3qGtEDY2VeL884ZpHwyT/lYYiUCKZ/MX1iDX7g4pI7F6fCeIS0QduMSvyh6SA3EXWviR4aG1EDcjUz8IMCQGoi7FsWPDQ2pgTh58dCQFgiTVw8NaYGwa0/8SNKQGojX7GfC9qyZlSVkfLKG8ZaQ78kaxltCtifzNwHjR6mG1ECc8ZaQ78kabjMzg4xP5o9T4dHHQ2og7oOV0aC/ITUQ5/ZKMsj6ZI7XIbj+DJI+maN1cvyM2ZA6Ejee9MFPmQ2pgXhGjmUDKR+z8A2KR/cYSPoYT/rkDSFuobgbnPjBtCE1EPfhBvhK2kDix/hbg/GTbENqIE7vaBpI/Bh/tw069A2kfYwPBSJ6roHEj/HED36obkgNxB2JR+zaG0j+mIyeBhlI/ZiM2f4ykPsx/i1qYlAYyP0Y/9BSNyqwEWog+2M8+0Ns8xnI/xjH8eQFeonOkBqIO3tboAeEh9RA3A3RoiTAwCY19LGCITGQphebBhJAxtCLTQPpH+Monhw/ZjakBuJ+fOJrUwMpIGN8g6KByENqIO4aFL+pdkgNxF2D4je/DqmBuGvQ/hQOMsMxkAQyhl6mGEgBGYYCMpACMpae2hpIARnLtCYkgIwjefKSGBGQAjI+GohwcQaSQMYRPYSfgCSQ8bcOU0Mf0kDGET1U2bAlLeM8DWSBjKW5WQM5IOMfZsLPwg2pgbgbmCU+vTGQBzI+FAg/hTWkBuL0bMhAHsj4i3GIkBoDmSDjmSAipMZAJsj4YCD8gtEhNRD3Q7PrWfWzejLWIBdkcvrk3ZAYSDMNCokg41+3pvohpIJMwcyFIBVkPBVE+StIBRlH91Blw+b0b1xTzg1SQaZgxiakgoyngihPCMkgUzBjE5JBpmDdJiSDTMG0JSSDjH/MifKxkA4yJdOWkAwyngwibApkg0zJNCVkg4xjfHL8Ct0hNRCnV5wGskGGfv56SAuE2VEJ+SDjn8Cu0CvdhtRA3O+a4ASPgXyQqWi23UA2yFTMBAiyQaZiXCZkg4yPAcIPTA6pgTjNthvIBhnPBlH1Ddkg40OAqPqGfJCp6B0wA9kgU5Gv0QxpgTD5Hs2QNhb2wT8VsTiBXJDxXBBVJ5ALMp4LomY0kAsyngvq3zNFKEwDuSDjuSBqSgi5IOPDfyrCbkI2yPiXoPDLl4fUQJxZbkI2yNTMchNyQcbxPXSdwxb1bBBV55APMj7+h6pzyAgZzwhRdQ4ZIeMjgKg6h5yQ8ZwQZYQgJ2QaegfFQEbINL49idkbZIRMQ17tOKQFwuT7XkNaIOzaE797e0gdiVt/zQ6xEW8hHWQX3Ai1kBCyC+Yk7ZAaiPv2xFeQFhJCdkHbWwvpILsgrywb0gLhkv3MEopXTMeykA6y/mwYEUJgISFkPSFENhFsUX/dMVXnkBCyGb3gtJAOssPZMDxWwkJCyNLPSg1pgTC9L2YhG2Q9G4TfAz+kBuL0vpiFXJBlzoVZyARZzwRRPQUyQdYzQYT5tJAJsobbF7OQCrKGaUtIBVkfC4Qfth9SA3GmLSEVZA3TlpAIsp4Iwg/yD6mBONOWkAayhmlLSAJZw7YlJIGsPxVGTMkspIGsZdsSEkGWIYIsJIKspfc4LSSCrKX3OC2kgawjenL84oQhNRB36xP8msUhNRB3drZGbysbUgNx5zVr3N9bSAVZy+1ZW8gFWc8F4fsFFpJB1pNBxGljC8kgm5PPLQ5pgTD54OKQFghbrsohFWT9uTCqyiEVZP25MKrKIRVk/S0+VJVDKsg6soeqcsgEWfrl7iEtEHajkzjebSEVZH1MEHG820IqyDq6J6/xnS4LySBbMOMTUkG2YMYnpIKsp4KIg+MWUkHWnwnDH9QYUgNxOgbBQirIOrqH7IiQDLIFdwbXQjLI+jNhDeElIB1kPR1EHEu3kA6yDB1kIR1kHeNDnNqzkA6yPjiowYlACwkh6wmhhhhwkBCyPkAIfxVkSA3EGecJKSHLBAhZSAhZ7i7lITUQ981JDE9ICNlqwVUipIRsxe1yWkgKWfrx7yEtEGZ2OS3khGzF7XJayApZzwo1eByChayQdbxPgy+XLSSFrA8SIg6nWkgLWU8LNfgGnYXEkPUXABHHTS2khmxN74pZSAzZmg4rsZAWso74KYgD9RbSQramN1IsJIVsTQe5W0gJWUf6UN4NMkLWcT7408lDYiBNE3wWEkK2pgk+CwkhW9MEn4V0kHWET4G/gDOkBuIZZ/MhHWQ9HUScwbSQDrINc5raQjbIOr6nwN/jGVIDcccGEefpLeSDrOeDKDMO+SDrbwkijt9byAhZx/qQXwpbtPEjk7C1kBLKF75NK+wK7yE1EKdntjkkhPIFPRHKIR2UO8IH7+M5JINy5lBYDsmgfMGMzByyQbnjewiLn0MyKF/QO2I5pILyBXM35ZAaiNM7YjkkgnIfGUT4khwSQXlGT4FySATljuohHE8OeaA8o3fEcsgD5VnOeKkcMkF5Rm9u5pAHyn1UEOHScsgE5RnTlJAJyv1D44T/yyETlDOnwnLIA+U+Iog4op9DHig3zJCEPFBu6MVmDlmg3DE91MCBNFBucs6SQCIoN97EEq0DiaDckT1FRlQ4pIJyfygsw6cFOSSD8uFYGE7X5JAM+v/5upscXXYdO6Bzee2Li08S/+QZeAwFozr1Gu4YhmEYNgzP3Zki8yC1nzY7VYkSb1aeYIQiYoVIyeRLagUpSJoVQYIQJE1RmCAEycEeHe/7sSAFyeEeeggRgyTLwsb7limIQbL4x2pBCpJs3EyWqAhSkKwk9/cSFUEKklwV9N5UrEavcL6+S1CC5FgPuyYQgiT7A713LKvRK3x2pyFikEhzy0QKEsl0vp8LBClI+ObkNXYF8zo/QQaS3DDrvSVZjV7hvM5P0IFEmq0Ga/R3uH660xAdSLKrMzsN0YFE8/Ik8zhKkDT1YYISJMpfTQQdSJrqMEEFEs2J9l0tIuhAkv2d350tBBlIlL+bCCKQKH83ESQgqQbPb+sSJCCx5qaJBCS5ImiO950NDUiqMRCZltGA5CiPkgJzQQOS3E2LnbNoQJK9ntk5iwok2e2ZlJgLOpBYLtcj8xs6kNSuWs/dk2r0d7i3lyc6kHjzTIsKJN41vhR0IPHmoRYZSDwzSqZaZCDhO5rX2BXcXp6oQOLd5YkIJM3aIEECEm8eghCAJOjWkjV2BZ+7JqkEFyQgadoCCQKQxOquZSQgSQIS8pSKCCTRXpyoQBLtxYkMJMlApB5cEIIk8uJ8fy0QpCCJ5h0FKUh20/VSUIKklSBBCZJsDEQKwgUlSJpSMUEIkt3cOJGBZDfbItToFd5sR1KjVzhXPUEEkt3aASqQpAK9d7Kq0V/hmgq03iWFigqkn7xAn0aiyED6aRbUKjqQNs2BFB1IGwdSdCDNGjHyuVIRgvTT1S0oSpA2EqQoQfqJJj2KEqSNBClKkI42lyhB2kiQogRpVoiRxKMEaSNBihKkx3rYWYIQpA0EKUKQHupR0pZAEYJ0dJ82FSlIk4LeO1PW6BXeLDxQtCCdXZdERQvSXBO03ku2FDVIj/iQrxCKHKS5UxepgFf0IJ18wZ6iBunkC/YULUhzURBLEFqQpgWxBKEFaW7aRRKEFKS1NTpLEOZzfboEIQfpIR+WIPQgXR0fKHqQLs4HihqkuTToPS2jBenxHjItowVp9oomnRIULUgXXxytKEHaLgpSlCBdu80OJrNpE6RIQdq0CVKEIG3aBCkykCYDrfdjoSIEaUIQgVdFCFLJXrTvp0hFClLhaw4UKUhzZy/yuKxIQVq9ot+Py4oYpId7lDSbUMQgVb7NgiIF6cEeJZ0pFClIq1P08zVMUYJUm0cglCBV3r1LUYI0JYi0jlC0IE0LkvdCDEUL0sM9X2cQCcd0HvD5OoNIOKaz4SBFDtLkINInQZGDtOEgRQ5S65KJGqS55xdZ0K2oQWpdk0RFDVLjTKtoQWq8iZeiBKnxxk+KDqTpQKTPhKIDqXFxV1QgzfIwIh6KCqTZLui7LcXrnokOpLka6L1bco1e4fxdU9GBNB2I9LBQdCDN5UCkfEZRgjQliPSwUJQgdV6EoghB6nzxpSIEaUIQaUqhSEHaUJAiBWlSkJJHd6QgzdVA7y17a/QKPztmfN7drRUxSCPzSSYsxCCNrieJIgZpZD7JlIUYpE2RmCIFabMmSBGCtGkYpAhBuptsogPpzmySaQIdSNOBSI8JRQfSYz1ftwISjtnMJUGkx4SiBWkuCfre5/U1DaEFabaJ/joT9fO4S6AFaVqQkWsINUizadB7t+AavcJPRkkvA0UNsg9/EjK0IKtG0c+7oaEF2eGe8fUA8npFMcQgazDIEIPsw5+EDDHIPvwVxZCCLNcEkeYOhhRkWSE23rpjiEGWFWLj/VBmiEGWnaLJiWjIQZa7h5ET0ZCDLCvEyBxnCEJWNWLvOc5QhCybBpG2F4YmZM3+YYYkZIM/ChmSkA3+KGQIQtb0izbkIEsOIv0xDDnIRlcrb+hBxrdsr7Er+OTS3vOnoQbZ5N9RDDHIJt9sypCCbDb7ZRhakM0mkWhBNptEogTZbBKJDmQzE/m+nRhCkDVdggwZyJKB/P3ia8hAluVhpDWBoQPZal5QDBnIVjPHIgNZ0yvakIGsYSBDBrJkINI9wJCBrGEgQwayXBBE3mMNGchyyzByRDCVDQIZIpDleiDy/m3IQCb5cvJ+oTaEIEsIIi/UhhBkwj+eGDKQJQO99/Gu0SucM5AhA9mBninvx3BDBrKmMswQgUyaXCIBmfKHWUMCsiQgfz9UGRKQ8V3ea+wKXs0VjARkym3WkICsWQxkCECmfGGXIf9Y8g/pcmHIP6Z8YZch/lhu9s4OCObR+JJLQ/sx47W3hvZjxmHWkH4sFwKRNhGG9GO5EIg0czCkH8tNwkj/BEP8scQfUkRvyD9mzfyK/GPGe5AY4o8Zf700xB/zJpNIP+Z88awh/FjCD/kqZAg/1sCPIfyYNxckso95c0Ei+pg3FySSj2VfIFL0b4g+5s0FiehjzveRMiQfi+xS8V5HYYg+ltvA+3tLM0P0seAFfYbkY7n+h/QfMCQfS/IhFfGG5GMHdfS9gX2NXuHnmnxvYV+jVzgnPEPyseB9ZAzJxyIX5pGLAdHHsi8Q2f3MkH1s8yUGhuhjiT6k1N4QfaxZ/GNIPtYs/jEEHzukQ6kCwcdy8Q/ZcdAQfCzBh1SsG4KPHdJhxXGG4GO7u12i93htDfbeoNBRfDzbApENCh3Jx7MKjGxQ6Eg+nuRDNih0RB/PPtFkg0JH9vHcIIxsUOgIP57wQxoFOMKPN32iHdnHD+yw88uRffyzm2vOkX08GwO9zwBH9fFUH7KBvaP6+ODPso7m44NLgaP4eNaDkfPc0Xx8dAv0HNXHU31I/wRH9/FjO0r6JzjKj6f8kKYFjvLjx3aUNC1wlB+f7UWK9uO5bzyZjhztx7M/ELumUX88+wOxaxr9x2d7kSIA+WwvUiQgz2bRbMZABPJcDrTf92hHBvLJn4ocEchn187dkYF8dfdRRwbyZKD9flxwZCBvNo93VCBPBWIXHjqQr0b0HCHIc9Mwdu4iBfnqbqWOFOTZKIidu4hBnvvHs3MXMcgTg9jZhRzk2SmIneoIQp6rgtipjiDkCUKkAYgjCHnTNtqRg1y6lKIHedaHsVMXPchz/zDSAcRRhDwXBpFFE44i5NL18nI0Ic+FQaRS1VGFPLsFkY0uHF3Is1sQ2ejC0YVcu7YHjjLkB390kycSpCFX/gXFkYZc+SJMRxry3EGepQhxyLXrOOyIQ55rg1iKkIc8+wXRFGFG04dYilCIvHaRJylCI/JmNzFHI/JmNzFHIfJmNzFHH/L0oU2e6dCHPAvFyCZejj7kx4DYOiVHIfJcILT3+2EXjciPA9mHPHmhErnzD9aOSuRHgshZjkrkWSbGjgoqkR8JokcFnchzgRA7KihF3kiRoxS5813+HKXInX8Yc3QiPxZkpOWOoxR59pAmXWMcrcijySVKkUeTS3QijzaXKEUefHm0oxN5cPFzVCIP/l3M0Yj8KJCR9v+ORuTNsiBHI/Kmd7SjEXm2CiI9cRyNyHNhEGly42hEnnuJkbY1jkrkx4HsQ26DqER+JMg+7zYjjk7kuX/8h7wnohT5sSAbZLZCKfJjQUZ6UzhKkR8LMtLlwVGKPPtHk7YNjlLkm3+2doSi+HyaczEQiuLDv6wEMlE0zYICkSg+vGtiIBFFFomN91fUQCKKXBlEHskDiSg+vGtiIBDFJ3P5PssDiSg+/N0zEIjiEBD/Z2IuB/9uHehDMXjxQqAOxeDfyAJ1KI4A2Xj3LQr0oWhWBAXqUDQrggJtKJoVQYEyFM2KoEAXipFX5HvyCXShGPyKDFShmPz7WKAJRdMxOlCEotk8LNCDYmYW3xNmoAdFdowmzRoCPSgmL5AP1KBIDSIP64EaFLkkaL7xIFCD4oiPkd4OgR4UR3yM9HYI9KA44mOk+0KgB0U2CyLdFwI9KHIDMdKWIFCEIjtHkyr8QBGK1VyZCEKRK4NIJXsgCEXuI08q2QNBKBYvrA7koDjgY6TYPJCDolkbFIhBIXw9SSAFxcEeI/uaB1JQCNe9QAiKgz1GaoIDKSiEfycLlKCo/cOebhQIQZGtgta7I3UgBEUuDSJF2IEQFJJV8vKXrr+n/cshx2Qe6pnhJBzTqc1WjYEOFNktyL9e7ubfX8cBwzGfR3pskds3OlBk3+j1XusV6EBxrMe+O688wzGnR3uM1GQGWlDkMiGyIXWgBUXuKb/eFYiBFhRHe0zefcsCLSiyTkzeq68DLSiO9hhZkhdoQXG0x8hSwkALilwvRFbwBWpQHPExsoIv0IMiPYhUuQWKUDT7iQV6UDT7iQVqUGSxGP27MaMW3QmAGhSpQez0Qg0K/3TnC3pQ5Kohdr6gCEXuKcbOFxShyD3m2fmCIhQu3fmCIhSNCAWKUOTaIVKkF2hCkSYk5B6NKhRN76BAE4pmX7FAEYosGCMleoEmFMFrOQNNKNKEvp6JXs4caEJx3MdIRV+gCkXw1dKBKhTRvK2gCkXwdWCBJhTHfYxUCgaqUETz1okqFLlyiB5AzGWqEKkVDFSh2M0bC5pQ7EYQUIRiN4KAHhTpQaQKMdCDYjfzLGpQpAaRksVADYqmaVCgBcVurkmUoNjNNYkStFOC9P3qsVGCdtM2eqME7UaCNkrQbtpGb5Sg3bQL2uhAOx2I1GNudKD94SveNzrQTgcihZAbHWh/+Ir3jQ60P/wNZaMC7cHfUDYq0D7SY/q+D290oN2sEtroQLvZPWyjAu3B59WNCrQH1/aNCrRHXo3ve81GB9qDa/tGB9rpQPZ+LtnoQHuk571lbKME7dnZ7EYL2sd7zN5PPRs1aKcGkfrUjR6004NIfepGD9rpQaQ+daMH7WM+izzgbRShfczHSPXmRhHaKUKkRnGjCO0UIVLvt1GEdooQqcnbKEJ78a9hGz1oL/41bKMG7dQgUt62UYP2ajZC2YhB+4CP+fs5aSMH7eQgUt+2kYN2chApFdvIQfuQj5HSpY0gtBOESF3PRhDaB32MVL1sJKGdJERqQjai0E4UIjUhG1FoZ98gUhOykYV2shCpCdnIQjsLxkg9wUYY2sIfgza60Jaup9dGF9pHfizenbE2utCWbr+ijS60hRc3bFShrfxDykYU2so/pGwkoa2c4DeC0E4QIpUKG0FoNwuDNnLQTg4iXzA2ctBODmLPCchBOzmIFE1s5KDd1I1txKCtTSaRgnZSENn+biMF7aSgeKPHRgraSUHxJriNFLStebBFCNrGlx9sZKBtzQMRMtA+1GNkBfxGCNrW9U7cCEE79xEj/do3QtA+1DPpb8d8JgR979v3WPCxEYJ2QhCbUxCCdi4NYnMKQtBOCCJrzzdC0G62l9/IQNv5wr2NDLQP9NCDiAy0k4HIIviNDLRzcRA95pjRhCB6zDGjbSHZRgrawflgIwXtaF47EYJ2cD7YyED7UI9t8qyNELRzeRDZb2cjBe3gCxA2UtBOCiKL3zdS0G4oaCMF7VwgRP+ZmMvd3DcRgvZu7psIQXs3902EoJ0QxN7KkIL2bq5LhKC9OelthKC9+QKEjQy0N1+AsJGBdi4JInUDGyFoN0uCNkDQ1zRy5tj3JuE1eoXTK7LGrmB6RdbYFUyvyBq7gvOKfD6F1+gVTp9ka+wKNj6l1egV7nxKq9ErnFJQjV3BlIJq7Hcwp6Aau4LPvfK9DL1Gr/Bzr3wvFq/RK/xg0HuxeI1e4c3OUzV6hef8+nw8rdEr/ORzP2/cNXqFUxKqsSuYLsCssSt4twcR85lLg9hBnJjRXBzEDuLEjCYIsYM4MaOTPs3W2BVMn2Zr7AqmT7M1dgV/Z8vf68pr9Apvcjkxl7PJ5cRcHujx9xrqGv0dnoVi69kDs0av8HF++/NdsEav8HnCnw8FNXqFN7lcmMuUoPdqyhq9wukds8auYPoRrMauYD//yOdNsEavcPrkU2NXcGaT3AQXZlPae6ZgNiWzae9DKJhNyWySqVkwm9Isja7RK1zOb38KU41e4XrCyeQpmNHjPP5dKPiahARzKnTPhRq7gpvrUzCjR3n4H4IZVdqWrcau4MO035fEv74i1egVPpvfjdk8zuODPHwoZvNID/vdmMvjPP5dOPk6Joq55NvJ19gVfK7O7yrL59+NuTzOw3435lIzl0J+N+bSmlwa5vIoj4/nli81eoU3uTTMpWUuyUOqYS6NvpnU2BWs3fltmEvL65LMKYbZzL3k2RlumM3jPPSkNcyn7e48NMzncR56ajlm1Ed3tjhm9DgPPQEcc+qZUzJ9OuaUK1CNXcFUgWrsCm5nWseMeptRx4x6m1HHjHqbUceMRpvRwIxGm9HAjEab0cCMpgSxm3lgRkO6m3lgToPuc1NjV3DmlNxsA3N6tMffq/Br9Ao/OZ3kkTUwp8d7/L1SvkZ/hx/x8fdK+Rq9wk9O3yvla/QKp0sRauwKXt2lsTGj2VSIXRobM7q1uzQ25nRbd2lszOlu76Mbc7qjuzQ25nTv7tJAGxqfzOnz02iNXuF0kVCNXcGTTnYDbWgc/2EX3UAdGsd//F0oUaNXONehgTo0PnRZbY1dwd6ciQNtaOT+8uRMHKhD47ObM3GgD43xac7EgUI0xmjOxIFCNMZszsSBQjTGas7EgUI0Rmb0/fwyUIjGaDKKPjSOAPm7lqVGr/Ccdd+T9EAhGkeB6KmLRjSOAvm7mqVGf4cfBfJ3zUmNXuHNFYpCNCZtg1BjVzBd/lVjVzBdxldjV/CZb9f7PjRQiMaky/hq7Ao+uXxvLFejVzi324FCNCa324E+NBa324E6NFKH3pUmNXqF83vnQBsavJl0jV3BdBlfjV3B3PkGytA4+uOL3HnQhkba0LL3bII2NI7/+Ls6pkav8LwmyQSBOjSELvmqsSs4c0lmE7ShkUVj8VwkWKNX+Jll3zto1egV3uQTZWjwDeZr7Arm0jdQhcaRH3/vzVWjVziXvoEuNCQLOp/lojX6O/zYjwuZfFCGRpaMfZO9ff12vDJRhsbRHxcy/aANjbQhopQDbWhkV+n3dkQ1eoWfefZduVKjV3iuQtjvpwn0oXEEiCxaqNEr/FyhQq5/FKKh9Itnjf0OPgZEnuDQh0b6EDvm6EPjGBA95ihEI4WIHXMUonEUiB5zNKJxFIgeczSikQ2E2MmLRjQsr1LykI1GNNKI3sVLNXqFnzn3XbxUo7/D04jeJUY1eoWfrOrn+586cRJAIhpJRO/ymxq9wk9S3yUyNXqFS3fYEYmGc1AYiEQjkehd91KjV/jp8RXP2t4avcKj/csxpYeB2F+OCU0i0mdD4xq9wmmH4hq7gjOfz3V/NXqFr+6fiUA0gpP8QB4ah4D8XaNSo1d4bko13i+ICEQjewl9neb2NQHEwnDMZwKRPlsC1ugVvtvjghndnOUH8tBIHnrvHFajV3jziIs8NJKH2D8TeWgcAPJ3RUmNXuHaHRXkoZE89N7ErEavcP5BeyAOjcShd4lIjV7hzfWJNDSThuy5xq1Gr/CTT3vPLBNxaH5mcxAn8tBMHiKTxUQemslD72qVGr3COSZM5KH5sebkmghEM4HoXdpSo1d4N+NOBKKZQPSuhKnR3+GDv7hM5KGZHae/H6QfzyITeWiONqPIQ3O0GUUemslD7xqeGr3Cm4wiD83BwW8iDs3sK/RegV6jV3i+iLJwzGdWlL0XrNfo7/DEoXepUo1e4QeHyOPiRB6as80oAtE8COTvcqUavcK7p6KJSDQnfyqaSEQzFxG9i5tq9Ar37kxHJJrZb/q9yGuiEs1cR0TkYqITzVxH9G6OVKNXeLayfbZVrdEr/DwYvcu4avQKPyl9l3HV6BXOv4VO1KK5+LfQiVo0U4vIA91ELZpZT/Yu5KjRK7x7LJqoRXM1NQ41+js8+00HSRF60UwvetfC1egVzh+MJmrRFNrov8auYOn+mahFM9cRsYOIXjSPCfGjghlNMXqX/NXoFR7tb8eMCn8wmihGM8XoXU5Yo1f4mXTfX3wmgtHMXtPvjyYTvWgeERrfk8Xzl2NGcy3R+/PQRC6a2Wv6w/5yTKjmnEseRZCLpvLn3IlYNJUvDJtIRTOpiP3ZmM1sNE0OOGLRzF3o2QFHLJq5mIgccLSieTSIHnC0omnccidK0czVRO8q1Rq9wmlr4hq7gmmlQ41dwWeufde/1ugVfu6e7/rXGv0d7ll99Ox1UqNX+Jlr3+WyNXqFn7vne2eqGr3Cz93zXe9Zo1f4ecR9F1nW6BXePOIiE01vHnERieZhIH/veVWjV3g2XHyD+0QkmrmSiD3iIhPNZKL3Lkw1eoVnRsl5jlA0o7l7IhPNaO6eiEQzVxG99+up0Ss8W8E/+4zX6BV+8kkWBkxkohm0JU2NXcHnCo1n668avcL5V9CJRDT5XvQ1dgWfXL7rGmv0Cj+51PeXs4lINA8DkS1Na/QKP/l8bx1Uo1d4c3UiEc3dzLYIRJO3F6qxK5huMVdjV/C5Mt/bHdXor/CVQPQuVKzRKzyz+Z5VFgLROgTk731UavQKP3MtKRdbCEQrgYhMQguBaH34y+dCIFoJRKTwaiEQrU9+N3ufhwuBaGXDaXKWLwSidQiIneULgWjlCqL3jhQ1eoXz1SYLgWgNXiu4kIfW4BUsC3FoDb7aZCENrcM/TorFFuLQOgA0vquoHk61kIfWyFW49gT5hTy0srrM3k+IC3lojd08IS7koZVb0ZNaqoU8tJq1QwtxaE2+um8hDa2DP/QgIg2tKd1BRBpah3/oQUQcWtO6g4g4tCafbxfS0Dr6E6RobKENraM/QarAFtrQWrSVeI1dwYNfFOhC68hPkPqyhS60Ft21qsauYF4ruFCF1qLtMmvsCuZrThaa0DrqE6S6bKEJrawuIycJktDKntPvt8iFIrRy/RB5i1woQuuYDz1hUYSWZC7JnRNNaPEdyGrsCqZtp2vsCtbmECIIrQQhcgjRg5Z4ewgxm1lZRg8hpjO3H3ufWOhBKyvL3vui1OgVTvsk1NgVTPsk1NgVvM4fQh48UINWahApK1zIQeuAT5A6wYUctLK27L3jSo1e4ZyDFnLQUto0s8au4CaXqEHL+PvJQgxah3vivUtMjV7h/F1zoQUt4++aCyVoWbNJVY1e4c0cixK0GglaKEGrkaCFErSO9cR715wavcL5CrCFDrS6vkI1eoVnJslDNTrQOtITg9xK0IEW35i+xq7gc1UOMnujAq1cLET/csym51VJ5iqUoOXNVYkOtDzzSaYfdKDlzXWJCrSO8wQpyluoQCuaORYNaEUzx6IBreM8QQq4FirQCv5FbKEBLd5eusauYNqLpsau4Oa6RP9ZR3iCFJ0t9J8VzXWJ/rOO8bBvSgsFaB3jIc3HavQKT24nEzIK0Np8JfxC/1mba/tC/Vm7vSrRf9ZunmPRf9YxniBVewsFaO1o/xTMZrNEaKEAyTGeIBWBggIkTfWYoP/IEZ7hz60Aa/QKP7l8ryYR5B/55Iew9wQuyD+S/EOq5AQBSD780hTkHznA8z4JBfFHPpzzBOlHDu7EfH8EF6QfadYGCcKPHNyhvxvpRwYvqhekH2noR5B+ZPCXS0H6Ed5nusau4HOrJAVpgvAjTVMhQfaRZJ/1bBxdo1c4v1UKoo/w/cZq7ArmSCBIPjJzen3fhAXRRyZ/7BEkH5l5Rb7vq4LkIwd19HvZy+NtUZB85KBOkJo7QfKRpqmQIPlIkg8p0BMkH0nyIcVuguQjh3VivadvQfQR3l+6xq7gk89FZkFEHzmwE6RiS5B9pGEfQfaRhn0E2UdWZvP9ECsIP7L4w48g+8jKbJKrHt1HFn/4EWQfkcwluX6QfUR4Iz5B9BHhuC5IPiK8EZ8g+chhnSD1a4LoI7yldI1dwU2j0xq9ws91af58HBREHxHOBILkIw35CJKPKGcCQfCRgzpBSvQEyUeUM4Eg+Yiu7gAi+Ui2lGYHEMlHlL+QCIKPaPPUg9wj2lyTyD2SrYRItaAg+EhTKiYIPmLN3RLBR6y5IpF7xPhrpSD3yCGdIFWIguAjTSMhQe4Ra7KI3CPWZBG5RxruEeQeSe4hpZCC3CMN9whyj+Syn+cGhzV4RR8deK/fFcQecV4kL0g94vyVUpB6xPlnS0HokYQeITdrhB5xXiQvyDxyKIcePkzkkZzxda6+tFHQecT5+hBB55GgHYdr7ApuHl5ReeRITpB6U0HnkWgeXlF5hG8iVmNXcHM5ovII30Ssxq7gIwOkXlPQeSSdh9RrCjqPHMsJ9siN0iNZDEbqNQWlR3ZjA+g8wrcRq7EruHmdROWR3VySqDySyvPeaq5Gr/Dz2EqKTAWdR47kzB3PQmNB55F0Hn2Xawk6jxzLmT6fn9gFpUdTesiqE0Xp0aM5oe9VJ4rWo0dzQt8l2IrWo4dzQo2ELww/D7DqJFwwPLP6XqugiD2am8vru++rIvfoIZ347mX+DHcMP1n9LvB7hgeGn2v0vQdUjf4Ob8hHkXx08FdLRfDRBB977qlZo1d4rmN/3pEVzUeP64SRswvVR4/shL372yq6j6b72Ludj6L76OguU0X50dFsp1GjV3gmlJy7aD+aC36MnLuoP3qEJ4ycu+g/mv7jn/eRQf/RYzzh5NxFAdIUIH9PYIoCpFkP5u96U0UB0hQgJ+cMCpAe5QlS46FoQDp5gxJFAdJJN7ypsd/BubsYuY6Qf3SN5jpC/9EjPGu9i2QU/UeP8KzvW8YzHPPZ+I+i/2jjP4r+o82yH0X90Vz2Q8pSFP1Hm6bSivqjR3iCFFUo+o8Kf7hV1B8V/glTUX9U+Lumov6o5HX5ZihF/1Hh75qK+qPCi/oU9Uclr8n3QnNF/VHhC/EU7Ucb+1G0H82WQeQ3YxZzuQ+pGVHUHy39eT82K+qPZitpsihH0X80l/yQihRF/1G+pViNXcH8RUVRf7TRH0X90UZ/FPVHU39IFY2i/mijP4r6o02jIEX90SM8bBsQRf/RYzxsUY6iAKnlI9Bb8hQFSPl2YjV2BTezKwqQWjO7ogDpUZ4gNUuKBqTWzK4oQGrNfRIFSL3ZdqpGr/DRTT1oQNoYkKIBqec1+ZYaRQVSbzKJCqTOv2AqGpDmYp8gDzGoQOqZS3KnRAbSXO5DKq0UGUi9uS6RgfRQz/w6hLr+nob/UIQgzd5AQeZYpCA92DO//qESf6+JxxwpSLPs6+sf+v5jMJ8HfObX/eH5hI8cpFn4tf6S/fdYeGDQgzR3EotN/qWY0hSh/e5OqyhCmiK031VliiKk2R7o6yLS+XfIv4RjUlOE9nz/dhQhPeoTe73/djQhzbU/+92dVlGF9MhPbH36h6IL6bGf2O8mDooypClD28lvx6ymDO33akVFGdJcAfR1Z3n/dszqsZ/9IScBypAe+9mkhEFRhuzYzyYlDIYyZMd+2OuyoQxZydD7DdVQhuzYD1MtQxmykqG3ahnKkJUMvd8hDWXISobeqmUoQ5YyRFTLUIYsZYiolqEMWcoQUS1DGbKR3vd+GTe0IcvlQES1DHXISofeMmCoQ3YAaJPiFEMessEfcg1xyAZ/YTGkISsaIicA0pC1NGRIQ9bSkCENWUtDhjRkLQ0Z0pC1NGRIQ9bSkCENWUtDhjRkLQ0Z0pC1NGRIQ5Y0RHzQkIasaIicBEhDlsuDCCca4pDNnH3fD4+GPGS5PIi8XRr6kKUPkXaBhkBkh4A2qSQyBCJrqsIMecgWryQy5CE7BLQ/ZG5EILLFX0YNgcgWX4BpyEO2+AJMQx6ylbl8PyEb8pBJ3knfLmMIRCb8i5khEJnwak1DIDJZ3dFGILKDQOTrsaEQmWQq9/t6QCMyaVKJQmTSpBKFyKRJJQqRHQXapJrJ0IhM+YcVQyGy3GyMvOwYCpGlEJGXHUMhslwhRF52DIXINN9e3i87hkZk2SOIvOwYKpGlEr1fdgyZyDRfSN8vO4ZQZAlF5GXHEIrsYBB72TGkIjscxF52DLHIsjaMvOwYYpFloyDysmOIRZbLhcjLjiEWmeXby/tlx5CLzPLt5f2yYwhGZvn28n7ZMSQjSzIiLzuGZGS5bIi87BiikVnOueQkQDayA0OblPAZspF5M+ciGpk3cy6ikXnHf4ZoZAeG9phPvzJkI3MOgIZsZM4r/gzRyJxTriEZ2UGhPciDPJKRNWRkSEYWnHINwcgOCdE7HIKRHRKiRxvByHK/MVJ8aAhGFpnLd+2KIRhZNFXVhmBk2U+a1EkbgpElGL07KRh6kQXfLcVQiyzyFvpuuWKoRbb5wkxDK7LNV4IZSpHtzObbOQ2lyI4FbVLWaChFtnlzcEMnsiNBm5Q1GjqRHQnapPjQ0IksnYj8KZjLVKL5eacHlchy/RB7t0Ul8lQiUpnnqER+HGiTGjdHJfLjQJvUoTkqkR8H2qT6y1GJ/MM9wdGI/CgQOy6ORuRHgdg7v6MRea0eer/zOxqR1+qh9zu/oxF5rR56v/M7GpGnEZF3fkcj8jKi93uzoxF5GhEhAkcj8pGi8CYCRyPyXEJEiMBRibxdQuToRD66xSaOTuQjs/omAkcn8pFX6vut3NGJfPC7qKMS+eR3UUcj8tyPnnzhdDQiz3bS5BOdoxF5sx+9oxB5sx+9ow95sx+9ow758Z9Ndhp01CGf3tz7HXXIZzT3fkcd8tSh+a4bdNQhz8VDpNzDUYd85az7vhs56pA3u4452pCv7pnIUYd8dc9Ejj7k6UPsuKAP+TEgflwwp40QOQqRL/5M5ChEvvjCE0cf8vQhUiLp6EPe+JCjD3njQ44+5EeA6IWMPuS555i/jcARiDyXEBGwcAQizxKyeH9lcSQiPwzEwMIRiTyXESmZmpGJPIvI3r7hqER+JGiTqlRHJ/IjQZsUmjo6kR8J2qTQ1NGJ/EjQJhslOjqRNyuJHJXIlX9kcTQiPwxEzy5EIj8MRG9CiESu+TH0zY+OSORN8yBHIvKmlswRiNz4K4sjD7llLskTK/KQW/cZ1JGHPDcdY8+syEOePES+mjrykCcPka+mjjzkyUPkq6kjD3nyEPlq6shDbvkZlDxAIw+552dQ8gCNPOS5qoh8rXYEIs82QuQjqyMRea4rIh9ZHYnIs5EQ+cjqSER+GGiT6m5HJPJsKM1maWQid/4q6shEfiCITunIRN7sOubIRF4ri8j8j1Dkza5jjkzkMbubBTKRZysh8rsxm1liRu4saETe7EnvSER+EGiTcnpHIvKjQAwKHI3IjwPRuQiVyFOJFrlAUYl85y2UPLKiE/nOWyh5hEIp8t191XaUIt9NQtGJfHdFLI5S5LvJKDqR7+6LtqMTeeNEjk7kWWfG3m3RibzpJ+SoRJFVZuRFOFCJ4sMvzkAjijQiUoUfaETx4d+yA4UoUohIRWygEcVRoE3q2QONKJp2QoFCFE07oUAfiqadUKAOxfGfTUrUA3UosraMLDUI1KEY3TL5QB2Kkdl8P60G6lCMJptoQ9G0FAqUoRj8y0qgC8XgS6sDVSiO+2xS8B2oQjGieSoLVKEYXTVvoAvFsZ9NqqcDZSiyk/TXM59+/nVNQKAMxcxsvu9AgTIUTWOhQBmKRoYCZShmk02UoZhNNtGFYmY2318RAl0o0oXIbTDQheLID52A0IUiXej9CSmQhWJ1e94EslCsZs+bQBeK1VlCoAtFupC8y2MCXSjShUgReqALxeJNEwJVKI78vF9qA1UoVptPdKFYbT5RhkK6fCIMhbT5RBoK6fKJNhStDQXaUEibT7ShkOb6RBkKya9l7w+OgTIUzeKhQBeKZvFQoApFLh4ifQICWSiaxUOBKBTKq7IDSSi0E/hAEgrlAh8IQqHNPIsgFMoFPhCEIjtJk1ryQBCKppN0IAdF00k6EIOiwaBADIqmk3QgBsUBn01aQwRyUDSdpAMxKBKDiO4EYlBYs5ov0IKi6S0UKEHR9BYKdKBoegsFKlAc59lkQ/ZABYrsLUQW2wQqUBznYcQYqEDhmcz1frRCBYrjPFvfO8QGKlAc59lKnsRQgcK50wYaUKQBEUwLNKA4ysOPC2b0OA8/LpjTXCxEqC5QgcJzkn1TXaADxZGeTagu0IEieOevQAeK4O1pAhUogvfiC1SgyKVCZC/xQAaK4L34AhkocqUQe+ZABorIbYvIQwcyUEQz0SICRTQTLRJQNFuKBQJQJAAZmWgRgKLZdT6Qf6JpJx3IP3GAh15qyD+xu+3hAgEocqEQu9QQgGJ7d6khAUUuFWKXGhJQZEEZu9QQgfaHd0nYSED7w7+ibCSgnQREuuNsJKDdENBGAtofXs6wEYB2ApC99WIjAO2PNberjQS0D/OwztkbEWh/ui2oNjLQzg3F9MD/11MPhmM2B/8mthGB9uCz7EYC2klA9vaRjQS0B59nNxLQHjnPvm+yGxFo527z7IgjA+3R5hMhaI/uC+dGCNq5PIhc+xshaI/dPH5shKCdEGRvqtkIQbvZUmwjA+3ZtXzfyEB78vl2IwPt2c23GyFoz26+3UhBe3bz7UYM2rObbzdi0J7dfLsRg/bs5tuNGLRXM9+iBe1mU7GNErSzfMze5rWRgvZq8okQtBdfZruRgXYykL1XWW5koJ39pcnvxlwe6tm2ye/GXGZ/afK7MZNZQEZWzmxkoJ39pd+/GxVoH+fZPt6/GxVoC+/gvxGBdhaQfX/ze/5uzKU0uUQC2lk/9j1JPHpcbUSgLU0ukYD2YZ7tpxLLNs5XiEBbmlwiAu1EINJRbCMC7QaBNiLQzpVBpMfVRgbauTKIpR4ZaCvfimojA+1DPdvfK/E2QtBuegxthKB9qIdexghBW9srEylo58ogdrEhBm3d3TmOHLQP+dDTFkFoJwixMxFBaOf6IH8z6kYS2pbX57v7zUYS2kd9dry/+G80oX3cZ8cg4ZjVIz+b9Hfa6ELbONNudKFtzRWKKrSzdIydXqhC25vZFk1opwmxcxFNaHsz26II7RQhduKiCG1vZlsUoZ0ixKYKFKHtzWyLHrTTg9gVhB60vcklatBODWKXG2rQjiaXaEE72msTNWhHk0vUoH3EZ5N+Whs9aDfbi23UoB18FeZGDdq5KIjN46hBO5qrEi1oH++hFxpq0M4lQezaQQ/auSSIXQ4oQnu3z0EoQjuLx9hJiya0s3iMnYeoQjtViJ1aqEI7y8fYtI8qtFOFSGOyjSq0U4VI+7CNKrRThdhNBVVopwqRbmMbVGh9soDs3W2sRq/wk9V4rgur0Sv8ZDWe34lr9Apf/IZYo1e48BtijV7hJ6v7ibw1eoXTj9Y1dgWfnO6nf9boFR784qjRK7x5JqrR3+HHf76umfcfMzCnR4D2fr5k1+gVThW+xq7gxaekGr3ChU9JNXqFN+8sNXqFG5/BavQKb95aavQKPzndz1mgRq9wWj5WY7+Dc++x+ZfG3x9Yg1SDV/T5dv12sBq9wumNtMau4GxW/GzXUKNXOP16XWNXcMMJNXqFW3eyTExn4hDL/sR0zvYSnZjO2V6iExO6mteWGr3Cm0ejGr3Cz7S7n3eYGr3Cz0W6n7eMGr3Cz0W6yS1jYVYTiTa5ZSzM6oGgr/sUCcesLroqocau4OhmuoU5LSYip8DCnGYdGTsFBHPKG1HX2BU8u0tDMKMJRezSEMxorhZiZ6NgRouKyJUkmNFcL8ROXsGM1g70H3KfFkyq0N63NXYF0963NfY7OK3o827ZWMNX/GhmacWU5n5kn3eHxxq+4ptKzxq9wpuZVzGj2s68ihnVduZVzKi2M69iQguMyHWkmFJtr1LFpHZgVKNXeDvzGibVKqnPF80avuJpaUONXcEnpd8LDJ9/Oib1iNDX3/L8BFXDV3x9PiO3DcO0Wl2o5L5hmNdsUv15922r4Su+VhORO4dhZr0uV3LrcExtNh36vJuP1fAVn7l9NzWq4Ss+Ww8NcoE7pjeXFH3ebXxq+IrP/A7yxOmY39y67OuxmMRjfnOT+s+7oUsNX/HNROyY3OxBtJ7fDWv0d3guK2IXeWBqi5LIFBKY2exDxJ4LAhMb9INajV3B0k2tgUkN7abWwJwWJ5HZLDCl0c7EgRlNUGKTX2BOc8f6z7ulTw3/jt95wY5nsUQNX/F1wT6/wNbwFZ8X7HxWdtbwFZ8X7HyWdtbwFZ8X7LudTg1f8XTZWI1dwU0vhRq9wr0/lpjaHf2xxNzu3R9LyO34fLpjORCWRu5h//UC+bxZDZSl8ancvie/gbQ0+KKjGruCK7HPJe41fMVrd/AH0tKohUfvbd5r+Io/yX1XKNfoFR79nxMYv7tzYaAvjfHpzoWBwDTGaM8FFKYxZnsuIDKNwR+iBhLTyC7W5LoaSEwjlyDRUwGNaQz6pabGruD2oh1ITGPQTzU1dgXv9iRDYxqTfqupsSu4Uvqe6gca05h0wWeNXcE1D7/vmQORacy6XN83zYHONGbmdH1eS/dr+IqnjRtr7AqmuynV2BVMy11q7ArOhL4bldTw7/hFlzrU2BVM611q7ArOC/TdA6WGr3j+wDSQl8YBJHIAEZfGqlS+n5kH6tLISrTPu+NHDV/xeYW+2zfU8BWfU++76L+Gr/jKKbmO0JhGVqR93oX5NXzF53X6rsyv4Ss+M/su567hKz4v1XfNdQ1f8cJPeHSmkVvef96l0TV8xZ/C0fVsPlejV3jm9l3sXMNXfOb2XTlcw1d85vZd3FvDv+OLm97lujV8xWdu37WvNXzFN3MwatPgi5Nq7Ao+l+y76LlGr/Ds5TheJew1eoWftH49PTwqsGv0CqefzGvsCqZdxWrsCqZdxWrsd7BVNsmVitA0jK7orbEr+HyDe0vjQGQaB5Lk+yXxdbtDZhrVtoikB5lp8FK1GruCaalajV3BdYGSyQuBaRQwvQtCa/iKzwv0XR5Yw7/jC5jYcwkC0yhgYs8lCEyjgIk9lyAwDadL72vsCs6HpHctXw1f8fxldSAtjaIlJVMp0tIoWqL/Usys0yqnGruCaZVTjf0ODlrlVGNXcCZUyR0AXWlEJvRdVFjDV3zeTZXcAdCWRlROyR0AcWlk3dpHyZyEujSqybWSCxB5aUSm9V1HV8NXfF6w77KxGr7i84J9VxrV8O/4AqZ3QVANX/GZ33ftSw1f8c0dFXVplC69i19q+IrP5L5LQmr4is/kvssCaviK5+tbBvLSOH5EbyGoS2M31yvS0tjN9YquNMuV7H0KT3SlWa5k71N4oivNA0fv+WAiKs1EpY+/z/eJrjR5x+sau4JpT4Yau4LzSvX3lTRRlGaKEruVTSSlWaREbmUTSWkWKZEJfiIpTV7OVmNXMC2WqbErOOdgf88ZEzFp8pZGNXYF83fViZQ0fyiJHHOkpFnlbOyYoybN0d5UJ2rSHPwinahJc/Bn34mUNGdepP6edydq0ixN8veXyomaNGfl9I1yE0FpFij5m8ImgtKc3RPwRE+a5Unv/cpr+IrnM+9ET5qzm3knitKc0R9KzGuhEj2UmNr1aQ8lutJMV2KHEmVpHjoiFxSy0lytE06UpblaJ5yIS3O1TjgRl+biTjhRluaifThq7AqurJK7HrLSXHxx4URTmkILFWvsCh7tMUdQmgVK7JgjKM0CJXbMEZSm8GUuE0FpCm2PU2NXcN1SyZMDctIUvhJtoiXN7H/NrmqkpCn8EWmiI01tX1MnOtLU9jV1oiNNbV9TJ1LSVK6/EylpKgfCiZA0NS/QIM9fKElTm4kXHWkqh/yJjjR5v6Mau4Kbeyk60ixHCvJkh440G0ea6Eizliu9i8Rq+Iqnnatq7AqW9jxESJq1Xomdh2hJs9YrsfMQOWnyCrcau4L5l5mJkDQLkt7lRTX8O975l5mJijRLkd7lJTV8xTe3UCSk6f0tFBVpen8LRUWa3t9CEZIm3yOtxq7g5haKhDRzddLnXXZTw1f8yamO53LLiY40o2nLWqNX+HfW1nh/qpgISbMg6V3VU8NXfPMSg4o0o7mFIiHNaN5K0Y9m0E6eNXYF5+sLKUWaiEcz+HKziXI0o38fRTmafJe0GruCaXuVGruCG2BAM5plRqTeaqIZzd0AA4LRLDCK554NNXzF15Z3z7bdNXzFf2fs3fGuBq/obE7/bHxfo1f4Wcj93ty1Rn+Fr0+2p39uv1qjV/jJ6LMrfA1e0af9I6mJWahGq9SIFIstVKPVqNFCNVq1FIkUfy2Eo5UbpdG/3TDcu3NmoRutciNyzix0o3VgiJwzC9VojU9zzix0o3VsiJ0zC+VoHRqi5wzC0To4xM4ZlKOVy5A++/3IsBCP1tD2j8G0jmYbiRq9wmmn+hq7gqM9jJjSQTvV19jv4END7CCiG61JG9XX2BXcXqVoRmvyRWULwWjVCiRS/LdQjNbkH9cWctE6JPT+FL+Qi9bsL1D0ojX7CxS9aM3uAkUtWqu9QBGL1movUMSitdoLFLlore4CRSxaR4Po6YJWtMqKSM3dQitatRCJFN0t5KJVC5FI1d1CMVolRqTsbqEYrVqIROruFqLRyoVIg1RpLXSjlW40SC3VQjda6UaDVEctdKOVbjRI4c1CN1rHhr7iyRWLdLRyLdIgxTEL9WhJ3lef23nU6BXeTMCIR+vw0PLnNiQ1eoU3EzDi0To6pPMv1cf1jXS0tJmA0Y2Wzu7qRjZa2kzAyEbr0BCdaBCOltJdX2rsCs5U2vOVd6EbLW1SiW60NFPp71SiHC1tUolytKx95kU4WtbkEuFoWd5M4/13oxutpsxtoRst41sy1eAV3aQSyWhZ+7SLYrSsSSWK0crVR4OUwy1Eo2Xc6BeK0cpW2WSF3UIzWgeFyNaQNXqF12RLbi6oRuuwEL3aEI2WS3fhoxktbx91kYxWdssmpwua0TouRM8AVKPllVRyG0U1WqlGg9QgLmSjlWw0SA3iQjdauQJpkBrEhXC0gq9QWahGK/iaz4VqtIL3s6/BK/p8eSFLcxfC0Yr29QXpaGXPbHaCoRyt3DqNnWBoRyv45qM1+Dv66BA9wdCO1vEhW/P5OXWhHq3Uo/X+urvQj9YBIlvvj7sL+WgdIrL1/ra7EJBWAtIgBa4LAWntNqvoR4tvn1ZjV3D7Uop8tPj2aTX2K1haPBLEI+Hbp9XYFTz5ySVIR/Lh91FBN5JP9wYjKEfy4TdSQTaSXG80SK2yoBvJh38cFUQjyc7Zz3lIUIykEyNBMZJR8+37sV+QjGTUfPt+7Bc0IxndM66gGcnobqSCaCRDuhMRzUhyDzVybiEZyeiejQTJSHK10SDV4YJqJCPvpKQ4WJCNJMvXxnjfeQXlSGZl9n3nFbQj4R20a+wKPmnVd9GgoB3JbNOKeiSzez4SxCOZ3fORIB/JbJ6PBP1IZvd8JMhHknw05vv5RZCPZPKHXkE9kuND7NJGPJLCI3LQEY9ktVcq4pGs1R101CNZzTuMIB7J0SF60NGOpOyIGJ+gHcmPHb2NT9COJHtpr+eWhzV6hfN7qaAbSfbSZr8b2UiKjea7x58gG0mxESnJF2QjEf6hVNCMROheFDV2BWtz8iIXSS42GpPcT9GLRLw72VGMRLqnI0ExkuySxE52NCPRBu0FzUiOC9GTHdVItDJK7tjIRqIJgZPcsVGORBMCJ7mPIR1JrjkapPJZUI9EK7PkPoZ8JA0fCfKRaHulIh+J7vZqQkGSXHs0JrmnIiFJrj0ai9wNUJHEeOdBQUOS3G/tveF1jV7hmVdSLS3oSNI4kqAjyU+rpPd7mCAkSQNJgpAkR4q+LurXxjE1eoWfi/W9D12N/g7PtUeD1G4LUpJ48zaDkCQ+uz8dHUm82UKvRq/wSimZJBGSpClhE2Qkcf6VTVCRJOvXBikjF2QkKUYiZeSCjCTFSKSMXJCRpBiJlJELMpIUI5EyckFGkmSkQcrIBSVJIruEvr9+CFqSpCWRDxqCmCTZcJvdzRCTpMUkQUySw0XkC4igJUlrSYKWJIeLmJsLYpLs7s6KliQ776zvjwmCliQ7Df/9XUPQkmR3nV8FLUlyKdIgnQQEMUkKk0gnAUFMklyNNEhzAEFNkmyQNEi1vyAoSTZIGqTaX1CUJBskDVLtL4hKmoVsg1T7K6qSZiHbINX+irCk2SBpkPpzRVrSXJU0SLG1oi5prkoapNhakZc0FyYNUmytKExawkTqlRWFSVOYBilBVkQmzZVJg9TyKjqTZkXbILW8itKkJU2klldRmrSkidTyKkqTDi77is6kg8u+ojLpqMy+JylFZtJRmd3Pj1OK0KRZ1/bdzur9+zGzJU2kSlhRmrSk6Xvnveffg5ktabL3U7SiNGlJk73vborSpClNw963N0Vs0qxuG2bvvx+1SbO67bS0ev5+zG8uVhpG8ovepLlYadibGxTBSbO8bTjJL5KT5pKl4e8GH4rmpGVO328Cz3jMb5rT2f/uGY/5zRK34WRmQHjSxSVRkZ00WyeN935VNXzFZ3Lfe1DV8BUv7cmJ9KRL25MB7UmXtScD2pOuSu5zw5MavuK5/SvKk67dzlSIT1qLlthMhfqkpU9spkJ90tInNvOgPmktWmIzDwKU1qIlNpOgQWktWmIzCSqUlkKxmQQVSsXbKx0ZSiXaKx0dSmW3VzpClOqnvdKRojQr3wYpq1S0KG06KClClB5pIu8RigylxVCk2lCRoTQZipSnKCqUHmZi60cUEUoPNLGqXUWGUs28kjo8RYfSciiyc4uiQ2k5FDuP0aG0WcqkiFBq/UWLDqXNWiZFhdJSKFJgp6hQeqSJnTTIUGq82aSiQWl2UxqkSE2RodR4fY0iQmkhFDlhEKG0EIrUtCkilGYN3CDFW4oOpbWgiU2UCFHqq72roUSp93dZlCj1/i6LGKUNRililBZGsbsgYpQWRrG7IGKUFkaxuyBilBZGsQsKMUoLo9hdEDFKo38+RozS6J+PUaM0pL2rIUdpdlWidzX0KA1r72oIUhre3tWQpDRqNiaPjGhSGvybrKJI6a4rl7ymoknpriv3uclyDV/x39lzI3cGRCndzWSMJKXHnPzrvHz/KZjXQ05u7zVriiClu394QpDSAik2JyBIaYEU2UxNEaS0QIqdlghS9mlfaw1BygqkyJxpCFJWIEXeBAxByj7cLAw1yj6tWRhqlH1aszDUKPu0ZmGoUVYaReZAQ42y0igyBxpqlJVGkRucoUbZaJ+gDDXKSqPIHGioUTZmN6cZgpSN1c1phiZlZVJk8z5Dk7LBP/0YgpQNfrc11Cgrjdrvy8pQoyw16rtX57/ueF+jV3gmltRvGmKUFUaROkJDjLLJd50ylCibvJWAIUPZ5N0oDQ3KyqBIwZyhQVlTMGcIUNYUzBnqk80+n6hPdnhpfm/C8/jEaYhPVvhE6sIM8ckWLzw3lCdbvPDcUJ5s8cJzQ3ayYidSnmbITrZ4jbKhOdlBJZIfBCcrcNrktoHgZNlXiWyTZehNtnjjFkNvssXb8Bhikx1NmnM9X4kMrcnKmkjBnqE1mTTpRGiygiZS3WcITXYk6f1YZahM1q10MjQmS2MicGFITJYLnehRxHSmMH3vffk8W1CYTPizryEvmTbXJtqSaXNtIiyZNslEWLJc4TRJKaUhLZk21ya6kmlzbaIqWa1tYnMnspI1rbkNUcma1tyGomRNSyVDTrLkpElqSw05yXJZEztlEZTsiBE9ZdGTLNc1kd1aDUXJUpQmKXQ1FCWz5s6JoGTG2+8YgpIZb5BlqEnW9FMy1CTL0rhJinMNOcmSk1iCUJPscBFNEGKSJSaR1j6GlmRelye546MlmTeXJ0KSOW+2bqhI5rzZuqEiWdNMyZCQzGuaJY8HSEjmzTSLfmQHiMgUhHhkhUdsCkI8smgeaVGOrNnozZCNLHjnOkMzsjSjSSouDc3IgneuMwQjy3I4cgAxlaVF7PkKtciOCLFjgqncvLWkIRVZUtEktZaGVGRZC0fu9ChFtuuyJI9AiEWW65cmqcw01CLL9UuTVGYacpElF01SPGfIRbbbByHUItvNfItUZElFk1RzGVKRf3j/Okcn8uyl9L19x+OFyZGJPJloDnmymyMTea5bmkNJ/ML4yut750lHKfJP5dVJvGJ85fX9qc1RijylaJLN1xylyFOKJqm4cZQi//Cp15GJPNtwv/cVcUQiPwrEts10NCIffWbRiDyNaM73FeVoRD6kPRPQiHxoeyYgE/mw9kxAKfLh7ZmAUuQpRfRMQCrypKJJal0cqchnc9WiE3kuWqIHE6nI52wPJmqRz9UeTAQjn9KePAhGPrU9+GhGPq09+MhGnmw0ScGOIxv55F9THdHIZ2X2/fzriEaeK5YmqXlxdCNv3MjRjTxXLE2yj6AjHXmz2ZujG/niD02ObuS5VmmS0htHOvJjQ+zNylGOfFVK388fjnTkq2bi9xOFox5505TbUY88lypNUkrjyEeefDRJuYsjH7nw52BHPnJZ7SmAfORNU25HPvKmKbejHnnq0STVK4585E1Tbkc88uyrRJqyOtqRpx0R2XfUI9fKKJkxEJBcK6NkEkBD8mZxkqMheVXJkc+yjobk2V+JXUqoSJ6rkyapd3GEJG8aczsqkmdjbvZAiY7kuThpkloaR0py5S84jpTkxl9wHB3JrTJK5i+EJM+VSZNU6ThKkhv/AuPoSF6OREp6HB3JG0dydCRvHMnRkbxxJEdH8saRHB3Jy5FIDYqjI3nTl9tRkfxnTdJ7qYIjI3ky0iQFLo6O5LUmiXyidnQkT0ea8m4l40hJnmuSprx3WXbUJM893qa8ax4dQcm9f/xFU/IyJVJA42hKftwo9vtDj6Mq+ZGjRSo2HV3J05UmKc9xdCWPyi65tpGWPBclTVKe46hLHn12EZg8eDmroy55WHsqIDB58HJWR2DyiPa8QWDy4O0EHIHJczkSPcnQmHzzlaGOwOS7ckqmSCQm37yZgKMv+QEkIa8zqEu+edt1R1ry3cy+6Eq+ufs6qpLnGqRJir4cYckLlnR8i0L86z8T0hkHj97pCYSlyAVIU+fzlwfKUnx4tXkgK0Wxki7yyxfG8y+mgaYUB422nwJW247hiuF8mW+gJ0V5kgr5wx3jo/nlgcGVT/1L/W+ZgvGYz9HkEzkpRuXzPeUGelI0FXCBmBSFSewvR0yKwiRy5gZiUhQmsZMRMSkKk9j5hZgUR4voKYOWFGVJ7CxAS4qyJFJ9GGhJ0VhSoCXFwaL394hASIqCJHbgEZLiSBFZfRDISFGMxE4DZKQoRmJpQkaK40Q0TahIMfuLFRUpZrRnGUJSFCSRDV8DISlWk1ZUpDhSxI48MlIUI309zr4eAwIZKVZ/waIkRa5AmmTv2UBMisXfZwIlKRZfURboSHGgiLF4ICNFrkB6m3sgIkU2W1LyuzGfuQaJLFYLRKQoRGLHHBEppL9W0ZFC+psqOlKItKc7UlKItpcTalJIe7UiJkVi0iSFyIGeFLUYiWxXHAhKkaA0yXbFgaIUJUpku+JAUYpDRvt7ze34e41/CcfsJihNsmFxoClFrUsiGxYHmlJoXbHknoOoFIVKZOvfQFSKRKVJtv4NdKXQTC/ZzTcQlqJgiey5GwhLkVVvk+xEG2hLUcuUyC6qgbwUxUukbjmQl6J4iZQiB/JSWOaXlCIHClOUMJFtUQOFKVKYJqnGDESmyCZMk5RMBjpTZAHcJFWKgdQUWQA3yc57gdoUTUPvQGqKpKZJCgMDtSlSmyap3gvUpvB+akZtilq1RCryArUpvGn/HGhNUdbEbixoTeH90zFaU3j7dIzUFN4/HSM1he/2PoTWFFHJJVcWYlME7yAQKE1xKIk8iyAzRXRPx4hMUchEKscCkSkSmcjDCCpTlDKxkwCVKcLbUxihKQqa2EmD0BTRZxWtKQ4m0ZMMqSlqORM7yVCborSJVNYFalPUgiayN1wgOEUtaCL1Y4HkFLWgiZTcBKpT1IImsq1ZIDzF5p/mAuEpjiyx8xjZKXbPFMhOO9czsTNtozztH3l6n2kb5WkfXWJnzkZ72j/29D4xN9rTriVN5EzbyE+7ljSRGqON/rRrSROpMdpIULsIar/FdyNB7VrStN9t6jcq1C6F2u/P0RsVamfx2yRLHDdC1C6I2kHiMb21sGm/X203WtQ+2LTIUpmNFLWTohapadhIUftY0/686zI3StROiVqf93esjRK1c1nT+ry/RGykqJ0UtT7vjwsbKWonRbEvNRspaidFLbLeeqNG7abx90aN2rlp3Hve2WhRe7ZmsVGj9myRcaNG7V6jNmrUbjVqo0btXqM2atTuNWqjRu1ZmX0/XmzUqN1o1EaN2qtWD5OrBD1q/3gU+ceiR+3VPElt1Ki9WmfcqFG7ljaxMwFBaq/2AXmjSe3VPSBvNKm9+syiSu1VmX0/u2x0qS1NZlGltvR3W1SpLe3dFlFq/6AUOREQpXaPUhtRanflcRtJakv7kLzRpLa0D8kbTWpLzcbvp8aNJrWbArmNILWVV25s1Kh9vInZ5EaN2qlRi6zf36hROzVqkfX7GzVqp0Ytsn5/o0Zt7a9Y1Kit/RWLGrVLo9hphhq1tXlC3mhRW9sn5I0Wta1799lIUdvad5+NFLWPNcnnCZMbIWpbf5tFiNrGv81uVKidCrVIXcZGhdqpUIvUTmxUqG39BYsKtY1/n91IUNvaV9qNCrWdf5/dSFDb+3kYCWo7/96+0Z/2ASZ6giE/bW9Sivq0vf0ssFGftvPv7RvpadcyJ3Yyoj1tb/KJ8LQTnhbZrmgjPO1o7quoTvvI0iQvLchOuxY4sX8nytOuBU7sPEd72mVP7OxCe9rRfnDfqE872mdhxKcd/bMw4tNOfFpko6iN+LSjMkuehRGf9uGl77UR8vXnKGYL8WknPq3h72whPu3Ep6+599l5biM+7abv0kZ52ptXuG5kp31cif9DMa27pt/9l9rfE192EZ12otOan3c4ZjXXO32fBJ/XUcGkHlhyJb/8Tql8Up3Wu76phq/4wY9MjV7hszkFaviKX80pUMNXPJ2Ca+wKpl/ba+wKtvYfahju/BSo0Ss8+ClQo1f45qdAjf4OP5j0PgVq8IrOy/RdwlXDV/zpjhbPObtGr/BM6btIqYaveOkO/MCkDm3PsIF5LWliZ9jAxA66zLTGrmBaYFVjV/Bu/6GY1CImcoZNzOoc3Rk2Mam54omdYROTehSJnWETU5rEtN6lZDV8xTfTb41e4daeAhNTOr09BSZmddKnpRq7gum7ao39Dl41+z4LHGv4im9n34VJXbM7ZRYmda3ulFmY1eQldsosTOrhI3bKLMxp2tJ674hVw1d83VOf+FPDV3xNwE+CqOErfreHEhMrn+5QCuY1dYkdSsG85pKn9S76q+Ervr+rCmZW6LNSjV3B7cUqmFhpnpVq9ApvnpVq9ApvnpVq9Arnz0o1+Ds6lzqtdzlkDV/x7dWqmFXtn5UUs6p9VhWzqs2zkmJWtXlWUsxpstJ6133W8BWfSX0XUNbwFZ8X67tqsYav+LxY31WLNfw73pr3mhq9wrv3mhq+4rv3mhq+4ul7TY1dwc21aphVa69Vw7xae60aptXaa9Uwq9Zeq4ZJte5aNUyp17X6fBWu4Su+vVYdU+r9teqYUu+vVcesclqqsSu4uVYdc+p1rT6/W9fwFe/tgcGkenSnjGNSy5bIKeOY1aQldsoEJvX4ETtlAnOauLTelbE1fMWv7sgEpjSkPWUCsxranjKBiQ0KhjV2BdN1LzV2BUf7lBqY1GhfbAKTutsXm41J3e2Lzcas7vbFZmNSd/diszGniUrrXRxdw1d8O/9uTOnuX2w2ZnX3LzYbE7ubF5uNWd3Niw2y0vh0d9SBqjQ+ozkFBqrSKFV6nwIDUWkkKpFTYKApjeNG5BQYiEojUWm9S9hr+IrvXGmgK40fV3qfAgNhaRQskVNgoCyNDy10rbHfwYPKfo1dwd0ddaAqjdG9qw5UpTG6d9WBqDRG9646EJXGaN5VB5LSKFJ6V/jX8BV/bqlDX0XjNXqFZ0rfNfs1fMXnPfW9KWUN/44/dBT6bLlfo1d4XqvvPSxr+Ipvn34H0tKYtIC5xq7gnIDfG2TW8BXfTcADZWnM7gF4ICyN2T0AD3SlMbsH4IGyNGbzADyQlkbR0ruTQQ1f8e3lirQ0VvsAPNCWxmofgAfi0lj8AXggLQ1eRldjV3A7ASMsjdXB/kBXGquD/YGsNFYH+wNZaUgD+wNVaUhdqW9DG8hK47gRPTKoSuNHlcgpgKo0RNpTAGFpCO0eUWNXMG3eU2NXcPdOMxCVhnTvNANRaUj3TjNQlYZ27zQDUWlo804z0JRGmdK7I0gNX/GZ03dHkBq+4vucIiuNhpUGstIoViLvHQNZaWibVlSloW1aEZWGtmlFUxrWphVNaViXVhSlUaL0bgpSw1d896o60JSGta+qA1lpWPuqOtCVBt8yrsauYP6qOtCURprSevcGqeErPpP63hC6hn/HFyu9N4Su4Ss+p+D3htA1fMVnYt8bQtfwFZ/X63tD6Bq+4s+7zZiv9Y41eoWfZaOfeO3OXqNX+On5sp7tK2v0Cs9b67vXRg1f8ZVcMpkhLg3vHGIgLo34tGc96tKI0Z716Esj6FK0GruCm6dgpKUR3SfzgbI0fmTpPfEhLI2wbuJDWhpJS2ziQ1waR4/YxIe0NGrF0ruXRA3/ju9WLNXoFd7K/kBcGu2KpRq+4rnsD8SlwVcs1dgV3L7YoCyNbsVSjV7h7YsNutLoVizV6BXevdggLc1asaTve99EW5ofWmpTY1fweQT+vIpJa/CKPrfV+ZwdJ7rS/NCGpDV2BdNeWzV2BZ9Xmmevjxq8ommzrRq7gnPOfXc0qeErPi/Qd3uKGv4dn6S03u0paviKb7KJpjSPGpEjjqI0jxmRI46eNAdtGVxjV3DOt++WGjV8xfN3mYmYNAfdZ6HGruBoTliEpDloE9Ia+x18nIgcETSkOWnv5xq7gnOSfXcYqeErnt86JwLSnLyFQA1e0ZXJ9+PWRD+a1dD73W+ohq94ujdRjV3BdG+iGruC67p8P2tN5KNZfPTui1LDV/zg6Uc8moVH7yYqNXzFNxlFOZqryyjS0Tw89L1sSMffay0Mx4QeHrIY76kW8WgWHr27v9TwFZ+z7bv7Sw1f8ZnVd/eXGv4dL3TzsBq7gpuUoh1N3sq7xq7gfGt5N6Gp4Ss+30ffTWhq+IrPy/TdhKaGr/h8Gno3oanhK56/kk7Uo1l6RD64T+SjeYCInb+oR5NvB1djV3Az7SIdzaKjd6edGr7iaePnGruCK6NkekE3mo0bTXSjeWCI3eVQjSbfD67GruBmzkUxmnw/uBr7HZxetN6Nh2r4im8ehNCLpuUuRc+Nbmv0CudlxjV4RVcuySSHWjSNbh9WY1cw3T6sxq7gnG7fzZVq+Iqnfbxr7ArOufbdiamGf8fzPt41dgWP5pRFJZreTLZIRNPpVhg1dgU3z7WoQzPXHa13+6gavuKb51rEoZk4FOSURRua3lyYCEPTmwdbZKEZzYMtmtAsE3p3yKrhK562j62xK/i8bpLvxhNVaB73IYcETWhGc1GiCM1jPuyQYCKjLkpyM0YQmsFrKCZ60MylRuS6QQ2atdLo3RKrhq/4yia5BSIHzd28b6IFzd28b6IFzeM97A0fMWgmBhHFQAuau8kmStAsCXo3iKrhK77JJkLQ3DXFknsgUtD68IefhQ60PvzhZ6EDrUM972OykIFWFa29m1rV8BXPYW8hBK2DPe/3+4UQtD7Nk89CCFof/uSzEILWh0+wCxVoffiTz0ICWkVA7x5fNXzF8yefhQS0alnRe2vOGr7iM5d7knjMZfVF2u/71EILWmVB+73aZqEFreM978a8NXhFe/+vxaQOvgBwIQetWldEDw3mddK6/hq7gkd7HBGF1uQfUxaK0JqrPeiIQmvyxScLTWiVCe33TWWhCa3Jn4IWgtDKFUXvLY9q9AoPPlkgCa0iIXayIAmtIiGWIiShtUZ7vqAKrVIhliVUoVVLivb77rwQhtZqpl10oZVLitiBRxdaWa5GtrKq4Sueq+1CFVqlQixRqEKrVIgmChNbxWosUQhDq9YVsUShDa0qV9vvZ4aFPLSEc99CG1plQ5scebShVTa09/smiTa00obkQ+5OaEMrbUg+79fEhTy0kofkvQ98DV/xueHb57lBXA3/js/lRfJ5bvJSw1f8eUzyz/vwoBKtVCL5KInH3OYCI/nY+9xBKFoJRfJu6lXDV3yfXrSipXwpykIqWur9PxZzq83tFbVoaSX2/fC7EIyWcV9YqEXL2qyiF61aX8SOIoLRstUeGCSjZdKeBUhGKxcYybvvVg1f8c09FtVoWTMXIxmtXGAk49nhr4av+Mzqu6NXDf+OTzWSd+enGr7iR8Y/G1vW8BWf1+u7mU8NX/F8xcJCPVq5+5t8C8UrrQhIKwFJBjkNEJBWApIMMhmgIa00JBnkkkJEWgeK7Os++JwqkZHWoSKj/1pMbVRqyUmMlrTSkuS9yXYNX/HckhZa0sqe3OS710JLWlm8JqRNzEJOWrnESEhPkYWitMLauxqi0kpUEtJUZCEqrYj2LoiutGqdEXuqQFlaJUtswkRZWrudjxGW1u7vsmhLa/d3WeSltSu9ZFZAYFqbf45Z6Etr031rauwK9vbAYF6Tl+S96XQNX/G7naFQmOTz6WYoQWSST12z73cSQWeSrGQT0rZCkJrkwx+NBZ1JPpXV9/QnSE3y0e4iFNQm+Vh3UQl6k1QtG7moBMlJau0RuagE1UmOLLFzR9CdZHy6i0rQnSTdiV1UgvQko3L7nu8F6Ul+6In8c5GeZHClEHQnGdr/YzG3gz8XC7KTJDsJaYwhyE6SFW2ynt2+a/iKz6uW9IsQlCc5uiTybD5eo1d4Jpa0lxC0J8kFSULaSwjykzQLkgTtSY4vvWdLQXuStCchXQ4E7UnSnuS9DXUNX/GVWDI9oT/JbJ+OBQlK5m5PBCQoWZ/uaVeQoGRVZskMiAQlqzJLLlkkKEmCElL5KUhQkgQlpJRTUKFk8RIoQYOSapnE5g80KFnt26wgQ8mK7t4pyFCydnvvRIaS40zs6VtQoSSXJ7G/BhFKEqGEVMUKIpRIpZZMCuhQIu27j6BDSVPdJohQUgjFDiUilAhvWicoUFICRWpoBQVKeDfuGvsdzLtx19gV3D0VC9qTHFz6XkX2PChIT6L9/RXpSX7oiVwfSE+S9CSk4laQniTL24SUZwrqkyhfdSZIT6L8S4AgPUmVttEjg0m1/skJ9UlyrdLXmfeetpGfxPibrKA9SdkT/eWY1rInUuIoaE9izYWK8CQHl743MNP197SJ4ZjSpKc4VRtrYp4Qn+To0vfmTO/fjmk9uKTrL9l/j/UvxxGTmm249+dZGiYIT3Jk6XvRl86/Q3C2RneS7MP9/Uni+dsxqclO++sEk78tFoZjTrNd0nYSjik9sBRf7yGvhTSC7CTZivv76nj+dkxq7gP3YQcSk+o1/ZJnDlQnyZZJQkocBdlJeDvuGruCR3f+IjlJbgPHzl9EJ8kFTOz8RXSSXMBEzl8kJ8l94Nj5i+Ikh5To+YvgJEeU6PmL3iQHlOj5i9wkx5Po+YvaJPvTnb+ITXI4iZ6/iE1yNImev2hNUtZESmgFrUmasjZBaJJcycTOR6QmOZwUEc+VT4LYJLudfhGbZLfTL1qTHEz63unzeZNEatJjSeRsV4QmPZIUsZ//UkVn0s9sLg5FZtJPTr/vMgdFaNIjSexaUnQm/eSVOslvVwy35tJTVCb95JUq5Lc7hndXqqIxafZL2kZ+OyZ1fJoLW5GYdIzmwlYUJh2zubAVgUmPILELW9GXNJc2Cal1VyQmLWIite6KxKRZ5iak1l1RmbSUidS6KyqTljKR8nJFZdJSJlJerqhMmg25hdQiKzKTFjORwlVFZtJmiZOiMWkak5A6TUVm0maJkyIzaXZNIjOZojLpzIfgN+ooIpMWMpGSUUVk0lzkRGZtRWPSyTucKQKTHkFiNxBFX9IDSOR3Iy7pmt1RRFvSxb+8KsKSZrskdjtAV9LGlRRdSZd1NwNkJV3cHhRNSQ8a0TsHkpKuJpfoSSqf7jaDnqTS5BI1SWV2NxnEJJUmlyhJKtLdkRCStIEkRUhSse72hY6kjSMpOpJKdPc6ZCSVJpfISKqf7k6HkKTa5BIZSWsJEylBV3QkVc75ioikhUik9lsRkbQQyZ4bj9bwFd+Bg6Ih6XEiOr+hIqm2Uy06kupuHpAVGUmz7TabEFGRNNcwkQdkNCQ9TkRnRFQkzZ7b7AEZEUlzNzc2J6Ih6XEiOs2hImn2R2IzFyqSWvduqqhImpu5sbkLFUltd9MRMpIWI5EZBhlJfXSTBjKSFiORB2RkJC1GItMGMpIeKKIPyMhIWsuXSDcARUfSpv5NUZG01i6Rgn1FRtJiJFKwr8hIWoxEavAVGUmD19ooMpIGr7VRRCQNXmujSEga9ZxLHqLRkDS4NigSkka36FuRkDR4baoiIGmtWPLP8/OWoiDpMSJ2vDGZwettFPVIc62SkKYBinykm9fbKOKR1kol9s9EPdLNq1MV6Ug3r2hUpCM9OESOCcKRZj8kIR0JFOVIN/8Wo+hGmouU2GmFbqRHhti/EpJptUCJHG9DN7IjQ+/jbahG1lTBGZqR5dIkIU0aDNHImio4QzKyg0K+3ncVQzKyg0Lff4p9/pbPxnDDcF4IZwhG1hTCGXKRNYVwhlhkuW0b+0ciFlmtRyJdLgy1yGo9kuvz0dKQi2ysPh4TWl7k70YXhl5k5UWkB4ShF1l5Ef39mNXyItJRwdCLrLyI9DEw9CI7IMTThdnNRUnsnEQtsslnXUMqsskLjw2pyCYvPDZ0Ipu8IYChE1ktRyL9FwyhyGo5EmmpYChFVlJEGg4YSpHVciRSjW9IRVbLkUipuqEWWS1HIvXkhlxktRyJ1JMbipHVciRSbG1IRlbLkUj9tKEaWS1HIoXLhmxkWRQnpFLXUI4sVyTJJvlFOrJakbRJflGPrFYkbZJf5COrFUmb5BcFyYRXsBr6kUl+On3fhxGQrJYjkapRQ0GyWo5Eih0NEclqORKpuTNUJJNKLTl1EJKsViRtcuqgJFkjSYaSZLWLG6m5M6QkyxVJc7/RxFCTTJu8oiXZ8aKvX05ug8hJppztDS3J0pLmJvc05CRr9nAztCRLS5r7vTLG0JKsqYUzlCTL1UjzezH385djTptaOENIMq2EvvvmGUqSWZNQdCQ7VPS96fXzSkVIMmvyiYxkuRhpfd4LYA0dyazJJyqSHSfan/eyZkNFsqbLtqEhWbVO+rw/2hgiklmTTiQkq9ZJn0l+OabTm3SiIFm12P681wQbEpJ5k08EJKv+2h8ys6AgWbNvm6EfWfqRklJhQz+y9CMlpcKGhGRJSPoht0ckJPOadsntEQnJnAu+oR9Zbd32ITc8JCTL6jf9kBseKpJl9ZuSQmFDSLKEJCXltoaQZAlJSkpQDS3J0pJ0kHsYYpJlBZySQlFDT7Jqs00KRQ09ybICTgc5GZCULCvglBSKGqqSpSrpIPlFVbJUJR0kvwhLVvu4kdpPQ1iyXJakpPbT0JYslyUpqc405CXLEjgl1ZmGwmQpTEoqKA2FyVKYlFRQGiKTHUb6rnR4TlSITJaFcEoKKA2dycuZyHcpR2fyLIRTUlHoSE2ehXBKCvkctckPJ303p3x9O3LEJk9sUlKX5+hN/qnsvs82R3DyT2X3fbY5ipMfVVIbz2cQR3PyrIRTUkrmyE6eXbiVFGQ5ypNnKZySDXwd6cmTnpQUZDnSkyc9KamwcqQnT3pSUmHlSE9e27uROihHevKkJyV1UI705ElPSuqgHOnJk56U1B050pMnPSmpO3KkJx+1bRTJL9qTz9qMhuQX8ckTn5QUyzj6kzdLlRz9yY8xub3rfBwFyo8yub2LUh0NytOglNTtOBqUp0EpqX5xNCiftb0FOdXQoPxnkzdyqqFB+azUklMNDcpXpZacamhQviq15FRDg/I0KCXLzR0NytOglCwHdjQoT4NSssrQ0aA8DUrJKkNHg/I0KCWrDB0NytOglKwydDQoT4NSssrQ0aC8dnwjqwwdDcqzOZOSVYaODOXZnEnJKkNHiPKEKCULBx0hyhOilKzWc4QoF/6Zx1Gh/DCTkHb5jgjliVBKVu44IpRnbyYli3EcHcrLocjOA44O5U1lnCNCee37RlYPODqUp0MpWRDg6FCulVhyoiFFuVZiyYmGFOW5sknJl3hHjfLUKCW97R01yo84mb1BwtGjPD1KyVdtR4/y9CiyksRRpDxFSskHYkeR8qY7k6NIeYrUu9+2I0h5Vscp+dDqaFKeJqXkO6GjSXkWyCnphu/IUm6VWHJiokt5NmdS8t3PkabcKrPkxESa8mzRpOQ7nqNOeeqUkq9Wjjrl2aJJyVcrR6DyBColX60cgcqzRZOSr1aORuVpVEq+WjkalWeXJiVfrRyZyoupyFcrR6byYiry1cqRqbyYiny1cmQqd06PjkblXsklJwMylQenR0ej8jIq8j3M0ai8jIp8D3M0Ki+jIt/DHI3Ky6jI9zBHo/IyKvI9zNGovIyKfLRyNCovoyIfrRyNysuoyEcrR6PyMiry0crRqLyMiny0cjQqT6My8h3K0ag8jcoI6DoaladRGQFdR6PyNCojoOtoVJ5GZQR0HY3K06iMGK2jUXkalRGjdTQqz4VQRozWEam8Kujeb35IVJFEZUR0A4kqPpXd99kQSFSRe8Ppu9tRoFBFrocyAsCBRBVJVEYAOJCoIonKCAAHElUkURkB4ECiiuzWZASAA40q0qiMAHCgUUUalREADjSqSKMyAsCBRhVpVEYAONCoIo3KCAAHGlWkURkB4ECjijQqIwAcaFSRRmUEgAONKtKojIhuoFFFGpURoQ00qkijMiK0gUYVaVRGyDXQqCKNygi5BhpVpFEZIddAo4rs2mTEUAOZKrKizoihBjpVzMwvMdRAqIqEKiOGGghVkVBlxFADoSoSqowYaiBURUKVEUMNhKpIqDJiqIFQFQlVRgw1EKoiocqIoUZB1X/56x//9b/9r3/+j//5z//4z//tP/75v//xn/7t3/7x7//+P//Pf//nP/76v//49/+a/8f46/zaf/yn//uP+Pof/++vf3zNF/m/V/1vy//9vY9K/aA/P/jPD7t++LqT1w/y88PPf77r939vQFE/zJ8f5OeHCv5uF5s//Pzm7zVp54f4+a/i57/6niHOD/vz54f6PfvP0Pz8/PDn//IT8/Ob9/qJ8Z8Y/4nxn5j4iYmfmPiJiZ+Y/RPzczT2z9HYP0dj7z9H++dwfP00//wkPz/9/JXjo3/+C/vzX9if/8L+/Bf281+MsX9+8j//t5+/f3xv8Vo/Lf3zk//56ee//d5ZrX7SP/+Frj8//flv9c9/q3/+C/vzX9jPf/HdPLp++jP63eHw56ef//a7beDPT+vPT/rnpz//xZ9/5XdvlZ+f/vwXP+fP9wfwPz/9+b/9+f+hf/5/6J//H/Zzzozvj675U/ycWeNP3udHfi6Dj37+/DT//CR/fvrzX/zkcv7J5fyTy/n5c319byT+89PPFfa9ffbPTz+/+f9X9m7LjevItui/nOfzQFx4O79yYkeFLMm2umRJrUt51orY/74BkhjIBDHouR+6i9M2kiQIJPIycqRJK87GrsDzVey5uVylL2hjX5TlCn8X6Rbnqw57NiZR56voZKarNKLHE/RQCT2eORrn6Sr/DFJw3yGtPzs66AoHZeHSDI2+wVVWLhjhMcJjRIerHmN7jO0xtsfYHiMGjBignSyu0ip2xuSrDldJaZm0cpxL69S5tE5d7NmRrpIU5/F3Hn/X4u9a/F3ab861GNFiRIcReNLIAZ6uMGLMV2msT9/DRb7UdJXGeoe/w319WrHO4x4e98BudG2Xrxyu0qy1ab24Ln1Vh9Xk+nTEuD7tZNen3egGHCU4FRyOBYe96qKNvVyl082NSWM6rBeH9eKwXhzWi8N6cVgvYfqWp/fQ2WEi+3SVjhYPLeCxhoLSw8+SLgnqL40wSUsF9Zf+zvg2XaX58yat06lR+nzl0kqc+smkK4urJA+6eGLdX66S7py4UtNV+jufzoqJiy9dpffFOph4GNKVx1V6o0gBkK4crjA2nUJT6fpy5THCYwSeoMUTtB4j0u6ZEMnpKv1d1+JnSVNPONF01eEqzUvXYUSHER1G4Ht0HUb0GNFjBL55l/TplAhertK6mkJq4SpcLobd9F/R0Pv1vO8uj/fr/UuacVNUGpbcFIuuD9+9Pa7n1/P4fjofb7vnpxYSbHQhxLBnSEKigNPlebzv9s/T9XK/hp9JgRGUBHlmWSc1efv98fZUZmkrDFPb4tzqGpxCPX26Sdrtfnw/3o+XcL27P4539aKjFe85bxsqKFrMDzk6HK15dKyt4KMfj/3ncf9b3z04fhgOQ2DWlj+J2d0/9KOI+e22XuPx+Nrd1Kfx4su4H4ZeD+qzevFtzA/vf1WvHtRlHuqaZH65xsE5wLHb47eD27jH9XV5/jodfv0+/pV3io348kM2zU8Sbvfrl16CMXuaJbTjTxIex+fzdPl4/Lofv45fb8f7r/P143RRD9WKhxpnJb0l8Xm97z6Ovw7Hx/5+usUtpqR1YjLHWbluSCs9v9iLMw8fNtZfHH46qLHjKGfXwjVJKtTABAoXyaDGIRNbNi1XHlftAMN7Nkm3Hmb1tTv1tbufxq9UVeytKCX88G1Ol9PztDuf/kdv7Rihz1L6dmNfFVLKnR1zA0KS/+mNhBY+Pl7npxYmV0pMC2wLC5Orhsf+4nmltD9shGnVL0tXz3CrZrjdFjNvyPfwTte7/tZGxiz8D+t2fSb14oyLUant8WlX6208yG38w8arTEWwSMQzDNgWw9aZlmTpSe0aqQMQDkgGYNiH2H0INLjsAMMt75NpZPrspsI1bDZe8qwOJDEz2TiC8ba4f3U55THjWvmd+bjb8f51ejzC0g8fS69bIYBvoPNqVo1cYrGB9cbQ++55/PirR/dyNN8u5+c1P7uaxVas0eUcrEpQR/qU4clmzeIc1cd9HneH4/1zdzmctQYbrNjr1m/JuE8y1LqWO9zzafvv61RMeKQHz4/uYCXDP51o1JcrzxfDJDk+2Pm6/63v0DTyDhsKVZuKsRIxj+s8P5ruq3XUydNg4zC415ZRJw+Alt/2efpzeqqRoxePbAfLv+E89vh1ej71lxxNp3bAT7e/XJ+n99N+Fw+gj+MlnEVPbfkNbpTrin/Cw+4WnqWm952X23lRXENymUw30AV3OGgdJVYCAgy2RTitaxG4QmivT4GhiaD0/1sc2uyywt3t6GwfDtmcDkvleL/rKep7qTdsRw/ISVA+I9UkSd9k8PSgjyLmL/d1fIY5f+7Uore9+FrBuKKb5XDYXy/P3ekyWx/lSjRqroMgqgyFIKHP1ZKUs8MtxMNhWX/HQ7CErq/7XntvwSiTcvqNV/tcKbip7Edog60ldz49nvFJ9HyMYrwbG8QjuLY8HKqfyIkPbVOkFeEex7XN4XC7Pk7/1ISOg/zsSz6iLuO/r53eVH0nN9XG3ePIwont5VCuGcIH/br+Of6sa6R5ZX1Lz88Dloj+SHKJuAHh0AGh3iHtfDd4/BbhwWFAeBBB1REjEOR2o8dv2xxaxM+2Z2J+7urSaDsVC2o3NFKQ89DLqpWhEcMN0sPhefy6ncM+I8/Qq2fYWErPa1XCoARszMX3br87n6/fNSlDI88xtzUV38e30+HP8Y61VdOuTmpXumU/4n/JfSVs9K0xNGTkxILmOjSK2J93jweXI+1K+kminI/gON24HLFIevo85w89RtrzKVAwJq9k5Nrm/HF8u+/0e4gJGSzd4OeP/3wrM1At74F7I+fzfneZzWOlqsT3TxvfpgByi3i5TZkHv+TB67d4f53fT+fz8aB3Tqt2L499nc9hxX9etTIdZYjJwjqyA1JwI4/YxV00Bz3no+/7firsQmvlSrQbL3f9Ph6qz+fU86Uk4IBE45ARAwZpOUuP6flOMRIdpRb38upeSAFyb7aQdj9+BEFK5KBEIps55kelRlcUHq0CrebU1+Z7ILiaQSvt105XLwNXHb35VzQY9THnhW50PY8A3pSb2bUy9jca+mVut+NFLe1WRj14vPJ2Oy8a+Nd/HtoxniiOhP3Fl7IQcj7U5Dglh06bkHPdP48xKBs+wVchTBmF/+rNHrfd/b/nX69bOLEKV1itiM7RI0tI++fX9/f3r5gU+vW6n4+XfXAxDoXUTknd+Njnv8EUP5yepQFuzCiWmut46C3KCJot6A69H2XaxTU8vXS73V+XwnTuOrnON8LdafDpcns9tQSnJFAb9f7xR4/r1Ti6Vu733d/j+fhVnP4Tk3+e+5bvmCjgdQnzXgnMBMtM7LtwxNDZ0x8twnhlUIh+tDJDFEl8RQou2bS2a+H/Njl5mw68lmceH4/j/VlPJ8gJGg11fCcJ19NhL8LdSsG0KuAy8neNgqIqJSs9Fm9J63XrnZ7xtDj+87xPIQutKWWoeRiosnr8veyrn1ymoLzlG0YIWC17o2LEYeHQ9SukXF/PtRijxNANGMU8r9Ni1pMqg8NT6f+WgJTlvt4qn0f7BtyHD67FaR99gmoyUu5rOzp69k5SYsKcSpLJ92Dy0amZJCEssQo7W3lCup7naZ7R96rmJqYeo8JGBRrBc731fN5Pb6+nNp4Gaa5bz9M1Lw0isHIv94DpAcDmB27oB1G71z+n82l3/7s2dIyRpiPfk0FK+O94NOqstbSrjUWGxLZ0YoKkQikaBbPwdEOGkdf76X9mP3KNP+jlgeC27h+lqNcYZaTcdkDeDjyincTMWc+KomllviM2tvlJUpEykJnKdExY4B4tkI1dBgyngGl47p/vttJpMjxpeGxgERD2yOfzeau8eC+jVuGRf5pCLanM2fZKDVgebAjSahH/UdrHY45LUzHLVjkd4np/Px2reQSjNjK38pO08+nyO4VSKg6gE5twIxvCt7G0vA0PFCYBtVdSmWSsqQSC7TyCc0AtDgPVX392p/Pu7XwkYedBnuE01vG2O9yP/30FnR7Xxyq0b5zMp7iRxo3fdg+drbby9kBcRv8l7a4Ek7HWAiuJsGNPs/XxTp2fXIV4hqyT1KaRkAhnKUwqStoCViioCDUbhJRKllvah/SgnkVs5LRUXnbzfaIddDmeS8zMaGVEoW82RZxPMR53P067c3d+VCbHNwq3QlV4Vd5qmnwjF0tDfbxJ2vXrdr2Enz7+86gk23ovjX9DkXuzqOvv09qacTKBOfqtqTp+hT34OF4KTRF7TOf3MTQeHkVE8yzrwa8YfCiMB+kbuJYm1Sdh1/vHNdj1j8f39X5Yz7PMrwaveGs9/qCb3aisNWrhR1Hn68dHcXypLG1DEYDL6NOFQ1KCzpAYn63ZCfaMhhf1nVosKPRpN2cmTW9tW6jct6WnjBSz/krK+7LU3ZiFFEjYRoUqHLV+p8HXQwzLFc6fCuMYR01FLaE0KVS8yzi3tQWClMpcttJqNv4nCetpHNV70Kx0HB8P+8lkiOiL0peV+dvwGFvfdDlKX/dTsYUHtYUTMB8wcdemKLLrmq0XhQtWzR/2Cj9hqAGmJFWcOXnkD5sKZ/pqNTjO2Crjrd/a4UpIuZBGmfiwA40TR0FB1J8qBKOXtlswN7amWAmpOPG9jFsHH2HzgZ67qt8yKtO2p4DaWcbqA8nD3PU0ojiNfr0druGU0lFklaN07bi1x6MpEWzEW1gwMdMX52N/nQs09UZpJKjbGZrcikJf97Me2yhFPO+FIQHxkK4IigSowJTGMigoilyi6Qrlhyi0MmMq8QkGZzI9gSO0XSofCWsMRaFNzuig4CQZq97lwo8BVzT0sbw1ibcp14Km3hYZNX/QqZOMIqcWCefj5UMfHKPc9GG/olI218PSpNkidN7G99e5XK1OrdYtiyxImRPZRQh9UA4mxWBFEVM2PLqC6wNFIrnMUoSzJWW181qZzo5dDbiE055EaBurcglb31rKqEUTG+kXuGbLN5OiKmEdabb4LU/ntA8O9kct5NsopWRorGwSotWJctNlroPj0Bcp02lbK5MRE7NUdP0rIeXhYySYnec/FkGPW0TyVkIP0szsafbp7bi7H+/TyqtqCbH26PYOlrI++az0QPukKfvkj/dJJw58d08yH+dTATZqZQhqIgX7cfyWzdErm4MuweuhwNRLbCV3HMOwyjKRNopLZ0ybDoeWBp6zuNWCkdaKo/H9t+v1fNzVs2VyA3hLc0pvr9P58LW77ErXykt7ydBY3luZ45BJkm5kT77f7T/LT6cglwCUWgp9mGQc6i8v48uW7txZwn++f1fNYCdV0UCDwrMQrMljATJQNvtAjaz97rx/RTTZ/vN1+f0ogt7BB1S2GqB2/cAW13532Qc/5HSoZda8rMEzhkaUgpDjP8d9cQIaN6iMGkVkVTFE8tMsNkGqOU+OM+p9lx20/D7BklMlaqovTVZGKp1LJVUJqGxAfZAKOkzOfqSCLRA+gJUh4WUyZ0QSbFO1tTUI8qcLFPN7GIfp9ZAHSDoCRqBLBcEOhYB9Rl2mCxRJp3ISwKxgVuZy5/Q3uWA57ahEFOBbpK9TbgpVvMmP9DBJ07v7BE9qE3KtTY/RpultE5NIm2ajTTXIKFVuU34E5fFtytW16YO2Kcrbprt3DS6Wm3aJr6JLChf1zl0qhgagHUXMqFeGvY565C7Nc5foS7oU0enTTftEf9AnJ6NPQfc+fe4hlXEPLSB+yx8D+GqaXLLkcZXq2I1pcAVWGvAthG2Ln8GdMZBsWvwWjCMG5U55cYM7w8CdMRaSLThFLAoNbErNGAfWEDA5BNcqSXYtrrCDXIJRGA+2F4+7oabeeNSEedwXcAuDZWVQFx+Jn9NVqsI3CIcYwDciSR42emY6wZXDb7NCAAMMKuQNFpJBlbtBbbtBns/0ucAMHDR9KrQwYG0wA5hYBjzVgBJS5HFMLvcYUC46jJACVp0RkrHogvZKzzKCyQYsEAZ8H2ZESeoIBhNw89gGFegNdF6T1l9wGR2uwNji8LP0fcOhnlzizJ2UqZIcCu9cWhvWQbGCF8SioNY6yIO+DFeZ7SU9AZh2LNgdLJSm9Vl5g2sF6tJ6lMV4sNaA8cGCcydcgVsGT+BBDIW1a9t8QuAeLe7Rdvg7MLZ0SaVYMDnYDiwuHVhwenyZHiN6PPOAOQBzlB0wYoBkYJQtKjTtgPcd0nqxgPuHT5nmYEz6yo5YESPWwYi3zMGUEUwnKLt0WGGuQakASqyDpwoOmhSmcVhrzoCnxYCdBdl5l4P0FowogEQEZZbkWXCygPPJ2RZ/B7YXC4vMDhiRvofD0eQ6h5/hpAcXh+vwzDifXJcOQ9fhfbvMBYP37TN7DPhwekjpx2whAKVtYGOnU8wjh+otWENgwHhwXHkLphMLvhSYNR4MaR6EaB7lt+EKbCUoKoN+9uDD8Tjrp167y9WGLb/YmiuwxCg9i7BasQ/AxcTRlPvd7fm6H6eEdvLMdS20NMwHirjb716PwoY20t8BMZpv8K4NjLkG3lADRpjGYwSstgb8KU1ae95gFmH9euwXb8A1Y2AWGnC+GHxHwz25411DU6RvYDmvR3BLTpfjgcSAZRzScaz0IuR4+Qj/FDgwVYDT9tRPmkWkYp5ZVCGpVZKYKx0drY9jCZgKTy+/M41vLBl3Bb2QRCMWVG4W1D4W6sTCgLA86sGS+rJO3PYZUWWh1ylEK4i8Fy6vldwYA40CTlU1Sz5W4yXEpx9p/dU0HMFIPeO9Qo3SzPtc13Mpqk96BdLkru3n6axHqopE5/mTx5DNGl/qZKZz5Nsmjs7cPkUkV0WiFmYsJuRxfn3oGINkhnADTftNo1+3JYmunqCTUSMzwEgeaGFHFKbhURIREI5a2DnQSh68Utk7bZN96luKAphuFTOzhaKQz+w9TczO+BP9yWWCfXPYL4Fb+ZHXRpGoNJZqDC55xXWj2FQaGqRdYWw0vEY9Fw0JroQsNe1alqKb4duMyKokZ71R70iBfiuRh+Mzwm9qYTKFC20ogP3fQZ0U/QtNG61krSUZhSiDt2ZAcGIoxr0KolqxsyjYfpt9z389pWswlOYiSZER+JzgBjUNIg4N/GRYM+EKnK6U0mp+Gl1hIQ9hs736T4fKem0VmoXzQRQiKstUYfcNrwJYJF3er9X4rRRiaI1kFFLNFKuFPSAaujhmdUmV3GFnlb6nmY4wOgbIY1ZWJ2Tl8JGm6fbn6+XIk31TbyJxaG/Jeei6sFG+gO1pddA08vjPLbzG4RHBPRoBNsgKuOAl8Qd4PZ4Rz/1+VTazlR6KMfxzTsMr6ZrY+kGC0NNuAkOoAQO0X+LQG/ILIqJOqa6ewjz2xTjjJCDBG64/wsBkgD/WWDQJK3cWbLSWuwXXr7fCireKh2OxKTwC15gb2BELpwSXfnh8Xu/PuDmrS1sCIcxIAXQRh3o+Po8181+m020LHnJQgVuUl1hOdvQT0FXhogxfuVFM2DybuHQjKWocV9CLLElkUUU3Sfenp1nZDXErFJjMe9mepxavlyCnyGyqQmUKTIBPsqsBbIxTqsryzFsd9iFL2VyKrQwIKm0cilu4DYl99ekwaJPCaCnWJgh9P2mSA0k9gpp2M3IjdhJRY2PtZLWtbQxC0TwENMmKMNA6O2GnSi84kR/k1PLi0rm0ljKHzjJq1pWyJMaU/LKWu+2TqKQfy2nqO4UjpJCtWcprDfZUR5elFR5p/HF/3p2+ihiYZCTc0JuLhCmaVjAKGimBmhFJwmQTFxLkwqNkpZOE+5ekOdGYaUkLa4ED5JVRUeD5tGdlLwoO0Wwo6Uu0bKqWnrTUDA9mBAnPXTDC6/E0rzCVFN6+klLFi0mH2RnuySzCtoqphDrutp/q/iqNWOmlJD2TDvZkIiz/Iny8aDSkled/U+I5hbJTGBUdLVKqTeRj00WytJDIRQ8JJGATEBQ1oOhcYACLBMMzjvQUiUcg3iJ7hvQJMhtNTl0sFzgTUm7OIYUChn0Q04PtPQXHkTtzIGRH3gDGUs4aAMuaeQuXi8xRDgJzMIWDFBxM4OlXKYfnkRZIEwX2uTY9D9pZtOndQareJkuvTckRhE7bFJtCtrhNk9ACwpWCT12yorv0mbo0CV06LpFD7hKiGMzqCF11KRvcpVdG9q5LE44sXpdWHarZ+vSmfVp1oE7v0yfo05pH5q9Pqcw+ffc+pdB6IGfSjA3pj4e0RwY0g0lrDHk8tKEYkelvgFNoDLx3IALQKcQ0acuZJscAkKNvRiAW0G8EHScMcswG2b5wBcLX9FDGABFgEMMwuTsM8ufoG2AsgEI2Za+NBUAcu81YZPrRAsigiU+sdUxXgI9j8xlkqsMjo0sLetF4YDAA3DHYTAa5aAPsjvG5i0yPEZhTj3dDHwLTZg0FUHsLZQU4TiSBSFfoJ4MtYbAnYie4dAUl2GH+kLM2He6GnWGwNcKHwd/hbl0mt8R79PhGPdBcPQi4sfxNj++G5W56YDVAZ2n6jNVAbAn9Mgwy5GZAnx2Q35kBOBTsG4MMuRmSFjPIkJsBRwmo8cyYe+rgjUaYHujKFM4KjMUbjZg/9OkwaMRk0HcpXAG1gZMGfTqCSY0r+MboqGTRp8M2QDEgqxiucHLBRDcojECm0RpUvBscaMg5WuxQa/I9UAKeT0dk663F3TLkzgK1gUx1OEbxd0AsgC/SOqTN0JUm2PQJp4DiEIvikGCyAJuCAg+A9cIV/g50qujhZbHPLQ5Ri05O4eGBIMlnv8NYnP4+7R4L4J71+Fo4TS2OU5urpQHjs4h52BbxBJyXFgemBU4vXCEBiQ5DOCsttIAFhsqC+Np2GQQJyrMud1RKutMCT2exk20PKX1GpCRLzA4GV5i/AX2UgL0LV4iV4AvibLND7umWW7jhHiPWxgh5aIDmGvTZadDjqElaLxwLaO0A9EkDvlJYlA4GpDPZnW/xM5hq6InlsFOcSeelA7ojLGfgVYCOQVczZ9FvyYJ6E93KnEUfIDS9C1cwMZNWcblxnQO9J3aFc2hlAdSVw/kWrtBRCRSiOMEcoKQOvXJci9nA+nPtkG1Z4GTwLF3SDK7LNi/wQx2sZyD3HNakAwzU9eiyBAMsGMz4GVDLPWYXtMmuxzODVt71uC/OI4euYW7AmwP/53KAZ4A1j/IyN2SEMPpaYcU6nB8OncTciNlAvy+Hs8LjhPCg0fcNehc1Hn/X4u9Add/0+Fk6Vz1yNt5k1yHtVQ/sqjdAtBhINskq8GbACDwpevh5sECEKyCdcA+LLktY9x5OlMe691j3Hnguj1PDYwd49HL02AEeJ4mH1edd9ofQtcmhjxIsQY+dEtQ94NogF8O54D26O6ELmc9ulBcU3eg5lTHeeCMQfXvAqn2bVo7v8EZArXlgyzx8CN9Tom+46zELXcJhmk6RamxGRF5fRd5Thu+gTU0Pr7yHvb3sxbrgmWZbBeWcqpxMC9FhSTpHCVQgUGccu4LNZiMitQxnQUtFN7kRoF/LKcPfnco9jpTWPFOR7yJTT4UaRXLjhWPgx4d6XlP8kgWo5LIwW2srCiw4m0dFJ5UOAo9giAco3TtaNxdFRzzFuqjVqOUxddT9NyJ+xVRaIccrOVtr4lhpWTQ14ZUCNgKlEFB7jE5J2doq4b/XE2JlG6ut1JMYX0s7yMeg1biLlAK0IxmwfEcr35fB5URauX57YIFx7oQVCDsqBxOFJZLO2ZY2RxF3XulAxa/OKfiliI0Yqmw5s5XTSLKub/857gvInuSzpqzQQkbtayq85Q9rIsq4H4NC2JeKQFU+cm6zSc4/Gucrc7wWRTu257idWcjhun/Fn5+vK8q9plPlyBzfO0sqAuWdguNRwqU4+H5VuV+5QzdPnjCuRminGiy1lJBxkaCbZSn4T7sVla8ocpUbSG6YrL5B5AeRkD5FW6zPdN3wCAfUkaAKJhhiQMcDs99vveT8oMXXUXjNjRrIefjp8jHldyqzbSXlZEs7LWVBMlMdtlHl1B8krNx6jjmGzNhKaU5916n+Rpk6DjO4sbEWieHw33+WLFLSqnEdh1JByp3ROUj4e88BxhA0YcrCr+4Fu5+iC+kdn6nI0iWIc6vbRvUc2rBCoqwVNaY8ktIJ0VE+4EXIhmIX8jqO2ZnETH+napdlQpXyqs2Da8pcohQ4KIwwn0lFPKS4FVoKmyY3Zkd41eRQOVSEMzkojRAuwsT9hil8r6E5BwX+QKd16yk10QqcHvwBpyaGf9ypE2CFBUpOrINfhRih9xsQjkhd9np/P/1TqFwJYN5wVCLFVsGuKJZ7sm5QsIUe5GNyWcecCE2xBIN+zgYRJ2ORp3C5Ez2i3C0i322Od6OOyaEayqMiDF6sa3n9xPR2MztxWNCaot7KN+05VjvJKL97p1q+DtyZkwIqS9BJQyvsA7qCpZzn6et4LYsFJFsdt0FnMR8f9+NHrG1Z4xOUY9NwyP8sqGiEoDovjBw4Pw3en096sIJ+Oqqh0mANMK4iJaTN03AYSpJYhe31Cp3DowizEGDrapBMSXJsRn7CLaJW9myneIa2l9whFaeRmgIrK0N6yqk1C5vWyVfYR4Xb38tQhM3hsOaHDTXhZqMpwBG8VnXe4tRVs8CJruO0P/4Jv1qITqe+P1otjspF5GfgJHIeJbeYXAljSn0gj+Yc4vqe21KT6ApvperKhNpWC8S7RV7AGu7bTtKnbnpVkLd0DLkLNAlJJJK1baWWoeXmzCIoUoav7MbBKXOW29qzkKuKpHnVmjhXf2dgDIC81tKWfxBds/tUNYrnGLpZxv3651Q4ik5StQ4cIT0J+O/r+tx9vHb3okRBVYQiz+367OPwyNMk+H7cv+6P058j4m56S9hekdH8cJYGbXt6VKqevFxY3nNc7iJlVkzaYRKz1f6gqVf1L87LAkNemDqNfuzejyWPppVnj1sKXLiEichR60HFc440pqOcm1JSjQtyUDTsw/byWQKytaoqoyq0ckNx1M8gg2V64Ap6juCb75e4H6duUNrnaaWf6n9an1NTi9u1pM91irWR42BnGdUIllHUj47Tzc5CViuiU8cPR3tOo/9c97u317mgSDOdpJ/2Pa8RmoT8XbXZUayAGyW39eo82UNyOZfhgqYPDdTDxmmQZFePFKOI55POzRoZCAHwGFkH3EKXc+y5bHnrQ+VquqLdvW+kadXw0PHrEZsr/vM8Xla89kaFn13LkdyTkMhW+hU7Ip4eZWcpqba945t3khOXb/kcrXoOtmzK1o6K665POW9s6z7lVft0TPYput2nhCf4IQCdcJ6i62nzF1nEZXlSSY6P3JhrXsywDVWVDuVqjj3DolekTgWpAAZKJH54K84y6QB5ahgf9nqrqyYzA81/HY5vusi6l0SDtsF+QdWjbcBf0yCCbaiBfTjG2qmgzqLhld0RvWfVed3T6rLD8X33Oj9/zQv113qlepVn66hzlATJMOev96D0XveiQWHRZ56dQ0lgOIng3fwKPuD+rKWNShpdiLO0Vb2JioZwGy4Nv2rei06VDnCzZBleWfyK84Lzey4CVrlBI5NyrqNG7DL+z+780oUpqj3hQDuThPHBslxVmEtvF6jEEfAhh0y635AcK+GUYS7T8imHCwwWyIPGHu4ZAMaZYg2ATJD+GAtqLQvgMOj5DMgETJvhnwB+gaXZdgnSYwGLsCD3cg5NSECT5nJ/apcDXkg1uj6jDQCOagCiAsDJA9AFwL3zOWwG6pcMrPcZ8gEangXoS79DpSJxVJYab6y8CPhXQRuZbDK0THKWuIr+Dyoi0aa0kAWRkkew0YN4K7w5V6fxNv+iwbakyfY0bDaLy5mZSj2gDFK01C6bBd129+MUJVobZvKBaPAkSeG+fq8YLWiAfRZU6x0+SjVgR3CJ5Tq3EecbEGcOSGTXIMcOfiPXAJeICoFgZQEHh7EDtkUG8KAE0Q1g4wI3nhsxYgRec/T4bYcRIOMcaXZvnpOyT5/QyBsHSjzU3spkhVxijjoTYXDRplA12zSUeCUOvF8LBg1lVqNaCfBcA2I501PDPZZy37/CEUEaShmVpqcJ/sPpEbtSHb6Oh9PuHpmVyio0ab5zguIg53m67J/BhdAl+6Mq2QfqFzU6QXVAiYA7taV9GhKIoHhIhfSgbYS2EAiyPtNxPq3D7XrjpN+qUQ7d1n/Dn5z2sVnwj3itThUUUsvt+J/HJrOWSplSw2Dqj6RWqsrHoGjfgHzVgATPWhqgmsSuOs6oHqqWTtY0eF0A7Z1i5qCJe9bySXY8DXeHcYKKQUtVgRC5eimn+J7ppovBdKXOG2VSw5XvQYE4Am3X0XBilDqToxUBT9VkiHMk1HqZWcVZBowIz//HhqF/v3Y3VkzqVXvhlnqCk5xKAEq11/Qt9bKOlx/UmsIMUVDL3OP6J8dPdfGliYTUBE+70xJAQDPka/o0FQOjWaswTvMrDKpxCKh+LagfbU9VbxB2fa/0JW9Vz++e78VLUJ6nUnXLCXCc7aqi1lTfCNeBTLSjZO3HyyP4xufjbupFeN49PosPqaKsNG08i1mNb61qgUVTOPPwcHqczuQxrHoMviie91NRni/BMWMH9zC5awNiiKjosOBYdo2oara4grOEyhng7R2w9Q4VWc7BAkQtswNzukPNlfO5Yjo9lUMdpfcpUhPOICDqgZlHBZXnSIXJi3mUDEJSF9oWVL4dihNalGWATD3chJmjx8ufP7t7JArUaJFOMf8PNNp4vH0ev8JBovsrDXodsrH/fe3OW73QFPtbmG6q5O73iyJKCtat1LKcrmYFdbAydI1qB9tg3TVgIm5Qw9eMOR8LTtTkb3jL7ZV4d0bvF2uB5TtwtRylrDmVFJMRAh6+wRM2qNtoUPcCvI5HDbbHG3uY+h5sct6ACQmV196g0B/11t6gIgQ1nN5gZxjKxMHBlLJXTkq3dwkp1KGrV9qHAIMGQw/Fl5ThUN62tJKs9H9aGsGbRFSS+oMiYqGgAIauiNz4Yl1YCsOeBEQfa0puzPDBAtWjWEdoNmsWdI32vj76FBEo7xwpxhMvQRILBUGb++V5DWqD8QGrjK2l4fBF0A++i0Sqh8OD6ungOH7F/OeqGYsMWzs0hXCg43JIx4TTBz+jAQDWC0sxGKO3BkhMEijOeoRZPApkkQcKVwikoEzUUODuhKmJNy1KbGTGLRj9aBjCNfDcN+Z6ud3DLBapUmUOeA4qmZBDK7SQIvgdwRzZIbIEAhDPe7nPZH76DJbJIIu2FM6Dqt2jhJIH/RLaqcoiKd3WDQNKi6ixSI6K749WEiVJS+ZSn8LS1fAc5ZvhW1snuupuSnGxSVa9qEwGSxxfojGfezhWWr1KirZg5/IvFAXQLL4ycmnRBrLKhW7plG5B9bSjmz/JmXKitcbNMqTq2v8rQZWVYxS22/H6Di1vK4qjfD7eBXQJTE06euHc1aevlafvxteHlOkQLI4+q44+vi8mKRN4TqkAFb9G+0/bgZEB3Du2pzxli3QSAJUVsIYfzosMjYXrZXTXojOVtXCYLfcOZ4mPfbTsCxSPWvM89rFISMSX6q16RXhJw8M1DkrJL2rR4sCCwMcamqta0so6S6V4I+l6rGWkh04llMD7gFpo21NG+/fjc/8ZjbGyB5xXrZ87CleZBJTGilRHrqHH2TQ2GlAFM58M4rChp+P5UGwj1fKAm0iRt5HjQuRpOlJn6efO9bIjgGtzdxPqgNZEVlWhhK64lpohUd76wXplLhh6BtfILVsVwG6B/vAwHE2b08LJ6Giptoj3iHbq/Xi7rgxeK6sBXU/LBSYhf2PAPqX2qie9gjvRKEcQVj5Ha1X4gJItz0N35/P1OwZKn59XvTytjGF0FLg1i1kM62J9SzXvLQVAziKSk0VXuiqKa2gce5YWlkL4/5LAWoVNKcvjLEFjaFQpfkOrh5aha9iJPFBol5T30yUWKcbQtVL6KmOIok3D234IQRWXp1Mc/sPGy0xSimdR4MRMc5VJOBDm8BRdkySXGD8JE3M5BEitsSSneD2ZHBpyPzaKeQ1i1JM4ecqOKVU5AunboMiuA4deD0657Ao6sNGgM5nvqX8en2L3KkgRFJKNlkqmodd7+OgT8Dn2sv9a5SpkiJqT0M7SZgbqU3lyK/jVhoC3MmXeOJVKpsjbafDfSnmYV+zrMGAMkAvGZp5Q6hvN4itt7ZX9EHQXaP4oynEWtU6bKjwVGNTCM1GzYhJ03r1pIJBvVB0bMFQNDeXOgl6aI8WrtgyIu5o+J3TB9chLhBfRj+MqWOpVh5Ymd2BEBSIINE1PwTdRPiJJufVOkbZTDas2FPjlEJEXQTus48Iq3sM9xiijSi3eq5bP3MwMA06FnShDYrknZJMhbEj4esqBMMmN8qJrfi32t2mVEbdxRoYXO110jx6VeDKAsJl2cwPMlkMxRTIjuL3sr99l/YyMT9gN6+VymJFaerD0cTafe90AwSkUCU1xT4MJ6EZhY2nQbpJQWFsqMYWpB1bReBqNjdJWLomRpo6j4ZU4NgacVo3hZIx9e/DhdC+S9GOn0GmbD16xlKTZ6fpMLr2521PgRK1nBTVeOBTZ+BLn26hale11+Ccck9HUKr6Agl1sqYmZJ/14KKIQrTLTOHVPEHF6fB7LPWiUmtt4+TBYEDboGVT+E8XEvJ+CyVtFHklF0G4YHP9MPQoFlc/aPZW7s6WtrN7PrzKfPih8Bl8G1917sYXkFA607Oy9rN5RTAEdzc2FcW+ncE5dGKu9qhqnAacg5rjbq3cepCljW/Cwot+p94mL0aPhoc/9WdrcvJx7/9f7x/E5YeH0klH11Fzz5OE1iKw6igw/QYKU63MTayvdFUtxpVVBK3yXqqbnBYRa2ErFKXYLA9ZEAw5Eg562sX8pv8nXdlZQUQByu+56X50eVkZsem7mX+/fu/uh0DytTJ17Xm7yHuz7A1v6MnDAG+ktsHFdIiEDv4BGA1tswOJqMqOxAT4BzOXWgLUW/Ywt2DGtAX7GYHcBIBmuULWHHtvoqGTtj+8Twx83zR0mNwSvCYKAGNXR440czxZDGh/doxzaU4tXeYCOIueSpFp9g8xi2Z9fpk6fJfdQm7OTP75akqajx6rC1oB5znSUbyPLi+w8Je7ZSdz0QLVgEnJgbXCUIUbDKUkMdtOap8FJKKdvqBu2ElUW8TppnwVBTKMmQTXsRN+qWuQU6HHgffDocOCBSgv3Aust0DANim9Q0ecboMhM7qYBAK0Bxy4Y0j32vwcDtDcg3jAUI5Lesda/RXW19I7aPklGxR9RpHg/TnQyxbcWgVdYB3qsZpHr2pPeqy56tAFvkvG8/j5qo1K1I+woggcC7qdbYVsPqqKRFwMnEcHMmNsJFiGfQVEMtJQislqe1CmYwYimByOOC6QULJrK2z6nOFGb1oB4qdvel5qMRZ+6jTp1KUHHR9FGWqpz0GOPyf4bU7XemMJhIxqhgnzdNFCXaCZgLGr6rMtBuezXpt96NIHwqBtsQWI1AHPToq1Ah3xln5HyqOkDabQDr5lDqxAn+/XkxA9gryA8dMDweFQV+ly9jfIpYIJchql6AP7QIMR7AAjRBsC3FNsSvtEuLNjzq6IVVBc5h9R5eB3QeKE2sqPQl3iHKcVSIcVUFjNNPJUSzhM50qQtNGGCDKpSr62UVlU80vCgiNxJ0nkmxyli37LUi6LU5/GgeClCE1LC1hOcz3qTSVoo1ED14NPpaUYoCosNyIPuyfaYnmDFI8pPqid6StYNO6N4+7DbwMSU9jM41nNyg/YCr9+1ZMuRt821ium2QImnX4EVmCaS423/xKKjGJO57fYlrlBRWaLEEZAT19OQV5AcTeOaTTMqdplxw2Z4xtQIi3CrYkZDWQaDlH1w+o+fU/CuwNcpAsYNuyHskdP5UH8Z+RgNjX4lGXOlThELVTU2fmtCJhn343m3NqOMoixvaUPQLEUZG6NUl3YE6AW18xaeYfhmqITAUkDPHtekw8bhuHO8V3l+nIpODGapDC5uqkVwTBWmi1G4VYeubA7IVdeCFoCjrPMdJujh/lqwZRlV/9lSEvJFzrFCAi7Db/1PD7IIeL9fv9ZHnwrJtsBwtMi3ooOW6zaXrL7RemYVVQx6fLRCBVncZ2tZT4GZmCV47u6F4RWTeGqnb07M6/IsyHmMV+FBt7kSE00q0fwqserRuNC7bNPQTFIQv1IeqlfqmLw2CwyxHdE9CV20XANDq8GXbVAlji4ortlwGJ4L64Z+O9UeuzVbb1KvJRmUEmkRyEEjNtujzRMnpIryJwftev9b17mtOkA2PmgqZF6vXKUswanfotaqzb1/tm5wfH8PDxrsn9v1fNoXGIBesZ5vWC7HkkhiHNWxQlNscexz96H3i1Ulm6gtM1sftA4fblVnhn5LwIRJq34slePaUms1YNogO0yEM3rD3vi47woYhOT0NrzaPYz9PMUg9v6z+Aid+ggb955GlIrHqL4KLUUPhfGrmhdjFH/chuM+jY20gufi7rKoLfhuG8tv9eCqoMTTyPo8tIRqqpQ2beYxj/0+PT+Dcbb/Xdy/V/ffePSgrHfn6U/1kaHgDxRhOAv4XeHVVrE7v3VGbhwXVva3ccOWwotSis8wOuVFbcSgnnP1V5Fe65Uf19Bi3zC+QpEqA6pmy2+ZxsYSipUfWti1mT17Q9ixiH/KlWCbLWe2qnwUfBqkKnZE870RUNcRHEdoFRsOWJi3Pseg8LMtpyM9zqUsmGwkutxtv9L18DofI3hFa2VVKMOLbYKEy/X+NeMHq5V5VibY3LCRo3husQZZWZveUvhBlPJ63l7PNZVbI5mcnMmoY9iPBoVrFl3v0JzaWZzb6I/rFjhNvEL1NbpvOkuTdfExV1gbPyrSX0DDPC0LCmKCR/1793F8HJ9TwwgVE1X7a9yIZj5n8E61T5hRBO4exF7eoSLOpRCc5ySk65sUX6dVX4cWMkFOxZ7p1VG6OWlRwqoSRp7FditcN49PPnLhoym/iOJLJynaDnGqfVqDfutop2ksGj17xHHBgha8Q6AkEf/2gMm2W7ZJfJTZ4Swdfpn28LT6ZxHxvK4p+hQdkN+ycyfzVlfJyDzgVoTpdj/92T2Pxenm5I4fwGe+5T7Via7FBhiSCh8pBiSKeb2Fd1k9juQXQYOJrSVy333XDV611LcCAahgXLmsiimF85NPMiKa6xD/uNi00lcN58xPMqIPs46hK5QkQjyAvTiwD7p2K26V7lD6YSo77Xta2DOJmNpzfVUiJ0FBqQwgLS2axVDSf2U1ov22Q9NtN4DaAw223YAjakCDkBEtWke4lnDvHbAWboSzDu5IxyuTpqefzazjmtKkU0igAcegowBZIW+1AGWJjt90u1bmie655bc8vui2/GiiyE87UN6bKG0+ZzXGRRIRJrOC99GIUiKP6wroM8idYBFEtB2ueBuXKDQ81/kYdnrJCKQKHSmEbJJQVv0r5d3DsOm3AmSx2kEfq70KQXU5m7GxFZdq6brXM8jaFIvaFOsy3Xdud751aK0Rr06W1Lhxy6N5vKZAO3PMpFuQA2vZ6lwucoQYbZg3JjdBa2txjHDYq7TzlqabgADFjmxl0aHptnREOOgjSflqubRquWzM3SwgpoNeJbm4oiRxqItwPbpE9xuYrUlxfx9PH59lhFcVvGy93OsyEyUUwXcV8vLtpgBNKRcmxqqJSfq63wqf/jkdFWrMKf6DBpUsBpUdBmafTTFdg87lxiVaMQNKXoMUfFCoSP2nY8e0Ce9tuq34zDzbx0POopWmvSJO5O98vr7tzlOnkMczIkU+irZ3cte7jtsCMUgX1nYRq1DQY7MkGKvDj8fD303mBwWqdNwUuF9ft1VlRy+TaHYjcPSqwDlVcqDjOKZ57EwQF9MqxZGgnHtKjThJqZHMKb6IjibfZzdefQPhwy/6GbGRZEvM/4J+dPl5iogkSFha4GkvgQ4bHffQrS0tbNQeohefhcOE8hp06EybasBFkpOMNgQJLF4CDDTp8XOjCJBz9jlkkF4ZZG4gzsnWYLrIpFfpIhNTpSmDG577rS8XiRocGBmfIhc+JV/hPqIlqUf/efBrp2MVHNOgaGvTY7TpUyLR0aa7w6Zv0zy3yRpo0wdF03ZAZ0BUi06qYEjsktmM7E+XJrNL9+oSuKhLn6BLb9qlb9GlV+7SPHcjFtryE4ATkF9ClyKAR/r0uYdUHwjQ1JhGjRmqBT3cwJ1vsIDBRhaucvNIaP3kKIVljYaSWMZo4m7yijYge8+LG8hpA2y0Qc/ncAucJwhGWfRDdAhQOFTbIhJknOiHiOaW4D706F/v02oJ5w5+1uZABn4LMBuYjkwrtm2agxatX9oeEDa8ZYdy7Q7VqR3acHaYyQ6SsYxMh6cCQWG4gmSUqHaoHOgx4zCdTZ/2lBmarGIaXAFshzkdsF4GSBnAjTsAAjhghkbM7gjlNwICiF4CBsXUBgzlBrgLMybYnUVNpAXjngUS2IJxLywhiyug9DOuPwWvrO1wlVaEteAnRITROsAzHfLWSIhblzvvdPhtbkyVKfLAaIh+nBY60/p0GFhwYFpoy3CF3yJf7sHr7lGf4NMatx78NGhAYMGkaaESLdaubTOsEvdo8UZAN1iQqtoOWDWsOtul48n22V1ER6JMDT1gDoakS+xgcQUQ5wBg55DH4n0H8I4hHmYRkLCjwaEOiCf0lcOKcAYVtqj0CH4RMG4Ijlh4TQCyOotDEz3xwhVGABVkO8Tq88GLgJJNu8fhAHEdAKVdQiiFBYaf4Zk7hFM6AF6x9x36j7ke8noEdHrwvKK5b1i66fzF+3qbz3Yc7mDI9rAyPMyMcIXfor4Mb+4tjnag+4ICRkS/yQYEgLFA8reZ+zXtKA+ySt9hREcBe7M9+La7bxKky7ouz8FSszBkEypBnU4FdbYfalX2NEgbNyw2ZqXXWiuOytFIzL8Gfp/FArTohGJhCdk+Ey8hhzgAvT702ISIcYxgAR2p07886PG/r4ILYmhU2wXLvPYaq4wqroTiS5acwaJssomKBdjm5Ym/Q/mjowyc6TGmxoIzGf1rVQ7QywB5mG7moc3CYohQhTnzWDTZXDYpaImW50wmajJwk/W4/H16s/TN0uGftlz23bOJB6h+duaXi2yKZAaH5QI2BwDNuZsqSuKw6HDQ5XNpueig9aFUAeHP0d6ksdCQBL1C0jcFk24mEQaHcPqVwwUw+uCwRBls0jRJYWZAP5htoJdA65JsCXQ1Ql+LNs1Gm7QyAIvoeNFiAacl2qZpadM2bJNBjOREm75p1+AiORXJqkMkt0sWRpeMMTRWgnGJ86VLeqNLHwWHfYebJkWMHqp9Wkh9Wkh9MjT65PsNac+CixxHN3rCGFh6BgAFA5ZoA+xX8E3gVZjsm+Bn8HAMJKPSy5hctAImDiOqROGR2Oyl4KrPVznqBe8D+8mhkQuWsnEtrmABoxGVAWe6QZFJMGJz4hV/N8APwQhYeqbN8TSMaDt4M3ksLO+ugS+BmQQbY/BS8Fukg7GMTJerL6ElOvh7sFQMllA4oNDgJrPRIG08wJcY4CGi/5BBsspgKQUvJb0laKrNAIU3pIUafBN4JPB/0FojeCnQaEhro7VaMA3x28xrDo2HekUL9KqFhx18E3gkCNcYqEST+yp32TcB5yT6E2JdWfi84Qo+R3r6cMA3uII3g4IOeMQWqtNCZVq0P7MI7VgoSwttaQEBCFf4LcwJaEwLnoHgm0Ae/CQPPwkq0bY5jgVPCPW4Fr62bbMfAp8DnrPtwC6PqIoFXXTwUhAZg2c1YA7gEVv0ugqmK37bwl/BPA943wGFfuiEFT4lfBP4gCMsdPitDt6qA8e7g0ZyJh+PyE/YpP/CFfwQRPQsKhYsit0QEwxeSrqvzRgkFMDZtNodDhCHOJfr4FV0bb7KyST4K5Dc5aI0FOj18MpQyBd8E4cr/B2K5ywCkPDKPJoMekSRvPXZN4EZCN58vLm3YMGA8eExB8FLSVfohxGuYCaguK/NDBrwpxA39B1GdDSHtNiEFbZmJ8HWnrM4zBJWbBx+UJxmNM38uSv4H0Q+rE8bCN3lgCk0eVvgULHZcc3FYwjchats3GXaqxyNRlUmUAcOCwbs7M4DfwCTznmgN4BA8j4TnsCpREDZc6LPMB/Bzj+cVvVIqnEUJbSch89e4grVYRXT9EA5d4OQSrc7iRvg2O8wdgVWG1TnBDjZFlvYeyz4FuH8lpI7h3t8pp5GdaJx+Z68V0SU864hK6rxmOetdOLQr92tGNursfjsFO0bpaxbuMTAt4Jrb3yn0yX4hs8CtyK/08Y6u90jBrVWuxZWioonbL1ArWDWWNnGxQ0AmIISM1gFyPrA1xqS8nRD9rZwMMCYciMOhhGKfAS0YMRxgJCvG3EcjANDlYR3qVFnq+7fHWXTCqMrfAMK803RzXMpZSW4MqgSVU+zuLOAYj2qPDzPnlbqOK3scZeL3nndQJSxjWeW1O/8LNAIj06yR/qBIhk/rzrG4yU/uAHO2XcUHPP5/NL0l53qk0oB4XFcRC6sNF4rVYHhTSWTgFpgzSs6K9rnM5JuFNPm1LTRRUMIkOR6bygJzRbXh0Siet5ZDSJqJCbBIpRCuPkRhFRmr5esydbybZuHny6311PLaJQMqoafsaZ6FWrsFZ2ko7jVefjjFmZAsw6oBqaOlszE8QXxgURjWYq5mAZOkcUaZ7/ChzuK2z3tLrti+Xm1/Nje0eailYHwHsnM3L7LA4iAkJOFyW57YM74YUugaxqjmqJHsFFMdkyQrEFC3yE55RDJCq4H+9L5Caq0Ll4dF/CvDQgIrKFaPIuuGjUK/UyhaopSvyg8UvBVymQoqBaOz6/XOTZYKiVJakNP+amEpAo8Sh5tmbwlTRP8aRDr5woXJJuy/5X+Br3bseocgs8OOAgHtIN39EDOTx+Ngr/aPFNE1pkMhuqoWViw5he4fmW3OolvHyj9K5FUsg2qJivcTSilEVXcSX4gw7sTbIgrH7BVxUM9pYo5HQS96H3dTkg+mKcU56dDWQ+peDbNlsq5zSPk2FYVMVM82unjcr3PqbriZFRdT/mxNAt4v55L885YRWbdU9Pi9PX1ekYqkwQkv63LGo1RzhaPNEDY0h+hpC9ulRS6SL5i/4vr6bCvFa90MrtnOCb3dNmfX4d4ZN//BvVSYNyNSspmjUGfifBgOtlJwy0x3ur48Pe/TodfZdFAoybF0aL16e+Ph+l19Kyqrm6O8vguAmq+tFHVlY4GHmYRxUdVvPsbp0b8+3KPGUUF6gZ+qsa/r5enyRokx535RYKsY6mwQ6suNQM16ae/r86k09W7mwJi7GYfua1WzMhGcWQ7R6tDIYf1KTWq9ZCjpv7p8q6atPbSL7Pgx7BgRLToN2rRktAa8Cry9uSny9xIvKDtHBStd4tkRJdbdQGE0/NjNApf9XN3EsbPK8rj4FO1Q4p0NMwIqNpIy2GVqNp5qaDvI6VXgZzieawanbSXAxjG07LVLFH3JJGsNGMGbyI1ZzM4Esk3XqaU76Jfu5Pn4piCtWbkJuLl6/gVzBfetkdqv4ZGL4LjR8D8zigue9rZY3IdK0XYVlFqIWqF0gWHtIIDcsGBltkhmeDAX+gAJ3Sc5f90mQJZyi9rVasMT0MalYCiUXxB3N5gTO6KL5eiU8TwWjREVrSYlpZkraWs3Pq2VYS7NB64ZTo6ebIBKQigYDAJ+e7XUmvvqlp4+w1tOfWuOpwiF/D9GBFmc/++wq1UlTSbb7sIW9c1S6XieH3MJOSyO/8qaAiDNpBeX0eZ4SBgHZjyo6oGoQEhiFh3pvCquJ8zniYRc3CkEiNziiScUh9OcoJuyTQAuXuHUlSqRobvaiGtYM5UGQPLPbbHrCdXkWpFzzvwI/RRaY7UqVjnQAtkwuDX8zP6ePtYYK01pYxz0+LYKOEHJkk5k4jcNFC84FZFkTUSxtSwfdSIxJ2m9OQTHn5yuz5Oz8KYVK5Bx4+4nM1j4SvVbH6BP21LWpVStqo4uefbezO3qJhPuDP9iMf1KmA+KlenoQX6pyUzuTQP1FkL8RYbm3uRMB902nuUahfYA24TBkm32Kn4krlGldkq9wXtUnp6HL9uTzXQSoOrT0sU0U7gEwaKfw1CK5F9hV+lWcUwtloRqnw5bgo96qV8Sv9TDtzTgwbTpc9haTnkLOAxa24tQGpIx8/BmFKdmG8LS1CackBkeeCwPJg7PZg7PTCEHkTbvukwtsfPYKY3QJyYDCYFiNSgYBCIHY+wpzeoaUMdnzcbqzcdc4Q+0zSqjxDvuXd6/L5cvy/RqPlzehZlrKrn90iTUadHLB3Vq6Z1ymQFlq5t6Nn/CB7B2/F+fZ+qUbXFJg44vherlAlmUMzXlHgwDyfKumkUAR5lX82CKgwiigPP5pwE0NrAr3Tclnhcrmp6VMKTx4keUwSwpnxl2nDDvnuEw/BZHS9TzpTOKIy/n74KPds1KhqM+qOGh0Yi9iEYYkWqv1XkEVsP8aq/wyDfges4HWqqLTlVz7ERMn9EVRl19emyog1RJsoIEwgLhiuGBOmor2InF/GCjq2LCU/EWLYU7SsQdS4X9eaqXsotMt+hFmqzvYKfUKqeKKFMCsjUkmlzGSRtgRLt+UhGEkmldsXB10nD1nCG1iDjtrv/V9mYqgPa1t2nka/bYbcyMuWZ1XHH/fF4lR9IzsGynVrasDIKuE19qbX+lgAGHl18zC2pKwaLSjpylrTTI7quRcRCFf3zcMFjRaCklibnrDg9/uzOp0OkJllFrlvlZ/aUfmORkZr4KXNF0bTyFiynx/fx7fN6/R1rVGuhU9XvxlMSmknO3KmESBpV5RQnpzrF1mO/y7yMKhLj/uVznRUfZIGZbYGAB9bX+x5QywQY9a0BRrYFoJAGzP5zPV2qJDOtgrL0lHI7ClitJJXp7qlXW1LVql7hBsBek+G8PQVVRFm/ztr2Vn2z/UCNp9zQ7UFicAoByldAFDS1mq+mk6QF5OiejjJ+iAh2qisHNXXqktZRwU41H6GGahR3Plyu8Vzcz6miIG0dzh684lmmUcYoj1OotconbenGmaUshP+1aVeBbE7iEuWUVDxtpxqp0DD6f75/V2EtTsLxhpQjQlF/rlFoqddfcgtKXxRVEWZAXWCu084QEA9Uv6cJ73Cfagi1U1i8gfoPFR4elY7hoZWS9nlQ4LEWlSSoc/KowvcedCloX+R5m9Jwp5g/r1l2nTx0DIriHe/iG4SFI+yVeu1Vlt6oqMF6mntKkuqrVyUq6SG2amPuFE4EfrlpqPF73l0+XsX9ncyTDpSV7rx7TP2xdOZSHZoAJnVozsgJic67//m78FBX4Hkys295U73zoQSHduowYOvxfPyjp7JXoVVDkU/n01fJByZv6XrQ5/fIeC1N2qvSLprJXEYqObA/DlsqIeJ+rmEDJLbTUysvCkr+WVW5GaeaNW+9R3iMEgw3qKhYKnylSIckZXmgibFL46zl9HT0cF3kzK1z9AOpBMkP44Pf8Sj8Bs3Jx06ZOJ7131UdEkxL6RVKGSuImFM+zMZ6jf2jY3F9SVnvGpX8RXivo6o1ydJgOrn8BzSMQUGe7zbmKcoLzmUKrVXma5TvGfxePl+Pp/ZTp8zE5Vi0sVetpw3vmnO+7ooUjqKgMNRUiQNjHivWCzxLylVlYY58fwcZkejtePmjhlt1fjk6r9f9WiE4Odg3iD80uRsnLdpKAn+yWOVp1NmNx/sde9pJo/D+Kgp0VJss3uZ1TejXqiYqHaqCe9SAAsThHZhWHKqZ3JivQGUA18TTVFh8khmMqBW6KvJwXPfxrhAqe+gcte4mEZGDZfsjjeojUR04C5NGd4kXUzEoajNGQfUurvJwcDQGGMcX8M5BFW/xw+2qkFC97JBiG5SGo+WtbUDU1ICXBS1vraFeabjRr8mgKNoHSsuwoTGa2QZSx5wYl1bvsv4S5R6YCUAYlmvt8TbpwdEyGyWloJyCukazX+RYcnlfUuRJo6M+N7khqB1HmzAUrXZJDvgNQGDQJewcaGH7lE/qM8fKMgr81CidQ23cCN6HBlwG4DEzQO2ZBsW1yEIZ8AcEiw98e+BzQHGEAebeYM4MiIANmIANqIAN+M6MA2cEWAOMA5AOFCoG/CgG1fsGvdgMqsUNIkPhQcFYhxE9mDH7zH8J2BoKPwxKSswA5gkgfQyq6MNBB44HMF6gZ61tsLgarC60OAjbCEwM6OBu8rpElb8F0DHT2WQ+G7BgWYttacEG4MBTl+tIHApnwPVhQWBkkVSyLRjSWjwLuCuDE5N5EADJBIdCl7ncUKANdhYLdjDbZ1YDsD2AocWCN8NiFVuAGh1UkzOZ1SC7rZlzFJw94JsIk4FCbjCagdbTtanIw7WZ7ww4EgBPHfgUHZhKXJfLg8CcAKpNB65Dl41BRC4c+Ao9erF47B4PfiIP9lSPPeMzIVGubgFbhvc0bUmdzE7lzBtQ3jVgv2pobHsWyrCeo7LzaF1mEHLSOCU1ECl3g9bqxtH45iQs98tREDnZ0TB269oSUYlQOMlawCuMp+ErmKiTTPgcYxoGV5xydWRTqHAYW8sy9gp2xWs9w/AwbxVjyas6GENDI19liaAslF8IQavDTufnfXd5TLklfWfZqyV8MPbmQcQl8e+t+9wrPgSQDjpLrb6v3WVXGCNeFkoabqeFoYcYPfgb7NdzAUx08m28oX7PqphO+kseyUrf02LTIGGFvQoHq6y1bSmGLAxOWZLndd0BUvVrBYlcm7F2XYYogLtl4+PfVk00JAg4eBr8K91uuftFLUwidhwHI0UxZZupQWXV/cZCuYUJel456M6oVmFtzsvnLtfJFnEdVWrpPqkvZ+U2Xn0WfAIwJ7RgPum2ls10m2qSzCicUAuaFfApOdA9ujafiNRdCDebQsHFt+/Vt+fb7P77cP2+PK+xtr5emNX0KmhHOTKWXu4Rtnq9n/5nzvbUKCLk9uFgzkXcur+owpY1uRd0ssKdyZ00YL8YirxY7jOBuWmbgk51INvQn1lWBSCmukLS9iEQUsFWNfLodSZ3X984TCZp7M0Ug5DjtbCTmHVXMqPsC9ACwsgHtZUBOZnx8DLB+mOQnjEgHTMLIzx7mPuaiUOVaFkaXp6GV0IQTvWbp3HGr90/h9d9FRIbVe8GeJp2oPiwICjo7PPx8lGqCNXmxG8o/SygnglSDdZolnZar8FyKHFBgwIp0/ZAc11R0EP1Z5Daw/PTchKSAkTVzhry9Ob131+RL2AB/esYt8wxm7aF20uBb5OoXIQQ37B4N3m6UaWgpRQi5IrlC77oS2qUGeW33qCiRFS3stzdIAVLkjfUJy8B/G+g4+tTyAdk1X0KdmXaxzY5WKYD6WJ258ZEROAbhEMbQHebdEvfgCIOgYCwkHEFOjg0RwjbBbBfQOVA3udNegdv4OwhdOANksOGulk/ZLh09+vlbWk1NITddzelBKwMPPdcL29CaK0EI/Q0Wpzhs+sUlTysU/wF5ldruUqZRc6dI/UzjfKZqJJeBNT4LFQ9CKxja9ocC4KRBsIKsJC6kUbdcdPX+4plTJ3eLTcnFhErm8zKfAbvtbZlh4ulBZ7Gnh8vStIKwqMauHUU4xKkfF51gatUe0PmnuUW6iQiGMPPKm2XcRJ/6jcMzEnO1Jq1XronXUvaLH6WcrkmTDIhdnIqv7W1dYK0ktGpU2PBU8n1++ny39fuXJYDNKrFquHDy261gzwr7cJVzAbW51KelVDf6GlsbeauBUer41/ueoi6adPJlMzqtHgiCXqcypKTRgZ3HE6DcIWgJ7ejotTSeVatBmib5XlopYN7o6wVHDUO+dENc2ySWc1yST/E83T/LIFwDSqDHxXVAxxRbGmHlh/B+MNv0RYDwWY3YsQIls8RjjnoSB0C/Y7X6c+Pnjv1lY26R7UjqNaaWpdXSvfkzux5PALDp6avn+tErOKl8T3F4s2SFpRo+GeNIlPMYc3GVr2cwh5dODyLbzoqsg2KQvi6/jkeoiW6i0CG81+m+mTsoKHx2a/wIDVHKAIv5dxQIseLm+pj3q6HvxXLQzVlpFnZRcaKZUcO7iiYeBm9oQYlmJNCEKa/kKMUgBuFa7FdejosQcMFLn7Tu5xqy22ikJG1OamFkAflaIk3n1poVvhSvQzKeY+uG5yy53L8XiqZKx5epyrmh/zA1GYN4h7H56vmLnYqUD2Apn6guL/LNXz9/e/rd0QSfZ5uU41AaZW3vYIp0C6qaAZch7crsseeRhmDbfEeJotaFoqqkfqxEjStznavWE5pGEmOr9ZkSxOhp0U/FTE13KoqwOhpkLgirYyTjU5BYGkdjhQ1c/a8FVgvCe+zA61hlYIiIvVZipGQMQ5orYhZ2dyjLJeyHE8qZVXdzEEJ4pRqUlANDifPQzvQiFlFTOXdvJondsD/m2IAuQI8rQWvS1o92KBe0lPLQ4l7vVVXlGrcTGsW65JKzOWoNvJAOWaktBd7MlW4NPjNhaUt3U7F4wda6B6Hft0iu93lyb0mqSEN5SAOsnh4X1p4DazNBuzyhm6b60SZEZ+qmjVU9XEU4joJIa8nVYHn9kAFKtx2qlCOBgvnoZVyWaN4DOnZOo9/nE+F2d/20qjr6Ql4fX8vTEtVyQ8YV0fp5iPbYLHARrXAmJKJA5e4bQ1pKGkGDa+ZjlIotaaqLqEEe1EEpWdSMWTArjq6bSZhq5LRXqIYrKXuw0TdWGZd5Fk7IO5KIZPX34kvmVDbWZnQ7mlIr7DyreIgGXOPPxpdu5Y+u1Vm+pgbcFBcdq7bitbDR8G8JoESAy2EBvW6DimK0wu5ARjd4VMDIUbjXNuc7rK/NdpmWsC5cns1FJ1bQLKsQ9tRlxvc0JOsfJB17E+SIvLOEVkOow2XKS9H4ys1ORX+cMVqRKMjEDYVo9cCiqMqIxqoBTlHWHbnNZGo1HmOcmdVIjSdlRlRRFKsASoYbTYdB8gHN//jFB7sdT9XvVK5zjPh6v+NtNIWMVIfeRpXCjNOyFslGtqNfP9OgDKaZlccppb6JBmWVqZ/VXQIPTPQ1NoBeOsAEnUW2A40TXU298ZJCtZZ6oNew4xExim1nJX3YWiGLlLBSMREERlX78NFHO+/Fq/sF1Hyis3NOMo4pYWtoH8q4+8ol9skhUd7FcGRcTTENInJqdM55a9se1kjQqEkPwQHnCrUBpVmm1MbNEt1292DrXasGSzh40mTy1KoYpBxLKLHjWIiRiGB89Rum4UAP7WeKdUegUYZpzhcZL27FearjGj5jobjxPhwQEda+wL7oyreaGRQiIk8HcHxKDFEit2QxkCEnNQBqZCjSgppUYWQUyt5DXJ0JSA7UCc5jECqVcwDHXV7JyFxWj5XH9nIHKOnSYtJwvv1/l2hHlMVr5wFZRIxFY6uH6JVgFXOCDfJiDsoKIoSydM2CiVGgdOLjLDaCndHBo83l8fKvJYm/kjdxGnsmjSzVeBQXsA9B7wP7/vzKSbuNRPMoLgaxs3VVOGu7dVwGhuahgf3u7aMlBu/uUtBhFJrHy1fxLa0HUcUFLYmsTIH2REh2MRbU6qllFZOr8hR3NaLRRx+VKLT2VVFI6nuZTS4uIj6c93v3l7ngorLdCpL2NNS/ShFo+ClOzFsLFLdbMhLKK8x9NyN426f913RYmdQ8Doag4ijn5/BPP/4DOf/rTz7VVFCT8tO11IqNReKucj0FJMvhBGQqyKtW9yybUGcSFtFsGikQojapHNQiW2OoRbi1hlCtV7cuLGHHpGQSPemVHQeaB5ueuA4gQLzHN+XJP9aA0q8okzh+A+I+MnU1Vk7CtNeyVtZuxpRQil8kqDToXAlVcVBeLOfnuR0WDGsecW0Y2nGO4mYqmZqxSe9NJV5h6qanFKP+l5N8I/zsn4pVVWNPq8GFXmGI+aS0NUi96pg3KaO5gbNmiPRXbpC4aIdci0UePkbPAa8ARSTBS2DK7Q7btAwuNnYAYWVYiWYuwPaMvfnBWKtSy/jwGjjUPjqtiyEWm5cggXQRdyhi7hDn3DHYWGT5JrXY+Vp7dDo2Y0bij6LWkWF4q5T8vi6DVKq6AjFwBh0H19YQcJ2DE8IamnufWVQSlN2SMG9Af0gfC6JTRvBgjbAwh+1Ha56EBcZmmmNT/EWDvBDxRWUVtCG7fD8/Fqvn8GpzOPWbFaatY4K79yh6Xi3YYo8P4sojwqdb+y2zxqMU9U7tBTXd9v9XXF2GBnccx7tJjwNg+TQxfQpUqCntD2ka07DeAqHrmwgVVFH18NGFMU0yi7OwWnUTHc5/AzcX9JJtkOf+AH10QM/qIoHWW/5RkWVf56PIsqgUjQO6Br6pd/VCukHtbx45Oe0p6w8XjGDGUqWf9N+X69evKHA3ttJ03d2VrEzUW6/2+l2fOzej2fthKi+u54jsm/n3ekyE/rNWF6dnlRJPjrZ15+tN8k1FdYznbzrhuEmnybIoDN5PUytQIqAoKKh9amQ26BOPJgASWWDbz6YAGioSBPD+X5rRkWVnHQ8+gMRcxRcy/BKxsbUVVElfatoVAGs39iE10PRyF55dy7h8I2joMRJRGE3q3ia8TQ9Oo1dkxIb1ZoAOTxPcYBBTqVWue+VYqY5+zD6v69rvVTBWOW+cdBYEFJ5EalHPFep10PQgc+y+raXVrbdOFmuqZddYmaqvcmgjm7ORbpIUy+itiPKgoAcNzhLjAPzDLhjjAdXiU+nj0EJimm5RxzhqZokulFnA7ebr/eiR7Z8AdNjz4P3ytBGLrGfyT+FvjZKX3PtpMNpVqL6O8ovHYdtm7FCvbW0EOUWS3cuh1OU8r47nSnmR5YKeMMfK/Ku70vW7bZT5M/c90fKsAIVViTUCScEwxmkNy0tKyAJSSfTDAOaB8B5dD0tyRASn9dK08xG1bPzfidCzkwarpWLNMbdT7MXPsCvCh64U3jvYesDKiG/VjzinYK2cka5MD52gkkEgIW3Jl9pBK1LR6kiFmkRXUIkqqYawDt3G0v/9Ccs1P98KzZN1WN9oKCJ2/0aY4IRQazPVmlXGm5lLcNXJQe9gjEaSqu4CKhnJOX3sTQHvLR7uN7XxAKqs5zvKTZiEfG4lpm7VkW8uWERxt+e1d7Nck+maMiQAkcjRefMEqvWuqKzocQ/s4DpkNbRMJU/NrRufCFx1I2crOKj5GmE+/V51RNpVQqUx+AqjX+dTAMMPD220UFbtikcUfiP4lpjUPiPjjthamA1o/C/R+F/z0MAr7fzaR+s3qnGNTaaq4JiVPfITVGrjS3bgfPvX2CoJANmt3HHHw7jQR7G7N6rRKOVtmlP/a1p3PNaa3XQK8rsdEbaDlc9NUyi1DD7h3eWS5FxEq5mtoxmda5R+pJJQhXUYazMWjjeS2RFe6COC+5MT+O26hllhx5a5DFJuVyfj7A+HrGwkdlYUuvysrdJ3LapJGGONAlwL8y0oVWIM7DMdaDo5l137rtvUuGluHaoLR7GV5mCw7muMGeo9ecZ77BiC0NcGp8DzQeHcbVIulWUxxy0GoY/ivs6dV92CMaB0ZWq31xaNR2NRhcy1tE2qwyuju7WIOh5jTufbXqnNj1dDof3+oaVZ5Kj3aRizFDHG2TOh6nPOCr2jJlfoEBsKBbujXUMGRVzXhWY+Z46x5OQ/X1FLaew7fQLHOPkryqNpVnqea13BTyna+2WnZwqgi21cKOkGAcM83DcFZ2EFEc7Z5yIIq6X899atkZCd0aK4o4Sbrv9793HsWwJEywO9TXo2RxlVHIEXvnnvPY0Dk9seVqAZqqngZdtgIl8B0/Bn8FLP57+HCO/t9bYqg8QWFI7MKdyCoog8nSLsCS10VSDLUtJ92bCj2oFjLL8qeccwwRByJOdhArhxnVuKWV/LrAwQZRCOVG0cRIV9vwkqWbFScRbt7EFIYlgnUYZDrEj9QeSJF1QJmMKYTA9zsLggldAsV142ih1GhkXazFaYaFoIRtGl0tdNYj2tApxGn//LsZ2aizfamFsLUgaJDRqo208/assqrLKGd747u/340MnhSXEDqTII4XI3Y8fxzKTKR0e9LxxPXqnOupdT9Lm+on761wU5SgGo57mX2YZ69GKXIrWAqUuIwUblqJ34G2g0ugy76OevaMB+3n4nxX0U/kMaL1ieMMTKahsVa/izlZllCiqIsmr8IXKEHr42lx7zhKK8YPqK+Q3tPc8fMpsltPjlcEATmWz9AevizsWIMJg58lN4xIkxyPP5j0oujyNaC6S4wm61keqfbLbWAaR73ZqS1Bk+ttenVXcoUgSHr9Pt0KCSqpuHC5zD141z1YFlGg2MY1d8z7Lw39MlGscgRMEXf/ojSQtGHC7e873NYvYnc9aipiEnsa4Mbbu51mFAEKwyXcUdjELfNsdKuARXVKzYV5GEQSqb2WKuuee6yRjaQ8efnEv+rfEdgFS3bUbiyQIqga37ajM5cTU5LsNvR2FTSUxOjWm0u5oBeApb/AsKDpUOjAli0lphUceXIS1pAam9Rjz6FTWWiU5VNR3bqAQgHtsSR++z/SnSouoWoqWVgsH1zpyBMWflSUMqpRiQ+nHvM6MJF4bvDJjaTd28Jr0OygOdZKDjx+UM67f0C2syaJpFcAvoRZTpt+CQtF2GQ2UiRAzozFNgeh7s3CDBPXZDUuhKmtV/9io/jOWBmKr8gjsUFXOb/g7P7a3lsWZvAOeFlSPGcmX7CiAvyqpFjmS6osn6Cri6shRRdr0Lz8BSd0qvTjQpFClaMXI1Ibrl8XcprSytYnEyfLmCYvY42HNzCe1LPqP0DTaIqgWyJV5A4dHQusTR4t4lyboxVkdkRcyObhxWvMe6ioF88P949RkDF+RHJc6j2/t4M9NVvcl8mWw1o8qw9ZsvFaQVi1/UJ+MNy1UAqoAfIVJ48HmKOdHxgZ5TG6cClHUGnyvihIAuLG0fjZyLpyDhfaY3nDFqacq3ih8YBGyOuE6NS8jBXgv42l9g+pmZ7Y+UxRDCQIVTQpFNy9SNhPlygGguNxFkrZ5O5lvMTynvQx+fIbDP86Jnlclg+eMKiyRfauwBhtW3Dy2zj6sQrnDhh25cH6X3UuNajzQbphwnDRcMfb4zcUVRUy9MHRETk6jHVMy244bxunS5E7DkiUfQGpagMZhiDWg4Rcwby4fPMmuSj/xKAEZNxzM5WkI4rNXHzpJNuhTlxu/2fwkGw4/a/CnsFTheTdmb9J8Oi4jgW/oW42qGGvxuI6SQ/2kUiW1KselJCnP68QTXdS3+1FVLW9N0ySlkjeWAWBUGg0JJTHAuEZlUjggU8Z+3DBItJHTq1CxRR+JNvX78/1GjOjxOpf0AKp0ncIR7sc/19/Ht78f911Z9OwV1hW87qYHDLRH87qeK7PCJBmMcp+47RzG1bu1tEoHoQlzi9qsFoQuHfqOcL52eaMao46qrjE8EB/E/CvMrlevT5VEELfiI9AZWU/R5Gnwn11RaKbMwY2g5xr2LC0C3wK/jepAXrczCQOngI7BSrPHU/zcBq2QPBR5Da0SsCL9k+WcdqQQGxqcV6gWnvUPw2Mn5Nc/p/Npd/+bD+gq3kaeko5WqZZC66I69dG3RW0dFxocQrX6LKhGJatYFMYuFzPQL1/MtoyZg4Jl5Os4DC8ilzI55XqKLCvaFXeqqe7IHaDXZX8+aZvPqJF0y04jH38vez26UaPZ4oo1RDwTKjZ9Rw/juQzpcDyHXYr1hNWgJ7FXgTy65GeRH5PvtDJoO4XRHNpUROsoLuyxO0fX6aLjk4oW3ljKePYIf5IXd4kPaGTe0KGFqTMU6PbYxdaQ/xPTOpELQh++o8Jc0FDYuhdXr7LNtsGRltq/BiuAHWSP/bU4L5zkpPUb73Lc3feft9NXje3AqhrLngYRHsf9vbSv5ept0OKyoZHwxzEYg4eF2Zr23lRtlylUi8kq9X+nWO4aShv5mMLS6iyXBqptAdNBS2TLrY5ZWhni9vKDGZMYDg1vTRblTEGF2GtSxxSksrW02CsKeIQV/N/Yay6cH68CJNIotd/Q6uYs53U7rLaXins3tDInCtGo6qFVxc2I+eUGRrw8MrIBxTBkFXivAEEcHAcW4xqxkIpM0MRVnVJ5VIYgmsfYHm2We67uj/c/hZXaqJgaPaDmkeFLv58+XmsOayXF/SClFtpTleANDdbMAsgG7xW7UEMTnIWrZwfZWSnpyzGZCWNySM0A5sdMIdqlKIJz0LnO4EyCk+HQTcOhGSgS5g6tRBxS584jteOTt+R86ivgwDTgfG5Dgl5aPj2fx8L3Lc2xhvlg2VEJTOGcRkHAxNKsIkYyeTiiSKBB6sqB/sLTYq4g+ON8fduMCctt3mxJqudjhH7ZOG/D6OAon9ZtaKUyaClcKgYZFmLJIkcqs+rUMp6iyDSJZ6WmcwMCAAMW3yA6Z6VFNaS0cFh76WrExxkxYkQ/8BFjx0SW4sYOY2lkMTx9NOim8P6fnc5UdI1C7FKOuhrcq5VKx/AugrRBhXRqgyGZluiwodOf615g0sihAz93ew3i6RQKHzTBHa56GimehK1OlUHmuC3a3doud56nIaV60LlTThdf22lwtZSnUxQOIyVwgpQURNdCFDdospLMSGl3g7jvYKzvf8dHKr6X+GBtit52ifRn6JefDCmZYi0NDz9OZ03A0KsYVQOqjSYF/WyDSnx0swpPRI29iaZ/Vn76pFOmLA1ORhK98xFUojPSu7IRFNMxjcjN0mKM6IcYhJNUbt7R0Ncs8Dn3f9WLT7EGcFzOI9gAahcoGmu0rbRdIo5yfQ9EWsarpWXgW7Dit+mTee7sx7vX4RoykRZOQvp9f59uk011/1rp9U71bRs6WCE03DW1Cqgh+XtVmM3tgDy+1rGs7ZWu5r7Y+fVRy3KrSnn6DhMBZXHODr1CwPv0VXnF+yymDAH3qqlwQ5Ot8+gSdymPC+tpaC2oLx0ON51qd8vbqUwjf+3KAqNWDaZrcRq8Bh11Ctg8cFc+j69UgyuKzIHGS2chERBfDFfF5BSpNA9fdcjtVP0Eb20zHRzBcyuYOY2yj1rKRv+I+/iwi6G0qc+vXvxqBnoKyF/Hq2SYN1la4M0AO12T+LMiHGq58snMMj5hV4LviJ686KjVge2uA61N5/DbBCI3XaKjM106e0xvkJ3J/ErJ0DPoGmh9OhctnsV26e/sgCatFq3bXeoB4RzoFtwAnwa/9eiB5tGjsMvdClPy1IGQyg09jNgBv0VPmTF1Hg6mK8xZyBsTyY+3aa48WOO9TV6VRw8Hz7uH10Kcqs0nOOhbumG2AiiqfKqhhWizDEZhGsSobpoUQr2ImeK4RQxGmrgNj5pMAk6xf1P5IopFlSZ8pIAqELRRrQkarv0nQY/wKvvnqhtzeJxBzSvViCIoxcpeVWdZesoLQUucvABsNdLccQ0P/glJlRdTefmGZkilFN4vUeFWaBJdylqxYjr54TdOjVLGCk0oNwKnmg9yvi/f1/vvEoIjQWhmw8m8HfexPVe1T7XMOnS0luFxO5+ewYvZn4+7EmqrmNR5qCFKiD/czYTqz5LVfVRWGE1hBe9Hb8OuUwmlVErge+5ERRE7nYRXtGItKhA7QEt6bp6WyZNBEogEYQbCwFuQ4kbe8NUTxda4xhUuok0xOTtsve/z+C/69Um5nqvlGKrZT0C78GNtkwxW2ZLcoskyam8oy90sL5ibpcw0NAQ6JB/H8A0yCapHxaWLYXmwf5Ig6quq7cFkXIcjb2ZZiz9bbRs5GIU+5dmDSVKq/z1ePoKzrE91VQLUcU0/C/q8X7/rsyTF2K29+3w99lfdhsZKJF+f7CKE/dFztge4C2243Jg83HCVvN4mbbhwlbYZmA/DVTKFGvQlahxGePysxc9AHY4uJ77p8dtkNvoGwelmwD3wVAa1YyZT48IrN3gWg2dZDqd4lQyucJXuZlpcwaQziAGYZJB6gxiA4XHu5/WmVapVKpVv41XMxUl/ArHHIUXwYdiOiVsYJuyY+oyZBha7SVmLoCZBxAcqbp8m13QZi5WCw6ZHenUEG/YIKp8xjbBNZhNAXKuFV9Anq9v2qVu47dNr2SGtTTvgt8jcB/s7fVTHIyWb21xx3v47GXPDsMNU81GYdSp60/OQ5UpcTUdb1fGCp2NnYQV5ZjeoMxvUimOPEGhayjZvYs7x+W9wZiqhwrlcFlE1EaqxVPLLULMUtCCwXxbOLI/FzPdZo7JV2bXnUKAVIEnRmrepQLVN+wsedptihm3yN9vEFtjDH0cCJHyJtNqhcqzpEETOVMzwmt0InxohLZ+8ddckC811SXG5Pqk611MI9fS+lUxZp0p+x6SsreXxqCipQPBYVYdGKwRqy0L1A4eJ53MtG8/gTDHJhWrBNtbVejur6rqOp6ClLNrcWfF4dzwdLYXNRZ0RVRcsmz+n598a8FDxQnc8iCgFF9HQUXrBQca/ejhObzVK99523DuX4pZiptobSifU8tKvWVz5aqpcqEvngu1wavDay0jls39+FUaTir0azog5EwGV7SMVQb1zPDMSRt+CF328rAqgjMK8tanS3nWUEOTxejtcYzE6BE6M8+t6BqMaCbuWHy5JYs7b1P0AhUsyHPqzlkfyQIofgHI2B3mzd/JDhUOnSJwpR8eGuFUbKeXMmXbjm8wi9WiFALY8Y/tacej4VrFdwaztubszdwtfJ2ZGCe62Aw9NSwHH+5+ir/QoEa6WF2zXWJZkQI2Wr8wD/zWOWcV86LadZP64rDv1majCnGl595/HVfGRtSqhx42NWcQxM6sVtcmydMgZ2uQKcqADijCzysW1qZQkrCpQKnC7Ncme2zdpQIqEM3C2q0VECZFW1bY85r0MrleaBaWhKD/AEeHAH4x8gucNfR/fc+P1mM8qpk7i5zwvpFgkvEeS0iLELx/Qc7Dd38d+VZmrOHcN5QgKY5/HrwpnlqQe9obGrp+737FoWafhGl3US42PZ9CSGiLnZHwaaCLTUUTJLIJ0PHbqUJhltenrtiktk4ErHmHGET7omPxXy93u4iE4zl0WB1BreJa2qPLHVdFPjnLbWO4yxhBTrTZp7FU9CqVaqlHU9Upvm2RgWBQZesRTfZdJRWgiON3j15/d/RRZEvXNVJEh3X5JyIH2p1AAKEuLZyDoJ9NAhgAshbrzGJ8K8RkLBLVNbFzBq0tLDjzI1gDEiOiSM0iBWvThsim04hEp9x0NaeunXLM1qAZwfmPJJjk1y7SX/lh4JbwcpUhK4ko+dKOayIXnYRaIFDD9uRbilZCf9kCFVl0RJRrqTiYJNZBL0yvu0x8/0arKUMHnw2uAypbWGyRRGtwoFX1Yej8OXhOZ+l5VcmayJQo3i7gPDSpU7ekddebiwOf1dClpIlWqiho7UUWrrSjHGd7sJI779fn80kesH9RipIGAafTX7v77cP2+FBLU9qJuyyTh4oqxqrs2NQ6msc/X/VluJZXe62jZ15RjWNkHrYrx8CbYsQt34UpaVTdIE5zP6353uV5OwbJ5BV9iRbqg+CN7vuav4Se36yX87PGfRwk771TXH447nyu3i/dQlao01/e8zmReJYtXr0bzG8/Ns3S+UaVGYZ90FqlR/KynrvXz+vt4+aHJvWIx6agN+byeY6ynQFy3qq69p4D5MPq6/10tpPaqKThPqz2v8Y8OKzRZq8ICPcUChvHH7zIk0yj2RJtSG841AB7h1PU0EP68zrS2lWdTC5iGVIKA+ymczrvz6gHlDnY2Qb2cSwTrDv1HwwPyd7+dVEXn0Kp0dsqS2Q4M7j2CzRwlGMSm3j2VV1dUy5ReJ5rSM7Vk4f4pF5mGARLp9nOnjqtRFe9kjqauy3jd5AB6eLltwm37lsJdntd0SJa0JL1X1ixN5QcJQUNViJCNcuc9tzjuu8vj/VpOuDpner6R0+jYI+F4mKevJKhTxhM/qJOoavNAxZRJQUjh9l/n4+4QH+K8e3wWOrRVBMS880QUEx7ndKZyFOsOZc1+PpWCc9KxGFNexfCk7voQHhRPTEurOtZckrKrEPop+BGJ0+Tk2i6DXfLPUBDQCwBMhlii9As1N55/o/BoBwllqUXqVRujgcIcJ1n/jshPnp6W6/UosJZckngW1/P4RH0zNopc1NHP9pp6FL4Xh6pKWvZUgb4u6PzKGnyo6k5Dt+LrEifyp044qmPylqQ63kTuaP5BJgGbXWVVyol2M53lbPYsEbqhpdGjIOe/r2rhrDqhaDomjNfhK6kdc1kc77UTBfx6+/ssF6gKSvNywdfld7Thgu1z2sXFSjJD0s1xbaL7cy26Ebeo0esoav11iacaa1+r7PGgUjekBGsvhivfdvvfRcBUVSA4ylf9unxdDzGee3icLgW9eqPK5JoRsRKUuxrq8L8uj+P+NbUwfDx3l+dPe0ZVWzCtn4ROE1cXI5cq/9IQMxeNPKb2XvurPpNkWdhAPdIgLIXmpyqE+paW2sVSeIaQhWXI9JVqw0AdgnV1vlftqi3aeFpgC8B6ZTc2yyQXNWppDa2oAKwscHQD9c0Szvp4i+88j1bbTqJO3YYSSihrHdVQPQaCAbg9XCAdtRCjhGzP+VS2t7bXVKtv52j18CwkHHm1uVAJZMqBAqx4/dO0nXLoaPh6FrPiq/ajotPsgVuj4QMhqKb0jKKHokHqhDjnPJ8KfsXrGAFd//w+nj4+i7xYo7owGOryzVISE/xS8azUyKh41RI+yBgkZBy1kmfhNaESwzgm13mkxtcsiG2tVm2t7RW5hnTppO8CCK+OD9syUn2vGH8HVRjLO46/bmWVilcxp6YHPBI9w3uLKxqWe91PWrnKUIkbx4y4TR5sk8wR36RAkW9a/LbL+Fn8DJjVZgTyNUU/vHEZAwu8aweU65BRrnR2i34VcjPRtXs//5pIiVQ0rpV5CtN1fNbOFVSBUTzevNbz9SjrmWUs0wwUvfUqrFPvlWqnSKM4LoKza16EClzy6XqsKXxib3SZV6YJulfsxfoNP2RNCKHKAtBMJpFMOqqe/3Rfp4+5vSWjUJKUcIYTeNUlrQiUlHHKT/QlClrAP1WDJOTZYDrTR1uETfHnx6k0MlQhVkfDtFnK0la7cBQ6RclBjYQk5nB8n+ap9BAUP39LAU9ZTCwuq1TgKdKD8Fo/zTSBZlhZQhReiy3vJIY15zGmVyW5iIe2YLVpE0jYdfRMS7eJBef6OSU6xvH+zhAgkFE6ECSx0EAmWJTZWs5qlmRXSK2sKmPkHUWTiO/T83Od6lGc0Lxp5CIknPq8QlSWybiGxiHrzR4VMWIq1HCgM26oXQpxlQS3CntsPg/bOqo5jKee/toIUTU6YANBRC7XmNitiXqJ3q06RihdQVpIVEgo+iHIaAY1kiYROps7qgwViJY7mAdLQHFikAJvVIOrhFwPjt/GR31FM7O4cadujH2EOqE2la14sDt4zgw736RCOWhUyzK//YFWLLmNasDjqKGO0YR/OgjqlCB+ilz0wE41sBsojKUOzVHoBxocS2Pfwrgyj9B1iq2HZt6TjCrtsYKVoG+MpSHVJCw6J6UsVZdII7p/9rt7QbnhFNsIJcD+c7y/XTW+r1cA9ga1HA1qnZpcE4XQPg9fRb666DXryIlCOPCDPY7V3drFwkq7aHNw4rHU5GzS7x+pmTpLOP5zekwdM2tRzHFQxiZ4IBqu2iah6+Bup0jlqYUSPGNWNqqwD9zKnSWUlVZy95gBzBsDTQr+OYWD+YdC1lY9EZ3m0/35WieSjaQ9cZ5ioJfhtfSkSqh4muH5c3qcCm3iR0WuBvYhx5Xydb97e513BftK16jzlBs7GB6r00qWOJVS5FY5ZKwZbFT5fU+D2FnE2jJQPAKek1L9uZ4O1QYWqr8phabMw1eUXzKsHRQP/ZYYXWVLlBaAoTjV791+Aj+T1raD7mRGgV0VMaUPOKhKK37mJlG8jslKncq57r53p2fw2ufyo+f1qEnvjOoH6Aaqh753d42mVFVUTarisw06fDQ9rkYYkzRE9h3dp/fwyvUkgMyDOapqv49vu/25ls5TZVZsS4bhn9fr75iHuBzPse5OA1LkG3u6KddSSsNrUNzVPGy4SKoU/w29smwpV+EiYUr66PHKQOWrsByogoYpHtskRiODdWDAdhqsGPxsRKQblaAWLL6AtlheHDs9z6/FEv5FzNHWqh4MFNKkhZUfqZXAOsMJ3CYpJdBG9U8M773xhefBxVnYKqrOlvb+wfh1I4pGTQL6j7Q0mT3JWsuRwXzTIgbf4ptzvMgkcVWO7GSOH/ysBuamAV9C0BZpwRgU9zuHK4BdWjRaAQ9ouBrxgBsrYM5iag0tjXAH6HtLk6IQQ0p1h16RNG59zSyndgzJ9Ex4nv8bOauYw6AM2ZZWLylhtT6uw6C0GSWPVIKmVVGIUXg/GgSBmDqXwaAKNnguDGKIth8VdSIvLqvJKVXJqNjCORwdsmrfXiFSHDWmShnr794oiPvPi6jkphwUWIzCfTJCYJtJXdkRjprsc6JRh4WEjh0oXiT4LGGxXWoGpqojoj6pElC1MRWokuL/YlQztXycXNRK82+ZEOEdaKKkymBVe5wOYu8Q7MJB7D113qPoamNyp8CyDnQ4rsVVh8pFUMt4xNI8gKse9DXgfghX9AwJDzTZvpUXVjAdpBAdCHDgxXkHAK1HRZhHItKnGrLwHIgMUvdzJlz72l12xYLqZCDFcJerytimko4Uk/J9391uu+AxFk3flYHrPA1wTONjke3tdF+ax2NyV96bhBV5vhi1yGqUUlKsOM/dp1nUNGwGTK7jnapqg0KgF0mcxl5utI2DPYqJnM1r5SF7BVlOYDjNrsZqSMOQrrE4DBAhdZaoFM0InogxcZ3aEXylY1r1rgExFprLuAZt4JrEEeoamgOenqjSqVymrIeNiVxGl6V0ozJp0IMiPDD/tFHUdf+afqpmRolKoMIwM6imRUEjgAnhRnh3ZOUahzlqcUUzKtMD1eg7x16lbEEtm6loMpkRmm444CMc3KrwqRBmRDMN0OaGad/8aOnRVlOvSKbHDiuJK67v75iE3wpJyPYOtCzyn0cZvJbbcaCwo78xmBL+V6ljVIzLZqB4lUnE/nyqc/dblZ+ndXCTkNpDqOZ/PJsxja82+uske5bhYfwo4U91GtQT1BMx/+v//X9up1ssDgl/9v//r//9v/8PiGyAbahSDwA="; \ No newline at end of file diff --git a/7.x/docs/assets/style.css b/7.x/docs/assets/style.css new file mode 100644 index 000000000..108428c3f --- /dev/null +++ b/7.x/docs/assets/style.css @@ -0,0 +1,1383 @@ +:root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-icon-background: var(--light-color-background); + --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-accent); + --light-color-text: #222; + --light-color-text-aside: #6e6e6e; + --light-color-link: #1f70c2; + + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --light-color-ts-function: #572be7; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: var(--light-color-ts-class); + --light-color-ts-property: var(--light-color-ts-variable); + --light-color-ts-method: var(--light-color-ts-function); + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var(--light-color-ts-constructor); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: var(--light-color-ts-type-alias); + --light-color-ts-accessor: var(--light-color-ts-property); + --light-color-ts-get-signature: var(--light-color-ts-accessor); + --light-color-ts-set-signature: var(--light-color-ts-accessor); + --light-color-ts-type-alias: #d51270; + /* reference not included as links will be colored with the kind that it points to */ + + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-accent: #9096a2; + --dark-color-active-menu-item: #5d5d6a; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + --dark-color-link: #00aff4; + + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: var(--dark-color-ts-class); + --dark-color-ts-property: var(--dark-color-ts-variable); + --dark-color-ts-method: var(--dark-color-ts-function); + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: var(--dark-color-ts-type-alias); + --dark-color-ts-accessor: var(--dark-color-ts-property); + --dark-color-ts-get-signature: var(--dark-color-ts-accessor); + --dark-color-ts-set-signature: var(--dark-color-ts-accessor); + --dark-color-ts-type-alias: #ff6492; + /* reference not included as links will be colored with the kind that it points to */ + + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; +} + +@media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } +} + +@media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } +} + +html { + color-scheme: var(--color-scheme); +} + +body { + margin: 0; +} + +:root[data-theme="light"] { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); +} + +:root[data-theme="dark"] { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); +} + +.always-visible, +.always-visible .tsd-signatures { + display: inherit !important; +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: 1.2; +} + +h1 > a, +h2 > a, +h3 > a, +h4 > a, +h5 > a, +h6 > a { + text-decoration: none; + color: var(--color-text); +} + +h1 { + font-size: 1.875rem; + margin: 0.67rem 0; +} + +h2 { + font-size: 1.5rem; + margin: 0.83rem 0; +} + +h3 { + font-size: 1.25rem; + margin: 1rem 0; +} + +h4 { + font-size: 1.05rem; + margin: 1.33rem 0; +} + +h5 { + font-size: 1rem; + margin: 1.5rem 0; +} + +h6 { + font-size: 0.875rem; + margin: 2.33rem 0; +} + +.uppercase { + text-transform: uppercase; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1700px; + padding: 0 2rem; +} + +/* Footer */ +.tsd-generator { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; +} + +.tsd-generator > p { + margin-top: 0; + margin-bottom: 0; + padding: 0 1rem; +} + +.container-main { + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: "Segoe UI", sans-serif; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; +} + +pre { + position: relative; + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); +} +pre code { + padding: 0; + font-size: 100%; +} +pre > button { + position: absolute; + top: 10px; + right: 10px; + opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; +} +pre:hover > button, +pre > button.visible { + opacity: 1; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography .tsd-index-panel h3, +.tsd-index-panel .tsd-typography h3, +.tsd-typography h4, +.tsd-typography h5, +.tsd-typography h6 { + font-size: 1em; +} +.tsd-typography h5, +.tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, +.tsd-typography ul, +.tsd-typography ol { + margin: 1em 0; +} +.tsd-typography table { + border-collapse: collapse; + border: none; +} +.tsd-typography td, +.tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); +} +.tsd-typography thead, +.tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +.tsd-comment-tags { + display: flex; + flex-direction: column; +} +dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; +} +dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; +} +dl.tsd-comment-tag-group dd { + margin: 0; +} +code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; +} +h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; +} + +dl.tsd-comment-tag-group dd:before, +dl.tsd-comment-tag-group dd:after { + content: " "; +} +dl.tsd-comment-tag-group dd pre, +dl.tsd-comment-tag-group dd:after { + clear: both; +} +dl.tsd-comment-tag-group p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; +} +.tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; +} +.tsd-filter-input { + display: flex; + width: fit-content; + width: -moz-fit-content; + align-items: center; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + cursor: pointer; +} +.tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; +} +.tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; +} +.tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; +} +.tsd-filter-input input[type="checkbox"]:focus + svg { + transform: scale(0.95); +} +.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { + transform: scale(1); +} +.tsd-checkbox-background { + fill: var(--color-accent); +} +input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); +} + +.tsd-theme-toggle { + padding-top: 0.75rem; +} +.tsd-theme-toggle > h4 { + display: inline; + vertical-align: middle; + margin-right: 0.75rem; +} + +.tsd-hierarchy { + list-style: square; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-panel-group.tsd-index-group { + margin-bottom: 0; +} +.tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; +} +@media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } +} +@media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } +} +.tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} + +.tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; +} + +.tsd-anchor { + position: relative; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} + +.tsd-navigation.settings { + margin: 1rem 0; +} +.tsd-navigation > a, +.tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.5rem); +} +.tsd-navigation a, +.tsd-navigation summary > span, +.tsd-page-navigation a { + display: inline-flex; + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; +} +.tsd-navigation a.current, +.tsd-page-navigation a.current { + background: var(--color-active-menu-item); +} +.tsd-navigation a:hover, +.tsd-page-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul, +.tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li, +.tsd-page-navigation li { + padding: 0; + max-width: 100%; +} +.tsd-nested-navigation { + margin-left: 3rem; +} +.tsd-nested-navigation > li > details { + margin-left: -1.5rem; +} +.tsd-small-nested-navigation { + margin-left: 1.5rem; +} +.tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; +} + +.tsd-nested-navigation > li > a, +.tsd-nested-navigation > li > span { + width: calc(100% - 1.75rem - 0.5rem); +} + +.tsd-page-navigation ul { + padding-left: 1.75rem; +} + +#tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; +} +#tsd-sidebar-links a:last-of-type { + margin-bottom: 0; +} + +a.tsd-index-link { + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} +.tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ +} +.tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ +} +.tsd-accordion-summary, +.tsd-accordion-summary a { + user-select: none; + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; + + cursor: pointer; +} +.tsd-accordion-summary a { + width: calc(100% - 1.5rem); +} +.tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; +} +.tsd-index-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; +} +.tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; +} +.tsd-index-heading { + margin-top: 1.5rem; + margin-bottom: 0.75rem; +} + +.tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; +} +.tsd-kind-icon path { + transform-origin: center; + transform: scale(1.1); +} +.tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; +} + +.tsd-panel { + margin-bottom: 2.5rem; +} +.tsd-panel.tsd-member { + margin-bottom: 4rem; +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, +.tsd-panel > h2, +.tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; +} +.tsd-panel > h1.tsd-before-signature, +.tsd-panel > h2.tsd-before-signature, +.tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; +} + +.tsd-panel-group { + margin: 4rem 0; +} +.tsd-panel-group.tsd-index-group { + margin: 2rem 0; +} +.tsd-panel-group.tsd-index-group details { + margin: 2rem 0; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title, +#tsd-toolbar-links a { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + background-color: var(--color-background); + line-height: initial; + padding: 4px; +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-background-secondary); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current:not(.no-results), +#tsd-search .results li:hover:not(.no-results) { + background-color: var(--color-accent); +} +#tsd-search .results a { + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-accent); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title, +#tsd-search.has-focus #tsd-toolbar-links a { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +#tsd-toolbar-links { + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; +} +#tsd-toolbar-links a { + margin-left: 1.5rem; +} +#tsd-toolbar-links a:hover { + text-decoration: underline; +} + +.tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; +} +.tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; +} +.tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; +} + +ul.tsd-parameter-list, +ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameter-list > li.tsd-parameter-signature, +ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameter-list h5, +ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +.tsd-sources { + margin-top: 1rem; + font-size: 0.875em; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; +} +.tsd-page-toolbar a { + color: var(--color-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .tsd-toolbar-contents { + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; +} +.tsd-page-toolbar .table-cell { + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} +.tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: + opacity 0.1s, + background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.9; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-accent); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} + +.tsd-widget.options, +.tsd-widget.menu { + display: none; +} +input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; +} +input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} + +.deprecated { + text-decoration: line-through !important; +} + +.warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); +} + +.tsd-kind-project { + color: var(--color-ts-project); +} +.tsd-kind-module { + color: var(--color-ts-module); +} +.tsd-kind-namespace { + color: var(--color-ts-namespace); +} +.tsd-kind-enum { + color: var(--color-ts-enum); +} +.tsd-kind-enum-member { + color: var(--color-ts-enum-member); +} +.tsd-kind-variable { + color: var(--color-ts-variable); +} +.tsd-kind-function { + color: var(--color-ts-function); +} +.tsd-kind-class { + color: var(--color-ts-class); +} +.tsd-kind-interface { + color: var(--color-ts-interface); +} +.tsd-kind-constructor { + color: var(--color-ts-constructor); +} +.tsd-kind-property { + color: var(--color-ts-property); +} +.tsd-kind-method { + color: var(--color-ts-method); +} +.tsd-kind-call-signature { + color: var(--color-ts-call-signature); +} +.tsd-kind-index-signature { + color: var(--color-ts-index-signature); +} +.tsd-kind-constructor-signature { + color: var(--color-ts-constructor-signature); +} +.tsd-kind-parameter { + color: var(--color-ts-parameter); +} +.tsd-kind-type-literal { + color: var(--color-ts-type-literal); +} +.tsd-kind-type-parameter { + color: var(--color-ts-type-parameter); +} +.tsd-kind-accessor { + color: var(--color-ts-accessor); +} +.tsd-kind-get-signature { + color: var(--color-ts-get-signature); +} +.tsd-kind-set-signature { + color: var(--color-ts-set-signature); +} +.tsd-kind-type-alias { + color: var(--color-ts-type-alias); +} + +/* if we have a kind icon, don't color the text by kind */ +.tsd-kind-icon ~ span { + color: var(--color-text); +} + +* { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); +} + +*::-webkit-scrollbar { + width: 0.75rem; +} + +*::-webkit-scrollbar-track { + background: var(--color-icon-background); +} + +*::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); +} + +/* mobile */ +@media (max-width: 769px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } + + .container-main { + display: flex; + } + html .col-content { + float: none; + max-width: 100%; + width: 100%; + } + html .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-sidebar > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } +} + +/* one sidebar */ +@media (min-width: 770px) { + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + margin: 2rem auto; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } +} +@media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + padding-top: 1rem; + } + .site-menu { + margin-top: 1rem; + } +} + +/* two sidebars */ +@media (min-width: 1200px) { + .container-main { + grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 1rem 0; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } +} diff --git a/7.x/docs/classes/AbsolutePathInteractionRoute.html b/7.x/docs/classes/AbsolutePathInteractionRoute.html new file mode 100644 index 000000000..414b72b8f --- /dev/null +++ b/7.x/docs/classes/AbsolutePathInteractionRoute.html @@ -0,0 +1,159 @@ +AbsolutePathInteractionRoute | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AbsolutePathInteractionRoute

+
+

A route that stores a single absolute path.

+
+
+
+

Hierarchy

+
    +
  • AbsolutePathInteractionRoute
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
path +
+
+

Methods

+
getPath +matchPath +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly path

+
path: string
+
+

Methods

+
+

getPath

+
+
+

matchPath

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AcceptPreferenceParser.html b/7.x/docs/classes/AcceptPreferenceParser.html new file mode 100644 index 000000000..1f99aa6ea --- /dev/null +++ b/7.x/docs/classes/AcceptPreferenceParser.html @@ -0,0 +1,181 @@ +AcceptPreferenceParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AcceptPreferenceParser

+
+

Extracts preferences from the Accept-* headers from an incoming HttpRequest. +Supports Accept, Accept-Charset, Accept-Encoding, Accept-Language and Accept-DateTime.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: {
          request: HttpRequest;
      }
      +

      Input that could potentially be handled.

      +
      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AccessChecker.html b/7.x/docs/classes/AccessChecker.html new file mode 100644 index 000000000..62fec64c7 --- /dev/null +++ b/7.x/docs/classes/AccessChecker.html @@ -0,0 +1,175 @@ +AccessChecker | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AccessCheckerAbstract

+
+

Performs an authorization check against the given acl resource.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AccountInitializer.html b/7.x/docs/classes/AccountInitializer.html new file mode 100644 index 000000000..e0bdee4a8 --- /dev/null +++ b/7.x/docs/classes/AccountInitializer.html @@ -0,0 +1,224 @@ +AccountInitializer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AccountInitializer

+
+

Initializes an account with email/password login and a pod with the provided name.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
accountStore +email +logger +name +password +passwordStore +podCreator +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly accountStore

+
accountStore: AccountStore
+
+

Private email

+
email: undefined | string
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly name

+
name: undefined | string
+
+

Private password

+
password: undefined | string
+
+

Private Readonly passwordStore

+
passwordStore: PasswordStore
+
+

Private Readonly podCreator

+
podCreator: PodCreator
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      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.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AccountPromptFactory.html b/7.x/docs/classes/AccountPromptFactory.html new file mode 100644 index 000000000..3043ad779 --- /dev/null +++ b/7.x/docs/classes/AccountPromptFactory.html @@ -0,0 +1,252 @@ +AccountPromptFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AccountPromptFactory

+
+

Creates the prompt necessary to ensure a user is logged in with their account when doing an OIDC interaction. +This is done by checking the presence of the account-related cookie.

+

Adds a Check to the login policy that verifies if the stored accountId, which corresponds to the chosen WebID, +belongs to the currently logged in account.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
cookieName +cookieStore +logger +webIdStore +
+
+

Methods

+
addAccountPrompt +addWebIdVerificationPrompt +canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly cookieName

+
cookieName: string
+
+

Private Readonly cookieStore

+
cookieStore: CookieStore
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly webIdStore

+
webIdStore: WebIdStore
+
+

Methods

+
+

Private addAccountPrompt

+
+
+

Private addWebIdVerificationPrompt

+
+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: DefaultPolicy
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: DefaultPolicy
      +

      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.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AcpHeaderHandler.html b/7.x/docs/classes/AcpHeaderHandler.html new file mode 100644 index 000000000..59a32fdfe --- /dev/null +++ b/7.x/docs/classes/AcpHeaderHandler.html @@ -0,0 +1,218 @@ +AcpHeaderHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AcpHeaderHandler

+
+

Handles all the required ACP headers as defined at +https://solid.github.io/authorization-panel/acp-specification/#conforming-acp-server

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
attributes +modes +strategy +targetExtractor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly attributes

+
attributes: string[]
+
+

Private Readonly modes

+
modes: string[]
+
+

Private Readonly strategy

+
strategy: AuxiliaryIdentifierStrategy
+
+

Private Readonly targetExtractor

+
targetExtractor: TargetExtractor
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AcpReader.html b/7.x/docs/classes/AcpReader.html new file mode 100644 index 000000000..83d332704 --- /dev/null +++ b/7.x/docs/classes/AcpReader.html @@ -0,0 +1,326 @@ +AcpReader | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AcpReader

+
+

Finds the permissions of a resource as defined in the corresponding ACRs. +Implementation based on https://solid.github.io/authorization-panel/acp-specification/.

+

Caches data so no duplicate calls are made to the ResourceStore for a single request.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
acrStore +acrStrategy +identifierStrategy +logger +
+
+

Methods

+
canHandle +createContext +extractPermissions +getAncestorIdentifiers +getEffectivePolicies +handle +handleSafe +readAcrData +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly acrStore

+
acrStore: ResourceStore
+
+

Private Readonly acrStrategy

+
acrStrategy: AuxiliaryStrategy
+
+

Private Readonly identifierStrategy

+
identifierStrategy: IdentifierStrategy
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Private createContext

+
+
+

Private extractPermissions

+
    + +
  • +

    Generates the allowed permissions.

    +
    +
    +

    Parameters

    +
      +
    • +
      target: ResourceIdentifier
      +

      Target to generate permissions for.

      +
      +
      • +
    • +
      credentials: Credentials
      +

      Credentials that are trying to access the resource.

      +
      +
      • +
    • +
      resourceCache: IdentifierMap<IAccessControlledResource[]>
      +

      Cache used to store ACR data.

      +
      +
    +

    Returns Promise<Partial<Record<AccessMode, boolean>>>

    +
+
+

Private getAncestorIdentifiers

+
+
+

Private getEffectivePolicies

+
+
+

handle

+
+
+

handleSafe

+
+
+

Private readAcrData

+
    + +
  • +

    Returns the data found in the ACR corresponding to the given identifier.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Store<Quad, Quad, Quad, Quad>>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ActivityNotificationGenerator.html b/7.x/docs/classes/ActivityNotificationGenerator.html new file mode 100644 index 000000000..e7f418536 --- /dev/null +++ b/7.x/docs/classes/ActivityNotificationGenerator.html @@ -0,0 +1,200 @@ +ActivityNotificationGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ActivityNotificationGenerator

+
+

A NotificationGenerator that creates a Notification by using the provided activity as type. +Requests metadata of the topic from the ResourceStore to fill in the details.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
eTagHandler +store +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly eTagHandler

+
eTagHandler: ETagHandler
+
+

Private Readonly store

+
store: ResourceStore
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AddRemoveNotificationGenerator.html b/7.x/docs/classes/AddRemoveNotificationGenerator.html new file mode 100644 index 000000000..66d1d27c8 --- /dev/null +++ b/7.x/docs/classes/AddRemoveNotificationGenerator.html @@ -0,0 +1,201 @@ +AddRemoveNotificationGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AddRemoveNotificationGenerator

+
+

A NotificationGenerator specifically for Add/Remove notifications. +Creates the notification so the target is set to input topic, +and the object value is extracted from the provided metadata.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
eTagHandler +store +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly eTagHandler

+
eTagHandler: ETagHandler
+
+

Private Readonly store

+
store: ResourceStore
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AgentAccessChecker.html b/7.x/docs/classes/AgentAccessChecker.html new file mode 100644 index 000000000..feb1faf0f --- /dev/null +++ b/7.x/docs/classes/AgentAccessChecker.html @@ -0,0 +1,171 @@ +AgentAccessChecker | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AgentAccessChecker

+
+

Checks if the given WebID has been given access.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AgentClassAccessChecker.html b/7.x/docs/classes/AgentClassAccessChecker.html new file mode 100644 index 000000000..62af53420 --- /dev/null +++ b/7.x/docs/classes/AgentClassAccessChecker.html @@ -0,0 +1,171 @@ +AgentClassAccessChecker | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AgentClassAccessChecker

+
+

Checks access based on the agent class.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AgentGroupAccessChecker.html b/7.x/docs/classes/AgentGroupAccessChecker.html new file mode 100644 index 000000000..4926400b5 --- /dev/null +++ b/7.x/docs/classes/AgentGroupAccessChecker.html @@ -0,0 +1,219 @@ +AgentGroupAccessChecker | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AgentGroupAccessChecker

+
+

Checks if the given WebID belongs to a group that has access. +Implements the behaviour of groups from the WAC specification.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +fetchQuads +handle +handleSafe +isMemberOfGroup +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Private fetchQuads

+
+
+

handle

+
+
+

handleSafe

+
+
+

Private isMemberOfGroup

+
    + +
  • +

    Checks if the given agent is member of a given vCard group.

    +
    +
    +

    Parameters

    +
      +
    • +
      webId: string
      +

      WebID of the agent that needs access.

      +
      +
      • +
    • +
      group: Term
      +

      URL of the vCard group that needs to be checked.

      +
      +
    +

    Returns Promise<boolean>

    If the agent is member of the given vCard group.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AllStaticReader.html b/7.x/docs/classes/AllStaticReader.html new file mode 100644 index 000000000..e931c7473 --- /dev/null +++ b/7.x/docs/classes/AllStaticReader.html @@ -0,0 +1,191 @@ +AllStaticReader | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AllStaticReader

+
+

PermissionReader which sets all permissions to true or false +independently of the identifier and requested permissions.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
permissionSet +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly permissionSet

+
permissionSet: Partial<Record<AccessMode, boolean>>
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AllowAcceptHeaderWriter.html b/7.x/docs/classes/AllowAcceptHeaderWriter.html new file mode 100644 index 000000000..28d06d687 --- /dev/null +++ b/7.x/docs/classes/AllowAcceptHeaderWriter.html @@ -0,0 +1,374 @@ +AllowAcceptHeaderWriter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AllowAcceptHeaderWriter

+
+

Generates Allow, Accept-Patch, Accept-Post, and Accept-Put headers. +The resulting values depend on the choses input methods and types. +The input metadata also gets used to remove methods from that list +if they are not valid in the given situation.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
acceptTypes +supportedMethods +
+
+

Methods

+
canHandle +filterAllowedMethods +generateAccept +generateAllow +handle +handleSafe +isDeleteAllowed +isPatchAllowed +isPostAllowed +isPutAllowed +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly acceptTypes

+
acceptTypes: {
    patch: string[];
    post: string[];
    put: string[];
}
+
+

Type declaration

+
    +
  • +
    patch: string[]
    • +
  • +
    post: string[]
    • +
  • +
    put: string[]
+
+

Private Readonly supportedMethods

+
supportedMethods: string[]
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Private filterAllowedMethods

+
+
+

Private generateAccept

+
    + +
  • +

    Generates the Accept-[Method] headers if required. +Will be added if the Allow header was added, or in case of a 415 error. +Specific Accept-[Method] headers will only be added if the method is in the methods set.

    +
    +
    +

    Parameters

    +
    +

    Returns void

    +
+
+

Private generateAllow

+
    + +
  • +

    Generates the Allow header if required. +It only needs to get added for successful GET/HEAD requests, 404s, or 405s. +The spec only requires it for GET/HEAD requests and 405s. +In the case of other error messages we can't deduce what the request method was, +so we do not add the header as we don't have enough information.

    +
    +
    +

    Parameters

    +
    +

    Returns boolean

    +
+
+

handle

+
+
+

handleSafe

+
+
+

Private isDeleteAllowed

+
    + +
  • +

    DELETE is allowed if the target exists, +is not a container, +or is an empty container that isn't a storage.

    +

    Note that the identifier value check only works if the metadata is not about an error.

    +
    +
    +

    Parameters

    +
    +

    Returns boolean

    +
+
+

Private isPatchAllowed

+
+
+

Private isPostAllowed

+
+
+

Private isPutAllowed

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/App.html b/7.x/docs/classes/App.html new file mode 100644 index 000000000..582c8774a --- /dev/null +++ b/7.x/docs/classes/App.html @@ -0,0 +1,158 @@ +App | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class App

+
+

Entry point for the entire Solid server.

+
+
+
+

Hierarchy

+
    +
  • App
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
clusterManager +finalizer +initializer +
+
+

Methods

+
start +stop +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly clusterManager

+
clusterManager: ClusterManager
+
+

Private Readonly finalizer

+
finalizer: Finalizer
+
+

Private Readonly initializer

+
initializer: Initializer
+
+

Methods

+
+

start

+
    + +
  • +

    Initializes and starts the application.

    +
    +

    Returns Promise<void>

    +
+
+

stop

+
    + +
  • +

    Stops the application and handles cleanup.

    +
    +

    Returns Promise<void>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AppRunner.html b/7.x/docs/classes/AppRunner.html new file mode 100644 index 000000000..4cac45979 --- /dev/null +++ b/7.x/docs/classes/AppRunner.html @@ -0,0 +1,369 @@ +AppRunner | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AppRunner

+
+

A class that can be used to instantiate and start a server based on a Component.js configuration.

+
+
+
+

Hierarchy

+
    +
  • AppRunner
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +
+
+

Methods

+
create +createApp +createCli +createCliResolver +createComponentsManager +extractShorthand +getPackageSettings +resolveError +resolveShorthand +run +runCli +runCliSync +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly logger

+
logger: Logger = ...
+
+

Methods

+
+

create

+
    + +
  • +

    Returns an App object, created with the given config, that can start and stop the Solid server.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: AppRunnerInput = {}
      +

      All values necessary to configure the server.

      +
      +
    +

    Returns Promise<App>

    +
+
+

Private createApp

+
    + +
  • +

    The second Components.js instantiation, +where the App is created and started using the variable mappings.

    +
    +
    +

    Parameters

    +
      +
    • +
      componentsManager: ComponentsManager<App>
      • +
    • +
      variables: Record<string, unknown>
    +

    Returns Promise<App>

    +
+
+

createCli

+
    + +
  • +

    Returns an App object, created by parsing the Command line arguments, that can start and stop the Solid server. +Will exit the process on failure.

    +
    +
    +

    Parameters

    +
      +
    • +
      argv: CliArgv = process.argv
      +

      Command line arguments.

      +
      +
    +

    Returns Promise<App>

    +
+
+

Private createCliResolver

+
+
+

createComponentsManager

+
    + +
  • +

    Creates the Components Manager that will be used for instantiating.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      loaderProperties: IComponentsManagerBuilderOptions<T>
      • +
    • +
      configs: string[]
    +

    Returns Promise<ComponentsManager<T>>

    +
+
+

Private extractShorthand

+
    + +
  • +

    Uses the CliExtractor to convert the CLI args to a Shorthand object.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Shorthand>

    +
+
+

getPackageSettings

+
    + +
  • +

    Retrieves settings from package.json or configuration file when +part of an npm project.

    +
    +

    Returns Promise<undefined | Record<string, unknown>>

    The settings defined in the configuration file

    + +
+
+

Private resolveError

+
    + +
  • +

    Throws a new error that provides additional information through the extra message. +Also appends the stack trace to the message. +This is needed for errors that are thrown before the logger is created as we can't log those the standard way.

    +
    +
    +

    Parameters

    +
      +
    • +
      message: string
      • +
    • +
      error: unknown
    +

    Returns never

    +
+
+

Private resolveShorthand

+
    + +
  • +

    Uses the ShorthandResolver to convert Shorthand to VariableBindings .

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<VariableBindings>

    +
+
+

run

+
    + +
  • +

    Starts the server with a given config.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: AppRunnerInput
      +

      All values necessary to configure the server.

      +
      +
    +

    Returns Promise<void>

    +
+
+

runCli

+
    + +
  • +

    Starts the server as a command-line application.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional argv: CliArgv
      +

      Command line arguments.

      +
      +
    +

    Returns Promise<void>

    +
+
+

runCliSync

+
    + +
  • +

    Starts the server as a command-line application. +Will exit the process on failure.

    +

    Made non-async to lower the risk of unhandled promise rejections. +This is only relevant when this is used to start as a Node.js application on its own, +if you use this as part of your code you probably want to use the async version.

    +
    +
    +

    Parameters

    +
      +
    • +
      argv: {
          argv?: CliArgv;
          stderr?: WriteStream;
      }
      +

      Input parameters.

      +
      +
      +
        +
      • +
        Optional argv?: CliArgv
        +

        Command line arguments.

        +
        +
        • +
      • +
        Optional stderr?: WriteStream
        +

        Stream that should be used to output errors before the logger is enabled.

        +
        +
    +

    Returns void

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ArrayUnionHandler.html b/7.x/docs/classes/ArrayUnionHandler.html new file mode 100644 index 000000000..baea43b20 --- /dev/null +++ b/7.x/docs/classes/ArrayUnionHandler.html @@ -0,0 +1,244 @@ +ArrayUnionHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ArrayUnionHandler<T>

+
+

A utility handler that concatenates the results of all its handlers into a single result.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
handlers +
+
+

Methods

+
allCanHandle +canHandle +combine +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly handlers

+
handlers: T[]
+
+

Methods

+
+

Protected allCanHandle

+
+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Protected combine

+
+
+

handle

+
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Awaited<ReturnType<T["handle"]>>>

    A promise resolving when handling is finished.

    + +
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: AsyncHandlerInput<T>
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<Awaited<ReturnType<T["handle"]>>>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AssetPathExtractor.html b/7.x/docs/classes/AssetPathExtractor.html new file mode 100644 index 000000000..cae74bed7 --- /dev/null +++ b/7.x/docs/classes/AssetPathExtractor.html @@ -0,0 +1,201 @@ +AssetPathExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AssetPathExtractor

+
+

A ShorthandExtractor that converts a path value to an absolute asset path +by making use of resolveAssetPath. +Returns the default path in case it is defined and no path was found in the map.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
defaultPath? +key +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Optional Readonly defaultPath

+
defaultPath?: string
+
+

Private Readonly key

+
key: string
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Shorthand
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Shorthand
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<unknown>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AsyncHandler.html b/7.x/docs/classes/AsyncHandler.html new file mode 100644 index 000000000..782e8c6de --- /dev/null +++ b/7.x/docs/classes/AsyncHandler.html @@ -0,0 +1,243 @@ +AsyncHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AsyncHandler<TIn, TOut>Abstract

+
+

Simple interface for classes that can potentially handle a specific kind of data asynchronously.

+
+
+
+

Type Parameters

+
    +
  • +

    TIn = void

    • +
  • +

    TOut = void

+
+

Hierarchy

+
+
+

Implemented by

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      TIn = void

      • +
    • +

      TOut = void

    +

    Returns AsyncHandler<TIn, TOut>

+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<TOut>

    A promise resolving when handling is finished.

    + +
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<TOut>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AtomicFileDataAccessor.html b/7.x/docs/classes/AtomicFileDataAccessor.html new file mode 100644 index 000000000..328dafbdb --- /dev/null +++ b/7.x/docs/classes/AtomicFileDataAccessor.html @@ -0,0 +1,438 @@ +AtomicFileDataAccessor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AtomicFileDataAccessor

+
+

AtomicDataAccessor that uses the file system to store documents as files and containers as folders. +Data will first be written to a temporary location and only if no errors occur +will the data be written to the desired location.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +resourceMapper +tempFilePath +
+
+

Methods

+
canHandle +deleteResource +getChildren +getData +getMetadata +getStats +verifyExistingExtension +writeContainer +writeDataFile +writeDocument +writeMetadata +writeMetadataFile +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Protected Readonly resourceMapper

+
resourceMapper: FileIdentifierMapper
+
+

Private Readonly tempFilePath

+
tempFilePath: string
+
+

Methods

+
+

canHandle

+
+
+

deleteResource

+
+
+

getChildren

+
    + +
  • +

    Returns metadata for all resources in the requested container. +This should not be all metadata of those resources (but it can be), +but instead the main metadata you want to show in situations +where all these resources are presented simultaneously. +Generally this would be metadata that is present for all of these resources, +such as resource type or last modified date.

    +

    It can be safely assumed that the incoming identifier will always correspond to a container.

    +
    +
    +

    Parameters

    +
    +

    Returns AsyncIterableIterator<RepresentationMetadata>

    +
+
+

getData

+
+
+

getMetadata

+
+
+

Protected getStats

+
    + +
  • +

    Gets the Stats object corresponding to the given file path, +resolving symbolic links.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      File path to get info from.

      +
      +
    +

    Returns Promise<Stats>

    +
    +

    Throws

    NotFoundHttpError +If the file/folder doesn't exist.

    +
+
+

Protected verifyExistingExtension

+
    + +
  • +

    Verifies if there already is a file corresponding to the given resource. +If yes, that file is removed if it does not match the path given in the input ResourceLink. +This can happen if the content-type differs from the one that was stored.

    +
    +
    +

    Parameters

    +
      +
    • +
      link: ResourceLink
      +

      ResourceLink corresponding to the new resource data.

      +
      +
    +

    Returns Promise<void>

    +
+
+

writeContainer

+
+
+

Protected writeDataFile

+
    + +
  • +

    Helper function without extra validation checking to create a data file.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      The filepath of the file to be created.

      +
      +
      • +
    • +
      data: Readable
      +

      The data to be put in the file.

      +
      +
    +

    Returns Promise<void>

    +
+
+

writeDocument

+
+
+

writeMetadata

+
+
+

Protected writeMetadataFile

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AuthAuxiliaryReader.html b/7.x/docs/classes/AuthAuxiliaryReader.html new file mode 100644 index 000000000..97b5ebbca --- /dev/null +++ b/7.x/docs/classes/AuthAuxiliaryReader.html @@ -0,0 +1,250 @@ +AuthAuxiliaryReader | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AuthAuxiliaryReader

+
+

Determines the permission for authorization resources (such as ACL or ACR). +In contrast to the regular resource mechanism, read/write access to authorization resources +is obtained by setting Control permissions on the corresponding subject resource +rather than directly setting permissions for the authorization resource itself. +Hence, this class transforms Control permissions on the subject resource +to Read/Write permissions on the authorization resource.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
authStrategy +logger +reader +
+
+

Methods

+
canHandle +findAuth +handle +handleSafe +interpretControl +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly authStrategy

+
authStrategy: AuxiliaryStrategy
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly reader

+
reader: PermissionReader
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Private findAuth

+
+
+

handle

+
+
+

handleSafe

+
+
+

Protected interpretControl

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AuthorizationParser.html b/7.x/docs/classes/AuthorizationParser.html new file mode 100644 index 000000000..62309e53d --- /dev/null +++ b/7.x/docs/classes/AuthorizationParser.html @@ -0,0 +1,210 @@ +AuthorizationParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AuthorizationParser

+
+

Parses specific authorization schemes and stores their value as metadata. +The keys of the input authMap should be the schemes, +and the values the corresponding predicate that should be used to store the value in the metadata. +The scheme will be sliced off the value, after which it is used as the object in the metadata triple.

+

This should be used for custom authorization schemes, +for things like OIDC tokens a CredentialsExtractor should be used.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
authMap +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly authMap

+
authMap: Record<string, NamedNode<string>>
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AuthorizedRouteHandler.html b/7.x/docs/classes/AuthorizedRouteHandler.html new file mode 100644 index 000000000..ce741abf4 --- /dev/null +++ b/7.x/docs/classes/AuthorizedRouteHandler.html @@ -0,0 +1,212 @@ +AuthorizedRouteHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AuthorizedRouteHandler

+
+

An InteractionRouteHandler specifically for an AccountIdRoute. +If there is no account ID, implying the user is not logged in, +an UnauthorizedHttpError will be thrown. +If there is an account ID, but it does not match the one in target resource, +a ForbiddenHttpError will be thrown.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +route +source +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly logger

+
logger: Logger = ...
+
+

Protected Readonly route

+
route: AccountIdRoute
+
+

Protected Readonly source

+
source: JsonInteractionHandler<Dict<Json>>
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/Authorizer.html b/7.x/docs/classes/Authorizer.html new file mode 100644 index 000000000..b43399a8d --- /dev/null +++ b/7.x/docs/classes/Authorizer.html @@ -0,0 +1,174 @@ +Authorizer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AuthorizerAbstract

+
+

Verifies whether the credentials provide access with the given permissions on the resource. +An Error with the necessary explanation will be thrown if permissions are not granted.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AuthorizingHttpHandler.html b/7.x/docs/classes/AuthorizingHttpHandler.html new file mode 100644 index 000000000..26dfe24e4 --- /dev/null +++ b/7.x/docs/classes/AuthorizingHttpHandler.html @@ -0,0 +1,250 @@ +AuthorizingHttpHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AuthorizingHttpHandler

+
+

Handles all the necessary steps for an authorization. +Errors if authorization fails, otherwise passes the parameter to the operationHandler handler. +The following steps are executed:

+
    +
  • Extracting credentials from the request.
    • +
  • Extracting the required permissions.
    • +
  • Reading the allowed permissions for the credentials.
    • +
  • Validating if this operation is allowed.
    • +
+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
authorizer +credentialsExtractor +logger +modesExtractor +operationHandler +permissionReader +
+
+

Methods

+
addAccessModesToError +canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly authorizer

+
authorizer: Authorizer
+
+

Private Readonly credentialsExtractor

+
credentialsExtractor: CredentialsExtractor
+
+

Private Readonly logger

+
logger: Logger = ...
+
+

Private Readonly modesExtractor

+
modesExtractor: ModesExtractor
+
+

Private Readonly operationHandler

+
operationHandler: OperationHttpHandler
+
+

Private Readonly permissionReader

+
permissionReader: PermissionReader
+
+

Methods

+
+

Private addAccessModesToError

+
+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AuxiliaryLinkMetadataWriter.html b/7.x/docs/classes/AuxiliaryLinkMetadataWriter.html new file mode 100644 index 000000000..7ca213ed5 --- /dev/null +++ b/7.x/docs/classes/AuxiliaryLinkMetadataWriter.html @@ -0,0 +1,231 @@ +AuxiliaryLinkMetadataWriter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AuxiliaryLinkMetadataWriter

+
+

A MetadataWriter that takes a specific auxiliaryStrategy and relation type as input and +creates a Link header with the strategy identifier and the relation type as "rel" value.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
auxiliaryStrategy +logger +relationType +specificStrategy +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly auxiliaryStrategy

+
auxiliaryStrategy: AuxiliaryStrategy
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly relationType

+
relationType: string
+
+

Private Readonly specificStrategy

+
specificStrategy: AuxiliaryStrategy
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/AuxiliaryReader.html b/7.x/docs/classes/AuxiliaryReader.html new file mode 100644 index 000000000..0db010f8c --- /dev/null +++ b/7.x/docs/classes/AuxiliaryReader.html @@ -0,0 +1,242 @@ +AuxiliaryReader | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class AuxiliaryReader

+
+

Determines the permissions of auxiliary resources by finding those of the corresponding subject resources.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
auxiliaryStrategy +logger +reader +
+
+

Methods

+
canHandle +findAuxiliaries +handle +handleSafe +isDependentAuxiliary +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly auxiliaryStrategy

+
auxiliaryStrategy: AuxiliaryStrategy
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly reader

+
reader: PermissionReader
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Private findAuxiliaries

+
+
+

handle

+
+
+

handleSafe

+
+
+

Private isDependentAuxiliary

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BadRequestHttpError.html b/7.x/docs/classes/BadRequestHttpError.html new file mode 100644 index 000000000..d82616814 --- /dev/null +++ b/7.x/docs/classes/BadRequestHttpError.html @@ -0,0 +1,238 @@ +BadRequestHttpError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BadRequestHttpError

+
+

An error thrown when incoming data is not supported. +Probably because an AsyncHandler returns false on the canHandle call.

+
+
+
+

Hierarchy

+
    +
  • BaseHttpError +
      +
    • BadRequestHttpError
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
cause? +errorCode +message +metadata +name +stack? +statusCode +isInstance +statusCode +uri +
+
+

Methods

+
generateMetadata +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Optional Readonly cause

+
cause?: unknown
+
+

Readonly errorCode

+
errorCode: string
+
+

message

+
message: string
+
+

Readonly metadata

+
metadata: RepresentationMetadata
+
+

name

+
name: string
+
+

Optional stack

+
stack?: string
+
+

Readonly statusCode

+
statusCode: 400
+
+

Static Readonly isInstance

+
isInstance: ((error) => error is HttpError<400>)
+
+

Type declaration

+
    +
  • +
      +
    • (error): error is HttpError<400>
      • +
    • +

      Checks whether the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: unknown
      +

      Returns error is HttpError<400>

      +
+
+

Static Readonly statusCode

+
statusCode: 400
+

The status code corresponding to this error class.

+
+
+
+

Static Readonly uri

+
uri: NamedNode<string>
+

A unique URI identifying this error class.

+
+
+
+

Methods

+
+

Protected generateMetadata

+
    + +
  • +

    Initializes the error metadata.

    +
    +

    Returns void

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/Base64EncodingStorage.html b/7.x/docs/classes/Base64EncodingStorage.html new file mode 100644 index 000000000..be4a08929 --- /dev/null +++ b/7.x/docs/classes/Base64EncodingStorage.html @@ -0,0 +1,279 @@ +Base64EncodingStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class Base64EncodingStorage<T>

+
+

Encodes the input key with base64 encoding, +to make sure there are no invalid or special path characters.

+
+
+
+

Type Parameters

+
    +
  • +

    T

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
source +
+
+

Methods

+
delete +entries +get +has +set +toNewKey +toOriginalKey +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly source

+
source: KeyValueStorage<string, T>
+
+

Methods

+
+

delete

+
+
+

entries

+
+
+

get

+
+
+

has

+
+
+

set

+
+
+

Protected toNewKey

+
+
+

Protected toOriginalKey

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseAccountIdRoute.html b/7.x/docs/classes/BaseAccountIdRoute.html new file mode 100644 index 000000000..2a56ca242 --- /dev/null +++ b/7.x/docs/classes/BaseAccountIdRoute.html @@ -0,0 +1,158 @@ +BaseAccountIdRoute | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseAccountIdRoute

+
+

Implementation of an AccountIdRoute that adds the identifier relative to a base InteractionRoute.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
getPath +matchPath +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

getPath

+
    + +
  • +

    Returns the path that is the result of having the specified values for the dynamic parameters.

    +

    Will throw an error in case the input parameters object is missing one of the expected keys.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional parameters: Record<"accountId", string>
      +

      Values for the dynamic parameters.

      +
      +
    +

    Returns string

    +
+
+

matchPath

+
    + +
  • +

    Checks if the provided path matches the route (pattern).

    +

    The result will be undefined if there is no match.

    +

    If there is a match the result object will have the corresponding values for all the parameters.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      The path to verify.

      +
      +
    +

    Returns undefined | Record<"accountId", string>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseAccountStore.html b/7.x/docs/classes/BaseAccountStore.html new file mode 100644 index 000000000..20721b973 --- /dev/null +++ b/7.x/docs/classes/BaseAccountStore.html @@ -0,0 +1,295 @@ +BaseAccountStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseAccountStore

+
+

A AccountStore that uses an AccountLoginStorage to keep track of the accounts. +Needs to be initialized before it can be used.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
initialized +logger +storage +
+
+

Methods

+
canHandle +create +getSetting +handle +handleSafe +updateSetting +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private initialized

+
initialized: boolean = false
+
+

Private Readonly logger

+
logger: Logger = ...
+
+

Private Readonly storage

+
storage: AccountLoginStorage<{
    account: {
        rememberLogin: "boolean?";
    };
}>
+
+

Type declaration

+
    +
  • +
    account: {
        rememberLogin: "boolean?";
    }
    +
      +
    • +
      Readonly rememberLogin: "boolean?"
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

create

+
    + +
  • +

    Creates a new and empty account. +Since this account will not yet have a login method, +implementations should restrict what is possible with this account, +and should potentially have something in place to clean these accounts up if they are unused.

    +
    +

    Returns Promise<string>

    +
+
+

getSetting

+
+
+

handle

+
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      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.

    + +
+
+

updateSetting

+
    + +
  • +

    Updates the settings for the account with the given identifier to the new values.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends "rememberLogin"

    +
    +

    Parameters

    +
      +
    • +
      id: string
      +

      The account identifier.

      +
      +
      • +
    • +
      setting: T
      +

      The setting to update.

      +
      +
      • +
    • +
      value: AccountSettings[T]
      +

      The new value for the setting.

      +
      +
    +

    Returns Promise<void>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseChannelType.html b/7.x/docs/classes/BaseChannelType.html new file mode 100644 index 000000000..4c7e22991 --- /dev/null +++ b/7.x/docs/classes/BaseChannelType.html @@ -0,0 +1,347 @@ +BaseChannelType | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseChannelTypeAbstract

+
+

A NotificationChannelType that handles the base case of parsing and serializing a notification channel. +Note that the extractModes call always requires Read permissions on the target resource.

+

Uses SHACL to validate the incoming data in initChannel. +Classes extending this can pass extra SHACL properties in the constructor to extend the validation check.

+

The completeChannel implementation is an empty function.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
features +path +shacl +shaclQuads? +type +
+
+

Methods

+
completeChannel +extractModes +getDescription +getShaclQuads +initChannel +quadsToChannel +toJsonLd +validateSubscription +
+
+

Constructors

+
+

Protected constructor

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      type: NamedNode<string>
      +

      The URI of the notification channel type. + This will be added to the SHACL shape to validate incoming subscription data.

      +
      +
      • +
    • +
      route: InteractionRoute<never>
      +

      The route corresponding to the URL of the subscription service of this channel type. + Channel identifiers will be generated by appending a value to this URL.

      +
      +
      • +
    • +
      features: string[] = DEFAULT_NOTIFICATION_FEATURES
      +

      The features that should be enabled for this channel type. + Values are expected to be full URIs, but the notify: prefix can also be used.

      +
      +
      • +
    • +
      additionalShaclProperties: unknown[] = []
      +

      Any additional properties that need to be added to the default SHACL shape.

      +
      +
    +

    Returns BaseChannelType

    +
+
+

Properties

+
+

Protected Readonly features

+
features: NamedNode<string>[]
+
+

Protected Readonly path

+
path: string
+
+

Protected Readonly shacl

+
shacl: unknown
+
+

Protected Optional shaclQuads

+
shaclQuads?: Store<Quad, Quad, Quad, Quad>
+
+

Protected Readonly type

+
type: NamedNode<string>
+
+

Methods

+
+

completeChannel

+
+
+

extractModes

+
+
+

getDescription

+
+
+

Protected getShaclQuads

+
    + +
  • +

    Returns an N3.js Store containing quads corresponding to the stored SHACL representation. +Caches this result so the conversion from JSON-LD to quads only has to happen once.

    +
    +

    Returns Promise<Store<Quad, Quad, Quad, Quad>>

    +
+
+

initChannel

+
+
+

Protected quadsToChannel

+
    + +
  • +

    Converts a set of quads to a NotificationChannel. +Assumes the data is valid, so this should be called after validateSubscription.

    +

    The generated identifier will be a URL made by combining the base URL of the channel type with a unique identifier.

    +

    The values of the default features will be added to the resulting channel, +subclasses with additional features that need to be added are responsible for parsing those quads.

    +
    +
    +

    Parameters

    +
      +
    • +
      data: Store<Quad, Quad, Quad, Quad>
      +

      Data to convert.

      +
      +
      • +
    • +
      subject: Term
      +

      The identifier of the notification channel description in the dataset.

      +
      +
    +

    Returns Promise<NotificationChannel>

    The generated NotificationChannel.

    + +
+
+

toJsonLd

+
+
+

Protected validateSubscription

+
    + +
  • +

    Validates whether the given data conforms to the stored SHACL shape. +Will throw an UnprocessableEntityHttpError if validation fails. +Along with the SHACL check, this also makes sure there is only one matching entry in the dataset.

    +
    +
    +

    Parameters

    +
      +
    • +
      data: Store<Quad, Quad, Quad, Quad>
      +

      The data to validate.

      +
      +
    +

    Returns Promise<Term>

    The focus node that corresponds to the subject of the found notification channel description.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseClientCredentialsIdRoute.html b/7.x/docs/classes/BaseClientCredentialsIdRoute.html new file mode 100644 index 000000000..221d58aff --- /dev/null +++ b/7.x/docs/classes/BaseClientCredentialsIdRoute.html @@ -0,0 +1,153 @@ +BaseClientCredentialsIdRoute | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseClientCredentialsIdRoute

+
+

Implementation of an ClientCredentialsIdRoute +that adds the identifier relative to a base AccountIdRoute.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
getPath +matchPath +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

getPath

+
    + +
  • +

    Returns the path that is the result of having the specified values for the dynamic parameters.

    +

    Will throw an error in case the input parameters object is missing one of the expected keys.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional parameters: Record<"accountId" | "clientCredentialsId", string>
      +

      Values for the dynamic parameters.

      +
      +
    +

    Returns string

    +
+
+

matchPath

+
    + +
  • +

    Checks if the provided path matches the route (pattern).

    +

    The result will be undefined if there is no match.

    +

    If there is a match the result object will have the corresponding values for all the parameters.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      The path to verify.

      +
      +
    +

    Returns undefined | Record<"accountId" | "clientCredentialsId", string>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseClientCredentialsStore.html b/7.x/docs/classes/BaseClientCredentialsStore.html new file mode 100644 index 000000000..90c80a418 --- /dev/null +++ b/7.x/docs/classes/BaseClientCredentialsStore.html @@ -0,0 +1,332 @@ +BaseClientCredentialsStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseClientCredentialsStore

+
+

A ClientCredentialsStore that uses a AccountLoginStorage for storing the tokens. +Needs to be initialized before it can be used.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
initialized +logger +storage +
+
+

Methods

+
canHandle +create +delete +findByAccount +findByLabel +get +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private initialized

+
initialized: boolean = false
+
+

Private Readonly logger

+
logger: Logger = ...
+
+

Private Readonly storage

+
storage: AccountLoginStorage<{
    clientCredentials: {
        accountId: "id:account";
        label: "string";
        secret: "string";
        webId: "string";
    };
}>
+
+

Type declaration

+
    +
  • +
    clientCredentials: {
        accountId: "id:account";
        label: "string";
        secret: "string";
        webId: "string";
    }
    +
      +
    • +
      Readonly accountId: "id:account"
      • +
    • +
      Readonly label: "string"
      • +
    • +
      Readonly secret: "string"
      • +
    • +
      Readonly webId: "string"
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

create

+
+
+

delete

+
+
+

findByAccount

+
+
+

findByLabel

+
+
+

get

+
+
+

handle

+
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      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.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseComponentsJsFactory.html b/7.x/docs/classes/BaseComponentsJsFactory.html new file mode 100644 index 000000000..4feb6aa42 --- /dev/null +++ b/7.x/docs/classes/BaseComponentsJsFactory.html @@ -0,0 +1,171 @@ +BaseComponentsJsFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseComponentsJsFactory

+
+

Can be used to instantiate objects using Components.js. +Default main module path is the root folder of the project. +For every generate call a new manager will be made, +but moduleState will be stored in between calls.

+
+
+
+

Hierarchy

+
    +
  • BaseComponentsJsFactory
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
options +
+
+

Methods

+
buildManager +generate +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly options

+
options: IComponentsManagerBuilderOptions<unknown>
+
+

Methods

+
+

Private buildManager

+
+
+

generate

+
    + +
  • +

    Calls Components.js to instantiate a new object.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      configPath: string
      +

      Location of the config to instantiate.

      +
      +
      • +
    • +
      componentIri: string
      +

      Iri of the object in the config that will be the result.

      +
      +
      • +
    • +
      variables: Record<string, unknown>
      +

      Variables to send to Components.js

      +
      +
    +

    Returns Promise<T>

    The resulting object, corresponding to the given component IRI.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseCookieStore.html b/7.x/docs/classes/BaseCookieStore.html new file mode 100644 index 000000000..389443fc7 --- /dev/null +++ b/7.x/docs/classes/BaseCookieStore.html @@ -0,0 +1,219 @@ +BaseCookieStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseCookieStore

+
+

A CookieStore that uses an ExpiringStorage to keep track of the stored cookies. +Cookies have a specified time to live in seconds, default is 14 days, +after which they will be removed.

+
+
+
+

Hierarchy

+
    +
  • BaseCookieStore
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
storage +ttl +
+
+

Methods

+
delete +generate +get +refresh +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly storage

+
storage: ExpiringStorage<string, string>
+
+

Private Readonly ttl

+
ttl: number
+
+

Methods

+
+

delete

+
+
+

generate

+
    + +
  • +

    Generates and stores a new cookie for the given accountId. +This does not replace previously generated cookies.

    +
    +
    +

    Parameters

    +
      +
    • +
      accountId: string
      +

      Account to create a cookie for.

      +
      +
    +

    Returns Promise<string>

    The generated cookie.

    + +
+
+

get

+
+
+

refresh

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseEmailSender.html b/7.x/docs/classes/BaseEmailSender.html new file mode 100644 index 000000000..1a5df0d6d --- /dev/null +++ b/7.x/docs/classes/BaseEmailSender.html @@ -0,0 +1,204 @@ +BaseEmailSender | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseEmailSender

+
+

Sends e-mails using nodemailer.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +mailTransporter +senderName +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly logger

+
logger: Logger = ...
+
+

Private Readonly mailTransporter

+
mailTransporter: Mail<any>
+
+

Private Readonly senderName

+
senderName: string
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: EmailArgs
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: EmailArgs
      +

      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.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseFileIdentifierMapper.html b/7.x/docs/classes/BaseFileIdentifierMapper.html new file mode 100644 index 000000000..83901c7d6 --- /dev/null +++ b/7.x/docs/classes/BaseFileIdentifierMapper.html @@ -0,0 +1,464 @@ +BaseFileIdentifierMapper | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseFileIdentifierMapper

+
+

Base class for FileIdentifierMapper implementations.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
baseRequestURI +logger +metadataSuffix +rootFilepath +unknownMediaTypeExtension +
+
+

Methods

+
getAbsolutePath +getContainerUrl +getContentTypeFromPath +getContentTypeFromUrl +getDocumentUrl +getRelativePath +isMetadataPath +mapFilePathToUrl +mapUrlToContainerPath +mapUrlToDocumentPath +mapUrlToFilePath +validateRelativePath +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly baseRequestURI

+
baseRequestURI: string
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly metadataSuffix

+
metadataSuffix: ".meta" = '.meta'
+
+

Protected Readonly rootFilepath

+
rootFilepath: string
+
+

Protected Readonly unknownMediaTypeExtension

+
unknownMediaTypeExtension: "unknown" = 'unknown'
+
+

Methods

+
+

Protected getAbsolutePath

+
    + +
  • +

    Get the absolute file path based on the rootFilepath.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      The relative file path.

      +
      +
    +

    Returns string

    Absolute path of the file.

    + +
+
+

Protected getContainerUrl

+
    + +
  • +

    Maps the given container path to a URL and determines its content type.

    +
    +
    +

    Parameters

    +
      +
    • +
      relative: string
      +

      The relative container path.

      +
      +
    +

    Returns Promise<string>

    A ResourceLink with all the necessary metadata.

    + +
+
+

Protected getContentTypeFromPath

+
    + +
  • +

    Determines the content type from the relative path.

    +
    +
    +

    Parameters

    +
      +
    • +
      filePath: string
      +

      The file path of the document.

      +
      +
    +

    Returns Promise<string>

    The content type of the document.

    + +
+
+

Protected getContentTypeFromUrl

+
    + +
  • +

    Determines the content type from the document identifier.

    +
    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      The input identifier.

      +
      +
      • +
    • +
      Optional contentType: string
      +

      The content-type provided with the request.

      +
      +
    +

    Returns Promise<string>

    The content type of the document.

    + +
+
+

Protected getDocumentUrl

+
    + +
  • +

    Maps the given document path to a URL and determines its content type.

    +
    +
    +

    Parameters

    +
      +
    • +
      relative: string
      +

      The relative document path.

      +
      +
    +

    Returns Promise<string>

    A ResourceLink with all the necessary metadata.

    + +
+
+

Protected getRelativePath

+
    + +
  • +

    Strips the baseRequestURI from the identifier.

    +
    +
    +

    Parameters

    +
    +

    Returns string

    A string representing the relative path.

    + +
    +

    Throws

    NotFoundHttpError +If the identifier does not match the baseRequestURI.

    +
+
+

Protected isMetadataPath

+
+
+

mapFilePathToUrl

+
+
+

Protected mapUrlToContainerPath

+
    + +
  • +

    Maps the given container identifier to a file path, +possibly making alterations to the direct translation.

    +
    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      The input identifier.

      +
      +
      • +
    • +
      filePath: string
      +

      The direct translation of the identifier onto the file path.

      +
      +
    +

    Returns Promise<ResourceLink>

    A ResourceLink with all the necessary metadata.

    + +
+
+

Protected mapUrlToDocumentPath

+
    + +
  • +

    Maps the given document identifier to a file path, +possibly making alterations to the direct translation +(for instance, based on its content type)). +Determines the content type if none was provided.

    +
    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      The input identifier.

      +
      +
      • +
    • +
      filePath: string
      +

      The direct translation of the identifier onto the file path.

      +
      +
      • +
    • +
      Optional contentType: string
      +

      The content-type provided with the request.

      +
      +
    +

    Returns Promise<ResourceLink>

    A ResourceLink with all the necessary metadata.

    + +
+
+

mapUrlToFilePath

+
    + +
  • +

    Maps the given resource identifier / URL to a file path. +Determines the content type if none was provided. +For containers the content-type input is ignored.

    +
    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      The input identifier.

      +
      +
      • +
    • +
      isMetadata: boolean
      +

      If we need the data or metadata file path.

      +
      +
      • +
    • +
      Optional contentType: string
      +

      The content-type provided with the request.

      +
      +
    +

    Returns Promise<ResourceLink>

    A ResourceLink with all the necessary metadata.

    + +
+
+

Protected validateRelativePath

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseForgotPasswordStore.html b/7.x/docs/classes/BaseForgotPasswordStore.html new file mode 100644 index 000000000..4078cbfb7 --- /dev/null +++ b/7.x/docs/classes/BaseForgotPasswordStore.html @@ -0,0 +1,198 @@ +BaseForgotPasswordStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseForgotPasswordStore

+
+

A ForgotPasswordStore using an ExpiringStorage to hold the necessary records.

+
+
+
+

Hierarchy

+
    +
  • BaseForgotPasswordStore
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
storage +ttl +
+
+

Methods

+
delete +generate +get +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly storage

+
storage: ExpiringStorage<string, string>
+
+

Private Readonly ttl

+
ttl: number
+
+

Methods

+
+

delete

+
+
+

generate

+
    + +
  • +

    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.

    +
    +
    +

    Parameters

    +
      +
    • +
      email: string
      +

      ID of the email/password login object.

      +
      +
    +

    Returns Promise<string>

    The record id. This should be included in the reset password link.

    + +
+
+

get

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseIdentifierStrategy.html b/7.x/docs/classes/BaseIdentifierStrategy.html new file mode 100644 index 000000000..4ab9d054c --- /dev/null +++ b/7.x/docs/classes/BaseIdentifierStrategy.html @@ -0,0 +1,195 @@ +BaseIdentifierStrategy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseIdentifierStrategyAbstract

+
+

Provides a default implementation for getParentContainer +which checks if the identifier is supported and not a root container. +If not, the last part before the first relevant slash will be removed to find the parent.

+

Provides a default implementation for contains +which does standard slash-semantics based string comparison.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
contains +getParentContainer +isRootContainer +supportsIdentifier +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

contains

+
+
+

getParentContainer

+
+
+

Abstract isRootContainer

+
+
+

Abstract supportsIdentifier

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseLogger.html b/7.x/docs/classes/BaseLogger.html new file mode 100644 index 000000000..022363da2 --- /dev/null +++ b/7.x/docs/classes/BaseLogger.html @@ -0,0 +1,279 @@ +BaseLogger | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseLoggerAbstract

+
+

Base class that implements all additional BaseLogger methods, +leaving only the implementation of SimpleLogger.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
debug +error +getMeta +info +log +silly +verbose +warn +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

debug

+
+
+

error

+
+
+

Private Readonly getMeta

+
+
+

info

+
+
+

Abstract log

+
    + +
  • +

    Log the given message at the given level. +If the internal level is higher than the given level, the message may be voided.

    +
    +
    +

    Parameters

    +
      +
    • +
      level: "error" | "warn" | "info" | "verbose" | "debug" | "silly"
      +

      The level to log at.

      +
      +
      • +
    • +
      message: string
      +

      The message to log.

      +
      +
      • +
    • +
      Optional meta: LogMetadata
      +

      Optional metadata to include in the log message.

      +
      +
    +

    Returns Logger

    +
+
+

silly

+
+
+

verbose

+
+
+

warn

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseLoginAccountStorage.html b/7.x/docs/classes/BaseLoginAccountStorage.html new file mode 100644 index 000000000..c20894a14 --- /dev/null +++ b/7.x/docs/classes/BaseLoginAccountStorage.html @@ -0,0 +1,607 @@ +BaseLoginAccountStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseLoginAccountStorage<T>

+
+

A LoginStorage that wraps around another IndexedStorage to add specific account requirements.

+
    +
  • New accounts will be removed after expiration time, in seconds, default is 1800, +if no login method was added to them in that time.
    • +
  • Non-login types can not be created until the associated account has at least 1 login method.
    • +
  • Login types can not be deleted if they are the last login of the associated account.
    • +
+

All of this is tracked by adding a new field to the account object, +that keeps track of how many login objects are associated with the account.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
    +
  • BaseLoginAccountStorage
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
accountKeys +expiration +logger +loginTypes +storage +
+
+

Methods

+
checkAccount +cleanOutput +create +createAccountTimeout +createIndex +defineType +delete +entries +find +findIds +get +has +set +setField +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly accountKeys

+
accountKeys: Dict<string>
+
+

Private Readonly expiration

+
expiration: number
+
+

Private Readonly logger

+
logger: Logger = ...
+
+

Protected Readonly loginTypes

+
loginTypes: string[]
+
+

Protected Readonly storage

+
storage: IndexedStorage<T>
+
+

Methods

+
+

Protected checkAccount

+
    + +
  • +

    Makes sure of the operation, adding or removing an object of the given type, +is allowed, based on the current amount of login methods on the given account.

    +
    +
    +

    Parameters

    +
      +
    • +
      type: string
      • +
    • +
      accountId: string
      • +
    • +
      add: boolean
    +

    Returns Promise<void>

    +
+
+

Protected cleanOutput

+
    + +
  • +

    Removes the field that keeps track of the login counts, to hide this from the output.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TVal extends undefined | Record<string, unknown>

    +
    +

    Parameters

    +
      +
    • +
      this: void
      • +
    • +
      value: TVal
    +

    Returns TVal

    +
+
+

create

+
+
+

Protected createAccountTimeout

+
+
+

createIndex

+
+
+

defineType

+
    + +
  • +

    Defines a type in the storage, just like in an IndexedStorage, +but additionally it needs to be indicated if the type corresponds to a login method or not.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      Type to define.

      +
      +
      • +
    • +
      description: T[TType]
      +

      Description of the type.

      +
      +
      • +
    • +
      isLogin: boolean
      +

      Whether this type corresponds to a login method or not.

      +
      +
    +

    Returns Promise<void>

    +
+
+

delete

+
    + +
  • +

    Deletes the given object. +This will also delete all objects that reference that object if the corresponding key is not optional.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type of the object to delete.

      +
      +
      • +
    • +
      id: string
      +

      The identifier of the object.

      +
      +
    +

    Returns Promise<void>

    +
+
+

entries

+
+
+

find

+
    + +
  • +

    Finds all objects matching a specific IndexedQuery.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type of objects to find.

      +
      +
      • +
    • +
      query: {
          [K in string | number | symbol]?: ValueType<T[TType][K]> | (T[TType][K] extends `id:${U}`
              ? ({ [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<...> | ... 1 more ... | undefined; } : never) | undefined; } : never) | undefined; })
              : never)
      }
      +

      The query to execute.

      +
      +
    +

    Returns Promise<TypeObject<T[TType]>[]>

    A list of objects matching the query.

    + +
+
+

findIds

+
    + +
  • +

    Similar to IndexedStorage.find, but only returns the identifiers of the found objects.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type of objects to find.

      +
      +
      • +
    • +
      query: {
          [K in string | number | symbol]?: ValueType<T[TType][K]> | (T[TType][K] extends `id:${U}`
              ? ({ [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<...> | ... 1 more ... | undefined; } : never) | undefined; } : never) | undefined; })
              : never)
      }
      +

      The query to execute.

      +
      +
    +

    Returns Promise<string[]>

    A list of identifiers of the matching objects.

    + +
+
+

get

+
    + +
  • +

    Returns the object of the given type with the given identifier.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type of object to get.

      +
      +
      • +
    • +
      id: string
      +

      The identifier of that object.

      +
      +
    +

    Returns Promise<undefined | TypeObject<T[TType]>>

    A representation of the object, or undefined if there is no object of that type with that identifier.

    + +
+
+

has

+
    + +
  • +

    Returns true if the object of the given type with the given identifier exists.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type of object to get.

      +
      +
      • +
    • +
      id: string
      +

      The identifier of that object.

      +
      +
    +

    Returns Promise<boolean>

    Whether this object exists.

    + +
+
+

set

+
    + +
  • +

    Sets the value of a specific object. +The identifier in the object is used to identify the object.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type of the object to set.

      +
      +
      • +
    • +
      value: TypeObject<T[TType]>
      +

      The new value for the object.

      +
      +
    +

    Returns Promise<void>

    +
+
+

setField

+
    + +
  • +

    Sets the value of one specific field in an object.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

      • +
    • +

      TKey extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type of the object to update.

      +
      +
      • +
    • +
      id: string
      +

      The identifier of the object to update.

      +
      +
      • +
    • +
      key: TKey
      +

      The key to update.

      +
      +
      • +
    • +
      value: ValueType<T[TType][TKey]>
      +

      The new value for the given key.

      +
      +
    +

    Returns Promise<void>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BasePasswordIdRoute.html b/7.x/docs/classes/BasePasswordIdRoute.html new file mode 100644 index 000000000..8233f7a91 --- /dev/null +++ b/7.x/docs/classes/BasePasswordIdRoute.html @@ -0,0 +1,152 @@ +BasePasswordIdRoute | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BasePasswordIdRoute

+
+

Implementation of an PasswordIdRoute that adds the identifier relative to a base AccountIdRoute.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
getPath +matchPath +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

getPath

+
    + +
  • +

    Returns the path that is the result of having the specified values for the dynamic parameters.

    +

    Will throw an error in case the input parameters object is missing one of the expected keys.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional parameters: Record<"accountId" | "passwordId", string>
      +

      Values for the dynamic parameters.

      +
      +
    +

    Returns string

    +
+
+

matchPath

+
    + +
  • +

    Checks if the provided path matches the route (pattern).

    +

    The result will be undefined if there is no match.

    +

    If there is a match the result object will have the corresponding values for all the parameters.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      The path to verify.

      +
      +
    +

    Returns undefined | Record<"accountId" | "passwordId", string>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BasePasswordStore.html b/7.x/docs/classes/BasePasswordStore.html new file mode 100644 index 000000000..04fd7fc54 --- /dev/null +++ b/7.x/docs/classes/BasePasswordStore.html @@ -0,0 +1,425 @@ +BasePasswordStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BasePasswordStore

+
+

A PasswordStore that uses a KeyValueStorage to store the entries. +Passwords are hashed and salted. +Default saltRounds is 10.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
initialized +logger +saltRounds +storage +
+
+

Methods

+
authenticate +canHandle +confirmVerification +create +delete +findByAccount +findByEmail +get +handle +handleSafe +update +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private initialized

+
initialized: boolean = false
+
+

Private Readonly logger

+
logger: Logger = ...
+
+

Private Readonly saltRounds

+
saltRounds: number
+
+

Private Readonly storage

+
storage: AccountLoginStorage<{
    password: {
        accountId: "id:account";
        email: "string";
        password: "string";
        verified: "boolean";
    };
}>
+
+

Type declaration

+
    +
  • +
    password: {
        accountId: "id:account";
        email: "string";
        password: "string";
        verified: "boolean";
    }
    +
      +
    • +
      Readonly accountId: "id:account"
      • +
    • +
      Readonly email: "string"
      • +
    • +
      Readonly password: "string"
      • +
    • +
      Readonly verified: "boolean"
+
+

Methods

+
+

authenticate

+
    + +
  • +

    Authenticate if the email and password are correct and return the account and login ID if they are. +Throw an error if they are not.

    +
    +
    +

    Parameters

    +
      +
    • +
      email: string
      +

      The user's email.

      +
      +
      • +
    • +
      password: string
      +

      This user's password.

      +
      +
    +

    Returns Promise<{
        accountId: string;
        id: string;
    }>

    +
+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

confirmVerification

+
    + +
  • +

    Confirms that the login has been verified. +This can be used with, for example, email verification. +The login can only be used after it is verified. +In case verification is not required, this should be called immediately after the create call.

    +
    +
    +

    Parameters

    +
      +
    • +
      id: string
      +

      ID of the login.

      +
      +
    +

    Returns Promise<void>

    +
+
+

create

+
+
+

delete

+
+
+

findByAccount

+
+
+

findByEmail

+
    + +
  • +

    Finds the account and login ID associated with this email.

    +
    +
    +

    Parameters

    +
      +
    • +
      email: string
      +

      Email to find the information for.

      +
      +
    +

    Returns Promise<undefined | {
        accountId: string;
        id: string;
    }>

    +
+
+

get

+
    + +
  • +

    Finds the account and email associated with this login ID.

    +
    +
    +

    Parameters

    +
      +
    • +
      id: string
      +

      The ID of the login object.

      +
      +
    +

    Returns Promise<undefined | {
        accountId: string;
        email: string;
    }>

    +
+
+

handle

+
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      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.

    + +
+
+

update

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BasePodCreator.html b/7.x/docs/classes/BasePodCreator.html new file mode 100644 index 000000000..e23da0f22 --- /dev/null +++ b/7.x/docs/classes/BasePodCreator.html @@ -0,0 +1,291 @@ +BasePodCreator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BasePodCreator

+
+

Handles the creation of pods. +Will call the stored PodStore with the provided settings.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
baseUrl +identifierGenerator +logger +podStore +relativeWebIdPath +webIdStore +
+
+

Methods

+
canHandle +createPod +generateBaseIdentifier +handle +handleSafe +handleWebId +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly baseUrl

+
baseUrl: string
+
+

Protected Readonly identifierGenerator

+
identifierGenerator: IdentifierGenerator
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Protected Readonly podStore

+
podStore: PodStore
+
+

Protected Readonly relativeWebIdPath

+
relativeWebIdPath: string
+
+

Protected Readonly webIdStore

+
webIdStore: WebIdStore
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Protected createPod

+
    + +
  • +

    Creates a pod with the given settings. +In case pod creation fails, the given WebID link will be removed, if there is one, before throwing an error.

    +
    +
    +

    Parameters

    +
      +
    • +
      accountId: string
      • +
    • +
      settings: PodSettings
      • +
    • +
      overwrite: boolean
      • +
    • +
      Optional webIdLink: string
    +

    Returns Promise<string>

    +
+
+

Protected generateBaseIdentifier

+
+
+

handle

+
+
+

handleSafe

+
+
+

Protected handleWebId

+
    + +
  • +

    Links the WebID to the account if linkWebId is true. +Also updates the oidcIssuer value in the settings object in that case.

    +
    +
    +

    Parameters

    +
      +
    • +
      linkWebId: boolean
      • +
    • +
      webId: string
      • +
    • +
      accountId: string
      • +
    • +
      settings: PodSettings
    +

    Returns Promise<undefined | string>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BasePodIdRoute.html b/7.x/docs/classes/BasePodIdRoute.html new file mode 100644 index 000000000..90f4e82ba --- /dev/null +++ b/7.x/docs/classes/BasePodIdRoute.html @@ -0,0 +1,152 @@ +BasePodIdRoute | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BasePodIdRoute

+
+

Implementation of an PodIdRoute that adds the identifier relative to a base AccountIdRoute.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
getPath +matchPath +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

getPath

+
    + +
  • +

    Returns the path that is the result of having the specified values for the dynamic parameters.

    +

    Will throw an error in case the input parameters object is missing one of the expected keys.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional parameters: Record<"accountId" | "podId", string>
      +

      Values for the dynamic parameters.

      +
      +
    +

    Returns string

    +
+
+

matchPath

+
    + +
  • +

    Checks if the provided path matches the route (pattern).

    +

    The result will be undefined if there is no match.

    +

    If there is a match the result object will have the corresponding values for all the parameters.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      The path to verify.

      +
      +
    +

    Returns undefined | Record<"accountId" | "podId", string>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BasePodStore.html b/7.x/docs/classes/BasePodStore.html new file mode 100644 index 000000000..00f97c5dd --- /dev/null +++ b/7.x/docs/classes/BasePodStore.html @@ -0,0 +1,426 @@ +BasePodStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BasePodStore

+
+

A PodStore implementation using a PodManager to create pods +and a AccountLoginStorage to store the data. +Needs to be initialized before it can be used.

+

Adds the initial WebID as the owner of the pod. +By default, this owner is not exposed through a link header. +This can be changed by setting the constructor visible parameter to true.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
initialized +logger +manager +storage +visible +
+
+

Methods

+
canHandle +create +findByBaseUrl +findPods +get +getOwners +handle +handleSafe +removeOwner +updateOwner +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private initialized

+
initialized: boolean = false
+
+

Private Readonly logger

+
logger: Logger = ...
+
+

Private Readonly manager

+
manager: PodManager
+
+

Private Readonly storage

+
storage: AccountLoginStorage<{
    owner: {
        podId: "id:pod";
        visible: "boolean";
        webId: "string";
    };
    pod: {
        accountId: "id:account";
        baseUrl: "string";
    };
}>
+
+

Type declaration

+
    +
  • +
    owner: {
        podId: "id:pod";
        visible: "boolean";
        webId: "string";
    }
    +
      +
    • +
      Readonly podId: "id:pod"
      • +
    • +
      Readonly visible: "boolean"
      • +
    • +
      Readonly webId: "string"
    • +
  • +
    pod: {
        accountId: "id:account";
        baseUrl: "string";
    }
    +
      +
    • +
      Readonly accountId: "id:account"
      • +
    • +
      Readonly baseUrl: "string"
+
+

Private Readonly visible

+
visible: boolean
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

create

+
    + +
  • +

    Creates a new pod and updates the account accordingly.

    +
    +
    +

    Parameters

    +
      +
    • +
      accountId: string
      +

      Identifier of the account that is creating the account.

      +
      +
      • +
    • +
      settings: PodSettings
      +

      Settings to create a pod with.

      +
      +
      • +
    • +
      overwrite: boolean
      +

      If the pod is allowed to overwrite existing data.

      +
      +
    +

    Returns Promise<string>

    The ID of the new pod resource.

    + +
+
+

findByBaseUrl

+
    + +
  • +

    Find the ID of the account that created the given pod.

    +
    +
    +

    Parameters

    +
      +
    • +
      baseUrl: string
      +

      The pod base URL.

      +
      +
    +

    Returns Promise<undefined | {
        accountId: string;
        id: string;
    }>

    +
+
+

findPods

+
    + +
  • +

    Find all the pod resources created by the given account ID.

    +
    +
    +

    Parameters

    +
      +
    • +
      accountId: string
      +

      Account ID to find pod resources for.

      +
      +
    +

    Returns Promise<{
        baseUrl: string;
        id: string;
    }[]>

    +
+
+

get

+
    + +
  • +

    Returns the baseURl and account that created the pod for the given pod ID.

    +
    +
    +

    Parameters

    +
      +
    • +
      id: string
      +

      ID of the pod.

      +
      +
    +

    Returns Promise<undefined | {
        accountId: string;
        baseUrl: string;
    }>

    +
+
+

getOwners

+
    + +
  • +

    Find all owners for the given pod ID.

    +
    +
    +

    Parameters

    +
      +
    • +
      id: string
      +

      ID of the pod.

      +
      +
    +

    Returns Promise<undefined | {
        visible: boolean;
        webId: string;
    }[]>

    +
+
+

handle

+
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      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.

    + +
+
+

removeOwner

+
+
+

updateOwner

+
    + +
  • +

    Add or update an owner of a pod. +In case there already is an owner with this WebID, it will be updated, +otherwise a new owner will be added.

    +
    +
    +

    Parameters

    +
      +
    • +
      id: string
      +

      ID of the pod.

      +
      +
      • +
    • +
      webId: string
      +

      WebID of the owner.

      +
      +
      • +
    • +
      visible: boolean
      +

      Whether the owner wants to be exposed or not.

      +
      +
    +

    Returns Promise<void>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseReadWriteLocker.html b/7.x/docs/classes/BaseReadWriteLocker.html new file mode 100644 index 000000000..e909b47a6 --- /dev/null +++ b/7.x/docs/classes/BaseReadWriteLocker.html @@ -0,0 +1,383 @@ +BaseReadWriteLocker | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseReadWriteLockerAbstract

+
+

A ReadWriteLocker that allows for multiple simultaneous read operations. +Write operations will be blocked as long as read operations are not finished. +New read operations are allowed while this is going on, which will cause write operations to wait longer.

+

Based on https://en.wikipedia.org/wiki/Readers%E2%80%93writer_lock#Using_two_mutexes . +As soon as 1 read lock request is made, the main lock is locked. +Internally a counter keeps track of the amount of active read locks. +Only when this number reaches 0 will the main lock be released again. +The internal count lock is only locked to increase/decrease this counter and is released afterwards. +This allows for multiple read operations, although only 1 at the time can update the counter, +which means there can still be a small waiting period if there are multiple simultaneous read operations.

+

Classes extending this need to implement getCountLockIdentifier and modifyCount.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
countLocker +locker +
+
+

Methods

+
acquireReadLock +getCountLockIdentifier +modifyCount +releaseReadLock +withInternalCountLock +withLock +withReadLock +withWriteLock +
+
+

Constructors

+
+

Protected constructor

+
+
+

Properties

+
+

Protected Readonly countLocker

+
countLocker: ResourceLocker
+
+

Protected Readonly locker

+
locker: ResourceLocker
+
+

Methods

+
+

Private acquireReadLock

+
+
+

Protected Abstract getCountLockIdentifier

+
    + +
  • +

    Generate the identifier that will be used to acquire the count lock for the given identifier. +There will be cases where this lock needs to be acquired +while an active lock on the main resource is still being maintained. +This means that if the input resourceLocker and countLocker use the same locking system +this generated identifier needs to be different.

    +
    +
    +

    Parameters

    +
    +

    Returns ResourceIdentifier

    +
+
+

Protected Abstract modifyCount

+
+
+

Private releaseReadLock

+
+
+

Private withInternalCountLock

+
+
+

Protected withLock

+
+
+

withReadLock

+
    + +
  • +

    Run the given function while the resource is locked. +The lock will be released when the (async) input function resolves. +This function should be used for operations that only require reading the resource.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
    +

    Returns Promise<T>

    A promise resolving when the lock is released.

    + +
+
+

withWriteLock

+
    + +
  • +

    Run the given function while the resource is locked. +The lock will be released when the (async) input function resolves. +This function should be used for operations that could modify the resource.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
    +

    Returns Promise<T>

    A promise resolving when the lock is released.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseResourceStore.html b/7.x/docs/classes/BaseResourceStore.html new file mode 100644 index 000000000..594049d84 --- /dev/null +++ b/7.x/docs/classes/BaseResourceStore.html @@ -0,0 +1,284 @@ +BaseResourceStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseResourceStore

+
+

Base implementation of ResourceStore for implementers of custom stores.

+
+
+
+

Hierarchy

+
    +
  • BaseResourceStore
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
addResource +deleteResource +getRepresentation +hasResource +modifyResource +setRepresentation +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

addResource

+
+
+

deleteResource

+
+
+

getRepresentation

+
+
+

hasResource

+
+
+

modifyResource

+
+
+

setRepresentation

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseResourcesGenerator.html b/7.x/docs/classes/BaseResourcesGenerator.html new file mode 100644 index 000000000..e002a1574 --- /dev/null +++ b/7.x/docs/classes/BaseResourcesGenerator.html @@ -0,0 +1,330 @@ +BaseResourcesGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseResourcesGenerator

+
+

Generates resources by making use of a template engine. +The template folder structure will be kept. +Folders will be interpreted as containers and files as documents. +A FileIdentifierMapper will be used to generate identifiers that correspond to the relative structure.

+

Metadata resources will be yielded separately from their subject resource.

+

A relative templateFolder is resolved relative to cwd, +unless it's preceded by @css:, e.g. @css:foo/bar.

+
+
+
+

Hierarchy

+
    +
  • BaseResourcesGenerator
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
factory +logger +metadataStrategy +store +templateEngine +templateExtension +
+
+

Methods

+
generate +generateMetadata +generateResource +groupLinks +processFile +processFolder +toTemplateLink +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly factory

+
factory: FileIdentifierMapperFactory<FileIdentifierMapper>
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly metadataStrategy

+
metadataStrategy: AuxiliaryStrategy
+
+

Private Readonly store

+
store: ResourceSet
+
+

Private Readonly templateEngine

+
templateEngine: TemplateEngine<Dict<unknown>>
+
+

Private Readonly templateExtension

+
templateExtension: string
+
+

Methods

+
+

generate

+
    + +
  • +

    Generates resources with the given options, based on the given template folder. +The output Iterable should be sorted so that containers always appear before their contents.

    +
    +
    +

    Parameters

    +
      +
    • +
      templateFolder: string
      +

      Folder where the templates are located.

      +
      +
      • +
    • +
      location: ResourceIdentifier
      +

      Base identifier.

      +
      +
      • +
    • +
      options: Dict<unknown>
      +

      Options that can be used when generating resources.

      +
      +
    +

    Returns AsyncIterable<Resource>

    A map where the keys are the identifiers and the values the corresponding representations to store.

    + +
+
+

Private generateMetadata

+
+
+

Private generateResource

+
    + +
  • +

    Generates a Resource object for the given ResourceLink. +In the case of documents the corresponding template will be used. +If a ResourceLink of metadata is provided the corresponding metadata resource +will be yielded as a separate resource.

    +
    +
    +

    Parameters

    +
      +
    • +
      link: TemplateResourceLink
      • +
    • +
      options: Dict<unknown>
      • +
    • +
      Optional metaLink: TemplateResourceLink
    +

    Returns AsyncIterable<Resource>

    +
+
+

Private groupLinks

+
    + +
  • +

    Generates TemplateResourceLinks for each entry in the given folder +and combines the results so resources and their metadata are grouped together.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Record<string, {
        link: TemplateResourceLink;
        meta?: TemplateResourceLink;
    }>>

    +
+
+

Private processFile

+
    + +
  • +

    Creates a read stream from the file and applies the template if necessary.

    +
    +
    +

    Parameters

    +
      +
    • +
      link: TemplateResourceLink
      • +
    • +
      contents: Dict<unknown>
    +

    Returns Promise<Guarded<Readable>>

    +
+
+

Private processFolder

+
+
+

Private toTemplateLink

+
    + +
  • +

    Creates a TemplateResourceLink for the given filePath, +which connects a resource URL to its template file. +The identifier will be based on the file path stripped from the template extension, +but the filePath parameter will still point to the original file.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<TemplateResourceLink>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseRouterHandler.html b/7.x/docs/classes/BaseRouterHandler.html new file mode 100644 index 000000000..ae2a52def --- /dev/null +++ b/7.x/docs/classes/BaseRouterHandler.html @@ -0,0 +1,252 @@ +BaseRouterHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseRouterHandler<T>Abstract

+
+

Checks if a given method and path are satisfied and allows its handler to be executed if so.

+

Implementations of this class should call canHandleInput in their canHandle call with the correct parameters.

+

canHandleInput expects a ResourceIdentifier to indicate it expects the target to have been validated already.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
allMethods +allowedMethods +allowedPathNamesRegEx +baseUrlLength +handler +
+
+

Methods

+
canHandle +canHandleInput +handle +handleSafe +
+
+

Constructors

+
+

Protected constructor

+
+
+

Properties

+
+

Protected Readonly allMethods

+
allMethods: boolean
+
+

Protected Readonly allowedMethods

+
allowedMethods: string[]
+
+

Protected Readonly allowedPathNamesRegEx

+
allowedPathNamesRegEx: RegExp[]
+
+

Protected Readonly baseUrlLength

+
baseUrlLength: number
+
+

Protected Readonly handler

+
handler: T
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Protected canHandleInput

+
+
+

handle

+
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: AsyncHandlerInput<T>
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<Awaited<ReturnType<T["handle"]>>>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseServerFactory.html b/7.x/docs/classes/BaseServerFactory.html new file mode 100644 index 000000000..168d35e8e --- /dev/null +++ b/7.x/docs/classes/BaseServerFactory.html @@ -0,0 +1,160 @@ +BaseServerFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseServerFactory

+
+

Creates an HTTP(S) server native Node.js http/https modules.

+

Will apply a ServerConfigurator to the server, +which should be used to attach listeners.

+
+
+
+

Hierarchy

+
    +
  • BaseServerFactory
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
configurator +logger +options +
+
+

Methods

+
createServer +createServerOptions +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly configurator

+
configurator: ServerConfigurator
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly options

+
options: BaseServerFactoryOptions
+
+

Methods

+
+

createServer

+
+
+

Private createServerOptions

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseStateHandler.html b/7.x/docs/classes/BaseStateHandler.html new file mode 100644 index 000000000..7d25b1078 --- /dev/null +++ b/7.x/docs/classes/BaseStateHandler.html @@ -0,0 +1,217 @@ +BaseStateHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseStateHandler

+
+

Handles the state feature by calling a NotificationHandler +in case the NotificationChannel has a state value.

+

Deletes the state parameter from the channel afterwards.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
handler +logger +storage +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly handler

+
handler: NotificationHandler
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly storage

+
storage: NotificationChannelStorage
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseTypedRepresentationConverter.html b/7.x/docs/classes/BaseTypedRepresentationConverter.html new file mode 100644 index 000000000..24bb21a78 --- /dev/null +++ b/7.x/docs/classes/BaseTypedRepresentationConverter.html @@ -0,0 +1,233 @@ +BaseTypedRepresentationConverter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseTypedRepresentationConverterAbstract

+
+

A base TypedRepresentationConverter implementation for converters +that can convert from all its input types to all its output types.

+

This base class handles the canHandle call by comparing the input content type to the stored input types +and the output preferences to the stored output types.

+

Output weights are determined by multiplying all stored output weights with the weight of the input type.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
inputTypes +outputTypes +
+
+

Methods

+
canHandle +getOutputTypes +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected inputTypes

+
inputTypes: Promise<ValuePreferences>
+
+

Protected outputTypes

+
outputTypes: Promise<ValuePreferences>
+
+

Methods

+
+

canHandle

+
+
+

getOutputTypes

+
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseUrlExtractor.html b/7.x/docs/classes/BaseUrlExtractor.html new file mode 100644 index 000000000..9404bc8f2 --- /dev/null +++ b/7.x/docs/classes/BaseUrlExtractor.html @@ -0,0 +1,191 @@ +BaseUrlExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseUrlExtractor

+
+

A ShorthandExtractor that that generates the base URL based on the input baseUrl value, +or by using the port if the first isn't provided.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
defaultPort +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly defaultPort

+
defaultPort: number
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Shorthand
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Shorthand
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<unknown>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseUrlHandler.html b/7.x/docs/classes/BaseUrlHandler.html new file mode 100644 index 000000000..e73881016 --- /dev/null +++ b/7.x/docs/classes/BaseUrlHandler.html @@ -0,0 +1,188 @@ +BaseUrlHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseUrlHandler

+
+

Adds the pod identifier as base url variable to the agent. +This allows for config templates that require a value for TEMPLATE_BASE_URL_URN, +which should equal the pod identifier.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseUrlRouterRule.html b/7.x/docs/classes/BaseUrlRouterRule.html new file mode 100644 index 000000000..aea50ed8d --- /dev/null +++ b/7.x/docs/classes/BaseUrlRouterRule.html @@ -0,0 +1,236 @@ +BaseUrlRouterRule | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseUrlRouterRule

+
+

Routes requests based on their base url. +Checks if any of the stored base URLs match the request identifier. +If there are no matches the base store will be returned if one was configured.

+

Part of the dynamic pod creation. +Uses the identifiers that were added to the routing storage.

+
+
+

See

TemplatedPodGenerator, ConfigPodInitializer, ConfigPodManager

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
baseStore? +stores +
+
+

Methods

+
canHandle +findStore +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Optional Readonly baseStore

+
baseStore?: ResourceStore
+
+

Private Readonly stores

+
stores: KeyValueStorage<string, ResourceStore>
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Private findStore

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseUrlVerifier.html b/7.x/docs/classes/BaseUrlVerifier.html new file mode 100644 index 000000000..9c758d34a --- /dev/null +++ b/7.x/docs/classes/BaseUrlVerifier.html @@ -0,0 +1,208 @@ +BaseUrlVerifier | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseUrlVerifier

+
+

Stores the baseUrl value that was used to start the server +and warns the user in case it differs from the previous one.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
baseUrl +logger +storage +storageKey +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly baseUrl

+
baseUrl: string
+
+

Private Readonly logger

+
logger: Logger = ...
+
+

Private Readonly storage

+
storage: KeyValueStorage<string, string>
+
+

Private Readonly storageKey

+
storageKey: string
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +

    Returns Promise<void>

    A promise resolving when handling is finished.

    + +
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      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.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseWebIdLinkRoute.html b/7.x/docs/classes/BaseWebIdLinkRoute.html new file mode 100644 index 000000000..51d30dd31 --- /dev/null +++ b/7.x/docs/classes/BaseWebIdLinkRoute.html @@ -0,0 +1,152 @@ +BaseWebIdLinkRoute | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseWebIdLinkRoute

+
+

Implementation of an WebIdLinkRoute that adds the identifier relative to a base AccountIdRoute.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
getPath +matchPath +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

getPath

+
    + +
  • +

    Returns the path that is the result of having the specified values for the dynamic parameters.

    +

    Will throw an error in case the input parameters object is missing one of the expected keys.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional parameters: Record<"accountId" | "webIdLink", string>
      +

      Values for the dynamic parameters.

      +
      +
    +

    Returns string

    +
+
+

matchPath

+
    + +
  • +

    Checks if the provided path matches the route (pattern).

    +

    The result will be undefined if there is no match.

    +

    If there is a match the result object will have the corresponding values for all the parameters.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      The path to verify.

      +
      +
    +

    Returns undefined | Record<"accountId" | "webIdLink", string>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BaseWebIdStore.html b/7.x/docs/classes/BaseWebIdStore.html new file mode 100644 index 000000000..76f4ad4b1 --- /dev/null +++ b/7.x/docs/classes/BaseWebIdStore.html @@ -0,0 +1,326 @@ +BaseWebIdStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BaseWebIdStore

+
+

A WebIdStore using a AccountLoginStorage to store the links. +Needs to be initialized before it can be used.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
initialized +logger +storage +
+
+

Methods

+
canHandle +create +delete +findLinks +get +handle +handleSafe +isLinked +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private initialized

+
initialized: boolean = false
+
+

Private Readonly logger

+
logger: Logger = ...
+
+

Private Readonly storage

+
storage: AccountLoginStorage<{
    webIdLink: {
        accountId: "id:account";
        webId: "string";
    };
}>
+
+

Type declaration

+
    +
  • +
    webIdLink: {
        accountId: "id:account";
        webId: "string";
    }
    +
      +
    • +
      Readonly accountId: "id:account"
      • +
    • +
      Readonly webId: "string"
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

create

+
+
+

delete

+
+
+

findLinks

+
    + +
  • +

    Finds all links associated with the given account.

    +
    +
    +

    Parameters

    +
      +
    • +
      accountId: string
      +

      ID of the account.

      +
      +
    +

    Returns Promise<{
        id: string;
        webId: string;
    }[]>

    +
+
+

get

+
    + +
  • +

    Finds the account and WebID of the link with the given ID.

    +
    +
    +

    Parameters

    +
      +
    • +
      id: string
    +

    Returns Promise<undefined | {
        accountId: string;
        webId: string;
    }>

    +
+
+

handle

+
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      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.

    + +
+
+

isLinked

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BasicConditions.html b/7.x/docs/classes/BasicConditions.html new file mode 100644 index 000000000..710bf803e --- /dev/null +++ b/7.x/docs/classes/BasicConditions.html @@ -0,0 +1,193 @@ +BasicConditions | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BasicConditions

+
+

Stores all the relevant Conditions values and matches them based on RFC7232.

+
+
+
+

Hierarchy

+
    +
  • BasicConditions
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
eTagHandler +matchesETag? +modifiedSince? +notMatchesETag? +unmodifiedSince? +
+
+

Methods

+
matchesMetadata +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly eTagHandler

+
eTagHandler: ETagHandler
+
+

Optional Readonly matchesETag

+
matchesETag?: string[]
+

Valid if matching any of the given ETags.

+
+
+
+

Optional Readonly modifiedSince

+
modifiedSince?: Date
+

Valid if modified since the given date.

+
+
+
+

Optional Readonly notMatchesETag

+
notMatchesETag?: string[]
+

Valid if not matching any of the given ETags.

+
+
+
+

Optional Readonly unmodifiedSince

+
unmodifiedSince?: Date
+

Valid if not modified since the given date.

+
+
+
+

Methods

+
+

matchesMetadata

+
    + +
  • +

    Checks validity based on the given metadata.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional metadata: RepresentationMetadata
      +

      Metadata of the representation. Undefined if the resource does not exist.

      +
      +
      • +
    • +
      Optional strict: boolean
      +

      How to compare the ETag related headers. + If true, the comparison will happen on representation level. + If false, the comparison happens on resource level, ignoring the content-type.

      +
      +
    +

    Returns boolean

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BasicConditionsParser.html b/7.x/docs/classes/BasicConditionsParser.html new file mode 100644 index 000000000..55f41b06d --- /dev/null +++ b/7.x/docs/classes/BasicConditionsParser.html @@ -0,0 +1,246 @@ +BasicConditionsParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BasicConditionsParser

+
+

Creates a Conditions object based on the following headers:

+
    +
  • If-Modified-Since
    • +
  • If-Unmodified-Since
    • +
  • If-Match
    • +
  • If-None-Match
    • +
+

Implementation based on RFC7232

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
eTagHandler +logger +
+
+

Methods

+
canHandle +handle +handleSafe +parseDateHeader +parseTagHeader +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly eTagHandler

+
eTagHandler: ETagHandler
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: HttpRequest
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+

Private parseDateHeader

+
    + +
  • +

    Converts a request header containing a datetime string to an actual Date object. +Undefined if there is no value for the given header name.

    +
    +
    +

    Parameters

    +
      +
    • +
      request: HttpRequest
      • +
    • +
      header: "if-modified-since" | "if-unmodified-since"
    +

    Returns undefined | Date

    +
+
+

Private parseTagHeader

+
    + +
  • +

    Converts a request header containing ETags to an array of ETags. +Undefined if there is no value for the given header name.

    +
    +
    +

    Parameters

    +
      +
    • +
      request: HttpRequest
      • +
    • +
      header: "if-match" | "if-none-match"
    +

    Returns undefined | string[]

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BasicETagHandler.html b/7.x/docs/classes/BasicETagHandler.html new file mode 100644 index 000000000..7d6ba1cbf --- /dev/null +++ b/7.x/docs/classes/BasicETagHandler.html @@ -0,0 +1,183 @@ +BasicETagHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BasicETagHandler

+
+

Standard implementation of ETagHandler. +ETags are constructed by combining the last modified date with the content type of the representation.

+
+
+
+

Hierarchy

+
    +
  • BasicETagHandler
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
getETag +matchesETag +sameResourceState +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

getETag

+
+
+

matchesETag

+
    + +
  • +

    Validates whether the given metadata corresponds to the given ETag.

    +
    +
    +

    Parameters

    +
      +
    • +
      metadata: RepresentationMetadata
      +

      Metadata of the resource.

      +
      +
      • +
    • +
      eTag: string
      +

      ETag to compare to.

      +
      +
      • +
    • +
      strict: boolean
      +

      True if the comparison needs to be on representation level. + False if it is on resource level and the content-type doesn't matter.

      +
      +
    +

    Returns boolean

    +
+
+

sameResourceState

+
    + +
  • +

    Validates whether 2 ETags correspond to the same state of a resource, +independent of the representation the ETags correspond to.

    +
    +
    +

    Parameters

    +
      +
    • +
      eTag1: string
      +

      First ETag to compare.

      +
      +
      • +
    • +
      eTag2: string
      +

      Second ETag to compare.

      +
      +
    +

    Returns boolean

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BasicRepresentation.html b/7.x/docs/classes/BasicRepresentation.html new file mode 100644 index 000000000..e07423725 --- /dev/null +++ b/7.x/docs/classes/BasicRepresentation.html @@ -0,0 +1,301 @@ +BasicRepresentation | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BasicRepresentation

+
+

Class with various constructors to facilitate creating a representation.

+

A representation consists of 1) data, 2) metadata, and 3) a binary flag +to indicate whether the data is a binary stream or an object stream.

+
    +
  1. The data can be given as a stream, array, or string.
    2. +
  2. The metadata can be specified as one or two parameters +that will be passed to the RepresentationMetadata constructor.
    3. +
  3. The binary field is optional, and if not specified, +is determined from the content type inside the metadata.
    4. +
+
+
+
+

Hierarchy

+
    +
  • BasicRepresentation
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
binary +data +metadata +
+
+

Accessors

+
isEmpty +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly binary

+
binary: boolean
+

Whether the data stream consists of binary/string chunks +(as opposed to complex objects).

+
+
+
+

Readonly data

+
data: Guarded<Readable>
+

The raw data stream for this representation.

+
+
+
+

Readonly metadata

+
metadata: RepresentationMetadata
+

The corresponding metadata.

+
+
+
+

Accessors

+
+

isEmpty

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BasicRequestParser.html b/7.x/docs/classes/BasicRequestParser.html new file mode 100644 index 000000000..dc9acd2b7 --- /dev/null +++ b/7.x/docs/classes/BasicRequestParser.html @@ -0,0 +1,220 @@ +BasicRequestParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BasicRequestParser

+
+

Creates an Operation from an incoming HttpRequest by aggregating the results +of a TargetExtractor, MetadataParser, +ConditionsParser and BodyParser.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
bodyParser +conditionsParser +metadataParser +preferenceParser +targetExtractor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly bodyParser

+
bodyParser: BodyParser
+
+

Private Readonly conditionsParser

+
conditionsParser: ConditionsParser
+
+

Private Readonly metadataParser

+
metadataParser: MetadataParser
+
+

Private Readonly preferenceParser

+
preferenceParser: PreferenceParser
+
+

Private Readonly targetExtractor

+
targetExtractor: TargetExtractor
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: HttpRequest
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BasicResponseWriter.html b/7.x/docs/classes/BasicResponseWriter.html new file mode 100644 index 000000000..219978ad2 --- /dev/null +++ b/7.x/docs/classes/BasicResponseWriter.html @@ -0,0 +1,212 @@ +BasicResponseWriter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BasicResponseWriter

+
+

Writes to an HttpResponse based on the incoming ResponseDescription.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +metadataWriter +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly metadataWriter

+
metadataWriter: MetadataWriter
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BearerWebIdExtractor.html b/7.x/docs/classes/BearerWebIdExtractor.html new file mode 100644 index 000000000..8cc9e8e07 --- /dev/null +++ b/7.x/docs/classes/BearerWebIdExtractor.html @@ -0,0 +1,192 @@ +BearerWebIdExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BearerWebIdExtractor

+
+

Responsible for extracting credentials from an incoming request.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +verify +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly verify

+
verify: SolidTokenVerifierFunction
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      __namedParameters: HttpRequest
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BinarySliceResourceStore.html b/7.x/docs/classes/BinarySliceResourceStore.html new file mode 100644 index 000000000..3e1a6b58d --- /dev/null +++ b/7.x/docs/classes/BinarySliceResourceStore.html @@ -0,0 +1,325 @@ +BinarySliceResourceStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BinarySliceResourceStore<T>

+
+

Resource store that slices the data stream if there are range preferences. +Only works for bytes range preferences on binary data streams. +Does not support multipart range requests.

+

If the slice happens, unit/start/end values will be written to the metadata to indicate such. +The values are dependent on the preferences we got as an input, +as we don't know the actual size of the data stream.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +source +
+
+

Methods

+
addResource +deleteResource +getRepresentation +hasResource +modifyResource +setRepresentation +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Protected Readonly source

+
source: T
+
+

Methods

+
+

addResource

+
+
+

deleteResource

+
+
+

getRepresentation

+
+
+

hasResource

+
+
+

modifyResource

+
+
+

setRepresentation

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BodyParser.html b/7.x/docs/classes/BodyParser.html new file mode 100644 index 000000000..1f238d32c --- /dev/null +++ b/7.x/docs/classes/BodyParser.html @@ -0,0 +1,175 @@ +BodyParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BodyParserAbstract

+
+

Parses the body of an incoming HttpRequest and converts it to a Representation.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: BodyParserArgs
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/BooleanHandler.html b/7.x/docs/classes/BooleanHandler.html new file mode 100644 index 000000000..c8e108155 --- /dev/null +++ b/7.x/docs/classes/BooleanHandler.html @@ -0,0 +1,214 @@ +BooleanHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class BooleanHandler<TIn>

+
+

A composite handler that returns true if any of its handlers can handle the input and return true. +Handler errors are interpreted as false results.

+
+
+
+

Type Parameters

+
    +
  • +

    TIn

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
handlers +logger +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly handlers

+
handlers: AsyncHandler<TIn, boolean>[]
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<boolean>

    A promise resolving when handling is finished.

    + +
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<boolean>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CachedHandler.html b/7.x/docs/classes/CachedHandler.html new file mode 100644 index 000000000..c6cdc3ee0 --- /dev/null +++ b/7.x/docs/classes/CachedHandler.html @@ -0,0 +1,273 @@ +CachedHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CachedHandler<TIn, TOut>

+
+

Caches output data from the source handler based on the input object. +The fields parameter can be used to instead use one or more specific entries from the input object as cache key, +so has as actual required typing (keyof TIn)[].

+

A WeakMap is used internally so strict object equality determines cache hits, +and data will be removed once the key stops existing. +This also means that the cache key needs to be an object. +Errors will be thrown in case a primitive is used.

+
+
+
+

Type Parameters

+
    +
  • +

    TIn extends Record<string, unknown>

    • +
  • +

    TOut = void

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
cache +fields? +source +
+
+

Methods

+
canHandle +findDestination +getKeys +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly cache

+
cache: WeakMap<object, NestedMap<TOut>>
+
+

Private Optional Readonly fields

+
fields?: [keyof TIn, ...(keyof TIn)[]]
+
+

Private Readonly source

+
source: AsyncHandler<TIn, TOut>
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Protected findDestination

+
    + +
  • +

    Returns the WeakMap that contains actual objects that were cached, +so the last WeakMap in the chain of maps.

    +

    Returns undefined if no such map exists because earlier keys were not cached.

    +

    Will always return a map if ensure is set to true, +in such a case the intermediate maps will be created and added to the previous map.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      • +
    • +
      keys: object[]
      • +
    • +
      cache: WeakMap<object, NestedMap<TOut>>
      • +
    • +
      ensure: boolean = false
    +

    Returns undefined | WeakMap<object, TOut>

    +
+
+

Protected getKeys

+
    + +
  • +

    Extracts the values that will be used as keys from the input object. +In case the fields value was undefined, this will return an array containing the input object itself.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
    +

    Returns [object, ...object[]]

    +
+
+

handle

+
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<TOut>

    A promise resolving when handling is finished.

    + +
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<TOut>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CachedJwkGenerator.html b/7.x/docs/classes/CachedJwkGenerator.html new file mode 100644 index 000000000..4f0f90ec6 --- /dev/null +++ b/7.x/docs/classes/CachedJwkGenerator.html @@ -0,0 +1,184 @@ +CachedJwkGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CachedJwkGenerator

+
+

Generates a key pair once and then caches it using both an internal variable and a KeyValueStorage. +The storage makes sure the keys remain the same between server restarts, +while the internal variable makes it so the storage doesn't have to be accessed every time a key is needed.

+

Only the private key is stored in the internal storage, using the storageKey parameter. +The public key is determined based on the private key and then also stored in memory.

+
+
+
+

Hierarchy

+
    +
  • CachedJwkGenerator
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
alg +key +privateJwk? +publicJwk? +storage +
+
+

Methods

+
getPrivateKey +getPublicKey +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly alg

+
alg: AsymmetricSigningAlgorithm
+

The algorithm used for the keys.

+
+
+
+

Private Readonly key

+
key: string
+
+

Private Optional privateJwk

+
privateJwk?: AlgJwk
+
+

Private Optional publicJwk

+
publicJwk?: AlgJwk
+
+

Private Readonly storage

+
storage: KeyValueStorage<string, JWKS>
+
+

Methods

+
+

getPrivateKey

+
+
+

getPublicKey

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CachedResourceSet.html b/7.x/docs/classes/CachedResourceSet.html new file mode 100644 index 000000000..7ffe23fd7 --- /dev/null +++ b/7.x/docs/classes/CachedResourceSet.html @@ -0,0 +1,148 @@ +CachedResourceSet | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CachedResourceSet

+
+

Caches resource existence in a WeakMap tied to the ResourceIdentifier object.

+
+
+
+

Hierarchy

+
    +
  • CachedResourceSet
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
cache +source +
+
+

Methods

+
hasResource +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly cache

+
cache: WeakMap<ResourceIdentifier, boolean>
+
+

Private Readonly source

+
source: ResourceSet
+
+

Methods

+
+

hasResource

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CancelOidcHandler.html b/7.x/docs/classes/CancelOidcHandler.html new file mode 100644 index 000000000..6e33907f0 --- /dev/null +++ b/7.x/docs/classes/CancelOidcHandler.html @@ -0,0 +1,171 @@ +CancelOidcHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CancelOidcHandler

+
+

Cancel an active OIDC interaction.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ChainedConverter.html b/7.x/docs/classes/ChainedConverter.html new file mode 100644 index 000000000..130fb8010 --- /dev/null +++ b/7.x/docs/classes/ChainedConverter.html @@ -0,0 +1,419 @@ +ChainedConverter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ChainedConverter

+
+

A meta converter that takes an array of other converters as input. +It chains these converters by finding a path of converters +that can go from the given content-type to the given type preferences. +In case there are multiple paths, the one with the highest weight gets found. +Will error in case no path can be found.

+

This is not a TypedRepresentationConverter since the supported output types +might depend on what is the input content-type.

+

This converter should be the last in a WaterfallHandler if there are multiple, +since it will try to convert any representation with a content-type.

+

Some suggestions on how this class can be even more optimized should this ever be needed in the future. +Most of these decrease computation time at the cost of more memory.

+
    +
  • The algorithm could start on both ends of a possible path and work towards the middle.
    • +
  • When creating a path, store the list of unused converters instead of checking every step.
    • +
  • Caching: https://github.com/CommunitySolidServer/CommunitySolidServer/issues/832
    • +
  • Making sure each intermediate type is only used once.
    • +
  • The TypedRepresentationConverter interface could potentially be updated +so paths only differing in intermediate types can be combined.
    • +
+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
converters +logger +
+
+

Methods

+
canHandle +findBest +findConverterPreference +findPath +generatePath +handle +handleSafe +modifyTypeWeights +removeBadPaths +supportedConverters +takeStep +updatePathWeights +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly converters

+
converters: TypedRepresentationConverter[]
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Methods

+
+

canHandle

+
+
+

Private findBest

+
    + +
  • +

    Finds the path from the given list that can convert to the given preferences. +If there are multiple matches the one with the highest result weight gets chosen. +Will return undefined if there are no matches.

    +
    +
    +

    Parameters

    +
      +
    • +
      paths: ConversionPath[]
    +

    Returns undefined | ConversionPath

    +
+
+

Private findConverterPreference

+
    + +
  • +

    Returns a ConverterPreference if the given converter supports the given type. +All types that have already been used will be removed from the output types.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<undefined | ConverterPreference>

    +
+
+

Private findPath

+
+
+

Private generatePath

+
    + +
  • +

    Tries to generate the optimal ConversionPath that supports the given parameters, +which will then be used to instantiate a specific MatchedPath for those parameters.

    +

    Errors if such a path does not exist.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ConversionPath>

    +
+
+

handle

+
+
+

handleSafe

+
+
+

Private modifyTypeWeights

+
+
+

Private removeBadPaths

+
    + +
  • +

    Filter out paths that can no longer be better than the current best solution. +This depends on a valid path already being found, if not all the input paths will be returned.

    +
    +
    +

    Parameters

    +
      +
    • +
      paths: ConversionPath[]
      +

      Paths to filter.

      +
      +
      • +
    • +
      maxWeight: number
      +

      The maximum weight in the output preferences.

      +
      +
      • +
    • +
      Optional bestMatch: ConversionPath
      +

      The current best path.

      +
      +
    +

    Returns ConversionPath[]

    +
+
+

Private supportedConverters

+
+
+

Private takeStep

+
    + +
  • +

    Finds all converters that could take the output of the given path as input. +For each of these converters a new path gets created which is the input path appended by the converter.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<ConversionPath[]>

    +
+
+

Private updatePathWeights

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ChainedTemplateEngine.html b/7.x/docs/classes/ChainedTemplateEngine.html new file mode 100644 index 000000000..10ca5817d --- /dev/null +++ b/7.x/docs/classes/ChainedTemplateEngine.html @@ -0,0 +1,227 @@ +ChainedTemplateEngine | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ChainedTemplateEngine<T>

+
+

Calls the given array of TemplateEngines in the order they appear, +feeding the output of one into the input of the next.

+

The first engine will be called with the provided contents and template parameters. +All subsequent engines will be called with no template parameter. +Contents will still be passed along and another entry will be added for the body of the previous output.

+
+
+
+

Type Parameters

+
    +
  • +

    T extends Dict<unknown> = Dict<unknown>

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
chainedEngines +firstEngine +renderedName +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly chainedEngines

+
chainedEngines: TemplateEngine<Dict<unknown>>[]
+
+

Private Readonly firstEngine

+
firstEngine: TemplateEngine<T>
+
+

Private Readonly renderedName

+
renderedName: string
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CliExtractor.html b/7.x/docs/classes/CliExtractor.html new file mode 100644 index 000000000..d1f070edb --- /dev/null +++ b/7.x/docs/classes/CliExtractor.html @@ -0,0 +1,184 @@ +CliExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CliExtractorAbstract

+
+

Converts the input CLI arguments into an easily parseable key/value object.

+

Due to how the application is built, there are certain CLI parameters +that need to be parsed before this class can be instantiated. +These can be ignored by this class as they will have been handled before it is called, +but that does mean that this class should not error if they are present, +e.g., by being strict throwing an error on these unexpected parameters.

+

In case strict mode is preferred, the following should be added to the list of known parameters:

+
    +
  • -c / --config
    • +
  • -m / --mainModulePath
    • +
  • -l / --loggingLevel
    • +
+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: CliArgv
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: CliArgv
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<Shorthand>

    A promise resolving when handling is finished.

    + +
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: CliArgv
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<Shorthand>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CliResolver.html b/7.x/docs/classes/CliResolver.html new file mode 100644 index 000000000..3b79bab67 --- /dev/null +++ b/7.x/docs/classes/CliResolver.html @@ -0,0 +1,119 @@ +CliResolver | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CliResolver

+
+

A class that combines a CliExtractor and a ShorthandResolver. +Mainly exists so both such classes can be generated in a single Components.js instance.

+
+
+
+

Hierarchy

+
    +
  • CliResolver
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
cliExtractor +shorthandResolver +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly cliExtractor

+
cliExtractor: CliExtractor
+
+

Readonly shorthandResolver

+
shorthandResolver: ShorthandResolver
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ClientCredentialsAdapter.html b/7.x/docs/classes/ClientCredentialsAdapter.html new file mode 100644 index 000000000..b7a8fa712 --- /dev/null +++ b/7.x/docs/classes/ClientCredentialsAdapter.html @@ -0,0 +1,271 @@ +ClientCredentialsAdapter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ClientCredentialsAdapter

+
+

A PassthroughAdapter that overrides the find function +by checking if there are stored client credentials for the given ID +if no payload is found in the source.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
clientCredentialsStore +logger +name +source +webIdStore +
+
+

Methods

+
consume +destroy +find +findByUid +findByUserCode +revokeByGrantId +upsert +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly clientCredentialsStore

+
clientCredentialsStore: ClientCredentialsStore
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Protected Readonly name

+
name: string
+
+

Protected Readonly source

+
source: Adapter
+
+

Private Readonly webIdStore

+
webIdStore: WebIdStore
+
+

Methods

+
+

consume

+
+
+

destroy

+
+
+

find

+
+
+

findByUid

+
+
+

findByUserCode

+
+
+

revokeByGrantId

+
+
+

upsert

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ClientCredentialsAdapterFactory.html b/7.x/docs/classes/ClientCredentialsAdapterFactory.html new file mode 100644 index 000000000..dd1d18bfd --- /dev/null +++ b/7.x/docs/classes/ClientCredentialsAdapterFactory.html @@ -0,0 +1,155 @@ +ClientCredentialsAdapterFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ClientCredentialsAdapterFactory

+
+

A factory that generates an Adapter to be used by the IDP to persist information.

+

The oidc-provider library will call the relevant functions when it needs to find/create/delete metadata. +For a full explanation of how these functions work and what is expected, +have a look at https://github.com/panva/node-oidc-provider/blob/main/example/my_adapter.js

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
clientCredentialsStore +source +webIdStore +
+
+

Methods

+
createStorageAdapter +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly clientCredentialsStore

+
clientCredentialsStore: ClientCredentialsStore
+
+

Protected Readonly source

+
source: AdapterFactory
+
+

Private Readonly webIdStore

+
webIdStore: WebIdStore
+
+

Methods

+
+

createStorageAdapter

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ClientCredentialsDetailsHandler.html b/7.x/docs/classes/ClientCredentialsDetailsHandler.html new file mode 100644 index 000000000..a014675c1 --- /dev/null +++ b/7.x/docs/classes/ClientCredentialsDetailsHandler.html @@ -0,0 +1,206 @@ +ClientCredentialsDetailsHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ClientCredentialsDetailsHandler

+
+

Provides a view on a client credentials token, indicating the token identifier and its associated WebID.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
clientCredentialsRoute +clientCredentialsStore +logger +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly clientCredentialsRoute

+
clientCredentialsRoute: ClientCredentialsIdRoute
+
+

Private Readonly clientCredentialsStore

+
clientCredentialsStore: ClientCredentialsStore
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ClientIdAdapter.html b/7.x/docs/classes/ClientIdAdapter.html new file mode 100644 index 000000000..402cfe962 --- /dev/null +++ b/7.x/docs/classes/ClientIdAdapter.html @@ -0,0 +1,295 @@ +ClientIdAdapter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ClientIdAdapter

+
+

This Adapter redirects the find call to its source adapter. +In case no client data was found in the source for the given Client ID, +this class will do an HTTP GET request to that Client ID. +If the result is a valid Client ID document, that will be returned instead.

+

See https://solidproject.org/TR/2022/oidc-20220328#clientids-document.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
converter +logger +name +source +
+
+

Methods

+
consume +destroy +find +findByUid +findByUserCode +parseRdfClientId +revokeByGrantId +upsert +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly converter

+
converter: RepresentationConverter
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Protected Readonly name

+
name: string
+
+

Protected Readonly source

+
source: Adapter
+
+

Methods

+
+

consume

+
+
+

destroy

+
+
+

find

+
+
+

findByUid

+
+
+

findByUserCode

+
+
+

Private parseRdfClientId

+
    + +
  • +

    Parses RDF data found at a Client ID.

    +
    +
    +

    Parameters

    +
      +
    • +
      data: string
      +

      Raw data from the Client ID.

      +
      +
      • +
    • +
      id: string
      +

      The actual Client ID.

      +
      +
      • +
    • +
      response: Response
      +

      Response object from the request.

      +
      +
    +

    Returns Promise<AdapterPayload>

    +
+
+

revokeByGrantId

+
+
+

upsert

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ClientIdAdapterFactory.html b/7.x/docs/classes/ClientIdAdapterFactory.html new file mode 100644 index 000000000..94c10dee2 --- /dev/null +++ b/7.x/docs/classes/ClientIdAdapterFactory.html @@ -0,0 +1,146 @@ +ClientIdAdapterFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ClientIdAdapterFactory

+
+

A factory that generates an Adapter to be used by the IDP to persist information.

+

The oidc-provider library will call the relevant functions when it needs to find/create/delete metadata. +For a full explanation of how these functions work and what is expected, +have a look at https://github.com/panva/node-oidc-provider/blob/main/example/my_adapter.js

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
converter +source +
+
+

Methods

+
createStorageAdapter +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly converter

+
converter: RepresentationConverter
+
+

Protected Readonly source

+
source: AdapterFactory
+
+

Methods

+
+

createStorageAdapter

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ClientInfoHandler.html b/7.x/docs/classes/ClientInfoHandler.html new file mode 100644 index 000000000..fdf5284bf --- /dev/null +++ b/7.x/docs/classes/ClientInfoHandler.html @@ -0,0 +1,190 @@ +ClientInfoHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ClientInfoHandler

+
+

Returns a JSON representation with metadata of the client that is requesting the OIDC interaction.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
providerFactory +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly providerFactory

+
providerFactory: ProviderFactory
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ClusterManager.html b/7.x/docs/classes/ClusterManager.html new file mode 100644 index 000000000..b306090d9 --- /dev/null +++ b/7.x/docs/classes/ClusterManager.html @@ -0,0 +1,213 @@ +ClusterManager | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ClusterManager

+
+

This class is responsible for deciding how many affective workers are needed. +It also contains the logic for respawning workers when they are killed by the os.

+

The workers values are interpreted as follows:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
valueactual workers
-mnum_cores - m workers (autoscale) (m < num_cores)
-1num_cores - 1 workers (autoscale)
0num_cores workers (autoscale)
1single threaded mode (default)
nn workers
+
+
+
+

Hierarchy

+
    +
  • ClusterManager
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
clusterMode +logger +workers +
+
+

Methods

+
isPrimary +isSingleThreaded +isWorker +spawnWorkers +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly clusterMode

+
clusterMode: ClusterMode
+
+

Private Readonly logger

+
logger: Logger = ...
+
+

Private Readonly workers

+
workers: number
+
+

Methods

+
+

isPrimary

+
+
+

isSingleThreaded

+
    + +
  • +

    Check whether the CSS server was booted in single threaded mode.

    +
    +

    Returns boolean

    True is single threaded.

    + +
+
+

isWorker

+
+
+

spawnWorkers

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CombinedShorthandResolver.html b/7.x/docs/classes/CombinedShorthandResolver.html new file mode 100644 index 000000000..8f584eb1f --- /dev/null +++ b/7.x/docs/classes/CombinedShorthandResolver.html @@ -0,0 +1,190 @@ +CombinedShorthandResolver | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CombinedShorthandResolver

+
+

Generates variable values by running a set of ShorthandExtractors on the input.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
resolvers +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly resolvers

+
resolvers: Record<string, ShorthandExtractor>
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Shorthand
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Record<string, unknown>
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<Record<string, unknown>>

    A promise resolving when handling is finished.

    + +
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Shorthand
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<VariableBindings>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ComposedAuxiliaryStrategy.html b/7.x/docs/classes/ComposedAuxiliaryStrategy.html new file mode 100644 index 000000000..2ebd34cbb --- /dev/null +++ b/7.x/docs/classes/ComposedAuxiliaryStrategy.html @@ -0,0 +1,336 @@ +ComposedAuxiliaryStrategy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ComposedAuxiliaryStrategy

+
+

An AuxiliaryStrategy that provides its functionality through the combination of +an AuxiliaryIdentifierStrategy, MetadataGenerator and Validator.

+
+
+
+

Hierarchy

+
    +
  • ComposedAuxiliaryStrategy
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
identifierStrategy +metadataGenerator? +ownAuthorization +requiredInRoot +validator? +
+
+

Methods

+
addMetadata +getAuxiliaryIdentifier +getAuxiliaryIdentifiers +getSubjectIdentifier +isAuxiliaryIdentifier +isRequiredInRoot +usesOwnAuthorization +validate +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly identifierStrategy

+
identifierStrategy: AuxiliaryIdentifierStrategy
+
+

Private Optional Readonly metadataGenerator

+
metadataGenerator?: MetadataGenerator
+
+

Private Readonly ownAuthorization

+
ownAuthorization: boolean
+
+

Private Readonly requiredInRoot

+
requiredInRoot: boolean
+
+

Private Optional Readonly validator

+
validator?: Validator
+
+

Methods

+
+

addMetadata

+
    + +
  • +

    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 subject 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 subject identifier.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    +
+
+

getAuxiliaryIdentifier

+
+
+

getAuxiliaryIdentifiers

+
+
+

getSubjectIdentifier

+
+
+

isAuxiliaryIdentifier

+
    + +
  • +

    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

    +
    +

    Returns boolean

    true if the input identifier points to an auxiliary resource.

    + +
+
+

isRequiredInRoot

+
+
+

usesOwnAuthorization

+
+
+

validate

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ComposedNotificationHandler.html b/7.x/docs/classes/ComposedNotificationHandler.html new file mode 100644 index 000000000..5119520a1 --- /dev/null +++ b/7.x/docs/classes/ComposedNotificationHandler.html @@ -0,0 +1,213 @@ +ComposedNotificationHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ComposedNotificationHandler

+
+

Generates, serializes and emits a Notification using a NotificationGenerator, +NotificationSerializer and NotificationEmitter.

+

Will not emit an event when it has the same state as the notification channel.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
eTagHandler +emitter +generator +serializer +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly eTagHandler

+
eTagHandler: ETagHandler
+
+

Private Readonly emitter

+
emitter: NotificationEmitter
+
+

Private Readonly generator

+
generator: NotificationGenerator
+
+

Private Readonly serializer

+
serializer: NotificationSerializer
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ConditionalHandler.html b/7.x/docs/classes/ConditionalHandler.html new file mode 100644 index 000000000..71f5624dc --- /dev/null +++ b/7.x/docs/classes/ConditionalHandler.html @@ -0,0 +1,266 @@ +ConditionalHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ConditionalHandler<TIn, TOut>

+
+

This handler will pass all requests to the wrapped handler, +until a specific value has been set in the given storage. +After that all input will be rejected. +Once the value has been matched this behaviour will be cached, +so changing the value again afterwards will not enable this handler again.

+

If handleStorage is set to true, +this handler will set the value itself in the given storage after the source handler successfully resolved.

+
+
+
+

Type Parameters

+
    +
  • +

    TIn

    • +
  • +

    TOut

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
finished +handleStorage +source +storage +storageKey +storageValue +
+
+

Methods

+
canHandle +checkCondition +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private finished

+
finished: boolean
+
+

Private Readonly handleStorage

+
handleStorage: boolean
+
+

Private Readonly source

+
source: AsyncHandler<TIn, TOut>
+
+

Private Readonly storage

+
storage: KeyValueStorage<string, unknown>
+
+

Private Readonly storageKey

+
storageKey: string
+
+

Private Readonly storageValue

+
storageValue: unknown
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Private checkCondition

+
+
+

handle

+
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<TOut>

    A promise resolving when handling is finished.

    + +
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<TOut>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ConditionsParser.html b/7.x/docs/classes/ConditionsParser.html new file mode 100644 index 000000000..111e3e9a6 --- /dev/null +++ b/7.x/docs/classes/ConditionsParser.html @@ -0,0 +1,173 @@ +ConditionsParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ConditionsParserAbstract

+
+

Creates a Conditions object based on the input HttpRequest.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: HttpRequest
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ConfigPodInitializer.html b/7.x/docs/classes/ConfigPodInitializer.html new file mode 100644 index 000000000..4c7fb25b1 --- /dev/null +++ b/7.x/docs/classes/ConfigPodInitializer.html @@ -0,0 +1,215 @@ +ConfigPodInitializer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ConfigPodInitializer

+
+

Initializes all pods that have been stored and loads them in memory. +This reads the pod settings from a permanent storage and uses those +to create the corresponding ResourceStores in memory, +so this is required every time the server starts.

+

Part of the dynamic pod creation. +Reads the contents from the configuration storage, uses those values to instantiate ResourceStores, +and then adds them to the routing storage.

+
+
+

See

ConfigPodManager, TemplatedPodGenerator, BaseUrlRouterRule

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
configStorage +logger +routingStorage +storeFactory +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly configStorage

+
configStorage: KeyValueStorage<string, unknown>
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly routingStorage

+
routingStorage: KeyValueStorage<string, ResourceStore>
+
+

Private Readonly storeFactory

+
storeFactory: ComponentsJsFactory
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      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.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ConfigPodManager.html b/7.x/docs/classes/ConfigPodManager.html new file mode 100644 index 000000000..2ed159fc0 --- /dev/null +++ b/7.x/docs/classes/ConfigPodManager.html @@ -0,0 +1,196 @@ +ConfigPodManager | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ConfigPodManager

+
+

Pod manager that creates a store for the pod with a PodGenerator +and fills it with resources from a ResourcesGenerator.

+

Part of the dynamic pod creation.

+
    +
  1. Calls a PodGenerator to instantiate a new resource store for the pod.
    2. +
  2. Generates the pod resources based on the templates as usual.
    3. +
  3. Adds the created pod to the routing storage, which is used for linking pod identifiers to their resource stores.
    4. +
+
+
+

See

TemplatedPodGenerator, ConfigPodInitializer, BaseUrlRouterRule

+
+
+

Hierarchy

+
    +
  • ConfigPodManager
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +podGenerator +resourcesGenerator +routingStorage +store +
+
+

Methods

+
createPod +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly podGenerator

+
podGenerator: PodGenerator
+
+

Private Readonly resourcesGenerator

+
resourcesGenerator: ResourcesGenerator
+
+

Private Readonly routingStorage

+
routingStorage: KeyValueStorage<string, ResourceStore>
+
+

Private Readonly store

+
store: ResourceStore
+
+

Methods

+
+

createPod

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ConflictHttpError.html b/7.x/docs/classes/ConflictHttpError.html new file mode 100644 index 000000000..fc4576c4b --- /dev/null +++ b/7.x/docs/classes/ConflictHttpError.html @@ -0,0 +1,228 @@ +ConflictHttpError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ConflictHttpError

+
+

An error thrown when a request conflict with current state of the server.

+
+
+
+

Hierarchy

+
    +
  • BaseHttpError +
      +
    • ConflictHttpError
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
cause? +errorCode +message +metadata +name +stack? +statusCode +isInstance +statusCode +uri +
+
+

Methods

+
generateMetadata +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Optional Readonly cause

+
cause?: unknown
+
+

Readonly errorCode

+
errorCode: string
+
+

message

+
message: string
+
+

Readonly metadata

+
metadata: RepresentationMetadata
+
+

name

+
name: string
+
+

Optional stack

+
stack?: string
+
+

Readonly statusCode

+
statusCode: 409
+
+

Static Readonly isInstance

+
isInstance: ((error) => error is HttpError<409>)
+
+

Type declaration

+
    +
  • +
      +
    • (error): error is HttpError<409>
      • +
    • +

      Checks whether the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: unknown
      +

      Returns error is HttpError<409>

      +
+
+

Static Readonly statusCode

+
statusCode: 409
+

The status code corresponding to this error class.

+
+
+
+

Static Readonly uri

+
uri: NamedNode<string>
+

A unique URI identifying this error class.

+
+
+
+

Methods

+
+

Protected generateMetadata

+
    + +
  • +

    Initializes the error metadata.

    +
    +

    Returns void

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ConsentHandler.html b/7.x/docs/classes/ConsentHandler.html new file mode 100644 index 000000000..73e241e4d --- /dev/null +++ b/7.x/docs/classes/ConsentHandler.html @@ -0,0 +1,251 @@ +ConsentHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ConsentHandler

+
+

Handles the OIDC consent prompts where the user confirms they want to log in for the given client.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
providerFactory +
+
+

Methods

+
canHandle +getGrant +handle +handleSafe +updateGrant +updateInteraction +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly providerFactory

+
providerFactory: ProviderFactory
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Private getGrant

+
    + +
  • +

    Either returns the grant associated with the given interaction or creates a new one if it does not exist yet.

    +
    +
    +

    Parameters

    +
      +
    • +
      oidcInteraction: Interaction
    +

    Returns Promise<Grant>

    +
+
+

handle

+
+
+

handleSafe

+
+
+

Private updateGrant

+
    + +
  • +

    Updates the grant with all the missing scopes and claims requested by the interaction.

    +

    Will reject the offline_access scope if remember is false.

    +
    +
    +

    Parameters

    +
      +
    • +
      grant: Grant
      • +
    • +
      details: UnknownObject
      • +
    • +
      remember: boolean
    +

    Returns void

    +
+
+

Private updateInteraction

+
    + +
  • +

    Updates the interaction with the new grant and returns the resulting redirect URL.

    +
    +
    +

    Parameters

    +
      +
    • +
      oidcInteraction: Interaction
      • +
    • +
      grant: Grant
    +

    Returns Promise<string>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ConstantConverter.html b/7.x/docs/classes/ConstantConverter.html new file mode 100644 index 000000000..ac8097760 --- /dev/null +++ b/7.x/docs/classes/ConstantConverter.html @@ -0,0 +1,233 @@ +ConstantConverter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ConstantConverter

+
+

A RepresentationConverter that ensures +a representation for a certain content type is available.

+

Representations of the same content type are served as is; +others are replaced by a constant document.

+

This can for example be used to serve an index.html file, +which could then interactively load another representation.

+

Options default to the most permissive values when not defined.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
contentType +filePath +logger +options +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly contentType

+
contentType: string
+
+

Private Readonly filePath

+
filePath: string
+
+

Private Readonly logger

+
logger: Logger = ...
+
+

Private Readonly options

+
options: Required<ConstantConverterOptions>
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ConstantMetadataWriter.html b/7.x/docs/classes/ConstantMetadataWriter.html new file mode 100644 index 000000000..12e3acb02 --- /dev/null +++ b/7.x/docs/classes/ConstantMetadataWriter.html @@ -0,0 +1,193 @@ +ConstantMetadataWriter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ConstantMetadataWriter

+
+

A MetadataWriter that takes a constant map of header names and values.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
headers +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly headers

+
headers: [string, string][]
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ContainerInitializer.html b/7.x/docs/classes/ContainerInitializer.html new file mode 100644 index 000000000..5a7ab703a --- /dev/null +++ b/7.x/docs/classes/ContainerInitializer.html @@ -0,0 +1,218 @@ +ContainerInitializer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ContainerInitializer

+
+

Initializer that sets up a container. +Will copy all the files and folders in the given path to the corresponding documents and containers.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
containerId +generator +logger +storage +storageKey +store +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly containerId

+
containerId: ResourceIdentifier
+
+

Private Readonly generator

+
generator: ResourcesGenerator
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly storage

+
storage: KeyValueStorage<string, boolean>
+
+

Private Readonly storageKey

+
storageKey: string
+
+

Private Readonly store

+
store: ResourceStore
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      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.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ContainerPathStorage.html b/7.x/docs/classes/ContainerPathStorage.html new file mode 100644 index 000000000..a16b2589b --- /dev/null +++ b/7.x/docs/classes/ContainerPathStorage.html @@ -0,0 +1,288 @@ +ContainerPathStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ContainerPathStorage<T>

+
+

A KeyValueStorage that prepends a relative path to the key. +Leading slashes of the relative path are trimmed, and a trailing slash is added if needed.

+
+
+
+

Type Parameters

+
    +
  • +

    T

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
basePath +source +
+
+

Methods

+
delete +entries +get +has +set +toNewKey +toOriginalKey +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly basePath

+
basePath: string
+
+

Protected Readonly source

+
source: KeyValueStorage<string, T>
+
+

Methods

+
+

delete

+
+
+

entries

+
+
+

get

+
+
+

has

+
+
+

set

+
+
+

Protected toNewKey

+
+
+

Protected toOriginalKey

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ContainerToTemplateConverter.html b/7.x/docs/classes/ContainerToTemplateConverter.html new file mode 100644 index 000000000..31855e786 --- /dev/null +++ b/7.x/docs/classes/ContainerToTemplateConverter.html @@ -0,0 +1,301 @@ +ContainerToTemplateConverter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ContainerToTemplateConverter

+
+

A RepresentationConverter that creates a templated representation of a container.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
contentType +identifierStrategy +inputTypes +outputTypes +templateEngine +
+
+

Methods

+
canHandle +getChildResources +getLocalName +getOutputTypes +getParentContainers +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly contentType

+
contentType: string
+
+

Private Readonly identifierStrategy

+
identifierStrategy: IdentifierStrategy
+
+

Protected inputTypes

+
inputTypes: Promise<ValuePreferences>
+
+

Protected outputTypes

+
outputTypes: Promise<ValuePreferences>
+
+

Private Readonly templateEngine

+
templateEngine: TemplateEngine<Dict<unknown>>
+
+

Methods

+
+

canHandle

+
+
+

Private getChildResources

+
+
+

Private getLocalName

+
+
+

getOutputTypes

+
+
+

Private getParentContainers

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ContentLengthParser.html b/7.x/docs/classes/ContentLengthParser.html new file mode 100644 index 000000000..1ee58f766 --- /dev/null +++ b/7.x/docs/classes/ContentLengthParser.html @@ -0,0 +1,198 @@ +ContentLengthParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ContentLengthParser

+
+

Parser for the content-length header.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ContentTypeMetadataWriter.html b/7.x/docs/classes/ContentTypeMetadataWriter.html new file mode 100644 index 000000000..2d99ba6dd --- /dev/null +++ b/7.x/docs/classes/ContentTypeMetadataWriter.html @@ -0,0 +1,176 @@ +ContentTypeMetadataWriter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ContentTypeMetadataWriter

+
+

Adds the Content-Type header containing value and parameters (if available).

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ContentTypeParser.html b/7.x/docs/classes/ContentTypeParser.html new file mode 100644 index 000000000..1823fd90b --- /dev/null +++ b/7.x/docs/classes/ContentTypeParser.html @@ -0,0 +1,186 @@ +ContentTypeParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ContentTypeParser

+
+

Parser for the content-type header.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ContentTypeReplacer.html b/7.x/docs/classes/ContentTypeReplacer.html new file mode 100644 index 000000000..2ff6a898b --- /dev/null +++ b/7.x/docs/classes/ContentTypeReplacer.html @@ -0,0 +1,243 @@ +ContentTypeReplacer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ContentTypeReplacer

+
+

A RepresentationConverter that changes the content type +but does not alter the representation.

+

Useful for when a content type is binary-compatible with another one; +for instance, all JSON-LD files are valid JSON files.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
contentTypeMap +
+
+

Methods

+
canHandle +getOutputTypes +getReplacementType +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly contentTypeMap

+
contentTypeMap: Record<string, ValuePreferences> = {}
+
+

Methods

+
+

canHandle

+
+
+

getOutputTypes

+
+
+

Private getReplacementType

+
    + +
  • +

    Find a replacement content type that matches the preferences, +or throws an error if none was found.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<string>

    +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ContextDocumentLoader.html b/7.x/docs/classes/ContextDocumentLoader.html new file mode 100644 index 000000000..93470afc6 --- /dev/null +++ b/7.x/docs/classes/ContextDocumentLoader.html @@ -0,0 +1,140 @@ +ContextDocumentLoader | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ContextDocumentLoader

+
+

First, checks whether a context is stored locally before letting the super class do a fetch. +This can be used when converting JSON-LD with Comunica-related libraries, such as rdf-parse.

+

To use this, add this document loader to the options of the call +using the KeysRdfParseJsonLd.documentLoader.name key. +All extra keys get passed in the Comunica ActionContext +and this is the key that is used to define the document loader. +See https://github.com/rubensworks/rdf-parse.js/blob/master/lib/RdfParser.ts +and https://github.com/comunica/comunica/blob/master/packages/actor-rdf-parse-jsonld/lib/ActorRdfParseJsonLd.ts

+
+
+
+

Hierarchy

+
    +
  • FetchDocumentLoader +
      +
    • ContextDocumentLoader
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
contexts +
+
+

Methods

+
load +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly contexts

+
contexts: Record<string, IJsonLdContext>
+
+

Methods

+
+

load

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ControlHandler.html b/7.x/docs/classes/ControlHandler.html new file mode 100644 index 000000000..6a2f6e767 --- /dev/null +++ b/7.x/docs/classes/ControlHandler.html @@ -0,0 +1,277 @@ +ControlHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ControlHandler

+
+

Creates an object with the keys matching those of the input controls, +and the values being the results received by the matching values in the same input.

+

If source is defined, the controls will be added to the output of that handler after passing the input. +In case the control keys conflict with a key already present in the resulting object, +the results will be merged.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
controls +source? +
+
+

Methods

+
canHandle +generateControlSet +generateControls +handle +handleSafe +isRoute +mergeControls +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly controls

+
controls: Record<string, InteractionRoute<never> | JsonInteractionHandler<Dict<Json>>>
+
+

Private Optional Readonly source

+
source?: JsonInteractionHandler<Dict<Json>>
+
+

Methods

+
+

canHandle

+
+
+

Protected generateControlSet

+
+
+

Protected generateControls

+
+
+

handle

+
+
+

handleSafe

+
+
+

Protected isRoute

+
+
+

Protected mergeControls

+
    + +
  • +

    Merge the two objects. +Generally this will probably not be necessary, or be very simple merges, +but this ensures that we handle all possibilities.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional original: Json
      • +
    • +
      Optional controls: Json
    +

    Returns Json

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ConvertingErrorHandler.html b/7.x/docs/classes/ConvertingErrorHandler.html new file mode 100644 index 000000000..927b88e2b --- /dev/null +++ b/7.x/docs/classes/ConvertingErrorHandler.html @@ -0,0 +1,247 @@ +ConvertingErrorHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ConvertingErrorHandler

+
+

Converts an error into a Representation of content type internal/error. +Then feeds that representation into its converter to create a representation based on the given preferences.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
converter +preferenceParser +showStackTrace +
+
+

Methods

+
canHandle +createResponse +extractErrorDetails +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly converter

+
converter: RepresentationConverter
+
+

Private Readonly preferenceParser

+
preferenceParser: PreferenceParser
+
+

Private Readonly showStackTrace

+
showStackTrace: boolean
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Private createResponse

+
+
+

Private extractErrorDetails

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ConvertingNotificationSerializer.html b/7.x/docs/classes/ConvertingNotificationSerializer.html new file mode 100644 index 000000000..d7afa79fc --- /dev/null +++ b/7.x/docs/classes/ConvertingNotificationSerializer.html @@ -0,0 +1,200 @@ +ConvertingNotificationSerializer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ConvertingNotificationSerializer

+
+

Converts a serialization based on the provided accept feature value. +In case none was provided no conversion takes place.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
converter +source +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly converter

+
converter: RepresentationConverter
+
+

Private Readonly source

+
source: NotificationSerializer
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ConvertingOperationHttpHandler.html b/7.x/docs/classes/ConvertingOperationHttpHandler.html new file mode 100644 index 000000000..5635b8421 --- /dev/null +++ b/7.x/docs/classes/ConvertingOperationHttpHandler.html @@ -0,0 +1,200 @@ +ConvertingOperationHttpHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ConvertingOperationHttpHandler

+
+

An OperationHttpHandler that converts the response of its handler based on the Operation preferences. +If there are no preferences, or no data, the response will be returned as-is.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
converter +operationHandler +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly converter

+
converter: RepresentationConverter
+
+

Private Readonly operationHandler

+
operationHandler: OperationHttpHandler
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ConvertingPatcher.html b/7.x/docs/classes/ConvertingPatcher.html new file mode 100644 index 000000000..3b895f26d --- /dev/null +++ b/7.x/docs/classes/ConvertingPatcher.html @@ -0,0 +1,242 @@ +ConvertingPatcher | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ConvertingPatcher

+
+

A ConvertingPatcher converts a document to its intermediateType, +sends the result to the wrapped patcher, and then converts back to its original type. +No changes will take place if no intermediateType is provided.

+

In case there is no resource yet and a new one needs to be created, +the result of the wrapped patcher will be converted to the provided defaultType. +In case no defaultType is provided, the patcher output will be returned directly.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
converter +defaultType? +intermediateType? +logger +patcher +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly converter

+
converter: RepresentationConverter
+
+

Private Optional Readonly defaultType

+
defaultType?: string
+
+

Private Optional Readonly intermediateType

+
intermediateType?: string
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly patcher

+
patcher: RepresentationPatcher<Representation>
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ConvertingRouterRule.html b/7.x/docs/classes/ConvertingRouterRule.html new file mode 100644 index 000000000..7b95889c7 --- /dev/null +++ b/7.x/docs/classes/ConvertingRouterRule.html @@ -0,0 +1,251 @@ +ConvertingRouterRule | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ConvertingRouterRule

+
+

Rule that directs requests based on how the data would need to be converted. +In case the given converter can convert the data to the requested type, +it will be directed to the convertStore. +Otherwise the defaultStore will be chosen.

+

In case there is no data and only an identifier the defaultStore will be checked +if it contains the given identifier. +If not, the convertStore will be returned.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
defaultStore +typedStores +
+
+

Methods

+
canHandle +findStore +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly defaultStore

+
defaultStore: ResourceStore
+
+

Private Readonly typedStores

+
typedStores: ConvertingStoreEntry[]
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Private findStore

+
    + +
  • +

    Helper function that runs the given callback function for all the stores +and returns the first one that does not throw an error.

    +

    Returns the default store if no match was found.

    +
    +
    +

    Parameters

    +
      +
    • +
      supports: ((entry) => Promise<boolean>)
      +
        +
      • +
          +
        • (entry): Promise<boolean>
          • +
        • +
          +

          Parameters

          +
          +

          Returns Promise<boolean>

    +

    Returns Promise<ResourceStore>

    +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CookieInteractionHandler.html b/7.x/docs/classes/CookieInteractionHandler.html new file mode 100644 index 000000000..e5a515a4f --- /dev/null +++ b/7.x/docs/classes/CookieInteractionHandler.html @@ -0,0 +1,212 @@ +CookieInteractionHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CookieInteractionHandler

+
+

Handles all the necessary steps for having cookies. +Refreshes the cookie expiration if there was a successful account interaction. +Adds the cookie and cookie expiration data to the output metadata, +unless it is already present in that metadata. +Checks the account settings to see if the cookie needs to be remembered.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
accountStore +cookieStore +source +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly accountStore

+
accountStore: AccountStore
+
+

Private Readonly cookieStore

+
cookieStore: CookieStore
+
+

Private Readonly source

+
source: JsonInteractionHandler<Dict<Json>>
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CookieMetadataWriter.html b/7.x/docs/classes/CookieMetadataWriter.html new file mode 100644 index 000000000..de748c01d --- /dev/null +++ b/7.x/docs/classes/CookieMetadataWriter.html @@ -0,0 +1,208 @@ +CookieMetadataWriter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CookieMetadataWriter

+
+

Generates the necessary Set-Cookie header if a cookie value is detected in the metadata. +The keys of the input cookieMap should be the URIs of the predicates +used in the metadata when the object is a cookie value. +The value of the map are objects that contain the name of the cookie, +and the URI that is used to store the expiration date in the metadata, if any. +If no expiration date is found in the metadata, none will be set for the cookie, +causing it to be a session cookie.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
cookieMap +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly cookieMap

+
cookieMap: Map<NamedNode<string>, {
    expirationUri?: NamedNode<string>;
    name: string;
}>
+
+

Type declaration

+
    +
  • +
    Optional expirationUri?: NamedNode<string>
    • +
  • +
    name: string
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CookieParser.html b/7.x/docs/classes/CookieParser.html new file mode 100644 index 000000000..bbee043d0 --- /dev/null +++ b/7.x/docs/classes/CookieParser.html @@ -0,0 +1,208 @@ +CookieParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CookieParser

+
+

Parses the cookie header and stores their values as metadata. +The keys of the input cookieMap should be the cookie names, +and the values the corresponding predicate that should be used to store the value in the metadata. +The values of the cookies will be used as objects in the generated triples

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
cookieMap +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly cookieMap

+
cookieMap: Record<string, NamedNode<string>>
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CorsHandler.html b/7.x/docs/classes/CorsHandler.html new file mode 100644 index 000000000..6d384bffb --- /dev/null +++ b/7.x/docs/classes/CorsHandler.html @@ -0,0 +1,250 @@ +CorsHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CorsHandler

+
+

Handler that sets CORS options on the response. +In case of an OPTIONS request this handler will close the connection after adding its headers +if preflightContinue is set to false.

+

Solid, §8.1: "A server MUST implement the CORS protocol [FETCH] such that, to the extent possible, +the browser allows Solid apps to send any request and combination of request headers to the server, +and the Solid app can read any response and response headers received from the server." +Full details: https://solidproject.org/TR/2021/protocol-20211217#cors-server

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
corsHandler +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly corsHandler

+
corsHandler: ((req, res, next) => void)
+
+

Type declaration

+
    +
  • +
      +
    • (req, res, next): void
      • +
    • +
      +

      Parameters

      +
        +
      • +
        req: CorsRequest
        • +
      • +
        res: {
            end: (() => unknown);
            setHeader: ((key, value) => unknown);
            statusCode?: number;
        }
        +
          +
        • +
          end: (() => unknown)
          +
            +
          • +
              +
            • (): unknown
              • +
            • +

              Returns unknown

          • +
        • +
          setHeader: ((key, value) => unknown)
          +
            +
          • +
              +
            • (key, value): unknown
              • +
            • +
              +

              Parameters

              +
                +
              • +
                key: string
                • +
              • +
                value: string
              +

              Returns unknown

          • +
        • +
          Optional statusCode?: number
        • +
      • +
        next: ((err?) => unknown)
        +
          +
        • +
            +
          • (err?): unknown
            • +
          • +
            +

            Parameters

            +
              +
            • +
              Optional err: unknown
            +

            Returns unknown

      +

      Returns void

+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CreateAccountHandler.html b/7.x/docs/classes/CreateAccountHandler.html new file mode 100644 index 000000000..dc6cd6a5a --- /dev/null +++ b/7.x/docs/classes/CreateAccountHandler.html @@ -0,0 +1,265 @@ +CreateAccountHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CreateAccountHandler

+
+

Creates new accounts using an AccountStore;

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
accountStore +cookieStore +logger +
+
+

Methods

+
canHandle +getView +handle +handleSafe +login +updateRememberSetting +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly accountStore

+
accountStore: AccountStore
+
+

Protected Readonly cookieStore

+
cookieStore: CookieStore
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

getView

+
+
+

handle

+
+
+

handleSafe

+
+
+

login

+
+
+

Protected updateRememberSetting

+
    + +
  • +

    Updates the account setting that determines whether the login status needs to be remembered.

    +
    +
    +

    Parameters

    +
      +
    • +
      accountId: string
      +

      ID of the account.

      +
      +
      • +
    • +
      Optional remember: boolean
      +

      If the account should be remembered or not. The setting will not be updated if this is undefined.

      +
      +
    +

    Returns Promise<void>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CreateClientCredentialsHandler.html b/7.x/docs/classes/CreateClientCredentialsHandler.html new file mode 100644 index 000000000..1012980fe --- /dev/null +++ b/7.x/docs/classes/CreateClientCredentialsHandler.html @@ -0,0 +1,235 @@ +CreateClientCredentialsHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CreateClientCredentialsHandler

+
+

Handles the creation of client credential tokens.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
clientCredentialsRoute +clientCredentialsStore +logger +webIdStore +
+
+

Methods

+
canHandle +getView +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly clientCredentialsRoute

+
clientCredentialsRoute: ClientCredentialsIdRoute
+
+

Private Readonly clientCredentialsStore

+
clientCredentialsStore: ClientCredentialsStore
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly webIdStore

+
webIdStore: WebIdStore
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

getView

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CreateModesExtractor.html b/7.x/docs/classes/CreateModesExtractor.html new file mode 100644 index 000000000..7d4595934 --- /dev/null +++ b/7.x/docs/classes/CreateModesExtractor.html @@ -0,0 +1,199 @@ +CreateModesExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CreateModesExtractor

+
+

Adds the create access mode to the result of the source in case the target resource does not exist.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
resourceSet +source +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly resourceSet

+
resourceSet: ResourceSet
+
+

Private Readonly source

+
source: ModesExtractor
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      operation: Operation
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CreatePasswordHandler.html b/7.x/docs/classes/CreatePasswordHandler.html new file mode 100644 index 000000000..6147f96a0 --- /dev/null +++ b/7.x/docs/classes/CreatePasswordHandler.html @@ -0,0 +1,226 @@ +CreatePasswordHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CreatePasswordHandler

+
+

Handles the creation of email/password login combinations for an account.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +passwordRoute +passwordStore +
+
+

Methods

+
canHandle +getView +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly passwordRoute

+
passwordRoute: PasswordIdRoute
+
+

Private Readonly passwordStore

+
passwordStore: PasswordStore
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

getView

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CreatePodHandler.html b/7.x/docs/classes/CreatePodHandler.html new file mode 100644 index 000000000..2034acdc0 --- /dev/null +++ b/7.x/docs/classes/CreatePodHandler.html @@ -0,0 +1,268 @@ +CreatePodHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CreatePodHandler

+
+

Handles the creation of pods. +Will call the stored PodCreator with the settings found in the input JSON.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
inSchema +logger +podCreator +podIdRoute +podStore +webIdLinkRoute +
+
+

Methods

+
canHandle +getView +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly inSchema

+
inSchema: ObjectSchema<{
    name: undefined | string;
    settings: undefined | ({ webId?: string | undefined; });
}, AnyObject, {
    name: undefined;
    settings: { webId: undefined; };
}, "">
+
+

Type declaration

+
    +
  • +
    name: undefined | string
    • +
  • +
    settings: undefined | ({ webId?: string | undefined; })
+
+

Type declaration

+
    +
  • +
    name: undefined
    • +
  • +
    settings: { webId: undefined; }
+
+

Private Readonly logger

+
logger: Logger = ...
+
+

Private Readonly podCreator

+
podCreator: PodCreator
+
+

Private Readonly podIdRoute

+
podIdRoute: PodIdRoute
+
+

Private Readonly podStore

+
podStore: PodStore
+
+

Private Readonly webIdLinkRoute

+
webIdLinkRoute: WebIdLinkRoute
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

getView

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CreatedResponseDescription.html b/7.x/docs/classes/CreatedResponseDescription.html new file mode 100644 index 000000000..be22b6640 --- /dev/null +++ b/7.x/docs/classes/CreatedResponseDescription.html @@ -0,0 +1,129 @@ +CreatedResponseDescription | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CreatedResponseDescription

+
+

Corresponds to a 201 response, containing the relevant location metadata.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
data? +metadata? +statusCode +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Optional data

+
data?: Guarded<Readable>
+
+

Optional metadata

+
metadata?: RepresentationMetadata
+
+

statusCode

+
statusCode: number
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/CredentialsExtractor.html b/7.x/docs/classes/CredentialsExtractor.html new file mode 100644 index 000000000..46a7b1137 --- /dev/null +++ b/7.x/docs/classes/CredentialsExtractor.html @@ -0,0 +1,177 @@ +CredentialsExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class CredentialsExtractorAbstract

+
+

Responsible for extracting credentials from an incoming request.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: HttpRequest
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/DPoPWebIdExtractor.html b/7.x/docs/classes/DPoPWebIdExtractor.html new file mode 100644 index 000000000..8c832fbfc --- /dev/null +++ b/7.x/docs/classes/DPoPWebIdExtractor.html @@ -0,0 +1,208 @@ +DPoPWebIdExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class DPoPWebIdExtractor

+
+

Credentials extractor that extracts a WebID from a DPoP-bound access token.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +originalUrlExtractor +verify +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly originalUrlExtractor

+
originalUrlExtractor: TargetExtractor
+
+

Private Readonly verify

+
verify: SolidTokenVerifierFunction = ...
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      __namedParameters: HttpRequest
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/DataAccessorBasedStore.html b/7.x/docs/classes/DataAccessorBasedStore.html new file mode 100644 index 000000000..718189bcd --- /dev/null +++ b/7.x/docs/classes/DataAccessorBasedStore.html @@ -0,0 +1,851 @@ +DataAccessorBasedStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class DataAccessorBasedStore

+
+

ResourceStore which uses a DataAccessor for backend access.

+

The DataAccessor interface provides elementary store operations such as read and write. +This DataAccessorBasedStore uses those elementary store operations +to implement the more high-level ResourceStore contact, abstracting all common functionality +such that new stores can be added by implementing the more simple DataAccessor contract. +DataAccessorBasedStore thereby provides behaviours for reuse across different stores, such as:

+
    +
  • Converting container metadata to data
    • +
  • Converting slug to URI
    • +
  • Checking if addResource target is a container
    • +
  • Checking if no containment triples are written to a container
    • +
  • etc.
    • +
+

Currently "metadata" is seen as something that is not directly accessible. +That means that a consumer can't write directly to the metadata of a resource, only indirectly through headers. +(Except for containers where data and metadata overlap).

+

The one thing this store does not take care of (yet?) are containment triples for containers

+

Work has been done to minimize the number of required calls to the DataAccessor, +but the main disadvantage is that sometimes multiple calls are required where a specific store might only need one.

+
+
+
+

Hierarchy

+
    +
  • DataAccessorBasedStore
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
accessor +auxiliaryStrategy +identifierStrategy +logger +metadataStrategy +
+
+

Methods

+
addActivityMetadata +addContainerActivity +addResource +cleanSlug +createRecursiveContainers +createSafeUri +createURI +deleteResource +getNormalizedMetadata +getRepresentation +getSafeNormalizedMetadata +handleContainerData +hasContainerType +hasProperChildren +hasResource +isContainerType +isRootStorage +modifyResource +removeResponseMetadata +safelyDeleteAuxiliaryResources +setRepresentation +updateContainerModifiedDate +validateConditions +validateIdentifier +validateSlug +writeData +writeMetadata +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly accessor

+
accessor: DataAccessor
+
+

Private Readonly auxiliaryStrategy

+
auxiliaryStrategy: AuxiliaryStrategy
+
+

Private Readonly identifierStrategy

+
identifierStrategy: IdentifierStrategy
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly metadataStrategy

+
metadataStrategy: AuxiliaryStrategy
+
+

Methods

+
+

Private addActivityMetadata

+
    + +
  • +

    Generates activity metadata for a resource and adds it to the ChangeMap

    +
    +
    +

    Parameters

    +
      +
    • +
      map: ChangeMap
      +

      ChangeMap to update.

      +
      +
      • +
    • +
      id: ResourceIdentifier
      +

      Identifier of the resource being changed.

      +
      +
      • +
    • +
      activity: NamedNode<string>
      +

      Which activity is taking place.

      +
      +
    +

    Returns void

    +
+
+

Private addContainerActivity

+
    + +
  • +

    Generates activity metadata specifically for Add/Remove events on a container.

    +
    +
    +

    Parameters

    +
      +
    • +
      map: ChangeMap
      +

      ChangeMap to update.

      +
      +
      • +
    • +
      id: ResourceIdentifier
      +

      Identifier of the container.

      +
      +
      • +
    • +
      add: boolean
      +

      If there is a resource being added (true) or removed (false).

      +
      +
      • +
    • +
      object: ResourceIdentifier
      +

      The object that is being added/removed.

      +
      +
    +

    Returns void

    +
+
+

addResource

+
+
+

Protected cleanSlug

+
    + +
  • +

    Clean http Slug to be compatible with the server. Makes sure there are no unwanted characters, +e.g., cleanslug('&%26') returns '%26%26'

    +
    +
    +

    Parameters

    +
      +
    • +
      slug: string
      +

      the slug to clean

      +
      +
    +

    Returns string

    +
+
+

Protected createRecursiveContainers

+
    + +
  • +

    Create containers starting from the root until the given identifier corresponds to an existing container. +Will throw errors if the identifier of the last existing "container" corresponds to an existing document.

    +
    +
    +

    Parameters

    +
      +
    • +
      container: ResourceIdentifier
      +

      Identifier of the container which will need to exist.

      +
      +
    +

    Returns Promise<ChangeMap>

    +
+
+

Protected createSafeUri

+
+
+

Protected createURI

+
    + +
  • +

    Generates a new URI for a resource in the given container, potentially using the given slug.

    +

    Solid, §5.3: "Servers MUST allow creating new resources with a POST request to URI path ending /. +Servers MUST create a resource with URI path ending /{id} in container /. +Servers MUST create a container with URI path ending /{id}/ in container / for requests +including the HTTP Link header with rel="type" targeting a valid LDP container type." +https://solid.github.io/specification/protocol#writing-resources

    +
    +
    +

    Parameters

    +
      +
    • +
      container: ResourceIdentifier
      +

      Parent container of the new URI.

      +
      +
      • +
    • +
      isContainer: boolean
      +

      Does the new URI represent a container?

      +
      +
      • +
    • +
      Optional slug: string
      +

      Slug to use for the new URI.

      +
      +
    +

    Returns ResourceIdentifier

    +
+
+

deleteResource

+
+
+

Protected getNormalizedMetadata

+
+
+

getRepresentation

+
+
+

Protected getSafeNormalizedMetadata

+
+
+

Protected handleContainerData

+
    + +
  • +

    Warns when the representation has data and removes the content-type from the metadata.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    +
+
+

Protected hasContainerType

+
    + +
  • +

    Checks in a list of types if any of them match a Container type.

    +
    +
    +

    Parameters

    +
      +
    • +
      rdfTypes: Term[]
    +

    Returns boolean

    +
+
+

Protected hasProperChildren

+
+
+

hasResource

+
+
+

Protected isContainerType

+
+
+

Protected isRootStorage

+
+
+

modifyResource

+
    + +
  • +

    Sets or updates the representation of a resource, +creating a new resource and intermediary containers as needed.

    +
    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      Identifier of resource to update.

      +
      +
      • +
    • +
      patch: Patch
      +

      Description of which parts to update.

      +
      +
      • +
    • +
      Optional conditions: Conditions
      +

      Optional conditions under which to proceed.

      +
      +
    +

    Returns Promise<never>

    A ChangeMap.

    + +
+
+

Protected removeResponseMetadata

+
+
+

Protected safelyDeleteAuxiliaryResources

+
+
+

setRepresentation

+
+
+

Protected updateContainerModifiedDate

+
+
+

Protected validateConditions

+
+
+

Protected validateIdentifier

+
+
+

Protected validateSlug

+
    + +
  • +

    Validates if the slug and headers are valid. +Errors if slug exists, ends on slash, but ContainerType Link header is NOT present

    +
    +
    +

    Parameters

    +
      +
    • +
      isContainer: boolean
      +

      Is the slug supposed to represent a container?

      +
      +
      • +
    • +
      Optional slug: string
      +

      Is the requested slug (if any).

      +
      +
    +

    Returns void

    +
+
+

Protected writeData

+
    + +
  • +

    Write the given resource to the DataAccessor. Metadata will be updated with necessary triples. +For containers, handleContainerData will be used to verify the data.

    +
    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      Identifier of the resource.

      +
      +
      • +
    • +
      representation: Representation
      +

      Corresponding Representation.

      +
      +
      • +
    • +
      isContainer: boolean
      +

      Is the incoming resource a container?

      +
      +
      • +
    • +
      createContainers: boolean
      +

      Should parent containers (potentially) be created?

      +
      +
      • +
    • +
      exists: boolean
      +

      If the resource already exists.

      +
      +
    +

    Returns Promise<ChangeMap>

    Identifiers of resources that were possibly modified.

    + +
+
+

Protected writeMetadata

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/DeleteClientCredentialsHandler.html b/7.x/docs/classes/DeleteClientCredentialsHandler.html new file mode 100644 index 000000000..b819e6f4a --- /dev/null +++ b/7.x/docs/classes/DeleteClientCredentialsHandler.html @@ -0,0 +1,199 @@ +DeleteClientCredentialsHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class DeleteClientCredentialsHandler

+
+

Handles the deletion of client credentials tokens.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
clientCredentialsRoute +clientCredentialsStore +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly clientCredentialsRoute

+
clientCredentialsRoute: ClientCredentialsIdRoute
+
+

Private Readonly clientCredentialsStore

+
clientCredentialsStore: ClientCredentialsStore
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/DeleteNotificationGenerator.html b/7.x/docs/classes/DeleteNotificationGenerator.html new file mode 100644 index 000000000..68f853647 --- /dev/null +++ b/7.x/docs/classes/DeleteNotificationGenerator.html @@ -0,0 +1,173 @@ +DeleteNotificationGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class DeleteNotificationGenerator

+
+

Generates a Notification for a resource that was deleted. +This differs from other activity notifications in that there is no state and no resource metadata +since the resource no longer exists.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/DeleteOperationHandler.html b/7.x/docs/classes/DeleteOperationHandler.html new file mode 100644 index 000000000..522907435 --- /dev/null +++ b/7.x/docs/classes/DeleteOperationHandler.html @@ -0,0 +1,191 @@ +DeleteOperationHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class DeleteOperationHandler

+
+

Handles DELETE Operations. +Calls the deleteResource function from a ResourceStore.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
store +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly store

+
store: ResourceStore
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/DeleteParentExtractor.html b/7.x/docs/classes/DeleteParentExtractor.html new file mode 100644 index 000000000..6a9dababf --- /dev/null +++ b/7.x/docs/classes/DeleteParentExtractor.html @@ -0,0 +1,213 @@ +DeleteParentExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class DeleteParentExtractor

+
+

In case a resource is being deleted but does not exist, +the server response code depends on the access modes the agent has on the parent container. +In case the agent has read access on the parent container, a 404 should be returned, +otherwise it should be 401/403.

+

This class adds support for this by requiring read access on the parent container +in case the target resource does not exist.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
identifierStrategy +resourceSet +source +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly identifierStrategy

+
identifierStrategy: IdentifierStrategy
+
+

Private Readonly resourceSet

+
resourceSet: ResourceSet
+
+

Private Readonly source

+
source: ModesExtractor
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      operation: Operation
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/DeletePasswordHandler.html b/7.x/docs/classes/DeletePasswordHandler.html new file mode 100644 index 000000000..c23cc81b3 --- /dev/null +++ b/7.x/docs/classes/DeletePasswordHandler.html @@ -0,0 +1,199 @@ +DeletePasswordHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class DeletePasswordHandler

+
+

Handles the deletion of a password login method.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
passwordRoute +passwordStore +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly passwordRoute

+
passwordRoute: PasswordIdRoute
+
+

Private Readonly passwordStore

+
passwordStore: PasswordStore
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/DynamicJsonToTemplateConverter.html b/7.x/docs/classes/DynamicJsonToTemplateConverter.html new file mode 100644 index 000000000..7dd116ba5 --- /dev/null +++ b/7.x/docs/classes/DynamicJsonToTemplateConverter.html @@ -0,0 +1,240 @@ +DynamicJsonToTemplateConverter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class DynamicJsonToTemplateConverter

+
+

Converts JSON data by using it as input parameters for rendering a template. +The extension field can be used to only support a specific type of templates, +such as ".ejs" for EJS templates.

+

To find the templates it expects the Representation metadata to contain SOLID_META.template triples, +with the objects being the template paths. +For each of those templates there also needs to be a CONTENT_TYPE triple +describing the content-type of that template.

+

The output of the result depends on the content-type matched with the template. +In case JSON is the most preferred output type, +the input representation will be returned unless a JSON template is defined.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
templateEngine +
+
+

Methods

+
canHandle +constructTypeMap +findType +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly templateEngine

+
templateEngine: TemplateEngine<Dict<unknown>>
+
+

Methods

+
+

canHandle

+
+
+

Private constructTypeMap

+
+
+

Private findType

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/EjsTemplateEngine.html b/7.x/docs/classes/EjsTemplateEngine.html new file mode 100644 index 000000000..b0bf632a5 --- /dev/null +++ b/7.x/docs/classes/EjsTemplateEngine.html @@ -0,0 +1,217 @@ +EjsTemplateEngine | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class EjsTemplateEngine<T>

+
+

Fills in EJS templates.

+
+
+
+

Type Parameters

+
    +
  • +

    T extends Dict<unknown> = Dict<unknown>

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
baseUrl +supportedExtensions +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly baseUrl

+
baseUrl: string
+
+

Protected Readonly supportedExtensions

+
supportedExtensions: string[]
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/EmailSender.html b/7.x/docs/classes/EmailSender.html new file mode 100644 index 000000000..719c1e4a6 --- /dev/null +++ b/7.x/docs/classes/EmailSender.html @@ -0,0 +1,173 @@ +EmailSender | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class EmailSenderAbstract

+
+

A class that can send an e-mail.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: EmailArgs
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: EmailArgs
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving when handling is finished.

    + +
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: EmailArgs
      +

      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.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/EqualReadWriteLocker.html b/7.x/docs/classes/EqualReadWriteLocker.html new file mode 100644 index 000000000..4e6377dfe --- /dev/null +++ b/7.x/docs/classes/EqualReadWriteLocker.html @@ -0,0 +1,240 @@ +EqualReadWriteLocker | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class EqualReadWriteLocker

+
+

A ReadWriteLocker that gives no priority to read or write operations: both use the same lock.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
locker +
+
+

Methods

+
withLock +withReadLock +withWriteLock +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly locker

+
locker: ResourceLocker
+
+

Methods

+
+

Protected withLock

+
    + +
  • +

    Acquires a new lock for the requested identifier. +Will resolve when the input function resolves.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
    +

    Returns Promise<T>

    +
+
+

withReadLock

+
    + +
  • +

    Run the given function while the resource is locked. +The lock will be released when the (async) input function resolves. +This function should be used for operations that only require reading the resource.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
    +

    Returns Promise<T>

    A promise resolving when the lock is released.

    + +
+
+

withWriteLock

+
    + +
  • +

    Run the given function while the resource is locked. +The lock will be released when the (async) input function resolves. +This function should be used for operations that could modify the resource.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
    +

    Returns Promise<T>

    A promise resolving when the lock is released.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ErrorHandler.html b/7.x/docs/classes/ErrorHandler.html new file mode 100644 index 000000000..df2782e76 --- /dev/null +++ b/7.x/docs/classes/ErrorHandler.html @@ -0,0 +1,176 @@ +ErrorHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ErrorHandlerAbstract

+
+

Converts an error into a ResponseDescription based on the request preferences.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ErrorToJsonConverter.html b/7.x/docs/classes/ErrorToJsonConverter.html new file mode 100644 index 000000000..f70c2e970 --- /dev/null +++ b/7.x/docs/classes/ErrorToJsonConverter.html @@ -0,0 +1,230 @@ +ErrorToJsonConverter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ErrorToJsonConverter

+
+

Converts an Error object to JSON by copying its fields.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
inputTypes +outputTypes +
+
+

Methods

+
canHandle +errorToJson +getOutputTypes +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected inputTypes

+
inputTypes: Promise<ValuePreferences>
+
+

Protected outputTypes

+
outputTypes: Promise<ValuePreferences>
+
+

Methods

+
+

canHandle

+
+
+

Private errorToJson

+
+
+

getOutputTypes

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ErrorToQuadConverter.html b/7.x/docs/classes/ErrorToQuadConverter.html new file mode 100644 index 000000000..bed879e2c --- /dev/null +++ b/7.x/docs/classes/ErrorToQuadConverter.html @@ -0,0 +1,215 @@ +ErrorToQuadConverter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ErrorToQuadConverter

+
+

Converts an error object into quads by creating a triple for each of name/message/stack.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
inputTypes +outputTypes +
+
+

Methods

+
canHandle +getOutputTypes +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected inputTypes

+
inputTypes: Promise<ValuePreferences>
+
+

Protected outputTypes

+
outputTypes: Promise<ValuePreferences>
+
+

Methods

+
+

canHandle

+
+
+

getOutputTypes

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ErrorToTemplateConverter.html b/7.x/docs/classes/ErrorToTemplateConverter.html new file mode 100644 index 000000000..4ce481c25 --- /dev/null +++ b/7.x/docs/classes/ErrorToTemplateConverter.html @@ -0,0 +1,264 @@ +ErrorToTemplateConverter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ErrorToTemplateConverter

+
+

Serializes an Error by filling in the provided template. +Content-type is based on the constructor parameter.

+

In case the input Error has an errorCode value, +the converter will look in the descriptions for a file +with the exact same name as that error code + extension. +The templating engine will then be applied to that file. +That result will be passed as an additional parameter to the main templating call, +using the variable codeMessage.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
codeTemplatesPath +contentType +extension +inputTypes +mainTemplatePath +outputTypes +templateEngine +
+
+

Methods

+
canHandle +getOutputTypes +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly codeTemplatesPath

+
codeTemplatesPath: string
+
+

Private Readonly contentType

+
contentType: string
+
+

Private Readonly extension

+
extension: string
+
+

Protected inputTypes

+
inputTypes: Promise<ValuePreferences>
+
+

Private Readonly mainTemplatePath

+
mainTemplatePath: string
+
+

Protected outputTypes

+
outputTypes: Promise<ValuePreferences>
+
+

Private Readonly templateEngine

+
templateEngine: TemplateEngine<Dict<unknown>>
+
+

Methods

+
+

canHandle

+
+
+

getOutputTypes

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ExpiringAdapter.html b/7.x/docs/classes/ExpiringAdapter.html new file mode 100644 index 000000000..6cae17ef6 --- /dev/null +++ b/7.x/docs/classes/ExpiringAdapter.html @@ -0,0 +1,311 @@ +ExpiringAdapter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ExpiringAdapter

+
+

An IDP storage adapter that uses an ExpiringStorage +to persist data.

+
+
+
+

Hierarchy

+
    +
  • ExpiringAdapter
+
+

Implements

+
    +
  • Adapter
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +name +storage +
+
+

Methods

+
consume +destroy +find +findByUid +findByUserCode +grantKeyFor +keyFor +revokeByGrantId +uidKeyFor +upsert +userCodeKeyFor +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly name

+
name: string
+
+

Private Readonly storage

+
storage: ExpiringStorage<string, unknown>
+
+

Methods

+
+

consume

+
+
+

destroy

+
+
+

find

+
+
+

findByUid

+
+
+

findByUserCode

+
+
+

Private grantKeyFor

+
+
+

Private keyFor

+
+
+

revokeByGrantId

+
+
+

Private uidKeyFor

+
+
+

upsert

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      id: string
      • +
    • +
      payload: AdapterPayload
      • +
    • +
      Optional expiresIn: number
    +

    Returns Promise<void>

+
+

Private userCodeKeyFor

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ExpiringAdapterFactory.html b/7.x/docs/classes/ExpiringAdapterFactory.html new file mode 100644 index 000000000..ceb1a0305 --- /dev/null +++ b/7.x/docs/classes/ExpiringAdapterFactory.html @@ -0,0 +1,134 @@ +ExpiringAdapterFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ExpiringAdapterFactory

+
+

The factory for a ExpiringStorageAdapter

+
+
+
+

Hierarchy

+
    +
  • ExpiringAdapterFactory
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
storage +
+
+

Methods

+
createStorageAdapter +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly storage

+
storage: ExpiringStorage<string, unknown>
+
+

Methods

+
+

createStorageAdapter

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ExtensionBasedMapper.html b/7.x/docs/classes/ExtensionBasedMapper.html new file mode 100644 index 000000000..36c3c6cab --- /dev/null +++ b/7.x/docs/classes/ExtensionBasedMapper.html @@ -0,0 +1,507 @@ +ExtensionBasedMapper | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ExtensionBasedMapper

+
+

Supports the behaviour described in https://www.w3.org/DesignIssues/HTTPFilenameMapping.html +Determines content-type based on the file extension. +In case an identifier does not end on an extension matching its content-type, +the corresponding file will be appended with the correct extension, preceded by $.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
baseRequestURI +customExtensions +customTypes +logger +rootFilepath +unknownMediaTypeExtension +
+
+

Methods

+
getAbsolutePath +getContainerUrl +getContentTypeFromPath +getContentTypeFromUrl +getDocumentUrl +getRelativePath +isMetadataPath +mapFilePathToUrl +mapUrlToContainerPath +mapUrlToDocumentPath +mapUrlToFilePath +stripExtension +validateRelativePath +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly baseRequestURI

+
baseRequestURI: string
+
+

Private Readonly customExtensions

+
customExtensions: Record<string, string>
+
+

Private Readonly customTypes

+
customTypes: Record<string, string>
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Protected Readonly rootFilepath

+
rootFilepath: string
+
+

Protected Readonly unknownMediaTypeExtension

+
unknownMediaTypeExtension: "unknown" = 'unknown'
+
+

Methods

+
+

Protected getAbsolutePath

+
+
+

Protected getContainerUrl

+
+
+

Protected getContentTypeFromPath

+
+
+

Protected getContentTypeFromUrl

+
+
+

Protected getDocumentUrl

+
+
+

Protected getRelativePath

+
+
+

Protected isMetadataPath

+
+
+

mapFilePathToUrl

+
+
+

Protected mapUrlToContainerPath

+
+
+

Protected mapUrlToDocumentPath

+
    + +
  • +

    Maps the given document identifier to a file path, +possibly making alterations to the direct translation +(for instance, based on its content type)). +Determines the content type if none was provided.

    +
    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      The input identifier.

      +
      +
      • +
    • +
      filePath: string
      +

      The direct translation of the identifier onto the file path.

      +
      +
      • +
    • +
      Optional contentType: string
      +

      The content-type provided with the request.

      +
      +
    +

    Returns Promise<ResourceLink>

    A ResourceLink with all the necessary metadata.

    + +
+
+

mapUrlToFilePath

+
    + +
  • +

    Maps the given resource identifier / URL to a file path. +Determines the content type if none was provided. +For containers the content-type input is ignored.

    +
    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      The input identifier.

      +
      +
      • +
    • +
      isMetadata: boolean
      +

      If we need the data or metadata file path.

      +
      +
      • +
    • +
      Optional contentType: string
      +

      The content-type provided with the request.

      +
      +
    +

    Returns Promise<ResourceLink>

    A ResourceLink with all the necessary metadata.

    + +
+
+

Protected stripExtension

+
    + +
  • +

    Helper function that removes the internal extension, one starting with $., from the given path. +Nothing happens if no such extension is present.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
    +

    Returns string

    +
+
+

Protected validateRelativePath

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ExtensionBasedMapperFactory.html b/7.x/docs/classes/ExtensionBasedMapperFactory.html new file mode 100644 index 000000000..278b0c873 --- /dev/null +++ b/7.x/docs/classes/ExtensionBasedMapperFactory.html @@ -0,0 +1,118 @@ +ExtensionBasedMapperFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ExtensionBasedMapperFactory

+
+

Factory that can create FileIdentifierMappers so the base and rootFilePath can be set dynamically. +Specifically used when identifiers need to be generated for a new pod (since pod identifiers are generated).

+
+
+
+

Hierarchy

+
    +
  • ExtensionBasedMapperFactory
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
create +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

create

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ExtensionBasedTemplateEngine.html b/7.x/docs/classes/ExtensionBasedTemplateEngine.html new file mode 100644 index 000000000..6711934df --- /dev/null +++ b/7.x/docs/classes/ExtensionBasedTemplateEngine.html @@ -0,0 +1,209 @@ +ExtensionBasedTemplateEngine | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ExtensionBasedTemplateEngine<T>Abstract

+
+

Parent class for template engines that accept handling based on whether the template extension is supported.

+
+
+
+

Type Parameters

+
    +
  • +

    T extends Dict<unknown> = Dict<unknown>

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
supportedExtensions +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

Protected constructor

+
+
+

Properties

+
+

Protected Readonly supportedExtensions

+
supportedExtensions: string[]
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/FileDataAccessor.html b/7.x/docs/classes/FileDataAccessor.html new file mode 100644 index 000000000..c832357db --- /dev/null +++ b/7.x/docs/classes/FileDataAccessor.html @@ -0,0 +1,561 @@ +FileDataAccessor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class FileDataAccessor

+
+

DataAccessor that uses the file system to store documents as files and containers as folders.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +resourceMapper +
+
+

Methods

+
addPosixMetadata +canHandle +deleteResource +getBaseMetadata +getChildMetadata +getChildren +getData +getDirectoryMetadata +getFileMetadata +getMetadata +getRawMetadata +getStats +verifyExistingExtension +writeContainer +writeDataFile +writeDocument +writeMetadata +writeMetadataFile +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Protected Readonly resourceMapper

+
resourceMapper: FileIdentifierMapper
+
+

Methods

+
+

Private addPosixMetadata

+
    + +
  • +

    Helper function to add file system related metadata.

    +
    +
    +

    Parameters

    +
      +
    • +
      metadata: RepresentationMetadata
      +

      metadata object to add to

      +
      +
      • +
    • +
      stats: Stats
      +

      Stats of the file/directory corresponding to the resource.

      +
      +
    +

    Returns void

    +
+
+

canHandle

+
+
+

deleteResource

+
+
+

Private getBaseMetadata

+
+
+

Private getChildMetadata

+
+
+

getChildren

+
    + +
  • +

    Returns metadata for all resources in the requested container. +This should not be all metadata of those resources (but it can be), +but instead the main metadata you want to show in situations +where all these resources are presented simultaneously. +Generally this would be metadata that is present for all of these resources, +such as resource type or last modified date.

    +

    It can be safely assumed that the incoming identifier will always correspond to a container.

    +
    +
    +

    Parameters

    +
    +

    Returns AsyncIterableIterator<RepresentationMetadata>

    +
+
+

getData

+
+
+

Private getDirectoryMetadata

+
+
+

Private getFileMetadata

+
+
+

getMetadata

+
+
+

Private getRawMetadata

+
    + +
  • +

    Reads the metadata from the corresponding metadata file. +Returns an empty array if there is no metadata file.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Quad[]>

    +
+
+

Protected getStats

+
    + +
  • +

    Gets the Stats object corresponding to the given file path, +resolving symbolic links.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      File path to get info from.

      +
      +
    +

    Returns Promise<Stats>

    +
    +

    Throws

    NotFoundHttpError +If the file/folder doesn't exist.

    +
+
+

Protected verifyExistingExtension

+
    + +
  • +

    Verifies if there already is a file corresponding to the given resource. +If yes, that file is removed if it does not match the path given in the input ResourceLink. +This can happen if the content-type differs from the one that was stored.

    +
    +
    +

    Parameters

    +
      +
    • +
      link: ResourceLink
      +

      ResourceLink corresponding to the new resource data.

      +
      +
    +

    Returns Promise<void>

    +
+
+

writeContainer

+
+
+

Protected writeDataFile

+
    + +
  • +

    Helper function without extra validation checking to create a data file.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      The filepath of the file to be created.

      +
      +
      • +
    • +
      data: Readable
      +

      The data to be put in the file.

      +
      +
    +

    Returns Promise<void>

    +
+
+

writeDocument

+
+
+

writeMetadata

+
+
+

Protected writeMetadataFile

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/FileSizeReporter.html b/7.x/docs/classes/FileSizeReporter.html new file mode 100644 index 000000000..378623785 --- /dev/null +++ b/7.x/docs/classes/FileSizeReporter.html @@ -0,0 +1,233 @@ +FileSizeReporter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class FileSizeReporter

+
+

SizeReporter that is used to calculate sizes of resources for a file based system.

+
+
+
+

Hierarchy

+
    +
  • FileSizeReporter
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
fileIdentifierMapper +ignoreFolders +rootFilePath +
+
+

Methods

+
calculateChunkSize +estimateSize +getSize +getTotalSize +getUnit +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly fileIdentifierMapper

+
fileIdentifierMapper: FileIdentifierMapper
+
+

Private Readonly ignoreFolders

+
ignoreFolders: RegExp[]
+
+

Private Readonly rootFilePath

+
rootFilePath: string
+
+

Methods

+
+

calculateChunkSize

+
+
+

estimateSize

+
+
+

getSize

+
+
+

Private getTotalSize

+
    + +
  • +

    Get the total size of a resource and its children if present

    +
    +
    +

    Parameters

    +
      +
    • +
      fileLocation: string
      +

      the resource of which you want the total size of ( on disk )

      +
      +
    +

    Returns Promise<number>

    a number specifying how many bytes are used by the resource

    + +
+
+

getUnit

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/FileSystemResourceLocker.html b/7.x/docs/classes/FileSystemResourceLocker.html new file mode 100644 index 000000000..70db3c208 --- /dev/null +++ b/7.x/docs/classes/FileSystemResourceLocker.html @@ -0,0 +1,356 @@ +FileSystemResourceLocker | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class FileSystemResourceLocker

+
+

A resource locker making use of the proper-lockfile library. +Note that no locks are kept in memory, thus this is considered thread- and process-safe. +While it stores the actual locks on disk, it also tracks them in memory for when they need to be released. +This means only the worker thread that acquired a lock can release it again, +making this implementation unusable in combination with a wrapping read/write lock implementation.

+

This proper-lockfile library has its own retry mechanism for the operations, since a lock/unlock call will +either resolve successfully or reject immediately with the causing error. The retry function of the library +however will be ignored and replaced by our own LockUtils' retryFunction function.

+
+
+
+

Hierarchy

+
    +
  • FileSystemResourceLocker
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
attemptSettings +finalized +lockFolder +lockOptions +logger +
+
+

Methods

+
acquire +customOnCompromised +finalize +generateOptions +initialize +release +swallowErrors +toLockfilePath +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly attemptSettings

+
attemptSettings: Required<AttemptSettings>
+
+

Private finalized

+
finalized: boolean = false
+
+

Private Readonly lockFolder

+
lockFolder: string
+

Folder that stores the locks

+
+
+
+

Private Readonly lockOptions

+
lockOptions: LockOptions
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Methods

+
+

acquire

+
+
+

Private customOnCompromised

+
    + +
  • +

    This function is used to override the proper-lock onCompromised function. +Once the locker was finalized, it will log the provided error instead of throwing it +This allows for a clean shutdown procedure.

    +
    +
    +

    Parameters

    +
      +
    • +
      err: Error
    +

    Returns void

    +
+
+

finalize

+
+
+

Private generateOptions

+
    + +
  • +

    Generate LockOptions or UnlockOptions depending on the type of defauls given. +A custom lockFilePath mapping strategy will be used.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      ResourceIdentifier to generate (Un)LockOptions for

      +
      +
      • +
    • +
      defaults: T
      +

      The default options. (lockFilePath will get overwritten)

      +
      +
    +

    Returns T

    LockOptions or UnlockOptions

    + +
+
+

initialize

+
+
+

release

+
+
+

Private swallowErrors

+
    + +
  • +

    Wrapper function for all (un)lock operations. Any errors coming from the fn() will be swallowed. +Only ENOTACQUIRED errors wills be thrown (trying to release lock that didn't exist). +This wrapper returns undefined because retryFunction expects that when a retry needs to happen.

    +
    +
    +

    Parameters

    +
      +
    • +
      fn: (() => Promise<unknown>)
      +

      The function reference to swallow errors from.

      +
      +
      +
        +
      • +
          +
        • (): Promise<unknown>
          • +
        • +

          Returns Promise<unknown>

    +

    Returns (() => Promise<unknown>)

    Boolean or undefined.

    + +
      +
    • +
        +
      • (): Promise<unknown>
        • +
      • +

        Wrapper function for all (un)lock operations. Any errors coming from the fn() will be swallowed. +Only ENOTACQUIRED errors wills be thrown (trying to release lock that didn't exist). +This wrapper returns undefined because retryFunction expects that when a retry needs to happen.

        +
        +

        Returns Promise<unknown>

        Boolean or undefined.

        + +
    +
+
+

Private toLockfilePath

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/FilterMetadataDataAccessor.html b/7.x/docs/classes/FilterMetadataDataAccessor.html new file mode 100644 index 000000000..a062fc834 --- /dev/null +++ b/7.x/docs/classes/FilterMetadataDataAccessor.html @@ -0,0 +1,374 @@ +FilterMetadataDataAccessor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class FilterMetadataDataAccessor

+
+

A FilterMetadataDataAccessor wraps a DataAccessor such that specific metadata properties +can be filtered before passing on the call to the wrapped DataAccessor.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
accessor +filters +
+
+

Methods

+
applyFilters +canHandle +deleteResource +getChildren +getData +getMetadata +writeContainer +writeDocument +writeMetadata +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly accessor

+
accessor: AtomicDataAccessor
+
+

Private Readonly filters

+
filters: FilterPattern[]
+
+

Methods

+
+

Private applyFilters

+
+
+

canHandle

+
+
+

deleteResource

+
+
+

getChildren

+
    + +
  • +

    Returns metadata for all resources in the requested container. +This should not be all metadata of those resources (but it can be), +but instead the main metadata you want to show in situations +where all these resources are presented simultaneously. +Generally this would be metadata that is present for all of these resources, +such as resource type or last modified date.

    +

    It can be safely assumed that the incoming identifier will always correspond to a container.

    +
    +
    +

    Parameters

    +
    +

    Returns AsyncIterableIterator<RepresentationMetadata>

    +
+
+

getData

+
+
+

getMetadata

+
+
+

writeContainer

+
+
+

writeDocument

+
+
+

writeMetadata

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/FilterPattern.html b/7.x/docs/classes/FilterPattern.html new file mode 100644 index 000000000..223621c6e --- /dev/null +++ b/7.x/docs/classes/FilterPattern.html @@ -0,0 +1,137 @@ +FilterPattern | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class FilterPattern

+
+

Represents a triple pattern to be used as a filter.

+
+
+
+

Hierarchy

+
    +
  • FilterPattern
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
object +predicate +subject +
+
+

Constructors

+
+

constructor

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      Optional subject: string
      +

      Optionally filter based on a specific subject.

      +
      +
      • +
    • +
      Optional predicate: string
      +

      Optionally filter based on a predicate.

      +
      +
      • +
    • +
      Optional object: string
      +

      Optionally filter based on a specific object.

      +
      +
    +

    Returns FilterPattern

    +
+
+

Properties

+
+

Readonly object

+
object: null | NamedNode<string>
+
+

Readonly predicate

+
predicate: null | NamedNode<string>
+
+

Readonly subject

+
subject: null | NamedNode<string>
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/FinalizableHandler.html b/7.x/docs/classes/FinalizableHandler.html new file mode 100644 index 000000000..ca0f5d29e --- /dev/null +++ b/7.x/docs/classes/FinalizableHandler.html @@ -0,0 +1,182 @@ +FinalizableHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class FinalizableHandler

+
+

Allows using a Finalizable as a Finalizer Handler.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
finalizable +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly finalizable

+
finalizable: Finalizable
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      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.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/Finalizer.html b/7.x/docs/classes/Finalizer.html new file mode 100644 index 000000000..5400454cf --- /dev/null +++ b/7.x/docs/classes/Finalizer.html @@ -0,0 +1,173 @@ +Finalizer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class FinalizerAbstract

+
+

Finalizer is used to indicate an AsyncHandler that performs finalization logic.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving when handling is finished.

    + +
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      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.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/FixedContentTypeMapper.html b/7.x/docs/classes/FixedContentTypeMapper.html new file mode 100644 index 000000000..1da7d4faa --- /dev/null +++ b/7.x/docs/classes/FixedContentTypeMapper.html @@ -0,0 +1,504 @@ +FixedContentTypeMapper | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class FixedContentTypeMapper

+
+

A mapper that always returns a fixed content type for files.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
baseRequestURI +contentType +logger +pathSuffix +rootFilepath +unknownMediaTypeExtension +urlSuffix +
+
+

Methods

+
getAbsolutePath +getContainerUrl +getContentTypeFromPath +getContentTypeFromUrl +getDocumentUrl +getRelativePath +isMetadataPath +mapFilePathToUrl +mapUrlToContainerPath +mapUrlToDocumentPath +mapUrlToFilePath +validateRelativePath +
+
+

Constructors

+
+

constructor

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      base: string
      +

      Base URL.

      +
      +
      • +
    • +
      rootFilepath: string
      +

      Base file path.

      +
      +
      • +
    • +
      contentType: string
      +

      Fixed content type that will be used for all resources.

      +
      +
      • +
    • +
      pathSuffix: string = ''
      +

      An optional suffix that will be appended to all file paths. + Requested file paths without this suffix will be rejected.

      +
      +
      • +
    • +
      urlSuffix: string = ''
      +

      An optional suffix that will be appended to all URL. + Requested URLs without this suffix will be rejected.

      +
      +
    +

    Returns FixedContentTypeMapper

    +
+
+

Properties

+
+

Protected Readonly baseRequestURI

+
baseRequestURI: string
+
+

Protected Readonly contentType

+
contentType: string
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Protected Readonly pathSuffix

+
pathSuffix: string
+
+

Protected Readonly rootFilepath

+
rootFilepath: string
+
+

Protected Readonly unknownMediaTypeExtension

+
unknownMediaTypeExtension: "unknown" = 'unknown'
+
+

Protected Readonly urlSuffix

+
urlSuffix: string
+
+

Methods

+
+

Protected getAbsolutePath

+
+
+

Protected getContainerUrl

+
+
+

Protected getContentTypeFromPath

+
+
+

Protected getContentTypeFromUrl

+
+
+

Protected getDocumentUrl

+
+
+

Protected getRelativePath

+
+
+

Protected isMetadataPath

+
+
+

mapFilePathToUrl

+
+
+

Protected mapUrlToContainerPath

+
+
+

mapUrlToDocumentPath

+
    + +
  • +

    Maps the given document identifier to a file path, +possibly making alterations to the direct translation +(for instance, based on its content type)). +Determines the content type if none was provided.

    +
    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      The input identifier.

      +
      +
      • +
    • +
      filePath: string
      +

      The direct translation of the identifier onto the file path.

      +
      +
      • +
    • +
      Optional contentType: string
      +

      The content-type provided with the request.

      +
      +
    +

    Returns Promise<ResourceLink>

    A ResourceLink with all the necessary metadata.

    + +
+
+

mapUrlToFilePath

+
    + +
  • +

    Maps the given resource identifier / URL to a file path. +Determines the content type if none was provided. +For containers the content-type input is ignored.

    +
    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      The input identifier.

      +
      +
      • +
    • +
      isMetadata: boolean
      +

      If we need the data or metadata file path.

      +
      +
      • +
    • +
      Optional contentType: string
      +

      The content-type provided with the request.

      +
      +
    +

    Returns Promise<ResourceLink>

    A ResourceLink with all the necessary metadata.

    + +
+
+

Protected validateRelativePath

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ForbiddenHttpError.html b/7.x/docs/classes/ForbiddenHttpError.html new file mode 100644 index 000000000..2e3b8f098 --- /dev/null +++ b/7.x/docs/classes/ForbiddenHttpError.html @@ -0,0 +1,228 @@ +ForbiddenHttpError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ForbiddenHttpError

+
+

An error thrown when an agent is not allowed to access data.

+
+
+
+

Hierarchy

+
    +
  • BaseHttpError +
      +
    • ForbiddenHttpError
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
cause? +errorCode +message +metadata +name +stack? +statusCode +isInstance +statusCode +uri +
+
+

Methods

+
generateMetadata +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Optional Readonly cause

+
cause?: unknown
+
+

Readonly errorCode

+
errorCode: string
+
+

message

+
message: string
+
+

Readonly metadata

+
metadata: RepresentationMetadata
+
+

name

+
name: string
+
+

Optional stack

+
stack?: string
+
+

Readonly statusCode

+
statusCode: 403
+
+

Static Readonly isInstance

+
isInstance: ((error) => error is HttpError<403>)
+
+

Type declaration

+
    +
  • +
      +
    • (error): error is HttpError<403>
      • +
    • +

      Checks whether the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: unknown
      +

      Returns error is HttpError<403>

      +
+
+

Static Readonly statusCode

+
statusCode: 403
+

The status code corresponding to this error class.

+
+
+
+

Static Readonly uri

+
uri: NamedNode<string>
+

A unique URI identifying this error class.

+
+
+
+

Methods

+
+

Protected generateMetadata

+
    + +
  • +

    Initializes the error metadata.

    +
    +

    Returns void

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ForgetWebIdHandler.html b/7.x/docs/classes/ForgetWebIdHandler.html new file mode 100644 index 000000000..3e62acdb5 --- /dev/null +++ b/7.x/docs/classes/ForgetWebIdHandler.html @@ -0,0 +1,191 @@ +ForgetWebIdHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ForgetWebIdHandler

+
+

Forgets the chosen WebID in an OIDC interaction, +causing the next policy trigger to be one where a new WebID has to be chosen.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
providerFactory +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly providerFactory

+
providerFactory: ProviderFactory
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ForgotPasswordHandler.html b/7.x/docs/classes/ForgotPasswordHandler.html new file mode 100644 index 000000000..db7ec4814 --- /dev/null +++ b/7.x/docs/classes/ForgotPasswordHandler.html @@ -0,0 +1,264 @@ +ForgotPasswordHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ForgotPasswordHandler

+
+

Responsible for the case where a user forgot their password and asks for a reset. +Will send out the necessary mail if the email address is known. +The JSON response will always be the same to prevent leaking which email addresses are stored.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
emailSender +forgotPasswordStore +logger +passwordStore +resetRoute +templateEngine +
+
+

Methods

+
canHandle +getView +handle +handleSafe +sendResetMail +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly emailSender

+
emailSender: EmailSender
+
+

Private Readonly forgotPasswordStore

+
forgotPasswordStore: ForgotPasswordStore
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly passwordStore

+
passwordStore: PasswordStore
+
+

Private Readonly resetRoute

+
resetRoute: InteractionRoute<never>
+
+

Private Readonly templateEngine

+
templateEngine: TemplateEngine<{
    resetLink: string;
}>
+
+

Type declaration

+
    +
  • +
    resetLink: string
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

getView

+
+
+

handle

+
+
+

handleSafe

+
+
+

Private sendResetMail

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/FormToJsonConverter.html b/7.x/docs/classes/FormToJsonConverter.html new file mode 100644 index 000000000..bcc4f5681 --- /dev/null +++ b/7.x/docs/classes/FormToJsonConverter.html @@ -0,0 +1,216 @@ +FormToJsonConverter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class FormToJsonConverter

+
+

Converts application/x-www-form-urlencoded data to application/json. +Due to the nature of form data, the result will be a simple key/value JSON object.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
inputTypes +outputTypes +
+
+

Methods

+
canHandle +getOutputTypes +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected inputTypes

+
inputTypes: Promise<ValuePreferences>
+
+

Protected outputTypes

+
outputTypes: Promise<ValuePreferences>
+
+

Methods

+
+

canHandle

+
+
+

getOutputTypes

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/FoundHttpError.html b/7.x/docs/classes/FoundHttpError.html new file mode 100644 index 000000000..4de9f9851 --- /dev/null +++ b/7.x/docs/classes/FoundHttpError.html @@ -0,0 +1,239 @@ +FoundHttpError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class FoundHttpError

+
+

Error used for resources that have been moved temporarily. +Methods other than GET may or may not be changed to GET in subsequent requests.

+
+
+
+

Hierarchy

+
    +
  • BaseHttpError +
      +
    • FoundHttpError
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
cause? +errorCode +location +message +metadata +name +stack? +statusCode +isInstance +statusCode +uri +
+
+

Methods

+
generateMetadata +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Optional Readonly cause

+
cause?: unknown
+
+

Readonly errorCode

+
errorCode: string
+
+

Readonly location

+
location: string
+
+

message

+
message: string
+
+

Readonly metadata

+
metadata: RepresentationMetadata
+
+

name

+
name: string
+
+

Optional stack

+
stack?: string
+
+

Readonly statusCode

+
statusCode: 302
+
+

Static Readonly isInstance

+
isInstance: ((error) => error is HttpError<302>)
+
+

Type declaration

+
    +
  • +
      +
    • (error): error is HttpError<302>
      • +
    • +

      Checks whether the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: unknown
      +

      Returns error is HttpError<302>

      +
+
+

Static Readonly statusCode

+
statusCode: 302
+

The status code corresponding to this error class.

+
+
+
+

Static Readonly uri

+
uri: NamedNode<string>
+

A unique URI identifying this error class.

+
+
+
+

Methods

+
+

Protected generateMetadata

+
    + +
  • +

    Initializes the error metadata.

    +
    +

    Returns void

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/GeneratedPodManager.html b/7.x/docs/classes/GeneratedPodManager.html new file mode 100644 index 000000000..823d755f8 --- /dev/null +++ b/7.x/docs/classes/GeneratedPodManager.html @@ -0,0 +1,157 @@ +GeneratedPodManager | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class GeneratedPodManager

+
+

Pod manager that uses an IdentifierGenerator and ResourcesGenerator +to create the default resources and identifier for a new pod.

+
+
+
+

Hierarchy

+
    +
  • GeneratedPodManager
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +resourcesGenerator +store +
+
+

Methods

+
createPod +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly resourcesGenerator

+
resourcesGenerator: ResourcesGenerator
+
+

Private Readonly store

+
store: ResourceStore
+
+

Methods

+
+

createPod

+
    + +
  • +

    Creates a new pod, pre-populating it with the resources created by the data generator. +Will throw an error if the given identifier already has a resource.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/GetOperationHandler.html b/7.x/docs/classes/GetOperationHandler.html new file mode 100644 index 000000000..5bd7dd393 --- /dev/null +++ b/7.x/docs/classes/GetOperationHandler.html @@ -0,0 +1,200 @@ +GetOperationHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class GetOperationHandler

+
+

Handles GET Operations. +Calls the getRepresentation function from a ResourceStore.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
eTagHandler +store +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly eTagHandler

+
eTagHandler: ETagHandler
+
+

Private Readonly store

+
store: ResourceStore
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/GlobalQuotaStrategy.html b/7.x/docs/classes/GlobalQuotaStrategy.html new file mode 100644 index 000000000..465045202 --- /dev/null +++ b/7.x/docs/classes/GlobalQuotaStrategy.html @@ -0,0 +1,227 @@ +GlobalQuotaStrategy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class GlobalQuotaStrategy

+
+

The GlobalQuotaStrategy sets a limit on the amount of data stored on the server globally.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
base +limit +reporter +
+
+

Methods

+
createQuotaGuard +estimateSize +getAvailableSpace +getTotalSpaceUsed +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly base

+
base: string
+
+

Readonly limit

+
limit: Size
+
+

Readonly reporter

+
reporter: SizeReporter<unknown>
+
+

Methods

+
+

createQuotaGuard

+
    + +
  • +

    Get a Passthrough stream that will keep track of the available space. +If the quota is exceeded the stream will emit an error and destroy itself. +Like other Passthrough instances this will simply pass on the chunks, when the quota isn't exceeded.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Guarded<PassThrough>>

    a Passthrough instance that errors when quota is exceeded

    + +
+
+

estimateSize

+
+
+

getAvailableSpace

+
    + +
  • +

    Get the available space when writing data to the given identifier. +If the given resource already exists it will deduct the already taken up +space by that resource since it is going to be overwritten and thus counts +as available space.

    +
    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      the identifier of the resource of which you want the available space

      +
      +
    +

    Returns Promise<Size>

    the available space and the unit of the space as a Size object

    + +
+
+

Protected getTotalSpaceUsed

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/GreedyReadWriteLocker.html b/7.x/docs/classes/GreedyReadWriteLocker.html new file mode 100644 index 000000000..91239cef2 --- /dev/null +++ b/7.x/docs/classes/GreedyReadWriteLocker.html @@ -0,0 +1,354 @@ +GreedyReadWriteLocker | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class GreedyReadWriteLocker

+
+

A BaseReadWriteLocker that uses the same locker for the main lock and the count lock, +and uses a KeyValueStorage for keeping track of the counter.

+

Since it is completely dependent on other implementations, +this locker is threadsafe if its inputs are as well.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
countLocker +countSuffix +locker +readSuffix +storage +
+
+

Methods

+
getCountKey +getCountLockIdentifier +modifyCount +withLock +withReadLock +withWriteLock +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly countLocker

+
countLocker: ResourceLocker
+
+

Protected Readonly countSuffix

+
countSuffix: string
+
+

Protected Readonly locker

+
locker: ResourceLocker
+
+

Protected Readonly readSuffix

+
readSuffix: string
+
+

Protected Readonly storage

+
storage: KeyValueStorage<string, number>
+
+

Methods

+
+

Protected getCountKey

+
+
+

Protected getCountLockIdentifier

+
+
+

Protected modifyCount

+
+
+

Protected withLock

+
+
+

withReadLock

+
    + +
  • +

    Run the given function while the resource is locked. +The lock will be released when the (async) input function resolves. +This function should be used for operations that only require reading the resource.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
    +

    Returns Promise<T>

    A promise resolving when the lock is released.

    + +
+
+

withWriteLock

+
    + +
  • +

    Run the given function while the resource is locked. +The lock will be released when the (async) input function resolves. +This function should be used for operations that could modify the resource.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
    +

    Returns Promise<T>

    A promise resolving when the lock is released.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/HandlebarsTemplateEngine.html b/7.x/docs/classes/HandlebarsTemplateEngine.html new file mode 100644 index 000000000..9549bdd7a --- /dev/null +++ b/7.x/docs/classes/HandlebarsTemplateEngine.html @@ -0,0 +1,217 @@ +HandlebarsTemplateEngine | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class HandlebarsTemplateEngine<T>

+
+

Fills in Handlebars templates.

+
+
+
+

Type Parameters

+
    +
  • +

    T extends Dict<unknown> = Dict<unknown>

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
baseUrl +supportedExtensions +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly baseUrl

+
baseUrl: string
+
+

Protected Readonly supportedExtensions

+
supportedExtensions: string[]
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/HandlerServerConfigurator.html b/7.x/docs/classes/HandlerServerConfigurator.html new file mode 100644 index 000000000..24d5ed95c --- /dev/null +++ b/7.x/docs/classes/HandlerServerConfigurator.html @@ -0,0 +1,245 @@ +HandlerServerConfigurator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class HandlerServerConfigurator

+
+

A ServerConfigurator that attaches an HttpHandler to the request event of a Server. +All incoming requests will be sent to the provided handler. +Failsafes are added to make sure a valid response is sent in case something goes wrong.

+

The showStackTrace parameter can be used to add stack traces to error outputs.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
handler +logger +showStackTrace +
+
+

Methods

+
canHandle +createErrorMessage +errorLogger +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly handler

+
handler: HttpHandler
+

The main HttpHandler

+
+
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly showStackTrace

+
showStackTrace: boolean
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Server<typeof IncomingMessage, typeof ServerResponse>
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Private createErrorMessage

+
    + +
  • +

    Creates a readable error message based on the error and the showStackTrace parameter.

    +
    +
    +

    Parameters

    +
      +
    • +
      error: unknown
    +

    Returns string

    +
+
+

Protected Readonly errorLogger

+
+
+

handle

+
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      server: Server<typeof IncomingMessage, typeof ServerResponse>
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving when handling is finished.

    + +
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Server<typeof IncomingMessage, typeof ServerResponse>
      +

      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.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/HashEncodingStorage.html b/7.x/docs/classes/HashEncodingStorage.html new file mode 100644 index 000000000..1fce426de --- /dev/null +++ b/7.x/docs/classes/HashEncodingStorage.html @@ -0,0 +1,282 @@ +HashEncodingStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class HashEncodingStorage<T>

+
+

Encodes the input key with SHA-256 hashing, +to make sure there are no invalid or special path characters.

+

This class was created specifically to prevent the issue of identifiers being too long when storing data: +https://github.com/CommunitySolidServer/CommunitySolidServer/issues/1013

+

This should eventually be replaced by a more structural approach once internal storage has been refactored +and data migration from older versions and formats is supported.

+
+
+
+

Type Parameters

+
    +
  • +

    T

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +source +
+
+

Methods

+
delete +entries +get +has +set +toNewKey +toOriginalKey +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Protected Readonly source

+
source: KeyValueStorage<string, T>
+
+

Methods

+
+

delete

+
+
+

entries

+
+
+

get

+
+
+

has

+
+
+

set

+
+
+

Protected toNewKey

+
+
+

Protected toOriginalKey

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/HashMap.html b/7.x/docs/classes/HashMap.html new file mode 100644 index 000000000..44c630f90 --- /dev/null +++ b/7.x/docs/classes/HashMap.html @@ -0,0 +1,346 @@ +HashMap | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class HashMap<TKey, TVal>

+
+

A Map implementation that maps the Key object to a string using the provided hash function. +This ensures that equal objects that are not the same instance are mapped to the same value.

+
+
+
+

Type Parameters

+
    +
  • +

    TKey = unknown

    • +
  • +

    TVal = unknown

+
+

Hierarchy

+
+
+

Implements

+
    +
  • Map<TKey, TVal>
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
[toStringTag] +hashFn +hashMap +
+
+

Accessors

+
size +
+
+

Methods

+
[iterator] +clear +delete +entries +forEach +get +has +keys +set +values +
+
+

Constructors

+
+

constructor

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      TKey = unknown

      • +
    • +

      TVal = unknown

    +
    +

    Parameters

    +
      +
    • +
      hashFn: ((key) => string)
      +
        +
      • +
          +
        • (key): string
          • +
        • +
          +

          Parameters

          +
            +
          • +
            key: TKey
          +

          Returns string

      • +
    • +
      Optional iterable: Iterable<readonly [TKey, TVal]>
    +

    Returns HashMap<TKey, TVal>

+
+

Properties

+
+

Readonly [toStringTag]

+
[toStringTag]: "HashMap" = 'HashMap'
+
+

Private Readonly hashFn

+
hashFn: ((key) => string)
+
+

Type declaration

+
    +
  • +
      +
    • (key): string
      • +
    • +
      +

      Parameters

      +
        +
      • +
        key: TKey
      +

      Returns string

+
+

Private Readonly hashMap

+
hashMap: Map<string, Entry<TKey, TVal>>
+
+

Accessors

+
+

size

+
+
+

Methods

+
+

[iterator]

+
    +
  • [iterator](): IterableIterator<[TKey, TVal]>
    • +
  • +

    Returns IterableIterator<[TKey, TVal]>

+
+

clear

+
+
+

delete

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      key: TKey
    +

    Returns boolean

+
+

entries

+
    + +
  • +

    Returns IterableIterator<[TKey, TVal]>

+
+

forEach

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      callbackfn: ((value, key, map) => void)
      +
        +
      • +
          +
        • (value, key, map): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            value: TVal
            • +
          • +
            key: TKey
            • +
          • +
            map: Map<TKey, TVal>
          +

          Returns void

      • +
    • +
      Optional thisArg: unknown
    +

    Returns void

+
+

get

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      key: TKey
    +

    Returns undefined | TVal

+
+

has

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      key: TKey
    +

    Returns boolean

+
+

keys

+
    + +
  • +

    Returns IterableIterator<TKey>

+
+

set

+
+
+

values

+
    + +
  • +

    Returns IterableIterator<TVal>

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/HeadOperationHandler.html b/7.x/docs/classes/HeadOperationHandler.html new file mode 100644 index 000000000..59f18fa7e --- /dev/null +++ b/7.x/docs/classes/HeadOperationHandler.html @@ -0,0 +1,200 @@ +HeadOperationHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class HeadOperationHandler

+
+

Handles HEAD Operations. +Calls the getRepresentation function from a ResourceStore.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
eTagHandler +store +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly eTagHandler

+
eTagHandler: ETagHandler
+
+

Private Readonly store

+
store: ResourceStore
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/HeaderHandler.html b/7.x/docs/classes/HeaderHandler.html new file mode 100644 index 000000000..4f9d8279f --- /dev/null +++ b/7.x/docs/classes/HeaderHandler.html @@ -0,0 +1,193 @@ +HeaderHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class HeaderHandler

+
+

Handler that sets custom headers on the response.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
headers +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly headers

+
headers: Record<string, string>
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/HtmlViewEntry.html b/7.x/docs/classes/HtmlViewEntry.html new file mode 100644 index 000000000..efc33ff2a --- /dev/null +++ b/7.x/docs/classes/HtmlViewEntry.html @@ -0,0 +1,121 @@ +HtmlViewEntry | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class HtmlViewEntry

+
+

Used to link file paths and URLs together. +The reason we use a separate object instead of a key/value Record, +is that this makes it easier to override the values in Components.js, +which can be useful if someone wants to replace the HTML for certain URLs.

+
+
+
+

Hierarchy

+
    +
  • HtmlViewEntry
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
filePath +route +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly filePath

+
filePath: string
+
+

Readonly route

+
route: InteractionRoute<never>
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/HtmlViewHandler.html b/7.x/docs/classes/HtmlViewHandler.html new file mode 100644 index 000000000..747192171 --- /dev/null +++ b/7.x/docs/classes/HtmlViewHandler.html @@ -0,0 +1,232 @@ +HtmlViewHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class HtmlViewHandler

+
+

Stores the HTML templates associated with specific InteractionRoutes.

+

This class will only handle GET operations for which there is a matching template, +if HTML is more preferred than JSON. +The reason for doing it like this instead of a standard content negotiation flow, +is because we only want to return the HTML pages on GET requests.

+

Templates will receive the parameter idpIndex in their context pointing to the root index URL of the IDP API +and an authenticating parameter indicating if this is an active OIDC interaction.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
idpIndex +templateEngine +templates +
+
+

Methods

+
canHandle +findTemplate +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly idpIndex

+
idpIndex: string
+
+

Private Readonly templateEngine

+
templateEngine: TemplateEngine<Dict<unknown>>
+
+

Private Readonly templates

+
templates: HtmlViewEntry[]
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Private findTemplate

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/HttpError.html b/7.x/docs/classes/HttpError.html new file mode 100644 index 000000000..9c8bfc1c4 --- /dev/null +++ b/7.x/docs/classes/HttpError.html @@ -0,0 +1,289 @@ +HttpError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class HttpError<T>

+
+

A class for all errors that could be thrown by Solid. +All errors inheriting from this should fix the status code thereby hiding the HTTP internals from other components.

+
+
+
+

Type Parameters

+
    +
  • +

    T extends number = number

+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
cause? +errorCode +message +metadata +name +stack? +statusCode +prepareStackTrace? +stackTraceLimit +
+
+

Methods

+
generateMetadata +captureStackTrace +isInstance +
+
+

Constructors

+
+

constructor

+
    + +
  • +

    Creates a new HTTP error. Subclasses should call this with their fixed status code.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends number = number

    +
    +

    Parameters

    +
      +
    • +
      statusCode: T
      +

      HTTP status code needed for the HTTP response.

      +
      +
      • +
    • +
      name: string
      +

      Error name. Useful for logging and stack tracing.

      +
      +
      • +
    • +
      Optional message: string
      +

      Error message.

      +
      +
      • +
    • +
      options: HttpErrorOptions = {}
      +

      Optional options.

      +
      +
    +

    Returns HttpError<T>

    +
+
+

Properties

+
+

Optional Readonly cause

+
cause?: unknown
+
+

Readonly errorCode

+
errorCode: string
+
+

message

+
message: string
+
+

Readonly metadata

+
metadata: RepresentationMetadata
+
+

name

+
name: string
+
+

Optional stack

+
stack?: string
+
+

Readonly statusCode

+
statusCode: T
+
+

Static Optional prepareStackTrace

+
prepareStackTrace?: ((err, stackTraces) => any)
+
+

Type declaration

+
+
+

Static stackTraceLimit

+
stackTraceLimit: number
+
+

Methods

+
+

Protected generateMetadata

+
+
+

Static captureStackTrace

+
    + +
  • +

    Create .stack property on a target object

    +
    +
    +

    Parameters

    +
      +
    • +
      targetObject: object
      • +
    • +
      Optional constructorOpt: Function
    +

    Returns void

    +
+
+

Static isInstance

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/HttpHandler.html b/7.x/docs/classes/HttpHandler.html new file mode 100644 index 000000000..8d4b7ed57 --- /dev/null +++ b/7.x/docs/classes/HttpHandler.html @@ -0,0 +1,180 @@ +HttpHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class HttpHandlerAbstract

+
+

An HTTP request handler.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/IdInteractionRoute.html b/7.x/docs/classes/IdInteractionRoute.html new file mode 100644 index 000000000..198d94c95 --- /dev/null +++ b/7.x/docs/classes/IdInteractionRoute.html @@ -0,0 +1,203 @@ +IdInteractionRoute | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class IdInteractionRoute<TBase, TId>

+
+

An InteractionRoute for routes that have a dynamic identifier in their path.

+
+
+
+

Type Parameters

+
    +
  • +

    TBase extends string

    • +
  • +

    TId extends string

+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
base +ensureSlash +idName +
+
+

Methods

+
getPath +matchPath +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly base

+
base: InteractionRoute<TBase>
+
+

Private Readonly ensureSlash

+
ensureSlash: boolean
+
+

Private Readonly idName

+
idName: TId
+
+

Methods

+
+

getPath

+
    + +
  • +

    Returns the path that is the result of having the specified values for the dynamic parameters.

    +

    Will throw an error in case the input parameters object is missing one of the expected keys.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional parameters: Record<TBase | TId, string>
      +

      Values for the dynamic parameters.

      +
      +
    +

    Returns string

    +
+
+

matchPath

+
    + +
  • +

    Checks if the provided path matches the route (pattern).

    +

    The result will be undefined if there is no match.

    +

    If there is a match the result object will have the corresponding values for all the parameters.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      The path to verify.

      +
      +
    +

    Returns undefined | Record<TBase | TId, string>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/IdentifierMap.html b/7.x/docs/classes/IdentifierMap.html new file mode 100644 index 000000000..1f3d56fa1 --- /dev/null +++ b/7.x/docs/classes/IdentifierMap.html @@ -0,0 +1,298 @@ +IdentifierMap | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class IdentifierMap<T>

+
+

A specific implementation of HashMap where the key type is ResourceIdentifier.

+
+
+
+

Type Parameters

+
    +
  • +

    T

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
[toStringTag] +
+
+

Accessors

+
size +
+
+

Methods

+
[iterator] +clear +delete +entries +forEach +get +has +keys +set +values +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly [toStringTag]

+
[toStringTag]: "HashMap" = 'HashMap'
+
+

Accessors

+
+

size

+
+
+

Methods

+
+

[iterator]

+
+
+

clear

+
+
+

delete

+
+
+

entries

+
+
+

forEach

+
+
+

get

+
+
+

has

+
+
+

keys

+
+
+

set

+
+
+

values

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/IdentifierSetMultiMap.html b/7.x/docs/classes/IdentifierSetMultiMap.html new file mode 100644 index 000000000..c586b65e1 --- /dev/null +++ b/7.x/docs/classes/IdentifierSetMultiMap.html @@ -0,0 +1,445 @@ +IdentifierSetMultiMap | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class IdentifierSetMultiMap<T>

+
+

A specific implementation of WrappedSetMultiMap where the key type is ResourceIdentifier.

+
+
+
+

Type Parameters

+
    +
  • +

    T

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
[toStringTag] +
+
+

Accessors

+
size +
+
+

Methods

+
[iterator] +add +asMap +clear +delete +deleteEntry +distinctKeys +entries +entrySets +forEach +get +has +hasEntry +keys +set +valueSets +values +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly [toStringTag]

+
[toStringTag]: "WrappedSetMultiMap" = 'WrappedSetMultiMap'
+
+

Accessors

+
+

size

+
+
+

Methods

+
+

[iterator]

+
+
+

add

+
+
+

asMap

+
+
+

clear

+
+
+

delete

+
+
+

deleteEntry

+
+
+

distinctKeys

+
+
+

entries

+
+
+

entrySets

+
+
+

forEach

+
+
+

get

+
+
+

has

+
+
+

hasEntry

+
+
+

keys

+
+
+

set

+
+
+

valueSets

+
+
+

values

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/IdentityProviderFactory.html b/7.x/docs/classes/IdentityProviderFactory.html new file mode 100644 index 000000000..aea57a0b1 --- /dev/null +++ b/7.x/docs/classes/IdentityProviderFactory.html @@ -0,0 +1,409 @@ +IdentityProviderFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class IdentityProviderFactory

+
+

Creates an OIDC Provider based on the provided configuration and parameters. +The provider will be cached and returned on subsequent calls. +Cookie and JWT keys will be stored in an internal storage, so they can be re-used over multiple threads. +Necessary claims for Solid OIDC interactions will be added. +Routes will be updated based on the baseUrl and oidcPath.

+
+
+
+

Hierarchy

+
    +
  • IdentityProviderFactory
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
adapterFactory +baseUrl +clientCredentialsStore +config +errorHandler +interactionRoute +jwkGenerator +logger +oidcPath +promptFactory +provider? +responseWriter +showStackTrace +storage +
+
+

Methods

+
captureErrorResponses +configureClaims +configureErrors +configureRoutes +createProvider +createRoute +generateCookieKeys +getProvider +initConfig +isAccessToken +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly adapterFactory

+
adapterFactory: AdapterFactory
+
+

Private Readonly baseUrl

+
baseUrl: string
+
+

Private Readonly clientCredentialsStore

+
clientCredentialsStore: ClientCredentialsStore
+
+

Private Readonly config

+
config: Configuration
+
+

Private Readonly errorHandler

+
errorHandler: ErrorHandler
+
+

Private Readonly interactionRoute

+
interactionRoute: InteractionRoute<never>
+
+

Private Readonly jwkGenerator

+
jwkGenerator: JwkGenerator
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly oidcPath

+
oidcPath: string
+
+

Private Readonly promptFactory

+
promptFactory: PromptFactory
+
+

Private Optional provider

+
provider?: default
+
+

Private Readonly responseWriter

+
responseWriter: ResponseWriter
+
+

Private Readonly showStackTrace

+
showStackTrace: boolean
+
+

Private Readonly storage

+
storage: KeyValueStorage<string, string[]>
+
+

Methods

+
+

Private captureErrorResponses

+
    + +
  • +

    In the configureErrors function below, we configure the renderError function of the provider configuration. +This function is called by the OIDC provider library to render errors, +but only does this if the accept header is HTML. +Otherwise, it just returns the error object itself as a JSON object. +See https://github.com/panva/node-oidc-provider/blob/0fcc112e0a95b3b2dae4eba6da812253277567c9/lib/shared/error_handler.js#L48-L52.

    +

    In this function we override the ctx.accepts function +to make the above code think HTML is always requested there. +This way we have full control over error representation as configured in configureErrors. +We still check the accept headers ourselves so there still is content negotiation on the output, +the client will not simply always receive HTML.

    +

    Should this part of the OIDC library code ever change, our function will break, +at which point behaviour will simply revert to what it was before.

    +
    +
    +

    Parameters

    +
      +
    • +
      provider: default
    +

    Returns void

    +
+
+

Private configureClaims

+
    + +
  • +

    Adds the necessary claims to the id and access tokens based on the Solid OIDC spec.

    +
    +
    +

    Parameters

    +
      +
    • +
      config: Configuration
      • +
    • +
      jwtAlg: AsymmetricSigningAlgorithm
    +

    Returns void

    +
+
+

Private configureErrors

+
+
+

Private configureRoutes

+
+
+

Private createProvider

+
+
+

Private createRoute

+
    + +
  • +

    Creates the route string as required by the oidc-provider library. +In case base URL is http://test.com/foo/, oidcPath is /idp and relative is device/auth, +this would result in /foo/idp/device/auth.

    +
    +
    +

    Parameters

    +
      +
    • +
      relative: string
    +

    Returns string

    +
+
+

Private generateCookieKeys

+
+
+

getProvider

+
+
+

Private initConfig

+
+
+

Private isAccessToken

+
    + +
  • +

    Checks whether the given token is an access token. +The AccessToken interface is not exported, so we have to access it like this.

    +
    +
    +

    Parameters

    +
      +
    • +
      token: unknown
    +

    Returns token is undefined | AccessToken

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/IdentityProviderHttpHandler.html b/7.x/docs/classes/IdentityProviderHttpHandler.html new file mode 100644 index 000000000..cdcd9a2bd --- /dev/null +++ b/7.x/docs/classes/IdentityProviderHttpHandler.html @@ -0,0 +1,213 @@ +IdentityProviderHttpHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class IdentityProviderHttpHandler

+
+

Generates the active Interaction object if there is an ongoing OIDC interaction. +Finds the account ID if there is cookie metadata.

+

Calls the stored InteractionHandler with that information and returns the result.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
cookieStore +handler +logger +providerFactory +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly cookieStore

+
cookieStore: CookieStore
+
+

Private Readonly handler

+
handler: InteractionHandler
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly providerFactory

+
providerFactory: ProviderFactory
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ImmutableMetadataPatcher.html b/7.x/docs/classes/ImmutableMetadataPatcher.html new file mode 100644 index 000000000..03df9915e --- /dev/null +++ b/7.x/docs/classes/ImmutableMetadataPatcher.html @@ -0,0 +1,218 @@ +ImmutableMetadataPatcher | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ImmutableMetadataPatcher

+
+

Guarantees that certain PATCH operations MUST NOT update certain triples in metadata resources. +Furthermore, this class also handles the patching for metadata resources. +List of triples that must not be updated are given during instantiation with the ImmutableTriple class. +When there is a change to an Immutable Triple, then a ConflictError will be thrown.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
immutablePatterns +logger +metadataStrategy +patcher +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly immutablePatterns

+
immutablePatterns: FilterPattern[]
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly metadataStrategy

+
metadataStrategy: AuxiliaryStrategy
+
+

Private Readonly patcher

+
patcher: RepresentationPatcher<RdfDatasetRepresentation>
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/InMemoryDataAccessor.html b/7.x/docs/classes/InMemoryDataAccessor.html new file mode 100644 index 000000000..45dccdb76 --- /dev/null +++ b/7.x/docs/classes/InMemoryDataAccessor.html @@ -0,0 +1,418 @@ +InMemoryDataAccessor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class InMemoryDataAccessor

+
+

A DataAccessor is the building block closest to the actual data storage. +It should not worry about most Solid logic, most of that will be handled before it is called. +There are a few things it still needs to do, and it is very important every implementation does this:

+
    +
  • If the input identifier ends with a slash, it should be assumed the identifier is targeting a container.
    • +
  • Similarly, if there is no trailing slash it should assume a document.
    • +
  • It should always throw a NotFoundHttpError if it does not have data matching the input identifier.
    • +
  • DataAccessors should not generate containment triples. This will be done externally using getChildren.
    • +
+
+
+
+

Hierarchy

+
    +
  • InMemoryDataAccessor
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
identifierStrategy +store +
+
+

Methods

+
canHandle +deleteResource +getChildren +getData +getEntry +getHierarchy +getMetadata +getParentEntry +isDataEntry +writeContainer +writeDocument +writeMetadata +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly identifierStrategy

+
identifierStrategy: IdentifierStrategy
+
+

Private Readonly store

+
store: {
    entries: Record<string, ContainerEntry>;
}
+
+

Type declaration

+
    +
  • +
    entries: Record<string, ContainerEntry>
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Should throw a NotImplementedHttpError if the DataAccessor does not support storing the given Representation.

    +
    +

    Returns Promise<void>

    +
    +

    Throws

    BadRequestHttpError +If it does not support the incoming data.

    +
+
+

deleteResource

+
+
+

getChildren

+
    + +
  • +

    Returns metadata for all resources in the requested container. +This should not be all metadata of those resources (but it can be), +but instead the main metadata you want to show in situations +where all these resources are presented simultaneously. +Generally this would be metadata that is present for all of these resources, +such as resource type or last modified date.

    +

    It can be safely assumed that the incoming identifier will always correspond to a container.

    +
    +
    +

    Parameters

    +
    +

    Returns AsyncIterableIterator<RepresentationMetadata>

    +
+
+

getData

+
+
+

Private getEntry

+
+
+

Private getHierarchy

+
+
+

getMetadata

+
+
+

Private getParentEntry

+
+
+

Private isDataEntry

+
+
+

writeContainer

+
+
+

writeDocument

+
+
+

writeMetadata

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/IndexRepresentationStore.html b/7.x/docs/classes/IndexRepresentationStore.html new file mode 100644 index 000000000..485594290 --- /dev/null +++ b/7.x/docs/classes/IndexRepresentationStore.html @@ -0,0 +1,355 @@ +IndexRepresentationStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class IndexRepresentationStore

+
+

Allow containers to have a custom representation. +The index representation will be returned when the following conditions are fulfilled:

+
    +
  • The request targets a container.
    • +
  • A resource with the given indexName exists in the container. (default: "index.html")
    • +
  • The highest weighted preference matches the mediaRange (default: "text/html") +Otherwise the request will be passed on to the source store. +In case the index representation should always be returned when it exists, +the mediaRange should be set to "*∕*".
    • +
+

Note: this functionality is not yet part of the specification. Relevant issues are:

+ +
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
indexName +mediaRange +source +
+
+

Methods

+
addResource +deleteResource +getRepresentation +hasResource +matchesPreferences +modifyResource +setRepresentation +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly indexName

+
indexName: string
+
+

Private Readonly mediaRange

+
mediaRange: string
+
+

Protected Readonly source

+
source: ResourceStore
+
+

Methods

+
+

addResource

+
+
+

deleteResource

+
+
+

getRepresentation

+
+
+

hasResource

+
+
+

Private matchesPreferences

+
+
+

modifyResource

+
+
+

setRepresentation

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/InitializableHandler.html b/7.x/docs/classes/InitializableHandler.html new file mode 100644 index 000000000..5bb4ff6ed --- /dev/null +++ b/7.x/docs/classes/InitializableHandler.html @@ -0,0 +1,182 @@ +InitializableHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class InitializableHandler

+
+

Allows using an Initializable as an Initializer Handler.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
initializable +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly initializable

+
initializable: Initializable
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      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.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/Initializer.html b/7.x/docs/classes/Initializer.html new file mode 100644 index 000000000..2e18c880d --- /dev/null +++ b/7.x/docs/classes/Initializer.html @@ -0,0 +1,188 @@ +Initializer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class InitializerAbstract

+
+

Initializer is used to indicate an AsyncHandler that performs initialization logic.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving when handling is finished.

    + +
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      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.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/InteractionHandler.html b/7.x/docs/classes/InteractionHandler.html new file mode 100644 index 000000000..24f8aef39 --- /dev/null +++ b/7.x/docs/classes/InteractionHandler.html @@ -0,0 +1,175 @@ +InteractionHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class InteractionHandlerAbstract

+
+

Handler used for IDP interactions.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/InteractionRouteHandler.html b/7.x/docs/classes/InteractionRouteHandler.html new file mode 100644 index 000000000..279e9eca8 --- /dev/null +++ b/7.x/docs/classes/InteractionRouteHandler.html @@ -0,0 +1,213 @@ +InteractionRouteHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class InteractionRouteHandler<T>

+
+

InteractionHandler that only accepts input of which the target matches the stored route.

+

Rejects operations that target a different route, +otherwise the input parameters are passed to the source handler.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
route +source +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly route

+
route: T
+
+

Protected Readonly source

+
source: JsonInteractionHandler<Dict<Json>>
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/IntermediateCreateExtractor.html b/7.x/docs/classes/IntermediateCreateExtractor.html new file mode 100644 index 000000000..1dcfd3b24 --- /dev/null +++ b/7.x/docs/classes/IntermediateCreateExtractor.html @@ -0,0 +1,224 @@ +IntermediateCreateExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class IntermediateCreateExtractor

+
+

Returns the required access modes from the source ModesExtractor. +In case create permissions are required, +verifies if any of the containers permissions also need to be created +and adds the corresponding identifier/mode combinations.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
resourceSet +source +strategy +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly resourceSet

+
resourceSet: ResourceSet
+
+

Private Readonly source

+
source: ModesExtractor
+
+

Private Readonly strategy

+
strategy: IdentifierStrategy
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/InternalServerError.html b/7.x/docs/classes/InternalServerError.html new file mode 100644 index 000000000..f7581ea5d --- /dev/null +++ b/7.x/docs/classes/InternalServerError.html @@ -0,0 +1,228 @@ +InternalServerError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class InternalServerError

+
+

A generic error message, given when an unexpected condition was encountered and no more specific message is suitable.

+
+
+
+

Hierarchy

+
    +
  • BaseHttpError +
      +
    • InternalServerError
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
cause? +errorCode +message +metadata +name +stack? +statusCode +isInstance +statusCode +uri +
+
+

Methods

+
generateMetadata +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Optional Readonly cause

+
cause?: unknown
+
+

Readonly errorCode

+
errorCode: string
+
+

message

+
message: string
+
+

Readonly metadata

+
metadata: RepresentationMetadata
+
+

name

+
name: string
+
+

Optional stack

+
stack?: string
+
+

Readonly statusCode

+
statusCode: 500
+
+

Static Readonly isInstance

+
isInstance: ((error) => error is HttpError<500>)
+
+

Type declaration

+
    +
  • +
      +
    • (error): error is HttpError<500>
      • +
    • +

      Checks whether the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: unknown
      +

      Returns error is HttpError<500>

      +
+
+

Static Readonly statusCode

+
statusCode: 500
+

The status code corresponding to this error class.

+
+
+
+

Static Readonly uri

+
uri: NamedNode<string>
+

A unique URI identifying this error class.

+
+
+
+

Methods

+
+

Protected generateMetadata

+
    + +
  • +

    Initializes the error metadata.

    +
    +

    Returns void

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/JsonConversionHandler.html b/7.x/docs/classes/JsonConversionHandler.html new file mode 100644 index 000000000..67966d24d --- /dev/null +++ b/7.x/docs/classes/JsonConversionHandler.html @@ -0,0 +1,204 @@ +JsonConversionHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class JsonConversionHandler

+
+

An InteractionHandler that sits in-between +an InteractionHandler and a JsonInteractionHandler. +It converts the input data stream into a JSON object to be used by the stored handler.

+

Since the JSON body is only made during the handle call, it can not be used during the canHandle, +so the canHandle call of the stored handler is not called, +meaning this class accepts all input that can be converted to JSON.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
converter +source +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly converter

+
converter: RepresentationConverter
+
+

Private Readonly source

+
source: JsonInteractionHandler<Dict<Json>>
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/JsonFileStorage.html b/7.x/docs/classes/JsonFileStorage.html new file mode 100644 index 000000000..240062518 --- /dev/null +++ b/7.x/docs/classes/JsonFileStorage.html @@ -0,0 +1,302 @@ +JsonFileStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class JsonFileStorage

+
+

Uses a JSON file to store key/value pairs.

+
+
+
+

Hierarchy

+
    +
  • JsonFileStorage
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
filePath +lockIdentifier +locker +
+
+

Methods

+
delete +entries +get +getJson +getJsonSafely +has +set +updateJsonSafely +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly filePath

+
filePath: string
+
+

Private Readonly lockIdentifier

+
lockIdentifier: ResourceIdentifier
+
+

Private Readonly locker

+
locker: ReadWriteLocker
+
+

Methods

+
+

delete

+
+
+

entries

+
+
+

get

+
+
+

Private getJson

+
+
+

Private getJsonSafely

+
+
+

has

+
+
+

set

+
+
+

Private updateJsonSafely

+
    + +
  • +

    Updates the data in the JSON file while using a write lock.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      updateFn: ((json) => T)
      +

      A function that updates the JSON object.

      +
      +
      +
        +
      • +
          +
        • (json): T
          • +
        • +
          +

          Parameters

          +
            +
          • +
            json: Dict<unknown>
          +

          Returns T

    +

    Returns Promise<T>

    The return value of updateFn.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/JsonInteractionHandler.html b/7.x/docs/classes/JsonInteractionHandler.html new file mode 100644 index 000000000..397237f65 --- /dev/null +++ b/7.x/docs/classes/JsonInteractionHandler.html @@ -0,0 +1,210 @@ +JsonInteractionHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class JsonInteractionHandler<TOut>Abstract

+
+

A handler that consumes and returns a JSON object, +designed to be used for IDP/OIDC interactions.

+
+
+
+

Type Parameters

+
    +
  • +

    TOut extends Dict<Json> = Dict<Json>

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/JsonLdNotificationSerializer.html b/7.x/docs/classes/JsonLdNotificationSerializer.html new file mode 100644 index 000000000..138808e4c --- /dev/null +++ b/7.x/docs/classes/JsonLdNotificationSerializer.html @@ -0,0 +1,171 @@ +JsonLdNotificationSerializer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class JsonLdNotificationSerializer

+
+

Serializes a Notification into a JSON-LD string.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/JsonResourceStorage.html b/7.x/docs/classes/JsonResourceStorage.html new file mode 100644 index 000000000..b93de0a6e --- /dev/null +++ b/7.x/docs/classes/JsonResourceStorage.html @@ -0,0 +1,332 @@ +JsonResourceStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class JsonResourceStorage<T>

+
+

A KeyValueStorage for JSON-like objects using a ResourceStore as backend.

+

Creates a base URL by joining the input base URL with the container string. +The storage assumes it has ownership over all entries in the target container +so no other classes should access resources there to prevent issues.

+

Assumes the input keys can be safely used to generate identifiers, +which will be appended to the stored base URL.

+

All non-404 errors will be re-thrown.

+
+
+
+

Type Parameters

+
    +
  • +

    T

+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
container +logger +source +
+
+

Methods

+
delete +entries +get +getResourceEntries +has +identifierToKey +keyToIdentifier +safelyGetResource +set +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly container

+
container: string
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Protected Readonly source

+
source: ResourceStore
+
+

Methods

+
+

delete

+
+
+

entries

+
+
+

get

+
+
+

Protected getResourceEntries

+
+
+

has

+
+
+

Protected identifierToKey

+
+
+

Protected keyToIdentifier

+
+
+

Protected safelyGetResource

+
+
+

set

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/KeyExtractor.html b/7.x/docs/classes/KeyExtractor.html new file mode 100644 index 000000000..d0a1bbdf0 --- /dev/null +++ b/7.x/docs/classes/KeyExtractor.html @@ -0,0 +1,200 @@ +KeyExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class KeyExtractor

+
+

A simple ShorthandExtractor that extracts a single value from the input map. +Returns the default value if it was defined in case no value was found in the map.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
defaultValue +key +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly defaultValue

+
defaultValue: unknown
+
+

Private Readonly key

+
key: string
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Shorthand
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Shorthand
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<unknown>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/KeyValueChannelStorage.html b/7.x/docs/classes/KeyValueChannelStorage.html new file mode 100644 index 000000000..c66492a45 --- /dev/null +++ b/7.x/docs/classes/KeyValueChannelStorage.html @@ -0,0 +1,299 @@ +KeyValueChannelStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class KeyValueChannelStorage

+
+

Stores all the NotificationChannel in a KeyValueStorage. +Encodes IDs/topics before storing them in the KeyValueStorage.

+

Uses a ReadWriteLocker to prevent internal race conditions.

+
+
+
+

Hierarchy

+
    +
  • KeyValueChannelStorage
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
locker +logger +storage +
+
+

Methods

+
add +delete +deleteChannel +get +getAll +getLockKey +isChannel +update +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly locker

+
locker: ReadWriteLocker
+
+

Protected logger

+
logger: Logger = ...
+
+

Private Readonly storage

+
storage: KeyValueStorage<string, StorageValue>
+
+

Methods

+
+

add

+
+
+

delete

+
+
+

Private deleteChannel

+
+
+

get

+
+
+

getAll

+
+
+

Private getLockKey

+
+
+

Private isChannel

+
+
+

update

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/LazyLoggerFactory.html b/7.x/docs/classes/LazyLoggerFactory.html new file mode 100644 index 000000000..3815e43f5 --- /dev/null +++ b/7.x/docs/classes/LazyLoggerFactory.html @@ -0,0 +1,173 @@ +LazyLoggerFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class LazyLoggerFactory

+
+

Wraps around another LoggerFactory that can be set lazily. +This is useful when objects are instantiated (and when they create loggers) +before the logging system has been fully instantiated, +as is the case when using a dependency injection framework such as Components.js.

+

Loggers can be created even before a LoggerFactory is set; +any log messages will be buffered and re-emitted.

+
+
+
+

Hierarchy

+
    +
  • LazyLoggerFactory
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
factory +
+
+

Accessors

+
loggerFactory +
+
+

Methods

+
createLogger +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private factory

+
factory: LoggerFactory
+
+

Accessors

+
+

loggerFactory

+
+
+

Methods

+
+

createLogger

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/LinkMetadataGenerator.html b/7.x/docs/classes/LinkMetadataGenerator.html new file mode 100644 index 000000000..12f0b2afd --- /dev/null +++ b/7.x/docs/classes/LinkMetadataGenerator.html @@ -0,0 +1,201 @@ +LinkMetadataGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class LinkMetadataGenerator

+
+

Adds a link to the auxiliary resource when called on the subject resource. +Specifically: will be added.

+

In case the input is metadata of an auxiliary resource no metadata will be added

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
identifierStrategy +link +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly identifierStrategy

+
identifierStrategy: AuxiliaryIdentifierStrategy
+
+

Private Readonly link

+
link: NamedNode<string>
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/LinkRelMetadataWriter.html b/7.x/docs/classes/LinkRelMetadataWriter.html new file mode 100644 index 000000000..e591b3c9c --- /dev/null +++ b/7.x/docs/classes/LinkRelMetadataWriter.html @@ -0,0 +1,203 @@ +LinkRelMetadataWriter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class LinkRelMetadataWriter

+
+

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.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
linkRelMap +logger +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly linkRelMap

+
linkRelMap: Map<NamedNode<string>, string>
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/LinkRelObject.html b/7.x/docs/classes/LinkRelObject.html new file mode 100644 index 000000000..3c014af5b --- /dev/null +++ b/7.x/docs/classes/LinkRelObject.html @@ -0,0 +1,195 @@ +LinkRelObject | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class LinkRelObject

+
+

Represents the values that are parsed as metadata

+
+
+
+

Hierarchy

+
    +
  • LinkRelObject
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
allowList +ephemeral +value +
+
+

Methods

+
addToMetadata +objectAllowed +
+
+

Constructors

+
+

constructor

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      value: string
      +

      The value corresponding to the rel value that will be used as predicate in the metadata.

      +
      +
      • +
    • +
      Optional ephemeral: boolean
      +

      (Optional) Indicates whether it will be stored by the server.

      +
      +
      • +
    • +
      Optional allowList: string[]
      +

      (Optional) Contains the objects that are allowed to be used with the given predicate.

      +
      +
    +

    Returns LinkRelObject

    +
+
+

Properties

+
+

Readonly allowList

+
allowList: undefined | string[]
+
+

Readonly ephemeral

+
ephemeral: boolean
+
+

Readonly value

+
value: NamedNode<string>
+
+

Methods

+
+

addToMetadata

+
+
+

Private objectAllowed

+
    + +
  • +

    Checks whether the object can be added to the metadata

    +
    +
    +

    Parameters

    +
      +
    • +
      object: string
      +

      The link target.

      +
      +
    +

    Returns boolean

    a boolean to indicate whether it can be added to the metadata or not

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/LinkRelParser.html b/7.x/docs/classes/LinkRelParser.html new file mode 100644 index 000000000..a3fc8f618 --- /dev/null +++ b/7.x/docs/classes/LinkRelParser.html @@ -0,0 +1,212 @@ +LinkRelParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class LinkRelParser

+
+

Parses Link headers with a specific rel value and adds them as metadata with the given predicate.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
linkRelMap +logger +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly linkRelMap

+
linkRelMap: Record<string, LinkRelObject>
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/LinkWebIdHandler.html b/7.x/docs/classes/LinkWebIdHandler.html new file mode 100644 index 000000000..3207d991b --- /dev/null +++ b/7.x/docs/classes/LinkWebIdHandler.html @@ -0,0 +1,253 @@ +LinkWebIdHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class LinkWebIdHandler

+
+

Handles the linking of WebIDs to account, +thereby registering them to the server IDP.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
baseUrl +logger +ownershipValidator +podStore +storageStrategy +webIdRoute +webIdStore +
+
+

Methods

+
canHandle +getView +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly baseUrl

+
baseUrl: string
+
+

Private Readonly logger

+
logger: Logger = ...
+
+

Private Readonly ownershipValidator

+
ownershipValidator: OwnershipValidator
+
+

Private Readonly podStore

+
podStore: PodStore
+
+

Private Readonly storageStrategy

+
storageStrategy: StorageLocationStrategy
+
+

Private Readonly webIdRoute

+
webIdRoute: WebIdLinkRoute
+
+

Private Readonly webIdStore

+
webIdStore: WebIdStore
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

getView

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ListeningActivityHandler.html b/7.x/docs/classes/ListeningActivityHandler.html new file mode 100644 index 000000000..24f1e1e1a --- /dev/null +++ b/7.x/docs/classes/ListeningActivityHandler.html @@ -0,0 +1,224 @@ +ListeningActivityHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ListeningActivityHandler

+
+

Listens to an ActivityEmitter and calls the stored NotificationHandlers in case of an event +for every matching notification channel found.

+

Takes the rate feature into account so only channels that want a new notification will receive one.

+

Extends StaticHandler so it can be more easily injected into a Components.js configuration. +No class takes this one as input, so to make sure Components.js instantiates it, +it needs to be added somewhere where its presence has no impact, such as the list of initializers.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
handler +logger +storage +
+
+

Methods

+
canHandle +emit +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly handler

+
handler: NotificationHandler
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly storage

+
storage: NotificationChannelStorage
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: unknown
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Private emit

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      topic: ResourceIdentifier
      • +
    • +
      activity: NamedNode<"https://www.w3.org/ns/activitystreams#Create"> | NamedNode<"https://www.w3.org/ns/activitystreams#object"> | NamedNode<"https://www.w3.org/ns/activitystreams#target"> | NamedNode<"https://www.w3.org/ns/activitystreams#Add"> | NamedNode<"https://www.w3.org/ns/activitystreams#Delete"> | NamedNode<"https://www.w3.org/ns/activitystreams#Remove"> | NamedNode<"https://www.w3.org/ns/activitystreams#Update">
      • +
    • +
      metadata: RepresentationMetadata
    +

    Returns Promise<void>

+
+

handle

+
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: unknown
      +

      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.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/LocationInteractionHandler.html b/7.x/docs/classes/LocationInteractionHandler.html new file mode 100644 index 000000000..45934b50b --- /dev/null +++ b/7.x/docs/classes/LocationInteractionHandler.html @@ -0,0 +1,210 @@ +LocationInteractionHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class LocationInteractionHandler

+
+

Transforms an HTTP redirect into a hypermedia document with a redirection link, +such that scripts running in a browser can redirect the user to the next page.

+

This handler addresses the situation where:

+
    +
  • the user visits a first page
    • +
  • this first page contains a script that performs interactions with a JSON API
    • +
  • as a result of a certain interaction, the user needs to be redirected to a second page
    • +
+

Regular HTTP redirects are performed via responses with 3xx status codes. +However, since the consumer of the API in this case is a browser script, +a 3xx response would only reach that script and not move the page for the user.

+

Therefore, this handler changes a 3xx response into a 200 response +with an explicit link to the next page, +enabling the script to move the user to the next page.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +source +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly logger

+
logger: Logger = ...
+
+

Private Readonly source

+
source: JsonInteractionHandler<Dict<Json>>
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/LockingInteractionHandler.html b/7.x/docs/classes/LockingInteractionHandler.html new file mode 100644 index 000000000..615300c5d --- /dev/null +++ b/7.x/docs/classes/LockingInteractionHandler.html @@ -0,0 +1,209 @@ +LockingInteractionHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class LockingInteractionHandler

+
+

An InteractionHandler that locks the path generated with the stored route during an operation. +If the route is the base account route, this can be used to prevent multiple operations on the same account.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
accountRoute +locker +source +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly accountRoute

+
accountRoute: AccountIdRoute
+
+

Private Readonly locker

+
locker: ReadWriteLocker
+
+

Private Readonly source

+
source: InteractionHandler
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/LockingResourceStore.html b/7.x/docs/classes/LockingResourceStore.html new file mode 100644 index 000000000..6fbfc6d52 --- /dev/null +++ b/7.x/docs/classes/LockingResourceStore.html @@ -0,0 +1,441 @@ +LockingResourceStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class LockingResourceStore

+
+

Store that for every call acquires a lock before executing it on the requested resource, +and releases it afterwards. +In case the request returns a Representation the lock will only be released when the data stream is finished.

+

For auxiliary resources the lock will be applied to the subject resource. +The actual operation is still executed on the auxiliary resource.

+
+
+
+

Hierarchy

+
    +
  • LockingResourceStore
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
auxiliaryStrategy +locks +logger +source +
+
+

Methods

+
addResource +createExpiringRepresentation +deleteResource +getLockIdentifier +getRepresentation +hasResource +lockedRepresentationRun +modifyResource +setRepresentation +waitForStreamToEnd +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly auxiliaryStrategy

+
auxiliaryStrategy: AuxiliaryIdentifierStrategy
+
+

Private Readonly locks

+
locks: ExpiringReadWriteLocker
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly source

+
source: ResourceStore
+
+

Methods

+
+

addResource

+
+
+

Protected createExpiringRepresentation

+
    + +
  • +

    Wraps a representation to make it reset the timeout timer every time data is read.

    +
    +
    +

    Parameters

    +
      +
    • +
      representation: Representation
      +

      The representation to wrap

      +
      +
      • +
    • +
      maintainLock: (() => void)
      +

      Function to call to reset the timer.

      +
      +
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns Representation

    +
+
+

deleteResource

+
+
+

Protected getLockIdentifier

+
+
+

getRepresentation

+
+
+

hasResource

+
+
+

Protected lockedRepresentationRun

+
    + +
  • +

    Acquires a lock that is only released when all data of the resulting representation data has been read, +an error occurs, or the timeout has been triggered. +The resulting data stream will be adapted to reset the timer every time data is read.

    +

    In case the data of the resulting stream is not needed it should be closed to prevent a timeout error.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Representation>

    +
+
+

modifyResource

+
+
+

setRepresentation

+
+
+

Protected waitForStreamToEnd

+
    + +
  • +

    Returns a promise that resolve when the source stream is finished, +either by ending or emitting an error. +In the case of an error the stream will be destroyed if it hasn't been already.

    +
    +
    +

    Parameters

    +
      +
    • +
      source: Readable
      +

      The input stream.

      +
      +
    +

    Returns Promise<void>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/LoggerInitializer.html b/7.x/docs/classes/LoggerInitializer.html new file mode 100644 index 000000000..bb11e4bd1 --- /dev/null +++ b/7.x/docs/classes/LoggerInitializer.html @@ -0,0 +1,182 @@ +LoggerInitializer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class LoggerInitializer

+
+

Sets up the global logger factory.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
loggerFactory +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly loggerFactory

+
loggerFactory: LoggerFactory
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      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.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/LogoutHandler.html b/7.x/docs/classes/LogoutHandler.html new file mode 100644 index 000000000..4c7252254 --- /dev/null +++ b/7.x/docs/classes/LogoutHandler.html @@ -0,0 +1,191 @@ +LogoutHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class LogoutHandler

+
+

Responsible for logging a user out. +In practice this means making sure the cookie is no longer valid.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
cookieStore +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly cookieStore

+
cookieStore: CookieStore
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/MappedMetadataWriter.html b/7.x/docs/classes/MappedMetadataWriter.html new file mode 100644 index 000000000..6152eec42 --- /dev/null +++ b/7.x/docs/classes/MappedMetadataWriter.html @@ -0,0 +1,196 @@ +MappedMetadataWriter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class MappedMetadataWriter

+
+

A MetadataWriter that takes a map directly converting metadata predicates to headers. +The header value(s) will be the same as the corresponding object value(s).

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
headerMap +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly headerMap

+
headerMap: Map<NamedNode<string>, string>
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/MarkdownToHtmlConverter.html b/7.x/docs/classes/MarkdownToHtmlConverter.html new file mode 100644 index 000000000..327b73b93 --- /dev/null +++ b/7.x/docs/classes/MarkdownToHtmlConverter.html @@ -0,0 +1,230 @@ +MarkdownToHtmlConverter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class MarkdownToHtmlConverter

+
+

Converts Markdown data to HTML. +The generated HTML will be injected into the given template using the parameter htmlBody. +A standard Markdown string will be converted to a

tag, so html and body tags should be part of the template. +In case the Markdown body starts with a header (#), that value will also be used as title parameter.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
inputTypes +outputTypes +templateEngine +
+
+

Methods

+
canHandle +getOutputTypes +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected inputTypes

+
inputTypes: Promise<ValuePreferences>
+
+

Protected outputTypes

+
outputTypes: Promise<ValuePreferences>
+
+

Private Readonly templateEngine

+
templateEngine: TemplateEngine<Dict<unknown>>
+
+

Methods

+
+

canHandle

+
+
+

getOutputTypes

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/MaxKeyLengthStorage.html b/7.x/docs/classes/MaxKeyLengthStorage.html new file mode 100644 index 000000000..33cbd5a55 --- /dev/null +++ b/7.x/docs/classes/MaxKeyLengthStorage.html @@ -0,0 +1,319 @@ +MaxKeyLengthStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class MaxKeyLengthStorage<T>

+
+

A KeyValueStorage that hashes keys in case they would be longer than the set limit. +Hashed keys are prefixed with a certain value to prevent issues with incoming keys that are already hashed. +The default max length is 150 and the default prefix is $hash$.

+

This class mostly exists to prevent issues when writing storage entries to disk. +Keys that are too long would cause issues with the file name limit. +For this reason, only the part after the last / in a key is hashed, to preserve the expected file structure.

+
+
+
+

Type Parameters

+
    +
  • +

    T

+
+

Hierarchy

+
    +
  • MaxKeyLengthStorage
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
hashPrefix +logger +maxKeyLength +source +
+
+

Methods

+
delete +entries +get +getKey +getKeyWithCheck +has +set +wrapPayload +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly hashPrefix

+
hashPrefix: string
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Protected Readonly maxKeyLength

+
maxKeyLength: number
+
+

Protected Readonly source

+
source: KeyValueStorage<string, Entry<T>>
+
+

Methods

+
+

delete

+
+
+

entries

+
+
+

get

+
+
+

Protected getKey

+
    + +
  • +

    Hashes the last part of the key if it is too long. +Otherwise, just returns the key.

    +
    +
    +

    Parameters

    +
      +
    • +
      key: string
      • +
    • +
      Optional parts: string[]
    +

    Returns string

    +
+
+

Protected getKeyWithCheck

+
    + +
  • +

    Similar to getKey but checks to make sure the key does not already contain the prefix. +Only necessary for set calls.

    +
    +
    +

    Parameters

    +
      +
    • +
      key: string
    +

    Returns string

    +
+
+

has

+
+
+

set

+
+
+

Protected wrapPayload

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/MemoryMapStorage.html b/7.x/docs/classes/MemoryMapStorage.html new file mode 100644 index 000000000..28a2247b8 --- /dev/null +++ b/7.x/docs/classes/MemoryMapStorage.html @@ -0,0 +1,227 @@ +MemoryMapStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class MemoryMapStorage<TValue>

+
+

A KeyValueStorage which uses a JavaScript Map for internal storage.

+
+
+
+

Type Parameters

+
    +
  • +

    TValue

+
+

Hierarchy

+
    +
  • MemoryMapStorage
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
data +
+
+

Methods

+
delete +entries +get +has +set +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly data

+
data: Map<string, TValue>
+
+

Methods

+
+

delete

+
+
+

entries

+
+
+

get

+
+
+

has

+
+
+

set

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/MemoryResourceLocker.html b/7.x/docs/classes/MemoryResourceLocker.html new file mode 100644 index 000000000..304678d0c --- /dev/null +++ b/7.x/docs/classes/MemoryResourceLocker.html @@ -0,0 +1,199 @@ +MemoryResourceLocker | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class MemoryResourceLocker

+
+

A resource locker making use of the async-lock library. +Note that all locks are kept in memory until they are unlocked which could potentially result +in a memory leak if locks are never unlocked, so make sure this is covered with expiring locks for example, +and/or proper finally handles.

+
+
+
+

Hierarchy

+
    +
  • MemoryResourceLocker
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
locker +logger +unlockCallbacks +
+
+

Methods

+
acquire +getLockCount +release +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly locker

+
locker: AsyncLock
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly unlockCallbacks

+
unlockCallbacks: Record<string, (() => void)>
+
+

Type declaration

+
    +
  • +
      +
    • (): void
      • +
    • +

      Returns void

+
+

Methods

+
+

acquire

+
+
+

Private getLockCount

+
+
+

release

+
    + +
  • +

    Releases a lock on the requested identifier. +The promise will resolve when the lock has been released. +If there is no lock on the resource, an error should be thrown.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/MetadataGenerator.html b/7.x/docs/classes/MetadataGenerator.html new file mode 100644 index 000000000..7c6e5bafe --- /dev/null +++ b/7.x/docs/classes/MetadataGenerator.html @@ -0,0 +1,173 @@ +MetadataGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class MetadataGeneratorAbstract

+
+

Generic interface for classes that add metadata to a RepresentationMetadata.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/MetadataParser.html b/7.x/docs/classes/MetadataParser.html new file mode 100644 index 000000000..561dd3ddd --- /dev/null +++ b/7.x/docs/classes/MetadataParser.html @@ -0,0 +1,195 @@ +MetadataParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class MetadataParserAbstract

+
+

A parser that takes a specific part of an HttpRequest and converts it into metadata, +such as the value of a header entry.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/MetadataWriter.html b/7.x/docs/classes/MetadataWriter.html new file mode 100644 index 000000000..4d7f93982 --- /dev/null +++ b/7.x/docs/classes/MetadataWriter.html @@ -0,0 +1,186 @@ +MetadataWriter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class MetadataWriterAbstract

+
+

A serializer that converts metadata to headers for an HttpResponse.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/MethodFilterHandler.html b/7.x/docs/classes/MethodFilterHandler.html new file mode 100644 index 000000000..ac073916f --- /dev/null +++ b/7.x/docs/classes/MethodFilterHandler.html @@ -0,0 +1,233 @@ +MethodFilterHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class MethodFilterHandler<TIn, TOut>

+
+

Only accepts requests where the input has a (possibly nested) method field +that matches any one of the given methods. +In case of a match, the input will be sent to the source handler.

+
+
+
+

Type Parameters

+
    +
  • +

    TIn extends InType

    • +
  • +

    TOut

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
methods +source +
+
+

Methods

+
canHandle +findMethod +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly methods

+
methods: string[]
+
+

Private Readonly source

+
source: AsyncHandler<TIn, TOut>
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Private findMethod

+
+
+

handle

+
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<TOut>

    A promise resolving when handling is finished.

    + +
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<TOut>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/MethodModesExtractor.html b/7.x/docs/classes/MethodModesExtractor.html new file mode 100644 index 000000000..cdd00fa56 --- /dev/null +++ b/7.x/docs/classes/MethodModesExtractor.html @@ -0,0 +1,198 @@ +MethodModesExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class MethodModesExtractor

+
+

Generates permissions for the base set of methods that always require the same permissions. +Specifically: GET, HEAD, POST, PUT and DELETE.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
resourceSet +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly resourceSet

+
resourceSet: ResourceSet
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      __namedParameters: Operation
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/MethodNotAllowedHttpError.html b/7.x/docs/classes/MethodNotAllowedHttpError.html new file mode 100644 index 000000000..dc833d5d3 --- /dev/null +++ b/7.x/docs/classes/MethodNotAllowedHttpError.html @@ -0,0 +1,238 @@ +MethodNotAllowedHttpError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class MethodNotAllowedHttpError

+
+

An error thrown when data was found for the requested identifier, but is not supported by the target resource. +Can keep track of the methods that are not allowed.

+
+
+
+

Hierarchy

+
    +
  • BaseHttpError +
      +
    • MethodNotAllowedHttpError
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
cause? +errorCode +message +metadata +methods +name +stack? +statusCode +isInstance +statusCode +uri +
+
+

Methods

+
generateMetadata +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Optional Readonly cause

+
cause?: unknown
+
+

Readonly errorCode

+
errorCode: string
+
+

message

+
message: string
+
+

Readonly metadata

+
metadata: RepresentationMetadata
+
+

Readonly methods

+
methods: readonly string[]
+
+

name

+
name: string
+
+

Optional stack

+
stack?: string
+
+

Readonly statusCode

+
statusCode: 405
+
+

Static Readonly isInstance

+
isInstance: ((error) => error is HttpError<405>)
+
+

Type declaration

+
    +
  • +
      +
    • (error): error is HttpError<405>
      • +
    • +

      Checks whether the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: unknown
      +

      Returns error is HttpError<405>

      +
+
+

Static Readonly statusCode

+
statusCode: 405
+

The status code corresponding to this error class.

+
+
+
+

Static Readonly uri

+
uri: NamedNode<string>
+

A unique URI identifying this error class.

+
+
+
+

Methods

+
+

Protected generateMetadata

+
    + +
  • +

    Initializes the error metadata.

    +
    +

    Returns void

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ModesExtractor.html b/7.x/docs/classes/ModesExtractor.html new file mode 100644 index 000000000..173719373 --- /dev/null +++ b/7.x/docs/classes/ModesExtractor.html @@ -0,0 +1,178 @@ +ModesExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ModesExtractorAbstract

+
+

Extracts all AccessModes that are necessary to execute the given Operation.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Operation
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ModifiedMetadataWriter.html b/7.x/docs/classes/ModifiedMetadataWriter.html new file mode 100644 index 000000000..3b85a6d8c --- /dev/null +++ b/7.x/docs/classes/ModifiedMetadataWriter.html @@ -0,0 +1,176 @@ +ModifiedMetadataWriter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ModifiedMetadataWriter

+
+

A MetadataWriter that generates all the necessary headers related to the modification date of a resource.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ModuleVersionVerifier.html b/7.x/docs/classes/ModuleVersionVerifier.html new file mode 100644 index 000000000..8d94140da --- /dev/null +++ b/7.x/docs/classes/ModuleVersionVerifier.html @@ -0,0 +1,193 @@ +ModuleVersionVerifier | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ModuleVersionVerifier

+
+

This initializer simply writes the version number of the server to the storage. +This will be relevant in the future when we look into migration initializers.

+

It automatically parses the version number from the package.json.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
storage +storageKey +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly storage

+
storage: KeyValueStorage<string, string>
+
+

Private Readonly storageKey

+
storageKey: string
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      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.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/MonitoringStore.html b/7.x/docs/classes/MonitoringStore.html new file mode 100644 index 000000000..d508024c6 --- /dev/null +++ b/7.x/docs/classes/MonitoringStore.html @@ -0,0 +1,1082 @@ +MonitoringStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class MonitoringStore<T>

+
+

Store that notifies listeners of changes to its source +by emitting a changed event.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
addListener +emit +eventNames +listenerCount +listeners +off +on +once +prependListener +prependOnceListener +rawListeners +removeAllListeners +removeListener +source +
+
+

Methods

+
[captureRejectionSymbol]? +addResource +deleteResource +emitChanged +getMaxListeners +getRepresentation +hasResource +isKnownActivity +modifyResource +setMaxListeners +setRepresentation +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

addListener

+
addListener: ((event, listener) => MonitoringStore<T>) & ((event, listener) => MonitoringStore<T>)
+
+

Type declaration

+
    +
  • +
      +
    • (event, listener): MonitoringStore<T>
      • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "changed"
        • +
      • +
        listener: ((target, activity, metadata) => void)
        +
          +
        • +
            +
          • (target, activity, metadata): void
            • +
          • +
            +

            Parameters

            +
              +
            • +
              target: ResourceIdentifier
              • +
            • +
              activity: NamedNode<"https://www.w3.org/ns/activitystreams#Create"> | NamedNode<"https://www.w3.org/ns/activitystreams#object"> | NamedNode<"https://www.w3.org/ns/activitystreams#target"> | NamedNode<"https://www.w3.org/ns/activitystreams#Add"> | NamedNode<"https://www.w3.org/ns/activitystreams#Delete"> | NamedNode<"https://www.w3.org/ns/activitystreams#Remove"> | NamedNode<"https://www.w3.org/ns/activitystreams#Update">
              • +
            • +
              metadata: RepresentationMetadata
            +

            Returns void

      +

      Returns MonitoringStore<T>

+
+

Type declaration

+
    +
  • +
      +
    • (event, listener): MonitoringStore<T>
      • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#target" | "https://www.w3.org/ns/activitystreams#Add" | "https://www.w3.org/ns/activitystreams#Create" | "https://www.w3.org/ns/activitystreams#Delete" | "https://www.w3.org/ns/activitystreams#Remove" | "https://www.w3.org/ns/activitystreams#Update"
        • +
      • +
        listener: ((target, metadata) => void)
        +
      +

      Returns MonitoringStore<T>

+
+

emit

+
emit: ((event, ...args) => boolean) & ((event, ...args) => boolean)
+
+

Type declaration

+
    +
  • +
      +
    • (event, ...args): boolean
      • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "changed"
        • +
      • +
        Rest ...args: [target: ResourceIdentifier, activity: NamedNode<"https://www.w3.org/ns/activitystreams#Create"> | NamedNode<"https://www.w3.org/ns/activitystreams#object"> | NamedNode<"https://www.w3.org/ns/activitystreams#target"> | NamedNode<"https://www.w3.org/ns/activitystreams#Add"> | NamedNode<"https://www.w3.org/ns/activitystreams#Delete"> | NamedNode<"https://www.w3.org/ns/activitystreams#Remove"> | NamedNode<"https://www.w3.org/ns/activitystreams#Update">, metadata: RepresentationMetadata]
      +

      Returns boolean

+
+

Type declaration

+
    +
  • +
      +
    • (event, ...args): boolean
      • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#target" | "https://www.w3.org/ns/activitystreams#Add" | "https://www.w3.org/ns/activitystreams#Create" | "https://www.w3.org/ns/activitystreams#Delete" | "https://www.w3.org/ns/activitystreams#Remove" | "https://www.w3.org/ns/activitystreams#Update"
        • +
      • +
        Rest ...args: [target: ResourceIdentifier, metadata: RepresentationMetadata]
      +

      Returns boolean

+
+

eventNames

+
eventNames: (() => "changed"[]) & (() => ("https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#target" | "https://www.w3.org/ns/activitystreams#Add" | "https://www.w3.org/ns/activitystreams#Create" | "https://www.w3.org/ns/activitystreams#Delete" | "https://www.w3.org/ns/activitystreams#Remove" | "https://www.w3.org/ns/activitystreams#Update")[])
+
+

Type declaration

+
    +
  • +
      +
    • (): "changed"[]
      • +
    • +

      Returns "changed"[]

+
+

Type declaration

+
    +
  • +
      +
    • (): ("https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#target" | "https://www.w3.org/ns/activitystreams#Add" | "https://www.w3.org/ns/activitystreams#Create" | "https://www.w3.org/ns/activitystreams#Delete" | "https://www.w3.org/ns/activitystreams#Remove" | "https://www.w3.org/ns/activitystreams#Update")[]
      • +
    • +

      Returns ("https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#target" | "https://www.w3.org/ns/activitystreams#Add" | "https://www.w3.org/ns/activitystreams#Create" | "https://www.w3.org/ns/activitystreams#Delete" | "https://www.w3.org/ns/activitystreams#Remove" | "https://www.w3.org/ns/activitystreams#Update")[]

+
+

listenerCount

+
listenerCount: ((event) => number) & ((event) => number)
+
+

Type declaration

+
    +
  • +
      +
    • (event): number
      • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "changed"
      +

      Returns number

+
+

Type declaration

+
    +
  • +
      +
    • (event): number
      • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#target" | "https://www.w3.org/ns/activitystreams#Add" | "https://www.w3.org/ns/activitystreams#Create" | "https://www.w3.org/ns/activitystreams#Delete" | "https://www.w3.org/ns/activitystreams#Remove" | "https://www.w3.org/ns/activitystreams#Update"
      +

      Returns number

+
+

listeners

+
listeners: ((event) => ((target, activity, metadata) => void)[]) & ((event) => ((target, metadata) => void)[])
+
+

Type declaration

+
    +
  • +
      +
    • (event): ((target, activity, metadata) => void)[]
      • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "changed"
      +

      Returns ((target, activity, metadata) => void)[]

+
+

Type declaration

+
    +
  • +
      +
    • (event): ((target, metadata) => void)[]
      • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#target" | "https://www.w3.org/ns/activitystreams#Add" | "https://www.w3.org/ns/activitystreams#Create" | "https://www.w3.org/ns/activitystreams#Delete" | "https://www.w3.org/ns/activitystreams#Remove" | "https://www.w3.org/ns/activitystreams#Update"
      +

      Returns ((target, metadata) => void)[]

+
+

off

+
off: ((event, listener) => MonitoringStore<T>) & ((event, listener) => MonitoringStore<T>)
+
+

Type declaration

+
    +
  • +
      +
    • (event, listener): MonitoringStore<T>
      • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "changed"
        • +
      • +
        listener: ((target, activity, metadata) => void)
        +
          +
        • +
            +
          • (target, activity, metadata): void
            • +
          • +
            +

            Parameters

            +
              +
            • +
              target: ResourceIdentifier
              • +
            • +
              activity: NamedNode<"https://www.w3.org/ns/activitystreams#Create"> | NamedNode<"https://www.w3.org/ns/activitystreams#object"> | NamedNode<"https://www.w3.org/ns/activitystreams#target"> | NamedNode<"https://www.w3.org/ns/activitystreams#Add"> | NamedNode<"https://www.w3.org/ns/activitystreams#Delete"> | NamedNode<"https://www.w3.org/ns/activitystreams#Remove"> | NamedNode<"https://www.w3.org/ns/activitystreams#Update">
              • +
            • +
              metadata: RepresentationMetadata
            +

            Returns void

      +

      Returns MonitoringStore<T>

+
+

Type declaration

+
    +
  • +
      +
    • (event, listener): MonitoringStore<T>
      • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#target" | "https://www.w3.org/ns/activitystreams#Add" | "https://www.w3.org/ns/activitystreams#Create" | "https://www.w3.org/ns/activitystreams#Delete" | "https://www.w3.org/ns/activitystreams#Remove" | "https://www.w3.org/ns/activitystreams#Update"
        • +
      • +
        listener: ((target, metadata) => void)
        +
      +

      Returns MonitoringStore<T>

+
+

on

+
on: ((event, listener) => MonitoringStore<T>) & ((event, listener) => MonitoringStore<T>)
+
+

Type declaration

+
    +
  • +
      +
    • (event, listener): MonitoringStore<T>
      • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "changed"
        • +
      • +
        listener: ((target, activity, metadata) => void)
        +
          +
        • +
            +
          • (target, activity, metadata): void
            • +
          • +
            +

            Parameters

            +
              +
            • +
              target: ResourceIdentifier
              • +
            • +
              activity: NamedNode<"https://www.w3.org/ns/activitystreams#Create"> | NamedNode<"https://www.w3.org/ns/activitystreams#object"> | NamedNode<"https://www.w3.org/ns/activitystreams#target"> | NamedNode<"https://www.w3.org/ns/activitystreams#Add"> | NamedNode<"https://www.w3.org/ns/activitystreams#Delete"> | NamedNode<"https://www.w3.org/ns/activitystreams#Remove"> | NamedNode<"https://www.w3.org/ns/activitystreams#Update">
              • +
            • +
              metadata: RepresentationMetadata
            +

            Returns void

      +

      Returns MonitoringStore<T>

+
+

Type declaration

+
    +
  • +
      +
    • (event, listener): MonitoringStore<T>
      • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#target" | "https://www.w3.org/ns/activitystreams#Add" | "https://www.w3.org/ns/activitystreams#Create" | "https://www.w3.org/ns/activitystreams#Delete" | "https://www.w3.org/ns/activitystreams#Remove" | "https://www.w3.org/ns/activitystreams#Update"
        • +
      • +
        listener: ((target, metadata) => void)
        +
      +

      Returns MonitoringStore<T>

+
+

once

+
once: ((event, listener) => MonitoringStore<T>) & ((event, listener) => MonitoringStore<T>)
+
+

Type declaration

+
    +
  • +
      +
    • (event, listener): MonitoringStore<T>
      • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "changed"
        • +
      • +
        listener: ((target, activity, metadata) => void)
        +
          +
        • +
            +
          • (target, activity, metadata): void
            • +
          • +
            +

            Parameters

            +
              +
            • +
              target: ResourceIdentifier
              • +
            • +
              activity: NamedNode<"https://www.w3.org/ns/activitystreams#Create"> | NamedNode<"https://www.w3.org/ns/activitystreams#object"> | NamedNode<"https://www.w3.org/ns/activitystreams#target"> | NamedNode<"https://www.w3.org/ns/activitystreams#Add"> | NamedNode<"https://www.w3.org/ns/activitystreams#Delete"> | NamedNode<"https://www.w3.org/ns/activitystreams#Remove"> | NamedNode<"https://www.w3.org/ns/activitystreams#Update">
              • +
            • +
              metadata: RepresentationMetadata
            +

            Returns void

      +

      Returns MonitoringStore<T>

+
+

Type declaration

+
    +
  • +
      +
    • (event, listener): MonitoringStore<T>
      • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#target" | "https://www.w3.org/ns/activitystreams#Add" | "https://www.w3.org/ns/activitystreams#Create" | "https://www.w3.org/ns/activitystreams#Delete" | "https://www.w3.org/ns/activitystreams#Remove" | "https://www.w3.org/ns/activitystreams#Update"
        • +
      • +
        listener: ((target, metadata) => void)
        +
      +

      Returns MonitoringStore<T>

+
+

prependListener

+
prependListener: ((event, listener) => MonitoringStore<T>) & ((event, listener) => MonitoringStore<T>)
+
+

Type declaration

+
    +
  • +
      +
    • (event, listener): MonitoringStore<T>
      • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "changed"
        • +
      • +
        listener: ((target, activity, metadata) => void)
        +
          +
        • +
            +
          • (target, activity, metadata): void
            • +
          • +
            +

            Parameters

            +
              +
            • +
              target: ResourceIdentifier
              • +
            • +
              activity: NamedNode<"https://www.w3.org/ns/activitystreams#Create"> | NamedNode<"https://www.w3.org/ns/activitystreams#object"> | NamedNode<"https://www.w3.org/ns/activitystreams#target"> | NamedNode<"https://www.w3.org/ns/activitystreams#Add"> | NamedNode<"https://www.w3.org/ns/activitystreams#Delete"> | NamedNode<"https://www.w3.org/ns/activitystreams#Remove"> | NamedNode<"https://www.w3.org/ns/activitystreams#Update">
              • +
            • +
              metadata: RepresentationMetadata
            +

            Returns void

      +

      Returns MonitoringStore<T>

+
+

Type declaration

+
    +
  • +
      +
    • (event, listener): MonitoringStore<T>
      • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#target" | "https://www.w3.org/ns/activitystreams#Add" | "https://www.w3.org/ns/activitystreams#Create" | "https://www.w3.org/ns/activitystreams#Delete" | "https://www.w3.org/ns/activitystreams#Remove" | "https://www.w3.org/ns/activitystreams#Update"
        • +
      • +
        listener: ((target, metadata) => void)
        +
      +

      Returns MonitoringStore<T>

+
+

prependOnceListener

+
prependOnceListener: ((event, listener) => MonitoringStore<T>) & ((event, listener) => MonitoringStore<T>)
+
+

Type declaration

+
    +
  • +
      +
    • (event, listener): MonitoringStore<T>
      • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "changed"
        • +
      • +
        listener: ((target, activity, metadata) => void)
        +
          +
        • +
            +
          • (target, activity, metadata): void
            • +
          • +
            +

            Parameters

            +
              +
            • +
              target: ResourceIdentifier
              • +
            • +
              activity: NamedNode<"https://www.w3.org/ns/activitystreams#Create"> | NamedNode<"https://www.w3.org/ns/activitystreams#object"> | NamedNode<"https://www.w3.org/ns/activitystreams#target"> | NamedNode<"https://www.w3.org/ns/activitystreams#Add"> | NamedNode<"https://www.w3.org/ns/activitystreams#Delete"> | NamedNode<"https://www.w3.org/ns/activitystreams#Remove"> | NamedNode<"https://www.w3.org/ns/activitystreams#Update">
              • +
            • +
              metadata: RepresentationMetadata
            +

            Returns void

      +

      Returns MonitoringStore<T>

+
+

Type declaration

+
    +
  • +
      +
    • (event, listener): MonitoringStore<T>
      • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#target" | "https://www.w3.org/ns/activitystreams#Add" | "https://www.w3.org/ns/activitystreams#Create" | "https://www.w3.org/ns/activitystreams#Delete" | "https://www.w3.org/ns/activitystreams#Remove" | "https://www.w3.org/ns/activitystreams#Update"
        • +
      • +
        listener: ((target, metadata) => void)
        +
      +

      Returns MonitoringStore<T>

+
+

rawListeners

+
rawListeners: ((event) => ((target, activity, metadata) => void)[]) & ((event) => ((target, metadata) => void)[])
+
+

Type declaration

+
    +
  • +
      +
    • (event): ((target, activity, metadata) => void)[]
      • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "changed"
      +

      Returns ((target, activity, metadata) => void)[]

+
+

Type declaration

+
    +
  • +
      +
    • (event): ((target, metadata) => void)[]
      • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#target" | "https://www.w3.org/ns/activitystreams#Add" | "https://www.w3.org/ns/activitystreams#Create" | "https://www.w3.org/ns/activitystreams#Delete" | "https://www.w3.org/ns/activitystreams#Remove" | "https://www.w3.org/ns/activitystreams#Update"
      +

      Returns ((target, metadata) => void)[]

+
+

removeAllListeners

+
removeAllListeners: ((event) => MonitoringStore<T>) & ((event) => MonitoringStore<T>)
+
+

Type declaration

+
+
+

Type declaration

+
    +
  • +
      +
    • (event): MonitoringStore<T>
      • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#target" | "https://www.w3.org/ns/activitystreams#Add" | "https://www.w3.org/ns/activitystreams#Create" | "https://www.w3.org/ns/activitystreams#Delete" | "https://www.w3.org/ns/activitystreams#Remove" | "https://www.w3.org/ns/activitystreams#Update"
      +

      Returns MonitoringStore<T>

+
+

removeListener

+
removeListener: ((event, listener) => MonitoringStore<T>) & ((event, listener) => MonitoringStore<T>)
+
+

Type declaration

+
    +
  • +
      +
    • (event, listener): MonitoringStore<T>
      • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "changed"
        • +
      • +
        listener: ((target, activity, metadata) => void)
        +
          +
        • +
            +
          • (target, activity, metadata): void
            • +
          • +
            +

            Parameters

            +
              +
            • +
              target: ResourceIdentifier
              • +
            • +
              activity: NamedNode<"https://www.w3.org/ns/activitystreams#Create"> | NamedNode<"https://www.w3.org/ns/activitystreams#object"> | NamedNode<"https://www.w3.org/ns/activitystreams#target"> | NamedNode<"https://www.w3.org/ns/activitystreams#Add"> | NamedNode<"https://www.w3.org/ns/activitystreams#Delete"> | NamedNode<"https://www.w3.org/ns/activitystreams#Remove"> | NamedNode<"https://www.w3.org/ns/activitystreams#Update">
              • +
            • +
              metadata: RepresentationMetadata
            +

            Returns void

      +

      Returns MonitoringStore<T>

+
+

Type declaration

+
    +
  • +
      +
    • (event, listener): MonitoringStore<T>
      • +
    • +
      +

      Parameters

      +
        +
      • +
        event: "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#target" | "https://www.w3.org/ns/activitystreams#Add" | "https://www.w3.org/ns/activitystreams#Create" | "https://www.w3.org/ns/activitystreams#Delete" | "https://www.w3.org/ns/activitystreams#Remove" | "https://www.w3.org/ns/activitystreams#Update"
        • +
      • +
        listener: ((target, metadata) => void)
        +
      +

      Returns MonitoringStore<T>

+
+

Private Readonly source

+
source: T
+
+

Methods

+
+

Optional [captureRejectionSymbol]

+
    +
  • [captureRejectionSymbol](error, event, ...args): void
    • +
  • +
    +

    Parameters

    +
      +
    • +
      error: Error
      • +
    • +
      event: string
      • +
    • +
      Rest ...args: any[]
    +

    Returns void

+
+

addResource

+
+
+

deleteResource

+
+
+

Private emitChanged

+
+
+

getMaxListeners

+
    + +
  • +

    Returns the current max listener value for the EventEmitter which is either +set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    +
    +

    Returns number

    +
    +

    Since

    v1.0.0

    +
+
+

getRepresentation

+
+
+

hasResource

+
+
+

Private isKnownActivity

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      Optional term: Term
    +

    Returns term is NamedNode<"https://www.w3.org/ns/activitystreams#Create"> | NamedNode<"https://www.w3.org/ns/activitystreams#Add"> | NamedNode<"https://www.w3.org/ns/activitystreams#Delete"> | NamedNode<"https://www.w3.org/ns/activitystreams#Remove"> | NamedNode<"https://www.w3.org/ns/activitystreams#Update">

+
+

modifyResource

+
+
+

setMaxListeners

+
    + +
  • +

    By default EventEmitters will print a warning if more than 10 listeners are +added for a particular event. This is a useful default that helps finding +memory leaks. The emitter.setMaxListeners() method allows the limit to be +modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    +

    Returns a reference to the EventEmitter, so that calls can be chained.

    +
    +
    +

    Parameters

    +
      +
    • +
      n: number
    +

    Returns MonitoringStore<T>

    +
    +

    Since

    v0.3.5

    +
+
+

setRepresentation

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/MovedPermanentlyHttpError.html b/7.x/docs/classes/MovedPermanentlyHttpError.html new file mode 100644 index 000000000..0172a1f14 --- /dev/null +++ b/7.x/docs/classes/MovedPermanentlyHttpError.html @@ -0,0 +1,239 @@ +MovedPermanentlyHttpError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class MovedPermanentlyHttpError

+
+

Error used for resources that have been moved permanently. +Methods other than GET may or may not be changed to GET in subsequent requests.

+
+
+
+

Hierarchy

+
    +
  • BaseHttpError +
      +
    • MovedPermanentlyHttpError
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
cause? +errorCode +location +message +metadata +name +stack? +statusCode +isInstance +statusCode +uri +
+
+

Methods

+
generateMetadata +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Optional Readonly cause

+
cause?: unknown
+
+

Readonly errorCode

+
errorCode: string
+
+

Readonly location

+
location: string
+
+

message

+
message: string
+
+

Readonly metadata

+
metadata: RepresentationMetadata
+
+

name

+
name: string
+
+

Optional stack

+
stack?: string
+
+

Readonly statusCode

+
statusCode: 301
+
+

Static Readonly isInstance

+
isInstance: ((error) => error is HttpError<301>)
+
+

Type declaration

+
    +
  • +
      +
    • (error): error is HttpError<301>
      • +
    • +

      Checks whether the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: unknown
      +

      Returns error is HttpError<301>

      +
+
+

Static Readonly statusCode

+
statusCode: 301
+

The status code corresponding to this error class.

+
+
+
+

Static Readonly uri

+
uri: NamedNode<string>
+

A unique URI identifying this error class.

+
+
+
+

Methods

+
+

Protected generateMetadata

+
    + +
  • +

    Initializes the error metadata.

    +
    +

    Returns void

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/N3PatchBodyParser.html b/7.x/docs/classes/N3PatchBodyParser.html new file mode 100644 index 000000000..599420846 --- /dev/null +++ b/7.x/docs/classes/N3PatchBodyParser.html @@ -0,0 +1,265 @@ +N3PatchBodyParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class N3PatchBodyParser

+
+

Parses an N3 Patch document and makes sure it conforms to the specification requirements. +Requirements can be found at Solid Protocol, §5.3.1: https://solid.github.io/specification/protocol#n3-patch

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +findQuads +findVariables +handle +handleSafe +parsePatch +verifyQuads +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      __namedParameters: BodyParserArgs
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Private findQuads

+
    + +
  • +

    Finds all quads in a where/deletes/inserts formula. +The returned quads will be updated so their graph is the default graph instead of the N3 reference to the formula. +Will error in case there are multiple instances of the subject/predicate combination.

    +
    +
    +

    Parameters

    +
      +
    • +
      store: Store<Quad, Quad, Quad, Quad>
      • +
    • +
      subject: Quad_Subject
      • +
    • +
      predicate: NamedNode<string>
    +

    Returns Quad[]

    +
+
+

Private findVariables

+
+
+

handle

+
+
+

handleSafe

+
+
+

Private parsePatch

+
    + +
  • +

    Extracts the deletes/inserts/conditions from a solid:InsertDeletePatch entry.

    +
    +
    +

    Parameters

    +
      +
    • +
      patch: Quad_Subject
      • +
    • +
      store: Store<Quad, Quad, Quad, Quad>
    +

    Returns {
        conditions: Quad[];
        deletes: Quad[];
        inserts: Quad[];
    }

    +
      +
    • +
      conditions: Quad[]
      • +
    • +
      deletes: Quad[]
      • +
    • +
      inserts: Quad[]
    +
+
+

Private verifyQuads

+
    + +
  • +

    Verifies if the delete/insert triples conform to the specification requirements:

    +
      +
    • They should not contain blank nodes.
      • +
    • They should not contain variables that do not occur in the conditions.
      • +
    +
    +
    +

    Parameters

    +
      +
    • +
      otherQuads: Quad[]
      • +
    • +
      conditionVars: Set<string>
    +

    Returns void

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/N3PatchModesExtractor.html b/7.x/docs/classes/N3PatchModesExtractor.html new file mode 100644 index 000000000..631bc3b75 --- /dev/null +++ b/7.x/docs/classes/N3PatchModesExtractor.html @@ -0,0 +1,201 @@ +N3PatchModesExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class N3PatchModesExtractor

+
+

Extracts the required access modes from an N3 Patch.

+

Solid, §5.3.1: "When ?conditions is non-empty, servers MUST treat the request as a Read operation. +When ?insertions is non-empty, servers MUST (also) treat the request as an Append operation. +When ?deletions is non-empty, servers MUST treat the request as a Read and Write operation." +https://solid.github.io/specification/protocol#n3-patch

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
resourceSet +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly resourceSet

+
resourceSet: ResourceSet
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      __namedParameters: Operation
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/N3Patcher.html b/7.x/docs/classes/N3Patcher.html new file mode 100644 index 000000000..4fd280a25 --- /dev/null +++ b/7.x/docs/classes/N3Patcher.html @@ -0,0 +1,244 @@ +N3Patcher | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class N3Patcher

+
+

Applies an N3 Patch to a representation, or creates a new one if required. +Follows all the steps from Solid, §5.3.1: https://solid.github.io/specification/protocol#n3-patch

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
engine +generator +logger +
+
+

Methods

+
applyConditions +canHandle +handle +handleSafe +patch +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly engine

+
engine: QueryEngine<IQueryContextCommon>
+
+

Private Readonly generator

+
generator: SparqlGenerator
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Methods

+
+

Private applyConditions

+
    + +
  • +

    Creates a new N3Patch where the conditions of the provided patch parameter are applied to its deletes and inserts. +Also does the necessary checks to make sure the conditions are valid for the given dataset.

    +
    +
    +

    Parameters

    +
      +
    • +
      patch: N3Patch
      • +
    • +
      identifier: ResourceIdentifier
      • +
    • +
      source: Store<Quad, Quad, Quad, Quad>
    +

    Returns Promise<N3Patch>

    +
+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+

Private patch

+
    + +
  • +

    Applies the given N3Patch to the store. +First the conditions are applied to find the necessary bindings, +which are then applied to generate the triples that need to be deleted and inserted. +After that the delete and insert operations are applied.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Store<Quad, Quad, Quad, Quad>>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/NoCheckOwnershipValidator.html b/7.x/docs/classes/NoCheckOwnershipValidator.html new file mode 100644 index 000000000..74aa35aa9 --- /dev/null +++ b/7.x/docs/classes/NoCheckOwnershipValidator.html @@ -0,0 +1,193 @@ +NoCheckOwnershipValidator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class NoCheckOwnershipValidator

+
+

Does not do any checks to verify if the agent doing the request is actually the owner of the WebID. +This should only be used for debugging.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: {
          webId: string;
      }
      +

      Input that could potentially be handled.

      +
      +
      +
        +
      • +
        webId: string
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      __namedParameters: {
          webId: string;
      }
      +

      Input that needs to be handled.

      +
      +
      +
        +
      • +
        webId: string
    +

    Returns Promise<void>

    A promise resolving when handling is finished.

    + +
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: {
          webId: string;
      }
      +

      Input data that will be handled if it can be handled.

      +
      +
      +
        +
      • +
        webId: string
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/NotFoundHttpError.html b/7.x/docs/classes/NotFoundHttpError.html new file mode 100644 index 000000000..2725753e7 --- /dev/null +++ b/7.x/docs/classes/NotFoundHttpError.html @@ -0,0 +1,228 @@ +NotFoundHttpError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class NotFoundHttpError

+
+

An error thrown when no data was found for the requested identifier.

+
+
+
+

Hierarchy

+
    +
  • BaseHttpError +
      +
    • NotFoundHttpError
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
cause? +errorCode +message +metadata +name +stack? +statusCode +isInstance +statusCode +uri +
+
+

Methods

+
generateMetadata +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Optional Readonly cause

+
cause?: unknown
+
+

Readonly errorCode

+
errorCode: string
+
+

message

+
message: string
+
+

Readonly metadata

+
metadata: RepresentationMetadata
+
+

name

+
name: string
+
+

Optional stack

+
stack?: string
+
+

Readonly statusCode

+
statusCode: 404
+
+

Static Readonly isInstance

+
isInstance: ((error) => error is HttpError<404>)
+
+

Type declaration

+
    +
  • +
      +
    • (error): error is HttpError<404>
      • +
    • +

      Checks whether the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: unknown
      +

      Returns error is HttpError<404>

      +
+
+

Static Readonly statusCode

+
statusCode: 404
+

The status code corresponding to this error class.

+
+
+
+

Static Readonly uri

+
uri: NamedNode<string>
+

A unique URI identifying this error class.

+
+
+
+

Methods

+
+

Protected generateMetadata

+
    + +
  • +

    Initializes the error metadata.

    +
    +

    Returns void

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/NotImplementedHttpError.html b/7.x/docs/classes/NotImplementedHttpError.html new file mode 100644 index 000000000..917a30646 --- /dev/null +++ b/7.x/docs/classes/NotImplementedHttpError.html @@ -0,0 +1,229 @@ +NotImplementedHttpError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class NotImplementedHttpError

+
+

The server either does not recognize the request method, or it lacks the ability to fulfil the request. +Usually this implies future availability (e.g., a new feature of a web-service API).

+
+
+
+

Hierarchy

+
    +
  • BaseHttpError +
      +
    • NotImplementedHttpError
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
cause? +errorCode +message +metadata +name +stack? +statusCode +isInstance +statusCode +uri +
+
+

Methods

+
generateMetadata +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Optional Readonly cause

+
cause?: unknown
+
+

Readonly errorCode

+
errorCode: string
+
+

message

+
message: string
+
+

Readonly metadata

+
metadata: RepresentationMetadata
+
+

name

+
name: string
+
+

Optional stack

+
stack?: string
+
+

Readonly statusCode

+
statusCode: 501
+
+

Static Readonly isInstance

+
isInstance: ((error) => error is HttpError<501>)
+
+

Type declaration

+
    +
  • +
      +
    • (error): error is HttpError<501>
      • +
    • +

      Checks whether the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: unknown
      +

      Returns error is HttpError<501>

      +
+
+

Static Readonly statusCode

+
statusCode: 501
+

The status code corresponding to this error class.

+
+
+
+

Static Readonly uri

+
uri: NamedNode<string>
+

A unique URI identifying this error class.

+
+
+
+

Methods

+
+

Protected generateMetadata

+
    + +
  • +

    Initializes the error metadata.

    +
    +

    Returns void

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/NotificationDescriber.html b/7.x/docs/classes/NotificationDescriber.html new file mode 100644 index 000000000..f5cf97c80 --- /dev/null +++ b/7.x/docs/classes/NotificationDescriber.html @@ -0,0 +1,203 @@ +NotificationDescriber | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class NotificationDescriber

+
+

Outputs quads describing all the subscription services of the server, +as described in https://solidproject.org/TR/2022/notifications-protocol-20221231#discovery and +https://solidproject.org/TR/2022/notifications-protocol-20221231#description-resource-data-model.

+

In the future, if there is ever a need to add notification channels to the description resource as described above, +this functionality should probably be added here as well.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
converter +subscriptions +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly converter

+
converter: RepresentationConverter
+
+

Private Readonly subscriptions

+
subscriptions: NotificationChannelType[]
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/NotificationEmitter.html b/7.x/docs/classes/NotificationEmitter.html new file mode 100644 index 000000000..37d6c0bdc --- /dev/null +++ b/7.x/docs/classes/NotificationEmitter.html @@ -0,0 +1,174 @@ +NotificationEmitter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class NotificationEmitterAbstract

+
+

Emits a serialized Notification to the channel.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/NotificationGenerator.html b/7.x/docs/classes/NotificationGenerator.html new file mode 100644 index 000000000..aca6fbbbb --- /dev/null +++ b/7.x/docs/classes/NotificationGenerator.html @@ -0,0 +1,176 @@ +NotificationGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class NotificationGeneratorAbstract

+
+

Creates a Notification based on the provided input.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/NotificationHandler.html b/7.x/docs/classes/NotificationHandler.html new file mode 100644 index 000000000..dddcdffb4 --- /dev/null +++ b/7.x/docs/classes/NotificationHandler.html @@ -0,0 +1,174 @@ +NotificationHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class NotificationHandlerAbstract

+
+

Makes sure an activity gets emitted to the relevant channel.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/NotificationSerializer.html b/7.x/docs/classes/NotificationSerializer.html new file mode 100644 index 000000000..d049da4c9 --- /dev/null +++ b/7.x/docs/classes/NotificationSerializer.html @@ -0,0 +1,176 @@ +NotificationSerializer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class NotificationSerializerAbstract

+
+

Converts a Notification into a Representation that can be transmitted.

+

This is a separate class between a generator and emitter, +so that a specific notification channel type can add extra metadata to the Representation if needed.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/NotificationSubscriber.html b/7.x/docs/classes/NotificationSubscriber.html new file mode 100644 index 000000000..6e3a9a453 --- /dev/null +++ b/7.x/docs/classes/NotificationSubscriber.html @@ -0,0 +1,259 @@ +NotificationSubscriber | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class NotificationSubscriber

+
+

Handles notification subscriptions by creating a notification channel.

+

Uses the information from the provided NotificationChannelType to validate the input +and verify the request has the required permissions available. +If successful the generated channel will be stored in a NotificationChannelStorage.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
authorizer +channelType +converter +credentialsExtractor +logger +maxDuration +permissionReader +storage +
+
+

Methods

+
authorize +canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly authorizer

+
authorizer: Authorizer
+
+

Private Readonly channelType

+
channelType: NotificationChannelType
+
+

Private Readonly converter

+
converter: RepresentationConverter
+
+

Private Readonly credentialsExtractor

+
credentialsExtractor: CredentialsExtractor
+
+

Protected logger

+
logger: Logger = ...
+
+

Private Readonly maxDuration

+
maxDuration: number
+
+

Private Readonly permissionReader

+
permissionReader: PermissionReader
+
+

Private Readonly storage

+
storage: NotificationChannelStorage
+
+

Methods

+
+

Private authorize

+
+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/NotificationUnsubscriber.html b/7.x/docs/classes/NotificationUnsubscriber.html new file mode 100644 index 000000000..9325d26b2 --- /dev/null +++ b/7.x/docs/classes/NotificationUnsubscriber.html @@ -0,0 +1,198 @@ +NotificationUnsubscriber | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class NotificationUnsubscriber

+
+

Allows clients to unsubscribe from notification channels. +Should be wrapped in a route handler that only allows DELETE operations.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +storage +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly storage

+
storage: NotificationChannelStorage
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/OAuthHttpError.html b/7.x/docs/classes/OAuthHttpError.html new file mode 100644 index 000000000..87cd49684 --- /dev/null +++ b/7.x/docs/classes/OAuthHttpError.html @@ -0,0 +1,270 @@ +OAuthHttpError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class OAuthHttpError

+
+

Represents on OAuth error that is being thrown. +OAuth error responses have additional fields that need to be present in the JSON response, +as described in RFC 6749, §4.1.2.1.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
cause? +errorCode +mandatoryFields +message +metadata +name +stack? +statusCode +prepareStackTrace? +stackTraceLimit +
+
+

Methods

+
generateMetadata +captureStackTrace +isInstance +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Optional Readonly cause

+
cause?: unknown
+
+

Readonly errorCode

+
errorCode: string
+
+

Readonly mandatoryFields

+
mandatoryFields: OAuthErrorFields
+
+

message

+
message: string
+
+

Readonly metadata

+
metadata: RepresentationMetadata
+
+

name

+
name: string
+
+

Optional stack

+
stack?: string
+
+

Readonly statusCode

+
statusCode: number
+
+

Static Optional prepareStackTrace

+
prepareStackTrace?: ((err, stackTraces) => any)
+
+

Type declaration

+
+
+

Static stackTraceLimit

+
stackTraceLimit: number
+
+

Methods

+
+

Protected generateMetadata

+
+
+

Static captureStackTrace

+
    + +
  • +

    Create .stack property on a target object

    +
    +
    +

    Parameters

    +
      +
    • +
      targetObject: object
      • +
    • +
      Optional constructorOpt: Function
    +

    Returns void

    +
+
+

Static isInstance

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/OidcControlHandler.html b/7.x/docs/classes/OidcControlHandler.html new file mode 100644 index 000000000..398847215 --- /dev/null +++ b/7.x/docs/classes/OidcControlHandler.html @@ -0,0 +1,256 @@ +OidcControlHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class OidcControlHandler

+
+

A ControlHandler that only returns results if there is an active OIDC interaction.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +generateControlSet +generateControls +handle +handleSafe +isRoute +mergeControls +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
+
+

Protected generateControlSet

+
+
+

Protected generateControls

+
+
+

handle

+
+
+

handleSafe

+
+
+

Protected isRoute

+
+
+

Protected mergeControls

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/OidcHttpHandler.html b/7.x/docs/classes/OidcHttpHandler.html new file mode 100644 index 000000000..aa6b58065 --- /dev/null +++ b/7.x/docs/classes/OidcHttpHandler.html @@ -0,0 +1,197 @@ +OidcHttpHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class OidcHttpHandler

+
+

HTTP handler that redirects all requests to the OIDC library.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +providerFactory +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly providerFactory

+
providerFactory: ProviderFactory
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving when handling is finished.

    + +
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/OkResponseDescription.html b/7.x/docs/classes/OkResponseDescription.html new file mode 100644 index 000000000..b8d24a97a --- /dev/null +++ b/7.x/docs/classes/OkResponseDescription.html @@ -0,0 +1,140 @@ +OkResponseDescription | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class OkResponseDescription

+
+

Corresponds to a 200 or 206 response, containing relevant metadata and potentially data. +A 206 will be returned if range metadata is found in the metadata object.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
data? +metadata? +statusCode +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Optional data

+
data?: Guarded<Readable>
+
+

Optional metadata

+
metadata?: RepresentationMetadata
+
+

statusCode

+
statusCode: number
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/OperationHandler.html b/7.x/docs/classes/OperationHandler.html new file mode 100644 index 000000000..4de981af6 --- /dev/null +++ b/7.x/docs/classes/OperationHandler.html @@ -0,0 +1,178 @@ +OperationHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class OperationHandlerAbstract

+
+

Handler for a specific operation type.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/OperationHttpHandler.html b/7.x/docs/classes/OperationHttpHandler.html new file mode 100644 index 000000000..8d28527cc --- /dev/null +++ b/7.x/docs/classes/OperationHttpHandler.html @@ -0,0 +1,181 @@ +OperationHttpHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class OperationHttpHandlerAbstract

+
+

An HTTP handler that makes use of an already parsed Operation.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/OperationRouterHandler.html b/7.x/docs/classes/OperationRouterHandler.html new file mode 100644 index 000000000..9728ff6b9 --- /dev/null +++ b/7.x/docs/classes/OperationRouterHandler.html @@ -0,0 +1,243 @@ +OperationRouterHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class OperationRouterHandler

+
+

A BaseRouterHandler for an OperationHttpHandler.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
allMethods +allowedMethods +allowedPathNamesRegEx +baseUrlLength +handler +
+
+

Methods

+
canHandle +canHandleInput +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly allMethods

+
allMethods: boolean
+
+

Protected Readonly allowedMethods

+
allowedMethods: string[]
+
+

Protected Readonly allowedPathNamesRegEx

+
allowedPathNamesRegEx: RegExp[]
+
+

Protected Readonly baseUrlLength

+
baseUrlLength: number
+
+

Protected Readonly handler

+
handler: OperationHttpHandler
+
+

Methods

+
+

canHandle

+
+
+

Protected canHandleInput

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/OriginalUrlExtractor.html b/7.x/docs/classes/OriginalUrlExtractor.html new file mode 100644 index 000000000..646605c64 --- /dev/null +++ b/7.x/docs/classes/OriginalUrlExtractor.html @@ -0,0 +1,206 @@ +OriginalUrlExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class OriginalUrlExtractor

+
+

Reconstructs the original URL of an incoming HttpRequest.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
identifierStrategy +includeQueryString +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly identifierStrategy

+
identifierStrategy: IdentifierStrategy
+
+

Private Readonly includeQueryString

+
includeQueryString: boolean
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: {
          request: HttpRequest;
      }
      +

      Input that could potentially be handled.

      +
      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/OwnerMetadataWriter.html b/7.x/docs/classes/OwnerMetadataWriter.html new file mode 100644 index 000000000..b326f1014 --- /dev/null +++ b/7.x/docs/classes/OwnerMetadataWriter.html @@ -0,0 +1,211 @@ +OwnerMetadataWriter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class OwnerMetadataWriter

+
+

Adds link headers indicating who the owners are when accessing the base URL of a pod. +Only owners that have decided to be visible will be shown.

+

Solid, §4.1: "When a server wants to advertise the owner of a storage, +the server MUST include the Link header with rel="http://www.w3.org/ns/solid/terms#owner" +targeting the URI of the owner in the response of HTTP HEAD or GET requests targeting the root container." +https://solidproject.org/TR/2022/protocol-20221231#server-storage-link-owner

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +podStore +storageStrategy +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected logger

+
logger: Logger = ...
+
+

Protected podStore

+
podStore: PodStore
+
+

Protected storageStrategy

+
storageStrategy: StorageLocationStrategy
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/OwnerPermissionReader.html b/7.x/docs/classes/OwnerPermissionReader.html new file mode 100644 index 000000000..26ca3fc52 --- /dev/null +++ b/7.x/docs/classes/OwnerPermissionReader.html @@ -0,0 +1,253 @@ +OwnerPermissionReader | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class OwnerPermissionReader

+
+

Allows control access if the request is being made by an owner of the pod containing the resource.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
authStrategy +logger +podStore +storageStrategy +
+
+

Methods

+
canHandle +findOwners +findPods +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly authStrategy

+
authStrategy: AuxiliaryIdentifierStrategy
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly podStore

+
podStore: PodStore
+
+

Private Readonly storageStrategy

+
storageStrategy: StorageLocationStrategy
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Protected findOwners

+
    + +
  • +

    Finds the owners of the given pods. +Return value is a record where the keys are the pods and the values are all the WebIDs that own this pod.

    +
    +
    +

    Parameters

    +
      +
    • +
      pods: string[]
    +

    Returns Promise<Record<string, string[]>>

    +
+
+

Protected findPods

+
    + +
  • +

    Finds all pods that contain the given identifiers. +Return value is a record where the keys are the identifiers and the values the associated pod.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Record<string, string>>

    +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/OwnershipValidator.html b/7.x/docs/classes/OwnershipValidator.html new file mode 100644 index 000000000..fd97461c7 --- /dev/null +++ b/7.x/docs/classes/OwnershipValidator.html @@ -0,0 +1,185 @@ +OwnershipValidator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class OwnershipValidatorAbstract

+
+

A class that validates if a someone owns a WebId. +Will throw an error if the WebId is not valid or ownership could not be validated. +The error message should contain a description of what is wrong and how it can be resolved.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: {
          webId: string;
      }
      +

      Input that could potentially be handled.

      +
      +
      +
        +
      • +
        webId: string
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: {
          webId: string;
      }
      +

      Input that needs to be handled.

      +
      +
      +
        +
      • +
        webId: string
    +

    Returns Promise<void>

    A promise resolving when handling is finished.

    + +
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: {
          webId: string;
      }
      +

      Input data that will be handled if it can be handled.

      +
      +
      +
        +
      • +
        webId: string
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ParallelHandler.html b/7.x/docs/classes/ParallelHandler.html new file mode 100644 index 000000000..de6fb97c9 --- /dev/null +++ b/7.x/docs/classes/ParallelHandler.html @@ -0,0 +1,204 @@ +ParallelHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ParallelHandler<TIn, TOut>

+
+

A composite handler that executes handlers in parallel.

+
+
+
+

Type Parameters

+
    +
  • +

    TIn = void

    • +
  • +

    TOut = void

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
handlers +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly handlers

+
handlers: AsyncHandler<TIn, TOut>[]
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<TOut[]>

    A promise resolving when handling is finished.

    + +
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<TOut[]>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ParentContainerReader.html b/7.x/docs/classes/ParentContainerReader.html new file mode 100644 index 000000000..97a430d22 --- /dev/null +++ b/7.x/docs/classes/ParentContainerReader.html @@ -0,0 +1,288 @@ +ParentContainerReader | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ParentContainerReader

+
+

Determines delete and create permissions for those resources that need it +by making sure the parent container has the required permissions.

+

Create requires append permissions on the parent container. +Delete requires write permissions on both the parent container and the resource itself.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
identifierStrategy +logger +reader +
+
+

Methods

+
addContainerPermissions +canHandle +findParents +getParentModes +handle +handleSafe +interpretContainerPermission +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly identifierStrategy

+
identifierStrategy: IdentifierStrategy
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly reader

+
reader: PermissionReader
+
+

Methods

+
+

Private addContainerPermissions

+
    + +
  • +

    Merges the container permission set into the resource permission set +based on the parent container rules for create/delete permissions.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional resourceSet: Partial<Record<AccessMode, boolean>>
      • +
    • +
      Optional containerSet: Partial<Record<AccessMode, boolean>>
    +

    Returns Partial<Record<AccessMode, boolean>>

    +
+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Private findParents

+
+
+

Private getParentModes

+
+
+

handle

+
+
+

handleSafe

+
+
+

Private interpretContainerPermission

+
    + +
  • +

    Determines the create and delete permissions for the given resource permissions +based on those of its parent container.

    +
    +
    +

    Parameters

    +
      +
    • +
      resourcePermission: Partial<Record<AccessMode, boolean>>
      • +
    • +
      containerPermission: Partial<Record<AccessMode, boolean>>
    +

    Returns Partial<Record<AccessMode, boolean>>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ParsingHttpHandler.html b/7.x/docs/classes/ParsingHttpHandler.html new file mode 100644 index 000000000..3bf0874ef --- /dev/null +++ b/7.x/docs/classes/ParsingHttpHandler.html @@ -0,0 +1,260 @@ +ParsingHttpHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ParsingHttpHandler

+
+

Parses requests and sends the resulting Operation to the wrapped OperationHttpHandler. +Errors are caught and handled by the ErrorHandler. +In case the OperationHttpHandler returns a result it will be sent to the ResponseWriter.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
errorHandler +logger +operationHandler +requestParser +responseWriter +
+
+

Methods

+
canHandle +handle +handleError +handleRequest +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly errorHandler

+
errorHandler: ErrorHandler
+
+

Private Readonly logger

+
logger: Logger = ...
+
+

Private Readonly operationHandler

+
operationHandler: OperationHttpHandler
+
+

Private Readonly requestParser

+
requestParser: RequestParser
+
+

Private Readonly responseWriter

+
responseWriter: ResponseWriter
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving when handling is finished.

    + +
+
+

Protected handleError

+
+
+

Protected handleRequest

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PartialReadWriteLocker.html b/7.x/docs/classes/PartialReadWriteLocker.html new file mode 100644 index 000000000..0ffa0d344 --- /dev/null +++ b/7.x/docs/classes/PartialReadWriteLocker.html @@ -0,0 +1,309 @@ +PartialReadWriteLocker | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PartialReadWriteLocker

+
+

A BaseReadWriteLocker that stores the counter and its associated locks in memory. +The consequence of this is that multiple read requests are possible as long as they occur on the same worker thread. +A read request from a different worker thread will have to wait +until those from the current worker thread are finished.

+

The main reason for this class is due to the file locker that we use only allowing locks to be released +by the same worker thread that acquired them.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
countLocker +locker +readCount +
+
+

Methods

+
getCountLockIdentifier +modifyCount +withLock +withReadLock +withWriteLock +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly countLocker

+
countLocker: ResourceLocker
+
+

Protected Readonly locker

+
locker: ResourceLocker
+
+

Private Readonly readCount

+
readCount: Map<string, number>
+
+

Methods

+
+

Protected getCountLockIdentifier

+
+
+

Protected modifyCount

+
+
+

Protected withLock

+
+
+

withReadLock

+
    + +
  • +

    Run the given function while the resource is locked. +The lock will be released when the (async) input function resolves. +This function should be used for operations that only require reading the resource.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
    +

    Returns Promise<T>

    A promise resolving when the lock is released.

    + +
+
+

withWriteLock

+
    + +
  • +

    Run the given function while the resource is locked. +The lock will be released when the (async) input function resolves. +This function should be used for operations that could modify the resource.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
    +

    Returns Promise<T>

    A promise resolving when the lock is released.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PassthroughAdapter.html b/7.x/docs/classes/PassthroughAdapter.html new file mode 100644 index 000000000..579c4fd7a --- /dev/null +++ b/7.x/docs/classes/PassthroughAdapter.html @@ -0,0 +1,248 @@ +PassthroughAdapter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PassthroughAdapter

+
+

OIDC Adapter that calls the corresponding functions of the source Adapter. +Can be extended by adapters that do not want to override all functions +by implementing a decorator pattern.

+
+
+
+

Hierarchy

+
+
+

Implements

+
    +
  • Adapter
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
name +source +
+
+

Methods

+
consume +destroy +find +findByUid +findByUserCode +revokeByGrantId +upsert +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly name

+
name: string
+
+

Protected Readonly source

+
source: Adapter
+
+

Methods

+
+

consume

+
+
+

destroy

+
+
+

find

+
+
+

findByUid

+
+
+

findByUserCode

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      userCode: string
    +

    Returns Promise<undefined | void | AdapterPayload>

+
+

revokeByGrantId

+
+
+

upsert

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      id: string
      • +
    • +
      payload: AdapterPayload
      • +
    • +
      expiresIn: number
    +

    Returns Promise<undefined | void>

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PassthroughAdapterFactory.html b/7.x/docs/classes/PassthroughAdapterFactory.html new file mode 100644 index 000000000..13bf18e79 --- /dev/null +++ b/7.x/docs/classes/PassthroughAdapterFactory.html @@ -0,0 +1,140 @@ +PassthroughAdapterFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PassthroughAdapterFactory

+
+

A factory that generates an Adapter to be used by the IDP to persist information.

+

The oidc-provider library will call the relevant functions when it needs to find/create/delete metadata. +For a full explanation of how these functions work and what is expected, +have a look at https://github.com/panva/node-oidc-provider/blob/main/example/my_adapter.js

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
source +
+
+

Methods

+
createStorageAdapter +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly source

+
source: AdapterFactory
+
+

Methods

+
+

createStorageAdapter

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PassthroughConverter.html b/7.x/docs/classes/PassthroughConverter.html new file mode 100644 index 000000000..3fa75a8dd --- /dev/null +++ b/7.x/docs/classes/PassthroughConverter.html @@ -0,0 +1,171 @@ +PassthroughConverter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PassthroughConverter

+
+

A RepresentationConverter that does not perform any conversion.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PassthroughDataAccessor.html b/7.x/docs/classes/PassthroughDataAccessor.html new file mode 100644 index 000000000..3f4db3785 --- /dev/null +++ b/7.x/docs/classes/PassthroughDataAccessor.html @@ -0,0 +1,338 @@ +PassthroughDataAccessor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PassthroughDataAccessor

+
+

DataAccessor that calls the corresponding functions of the source DataAccessor. +Can be extended by data accessors that do not want to override all functions +by implementing a decorator pattern.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
accessor +
+
+

Methods

+
canHandle +deleteResource +getChildren +getData +getMetadata +writeContainer +writeDocument +writeMetadata +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly accessor

+
accessor: AtomicDataAccessor
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Should throw a NotImplementedHttpError if the DataAccessor does not support storing the given Representation.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    +
    +

    Throws

    BadRequestHttpError +If it does not support the incoming data.

    +
+
+

deleteResource

+
+
+

getChildren

+
    + +
  • +

    Returns metadata for all resources in the requested container. +This should not be all metadata of those resources (but it can be), +but instead the main metadata you want to show in situations +where all these resources are presented simultaneously. +Generally this would be metadata that is present for all of these resources, +such as resource type or last modified date.

    +

    It can be safely assumed that the incoming identifier will always correspond to a container.

    +
    +
    +

    Parameters

    +
    +

    Returns AsyncIterableIterator<RepresentationMetadata>

    +
+
+

getData

+
+
+

getMetadata

+
+
+

writeContainer

+
+
+

writeDocument

+
+
+

writeMetadata

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PassthroughKeyValueStorage.html b/7.x/docs/classes/PassthroughKeyValueStorage.html new file mode 100644 index 000000000..6a229d068 --- /dev/null +++ b/7.x/docs/classes/PassthroughKeyValueStorage.html @@ -0,0 +1,281 @@ +PassthroughKeyValueStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PassthroughKeyValueStorage<TVal>Abstract

+
+

Abstract class to create a KeyValueStorage by wrapping around another one.

+

Exposes abstract functions to modify the key before passing it to the the source storage.

+
+
+
+

Type Parameters

+
    +
  • +

    TVal

+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
source +
+
+

Methods

+
delete +entries +get +has +set +toNewKey +toOriginalKey +
+
+

Constructors

+
+

Protected constructor

+
+
+

Properties

+
+

Protected Readonly source

+
source: KeyValueStorage<string, TVal>
+
+

Methods

+
+

delete

+
+
+

entries

+
+
+

get

+
+
+

has

+
+
+

set

+
+
+

Protected Abstract toNewKey

+
    + +
  • +

    This function will be called on the input key and used as a new key when calling the source.

    +
    +
    +

    Parameters

    +
      +
    • +
      key: string
      +

      Original input key.

      +
      +
    +

    Returns string

    A new key to use with the source storage.

    + +
+
+

Protected Abstract toOriginalKey

+
    + +
  • +

    This function is used when calling entries() to revert the key generated by toNewKey().

    +
    +
    +

    Parameters

    +
      +
    • +
      key: string
      +

      A key generated by toNewKey()

      +
      +
    +

    Returns string

    The original key.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PassthroughStore.html b/7.x/docs/classes/PassthroughStore.html new file mode 100644 index 000000000..c1f2ae3fa --- /dev/null +++ b/7.x/docs/classes/PassthroughStore.html @@ -0,0 +1,321 @@ +PassthroughStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PassthroughStore<T>

+
+

Store that calls the corresponding functions of the source Store. +Can be extended by stores that do not want to override all functions +by implementing a decorator pattern.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
source +
+
+

Methods

+
addResource +deleteResource +getRepresentation +hasResource +modifyResource +setRepresentation +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly source

+
source: T
+
+

Methods

+
+

addResource

+
+
+

deleteResource

+
+
+

getRepresentation

+
+
+

hasResource

+
+
+

modifyResource

+
+
+

setRepresentation

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PasswordLoginHandler.html b/7.x/docs/classes/PasswordLoginHandler.html new file mode 100644 index 000000000..cbd04fc3a --- /dev/null +++ b/7.x/docs/classes/PasswordLoginHandler.html @@ -0,0 +1,278 @@ +PasswordLoginHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PasswordLoginHandler

+
+

Handles the submission of the Login Form and logs the user in.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
accountStore +cookieStore +logger +passwordStore +
+
+

Methods

+
canHandle +getView +handle +handleSafe +login +updateRememberSetting +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly accountStore

+
accountStore: AccountStore
+
+

Protected Readonly cookieStore

+
cookieStore: CookieStore
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly passwordStore

+
passwordStore: PasswordStore
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

getView

+
+
+

handle

+
+
+

handleSafe

+
+
+

login

+
+
+

Protected updateRememberSetting

+
    + +
  • +

    Updates the account setting that determines whether the login status needs to be remembered.

    +
    +
    +

    Parameters

    +
      +
    • +
      accountId: string
      +

      ID of the account.

      +
      +
      • +
    • +
      Optional remember: boolean
      +

      If the account should be remembered or not. The setting will not be updated if this is undefined.

      +
      +
    +

    Returns Promise<void>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PatchHandler.html b/7.x/docs/classes/PatchHandler.html new file mode 100644 index 000000000..4cdc99b27 --- /dev/null +++ b/7.x/docs/classes/PatchHandler.html @@ -0,0 +1,183 @@ +PatchHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PatchHandler<T>Abstract

+
+

Executes the given Patch.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PatchOperationHandler.html b/7.x/docs/classes/PatchOperationHandler.html new file mode 100644 index 000000000..0128d0c39 --- /dev/null +++ b/7.x/docs/classes/PatchOperationHandler.html @@ -0,0 +1,198 @@ +PatchOperationHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PatchOperationHandler

+
+

Handles PATCH Operations. +Calls the modifyResource function from a ResourceStore.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +store +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly store

+
store: ResourceStore
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PatchingStore.html b/7.x/docs/classes/PatchingStore.html new file mode 100644 index 000000000..01b4a8e50 --- /dev/null +++ b/7.x/docs/classes/PatchingStore.html @@ -0,0 +1,324 @@ +PatchingStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PatchingStore<T>

+
+

ResourceStore using decorator pattern for the modifyResource function. +If the original store supports the Patch, behaviour will be identical, +otherwise the PatchHandler will be called instead.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
patchHandler +source +
+
+

Methods

+
addResource +deleteResource +getRepresentation +hasResource +modifyResource +setRepresentation +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly patchHandler

+
patchHandler: PatchHandler<ResourceStore>
+
+

Protected Readonly source

+
source: T
+
+

Methods

+
+

addResource

+
+
+

deleteResource

+
+
+

getRepresentation

+
+
+

hasResource

+
+
+

modifyResource

+
+
+

setRepresentation

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PathBasedReader.html b/7.x/docs/classes/PathBasedReader.html new file mode 100644 index 000000000..6c09833d5 --- /dev/null +++ b/7.x/docs/classes/PathBasedReader.html @@ -0,0 +1,246 @@ +PathBasedReader | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PathBasedReader

+
+

Redirects requests to specific PermissionReaders based on their identifier. +The keys are regular expression strings. +The regular expressions should all start with a slash +and will be evaluated relative to the base URL.

+

Will error if no match is found.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
baseUrl +logger +paths +
+
+

Methods

+
canHandle +findReader +handle +handleSafe +matchReaders +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly baseUrl

+
baseUrl: string
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly paths

+
paths: Map<RegExp, PermissionReader>
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Private findReader

+
+
+

handle

+
+
+

handleSafe

+
+
+

Private matchReaders

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PermissionBasedAuthorizer.html b/7.x/docs/classes/PermissionBasedAuthorizer.html new file mode 100644 index 000000000..958a73264 --- /dev/null +++ b/7.x/docs/classes/PermissionBasedAuthorizer.html @@ -0,0 +1,288 @@ +PermissionBasedAuthorizer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PermissionBasedAuthorizer

+
+

Authorizer that bases its decision on the output it gets from its PermissionReader. +For each permission it checks if the reader allows that for at least one credential type, +if yes, authorization is granted. +undefined values for reader results are interpreted as false.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +resourceSet +
+
+

Methods

+
canHandle +handle +handleSafe +isAuthenticated +reportAccessError +requireModePermission +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly resourceSet

+
resourceSet: ResourceSet
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+

Private isAuthenticated

+
+
+

Private reportAccessError

+
    + +
  • +

    If we know the operation will return a 404 regardless (= resource does not exist and is not being created), +and the agent is allowed to know about its existence (= the agent has Read permissions), +then immediately send the 404 here, as it makes any other agent permissions irrelevant.

    +

    Otherwise, deny access based on existing grounds.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<never>

    +
+
+

Private requireModePermission

+
    + +
  • +

    Ensures that at least one of the credentials provides permissions for the given mode. +Throws a ForbiddenHttpError or UnauthorizedHttpError depending on the credentials +if access is not allowed.

    +
    +
    +

    Parameters

    +
      +
    • +
      credentials: Credentials
      +

      Credentials that require access.

      +
      +
      • +
    • +
      permissionSet: Partial<Record<AccessMode, boolean>>
      +

      PermissionSet describing the available permissions of the credentials.

      +
      +
      • +
    • +
      mode: AccessMode
      +

      Which mode is requested.

      +
      +
    +

    Returns void

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PermissionReader.html b/7.x/docs/classes/PermissionReader.html new file mode 100644 index 000000000..8f0fb6490 --- /dev/null +++ b/7.x/docs/classes/PermissionReader.html @@ -0,0 +1,182 @@ +PermissionReader | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PermissionReaderAbstract

+
+

Discovers the permissions of the given credentials on the given identifier. +If the reader finds no permission for the requested identifiers and credentials, +it can return an empty or incomplete map.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PickWebIdHandler.html b/7.x/docs/classes/PickWebIdHandler.html new file mode 100644 index 000000000..304869c87 --- /dev/null +++ b/7.x/docs/classes/PickWebIdHandler.html @@ -0,0 +1,232 @@ +PickWebIdHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PickWebIdHandler

+
+

Allows users to choose which WebID they want to authenticate as during an OIDC interaction.

+

One of the main reason picking a WebID is a separate class/request from consenting to the OIDC interaction, +is because the OIDC-provider will only give the information we need for consent +once we have added an accountId to the OIDC interaction, which we do in this class. +The library also really wants to use that accountId as the value that you use for generating the tokens, +meaning we can't just use another value there, so we need to assign the WebID to it, +unless we use a hacky workaround.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +providerFactory +webIdStore +
+
+

Methods

+
canHandle +getView +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly logger

+
logger: Logger = ...
+
+

Private Readonly providerFactory

+
providerFactory: ProviderFactory
+
+

Private Readonly webIdStore

+
webIdStore: WebIdStore
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

getView

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PlainJsonLdFilter.html b/7.x/docs/classes/PlainJsonLdFilter.html new file mode 100644 index 000000000..469900de8 --- /dev/null +++ b/7.x/docs/classes/PlainJsonLdFilter.html @@ -0,0 +1,216 @@ +PlainJsonLdFilter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PlainJsonLdFilter

+
+

Filter that errors on JSON-LD with a plain application/json content-type. +This will not store metadata, only throw errors if necessary.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +
+
+

Methods

+
canHandle +handle +handleSafe +linkHasContextRelation +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+

Private linkHasContextRelation

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PodCreator.html b/7.x/docs/classes/PodCreator.html new file mode 100644 index 000000000..2673481ea --- /dev/null +++ b/7.x/docs/classes/PodCreator.html @@ -0,0 +1,173 @@ +PodCreator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PodCreatorAbstract

+
+

Handles creating a pod and linking the created WebID.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PodQuotaStrategy.html b/7.x/docs/classes/PodQuotaStrategy.html new file mode 100644 index 000000000..d4aa3b117 --- /dev/null +++ b/7.x/docs/classes/PodQuotaStrategy.html @@ -0,0 +1,262 @@ +PodQuotaStrategy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PodQuotaStrategy

+
+

The PodQuotaStrategy sets a limit on the amount of data stored on a per pod basis

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
accessor +identifierStrategy +limit +reporter +
+
+

Methods

+
createQuotaGuard +estimateSize +getAvailableSpace +getTotalSpaceUsed +searchPimStorage +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly accessor

+
accessor: DataAccessor
+
+

Private Readonly identifierStrategy

+
identifierStrategy: IdentifierStrategy
+
+

Readonly limit

+
limit: Size
+
+

Readonly reporter

+
reporter: SizeReporter<unknown>
+
+

Methods

+
+

createQuotaGuard

+
    + +
  • +

    Get a Passthrough stream that will keep track of the available space. +If the quota is exceeded the stream will emit an error and destroy itself. +Like other Passthrough instances this will simply pass on the chunks, when the quota isn't exceeded.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Guarded<PassThrough>>

    a Passthrough instance that errors when quota is exceeded

    + +
+
+

estimateSize

+
+
+

getAvailableSpace

+
    + +
  • +

    Get the available space when writing data to the given identifier. +If the given resource already exists it will deduct the already taken up +space by that resource since it is going to be overwritten and thus counts +as available space.

    +
    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      the identifier of the resource of which you want the available space

      +
      +
    +

    Returns Promise<Size>

    the available space and the unit of the space as a Size object

    + +
+
+

Protected getTotalSpaceUsed

+
+
+

Private searchPimStorage

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PodStorageLocationStrategy.html b/7.x/docs/classes/PodStorageLocationStrategy.html new file mode 100644 index 000000000..7c3531998 --- /dev/null +++ b/7.x/docs/classes/PodStorageLocationStrategy.html @@ -0,0 +1,140 @@ +PodStorageLocationStrategy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PodStorageLocationStrategy

+
+

A StorageLocationStrategy to be used when the server has pods which each are a different storage. +The IdentifierGenerator that is used to generate URLs for the pods +is used here to determine what the root pod URL is.

+
+
+
+

Hierarchy

+
    +
  • PodStorageLocationStrategy
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
generator +
+
+

Methods

+
getStorageIdentifier +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly generator

+
generator: IdentifierGenerator
+
+

Methods

+
+

getStorageIdentifier

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PostOperationHandler.html b/7.x/docs/classes/PostOperationHandler.html new file mode 100644 index 000000000..fd5d1ab44 --- /dev/null +++ b/7.x/docs/classes/PostOperationHandler.html @@ -0,0 +1,198 @@ +PostOperationHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PostOperationHandler

+
+

Handles POST Operations. +Calls the addResource function from a ResourceStore.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +store +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly store

+
store: ResourceStore
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PreconditionFailedHttpError.html b/7.x/docs/classes/PreconditionFailedHttpError.html new file mode 100644 index 000000000..969a65dc6 --- /dev/null +++ b/7.x/docs/classes/PreconditionFailedHttpError.html @@ -0,0 +1,228 @@ +PreconditionFailedHttpError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PreconditionFailedHttpError

+
+

An error thrown when access was denied due to the conditions on the request.

+
+
+
+

Hierarchy

+
    +
  • BaseHttpError +
      +
    • PreconditionFailedHttpError
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
cause? +errorCode +message +metadata +name +stack? +statusCode +isInstance +statusCode +uri +
+
+

Methods

+
generateMetadata +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Optional Readonly cause

+
cause?: unknown
+
+

Readonly errorCode

+
errorCode: string
+
+

message

+
message: string
+
+

Readonly metadata

+
metadata: RepresentationMetadata
+
+

name

+
name: string
+
+

Optional stack

+
stack?: string
+
+

Readonly statusCode

+
statusCode: 412
+
+

Static Readonly isInstance

+
isInstance: ((error) => error is HttpError<412>)
+
+

Type declaration

+
    +
  • +
      +
    • (error): error is HttpError<412>
      • +
    • +

      Checks whether the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: unknown
      +

      Returns error is HttpError<412>

      +
+
+

Static Readonly statusCode

+
statusCode: 412
+

The status code corresponding to this error class.

+
+
+
+

Static Readonly uri

+
uri: NamedNode<string>
+

A unique URI identifying this error class.

+
+
+
+

Methods

+
+

Protected generateMetadata

+
    + +
  • +

    Initializes the error metadata.

    +
    +

    Returns void

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PreferenceParser.html b/7.x/docs/classes/PreferenceParser.html new file mode 100644 index 000000000..fa93d6b9d --- /dev/null +++ b/7.x/docs/classes/PreferenceParser.html @@ -0,0 +1,183 @@ +PreferenceParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PreferenceParserAbstract

+
+

Creates RepresentationPreferences based on the incoming HTTP headers in a HttpRequest.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: {
          request: HttpRequest;
      }
      +

      Input that could potentially be handled.

      +
      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PreferenceSupport.html b/7.x/docs/classes/PreferenceSupport.html new file mode 100644 index 000000000..2369ece14 --- /dev/null +++ b/7.x/docs/classes/PreferenceSupport.html @@ -0,0 +1,146 @@ +PreferenceSupport | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PreferenceSupport

+
+

Helper class that checks if the stored RepresentationConverter and RepresentationPreferences +support the given input RepresentationPreferences and Representation.

+

Creates a new object by combining the input arguments together with the stored preferences and checks +if the converter can handle that object.

+
+
+
+

Hierarchy

+
    +
  • PreferenceSupport
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
converter +preferences +
+
+

Methods

+
supports +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly converter

+
converter: RepresentationConverter
+
+

Private Readonly preferences

+
preferences: RepresentationPreferences
+
+

Methods

+
+

supports

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ProcessHandler.html b/7.x/docs/classes/ProcessHandler.html new file mode 100644 index 000000000..ae0bf6ac2 --- /dev/null +++ b/7.x/docs/classes/ProcessHandler.html @@ -0,0 +1,251 @@ +ProcessHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ProcessHandler<TIn, TOut>

+
+

A wrapper handler that will only run the wrapped handler if it is executed from:

+
    +
  • when running multithreaded: either the primary or a worker process
    • +
  • when running singlethreaded: the only process (i.e. always)
    • +
+
+
+
+

Type Parameters

+
    +
  • +

    TIn

    • +
  • +

    TOut

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
clusterManager +executeOnPrimary +source +
+
+

Methods

+
canExecute +canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly clusterManager

+
clusterManager: ClusterManager
+
+

Private Readonly executeOnPrimary

+
executeOnPrimary: boolean
+
+

Private Readonly source

+
source: AsyncHandler<TIn, TOut>
+
+

Methods

+
+

Private canExecute

+
+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<TOut>

    A promise resolving when handling is finished.

    + +
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<TOut>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PromptFactory.html b/7.x/docs/classes/PromptFactory.html new file mode 100644 index 000000000..b8bcb77bf --- /dev/null +++ b/7.x/docs/classes/PromptFactory.html @@ -0,0 +1,173 @@ +PromptFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PromptFactoryAbstract

+
+

Used to generate custom interactionPolicy.Prompts.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: DefaultPolicy
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: DefaultPolicy
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving when handling is finished.

    + +
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: DefaultPolicy
      +

      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.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PromptHandler.html b/7.x/docs/classes/PromptHandler.html new file mode 100644 index 000000000..6157845af --- /dev/null +++ b/7.x/docs/classes/PromptHandler.html @@ -0,0 +1,203 @@ +PromptHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PromptHandler

+
+

Redirects requests based on the OIDC Interaction prompt. +Errors in case no match was found.

+

The reason we use this intermediate handler +instead of letting the OIDC library redirect directly to the correct page, +is because that library creates a cookie with of scope of the target page. +By having the library always redirect to the index page, +the cookie is relevant for all pages and other pages can see if we are still in an interaction.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +promptRoutes +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly logger

+
logger: Logger = ...
+
+

Private Readonly promptRoutes

+
promptRoutes: Record<string, InteractionRoute<never>>
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PublicCredentialsExtractor.html b/7.x/docs/classes/PublicCredentialsExtractor.html new file mode 100644 index 000000000..93a7817d4 --- /dev/null +++ b/7.x/docs/classes/PublicCredentialsExtractor.html @@ -0,0 +1,164 @@ +PublicCredentialsExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PublicCredentialsExtractor

+
+

Extracts the "public credentials", to be used for data everyone has access to. +This class mainly exists so a Credentials is still generated in case the token parsing fails.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: HttpRequest
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/PutOperationHandler.html b/7.x/docs/classes/PutOperationHandler.html new file mode 100644 index 000000000..8590d5efd --- /dev/null +++ b/7.x/docs/classes/PutOperationHandler.html @@ -0,0 +1,207 @@ +PutOperationHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class PutOperationHandler

+
+

Handles PUT Operations. +Calls the setRepresentation function from a ResourceStore.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +metadataStrategy +store +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly metadataStrategy

+
metadataStrategy: AuxiliaryStrategy
+
+

Private Readonly store

+
store: ResourceStore
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/QuadToRdfConverter.html b/7.x/docs/classes/QuadToRdfConverter.html new file mode 100644 index 000000000..22bc450d6 --- /dev/null +++ b/7.x/docs/classes/QuadToRdfConverter.html @@ -0,0 +1,230 @@ +QuadToRdfConverter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class QuadToRdfConverter

+
+

Converts internal/quads to most major RDF serializations.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
inputTypes +outputPreferences? +outputTypes +
+
+

Methods

+
canHandle +getOutputTypes +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected inputTypes

+
inputTypes: Promise<ValuePreferences>
+
+

Private Optional Readonly outputPreferences

+
outputPreferences?: ValuePreferences
+
+

Protected outputTypes

+
outputTypes: Promise<ValuePreferences>
+
+

Methods

+
+

canHandle

+
+
+

getOutputTypes

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/QuotaStrategy.html b/7.x/docs/classes/QuotaStrategy.html new file mode 100644 index 000000000..cad712f69 --- /dev/null +++ b/7.x/docs/classes/QuotaStrategy.html @@ -0,0 +1,224 @@ +QuotaStrategy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class QuotaStrategyAbstract

+
+

A QuotaStrategy is used when we want to set a limit to the amount of data that can be +stored on the server. +This can range from a limit for the whole server to a limit on a per pod basis. +The way the size of a resource is calculated is implemented by the implementing classes. +This can be bytes, quads, file count, ...

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
limit +reporter +
+
+

Methods

+
createQuotaGuard +estimateSize +getAvailableSpace +getTotalSpaceUsed +
+
+

Constructors

+
+

Protected constructor

+
+
+

Properties

+
+

Readonly limit

+
limit: Size
+
+

Readonly reporter

+
reporter: SizeReporter<unknown>
+
+

Methods

+
+

createQuotaGuard

+
    + +
  • +

    Get a Passthrough stream that will keep track of the available space. +If the quota is exceeded the stream will emit an error and destroy itself. +Like other Passthrough instances this will simply pass on the chunks, when the quota isn't exceeded.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Guarded<PassThrough>>

    a Passthrough instance that errors when quota is exceeded

    + +
+
+

estimateSize

+
    + +
  • +

    Get an estimated size of the resource

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<undefined | Size>

    a Size object containing the estimated size and unit of the resource

    + +
+
+

getAvailableSpace

+
    + +
  • +

    Get the available space when writing data to the given identifier. +If the given resource already exists it will deduct the already taken up +space by that resource since it is going to be overwritten and thus counts +as available space.

    +
    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      the identifier of the resource of which you want the available space

      +
      +
    +

    Returns Promise<Size>

    the available space and the unit of the space as a Size object

    + +
+
+

Protected Abstract getTotalSpaceUsed

+
    + +
  • +

    Get the currently used/occupied space.

    +
    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      the identifier that should be used to calculate the total

      +
      +
    +

    Returns Promise<Size>

    a Size object containing the requested value. +If quota is not relevant for this identifier, Size.amount should be Number.MAX_SAFE_INTEGER

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/QuotaValidator.html b/7.x/docs/classes/QuotaValidator.html new file mode 100644 index 000000000..09b2dbf3a --- /dev/null +++ b/7.x/docs/classes/QuotaValidator.html @@ -0,0 +1,190 @@ +QuotaValidator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class QuotaValidator

+
+

The QuotaValidator validates data streams by making sure they would not exceed the limits of a QuotaStrategy.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
strategy +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly strategy

+
strategy: QuotaStrategy
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: ValidatorInput
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RangeMetadataWriter.html b/7.x/docs/classes/RangeMetadataWriter.html new file mode 100644 index 000000000..d8027ba9a --- /dev/null +++ b/7.x/docs/classes/RangeMetadataWriter.html @@ -0,0 +1,195 @@ +RangeMetadataWriter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RangeMetadataWriter

+
+

Generates the necessary content-range header if there is range metadata. +If the start or end is unknown, a * will be used instead. +According to the RFC, this is incorrect, +but is all we can do as long as we don't know the full length of the representation in advance. +For the same reason, the total length of the representation will always be *.

+

This class also adds the content-length header. +This will contain either the full size for standard requests, +or the size of the slice for range requests.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RangeNotSatisfiedHttpError.html b/7.x/docs/classes/RangeNotSatisfiedHttpError.html new file mode 100644 index 000000000..e44053c3a --- /dev/null +++ b/7.x/docs/classes/RangeNotSatisfiedHttpError.html @@ -0,0 +1,237 @@ +RangeNotSatisfiedHttpError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RangeNotSatisfiedHttpError

+
+

An error thrown when the requested range is not supported.

+
+
+
+

Hierarchy

+
    +
  • BaseHttpError +
      +
    • RangeNotSatisfiedHttpError
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
cause? +errorCode +message +metadata +name +stack? +statusCode +isInstance +statusCode +uri +
+
+

Methods

+
generateMetadata +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Optional Readonly cause

+
cause?: unknown
+
+

Readonly errorCode

+
errorCode: string
+
+

message

+
message: string
+
+

Readonly metadata

+
metadata: RepresentationMetadata
+
+

name

+
name: string
+
+

Optional stack

+
stack?: string
+
+

Readonly statusCode

+
statusCode: 416
+
+

Static Readonly isInstance

+
isInstance: ((error) => error is HttpError<416>)
+
+

Type declaration

+
    +
  • +
      +
    • (error): error is HttpError<416>
      • +
    • +

      Checks whether the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: unknown
      +

      Returns error is HttpError<416>

      +
+
+

Static Readonly statusCode

+
statusCode: 416
+

The status code corresponding to this error class.

+
+
+
+

Static Readonly uri

+
uri: NamedNode<string>
+

A unique URI identifying this error class.

+
+
+
+

Methods

+
+

Protected generateMetadata

+
    + +
  • +

    Initializes the error metadata.

    +
    +

    Returns void

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RangePreferenceParser.html b/7.x/docs/classes/RangePreferenceParser.html new file mode 100644 index 000000000..d52285e94 --- /dev/null +++ b/7.x/docs/classes/RangePreferenceParser.html @@ -0,0 +1,181 @@ +RangePreferenceParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RangePreferenceParser

+
+

Parses the range header into range preferences. +If the range corresponds to a suffix-length range, it will be stored in start as a negative value.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: {
          request: HttpRequest;
      }
      +

      Input that could potentially be handled.

      +
      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RawBodyParser.html b/7.x/docs/classes/RawBodyParser.html new file mode 100644 index 000000000..810627094 --- /dev/null +++ b/7.x/docs/classes/RawBodyParser.html @@ -0,0 +1,183 @@ +RawBodyParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RawBodyParser

+
+

Converts incoming HttpRequest to a Representation without any further parsing.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: BodyParserArgs
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RdfPatcher.html b/7.x/docs/classes/RdfPatcher.html new file mode 100644 index 000000000..33a43d2d2 --- /dev/null +++ b/7.x/docs/classes/RdfPatcher.html @@ -0,0 +1,198 @@ +RdfPatcher | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RdfPatcher

+
+

Patcher that converts the representation data to a representation with an N3 store, does the patch using this store +and then converts the representation with store back to a representation with data which gets returned

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +patcher +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly patcher

+
patcher: RepresentationPatcher<RdfDatasetRepresentation>
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RdfStorePatcher.html b/7.x/docs/classes/RdfStorePatcher.html new file mode 100644 index 000000000..152c945be --- /dev/null +++ b/7.x/docs/classes/RdfStorePatcher.html @@ -0,0 +1,171 @@ +RdfStorePatcher | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RdfStorePatcherAbstract

+
+

Applies a Patch on an N3.js Store.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Store<Quad, Quad, Quad, Quad>>

    A promise resolving when handling is finished.

    + +
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Store<Quad, Quad, Quad, Quad>>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RdfToQuadConverter.html b/7.x/docs/classes/RdfToQuadConverter.html new file mode 100644 index 000000000..aec51ecea --- /dev/null +++ b/7.x/docs/classes/RdfToQuadConverter.html @@ -0,0 +1,231 @@ +RdfToQuadConverter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RdfToQuadConverter

+
+

Converts most major RDF serializations to internal/quads.

+

Custom contexts can be defined to be used when parsing JSON-LD. +The keys of the object should be the URL of the context, +and the values the file path of the contexts to use when the JSON-LD parser would fetch the given context. +We use filepaths because embedding them directly into the configurations breaks Components.js.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
documentLoader +inputTypes +outputTypes +
+
+

Methods

+
canHandle +getOutputTypes +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly documentLoader

+
documentLoader: ContextDocumentLoader
+
+

Protected inputTypes

+
inputTypes: Promise<ValuePreferences>
+
+

Protected outputTypes

+
outputTypes: Promise<ValuePreferences>
+
+

Methods

+
+

canHandle

+
+
+

getOutputTypes

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RdfValidator.html b/7.x/docs/classes/RdfValidator.html new file mode 100644 index 000000000..8e937ba4a --- /dev/null +++ b/7.x/docs/classes/RdfValidator.html @@ -0,0 +1,191 @@ +RdfValidator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RdfValidator

+
+

Validates a Representation by verifying if the data stream contains valid RDF data. +It does this by letting the stored RepresentationConverter convert the data.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
converter +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly converter

+
converter: RepresentationConverter
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: ValidatorInput
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ReadOnlyStore.html b/7.x/docs/classes/ReadOnlyStore.html new file mode 100644 index 000000000..1b6f4b6f0 --- /dev/null +++ b/7.x/docs/classes/ReadOnlyStore.html @@ -0,0 +1,313 @@ +ReadOnlyStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ReadOnlyStore<T>

+
+

Store that only allow read operations on the underlying source.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
source +
+
+

Methods

+
addResource +deleteResource +getRepresentation +hasResource +modifyResource +setRepresentation +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly source

+
source: T
+
+

Methods

+
+

addResource

+
+
+

deleteResource

+
+
+

getRepresentation

+
+
+

hasResource

+
+
+

modifyResource

+
+
+

setRepresentation

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RecordObject.html b/7.x/docs/classes/RecordObject.html new file mode 100644 index 000000000..383a1911f --- /dev/null +++ b/7.x/docs/classes/RecordObject.html @@ -0,0 +1,105 @@ +RecordObject | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RecordObject

+
+

Helper class for instantiating multiple objects with Components.js. +See https://github.com/LinkedSoftwareDependencies/Components.js/issues/26

+
+
+
+

Hierarchy

+
    +
  • RecordObject
+
+

Implements

+
    +
  • Record<string, unknown>
+
+

Indexable

+
[key: string]: unknown
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Constructors

+
+

constructor

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RedirectHttpError.html b/7.x/docs/classes/RedirectHttpError.html new file mode 100644 index 000000000..41566238d --- /dev/null +++ b/7.x/docs/classes/RedirectHttpError.html @@ -0,0 +1,279 @@ +RedirectHttpError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RedirectHttpError<TCode>

+
+

An error corresponding to a 3xx status code. +Includes the location it redirects to.

+
+
+
+

Type Parameters

+
    +
  • +

    TCode extends number = number

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
cause? +errorCode +location +message +metadata +name +stack? +statusCode +prepareStackTrace? +stackTraceLimit +
+
+

Methods

+
generateMetadata +captureStackTrace +isInstance +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Optional Readonly cause

+
cause?: unknown
+
+

Readonly errorCode

+
errorCode: string
+
+

Readonly location

+
location: string
+
+

message

+
message: string
+
+

Readonly metadata

+
metadata: RepresentationMetadata
+
+

name

+
name: string
+
+

Optional stack

+
stack?: string
+
+

Readonly statusCode

+
statusCode: TCode
+
+

Static Optional prepareStackTrace

+
prepareStackTrace?: ((err, stackTraces) => any)
+
+

Type declaration

+
+
+

Static stackTraceLimit

+
stackTraceLimit: number
+
+

Methods

+
+

Protected generateMetadata

+
+
+

Static captureStackTrace

+
    + +
  • +

    Create .stack property on a target object

    +
    +
    +

    Parameters

    +
      +
    • +
      targetObject: object
      • +
    • +
      Optional constructorOpt: Function
    +

    Returns void

    +
+
+

Static isInstance

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RedirectingErrorHandler.html b/7.x/docs/classes/RedirectingErrorHandler.html new file mode 100644 index 000000000..facebd574 --- /dev/null +++ b/7.x/docs/classes/RedirectingErrorHandler.html @@ -0,0 +1,172 @@ +RedirectingErrorHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RedirectingErrorHandler

+
+

Internally we create redirects by throwing specific RedirectHttpErrors. +This Error handler converts those to RedirectResponseDescriptions that are used for output.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      __namedParameters: ErrorHandlerArgs
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RedirectingHttpHandler.html b/7.x/docs/classes/RedirectingHttpHandler.html new file mode 100644 index 000000000..aeb235b42 --- /dev/null +++ b/7.x/docs/classes/RedirectingHttpHandler.html @@ -0,0 +1,286 @@ +RedirectingHttpHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RedirectingHttpHandler

+
+

Handler that redirects paths matching given patterns +to their corresponding URL, substituting selected groups.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
baseUrl +logger +redirects +responseWriter +statusCode +targetExtractor +
+
+

Methods

+
canHandle +findRedirect +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
    + +
  • +

    Creates a handler for the provided redirects.

    +
    +
    +

    Parameters

    +
      +
    • +
      redirects: Record<string, string>
      +

      A mapping between URL patterns.

      +
      +
      • +
    • +
      baseUrl: string
      +

      Base URL of the server.

      +
      +
      • +
    • +
      targetExtractor: TargetExtractor
      +

      To extract the target from the request.

      +
      +
      • +
    • +
      responseWriter: ResponseWriter
      +

      To write the redirect to the response.

      +
      +
      • +
    • +
      statusCode: 302 | 301 | 308 | 303 | 307 = 308
      +

      Desired 30x redirection code (defaults to 308).

      +
      +
    +

    Returns RedirectingHttpHandler

    +
+
+

Properties

+
+

Private Readonly baseUrl

+
baseUrl: string
+

Base URL of the server.

+
+
+
+

Private Readonly logger

+
logger: Logger = ...
+
+

Private Readonly redirects

+
redirects: {
    redirectPattern: string;
    regex: RegExp;
}[]
+
+

Type declaration

+
    +
  • +
    redirectPattern: string
    • +
  • +
    regex: RegExp
+
+

Private Readonly responseWriter

+
responseWriter: ResponseWriter
+

To write the redirect to the response.

+
+
+
+

Private Readonly statusCode

+
statusCode: 302 | 301 | 308 | 303 | 307 = 308
+

Desired 30x redirection code (defaults to 308).

+
+
+
+

Private Readonly targetExtractor

+
targetExtractor: TargetExtractor
+

To extract the target from the request.

+
+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      __namedParameters: HttpHandlerInput
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Private findRedirect

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RedisLocker.html b/7.x/docs/classes/RedisLocker.html new file mode 100644 index 000000000..3c158995d --- /dev/null +++ b/7.x/docs/classes/RedisLocker.html @@ -0,0 +1,488 @@ +RedisLocker | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RedisLocker

+
+

A Redis Locker that can be used as both:

+
    +
  • a Read Write Locker that uses a (single) Redis server to store the locks and counts.
    • +
  • a Resource Locker that uses a (single) Redis server to store the lock. +This solution should be process-safe. The only references to locks are string keys +derived from identifier paths.
    • +
+

The Read Write algorithm roughly goes as follows:

+
    +
  • Acquire a read lock: allowed as long as there is no write lock. On acquiring the read counter goes up.
    • +
  • Acquire a write lock: allowed as long as there is no other write lock AND the read counter is 0.
    • +
  • Release a read lock: decreases the read counter with 1
    • +
  • Release a write lock: unlocks the write lock
    • +
+

The Resource locking algorithm uses a single mutex/lock.

+

All operations, such as checking for a write lock AND read count, are executed in a single Lua script. +These scripts are used by Redis as a single new command. +Redis executes its operations in a single thread, as such, each such operation can be considered atomic.

+

The operation to (un)lock will always resolve with either 1/OK/true if succeeded or 0/false if not succeeded. +Rejection with errors will be happen on actual failures. Retrying the (un)lock operations will be done by making +use of the LockUtils' retryFunctionUntil function.

+
    +
  • +
+
+
+

See

+ +
+
+

Hierarchy

+
    +
  • RedisLocker
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
attemptSettings +finalized +logger +namespacePrefix +redis +redisLock +redisRw +
+
+

Methods

+
acquire +clearLocks +createRedisClient +finalize +getReadWriteKey +getResourceKey +initialize +release +swallowFalse +withReadLock +withWriteLock +
+
+

Constructors

+
+

constructor

+
    + +
  • +

    Creates a new RedisClient

    +
    +
    +

    Parameters

    +
      +
    • +
      redisClient: string = '127.0.0.1:6379'
      +

      Redis connection string of a standalone Redis node

      +
      +
      • +
    • +
      attemptSettings: AttemptSettings = {}
      +

      Override default AttemptSettings

      +
      +
      • +
    • +
      Optional redisSettings: RedisSettings
      +

      Addition settings used to create the Redis client or to interact with the Redis server

      +
      +
    +

    Returns RedisLocker

    +
+
+

Properties

+
+

Private Readonly attemptSettings

+
attemptSettings: Required<AttemptSettings>
+
+

Private finalized

+
finalized: boolean = false
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly namespacePrefix

+
namespacePrefix: string
+
+

Private Readonly redis

+
redis: Redis
+
+

Private Readonly redisLock

+
redisLock: RedisResourceLock
+
+

Private Readonly redisRw

+
redisRw: RedisReadWriteLock
+
+

Methods

+
+

acquire

+
+
+

Private clearLocks

+
+
+

Private createRedisClient

+
    + +
  • +

    Generate and return a RedisClient based on the provided string

    +
    +
    +

    Parameters

    +
      +
    • +
      redisClientString: string
      +

      A string that contains either a host address and a + port number like '127.0.0.1:6379' or just a port number like '6379'.

      +
      +
      • +
    • +
      options: Omit<RedisSettings, "namespacePrefix">
    +

    Returns Redis

    +
+
+

finalize

+
+
+

Private getReadWriteKey

+
    + +
  • +

    Create a scoped Redis key for Read-Write locking.

    +
    +
    +

    Parameters

    +
    +

    Returns string

    A scoped Redis key that allows cleanup afterwards without affecting other keys.

    + +
+
+

Private getResourceKey

+
    + +
  • +

    Create a scoped Redis key for Resource locking.

    +
    +
    +

    Parameters

    +
    +

    Returns string

    A scoped Redis key that allows cleanup afterwards without affecting other keys.

    + +
+
+

initialize

+
+
+

release

+
    + +
  • +

    Releases a lock on the requested identifier. +The promise will resolve when the lock has been released. +If there is no lock on the resource, an error should be thrown.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    +
+
+

Private swallowFalse

+
    + +
  • +

    Wrapper function for all (un)lock operations. If the fn() resolves to false (after applying +fromResp2ToBool, the result will be swallowed. When fn() resolves to true, this wrapper +will return true. Any error coming from fn() will be thrown.

    +
    +
    +

    Parameters

    +
      +
    • +
      fn: (() => Promise<RedisAnswer>)
      +

      The function reference to swallow false from.

      +
      +
      +
        +
      • +
          +
        • (): Promise<RedisAnswer>
          • +
        • +

          Returns Promise<RedisAnswer>

    +

    Returns (() => Promise<unknown>)

    +
      +
    • +
        +
      • (): Promise<unknown>
        • +
      • +

        Wrapper function for all (un)lock operations. If the fn() resolves to false (after applying +fromResp2ToBool, the result will be swallowed. When fn() resolves to true, this wrapper +will return true. Any error coming from fn() will be thrown.

        +
        +

        Returns Promise<unknown>

        +
    +
+
+

withReadLock

+
    + +
  • +

    Run the given function while the resource is locked. +The lock will be released when the (async) input function resolves. +This function should be used for operations that only require reading the resource.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
    +

    Returns Promise<T>

    A promise resolving when the lock is released.

    + +
+
+

withWriteLock

+
    + +
  • +

    Run the given function while the resource is locked. +The lock will be released when the (async) input function resolves. +This function should be used for operations that could modify the resource.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
    +

    Returns Promise<T>

    A promise resolving when the lock is released.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RegexRouterRule.html b/7.x/docs/classes/RegexRouterRule.html new file mode 100644 index 000000000..42fed3798 --- /dev/null +++ b/7.x/docs/classes/RegexRouterRule.html @@ -0,0 +1,256 @@ +RegexRouterRule | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RegexRouterRule

+
+

Routes requests to a store based on the path of the identifier. +The identifier will be stripped of the base URI after which regexes will be used to find the correct store. +The trailing slash of the base URI will still be present so the first character a regex can match would be that /. +This way regexes such as /container/ can match containers in any position.

+

In case none of the regexes match an error will be thrown.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
base +rules +
+
+

Methods

+
canHandle +handle +handleSafe +matchStore +toRelative +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly base

+
base: string
+
+

Private Readonly rules

+
rules: RegexRule[]
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+

Private matchStore

+
+
+

Private toRelative

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RegexRule.html b/7.x/docs/classes/RegexRule.html new file mode 100644 index 000000000..4cb408101 --- /dev/null +++ b/7.x/docs/classes/RegexRule.html @@ -0,0 +1,118 @@ +RegexRule | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RegexRule

+
+

Utility class to easily configure Regex to ResourceStore mappings in the config files.

+
+
+
+

Hierarchy

+
    +
  • RegexRule
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
regex +store +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly regex

+
regex: RegExp
+
+

Readonly store

+
store: ResourceStore
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RelativePathInteractionRoute.html b/7.x/docs/classes/RelativePathInteractionRoute.html new file mode 100644 index 000000000..10b386cdf --- /dev/null +++ b/7.x/docs/classes/RelativePathInteractionRoute.html @@ -0,0 +1,188 @@ +RelativePathInteractionRoute | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RelativePathInteractionRoute<TBase>

+
+

A route that is relative to another route. +The relative path will be joined to the input base, +which can either be an absolute URL or an InteractionRoute of which the path will be used.

+
+
+
+

Type Parameters

+
    +
  • +

    TBase extends string

+
+

Hierarchy

+
    +
  • RelativePathInteractionRoute
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
base +relativePath +
+
+

Methods

+
getPath +matchPath +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly base

+
base: InteractionRoute<TBase>
+
+

Private Readonly relativePath

+
relativePath: string
+
+

Methods

+
+

getPath

+
    + +
  • +

    Returns the path that is the result of having the specified values for the dynamic parameters.

    +

    Will throw an error in case the input parameters object is missing one of the expected keys.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional parameters: Record<TBase, string>
      +

      Values for the dynamic parameters.

      +
      +
    +

    Returns string

    +
+
+

matchPath

+
    + +
  • +

    Checks if the provided path matches the route (pattern).

    +

    The result will be undefined if there is no match.

    +

    If there is a match the result object will have the corresponding values for all the parameters.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      The path to verify.

      +
      +
    +

    Returns undefined | Record<TBase, string>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RepresentationConverter.html b/7.x/docs/classes/RepresentationConverter.html new file mode 100644 index 000000000..3909a925c --- /dev/null +++ b/7.x/docs/classes/RepresentationConverter.html @@ -0,0 +1,177 @@ +RepresentationConverter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RepresentationConverterAbstract

+
+

Converts a Representation from one media type to another, based on the given preferences.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RepresentationConvertingStore.html b/7.x/docs/classes/RepresentationConvertingStore.html new file mode 100644 index 000000000..461928974 --- /dev/null +++ b/7.x/docs/classes/RepresentationConvertingStore.html @@ -0,0 +1,379 @@ +RepresentationConvertingStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RepresentationConvertingStore<T>

+
+

Store that provides (optional) conversion of incoming and outgoing Representations.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
inConverter +inPreferences +logger +metadataStrategy +outConverter +source +
+
+

Methods

+
addResource +deleteResource +getRepresentation +hasResource +modifyResource +setRepresentation +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly inConverter

+
inConverter: RepresentationConverter
+
+

Private Readonly inPreferences

+
inPreferences: RepresentationPreferences
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly metadataStrategy

+
metadataStrategy: AuxiliaryStrategy
+
+

Private Readonly outConverter

+
outConverter: RepresentationConverter
+
+

Protected Readonly source

+
source: T
+
+

Methods

+
+

addResource

+
+
+

deleteResource

+
+
+

getRepresentation

+
+
+

hasResource

+
+
+

modifyResource

+
+
+

setRepresentation

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RepresentationMetadata.html b/7.x/docs/classes/RepresentationMetadata.html new file mode 100644 index 000000000..a1383d3e4 --- /dev/null +++ b/7.x/docs/classes/RepresentationMetadata.html @@ -0,0 +1,766 @@ +RepresentationMetadata | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RepresentationMetadata

+
+

Stores the metadata triples and provides methods for easy access. +Most functions return the metadata object to allow for chaining.

+
+
+
+

Hierarchy

+
    +
  • RepresentationMetadata
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
id +logger +store +
+
+

Accessors

+
contentLength +contentType +contentTypeObject +identifier +
+
+

Methods

+
add +addQuad +addQuads +forQuads +get +getAll +getContentType +has +quads +remove +removeAll +removeContentType +removeQuad +removeQuads +set +setContentType +setMetadata +setOverrides +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private id

+
id: BlankNode | NamedNode<string>
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private store

+
store: Store<Quad, Quad, Quad, Quad>
+
+

Accessors

+
+

contentLength

+
+
+

contentType

+
+
+

contentTypeObject

+
+
+

identifier

+
+
+

Methods

+
+

add

+
+
+

addQuad

+
+
+

addQuads

+
+
+

Private forQuads

+
    + +
  • +

    Helper function to simplify add/remove +Runs the given function on all predicate/object pairs, but only converts the predicate to a named node once.

    +
    +
    +

    Parameters

    +
      +
    • +
      predicate: NamedNode<string>
      • +
    • +
      object: MetadataValue
      • +
    • +
      forFn: ((pred, obj) => void)
      +
        +
      • +
          +
        • (pred, obj): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            pred: NamedNode<string>
            • +
          • +
            obj: BlankNode | Literal | NamedNode<string>
          +

          Returns void

    +

    Returns RepresentationMetadata

    +
+
+

get

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      predicate: NamedNode<string>
      +

      Predicate to get the value for.

      +
      +
      • +
    • +
      Optional graph: MetadataGraph
      +

      Optional graph where the triple should be found.

      +
      +
    +

    Returns undefined | Term

    The corresponding value. Undefined if there is no match

    + +
    +

    Throws

    Error +If there are multiple matching values.

    +
+
+

getAll

+
    + +
  • +

    Finds all object values matching the given predicate and/or graph.

    +
    +
    +

    Parameters

    +
      +
    • +
      predicate: NamedNode<string>
      +

      Optional predicate to get the values for.

      +
      +
      • +
    • +
      Optional graph: MetadataGraph
      +

      Optional graph where to get from.

      +
      +
    +

    Returns Term[]

    An array with all matches.

    + +
+
+

Private getContentType

+
    + +
  • +

    Parse the internal RDF structure to retrieve the Record with ContentType Parameters.

    +
    +

    Returns undefined | ContentType

    A ContentType object containing the value and optional parameters if there is one.

    + +
+
+

has

+
    + +
  • +

    Verifies if a specific triple can be found in the metadata. +Undefined parameters are interpreted as wildcards.

    +
    +
    +

    Parameters

    +
      +
    • +
      predicate: null | string | NamedNode<string> = null
      • +
    • +
      object: null | string | BlankNode | Literal | NamedNode<string> = null
      • +
    • +
      graph: null | MetadataGraph = null
    +

    Returns boolean

    +
+
+

quads

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      subject: null | string | BlankNode | NamedNode<string> = null
      • +
    • +
      predicate: null | NamedNode<string> = null
      • +
    • +
      object: null | string | BlankNode | Literal | NamedNode<string> = null
      • +
    • +
      graph: null | MetadataGraph = null
    +

    Returns Quad[]

    All matching metadata quads.

    + +
+
+

remove

+
+
+

removeAll

+
+
+

Private removeContentType

+
+
+

removeQuad

+
+
+

removeQuads

+
+
+

set

+
+
+

Private setContentType

+
+
+

setMetadata

+
+
+

Private setOverrides

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RepresentationPatchHandler.html b/7.x/docs/classes/RepresentationPatchHandler.html new file mode 100644 index 000000000..9d9a0c2cd --- /dev/null +++ b/7.x/docs/classes/RepresentationPatchHandler.html @@ -0,0 +1,200 @@ +RepresentationPatchHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RepresentationPatchHandler

+
+

Handles a patch operation by getting the representation from the store, applying a RepresentationPatcher, +and then writing the result back to the store.

+

In case there is no original representation (the store throws a NotFoundHttpError), +the patcher is expected to create a new one.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +patcher +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly patcher

+
patcher: RepresentationPatcher<Representation>
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RepresentationPatcher.html b/7.x/docs/classes/RepresentationPatcher.html new file mode 100644 index 000000000..b527820f5 --- /dev/null +++ b/7.x/docs/classes/RepresentationPatcher.html @@ -0,0 +1,187 @@ +RepresentationPatcher | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RepresentationPatcher<T>Abstract

+
+

Handles the patching of a specific Representation.

+
+
+
+

Type Parameters

+
    +
  • +

    T

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RequestParser.html b/7.x/docs/classes/RequestParser.html new file mode 100644 index 000000000..e92dc8f6f --- /dev/null +++ b/7.x/docs/classes/RequestParser.html @@ -0,0 +1,173 @@ +RequestParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RequestParserAbstract

+
+

Converts an incoming HttpRequest to an Operation.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: HttpRequest
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ResetPasswordHandler.html b/7.x/docs/classes/ResetPasswordHandler.html new file mode 100644 index 000000000..ebb898ccf --- /dev/null +++ b/7.x/docs/classes/ResetPasswordHandler.html @@ -0,0 +1,242 @@ +ResetPasswordHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ResetPasswordHandler

+
+

Resets a password if a valid recordId is provided, +which should have been generated by a different handler.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
forgotPasswordStore +logger +passwordStore +
+
+

Methods

+
canHandle +getView +handle +handleSafe +resetPassword +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly forgotPasswordStore

+
forgotPasswordStore: ForgotPasswordStore
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly passwordStore

+
passwordStore: PasswordStore
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

getView

+
+
+

handle

+
+
+

handleSafe

+
+
+

Private resetPassword

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ResetResponseDescription.html b/7.x/docs/classes/ResetResponseDescription.html new file mode 100644 index 000000000..46de6e699 --- /dev/null +++ b/7.x/docs/classes/ResetResponseDescription.html @@ -0,0 +1,124 @@ +ResetResponseDescription | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ResetResponseDescription

+
+

Corresponds to a 205 response.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
data? +metadata? +statusCode +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Optional data

+
data?: Guarded<Readable>
+
+

Optional metadata

+
metadata?: RepresentationMetadata
+
+

statusCode

+
statusCode: number
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ResolveLoginHandler.html b/7.x/docs/classes/ResolveLoginHandler.html new file mode 100644 index 000000000..ddd0d671f --- /dev/null +++ b/7.x/docs/classes/ResolveLoginHandler.html @@ -0,0 +1,258 @@ +ResolveLoginHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ResolveLoginHandlerAbstract

+
+

A handler that takes care of all the necessary steps when logging a user in, +such as generating a cookie and setting the necessary OIDC information. +Classes that resolve login methods should extend this class and implement the login method.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
accountStore +cookieStore +logger +
+
+

Methods

+
canHandle +handle +handleSafe +login +updateRememberSetting +
+
+

Constructors

+
+

Protected constructor

+
+
+

Properties

+
+

Protected Readonly accountStore

+
accountStore: AccountStore
+
+

Protected Readonly cookieStore

+
cookieStore: CookieStore
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+

Abstract login

+
+
+

Protected updateRememberSetting

+
    + +
  • +

    Updates the account setting that determines whether the login status needs to be remembered.

    +
    +
    +

    Parameters

    +
      +
    • +
      accountId: string
      +

      ID of the account.

      +
      +
      • +
    • +
      Optional remember: boolean
      +

      If the account should be remembered or not. The setting will not be updated if this is undefined.

      +
      +
    +

    Returns Promise<void>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ResponseDescription.html b/7.x/docs/classes/ResponseDescription.html new file mode 100644 index 000000000..a58d565f7 --- /dev/null +++ b/7.x/docs/classes/ResponseDescription.html @@ -0,0 +1,142 @@ +ResponseDescription | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ResponseDescription

+
+

The result of executing an operation.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
data? +metadata? +statusCode +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Optional data

+
data?: Guarded<Readable>
+
+

Optional metadata

+
metadata?: RepresentationMetadata
+
+

statusCode

+
statusCode: number
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ResponseWriter.html b/7.x/docs/classes/ResponseWriter.html new file mode 100644 index 000000000..34c59ee38 --- /dev/null +++ b/7.x/docs/classes/ResponseWriter.html @@ -0,0 +1,188 @@ +ResponseWriter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ResponseWriterAbstract

+
+

Writes the ResponseDescription to the HttpResponse.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RootFilePathHandler.html b/7.x/docs/classes/RootFilePathHandler.html new file mode 100644 index 000000000..3b70f042e --- /dev/null +++ b/7.x/docs/classes/RootFilePathHandler.html @@ -0,0 +1,206 @@ +RootFilePathHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RootFilePathHandler

+
+

Uses a FileIdentifierMapper to generate a root file path variable based on the identifier. +Will throw an error if the resulting file path already exists.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
fileMapper +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly fileMapper

+
fileMapper: FileIdentifierMapper
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RootStorageLocationStrategy.html b/7.x/docs/classes/RootStorageLocationStrategy.html new file mode 100644 index 000000000..3ed30346b --- /dev/null +++ b/7.x/docs/classes/RootStorageLocationStrategy.html @@ -0,0 +1,133 @@ +RootStorageLocationStrategy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RootStorageLocationStrategy

+
+

A StorageLocationStrategy to be used when the server has one storage in the root container of the server.

+
+
+
+

Hierarchy

+
    +
  • RootStorageLocationStrategy
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
root +
+
+

Methods

+
getStorageIdentifier +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly root

+
root: ResourceIdentifier
+
+

Methods

+
+

getStorageIdentifier

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RouterHandler.html b/7.x/docs/classes/RouterHandler.html new file mode 100644 index 000000000..4db8429da --- /dev/null +++ b/7.x/docs/classes/RouterHandler.html @@ -0,0 +1,251 @@ +RouterHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RouterHandler

+
+

A BaseRouterHandler for an HttpHandler. +Uses a TargetExtractor to generate the target identifier.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
allMethods +allowedMethods +allowedPathNamesRegEx +baseUrlLength +handler +targetExtractor +
+
+

Methods

+
canHandle +canHandleInput +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly allMethods

+
allMethods: boolean
+
+

Protected Readonly allowedMethods

+
allowedMethods: string[]
+
+

Protected Readonly allowedPathNamesRegEx

+
allowedPathNamesRegEx: RegExp[]
+
+

Protected Readonly baseUrlLength

+
baseUrlLength: number
+
+

Protected Readonly handler

+
handler: HttpHandler
+
+

Private Readonly targetExtractor

+
targetExtractor: TargetExtractor
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Protected canHandleInput

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RouterRule.html b/7.x/docs/classes/RouterRule.html new file mode 100644 index 000000000..1601cc971 --- /dev/null +++ b/7.x/docs/classes/RouterRule.html @@ -0,0 +1,191 @@ +RouterRule | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RouterRuleAbstract

+
+

Finds which store needs to be accessed for the given resource, +potentially based on the Representation of incoming data.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RoutingAuxiliaryIdentifierStrategy.html b/7.x/docs/classes/RoutingAuxiliaryIdentifierStrategy.html new file mode 100644 index 000000000..86d8063f7 --- /dev/null +++ b/7.x/docs/classes/RoutingAuxiliaryIdentifierStrategy.html @@ -0,0 +1,227 @@ +RoutingAuxiliaryIdentifierStrategy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RoutingAuxiliaryIdentifierStrategy

+
+

An AuxiliaryIdentifierStrategy that combines multiple AuxiliaryIdentifierStrategies into one. +Uses isAuxiliaryIdentifier to know which strategy to route to.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
sources +
+
+

Methods

+
getAuxiliaryIdentifier +getAuxiliaryIdentifiers +getMatchingSource +getSubjectIdentifier +isAuxiliaryIdentifier +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly sources

+
sources: AuxiliaryIdentifierStrategy[]
+
+

Methods

+
+

getAuxiliaryIdentifier

+
+
+

getAuxiliaryIdentifiers

+
+
+

Protected getMatchingSource

+
+
+

getSubjectIdentifier

+
+
+

isAuxiliaryIdentifier

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RoutingAuxiliaryStrategy.html b/7.x/docs/classes/RoutingAuxiliaryStrategy.html new file mode 100644 index 000000000..da7d5bf1b --- /dev/null +++ b/7.x/docs/classes/RoutingAuxiliaryStrategy.html @@ -0,0 +1,334 @@ +RoutingAuxiliaryStrategy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RoutingAuxiliaryStrategy

+
+

An AuxiliaryStrategy that combines multiple AuxiliaryStrategies into one. +Uses isAuxiliaryIdentifier to know which strategy to call for which call.

+

addMetadata will either call all strategies if the input is the subject identifier, +or only the matching strategy if the input is an auxiliary identifier.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
sources +
+
+

Methods

+
addMetadata +getAuxiliaryIdentifier +getAuxiliaryIdentifiers +getMatchingSource +getSubjectIdentifier +isAuxiliaryIdentifier +isRequiredInRoot +usesOwnAuthorization +validate +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly sources

+
sources: AuxiliaryStrategy[] = []
+
+

Methods

+
+

addMetadata

+
    + +
  • +

    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 subject 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 subject identifier.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    +
+
+

getAuxiliaryIdentifier

+
+
+

getAuxiliaryIdentifiers

+
+
+

Protected getMatchingSource

+
+
+

getSubjectIdentifier

+
+
+

isAuxiliaryIdentifier

+
+
+

isRequiredInRoot

+
+
+

usesOwnAuthorization

+
+
+

validate

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/RoutingResourceStore.html b/7.x/docs/classes/RoutingResourceStore.html new file mode 100644 index 000000000..bbe0f5c1e --- /dev/null +++ b/7.x/docs/classes/RoutingResourceStore.html @@ -0,0 +1,322 @@ +RoutingResourceStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class RoutingResourceStore

+
+

Store that routes the incoming request to a specific store based on the stored ResourceRouter. +In case no store was found for one of the functions that take no data (GET/PATCH/DELETE), +a 404 will be thrown. In the other cases the error of the router will be thrown (which would probably be 400).

+
+
+
+

Hierarchy

+
    +
  • RoutingResourceStore
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
rule +
+
+

Methods

+
addResource +deleteResource +getRepresentation +getStore +hasResource +modifyResource +setRepresentation +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly rule

+
rule: RouterRule
+
+

Methods

+
+

addResource

+
+
+

deleteResource

+
+
+

getRepresentation

+
+
+

Private getStore

+
+
+

hasResource

+
+
+

modifyResource

+
+
+

setRepresentation

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SafeErrorHandler.html b/7.x/docs/classes/SafeErrorHandler.html new file mode 100644 index 000000000..7c97037bc --- /dev/null +++ b/7.x/docs/classes/SafeErrorHandler.html @@ -0,0 +1,207 @@ +SafeErrorHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SafeErrorHandler

+
+

Returns a simple text description of an error. +This class is a failsafe in case the wrapped error handler fails.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
errorHandler +logger +showStackTrace +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly errorHandler

+
errorHandler: ErrorHandler
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly showStackTrace

+
showStackTrace: boolean
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SeededAccountInitializer.html b/7.x/docs/classes/SeededAccountInitializer.html new file mode 100644 index 000000000..749ae52fc --- /dev/null +++ b/7.x/docs/classes/SeededAccountInitializer.html @@ -0,0 +1,212 @@ +SeededAccountInitializer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SeededAccountInitializer

+
+

Initializes a set of accounts based on the input data. +These accounts have exactly 1 email/password login method, and 0 or more pods. +The pod settings that can be defined are identical to those of the CreatePodHandler.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
accountStore +configFilePath? +logger +passwordStore +podCreator +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly accountStore

+
accountStore: AccountStore
+
+

Private Optional Readonly configFilePath

+
configFilePath?: string
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly passwordStore

+
passwordStore: PasswordStore
+
+

Private Readonly podCreator

+
podCreator: PodCreator
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      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.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SequenceHandler.html b/7.x/docs/classes/SequenceHandler.html new file mode 100644 index 000000000..7023ff4ef --- /dev/null +++ b/7.x/docs/classes/SequenceHandler.html @@ -0,0 +1,206 @@ +SequenceHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SequenceHandler<TIn, TOut>

+
+

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.

+
+
+
+

Type Parameters

+
    +
  • +

    TIn = void

    • +
  • +

    TOut = void

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
handlers +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly handlers

+
handlers: AsyncHandler<TIn, TOut>[]
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<undefined | TOut>

    A promise resolving when handling is finished.

    + +
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<undefined | TOut>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ServerConfigurator.html b/7.x/docs/classes/ServerConfigurator.html new file mode 100644 index 000000000..0a1b109f7 --- /dev/null +++ b/7.x/docs/classes/ServerConfigurator.html @@ -0,0 +1,174 @@ +ServerConfigurator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ServerConfiguratorAbstract

+
+

Configures a Server by attaching listeners for specific events.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Server<typeof IncomingMessage, typeof ServerResponse>
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Server<typeof IncomingMessage, typeof ServerResponse>
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving when handling is finished.

    + +
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Server<typeof IncomingMessage, typeof ServerResponse>
      +

      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.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ServerInitializer.html b/7.x/docs/classes/ServerInitializer.html new file mode 100644 index 000000000..a77c0b059 --- /dev/null +++ b/7.x/docs/classes/ServerInitializer.html @@ -0,0 +1,229 @@ +ServerInitializer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ServerInitializer

+
+

Creates and starts an HTTP server.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +port? +server? +serverFactory +socketPath? +
+
+

Methods

+
canHandle +finalize +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Optional Readonly port

+
port?: number
+
+

Private Optional server

+
server?: Server<typeof IncomingMessage, typeof ServerResponse>
+
+

Private Readonly serverFactory

+
serverFactory: HttpServerFactory
+
+

Private Optional Readonly socketPath

+
socketPath?: string
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

finalize

+
+
+

handle

+
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      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.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ShorthandExtractor.html b/7.x/docs/classes/ShorthandExtractor.html new file mode 100644 index 000000000..c75747617 --- /dev/null +++ b/7.x/docs/classes/ShorthandExtractor.html @@ -0,0 +1,175 @@ +ShorthandExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ShorthandExtractorAbstract

+
+

A handler that computes a specific value from a given map of values.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Shorthand
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Shorthand
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<unknown>

    A promise resolving when handling is finished.

    + +
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Shorthand
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<unknown>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ShorthandResolver.html b/7.x/docs/classes/ShorthandResolver.html new file mode 100644 index 000000000..0076d1226 --- /dev/null +++ b/7.x/docs/classes/ShorthandResolver.html @@ -0,0 +1,175 @@ +ShorthandResolver | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ShorthandResolverAbstract

+
+

Converts a key/value object, extracted from the CLI or passed as a parameter, +into a new key/value object where the keys are variables defined in the Components.js configuration. +The resulting values are the values that should be assigned to those variables.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Shorthand
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Shorthand
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<VariableBindings>

    A promise resolving when handling is finished.

    + +
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Shorthand
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<VariableBindings>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SingleContainerJsonStorage.html b/7.x/docs/classes/SingleContainerJsonStorage.html new file mode 100644 index 000000000..1085003bb --- /dev/null +++ b/7.x/docs/classes/SingleContainerJsonStorage.html @@ -0,0 +1,334 @@ +SingleContainerJsonStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SingleContainerJsonStorage<T>

+
+

A variant of a JsonResourceStorage where the entries() call +does not recursively iterate through all containers. +Only the documents that are found in the root container are returned.

+

This class was created to support migration where different storages are nested in one main .internal container, +and we specifically want to only return entries of one storage.

+
+
+
+

Type Parameters

+
    +
  • +

    T

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
container +logger +source +
+
+

Methods

+
delete +entries +get +getResourceEntries +has +identifierToKey +keyToIdentifier +safelyGetResource +set +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly container

+
container: string
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Protected Readonly source

+
source: ResourceStore
+
+

Methods

+
+

delete

+
+
+

entries

+
+
+

get

+
+
+

Protected getResourceEntries

+
+
+

has

+
+
+

Protected identifierToKey

+
+
+

Protected keyToIdentifier

+
+
+

Protected safelyGetResource

+
+
+

set

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SingleRootIdentifierStrategy.html b/7.x/docs/classes/SingleRootIdentifierStrategy.html new file mode 100644 index 000000000..5951d486e --- /dev/null +++ b/7.x/docs/classes/SingleRootIdentifierStrategy.html @@ -0,0 +1,213 @@ +SingleRootIdentifierStrategy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SingleRootIdentifierStrategy

+
+

An IdentifierStrategy that assumes there is only 1 root and all other identifiers are made by appending to that root.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
baseUrl +logger +
+
+

Methods

+
contains +getParentContainer +isRootContainer +supportsIdentifier +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly baseUrl

+
baseUrl: string
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Methods

+
+

contains

+
+
+

getParentContainer

+
+
+

isRootContainer

+
+
+

supportsIdentifier

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SliceStream.html b/7.x/docs/classes/SliceStream.html new file mode 100644 index 000000000..900de0e48 --- /dev/null +++ b/7.x/docs/classes/SliceStream.html @@ -0,0 +1,4044 @@ +SliceStream | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SliceStream

+
+

A stream that slices a part out of another stream. +start and end are inclusive. +If end is not defined it is until the end of the stream.

+

Negative start values can be used to instead slice that many streams off the end of the stream. +This requires the size field to be defined.

+

Both object and non-object streams are supported. +This needs to be explicitly specified, +as the class makes no assumptions based on the object mode of the source stream.

+
+
+
+

Hierarchy

+
    +
  • Transform +
      +
    • SliceStream
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
allowHalfOpen +closed +destroyed +errored +readable +readableAborted +readableDidRead +readableEncoding +readableEnded +readableFlowing +readableHighWaterMark +readableLength +readableObjectMode +remainingRead +remainingSkip +source +writable +writableCorked +writableEnded +writableFinished +writableHighWaterMark +writableLength +writableNeedDrain +writableObjectMode +captureRejectionSymbol +captureRejections +defaultMaxListeners +errorMonitor +
+
+

Methods

+
[asyncDispose] +[asyncIterator] +[captureRejectionSymbol]? +_construct? +_destroy +_final +_flush +_read +_transform +_write +_writev? +addListener +asIndexedPairs +binarySlice +checkEnd +compose +cork +destroy +drop +emit +end +eventNames +every +filter +find +flatMap +forEach +getMaxListeners +isPaused +iterator +listenerCount +listeners +map +objectSlice +off +on +once +pause +pipe +prependListener +prependOnceListener +push +rawListeners +read +reduce +removeAllListeners +removeListener +resume +setDefaultEncoding +setEncoding +setMaxListeners +some +take +toArray +uncork +unpipe +unshift +wrap +write +addAbortListener +from +fromWeb +getEventListeners +getMaxListeners +isDisturbed +listenerCount +on +once +setMaxListeners +toWeb +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

allowHalfOpen

+
allowHalfOpen: boolean
+

If false then the stream will automatically end the writable side when the +readable side ends. Set initially by the allowHalfOpen constructor option, +which defaults to false.

+

This can be changed manually to change the half-open behavior of an existingDuplex stream instance, but must be changed before the 'end' event is +emitted.

+
+
+

Since

v0.9.4

+
+
+

Readonly closed

+
closed: boolean
+
+

destroyed

+
destroyed: boolean
+

Is true after readable.destroy() has been called.

+
+
+

Since

v8.0.0

+
+
+

Readonly errored

+
errored: null | Error
+
+

readable

+
readable: boolean
+

Is true if it is safe to call readable.read(), which means +the stream has not been destroyed or emitted 'error' or 'end'.

+
+
+

Since

v11.4.0

+
+
+

Readonly Experimental readableAborted

+
readableAborted: boolean
+

Returns whether the stream was destroyed or errored before emitting 'end'.

+
+
+

Since

v16.8.0

+
+
+

Readonly Experimental readableDidRead

+
readableDidRead: boolean
+

Returns whether 'data' has been emitted.

+
+
+

Since

v16.7.0, v14.18.0

+
+
+

Readonly readableEncoding

+
readableEncoding: null | BufferEncoding
+

Getter for the property encoding of a given Readable stream. The encodingproperty can be set using the readable.setEncoding() method.

+
+
+

Since

v12.7.0

+
+
+

Readonly readableEnded

+
readableEnded: boolean
+

Becomes true when 'end' event is emitted.

+
+
+

Since

v12.9.0

+
+
+

Readonly readableFlowing

+
readableFlowing: null | boolean
+

This property reflects the current state of a Readable stream as described +in the Three states section.

+
+
+

Since

v9.4.0

+
+
+

Readonly readableHighWaterMark

+
readableHighWaterMark: number
+

Returns the value of highWaterMark passed when creating this Readable.

+
+
+

Since

v9.3.0

+
+
+

Readonly readableLength

+
readableLength: number
+

This property contains the number of bytes (or objects) in the queue +ready to be read. The value provides introspection data regarding +the status of the highWaterMark.

+
+
+

Since

v9.4.0

+
+
+

Readonly readableObjectMode

+
readableObjectMode: boolean
+

Getter for the property objectMode of a given Readable stream.

+
+
+

Since

v12.3.0

+
+
+

Protected remainingRead

+
remainingRead: number
+
+

Protected remainingSkip

+
remainingSkip: number
+
+

Protected Readonly source

+
source: Readable
+
+

Readonly writable

+
writable: boolean
+
+

Readonly writableCorked

+
writableCorked: number
+
+

Readonly writableEnded

+
writableEnded: boolean
+
+

Readonly writableFinished

+
writableFinished: boolean
+
+

Readonly writableHighWaterMark

+
writableHighWaterMark: number
+
+

Readonly writableLength

+
writableLength: number
+
+

Readonly writableNeedDrain

+
writableNeedDrain: boolean
+
+

Readonly writableObjectMode

+
writableObjectMode: boolean
+
+

Static Readonly captureRejectionSymbol

+
captureRejectionSymbol: typeof captureRejectionSymbol
+
+

Static captureRejections

+
captureRejections: boolean
+

Sets or gets the default captureRejection value for all emitters.

+
+
+
+

Static defaultMaxListeners

+
defaultMaxListeners: number
+
+

Static Readonly errorMonitor

+
errorMonitor: typeof 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.

+
+
+
+

Methods

+
+

[asyncDispose]

+
    +
  • [asyncDispose](): Promise<void>
    • +
  • +

    Calls readable.destroy() with an AbortError and returns a promise that fulfills when the stream is finished.

    +
    +

    Returns Promise<void>

    +
    +

    Since

    v18.18.0

    +
+
+

[asyncIterator]

+
    +
  • [asyncIterator](): AsyncIterableIterator<any>
    • +
  • +

    Returns AsyncIterableIterator<any>

+
+

Optional [captureRejectionSymbol]

+
    +
  • [captureRejectionSymbol](error, event, ...args): void
    • +
  • +
    +

    Parameters

    +
      +
    • +
      error: Error
      • +
    • +
      event: string
      • +
    • +
      Rest ...args: any[]
    +

    Returns void

+
+

Optional _construct

+
    +
  • _construct(callback): void
    • +
  • +
    +

    Parameters

    +
      +
    • +
      callback: ((error?) => void)
      +
        +
      • +
          +
        • (error?): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Optional error: null | Error
          +

          Returns void

    +

    Returns void

+
+

_destroy

+
    +
  • _destroy(error, callback): void
    • +
  • +
    +

    Parameters

    +
      +
    • +
      error: null | Error
      • +
    • +
      callback: ((error) => void)
      +
        +
      • +
          +
        • (error): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            error: null | Error
          +

          Returns void

    +

    Returns void

+
+

_final

+
    +
  • _final(callback): void
    • +
  • +
    +

    Parameters

    +
      +
    • +
      callback: ((error?) => void)
      +
        +
      • +
          +
        • (error?): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Optional error: null | Error
          +

          Returns void

    +

    Returns void

+
+

_flush

+
    +
  • _flush(callback): void
    • +
  • +
    +

    Parameters

    +
      +
    • +
      callback: TransformCallback
    +

    Returns void

+
+

_read

+
    +
  • _read(size): void
    • +
  • +
    +

    Parameters

    +
      +
    • +
      size: number
    +

    Returns void

+
+

_transform

+
    +
  • _transform(chunk, encoding, callback): void
    • +
  • +
    +

    Parameters

    +
      +
    • +
      chunk: unknown
      • +
    • +
      encoding: BufferEncoding
      • +
    • +
      callback: TransformCallback
    +

    Returns void

+
+

_write

+
    +
  • _write(chunk, encoding, callback): void
    • +
  • +
    +

    Parameters

    +
      +
    • +
      chunk: any
      • +
    • +
      encoding: BufferEncoding
      • +
    • +
      callback: ((error?) => void)
      +
        +
      • +
          +
        • (error?): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Optional error: null | Error
          +

          Returns void

    +

    Returns void

+
+

Optional _writev

+
    +
  • _writev(chunks, callback): void
    • +
  • +
    +

    Parameters

    +
      +
    • +
      chunks: {
          chunk: any;
          encoding: BufferEncoding;
      }[]
      • +
    • +
      callback: ((error?) => void)
      +
        +
      • +
          +
        • (error?): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Optional error: null | Error
          +

          Returns void

    +

    Returns void

+
+

addListener

+
    + +
  • +

    Event emitter +The defined events on documents including:

    +
      +
    1. close
      2. +
    2. data
      3. +
    3. drain
      4. +
    4. end
      5. +
    5. error
      6. +
    6. finish
      7. +
    7. pause
      8. +
    8. pipe
      9. +
    9. readable
      10. +
    10. resume
      11. +
    11. unpipe
      12. +
    +
    +
    +

    Parameters

    +
      +
    • +
      event: "close"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    +
    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "data"
      • +
    • +
      listener: ((chunk) => void)
      +
        +
      • +
          +
        • (chunk): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            chunk: any
          +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "drain"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "end"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "error"
      • +
    • +
      listener: ((err) => void)
      +
        +
      • +
          +
        • (err): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            err: Error
          +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "finish"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "pause"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "pipe"
      • +
    • +
      listener: ((src) => void)
      +
        +
      • +
          +
        • (src): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            src: Readable
          +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "readable"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "resume"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "unpipe"
      • +
    • +
      listener: ((src) => void)
      +
        +
      • +
          +
        • (src): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            src: Readable
          +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: string | symbol
      • +
    • +
      listener: ((...args) => void)
      +
        +
      • +
          +
        • (...args): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
          +

          Returns void

    +

    Returns SliceStream

+
+

asIndexedPairs

+
    + +
  • +

    This method returns a new stream with chunks of the underlying stream paired with a counter +in the form [index, chunk]. The first index value is 0 and it increases by 1 for each chunk produced.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional options: Pick<ArrayOptions, "signal">
    +

    Returns Readable

    a stream of indexed pairs.

    + +
    +

    Since

    v17.5.0

    +
+
+

Protected binarySlice

+
+
+

Protected checkEnd

+
    + +
  • +

    Stop piping the source stream and close everything once the slice is finished.

    +
    +

    Returns void

    +
+
+

compose

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T extends ReadableStream

    +
    +

    Parameters

    +
      +
    • +
      stream: ComposeFnParam | T | Iterable<T> | AsyncIterable<T>
      • +
    • +
      Optional options: {
          signal: AbortSignal;
      }
      +
        +
      • +
        signal: AbortSignal
    +

    Returns T

+
+

cork

+
    + +
  • +

    Returns void

+
+

destroy

+
    + +
  • +

    Destroy the stream. Optionally emit an 'error' event, and emit a 'close'event (unless emitClose is set to false). After this call, the readable +stream will release any internal resources and subsequent calls to push()will be ignored.

    +

    Once destroy() has been called any further calls will be a no-op and no +further errors except from _destroy() may be emitted as 'error'.

    +

    Implementors should not override this method, but instead implement readable._destroy().

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional error: Error
      +

      Error which will be passed as payload in 'error' event

      +
      +
    +

    Returns SliceStream

    +
    +

    Since

    v8.0.0

    +
+
+

drop

+
    + +
  • +

    This method returns a new stream with the first limit chunks dropped from the start.

    +
    +
    +

    Parameters

    +
      +
    • +
      limit: number
      +

      the number of chunks to drop from the readable.

      +
      +
      • +
    • +
      Optional options: Pick<ArrayOptions, "signal">
    +

    Returns Readable

    a stream with limit chunks dropped from the start.

    + +
    +

    Since

    v17.5.0

    +
+
+

emit

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "close"
    +

    Returns boolean

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "data"
      • +
    • +
      chunk: any
    +

    Returns boolean

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "drain"
    +

    Returns boolean

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "end"
    +

    Returns boolean

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "error"
      • +
    • +
      err: Error
    +

    Returns boolean

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "finish"
    +

    Returns boolean

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "pause"
    +

    Returns boolean

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "pipe"
      • +
    • +
      src: Readable
    +

    Returns boolean

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "readable"
    +

    Returns boolean

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "resume"
    +

    Returns boolean

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "unpipe"
      • +
    • +
      src: Readable
    +

    Returns boolean

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: string | symbol
      • +
    • +
      Rest ...args: any[]
    +

    Returns boolean

+
+

end

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      Optional cb: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      chunk: any
      • +
    • +
      Optional cb: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      chunk: any
      • +
    • +
      Optional encoding: BufferEncoding
      • +
    • +
      Optional cb: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

+
+

eventNames

+
    + +
  • +

    Returns an array listing the events for which the emitter has registered +listeners. The values in the array are strings or Symbols.

    +
    const EventEmitter = require('events');
    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});

    const sym = Symbol('symbol');
    myEE.on(sym, () => {});

    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]
+
    +
    +

    Returns (string | symbol)[]

    +
    +

    Since

    v6.0.0

    +
+
+

every

+
    + +
  • +

    This method is similar to Array.prototype.every and calls fn on each chunk in the stream +to check if all awaited return values are truthy value for fn. Once an fn call on a chunk +awaited return value is falsy, the stream is destroyed and the promise is fulfilled with false. +If all of the fn calls on the chunks return a truthy value, the promise is fulfilled with true.

    +
    +
    +

    Parameters

    +
      +
    • +
      fn: ((data, options?) => boolean | Promise<boolean>)
      +

      a function to call on each chunk of the stream. Async or not.

      +
      +
      +
        +
      • +
          +
        • (data, options?): boolean | Promise<boolean>
          • +
        • +
          +

          Parameters

          +
            +
          • +
            data: any
            • +
          • +
            Optional options: Pick<ArrayOptions, "signal">
          +

          Returns boolean | Promise<boolean>

      • +
    • +
      Optional options: ArrayOptions
    +

    Returns Promise<boolean>

    a promise evaluating to true if fn returned a truthy value for every one of the chunks.

    + +
    +

    Since

    v17.5.0

    +
+
+

filter

+
    + +
  • +

    This method allows filtering the stream. For each chunk in the stream the fn function will be called +and if it returns a truthy value, the chunk will be passed to the result stream. +If the fn function returns a promise - that promise will be awaited.

    +
    +
    +

    Parameters

    +
      +
    • +
      fn: ((data, options?) => boolean | Promise<boolean>)
      +

      a function to filter chunks from the stream. Async or not.

      +
      +
      +
        +
      • +
          +
        • (data, options?): boolean | Promise<boolean>
          • +
        • +
          +

          Parameters

          +
            +
          • +
            data: any
            • +
          • +
            Optional options: Pick<ArrayOptions, "signal">
          +

          Returns boolean | Promise<boolean>

      • +
    • +
      Optional options: ArrayOptions
    +

    Returns Readable

    a stream filtered with the predicate fn.

    + +
    +

    Since

    v17.4.0, v16.14.0

    +
+
+

find

+
    + +
  • +

    This method is similar to Array.prototype.find and calls fn on each chunk in the stream +to find a chunk with a truthy value for fn. Once an fn call's awaited return value is truthy, +the stream is destroyed and the promise is fulfilled with value for which fn returned a truthy value. +If all of the fn calls on the chunks return a falsy value, the promise is fulfilled with undefined.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      fn: ((data, options?) => data is T)
      +

      a function to call on each chunk of the stream. Async or not.

      +
      +
      +
        +
      • +
          +
        • (data, options?): data is T
          • +
        • +
          +

          Parameters

          +
            +
          • +
            data: any
            • +
          • +
            Optional options: Pick<ArrayOptions, "signal">
          +

          Returns data is T

      • +
    • +
      Optional options: ArrayOptions
    +

    Returns Promise<undefined | T>

    a promise evaluating to the first chunk for which fn evaluated with a truthy value, +or undefined if no element was found.

    + +
    +

    Since

    v17.5.0

    +
    • + +
  • +
    +

    Parameters

    +
      +
    • +
      fn: ((data, options?) => boolean | Promise<boolean>)
      +
        +
      • +
          +
        • (data, options?): boolean | Promise<boolean>
          • +
        • +
          +

          Parameters

          +
            +
          • +
            data: any
            • +
          • +
            Optional options: Pick<ArrayOptions, "signal">
          +

          Returns boolean | Promise<boolean>

      • +
    • +
      Optional options: ArrayOptions
    +

    Returns Promise<any>

+
+

flatMap

+
    + +
  • +

    This method returns a new stream by applying the given callback to each chunk of the stream +and then flattening the result.

    +

    It is possible to return a stream or another iterable or async iterable from fn and the result streams +will be merged (flattened) into the returned stream.

    +
    +
    +

    Parameters

    +
      +
    • +
      fn: ((data, options?) => any)
      +

      a function to map over every chunk in the stream. May be async. May be a stream or generator.

      +
      +
      +
        +
      • +
          +
        • (data, options?): any
          • +
        • +
          +

          Parameters

          +
            +
          • +
            data: any
            • +
          • +
            Optional options: Pick<ArrayOptions, "signal">
          +

          Returns any

      • +
    • +
      Optional options: ArrayOptions
    +

    Returns Readable

    a stream flat-mapped with the function fn.

    + +
    +

    Since

    v17.5.0

    +
+
+

forEach

+
    + +
  • +

    This method allows iterating a stream. For each chunk in the stream the fn function will be called. +If the fn function returns a promise - that promise will be awaited.

    +

    This method is different from for await...of loops in that it can optionally process chunks concurrently. +In addition, a forEach iteration can only be stopped by having passed a signal option +and aborting the related AbortController while for await...of can be stopped with break or return. +In either case the stream will be destroyed.

    +

    This method is different from listening to the 'data' event in that it uses the readable event +in the underlying machinary and can limit the number of concurrent fn calls.

    +
    +
    +

    Parameters

    +
      +
    • +
      fn: ((data, options?) => void | Promise<void>)
      +

      a function to call on each chunk of the stream. Async or not.

      +
      +
      +
        +
      • +
          +
        • (data, options?): void | Promise<void>
          • +
        • +
          +

          Parameters

          +
            +
          • +
            data: any
            • +
          • +
            Optional options: Pick<ArrayOptions, "signal">
          +

          Returns void | Promise<void>

      • +
    • +
      Optional options: ArrayOptions
    +

    Returns Promise<void>

    a promise for when the stream has finished.

    + +
    +

    Since

    v17.5.0

    +
+
+

getMaxListeners

+
    + +
  • +

    Returns the current max listener value for the EventEmitter which is either +set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    +
    +

    Returns number

    +
    +

    Since

    v1.0.0

    +
+
+

isPaused

+
    + +
  • +

    The readable.isPaused() method returns the current operating state of theReadable. This is used primarily by the mechanism that underlies thereadable.pipe() method. In most +typical cases, there will be no reason to +use this method directly.

    +
    const readable = new stream.Readable();

    readable.isPaused(); // === false
    readable.pause();
    readable.isPaused(); // === true
    readable.resume();
    readable.isPaused(); // === false
+
    +
    +

    Returns boolean

    +
    +

    Since

    v0.11.14

    +
+
+

iterator

+
    + +
  • +

    The iterator created by this method gives users the option to cancel the destruction +of the stream if the for await...of loop is exited by return, break, or throw, +or if the iterator should destroy the stream if the stream emitted an error during iteration.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional options: {
          destroyOnReturn?: boolean;
      }
      +
        +
      • +
        Optional destroyOnReturn?: boolean
        +

        When set to false, calling return on the async iterator, +or exiting a for await...of iteration using a break, return, or throw will not destroy the stream. +Default: true.

        +
        +
    +

    Returns AsyncIterableIterator<any>

    +
    +

    Since

    v16.3.0

    +
+
+

listenerCount

+
    + +
  • +

    Returns the number of listeners listening to the event named eventName.

    +

    If listener is provided, it will return how many times the listener +is found in the list of the listeners of the event.

    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      +

      The name of the event being listened for

      +
      +
      • +
    • +
      Optional listener: Function
      +

      The event handler function

      +
      +
    +

    Returns number

    +
    +

    Since

    v3.2.0

    +
+
+

listeners

+
    + +
  • +

    Returns a copy of the array of listeners for the event named eventName.

    +
    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
    console.log(util.inspect(server.listeners('connection')));
    // Prints: [ [Function] ]
+
    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
    +

    Returns Function[]

    +
    +

    Since

    v0.1.26

    +
+
+

map

+
    + +
  • +

    This method allows mapping over the stream. The fn function will be called for every chunk in the stream. +If the fn function returns a promise - that promise will be awaited before being passed to the result stream.

    +
    +
    +

    Parameters

    +
      +
    • +
      fn: ((data, options?) => any)
      +

      a function to map over every chunk in the stream. Async or not.

      +
      +
      +
        +
      • +
          +
        • (data, options?): any
          • +
        • +
          +

          Parameters

          +
            +
          • +
            data: any
            • +
          • +
            Optional options: Pick<ArrayOptions, "signal">
          +

          Returns any

      • +
    • +
      Optional options: ArrayOptions
    +

    Returns Readable

    a stream mapped with the function fn.

    + +
    +

    Since

    v17.4.0, v16.14.0

    +
+
+

Protected objectSlice

+
+
+

off

+
    + +
  • +

    Alias for emitter.removeListener().

    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      • +
    • +
      listener: ((...args) => void)
      +
        +
      • +
          +
        • (...args): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
          +

          Returns void

    +

    Returns SliceStream

    +
    +

    Since

    v10.0.0

    +
+
+

on

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "close"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "data"
      • +
    • +
      listener: ((chunk) => void)
      +
        +
      • +
          +
        • (chunk): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            chunk: any
          +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "drain"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "end"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "error"
      • +
    • +
      listener: ((err) => void)
      +
        +
      • +
          +
        • (err): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            err: Error
          +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "finish"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "pause"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "pipe"
      • +
    • +
      listener: ((src) => void)
      +
        +
      • +
          +
        • (src): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            src: Readable
          +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "readable"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "resume"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "unpipe"
      • +
    • +
      listener: ((src) => void)
      +
        +
      • +
          +
        • (src): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            src: Readable
          +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: string | symbol
      • +
    • +
      listener: ((...args) => void)
      +
        +
      • +
          +
        • (...args): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
          +

          Returns void

    +

    Returns SliceStream

+
+

once

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "close"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "data"
      • +
    • +
      listener: ((chunk) => void)
      +
        +
      • +
          +
        • (chunk): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            chunk: any
          +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "drain"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "end"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "error"
      • +
    • +
      listener: ((err) => void)
      +
        +
      • +
          +
        • (err): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            err: Error
          +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "finish"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "pause"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "pipe"
      • +
    • +
      listener: ((src) => void)
      +
        +
      • +
          +
        • (src): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            src: Readable
          +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "readable"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "resume"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "unpipe"
      • +
    • +
      listener: ((src) => void)
      +
        +
      • +
          +
        • (src): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            src: Readable
          +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: string | symbol
      • +
    • +
      listener: ((...args) => void)
      +
        +
      • +
          +
        • (...args): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
          +

          Returns void

    +

    Returns SliceStream

+
+

pause

+
    + +
  • +

    The readable.pause() method will cause a stream in flowing mode to stop +emitting 'data' events, switching out of flowing mode. Any data that +becomes available will remain in the internal buffer.

    +
    const readable = getReadableStreamSomehow();
    readable.on('data', (chunk) => {
      console.log(`Received ${chunk.length} bytes of data.`);
      readable.pause();
      console.log('There will be no additional data for 1 second.');
      setTimeout(() => {
        console.log('Now data will start flowing again.');
        readable.resume();
      }, 1000);
    });
+
    +

    The readable.pause() method has no effect if there is a 'readable'event listener.

    +
    +

    Returns SliceStream

    +
    +

    Since

    v0.9.4

    +
+
+

pipe

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T extends WritableStream

    +
    +

    Parameters

    +
      +
    • +
      destination: T
      • +
    • +
      Optional options: {
          end?: boolean;
      }
      +
        +
      • +
        Optional end?: boolean
    +

    Returns T

+
+

prependListener

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "close"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "data"
      • +
    • +
      listener: ((chunk) => void)
      +
        +
      • +
          +
        • (chunk): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            chunk: any
          +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "drain"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "end"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "error"
      • +
    • +
      listener: ((err) => void)
      +
        +
      • +
          +
        • (err): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            err: Error
          +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "finish"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "pause"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "pipe"
      • +
    • +
      listener: ((src) => void)
      +
        +
      • +
          +
        • (src): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            src: Readable
          +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "readable"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "resume"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "unpipe"
      • +
    • +
      listener: ((src) => void)
      +
        +
      • +
          +
        • (src): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            src: Readable
          +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: string | symbol
      • +
    • +
      listener: ((...args) => void)
      +
        +
      • +
          +
        • (...args): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
          +

          Returns void

    +

    Returns SliceStream

+
+

prependOnceListener

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "close"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "data"
      • +
    • +
      listener: ((chunk) => void)
      +
        +
      • +
          +
        • (chunk): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            chunk: any
          +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "drain"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "end"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "error"
      • +
    • +
      listener: ((err) => void)
      +
        +
      • +
          +
        • (err): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            err: Error
          +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "finish"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "pause"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "pipe"
      • +
    • +
      listener: ((src) => void)
      +
        +
      • +
          +
        • (src): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            src: Readable
          +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "readable"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "resume"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "unpipe"
      • +
    • +
      listener: ((src) => void)
      +
        +
      • +
          +
        • (src): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            src: Readable
          +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: string | symbol
      • +
    • +
      listener: ((...args) => void)
      +
        +
      • +
          +
        • (...args): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
          +

          Returns void

    +

    Returns SliceStream

+
+

push

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      chunk: any
      • +
    • +
      Optional encoding: BufferEncoding
    +

    Returns boolean

+
+

rawListeners

+
    + +
  • +

    Returns a copy of the array of listeners for the event named eventName, +including any wrappers (such as those created by .once()).

    +
    const emitter = new EventEmitter();
    emitter.once('log', () => console.log('log once'));

    // Returns a new Array with a function `onceWrapper` which has a property
    // `listener` which contains the original listener bound above
    const listeners = emitter.rawListeners('log');
    const logFnWrapper = listeners[0];

    // Logs "log once" to the console and does not unbind the `once` event
    logFnWrapper.listener();

    // Logs "log once" to the console and removes the listener
    logFnWrapper();

    emitter.on('log', () => console.log('log persistently'));
    // Will return a new Array with a single function bound by `.on()` above
    const newListeners = emitter.rawListeners('log');

    // Logs "log persistently" twice
    newListeners[0]();
    emitter.emit('log');
+
    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
    +

    Returns Function[]

    +
    +

    Since

    v9.4.0

    +
+
+

read

+
    + +
  • +

    The readable.read() method reads data out of the internal buffer and +returns it. If no data is available to be read, null is returned. By default, +the data is returned as a Buffer object unless an encoding has been +specified using the readable.setEncoding() method or the stream is operating +in object mode.

    +

    The optional size argument specifies a specific number of bytes to read. Ifsize bytes are not available to be read, null will be returned _unless_the stream has ended, in which +case all of the data remaining in the internal +buffer will be returned.

    +

    If the size argument is not specified, all of the data contained in the +internal buffer will be returned.

    +

    The size argument must be less than or equal to 1 GiB.

    +

    The readable.read() method should only be called on Readable streams +operating in paused mode. In flowing mode, readable.read() is called +automatically until the internal buffer is fully drained.

    +
    const readable = getReadableStreamSomehow();

    // 'readable' may be triggered multiple times as data is buffered in
    readable.on('readable', () => {
      let chunk;
      console.log('Stream is readable (new data received in buffer)');
      // Use a loop to make sure we read all currently available data
      while (null !== (chunk = readable.read())) {
        console.log(`Read ${chunk.length} bytes of data...`);
      }
    });

    // 'end' will be triggered once when there is no more data available
    readable.on('end', () => {
      console.log('Reached end of stream.');
    });
+
    +

    Each call to readable.read() returns a chunk of data, or null. The chunks +are not concatenated. A while loop is necessary to consume all data +currently in the buffer. When reading a large file .read() may return null, +having consumed all buffered content so far, but there is still more data to +come not yet buffered. In this case a new 'readable' event will be emitted +when there is more data in the buffer. Finally the 'end' event will be +emitted when there is no more data to come.

    +

    Therefore to read a file's whole contents from a readable, it is necessary +to collect chunks across multiple 'readable' events:

    +
    const chunks = [];

    readable.on('readable', () => {
      let chunk;
      while (null !== (chunk = readable.read())) {
        chunks.push(chunk);
      }
    });

    readable.on('end', () => {
      const content = chunks.join('');
    });
+
    +

    A Readable stream in object mode will always return a single item from +a call to readable.read(size), regardless of the value of thesize argument.

    +

    If the readable.read() method returns a chunk of data, a 'data' event will +also be emitted.

    +

    Calling read after the 'end' event has +been emitted will return null. No runtime error will be raised.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional size: number
      +

      Optional argument to specify how much data to read.

      +
      +
    +

    Returns any

    +
    +

    Since

    v0.9.4

    +
+
+

reduce

+
    + +
  • +

    This method calls fn on each chunk of the stream in order, passing it the result from the calculation +on the previous element. It returns a promise for the final value of the reduction.

    +

    If no initial value is supplied the first chunk of the stream is used as the initial value. +If the stream is empty, the promise is rejected with a TypeError with the ERR_INVALID_ARGS code property.

    +

    The reducer function iterates the stream element-by-element which means that there is no concurrency parameter +or parallelism. To perform a reduce concurrently, you can extract the async function to readable.map method.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T = any

    +
    +

    Parameters

    +
      +
    • +
      fn: ((previous, data, options?) => T)
      +

      a reducer function to call over every chunk in the stream. Async or not.

      +
      +
      +
        +
      • +
          +
        • (previous, data, options?): T
          • +
        • +
          +

          Parameters

          +
            +
          • +
            previous: any
            • +
          • +
            data: any
            • +
          • +
            Optional options: Pick<ArrayOptions, "signal">
          +

          Returns T

      • +
    • +
      Optional initial: undefined
      +

      the initial value to use in the reduction.

      +
      +
      • +
    • +
      Optional options: Pick<ArrayOptions, "signal">
    +

    Returns Promise<T>

    a promise for the final value of the reduction.

    + +
    +

    Since

    v17.5.0

    +
    • + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T = any

    +
    +

    Parameters

    +
      +
    • +
      fn: ((previous, data, options?) => T)
      +
        +
      • +
          +
        • (previous, data, options?): T
          • +
        • +
          +

          Parameters

          +
            +
          • +
            previous: T
            • +
          • +
            data: any
            • +
          • +
            Optional options: Pick<ArrayOptions, "signal">
          +

          Returns T

      • +
    • +
      initial: T
      • +
    • +
      Optional options: Pick<ArrayOptions, "signal">
    +

    Returns Promise<T>

+
+

removeAllListeners

+
    + +
  • +

    Removes all listeners, or those of the specified eventName.

    +

    It is bad practice to remove listeners added elsewhere in the code, +particularly when the EventEmitter instance was created by some other +component or module (e.g. sockets or file streams).

    +

    Returns a reference to the EventEmitter, so that calls can be chained.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional event: string | symbol
    +

    Returns SliceStream

    +
    +

    Since

    v0.1.26

    +
+
+

removeListener

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "close"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "data"
      • +
    • +
      listener: ((chunk) => void)
      +
        +
      • +
          +
        • (chunk): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            chunk: any
          +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "drain"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "end"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "error"
      • +
    • +
      listener: ((err) => void)
      +
        +
      • +
          +
        • (err): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            err: Error
          +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "finish"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "pause"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "pipe"
      • +
    • +
      listener: ((src) => void)
      +
        +
      • +
          +
        • (src): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            src: Readable
          +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "readable"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "resume"
      • +
    • +
      listener: (() => void)
      +
        +
      • +
          +
        • (): void
          • +
        • +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: "unpipe"
      • +
    • +
      listener: ((src) => void)
      +
        +
      • +
          +
        • (src): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            src: Readable
          +

          Returns void

    +

    Returns SliceStream

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      event: string | symbol
      • +
    • +
      listener: ((...args) => void)
      +
        +
      • +
          +
        • (...args): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
          +

          Returns void

    +

    Returns SliceStream

+
+

resume

+
    + +
  • +

    The readable.resume() method causes an explicitly paused Readable stream to +resume emitting 'data' events, switching the stream into flowing mode.

    +

    The readable.resume() method can be used to fully consume the data from a +stream without actually processing any of that data:

    +
    getReadableStreamSomehow()
      .resume()
      .on('end', () => {
        console.log('Reached the end, but did not read anything.');
      });
+
    +

    The readable.resume() method has no effect if there is a 'readable'event listener.

    +
    +

    Returns SliceStream

    +
    +

    Since

    v0.9.4

    +
+
+

setDefaultEncoding

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      encoding: BufferEncoding
    +

    Returns SliceStream

+
+

setEncoding

+
    + +
  • +

    The readable.setEncoding() method sets the character encoding for +data read from the Readable stream.

    +

    By default, no encoding is assigned and stream data will be returned asBuffer objects. Setting an encoding causes the stream data +to be returned as strings of the specified encoding rather than as Bufferobjects. For instance, calling readable.setEncoding('utf8') will cause the +output data to be interpreted as UTF-8 data, and passed as strings. Callingreadable.setEncoding('hex') will cause the data to be encoded in hexadecimal +string format.

    +

    The Readable stream will properly handle multi-byte characters delivered +through the stream that would otherwise become improperly decoded if simply +pulled from the stream as Buffer objects.

    +
    const readable = getReadableStreamSomehow();
    readable.setEncoding('utf8');
    readable.on('data', (chunk) => {
      assert.equal(typeof chunk, 'string');
      console.log('Got %d characters of string data:', chunk.length);
    });
+
    +
    +
    +

    Parameters

    +
      +
    • +
      encoding: BufferEncoding
      +

      The encoding to use.

      +
      +
    +

    Returns SliceStream

    +
    +

    Since

    v0.9.4

    +
+
+

setMaxListeners

+
    + +
  • +

    By default EventEmitters will print a warning if more than 10 listeners are +added for a particular event. This is a useful default that helps finding +memory leaks. The emitter.setMaxListeners() method allows the limit to be +modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    +

    Returns a reference to the EventEmitter, so that calls can be chained.

    +
    +
    +

    Parameters

    +
      +
    • +
      n: number
    +

    Returns SliceStream

    +
    +

    Since

    v0.3.5

    +
+
+

some

+
    + +
  • +

    This method is similar to Array.prototype.some and calls fn on each chunk in the stream +until the awaited return value is true (or any truthy value). Once an fn call on a chunk +awaited return value is truthy, the stream is destroyed and the promise is fulfilled with true. +If none of the fn calls on the chunks return a truthy value, the promise is fulfilled with false.

    +
    +
    +

    Parameters

    +
      +
    • +
      fn: ((data, options?) => boolean | Promise<boolean>)
      +

      a function to call on each chunk of the stream. Async or not.

      +
      +
      +
        +
      • +
          +
        • (data, options?): boolean | Promise<boolean>
          • +
        • +
          +

          Parameters

          +
            +
          • +
            data: any
            • +
          • +
            Optional options: Pick<ArrayOptions, "signal">
          +

          Returns boolean | Promise<boolean>

      • +
    • +
      Optional options: ArrayOptions
    +

    Returns Promise<boolean>

    a promise evaluating to true if fn returned a truthy value for at least one of the chunks.

    + +
    +

    Since

    v17.5.0

    +
+
+

take

+
    + +
  • +

    This method returns a new stream with the first limit chunks.

    +
    +
    +

    Parameters

    +
      +
    • +
      limit: number
      +

      the number of chunks to take from the readable.

      +
      +
      • +
    • +
      Optional options: Pick<ArrayOptions, "signal">
    +

    Returns Readable

    a stream with limit chunks taken.

    + +
    +

    Since

    v17.5.0

    +
+
+

toArray

+
    + +
  • +

    This method allows easily obtaining the contents of a stream.

    +

    As this method reads the entire stream into memory, it negates the benefits of streams. It's intended +for interoperability and convenience, not as the primary way to consume streams.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional options: Pick<ArrayOptions, "signal">
    +

    Returns Promise<any[]>

    a promise containing an array with the contents of the stream.

    + +
    +

    Since

    v17.5.0

    +
+
+

uncork

+
    + +
  • +

    Returns void

+
+

unpipe

+
    + +
  • +

    The readable.unpipe() method detaches a Writable stream previously attached +using the pipe method.

    +

    If the destination is not specified, then all pipes are detached.

    +

    If the destination is specified, but no pipe is set up for it, then +the method does nothing.

    +
    const fs = require('fs');
    const readable = getReadableStreamSomehow();
    const writable = fs.createWriteStream('file.txt');
    // All the data from readable goes into 'file.txt',
    // but only for the first second.
    readable.pipe(writable);
    setTimeout(() => {
      console.log('Stop writing to file.txt.');
      readable.unpipe(writable);
      console.log('Manually close the file stream.');
      writable.end();
    }, 1000);
+
    +
    +
    +

    Parameters

    +
      +
    • +
      Optional destination: WritableStream
      +

      Optional specific stream to unpipe

      +
      +
    +

    Returns SliceStream

    +
    +

    Since

    v0.9.4

    +
+
+

unshift

+
    + +
  • +

    Passing chunk as null signals the end of the stream (EOF) and behaves the +same as readable.push(null), after which no more data can be written. The EOF +signal is put at the end of the buffer and any buffered data will still be +flushed.

    +

    The readable.unshift() method pushes a chunk of data back into the internal +buffer. This is useful in certain situations where a stream is being consumed by +code that needs to "un-consume" some amount of data that it has optimistically +pulled out of the source, so that the data can be passed on to some other party.

    +

    The stream.unshift(chunk) method cannot be called after the 'end' event +has been emitted or a runtime error will be thrown.

    +

    Developers using stream.unshift() often should consider switching to +use of a Transform stream instead. See the API for stream implementers section for more information.

    +
    // Pull off a header delimited by \n\n.
    // Use unshift() if we get too much.
    // Call the callback with (error, header, stream).
    const { StringDecoder } = require('string_decoder');
    function parseHeader(stream, callback) {
      stream.on('error', callback);
      stream.on('readable', onReadable);
      const decoder = new StringDecoder('utf8');
      let header = '';
      function onReadable() {
        let chunk;
        while (null !== (chunk = stream.read())) {
          const str = decoder.write(chunk);
          if (str.includes('\n\n')) {
            // Found the header boundary.
            const split = str.split(/\n\n/);
            header += split.shift();
            const remaining = split.join('\n\n');
            const buf = Buffer.from(remaining, 'utf8');
            stream.removeListener('error', callback);
            // Remove the 'readable' listener before unshifting.
            stream.removeListener('readable', onReadable);
            if (buf.length)
              stream.unshift(buf);
            // Now the body of the message can be read from the stream.
            callback(null, header, stream);
            return;
          }
          // Still reading the header.
          header += str;
        }
      }
    }
+
    +

    Unlike push, stream.unshift(chunk) will not +end the reading process by resetting the internal reading state of the stream. +This can cause unexpected results if readable.unshift() is called during a +read (i.e. from within a _read implementation on a +custom stream). Following the call to readable.unshift() with an immediate push will reset the reading state appropriately, +however it is best to simply avoid calling readable.unshift() while in the +process of performing a read.

    +
    +
    +

    Parameters

    +
      +
    • +
      chunk: any
      +

      Chunk of data to unshift onto the read queue. For streams not operating in object mode, chunk must be a string, Buffer, Uint8Array or null. For object mode +streams, chunk may be any JavaScript value.

      +
      +
      • +
    • +
      Optional encoding: BufferEncoding
      +

      Encoding of string chunks. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'.

      +
      +
    +

    Returns void

    +
    +

    Since

    v0.9.11

    +
+
+

wrap

+
    + +
  • +

    Prior to Node.js 0.10, streams did not implement the entire stream module API +as it is currently defined. (See Compatibility for more information.)

    +

    When using an older Node.js library that emits 'data' events and has a pause method that is advisory only, thereadable.wrap() method can be used to create a Readable +stream that uses +the old stream as its data source.

    +

    It will rarely be necessary to use readable.wrap() but the method has been +provided as a convenience for interacting with older Node.js applications and +libraries.

    +
    const { OldReader } = require('./old-api-module.js');
    const { Readable } = require('stream');
    const oreader = new OldReader();
    const myReader = new Readable().wrap(oreader);

    myReader.on('readable', () => {
      myReader.read(); // etc.
    });
+
    +
    +
    +

    Parameters

    +
      +
    • +
      stream: ReadableStream
      +

      An "old style" readable stream

      +
      +
    +

    Returns SliceStream

    +
    +

    Since

    v0.9.4

    +
+
+

write

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      chunk: any
      • +
    • +
      Optional encoding: BufferEncoding
      • +
    • +
      Optional cb: ((error) => void)
      +
        +
      • +
          +
        • (error): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            error: undefined | null | Error
          +

          Returns void

    +

    Returns boolean

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      chunk: any
      • +
    • +
      Optional cb: ((error) => void)
      +
        +
      • +
          +
        • (error): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            error: undefined | null | Error
          +

          Returns void

    +

    Returns boolean

+
+

Static addAbortListener

+
    + +
  • Experimental +

    Listens once to the abort event on the provided signal.

    +

    Listening to the abort event on abort signals is unsafe and may +lead to resource leaks since another third party with the signal can +call e.stopImmediatePropagation(). Unfortunately Node.js cannot change +this since it would violate the web standard. Additionally, the original +API makes it easy to forget to remove listeners.

    +

    This API allows safely using AbortSignals in Node.js APIs by solving these +two issues by listening to the event such that stopImmediatePropagation does +not prevent the listener from running.

    +

    Returns a disposable so that it may be unsubscribed from more easily.

    +
    import { addAbortListener } from 'node:events';

    function example(signal) {
      let disposable;
      try {
        signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
        disposable = addAbortListener(signal, (e) => {
          // Do something when signal is aborted.
        });
      } finally {
        disposable?.[Symbol.dispose]();
      }
    }
+
    +
    +
    +

    Parameters

    +
      +
    • +
      signal: AbortSignal
      • +
    • +
      resource: ((event) => void)
      +
        +
      • +
          +
        • (event): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            event: Event
          +

          Returns void

    +

    Returns Disposable

    Disposable that removes the abort listener.

    + +
    +

    Since

    v18.18.0

    +
+
+

Static from

+
    + +
  • +

    A utility method for creating duplex streams.

    +
      +
    • Stream converts writable stream into writable Duplex and readable stream +to Duplex.
      • +
    • Blob converts into readable Duplex.
      • +
    • string converts into readable Duplex.
      • +
    • ArrayBuffer converts into readable Duplex.
      • +
    • AsyncIterable converts into a readable Duplex. Cannot yield null.
      • +
    • AsyncGeneratorFunction converts into a readable/writable transform +Duplex. Must take a source AsyncIterable as first parameter. Cannot yield +null.
      • +
    • AsyncFunction converts into a writable Duplex. Must return +either null or undefined
      • +
    • Object ({ writable, readable }) converts readable and +writable into Stream and then combines them into Duplex where the +Duplex will write to the writable and read from the readable.
      • +
    • Promise converts into readable Duplex. Value null is ignored.
      • +
    +
    +
    +

    Parameters

    +
      +
    • +
      src: string | Object | Stream | Promise<any> | Iterable<any> | AsyncIterable<any> | ArrayBuffer | Blob | AsyncGeneratorFunction
    +

    Returns Duplex

    +
    +

    Since

    v16.8.0

    +
+
+

Static fromWeb

+
    + +
  • Experimental +

    A utility method for creating a Readable from a web ReadableStream.

    +
    +
    +

    Parameters

    +
      +
    • +
      readableStream: ReadableStream<any>
      • +
    • +
      Optional options: Pick<ReadableOptions, "encoding" | "highWaterMark" | "objectMode" | "signal">
    +

    Returns Readable

    +
    +

    Since

    v17.0.0

    +
+
+

Static getEventListeners

+
    + +
  • +

    Returns a copy of the array of listeners for the event named eventName.

    +

    For EventEmitters this behaves exactly the same as calling .listeners on +the emitter.

    +

    For EventTargets this is the only way to get the event listeners for the +event target. This is useful for debugging and diagnostic purposes.

    +
    const { getEventListeners, EventEmitter } = require('events');

    {
      const ee = new EventEmitter();
      const listener = () => console.log('Events are fun');
      ee.on('foo', listener);
      getEventListeners(ee, 'foo'); // [listener]
    }
    {
      const et = new EventTarget();
      const listener = () => console.log('Events are fun');
      et.addEventListener('foo', listener);
      getEventListeners(et, 'foo'); // [listener]
    }
+
    +
    +
    +

    Parameters

    +
      +
    • +
      emitter: EventEmitter | _DOMEventTarget
      • +
    • +
      name: string | symbol
    +

    Returns Function[]

    +
    +

    Since

    v15.2.0, v14.17.0

    +
+
+

Static getMaxListeners

+
    + +
  • +

    Returns the currently set max amount of listeners.

    +

    For EventEmitters this behaves exactly the same as calling .getMaxListeners on +the emitter.

    +

    For EventTargets this is the only way to get the max event listeners for the +event target. If the number of event handlers on a single EventTarget exceeds +the max set, the EventTarget will print a warning.

    +
    import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';

    {
      const ee = new EventEmitter();
      console.log(getMaxListeners(ee)); // 10
      setMaxListeners(11, ee);
      console.log(getMaxListeners(ee)); // 11
    }
    {
      const et = new EventTarget();
      console.log(getMaxListeners(et)); // 10
      setMaxListeners(11, et);
      console.log(getMaxListeners(et)); // 11
    }
+
    +
    +
    +

    Parameters

    +
      +
    • +
      emitter: EventEmitter | _DOMEventTarget
    +

    Returns number

    +
    +

    Since

    v18.17.0

    +
+
+

Static isDisturbed

+
    + +
  • +

    Returns whether the stream has been read from or cancelled.

    +
    +
    +

    Parameters

    +
      +
    • +
      stream: Readable | ReadableStream
    +

    Returns boolean

    +
    +

    Since

    v16.8.0

    +
+
+

Static listenerCount

+
    + +
  • +

    A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

    +
    const { EventEmitter, listenerCount } = require('events');
    const myEmitter = new EventEmitter();
    myEmitter.on('event', () => {});
    myEmitter.on('event', () => {});
    console.log(listenerCount(myEmitter, 'event'));
    // Prints: 2
+
    +
    +
    +

    Parameters

    +
      +
    • +
      emitter: EventEmitter
      +

      The emitter to query

      +
      +
      • +
    • +
      eventName: string | symbol
      +

      The event name

      +
      +
    +

    Returns number

    +
    +

    Since

    v0.9.12

    + +

    Deprecated

    Since v3.2.0 - Use listenerCount instead.

    +
+
+

Static on

+
    + +
  • +
    const { on, EventEmitter } = require('events');

    (async () => {
      const ee = new EventEmitter();

      // Emit later on
      process.nextTick(() => {
        ee.emit('foo', 'bar');
        ee.emit('foo', 42);
      });

      for await (const event of on(ee, 'foo')) {
        // The execution of this inner block is synchronous and it
        // processes one event at a time (even with await). Do not use
        // if concurrent execution is required.
        console.log(event); // prints ['bar'] [42]
      }
      // Unreachable here
    })();
+
    +

    Returns an AsyncIterator that iterates eventName events. It will throw +if the EventEmitter emits 'error'. It removes all listeners when +exiting the loop. The value returned by each iteration is an array +composed of the emitted event arguments.

    +

    An AbortSignal can be used to cancel waiting on events:

    +
    const { on, EventEmitter } = require('events');
    const ac = new AbortController();

    (async () => {
      const ee = new EventEmitter();

      // Emit later on
      process.nextTick(() => {
        ee.emit('foo', 'bar');
        ee.emit('foo', 42);
      });

      for await (const event of on(ee, 'foo', { signal: ac.signal })) {
        // The execution of this inner block is synchronous and it
        // processes one event at a time (even with await). Do not use
        // if concurrent execution is required.
        console.log(event); // prints ['bar'] [42]
      }
      // Unreachable here
    })();

    process.nextTick(() => ac.abort());
+
    +
    +
    +

    Parameters

    +
      +
    • +
      emitter: EventEmitter
      • +
    • +
      eventName: string
      +

      The name of the event being listened for

      +
      +
      • +
    • +
      Optional options: StaticEventEmitterOptions
    +

    Returns AsyncIterableIterator<any>

    that iterates eventName events emitted by the emitter

    + +
    +

    Since

    v13.6.0, v12.16.0

    +
+
+

Static once

+
    + +
  • +

    Creates a Promise that is fulfilled when the EventEmitter emits the given +event or that is rejected if the EventEmitter emits 'error' while waiting. +The Promise will resolve with an array of all the arguments emitted to the +given event.

    +

    This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event +semantics and does not listen to the 'error' event.

    +
    const { once, EventEmitter } = require('events');

    async function run() {
      const ee = new EventEmitter();

      process.nextTick(() => {
        ee.emit('myevent', 42);
      });

      const [value] = await once(ee, 'myevent');
      console.log(value);

      const err = new Error('kaboom');
      process.nextTick(() => {
        ee.emit('error', err);
      });

      try {
        await once(ee, 'myevent');
      } catch (err) {
        console.log('error happened', err);
      }
    }

    run();
+
    +

    The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the +'error' event itself, then it is treated as any other kind of event without +special handling:

    +
    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();

    once(ee, 'error')
      .then(([err]) => console.log('ok', err.message))
      .catch((err) => console.log('error', err.message));

    ee.emit('error', new Error('boom'));

    // Prints: ok boom
+
    +

    An AbortSignal can be used to cancel waiting for the event:

    +
    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();
    const ac = new AbortController();

    async function foo(emitter, event, signal) {
      try {
        await once(emitter, event, { signal });
        console.log('event emitted!');
      } catch (error) {
        if (error.name === 'AbortError') {
          console.error('Waiting for the event was canceled!');
        } else {
          console.error('There was an error', error.message);
        }
      }
    }

    foo(ee, 'foo', ac.signal);
    ac.abort(); // Abort waiting for the event
    ee.emit('foo'); // Prints: Waiting for the event was canceled!
+
    +
    +
    +

    Parameters

    +
      +
    • +
      emitter: _NodeEventTarget
      • +
    • +
      eventName: string | symbol
      • +
    • +
      Optional options: StaticEventEmitterOptions
    +

    Returns Promise<any[]>

    +
    +

    Since

    v11.13.0, v10.16.0

    +
    • + +
  • +
    +

    Parameters

    +
      +
    • +
      emitter: _DOMEventTarget
      • +
    • +
      eventName: string
      • +
    • +
      Optional options: StaticEventEmitterOptions
    +

    Returns Promise<any[]>

+
+

Static setMaxListeners

+
    + +
  • +
    const {
      setMaxListeners,
      EventEmitter
    } = require('events');

    const target = new EventTarget();
    const emitter = new EventEmitter();

    setMaxListeners(5, target, emitter);
+
    +
    +
    +

    Parameters

    +
      +
    • +
      Optional n: number
      +

      A non-negative number. The maximum number of listeners per EventTarget event.

      +
      +
      • +
    • +
      Rest ...eventTargets: (EventEmitter | _DOMEventTarget)[]
    +

    Returns void

    +
    +

    Since

    v15.4.0

    +
+
+

Static toWeb

+
    + +
  • Experimental +

    A utility method for creating a web ReadableStream from a Readable.

    +
    +
    +

    Parameters

    +
      +
    • +
      streamReadable: Readable
    +

    Returns ReadableStream<any>

    +
    +

    Since

    v17.0.0

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SlugParser.html b/7.x/docs/classes/SlugParser.html new file mode 100644 index 000000000..1eb630ea2 --- /dev/null +++ b/7.x/docs/classes/SlugParser.html @@ -0,0 +1,198 @@ +SlugParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SlugParser

+
+

Converts the contents of the slug header to metadata.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SparqlDataAccessor.html b/7.x/docs/classes/SparqlDataAccessor.html new file mode 100644 index 000000000..fe8586239 --- /dev/null +++ b/7.x/docs/classes/SparqlDataAccessor.html @@ -0,0 +1,607 @@ +SparqlDataAccessor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SparqlDataAccessor

+
+

Stores all data and metadata of resources in a SPARQL backend. +Communication is done by sending SPARQL queries. +Queries are constructed in such a way to keep everything consistent, +such as updating containment triples and deleting old data when it is overwritten.

+

Since metadata is hidden, no containment triples are stored for metadata files.

+

All input container metadata is stored in its metadata identifier. +The containment triples are stored in the graph corresponding to the actual identifier +so those don't get overwritten.

+
+
+
+

Hierarchy

+
    +
  • SparqlDataAccessor
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
endpoint +fetcher +generator +identifierStrategy +logger +
+
+

Methods

+
canHandle +deleteResource +getChildren +getData +getMetadata +getMetadataNode +getRelatedNames +isMetadataIdentifier +sendSparqlConstruct +sendSparqlUpdate +sparqlConstruct +sparqlDelete +sparqlInsert +sparqlInsertMetadata +sparqlSelectGraph +sparqlUpdateDeleteAll +sparqlUpdateGraph +writeContainer +writeDocument +writeMetadata +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly endpoint

+
endpoint: string
+
+

Private Readonly fetcher

+
fetcher: SparqlEndpointFetcher
+
+

Private Readonly generator

+
generator: SparqlGenerator
+
+

Private Readonly identifierStrategy

+
identifierStrategy: IdentifierStrategy
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Methods

+
+

canHandle

+
+
+

deleteResource

+
+
+

getChildren

+
    + +
  • +

    Returns metadata for all resources in the requested container. +This should not be all metadata of those resources (but it can be), +but instead the main metadata you want to show in situations +where all these resources are presented simultaneously. +Generally this would be metadata that is present for all of these resources, +such as resource type or last modified date.

    +

    It can be safely assumed that the incoming identifier will always correspond to a container.

    +
    +
    +

    Parameters

    +
    +

    Returns AsyncIterableIterator<RepresentationMetadata>

    +
+
+

getData

+
+
+

getMetadata

+
+
+

Private getMetadataNode

+
    + +
  • +

    Creates the name for the metadata of a resource.

    +
    +
    +

    Parameters

    +
      +
    • +
      name: NamedNode<string>
      +

      Name of the (non-metadata) resource.

      +
      +
    +

    Returns NamedNode<string>

    +
+
+

Private getRelatedNames

+
    + +
  • +

    Helper function to get named nodes corresponding to the identifier and its parent container. +In case of a root container only the name will be returned.

    +
    +
    +

    Parameters

    +
    +

    Returns {
        name: NamedNode<string>;
        parent?: NamedNode<string>;
    }

    +
      +
    • +
      name: NamedNode<string>
      • +
    • +
      Optional parent?: NamedNode<string>
    +
+
+

Private isMetadataIdentifier

+
+
+

Private sendSparqlConstruct

+
    + +
  • +

    Sends a SPARQL CONSTRUCT query to the endpoint and returns a stream of quads.

    +
    +
    +

    Parameters

    +
      +
    • +
      sparqlQuery: ConstructQuery
      +

      Query to execute.

      +
      +
    +

    Returns Promise<Guarded<Readable>>

    +
+
+

Private sendSparqlUpdate

+
    + +
  • +

    Sends a SPARQL update query to the stored endpoint.

    +
    +
    +

    Parameters

    +
      +
    • +
      sparqlQuery: Update
      +

      Query to send.

      +
      +
    +

    Returns Promise<void>

    +
+
+

Private sparqlConstruct

+
    + +
  • +

    Creates a CONSTRUCT query that returns all quads contained within a single resource.

    +
    +
    +

    Parameters

    +
      +
    • +
      name: NamedNode<string>
      +

      Name of the resource to query.

      +
      +
    +

    Returns ConstructQuery

    +
+
+

Private sparqlDelete

+
    + +
  • +

    Creates a query that deletes everything related to the given name.

    +
    +
    +

    Parameters

    +
      +
    • +
      name: NamedNode<string>
      +

      Name of resource to delete.

      +
      +
      • +
    • +
      Optional parent: NamedNode<string>
      +

      Parent of the resource to delete so the containment triple can be removed (unless root).

      +
      +
    +

    Returns Update

    +
+
+

Private sparqlInsert

+
    + +
  • +

    Creates an update query that overwrites the data and metadata of a resource. +If there are no triples we assume it's a container (so don't overwrite the main graph with containment triples).

    +
    +
    +

    Parameters

    +
      +
    • +
      name: NamedNode<string>
      +

      Name of the resource to update.

      +
      +
      • +
    • +
      metadata: RepresentationMetadata
      +

      New metadata of the resource.

      +
      +
      • +
    • +
      Optional parent: NamedNode<string>
      +

      Name of the parent to update the containment triples.

      +
      +
      • +
    • +
      Optional triples: Quad[]
      +

      New data of the resource.

      +
      +
    +

    Returns Update

    +
+
+

Private sparqlInsertMetadata

+
    + +
  • +

    Creates an update query that overwrites metadata of a resource.

    +
    +
    +

    Parameters

    +
      +
    • +
      metaName: NamedNode<string>
      +

      Name of the metadata resource to update.

      +
      +
      • +
    • +
      metadata: RepresentationMetadata
      +

      New metadata of the resource.

      +
      +
    +

    Returns Update

    +
+
+

Private sparqlSelectGraph

+
+
+

Private sparqlUpdateDeleteAll

+
    + +
  • +

    Helper function for creating SPARQL update queries. +Creates an operation for deleting all triples in a graph.

    +
    +
    +

    Parameters

    +
      +
    • +
      name: NamedNode<string>
      +

      Name of the graph to delete.

      +
      +
    +

    Returns InsertDeleteOperation

    +
+
+

Private sparqlUpdateGraph

+
    + +
  • +

    Helper function for creating SPARQL update queries. +Creates a Graph selector with the given triples.

    +
    +
    +

    Parameters

    +
      +
    • +
      name: NamedNode<string>
      +

      Name of the graph.

      +
      +
      • +
    • +
      triples: Quad[]
      +

      Triples/triple patterns to select.

      +
      +
    +

    Returns GraphQuads

    +
+
+

writeContainer

+
+
+

writeDocument

+
+
+

writeMetadata

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SparqlUpdateBodyParser.html b/7.x/docs/classes/SparqlUpdateBodyParser.html new file mode 100644 index 000000000..4294e14f6 --- /dev/null +++ b/7.x/docs/classes/SparqlUpdateBodyParser.html @@ -0,0 +1,184 @@ +SparqlUpdateBodyParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SparqlUpdateBodyParser

+
+

BodyParser that supports application/sparql-update content. +Will convert the incoming update string to algebra in a SparqlUpdatePatch.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      __namedParameters: BodyParserArgs
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SparqlUpdateModesExtractor.html b/7.x/docs/classes/SparqlUpdateModesExtractor.html new file mode 100644 index 000000000..af104d7fb --- /dev/null +++ b/7.x/docs/classes/SparqlUpdateModesExtractor.html @@ -0,0 +1,304 @@ +SparqlUpdateModesExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SparqlUpdateModesExtractor

+
+

Generates permissions for a SPARQL DELETE/INSERT body. +Updates with only an INSERT can be done with just append permissions, +while DELETEs require write permissions as well.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
resourceSet +
+
+

Methods

+
canHandle +handle +handleSafe +hasConditions +hasDeletes +hasInserts +isDeleteInsert +isNop +isSparql +isSupported +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly resourceSet

+
resourceSet: ResourceSet
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      __namedParameters: Operation
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+

Private hasConditions

+
+
+

Private hasDeletes

+
+
+

Private hasInserts

+
+
+

Private isDeleteInsert

+
+
+

Private isNop

+
+
+

Private isSparql

+
+
+

Private isSupported

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SparqlUpdatePatcher.html b/7.x/docs/classes/SparqlUpdatePatcher.html new file mode 100644 index 000000000..9b9576364 --- /dev/null +++ b/7.x/docs/classes/SparqlUpdatePatcher.html @@ -0,0 +1,311 @@ +SparqlUpdatePatcher | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SparqlUpdatePatcher

+
+

Supports application/sparql-update PATCH requests on RDF resources.

+

Only DELETE/INSERT updates without variables are supported.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
engine +logger +
+
+

Methods

+
canHandle +handle +handleSafe +isComposite +isDeleteInsert +isSparqlUpdate +patch +validateComposite +validateDeleteInsert +validateUpdate +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly engine

+
engine: QueryEngine<IQueryContextCommon>
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+

Private isComposite

+
+
+

Private isDeleteInsert

+
+
+

Private isSparqlUpdate

+
+
+

Private patch

+
+
+

Private validateComposite

+
    + +
  • +

    Checks if the composite update only contains supported update components.

    +
    +
    +

    Parameters

    +
      +
    • +
      op: CompositeUpdate
    +

    Returns void

    +
+
+

Private validateDeleteInsert

+
    + +
  • +

    Checks if the input DELETE/INSERT is supported. +This means: no GRAPH statements, no DELETE WHERE containing terms of type Variable.

    +
    +
    +

    Parameters

    +
      +
    • +
      op: DeleteInsert
    +

    Returns void

    +
+
+

Private validateUpdate

+
    + +
  • +

    Checks if the input operation is of a supported type (DELETE/INSERT or composite of those)

    +
    +
    +

    Parameters

    +
      +
    • +
      op: Operation
    +

    Returns void

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/StateHandler.html b/7.x/docs/classes/StateHandler.html new file mode 100644 index 000000000..639161a7e --- /dev/null +++ b/7.x/docs/classes/StateHandler.html @@ -0,0 +1,185 @@ +StateHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class StateHandlerAbstract

+
+

Handles the state feature of notifications. +Every implementation of a specific notification channel type should make sure an instance of this class +gets called when a state notification can be sent out.

+

Implementations of this class should handle all channels and filter out those that need a state notification.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/StateNotificationGenerator.html b/7.x/docs/classes/StateNotificationGenerator.html new file mode 100644 index 000000000..b5ec84a1a --- /dev/null +++ b/7.x/docs/classes/StateNotificationGenerator.html @@ -0,0 +1,200 @@ +StateNotificationGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class StateNotificationGenerator

+
+

Determines the most relevant activity for a Notification in case none was provided. +This is relevant for the state feature where a notification channel needs to know the current state of a resource.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
resourceSet +source +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly resourceSet

+
resourceSet: ResourceSet
+
+

Private Readonly source

+
source: NotificationGenerator
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/StaticAssetEntry.html b/7.x/docs/classes/StaticAssetEntry.html new file mode 100644 index 000000000..bb01c6ef2 --- /dev/null +++ b/7.x/docs/classes/StaticAssetEntry.html @@ -0,0 +1,119 @@ +StaticAssetEntry | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class StaticAssetEntry

+
+

Used to link file paths with relative URLs. +By using a separate class instead of a key/value map it is easier to replace values in Components.js.

+
+
+
+

Hierarchy

+
    +
  • StaticAssetEntry
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
filePath +relativeUrl +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly filePath

+
filePath: string
+
+

Readonly relativeUrl

+
relativeUrl: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/StaticAssetHandler.html b/7.x/docs/classes/StaticAssetHandler.html new file mode 100644 index 000000000..88d7c522b --- /dev/null +++ b/7.x/docs/classes/StaticAssetHandler.html @@ -0,0 +1,283 @@ +StaticAssetHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class StaticAssetHandler

+
+

Handler that serves static resources on specific paths. +Relative file paths are assumed to be relative to the current working directory. +Relative file paths can be preceded by @css:, e.g. @css:foo/bar, +in case they need to be relative to the module root. +File paths ending in a slash assume the target is a folder and map all of its contents.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
expires +logger +mappings +pathMatcher +
+
+

Methods

+
canHandle +createPathMatcher +getCacheHeaders +getFilePath +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly expires

+
expires: number
+
+

Private Readonly logger

+
logger: Logger = ...
+
+

Private Readonly mappings

+
mappings: Record<string, string>
+
+

Private Readonly pathMatcher

+
pathMatcher: RegExp
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      __namedParameters: HttpHandlerInput
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Private createPathMatcher

+
+
+

Private getCacheHeaders

+
+
+

Private getFilePath

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/StaticFolderGenerator.html b/7.x/docs/classes/StaticFolderGenerator.html new file mode 100644 index 000000000..918438434 --- /dev/null +++ b/7.x/docs/classes/StaticFolderGenerator.html @@ -0,0 +1,156 @@ +StaticFolderGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class StaticFolderGenerator

+
+

Stores a static template folder that will be used to call the wrapped TemplatedResourcesGenerator.

+
+
+
+

Hierarchy

+
    +
  • StaticFolderGenerator
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
resourcesGenerator +templateFolder +
+
+

Methods

+
generate +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly resourcesGenerator

+
resourcesGenerator: TemplatedResourcesGenerator
+
+

Private Readonly templateFolder

+
templateFolder: string
+
+

Methods

+
+

generate

+
    + +
  • +

    Generates resources with the given options. +The output Iterable should be sorted so that containers always appear before their contents.

    +
    +
    +

    Parameters

    +
      +
    • +
      location: ResourceIdentifier
      +

      Base identifier.

      +
      +
      • +
    • +
      options: Dict<unknown>
      +

      Options that can be used when generating resources.

      +
      +
    +

    Returns AsyncIterable<Resource>

    A map where the keys are the identifiers and the values the corresponding representations to store.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/StaticHandler.html b/7.x/docs/classes/StaticHandler.html new file mode 100644 index 000000000..bc7efba10 --- /dev/null +++ b/7.x/docs/classes/StaticHandler.html @@ -0,0 +1,197 @@ +StaticHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class StaticHandler<T>

+
+

A handler that always resolves and always returns the stored value. +Will return undefined if no value is stored.

+

The generic type extends any due to Components.js requirements.

+
+
+
+

Type Parameters

+
    +
  • +

    T = void

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
value? +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Optional Readonly value

+
value?: T
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: unknown
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: unknown
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<T>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/StaticInteractionHandler.html b/7.x/docs/classes/StaticInteractionHandler.html new file mode 100644 index 000000000..0c9f67777 --- /dev/null +++ b/7.x/docs/classes/StaticInteractionHandler.html @@ -0,0 +1,185 @@ +StaticInteractionHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class StaticInteractionHandler

+
+

An JsonInteractionHandler that always returns the same JSON response on all requests.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
response +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly response

+
response: Record<string, Json>
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/StaticStorageDescriber.html b/7.x/docs/classes/StaticStorageDescriber.html new file mode 100644 index 000000000..bb4c20372 --- /dev/null +++ b/7.x/docs/classes/StaticStorageDescriber.html @@ -0,0 +1,208 @@ +StaticStorageDescriber | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class StaticStorageDescriber

+
+

Adds a fixed set of triples to the storage description resource, +with the resource identifier as subject.

+

This can be used to add descriptions that a storage always needs to have, +such as the <> a pim:Storage triple.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
terms +
+
+

Methods

+
canHandle +generateTriples +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly terms

+
terms: ReadonlyMap<NamedNode<string>, Quad_Object[]>
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Private generateTriples

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/StaticTemplateEngine.html b/7.x/docs/classes/StaticTemplateEngine.html new file mode 100644 index 000000000..bd1d1fbb9 --- /dev/null +++ b/7.x/docs/classes/StaticTemplateEngine.html @@ -0,0 +1,218 @@ +StaticTemplateEngine | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class StaticTemplateEngine<T>

+
+

Template engine that renders output based on a static template file.

+
+
+
+

Type Parameters

+
    +
  • +

    T extends Dict<unknown> = Dict<unknown>

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
template +templateEngine +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly template

+
template: Template
+
+

Private Readonly templateEngine

+
templateEngine: AsyncHandler<TemplateEngineInput<T>, string>
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/StaticThrowHandler.html b/7.x/docs/classes/StaticThrowHandler.html new file mode 100644 index 000000000..8c56a35c9 --- /dev/null +++ b/7.x/docs/classes/StaticThrowHandler.html @@ -0,0 +1,182 @@ +StaticThrowHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class StaticThrowHandler

+
+

Utility handler that can handle all input and always throws an instance of the given error.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
error +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly error

+
error: HttpError<number>
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: unknown
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: unknown
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<never>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/StorageDescriber.html b/7.x/docs/classes/StorageDescriber.html new file mode 100644 index 000000000..97354735a --- /dev/null +++ b/7.x/docs/classes/StorageDescriber.html @@ -0,0 +1,174 @@ +StorageDescriber | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class StorageDescriberAbstract

+
+

Generates Quads that need to be added to the given storage description resource.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/StorageDescriptionAdvertiser.html b/7.x/docs/classes/StorageDescriptionAdvertiser.html new file mode 100644 index 000000000..45a231151 --- /dev/null +++ b/7.x/docs/classes/StorageDescriptionAdvertiser.html @@ -0,0 +1,208 @@ +StorageDescriptionAdvertiser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class StorageDescriptionAdvertiser

+
+

Adds a link header pointing to the relevant storage description resource. +Recursively checks parent containers until a storage container is found, +and then appends the provided relative path to determine the storage description resource.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +relativePath +storageStrategy +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly relativePath

+
relativePath: string
+
+

Private Readonly storageStrategy

+
storageStrategy: StorageLocationStrategy
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/StorageDescriptionHandler.html b/7.x/docs/classes/StorageDescriptionHandler.html new file mode 100644 index 000000000..3a6afb86a --- /dev/null +++ b/7.x/docs/classes/StorageDescriptionHandler.html @@ -0,0 +1,228 @@ +StorageDescriptionHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class StorageDescriptionHandler

+
+

Generates the response for GET requests targeting a storage description resource. +The input path needs to match the relative path used to generate storage description resources +and will be used to verify if the container it is linked to is an actual storage.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
describer +path +store +
+
+

Methods

+
canHandle +getStorageIdentifier +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly describer

+
describer: StorageDescriber
+
+

Private Readonly path

+
path: string
+
+

Private Readonly store

+
store: ResourceStore
+
+

Methods

+
+

canHandle

+
+
+

Protected getStorageIdentifier

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/StreamingHttp2023Emitter.html b/7.x/docs/classes/StreamingHttp2023Emitter.html new file mode 100644 index 000000000..ad4f9911e --- /dev/null +++ b/7.x/docs/classes/StreamingHttp2023Emitter.html @@ -0,0 +1,199 @@ +StreamingHttp2023Emitter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class StreamingHttp2023Emitter

+
+

Emits notifications on StreamingHTTPChannel2023 streams. +Uses the response streams found in the provided map. +The key should be the identifier of the topic resource.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +streamMap +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly streamMap

+
streamMap: StreamingHttpMap
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/StreamingHttpListeningActivityHandler.html b/7.x/docs/classes/StreamingHttpListeningActivityHandler.html new file mode 100644 index 000000000..3e105b00c --- /dev/null +++ b/7.x/docs/classes/StreamingHttpListeningActivityHandler.html @@ -0,0 +1,223 @@ +StreamingHttpListeningActivityHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class StreamingHttpListeningActivityHandler

+
+

Listens to an ActivityEmitter and calls the stored NotificationHandlers in case of an event +for every matching notification channel found.

+

Extends StaticHandler so it can be more easily injected into a Components.js configuration. +No class takes this one as input, so to make sure Components.js instantiates it, +it needs to be added somewhere where its presence has no impact, such as the list of initializers.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +source +streamMap +
+
+

Methods

+
canHandle +emit +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly source

+
source: NotificationHandler
+
+

Private Readonly streamMap

+
streamMap: StreamingHttpMap
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: unknown
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Private emit

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      topic: ResourceIdentifier
      • +
    • +
      activity: NamedNode<"https://www.w3.org/ns/activitystreams#Create"> | NamedNode<"https://www.w3.org/ns/activitystreams#object"> | NamedNode<"https://www.w3.org/ns/activitystreams#target"> | NamedNode<"https://www.w3.org/ns/activitystreams#Add"> | NamedNode<"https://www.w3.org/ns/activitystreams#Delete"> | NamedNode<"https://www.w3.org/ns/activitystreams#Remove"> | NamedNode<"https://www.w3.org/ns/activitystreams#Update">
      • +
    • +
      metadata: RepresentationMetadata
    +

    Returns Promise<void>

+
+

handle

+
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: unknown
      +

      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.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/StreamingHttpMap.html b/7.x/docs/classes/StreamingHttpMap.html new file mode 100644 index 000000000..a0c430990 --- /dev/null +++ b/7.x/docs/classes/StreamingHttpMap.html @@ -0,0 +1,456 @@ +StreamingHttpMap | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class StreamingHttpMap

+
+

A SetMultiMap linking identifiers to a set of Streaming HTTP streams. +An extension of WrappedSetMultiMap to make sure Components.js allows us to create this in the config, +as WrappedSetMultiMap has a constructor not supported.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
[toStringTag] +
+
+

Accessors

+
size +
+
+

Methods

+
[iterator] +add +asMap +clear +delete +deleteEntry +distinctKeys +entries +entrySets +forEach +get +has +hasEntry +keys +set +valueSets +values +
+
+

Constructors

+
+

constructor

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      mapConstructor: (new () => Map<string, Set<PassThrough>>) = Map
      +

      Will be used to instantiate the internal Map.

      +
      +
      +
        +
      • +
          +
        • new (): Map<string, Set<PassThrough>>
          • +
        • +

          Returns Map<string, Set<PassThrough>>

      • +
    • +
      Optional iterable: Iterable<readonly [string, PassThrough | ReadonlySet<PassThrough>]>
      +

      Entries to add to the map.

      +
      +
    +

    Returns StreamingHttpMap

    +
+
+

Properties

+
+

Readonly [toStringTag]

+
[toStringTag]: "WrappedSetMultiMap" = 'WrappedSetMultiMap'
+
+

Accessors

+
+

size

+
+
+

Methods

+
+

[iterator]

+
+
+

add

+
+
+

asMap

+
+
+

clear

+
+
+

delete

+
+
+

deleteEntry

+
+
+

distinctKeys

+
+
+

entries

+
+
+

entrySets

+
+
+

forEach

+
    + +
  • +

    Loops over all key/value bindings.

    +
    +
    +

    Parameters

    +
      +
    • +
      callbackfn: ((value, key, map) => void)
      +
        +
      • +
          +
        • (value, key, map): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            value: PassThrough
            • +
          • +
            key: string
            • +
          • +
            map: SetMultiMap<string, PassThrough>
          +

          Returns void

      • +
    • +
      Optional thisArg: unknown
    +

    Returns void

    +
+
+

get

+
    + +
  • +

    Returns all values stored for the given key. +Returns undefined if there are no values for this key.

    +
    +
    +

    Parameters

    +
      +
    • +
      key: string
    +

    Returns undefined | ReadonlySet<PassThrough>

    +
+
+

has

+
+
+

hasEntry

+
+
+

keys

+
+
+

set

+
+
+

valueSets

+
+
+

values

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/StreamingHttpMetadataWriter.html b/7.x/docs/classes/StreamingHttpMetadataWriter.html new file mode 100644 index 000000000..b5adf151b --- /dev/null +++ b/7.x/docs/classes/StreamingHttpMetadataWriter.html @@ -0,0 +1,212 @@ +StreamingHttpMetadataWriter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class StreamingHttpMetadataWriter

+
+

A MetadataWriter that adds a link to the receiveFrom endpoint +of the corresponding Streaming HTTP notifications channel

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
baseUrl +logger +pathPrefix +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly baseUrl

+
baseUrl: string
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly pathPrefix

+
pathPrefix: string
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/StreamingHttpRequestHandler.html b/7.x/docs/classes/StreamingHttpRequestHandler.html new file mode 100644 index 000000000..7492d6be2 --- /dev/null +++ b/7.x/docs/classes/StreamingHttpRequestHandler.html @@ -0,0 +1,269 @@ +StreamingHttpRequestHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class StreamingHttpRequestHandler

+
+

Handles request to Streaming HTTP receiveFrom endopints. +All allowed requests are stored in the StreamingHttpMap

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
authorizer +credentialsExtractor +generator +logger +pathPrefix +permissionReader +serializer +streamMap +
+
+

Methods

+
authorize +canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly authorizer

+
authorizer: Authorizer
+
+

Private Readonly credentialsExtractor

+
credentialsExtractor: CredentialsExtractor
+
+

Private Readonly generator

+
generator: NotificationGenerator
+
+

Protected logger

+
logger: Logger = ...
+
+

Private Readonly pathPrefix

+
pathPrefix: string
+
+

Private Readonly permissionReader

+
permissionReader: PermissionReader
+
+

Private Readonly serializer

+
serializer: NotificationSerializer
+
+

Private Readonly streamMap

+
streamMap: StreamingHttpMap
+
+

Methods

+
+

Private authorize

+
+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SubdomainExtensionBasedMapper.html b/7.x/docs/classes/SubdomainExtensionBasedMapper.html new file mode 100644 index 000000000..dccc5388f --- /dev/null +++ b/7.x/docs/classes/SubdomainExtensionBasedMapper.html @@ -0,0 +1,551 @@ +SubdomainExtensionBasedMapper | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SubdomainExtensionBasedMapper

+
+

Extends the functionality of an ExtensionBasedMapper to support identifiers containing subdomains. +This is mostly only relevant in case you want to support multiple pods with subdomain identifiers +in a single ResourceStore.

+

When converting to/from file paths, the subdomain is interpreted as a folder in the rootFilePath. +The rest of the path is then interpreted relative to that folder. +E.g. http://alice.test.com/foo results in the relative path /alice/foo.

+

In case there is no subdomain in the URL, the baseSubdomain parameter is used instead. +E.g., if the baseSubdomain is "www", http://test.com/foo would result in the relative path /www/foo. +This means that there is no identifier that maps to the rootFilePath itself. +To prevent the possibility of 2 identifiers linking to the same file, +identifiers containing the default subdomain are rejected. +E.g., http://www.test.com/foo would result in a 403, even if http://test.com/foo exists.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
baseParts +baseRequestURI +baseSubdomain +logger +regex +rootFilepath +unknownMediaTypeExtension +
+
+

Methods

+
getAbsolutePath +getContainerUrl +getContentTypeFromPath +getContentTypeFromUrl +getDocumentUrl +getRelativePath +isMetadataPath +mapFilePathToUrl +mapUrlToContainerPath +mapUrlToDocumentPath +mapUrlToFilePath +relativeToUrl +stripExtension +validateRelativePath +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly baseParts

+
baseParts: {
    rest: string;
    scheme: string;
}
+
+

Type declaration

+
    +
  • +
    rest: string
    • +
  • +
    scheme: string
+
+

Protected Readonly baseRequestURI

+
baseRequestURI: string
+
+

Private Readonly baseSubdomain

+
baseSubdomain: string
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly regex

+
regex: RegExp
+
+

Protected Readonly rootFilepath

+
rootFilepath: string
+
+

Protected Readonly unknownMediaTypeExtension

+
unknownMediaTypeExtension: "unknown" = 'unknown'
+
+

Methods

+
+

Protected getAbsolutePath

+
+
+

Protected getContainerUrl

+
+
+

Protected getContentTypeFromPath

+
+
+

Protected getContentTypeFromUrl

+
+
+

Protected getDocumentUrl

+
+
+

Protected getRelativePath

+
+
+

Protected isMetadataPath

+
+
+

mapFilePathToUrl

+
+
+

Protected mapUrlToContainerPath

+
+
+

Protected mapUrlToDocumentPath

+
    + +
  • +

    Maps the given document identifier to a file path, +possibly making alterations to the direct translation +(for instance, based on its content type)). +Determines the content type if none was provided.

    +
    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      The input identifier.

      +
      +
      • +
    • +
      filePath: string
      +

      The direct translation of the identifier onto the file path.

      +
      +
      • +
    • +
      Optional contentType: string
      +

      The content-type provided with the request.

      +
      +
    +

    Returns Promise<ResourceLink>

    A ResourceLink with all the necessary metadata.

    + +
+
+

mapUrlToFilePath

+
    + +
  • +

    Maps the given resource identifier / URL to a file path. +Determines the content type if none was provided. +For containers the content-type input is ignored.

    +
    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      The input identifier.

      +
      +
      • +
    • +
      isMetadata: boolean
      +

      If we need the data or metadata file path.

      +
      +
      • +
    • +
      Optional contentType: string
      +

      The content-type provided with the request.

      +
      +
    +

    Returns Promise<ResourceLink>

    A ResourceLink with all the necessary metadata.

    + +
+
+

Protected relativeToUrl

+
+
+

Protected stripExtension

+
+
+

Protected validateRelativePath

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SubdomainIdentifierGenerator.html b/7.x/docs/classes/SubdomainIdentifierGenerator.html new file mode 100644 index 000000000..ab694b6ec --- /dev/null +++ b/7.x/docs/classes/SubdomainIdentifierGenerator.html @@ -0,0 +1,167 @@ +SubdomainIdentifierGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SubdomainIdentifierGenerator

+
+

Generates identifiers by using the name as a subdomain on the base URL. +Non-alphanumeric characters will be replaced with -.

+

When extracting the pod, the base URl is also seen as a pod as there is no issue of nested containers here.

+
+
+
+

Hierarchy

+
    +
  • SubdomainIdentifierGenerator
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
baseParts +
+
+

Methods

+
extractPod +generate +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly baseParts

+
baseParts: {
    rest: string;
    scheme: string;
}
+
+

Type declaration

+
    +
  • +
    rest: string
    • +
  • +
    scheme: string
+
+

Methods

+
+

extractPod

+
+
+

generate

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SubdomainIdentifierStrategy.html b/7.x/docs/classes/SubdomainIdentifierStrategy.html new file mode 100644 index 000000000..43def6e80 --- /dev/null +++ b/7.x/docs/classes/SubdomainIdentifierStrategy.html @@ -0,0 +1,220 @@ +SubdomainIdentifierStrategy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SubdomainIdentifierStrategy

+
+

An IdentifierStrategy that interprets all subdomains of the given base URL as roots.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
baseUrl +logger +regex +
+
+

Methods

+
contains +getParentContainer +isRootContainer +supportsIdentifier +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly baseUrl

+
baseUrl: string
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly regex

+
regex: RegExp
+
+

Methods

+
+

contains

+
+
+

getParentContainer

+
+
+

isRootContainer

+
+
+

supportsIdentifier

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SubfolderResourcesGenerator.html b/7.x/docs/classes/SubfolderResourcesGenerator.html new file mode 100644 index 000000000..8d02ed66c --- /dev/null +++ b/7.x/docs/classes/SubfolderResourcesGenerator.html @@ -0,0 +1,167 @@ +SubfolderResourcesGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SubfolderResourcesGenerator

+
+

Generates all resources found in specific subfolders of the given template folder. +In case the same resource is defined in several subfolders, +the data of the last subfolder in the list will be used.

+

The results of all the subfolders will be merged so the end result is still a sorted stream of identifiers.

+

One of the main use cases for this class is so template resources can be in a separate folder +than their corresponding authorization resources, +allowing for authorization-independent templates.

+
+
+
+

Hierarchy

+
    +
  • SubfolderResourcesGenerator
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
resourcesGenerator +subfolders +
+
+

Methods

+
generate +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly resourcesGenerator

+
resourcesGenerator: TemplatedResourcesGenerator
+
+

Private Readonly subfolders

+
subfolders: string[]
+
+

Methods

+
+

generate

+
    + +
  • +

    Generates resources with the given options, based on the given template folder. +The output Iterable should be sorted so that containers always appear before their contents.

    +
    +
    +

    Parameters

    +
      +
    • +
      templateFolder: string
      +

      Folder where the templates are located.

      +
      +
      • +
    • +
      location: ResourceIdentifier
      +

      Base identifier.

      +
      +
      • +
    • +
      options: Dict<unknown>
      +

      Options that can be used when generating resources.

      +
      +
    +

    Returns AsyncIterable<Resource>

    A map where the keys are the identifiers and the values the corresponding representations to store.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SuffixAuxiliaryIdentifierStrategy.html b/7.x/docs/classes/SuffixAuxiliaryIdentifierStrategy.html new file mode 100644 index 000000000..893801f5f --- /dev/null +++ b/7.x/docs/classes/SuffixAuxiliaryIdentifierStrategy.html @@ -0,0 +1,218 @@ +SuffixAuxiliaryIdentifierStrategy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SuffixAuxiliaryIdentifierStrategy

+
+

Helper class that uses a suffix to determine if a resource is an auxiliary resource or not. +Simple string matching is used, so the dot needs to be included if needed, e.g. ".acl".

+
+
+
+

Hierarchy

+
    +
  • SuffixAuxiliaryIdentifierStrategy
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
suffix +
+
+

Methods

+
getAuxiliaryIdentifier +getAuxiliaryIdentifiers +getSubjectIdentifier +isAuxiliaryIdentifier +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly suffix

+
suffix: string
+
+

Methods

+
+

getAuxiliaryIdentifier

+
+
+

getAuxiliaryIdentifiers

+
+
+

getSubjectIdentifier

+
+
+

isAuxiliaryIdentifier

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/SuffixIdentifierGenerator.html b/7.x/docs/classes/SuffixIdentifierGenerator.html new file mode 100644 index 000000000..766a13f17 --- /dev/null +++ b/7.x/docs/classes/SuffixIdentifierGenerator.html @@ -0,0 +1,159 @@ +SuffixIdentifierGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class SuffixIdentifierGenerator

+
+

Generates identifiers by appending the name to a stored base identifier. +Non-alphanumeric characters will be replaced with -.

+
+
+
+

Hierarchy

+
    +
  • SuffixIdentifierGenerator
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
base +
+
+

Methods

+
extractPod +generate +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly base

+
base: string
+
+

Methods

+
+

extractPod

+
+
+

generate

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/TargetExtractor.html b/7.x/docs/classes/TargetExtractor.html new file mode 100644 index 000000000..ceb08154c --- /dev/null +++ b/7.x/docs/classes/TargetExtractor.html @@ -0,0 +1,182 @@ +TargetExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class TargetExtractorAbstract

+
+

Extracts a ResourceIdentifier from an incoming HttpRequest.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: {
          request: HttpRequest;
      }
      +

      Input that could potentially be handled.

      +
      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/TargetExtractorErrorHandler.html b/7.x/docs/classes/TargetExtractorErrorHandler.html new file mode 100644 index 000000000..cf89b3c16 --- /dev/null +++ b/7.x/docs/classes/TargetExtractorErrorHandler.html @@ -0,0 +1,199 @@ +TargetExtractorErrorHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class TargetExtractorErrorHandler

+
+

Adds metadata to an error to indicate the identifier of the originally targeted resource.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
errorHandler +targetExtractor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly errorHandler

+
errorHandler: ErrorHandler
+
+

Protected Readonly targetExtractor

+
targetExtractor: TargetExtractor
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/TemplateEngine.html b/7.x/docs/classes/TemplateEngine.html new file mode 100644 index 000000000..b15e8fa91 --- /dev/null +++ b/7.x/docs/classes/TemplateEngine.html @@ -0,0 +1,186 @@ +TemplateEngine | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class TemplateEngine<T>Abstract

+
+

Generic interface for classes that implement a template engine. +A template engine renders content into a template.

+
+
+
+

Type Parameters

+
    +
  • +

    T extends Dict<unknown> = Dict<unknown>

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/TemplatedPodGenerator.html b/7.x/docs/classes/TemplatedPodGenerator.html new file mode 100644 index 000000000..058b8c4da --- /dev/null +++ b/7.x/docs/classes/TemplatedPodGenerator.html @@ -0,0 +1,211 @@ +TemplatedPodGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class TemplatedPodGenerator

+
+

Creates a new ResourceStore when creating a pod based on a Components.js configuration.

+

Part of the dynamic pod creation.

+
    +
  1. It calls a VariableHandler to add necessary variable values. +E.g. setting the base url variable for components.js to the pod identifier.
    2. +
  2. It filters/cleans the input agent values using VariableHandlers
    3. +
  3. It calls a ComponentsJsFactory with the variables and template location to instantiate a new ResourceStore.
    4. +
  4. It stores these values in the configuration storage, which is used as a permanent storage for pod configurations.
    5. +
+
+
+

See

ConfigPodManager, ConfigPodInitializer, BaseUrlRouterRule

+
+
+

Hierarchy

+
    +
  • TemplatedPodGenerator
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
baseUrl +configStorage +configTemplatePath +logger +storeFactory +variableHandler +
+
+

Methods

+
generate +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly baseUrl

+
baseUrl: string
+
+

Private Readonly configStorage

+
configStorage: KeyValueStorage<string, unknown>
+
+

Private Readonly configTemplatePath

+
configTemplatePath: string
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly storeFactory

+
storeFactory: ComponentsJsFactory
+
+

Private Readonly variableHandler

+
variableHandler: VariableHandler
+
+

Methods

+
+

generate

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/TokenOwnershipValidator.html b/7.x/docs/classes/TokenOwnershipValidator.html new file mode 100644 index 000000000..604a22ff3 --- /dev/null +++ b/7.x/docs/classes/TokenOwnershipValidator.html @@ -0,0 +1,287 @@ +TokenOwnershipValidator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class TokenOwnershipValidator

+
+

Validates ownership of a WebId by seeing if a specific triple can be added. +expiration parameter is how long the token should be valid in minutes.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
expiration +logger +storage +
+
+

Methods

+
canHandle +generateToken +getTokenKey +handle +handleSafe +hasToken +throwError +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly expiration

+
expiration: number
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly storage

+
storage: ExpiringStorage<string, string>
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: {
          webId: string;
      }
      +

      Input that could potentially be handled.

      +
      +
      +
        +
      • +
        webId: string
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Private generateToken

+
+
+

Private getTokenKey

+
+
+

handle

+
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      __namedParameters: {
          webId: string;
      }
      +

      Input that needs to be handled.

      +
      +
      +
        +
      • +
        webId: string
    +

    Returns Promise<void>

    A promise resolving when handling is finished.

    + +
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: {
          webId: string;
      }
      +

      Input data that will be handled if it can be handled.

      +
      +
      +
        +
      • +
        webId: string
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Private hasToken

+
+
+

Private throwError

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/TypedNotificationHandler.html b/7.x/docs/classes/TypedNotificationHandler.html new file mode 100644 index 000000000..2b289cc61 --- /dev/null +++ b/7.x/docs/classes/TypedNotificationHandler.html @@ -0,0 +1,199 @@ +TypedNotificationHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class TypedNotificationHandler

+
+

A NotificationHandler that only accepts input for a specific notification channel type.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
source +type +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly source

+
source: NotificationHandler
+
+

Private Readonly type

+
type: string
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/TypedRepresentationConverter.html b/7.x/docs/classes/TypedRepresentationConverter.html new file mode 100644 index 000000000..8c6d23259 --- /dev/null +++ b/7.x/docs/classes/TypedRepresentationConverter.html @@ -0,0 +1,192 @@ +TypedRepresentationConverter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class TypedRepresentationConverterAbstract

+
+

A RepresentationConverter that allows requesting the supported types.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +getOutputTypes +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
+
+

Abstract getOutputTypes

+
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/UnauthorizedHttpError.html b/7.x/docs/classes/UnauthorizedHttpError.html new file mode 100644 index 000000000..1a52a9da2 --- /dev/null +++ b/7.x/docs/classes/UnauthorizedHttpError.html @@ -0,0 +1,228 @@ +UnauthorizedHttpError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class UnauthorizedHttpError

+
+

An error thrown when an agent is not authorized.

+
+
+
+

Hierarchy

+
    +
  • BaseHttpError +
      +
    • UnauthorizedHttpError
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
cause? +errorCode +message +metadata +name +stack? +statusCode +isInstance +statusCode +uri +
+
+

Methods

+
generateMetadata +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Optional Readonly cause

+
cause?: unknown
+
+

Readonly errorCode

+
errorCode: string
+
+

message

+
message: string
+
+

Readonly metadata

+
metadata: RepresentationMetadata
+
+

name

+
name: string
+
+

Optional stack

+
stack?: string
+
+

Readonly statusCode

+
statusCode: 401
+
+

Static Readonly isInstance

+
isInstance: ((error) => error is HttpError<401>)
+
+

Type declaration

+
    +
  • +
      +
    • (error): error is HttpError<401>
      • +
    • +

      Checks whether the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: unknown
      +

      Returns error is HttpError<401>

      +
+
+

Static Readonly statusCode

+
statusCode: 401
+

The status code corresponding to this error class.

+
+
+
+

Static Readonly uri

+
uri: NamedNode<string>
+

A unique URI identifying this error class.

+
+
+
+

Methods

+
+

Protected generateMetadata

+
    + +
  • +

    Initializes the error metadata.

    +
    +

    Returns void

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/UnionCredentialsExtractor.html b/7.x/docs/classes/UnionCredentialsExtractor.html new file mode 100644 index 000000000..dd7a2251d --- /dev/null +++ b/7.x/docs/classes/UnionCredentialsExtractor.html @@ -0,0 +1,259 @@ +UnionCredentialsExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class UnionCredentialsExtractor

+
+

Combines the results of several CredentialsExtractors into one. +If multiple of these extractors return a value for the same key, +the last result will be used.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
handlers +
+
+

Methods

+
allCanHandle +canHandle +combine +handle +handleSafe +setValue +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly handlers

+
handlers: CredentialsExtractor[]
+
+

Methods

+
+

Protected allCanHandle

+
+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: HttpRequest
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

combine

+
+
+

handle

+
+
+

handleSafe

+
+
+

Private setValue

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/UnionHandler.html b/7.x/docs/classes/UnionHandler.html new file mode 100644 index 000000000..04a28437a --- /dev/null +++ b/7.x/docs/classes/UnionHandler.html @@ -0,0 +1,280 @@ +UnionHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class UnionHandler<T>Abstract

+
+

Utility handler that allows combining the results of multiple handlers into one. +Will run the handlers and then call the abstract combine function with the results, +which then generates the handler's output.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
handlers +ignoreErrors +requireAll +
+
+

Methods

+
allCanHandle +canHandle +combine +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
    + +
  • +

    Creates a new UnionHandler.

    +

    When requireAll is false or ignoreErrors is true, +the length of the input to combine can vary; +otherwise, it is exactly the number of handlers.

    +
    +
    +

    Type Parameters

    +
    +
    +

    Parameters

    +
      +
    • +
      handlers: T[]
      +

      The handlers whose output is to be combined.

      +
      +
      • +
    • +
      requireAll: boolean = false
      +

      If true, will fail if any of the handlers do not support the input. + If false, only the handlers that support the input will be called; + will fail only if none of the handlers can handle the input.

      +
      +
      • +
    • +
      ignoreErrors: boolean = !requireAll
      +

      If true, ignores handlers that fail by omitting their output; + if false, fails when any handlers fail.

      +
      +
    +

    Returns UnionHandler<T>

    +
+
+

Properties

+
+

Protected Readonly handlers

+
handlers: T[]
+
+

Private Readonly ignoreErrors

+
ignoreErrors: boolean
+
+

Private Readonly requireAll

+
requireAll: boolean
+
+

Methods

+
+

Protected allCanHandle

+
    + +
  • +

    Checks if all handlers can handle the input. +If not, throw an error based on the errors of the failed handlers.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    +
+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Protected Abstract combine

+
+
+

handle

+
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: AsyncHandlerInput<T>
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<Awaited<ReturnType<T["handle"]>>>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/UnionPermissionReader.html b/7.x/docs/classes/UnionPermissionReader.html new file mode 100644 index 000000000..c56e913a5 --- /dev/null +++ b/7.x/docs/classes/UnionPermissionReader.html @@ -0,0 +1,271 @@ +UnionPermissionReader | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class UnionPermissionReader

+
+

Combines the results of multiple PermissionReaders. +Every permission in every credential type is handled according to the rule false > true > undefined.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
handlers +
+
+

Methods

+
allCanHandle +canHandle +combine +handle +handleSafe +mergePermissionMaps +mergePermissions +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly handlers

+
handlers: PermissionReader[]
+
+

Methods

+
+

Protected allCanHandle

+
+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Protected combine

+
+
+

handle

+
+
+

handleSafe

+
+
+

Private mergePermissionMaps

+
+
+

Private mergePermissions

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/UnionPreferenceParser.html b/7.x/docs/classes/UnionPreferenceParser.html new file mode 100644 index 000000000..c1d3c92b3 --- /dev/null +++ b/7.x/docs/classes/UnionPreferenceParser.html @@ -0,0 +1,243 @@ +UnionPreferenceParser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class UnionPreferenceParser

+
+

Combines the results of multiple PreferenceParsers. +Will throw an error if multiple parsers return a range as these can't logically be combined.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
handlers +
+
+

Methods

+
allCanHandle +canHandle +combine +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly handlers

+
handlers: PreferenceParser[]
+
+

Methods

+
+

Protected allCanHandle

+
+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: {
          request: HttpRequest;
      }
      +

      Input that could potentially be handled.

      +
      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Protected combine

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/UnlinkWebIdHandler.html b/7.x/docs/classes/UnlinkWebIdHandler.html new file mode 100644 index 000000000..c1e714310 --- /dev/null +++ b/7.x/docs/classes/UnlinkWebIdHandler.html @@ -0,0 +1,199 @@ +UnlinkWebIdHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class UnlinkWebIdHandler

+
+

Allows users to remove WebIDs linked to their account.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
webIdRoute +webIdStore +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly webIdRoute

+
webIdRoute: WebIdLinkRoute
+
+

Private Readonly webIdStore

+
webIdStore: WebIdStore
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/UnsecureConstantCredentialsExtractor.html b/7.x/docs/classes/UnsecureConstantCredentialsExtractor.html new file mode 100644 index 000000000..e420d2129 --- /dev/null +++ b/7.x/docs/classes/UnsecureConstantCredentialsExtractor.html @@ -0,0 +1,201 @@ +UnsecureConstantCredentialsExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class UnsecureConstantCredentialsExtractor

+
+

Credentials extractor that authenticates a constant agent +(useful for development or debugging purposes).

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
credentials +logger +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly credentials

+
credentials: Credentials
+
+

Private Readonly logger

+
logger: Logger = ...
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: HttpRequest
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/UnsecureWebIdExtractor.html b/7.x/docs/classes/UnsecureWebIdExtractor.html new file mode 100644 index 000000000..6866c9e67 --- /dev/null +++ b/7.x/docs/classes/UnsecureWebIdExtractor.html @@ -0,0 +1,183 @@ +UnsecureWebIdExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class UnsecureWebIdExtractor

+
+

Credentials extractor which simply interprets the contents of the Authorization header as a WebID.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      __namedParameters: HttpRequest
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/UnsecureWebSocketsProtocol.html b/7.x/docs/classes/UnsecureWebSocketsProtocol.html new file mode 100644 index 000000000..d941b374f --- /dev/null +++ b/7.x/docs/classes/UnsecureWebSocketsProtocol.html @@ -0,0 +1,227 @@ +UnsecureWebSocketsProtocol | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class UnsecureWebSocketsProtocol

+
+

Provides live update functionality following +the Solid WebSockets API Spec solid-0.1.

+

The baseUrl parameter should be the same one that is used to advertise with the Updates-Via header.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
listeners +logger +path +
+
+

Methods

+
canHandle +handle +handleSafe +onResourceChanged +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly listeners

+
listeners: Set<WebSocketListener> = ...
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly path

+
path: string
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+

Private onResourceChanged

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/UnsupportedAsyncHandler.html b/7.x/docs/classes/UnsupportedAsyncHandler.html new file mode 100644 index 000000000..3168af440 --- /dev/null +++ b/7.x/docs/classes/UnsupportedAsyncHandler.html @@ -0,0 +1,174 @@ +UnsupportedAsyncHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class UnsupportedAsyncHandler

+
+

Handler that does not support any input and will always throw an error.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
errorMessage? +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Optional Readonly errorMessage

+
errorMessage?: string
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +

    Returns Promise<never>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: unknown
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<never>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/UnsupportedMediaTypeHttpError.html b/7.x/docs/classes/UnsupportedMediaTypeHttpError.html new file mode 100644 index 000000000..089c493c6 --- /dev/null +++ b/7.x/docs/classes/UnsupportedMediaTypeHttpError.html @@ -0,0 +1,228 @@ +UnsupportedMediaTypeHttpError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class UnsupportedMediaTypeHttpError

+
+

An error thrown when the media type of incoming data is not supported by a parser.

+
+
+
+

Hierarchy

+
    +
  • BaseHttpError +
      +
    • UnsupportedMediaTypeHttpError
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
cause? +errorCode +message +metadata +name +stack? +statusCode +isInstance +statusCode +uri +
+
+

Methods

+
generateMetadata +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Optional Readonly cause

+
cause?: unknown
+
+

Readonly errorCode

+
errorCode: string
+
+

message

+
message: string
+
+

Readonly metadata

+
metadata: RepresentationMetadata
+
+

name

+
name: string
+
+

Optional stack

+
stack?: string
+
+

Readonly statusCode

+
statusCode: 415
+
+

Static Readonly isInstance

+
isInstance: ((error) => error is HttpError<415>)
+
+

Type declaration

+
    +
  • +
      +
    • (error): error is HttpError<415>
      • +
    • +

      Checks whether the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: unknown
      +

      Returns error is HttpError<415>

      +
+
+

Static Readonly statusCode

+
statusCode: 415
+

The status code corresponding to this error class.

+
+
+
+

Static Readonly uri

+
uri: NamedNode<string>
+

A unique URI identifying this error class.

+
+
+
+

Methods

+
+

Protected generateMetadata

+
    + +
  • +

    Initializes the error metadata.

    +
    +

    Returns void

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/UpdateOwnerHandler.html b/7.x/docs/classes/UpdateOwnerHandler.html new file mode 100644 index 000000000..06009f3ab --- /dev/null +++ b/7.x/docs/classes/UpdateOwnerHandler.html @@ -0,0 +1,240 @@ +UpdateOwnerHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class UpdateOwnerHandler

+
+

Responsible for adding/updating/deleting owners in pods.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
podRoute +podStore +
+
+

Methods

+
canHandle +findVerifiedPod +getView +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly podRoute

+
podRoute: PodIdRoute
+
+

Private Readonly podStore

+
podStore: PodStore
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Protected findVerifiedPod

+
    + +
  • +

    Extract the pod ID from the path and find the associated pod. +Asserts that the given account ID is the creator of this pod.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<{
        accountId: string;
        baseUrl: string;
        id: string;
    }>

    +
+
+

getView

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/UpdatePasswordHandler.html b/7.x/docs/classes/UpdatePasswordHandler.html new file mode 100644 index 000000000..b56a3d38a --- /dev/null +++ b/7.x/docs/classes/UpdatePasswordHandler.html @@ -0,0 +1,221 @@ +UpdatePasswordHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class UpdatePasswordHandler

+
+

Allows the password of a login to be updated.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +passwordRoute +passwordStore +
+
+

Methods

+
canHandle +getView +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly logger

+
logger: Logger = ...
+
+

Private Readonly passwordRoute

+
passwordRoute: PasswordIdRoute
+
+

Private Readonly passwordStore

+
passwordStore: PasswordStore
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

getView

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/V6MigrationInitializer.html b/7.x/docs/classes/V6MigrationInitializer.html new file mode 100644 index 000000000..980ff811c --- /dev/null +++ b/7.x/docs/classes/V6MigrationInitializer.html @@ -0,0 +1,331 @@ +V6MigrationInitializer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class V6MigrationInitializer

+
+

Handles migrating account data from v6 to the newer format. +Will only trigger if it is detected that this server was previously started on an older version +and at least one account was found. +Confirmation will be asked to the user through a CLI prompt. +After migration is complete the old data will be removed.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
accountStorage +cleanupStorages +clientCredentialsStorage +logger +newAccountStorage +newSetupStorage +setupStorage +skipConfirmation +versionKey +
+
+

Methods

+
canHandle +createAccount +handle +handleSafe +isAccount +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly accountStorage

+
accountStorage: KeyValueStorage<string, Account | Settings>
+
+

Private Readonly cleanupStorages

+
cleanupStorages: KeyValueStorage<string, unknown>[]
+
+

Private Readonly clientCredentialsStorage

+
clientCredentialsStorage: KeyValueStorage<string, ClientCredentials>
+
+

Private Readonly logger

+
logger: Logger = ...
+
+

Private Readonly newAccountStorage

+
newAccountStorage: AccountLoginStorage<{
    account: {
        rememberLogin: "boolean?";
    };
    clientCredentials: {
        accountId: "id:account";
        label: "string";
        secret: "string";
        webId: "string";
    };
    owner: {
        podId: "id:pod";
        visible: "boolean";
        webId: "string";
    };
    password: {
        accountId: "id:account";
        email: "string";
        password: "string";
        verified: "boolean";
    };
    pod: {
        accountId: "id:account";
        baseUrl: "string";
    };
    webIdLink: {
        accountId: "id:account";
        webId: "string";
    };
}>
+
+

Type declaration

+
    +
  • +
    Readonly account: {
        rememberLogin: "boolean?";
    }
    +
      +
    • +
      Readonly rememberLogin: "boolean?"
    • +
  • +
    Readonly clientCredentials: {
        accountId: "id:account";
        label: "string";
        secret: "string";
        webId: "string";
    }
    +
      +
    • +
      Readonly accountId: "id:account"
      • +
    • +
      Readonly label: "string"
      • +
    • +
      Readonly secret: "string"
      • +
    • +
      Readonly webId: "string"
    • +
  • +
    Readonly owner: {
        podId: "id:pod";
        visible: "boolean";
        webId: "string";
    }
    +
      +
    • +
      Readonly podId: "id:pod"
      • +
    • +
      Readonly visible: "boolean"
      • +
    • +
      Readonly webId: "string"
    • +
  • +
    Readonly password: {
        accountId: "id:account";
        email: "string";
        password: "string";
        verified: "boolean";
    }
    +
      +
    • +
      Readonly accountId: "id:account"
      • +
    • +
      Readonly email: "string"
      • +
    • +
      Readonly password: "string"
      • +
    • +
      Readonly verified: "boolean"
    • +
  • +
    Readonly pod: {
        accountId: "id:account";
        baseUrl: "string";
    }
    +
      +
    • +
      Readonly accountId: "id:account"
      • +
    • +
      Readonly baseUrl: "string"
    • +
  • +
    Readonly webIdLink: {
        accountId: "id:account";
        webId: "string";
    }
    +
      +
    • +
      Readonly accountId: "id:account"
      • +
    • +
      Readonly webId: "string"
+
+

Private Readonly newSetupStorage

+
newSetupStorage: KeyValueStorage<string, string>
+
+

Private Readonly setupStorage

+
setupStorage: KeyValueStorage<string, string>
+
+

Private Readonly skipConfirmation

+
skipConfirmation: boolean
+
+

Private Readonly versionKey

+
versionKey: string
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Protected createAccount

+
    + +
  • +

    Creates a new account based on the account data found in the old storage. +Will always create an account and password entry. +In case useIdp is true, will create a WebID link entry. +In case there is an associated podBaseUrl, will create a pod and owner entry.

    +
    +
    +

    Parameters

    +
      +
    • +
      account: Account | Settings
    +

    Returns Promise<undefined | {
        accountId: string;
        webId: string;
    }>

    +
+
+

handle

+
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      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.

    + +
+
+

Protected isAccount

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ValidatingDataAccessor.html b/7.x/docs/classes/ValidatingDataAccessor.html new file mode 100644 index 000000000..01112afd7 --- /dev/null +++ b/7.x/docs/classes/ValidatingDataAccessor.html @@ -0,0 +1,343 @@ +ValidatingDataAccessor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ValidatingDataAccessor

+
+

A ValidatingDataAccessor wraps a DataAccessor such that the data stream is validated while being written. +An AtomicDataAccessor can be used to prevent data being written in case validation fails.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
accessor +validator +
+
+

Methods

+
canHandle +deleteResource +getChildren +getData +getMetadata +writeContainer +writeDocument +writeMetadata +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly accessor

+
accessor: AtomicDataAccessor
+
+

Private Readonly validator

+
validator: Validator
+
+

Methods

+
+

canHandle

+
+
+

deleteResource

+
+
+

getChildren

+
    + +
  • +

    Returns metadata for all resources in the requested container. +This should not be all metadata of those resources (but it can be), +but instead the main metadata you want to show in situations +where all these resources are presented simultaneously. +Generally this would be metadata that is present for all of these resources, +such as resource type or last modified date.

    +

    It can be safely assumed that the incoming identifier will always correspond to a container.

    +
    +
    +

    Parameters

    +
    +

    Returns AsyncIterableIterator<RepresentationMetadata>

    +
+
+

getData

+
+
+

getMetadata

+
+
+

writeContainer

+
+
+

writeDocument

+
+
+

writeMetadata

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/Validator.html b/7.x/docs/classes/Validator.html new file mode 100644 index 000000000..3ad2ee303 --- /dev/null +++ b/7.x/docs/classes/Validator.html @@ -0,0 +1,174 @@ +Validator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ValidatorAbstract

+
+

Generic interface for classes that validate Representations in some way.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: ValidatorInput
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/VariableHandler.html b/7.x/docs/classes/VariableHandler.html new file mode 100644 index 000000000..da4397e8d --- /dev/null +++ b/7.x/docs/classes/VariableHandler.html @@ -0,0 +1,193 @@ +VariableHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class VariableHandlerAbstract

+
+

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.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/VariableSetter.html b/7.x/docs/classes/VariableSetter.html new file mode 100644 index 000000000..44d1258ac --- /dev/null +++ b/7.x/docs/classes/VariableSetter.html @@ -0,0 +1,222 @@ +VariableSetter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class VariableSetter

+
+

A VariableHandler that will set the given variable to the given value, +unless there already is a value for the variable and override is false.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
override +value +variable +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly override

+
override: boolean
+
+

Private Readonly value

+
value: string
+
+

Private Readonly variable

+
variable: string
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/VersionHandler.html b/7.x/docs/classes/VersionHandler.html new file mode 100644 index 000000000..ae9c5ef1e --- /dev/null +++ b/7.x/docs/classes/VersionHandler.html @@ -0,0 +1,191 @@ +VersionHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class VersionHandler

+
+

Adds the current version of the API to the JSON output. +This version number should be updated every time the API changes.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
source +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly source

+
source: JsonInteractionHandler<Dict<Json>>
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/ViewInteractionHandler.html b/7.x/docs/classes/ViewInteractionHandler.html new file mode 100644 index 000000000..a01d7141f --- /dev/null +++ b/7.x/docs/classes/ViewInteractionHandler.html @@ -0,0 +1,194 @@ +ViewInteractionHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class ViewInteractionHandler

+
+

Utility class for the common case of a JsonInteractionHandler +describing the expected input on a GET request which is needed to do a POST request.

+

Returns the result of a JsonView on GET requests. +POST requests are sent to the JsonInteractionHandler. +Other methods will be rejected.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
source +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly source

+
source: JsonInteractionHandler<Dict<Json>> & JsonView
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/VoidLocker.html b/7.x/docs/classes/VoidLocker.html new file mode 100644 index 000000000..3275913b8 --- /dev/null +++ b/7.x/docs/classes/VoidLocker.html @@ -0,0 +1,217 @@ +VoidLocker | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class VoidLocker

+
+

A ReadWriteLocker where the locks expire after a given time.

+
+
+
+

Hierarchy

+
    +
  • VoidLocker
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +
+
+

Methods

+
withReadLock +withWriteLock +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Methods

+
+

withReadLock

+
    + +
  • +

    As ReadWriteLocker.withReadLock but the locked function gets called with a maintainLock callback function +to reset the lock expiration every time it is called. +The resulting promise will reject once the lock expires.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      Identifier of the resource that needs to be locked.

      +
      +
      • +
    • +
      whileLocked: ((maintainLock) => PromiseOrValue<T>)
      +

      A function to execute while the resource is locked. +Receives a callback as input parameter to maintain the lock.

      +
      +
      +
        +
      • +
          +
        • (maintainLock): PromiseOrValue<T>
          • +
        • +
          +

          Parameters

          +
            +
          • +
            maintainLock: (() => void)
            +
              +
            • +
                +
              • (): void
                • +
              • +

                Returns void

          +

          Returns PromiseOrValue<T>

    +

    Returns Promise<T>

    +
+
+

withWriteLock

+
    + +
  • +

    As ReadWriteLocker.withWriteLock but the locked function gets called with a maintainLock +callback function to reset the lock expiration every time it is called. +The resulting promise will reject once the lock expires.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      identifier: ResourceIdentifier
      +

      Identifier of the resource that needs to be locked.

      +
      +
      • +
    • +
      whileLocked: ((maintainLock) => PromiseOrValue<T>)
      +

      A function to execute while the resource is locked. +Receives a callback as input parameter to maintain the lock.

      +
      +
      +
        +
      • +
          +
        • (maintainLock): PromiseOrValue<T>
          • +
        • +
          +

          Parameters

          +
            +
          • +
            maintainLock: (() => void)
            +
              +
            • +
                +
              • (): void
                • +
              • +

                Returns void

          +

          Returns PromiseOrValue<T>

    +

    Returns Promise<T>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/VoidLogger.html b/7.x/docs/classes/VoidLogger.html new file mode 100644 index 000000000..02168c38c --- /dev/null +++ b/7.x/docs/classes/VoidLogger.html @@ -0,0 +1,245 @@ +VoidLogger | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class VoidLogger

+
+

A logger that does nothing on a log message.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
debug +error +info +log +silly +verbose +warn +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

debug

+
+
+

error

+
+
+

info

+
+
+

log

+
+
+

silly

+
+
+

verbose

+
+
+

warn

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/VoidLoggerFactory.html b/7.x/docs/classes/VoidLoggerFactory.html new file mode 100644 index 000000000..78c9f0538 --- /dev/null +++ b/7.x/docs/classes/VoidLoggerFactory.html @@ -0,0 +1,133 @@ +VoidLoggerFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class VoidLoggerFactory

+
+

A factory that always returns VoidLogger, which does nothing on log messages.

+
+
+
+

Hierarchy

+
    +
  • VoidLoggerFactory
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +
+
+

Methods

+
createLogger +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly logger

+
logger: VoidLogger = ...
+
+

Methods

+
+

createLogger

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WacAllowHttpHandler.html b/7.x/docs/classes/WacAllowHttpHandler.html new file mode 100644 index 000000000..04eb59f2b --- /dev/null +++ b/7.x/docs/classes/WacAllowHttpHandler.html @@ -0,0 +1,243 @@ +WacAllowHttpHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WacAllowHttpHandler

+
+

Adds all the available permissions to the response metadata, +which can be used to generate the correct WAC-Allow header.

+

This class does many things similar to the AuthorizingHttpHandler, +so in general it is a good idea to make sure all these classes cache their results.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
credentialsExtractor +logger +modesExtractor +operationHandler +permissionReader +
+
+

Methods

+
addWacAllowMetadata +canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly credentialsExtractor

+
credentialsExtractor: CredentialsExtractor
+
+

Private Readonly logger

+
logger: Logger = ...
+
+

Private Readonly modesExtractor

+
modesExtractor: ModesExtractor
+
+

Private Readonly operationHandler

+
operationHandler: OperationHttpHandler
+
+

Private Readonly permissionReader

+
permissionReader: PermissionReader
+
+

Methods

+
+

Private addWacAllowMetadata

+
+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WacAllowMetadataWriter.html b/7.x/docs/classes/WacAllowMetadataWriter.html new file mode 100644 index 000000000..0ca6f31f6 --- /dev/null +++ b/7.x/docs/classes/WacAllowMetadataWriter.html @@ -0,0 +1,213 @@ +WacAllowMetadataWriter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WacAllowMetadataWriter

+
+

Add the necessary WAC-Allow header values. +Solid, §10.1: "Servers exposing client’s access privileges on a resource URL MUST advertise +by including the WAC-Allow HTTP header in the response of HTTP HEAD and GET requests." +https://solid.github.io/specification/protocol#web-access-control

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
aclToPermission +canHandle +createAccessParam +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

Private aclToPermission

+
+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Private createAccessParam

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WaterfallHandler.html b/7.x/docs/classes/WaterfallHandler.html new file mode 100644 index 000000000..4a0720e37 --- /dev/null +++ b/7.x/docs/classes/WaterfallHandler.html @@ -0,0 +1,220 @@ +WaterfallHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WaterfallHandler<TIn, TOut>

+
+

A composite handler that tries multiple handlers one by one +until it finds a handler that supports the input. +The handlers will be checked in the order they appear in the input array, +allowing for more fine-grained handlers to check before catch-all handlers.

+
+
+
+

Type Parameters

+
    +
  • +

    TIn

    • +
  • +

    TOut

+
+

Hierarchy

+
    +
  • WaterfallHandler
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
handlers +logger +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly handlers

+
handlers: AsyncHandler<TIn, TOut>[]
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether any of the stored handlers can handle the given input.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      The data that would need to be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if at least 1 handler supports to input, or rejecting if none do.

    + +
+
+

handle

+
    + +
  • +

    Finds a handler that supports the given input and then lets it handle the given data.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      The data that needs to be handled.

      +
      +
    +

    Returns Promise<TOut>

    A promise corresponding to the handle call of a handler that supports the input. +It rejects if no handlers support the given data.

    + +
+
+

handleSafe

+
    + +
  • +

    Identical to AsyncHandler.handleSafe but optimized for composite +by only needing 1 canHandle call on members.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: TIn
      +

      The input data.

      +
      +
    +

    Returns Promise<TOut>

    A promise corresponding to the handle call of a handler that supports the input. +It rejects if no handlers support the given data.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WebAclReader.html b/7.x/docs/classes/WebAclReader.html new file mode 100644 index 000000000..262b9d012 --- /dev/null +++ b/7.x/docs/classes/WebAclReader.html @@ -0,0 +1,389 @@ +WebAclReader | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WebAclReader

+
+

Finds the permissions of a resource as defined in the corresponding ACL resource. +Does not make any deductions such as checking parent containers for create permissions +or applying control permissions for ACL resources.

+

Specific access checks are done by the provided AccessChecker.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
accessChecker +aclStore +aclStrategy +identifierStrategy +logger +resourceSet +
+
+

Methods

+
canHandle +determinePermissions +filterStore +findAuthorizationStatements +findPermissions +getAclMatches +getAclRecursive +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly accessChecker

+
accessChecker: AccessChecker
+
+

Private Readonly aclStore

+
aclStore: ResourceStore
+
+

Private Readonly aclStrategy

+
aclStrategy: AuxiliaryIdentifierStrategy
+
+

Private Readonly identifierStrategy

+
identifierStrategy: IdentifierStrategy
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly resourceSet

+
resourceSet: ResourceSet
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Private determinePermissions

+
    + +
  • +

    Determines the available permissions for the given credentials.

    +
    +
    +

    Parameters

    +
      +
    • +
      acl: Store<Quad, Quad, Quad, Quad>
      +

      Store containing all relevant authorization triples.

      +
      +
      • +
    • +
      credentials: Credentials
      +

      Credentials to find the permissions for.

      +
      +
    +

    Returns Promise<AclPermissionSet>

    +
+
+

Private filterStore

+
    + +
  • +

    Extracts all rules from the store that are relevant for the given target, +based on either the acl:accessTo or acl:default predicates.

    +
    +
    +

    Parameters

    +
      +
    • +
      store: Store<Quad, Quad, Quad, Quad>
      +

      Store to filter.

      +
      +
      • +
    • +
      target: string
      +

      The identifier of which the acl rules need to be known.

      +
      +
      • +
    • +
      directAcl: boolean
      +

      If the store contains triples from the direct acl resource of the target or not. + Determines if acl:accessTo or acl:default are used.

      +
      +
    +

    Returns Promise<Store<Quad, Quad, Quad, Quad>>

    A store containing the relevant triples for the given target.

    + +
+
+

Private findAuthorizationStatements

+
    + +
  • +

    For every ACL/identifier combination it finds the relevant ACL triples for that identifier. +This is done in such a way that store results are reused for all matching identifiers. +The split is based on the acl:accessTo and acl:default triples.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Map<Store<Quad, Quad, Quad, Quad>, ResourceIdentifier[]>>

    +
+
+

Private findPermissions

+
    + +
  • +

    Finds the permissions in the provided WebACL quads.

    +

    Rather than restricting the search to only the required modes, +we collect all modes in order to have complete metadata (for instance, for the WAC-Allow header).

    +
    +
    +

    Parameters

    +
      +
    • +
      aclMap: Map<Store<Quad, Quad, Quad, Quad>, ResourceIdentifier[]>
      +

      A map containing stores of ACL data linked to their relevant identifiers.

      +
      +
      • +
    • +
      credentials: Credentials
      +

      Credentials to check permissions for.

      +
      +
    +

    Returns Promise<PermissionMap>

    +
+
+

Private getAclMatches

+
+
+

Private getAclRecursive

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WebSocket2023Emitter.html b/7.x/docs/classes/WebSocket2023Emitter.html new file mode 100644 index 000000000..aed145e87 --- /dev/null +++ b/7.x/docs/classes/WebSocket2023Emitter.html @@ -0,0 +1,199 @@ +WebSocket2023Emitter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WebSocket2023Emitter

+
+

Emits notifications on WebSocketChannel2023 subscription. +Uses the WebSockets found in the provided map. +The key should be the identifier of the matching channel.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +socketMap +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly socketMap

+
socketMap: SetMultiMap<string, WebSocket>
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WebSocket2023Handler.html b/7.x/docs/classes/WebSocket2023Handler.html new file mode 100644 index 000000000..98ec16257 --- /dev/null +++ b/7.x/docs/classes/WebSocket2023Handler.html @@ -0,0 +1,173 @@ +WebSocket2023Handler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WebSocket2023HandlerAbstract

+
+

A handler that is called when a valid WebSocketChannel2023 connection has been made.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WebSocket2023Listener.html b/7.x/docs/classes/WebSocket2023Listener.html new file mode 100644 index 000000000..a26ab0b9e --- /dev/null +++ b/7.x/docs/classes/WebSocket2023Listener.html @@ -0,0 +1,216 @@ +WebSocket2023Listener | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WebSocket2023Listener

+
+

Listens for WebSocket connections and verifies whether they are valid WebSocketChannel2023 connections, +in which case its WebSocket2023Handler will be alerted.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
baseUrl +handler +logger +storage +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly baseUrl

+
baseUrl: string
+
+

Private Readonly handler

+
handler: WebSocket2023Handler
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly storage

+
storage: NotificationChannelStorage
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WebSocket2023Storer.html b/7.x/docs/classes/WebSocket2023Storer.html new file mode 100644 index 000000000..4c45f18c3 --- /dev/null +++ b/7.x/docs/classes/WebSocket2023Storer.html @@ -0,0 +1,226 @@ +WebSocket2023Storer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WebSocket2023Storer

+
+

Keeps track of the WebSockets that were opened for a WebSocketChannel2023 channel. +The WebSockets are stored in the map using the identifier of the matching channel.

+

cleanupTimer defines in minutes how often the stored WebSockets are closed +if their corresponding channel has expired. +Defaults to 60 minutes. +Open WebSockets will not receive notifications if their channel expired.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +socketMap +storage +
+
+

Methods

+
canHandle +closeExpiredSockets +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly socketMap

+
socketMap: SetMultiMap<string, WebSocket>
+
+

Private Readonly storage

+
storage: NotificationChannelStorage
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Private closeExpiredSockets

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WebSocketAdvertiser.html b/7.x/docs/classes/WebSocketAdvertiser.html new file mode 100644 index 000000000..0a5475421 --- /dev/null +++ b/7.x/docs/classes/WebSocketAdvertiser.html @@ -0,0 +1,193 @@ +WebSocketAdvertiser | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WebSocketAdvertiser

+
+

Handler that advertises a WebSocket through the Updates-Via header.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
socketUrl +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly socketUrl

+
socketUrl: string
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WebSocketChannel2023Type.html b/7.x/docs/classes/WebSocketChannel2023Type.html new file mode 100644 index 000000000..45e51c51c --- /dev/null +++ b/7.x/docs/classes/WebSocketChannel2023Type.html @@ -0,0 +1,336 @@ +WebSocketChannel2023Type | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WebSocketChannel2023Type

+
+

The notification channel type WebSocketChannel2023 as described in +https://solid.github.io/notifications/websocket-channel-2023

+

Requires read permissions on a resource to be able to receive notifications.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
features +logger +path +shacl +shaclQuads? +type +
+
+

Methods

+
completeChannel +extractModes +getDescription +getShaclQuads +initChannel +quadsToChannel +toJsonLd +validateSubscription +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly features

+
features: NamedNode<string>[]
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Protected Readonly path

+
path: string
+
+

Protected Readonly shacl

+
shacl: unknown
+
+

Protected Optional shaclQuads

+
shaclQuads?: Store<Quad, Quad, Quad, Quad>
+
+

Protected Readonly type

+
type: NamedNode<string>
+
+

Methods

+
+

completeChannel

+
+
+

extractModes

+
+
+

getDescription

+
+
+

Protected getShaclQuads

+
    + +
  • +

    Returns an N3.js Store containing quads corresponding to the stored SHACL representation. +Caches this result so the conversion from JSON-LD to quads only has to happen once.

    +
    +

    Returns Promise<Store<Quad, Quad, Quad, Quad>>

    +
+
+

initChannel

+
+
+

Protected quadsToChannel

+
+
+

toJsonLd

+
    + +
  • +

    Converts the given channel to a JSON-LD description. +All fields found in the channel, except lastEmit, will be part of the result subject, +so subclasses should remove any fields that should not be exposed.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Record<string, unknown>>

    +
+
+

Protected validateSubscription

+
    + +
  • +

    Validates whether the given data conforms to the stored SHACL shape. +Will throw an UnprocessableEntityHttpError if validation fails. +Along with the SHACL check, this also makes sure there is only one matching entry in the dataset.

    +
    +
    +

    Parameters

    +
      +
    • +
      data: Store<Quad, Quad, Quad, Quad>
      +

      The data to validate.

      +
      +
    +

    Returns Promise<Term>

    The focus node that corresponds to the subject of the found notification channel description.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WebSocketHandler.html b/7.x/docs/classes/WebSocketHandler.html new file mode 100644 index 000000000..ca8255570 --- /dev/null +++ b/7.x/docs/classes/WebSocketHandler.html @@ -0,0 +1,174 @@ +WebSocketHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WebSocketHandlerAbstract

+
+

A handler to support requests trying to open a WebSocket connection.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Abstract handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WebSocketMap.html b/7.x/docs/classes/WebSocketMap.html new file mode 100644 index 000000000..0b5fa721e --- /dev/null +++ b/7.x/docs/classes/WebSocketMap.html @@ -0,0 +1,456 @@ +WebSocketMap | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WebSocketMap

+
+

A SetMultiMap linking identifiers to a set of WebSockets. +An extension of WrappedSetMultiMap to make sure Components.js allows us to create this in the config, +as WrappedSetMultiMap has a constructor not supported.

+
+
+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
[toStringTag] +
+
+

Accessors

+
size +
+
+

Methods

+
[iterator] +add +asMap +clear +delete +deleteEntry +distinctKeys +entries +entrySets +forEach +get +has +hasEntry +keys +set +valueSets +values +
+
+

Constructors

+
+

constructor

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      mapConstructor: (new () => Map<string, Set<WebSocket>>) = Map
      +

      Will be used to instantiate the internal Map.

      +
      +
      +
        +
      • +
          +
        • new (): Map<string, Set<WebSocket>>
          • +
        • +

          Returns Map<string, Set<WebSocket>>

      • +
    • +
      Optional iterable: Iterable<readonly [string, WebSocket | ReadonlySet<WebSocket>]>
      +

      Entries to add to the map.

      +
      +
    +

    Returns WebSocketMap

    +
+
+

Properties

+
+

Readonly [toStringTag]

+
[toStringTag]: "WrappedSetMultiMap" = 'WrappedSetMultiMap'
+
+

Accessors

+
+

size

+
+
+

Methods

+
+

[iterator]

+
+
+

add

+
+
+

asMap

+
+
+

clear

+
+
+

delete

+
+
+

deleteEntry

+
+
+

distinctKeys

+
+
+

entries

+
+
+

entrySets

+
+
+

forEach

+
    + +
  • +

    Loops over all key/value bindings.

    +
    +
    +

    Parameters

    +
      +
    • +
      callbackfn: ((value, key, map) => void)
      +
        +
      • +
          +
        • (value, key, map): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            value: WebSocket
            • +
          • +
            key: string
            • +
          • +
            map: SetMultiMap<string, WebSocket>
          +

          Returns void

      • +
    • +
      Optional thisArg: unknown
    +

    Returns void

    +
+
+

get

+
    + +
  • +

    Returns all values stored for the given key. +Returns undefined if there are no values for this key.

    +
    +
    +

    Parameters

    +
      +
    • +
      key: string
    +

    Returns undefined | ReadonlySet<WebSocket>

    +
+
+

has

+
+
+

hasEntry

+
+
+

keys

+
+
+

set

+
+
+

valueSets

+
+
+

values

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WebSocketServerConfigurator.html b/7.x/docs/classes/WebSocketServerConfigurator.html new file mode 100644 index 000000000..2198012c2 --- /dev/null +++ b/7.x/docs/classes/WebSocketServerConfigurator.html @@ -0,0 +1,198 @@ +WebSocketServerConfigurator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WebSocketServerConfigurator

+
+

ServerConfigurator that adds WebSocket functionality to an existing Server.

+

Listens for WebSocket requests and sends them to its handler.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
handler +logger +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly handler

+
handler: WebSocketHandler
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Server<typeof IncomingMessage, typeof ServerResponse>
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      server: Server<typeof IncomingMessage, typeof ServerResponse>
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving when handling is finished.

    + +
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: Server<typeof IncomingMessage, typeof ServerResponse>
      +

      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.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WebhookChannel2023Type.html b/7.x/docs/classes/WebhookChannel2023Type.html new file mode 100644 index 000000000..0a7449bc5 --- /dev/null +++ b/7.x/docs/classes/WebhookChannel2023Type.html @@ -0,0 +1,366 @@ +WebhookChannel2023Type | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WebhookChannel2023Type

+
+

The notification channel type WebhookChannel2023 as described in +https://solid.github.io/notifications/webhook-channel-2023

+

Requires read permissions on a resource to be able to receive notifications.

+

Also handles the state feature if present.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
features +logger +path +shacl +shaclQuads? +stateHandler +type +webId +
+
+

Methods

+
completeChannel +extractModes +getDescription +getShaclQuads +initChannel +quadsToChannel +toJsonLd +validateSubscription +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly features

+
features: NamedNode<string>[]
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Protected Readonly path

+
path: string
+
+

Protected Readonly shacl

+
shacl: unknown
+
+

Protected Optional shaclQuads

+
shaclQuads?: Store<Quad, Quad, Quad, Quad>
+
+

Private Readonly stateHandler

+
stateHandler: StateHandler
+
+

Protected Readonly type

+
type: NamedNode<string>
+
+

Private Readonly webId

+
webId: string
+
+

Methods

+
+

completeChannel

+
+
+

extractModes

+
+
+

getDescription

+
+
+

Protected getShaclQuads

+
    + +
  • +

    Returns an N3.js Store containing quads corresponding to the stored SHACL representation. +Caches this result so the conversion from JSON-LD to quads only has to happen once.

    +
    +

    Returns Promise<Store<Quad, Quad, Quad, Quad>>

    +
+
+

initChannel

+
+
+

Protected quadsToChannel

+
+
+

toJsonLd

+
+
+

Protected validateSubscription

+
    + +
  • +

    Validates whether the given data conforms to the stored SHACL shape. +Will throw an UnprocessableEntityHttpError if validation fails. +Along with the SHACL check, this also makes sure there is only one matching entry in the dataset.

    +
    +
    +

    Parameters

    +
      +
    • +
      data: Store<Quad, Quad, Quad, Quad>
      +

      The data to validate.

      +
      +
    +

    Returns Promise<Term>

    The focus node that corresponds to the subject of the found notification channel description.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WebhookEmitter.html b/7.x/docs/classes/WebhookEmitter.html new file mode 100644 index 000000000..a04cb675e --- /dev/null +++ b/7.x/docs/classes/WebhookEmitter.html @@ -0,0 +1,229 @@ +WebhookEmitter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WebhookEmitter

+
+

Emits a notification representation using the WebhookChannel2023 specification.

+

At the time of writing it is not specified how exactly a notification sender should make its requests verifiable, +so for now we use a token similar to those from Solid-OIDC, signed by the server itself.

+

Generates a DPoP token and proof, and adds those to the HTTP request that is sent to the target.

+

The expiration input parameter is how long the generated token should be valid in minutes. +Default is 20.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
expiration +issuer +jwkGenerator +logger +webId +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly expiration

+
expiration: number
+
+

Private Readonly issuer

+
issuer: string
+
+

Private Readonly jwkGenerator

+
jwkGenerator: JwkGenerator
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly webId

+
webId: string
+
+

Methods

+
+

canHandle

+
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WebhookWebId.html b/7.x/docs/classes/WebhookWebId.html new file mode 100644 index 000000000..7c77a93e0 --- /dev/null +++ b/7.x/docs/classes/WebhookWebId.html @@ -0,0 +1,192 @@ +WebhookWebId | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WebhookWebId

+
+

Generates a fixed WebID that we use to identify the server for notifications sent using a WebhookChannel2023. +This is used in tandem with the tokens generated by the WebhookEmitter. +This is a minimal WebID with only the solid:oidcIssuer triple.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
turtle +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly turtle

+
turtle: string
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WinstonLogger.html b/7.x/docs/classes/WinstonLogger.html new file mode 100644 index 000000000..efb323e95 --- /dev/null +++ b/7.x/docs/classes/WinstonLogger.html @@ -0,0 +1,282 @@ +WinstonLogger | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WinstonLogger

+
+

A WinstonLogger implements the Logger interface using a given winston logger.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +
+
+

Methods

+
debug +error +info +log +silly +verbose +warn +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly logger

+
logger: Logger
+
+

Methods

+
+

debug

+
+
+

error

+
+
+

info

+
+
+

log

+
    + +
  • +

    Log the given message at the given level. +If the internal level is higher than the given level, the message may be voided.

    +
    +
    +

    Parameters

    +
      +
    • +
      level: "error" | "warn" | "info" | "verbose" | "debug" | "silly"
      +

      The level to log at.

      +
      +
      • +
    • +
      message: string
      +

      The message to log.

      +
      +
      • +
    • +
      Optional meta: unknown
      +

      Optional metadata to include in the log message.

      +
      +
    +

    Returns WinstonLogger

    +
+
+

silly

+
+
+

verbose

+
+
+

warn

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WinstonLoggerFactory.html b/7.x/docs/classes/WinstonLoggerFactory.html new file mode 100644 index 000000000..554811cb8 --- /dev/null +++ b/7.x/docs/classes/WinstonLoggerFactory.html @@ -0,0 +1,167 @@ +WinstonLoggerFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WinstonLoggerFactory

+
+

Uses the winston library to create loggers for the given logging level. +By default, it will print to the console with colorized logging levels.

+

This creates instances of WinstonLogger.

+
+
+
+

Hierarchy

+
    +
  • WinstonLoggerFactory
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
level +
+
+

Methods

+
clusterInfo +createLogger +createTransports +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly level

+
level: string
+
+

Methods

+
+

Private Readonly clusterInfo

+
+
+

createLogger

+
+
+

Protected createTransports

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WorkerManager.html b/7.x/docs/classes/WorkerManager.html new file mode 100644 index 000000000..ecc70e1e7 --- /dev/null +++ b/7.x/docs/classes/WorkerManager.html @@ -0,0 +1,182 @@ +WorkerManager | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WorkerManager

+
+

Spawns the necessary workers when starting in multithreaded mode.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
clusterManager +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly clusterManager

+
clusterManager: ClusterManager
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: void
      +

      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.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WrappedExpiringReadWriteLocker.html b/7.x/docs/classes/WrappedExpiringReadWriteLocker.html new file mode 100644 index 000000000..d929f903e --- /dev/null +++ b/7.x/docs/classes/WrappedExpiringReadWriteLocker.html @@ -0,0 +1,289 @@ +WrappedExpiringReadWriteLocker | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WrappedExpiringReadWriteLocker

+
+

Wraps around an existing ReadWriteLocker and adds expiration logic to prevent locks from getting stuck.

+
+
+
+

Hierarchy

+
    +
  • WrappedExpiringReadWriteLocker
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
expiration +locker +logger +
+
+

Methods

+
expiringPromise +withReadLock +withWriteLock +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly expiration

+
expiration: number
+
+

Protected Readonly locker

+
locker: ReadWriteLocker
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Methods

+
+

Private expiringPromise

+
    + +
  • +

    Creates a Promise that either resolves the given input function or rejects if time runs out, +whichever happens first. The input function can reset the timer by calling the maintainLock function +it receives. The ResourceIdentifier is only used for logging.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
    +

    Returns Promise<T>

    +
+
+

withReadLock

+
+
+

withWriteLock

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WrappedExpiringStorage.html b/7.x/docs/classes/WrappedExpiringStorage.html new file mode 100644 index 000000000..d21c52cc7 --- /dev/null +++ b/7.x/docs/classes/WrappedExpiringStorage.html @@ -0,0 +1,390 @@ +WrappedExpiringStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WrappedExpiringStorage<TKey, TValue>

+
+

A storage that wraps around another storage and expires resources based on the given (optional) expiry date. +Will delete expired entries when trying to get their value. +Has a timer that will delete all expired data every hour (default value).

+
+
+
+

Type Parameters

+
    +
  • +

    TKey

    • +
  • +

    TValue

+
+

Hierarchy

+
    +
  • WrappedExpiringStorage
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +source +timer +
+
+

Methods

+
delete +entries +get +getUnexpired +has +isExpired +removeExpiredEntries +set +toData +toExpires +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly source

+
source: KeyValueStorage<TKey, Expires<TValue>>
+
+

Private Readonly timer

+
timer: Timeout
+
+

Methods

+
+

delete

+
+
+

entries

+
+
+

get

+
+
+

Private getUnexpired

+
    + +
  • +

    Tries to get the data for the given key. +In case the data exists but has expired, +it will be deleted and undefined will be returned instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      key: TKey
    +

    Returns Promise<undefined | TValue>

    +
+
+

has

+
+
+

Private isExpired

+
+
+

Private removeExpiredEntries

+
+
+

set

+
+
+

Private toData

+
    + +
  • +

    Creates a new object where the expires field is a Date instead of a string.

    +
    +
    +

    Parameters

    +
    +

    Returns {
        expires?: Date;
        payload: TValue;
    }

    +
      +
    • +
      Optional expires?: Date
      • +
    • +
      payload: TValue
    +
+
+

Private toExpires

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WrappedIndexedStorage.html b/7.x/docs/classes/WrappedIndexedStorage.html new file mode 100644 index 000000000..60708cb0c --- /dev/null +++ b/7.x/docs/classes/WrappedIndexedStorage.html @@ -0,0 +1,1018 @@ +WrappedIndexedStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WrappedIndexedStorage<T>

+
+

An IndexedStorage that makes use of 2 KeyValueStorages to implement the interface. +Due to being limited by key/value storages, there are some restrictions on the allowed type definitions:

+
    +
  • There needs to be exactly 1 type with no references to other types.
    • +
  • All other types need to have exactly 1 reference to another type.
    • +
  • Types can't reference each other to create a cycle of references.
    • +
+

All of the above to create a tree-like structure of references. +Such a tree is then stored in one of the storages. +The other storage is used to store all indexes that are used to find the correct tree object when solving queries.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
    +
  • WrappedIndexedStorage
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
indexStorage +indexes +logger +relations +rootTypeVar +validDefinition +valueStorage +
+
+

Accessors

+
rootType +
+
+

Methods

+
create +createIndex +defineType +delete +entries +find +findIds +findIndexedRoots +get +getChildObjects +getChildRelations +getContainingRecord +getIndexKey +getParentRelation +getPathRecords +getPathToType +getRoot +has +set +setField +solveQuery +toTypeObject +updateDeepTypeIndex +updateKeyIndex +updateTypeIndex +updateValue +validateDefinition +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly indexStorage

+
indexStorage: KeyValueStorage<string, string[]>
+
+

Private Readonly indexes

+
indexes: {
    [K in string]?: Set<StringKey<T[K]>>
}
+

For every type, the keys on which an index tracks the values and which root object they are contained in. +All types for which a defineType call was made will have a key in this object. +For all types that are not the root, there will always be an index on their ID value.

+
+
+
+

Protected Readonly logger

+
logger: Logger = ...
+
+

Private Readonly relations

+
relations: IndexRelation<T>[]
+

All parent/child relations between all types in the storage, +including the keys in both types that are used to reference each other.

+
+
+
+

Private rootTypeVar

+
rootTypeVar: undefined | StringKey<T>
+

The variable in which the root type is stored. +A separate getter is used to always return the value +so the potential undefined does not have to be taken into account.

+
+
+
+

Private validDefinition

+
validDefinition: boolean = false
+

Keeps track of type validation. +If true the defined types create a valid structure that can be used.

+
+
+
+

Private Readonly valueStorage

+
valueStorage: KeyValueStorage<string, VirtualObject>
+
+

Accessors

+
+

Protected rootType

+
    +
  • get rootType(): string
    • +
  • +

    The root type for this storage. +Use this instead of rootTypeVar to prevent having to check for undefined. +This value will always be defined if the type definitions have been validated.

    +
    +

    Returns string

    +
+
+

Methods

+
+

create

+
    + +
  • +

    Creates an object of the given type. +The storage will generate an identifier for the newly created object.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type to create.

      +
      +
      • +
    • +
      value: CreateTypeObject<T[TType]>
      +

      The value to set for the created object.

      +
      +
    +

    Returns Promise<TypeObject<T[TType]>>

    A representation of the newly created object, including its new identifier.

    + +
+
+

createIndex

+
    + +
  • +

    Creates an index on a key of the given type, to allow for better queries involving those keys. +Similar to IndexedStorage.defineType these calls need to happen first.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type to create an index on.

      +
      +
      • +
    • +
      key: StringKey<T[TType]>
      +

      The key of that type to create an index on.

      +
      +
    +

    Returns Promise<void>

    +
+
+

defineType

+
    + +
  • +

    Informs the storage of the definition of a specific type. +A definition is a key/value object with the values being a valid ValueTypeDescription. +Generally, this call needs to happen for every type of this storage, +and before any calls are made to interact with the data.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type to define.

      +
      +
      • +
    • +
      description: T[TType]
      +

      A description of the values stored in objects of that type.

      +
      +
    +

    Returns Promise<void>

    +
+
+

delete

+
    + +
  • +

    Deletes the given object. +This will also delete all objects that reference that object if the corresponding key is not optional.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type of the object to delete.

      +
      +
      • +
    • +
      id: string
      +

      The identifier of the object.

      +
      +
    +

    Returns Promise<void>

    +
+
+

entries

+
+
+

find

+
    + +
  • +

    Finds all objects matching a specific IndexedQuery.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type of objects to find.

      +
      +
      • +
    • +
      query: {
          [K in string | number | symbol]?: ValueType<T[TType][K]> | (T[TType][K] extends `id:${U}`
              ? ({ [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<...> | ... 1 more ... | undefined; } : never) | undefined; } : never) | undefined; })
              : never)
      }
      +

      The query to execute.

      +
      +
    +

    Returns Promise<TypeObject<T[TType]>[]>

    A list of objects matching the query.

    + +
+
+

findIds

+
    + +
  • +

    Similar to IndexedStorage.find, but only returns the identifiers of the found objects.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type of objects to find.

      +
      +
      • +
    • +
      query: {
          [K in string | number | symbol]?: ValueType<T[TType][K]> | (T[TType][K] extends `id:${U}`
              ? ({ [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<...> | ... 1 more ... | undefined; } : never) | undefined; } : never) | undefined; })
              : never)
      }
      +

      The query to execute.

      +
      +
    +

    Returns Promise<string[]>

    A list of identifiers of the matching objects.

    + +
+
+

Protected findIndexedRoots

+
    + +
  • +

    Finds the IDs of all root objects that contain objects of the given type matching the given query +by making use of the indexes applicable to the keys in the query. +This function only looks at the keys in the query with primitive values, +object values in the query referencing parent objects are not considered. +Similarly, only indexes are used, keys without index are also ignored.

    +

    If an array of root IDs is provided as input, +the result will be an intersection of this array and the found identifiers.

    +

    If the result is an empty array, it means that there is no valid identifier matching the query, +while an undefined result means there is no index matching any of the query keys, +so a result can't be determined.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      • +
    • +
      match: {
          [K in string | number | symbol]?: ValueType<T[TType][K]> | (T[TType][K] extends `id:${U}`
              ? ({ [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<...> | ... 1 more ... | undefined; } : never) | undefined; } : never) | undefined; })
              : never)
      }
      • +
    • +
      Optional rootIds: string[]
    +

    Returns Promise<undefined | string[]>

    +
+
+

get

+
    + +
  • +

    Returns the object of the given type with the given identifier.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type of object to get.

      +
      +
      • +
    • +
      id: string
      +

      The identifier of that object.

      +
      +
    +

    Returns Promise<undefined | TypeObject<T[TType]>>

    A representation of the object, or undefined if there is no object of that type with that identifier.

    + +
+
+

Protected getChildObjects

+
+
+

Protected getChildRelations

+
+
+

Protected getContainingRecord

+
    + +
  • +

    Finds the record in the given object that contains the given type/id combination. +This function assumes it was already verified through an index that this object contains the given combination.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
    +

    Returns Record<string, VirtualObject>

    +
+
+

Protected getIndexKey

+
    + +
  • +

    Generate the key used to store the index in the index storage.

    +
    +
    +

    Parameters

    +
      +
    • +
      type: string
      • +
    • +
      key: string
      • +
    • +
      value: string | number
    +

    Returns string

    +
+
+

Protected getParentRelation

+
    + +
  • +

    Returns the relation where the given type is the child. +Will return undefined for the root type as that one doesn't have a parent.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
    +

    Returns undefined | IndexRelation<T>

    +
+
+

Protected getPathRecords

+
+
+

Protected getPathToType

+
    + +
  • +

    Returns the sequence of virtual keys that need to be accessed to reach the given type, starting from the root.

    +
    +
    +

    Parameters

    +
      +
    • +
      type: string
    +

    Returns `**${string}**`[]

    +
+
+

Protected getRoot

+
+
+

has

+
    + +
  • +

    Returns true if the object of the given type with the given identifier exists.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type of object to get.

      +
      +
      • +
    • +
      id: string
      +

      The identifier of that object.

      +
      +
    +

    Returns Promise<boolean>

    Whether this object exists.

    + +
+
+

set

+
    + +
  • +

    Sets the value of a specific object. +The identifier in the object is used to identify the object.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type of the object to set.

      +
      +
      • +
    • +
      value: TypeObject<T[TType]>
      +

      The new value for the object.

      +
      +
    +

    Returns Promise<void>

    +
+
+

setField

+
    + +
  • +

    Sets the value of one specific field in an object.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

      • +
    • +

      TKey extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      +

      The type of the object to update.

      +
      +
      • +
    • +
      id: string
      +

      The identifier of the object to update.

      +
      +
      • +
    • +
      key: TKey
      +

      The key to update.

      +
      +
      • +
    • +
      value: ValueType<T[TType][TKey]>
      +

      The new value for the given key.

      +
      +
    +

    Returns Promise<void>

    +
+
+

Protected solveQuery

+
    + +
  • +

    Finds all objects of the given type matching the query. +The rootIds array can be used to restrict the IDs of root objects to look at, +which is relevant for the recursive calls the function does.

    +

    Will throw an error if there is no index that can be used to solve the query.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      • +
    • +
      query: {
          [K in string | number | symbol]?: ValueType<T[TType][K]> | (T[TType][K] extends `id:${U}`
              ? ({ [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<...> | ... 1 more ... | undefined; } : never) | undefined; } : never) | undefined; })
              : never)
      }
      • +
    • +
      Optional rootIds: string[]
    +

    Returns Promise<VirtualObject[]>

    +
+
+

Protected toTypeObject

+
+
+

Protected updateDeepTypeIndex

+
    + +
  • +

    Update all indexes for an object of the given type, and all its children.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    +
+
+

Protected updateKeyIndex

+
    + +
  • +

    Updates the index for a specific key of an object of the given type.

    +
    +
    +

    Parameters

    +
      +
    • +
      type: string
      • +
    • +
      key: string
      • +
    • +
      value: string
      • +
    • +
      rootId: string
      • +
    • +
      add: boolean
    +

    Returns Promise<void>

    +
+
+

Protected updateTypeIndex

+
    + +
  • +

    Updates all indexes for an object of the given type.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    +
+
+

Protected updateValue

+
    + +
  • +

    Replaces an object of the given type. +The identifier in the value is used to determine which object.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      • +
    • +
      value: TypeObject<T[TType]>
      • +
    • +
      replace: true
    +

    Returns Promise<void>

    +
    • + +
  • +

    Replaces part of an object of the given type with the given partial value. +The identifier in the value is used to determine which object.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends string

    +
    +

    Parameters

    +
      +
    • +
      type: TType
      • +
    • +
      partial: Partial<TypeObject<T[TType]>> & {
          id: string;
      }
      • +
    • +
      replace: false
    +

    Returns Promise<void>

    +
+
+

Protected validateDefinition

+
    + +
  • +

    Makes sure the defined types fulfill all the requirements necessary for types on this storage. +Will throw an error if this is not the case. +This should be called before doing any data interactions. +Stores success in a variable so future calls are instantaneous.

    +
    +
    +

    Parameters

    +
      +
    • +
      type: string
    +

    Returns void

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WrappedSetMultiMap.html b/7.x/docs/classes/WrappedSetMultiMap.html new file mode 100644 index 000000000..670d378eb --- /dev/null +++ b/7.x/docs/classes/WrappedSetMultiMap.html @@ -0,0 +1,486 @@ +WrappedSetMultiMap | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WrappedSetMultiMap<TKey, TVal>

+
+

A SetMultiMap that uses an internal Map based on the provided constructor.

+

In case no input constructor is provided, the default Map implementation will be used.

+

It is required that the value type of this map is not Set or any extension of Set, +otherwise the set and add functions wil break.

+
+
+
+

Type Parameters

+
    +
  • +

    TKey

    • +
  • +

    TVal

+
+

Hierarchy

+
+
+

Implements

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
[toStringTag] +count +map +
+
+

Accessors

+
size +
+
+

Methods

+
[iterator] +add +asMap +clear +delete +deleteEntry +distinctKeys +entries +entrySets +forEach +get +has +hasEntry +keys +set +valueSets +values +
+
+

Constructors

+
+

constructor

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      TKey

      • +
    • +

      TVal

    +
    +

    Parameters

    +
      +
    • +
      mapConstructor: (new () => Map<TKey, Set<TVal>>) = Map
      +

      Will be used to instantiate the internal Map.

      +
      +
      +
        +
      • +
          +
        • new (): Map<TKey, Set<TVal>>
          • +
        • +

          Returns Map<TKey, Set<TVal>>

      • +
    • +
      Optional iterable: Iterable<readonly [TKey, TVal | ReadonlySet<TVal>]>
      +

      Entries to add to the map.

      +
      +
    +

    Returns WrappedSetMultiMap<TKey, TVal>

    +
+
+

Properties

+
+

Readonly [toStringTag]

+
[toStringTag]: "WrappedSetMultiMap" = 'WrappedSetMultiMap'
+
+

Private count

+
count: number
+
+

Private Readonly map

+
map: Map<TKey, Set<TVal>>
+
+

Accessors

+
+

size

+
+
+

Methods

+
+

[iterator]

+
+
+

add

+
+
+

asMap

+
+
+

clear

+
+
+

delete

+
+
+

deleteEntry

+
+
+

distinctKeys

+
+
+

entries

+
+
+

entrySets

+
    + +
  • +

    Iterates over all distinct keys in this Map, together with a Set of their values.

    +
    +

    Returns IterableIterator<[TKey, ReadonlySet<TVal>]>

    +
+
+

forEach

+
    + +
  • +

    Loops over all key/value bindings.

    +
    +
    +

    Parameters

    +
      +
    • +
      callbackfn: ((value, key, map) => void)
      +
        +
      • +
          +
        • (value, key, map): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            value: TVal
            • +
          • +
            key: TKey
            • +
          • +
            map: SetMultiMap<TKey, TVal>
          +

          Returns void

      • +
    • +
      Optional thisArg: unknown
    +

    Returns void

    +
+
+

get

+
    + +
  • +

    Returns all values stored for the given key. +Returns undefined if there are no values for this key.

    +
    +
    +

    Parameters

    +
      +
    • +
      key: TKey
    +

    Returns undefined | ReadonlySet<TVal>

    +
+
+

has

+
+
+

hasEntry

+
+
+

keys

+
+
+

set

+
+
+

valueSets

+
+
+

values

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WrappingLogger.html b/7.x/docs/classes/WrappingLogger.html new file mode 100644 index 000000000..f448fbfd2 --- /dev/null +++ b/7.x/docs/classes/WrappingLogger.html @@ -0,0 +1,283 @@ +WrappingLogger | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WrappingLogger

+
+

Implements BaseLogger around a SimpleLogger, +which can be swapped out a runtime.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
logger +
+
+

Methods

+
debug +error +info +log +silly +verbose +warn +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

logger

+
logger: SimpleLogger
+
+

Methods

+
+

debug

+
+
+

error

+
+
+

info

+
+
+

log

+
    + +
  • +

    Log the given message at the given level. +If the internal level is higher than the given level, the message may be voided.

    +
    +
    +

    Parameters

    +
      +
    • +
      level: "error" | "warn" | "info" | "verbose" | "debug" | "silly"
      +

      The level to log at.

      +
      +
      • +
    • +
      message: string
      +

      The message to log.

      +
      +
      • +
    • +
      Optional meta: LogMetadata
      +

      Optional metadata to include in the log message.

      +
      +
    +

    Returns WrappingLogger

    +
+
+

silly

+
+
+

verbose

+
+
+

warn

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/WwwAuthMetadataWriter.html b/7.x/docs/classes/WwwAuthMetadataWriter.html new file mode 100644 index 000000000..4b2f3fb43 --- /dev/null +++ b/7.x/docs/classes/WwwAuthMetadataWriter.html @@ -0,0 +1,195 @@ +WwwAuthMetadataWriter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class WwwAuthMetadataWriter

+
+

Adds the WWW-Authenticate header with the injected value in case the response status code is 401.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
auth +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly auth

+
auth: string
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

handle

+
+
+

handleSafe

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/YargsCliExtractor.html b/7.x/docs/classes/YargsCliExtractor.html new file mode 100644 index 000000000..e267d027a --- /dev/null +++ b/7.x/docs/classes/YargsCliExtractor.html @@ -0,0 +1,227 @@ +YargsCliExtractor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class YargsCliExtractor

+
+

Parses CLI args using the yargs library. +Specific settings can be enabled through the provided options.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
yargsArgOptions +yargvOptions +
+
+

Methods

+
canHandle +createYArgv +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected Readonly yargsArgOptions

+
yargsArgOptions: Record<string, Options>
+
+

Protected Readonly yargvOptions

+
yargvOptions: CliOptions
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks whether the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: CliArgv
      +

      Input that could potentially be handled.

      +
      +
    +

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+

Private createYArgv

+
    + +
  • +

    Creates the yargs Argv object based on the input CLI argv.

    +
    +
    +

    Parameters

    +
      +
    • +
      argv: readonly string[]
    +

    Returns Argv<{}>

    +
+
+

handle

+
    + +
  • +

    Handles the given input. This may only be called if canHandle did not reject. +When unconditionally calling both in sequence, consider handleSafe instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      argv: readonly string[]
      +

      Input that needs to be handled.

      +
      +
    +

    Returns Promise<{
        $0: string;
        _: (string | number)[];
        [argName: string]: unknown;
    }>

    A promise resolving when handling is finished.

    + +
+
+

handleSafe

+
    + +
  • +

    Helper function that first runs canHandle followed by handle. +Throws the error of canHandle if the data cannot be handled, +or returns the result of handle otherwise.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: CliArgv
      +

      Input data that will be handled if it can be handled.

      +
      +
    +

    Returns Promise<Shorthand>

    A promise resolving if the input can be handled, rejecting with an Error if not.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/classes/YargsParameter.html b/7.x/docs/classes/YargsParameter.html new file mode 100644 index 000000000..3cbdd07dc --- /dev/null +++ b/7.x/docs/classes/YargsParameter.html @@ -0,0 +1,128 @@ +YargsParameter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Class YargsParameter

+
+

This class exists as wrapper around a yargs Options object, +thereby allowing us to create these in a Components.js configuration.

+

Format details can be found at https://yargs.js.org/docs/#api-reference-optionskey-opt

+
+
+
+

Hierarchy

+
    +
  • YargsParameter
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
name +options +
+
+

Constructors

+
+

constructor

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      name: string
      +

      Name of the parameter. Corresponds to the first parameter passed to the yargs.options function.

      +
      +
      • +
    • +
      options: Record<string, unknown>
      +

      Options for a single parameter that should be parsed.

      +
      +
    +

    Returns YargsParameter

    +
    +

    Range

+
+

Properties

+
+

Readonly name

+
name: string
+
+

Readonly options

+
options: Options
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/enums/AccessMode.html b/7.x/docs/enums/AccessMode.html new file mode 100644 index 000000000..3980d77b1 --- /dev/null +++ b/7.x/docs/enums/AccessMode.html @@ -0,0 +1,113 @@ +AccessMode | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Enumeration AccessMode

+
+

Different modes that require permission.

+
+
+
+
+
+ +
+
+

Enumeration Members

+
append +create +delete +read +write +
+
+

Enumeration Members

+
+

append

+
append: "append"
+
+

create

+
create: "create"
+
+

delete

+
delete: "delete"
+
+

read

+
read: "read"
+
+

write

+
write: "write"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/enums/AclMode.html b/7.x/docs/enums/AclMode.html new file mode 100644 index 000000000..ec35efd53 --- /dev/null +++ b/7.x/docs/enums/AclMode.html @@ -0,0 +1,81 @@ +AclMode | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Enumeration AclMode

+
+
+
+ +
+
+

Enumeration Members

+
control +
+
+

Enumeration Members

+
+

control

+
control: "control"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/absoluteFilePath.html b/7.x/docs/functions/absoluteFilePath.html new file mode 100644 index 000000000..f40fd6ba0 --- /dev/null +++ b/7.x/docs/functions/absoluteFilePath.html @@ -0,0 +1,79 @@ +absoluteFilePath | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function absoluteFilePath

+
+
    + +
  • +

    Resolves a path to its absolute form. +Absolute inputs will not be changed (except changing Windows to POSIX). +Relative inputs will be interpreted relative to process.cwd().

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      Path to check (POSIX or Windows).

      +
      +
    +

    Returns string

    The potentially changed path (POSIX).

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/addGeneratedResources.html b/7.x/docs/functions/addGeneratedResources.html new file mode 100644 index 000000000..5d221bf27 --- /dev/null +++ b/7.x/docs/functions/addGeneratedResources.html @@ -0,0 +1,87 @@ +addGeneratedResources | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function addGeneratedResources

+
+
    + +
  • +

    Generates resources with the given generator and adds them to the given store.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<number>

    The amount of resources that were added.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/addHeader.html b/7.x/docs/functions/addHeader.html new file mode 100644 index 000000000..516141ad1 --- /dev/null +++ b/7.x/docs/functions/addHeader.html @@ -0,0 +1,77 @@ +addHeader | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function addHeader

+
+
    + +
  • +

    Adds a header value without overriding previous values.

    +
    +
    +

    Parameters

    +
      +
    • +
      response: HttpResponse
      • +
    • +
      name: string
      • +
    • +
      value: string | string[]
    +

    Returns void

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/addResourceMetadata.html b/7.x/docs/functions/addResourceMetadata.html new file mode 100644 index 000000000..21568edfc --- /dev/null +++ b/7.x/docs/functions/addResourceMetadata.html @@ -0,0 +1,81 @@ +addResourceMetadata | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function addResourceMetadata

+
+
    + +
  • +

    Helper function to generate type quads for a Container or Resource.

    +
    +
    +

    Parameters

    +
      +
    • +
      metadata: RepresentationMetadata
      +

      Metadata to add to.

      +
      +
      • +
    • +
      isContainer: boolean
      +

      If the identifier corresponds to a container.

      +
      +
    +

    Returns void

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/addTemplateMetadata.html b/7.x/docs/functions/addTemplateMetadata.html new file mode 100644 index 000000000..736ad78b3 --- /dev/null +++ b/7.x/docs/functions/addTemplateMetadata.html @@ -0,0 +1,86 @@ +addTemplateMetadata | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function addTemplateMetadata

+
+
    + +
  • +

    Links a template file with a given content-type to the metadata using the SOLID_META.template predicate.

    +
    +
    +

    Parameters

    +
      +
    • +
      metadata: RepresentationMetadata
      +

      Metadata to update.

      +
      +
      • +
    • +
      templateFile: string
      +

      Path to the template.

      +
      +
      • +
    • +
      contentType: string
      +

      Content-type of the template after it is rendered.

      +
      +
    +

    Returns void

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/allFulfilled.html b/7.x/docs/functions/allFulfilled.html new file mode 100644 index 000000000..6044b6ce5 --- /dev/null +++ b/7.x/docs/functions/allFulfilled.html @@ -0,0 +1,81 @@ +allFulfilled | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function allFulfilled

+
+
    + +
  • +

    Obtains the values of all fulfilled promises. +If there are rejections (and ignoreErrors is false), throws a combined error of all rejected promises.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      promises: Promise<T>[]
      • +
    • +
      ignoreErrors: boolean = false
    +

    Returns Promise<T[]>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/assertAccountId.html b/7.x/docs/functions/assertAccountId.html new file mode 100644 index 000000000..70cac9256 --- /dev/null +++ b/7.x/docs/functions/assertAccountId.html @@ -0,0 +1,73 @@ +assertAccountId | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function assertAccountId

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/assertOidcInteraction.html b/7.x/docs/functions/assertOidcInteraction.html new file mode 100644 index 000000000..850a2c0f5 --- /dev/null +++ b/7.x/docs/functions/assertOidcInteraction.html @@ -0,0 +1,78 @@ +assertOidcInteraction | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function assertOidcInteraction

+
+
    + +
  • +

    Asserts oidcInteraction is defined, throws the correct error in case this is not the case. +The error contains the relevant error code that can be used to explain more extensively what the issue is +and why an OIDC interaction is needed.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional oidcInteraction: Interaction
      +

      Interaction object to check.

      +
      +
    +

    Returns asserts oidcInteraction is Interaction

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/assertReadConditions.html b/7.x/docs/functions/assertReadConditions.html new file mode 100644 index 000000000..8f11772a5 --- /dev/null +++ b/7.x/docs/functions/assertReadConditions.html @@ -0,0 +1,94 @@ +assertReadConditions | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function assertReadConditions

+
+
    + +
  • +

    Verify whether the given Representation matches the given conditions. +If true, add the corresponding ETag to the body metadata. +If not, destroy the data stream and throw a NotModifiedHttpError with the same ETag. +If conditions is not defined, nothing will happen.

    +

    This uses the strict conditions check which takes the content type into account; +therefore, this should only be called after content negotiation, when it is certain what the output will be.

    +

    Note that browsers only keep track of one ETag, and the Vary header has no impact on this, +meaning the browser could send us the ETag for a Turtle resource even though it is requesting JSON-LD; +this is why we have to check ETags after content negotiation.

    +
    +
    +

    Parameters

    +
      +
    • +
      body: Representation
      +

      The representation to compare the conditions against.

      +
      +
      • +
    • +
      eTagHandler: ETagHandler
      +

      Used to generate the ETag to return with the 304 response.

      +
      +
      • +
    • +
      Optional conditions: Conditions
      +

      The conditions to assert.

      +
      +
    +

    Returns void

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/asyncToArray.html b/7.x/docs/functions/asyncToArray.html new file mode 100644 index 000000000..aa680cbc8 --- /dev/null +++ b/7.x/docs/functions/asyncToArray.html @@ -0,0 +1,78 @@ +asyncToArray | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function asyncToArray

+
+
    + +
  • +

    Converts an AsyncIterator to an array.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      iterable: AsyncIterable<T>
    +

    Returns Promise<T[]>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/cleanPreferences.html b/7.x/docs/functions/cleanPreferences.html new file mode 100644 index 000000000..2227b6ea0 --- /dev/null +++ b/7.x/docs/functions/cleanPreferences.html @@ -0,0 +1,79 @@ +cleanPreferences | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function cleanPreferences

+
+
    + +
  • +

    Cleans incoming preferences to prevent unwanted behaviour. +Makes sure internal types have weight 0, unless specifically requested in the preferences, +and interprets empty preferences as accepting everything.

    +
    +
    +

    Parameters

    +
      +
    • +
      preferences: ValuePreferences = {}
      +

      Preferences that need to be updated.

      +
      +
    +

    Returns ValuePreferences

    A copy of the the preferences with the necessary updates.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/cloneRepresentation.html b/7.x/docs/functions/cloneRepresentation.html new file mode 100644 index 000000000..ab1e203fb --- /dev/null +++ b/7.x/docs/functions/cloneRepresentation.html @@ -0,0 +1,78 @@ +cloneRepresentation | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function cloneRepresentation

+
+
    + +
  • +

    Helper function to clone a representation, the original representation can still be used. +This function loads the entire stream in memory.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<BasicRepresentation>

    The cloned representation.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/concat.html b/7.x/docs/functions/concat.html new file mode 100644 index 000000000..5ef68e5f5 --- /dev/null +++ b/7.x/docs/functions/concat.html @@ -0,0 +1,81 @@ +concat | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function concat

+
+
    + +
  • +

    Creates a new iterable that is a concatenation of all the iterables in the input.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      iterables: Iterable<Iterable<T>>
      +

      An iterable of which the contents will be concatenated into a new iterable.

      +
      +
    +

    Returns Iterable<T>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/createAggregateError.html b/7.x/docs/functions/createAggregateError.html new file mode 100644 index 000000000..e8ff874cd --- /dev/null +++ b/7.x/docs/functions/createAggregateError.html @@ -0,0 +1,78 @@ +createAggregateError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function createAggregateError

+
+
    + +
  • +

    Combines a list of errors into a single HttpError. +Status code depends on the input errors. If they all share the same status code that code will be re-used. +If they are all within the 4xx range, 400 will be used, otherwise 500.

    +
    +
    +

    Parameters

    +
      +
    • +
      errors: Error[]
      +

      Errors to combine.

      +
      +
    +

    Returns HttpError

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/createErrorMessage.html b/7.x/docs/functions/createErrorMessage.html new file mode 100644 index 000000000..b79066860 --- /dev/null +++ b/7.x/docs/functions/createErrorMessage.html @@ -0,0 +1,73 @@ +createErrorMessage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function createErrorMessage

+
+
    + +
  • +

    Creates a string representing the error message of this object.

    +
    +
    +

    Parameters

    +
      +
    • +
      error: unknown
    +

    Returns string

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/createGenericEventEmitterClass.html b/7.x/docs/functions/createGenericEventEmitterClass.html new file mode 100644 index 000000000..6d50c0452 --- /dev/null +++ b/7.x/docs/functions/createGenericEventEmitterClass.html @@ -0,0 +1,81 @@ +createGenericEventEmitterClass | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function createGenericEventEmitterClass

+
+
    + +
  • +

    Creates a class that is an implementation of EventEmitter +but with specific typings based on GenericEventEmitter. +Useful in case a class needs to extend EventEmitter and wants specific internal typings.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends EventEmitter

    +

    Returns (new () => T)

    +
      +
    • +
        +
      • new (): T
        • +
      • +

        Returns T

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/createSubdomainRegexp.html b/7.x/docs/functions/createSubdomainRegexp.html new file mode 100644 index 000000000..3a5b9e42f --- /dev/null +++ b/7.x/docs/functions/createSubdomainRegexp.html @@ -0,0 +1,85 @@ +createSubdomainRegexp | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function createSubdomainRegexp

+
+
    + +
  • +

    Creates a regular expression that matches URLs containing the given baseUrl, or a subdomain of the given baseUrl. +In case there is a subdomain, the first match of the regular expression will be that subdomain.

    +

    Examples with baseUrl http://test.com/foo/:

    +
      +
    • Will match http://test.com/foo/
      • +
    • Will match http://test.com/foo/bar/baz
      • +
    • Will match http://alice.bob.test.com/foo/bar/baz, first match result will be alice.bob
      • +
    • Will not match http://test.com/
      • +
    • Will not match http://alicetest.com/foo/
      • +
    +
    +
    +

    Parameters

    +
      +
    • +
      baseUrl: string
      +

      Base URL for the regular expression.

      +
      +
    +

    Returns RegExp

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/createVocabulary.html b/7.x/docs/functions/createVocabulary.html new file mode 100644 index 000000000..6a47689c0 --- /dev/null +++ b/7.x/docs/functions/createVocabulary.html @@ -0,0 +1,84 @@ +createVocabulary | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function createVocabulary

+
+
    + +
  • +

    Creates a Vocabulary with the given baseUri as namespace and all localNames as entries. +The values are the local names expanded from the given base URI as strings. +The terms field contains all the same values but as NamedNode instead.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TBase extends string

      • +
    • +

      TLocal extends string

    +
    +

    Parameters

    +
      +
    • +
      baseUri: TBase
      • +
    • +
      Rest ...localNames: TLocal[]
    +

    Returns string extends TLocal
        ? PartialVocabulary<TBase>
        : Vocabulary<TBase, TLocal>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/decodeUriPathComponents.html b/7.x/docs/functions/decodeUriPathComponents.html new file mode 100644 index 000000000..5f33e2108 --- /dev/null +++ b/7.x/docs/functions/decodeUriPathComponents.html @@ -0,0 +1,80 @@ +decodeUriPathComponents | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function decodeUriPathComponents

+
+
    + +
  • +

    This function is used when converting a URI to a file path. Decodes all components of a URI path, +with the exception of encoded slash characters, as this would lead to unexpected file locations +being targeted (resulting in erroneous behaviour of the file based backend). +Characters that would result in an illegal file path remain percent encoded.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      The path to decode the URI path components of.

      +
      +
    +

    Returns string

    A decoded copy of the provided URI path (ignoring encoded slash characters).

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/encodeUriPathComponents.html b/7.x/docs/functions/encodeUriPathComponents.html new file mode 100644 index 000000000..71ffbab69 --- /dev/null +++ b/7.x/docs/functions/encodeUriPathComponents.html @@ -0,0 +1,79 @@ +encodeUriPathComponents | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function encodeUriPathComponents

+
+
    + +
  • +

    This function is used in the process of converting a file path to a URI. Encodes all (non-slash) +special characters in a URI path, with the exception of encoded slash characters, as this would +lead to unnecessary double encoding, resulting in a URI that differs from the expected result.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      The path to encode the URI path components of.

      +
      +
    +

    Returns string

    An encoded copy of the provided URI path (ignoring encoded slash characters).

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/endOfStream.html b/7.x/docs/functions/endOfStream.html new file mode 100644 index 000000000..f53546ccf --- /dev/null +++ b/7.x/docs/functions/endOfStream.html @@ -0,0 +1,70 @@ +endOfStream | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function endOfStream

+
+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      arg1: Stream
    +

    Returns Promise<void>

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/ensureLeadingSlash.html b/7.x/docs/functions/ensureLeadingSlash.html new file mode 100644 index 000000000..ac388f1e5 --- /dev/null +++ b/7.x/docs/functions/ensureLeadingSlash.html @@ -0,0 +1,79 @@ +ensureLeadingSlash | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function ensureLeadingSlash

+
+
    + +
  • +

    Makes sure the input path has exactly 1 slash at the beginning. +Multiple slashes will get merged into one. +If there is no slash it will be added.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      Path to check.

      +
      +
    +

    Returns string

    The potentially changed path.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/ensureTrailingSlash.html b/7.x/docs/functions/ensureTrailingSlash.html new file mode 100644 index 000000000..bb690acca --- /dev/null +++ b/7.x/docs/functions/ensureTrailingSlash.html @@ -0,0 +1,79 @@ +ensureTrailingSlash | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function ensureTrailingSlash

+
+
    + +
  • +

    Makes sure the input path has exactly 1 slash at the end. +Multiple slashes will get merged into one. +If there is no slash it will be added.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      Path to check.

      +
      +
    +

    Returns string

    The potentially changed path.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/errorTermsToMetadata.html b/7.x/docs/functions/errorTermsToMetadata.html new file mode 100644 index 000000000..f6d956e9b --- /dev/null +++ b/7.x/docs/functions/errorTermsToMetadata.html @@ -0,0 +1,83 @@ +errorTermsToMetadata | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function errorTermsToMetadata

+
+
    + +
  • +

    Adds the given terms to error metadata. +The keys will be converted to predicates by prepending them with the SOLID_ERROR_TERM namespace. +The values will become literals.

    +
    +
    +

    Parameters

    +
      +
    • +
      terms: Dict<string>
      +

      Terms to add to the metadata.

      +
      +
      • +
    • +
      Optional metadata: RepresentationMetadata
      +

      Metadata to add the terms to. A new metadata object will be created if this is undefined.

      +
      +
    +

    Returns RepresentationMetadata

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/extendVocabulary.html b/7.x/docs/functions/extendVocabulary.html new file mode 100644 index 000000000..4d7877b61 --- /dev/null +++ b/7.x/docs/functions/extendVocabulary.html @@ -0,0 +1,90 @@ +extendVocabulary | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function extendVocabulary

+
+
    + +
  • +

    Creates a new Vocabulary that extends an existing one by adding new local names.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TBase extends string

      • +
    • +

      TLocal extends string

      • +
    • +

      TNew extends string

    +
    +

    Parameters

    +
      +
    • +
      vocabulary: Vocabulary<TBase, TLocal>
      +

      The Vocabulary to extend.

      +
      +
      • +
    • +
      Rest ...newNames: TNew[]
      +

      The new local names that need to be added.

      +
      +
    +

    Returns ReturnType<typeof createVocabulary>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/extractErrorTerms.html b/7.x/docs/functions/extractErrorTerms.html new file mode 100644 index 000000000..ae236b653 --- /dev/null +++ b/7.x/docs/functions/extractErrorTerms.html @@ -0,0 +1,79 @@ +extractErrorTerms | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function extractErrorTerms

+
+
    + +
  • +

    Extracts all the error metadata terms and converts them to a simple object. +All predicates in the SOLID_ERROR_TERM namespace will be found. +The namespace will be removed from the predicate and the remainder will be used as a key. +The object literal values will be used as values in the resulting object.

    +
    +
    +

    Parameters

    +
    +

    Returns Dict<string>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/extractScheme.html b/7.x/docs/functions/extractScheme.html new file mode 100644 index 000000000..cc4820c7c --- /dev/null +++ b/7.x/docs/functions/extractScheme.html @@ -0,0 +1,82 @@ +extractScheme | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function extractScheme

+
+
    + +
  • +

    Splits a URL (or similar) string into a part containing its scheme and one containing the rest. +E.g., http://test.com/ results in { scheme: 'http://', rest: 'test.com/' }.

    +
    +
    +

    Parameters

    +
      +
    • +
      url: string
      +

      String to parse.

      +
      +
    +

    Returns {
        rest: string;
        scheme: string;
    }

    +
      +
    • +
      rest: string
      • +
    • +
      scheme: string
    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/fetchDataset.html b/7.x/docs/functions/fetchDataset.html new file mode 100644 index 000000000..c796b57f2 --- /dev/null +++ b/7.x/docs/functions/fetchDataset.html @@ -0,0 +1,74 @@ +fetchDataset | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function fetchDataset

+
+
    + +
  • +

    Fetches an RDF dataset from the given URL.

    +

    Response will be a Representation with content-type internal/quads.

    +
    +
    +

    Parameters

    +
      +
    • +
      url: string
    +

    Returns Promise<Representation>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/filter.html b/7.x/docs/functions/filter.html new file mode 100644 index 000000000..bd6eeda67 --- /dev/null +++ b/7.x/docs/functions/filter.html @@ -0,0 +1,106 @@ +filter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function filter

+
+
    + +
  • +

    Creates a new iterable with all elements that pass the test implemented by the provided function. +Similar to the Array.prototype.filter function. +See the documentation of the above function for more details.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      iterable: Iterable<T>
      +

      Iterable on which to call the map function.

      +
      +
      • +
    • +
      callbackFn: ((element, index) => boolean)
      +

      Function that is called to test every element.

      +
      +
      +
        +
      • +
          +
        • (element, index): boolean
          • +
        • +
          +

          Parameters

          +
            +
          • +
            element: T
            • +
          • +
            index: number
          +

          Returns boolean

      • +
    • +
      Optional thisArg: unknown
      +

      Value to use as this when executing callbackFn.

      +
      +
    +

    Returns Iterable<T>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/filterHandlers.html b/7.x/docs/functions/filterHandlers.html new file mode 100644 index 000000000..eee514e11 --- /dev/null +++ b/7.x/docs/functions/filterHandlers.html @@ -0,0 +1,89 @@ +filterHandlers | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function filterHandlers

+
+
    + +
  • +

    Filters a list of handlers to only keep those that can handle the input. +Will error if no matching handlers are found.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TIn

      • +
    • +

      TOut

    +
    +

    Parameters

    +
      +
    • +
      handlers: AsyncHandler<TIn, TOut>[]
      +

      Handlers to filter.

      +
      +
      • +
    • +
      input: TIn
      +

      Input that needs to be supported.

      +
      +
    +

    Returns Promise<AsyncHandler<TIn, TOut>[]>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/find.html b/7.x/docs/functions/find.html new file mode 100644 index 000000000..23a34dfcb --- /dev/null +++ b/7.x/docs/functions/find.html @@ -0,0 +1,107 @@ +find | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function find

+
+
    + +
  • +

    Returns the first element in the provided iterable that satisfies the provided testing function. +If no values satisfy the testing function, undefined is returned. +Similar to the Array.prototype.find function. +See the documentation of the above function for more details.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      iterable: Iterable<T>
      +

      Iterable on which to call the map function.

      +
      +
      • +
    • +
      callbackFn: ((element, index) => boolean)
      +

      Function that is called to test every element.

      +
      +
      +
        +
      • +
          +
        • (element, index): boolean
          • +
        • +
          +

          Parameters

          +
            +
          • +
            element: T
            • +
          • +
            index: number
          +

          Returns boolean

      • +
    • +
      Optional thisArg: unknown
      +

      Value to use as this when executing callbackFn.

      +
      +
    +

    Returns T | undefined

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/findHandler.html b/7.x/docs/functions/findHandler.html new file mode 100644 index 000000000..f17e30d9a --- /dev/null +++ b/7.x/docs/functions/findHandler.html @@ -0,0 +1,90 @@ +findHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function findHandler

+
+
    + +
  • +

    Finds a handler that can handle the given input data. +Otherwise an error gets thrown.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TIn

      • +
    • +

      TOut

    +
    +

    Parameters

    +
      +
    • +
      handlers: AsyncHandler<TIn, TOut>[]
      +

      List of handlers to search in.

      +
      +
      • +
    • +
      input: TIn
      +

      The input data.

      +
      +
    +

    Returns Promise<AsyncHandler<TIn, TOut>>

    A promise resolving to a handler that supports the data or otherwise rejecting.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/finishInteraction.html b/7.x/docs/functions/finishInteraction.html new file mode 100644 index 000000000..1dec210ca --- /dev/null +++ b/7.x/docs/functions/finishInteraction.html @@ -0,0 +1,86 @@ +finishInteraction | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function finishInteraction

+
+
    + +
  • +

    Updates the oidcInteraction object with the necessary data in case a prompt gets updated.

    +
    +
    +

    Parameters

    +
      +
    • +
      oidcInteraction: Interaction
      +

      Interaction to update.

      +
      +
      • +
    • +
      result: AccountInteractionResults
      +

      New data to add to the interaction.

      +
      +
      • +
    • +
      mergeWithLastSubmission: boolean
      +

      If this new data needs to be merged with already existing data in the interaction.

      +
      +
    +

    Returns Promise<string>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/forgetWebId.html b/7.x/docs/functions/forgetWebId.html new file mode 100644 index 000000000..b58a90b20 --- /dev/null +++ b/7.x/docs/functions/forgetWebId.html @@ -0,0 +1,83 @@ +forgetWebId | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function forgetWebId

+
+
    + +
  • +

    Removes the WebID, the accountId, from the OIDC session object, +allowing us to replace it with a new value. +If there is no session in the Interaction, nothing will happen.

    +
    +
    +

    Parameters

    +
      +
    • +
      provider: default
      +

      The OIDC provider.

      +
      +
      • +
    • +
      oidcInteraction: Interaction
      +

      The current interaction.

      +
      +
    +

    Returns Promise<void>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/generateChannel.html b/7.x/docs/functions/generateChannel.html new file mode 100644 index 000000000..89cca4051 --- /dev/null +++ b/7.x/docs/functions/generateChannel.html @@ -0,0 +1,75 @@ +generateChannel | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function generateChannel

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/generateHttpErrorClass.html b/7.x/docs/functions/generateHttpErrorClass.html new file mode 100644 index 000000000..6d8fd655f --- /dev/null +++ b/7.x/docs/functions/generateHttpErrorClass.html @@ -0,0 +1,86 @@ +generateHttpErrorClass | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function generateHttpErrorClass

+
+
    + +
  • +

    Generates a new HttpError class with the given status code and name. +In general, status codes are used to uniquely identify error types, +so there should be no 2 classes with the same value there.

    +

    To make sure Components.js can work with these newly generated classes, +the generated class should be called BaseHttpError as that name is an entry in .componentsignore. +The actual class should then extend BaseHttpError and have a correct constructor, +so the Components.js generator can generate the correct components JSON-LD file during build.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TCode extends number

    +
    +

    Parameters

    +
      +
    • +
      statusCode: TCode
      • +
    • +
      name: string
    +

    Returns HttpErrorClass<TCode>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/generateHttpErrorUri.html b/7.x/docs/functions/generateHttpErrorUri.html new file mode 100644 index 000000000..1d94cac50 --- /dev/null +++ b/7.x/docs/functions/generateHttpErrorUri.html @@ -0,0 +1,73 @@ +generateHttpErrorUri | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function generateHttpErrorUri

+
+
    + +
  • +

    Returns a URI that is unique for the given status code.

    +
    +
    +

    Parameters

    +
      +
    • +
      statusCode: number
    +

    Returns NamedNode

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/generateRedirectHttpErrorClass.html b/7.x/docs/functions/generateRedirectHttpErrorClass.html new file mode 100644 index 000000000..dde00b8c8 --- /dev/null +++ b/7.x/docs/functions/generateRedirectHttpErrorClass.html @@ -0,0 +1,82 @@ +generateRedirectHttpErrorClass | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function generateRedirectHttpErrorClass

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/generateWebSocketUrl.html b/7.x/docs/functions/generateWebSocketUrl.html new file mode 100644 index 000000000..d34339dec --- /dev/null +++ b/7.x/docs/functions/generateWebSocketUrl.html @@ -0,0 +1,76 @@ +generateWebSocketUrl | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function generateWebSocketUrl

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/getAccessControl.html b/7.x/docs/functions/getAccessControl.html new file mode 100644 index 000000000..b977d51ce --- /dev/null +++ b/7.x/docs/functions/getAccessControl.html @@ -0,0 +1,81 @@ +getAccessControl | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function getAccessControl

+
+
    + +
  • +

    Finds the IAccessControl with the given identifier in the given dataset.

    +
    +
    +

    Parameters

    +
      +
    • +
      data: Store<Quad, Quad, Quad, Quad>
      +

      Dataset to look in.

      +
      +
      • +
    • +
      accessControl: Term
      +

      Identifier of the access control.

      +
      +
    +

    Returns IAccessControl

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/getAccessControlResource.html b/7.x/docs/functions/getAccessControlResource.html new file mode 100644 index 000000000..d93dd7c0f --- /dev/null +++ b/7.x/docs/functions/getAccessControlResource.html @@ -0,0 +1,81 @@ +getAccessControlResource | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function getAccessControlResource

+
+
    + +
  • +

    Finds the IAccessControlResource with the given identifier in the given dataset.

    +
    +
    +

    Parameters

    +
      +
    • +
      data: Store<Quad, Quad, Quad, Quad>
      +

      Dataset to look in.

      +
      +
      • +
    • +
      acr: Term
      +

      Identifier of the access control resource.

      +
      +
    +

    Returns IAccessControlResource

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/getAccessControlledResources.html b/7.x/docs/functions/getAccessControlledResources.html new file mode 100644 index 000000000..754d9da66 --- /dev/null +++ b/7.x/docs/functions/getAccessControlledResources.html @@ -0,0 +1,76 @@ +getAccessControlledResources | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function getAccessControlledResources

+
+
    + +
  • +

    Finds all IAccessControlledResource in the given dataset.

    +
    +
    +

    Parameters

    +
      +
    • +
      data: Store<Quad, Quad, Quad, Quad>
      +

      Dataset to look in.

      +
      +
    +

    Returns Iterable<IAccessControlledResource>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/getBestPreference.html b/7.x/docs/functions/getBestPreference.html new file mode 100644 index 000000000..6ebafc05f --- /dev/null +++ b/7.x/docs/functions/getBestPreference.html @@ -0,0 +1,84 @@ +getBestPreference | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function getBestPreference

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/getConversionTarget.html b/7.x/docs/functions/getConversionTarget.html new file mode 100644 index 000000000..c3553681d --- /dev/null +++ b/7.x/docs/functions/getConversionTarget.html @@ -0,0 +1,88 @@ +getConversionTarget | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function getConversionTarget

+
+
    + +
  • +

    For a media type converter that can generate the given types, +this function tries to find the type that best matches the given preferences.

    +

    This function combines several other conversion utility functions +to determine what output a converter should generate: +it cleans the preferences with cleanPreferences to support empty preferences +and to prevent the accidental generation of internal types, +after which the best match gets found based on the weights.

    +
    +
    +

    Parameters

    +
    +

    Returns string | undefined

    The best match. Undefined if there is no match.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/getDefault.html b/7.x/docs/functions/getDefault.html new file mode 100644 index 000000000..5b8b33aa9 --- /dev/null +++ b/7.x/docs/functions/getDefault.html @@ -0,0 +1,142 @@ +getDefault | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function getDefault

+
+
    + +
  • +

    Finds the result of calling map.get(key). +If there is no result, it instead returns the result of the default function. +The Map will also be updated to assign that default value to the given key.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TKey

      • +
    • +

      TValue

    +
    +

    Parameters

    +
      +
    • +
      map: Map<TKey, TValue>
      +

      Map to use.

      +
      +
      • +
    • +
      key: TKey
      +

      Key to find the value for.

      +
      +
      • +
    • +
      defaultFn: (() => TValue)
      +

      Function to generate default value to insert and return if no result was found.

      +
      +
      +
        +
      • +
          +
        • (): TValue
          • +
        • +

          Returns TValue

    +

    Returns TValue

    +
    • + +
  • +

    Finds the result of calling map.get(key). +If there is no result, it instead returns the result of the default function. +The Map will also be updated to assign the resolved default value to the given key.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TKey

      • +
    • +

      TValue

    +
    +

    Parameters

    +
      +
    • +
      map: Map<TKey, TValue>
      +

      Map to use.

      +
      +
      • +
    • +
      key: TKey
      +

      Key to find the value for.

      +
      +
      • +
    • +
      defaultFn: (() => Promise<TValue>)
      +

      Function to generate default value to insert and return if no result was found.

      +
      +
      +
        +
      • +
          +
        • (): Promise<TValue>
          • +
        • +

          Returns Promise<TValue>

    +

    Returns Promise<TValue>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/getExtension.html b/7.x/docs/functions/getExtension.html new file mode 100644 index 000000000..315438452 --- /dev/null +++ b/7.x/docs/functions/getExtension.html @@ -0,0 +1,77 @@ +getExtension | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function getExtension

+
+
    + +
  • +

    Extracts the extension (without dot) from a path. +Custom function since path.extname does not work on all cases (e.g. ".acl")

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      Input path to parse.

      +
      +
    +

    Returns string

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/getLoggerFor.html b/7.x/docs/functions/getLoggerFor.html new file mode 100644 index 000000000..785c9b997 --- /dev/null +++ b/7.x/docs/functions/getLoggerFor.html @@ -0,0 +1,82 @@ +getLoggerFor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function getLoggerFor

+
+
    + +
  • +

    Gets a logger instance for the given class instance.

    +

    The following shows a typical pattern on how to create loggers:

    +
    class MyClass {
      protected readonly logger = getLoggerFor(this);
    }
+
    +

    If no class is applicable, a logger can also be created as follows:

    +
    const logger = getLoggerFor('MyFunction');
+
    +
    +
    +

    Parameters

    +
      +
    • +
      loggable: string | Instance
      +

      A class instance or a class string name.

      +
      +
    +

    Returns Logger

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/getMatcher.html b/7.x/docs/functions/getMatcher.html new file mode 100644 index 000000000..0783c5da9 --- /dev/null +++ b/7.x/docs/functions/getMatcher.html @@ -0,0 +1,81 @@ +getMatcher | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function getMatcher

+
+
    + +
  • +

    Finds the IMatcher with the given identifier in the given dataset.

    +
    +
    +

    Parameters

    +
      +
    • +
      data: Store<Quad, Quad, Quad, Quad>
      +

      Dataset to look in.

      +
      +
      • +
    • +
      matcher: Term
      +

      Identifier of the matcher.

      +
      +
    +

    Returns IMatcher

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/getModuleRoot.html b/7.x/docs/functions/getModuleRoot.html new file mode 100644 index 000000000..a3f967ad1 --- /dev/null +++ b/7.x/docs/functions/getModuleRoot.html @@ -0,0 +1,68 @@ +getModuleRoot | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function getModuleRoot

+
+
    + +
  • +

    Returns the folder corresponding to the root of the Community Solid Server module

    +
    +

    Returns string

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/getPolicy.html b/7.x/docs/functions/getPolicy.html new file mode 100644 index 000000000..b93dcb318 --- /dev/null +++ b/7.x/docs/functions/getPolicy.html @@ -0,0 +1,81 @@ +getPolicy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function getPolicy

+
+
    + +
  • +

    Finds the IPolicy with the given identifier in the given dataset.

    +
    +
    +

    Parameters

    +
      +
    • +
      data: Store<Quad, Quad, Quad, Quad>
      +

      Dataset to look in.

      +
      +
      • +
    • +
      policy: Term
      +

      Identifier of the policy.

      +
      +
    +

    Returns IPolicy

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/getRelativeUrl.html b/7.x/docs/functions/getRelativeUrl.html new file mode 100644 index 000000000..1534cdbec --- /dev/null +++ b/7.x/docs/functions/getRelativeUrl.html @@ -0,0 +1,87 @@ +getRelativeUrl | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function getRelativeUrl

+
+
    + +
  • +

    Creates a relative URL by removing the base URL. +Will throw an error in case the resulting target is not withing the base URL scope.

    +
    +
    +

    Parameters

    +
      +
    • +
      baseUrl: string
      +

      Base URL.

      +
      +
      • +
    • +
      request: HttpRequest
      +

      Incoming request of which the target needs to be extracted.

      +
      +
      • +
    • +
      targetExtractor: TargetExtractor
      +

      Will extract the target from the request.

      +
      +
    +

    Returns Promise<string>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/getSingleItem.html b/7.x/docs/functions/getSingleItem.html new file mode 100644 index 000000000..943bc9413 --- /dev/null +++ b/7.x/docs/functions/getSingleItem.html @@ -0,0 +1,78 @@ +getSingleItem | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function getSingleItem

+
+
    + +
  • +

    Converts the stream to a single object. +This assumes the stream is in object mode and only contains a single element, +otherwise an error will be thrown.

    +
    +
    +

    Parameters

    +
      +
    • +
      stream: Readable
      +

      Object stream with single entry.

      +
      +
    +

    Returns Promise<unknown>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/getTemplateFilePath.html b/7.x/docs/functions/getTemplateFilePath.html new file mode 100644 index 000000000..3bb15587a --- /dev/null +++ b/7.x/docs/functions/getTemplateFilePath.html @@ -0,0 +1,74 @@ +getTemplateFilePath | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function getTemplateFilePath

+
+
    + +
  • +

    Returns the absolute path to the template. +Returns undefined if the input does not contain a file path.

    +
    +
    +

    Parameters

    +
    +

    Returns string | undefined

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/getTypeWeight.html b/7.x/docs/functions/getTypeWeight.html new file mode 100644 index 000000000..db0107aac --- /dev/null +++ b/7.x/docs/functions/getTypeWeight.html @@ -0,0 +1,83 @@ +getTypeWeight | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function getTypeWeight

+
+
    + +
  • +

    Tries to match the given type to the given preferences. +In case there are multiple matches the most specific one will be chosen as per RFC 7231.

    +
    +
    +

    Parameters

    +
      +
    • +
      type: string
      +

      Type for which the matching weight is needed.

      +
      +
      • +
    • +
      preferred: ValuePreferences
      +

      Preferences to match the type to.

      +
      +
    +

    Returns number

    The corresponding weight from the preferences or 0 if there is no match.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/getWeightedPreferences.html b/7.x/docs/functions/getWeightedPreferences.html new file mode 100644 index 000000000..f05e7ec08 --- /dev/null +++ b/7.x/docs/functions/getWeightedPreferences.html @@ -0,0 +1,84 @@ +getWeightedPreferences | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function getWeightedPreferences

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/guardStream.html b/7.x/docs/functions/guardStream.html new file mode 100644 index 000000000..e91b62209 --- /dev/null +++ b/7.x/docs/functions/guardStream.html @@ -0,0 +1,87 @@ +guardStream | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function guardStream

+
+
    + +
  • +

    Makes sure that listeners always receive the error event of a stream, +even if it was thrown before the listener was attached.

    +

    When guarding a stream it is assumed that error listeners already attached should be ignored, +only error listeners attached after the stream is guarded will prevent an error from being logged.

    +

    If the input is already guarded the guard will be reset, +which means ignoring error listeners already attached.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends EventEmitter

    +
    +

    Parameters

    +
      +
    • +
      stream: T
      +

      Stream that can potentially throw an error.

      +
      +
    +

    Returns Guarded<T>

    The stream.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/guardedStreamFrom.html b/7.x/docs/functions/guardedStreamFrom.html new file mode 100644 index 000000000..640e7430e --- /dev/null +++ b/7.x/docs/functions/guardedStreamFrom.html @@ -0,0 +1,81 @@ +guardedStreamFrom | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function guardedStreamFrom

+
+
    + +
  • +

    Converts a string or array to a stream and applies an error guard so that it is Guarded.

    +
    +
    +

    Parameters

    +
      +
    • +
      contents: string | Iterable<unknown>
      +

      Data to stream.

      +
      +
      • +
    • +
      Optional options: ReadableOptions
      +

      Options to pass to the Readable constructor. See Readable.from.

      +
      +
    +

    Returns Guarded<Readable>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/hasScheme.html b/7.x/docs/functions/hasScheme.html new file mode 100644 index 000000000..ee31b51c9 --- /dev/null +++ b/7.x/docs/functions/hasScheme.html @@ -0,0 +1,82 @@ +hasScheme | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function hasScheme

+
+
    + +
  • +

    Checks if the scheme part of the specified url matches at least one of the provided options.

    +
    +
    +

    Parameters

    +
      +
    • +
      url: string
      +

      A string representing the URL.

      +
      +
      • +
    • +
      Rest ...schemes: string[]
      +

      Scheme value options (the function will check whether at least one matches the URL scheme).

      +
      +
    +

    Returns boolean

    True if the URL scheme matches at least one of the provided options, false otherwise.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/identifierHashFn.html b/7.x/docs/functions/identifierHashFn.html new file mode 100644 index 000000000..1d0506837 --- /dev/null +++ b/7.x/docs/functions/identifierHashFn.html @@ -0,0 +1,73 @@ +identifierHashFn | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function identifierHashFn

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/importOidcProvider.html b/7.x/docs/functions/importOidcProvider.html new file mode 100644 index 000000000..7f84ea7d8 --- /dev/null +++ b/7.x/docs/functions/importOidcProvider.html @@ -0,0 +1,74 @@ +importOidcProvider | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function importOidcProvider

+
+
    + +
  • +

    Import the OIDC-provider package.

    +

    As oidc-provider is an ESM package and CSS is CJS, we have to use a dynamic import here. +Unfortunately, there is a Node/Jest bug that causes segmentation faults when doing such an import in Jest: +https://github.com/nodejs/node/issues/35889 +To work around that, we do the import differently, in case we are in a Jest test run. +This can be detected via the env variables: https://jestjs.io/docs/environment-variables. +There have been reports of JEST_WORKER_ID being undefined, so to be sure we check both.

    +
    +

    Returns CanBePromise<__module>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/isContainerIdentifier.html b/7.x/docs/functions/isContainerIdentifier.html new file mode 100644 index 000000000..06a44f786 --- /dev/null +++ b/7.x/docs/functions/isContainerIdentifier.html @@ -0,0 +1,76 @@ +isContainerIdentifier | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function isContainerIdentifier

+
+
    + +
  • +

    Checks whether the identifier corresponds to a container identifier.

    +
    +
    +

    Parameters

    +
    +

    Returns boolean

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/isContainerPath.html b/7.x/docs/functions/isContainerPath.html new file mode 100644 index 000000000..8dabcb115 --- /dev/null +++ b/7.x/docs/functions/isContainerPath.html @@ -0,0 +1,76 @@ +isContainerPath | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function isContainerPath

+
+
    + +
  • +

    Checks whether the path corresponds to a container path (ending in a /).

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      Path to check.

      +
      +
    +

    Returns boolean

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/isError.html b/7.x/docs/functions/isError.html new file mode 100644 index 000000000..8ecaf2e74 --- /dev/null +++ b/7.x/docs/functions/isError.html @@ -0,0 +1,73 @@ +isError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function isError

+
+
    + +
  • +

    Checks if the input is an Error.

    +
    +
    +

    Parameters

    +
      +
    • +
      error: unknown
    +

    Returns error is Error

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/isGuarded.html b/7.x/docs/functions/isGuarded.html new file mode 100644 index 000000000..e98cb9afd --- /dev/null +++ b/7.x/docs/functions/isGuarded.html @@ -0,0 +1,78 @@ +isGuarded | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function isGuarded

+
+
    + +
  • +

    Determines whether the stream is guarded against emitting errors.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends EventEmitter

    +
    +

    Parameters

    +
      +
    • +
      stream: T
    +

    Returns stream is Guarded<T>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/isHttpRequest.html b/7.x/docs/functions/isHttpRequest.html new file mode 100644 index 000000000..1dd4d2ff4 --- /dev/null +++ b/7.x/docs/functions/isHttpRequest.html @@ -0,0 +1,73 @@ +isHttpRequest | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function isHttpRequest

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/isHttpsServer.html b/7.x/docs/functions/isHttpsServer.html new file mode 100644 index 000000000..6d1d59dfc --- /dev/null +++ b/7.x/docs/functions/isHttpsServer.html @@ -0,0 +1,73 @@ +isHttpsServer | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function isHttpsServer

+
+
    + +
  • +

    Returns true if the server is an HTTPS server.

    +
    +
    +

    Parameters

    +
      +
    • +
      server: Server<typeof IncomingMessage, typeof ServerResponse>
    +

    Returns server is Server<typeof IncomingMessage, typeof ServerResponse>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/isInternalContentType.html b/7.x/docs/functions/isInternalContentType.html new file mode 100644 index 000000000..3223f748c --- /dev/null +++ b/7.x/docs/functions/isInternalContentType.html @@ -0,0 +1,78 @@ +isInternalContentType | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function isInternalContentType

+
+
    + +
  • +

    Checks if the given content type is an internal content type such as internal/quads. +Response will be false if the input type is undefined.

    +

    Do not use this for media ranges.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional contentType: string
      +

      Type to check.

      +
      +
    +

    Returns boolean

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/isPromise.html b/7.x/docs/functions/isPromise.html new file mode 100644 index 000000000..b831372cc --- /dev/null +++ b/7.x/docs/functions/isPromise.html @@ -0,0 +1,81 @@ +isPromise | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function isPromise

+
+
    + +
  • +

    Verifies if the given value is a Promise or not.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
    +

    Returns object is Promise<T>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/isRepresentationMetadata.html b/7.x/docs/functions/isRepresentationMetadata.html new file mode 100644 index 000000000..1ce436a46 --- /dev/null +++ b/7.x/docs/functions/isRepresentationMetadata.html @@ -0,0 +1,73 @@ +isRepresentationMetadata | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function isRepresentationMetadata

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/isResourceIdentifier.html b/7.x/docs/functions/isResourceIdentifier.html new file mode 100644 index 000000000..0d622a6fd --- /dev/null +++ b/7.x/docs/functions/isResourceIdentifier.html @@ -0,0 +1,73 @@ +isResourceIdentifier | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function isResourceIdentifier

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/isSystemError.html b/7.x/docs/functions/isSystemError.html new file mode 100644 index 000000000..7a5ba3a99 --- /dev/null +++ b/7.x/docs/functions/isSystemError.html @@ -0,0 +1,70 @@ +isSystemError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function isSystemError

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/isTerm.html b/7.x/docs/functions/isTerm.html new file mode 100644 index 000000000..e27b9e234 --- /dev/null +++ b/7.x/docs/functions/isTerm.html @@ -0,0 +1,74 @@ +isTerm | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function isTerm

+
+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      Optional input: unknown
      +

      Checks if this is a Term.

      +
      +
    +

    Returns input is Term

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/isUrl.html b/7.x/docs/functions/isUrl.html new file mode 100644 index 000000000..aa4b64323 --- /dev/null +++ b/7.x/docs/functions/isUrl.html @@ -0,0 +1,77 @@ +isUrl | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function isUrl

+
+
    + +
  • +

    Checks whether the given string is a valid URL.

    +
    +
    +

    Parameters

    +
      +
    • +
      url: string
      +

      String to check.

      +
      +
    +

    Returns boolean

    True if the string is a valid URL.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/isValidFileName.html b/7.x/docs/functions/isValidFileName.html new file mode 100644 index 000000000..6e0ba1b90 --- /dev/null +++ b/7.x/docs/functions/isValidFileName.html @@ -0,0 +1,77 @@ +isValidFileName | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function isValidFileName

+
+
    + +
  • +

    Checks the validity of a file name. A valid name consists of word characters, '-' or '.'.

    +
    +
    +

    Parameters

    +
      +
    • +
      name: string
      +

      The name of the file to validate.

      +
      +
    +

    Returns boolean

    True if the filename is valid, false otherwise.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/isValidVariable.html b/7.x/docs/functions/isValidVariable.html new file mode 100644 index 000000000..1b9574168 --- /dev/null +++ b/7.x/docs/functions/isValidVariable.html @@ -0,0 +1,74 @@ +isValidVariable | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function isValidVariable

+
+
    + +
  • +

    Checks if the given variable is one that is supported. +This can be used to weed out irrelevant parameters in an object.

    +
    +
    +

    Parameters

    +
      +
    • +
      variable: string
    +

    Returns boolean

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/isWebSocket2023Channel.html b/7.x/docs/functions/isWebSocket2023Channel.html new file mode 100644 index 000000000..1949348b1 --- /dev/null +++ b/7.x/docs/functions/isWebSocket2023Channel.html @@ -0,0 +1,70 @@ +isWebSocket2023Channel | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function isWebSocket2023Channel

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/isWebhook2023Channel.html b/7.x/docs/functions/isWebhook2023Channel.html new file mode 100644 index 000000000..65b4c11ab --- /dev/null +++ b/7.x/docs/functions/isWebhook2023Channel.html @@ -0,0 +1,70 @@ +isWebhook2023Channel | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function isWebhook2023Channel

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/joinFilePath.html b/7.x/docs/functions/joinFilePath.html new file mode 100644 index 000000000..68a0605fe --- /dev/null +++ b/7.x/docs/functions/joinFilePath.html @@ -0,0 +1,82 @@ +joinFilePath | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function joinFilePath

+
+
    + +
  • +

    Adds the paths to the base path.

    +
    +
    +

    Parameters

    +
      +
    • +
      basePath: string
      +

      The base path (POSIX or Windows).

      +
      +
      • +
    • +
      Rest ...paths: string[]
      +

      Subpaths to attach (POSIX).

      +
      +
    +

    Returns string

    The potentially changed path (POSIX).

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/joinUrl.html b/7.x/docs/functions/joinUrl.html new file mode 100644 index 000000000..68b7df0e2 --- /dev/null +++ b/7.x/docs/functions/joinUrl.html @@ -0,0 +1,88 @@ +joinUrl | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function joinUrl

+
+
    + +
  • +

    Concatenates all the given strings into a normalized URL. +Will place slashes between input strings if necessary.

    +
    +
    +

    Parameters

    +
      +
    • +
      Rest ...parts: string[]
    +

    Returns string

    +
    • + +
  • +

    Concatenates all the given strings into a normalized URL. +Will place slashes between input strings if necessary.

    +
    +
    +

    Parameters

    +
      +
    • +
      parts: string[]
    +

    Returns string

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/listSingleThreadedComponents.html b/7.x/docs/functions/listSingleThreadedComponents.html new file mode 100644 index 000000000..47bad170b --- /dev/null +++ b/7.x/docs/functions/listSingleThreadedComponents.html @@ -0,0 +1,82 @@ +listSingleThreadedComponents | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function listSingleThreadedComponents

+
+
    + +
  • +

    Will list class names of components instantiated implementing the SingleThreaded +interface while the application is being run in multithreaded mode.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      componentsManager: ComponentsManager<T>
      +

      The componentsManager being used to set up the application

      +
      +
    +

    Returns Promise<string[]>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/map.html b/7.x/docs/functions/map.html new file mode 100644 index 000000000..470b2b3bc --- /dev/null +++ b/7.x/docs/functions/map.html @@ -0,0 +1,108 @@ +map | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function map

+
+
    + +
  • +

    Creates a new iterable with the results of calling a provided function on every element in the calling array. +Similar to the Array.prototype.map function. +See the documentation of the above function for more details.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TIn

      • +
    • +

      TOut

    +
    +

    Parameters

    +
      +
    • +
      iterable: Iterable<TIn>
      +

      Iterable on which to call the map function.

      +
      +
      • +
    • +
      callbackFn: ((element, index) => TOut)
      +

      Function that is called for every element.

      +
      +
      +
        +
      • +
          +
        • (element, index): TOut
          • +
        • +
          +

          Parameters

          +
            +
          • +
            element: TIn
            • +
          • +
            index: number
          +

          Returns TOut

      • +
    • +
      Optional thisArg: unknown
      +

      Value to use as this when executing callbackFn.

      +
      +
    +

    Returns Iterable<TOut>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/matchesAuthorizationScheme.html b/7.x/docs/functions/matchesAuthorizationScheme.html new file mode 100644 index 000000000..d78263778 --- /dev/null +++ b/7.x/docs/functions/matchesAuthorizationScheme.html @@ -0,0 +1,82 @@ +matchesAuthorizationScheme | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function matchesAuthorizationScheme

+
+
    + +
  • +

    Checks if the value of an HTTP Authorization header matches a specific scheme (e.g. Basic, Bearer, etc).

    +
    +
    +

    Parameters

    +
      +
    • +
      scheme: string
      +

      Name of the authorization scheme (case insensitive).

      +
      +
      • +
    • +
      Optional authorization: string
      +

      The value of the Authorization header (may be undefined).

      +
      +
    +

    Returns boolean

    True if the Authorization header uses the specified scheme, false otherwise.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/matchesMediaPreferences.html b/7.x/docs/functions/matchesMediaPreferences.html new file mode 100644 index 000000000..0e8705e34 --- /dev/null +++ b/7.x/docs/functions/matchesMediaPreferences.html @@ -0,0 +1,81 @@ +matchesMediaPreferences | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function matchesMediaPreferences

+
+
    + +
  • +

    Checks if the given type matches the given preferences.

    +
    +
    +

    Parameters

    +
      +
    • +
      type: string
      +

      Type to match.

      +
      +
      • +
    • +
      Optional preferred: ValuePreferences
      +

      Preferences to match against.

      +
      +
    +

    Returns boolean

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/matchesMediaType.html b/7.x/docs/functions/matchesMediaType.html new file mode 100644 index 000000000..b947118a7 --- /dev/null +++ b/7.x/docs/functions/matchesMediaType.html @@ -0,0 +1,83 @@ +matchesMediaType | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function matchesMediaType

+
+
    + +
  • +

    Checks whether the given two media types/ranges match each other. +Takes wildcards into account.

    +
    +
    +

    Parameters

    +
      +
    • +
      mediaA: string
      +

      Media type to match.

      +
      +
      • +
    • +
      mediaB: string
      +

      Media type to match.

      +
      +
    +

    Returns boolean

    True if the media type patterns can match each other.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/modify.html b/7.x/docs/functions/modify.html new file mode 100644 index 000000000..b8e96fbc5 --- /dev/null +++ b/7.x/docs/functions/modify.html @@ -0,0 +1,87 @@ +modify | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function modify

+
+
    + +
  • +

    Modifies a SetMultiMap in place by removing and adding the requested entries. +Removals happen before additions.

    +
    +
    +

    Type Parameters

    +
    +
    +

    Parameters

    +
    +

    Returns T

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/modulePath.html b/7.x/docs/functions/modulePath.html new file mode 100644 index 000000000..2ed8e4faa --- /dev/null +++ b/7.x/docs/functions/modulePath.html @@ -0,0 +1,74 @@ +modulePath | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function modulePath

+
+
    + +
  • +

    Creates a path starting from the @solid/community-server module root, +to be resolved by the resolveAssetPath function.

    +
    +
    +

    Parameters

    +
      +
    • +
      relativePath: string = ''
    +

    Returns string

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/msToDuration.html b/7.x/docs/functions/msToDuration.html new file mode 100644 index 000000000..8fde393f8 --- /dev/null +++ b/7.x/docs/functions/msToDuration.html @@ -0,0 +1,78 @@ +msToDuration | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function msToDuration

+
+
    + +
  • +

    Converts milliseconds to an ISO 8601 duration string. +The only categories used are days, hours, minutes, and seconds, +because months have no fixed size in milliseconds.

    +
    +
    +

    Parameters

    +
      +
    • +
      ms: number
      +

      The duration in ms to convert.

      +
      +
    +

    Returns string

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/normalizeFilePath.html b/7.x/docs/functions/normalizeFilePath.html new file mode 100644 index 000000000..8c0e8bb5d --- /dev/null +++ b/7.x/docs/functions/normalizeFilePath.html @@ -0,0 +1,77 @@ +normalizeFilePath | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function normalizeFilePath

+
+
    + +
  • +

    Resolves relative segments in the path.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      Path to check (POSIX or Windows).

      +
      +
    +

    Returns string

    The potentially changed path (POSIX).

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/parseAccept.html b/7.x/docs/functions/parseAccept.html new file mode 100644 index 000000000..3dfa53949 --- /dev/null +++ b/7.x/docs/functions/parseAccept.html @@ -0,0 +1,83 @@ +parseAccept | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function parseAccept

+
+
    + +
  • +

    Parses an Accept header string.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: string
      +

      The Accept header string.

      +
      +
      • +
    • +
      strict: boolean = false
      +

      Determines if invalid values throw errors (true) or log warnings (false). Defaults to false.

      +
      +
    +

    Returns Accept[]

    An array of Accept objects, sorted by weight. Accept parts +with invalid syntax are ignored and removed from the returned array.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/parseAcceptCharset.html b/7.x/docs/functions/parseAcceptCharset.html new file mode 100644 index 000000000..6f067aead --- /dev/null +++ b/7.x/docs/functions/parseAcceptCharset.html @@ -0,0 +1,83 @@ +parseAcceptCharset | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function parseAcceptCharset

+
+
    + +
  • +

    Parses an Accept-Charset header string.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: string
      +

      The Accept-Charset header string.

      +
      +
      • +
    • +
      strict: boolean = false
      +

      Determines if invalid values throw errors (true) or log warnings (false). Defaults to false.

      +
      +
    +

    Returns AcceptCharset[]

    An array of AcceptCharset objects, sorted by weight. Invalid ranges +are ignored and not returned.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/parseAcceptDateTime.html b/7.x/docs/functions/parseAcceptDateTime.html new file mode 100644 index 000000000..4d09d2bbf --- /dev/null +++ b/7.x/docs/functions/parseAcceptDateTime.html @@ -0,0 +1,83 @@ +parseAcceptDateTime | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function parseAcceptDateTime

+
+
    + +
  • +

    Parses an Accept-DateTime header string.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: string
      +

      The Accept-DateTime header string.

      +
      +
      • +
    • +
      strict: boolean = false
      +

      Determines if invalid values throw errors (true) or log warnings (false). Defaults to false.

      +
      +
    +

    Returns AcceptDatetime[]

    An array with a single AcceptDatetime object, +or an empty array if a range in an invalid format is detected.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/parseAcceptEncoding.html b/7.x/docs/functions/parseAcceptEncoding.html new file mode 100644 index 000000000..0bd6541af --- /dev/null +++ b/7.x/docs/functions/parseAcceptEncoding.html @@ -0,0 +1,83 @@ +parseAcceptEncoding | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function parseAcceptEncoding

+
+
    + +
  • +

    Parses an Accept-Encoding header string.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: string
      +

      The Accept-Encoding header string.

      +
      +
      • +
    • +
      strict: boolean = false
      +

      Determines if invalid values throw errors (true) or log warnings (false). Defaults to false.

      +
      +
    +

    Returns AcceptEncoding[]

    An array of AcceptEncoding objects, sorted by weight. Invalid ranges +are ignored and not returned.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/parseAcceptLanguage.html b/7.x/docs/functions/parseAcceptLanguage.html new file mode 100644 index 000000000..b7a62bd49 --- /dev/null +++ b/7.x/docs/functions/parseAcceptLanguage.html @@ -0,0 +1,83 @@ +parseAcceptLanguage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function parseAcceptLanguage

+
+
    + +
  • +

    Parses an Accept-Language header string.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: string
      +

      The Accept-Language header string.

      +
      +
      • +
    • +
      strict: boolean = false
      +

      Determines if invalid values throw errors (true) or log warnings (false). Defaults to false.

      +
      +
    +

    Returns AcceptLanguage[]

    An array of AcceptLanguage objects, sorted by weight. Invalid ranges +are ignored and not returned.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/parseContentType.html b/7.x/docs/functions/parseContentType.html new file mode 100644 index 000000000..26c4ba7b4 --- /dev/null +++ b/7.x/docs/functions/parseContentType.html @@ -0,0 +1,80 @@ +parseContentType | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function parseContentType

+
+
    + +
  • +

    Parses the Content-Type header and also parses any parameters in the header.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: string
      +

      The Content-Type header string.

      +
      +
    +

    Returns ContentType

    A ContentType object containing the value and optional parameters.

    + +
    +

    Throws

    BadRequestHttpError +Thrown on invalid header syntax.

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/parseForwarded.html b/7.x/docs/functions/parseForwarded.html new file mode 100644 index 000000000..fc628af27 --- /dev/null +++ b/7.x/docs/functions/parseForwarded.html @@ -0,0 +1,77 @@ +parseForwarded | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function parseForwarded

+
+
    + +
  • +

    Parses a Forwarded header value and will fall back to X-Forwarded-* headers.

    +
    +
    +

    Parameters

    +
      +
    • +
      headers: IncomingHttpHeaders
      +

      The incoming HTTP headers.

      +
      +
    +

    Returns Forwarded

    The parsed Forwarded header.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/parseLinkHeader.html b/7.x/docs/functions/parseLinkHeader.html new file mode 100644 index 000000000..757d953f2 --- /dev/null +++ b/7.x/docs/functions/parseLinkHeader.html @@ -0,0 +1,77 @@ +parseLinkHeader | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function parseLinkHeader

+
+
    + +
  • +

    Parses the link header(s) and returns an array of LinkEntry objects.

    +
    +
    +

    Parameters

    +
      +
    • +
      link: string | string[] = []
      +

      A single link header or an array of link headers

      +
      +
    +

    Returns LinkEntry[]

    A LinkEntry array, LinkEntry contains a link and a params Record<string,string>

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/parseParameters.html b/7.x/docs/functions/parseParameters.html new file mode 100644 index 000000000..92edaa05e --- /dev/null +++ b/7.x/docs/functions/parseParameters.html @@ -0,0 +1,88 @@ +parseParameters | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function parseParameters

+
+
    + +
  • +

    Parses a list of split parameters and checks their validity. Parameters with invalid +syntax are ignored and not returned.

    +
    +
    +

    Parameters

    +
      +
    • +
      parameters: string[]
      +

      A list of split parameters (token [ "=" ( token / quoted-string ) ])

      +
      +
      • +
    • +
      replacements: Record<string, string>
      +

      The double quoted strings that need to be replaced.

      +
      +
      • +
    • +
      strict: boolean = false
      +

      Determines if invalid values throw errors (true) or log warnings (false). Defaults to false.

      +
      +
    +

    Returns {
        name: string;
        value: string;
    }[]

    An array of name/value objects corresponding to the parameters.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/parsePath.html b/7.x/docs/functions/parsePath.html new file mode 100644 index 000000000..97d4fdd6b --- /dev/null +++ b/7.x/docs/functions/parsePath.html @@ -0,0 +1,88 @@ +parsePath | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function parsePath

+
+
    + +
  • +

    Parses the given path with the given InteractionRoute. +This assumes this call will succeed and thus expects the path to have the correct format. +If not, a 500 error will be thrown.

    +
    +
    +

    Type Parameters

    +
    +
    +

    Parameters

    +
      +
    • +
      route: T
      +

      Route to parse with.

      +
      +
      • +
    • +
      path: string
      +

      Path to parse.

      +
      +
    +

    Returns NonNullable<ReturnType<T["matchPath"]>>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/parseQuads.html b/7.x/docs/functions/parseQuads.html new file mode 100644 index 000000000..f3688cd8e --- /dev/null +++ b/7.x/docs/functions/parseQuads.html @@ -0,0 +1,82 @@ +parseQuads | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function parseQuads

+
+
    + +
  • +

    Helper function to convert a Readable into an array of quads.

    +
    +
    +

    Parameters

    +
      +
    • +
      readable: Guarded<Readable>
      +

      The readable object.

      +
      +
      • +
    • +
      options: ParserOptions = {}
      +

      Options for the parser.

      +
      +
    +

    Returns Promise<Quad[]>

    A promise containing the array of quads.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/parseSchema.html b/7.x/docs/functions/parseSchema.html new file mode 100644 index 000000000..29bf2df20 --- /dev/null +++ b/7.x/docs/functions/parseSchema.html @@ -0,0 +1,78 @@ +parseSchema | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function parseSchema

+
+
    + +
  • +

    Generates a simplified representation of a yup schema.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends BaseObjectSchema

    +
    +

    Parameters

    +
      +
    • +
      schema: T
    +

    Returns Pick<SchemaType<T>, "fields">

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/parseWebSocketRequest.html b/7.x/docs/functions/parseWebSocketRequest.html new file mode 100644 index 000000000..1e536fc34 --- /dev/null +++ b/7.x/docs/functions/parseWebSocketRequest.html @@ -0,0 +1,81 @@ +parseWebSocketRequest | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function parseWebSocketRequest

+
+
    + +
  • +

    Parses a IncomingMessage to extract its path used for authentication.

    +
    +
    +

    Parameters

    +
      +
    • +
      baseUrl: string
      +

      The base URL of the server.

      +
      +
      • +
    • +
      request: IncomingMessage
      +

      The request to parse.

      +
      +
    +

    Returns string

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/pipeSafely.html b/7.x/docs/functions/pipeSafely.html new file mode 100644 index 000000000..601767781 --- /dev/null +++ b/7.x/docs/functions/pipeSafely.html @@ -0,0 +1,105 @@ +pipeSafely | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function pipeSafely

+
+
    + +
  • +

    Pipes one stream into another and emits errors of the first stream with the second. +If the first stream errors, the second one will be destroyed with the given error. +This will also make the stream Guarded.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends Writable

    +
    +

    Parameters

    +
      +
    • +
      readable: ReadableStream
      +

      Initial readable stream.

      +
      +
      • +
    • +
      destination: T
      +

      The destination for writing data.

      +
      +
      • +
    • +
      Optional mapError: ((error) => Error)
      +

      Optional function that takes the error and converts it to a new error.

      +
      +
      +
        +
      • +
          +
        • (error): Error
          • +
        • +
          +

          Parameters

          +
            +
          • +
            error: Error
          +

          Returns Error

    +

    Returns Guarded<T>

    The destination stream.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/preferencesToString.html b/7.x/docs/functions/preferencesToString.html new file mode 100644 index 000000000..6ec9764dc --- /dev/null +++ b/7.x/docs/functions/preferencesToString.html @@ -0,0 +1,76 @@ +preferencesToString | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function preferencesToString

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/promiseSome.html b/7.x/docs/functions/promiseSome.html new file mode 100644 index 000000000..edd76150f --- /dev/null +++ b/7.x/docs/functions/promiseSome.html @@ -0,0 +1,82 @@ +promiseSome | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function promiseSome

+
+
    + +
  • +

    A function that simulates the Array.some behaviour but on an array of Promises. +Returns true if at least one promise returns true. +Returns false if all promises return false or error.

    +
    +
    +

    Parameters

    +
      +
    • +
      predicates: Promise<boolean>[]
    +

    Returns Promise<boolean>

    +
    +

    Remarks

    Predicates provided as input must be implemented considering +the following points:

    +
      +
    1. if they throw an error, it won't be propagated;
      2. +
    2. throwing an error should be logically equivalent to returning false.
      3. +
    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/readJsonStream.html b/7.x/docs/functions/readJsonStream.html new file mode 100644 index 000000000..a383ec656 --- /dev/null +++ b/7.x/docs/functions/readJsonStream.html @@ -0,0 +1,77 @@ +readJsonStream | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function readJsonStream

+
+
    + +
  • +

    Interprets the stream as JSON and converts it to a Dict.

    +
    +
    +

    Parameters

    +
      +
    • +
      stream: Readable
      +

      Stream of JSON data.

      +
      +
    +

    Returns Promise<Json>

    The parsed object.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/readPackageJson.html b/7.x/docs/functions/readPackageJson.html new file mode 100644 index 000000000..3e03eff21 --- /dev/null +++ b/7.x/docs/functions/readPackageJson.html @@ -0,0 +1,68 @@ +readPackageJson | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function readPackageJson

+
+
    + +
  • +

    Reads the project package.json and returns it.

    +
    +

    Returns Promise<Record<string, Json>>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/readTemplate.html b/7.x/docs/functions/readTemplate.html new file mode 100644 index 000000000..62c515c8c --- /dev/null +++ b/7.x/docs/functions/readTemplate.html @@ -0,0 +1,73 @@ +readTemplate | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function readTemplate

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/readableToQuads.html b/7.x/docs/functions/readableToQuads.html new file mode 100644 index 000000000..8956e615c --- /dev/null +++ b/7.x/docs/functions/readableToQuads.html @@ -0,0 +1,77 @@ +readableToQuads | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function readableToQuads

+
+
    + +
  • +

    Imports quads from a stream into a Store.

    +
    +
    +

    Parameters

    +
      +
    • +
      stream: Readable
      +

      Stream of quads.

      +
      +
    +

    Returns Promise<Store>

    A Store containing all the quads.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/readableToString.html b/7.x/docs/functions/readableToString.html new file mode 100644 index 000000000..4b55d1516 --- /dev/null +++ b/7.x/docs/functions/readableToString.html @@ -0,0 +1,77 @@ +readableToString | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function readableToString

+
+
    + +
  • +

    Joins all strings of a stream.

    +
    +
    +

    Parameters

    +
      +
    • +
      stream: Readable
      +

      Stream of strings.

      +
      +
    +

    Returns Promise<string>

    The joined string.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/reduce.html b/7.x/docs/functions/reduce.html new file mode 100644 index 000000000..03338d25c --- /dev/null +++ b/7.x/docs/functions/reduce.html @@ -0,0 +1,152 @@ +reduce | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function reduce

+
+
    + +
  • +

    Similar to the Array.prototype.reduce function, but for an iterable. +See the documentation of the above function for more details. +The first element will be used as the initial value.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TIn

    +
    +

    Parameters

    +
      +
    • +
      iterable: Iterable<TIn>
      +

      Iterable of which to reduce the elements.

      +
      +
      • +
    • +
      callbackFn: ((previousValue, currentValue, currentIndex) => TIn)
      +

      A reducer function.

      +
      +
      +
        +
      • +
          +
        • (previousValue, currentValue, currentIndex): TIn
          • +
        • +
          +

          Parameters

          +
            +
          • +
            previousValue: TIn
            • +
          • +
            currentValue: TIn
            • +
          • +
            currentIndex: number
          +

          Returns TIn

    +

    Returns TIn

    +
    • + +
  • +

    Similar to the Array.prototype.reduce function, but for an iterable. +See the documentation of the above function for more details.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TIn

      • +
    • +

      TOut

    +
    +

    Parameters

    +
      +
    • +
      iterable: Iterable<TIn>
      +

      Iterable of which to reduce the elements.

      +
      +
      • +
    • +
      callbackFn: ((previousValue, currentValue, currentIndex) => TOut)
      +

      A reducer function.

      +
      +
      +
        +
      • +
          +
        • (previousValue, currentValue, currentIndex): TOut
          • +
        • +
          +

          Parameters

          +
            +
          • +
            previousValue: TOut
            • +
          • +
            currentValue: TIn
            • +
          • +
            currentIndex: number
          +

          Returns TOut

      • +
    • +
      initialValue: TOut
      +

      The value to start from.

      +
      +
    +

    Returns TOut

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/resetInternalLoggerFactory.html b/7.x/docs/functions/resetInternalLoggerFactory.html new file mode 100644 index 000000000..e29c25beb --- /dev/null +++ b/7.x/docs/functions/resetInternalLoggerFactory.html @@ -0,0 +1,74 @@ +resetInternalLoggerFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function resetInternalLoggerFactory

+
+
    + +
  • +

    Resets the internal logger factory, which holds the global logger factory. +For testing purposes only.

    +
    +
    +

    Parameters

    +
    +

    Returns void

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/resolveAssetPath.html b/7.x/docs/functions/resolveAssetPath.html new file mode 100644 index 000000000..79702d4eb --- /dev/null +++ b/7.x/docs/functions/resolveAssetPath.html @@ -0,0 +1,75 @@ +resolveAssetPath | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function resolveAssetPath

+
+
    + +
  • +

    Converts file path inputs into absolute paths. +Works similar to absoluteFilePath but paths that start with the modulePathPlaceholder +will be relative to the module directory instead of the cwd.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string = modulePathPlaceholder
    +

    Returns string

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/resolveModulePath.html b/7.x/docs/functions/resolveModulePath.html new file mode 100644 index 000000000..4f38d4aed --- /dev/null +++ b/7.x/docs/functions/resolveModulePath.html @@ -0,0 +1,73 @@ +resolveModulePath | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function resolveModulePath

+
+
    + +
  • +

    Creates an absolute path starting from the @solid/community-server module root.

    +
    +
    +

    Parameters

    +
      +
    • +
      relativePath: string = ''
    +

    Returns string

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/resolvePromiseOrValue.html b/7.x/docs/functions/resolvePromiseOrValue.html new file mode 100644 index 000000000..173e77ff3 --- /dev/null +++ b/7.x/docs/functions/resolvePromiseOrValue.html @@ -0,0 +1,95 @@ +resolvePromiseOrValue | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function resolvePromiseOrValue

+
+
    + +
  • +

    Calls callback with the resolved value of object. +In case object is a Promise, the result will also be a Promise, +otherwise the result will be sync.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TIn

      • +
    • +

      TOut

    +
    +

    Parameters

    +
      +
    • +
      object: PromiseOrValue<TIn>
      • +
    • +
      callback: ((val) => TOut)
      +
        +
      • +
          +
        • (val): TOut
          • +
        • +
          +

          Parameters

          +
            +
          • +
            val: TIn
          +

          Returns TOut

    +

    Returns PromiseOrValue<TOut>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/responseToDataset.html b/7.x/docs/functions/responseToDataset.html new file mode 100644 index 000000000..fe59c35d3 --- /dev/null +++ b/7.x/docs/functions/responseToDataset.html @@ -0,0 +1,80 @@ +responseToDataset | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function responseToDataset

+
+
    + +
  • +

    Converts a given Response (from a request that was already made) to an RDF dataset. +In case the given Response object was already parsed its body can be passed along as a string.

    +

    The converter will be used to convert the response body to RDF.

    +

    Response will be a Representation with content-type internal/quads.

    +
    +
    +

    Parameters

    +
    +

    Returns Promise<Representation>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/sanitizeUrlPart.html b/7.x/docs/functions/sanitizeUrlPart.html new file mode 100644 index 000000000..672155c83 --- /dev/null +++ b/7.x/docs/functions/sanitizeUrlPart.html @@ -0,0 +1,77 @@ +sanitizeUrlPart | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function sanitizeUrlPart

+
+
    + +
  • +

    Sanitizes part of a URL by replacing non-word content with a '-'.

    +
    +
    +

    Parameters

    +
      +
    • +
      urlPart: string
      +

      The URL part to sanitize.

      +
      +
    +

    Returns string

    The sanitized output.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/serializeQuads.html b/7.x/docs/functions/serializeQuads.html new file mode 100644 index 000000000..89dfd1fbd --- /dev/null +++ b/7.x/docs/functions/serializeQuads.html @@ -0,0 +1,82 @@ +serializeQuads | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function serializeQuads

+
+
    + +
  • +

    Helper function for serializing an array of quads, with as result a Readable object.

    +
    +
    +

    Parameters

    +
      +
    • +
      quads: Quad[]
      +

      The array of quads.

      +
      +
      • +
    • +
      Optional contentType: string
      +

      The content-type to serialize to.

      +
      +
    +

    Returns Guarded<Readable>

    The Readable object.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/setGlobalLoggerFactory.html b/7.x/docs/functions/setGlobalLoggerFactory.html new file mode 100644 index 000000000..2b761a227 --- /dev/null +++ b/7.x/docs/functions/setGlobalLoggerFactory.html @@ -0,0 +1,77 @@ +setGlobalLoggerFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function setGlobalLoggerFactory

+
+
    + +
  • +

    Sets the global logger factory. +This causes loggers created by getLoggerFor to delegate to a logger from the given factory.

    +
    +
    +

    Parameters

    +
    +

    Returns void

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/setSafeInterval.html b/7.x/docs/functions/setSafeInterval.html new file mode 100644 index 000000000..a9d5a445b --- /dev/null +++ b/7.x/docs/functions/setSafeInterval.html @@ -0,0 +1,100 @@ +setSafeInterval | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function setSafeInterval

+
+
    + +
  • +

    Wraps the callback for setInterval so errors get caught and logged. +Parameters are identical to the setInterval parameters starting from the 3rd argument. +The logger and message will be used when the callback throws an error. +Supports asynchronous callback functions.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TArgs

    +
    +

    Parameters

    +
      +
    • +
      logger: Logger
      • +
    • +
      message: string
      • +
    • +
      callback: ((...cbArgs) => void | Promise<void>)
      +
        +
      • +
          +
        • (...cbArgs): void | Promise<void>
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Rest ...cbArgs: TArgs[]
          +

          Returns void | Promise<void>

      • +
    • +
      Optional ms: number
      • +
    • +
      Rest ...args: TArgs[]
    +

    Returns NodeJS.Timeout

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/sortedAsyncMerge.html b/7.x/docs/functions/sortedAsyncMerge.html new file mode 100644 index 000000000..907ee6a4b --- /dev/null +++ b/7.x/docs/functions/sortedAsyncMerge.html @@ -0,0 +1,100 @@ +sortedAsyncMerge | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function sortedAsyncMerge

+
+
    + +
  • +

    Merges the results of several sorted iterators. +In case the results of the individual iterators are not sorted the outcome results will also not be sorted.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      iterators: AsyncIterator<T, any, undefined>[]
      +

      The iterators whose results need to be merged.

      +
      +
      • +
    • +
      Optional comparator: ((left, right) => number)
      +

      The comparator to use to compare the results.

      +
      +
      +
        +
      • +
          +
        • (left, right): number
          • +
        • +
          +

          Parameters

          +
            +
          • +
            left: T
            • +
          • +
            right: T
          +

          Returns number

    +

    Returns AsyncIterable<T>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/splitAndClean.html b/7.x/docs/functions/splitAndClean.html new file mode 100644 index 000000000..9520925f8 --- /dev/null +++ b/7.x/docs/functions/splitAndClean.html @@ -0,0 +1,77 @@ +splitAndClean | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function splitAndClean

+
+
    + +
  • +

    Splits the input string on commas, trims all parts and filters out empty ones.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: string
      +

      Input header string.

      +
      +
    +

    Returns string[]

    An array of trimmed strings.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/splitCommaSeparated.html b/7.x/docs/functions/splitCommaSeparated.html new file mode 100644 index 000000000..4b2faed0b --- /dev/null +++ b/7.x/docs/functions/splitCommaSeparated.html @@ -0,0 +1,77 @@ +splitCommaSeparated | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function splitCommaSeparated

+
+
    + +
  • +

    Splits a string by comma.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: string
      +

      String instance to split.

      +
      +
    +

    Returns string[]

    A String array containining the split parts.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/termToInt.html b/7.x/docs/functions/termToInt.html new file mode 100644 index 000000000..e91c6b924 --- /dev/null +++ b/7.x/docs/functions/termToInt.html @@ -0,0 +1,81 @@ +termToInt | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function termToInt

+
+
    + +
  • +

    Converts a term to a number. Returns undefined if the term was undefined.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional term: Term
      +

      Term to parse.

      +
      +
      • +
    • +
      radix: number = 10
      +

      Radix to use when parsing. Default is 10.

      +
      +
    +

    Returns number | undefined

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/toCanonicalUriPath.html b/7.x/docs/functions/toCanonicalUriPath.html new file mode 100644 index 000000000..8dd3948a2 --- /dev/null +++ b/7.x/docs/functions/toCanonicalUriPath.html @@ -0,0 +1,80 @@ +toCanonicalUriPath | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function toCanonicalUriPath

+
+
    + +
  • +

    Converts a URI path to the canonical version by splitting on slashes, +decoding any percent-based encodings, and then encoding any special characters. +This function is used to clean unwanted characters in the components of +the provided path.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      The path to convert to its canonical URI path form.

      +
      +
    +

    Returns string

    The canonical URI path form of the provided path.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/toComponentsJsType.html b/7.x/docs/functions/toComponentsJsType.html new file mode 100644 index 000000000..8011f4e06 --- /dev/null +++ b/7.x/docs/functions/toComponentsJsType.html @@ -0,0 +1,87 @@ +toComponentsJsType | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function toComponentsJsType

+
+
    + +
  • +

    Convert an exported interface name to the properly expected Components.js type URI.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      componentsManager: ComponentsManager<T>
      +

      The currently used ComponentsManager

      +
      +
      • +
    • +
      interfaceName: string
      +

      An interface name

      +
      +
    +

    Returns Promise<string>

    A Components.js type URI

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/toLiteral.html b/7.x/docs/functions/toLiteral.html new file mode 100644 index 000000000..1076500d2 --- /dev/null +++ b/7.x/docs/functions/toLiteral.html @@ -0,0 +1,81 @@ +toLiteral | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function toLiteral

+
+
    + +
  • +

    Creates a literal by first converting the dataType string to a named node.

    +
    +
    +

    Parameters

    +
      +
    • +
      object: string | number
      +

      Object value.

      +
      +
      • +
    • +
      dataType: NamedNode<string>
      +

      Object data type (as string).

      +
      +
    +

    Returns Literal

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/toNamedTerm.html b/7.x/docs/functions/toNamedTerm.html new file mode 100644 index 000000000..1566017ec --- /dev/null +++ b/7.x/docs/functions/toNamedTerm.html @@ -0,0 +1,106 @@ +toNamedTerm | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function toNamedTerm

+
+
    + +
  • +

    Converts a string to a named node when needed.

    +
    +
    +

    Parameters

    +
      +
    • +
      subject: string
      +

      Subject to potentially transform.

      +
      +
    +

    Returns NamedNode

    +
    • + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T extends Term

    +
    +

    Parameters

    +
      +
    • +
      subject: T
    +

    Returns T

    • + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T extends Term

    +
    +

    Parameters

    +
      +
    • +
      subject: string | T
    +

    Returns T | NamedNode

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/toObjectTerm.html b/7.x/docs/functions/toObjectTerm.html new file mode 100644 index 000000000..116f84fa0 --- /dev/null +++ b/7.x/docs/functions/toObjectTerm.html @@ -0,0 +1,115 @@ +toObjectTerm | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function toObjectTerm

+
+
    + +
  • +

    Converts an object term when needed.

    +
    +
    +

    Parameters

    +
      +
    • +
      object: string
      +

      Object to potentially transform.

      +
      +
      • +
    • +
      Optional preferLiteral: boolean
      +

      Whether strings are converted to literals or named nodes.

      +
      +
    +

    Returns NamedNode

    +
    • + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T extends Term

    +
    +

    Parameters

    +
      +
    • +
      object: T
      • +
    • +
      Optional preferLiteral: boolean
    +

    Returns T

    • + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T extends Term

    +
    +

    Parameters

    +
      +
    • +
      object: string | T
      • +
    • +
      Optional preferLiteral: boolean
    +

    Returns T | NamedNode

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/toPredicateTerm.html b/7.x/docs/functions/toPredicateTerm.html new file mode 100644 index 000000000..3d104b83e --- /dev/null +++ b/7.x/docs/functions/toPredicateTerm.html @@ -0,0 +1,106 @@ +toPredicateTerm | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function toPredicateTerm

+
+
    + +
  • +

    Converts a string to a named node when needed.

    +
    +
    +

    Parameters

    +
      +
    • +
      subject: string
      +

      Subject to potentially transform.

      +
      +
    +

    Returns NamedNode

    +
    • + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T extends Term

    +
    +

    Parameters

    +
      +
    • +
      subject: T
    +

    Returns T

    • + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T extends Term

    +
    +

    Parameters

    +
      +
    • +
      subject: string | T
    +

    Returns T | NamedNode

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/transformQuotedStrings.html b/7.x/docs/functions/transformQuotedStrings.html new file mode 100644 index 000000000..1874bff84 --- /dev/null +++ b/7.x/docs/functions/transformQuotedStrings.html @@ -0,0 +1,85 @@ +transformQuotedStrings | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function transformQuotedStrings

+
+
    + +
  • +

    Replaces all double quoted strings in the input string with "0", "1", etc.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: string
      +

      The Accept header string.

      +
      +
    +

    Returns {
        replacements: Record<string, string>;
        result: string;
    }

    The transformed string and a map with keys "0", etc. and values the original string that was there.

    + +
      +
    • +
      replacements: Record<string, string>
      • +
    • +
      result: string
    +
    +

    Throws

    BadRequestHttpError +Thrown if invalid characters are detected in a quoted string.

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/transformSafely.html b/7.x/docs/functions/transformSafely.html new file mode 100644 index 000000000..48e090bd2 --- /dev/null +++ b/7.x/docs/functions/transformSafely.html @@ -0,0 +1,87 @@ +transformSafely | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function transformSafely

+
+
    + +
  • +

    Transforms a stream, ensuring that all errors are forwarded.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T = unknown

    +
    +

    Parameters

    +
      +
    • +
      source: ReadableStream
      +

      The stream to be transformed.

      +
      +
      • +
    • +
      options: AsyncTransformOptions<T> = {}
      +

      The transformation options.

      +
      +
    +

    Returns Guarded<Transform>

    The transformed stream

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/trimLeadingSlashes.html b/7.x/docs/functions/trimLeadingSlashes.html new file mode 100644 index 000000000..2ac4c102b --- /dev/null +++ b/7.x/docs/functions/trimLeadingSlashes.html @@ -0,0 +1,77 @@ +trimLeadingSlashes | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function trimLeadingSlashes

+
+
    + +
  • +

    Makes sure the input path has no slashes at the beginning.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      Path to check.

      +
      +
    +

    Returns string

    The potentially changed path.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/trimTrailingSlashes.html b/7.x/docs/functions/trimTrailingSlashes.html new file mode 100644 index 000000000..d903a60d3 --- /dev/null +++ b/7.x/docs/functions/trimTrailingSlashes.html @@ -0,0 +1,77 @@ +trimTrailingSlashes | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function trimTrailingSlashes

+
+
    + +
  • +

    Makes sure the input path has no slashes at the end.

    +
    +
    +

    Parameters

    +
      +
    • +
      path: string
      +

      Path to check.

      +
      +
    +

    Returns string

    The potentially changed path.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/uniqueQuads.html b/7.x/docs/functions/uniqueQuads.html new file mode 100644 index 000000000..896e05289 --- /dev/null +++ b/7.x/docs/functions/uniqueQuads.html @@ -0,0 +1,77 @@ +uniqueQuads | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function uniqueQuads

+
+
    + +
  • +

    Filter out duplicate quads from an array.

    +
    +
    +

    Parameters

    +
      +
    • +
      quads: Quad[]
      +

      Quads to filter.

      +
      +
    +

    Returns Quad[]

    A new array containing the unique quads.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/updateModifiedDate.html b/7.x/docs/functions/updateModifiedDate.html new file mode 100644 index 000000000..0c83c9aa5 --- /dev/null +++ b/7.x/docs/functions/updateModifiedDate.html @@ -0,0 +1,81 @@ +updateModifiedDate | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function updateModifiedDate

+
+
    + +
  • +

    Updates the dc:modified time to the given time.

    +
    +
    +

    Parameters

    +
      +
    • +
      metadata: RepresentationMetadata
      +

      Metadata to update.

      +
      +
      • +
    • +
      date: Date = ...
      +

      Last modified date. Defaults to current time.

      +
      +
    +

    Returns void

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/validateWithError.html b/7.x/docs/functions/validateWithError.html new file mode 100644 index 000000000..1e8ad441a --- /dev/null +++ b/7.x/docs/functions/validateWithError.html @@ -0,0 +1,82 @@ +validateWithError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function validateWithError

+
+
    + +
  • +

    Same functionality as the yup validate function, but throws a BadRequestHttpError if there is an error.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends BaseObjectSchema

    +
    +

    Parameters

    +
      +
    • +
      schema: T
      • +
    • +
      data: unknown
      • +
    • +
      Optional options: ValidateOptions<AnyObject>
    +

    Returns Promise<T["__outputType"]>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/functions/verifyAccountId.html b/7.x/docs/functions/verifyAccountId.html new file mode 100644 index 000000000..c32a1b6e6 --- /dev/null +++ b/7.x/docs/functions/verifyAccountId.html @@ -0,0 +1,82 @@ +verifyAccountId | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Function verifyAccountId

+
+
    + +
  • +

    Asserts that the two given IDs are identical. +To be used when a request tries to access a resource to ensure they're not accessing someone else's data.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional input: string
      +

      Input ID.

      +
      +
      • +
    • +
      Optional expected: string
      +

      Expected ID.

      +
      +
    +

    Returns asserts expected is string

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/index.html b/7.x/docs/index.html new file mode 100644 index 000000000..2ce3e01c6 --- /dev/null +++ b/7.x/docs/index.html @@ -0,0 +1,126 @@ +Community Solid Server - v7.0.5
+
+ +
+
+
+
+

Community Solid Server - v7.0.5

+

Community Solid Server

[Solid logo]

+

MIT license +npm version +Node.js version +Build Status +Coverage Status +DOI +GitHub discussions +Chat on Gitter

+

The Community Solid Server is open software +that provides you with a Solid Pod and identity. +This Pod acts as your own personal storage space +so you can share data with people and Solid applications.

+

As an open and modular implementation of the +Solid specifications, +the Community Solid Server is a great companion:

+
    +

  • 🧑🏽 for people who want to try out having their own Pod

    +
    • +

  • 👨🏿‍💻 for developers who want to quickly create and test Solid apps

    +
    • +

  • 👩🏻‍🔬 for researchers who want to design new features for Solid

    +
    • +
+

And, of course, for many others who like to experience Solid.

+

⚡ Running the Community Solid Server

Use Node.js 18.0 or up and execute:

+
npx @solid/community-server
+
+

Now visit your brand new server at http://localhost:3000/!

+

To persist your pod's contents between restarts, use:

+
npx @solid/community-server -c @css:config/file.json -f data/
+
+

Find more ways to run the server in the documentation.

+

🔧 Configure your server

Substantial changes to server behavior can be achieved via JSON configuration files. +The Community Solid Server uses Components.js +to specify how modules and components need to be wired together at runtime.

+

Recipes for configuring the server can be found at CommunitySolidServer/recipes.

+

Examples and guidance on custom configurations +are available in the config folder, +and the configurations tutorial. +There is also a configuration generator.

+

👩🏽‍💻 Developing server code

The server allows writing and plugging in custom modules +without altering its base source code.

+

The 📗 API documentation and +the 📓 user documentation +can help you find your way. +There is also a repository of 📚 comprehensive tutorials

+

📜 License

The Solid Community Server code +is copyrighted by Inrupt Inc. +and imec +and available under the MIT License.

+

🎤 Feedback and questions

Don't hesitate to start a discussion +or report a bug.

+

There's also a Matrix-based, CSS-focused chat

+

Learn more about Solid at solidproject.org.

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/AccessCheckerArgs.html b/7.x/docs/interfaces/AccessCheckerArgs.html new file mode 100644 index 000000000..ad7bac5ed --- /dev/null +++ b/7.x/docs/interfaces/AccessCheckerArgs.html @@ -0,0 +1,108 @@ +AccessCheckerArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface AccessCheckerArgs

+
+

Hierarchy

+
    +
  • AccessCheckerArgs
+
+
+
+ +
+
+

Properties

+
acl +credentials +rule +
+
+

Properties

+
+

acl

+
acl: Store<Quad, Quad, Quad, Quad>
+

A store containing the relevant triples of the authorization.

+
+
+
+

credentials

+
credentials: Credentials
+

Credentials of the entity that wants to use the resource.

+
+
+
+

rule

+
rule: Term
+

Authorization rule to be processed.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/AccountInitializerArgs.html b/7.x/docs/interfaces/AccountInitializerArgs.html new file mode 100644 index 000000000..aeda2fb44 --- /dev/null +++ b/7.x/docs/interfaces/AccountInitializerArgs.html @@ -0,0 +1,138 @@ +AccountInitializerArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface AccountInitializerArgs

+
+

Hierarchy

+
    +
  • AccountInitializerArgs
+
+
+
+ +
+
+

Properties

+
accountStore +email +name? +password +passwordStore +podCreator +
+
+

Properties

+
+

accountStore

+
accountStore: AccountStore
+

Creates the accounts.

+
+
+
+

email

+
email: string
+

Email address for the account login.

+
+
+
+

Optional name

+
name?: string
+

Name to use for the pod. If undefined the pod will be made in the root of the server.

+
+
+
+

password

+
password: string
+

Password for the account login.

+
+
+
+

passwordStore

+
passwordStore: PasswordStore
+

Adds the login methods.

+
+
+
+

podCreator

+
podCreator: PodCreator
+

Creates the pods.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/AccountStore.html b/7.x/docs/interfaces/AccountStore.html new file mode 100644 index 000000000..217eaf85a --- /dev/null +++ b/7.x/docs/interfaces/AccountStore.html @@ -0,0 +1,184 @@ +AccountStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface AccountStore

+
+

Used to store account data.

+
+
+
+

Hierarchy

+
    +
  • AccountStore
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
create +getSetting +updateSetting +
+
+

Properties

+
+

create

+
create: (() => Promise<string>)
+
+

Type declaration

+
    +
  • +
      +
    • (): Promise<string>
      • +
    • +

      Creates a new and empty account. +Since this account will not yet have a login method, +implementations should restrict what is possible with this account, +and should potentially have something in place to clean these accounts up if they are unused.

      +
      +

      Returns Promise<string>

      +
+
+

getSetting

+
getSetting: (<T>(id, setting) => Promise<AccountSettings[T]>)
+
+

Type declaration

+
    +
  • +
      +
    • <T>(id, setting): Promise<AccountSettings[T]>
      • +
    • +

      Finds the setting of the account with the given identifier.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        T extends "rememberLogin"

      +
      +

      Parameters

      +
        +
      • +
        id: string
        +

        The account identifier.

        +
        +
        • +
      • +
        setting: T
        +

        The setting to find the value of.

        +
        +
      +

      Returns Promise<AccountSettings[T]>

      +
+
+

updateSetting

+
updateSetting: (<T>(id, setting, value) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • <T>(id, setting, value): Promise<void>
      • +
    • +

      Updates the settings for the account with the given identifier to the new values.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        T extends "rememberLogin"

      +
      +

      Parameters

      +
        +
      • +
        id: string
        +

        The account identifier.

        +
        +
        • +
      • +
        setting: T
        +

        The setting to update.

        +
        +
        • +
      • +
        value: AccountSettings[T]
        +

        The new value for the setting.

        +
        +
      +

      Returns Promise<void>

      +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/AdapterFactory.html b/7.x/docs/interfaces/AdapterFactory.html new file mode 100644 index 000000000..2d0ecef7f --- /dev/null +++ b/7.x/docs/interfaces/AdapterFactory.html @@ -0,0 +1,110 @@ +AdapterFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface AdapterFactory

+
+

A factory that generates an Adapter to be used by the IDP to persist information.

+

The oidc-provider library will call the relevant functions when it needs to find/create/delete metadata. +For a full explanation of how these functions work and what is expected, +have a look at https://github.com/panva/node-oidc-provider/blob/main/example/my_adapter.js

+
+
+
+

Hierarchy

+
    +
  • AdapterFactory
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
createStorageAdapter +
+
+

Properties

+
+

createStorageAdapter

+
createStorageAdapter: ((name) => Adapter)
+
+

Type declaration

+
    +
  • +
      +
    • (name): Adapter
      • +
    • +
      +

      Parameters

      +
        +
      • +
        name: string
      +

      Returns Adapter

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/AlgJwk.html b/7.x/docs/interfaces/AlgJwk.html new file mode 100644 index 000000000..bcfd74cd0 --- /dev/null +++ b/7.x/docs/interfaces/AlgJwk.html @@ -0,0 +1,304 @@ +AlgJwk | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface AlgJwk

+
+

A JWK where the alg parameter is always defined.

+
+
+
+

Hierarchy

+
    +
  • JWK +
      +
    • AlgJwk
+
+
+
+ +
+
+

Properties

+
alg +crv? +d? +dp? +dq? +e? +ext? +k? +key_ops? +kid? +kty? +n? +oth? +p? +q? +qi? +use? +x? +x5c? +x5t? +x5t#S256? +x5u? +y? +
+
+

Properties

+
+

alg

+
alg: AsymmetricSigningAlgorithm
+
+

Optional crv

+
crv?: string
+
+

Optional d

+
d?: string
+
+

Optional dp

+
dp?: string
+
+

Optional dq

+
dq?: string
+
+

Optional e

+
e?: string
+
+

Optional ext

+
ext?: boolean
+

JWK "ext" (Extractable) Parameter.

+
+
+
+

Optional k

+
k?: string
+
+

Optional key_ops

+
key_ops?: string[]
+

JWK "key_ops" (Key Operations) Parameter.

+
+
+
+

Optional kid

+
kid?: string
+

JWK "kid" (Key ID) Parameter.

+
+
+
+

Optional kty

+
kty?: string
+

JWK "kty" (Key Type) Parameter.

+
+
+
+

Optional n

+
n?: string
+
+

Optional oth

+
oth?: {
    d?: string;
    r?: string;
    t?: string;
}[]
+
+

Type declaration

+
    +
  • +
    Optional d?: string
    • +
  • +
    Optional r?: string
    • +
  • +
    Optional t?: string
+
+

Optional p

+
p?: string
+
+

Optional q

+
q?: string
+
+

Optional qi

+
qi?: string
+
+

Optional use

+
use?: string
+

JWK "use" (Public Key Use) Parameter.

+
+
+
+

Optional x

+
x?: string
+
+

Optional x5c

+
x5c?: string[]
+

JWK "x5c" (X.509 Certificate Chain) Parameter.

+
+
+
+

Optional x5t

+
x5t?: string
+

JWK "x5t" (X.509 Certificate SHA-1 Thumbprint) Parameter.

+
+
+
+

Optional x5t#S256

+
x5t#S256?: string
+

"x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Parameter.

+
+
+
+

Optional x5u

+
x5u?: string
+

JWK "x5u" (X.509 URL) Parameter.

+
+
+
+

Optional y

+
y?: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/AppRunnerInput.html b/7.x/docs/interfaces/AppRunnerInput.html new file mode 100644 index 000000000..1eafe2d35 --- /dev/null +++ b/7.x/docs/interfaces/AppRunnerInput.html @@ -0,0 +1,147 @@ +AppRunnerInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface AppRunnerInput

+
+

Parameters that can be used to instantiate the server through code.

+
+
+
+

Hierarchy

+
    +
  • AppRunnerInput
+
+
+
+ +
+
+

Properties

+
argv? +config? +loaderProperties? +shorthand? +variableBindings? +
+
+

Properties

+
+

Optional argv

+
argv?: string[]
+

An array containing CLI arguments passed to start the process. +Entries here have the lowest priority for assigning values to variables.

+
+
+
+

Optional config

+
config?: string | string[]
+

Path to the server config file(s). Defaults to @css:config/default.json.

+
+
+
+

Optional loaderProperties

+
loaderProperties?: Partial<IComponentsManagerBuilderOptions<App>>
+

Properties that will be used when building the Components.js manager. +Default values:

+
    +
  • typeChecking: false, as the server components would otherwise error.
    • +
  • mainModulePath: @css:, which resolves to the directory of the CSS package. + This is useful for packages that depend on the CSS + but do not create any new modules themselves.
    • +
+
+
+
+

Optional shorthand

+
shorthand?: Shorthand
+

CLI argument names and their corresponding values. +E.g.: { rootFilePath: '.data' }. +Abbreviated parameter names can not be used, so { f: '.data' } would not work.

+

In case both shorthand and variableBindings have entries that would result in a value for the same variable, +variableBindings has priority.

+
+
+
+

Optional variableBindings

+
variableBindings?: VariableBindings
+

Values to apply to the Components.js variables. +These are the variables CLI values will be converted to. +The keys should be the variable URIs. +E.g.: { 'urn:solid-server:default:variable:rootFilePath': '.data' }.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/AsyncTransformOptions.html b/7.x/docs/interfaces/AsyncTransformOptions.html new file mode 100644 index 000000000..99b1fccde --- /dev/null +++ b/7.x/docs/interfaces/AsyncTransformOptions.html @@ -0,0 +1,426 @@ +AsyncTransformOptions | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface AsyncTransformOptions<T>

+
+

Type Parameters

+
    +
  • +

    T = unknown

+
+

Hierarchy

+
    +
  • DuplexOptions +
      +
    • AsyncTransformOptions
+
+
+
+ +
+
+

Properties

+
allowHalfOpen? +autoDestroy? +decodeStrings? +defaultEncoding? +emitClose? +encoding? +flush? +highWaterMark? +objectMode? +readableHighWaterMark? +readableObjectMode? +signal? +transform? +writableCorked? +writableHighWaterMark? +writableObjectMode? +
+
+

Methods

+
construct? +destroy? +final? +read? +write? +writev? +
+
+

Properties

+
+

Optional allowHalfOpen

+
allowHalfOpen?: boolean
+
+

Optional autoDestroy

+
autoDestroy?: boolean
+
+

Optional decodeStrings

+
decodeStrings?: boolean
+
+

Optional defaultEncoding

+
defaultEncoding?: BufferEncoding
+
+

Optional emitClose

+
emitClose?: boolean
+
+

Optional encoding

+
encoding?: BufferEncoding
+
+

Optional flush

+
flush?: ((this) => unknown)
+
+

Type declaration

+
    +
  • +
      +
    • (this): unknown
      • +
    • +

      Performs any final actions after the source has ended

      +
      +
      +

      Parameters

      +
        +
      • +
        this: Transform
      +

      Returns unknown

      +
+
+

Optional highWaterMark

+
highWaterMark?: number
+
+

Optional objectMode

+
objectMode?: boolean
+
+

Optional readableHighWaterMark

+
readableHighWaterMark?: number
+
+

Optional readableObjectMode

+
readableObjectMode?: boolean
+
+

Optional signal

+
signal?: AbortSignal
+

When provided the corresponding AbortController can be used to cancel an asynchronous action.

+
+
+
+

Optional transform

+
transform?: ((this, data, encoding) => unknown)
+
+

Type declaration

+
    +
  • +
      +
    • (this, data, encoding): unknown
      • +
    • +

      Transforms data from the source by calling the push method

      +
      +
      +

      Parameters

      +
        +
      • +
        this: Transform
        • +
      • +
        data: T
        • +
      • +
        encoding: string
      +

      Returns unknown

      +
+
+

Optional writableCorked

+
writableCorked?: number
+
+

Optional writableHighWaterMark

+
writableHighWaterMark?: number
+
+

Optional writableObjectMode

+
writableObjectMode?: boolean
+
+

Methods

+
+

Optional construct

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      this: Duplex
      • +
    • +
      callback: ((error?) => void)
      +
        +
      • +
          +
        • (error?): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Optional error: null | Error
          +

          Returns void

    +

    Returns void

+
+

Optional destroy

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      this: Duplex
      • +
    • +
      error: null | Error
      • +
    • +
      callback: ((error) => void)
      +
        +
      • +
          +
        • (error): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            error: null | Error
          +

          Returns void

    +

    Returns void

+
+

Optional final

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      this: Duplex
      • +
    • +
      callback: ((error?) => void)
      +
        +
      • +
          +
        • (error?): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Optional error: null | Error
          +

          Returns void

    +

    Returns void

+
+

Optional read

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      this: Duplex
      • +
    • +
      size: number
    +

    Returns void

+
+

Optional write

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      this: Duplex
      • +
    • +
      chunk: any
      • +
    • +
      encoding: BufferEncoding
      • +
    • +
      callback: ((error?) => void)
      +
        +
      • +
          +
        • (error?): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Optional error: null | Error
          +

          Returns void

    +

    Returns void

+
+

Optional writev

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      this: Duplex
      • +
    • +
      chunks: {
          chunk: any;
          encoding: BufferEncoding;
      }[]
      • +
    • +
      callback: ((error?) => void)
      +
        +
      • +
          +
        • (error?): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Optional error: null | Error
          +

          Returns void

    +

    Returns void

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/AtomicDataAccessor.html b/7.x/docs/interfaces/AtomicDataAccessor.html new file mode 100644 index 000000000..74f51ebce --- /dev/null +++ b/7.x/docs/interfaces/AtomicDataAccessor.html @@ -0,0 +1,347 @@ +AtomicDataAccessor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface AtomicDataAccessor

+
+

The AtomicDataAccessor interface has identical function signatures as +the DataAccessor, with the additional constraint that every function call +must be atomic in its effect: either the call fully succeeds, reaching the +desired new state; or it fails, upon which the resulting state remains +identical to the one before the call.

+
+
+
+

Hierarchy

+
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
canHandle +deleteResource +getChildren +getData +getMetadata +writeContainer +writeDocument +writeMetadata +
+
+

Properties

+
+

canHandle

+
canHandle: ((representation) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (representation): Promise<void>
      • +
    • +

      Should throw a NotImplementedHttpError if the DataAccessor does not support storing the given Representation.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<void>

      +
      +

      Throws

      BadRequestHttpError +If it does not support the incoming data.

      +
+
+

deleteResource

+
deleteResource: ((identifier) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): Promise<void>
      • +
    • +

      Deletes the resource and its corresponding metadata.

      +

      Solid, §5.4: "When a contained resource is deleted, the server MUST also remove the corresponding containment +triple, which has the effect of removing the deleted resource from the containing container." +https://solid.github.io/specification/protocol#deleting-resources

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<void>

      +
+
+

getChildren

+
getChildren: ((identifier) => AsyncIterableIterator<RepresentationMetadata>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): AsyncIterableIterator<RepresentationMetadata>
      • +
    • +

      Returns metadata for all resources in the requested container. +This should not be all metadata of those resources (but it can be), +but instead the main metadata you want to show in situations +where all these resources are presented simultaneously. +Generally this would be metadata that is present for all of these resources, +such as resource type or last modified date.

      +

      It can be safely assumed that the incoming identifier will always correspond to a container.

      +
      +
      +

      Parameters

      +
      +

      Returns AsyncIterableIterator<RepresentationMetadata>

      +
+
+

getData

+
getData: ((identifier) => Promise<Guarded<Readable>>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): Promise<Guarded<Readable>>
      • +
    • +

      Returns a data stream stored for the given identifier. +It can be assumed that the incoming identifier will always correspond to a document.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<Guarded<Readable>>

      +
+
+

getMetadata

+
getMetadata: ((identifier) => Promise<RepresentationMetadata>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): Promise<RepresentationMetadata>
      • +
    • +

      Returns the metadata corresponding to the identifier. +If possible, it is suggested to add a posix:size triple to the metadata indicating the binary size. +This is necessary for range requests.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<RepresentationMetadata>

      +
+
+

writeContainer

+
writeContainer: ((identifier, metadata) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier, metadata): Promise<void>
      • +
    • +

      Writes metadata for a container. +If the container does not exist yet it should be created, +if it does its metadata should be overwritten, except for the containment triples.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<void>

      +
+
+

writeDocument

+
writeDocument: ((identifier, data, metadata) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier, data, metadata): Promise<void>
      • +
    • +

      Writes data and metadata for a document. +If any data and/or metadata exist for the given identifier, it should be overwritten.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<void>

      +
+
+

writeMetadata

+
writeMetadata: ((identifier, metadata) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier, metadata): Promise<void>
      • +
    • +

      Writes metadata for a resource. +It can safely be assumed that the subject resource already exists.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<void>

      +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/AtomicResourceStore.html b/7.x/docs/interfaces/AtomicResourceStore.html new file mode 100644 index 000000000..bec9d61a1 --- /dev/null +++ b/7.x/docs/interfaces/AtomicResourceStore.html @@ -0,0 +1,303 @@ +AtomicResourceStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface AtomicResourceStore

+
+

A ResourceStore of which all operations are atomic.

+
+
+
+

Hierarchy

+
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
addResource +deleteResource +getRepresentation +hasResource +modifyResource +setRepresentation +
+
+

Properties

+
+

addResource

+
addResource: ((container, representation, conditions?) => Promise<ChangeMap>)
+
+

Type declaration

+
    +
  • +
      +
    • (container, representation, conditions?): Promise<ChangeMap>
      • +
    • +

      Creates a new resource in the container.

      +
      +
      +

      Parameters

      +
        +
      • +
        container: ResourceIdentifier
        +

        Container in which to create a resource.

        +
        +
        • +
      • +
        representation: Representation
        +

        Representation of the new resource

        +
        +
        • +
      • +
        Optional conditions: Conditions
        +

        Optional conditions under which to proceed.

        +
        +
      +

      Returns Promise<ChangeMap>

      A ChangeMap.

      + +
+
+

deleteResource

+
deleteResource: ((identifier, conditions?) => Promise<ChangeMap>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier, conditions?): Promise<ChangeMap>
      • +
    • +

      Deletes a resource.

      +
      +
      +

      Parameters

      +
        +
      • +
        identifier: ResourceIdentifier
        +

        Identifier of resource to delete.

        +
        +
        • +
      • +
        Optional conditions: Conditions
        +

        Optional conditions under which to proceed.

        +
        +
      +

      Returns Promise<ChangeMap>

      A ChangeMap.

      + +
+
+

getRepresentation

+
getRepresentation: ((identifier, preferences, conditions?) => Promise<Representation>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier, preferences, conditions?): Promise<Representation>
      • +
    • +

      Retrieves a representation of a resource.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<Representation>

      A representation corresponding to the identifier.

      + +
+
+

hasResource

+
hasResource: ((identifier) => Promise<boolean>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): Promise<boolean>
      • +
    • +

      Checks whether a resource exists in this ResourceSet.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<boolean>

      A promise resolving if the resource already exists.

      + +
+
+

modifyResource

+
modifyResource: ((identifier, patch, conditions?) => Promise<ChangeMap>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier, patch, conditions?): Promise<ChangeMap>
      • +
    • +

      Sets or updates the representation of a resource, +creating a new resource and intermediary containers as needed.

      +
      +
      +

      Parameters

      +
        +
      • +
        identifier: ResourceIdentifier
        +

        Identifier of resource to update.

        +
        +
        • +
      • +
        patch: Patch
        +

        Description of which parts to update.

        +
        +
        • +
      • +
        Optional conditions: Conditions
        +

        Optional conditions under which to proceed.

        +
        +
      +

      Returns Promise<ChangeMap>

      A ChangeMap.

      + +
+
+

setRepresentation

+
setRepresentation: ((identifier, representation, conditions?) => Promise<ChangeMap>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier, representation, conditions?): Promise<ChangeMap>
      • +
    • +

      Sets or replaces the representation of a resource, +creating a new resource and intermediary containers as needed.

      +
      +
      +

      Parameters

      +
        +
      • +
        identifier: ResourceIdentifier
        +

        Identifier of resource to update.

        +
        +
        • +
      • +
        representation: Representation
        +

        New representation of the resource.

        +
        +
        • +
      • +
        Optional conditions: Conditions
        +

        Optional conditions under which to proceed.

        +
        +
      +

      Returns Promise<ChangeMap>

      A ChangeMap.

      + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/AuthorizerInput.html b/7.x/docs/interfaces/AuthorizerInput.html new file mode 100644 index 000000000..2664816ef --- /dev/null +++ b/7.x/docs/interfaces/AuthorizerInput.html @@ -0,0 +1,108 @@ +AuthorizerInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface AuthorizerInput

+
+

Hierarchy

+
    +
  • AuthorizerInput
+
+
+
+ +
+
+

Properties

+
availablePermissions +credentials +requestedModes +
+
+

Properties

+
+

availablePermissions

+
availablePermissions: PermissionMap
+

Actual permissions available per resource and per credential group.

+
+
+
+

credentials

+
credentials: Credentials
+

Credentials of the entity that wants to use the resource.

+
+
+
+

requestedModes

+
requestedModes: AccessMap
+

Requested access modes per resource.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/AuthorizingHttpHandlerArgs.html b/7.x/docs/interfaces/AuthorizingHttpHandlerArgs.html new file mode 100644 index 000000000..be7ffb3d6 --- /dev/null +++ b/7.x/docs/interfaces/AuthorizingHttpHandlerArgs.html @@ -0,0 +1,128 @@ +AuthorizingHttpHandlerArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface AuthorizingHttpHandlerArgs

+
+

Hierarchy

+
    +
  • AuthorizingHttpHandlerArgs
+
+
+
+ +
+
+

Properties

+
authorizer +credentialsExtractor +modesExtractor +operationHandler +permissionReader +
+
+

Properties

+
+

authorizer

+
authorizer: Authorizer
+

Verifies if the requested operation is allowed.

+
+
+
+

credentialsExtractor

+
credentialsExtractor: CredentialsExtractor
+

Extracts the credentials from the incoming request.

+
+
+
+

modesExtractor

+
modesExtractor: ModesExtractor
+

Extracts the required modes from the generated Operation.

+
+
+
+

operationHandler

+
operationHandler: OperationHttpHandler
+

Handler to call if the operation is authorized.

+
+
+
+

permissionReader

+
permissionReader: PermissionReader
+

Reads the permissions available for the Operation.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/AuxiliaryIdentifierStrategy.html b/7.x/docs/interfaces/AuxiliaryIdentifierStrategy.html new file mode 100644 index 000000000..141076ad7 --- /dev/null +++ b/7.x/docs/interfaces/AuxiliaryIdentifierStrategy.html @@ -0,0 +1,204 @@ +AuxiliaryIdentifierStrategy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface AuxiliaryIdentifierStrategy

+
+

A strategy for handling auxiliary related ResourceIdentifiers.

+
+
+
+

Hierarchy

+
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
getAuxiliaryIdentifier +getAuxiliaryIdentifiers +getSubjectIdentifier +isAuxiliaryIdentifier +
+
+

Properties

+
+

getAuxiliaryIdentifier

+
getAuxiliaryIdentifier: ((identifier) => ResourceIdentifier)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): ResourceIdentifier
      • +
    • +

      Returns the identifier of the auxiliary resource corresponding to the given resource. +This does not guarantee that this auxiliary resource exists.

      +

      Should error if there are multiple results: see getAuxiliaryIdentifiers.

      +
      +
      +

      Parameters

      +
        +
      • +
        identifier: ResourceIdentifier
        +

        The ResourceIdentifier of which we need the corresponding auxiliary resource.

        +
        +
      +

      Returns ResourceIdentifier

      The ResourceIdentifier of the corresponding auxiliary resource.

      + +
+
+

getAuxiliaryIdentifiers

+
getAuxiliaryIdentifiers: ((identifier) => ResourceIdentifier[])
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): ResourceIdentifier[]
      • +
    • +

      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

      +
        +
      • +
        identifier: ResourceIdentifier
        +

        The ResourceIdentifier of which we need the corresponding auxiliary resources.

        +
        +
      +

      Returns ResourceIdentifier[]

      The ResourceIdentifiers of the corresponding auxiliary resources.

      + +
+
+

getSubjectIdentifier

+
getSubjectIdentifier: ((identifier) => ResourceIdentifier)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): ResourceIdentifier
      • +
    • +

      Returns the identifier of the resource which this auxiliary resource is referring to. +This does not guarantee that this resource exists.

      +
      +
      +

      Parameters

      +
      +

      Returns ResourceIdentifier

      The ResourceIdentifier of the subject resource.

      + +
+
+

isAuxiliaryIdentifier

+
isAuxiliaryIdentifier: ((identifier) => boolean)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): boolean
      • +
    • +

      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

      +
      +

      Returns boolean

      true if the input identifier points to an auxiliary resource.

      + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/AuxiliaryStrategy.html b/7.x/docs/interfaces/AuxiliaryStrategy.html new file mode 100644 index 000000000..92776a4e3 --- /dev/null +++ b/7.x/docs/interfaces/AuxiliaryStrategy.html @@ -0,0 +1,324 @@ +AuxiliaryStrategy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface AuxiliaryStrategy

+
+

A strategy for handling one or more types of auxiliary resources. +References to "an auxiliary resource" implicitly imply a specific type of auxiliary resources +supported by this strategy.

+
+
+
+

Hierarchy

+
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
addMetadata +getAuxiliaryIdentifier +getAuxiliaryIdentifiers +getSubjectIdentifier +isAuxiliaryIdentifier +isRequiredInRoot +usesOwnAuthorization +validate +
+
+

Properties

+
+

addMetadata

+
addMetadata: ((metadata) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (metadata): Promise<void>
      • +
    • +

      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 subject 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 subject identifier.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<void>

      +
+
+

getAuxiliaryIdentifier

+
getAuxiliaryIdentifier: ((identifier) => ResourceIdentifier)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): ResourceIdentifier
      • +
    • +

      Returns the identifier of the auxiliary resource corresponding to the given resource. +This does not guarantee that this auxiliary resource exists.

      +

      Should error if there are multiple results: see getAuxiliaryIdentifiers.

      +
      +
      +

      Parameters

      +
        +
      • +
        identifier: ResourceIdentifier
        +

        The ResourceIdentifier of which we need the corresponding auxiliary resource.

        +
        +
      +

      Returns ResourceIdentifier

      The ResourceIdentifier of the corresponding auxiliary resource.

      + +
+
+

getAuxiliaryIdentifiers

+
getAuxiliaryIdentifiers: ((identifier) => ResourceIdentifier[])
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): ResourceIdentifier[]
      • +
    • +

      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

      +
        +
      • +
        identifier: ResourceIdentifier
        +

        The ResourceIdentifier of which we need the corresponding auxiliary resources.

        +
        +
      +

      Returns ResourceIdentifier[]

      The ResourceIdentifiers of the corresponding auxiliary resources.

      + +
+
+

getSubjectIdentifier

+
getSubjectIdentifier: ((identifier) => ResourceIdentifier)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): ResourceIdentifier
      • +
    • +

      Returns the identifier of the resource which this auxiliary resource is referring to. +This does not guarantee that this resource exists.

      +
      +
      +

      Parameters

      +
      +

      Returns ResourceIdentifier

      The ResourceIdentifier of the subject resource.

      + +
+
+

isAuxiliaryIdentifier

+
isAuxiliaryIdentifier: ((identifier) => boolean)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): boolean
      • +
    • +

      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

      +
      +

      Returns boolean

      true if the input identifier points to an auxiliary resource.

      + +
+
+

isRequiredInRoot

+
isRequiredInRoot: ((identifier) => boolean)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): boolean
      • +
    • +

      Whether the root storage container requires this auxiliary resource to be present. +If yes, this means they can't be deleted individually from such a container.

      +
      +
      +

      Parameters

      +
      +

      Returns boolean

      +
+
+

usesOwnAuthorization

+
usesOwnAuthorization: ((identifier) => boolean)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): boolean
      • +
    • +

      Whether this auxiliary resources uses its own authorization instead of the subject resource authorization.

      +
      +
      +

      Parameters

      +
      +

      Returns boolean

      +
+
+

validate

+
validate: ((representation) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (representation): Promise<void>
      • +
    • +

      Validates if the representation contains valid data for an auxiliary resource. +Should throw an error in case the data is invalid.

      +
      +
      +

      Parameters

      +
        +
      • +
        representation: Representation
        +

        Representation of the auxiliary resource.

        +
        +
      +

      Returns Promise<void>

      +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/BasePodCreatorArgs.html b/7.x/docs/interfaces/BasePodCreatorArgs.html new file mode 100644 index 000000000..c37a69b1e --- /dev/null +++ b/7.x/docs/interfaces/BasePodCreatorArgs.html @@ -0,0 +1,130 @@ +BasePodCreatorArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface BasePodCreatorArgs

+
+

Hierarchy

+
    +
  • BasePodCreatorArgs
+
+
+
+ +
+
+

Properties

+
baseUrl +identifierGenerator +podStore +relativeWebIdPath +webIdStore +
+
+

Properties

+
+

baseUrl

+
baseUrl: string
+

Base URL of the server. +Used to potentially set the solid:oidcIssuer triple +and/or the pod URL if it is a root pod.

+
+
+
+

identifierGenerator

+
identifierGenerator: IdentifierGenerator
+

Generates the base URL of the pod based on the input name.

+
+
+
+

podStore

+
podStore: PodStore
+

Pod data store.

+
+
+
+

relativeWebIdPath

+
relativeWebIdPath: string
+

The path of where the WebID will be generated by the template, relative to the pod URL.

+
+
+
+

webIdStore

+
webIdStore: WebIdStore
+

WebID data store.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/BaseRouterHandlerArgs.html b/7.x/docs/interfaces/BaseRouterHandlerArgs.html new file mode 100644 index 000000000..e34c2467d --- /dev/null +++ b/7.x/docs/interfaces/BaseRouterHandlerArgs.html @@ -0,0 +1,130 @@ +BaseRouterHandlerArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface BaseRouterHandlerArgs<T>

+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
allowedMethods? +allowedPathNames? +baseUrl? +handler +
+
+

Properties

+
+

Optional allowedMethods

+
allowedMethods?: string[]
+

The allowed method(s). * can be used to indicate all methods are allowed. +Default is [ '*' ].

+
+
+
+

Optional allowedPathNames

+
allowedPathNames?: string[]
+

Regular expression(s) used to match the target URL. +The base URl without trailing slash will be stripped of before applying the regular expressions, +so the input will always start with a /. +Default is [ '.*' ].

+
+
+
+

Optional baseUrl

+
baseUrl?: string
+

The base URL of the server. +Not required if no value is provided for allowedPathNames.

+
+
+
+

handler

+
handler: T
+

The handler to call if all checks pass.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/BaseServerFactoryOptions.html b/7.x/docs/interfaces/BaseServerFactoryOptions.html new file mode 100644 index 000000000..48dfe60f8 --- /dev/null +++ b/7.x/docs/interfaces/BaseServerFactoryOptions.html @@ -0,0 +1,123 @@ +BaseServerFactoryOptions | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface BaseServerFactoryOptions

+
+

Options to be used when creating the server. +Due to Components.js not supporting external types, this has been simplified (for now?). +The common https keys here (key/cert/pfx) will be interpreted as file paths that need to be read +before passing the options to the createServer function.

+
+
+
+

Hierarchy

+
    +
  • BaseServerFactoryOptions
+
+
+
+ +
+
+

Properties

+
cert? +https? +key? +passphrase? +pfx? +
+
+

Properties

+
+

Optional cert

+
cert?: string
+
+

Optional https

+
https?: boolean
+

If the server should start as an HTTP or HTTPS server.

+
+
+
+

Optional key

+
key?: string
+
+

Optional passphrase

+
passphrase?: string
+
+

Optional pfx

+
pfx?: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/BasicConditionsOptions.html b/7.x/docs/interfaces/BasicConditionsOptions.html new file mode 100644 index 000000000..f056e8b58 --- /dev/null +++ b/7.x/docs/interfaces/BasicConditionsOptions.html @@ -0,0 +1,106 @@ +BasicConditionsOptions | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface BasicConditionsOptions

+
+

Hierarchy

+
    +
  • BasicConditionsOptions
+
+
+
+ +
+
+

Properties

+
matchesETag? +modifiedSince? +notMatchesETag? +unmodifiedSince? +
+
+

Properties

+
+

Optional matchesETag

+
matchesETag?: string[]
+
+

Optional modifiedSince

+
modifiedSince?: Date
+
+

Optional notMatchesETag

+
notMatchesETag?: string[]
+
+

Optional unmodifiedSince

+
unmodifiedSince?: Date
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/BasicRequestParserArgs.html b/7.x/docs/interfaces/BasicRequestParserArgs.html new file mode 100644 index 000000000..410a74c74 --- /dev/null +++ b/7.x/docs/interfaces/BasicRequestParserArgs.html @@ -0,0 +1,117 @@ +BasicRequestParserArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface BasicRequestParserArgs

+
+

Input parsers required for a BasicRequestParser.

+
+
+
+

Hierarchy

+
    +
  • BasicRequestParserArgs
+
+
+
+ +
+
+

Properties

+
bodyParser +conditionsParser +metadataParser +preferenceParser +targetExtractor +
+
+

Properties

+
+

bodyParser

+
bodyParser: BodyParser
+
+

conditionsParser

+
conditionsParser: ConditionsParser
+
+

metadataParser

+
metadataParser: MetadataParser
+
+

preferenceParser

+
preferenceParser: PreferenceParser
+
+

targetExtractor

+
targetExtractor: TargetExtractor
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/BodyParserArgs.html b/7.x/docs/interfaces/BodyParserArgs.html new file mode 100644 index 000000000..1efcabbd8 --- /dev/null +++ b/7.x/docs/interfaces/BodyParserArgs.html @@ -0,0 +1,99 @@ +BodyParserArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface BodyParserArgs

+
+

Hierarchy

+
    +
  • BodyParserArgs
+
+
+
+ +
+
+

Properties

+
metadata +request +
+
+

Properties

+
+

metadata

+
metadata: RepresentationMetadata
+

Metadata that has already been parsed from the request. +Can be updated by the BodyParser with extra metadata.

+
+
+
+

request

+
request: HttpRequest
+

Request that contains the (potential) body.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/CliOptions.html b/7.x/docs/interfaces/CliOptions.html new file mode 100644 index 000000000..8f6df8857 --- /dev/null +++ b/7.x/docs/interfaces/CliOptions.html @@ -0,0 +1,106 @@ +CliOptions | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface CliOptions

+
+

Hierarchy

+
    +
  • CliOptions
+
+
+
+ +
+
+

Properties

+
envVarPrefix? +loadFromEnv? +strictMode? +usage? +
+
+

Properties

+
+

Optional envVarPrefix

+
envVarPrefix?: string
+
+

Optional loadFromEnv

+
loadFromEnv?: boolean
+
+

Optional strictMode

+
strictMode?: boolean
+
+

Optional usage

+
usage?: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ClientCredentials.html b/7.x/docs/interfaces/ClientCredentials.html new file mode 100644 index 000000000..fa5d40ab4 --- /dev/null +++ b/7.x/docs/interfaces/ClientCredentials.html @@ -0,0 +1,113 @@ +ClientCredentials | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ClientCredentials

+
+

Hierarchy

+
    +
  • ClientCredentials
+
+
+
+ +
+
+

Properties

+
accountId +id +label +secret +webId +
+
+

Properties

+
+

accountId

+
accountId: string
+
+

id

+
id: string
+
+

label

+
label: string
+
+

secret

+
secret: string
+
+

webId

+
webId: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ClientCredentialsStore.html b/7.x/docs/interfaces/ClientCredentialsStore.html new file mode 100644 index 000000000..2b6c0ca26 --- /dev/null +++ b/7.x/docs/interfaces/ClientCredentialsStore.html @@ -0,0 +1,223 @@ +ClientCredentialsStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ClientCredentialsStore

+
+

Stores and creates ClientCredentials.

+
+
+
+

Hierarchy

+
    +
  • ClientCredentialsStore
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
create +delete +findByAccount +findByLabel +get +
+
+

Properties

+
+

create

+
create: ((label, webId, accountId) => Promise<ClientCredentials>)
+
+

Type declaration

+
    +
  • +
      +
    • (label, webId, accountId): Promise<ClientCredentials>
      • +
    • +

      Creates new token.

      +
      +
      +

      Parameters

      +
        +
      • +
        label: string
        +

        Identifier to use for the new token.

        +
        +
        • +
      • +
        webId: string
        +

        WebID to identify as when using this token.

        +
        +
        • +
      • +
        accountId: string
      +

      Returns Promise<ClientCredentials>

      +
+
+

delete

+
delete: ((id) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (id): Promise<void>
      • +
    • +

      Deletes the token with the given ID.

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +

        ID of the token.

        +
        +
      +

      Returns Promise<void>

      +
+
+

findByAccount

+
findByAccount: ((accountId) => Promise<ClientCredentials[]>)
+
+

Type declaration

+
    +
  • +
      +
    • (accountId): Promise<ClientCredentials[]>
      • +
    • +

      Find all tokens created by the given account.

      +
      +
      +

      Parameters

      +
        +
      • +
        accountId: string
        +

        ID of the account.

        +
        +
      +

      Returns Promise<ClientCredentials[]>

      +
+
+

findByLabel

+
findByLabel: ((label) => Promise<undefined | ClientCredentials>)
+
+

Type declaration

+
+
+

get

+
get: ((id) => Promise<undefined | ClientCredentials>)
+
+

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ComponentsJsFactory.html b/7.x/docs/interfaces/ComponentsJsFactory.html new file mode 100644 index 000000000..5d7ba6367 --- /dev/null +++ b/7.x/docs/interfaces/ComponentsJsFactory.html @@ -0,0 +1,128 @@ +ComponentsJsFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ComponentsJsFactory

+
+

Used for instantiating new object using Components.js configurations.

+
+
+
+

Hierarchy

+
    +
  • ComponentsJsFactory
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
generate +
+
+

Properties

+
+

generate

+
generate: (<T>(configPath, componentIri, variables) => Promise<T>)
+
+

Type declaration

+
    +
  • +
      +
    • <T>(configPath, componentIri, variables): Promise<T>
      • +
    • +

      Instantiates a new object using Components.js.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        T

      +
      +

      Parameters

      +
        +
      • +
        configPath: string
        +

        Location of the config to instantiate.

        +
        +
        • +
      • +
        componentIri: string
        +

        IRI of the object in the config that will be the result.

        +
        +
        • +
      • +
        variables: Record<string, unknown>
        +

        Variables to send to Components.js

        +
        +
      +

      Returns Promise<T>

      The resulting object, corresponding to the given component IRI.

      + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ComposedNotificationHandlerArgs.html b/7.x/docs/interfaces/ComposedNotificationHandlerArgs.html new file mode 100644 index 000000000..1a0d3b541 --- /dev/null +++ b/7.x/docs/interfaces/ComposedNotificationHandlerArgs.html @@ -0,0 +1,106 @@ +ComposedNotificationHandlerArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ComposedNotificationHandlerArgs

+
+

Hierarchy

+
    +
  • ComposedNotificationHandlerArgs
+
+
+
+ +
+
+

Properties

+
eTagHandler +emitter +generator +serializer +
+
+

Properties

+
+

eTagHandler

+
eTagHandler: ETagHandler
+
+

emitter

+
emitter: NotificationEmitter
+
+

generator

+
generator: NotificationGenerator
+
+

serializer

+
serializer: NotificationSerializer
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/Conditions.html b/7.x/docs/interfaces/Conditions.html new file mode 100644 index 000000000..3ca612df3 --- /dev/null +++ b/7.x/docs/interfaces/Conditions.html @@ -0,0 +1,159 @@ +Conditions | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface Conditions

+
+

The conditions of an HTTP conditional request.

+
+
+
+

Hierarchy

+
    +
  • Conditions
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
matchesETag? +matchesMetadata +modifiedSince? +notMatchesETag? +unmodifiedSince? +
+
+

Properties

+
+

Optional matchesETag

+
matchesETag?: string[]
+

Valid if matching any of the given ETags.

+
+
+
+

matchesMetadata

+
matchesMetadata: ((metadata?, strict?) => boolean)
+
+

Type declaration

+
    +
  • +
      +
    • (metadata?, strict?): boolean
      • +
    • +

      Checks validity based on the given metadata.

      +
      +
      +

      Parameters

      +
        +
      • +
        Optional metadata: RepresentationMetadata
        +

        Metadata of the representation. Undefined if the resource does not exist.

        +
        +
        • +
      • +
        Optional strict: boolean
        +

        How to compare the ETag related headers. + If true, the comparison will happen on representation level. + If false, the comparison happens on resource level, ignoring the content-type.

        +
        +
      +

      Returns boolean

      +
+
+

Optional modifiedSince

+
modifiedSince?: Date
+

Valid if modified since the given date.

+
+
+
+

Optional notMatchesETag

+
notMatchesETag?: string[]
+

Valid if not matching any of the given ETags.

+
+
+
+

Optional unmodifiedSince

+
unmodifiedSince?: Date
+

Valid if not modified since the given date.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ConstantConverterOptions.html b/7.x/docs/interfaces/ConstantConverterOptions.html new file mode 100644 index 000000000..0fe28c8e6 --- /dev/null +++ b/7.x/docs/interfaces/ConstantConverterOptions.html @@ -0,0 +1,132 @@ +ConstantConverterOptions | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ConstantConverterOptions

+
+

Extra options for the ConstantConverter.

+
+
+
+

Hierarchy

+
    +
  • ConstantConverterOptions
+
+
+
+ +
+
+

Properties

+
container? +disabledMediaRanges? +document? +enabledMediaRanges? +minQuality? +
+
+

Properties

+
+

Optional container

+
container?: boolean
+

Whether this should trigger on containers.

+
+
+
+

Optional disabledMediaRanges

+
disabledMediaRanges?: string[]
+

Media ranges for which the conversion should not happen.

+
+
+
+

Optional document

+
document?: boolean
+

Whether this should trigger on documents.

+
+
+
+

Optional enabledMediaRanges

+
enabledMediaRanges?: string[]
+

Media ranges for which the conversion should happen.

+
+
+
+

Optional minQuality

+
minQuality?: number
+

The minimum requested quality/preference before this should trigger.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ContainerInitializerArgs.html b/7.x/docs/interfaces/ContainerInitializerArgs.html new file mode 100644 index 000000000..a56269448 --- /dev/null +++ b/7.x/docs/interfaces/ContainerInitializerArgs.html @@ -0,0 +1,138 @@ +ContainerInitializerArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ContainerInitializerArgs

+
+

Hierarchy

+
    +
  • ContainerInitializerArgs
+
+
+
+ +
+
+

Properties

+
baseUrl +generator +path +storage +storageKey +store +
+
+

Properties

+
+

baseUrl

+
baseUrl: string
+

Base URL of the server.

+
+
+
+

generator

+
generator: ResourcesGenerator
+

Generator that should be used to generate container contents.

+
+
+
+

path

+
path: string
+

Relative path of the container.

+
+
+
+

storage

+
storage: KeyValueStorage<string, boolean>
+

Used to store initialization status.

+
+
+
+

storageKey

+
storageKey: string
+

Key that is used to store the boolean in the storage indicating the container is initialized.

+
+
+
+

store

+
store: ResourceStore
+

ResourceStore where the container should be stored.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ConvertingStoreEntry.html b/7.x/docs/interfaces/ConvertingStoreEntry.html new file mode 100644 index 000000000..68719e43e --- /dev/null +++ b/7.x/docs/interfaces/ConvertingStoreEntry.html @@ -0,0 +1,92 @@ +ConvertingStoreEntry | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ConvertingStoreEntry

+
+

Hierarchy

+
    +
  • ConvertingStoreEntry
+
+
+
+ +
+
+

Properties

+
store +supportChecker +
+
+

Properties

+
+

store

+
store: ResourceStore
+
+

supportChecker

+
supportChecker: PreferenceSupport
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/CookieStore.html b/7.x/docs/interfaces/CookieStore.html new file mode 100644 index 000000000..2eb86b9b9 --- /dev/null +++ b/7.x/docs/interfaces/CookieStore.html @@ -0,0 +1,192 @@ +CookieStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface CookieStore

+
+

Used to generate and store cookies.

+
+
+
+

Hierarchy

+
    +
  • CookieStore
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
delete +generate +get +refresh +
+
+

Properties

+
+

delete

+
delete: ((cookie) => Promise<boolean>)
+
+

Type declaration

+
    +
  • +
      +
    • (cookie): Promise<boolean>
      • +
    • +

      Deletes the given cookie.

      +
      +
      +

      Parameters

      +
        +
      • +
        cookie: string
        +

        Cookie to delete.

        +
        +
      +

      Returns Promise<boolean>

      +
+
+

generate

+
generate: ((accountId) => Promise<string>)
+
+

Type declaration

+
    +
  • +
      +
    • (accountId): Promise<string>
      • +
    • +

      Generates and stores a new cookie for the given accountId. +This does not replace previously generated cookies.

      +
      +
      +

      Parameters

      +
        +
      • +
        accountId: string
        +

        Account to create a cookie for.

        +
        +
      +

      Returns Promise<string>

      The generated cookie.

      + +
+
+

get

+
get: ((cookie) => Promise<undefined | string>)
+
+

Type declaration

+
    +
  • +
      +
    • (cookie): Promise<undefined | string>
      • +
    • +

      Return the accountID associated with the given cookie.

      +
      +
      +

      Parameters

      +
        +
      • +
        cookie: string
        +

        Cookie to find the account for.

        +
        +
      +

      Returns Promise<undefined | string>

      +
+
+

refresh

+
refresh: ((cookie) => Promise<undefined | Date>)
+
+

Type declaration

+
    +
  • +
      +
    • (cookie): Promise<undefined | Date>
      • +
    • +

      Refreshes the cookie expiration and returns when it will expire if the cookie exists.

      +
      +
      +

      Parameters

      +
        +
      • +
        cookie: string
        +

        Cookie to refresh.

        +
        +
      +

      Returns Promise<undefined | Date>

      +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/DataAccessor.html b/7.x/docs/interfaces/DataAccessor.html new file mode 100644 index 000000000..1378e8274 --- /dev/null +++ b/7.x/docs/interfaces/DataAccessor.html @@ -0,0 +1,346 @@ +DataAccessor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface DataAccessor

+
+

A DataAccessor is the building block closest to the actual data storage. +It should not worry about most Solid logic, most of that will be handled before it is called. +There are a few things it still needs to do, and it is very important every implementation does this:

+
    +
  • If the input identifier ends with a slash, it should be assumed the identifier is targeting a container.
    • +
  • Similarly, if there is no trailing slash it should assume a document.
    • +
  • It should always throw a NotFoundHttpError if it does not have data matching the input identifier.
    • +
  • DataAccessors should not generate containment triples. This will be done externally using getChildren.
    • +
+
+
+
+

Hierarchy

+
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
canHandle +deleteResource +getChildren +getData +getMetadata +writeContainer +writeDocument +writeMetadata +
+
+

Properties

+
+

canHandle

+
canHandle: ((representation) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (representation): Promise<void>
      • +
    • +

      Should throw a NotImplementedHttpError if the DataAccessor does not support storing the given Representation.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<void>

      +
      +

      Throws

      BadRequestHttpError +If it does not support the incoming data.

      +
+
+

deleteResource

+
deleteResource: ((identifier) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): Promise<void>
      • +
    • +

      Deletes the resource and its corresponding metadata.

      +

      Solid, §5.4: "When a contained resource is deleted, the server MUST also remove the corresponding containment +triple, which has the effect of removing the deleted resource from the containing container." +https://solid.github.io/specification/protocol#deleting-resources

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<void>

      +
+
+

getChildren

+
getChildren: ((identifier) => AsyncIterableIterator<RepresentationMetadata>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): AsyncIterableIterator<RepresentationMetadata>
      • +
    • +

      Returns metadata for all resources in the requested container. +This should not be all metadata of those resources (but it can be), +but instead the main metadata you want to show in situations +where all these resources are presented simultaneously. +Generally this would be metadata that is present for all of these resources, +such as resource type or last modified date.

      +

      It can be safely assumed that the incoming identifier will always correspond to a container.

      +
      +
      +

      Parameters

      +
      +

      Returns AsyncIterableIterator<RepresentationMetadata>

      +
+
+

getData

+
getData: ((identifier) => Promise<Guarded<Readable>>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): Promise<Guarded<Readable>>
      • +
    • +

      Returns a data stream stored for the given identifier. +It can be assumed that the incoming identifier will always correspond to a document.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<Guarded<Readable>>

      +
+
+

getMetadata

+
getMetadata: ((identifier) => Promise<RepresentationMetadata>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): Promise<RepresentationMetadata>
      • +
    • +

      Returns the metadata corresponding to the identifier. +If possible, it is suggested to add a posix:size triple to the metadata indicating the binary size. +This is necessary for range requests.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<RepresentationMetadata>

      +
+
+

writeContainer

+
writeContainer: ((identifier, metadata) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier, metadata): Promise<void>
      • +
    • +

      Writes metadata for a container. +If the container does not exist yet it should be created, +if it does its metadata should be overwritten, except for the containment triples.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<void>

      +
+
+

writeDocument

+
writeDocument: ((identifier, data, metadata) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier, data, metadata): Promise<void>
      • +
    • +

      Writes data and metadata for a document. +If any data and/or metadata exist for the given identifier, it should be overwritten.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<void>

      +
+
+

writeMetadata

+
writeMetadata: ((identifier, metadata) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier, metadata): Promise<void>
      • +
    • +

      Writes metadata for a resource. +It can safely be assumed that the subject resource already exists.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<void>

      +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ETagHandler.html b/7.x/docs/interfaces/ETagHandler.html new file mode 100644 index 000000000..c9d4b731f --- /dev/null +++ b/7.x/docs/interfaces/ETagHandler.html @@ -0,0 +1,183 @@ +ETagHandler | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ETagHandler

+
+

Responsible for everything related to ETag generation and comparison. +ETags are constructed in such a way they can both be used for the standard ETag usage of comparing representations, +but also to see if two ETags of different representations correspond to the same resource state.

+
+
+
+

Hierarchy

+
    +
  • ETagHandler
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
getETag +matchesETag +sameResourceState +
+
+

Properties

+
+

getETag

+
getETag: ((metadata) => undefined | string)
+
+

Type declaration

+
    +
  • +
      +
    • (metadata): undefined | string
      • +
    • +

      Generates an ETag for the given metadata. Returns undefined if no ETag could be generated.

      +
      +
      +

      Parameters

      +
      +

      Returns undefined | string

      +
+
+

matchesETag

+
matchesETag: ((metadata, eTag, strict) => boolean)
+
+

Type declaration

+
    +
  • +
      +
    • (metadata, eTag, strict): boolean
      • +
    • +

      Validates whether the given metadata corresponds to the given ETag.

      +
      +
      +

      Parameters

      +
        +
      • +
        metadata: RepresentationMetadata
        +

        Metadata of the resource.

        +
        +
        • +
      • +
        eTag: string
        +

        ETag to compare to.

        +
        +
        • +
      • +
        strict: boolean
        +

        True if the comparison needs to be on representation level. + False if it is on resource level and the content-type doesn't matter.

        +
        +
      +

      Returns boolean

      +
+
+

sameResourceState

+
sameResourceState: ((eTag1, eTag2) => boolean)
+
+

Type declaration

+
    +
  • +
      +
    • (eTag1, eTag2): boolean
      • +
    • +

      Validates whether 2 ETags correspond to the same state of a resource, +independent of the representation the ETags correspond to.

      +
      +
      +

      Parameters

      +
        +
      • +
        eTag1: string
        +

        First ETag to compare.

        +
        +
        • +
      • +
        eTag2: string
        +

        Second ETag to compare.

        +
        +
      +

      Returns boolean

      +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/EmailArgs.html b/7.x/docs/interfaces/EmailArgs.html new file mode 100644 index 000000000..1b96d2e8c --- /dev/null +++ b/7.x/docs/interfaces/EmailArgs.html @@ -0,0 +1,106 @@ +EmailArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface EmailArgs

+
+

Hierarchy

+
    +
  • EmailArgs
+
+
+
+ +
+
+

Properties

+
html +recipient +subject +text +
+
+

Properties

+
+

html

+
html: string
+
+

recipient

+
recipient: string
+
+

subject

+
subject: string
+
+

text

+
text: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/EmailSenderArgs.html b/7.x/docs/interfaces/EmailSenderArgs.html new file mode 100644 index 000000000..11f849e44 --- /dev/null +++ b/7.x/docs/interfaces/EmailSenderArgs.html @@ -0,0 +1,106 @@ +EmailSenderArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface EmailSenderArgs

+
+

Hierarchy

+
    +
  • EmailSenderArgs
+
+
+
+ +
+
+

Properties

+
emailConfig +senderName? +
+
+

Properties

+
+

emailConfig

+
emailConfig: {
    auth: {
        pass: string;
        user: string;
    };
    host: string;
    port: number;
}
+
+

Type declaration

+
    +
  • +
    auth: {
        pass: string;
        user: string;
    }
    +
      +
    • +
      pass: string
      • +
    • +
      user: string
    • +
  • +
    host: string
    • +
  • +
    port: number
+
+

Optional senderName

+
senderName?: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ErrorHandlerArgs.html b/7.x/docs/interfaces/ErrorHandlerArgs.html new file mode 100644 index 000000000..a54998b30 --- /dev/null +++ b/7.x/docs/interfaces/ErrorHandlerArgs.html @@ -0,0 +1,92 @@ +ErrorHandlerArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ErrorHandlerArgs

+
+

Hierarchy

+
    +
  • ErrorHandlerArgs
+
+
+
+ +
+
+

Properties

+
error +request +
+
+

Properties

+
+

error

+
error: HttpError<number>
+
+

request

+
request: HttpRequest
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ExpiringReadWriteLocker.html b/7.x/docs/interfaces/ExpiringReadWriteLocker.html new file mode 100644 index 000000000..0b86c6466 --- /dev/null +++ b/7.x/docs/interfaces/ExpiringReadWriteLocker.html @@ -0,0 +1,203 @@ +ExpiringReadWriteLocker | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ExpiringReadWriteLocker

+
+

A ReadWriteLocker where the locks expire after a given time.

+
+
+
+

Hierarchy

+
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
withReadLock +withWriteLock +
+
+

Properties

+
+

withReadLock

+
withReadLock: (<T>(identifier, whileLocked) => Promise<T>)
+
+

Type declaration

+
    +
  • +
      +
    • <T>(identifier, whileLocked): Promise<T>
      • +
    • +

      As ReadWriteLocker.withReadLock but the locked function gets called with a maintainLock callback function +to reset the lock expiration every time it is called. +The resulting promise will reject once the lock expires.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        T

      +
      +

      Parameters

      +
        +
      • +
        identifier: ResourceIdentifier
        +

        Identifier of the resource that needs to be locked.

        +
        +
        • +
      • +
        whileLocked: ((maintainLock) => PromiseOrValue<T>)
        +

        A function to execute while the resource is locked. +Receives a callback as input parameter to maintain the lock.

        +
        +
        +
          +
        • +
            +
          • (maintainLock): PromiseOrValue<T>
            • +
          • +
            +

            Parameters

            +
              +
            • +
              maintainLock: (() => void)
              +
                +
              • +
                  +
                • (): void
                  • +
                • +

                  Returns void

            +

            Returns PromiseOrValue<T>

      +

      Returns Promise<T>

      +
+
+

withWriteLock

+
withWriteLock: (<T>(identifier, whileLocked) => Promise<T>)
+
+

Type declaration

+
    +
  • +
      +
    • <T>(identifier, whileLocked): Promise<T>
      • +
    • +

      As ReadWriteLocker.withWriteLock but the locked function gets called with a maintainLock +callback function to reset the lock expiration every time it is called. +The resulting promise will reject once the lock expires.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        T

      +
      +

      Parameters

      +
        +
      • +
        identifier: ResourceIdentifier
        +

        Identifier of the resource that needs to be locked.

        +
        +
        • +
      • +
        whileLocked: ((maintainLock) => PromiseOrValue<T>)
        +

        A function to execute while the resource is locked. +Receives a callback as input parameter to maintain the lock.

        +
        +
        +
          +
        • +
            +
          • (maintainLock): PromiseOrValue<T>
            • +
          • +
            +

            Parameters

            +
              +
            • +
              maintainLock: (() => void)
              +
                +
              • +
                  +
                • (): void
                  • +
                • +

                  Returns void

            +

            Returns PromiseOrValue<T>

      +

      Returns Promise<T>

      +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ExpiringStorage.html b/7.x/docs/interfaces/ExpiringStorage.html new file mode 100644 index 000000000..d8539ea36 --- /dev/null +++ b/7.x/docs/interfaces/ExpiringStorage.html @@ -0,0 +1,260 @@ +ExpiringStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ExpiringStorage<TKey, TValue>

+
+

A KeyValueStorage in which the values can expire. +Entries with no expiration date never expire.

+
+
+
+

Type Parameters

+
    +
  • +

    TKey

    • +
  • +

    TValue

+
+

Hierarchy

+
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
delete +entries +get +has +
+
+

Methods

+
set +
+
+

Properties

+
+

delete

+
delete: ((key) => Promise<boolean>)
+
+

Type declaration

+
    +
  • +
      +
    • (key): Promise<boolean>
      • +
    • +

      Deletes the value stored for the given key.

      +
      +
      +

      Parameters

      +
        +
      • +
        key: TKey
        +

        Key to delete.

        +
        +
      +

      Returns Promise<boolean>

      If there was a value to delete.

      + +
+
+

entries

+
entries: (() => AsyncIterableIterator<[TKey, TValue]>)
+
+

Type declaration

+
    +
  • +
      +
    • (): AsyncIterableIterator<[TKey, TValue]>
      • +
    • +

      An iterable of entries in the storage.

      +
      +

      Returns AsyncIterableIterator<[TKey, TValue]>

      +
+
+

get

+
get: ((key) => Promise<undefined | TValue>)
+
+

Type declaration

+
    +
  • +
      +
    • (key): Promise<undefined | TValue>
      • +
    • +

      Returns the value stored for the given identifier. +undefined if no value is stored.

      +
      +
      +

      Parameters

      +
        +
      • +
        key: TKey
      +

      Returns Promise<undefined | TValue>

      +
+
+

has

+
has: ((key) => Promise<boolean>)
+
+

Type declaration

+
    +
  • +
      +
    • (key): Promise<boolean>
      • +
    • +

      Checks whether there is a value stored for the given key.

      +
      +
      +

      Parameters

      +
        +
      • +
        key: TKey
      +

      Returns Promise<boolean>

      +
+
+

Methods

+
+

set

+
    + +
  • +

    Sets the value for the given key. +Should error if the data is already expired.

    +
    +
    +

    Parameters

    +
      +
    • +
      key: TKey
      +

      Key to set/update.

      +
      +
      • +
    • +
      value: TValue
      +

      Value to store.

      +
      +
      • +
    • +
      Optional expiration: number
      +

      How long this data should stay valid in milliseconds.

      +
      +
    +

    Returns Promise<ExpiringStorage<TKey, TValue>>

    The storage.

    + +
    • + +
  • +

    Sets the value for the given key. +Should error if the data is already expired.

    +
    +
    +

    Parameters

    +
      +
    • +
      key: TKey
      +

      Key to set/update.

      +
      +
      • +
    • +
      value: TValue
      +

      Value to store.

      +
      +
      • +
    • +
      Optional expires: Date
      +

      When this value expires. Never if undefined.

      +
      +
    +

    Returns Promise<ExpiringStorage<TKey, TValue>>

    The storage.

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/FileIdentifierMapper.html b/7.x/docs/interfaces/FileIdentifierMapper.html new file mode 100644 index 000000000..eaf243b44 --- /dev/null +++ b/7.x/docs/interfaces/FileIdentifierMapper.html @@ -0,0 +1,158 @@ +FileIdentifierMapper | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface FileIdentifierMapper

+
+

Supports mapping a file to an URL and back.

+
+
+
+

Hierarchy

+
    +
  • FileIdentifierMapper
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
mapFilePathToUrl +mapUrlToFilePath +
+
+

Properties

+
+

mapFilePathToUrl

+
mapFilePathToUrl: ((filePath, isContainer) => Promise<ResourceLink>)
+
+

Type declaration

+
    +
  • +
      +
    • (filePath, isContainer): Promise<ResourceLink>
      • +
    • +

      Maps the given file path to an URL and determines the content-type

      +
      +
      +

      Parameters

      +
        +
      • +
        filePath: string
        +

        The input file path.

        +
        +
        • +
      • +
        isContainer: boolean
        +

        If the path corresponds to a file.

        +
        +
      +

      Returns Promise<ResourceLink>

      A ResourceLink with all the necessary metadata.

      + +
+
+

mapUrlToFilePath

+
mapUrlToFilePath: ((identifier, isMetadata, contentType?) => Promise<ResourceLink>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier, isMetadata, contentType?): Promise<ResourceLink>
      • +
    • +

      Maps the given resource identifier / URL to a file path. +Determines the content-type, if no content-type was provided, by finding the corresponding file. +If there is no corresponding file, a file path will be generated. +For containers, the content-type input gets ignored.

      +
      +
      +

      Parameters

      +
        +
      • +
        identifier: ResourceIdentifier
        +

        The input identifier.

        +
        +
        • +
      • +
        isMetadata: boolean
        +

        If we are mapping the metadata of the resource instead of its data.

        +
        +
        • +
      • +
        Optional contentType: string
        +

        The (optional) content-type of the resource.

        +
        +
      +

      Returns Promise<ResourceLink>

      A ResourceLink with all the necessary metadata.

      + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/FileIdentifierMapperFactory.html b/7.x/docs/interfaces/FileIdentifierMapperFactory.html new file mode 100644 index 000000000..ecf43d625 --- /dev/null +++ b/7.x/docs/interfaces/FileIdentifierMapperFactory.html @@ -0,0 +1,114 @@ +FileIdentifierMapperFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface FileIdentifierMapperFactory<T>

+
+

Factory that can create FileIdentifierMappers so the base and rootFilePath can be set dynamically. +Specifically used when identifiers need to be generated for a new pod (since pod identifiers are generated).

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
    +
  • FileIdentifierMapperFactory
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
create +
+
+

Properties

+
+

create

+
create: ((base, rootFilePath) => Promise<T>)
+
+

Type declaration

+
    +
  • +
      +
    • (base, rootFilePath): Promise<T>
      • +
    • +
      +

      Parameters

      +
        +
      • +
        base: string
        • +
      • +
        rootFilePath: string
      +

      Returns Promise<T>

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/Finalizable.html b/7.x/docs/interfaces/Finalizable.html new file mode 100644 index 000000000..61b3b00f4 --- /dev/null +++ b/7.x/docs/interfaces/Finalizable.html @@ -0,0 +1,105 @@ +Finalizable | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface Finalizable

+
+

Allows for cleaning up an object and stopping relevant loops when the application needs to be stopped. +Use this interface to add finalization logic to classes that already extend some other type. +NOTE: classes without an existing extends-relation should extend from Finalizer instead!

+
+
+
+

Hierarchy

+
    +
  • Finalizable
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
finalize +
+
+

Properties

+
+

finalize

+
finalize: (() => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (): Promise<void>
      • +
    • +

      Returns Promise<void>

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ForgotPasswordHandlerArgs.html b/7.x/docs/interfaces/ForgotPasswordHandlerArgs.html new file mode 100644 index 000000000..e680a8ac6 --- /dev/null +++ b/7.x/docs/interfaces/ForgotPasswordHandlerArgs.html @@ -0,0 +1,133 @@ +ForgotPasswordHandlerArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ForgotPasswordHandlerArgs

+
+

Hierarchy

+
    +
  • ForgotPasswordHandlerArgs
+
+
+
+ +
+
+

Properties

+
emailSender +forgotPasswordStore +passwordStore +resetRoute +templateEngine +
+
+

Properties

+
+

emailSender

+
emailSender: EmailSender
+

Sender to send the actual email.

+
+
+
+

forgotPasswordStore

+
forgotPasswordStore: ForgotPasswordStore
+

Store containing the forgot password records.

+
+
+
+

passwordStore

+
passwordStore: PasswordStore
+

Store containing the password login information.

+
+
+
+

resetRoute

+
resetRoute: InteractionRoute<never>
+

Route used to generate the reset link for the user.

+
+
+
+

templateEngine

+
templateEngine: TemplateEngine<{
    resetLink: string;
}>
+

Template engine that will be used to generate the email body.

+
+
+

Type declaration

+
    +
  • +
    resetLink: string
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ForgotPasswordStore.html b/7.x/docs/interfaces/ForgotPasswordStore.html new file mode 100644 index 000000000..8ced25c7c --- /dev/null +++ b/7.x/docs/interfaces/ForgotPasswordStore.html @@ -0,0 +1,169 @@ +ForgotPasswordStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ForgotPasswordStore

+
+

Responsible for storing the records that are used when a user forgets their password.

+
+
+
+

Hierarchy

+
    +
  • ForgotPasswordStore
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
delete +generate +get +
+
+

Properties

+
+

delete

+
delete: ((recordId) => Promise<boolean>)
+
+

Type declaration

+
    +
  • +
      +
    • (recordId): Promise<boolean>
      • +
    • +

      Deletes the Forgot Password Confirmation Record.

      +
      +
      +

      Parameters

      +
        +
      • +
        recordId: string
        +

        The record id of the forgot password confirmation record.

        +
        +
      +

      Returns Promise<boolean>

      +
+
+

generate

+
generate: ((id) => Promise<string>)
+
+

Type declaration

+
    +
  • +
      +
    • (id): Promise<string>
      • +
    • +

      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.

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +

        ID of the email/password login object.

        +
        +
      +

      Returns Promise<string>

      The record id. This should be included in the reset password link.

      + +
+
+

get

+
get: ((recordId) => Promise<undefined | string>)
+
+

Type declaration

+
    +
  • +
      +
    • (recordId): Promise<undefined | string>
      • +
    • +

      Gets the email associated with the forgot password confirmation record +or undefined if it's not present.

      +
      +
      +

      Parameters

      +
        +
      • +
        recordId: string
        +

        The record id retrieved from the link.

        +
        +
      +

      Returns Promise<undefined | string>

      The user's email.

      + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/Forwarded.html b/7.x/docs/interfaces/Forwarded.html new file mode 100644 index 000000000..38564804a --- /dev/null +++ b/7.x/docs/interfaces/Forwarded.html @@ -0,0 +1,122 @@ +Forwarded | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface Forwarded

+
+

The Forwarded header from RFC7239

+
+
+
+

Hierarchy

+
    +
  • Forwarded
+
+
+
+ +
+
+

Properties

+
by? +for? +host? +proto? +
+
+

Properties

+
+

Optional by

+
by?: string
+

The user-agent facing interface of the proxy

+
+
+
+

Optional for

+
for?: string
+

The node making the request to the proxy

+
+
+
+

Optional host

+
host?: string
+

The host request header field as received by the proxy

+
+
+
+

Optional proto

+
proto?: string
+

The protocol used to make the request

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/GenericEventEmitter.html b/7.x/docs/interfaces/GenericEventEmitter.html new file mode 100644 index 000000000..28d9b961d --- /dev/null +++ b/7.x/docs/interfaces/GenericEventEmitter.html @@ -0,0 +1,446 @@ +GenericEventEmitter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface GenericEventEmitter<TEvent, TFunc>

+
+

A typed interface of EventEmitter.

+

Use the & operator to combine multiple event/function pairs into a single event emitter. +The result needs to be a type and not an interface because of https://github.com/microsoft/TypeScript/issues/16936.

+

Use the createGenericEventEmitterClass function to generate an event emitter class with the correct typings +in case EventEmitter needs to be extended.

+
+
+
+

Type Parameters

+
    +
  • +

    TEvent extends string | symbol

    • +
  • +

    TFunc extends ((...args) => void)

+
+

Hierarchy

+
    +
  • EventEmitter +
      +
    • GenericEventEmitter
+
+
+
+ +
+
+

Properties

+
addListener +emit +eventNames +listenerCount +listeners +off +on +once +prependListener +prependOnceListener +rawListeners +removeAllListeners +removeListener +
+
+

Methods

+
[captureRejectionSymbol]? +getMaxListeners +setMaxListeners +
+
+

Properties

+
+

addListener

+
addListener: ((event, listener) => GenericEventEmitter<TEvent, TFunc>)
+
+

Type declaration

+
+
+

emit

+
emit: ((event, ...args) => boolean)
+
+

Type declaration

+
    +
  • +
      +
    • (event, ...args): boolean
      • +
    • +
      +

      Parameters

      +
        +
      • +
        event: TEvent
        • +
      • +
        Rest ...args: Parameters<TFunc>
      +

      Returns boolean

+
+

eventNames

+
eventNames: (() => TEvent[])
+
+

Type declaration

+
    +
  • +
      +
    • (): TEvent[]
      • +
    • +

      Returns TEvent[]

+
+

listenerCount

+
listenerCount: ((event) => number)
+
+

Type declaration

+
    +
  • +
      +
    • (event): number
      • +
    • +
      +

      Parameters

      +
        +
      • +
        event: TEvent
      +

      Returns number

+
+

listeners

+
listeners: ((event) => TFunc[])
+
+

Type declaration

+
    +
  • +
      +
    • (event): TFunc[]
      • +
    • +
      +

      Parameters

      +
        +
      • +
        event: TEvent
      +

      Returns TFunc[]

+
+

off

+
off: ((event, listener) => GenericEventEmitter<TEvent, TFunc>)
+
+

Type declaration

+
+
+

on

+
on: ((event, listener) => GenericEventEmitter<TEvent, TFunc>)
+
+

Type declaration

+
+
+

once

+
once: ((event, listener) => GenericEventEmitter<TEvent, TFunc>)
+
+

Type declaration

+
+
+

prependListener

+
prependListener: ((event, listener) => GenericEventEmitter<TEvent, TFunc>)
+
+

Type declaration

+
+
+

prependOnceListener

+
prependOnceListener: ((event, listener) => GenericEventEmitter<TEvent, TFunc>)
+
+

Type declaration

+
+
+

rawListeners

+
rawListeners: ((event) => TFunc[])
+
+

Type declaration

+
    +
  • +
      +
    • (event): TFunc[]
      • +
    • +
      +

      Parameters

      +
        +
      • +
        event: TEvent
      +

      Returns TFunc[]

+
+

removeAllListeners

+
removeAllListeners: ((event) => GenericEventEmitter<TEvent, TFunc>)
+
+

Type declaration

+
+
+

removeListener

+
removeListener: ((event, listener) => GenericEventEmitter<TEvent, TFunc>)
+
+

Type declaration

+
+
+

Methods

+
+

Optional [captureRejectionSymbol]

+
    +
  • [captureRejectionSymbol](error, event, ...args): void
    • +
  • +
    +

    Parameters

    +
      +
    • +
      error: Error
      • +
    • +
      event: string
      • +
    • +
      Rest ...args: any[]
    +

    Returns void

+
+

getMaxListeners

+
    + +
  • +

    Returns the current max listener value for the EventEmitter which is either +set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    +
    +

    Returns number

    +
    +

    Since

    v1.0.0

    +
+
+

setMaxListeners

+
    + +
  • +

    By default EventEmitters will print a warning if more than 10 listeners are +added for a particular event. This is a useful default that helps finding +memory leaks. The emitter.setMaxListeners() method allows the limit to be +modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    +

    Returns a reference to the EventEmitter, so that calls can be chained.

    +
    +
    +

    Parameters

    +
      +
    • +
      n: number
    +

    Returns GenericEventEmitter<TEvent, TFunc>

    +
    +

    Since

    v0.3.5

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/HttpErrorClass.html b/7.x/docs/interfaces/HttpErrorClass.html new file mode 100644 index 000000000..7839aab49 --- /dev/null +++ b/7.x/docs/interfaces/HttpErrorClass.html @@ -0,0 +1,153 @@ +HttpErrorClass | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface HttpErrorClass<TCode>

+
+

Interface describing what an HttpError class should look like. +This helps us make sure all HttpError classes have the same utility static functions.

+
+
+
+

Type Parameters

+
    +
  • +

    TCode extends number = number

+
+

Hierarchy

+
    +
  • HttpErrorClass
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
isInstance +statusCode +uri +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly isInstance

+
isInstance: ((error) => error is HttpError<TCode>)
+
+

Type declaration

+
    +
  • +
      +
    • (error): error is HttpError<TCode>
      • +
    • +

      Checks whether the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: unknown
      +

      Returns error is HttpError<TCode>

      +
+
+

Readonly statusCode

+
statusCode: TCode
+

The status code corresponding to this error class.

+
+
+
+

Readonly uri

+
uri: NamedNode<string>
+

A unique URI identifying this error class.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/HttpErrorOptions.html b/7.x/docs/interfaces/HttpErrorOptions.html new file mode 100644 index 000000000..952348c53 --- /dev/null +++ b/7.x/docs/interfaces/HttpErrorOptions.html @@ -0,0 +1,103 @@ +HttpErrorOptions | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface HttpErrorOptions

+
+

Hierarchy

+
    +
  • HttpErrorOptions
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
cause? +errorCode? +metadata? +
+
+

Properties

+
+

Optional cause

+
cause?: unknown
+
+

Optional errorCode

+
errorCode?: string
+
+

Optional metadata

+
metadata?: RepresentationMetadata
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/HttpHandlerInput.html b/7.x/docs/interfaces/HttpHandlerInput.html new file mode 100644 index 000000000..9f4f3e948 --- /dev/null +++ b/7.x/docs/interfaces/HttpHandlerInput.html @@ -0,0 +1,94 @@ +HttpHandlerInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface HttpHandlerInput

+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
request +response +
+
+

Properties

+
+

request

+
request: HttpRequest
+
+

response

+
response: HttpResponse
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/HttpServerFactory.html b/7.x/docs/interfaces/HttpServerFactory.html new file mode 100644 index 000000000..3d2ddd551 --- /dev/null +++ b/7.x/docs/interfaces/HttpServerFactory.html @@ -0,0 +1,101 @@ +HttpServerFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface HttpServerFactory

+
+

A factory for HTTP servers.

+
+
+
+

Hierarchy

+
    +
  • HttpServerFactory
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
createServer +
+
+

Properties

+
+

createServer

+
createServer: (() => Promise<Server<typeof IncomingMessage, typeof ServerResponse>>)
+
+

Type declaration

+
    +
  • +
      +
    • (): Promise<Server<typeof IncomingMessage, typeof ServerResponse>>
      • +
    • +

      Returns Promise<Server<typeof IncomingMessage, typeof ServerResponse>>

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/IdentifierGenerator.html b/7.x/docs/interfaces/IdentifierGenerator.html new file mode 100644 index 000000000..f076c934f --- /dev/null +++ b/7.x/docs/interfaces/IdentifierGenerator.html @@ -0,0 +1,135 @@ +IdentifierGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface IdentifierGenerator

+
+

Utility class for generating container identifiers.

+
+
+
+

Hierarchy

+
    +
  • IdentifierGenerator
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
extractPod +generate +
+
+

Properties

+
+

extractPod

+
extractPod: ((identifier) => ResourceIdentifier)
+
+

Type declaration

+
+
+

generate

+
generate: ((name) => ResourceIdentifier)
+
+

Type declaration

+
    +
  • +
      +
    • (name): ResourceIdentifier
      • +
    • +

      Generates container identifiers based on an input name. +This is simply string generation, no resource-related checks are run.

      +
      +
      +

      Parameters

      +
        +
      • +
        name: string
      +

      Returns ResourceIdentifier

      +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/IdentifierStrategy.html b/7.x/docs/interfaces/IdentifierStrategy.html new file mode 100644 index 000000000..166b85727 --- /dev/null +++ b/7.x/docs/interfaces/IdentifierStrategy.html @@ -0,0 +1,191 @@ +IdentifierStrategy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface IdentifierStrategy

+
+

Captures the behavior of container identifiers in a certain storage configuration.

+
+
+
+

Hierarchy

+
    +
  • IdentifierStrategy
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
contains +getParentContainer +isRootContainer +supportsIdentifier +
+
+

Properties

+
+

contains

+
contains: ((container, identifier, transitive) => boolean)
+
+

Type declaration

+
    +
  • +
      +
    • (container, identifier, transitive): boolean
      • +
    • +

      Checks if the given container would contain the given identifier. +This does not check that either of these identifiers actually exist. +This is similar to calling getParentContainer on an identifier +and comparing the result.

      +

      If transitive is false this only checks if container is the direct parent container of identifier.

      +
      +
      +

      Parameters

      +
      +

      Returns boolean

      +
+
+

getParentContainer

+
getParentContainer: ((identifier) => ResourceIdentifier)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): ResourceIdentifier
      • +
    • +

      Generates the identifier of the container this resource would be a member of. +This does not check if that identifier actually exists. +Will throw an error if the input identifier is a root container or is not supported.

      +
      +
      +

      Parameters

      +
      +

      Returns ResourceIdentifier

      +
+
+

isRootContainer

+
isRootContainer: ((identifier) => boolean)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): boolean
      • +
    • +

      Checks if the input corresponds to the identifier of a root container. +This does not check if this identifier actually exists.

      +
      +
      +

      Parameters

      +
      +

      Returns boolean

      +
+
+

supportsIdentifier

+
supportsIdentifier: ((identifier) => boolean)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): boolean
      • +
    • +

      Verifies if this identifier is supported. +This does not check if this identifier actually exists, +but checks if the identifier is in scope for this class.

      +
      +
      +

      Parameters

      +
      +

      Returns boolean

      +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/IdentityProviderFactoryArgs.html b/7.x/docs/interfaces/IdentityProviderFactoryArgs.html new file mode 100644 index 000000000..7b226a492 --- /dev/null +++ b/7.x/docs/interfaces/IdentityProviderFactoryArgs.html @@ -0,0 +1,188 @@ +IdentityProviderFactoryArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface IdentityProviderFactoryArgs

+
+

Hierarchy

+
    +
  • IdentityProviderFactoryArgs
+
+
+
+ +
+
+

Properties

+
adapterFactory +baseUrl +clientCredentialsStore +errorHandler +interactionRoute +jwkGenerator +oidcPath +promptFactory +responseWriter +showStackTrace +storage +
+
+

Properties

+
+

adapterFactory

+
adapterFactory: AdapterFactory
+

Factory that creates the adapter used for OIDC data storage.

+
+
+
+

baseUrl

+
baseUrl: string
+

Base URL of the server.

+
+
+
+

clientCredentialsStore

+
clientCredentialsStore: ClientCredentialsStore
+

Store containing the generated client credentials with their associated WebID.

+
+
+
+

errorHandler

+
errorHandler: ErrorHandler
+

Used to convert errors thrown by the OIDC library.

+
+
+
+

interactionRoute

+
interactionRoute: InteractionRoute<never>
+

The route where requests should be redirected to in case of an OIDC interaction.

+
+
+
+

jwkGenerator

+
jwkGenerator: JwkGenerator
+

Generates the JWK used for signing and decryption.

+
+
+
+

oidcPath

+
oidcPath: string
+

Path for all requests targeting the OIDC library.

+
+
+
+

promptFactory

+
promptFactory: PromptFactory
+

Used to generate new prompt that are needed in addition to the defaults prompts.

+
+
+
+

responseWriter

+
responseWriter: ResponseWriter
+

Used to write out errors thrown by the OIDC library.

+
+
+
+

showStackTrace

+
showStackTrace: boolean
+

Extra information will be added to the error output if this is true.

+
+
+
+

storage

+
storage: KeyValueStorage<string, string[]>
+

Storage used to store cookie keys, so they can be re-used in case of multithreading.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/IdentityProviderHttpHandlerArgs.html b/7.x/docs/interfaces/IdentityProviderHttpHandlerArgs.html new file mode 100644 index 000000000..abb5d2913 --- /dev/null +++ b/7.x/docs/interfaces/IdentityProviderHttpHandlerArgs.html @@ -0,0 +1,108 @@ +IdentityProviderHttpHandlerArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface IdentityProviderHttpHandlerArgs

+
+

Hierarchy

+
    +
  • IdentityProviderHttpHandlerArgs
+
+
+
+ +
+
+

Properties

+
cookieStore +handler +providerFactory +
+
+

Properties

+
+

cookieStore

+
cookieStore: CookieStore
+

Used to determine the account of the requesting agent.

+
+
+
+

handler

+
handler: InteractionHandler
+

Handles the requests.

+
+
+
+

providerFactory

+
providerFactory: ProviderFactory
+

Used to generate the OIDC provider.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/IndexedStorage.html b/7.x/docs/interfaces/IndexedStorage.html new file mode 100644 index 000000000..24886a2a1 --- /dev/null +++ b/7.x/docs/interfaces/IndexedStorage.html @@ -0,0 +1,507 @@ +IndexedStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface IndexedStorage<T>

+
+

A storage solution that allows for more complex queries than a key/value storage +and allows setting indexes on specific keys.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
    +
  • IndexedStorage
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
create +createIndex +defineType +delete +entries +find +findIds +get +has +set +setField +
+
+

Properties

+
+

create

+
create: (<TType>(type, value) => Promise<TypeObject<T[TType]>>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, value): Promise<TypeObject<T[TType]>>
      • +
    • +

      Creates an object of the given type. +The storage will generate an identifier for the newly created object.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type to create.

        +
        +
        • +
      • +
        value: CreateTypeObject<T[TType]>
        +

        The value to set for the created object.

        +
        +
      +

      Returns Promise<TypeObject<T[TType]>>

      A representation of the newly created object, including its new identifier.

      + +
+
+

createIndex

+
createIndex: (<TType>(type, key) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, key): Promise<void>
      • +
    • +

      Creates an index on a key of the given type, to allow for better queries involving those keys. +Similar to IndexedStorage.defineType these calls need to happen first.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type to create an index on.

        +
        +
        • +
      • +
        key: StringKey<T[TType]>
        +

        The key of that type to create an index on.

        +
        +
      +

      Returns Promise<void>

      +
+
+

defineType

+
defineType: (<TType>(type, description) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, description): Promise<void>
      • +
    • +

      Informs the storage of the definition of a specific type. +A definition is a key/value object with the values being a valid ValueTypeDescription. +Generally, this call needs to happen for every type of this storage, +and before any calls are made to interact with the data.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type to define.

        +
        +
        • +
      • +
        description: T[TType]
        +

        A description of the values stored in objects of that type.

        +
        +
      +

      Returns Promise<void>

      +
+
+

delete

+
delete: (<TType>(type, id) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, id): Promise<void>
      • +
    • +

      Deletes the given object. +This will also delete all objects that reference that object if the corresponding key is not optional.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type of the object to delete.

        +
        +
        • +
      • +
        id: string
        +

        The identifier of the object.

        +
        +
      +

      Returns Promise<void>

      +
+
+

entries

+
entries: (<TType>(type) => AsyncIterableIterator<TypeObject<T[TType]>>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type): AsyncIterableIterator<TypeObject<T[TType]>>
      • +
    • +

      Returns an iterator over all objects of the given type.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type to iterate over.

        +
        +
      +

      Returns AsyncIterableIterator<TypeObject<T[TType]>>

      +
+
+

find

+
find: (<TType>(type, query) => Promise<TypeObject<T[TType]>[]>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, query): Promise<TypeObject<T[TType]>[]>
      • +
    • +

      Finds all objects matching a specific IndexedQuery.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type of objects to find.

        +
        +
        • +
      • +
        query: {
            [K in string | number | symbol]?: ValueType<T[TType][K]> | (T[TType][K] extends `id:${U}`
                ? ({ [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<...> | ... 1 more ... | undefined; } : never) | undefined; } : never) | undefined; })
                : never)
        }
        +

        The query to execute.

        +
        +
      +

      Returns Promise<TypeObject<T[TType]>[]>

      A list of objects matching the query.

      + +
+
+

findIds

+
findIds: (<TType>(type, query) => Promise<string[]>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, query): Promise<string[]>
      • +
    • +

      Similar to IndexedStorage.find, but only returns the identifiers of the found objects.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type of objects to find.

        +
        +
        • +
      • +
        query: {
            [K in string | number | symbol]?: ValueType<T[TType][K]> | (T[TType][K] extends `id:${U}`
                ? ({ [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<...> | ... 1 more ... | undefined; } : never) | undefined; } : never) | undefined; })
                : never)
        }
        +

        The query to execute.

        +
        +
      +

      Returns Promise<string[]>

      A list of identifiers of the matching objects.

      + +
+
+

get

+
get: (<TType>(type, id) => Promise<undefined | TypeObject<T[TType]>>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, id): Promise<undefined | TypeObject<T[TType]>>
      • +
    • +

      Returns the object of the given type with the given identifier.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type of object to get.

        +
        +
        • +
      • +
        id: string
        +

        The identifier of that object.

        +
        +
      +

      Returns Promise<undefined | TypeObject<T[TType]>>

      A representation of the object, or undefined if there is no object of that type with that identifier.

      + +
+
+

has

+
has: (<TType>(type, id) => Promise<boolean>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, id): Promise<boolean>
      • +
    • +

      Returns true if the object of the given type with the given identifier exists.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type of object to get.

        +
        +
        • +
      • +
        id: string
        +

        The identifier of that object.

        +
        +
      +

      Returns Promise<boolean>

      Whether this object exists.

      + +
+
+

set

+
set: (<TType>(type, value) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, value): Promise<void>
      • +
    • +

      Sets the value of a specific object. +The identifier in the object is used to identify the object.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type of the object to set.

        +
        +
        • +
      • +
        value: TypeObject<T[TType]>
        +

        The new value for the object.

        +
        +
      +

      Returns Promise<void>

      +
+
+

setField

+
setField: (<TType, TKey>(type, id, key, value) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType, TKey>(type, id, key, value): Promise<void>
      • +
    • +

      Sets the value of one specific field in an object.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

        • +
      • +

        TKey extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type of the object to update.

        +
        +
        • +
      • +
        id: string
        +

        The identifier of the object to update.

        +
        +
        • +
      • +
        key: TKey
        +

        The key to update.

        +
        +
        • +
      • +
        value: ValueType<T[TType][TKey]>
        +

        The new value for the given key.

        +
        +
      +

      Returns Promise<void>

      +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/Initializable.html b/7.x/docs/interfaces/Initializable.html new file mode 100644 index 000000000..1c0ecd37f --- /dev/null +++ b/7.x/docs/interfaces/Initializable.html @@ -0,0 +1,104 @@ +Initializable | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface Initializable

+
+

Allows for initializing state or executing logic when the application is started. +Use this interface to add initialization logic to classes that already extend some other type. +NOTE: classes without an existing extends-relation should extend from Initializer instead!

+
+
+
+

Hierarchy

+
    +
  • Initializable
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
initialize +
+
+

Properties

+
+

initialize

+
initialize: (() => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (): Promise<void>
      • +
    • +

      Returns Promise<void>

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/InteractionHandlerInput.html b/7.x/docs/interfaces/InteractionHandlerInput.html new file mode 100644 index 000000000..8365ea41d --- /dev/null +++ b/7.x/docs/interfaces/InteractionHandlerInput.html @@ -0,0 +1,109 @@ +InteractionHandlerInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface InteractionHandlerInput

+
+

Hierarchy

+
    +
  • InteractionHandlerInput
+
+
+
+ +
+
+

Properties

+
accountId? +oidcInteraction? +operation +
+
+

Properties

+
+

Optional accountId

+
accountId?: string
+

The account id of the agent doing the request if one could be found.

+
+
+
+

Optional oidcInteraction

+
oidcInteraction?: Interaction
+

Will be defined if the OIDC library expects us to resolve an interaction it can't handle itself, +such as logging a user in.

+
+
+
+

operation

+
operation: Operation
+

The operation to execute.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/InteractionRoute.html b/7.x/docs/interfaces/InteractionRoute.html new file mode 100644 index 000000000..f70f32453 --- /dev/null +++ b/7.x/docs/interfaces/InteractionRoute.html @@ -0,0 +1,150 @@ +InteractionRoute | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface InteractionRoute<T>

+
+

Routes are used to handle the pathing for API calls.

+

They can have dynamic values in the paths they support. +Typings are used to indicate the keys used to indicate what the corresponding values are.

+
+
+
+

Type Parameters

+
    +
  • +

    T extends string = never

+
+

Hierarchy

+
    +
  • InteractionRoute
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
getPath +matchPath +
+
+

Properties

+
+

getPath

+
getPath: ((parameters?) => string)
+
+

Type declaration

+
    +
  • +
      +
    • (parameters?): string
      • +
    • +

      Returns the path that is the result of having the specified values for the dynamic parameters.

      +

      Will throw an error in case the input parameters object is missing one of the expected keys.

      +
      +
      +

      Parameters

      +
        +
      • +
        Optional parameters: Record<T, string>
        +

        Values for the dynamic parameters.

        +
        +
      +

      Returns string

      +
+
+

matchPath

+
matchPath: ((path) => undefined | Record<T, string>)
+
+

Type declaration

+
    +
  • +
      +
    • (path): undefined | Record<T, string>
      • +
    • +

      Checks if the provided path matches the route (pattern).

      +

      The result will be undefined if there is no match.

      +

      If there is a match the result object will have the corresponding values for all the parameters.

      +
      +
      +

      Parameters

      +
        +
      • +
        path: string
        +

        The path to verify.

        +
        +
      +

      Returns undefined | Record<T, string>

      +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/JsonInteractionHandlerInput.html b/7.x/docs/interfaces/JsonInteractionHandlerInput.html new file mode 100644 index 000000000..3225f9e71 --- /dev/null +++ b/7.x/docs/interfaces/JsonInteractionHandlerInput.html @@ -0,0 +1,139 @@ +JsonInteractionHandlerInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface JsonInteractionHandlerInput

+
+

Hierarchy

+
    +
  • JsonInteractionHandlerInput
+
+
+
+ +
+
+

Properties

+
accountId? +json +metadata +method +oidcInteraction? +target +
+
+

Properties

+
+

Optional accountId

+
accountId?: string
+

The account id of the agent doing the request if one could be found.

+
+
+
+

json

+
json: unknown
+

The JSON body of the request.

+
+
+
+

metadata

+
metadata: RepresentationMetadata
+

The metadata of the request.

+
+
+
+

method

+
method: string
+

The operation to execute.

+
+
+
+

Optional oidcInteraction

+
oidcInteraction?: Interaction
+

Will be defined if the OIDC library expects us to resolve an interaction it can't handle itself, +such as logging a user in.

+
+
+
+

target

+
target: ResourceIdentifier
+

The resource that is being targeted.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/JsonRepresentation.html b/7.x/docs/interfaces/JsonRepresentation.html new file mode 100644 index 000000000..d0489eacb --- /dev/null +++ b/7.x/docs/interfaces/JsonRepresentation.html @@ -0,0 +1,103 @@ +JsonRepresentation | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface JsonRepresentation<T>

+
+

Contains a JSON object and any associated metadata. +Similar to a Representation but with all the data in memory instead of as a stream +and specific to JSON.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
    +
  • JsonRepresentation
+
+
+
+ +
+
+

Properties

+
json +metadata? +
+
+

Properties

+
+

json

+
json: T
+
+

Optional metadata

+
metadata?: RepresentationMetadata
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/JsonView.html b/7.x/docs/interfaces/JsonView.html new file mode 100644 index 000000000..a3ce1695a --- /dev/null +++ b/7.x/docs/interfaces/JsonView.html @@ -0,0 +1,117 @@ +JsonView | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface JsonView

+
+

An interface that can be used by classes that can provide a view besides doing an action. +Designed to be used by a JsonInteractionHandler that has a view explaining what JSON input it supports.

+
+
+
+

Hierarchy

+
    +
  • JsonView
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
getView +
+
+

Properties

+
+

getView

+
getView: ((input) => Promise<JsonRepresentation<Dict<Json>>>)
+
+

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/JwkGenerator.html b/7.x/docs/interfaces/JwkGenerator.html new file mode 100644 index 000000000..0036451bb --- /dev/null +++ b/7.x/docs/interfaces/JwkGenerator.html @@ -0,0 +1,131 @@ +JwkGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface JwkGenerator

+
+

Generates an asymmetric JWK.

+

The functions always need to return the same value.

+
+
+
+

Hierarchy

+
    +
  • JwkGenerator
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
alg +getPrivateKey +getPublicKey +
+
+

Properties

+
+

Readonly alg

+
alg: AsymmetricSigningAlgorithm
+

The algorithm used for the keys.

+
+
+
+

getPrivateKey

+
getPrivateKey: (() => Promise<AlgJwk>)
+
+

Type declaration

+
    +
  • +
      +
    • (): Promise<AlgJwk>
      • +
    • +

      Returns Promise<AlgJwk>

      The private key of the asymmetric JWK.

      + +
+
+

getPublicKey

+
getPublicKey: (() => Promise<AlgJwk>)
+
+

Type declaration

+
    +
  • +
      +
    • (): Promise<AlgJwk>
      • +
    • +

      Returns Promise<AlgJwk>

      The public key of the asymmetric JWK.

      + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/KeyValueStorage.html b/7.x/docs/interfaces/KeyValueStorage.html new file mode 100644 index 000000000..69b6fe591 --- /dev/null +++ b/7.x/docs/interfaces/KeyValueStorage.html @@ -0,0 +1,224 @@ +KeyValueStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface KeyValueStorage<TKey, TValue>

+
+

A simple storage solution that can be used for internal values that need to be stored. +To prevent potential issues, keys should be urlencoded before calling the storage.

+
+
+
+

Type Parameters

+
    +
  • +

    TKey

    • +
  • +

    TValue

+
+

Hierarchy

+
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
delete +entries +get +has +set +
+
+

Properties

+
+

delete

+
delete: ((key) => Promise<boolean>)
+
+

Type declaration

+
    +
  • +
      +
    • (key): Promise<boolean>
      • +
    • +

      Deletes the value stored for the given key.

      +
      +
      +

      Parameters

      +
        +
      • +
        key: TKey
        +

        Key to delete.

        +
        +
      +

      Returns Promise<boolean>

      If there was a value to delete.

      + +
+
+

entries

+
entries: (() => AsyncIterableIterator<[TKey, TValue]>)
+
+

Type declaration

+
    +
  • +
      +
    • (): AsyncIterableIterator<[TKey, TValue]>
      • +
    • +

      An iterable of entries in the storage.

      +
      +

      Returns AsyncIterableIterator<[TKey, TValue]>

      +
+
+

get

+
get: ((key) => Promise<undefined | TValue>)
+
+

Type declaration

+
    +
  • +
      +
    • (key): Promise<undefined | TValue>
      • +
    • +

      Returns the value stored for the given identifier. +undefined if no value is stored.

      +
      +
      +

      Parameters

      +
        +
      • +
        key: TKey
      +

      Returns Promise<undefined | TValue>

      +
+
+

has

+
has: ((key) => Promise<boolean>)
+
+

Type declaration

+
    +
  • +
      +
    • (key): Promise<boolean>
      • +
    • +

      Checks whether there is a value stored for the given key.

      +
      +
      +

      Parameters

      +
        +
      • +
        key: TKey
      +

      Returns Promise<boolean>

      +
+
+

set

+
set: ((key, value) => Promise<KeyValueStorage<TKey, TValue>>)
+
+

Type declaration

+
    +
  • +
      +
    • (key, value): Promise<KeyValueStorage<TKey, TValue>>
      • +
    • +

      Sets the value for the given key.

      +
      +
      +

      Parameters

      +
        +
      • +
        key: TKey
        +

        Key to set/update.

        +
        +
        • +
      • +
        value: TValue
        +

        Value to store.

        +
        +
      +

      Returns Promise<KeyValueStorage<TKey, TValue>>

      The storage.

      + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/LinkWebIdHandlerArgs.html b/7.x/docs/interfaces/LinkWebIdHandlerArgs.html new file mode 100644 index 000000000..6757a7ae2 --- /dev/null +++ b/7.x/docs/interfaces/LinkWebIdHandlerArgs.html @@ -0,0 +1,139 @@ +LinkWebIdHandlerArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface LinkWebIdHandlerArgs

+
+

Hierarchy

+
    +
  • LinkWebIdHandlerArgs
+
+
+
+ +
+
+

Properties

+
baseUrl +ownershipValidator +podStore +storageStrategy +webIdRoute +webIdStore +
+
+

Properties

+
+

baseUrl

+
baseUrl: string
+

Base URL of the server. +Used to indicate in the response what the object of the solid:oidcIssuer triple should be.

+
+
+
+

ownershipValidator

+
ownershipValidator: OwnershipValidator
+

Validates whether the user trying to link the WebID is the actual owner of that WebID.

+
+
+
+

podStore

+
podStore: PodStore
+

Pod store to find out if the account created the pod containing the WebID.

+
+
+
+

storageStrategy

+
storageStrategy: StorageLocationStrategy
+

Before calling the OwnershipValidator, we first check if the target WebID is in a pod owned by the user.

+
+
+
+

webIdRoute

+
webIdRoute: WebIdLinkRoute
+

Route used to generate the WebID link resource URL.

+
+
+
+

webIdStore

+
webIdStore: WebIdStore
+

WebID store to store WebID links.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/LogMetadata.html b/7.x/docs/interfaces/LogMetadata.html new file mode 100644 index 000000000..fc1ce513c --- /dev/null +++ b/7.x/docs/interfaces/LogMetadata.html @@ -0,0 +1,98 @@ +LogMetadata | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface LogMetadata

+
+

Hierarchy

+
    +
  • LogMetadata
+
+
+
+ +
+
+

Properties

+
isPrimary +pid +
+
+

Properties

+
+

isPrimary

+
isPrimary: boolean
+

Is the current process the Primary process

+
+
+
+

pid

+
pid: number
+

The process id of the current process

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/Logger.html b/7.x/docs/interfaces/Logger.html new file mode 100644 index 000000000..2a5994356 --- /dev/null +++ b/7.x/docs/interfaces/Logger.html @@ -0,0 +1,284 @@ +Logger | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface Logger

+
+

Logs messages, with convenience methods to log on a specific level.

+
+
+

See

getLoggerFor on how to instantiate loggers.

+
+
+

Hierarchy

+
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
debug +error +info +log +silly +verbose +warn +
+
+

Properties

+
+

debug

+
debug: ((message) => Logger)
+
+

Type declaration

+
    +
  • +
      +
    • (message): Logger
      • +
    • +

      Log a message at the 'debug' level.

      +
      +
      +

      Parameters

      +
        +
      • +
        message: string
        +

        The message to log.

        +
        +
      +

      Returns Logger

      +
+
+

error

+
error: ((message) => Logger)
+
+

Type declaration

+
    +
  • +
      +
    • (message): Logger
      • +
    • +

      Log a message at the 'error' level.

      +
      +
      +

      Parameters

      +
        +
      • +
        message: string
        +

        The message to log.

        +
        +
      +

      Returns Logger

      +
+
+

info

+
info: ((message) => Logger)
+
+

Type declaration

+
    +
  • +
      +
    • (message): Logger
      • +
    • +

      Log a message at the 'info' level.

      +
      +
      +

      Parameters

      +
        +
      • +
        message: string
        +

        The message to log.

        +
        +
      +

      Returns Logger

      +
+
+

log

+
log: ((level, message, meta?) => Logger)
+
+

Type declaration

+
    +
  • +
      +
    • (level, message, meta?): Logger
      • +
    • +

      Log the given message at the given level. +If the internal level is higher than the given level, the message may be voided.

      +
      +
      +

      Parameters

      +
        +
      • +
        level: "error" | "warn" | "info" | "verbose" | "debug" | "silly"
        +

        The level to log at.

        +
        +
        • +
      • +
        message: string
        +

        The message to log.

        +
        +
        • +
      • +
        Optional meta: LogMetadata
        +

        Optional metadata to include in the log message.

        +
        +
      +

      Returns Logger

      +
+
+

silly

+
silly: ((message) => Logger)
+
+

Type declaration

+
    +
  • +
      +
    • (message): Logger
      • +
    • +

      Log a message at the 'silly' level.

      +
      +
      +

      Parameters

      +
        +
      • +
        message: string
        +

        The message to log.

        +
        +
      +

      Returns Logger

      +
+
+

verbose

+
verbose: ((message) => Logger)
+
+

Type declaration

+
    +
  • +
      +
    • (message): Logger
      • +
    • +

      Log a message at the 'verbose' level.

      +
      +
      +

      Parameters

      +
        +
      • +
        message: string
        +

        The message to log.

        +
        +
      +

      Returns Logger

      +
+
+

warn

+
warn: ((message) => Logger)
+
+

Type declaration

+
    +
  • +
      +
    • (message): Logger
      • +
    • +

      Log a message at the 'warn' level.

      +
      +
      +

      Parameters

      +
        +
      • +
        message: string
        +

        The message to log.

        +
        +
      +

      Returns Logger

      +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/LoggerFactory.html b/7.x/docs/interfaces/LoggerFactory.html new file mode 100644 index 000000000..63251129f --- /dev/null +++ b/7.x/docs/interfaces/LoggerFactory.html @@ -0,0 +1,114 @@ +LoggerFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface LoggerFactory

+
+

Instantiates new logger instances.

+
+
+
+

Hierarchy

+
    +
  • LoggerFactory
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
createLogger +
+
+

Properties

+
+

createLogger

+
createLogger: ((label) => Logger)
+
+

Type declaration

+
    +
  • +
      +
    • (label): Logger
      • +
    • +

      Create a logger instance for the given label.

      +
      +
      +

      Parameters

      +
        +
      • +
        label: string
        +

        A label that is used to identify the given logger.

        +
        +
      +

      Returns Logger

      +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/LoginStorage.html b/7.x/docs/interfaces/LoginStorage.html new file mode 100644 index 000000000..049c0ccd9 --- /dev/null +++ b/7.x/docs/interfaces/LoginStorage.html @@ -0,0 +1,524 @@ +LoginStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface LoginStorage<T>

+
+

A IndexedStorage where the defineType function +takes an extra parameter to indicate if the type corresponds to a login method. +This is useful for storages that want to add extra requirements based on the data being edited.

+

In practice, we use this because we want to require accounts to have at least 1 login method.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
create +createIndex +defineType +delete +entries +find +findIds +get +has +set +setField +
+
+

Properties

+
+

create

+
create: (<TType>(type, value) => Promise<TypeObject<T[TType]>>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, value): Promise<TypeObject<T[TType]>>
      • +
    • +

      Creates an object of the given type. +The storage will generate an identifier for the newly created object.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type to create.

        +
        +
        • +
      • +
        value: CreateTypeObject<T[TType]>
        +

        The value to set for the created object.

        +
        +
      +

      Returns Promise<TypeObject<T[TType]>>

      A representation of the newly created object, including its new identifier.

      + +
+
+

createIndex

+
createIndex: (<TType>(type, key) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, key): Promise<void>
      • +
    • +

      Creates an index on a key of the given type, to allow for better queries involving those keys. +Similar to IndexedStorage.defineType these calls need to happen first.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type to create an index on.

        +
        +
        • +
      • +
        key: StringKey<T[TType]>
        +

        The key of that type to create an index on.

        +
        +
      +

      Returns Promise<void>

      +
+
+

defineType

+
defineType: (<TType>(type, description, isLogin) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, description, isLogin): Promise<void>
      • +
    • +

      Defines a type in the storage, just like in an IndexedStorage, +but additionally it needs to be indicated if the type corresponds to a login method or not.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        Type to define.

        +
        +
        • +
      • +
        description: T[TType]
        +

        Description of the type.

        +
        +
        • +
      • +
        isLogin: boolean
        +

        Whether this type corresponds to a login method or not.

        +
        +
      +

      Returns Promise<void>

      +
+
+

delete

+
delete: (<TType>(type, id) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, id): Promise<void>
      • +
    • +

      Deletes the given object. +This will also delete all objects that reference that object if the corresponding key is not optional.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type of the object to delete.

        +
        +
        • +
      • +
        id: string
        +

        The identifier of the object.

        +
        +
      +

      Returns Promise<void>

      +
+
+

entries

+
entries: (<TType>(type) => AsyncIterableIterator<TypeObject<T[TType]>>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type): AsyncIterableIterator<TypeObject<T[TType]>>
      • +
    • +

      Returns an iterator over all objects of the given type.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type to iterate over.

        +
        +
      +

      Returns AsyncIterableIterator<TypeObject<T[TType]>>

      +
+
+

find

+
find: (<TType>(type, query) => Promise<TypeObject<T[TType]>[]>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, query): Promise<TypeObject<T[TType]>[]>
      • +
    • +

      Finds all objects matching a specific IndexedQuery.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type of objects to find.

        +
        +
        • +
      • +
        query: {
            [K in string | number | symbol]?: ValueType<T[TType][K]> | (T[TType][K] extends `id:${U}`
                ? ({ [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<...> | ... 1 more ... | undefined; } : never) | undefined; } : never) | undefined; })
                : never)
        }
        +

        The query to execute.

        +
        +
      +

      Returns Promise<TypeObject<T[TType]>[]>

      A list of objects matching the query.

      + +
+
+

findIds

+
findIds: (<TType>(type, query) => Promise<string[]>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, query): Promise<string[]>
      • +
    • +

      Similar to IndexedStorage.find, but only returns the identifiers of the found objects.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type of objects to find.

        +
        +
        • +
      • +
        query: {
            [K in string | number | symbol]?: ValueType<T[TType][K]> | (T[TType][K] extends `id:${U}`
                ? ({ [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<T[U][K]> | (T[U][K] extends `id:${infer U}` ? { [K in "id" | keyof T[U]]?: ValueType<...> | ... 1 more ... | undefined; } : never) | undefined; } : never) | undefined; })
                : never)
        }
        +

        The query to execute.

        +
        +
      +

      Returns Promise<string[]>

      A list of identifiers of the matching objects.

      + +
+
+

get

+
get: (<TType>(type, id) => Promise<undefined | TypeObject<T[TType]>>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, id): Promise<undefined | TypeObject<T[TType]>>
      • +
    • +

      Returns the object of the given type with the given identifier.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type of object to get.

        +
        +
        • +
      • +
        id: string
        +

        The identifier of that object.

        +
        +
      +

      Returns Promise<undefined | TypeObject<T[TType]>>

      A representation of the object, or undefined if there is no object of that type with that identifier.

      + +
+
+

has

+
has: (<TType>(type, id) => Promise<boolean>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, id): Promise<boolean>
      • +
    • +

      Returns true if the object of the given type with the given identifier exists.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type of object to get.

        +
        +
        • +
      • +
        id: string
        +

        The identifier of that object.

        +
        +
      +

      Returns Promise<boolean>

      Whether this object exists.

      + +
+
+

set

+
set: (<TType>(type, value) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType>(type, value): Promise<void>
      • +
    • +

      Sets the value of a specific object. +The identifier in the object is used to identify the object.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type of the object to set.

        +
        +
        • +
      • +
        value: TypeObject<T[TType]>
        +

        The new value for the object.

        +
        +
      +

      Returns Promise<void>

      +
+
+

setField

+
setField: (<TType, TKey>(type, id, key, value) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • <TType, TKey>(type, id, key, value): Promise<void>
      • +
    • +

      Sets the value of one specific field in an object.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        TType extends string

        • +
      • +

        TKey extends string

      +
      +

      Parameters

      +
        +
      • +
        type: TType
        +

        The type of the object to update.

        +
        +
        • +
      • +
        id: string
        +

        The identifier of the object to update.

        +
        +
        • +
      • +
        key: TKey
        +

        The key to update.

        +
        +
        • +
      • +
        value: ValueType<T[TType][TKey]>
        +

        The new value for the given key.

        +
        +
      +

      Returns Promise<void>

      +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/MetadataWriterInput.html b/7.x/docs/interfaces/MetadataWriterInput.html new file mode 100644 index 000000000..3fc78ca3c --- /dev/null +++ b/7.x/docs/interfaces/MetadataWriterInput.html @@ -0,0 +1,92 @@ +MetadataWriterInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface MetadataWriterInput

+
+

Hierarchy

+
    +
  • MetadataWriterInput
+
+
+
+ +
+
+

Properties

+
metadata +response +
+
+

Properties

+
+

metadata

+
metadata: RepresentationMetadata
+
+

response

+
response: HttpResponse
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/NotificationChannel.html b/7.x/docs/interfaces/NotificationChannel.html new file mode 100644 index 000000000..76119da61 --- /dev/null +++ b/7.x/docs/interfaces/NotificationChannel.html @@ -0,0 +1,209 @@ +NotificationChannel | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface NotificationChannel

+
+

Internal representation of a notification channel. +Most of the fields are those defined in +https://solidproject.org/TR/2022/notifications-protocol-20221231#notification-channel-data-model

+

We only support notification channels with a single topic.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
accept? +endAt? +id +lastEmit? +rate? +receiveFrom? +sendTo? +sender? +startAt? +state? +topic +type +
+
+

Properties

+
+

Optional accept

+
accept?: string
+

The media type in which the receiver expects the notifications.

+
+
+
+

Optional endAt

+
endAt?: number
+

When the channel should stop existing, in milliseconds since epoch.

+
+
+
+

id

+
id: string
+

The unique identifier of the channel.

+
+
+
+

Optional lastEmit

+
lastEmit?: number
+

Internal value that we use to track when this channel last sent a notification.

+
+
+
+

Optional rate

+
rate?: number
+

The minimal time required between notifications, in milliseconds.

+
+
+
+

Optional receiveFrom

+
receiveFrom?: string
+

The resource receivers can use to establish a connection and receive notifications.

+
+
+
+

Optional sendTo

+
sendTo?: string
+

The resource on the receiver where notifications can be sent.

+
+
+
+

Optional sender

+
sender?: string
+

Can be used to identify the sender.

+
+
+
+

Optional startAt

+
startAt?: number
+

When the channel should start sending notifications, in milliseconds since epoch.

+
+
+
+

Optional state

+
state?: string
+

The state parameter sent by the receiver. +This is used to send a notification when the channel is established and the topic resource has a different state.

+
+
+
+

topic

+
topic: string
+

The resource this channel sends notifications about.

+
+
+
+

type

+
type: string
+

The channel type.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/NotificationChannelStorage.html b/7.x/docs/interfaces/NotificationChannelStorage.html new file mode 100644 index 000000000..f4e21a0a7 --- /dev/null +++ b/7.x/docs/interfaces/NotificationChannelStorage.html @@ -0,0 +1,222 @@ +NotificationChannelStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface NotificationChannelStorage

+
+

Stores all the information necessary to keep track of notification channels. +Besides the standard channel info it also stores features specific to a certain channel type.

+

This storage assumes that a channel can only have a single identifier as its topic.

+
+
+
+

Hierarchy

+
    +
  • NotificationChannelStorage
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
add +delete +get +getAll +update +
+
+

Properties

+
+

add

+
add: ((channel) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (channel): Promise<void>
      • +
    • +

      Adds the given channel to the storage.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<void>

      +
+
+

delete

+
delete: ((id) => Promise<boolean>)
+
+

Type declaration

+
    +
  • +
      +
    • (id): Promise<boolean>
      • +
    • +

      Deletes the given notification channel from the storage. +Returns true if the channel existed.

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +

        The identifier of the notification channel

        +
        +
      +

      Returns Promise<boolean>

      +
+
+

get

+
get: ((id) => Promise<undefined | NotificationChannel>)
+
+

Type declaration

+
    +
  • +
      +
    • (id): Promise<undefined | NotificationChannel>
      • +
    • +

      Returns the requested channel. +undefined if no match was found or if the notification channel expired.

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +

        The identifier of the notification channel.

        +
        +
      +

      Returns Promise<undefined | NotificationChannel>

      +
+
+

getAll

+
getAll: ((topic) => Promise<string[]>)
+
+

Type declaration

+
    +
  • +
      +
    • (topic): Promise<string[]>
      • +
    • +

      Returns the identifiers of all notification channel entries that have the given identifier as their topic. +The identifiers can potentially correspond to expired channels.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<string[]>

      +
+
+

update

+
update: ((channel) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (channel): Promise<void>
      • +
    • +

      Updates the given notification channel. +The id and the topic can not be updated.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<void>

      +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/NotificationChannelType.html b/7.x/docs/interfaces/NotificationChannelType.html new file mode 100644 index 000000000..09125ba8f --- /dev/null +++ b/7.x/docs/interfaces/NotificationChannelType.html @@ -0,0 +1,218 @@ +NotificationChannelType | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface NotificationChannelType

+
+

A specific channel type as defined at +https://solidproject.org/TR/2022/notifications-protocol-20221231#notification-channel-types.

+

All functions that take a NotificationChannel as input +only need to support channels generated by an initChannel on the same class.

+
+
+
+

Hierarchy

+
    +
  • NotificationChannelType
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
completeChannel +extractModes +getDescription +initChannel +toJsonLd +
+
+

Properties

+
+

completeChannel

+
completeChannel: ((channel) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (channel): Promise<void>
      • +
    • +

      This function will be called after the serialized channel is sent back as a response, +allowing for any final actions that need to happen.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<void>

      +
+
+

extractModes

+
extractModes: ((channel) => Promise<AccessMap>)
+
+

Type declaration

+
    +
  • +
      +
    • (channel): Promise<AccessMap>
      • +
    • +

      Determines which modes are required to allow the given notification channel.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<AccessMap>

      The required modes.

      + +
+
+

getDescription

+
getDescription: (() => SubscriptionService)
+
+

Type declaration

+
+
+

initChannel

+
initChannel: ((data, credentials) => Promise<NotificationChannel>)
+
+

Type declaration

+
+
+

toJsonLd

+
toJsonLd: ((channel) => Promise<Record<string, unknown>>)
+
+

Type declaration

+
    +
  • +
      +
    • (channel): Promise<Record<string, unknown>>
      • +
    • +

      Converts a NotificationChannel to a serialized JSON-LD representation.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<Record<string, unknown>>

      +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/NotificationEmitterInput.html b/7.x/docs/interfaces/NotificationEmitterInput.html new file mode 100644 index 000000000..9aa0703a3 --- /dev/null +++ b/7.x/docs/interfaces/NotificationEmitterInput.html @@ -0,0 +1,92 @@ +NotificationEmitterInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface NotificationEmitterInput

+
+

Hierarchy

+
    +
  • NotificationEmitterInput
+
+
+
+ +
+
+

Properties

+
channel +representation +
+
+

Properties

+
+

channel

+
channel: NotificationChannel
+
+

representation

+
representation: Representation
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/NotificationHandlerInput.html b/7.x/docs/interfaces/NotificationHandlerInput.html new file mode 100644 index 000000000..d151b7394 --- /dev/null +++ b/7.x/docs/interfaces/NotificationHandlerInput.html @@ -0,0 +1,106 @@ +NotificationHandlerInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface NotificationHandlerInput

+
+

Hierarchy

+
    +
  • NotificationHandlerInput
+
+
+
+ +
+
+

Properties

+
activity? +channel +metadata? +topic +
+
+

Properties

+
+

Optional activity

+
activity?: NamedNode<"https://www.w3.org/ns/activitystreams#Create"> | NamedNode<"https://www.w3.org/ns/activitystreams#object"> | NamedNode<"https://www.w3.org/ns/activitystreams#target"> | NamedNode<"https://www.w3.org/ns/activitystreams#Add"> | NamedNode<"https://www.w3.org/ns/activitystreams#Delete"> | NamedNode<"https://www.w3.org/ns/activitystreams#Remove"> | NamedNode<"https://www.w3.org/ns/activitystreams#Update">
+
+

channel

+
channel: NotificationChannel
+
+

Optional metadata

+
metadata?: RepresentationMetadata
+
+

topic

+
topic: ResourceIdentifier
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/NotificationSerializerInput.html b/7.x/docs/interfaces/NotificationSerializerInput.html new file mode 100644 index 000000000..5021bc3c5 --- /dev/null +++ b/7.x/docs/interfaces/NotificationSerializerInput.html @@ -0,0 +1,92 @@ +NotificationSerializerInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface NotificationSerializerInput

+
+

Hierarchy

+
    +
  • NotificationSerializerInput
+
+
+
+ +
+
+

Properties

+
channel +notification +
+
+

Properties

+
+

channel

+
channel: NotificationChannel
+
+

notification

+
notification: Notification
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/NotificationSubscriberArgs.html b/7.x/docs/interfaces/NotificationSubscriberArgs.html new file mode 100644 index 000000000..773e405a3 --- /dev/null +++ b/7.x/docs/interfaces/NotificationSubscriberArgs.html @@ -0,0 +1,151 @@ +NotificationSubscriberArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface NotificationSubscriberArgs

+
+

Hierarchy

+
    +
  • NotificationSubscriberArgs
+
+
+
+ +
+
+

Properties

+
authorizer +channelType +converter +credentialsExtractor +maxDuration? +permissionReader +storage +
+
+

Properties

+
+

authorizer

+
authorizer: Authorizer
+

Used to determine if the request has the necessary permissions.

+
+
+
+

channelType

+
channelType: NotificationChannelType
+

The NotificationChannelType with all the necessary information.

+
+
+
+

converter

+
converter: RepresentationConverter
+

RepresentationConverter used to convert input data into RDF.

+
+
+
+

credentialsExtractor

+
credentialsExtractor: CredentialsExtractor
+

Used to extract the credentials from the request.

+
+
+
+

Optional maxDuration

+
maxDuration?: number
+

Overrides the expiration feature of channels, by making sure they always expire after the maxDuration value. +If the expiration of the channel is shorter than maxDuration, the original value will be kept. +Value is set in minutes. 0 is infinite. +Defaults to 20160 minutes, which is 2 weeks.

+
+
+
+

permissionReader

+
permissionReader: PermissionReader
+

Used to determine which permissions the found credentials have.

+
+
+
+

storage

+
storage: NotificationChannelStorage
+

Storage used to store the channels.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/OAuthErrorFields.html b/7.x/docs/interfaces/OAuthErrorFields.html new file mode 100644 index 000000000..f73524a44 --- /dev/null +++ b/7.x/docs/interfaces/OAuthErrorFields.html @@ -0,0 +1,113 @@ +OAuthErrorFields | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface OAuthErrorFields

+
+

These are the fields that can occur in an OAuth error response as described in RFC 6749, §4.1.2.1. +https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.2.1

+

This interface is identical to the ErrorOut interface of the oidc-provider library, +but having our own version reduces the part of the codebase that is dependent on that library.

+
+
+
+

Hierarchy

+
    +
  • OAuthErrorFields
+
+
+
+ +
+
+

Properties

+
error +error_description? +scope? +state? +
+
+

Properties

+
+

error

+
error: string
+
+

Optional error_description

+
error_description?: string
+
+

Optional scope

+
scope?: string
+
+

Optional state

+
state?: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/Operation.html b/7.x/docs/interfaces/Operation.html new file mode 100644 index 000000000..3e62b0a96 --- /dev/null +++ b/7.x/docs/interfaces/Operation.html @@ -0,0 +1,132 @@ +Operation | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface Operation

+
+

A single REST operation.

+
+
+
+

Hierarchy

+
    +
  • Operation
+
+
+
+ +
+
+

Properties

+
body +conditions? +method +preferences +target +
+
+

Properties

+
+

body

+
body: Representation
+

Representation of the body and metadata headers.

+
+
+
+

Optional conditions

+
conditions?: Conditions
+

Conditions the resource must fulfill for a valid operation.

+
+
+
+

method

+
method: string
+

The HTTP method (GET/POST/PUT/PATCH/DELETE/etc.).

+
+
+
+

preferences

+
preferences: RepresentationPreferences
+

Representation preferences of the response. Will be empty if there are none.

+
+
+
+

target

+
target: ResourceIdentifier
+

Identifier of the target.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/OperationHandlerInput.html b/7.x/docs/interfaces/OperationHandlerInput.html new file mode 100644 index 000000000..14a0e2c68 --- /dev/null +++ b/7.x/docs/interfaces/OperationHandlerInput.html @@ -0,0 +1,85 @@ +OperationHandlerInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface OperationHandlerInput

+
+

Hierarchy

+
    +
  • OperationHandlerInput
+
+
+
+ +
+
+

Properties

+
operation +
+
+

Properties

+
+

operation

+
operation: Operation
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/OperationHttpHandlerInput.html b/7.x/docs/interfaces/OperationHttpHandlerInput.html new file mode 100644 index 000000000..f4b730ed6 --- /dev/null +++ b/7.x/docs/interfaces/OperationHttpHandlerInput.html @@ -0,0 +1,103 @@ +OperationHttpHandlerInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface OperationHttpHandlerInput

+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
operation +request +response +
+
+

Properties

+
+

operation

+
operation: Operation
+
+

request

+
request: HttpRequest
+
+

response

+
response: HttpResponse
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/OriginalUrlExtractorArgs.html b/7.x/docs/interfaces/OriginalUrlExtractorArgs.html new file mode 100644 index 000000000..a16046670 --- /dev/null +++ b/7.x/docs/interfaces/OriginalUrlExtractorArgs.html @@ -0,0 +1,98 @@ +OriginalUrlExtractorArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface OriginalUrlExtractorArgs

+
+

Hierarchy

+
    +
  • OriginalUrlExtractorArgs
+
+
+
+ +
+
+

Properties

+
identifierStrategy +includeQueryString? +
+
+

Properties

+
+

identifierStrategy

+
identifierStrategy: IdentifierStrategy
+

The IdentifierStrategy to use for checking the scope of the request

+
+
+
+

Optional includeQueryString

+
includeQueryString?: boolean
+

Specify whether the OriginalUrlExtractor should include the request query string.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ParsingHttpHandlerArgs.html b/7.x/docs/interfaces/ParsingHttpHandlerArgs.html new file mode 100644 index 000000000..653d465ad --- /dev/null +++ b/7.x/docs/interfaces/ParsingHttpHandlerArgs.html @@ -0,0 +1,118 @@ +ParsingHttpHandlerArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ParsingHttpHandlerArgs

+
+

Hierarchy

+
    +
  • ParsingHttpHandlerArgs
+
+
+
+ +
+
+

Properties

+
errorHandler +operationHandler +requestParser +responseWriter +
+
+

Properties

+
+

errorHandler

+
errorHandler: ErrorHandler
+

Converts errors to a serializable format.

+
+
+
+

operationHandler

+
operationHandler: OperationHttpHandler
+

Handler to send the operation to.

+
+
+
+

requestParser

+
requestParser: RequestParser
+

Parses the incoming requests.

+
+
+
+

responseWriter

+
responseWriter: ResponseWriter
+

Writes out the response of the operation.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/PasswordLoginHandlerArgs.html b/7.x/docs/interfaces/PasswordLoginHandlerArgs.html new file mode 100644 index 000000000..d5097b88d --- /dev/null +++ b/7.x/docs/interfaces/PasswordLoginHandlerArgs.html @@ -0,0 +1,99 @@ +PasswordLoginHandlerArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface PasswordLoginHandlerArgs

+
+

Hierarchy

+
    +
  • PasswordLoginHandlerArgs
+
+
+
+ +
+
+

Properties

+
accountStore +cookieStore +passwordStore +
+
+

Properties

+
+

accountStore

+
accountStore: AccountStore
+
+

cookieStore

+
cookieStore: CookieStore
+
+

passwordStore

+
passwordStore: PasswordStore
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/PasswordStore.html b/7.x/docs/interfaces/PasswordStore.html new file mode 100644 index 000000000..532bc2665 --- /dev/null +++ b/7.x/docs/interfaces/PasswordStore.html @@ -0,0 +1,318 @@ +PasswordStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface PasswordStore

+
+

Responsible for storing everything related to email/password based login combinations.

+
+
+
+

Hierarchy

+
    +
  • PasswordStore
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
authenticate +confirmVerification +create +delete +findByAccount +findByEmail +get +update +
+
+

Properties

+
+

authenticate

+
authenticate: ((email, password) => Promise<{
    accountId: string;
    id: string;
}>)
+
+

Type declaration

+
    +
  • +
      +
    • (email, password): Promise<{
          accountId: string;
          id: string;
      }>
      • +
    • +

      Authenticate if the email and password are correct and return the account and login ID if they are. +Throw an error if they are not.

      +
      +
      +

      Parameters

      +
        +
      • +
        email: string
        +

        The user's email.

        +
        +
        • +
      • +
        password: string
        +

        This user's password.

        +
        +
      +

      Returns Promise<{
          accountId: string;
          id: string;
      }>

      +
+
+

confirmVerification

+
confirmVerification: ((id) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (id): Promise<void>
      • +
    • +

      Confirms that the login has been verified. +This can be used with, for example, email verification. +The login can only be used after it is verified. +In case verification is not required, this should be called immediately after the create call.

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +

        ID of the login.

        +
        +
      +

      Returns Promise<void>

      +
+
+

create

+
create: ((email, accountId, password) => Promise<string>)
+
+

Type declaration

+
    +
  • +
      +
    • (email, accountId, password): Promise<string>
      • +
    • +

      Creates a new login entry for this account.

      +
      +
      +

      Parameters

      +
        +
      • +
        email: string
        +

        Email to log in with.

        +
        +
        • +
      • +
        accountId: string
        +

        Account ID.

        +
        +
        • +
      • +
        password: string
        +

        Password to authenticate with.

        +
        +
      +

      Returns Promise<string>

      +
+
+

delete

+
delete: ((id) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (id): Promise<void>
      • +
    • +

      Delete the login entry.

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +

        ID of the login object.

        +
        +
      +

      Returns Promise<void>

      +
+
+

findByAccount

+
findByAccount: ((accountId) => Promise<{
    email: string;
    id: string;
}[]>)
+
+

Type declaration

+
    +
  • +
      +
    • (accountId): Promise<{
          email: string;
          id: string;
      }[]>
      • +
    • +

      Find all login objects created by this account.

      +
      +
      +

      Parameters

      +
        +
      • +
        accountId: string
        +

        ID of the account to find the logins for.

        +
        +
      +

      Returns Promise<{
          email: string;
          id: string;
      }[]>

      +
+
+

findByEmail

+
findByEmail: ((email) => Promise<undefined | {
    accountId: string;
    id: string;
}>)
+
+

Type declaration

+
    +
  • +
      +
    • (email): Promise<undefined | {
          accountId: string;
          id: string;
      }>
      • +
    • +

      Finds the account and login ID associated with this email.

      +
      +
      +

      Parameters

      +
        +
      • +
        email: string
        +

        Email to find the information for.

        +
        +
      +

      Returns Promise<undefined | {
          accountId: string;
          id: string;
      }>

      +
+
+

get

+
get: ((id) => Promise<undefined | {
    accountId: string;
    email: string;
}>)
+
+

Type declaration

+
    +
  • +
      +
    • (id): Promise<undefined | {
          accountId: string;
          email: string;
      }>
      • +
    • +

      Finds the account and email associated with this login ID.

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +

        The ID of the login object.

        +
        +
      +

      Returns Promise<undefined | {
          accountId: string;
          email: string;
      }>

      +
+
+

update

+
update: ((id, password) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (id, password): Promise<void>
      • +
    • +

      Changes the password.

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +

        ID of the login object.

        +
        +
        • +
      • +
        password: string
        +

        The new password.

        +
        +
      +

      Returns Promise<void>

      +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/Patch.html b/7.x/docs/interfaces/Patch.html new file mode 100644 index 000000000..697300f41 --- /dev/null +++ b/7.x/docs/interfaces/Patch.html @@ -0,0 +1,133 @@ +Patch | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface Patch

+
+

Represents the changes needed for a PATCH request.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
binary +data +isEmpty +metadata +
+
+

Properties

+
+

binary

+
binary: boolean
+

Whether the data stream consists of binary/string chunks +(as opposed to complex objects).

+
+
+
+

data

+
data: Guarded<Readable>
+

The raw data stream for this representation.

+
+
+
+

isEmpty

+
isEmpty: boolean
+

Whether the data stream is empty. +This being true does not imply that the data stream has a length of more than 0, +only that it is a possibility and should be read to be sure.

+
+
+
+

metadata

+
metadata: RepresentationMetadata
+

The corresponding metadata.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/PermissionReaderInput.html b/7.x/docs/interfaces/PermissionReaderInput.html new file mode 100644 index 000000000..eede12c6e --- /dev/null +++ b/7.x/docs/interfaces/PermissionReaderInput.html @@ -0,0 +1,99 @@ +PermissionReaderInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface PermissionReaderInput

+
+

Hierarchy

+
    +
  • PermissionReaderInput
+
+
+
+ +
+
+

Properties

+
credentials +requestedModes +
+
+

Properties

+
+

credentials

+
credentials: Credentials
+

Credentials of the entity requesting access to resources.

+
+
+
+

requestedModes

+
requestedModes: AccessMap
+

For each credential, the reader will check which of the given per-resource access modes are available. +However, non-exhaustive information about other access modes and resources can still be returned.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/PodCreatorInput.html b/7.x/docs/interfaces/PodCreatorInput.html new file mode 100644 index 000000000..e4730c577 --- /dev/null +++ b/7.x/docs/interfaces/PodCreatorInput.html @@ -0,0 +1,122 @@ +PodCreatorInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface PodCreatorInput

+
+

Hierarchy

+
    +
  • PodCreatorInput
+
+
+
+ +
+
+

Properties

+
accountId +name? +settings? +webId? +
+
+

Properties

+
+

accountId

+
accountId: string
+

The ID of the account to create the pod for.

+
+
+
+

Optional name

+
name?: string
+

The name to use when generating the base URL of the pod. +If undefined, the pod will be created in the root of the server.

+
+
+
+

Optional settings

+
settings?: Record<string, unknown>
+

Additional settings to use when generating a pod.

+
+
+
+

Optional webId

+
webId?: string
+

The WebID to use for creation of the pod. +This WebID will be used in the templates to, for example, determine who has access. +If none is provided, the WebID generated by the creator will be used, +in which case that WebID will also be linked to the account.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/PodCreatorOutput.html b/7.x/docs/interfaces/PodCreatorOutput.html new file mode 100644 index 000000000..d66378621 --- /dev/null +++ b/7.x/docs/interfaces/PodCreatorOutput.html @@ -0,0 +1,118 @@ +PodCreatorOutput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface PodCreatorOutput

+
+

Hierarchy

+
    +
  • PodCreatorOutput
+
+
+
+ +
+
+

Properties

+
podId +podUrl +webId +webIdLink? +
+
+

Properties

+
+

podId

+
podId: string
+

The ID of the generated pod.

+
+
+
+

podUrl

+
podUrl: string
+

The URl of the generated pod.

+
+
+
+

webId

+
webId: string
+

The WebID that was used to generate the pod.

+
+
+
+

Optional webIdLink

+
webIdLink?: string
+

The ID of the WebID link if one was generated.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/PodGenerator.html b/7.x/docs/interfaces/PodGenerator.html new file mode 100644 index 000000000..3a8aa54e9 --- /dev/null +++ b/7.x/docs/interfaces/PodGenerator.html @@ -0,0 +1,116 @@ +PodGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface PodGenerator

+
+

Generates an empty resource store to be used as a new pod. +It is also responsible for storing any relevant variables needed to instantiate this resource store. +These can then be used when the server is restarted to re-instantiate those stores.

+
+
+
+

Hierarchy

+
    +
  • PodGenerator
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
generate +
+
+

Properties

+
+

generate

+
generate: ((settings) => Promise<ResourceStore>)
+
+

Type declaration

+
    +
  • +
      +
    • (settings): Promise<ResourceStore>
      • +
    • +

      Creates a ResourceStore based on the given input. +Should error if there already is a store for the given identifier.

      +
      +
      +

      Parameters

      +
        +
      • +
        settings: PodSettings
        +

        Parameters to be used for the new pod.

        +
        +
      +

      Returns Promise<ResourceStore>

      A new ResourceStore to be used for the new pod.

      + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/PodManager.html b/7.x/docs/interfaces/PodManager.html new file mode 100644 index 000000000..5cba55c17 --- /dev/null +++ b/7.x/docs/interfaces/PodManager.html @@ -0,0 +1,119 @@ +PodManager | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface PodManager

+
+

Covers all functions related to pod management. +In the future this should also include delete, and potentially recovery functions.

+
+
+
+

Hierarchy

+
    +
  • PodManager
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
createPod +
+
+

Properties

+
+

createPod

+
createPod: ((settings, overwrite) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (settings, overwrite): Promise<void>
      • +
    • +

      Creates a pod for the given settings.

      +
      +
      +

      Parameters

      +
        +
      • +
        settings: PodSettings
        +

        Settings describing the pod.

        +
        +
        • +
      • +
        overwrite: boolean
        +

        If the creation should proceed if there already is a resource there.

        +
        +
      +

      Returns Promise<void>

      +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/PodSettings.html b/7.x/docs/interfaces/PodSettings.html new file mode 100644 index 000000000..20b8ea114 --- /dev/null +++ b/7.x/docs/interfaces/PodSettings.html @@ -0,0 +1,145 @@ +PodSettings | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface PodSettings

+
+

Metadata related to pod generation.

+
+
+
+

Hierarchy

+
    +
  • Dict<unknown> +
      +
    • PodSettings
+
+
+
+ +
+
+

Properties

+
base +email? +name? +oidcIssuer? +template? +webId +
+
+

Properties

+
+

base

+
base: ResourceIdentifier
+

The root of the pod. Determines where the pod will be created.

+
+
+
+

Optional email

+
email?: string
+

E-mail of the owner. Used in provisioning templates.

+
+
+
+

Optional name

+
name?: string
+

Name of the owner. Used in provisioning templates.

+
+
+
+

Optional oidcIssuer

+
oidcIssuer?: string
+

The OIDC issuer of the owner's WebId. Necessary if the WebID in the pod is registered with the IDP.

+
+
+
+

Optional template

+
template?: string
+

Required for dynamic pod configuration. +Indicates the name of the config to use for the pod.

+
+
+
+

webId

+
webId: string
+

The WebId of the owner of this pod.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/PodStore.html b/7.x/docs/interfaces/PodStore.html new file mode 100644 index 000000000..ffa96b394 --- /dev/null +++ b/7.x/docs/interfaces/PodStore.html @@ -0,0 +1,300 @@ +PodStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface PodStore

+
+

Can be used to create new pods and find relevant information. +Also keeps track of the owners of a pod. +The visible parameter indicates if an owner should be publicly exposed or not.

+
+
+
+

Hierarchy

+
    +
  • PodStore
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
create +findByBaseUrl +findPods +get +getOwners +removeOwner +updateOwner +
+
+

Properties

+
+

create

+
create: ((accountId, settings, overwrite) => Promise<string>)
+
+

Type declaration

+
    +
  • +
      +
    • (accountId, settings, overwrite): Promise<string>
      • +
    • +

      Creates a new pod and updates the account accordingly.

      +
      +
      +

      Parameters

      +
        +
      • +
        accountId: string
        +

        Identifier of the account that is creating the account.

        +
        +
        • +
      • +
        settings: PodSettings
        +

        Settings to create a pod with.

        +
        +
        • +
      • +
        overwrite: boolean
        +

        If the pod is allowed to overwrite existing data.

        +
        +
      +

      Returns Promise<string>

      The ID of the new pod resource.

      + +
+
+

findByBaseUrl

+
findByBaseUrl: ((baseUrl) => Promise<undefined | {
    accountId: string;
    id: string;
}>)
+
+

Type declaration

+
    +
  • +
      +
    • (baseUrl): Promise<undefined | {
          accountId: string;
          id: string;
      }>
      • +
    • +

      Find the ID of the account that created the given pod.

      +
      +
      +

      Parameters

      +
        +
      • +
        baseUrl: string
        +

        The pod base URL.

        +
        +
      +

      Returns Promise<undefined | {
          accountId: string;
          id: string;
      }>

      +
+
+

findPods

+
findPods: ((accountId) => Promise<{
    baseUrl: string;
    id: string;
}[]>)
+
+

Type declaration

+
    +
  • +
      +
    • (accountId): Promise<{
          baseUrl: string;
          id: string;
      }[]>
      • +
    • +

      Find all the pod resources created by the given account ID.

      +
      +
      +

      Parameters

      +
        +
      • +
        accountId: string
        +

        Account ID to find pod resources for.

        +
        +
      +

      Returns Promise<{
          baseUrl: string;
          id: string;
      }[]>

      +
+
+

get

+
get: ((id) => Promise<undefined | {
    accountId: string;
    baseUrl: string;
}>)
+
+

Type declaration

+
    +
  • +
      +
    • (id): Promise<undefined | {
          accountId: string;
          baseUrl: string;
      }>
      • +
    • +

      Returns the baseURl and account that created the pod for the given pod ID.

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +

        ID of the pod.

        +
        +
      +

      Returns Promise<undefined | {
          accountId: string;
          baseUrl: string;
      }>

      +
+
+

getOwners

+
getOwners: ((id) => Promise<undefined | {
    visible: boolean;
    webId: string;
}[]>)
+
+

Type declaration

+
    +
  • +
      +
    • (id): Promise<undefined | {
          visible: boolean;
          webId: string;
      }[]>
      • +
    • +

      Find all owners for the given pod ID.

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +

        ID of the pod.

        +
        +
      +

      Returns Promise<undefined | {
          visible: boolean;
          webId: string;
      }[]>

      +
+
+

removeOwner

+
removeOwner: ((id, webId) => Promise<void>)
+
+

Type declaration

+
+
+

updateOwner

+
updateOwner: ((id, webId, visible) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (id, webId, visible): Promise<void>
      • +
    • +

      Add or update an owner of a pod. +In case there already is an owner with this WebID, it will be updated, +otherwise a new owner will be added.

      +
      +
      +

      Parameters

      +
        +
      • +
        id: string
        +

        ID of the pod.

        +
        +
        • +
      • +
        webId: string
        +

        WebID of the owner.

        +
        +
        • +
      • +
        visible: boolean
        +

        Whether the owner wants to be exposed or not.

        +
        +
      +

      Returns Promise<void>

      +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ProviderFactory.html b/7.x/docs/interfaces/ProviderFactory.html new file mode 100644 index 000000000..754d5dae3 --- /dev/null +++ b/7.x/docs/interfaces/ProviderFactory.html @@ -0,0 +1,106 @@ +ProviderFactory | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ProviderFactory

+
+

Returns a Provider of OIDC interactions.

+
+
+
+

Hierarchy

+
    +
  • ProviderFactory
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
getProvider +
+
+

Properties

+
+

getProvider

+
getProvider: (() => Promise<default>)
+
+

Type declaration

+
    +
  • +
      +
    • (): Promise<default>
      • +
    • +

      Gets a provider from the factory. +Multiple calls to this function should return providers that produce the same results. +This is mostly relevant for signing keys.

      +
      +

      Returns Promise<default>

      +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/RdfStorePatcherInput.html b/7.x/docs/interfaces/RdfStorePatcherInput.html new file mode 100644 index 000000000..f1bb0330f --- /dev/null +++ b/7.x/docs/interfaces/RdfStorePatcherInput.html @@ -0,0 +1,110 @@ +RdfStorePatcherInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface RdfStorePatcherInput

+
+

Hierarchy

+
    +
  • RdfStorePatcherInput
+
+
+
+ +
+
+

Properties

+
identifier +patch +store +
+
+

Properties

+
+

identifier

+
identifier: ResourceIdentifier
+

Identifier of the resource that will be patched

+
+
+
+

patch

+
patch: Patch
+

The changes represented by a Patch object

+
+
+
+

store

+
store: Store<Quad, Quad, Quad, Quad>
+

The store on which the patch will be executed. +Note the RdfStorePatcher is allowed to make changes to the store. +This means the store object might be modified by the patch.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ReadWriteLocker.html b/7.x/docs/interfaces/ReadWriteLocker.html new file mode 100644 index 000000000..33a363b28 --- /dev/null +++ b/7.x/docs/interfaces/ReadWriteLocker.html @@ -0,0 +1,179 @@ +ReadWriteLocker | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ReadWriteLocker

+
+

Allows the locking of resources which is needed for non-atomic ResourceStores.

+
+
+
+

Hierarchy

+
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
withReadLock +withWriteLock +
+
+

Properties

+
+

withReadLock

+
withReadLock: (<T>(identifier, whileLocked) => Promise<T>)
+
+

Type declaration

+
    +
  • +
      +
    • <T>(identifier, whileLocked): Promise<T>
      • +
    • +

      Run the given function while the resource is locked. +The lock will be released when the (async) input function resolves. +This function should be used for operations that only require reading the resource.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        T

      +
      +

      Parameters

      +
      +

      Returns Promise<T>

      A promise resolving when the lock is released.

      + +
+
+

withWriteLock

+
withWriteLock: (<T>(identifier, whileLocked) => Promise<T>)
+
+

Type declaration

+
    +
  • +
      +
    • <T>(identifier, whileLocked): Promise<T>
      • +
    • +

      Run the given function while the resource is locked. +The lock will be released when the (async) input function resolves. +This function should be used for operations that could modify the resource.

      +
      +
      +

      Type Parameters

      +
        +
      • +

        T

      +
      +

      Parameters

      +
      +

      Returns Promise<T>

      A promise resolving when the lock is released.

      + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/RedirectHttpErrorClass.html b/7.x/docs/interfaces/RedirectHttpErrorClass.html new file mode 100644 index 000000000..76b85d160 --- /dev/null +++ b/7.x/docs/interfaces/RedirectHttpErrorClass.html @@ -0,0 +1,161 @@ +RedirectHttpErrorClass | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface RedirectHttpErrorClass<TCode>

+
+

Interface describing what a RedirectHttpError class should look like. +Makes sure a location value is always needed.

+
+
+
+

Type Parameters

+
    +
  • +

    TCode extends number = number

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
isInstance +statusCode +uri +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Readonly isInstance

+
isInstance: ((error) => error is HttpError<TCode>)
+
+

Type declaration

+
    +
  • +
      +
    • (error): error is HttpError<TCode>
      • +
    • +

      Checks whether the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: unknown
      +

      Returns error is HttpError<TCode>

      +
+
+

Readonly statusCode

+
statusCode: TCode
+

The status code corresponding to this error class.

+
+
+
+

Readonly uri

+
uri: NamedNode<string>
+

A unique URI identifying this error class.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/RedisSettings.html b/7.x/docs/interfaces/RedisSettings.html new file mode 100644 index 000000000..a05a452cf --- /dev/null +++ b/7.x/docs/interfaces/RedisSettings.html @@ -0,0 +1,106 @@ +RedisSettings | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface RedisSettings

+
+

Hierarchy

+
    +
  • RedisSettings
+
+
+
+ +
+
+

Properties

+
db? +namespacePrefix? +password? +username? +
+
+

Properties

+
+

Optional db

+
db?: number
+
+

Optional namespacePrefix

+
namespacePrefix?: string
+
+

Optional password

+
password?: string
+
+

Optional username

+
username?: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/Representation.html b/7.x/docs/interfaces/Representation.html new file mode 100644 index 000000000..418dfe3f4 --- /dev/null +++ b/7.x/docs/interfaces/Representation.html @@ -0,0 +1,131 @@ +Representation | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface Representation

+
+

A representation of a resource.

+
+
+
+

Hierarchy

+
    +
  • Representation +
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
binary +data +isEmpty +metadata +
+
+

Properties

+
+

binary

+
binary: boolean
+

Whether the data stream consists of binary/string chunks +(as opposed to complex objects).

+
+
+
+

data

+
data: Guarded<Readable>
+

The raw data stream for this representation.

+
+
+
+

isEmpty

+
isEmpty: boolean
+

Whether the data stream is empty. +This being true does not imply that the data stream has a length of more than 0, +only that it is a possibility and should be read to be sure.

+
+
+
+

metadata

+
metadata: RepresentationMetadata
+

The corresponding metadata.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/RepresentationConverterArgs.html b/7.x/docs/interfaces/RepresentationConverterArgs.html new file mode 100644 index 000000000..3b9ed10cf --- /dev/null +++ b/7.x/docs/interfaces/RepresentationConverterArgs.html @@ -0,0 +1,108 @@ +RepresentationConverterArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface RepresentationConverterArgs

+
+

Hierarchy

+
    +
  • RepresentationConverterArgs
+
+
+
+ +
+
+

Properties

+
identifier +preferences +representation +
+
+

Properties

+
+

identifier

+
identifier: ResourceIdentifier
+

Identifier of the resource. Can be used as base IRI.

+
+
+
+

preferences

+
preferences: RepresentationPreferences
+

Preferences indicating what is requested.

+
+
+
+

representation

+
representation: Representation
+

Representation to convert.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/RepresentationPatcherInput.html b/7.x/docs/interfaces/RepresentationPatcherInput.html new file mode 100644 index 000000000..93bee4aa4 --- /dev/null +++ b/7.x/docs/interfaces/RepresentationPatcherInput.html @@ -0,0 +1,104 @@ +RepresentationPatcherInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface RepresentationPatcherInput<T>

+
+

Type Parameters

+
    +
  • +

    T

+
+

Hierarchy

+
    +
  • RepresentationPatcherInput
+
+
+
+ +
+
+

Properties

+
identifier +patch +representation? +
+
+

Properties

+
+

identifier

+
identifier: ResourceIdentifier
+
+

patch

+
patch: Patch
+
+

Optional representation

+
representation?: T
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/RepresentationPreferences.html b/7.x/docs/interfaces/RepresentationPreferences.html new file mode 100644 index 000000000..ba8475ab8 --- /dev/null +++ b/7.x/docs/interfaces/RepresentationPreferences.html @@ -0,0 +1,133 @@ +RepresentationPreferences | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface RepresentationPreferences

+
+

Contains preferences along multiple content negotiation dimensions.

+

All dimensions are optional for ease of constructing; either undefined +or an empty ValuePreferences can indicate that no preferences were specified.

+
+
+
+

Hierarchy

+
    +
  • RepresentationPreferences
+
+
+
+ +
+
+

Properties

+
charset? +datetime? +encoding? +language? +range? +type? +
+
+

Properties

+
+

Optional charset

+
charset?: ValuePreferences
+
+

Optional datetime

+
datetime?: ValuePreferences
+
+

Optional encoding

+
encoding?: ValuePreferences
+
+

Optional language

+
language?: ValuePreferences
+
+

Optional range

+
range?: {
    parts: {
        end?: number;
        start: number;
    }[];
    unit: string;
}
+
+

Type declaration

+
    +
  • +
    parts: {
        end?: number;
        start: number;
    }[]
    • +
  • +
    unit: string
+
+

Optional type

+
type?: ValuePreferences
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/Resource.html b/7.x/docs/interfaces/Resource.html new file mode 100644 index 000000000..bf872ca8e --- /dev/null +++ b/7.x/docs/interfaces/Resource.html @@ -0,0 +1,92 @@ +Resource | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface Resource

+
+

Hierarchy

+
    +
  • Resource
+
+
+
+ +
+
+

Properties

+
identifier +representation +
+
+

Properties

+
+

identifier

+
identifier: ResourceIdentifier
+
+

representation

+
representation: Representation
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ResourceIdentifier.html b/7.x/docs/interfaces/ResourceIdentifier.html new file mode 100644 index 000000000..167efa056 --- /dev/null +++ b/7.x/docs/interfaces/ResourceIdentifier.html @@ -0,0 +1,92 @@ +ResourceIdentifier | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ResourceIdentifier

+
+

The unique identifier of a resource.

+
+
+
+

Hierarchy

+
    +
  • ResourceIdentifier
+
+
+
+ +
+
+

Properties

+
path +
+
+

Properties

+
+

path

+
path: string
+

Path to the relevant resource.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ResourceLink.html b/7.x/docs/interfaces/ResourceLink.html new file mode 100644 index 000000000..6c72bb030 --- /dev/null +++ b/7.x/docs/interfaces/ResourceLink.html @@ -0,0 +1,118 @@ +ResourceLink | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ResourceLink

+
+

Hierarchy

+
    +
  • ResourceLink
+
+
+
+ +
+
+

Properties

+
contentType? +filePath +identifier +isMetadata +
+
+

Properties

+
+

Optional contentType

+
contentType?: string
+

Content-type for a document (not defined for containers).

+
+
+
+

filePath

+
filePath: string
+

File path of a resource.

+
+
+
+

identifier

+
identifier: ResourceIdentifier
+

Identifier of a resource.

+
+
+
+

isMetadata

+
isMetadata: boolean
+

If the resource is a metadata file.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ResourceLocker.html b/7.x/docs/interfaces/ResourceLocker.html new file mode 100644 index 000000000..b1c719764 --- /dev/null +++ b/7.x/docs/interfaces/ResourceLocker.html @@ -0,0 +1,145 @@ +ResourceLocker | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ResourceLocker

+
+

An interface for classes that only have 1 way to lock interfaces. +In general this should only be used by components implementing the ReadWriteLocker interface. +Other components that require locking of resources should use that interface.

+
+
+
+

Hierarchy

+
    +
  • ResourceLocker
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
acquire +release +
+
+

Properties

+
+

acquire

+
acquire: ((identifier) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): Promise<void>
      • +
    • +

      Acquires a lock on the requested identifier. +The promise will resolve when the lock has been acquired.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<void>

      +
+
+

release

+
release: ((identifier) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): Promise<void>
      • +
    • +

      Releases a lock on the requested identifier. +The promise will resolve when the lock has been released. +If there is no lock on the resource, an error should be thrown.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<void>

      +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ResourceSet.html b/7.x/docs/interfaces/ResourceSet.html new file mode 100644 index 000000000..4d7e1cc43 --- /dev/null +++ b/7.x/docs/interfaces/ResourceSet.html @@ -0,0 +1,115 @@ +ResourceSet | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ResourceSet

+
+

A set containing resources.

+
+
+
+

Hierarchy

+
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
hasResource +
+
+

Properties

+
+

hasResource

+
hasResource: ((identifier) => Promise<boolean>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): Promise<boolean>
      • +
    • +

      Checks whether a resource exists in this ResourceSet.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<boolean>

      A promise resolving if the resource already exists.

      + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ResourceStore.html b/7.x/docs/interfaces/ResourceStore.html new file mode 100644 index 000000000..dcfe28d9e --- /dev/null +++ b/7.x/docs/interfaces/ResourceStore.html @@ -0,0 +1,311 @@ +ResourceStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ResourceStore

+
+

A ResourceStore represents a collection of resources. +It has been designed such that each of its methods +can be implemented in an atomic way: for each CRUD operation, only one +dedicated method needs to be called. A fifth method enables the optimization +of partial updates with PATCH. It is up to the implementer of the interface to +(not) make an implementation atomic.

+

ResourceStores are also responsible for taking auxiliary resources into account +should those be relevant to the store.

+
+
+
+

Hierarchy

+
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
addResource +deleteResource +getRepresentation +hasResource +modifyResource +setRepresentation +
+
+

Properties

+
+

addResource

+
addResource: ((container, representation, conditions?) => Promise<ChangeMap>)
+
+

Type declaration

+
    +
  • +
      +
    • (container, representation, conditions?): Promise<ChangeMap>
      • +
    • +

      Creates a new resource in the container.

      +
      +
      +

      Parameters

      +
        +
      • +
        container: ResourceIdentifier
        +

        Container in which to create a resource.

        +
        +
        • +
      • +
        representation: Representation
        +

        Representation of the new resource

        +
        +
        • +
      • +
        Optional conditions: Conditions
        +

        Optional conditions under which to proceed.

        +
        +
      +

      Returns Promise<ChangeMap>

      A ChangeMap.

      + +
+
+

deleteResource

+
deleteResource: ((identifier, conditions?) => Promise<ChangeMap>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier, conditions?): Promise<ChangeMap>
      • +
    • +

      Deletes a resource.

      +
      +
      +

      Parameters

      +
        +
      • +
        identifier: ResourceIdentifier
        +

        Identifier of resource to delete.

        +
        +
        • +
      • +
        Optional conditions: Conditions
        +

        Optional conditions under which to proceed.

        +
        +
      +

      Returns Promise<ChangeMap>

      A ChangeMap.

      + +
+
+

getRepresentation

+
getRepresentation: ((identifier, preferences, conditions?) => Promise<Representation>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier, preferences, conditions?): Promise<Representation>
      • +
    • +

      Retrieves a representation of a resource.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<Representation>

      A representation corresponding to the identifier.

      + +
+
+

hasResource

+
hasResource: ((identifier) => Promise<boolean>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): Promise<boolean>
      • +
    • +

      Checks whether a resource exists in this ResourceSet.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<boolean>

      A promise resolving if the resource already exists.

      + +
+
+

modifyResource

+
modifyResource: ((identifier, patch, conditions?) => Promise<ChangeMap>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier, patch, conditions?): Promise<ChangeMap>
      • +
    • +

      Sets or updates the representation of a resource, +creating a new resource and intermediary containers as needed.

      +
      +
      +

      Parameters

      +
        +
      • +
        identifier: ResourceIdentifier
        +

        Identifier of resource to update.

        +
        +
        • +
      • +
        patch: Patch
        +

        Description of which parts to update.

        +
        +
        • +
      • +
        Optional conditions: Conditions
        +

        Optional conditions under which to proceed.

        +
        +
      +

      Returns Promise<ChangeMap>

      A ChangeMap.

      + +
+
+

setRepresentation

+
setRepresentation: ((identifier, representation, conditions?) => Promise<ChangeMap>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier, representation, conditions?): Promise<ChangeMap>
      • +
    • +

      Sets or replaces the representation of a resource, +creating a new resource and intermediary containers as needed.

      +
      +
      +

      Parameters

      +
        +
      • +
        identifier: ResourceIdentifier
        +

        Identifier of resource to update.

        +
        +
        • +
      • +
        representation: Representation
        +

        New representation of the resource.

        +
        +
        • +
      • +
        Optional conditions: Conditions
        +

        Optional conditions under which to proceed.

        +
        +
      +

      Returns Promise<ChangeMap>

      A ChangeMap.

      + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/ResourcesGenerator.html b/7.x/docs/interfaces/ResourcesGenerator.html new file mode 100644 index 000000000..f7399abe6 --- /dev/null +++ b/7.x/docs/interfaces/ResourcesGenerator.html @@ -0,0 +1,120 @@ +ResourcesGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface ResourcesGenerator

+
+

Generator used to create resources relative to a given base identifier. +Note that this is not an AsyncHandler since it returns an AsyncIterable instead of a promise.

+
+
+
+

Hierarchy

+
    +
  • ResourcesGenerator
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
generate +
+
+

Properties

+
+

generate

+
generate: ((location, options) => AsyncIterable<Resource>)
+
+

Type declaration

+
    +
  • +
      +
    • (location, options): AsyncIterable<Resource>
      • +
    • +

      Generates resources with the given options. +The output Iterable should be sorted so that containers always appear before their contents.

      +
      +
      +

      Parameters

      +
        +
      • +
        location: ResourceIdentifier
        +

        Base identifier.

        +
        +
        • +
      • +
        options: Dict<unknown>
        +

        Options that can be used when generating resources.

        +
        +
      +

      Returns AsyncIterable<Resource>

      A map where the keys are the identifiers and the values the corresponding representations to store.

      + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/RouterHandlerArgs.html b/7.x/docs/interfaces/RouterHandlerArgs.html new file mode 100644 index 000000000..35a9978da --- /dev/null +++ b/7.x/docs/interfaces/RouterHandlerArgs.html @@ -0,0 +1,136 @@ +RouterHandlerArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface RouterHandlerArgs

+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
allowedMethods? +allowedPathNames? +baseUrl? +handler +targetExtractor +
+
+

Properties

+
+

Optional allowedMethods

+
allowedMethods?: string[]
+

The allowed method(s). * can be used to indicate all methods are allowed. +Default is [ '*' ].

+
+
+
+

Optional allowedPathNames

+
allowedPathNames?: string[]
+

Regular expression(s) used to match the target URL. +The base URl without trailing slash will be stripped of before applying the regular expressions, +so the input will always start with a /. +Default is [ '.*' ].

+
+
+
+

Optional baseUrl

+
baseUrl?: string
+

The base URL of the server. +Not required if no value is provided for allowedPathNames.

+
+
+
+

handler

+
handler: HttpHandler
+

The handler to call if all checks pass.

+
+
+
+

targetExtractor

+
targetExtractor: TargetExtractor
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/SeededAccountInitializerArgs.html b/7.x/docs/interfaces/SeededAccountInitializerArgs.html new file mode 100644 index 000000000..fef513e4b --- /dev/null +++ b/7.x/docs/interfaces/SeededAccountInitializerArgs.html @@ -0,0 +1,118 @@ +SeededAccountInitializerArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface SeededAccountInitializerArgs

+
+

Hierarchy

+
    +
  • SeededAccountInitializerArgs
+
+
+
+ +
+
+

Properties

+
accountStore +configFilePath? +passwordStore +podCreator +
+
+

Properties

+
+

accountStore

+
accountStore: AccountStore
+

Creates the accounts.

+
+
+
+

Optional configFilePath

+
configFilePath?: string
+

File path of the JSON describing the accounts to seed.

+
+
+
+

passwordStore

+
passwordStore: PasswordStore
+

Adds the login methods.

+
+
+
+

podCreator

+
podCreator: PodCreator
+

Creates the pods.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/SetMultiMap.html b/7.x/docs/interfaces/SetMultiMap.html new file mode 100644 index 000000000..c245a28ef --- /dev/null +++ b/7.x/docs/interfaces/SetMultiMap.html @@ -0,0 +1,474 @@ +SetMultiMap | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface SetMultiMap<TKey, TVal>

+
+

A SetMultiMap is a Map where a single key can have multiple unique values. +Deleting a key removes all bindings with this key from the Map. +Setting a value for a key replaces all previous bindings with this key. +Using an empty Set when calling the set function is the same as deleting that key.

+
+
+
+

Type Parameters

+
    +
  • +

    TKey

    • +
  • +

    TVal

+
+

Hierarchy

+
    +
  • Map<TKey, TVal | ReadonlySet<TVal>> +
      +
    • SetMultiMap
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
[iterator] +[toStringTag] +add +asMap +deleteEntry +distinctKeys +entries +entrySets +forEach +get +hasEntry +size +valueSets +values +
+
+

Methods

+
clear +delete +has +keys +set +
+
+

Properties

+
+

[iterator]

+
[iterator]: (() => IterableIterator<[TKey, TVal]>)
+
+

Type declaration

+
    +
  • +
      +
    • (): IterableIterator<[TKey, TVal]>
      • +
    • +

      Iterates over all key/value bindings in this Map.

      +
      +

      Returns IterableIterator<[TKey, TVal]>

      +
+
+

Readonly [toStringTag]

+
[toStringTag]: string
+
+

add

+
add: ((key, value) => SetMultiMap<TKey, TVal>)
+
+

Type declaration

+
    +
  • +
      +
    • (key, value): SetMultiMap<TKey, TVal>
      • +
    • +

      Adds the given key/value binding to the Map.

      +
      +
      +

      Parameters

      +
        +
      • +
        key: TKey
        • +
      • +
        value: TVal | ReadonlySet<TVal>
      +

      Returns SetMultiMap<TKey, TVal>

      +
+
+

asMap

+
asMap: (() => ReadonlyMap<TKey, ReadonlySet<TVal>>)
+
+

Type declaration

+
    +
  • +
      +
    • (): ReadonlyMap<TKey, ReadonlySet<TVal>>
      • +
    • +

      Returns a Readonly Map representation of this Map.

      +
      +

      Returns ReadonlyMap<TKey, ReadonlySet<TVal>>

      +
+
+

deleteEntry

+
deleteEntry: ((key, value) => boolean)
+
+

Type declaration

+
    +
  • +
      +
    • (key, value): boolean
      • +
    • +

      Deletes the given key/value binding from the Map.

      +
      +
      +

      Parameters

      +
        +
      • +
        key: TKey
        • +
      • +
        value: TVal
      +

      Returns boolean

      +
+
+

distinctKeys

+
distinctKeys: (() => IterableIterator<TKey>)
+
+

Type declaration

+
    +
  • +
      +
    • (): IterableIterator<TKey>
      • +
    • +

      Iterates over all distinct keys in this Map.

      +
      +

      Returns IterableIterator<TKey>

      +
+
+

entries

+
entries: (() => IterableIterator<[TKey, TVal]>)
+
+

Type declaration

+
    +
  • +
      +
    • (): IterableIterator<[TKey, TVal]>
      • +
    • +

      Iterates over all key/value bindings in this Map.

      +
      +

      Returns IterableIterator<[TKey, TVal]>

      +
+
+

entrySets

+
entrySets: (() => IterableIterator<[TKey, ReadonlySet<TVal>]>)
+
+

Type declaration

+
    +
  • +
      +
    • (): IterableIterator<[TKey, ReadonlySet<TVal>]>
      • +
    • +

      Iterates over all distinct keys in this Map, together with a Set of their values.

      +
      +

      Returns IterableIterator<[TKey, ReadonlySet<TVal>]>

      +
+
+

forEach

+
forEach: ((callbackfn, thisArg?) => void)
+
+

Type declaration

+
    +
  • +
      +
    • (callbackfn, thisArg?): void
      • +
    • +

      Loops over all key/value bindings.

      +
      +
      +

      Parameters

      +
        +
      • +
        callbackfn: ((value, key, map) => void)
        +
          +
        • +
            +
          • (value, key, map): void
            • +
          • +
            +

            Parameters

            +
              +
            • +
              value: TVal
              • +
            • +
              key: TKey
              • +
            • +
              map: SetMultiMap<TKey, TVal>
            +

            Returns void

        • +
      • +
        Optional thisArg: unknown
      +

      Returns void

      +
+
+

get

+
get: ((key) => undefined | ReadonlySet<TVal>)
+
+

Type declaration

+
    +
  • +
      +
    • (key): undefined | ReadonlySet<TVal>
      • +
    • +

      Returns all values stored for the given key. +Returns undefined if there are no values for this key.

      +
      +
      +

      Parameters

      +
        +
      • +
        key: TKey
      +

      Returns undefined | ReadonlySet<TVal>

      +
+
+

hasEntry

+
hasEntry: ((key, value) => boolean)
+
+

Type declaration

+
    +
  • +
      +
    • (key, value): boolean
      • +
    • +

      Returns true if this key/value binding exists in the Map.

      +
      +
      +

      Parameters

      +
        +
      • +
        key: TKey
        • +
      • +
        value: TVal
      +

      Returns boolean

      +
+
+

Readonly size

+
size: number
+
+

Returns

the number of elements in the Map.

+
+
+

valueSets

+
valueSets: (() => IterableIterator<ReadonlySet<TVal>>)
+
+

Type declaration

+
    +
  • +
      +
    • (): IterableIterator<ReadonlySet<TVal>>
      • +
    • +

      Iterates over all distinct keys and returns their Set of values.

      +
      +

      Returns IterableIterator<ReadonlySet<TVal>>

      +
+
+

values

+
values: (() => IterableIterator<TVal>)
+
+

Type declaration

+
    +
  • +
      +
    • (): IterableIterator<TVal>
      • +
    • +

      Iterates over all values in this Map.

      +
      +

      Returns IterableIterator<TVal>

      +
+
+

Methods

+
+

clear

+
    + +
  • +

    Returns void

+
+

delete

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      key: TKey
    +

    Returns boolean

    true if an element in the Map existed and has been removed, or false if the element does not exist.

    + +
+
+

has

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      key: TKey
    +

    Returns boolean

    boolean indicating whether an element with the specified key exists or not.

    + +
+
+

keys

+
    + +
  • +

    Returns an iterable of keys in the map

    +
    +

    Returns IterableIterator<TKey>

    +
+
+

set

+
    + +
  • +

    Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.

    +
    +
    +

    Parameters

    +
      +
    • +
      key: TKey
      • +
    • +
      value: TVal | ReadonlySet<TVal>
    +

    Returns SetMultiMap<TKey, TVal>

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/SimpleLogger.html b/7.x/docs/interfaces/SimpleLogger.html new file mode 100644 index 000000000..a4428e340 --- /dev/null +++ b/7.x/docs/interfaces/SimpleLogger.html @@ -0,0 +1,123 @@ +SimpleLogger | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface SimpleLogger

+
+

Logs messages on a specific level.

+
+
+

See

getLoggerFor on how to instantiate loggers.

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
log +
+
+

Properties

+
+

log

+
log: ((level, message, meta?) => SimpleLogger)
+
+

Type declaration

+
    +
  • +
      +
    • (level, message, meta?): SimpleLogger
      • +
    • +

      Log the given message at the given level. +If the internal level is higher than the given level, the message may be voided.

      +
      +
      +

      Parameters

      +
        +
      • +
        level: "error" | "warn" | "info" | "verbose" | "debug" | "silly"
        +

        The level to log at.

        +
        +
        • +
      • +
        message: string
        +

        The message to log.

        +
        +
        • +
      • +
        Optional meta: LogMetadata
        +

        Optional metadata to include in the log message.

        +
        +
      +

      Returns SimpleLogger

      +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/SingleThreaded.html b/7.x/docs/interfaces/SingleThreaded.html new file mode 100644 index 000000000..3e31235ba --- /dev/null +++ b/7.x/docs/interfaces/SingleThreaded.html @@ -0,0 +1,76 @@ +SingleThreaded | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface SingleThreaded

+
+

Indicates a class is only meant to work in singlethreaded setups and is thus not threadsafe.

+
+
+
+

Hierarchy

+
    +
  • SingleThreaded
+
+

Implemented by

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/Size.html b/7.x/docs/interfaces/Size.html new file mode 100644 index 000000000..c23fcf210 --- /dev/null +++ b/7.x/docs/interfaces/Size.html @@ -0,0 +1,96 @@ +Size | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface Size

+
+

Describes the size of something by stating how much of a certain unit is present.

+
+
+
+

Hierarchy

+
    +
  • Size
+
+
+
+ +
+
+

Properties

+
amount +unit +
+
+

Properties

+
+

amount

+
amount: number
+
+

unit

+
unit: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/SizeReporter.html b/7.x/docs/interfaces/SizeReporter.html new file mode 100644 index 000000000..8a344b1a1 --- /dev/null +++ b/7.x/docs/interfaces/SizeReporter.html @@ -0,0 +1,196 @@ +SizeReporter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface SizeReporter<T>

+
+

A SizeReporter's only purpose (at the moment) is to calculate the size +of a resource. How the size is calculated or what unit it is in is defined by +the class implementing this interface. +One might use the amount of bytes and another might use the amount of triples +stored in a resource.

+
+
+
+

Type Parameters

+
    +
  • +

    T

+
+

Hierarchy

+
    +
  • SizeReporter
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
calculateChunkSize +estimateSize +getSize +getUnit +
+
+

Properties

+
+

calculateChunkSize

+
calculateChunkSize: ((chunk) => Promise<number>)
+
+

Type declaration

+
    +
  • +
      +
    • (chunk): Promise<number>
      • +
    • +

      Calculate the size of a chunk based on which SizeReporter is being used

      +
      +
      +

      Parameters

      +
        +
      • +
        chunk: T
        +

        the chunk of which you want the size

        +
        +
      +

      Returns Promise<number>

      the size of the passed chunk as a number

      + +
+
+

estimateSize

+
estimateSize: ((metadata) => Promise<undefined | number>)
+
+

Type declaration

+
    +
  • +
      +
    • (metadata): Promise<undefined | number>
      • +
    • +

      Estimate the size of a body / request by looking at its metadata

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<undefined | number>

      the estimated size of the body / request or undefined if no +meaningful estimation can be made

      + +
+
+

getSize

+
getSize: ((identifier) => Promise<Size>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): Promise<Size>
      • +
    • +

      Get the size of a given resource

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<Size>

      The size of the resource as a Size object calculated recursively +if the identifier leads to a container

      + +
+
+

getUnit

+
getUnit: (() => string)
+
+

Type declaration

+
    +
  • +
      +
    • (): string
      • +
    • +

      Get the unit as a string in which a SizeReporter returns data

      +
      +

      Returns string

      +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/SliceStreamOptions.html b/7.x/docs/interfaces/SliceStreamOptions.html new file mode 100644 index 000000000..bdf898863 --- /dev/null +++ b/7.x/docs/interfaces/SliceStreamOptions.html @@ -0,0 +1,432 @@ +SliceStreamOptions | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface SliceStreamOptions

+
+

Hierarchy

+
    +
  • TransformOptions +
      +
    • SliceStreamOptions
+
+
+
+ +
+
+

Properties

+
allowHalfOpen? +autoDestroy? +decodeStrings? +defaultEncoding? +emitClose? +encoding? +end? +highWaterMark? +objectMode? +readableHighWaterMark? +readableObjectMode? +signal? +size? +start +writableCorked? +writableHighWaterMark? +writableObjectMode? +
+
+

Methods

+
construct? +destroy? +final? +flush? +read? +transform? +write? +writev? +
+
+

Properties

+
+

Optional allowHalfOpen

+
allowHalfOpen?: boolean
+
+

Optional autoDestroy

+
autoDestroy?: boolean
+
+

Optional decodeStrings

+
decodeStrings?: boolean
+
+

Optional defaultEncoding

+
defaultEncoding?: BufferEncoding
+
+

Optional emitClose

+
emitClose?: boolean
+
+

Optional encoding

+
encoding?: BufferEncoding
+
+

Optional end

+
end?: number
+
+

Optional highWaterMark

+
highWaterMark?: number
+
+

Optional objectMode

+
objectMode?: boolean
+
+

Optional readableHighWaterMark

+
readableHighWaterMark?: number
+
+

Optional readableObjectMode

+
readableObjectMode?: boolean
+
+

Optional signal

+
signal?: AbortSignal
+

When provided the corresponding AbortController can be used to cancel an asynchronous action.

+
+
+
+

Optional size

+
size?: number
+
+

start

+
start: number
+
+

Optional writableCorked

+
writableCorked?: number
+
+

Optional writableHighWaterMark

+
writableHighWaterMark?: number
+
+

Optional writableObjectMode

+
writableObjectMode?: boolean
+
+

Methods

+
+

Optional construct

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      this: Transform
      • +
    • +
      callback: ((error?) => void)
      +
        +
      • +
          +
        • (error?): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Optional error: null | Error
          +

          Returns void

    +

    Returns void

+
+

Optional destroy

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      this: Transform
      • +
    • +
      error: null | Error
      • +
    • +
      callback: ((error) => void)
      +
        +
      • +
          +
        • (error): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            error: null | Error
          +

          Returns void

    +

    Returns void

+
+

Optional final

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      this: Transform
      • +
    • +
      callback: ((error?) => void)
      +
        +
      • +
          +
        • (error?): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Optional error: null | Error
          +

          Returns void

    +

    Returns void

+
+

Optional flush

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      this: Transform
      • +
    • +
      callback: TransformCallback
    +

    Returns void

+
+

Optional read

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      this: Transform
      • +
    • +
      size: number
    +

    Returns void

+
+

Optional transform

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      this: Transform
      • +
    • +
      chunk: any
      • +
    • +
      encoding: BufferEncoding
      • +
    • +
      callback: TransformCallback
    +

    Returns void

+
+

Optional write

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      this: Transform
      • +
    • +
      chunk: any
      • +
    • +
      encoding: BufferEncoding
      • +
    • +
      callback: ((error?) => void)
      +
        +
      • +
          +
        • (error?): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Optional error: null | Error
          +

          Returns void

    +

    Returns void

+
+

Optional writev

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      this: Transform
      • +
    • +
      chunks: {
          chunk: any;
          encoding: BufferEncoding;
      }[]
      • +
    • +
      callback: ((error?) => void)
      +
        +
      • +
          +
        • (error?): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Optional error: null | Error
          +

          Returns void

    +

    Returns void

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/SparqlUpdatePatch.html b/7.x/docs/interfaces/SparqlUpdatePatch.html new file mode 100644 index 000000000..bea821d11 --- /dev/null +++ b/7.x/docs/interfaces/SparqlUpdatePatch.html @@ -0,0 +1,141 @@ +SparqlUpdatePatch | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface SparqlUpdatePatch

+
+

A specific type of Patch corresponding to a SPARQL update.

+
+
+
+

Hierarchy

+
    +
  • Patch +
      +
    • SparqlUpdatePatch
+
+
+
+ +
+
+

Properties

+
algebra +binary +data +isEmpty +metadata +
+
+

Properties

+
+

algebra

+
algebra: Update
+

Algebra corresponding to the SPARQL update.

+
+
+
+

binary

+
binary: boolean
+

Whether the data stream consists of binary/string chunks +(as opposed to complex objects).

+
+
+
+

data

+
data: Guarded<Readable>
+

The raw data stream for this representation.

+
+
+
+

isEmpty

+
isEmpty: boolean
+

Whether the data stream is empty. +This being true does not imply that the data stream has a length of more than 0, +only that it is a possibility and should be read to be sure.

+
+
+
+

metadata

+
metadata: RepresentationMetadata
+

The corresponding metadata.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/StorageLocationStrategy.html b/7.x/docs/interfaces/StorageLocationStrategy.html new file mode 100644 index 000000000..a25539fdd --- /dev/null +++ b/7.x/docs/interfaces/StorageLocationStrategy.html @@ -0,0 +1,111 @@ +StorageLocationStrategy | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface StorageLocationStrategy

+
+

Interface used to find the storage a specific identifier is located in.

+
+
+
+

Hierarchy

+
    +
  • StorageLocationStrategy
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
getStorageIdentifier +
+
+

Properties

+
+

getStorageIdentifier

+
getStorageIdentifier: ((identifier) => Promise<ResourceIdentifier>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): Promise<ResourceIdentifier>
      • +
    • +

      Returns the identifier of the storage that contains the given resource. +Can error if the input identifier is not part of any storage.

      +
      +
      +

      Parameters

      +
      +

      Returns Promise<ResourceIdentifier>

      +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/StreamingHttpEmitterInput.html b/7.x/docs/interfaces/StreamingHttpEmitterInput.html new file mode 100644 index 000000000..e54328eec --- /dev/null +++ b/7.x/docs/interfaces/StreamingHttpEmitterInput.html @@ -0,0 +1,92 @@ +StreamingHttpEmitterInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface StreamingHttpEmitterInput

+
+

Hierarchy

+
    +
  • StreamingHttpEmitterInput
+
+
+
+ +
+
+

Properties

+
channel +representation +
+
+

Properties

+
+

channel

+
channel: NotificationChannel
+
+

representation

+
representation: Representation
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/SubfolderResourcesGeneratorArgs.html b/7.x/docs/interfaces/SubfolderResourcesGeneratorArgs.html new file mode 100644 index 000000000..f5a93c9f3 --- /dev/null +++ b/7.x/docs/interfaces/SubfolderResourcesGeneratorArgs.html @@ -0,0 +1,133 @@ +SubfolderResourcesGeneratorArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface SubfolderResourcesGeneratorArgs

+
+

Input arguments required for BaseResourcesGenerator

+
+
+
+

Hierarchy

+
    +
  • SubfolderResourcesGeneratorArgs
+
+
+
+ +
+
+

Properties

+
factory +metadataStrategy +store +templateEngine +templateExtension? +
+
+

Properties

+
+

factory

+
factory: FileIdentifierMapperFactory<FileIdentifierMapper>
+

Factory used to generate mapper relative to the base identifier.

+
+
+
+

metadataStrategy

+
metadataStrategy: AuxiliaryStrategy
+

The metadataStrategy

+
+
+
+

store

+
store: ResourceSet
+

The default ResourceStore

+
+
+
+

templateEngine

+
templateEngine: TemplateEngine<Dict<unknown>>
+

Template engine for generating the resources.

+
+
+
+

Optional templateExtension

+
templateExtension?: string
+

The extension of files that need to be interpreted as templates. +Will be removed to generate the identifier.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/SubscriptionService.html b/7.x/docs/interfaces/SubscriptionService.html new file mode 100644 index 000000000..047713b16 --- /dev/null +++ b/7.x/docs/interfaces/SubscriptionService.html @@ -0,0 +1,111 @@ +SubscriptionService | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface SubscriptionService

+
+

A subscription service description as based on the specification data model +https://solidproject.org/TR/2022/notifications-protocol-20221231#subscription-service-data-model

+
+
+
+

Hierarchy

+
    +
  • SubscriptionService
+
+
+
+ +
+
+

Properties

+
@context +channelType +feature +id +
+
+

Properties

+
+

@context

+
@context: ["https://www.w3.org/ns/solid/notification/v1"]
+
+

channelType

+
channelType: string
+
+

feature

+
feature: string[]
+
+

id

+
id: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/SystemError.html b/7.x/docs/interfaces/SystemError.html new file mode 100644 index 000000000..34e0d99cc --- /dev/null +++ b/7.x/docs/interfaces/SystemError.html @@ -0,0 +1,192 @@ +SystemError | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface SystemError

+
+

Interface for Node.js System errors

+

Node.js generates system errors when exceptions occur within its runtime environment. +These usually occur when an application violates an operating system constraint. +For example, a system error will occur if an application attempts to read a file that does not exist.

+
+
+
+

Hierarchy

+
    +
  • Error +
      +
    • SystemError
+
+
+
+ +
+
+

Properties

+
address? +code +dest? +errno +info? +message +name +path? +port? +stack? +syscall +
+
+

Properties

+
+

Optional address

+
address?: string
+

If present, the address to which a network connection failed.

+
+
+
+

code

+
code: string
+

The string error code. +Full list: https://man7.org/linux/man-pages/man3/errno.3.html

+
+
+
+

Optional dest

+
dest?: string
+

If present, the file path destination when reporting a file system error.

+
+
+
+

errno

+
errno: string | number
+

The system-provided error number.

+
+
+
+

Optional info

+
info?: unknown
+

If present, extra details about the error condition.

+
+
+
+

message

+
message: string
+
+

name

+
name: string
+
+

Optional path

+
path?: string
+

If present, the file path when reporting a file system error.

+
+
+
+

Optional port

+
port?: string
+

If present, the network connection port that is not available.

+
+
+
+

Optional stack

+
stack?: string
+
+

syscall

+
syscall: string
+

The name of the system call that triggered the error.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/TemplateEngineInput.html b/7.x/docs/interfaces/TemplateEngineInput.html new file mode 100644 index 000000000..d115f52d2 --- /dev/null +++ b/7.x/docs/interfaces/TemplateEngineInput.html @@ -0,0 +1,101 @@ +TemplateEngineInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface TemplateEngineInput<T>

+
+

Utility interface for representing TemplateEngine input.

+
+
+
+

Type Parameters

+
    +
  • +

    T

+
+

Hierarchy

+
    +
  • TemplateEngineInput
+
+
+
+ +
+
+

Properties

+
contents +template? +
+
+

Properties

+
+

contents

+
contents: T
+
+

Optional template

+
template?: Template
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/TemplateOptions.html b/7.x/docs/interfaces/TemplateOptions.html new file mode 100644 index 000000000..e9a998ca6 --- /dev/null +++ b/7.x/docs/interfaces/TemplateOptions.html @@ -0,0 +1,106 @@ +TemplateOptions | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface TemplateOptions

+
+

Hierarchy

+
    +
  • TemplateOptions
+
+
+
+ +
+
+

Properties

+
codeTemplatesPath? +contentType? +extension? +mainTemplatePath? +
+
+

Properties

+
+

Optional codeTemplatesPath

+
codeTemplatesPath?: string
+
+

Optional contentType

+
contentType?: string
+
+

Optional extension

+
extension?: string
+
+

Optional mainTemplatePath

+
mainTemplatePath?: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/TemplatePath.html b/7.x/docs/interfaces/TemplatePath.html new file mode 100644 index 000000000..e1c7bdbbe --- /dev/null +++ b/7.x/docs/interfaces/TemplatePath.html @@ -0,0 +1,92 @@ +TemplatePath | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface TemplatePath

+
+

Hierarchy

+
    +
  • TemplatePath
+
+
+
+ +
+
+

Properties

+
templateFile +templatePath? +
+
+

Properties

+
+

templateFile

+
templateFile: string
+
+

Optional templatePath

+
templatePath?: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/TemplateString.html b/7.x/docs/interfaces/TemplateString.html new file mode 100644 index 000000000..c5cef12b5 --- /dev/null +++ b/7.x/docs/interfaces/TemplateString.html @@ -0,0 +1,85 @@ +TemplateString | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface TemplateString

+
+

Hierarchy

+
    +
  • TemplateString
+
+
+
+ +
+
+

Properties

+
templateString +
+
+

Properties

+
+

templateString

+
templateString: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/TemplatedResourcesGenerator.html b/7.x/docs/interfaces/TemplatedResourcesGenerator.html new file mode 100644 index 000000000..9d0838c1b --- /dev/null +++ b/7.x/docs/interfaces/TemplatedResourcesGenerator.html @@ -0,0 +1,127 @@ +TemplatedResourcesGenerator | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface TemplatedResourcesGenerator

+
+

Generator used to create resources relative to a given base identifier. +Similar to ResourcesGenerator, but takes as input a string +indicating where the templates are stored that need to be used for resource generation.

+
+
+
+

Hierarchy

+
    +
  • TemplatedResourcesGenerator
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
generate +
+
+

Properties

+
+

generate

+
generate: ((templateFolder, location, options) => AsyncIterable<Resource>)
+
+

Type declaration

+
    +
  • +
      +
    • (templateFolder, location, options): AsyncIterable<Resource>
      • +
    • +

      Generates resources with the given options, based on the given template folder. +The output Iterable should be sorted so that containers always appear before their contents.

      +
      +
      +

      Parameters

      +
        +
      • +
        templateFolder: string
        +

        Folder where the templates are located.

        +
        +
        • +
      • +
        location: ResourceIdentifier
        +

        Base identifier.

        +
        +
        • +
      • +
        options: Dict<unknown>
        +

        Options that can be used when generating resources.

        +
        +
      +

      Returns AsyncIterable<Resource>

      A map where the keys are the identifiers and the values the corresponding representations to store.

      + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/V6MigrationInitializerArgs.html b/7.x/docs/interfaces/V6MigrationInitializerArgs.html new file mode 100644 index 000000000..4761ab169 --- /dev/null +++ b/7.x/docs/interfaces/V6MigrationInitializerArgs.html @@ -0,0 +1,159 @@ +V6MigrationInitializerArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface V6MigrationInitializerArgs

+
+

Hierarchy

+
    +
  • V6MigrationInitializerArgs
+
+
+
+ +
+
+

Properties

+
accountStorage +cleanupStorages +clientCredentialsStorage +newAccountStorage +newSetupStorage +setupStorage +skipConfirmation? +versionKey +
+
+

Properties

+
+

accountStorage

+
accountStorage: KeyValueStorage<string, Account | Settings>
+

The storage in which account data of the previous version is stored.

+
+
+
+

cleanupStorages

+
cleanupStorages: KeyValueStorage<string, any>[]
+

Storages for which all entries need to be removed.

+
+
+
+

clientCredentialsStorage

+
clientCredentialsStorage: KeyValueStorage<string, ClientCredentials>
+

The storage in which client credentials are stored from the previous version.

+
+
+
+

newAccountStorage

+
newAccountStorage: AccountLoginStorage<Record<string, never>>
+

The storage that will contain the account data in the new format. +Wrong typings to prevent Components.js typing issues.

+
+
+
+

newSetupStorage

+
newSetupStorage: KeyValueStorage<string, string>
+

The storage that will contain the setup entries in the new format.

+
+
+
+

setupStorage

+
setupStorage: KeyValueStorage<string, string>
+

The storage in which all setup values are stored, including the version of the server.

+
+
+
+

Optional skipConfirmation

+
skipConfirmation?: boolean
+

If true, no confirmation prompt will be printed to the stdout.

+
+
+
+

versionKey

+
versionKey: string
+

The key necessary to get the version from the setupStorage.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/WacAllowHttpHandlerArgs.html b/7.x/docs/interfaces/WacAllowHttpHandlerArgs.html new file mode 100644 index 000000000..b036e0212 --- /dev/null +++ b/7.x/docs/interfaces/WacAllowHttpHandlerArgs.html @@ -0,0 +1,106 @@ +WacAllowHttpHandlerArgs | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface WacAllowHttpHandlerArgs

+
+

Hierarchy

+
    +
  • WacAllowHttpHandlerArgs
+
+
+
+ +
+
+

Properties

+
credentialsExtractor +modesExtractor +operationHandler +permissionReader +
+
+

Properties

+
+

credentialsExtractor

+
credentialsExtractor: CredentialsExtractor
+
+

modesExtractor

+
modesExtractor: ModesExtractor
+
+

operationHandler

+
operationHandler: OperationHttpHandler
+
+

permissionReader

+
permissionReader: PermissionReader
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/WebIdStore.html b/7.x/docs/interfaces/WebIdStore.html new file mode 100644 index 000000000..2d78b5b6c --- /dev/null +++ b/7.x/docs/interfaces/WebIdStore.html @@ -0,0 +1,221 @@ +WebIdStore | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface WebIdStore

+
+

Stores and updates WebID to Account links.

+
+
+
+

Hierarchy

+
    +
  • WebIdStore
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
create +delete +findLinks +get +isLinked +
+
+

Properties

+
+

create

+
create: ((webId, accountId) => Promise<string>)
+
+

Type declaration

+
    +
  • +
      +
    • (webId, accountId): Promise<string>
      • +
    • +

      Creates a new WebID link for the given WebID and account.

      +
      +
      +

      Parameters

      +
        +
      • +
        webId: string
        +

        WebID to link.

        +
        +
        • +
      • +
        accountId: string
      +

      Returns Promise<string>

      ID of the link.

      + +
+
+

delete

+
delete: ((linkId) => Promise<void>)
+
+

Type declaration

+
    +
  • +
      +
    • (linkId): Promise<void>
      • +
    • +

      Deletes the link with the given ID

      +
      +
      +

      Parameters

      +
        +
      • +
        linkId: string
        +

        ID of the link.

        +
        +
      +

      Returns Promise<void>

      +
+
+

findLinks

+
findLinks: ((accountId) => Promise<{
    id: string;
    webId: string;
}[]>)
+
+

Type declaration

+
    +
  • +
      +
    • (accountId): Promise<{
          id: string;
          webId: string;
      }[]>
      • +
    • +

      Finds all links associated with the given account.

      +
      +
      +

      Parameters

      +
        +
      • +
        accountId: string
        +

        ID of the account.

        +
        +
      +

      Returns Promise<{
          id: string;
          webId: string;
      }[]>

      +
+
+

get

+
get: ((linkId) => Promise<undefined | {
    accountId: string;
    webId: string;
}>)
+
+

Type declaration

+
    +
  • +
      +
    • (linkId): Promise<undefined | {
          accountId: string;
          webId: string;
      }>
      • +
    • +

      Finds the account and WebID of the link with the given ID.

      +
      +
      +

      Parameters

      +
        +
      • +
        linkId: string
      +

      Returns Promise<undefined | {
          accountId: string;
          webId: string;
      }>

      +
+
+

isLinked

+
isLinked: ((webId, accountId) => Promise<boolean>)
+
+

Type declaration

+
    +
  • +
      +
    • (webId, accountId): Promise<boolean>
      • +
    • +

      Determines if a WebID is linked to an account.

      +
      +
      +

      Parameters

      +
        +
      • +
        webId: string
        +

        WebID to check.

        +
        +
        • +
      • +
        accountId: string
        +

        ID of the account.

        +
        +
      +

      Returns Promise<boolean>

      +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/WebSocket2023HandlerInput.html b/7.x/docs/interfaces/WebSocket2023HandlerInput.html new file mode 100644 index 000000000..73a5ee5ea --- /dev/null +++ b/7.x/docs/interfaces/WebSocket2023HandlerInput.html @@ -0,0 +1,92 @@ +WebSocket2023HandlerInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface WebSocket2023HandlerInput

+
+

Hierarchy

+
    +
  • WebSocket2023HandlerInput
+
+
+
+ +
+
+

Properties

+
channel +webSocket +
+
+

Properties

+
+

channel

+
channel: NotificationChannel
+
+

webSocket

+
webSocket: WebSocket
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/WebSocketChannel2023.html b/7.x/docs/interfaces/WebSocketChannel2023.html new file mode 100644 index 000000000..d7811a16f --- /dev/null +++ b/7.x/docs/interfaces/WebSocketChannel2023.html @@ -0,0 +1,217 @@ +WebSocketChannel2023 | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface WebSocketChannel2023

+
+

A NotificationChannel containing the necessary fields for a WebSocketChannel2023 channel.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
accept? +endAt? +id +lastEmit? +rate? +receiveFrom +sendTo? +sender? +startAt? +state? +topic +type +
+
+

Properties

+
+

Optional accept

+
accept?: string
+

The media type in which the receiver expects the notifications.

+
+
+
+

Optional endAt

+
endAt?: number
+

When the channel should stop existing, in milliseconds since epoch.

+
+
+
+

id

+
id: string
+

The unique identifier of the channel.

+
+
+
+

Optional lastEmit

+
lastEmit?: number
+

Internal value that we use to track when this channel last sent a notification.

+
+
+
+

Optional rate

+
rate?: number
+

The minimal time required between notifications, in milliseconds.

+
+
+
+

receiveFrom

+
receiveFrom: string
+

The WebSocket through which the channel will send notifications.

+
+
+
+

Optional sendTo

+
sendTo?: string
+

The resource on the receiver where notifications can be sent.

+
+
+
+

Optional sender

+
sender?: string
+

Can be used to identify the sender.

+
+
+
+

Optional startAt

+
startAt?: number
+

When the channel should start sending notifications, in milliseconds since epoch.

+
+
+
+

Optional state

+
state?: string
+

The state parameter sent by the receiver. +This is used to send a notification when the channel is established and the topic resource has a different state.

+
+
+
+

topic

+
topic: string
+

The resource this channel sends notifications about.

+
+
+
+

type

+
type: "http://www.w3.org/ns/solid/notifications#WebSocketChannel2023"
+

The "notify:WebSocketChannel2023" type.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/WebSocketHandlerInput.html b/7.x/docs/interfaces/WebSocketHandlerInput.html new file mode 100644 index 000000000..68c623478 --- /dev/null +++ b/7.x/docs/interfaces/WebSocketHandlerInput.html @@ -0,0 +1,92 @@ +WebSocketHandlerInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface WebSocketHandlerInput

+
+

Hierarchy

+
    +
  • WebSocketHandlerInput
+
+
+
+ +
+
+

Properties

+
upgradeRequest +webSocket +
+
+

Properties

+
+

upgradeRequest

+
upgradeRequest: HttpRequest
+
+

webSocket

+
webSocket: WebSocket
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/interfaces/WebhookChannel2023.html b/7.x/docs/interfaces/WebhookChannel2023.html new file mode 100644 index 000000000..19e9fe7d2 --- /dev/null +++ b/7.x/docs/interfaces/WebhookChannel2023.html @@ -0,0 +1,217 @@ +WebhookChannel2023 | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Interface WebhookChannel2023

+
+

A NotificationChannel containing the necessary fields for a WebhookChannel2023 channel.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

+
accept? +endAt? +id +lastEmit? +rate? +receiveFrom? +sendTo +sender? +startAt? +state? +topic +type +
+
+

Properties

+
+

Optional accept

+
accept?: string
+

The media type in which the receiver expects the notifications.

+
+
+
+

Optional endAt

+
endAt?: number
+

When the channel should stop existing, in milliseconds since epoch.

+
+
+
+

id

+
id: string
+

The unique identifier of the channel.

+
+
+
+

Optional lastEmit

+
lastEmit?: number
+

Internal value that we use to track when this channel last sent a notification.

+
+
+
+

Optional rate

+
rate?: number
+

The minimal time required between notifications, in milliseconds.

+
+
+
+

Optional receiveFrom

+
receiveFrom?: string
+

The resource receivers can use to establish a connection and receive notifications.

+
+
+
+

sendTo

+
sendTo: string
+

Where the notifications have to be sent.

+
+
+
+

Optional sender

+
sender?: string
+

Can be used to identify the sender.

+
+
+
+

Optional startAt

+
startAt?: number
+

When the channel should start sending notifications, in milliseconds since epoch.

+
+
+
+

Optional state

+
state?: string
+

The state parameter sent by the receiver. +This is used to send a notification when the channel is established and the topic resource has a different state.

+
+
+
+

topic

+
topic: string
+

The resource this channel sends notifications about.

+
+
+
+

type

+
type: "http://www.w3.org/ns/solid/notifications#WebhookChannel2023"
+

The "WebhookChannel2023" type.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
\ No newline at end of file diff --git a/7.x/docs/modules.html b/7.x/docs/modules.html new file mode 100644 index 000000000..a3a8d1f75 --- /dev/null +++ b/7.x/docs/modules.html @@ -0,0 +1,892 @@ +Community Solid Server - v7.0.5
+
+ +
+
+
+
+

Community Solid Server - v7.0.5

+
+
+

Index

+
+

Enumerations

+
AccessMode +AclMode +
+
+

Classes

+
AbsolutePathInteractionRoute +AcceptPreferenceParser +AccessChecker +AccountInitializer +AccountPromptFactory +AcpHeaderHandler +AcpReader +ActivityNotificationGenerator +AddRemoveNotificationGenerator +AgentAccessChecker +AgentClassAccessChecker +AgentGroupAccessChecker +AllStaticReader +AllowAcceptHeaderWriter +App +AppRunner +ArrayUnionHandler +AssetPathExtractor +AsyncHandler +AtomicFileDataAccessor +AuthAuxiliaryReader +AuthorizationParser +AuthorizedRouteHandler +Authorizer +AuthorizingHttpHandler +AuxiliaryLinkMetadataWriter +AuxiliaryReader +BadRequestHttpError +Base64EncodingStorage +BaseAccountIdRoute +BaseAccountStore +BaseChannelType +BaseClientCredentialsIdRoute +BaseClientCredentialsStore +BaseComponentsJsFactory +BaseCookieStore +BaseEmailSender +BaseFileIdentifierMapper +BaseForgotPasswordStore +BaseIdentifierStrategy +BaseLogger +BaseLoginAccountStorage +BasePasswordIdRoute +BasePasswordStore +BasePodCreator +BasePodIdRoute +BasePodStore +BaseReadWriteLocker +BaseResourceStore +BaseResourcesGenerator +BaseRouterHandler +BaseServerFactory +BaseStateHandler +BaseTypedRepresentationConverter +BaseUrlExtractor +BaseUrlHandler +BaseUrlRouterRule +BaseUrlVerifier +BaseWebIdLinkRoute +BaseWebIdStore +BasicConditions +BasicConditionsParser +BasicETagHandler +BasicRepresentation +BasicRequestParser +BasicResponseWriter +BearerWebIdExtractor +BinarySliceResourceStore +BodyParser +BooleanHandler +CachedHandler +CachedJwkGenerator +CachedResourceSet +CancelOidcHandler +ChainedConverter +ChainedTemplateEngine +CliExtractor +CliResolver +ClientCredentialsAdapter +ClientCredentialsAdapterFactory +ClientCredentialsDetailsHandler +ClientIdAdapter +ClientIdAdapterFactory +ClientInfoHandler +ClusterManager +CombinedShorthandResolver +ComposedAuxiliaryStrategy +ComposedNotificationHandler +ConditionalHandler +ConditionsParser +ConfigPodInitializer +ConfigPodManager +ConflictHttpError +ConsentHandler +ConstantConverter +ConstantMetadataWriter +ContainerInitializer +ContainerPathStorage +ContainerToTemplateConverter +ContentLengthParser +ContentTypeMetadataWriter +ContentTypeParser +ContentTypeReplacer +ContextDocumentLoader +ControlHandler +ConvertingErrorHandler +ConvertingNotificationSerializer +ConvertingOperationHttpHandler +ConvertingPatcher +ConvertingRouterRule +CookieInteractionHandler +CookieMetadataWriter +CookieParser +CorsHandler +CreateAccountHandler +CreateClientCredentialsHandler +CreateModesExtractor +CreatePasswordHandler +CreatePodHandler +CreatedResponseDescription +CredentialsExtractor +DPoPWebIdExtractor +DataAccessorBasedStore +DeleteClientCredentialsHandler +DeleteNotificationGenerator +DeleteOperationHandler +DeleteParentExtractor +DeletePasswordHandler +DynamicJsonToTemplateConverter +EjsTemplateEngine +EmailSender +EqualReadWriteLocker +ErrorHandler +ErrorToJsonConverter +ErrorToQuadConverter +ErrorToTemplateConverter +ExpiringAdapter +ExpiringAdapterFactory +ExtensionBasedMapper +ExtensionBasedMapperFactory +ExtensionBasedTemplateEngine +FileDataAccessor +FileSizeReporter +FileSystemResourceLocker +FilterMetadataDataAccessor +FilterPattern +FinalizableHandler +Finalizer +FixedContentTypeMapper +ForbiddenHttpError +ForgetWebIdHandler +ForgotPasswordHandler +FormToJsonConverter +FoundHttpError +GeneratedPodManager +GetOperationHandler +GlobalQuotaStrategy +GreedyReadWriteLocker +HandlebarsTemplateEngine +HandlerServerConfigurator +HashEncodingStorage +HashMap +HeadOperationHandler +HeaderHandler +HtmlViewEntry +HtmlViewHandler +HttpError +HttpHandler +IdInteractionRoute +IdentifierMap +IdentifierSetMultiMap +IdentityProviderFactory +IdentityProviderHttpHandler +ImmutableMetadataPatcher +InMemoryDataAccessor +IndexRepresentationStore +InitializableHandler +Initializer +InteractionHandler +InteractionRouteHandler +IntermediateCreateExtractor +InternalServerError +JsonConversionHandler +JsonFileStorage +JsonInteractionHandler +JsonLdNotificationSerializer +JsonResourceStorage +KeyExtractor +KeyValueChannelStorage +LazyLoggerFactory +LinkMetadataGenerator +LinkRelMetadataWriter +LinkRelObject +LinkRelParser +LinkWebIdHandler +ListeningActivityHandler +LocationInteractionHandler +LockingInteractionHandler +LockingResourceStore +LoggerInitializer +LogoutHandler +MappedMetadataWriter +MarkdownToHtmlConverter +MaxKeyLengthStorage +MemoryMapStorage +MemoryResourceLocker +MetadataGenerator +MetadataParser +MetadataWriter +MethodFilterHandler +MethodModesExtractor +MethodNotAllowedHttpError +ModesExtractor +ModifiedMetadataWriter +ModuleVersionVerifier +MonitoringStore +MovedPermanentlyHttpError +N3PatchBodyParser +N3PatchModesExtractor +N3Patcher +NoCheckOwnershipValidator +NotFoundHttpError +NotImplementedHttpError +NotificationDescriber +NotificationEmitter +NotificationGenerator +NotificationHandler +NotificationSerializer +NotificationSubscriber +NotificationUnsubscriber +OAuthHttpError +OidcControlHandler +OidcHttpHandler +OkResponseDescription +OperationHandler +OperationHttpHandler +OperationRouterHandler +OriginalUrlExtractor +OwnerMetadataWriter +OwnerPermissionReader +OwnershipValidator +ParallelHandler +ParentContainerReader +ParsingHttpHandler +PartialReadWriteLocker +PassthroughAdapter +PassthroughAdapterFactory +PassthroughConverter +PassthroughDataAccessor +PassthroughKeyValueStorage +PassthroughStore +PasswordLoginHandler +PatchHandler +PatchOperationHandler +PatchingStore +PathBasedReader +PermissionBasedAuthorizer +PermissionReader +PickWebIdHandler +PlainJsonLdFilter +PodCreator +PodQuotaStrategy +PodStorageLocationStrategy +PostOperationHandler +PreconditionFailedHttpError +PreferenceParser +PreferenceSupport +ProcessHandler +PromptFactory +PromptHandler +PublicCredentialsExtractor +PutOperationHandler +QuadToRdfConverter +QuotaStrategy +QuotaValidator +RangeMetadataWriter +RangeNotSatisfiedHttpError +RangePreferenceParser +RawBodyParser +RdfPatcher +RdfStorePatcher +RdfToQuadConverter +RdfValidator +ReadOnlyStore +RecordObject +RedirectHttpError +RedirectingErrorHandler +RedirectingHttpHandler +RedisLocker +RegexRouterRule +RegexRule +RelativePathInteractionRoute +RepresentationConverter +RepresentationConvertingStore +RepresentationMetadata +RepresentationPatchHandler +RepresentationPatcher +RequestParser +ResetPasswordHandler +ResetResponseDescription +ResolveLoginHandler +ResponseDescription +ResponseWriter +RootFilePathHandler +RootStorageLocationStrategy +RouterHandler +RouterRule +RoutingAuxiliaryIdentifierStrategy +RoutingAuxiliaryStrategy +RoutingResourceStore +SafeErrorHandler +SeededAccountInitializer +SequenceHandler +ServerConfigurator +ServerInitializer +ShorthandExtractor +ShorthandResolver +SingleContainerJsonStorage +SingleRootIdentifierStrategy +SliceStream +SlugParser +SparqlDataAccessor +SparqlUpdateBodyParser +SparqlUpdateModesExtractor +SparqlUpdatePatcher +StateHandler +StateNotificationGenerator +StaticAssetEntry +StaticAssetHandler +StaticFolderGenerator +StaticHandler +StaticInteractionHandler +StaticStorageDescriber +StaticTemplateEngine +StaticThrowHandler +StorageDescriber +StorageDescriptionAdvertiser +StorageDescriptionHandler +StreamingHttp2023Emitter +StreamingHttpListeningActivityHandler +StreamingHttpMap +StreamingHttpMetadataWriter +StreamingHttpRequestHandler +SubdomainExtensionBasedMapper +SubdomainIdentifierGenerator +SubdomainIdentifierStrategy +SubfolderResourcesGenerator +SuffixAuxiliaryIdentifierStrategy +SuffixIdentifierGenerator +TargetExtractor +TargetExtractorErrorHandler +TemplateEngine +TemplatedPodGenerator +TokenOwnershipValidator +TypedNotificationHandler +TypedRepresentationConverter +UnauthorizedHttpError +UnionCredentialsExtractor +UnionHandler +UnionPermissionReader +UnionPreferenceParser +UnlinkWebIdHandler +UnsecureConstantCredentialsExtractor +UnsecureWebIdExtractor +UnsecureWebSocketsProtocol +UnsupportedAsyncHandler +UnsupportedMediaTypeHttpError +UpdateOwnerHandler +UpdatePasswordHandler +V6MigrationInitializer +ValidatingDataAccessor +Validator +VariableHandler +VariableSetter +VersionHandler +ViewInteractionHandler +VoidLocker +VoidLogger +VoidLoggerFactory +WacAllowHttpHandler +WacAllowMetadataWriter +WaterfallHandler +WebAclReader +WebSocket2023Emitter +WebSocket2023Handler +WebSocket2023Listener +WebSocket2023Storer +WebSocketAdvertiser +WebSocketChannel2023Type +WebSocketHandler +WebSocketMap +WebSocketServerConfigurator +WebhookChannel2023Type +WebhookEmitter +WebhookWebId +WinstonLogger +WinstonLoggerFactory +WorkerManager +WrappedExpiringReadWriteLocker +WrappedExpiringStorage +WrappedIndexedStorage +WrappedSetMultiMap +WrappingLogger +WwwAuthMetadataWriter +YargsCliExtractor +YargsParameter +
+
+

Interfaces

+
AccessCheckerArgs +AccountInitializerArgs +AccountStore +AdapterFactory +AlgJwk +AppRunnerInput +AsyncTransformOptions +AtomicDataAccessor +AtomicResourceStore +AuthorizerInput +AuthorizingHttpHandlerArgs +AuxiliaryIdentifierStrategy +AuxiliaryStrategy +BasePodCreatorArgs +BaseRouterHandlerArgs +BaseServerFactoryOptions +BasicConditionsOptions +BasicRequestParserArgs +BodyParserArgs +CliOptions +ClientCredentials +ClientCredentialsStore +ComponentsJsFactory +ComposedNotificationHandlerArgs +Conditions +ConstantConverterOptions +ContainerInitializerArgs +ConvertingStoreEntry +CookieStore +DataAccessor +ETagHandler +EmailArgs +EmailSenderArgs +ErrorHandlerArgs +ExpiringReadWriteLocker +ExpiringStorage +FileIdentifierMapper +FileIdentifierMapperFactory +Finalizable +ForgotPasswordHandlerArgs +ForgotPasswordStore +Forwarded +GenericEventEmitter +HttpErrorClass +HttpErrorOptions +HttpHandlerInput +HttpServerFactory +IdentifierGenerator +IdentifierStrategy +IdentityProviderFactoryArgs +IdentityProviderHttpHandlerArgs +IndexedStorage +Initializable +InteractionHandlerInput +InteractionRoute +JsonInteractionHandlerInput +JsonRepresentation +JsonView +JwkGenerator +KeyValueStorage +LinkWebIdHandlerArgs +LogMetadata +Logger +LoggerFactory +LoginStorage +MetadataWriterInput +NotificationChannel +NotificationChannelStorage +NotificationChannelType +NotificationEmitterInput +NotificationHandlerInput +NotificationSerializerInput +NotificationSubscriberArgs +OAuthErrorFields +Operation +OperationHandlerInput +OperationHttpHandlerInput +OriginalUrlExtractorArgs +ParsingHttpHandlerArgs +PasswordLoginHandlerArgs +PasswordStore +Patch +PermissionReaderInput +PodCreatorInput +PodCreatorOutput +PodGenerator +PodManager +PodSettings +PodStore +ProviderFactory +RdfStorePatcherInput +ReadWriteLocker +RedirectHttpErrorClass +RedisSettings +Representation +RepresentationConverterArgs +RepresentationPatcherInput +RepresentationPreferences +Resource +ResourceIdentifier +ResourceLink +ResourceLocker +ResourceSet +ResourceStore +ResourcesGenerator +RouterHandlerArgs +SeededAccountInitializerArgs +SetMultiMap +SimpleLogger +SingleThreaded +Size +SizeReporter +SliceStreamOptions +SparqlUpdatePatch +StorageLocationStrategy +StreamingHttpEmitterInput +SubfolderResourcesGeneratorArgs +SubscriptionService +SystemError +TemplateEngineInput +TemplateOptions +TemplatePath +TemplateString +TemplatedResourcesGenerator +V6MigrationInitializerArgs +WacAllowHttpHandlerArgs +WebIdStore +WebSocket2023HandlerInput +WebSocketChannel2023 +WebSocketHandlerInput +WebhookChannel2023 +
+
+

Type Aliases

+
AccessMap +AccountIdKey +AccountIdRoute +AccountInteractionResults +AccountLoginStorage +AccountSettings +AclPermissionSet +ActivityEmitter +ArrayElement +AsyncHandlerInput +AsyncHandlerOutput +ChangeMap +ClientCredentialsIdRoute +CreateTypeObject +Credentials +CredentialsIdKey +EmptyMapConstructor +EmptyObject +Expires +ExtendedRoute +Guarded +HttpRequest +HttpResponse +IndexRelation +IndexTypeCollection +IndexTypeDescription +IndexedQuery +Interaction +Json +LogLevel +LoginOutputType +MapEntry +MapKey +MapValue +MetadataGraph +MetadataIdentifier +MetadataRecord +MetadataValue +ModifyOptions +OptionalKey +PartialVocabulary +PasswordIdKey +PasswordIdRoute +PatchHandlerInput +PermissionMap +PermissionSet +PodIdKey +PodIdRoute +PromiseOrValue +RouteParameter +StringKey +Template +TemplateFileName +TypeObject +ValidatorInput +ValuePreference +ValuePreferences +ValueType +ValueTypeDescription +VirtualKey +VirtualObject +Vocabulary +VocabularyLocal +VocabularyTerm +VocabularyValue +WebIdLinkKey +WebIdLinkRoute +YargsOptions +
+
+

Variables

+
ACCOUNT_ID_KEY +ACCOUNT_PROMPT +ACCOUNT_SETTINGS_REMEMBER_LOGIN +ACCOUNT_STORAGE_DESCRIPTION +ACCOUNT_TYPE +ACL +ACP +APPLICATION_JSON +APPLICATION_LD_JSON +APPLICATION_OCTET_STREAM +APPLICATION_SPARQL_UPDATE +APPLICATION_X_WWW_FORM_URLENCODED +AS +AUTH +BaseActivityEmitter +CLIENT_CREDENTIALS_STORAGE_DESCRIPTION +CLIENT_CREDENTIALS_STORAGE_TYPE +CONTENT_LENGTH +CONTENT_LENGTH_TERM +CONTENT_TYPE +CONTENT_TYPE_TERM +DC +DEFAULT_CUSTOM_TYPES +DEFAULT_NOTIFICATION_FEATURES +DEFAULT_SUBSCRIPTION_SHACL +FOAF +HH +HTTP +IANA +INDEX_ID_KEY +INTERNAL_ALL +INTERNAL_ERROR +INTERNAL_QUADS +JSON_LD +LDP +LOG_LEVELS +MA +NOTIFY +OIDC +OWNER_STORAGE_DESCRIPTION +OWNER_STORAGE_TYPE +PASSWORD_METHOD +PASSWORD_STORAGE_DESCRIPTION +PASSWORD_STORAGE_TYPE +PIM +POD_STORAGE_DESCRIPTION +POD_STORAGE_TYPE +POSIX +PREFERRED_PREFIX +PREFERRED_PREFIX_TERM +RDF +RDFS +SOLID +SOLID_AS +SOLID_ERROR +SOLID_ERROR_TERM +SOLID_HTTP +SOLID_META +TEMPLATE +TEMPLATE_VARIABLE +TEXT_HTML +TEXT_MARKDOWN +TEXT_N3 +TEXT_TURTLE +UNIT_BYTES +URL_SCHEMA +VANN +VCARD +WEBID_STORAGE_DESCRIPTION +WEBID_STORAGE_TYPE +XSD +modulePathPlaceholder +
+
+

Functions

+
absoluteFilePath +addGeneratedResources +addHeader +addResourceMetadata +addTemplateMetadata +allFulfilled +assertAccountId +assertOidcInteraction +assertReadConditions +asyncToArray +cleanPreferences +cloneRepresentation +concat +createAggregateError +createErrorMessage +createGenericEventEmitterClass +createSubdomainRegexp +createVocabulary +decodeUriPathComponents +encodeUriPathComponents +endOfStream +ensureLeadingSlash +ensureTrailingSlash +errorTermsToMetadata +extendVocabulary +extractErrorTerms +extractScheme +fetchDataset +filter +filterHandlers +find +findHandler +finishInteraction +forgetWebId +generateChannel +generateHttpErrorClass +generateHttpErrorUri +generateRedirectHttpErrorClass +generateWebSocketUrl +getAccessControl +getAccessControlResource +getAccessControlledResources +getBestPreference +getConversionTarget +getDefault +getExtension +getLoggerFor +getMatcher +getModuleRoot +getPolicy +getRelativeUrl +getSingleItem +getTemplateFilePath +getTypeWeight +getWeightedPreferences +guardStream +guardedStreamFrom +hasScheme +identifierHashFn +importOidcProvider +isContainerIdentifier +isContainerPath +isError +isGuarded +isHttpRequest +isHttpsServer +isInternalContentType +isPromise +isRepresentationMetadata +isResourceIdentifier +isSystemError +isTerm +isUrl +isValidFileName +isValidVariable +isWebSocket2023Channel +isWebhook2023Channel +joinFilePath +joinUrl +listSingleThreadedComponents +map +matchesAuthorizationScheme +matchesMediaPreferences +matchesMediaType +modify +modulePath +msToDuration +normalizeFilePath +parseAccept +parseAcceptCharset +parseAcceptDateTime +parseAcceptEncoding +parseAcceptLanguage +parseContentType +parseForwarded +parseLinkHeader +parseParameters +parsePath +parseQuads +parseSchema +parseWebSocketRequest +pipeSafely +preferencesToString +promiseSome +readJsonStream +readPackageJson +readTemplate +readableToQuads +readableToString +reduce +resetInternalLoggerFactory +resolveAssetPath +resolveModulePath +resolvePromiseOrValue +responseToDataset +sanitizeUrlPart +serializeQuads +setGlobalLoggerFactory +setSafeInterval +sortedAsyncMerge +splitAndClean +splitCommaSeparated +termToInt +toCanonicalUriPath +toComponentsJsType +toLiteral +toNamedTerm +toObjectTerm +toPredicateTerm +transformQuotedStrings +transformSafely +trimLeadingSlashes +trimTrailingSlashes +uniqueQuads +updateModifiedDate +validateWithError +verifyAccountId +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/AccessMap.html b/7.x/docs/types/AccessMap.html new file mode 100644 index 000000000..b67cdbc9b --- /dev/null +++ b/7.x/docs/types/AccessMap.html @@ -0,0 +1,64 @@ +AccessMap | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias AccessMap

+
AccessMap: IdentifierSetMultiMap<AccessMode>
+

Access modes per identifier.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/AccountIdKey.html b/7.x/docs/types/AccountIdKey.html new file mode 100644 index 000000000..371605c02 --- /dev/null +++ b/7.x/docs/types/AccountIdKey.html @@ -0,0 +1,61 @@ +AccountIdKey | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias AccountIdKey

+
AccountIdKey: "accountId"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/AccountIdRoute.html b/7.x/docs/types/AccountIdRoute.html new file mode 100644 index 000000000..f4f12538c --- /dev/null +++ b/7.x/docs/types/AccountIdRoute.html @@ -0,0 +1,64 @@ +AccountIdRoute | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias AccountIdRoute

+
AccountIdRoute: InteractionRoute<AccountIdKey>
+

A route that includes an account identifier.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/AccountInteractionResults.html b/7.x/docs/types/AccountInteractionResults.html new file mode 100644 index 000000000..d5d1fc448 --- /dev/null +++ b/7.x/docs/types/AccountInteractionResults.html @@ -0,0 +1,69 @@ +AccountInteractionResults | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias AccountInteractionResults

+
AccountInteractionResults: {
    account?: string;
} & InteractionResults
+

InteractionResults extended with our custom key for tracking a user's account ID.

+
+
+

Type declaration

+
    +
  • +
    Optional account?: string
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/AccountLoginStorage.html b/7.x/docs/types/AccountLoginStorage.html new file mode 100644 index 000000000..3b2da3d70 --- /dev/null +++ b/7.x/docs/types/AccountLoginStorage.html @@ -0,0 +1,70 @@ +AccountLoginStorage | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias AccountLoginStorage<T>

+
AccountLoginStorage<T>: LoginStorage<T & {
    account: unknown;
}>
+

A LoginStorage with specific typings to ensure other types can reference account IDs +without actually needing to specify it explicitly in their storage type.

+
+
+

Type Parameters

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/AccountSettings.html b/7.x/docs/types/AccountSettings.html new file mode 100644 index 000000000..b38c4159e --- /dev/null +++ b/7.x/docs/types/AccountSettings.html @@ -0,0 +1,66 @@ +AccountSettings | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias AccountSettings

+
AccountSettings: {
    rememberLogin?: boolean;
}
+
+

Type declaration

+
    +
  • +
    Optional rememberLogin?: boolean
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/AclPermissionSet.html b/7.x/docs/types/AclPermissionSet.html new file mode 100644 index 000000000..552bbe550 --- /dev/null +++ b/7.x/docs/types/AclPermissionSet.html @@ -0,0 +1,61 @@ +AclPermissionSet | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias AclPermissionSet

+
AclPermissionSet: PermissionSet & {
    [mode in AclMode]?: boolean
}
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/ActivityEmitter.html b/7.x/docs/types/ActivityEmitter.html new file mode 100644 index 000000000..620f6d77c --- /dev/null +++ b/7.x/docs/types/ActivityEmitter.html @@ -0,0 +1,65 @@ +ActivityEmitter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias ActivityEmitter

+
ActivityEmitter: GenericEventEmitter<"changed", ((target, activity, metadata) => void)> & GenericEventEmitter<VocabularyValue<typeof AS>, ((target, metadata) => void)>
+

An event emitter used to report changes made to resources. +Both generic change events and ActivityStream-specific events are emitted.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/ArrayElement.html b/7.x/docs/types/ArrayElement.html new file mode 100644 index 000000000..4e85ff7df --- /dev/null +++ b/7.x/docs/types/ArrayElement.html @@ -0,0 +1,66 @@ +ArrayElement | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias ArrayElement<TArray>

+
ArrayElement<TArray>: TArray[number]
+
+

Type Parameters

+
    +
  • +

    TArray extends readonly unknown[]

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/AsyncHandlerInput.html b/7.x/docs/types/AsyncHandlerInput.html new file mode 100644 index 000000000..85d111c84 --- /dev/null +++ b/7.x/docs/types/AsyncHandlerInput.html @@ -0,0 +1,66 @@ +AsyncHandlerInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias AsyncHandlerInput<T>

+
AsyncHandlerInput<T>: Parameters<T["handle"]>[0]
+
+

Type Parameters

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/AsyncHandlerOutput.html b/7.x/docs/types/AsyncHandlerOutput.html new file mode 100644 index 000000000..c7c4cb9ea --- /dev/null +++ b/7.x/docs/types/AsyncHandlerOutput.html @@ -0,0 +1,66 @@ +AsyncHandlerOutput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias AsyncHandlerOutput<T>

+
AsyncHandlerOutput<T>: Awaited<ReturnType<T["handle"]>>
+
+

Type Parameters

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/ChangeMap.html b/7.x/docs/types/ChangeMap.html new file mode 100644 index 000000000..c468756f6 --- /dev/null +++ b/7.x/docs/types/ChangeMap.html @@ -0,0 +1,66 @@ +ChangeMap | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias ChangeMap

+
ChangeMap: IdentifierMap<RepresentationMetadata>
+

An IdentifierMap containing one entry for each resource that was created, updated or deleted +by this operation. Where the value is a RepresentationMetadata +containing extra information about the change of the resource.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/ClientCredentialsIdRoute.html b/7.x/docs/types/ClientCredentialsIdRoute.html new file mode 100644 index 000000000..f1b16221d --- /dev/null +++ b/7.x/docs/types/ClientCredentialsIdRoute.html @@ -0,0 +1,64 @@ +ClientCredentialsIdRoute | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias ClientCredentialsIdRoute

+
ClientCredentialsIdRoute: ExtendedRoute<AccountIdRoute, CredentialsIdKey>
+

An AccountIdRoute that also includes a credentials identifier.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/CreateTypeObject.html b/7.x/docs/types/CreateTypeObject.html new file mode 100644 index 000000000..1e36b142a --- /dev/null +++ b/7.x/docs/types/CreateTypeObject.html @@ -0,0 +1,70 @@ +CreateTypeObject | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias CreateTypeObject<T>

+
CreateTypeObject<T>: Omit<TypeObject<T>, typeof INDEX_ID_KEY>
+

Input expected for create() call in IndexedStorage. +This is the same as TypeObject but without the index key.

+
+
+

Type Parameters

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/Credentials.html b/7.x/docs/types/Credentials.html new file mode 100644 index 000000000..2d71debe4 --- /dev/null +++ b/7.x/docs/types/Credentials.html @@ -0,0 +1,84 @@ +Credentials | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias Credentials

+
Credentials: {
    agent?: {
        webId: string;
    };
    client?: {
        clientId: string;
    };
    issuer?: {
        url: string;
    };
    [key: string]: unknown;
}
+

Credentials identifying an entity accessing or owning data.

+
+
+

Type declaration

+
    +
  • +
    [key: string]: unknown
    • +
  • +
    Optional agent?: {
        webId: string;
    }
    +
      +
    • +
      webId: string
    • +
  • +
    Optional client?: {
        clientId: string;
    }
    +
      +
    • +
      clientId: string
    • +
  • +
    Optional issuer?: {
        url: string;
    }
    +
      +
    • +
      url: string
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/CredentialsIdKey.html b/7.x/docs/types/CredentialsIdKey.html new file mode 100644 index 000000000..feb24c66c --- /dev/null +++ b/7.x/docs/types/CredentialsIdKey.html @@ -0,0 +1,61 @@ +CredentialsIdKey | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias CredentialsIdKey

+
CredentialsIdKey: "clientCredentialsId"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/EmptyMapConstructor.html b/7.x/docs/types/EmptyMapConstructor.html new file mode 100644 index 000000000..0f39619d0 --- /dev/null +++ b/7.x/docs/types/EmptyMapConstructor.html @@ -0,0 +1,72 @@ +EmptyMapConstructor | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias EmptyMapConstructor

+
EmptyMapConstructor: (new () => Map<unknown, unknown>)
+
+

Type declaration

+
    +
  • +
      +
    • new (): Map<unknown, unknown>
      • +
    • +

      A simplified version of MapConstructor that only allows creating an empty Map.

      +
      +

      Returns Map<unknown, unknown>

      +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/EmptyObject.html b/7.x/docs/types/EmptyObject.html new file mode 100644 index 000000000..1be437bf8 --- /dev/null +++ b/7.x/docs/types/EmptyObject.html @@ -0,0 +1,61 @@ +EmptyObject | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias EmptyObject

+
EmptyObject: Record<string, never>
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/Expires.html b/7.x/docs/types/Expires.html new file mode 100644 index 000000000..3ebfc6503 --- /dev/null +++ b/7.x/docs/types/Expires.html @@ -0,0 +1,73 @@ +Expires | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias Expires<T>

+
Expires<T>: {
    expires?: string;
    payload: T;
}
+
+

Type Parameters

+
    +
  • +

    T

+
+

Type declaration

+
    +
  • +
    Optional expires?: string
    • +
  • +
    payload: T
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/ExtendedRoute.html b/7.x/docs/types/ExtendedRoute.html new file mode 100644 index 000000000..0b618b8c9 --- /dev/null +++ b/7.x/docs/types/ExtendedRoute.html @@ -0,0 +1,71 @@ +ExtendedRoute | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias ExtendedRoute<TRoute, TParam>

+
ExtendedRoute<TRoute, TParam>: InteractionRoute<RouteParameter<TRoute> | TParam>
+

A route that adds a parameter to an existing route type.

+
+
+

Type Parameters

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/Guarded.html b/7.x/docs/types/Guarded.html new file mode 100644 index 000000000..78f33d662 --- /dev/null +++ b/7.x/docs/types/Guarded.html @@ -0,0 +1,71 @@ +Guarded | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias Guarded<T>

+
Guarded<T>: T & Guard
+

A stream that is guarded from emitting errors when there are no listeners. +If an error occurs while no listener is attached, +it will store the error and emit it once a listener is added (or a timeout occurs).

+
+
+

Type Parameters

+
    +
  • +

    T extends NodeJS.EventEmitter = NodeJS.EventEmitter

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/HttpRequest.html b/7.x/docs/types/HttpRequest.html new file mode 100644 index 000000000..1bbc7ca5e --- /dev/null +++ b/7.x/docs/types/HttpRequest.html @@ -0,0 +1,64 @@ +HttpRequest | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias HttpRequest

+
HttpRequest: Guarded<IncomingMessage>
+

An incoming HTTP request;

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/HttpResponse.html b/7.x/docs/types/HttpResponse.html new file mode 100644 index 000000000..6774f1dcd --- /dev/null +++ b/7.x/docs/types/HttpResponse.html @@ -0,0 +1,64 @@ +HttpResponse | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias HttpResponse

+
HttpResponse: ServerResponse
+

An outgoing HTTP response;

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/IndexRelation.html b/7.x/docs/types/IndexRelation.html new file mode 100644 index 000000000..0e2d1d629 --- /dev/null +++ b/7.x/docs/types/IndexRelation.html @@ -0,0 +1,86 @@ +IndexRelation | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias IndexRelation<TTypes>

+
IndexRelation<TTypes>: {
    child: {
        key: string;
        type: StringKey<TTypes>;
    };
    parent: {
        key: VirtualKey<string>;
        type: StringKey<TTypes>;
    };
}
+

A parent/child relation description in a WrappedIndexedStorage.

+
+
+

Type Parameters

+
    +
  • +

    TTypes

+
+

Type declaration

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/IndexTypeCollection.html b/7.x/docs/types/IndexTypeCollection.html new file mode 100644 index 000000000..851203371 --- /dev/null +++ b/7.x/docs/types/IndexTypeCollection.html @@ -0,0 +1,69 @@ +IndexTypeCollection | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias IndexTypeCollection<T>

+
IndexTypeCollection<T>: Record<string, IndexTypeDescription<keyof T>>
+

The full description of all the types of an IndexedStorage.

+
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/IndexTypeDescription.html b/7.x/docs/types/IndexTypeDescription.html new file mode 100644 index 000000000..5cfabff5f --- /dev/null +++ b/7.x/docs/types/IndexTypeDescription.html @@ -0,0 +1,69 @@ +IndexTypeDescription | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias IndexTypeDescription<TType>

+
IndexTypeDescription<TType>: Record<string, ValueTypeDescription<TType>>
+

The description of a single type in an IndexedStorage.

+
+
+

Type Parameters

+
    +
  • +

    TType = never

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/IndexedQuery.html b/7.x/docs/types/IndexedQuery.html new file mode 100644 index 000000000..90f87c9d5 --- /dev/null +++ b/7.x/docs/types/IndexedQuery.html @@ -0,0 +1,83 @@ +IndexedQuery | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias IndexedQuery<T, TType, TDepth>

+
IndexedQuery<T, TType, TDepth>: [TDepth] extends [never]
    ? never
    : {
        [K in keyof T[TType] | typeof INDEX_ID_KEY]?: ValueType<T[TType][K]> | (T[TType][K] extends `${typeof INDEX_ID_KEY}:${infer U}`
            ? IndexedQuery<T, U, Prev[TDepth]>
            : never)
    }
+

Object that represents a valid query starting from a specific type on an IndexedStorage. + The keys of the object need to be one or more keys from the starting type, + with the values being corresponding valid values of an object of that type. + If the value definition of a key is one that contains the identifier of a different type, + the value in the query can also be a nested object that has the same IndexedQuery requirements for that type. + This can be done recursively.

+

E.g., if the storage has the following definition:

+
 {
   account: {},
   pod: { baseUrl: 'string', account: 'id:account' },
   pod: { owner: 'string', pod: 'id:pod' },
 }
+
+

A valid query on the pod type could be { pod: '123456' }, +but also { pod: { baseUrl: 'http://example.com/pod/', account: { id: '789' }}}.

+
+
+

Type Parameters

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/Interaction.html b/7.x/docs/types/Interaction.html new file mode 100644 index 000000000..ab99b4ee3 --- /dev/null +++ b/7.x/docs/types/Interaction.html @@ -0,0 +1,61 @@ +Interaction | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias Interaction

+
Interaction: NonNullable<KoaContextWithOIDC["oidc"]["entities"]["Interaction"]>
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/Json.html b/7.x/docs/types/Json.html new file mode 100644 index 000000000..3a27da5da --- /dev/null +++ b/7.x/docs/types/Json.html @@ -0,0 +1,64 @@ +Json | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias Json

+
Json: string | number | boolean | NodeJS.Dict<Json> | Json[]
+

A JSON object.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/LogLevel.html b/7.x/docs/types/LogLevel.html new file mode 100644 index 000000000..cf470d5ae --- /dev/null +++ b/7.x/docs/types/LogLevel.html @@ -0,0 +1,64 @@ +LogLevel | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias LogLevel

+
LogLevel: typeof LOG_LEVELS[number]
+

Different log levels, from most important to least important.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/LoginOutputType.html b/7.x/docs/types/LoginOutputType.html new file mode 100644 index 000000000..42c66c567 --- /dev/null +++ b/7.x/docs/types/LoginOutputType.html @@ -0,0 +1,78 @@ +LoginOutputType | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias LoginOutputType

+
LoginOutputType: {
    accountId: string;
    remember?: boolean;
}
+

Output type that is expected of handlers logging an account in.

+
+
+

Type declaration

+
    +
  • +
    accountId: string
    +

    The ID of the account that logged in.

    +
    +
    • +
  • +
    Optional remember?: boolean
    +

    If this account should be remembered or not. +Setting this to undefined will keep the setting as it currently is.

    +
    +
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/MapEntry.html b/7.x/docs/types/MapEntry.html new file mode 100644 index 000000000..5a051cdf1 --- /dev/null +++ b/7.x/docs/types/MapEntry.html @@ -0,0 +1,66 @@ +MapEntry | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias MapEntry<T>

+
MapEntry<T>: T extends Map<unknown, unknown>
    ? [MapKey<T>, MapValue<T>]
    : never
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/MapKey.html b/7.x/docs/types/MapKey.html new file mode 100644 index 000000000..c9e74ceb1 --- /dev/null +++ b/7.x/docs/types/MapKey.html @@ -0,0 +1,66 @@ +MapKey | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias MapKey<T>

+
MapKey<T>: T extends Map<infer TKey, unknown>
    ? TKey
    : never
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/MapValue.html b/7.x/docs/types/MapValue.html new file mode 100644 index 000000000..c3a7d59b7 --- /dev/null +++ b/7.x/docs/types/MapValue.html @@ -0,0 +1,66 @@ +MapValue | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias MapValue<T>

+
MapValue<T>: T extends Map<unknown, infer TValue>
    ? TValue
    : never
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/MetadataGraph.html b/7.x/docs/types/MetadataGraph.html new file mode 100644 index 000000000..2fe552b93 --- /dev/null +++ b/7.x/docs/types/MetadataGraph.html @@ -0,0 +1,61 @@ +MetadataGraph | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias MetadataGraph

+
MetadataGraph: NamedNode | BlankNode | DefaultGraph | string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/MetadataIdentifier.html b/7.x/docs/types/MetadataIdentifier.html new file mode 100644 index 000000000..efb774e38 --- /dev/null +++ b/7.x/docs/types/MetadataIdentifier.html @@ -0,0 +1,61 @@ +MetadataIdentifier | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias MetadataIdentifier

+
MetadataIdentifier: ResourceIdentifier | NamedNode | BlankNode
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/MetadataRecord.html b/7.x/docs/types/MetadataRecord.html new file mode 100644 index 000000000..357d18047 --- /dev/null +++ b/7.x/docs/types/MetadataRecord.html @@ -0,0 +1,61 @@ +MetadataRecord | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias MetadataRecord

+
MetadataRecord: Record<string, MetadataValue>
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/MetadataValue.html b/7.x/docs/types/MetadataValue.html new file mode 100644 index 000000000..46bdb4c9c --- /dev/null +++ b/7.x/docs/types/MetadataValue.html @@ -0,0 +1,61 @@ +MetadataValue | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias MetadataValue

+
MetadataValue: NamedNode | BlankNode | Literal | string | (NamedNode | Literal | BlankNode | string)[]
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/ModifyOptions.html b/7.x/docs/types/ModifyOptions.html new file mode 100644 index 000000000..a12ab0d72 --- /dev/null +++ b/7.x/docs/types/ModifyOptions.html @@ -0,0 +1,82 @@ +ModifyOptions | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias ModifyOptions<T>

+
ModifyOptions<T>: {
    add?: Iterable<MapEntry<T>>;
    remove?: Iterable<MapKey<T>>;
}
+

Options describing the necessary changes when calling modify.

+
+
+

Type Parameters

+
+
+

Type declaration

+
    +
  • +
    Optional add?: Iterable<MapEntry<T>>
    +

    Entries that need to be added to the Map.

    +
    +
    • +
  • +
    Optional remove?: Iterable<MapKey<T>>
    +

    Keys that need to be removed from the Map.

    +
    +
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/OptionalKey.html b/7.x/docs/types/OptionalKey.html new file mode 100644 index 000000000..b5f740848 --- /dev/null +++ b/7.x/docs/types/OptionalKey.html @@ -0,0 +1,69 @@ +OptionalKey | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias OptionalKey<T>

+
OptionalKey<T>: {
    [K in keyof T]: T[K] extends `${string}?`
        ? K
        : never
}[keyof T]
+

Used to filter on optional keys in a IndexedStorage definition.

+
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/PartialVocabulary.html b/7.x/docs/types/PartialVocabulary.html new file mode 100644 index 000000000..2a2c6e5a4 --- /dev/null +++ b/7.x/docs/types/PartialVocabulary.html @@ -0,0 +1,80 @@ +PartialVocabulary | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias PartialVocabulary<TBase>

+
PartialVocabulary<TBase>: {
    namespace: TBase;
} & Partial<Record<string, string>> & {
    terms: {
        namespace: NamedNode<TBase>;
    } & Partial<Record<string, NamedNode>>;
}
+

A Vocabulary where all the non-namespace fields are of unknown value. +This is a fallback in case createVocabulary gets called with a non-strict string array.

+
+
+

Type Parameters

+
    +
  • +

    TBase extends string

+
+

Type declaration

+
    +
  • +
    namespace: TBase
+
+

Type declaration

+
    +
  • +
    terms: {
        namespace: NamedNode<TBase>;
    } & Partial<Record<string, NamedNode>>
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/PasswordIdKey.html b/7.x/docs/types/PasswordIdKey.html new file mode 100644 index 000000000..85b8a584e --- /dev/null +++ b/7.x/docs/types/PasswordIdKey.html @@ -0,0 +1,61 @@ +PasswordIdKey | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias PasswordIdKey

+
PasswordIdKey: "passwordId"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/PasswordIdRoute.html b/7.x/docs/types/PasswordIdRoute.html new file mode 100644 index 000000000..1ab754a4c --- /dev/null +++ b/7.x/docs/types/PasswordIdRoute.html @@ -0,0 +1,64 @@ +PasswordIdRoute | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias PasswordIdRoute

+
PasswordIdRoute: ExtendedRoute<AccountIdRoute, PasswordIdKey>
+

An AccountIdRoute that also includes a password login identifier.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/PatchHandlerInput.html b/7.x/docs/types/PatchHandlerInput.html new file mode 100644 index 000000000..29f9d6ec6 --- /dev/null +++ b/7.x/docs/types/PatchHandlerInput.html @@ -0,0 +1,75 @@ +PatchHandlerInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias PatchHandlerInput<T>

+
PatchHandlerInput<T>: {
    identifier: ResourceIdentifier;
    patch: Patch;
    source: T;
}
+
+

Type Parameters

+
+
+

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/PermissionMap.html b/7.x/docs/types/PermissionMap.html new file mode 100644 index 000000000..2a53298f9 --- /dev/null +++ b/7.x/docs/types/PermissionMap.html @@ -0,0 +1,64 @@ +PermissionMap | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias PermissionMap

+
PermissionMap: IdentifierMap<PermissionSet>
+

PermissionSet per identifier.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/PermissionSet.html b/7.x/docs/types/PermissionSet.html new file mode 100644 index 000000000..ebbe169bf --- /dev/null +++ b/7.x/docs/types/PermissionSet.html @@ -0,0 +1,64 @@ +PermissionSet | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias PermissionSet

+
PermissionSet: Partial<Record<AccessMode, boolean>>
+

A data interface indicating which permissions are required (based on the context).

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/PodIdKey.html b/7.x/docs/types/PodIdKey.html new file mode 100644 index 000000000..39d18c522 --- /dev/null +++ b/7.x/docs/types/PodIdKey.html @@ -0,0 +1,61 @@ +PodIdKey | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias PodIdKey

+
PodIdKey: "podId"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/PodIdRoute.html b/7.x/docs/types/PodIdRoute.html new file mode 100644 index 000000000..4129bfa03 --- /dev/null +++ b/7.x/docs/types/PodIdRoute.html @@ -0,0 +1,64 @@ +PodIdRoute | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias PodIdRoute

+
PodIdRoute: ExtendedRoute<AccountIdRoute, PodIdKey>
+

An AccountIdRoute that also includes a pod identifier.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/PromiseOrValue.html b/7.x/docs/types/PromiseOrValue.html new file mode 100644 index 000000000..73396c43f --- /dev/null +++ b/7.x/docs/types/PromiseOrValue.html @@ -0,0 +1,66 @@ +PromiseOrValue | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias PromiseOrValue<T>

+
PromiseOrValue<T>: T | Promise<T>
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/RouteParameter.html b/7.x/docs/types/RouteParameter.html new file mode 100644 index 000000000..0a68d9737 --- /dev/null +++ b/7.x/docs/types/RouteParameter.html @@ -0,0 +1,69 @@ +RouteParameter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias RouteParameter<TRoute>

+
RouteParameter<TRoute>: TRoute extends InteractionRoute<infer TParam>
    ? TParam
    : never
+

The parameters supported for the given route.

+
+
+

Type Parameters

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/StringKey.html b/7.x/docs/types/StringKey.html new file mode 100644 index 000000000..4a10a687b --- /dev/null +++ b/7.x/docs/types/StringKey.html @@ -0,0 +1,69 @@ +StringKey | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias StringKey<T>

+
StringKey<T>: keyof T & string
+

Key of an object that is also a string.

+
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/Template.html b/7.x/docs/types/Template.html new file mode 100644 index 000000000..1d34a608e --- /dev/null +++ b/7.x/docs/types/Template.html @@ -0,0 +1,61 @@ +Template | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias Template

+
Template: TemplateFileName | TemplateString | TemplatePath
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/TemplateFileName.html b/7.x/docs/types/TemplateFileName.html new file mode 100644 index 000000000..1555ab509 --- /dev/null +++ b/7.x/docs/types/TemplateFileName.html @@ -0,0 +1,61 @@ +TemplateFileName | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias TemplateFileName

+
TemplateFileName: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/TypeObject.html b/7.x/docs/types/TypeObject.html new file mode 100644 index 000000000..09b401497 --- /dev/null +++ b/7.x/docs/types/TypeObject.html @@ -0,0 +1,75 @@ +TypeObject | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias TypeObject<TDesc>

+
TypeObject<TDesc>: {
    -readonly [K in Exclude<keyof TDesc, OptionalKey<TDesc>>]: ValueType<TDesc[K]>
} & {
    -readonly [K in keyof TDesc]?: ValueType<TDesc[K]>
} & {
    id: string;
}
+

Converts a IndexedStorage definition of a specific type +to the typing an object would have that is returned as an output on function calls.

+
+
+

Type Parameters

+
+
+

Type declaration

+
    +
  • +
    id: string
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/ValidatorInput.html b/7.x/docs/types/ValidatorInput.html new file mode 100644 index 000000000..8c14435d6 --- /dev/null +++ b/7.x/docs/types/ValidatorInput.html @@ -0,0 +1,68 @@ +ValidatorInput | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias ValidatorInput

+
ValidatorInput: {
    identifier: ResourceIdentifier;
    representation: Representation;
}
+
+

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/ValuePreference.html b/7.x/docs/types/ValuePreference.html new file mode 100644 index 000000000..43ba13f42 --- /dev/null +++ b/7.x/docs/types/ValuePreference.html @@ -0,0 +1,72 @@ +ValuePreference | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias ValuePreference

+
ValuePreference: {
    value: string;
    weight: number;
}
+

A single entry of a ValuePreferences object. +Useful when doing operations on such an object.

+
+
+

Type declaration

+
    +
  • +
    value: string
    • +
  • +
    weight: number
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/ValuePreferences.html b/7.x/docs/types/ValuePreferences.html new file mode 100644 index 000000000..b26d8ef1f --- /dev/null +++ b/7.x/docs/types/ValuePreferences.html @@ -0,0 +1,76 @@ +ValuePreferences | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias ValuePreferences

+
ValuePreferences: {
    [key: string]: number;
}
+

Represents preferred values along a single content negotiation dimension.

+

The number represents how preferred this value is from 0 to 1. +Follows the quality values rule from RFC 7231: +"The weight is normalized to a real number in the range 0 through 1, +where 0.001 is the least preferred and 1 is the most preferred; a +value of 0 means "not acceptable"."

+

Because of an open issue in Components.js we cannot use Record<string, number> right now. +https://github.com/LinkedSoftwareDependencies/Components-Generator.js/issues/103

+
+
+

Type declaration

+
    +
  • +
    [key: string]: number
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/ValueType.html b/7.x/docs/types/ValueType.html new file mode 100644 index 000000000..62a7aee2b --- /dev/null +++ b/7.x/docs/types/ValueType.html @@ -0,0 +1,69 @@ +ValueType | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias ValueType<T>

+
ValueType<T>: (T extends "boolean" | "boolean?"
    ? boolean
    : T extends "number" | "number?"
        ? number
        : string) | (T extends `${string}?`
    ? undefined
    : never)
+

Converts a ValueTypeDescription to the type it should be interpreted as.

+
+
+

Type Parameters

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/ValueTypeDescription.html b/7.x/docs/types/ValueTypeDescription.html new file mode 100644 index 000000000..5536a1a2c --- /dev/null +++ b/7.x/docs/types/ValueTypeDescription.html @@ -0,0 +1,73 @@ +ValueTypeDescription | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias ValueTypeDescription<TType>

+
ValueTypeDescription<TType>: `${"string" | "boolean" | "number" | (TType extends string
    ? `${typeof INDEX_ID_KEY}:${TType}`
    : never)}${"?" | ""}`
+

Used to define the value of a key in a type entry of a IndexedStorage. +Valid values are "string", "boolean", "number" and "id:TYPE", +with TYPE being one of the types in the definition. +In the latter case this means that key points to an identifier of the specified type. +A ? can be appended to the type to indicate this key is optional.

+
+
+

Type Parameters

+
    +
  • +

    TType = string

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/VirtualKey.html b/7.x/docs/types/VirtualKey.html new file mode 100644 index 000000000..049947e8b --- /dev/null +++ b/7.x/docs/types/VirtualKey.html @@ -0,0 +1,69 @@ +VirtualKey | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias VirtualKey<TChild>

+
VirtualKey<TChild>: TChild extends string
    ? `**${TChild}**`
    : never
+

Key used to link to child objects in a WrappedIndexedStorage.

+
+
+

Type Parameters

+
    +
  • +

    TChild

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/VirtualObject.html b/7.x/docs/types/VirtualObject.html new file mode 100644 index 000000000..42481300e --- /dev/null +++ b/7.x/docs/types/VirtualObject.html @@ -0,0 +1,71 @@ +VirtualObject | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias VirtualObject

+
VirtualObject: {
    id: string;
    [key: VirtualKey<string>]: Record<string, VirtualObject>;
}
+

Object stored in the wrapped KeyValueStorage in a WrappedIndexedStorage.

+
+
+

Type declaration

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/Vocabulary.html b/7.x/docs/types/Vocabulary.html new file mode 100644 index 000000000..3fa08e107 --- /dev/null +++ b/7.x/docs/types/Vocabulary.html @@ -0,0 +1,77 @@ +Vocabulary | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias Vocabulary<TBase, TKey>

+
Vocabulary<TBase, TKey>: ValueVocabulary<TBase, TKey> & {
    terms: TermVocabulary<ValueVocabulary<TBase, TKey>>;
}
+

Contains a namespace and keys linking to the entries in this namespace. +The terms field contains the same values but as NamedNode instead of string.

+
+
+

Type Parameters

+
    +
  • +

    TBase extends string

    • +
  • +

    TKey extends string

+
+

Type declaration

+
    +
  • +
    terms: TermVocabulary<ValueVocabulary<TBase, TKey>>
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/VocabularyLocal.html b/7.x/docs/types/VocabularyLocal.html new file mode 100644 index 000000000..e0d230478 --- /dev/null +++ b/7.x/docs/types/VocabularyLocal.html @@ -0,0 +1,69 @@ +VocabularyLocal | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias VocabularyLocal<T>

+
VocabularyLocal<T>: T extends Vocabulary<string, infer TKey>
    ? TKey
    : never
+

A local name of a Vocabulary.

+
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/VocabularyTerm.html b/7.x/docs/types/VocabularyTerm.html new file mode 100644 index 000000000..ad5126108 --- /dev/null +++ b/7.x/docs/types/VocabularyTerm.html @@ -0,0 +1,69 @@ +VocabularyTerm | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias VocabularyTerm<T>

+
VocabularyTerm<T>: T extends Vocabulary<string, infer TKey>
    ? T["terms"][TKey]
    : never
+

A NamedNode entry of a Vocabulary.

+
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/VocabularyValue.html b/7.x/docs/types/VocabularyValue.html new file mode 100644 index 000000000..076d4f2d2 --- /dev/null +++ b/7.x/docs/types/VocabularyValue.html @@ -0,0 +1,69 @@ +VocabularyValue | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias VocabularyValue<T>

+
VocabularyValue<T>: T extends Vocabulary<string, infer TKey>
    ? T[TKey]
    : never
+

A URI string entry of a Vocabulary.

+
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/WebIdLinkKey.html b/7.x/docs/types/WebIdLinkKey.html new file mode 100644 index 000000000..ef77689f6 --- /dev/null +++ b/7.x/docs/types/WebIdLinkKey.html @@ -0,0 +1,61 @@ +WebIdLinkKey | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias WebIdLinkKey

+
WebIdLinkKey: "webIdLink"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/WebIdLinkRoute.html b/7.x/docs/types/WebIdLinkRoute.html new file mode 100644 index 000000000..d30250c3f --- /dev/null +++ b/7.x/docs/types/WebIdLinkRoute.html @@ -0,0 +1,64 @@ +WebIdLinkRoute | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias WebIdLinkRoute

+
WebIdLinkRoute: ExtendedRoute<AccountIdRoute, WebIdLinkKey>
+

An AccountIdRoute that also includes a Web ID link identifier.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/types/YargsOptions.html b/7.x/docs/types/YargsOptions.html new file mode 100644 index 000000000..9c579e76d --- /dev/null +++ b/7.x/docs/types/YargsOptions.html @@ -0,0 +1,61 @@ +YargsOptions | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Type alias YargsOptions

+
YargsOptions: Options
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/ACCOUNT_ID_KEY.html b/7.x/docs/variables/ACCOUNT_ID_KEY.html new file mode 100644 index 000000000..cbd580f36 --- /dev/null +++ b/7.x/docs/variables/ACCOUNT_ID_KEY.html @@ -0,0 +1,61 @@ +ACCOUNT_ID_KEY | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable ACCOUNT_ID_KEYConst

+
ACCOUNT_ID_KEY: AccountIdKey = 'accountId'
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/ACCOUNT_PROMPT.html b/7.x/docs/variables/ACCOUNT_PROMPT.html new file mode 100644 index 000000000..4cb8dcf14 --- /dev/null +++ b/7.x/docs/variables/ACCOUNT_PROMPT.html @@ -0,0 +1,66 @@ +ACCOUNT_PROMPT | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable ACCOUNT_PROMPTConst

+
ACCOUNT_PROMPT: "account" = 'account'
+

The prompt that is used to track the account ID of a user during an OIDC interaction. +The already existing login prompt in the InteractionResults +is used to track the WebID that is chosen in an OIDC interaction.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/ACCOUNT_SETTINGS_REMEMBER_LOGIN.html b/7.x/docs/variables/ACCOUNT_SETTINGS_REMEMBER_LOGIN.html new file mode 100644 index 000000000..3a09322d5 --- /dev/null +++ b/7.x/docs/variables/ACCOUNT_SETTINGS_REMEMBER_LOGIN.html @@ -0,0 +1,64 @@ +ACCOUNT_SETTINGS_REMEMBER_LOGIN | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable ACCOUNT_SETTINGS_REMEMBER_LOGINConst

+
ACCOUNT_SETTINGS_REMEMBER_LOGIN: "rememberLogin" = 'rememberLogin'
+

Settings parameter used to determine if the user wants the login to be remembered.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/ACCOUNT_STORAGE_DESCRIPTION.html b/7.x/docs/variables/ACCOUNT_STORAGE_DESCRIPTION.html new file mode 100644 index 000000000..c50670bbc --- /dev/null +++ b/7.x/docs/variables/ACCOUNT_STORAGE_DESCRIPTION.html @@ -0,0 +1,66 @@ +ACCOUNT_STORAGE_DESCRIPTION | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable ACCOUNT_STORAGE_DESCRIPTIONConst

+
ACCOUNT_STORAGE_DESCRIPTION: {
    rememberLogin: "boolean?";
} = ...
+
+

Type declaration

+
    +
  • +
    Readonly rememberLogin: "boolean?"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/ACCOUNT_TYPE.html b/7.x/docs/variables/ACCOUNT_TYPE.html new file mode 100644 index 000000000..f33d175f2 --- /dev/null +++ b/7.x/docs/variables/ACCOUNT_TYPE.html @@ -0,0 +1,61 @@ +ACCOUNT_TYPE | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable ACCOUNT_TYPEConst

+
ACCOUNT_TYPE: "account" = 'account'
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/ACL.html b/7.x/docs/variables/ACL.html new file mode 100644 index 000000000..eb99935fd --- /dev/null +++ b/7.x/docs/variables/ACL.html @@ -0,0 +1,61 @@ +ACL | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable ACLConst

+
ACL: Vocabulary<"http://www.w3.org/ns/auth/acl#", "default" | "accessTo" | "agent" | "agentClass" | "agentGroup" | "AuthenticatedAgent" | "Authorization" | "mode" | "Write" | "Read" | "Append" | "Control"> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/ACP.html b/7.x/docs/variables/ACP.html new file mode 100644 index 000000000..093beddb8 --- /dev/null +++ b/7.x/docs/variables/ACP.html @@ -0,0 +1,61 @@ +ACP | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable ACPConst

+
ACP: Vocabulary<"http://www.w3.org/ns/solid/acp#", "agent" | "AccessControlResource" | "grant" | "attribute" | "resource" | "accessControl" | "memberAccessControl" | "apply" | "allow" | "deny" | "allOf" | "anyOf" | "noneOf" | "client" | "issuer" | "vc"> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/APPLICATION_JSON.html b/7.x/docs/variables/APPLICATION_JSON.html new file mode 100644 index 000000000..0c6cb1f62 --- /dev/null +++ b/7.x/docs/variables/APPLICATION_JSON.html @@ -0,0 +1,61 @@ +APPLICATION_JSON | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable APPLICATION_JSONConst

+
APPLICATION_JSON: "application/json" = 'application/json'
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/APPLICATION_LD_JSON.html b/7.x/docs/variables/APPLICATION_LD_JSON.html new file mode 100644 index 000000000..9e53db142 --- /dev/null +++ b/7.x/docs/variables/APPLICATION_LD_JSON.html @@ -0,0 +1,61 @@ +APPLICATION_LD_JSON | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable APPLICATION_LD_JSONConst

+
APPLICATION_LD_JSON: "application/ld+json" = 'application/ld+json'
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/APPLICATION_OCTET_STREAM.html b/7.x/docs/variables/APPLICATION_OCTET_STREAM.html new file mode 100644 index 000000000..6c429b08b --- /dev/null +++ b/7.x/docs/variables/APPLICATION_OCTET_STREAM.html @@ -0,0 +1,61 @@ +APPLICATION_OCTET_STREAM | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable APPLICATION_OCTET_STREAMConst

+
APPLICATION_OCTET_STREAM: "application/octet-stream" = 'application/octet-stream'
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/APPLICATION_SPARQL_UPDATE.html b/7.x/docs/variables/APPLICATION_SPARQL_UPDATE.html new file mode 100644 index 000000000..486542ffb --- /dev/null +++ b/7.x/docs/variables/APPLICATION_SPARQL_UPDATE.html @@ -0,0 +1,61 @@ +APPLICATION_SPARQL_UPDATE | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable APPLICATION_SPARQL_UPDATEConst

+
APPLICATION_SPARQL_UPDATE: "application/sparql-update" = 'application/sparql-update'
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/APPLICATION_X_WWW_FORM_URLENCODED.html b/7.x/docs/variables/APPLICATION_X_WWW_FORM_URLENCODED.html new file mode 100644 index 000000000..a081faa5d --- /dev/null +++ b/7.x/docs/variables/APPLICATION_X_WWW_FORM_URLENCODED.html @@ -0,0 +1,61 @@ +APPLICATION_X_WWW_FORM_URLENCODED | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable APPLICATION_X_WWW_FORM_URLENCODEDConst

+
APPLICATION_X_WWW_FORM_URLENCODED: "application/x-www-form-urlencoded" = 'application/x-www-form-urlencoded'
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/AS.html b/7.x/docs/variables/AS.html new file mode 100644 index 000000000..2661fee38 --- /dev/null +++ b/7.x/docs/variables/AS.html @@ -0,0 +1,61 @@ +AS | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable ASConst

+
AS: Vocabulary<"https://www.w3.org/ns/activitystreams#", "object" | "target" | "Add" | "Create" | "Delete" | "Remove" | "Update"> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/AUTH.html b/7.x/docs/variables/AUTH.html new file mode 100644 index 000000000..b63cc39a2 --- /dev/null +++ b/7.x/docs/variables/AUTH.html @@ -0,0 +1,61 @@ +AUTH | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable AUTHConst

+
AUTH: Vocabulary<"urn:solid:auth:", "userMode" | "publicMode"> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/BaseActivityEmitter.html b/7.x/docs/variables/BaseActivityEmitter.html new file mode 100644 index 000000000..7445db467 --- /dev/null +++ b/7.x/docs/variables/BaseActivityEmitter.html @@ -0,0 +1,72 @@ +BaseActivityEmitter | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable BaseActivityEmitterConst

+
BaseActivityEmitter: (new () => ActivityEmitter) = ...
+
+

Type declaration

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/CLIENT_CREDENTIALS_STORAGE_DESCRIPTION.html b/7.x/docs/variables/CLIENT_CREDENTIALS_STORAGE_DESCRIPTION.html new file mode 100644 index 000000000..9f8ee06a7 --- /dev/null +++ b/7.x/docs/variables/CLIENT_CREDENTIALS_STORAGE_DESCRIPTION.html @@ -0,0 +1,72 @@ +CLIENT_CREDENTIALS_STORAGE_DESCRIPTION | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable CLIENT_CREDENTIALS_STORAGE_DESCRIPTIONConst

+
CLIENT_CREDENTIALS_STORAGE_DESCRIPTION: {
    accountId: "id:account";
    label: "string";
    secret: "string";
    webId: "string";
} = ...
+
+

Type declaration

+
    +
  • +
    Readonly accountId: "id:account"
    • +
  • +
    Readonly label: "string"
    • +
  • +
    Readonly secret: "string"
    • +
  • +
    Readonly webId: "string"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/CLIENT_CREDENTIALS_STORAGE_TYPE.html b/7.x/docs/variables/CLIENT_CREDENTIALS_STORAGE_TYPE.html new file mode 100644 index 000000000..73d493ad9 --- /dev/null +++ b/7.x/docs/variables/CLIENT_CREDENTIALS_STORAGE_TYPE.html @@ -0,0 +1,61 @@ +CLIENT_CREDENTIALS_STORAGE_TYPE | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable CLIENT_CREDENTIALS_STORAGE_TYPEConst

+
CLIENT_CREDENTIALS_STORAGE_TYPE: "clientCredentials" = 'clientCredentials'
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/CONTENT_LENGTH.html b/7.x/docs/variables/CONTENT_LENGTH.html new file mode 100644 index 000000000..a59b4bd49 --- /dev/null +++ b/7.x/docs/variables/CONTENT_LENGTH.html @@ -0,0 +1,61 @@ +CONTENT_LENGTH | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable CONTENT_LENGTHConst

+
CONTENT_LENGTH: "http://www.w3.org/2011/http-headers#content-length" = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/CONTENT_LENGTH_TERM.html b/7.x/docs/variables/CONTENT_LENGTH_TERM.html new file mode 100644 index 000000000..f4a3ee0aa --- /dev/null +++ b/7.x/docs/variables/CONTENT_LENGTH_TERM.html @@ -0,0 +1,61 @@ +CONTENT_LENGTH_TERM | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable CONTENT_LENGTH_TERMConst

+
CONTENT_LENGTH_TERM: NamedNode<"http://www.w3.org/2011/http-headers#content-length"> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/CONTENT_TYPE.html b/7.x/docs/variables/CONTENT_TYPE.html new file mode 100644 index 000000000..6e307da9d --- /dev/null +++ b/7.x/docs/variables/CONTENT_TYPE.html @@ -0,0 +1,61 @@ +CONTENT_TYPE | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable CONTENT_TYPEConst

+
CONTENT_TYPE: "http://www.w3.org/ns/ma-ont#format" = MA.format
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/CONTENT_TYPE_TERM.html b/7.x/docs/variables/CONTENT_TYPE_TERM.html new file mode 100644 index 000000000..4fe55a255 --- /dev/null +++ b/7.x/docs/variables/CONTENT_TYPE_TERM.html @@ -0,0 +1,61 @@ +CONTENT_TYPE_TERM | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable CONTENT_TYPE_TERMConst

+
CONTENT_TYPE_TERM: NamedNode<"http://www.w3.org/ns/ma-ont#format"> = MA.terms.format
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/DC.html b/7.x/docs/variables/DC.html new file mode 100644 index 000000000..1269efc5a --- /dev/null +++ b/7.x/docs/variables/DC.html @@ -0,0 +1,61 @@ +DC | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable DCConst

+
DC: Vocabulary<"http://purl.org/dc/terms/", "description" | "modified" | "title"> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/DEFAULT_CUSTOM_TYPES.html b/7.x/docs/variables/DEFAULT_CUSTOM_TYPES.html new file mode 100644 index 000000000..76a814e22 --- /dev/null +++ b/7.x/docs/variables/DEFAULT_CUSTOM_TYPES.html @@ -0,0 +1,70 @@ +DEFAULT_CUSTOM_TYPES | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable DEFAULT_CUSTOM_TYPESConst

+
DEFAULT_CUSTOM_TYPES: {
    acl: string;
    acr: string;
    meta: string;
} = ...
+
+

Type declaration

+
    +
  • +
    acl: string
    • +
  • +
    acr: string
    • +
  • +
    meta: string
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/DEFAULT_NOTIFICATION_FEATURES.html b/7.x/docs/variables/DEFAULT_NOTIFICATION_FEATURES.html new file mode 100644 index 000000000..627936ceb --- /dev/null +++ b/7.x/docs/variables/DEFAULT_NOTIFICATION_FEATURES.html @@ -0,0 +1,64 @@ +DEFAULT_NOTIFICATION_FEATURES | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable DEFAULT_NOTIFICATION_FEATURESConst

+
DEFAULT_NOTIFICATION_FEATURES: string[] = ...
+

The default notification features that are available on all channel types.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/DEFAULT_SUBSCRIPTION_SHACL.html b/7.x/docs/variables/DEFAULT_SUBSCRIPTION_SHACL.html new file mode 100644 index 000000000..1b3ac8fd0 --- /dev/null +++ b/7.x/docs/variables/DEFAULT_SUBSCRIPTION_SHACL.html @@ -0,0 +1,77 @@ +DEFAULT_SUBSCRIPTION_SHACL | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable DEFAULT_SUBSCRIPTION_SHACLConst

+
DEFAULT_SUBSCRIPTION_SHACL: {
    @context: readonly ["https://w3c.github.io/shacl/shacl-jsonld-context/shacl.context.ld.json"];
    @type: "sh:NodeShape";
    closed: true;
    property: readonly [{
        maxCount: 1;
        minCount: 1;
        nodeKind: "sh:IRI";
        path: "http://www.w3.org/1999/02/22-rdf-syntax-ns#type";
    }, {
        maxCount: 1;
        minCount: 1;
        nodeKind: "sh:IRI";
        path: "http://www.w3.org/ns/solid/notifications#topic";
    }, unknown];
    targetSubjectsOf: "http://www.w3.org/ns/solid/notifications#topic";
} = ...
+

The SHACL shape for the minimum requirements on a notification channel subscription request.

+
+
+

Type declaration

+
    +
  • +
    Readonly @context: readonly ["https://w3c.github.io/shacl/shacl-jsonld-context/shacl.context.ld.json"]
    • +
  • +
    Readonly @type: "sh:NodeShape"
    • +
  • +
    Readonly closed: true
    • +
  • +
    Readonly property: readonly [{
        maxCount: 1;
        minCount: 1;
        nodeKind: "sh:IRI";
        path: "http://www.w3.org/1999/02/22-rdf-syntax-ns#type";
    }, {
        maxCount: 1;
        minCount: 1;
        nodeKind: "sh:IRI";
        path: "http://www.w3.org/ns/solid/notifications#topic";
    }, unknown]
    • +
  • +
    Readonly targetSubjectsOf: "http://www.w3.org/ns/solid/notifications#topic"
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/FOAF.html b/7.x/docs/variables/FOAF.html new file mode 100644 index 000000000..7e91469ec --- /dev/null +++ b/7.x/docs/variables/FOAF.html @@ -0,0 +1,61 @@ +FOAF | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable FOAFConst

+
FOAF: Vocabulary<"http://xmlns.com/foaf/0.1/", "Agent"> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/HH.html b/7.x/docs/variables/HH.html new file mode 100644 index 000000000..3dd85e7f4 --- /dev/null +++ b/7.x/docs/variables/HH.html @@ -0,0 +1,61 @@ +HH | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable HHConst

+
HH: Vocabulary<"http://www.w3.org/2011/http-headers#", "content-length" | "etag"> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/HTTP.html b/7.x/docs/variables/HTTP.html new file mode 100644 index 000000000..3dca671df --- /dev/null +++ b/7.x/docs/variables/HTTP.html @@ -0,0 +1,61 @@ +HTTP | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable HTTPConst

+
HTTP: Vocabulary<"http://www.w3.org/2011/http#", "statusCodeNumber"> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/IANA.html b/7.x/docs/variables/IANA.html new file mode 100644 index 000000000..187d892b9 --- /dev/null +++ b/7.x/docs/variables/IANA.html @@ -0,0 +1,61 @@ +IANA | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable IANAConst

+
IANA: PartialVocabulary<"http://www.w3.org/ns/iana/media-types/"> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/INDEX_ID_KEY.html b/7.x/docs/variables/INDEX_ID_KEY.html new file mode 100644 index 000000000..2074d5015 --- /dev/null +++ b/7.x/docs/variables/INDEX_ID_KEY.html @@ -0,0 +1,64 @@ +INDEX_ID_KEY | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable INDEX_ID_KEYConst

+
INDEX_ID_KEY: "id" = 'id'
+

The key that needs to be present in all output results of IndexedStorage.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/INTERNAL_ALL.html b/7.x/docs/variables/INTERNAL_ALL.html new file mode 100644 index 000000000..351400430 --- /dev/null +++ b/7.x/docs/variables/INTERNAL_ALL.html @@ -0,0 +1,61 @@ +INTERNAL_ALL | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable INTERNAL_ALLConst

+
INTERNAL_ALL: "internal/*" = 'internal/*'
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/INTERNAL_ERROR.html b/7.x/docs/variables/INTERNAL_ERROR.html new file mode 100644 index 000000000..ece867726 --- /dev/null +++ b/7.x/docs/variables/INTERNAL_ERROR.html @@ -0,0 +1,61 @@ +INTERNAL_ERROR | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable INTERNAL_ERRORConst

+
INTERNAL_ERROR: "internal/error" = 'internal/error'
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/INTERNAL_QUADS.html b/7.x/docs/variables/INTERNAL_QUADS.html new file mode 100644 index 000000000..c8d49c3a9 --- /dev/null +++ b/7.x/docs/variables/INTERNAL_QUADS.html @@ -0,0 +1,61 @@ +INTERNAL_QUADS | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable INTERNAL_QUADSConst

+
INTERNAL_QUADS: "internal/quads" = 'internal/quads'
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/JSON_LD.html b/7.x/docs/variables/JSON_LD.html new file mode 100644 index 000000000..f8aeefb71 --- /dev/null +++ b/7.x/docs/variables/JSON_LD.html @@ -0,0 +1,61 @@ +JSON_LD | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable JSON_LDConst

+
JSON_LD: Vocabulary<"http://www.w3.org/ns/json-ld#", "context"> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/LDP.html b/7.x/docs/variables/LDP.html new file mode 100644 index 000000000..5a261c66e --- /dev/null +++ b/7.x/docs/variables/LDP.html @@ -0,0 +1,61 @@ +LDP | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable LDPConst

+
LDP: Vocabulary<"http://www.w3.org/ns/ldp#", "contains" | "BasicContainer" | "Container" | "Resource"> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/LOG_LEVELS.html b/7.x/docs/variables/LOG_LEVELS.html new file mode 100644 index 000000000..5a9d37686 --- /dev/null +++ b/7.x/docs/variables/LOG_LEVELS.html @@ -0,0 +1,61 @@ +LOG_LEVELS | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable LOG_LEVELSConst

+
LOG_LEVELS: readonly ["error", "warn", "info", "verbose", "debug", "silly"] = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/MA.html b/7.x/docs/variables/MA.html new file mode 100644 index 000000000..599c38887 --- /dev/null +++ b/7.x/docs/variables/MA.html @@ -0,0 +1,61 @@ +MA | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable MAConst

+
MA: Vocabulary<"http://www.w3.org/ns/ma-ont#", "format"> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/NOTIFY.html b/7.x/docs/variables/NOTIFY.html new file mode 100644 index 000000000..3cf275878 --- /dev/null +++ b/7.x/docs/variables/NOTIFY.html @@ -0,0 +1,61 @@ +NOTIFY | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable NOTIFYConst

+
NOTIFY: Vocabulary<"http://www.w3.org/ns/solid/notifications#", "accept" | "channelType" | "endAt" | "feature" | "rate" | "receiveFrom" | "startAt" | "state" | "sender" | "sendTo" | "subscription" | "topic" | "webhookAuth" | "WebhookChannel2023" | "WebSocketChannel2023" | "StreamingHTTPChannel2023"> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/OIDC.html b/7.x/docs/variables/OIDC.html new file mode 100644 index 000000000..da4426cc7 --- /dev/null +++ b/7.x/docs/variables/OIDC.html @@ -0,0 +1,61 @@ +OIDC | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable OIDCConst

+
OIDC: Vocabulary<"http://www.w3.org/ns/solid/oidc#", "redirect_uris"> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/OWNER_STORAGE_DESCRIPTION.html b/7.x/docs/variables/OWNER_STORAGE_DESCRIPTION.html new file mode 100644 index 000000000..ed7ee3e2c --- /dev/null +++ b/7.x/docs/variables/OWNER_STORAGE_DESCRIPTION.html @@ -0,0 +1,70 @@ +OWNER_STORAGE_DESCRIPTION | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable OWNER_STORAGE_DESCRIPTIONConst

+
OWNER_STORAGE_DESCRIPTION: {
    podId: "id:pod";
    visible: "boolean";
    webId: "string";
} = ...
+
+

Type declaration

+
    +
  • +
    Readonly podId: "id:pod"
    • +
  • +
    Readonly visible: "boolean"
    • +
  • +
    Readonly webId: "string"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/OWNER_STORAGE_TYPE.html b/7.x/docs/variables/OWNER_STORAGE_TYPE.html new file mode 100644 index 000000000..d865395fd --- /dev/null +++ b/7.x/docs/variables/OWNER_STORAGE_TYPE.html @@ -0,0 +1,61 @@ +OWNER_STORAGE_TYPE | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable OWNER_STORAGE_TYPEConst

+
OWNER_STORAGE_TYPE: "owner" = 'owner'
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/PASSWORD_METHOD.html b/7.x/docs/variables/PASSWORD_METHOD.html new file mode 100644 index 000000000..b973f2775 --- /dev/null +++ b/7.x/docs/variables/PASSWORD_METHOD.html @@ -0,0 +1,64 @@ +PASSWORD_METHOD | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable PASSWORD_METHODConst

+
PASSWORD_METHOD: "password" = 'password'
+

The constant used to identify email/password based login combinations in the map of logins an account has.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/PASSWORD_STORAGE_DESCRIPTION.html b/7.x/docs/variables/PASSWORD_STORAGE_DESCRIPTION.html new file mode 100644 index 000000000..717d8f280 --- /dev/null +++ b/7.x/docs/variables/PASSWORD_STORAGE_DESCRIPTION.html @@ -0,0 +1,72 @@ +PASSWORD_STORAGE_DESCRIPTION | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable PASSWORD_STORAGE_DESCRIPTIONConst

+
PASSWORD_STORAGE_DESCRIPTION: {
    accountId: "id:account";
    email: "string";
    password: "string";
    verified: "boolean";
} = ...
+
+

Type declaration

+
    +
  • +
    Readonly accountId: "id:account"
    • +
  • +
    Readonly email: "string"
    • +
  • +
    Readonly password: "string"
    • +
  • +
    Readonly verified: "boolean"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/PASSWORD_STORAGE_TYPE.html b/7.x/docs/variables/PASSWORD_STORAGE_TYPE.html new file mode 100644 index 000000000..9341ded30 --- /dev/null +++ b/7.x/docs/variables/PASSWORD_STORAGE_TYPE.html @@ -0,0 +1,61 @@ +PASSWORD_STORAGE_TYPE | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable PASSWORD_STORAGE_TYPEConst

+
PASSWORD_STORAGE_TYPE: "password" = 'password'
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/PIM.html b/7.x/docs/variables/PIM.html new file mode 100644 index 000000000..c0b24bd9a --- /dev/null +++ b/7.x/docs/variables/PIM.html @@ -0,0 +1,61 @@ +PIM | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable PIMConst

+
PIM: Vocabulary<"http://www.w3.org/ns/pim/space#", "Storage"> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/POD_STORAGE_DESCRIPTION.html b/7.x/docs/variables/POD_STORAGE_DESCRIPTION.html new file mode 100644 index 000000000..68fba4997 --- /dev/null +++ b/7.x/docs/variables/POD_STORAGE_DESCRIPTION.html @@ -0,0 +1,68 @@ +POD_STORAGE_DESCRIPTION | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable POD_STORAGE_DESCRIPTIONConst

+
POD_STORAGE_DESCRIPTION: {
    accountId: "id:account";
    baseUrl: "string";
} = ...
+
+

Type declaration

+
    +
  • +
    Readonly accountId: "id:account"
    • +
  • +
    Readonly baseUrl: "string"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/POD_STORAGE_TYPE.html b/7.x/docs/variables/POD_STORAGE_TYPE.html new file mode 100644 index 000000000..a97b3ab43 --- /dev/null +++ b/7.x/docs/variables/POD_STORAGE_TYPE.html @@ -0,0 +1,61 @@ +POD_STORAGE_TYPE | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable POD_STORAGE_TYPEConst

+
POD_STORAGE_TYPE: "pod" = 'pod'
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/POSIX.html b/7.x/docs/variables/POSIX.html new file mode 100644 index 000000000..7054fc278 --- /dev/null +++ b/7.x/docs/variables/POSIX.html @@ -0,0 +1,61 @@ +POSIX | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable POSIXConst

+
POSIX: Vocabulary<"http://www.w3.org/ns/posix/stat#", "mtime" | "size"> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/PREFERRED_PREFIX.html b/7.x/docs/variables/PREFERRED_PREFIX.html new file mode 100644 index 000000000..4f54f00fc --- /dev/null +++ b/7.x/docs/variables/PREFERRED_PREFIX.html @@ -0,0 +1,61 @@ +PREFERRED_PREFIX | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable PREFERRED_PREFIXConst

+
PREFERRED_PREFIX: "http://purl.org/vocab/vann/preferredNamespacePrefix" = VANN.preferredNamespacePrefix
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/PREFERRED_PREFIX_TERM.html b/7.x/docs/variables/PREFERRED_PREFIX_TERM.html new file mode 100644 index 000000000..c0f19e72c --- /dev/null +++ b/7.x/docs/variables/PREFERRED_PREFIX_TERM.html @@ -0,0 +1,61 @@ +PREFERRED_PREFIX_TERM | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable PREFERRED_PREFIX_TERMConst

+
PREFERRED_PREFIX_TERM: NamedNode<"http://purl.org/vocab/vann/preferredNamespacePrefix"> = VANN.terms.preferredNamespacePrefix
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/RDF.html b/7.x/docs/variables/RDF.html new file mode 100644 index 000000000..0c0a2b792 --- /dev/null +++ b/7.x/docs/variables/RDF.html @@ -0,0 +1,61 @@ +RDF | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable RDFConst

+
RDF: Vocabulary<"http://www.w3.org/1999/02/22-rdf-syntax-ns#", "type"> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/RDFS.html b/7.x/docs/variables/RDFS.html new file mode 100644 index 000000000..aaa9d3692 --- /dev/null +++ b/7.x/docs/variables/RDFS.html @@ -0,0 +1,61 @@ +RDFS | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable RDFSConst

+
RDFS: Vocabulary<"http://www.w3.org/2000/01/rdf-schema#", "label"> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/SOLID.html b/7.x/docs/variables/SOLID.html new file mode 100644 index 000000000..8fde26cf9 --- /dev/null +++ b/7.x/docs/variables/SOLID.html @@ -0,0 +1,61 @@ +SOLID | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable SOLIDConst

+
SOLID: Vocabulary<"http://www.w3.org/ns/solid/terms#", "deletes" | "inserts" | "oidcIssuer" | "oidcIssuerRegistrationToken" | "oidcRegistration" | "storageDescription" | "where" | "InsertDeletePatch"> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/SOLID_AS.html b/7.x/docs/variables/SOLID_AS.html new file mode 100644 index 000000000..39590fdd9 --- /dev/null +++ b/7.x/docs/variables/SOLID_AS.html @@ -0,0 +1,61 @@ +SOLID_AS | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable SOLID_ASConst

+
SOLID_AS: Vocabulary<"urn:npm:solid:community-server:activity:", "activity"> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/SOLID_ERROR.html b/7.x/docs/variables/SOLID_ERROR.html new file mode 100644 index 000000000..437ca54e9 --- /dev/null +++ b/7.x/docs/variables/SOLID_ERROR.html @@ -0,0 +1,61 @@ +SOLID_ERROR | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable SOLID_ERRORConst

+
SOLID_ERROR: Vocabulary<"urn:npm:solid:community-server:error:", "target" | "disallowedMethod" | "errorCode" | "errorResponse" | "stack"> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/SOLID_ERROR_TERM.html b/7.x/docs/variables/SOLID_ERROR_TERM.html new file mode 100644 index 000000000..5df87ba77 --- /dev/null +++ b/7.x/docs/variables/SOLID_ERROR_TERM.html @@ -0,0 +1,61 @@ +SOLID_ERROR_TERM | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable SOLID_ERROR_TERMConst

+
SOLID_ERROR_TERM: Vocabulary<"urn:npm:solid:community-server:error-term:", "path"> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/SOLID_HTTP.html b/7.x/docs/variables/SOLID_HTTP.html new file mode 100644 index 000000000..e5b061929 --- /dev/null +++ b/7.x/docs/variables/SOLID_HTTP.html @@ -0,0 +1,61 @@ +SOLID_HTTP | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable SOLID_HTTPConst

+
SOLID_HTTP: Vocabulary<"urn:npm:solid:community-server:http:", "accountCookie" | "accountCookieExpiration" | "end" | "location" | "start" | "slug" | "unit"> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/SOLID_META.html b/7.x/docs/variables/SOLID_META.html new file mode 100644 index 000000000..6dde6b0cb --- /dev/null +++ b/7.x/docs/variables/SOLID_META.html @@ -0,0 +1,61 @@ +SOLID_META | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable SOLID_METAConst

+
SOLID_META: Vocabulary<"urn:npm:solid:community-server:meta:", "value" | "ResponseMetadata" | "template" | "contentTypeParameter" | "preserve" | "requestedAccess" | "accessTarget" | "accessMode"> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/TEMPLATE-1.html b/7.x/docs/variables/TEMPLATE-1.html new file mode 100644 index 000000000..adb8b0d50 --- /dev/null +++ b/7.x/docs/variables/TEMPLATE-1.html @@ -0,0 +1,61 @@ +TEMPLATE | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable TEMPLATEConst

+
TEMPLATE: Vocabulary<"urn:solid-server:template:", "ResourceStore"> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/TEMPLATE_VARIABLE.html b/7.x/docs/variables/TEMPLATE_VARIABLE.html new file mode 100644 index 000000000..862f04113 --- /dev/null +++ b/7.x/docs/variables/TEMPLATE_VARIABLE.html @@ -0,0 +1,61 @@ +TEMPLATE_VARIABLE | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable TEMPLATE_VARIABLEConst

+
TEMPLATE_VARIABLE: Vocabulary<"urn:solid-server:template:variable:", "baseUrl" | "rootFilePath" | "sparqlEndpoint" | "templateConfig"> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/TEXT_HTML.html b/7.x/docs/variables/TEXT_HTML.html new file mode 100644 index 000000000..c54c26fcd --- /dev/null +++ b/7.x/docs/variables/TEXT_HTML.html @@ -0,0 +1,61 @@ +TEXT_HTML | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable TEXT_HTMLConst

+
TEXT_HTML: "text/html" = 'text/html'
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/TEXT_MARKDOWN.html b/7.x/docs/variables/TEXT_MARKDOWN.html new file mode 100644 index 000000000..ce51d94c8 --- /dev/null +++ b/7.x/docs/variables/TEXT_MARKDOWN.html @@ -0,0 +1,61 @@ +TEXT_MARKDOWN | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable TEXT_MARKDOWNConst

+
TEXT_MARKDOWN: "text/markdown" = 'text/markdown'
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/TEXT_N3.html b/7.x/docs/variables/TEXT_N3.html new file mode 100644 index 000000000..f6bf4cb39 --- /dev/null +++ b/7.x/docs/variables/TEXT_N3.html @@ -0,0 +1,61 @@ +TEXT_N3 | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable TEXT_N3Const

+
TEXT_N3: "text/n3" = 'text/n3'
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/TEXT_TURTLE.html b/7.x/docs/variables/TEXT_TURTLE.html new file mode 100644 index 000000000..438e1ea2b --- /dev/null +++ b/7.x/docs/variables/TEXT_TURTLE.html @@ -0,0 +1,61 @@ +TEXT_TURTLE | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable TEXT_TURTLEConst

+
TEXT_TURTLE: "text/turtle" = 'text/turtle'
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/UNIT_BYTES.html b/7.x/docs/variables/UNIT_BYTES.html new file mode 100644 index 000000000..0a06ff181 --- /dev/null +++ b/7.x/docs/variables/UNIT_BYTES.html @@ -0,0 +1,61 @@ +UNIT_BYTES | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable UNIT_BYTESConst

+
UNIT_BYTES: "bytes" = 'bytes'
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/URL_SCHEMA.html b/7.x/docs/variables/URL_SCHEMA.html new file mode 100644 index 000000000..30f862cc9 --- /dev/null +++ b/7.x/docs/variables/URL_SCHEMA.html @@ -0,0 +1,61 @@ +URL_SCHEMA | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable URL_SCHEMAConst

+
URL_SCHEMA: StringSchema<undefined | string, AnyObject, undefined, ""> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/VANN.html b/7.x/docs/variables/VANN.html new file mode 100644 index 000000000..f0232d716 --- /dev/null +++ b/7.x/docs/variables/VANN.html @@ -0,0 +1,61 @@ +VANN | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable VANNConst

+
VANN: Vocabulary<"http://purl.org/vocab/vann/", "preferredNamespacePrefix"> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/VCARD.html b/7.x/docs/variables/VCARD.html new file mode 100644 index 000000000..9d657d0b5 --- /dev/null +++ b/7.x/docs/variables/VCARD.html @@ -0,0 +1,61 @@ +VCARD | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable VCARDConst

+
VCARD: Vocabulary<"http://www.w3.org/2006/vcard/ns#", "hasMember"> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/WEBID_STORAGE_DESCRIPTION.html b/7.x/docs/variables/WEBID_STORAGE_DESCRIPTION.html new file mode 100644 index 000000000..0bdc9dd64 --- /dev/null +++ b/7.x/docs/variables/WEBID_STORAGE_DESCRIPTION.html @@ -0,0 +1,68 @@ +WEBID_STORAGE_DESCRIPTION | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable WEBID_STORAGE_DESCRIPTIONConst

+
WEBID_STORAGE_DESCRIPTION: {
    accountId: "id:account";
    webId: "string";
} = ...
+
+

Type declaration

+
    +
  • +
    Readonly accountId: "id:account"
    • +
  • +
    Readonly webId: "string"
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/WEBID_STORAGE_TYPE.html b/7.x/docs/variables/WEBID_STORAGE_TYPE.html new file mode 100644 index 000000000..979b1d208 --- /dev/null +++ b/7.x/docs/variables/WEBID_STORAGE_TYPE.html @@ -0,0 +1,61 @@ +WEBID_STORAGE_TYPE | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable WEBID_STORAGE_TYPEConst

+
WEBID_STORAGE_TYPE: "webIdLink" = 'webIdLink'
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/XSD.html b/7.x/docs/variables/XSD.html new file mode 100644 index 000000000..acbfaa7d0 --- /dev/null +++ b/7.x/docs/variables/XSD.html @@ -0,0 +1,61 @@ +XSD | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable XSDConst

+
XSD: Vocabulary<"http://www.w3.org/2001/XMLSchema#", "string" | "dateTime" | "duration" | "integer"> = ...
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file diff --git a/7.x/docs/variables/modulePathPlaceholder.html b/7.x/docs/variables/modulePathPlaceholder.html new file mode 100644 index 000000000..36d955256 --- /dev/null +++ b/7.x/docs/variables/modulePathPlaceholder.html @@ -0,0 +1,65 @@ +modulePathPlaceholder | Community Solid Server - v7.0.5
+
+ +
+
+
+
+ +

Variable modulePathPlaceholderConst

+
modulePathPlaceholder: "@css:" = '@css:'
+

A placeholder for the path to the @solid/community-server module root. +The resolveAssetPath function will replace this string with the actual path.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
\ No newline at end of file