From 089ea10f76b9fa30dda162951a05b2f0514803cc Mon Sep 17 00:00:00 2001 From: SevenWaysDP <97111299+SevenWaysDP@users.noreply.github.com> Date: Thu, 7 Sep 2023 09:59:22 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20hpi-schu?= =?UTF-8?q?l-cloud/schulcloud-server@4d4041d24f145ee409ce2a2fc90acf4e0313d?= =?UTF-8?q?b64=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../nestjs-application/s3clientmodule.html | 146 + coverage.html | 38 +- graph/dependencies.svg | 5740 ++++++++--------- injectables/FilesStorageService.html | 143 +- injectables/FwuLearningContentsUc.html | 14 +- injectables/PreviewService.html | 43 +- interfaces/CopyFiles.html | 1 + interfaces/GetFile.html | 1 + interfaces/IFileStorageConfig.html | 2 + interfaces/S3Config-1.html | 40 + js/menu-wc.js | 53 +- js/search/search_index.js | 4 +- miscellaneous/variables.html | 315 +- modules.html | 6 +- modules/AccountModule.html | 120 +- modules/AccountModule/dependencies.svg | 120 +- modules/AuthenticationModule.html | 8 +- modules/AuthenticationModule/dependencies.svg | 8 +- modules/AuthorizationModule.html | 8 +- modules/AuthorizationModule/dependencies.svg | 8 +- modules/BoardModule.html | 8 +- modules/BoardModule/dependencies.svg | 8 +- modules/CalendarModule.html | 8 +- modules/CalendarModule/dependencies.svg | 8 +- .../CollaborativeStorageAdapterModule.html | 98 +- .../dependencies.svg | 98 +- modules/CollaborativeStorageModule.html | 96 +- .../dependencies.svg | 96 +- modules/CommonToolModule.html | 112 +- modules/CommonToolModule/dependencies.svg | 112 +- modules/ConsoleWriterModule.html | 8 +- modules/ConsoleWriterModule/dependencies.svg | 8 +- modules/ContextExternalToolModule.html | 8 +- .../dependencies.svg | 8 +- modules/DatabaseManagementModule.html | 8 +- .../DatabaseManagementModule/dependencies.svg | 8 +- modules/ExternalToolModule.html | 152 +- modules/ExternalToolModule/dependencies.svg | 152 +- modules/FileSystemModule.html | 8 +- modules/FileSystemModule/dependencies.svg | 8 +- modules/FilesModule.html | 46 +- modules/FilesModule/dependencies.svg | 46 +- modules/FilesStorageAMQPModule.html | 46 +- .../FilesStorageAMQPModule/dependencies.svg | 46 +- modules/FilesStorageApiModule.html | 54 +- .../FilesStorageApiModule/dependencies.svg | 54 +- modules/FilesStorageClientModule.html | 8 +- .../FilesStorageClientModule/dependencies.svg | 8 +- modules/FilesStorageModule.html | 114 +- modules/FilesStorageModule/dependencies.svg | 112 +- modules/FwuLearningContentsModule.html | 118 +- .../dependencies.svg | 106 +- modules/FwuLearningContentsTestModule.html | 139 +- .../dependencies.svg | 122 +- modules/GroupModule.html | 8 +- modules/GroupModule/dependencies.svg | 8 +- modules/H5PEditorModule.html | 46 +- modules/H5PEditorModule/dependencies.svg | 46 +- modules/ImportUserModule.html | 86 +- modules/ImportUserModule/dependencies.svg | 86 +- modules/KeycloakAdministrationModule.html | 8 +- .../dependencies.svg | 8 +- modules/KeycloakConfigurationModule.html | 114 +- .../dependencies.svg | 114 +- modules/KeycloakModule.html | 72 +- modules/KeycloakModule/dependencies.svg | 72 +- modules/LearnroomApiModule.html | 158 +- modules/LearnroomApiModule/dependencies.svg | 158 +- modules/LearnroomModule.html | 176 +- modules/LearnroomModule/dependencies.svg | 176 +- modules/LessonApiModule.html | 38 +- modules/LessonApiModule/dependencies.svg | 38 +- modules/LoggerModule.html | 8 +- modules/LoggerModule/dependencies.svg | 8 +- modules/NewsModule.html | 58 +- modules/NewsModule/dependencies.svg | 58 +- modules/OauthApiModule.html | 102 +- modules/OauthApiModule/dependencies.svg | 102 +- modules/OauthModule.html | 136 +- modules/OauthModule/dependencies.svg | 136 +- modules/OauthProviderModule.html | 114 +- modules/OauthProviderModule/dependencies.svg | 114 +- modules/ProvisioningModule.html | 120 +- modules/ProvisioningModule/dependencies.svg | 120 +- modules/PseudonymModule.html | 8 +- modules/PseudonymModule/dependencies.svg | 8 +- modules/S3ClientModule.html | 163 +- modules/S3ClientModule/dependencies.svg | 66 - modules/SchoolExternalToolModule.html | 66 +- .../SchoolExternalToolModule/dependencies.svg | 66 +- modules/SchoolModule.html | 8 +- modules/SchoolModule/dependencies.svg | 8 +- modules/SharingModule.html | 90 +- modules/SharingModule/dependencies.svg | 90 +- modules/SystemApiModule.html | 26 +- modules/SystemApiModule/dependencies.svg | 26 +- modules/SystemModule.html | 8 +- modules/SystemModule/dependencies.svg | 8 +- modules/TaskModule.html | 8 +- modules/TaskModule/dependencies.svg | 8 +- modules/TeamsModule.html | 8 +- modules/TeamsModule/dependencies.svg | 8 +- modules/ToolApiModule.html | 166 +- modules/ToolApiModule/dependencies.svg | 166 +- modules/ToolLaunchModule.html | 8 +- modules/ToolLaunchModule/dependencies.svg | 8 +- modules/UserLoginMigrationApiModule.html | 118 +- .../dependencies.svg | 118 +- modules/UserModule.html | 88 +- modules/UserModule/dependencies.svg | 88 +- modules/VideoConferenceModule.html | 132 +- .../VideoConferenceModule/dependencies.svg | 132 +- overview.html | 5740 ++++++++--------- 113 files changed, 9442 insertions(+), 9332 deletions(-) create mode 100644 additional-documentation/nestjs-application/s3clientmodule.html delete mode 100644 modules/S3ClientModule/dependencies.svg diff --git a/additional-documentation/nestjs-application/s3clientmodule.html b/additional-documentation/nestjs-application/s3clientmodule.html new file mode 100644 index 00000000000..ae4fe804d59 --- /dev/null +++ b/additional-documentation/nestjs-application/s3clientmodule.html @@ -0,0 +1,146 @@ + + +
+ + +This module allows to connect to the S3 storage with our abstraction layer.
+You need to create a unique connection token and set it as the connection name in S3 configuration. And you must use this token, when injecting the S3 client into your service. This is very important, because multiple modules could potentially use the S3 client with different configurations.
+The S3ClientModule.register method awaits an array of S3 configurations. Also you can create many connections to different S3 providers and buckets.
+// your.config.ts
+export const YOUR_S3_UNIQ_CONNECTION_TOKEN = "YOUR_S3_UNIQ_CONNECTION_TOKEN";
+
+const s3Config: S3Config = {
+ connectionName: YOUR_S3_UNIQ_CONNECTION_TOKEN, // Important!
+ endpoint: "",
+ region: "",
+ bucket: "",
+ accessKeyId: "",
+ secretAccessKey: "",
+};
+
+// your.service.ts
+
+@Injectable()
+export class FilesStorageService {
+ constructor(
+ @Inject(YOUR_S3_UNIQ_CONNECTION_TOKEN) // Important!
+ private readonly storageClient: S3ClientAdapter)
+}
+
+// your.module.ts
+@Module({
+ imports: [S3ClientModule.register([s3Config]),]
+ providers: [YourService]
+})
+
+export class YourModule {}
+