From b29dd907c12cd4e5e8731f7b1d7dc62b1ffdf31b Mon Sep 17 00:00:00 2001 From: joachimvh Date: Fri, 20 Oct 2023 08:35:45 +0000 Subject: [PATCH] deploy: 762d703df7d0f178cdbd0b53b21ef7ef9b2d4919 --- 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 | 352 ++ 7.x/docs/classes/App.html | 158 + 7.x/docs/classes/AppRunner.html | 360 ++ 7.x/docs/classes/ArrayUnionHandler.html | 244 + 7.x/docs/classes/AssetPathExtractor.html | 201 + 7.x/docs/classes/AsyncHandler.html | 242 + 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 | 233 + .../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 | 605 +++ 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 | 226 + 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 | 175 + 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 | 185 + 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 | 139 + 7.x/docs/classes/OperationHandler.html | 178 + 7.x/docs/classes/OperationHttpHandler.html | 180 + 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 | 102 + 7.x/docs/classes/RedirectHttpError.html | 279 ++ 7.x/docs/classes/RedirectingErrorHandler.html | 172 + 7.x/docs/classes/RedirectingHttpHandler.html | 280 ++ 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 | 375 ++ 7.x/docs/classes/RepresentationMetadata.html | 764 ++++ .../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 | 141 + 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 | 280 ++ 7.x/docs/classes/StaticFolderGenerator.html | 156 + 7.x/docs/classes/StaticHandler.html | 196 + .../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 + .../SubdomainExtensionBasedMapper.html | 551 +++ .../classes/SubdomainIdentifierGenerator.html | 166 + .../classes/SubdomainIdentifierStrategy.html | 220 + .../classes/SubfolderResourcesGenerator.html | 167 + .../SuffixAuxiliaryIdentifierStrategy.html | 218 + .../classes/SuffixIdentifierGenerator.html | 159 + 7.x/docs/classes/TargetExtractor.html | 182 + 7.x/docs/classes/TemplateEngine.html | 186 + 7.x/docs/classes/TemplatedPodGenerator.html | 208 + 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 | 263 ++ 7.x/docs/classes/VoidLoggerFactory.html | 133 + 7.x/docs/classes/WacAllowHttpHandler.html | 243 + 7.x/docs/classes/WacAllowMetadataWriter.html | 211 + 7.x/docs/classes/WaterfallHandler.html | 220 + 7.x/docs/classes/WebAclReader.html | 392 ++ 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 | 485 ++ 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 | 82 + 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 + .../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 | 95 + 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 | 125 + 7.x/docs/interfaces/AccessCheckerArgs.html | 108 + .../interfaces/AccountInitializerArgs.html | 138 + 7.x/docs/interfaces/AccountStore.html | 179 + 7.x/docs/interfaces/AdapterFactory.html | 110 + 7.x/docs/interfaces/AlgJwk.html | 304 ++ 7.x/docs/interfaces/AppRunnerInput.html | 141 + .../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 | 452 ++ 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 | 479 ++ 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 | 75 + 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 + .../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 | 158 + .../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 | 884 ++++ 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 | 82 + 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 + 817 files changed, 143337 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/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/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/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/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..350549c12 --- /dev/null +++ b/7.x/docs/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA52d23LjRpKG38XXs+sZe8a7O3dsiWrJpkQ1SXXbsbGhgIgSBQsEOACobnlj332rAJKoQ+afSd+0Oph/fQUU6pB1/u///a4z37rv/vndZL02bXtb5+a7v3y3y7oX+5up9tv2+9Hy7y/dtrTm16LKv/vnf/7fX7zQJR20FMI9tXW578y9DXVTdabJ1l1RV4va/jbC1mXWtsbigDqM428/hE+3NrvuvjHPpjHV2oZvWtMQfFInkdv24sWsXzngySxw6n3V3VRFV2Rl8QcDizQK4n1Tb3fdlU2ounlnmYEKU3fXJstNc51VeUk/ZagQaIteS2IGEw7fFW9F935Xd8Vzsc5cZvhoKpsv7HtQTCCH8eT5wmzrN6ONCOphTBtTdVKmSjQi8cIF1WBTocj+2NT7nYadCiG7LJedTbg1m0NCgcCqvw6Fe8ibX5qiY5iUELJ3O4Kz2wlhFvuqIp/gaILhmyZ7f6hspuKLYSyBPBukc5Xq9FvX9JUAAUw0mPherfmH86yQ0tXbYn1VlOYy67Ih65DPRuoged+9TPbfirLImnc2h6UiiVk3xR99aWebmFSkYZq8b+T4FCV1KjKiqQhFtbnuup34bKEOkw+JPiuq11vTZbn9rGyZ5cWqOPivr/7yHzJb3/9rb9rOveC0aahMSogwszU//X1arevcJtzSlrdsQ7hEpEziHj2JnPGzUo2S6OLHvF4h0S5eMlsFlqv3HQPzBCKrLFy71pjc/rF+UwvfmlOfHQtICVorxmA9tLqyIdqfW9adY4Qyu34tDHrkUSCxptusKJemIstUJJBYrka/6VPpuTDNbbbbcVBKKdLrZlPbJq1tv9ZNDt6eEErs8VmWtrXszIb5WKlOIs/qzYZLhcGmIBSVVxzZeoUQSuxjIsFCFom0TPCFzvo293VuCx/tuYd2BQm/aK1+xxq+Xq17M9dS9S3frKb9cEIkM9t636xR7RBItLwW9J9onUh2Cc13TBOJxFua5s00sK4NJCLP9lZ4Dy5WSDTX9lmHYteY1lYhvTt5UVf2aUgnSQohxfbQlKBvECsUNJgOo11BGr7pYl8yuTOQKHifTdNXyCztKJBYX8zTTe6cUlBDhBoVERTE0S6QirX98nnhskBLonzBGSyu10PKRO50lW1QPgkUIi3M+QwwFCmYvUMPXzvQKIit9d7sp2R6O4QIMk3WmKbPF6j8EipILSrbL1qWxVpsHhglpNf5O5uiJxsm1KXJ+MGR0I5IF9n6xeQsKDDLnJ+/voJWL9XIxFOimo4DehLMq9amnBc5P2yTSCDvJSsqk4M2KVYoaCuz3ZW2jZxW1jMlshspg9yyAOXCtwoUl8rlG/mao1FghL3CSZ7t6HRjlH+Gzno3QoCz4ro0ne3ytXy+wgHkuG5yIbFOgjNYQtLEOgW5eq6FNPAkmLdvO9fNrTKyLxjaIanePrkSs3ypm+7FxgzyMScV+Lu6NflpMI3vDrNSDd+faOHTmBfjOA5+S8Z7ralGRWQdpnN8Jat9Ljaur4lmDymVisrnskgh0awTgMZHE4nAc14a+h6eXSJ1ma1+QEMVSzQ8adia1gnkzjVvjfSdE5WK6uZ22OEgSqWirupjY4wTmFVLsdivPDPVpnsBRSkWKZius6z4hLRUyReeeJQoebbzUmZrgXgUicxv3WW93m9d0tX0DAkpk7hNDWtRzy6QXPYoqk1fVSAiodOR/WZiafv8oMTBELrY5jvn87sWCc2lYb0uJluEbb8Awg8SHQ8NwFAqTHUTDd7aHpAStFKmy8U6VclUvjCPVkxpgIc8GiHDDVsfZ9p4GKGSqYmTLvA5vRyTWzHWol4ZoZKpxykC4bEjmYJbi8haT8uPQzuXpl03xY4equK1QgzHb4FTN1Eh6uV9fS+NL6UaSPTWcLhRTW7Ek9ZBsinNOTkZ6+WYlMvFgFiOY2wH8FvEOpls6yz7wuizUjINVyiJpAxy36tsW6x/butK5W9iPYpp+nsrjUElEshDs+XKmfLpv/ZZKU79USpIhX6V1pvqdavapTT4HpRKQf20z9D4IqVSUBX5h1NC+rdd0Vg/iB2pigRnsNiRKlqHybaf0Npaoq9QuRUXlOpcKnhoVqyPQyykQI1ikdcinrMK0WmXtotg+2Q1ndNihUh7bzuzPQ75c3UBpxTobkjx4BWLacBo5Rhs18P+Szg9gRlzKtfxyp5KfrY91SiIACSF/9bPc5xGC5hyResguW6eitw6JmBgLdUIxI3pem+NT71EIxHH5VMQmsgE7lZsWggRZu6rHKalb0ekgwtncjSESogws5PdPUIEmWX9lJWf9nWX8WPzhAgyG2Pyd9ElIWWIO7zOk+1LS/U7p5TpzbCmZxjc3jMeOyvF/PZFXM9LiCSmrSVojjXAsDbh5exEqSQqWIWl3ht0bU2fC/N1WnWUlxCYNRz+iUIBZrEVg6pOgEN7ynG8m1zeJ5dqMNFbN0vBPLOOszTd7b7sCoHnyWRu937f1G9FDjxHRngOG34hIIZxbLf7znkaR4eIHYDllJBe3ZqtfUvskVEqTM3Nt3AxFDMKwykx/TA1BX00SqWiQpjEkEeezxtzjkuiBqvdw9MH2Zq8cJ3QfkwQjNYAsRiH9XGHto6p/QgRYo7uWIsSmpRJ3L5vw7WukUBiaXIDrZPIs1w7u4TUUiz+kjs2PSIRYv5i3kEG860C5XNW7o+beNiHo3WIPMv+eB/2QLBtRCKBPG9HGRi/JWUSd2FKaSKKlCm486ffzZpYDxiYFRxuSiswSxzck4wVmNbajrEbzjrs4wZUWgnp9VC6NGWe1wox2J83yghoqYIvrMilVJjqCgtsWxOJwLOtG3hzz4w4/dhILhUhSoWpzWtef61WtesWgHEFRojZ32yVNqxDYSs9QgSZvVdn35IHRgqZJo0eUipMFWvQs2rP0Tmmq6fQriGxuUefb0z3UufDECWbtwmRzJRmwymVTLX+RH/WgUGDXawU8qXn1T9pnbtuolzGSZ1A3pfm8+BX8vt9SBnm2jqwbg5DN1RhDAWY9Wbye+uxZ24vb/mOvhMnRfy7H/vOJdpskUgUPOnzkzIFFzyf8Fx1f9jI/KutWdqXYmddyiKnayFWivmdNGicSATezXZXGreiDpZORiiwT72IYdHIE5mulEzLnW6LjiymhEjLBC3H2asmVCvFz1whru3Lnd+LC0Lsn1SfbNRpyQ9Vq2T7SkSfu0M/QOYN7ZBU5Gtp3WiqkYhwnC8SQNarasEWKYNccVz+nDF53drSc1eUnvTCxmtaB8lNsXHzqg9w1zGlglRXr0vOBCESma7pLVrnJHBnyZAykSs0V+e1U7YFz8rS8IUoEggs02+HGFbtc29NygRuK50mlGoEouuUilORtA6T27Z7aer95oVd0pNqziOyo1isVMkHHVtKpaTiKQhGqGQfBwPZfi6vVcbAuOyxQqK5xQv9wSkgB6cqTLVOLqCNVpEiNyukTOTyPZ7ALHBe+sVYfG0SCCDrVNP2AdBRZ6xUx2cf9oy6/r5YC6OksQLSSlvZDpMGw0gDgYslkAdOy9GdlGNVwvKSWCHQDuX6OAoLuYwWx9AqltlQKkhtzPq4qfMqK0rYtwNiIQ7hhNtzzrYdtcv9zi0/RLiDBPNqV+XzKRrYBRI61FZ9mu0gRA80miFn/1QWa93+Cl6LY9BkyVSEmG5h9Kpe5M/AG0g1mAiLubqM90Lg+YZ2RFpk1Ubc8EWIRKbtFC9tQrdu4BEUZF4rxiAXZlKGuV/ReF9ghpz8mR2UG20CofcIEMYXCCxxL0CqEYgg9/lWSHEr56rynfGMAjPmrK23yE3q+lZMyQvbqqAd+IlEwxO34DJCJRv2BWmdRG65TqBnxIyN+YY2vUYCmQUoYvjS1ixvyvPzkRrHojxm7k+cLkcG4fsTUK6P51jbSxEcdXoy7q3x2jNjUMIlLjy+TH1y2cL0Z4MLC/wplUhVDa9ySoHuTq/BXXVCJDBVD3vmc8ID4fRnwS3qunOL31zp5984FUlMdXcMiHEccHhZPaoMq2xdbW1VblXR8YQizSm/cphzYtTHcwZdWDFEqRB1mT0b7BLECkgztqeUa+5H4ZSYbqs46zvzjxoKMEveOHLejpFBLbx0JIG849FdoH+aalRE/tyws84LW9qMVprTlIEbpGJHfHmtHIOrijSlF6lhLO7ESys02ZaAjkbM2G+4pnm0QcIua/5V4mH5VCMTH3bWJzKoK0nrtGRpEQmv1cbA+lCECDLhmc7a85x7nXLBA6+VYijW/R0uzIaqWKGkwXcPNTLxqi5z0wgvn8hkrvCQ6ufTLN3llDL9UHmBhTm0TiZLuyUplYL60tT8trpUg4nyu5/z1p6297Aned9PpOsqoD4vFpAYjBTy9095vbVtm+5QBihXxTM2cagIAvWZsYBmlxcLcTz3dYPmkgEgxnE8PxffzuoCiEHk+JSfhpEi/ipze/lBYxsJIEuoZ/Q1zFHpNsaDNyZlkFu/mkqzuIYRQra7X0G1vJBTinT1QNyfvevhocpON4mBkWJShrnuCVQTZKxU5LPprb0Hr9fJk/ukTOaK8zmkDHNLcYdVqsHE1qz3jTkdeav8ZHIoTazSOXK0TkleuoH9rr1v6q5e1yWkR1ohhmHq2+T40kNGqGTfuo27rlTDUgnkMJ6+u9PXdvzjJxqZKA4JkzLE/fzTbbFpDpvvwLAIrYPkoYq3/X3cX6Z1CjKASeGbAm6UjwQa1tLQi/RDOyQJm7c/q3dtu8M3ND0rWgfJdZFzk32jTSbQN66NNh2BXa+SSBDvS7but2PBiVFCpGFKCyVoHSZbwXNW8suOYwWkmafJuuSaZd8qUIb6/Ye//vAju12FUqmp/NsSKjV12NYsYo8yNbcf0Zeog0jFRJ1tQqRiHg4BcE9CXwvKKVV0+Xud863IY298q4qimU4AYiGOl7p+1aQpoVOQUany7ApS7+qxnN4KKYX1SOuKq8IDs5rDVuSUClLr5hVc4xKYIafpt7kfj/sUdztg/RkxsXMztE5B7o8TMrkEDmUKLjySKtWIRPtSbKYK7JD09atbcC42u5QMcX/Lmk2Lr7ZKJCLP7Q/aGvIBQzsiDf5yv83WNBMbaoQVVe8IWPv3iSpE/vCPn0JkNOGLuIRUAY9mxlMkMSkegZgdPT4K7OSJYOXm56+vNKQ3wcC73WJf9RfE7PYdDQkkEOZ6sqsmq9rnutnOd9GNkj6TUkJ0V2+LNd0Z87mJTIYyCx4SKljyEGFP20ZAooYaDS5c18hna1aOI1EMYQexKMevmWh0cA0yvKSZTZZUJkGDpUSQmygldHBTMConnFiIwL9eVcATUhEeLAVEKUNIIfy0NoCHBhIEs80ZevXRLEDC2x44Vqg6C8nXO7QUwt2ldu7cj/bnFrUuhE7E0nflsV9KCIOjS68jDsj0ZcQJJLynDeYGRixEkNytBlKDFgsR+OuZo6UaITwRYrC7hQjku9GOMGJrrG2HyaudPQ57sXOEcTdksF/gZBURwyUbGDRqIM5b1sjzIhEESp06n6vp0NH4pMNFYMneVohzS4eDA4N3zKNSwnPBqLoDehzN6V4ABnuyQwx1lj2bHVi1Pgq+ZBM6Afs1a3KTc7DBihD9RHyxnr65a4HigSAPRugQ9jSTdeF6nSQxlKhgqImIRRLw8OX4LkAskoCBH8gSAxVCwkUkHlRcQcJhoYt/XreBOcubLUNAf040mu6WEAZGx4xu+XQwshXDvPOxGZanwKh4Wo3PxIxWiY92ptFcYkNaCKQPXeafGeilaMJFNCw9lElQN5XJopwRAr6+4vLrCxCIPVPFY8GzVEJcfJYvW4AoIQTXm3S/ns8b7QJmwzRF1FAtFRhVxWDUP0EV6a6GkFTQWxlCUDggzOd+QoewfvftMPVDYgndmViUCLz8zEjCqS0cQzq9xeMPLguf7JxYG4FYq3FibQTjEYS6OCK9OprTiYFsjcDLUST9IYK9g3ZVmDKn0bEIAo+nZ9Cko1WFEL8eqdShNb4mq4ZREEfqsR+NE6MI0tPbWDwtxfD0YC2Ap8WaCPjelrqf1e8tYhDWAoNGK0/5PEAqIfo0XA6goUaHm+87mTeIBCB2ffh14AkomXYPMeS0ewJx6+RsJmWy2GiXMHyGqhV5ibsYyeegO5FCXHT0Cp8TKCEEK4awzhi6So4r4QcGaKkEb+HXDRQYJfYg9L0HZk0/W80BvT4aOSew8jMiOS1817yJp8ZRDDO4DHEwagDj6AVEjTIN1HWEIM4JVCBUoPh7GmiYzdOQZO0qDFunqafV0TYugsdt4IqgqknesyZ4uZMHWDoKgCMiVjEFXGYFU4Qp3MHxoD/sCzDIbY9fvTTOvaCHjEMJhv1B5xdnkAKmVyhHAPoG5Qg0bsxH48KpDELjHeU0M1ZBpHTiig/WHLgS4fmdkXyOxmGE6E7bYt1YdsFU14QOYvsLrqOtMj5utCNMuGeRbwIJnQaL8lmk0eDcsT2Q5QQakM0ntuBC1CDRwHJlRQ70KBp6sw+bVXk5ioTYUsHGwGgh3o2H8k3maBYgye4CPseyalUU3qJwTPeEKrD+uc945mgZO8eNZMLKUNO2QUPcve/McfFq2gL/9b/+42//+CEk9M1//ot5JyAnm5oTza1EJGpShWV5czGmtR5Fy2EToTIGehA8YINhcI6adtgCItNbI2jlOHQSuMNHXGiXecM1hMls+BEXmEVa02Tv0+HinwTl2USOtws1Km0HWCw4hxiP+KRIcrgnYbriuDFEOTsZREK8po4pKZxO5PeX6bqpg/iM1gM3sit46drDE4pZcIgoZA0T2yXedLvr3DWC/bq5Zh/uKhiQhERFpZPNM4kUt0DJJKl1+FkO3bmlXXSmCIwS6eM+WjozMA4/S6Gdt3BYPBsTPJOOMpwJSWMGm8Q53OtdRoNWAygwqkgu+1/UZWnWLC+UqKnkYZsRlj1rk+Ga/NPeNEmZ8W0y59QyppiTSaK49QBxcPebFM62nTPz5k/cDmGPvyvCF9VQQYfzpyeMb5Zotk6IlrIOmOPvivBEDTb8qgjbL2AgQve/i+GPV5M22e4lgfhGLYkaSgxx7CgiyxxOAed4g1XLopPLN4okdyNnusvhQPKNEmmQZSXx+T2TRDnc7vS5XmdP+zJLM2IikInDPB/ZtAZGPYlsfyKzTBtPlCZ9ukQgEk+OLuGDBUY9iXCpz/Kn72sm4WtlmtdsctfqlG5q+8Bm3pDFJbRKrD5CYn/lwAqtEmsYlSES52SQCMdRmBhw/F0b3i3BvrMPzXGOdpHHetZ6n/p00ApZKEKrgrX3rt0gYL75TFpSXcZ2FY9qs08GNQF4VpRG5BZNtyer8tGiZNDZITCKJLYx0LcCo9INryfOVmTW01a2MuRhzqpnkdVTZJZo/eijm4skvp1vU3PIuje0Sqx+zznjYvg2cczi4mL+cLd6vLl8/GX620h6O5yE1H4fKkLejxTqfjG/vV8h1KBQoJbT1erm7uPycTG9nd5+mC4eZ/OPN3eIzQTRRLaaLyYfp4+X0+XF4uZ+dTPHEaVyRSSr3+6niOrsEDOjQ89goHs60D0KdH8/u7mYuNd6/HnJJEWkUeJmlyriQaaEzi9WU/dRFtPJrUT2tUr88n6y+DR7fLi/nKzoD8iJlRH8+vjly5fHq/ni9vFhMZveXcwvp5dSRGQgFOGSJC5RkIfVNRnI/g6CuX3c7LjvSCFkAHoxu5naMnKxmF7avzeT2VJbaHUh/1zUXJEWgqDI5ncrF9R+0Y906ocKNepxNV2QpYOQKaDsm3t2JUZ8spMIAC8vKMLlBQoyvZo8zOxXerDf5raPhSwjlE6BvZuvbq6OpfVqOlk9LDCfDKCIaPnw4ZSNH5fXTDvBq0EUV/PJFQVzv4Ng12TGvUaZ9Xq1Ilsq9zsIdjO5m1DB3O8o2N3l9Ffg+Ph2iLG58m4ye5zMyDT37RrMdLGYLyCoV2hQnx4ml2RuCxUA5Rpg2xBTjIMJBJ5dkl/T/owCzT/aWujzdEY++GgFiFsyN9yivNAXOzIXDBYQdH5DVzvudxTsy531TZXNFytWR8BV1akKIO8ny+WX+eLy8Xa6up6TuSKSaGDKNED6c6LhUoIUIvAN2V7Zn1Gguf59aakSzr7lXP+C8+XNrzTDGlDAxfTK1lHTy0f3P4YRac7Asa4CKQTgxSXZrtmfcSCyZnK/g2DL+eyGLDC9QQr4SDvuR5sYnG1TPLMOwiZ+rBFxXGM/WkWErWPIqn60AsRqens/YzpzR9u//U0BePw8WdxMPswg6SSCwF9X9sVvSTfiZJQAt5PFL5e2WmchR4EEuvuRRdz9KAW2fuuKS5GTGUAe7m5Wjx9+W9He8mhFiMXscXlxPaXdgdEKEJ8nd2Q6ut9RsIvJgizsvQEE/DL9cKNuIFixOgKukUhVAPnrknxV+zMItK3z/XDL5n2Zrc1Lv3aawpBCAM6e2rrcD7Mr4Wrg533Vrzlov481Ie6nv/u4/LihzluVSzIpIQZfRwd5B7Br4hzvGHCMJz0dIEDFMgw9Tk8J0FiGoGV5tS+fi7L01wZ5NM+OMG1rmu60npMkhRIRNi/yNblQJUZGQhHstvFRZ7rF3FAHse740Lpf30jjRjvArEuT0TvNRlSsgbi6Mtz+Pp+YyBC0rtZZR3J6CwraLzWcbDaN2bi9COHmBw9E6ERsr7o1bRss2Y2hvkpEEkdARZs4YzwXQozqdKVYf6/6jo8hEopgaiIxZnJTigEuN+s6Nw9N4ark8bhGispIAdzmZC2ckUJ4Pn+Obzv1gSczhLT7xsxsheCOmrPflGy6UpWIXDVZUcrMQIagLoO7Odh2VaM2gtIhbL/QFGemWINxrq6enh6C4YUiGbhcv5gtWfwDAQA9m2794s6JbA1Zyfl2hCnKjnYeBosY9LAIikyYUAFRFdkQu9+FYMnxl2Fo8vTLGFK0L0LznYgQsHY3/UU3Lnio0Qwgm4MTyO3KH3m08hy0raNUYKtTYKXzBNIINMcKkFGdtjA9NCWKwNdBbHc4Mr+uuqZmkKHmDFy6iZ7H0nvqIb4UehZIj6P54M6hJhZqBexQhIHD+QluleJwKyaDjGUYemmes33JsQ5WjDhd+cpATnaMORxhRvuMvh1jbuPLtQPILXWrdoLoe73u3nWOchJg0H1dFmuyMT0ZMWDY5fBm2JLqKzBq2Ap/0xnSSwoEGOSvoOT6+IRMgL7vbH1TbF64JB8FGDRoTC50s2glQrttNLyX6ZkliDnorpqaR/kiAHzJWt4nOhkBoDgt9r+2jucVWYRjDcJt3TkHrr9+PPKHBCYqhGzHs8yJvQselRLqwFw2jiQQxnZ3DyYYONm75Qcnd3BFAHL7lg9hN3ERoHY41JcHHQQQ1Ht9VVa6FLRfI1wU7AMJIQQfVrfTsIMRAsKxENSL4rQCnj+0J0TjU3siLHmihM9jj5SIQOH6Xp+Qru2NgjLNUG+AAfs17umSfB8RSGTY8a5QADtKICw4hyA5cNRnUkoJ7bb0a8CRDmB/r4sKtby+XcAwX/NgAoHLou3Ck3XwmA7Sg2i2GTlQto03+0SBnIPXHm8lGo6dYZtIXi1H0d9yLLgZjFQJ5+rMWINw/X43EtJbcNA9n89GK0K0q/pyH59q6kE8O8BUdbPtz0lBGT8RAeDO3ejjunU7srX0zDqILbYNM6CUqnTIS7drv6BzLSHTQaducDU4WYeEHmU66CyrrMtKj8oTMgkq+AuxRsIRV0pEMOZaiRTldofws4aRRIKdttSR9UYkkWF0mTgZJcCnfZbzD9JbJURfbZJelGeWIKc2FviypBCBi51ZZs+mJKvB0YoQY9W9quPDqTxWKoPQ3lVd1kwhH80A4ppTtyWf75mGCgF1n61fbRkNN/6HLE8iwNKtnCGJ3tKZYJwLt6rZHBpJVDD+E8YaiMv39LjeYIFBbTtw7Pcwh/v7OE6No6jLNzNpbViueog1Mu4W+gSJSAZyG5kTKNrTHIP7I0asZ8FP8yQiAGwzd07bH26Eze3Up3CRBMGOp9iz+TlUQFT3sayfFBmIVmK0qxP7PPfmby0NmL4EwdzJl3l/9tKtaWg/IdYg3K4sukmVX7iFEiTLF0gg2xHZZktj2xS3dIjFhTIAtamxXdU3FZlNTkYEqC+yqq6KtTvavuBKWqrCSO/6Rc6xSlUQOXO3edBZ42SEANfNz7mxCM8MIcNua54y2iHGds1ydwGE4UmBBMGOlwx/2tddP4obHgnnMUmlBs17M5EEwoqtv5CB7r+mKgEZrGPgmZEMQPdVYR08trb0zAjSn2zbn/1SmPyS8UlSFUC+Dac2mC/F4YIPipiIENDW+8/vcIFdJElg//P/3LqbcVEBAQA=" \ 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..7b351353c --- /dev/null +++ b/7.x/docs/assets/search.js @@ -0,0 +1 @@ +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA8y9W3Mcx5H3/VU2hNs1bcm29nD1QBAkwSZFGADJ2Nh4QtGYaQBtDqbHPTMguU+83/3tnmMd8vDP6hyuryhhKit/VZ2Zda76f9907aflN//53//vm4/NfPrNf3773b//6zfz6rn+5j+/+aGuurr7UN9fTS8/r7pqsmq7b/71m3U363+czKrlsl7+nkr06mn1POtT7tL0qb/5//51r+HP33530DBp58tVt7ZlfBZLBUr+9ZtFLzNfcexHiG//8N2fDhSz9vGxtgAcBI66V8vp75rl7xZdu6onq3payvJSd83DFwPLQYBgaV6qVW0g+e4Pfzp+/Uk1/6WaT2e15csEMkXfJSJ4sqp/8tZ9Wz3Y9e+Esu/RzJ/6b2Wzje/+8B//9u2fjw5z0dXTXrCpZssD1+rLoqcKfhHd7/s///mP3x/y++23QVrJ6uyQiq7XEIox6+pxSAqpebVPqyp7tePyKNxW6y7H331rUL/jZQr+afiyRQiv9qI2kLxSIp7JrMG/xCHx1/0UW7X7ivjOUgU7YrHw8PdIOF4F4kYg5aM0y+U6aIBkqkPir/tRtmr3lfFHSx3siJnCD8qLEF5tJY0YxKcIujyBGN/loRK5dHnYjNkuj9S0kGUxN/YCE9nYexExjT+PQzT+vixkZ0DjMXUGFKbQUH+8bq+VnnmexMVImWyhXjlBzUSFtmsem3k1e9fNzCU8Y4SRHjJOyPTUOSZTPx2nYMYuHIVx5CJygAGEtRd1rIBrZ4IFp1oZJ1j1koFB1m0KC7I1BEHhen0/ayZQG8YndQkSSvZF7ZlQOptZaHCKedg5eOdQ68ncxpbWEmnEWE2ZjBniC4363bxp55BNsyldTFrOHWr++KJwhtM+3zfz/LuoLHsxJ45lvXpfzdZmkEAOafYQrqj129pft7RyBXJ8Q/gvkhnbPyUbA7SPaQ4BZjYmTkKVeDqqaja7KK20RPZrfWQhlEKVaYqkkLdEgXRZT9ZdfTFEqmq+AmOqLuQUXkFFYKQFysrNEhFzrAWUUS5Y9CtnZoYBOK40MBhLisUalFTpnY1hk2I0/N0LwvXY2mQCjq1GjbHHZqtEGFJmL+hkrqHGMouBVMaoEbsEZRy1qzxGoy8bvdsolLBQMIov0S86ktNoXreWwFnOJ5N6ubx4qicfCZuJfnVxjTzHIo+Isc2GR1GYwyrEwJgdAWDs7Rq0k0bHEphsjaX48/e0iZ13j8dOTzNf1d1DNUlxhkSitcVLv5MZnuPZNjXt0Tkpo7JbB99U17lLPlIp1W3UdXPdRBghDBbD+q8SMbIkPmGDzrYsduSlMDovA6O0F7heIXBx9WCPXsZaoIOIWBO2SCLxZEZ4MeQJWGKezs8cmbzLbZIoVIFhcliIdeIEiomydVNmp9aa4Y1Vrh27xYpkmdn+3LXrBWC2eTo/s2XyhmY9uEIUmCmHgZgpTtAs39TP93X39mEjY0PJhZG5CyPhQ72aPP1tXU3zuSARLpI7AZfi4KwVlTm41aZ4B5ftyu7gIlk4jpq9aadHpnq+fh76ZJu/yn3Z70PfXXXtTMjk7JiE68ptOfgdnn2K67p7bpbLpp3f1ulWvfRnmT3e2dRb3KBc3tmUJfLa2URnDMU1kp3phi/bdTch9+kwAAcBxEstJF29zTr8iDpOLOXAhO/z4r6QOtVjIeD3dTHqlRbHrpvbxyXqt+7jEq0k3MdVz+pVfb2RFDY6Ual8dnOxOWMbukh8m2sKCCbfNLFIzikA2b3TRNVs5gIemrq77VOu6kdifxkPR0p7MKI7vQRb0jd7WRi4/V48gLbly66d3vWlEdg2fmm2EwSSq2Gq6bmeNv233cYfPpwIaV2CipY/FFqkAhU4tcpkd+0CwiXn1ire0ubSJWx0eNbJLEEa4wIDjm5natgp4GGCjwqjhKBiEjIQgTSmcATaVBCUlOHGCQYaliGGVNax3Wm8Iz2egjFIsDPtpZ80Q6cONdSVflOvntqpZnJEIh/D4zKGGjuSvaCV4ynszZvChDoCXy9qcLYQcE7AqlfCsV037QCKfpsbKFYSOMOvf7yuVpMnxRvIVC7uwOcM+QONX+AQAofdIzQq0CWkulF9wsTAOIUAoHhFgXbSLVQCk19oVOl+GnIqeP8DOhvcd4CmciZnuyTSqn4yGxzkXy0W9VzTcEhUpuPTUJWKin2aMg2TTT9RUXFIVKZjuhkmKzoOiQw68rn5TaLquFC1n5Tf/V20nTQ3aZofn+Pnc805o9/glYPbvpL+MXu3mOrrB3xSl0ZFyR5qWYTSFDQvGpG9jYH4wIZGrS+1tbHTME2OhqK0O3aOZrmVMZMEgqf5Xr2C9WLRdttGzAwXyJ6KbzvveDVf1p3d5DPxU1H+2uYbBnS4rdRpmJ6q5UU7nzarPsLm+wV0F4ilT8a4/TJFgEfRk9FtraeI7ih6Kjq2Q4vFN1OvFmupos3ii5u+x0luFN/94rRJPMwN25l0QLOdikhUGQ9CqFqrCb/QlqiOkyL2hWlvO2rzd656m85FL7DKmBAUryxSLNgG/Ei/tutM01JvPefY/yV2c8UaSQmXEm8HO32kX/U6VN9KErsQPNary4eH3lual/q6nTWThgi3CQgj48VzPu9HUL2NXx0MDSGipVyYhqH7+aT7sVpVGkic1MdGhKMxsX0UHIuBPJI5lEJ4pfFASq79+z+FlvBmmMkJWoKH9Xyy6RH9/vij2IrF2W1s9Qud2/Y3Q2a7fYbJNsAozyhJadY3dbIWy6vYJy1VNaun+yyWgLowOTyBcD6b3a6qVTPheifx7z59FCJPrKeSwDJt6IKcvBG1pyJQpGBpoFaUwtDaUkyjEKHImrfHKUvJ6WjFl94Ws3iS8BjdevXUds3/1N3VfLE+mkR4BCxOgh+h046WEfliB8sSZnYC7B/rvp2ttytPMEEmNgqieqmaWXU/q6lOnIbCCJuBwqB2SJUb3uEnn1AWZ1d2gOlIa3foVL/dl1XtXABLVFsP4YJ66fBB6rZFDkp/bESfm1lTdV+4ljH+3cmc8jyxljGBNY7kKbXW8TxG0OGVeXZIC7XGmP5qn4wfXlMolNg4KszFCBStj4BpfOj/tE9KDjEp1bmQYx0Mc9PDgmkvdJDAsBhJRzYpAFMeWxCFDXbChETWVoxxkfWjIDi+/TSvu2ODzYRIMpVLoORzhsIljW8LmgKCMXSaaBbtlJ6YFHgCGcQpTDxV346ysVRgSuTcuYa5p+qxLkHLRT3okIAvQClh36R9iOPXLXFsVtAfyPhYdUa0ETAzHaROQMWHfSn+mIN/geWQTYBqPaaGQPW28HLjjdAwD1U1vRTTHJCpXJoDPmeoOaDxbc2BgGBsDkw0TH9aoDH1qk0swNqVwFW8jqUxQtdO81zajdMW7ZsguhHI45yAEIu518kw3b5JH88hAWCZpDtbNZ0eUkpLhAIkn4U77Waua9HVK0KhyRfkfNy5hUvQhchqv//c7qn01eeat9puPddiXNTQrZ5+qJbDSgsTd6PfnRq3PE+wWYthrQ0aodbclEEE932Sd12+HZBEOCbG3AAiWPTJqKBC6N8nHacda5QI9WpzBGl8HhZrt0nAYicSjqUfWjeDO51F6R05pCBIeWBB+DNYAxP4WIswhjzWK8Jgd2hzNmmFVRU2pU8AFHPHQiFbFGNQlFGs4dFKJW13V9Dsu90ROiiMyWBaQLNSdPWwB3u7M+Ky6+z2RGVwkvoaFmGbbrN/VOomarR0JichbpZDmmGcNqmoLfIKay5+EkohkCuRxB7Sy3yEDu6In9jCPEIX7JNIZ3vY3RJkQrc9E3zu0M4JuhTF+ycEGnAXhQpEtrlcl+gUyym2lRTM5Io7W06zqiOn4uFZeD8GJSqM7fNhU7mbl2tUKyRTuZginzP+jBdshNITXhxD/nyX/N6Dgee57h6DVvxNtWBez6LZaHGkiR1DOQbRi8/w8JjkT6MfHRsf/STTK3tsbGQcVCvtNDT6A2PMsrLf42IOwVutPPujYmAYH/p6+g62LI3bpsgRO9lycOtuNka9eUcbTMLuamNIjDvbYA5xMwZLU7AVQ2ZCt4+W7W+DNW+3q62ecN2BhHMtRCs64QkVlYmQ9LBfwwZjtz1uRptht/767XUTPSsIpx/q+/PJjImj4Y8uATTLEIqcEaMtZOYKjbES0V1NZmxsygHi1Ig3IgzSBGrOYJ8zheuB2sHHVAK+cQ/RDmzSyDmK92Zg9SE96kFVSpx+BAfSUOUASguF6Nrs6BCGULnSXMKr3NN6uDq0H9TagBgxL6rN6cbZ9lApgpOm9+W4GZ4FXDYviHnkEl4s++7JMIlbDYdAh7Nv9TO5nYi2IF7aj3G2qpm7EyimMLUXA9+dIVpWcz8GjyVkB4aLJ6aeC8cQHXrcdWyu+Igfnc1jk+MT+4Pp5/mUqDtjs+KGBXxpg8PWf/7zH4819Ntvw9VrjnSvDjmaIV8x5TVVNHPosqgs0hnMf4KqXu7q+nffOdY2+37ksHDpY9ZcTv8UVU3C7Sv6+6KKpsvLW/Xt+v7v/ehifPCgMvqnqGSKbV/Hfyo15ry0SqMANQX2BmDd//z20zzqZuAqzhhxpUo8vpbOsf9G3wIR55AbWSA2yNxs93JMr+Y3bctcU0DyEqJfvc5ShkN9/cFQX1lBuDHjdPqmXlXT8AogHTGW+uo1FKiHewqHHEJ2plJeqlkzrVYWpEDkq1fHXvfBUIDod8jhAO7XEzX3P6FjtP71JvY9kf7QV+xz2nua/1SVujQ0zF+vb2ntUf4vVanYm/x3U6Nwyj6ksef4v2efbK8R6JmjfcXoVdL2edFutg1qV2awKV1WQ+TcsUdK2aKUz5IrWMVT5mbW51234Od6Xvcp7TVIZXAS0l2jbScMBU9C1nJjFhCQkD8JZ0ePEEDKTNqLMZsxF1o0kNU4/+dEmc+jF2Hyk2dmTrl7gAYj06xTSV3ybS5ekfiUjZlQnJcACU2TEwXfmRn9w58YnAIwk1FjbRAKGXCbebJhrq0R4ce6UDQOOkivm/nHN2rjS6Zy6RjxOUOdIhqf2zjSJ7YA7NIjDYyJA+iYCVTFnTKNEdlIIHApOwpM2vnFT8lezKugBTVCLoeqtWJaF1VtKX6TUnHd07it0WWVRwfHGoWbQYx1D9w1HCm4dyGdzBE1xZvpw3t2bBT+6GKAWYZQcxExcgf72vlL3a2I3h+p85AW22TIECDGlatXQi6ii3cqorRmf8JLSxoxV2KT/XLfPDTddr1q5o/IbpMDmiriY+aYGsz49VIyLpHe32+lO8qDTmIhLRm3o+DGAbw3d3mNW4f05eTY2B7ltg3yR9W3Pto3VDY+7B/FvNka2kvfxs93FABnOZ3AM6UQCwfWk4bT8UHUK3T6BkyXqSQZ0TSTZOVTJ5JkNngeycolTSPJSMgskpWGnUSSUdQ5JCuHPTCdKhydqHvguqvCh9kaUcZuW7B78PiKHrcroKCe7V0Cx4V3pGUJX81ePzw0ny1DFlXCpYnFtGBPaatF5BrdjWAp2kEai0EWypJgBFIbhyrO1MRzumOw+YFKMTcWkEBq2zBlTF3rIQmvaHyQYiP+j3/79s/H4HCYbIlv3hp2+Sx/H/8oBhxxsxGb25myKTWhY7coLLp62UvEPWNN66tMDoHY76NVV4twjkb/xCpD0Nbw87q+k7rgjK7Uio6Y8Bw921k6savP6jpoJSdYx8+uktqDwxo/tNMv11W3rLvz7pHcZxunwI9p7C6uA7M8Oyan/SEBVfapoVqftTEfrzbwv2Oi7Asef3LxwCS7IhcMaM0+mOk3O6GunfHCVLXRDVG9pB/Suk2OSOoPjejXP14Pg2zBlrIULiZF51pkWXkRzAbG0ZB2VqSbMS9GsbKEB2tdDL9u0qKaIwlk/4jEInbWYJBXx//83bfa8aI8NzIjLpJP61m9IiZmiyBfHXMbBat1Bee9JHFPQhnzMbdTMvd+Pm1W5H0cZdhRhs7k2U0Vf1tXxBNjDHgoMNahMpL3VdcMLwybaEIhV6KXPjg/fDHVTiziSiO0rGLYNTWwEk200lV9EtrY6FefNa0sx6K2NcbmdlDSV28RCMa7tzjt0L6YXLu2MQbRJuyMIWrcvjUGLzG9N4YrtW1zDPfVw5nmPvU/Zu8Ww5qRYNl0Mp85ZT7rIltnSmQzegnKaP0qD2iYYj2pPVwbBeOMEoLilSX6SdfQGUw+oltLOFSvls3k4tBF4UbtVCqfATybM7TkQuPbHENAMPqFiaa+qx63Fm5CisV8uKDpBh5J8ROT9k1v98fecn+h7/0UMHJRpNNmpxs+QBlcKOnOJkxSCT5mn6+y2xI9haTZk202SfO86Iy1Eu1OEuhsMU4q63iD8LKFkSEFjiZ+DKQpulmhxBKsMbztmsdmXs3edbPLz6uuGr4+t9rApcXXHYTTW6ge7QxXWAds4dg5oslsPa3/tq43W0ia+WMBHpVHOV4QK6jkmf1QiVxiBpsx1Dci2cuP+PEwxSf8TIS8nQCEsoEUEyJRjqdS+k0W3XysF2zIHO/ttUHGW61GTDFXs6HAme+q7rFe8X6c/O7iwlSeRa1+Cm82BJrEbAMgB+MMJISxxTcRkAYoUJhsjydJn4U5bDlnupxEGhfz4/KFn4VJwZnoPDxn8qZa4PqPAkgYlknQp09IEODpE1Cz/KAH/RWKHvQw1QT7oIdQG+YHPQQriQdeq17mdT1/XD3xY680jdfwi8y3dASWFcQ258TiGGecZBJwEEaTKI5h0CwORJmvUjIWtdUENxSUasM6GpSsJHeMuy+LWnaLYwpPp0hyHeMSQRGKzDBFwYxQ16qaYFYHpQaI1oBkfnQtlBgfSRObXvux4a3u+KOTwSUZgjcJBozsto0hDdUFoXQe0yK9D0Y/ZtapctWidV2SMWdlLbBjtLSMCdMlNlov/cWTi6Bu6hljudGvLqab5whf+HTEtHUSCJXG7gGmfZuI8h2KIEyNeA/HgF7flOgHrm1StcnXNaVfueiaJrDE7PVMZKnN1zKR3z53orebczYcx/ZXTycKcrQ40Q6TMeOXarZm6zLUuE84Qle9eKqf667Kn5Qk9IWJR+isZrP20+tmiXynszCxTWdkpO3m1/Mhs41xqXpTAUOAkEmq6fSuZc+yUzWQCBhrnrizjGlq4p9d3ITIctRVZaXRkOQovqSsqAWgEAqvJyuOxzxD0cVkYkS+nlXN/C/Ldv56+tPmnbaMJkvhYnJ0rlB0zpFt3RxGtbGrI1EghsZQKN0NWOvQbfqlWm6GZZ9Xfcih7zDh6oKTRuIrzMgHAs46zLHA+JVIdxS/lMkjRcsNd5TO1o/cLtLDTz47R+PsynaLHmmNO0QT5dZdoZReaA9molfbd6nqEXacpvVrtmC0lPROT7Kktt2d5NcNl5smk3qxuu7qh7oXmXBzO3Qyn0UnPusig2ZKZFwAEqC0NSCTfmEZSKoX+0pQQa3Qi0FqzdjWgzSuqLujmelJDNTPNMcbhZc5jHQP2DH8GOjG3csMQQO8qeaPtWqFZCqn01BczoWnoqjiWM8nsUjqOSWDdum8El8nBeeWzDXCnF9SasV4jkmmCk303XxYWNdMlEzlYqJ8ztDwkMbnjKJ9vm/mee2LDHsRrJuq8UQ95e2nJa6LEoACGZ7oXyTrsFUZ60dSpZn9yMTERBa10k5DU81mFyWVlMh9jY8pBCC18kwBSKUK78QZDlfcbO+j2SZk78YhU+J71VfMDk1MxVkuTockpkAM1IILvSAVIe+B9UxPS4NQmbQH0oQ7WQNCEfIeWPf5IWAQKJIsRUlPW0aJMzfPk/ids8yzxQ9ZxtRG/9UoJMdVjsdBXKwLa2Ci73qQMV6scQnu60HFOjJgTrwHe5ARvqwxMU5cSAOflSVIkIOykF7lrCf1YcoOehpqgT/lydaE/YgnayPhkF6Mr/6h1RBVxSHhuA/v8s3HGD1m707a6SG6i50hJvbj5vqst4vhgak+2HHH+OlkLkYnZA216UwJmKi77LPK61ti2Esg8VZlAV1ArBP1OhEbBeMEEoIS/Uv0k26gM5j8QbeUwDF+rleqVxBpXFyCyxfyBwrc5AysdosnGCik60NYFvXyECMR6Jj8l1G90qCfcUlWueKPZs2kMyraTZ6oWEfghsMtI6ofUolcHJHNGPJEkt3kirx+iy9aOCRn5Gns3qgwge4ofB/VHy0EjEPy6hWPtOsmXVLTb/JJjSm89iNJFr83EF52QSXEJ1Hbvbgt77NQjv4AdAnoEKSGn5OEHlvYEe8VGO1mFhfzIOHun0BdzY+BvvXBy+XANvB6uP1UtUIylc8mEzZnbFctiW/cWcsjWHfXWmjoVlmAsTTLGgm67Ub4OmojaGLgNtzwANqeY7t2equNRmDbb6NZSOia7VIfJlKJfByTyxjzS4rd6JYsgNUrDSyMU7IoJp+UOVCX5L+L7pEGAs4hWfWaP5p10+6o6Ld5o2IZoTOuAV/M0/i4IpMv5okEuNEROfVWP8RJGDfkQExeiFPslw/Zy95YIEJyPBsaIFhr0eMDrp8LD5xyLTpYNdPBQdZuiw2yncT3krzU3fDK52XXtR0XHehkLgFCyBq8OoIsAb/sPaS2FfEslEJ8wcakbl2Q0Aq3L9gIl0/tp9tVNfl411XEW8oSXybqQoff/MJ/UzWi2Cj4W29YBP3qG7N+7s4ZhSGLLuUc9XaLzybpj31T0szyrbUSEC1/Aqvp6l7+pl4u+iBjNJ1U1IcumEgMk3A7MdM0+PRhPUjCWZ7tk9PWkaEySoXHEWm12vOIkuKghRPbNffWDG/DpPZ7XNRDY91YAibiQXHORzcZ7eAYV8AQb0KaNl0/UND6Tkw6p41JfN6FW5ToQhVsVpLI1LbXyMFuWBIgtJNOJQTMpiWVwrh9SSOLTrb3WYv2mSbwOeVOZQr15zNe4wl3UrH1nDvIUJvr9SwRQXoOKI3SS6d5ivrnAhF0GwBJot0JAOoUbgagbdJ+P4Cp9PQtAUIN2O4KEGwjvDFguK5pe2x7+zzNhyEn4lw/nc7nzgAhb+yyaqYQnDusF4u2H7RP39Srp5Z4FVIEIqQRzzAyVpuUwxWeRrxY0IcMejEXpdLeyuXyCQvGzZeQbwobwV7tcynGU16ZXbTEPW5myFYYADkwrh0Q186E0FUfEqR214fqCMlLt8O1Qbv77opCCZODj9NGrM1yWBXiLvMTIVPR09Cti+HWp2bbboIuxEuFT0D4WM+HGf2tEhtfKnpKuo1EId5e9gR8wpU9YrfEfmePjUu6tEePcbZbe/SuSfSkyedm1lTdl+H+zP29hlyvkU/r03NU8gefOuELZBtiqjjG0WYBWbUXYZd3VUgqC8jx7LTLRT1pHppJOSyRw4lYu93Ni3dk51fjTKT9GLEHcBQ69SEcM4n0II7mswUP4xTWFPNADlRbxodyIHuL19+Xq2q+UiIsncxr/Z3LGl1/p0rAuNfTpuUhVwRZiqMMuM4m84CrtjyOumpr0C+uXfPfpeTpEnOtcGvJSs1YHzFRrId+REf3Fzqll8sIuY99XGes4Upo+GM7DuYr1tGYx3c8jFivpdLHeEBT3jxQo1lxnsjJgJmMDY/1YPFee7SHZih5vGek23Aw0GM+452FrYvCx30cXESukYLHfiDH2D3XoHgGmcrFNficLe+YgONL9VkecnRZ+DzPqDGvxFP0YNEodxVosMeDxjqsZCWljwmNdlm1VkoeF4KctrfFxWZqW/JZKpGLy7IZQx5LsoujF8pfeYZQBvFWhQd6UYWHkb3Dolt4U4b/HvaXZcy1Qb/votSI7ZUXhSnYxxknYo+DE8nw3ZxduoUVyPisozavRoUkyJWjJiaAQKgIgHi9iYs7J4g4TqO+0Z7m42OjYg0WZbz0i683jfVrqKlrp81Dozd2ZDIf4+OzLjNCukRGMxCgtEbHpF9wBqle7E5RUCu0cao1YzNSjSt7+kCxVCKNz9ZkJt/yRw9GDWBYHOPwRSaBH18o8BODZuXhBR8PMdcE/+iCk28oVhJuiu6Nr3qsf6yXk65ZDCt259PN6RzyATAhsc9maU0BtnFaKpNxE7UKZN1QXcC23Mqwi8Y6ZJ4DMgArYd2u+77U19Uq35mogybijpTQdmyVT9uaXcAibNPWvcG+Zbu4tujt22CN2bZyg3YXhLEP1WSzq0dp4ulkLqFLyLqooWdKZDNoCUoxZZv+ajK7a6/r7rlZLhvirU8JJJdF3N7Gtz2oOuz5Wg63tVfPtu9HSJ+AkQ0EIps5BJRYFun8unWZ3F7lihz+06fz9epJ83cqlY+7szlDXRQan93jRrSlAsAuPWShCgcUZHgSLcZYtAvuIXwLu3fYa4R2Dq1WbL6h2Uu4or6JVtP9qfygGc0g+aQ+q+ty9tgaO18atrtcrdbLi3ZKrOUqQJEouKJr5stmiVE6cqbYl62I6wRM4eWqHxFLJlO5GDGfM2S/NL7ddAWMAqs1UbEGKzCZbdVEZKXxJYmuPljWK8Q+uYROlx8ImUNWypbDbqgyTIGtWtlYc5XJzBZr5SpgcueJTRex2lMZ7Chb9TFTk4UWEkjGaLDDQu02zWO05g//bZMzAzMijYthcfla3v6LwG3Txax64yyxgeRZHgGzRJkcMlyUuWzPthHfSL0Mx6Bffq4uV469V4drlp6I47SXvBHH2QgR6bl1T383tHig0qSNMjXcysZTsDcvQbbmpZ+5d8nF4iBj25nlout7I/NVRXYriDSe0T/L1xL9I3BLs8oqF5tVg1a2K8FqVrsSBu33zbzq8rVHVvchfYnm777/7ts/HXU3y8vnxcqg/ChQpD3Yt3gdXbES7Ofb/IDvTZS2Bh6zsg9CtnyIndIK/ZQlBkKrI6yiWGFqFbRGyhQsKkNjYMJaoNgQ1GDzKPLsgkCmqHRQx5tIQQTBVApGUhI4WKXfhyrjVG/Sb/uwnk+GH5a/55KKhvPdH/7j377987FF3AtdTftshi1xx4ZxuFDouCv0mKAo//fVbF0zWW9+K8r1pp603ZTJdvtjUb4/d9Xiicl285vsnFH3Wfyax06W+Uvi3Wk2a3DGhCyBcd+gAGHdOmjioZ+RkHAsL0nYWJr8QiQJpEGvQFIpoq7+sl69fam7rpnW+QUCYsXEgv5k/1hXxKVgEtJeotBy055iHgOx7xSIlZIkX6gkUJzFch4k1XT6t76KTRRHGUcCm1kEQh4MXf3cvtTmiojEfDls1RHLOX0V6wdxrYOC4jvpf2g7+wcIhPyj5rZ457NZQaVspTzq5amyVck2vYfmx3plLfxBxEm/VblfO2FtH/w0B1d1WCFiUX+PeCyny0RP5a+lgJS0D2PcF5oU8k0YMieWt/d/7wcEpUQHaVeu1/X8kdhjCTAdJIt9Mh6+bgbS14enrI4ReTuCTX8Wh5fiNdZCfmfKjdUZI1wcWbtzYUrKwo37Xoi5D0Hdq316SKlyN/Wnunl8WhmUHwQKtfNTnpRhsjNqqJlGhY0+K5z1mfiN+TIwEJOn4QU58oICheMo6YTSh4t61TyX1Ekg6gTT/9hOm/ljAUwg6gQzq+aP6+qxpGYCUSeYbjhwWUCylyvHEOOiEUR7qoDPY1sOpnLW86bEl0KkV7s8iri0u/+rblUQzmK+fSZOgMlywrJdd5OamOCPlxLSZPLEeRTlWQ1RfZgUpE9VkMuoTJ5ni/QAaFydGS5drtte5B+zd4shFLIruVkivFTV7LG+78glNDrXs6MEXbScuGDFkNFtXlyGYYwgp4HgVxcZDONiNAwirDkyJNZFagkltP/D28cUy+FH0zL1UzvVMzs7JKSt/MjFdQOr7pHugCWKDgkLFS3kHm2iLU5dqLIfOU6bTdAGNEaJCxXet1PSGBNVu2QGJcEi6bv5sp6su/pDfX/bTj7Wq+V1167aSZtP6/FJXRZLleyhBVOhNLZFUw3GuHBq51pQ9zBoVFnjy09KFdRUs1wN75zkk81qZQWSbmzgTlLVqtS9y3YaZkephqLsZLZztPN9h+viaeiu5gtHGhKVw2m+oLALFqs3045YzPrDx2Qmk3Y9X/Wp+vb+p2oIQsQjIEQil9DIZoy9G0Ox28IhD2B9KcbA8qm+v5rekptIeJ5ICDFVC9H2Xm8rUix1GqZfq2c70k7IgQh63IWl0V51MeiuptMouYGCEPWumV7Fh8E+3/cR6aGZ7CYV7Jx8Jt7EwvM4vHHZ38UxWxf9II5iYbaXcBQfDC9uqCZP9fQvnz7+vH0HjrpRIUvi0jAw2WIXNOTU/GwJrHmbdqzGj3XeunIat2kRw8f17+5dgxmO6X05dsJ9UhglEnGmWd/PmokJJpAYzZJuNLjeyv/VYCupVIGdZhSbIlohAqEShmCqaDuXuvrSB6qXZlp3u1B13j2S0xRCcsOkMNkNNmg5S3OgK0EqGxerptVidUhZxJZl4QZ3Xy3rd92siOoo64bTNtPJNTO/r/IEwm5AG/3VZmHkpl2vyPUwFYzIxA1wMmt6mYuu3ohWs2U8FrBgslm5waaNmIWOatBG4vyd6h9ZmJIM/Orpqf10u6omH+96symsrjQLN7i669pu250uq7UkAzewjj6cbkHLshgFF3TIGYmshWbSuXTNpbyh/jlXCNvMjYhhnLwxEtG9BAiM7x7wfUcjXf8JHpp8XKN9tq3MCXiYjgvEJfRY3PjSvgsERnVa3Iiy7guERPZb3JjYHgzEJnZd/Cxf7sRgnqD3Xtx4ucG4CGgbkRuJyK4MhMX2Yfxqi+7NYJXGd2Pc+MgODUTH9mTc2Jg+DUQndGbc+Ba7ZObGdC/lw5RPxJRgxYKlfSDitvAynEz2BHU16ZvpdVdfDoa8v5QnX06XMZksTkDbzJvhRI65lxTJncTiNgG03r7J+tf6i7EKSflT1N9ye/P8Xfuxzu9SkqswET2FLW6+UG9KF7OqebZaYSZ8CsKNRxZ0o2LBU9bdRkdp3R2ET0m4CRSlhAdhJ8Jg2vp89hguJATTBttfTHt5lWzERakdCE1JrukFSuAFPYTYtpiGLNiQyxOiRmhtglGNnmiQte721P/uO0j9qwhYqIZ8rUgl0heKTlIRB7XaqY6sHo7A9LSYvHvJf9uSYb+SeLPXuI0KLjsUxmx8wXa8OGknN0b47IhgKcJr95gZ1/CON8Nka+7GSddeyRcaZPANFurImmrNk1P5kJo8WzRk0q12W1Sujvs6j8eKkhTyEd3oTNUyfgPumOXhNzSzl2GH0heJMkkhZvzHY9A5v7h4++7Xu99uL+/urn79+fa3m8s3l29+uLz57fXbn69+PSh6qbqmup8NvQFZQj5wlZyN3uHe1qtVM39MT3onv449G01lp52NTgHZ2Y7n+vm+7l63j80cV/sqlYMg5NPK+8Tcamr4Ox4wtuMAKL+zQ1q5NBtAe4Dg9GmBIZLbIfLzMLu6xgCi9KZCR2rXm7NMJs2piEk5FQXu3t6c/3z524+Xtxc3V9d3V2/FCJCnLvdRPHvVZ4XCmPzXjIT6s5Bbfk43vli6Jv173ztJE7j0PclM0fuka8b4wKcECMXSSit1Wz9EwC2M0Ai2FRGUYZjsa6pZ8z/E6RKaI5YYyQI+HUBg6O8GQDqTNkYxP7mRQXUSoV7WC8R6VDcd72X1WMCHa1x6oIKqdPNgz2Zv3IMRrM1ZX4tg/TAJshfC6ZTkd7cQm+YJR9gQtiC8ZXrt0Q0gWK3y/Q6k9m3CcZrJNQ5MfZDaWuPqfXqMQv7oNqirqx+6eplv3iD1HROP0jmtZzVap4e0ZhtO3HLTrQpcmDNpIp2bm3J5w+5KFcLeL2IxzN0jG08zH66gy1dBNKajHLZBzkgmBTgWSwx045nqz4smuXoCworkTvAVq20qcrVXBIsFveosCSsPzbwm72sU0SK5Ut8jeqNX82n92RgHIkFHlhIMLwLqYlxRvXQzrlE315SyurUm1aD7YfiTSflOwk37FXFLswpwJdyRbWSgrueVo6pf7fdZ/dTUM+MXCKRcKISujhCP1C6PgaAX6hpro3sUcoxBu7R3zXPdro2GweRwknZk8lRPPu6SGiljydPQzepq/na9WpirMBJ0YwuWD6iRbzAFjQ58k9XGZAQmZKgPwOihArp8wOrTN0uEogdKfoEV1M4HS/eCrvZl/BNYxhU/Xx6POCW92oDTuZg7dfuifg8Vdc/IFDdpAST1SuB3LuxWm7b0FYrt+MRVoLv/ur48qM8XQYaf5VXeIJ5sIk86Vg+KFP6ORxRimCDliQwPIlD7p5F0at8nkg1QkT6piJD1RaXpUaYCxI6IqJ3qgIwFCMchovJ0/DFWMRPQc8VpRB+rmLmEO1ec9rvHKuaX/HPdxGBzrHo+5lKulgVdn9LHw3+gCvJh/1iQdAyoOnw69nMwwHgQpllhPvgqQiB3CpHNSbTPBm5QGA1X03Bna5T15ifrxqqrH3/76+V/Cc3pNkEZaryjP4Hd/Ci3qfTegjRfYiUOyb1gf0GYrXWHwZ5aOFxFnXDltB/Tm1cXFZLn4bZiE0so4UATXbgVDsq5s4RUIpdPz2aMXbtFsfOf/31TfzIQHCXGa59F+4p03fv0RZqRJSRRtXaRwb9IlmeBq6S9TDxiIvYVQKXbKiUbVm6rdMBEdu3whMbN8xaW7U6Vm92GOG6XC4/GyX+FauS3xQjf2rw1xv5hye0x2sc1bZFRmILuzcXrq8u+83Jxc/lj/+/V+evbw3ZGZvpAkUD7VUI28q5VTNBjA6tBk7aXFSwtF/yr+3rmAvhqn9UYTOURmio73TCKOMzuhNTLuh/5rXyQD3mdkHdzq7MP7j4rZ9p0Lx52xwqf1G+HHp89vlmPLo19A5AEY94DZKMSdxMKWAUbC01c2gZqia1sK7XKh26qltCA7dU2DnZvogChblM0EQzzVD98eR01TyhJLOtLJK0Y60zUqvE4KmHjjxiM9L0/Ng5pt6fAgWz8tNWHuGFdrJKiresl/s1uYtd93LydHeCLZw6DpNREZ/qzaVYyg6HnJ7lkpplKVZdY8d6zl6KC8q7BiBlNmahkbtNKJ89yynxl850IYbjTJU1OLXBkifA16oZcMaEzPGuEfnTGCY32dJ3KkA5VGw8odLXKqAFVm48WddXAkBBVnwz7dN3a2E5QLFotv1XLPhiCtjAVdhLVpgreBCMD7Df+/LuRRNruRHVXQSKkt/pVqiYAAfZG0RmFhRGrKu1Hmxi1bvRXrK4dCrBvTqqwfYHMdyuM6ON/lUrCbl5gcsjuYEC33JUPOL5KpUR78qTtpHQe2Qa9aLU2lTnfXledrwowCX1WbaXMsZVbrhzGVUwRxHglu5VJeFNP5jK/q2clA2+lVj7jmGupAWL9mI3MJ56zsdbY5h+b/p1I6XKkEXD7cqgR8SB0OshkyXe4KMsIeRACVygLLOuHL+96HRft1FqBmfBJGZsSF9jLnYZsiOVrs2scpU5DNa37BqYlXgkTqY5Sp6Hq6pf2Y/3Dl5+7KhqWYnS5tBsl0oHgbrJU0p+0O2F+5kUrnF9DPu6d3ELOkc2636MTOD+xmLHbmmvtuBK3Umc5uVqFscWNH384UcOrvJ2aSv1Yr6pmtmR3dcrpT+PbhI4y304KN3LgQGGNHT9ghKVeTVakq1cX8tPrMGX8lovncX5ozyTCq6zMFxIJ2w+hSrTvRBxTc/SmRLz2bPsTcRvN9rhnsvJudy654753UYVhBzxbspI94TKUNSYW8UkdMoDR3h8rokQDN/KpR8VtH3ombJfQm6I2Sm84zSHjYuc6rETi1nsZSGtFini0PezKJy3czV5Wa8K+dqTmCna4I94SNCA/bubk4QZETu7SgAAqoAZEKdm40AdBjgl9TvR06Cuit4Q+mB4JNAitEmjKePhAA1WgOdCMqTUy0OA1Zwo0uG0GgeZ1+9gbEBdXol9dwkieIxQ1YsyCM3OkXuWwXOY/HAXiLgSA4h2QNt4ZqBKbbd9QYtLU2VKbLJuniPeDbk7iby+rim5q2W4DTX4tP3fFZ6cdrkoB4Z1mqkrg8FEqLZ/a2T8sYEAIREoJgsh0Uy/b2cv2IjEuPhFpXKIUl6/2BBY5JKUKYhsnszjGwbGBRDwozfLA56QLqaQIL3wz7FA0zoTEexZHifoGzdiBZxbEft65kJO+i0AyauEqAoNevm3kbcXcQpothWwnFWsxtZaKP4XTlNV8Us/eNtMJOzOZpvCZjCRzLXpfMC+CcbqERtFmSFCtwqQIUwf2eRBbDdBTH1It2GY7BJp86fBq/tDKi4VBCsflwTRXw4JgiMy0UgvmHUWFIRfDF6FoKnzZKYOBFpoArdrSUv4lCheT4BoQlo+YWihYMGKsJHSA4fF34QKk6Gcf08+zxOw+Ji01ekJ7ocVzPJC5ExiarUP6HuvVZicVpDFI7FfibX8Oh4jTe3NcDXvXqwn5GAVPE0v5MQlhiPIKewwy2CQdgFi7tEUf1leD0PNT2/UG+GFYtOTCT57EJQQx2UJhiKAuDEUcRVk4ErmQkMThKGEJ18sbP/s9zA5grQXSCeSaMDmCbC3Zu+qcH0S/urhAniNk/TGmbfqIUGm6rwXSvdgk2qxG5c9GEARJ+jEc+DvuFv+CtGkv14/0KkOJhbfjx/oS+/1DN2omH8UWJU3g40xUppg/pbxGlyIV27wKJBD2JtEU5t1IKInWrtI4Za2qwATty6FZtJ04qFYuyJBKtTgD6hRCDe0F9mhjKj0dcIQasMUcgSW4nODyuWpmt/W8t6/z7pG8UCNJgl9HUA+CfYf6oSHfRqfyPYtl6A+eMtsPA2uqtfPRqXxIzVTGU7skD9eDKK928mYeZZVy0XajsHby3ljVekU+VYNi7eQdsJxNakO2P2n+7QjEbRGZ6lsvgyZ3LOSrXW6jSDUz7LP2A97ldkrg5SaDX8NDyBp2JGKNbOltWkHKrA1JfnfpKFJ5wtdkhbC2biKp1nxXJqB/SHHXVfPlENBQkFzIkYiwMBGGMa8SDvQKzIwBuPcS0ChfGZhbYdE9gXDJ2csBmdKbbwRkbCFx+GE+pl1d95l+ajtmOMOkcwsAXN5wIKAKwZm/cGMty2G/rtZAtH3m3kCzFfAhScZsyeuMEI76TKOZgr51VQCQL1o16BZuN2XVA1ebygTBlfbX57e3H97e/KjdoE+mE/1RUiLfli8lL9+rachf27wplkcaQ46AebXPwI4EdFkHKxkDF+ThzvfStzYPTT2KL8jDnU96OwAG1DftGgmTVldvb0/T0o5oY6G2TOhuE6rNHe7RLbxL245RVLNhEWXOvNlOgYQSrizabfgETNkl+FAbK3T8CRCg6w9pFe5Pp5xCvzZ9VF+moBcD6dveA3UZNW6K3ljERb90dz5LgFyZj33pYc6le36/aWMmFbnRhY+FhOhInmHWZzjyNTHYXyIzkmC7hQfVfUg9UqvQly7rRWNfXxzkU9+8aJhviHTsQJ+NduahPkuTrsiIazG2VZiunjSLYUulnt9ZmFaYoUznJqP2dH3/93qCKDumLFS1qj8jenbJCpXs6llTkn8OTUnQ05Qmc70ncuFJXMmWR03iOUzglU9bIlOWLprJaOIxZcgQBBFEmioMLNg6U5hcNZ9MQQEZ6zNQ8vwLuhSn6tdveqayONCzVUJGo6LpsJNXBHBBOl0H7J3o/PXfpTNyJ66E6NZvUy1kF36n56j3yakHe6LfRIfjc6Ue6Ul+lV2ZmeaQnuSx5F8y1VH0AE8Kzg/vrrl3bUj9Jc/tgCzyKzskTdnjOjwPNcf85vLul7c/SnNx2xSyxQatkNr+FLY8/NsL9vmBsbGF1ahH11hUflmBaVmMbcoJChu0I9/yjSnchFCzIjIAMilygnIHag/l/wNY/hBZrAfhRZbiyZmT1UXy7Ar/lA9VGdprK8JEkeKMhnmiU8SCXL3e9UwCA1ECYc9cNn8lA0LTVyeomFCv1gGLxSNibvdbPI0moyizaCco/FbjIW6gTcQO1Nz7tve7T1Dm+IUd/hUrpZ+dXxG7F2CPAVOpfE4Dszkb7oFN8W3LdQJC0a2vIM0isg8DVCqILFcVkUk3o4pk9ntQeTLD9ackE3brKahfvOyUVA/dcQpq1642pb2o8EZTU40IF5kKtVJwf6lgwdm1pVpQI1O5BDU+Z8PdpC5hRCApCSNFZNIto25hRCPDrxItcWOTdu3iUCc3LqgR4ZpQLzdWqdgZ+F1abk2PTYzPidCuBOsQPIqfCg1LxY1jSxYiMjg6FyfEVf28mPUeeTl/bOYldFkGTmA1sSaIU8XSTkhdvaxXcUzEiSLhEUDJNRxZ+iwKkKlcGks+Z/g+jhzfNgIQEIwjABON3HQLUCVNt4lMCjkAnxZrnCiZqAMACuHGiY0KPAAYF3GcqIjYA0AxQaecCRrTCUDamM6kX7gOh1EP3IgDax/Om90M9fuG2sQoQKSC7t9Fvq6Hi9hFN/YYvxV7aY/4vcz39ohUxBJdeNMp10vl0uKdVPJGZFQDfzMyNX2YFai03ywzYd1mKxR1RzOMxN3VbAUKb6YhkmdGTCVy6WSxGWO31FDsti4WD2DsYVlY5A4Wj1TSv1K4sNtiWCL1xhiDdvoebPEDCRdhW76HeJs7DwBf5y6+LWoBlS54l1wJu+F9DCZ0/w9LaNymaWHBboHn0ezXwLtVo3ClEf+t7dcamT8sfbWR8nFt1xspPhG/g1GrswRUIpf2i80Yar9Idlv7xQPYH7+AWeT2i0cqab8sXMj0AE9XPjugMEJtLM+ltbEW7fxrHIxy/TkOWHcXpjUgpHLeX0R8B4Pz7pKHMIxfiXsJQ/xS1qcwRN8Kwuy7TTOoxVkylUug5XOGIi2Nbwu1AoLpCLWJRQ61AlJJrC0io6ftADLLzJ1GBoVYgUmLsSb9TJAV1CtR1qSdD2eSD5njWUGNkAFNrRVTRFOpgvmxzS76drrZwNGyM2N5KnxO7L6XfdeRu52ZbM+OIrQpENDcdQObFy4fmrr7eXu0qSWXGjkQWnwsVFfPqlXzUm/uLo2OSQBIlPBYIOL6YICEuUO4DGHR2gECmRL16QGhQ8LMPeOf/Y4FxVniJ4KOpLbGm1JqHCFh+lOflwAoZx9PIDm+RKN5/Hgy3vslLtntx1MJN4hTONr94cUcWRyQKMgAUMQA3wqTECBXwqj69qduh9RXB/uD9LOi/vWxsTxDpezTe5Jsz5D16bB4GqR2pZDv9Ugpyi71AL8Kf6MH+VHs13lQHOHhyrf6BYFvC+8GfAtfC0inFBWhNwIKWauXATIFABtNE8Qrrc/M5THiBjuACri8DuUKLOPth18vbzSzyxOhhhdLyqbHpvUwPjlzzfz4Ykh9gFKMV5+yeA/BaFc8NsvmflZcOa+O8r5cfddjRF3tpccz5YMYsfvkfIVjmKFl+FJ8cWOk0H5no6JZvK4xUl1wU6Oi+7maV1ixjym9dKdOxuum3GmcbvVCyEh/4V2QOYOhw2+8AVLRJV3+GLsTcO+joou98jFSpN72qGjZHnD/QR7yZ6fpf1D6K6jmPg1zrWmmdJd0VH2+/dQPuBCFYdpyjduNF5uMAJ1x6nKtXf3cvsBa49QjPEMbVo2/KRGKA9KQyuF+RCIeBo34phrf1Kuq/5LVhyGH/BMQaVyadC5fqGWnwG0NPKveOEVpIGFnm1gW85STgWbXqbhdDTM6j/nbeSxULujBhjSRLJLSUho082GBt1dzdDDXBBkklNowxQqFKNzifpiiuZov1vRlOnES84b2YKij5HoGjPgTXkb15h9U6y7xKIXx8FfTKA93QZXL7U5K+jQCpTUQsCqmTebteqXazDaN4ahuNDbWsjyTB8MZKq+UWWVmtYrTZaBawGhCrajVAEpfN/OPRsU7Ebvy8KgEv0zqvESKLo+Ke2hHTOaPn8gvXmoClpk89NJ7mMcvHND64/jDH/5BZqnQ6xItI2qiZw5fB0XoUS/92suUXYwID+HdihXchCjcbrUXUe9ATCcMWL3YfIFbMSN1wF12e+EYUyh6NGMhYogTFq4FHjQBF3qGZd3A8UabTJRIVqXMk3ga8FYVcIVjYMY7PKao1AwNS4BM0LgVN1CG3GC6lw0Z2S0s+fwQi4FMD7mVOVCG3Fq6lw0Z6W7PxX4vAbfrO03g0gUiM7XcvdcWbvOmFZsWXFACdg6GZpAnYMZQcN1aluMo4Ely6KmLN/wlNJmQc91wt6azdXNVcs+gStLMbydP9XMFcgTJR1JYLjpsbbvqUa3y9YataS89qlO91DCNTKX3GYKll64yJGug5BZDmiV5p6ClHz5oS948yN0ryK3gpQPeXeOfPfcBlD1t0I561aB1eNBAJVDeMmhdnjGgKPKDZ5v+iXzqLEzieOQsy9Zw3iyitvYBOPXGXoCJRDrLRZLYz3AxJIYDXDkIdnoL0Swe3coVQ+e2EL3DqPL97jnea2KPLweQy2HLXziZdpyM8I/Cs2T49xEOknHfqOAUGeczQXA6v1+2s/Vw4Gz1dDUMzKrJcIc/7UZSYpeApSqAQpdYJvYsKNFI6DgL9jBHFjxAKqgF1cGo9nQsDd+a6jx021ry1ULjXa+e2m7YT7ZJxbWudDIfg+WzxkyVLoFtvC9BmEb9Kg3S0kg0Smtjq42OjlGC+o5v65Gbb2x4y3bdTWx8B5FTAYLtomjV5raxxKrI9lG3LFMbqX/OINRcTdXWMU/iEmKYbKHwQlAL51dg1bvESEjBCZrpr+GmEY3hkNyXop4v11192+eZt3IcSiwzmgfqAXAsWruPa+Zbe0633sYr2uOplc3v11XX/1+4kXI7vRL/aJqyufy8Gq4BJmdtot/kXIMVcTY0BEsdptiQrsddM/cMFNoA/w3QhRtRsbZ4ngnvgdnTFaklqiSAKZ6qEg6q9eXnLIMjNtMKJQJcj5dJ59MeCXljjRJTCFM3T6TQ+3kjeJh+nQgEdOxsRGBHTv5WZE9uBAczIBAhlBFBEQHZeQQoTL1HwGqiOx63N0BA0yxSYhcXVhWAdz8KZbJ0M3UcQ4ezhKoLZAroEnFHSqgrqANqHYISGr57qPPorTNIFJz7/nD5w5V6m0GeCD1WHkvKx8rZtB7HyuXMtWPlfDGMx8ohDOVYOZ9H+b0GGJd+zsHClizhfpBv4zn+7LaEm2QJL+EGpPbj3KlS84FuXbt0pDtVbz/UrevXjjenDGUHnEkO9IhzigAcctb1cUePU2Xa4WNdU7Mc9j2h1XtMPEbnsOI4ZEQfBE6VhqnHaBWOjmfuqx8e1/UlDy5L+pTnlsHyiQeAsyIWHQFGPYU9BEx7i/kYMM0RTAgRTUAwbwC2AMhJAotHktToXAehSD9PEAgJJwqyGCCoVUOAayH32vQt54HkAVE4RRCHH4FAjz6uBT6o048TBKJHSPMZH2Pocy0sdtInkJLP+vAv3BvjrWsh44ft+anIQC571T6MbMN33qTdzXdwlw5T6fBoJ1w7zGasXjxMojMA7ebYyFOzeN9356bczcM8Cyk/HivbagfBkPvtShHk64Z5CODCYTMGu9iiYMjPvFowuFsfIBbp5gcLUDD+TJNmvaA0gcsYlMwUGoVmvLZxKK3YNBJFCbhbkWkE8V7kYgYhKsk4SjgaT8buAaZ5jDuAUQrhHmSaQ7sJeRwJPbsvkFj2IqMk2r00NA50KY2FCdodTbNoe6NRrcwsCq1UmUdBdfKjYiZmmsfFttKTI2OpBkxjY8kmwwMR85nWTOVJfA5E0NliByJyansY4gDMgchIwxyLkGhMByMkGuh4AkOiHU+A9QqHADibsB8CMNYCfQhArAnbIQCZJ94V9WF/CDU/GBf+ZNppdRCktlrFP5oOyTH5ZjN9WO7mlZY4W9tqy5G64NAcpb3k4BxGIh+eo1jKDtCxNNER/na+6toZ117EP7t8biJL7PB+TMpNiW1T5WsQjNp9YiQaYwTMPiZKv7R9CdeOHk6mKkDdqoRp5Y5hEyq1Q9iQvmbJnLwnFB7TErVMbBLDCPZvjFxY7I0QOiHTLbHaCFDdJksd47me6+7RVlGphCeNdGietVfbkXk2TkSBd3h6O9iDw4dgOqFTMBYyB8MyUw5reJRAjIHSRiS+8S5z6e+8j6aTHnbXvp7yuHsJG9zYiGRAs2MjYRsgCUNtikoYmMCicxhDjG5FQbD5pVczzPVc9oEpn6qKfnUJK3mOUCyJMU371gmN+W51s66HZkZvXiXUBWmNGokPxTUGye+uH8sc+lNY9gDa4mo+rT9jioPUSMgCGVb182LWi17OH5s5bz0RSSZzAp68OySioCMVngKM37RNqGEb1MtEa1KpEqRBjcNWirtdJWJ6EwnHWhfaCaEGTM2DRBJPJQVNSDKPFPxScmBvp5q9fZ1Jiu9laBfDqCXkBnM/CyVpq+LKwaE00wlVkTBQJu+CJd5TLwLp+7gBFPp8HdeynWiAYx3agEeTigOrrUvsQ6OfH9MirieHdopsbOwTeb4PvKPPq1u9ZVz3YT3f/GH5ezKdfOIk2pTYLJ9kBVkaOPO2e6xX8RO0QbbHX02LC39ZZk3B8Ce4DRgS39SLrl7234MN0HkqPPL/fWnK82yXng5kBC53XHr37ohFdSBToD44J3V+cfH23a93v13fvH1zfXdAOB7QiROYvvj5LtoH58Hq5Xq2WiZmwKaDF5mG0l6085e6WwpNAZnKpTXgc4YGPDS+baJLQDDNcplYJpuEK1Ndn4VCHkRgCykRqQMQEwPTLgoAymCkQDvZGqoEpgZRpUqCt6ETLyTHw3kfI59aso+qZX92EOW/h7HPvKo65kiICnMQdYORGjoRRW3xjCBa06d9JL0N9B9xqVzoqKsATxx5qWD66AtESlpeYBRGJ3Nrez1HY0yJitobv1GZjUpogZxGZyU8bJvkOErTuZJWKdrYmnjT8JvpyB+UmbpB9oBlP05EKtKOTB2E9mDMWYV2shlIAO7OJ/U5vyBnj51k4EtjPNOgwNhON5ipmOGARmUaE0BU6D5q7dupfXE7DbeTXEHR9pQXctB7uiEW2+5uyJZiB+//+Ij5N53Sy72F3FHvZorCOvfko7mgZwcp0ItsTLv+GnMsRSZLZE/Cx4ceicwaeVQmPPCIVoXEHRsLH3YkED3qlFBwQUcnscYc3YbCF9j7sZKyVThP4hJkmGyLhgxEKUq3d3JYxVs8cTbh7W+uruxPf8M03BvoDIpx+IJzcFuCORBkW7B4KXixMVH7ckFz0vbmOgHLG3Y5VnzTrhOm9Oi8aH62N+clnjBG3g7rNxOgV8YldImXYuZQn4wtB7chr14u+mzzjyCjBGJIDwOgQuKSzKS06VYGPlIrX8kcr8tqh3QdpIZMDoTYU+BG7+XFwff+q4JElpCjvB+zDkgpNXW5We2gCZKlVjvXmFbG+SiVistZ9JHmzOs0GTH/rUPTbepPQPynk/mYMp81ZtJ0CYymLUDYTFyjQU1dqhXd5E0UnOkLCJoLFOinXUFlsLmExhVsVeqFlnXyTO1xq1LwK7r36WV74Ur9oVk9XXZd4ArHbLM0YubBZpt3N69/u7345fLN+SHX40ab44/wtpdf24unevLxrX7NDJvSJTrIuRcNqfmi2WbnFTRpcp4YTCNUiNcqVIrjmin4CKZ9OXOHsbCGyLgC1ZIptEBWFU5P6Z51Ipfy9CUPQ/GzkNHOY/AaTw56PsDPNmGjvGs/1nPAMpl0LuYp5Q11CLlC2KK7iGGM7UYi7q5zEcl26bmRqP68aJKTKxBUJOfDhbixyKS0gEaCx3q1kQivyoEwYsET1M1+HnYjZmWLRU/y5ZYFYIHUCZhWT137Ke6ZQ1SR3Am4+KZTjpXm9rPI+8jGC/BAUwsGkAWbr86n1aIf5P1UDe0EeRNrnALfiLW99/l2G2t3mYD5nzGydBhKimDfroUSaDu4knzIQtCdiYtZUw9bQtNq2ttI8rtL54HKE7sTJIG1dRZItcZOAkjAn4vgym46EcFTZIeTMYBdSmutR9o2ky0304d9ckwzITWuBqLvsPkH4tilLFxbBHG4O2oooLFvS4Nfbb0YTiFiSIe0WHNgsNIfvrzrs75op2DlZDKnIGoMzrNP7soxhMQ1asDHxK4M07qPym3ebSYZjoldGbr6pe9Z/PDl567CA0suNJZJaDbTTgxDhvRkChvRuAthb0vzPkxZg5ZyjGnXcibihSammwfhWfp6tvrCIn1E4xzwCcDAfi+HMX8zf+SqLfndxWKpPCFTTWFt3T5SrbHbBxKQ3Q1SP9/dyJwC1M3NR5HqbfNQPEE8lzFE2r/WX35Cv30s4Eiy3nUMLDCZjCdPMzWhBMkdKT4aED6eohboriZdBXlXs0AjOQAi9YkDIIM2oSPL6mU6suUERMdVUt6MLjnXSSS1Up3EAp1ap5DULXUKCxi4Djrb0qUddDDO8w031/Gkk52iGTd3PJkSjGvW4p7UmNbNo9MpVpGl06nXVWAa130Owyz3+vGJA8uTuJgEky1kDgS1pXfFqVbnc8oYmH49RwH06WEOpC3lOJTmFNdLtqicVrFRtekU2lVJO9C0mjmI1lVBEBpYXDvX1ki+JzU3uGaudec0aw08rllr4zkCtJmX/V4MrVzDy6Y8UaA1N798UcaGPOtshpXK3g5r1WVpiiHCcHlzf6nZ/ol59ulVOiW+3EneM4/lz180HxadKQqDs+iz+NR2/JujEk8q7ALUTi+GL02/CSvShJIeKPVz1ZCv5EoUeyHPj1P6XZwwoq4ciJD16Gzqg2ieJ84iR57EJX4z2UKBm6C2TYRyyo1zoTiH+AAGR1Pw9AVORMcmDYkPSi5MeXhSgei45EETRygNJA9Nnl/J/IHcScghJ0dhmNMXCZDNkxyDsm8S18tvZ2NjmHknm7UWyE1sck2Y9q/JPOF19NNeoFl9ue7al2Zad7+sVovdMSWuk6eI4L29xS4DYd8coussz4c2Ga2s7IJx/ryQFZF7aMgB7yk5QmlFO8qPxgqvs+elMrsX0rp0VbT8oT6LVCBb50XFMfZiCsg4z4MRJZfj24oCUultL+C7Wp/3KiBM/Q+moxxvLBn0qAEGNtIT0Mce1G9of/WhtKboZxew2rK9vwARBkd5m+dFu31gYS9y4Dye5c0TwadvByEpQie/+xwLJPKEInEKa4u+pFpjxAUJtChLopRFVp4IvYnKGgVAjfJNXA7ebio5exGSh1cLVhFtt1wv+w7am2pe0Tv7w5+dtldmWYLbKiNS6wmFXKnp+lhMez9U/lh3xIu5hPpjWj/9k10qers3Ue9R+lEckXkvF9Wn+QdDZSQCRgtIrpW7beaPs/ruqauraU1tas71E0LjGK675rki9y1Tyo+px2nd1iCo9JDYqDPoCKzai7Zv5ue9xPIvy7vwLNaxI5AnEuNIkP2sWa7i73LMiVAkJRdVhjMQjPEEw9g4Bdyp2VY3F2ijX13ibJ4jFGZjTCXOwIU5yySQYMOxIJ0IgkHpQkDa+A4EVWhz98FQYrLzwJba1HVgKQI/+amZDzN5ww07lJMEP+MzcA9bISjDsyAx/T1DQvsBUlafdmI0FDww0iEhSMoNdfIkLsGByRaKEAS1/D0jG9EIYhlsACQSIcGCg1EiBq6XDxvslzDHDmstkAFErglTFJHtJHcD3vp9jX7MfdRH1NIPPfr7lhp34X3OoFbJmMbbkHRa8PLzqqu4g3yHH71OBsYZFtlQxGw2I4LBbEkIAWNMuXqjPeG6SZPi9JusimWIX9n8r6p7XL5dbAYXB5Dtw5rhT/AIYCN0XXX9/1F76uKfXQyWyBJq4hNSyxo+pVLcYITpapPPIKk7pjVqDPu3vY2knz7oHR5/xXu362V43ILP7GyfkBuXH8DYkx1dM1lFk0CCtih1qcpZW01/6trny/kLojNOXqq0nr+8r7rrrn5oPiNak/QWtakXi+1OlsLPl/EWKDN4JuhFNfplSHjePaaWrzDkYli/3cT1UgD14kmENI8MizKOgLVu91X/V1/VL7B9RCLIrAtOw3ZSOBZzT8X4Pcgug/hNTP0G0V7DdyU2M4TDExRVM6+74RXAW+a0HZ/UJWgo2Rf1X4XScefX69VNvT23cDnvm5s6d2INlMwC82mIF1lE0hiBZVvxngk7KHOCRAMdeyGGHXSyT1tioQfJU+KmBltioSd0oafK7jNbmVMRLQvqaHnSOprWs5p4T0qDOoidiqsujHk1H+i8vmHf+s2+/HyMrfYvSuTw1dz0Y/3lrt3uXnpoCmJLLv/V0JuD1ruWujxXQ8/lT4oeDIzff/+meex275+qR/D41PjAuY8a60XagcJ1nCXydB9cKBaD9bJ9YCb8egaoSNoLKTjiU1hXWQ5eaJPNJVoXXb0x3Gq2HAEp5OWHW1fzg9WUmPZZnoUX3Lz+dD76S1OZOALejnTaPAsvuOXHZtHHu4eme47vdLeElDyPMXjhi1SkQNY+0MlcxoxC1tiLVHQJbGMtCcK0cc9Gw9oGwiUahRch0eogbExz41ZvlLdDdcb5uBcZ0yQibEJb6EWntoqQUyLNoR8x3TBioHyL6MXHt40IodwoOjKSzSNIyLaLI/igF/EELO1FPJP+Zrn7CCaEUAqbGbRRbWfSS8hSyZPQ8W8pSmTmGfkSS6LfNlStyfa2oeqBQSerbwb55bvwR5cOVZYh1I2KGJlA8pHoBeTaPsKNPqJzWj9U69nqfTVb5x81V54kH0GBhKhcvxKYEF28axFf1uxQeGlJN+JKbHIe7ruHV7v02ayuq9UT7zh5Ehf3YbLFrnbJqQ2uxGnGHQrXv/OTIS3MEcuM5oGux2BQtOsxYL3C9RicHdivxzDWAn09hlgTtusxRCsJnPCHalm/62a8C6YJXByQzBRyv4xXMf6WuHmT1h5LIKYvsCCGT2MoZo/q5I2eqXuzydtKTxq8VAMmc5esItxF8dR/3CF73tzzJD67Juhsy3ZL5KUwGwHLYzYDnIZxAw7FuAvYykEapMxiMkmRJ9pw3j7fN/N6ehAY1j1nL9ShSy6lz1Z0MXfsQDVbFCZKd7vfiSO9Mk0oWM4CbU+XQZRwbaYQtukr38e+Z7+shuhN9Egt2XbUI7ZExXbWfU7jNkZ3gUJGuZG4GcdYt8HdxZFCjumjTRI1xfPFIu/bLxY+Q9ddPthYtQdhIm8jXai61xEngkaDvMYH9kzeQV+YZKQ25Tz5sRr5U+S8pnjH06oixhgHBfufC/JteTM62/0K5RredL1Y3Kzn87q7mi/WR+rwWt8oBb6lZjiAUXfXXbuou1W4N03O+4yQYwsVovPbQh+aR1T5IfUYlS9V1wxHUn/of2rmzL3hhHJCbgzGch+dUP2hwBjFVXh2QNFZpYcGMHVxcN0monxj+4tXoA1yQ8PtDs22MyFRZdqMQOmM32VY51sOEoXbJHiZiDUstfr2qQq19IgXs+b2y3wCFOaYcpQ2TNPYmgMUhQkLdT0Os4GTj30bd1uvVlGUYpSSEuNKerg6R2iViXITYmNrnB0jcDUfCLh4Zb2dFLjNYjYDQqT3iQ7bcsEcRHoXjt16Nt1xzr/INqFnDVx2nd4IJGlL9RPz7+/70Qa54Tz53XP2PcrTMvl+gGWaufttMkzvMbFhyl0j2L0qR21pIyGi9P4cJghfAqbLQQKYOh68fsPaR6wfW/rQNKorH4ndly58YCWX1j2o0pcse1A2EN9owk8pH3/zmURO8kOfN9cmiifKrSyJ0jh1sdalPiWfqqZETPqjlYFhdHrdTqVt21Qip/UAJmNwKYBgt8UoHsB4m7GFZQjCNXefMU+UiCEB1EK1nafgNneKXyqS8+bq2vUwNLCDZYIOZNhqDkekLuTguqU1HPZLFSzfWGuDWbmRa8S4aCMzhbfh7M8HAkf+uLT47GTaJUUzJ7unSYnpYjAgi3A3FkyxSPdjjUHYxCo7w17MB+Kx7tNy7/zJIKGoX40kwwVTtRBDBwecYpZRIHH/I0tOxY8skVf/g84Y7X/k7Ob+BwNg73/ALLFz6ii5V4rtJ8xxuCSDeMpX/DKBlDdTHjN0IjpY+PAIswzyBzNNNRQQ2XF8WMAeGIOi98Bg3WIPjLPdkh6YsTa4HphYI9YemMgUvoy3T8HduB0lwPtax10DWKZnkQD98WPWo2L07m1Rq3b/diwc0NLNZpScfRKOSOTSbLIZY4/AUezadyZv4+Y5UjmsEVXIoHfBWCTtQTCDbuElMP7L2J8AM9cG/faXUiO2R78U26FcRPIMb4cYszVvVJvj0NSUt7dIM+uiWTYwD7tizen1pj8uGVWWwsW06FyhQJsji4MTbkaSIUiFkL6dRIQYGoOihFZYK+9e3FcwO5mxBkiDF2vBZPaihQTG/6adrmf1++1tHOw6MpnKxQn4nCFHoPHtIy4BwzzkKmEqAHKiQZxTgFEc1KSdd1LJSsyOWlAjpLOqtWJyWJUqfBOsrqf1NH/EnJsBl9LjI7Pg+hlylKRqOUtyoE1GLBw7L75cfmq76Qi2NAtHuHZ6Mew7omerAbJQ3g9ru7r3UzOrr5lVBR0ty2McXngghxHJvJBL6HM8R8ocaqDYcthmk2UQ44yylYl0fIyM9Xi+wbLS0b6P4fFO78iXuz8IR/u9HxkTAWDj51x/FCF0PEwkU7okVgbhuJxcQfZTc0W1Qx9bA2rIdnoNsK0ofHcv8pg6S+EUsKlcwUidIltDNKnaHJtBiuUmITeyZ2BSIcxnQaIFdVsGA7LA78nAa6SdfKzpC2u46gglfFk2CW2fxYEBC54kgxo1Qa3Zm6mKXvXZVFizFKjpqFAQoU11z4Rmof6NMVmwxnCCs/qfL6/licA0hc8EJ5krNsGZIXPngk0lOnuwTWoKFN99/923f4InWmkafqIVpsiPwbymmyfuY8QyBQTBvESf5k29qqbVqqLGk8HPhvXg7Ol6IUfg6fqQkWvIGvIUbKZsm86iJn7Y/XkxS79W9Kz78XfLQWry+HKW2dk2IRNyQzT7cjmpTFsmj4QGONbEmPpyqim0joprh66X332vaErqJH54MDp+xuiqs3Nn7sXZqNgX6DutQFsgpkifqo68CD9Ut0tzwgINGvbl+VYt0IaH3e7w0GradmlOWJ5Bw748f9KKs8FhitP3O+7bparvmOyEhdopOXynP2gF21MxZZvW92s1NOwTnbBcGxVa2NwJbHG4wUgzm3HN50HbPtEJC7RRsf9M/64VaQvEn3tl+jnHn9xOu4ZlQA+6ZhUW9dTCtofTJDU+uobHejX0P1Qtx3RIh1jXW5MnoVOtcluka4laB06J2DzoOqKIzekQQ7auIw2jnBotjuqa4qDG6ZGjmq4ljjScFjnUkFpC5//QVYtFM39kAkD8s0sQILKEAkFCaptPpJQSk4mQPjX4MMpGaqKDAaUrDwjSxAemnQwSlPIsUIzXTQYPSncWQMbr5oIKpZ4KLOMJ6GBD6c8DznjtdBCitOeBqEx7Nj5N54GyDhEyzRav1VFzO2K24NQOM61j69+xerHu6148Ij6y/PEYpV+//fm315fvL1/fHmD2F6H1LIcfxXr97g//8W/f/vm78JO9rl/q4/HOgXhTss2fxby+D88XrXalCWLew3o+2bz4/vvwZzTLZb36edbeVzPaqo6Z0wlRNV3dy18N33Suq+ITy8YcPinXNlOm8T7+5NJwJ9kVbd4OaA0NaqpZakx1DXRDmuqwNaK6VrIBTZWaGk9dJ9lwpjpNjaauk2swU7XWxlLXTDeUqV5bI6lrpRvIVKutcSS10k7PLZJkKZxDgHkRKke29eAZ1bbnIgUGfPGHqwSkhyDWQjgsa/oabefcqCz81WdQluWIjckiTOOQLFdp+picbn14Rio2lxEZnOWajGMzRDc9NMtV20ZmiGZ6YJZrto3LEM3ssCxXbh6VIfqZQVmu3TgmQ3QzQ7Jct3FExvkyF5a4podK5B+kzA0Qyc6FrGgIo+vfpzfHLa0d2l6JfqX6WVwbkZQ7k9Q2ClBI82jnuOuq+XLYAJffoquxRKJELREbCjUbym8T5Q6dxz+7ra4kWRaN0RJy24Y4CgK7TLL4MDdZ7tKrJMsPcPMlL7lIUj60fdO2q/1ucc7CiDQuZsblCwVhCpzbjNYne1MtFoainUUySOCTeRCDZ1kUqzdo5k2f/xZm+zfXBOkESm2YPEGxlXA4vJu15Fwh+d1nKEzkWTYllsCbjYAmsb/9jHFwz4dTEMb7DUwE9LPTPIXtvWmW5PtwM+X7atZM92kPMMfp3SSFaHfBvPzd5Zvr1+d3l4ccj7Py+59+9601s9/en99cnf/wWsr1kAaffd7lMTxMIDje9mdXvwuyxOafYlJuK1b6MSW1QWJo9gkkmBFPb9PqZ/Cr25juth8rd80UUx8kHkVgiS6hfqV9xfTpUTWys+KgipRajGh5yYsCWv79kyHL8YmPvyy5AT6Tzm0Qw+UN7xejCsGZ/GITqm0cRyHE8nWiyBju181syj3LImIlkidg213hSA9+WK5AqvSbRXv91/cP7Wxad8Od7etuUi9/3t8syd7ZIIvgOwfSEzJGHeSRmbAmtLIxWKv6eTHra/hy/tjM6WMECF2WzWkgP6/q+XAxx3jOICdX1OfdaZPb1WC3j+Xfm8jIFZS9QBqik++RNiAljUguQAaMPJlbE8JkDbcgRAlsq1sShPEUs42HO8MnAdkO8tl4mNCEYAnhyJ0ui0kmQDIOeTGywQhBFAOQFyF9U7aEZbkrW2XBuygcDtRDwRl6N+6TLX/aRE8TSCrpXz+r9m5nta+b+UebuaeiJ/h6XbteDLnTPXL2+4Vip7OpvUSRbQXCpyPMTgxbCANhf8K9ZTfMCo7mEQ08z6JzRW+f8OPd6LEH23CXuiyf7KeVD5rkARO65VjVr206pjI4sJPzptV0uvsq9fTwnYjZUzKdvBk5vFJ92jNt7v3LO6HhbeR5Mp8Py2Wsf1iK3P5hVf360WIqC+LTxqent4+9XbfkqX8WKhL7X6mWI4F6Bz2RRcBPm2P/i2iH4e8+BpjlqFteBGmvW16jVqWRJGFiYU1mjXBAsP8Nr8Hm8DHV/M6itMyq7h6OUdfVi2HP/3xVrZgJkFhllh5WS1UZMR4nNIPDcdgQizvdYiOOGqWmXTNNQp6KgeF1bcPHmmy78PwECJnKZf6Dzxm7uo3EZ+1ZnekRcEhppItnYtyP0pnhmMCXSXqwYaNVgUr1G7V2QmNd30/b56qZS/2lA5SQ2Md0NQWYBUtlYoxkeFzwuqK2EepMoSxkIRifGOEK6NRLg6SsjmXk5oAmT/WzB9+rQ05jMPeF5eMWcb2inXWXjy8pGCFUWj1QYIYYn3TIO/g4EdDNR503jmHcQgXFyKX1imBi/mgAYws0oiHW0MqbYzvvci9CBlyZM5L144PdTqZDvA6prcjAHx6az1gLzaR0Mm4pd9C0uaIIDbMVZCeDmYbOgxqGyASYhZFEjMQiCxSGge8UmOh+ZWBKTnTsuchULqbJ5wyZJY1vW/IVEIwrviaa5L17mCmRQ5zFxPWibMoW0HJRd7rtjfvHR+8t1hQJnohsL3JN3cCt4iXS7ozpG+4AGPV6ezkNFpIFHDUcqwTB/NohLTbRJiT3mXHTFBhK7zIHB/NoQ1QpI2XauP+Mw+bXZk7vEAx+xr9B1DcRMss7JMnk94GMUfSpvr8iF1QyTfuUxar2c16QtiBxscLNP4iyXcJiRXU/qpxBmvYpi1W1zXRytVyu6VWFTF+U3KQ06IFdbCJ/n47bO5wmcOl3kZlCXa6M19bbohUbO1oow0Lq1NIkiQjS6KE0XbseDIHrvNA8mZArkT77wFCVTjmgZPTWNBrGsilN0E+cUqfGaIznBOntfhOEg8PWCSEiEGlcggKXLxQXKHBbaGDVG6ODgYQ2MxbEYmkGCsANWaRiT5T5QGfgLUb1B0V/3AVMPSFulREfIC6SZDa72ItClsCw+4JWB2y+2AseEekaPF+vntqu+Z++IflltVrsxufcqRs+tamGN3NQ1Wx5uZ21osdUiq4zJh+6RoRicnu022k9DjDLwQttUXfPzXLYnX5TV1Pa9jU4Ig8vvGonUQYWSXshtYshoPSFTaeuDGBEHmPwgoadFsgiKp3MpXkXsoZaeKYEtkZegjDdI2ejEeMRVEFaIPIiZUISwijEIi86NiohfGI48iIkAhPCxkQkLyo2NiFsYlAaQYgc4Ze4lKP8Nv38kX7RLc1H+0tqhTzir9eM6ai/zhV06IazErfhO6Zvk/PwQZPHpcU7c089jz3rs70YbR1sERiIjzV5wkNG2Ar5AEzq4GlXmGAn5YOwePhsJ9gKOQH0mSyeOmb+XOEIZctxkjPLt+ITwFkKt5PKea7wIeUY2X4+mVBdcDQZotguS67pOQm+GkIZpKWCeaRrPwgU+4UfHAUxH3JLP2/M1UosY7cOliAN/QaQt271E7rlrunaJr2QLIhN6eKmcu6Qu/JFsbmtgmJ0X4Qqv+aaufpVQYtF/fjiDgbTKVbYnkzdYTPV8qn9dLuqJh/v+gFV3v9T4DJpL0ak1w5V3CirJ8LR5WAqb+rlklrd0pyRyuEkNcaPMzRE81Cj8GuSow3oi5oGHBBdMOYIRiVX88Wa7AunafAxRlf/Yx1u7tcyPTsKMEac4vKLL4u+JSA7tJzmg4RdddhOCtOA3nN/8ISfaDFjRvEOQ/fyWQxk6sJFM+27DtMDNEF0remQ5CZxo/BS0+B3+Th+8jYYle/2ebBxOSZ+F2a5/UnMMyv6MumQp0Xf/Q7fRDDI0KPLJELgA0xiETKBVrPGBhI5u31hEtCvLVHmWUT0dL2/Pcx2Ag0Omxj/DofZVXv+Z6EsXQV8aewNoQJDtYhSSClA45tKlY1oM0fDBY0plT4LxFQil+aVzbionSXLYm5wBSZzy2shYppgHsfYFttZyEZZ4zG1zhpTuJul6pbYPgw6pblLPWTDbJ3hFZylwsweFLow3E7eYXgnLM5LPImsB84+Jn0YPmdBBSXSHkjIFgYJCt6+oGMFsTVPnHlTnsQlrjLZQnN3BLVt0o5TbtqmgFPQ7qrB8H7qwUR6rIbEuqpPLZFOq1cT660eVOryPsdVuLQvkiGtMcejzAxa9abDRkz9Dd+RJeebrVSX5KuPMtMl9wDkSCK+/8bGPnPvzVo/ZH9Jrh5Tb0n2q/AAvb6EdKK1I+uikVRcj7lpv0np0WsLhkUFTw7SKB2nw+F58A/V5Hw2az8BPXgmqf82akmRbQ81V7riDdQiGrh72giFbJ0WseB900YwpHsvgsH9ewAsfB82T525GpHGJdJy+WKPwxLgtk4+q972qDXOAe1E5iulfBuygVHZg8zSFW1ANnCpu49ZssKtxwY2dQjAshWOAWQ2pCVniZRRgEFzNZ3uU7N3nLMYtLBz3fB9Lt4JzZ0u87ciezvK9zJ1dxSisL9T39+2k4/1SluLIRPifZ1Pe3Fb3mehHGOvZAkYjPXisesjRDpyxVgy4UKgsG1O0uZWkSTwaZWpTItGPxm/3Q9pFrsTgiRctCQxjKMeGwMdBQQOWwjgWUgDBEbjQlpfsxyzqVMqkLHzqOEYN3YWkHFbJ1U02+ZJjMzkRoWbEwtIgNDiN79SXFOyszvOdIBWFi4AtdPdBSSv28mmq8o+asUn9VkQkrPHFob40jBO9sjey6DxPBpvZYDYklvUVjuJ462PBZhkJmPqLzCf4UV41H6EtC4GpOUPWZBUIG7dqhexw+ykEMvBmOymozKabAesuexZhp3Mj/Vy0jX3BCadzGctgM/a8DJDVgLGUPphxjNxubLAsJdArERlgVYABBil9bbp398NeNc1i1ltq5Vc1r9+hPUayWbsazYFX41eL1G/nG3NRLXsyJFVFz6J81rcVi7seKPwMoeR7gs6rh8DY4xuZmg3wIU0Vcum9DfJLHewSeGKwp1lW1EXnSkkluvOzEQL6oZkBWiB34ts5plicSmHCgW9yEoCCmFJZGQZxYKElBxE7RQYKaCOq8KkdluliZrCetPDIFd35fGQowtm+LWxWfg+fcHQLBlKC58OVGQbcujDDfREjJlJfbqJyZAsH92onU8Wv2xWNLm2LE3g0oSRmWKXiKW83DCo6vpaEO7BIglyKSQio0xLbtKChgmSe1JsFtlBhH1aT/3VatU3d+sVDBEJjCSBrqwiKbTLqkCdwjVVtE/YL6gylZ6+mkqoAdulVIJNRHeYd0su/gS/uYSeND/w0vIjILcvx1CGszgxYtM0AfRWoKRdf+b7mHRCIiAelREozkQXFvSjvLhmFwL0C97DlNbkOIzBhaf/xVbbv8kubK+hJuFpkyhvD6ggdEiKeM2YZsDeBoxsAFyi/9jQ7xP3kaC/nfw773NbXc5XxOVraQLHyfgkU8M0fMDLnjCa9QlfyIeSaO2xxDjtD82MfjyKVh0kt+ulPyY/KZYm8f6gBdNgGTXXaa4Wi+gNIU19IICvGyAkwxzWm2o1ecKr+CyW8eWpPy+ajl1byVmO6X05mC02HIZpe7ZIQT11UPCNKElftn5k+xMQHdJZrp+oEOFSV8rqF1FHwIQkql1cm8xVQ+uS4Fe4qPrv+wvT5xG+RCLn+zXUVT+uTgpW/Dh/pnYNnk9f6m7VUGeaiTS+uwSTfG27AwNwbj5ok47qJ7AEoQjy/WUa0367FAXdZ6drBvbXZV+ifF8dWhPyfjq6Nsr20dGWEk3S9t3DZvXl13aYy91O9vJv/YipnaZvNQ3gXK5ULNNKJEBkWY0sIqvvqkd+Fl3li8U9KeEJSP2rqg1wERM7EasCqbOyxTTMxChIZJwlBa0tDAnT6U393L7UYEwQk/sEBV0FFhXkktnCAsBkigtFbGJgAAgLIgPKiYYG5NvqsaGIigsOAJIWHUbw0OEBZrLFB9jqggDxYz2rV2B0ENK6hAYt/6L9dFIBzQauE6rWXcDDmLYKo9h1MQlp1CCNyaIxwtCcMUM+nQk7G6+T2ZoN1o2JMV2b0TrTkObra7gWkx3mOsAAzCd1myMf2y0TSsNObwwPy5phDmLo/JaNav/g7W2dn6fR0GJZNz50XnJEk2DnkGdn7U2lNivo1l5hNWWetTS1VhftfDOlM38MpW77nKsZ+bSgJuC09QVQAu6HUcpnCwkYmCkwlBJOtnKln+gslHfmhPe/QJxqf7aUjN0DhGCpG4PGMDG7dXAu4xYe3AKD0PGXZTt/PQXDhpTYJWSoCop6v2IZbWalAyomVcLCOx9QX+bWsby2SINHa8xk7ChjcGqATszeDiQkx08PzINMSpScJRnQJiWVjGt2+jqf17MipqPsKBxmsC1EnxPGHe+I4+Xfvp7tEgGNsc+bRx10O0QXlSt6zOdDff/Uth+/+8N3f7xI3Cp80ydPJlpucqXZILoTG3KgHDdPhQcq7ggRk+eZuImbwOX65/V8etdaFB8kxqpupha1m9TwMjuIsGoXzcRU6zsBb5DlajtKwL/CTuAEIN3qnLvFjkPZiXjD9JZmQ9kLeIN0xq/TnebjVJNJvTBVyEHCvUbqSd281D917bOpYiIxd+Ptvz99OFQKZvTIfSRKn93q8rkxfaxAxgMn3luXJLyjzg3Rybx22HFZo5vsqBLYtgZLEPaL9ww8m2jNbQiQqBJBcAOggexTfX81NSHtJVxYou5lM29Waf8NIYrlCu0nIlm12+GtCSMQ8mCYtM+LYc20pEZyWQ+vIs8aijWS9lFTj/oXW3ST4MjbQSQ4/moQf7jlUzWxfcG9xNfD+9u6muab01XGvdhXAX2oq9WaOnsiYQZCp4JM9/sHF2mYUDPR0n6Awndb9sFTya9SnS/92H/atyu36/uySmUy+Crw/xhq6q4tieGZ6FcBrrc3Ybwhr4yQcBNBJ8MlOrFDD5larYt/9uy0hllaOqt70qJOaqS0rHOq6G+WyzWo/5DU0OlTtIsdz0h5QYdT0f33Tx/5nTkUQiLgR7I5G1lJIS3iiJKPosCP4+QeoC4kY1r540eZSv3kEayPO+TD6LSe72G+eR7GPkj2v/nRM4QdM7QEsC0jNxpYdyv+8wUKDwkNBptqNhhOoBkzG1GX6hphzZYcUQNLK5ltVuISo82+NXU0c2ihhfY3S+R7ODPN2HY6M2Q3t8gMQOlrDQDL9tznm2phwAllQGeTeEyHRTMY9LQooBs4LprbRvl5Ubg25AOjTI2UnRhlmKhXl4akuylD/eWlNDG+YClsYJBzV7cv8CXh+5LAQ1A0jOExKAmHi5bCpG+WyD9aQvejwPZXfLuDwDTOS8tufOBxjLsn7Cx6xBh734LCxBrq62a5GoY4Mt0+lb+pRjnbW/YD/oimPUYY07ZrNMvtXa0WnKOIuWXXaJ6QGBXTHEXcae6rJXmTlkBzFPGgKQlqifUiI2ScAQlj1Ofx1K4HLoqgPHJRVsKFruHmY818t2n8w1aQrz1o7cBHhKxQ/ZiAJZNA4SpEGRGsFBJsVBSxjBkUZTRmxwxRLG4pa57M2mV9ublYbbqVIWfrGTslhZ3rBgycEde4ziDyrfQwln+v8iCWEQW7VvevDR0EwjbvuGuVSiZGse/DJfFueRRM36c96iDTyQNBKhSLXtn/6Bt89xmOG9YMzKzBCC510L5N5aqVvhuVVL1P6qf/kTgkm6t+pI/DFmtdQlqXzlqrKTkBn2jdpvLTOt3chAAoPiT01o0aWJzaj2IyqyvIs3fpHL/4EgpSZ/t0fpr7lF1DL6knuo8pfbV/uRU7CZH+fVo/go/1F0T5LpmjxffjiKZv6P6K6U+S+3G8VLM19PkPCZ11g18/TOtH8NB2l9WE3J+X6D+mHKf9++++/VMwbGj+B4m4u2R+5f7vXmizaeD/Atp/2yf+bSxDNGT671V720eU+eNd9QhhBOlHk6THtI59Y+WgVpbQclRrK6wf1srSuRzXonNVD2zl0MVHLxgC7vBFKQh7gIvRbzvCBWNIh7i4b2E9xgXDSAe5GBjzUS4LjHCYi8exHueCgaQDXQyO+UgX7kfmL2U91gWjiAe7GBj70S7cbqRDoZzZ5MdCPXHYY10Cju1gF4wzk492MUCzgsNdIhI1BQMc8CIT+k7NjDnkRZejcIbc6aCXxmQ5xCSAgceYTDXEHdkRMEYf2jEBcsd2BMDRB3dMgOzRHYFw/OEdOyJ7mkPjHH+YwwQrHeERUF0O8ZgcWT/GI+CWH+SxMspHeWREp8M8JmT0OI9A7n6gx1QA/UiPgO54qMcELR1oldoC6kirJ5d23EhgKz1wZOIDDuGKfR7+GO5oyv/4t2//fOyY7V8USHdnD6358RUDZFv2H4+Z/lAtay7jl6prqvtZnzmRCu5PJg+Y6pmeKc+XUshk2X68/On83eu73359e3f109XF+d3V219/++ny/O7dzeUtASSmRyt0n8ntux9uL26urjeZ3P5yfvFa0JgnlheApRdi4dy1ehZKwjT8/6cfAax6py1mefXbMQcr1P7VW45tVCW9Kq0qhWr7Nnnfyv29bxCWbx/KAYmcnFk3e0qm5YQHeWeuvjld1N3qSzlZkIMDWzBqH0LVLsCTg/Xkd5cxOpWntoOCHBan8JbxJwmhDjsLtJODS1K7OqYs0E6PHEn1+oCxVD89MuAh9NFAAQk75iM5oKEeRmEZ0JEswjiugECaGyLVI1NCeOmFoSJXeHCEWMADjQNJLPPwr4BOGeSRXIaxXQERO4Kjo6l2FxGoVRyfkZrZYVmBdm30xbRm2N1HQuxKGulb6fauNIFbM51lCk2hZ7y2qXNasXHKHGXgzp3QELYjJygDt7WdZrDtaxcYkG3kUjWUfH9wezZje+a92bbSkxuzpRow7cqWWIKtIxd96BiGIeHtwzuJ8y54Cj5Y8FNE8A0lj9mFJEYtZ4/kDSVhNWjlY9dfswvBrWxRFq5wdTIvZSU7yvtiES9AmtGYVyAL8aLXalipzAmFtC5tnZY/+DwNXyDY4WAi2tP4hqCAjvA5GI9xNle+1O1gOMrffMmEt1d1OvPDqxgh/JKP5gvAIz5mHqb/ocIoXZFiEubVHojG+GAPZF1B4Pxr/eX9sEN6N3C4ZXqPdDKXcClkDUVKpgS2YYIEYRws2Hi47roEZOu0W+tn8tFcPzsRFxr18JaEkh7jGqX5fJYP0BXlWxEP/dRRLkl5eqirXPN6Ma2I41yS8oOIh37mOJmknzhYNlY/N0OjY4jTZSP9oVmWcIVSJ/HR130E6IWs3nIU84ljQbO2vW2hmT/ul865DhSX0KVpEzOHGje2HLbmTQYxNnBWJq6Jk6FsjZyViZupk5lsM3YAUzw1HW7BxoBqZv+1Aw3Th0YqCO6uWpn4cYbiaea5vrLaIvv5SI2ZOvkIG/NIYdp6MG/07ZLhc330wSkuy/TcVFg4itZ4Yo1VK25qsSjmzmfxmrPjWYWq2dNYrOr8MFa5au7slaQ8O3pVqJ49acUqzw9aFarmzlWxmrNjVYWK+VNUrGriEFVpqeVTmXzhgUOZFrNjj27xVic/6GdUTs93i8qF6W2D8plwLItVP6NOZeEASsORTg/JRMgsUTKDjRYWHvULhQB3mNpAdjvkfvenAqJXQ0H4qgnnI2xQ0rTE166gnmVfR98X1tFQHC5iTtGeCDx78lUrqAd5pWxUFrIYisFUTDKrY0BSJne+avVsWfb28+8ldbQrDlNNyeSTAU2Zg/qq1bRl2VfTdyXVtCsO3TKEG9Vu6+6lmZCYRDK8Lch21wMZn6kb6ily05iGVS2MaQxKJ8H+LYv2WG40xm7HqgnhKFOiXul4cBXCJDV1Oag9tKAKdDstVyIX1+doiroim8ySUnEOQmz+RUmRfcBfqdIClKKOySansDzsrEGy3xUFVLe+fqWK2nMUNb+bbA4l4cb41OZcFA/ap/uVqipkKWqGN1lFJeIaDGZHMUqKbi7+ShWX4BT0hTd5paWiF4lC6W28uyeWBMhULstDfM7Q2hCNz9rJ/KXuqA1OMsVBCFljMBEtg/5AvhVfoEoFPciQpQ8BSdk4ZNLOL3JIX8q8wlFQI+TyhlorprUNlYrpJu5ORrPPA3Fp8Y5iVy+6etlTxo8bojrOMnndVKJCyQMGO4/2ZhECwsRS7kE1Io17HIWeU0MtsPgVL55olJ+WvWjGwhhXa80karwY+5iYQsTECu0pMS4tHiugBcL85S58lRB5QwyMDPbXzKwg1W6Z2k4SSPqgPNeralqtKjtKIFmOwsRLbm/SqQ4omA8moD5YvH3DuD3ciQeIl2N2t/hsE/fcHq4QMfFyN3F3z58Z41PjMVOZ+VRUQBOgQqHgUZMFiRw9jQTq6mkv21Sz5eV2doA+X6ey0fl4YS7q7rlZLvv0N3UFrKBTiEQeXnjVevXUdtz5Pw0skvZCSjdJGnionZLjYJ6rzz+uk1fcDUCx+BgopsE8Cojh8pjMvdlMsjbP1wQlsO3klSCM+3htPFR8hmqGCczYXA3ABU1sEd+reGYLYJKiNISnhWcvUjZQI5RihPYiJGI1wsYEaS8qbk+7hGTb0W7joSI2wsSF6hFc1i52imSYS9X1H8ygzHhOUifYMCgLCaNGQuiXUocg9NcqHoXQls00++/mS6zhDxO6N/1Z5ubGPypHefOfg4zoACBMSNDLocrDHsNkDTA5kiHEIAyYQxN2M8ql8dpRnZqroWK35qwpcGzxDir3+6fwu6ekIo67h8jjDqIRty9BNy/56CYNzuXeI+4GrMCwhpEGdA8Ml9DF4MTMoRaDLQdyHArD4K8ozeKylWbZrruJlecg5EQEOqbyrdQbSqwkjIPKGEqbVcZAOirCYXJahC2Yex7uNrtp1/3gXLmqjEyIzzjf9+LhG9VQzmdHKfpD0PTgMWQMgTqGXIxQzWbtp3r6pu6HPFNjNZ9lwn5A19Xq6df+L4VIoXghVHJpZpQ2c5oshUsrQudafL91XATZLV7X80fmsmmCKBVyZuKO6zM04jn9MRyMsyg4gpd4UdmJTkkTOeBN/Xj52VhVmfB4RrovEG8C0dwulXKmYvoFopHj4c3eL9KqAe4AGGuAvTqVrQXz3amsJUd3Sm7WCJr549tFvZ0j/WW1WvBX8UnJXZoDQAV4uaRYMvNKC8hlWnEpY2wPacu/0hmRiSsxfHciUKvA9YklVEwoQpCUuDSGh7lHEWUyXqWI2l8QMg5J5c4incwlRAhZQ6GBKYHZeEUO1WhVCkOPVSLBu63i43U2XK4zK4EiPVpHRKWfK5EaOru+wIWwXx8U6B0DFWzoIo/Dt3ScIa/Xe8+OwExDpvsa3FCU8JANmc5kasB0uwwarpt62nR93ffNndTHpZO5NFxC1lDDxZTAtrwqQUiLq1lf0EbT7VLnwUsCCqX8mdLZUYSImhv14tm++Mdvp5K4ctlTfMPlojfT+sPgiDa8TNSfbrgFbr28aKd52JHIIjEXKrD7KEYDtftoo2CaCAlBGePY9D/0f9pLmCgSQf/vIzRWeu2YGiudK1ggghaHRiwMcaFGzV0MNFFx0cUQYY3KsD4l1rzDWpVhncoFRV+zsq9XeYKJa1cl61bFcGEXT5yS8J+JKJyAgEZRamcg113YBxg3C1I0+eEw53G6qY5RMxynmNjwmM844TTG2NmLE01aOM5VnH6KwmNm4oQTEmPmIcZPP4yddfCZbGApgm7b+ap9biY/VqvqfNI3hEu6Z5WnMpwhzQKxnnHBciZRkCMQeg2SiqPdfURkcCwKU0HDxW7M8XeO5yjyT1A5Oxj9njYig31B+Kp5I9wOIBC9oa4G+N+soj2QflEbXU2HAvFVdfHUzKZ9JkayQOyfo6r2QPpdiXRVHQrEVNWnoUQ/tpP185CLgS0V/CeorghpX2Hf8tfaEfnEpZLq7KKdr6pmTo83RcJQ8p+l1g5Mh2r7g7najuWS6q0khqWC/yy1lsaxb03eGZeKqbPtNcc3dbJdHSDMJP8Jai1m0i+eJPJJikVPJWzlfmpmNdmb23ct6WQukwtC1tAsA1MCbrqhfl4MaYcBjQklEURmHFSyqGNPty8IGt/AlNcTs6omYQBHFsXBlw2w29n1m2qxMIJmoqcCBqeWRA8oHNKgVOkwAmEqG0cYiLKWD6QqbPgMZFlnGSQr7C2bYkfez4KDR2lHy8RX9FXHdGhQOqbngOCN6joY7G44LJnPKCpGtxf6KuEt+lCDUPln3kl/FeyXPoOHL5efm+WwYHn5eVXPl9TNGxI8n8fXq/kfi2v9x69Q48HUoTZpeILpQrRVDcs0sls/YjLQbRoQa7hPWmh4ks9xeg/vGZy66PjknfO0Hd4FOXUV4JNy7tNxpeMk92qwTradYprN1O87fW1YJtFOMX1m6WeevjYMk2OnmBYz9WpPWhvWSS/7dJc60XWSKa7yya2R0zXFEzUlDMqMzOi5GJAJnHSxTLeUaOYmVvAplUKt7DDbNm1SqJ2dILFNjZRolydQx0ydOk3DmCdgihmMNoA1fk7TKeaJlEJLpKdMRkyWFHIMSe0+mUghyw2WyLTZod12X+xglKgnnT6P5DGDVFhvw30D9ipLpJy/5U31yY4UCzkTbSK6nSkV86SqptPrdtl8NlIRYp5U6OSj37Rjebta4I3QzCLa04w78f0gYv9NtO48k9SrYy9lj3bxudIwHe2HjQTZtok0RznQiHUuWwdMpIO7YiVUYqdMx4K6Z0aufsAz+/JT4adMhN2+Z/LaU5lXnQWChUsK9uoUR3qyk5qX2O10wmhQZLMutReRSY2iRmdemi104GLGsgXkonqUxr5aPZo3CNgJ9XGZCFm41I2FnaB1v5q/qZ/78YXYrlOJXFp0NmOoLSfZmejabJ4FeWjq7nbV9bH68YsBhhRGWgEL4XDde24nPNQ+vQOHOIcMkmgLraT4tgxMhfRyXVPnrTUG8uoobgXaF8Xc9gnmrM50Kp8Iat94/dqMp1E72z6IBOqcl5GCbQFECnUG1EIhd8J5Dqz7bSbhO94Kit7lNrMU2Ag2M2ohUVphHgWcIbWwNMsh1WUflkxtTyTlEOxTL/qlb9aqbvJkgUrETkB1vZGzVlYmeAKyAiZHmrDvdt3ntnrq2vXjk9h9Y9K59OCkvKFOHFcI6yhZBIGGyDYqQzMgomEtQQkP3xjoQHp7YCTiO02yBan9JiMH13USKbTek52BbRw1DrV1LLGUMhqstbbXDdut0+pG7dkZWZTOg4gD9h+A6Bc+/dTL/WMmxvo8iUuYZ7KFIjxBbdtXwyk37qzBOer5dNE2RCTnSAIBpI3HSYBpC46peNICp3uoV5Mnwwc7pvfleKznw5WdBrsNJUazoM+YcT6ktnG4dq554+tBbtlMmtlmRNCuth8mArbpEAjUVgMnULpdHATY4zJysN1REUPtiRopzDaB9SpwCqUR5zDA9ttknTf1rA8r0/iCO8BCE7nR8Qqa7gV5XiX//7tvtYlgImMlTy7sb/7x5n61y9ULPp9Mjt8R3+bsXopDvqcrBxf+f6UuywWagF/x23Jxt2uW++yvDv0hvAtFC/sSLjcpL/YdaRgulzsF120fByern7tqkV/gIJPFkqdgu5ov685aYQeh0xGZ2zxG+BSEP27aNSPZQegURO8WfXHrrYrzWX5vuoyWS5+OscQLYklntn7YeVsaPUjZU/Fta6EA7iA4fsAYzKO8r2ZNn28zfxTnUuhkLvMpQtbQnApTAqaT8bJNbeQIpZDqV5kMYxSJCxunFNDwIzcVRx+92b4Yu8whkYzfCGirNH6qQzRv8wZAGxU3BSIxWTf+mYnYLoFCZd5KV2D2RWxlG/3M9cZO6Cj1Zt7gZyNTJhUkuMKNfTpf/BB4M+lD0rQZnjFavl1s/jlgxu9BEynxm0Ceq2FGd3l5Vz0asz+LRemgyRSEmw9oV2/KeTJpD6TndjqMGqe3zZw+Di7WUCLsAbSej0LKxUuh4kfCw8SZOyW/u3TAqDyhnlcKyy0h9TbEPRlB6o4FsBUtkIVyUpGlwDWNPimqL/NEmwvK5S+xcavHiQSFfsa1V7sPyrb0khWoc/FCPaROfql5RZDAz83TTHE/D3mFHWGsZWeaj6nHaVVdOtMM+zSgfdn/s+/BDCe5GaPOGCg5O0nQ0SEajaAhA5sMS4emJFIWB0lBLxgiS6OjVGIoLpWHRUE1GhThFlG6tKg0GpLK0Ut6FKXa0lognuLS/kPF4wAHjcbpbWmcFZvDIR0B0Nrk1GnVGMrtCcvCRVEUdi50oFK/4ymUDlm5M0tsQyAR4c2Ac1VkivWL8sI8cm62q1Pf9dlOb+pFVy/7jDbPCffe+VJ31BunmoBXV0hXgnaN5PJxm9mG56IGQXKIB8BFGcBDpCLWdr0aCRvn4E6bdkLfjgbOMhn99cHZYtAy1W1ypWTME2MYlvHVsXGM5ENkFk7T22QW3wnC38XTsBIy5cNdmsAlvJGZQuEs47XtTqYVG/cmowyTfYLcydkKOAogq3gCCejODIjqvqhmxl1ptcqD06jO4cXoa+oRE1prkNyzzne7lunnVGiSRMSTZr1Zmx8y/lA3j0/E9W80EiXnyTVU/g/1Ml9U5r/VLrknRVc/ty/1D9XGDtCqyYQ8iVbVx77bWi9AliC5J8VmCP9laFZsVkPJeXIt14tF2yc4pkTJaElviz4kuu7qh7rPgJhK5g2clvZkFDooUmQ2dUgklnhWcLmq5qtDOmEBlEuLz3dMpJvAxezPJuquEbYoDMxUuKJdZplqG2qsKM/N/G/ratasvthhIlkfnHpe3c+Gd6mnTXVTzR9ruzmckXk4fbhmOZ6PzqQcMOzUp8lzL09T+HTryVyxfn2GzB1j416oY5QH6aEIinIM4aAXuaOOY/D1EIi40rRJ0FRIjsnHUqDDDKZG9HEGqpsbaNCKtZGGTSvdkEqabS2pZAWx229bqLv2rn5eDMdBxAjAJvYKBrICNC7wZSo/h6vDFZ/ILSFe7RJezh97yQLaLINTkSphT//i9giIMOJhSCNEIpKZiA9OCo4ep8ws+w2X+8URstFQsKg8TvU1D9cEHYQLiYlcTsj8up1Us1+pQ48QbCh+Kl8WlniA+Igt74g72EugpbUenRpd5/HAtiz6QDbBLfh4s8qdGihiWfs3kBkkXZ1dQ3JT9xITpoeTpHHr2FD5wv2ZFFxvat9UxESggBHL/f/MfduW2ziS7b+MXz3ZIgDezpuPL12etstuO909s3rN8lKlaFtTSilbUrrKc37+kACVSWxGAAGKmpqXKqcQQGziEgFsBACp/eBxpXZlEpdwyzIBSdjR05Uj8u9C/QG3TioXePMkzewQDWgfjczpvaAXuQ3NB7meMM57fi8tBmNn0yy3j/TpYy/9cr+9sWvfP6FI0DYUXsjUI7FNlOulJxTqMjSrMGpaMEFNt3tCsNKeBl8moXBntrunNq6X+/ZvuniUkip4CJNbrZfhWmIkpyjyejatoRORFr0+vO4Iwu1yM+jLRPmknFTJ3eMnX+/a5et6+5VQQUiFiXT0v78fTwc73+yWK84Do9R8PpgsWe6FR/BDfvh3au8rCOKUR2zXAng8y7tpU1Ow9PITa2LQ6C9+tP9Y3/zboR24AoYpLD5LNxCoEPWHyJdNY20k4CbxNmK0wsmSqBbjz4JPQsVMoSSQIrOpibV06i3ctDupy6XNwach7naMyemXBOkg8+UQBiar8nZOWlHKx/PAvL3c73ftErTLxBs1SmgWU8YWLDJgJPa0IccDiAy0FN3No2wCAD+XpKNGMElpMB7SHPRXCsgQ7cWjnIXuSmnfCDfAI51Ib6Vg4x1gYOwl33+RPhJJwxgbjUnmMNbRxkbwr/fLQEwwJTSnERwXnGIEfeyTjCABQGYEOd2JBofQP6PBEYEUGBwC5ZwGR9SOMoNDID3P4IiwRQ0O1c+nGpyEXh8yOGzPn2JwWEyD+L/T7CwQ9gciKeeD19tTZi9mKFL4EyIjPewRPUshrJqT6CEJCZXzLCjN6CndGISGfD53Ui2MGa/499MRA0L1Y88W5y04wTk93BlcBfsd01iKMKBJ/EQqQnaYyjAGB+t8KPkxLG3b0EieD+d4gMvw0cN8zvrjI4eioyIxakiALWE2OI1/Sq2f+KzwgpEYqWAFs8NLRmCktq9sljhv5EUqxuhsMYmZnRNZfNY4H3Mn6YjD9+53+9sYZUfIzOLKuXJlT9sTwNOME6s+YpfCmqUmidU+hzVKgBgyRCzGWWxQQgtGzA+Lc6LlSUAWeBqe7d3pb8Kn9nXS1ET6e5KViXSwgYF5u9z/utr9tr3e/dTq4o0MIzeLoQmVLTI23EdMWzEE4UxaMMTxSQxiEFfEKCbWUMAwBlHMYRwToYYMZBDrLEYysWUjhjKId6KxTETIG8zwKE02mpPGBGk4BeMiyXgKOiD97i1vPSmhWUwnWzBrN0NfTn5LmpHiAUUsVIpu0futZ/fQ9Nogu2esRpL6ZgTTsGN25PT17sPqC98txyKzdEqmWJErJ1AHDT8VJxnDQeWUuPEgNsng4ABFhoa8TgJ+m9M9h8tObbQ0hLM4annbRXw0h3Kie5bj4o0eO96STV5qDycNXriXJ5m7cMcaGLtWJLapPxaZxdgxxYqMHYE6cpUGE4jMgRhlk5i5ICqJmePQRMycvDYCZo7TPYeZkwMMmTkO4SxmTt52ETPHoZxo5uS4eDPHjrRkM5faw0kzF+7lSWYujGcQTMDcffhs/5UMLAiIy4MM1uOnKhNUPFnTj1V6nx/4KgbU3ssyCdioiNnA3RFz0hRkd8zMdAKsoYsU3v97yWt/J932Gxw5c137OuG21xlxcY50xrte57vide6bXdMudE26y/ri91hPv8M6VCMXuHV5thuX571teepNy3PXHjMAZ79xeebbli9y0/KEW5a7y5kL83J7s1utt18/tn19+XWMlpSaZRjyJYvvkB/DZ5rjuPu5+e0vzfjOpQCIQR5+Yn8Gonf79df1drlJhuVnnAeb/ygD/ShhABT/FqFsCZRUdcMz3AJsTlw2jJJwfFvSF+UzOJz4BXAc0urjcKn6WNEvgwegrNhnwc9H02bZrwmnGoDzmGUePOQ9eF2UJWdsKaHZjqaTBafddzfEztiOX9o6IQNReQiDLDJjFsEj6gY8HKoXTNXO+h1efbLbScMT8johUFOcTkq/YXwOD+lcl5NSbZTH4ZGlOJwUFJS/4VGkuJsUFJS3CbTSheqC8TU8kERXE8MyfALt97v1nphBD9+R8kWCJp2t7Eh5o6oefg5iZAbh1wR1Kb2cVy9+iYuBIHh/C3J2uJnPHw6wmO6U4XWhz28hnD6/EH9+h5vbr/LHVEx94oi6UCU4FNEH+SBrj507rQJzhhiG1HnjhaqihyF4ow9yn/DTM9eflodvMZaAkJll3sqVK5q2UsCZFmdeZmLVJz7OFEYimzGyWJInjEloQvPFAKQp08WE9mJmiyygcyeLCVVGzRVZXClONAEDNVNkMaR4sgQM1DyRb5/L1AMzS2RhJLq0BCTcMpSFkupTwlj0o7l9/fOLl//++fWLz395+R8PcL4v9+vu4Y/Dn4bJkXlqXWb5Y7l/W27u7WN/L5rDzX595+3xdg7p8CdKZJoOruCk0tzRbN+0ufIGKUkldhDe/fJfrT2BAh8Tksp7vm+Wx4YtFZOTynaXK46//eH3pNJeb1fN7+HWp0Sm6Xi+22yam5CKR4l0Dc3qr/fNHqtlmBQuc7A07DMFVoa+hHxhuGq+tKtT7tYCotQnXg56wgRwuY1B2+usrFS3n+V85Wl6z1TJrAopfehK05UxK3BKGc4d0pV1F+1JtfWy56p7vRJX5qP4OUoZBoVSGCJQxMperZuNuFIH8ueo5RfutCEYTXLSVQaWyJTOGKfOKh0uRLujka/Wm4ZbhEL6LAtQqkzR4hPBMgsZ9uUwUnHiu2FCDJvdza/E4pdE8CA7s/7X44DFKI7XdJTiFDzRFRwJImSBhbqolRqpK+RahLqoFRmpK2QIhbqYlRepLmKQhBq5FRapMmaP5D2lk+widTZjeoTrM16WGfutexY5FRCRa96xRN6rGqqb860LOI3Ti1AhxwEyszkPqlyxA0Hgaewlqz6RvUxAwvByLBIBLzcRyfhRXUmrEI/pTscjciokkphjEerknAupM+ZghDo5J0M3/zzfGXA2pFqBwxFqDjkdUrXE8ch71EnyZSoMMu/sff5gHcqfH3Ul9Awi6+z4fm1+XO8iM08S3Tjj7Ngej+Bc76i9FxbbOOMs2AasVluqJVwDtBaIyA8uMfwHVV7QSiLG9C1WTmU84gBzpkcckLpDBvpCnyuKMBjl5CMMGDKG1B3yDRf63MNj61bizz3wrcvzMqT6iFu60EfLAigw6+QAChJDzCte6NPFAROYOxww8Xb5e5vhTbP9ykf6EjKzLDm4coVXco2Bpy05WPWJS44EJMzMgkWSOJ1IQHI7EJXjgVyzo2rN8bfu2pT173JMXp45EEWXJSEoE/trdPnF6gxNLBJ0UkshvlvOo5NZCrFqIz4nQTO3FGJVx4x+gu7f9su798sf5CN0rH4/0+y9vO1Erejf18dvz781N78m9T7IeCFsqZDmsk5DV9nc7vY/3i7vWD8JAvM4SapQmYdEvNzMb3lcCtX2ohLGM6A9buxI5UFLJ9RGmnNSW9CWC7WRRpXUFrSoQm2cOaVbMmJLhTpZQ0oqjVrRQI+lb0TklvcnHLzoLIMzUnzsbD5pkAJflzarjIFLnFyKcEWHdgxUaJCnI6CGewxBaOCnI6BMQLRhZq0DxizEQEQMRDoOzlTEgMSMRjoSNmw9BiU5en0KtlAQexzglFh2IUo//NCeyxg0p4s87H8NGtcgDTIu5onkuEwTeK4phrNXcPUoGVR0Yp8YfXcwtef13RHzeZm+gS/8e7swuGtW3Lm+U8ehxWbxgYGiRdNU5gvSuJwQiEQ6Jw0P43tDeEJ+dzSNTkNzXN8mVs4pxyxYot4/hCTk+dM0U14/pDnk8dM0U94+2BVm+2bGy4eURzx8mn7Ou4cAxDx7GoJ9u3j43jijueI2mUNwmAIuMjI+bZ23GVNAkSEyzDg/svXh5QRYw1zzYzrucKohsmuDXJfA9IIiTcKAXsjJkyia4BxKDufK/e9fs9iWGlOUV4p0BjYdXnSKJoGZOH87A21sgjcN7eic2Xp/vKcOhj0mpJ1bc9nIQ1xe2rmT/HFhsam+D41pwDXOvVk9V2u+bfxM0UawZwI+NJsld9DrlHZupY0Li1WaD43t9VZaqOvqQVygclx553xmrzq+DU5hOOFmKuHX0RASw7hq8/5rNgVMxBydUzdX9n+XQHXzbb3BYcbDOkn/z3cWq/lUH4kV4VDP0FV8EFe/AjMjAzJnNwFAcusRQzTmJZhDpeBUEw6WJrIS5EFLOSnBH/WScxIUhGmUhAzN99B+SAAT5EuYpspwrTupCbgg32Vw8dNTFlLq0kLceuvVi+7489qbSsgaELLOjm6/29nbm/+2TOrufrb5UfXmKakNh5nmQBQ78S6AJDj1noSCOvwusY+CA/BJOAJ8XOrB9CS9AQYy9Yz6hHpPr/J5tAc4yNSD5Kl6/fPkMuXhM+WJoy7EgU44Xp6kHW8MEKiP3RqQrD9V+TyaI9zvlDP2SfqPO+LWGQEIyDfPXEwVKjNjjznFXc6HCY9itQoSLWOf5TJ4umsCrnep1YQZL4ftQ3Oz26cN7VHOy6B73q3EXA9OhQdZL4TPHVNdb7+6mkjFOM5+AZzuVLmNe0jB52e7YPt+mDK/pTJfaoR0GUfkp3SQQOYLYLQLo7apzlhWYe4LoLSTASfZGdv0iYSf9wIID7vN98a/b0wyxxvmukwPtIJUvFS47w2yXcyqvGiau84/Ja/C6OwXw3kGxv8RfG0zTYQ3yDkT2wbvEnX3ejyer37bZaYfEKIEZyE7g4WLHygivyON8gwDSWQ9UzF1T3N8aP553xyOnz68TsQ2ynwZjN3UvpO/o67RCiOErJfBd7/9dbv7bfu2Wa2X3bh++fux2R4ojxkGGyrnMshvm+OyO57y8f4LdXwwDHeUWcIIChB6hux2efdpv7neveKuUYtgHGefPJZJXN4zEhPBYRmztTWJ+EX/+vQZgKGIy+DtVzKtcDcWXu13t63uRMBcGRer4VM/u96lgyWyz9NXH9eEzX5yHQ5yX6y9T/1qEkg/8/9Un5wwithCLob52S/teuL+OMWAjnNfDKVbz36fiBJyXwblaVl7BlSmiMvgXR/e9k56AtJR5vnmIIPFwMMkp8u3YhYClNAsiwC2YNECgMTORf/cH467W/oZ4AAKL5dkgpWO6SFHOjAv6wzo0icsPMKzJispOCOOi0c40WklYpM4rCDGc5xVCtZ2uK3v+LUTj3GUcRZskqU7j0mwbA++R5MCLrKG50EmrN9nAxtczPNQxQv52YDKV/U86mkr+nM+IW3xHLee5MJ5bnzhRXQcpHwBPVvVylanKXY15gLm7BXhZWqwwvkl6sxVyy5Xo5UqWqrO2ROC66sgXPHaak64wdVLEK540TIbXNGKi8ecvNqaDXhk6cVDTlh2neXrImuwV8tu6TPeHQzIXmxFNix/8sLs9EFp8YdxOOEoRCGSweW7pyt636y3j3eKDS66HKYHaxwOeJ1W46Iyn3jy9Kd5QBm1o9dPgkrJ109SVd48ulWZVj/DdMWPA1dYxUP5JLXD7hLcSB3oT95HhZsvmTmDRIOc2Y7wRtK7YOVIYkd4yZJGn8NXGj39lkKVbV39T1SahyR+jpCrNv+D5B0anVEEtsQf+TaDfXQuVnzM/oe+Zp42ItBM6dWnYvrvoScKr9a/N6vBuoWha2mxWaYHgaJFMwPmCxJ8iRAJ6VJCdFQaso4HYXbtQ8C8bJfA1UKZAGuYayZUE1brIYTn7SSfi5ZcQqTBTaJt0/CKiPoQ2ihVf1Zdhsj5SB1OoefTxgtDLIdwnUstpwGMkMshoHPRy2mAgwRzCO48FHOiuRSTzEHzOT/NPM0CsESzZPQnU83TMIbJZgnQmejmZPhh1jaCfBpvO8lxscytwGOdz90mQw6ytxHI8/C3yZCDbGgE8jxUaBpkEYsbwj0vj5sGPsLkhmDPxeXGncpgkfbx/pfV7rYdSKLQmqD0LEu2uAbRyi38WYHZy0PGKciwAEmQyySk++YrcVBDgPCU8WLIuip4v9wTh6uE9XfKPCdC0V1+KfhinEm4rMfPZCrxcPOtuZ0F4dVDUWcBjdyNtG8n7bOg7QuaGWvStEMAe2qQs7S7pqxJZXCnLE0nod33LpeedYoMlF/AZWs2OMWQVe2k0NxJeEXMiQB0cqxjcLYxteolpJV8LKZwV/N/TiQYUfAZCVGJs8CX0EoC2OeyS5OnGAGSSeh35uCaps3dQpSTxELOwjxNgi4noATfcQEe6iyzytJRCSY1mZU6C3GYnEqAPRNHNZMrOG9WlrDpcpG+FObdZI0yjX6bWv1BSktW8fMwW5M+QMQWCb5iXtJo0qdEuCPBR8xFIYm9w4BJagff92Z/XG+/trrbVed4QjGSmIUxoksVsURjyGkzJEZ14i0MYhR3SfX65FFcwqWIUdw4QTmOYYZZkdhYl9tu/nCkbwJlABH5ZsW1ar4s7zd0IAgDyc9yLho/VnW5/Wm5XW3EWIYZ0scN3EuaovjbrFo/Lr8kau5zyLxtsDcMzOLr29v74/KXTTOwzOQo5gRnMZLBwkW2kv2ONJMZBpJoOVMxcQY0DCrNjqZiergY5bhvS/o6jqEPgyOyXwLl+iTfyrXGkzj9G4ZJ5Z8Jp9DYRUZA1OalImFMXxhGxAJOw0AaQgmOJHso6VEDs/iz5uzgQ8oshs8vTWTpHqGlmTZQlWjLolqb7dd2iR7T+iAlGV1RnV+bbdPalXi9DgWnahYOZGzR6MiN6mKGKiiKjM2oFutGYkpOQrPUYbta2/xo5ymrNX23Kegei8+CImCEyBpOsjq0dv/lKCvh+sj+9fbuHh9hGqUHDY/gtRy6wNgrUmOY3O6w/yCqQOcV8SBqUHVkv5c4HyZBITgmlorEH1QSEOMRlqp/4MWG4qPePUycxZeNCmTdWWjIeJiTrS+BgTTA5yJgbPJYPWGW59FNWixOf5LRYjAMO9aH1RdufvSYNEunguJEM6QBurQpEipLnCPF9XIrPFSctqYj9QoHzKh+o/OVuDZmcKCqyIxFqoccCLSupGFA6x8ebl596e4Gbnop33cPT8sScrMddubKFh16pj5A5MlECMKuLEX5oRNMU37KMk25b+qGolRPG6bPZfRGZU5ypgh+inkgkCS7VCEO3nCMQSQ61iQEnEnhUKTaFQ6Jd3PC3b45tDnsswhRE8NKz3erQlCD7I4F9pOSjU4ETcT0JAPZezmmIBqVcA60oXmiMoz7LiU1j6liS55msMjPSTdbAVTpxisFE2fCeECphiwdDW3OYojSjFoEVaTLcmtUXvRSnVe0fo18ObF2kiw+ImBSFyPJuNjFSQRY4mJFgmvikIqtvM/DkWRuzuQgptaSdKifyxHIetfwIFeb9Z+bT/ZBFs5LETLzHNpiypUd1SKAJwYqc+oTR3QCEmYzhkWStC0TxiEcMnybRAmIBP2M6WCVR2xGgub1YSgsRzDKN3OLrA8v7JOnr7eHZk+ciuJxQb7ZcT3f3d7tDuu0yhpmmhnRKeIytQVH+S6Ea1o7MrkvhHFCm1JZZ0ZHb3WyiFI2PZNtE+mwI/YpyVNHvMbARf95s/tlufnr/S4Q7UPIzOKiuXJFLpoCHjicI1feS0saPowBY9qvW7FN2zI3zadDM34TlQVEZZVNHhLqaN/c7cgAWhbWIIesUyag2axv12P7xkI5ic+BY3QS4ftyveliiGz1J7XaKOvs+JrDcX3bSnxc/3cCNMg1Oyp3A58V/fP9knj+lx/445yz9K3h9vhuFbZ2KDDPNjlVqMjOjfBGmdy0L3tCZpRYPymy5c1NcziIK2UgfiaKRANMw5lufaXIDs1yf/Pt/fr29OioDBiRbc5WYx0CjSbZG0hx0K6ABpHmBxJ6TsQJsD1nogeQIguafxrUJNsvxRM1/IwZnGr1Q31oYPLD9n5+Yz/R0p83LKVjMlkjPQBFo0+iK3GoJY+zKRgijmJWL3H+QE8Z5cmao0M6dTyL+h+8tf1pv/mwu2978od7gtgbScwyiOlSxc9q+5ADC9OPXphLRPswg8TZi5HYyJlxNDYD40H6XAwS3pbBEGFtxVq/tD8ltcEww6zfz/PmXF9M3mFKbAuSpwq2RxJLFUQzCIt5PNZo6/3l9kjfpE/JyUNh2HgztthIvBkJm1N+f9f56uffmptf6VicAArMOw0OeWw+YHYpoZkPz08xviR2pta7KHo3lsemj0fh55KYgBRM/alr2iTxoCDbDKjSDk0nmucU3byF5tWnGukUPJLD6+eb6vTWiRwun8Fgx/rxkGbbN1+aNttN89GZp/FaECXmIdrIUmVM2wgyFzPzIDg2G4x+P4uIp5Gi4e++4Osi6e6LEBKfyHLJ4koZyE9oES+47GvzO+mkHlJmCh0bliaMFDtBYxf01LW5oGl8RW6SjgNpPUFHJHie0jFqAn62AOkzNseEOQKCTdk3JJUm7BkKde/btPFAIpWfRM/TLo56o+o8fn5IppeN+iOURkP9RBpvu91xenZBavXkZ6zx4+50yZcMhyc/I45gRCHbColhhOwIGBqUgC2Z2YwILUjwm84ZUmfPFacPrPiYmkMv3Z1m6EmxTtRdWthxoB841hwFZulQZKHCx90AL+MdvoTezAzDYLJKTIgU3frrtrWPr3abVbMf+zAaFuaZE8/pdtr39OsXFBzIciYa3F/4tCV2VGggj9LJPQa1kpsHrNbg1oFU681yc3Pfuqnm+bf77a8JAMiM52EJ7qHQKETbKAkt4LaIkpphmOXcXjigVD0QA5ax+11Omd4P+zFVypP7UN+1ILigkdvd/TZS+IOMqHj9aLw//fz6+vP//Y/rlx8fFHxf7tfdBuLhT4+JwYrA2hy5GIAs8jBw0ZFvKEIFRu0E0yek77ayCk9P6RYizVcnmPwnh3pmmpG6xCfbztd/shF/cqijB0xkEEyChZy9Isa6o4/PDMsgoHNHWiibHYQmMtmzV8hQa/xxaS+/BzgQv/I3FyLPhZs8JM8XweIXKQ9heUTK0lGhUBxQOxCW+D8WgWQ5ROmP0Awyffzij6zp5AVgyleTizH+y5MWZDyOgbd8dtzdrm8+NO4CMJ97GYwyQizJd36IHt/nNDyhcssqgPq2dAMjBxb3RVRZ4+/jRupZ1Ujl/l9RjSNgp2rMFkn1OP5Abja7Wp1yJgH18/2vqLsBpJjTp8oYfhG7A96dUptUX6Os/yuqzEcVnx9QBcGXMVV3u1utv/yYVHWjrP8rqs5Hdaq6Kqnq4MuYqvu2PEyqNz/f/4pKG0CKL8/IUgbfxEdl0h58GCYmd94pUZnEF0ujMrkqh2nSuCdE9HOdYJJ+fu4SQRGetkzCwk8AIljCvn8SFsqJRlBw/nOSfsYvRSAEXNIkFIyJj6AIWHcpCm/4r7fL/Y+Pm/VNzAowgvMYg1Dhk7bx2O/izkbQl3+EgSXeACLAlGo+gvASrEhibXFdNgiHd62yZ6NSqy9o/YNIp8wEUtEFbWAQ3ZSlRCq6mIUMApw4d0/FGLOfQYwTJ8mpGAVeNzxmJi+8JUN6GCi+vPnWPPSrj814V3MkMU+IOFmqLD58BDnNWjGqQ2ZqHG0sxXDTCYq/vhc+F4HYHDI4JJPhYA0MOtiL5XH5rD8Qbp/7o6cZtNgsXS1QtKi/MV+QNqEIgUicTqThYc/uhxAlnuBPQyS45yCEbfJtB4n1dv/7erPuTOkUkFTu+TFGX/kKQZz4xlcUodj4hMBJLFAakvikOoRHPqVOQxWaDQb7l2BZnIYkPmMJ4ZGTBWmoInO9YP+WLZjT8ETmxyE8QhohDc/p2rXX41vAJZjI7DN5IeZmOfbdKAnO2DtSZ+Nsx/nPu/1tq+6/m9XpzblUS0GWcCG03ebu+YjZUi6B+rduzTIJKea8GLoXk5C9uBwqt5PfvUS/XG+bfTI+Ov8lkO6b2933zszdtaN0WjOzRVwC7/1db1hczbztvMa6Wb1YErdfhkCHy7kEcndJx6cPr9NWPINcl7T0Hzf3XyfZ+D7jRWps0yy3ycCGuS7Xjp0J/rRfT2jLx5yXQNdd1tv3afLp8eBSbZT3MrbxDIhE5svU4ofdzp7tp66HC9ehn/NCNfh+v7tr9s+/rTertojUKhzlvgTKQ9vPNz/cDcjPTuvr03w6bT4ZLepy4/xDc3O/P6y/P7qKNOihUi6Bul1pPrs5rr+vjz8mOXM6//xMQ6vnoS5OClOBUgXMw9oMCNHX21Xzu79YpilRTnAWUjRYuIgWZb+Do/06+Z+7f6dhGeaTNEYqrttmtV5+WG4JuxwG5mWcCVkiZRUGKCetUpHZM9TN4X3gGo1I3VEFXKJ1GaImjO7cHevU6gyxpGGkU3asU9GFOMowuik71qnoIoxcGODEHevk4RJmMSNDZdqOdSrGOP8bGTOTd6wlQ3rgP9/sbn7t7i8KRi1RQrP4TbZgkc8ksadtJPIAErcRU7AwHZfHkrSZnlYrN7+OnU2oUpz83Dji24M8pqmbgxF8YpfCI5Nsu6WgiM9geCzy2UsKopAzC7SYYLstBUXc2AaG1kXqJeJGeTjCba0ULBF3yWMRbvkl9uBOPLC/FuzBo7yz2GYPYWfhukCcYZf4cJ/So/gS5kfr6IuXv9+t9zbLxEEQKWZ+3L8t18dXuy7kpFneXu9ebsf3aPNoyczzeOnBxOjtbrtuk0/Xw47wQfos0yGqTNFMCMGmTTxItUlzDl6/2I2SICQeVKg77jxJBHK/KcQRcpkkAom3FOqOuCVSvdAjCRHEXTXdGeduhYhTJEEI/aEQQXO7Pj7/1vFdY9tHqvczzDgq14e/bHe/bVmal0QzznQeIjwe/GZ9ODZbYoLAjZFBBtlCWYhF2kUTluhizdKe2UvOqt2FDaQ1wyjPvPXx5YuwOqzgBWrj2WZz+rjxqjlQI5BvVmSbNECbS+HYL39LrRs/x6xoGuqNHtasXqpNnnt3dona5fnoCq8Z8LSe867ZJtrUcaZLYHrXmq5JuCDjvL3neyvebZIJe7InfzaS4a3xbVHHb/vd/VfmTl4UmGUZQhYquzIe8aYtRGjFgv0jIQbxYoQGIlmNSLXHlyM0Bvl6RIoktCChMUhWJFLtkSUJDUC4JpFiiCwGaAzC1YAUQ3xhxAyOOfqDb3KON99Y1sNLncnYYIlCSzOEyfmYTshdHSZSDPKSFQ2HI62DjZCIe5egFuRaz92pF1VG2O6OME3ZkxfhkFjgEZrpN6GJMIVt8QjNlIgAEY6oVR5Bmbj3L0IjsY3jvjx7S/nPeyzbGejmB20lvdRZrOS4ROHDHkOYEzodoVfi/UV6I52MUC30+yLtEZtMaBfaZJH2eJcmAMh9PYdB4hcoxWf6BVGVhPwCgWmKXxDhiPsFAs10v8A2lWdthkXDw4UEvID0TNYopkFonUKflRbII4CUGNEzCV30DLkA58Sj5JPwrk+C06rUz34xlLv741kwIf8FazMUwyuqz/QYXinSZCMXRSvnIiZhDM9Louhk85QJuCS+O4ouxZdP6InTq+18Xz+hSsO+P4p52lxgAs7olDUKdeI6aRLa6BQ37oqmRUuL0Q5uQacuzRpc7iq9MSvlDttJNzXRdzRJ76gNqYxdH+3lJW+kVYu6zPLHOZwLF3i7vHuA0ik4/Onh92BVkq3jzTipD4tOMtPvpT8rnJWL9UpusYDy+K3zfinz3jd/VlTrBapnym3yfjFz3SM/Mfb4AnWScEu8n3uW++GnBxpfoCpSb3/3i5jr3vfp8c4XqJLUW939Ima5zz3h+ELY889eOUm3t0P+6L3t3YuZo4Dg0USJEJqHR+EKltEnFHYuOod7N5ZW34uLlp9hFPJpPgtGNCtLQCFY+7JYEuYdCYiCK10Wi8iVJaAQrGtZLAkTjgREseUWC0fq3RKwxBZTLBapW0nrwYmW6skgywyj2n/6ou2G/7xvDsefjse7l/s9+UzFSEa+Rji0Per+8Hy3Gn8vV+6Txzz/momdF/UlDKZ74m4hFsw9fZ3QuRjWh9etk1hSUcIsFC/PHIiCjj0BTmxWTBUx+Jh038tikr2dIm6l83rvJfrNzfL+kADmJD47jqZLTKuYYZbZ8dxyF/KwcG4DV/BMQAM2ftt0+z/sNUEsKiLnRC43UnnDi+932y+b9U3ABYwkZnEAdKnTzP/4GxKMPwMkxfSL9QcMPwNjgtkPoREZ/SiUmMkfF3CWwWfwiN5IkLbMOT11/n5CG3quHpLMvBgDb+QZHOkmXoyFNfAMlGTzHkKSZtwZRPOZ9uDwHpoa35p/ud/e2Buj/9SnBK34oKD+iHmX5W1zOAzvbXwscywUdhIDB/Rqt/9lvVo1W94DjUVmcUFMsdN8EPEZCU6Ig5LiheQIAm6IAzLBDwXxiBxRHEzMExElnOWKOEQSXyRvn7P67AX6C+2O2LpI8kdyFLxD4pCkeyQ5GtYlcWCSfVIQS5pT4jDN55XCFeeZ+/vtKmTqh8kzmflRkVNNvAc9ybyPIaSZdonmoFkfA5hk0hkcQnMeAhE35V7uM834GInMhEvaYbO7oVl4Su1AeM6+MHk8zIyDcx1E/Se6DYn2kMsYI5jiLiQoAq5iDGKCm2AwpLqIMZY53QNnOMwI4oPY8BmAx6UGJSZdy4zyPu8ySJRYQXHQ1UO2d3f+Iz+DDXOUkfs6f0zFiiQG1rBlRlDFQymqmB5PU5SPRlBUNzmMpKoH0xV+piKbpMB9PayDlvlm8gMm+L8Jru8cjyNzNknaaL8SdSlJOnjvIXIcSbpYHyFxDzFNaZ7gHCcQRUIZSd8IU0M7bn1jXTFcalKXdHAFs/+ITlwApCsj7ElEZ4pdQdXSSLCw3tg0H3JPmuZHwCSZu1EtgH24bva3h+vdaDQ9ziUoMemEpfn9uF/eHF8+FEGVjzJpzO6zr1/3zdcTe8tyu76YmN193TXFdrn52Oy/N3vakxIysyz8uXKnrf6pL0mgAFgwKTxAAobAXIOFMoERCCMS0QICODGjQRVxFkHAYpK9CCNupfN67yX6DT2x4usjadWegIOffLFY0tfvCXjYCRoLJ3klH0aTNoljUc23po9U3vBG5ub4bbf6eXd8ttnsfmsC9C8rOYtDCJc+zS3w35bgHCLAUlxEMp6Ao4jAmuAuJOhETkMMLeY6+ILOciARfKKrwVNb8tZmIG4+DGN5zDYTjjlG4OX6O+3gYu2V5OaSMfHOLoIr3eVN6VW0i4l3qzT3J0GW5gQjCOdzhaJK9Z4o+N6s3rdrteW2LWDzI+AQOcl5HGKw9IkOkf22FIcYBpbkEFPxhBxiGNYUhyhAJ3OIUmhRh8gWdJ5DDOOTvZWR2JLsRmwETPKebDKyOcbk5dAxLjLSgmkuMhVTwEWGcU1wkanYeBcZhpbuIgXIEl1kGOGMLlJSqQMX2TrTSKjQSGIWl0iXOs0Vjr8hwQUyQFJcn1h/wOUxMCa4uhAakYuLQom5tnEBZ7k0Bo/ElYlb5pyeOn8/oR0DVw9JDkGMgXcEDI50ByDGwhp+BkqywQ8hSTP0DKL5DHyw0nzD/vr2btPcttlCVCAjN5eRZ8uebOrJr0oz+DyoRLOfgiVs/HlI01xABJnUEUhgCdwBWcy5ToHHJnQNKa13fi+/VL9inUWgflJdRgqeoOPgMU1yHym4Qk6EhzXFlURQJTsUHt2sbiUGexBT9O7Z/fGbFXi1bjYrMqoIZeQepfEcVazIJydxepyPoIaUfl41h5v9+o67SS4AALKeB+Zws6ODfmgAJ/EzlR7dHSdSpb14utLBLMWK8ZMTP3mWCFCiSEm4FgBNd1iUXomfYhX7xm25bcf/bv8DxmNI+zjPOQgCDpJSPsEvynDQ7pCs/SQvKNPOOz8KQbrPE/YGzpmQ3SDVw7EY0hwbhWU+f8ZX1PApp33TDsHVurPZr5brTWidFJCdZa0UK3/aein0hQlrpii4lHXTBEwBex6FNmH9JEMoWkMlwIuto0JFnbWWimIUvTeW3qrzjIZL9jvamcTrK8mzTMDFu5kotnSfMwEf64Ci8JK9kQxdmmuKopzPTwkrd3gja3c1ebtc+7g8rg9f1iGfxYvO4rIixU/zWIHPS3BYMWgp/iodUcBdxYBN8FYifCJnJQcXvaObL+ksVxVDKLoWOLk9ZxkDF+xvtJuK1lWSl0pHxTupGLJ0H5WOjnVRMXDJHkqELc1BxTDO559kxmV89PtDs1q3ru3x+qzYEXA6g/gA1Cj7uM5QYhY6iS5VwiiNEU8wh7R22dtyvHpZdBejnIzqmqQ5ZHZp3VOsrRQNY2SZFkizrVIMAZNK45hgSaVYeANKQ0m3mwEkieaSRjSjlQxB9V4JClpF752HdHMoP5sdKH2WMTTl7HYIU9J0PQlM+Gx3CNOUmXoMmvwVEAmu+EM6ZCnnngUPgeM803m1NmzOjz8Ox+bWnwIML+UcpIcnAINhS5U5+GBpkfgy076hxz6W9+RRlm7IIT7OezGWYKTrJnQ5g0DRqjmQ79ONFPWCkxW1rm27E2k6SU5Wtd5+kWnqBScrulsev4kU9YLTFe32slbqBScrOvw43Cw3G5GuR9kkdYNVwKft8v74bbdf/3eIFiOlZmHE+JKnkWH09yTwYAFAKT41CUdgtRSAM8GdxlCJOC8RpJgnpQs5i+kK4JIs75Ja7NwefZl+RC+4QvWStOhKwsIvvAJ40hdfSZjYBVgAUvIiLIYobSEWQDbfYixaiZ7DONzfdT6uWb1tp5nL63aUhxxHQHomBxLTMNWRhL4zyaFEAaY5lgm4gg4mCm+So5GhFDqcBIhxxxMq7EwHFMUpc0QTWniuEXLZfsg5qHi9JTqqCdhCDiuKb4rjmoAx4MCiECc4MhnCVIcWRTqnYxNW8sDBPdvvlz8+bde77U/L7WrTjMf5SCLoyKTWgy5VZDHGkJnWudnd/rLejns4q/skzte/FIfXj7+55HHULQNkID+xJ8iraNlLiCtpkEE2sMRYviUB+XYhFMvN5nlqpUCeSzea+/SPyy+JldXnmKPC6jLLHwf6s8OP7U0v9np7d/9IHXWTkxYVpke2VvnS390fw8U7AfG28DDruDIHifMYPSxQZu+GGNPH8Vgn2VVTNXKjdaSOGKjTdNEdntE36usCnd6jvLvdplmyTtFPnqVzEEXKnlL1kbK79F+/yr7jyYOozA3K9LM+kEIQdoCjt5ZZBMIhQtZ8dJDItAa6Lv/lwc6bojdB54T+NXy+dHnzrVlxo8VLnWWwjEuUvUPpweQWl/QD5YRK4kVyvpeKdH+hj2cRur+MD2WdqfumExLVdC94jmbh0CS1x0amSCczQAiFkfEh0va1Of6l+SFq2EdRmf0V6f/S/vSiORzXWzpWi+xgmGVGPAGzyLZA0vSV7fH+m8susH65YS3XSGQe80UXK31LF1EnGjJGeZo1k6NoP2b4WmkUxoP8RXC0YysVistyETR/W27uk6vmlGleRP0gS2wtzDUvptYGrQ/f7MiWwRlkOBuJ1EVxYznup8TaQ+Yy3DChmWSq/kTdM+htbfjNrw/i8qrHbGf3hcLrk6OJ7mMA2SA16Cm8AjfHZv8TLpCGZQ4FxNyGuw331TDzqAYJmVkcHFduwo3bPnB+iyBw1zahn7plm+8TCUgYZ8sCSfK2YRxCQ8W3SdRSJehnTAWrPGIrEjR3Q8+Jy7V7eWZuiYDRjtRG0kw30keH1xks98vNpmEnu5A+iyGgypSdFwewqbwSqTiRWOIxCIcc/fXR4SbUywy1wJfPo5Hs0gGtSd050O7ezRy7m+ZwYHuylzxPRx4XKbz3wEPKcS+b+0M7ft8ut0uKpiWVYxZRjxahYXwZhSLJjcm0N783N/fH5t32/X59u9yPl2sUDiLTWYikA5xqmPj4FmnlhjehMja6pV/50tWi9DMfxeer65CJYb88zcKwvXBgYD42/7xvtjcNZ2EgfRYTQ5UpsjEINtVXkooTfSWPQdKpAwgmfLVw8NL1nRzgkPTlZMcOfH1Szw70g2HXPi6Pa3bT20udp1uPSpR1ag8m06W/k/wZofF7AmfGaRZ15LHqWDeWaAt0YqJ207uw/IvpDsx9dVr35Vp81Hmvv+13v4V78FBkxm48KjahL3uoQ3GZYt3jq01jvZrBIO/aYxCi/i3RG+vkRN1P7OnyWgh0d64mJvR5rmd4JxECMZqzh2dOi8w8KxhyYhxkqv596yPX++bZ4Mwhj8ATlgwyCYL11+1u795vltQCiJ+BQjjYpEGfqRoZsyIK7UzVFYziPCOAM7mWmRDk86OPzwwUnSVGlOvt9AGqYKwlIzeTMePLTj2jwoUOjnz423aJSW2kBsFATtlYj2ETD/tQLQksQBIO1hgEQETtwgQEzOCIokgcJ9H+Mxgyf1/aI/AblqdHgVkGCVmoaHSM8KaFoNKKE4NQpRjY2QeNIpEDCaAQDkKmFaKjT6qZGXahr59JJznQQnqDoQuh9h5GcS8PzetVm2X9Zd3sPx67c1Zfx4QyLTZPVDdftCy6m/4Cpqp7M3N4zJEEiMw+B66vzfG9zfl8tz0u22lOGi4y+xy41ocPu91EUOO8cyC6ceURcfLhjnTKNBXD4DajwIAZ3M6SOF78/SW+m8Y1pPTS4DdLL9OS4+hPY/9rkQDoivgcptoCo0gAN2EQXbTaxjhO1aZSqo34HG69zQxyAVbpGL9ohQGIU22ZlNrCD+G2odH6COBFjc9FK+ekPXYRApH/ATjDNK+3XzdNV22CGURIeB72OaZAxkOHvonpE7+0vuPTfsyWxRE95hTx0xOwMUuKOLTE5YUQW+pcLI4zwddNwRib/8QBSi3kFHSCWWMcYMTtBbn5CZjZ+ZtoAI8N6Qz4PKN2/8tqd9tqkdg0XnYekxYpX2bRAh+UatBieBLtWTqyffO1+T0d1ynbhVBxRjYGK9XGipAlm9gYyhQLm44wamBj8MT2NR2bxLzG4J1jXdMR88ZVYEoSbatsnADX9KFZrv7elfVmd/MrwyeAzGwsE1Vu7D5l+kA/8SHseuF+e0z81id+pjkweZ3kt/XxWyfaSclBQS6eRhGiWN7YneN0IOOMErOegGzfbJpeOg3ZOOPMyLo2eN0t+bbLzfNTJ0lrQir7zChbk/dQeoRnJWGy+WcfCbe71frLD6tMDs/PNLvF2CQai03cTgQvVUrsfg9iad1umE3mXxJxpUPiO/8M1TZgi1/+frfetwsRzvUNOBxGVM4bk6ZdqEBm4bmvSSesxFhizBVXkPc9gQobd+kUlHTP/oOq7OHHOGMcqrXHb6Jnci//eb/cxKZylNAsczm2YNF6mMSeZot5AAJjnIBFPmvjEckGdSIO3gmEgQjGSiKSCSCidj+ltwwGxav1pnEPLHxo3KEvZmBwgrMMjmDhogHCfkca+xEGkkh9pGJaHlvRu+PH5nhsTdx4ORwGN84tmSGn19vNr+/u7AUGyZU3zHkpbK92m9WEdh1kvASyL+t28dJdTJ8IbJhvJlw+0/bbcrPZ/cYELYexYd6Z8IkuU09AduX99a9ZbF7GFh0oNcIWpA7kh1yTTR3FDCSieMw1D4rjrkv/0uZ6P3ztSAZmlPkSg+F0Y/c08zbOfQmM6+36uLYmIRGel3GeFj0Zp4k2bTYcN/eH4+723fb57rZ1w7frQ7KZpUuYyxEMZlt/3jfN6kdsDUJKzTLP4ksWTbJo+Fw0GHPlWABD8I44YoKVhGffin28//JlPd6KC0Dycl0AlWXN02H52ebBNYUODUA8kxCdhJa6BVAAkb0J8FxcIao2gGsKWZve65Ktj3iLJ8hBJlVgkD8IIGUJhHOQSViWAKZzOe/kiuMJj0jNpfPeydimwDqP+462rnfH3u1u/yPCiFBCs3hptmDhNXsE9jQWhAeQyICkYUmr5eB4Ii54kyO533ZFP28XeL8sb36lbiHkII1zzoBNtKTkMcWWkynauaUkrz22jEzR3rrrToB2pzwEyDZHb/Fv3+sWVrE5PS02i7kIFC29ko/6gsA0mm6BEI5hLkkDRDFNmayGAJ45W03DG5oWhkBOmRemtW5oYhjuZzPMDNMqMTg1DGGdNDdMq0bGl4VQnTs7TK88fnoYq730+WE6uknAzpshxkEOAiQEgREXC4iYvmd6/m7+2YEPFwl4OGPz9oJVkhDYIA1o8Lvgan0Y7RZ6wAYC8u7X/e9w15bwft8MealgyU/GubgvHaLmpuCHLt7vlqnuke6B+BlK79qcv+32K6HSgfgZSle/CNVZwURFg3mqlWE8+yBtlhkplieahg4Bpi1XR+oSV6kCzftOJK74JCaZ4kq1fvhNqNcKzqmZdMG0bt7xTtEeC4QYYZgW+yBAwplCFknICp6FhA8hGGFIjRqgtft7bO0C7thYweebdUOsW8ZjnsgyE5p2sfbgLynKf4RlnGFOJI4lkAMZys+Eow9HeLXcEOzMCAVIT8cgCtYIqr8a/hGPzhiWxRYzacU4QimcT0ebJrzUItVKJq1RvRxTODaeEYJQoIvjBQlnEaYDBboCIRAjdYKoB4FGNtCBtbznaLtpa2jfiQj8nid7hinxFhXkpoc3NxXvePheHTpkuEhBt5wSQSZTGjdDXtYTVHYy5Y+OCIb4GLnAh/dKJQtVL/MJLL3o+Pt+eXfXrGKHSU79Oyw+y9JEoEJ2O174y9IWMBJQqTfnTcQ3tV1SDxFMw9d04vRTpxKMXvaZccpnGhKkosnHdGz8fEQKLj5FmYau6cXfuzi86c3slSFxjfIeOTBwf9utV4wxe0yaxXBBcSIjNUCXZpBQWaLxIfXKBwhqFw0GmU6+41NK452cruFBB/lpefj2dnk3Utf/PkvXGJYl6hcnUEyn+CbA/ORRSDK4BBpfjW36SOEr6aufY32ipSqhMDYVfMji4DF9r02NKktoLuQgwmU7gUllH2JlH6aXvWqnjsSjVF7xDzKTNNjlUWS49CKTym+F9usm0rKPQpN0/Eq9L+8p+BWflU8o3b6fEyn/QWaShi+7/cvlzfjAh6fiUUiso1CZGQSbU8tzv6OGluWRb/hH6wbaeeNu/59hHZ9Pcp+nmt5/HHcfj93043r5NaZsIJqib/BE8foh0OUn3wA/PlKMIuHl/sDxPQbRUK7ES53FCY5LFLlCH2aC9Sb0oQ0PxRqI9FKWndCL9v1svZTVJ/Si7T9bL+MRCNWEXzhbO+0tqH418hln6+Y8CaGd8idn6ye9DKF85GvO1sx4IEI34YfO1s55J0I95aMm6Rd4Lmqwof86+9sDXo3Qz/i2KSgSPB4FhPV7k7CQLutjc3x7vzmuw65rIDWzC8OSE13ZEP4klzbSP821yXC8bA3aeOs0DOaU5wKIwk53BGaa8xXgCDvhEY5pzliAY7kahxwEcDjxC+CITg5GUCZPEsRokruun+0CuGKTmLFlmTiZkfScQ5r9fHLKcAEs8QnWCM30iZYQz49WLhnRKdMFMEUmgSM4EyeDktG1PhzX7RL0L4mIIN8FkEWnqyNMk6etUjSpvWiY6QKY4lPqEaLpU2sGT9IUe+xKp021BXUjmnKP8Jw19aZRTZqCj4GdORWnsQ0IKnfgiaClXEJw1j0opp2jvWi+LFtVRFGPicHi1KIus/xxIv9sv1/+eLlpbptBMGS3U3D40zApqcyXt3fHH+9++a/mBoscpCSV2NbsMC7RFeZ+TC3nb96b7A8l2Z9Ty/LnTQ9l2Z/Ta6zN+ZxYVg1qzpcQL9Zglyhc4JPYhZ8E1EAl2Q6OVxH1NTVMC4+B0KYXV1jsQ3xoXLDXYNUQUXSFSwZW2Wkvjo2zut19F3/f1YP4JM3DmDmKLhjEW0l5AnwVTFJWcHOPsa/CMDFK1Sk+LOPfQhtm68DxW76+FQhpJlf8F/zSk76Hz61En/sAUzAoQupDA2LmL21VxWP+hrk6bNxRJmJNHNLNLYYv+LkDlfFX/Ya5h1i51j0Ixz+xzr1kC3fK4q/LeW18CMwWcSUd0k0toS/4qb26h1G7EH3tCWTge/2VegzCeIl+4W+2Ch++WjaOH4Fyo5lagwfHFrf4vuR4Hug8VYDMVntomSqAxX4ISCRIYubPdtoeDLesxXuIoW8Vd3OaQ7j0Fw+7uZIN7keg3Lk6oCtCIGJhKjN/c6/uYWDLjPcJJLfYH1MQIQyCkJaZv/pRYyz0bph18FnBowihnb2xyJxHDibt6RGomXa9IW+T4XXL7+KRY7iVV+qTW3HsaFB/dFOT0x8KuEzSSO8BBdSGJ7xy3dRGJac2tEqUa6S2JDmNocBQuUZq85HTGFo1yTUy24yc0kiAaqretM4kWUDJEdBbh6wFCQbOJrQwuUnItnFw5STXym0HcnpjC5k0zfTGX0h3eEkh105u8XGKg4HFCT07tJnHdm3JYkKOgdm247RHZvOJepNaOz6zlmvntuI43bH5bVizYNONdRah4Gz59wa21zjNgvmtfP4T3khjIYgCucMoBhPd59+6B1tX183t3WbZeYev7Z8jMKTULNNdvmTRjJeGzy3e1vvDMfkLn/jZJHPQJFQ3TtgJjUd+qIIw5+zY2jyrZt+sfu7+TEAG+ebA5U8+ltufltvVJgnUMNO03gST+VQA32bX/nH5ZQKCPpds/z3aX4Zv5v3XIWJIRhKzGBG6VNlTeSPIzFDgHoxndKc9Ex9CIel0DIhIhxN/e/88enfc+dhsD+R7NwwEOitRJ5IrN8XVxNsHrquQtmEWLIGRGmy2pFEabMrhCD21Qve2a8zrh4TnGbcxBZOeLg9+4zk9PIo2tbNPQC3t5vGajXrDKYg4+xSFQ5iqYH+fjI0eiEJ8aWNS2A+98/+dll+W+5gf5QRnGZbBwoVXBjDfkehcw0jSfKwAk6QrhyFFPG5qvUjMUhjQrP43tQp5+xTpYsneeFrjkrZA0sBJdkDS6AMb8PG4PK5vIuOfEppl7LMFi8Y9iZ3p28deKgHCIItkxE9Bk1rfT0YZZ0AmHESBtoo69xQEjCXk1UesYLpucqDG9CcN0igmP+D2GjuvCx89/ZwUlXzK1L0O6REtfpmn5HDZgzjTU0ZHFz6UOthN9yXk0abHKSU/GeWiewfADn/b++HrsIT+Lj39u7qqFpX6BHKEv8iCjagWf9ATyJGkmqpK1+dfb+/uyVBiQkxesa3vaGcfdLQQV/CTQabwxw2RS52NBADpbhIADJx6xJ1fwJFPWE2ThvFcJzXP/O4sRzXDevNsZzWTm2Jx+OeXhj7DsyjeQSaUkh6Q6p7nGjnAx5KHycEi9eB81Pv3b14/f3b9+t3Pn//t47ufH4r9vtyvl79sunNSIDKl6DcvJKX3UlMUvHt+/fL688frDy+fvY1oGYpOUfXx/bMPf33z+dP7F8+uX0Z0ebJTlP3757///e+fX7378Pbzpw9vXv78/N2Lly8iSsk8UuXXL//9+vNP12/fEEoe0pIKe/vsw19evPs71fheelKhP2uuuJ91UkHXnz5cv6GacZAqLfD1z9cvP/z87M3nZ2+o6hsmJxf510/PXnwMFWoFkot9+eHDuw+hYq2AtNgXL189+/Tm+vPzTx+v3739fP0f719SmCmx6QfkBOXGzsqRuLnzIzebCaqvXDa5+sghuuXNfhoKnkOYgOK2OS6nwOjznYNj4Ba/NMebby+Wx+Uw8PHRLQ6T5Z72cNfmba53fLkjGWnh7smVPzfbdppx8/J7+9Uvb9fHdlr8vMtIaApnmHpONqn8JxGZyACL5I7UCL1+IsSpVQYhJl8/LVerN+vDsSsipewnfj66Tij86YH5Egix1qHKGH4BUzmD690lgOA69//BqthtBaeuqNy7Lf/tN6kYbpIaYN7vv2kEx1PoGriJHOSeND5GWf+QevFRPBxZSqsh+BSuv3z5ktZkVv6P6S1fvgiOZpKdpQUd7CvPNptTRZGUVKSlIPsf2GeGSATn+/h+430SU3ebSVW2+aNraoMVxJ/4pMrYxKplv/xtYmfyM/4x3WiAQXBWkuxAw8/gTkW3skm4+gx/SJ10uuO3HFDZLerI6PHfcU/pwOOX3P+AUWRBxC9DCI0k9x1MNd3tm7tmO222O877h1QVwBBcgkIVhR8Trq937fzonDqD/H9kvQ2hCG5UCdSd91GcZerydduqabbby/bHWKkHBPHbOkhb9fgFJDuwPvz5frlfDV6QHVzzf0qTUg1fO/GPx3Z5fUsUN0hN2jhHgG6/PBHacb/cHr7s9rd/vd8dm5XbdabYD1pwOl8oKvkJkxZZSTO5mG9l58oH+g68yXivHoqcAXb0eq+7TTuCbr1t53m+wSv4Il8y6J+Hu836+Gy7er5pltSTG166tNO3OA/N++W+/es4nLY+FgsSSQU/u7lp7qiOM0idUODzb92/I+X2QhOKf7m92a2G4Sxk+SepCQreLLetpftKWQBCaoKCF8tjc72+jSg4SUkVLFern5rlajCveCz2IS0J7XMX2HFNW0MUSSr61W7/G+e1fIGkYt+st7+ylQAS0oJvl8ebb83h2f3x226//m/70OTH9hey/XhhqbpvywNb+kOaOLZsXM+DOYusjv0AcPIOOL+gJ7/w9xY84uHOfu7IeTFo+BKIbY2q+LY7kAs70NGLTVTSBWrvBFpOcnI1Xte8I/tg+Iab4VbYenMkx4pLEO9Q7bY3S8rguwQ5mi1lD7qf5Rtxq/sbOtilS5AWc7Ch+M8OP7Y3b5s96QpQRGymuxzXO3ubMGWpB8nSIrftRMU+UB4IIxrJSAv/r916Gyh3mCyugl8Ou819MOoJRaRFN9vD/b653i/Xm9b5f2ylqdIJKfkyZH3rZWzoWetIKu0L3rQuKvoBQ6EU/MN8LHxfSLyAbI4PB1ioFeQgWYx493y53W3XN8vNp/2a6S9jIWnxq6adKDZ9pue727vdllmKMJLyhpUqYiSlitaHblbWnQbfM7UFEhMKfrztPVz8o5y4mn5vF183R3YO5KXPsaofF/jE/ymyhveFffjccTH5x5FYrh4KSIYUXY0fKD8uxdVnnwGVb1M+NJt2Kv3dO3voWZWBQFpYzcf7X1a727avfmi+Nr9T0ylSLsEevt2t7jfNh92OeabgMV28IrE5mLH9mJgQvLTbfG/ehkodySQW/qwVOobLfhBJCW9+v7z5tV2E/9uBdDcgIQ1LfKzC9x2D9G23GS4oH+PWSLmUeRXdnfsUuVV+v9/drg+UPXlIS2yuPte7vf88xKjNfDnxUt3l+rijKZDHVPGEcrN5db9p1ywbklAYJicR10w1OP562rcfmrb3dPPwv94vV5Tz9wWS2A+uyMdEaXH32/U/79nyBqniSVyzv73evd6SNPUpLUxDDE7pvLKr03bgtf8dvy/vpc5yRmdcouiUrQ+Tmwvc+y/DBHQ+ip6h765dCbfTZOI8L6FxKHyGzp34E3cTv3DQOT600/T96h2tcpg4S9cYFSjqGR5Gjs390NrY+/1N87Y5LlfLQeS0x+uilHiI37XSjX0OZd2sXizJI0JjoQQ2+nS2KIwfpcTTt027KvrQtD300NapJVqpydtYSk7UtKa4nVguV+1qZrX2n+wZEjZjMTE9+3Gzvmncjio+CjS8THskJSdsD8flnn5yhi70ySkD3XEJwNyG/ZZ+FYVR68TPVepdTyn52NANlWG1w5sgHgVH9mGQNou9wfJk1z0MAHI1Z41IXN2D3KOm0G1JAs37pltWdVTTr+vxlcEjACg+P45uLCfg6MXPweEdTv38sPkcB+HJprS9p/GX9Xa5/2EF4yp94dm+2jl+IQZfeDYMN9+am19fbgWNP5A8RzssZrtV5fUOLmvwV7NDkZR1ssvHTehBIqXgbl3NBgz5Agmcycf28zbN62NDhiEN08ULpPWdPcG9oTZdHhOTo5HYMkEiKQKr6aOsXrVLTKoCUEZOQa/efWFba5AqnsDY/a/r06cG5jCkoHwaM7aJorKfxO0j/QXpAYASEPFoZbqUx6/gds039wfyOpIAqlOeP6xaLIAYu07nd9j5OKznu9vb5cemLWV5JCkhQkrM4Cy37Sz/vzuq+f1wbj0o3JeQE3l/W27Wq9H1QkM6z5OQF0wTjfZ3Mel8uN69uN9zC61hshzXdbOnLJFLkG8QdpWxYsoapMoLdCtztsTHZHmRb+yV9FQzPKTJC3t/4mVYiJ6EnJw8dt7qdTd8v5NYQSJtr+Vvu5vlL/eb5Z7ylyiSsF/YOq5g0SiSxAETJTv+d2J5nUVYLzdssaP0iWjftP/asJBt6sSSKTIcUieW7PVmLDjakYdXojynLtRof5UX8J4s4L24AOoii2fiCzeefbr+iSqg/VlaxIvnRAEvnkuzv3r37BVRQPeztIifqE/4SfwBP11fU43Q/Swt4vWzn58RRXQ/S4vobhj6/Ia6Q6dPkRb05gX1Ne2v0gLeUp/yVvwhP7+7fv3qP4giXIK0mHevyY7V/Swt4v1r6s6l9ldxAe8+vv53qojud2khH15Q/bv9NaEAapB3P0uL+PjuzWuqa9nfkwr5TBqcU1JaUdwlP4PUCQV+vn75gWp3FEkrmjESj4lpxb19eU2NssdEaXF/e/YzdYNV97O4iOfPPlCdw/4uLeTfP1JFtL9KC3j+7ufrlz9ff37z8uc/kz7JF5hWLNc3CKlUBd19QIGSu+QpRcYQP8iIbdqHl6/aQfDyxefuX7R5A5GpRXPYSTlKyX8+bZf4q+b3f/k//+9fvjd7G+z5f/5FXemrupX8sm42q1bwH05/m7VdZ3er+f/s0/7WdLsVnYQT+dPiX57+Y/G0WlzlZfmf//n0H6ccNsH+YMWy9q/sqTJXRZ57Ypknptq/1FOdX5VF4YkpT0y3f+mnZX5litoT056Yaf8yT1V1VRpPynhSeftX/lTVV4tKe2K5J1a0fxWUWOGJle1f5dOivMorX2npiVXtX9VTvbjS/ndWnlTbJP+oqcqt/cpdMKVl0Ai2FRZPi+wqyypf0m+H7vKcf2QZpTrzmyLTnG6/LbrLaP6RKbJEvz2yrt4zsnkzv0m64960br9Nsq7uM0Pq9pulOwT9jyx/WpgrA82c+U2T1WyP9hunu+qB7IXKbxyVcf1QwRhRXE9UftOorgWygvps5TeOMtzHKL9tlG2bkmob5beNKrgxqvzGUSU75v22URVXkX7LqJqtSL9l9IKrSO03jbbjpqIqUvttoxVXkRosmOZAar9pNGfEtN8yOmc/xm8Y3VV/RloV7beMLtmP8VtGdw2gFpTV037b6K4FFGlXtN84pmsCpZ4WqrVVfgcyfuuYjDPzftsYxVW58dvGdC2gNPU5BhyM4Srd+K1jujZQpAUyfvOYgqt047eOYT2N8VvHVNwAM37jGHbgGL9tcs6k5X7L5BlXPbnfNLn1+zlVPbnfNrnmqif3myY33Ffn4P5z7mP8hskLdp7gN0xesl/tN0xuG6agbGTut0zOOpvcb5mCa5nCb5mCdTaF3zIF62wKv2EKO2hKqgkLv2UK2zLV07Id2QtA6TdNYUdNTVVQAZOzghsMhd84RdcEmpywFn7rFBVX54XfOAU7bAq/cUqucUq/cUp22JR+45RdE2jSmpZ+65TssCn9xikN9zGl3zYlN2xKv2VKdt5cwsTZtgw5QSz9linZlin9linZlin9lqm6BtCa0l35bVN1LaBJQ175jVMppoIqv2kqzVVQ5TdN1TWAJo1k5bdN1TWBJid+ld86lZ2lkaO28punss1DzoEqWNqwzVP5zVN1jaDrp6a4KrBIv31qO3LIhUvtt0/NTQZqv3VqdjJQ+81Ts81T+81T24kaORhrv3nqnKug2m+dumArqPZbpy75CvJbp7azaPU0L68q36TWsPasuZrExeeCq0qXNBRlLZtLGora4UMOSZc2lGWtm0saihq2olzaUNaaOEM5Kpc2lOWbyqUNZUumZl3KULLiqxaWo4uar1poMMsKmJzyltmIMeCJG6QMMs7gZUgZZOziJ0PWIGNn2BnSBpYcMKTVy5A4yNhZdobcQcYPrQzZg4xbombIHmSsa8qAP8gUu0zNgELILFNgSHOeKWR42KVqBjxCZtkCpgqAScgUt17NgErIFEu8ZcAlZIqdRGTAJmSWNDCkn8qAUMgco0AuhTMgFTLHKpATxwx4hczSBznNngG1kFkCIW/tcTvHzaHGgFzILIeQ66emvlJKgSzScnaM0ZwXUAyZpRLynGTcgGbILJuQ06MMmIbM8gk53R2Ba8h4siEDtiGznALTHYFvyDTnxTLgGzLDuzEgHDJLLOR0HwPSIXOsA93HgHfILLtQLMh2MEinWsNI9zEgHzJLMRQM9wptZlmGgva7wEBklmgo6D4GJERmuQZ6CAMNkVm2oSAnuhkwEZllHOhuA2REZjkHkhHIgI7ILOlQ0J0cCInM8g4F3cmBk8gs9UBOvrIcSXDeOgIxkVn+oaC7I3ATmSMn6O4I9ERmSYiSNnlAUGSWhyjp7ggcRWa5iJLujsBTZAU3n8+AqMh4piIDqiKzhERJ93EgKzJLSZR0Hwe6IrOkREl33AK3LixjQXcx4Cwyy0yUdBcD1iKz5ERJdwYgLrKC38MA6iKzFAXjIoC+yEqWXMqAwMhKds4IBEZWsuuwDCiMzDIVJd3HgcXILFtBEkcZEBmZ5Ssq2jqXuOHUtUpFDwdgMzJLWlSKxgAtVvItBpRGVnFsUwaURlbx7QWcRlbxgwxojcyyFxU9yIDZyCp2/ykDaiOzBAZtxYHbyCyDUdHrN2A3MsthVPSaCPiNrOJXZcBwZJbHqOhRDhxHZpmMih7lwHJkLM2RAc+R1XyLAdORWUKjok0HkB1ZzbcYsB1ZzbcY8B2ZZTWqmtr0yYDxyCyvUdPDETiPzFIbdUa2LtAeWc2vzID5UJbeqBXVwRRQH8ryGzU5HBRwH2rBWUUFzIdasFZRAfOhLLtRk45MAfOhFixDpYD4UJbcoLdvgfdQlt2gx6MC5kMtWJpKAfOhFvx+LzAfyrIbNemgFTAfytIbNb17DtSHsgRHTQ5dBeSHsgxHTY4yBeyHyrjFtALyQ2Xs9q8C7kNZgqMm3aMC8kNl7KpMAfehMnabUQH5oVzsxGLxNDdXtUII0GaW48gWpC9VGEMRCKIYRVFY/mNBTkMVRlK4UIoFPXwxmIKlQBRGUyi+1TCcwvIc7bChEUCzKb7ZMKhC8c2GcRWW5qDX3QooEKXZ1bQCBkS56IoFPSqBAlEuwGLBBLVg/ItrNXpcAgmi2EALBRSI4kMtFDAgygVbLOjRDhSI0uyOvgIKRFmag56LKqBAlHajraaCmhSwIMqw62kFLIhi4y4UcCCKj7xQQIEowzs0YECUZTmyjFyfKqBAlOE9GjAgyrIcdDSLAgZEWZYjowPlFFAgyvIcGR0Dp4AEUZbooONfFJAgio3HUMCBqJy3j8CBKBeTQUbBKOBAVM63GlAgKnetRltSIEFUzrcakCAq5+chwIGoPDAPAQ5EWZ6DnmUq4EBUzk9EgAJRlubI6JBEBRyIskxHltEGEmgQVbBzR2BBVME3GpAgqnCNRltdYEFUwTcakCCq4BsNOBBVuJFG23IgQVTBM8QKSBDlSBA6uk8BDaJcCAc5LQUWRFmqg47uUUCDqJI3kMCDKBfJQcfvKWBCVOmCbmkTCVSIsnxHRgfnKSBDlCU8MkXbMmBDlGU8MkWPeaBDlIvuoGPlFPAhquTofQV0iKrYXTQFfIiypEdGh6MpYESUpT2ytp2L/KrOMDAVGq/igqUVMCLKMSKqpIuFlrPEB10sNFvlmq2ii4Vmc5wIWSxG5ro2q+lioc0cJ0IWC23mGBGSlFHAiCjLe2R6QVp1IEWUZT5ICMCJKMt7ZDqji4VGs8wHXSy0mAsB0TR1AKyIqrkwdwWciLK8R6Y1XSw0Ws2dQVBAiSjLe3B9HEgRveAOI2igRPQi4/u4Bk5EL7gm08CJaBcNQvdxDayIXnBNpoET0Y4Tofu4BlZEL7gm00CK6IVrMtLcaWBF9IINrdLAimhLfZCeSgMroi3zkWmS3NdAi2gXEKILqotp4EW0O0ZCx5dpIEZ05oYaE2YP7dYfJyG7pAZyRLsTJUxHA3pEZwETqYEf0Y4fYToFMCTaHS6hTZQGjkQ7joQ2PBo4Eu04EtqcaOBItMp4I6GBJdGOJdH0cQFgSbRi47A0cCTanTgx5MxEA02iLRdC92WgSbRio7Q1kCRacWFYGjgSrdi9aw0ciVZ1YCzh+RPNLrY1nkDR3GJb4wkUzc4l9egMCrsC0HgKRbv2ok9u4FEUza4ANB5GcQRJ17b1lR59GrSYZUGYT4Mm01wklsYTKZoNnNNAjmhHjtBBiRroEW3YyDkN/Ii2JEjWRRoSnQYYEm10wPIBR6JNYBqpgSPRjiNhLB+wJNqdU2EsH9Ak2tEkhh4VQJNoR5PQgXwaaBJt2A1RDSyJdqEiTC0DUaLzwHRSA1WicxWw1cCVaHeChbHVwJZox5YwthrYEu3YEqaWgS/ReRHoRsCY6LwMdCOgTHReBboRcCbanWxhuhGwJtqxJnR8owbWRBf8+APORBdu/NEzD6BNdBEaf0Cc6CI0/oA40UVo/AF1oovQ+APyRDvyhI501ECe6IJbF2igTrSjTvIFjQEaz/IjWZ49LfSV0pkvDOSJLkOzTGBPdMkfugT2RFuChHQLQJ1o/iCMBuJEl/zRS6BNtKNNcpI20UCbaEeb5PppUV/lNdYYtJqjTXLzNF+MAkk10CbahZF04TxU9ULDVfwsBZgTXbGzFKBNdMXPUoA00fwBGQ2siXasCR2dqoE10RU/SwHaRFtmhP4uaLOKn6IAaaIdaUKHx2ogTTRLmmggTXTtxhltzIA10Y41ocNTNbAm2nIjWUH7RCBOtCNO6ABVDcSJdtEkdISqBu5EO+6EDlHVwJ3omo0c10CeaEee0OGsGsgTXfMrcWBPtCVISJJbA3di+KM0BsgTs2BPPQNzYhZsBJAB6sQ46oQOvTVAnZgFGwJkgDsxCzYEyABzYhbcUDPAnJgFO9QM8CZmwS7gDPAmxpIjGR37a4A5MRlrGg3wJiZjo48NsCbGsSZFSZ59B9bE8GdpDHAmxnEmdKCwAc7EOM6EjhQ2wJmYjG00IExMxh6ONkCXGEeXlKS5MUCXGP46DgNkiWEv5DDAlBg+msQAT2L4SzkMsCTGsSR0rLQBnsQoNmLcAEti+rs5FDX9N8CTGBdOQl7kYYAoMXw0iQGmxCg2bMsAU2IcU8LBhTbjw0kMMCWGZUoMMCVG820GTIlxkSSlpmIoDHAlRvOGEZgSo7lT1AaIEqNZYssATWI0P8aAJjHajTH6YgpgSozmxxhe3uGYEjoU3uD9HYYfZniFh+F2tw3e4cEHkpjRJR62vehYfIMXefCBJAZv8jDs7rbBuzwM78vwNg/DMVsGr/MwLLNlgBsxjhuhjxgY4EZMzq6sDTAjJufvXAFexOTc0swAKWJy/tYVoESMo0To4xAGKBGT81evACFiHCFSkldTGCBETM7GixugQ0zO7Wcb4EJMwe5nG2BCjGNCKpJrN8CFmIJdTBtgQoy78oPs38CDGMeDVBlZX8CDmII9+mSABTEFO/EACsQUvFEEAsS4mz8qcjVigAMx/BkaAwyIcQxIRa7nDTAgxjEgFW2ZgQExjgGpaHMLHIhxEST0oQQDNIhxEST0qQQDRIhxESQVebWLASrElPxoAyLElNxOjQEWxJT8UAMOxJS8dQQGxDgGpKLnwsCBmIq3jkCCmIq97tAACWIqfpoPJIhxJEhND3cgQUzFTkCAAzEVu5I2QIIYy3RkNT3DBRrE8NeFGCBBTMWupA2wIKbmJ4zAgRj2LI0BAsTwZ2kM0B/G0R81bUOA/jD8YRoD5IepedsI1IepWdsIzIepedsIvIdxvEdN2zBgPkzN20ZgPvIFf6UY3Cm2YGeLOTAfOc985MB85I75oI/H5MB85DzzkQPzkS/420WB+chZ5iMH5iNf8DeMAfORu4gR+shLDtxHvuCvGQPmI7f0Bh0knQP1kTvqgwxlzoH7yNlLRHIgPnKe+MiB+Mgtt0GHMufAe+T8QZocWI/cRYrQR4RyID5yFylCryBzoD7yLDDKcqA+ckd90F43B/Ijd5EiNKmSA/+Ru0gRepsgBwYkd5Ei9CGoHDiQnI8UyYEByV2kCFNxwIHkjgNhKg44kNxxIEzFAQmSOxKEqzhoP1WFKg7aj7+vNAcaJNeslQQWJNf81YtAg+TuSE1NVwMQIbkO3L8IDcceqMmBBck1bySBBsk1OwvJgQbJ3Y0i9EG3HIiQXLOzkBxokNzdYepOrxmF5UKLGbbFgAXJeRYkBxYkN7xfAxokd3eZ0qfnciBCcsP7NaBBcnehKVMJQITkLlaEJrRzoEJyw032c2BCcsNO9nOgQnKeCsnxbtPceTZy5pbjBac8FZLjFafuPA1TY3jLqQsSYWoMbzrN2YE2uuqUH2h422nODzS879TyHYo+HJnjnafu0tOFIS00Xnuau6GWUzEDOTAiecFuxuTAiOTsrSI50CF5wRJYOdAhOX+eJgc6JHdXoNKnGHOgQ3L+PE0OdEjOn6fJgQ/JizLQHYERyQuOc8yBDsn5y1BzoEPykmWwciBDcneWhj7ImQMZkvPhIDlQIXnJMlg5ECF5aQL1BURIzl6OmgMLkpf8rcLAguRl4F5haK/SDTKS9syBCMn5O0VyIEJyy3XQ9QU0SF5lgfoCIiR3RMiCDGbKgQrJK44ozoEJySs2hicHHiSv+Gk/ECG5ZTsUfe40Byokr9i9sxyIkNwRIXQobA5USG75Dm6iC2RIbhkPlZH3X+RAh+QsHZIDHZLzd6jmQIfk/C2qOZAhuWU8FH1KNgc6JHd3i9CnSXMgRPLaNRy9xgdOJLfEh8po1wOsSO5YETpSKwdWJHfxIBkZQJgDL1IsWKdWADFSsBEhBfAixYJtuAJ4kYK/YKQAVqRYuIajrwAHXqTgbxgpgBcpWF6kAF6k4CNCCuBFCj4ipABWpFi49iKNaQG8SMFHhBRAixR8REgBrEhhuQ+myxRAjBSW/WBGewHUSJGxJrIAZqTIOKdWADFSZPxbOUCLFJkbZuQirQBapMj4K9mBFCkyd3yevugdSJFCubcmyEVSAaRIYXkPKhKvAEaksKSH6oivMXNRACNSWNpD0WdkC+BECkt7KPqMbAGcSMHfs1oAI1JY0kPRJ18LYEQK93CLIiexBTAihbtmhHkfABiRQrnGo0cccCKFdo1H9yCgRQrLfSjm/n8gRgrNcZEFsCIFf5CmAFak0I6LpPsaECMFf5CmAGKk0OzUvwBipND8XWcF8CKFe9qFvpa/AGakcMwIfY9+AcxIwd+3WgA1UrA3jRTAjBQ8M1IAM1L0r7zQYwiYkYJnRgpgRgrHjNAnwApgRgrDTv8L4EUKlhcpgBcp+KtWC+BFCnfLCP1UQAHMSMHftVoAL1Lw94wUwIsUOTvKgBQp+FtGCqBECvf6C33wtABWpOBvGSmAFSlciAgd91EAL1Lk/HQEWJEi5xbYBVAiRc4yWQW+BWNZD0UfqC3wQRj+uEyBT8K4EBE6mKPAZ2H4IJEC34Up+LkIPgxTsHOR0cMw/FwEn4ZxlAh91rXA12ECz8Pg+zCW+FD0WdcCWJGi5M0isCJFyZpFoESKkjeLQIkUjhKhD3oWQIoUjhRpl6zEuqcAUqRw0SH0CZUCeJHCkh/KkA/IFcCMFCW7yC6AGSlKdqABLVLwj8cUQIsU/N0iBdAihaNFDO11gBYpKpbJKoAUKfj4kAJYkaLi6OICSJGCJ0UKIEUKR4oYeuYIpEjBkyIFkCJFxV5PVwAlUlR8gwEhUtTsM1nAhhQ1u49WAB1SWM5D0edWCyBEiprdRyuAEClq9iWzAuiQwjIe9D2nBbAhhWNDDBkCXgAbUtS8KwMupKjZEQZESFHzrgxokNJyHYo+oVkCEVIuWFdWAhNS8kxICUxIuXCGkfQOJXAhpeNC6OciSuBCygX7lBZQIeWCf0wLuJDSEh6KfoSiBDak5O8VKYENKR0bkpPHl0tgQ8qMdWYlsCFlxjmzEsiQMmOdWQlUSOmokJxckJRAhZQZO8cvgQopLeGhWldmqla4AmFoNBcmQvu9EviQ0vEheU5t/JXAh5TuylX6uGMJjEjJn5ApgQ8pHR/CfB7wIWUfJEJ/HlAipaNEmM8DSqR0lAh9QLIESqTkn7AtgRApVaj1gBIpVaj1gBIpVaj1gBIpHSVCH9QsgRIpFd96QIiUOtR6QIiUOtR6QIiUOtR6wImU2rUebS+BFSn5IzMlcCKlZs8SlsCJlDowiSyBFSk1t74ugRMpNRt3UAIjUvKXi5TAh5TuwduCPExfAiNS8peLlECJlOyRmRIYkdKwc8gS+JCSf/i2BD6kdHwIfRC4BD6k5F+/LYEPKU1orAElUprA6fgSSJHSkSIFuaopgRQpXbhIQW79lECLlO4JGpoRLoEYKd2tIgxm4EbKXAdqA9iR0rEjzAcCO1LmeegDof0cP0LfCFECP1K6QzTcB0ILurgR7gOhBfNQCwJNUhahFgSapCzcrZ7k+q0EoqS0XIiij1OXQJSUjiihDx6XQJWULoCEfnWoBLKkdM/o0ud+S+BLShdCQp/7LYExKQt2IVcCX1IW7EKuBL6kLAIBdiW+qWtJEVUuyCGFD+u6OBL66G2Jj+taZkTR7xSV+L6uO1RD325S4hu7jjahHyAq8Z1dy4wo+ohmiY/tOtqEPndZjh7ctRaUPvdY4pu7LqSEPiFY4ru7liBRZUXXBrSgCyqhOdUS+JPS8Sf0WbYS+JPShZXQz/CUwKCUliZRlXqa6ytTQxcFDqW0TImqyHuZSqBRSvdkTWUnZLqCCRkQKaUjUqqchgEtaNkSRR/lKoFKKR2VQh/lKoFMKd1RG/oxmBLolNLFl1TkDfMlMCqlpU0UfTypBE6ldJwKfZKoBE6ltMSJos/clMCqlOxdrSWQKqWLMaGfbimBVSnZu1pLoFRKd90IfRqwBFKltNSJoo+nlMCrlC7AhD7zUQKzUjlmpS6eFosrtfA7ZwXMSrVwbUe/Fw3cSrVwbUc/GQ3sSuXYFTpYuwJ2pbIEil6QXagCdqWyHIqmI6ArIFgq9t7WCviVylIoekFeX1ABv1JZEkXTEbIVMCyVJVE0/dJHBQxLZWkUTT+eUQHHUlkmRS8Kag5VAc1SWS5F0zGXFRAtleVSNB1wWAHRUjmihZ73VUC1VD3VQs77KqBaqqzg530VUC2Vo1roeV8FVEuVBcKWK6Baqsy1IOnRKiBbKsun6Ix8YqACsqWyfIrOyJsGKyBbKhW4r6kCsqWyfIqmw+4qIFsqy6hoOuyuArqlUuz2agVkS6XYIIYKqJZKlYG+DFRLZdkUnZFPPlRAtVSKO4NfAdNS8beSVMCzVNo1HD1OgWep+ItJKmBZKu2ajZwBVMCyVDzLUgHLUvEsSwUsS2WJFJ2VpAcBlqWyXIrOKupphgqIlkq7ZqOdAlAtlWa3fyqgWirLpmg6OKwCqqWyfIqmg8MqIFsqlmypgGyp+PtJKiBbKsuoaPqthQroloq/n6QCsqWyjIpW5CS2ArqlsoyKVoZa2VdAt1SWUdGqncS2razx86DhLKOi6TiyCuiWKndNR3sloFuq3DVdRZpWoFsqy6hoRRttoFsqy6hoOo6sArqlsoyKpq+HrYBuqSyjounrYSugWypHt9APqVVAt1SWUdGaZEMroFsqy6hoTVtMoFsqy6hoTcZKV0C3VMUi0DeAbqkso6J1QbpdoFsqR7fQga8V0C2Vo1vokNoK6Jaqp1tIWqsCuqUqXAvSXRTolqpgCc8KyJbKhaeQJhnIlqqoAj0O6JaqcK1HjxKgWyrLqHDdE+iWyt1hwnRPoFsqy6hw3RPolqrUge4JdEtVmkD3BLqlsowK1z2Bbqkso8J1T6BbKke3MN0T6JbK0S1M9wS6pXJ0C9M9gW6pKteCtFMFuqWyjIo29OQU6JbKMiqaDh2qgG6pLKOiDe3UgG6pLKOi6YvXK6BbKsuoaDrEpgK6pbKMiqbjViqgWyrLqGg6wqMCuqWyjIqmL6uugG6pLKOi6fiGCuiWyjIqmo5EqIBuqSyjoulIhArolqpWgRkB0C1VrQOdH+iWqjahkqEF6zzgioFxqVjGpQLGparLwHQAGJeKfR2nArqlquuAsQW6pebP89RAttTseZ4amJaaj2KpgWep+fM8NbAstWNZaEq7BpaldiwLbShqYFlqlmWpgWWpHctC35ddA8tSO5aFjvaogWWpHcuSk1aiBpaldixLTlqJGliW2rEsdFRGDSxLnXHPGtVAsdSOYsnJeK0aKJY6c21HLrNqoFhqy6K0dZznIzqmBoalztimA3qlzlzTkYO4BnqltgyKLujuA/RK7egVeke5BnqlVtxzVDVwK7XjVpgKBm6ltvSJpm+sroFbqfnbTmpgVmrFBvvVwKvUKjBTqYFZqS19ogvyDpwauJVasdF+NTArtSVPmL4DxEqt6kCPAG6ltgQK1yOAXanZO19roFZqnlqpgVqpHbVCb/XWQK3UPLVSA7VS61C7AblSO3KlIE+T1ECu1I5cKYqnedF6ZBj1QK7U7mQPvStVA7lSazfk6LEB9ErtTvbop6a+Ukr5ssCu1I5dofema2BXasPGQ9dAr9SGPXZQA71SO3qF3vGugV6pTajxgGCpHcHS7U2PZ0g1ECy1I1jovekaCJbaESwlSXTXQLDUjmApSaK7BoKlthwKM6CBX6ldOAu9ZVoDv1K7+0+Y/gb8Su34ldJQ7G4N/Ert+JUyJ78P+JXahbPQ+6s18Ct17hqQnOLWwK/U7rgP3e2BXqkdvVKWHYpFgcLQfo5eoS+xrYFeqR29UtK9GeiV2tEr9G56DfRKbRkUhrqtgV6pCx0wRUCv1AW3F1sDt1IXga30GriVumDnKkCt1EUZMG9ArtTs+zg1MCu1uwyF7hFArNQlO08BVqUuXaPRhgJYldqxKvRdtjWwKrVjVRirAqxKXbKNBpRK7SgVZjADpVI7SoUZGUCp1I5SYQwQUCp1GXJ4QKnUjlJhzARQKnUVsJnAqNSWNGH6BBAqtSNUGMMNhErtCBXGCgKhUjtChTFsQKjUjlCp6HUVECq1I1Toe4trIFRqR6jQ9xbXQKjUjlChg11qIFRqR6jQwS41ECp1zS/KgU6pHZ1SVWRfBjqldnRKFxdDCUP7OTqFjoupgU6p+RtjayBTakem1Bl1rUwNZEptKRNdk/RuDXxKXbOEdA1sSl27pTntO4BQqR2hwjgaIFSyBf9mTp/mCdvmq0kaqk/1xLntvD7Jk2WZlT7NE7bjj47n6VM9cdeG5DjpUz1xzvH1SZ6sHYI1+U59n+qJ24asyYvp+lRP3DZlTVJufepQ3N2esqAavk/0pF1jklOdPtUTZ1cPfZonzK4f+jRP2JGb5KKgT/XEbWvSa/E+1RNn7wjo0zzhkndyfaonbg/rLchVdp/qidvQiEVGuY0+dSiueL/YJ3rSvGfsEz1pfmgqbEwVGJoKG9O9uEPf/9ineuL28B4d2tWneuL2MiM6uKtP9cTZAOs+zROueN/Up3riNe+d+tShuLt7lo4061M9cRdqTcZl96meuAqZIY0t6q6hZQyFxibVJmS0NDapI2g4o6WxSR1FQ28v9qmeeHCEamxUza02+iRPtg6NZo0targlR5/kyWahkW+wOQ1Ha/dJnqwOWAmDbWm4ZUef5MnmAYtisB0N7zUNNqK7jIW+wLNP9cTZ87V9mifMvnLQpw2FXTwMHXzVp3riWaiv5tiMLiaGXrn1qZ64vZlxUdLDMsemdLxN/dQUV8WoDnNszNwZ2orugTm2Zu4Mbc2IY4NagsZkJFXXp3ri1m9mzHDIsUndsz4ZubDuU4filqYxGbnu61M9cTs26XsN+1RPPDAPKrBJHY/D9a8Cm7QIhFr0qZ64bdOMvIqqT/XEi0CHKbBJC9ekzBgtsEn5C136NE84MEYLbM4+ZoaplBKb013r0r3NR61RSmzOkt387dM8Ye7u1D7Jk2XPePZpnrBrSZKj7FM9cTbsqU/zhNl1Zp/mCVehDltiQ5aB0LU+dSheLUJtU2FTuvAZeu3dp3rigaassCnZa3D7JE820JQVNqV7EoiOuu1TPfFAU1bYlI7w4aq7wsasqmB1Y2PyN8D0aUNh9g6YPsmTZW+B6dM8YbsyoaOL+1RPnN0c7tM8YRd4T1Ijfaonzl792Kd5wtw9q32SJ8veRd2necK2FekI6j7VE6/ZeRiSP5kleLiZfYb0T+ZCauhI6j7VE3ctSa/tMmSAsgXfkhkyQNmC3ejv0zxhuyKh6bM+1RMvAr0kQwoo46/N7dM8YUcA0QxahgRQ1hNAJKHYpw7FM3ZQZkj/ZBk/KDMkfzL3rhB9Y2qf6okHmhLpn4y/Q7dP84S5y376JE+Wve6nT/OE7XSHvru1T/XE+elOhrxP5iJu6FCwPnUornhKNkPaJ1Nc7Eaf5Mmy0Rt9midsHSR9rqBP9cRZSr1P84TzUIUg65MpnsLLkPPJlGtIcuuiT/XEnXWlZ14Zsj6ZO91EX5fbpw7F2ReH+iRPNjAgkfDJ3OW69AmKPtUTDwxI5HsyHYhc7FM9cd5LZsj2ZJr1khlSPRn/EHOf5gnbdqQvBu5TPXH2QqA+bShs2Hcb+jRP2A5I+srfPtUT5yetGXI9mWEnrRkyPRl/x0yf5glbs0pfPdyneuL8pDVDsicz/PojQ6onM6H1R4ZkT2aClhXpnszRPcyCIkO6J+Ov4e3TPGGWUc+Q6cn4q3j7NE/YMur0Tct9qifumpJxZEj0ZDlL22XI8mSO5dE0y5why5M5lkfTy48MWZ4sD1yN16cOxQuWfs2Q4skcxUNf5duneuLOuDJGHkmezNI4hg7e7lM9cdue9DmPPtUTZ08k9mmeMHsCuE/zhG1z0mdI+lRPvAp+JjYn/5RRnzYULnk/iQRPVgb8JNI7maVwDH30pU/1xAN+EhmerAztW2bI8WQujoeORe1TPXEXukqGgPWpnnhoXyRDnidzLz3T3H6GNE9miRxDnwnqU4fijuahTwX1qZ449yREn+TJuvYkI2/6VE/cDc2SEccWdXf70ueI+lRP3O10MctnpHoyS+cY+uBRn+qJ85uXGVI9GX/Rb5/mCdehjotUT+aoHvoMVJ/qibuYZHp/PkO+J+OfQerTPOHAZleGdE/mrv7lxgTSPZmldExOXszep3ribouE3sTIkPPJLK9jcvLGkz7VE7fWNifPc/apnrgdoTl5wUafOhBXCz7GvE/0pNk1pkLSR/GPRvdpnrAdnvTBoD7VE7fDkz4a1Kd64q49ybDUPtUTt+1JXyjap3rirj3p0ayQ+FGW2jH0bSJ9qifOr08U0j6Kp30U0j4q4+e0Cmkfxd8V3Kd5wrYxC3o8KKR9lIv6YfybQuJHWXaHdBIKiR/l7rFhxr1C6kdZcocpGpsxC/hNhcSPylguViHroyyzY+gjUX2qJ27HZEFPbBRSP8rF+9CncfpUT5yfBymkfpS7zoYJnFFI/ihH/jCBMwrJH+VCfuhbIPtUT9wOy65bVVfFYoQd2zNwAKtP9KT59kTqR7l7hLlOiOyP0uwkSCH5oxz5wzgqheSPsgQPUzS2pXt1mnFqCrkfpflRidSPctQP4wAVsj9K86MSyR+lQ85SIfmjNN+MyP0o9wI141gVsj/K8M2I1I9y1A9jS5D7UYZvReR+lOV3DH2/aZ/qifNLTIXcjzL8ElMh96NMcDQi+6OMc5LkW+p9qifudkdoOkch+6NynldXyP2onJ/zIPWj8oCbRO5HuSgf+rxcn+qJ87y6Qu5HOe6Hq27kfpQL8uGqG+kfxT/I1Kd5wtw7Fn2SJ8te892nDYVddE9Jr0YUUj/KUT9clSD1oxz1w01ikPpRjvopM5KuVEj9KEf9cJNApH6Ui+8pGYuJ5I+yBI+h78XtUz1xfn2pkPxR/P3DfZonXAfrHFvUkT9cnSP/o1yAD1fnyAApxwBxdY4MkHIhPlydIwekHAfEmSDkgFTJ75UoZIBU6dqTmbMhA6RK7gb+PsmTZd+469M8Yduc9K3IfepQ3N2Qw+y2K2R/VBUcoEgAqSpwjLJP9cRdczJLRiSAVBWwtkj/qIq95K9P84SL4GdiY7pIH65fIf2j3OEuJk5AIQGkHAHENhG2qLsxh6tzJIBUHVhiIv2j3CEvJiBCIQGkanYHTCH9o2p+B0wh+aMc+UNf0N2neuL8DphC6kfxJ736NE+4CnUUJH6UI34444nEj16EdsA0Mj96wTelRupHu3gf+qB1n+qJs02pkfnRC74pNfI+2vE+9BnuPtUT55tSI+ujF3xTauR89CLUlBo5H72oA9MxjayPzoJNicSPDhA/GokfnbGbmRp5H53xm5kaWR9teR1DH5nvUz1xuzKhr8DrUz1xa2Qr8i6pPtUTtx6zon29Ru5HZ6G9aY3kj3bkD01zaKR/tKN/6FPCfaonzr5g06d5worvtEj9aEf9cFWO5I925724KkfyR7vzXlyVI/mjVeBy3D7VEy8DVY7cj1bsQ0R9midsByd9MLtPHYq7wB/6aHaf6onbSVBFb2tpJIA0+7R2n+TJBoYn0j/a0T/0ue8+1RN3rclYfGSAtGZjDTTSP9pyPGw3RAZI69DBWo0MkHZHvSrGRSAJpB0JRB8u71M9cZYE0kgCaXcpD30UTyMJpF0AUE0zfxp5IO14oJoZbcgDaRcFRD/V0Kd64gHHiUyQDkQBaeSBdOgC5D7VE7etyRwH18gD6XwRqkRkgnQe2s/USAbpnN/P1EgG6Tywn6mRC9J5aD9TIxukHRtU0wEHGtkgbfkeZgmhkQzSLhaIOXGqkQ7Sjg6q6b04jYyQdie+mDOkGjkhXbAbYBoJIV3w4SMa6SDt6CDmjLxGOkgX/LaJRjJIF3wIu0YqSFuyh/NsyARpy/XQD9n2iZ40z+tpJIJ0wfJ6GnkgXfC8nkYWSLuXu+lXSfpUTzwLGXxkgbRjgZizlRpZIF0GDkhrJIG0pXly+o2UPtUTtyQQc0ReIw2kHQ3EGXGkgbTlenLmRL1GJkhbtof9UmxR96o3c/5eIxWk3c0+i5y6WblP9cQDk1okgnTFz4GQBdL88959miccWGsiB6Sr0LhEEkhbmocz98gB6YrdAdNIAOkqcDtTn+qJsztgGtkf7cJ/ODeC7I+u+ckPkj/a0jucy0HuR9fsDphG7kfXJuSekP3RNbuPqZH60S7uh3NlSP7omm9F5H604344t4fcj+aPemkkfoyL+GGO3Bskfgz/CHif5gnz60uDtI+x3A4zYgwSP2ZhAhbEIPVjFs600m1jkPoxlt7JF3R9GyR/jDvptaBnAwbpH9Of9aIJGoP0j1nwAbMGyR/Dh/wYZH5M4KSXQebHWHonz2g3bJD8MZbgYWsQ6R/jznpltKc0SP+YjN+YNkj+mMxdnUaHoRgkf4y7YJnriEj+GBf4Qz/w1Kd64nz8lkHux7hLlhkkSP0Yd9EP/XpUn+qJq1AvRPrHKN5VGiR/jHLNSU8HDJI/RrGH9wwyP0bxh/cM8j7G3bhMPw/Vp3ri/OE9g8SPcff80C9l9alDcXfxMtcLkfgx7mErru2R+DHajU7GiiP3YwLHvgxyP0bz6xGDzI8JHPoyyPsYS+7kzDl0g9SPcfcw0/dUGGR+jGYXJAZpH8O/J96nDYXdPczMnQwGSR/Dvynep3nCrh1r2q0h7WP6O34Yo4y0j7HETs6cGDdI+xh3KTPXZZH2Me5aZq7LIvFjLLmTM4fGDVI/xriAPMa6IfVjXAgQ/ZJNnzoUz4OjE6kfk7NzWYO8j8kDt1X2qZ44O5k1yPuY3LUnY2aR9zF5wGsi62Py4NhE2sfkobGJrI/hg4AMUj4mD0x/kPAxltVhBjIyPsayOjlztNsg52MCF/wYZHyMZXXYgYycj3Gcj2Hmp8j6mCI4MpH2MUVwZCLvYxzvw5zwNsj8mMKNTHpvwCD5Ywp2cWKQ+zFl4OJKg9SPCVI/Bqkf4274YU54G6R+TOAImEHmx5QBn4m8jwm9jdWneuKBNyf6VE+cZ/EMsj4mdJlzn+qJ27FJvyjUpw7FHe2j6ZOCBmkf4+50plkRg7yPqQJRswaZH8Nf82OQ+DEB4scg8WPc2S9mZ9Ig82Oq0JEEg9SP4akfg9SPqapQ4yD1Y3jqxyD1Y+pgQyL1Y3jqxyD1Y9yxL6bRkfoxPPVjkPoxltzhOggyP4ZnfgwyP8ZyOzlzx4BB5sfUoS1Mg+SPqd3REpoNM0j+mDoQXmCQ/skXoYsOc6R/chf3o+morBwJoNySPMx+Q44MUG5Jnpw50J4jBZQv+Ji8HAmgfMHH5OVI/+Qu8odpoBzpn9zRP0wD5Uj/5JbgYRooR/Yndzf9sA2E7ZktQg2EFFBuaR6ugZADyrMQZZAjB5RnPGWQIwOUuwAgyiDnSP/kluKhDXKO9E/u7nlm7j3Ikf7JMz76OUfyJw9G/uRI/uTZ/2fsbpdku430UN+LfjMYhY/MRPoOzjU4HApae4+GMRIpk1sTnuM49366kFm1Gy/xpuwfVg2RXbt74WNhPQsJeFk5WJfFfj+C+iN8vx9B+pFivx9B+JGAn3GfDQrSjwT9EGkVpB/psZfsffIoqD/S+dICQf2ROMuczJIF9Udyn2fSMdF/pEdl3qePgv4jgx6GkGVHcAyzd1AW1B/JXZ6vD1+C+CODTn0E7UcG34NL0H4k7IdsBCGoPxL6M+/LLQT1RzbwyLy/7hTkH9nGI/Oe+iUoQFIIkKAASQgQ2fZAUICkECBBAZJZ1SUCkMw4vfC+AlsQgGRW+xwKApBM6rKC+iOT78UlaD8y+Q5OgvIjIT9k1whB+ZHJhV3QfSRSv4hyCLqPxMY/z10mbvdLpB+JJT/3s2qz9AjnT5iC9iNhP2RLCkH7kVjzQ5JjBPVHQn/IlhSC+iNCU0wE7UeEr64UxB8J/CFbTAjyjxT8I8g/Evwj91m7IP/IJh65n5mapUf4Punicc8PFQQg2cQjJFNVEIBEqx1GBAFINvHI/VTWLD3CizkQ8o/whT+C9iPF3j+C+CNWVCbaj1hUJhkk0H4k7IfsGCFoP7J956Mpk3CszFj3I/cF+4L+I7Huh+wYIeg/Ylp+O1bmNp6Poe8HefzxiVpQgCQ2AFLS41CAJATofmhsln4ODwEimxkICpAUC38EAUhWdedEAJKtPO1jOnF9lkEDksUfT5CAZPF3YIIAJIu/zxTkH9nGI2RzB0EBksj+etwFSFCAJLK/Gpm/IQJJIBBrh4hAsqWHtkN0IAkHYgMiQpDkMV9kQEQLkrAgsu2FIAaJ8zcnghokfMNnQQoS5zgrCEHiPDlTkIHEo2OSAREdSMv8L0UH0gcVPUUE0jhGXe9jraICabHds6IBabHds6IBaR73dR0gFBFIH7QaFQVIi62eFf1HH7waFflHY/EP2bFBkX+08adMRfzRyPzS+/Oxov5orAAiGxQo6o/GwerkaiP/KOcfRf7RxsdXRf7RYrNnRfzRDTxC9hBQ5B8tNntWxB8N/CGPu4r4o50u5FK0H+08hU8Rf7THQ8l9lFfkHw3+IY/divyjwT/ksVuRf7RzyVPEH43tnu9HOWfpEc5nsYr4o5t3+rwfJaOIP9r5RFaRfpRv9qwoP1ps9qzoPhqrfuw+m1KEHy1W/SjKj47iFCFF+tFBpUDRfXRwKVBUHy32elY0Hw3zIRtdKJqPFns9K5qPzkdxPZB8dFKNVRQfLXZ6VgQfnTxrT5F7NNb7kI0iFLlH41wvsp+DovhoiA/ZQkHRfDTW+5BEekX10eJsL0Xz0eJsL0Xz0WK7H0XxUb7djyL3aLHdjyL2aGR4kZdGityjxXY/itijwnsjSo9K0RvReVSK3ojQowE9JO1fkXpUit6I0KPKd15XhB6N49jJ+gpF6NE4kP15xOLtVoDQo8rfcikyjwbzkC0IFJlHN+QIyYpXZB4N5rkfYZ6lR/jukfdDzLP0CKfQowg9WmR4KUKP5kFepCsg9Wge5HU/3UyRetTomYmKzqPhPCTZXtF51IpOicqjxt9AKxqPxkFeRCcUjUe34rADBRWNR8N4SM66ovFo7PNDcuQUjUdXdadE4tHY5oecP6iIPBrZXeT8QUXl0VjmQ84fVFQeDeUh5w8qQo/mkV5k0ojUo7HVDzl/UBF7NLCHbBWgiD26ihsmUo9uzKHtC6lHI9WLdTmkHo2dnkkLQOnRkJ77AfRZeoQXs1h0HvXCB1B5NLb6Ye0cnUfjUHd2W0Hq0aAesoWCIvZorPohWygoco8G95CNCxS5xyLri2xcYMg99qg6qaH42KMXw5Gh+Fhs+EP6tKH5WOz2TPq0ofrYo+qkhuxjj6qTGsqPxW7PZMQwtB/bvvMRR677wnA+JzK0H4t9f0h7NNQfa9Vt1FB/LPTH75MFQ/2x4qQvQ/yxwB/S8Qz9x1rheIYAZLH3D2u7SEDWqlupIQFZnvRO2i4ikMVJ76ztIgJZIBBrXehAFmuAWFNHCbLY+5k1dZQgCwkiu4AYSpAVB38ZOpD1qkoRgiy2fmZNFyHIIguMbANiSEEW64DImgpDCrJebWppiEE2qtR3Qw+y2ACInGthKEIWGwCRcy0MRchiKRDreGhCFquB/D4jMUQhG/ytiaEK2eDbBxuqkEUmGKsidCEb1X5rhi5kw8sqwhqNTYBYFSENWdAQqyLUIZvVBhWGPmSTP40a+pBNiu6GOGSTS60hDVnQkN+ndIY0ZDOq835alyENWZ4FRmofccg2AInbda5ryEMWPOT3iZchEJnwV9SGQmTCE+INhchkVFcFhcikWttlaES2IYheFWQiK5jIkImMLwcyVCIT/jbM0IgslgORbXcMlchiORDZOsbQiUyLqkQlMi2qEo3ItKxKVCJTvurS0IhMKfYZApEpfxlmyEO2AUjJlv+GPGTFQe+GPmTFQe+GPmSxEIjsi2PoQxbngJGNbgx9yDYCKdm6xpCIbCPQx02EhGNVxmnvj/t+I4ZIZBuC9HF/SDRkItsQpA8yViETmUWNku6DTGSxGTTZ8sGQiWxDkJI9HAyZyBZ/VW2oRLZa1RZRiaw48d3QiIynghkCkRWpYIY8ZBuAtN1fnRrykMVKIDYdRx4yngpmaEO2oiZJG0cdslU8dqIN2dYf+leiDVmxCbQhDZnTvZwMXcicvxkzdCGLLaDbfe8iQxmyYv2PoQsZX/9jiEJWrP8xJCEr1v8YgpB59EYy8CAIrQfvjQs5aPFzvxZa0HrwrrhQgtaD1+FCB1qx93O7j5ULHWg9ojfex8qFDrSK3Z8XKtAKBSKT9IUKtGIFULujwUIFWlt6lOzysNCB1pYeJbs8LHSgFbsAkX0YFjrQiqO/yD4MCx1oxSbQZIuChRK0tvUoSclfKEGr2AdoIQStWAlE0toXQtDa1KMkrX0hBK3Gl7UvZKDVokZJW0QGWnwt0EIDWp0vIFkoQCsSwcip5QsFaBWnfy30n7WNR0mO8EIBWp2/HlsIQCu2f75z0UL/WVt4dNy3ol7oP6tXOfAL/Wdt4emr/yDjx+l/+NWxLvP4L7mHo/+szAS7Ji0v5J8ViWBmzy9/6B/CsT5jC+hxv3Uv5J81okbva7sW8s/axKPPLViu4VinG3mU5GkuJKAVC4PImdMLCWht5NFxT0tcSEAr0sHGffuyhQS0NvLouC+0XkhAayOPkiV4CwlobeRRsnJwIQGtWCJEVuwtRKAV58GTFXsLHWiFA5Hct4UStIq9oBc60Cr2gl6oQGs7D/+9sUanVw0AFWjJo2peqEBrSw9tL+hAK1YKsfaCErTiWHjWXlCClsyqvaAELZGqvaAErUKCFkrQigVDJHdvIQatwKBJbtHIQSt2g77eF9GCVpEatlCCVuwFTRL3FlrQKnYGWmhBKyzoY0Z00+WFFrQ0KpNMFVCDlvK10Qs5aCl9UlmoQUv50q+FFrQ06pHMK1CDlvLnzYUatGK1ELt+qEErNIhkEC7UoGXF4wpa0DIqBwshaBmXg4UMtIKBSGriQgZaVgyyiEArEIjkMS5EoGXFvBYJaBnvkOg/axUdEv1nhf8IeepA/1mr6JDoP4v7z0L/WYvL7EL/WYu/MlmoPyv0h6RoLtSfVRwCv5B/VvAPSY5cyD9r8cXtC/lnOX82QftZXjyboP2sDTwq5A6M/LOKZUEL+Wc5ffG10H6WFyMq2s9yDuwL8Wd59ERyl0H+Wc6BfSH/rOAfIRMS5B9/BOLdPcwRgPxRcayjAXmc/S736Y6jAnkoEElBdXQgDwciKaiODuThQCQF1dGBfFvPIDM7RwnybT1KMjQdJchDgkgeoqMEeUgQSepzlCAPCSKZd44S5I2//3J0IG/8/ZejAnkoEMlic1Qgj92g73uAOSKQx25Aep8hOTKQBwORNDZHBvJgIJIS5shAvqlHSY6SIwR5QBDJ4HGEIN/aoyTBxdGCPCyI5H84apCHBpH8D0cN8i0+SvI/HD3Iw4NI/oejB3lkhpHsAUcR8mJjIEcQ8l5twOYIQt6jTv263MgRhDw2hibr8BxByAdPZXDkIB/87YmjBjk/DcyRgrw4DcwRgjwgiKQlOEKQF+uAHBnIg4HIewtHBvJgIDJLcGQgDwYiGRKODORFhpgjAvksKhIJyIOAyHl3jgTkQUDrjh2OBORBQOtOb44E5JPPah0ByPmmQI7645NPhxz1x2NTILLe3dF/PBLEWCdG//FZbdfu6D++hafHt88/fDv6j4f/PM/p+wj/w5+K/uPhP2xEQf/xWAnERhT0Hw//ISvNHf3Hi22hHfXHhS/Tc9Qf377DLyLWaOgPWfLuqD8ep8PTa441GgDErjkSkJdJY44E5MrdwJGAXOkTp6P/uHI3cNQf38Kji0y00X88lgP5/Qh0RwJypSsOHAXIQ4DIQndHAfJCgBwFyGM9EPsrUYDcinsm+o8bv2ci/7gV90z0Hw//IQ9kjgLkVnRK9B836niO/OPFdtCO+OPFcfCO+OOx/odkCDj6jxfrfxz9x8N/yGngjv7jxfofR/9x7j+O/uPF+h9H//HwH7Lu3FGAfBVTWPQfX1aNZihAvqqDMx0FyAsBchQg5wLkKEBeCJCjAHkIEFlu7ihA7tVeiI4G5GFAZFG4IwN5MBBZFO4IQR4QRM4Zc6QgDwpycstGCvKCghwpyJ2vtXSAoI979YNfxCw9whu/iFl6hHd+EbP0CB/8ImbpEU6nsVl2BLNpbBYdsXQam2VHcFTldRaTpUc4rcosO4JpVWbZ5+DQn/ti6Sw9wndVjutWmFl6hD8ry+5rq7P0CB87/DofyNIjvKjKhlUZAHRfOJmlRzi7W2bREUvfemXZEbz233i9AWbpEU7nPFn2OXjbjj2uN8AsPcKL+2WWHuFRmdfNKrP0CI/KvA7MWXqEF2ugs/QIl/3tV1fK0iNcd/h16MzSI9x2+LoPQR3rdOvObc6bRUds0Ts7Vuh4VL/HwAodbMO1LDpiN80+0+P+mG2QpUc4O0Mhi47YuX/r67QjS49wdohCFh2xux6fqZHXC4L1ONjDSBYdsbtjtus291l6hLOTMLLoc+yGHXumXN6+emI10hPgs+iI3Z2yXc95ydIjnFfjxGrcqGP39eBZeoTTh5EsO4K1atgT63G7jt2P6MvSI3xVbXtiVW7Xoe11Ym3Ko2qDgrW5XYe2K8EKlV61FcEK3a5D61+wTiXqlAybgnXK1SfLjmCqPll2BJcjrGCNSlmjgjUqZY0K1qiWNapYo1rWqGKNalmjijWqZY0q1mjQD7uJK9aoSnUTV6zTzTv38UKxSjU6KbnHKlapxnhLpsCKVbqBxxqZqCpW6QYeuy+Hz9IjfFfpfTl8lh7hu0rvy+Gz9Ainyw6y7AieVc8wrNDYMYj1DMMKNa16hmGdmlU9w7BOrbyHGtapedUzDOt0PaqesbBOV9Tp9T1olh7hdDlQlh3Bg491C2t0zarPLazRbT52z4bI0iOcilCWHcF08WyWHcGraokLa3ObD22JC2vTH1VLdKxNb1VLdKxN71VLdKxPH1VLdKxRn1VLdKxRjxol0xfHGvWiRh1rdLOP3RNWsvQI33V6T1jJ0iPcq6aLMNQeMerex/SGMNQe0UPvY3pDGGoP3kMbslB70D0OsuwIZku9suiIpQv2suwI3sPtuN+GGrJQe9AFe1l2BO+qvB8ol6VHOOXaLPscTE+Iz6IjlnJtlh3Bu1/es0my9Ajnd86GHtTo9tBZdMTSBXtZdgRz2muoQW2Lj437baehB7XwoDGvQ0lDD2rbfOyeAJOln8NDhO7ncmXpEU4Xd2XZERxVeR9KGnpQi7ywdQe4hh7UtvjY/eSsLD3Ci/pEDWqd4l5DCmqd415DCGo9KpMMaGhBrXPca2hBbcTqy2s+aJYe4XtsnWTkQQ5qkRT2NHr9+PaF4ViZ23xskrEHRailCN0fUhqKUBvFOURZeoTvQfaem5KlR3gsOLieupylR/h+9LyvT8jSI3x30Em6P9JQm/QFZ5YdwY3O3hrKUAsZYtccZaht/qHXHHGoBQ6xa4441DYA0WuOPNQ2ANFrjjzUYmsg1niRh9oGILtnp2XpER41SoZc5KEWPHRPT8rSIzz6KRlFkYda8NBczz/1gYMA6lALHbqn2GTpEb4r9Z4Gk6VHuFSXHX2oCbWEhjzUgofuuS1ZeoTvvbvWNXk3S49wL39xrNENQPdfHG2ohQ3JdZviLD3C2b7DWXTE7sq8H3aTpUf4rP5IhKGmVOEbqlDb9GP3NJQsPcLjcKnrxkZZeoTvl51yf9JrCEMtYEiu+/xl6efwyAxjlwVhqBm1+IYq1EKF7ueFZekRXsxtUYVaqBD7K1GF2nYfu2eNZOkRruVFwQoNFRIyN0MVasbfXjc0oRYmdE8DydLP4Yv3TQShFiCk15VsWXqE7+pUMqggCbXNPvQaIgq1QCE2UCAKtUChe0JKlh7hnBAaolBbVrUtZKEWLHTPXsnSI7wcbJGFWrDQPdklS4/w4okFUajFJtKNzEIQhZqXNYoo1LysUUShFih0T9PJ0iO8qFFEoeac+RqSUIsdg+6rzLP0CI8nUBYO9dkjaey+KD1Lj/Doo/cxtCMJ9SCh+/ruLD3CqxrtyEJ924/dM5Ky9Aiv5kMdbag/6HyoIwz1jT92T1/K0iN8FQ29Iw312EH6cV3O1dGGegtTuItFRx7qsWTovu1Rlh7hsTntdaPULD3C96TonqiVpUf4rtF7olaWHuH8/WdHJeqNv//sqEQ9lIhM5joqUY+MsXuuRpYe4dWcqKMS9V7kMWTpEb5rdJEqQifq4UT3bLcsPcL5tKijEvVOt+7PsiNYyj8T6zPWDLGLiFDUNwbxq4I1GlR0T+rL0iPcy2/HGh10WtRRinpI0T1fMEuP8D3kyi2hIguP6M0K5BqiE/UtQe3JBNcvxwqNlUP3lzYdmajH5tGP+/upjkzUNwTZPS8yS49wPsntiER98EVgHYmoBxGRC45G1GPnaHLBEYn67NUFRyTqsXyIXHA0or4ViF5wNKI+OeF2FKI+KeF25KHOD5LPsiM4+uV9WtYRh3rg0D2/NUs/h0uxL0mWHuHRNckEBHGoBw7d02Gz9Ajf9877OVNZeoTve+c9oTNLj/Di3ok21Iu1Qx1xqAcO3fMzs/QILzZSzNIjfNcomQ53xKEea4fup0Fl6RG+a/R+qlKWHuH8lWdHIOrKFyV05KGuUZuknSMPdS12As/SI3zXJ3n93lGIutJ8oyw7gncPXfeVwh19qCvbbiaLPsfy0+Sz7AiOqiSdE3WoW9w37++/OupQ3wJEzhrN0iM8qpN0ffShzjPHsuwI5mMt0lDnmWNZdgTTzLEsO4KjX5LRCmGox2Kh++FFWXqE78q8pyJm6RG+R9p7GluWHuF7pL2fipKlR/ishiC0ob4o3XaEob7xx+7pZll6hMe7svv6j4401ON4MdbGkYZ6rBhibRxpqAcN3VO9svQI5zTUkYY63UQ6i45YvrSkowp1p8mAWXYEbxO6H4mRpUf4NiFfV3HqqEI9VKjpffKBLtS3/HzcwUg4VmZkkLHZHrrQiKVC92S2LD3CeWUOVKHxoNvOZNkRPIqLONCERhwmTy7iQBMaW33YRRxoQuNRPaMMZKHBj5TPsiN43zdJztlAFBrbfYxkhg1UocFXDA0koVGsGBoIQmOTzyI5ZANBaBQrhgZy0OArhgZa0ChWDA20oFGsGBpoQWNrzyJpbwMtaMSB8vfnwYEUNOIwsfvz4EAJGtt62PPgQAka23poc0UJGj2q8n7XHChBo5CggRI0CgkaKEFjWw+7hAhBI5YLkUuIDjRy3yB2CbE2YyNpegmxOvmZ8ln2OTgU6H7ISZYe4WzH/iw6Yjtv4IhAI5LH7qenZOkRPnf4dZ+5LD3C9/SHpAIOZKCxoWeRVMCBDDQGX5I5EIFGnCF2v4JYk6OoSTSgMfmDyUACGpE/dj/wJUuPcP6MOVCAxuTPmAMBaMSWQeShcSAAjQKABgLQ4AA0EIBGAUADAWhs4ln382+y9Ajna/gG8s+IDaPvu9Fk6RG+K/J+EGSWHuF7eL2frZOlR3gxvCL+jM07q5GhG/FnbODhvzlWZiwNamSgQgAaUvRJ5J+xgWeRNMaB/DOk6JaIPyNWBpG8xIH4M5QPsCg/Q4sBFuVnbN1ZJK1voP0MpaduZtkRTPdAGMg+Q+m231l2BBe9EtFnaNQiGbURfQbfKijLPgdb9fproPuMLTtkk7AsPcKjV5LRGN1n0O2is+iI5RsgDCSfYWWXRPQZVsxgUX3Glp1FkvMGus+wVf4qWJlGU60Hss+I9UAk728g+4xVPFYi+ozIELNxH70RfUZsGTTvz5VoPmOrziIZiAPNZ4T5kAzEgewzVtExEX3GYiczZtERywlvoPeMLTqr3196D/Se4Xxt9EDtGVt06Hej9wynCy8Hes8ovGeg9wy6a3QWHbE8lWgg9ozNOYukBQ7EnuHFPRKpZwT1DDLjRuoZXtwjEXrmg8LAROWZDw4DE5VnbslZJKtuovPMB5/uTFSe+YjeeL+hTlSeuR1HnotWLo+IE5VnxsofkoQ3UXlmkRU2UXnmdpxFUvAmKs98RJe8j9wTlWduylnjPnJPhJ7ZeMLCROiZAT0kn20i9MyNOWvcR8CJ1DM59UyknllQz0TqmZtzFsn3mog9s9gsaCL1zK05a9z7/ETrmcVmQROpZ/aoStJ9kHpmpxskZtkRTDV9ovLMTjdIzLIjePdLks820Xlm56+5JjLP7FXSyUTnmeE8atdp4ETnmZ3SwETkmQXyTESeOTgNTCSeGTsEkZy9icozB6eBicozt+PQ64fKM2OtD7t+qDxz0MeQicQzB5/tTASeOYoOicAzR3RIMrqi8Uy+NXSWfQ6e/EaJxDNn0RsReObkj5ITgWfGEh+SwjiReObkj5ITgWfSXaGz6Igt6hCBZxbAMxF4ZgAPyYycCDyzAJ6JwDNjfc/1zMEsPKJjaex1ZexE3plC9yvNsiOYPkZOtJ0p/BXlRNmZITsk83Oi7Ezhy9Ynus7cdkOvHtbjpps2+1UXJ8LOpOeAZdHn2C035FKj6kwtJq3IOjMSviaZtSDsTC0mrcg6k58In2VHMO+LyDqTnwifZUfwtgCSADsRdmbADknGnAg7c+PNer6MuU1AkXbmxptFkjEn0s40zgETYWfSXaCz6Ijlj5ATWWfyU8Cy7AiO/kju6Mg6c9PNup8Ul6VH+F4y4HrNCp4IOzNgZ/rVPCbCztx60+1xBZWJtjPDdoQ8fKDtzO03S67nD2XpEb57Jknfmag7cwPOknt69UTemcE7ctegibwzg3dESDjW6iac9Tzg4hqOtRqnwst9F9eJxjO34yy5r5CYqDwzlEfIDAKVZxbKM1F5phcPlGg8M4xHrydiZukRvsdacjdG55kbc5aS1oXUMzfnLL0vdZqIPTOwR+8LqSZiz/SymyL3zA06TLAncs/cpLOUtF0EH9mqs/TedgXNR7brLL23XUH1kVCf52PD5coIqo9s2Vl6b7uC7iPhPnofwATdR7bsLLtnlAq6j4T72L3NCLqPbNtZJEVEUH6k2CRa0H2k2CRaUH1ku06706og+kicEHbvR4LqI9t1xrgntgiqj2zXGXa/Bwiqj3D1EVQfKdRHUH2kWOAjaD4SC3xIho2g+kgrKhLNR7brLJKmIqg+0vnMVtB8pNP3lYLkI50/ZAqaj2zXWSTJQlB9pPOHTEHzEX5GfJYdwdEj72vJBc1HOl9vJyg+wsVHUHxkqw67eliHsayHZIUImo+E+ZAps6D5yIhFWvd3AYLqI7G2h+ScCKqPjKIq0XyEm4+g+UhhPoLmI4X5CJqPhPmQNBlB85HCfATNR/hxYFl2BBenDWXpEb69gKy+EYQfmTH9uadSC8KPTD6yovtIsbBHEH6EHweWZUfwHllJTpIg/cgsRlaEH5nFLRLhRzKxi9QNyo/Eyh427iD9SEE/gvQj23cWSY8S1B8RXpGIPyL8haUg/Ugs6llk+oL4IxJVSW6SqD8Sy3pIIpWg/ogUvRL5Rzbx9I/fXMaPH5NtCEcAko08a5EBFglINvL0j998rh/HwgkSEpBEVtfHt99/GazODT39Yzy+rScVZCCJvK7xw/Qfe+8YjVUa20GTLGRBCpKgoGXX16KCFCRBQWuRb8cq3dgzPm6DHxfmoX/43bFSg4LWPQ1QkIIkNv7xx/13RwySWOXjZGqPHiTbfJb3a1qAoAjJVp/l98dBQROSMCG/Z5kKmpCECfl9ObSgCUks9vF7BoSgCUmYkJNGgCYksdiHZCkImpCECZEsBUETkq0+7EFZ0IQkTYg8m6IJSewKTTxL0IQkTYg8y6AJSZoQaWJoQpImdPcsQROSNKG7ZwmakKQJ3U1A0IQkTYiYAJqQeLAteQxHFZJY+0M8S9CFJFyIeJagC8mmHycJKIIwJF7McJGFxIuHFUQhSRQiDQBRSEoUEkQhKVFIEIWkRCFBFNIShRRRSEsUUkQhLVFIEYW0RCFFFNIShRRRSEsUUkQhDRQiMqiIQpoodG8EiiiksRyIQKIiC+mmHyepSIowpNt+nCT0KMqQNrqZnqIL6ZYfJ7krii6kLTrpfTqo6EK68Yf8Jlif236cPBArypDGNkCk2ynakG79cZK9omhDuv3HSfaKog5pi/q8300VdUh71Of9bqroQ1psF60IRLoRiF4XJCLdCMSGI0Ui0lgYRIYjRSTSLtVwhEykwURsOEIm0k1BdDhCKNI4PoyM64pWpN2r0Qu1SEOL2OiFWqShRWz0Qi3S0CI2eqEWaWoR+VNRizQywdjohV6kG4W83e/UimSkg69NUCQjHXxLPUUy0o1CjF4UyUg3CzE8UEQjndxwFdFIJzVcRTHSYqGQohfpFiEn2UaKXqQbhVjqkyIZ6YyqvG+BoIhGumHIySsKRTbSWa3dU2Qj3TTkJIVIEY60WDGkCEdapoQpwpFuGqLXBeFINw7R64J0pJESxq4L0pFyOlKkIxVugIp0pMINUBGOdNOQkyQsRThS4QaoyEYq3AAV2Ui1MkBFNtINQ/Ixjl8vNrKRlmykyEaabHR/nlNkIy3ZSJGNNFYPyX1fEEU30sgLuyuTIhupRoWSKRGykWr0TjIlQjbSDUNO8rEU2Ug3DDlJbVJkIy1WECmikRrfp0KRjHSjEG1dSEZqVe6tIhnpRiHv5LaPZKTG37YogpEazSdS1CIttgRStCLdGuQkZ0rRinRrEOMZRSvS0ooUrUjTiu6ao2hFmuuHyEwIrUjTiu6ao2hFmlZEej9akaYVkdkzWpGmFZHZM1qRphWR2TNakYYVEfxRtCINKyL4o2hFmlZEZs9oRbo1yEmenaIVqY9qkEYrUuePoUhFGlTEBnTEInW6u7CiFGlIERv8UYp0WxD5aqxM9+pGgUxkD7pvqaER2VYgclMxJCJ70IQ/Qx+yLUBOTg409CHbAsSAwNCHLLYEIsOQoQ/ZFiDv975p6EO2BchJVpyhD9kWICeJboY+ZJEuRp5sDX3IGq9OxCELHCJPwYY+ZI3XJ+KQRaoYeUg1xCHjOGSIQ9YC+9hvjZXZaK80lCGLVUPk4ddQhqzRXmnIQhYsRBIQDVnIOl+iaYhCFihEluUbspD1GGDv0zFDFrLOF1IbopB1+nxiKELW+attQw+yHn3yPik09CCLVDFyoomhB1l4EFmwY+hBtsXHyRmDhh5ko6hM1CDjWwIZUpANvkjBEIJs8Kw/QwayDT1OMkMNGchiQyAyEzNkIIsNgdjlRgiyjT1O8k4NKchiX+iPG6A8fvy4D2I4VuaIyiS3HqQgK44PM6Qg4xRkSEE2i8pECrJZVCZCkM2ozDumGEKQBQSx2x9CkG3qoaMPQpAFBN3ffBs6kMXyIbK1l6ED2Yzc6uuLb0MIsnIFkSEEWUAQSdk3hCALCCKJs4YQZMXeQIYMZMK3XjN0IJOyPlGCTMr6RAsyqeoTKcikrE/EIJOqPlGDrNQgQw0yLesTNci06J9oQba1x0nWr6EFmfLbJkKQaXHbRAayLT1OsmcNHciU73tgqEC2nYc0QjQg0wrcDQ3IjIO7oQCZ8VEWAciMg7shAFmsGSLpLIYAZMbXIRjyjxldaWtoP1bYj6H9mPGVtob4Yxt4nOQeG/KPGXd2Q/yxwB+iOYb4Y5t3SCqqof3YoqmAhvBjq5jBIvvY4qmAhuhjm3WcJDYboo/FGWFkwa8h+thmHQaKhuhjm3V83neAN0Qf26zj5DxRQ/SxzTpOkkwN0ceKraANyceCfMjGTYbkY7E7ELsuSD62XYdeF1Qf86jTO7UZqo9t2vF5pzZD+LFNOz7vdmYIP7Z1hzRdlB9zmm9tyD7rwfewWOg+a9OOkxTWhfCzilPjF8rPik2CyHRjofysR3XCyUL5WQ86yi5kn/Xgo+xC9FkPPsouJJ8V5EMOhV1IPuvBR9mF4LP4LtALwWe1VvSzheCzWpXOsNB8ViwIIv1sofmsNot+tpB9VqwJIv1sIfuspkU/Wyg/q/E0o4Xusxp/Y7IQflbADznhdyH8rAJ+FsLP6jw3dyH7rGAfcsDvQvZZvUpOWQg/KxLGyE59C+1n9WqT9oX6s2KjINnIr7IwHGuz09dfC+lndT7CLoSfFfAjd4lYCD+r2ChoIfysrTsu9xvsQvtZo9oacaH+rFFWJ/rPGtW7zIX+s2IZEOv66D9raDH1WOg/K/yHHH680H9WcS7YQv1ZkTtGLyPWKN8xaCH+rFmOtug/q0weWyhAa5ajLRrQmuVoiwa0ZjnaogGtWY62aEBrFqMtEtCaxWiLALRmdND7u5iFArSEVyfyzxK6lHah/aywH7kvpVxoPyvyx+5fjRW5ecflvmBoIf4soSfVLJSftW3H5b48ZqH8rEgfu381VuKWHRcnX43VKHT/2YXqs7br+PNWcvtqVJ+lvBqRfNZmHX++ILsk1i9En6W8GlF81mYd13vC20L0Wfys+IXms8J8yGnRC81nFeaz0HxWrPwhZ0UvVJ8VK39YtaP6LOO5uQvVZ23acb3z3UL4WXzvoIXus7bs0O6L7rOs7JIoPysW/rBuhvizTKv2jfyzNvHQNosAtAKAWDtEAFqx/kfvWbQLCWit6Jt2D0cCWiuqdJFwrNIV3fN+cP1CBlqbepycRLwQgtaiJrvQgRY/D2whAq2lVeNCBFqLj7IoQCsEiDVEFKC1+CiL/LOCf1ijRf5ZzkdZ1J8V+sMGCdSf5XyURfpZQT+s7yD9LOfViO6zwn1YP0P3Wc6rEdFnedknkX2W82pE9vFNO05OhnaEHy/OAHNkHy/OAHNkH48FP2T0dmQff9DO6Gg+/pCigzmyj8dqH9JpHOHHY7UP6QiO9OOPauLjSD8e2WCkwTrij0c2GGmEjv7j4T+kYTn6j0dCGBnsHf3Hw3/I5kmO/uPhP2SLHkf/8fAfcitx9B8P/yGb9Dj6j0dOGNkex1GAPHLCyBnEjgbkYUBk+xhHA/LICSO3QUcF8t6K26CjA3k4ENk+xtGBvDgSzFGBvEed3qHTUYG8S9U5UIG8VzMhRwXyTT1OdipxhCDf2OPr/kDtSEHeKbY7OpCPRzUioQR5ShAZkVCCfFRPKY4S5GNUAxhKkI/qQcVRgjwkiGxB4ihBXiSEOTqQb+l5vimwH9cffm+szhGnvN33xnZ0IB/0JuqIQL6lh22D4ehAzhcBOSKQzwoOHBHIA4FYS0EE8kAgVvWIQD7L7okI5LPsnohAPqsHFUcG8llNihwhyAOCyN42jhDkW3uc7G3jaEEeS4HIUd6OHOTBQYvcLpCDfJuPk2OuHUXIhS87cPQgj8VAbJRDEvIkIdIEkIQ8EsNYE0AVcqH7tTmSkItXPQNVyEOFWM9AFfJYC8QaI8KQBwyxjoQw5LEaiLVdtCEPGyInizvakCs/csERhzyOib9P0pGGPNLCyAHgjjjkm3/I+Iw05EFD5LRwRxpyq5I2HXHI+ZIgRxlyK8dcxCG3csxFHHIrx1zEIQ8cYj0Iccit7J+IQ17ikCMOeYlDjjjkgUPkRHdHHPJFUxUcZchX7Ntv918cZchDhvz+gslRhjxkiBwW7yhDvvnHyYnujjjksUiIHKLu6EMePkROJHf0Id8I5ORUb0ci8iAistmTIxF5LBIimz05KpHHztIPsnOPIxN5rBJ6kN1PHKnINwZ9xJPpJVqR5wbTZE8TRy/y2EnoQTY1cQQj92LoRTHyODt+3N+pOYqRx0oh1rURjTzRiAwciEbuXs0DwI3Ggx4plkVHbOPjaZYe4Z2Pp1l6hA8+hGXpEV4Mv1l6hAsf8bL0CM8Ffde+ncVHvEX89diyLD7iY7n04/piNYuPeI/4a65lFn+Ob9lfr5mfWXzER3+97/eRxUc8XQmWZUdwsRVClh7hs7yWDat2ExG/lg3rtml5LRvWbbP6WmLdxp7TH9fsdpPK4iM+6vZ+IHAWf47nK4my7AjOir1uW5HFR3wvL37Hus3VRG2S78fKjeVEek2Oz9IjXOpfB+u2a9kWOtZtnjDP2kLHuu2rbAsd67Z72RY61u1gU6csOmJb1a0G1mysK6ItYWDNDvY6JouO2LrLDqzWwd7HZNERq2ULG1ilg72QyaIjNrsqGeYHViffkDrLPgdHQtnHeHKvoIn1ObOrkgqdWKEzK3Td1uFn8RHPzrHKoiOWnn+UZUcwTVzJsiM4q/M688ziI56uYsiyI5hmrmTZERx9837AcRZ/jqdrirLoiKWHymXZERwVed98I4uP+Bhz7zspZPERH73znoSfxUd8DLr383Gz+IiPKr0nymfxER+D7j1TPouP+Oil9xzrLD7is2Kvz0JZ/Dleo6Pec5Cz+Iinp5Rl2REclXvPKc7iI34ngI52v8Eo1m2cP/+4J/Rm8REfdXvPuc3iIz7q9p5Fm8VHfNTtPSc1i4/4qNv72alZfMQXI7BixUay2f0s4Sw9wveq63XNYczSI3xnnLXrLthZeoTz4dewVvlp9Fl2BBfDr2F9WtYn6XuG9WnF8GtYmUadMMuO4P2e7bndw+3uZViXkXTGKmdhXS7mhFl0xNIE0Cw7gmPwvWeAZvERnx2UDEYLa3NlByWD0cIKzdQzNstYWKHLylnGwjpdq5xlLKzWRY9fybLPwclK9zy7LD7i6bKVLDuCY+S9n6+ZxUf8KP9Sx5qlx9Nn0RFLt+zLsiOYbtmXZUdw1Of9GMwsPuKjPu/5fll8xMfN9H6qZBZ/im+PrNL7gN4QlVqsRHrcz5XM4iM+a/Xe/xqyUos0tMc9xy2Lj/jor/ecriw+4qO/3vOAsviIj/56T9fJ4iM+6veempLFRzxNksiyIzgq956bksWf45OV7hkbWXzER+Xel+1n8RHPWakhK7UNR+wG0pCVGj2/LIuOWN5dG3pSS08S0oLRk1p6kpAWjJ7UeFZalh3BWaOkuSMmtQKTGmJS4wfXZ9kRHB31fnhlFh/xo7qRNZSkFpLEbmQNKaklJZHhvSEltW1F9/aCjNQ6TRrNsiM4RmAlIwYaUut8ytsQkNqg+ytk2RHcykuOhNRehEQuORJSG+UdtSEjtcG7KBJSG3zW29CQWhqSkkEXDamN6KJ6fc+YxUd8Vund1ho6UgtHeujdtBpSUpvV5LehJLWUJCXDLkpSm8Wwi4zUZjnsoiS1ONWeXkrEpDalvJToSS09iV1K9KS2zYhfSqzZSbNIs+wI9rI/oSg1eZT9CVWpSSv7E8JSE5Yak0VHLN14KsuO4KxUcstDUWpCX6dm2RFM0/Wz7Ai28pKjJbW0JHrJsUrTkuglxypVioQNHakVjtTQkVo6kpJZAzpS48fdZ9kRPKs+jYjUtJgeoSA1LR9QGwpS0/IBtaEgNS0fUBsKUlO2vjeLPscazfPOsiM4R10y9UI/alaMuqhHjZ96n2VHML+Poh61Qo8a6lFLPVIyp0M9aoUeNdSjZlGR9zyuLD7ivbgkWJOrfBnT0I/aKl/GNDSktsqXMQ0ZqS2qgQ0JqfGdi7LsCI775z0TKIuPeLpQO8uO4Oib91SQLD7ii7snylFb9d0T8ah5ffdEPGpe3z3Rj5rzuyfaUfPi7olw1HIx0j1DJouP+F2lz/3N/7g1TpYe4btG71ukZukR/qy00e4vHBr6UUs/uifgZPERXzy9IB51vhqpIxz1B38Y7ahG/UF3h8uyIzgeW+5JQ1l8xNN12ll2BJePoR29qD/oY2hHK+oPuv1Clh3BnBU6QlFPKLonRmXx5/jGWaGjEvVUIrtuhZ3FR3yMtXY93TSLj/h93MN1A7osPKL3RlT3feez9AiPveTvC8s6YlGPI83uR9Bm6RG+a/S6MXsWHtH73MF7/kqWHuFZqfe7eUcr6oUVdbSinguP7llaWXzE9+p3Ry3qqUWszaAW9dQi1mZQi/rmINZm0Ip6bGPE2gxyUe9WtRkEo75FiLYZ9KK+TYi1GQSjHntYP+5nXGfxEd+qXwbJqI/iqJ0sPcLpoqOOWtTHrK4iglHna446elEf/JCdLDyi6YqjjlLUR9lFEYo6zV7Los+xud7onqKXxUc8f5nWkYj6pDngWXYE150TjajPunOiEfVZdU4Uoj7LzolA1GfZORGI+iw7JxJRn1XnRCDqUiQkZukRnmPufWLZ0Yd6Ljy6Z8dl8REf9XpPj8viIz7q9Z4fl8VHfMyN7glyWXzEx+PoPaEqi4/4eHy55z1l8RGfm1qTexhiUU8suifKZPHn+Fx45KTHIhh1jfq957Nk8REf99TrYR1ZeoTveZJdT8nI0iN8L1L56Cfyh934s/CILudJqEZdy06LaNS3Co2Ph5Lbo2BHM+oao/D1nIIsPcK96uOoRt2i1+r929GNuvHDd7LwiC7nSehG3aLL3nOasviIL55l0I769iG2vqqjHvXY7fp+Sl+WHuHRW+/5VVl8xK+qySAfdfOqQSIg9Vx/RNoA+lFfVaWiHvVVViriUc81SPdUsiw+4mMcvueSZfERH+PwPZksi4/4GIfv2WRZfMRzFuxoSH3xNb0dDalvJGIzAxSkvomIrbXsCEjdW9XA0I+696qBISH1PO+MNDBEpL6ViDUwJKS+kYg2MCSkHiuQxnV//Cw9wvfr73F/xdeRkPo2Ih33N3wdBalvJdJxf8HX0ZBGLEBq91TFLD7iq1odKEmDHn6WRUfsKFrAQEcaD3ZYVhYdsVK0loGKNB7ssKwsOmILcxjISOPBzsrKoiPWi1Y4EJEGPfIsi47YFrV+n3oNNKRRrDQaCEhjG9F9CBroR2MLERmCBvLRiOS1dk98zeIjXiP+PgUcCEijVU8zAwVptOoeOlCQRqsmRgMBaWwkYi0LBWlsIqKtBQFpxHqjdk/xzeIjfkT8fXoxUJBGCFJ73G+6AwVp9KzZ+013oCGNzl/EDBSkEYIkcp1KDRSk0ctqRUEavZoaDSSkMaqp0UBBGqOYGg0EpDGqqdFAQBoja/U+dRmISGPw+e5AQhqjcIeBiDRG9QgzUJHGKHsqQtIYlTsMhKQxCncYSEmj2ggpS4/wEvAHYtKYJeAP9KSxwWh9TEfu4Vink99HkZLG1iL+1VinM4ff655sWXzE75luI3nVAzVpTL56d6Aljc1F5LaElDSCkkjbRUkaIUkf/+/+e6MkDamYdyAkDSknRuhII05FY20dGWlsJ2JtHRFpbCWibR0NaUjWKLlhoyGNMKTWyA0bDWmEIbVGbmNoSCMMqZEU1oGGNDRrltzG0JCG8vkuAtLQsp8iIA2dZWdCQhqRu9bux9Nn8REfnfV+Pn0WH/HU8QcK0ogz0u4nD2fpEZ61en9CHkhIw/jUF/1oxH7Z9z1xsvQI5xWKejQ2D31Mba5LCQbi0dhARA4Gy9IjPOqTJOAO9KNh/CEG8WhsHeK/OVZn2BH9zbE647i0RjJ2B+LRWPzN6UA6Gose/pJlR3DMekku8EA6GkFHjeQCD6SjEXTUSC7wQDoaK+uUDEdIRyPoqJFc4IF0NIKOGskFHqhHY4X03gl8oB+N8CNC4AMBafijuo8hII0SkAYC0thERIB9oB+N0o8G+tHYRMSQeiAgDa/uqehHw+Oeevf1gX40vNL7gX40vHqHOtCPhmdnJbcBBKSZgETSwScC0owMtkYyvCcK0owMtkZSticq0ozlSI2kbE9kpBnLkRpJ2Z5ISTNWJDWSsj3RkmZksDWSsj3Rk2ZksDWScjxRlGZksDWSYTtRlWasTWokw3YiK81Ym9RIhu1EWppJSyRJdSItzaClRvJOJ+rSjO2RGsngnAhMM/ZHaiSDcyIxzSQmksE5kZhmEhPJ4JxITLNxzZ8ITLNxzZ/ISzMWKLV5H6Qm+tKMBUpt2vWF1ERhmj1r9v4cOpGYZhITyQ2dSEwziem5FPP6+2DNJjE9V3pefx+s2SQmud/dJhLTDGJqcr+9TVSmGbsjPU9cv//+WLmR2dbkPu5PdKYZmW1NSP0iNM1Yq9Tk7gwTpWlGflsTUr9oTTPy25rct3SYiE0zsUnvDzwTsWkGNjUl9YveNEfUr5KRAcVp8k23s+wIjsq9HyeUxUd8VO79iKAsPuK9bJxoTnM+ysaA6DRnKxsDotMMdGr3kymy+Ijn6D+RnOac5UiF7DSnlCMVutNMd2IjFbrTTHdiIw+605yrHHmQnub0ciRBfZryKEcS9KeZ/sRGEvSnKb3s6QhQU0bZ01GgpsyypyNBTZGypyNCzVjJ1EhC3USFmlLcc5Gg5jYm8hwxEaBmAhRJNJsIUDMAimQnTPSnuYGJrRmZyE9TAxbv6ZoTBWpqjshkLogENZOg7mdsZPERL2U7RoKaSsliIj9NrfssEtRU+uZ1oj/N9CeSWzXRn2bsnESaDArUNHYoVBYdsdFTSX7SRIKaxvMYJwLUDIBirQUBaiZAkXSmiQA1I/2tkcSdiQg1zcpREhVq2ipvachQ0+pbLDLUXPUtFiVqFhI1UaJmShS7BaJEzZQodgtEiZopUewWiBI1U6JYd0KJmilR7BaIEjVXPTlGiZqrnhwjRc3l5S0NLWr6o7ylIUbNSIejtzTUqOm9vKWhR83YTqmRRLGJIDWdv4mdyFHTs+eSZ1QEqenZc697dGfxEf+sPRNyW0CRms6HYuSoub3JyA64EzVKNjeZ3teoCWKUPMqJkyBGSWIUGRIEMUoSo+5HXmXxET+rVimIUfIoH2kFMUoSo8iQKYhRkhhFngIEMUoe3CsEJUoepVcISpS00isEJUpa6RWCEiUpUWQIFJQoSYkiQ6CgRElKFLm/CUqUtHL2JChRkhJFhkBBiZJm1ZAmiFHSVjWkCXqUpEfdj1jL4s/xRcKcIEZJ5zdbQYmSlCgj3QolSkKinlsz/vEM8iw9wqNiSfKeIERJQhRJIhOEKOF7KwkilHSe1CooUNJ5UqsgP0nyE0mYEuQnGUV1oj3JKKoT4UlGXZ0IT7JlqT/8+nZT0J0k3YnkBQm6k2xYulcPmpMMvluLoDnJ4PtkCYKTJDiR7CRBcJJic25BbZLYUelePUhNktS0yE0DqUm2JZEzjbL0CKd7QQhCkxQbcwsqk2xG6r2T3wOrMpGJpGsJIpPMojZRmCSFieR2CQqTTJr5KKhLUq1tErQlCVsiYCFISxJLm9hFRFmSlKV1PeQzi494Pu0VZCUR3jGRlKTYRknQk0SKqkRPklzSRNLoBEVJpOiYyEmiRcdETJJczMTGTdQkUbqlhyAlifIddwQdSZRv0SKISJKIRNIKBRFJYh0Ta7DoSLKhiDZYZCTR4jzNLD3C46ZJchwFJUmsuGkiJAk93S2Ljli+a7OgIonx/VkEFUkiB66RtExBRhKr9mcRVCTZTETrBxFJApHIdi6ChiRpSCRHVNCQxIrOiYAki+7PIohHsvj+LIJ4JIvvzyIoR5JyRHIaBeVIVjHEIhvJdiEy/qAZSZoRG3/QjGQVc1kEI1nsEM0sOmL5rtuCUiQpRSSxUlCKpNh1W5CJxPlGAYJGJGlEbGKFRiR8y21BIpJiy21BH5L0IZJRKehDEhlv9/w4QR4Szz5J5j5IRJIrlkj+paARaa5YIvmXikikgUSdpMgpIpE+qimQohHpgw+2ikCkAUSdJG4pApE++FaSijqkm3+k3Z+TFHFIA4f6o1+xTRGHNFYq9ccg8QvjPeInicd6DR/qD7nHow9py3q9v1xT9CENH+rktCxFH9LwoU6SaxR9SBsfeBVxSLf+3A+PUJQh3fRDTjnM0iO8rliEIW1ZsaRDIQxp87IhIAxpf5QNAW1IeysbAvKQ9l42BOQh7aNsCOhDGj7USVqLog9pLzot4pDGKiV6MRGItFt9MbFy+6ovJlZu97LxIBPpeJQXH6VIRysvPmKRBhZ1kpujiEU6+BtURSrSkTV7n/sqUpHGEqVO0lsUuUgLLlLkIo0lSp0c/aYoRjrojElRi3TwGZOiFmmsTeokyUYRjHSLEHumUvQinVmj99mHIhhp7K/USSKMIhrpLMZhRCOdWaNkkEc10lCjTlJbFNVIJ58DK6qRhhrRFoBqpJNu7quoRip8c19FNNJAo05yVRTVSIXnlyuakW4UYltwKpKRBhkRzFdEI421SJ0kqyjCkcZapE5SShTtSIu1SIp2pGlH5EWsoh3p9iHak1CPNBYjdZLeoghIqvzRRlGPdBMRnU0iIGmsReokdUbRkFTpw40iIWmxA7eiH6lmhZLRCwFJYyFSJzk5ioKkyl+6KPqRhh91ksCj6Eda+JGiHyn3I0U/0sKPFP1ICz9S9CMNP+ok4UTRj9SK2RHqkeYaJLJiTZGP1LIyyfCMfqTpR+SdtKIfafhRJ3vFKBKSxhqkPu4n4ioyksZG3J1sLqMoSbrqqS9ikgYmdZIto4hJusFoudyfhZGTdJPReLDfHms3QKmTXBxFUNJYhNRJLo6iKWksQuokF0fRlXTVtYu0pE7zVhVZSb2VLQFlSZ0mrirCkvooWw3CkjrdMkARljTWHtEWhrakTteAKrqSetYnGR1RltT5fgGKrKTbjSZ5TEJUsgc/SchQlOxBB15DTbJiL25DS7JHVuR9LDXkJEtOGv6DrB/1IRg/MZ7uCmuoSRZrjfp8kO9WjKf55IaUZElJs5HvXhhPX48aMpJtJ3K9Z6kaKpI1uprXUJAsBek5F7392ihI1uj+voZ6ZKFHfY4nCX1M6TAeq7LxqkQ/spZVeR9nDQHJihw3Qz2y1CP6i2Ndph6xNot6ZKlHrB2iHlnqEWtbqEe2eYi2F8QjSzxibQDxyBKPSH6hIR5ZgUeGeGSxE/f19YOhHFnKEbvwKEe2aYisMzB0I0s3Ys0A3cjSjVg1oRvZhiFaTchGNuquimxkY5StDOXIUo7IQZ6GcmSjqFZkI9s0xK48upGlG33MYW93f0M3slF3WLQjG1mz5KaEfGSTP8MY2pFNvnDMUI5s0xBzcEM4slhpdDV2QzWy2EZJyFdjdcZaI7IkzVCNLNWIXXJUI5t1V0U4slnfTxGObHrZ2hGPTB5lb0I/Mik7K/KRSXbW+1OboSBZrDrq5BRaQ0KyIKROTqE1NCRLQyKn0Boakm0k8ufC2vZjawvDsXaDkDo5h9ZQkSwUqZNzaA0VyWIFUifn0BoykiUjkSNdDRnJgpE6OdLVUJIsDnPr5JRWQ0qypCRylqohJVmktXVyxKghJ1msSOrkfExDUbIUJZKYbChKlqJEco0NRcniTLdOco0NUckSlciBl4aoZIFKnaRbGrqSxdFuneREGtqSRZJbJ2mIhrxkkeTWyblqhsJkxS7dhrxkwUud5P4ZCpOFMHWSoWcoTGb10IzCZCFMnWTdGQqTWbGns6EvWfoSu7GgL9mqJ8foS7bKyTHykq16coy8ZGuW9yH0JVtZuaRnITBZcdyboS7Z5iMyFUFaslVNjhGWLGGJZIcZwpIFLJHJCNKSJS2xRoC0ZJHbRpsw8pIlL7FGg7xkXtcqEpNtQ6KNDIXJXMtGhspkqUwke85Qmcyzx5LhEqHJPCuXDJdITSvWL3WSV7NQm1auXyIHVy0Up/XgL+MWitN6FKeFLfSm9SiRYqE3rVi+xFraQnNaL3O6t7SF5rQ2LLGWs5Cd1oud7g1zITutXMFEWtpCelq5gokkEi20p5UrmEgi0UJ/WulP6+68C/1p5Qqmdd97fqFBrTSodX//vNCgVmS4dbKgcaFDrXSopSQeqzcXMq37k+1CilpxIly7m+9CiVopUSR5YaFErU1N3u+5rAshaiVErfu7q4UQtXIZk9/fPiyUqJUS5fc3CgslaqVEka0zF0rUConqZG31QoxaxZbeCzFqbW1i4w5S1OolWSzEqNVLY1yIUavGqIUYtUqMWohRq8aohRi1aoxaiFErMYosEV+IUavAqIUYtUbmSZFeghy1XhzF/lis21HMpBZi1BolMy7EqJVrmVhLQI9as5wgLySpNasJ8kKSWrOuWVSpNbNm73OXhS61ZlGzqFJr1ndbVKk1y7stotR6oRRpCIhSq0aphSi1qjy4hSS1pJwkLzSpJeUkeaFJrTQpsqZ+oUmtIhNuIUgt4WkaCzVqbW9iNrlQo1ZqFFmuv1CjVmoUWa6/UKNWahRZrr9Qo5bWPRY1amndY1GjVmoUa2aoUUurGTJa1NJ6howWtbR69llIUUvLZ5+FFLW2NX38qTeYXAhRS+vbLELUUvpadiFCrUCoQbIwFiLUCoQaJFNiIUItq/srItQy+m52IUAtKx9oFxrUMvpudqE/LasHYfSnZfQ1+0J7WhuXaONCelrGqxPhaa3yjcBCeFqLvmZfiE4rFzWxZojqtBavShSnFeI0yAlEC8VpreKGity0Nil1Mt9Hb1q5mon+mVibr9VMpIUjOq1EJ9ayEJ2Wly/aF7LT8nISjOq0vJ4EozqtUKdBzn5aqE7Ls2bJJBjVaW1Xer5UmR+/juDYiOq0Qp3GQ+61heq0Qp3GQ6+7yi1Up8U3VVooTst5FutCbvLtSezvdNQmf+S4az+I/vhoGN4wvEf4uod3DN+V+vHLyOOPF8XRm3yDkk3y5ROjJX6X+0zDUZt8cxK/MorhVrUAR23y0CbWAhy1yfkiJ0dp8sbfsTsyk29Hon8nKpO3XrUARCZvo2oBaEwexsRaABKTb0NiLQCByQOYBsnUcgQm34JkxKMcfcljqdMguUiOwORxYBy98Fip/VE2MAQm761sYAhM3umSUkdc8s7TqBxlyTcd0b8TYcm7VA0MXcm7Vg0MZcljmRNrYEhLvu2INTCEJQ9YGiRhzBGWfJSDL7qSj1a2AIQlH71sAQhLPuhMyRGVvDgrzlGUPERptHsWoyMq+SiHXjQlH1a1GCQlH6tqMWhKHqbEWgySkm8zYi0GQckDlAY54coRlDyy4wZJvnMUJQ9RGiSbzlGUfM7qUiIo+ZTqUiIpeZASu5QoSh7rnAZJ7XMkJZ/1LRVJySefKDl6kkvZVxGUXMqJEnqSSzlRQk5yKSdKqEku1UQJOckle+udcBxFyaXsrShKLvVECUXJpa5VFCUXPlFCTXItJkpISa7ZV8kEEinJg5IGSZN0pCSPhU2D5CY6YpIHJg2Sm+iISa7VI40jJrmWjzSOmORaPtI4cpLzLbsdKcm16KloSW5lT0VKcit7KkqSW9lTEZLcyp6KluRW9VSUJI/VTINkeDpqklvZUxGT3OqeiqDkVvdUFCXnouQoSl6cGufISR7rmJ4n3l1n7khKvs2IXhcUJV+jajGISv5CpXuloil5mBJrMahKvuGItRhUJQ9VGiT91VGVfLMRvzJYo4FKtMUgKrk/yhaDqOROndBRlNz5QhdHTvLkJDZDRU5yL59pUJPcy2ca1CT38pkGMcm9fKZBS3KvnmlQkzw0aZAEaAdQmo8KlLL0CK+eabL4iK+eabL4iGfPNFl0xNJnmiw7gou7aZYe4cpbQJYe4cZbQJYe4Yu3gCw9wp22gCz8HB2aNO5Z6ll8xBeglKVHeC9bQMMafYkSaQENa7WxdNYsOmKp52fZEVzcTbP0CC+eUrP0CC+eUrP0CC+eUrP0c3jnT6lZeETn/fT6RJDFR/y+n348pF42gczSIzwnvteJdRYf8XFDvR8ymcVH/H7hdt/JPUuP8Oiq9zMps/iIrya+WXzE0zzlLDuCY/i9H3iZxZ/jK1LK0iO8mPxm6RFeTH6z9AgvJr9ZeoTzyW8WHtFxT71vVpDFR3zZXQfW6qgmv1l8xFeT3yw+4tnkN4s+x/KcuSw7gsvhd2KVzsLzs/QILzw/S4/wwvOz9Ajnnp+FR3R21CueZfERb+WVwRp9cRJpARNrdHrZAibWqrD9IbLoiKV782TZEVw8zmTpEV48zmTpEV48zmTpEV48zmTpEc4fZ7LwiI5Oet/yI4uP+KjS+5YfWXzE11UqWKXck7LsCE5Puj5zZPERX1arYrVqWa2K1apltSpWq5bVqlitWlWrYrUmJd13/sjiI754Ss3SI7x6Ss3iz/FWPaVm8RHPnlKz6IilT6lZdgRHld43AMniIz4nSmRiZVip6Un3052z+IiPAfh+unMWH/FRr/fTnbP4iI/uej/dOYuP+P1c067bg2fp5/DtRs9qvRy1nqVH+N7XZVy3pszSIzxurPdtNbL4iI/KvW8FkcVHfEEQWXqES9noF9bt0rLRL6zbxVaeZdERW8yAF1bqKl6TZ+nn8Bcp3Yc9x0r1Vg17jpUaqMSGPcc63W7Ehj3HGs01SvddI7L4iC8JwrFGyzVKWXzE1881jrVK1yhl0RFLQT/LPgW3kpQaklKr1ihl6RFePdM0BKVWrVHK0iO8eKZpiEot1yjN+42voSq1B02qybIjeE9/H7e00Sw8ovc9tV/Hxoai1B5sr9Es+hzb6GZaWXYE76eZcf+l0ZJao9tpZdkRnAPu/W7aEJJay+55v5s2xKQWmDTu+1Bk8RFfVCZqUttedL/gSEltYxG74FiTje4FnGWfg3NN0n3rjCw+4vljTENFap2enpBlR/AomisKUutse9EsOmKFXxC0o9bpls5ZdgTHAHvfSCSLj3h+22wIR63znQKy8HP0yIq8z7QaulHLfbrvuwpl8RHPDhvKoiOWHjaUZUdwdMr77idZfMRnp7zPshqqUdsuRGofzailGd23SsniI76oUASjNqoKRTJqm4We7/mk/fhx1SAc0ahtFtLn2S23cRbRqCUa3fd4yeIjPoba+x4vWXzEZ62SoRbdqE12FlgWHbFFjSIZNb5Bd5YdwfG4ct9pJouP+HgOve80k8Wf42OfpXHfaSaLj/iYCN13msniI54/izZUo5ZqdH/HnsVH/CyaL6pRo4e7ZdERW4y5KEYtxei+m04WH/F0P+csO4KzQsngglzUCi5qyEVtexC7wyEWNXq6WxYdscWAi07U+OluWXYEx2h731soi4/4YgqEStQ0zh26v9ZpiERNeSZxFh7RWZVkhEMjasZOA8uiI5aeBpZlR3AMtfftk7L4iKe7c2fZERzj7H2vpSw+4vn70YY61PJst3uDRRtqVoy0CEPN2OEWWXTEFhNaJKEWy4zGfX+oLD7iiwktilALEVrXE6Kz9AgvuiVqUFt8RosU1FYxo0UHaulA9x2wsviIp7vDZtkRvB8yyYvihhTUNvawK4JV6bxHogK17TzkiqABtTCgcd+zK4uPeJoskWVH8Cw6DQpQy3VF9x2vsviIz8okdz8koOb8KRP5p3nxlIn+07bxsMd6BKAeAHSXi47+0x+8MjvqT0/9uW//lMVHPK/MjvjTY0HRuO8VlcVHPJ31dKSf/uCzno7007fusEtiGBzT2PuOVVl8xHPL64g/fQPP/aG+I/70Vkx5OuJPb3TK09F+euNja0f46Y1PeTqqT0/1ue/flcVHPJ/ydFSfnmuI7mdsZvERH1W5HiQeqzJWEY11n1N19J+e/rP6PR79p2/jue65m2VHcC//WCSg3ulSv44A1HMJEbswiEC9s5z9LDpitbyIyEC90zcnHQmo91VfcKzQTleZdDSgnga07jeTjgbUB5/7dASgHiuH4uwi73/4bqzL7TxkmEAD6mlArKGgAfU0IFZBaEB9aNlYkIF6MhCrJGSgnkuH1v2u3FGC+igGXISgHmuH2IVHCOqRkEbOpMriI54jbUcG6slArKKQgXoyEKsoZKCe6WisopCCei4gYhWFGtQzIW2RyQKCUJ/c9zpqUE8NWuzKY8WmBi273x5Rg3pq0CI3JtSgnilp95Pts/iIj8q9n+SexUd8VK5fT3rL4iM+KtevR09m8RG/J0gfz833y4N1mzDkg8Rj3eZSIp/3toM21NOG7nt1ZfHneK2rF3moK1100hGHemamsb8Vgagrv7OiD/VcR3Tf6SqLj3hOCh19qGtZpyhEPdcR0WuIdaqrvi5Yp4lErA0gEvVcSHTfTCuLj/jiDotQ1K0YiVGJeq4k8uu2fVl8xGetksEAoagHFM37fk5ZfMRrxF93q8ziI94i/v4M3hGMutG1CR3BqMcpbvNxd5qOZtTDjOaDtAI0ox5mNB9kJEA26sFG80F6FLpR3zakft2INEuP8P1008hfi3jUV9YsacPoR31lzZLbDvpRL/yoox/12GebvOXq6Ed9Zc2SVoyE1GMt0bxvGJLFR3wrb2koST0kad53DMniI36Ut0DEpJ4LitiUAjmpJyex8RI5qXs5HKMmda9vsShK3etbLKJSj0VF8779RhZ/ih8P/vploCqNBz2KJsuO4F5cmIGoNAKV5v3g6Cw+4mc1Qg10pfGQaoQaaEsjlhXN+64UWXzEx2h835Uii494Pi8eyEvjkbV6H/4GCtPIdDXSCQci02it6lQDmWlkvhrpVAOpaeQyI9KpBmrT2KJE2w5600hvIp1qoDeN3ASJdKqB5DRa1u19vB9ITuNFTuzPxeptVCgGctNIbmJ/K3LT6HROPFCbRs+x+H6fGqhNo2efve7nl8VHfPTZ+24QWXzEbwt+Hj17qyZEpxHoNO+bR2TxER/Vet88IouP+KLLojqNTUtkrER2GsFO876JQRYf8TF9uh8lncVHfFTsPeU9i4/4cmo8UJ9G6BNtCKhPY0g11R2oT2NkzZLxD/VpjKxZ0mFRn0bo0yTJnQP1aYQ+TZKtORCgxqRpTgP1aeR2SGzwQH0as3yQHQhQIwCK3jgRoMac5Y0TAWpsYWJT74H+NGIpEpl6D+SnEfw0Sd7rQH4awU+TJLIOFKgxywefgQI1eALbQH0a0sorifo0hO1Gl0VHbNQqyZEdKE+Db66dZUcw3Vw7y47gakI80JzGRqXnYoP7NcH6lPrWiuQ0XuREegeS0whymiSjdiA5jUhgmyT/ciA7DeXrywaa01D+BmAgOo1EJ3ZlEJ2G1pMmdKcR65I+Ltl9zEZ4GsofYgeq09BVfzlWa6jTJEmMA9VpGO+mKE5jq9LzCJnLrr1ZeoRvc1o7M2OsheFYp5uVngfC3L8da3Wrkowfpv/Ye8dorNPYVvvZBC6rBAaK09ik9HzJ/fG7PPQP3441Ghtr+30NwkBvGuFNH88Ut0y0geQ0Yiek55z8Go41uklpufyg88eJr6QHgtOI3bVd79+O3jQ2KC0nFxK5aawcfcl8A71pxHZIkyQxDgSnwffYzrIjWKv2i9g04lA31n6Rm0YsV2LtF7lpxHIl0n4Rm0ac6sbaL1rT2JhE2y9S0/BetV+UprEpibZfhKaxJYm2X3SmsSGJtl9kprEhibZfZKbhVrVfVKbhOfyS+Swq0yhS1wYS04yVS6Q9TkSmuSFpPY/2u0wIJjLTfFTD70Rmmo9q+J2oTHMz0vMgutvivInINLcikdY+kZjmNqS1lPyliuFWdI6JwDQ3Iq21yLcvDPeiL00Uptmip97fYk8Eptla0fUm+tJs0VPv77wn8tJsVU+dqEszdkPy+xR/oi7NJkXHnohLs2nRsSfa0mxWdOyJtDTbKjr2RFmasZhpkmz2ibo0Q5cmyWafqEszktkmyWafKEwzhYlks08UppnCRBLIJwrTTGEiCeQThWnGRtuTpBtPJKaZxESSUycS0+Trmiby0gxemiQXc6IwTb6uaSIwzdgSiY1j6EtzA9LzPM3bbHwiL83kJZIVOpGXZqxsYmM26tIcdPeyibI0h1R3D4SlueWIfDXW5VYjfg2xOgd93TrRk2ZshMTuBMhJk3PSRE6as1W3AdSkOak5TJSkuamI3jIQkubk1YiINKdUtxdEpDl5NaIgzWnVvQUBaU5ejYhHc3p1H0I7mtyOJtrRlFbds5COJqejiXQ0ZVT3N5SjKbwaEY6mSHVzQzqawqsR3WjGWqVJMssnwtEUjvcT1WiGGk2S0z1RjWaqkVwPDs3iI74iholoNDcM0UEN2WhqObwiHM0tQ3RKjG40YwttNgwiG81YrkSmxIhGU60aCJGNZuyfzabEqEYzTmNjYyGi0dwyRMc3dKMZWx6xMQvdaFr1NDrRjWacxsaGLXSjabMaihCOZsARG14QjqZpNWQgHM2EIzIlRjiaCUdk1EA4mglHpBEgHM1cqkTS/CfK0SzS2ya60cx1SiQVfyIczYQjkoo/EY5mwhHJrp8IR3PRbJqJbjQXz6aZqEZz8WyaiWY0Y6+jSVLlJ6LRXJwXJprR9Gpx90Qzms4TTyeK0czFSbKuL7MmktHcKHS/3OhF03lGzUQtmrEqaZLNACZy0XSeUTMRi6Zb/VdidTrNPJ0oRdN5uuJEKZJtQfdLIuhEElscTbLTgCAUyYO/eRFkIonVSKRRCTKRbAi6/5WCSCS5EolcbkEmkg1B18staERSJLkJCpHEEqRJ9l4QJCIpktwEgUg2AdmY11FZEIhkE9DHTfIHffzYHwvDsTJ5npugDkmR5yZoQ1LkuQnKkMTRa/RvxIqMZUeT7F0hSEOSy450XGeVgjYkbdXxWJ+JQ3rfvkIQhyRxiGztIIhDkjjEvh9xSBKHyE4JgjgkiUNkfwJBHJKtP7S60IYkVh+xJok0JJ0PuYIuJJ0mFQu6kHSeVCyIQtJ5pr+gCkkuOyL7KgiykOSyI7JVgqALSboQ2UlA0IUklh1NkmcvCEOSy45IFrogDkkuOyKp4oI6JLnsiKSKCwqR5LIjkkgtSESSy45IbrQgE0kuOyJZyYJOJJH3NkkerqAVSSw9+pgyk3is31h69DFlJvFYv7n0aJH6RTGSXHq0SP2iGsmkGaqCZCQz3pLe78GIRpLLjkheqKAaSS47IumMgnIkueyIZNUJ0pFE4tvHtPwej3wkufRokZaDfiTcjwT9SHLpEUmqEwQkiaVHT/243hYQkUR4raIgyWaij+8mt0BUJBHq84KCJCFIT1e5fzfWKT2ELYs+xwYgPRHm+t0ISMIz3QT1SGLJUb+f4ZrFRzzNdBO0I9Gsy/seeIJ4JMrrEuVINg49j4W8dlGkI1FelehGolmV9/WtgnAkyqsS1Ui2C3m/r38UVCPhG2ULkpFY1uT9vYygGYnxmkQwkshu6891m9fvxpo0XpPIRRKZbd3vy30FvUiMVyVikcT+2N3JaIJaJPTAtSz6HJtURNJ/BalIMquNpP8KapGkFjm5H6IWSWqRk/shapEsSvWCUiSZ0+bkDodaJJnT5uQOh2AkkdM2Se6voBlJmhHJoRU0I8m8NpJXKshGknltTu5a6EbiWbekLSAdSe6STbI/BelIIq9NHqQtIB9J5LUJyf4UFCQJQZIHqV8UJAlBkgepX0QkyQPYSEanICJJLDkSktEpCEkSS46E5FwKWpJGYpuQnEtFTtLgJCF5kYqcpMFJQvIiFUVJtxk9F6zehilFUdJIbxOSFqmISvpCpfswqIhKGultQvIEFWFJI71NSHqeoi3pxqPnJlu3xcWKtKRBS0Ky7RR1SSPBTUi2nSIvaSS4CUmgU/QlbVm799amaEwaCW5CMqcUmUlbVi9pbShNGhluQjKnFKlJg5qEpEIpUpMGNQlJhVKkJg1qEpKwpEhNmkezkYQlRWrSoCYhCUuK1KRBTUIShBSpSYOahCQIKVKTBjUJSRBSpCaNdUhCEoQUrUljHZKQtBZFbNJO35QrWpNuUDK9T0gVuUk3KZneU0cVwUnjcDYhCTaK5qRhTkISVRTNScOchCRkKJqThjkJSchQNCfN89nI8UmK5qRhTkIyDxTNSUfWLGlpaE4a5iRkabiiOWmYk5Clu4rmpCOPySQtDc1JRx6qSOoXzUnDnISsCFQ0Jw1zErIiUNGcdObpI6R+0Zx05lkVpH7RnPR1WhupXzQnnXkIFKlfdCeN/ZaErPJTlCcNeRKytk5RnrTYb0mRnXS70vO97HXSgOqkoU5C1twoqpOGOglZRqOoThrbLQk5DEBRnlT4RpSK7KTBTkLe+yuyk+ahbeRVviI9adCTkFf5ivSksYBJyKt8RX7S4CchL9EV+UljDZOQ/eYVCUq3MX3853tbQIFSzbol7RIVSmMNE1kDoohQGie3CXm7qwhRqjyfUVGhdFMT2QZb0aE0Et+EvCZVhCiNxDchr/kUMUoDo4RsUa+IURq5b0K2b1cEKY0dl4S8tlMUKY0dl4S8hlNUKQ2VEvIaTlGl1LJqScNEmdKQKSFvnRRlSmPfJSFvnRR1SkOnhLx1UtQpjX2XhLx1UhQqDaES8tZJUag09l4S8tZJUak0lErIWydFpdJQKiFvnRSVShd9F6AoVBpCJeQNlaJQKRcqRaHSlfVK2g0Kla6sV9JuUKg0hErI2yxFodIQKiFvsxSFSkOohLzNUhQqDaES8s5JUag0hErIOydFodIUKvLOSVGoNIWKvHNSFCpNoSLvnBSFSlOoyHskRaHSFCqis4pCpSlURGcVhUpTqIjOKgqVplARnVUUKkuhIuJqKFSWQkXE1VCoLIWKiKuhUFmmxl2f+wyByhKoiM8aApUFUAnxWUOgsi1QXe47Ehn6lKVPEc419Cl7ZOXeG48hUFkAlRLONQQqC6BSwrmGQGUBVEo41xCoLIBKCecaApUFUCnhXEOgsgAqJZxrCFQWQKWEcw2BygKolHCuIVBZAJUSzjUEKgugUsK5hkBlAVRKONcQqCyASonPGgKVBVAp8VZDoLIAKiXeaghUFkClBFANgcoCqJQAqiFQWQCVEkA1BCqL1VBKANUQqSz2YlICqIZKZZEspwRQDZnKgqmUAKohU1kwlRJANWQqC6ZSAqiGTGXBVEoA1ZCpLJhKCaAaMpUFUykBVEOmsmAqJYBqyVT/44c//fzLf3797dvXL//PL1++/u8//bf//t//9Oc/f/uvf3z90w//509//jn+4/phf+2f/tv/+dP6+P/+vx/+9DHexf+O/F+N/31uxZkf5PXBXh88P3zMRPLDfH14/bjn9z/3KswP/fVhvj5k8HMXkfjw+uanC+8P9vpme33zev3Uev+X17/lryJv/fXh9V96/hqu8/XhVfT6191eMTZfF+f1je0x3hdsPt6f+vvT+yfm+yc8/5j2POgrP+nrZ58H8MSn56kLr0/2/vT62edO+PlpvH9ijPen98+O98+O90/M90/M1088t+TKT+/S8arZ9q6A5xaF70/vn3V5f3r/xPuvfOa6vT69fuKZupOf3v/GfP8b8/1vzPe/Md//xvPNXn6y13W297e4vlrjo6/Xp9cV+vg03p/k/en9E68r1B/z/RPz/ROvhtHf9dbf9dafB5S9Pr2++XkuVn5ar7j+ajn9eTZBfnp3peeuKfnp3Yee77pen17dSf37J31/ev299upb3V6dq1t7/7f2/b/N9yd9f3p9y3rV28en733+3enl3evl9Tsvff+Evn/ifTXW9wHj+4jxHjKWv3/W3z/r75/w72PMe5B515av91gyvn8a70/y/pTfMt49Zbx7yuifSvObx/fB6fvo9H14em77mZ9eV3eM+Y7T98++2uQY9o6zd6m9vm/q90+vb56vNjTme+h8ri6MT89nyten/v40359e3/ecrb8+2fvT61vs1cKGvYb7Ya/RZ6xXX/0YDsb707vU7P3pHfcawz4+vX/i/dv7+9/1/vqd/V0fLu/S9zXw9zf7q5XMx2O8Pr1a8Xz33/mQx+uTvX/i1er2yd7x6XnGyuuTvD/Z+9Pr+/qrZe+94/OTvb5lvEblvUNnfnrdDfa2cq9P/fXp1Q72rgKvT69veSbJvz7p+9PrX5vvb56v+8zOx359ev/EfP/E+zeY79/gmfr7+vT6ieea2/z0jhP5/t/s/en1m8r7usj7uoi+f0LfP6Hvn3jXh9j7J+z9E/b+CXv/xHr9ps83pflp9fenXfrxMec++/96zoX+/O23n375/d9+/e3vn2c6m23fk52Ntfcf/+l//v7r3/757eu//fy3r//46du/n1/yMY399CWN/Q6vL3l+wc+/fPv6209/+fbzr7/89uvHf/v8hc91Ee/va9kmbt/3l798/ce3Y+Ymn36yz/cYK++RVVf9bf/47eu/ff3t6y8fn3/67fevvx1/qPdPf2cMzPSLnpPK3z//dP+YjL9/WmOmRX7699//8u9f//If57/+Mbd9/7i8b27t/+Zrfvrtr+evYp9+k+rP+P33v//0j6Nq5qeaGf/iR3/9clTr/DSvbmWl/v77r8ef7uvTpfuYT7/+en/fgN3fN4H2HuZjQLj/G7/+85dvf/75y5//4+t/ff6XngfDvP8lr9rK/oJ//Pbr388W+Hzl8/2vFKMdKr/h96/fvv38y19///NvX//+9e//8+tvf/7br3/9+Zfjd/rcqL0VDSe+8duvv/30169//vL197/89vM/nj3s+DZtn7/N/8W34bPR+FwVXjW/54///OX4Wf/U7j6eGt7PCq8RvrXH95n/exb9fqYY9p4Jvz+9x9enRP6rX+YPlT0/V7b+qx//w0D13EH80xf8i7r++Zefv/38099+/n/Pfv0Uzu9XxQYdPf/wLditn7b66ZuqLhbf9H0I/vr7P//27fyyz+2k5Q2If9nHpT1+/Hna6PdLM//Fr7LbfDbc8wKPzxdY6m+J3vhvH3/Sr7+dFd0+1dOqhq3n1/zxfqSf7m9PBKt//tWlzz78uaW0f9FtLldCx+fRc72fXvO5pP6u85rK+vyrvB70X7PAjz74flp+PUm0N2Y8V7rkJ3sNwx9t9v28+X5aeTz4OPW341706bd5qcPOYIpP9uC19Te8w4xPPYnOhD5+7h9ff/v7z7///tHwP+rqbLWfvoCPB3/7w0X9GK8+3aGUd5aPH/3tp29f//pf50/b55/mneVv3379/rsfV3F+aqLVNTvu5vv9x/cZjT34NfvHv3/96cvX3/79p1++/O0cv1b/dMfrY/F6/5hbPb/jaNbHTI9ftv/1z5/hgj/3uP7+q/f3BPn9aLr3An99+hff/PzF/vbrX/7j+Bee56x9+heKjnbOEufnQWsn19Gf+0M70s93SOHV+NutGal+/mE+Sn37+T9//nb8pI9PM9ue/bn42a9///nbt7Mm/fF5jqYPfsXjK3759dvP//bzX3563n7++vWXjzvRt3PSt8anP6c/974jX/jlp398/C63Yf/zX/XGmvV62mxqtK1+OSYuz+2Cvveut0qJvt3p+yd/P8E+vj+3vp84x7tU6c3sy5fjfnb8RZ/72prFr/+6zH//+u3jAn376Wih/XMzG8ZncV++/OXXX7799PMvMVHAZvPxRev4ItrmPn3Rp8H3aD+fh0B+i/3yJRvL1y8fk5Zf//nbX86nLJPPzbAJbclfvvz7H0ajnY/yqes6b3Nf/vbz79+ev8l5Pdann/+YKn93g+KbrlV0dEh/q9wLuPjQ8OXLP379/ef/fftSt8/XuJj7f/nyv/75E/SA+bkHFG33+ZPwsCmff5TeVb98VOjff/3Pr/8XA8PnP2OOovW+mshZSbN9brRvtrT+hr83nNp8l74Zz/7/yt5suZEdaRJ+l7n+LxJLbs8yNlZGkZTELopkcymd+szm3X8gM+GIQMJTZy66i0cSgrlgicXDfUQaD8nPASMGj3Sfx287/AzpzSXZu33d1akRMaAi3bI1tYKdh55WXmwgvtl6kc/j1+0c1hm5hlZdw8ZbfV6rFoZeeh4b9/C92+/O5+t3zcognQDr3MaG+H18Ox3+HO+YW7Xd1cjdlc6rj/hfcl0Jf3prDE3tOPFSuPcXTezPu8eD2xHXz/fiaOcjBDk3bsfKFcvsnD/0GCcfHqqONn2gr/j8cXy77/TzkCVYQ/e688d/vpXP5lp5Po70DZ7P+91l9mXVViUXVopkUvK3RWbdpAqBNyN94efz++v8fjqfjwe9crxavXyWnc9hxn9e9WY6epng7HNJCMWrwfMHHVbRnJycj77v+6lw4qzM5HaGv/pg6XioXp88fvsBeUqU6AaDghaKjoPnr3j6ppgxjlaL71JOay6eObobFdbux49gSJns1ONFmd/kS6VbZjQevQK9zcl9kq/Jc4gLw660X0dI0vU0PD//FR1Gfcw5cWS7joezNxUTdq0MQZZSY33Y8aKmtlx7xtKFcbudlx34138eOoqduHaE/+Xo8xJGzoeaHaPs0Okl7Fz3z2PMnoZX8FUYU04hT9AJY4/b7v7f86/XLZxYRdzaq+jQ0ekkrP3z6/v7+1cs3vx63c/Hy/56KHYVL/2zidqHW/0bXPHD6Vk64MbIbKZbUjDMRtjZwt6h1+MgEwEjTz/ebvfXpXCdOxW8bmS50+DT5fZ6agsyYTnyXMb9448e16pxdOLe77u/x/Pxqzj9J/r4/Oy9pTt6NPC6hOdeyaIEz0w6REsSrmZFv7R2VH7UxrCikjPI7IZtO5RHm1xaTcec5wmtx+N4f9az/a14LGNDZ8Nk4Xo67EU+Wm0r0tU0LQ9WJ0NxAyXzu5U729RxxA094xlx/Od5n7IKarrITFtYMtzK38u++qLlPhl8Cf7GsoHVZA/TZVBW6A4nrFxfz7WZUZmhiyaaeV6nKVzUfmUGseOZ7clAqkFfb5XX06uQgucRQ0Bx2sdIoFoqVBXggSf+JiuxnE0tydK4HTq6HU6WkIxYZYatUzkSnpt9xoirWj2YpCxlshOJTX6yPZ/309vrqV2mwUqXyfGCykuX+K1cy4DKhLmbsq59Qx9PMLV7/XM6n3b3v2v3JsxcuQ3R+ReshP+OB6KuKctY2BgUMayj6zJYKrZCo2Yez6qFkdf76X/m6HGNDlBH8Ob3RyvqNkaV0uh5TT4NnmuRle1FrccoqPiTpSKXLwuIyXkHKswCIWn7hLqyfUvXGL5jtX/1chPl0f9iIKyHz+fzVrndXj50a3niumqpLKD20jezlmeWgrVaAn6UHjBAevygScvidIhz+/10rKb1jVVbGr+oxdr5dPmdkiWVEE8mCTruzPIlK8sbZuBTdTFQuyUZFRngHxN8rwP2sAd+sB/psvyzO513b+cjSSxLwIKh2Yy33eF+/O8r7N9xfhzv92txajcymuLZjLfdo8AyyZkOjFqkuV3u2gDbapGK7DLou2MrOH5T56dgIJ4X65KxaXrp0Fvq2UZLWyAHsTeNNGspjKxLzp10Be3WHW1WmOTh1dEQIZqJLs/leC7RK8G7lyYoCGsycT7FhNv9OC3O3flReTZezgrTWHYIVu2tH9Mo50pDfanJ2vXrdr2Enz7+86iUvnonb9RYtgXNpq6/T2vHxXUSHUMdjWjh+BWW4ON4KTYKL5NBxnRbayZ6Ynkb/IrZhcJPkJkv583Wow4u5sc1uPCPx/f1fljdmffKaaBZmWjqh63Z9coxo858NHW+fnwUp5eRp1dDM3fL6NOF40OcrMSNNKsYLQXX5VnUzNRkAb7Y0+TPbGZ+vLVlIaeOsZsLfuMtydVgaP5qNlJAUhuZi3CWxuTT4Osh5t2KOE9V8Y3b3CqyhdKj8PI6jKPx1WKl8iwjh5o4QH6ysH6Mo7oPmr6M4+NZP3kMEQtRhq0qk2kpqmG2M52kr/upWMKdWsKYZzjlfUIyu3bztEK0VS0Q9nJ9W+P+laV13Oblid9vbjjTW6uBY0Z1KdyJWRkpJ9IoC3e2p5FbNBRM/akCInqVoePR1spIJV7vZdAUAoOtEybmtmvBymjk9XQ0FzrbWL0gI4vt3JWdRr/eDtdwSuk0sQr83NJURSxEVyK4iLcwYWIpLz6P/XVuJtQLpZHoddfQQDAafd3Peqx8Hml9DKklYQDq1aEbzqWeDeOAwvPoO2vRmTdaYPQ84jr0Q7U5rhtQ87C5UIMuD5cQDTb3XSS3fRIW2bzXekJNIjbMQEvSi41aEGjV+dVsbfbBwvl4+dDHxSiXelil6bEMaDbj1eDF6Lx4769zOUeNmqNbJ2GwMteni8y4qgCNduv5TEXuGP+tjxGnkGU/W1mtt1YiNQ2vZQULpz1JwTZywbtND1faqKULm0YtM5p/KkxV8jay8uC3jp3TPkTVH7WcbqO2ooYiayYjehNRsbksYfRbR3W0Mp2xtS4V8abbLd+rMFIeOUaCQ9ut829Kf94imraSb5DOZc/DiOPufrxPM6+6S4h5Q8/Q4B/r887KuBMZqz41e/UpfTnwm5tsPs6nAkPUSg93Iq36cfyWpyGnck+Rjm/XQwFrl/hGSx9tGFaZJq360uVJtAkD1fKQEeZWE0ZmiR1Fer1dr+fjrl4Ek2eBN9zpfp3Oh6/dZVcGVMpLMjSB91YUMRrVwEYPkP1u/1m+OoWkBLyTf/Vk41C/eatunnnYs4X/fP+uOr9Opvg5GGQ2gjl5LLADylPnPSn73Xn/iiCx/efr8vtRZLWNdcpDA4Kuo606+91lH6KP06FWOgtOh4wIKUg0GDn+c9wXJ6BRIbLnYX8VGiSX++ITpBZyNCend7+soOX3CXecmuMT/Di1eaaQJzXzgiog9SabBCM1BuWN1DCFPpCEMDRgAUDzBnrJ4e4BLJTs2HTxIEOw6fItWvmRF0iupEtMAmjRcrknGojH1MmRiAp88kl96tTz6VH6ZNCnioNo6k1l6dR+71F86tAskpZfah4Dd4JPUJ42dZjBNW7T420ThrNNT6NNTu4C4o8vM/0qPXBUztG326Y27zZ9O0gakNftkgPfJY+6S0++S98VCUOXD8tXdKnZrUuRQJeKNF3qC0YTPBgQ0O6OznbsU316vENqtx7ST8Z0zSMYNZo0gUxj8Sm9cdMM+JQuIXwCpwcoVAxiF5MOG2McfgvmDYNOI9NiAQC7b8F7YWHZglvDtlgpaU4Ymxk6GnzC0nIOn8A+AsYV4wbk7fFtPvXIG3SjR1XE9AlPA7hBg8PVtOAmQZe5QUe5wZQy6PaOnTpppSOmAwOG6dIKMp3Ln8ARAg6Trs2f8Ft8G6otIS5O19Kjv7LHHSFAMkDIhd0mWR5wLeDCMEOHv8N8AUOCAS+CGTBzhgQYNCPezIhnNabqSXB28dsesS7sjcmebdIiCBMHfCWpQ8NidlqDvdGk/vqwS+JT6ty3tsfPEC6C98I6WMEeabFJhs02jXXgCHFgBsEeasE4Yx3gkx5sJh7f4dNqDJ/Sd2AHtWBIsN7jZ+AwwS5qPa7A98gL4Dswd22L72jxHa3H36UN0mLW2S7/LK1G2+Po6fGEeozo0U/TgzWmT/ur7Yd8JAH0ifc74C0M6aCyA57BgHNtwF0OaZXZETNiTBuiHXFVI9ruR/CQNJm5Ke1XDnwbDruja3AgNmAkwVxzmGvOOPws7XoOvDrhUzqDTY+/A6sIKonO4qrAsONafAfem0Pex4HZwrVgagE7hWvBKdMmSK9rM7MKjv8uc7F0+C2s9HABTIKQeGPgMls4UMgyGXBwGDBvgFvI4zTwwCp4A34Mg7wUSvHB0QCvicmOBXyNdEJ4sMt4uAm+zd08G6754jquAA+jVwiPzOCTqcQo4HK/uz1f9+NUlE6Btu4ulgjEgZbk97vXo3CJGxm+4Mh3oAZzYzrl3Iiq/Ih8/dhiBN4ydl83Jni6B0NY8ALBOwNnDwxhvoFz14BBpcnvkQdmx7uGl6hOJ966GaKM0+V4YIncUSZ1+OuZjRwvH+EfHRB71Sbj+ZuZTaSWm9lUYckpSywyjnHTx7EEODmZWHYD7XtcyuYKPqE6DkBVZtu8beNA6CnumNXjrUq8gg2sx0nVtywLFkzei7jVytTXwGdL7HhZSqlqGUlU0tjxhxSGI6NYhJgK20mLInPPzaXoDFGJyI4CXfefp7MeaWRbqHM0hb6PeZc1CtTJstDY0e+NozM/TpGOlYUut3BKMSOP8+tDJwpkktBx/Ns0+nVb6t/qCjqZ+jHowjMDbZWMxjSwSSJdbOZrcmBkctiLfIrOvacQ4OkLYim12BRku5d3tJI6A0b0i5Zl9c1hvwTQ5EdKGMVA0lAM+YblFU2MoiJpKBh/BYrR6Bp1XbS7b2VkaQnXtiQusvnhoa9tVaqp3qh73Fg3hcnD8RnxMrUMl0JvNrQX8N9hk2Thv6EVn5WttSWjeHtQhWyQYmoo900V9bTiNlGQep/jx+05vomlUlwgSPRnzlLkGRrExE2H3yLP0CBKbSgb1Hw1uvtBpuYpZiMNrMzXVsFPup5vYspEZZq2CmzJ+c8WS5f3azX1Ko0Y2hkYjVSLvGpiI2wLwT31GM6nStmvs2qXp9W6MDrmtmNBVQ1XcJyR57XP18uR1+km2RtxVFOWgWDnoTu1xkZRvRi+bsLI4z+3cBuHR0TjaMjWoBjR2o0z7vV4Rvz1+1VXzOVVbJ3W0/BKpaVrFKy2Q74IjL1jjvY29rHZfsHj06mti/NT7Itxka1X1nJpCSoOTM72Yw0ek50fISJP0a2hFdnw32+Fx65cMmRlkHPOMU2OTen5Nls/PD6v92dcnNWpraj5BgqXi8DR8/F5rLn6quPFZy7dhEu2HeoEPd8CfkCmtqpERzFIk5mweDZx5Eb1uNIes2RLUktU4UgyGum4987NrWBbRrHi0D7nEE4EO3qPMapRfOPmlkhkV8PGGMU85g3tkCCIDRnQgIV5AFVtQ4vVm5AL1eabqlptShxv5Feul/eTph2Q3VUg5zUjxYPMJmo8pt2oWlAx/RsKa5ptRdxmndqvU70HI4WCwU6tpN0rzB73JSYbNe9KeRJjyrXYrf0mmkr7Y/mYehmmWsuj7MnKa43OVEeX5WfnMv64P+9OX0W+S/L5cY8mWZgyZ4UF4XIOFJYJC5NPXFiQE4+2RUwW7l+SeET5VbLmb5CoNJb7RcHg+bSnbSoykB55KBdziJdn1dOTq8BQVEm08NwFJ7yeO3MKncVD5NJKFerlFGqMdsQkY1vNT2KH39yNw2nzKp1YuZjTPpMO9mU/TPtiOtTTeY+K8PxvKrml8kBKX6fkOuj9UalMpVuT8sUGJVjgPluU/tI2mEtsqKYBvZB5+dOGkD7kghHqO+lDqhFlsveEEnVgQEJ1AUxIuSqAUkB6UCgsDMgzp9Q7+NOyswQGcqRmQPYHunCwZ2cy7vQyQJONttX0q+S1+vQGfHpQPsUqbbqetgFYKr1Whw/pLEsp8jZdRpuKOGCsbdNDALt3mwp+XarfdOk1dekhdOm4RH23S9/VpQmA4m6XHjiKvKjAgTS8w5em8gfqNODGgjZCn14B6nd9KpT16V2gjNen6Y/wYEjVhCH98ZDeF0rEY7r3MT3eMf0xDi/UdUeUiRuU8htAnZsEGjFNh9+i3N2gYNwM+ASQgFx6+RNIUoHAMSjlZzCOgbwJ5C9CyIy/gzyHRSc1qPcNFp2xqWxqLMIri4UMERkDCQYDwn2DErNxKJUDk2OAxTEeYAwsLoMisvG4N3BBxJJG+oRn6nFvWCRRfD59SoVHA4RNFGTGJ1DLQhAFqdcoT5g+CckTqPAAjIFVYTq8/Q5X32WYFGYEitKmA0yhQ3qoG/B3mBG57x3CEAbLwPSAW/RIKPUZlZVBFkiagbHIgMfJDCDABrecAfmQASTfgGDLDHgL2fsFy1yIA/FbzDpIihjIUJgR58uItzXijiAuYsC4bsbsa/f4WcacYUWBWNiC8Ns2ODcbHDENzhgUzW2DQj9WqAWkyJqMZ0tBtMVatQAXWYNSvsHJhtVoc5u7wXdkyJzBt0GAyGKtWovAPp+QGS9nAViwsOcafMKV4gi1aOEIfgpAJWi0dwBtOMjNOAAlHCpzWOcW5QoLKaJwuAP6gafmsx+TNmjrky9jcbZaNGqFT/gZ5H9ySzPo2S2aQ2yLt99CVKcFCASQu/AJFUY0qkBiw7ZZ6gfvt3NIVOCqAJmzXQaQALEJfkfbY0b0eLo4rWzfI90B0tc+S/Ng/g1pZ7BDRoVibgywh5SYxdlmR1z9CJjMCCgOSugO51uIubOsT3KsmgQaDIcBfgYxmiZdszPw24AqdQb2sFKc8fgtgCEmvV8HkKkz+A6sHmegxWAhEwSQnrP4NmBNnQWYBfJpDtA85wBccQDHOPByZg/SpxPHQSjG+RY/AxQHrp1rBZ9q/pSuHlAmh/kXFh7+DnBYgPQcAJ8OfpsDSM91gFLgZHLw3RzQnq7DNcN9cx2+t4PYEACersed9/gOnEcOc9xhPju0eTnMYjfgOYOZz8E9C/55GgvpKgf5KTfi/WJmO7htbkQAMALKhPPDZcGqcQQQBM5/k/ZdDwkzD3E5j+KNbzr8rIcVePOQmQvBBODHwB/jrPAG34G0rwcQywOIFT5hLIrDEKvz8PDCxorWuSZ/QhiTEdAAw0Buy1tAnhF2eQvBIKwUD/FAj6gsbN74BGkjSHB5l0vbAD9Bos4DxOpzWAQ5Oo+0sG/TzPGIiHybRYlw9R1APR2lAEDEHQvJJXqlkSlMZ2izTjTy+ipKlzJobwDPBVzaQALM9LTdBNzVumqp+hZt3oChpraVV5oN6qJhN6hWP0ock4ezvGOv7Gw89ZWdMoPdqfIhV/LI/N67SI5TYyORqSlLe+Rg6HlNKUiWY+pU8n9jWkSDBaOWpDryOJTCJyw6JHEsh34F0xESsW4pnbRX8xf0HLygTPyK1bDCjlV2NtKtk50SiTGJtEoDG9kzGKhdhldWNlJn0cr6gQQfWPTijT9cxTy+VjmQ1Qze3TRbKXA3kvXet1uZzTi4fJB2kI2MkBpsMhQY5xjijPAJ/gdgtZztWnzzag9UpOXNT89vMrGRBu1kGnRrJS62rm//Oe4LrF0jH8cP0zLaqL1N9UZ+WCLRxv0YNoR9uRF4lR/e3HWP/2hYroQYWXTlWC6Fshg5XPev+PPzdcVo16g2SLNVuIuWilx3q2rPHOBwjUJFqnwrXyrlh1jG1ZjjlMJQSwl8FwtaLEoheNqtTaqykUv0MpR3ATQ36KcyHfIa3ZDjT6BPEREi8RiiOsCrk//lkLZ1nDsfF1q8HVXVb7ZWThx+unxMJZrK07ayE77dqNYnQ7LYHJZR5dQfFPe258BZ2IxiQnP1us6uN8oal90A1MJiOPz3nyVzkyQwcO3Wwb9YuTMyBYlW3yzfLIYmWFj41b0g1FMUHR1lfJyZsQQvbW3ZSO4I0/5ga8U8KRuPU9zH5RQWIxsbu1R23Jjd0cz0d6qdXNZEN4rVcXBtM5fttRuzr842JgW0huR6jR0S/oDhIeOPSC7KrqRPaCBrczMbcr79xhO51/CYg1X6Eth03MZ5V/Kwe9XT7ilb5iKEVyFeki6P9QgPUaFyHAs8sYW93t9P/+hrkruP34hTIqtVwQIiZnsKWsd0bkKac0ylqJwSRtrKNLmzE6lo+N0GaU6D3mHjc+kCvYeQrnMWvUZAqDgcC8Hd2r67mfs3zGdN+24lTmnDHUg2yvfeSYyCGXgsJw1UpqCTftbIG+elmefp63gtMP5ydY58Es5mPj7ux4/YiLIGGMiwxo0cqT8bKrQFeoWw4R74NHh/PunBCrvJ8WdpsEYIV9HW0uPhYjiwWMXd9Qpew3MIsxGA42qYSik0YLg+UzK18maVTiUH1kzDD6mTjDQFWOmI9pRffDY2zZOvsIyKoL8fFFYoa5j/8PYm4Gt0BDgE1/aKeYMKscwGJ6qM0/74J/xqoRadpHT0rqg0iVreNTaZnEepJSbFStM+PYLSDmLpznG40GS6whTZKKZINPw2qBQ0aGJtfngWEW37qKK0FZZu+w0l2sbaslIihpYH6YuhyMe98hoHp5xZfsLNRq4qj+bltDO5Bdva/AmoFx7oJNM1r0+1k3gOpZtt3K9/TkWYqKDKS5mWGvjv6/rcfbx296LHQLVvdqiYdDnC4aHYZPh+3L/uj9OfI7JueknYThHB/HCUht329Ki0LSlMmXcc27ZYmTcmHS6JtdVSor7FwIrCWDbfDrxXZRr92L0fS+ZKq2CwPU9jzxYm6kS9D0rqYotypqUqtdJSjX1xUEzlvFdxNjOnY2ttUUa1WAGtgqqpAZ+IAX2I6SnR8fJ9iW1xElgqJGclJ5DveF50sjQpRtyuJWGtpKKz5ofVV89fxZ4lmY/mMddkZDUjWnX88OavafSf63739joX9GSmHRTv1Lh9CX9XyjWKkW/Y8hdq7XXiBlKmOwWgye8GgoHDxrPt6pGi5lcWFABGAvV3h986YBB6j0r8ljeTm+AKgXcvGcPNBlb99Ygqhf88j5cVfXzkrRZvmgs7zEYiK+hXlBY8PUqJJrlZe8szdJOdOGnL63DqOtgDKTUSrexBR6W4Ty5En07CPr0UPHVAIvoUTAGK5BzF6FM9FQVk5ywFcnxko1wzUQafQkmqUILfKL4VYyGdt5ZOTsPO3cNbcYLJIN7R/e+w15Nf6bb0NBV8OL7pjuhe9g9a1Ltt02bPD5+ATWloeHg4xpansIlFdysHIfpi1SndUc7sw/F99zo/f80T9dd6pnpVW2upA5gMydTmr/ew1b3uhdKfkvnsqDOYDIbzBzHNrxD5acX5UfnSHQ1tFmurNhGlczfQ5rQ0/KqpKTqVQRmoIMUyvEZ7LOuoHa1NLgZW9UAj+y8cZ4Jdxv/ZnV+6n8SrU4f6QmF88CdXjeEyxgUV8QhwDuBzIUhiO+3hGBvYdP1B+vspZ5hWzdginYigDD2/gMwCimgACTTg0QlPPXPvAfaaWcGQlBwQbADnHXxolCPAsALYvbMAXVnAlpDlcwB8OAsGIWT+nEvgBZeloQUrH6BMDiAuB04W1yN/mMEd4MfxVO9qfvqV9sFR9viGm+YzezLwrxI0ShCDHpmzxVWef1DZhxaQncxAKNoGfrjcf6FKLX1S7ibM5nLlpdKyJ2VAWn7OT4Zuu/txygOtXS8ZYFK9mmRlI5qX78DSTuPZUE1we5QsvHYAYnUA8hY4ZAscsgV6zGbCctC+2TGNdSB2cz0waHBuHMjFHFDZDvRhDrhrN2AhYQE7UCGGT/gtGmBw9Y7rDM/PpDhlpetCE+9zUu6tyInIfKV1lMA0DC5V/uSB3GycOY/n/VqQXCgXOkPlE3DMgF7S9BsuQwSUhOOAaDQpAhtL8RGH0yMKPR2+jofT7h6JjspGMdUOzJf06fE8XfbPEC7orvpRddUDR+gzWViaCd5TSoYEDSguTeE3+Km5gSvoFa6AJugOt+uNE2mrTZrewt/wJ6d91NX9EYWleKQNpXQ//uexSW8lgyNPj/5JaUjNT1VmMTiRsfBNhnhb6jhOZlfaLUp41NIu4GnwujPZO0WZQQuiTDxJppwMpMEMil3G0g1AmFzdlFMcyrQgGpPkahNXKzSDkAF49y1NDkZbMy9Zkb5UIj0DFfSqaYEp2cgOeI8FRV01cnv+/drdWG+nV/q7nkZ4k51KOkmJSnlPefePlx+2MMWjRb2wWQT6p4BOCd5uXNKsIafDZAkG4HO/5DBrVUaLpsXCOE13MLSKeyJBfixaIm1H3b9g7PpeEe5ulSJn17M0QRh/u570hj3K1FxwPNhmW9nLlOa7Q6eba2l0frw8Qsh7Pu4mJb/z7vFZvEeVMqW1s9nManxrlYIUDcfn4eHIOJ3JZTTqMvjreN5PRbO8LNaBRjUz9g5ICLZoY0L45hB7OQvHDq1XDkzlzqItxeaiG1w81yAasjlCQrSJb3MJMuZyK7JDo7ADo7gH6N0nPIPnWIMpOHmsWHxG5W+AXA4dz7md2dNEw/Hy58/uHon5NMpDQXZD1E9n3+3z+BVOCi1FNCi8L/3u/752503ZsFGhV6jfc7zfL1c9Um2oTU9dghKjoNBdLRrfGswxtAVbNATYps+F1PReUWb1hjsk8dsZsZ5xUpko2KOvIFpZsxk1OlYAJ2tqHXRo1nQj1gNYskOojxFYGSOalUBw4htwEDVppXk8LQ+0jm/QSgKmNI/WMm9oLpVjIKXATEJ4oYw5pGgvB4oWb9NRRI78ttL7sZLhp6X1lslEpQg/KMmzrblcRUMYp9DrdvsWYsQ0lSVmsJ82pHKAnLJzNnSNfnzhtMvxhnsGeTzz/uUUNbQEtRgKuwUj21UVVi5Yuhj6ISbpVExCtbtCuHv6ivXKlXCJLO+7LiUlXIfzBzz7DkQKrqN1aaYbpToSoEMB1pDM0p65OZAWgU6ERYOVa7AzNLTwP2Fg4pcWEfgoo8sBZNwt33hnjZXr5XYPT7EobTp9a1QgaUL6rNA9TtaKRvS6d6h5tOlGvaOVwZk9Tx+4kknG4pgNpz+gOdg9HcW2JXRSlbZRhqMdbdMoTNRoG0dFsNfwtzBbWmqOOiaRwYR3FCWQ4VZbB7nS/6QIwmSr2gKmSg+W1v6nSuzhWBFDlXhc4ylD22yAVd1H5cdSkVvUg4u9ReaYwPnhDC3EwM5UzaxJG8sEqfNUBrNmqDJzjFK0c54iG7S9zeyMdGO4TuaScJr26IXkVp++Vp6+9PQTVqZDsHCpFCMdJYNarExgN7UF9CrHB8rxDmwI6M62PY9xZuskndmpTpqNxz/Z0Ni1XtYHLXSdLCicrPnpyT320aEvUDdqztOiX7KQmCbVXclw2ow02VsjfVQFXCDBLdQu7EI4UDM3F4R1Mko6YrysXqslD4q+rgUjQ5c/0dzP+/G5/4zOWKmX5pU4ckv7giYDRSZL7kZ2pAflNDT6TwULncjS0BdyOp4PxSpScgKG7sSRJ5EDOuRKGikK62dpd1licl4oh9AXUTFZ3QmlH+E8f7jB3vrCeoVBNfQIrpFJtiovDRYwiwqrA8e0A1FMuEL+Ds+Tm3o/3q4rf9dKIJjraP1kMvI35uFTna560CucEs1oBGPldbRGJaooB+c8dHc+X79jJvT5edXT08r1vbEcJzOLX13Mb3mkekNbS2cTKcbiM10W3kYaLs3WwlQI/18QRnuVF6Vd9LMFDX7pVSaSgtiWoRWwlNwr+Ry+xI7CmJtWe74q//W56Ecrl8JQJeLpFGd+T9Mqi5XiWhQrdGaEAkMI2NG8o95YslyC84ya9Ej3UWcs2SluT9Z8+qxhtrE56kPWyUN2TIFdptgCAMyAyS9scqh6ZVRJB2QI1I+6jR3scti9CgYDzYa8dQNx6PUeXvqEU45i71+rYoTqpKMV6NnazPh8Kg9umc3kO/nl8FbWvxur6sK0FDcN/ltp5lLTw4C+LHblL59AFGYsZZWfzVd0370S4ABYx3B8wGxqXQ1VWuoGtHKWsj7Mhs67N43l8VIwyCAtaBqKtZwNvTShieozDHMX1HxZSxCEgT1NHi2mH8dVitQ3CiDUIlGQ68AgC+wp1360j0RSFrgpppASg9pcDhFGEXaHdTZYqUGZra2lLhAs5cG94V5mGHAq/MS+ldtK4tMcMuwOfFo0KzqZjeZiYH4tlrdxyoejtdxoJArUF/QBcpp4tIz6zfk/Ow7FE/Lq2N/aZq7fZbfLqIIU7oldDjPqSg+WIcnm7a/1BlRPZUNL2NNgAqCRCWFLoSmThcLZGhXSOD16VMGMo0msaG0VkZhONYhuXUlMN604fWSGfXvw4XQvivCjip0H2tkVx9eAtfKU6CB3x4UAop2UNlHzWUGEW5orm8aX+NxGdZZwqZU4+E84JaOnVbwBmU6iyYJp/ERLfjwUOYhWeWl+w+W8nB6fhSvlVLLI0HLzPFiQK+gnqMIninR5PwWPt5qxkhuBp+1176d/Jvk/Qbuzik5lmOs8v5TzqyyYK3qbjnY8vF9370WGUj5Cnvt9L3ttVFt/RwtyYdzbKRxTF0Iib9QS5udmWEG7vbrnQep+2TYLp6UeBQ8pWw/uYZ81vT0P+a/3j+NzwrXpidKricKfMYbXQK7qADLcWwpWrs8ttKzqBrcUvlM1tMJqqY73DRdcGVttbF7uyGGXA+UCmINtltWmvcPhS742K4Eq6cyBZcHO6sxQQLCe57Gu9+/d/VDsN62skvuOR1rBqT+wCa92THpuLMBv3dAg73vMxCWguADIxWZpaUARwA9mwbMaPoGvGFhpSN1a2LMQ/rUGxCQg1LDgm7SWqkCk+4k5j5tm95ILgjcRw0BM5egMzijHs3eSxseYKOfz1OSVOJSIp/jBUpWdSiLhTQvlt45GHKU1ne5tJZzatNBf6KjDku1F8psSduwkhdBAYW7JyIEJxShdFZqkSmawFNZECE7xI400Nb8yVXbJOuVSjbQQnwzVwA69IqHKqtjQ6nagn3Hgn3EZPYZox42gvwU9uRuz3ESTcT+gkoW+BLqDPKJM36CjBLIB3lBQR7rHmsKJUqf0lroryUYlhJA7WEO7NJKB5D1vTQKJX/YNjaWyyXXrR69Urw1l1Eg2ntffR+0HKsG+rvtpbTzvp1vhDg9yMlteBE8mgo8wC+4VSZpB9fC3tKxX7Q7qVPYKstlmxF7vIEwPTmgLQQ87Zt7p7dWoOU6KIpUm6OJzRB8FcgdGBhh4M4DMQFqO3hwDse8Q16VPYAw30KIxNovauByApt86MAF6WPaghhqgPg3heptxIlBvcDbTRQE0hz50B2U+Zzt8QocP+Psd+Psd+tUduJYdyAvD2gGwFAA5iN54B+5mDw5laG14T4En4c3swuQ8vyo7gG4s8uhi8rgScDi7llIox2+YCiAVfsle6YjylagtnCemoWln0OwD0m+n8OrSWnWTUZCbzTs7z0wzRWZanpuUBGoeD76Uov4mLWxdwfmsl5bkWEKBv0ObG0eURWNRhDvsM9lx0g9YOT3c03lCYbHugRnZFg5gtR0z8CXNLxBsplWwOZHX31q8Fnl0ALWK9YczHwz6mTafH8HP3Z/Y6RNTJrfdvgT9KVZIgMOgNBE+sVA4WI4+bM1/GWVFJ+wkG9MjFi5Y/tmr8IpmJ4OVfYjJj59Tbq0Av6kWi60LmSTm6zfTqZvZeB6TjblRpkwVKyKLDYdptnE/nndrl8ko9m9PMSDZinIsxlZRm2aaWODAB0iXjIAGjYAGjTikwVFps3/JBc/z5VT2xHhMSjeOZoyilUTYVLgpsdNMPhgcThBEcxA5c+3mPJq/YcIF7q8F9ZRWXvUbIeaT8mlLAhpaCdYG3u/Xr8rR16ujD4IgWYCuz3e8Ne31F62frJq4cCMghhO+J+1BLRXqnL/nT1icp/iA74W7FbXp1Urn7t5zqlMWnDdGSR54S7P3aXyEgJCd343KFOD/Nvs0tNIRzK82j1adJMkxCRMhraoBRf0R+oQjxHqydml2m3NnQ7M1lxcyC/2glFi0p8yN0/Bqf8cgQc4Wehi2y58A3O4plXe0PwVj1/vf+p7r1J67MbFS9/B65qrNEowTHlEyim6u3Zpxx/f3cKHB/7ldz6d9UaFX6UpKeBqtlEwNo2JqGGkFLI597j70ejGqYxKHdUOzuNFKFdvbKpGDrfTQc0KMVV+WVS9rYwevwcYGyY4WzuiN4R/3XQFSkB6TMZSgKYz9PMVs8/6zeAnKUaGYqTB+GlFuPEZJFHDKxjB+3ZAyKjK2jRzYNDZy9J3/FhY6ZWHjya0uXHV7OFrumoeWQEpVcabYj3ns9+n5GZyz/e/i+1v1/RuXHjbr3Xn6U+02KHDC1tOLu32Fo1rm6bzbOiM3jgsrI0TXU2D9YqV4DaNit+goVnMaHVuziupXr0rgzdb4Ct+oqttsxS3T2NjfsIpDjVeOFzyBjbcRdxB9DzJX1VCY4DJ0fcCqmAl6cgN07Ibk+tkRyPcRlEWjh3vb5cwTWoq2DoZ0OZcCoTMqUMW4tSy/rofX+RihJXpTVk0sW7WI5+V6/5rBfdWuOSvRUY6TwQdLW/w8VoLBWqpCEK28nrfXc02Q1sip7hrwzECvzCGh7AwU3aA060ybo2CE4UDwgATDQcfSbdWAnmskjJebqUFkbTiaIJgJAfXv3cfxcXxO0gsq/amSEZth4wytqSpuGTco2no0q1p0q4FCyy86uv/qS8ogTL0dStEKOxV3plUn6caUnS2sulTk87eUUwXjU4hchGgqLKIogsmKdkOcTBWPaRYZKPAZPHHjkbtF4GXQtW48NMk9uGXbLc8kXskcbpbhvuqRooQUi4nndc17pxh4/NZmNjm3uoFFViG38ku3++nP7nkszjYnAfpDWr3D1glZ54wW839IfHDj1tq+vd7CvawuR5J7pDhs2Eo23nffdXdXzXQKVooWUnPhKmBVNCWOEp5NNiLU6hD/WC8XRdw0UqaPZCIGMOssgkIwojQAcIqDmK1rt/I76RvKIKyVE9B3G6Xs5yJz9VVJm5hGySU1W3Noiz5fuYxA4ToIvDsQwzoQwroe+Y0eShsDOloGxJUD4krMLjdA+nNAzM65uKern32s45pPpFN4HTQrO0vBq8Leev4Nav5tXVLpnBinGoy2UhAxZvnRQbHKQdlYj8spq1a1nMBjKr1toVmeEzfqCo4zyP5F2wJI0uVPm0bDdZ2PYaGXbDwKnLZVaFn346u9u0OuoqPUe9FKmPbFoaryT6DNHbdC1aWPuR7yDBJwZx26vADht05QaG9MrDUa1UkorBsokDYOfk1ZdhaVybAoO5jwKrNAYdrc0ireqqUl2GstiRHOelVp3oD/PKeKf7EiW9nxZLho7DT8GYm/V9PFqemy8exmA7EW9CoJu61kD3foD3YdHtnmMogb9/fx9PFZpndVLwrF2wULr8tMYVBk3lW+y23l2V4XTeJmFKzLdZCw7mg/TbDy53RU2C6VFYZAeWzuXz4ZOH3gsTWQ+DYQLjYuo80N3EQQ3fnEtRHbCpdPHN03gTvjwz4ecgWt8OtVfM5VAz7O17fdeZLceDwjIuSjUI9r1GbEXYGYoAtTu8hTtEqcl9MPfNyPx8PfLUoGr5CPlooIRj2926rpovcqxuDpvtcac+lVYaDleKV57MzNFksqxYmgInu+P0YrFX43r4gcWoobnWN49Q5EAL9sz8iBLEsCat3Lv8vPU6Ew9eUnurI0vdOSgkwZ5jgmNgC4aCOzCJegXodGy7SosLqAhkkVeOiJZ3kblExQMcHRhMpJJksDaAWYlez5/a/k2qUPoIrKcuvLB1CyQE09XYZHVJ4qcplHNfmHWXUcYuepaAc2QDjgPu066N9v04EGZpg2vco2qdmDiq9NBGBtes7ADoF/rk042zZhD9r0TlHewZnQJRBEl15ll14luCm79Ao66DwmeG+X0F3YkdEgB6HTLrVxotsTfMd9wmL1KX83pCc/JH4SsIeNya0PMxNTEzF802PeDvlT1l4ERTpU0026dWMg8GfSlDLGYQRo05G9MiY97LAUgEWHyozNxwgSUGiVN6hBGmBCYuNC+iTkBJNlqN4bh/ZDkPiFy8PPXM5e4LdArWF+RT7E9CnBRA24m8IKhn4t7rJF/zRo6QzmkIH6sAHixHRpEpsuw5bxJIEPNF1ufQTyHLPBQAXX9GCP7XOLJJ5kj6sa0FI8oPcTIAkDFmyDUM6ApC1sUCDDx8wZMHOQbTaAUBhAKMyI/W7EE4eCWviELS8FrOEwBkYe4YnBjmig6IxN1lqPT2lGWNvjExD0INe3ABtZl96HBbm+BWWUdRnNCcp/7KEWcpbW5e/AJo5uGIv906JQa7GDWmyh4RN+hlK6R94eNBrWo7ze4jswd22LCjWA8bbFHbWwjA3NdghuoMccDhNw5qC3ocfh0wMi06OPoc9j0cfQgwd+QHViSN62zUjPzMfeAP3VICfeZBgOji3sXA4zwhmUig0gI8Yjiw4Um+lyrIQMPFxnnMfOZnEHxAp4ug5P17UZsYbvaKENCNZx10LwASS4rsV9YD9wIIJzHa60g5UeB7Ux+VM6WbFTe1QXPHpSPJ6BNx1+m1aoB5LXoxPFoxPFGwDrLeQW0Hvkgd/1PhOqprXg27S6feZ5ayn2bnbv3nb3TYLxTvmKNFEzG0NloJKi8SpFs31Rq1ajXnb2WUcxITXJQcnLEjb3tLX2bd7OsBEBndZiEXbJS7AdtqQe7Mo9tqQhRVt2ADvTQEHny4Ue//sqSBf6UYkV0OpDjb5F8R1jQ0uOmcEEbPI0xgTs8vTE5EXLIS+lpMuYBPdmMvfXCsXfK4SEpWQ9s7GY8FNJyzw2bW7YntLyTksh3eryb3IY4fkt/y520vKDmjI8Irg38NLgtMBHgzw2TuG0zWU6/eSe5a4yHCU2n37pTeG8Qb4QkwucRxkznz4g8Yx8Mmhu0WcDUlq8+bQHgasXxLUpihH0zNhg0oRIx6VPnoBHoyp2qHTvPnlHAHq1aZ/Hwdom7wbbPRZgiwmcdlVs+mB+btOWCk+xTe8Uydcu3XuXvHYQ1sEz7NI7BTVol1wTiBHhiEA6FZoeXdqTu7Ql92kP79Pu0Kf31afZChLvIT3wscHEzOEw5igcbhzYBiK2pslFxzGHGggcELAYZImgRh4Ln5j1CE6gKp5Dagsn1yLDZNv8KeeuUPZEy4oDb4lDQIC5HJk68ClZcbg3j/vweRE6hBppToaFibACoUGbs2IY0XoEJxiLKRWCDoQkI1Y6khGYRAahq+nwJLvc24hgosMT6jKfC+6yR+kXooFhI0b4gTvCeWPg9JmhyfsOsh24owHhG+AswffCbxFaDZg5Azh5gNs2mUx2RCgEiIvJrUvgyTYof4egI1NOoW0XOFXMTovZaU2WGfY51IAeieC1RpAAKw5WkJixLstlwp6Dc40A14Kv3qJ5ykL5y3pQHWL7tAh/rc/JI4ffwotA4sZiE7UeJJUeYY+Hj9HiPjB3LXIzFt2zFqGzbXOAkb0XIPQ7PLU+C4Vmyk4cPj28oT7tdBb1S5u7bYbkIFuIQFkEvRaZlOADoXYCjuCmy0EHfoY2qybNPweH22FGOKRGHPYmB+/FoeHbQYTVgQLUmdzWBlZ4SMS4Focrnq5rBR4Nn8C02CKwaREytbgPHD0h6MDPoLrQAXjUwQpyVGGry58QGqT3FoIO+Ggen5AIRPu7h0fiEXiFUANWEEIgBPMIwTwa/0LQAY8AHmGL8AiHuW8xoqUFnsXFq5AcO9lZEu6LFZ9mCytCC0UlGo4Ulpb/3BUUCsJnRkSNRtOcTRny0kNBHs6cgy66s8n5d9i6HAIMZxH/WgABHKZJLiq6nE/HVHRtdvmQIEZU6XJkiFfDaTHDUwjO+uG06g+SHDiGQsHm4XOotwJaWMWj09NqaDBSEXrrFIUOK/KEsSv02KDQYy0CGmzb3udAgfIfB8ufSdinzsUt727RYSZ23jV2xMvWK+8o0jYO/drdirGtGguixY4HiI/PtbiJUVRRztFutjD8dAlh3bMAkMi3szH2do9Q0FoHWVTiUvNj4wZqbavGSoGTsAAyBCdtqD1WD1L8rkedvkcwhQyuGwDkQbbMoQbggDxzUGEMn/B3uchDteXCvdTYpZW0dUtr2mF0pcNfQkM7vsqmhsZKXmRQBKecvm42UMxHKxF1HHNe6aa0ciJ3OQU80mkQbGzDiiU7Oi3HfmqoRSeJGj1vMvq86vSMWsPGJJ/AdxRZ+fn8KrgmlTAobcCM4yKEYLXPtbIeb1rKspYM1HJiXrE/0b6hSHNRPDZZwO5pFxvjC5LI2pHv7lsUK0rbh0K9YKJGG+KkgI4buasRjFSeXi9RvpbLborhp8vtpdN8Es1gLRWKijaqWUIJoFrSQ3T44xaegO79V8BPyyEAYXxBPyDRD5ZyaU4Dp6RgjdZeNTfwnqPT7rIrpp9V049dtnYNrUTQoZJiGvRvIHllW9RUkN2xEGp1/LAlGDLdOJHKzqgrGZANg3LWIY3hQH7uIMHsWgr/y1dQJVLx6rhAjGxcwoBa3nmYTVedGoVC5u9S0s4XFhSOlPYNCMKD4/PrdY4aRKUlyf/HjxRhqQJUkjhh5FgQtDeIotN7gj4ewrPcVoGuIYTrI/yGBs3VqGA7hOHeUp2IfPXRKfir3TMlXYdImdPTzcaCD7/A5iur1ck3PFACE2KpJOdzEko3UDKd0hrZiltZLQkRP9sHN8yVF9iqHp6eOrmng+DgvK8Ud+Q5ZTwNE06HsitRyUUaTw+n0+E2j1DnulJQoZ1ap4/L9T5X2YqTUUl/GuoUzgber+fSvTOKwc51lLH89PX1ekZCkYTovq2bC6MusTDGswowtmgIFD0wki7GtbTX9PQVNSKup8O+1kSiyEXDVKPXctmfX4d4ZN//hu2lAJsb2efs846xYa1KG2llVTMEKPQxx7//dTr8KtH7jXoolvZaTX9/PEy3ow0o4TPOsrkYqMbSo7oGmq2YTRQvVXHTb5wa8e/LNWaUS+B6fqrGv693iSkpQR7MLxZkQ0mFQlkpufSUjXX6+9qTVDIBbuMUjn8fMzb7yDC1og+O5SM1KzbvKtphCp6NdFCDIXoUX96VfGmvOgMaQGsaULo1gOo0yEpnNc2G9jCdLrOa9kUz9g+S5dUiwWnbEYlznOIbDmc0vpIyV1Ksw8YUPT1PVRURqXNrQBRnRiouo0zVdESUOt7I/dlkR1+PfKlhNPApwLE4mjLMFrVuh8woQZbVQJvEmIxXBP6Rsx3nb9G3LXPLZkjVWTPS2O10+Tp+BfeFStsoVsORahKEwI/A6pVSeNjB+bwlvdAyhm3QONaAohPgDocSrzOg3EHqwhlEFwaZMS4UcrpMiSwVl7VKToJzSlUSirp7kLYlUbpzRda2cYBgeM2JlNgk09JU2trKKqxvW0VxS7PMW66jU+JkqaoDsh/jadBdWq3dqxK39txDvEz6TodTZN+9HyM4bJa4K8JKmQ+mrcHS2Lq/WDanBx9v84ouu/Ovggww7AYy6mspWS4MrBNTKjr2nJsAJtbyDV712HO20WRiTo5UcmSKkXakTVyTnbC35G78LHGhNyrZrbJ5Y8lawV9pFLkGX2OPeZ9cZaqdzFcOtNtmGl8yrHQq17nh5j6illKM8fax0VnvlDLT5ugTePzI56iY79Ke2eQa9PIBVe4W8T09HR4Vj2SUWVLb8TP6EX5yuz5Oz2JBqdCg5VmQXMNj6Sslw97xpZktrXoaW9UlzKm+T5sVRZVH23ic8bheJczHQXGp8O1zqUcuAnsaWSnugrcvJgvzQacmsgrqgRqgXWzR0i2K+V4y46dyW2UCn8r9nB7Hr9tTDbTS4eqTVw0wbJ+864FyEgSjlcy+UpelVcUwttqaqWI57go9qk11g9r/aS789GDJdGnAWh5BTAYe886t89nSGeQ05KdYUp34Z/XDUzxaQ8LtuRHIlBGQeyAC3QhczYiNZkRCGYgsNwIs0GQYKODhTQIu+CaVSn0DvGfT4lMPKwAacA6FeKPzMUdILE0jpX6coVQcp8fvy/X7Ep2aP6dn0VCqZLEHHpw9YhOnnjVqazMoABhPmRVOjxARvB3v1/epL1R7bOKA49Ovyl1gOsU/TSm08vD6Zj0qBZmRB5sPkXArmDzUNusBZPEtihMArbSUi+j0uFzV01EyKlTW6PQIR9mzuvVKADjlwAnj76evYpfsGpXLBbau2TjKaoLwrVccDJTqIox+1e+hl/fAh+tEUW3CKPREv+GNxY0u7rSny4p9Q+nzZsYs0Jzz/SsBMupzMIShciHwfTReEaOqUtSpwL6BfN4DL+/txmSalPYqiTJ1/AVXgk+ndUrfK55OdDt2VDIkeuOR0yNSM+2KY6trlOQpT/k9Hrfd/b/KQ1TZDB7vLCNft8Nu5SLKE6flaf7H41W+IPkMluXUUhxANHCblJf17qs2343HN4kuV9wNVTJsNh5eDDz1Uh5U8/yG67TiIVJTs9s4KP7szqdDZPhY5Z2VLkewwaffZCPp1ClnQ9GRc5270+P7+PZ5vf4Ou52rJT6VxojnKfAHlD2YJRVjthv+0/f1XpAxdI3qzuJX8VzXtAfF9oYeEO8GgCLRAZMbXnCaeU+ZE/5zPV2qDC2qrOc7Gk9HA2seKxVNUb6ukuS1Vcu9BYgfnfampbM42vp11v5yJxGAvqckPlmz7EHyZgosyh3vaGiSUK+WgKTrzxU4o40fsngKOdpSxsW6pXUmT0EdW7pSo7nz4XKNp+F+Lu8Ea+sU9OAVQzHNDEZ7nH+sVTsnR4PMVhaq/Opjl2lXToES7ZQ8Nm2n8GcUWvCf799VKIqTELohwXQHNOWho7KlU3PFyyf9DnT1DGjpH3LvCPD3Dqh7R4vU4Xuqac9O4ecG6oVVWGxUCaWnZDolYfKgAF9thn3nXQ/9duiT8lx1M9iPle6aF9fJA8YMGc9OM0nBWDiuXsflbKhMuFHnEGkeL1mq1jglZNM5+uhWotxOIToaEEdwpvPz7vLxKr7fya8fKHvRefeYVKTUy1OiGZCRsGBGsZyQ7bz7n78Lb3MFSCfxcLahMdn5UMI4vToC2K57Pv7Rj7JXojY8AXA+fZUUWvIrXQfQVJcaax2P7WL4rlM+qrhMX0UYtnQqxFVcq+IrJiQaM0dDKRarbmlaxZvGA9FOuIwStqb9ysRtQ0+IZGW5oInlSiOipXfcUWDGYmeWmtEXJDEqNP+8jA8xxqOIEbSTS2d2GM+EZVsFZGspuLq0sQJzOZV8oIHOOUYKl9jBXlK820GVacHRxLWVky0Ne5MpTtFjAEYJXnac7YVAMiXBKs9rVCTuHcUHRFs6Jp1qCJdjocreqYpuTw/I83VXFFsUz4OhgWEcGCtOEdn/LFlKlV/JaXqjjUiOdrz8UcOtOr+oExE1AVYbglMsgSMQlCOUKhs+oReDP/mpSneNFk0n4rqDdgXvr6KVRqKxXU8P6DUJXivTjqZD92yHTkoLHggLOhObIR+IrByyypA0846qPMYrmWGDxYauGMqpX7uhotCMkqbQbkzZYCISnWy/JEU2SFNZizHpapdAM5VvohIT0VC1VUFJmvNegzi+1IFTbVYU0BGcC+1SSF8F5QHboKG38RmUhd/m1CrNi4Qv+jU5FIXcnkxDNDQhN/tA6pgT45YvT75woqnLPADLB3S7o6kbveloXRbCmFgU2AXSJoAeWrjaaT2A8Se1hUE/EjB+tA23oJBIdkBPBD6yLrmLXcKm9Q7FugQOSdlRQL7R9T8mMDpEKkYQQ6AMZFDyMQ0oCZqsOArShsy0CLYjA/yQyRyL0AU1tsPP8PAtrgBcYcaBoAEt+saBagAMJgZlCeNzJqRBLhZX2uGOOlAhdGDBw7M0Pfjh+hY8LpnRBU9jAM1DDjBH0F9AbMtAQDlMMVAmZMpJMKw16CeGMLJt0H3SgGDIgLfMpKdmoftqoSdgLXjV8rzN/DHYpG1u+IDwpMUstmCVCnEyemJAF9CCRgGkLBbMWhakFxakKbbLFALooMCstfCmbA7QQbhogS90DUqdIOZ0mZIZRCLOAd2GFKDz6AoFn43zmSFMNP/jZ0DL4X5d7vkGw4xD9OZ6UIH2kM4DRZQbkHAE6Yq34BSzmTEVnKk2K96idxkd4R4k2Z4LhdKIsZOQazOmB2Gh/xU2RH7GRKMMYjkqp40mgYORk4YHyYEjqEcyBZPdOlFOlywWo4BpUp02ymRtmahkG5yMgUbu68fhK3Cmk3DukVapwuB1gK3UnBoefF0/qqLvjRJComibMDw8t4rj41X3SUNVEL/KxjzZnt5Trb2v3en8vO8uj6kmpL9ZJkgNlzYOJi6JsG6t5664B0Bo5Hjd+Wt32RWOhZc5aeMoXigMPcRMwN/gi54LOKBziouNIoZWLWwSQOoFzxaNgoKFFeIp3K6kGlj6TOqDU53jeV2rHyqtUlBcQJzGgXPY+Uy1aDa+bKUhIVndvafzNQy9ZfGHWspDrLhuY+7cbqXG0qBwfVzuJ4wND+h55VA33e6JLsBw8OAIAmywpTm39D1Jk7LyNUrSBzpXoMJygLO4dmvaTF9TLXMZhc4Bx5EDi5ED8Vu4JxyINNQOXzaldYt336p3z1fo/ffh+n15XmNHe70dqumU+CvNnS065hEser2f/meu19SIGeTy4RDKxdxaW1MhupBxdiDdDf4YOAzxAhvambZ8zwSh5jT9EkhkaMpM2qqI5IzKyI8XVEE0NVJI1zXwv7Y2wcka7ZToFaEMrdpOZtaSXPIszvTyIIi2mUU+1YhDkIFWEwQyIAs2YOsynFx1upb7mv7CqIw9zRRPwyvZBKuk1mnK8Gv3z+F1X2W3Rsm9ETzy5PJxGFEwFLbs8/HyUe4QSuTDbez52UC9qGOUHXohcboGx6GE8/QKGUz7guZmnrAN1a9Bbh6OH5aTkZTrqQlLGNXcSSujX7FJf0Ha63S16qdoEyLTcOj1ZCoj/+Md6ntT3W30XNRWyk5LVbyiJoptwEvSV89pSqp7iGYLTgmQFL73Kf7tU9SCCKxPK7dPhy7C+j5lqwaTIRRggETgmymDQMPpRuzbkAFwI45bcCO6ERRdWf5zHHIOGVhb8LA2QLg1CARBzu0bhHoN1B0a1Hk39vjtYpXWc1muju/Oydh9d1ObgJU5ZI7K38atWokm6PnBDdDqutokITlpirTpubaW7wmzyVk2UV9TL6+Jr73ZQI1EwsoCCsgBLSISa3KbCKh8QQLqBppAx5e+3lfUXurw9vxwWUysXDIrSxM9TS5suOFy/wLL/ZJi+9HSCoNjpTJ2R7FBwcrnVXeVyqc/QC+mpZmE2UTwhZ9Vriyj2lS9od3ys51JlrTeL6fZozatXK4JSkzYlFTP90hrJrO1IjxV3fNIA3lDCTm+Tpf/vnbnEoPfKH3Rhm8CpVLrIBM0lvfvbzxLCUMyAPiA0tQicwpos3V8N7ge4t60FWPKWLWjlEnJ0ONU9nk0srTikAp2kJFxDYVATFbL2FnWzLyh+/c0dF3ZVom3EEZmLgp0c3N3bLJZK1h5GYZ4zx3kyQIh+FP+vslpVmyU6IJBB5MDeafrwR874BmDZDt8QmIWcfmAVDOYkUPcQPfP6dKzTl3p4EtvsqHMB7Ns9xphKpEPvqMQpTx8kjz9XNdUWwWS7vgmPFlaYJ7hnzUgTOXDRlrD/LpeTmGNLsSZpaOuYBRUR+Lr+ud4iJ7oLmISzn/Z1teq7YuumnAhtUAonAQa4sLWzsVNtDRv18PfiufRqr4ttoMtNlbUNnIHbmlLyTJ6YxuUlWpKGjX9hRylcNcNWN4dhImgqWU6iBCBbNOAOdpArsZkHmiIUdmR7pPxyycByQpJqTeKyAsqFY5mSC7H76V9uBLhddKPMEO+YNr+Hsw9js9XLVzsVJ4anP1moFyEl2t4+/vfs1z85+k2QftLrzyEIhJxQEM1SOESfLpkY+toQi74Fu/hYVHPQvEj0jhWop7V2S5PSssRZHJ8rRFauQgdLSlVzNQgqLKx3nZ0d69YK9Nko0JB9jRlLE3NRDlvBWxLnhW2p0e4NBTBpYVnMkpONdvTSK5iZuVzj0r3tqf+krRVDTMHmZK3nMdMGqoh21S7y6Ke8e/MrO9NNb71fDP5F2h+OQM8xdvVLa0ubJBxk/W0fqHMvd5qM8qpqdn+m1meLZXwyVE6I7anRTRp7UWvTNZZOC34ZEt7uqqN0/c0bopDv27nSf+dR01yh2woQDHY4tl95eEBQgDSouDHs7u7TjwV8apqRUPFldDQw3wyQm5PTnG/cR1r1K8i0/EdjXHnoZUuVzOo18QW/Dz+cT4Vbr/qK/Ecw3p9f9eu5aDcsBRMec6+Eyn+ignWqwlGn1oYuORta6BBSSpnOtqZF60QPktFS216it2OJignksohA0LV0hNvMrbq9Ow7xYpA65UTX2JZdFEd8ci7UhjF9XciKSZ8cla62j3tcyi8fKs4DoesiUeza9cyZrfKTR+ywgWN63LjVfQePgq6M9kHMzi6xBLfuU4pikuBTGrWGYUslrU0INomUpfyzoBwWXDwWajjWQDaHPCTLqsoZ8FJWkAsL2Sd+5Ndii1tGMp2CFe3RAWH66YLqmJnTdqtOBZ41xyMTT3ktYTiKFO14THRyTSthN15zd4p9zxL45hKhqaTsZUZwGcMMU9rwSfS8BV7P32cwoW97udqVKpQvcgs0QdWsVb6IqZXzAB0O3o9GWOqzL4NfP1OeDJaZVfEoYbWojMqraTtU74D4IIAfDoD3IhBzsogywWVHyfIwwFn5ExA1/BEIs2Tms7KIzO0xhj5VyRgQjscCnhBp0uMfX8tUdkvsskrXXrjKGeyNrZC/inSTEcDhskKz/Z6RffruC/xrajX5pK/8u1lo8VIp+12ckBm2Y3PrORZBJsm7m+7e/DVjjWHJdyWdLkMJV4KNo46ezwqyiNITTtHlQxmG0BPrR+U2lzpwTGl4SLT3E17r35UWio0oyfGh/M5UskXZqQLzhvrhZnIrhHijhJBpBgF6XsXdpLqUHE9ityKtokKO7Xm1XA9ip6Q+oKTHUba1CrmgAX5zYzEx/K5esmK7shTnOhk4f16/17TfbWqd5Vzl0wmphbQ9UW0Cq7KWdgmG3EBhX2iBPL4UWHEaGlxsRFmm74Exd/902DtXUsPf6S+wzR2TVTZKmhoR2P6Od99eN+fT7Fur/lbpFdsOnoKTjYqfLG9Gr59CSH6rk2jUW1cWwZAX1KhfhsUNSB3M6OhsDSpk6koJmln+tpK6eT0itLEbq2wCMKPm+h0dFXBSEoxjJLyLqb+XPe7t9e5INCKUaOcLTQVHK1oDHyjSNH4DNECP0rCw3AgZxx3+7zvClmbXsWsG2fi4/H8DN75x2c4/m/F0a/u2XCClLWVSsNFqxoueuq3CmMM4qrwnRvnLAxx8mo5X8d/85i2iRnklTlKsSrMVQqESgtgoCC8aOS7wOt4VQMzA0pTkE9GX47n8L5k+dcaT+IV5YmlcQxM/OTpauwCZc5Z2Vs5u7LSYgwtkSRDp0MRSXrVa23tT1dyOqx40bxiyuG6NcnE1DNTaz2RzcyGq0LV7JT7qO/VC/vxuVRuSrrtFlrvaK4zjjYFJ6OrSe5V6zc0Qw2UQg1QGMZCCtuiB9EO+BnEqS2CAQdxaugfGoAZzQhlg4YW31deipU1s84CSJkb5ABia8EMibgUBFWOd7lXS+MKKwD14+D25O/AFdAkzGS5FvQowGC48AQbGShCQppaJYWCPcW3TIGuk5U6OEKRYA20LjVZ2E7hiQnWUuDiyqGUw4ZUux8wPz3m04i+TyjPWoSjFkLptkPJvtnY3J6fb+EAP1RCQXmM02x8NPC1nj+DqmD6jWX6/CyTM9J72LruGvpSdSlwPr3b7u+KNcNIvKJzwBM7/gqRcZgeYcrPlD6DylfS5yjh48p3kdsVlbjYSn6oGxMtyg6ZZCiVu0QEFD5BbTztu7an+bry69cLVDEa8EWe4e/HQtNBZaXSzkqnx7uaF32vxCJpQfZ22lM2HK8Yubgs801HaX2jyJq443PSFJldoxDVtI51O92Oj9378VyEDCpR29GejNt5d7rM9Hkz8FbXEmWAx/eQ68++lkrAOT6NrxtulqJb5yikYGMSyyiyd4rq1SWEofFNRlM1+IStNlNU8NMT37fmL1SVRMenK0zMKWttwyobG4+uCgHpW0VVmutTfEpdD4Wsu4rFXKpAhYuh0+q69nJbo+j3eUR3rTm4baP4dlPFK9ihLur1UOkr7nvd+0V3tOvhv69rva/AWBVscQbSYGR9I4q913NP/XoIe+Cz7JTtO7WV8YzCNam9JUak2p0M+mjgbtN17UgXulhpTgDojxPEOIhmOdCP+NTXEx4B1iI0oVqeq4hYUk3ELJMchvNIxm53vaGrgDXVdGwDOpmG4iaj4sc/xX49qv2aX79OflnZQMCVOeKwbadT3EzL8xKxz+ZyOEUr77vTmQJ05GEXXhXddCK3+b5ktm5bxT1HBUFzfa+C65WpCHi3bSq0gw9lo8hQrx462Y0H8hMHYhe3UcXJFp/Xiqxko3rPTUN3x2xnJubWm4tkf3AcAjRbCS/gVwW821nFBcEPy8LIrxVXd2c1oGhjKkStlES8V8RW8pYGMLC0lEprsRahIMSikp1ApNPyI+l++hMm6n++FYulQtkOlGXidr/GDF6E+6rNWCEIeN9OGr7qD+gVSNfw/Xc2UC8fyvdjaPPPIqlwva9JAFpFANFRLvjFxONa1tm8yk/TmnEcf3tW1Y3lmkwkRQOYtXjGe7JY9dYl2txQZP9sYDqkixS4IkKh/P4LeaKWOlKxTkcBxWHs86ofpFFeO6+/VqRxnUzaD9xZ39CYltvXmOnGcKIbdOnnEAxihqZHAq1HJwPvX7y93s6nffB6p4bUKMVWRbCodPumqdXCloLZ/AgqAE+yJY83fIdR24fxIA9jNvdWZUHFsdBT2M807nmtiQD0iqA6MbLZLn+iTzFaDU//8M4qH4qUgm6zG06zkqfiD3eyUEVgGKuALh0tGa84CpzMKg2Uj2Uat9V8KA7VjiY9JyuX6/MR5scjdiEyH0vuug3VOJ/MbbtKEpNI+9HvhZs2tKpBZIDoLqixt27xm7Rjdaqnlb+g7ypDb+QZk+c6GvNb2r8SZqy+ADnNPG/nCOPqLWEq700zXmH4o/heuXf3NHMZB8ZQqvrlyqtpqZ51YaOSDlcOV0udgmDoeY0rnyx6xexhaNNhMFNfsF4Ri7AVH3OGOt+galAbo6Iuy3wDBb5CIVx413q2UXHnFf+s7+h+PBnZ31c0cNKDoCDyOHjdFuylsLDnVa4K0k3WIlOByqIpkIIroqWYBwzP4bgr1HoUzqOjPns0cb2c/9ZqK7JVdKBYk2jhttv/3n0cSwGW4Fyrt0HjkGijUhnwKj63NGqMwxOznTagnkJLz9FtOIi8B0czcCFKP57+HCOvtt6xVcMT3m6mtuCCSMHk6RZBRGqhqeICx/vN7BzVdhXl+dPEekwTBCNPdhLK2c67tVdW9ucCuRJMqc4i2sSVTIU1P1mqeXHyZXFfXFgiyKRRpkPswE+kxZLu/pJOuR0on0gcXGDjZGbJO8d3oDAyTtZitEIu0RZ4jC6nuqxae0c5Fabx9+9irFffzZdaGFtLkoaFNqhv37j6V9kBZVQwvLH1vt+PD13ClQcGqInGjUn4cSzrl7KlwINDoUvZSW9pKDpZm5sd7q9zsQErmhIuRzHbWI+WVdWONu4kdY+Sukoxe9G2mDS6rPtYmYvsKJR8Hv5nBdS0EpfUIU/taVVXGtqSiG/lCjFcYiPZq3B79gq0wD33xUIxflAd0H5jh5qHT5XN8vH4QdV2wL7HIVrB3LGA/MUqmjpdE2OqA0c7qkbe0YzmYjmeoKv9SFEIel7CvR8jN+0kB1DU95VSmuf8pLDw+H26FRZUeoZ2zwYLk0qtes5WJZQo/CeNXVM0S7DymNroRlo/Coauf/RCkpCeHu/Ib+yv0cTurGadEvztqcwyxrI4T0GvIQzI8TKzwbfdoQIZUUwkzcb+FE0QYL2KPLlSw2xjEdAOv7gXuilGUfU5t+FwR0P15Pag3OXU0ezbjX07Gpv6V3QgpcruLUpzlEx1NhQDKj1zZOcnrbDlwUVaSzK50XTYPDr1oFYZCa2Egbietsrco2h7eD/Tn6p9Sjq8notNhdA6EvrEn5UNB6rxgSdIjrGuM+N+1w6vIgjfWH5rgm6jWjJdh773DsrBHcUYcUlDzTWcsI49RAwM5AJ6cC+i5uvajRkhv5ElGZRa0cbUrNpatSg2Su3FUA3Kqj0CDVTN7bTM82+Eo+UWvHGASEP1TJG8SZ5jrlqq5YusMvfvnhlHdyosZUtRxIW5esFWJQ96WgqqNJaYVun+LBM3AyQh8WC5vMFi9nhYk+dploDFEq00LYZq6VtZLXC4pBEmNxzDSV68OKGN6xVRIm1g2VInV4WXH74/PpqM3CvKBnKn485CiOImX/sSKS2Y0KKiImooyGGyVm1R6NVxSBFdykAVJK/ovjae7yM2PP1AqiAPR4r/mE2tAPIqx2gBs+ESvpEW4Rz8ssd0hyvaO9WVtpGvnYyszrVOPZeRVniW8bQHQWnHma3XFM1QDj/FZEIbYhYrm+Vx5fZvRKCTJe3pdgq5OmzsM9Pgx2c48uMz0c+1Vc9164GURI69qvKYjSNnHlsnCHbSYxkoXw9ouUutUKOkAfyG48Z5vRWpDoeqJROTWoXOw8kGohCAgB5vY39dJOU0GFlyfo5LGJX1vFAZRz8JeP1w8ECaKf3Eo51j2AhMl6shOM9Wvej0FQaqcAZ6VhZcrByQzuX0VDHVDVv78LTz6WyMbGaBeFhn85mcCVQ2Zsn2liojuY360WzleZ2onMsedMWj1FIAQbJSqRZ3Ypr0ScVqSFxAQ493AIcE6RLLe+/uhZPTy6REeMdoz2kgW7P1CF7nsvdetZfzkt/xz/X38e3vx31XNiZ7hXBtsvIb+qV6wHd7vpkVLsmgKPAdZVuJ4+p6Kl7tQZA89uif8mCvbcHIzvuq5RfV+pEVHyAHA0Yz/wapq0QEHM9/BXMrzgAju3Gcp73RafCfXeHPKy5Kx6PeNdhZegQeMn8eHXwbKysaQ9+/zrwqJg5K08mZf9ShuJAR/2RgxcungPWcR4qm5BWWhdf6w/CoO/z653Q+7e5/8wFdRdlIEkPO3lIarZtStQi+DCZTW8eFjC0HnnOZDdXYXlVRGxqa1lKUdfm05fyHXNbA53EYXuQrFVd7R2FthThwpyRsRx5IvS7780mPVPB62n83j3z8vez1aEV4Q7kZYucQr39KBXNaB5ubjw7Hc1ilmE+YDfohdip9R6f8bPJjip1WDm2nkJkDdBssBRs9ducYOl10VtLLlJfhpE2P8Cd5cpeogEZWC10DcvSGtrg9dlG78X9iMSfyNehIo1dICzo/12pZfadOm6y8CbXcjpZgH/trcV44eXb5hgZyj+Puvv+8nb5qjARKfcN1dK0+jvu7dr6cSluDo9/wPoTHMTiDh4V8mopjqrXIpwuxVe7/3aiiMsrm85iS0RrHIakfoNpns/5Nx6fjZK1MbCsZAoMmL2MobC7amZIKUQ1S5xTkZmsp0DMaeIQZ/N+oBhfOj1cBDWmUyNb245ntvG6H1fKS2W47UganaERjqQcFzfdJvsi2KWCznHA+MvbENGQdbq9Ib2imFETDNfIflZmgpMx11uNR+cGdB7KXllWDnT+Fb6qarBt6LM0jw/t9P3281uTSsrvRct652UpVB3dUl8HnfDRAl7USa6UNcUWAp2psfYpMxkT9MIJ4fwAlI7g9HbSfHYTKnYVisc1KySkKdyiJOyh7OER7Dk1zzqVvC5+grZwaIpzLqiA9PiW4rkdLnefghvAUaP1T1vgoSiMYmEiT1X4ty4NQ3B4TotjZHjdFqzHB7sf5+raZ/pXTraHNtHFPq5VeZFK831i3z68QE59WmrByP/GeprJjPmGheSyKoLJsTnMmU8KYVums3OYdomjXI5jthY5VmlM9XkSf+EccKEdd9qAgo+AGjB2SCrsbeozdOJye0XebMvl/droo0SqJsI4mzWt4LkXkZ9zWy6vLRcjEtoH4jOF9IcHSWplLpr3o2fG522uUTqdg9iDtbfGJt0JMxlYHyKDymMjz2C5/otmjen65U/EV7b3F4GqvTqc4rwfaOwsrKV+ujag3BanQkcbowdx38Mv3v+MlFe9LvDCc+12CzmBqDz3yojQ9/jidNcNCL5NctgGDBlRcbINW+yZt/sElpq96Is2fNz99VEtfkXPJR0678xHMnjOUe70QZCBsOJp0thbTQT+kG5zk7vOWgkxng89ZjVVPPkULwOEhj3Dwq1WgSKUFzdEAoFmGoSUaB+/BTO/TW/cdJbiL31lHYcgNxXHUdYSQTe7T/Wu1m3dKZ3QAq8JAUy0TXX8VoK/6rWlyQoyvqYa1rdqhaZHmcX591MrYsj7D/YeJBbI4XQfpQNg26Yjalvu0k5kyx9srj7ThHuk0uoRTKmFeTxt4wqal892mU5KzPYXkTSN/7cq+IacG82uOg9dYok7hlXkFWYyvNHkrnsqeH0iTkYhzL4arHnF++kzDVyq1nWqL4HI303ERQrOCHtMor8hTvbxHXMeHXcyVTVq7evKrJ9DxWGSVkFJ9t8B8L4sZhY4mOfHhR8iCwxHxSZ7BAAASu6rTp1TUMWjkNDjGTIde3M7nUgs+pZyC6ROO0PTo4x2w1HxiN7e4FtsjjWQNQh8opVvUTeyA8AUavQvHzxS+JOe0zTqBCJt6Bye2zw4rnFOo/4IILZw4+C3sDems9SbVVr1x+JSevQeOLeySfJKuM5eyQd75XGJjJnheZFTHFtfxm01w8lAZ9I483JutTMlZfRWjugq61U/jT1E2qbgLRV7Kd3sxvhaUjSp4H/k5Otl5hPvYP1cSyKPi6x151lRkmVj3qtwEKCxAGloS3wUCq1EH0cgDJmFpdV/BilFW6MYmrHCNwlbRZ/2bh7SionTSGR348VraWMEDZR2A87sHO9+X7+v9d4mpkd0GhjfKP27HfZTEqmpDyzJCR1F7j9v59Ayxyv583OlY3Mub8O3GEggW4g93M4v5s6RS75XXxTeEZ1EtCA6aitoSqQrv7plM7HRVXTbwWY9GwhbNhR0t2K2qIYPqVfPp9LDtgCRlqrB7zoQ3ma2kXgdV4vApNLQ9BbtNln7WyPPKLve+Y0JmPyHnwo+1DzJY5TtSyJqwUbtDpUToKWRgtjKzyRAskNwRDV8gk6FqmlsySXhOjjxbEG1SVUkumb3h8PTZ1hK1VqUaBxV0O9roMVtKbbzHy0cIiYvStlKG4BmP2dDn/fpdf0pGPaWt63k99lct/WIlCgHeGXJ58NJATGjhrrkhRbRuTFmf8Cn9dkwUZuFTcqpGSNqMyDGPcL5GuFLI37oRlfIRCdwRcXaWGxnhroHf2DdAHzVoARPEaojCG4e/c/gZeMKbRCnjmzZtb02XPyVnrkHM3yRX1DeI+Q3Fu0RONZ0Ia9SWyjeWVWZFqSFD1HpI4KehT4WF9FbH5CCPyY+OxeTlE0B7kY9i+eTAf+17RAEgqM6djX3CLpkxUwaDkWfECLy2MA+xUyMK6MAT23X4GbB5UPy2fZc/wd9OcYjnuPrtZa5Q4zyfIW3MIl2HqYmjcOusRLJw0dm1udoerUS1HK+vzsYKDsyuV2d2ioLC+0GiE3C5MdWFPaef+lfAMUXxSFt1FlM1EzKzYxJYMQtSOwS0bYOQlUfh8/esYdaqwTHc89Zr0vuodLbbNG9Biw5WdJCit2l1tclFwdw12AjDpxQHZ+CuSazQ1oIpGRGxdT1i6BxXp/KKHRG3tmnjch20xzbSbfF+a9VT1bk7Yg3zDqrJUgHJMaqdjAMsKtNCyR4AueoAouRCJZFsZf/8Ks7DTsH6ho0ZFKla1mp8Em7CiU7i6FsIkI6XVbOKCv+cF3E+NfZ6O1xjuzAMTkzga+x53NGlbY5kSBZz4p24eEo3ji/rtT2SyFcd3Dwger3NjucPaHTZbG05c9CGuZUsj1dAZ9rQAZMFb66iQebn0mvFcuJV5Gzhz3SULnIRX17n2EcpLmw3kr3SwPH+p5DpHWWHjO25n1LhwVHMxfz748B/jTlVSFbqbE02f5rWqlq6gcqbiVP3n8dVo4g1qjbDz5HZxDFzX5Vd5fJRNXx/TnawBxS5Q1VWQdwaPqHpnRLSwfYsh6MRBRIPwVkmFxMlnFXWsrv2h+9/1LuCQvyjSBnQxW/B8AqRAW85zul71rGOpYni0UkMmbd8k5stvEcaSW1A1js916F8/H3sV12UihW1oUwHYWyINGusRvK7GwpaeO5+xwbTWzH5OjX52J0/wy5ZgCdlPXUAtzbnSZ5NEAFZTSG0eE3pPbcppAzHRcrGDPjZgFbWgT73+buXPfdxVUx+o+od5UreMcyvNXyMaisZqKdeY/vqndqGEut0WDYpsmnFJ/Az0LpZ+o5ff3b3UySc01+mOrfoSk5GDpTqXwFDeN8vDP10hstQh7OD8TyLV5kfC1iqTb13pk2AO2scPgGH1KAkZFCAyr81qZXKt8gstDStqK9y3QKvdKF8S49m2Km5kL1Xbg9Uuw2lvEvmSmppo+TOwvWwk1AamP5cG5EbaEu7CGBkzVCtsMqGyk8kCzVgQdMpGklae0g2Vq1bvlOsG5kVlJbakykNI1PEklyAHoPXnJBKZ823mbeGwttjrV3Dt2TB3jrKdhcHPq+nS9Ei4FW5gLLGxg1dO7FKS43mluO4X5/PL30WKik331Iw1jT6a3f/fbh+F+WSXi0vGl9MFi6uGKtkhflpEsc+X/dnuZRUiaWlXVFTnnd1kLcqzua8UVF+uIj5jKI/pWCW53W/u1wvp30UXz+tO9kVFV/Hd4Jr+Mntegk/e/znUeJ7laBQiBfpBLiuaHeM8qgdZTp7XmdepJIQqVWj+eXPOkS65qPKU1Dj6RqUp+Bl9BTG/rz+Pl5+EPdW1BAdX5TXc+zzXWFbFXECDe7D6Ov+d7U71Ss1ZEvRk89r/KPDCsGj1IB9R2vFYfzxe5U7UUR0FtUDi34mi1PX0WTk8zozhFauTU1gmoANBu6ncDrvzusLHNQFWlwgMOYeyBMa8T2vt5NqkxsUM6cHTLMFGXYHx5YrXwSzSQalcuuKtZbCP2NmbmbpK+I0FcvyvWfhL37u1HE1KJhGm5pgPNx17xCE+uTkek+VOp/XdDSWDA+9V64nzYwEC2FfqjDJGhVtO5o6DFHK5fF+LR+zOl06vnrS6EgyfzzMD61k+FIuE+Uugqmq+pqiGqRxa/j6r/NxFwXnH+fd47PYOVvF4Mo76KKZcDmnM7WjCEy4F/hU25qTHihKhWbDB1wdvYPMetqWhzZlM4qE9AzAtQOza5E8sW2GGeBnncHxkDIRtsPfgfrQOfQ0OIo7jpd2kCCCWj+5DPUtxzBPtv4dJ5o8My1N8E0Gq2l9leajYoVkMTaKndHS9NBrEnl7L/0l6WXzIsDrAsFMppCgGuUauhRfl/ggf5ISUd2oW5bqlX65og09wiYDm2KcRqNNNu1sij6IZ8MBDMHOf1/VHkR1LtEJEsbr7JLMyA2JVt5x2FI08Ovt77OcoDLnEYazHfJ1+R09t+DxnHZxspLCjcpqe4h6eYi4Qt7C8crk6xJPNab/qfikDA+lg5Xg48Vs4ttu/7ukpVb5NLqsX5ev6yGmWw+P02VftsTKidyAqKRJsWh4RXw2PI7716QB93juLs+f1ozi4eZveDY6Pbi6GTlV+cqBmRme/5j0kfZXfSbJJzjQfFswljLnE967vqSVx00xW8IWpiHbrxSPPXX21o3OXkKBjIEOovXAXnSIffiOOtlFD1CaQ6uuaivhYa6nEVlCuB5v8Z7n0XrZKbVlGn8B36pzGV66fIYLfczDBcZMGxmVke1nM7VFrf21ZlTnHUU8zkbCkVd7Fqq+Sxk3gNKtv5q2VWEcP3knMxXCXwXyTazxxo10u8qGapueUUw71ANNWN8NykT5mhwteAE0/Pl9PH18PsuSnEQrNJQDaraSqLSXjlK1jYyKoqpJ6WiT2mLDRKL7wWS8ZlSix8YUTo20J242xJaW4vEx23e6BtMYdb5yKOnrFpZl5EpekacOmrqTRr+vW9kc4FWmqWkBVhvQitLkphR6ZfeT3lxlgsQNIB8e4YSM6IIe0YsPEE9YARjR42cZLdhkbCLwhQ7oQw+kIUBuTQI1h42e30ORRpUZOD7m18TvonJwKsA1PO0bRleK/qqO5zzN/b0eq35RWcDhxI+vwjv1Tm3tNGMYx0VYbC2KUAk5immKFtZlD1ka9467CVHM8htxyLrhXnG4pU4qZwDkYvf1p/s6fcz6gIy2QqGnBupd1S2tuGiUczrQ+GbJfZZsP/Im09qAE0132WRsyjo/TqWT0ShKcSp4kK0susRFoKCYyXvKvZ3MHI7v03MqIwRFaOwpm1U2E9t61o1P0TdTt8VWRDJEkBNWlqLCbbHDJplh6iZhbanmR5A5eJCGeMzblm466Wtia2/x+OVz6ylgCAYEcEkn8mWGpG2QX82f6DmZbFf4gRR3tmupZ5xMfJ+en+sCj6LX5bHwYiSc+qwtL3gSMt810gigrpanmsqRhM88tfScgblKWVtN1833z5aOUtdwNNJfOyGKGyBhY3tk6UCM6w0F10xGcx5E5wgloQsFOxQWCmp5KbhKyzaTCV3DlQNtm8l4coodVD3e4FOiVfGeooHm7zo+i69z6us8TONT4g/2nqZnZ9MVpjaj9J3c9stYkYs2Sq3Ebu3Q82hC2xsMeWWIX8ZFD+yU2ldPie7q4BuFb6CwjzT2LYwrawadBAWYkaKFk40qW6wCjiQf1JqNLW02FgOR0pbq/qL14j/73b0kMhjVg2RO15/j/e2qoXa94qdtgJhv0sS0TYdPYGNraJQVCb9ihKy8Sq+8ShqmT2O1tLWYWOm82Ryc6P80z5UMzkfuQ0wWjv+cHpO8YC1jOUp+TjugNDHylzUZXSdy5dRzfBMMUTBrzlPoBsprtVgo+1nk6jHozDcDLQD+OYVD+Id2QaeuiE7C0/35WpeKjWzQcY62+S/Da6VIVTxxlBPoz+lxKnYTr1plXCqaG04V8Oe63729zruC06JVbCo8/MnDYw9QgUoY9fn78yWsy9eqybmnOdJsoiKfoCSTeh4IXE+HKu+/EoOkoeQ8fEWfJI+2sPHwG0ijq8xziuuJVpe/d/sJh0x0QAfFiMlFKStmynhvUMwAXEg2mdrSNJdk+XSOfO9OzxChz+RBz+tRE4gZq/AZw4aZu8ZLNooBMoHFbZM8Jdu0+ASNnYa2BXzHUOk93HI94S9rXpbWzL6Pb7v9uVa6U4BkdvqE4Z/X6+9Yc7gczzZyAss3J5+35amYtZXS8RpaxXBK8d2LpePXqXQUhl55sdRvWSxMBR49XrmlfBaWAxXlV0oFopRlGod9Exw4ILw08LENYgprE0ew9cnvtrzQN13Pr8UT/kXc0dYq6noKH9fGypfUSgBPsLL5iEpQTat4LhyF5WBwcRYqPZ+IJvlp/Jq/v1EPAexDHOk+2VrbkTkm0yL9CxS94diQyeKq6dPJY34AOKVB+ybo9wzczVgnTpPI4FNq1Qy/xO01uCyQT3OELyqWeodWGn/Y2VrqYcFMXOzV1aoI77beZrZTO4bkXh2u5//Fziq/MPQKYUZzOMpYTfRy6FWCiHp9ytA0K7QZqcpmWyoNATP1jvFB9X/wuhfMsN1e8Sy1lEajZqfcSkbFKdTSbAVsVV0Q1b1O88SljfV7V4ku9/MkKhn/BgUMo3jbjAb4gYpazmkOUZ2LijoFJEk4qJ8dYpYw2S41B1PeSEOzY8pA1ceUq7uhkVzMYCalvClEXSslj7L4wfMx0VJlsGoDzrLjqHtBrcg7WruLpomKs3LB0mYdzOdPaCIEgYdDBg3btncgCUGVOwQH9FQKFzT5vpUbVgSmLb4dNCMQ6fIojoTrwLWloqOHr+IhtOt5+DnTWn3tLrtiQnUykWJ6fujXeLGsGkp3m/vudtuFiLFQyDZyUbuNACWOj/2ut9N9UdrGw11FbxI35/hk1CarWUrpNYYDlW7ts6lp2AyOXOc7VV8Gf8SzJUoJLktT3tMezclM5L9dbx4qouB4hunpalyGQlNsDQMcSOef5FkClho7IMYaEpWPHeFbj2C1GMGDkVkyxsRKY0e+jcYrqsg6K53WjQe5jC6b5UZVXRqA2efq6LOp6/41/VSaUlHVkPaW8IxGPBmYT2gRC1YfCzYfCyIlC9Iky1VHpguqUiQqfTeQVtvMWg0shB2TO21HtMWMHi8ICdiMgGhAsNnTdjh1aetH36tHjwugCKjv7+9YcN9IScjZ3dOo9J9HkbxWRf+eIsH+xmRK+F+lU7FT0dpAz7fJxP58qvOgW1WLp9CdyUjtIpRm2kDbbqfxVX00VQ8JFtibiBb+VB+DuoJ6XP9//r//dTvdYiNI+LP//X/+7//9/wHYyqV6LwMPAA=="; \ 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..c16727192 --- /dev/null +++ b/7.x/docs/classes/AbsolutePathInteractionRoute.html @@ -0,0 +1,159 @@ +AbsolutePathInteractionRoute | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..d9b846750 --- /dev/null +++ b/7.x/docs/classes/AcceptPreferenceParser.html @@ -0,0 +1,181 @@ +AcceptPreferenceParser | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..df44007f1 --- /dev/null +++ b/7.x/docs/classes/AccessChecker.html @@ -0,0 +1,175 @@ +AccessChecker | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Class AccessCheckerAbstract

+
+

Performs an authorization check against the given acl resource.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks if 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..b83ed6559 --- /dev/null +++ b/7.x/docs/classes/AccountInitializer.html @@ -0,0 +1,224 @@ +AccountInitializer | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..3a4dd68e2 --- /dev/null +++ b/7.x/docs/classes/AccountPromptFactory.html @@ -0,0 +1,252 @@ +AccountPromptFactory | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..bb825648a --- /dev/null +++ b/7.x/docs/classes/AcpHeaderHandler.html @@ -0,0 +1,218 @@ +AcpHeaderHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..dcad49064 --- /dev/null +++ b/7.x/docs/classes/AcpReader.html @@ -0,0 +1,326 @@ +AcpReader | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..d1afb593d --- /dev/null +++ b/7.x/docs/classes/ActivityNotificationGenerator.html @@ -0,0 +1,200 @@ +ActivityNotificationGenerator | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..760bc576b --- /dev/null +++ b/7.x/docs/classes/AddRemoveNotificationGenerator.html @@ -0,0 +1,201 @@ +AddRemoveNotificationGenerator | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..a2b63fcf2 --- /dev/null +++ b/7.x/docs/classes/AgentAccessChecker.html @@ -0,0 +1,171 @@ +AgentAccessChecker | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Class AgentAccessChecker

+
+

Checks if the given WebID has been given access.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks if 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..8dc5714dc --- /dev/null +++ b/7.x/docs/classes/AgentClassAccessChecker.html @@ -0,0 +1,171 @@ +AgentClassAccessChecker | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Class AgentClassAccessChecker

+
+

Checks access based on the agent class.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks if 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..424cf9f45 --- /dev/null +++ b/7.x/docs/classes/AgentGroupAccessChecker.html @@ -0,0 +1,219 @@ +AgentGroupAccessChecker | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..c01c3308b --- /dev/null +++ b/7.x/docs/classes/AllStaticReader.html @@ -0,0 +1,191 @@ +AllStaticReader | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..52c69b940 --- /dev/null +++ b/7.x/docs/classes/AllowAcceptHeaderWriter.html @@ -0,0 +1,352 @@ +AllowAcceptHeaderWriter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 +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 if 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

+
+
+

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..d24f9fa64 --- /dev/null +++ b/7.x/docs/classes/App.html @@ -0,0 +1,158 @@ +App | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..7790cfee5 --- /dev/null +++ b/7.x/docs/classes/AppRunner.html @@ -0,0 +1,360 @@ +AppRunner | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

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

    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..931e04259 --- /dev/null +++ b/7.x/docs/classes/ArrayUnionHandler.html @@ -0,0 +1,244 @@ +ArrayUnionHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..eb78ee1ef --- /dev/null +++ b/7.x/docs/classes/AssetPathExtractor.html @@ -0,0 +1,201 @@ +AssetPathExtractor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..de0436707 --- /dev/null +++ b/7.x/docs/classes/AsyncHandler.html @@ -0,0 +1,242 @@ +AsyncHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..74cd1d84d --- /dev/null +++ b/7.x/docs/classes/AtomicFileDataAccessor.html @@ -0,0 +1,438 @@ +AtomicFileDataAccessor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..3a72451cb --- /dev/null +++ b/7.x/docs/classes/AuthAuxiliaryReader.html @@ -0,0 +1,250 @@ +AuthAuxiliaryReader | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..654e5fd55 --- /dev/null +++ b/7.x/docs/classes/AuthorizationParser.html @@ -0,0 +1,210 @@ +AuthorizationParser | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..edc37d7da --- /dev/null +++ b/7.x/docs/classes/AuthorizedRouteHandler.html @@ -0,0 +1,212 @@ +AuthorizedRouteHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..cccea5134 --- /dev/null +++ b/7.x/docs/classes/Authorizer.html @@ -0,0 +1,174 @@ +Authorizer | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Class AuthorizerAbstract

+
+

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

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks if 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..9a5c231b7 --- /dev/null +++ b/7.x/docs/classes/AuthorizingHttpHandler.html @@ -0,0 +1,233 @@ +AuthorizingHttpHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

+
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

+
+

canHandle

+
    + +
  • +

    Checks if 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..60169bc97 --- /dev/null +++ b/7.x/docs/classes/AuxiliaryLinkMetadataWriter.html @@ -0,0 +1,231 @@ +AuxiliaryLinkMetadataWriter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..0bbe1ad06 --- /dev/null +++ b/7.x/docs/classes/AuxiliaryReader.html @@ -0,0 +1,242 @@ +AuxiliaryReader | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..3d3c4aa39 --- /dev/null +++ b/7.x/docs/classes/BadRequestHttpError.html @@ -0,0 +1,238 @@ +BadRequestHttpError | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: any
      +

      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..3537596b7 --- /dev/null +++ b/7.x/docs/classes/Base64EncodingStorage.html @@ -0,0 +1,279 @@ +Base64EncodingStorage | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..dd89cec73 --- /dev/null +++ b/7.x/docs/classes/BaseAccountIdRoute.html @@ -0,0 +1,158 @@ +BaseAccountIdRoute | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..a7ccab7d4 --- /dev/null +++ b/7.x/docs/classes/BaseAccountStore.html @@ -0,0 +1,295 @@ +BaseAccountStore | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..b87ea5ebc --- /dev/null +++ b/7.x/docs/classes/BaseChannelType.html @@ -0,0 +1,347 @@ +BaseChannelType | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..19e421797 --- /dev/null +++ b/7.x/docs/classes/BaseClientCredentialsIdRoute.html @@ -0,0 +1,153 @@ +BaseClientCredentialsIdRoute | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..0b4bc5bd9 --- /dev/null +++ b/7.x/docs/classes/BaseClientCredentialsStore.html @@ -0,0 +1,332 @@ +BaseClientCredentialsStore | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..9ebff5a92 --- /dev/null +++ b/7.x/docs/classes/BaseComponentsJsFactory.html @@ -0,0 +1,171 @@ +BaseComponentsJsFactory | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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<any>
+
+

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, any>
      +

      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..9a8e0bdc0 --- /dev/null +++ b/7.x/docs/classes/BaseCookieStore.html @@ -0,0 +1,219 @@ +BaseCookieStore | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..70f9ec8b8 --- /dev/null +++ b/7.x/docs/classes/BaseEmailSender.html @@ -0,0 +1,204 @@ +BaseEmailSender | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..41eb4ac00 --- /dev/null +++ b/7.x/docs/classes/BaseFileIdentifierMapper.html @@ -0,0 +1,464 @@ +BaseFileIdentifierMapper | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

+
+
+

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..2e443e93a --- /dev/null +++ b/7.x/docs/classes/BaseForgotPasswordStore.html @@ -0,0 +1,198 @@ +BaseForgotPasswordStore | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..b211d6397 --- /dev/null +++ b/7.x/docs/classes/BaseIdentifierStrategy.html @@ -0,0 +1,195 @@ +BaseIdentifierStrategy | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..f62081567 --- /dev/null +++ b/7.x/docs/classes/BaseLogger.html @@ -0,0 +1,279 @@ +BaseLogger | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..8c6381b93 --- /dev/null +++ b/7.x/docs/classes/BaseLoginAccountStorage.html @@ -0,0 +1,605 @@ +BaseLoginAccountStorage | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

+
+
+

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..ae4266fe5 --- /dev/null +++ b/7.x/docs/classes/BasePasswordIdRoute.html @@ -0,0 +1,152 @@ +BasePasswordIdRoute | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..036675d22 --- /dev/null +++ b/7.x/docs/classes/BasePasswordStore.html @@ -0,0 +1,425 @@ +BasePasswordStore | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..b3e193fea --- /dev/null +++ b/7.x/docs/classes/BasePodCreator.html @@ -0,0 +1,291 @@ +BasePodCreator | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..3f5d54c6b --- /dev/null +++ b/7.x/docs/classes/BasePodIdRoute.html @@ -0,0 +1,152 @@ +BasePodIdRoute | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..3c3ec6d79 --- /dev/null +++ b/7.x/docs/classes/BasePodStore.html @@ -0,0 +1,426 @@ +BasePodStore | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..511116808 --- /dev/null +++ b/7.x/docs/classes/BaseReadWriteLocker.html @@ -0,0 +1,383 @@ +BaseReadWriteLocker | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..562ddee39 --- /dev/null +++ b/7.x/docs/classes/BaseResourceStore.html @@ -0,0 +1,284 @@ +BaseResourceStore | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..10907d1de --- /dev/null +++ b/7.x/docs/classes/BaseResourcesGenerator.html @@ -0,0 +1,330 @@ +BaseResourcesGenerator | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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<any>>
+
+

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..8f6f9de99 --- /dev/null +++ b/7.x/docs/classes/BaseRouterHandler.html @@ -0,0 +1,252 @@ +BaseRouterHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..a6df3eef0 --- /dev/null +++ b/7.x/docs/classes/BaseServerFactory.html @@ -0,0 +1,160 @@ +BaseServerFactory | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..e70956156 --- /dev/null +++ b/7.x/docs/classes/BaseStateHandler.html @@ -0,0 +1,217 @@ +BaseStateHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..79979b3ce --- /dev/null +++ b/7.x/docs/classes/BaseTypedRepresentationConverter.html @@ -0,0 +1,233 @@ +BaseTypedRepresentationConverter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..7c8a25499 --- /dev/null +++ b/7.x/docs/classes/BaseUrlExtractor.html @@ -0,0 +1,191 @@ +BaseUrlExtractor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..5619b4eb9 --- /dev/null +++ b/7.x/docs/classes/BaseUrlHandler.html @@ -0,0 +1,188 @@ +BaseUrlHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..86aaa8946 --- /dev/null +++ b/7.x/docs/classes/BaseUrlRouterRule.html @@ -0,0 +1,236 @@ +BaseUrlRouterRule | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

+
+
+

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..3af7569b6 --- /dev/null +++ b/7.x/docs/classes/BaseUrlVerifier.html @@ -0,0 +1,208 @@ +BaseUrlVerifier | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..06a4e1b17 --- /dev/null +++ b/7.x/docs/classes/BaseWebIdLinkRoute.html @@ -0,0 +1,152 @@ +BaseWebIdLinkRoute | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..5c4a9a7d3 --- /dev/null +++ b/7.x/docs/classes/BaseWebIdStore.html @@ -0,0 +1,326 @@ +BaseWebIdStore | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..db1c82815 --- /dev/null +++ b/7.x/docs/classes/BasicConditions.html @@ -0,0 +1,193 @@ +BasicConditions | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..c9bd09689 --- /dev/null +++ b/7.x/docs/classes/BasicConditionsParser.html @@ -0,0 +1,246 @@ +BasicConditionsParser | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..508b2fa5a --- /dev/null +++ b/7.x/docs/classes/BasicETagHandler.html @@ -0,0 +1,183 @@ +BasicETagHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..eaeb97805 --- /dev/null +++ b/7.x/docs/classes/BasicRepresentation.html @@ -0,0 +1,301 @@ +BasicRepresentation | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..6383547a1 --- /dev/null +++ b/7.x/docs/classes/BasicRequestParser.html @@ -0,0 +1,220 @@ +BasicRequestParser | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..d68258256 --- /dev/null +++ b/7.x/docs/classes/BasicResponseWriter.html @@ -0,0 +1,212 @@ +BasicResponseWriter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..e29d4b961 --- /dev/null +++ b/7.x/docs/classes/BearerWebIdExtractor.html @@ -0,0 +1,192 @@ +BearerWebIdExtractor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..50ba4417a --- /dev/null +++ b/7.x/docs/classes/BinarySliceResourceStore.html @@ -0,0 +1,325 @@ +BinarySliceResourceStore | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..706073048 --- /dev/null +++ b/7.x/docs/classes/BodyParser.html @@ -0,0 +1,175 @@ +BodyParser | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..2ad8f40d3 --- /dev/null +++ b/7.x/docs/classes/BooleanHandler.html @@ -0,0 +1,214 @@ +BooleanHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..304ebc7fd --- /dev/null +++ b/7.x/docs/classes/CachedHandler.html @@ -0,0 +1,273 @@ +CachedHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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, any>

    • +
  • +

    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 if 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..69e0c42aa --- /dev/null +++ b/7.x/docs/classes/CachedJwkGenerator.html @@ -0,0 +1,184 @@ +CachedJwkGenerator | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..352a388f8 --- /dev/null +++ b/7.x/docs/classes/CachedResourceSet.html @@ -0,0 +1,148 @@ +CachedResourceSet | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..bac3d43d5 --- /dev/null +++ b/7.x/docs/classes/CancelOidcHandler.html @@ -0,0 +1,171 @@ +CancelOidcHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Class CancelOidcHandler

+
+

Cancel an active OIDC interaction.

+
+
+
+

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/ChainedConverter.html b/7.x/docs/classes/ChainedConverter.html new file mode 100644 index 000000000..85a77f11a --- /dev/null +++ b/7.x/docs/classes/ChainedConverter.html @@ -0,0 +1,419 @@ +ChainedConverter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..673e4817a --- /dev/null +++ b/7.x/docs/classes/ChainedTemplateEngine.html @@ -0,0 +1,227 @@ +ChainedTemplateEngine | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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<any> = Dict<any>

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
chainedEngines +firstEngine +renderedName +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly chainedEngines

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

Private Readonly firstEngine

+
firstEngine: TemplateEngine<T>
+
+

Private Readonly renderedName

+
renderedName: string
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks if 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..67ae09762 --- /dev/null +++ b/7.x/docs/classes/CliExtractor.html @@ -0,0 +1,184 @@ +CliExtractor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..c05ca41e9 --- /dev/null +++ b/7.x/docs/classes/CliResolver.html @@ -0,0 +1,119 @@ +CliResolver | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..c4ed36c20 --- /dev/null +++ b/7.x/docs/classes/ClientCredentialsAdapter.html @@ -0,0 +1,271 @@ +ClientCredentialsAdapter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..db139e510 --- /dev/null +++ b/7.x/docs/classes/ClientCredentialsAdapterFactory.html @@ -0,0 +1,155 @@ +ClientCredentialsAdapterFactory | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..bda90552b --- /dev/null +++ b/7.x/docs/classes/ClientCredentialsDetailsHandler.html @@ -0,0 +1,206 @@ +ClientCredentialsDetailsHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

+
+
+

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..1355f22db --- /dev/null +++ b/7.x/docs/classes/ClientIdAdapter.html @@ -0,0 +1,295 @@ +ClientIdAdapter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..3a40f569d --- /dev/null +++ b/7.x/docs/classes/ClientIdAdapterFactory.html @@ -0,0 +1,146 @@ +ClientIdAdapterFactory | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..1b8c8ffc9 --- /dev/null +++ b/7.x/docs/classes/ClientInfoHandler.html @@ -0,0 +1,190 @@ +ClientInfoHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

+
+
+

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..5d74bd66d --- /dev/null +++ b/7.x/docs/classes/ClusterManager.html @@ -0,0 +1,213 @@ +ClusterManager | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..8dab47201 --- /dev/null +++ b/7.x/docs/classes/CombinedShorthandResolver.html @@ -0,0 +1,190 @@ +CombinedShorthandResolver | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..231961fc0 --- /dev/null +++ b/7.x/docs/classes/ComposedAuxiliaryStrategy.html @@ -0,0 +1,336 @@ +ComposedAuxiliaryStrategy | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..4fb422bc0 --- /dev/null +++ b/7.x/docs/classes/ComposedNotificationHandler.html @@ -0,0 +1,213 @@ +ComposedNotificationHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..950c6c502 --- /dev/null +++ b/7.x/docs/classes/ConditionalHandler.html @@ -0,0 +1,266 @@ +ConditionalHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..0d60debb5 --- /dev/null +++ b/7.x/docs/classes/ConditionsParser.html @@ -0,0 +1,173 @@ +ConditionsParser | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Class ConditionsParserAbstract

+
+

Creates a Conditions object based on the input HttpRequest.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks if 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..36c6fc8b2 --- /dev/null +++ b/7.x/docs/classes/ConfigPodInitializer.html @@ -0,0 +1,215 @@ +ConfigPodInitializer | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..2b19e6a96 --- /dev/null +++ b/7.x/docs/classes/ConfigPodManager.html @@ -0,0 +1,196 @@ +ConfigPodManager | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..7be84fff2 --- /dev/null +++ b/7.x/docs/classes/ConflictHttpError.html @@ -0,0 +1,228 @@ +ConflictHttpError | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: any
      +

      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..c6595f6e0 --- /dev/null +++ b/7.x/docs/classes/ConsentHandler.html @@ -0,0 +1,251 @@ +ConsentHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

+
+
+

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..023550090 --- /dev/null +++ b/7.x/docs/classes/ConstantConverter.html @@ -0,0 +1,226 @@ +ConstantConverter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 +options +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly contentType

+
contentType: string
+
+

Private Readonly filePath

+
filePath: string
+
+

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..8c7ebadf7 --- /dev/null +++ b/7.x/docs/classes/ConstantMetadataWriter.html @@ -0,0 +1,193 @@ +ConstantMetadataWriter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..0fbf86e5f --- /dev/null +++ b/7.x/docs/classes/ContainerInitializer.html @@ -0,0 +1,218 @@ +ContainerInitializer | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..2e64680d1 --- /dev/null +++ b/7.x/docs/classes/ContainerPathStorage.html @@ -0,0 +1,288 @@ +ContainerPathStorage | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..2383981b8 --- /dev/null +++ b/7.x/docs/classes/ContainerToTemplateConverter.html @@ -0,0 +1,301 @@ +ContainerToTemplateConverter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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<any>>
+
+

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..369634989 --- /dev/null +++ b/7.x/docs/classes/ContentLengthParser.html @@ -0,0 +1,198 @@ +ContentLengthParser | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..309ada0bc --- /dev/null +++ b/7.x/docs/classes/ContentTypeMetadataWriter.html @@ -0,0 +1,176 @@ +ContentTypeMetadataWriter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..48e48eeaa --- /dev/null +++ b/7.x/docs/classes/ContentTypeParser.html @@ -0,0 +1,186 @@ +ContentTypeParser | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..9d1867564 --- /dev/null +++ b/7.x/docs/classes/ContentTypeReplacer.html @@ -0,0 +1,243 @@ +ContentTypeReplacer | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..63ad00ec6 --- /dev/null +++ b/7.x/docs/classes/ContextDocumentLoader.html @@ -0,0 +1,140 @@ +ContextDocumentLoader | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..6ff7e3aaf --- /dev/null +++ b/7.x/docs/classes/ControlHandler.html @@ -0,0 +1,277 @@ +ControlHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..9ee66c89d --- /dev/null +++ b/7.x/docs/classes/ConvertingErrorHandler.html @@ -0,0 +1,247 @@ +ConvertingErrorHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..cb555a930 --- /dev/null +++ b/7.x/docs/classes/ConvertingNotificationSerializer.html @@ -0,0 +1,200 @@ +ConvertingNotificationSerializer | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..42e491285 --- /dev/null +++ b/7.x/docs/classes/ConvertingOperationHttpHandler.html @@ -0,0 +1,200 @@ +ConvertingOperationHttpHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..c13696d5c --- /dev/null +++ b/7.x/docs/classes/ConvertingPatcher.html @@ -0,0 +1,242 @@ +ConvertingPatcher | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..42be45c1d --- /dev/null +++ b/7.x/docs/classes/ConvertingRouterRule.html @@ -0,0 +1,251 @@ +ConvertingRouterRule | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

+
+
+

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..f0892d16d --- /dev/null +++ b/7.x/docs/classes/CookieInteractionHandler.html @@ -0,0 +1,212 @@ +CookieInteractionHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..26fb63e01 --- /dev/null +++ b/7.x/docs/classes/CookieMetadataWriter.html @@ -0,0 +1,208 @@ +CookieMetadataWriter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..138a11288 --- /dev/null +++ b/7.x/docs/classes/CookieParser.html @@ -0,0 +1,208 @@ +CookieParser | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..a9df72862 --- /dev/null +++ b/7.x/docs/classes/CorsHandler.html @@ -0,0 +1,250 @@ +CorsHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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: (() => any);
            setHeader: ((key, value) => any);
            statusCode?: number;
        }
        +
          +
        • +
          end: (() => any)
          +
            +
          • +
              +
            • (): any
              • +
            • +

              Returns any

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

              Parameters

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

              Returns any

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

            Parameters

            +
              +
            • +
              Optional err: any
            +

            Returns any

      +

      Returns void

+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks if 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..53a9e4c7d --- /dev/null +++ b/7.x/docs/classes/CreateAccountHandler.html @@ -0,0 +1,265 @@ +CreateAccountHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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 if 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..b3eb54d0b --- /dev/null +++ b/7.x/docs/classes/CreateClientCredentialsHandler.html @@ -0,0 +1,235 @@ +CreateClientCredentialsHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

+
+
+

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..97866f4c1 --- /dev/null +++ b/7.x/docs/classes/CreateModesExtractor.html @@ -0,0 +1,199 @@ +CreateModesExtractor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..ba3ddfc3f --- /dev/null +++ b/7.x/docs/classes/CreatePasswordHandler.html @@ -0,0 +1,226 @@ +CreatePasswordHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

+
+
+

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..438706adf --- /dev/null +++ b/7.x/docs/classes/CreatePodHandler.html @@ -0,0 +1,268 @@ +CreatePodHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

+
+
+

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..b5f7c83c7 --- /dev/null +++ b/7.x/docs/classes/CreatedResponseDescription.html @@ -0,0 +1,129 @@ +CreatedResponseDescription | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..236ef94bf --- /dev/null +++ b/7.x/docs/classes/CredentialsExtractor.html @@ -0,0 +1,177 @@ +CredentialsExtractor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Class CredentialsExtractorAbstract

+
+

Responsible for extracting credentials from an incoming request.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks if 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..9ab41a3ed --- /dev/null +++ b/7.x/docs/classes/DPoPWebIdExtractor.html @@ -0,0 +1,208 @@ +DPoPWebIdExtractor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..5594f8967 --- /dev/null +++ b/7.x/docs/classes/DataAccessorBasedStore.html @@ -0,0 +1,851 @@ +DataAccessorBasedStore | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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. +In case of 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..316e9b93e --- /dev/null +++ b/7.x/docs/classes/DeleteClientCredentialsHandler.html @@ -0,0 +1,199 @@ +DeleteClientCredentialsHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

+
+
+

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..4fe94c613 --- /dev/null +++ b/7.x/docs/classes/DeleteNotificationGenerator.html @@ -0,0 +1,173 @@ +DeleteNotificationGenerator | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..fe9ddbbbc --- /dev/null +++ b/7.x/docs/classes/DeleteOperationHandler.html @@ -0,0 +1,191 @@ +DeleteOperationHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..51d1a11a4 --- /dev/null +++ b/7.x/docs/classes/DeleteParentExtractor.html @@ -0,0 +1,213 @@ +DeleteParentExtractor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..4ec25cab2 --- /dev/null +++ b/7.x/docs/classes/DeletePasswordHandler.html @@ -0,0 +1,199 @@ +DeletePasswordHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

+
+
+

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..c04371fbd --- /dev/null +++ b/7.x/docs/classes/DynamicJsonToTemplateConverter.html @@ -0,0 +1,240 @@ +DynamicJsonToTemplateConverter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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<any>>
+
+

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..400490516 --- /dev/null +++ b/7.x/docs/classes/EjsTemplateEngine.html @@ -0,0 +1,217 @@ +EjsTemplateEngine | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Class EjsTemplateEngine<T>

+
+

Fills in EJS templates.

+
+
+
+

Type Parameters

+
    +
  • +

    T extends Dict<any> = Dict<any>

+
+

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..4f8d4e884 --- /dev/null +++ b/7.x/docs/classes/EmailSender.html @@ -0,0 +1,173 @@ +EmailSender | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Class EmailSenderAbstract

+
+

A class that can send an e-mail.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks if 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..0c805a293 --- /dev/null +++ b/7.x/docs/classes/EqualReadWriteLocker.html @@ -0,0 +1,240 @@ +EqualReadWriteLocker | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..e0094344f --- /dev/null +++ b/7.x/docs/classes/ErrorHandler.html @@ -0,0 +1,175 @@ +ErrorHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..24abfb15f --- /dev/null +++ b/7.x/docs/classes/ErrorToJsonConverter.html @@ -0,0 +1,230 @@ +ErrorToJsonConverter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..aef4bb574 --- /dev/null +++ b/7.x/docs/classes/ErrorToQuadConverter.html @@ -0,0 +1,215 @@ +ErrorToQuadConverter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..a1e494a44 --- /dev/null +++ b/7.x/docs/classes/ErrorToTemplateConverter.html @@ -0,0 +1,264 @@ +ErrorToTemplateConverter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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<any>>
+
+

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..c5a146c40 --- /dev/null +++ b/7.x/docs/classes/ExpiringAdapter.html @@ -0,0 +1,311 @@ +ExpiringAdapter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..1e16ce059 --- /dev/null +++ b/7.x/docs/classes/ExpiringAdapterFactory.html @@ -0,0 +1,134 @@ +ExpiringAdapterFactory | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..103804068 --- /dev/null +++ b/7.x/docs/classes/ExtensionBasedMapper.html @@ -0,0 +1,507 @@ +ExtensionBasedMapper | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..18d8bc0fa --- /dev/null +++ b/7.x/docs/classes/ExtensionBasedMapperFactory.html @@ -0,0 +1,118 @@ +ExtensionBasedMapperFactory | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..7fcb9a813 --- /dev/null +++ b/7.x/docs/classes/ExtensionBasedTemplateEngine.html @@ -0,0 +1,209 @@ +ExtensionBasedTemplateEngine | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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<any> = Dict<any>

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
supportedExtensions +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

Protected constructor

+
+
+

Properties

+
+

Protected Readonly supportedExtensions

+
supportedExtensions: string[]
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks if 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..025df0bb5 --- /dev/null +++ b/7.x/docs/classes/FileDataAccessor.html @@ -0,0 +1,561 @@ +FileDataAccessor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..f4ad342ae --- /dev/null +++ b/7.x/docs/classes/FileSizeReporter.html @@ -0,0 +1,233 @@ +FileSizeReporter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..8bfbeb568 --- /dev/null +++ b/7.x/docs/classes/FileSystemResourceLocker.html @@ -0,0 +1,356 @@ +FileSystemResourceLocker | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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: any
    +

    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..20b8d0ff8 --- /dev/null +++ b/7.x/docs/classes/FilterMetadataDataAccessor.html @@ -0,0 +1,374 @@ +FilterMetadataDataAccessor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..ed31a6caf --- /dev/null +++ b/7.x/docs/classes/FilterPattern.html @@ -0,0 +1,137 @@ +FilterPattern | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..5bf8ccfd8 --- /dev/null +++ b/7.x/docs/classes/FinalizableHandler.html @@ -0,0 +1,182 @@ +FinalizableHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..419c47623 --- /dev/null +++ b/7.x/docs/classes/Finalizer.html @@ -0,0 +1,173 @@ +Finalizer | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..018fbef73 --- /dev/null +++ b/7.x/docs/classes/FixedContentTypeMapper.html @@ -0,0 +1,504 @@ +FixedContentTypeMapper | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..dd87666dd --- /dev/null +++ b/7.x/docs/classes/ForbiddenHttpError.html @@ -0,0 +1,228 @@ +ForbiddenHttpError | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: any
      +

      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..9f45b6c29 --- /dev/null +++ b/7.x/docs/classes/ForgetWebIdHandler.html @@ -0,0 +1,191 @@ +ForgetWebIdHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

+
+
+

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..d433e86a3 --- /dev/null +++ b/7.x/docs/classes/ForgotPasswordHandler.html @@ -0,0 +1,264 @@ +ForgotPasswordHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

+
+
+

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..e50023782 --- /dev/null +++ b/7.x/docs/classes/FormToJsonConverter.html @@ -0,0 +1,216 @@ +FormToJsonConverter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..87030d8b0 --- /dev/null +++ b/7.x/docs/classes/FoundHttpError.html @@ -0,0 +1,239 @@ +FoundHttpError | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: any
      +

      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..9cdd0ed44 --- /dev/null +++ b/7.x/docs/classes/GeneratedPodManager.html @@ -0,0 +1,157 @@ +GeneratedPodManager | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..55cd06c41 --- /dev/null +++ b/7.x/docs/classes/GetOperationHandler.html @@ -0,0 +1,200 @@ +GetOperationHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..5c5fea79a --- /dev/null +++ b/7.x/docs/classes/GlobalQuotaStrategy.html @@ -0,0 +1,227 @@ +GlobalQuotaStrategy | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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<any>
+
+

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..de8c2e1de --- /dev/null +++ b/7.x/docs/classes/GreedyReadWriteLocker.html @@ -0,0 +1,354 @@ +GreedyReadWriteLocker | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..fd9f37979 --- /dev/null +++ b/7.x/docs/classes/HandlebarsTemplateEngine.html @@ -0,0 +1,217 @@ +HandlebarsTemplateEngine | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Class HandlebarsTemplateEngine<T>

+
+

Fills in Handlebars templates.

+
+
+
+

Type Parameters

+
    +
  • +

    T extends Dict<any> = Dict<any>

+
+

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..d21b29ad4 --- /dev/null +++ b/7.x/docs/classes/HandlerServerConfigurator.html @@ -0,0 +1,245 @@ +HandlerServerConfigurator | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..91d59f66b --- /dev/null +++ b/7.x/docs/classes/HashEncodingStorage.html @@ -0,0 +1,282 @@ +HashEncodingStorage | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..48381be1a --- /dev/null +++ b/7.x/docs/classes/HashMap.html @@ -0,0 +1,346 @@ +HashMap | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 = any

    • +
  • +

    TVal = any

+
+

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 = any

      • +
    • +

      TVal = any

    +
    +

    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: any
    +

    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..2b2ce3063 --- /dev/null +++ b/7.x/docs/classes/HeadOperationHandler.html @@ -0,0 +1,200 @@ +HeadOperationHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..3c3e574ad --- /dev/null +++ b/7.x/docs/classes/HeaderHandler.html @@ -0,0 +1,193 @@ +HeaderHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..cec3cd908 --- /dev/null +++ b/7.x/docs/classes/HtmlViewEntry.html @@ -0,0 +1,121 @@ +HtmlViewEntry | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..c9333495c --- /dev/null +++ b/7.x/docs/classes/HtmlViewHandler.html @@ -0,0 +1,232 @@ +HtmlViewHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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<any>>
+
+

Private Readonly templates

+
templates: HtmlViewEntry[]
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks if 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..4f1fbf970 --- /dev/null +++ b/7.x/docs/classes/HttpError.html @@ -0,0 +1,289 @@ +HttpError | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..561abdf49 --- /dev/null +++ b/7.x/docs/classes/HttpHandler.html @@ -0,0 +1,180 @@ +HttpHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Class HttpHandlerAbstract

+
+

An HTTP request handler.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks if 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..ff3fb0ee1 --- /dev/null +++ b/7.x/docs/classes/IdInteractionRoute.html @@ -0,0 +1,203 @@ +IdInteractionRoute | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..cb1663efb --- /dev/null +++ b/7.x/docs/classes/IdentifierMap.html @@ -0,0 +1,298 @@ +IdentifierMap | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..5f70ec373 --- /dev/null +++ b/7.x/docs/classes/IdentifierSetMultiMap.html @@ -0,0 +1,445 @@ +IdentifierSetMultiMap | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..9387ce9f3 --- /dev/null +++ b/7.x/docs/classes/IdentityProviderFactory.html @@ -0,0 +1,409 @@ +IdentityProviderFactory | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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, unknown>
+
+

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 if the given token is an access token. +The AccessToken interface is not exported so we have to access it like this.

    +
    +
    +

    Parameters

    +
      +
    • +
      token: any
    +

    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..214f326b7 --- /dev/null +++ b/7.x/docs/classes/IdentityProviderHttpHandler.html @@ -0,0 +1,213 @@ +IdentityProviderHttpHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..19650e716 --- /dev/null +++ b/7.x/docs/classes/ImmutableMetadataPatcher.html @@ -0,0 +1,218 @@ +ImmutableMetadataPatcher | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..ad2420b0d --- /dev/null +++ b/7.x/docs/classes/InMemoryDataAccessor.html @@ -0,0 +1,418 @@ +InMemoryDataAccessor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..485c95a1d --- /dev/null +++ b/7.x/docs/classes/IndexRepresentationStore.html @@ -0,0 +1,355 @@ +IndexRepresentationStore | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..d4d425756 --- /dev/null +++ b/7.x/docs/classes/InitializableHandler.html @@ -0,0 +1,182 @@ +InitializableHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..a2beed8d9 --- /dev/null +++ b/7.x/docs/classes/Initializer.html @@ -0,0 +1,188 @@ +Initializer | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..6e6530d1c --- /dev/null +++ b/7.x/docs/classes/InteractionHandler.html @@ -0,0 +1,175 @@ +InteractionHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Class InteractionHandlerAbstract

+
+

Handler used for IDP interactions.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks if 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..8dc2398f1 --- /dev/null +++ b/7.x/docs/classes/InteractionRouteHandler.html @@ -0,0 +1,213 @@ +InteractionRouteHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..7a78c366d --- /dev/null +++ b/7.x/docs/classes/IntermediateCreateExtractor.html @@ -0,0 +1,224 @@ +IntermediateCreateExtractor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..77a287194 --- /dev/null +++ b/7.x/docs/classes/InternalServerError.html @@ -0,0 +1,228 @@ +InternalServerError | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: any
      +

      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..022d9aa11 --- /dev/null +++ b/7.x/docs/classes/JsonConversionHandler.html @@ -0,0 +1,204 @@ +JsonConversionHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..07dc819af --- /dev/null +++ b/7.x/docs/classes/JsonFileStorage.html @@ -0,0 +1,302 @@ +JsonFileStorage | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..9445a8691 --- /dev/null +++ b/7.x/docs/classes/JsonInteractionHandler.html @@ -0,0 +1,210 @@ +JsonInteractionHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..88b213545 --- /dev/null +++ b/7.x/docs/classes/JsonLdNotificationSerializer.html @@ -0,0 +1,171 @@ +JsonLdNotificationSerializer | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Class JsonLdNotificationSerializer

+
+

Serializes a Notification into a JSON-LD string.

+
+
+
+

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/JsonResourceStorage.html b/7.x/docs/classes/JsonResourceStorage.html new file mode 100644 index 000000000..046f58673 --- /dev/null +++ b/7.x/docs/classes/JsonResourceStorage.html @@ -0,0 +1,332 @@ +JsonResourceStorage | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..03928a3ce --- /dev/null +++ b/7.x/docs/classes/KeyExtractor.html @@ -0,0 +1,200 @@ +KeyExtractor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..6bd4da631 --- /dev/null +++ b/7.x/docs/classes/KeyValueChannelStorage.html @@ -0,0 +1,299 @@ +KeyValueChannelStorage | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..53ed0833e --- /dev/null +++ b/7.x/docs/classes/LazyLoggerFactory.html @@ -0,0 +1,173 @@ +LazyLoggerFactory | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..b951e8434 --- /dev/null +++ b/7.x/docs/classes/LinkMetadataGenerator.html @@ -0,0 +1,201 @@ +LinkMetadataGenerator | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..f79a37f84 --- /dev/null +++ b/7.x/docs/classes/LinkRelMetadataWriter.html @@ -0,0 +1,203 @@ +LinkRelMetadataWriter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..8da2e7f76 --- /dev/null +++ b/7.x/docs/classes/LinkRelObject.html @@ -0,0 +1,195 @@ +LinkRelObject | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..ae0fe8fca --- /dev/null +++ b/7.x/docs/classes/LinkRelParser.html @@ -0,0 +1,212 @@ +LinkRelParser | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..6e57b106f --- /dev/null +++ b/7.x/docs/classes/LinkWebIdHandler.html @@ -0,0 +1,253 @@ +LinkWebIdHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

+
+
+

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..414f78b02 --- /dev/null +++ b/7.x/docs/classes/ListeningActivityHandler.html @@ -0,0 +1,224 @@ +ListeningActivityHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if the input can be handled by this class. +If it cannot handle the input, rejects with an error explaining why.

    +
    +
    +

    Parameters

    +
      +
    • +
      input: any
      +

      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#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: any
      +

      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..ec922c27c --- /dev/null +++ b/7.x/docs/classes/LocationInteractionHandler.html @@ -0,0 +1,210 @@ +LocationInteractionHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..f6f0d9c05 --- /dev/null +++ b/7.x/docs/classes/LockingInteractionHandler.html @@ -0,0 +1,209 @@ +LockingInteractionHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..06d494883 --- /dev/null +++ b/7.x/docs/classes/LockingResourceStore.html @@ -0,0 +1,441 @@ +LockingResourceStore | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..f988e118c --- /dev/null +++ b/7.x/docs/classes/LoggerInitializer.html @@ -0,0 +1,182 @@ +LoggerInitializer | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..ed9b141db --- /dev/null +++ b/7.x/docs/classes/LogoutHandler.html @@ -0,0 +1,191 @@ +LogoutHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

+
+
+

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..0649aafde --- /dev/null +++ b/7.x/docs/classes/MappedMetadataWriter.html @@ -0,0 +1,196 @@ +MappedMetadataWriter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..7806005b3 --- /dev/null +++ b/7.x/docs/classes/MarkdownToHtmlConverter.html @@ -0,0 +1,230 @@ +MarkdownToHtmlConverter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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<any>>
+
+

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..7c820c804 --- /dev/null +++ b/7.x/docs/classes/MaxKeyLengthStorage.html @@ -0,0 +1,319 @@ +MaxKeyLengthStorage | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..3ecf4585b --- /dev/null +++ b/7.x/docs/classes/MemoryMapStorage.html @@ -0,0 +1,227 @@ +MemoryMapStorage | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..f628d9fc1 --- /dev/null +++ b/7.x/docs/classes/MemoryResourceLocker.html @@ -0,0 +1,199 @@ +MemoryResourceLocker | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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. +In case 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..b8a8c215c --- /dev/null +++ b/7.x/docs/classes/MetadataGenerator.html @@ -0,0 +1,173 @@ +MetadataGenerator | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Class MetadataGeneratorAbstract

+
+

Generic interface for classes that add metadata to a RepresentationMetadata.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks if 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..7fb2f5d3a --- /dev/null +++ b/7.x/docs/classes/MetadataParser.html @@ -0,0 +1,195 @@ +MetadataParser | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..4423cf388 --- /dev/null +++ b/7.x/docs/classes/MetadataWriter.html @@ -0,0 +1,185 @@ +MetadataWriter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Class MetadataWriterAbstract

+
+

A serializer that converts metadata to headers for an HttpResponse.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks if 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..c92b238ca --- /dev/null +++ b/7.x/docs/classes/MethodFilterHandler.html @@ -0,0 +1,233 @@ +MethodFilterHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..246e53ea9 --- /dev/null +++ b/7.x/docs/classes/MethodModesExtractor.html @@ -0,0 +1,198 @@ +MethodModesExtractor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..c052c91e0 --- /dev/null +++ b/7.x/docs/classes/MethodNotAllowedHttpError.html @@ -0,0 +1,238 @@ +MethodNotAllowedHttpError | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: any
      +

      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..b70a3a67c --- /dev/null +++ b/7.x/docs/classes/ModesExtractor.html @@ -0,0 +1,178 @@ +ModesExtractor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..cc01d0838 --- /dev/null +++ b/7.x/docs/classes/ModifiedMetadataWriter.html @@ -0,0 +1,176 @@ +ModifiedMetadataWriter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..6a2062ca1 --- /dev/null +++ b/7.x/docs/classes/ModuleVersionVerifier.html @@ -0,0 +1,193 @@ +ModuleVersionVerifier | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..1be6068f9 --- /dev/null +++ b/7.x/docs/classes/MonitoringStore.html @@ -0,0 +1,1082 @@ +MonitoringStore | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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#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#Create" | "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "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#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#Create" | "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "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#Create" | "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "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#Create" | "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "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#Create" | "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "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#Create" | "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "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#Create" | "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "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#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#Create" | "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "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#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#Create" | "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "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#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#Create" | "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "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#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#Create" | "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "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#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#Create" | "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "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#Create" | "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "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#Create" | "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "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#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#Create" | "https://www.w3.org/ns/activitystreams#object" | "https://www.w3.org/ns/activitystreams#Add" | "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..79d92c1a3 --- /dev/null +++ b/7.x/docs/classes/MovedPermanentlyHttpError.html @@ -0,0 +1,239 @@ +MovedPermanentlyHttpError | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: any
      +

      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..cdcc4270f --- /dev/null +++ b/7.x/docs/classes/N3PatchBodyParser.html @@ -0,0 +1,265 @@ +N3PatchBodyParser | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..866b62a01 --- /dev/null +++ b/7.x/docs/classes/N3PatchModesExtractor.html @@ -0,0 +1,201 @@ +N3PatchModesExtractor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..53b1a0b94 --- /dev/null +++ b/7.x/docs/classes/N3Patcher.html @@ -0,0 +1,244 @@ +N3Patcher | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..ae0f5494a --- /dev/null +++ b/7.x/docs/classes/NoCheckOwnershipValidator.html @@ -0,0 +1,193 @@ +NoCheckOwnershipValidator | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..f387a0548 --- /dev/null +++ b/7.x/docs/classes/NotFoundHttpError.html @@ -0,0 +1,228 @@ +NotFoundHttpError | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: any
      +

      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..0eee44370 --- /dev/null +++ b/7.x/docs/classes/NotImplementedHttpError.html @@ -0,0 +1,229 @@ +NotImplementedHttpError | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: any
      +

      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..67a6a8f78 --- /dev/null +++ b/7.x/docs/classes/NotificationDescriber.html @@ -0,0 +1,203 @@ +NotificationDescriber | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..9354d31c6 --- /dev/null +++ b/7.x/docs/classes/NotificationEmitter.html @@ -0,0 +1,174 @@ +NotificationEmitter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Class NotificationEmitterAbstract

+
+

Emits a serialized Notification to the channel.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks if 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..4e7aec147 --- /dev/null +++ b/7.x/docs/classes/NotificationGenerator.html @@ -0,0 +1,176 @@ +NotificationGenerator | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Class NotificationGeneratorAbstract

+
+

Creates a Notification based on the provided input.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks if 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..dfb737f41 --- /dev/null +++ b/7.x/docs/classes/NotificationHandler.html @@ -0,0 +1,174 @@ +NotificationHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Class NotificationHandlerAbstract

+
+

Makes sure an activity gets emitted to the relevant channel.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks if 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..5bca709dd --- /dev/null +++ b/7.x/docs/classes/NotificationSerializer.html @@ -0,0 +1,176 @@ +NotificationSerializer | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..260d57e3e --- /dev/null +++ b/7.x/docs/classes/NotificationSubscriber.html @@ -0,0 +1,259 @@ +NotificationSubscriber | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..65d9be402 --- /dev/null +++ b/7.x/docs/classes/NotificationUnsubscriber.html @@ -0,0 +1,198 @@ +NotificationUnsubscriber | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..585b03ecc --- /dev/null +++ b/7.x/docs/classes/OAuthHttpError.html @@ -0,0 +1,270 @@ +OAuthHttpError | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..f6e30b7b8 --- /dev/null +++ b/7.x/docs/classes/OidcControlHandler.html @@ -0,0 +1,256 @@ +OidcControlHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..b4a8107f6 --- /dev/null +++ b/7.x/docs/classes/OidcHttpHandler.html @@ -0,0 +1,197 @@ +OidcHttpHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..f08a5b505 --- /dev/null +++ b/7.x/docs/classes/OkResponseDescription.html @@ -0,0 +1,139 @@ +OkResponseDescription | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..9000f779f --- /dev/null +++ b/7.x/docs/classes/OperationHandler.html @@ -0,0 +1,178 @@ +OperationHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Class OperationHandlerAbstract

+
+

Handler for a specific operation type.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks if 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..6f63d1345 --- /dev/null +++ b/7.x/docs/classes/OperationHttpHandler.html @@ -0,0 +1,180 @@ +OperationHttpHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..57cfe10d5 --- /dev/null +++ b/7.x/docs/classes/OperationRouterHandler.html @@ -0,0 +1,243 @@ +OperationRouterHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..816a8e30c --- /dev/null +++ b/7.x/docs/classes/OriginalUrlExtractor.html @@ -0,0 +1,206 @@ +OriginalUrlExtractor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..00321a3d4 --- /dev/null +++ b/7.x/docs/classes/OwnerMetadataWriter.html @@ -0,0 +1,211 @@ +OwnerMetadataWriter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..12a496772 --- /dev/null +++ b/7.x/docs/classes/OwnerPermissionReader.html @@ -0,0 +1,253 @@ +OwnerPermissionReader | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..7429cf7d3 --- /dev/null +++ b/7.x/docs/classes/OwnershipValidator.html @@ -0,0 +1,185 @@ +OwnershipValidator | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..95472134d --- /dev/null +++ b/7.x/docs/classes/ParallelHandler.html @@ -0,0 +1,204 @@ +ParallelHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..c0ff7c9b2 --- /dev/null +++ b/7.x/docs/classes/ParentContainerReader.html @@ -0,0 +1,288 @@ +ParentContainerReader | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..3a47cfed6 --- /dev/null +++ b/7.x/docs/classes/ParsingHttpHandler.html @@ -0,0 +1,260 @@ +ParsingHttpHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..c4a2f3bbe --- /dev/null +++ b/7.x/docs/classes/PartialReadWriteLocker.html @@ -0,0 +1,309 @@ +PartialReadWriteLocker | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..9117b1e58 --- /dev/null +++ b/7.x/docs/classes/PassthroughAdapter.html @@ -0,0 +1,248 @@ +PassthroughAdapter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..7680895cc --- /dev/null +++ b/7.x/docs/classes/PassthroughAdapterFactory.html @@ -0,0 +1,140 @@ +PassthroughAdapterFactory | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..6beecd08b --- /dev/null +++ b/7.x/docs/classes/PassthroughConverter.html @@ -0,0 +1,171 @@ +PassthroughConverter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..ba4d4181b --- /dev/null +++ b/7.x/docs/classes/PassthroughDataAccessor.html @@ -0,0 +1,338 @@ +PassthroughDataAccessor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..0b5a65678 --- /dev/null +++ b/7.x/docs/classes/PassthroughKeyValueStorage.html @@ -0,0 +1,281 @@ +PassthroughKeyValueStorage | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..684501965 --- /dev/null +++ b/7.x/docs/classes/PassthroughStore.html @@ -0,0 +1,321 @@ +PassthroughStore | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..beee78343 --- /dev/null +++ b/7.x/docs/classes/PasswordLoginHandler.html @@ -0,0 +1,278 @@ +PasswordLoginHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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 if 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..12d95eeda --- /dev/null +++ b/7.x/docs/classes/PatchHandler.html @@ -0,0 +1,183 @@ +PatchHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Class PatchHandler<T>Abstract

+
+

Executes the given Patch.

+
+
+
+

Type Parameters

+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks if 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..e62d1f8b0 --- /dev/null +++ b/7.x/docs/classes/PatchOperationHandler.html @@ -0,0 +1,198 @@ +PatchOperationHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..aebc9f366 --- /dev/null +++ b/7.x/docs/classes/PatchingStore.html @@ -0,0 +1,324 @@ +PatchingStore | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..f83f4a954 --- /dev/null +++ b/7.x/docs/classes/PathBasedReader.html @@ -0,0 +1,246 @@ +PathBasedReader | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..4e6e45683 --- /dev/null +++ b/7.x/docs/classes/PermissionBasedAuthorizer.html @@ -0,0 +1,288 @@ +PermissionBasedAuthorizer | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..0392b4617 --- /dev/null +++ b/7.x/docs/classes/PermissionReader.html @@ -0,0 +1,182 @@ +PermissionReader | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Class PermissionReaderAbstract

+
+

Discovers the permissions of the given credentials on the given identifier. +In case 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 if 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..50288d0f4 --- /dev/null +++ b/7.x/docs/classes/PickWebIdHandler.html @@ -0,0 +1,232 @@ +PickWebIdHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

+
+
+

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..4846d0c8e --- /dev/null +++ b/7.x/docs/classes/PlainJsonLdFilter.html @@ -0,0 +1,216 @@ +PlainJsonLdFilter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..ca11a4016 --- /dev/null +++ b/7.x/docs/classes/PodCreator.html @@ -0,0 +1,173 @@ +PodCreator | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Class PodCreatorAbstract

+
+

Handles creating a pod and linking the created WebID.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks if 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..3f04e95f1 --- /dev/null +++ b/7.x/docs/classes/PodQuotaStrategy.html @@ -0,0 +1,262 @@ +PodQuotaStrategy | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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<any>
+
+

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..cb905ba1a --- /dev/null +++ b/7.x/docs/classes/PodStorageLocationStrategy.html @@ -0,0 +1,140 @@ +PodStorageLocationStrategy | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..354492dec --- /dev/null +++ b/7.x/docs/classes/PostOperationHandler.html @@ -0,0 +1,198 @@ +PostOperationHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..8b6922ce9 --- /dev/null +++ b/7.x/docs/classes/PreconditionFailedHttpError.html @@ -0,0 +1,228 @@ +PreconditionFailedHttpError | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: any
      +

      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..cdedba564 --- /dev/null +++ b/7.x/docs/classes/PreferenceParser.html @@ -0,0 +1,183 @@ +PreferenceParser | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..9078b51a5 --- /dev/null +++ b/7.x/docs/classes/PreferenceSupport.html @@ -0,0 +1,146 @@ +PreferenceSupport | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..040ef62ec --- /dev/null +++ b/7.x/docs/classes/ProcessHandler.html @@ -0,0 +1,251 @@ +ProcessHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..4627c583e --- /dev/null +++ b/7.x/docs/classes/PromptFactory.html @@ -0,0 +1,173 @@ +PromptFactory | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Class PromptFactoryAbstract

+
+

Used to generate custom interactionPolicy.Prompts.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks if 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..159161791 --- /dev/null +++ b/7.x/docs/classes/PromptHandler.html @@ -0,0 +1,203 @@ +PromptHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

+
+
+

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..f792d0433 --- /dev/null +++ b/7.x/docs/classes/PublicCredentialsExtractor.html @@ -0,0 +1,164 @@ +PublicCredentialsExtractor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..024cabc99 --- /dev/null +++ b/7.x/docs/classes/PutOperationHandler.html @@ -0,0 +1,207 @@ +PutOperationHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..ba2715c1b --- /dev/null +++ b/7.x/docs/classes/QuadToRdfConverter.html @@ -0,0 +1,230 @@ +QuadToRdfConverter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..899a99c30 --- /dev/null +++ b/7.x/docs/classes/QuotaStrategy.html @@ -0,0 +1,224 @@ +QuotaStrategy | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

+
+

constructor

+
+
+

Properties

+
+

Readonly limit

+
limit: Size
+
+

Readonly reporter

+
reporter: SizeReporter<any>
+
+

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..eacba95b6 --- /dev/null +++ b/7.x/docs/classes/QuotaValidator.html @@ -0,0 +1,190 @@ +QuotaValidator | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..8ba8075e2 --- /dev/null +++ b/7.x/docs/classes/RangeMetadataWriter.html @@ -0,0 +1,195 @@ +RangeMetadataWriter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..7a454e2a2 --- /dev/null +++ b/7.x/docs/classes/RangeNotSatisfiedHttpError.html @@ -0,0 +1,237 @@ +RangeNotSatisfiedHttpError | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: any
      +

      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..17651b9ec --- /dev/null +++ b/7.x/docs/classes/RangePreferenceParser.html @@ -0,0 +1,181 @@ +RangePreferenceParser | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..9e1da6522 --- /dev/null +++ b/7.x/docs/classes/RawBodyParser.html @@ -0,0 +1,183 @@ +RawBodyParser | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..9a97906f3 --- /dev/null +++ b/7.x/docs/classes/RdfPatcher.html @@ -0,0 +1,198 @@ +RdfPatcher | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..8080fb7bd --- /dev/null +++ b/7.x/docs/classes/RdfStorePatcher.html @@ -0,0 +1,171 @@ +RdfStorePatcher | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Class RdfStorePatcherAbstract

+
+

Applies a Patch on an N3.js Store.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks if 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..84f61ea97 --- /dev/null +++ b/7.x/docs/classes/RdfToQuadConverter.html @@ -0,0 +1,231 @@ +RdfToQuadConverter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..d3d93d5be --- /dev/null +++ b/7.x/docs/classes/RdfValidator.html @@ -0,0 +1,191 @@ +RdfValidator | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..0eca920a1 --- /dev/null +++ b/7.x/docs/classes/ReadOnlyStore.html @@ -0,0 +1,313 @@ +ReadOnlyStore | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..69780d5ab --- /dev/null +++ b/7.x/docs/classes/RecordObject.html @@ -0,0 +1,102 @@ +RecordObject | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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, any>
+
+
+
+ +
+
+

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..0fb6fbf25 --- /dev/null +++ b/7.x/docs/classes/RedirectHttpError.html @@ -0,0 +1,279 @@ +RedirectHttpError | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..49b60a35a --- /dev/null +++ b/7.x/docs/classes/RedirectingErrorHandler.html @@ -0,0 +1,172 @@ +RedirectingErrorHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..c123ef2c2 --- /dev/null +++ b/7.x/docs/classes/RedirectingHttpHandler.html @@ -0,0 +1,280 @@ +RedirectingHttpHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

+
+
+

Properties

+
+

Private Readonly baseUrl

+
baseUrl: string
+
+

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 if 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..f89a45c5e --- /dev/null +++ b/7.x/docs/classes/RedisLocker.html @@ -0,0 +1,488 @@ +RedisLocker | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

      +
      +
      • +
    • +
      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. +In case 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..4cc9fa3b2 --- /dev/null +++ b/7.x/docs/classes/RegexRouterRule.html @@ -0,0 +1,256 @@ +RegexRouterRule | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..f37b7f2ca --- /dev/null +++ b/7.x/docs/classes/RegexRule.html @@ -0,0 +1,118 @@ +RegexRule | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..5fc83673a --- /dev/null +++ b/7.x/docs/classes/RelativePathInteractionRoute.html @@ -0,0 +1,188 @@ +RelativePathInteractionRoute | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..29d872b57 --- /dev/null +++ b/7.x/docs/classes/RepresentationConverter.html @@ -0,0 +1,177 @@ +RepresentationConverter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..da376d22d --- /dev/null +++ b/7.x/docs/classes/RepresentationConvertingStore.html @@ -0,0 +1,375 @@ +RepresentationConvertingStore | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..a4e20d670 --- /dev/null +++ b/7.x/docs/classes/RepresentationMetadata.html @@ -0,0 +1,764 @@ +RepresentationMetadata | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..9c6854f54 --- /dev/null +++ b/7.x/docs/classes/RepresentationPatchHandler.html @@ -0,0 +1,200 @@ +RepresentationPatchHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..27afa9a46 --- /dev/null +++ b/7.x/docs/classes/RepresentationPatcher.html @@ -0,0 +1,187 @@ +RepresentationPatcher | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..e3039d6b4 --- /dev/null +++ b/7.x/docs/classes/RequestParser.html @@ -0,0 +1,173 @@ +RequestParser | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Class RequestParserAbstract

+
+

Converts an incoming HttpRequest to an Operation.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks if 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..ff9298246 --- /dev/null +++ b/7.x/docs/classes/ResetPasswordHandler.html @@ -0,0 +1,242 @@ +ResetPasswordHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

+
+
+

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..3809f8f3f --- /dev/null +++ b/7.x/docs/classes/ResetResponseDescription.html @@ -0,0 +1,124 @@ +ResetResponseDescription | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..9938a4c59 --- /dev/null +++ b/7.x/docs/classes/ResolveLoginHandler.html @@ -0,0 +1,258 @@ +ResolveLoginHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

+
+
+

handle

+
+
+

handleSafe

+
+
+

Abstract login

+
+
+

Protected updateRememberSetting

+
    + +
  • +

    Updates the account setting that determines if 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..7f11e8c88 --- /dev/null +++ b/7.x/docs/classes/ResponseDescription.html @@ -0,0 +1,141 @@ +ResponseDescription | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..9572af708 --- /dev/null +++ b/7.x/docs/classes/ResponseWriter.html @@ -0,0 +1,188 @@ +ResponseWriter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..ac38ae47a --- /dev/null +++ b/7.x/docs/classes/RootFilePathHandler.html @@ -0,0 +1,206 @@ +RootFilePathHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..b495c4b72 --- /dev/null +++ b/7.x/docs/classes/RootStorageLocationStrategy.html @@ -0,0 +1,133 @@ +RootStorageLocationStrategy | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..f9fefebd2 --- /dev/null +++ b/7.x/docs/classes/RouterHandler.html @@ -0,0 +1,251 @@ +RouterHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..dd10a4937 --- /dev/null +++ b/7.x/docs/classes/RouterRule.html @@ -0,0 +1,191 @@ +RouterRule | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..9f74c2fd1 --- /dev/null +++ b/7.x/docs/classes/RoutingAuxiliaryIdentifierStrategy.html @@ -0,0 +1,227 @@ +RoutingAuxiliaryIdentifierStrategy | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..d96ff66c2 --- /dev/null +++ b/7.x/docs/classes/RoutingAuxiliaryStrategy.html @@ -0,0 +1,334 @@ +RoutingAuxiliaryStrategy | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..ad29807b0 --- /dev/null +++ b/7.x/docs/classes/RoutingResourceStore.html @@ -0,0 +1,322 @@ +RoutingResourceStore | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..32a63fef7 --- /dev/null +++ b/7.x/docs/classes/SafeErrorHandler.html @@ -0,0 +1,207 @@ +SafeErrorHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..2ad57da08 --- /dev/null +++ b/7.x/docs/classes/SeededAccountInitializer.html @@ -0,0 +1,212 @@ +SeededAccountInitializer | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..d375b841a --- /dev/null +++ b/7.x/docs/classes/SequenceHandler.html @@ -0,0 +1,206 @@ +SequenceHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..df2f88d91 --- /dev/null +++ b/7.x/docs/classes/ServerConfigurator.html @@ -0,0 +1,174 @@ +ServerConfigurator | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Class ServerConfiguratorAbstract

+
+

Configures a Server by attaching listeners for specific events.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks if 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..0eb3670a7 --- /dev/null +++ b/7.x/docs/classes/ServerInitializer.html @@ -0,0 +1,229 @@ +ServerInitializer | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..0d9044e17 --- /dev/null +++ b/7.x/docs/classes/ShorthandExtractor.html @@ -0,0 +1,175 @@ +ShorthandExtractor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..a31358a80 --- /dev/null +++ b/7.x/docs/classes/ShorthandResolver.html @@ -0,0 +1,175 @@ +ShorthandResolver | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..848edec1e --- /dev/null +++ b/7.x/docs/classes/SingleContainerJsonStorage.html @@ -0,0 +1,334 @@ +SingleContainerJsonStorage | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..cdb380239 --- /dev/null +++ b/7.x/docs/classes/SingleRootIdentifierStrategy.html @@ -0,0 +1,213 @@ +SingleRootIdentifierStrategy | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..5d286dfc5 --- /dev/null +++ b/7.x/docs/classes/SliceStream.html @@ -0,0 +1,4044 @@ +SliceStream | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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: any
      • +
    • +
      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<T>

    +
    +

    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<T>

    +
    +

    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..3d647608c --- /dev/null +++ b/7.x/docs/classes/SlugParser.html @@ -0,0 +1,198 @@ +SlugParser | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..07a6301dc --- /dev/null +++ b/7.x/docs/classes/SparqlDataAccessor.html @@ -0,0 +1,607 @@ +SparqlDataAccessor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..5d6650194 --- /dev/null +++ b/7.x/docs/classes/SparqlUpdateBodyParser.html @@ -0,0 +1,184 @@ +SparqlUpdateBodyParser | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..77c8e1990 --- /dev/null +++ b/7.x/docs/classes/SparqlUpdateModesExtractor.html @@ -0,0 +1,304 @@ +SparqlUpdateModesExtractor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..440301b54 --- /dev/null +++ b/7.x/docs/classes/SparqlUpdatePatcher.html @@ -0,0 +1,311 @@ +SparqlUpdatePatcher | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..d563ea5c8 --- /dev/null +++ b/7.x/docs/classes/StateHandler.html @@ -0,0 +1,185 @@ +StateHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..1f82d39ec --- /dev/null +++ b/7.x/docs/classes/StateNotificationGenerator.html @@ -0,0 +1,200 @@ +StateNotificationGenerator | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..e8d4b4270 --- /dev/null +++ b/7.x/docs/classes/StaticAssetEntry.html @@ -0,0 +1,119 @@ +StaticAssetEntry | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..50504b2d9 --- /dev/null +++ b/7.x/docs/classes/StaticAssetHandler.html @@ -0,0 +1,280 @@ +StaticAssetHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..edf22a42c --- /dev/null +++ b/7.x/docs/classes/StaticFolderGenerator.html @@ -0,0 +1,156 @@ +StaticFolderGenerator | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..339648e64 --- /dev/null +++ b/7.x/docs/classes/StaticHandler.html @@ -0,0 +1,196 @@ +StaticHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 extends any = void

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
value? +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Optional Readonly value

+
value?: T
+
+

Methods

+
+

canHandle

+
    + +
  • +

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

    +
    +
    +

    Parameters

    +
      +
    • +
      input: any
      +

      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: any
      +

      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..e2ab1eb79 --- /dev/null +++ b/7.x/docs/classes/StaticInteractionHandler.html @@ -0,0 +1,185 @@ +StaticInteractionHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

+
+
+

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..aebaf8a2b --- /dev/null +++ b/7.x/docs/classes/StaticStorageDescriber.html @@ -0,0 +1,208 @@ +StaticStorageDescriber | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..9beef34e9 --- /dev/null +++ b/7.x/docs/classes/StaticTemplateEngine.html @@ -0,0 +1,218 @@ +StaticTemplateEngine | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Class StaticTemplateEngine<T>

+
+

Template engine that renders output based on a static template file.

+
+
+
+

Type Parameters

+
    +
  • +

    T extends Dict<any> = Dict<any>

+
+

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 if 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..b6f946217 --- /dev/null +++ b/7.x/docs/classes/StaticThrowHandler.html @@ -0,0 +1,182 @@ +StaticThrowHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Class StaticThrowHandler

+
+

Utility handler that can handle all input and always throws the given error.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
error +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Private Readonly error

+
error: HttpError<number>
+
+

Methods

+
+

canHandle

+
    + +
  • +

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

    +
    +
    +

    Parameters

    +
      +
    • +
      input: any
      +

      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: any
      +

      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..5f0490ebe --- /dev/null +++ b/7.x/docs/classes/StorageDescriber.html @@ -0,0 +1,174 @@ +StorageDescriber | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..ef7666d1a --- /dev/null +++ b/7.x/docs/classes/StorageDescriptionAdvertiser.html @@ -0,0 +1,208 @@ +StorageDescriptionAdvertiser | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..17ae9bf2c --- /dev/null +++ b/7.x/docs/classes/StorageDescriptionHandler.html @@ -0,0 +1,228 @@ +StorageDescriptionHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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/SubdomainExtensionBasedMapper.html b/7.x/docs/classes/SubdomainExtensionBasedMapper.html new file mode 100644 index 000000000..b7015e8e1 --- /dev/null +++ b/7.x/docs/classes/SubdomainExtensionBasedMapper.html @@ -0,0 +1,551 @@ +SubdomainExtensionBasedMapper | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..33c120641 --- /dev/null +++ b/7.x/docs/classes/SubdomainIdentifierGenerator.html @@ -0,0 +1,166 @@ +SubdomainIdentifierGenerator | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Class SubdomainIdentifierGenerator

+
+

Generates identifiers by using the name as a subdomain on the base URL. +Non-alphanumeric characters will be replaced with -.

+
+
+
+

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..39088bfb5 --- /dev/null +++ b/7.x/docs/classes/SubdomainIdentifierStrategy.html @@ -0,0 +1,220 @@ +SubdomainIdentifierStrategy | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..d25a779c4 --- /dev/null +++ b/7.x/docs/classes/SubfolderResourcesGenerator.html @@ -0,0 +1,167 @@ +SubfolderResourcesGenerator | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..71601ed64 --- /dev/null +++ b/7.x/docs/classes/SuffixAuxiliaryIdentifierStrategy.html @@ -0,0 +1,218 @@ +SuffixAuxiliaryIdentifierStrategy | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..b9e433d8f --- /dev/null +++ b/7.x/docs/classes/SuffixIdentifierGenerator.html @@ -0,0 +1,159 @@ +SuffixIdentifierGenerator | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..2b36cd3ed --- /dev/null +++ b/7.x/docs/classes/TargetExtractor.html @@ -0,0 +1,182 @@ +TargetExtractor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Class TargetExtractorAbstract

+
+

Extracts a ResourceIdentifier from an incoming HttpRequest.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks if 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/TemplateEngine.html b/7.x/docs/classes/TemplateEngine.html new file mode 100644 index 000000000..3c13dbe6b --- /dev/null +++ b/7.x/docs/classes/TemplateEngine.html @@ -0,0 +1,186 @@ +TemplateEngine | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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<any> = Dict<any>

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks if 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..cd45ad7c4 --- /dev/null +++ b/7.x/docs/classes/TemplatedPodGenerator.html @@ -0,0 +1,208 @@ +TemplatedPodGenerator | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..cbc2a6209 --- /dev/null +++ b/7.x/docs/classes/TokenOwnershipValidator.html @@ -0,0 +1,287 @@ +TokenOwnershipValidator | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..e6c4e6e76 --- /dev/null +++ b/7.x/docs/classes/TypedNotificationHandler.html @@ -0,0 +1,199 @@ +TypedNotificationHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..eb8e58853 --- /dev/null +++ b/7.x/docs/classes/TypedRepresentationConverter.html @@ -0,0 +1,192 @@ +TypedRepresentationConverter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..a2771586c --- /dev/null +++ b/7.x/docs/classes/UnauthorizedHttpError.html @@ -0,0 +1,228 @@ +UnauthorizedHttpError | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: any
      +

      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..086273405 --- /dev/null +++ b/7.x/docs/classes/UnionCredentialsExtractor.html @@ -0,0 +1,259 @@ +UnionCredentialsExtractor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..8799ae86b --- /dev/null +++ b/7.x/docs/classes/UnionHandler.html @@ -0,0 +1,280 @@ +UnionHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..36fc6dcdc --- /dev/null +++ b/7.x/docs/classes/UnionPermissionReader.html @@ -0,0 +1,271 @@ +UnionPermissionReader | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..e9aae43e0 --- /dev/null +++ b/7.x/docs/classes/UnionPreferenceParser.html @@ -0,0 +1,243 @@ +UnionPreferenceParser | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..a52a111ea --- /dev/null +++ b/7.x/docs/classes/UnlinkWebIdHandler.html @@ -0,0 +1,199 @@ +UnlinkWebIdHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

+
+
+

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..7bb1b8266 --- /dev/null +++ b/7.x/docs/classes/UnsecureConstantCredentialsExtractor.html @@ -0,0 +1,201 @@ +UnsecureConstantCredentialsExtractor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..a203f4285 --- /dev/null +++ b/7.x/docs/classes/UnsecureWebIdExtractor.html @@ -0,0 +1,183 @@ +UnsecureWebIdExtractor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..4bc0d195b --- /dev/null +++ b/7.x/docs/classes/UnsecureWebSocketsProtocol.html @@ -0,0 +1,227 @@ +UnsecureWebSocketsProtocol | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..fbe145b6f --- /dev/null +++ b/7.x/docs/classes/UnsupportedAsyncHandler.html @@ -0,0 +1,174 @@ +UnsupportedAsyncHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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: any
      +

      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..98e431c79 --- /dev/null +++ b/7.x/docs/classes/UnsupportedMediaTypeHttpError.html @@ -0,0 +1,228 @@ +UnsupportedMediaTypeHttpError | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: any
      +

      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..c89eb051d --- /dev/null +++ b/7.x/docs/classes/UpdateOwnerHandler.html @@ -0,0 +1,240 @@ +UpdateOwnerHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

+
+
+

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..e5e76430b --- /dev/null +++ b/7.x/docs/classes/UpdatePasswordHandler.html @@ -0,0 +1,221 @@ +UpdatePasswordHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

+
+
+

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..40cadee65 --- /dev/null +++ b/7.x/docs/classes/V6MigrationInitializer.html @@ -0,0 +1,331 @@ +V6MigrationInitializer | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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, any>[]
+
+

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 if 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..2bacc1351 --- /dev/null +++ b/7.x/docs/classes/ValidatingDataAccessor.html @@ -0,0 +1,343 @@ +ValidatingDataAccessor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..824608a28 --- /dev/null +++ b/7.x/docs/classes/Validator.html @@ -0,0 +1,174 @@ +Validator | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Class ValidatorAbstract

+
+

Generic interface for classes that validate Representations in some way.

+
+
+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
canHandle +handle +handleSafe +
+
+

Constructors

+
+

constructor

+
+
+

Methods

+
+

canHandle

+
    + +
  • +

    Checks if 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..db9799341 --- /dev/null +++ b/7.x/docs/classes/VariableHandler.html @@ -0,0 +1,193 @@ +VariableHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..2341853ea --- /dev/null +++ b/7.x/docs/classes/VariableSetter.html @@ -0,0 +1,222 @@ +VariableSetter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..71f11228c --- /dev/null +++ b/7.x/docs/classes/VersionHandler.html @@ -0,0 +1,191 @@ +VersionHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..697ed5251 --- /dev/null +++ b/7.x/docs/classes/ViewInteractionHandler.html @@ -0,0 +1,194 @@ +ViewInteractionHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..c20a012da --- /dev/null +++ b/7.x/docs/classes/VoidLocker.html @@ -0,0 +1,217 @@ +VoidLocker | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..866491a57 --- /dev/null +++ b/7.x/docs/classes/VoidLogger.html @@ -0,0 +1,263 @@ +VoidLogger | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

+
    + +
  • +

    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: any
      +

      Optional metadata to include in the log message.

      +
      +
    +

    Returns VoidLogger

    +
+
+

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..f04bf5f02 --- /dev/null +++ b/7.x/docs/classes/VoidLoggerFactory.html @@ -0,0 +1,133 @@ +VoidLoggerFactory | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..f3fa98d65 --- /dev/null +++ b/7.x/docs/classes/WacAllowHttpHandler.html @@ -0,0 +1,243 @@ +WacAllowHttpHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..9893e27e0 --- /dev/null +++ b/7.x/docs/classes/WacAllowMetadataWriter.html @@ -0,0 +1,211 @@ +WacAllowMetadataWriter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..caabdc019 --- /dev/null +++ b/7.x/docs/classes/WaterfallHandler.html @@ -0,0 +1,220 @@ +WaterfallHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..8d1a7ac47 --- /dev/null +++ b/7.x/docs/classes/WebAclReader.html @@ -0,0 +1,392 @@ +WebAclReader | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..ae1ad63e9 --- /dev/null +++ b/7.x/docs/classes/WebSocket2023Emitter.html @@ -0,0 +1,199 @@ +WebSocket2023Emitter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..9fe4e423f --- /dev/null +++ b/7.x/docs/classes/WebSocket2023Handler.html @@ -0,0 +1,173 @@ +WebSocket2023Handler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..39cfd8108 --- /dev/null +++ b/7.x/docs/classes/WebSocket2023Listener.html @@ -0,0 +1,216 @@ +WebSocket2023Listener | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..eb7775a43 --- /dev/null +++ b/7.x/docs/classes/WebSocket2023Storer.html @@ -0,0 +1,226 @@ +WebSocket2023Storer | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..db59210fb --- /dev/null +++ b/7.x/docs/classes/WebSocketAdvertiser.html @@ -0,0 +1,193 @@ +WebSocketAdvertiser | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..867f339bd --- /dev/null +++ b/7.x/docs/classes/WebSocketChannel2023Type.html @@ -0,0 +1,336 @@ +WebSocketChannel2023Type | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..11c0e431b --- /dev/null +++ b/7.x/docs/classes/WebSocketHandler.html @@ -0,0 +1,174 @@ +WebSocketHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..93c9a9926 --- /dev/null +++ b/7.x/docs/classes/WebSocketMap.html @@ -0,0 +1,456 @@ +WebSocketMap | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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<any, any>) = Map
      +

      Will be used to instantiate the internal Map.

      +
      +
      +
        +
      • +
          +
        • new (): Map<any, any>
          • +
        • +

          Returns Map<any, any>

      • +
    • +
      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: any
    +

    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..cfe00ffb0 --- /dev/null +++ b/7.x/docs/classes/WebSocketServerConfigurator.html @@ -0,0 +1,198 @@ +WebSocketServerConfigurator | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..4c86459ed --- /dev/null +++ b/7.x/docs/classes/WebhookChannel2023Type.html @@ -0,0 +1,366 @@ +WebhookChannel2023Type | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..e8698ca2f --- /dev/null +++ b/7.x/docs/classes/WebhookEmitter.html @@ -0,0 +1,229 @@ +WebhookEmitter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..f244469e7 --- /dev/null +++ b/7.x/docs/classes/WebhookWebId.html @@ -0,0 +1,192 @@ +WebhookWebId | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..ac06e61de --- /dev/null +++ b/7.x/docs/classes/WinstonLogger.html @@ -0,0 +1,282 @@ +WinstonLogger | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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: any
      +

      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..0da2b914e --- /dev/null +++ b/7.x/docs/classes/WinstonLoggerFactory.html @@ -0,0 +1,167 @@ +WinstonLoggerFactory | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..f33f93519 --- /dev/null +++ b/7.x/docs/classes/WorkerManager.html @@ -0,0 +1,182 @@ +WorkerManager | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..fa684e504 --- /dev/null +++ b/7.x/docs/classes/WrappedExpiringReadWriteLocker.html @@ -0,0 +1,289 @@ +WrappedExpiringReadWriteLocker | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..41f4ad6e4 --- /dev/null +++ b/7.x/docs/classes/WrappedExpiringStorage.html @@ -0,0 +1,390 @@ +WrappedExpiringStorage | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..75d6d1756 --- /dev/null +++ b/7.x/docs/classes/WrappedIndexedStorage.html @@ -0,0 +1,1018 @@ +WrappedIndexedStorage | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..6421d62fd --- /dev/null +++ b/7.x/docs/classes/WrappedSetMultiMap.html @@ -0,0 +1,485 @@ +WrappedSetMultiMap | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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<any, any>) = Map
      +

      Will be used to instantiate the internal Map.

      +
      +
      +
        +
      • +
          +
        • new (): Map<any, any>
          • +
        • +

          Returns Map<any, any>

      • +
    • +
      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: any
    +

    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..64ffcf39a --- /dev/null +++ b/7.x/docs/classes/WrappingLogger.html @@ -0,0 +1,283 @@ +WrappingLogger | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..3408b9d41 --- /dev/null +++ b/7.x/docs/classes/WwwAuthMetadataWriter.html @@ -0,0 +1,195 @@ +WwwAuthMetadataWriter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..a797f1e64 --- /dev/null +++ b/7.x/docs/classes/YargsCliExtractor.html @@ -0,0 +1,227 @@ +YargsCliExtractor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..dd67ec1c1 --- /dev/null +++ b/7.x/docs/classes/YargsParameter.html @@ -0,0 +1,128 @@ +YargsParameter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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, any>
      +

      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..4c617fc07 --- /dev/null +++ b/7.x/docs/enums/AccessMode.html @@ -0,0 +1,113 @@ +AccessMode | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..51a5c07f9 --- /dev/null +++ b/7.x/docs/enums/AclMode.html @@ -0,0 +1,81 @@ +AclMode | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..36d12c0e0 --- /dev/null +++ b/7.x/docs/functions/absoluteFilePath.html @@ -0,0 +1,79 @@ +absoluteFilePath | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..c53d9e3ec --- /dev/null +++ b/7.x/docs/functions/addGeneratedResources.html @@ -0,0 +1,87 @@ +addGeneratedResources | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..1485ec5bd --- /dev/null +++ b/7.x/docs/functions/addHeader.html @@ -0,0 +1,77 @@ +addHeader | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..95d42412a --- /dev/null +++ b/7.x/docs/functions/addResourceMetadata.html @@ -0,0 +1,82 @@ +addResourceMetadata | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

    The generated quads.

    + +
+
+
+
+
+

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..f6ac2647e --- /dev/null +++ b/7.x/docs/functions/addTemplateMetadata.html @@ -0,0 +1,86 @@ +addTemplateMetadata | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..d4449bd22 --- /dev/null +++ b/7.x/docs/functions/allFulfilled.html @@ -0,0 +1,81 @@ +allFulfilled | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..98ee0ceca --- /dev/null +++ b/7.x/docs/functions/assertAccountId.html @@ -0,0 +1,73 @@ +assertAccountId | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..7b1aa1451 --- /dev/null +++ b/7.x/docs/functions/assertOidcInteraction.html @@ -0,0 +1,78 @@ +assertOidcInteraction | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..3cf0015d8 --- /dev/null +++ b/7.x/docs/functions/assertReadConditions.html @@ -0,0 +1,94 @@ +assertReadConditions | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..ec80b3958 --- /dev/null +++ b/7.x/docs/functions/asyncToArray.html @@ -0,0 +1,78 @@ +asyncToArray | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..bb8fc84ee --- /dev/null +++ b/7.x/docs/functions/cleanPreferences.html @@ -0,0 +1,79 @@ +cleanPreferences | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..f956d1ba7 --- /dev/null +++ b/7.x/docs/functions/cloneRepresentation.html @@ -0,0 +1,78 @@ +cloneRepresentation | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..3e4c3ab49 --- /dev/null +++ b/7.x/docs/functions/concat.html @@ -0,0 +1,81 @@ +concat | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..e6957acdf --- /dev/null +++ b/7.x/docs/functions/createAggregateError.html @@ -0,0 +1,78 @@ +createAggregateError | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..13a620380 --- /dev/null +++ b/7.x/docs/functions/createErrorMessage.html @@ -0,0 +1,73 @@ +createErrorMessage | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..d80564a78 --- /dev/null +++ b/7.x/docs/functions/createGenericEventEmitterClass.html @@ -0,0 +1,81 @@ +createGenericEventEmitterClass | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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<T>

    +

    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..544c34f91 --- /dev/null +++ b/7.x/docs/functions/createSubdomainRegexp.html @@ -0,0 +1,85 @@ +createSubdomainRegexp | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..623f5f29d --- /dev/null +++ b/7.x/docs/functions/createVocabulary.html @@ -0,0 +1,84 @@ +createVocabulary | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..b19b28f3f --- /dev/null +++ b/7.x/docs/functions/decodeUriPathComponents.html @@ -0,0 +1,80 @@ +decodeUriPathComponents | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..e6ac59f70 --- /dev/null +++ b/7.x/docs/functions/encodeUriPathComponents.html @@ -0,0 +1,79 @@ +encodeUriPathComponents | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..d9de36324 --- /dev/null +++ b/7.x/docs/functions/endOfStream.html @@ -0,0 +1,70 @@ +endOfStream | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..2e5b76439 --- /dev/null +++ b/7.x/docs/functions/ensureLeadingSlash.html @@ -0,0 +1,79 @@ +ensureLeadingSlash | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..5646a4612 --- /dev/null +++ b/7.x/docs/functions/ensureTrailingSlash.html @@ -0,0 +1,79 @@ +ensureTrailingSlash | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..0b3fde42c --- /dev/null +++ b/7.x/docs/functions/errorTermsToMetadata.html @@ -0,0 +1,83 @@ +errorTermsToMetadata | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..1cab69e21 --- /dev/null +++ b/7.x/docs/functions/extendVocabulary.html @@ -0,0 +1,90 @@ +extendVocabulary | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..093b22162 --- /dev/null +++ b/7.x/docs/functions/extractErrorTerms.html @@ -0,0 +1,79 @@ +extractErrorTerms | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..59b1b7a4a --- /dev/null +++ b/7.x/docs/functions/extractScheme.html @@ -0,0 +1,82 @@ +extractScheme | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..ac1a20343 --- /dev/null +++ b/7.x/docs/functions/fetchDataset.html @@ -0,0 +1,74 @@ +fetchDataset | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..2fc8d85de --- /dev/null +++ b/7.x/docs/functions/filter.html @@ -0,0 +1,106 @@ +filter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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: any
      +

      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..6608da911 --- /dev/null +++ b/7.x/docs/functions/filterHandlers.html @@ -0,0 +1,89 @@ +filterHandlers | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..dd801c602 --- /dev/null +++ b/7.x/docs/functions/find.html @@ -0,0 +1,107 @@ +find | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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: any
      +

      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..4a2758626 --- /dev/null +++ b/7.x/docs/functions/findHandler.html @@ -0,0 +1,90 @@ +findHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..09dcda6d6 --- /dev/null +++ b/7.x/docs/functions/finishInteraction.html @@ -0,0 +1,86 @@ +finishInteraction | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..1dcfdeeff --- /dev/null +++ b/7.x/docs/functions/forgetWebId.html @@ -0,0 +1,83 @@ +forgetWebId | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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/generateHttpErrorClass.html b/7.x/docs/functions/generateHttpErrorClass.html new file mode 100644 index 000000000..9729ae3d8 --- /dev/null +++ b/7.x/docs/functions/generateHttpErrorClass.html @@ -0,0 +1,86 @@ +generateHttpErrorClass | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..68bb2a222 --- /dev/null +++ b/7.x/docs/functions/generateHttpErrorUri.html @@ -0,0 +1,73 @@ +generateHttpErrorUri | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..a17d670dc --- /dev/null +++ b/7.x/docs/functions/generateRedirectHttpErrorClass.html @@ -0,0 +1,82 @@ +generateRedirectHttpErrorClass | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..0bf888fa5 --- /dev/null +++ b/7.x/docs/functions/generateWebSocketUrl.html @@ -0,0 +1,76 @@ +generateWebSocketUrl | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..b68e2e5e1 --- /dev/null +++ b/7.x/docs/functions/getAccessControl.html @@ -0,0 +1,81 @@ +getAccessControl | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..1c246ca71 --- /dev/null +++ b/7.x/docs/functions/getAccessControlResource.html @@ -0,0 +1,81 @@ +getAccessControlResource | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..aa1d50eac --- /dev/null +++ b/7.x/docs/functions/getAccessControlledResources.html @@ -0,0 +1,76 @@ +getAccessControlledResources | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..5e5ae5523 --- /dev/null +++ b/7.x/docs/functions/getBestPreference.html @@ -0,0 +1,84 @@ +getBestPreference | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..5ad67e0dd --- /dev/null +++ b/7.x/docs/functions/getConversionTarget.html @@ -0,0 +1,88 @@ +getConversionTarget | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..af3b1e8b1 --- /dev/null +++ b/7.x/docs/functions/getDefault.html @@ -0,0 +1,142 @@ +getDefault | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..34e1d1df5 --- /dev/null +++ b/7.x/docs/functions/getExtension.html @@ -0,0 +1,77 @@ +getExtension | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..b88535bed --- /dev/null +++ b/7.x/docs/functions/getLoggerFor.html @@ -0,0 +1,82 @@ +getLoggerFor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..4301754d3 --- /dev/null +++ b/7.x/docs/functions/getMatcher.html @@ -0,0 +1,81 @@ +getMatcher | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..f971df139 --- /dev/null +++ b/7.x/docs/functions/getModuleRoot.html @@ -0,0 +1,68 @@ +getModuleRoot | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..1d44900f5 --- /dev/null +++ b/7.x/docs/functions/getPolicy.html @@ -0,0 +1,81 @@ +getPolicy | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..a1ae3edaa --- /dev/null +++ b/7.x/docs/functions/getRelativeUrl.html @@ -0,0 +1,87 @@ +getRelativeUrl | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..361cbaa27 --- /dev/null +++ b/7.x/docs/functions/getSingleItem.html @@ -0,0 +1,78 @@ +getSingleItem | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..56da2c78a --- /dev/null +++ b/7.x/docs/functions/getTemplateFilePath.html @@ -0,0 +1,74 @@ +getTemplateFilePath | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..d59ad9912 --- /dev/null +++ b/7.x/docs/functions/getTypeWeight.html @@ -0,0 +1,83 @@ +getTypeWeight | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..4126cc32d --- /dev/null +++ b/7.x/docs/functions/getWeightedPreferences.html @@ -0,0 +1,84 @@ +getWeightedPreferences | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..6774ab8b1 --- /dev/null +++ b/7.x/docs/functions/guardStream.html @@ -0,0 +1,87 @@ +guardStream | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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<T>

    +
    +

    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..3811f32ff --- /dev/null +++ b/7.x/docs/functions/guardedStreamFrom.html @@ -0,0 +1,81 @@ +guardedStreamFrom | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Function guardedStreamFrom

+
+
    + +
  • +

    Converts a string or array to a stream and applies an error guard so that it is Guarded.

    +
    +
    +

    Parameters

    +
      +
    • +
      contents: string | Iterable<any>
      +

      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..2d2b61c54 --- /dev/null +++ b/7.x/docs/functions/hasScheme.html @@ -0,0 +1,82 @@ +hasScheme | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..030440083 --- /dev/null +++ b/7.x/docs/functions/identifierHashFn.html @@ -0,0 +1,73 @@ +identifierHashFn | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..91231e78d --- /dev/null +++ b/7.x/docs/functions/importOidcProvider.html @@ -0,0 +1,74 @@ +importOidcProvider | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..92e159f67 --- /dev/null +++ b/7.x/docs/functions/isContainerIdentifier.html @@ -0,0 +1,76 @@ +isContainerIdentifier | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Function isContainerIdentifier

+
+
    + +
  • +

    Checks if 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..4ba49078f --- /dev/null +++ b/7.x/docs/functions/isContainerPath.html @@ -0,0 +1,76 @@ +isContainerPath | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Function isContainerPath

+
+
    + +
  • +

    Checks if 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..3d1db0bac --- /dev/null +++ b/7.x/docs/functions/isError.html @@ -0,0 +1,73 @@ +isError | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Function isError

+
+
    + +
  • +

    Checks if the input is an Error.

    +
    +
    +

    Parameters

    +
      +
    • +
      error: any
    +

    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..02f8b83e0 --- /dev/null +++ b/7.x/docs/functions/isGuarded.html @@ -0,0 +1,78 @@ +isGuarded | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Function isGuarded

+
+
    + +
  • +

    Determines whether the stream is guarded against emitting errors.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends EventEmitter<T>

    +
    +

    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..478808fe7 --- /dev/null +++ b/7.x/docs/functions/isHttpRequest.html @@ -0,0 +1,73 @@ +isHttpRequest | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..de3f23705 --- /dev/null +++ b/7.x/docs/functions/isHttpsServer.html @@ -0,0 +1,73 @@ +isHttpsServer | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..1c64b1cfd --- /dev/null +++ b/7.x/docs/functions/isInternalContentType.html @@ -0,0 +1,78 @@ +isInternalContentType | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..9314576ed --- /dev/null +++ b/7.x/docs/functions/isPromise.html @@ -0,0 +1,81 @@ +isPromise | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..f41dd108b --- /dev/null +++ b/7.x/docs/functions/isRepresentationMetadata.html @@ -0,0 +1,73 @@ +isRepresentationMetadata | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..5977ac8b4 --- /dev/null +++ b/7.x/docs/functions/isResourceIdentifier.html @@ -0,0 +1,73 @@ +isResourceIdentifier | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..a2d01feb1 --- /dev/null +++ b/7.x/docs/functions/isSystemError.html @@ -0,0 +1,70 @@ +isSystemError | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..3dd48b314 --- /dev/null +++ b/7.x/docs/functions/isTerm.html @@ -0,0 +1,74 @@ +isTerm | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Function isTerm

+
+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      Optional input: any
      +

      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..809a3c09e --- /dev/null +++ b/7.x/docs/functions/isUrl.html @@ -0,0 +1,77 @@ +isUrl | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Function isUrl

+
+
    + +
  • +

    Checks if 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..8d8eade4b --- /dev/null +++ b/7.x/docs/functions/isValidFileName.html @@ -0,0 +1,77 @@ +isValidFileName | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..d24e6c788 --- /dev/null +++ b/7.x/docs/functions/isValidVariable.html @@ -0,0 +1,74 @@ +isValidVariable | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..ab85eb2df --- /dev/null +++ b/7.x/docs/functions/isWebSocket2023Channel.html @@ -0,0 +1,70 @@ +isWebSocket2023Channel | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..745339f10 --- /dev/null +++ b/7.x/docs/functions/isWebhook2023Channel.html @@ -0,0 +1,70 @@ +isWebhook2023Channel | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..690e34053 --- /dev/null +++ b/7.x/docs/functions/joinFilePath.html @@ -0,0 +1,82 @@ +joinFilePath | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..2df117c91 --- /dev/null +++ b/7.x/docs/functions/joinUrl.html @@ -0,0 +1,88 @@ +joinUrl | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..eb2c02db1 --- /dev/null +++ b/7.x/docs/functions/listSingleThreadedComponents.html @@ -0,0 +1,82 @@ +listSingleThreadedComponents | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..1bdd05e40 --- /dev/null +++ b/7.x/docs/functions/map.html @@ -0,0 +1,108 @@ +map | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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: any
      +

      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..9697a63d1 --- /dev/null +++ b/7.x/docs/functions/matchesAuthorizationScheme.html @@ -0,0 +1,82 @@ +matchesAuthorizationScheme | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..ca760c8f1 --- /dev/null +++ b/7.x/docs/functions/matchesMediaPreferences.html @@ -0,0 +1,81 @@ +matchesMediaPreferences | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..0339c0a45 --- /dev/null +++ b/7.x/docs/functions/matchesMediaType.html @@ -0,0 +1,83 @@ +matchesMediaType | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Function matchesMediaType

+
+
    + +
  • +

    Checks if 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..d159fe39f --- /dev/null +++ b/7.x/docs/functions/modify.html @@ -0,0 +1,87 @@ +modify | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..d04f020cd --- /dev/null +++ b/7.x/docs/functions/modulePath.html @@ -0,0 +1,74 @@ +modulePath | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..60747ed00 --- /dev/null +++ b/7.x/docs/functions/msToDuration.html @@ -0,0 +1,78 @@ +msToDuration | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..5e4fec81d --- /dev/null +++ b/7.x/docs/functions/normalizeFilePath.html @@ -0,0 +1,77 @@ +normalizeFilePath | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..a8498d6ab --- /dev/null +++ b/7.x/docs/functions/parseAccept.html @@ -0,0 +1,83 @@ +parseAccept | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..71c9548e1 --- /dev/null +++ b/7.x/docs/functions/parseAcceptCharset.html @@ -0,0 +1,83 @@ +parseAcceptCharset | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..9dd716ddb --- /dev/null +++ b/7.x/docs/functions/parseAcceptDateTime.html @@ -0,0 +1,83 @@ +parseAcceptDateTime | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..e68039126 --- /dev/null +++ b/7.x/docs/functions/parseAcceptEncoding.html @@ -0,0 +1,83 @@ +parseAcceptEncoding | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..5df5c4ac7 --- /dev/null +++ b/7.x/docs/functions/parseAcceptLanguage.html @@ -0,0 +1,83 @@ +parseAcceptLanguage | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..555d563f1 --- /dev/null +++ b/7.x/docs/functions/parseContentType.html @@ -0,0 +1,80 @@ +parseContentType | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..cd020cfe1 --- /dev/null +++ b/7.x/docs/functions/parseForwarded.html @@ -0,0 +1,77 @@ +parseForwarded | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..819407a78 --- /dev/null +++ b/7.x/docs/functions/parseLinkHeader.html @@ -0,0 +1,77 @@ +parseLinkHeader | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..0664aa259 --- /dev/null +++ b/7.x/docs/functions/parseParameters.html @@ -0,0 +1,88 @@ +parseParameters | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..39878b584 --- /dev/null +++ b/7.x/docs/functions/parsePath.html @@ -0,0 +1,88 @@ +parsePath | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..597bcd180 --- /dev/null +++ b/7.x/docs/functions/parseQuads.html @@ -0,0 +1,82 @@ +parseQuads | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..31cd7d695 --- /dev/null +++ b/7.x/docs/functions/parseSchema.html @@ -0,0 +1,78 @@ +parseSchema | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Function parseSchema

+
+
    + +
  • +

    Generates a simplified representation of a yup schema.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends ObjectSchema<any, AnyObject, any, "", T>

    +
    +

    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..33e9b48bc --- /dev/null +++ b/7.x/docs/functions/parseWebSocketRequest.html @@ -0,0 +1,81 @@ +parseWebSocketRequest | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..825b15249 --- /dev/null +++ b/7.x/docs/functions/pipeSafely.html @@ -0,0 +1,105 @@ +pipeSafely | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Function pipeSafely

+
+
    + +
  • +

    Pipes one stream into another and emits errors of the first stream with the second. +In case of an error in the first stream the second one will be destroyed with the given error. +This will also make the stream Guarded.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends Writable<T>

    +
    +

    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..0e62b9a12 --- /dev/null +++ b/7.x/docs/functions/preferencesToString.html @@ -0,0 +1,76 @@ +preferencesToString | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..477b5548c --- /dev/null +++ b/7.x/docs/functions/promiseSome.html @@ -0,0 +1,82 @@ +promiseSome | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..3ac9171fa --- /dev/null +++ b/7.x/docs/functions/readJsonStream.html @@ -0,0 +1,77 @@ +readJsonStream | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Function readJsonStream

+
+
    + +
  • +

    Interprets the stream as JSON and converts it to a Dict.

    +
    +
    +

    Parameters

    +
      +
    • +
      stream: Readable
      +

      Stream of JSON data.

      +
      +
    +

    Returns Promise<NodeJS.Dict<any>>

    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..eed8b8018 --- /dev/null +++ b/7.x/docs/functions/readPackageJson.html @@ -0,0 +1,68 @@ +readPackageJson | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Function readPackageJson

+
+
    + +
  • +

    Reads the project package.json and returns it.

    +
    +

    Returns Promise<Record<string, any>>

    +
+
+
+
+
+

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..f16e6aab6 --- /dev/null +++ b/7.x/docs/functions/readTemplate.html @@ -0,0 +1,73 @@ +readTemplate | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..7a2611beb --- /dev/null +++ b/7.x/docs/functions/readableToQuads.html @@ -0,0 +1,77 @@ +readableToQuads | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..0127cc630 --- /dev/null +++ b/7.x/docs/functions/readableToString.html @@ -0,0 +1,77 @@ +readableToString | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..a30ab6076 --- /dev/null +++ b/7.x/docs/functions/reduce.html @@ -0,0 +1,152 @@ +reduce | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..db6f54953 --- /dev/null +++ b/7.x/docs/functions/resetInternalLoggerFactory.html @@ -0,0 +1,74 @@ +resetInternalLoggerFactory | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..f04df5ff9 --- /dev/null +++ b/7.x/docs/functions/resolveAssetPath.html @@ -0,0 +1,75 @@ +resolveAssetPath | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..f69d3f68c --- /dev/null +++ b/7.x/docs/functions/resolveModulePath.html @@ -0,0 +1,73 @@ +resolveModulePath | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..2e8b9522a --- /dev/null +++ b/7.x/docs/functions/resolvePromiseOrValue.html @@ -0,0 +1,95 @@ +resolvePromiseOrValue | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..a212a2131 --- /dev/null +++ b/7.x/docs/functions/responseToDataset.html @@ -0,0 +1,80 @@ +responseToDataset | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..aa930aaf3 --- /dev/null +++ b/7.x/docs/functions/sanitizeUrlPart.html @@ -0,0 +1,77 @@ +sanitizeUrlPart | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..716db7982 --- /dev/null +++ b/7.x/docs/functions/serializeQuads.html @@ -0,0 +1,82 @@ +serializeQuads | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..97a6eef92 --- /dev/null +++ b/7.x/docs/functions/setGlobalLoggerFactory.html @@ -0,0 +1,77 @@ +setGlobalLoggerFactory | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..f6c18932d --- /dev/null +++ b/7.x/docs/functions/setSafeInterval.html @@ -0,0 +1,95 @@ +setSafeInterval | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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.

    +
    +
    +

    Parameters

    +
      +
    • +
      logger: Logger
      • +
    • +
      message: string
      • +
    • +
      callback: ((...cbArgs) => void)
      +
        +
      • +
          +
        • (...cbArgs): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Rest ...cbArgs: any[]
          +

          Returns void

      • +
    • +
      Optional ms: number
      • +
    • +
      Rest ...args: any[]
    +

    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..f782f20b7 --- /dev/null +++ b/7.x/docs/functions/sortedAsyncMerge.html @@ -0,0 +1,100 @@ +sortedAsyncMerge | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..a0fc51416 --- /dev/null +++ b/7.x/docs/functions/splitAndClean.html @@ -0,0 +1,77 @@ +splitAndClean | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..764375d0e --- /dev/null +++ b/7.x/docs/functions/splitCommaSeparated.html @@ -0,0 +1,77 @@ +splitCommaSeparated | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..a9e1f50df --- /dev/null +++ b/7.x/docs/functions/termToInt.html @@ -0,0 +1,81 @@ +termToInt | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..11804da6d --- /dev/null +++ b/7.x/docs/functions/toCanonicalUriPath.html @@ -0,0 +1,80 @@ +toCanonicalUriPath | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..3e2134d18 --- /dev/null +++ b/7.x/docs/functions/toComponentsJsType.html @@ -0,0 +1,87 @@ +toComponentsJsType | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..9d0d873aa --- /dev/null +++ b/7.x/docs/functions/toLiteral.html @@ -0,0 +1,81 @@ +toLiteral | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..6bfa46503 --- /dev/null +++ b/7.x/docs/functions/toNamedTerm.html @@ -0,0 +1,106 @@ +toNamedTerm | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..311ec4cb3 --- /dev/null +++ b/7.x/docs/functions/toObjectTerm.html @@ -0,0 +1,115 @@ +toObjectTerm | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..c625e76ba --- /dev/null +++ b/7.x/docs/functions/toPredicateTerm.html @@ -0,0 +1,106 @@ +toPredicateTerm | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..a0080dda3 --- /dev/null +++ b/7.x/docs/functions/transformQuotedStrings.html @@ -0,0 +1,85 @@ +transformQuotedStrings | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..c12dd0a2a --- /dev/null +++ b/7.x/docs/functions/transformSafely.html @@ -0,0 +1,87 @@ +transformSafely | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Function transformSafely

+
+
    + +
  • +

    Transforms a stream, ensuring that all errors are forwarded.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T = any

    +
    +

    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..da9f8a11a --- /dev/null +++ b/7.x/docs/functions/trimLeadingSlashes.html @@ -0,0 +1,77 @@ +trimLeadingSlashes | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..242b4a96a --- /dev/null +++ b/7.x/docs/functions/trimTrailingSlashes.html @@ -0,0 +1,77 @@ +trimTrailingSlashes | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..be706d40c --- /dev/null +++ b/7.x/docs/functions/uniqueQuads.html @@ -0,0 +1,77 @@ +uniqueQuads | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..1e69d6fb5 --- /dev/null +++ b/7.x/docs/functions/updateModifiedDate.html @@ -0,0 +1,81 @@ +updateModifiedDate | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..e2ddc4e47 --- /dev/null +++ b/7.x/docs/functions/validateWithError.html @@ -0,0 +1,82 @@ +validateWithError | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Function validateWithError

+
+
    + +
  • +

    Same functionality as the yup validate function, but throws a BadRequestHttpError if there is an error.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends ObjectSchema<any, AnyObject, any, "", T>

    +
    +

    Parameters

    +
      +
    • +
      schema: T
      • +
    • +
      data: unknown
      • +
    • +
      Optional options: ValidateOptions<any>
    +

    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..01c556249 --- /dev/null +++ b/7.x/docs/functions/verifyAccountId.html @@ -0,0 +1,82 @@ +verifyAccountId | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..b75e0d62a --- /dev/null +++ b/7.x/docs/index.html @@ -0,0 +1,125 @@ +Community Solid Server - v7.0.0
+
+ +
+
+
+
+

Community Solid Server - v7.0.0

+

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.

+

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..0daf3375a --- /dev/null +++ b/7.x/docs/interfaces/AccessCheckerArgs.html @@ -0,0 +1,108 @@ +AccessCheckerArgs | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..cf232b062 --- /dev/null +++ b/7.x/docs/interfaces/AccountInitializerArgs.html @@ -0,0 +1,138 @@ +AccountInitializerArgs | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..3eef21b6b --- /dev/null +++ b/7.x/docs/interfaces/AccountStore.html @@ -0,0 +1,179 @@ +AccountStore | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Interface AccountStore

+
+

Used to store account data.

+
+
+
+

Hierarchy

+
    +
  • AccountStore
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
create +
+
+

Methods

+
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>

      +
+
+

Methods

+
+

getSetting

+
+
+

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/interfaces/AdapterFactory.html b/7.x/docs/interfaces/AdapterFactory.html new file mode 100644 index 000000000..3f598bcf0 --- /dev/null +++ b/7.x/docs/interfaces/AdapterFactory.html @@ -0,0 +1,110 @@ +AdapterFactory | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..0f0d686ba --- /dev/null +++ b/7.x/docs/interfaces/AlgJwk.html @@ -0,0 +1,304 @@ +AlgJwk | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..078e12d93 --- /dev/null +++ b/7.x/docs/interfaces/AppRunnerInput.html @@ -0,0 +1,141 @@ +AppRunnerInput | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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.

+
+
+
+

config

+
config: string | string[]
+

Path to the server config file(s).

+
+
+
+

loaderProperties

+
loaderProperties: IComponentsManagerBuilderOptions<App>
+

Properties that will be used when building the Components.js manager. +Sets typeChecking to false by default as the server components will result in errors otherwise.

+
+
+
+

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..7142e4f83 --- /dev/null +++ b/7.x/docs/interfaces/AsyncTransformOptions.html @@ -0,0 +1,426 @@ +AsyncTransformOptions | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Interface AsyncTransformOptions<T>

+
+

Type Parameters

+
    +
  • +

    T = any

+
+

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) => any)
+
+

Type declaration

+
    +
  • +
      +
    • (this): any
      • +
    • +

      Performs any final actions after the source has ended

      +
      +
      +

      Parameters

      +
        +
      • +
        this: Transform
      +

      Returns any

      +
+
+

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) => any)
+
+

Type declaration

+
    +
  • +
      +
    • (this, data, encoding): any
      • +
    • +

      Transforms data from the source by calling the push method

      +
      +
      +

      Parameters

      +
        +
      • +
        this: Transform
        • +
      • +
        data: T
        • +
      • +
        encoding: string
      +

      Returns any

      +
+
+

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..2ad3b5c5a --- /dev/null +++ b/7.x/docs/interfaces/AtomicDataAccessor.html @@ -0,0 +1,347 @@ +AtomicDataAccessor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..7b24800be --- /dev/null +++ b/7.x/docs/interfaces/AtomicResourceStore.html @@ -0,0 +1,303 @@ +AtomicResourceStore | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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>
      • +
    • +

      Check if 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..468eb916e --- /dev/null +++ b/7.x/docs/interfaces/AuthorizerInput.html @@ -0,0 +1,108 @@ +AuthorizerInput | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..17c5f52c6 --- /dev/null +++ b/7.x/docs/interfaces/AuthorizingHttpHandlerArgs.html @@ -0,0 +1,128 @@ +AuthorizingHttpHandlerArgs | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..b0cdd44e5 --- /dev/null +++ b/7.x/docs/interfaces/AuxiliaryIdentifierStrategy.html @@ -0,0 +1,204 @@ +AuxiliaryIdentifierStrategy | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..67c23e153 --- /dev/null +++ b/7.x/docs/interfaces/AuxiliaryStrategy.html @@ -0,0 +1,324 @@ +AuxiliaryStrategy | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..e01779d57 --- /dev/null +++ b/7.x/docs/interfaces/BasePodCreatorArgs.html @@ -0,0 +1,130 @@ +BasePodCreatorArgs | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..cef5fb77b --- /dev/null +++ b/7.x/docs/interfaces/BaseRouterHandlerArgs.html @@ -0,0 +1,130 @@ +BaseRouterHandlerArgs | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..c01c5e0a1 --- /dev/null +++ b/7.x/docs/interfaces/BaseServerFactoryOptions.html @@ -0,0 +1,123 @@ +BaseServerFactoryOptions | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..0dda30d88 --- /dev/null +++ b/7.x/docs/interfaces/BasicConditionsOptions.html @@ -0,0 +1,106 @@ +BasicConditionsOptions | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..86c8f3066 --- /dev/null +++ b/7.x/docs/interfaces/BasicRequestParserArgs.html @@ -0,0 +1,117 @@ +BasicRequestParserArgs | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..32fa92803 --- /dev/null +++ b/7.x/docs/interfaces/BodyParserArgs.html @@ -0,0 +1,99 @@ +BodyParserArgs | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..6d6913db7 --- /dev/null +++ b/7.x/docs/interfaces/CliOptions.html @@ -0,0 +1,106 @@ +CliOptions | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..1bcef93a9 --- /dev/null +++ b/7.x/docs/interfaces/ClientCredentials.html @@ -0,0 +1,113 @@ +ClientCredentials | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..28e5c2537 --- /dev/null +++ b/7.x/docs/interfaces/ClientCredentialsStore.html @@ -0,0 +1,223 @@ +ClientCredentialsStore | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..9e2d7ca9a --- /dev/null +++ b/7.x/docs/interfaces/ComponentsJsFactory.html @@ -0,0 +1,128 @@ +ComponentsJsFactory | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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, any>
        +

        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..f2ababbe9 --- /dev/null +++ b/7.x/docs/interfaces/ComposedNotificationHandlerArgs.html @@ -0,0 +1,106 @@ +ComposedNotificationHandlerArgs | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..43557a3a7 --- /dev/null +++ b/7.x/docs/interfaces/Conditions.html @@ -0,0 +1,159 @@ +Conditions | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..c07e5e548 --- /dev/null +++ b/7.x/docs/interfaces/ConstantConverterOptions.html @@ -0,0 +1,132 @@ +ConstantConverterOptions | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..3d03f7e5c --- /dev/null +++ b/7.x/docs/interfaces/ContainerInitializerArgs.html @@ -0,0 +1,138 @@ +ContainerInitializerArgs | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..bab493718 --- /dev/null +++ b/7.x/docs/interfaces/ConvertingStoreEntry.html @@ -0,0 +1,92 @@ +ConvertingStoreEntry | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..485baa17f --- /dev/null +++ b/7.x/docs/interfaces/CookieStore.html @@ -0,0 +1,192 @@ +CookieStore | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..c5f66f17b --- /dev/null +++ b/7.x/docs/interfaces/DataAccessor.html @@ -0,0 +1,346 @@ +DataAccessor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..f8ca2f792 --- /dev/null +++ b/7.x/docs/interfaces/ETagHandler.html @@ -0,0 +1,183 @@ +ETagHandler | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..500671631 --- /dev/null +++ b/7.x/docs/interfaces/EmailArgs.html @@ -0,0 +1,106 @@ +EmailArgs | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..f798d4d70 --- /dev/null +++ b/7.x/docs/interfaces/EmailSenderArgs.html @@ -0,0 +1,106 @@ +EmailSenderArgs | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..3c79942ba --- /dev/null +++ b/7.x/docs/interfaces/ErrorHandlerArgs.html @@ -0,0 +1,92 @@ +ErrorHandlerArgs | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..e6911bafa --- /dev/null +++ b/7.x/docs/interfaces/ExpiringReadWriteLocker.html @@ -0,0 +1,203 @@ +ExpiringReadWriteLocker | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..8cafd6319 --- /dev/null +++ b/7.x/docs/interfaces/ExpiringStorage.html @@ -0,0 +1,260 @@ +ExpiringStorage | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..68401f494 --- /dev/null +++ b/7.x/docs/interfaces/FileIdentifierMapper.html @@ -0,0 +1,158 @@ +FileIdentifierMapper | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..17c60c84f --- /dev/null +++ b/7.x/docs/interfaces/FileIdentifierMapperFactory.html @@ -0,0 +1,114 @@ +FileIdentifierMapperFactory | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..84d6eaf5f --- /dev/null +++ b/7.x/docs/interfaces/Finalizable.html @@ -0,0 +1,105 @@ +Finalizable | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..0ce96574b --- /dev/null +++ b/7.x/docs/interfaces/ForgotPasswordHandlerArgs.html @@ -0,0 +1,133 @@ +ForgotPasswordHandlerArgs | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..ef30bc908 --- /dev/null +++ b/7.x/docs/interfaces/ForgotPasswordStore.html @@ -0,0 +1,169 @@ +ForgotPasswordStore | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..6d0de6012 --- /dev/null +++ b/7.x/docs/interfaces/Forwarded.html @@ -0,0 +1,122 @@ +Forwarded | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..4ea88fe59 --- /dev/null +++ b/7.x/docs/interfaces/GenericEventEmitter.html @@ -0,0 +1,446 @@ +GenericEventEmitter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..4031fcebd --- /dev/null +++ b/7.x/docs/interfaces/HttpErrorClass.html @@ -0,0 +1,153 @@ +HttpErrorClass | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: any
      +

      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..6aaaf57fe --- /dev/null +++ b/7.x/docs/interfaces/HttpErrorOptions.html @@ -0,0 +1,103 @@ +HttpErrorOptions | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..c954df10e --- /dev/null +++ b/7.x/docs/interfaces/HttpHandlerInput.html @@ -0,0 +1,94 @@ +HttpHandlerInput | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..2fc8e455f --- /dev/null +++ b/7.x/docs/interfaces/HttpServerFactory.html @@ -0,0 +1,101 @@ +HttpServerFactory | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..a2f23520c --- /dev/null +++ b/7.x/docs/interfaces/IdentifierGenerator.html @@ -0,0 +1,135 @@ +IdentifierGenerator | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..318df8e42 --- /dev/null +++ b/7.x/docs/interfaces/IdentifierStrategy.html @@ -0,0 +1,191 @@ +IdentifierStrategy | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..ad0437241 --- /dev/null +++ b/7.x/docs/interfaces/IdentityProviderFactoryArgs.html @@ -0,0 +1,188 @@ +IdentityProviderFactoryArgs | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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, unknown>
+

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..be4434778 --- /dev/null +++ b/7.x/docs/interfaces/IdentityProviderHttpHandlerArgs.html @@ -0,0 +1,108 @@ +IdentityProviderHttpHandlerArgs | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..86a461c5b --- /dev/null +++ b/7.x/docs/interfaces/IndexedStorage.html @@ -0,0 +1,452 @@ +IndexedStorage | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

+
+
+
+
+ +
+
+

Methods

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

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

+
    + +
  • +

    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

+
    + +
  • +

    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/interfaces/Initializable.html b/7.x/docs/interfaces/Initializable.html new file mode 100644 index 000000000..09959b1b1 --- /dev/null +++ b/7.x/docs/interfaces/Initializable.html @@ -0,0 +1,104 @@ +Initializable | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..0f98f19f2 --- /dev/null +++ b/7.x/docs/interfaces/InteractionHandlerInput.html @@ -0,0 +1,109 @@ +InteractionHandlerInput | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..42a0863d4 --- /dev/null +++ b/7.x/docs/interfaces/InteractionRoute.html @@ -0,0 +1,150 @@ +InteractionRoute | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..6a32156ec --- /dev/null +++ b/7.x/docs/interfaces/JsonInteractionHandlerInput.html @@ -0,0 +1,139 @@ +JsonInteractionHandlerInput | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..8abcdfdd8 --- /dev/null +++ b/7.x/docs/interfaces/JsonRepresentation.html @@ -0,0 +1,103 @@ +JsonRepresentation | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..1b769f254 --- /dev/null +++ b/7.x/docs/interfaces/JsonView.html @@ -0,0 +1,117 @@ +JsonView | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..601b3acc5 --- /dev/null +++ b/7.x/docs/interfaces/JwkGenerator.html @@ -0,0 +1,131 @@ +JwkGenerator | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..8e35ae60d --- /dev/null +++ b/7.x/docs/interfaces/KeyValueStorage.html @@ -0,0 +1,224 @@ +KeyValueStorage | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if 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..a34beb91b --- /dev/null +++ b/7.x/docs/interfaces/LinkWebIdHandlerArgs.html @@ -0,0 +1,139 @@ +LinkWebIdHandlerArgs | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..ab6ace5a4 --- /dev/null +++ b/7.x/docs/interfaces/LogMetadata.html @@ -0,0 +1,98 @@ +LogMetadata | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..0fe172853 --- /dev/null +++ b/7.x/docs/interfaces/Logger.html @@ -0,0 +1,284 @@ +Logger | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..d16593c93 --- /dev/null +++ b/7.x/docs/interfaces/LoggerFactory.html @@ -0,0 +1,114 @@ +LoggerFactory | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..d61a6e7eb --- /dev/null +++ b/7.x/docs/interfaces/LoginStorage.html @@ -0,0 +1,479 @@ +LoginStorage | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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

+
defineType +
+
+

Methods

+
create +createIndex +delete +entries +find +findIds +get +has +set +setField +
+
+

Properties

+
+

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>

      +
+
+

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>

    +
+
+

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

+
    + +
  • +

    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

+
    + +
  • +

    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/interfaces/MetadataWriterInput.html b/7.x/docs/interfaces/MetadataWriterInput.html new file mode 100644 index 000000000..a5ed03371 --- /dev/null +++ b/7.x/docs/interfaces/MetadataWriterInput.html @@ -0,0 +1,92 @@ +MetadataWriterInput | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..3f8f1806d --- /dev/null +++ b/7.x/docs/interfaces/NotificationChannel.html @@ -0,0 +1,209 @@ +NotificationChannel | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..7f1f66dbc --- /dev/null +++ b/7.x/docs/interfaces/NotificationChannelStorage.html @@ -0,0 +1,222 @@ +NotificationChannelStorage | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..e89ee969e --- /dev/null +++ b/7.x/docs/interfaces/NotificationChannelType.html @@ -0,0 +1,218 @@ +NotificationChannelType | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..9da154d10 --- /dev/null +++ b/7.x/docs/interfaces/NotificationEmitterInput.html @@ -0,0 +1,92 @@ +NotificationEmitterInput | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..19e564754 --- /dev/null +++ b/7.x/docs/interfaces/NotificationHandlerInput.html @@ -0,0 +1,106 @@ +NotificationHandlerInput | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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#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..815ed31fd --- /dev/null +++ b/7.x/docs/interfaces/NotificationSerializerInput.html @@ -0,0 +1,92 @@ +NotificationSerializerInput | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..025e7e947 --- /dev/null +++ b/7.x/docs/interfaces/NotificationSubscriberArgs.html @@ -0,0 +1,151 @@ +NotificationSubscriberArgs | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..d2baa4fd5 --- /dev/null +++ b/7.x/docs/interfaces/OAuthErrorFields.html @@ -0,0 +1,113 @@ +OAuthErrorFields | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..87102c3af --- /dev/null +++ b/7.x/docs/interfaces/Operation.html @@ -0,0 +1,132 @@ +Operation | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..60e663720 --- /dev/null +++ b/7.x/docs/interfaces/OperationHandlerInput.html @@ -0,0 +1,85 @@ +OperationHandlerInput | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..9cb7e3ce4 --- /dev/null +++ b/7.x/docs/interfaces/OperationHttpHandlerInput.html @@ -0,0 +1,103 @@ +OperationHttpHandlerInput | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..ab4054dfe --- /dev/null +++ b/7.x/docs/interfaces/OriginalUrlExtractorArgs.html @@ -0,0 +1,98 @@ +OriginalUrlExtractorArgs | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..0dc57a8dc --- /dev/null +++ b/7.x/docs/interfaces/ParsingHttpHandlerArgs.html @@ -0,0 +1,118 @@ +ParsingHttpHandlerArgs | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..a07cb35a8 --- /dev/null +++ b/7.x/docs/interfaces/PasswordLoginHandlerArgs.html @@ -0,0 +1,99 @@ +PasswordLoginHandlerArgs | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..a0414638b --- /dev/null +++ b/7.x/docs/interfaces/PasswordStore.html @@ -0,0 +1,318 @@ +PasswordStore | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..aef5bbc7e --- /dev/null +++ b/7.x/docs/interfaces/Patch.html @@ -0,0 +1,133 @@ +Patch | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..53aaeaa12 --- /dev/null +++ b/7.x/docs/interfaces/PermissionReaderInput.html @@ -0,0 +1,99 @@ +PermissionReaderInput | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..e30b7df7d --- /dev/null +++ b/7.x/docs/interfaces/PodCreatorInput.html @@ -0,0 +1,122 @@ +PodCreatorInput | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..4dc30d671 --- /dev/null +++ b/7.x/docs/interfaces/PodCreatorOutput.html @@ -0,0 +1,118 @@ +PodCreatorOutput | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..f016061cf --- /dev/null +++ b/7.x/docs/interfaces/PodGenerator.html @@ -0,0 +1,116 @@ +PodGenerator | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..8d35d14f5 --- /dev/null +++ b/7.x/docs/interfaces/PodManager.html @@ -0,0 +1,119 @@ +PodManager | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..0463a0fe7 --- /dev/null +++ b/7.x/docs/interfaces/PodSettings.html @@ -0,0 +1,145 @@ +PodSettings | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..aae1c9888 --- /dev/null +++ b/7.x/docs/interfaces/PodStore.html @@ -0,0 +1,300 @@ +PodStore | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..a10fa2469 --- /dev/null +++ b/7.x/docs/interfaces/ProviderFactory.html @@ -0,0 +1,106 @@ +ProviderFactory | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..b3ff062bb --- /dev/null +++ b/7.x/docs/interfaces/RdfStorePatcherInput.html @@ -0,0 +1,110 @@ +RdfStorePatcherInput | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..646fee4f2 --- /dev/null +++ b/7.x/docs/interfaces/ReadWriteLocker.html @@ -0,0 +1,179 @@ +ReadWriteLocker | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..ddb3824c7 --- /dev/null +++ b/7.x/docs/interfaces/RedirectHttpErrorClass.html @@ -0,0 +1,161 @@ +RedirectHttpErrorClass | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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 if the given error is an instance of this class.

      +
      +
      +

      Parameters

      +
        +
      • +
        error: any
      +

      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..1be0814ac --- /dev/null +++ b/7.x/docs/interfaces/RedisSettings.html @@ -0,0 +1,106 @@ +RedisSettings | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Interface RedisSettings

+
+

Hierarchy

+
    +
  • RedisSettings
+
+
+
+ +
+
+

Properties

+
db? +namespacePrefix +password? +username? +
+
+

Properties

+
+

Optional db

+
db?: number
+
+

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..b8f0a2690 --- /dev/null +++ b/7.x/docs/interfaces/Representation.html @@ -0,0 +1,131 @@ +Representation | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..6c14f9136 --- /dev/null +++ b/7.x/docs/interfaces/RepresentationConverterArgs.html @@ -0,0 +1,108 @@ +RepresentationConverterArgs | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..918d353d9 --- /dev/null +++ b/7.x/docs/interfaces/RepresentationPatcherInput.html @@ -0,0 +1,104 @@ +RepresentationPatcherInput | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..eb54e2477 --- /dev/null +++ b/7.x/docs/interfaces/RepresentationPreferences.html @@ -0,0 +1,133 @@ +RepresentationPreferences | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..25ac0e008 --- /dev/null +++ b/7.x/docs/interfaces/Resource.html @@ -0,0 +1,92 @@ +Resource | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..fcdc6324c --- /dev/null +++ b/7.x/docs/interfaces/ResourceIdentifier.html @@ -0,0 +1,92 @@ +ResourceIdentifier | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..9ac1075a7 --- /dev/null +++ b/7.x/docs/interfaces/ResourceLink.html @@ -0,0 +1,118 @@ +ResourceLink | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..c41e30bc4 --- /dev/null +++ b/7.x/docs/interfaces/ResourceLocker.html @@ -0,0 +1,145 @@ +ResourceLocker | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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. +In case 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..96a3f2b5d --- /dev/null +++ b/7.x/docs/interfaces/ResourceSet.html @@ -0,0 +1,115 @@ +ResourceSet | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Interface ResourceSet

+
+

A set containing resources.

+
+
+
+

Hierarchy

+
+
+

Implemented by

+
+
+
+
+ +
+
+

Properties

+
hasResource +
+
+

Properties

+
+

hasResource

+
hasResource: ((identifier) => Promise<boolean>)
+
+

Type declaration

+
    +
  • +
      +
    • (identifier): Promise<boolean>
      • +
    • +

      Check if 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..c264b8cb8 --- /dev/null +++ b/7.x/docs/interfaces/ResourceStore.html @@ -0,0 +1,311 @@ +ResourceStore | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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>
      • +
    • +

      Check if 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..a7560ce11 --- /dev/null +++ b/7.x/docs/interfaces/ResourcesGenerator.html @@ -0,0 +1,120 @@ +ResourcesGenerator | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..a47120fc9 --- /dev/null +++ b/7.x/docs/interfaces/RouterHandlerArgs.html @@ -0,0 +1,136 @@ +RouterHandlerArgs | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..d9aa5ebd8 --- /dev/null +++ b/7.x/docs/interfaces/SeededAccountInitializerArgs.html @@ -0,0 +1,118 @@ +SeededAccountInitializerArgs | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..adfbb1499 --- /dev/null +++ b/7.x/docs/interfaces/SetMultiMap.html @@ -0,0 +1,474 @@ +SetMultiMap | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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: any
      +

      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..4fd141df6 --- /dev/null +++ b/7.x/docs/interfaces/SimpleLogger.html @@ -0,0 +1,123 @@ +SimpleLogger | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..17d81c89f --- /dev/null +++ b/7.x/docs/interfaces/SingleThreaded.html @@ -0,0 +1,75 @@ +SingleThreaded | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..86a912308 --- /dev/null +++ b/7.x/docs/interfaces/Size.html @@ -0,0 +1,96 @@ +Size | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..521326e77 --- /dev/null +++ b/7.x/docs/interfaces/SizeReporter.html @@ -0,0 +1,196 @@ +SizeReporter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..430bb65fa --- /dev/null +++ b/7.x/docs/interfaces/SliceStreamOptions.html @@ -0,0 +1,432 @@ +SliceStreamOptions | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..5ddf6abd7 --- /dev/null +++ b/7.x/docs/interfaces/SparqlUpdatePatch.html @@ -0,0 +1,141 @@ +SparqlUpdatePatch | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..8d3dc3faf --- /dev/null +++ b/7.x/docs/interfaces/StorageLocationStrategy.html @@ -0,0 +1,111 @@ +StorageLocationStrategy | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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/SubfolderResourcesGeneratorArgs.html b/7.x/docs/interfaces/SubfolderResourcesGeneratorArgs.html new file mode 100644 index 000000000..a0e9a2c1d --- /dev/null +++ b/7.x/docs/interfaces/SubfolderResourcesGeneratorArgs.html @@ -0,0 +1,133 @@ +SubfolderResourcesGeneratorArgs | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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<any>>
+

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..71bb1f4c1 --- /dev/null +++ b/7.x/docs/interfaces/SubscriptionService.html @@ -0,0 +1,111 @@ +SubscriptionService | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..1c39beaf2 --- /dev/null +++ b/7.x/docs/interfaces/SystemError.html @@ -0,0 +1,192 @@ +SystemError | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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?: any
+

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..07f1588fd --- /dev/null +++ b/7.x/docs/interfaces/TemplateEngineInput.html @@ -0,0 +1,101 @@ +TemplateEngineInput | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..2fdfa5d35 --- /dev/null +++ b/7.x/docs/interfaces/TemplateOptions.html @@ -0,0 +1,106 @@ +TemplateOptions | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..b784582d0 --- /dev/null +++ b/7.x/docs/interfaces/TemplatePath.html @@ -0,0 +1,92 @@ +TemplatePath | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..0c1c39e96 --- /dev/null +++ b/7.x/docs/interfaces/TemplateString.html @@ -0,0 +1,85 @@ +TemplateString | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..acb80c961 --- /dev/null +++ b/7.x/docs/interfaces/TemplatedResourcesGenerator.html @@ -0,0 +1,127 @@ +TemplatedResourcesGenerator | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..cb8950281 --- /dev/null +++ b/7.x/docs/interfaces/V6MigrationInitializerArgs.html @@ -0,0 +1,158 @@ +V6MigrationInitializerArgs | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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<any>
+

The storage that will contain the account data in the new format.

+
+
+
+

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..15bea0b41 --- /dev/null +++ b/7.x/docs/interfaces/WacAllowHttpHandlerArgs.html @@ -0,0 +1,106 @@ +WacAllowHttpHandlerArgs | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..798d9c09c --- /dev/null +++ b/7.x/docs/interfaces/WebIdStore.html @@ -0,0 +1,221 @@ +WebIdStore | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..92b472fc5 --- /dev/null +++ b/7.x/docs/interfaces/WebSocket2023HandlerInput.html @@ -0,0 +1,92 @@ +WebSocket2023HandlerInput | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..2bbd8b753 --- /dev/null +++ b/7.x/docs/interfaces/WebSocketChannel2023.html @@ -0,0 +1,217 @@ +WebSocketChannel2023 | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..8acf965e0 --- /dev/null +++ b/7.x/docs/interfaces/WebSocketHandlerInput.html @@ -0,0 +1,92 @@ +WebSocketHandlerInput | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..57bba79d9 --- /dev/null +++ b/7.x/docs/interfaces/WebhookChannel2023.html @@ -0,0 +1,217 @@ +WebhookChannel2023 | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..62372b3dc --- /dev/null +++ b/7.x/docs/modules.html @@ -0,0 +1,884 @@ +Community Solid Server - v7.0.0
+
+ +
+
+
+
+

Community Solid Server - v7.0.0

+
+
+

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 +SubdomainExtensionBasedMapper +SubdomainIdentifierGenerator +SubdomainIdentifierStrategy +SubfolderResourcesGenerator +SuffixAuxiliaryIdentifierStrategy +SuffixIdentifierGenerator +TargetExtractor +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 +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 +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..8f2f06a28 --- /dev/null +++ b/7.x/docs/types/AccessMap.html @@ -0,0 +1,64 @@ +AccessMap | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..469b656e6 --- /dev/null +++ b/7.x/docs/types/AccountIdKey.html @@ -0,0 +1,61 @@ +AccountIdKey | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..4767dd52a --- /dev/null +++ b/7.x/docs/types/AccountIdRoute.html @@ -0,0 +1,64 @@ +AccountIdRoute | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..e85151f3f --- /dev/null +++ b/7.x/docs/types/AccountInteractionResults.html @@ -0,0 +1,69 @@ +AccountInteractionResults | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..ac1896bc8 --- /dev/null +++ b/7.x/docs/types/AccountLoginStorage.html @@ -0,0 +1,70 @@ +AccountLoginStorage | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..2232020d9 --- /dev/null +++ b/7.x/docs/types/AccountSettings.html @@ -0,0 +1,66 @@ +AccountSettings | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..c87fda792 --- /dev/null +++ b/7.x/docs/types/AclPermissionSet.html @@ -0,0 +1,61 @@ +AclPermissionSet | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..6c8c988a7 --- /dev/null +++ b/7.x/docs/types/ActivityEmitter.html @@ -0,0 +1,65 @@ +ActivityEmitter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..0265a4468 --- /dev/null +++ b/7.x/docs/types/ArrayElement.html @@ -0,0 +1,66 @@ +ArrayElement | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Type alias ArrayElement<TArray>

+
ArrayElement<TArray>: TArray[number]
+
+

Type Parameters

+
    +
  • +

    TArray extends readonly any[]

+
+
+
+
+

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..db0162564 --- /dev/null +++ b/7.x/docs/types/AsyncHandlerInput.html @@ -0,0 +1,66 @@ +AsyncHandlerInput | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..2a620e1b6 --- /dev/null +++ b/7.x/docs/types/AsyncHandlerOutput.html @@ -0,0 +1,66 @@ +AsyncHandlerOutput | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..887436143 --- /dev/null +++ b/7.x/docs/types/ChangeMap.html @@ -0,0 +1,66 @@ +ChangeMap | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..a2797c286 --- /dev/null +++ b/7.x/docs/types/ClientCredentialsIdRoute.html @@ -0,0 +1,64 @@ +ClientCredentialsIdRoute | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..fff4b112b --- /dev/null +++ b/7.x/docs/types/CreateTypeObject.html @@ -0,0 +1,70 @@ +CreateTypeObject | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..a06055bbc --- /dev/null +++ b/7.x/docs/types/Credentials.html @@ -0,0 +1,82 @@ +Credentials | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Type alias Credentials

+
Credentials: {
    agent?: {
        webId: string;
    };
    client?: {
        clientId: string;
    };
    issuer?: {
        url: string;
    };
}
+

Credentials identifying an entity accessing or owning data.

+
+
+

Type declaration

+
    +
  • +
    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..f31d66e7f --- /dev/null +++ b/7.x/docs/types/CredentialsIdKey.html @@ -0,0 +1,61 @@ +CredentialsIdKey | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..c2f362109 --- /dev/null +++ b/7.x/docs/types/EmptyMapConstructor.html @@ -0,0 +1,72 @@ +EmptyMapConstructor | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Type alias EmptyMapConstructor

+
EmptyMapConstructor: (new () => Map<any, any>)
+
+

Type declaration

+
    +
  • +
      +
    • new (): Map<any, any>
      • +
    • +

      A simplified version of MapConstructor that only allows creating an empty Map.

      +
      +

      Returns Map<any, any>

      +
+
+
+
+
+

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..5ddb4dcf4 --- /dev/null +++ b/7.x/docs/types/EmptyObject.html @@ -0,0 +1,61 @@ +EmptyObject | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..10609a2d7 --- /dev/null +++ b/7.x/docs/types/Expires.html @@ -0,0 +1,73 @@ +Expires | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..7057dad91 --- /dev/null +++ b/7.x/docs/types/ExtendedRoute.html @@ -0,0 +1,71 @@ +ExtendedRoute | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..c8efa1d4b --- /dev/null +++ b/7.x/docs/types/Guarded.html @@ -0,0 +1,71 @@ +Guarded | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..d6ed82af6 --- /dev/null +++ b/7.x/docs/types/HttpRequest.html @@ -0,0 +1,64 @@ +HttpRequest | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..218fd6613 --- /dev/null +++ b/7.x/docs/types/HttpResponse.html @@ -0,0 +1,64 @@ +HttpResponse | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..6e389cd35 --- /dev/null +++ b/7.x/docs/types/IndexRelation.html @@ -0,0 +1,86 @@ +IndexRelation | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..1c86a86be --- /dev/null +++ b/7.x/docs/types/IndexTypeCollection.html @@ -0,0 +1,69 @@ +IndexTypeCollection | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..c16ca2f34 --- /dev/null +++ b/7.x/docs/types/IndexTypeDescription.html @@ -0,0 +1,69 @@ +IndexTypeDescription | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..28d7a1c28 --- /dev/null +++ b/7.x/docs/types/IndexedQuery.html @@ -0,0 +1,83 @@ +IndexedQuery | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..151552471 --- /dev/null +++ b/7.x/docs/types/Interaction.html @@ -0,0 +1,61 @@ +Interaction | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..2ee253a07 --- /dev/null +++ b/7.x/docs/types/Json.html @@ -0,0 +1,64 @@ +Json | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Type alias Json

+
Json: string | number | boolean | 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..94b6cee9d --- /dev/null +++ b/7.x/docs/types/LogLevel.html @@ -0,0 +1,64 @@ +LogLevel | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..2519d3dbf --- /dev/null +++ b/7.x/docs/types/LoginOutputType.html @@ -0,0 +1,78 @@ +LoginOutputType | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..c2a903f80 --- /dev/null +++ b/7.x/docs/types/MapEntry.html @@ -0,0 +1,66 @@ +MapEntry | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Type alias MapEntry<T>

+
MapEntry<T>: T extends Map<any, any>
    ? [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..2c705cbd2 --- /dev/null +++ b/7.x/docs/types/MapKey.html @@ -0,0 +1,66 @@ +MapKey | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Type alias MapKey<T>

+
MapKey<T>: T extends Map<infer TKey, any>
    ? 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..c20afeaf1 --- /dev/null +++ b/7.x/docs/types/MapValue.html @@ -0,0 +1,66 @@ +MapValue | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Type alias MapValue<T>

+
MapValue<T>: T extends Map<any, 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..81cf2ff93 --- /dev/null +++ b/7.x/docs/types/MetadataGraph.html @@ -0,0 +1,61 @@ +MetadataGraph | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..04ccdeefb --- /dev/null +++ b/7.x/docs/types/MetadataIdentifier.html @@ -0,0 +1,61 @@ +MetadataIdentifier | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..63b7ad3e1 --- /dev/null +++ b/7.x/docs/types/MetadataRecord.html @@ -0,0 +1,61 @@ +MetadataRecord | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..e7f13fe37 --- /dev/null +++ b/7.x/docs/types/MetadataValue.html @@ -0,0 +1,61 @@ +MetadataValue | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..908812beb --- /dev/null +++ b/7.x/docs/types/ModifyOptions.html @@ -0,0 +1,82 @@ +ModifyOptions | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..87a09dc52 --- /dev/null +++ b/7.x/docs/types/OptionalKey.html @@ -0,0 +1,69 @@ +OptionalKey | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..8ee78810e --- /dev/null +++ b/7.x/docs/types/PartialVocabulary.html @@ -0,0 +1,80 @@ +PartialVocabulary | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..801009c9c --- /dev/null +++ b/7.x/docs/types/PasswordIdKey.html @@ -0,0 +1,61 @@ +PasswordIdKey | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..7585b245c --- /dev/null +++ b/7.x/docs/types/PasswordIdRoute.html @@ -0,0 +1,64 @@ +PasswordIdRoute | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..65dd7ff2f --- /dev/null +++ b/7.x/docs/types/PatchHandlerInput.html @@ -0,0 +1,75 @@ +PatchHandlerInput | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..f16af1337 --- /dev/null +++ b/7.x/docs/types/PermissionMap.html @@ -0,0 +1,64 @@ +PermissionMap | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..ce0e7add4 --- /dev/null +++ b/7.x/docs/types/PermissionSet.html @@ -0,0 +1,64 @@ +PermissionSet | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..a76fe83e6 --- /dev/null +++ b/7.x/docs/types/PodIdKey.html @@ -0,0 +1,61 @@ +PodIdKey | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..c2e6ff25c --- /dev/null +++ b/7.x/docs/types/PodIdRoute.html @@ -0,0 +1,64 @@ +PodIdRoute | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..f31f51e5d --- /dev/null +++ b/7.x/docs/types/PromiseOrValue.html @@ -0,0 +1,66 @@ +PromiseOrValue | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..a21d69088 --- /dev/null +++ b/7.x/docs/types/RouteParameter.html @@ -0,0 +1,69 @@ +RouteParameter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..c0ca1e37e --- /dev/null +++ b/7.x/docs/types/StringKey.html @@ -0,0 +1,69 @@ +StringKey | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..e91e7840a --- /dev/null +++ b/7.x/docs/types/Template.html @@ -0,0 +1,61 @@ +Template | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..4e022918a --- /dev/null +++ b/7.x/docs/types/TemplateFileName.html @@ -0,0 +1,61 @@ +TemplateFileName | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..9e505cfc7 --- /dev/null +++ b/7.x/docs/types/TypeObject.html @@ -0,0 +1,75 @@ +TypeObject | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..b23ef248d --- /dev/null +++ b/7.x/docs/types/ValidatorInput.html @@ -0,0 +1,68 @@ +ValidatorInput | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..4b95e7ded --- /dev/null +++ b/7.x/docs/types/ValuePreference.html @@ -0,0 +1,72 @@ +ValuePreference | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..dbe026f24 --- /dev/null +++ b/7.x/docs/types/ValuePreferences.html @@ -0,0 +1,76 @@ +ValuePreferences | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..fd298b547 --- /dev/null +++ b/7.x/docs/types/ValueType.html @@ -0,0 +1,69 @@ +ValueType | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..966f7412b --- /dev/null +++ b/7.x/docs/types/ValueTypeDescription.html @@ -0,0 +1,73 @@ +ValueTypeDescription | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..537e5ae84 --- /dev/null +++ b/7.x/docs/types/VirtualKey.html @@ -0,0 +1,69 @@ +VirtualKey | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..d48166002 --- /dev/null +++ b/7.x/docs/types/VirtualObject.html @@ -0,0 +1,71 @@ +VirtualObject | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..72c8e1e98 --- /dev/null +++ b/7.x/docs/types/Vocabulary.html @@ -0,0 +1,77 @@ +Vocabulary | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..3193aede2 --- /dev/null +++ b/7.x/docs/types/VocabularyLocal.html @@ -0,0 +1,69 @@ +VocabularyLocal | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Type alias VocabularyLocal<T>

+
VocabularyLocal<T>: T extends Vocabulary<any, 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..a3f1d15bb --- /dev/null +++ b/7.x/docs/types/VocabularyTerm.html @@ -0,0 +1,69 @@ +VocabularyTerm | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Type alias VocabularyTerm<T>

+
VocabularyTerm<T>: T extends Vocabulary<any, 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..ef5e93737 --- /dev/null +++ b/7.x/docs/types/VocabularyValue.html @@ -0,0 +1,69 @@ +VocabularyValue | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Type alias VocabularyValue<T>

+
VocabularyValue<T>: T extends Vocabulary<any, 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..f1dfbcbd0 --- /dev/null +++ b/7.x/docs/types/WebIdLinkKey.html @@ -0,0 +1,61 @@ +WebIdLinkKey | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..9f6ab8790 --- /dev/null +++ b/7.x/docs/types/WebIdLinkRoute.html @@ -0,0 +1,64 @@ +WebIdLinkRoute | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..b8239c341 --- /dev/null +++ b/7.x/docs/types/YargsOptions.html @@ -0,0 +1,61 @@ +YargsOptions | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..65f4bb362 --- /dev/null +++ b/7.x/docs/variables/ACCOUNT_ID_KEY.html @@ -0,0 +1,61 @@ +ACCOUNT_ID_KEY | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..98ed3e57e --- /dev/null +++ b/7.x/docs/variables/ACCOUNT_PROMPT.html @@ -0,0 +1,66 @@ +ACCOUNT_PROMPT | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..449045483 --- /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.0
+
+ +
+
+
+
+ +

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..be1e99d17 --- /dev/null +++ b/7.x/docs/variables/ACCOUNT_STORAGE_DESCRIPTION.html @@ -0,0 +1,66 @@ +ACCOUNT_STORAGE_DESCRIPTION | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..d3c99959b --- /dev/null +++ b/7.x/docs/variables/ACCOUNT_TYPE.html @@ -0,0 +1,61 @@ +ACCOUNT_TYPE | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..7ca6b2918 --- /dev/null +++ b/7.x/docs/variables/ACL.html @@ -0,0 +1,61 @@ +ACL | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..79121c470 --- /dev/null +++ b/7.x/docs/variables/ACP.html @@ -0,0 +1,61 @@ +ACP | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..58b421279 --- /dev/null +++ b/7.x/docs/variables/APPLICATION_JSON.html @@ -0,0 +1,61 @@ +APPLICATION_JSON | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..d1013e0a3 --- /dev/null +++ b/7.x/docs/variables/APPLICATION_LD_JSON.html @@ -0,0 +1,61 @@ +APPLICATION_LD_JSON | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..2d2e8adbf --- /dev/null +++ b/7.x/docs/variables/APPLICATION_OCTET_STREAM.html @@ -0,0 +1,61 @@ +APPLICATION_OCTET_STREAM | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..080d51479 --- /dev/null +++ b/7.x/docs/variables/APPLICATION_SPARQL_UPDATE.html @@ -0,0 +1,61 @@ +APPLICATION_SPARQL_UPDATE | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..884b8b032 --- /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.0
+
+ +
+
+
+
+ +

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..69345c0c3 --- /dev/null +++ b/7.x/docs/variables/AS.html @@ -0,0 +1,61 @@ +AS | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Variable ASConst

+
AS: Vocabulary<"https://www.w3.org/ns/activitystreams#", "object" | "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..e4a6780a2 --- /dev/null +++ b/7.x/docs/variables/AUTH.html @@ -0,0 +1,61 @@ +AUTH | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..8c6f5739d --- /dev/null +++ b/7.x/docs/variables/BaseActivityEmitter.html @@ -0,0 +1,72 @@ +BaseActivityEmitter | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..3f0c6a05a --- /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.0
+
+ +
+
+
+
+ +

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..faabb377c --- /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.0
+
+ +
+
+
+
+ +

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..95e5938a0 --- /dev/null +++ b/7.x/docs/variables/CONTENT_LENGTH.html @@ -0,0 +1,61 @@ +CONTENT_LENGTH | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..f3cf1c518 --- /dev/null +++ b/7.x/docs/variables/CONTENT_LENGTH_TERM.html @@ -0,0 +1,61 @@ +CONTENT_LENGTH_TERM | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..f31d61e6e --- /dev/null +++ b/7.x/docs/variables/CONTENT_TYPE.html @@ -0,0 +1,61 @@ +CONTENT_TYPE | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..d463ab172 --- /dev/null +++ b/7.x/docs/variables/CONTENT_TYPE_TERM.html @@ -0,0 +1,61 @@ +CONTENT_TYPE_TERM | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..fdba839ba --- /dev/null +++ b/7.x/docs/variables/DC.html @@ -0,0 +1,61 @@ +DC | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..e6c26125c --- /dev/null +++ b/7.x/docs/variables/DEFAULT_CUSTOM_TYPES.html @@ -0,0 +1,70 @@ +DEFAULT_CUSTOM_TYPES | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..3d8408553 --- /dev/null +++ b/7.x/docs/variables/DEFAULT_NOTIFICATION_FEATURES.html @@ -0,0 +1,64 @@ +DEFAULT_NOTIFICATION_FEATURES | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..c1510497f --- /dev/null +++ b/7.x/docs/variables/DEFAULT_SUBSCRIPTION_SHACL.html @@ -0,0 +1,77 @@ +DEFAULT_SUBSCRIPTION_SHACL | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..ddd16efd8 --- /dev/null +++ b/7.x/docs/variables/FOAF.html @@ -0,0 +1,61 @@ +FOAF | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..46062acd5 --- /dev/null +++ b/7.x/docs/variables/HH.html @@ -0,0 +1,61 @@ +HH | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..4d843edf5 --- /dev/null +++ b/7.x/docs/variables/HTTP.html @@ -0,0 +1,61 @@ +HTTP | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..06de6ee85 --- /dev/null +++ b/7.x/docs/variables/IANA.html @@ -0,0 +1,61 @@ +IANA | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..ee553418a --- /dev/null +++ b/7.x/docs/variables/INDEX_ID_KEY.html @@ -0,0 +1,64 @@ +INDEX_ID_KEY | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..46d0352bc --- /dev/null +++ b/7.x/docs/variables/INTERNAL_ALL.html @@ -0,0 +1,61 @@ +INTERNAL_ALL | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..cf7c83a47 --- /dev/null +++ b/7.x/docs/variables/INTERNAL_ERROR.html @@ -0,0 +1,61 @@ +INTERNAL_ERROR | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..8b5206700 --- /dev/null +++ b/7.x/docs/variables/INTERNAL_QUADS.html @@ -0,0 +1,61 @@ +INTERNAL_QUADS | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..9af897014 --- /dev/null +++ b/7.x/docs/variables/JSON_LD.html @@ -0,0 +1,61 @@ +JSON_LD | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..f595351cd --- /dev/null +++ b/7.x/docs/variables/LDP.html @@ -0,0 +1,61 @@ +LDP | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..5bbd6f85a --- /dev/null +++ b/7.x/docs/variables/LOG_LEVELS.html @@ -0,0 +1,61 @@ +LOG_LEVELS | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..e0609e110 --- /dev/null +++ b/7.x/docs/variables/MA.html @@ -0,0 +1,61 @@ +MA | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..554842364 --- /dev/null +++ b/7.x/docs/variables/NOTIFY.html @@ -0,0 +1,61 @@ +NOTIFY | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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"> = ...
+
+
+
+
+

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..e0ad47649 --- /dev/null +++ b/7.x/docs/variables/OIDC.html @@ -0,0 +1,61 @@ +OIDC | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..a84a866a6 --- /dev/null +++ b/7.x/docs/variables/OWNER_STORAGE_DESCRIPTION.html @@ -0,0 +1,70 @@ +OWNER_STORAGE_DESCRIPTION | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..1045b4911 --- /dev/null +++ b/7.x/docs/variables/OWNER_STORAGE_TYPE.html @@ -0,0 +1,61 @@ +OWNER_STORAGE_TYPE | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..4e4a774ab --- /dev/null +++ b/7.x/docs/variables/PASSWORD_METHOD.html @@ -0,0 +1,64 @@ +PASSWORD_METHOD | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..a555021d9 --- /dev/null +++ b/7.x/docs/variables/PASSWORD_STORAGE_DESCRIPTION.html @@ -0,0 +1,72 @@ +PASSWORD_STORAGE_DESCRIPTION | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..c815114c8 --- /dev/null +++ b/7.x/docs/variables/PASSWORD_STORAGE_TYPE.html @@ -0,0 +1,61 @@ +PASSWORD_STORAGE_TYPE | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..0f5dfe376 --- /dev/null +++ b/7.x/docs/variables/PIM.html @@ -0,0 +1,61 @@ +PIM | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..f8d5649a1 --- /dev/null +++ b/7.x/docs/variables/POD_STORAGE_DESCRIPTION.html @@ -0,0 +1,68 @@ +POD_STORAGE_DESCRIPTION | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..198f92f01 --- /dev/null +++ b/7.x/docs/variables/POD_STORAGE_TYPE.html @@ -0,0 +1,61 @@ +POD_STORAGE_TYPE | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..d01a50c5e --- /dev/null +++ b/7.x/docs/variables/POSIX.html @@ -0,0 +1,61 @@ +POSIX | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..9641f3984 --- /dev/null +++ b/7.x/docs/variables/PREFERRED_PREFIX.html @@ -0,0 +1,61 @@ +PREFERRED_PREFIX | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..92c2429f9 --- /dev/null +++ b/7.x/docs/variables/PREFERRED_PREFIX_TERM.html @@ -0,0 +1,61 @@ +PREFERRED_PREFIX_TERM | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..e2604053c --- /dev/null +++ b/7.x/docs/variables/RDF.html @@ -0,0 +1,61 @@ +RDF | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..8ac8cbef8 --- /dev/null +++ b/7.x/docs/variables/RDFS.html @@ -0,0 +1,61 @@ +RDFS | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..2a80feea9 --- /dev/null +++ b/7.x/docs/variables/SOLID.html @@ -0,0 +1,61 @@ +SOLID | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..f9dad3fb2 --- /dev/null +++ b/7.x/docs/variables/SOLID_AS.html @@ -0,0 +1,61 @@ +SOLID_AS | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..00922136d --- /dev/null +++ b/7.x/docs/variables/SOLID_ERROR.html @@ -0,0 +1,61 @@ +SOLID_ERROR | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Variable SOLID_ERRORConst

+
SOLID_ERROR: Vocabulary<"urn:npm:solid:community-server:error:", "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..aab60d6ad --- /dev/null +++ b/7.x/docs/variables/SOLID_ERROR_TERM.html @@ -0,0 +1,61 @@ +SOLID_ERROR_TERM | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..61cfa8e56 --- /dev/null +++ b/7.x/docs/variables/SOLID_HTTP.html @@ -0,0 +1,61 @@ +SOLID_HTTP | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..219783499 --- /dev/null +++ b/7.x/docs/variables/SOLID_META.html @@ -0,0 +1,61 @@ +SOLID_META | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

Variable SOLID_METAConst

+
SOLID_META: Vocabulary<"urn:npm:solid:community-server:meta:", "value" | "ResponseMetadata" | "template" | "contentTypeParameter" | "preserve"> = ...
+
+
+
+
+

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..77a00ed35 --- /dev/null +++ b/7.x/docs/variables/TEMPLATE-1.html @@ -0,0 +1,61 @@ +TEMPLATE | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..8300f68fd --- /dev/null +++ b/7.x/docs/variables/TEMPLATE_VARIABLE.html @@ -0,0 +1,61 @@ +TEMPLATE_VARIABLE | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..9f516b93d --- /dev/null +++ b/7.x/docs/variables/TEXT_HTML.html @@ -0,0 +1,61 @@ +TEXT_HTML | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..a1e346449 --- /dev/null +++ b/7.x/docs/variables/TEXT_MARKDOWN.html @@ -0,0 +1,61 @@ +TEXT_MARKDOWN | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..9cf62b16a --- /dev/null +++ b/7.x/docs/variables/TEXT_N3.html @@ -0,0 +1,61 @@ +TEXT_N3 | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..07bcc3bc3 --- /dev/null +++ b/7.x/docs/variables/TEXT_TURTLE.html @@ -0,0 +1,61 @@ +TEXT_TURTLE | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..4779eb80a --- /dev/null +++ b/7.x/docs/variables/UNIT_BYTES.html @@ -0,0 +1,61 @@ +UNIT_BYTES | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..6ad5d1950 --- /dev/null +++ b/7.x/docs/variables/URL_SCHEMA.html @@ -0,0 +1,61 @@ +URL_SCHEMA | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..87f4e6e15 --- /dev/null +++ b/7.x/docs/variables/VANN.html @@ -0,0 +1,61 @@ +VANN | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..37241c27b --- /dev/null +++ b/7.x/docs/variables/VCARD.html @@ -0,0 +1,61 @@ +VCARD | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..5ae44d8f8 --- /dev/null +++ b/7.x/docs/variables/WEBID_STORAGE_DESCRIPTION.html @@ -0,0 +1,68 @@ +WEBID_STORAGE_DESCRIPTION | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..8460f0115 --- /dev/null +++ b/7.x/docs/variables/WEBID_STORAGE_TYPE.html @@ -0,0 +1,61 @@ +WEBID_STORAGE_TYPE | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..ecb4bf15b --- /dev/null +++ b/7.x/docs/variables/XSD.html @@ -0,0 +1,61 @@ +XSD | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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..3d7e70d63 --- /dev/null +++ b/7.x/docs/variables/modulePathPlaceholder.html @@ -0,0 +1,65 @@ +modulePathPlaceholder | Community Solid Server - v7.0.0
+
+ +
+
+
+
+ +

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