fix: sdk new package name and some small improvements (#1701)

* fix local sdk generation after introducing some new parameters on the backend and do some cleanup of appendToArrayField endpoint usage

* bump sdk version and improve the local generation

* rename the scicat-sdk-ts to scicat-sdk-ts-angular

* fix linting issues

* add some improvements in the dataset sharing process suggested by sourcery-ai

* fix unit test types

* fix failing tests and add some small improvements

* try to revert the appendToDatasetArray changes

* fix failing tests

Author: martin-trajanovski

package-lock.json

@@ -35,7 +35,7 @@
     "@ngrx/router-store": "^16",
     "@ngrx/store": "^16",
     "@ngx-translate/core": "^16.0.4",
-    "@scicatproject/scicat-sdk-ts": "^4.8.3",
+    "@scicatproject/scicat-sdk-ts-angular": "^4.11.0",
     "autolinker": "^4.0.0",
     "deep-equal": "^2.0.5",
     "exceljs": "^4.3.0",

package.json

@@ -6,8 +6,8 @@ USER=`who am i | cut -d\  -f1`
 echo -e "\nUser running the script: ${USER}"
 
 echo -e "\nCleanup old files..."
-rm -rf node_modules/@scicatproject/scicat-sdk-ts
-rm -rf @scicatproject/scicat-sdk-ts
+rm -rf node_modules/@scicatproject/scicat-sdk-ts-angular
+rm -rf @scicatproject/scicat-sdk-ts-angular
 
 echo -e "\nGenerating the new sdk..."
 docker run \
@@ -17,8 +17,8 @@ docker run \
 	openapitools/openapi-generator-cli:v7.9.0 generate \
 	-i http://host.docker.internal:3000/explorer-json \
 	-g typescript-angular \
-	-o local/@scicatproject/scicat-sdk-ts \
-	--additional-properties=ngVersion=16.2.12,npmName=@scicatproject/scicat-sdk-ts,supportsES6=true,npmVersion=10.8.2,withInterfaces=true
+	-o local/@scicatproject/scicat-sdk-ts-angular \
+	--additional-properties=ngVersion=16.2.12,npmName=@scicatproject/scicat-sdk-ts-angular,supportsES6=true,npmVersion=10.8.2,withInterfaces=true
 
 REMOVE_NPM_LINK=0
 if ! command -v npm 2>&1 1>/dev/null
@@ -38,16 +38,16 @@ then
 fi
 
 echo -e "\nInstalling dependencies and building the sdk..."
-cd @scicatproject/scicat-sdk-ts 
+cd @scicatproject/scicat-sdk-ts-angular 
 npm install
 npm run build
 
 echo -e "\nCopying the build files in node_modules..."
 cd ../..
-cp -rv @scicatproject/scicat-sdk-ts/dist node_modules/@scicatproject/scicat-sdk-ts
+cp -rv @scicatproject/scicat-sdk-ts-angular/dist node_modules/@scicatproject/scicat-sdk-ts-angular
 
 echo -e "\nAdjusting ownership to user ${USER}"
-chown -Rv ${USER} node_modules/@scicatproject/scicat-sdk-ts
+chown -Rv ${USER} node_modules/@scicatproject/scicat-sdk-ts-angular
 
 echo -e "\nFinal cleanup..."
 echo -e "Removing sdk folder"

scripts/generate-nestjs-sdk.bash

@@ -1,7 +1,7 @@
 /**
  * NOTE: This file contains commands that generate new typescript-angular sdk against the running scicat backend
- * which overwrites the node_modules/@scicatproject/scicat-sdk-ts for development purpose
- * It should NOT be used in production because the real (@scicatproject/scicat-sdk-ts) npm package will be installed and used.
+ * which overwrites the node_modules/@scicatproject/scicat-sdk-ts-angular for development purpose
+ * It should NOT be used in production because the real (@scicatproject/scicat-sdk-ts-angular) npm package will be installed and used.
  */
 
 const execSync = require("child_process").execSync;
@@ -20,31 +20,34 @@ function getCurrentDirectory() {
 }
 
 if (isWindows()) {
-
   // NOTE: First do some cleanup before starting the generation
   console.log("Cleanup old files...");
   execSync(
-    "rm -rf node_modules/@scicatproject/scicat-sdk-ts && rm -rf @scicatproject/scicat-sdk-ts",
+    "rm -rf node_modules/@scicatproject/scicat-sdk-ts-angular && rm -rf @scicatproject/scicat-sdk-ts-angular",
     { encoding: "utf-8" },
   );
 
   console.log("Generating the new sdk...");
+  /**
+   * NOTE: parameter --skip-validate-spec is passed to avoid some errors like not supporting the "content" in the @ApiQuery() parameter that we use in the dataset v4 controller.
+   * This should not be a risk as after the generation we can get a feedback immediately if something is broken here when we run and test the frontend.
+   */
   const generationOutput = execSync(
-    `docker run --rm --add-host host.docker.internal:host-gateway -v "${getCurrentDirectory()}:/local" openapitools/openapi-generator-cli:v7.9.0 generate -i http://host.docker.internal:3000/explorer-json -g typescript-angular -o local/@scicatproject/scicat-sdk-ts --additional-properties=ngVersion=16.2.12,npmName=@scicatproject/scicat-sdk-ts,supportsES6=true,npmVersion=10.8.2,withInterfaces=true`,
+    `docker run --rm --add-host host.docker.internal:host-gateway -v "${getCurrentDirectory()}:/local" openapitools/openapi-generator-cli:v7.9.0 generate -i http://host.docker.internal:3000/explorer-json -g typescript-angular -o local/@scicatproject/scicat-sdk-ts-angular --additional-properties=ngVersion=16.2.12,npmName=@scicatproject/scicat-sdk-ts-angular,supportsES6=true,npmVersion=10.8.2,withInterfaces=true,paramNaming=original,modelPropertyNaming=original,enumPropertyNaming=original --skip-validate-spec`,
     { encoding: "utf-8" },
   );
   console.log(generationOutput);
 
   console.log("Installing dependencies and building the sdk...");
   const installBuildOutput = execSync(
-    "cd @scicatproject/scicat-sdk-ts && npm install && npm run build",
+    "cd @scicatproject/scicat-sdk-ts-angular && npm install && npm run build",
     { encoding: "utf-8" },
-  );  
+  );
   console.log(installBuildOutput);
 
   console.log("Copying the build files in node_modules...");
   const copyToNodeModulesOutput = execSync(
-    "cp -r @scicatproject/scicat-sdk-ts/dist node_modules/@scicatproject/scicat-sdk-ts",
+    "cp -r @scicatproject/scicat-sdk-ts-angular/dist node_modules/@scicatproject/scicat-sdk-ts-angular",
     { encoding: "utf-8" },
   );
   console.log(copyToNodeModulesOutput);
@@ -55,14 +58,13 @@ if (isWindows()) {
   });
 
   console.log("Local SDK generation completed");
-
 } else {
   console.log("Your environment is a linux/unix");
   console.log("Please run the following command on your terminal:");
   console.log("> sudo -E ./scripts/generate-nestjs-sdk.bash");
   console.log("");
-  console.log("IMPORTANT: the script runs under sudo. You will be asked your password.");
+  console.log(
+    "IMPORTANT: the script runs under sudo. You will be asked your password.",
+  );
   console.log("");
-
 }
-

scripts/generate-nestjs-sdk.js

@@ -5,7 +5,7 @@ import {
   ActivatedRouteSnapshot,
   RouterStateSnapshot,
 } from "@angular/router";
-import { UsersService } from "@scicatproject/scicat-sdk-ts";
+import { UsersService } from "@scicatproject/scicat-sdk-ts-angular";
 
 /**
  * Ensure that the current user is logged in

src/app/app-routing/auth.guard.ts

@@ -7,7 +7,7 @@ import { MockStore } from "./shared/MockStubs";
 import { APP_CONFIG } from "./app-config.module";
 import { MatProgressSpinnerModule } from "@angular/material/progress-spinner";
 import { AppConfigService } from "app-config.service";
-import { Configuration } from "@scicatproject/scicat-sdk-ts";
+import { Configuration } from "@scicatproject/scicat-sdk-ts-angular";
 
 describe("AppComponent", () => {
   const getConfig = () => ({

src/app/app.component.spec.ts

@@ -24,7 +24,7 @@ import {
 } from "state-management/selectors/user.selectors";
 import { MessageType } from "state-management/models";
 import { AppConfigService, AppConfig as Config } from "app-config.service";
-import { Configuration } from "@scicatproject/scicat-sdk-ts";
+import { Configuration } from "@scicatproject/scicat-sdk-ts-angular";
 
 @Component({
   selector: "app-root",

src/app/app.component.ts

@@ -9,7 +9,7 @@ import { HttpClientModule, HTTP_INTERCEPTORS } from "@angular/common/http";
 import { APP_INITIALIZER, NgModule } from "@angular/core";
 import { ExtraOptions, RouterModule } from "@angular/router";
 import { StoreModule } from "@ngrx/store";
-import { ApiModule, Configuration } from "@scicatproject/scicat-sdk-ts";
+import { ApiModule, Configuration } from "@scicatproject/scicat-sdk-ts-angular";
 import { routerReducer } from "@ngrx/router-store";
 import { extModules } from "./build-specifics";
 import { MatNativeDateModule } from "@angular/material/core";

src/app/app.module.ts

@@ -6,7 +6,7 @@ import { take } from "rxjs/operators";
 import {
   CreateJobDto,
   OutputDatasetObsoleteDto,
-} from "@scicatproject/scicat-sdk-ts";
+} from "@scicatproject/scicat-sdk-ts-angular";
 import { submitJobAction } from "state-management/actions/jobs.actions";
 import {
   selectCurrentDatablocks,

src/app/datasets/admin-tab/admin-tab.component.ts

@@ -10,7 +10,10 @@ import {
 import { JobsState } from "state-management/state/jobs.store";
 import { ArchivingService } from "./archiving.service";
 import { createMock, mockDataset } from "shared/MockStubs";
-import { CreateJobDto, ReturnedUserDto } from "@scicatproject/scicat-sdk-ts";
+import {
+  CreateJobDto,
+  ReturnedUserDto,
+} from "@scicatproject/scicat-sdk-ts-angular";
 
 describe("ArchivingService", () => {
   let service: ArchivingService;