Merge branch 'Issue/2732-updatedApiClient' into 'dev'

BREAKING: New Api-Client

See merge request !86

.eslintrc.json

 {
     "root": true,
     "parser": "@typescript-eslint/parser",
-    "parserOptions": { "project": "./tsconfig.json" },
     "env": { "es6": true },
-    "ignorePatterns": ["node_modules", "build", "coverage"],
-    "plugins": ["import", "eslint-comments", "functional"],
+    "ignorePatterns": ["node_modules", "build", "coverage", "dist"],
+    "plugins": ["eslint-comments"],
     "extends": [
       "eslint:recommended",
       "plugin:@typescript-eslint/recommended",
       "plugin:import/typescript",
-      "prettier",
-      "prettier/@typescript-eslint"
+      "prettier"
     ],
     "globals": { "BigInt": true, "console": true, "WebAssembly": true },
     "rules": {
@@ -18,14 +16,6 @@
       "eslint-comments/disable-enable-pair": [
         "error",
         { "allowWholeFile": true }
-      ],
-      "import/order": [
-        "error",
-        { "newlines-between": "always", "alphabetize": { "order": "asc" } }
-      ],
-      "sort-imports": [
-        "error",
-        { "ignoreDeclarationSort": true, "ignoreCase": true }
       ]
     }
   }

.gitignore

@@ -320,3 +320,12 @@ node_modules
 
 # Old obsolete workspace lock file
 yarn.lock-workspace
+
+# Not necessary generated files
+src/**/.gitignore
+src/**/.npmignore
+src/**/.openapi-generator-ignore
+src/**/git_push.sh
+src/**/FILES
+src/**/VERSION
+docs

.gitlab-ci.yml

@@ -8,6 +8,7 @@ stages:
   - build
 # there are more stages in the imported file but we only want to import some
   - test
+  - pages
   - publish
 
 build-branch:
@@ -19,9 +20,30 @@ build-npm-release:
 test:
   extends: .test
 
+pages:
+  extends: .yarn-cache-verdaccio
+  stage: pages
+  script:
+    - yarn run build
+    # Move the resulting build to the pages 'public' folder
+    - mv docs public
+  artifacts:
+    # all build results are expected to be in the `public` folder
+    paths:
+      - public
+    expire_in: 1 year
+  only:
+    # Do not run by the bot
+    variables:
+      - $CI_COMMIT_TAG !~ /v[0-9]*\.[0-9]*\.[0-9]*/ && $GITLAB_USER_ID != $GIT_BOT_USER_ID
+  when: manual
+
 publish-branch-prerelease:
   extends: .publish-branch-prerelease
 
+publish-branch-gitlab-prerelease:
+  extends: .publish-branch-gitlab-prerelease
+
 publish-master-release:
   extends: .publish-master-release
 

.vscode/settings.json

@@ -4,7 +4,7 @@
     "**/.pnp.*": true
   },
   "eslint.nodePath": ".yarn/sdks",
-  "prettier.prettierPath": ".yarn/sdks/prettier/index.js",
+  "prettier.prettierPath": ".yarn/sdks/prettier/index.cjs",
   "typescript.tsdk": ".yarn/sdks/typescript/lib",
   "typescript.enablePromptUseWorkspaceTsdk": true
 }

.yarn/sdks/eslint/lib/unsupported-api.js

+#!/usr/bin/env node
+
+const {existsSync} = require(`fs`);
+const {createRequire} = require(`module`);
+const {resolve} = require(`path`);
+
+const relPnpApiPath = "../../../../.pnp.cjs";
+
+const absPnpApiPath = resolve(__dirname, relPnpApiPath);
+const absRequire = createRequire(absPnpApiPath);
+
+if (existsSync(absPnpApiPath)) {
+  if (!process.versions.pnp) {
+    // Setup the environment to be able to require eslint/use-at-your-own-risk
+    require(absPnpApiPath).setup();
+  }
+}
+
+// Defer to the real eslint/use-at-your-own-risk your application uses
+module.exports = absRequire(`eslint/use-at-your-own-risk`);

.yarn/sdks/eslint/package.json

 {
   "name": "eslint",
-  "version": "7.32.0-sdk",
+  "version": "8.54.0-sdk",
   "main": "./lib/api.js",
-  "type": "commonjs"
+  "type": "commonjs",
+  "bin": {
+    "eslint": "./bin/eslint.js"
+  },
+  "exports": {
+    "./package.json": "./package.json",
+    ".": "./lib/api.js",
+    "./use-at-your-own-risk": "./lib/unsupported-api.js"
+  }
 }

.yarn/sdks/prettier/bin/prettier.cjs

+#!/usr/bin/env node
+
+const {existsSync} = require(`fs`);
+const {createRequire} = require(`module`);
+const {resolve} = require(`path`);
+
+const relPnpApiPath = "../../../../.pnp.cjs";
+
+const absPnpApiPath = resolve(__dirname, relPnpApiPath);
+const absRequire = createRequire(absPnpApiPath);
+
+if (existsSync(absPnpApiPath)) {
+  if (!process.versions.pnp) {
+    // Setup the environment to be able to require prettier/bin/prettier.cjs
+    require(absPnpApiPath).setup();
+  }
+}
+
+// Defer to the real prettier/bin/prettier.cjs your application uses
+module.exports = absRequire(`prettier/bin/prettier.cjs`);

.yarn/sdks/prettier/index.js → .yarn/sdks/prettier/index.cjs

@@ -11,10 +11,10 @@ const absRequire = createRequire(absPnpApiPath);
 
 if (existsSync(absPnpApiPath)) {
   if (!process.versions.pnp) {
-    // Setup the environment to be able to require prettier/index.js
+    // Setup the environment to be able to require prettier
     require(absPnpApiPath).setup();
   }
 }
 
-// Defer to the real prettier/index.js your application uses
-module.exports = absRequire(`prettier/index.js`);
+// Defer to the real prettier your application uses
+module.exports = absRequire(`prettier`);

.yarn/sdks/prettier/package.json

 {
   "name": "prettier",
-  "version": "2.7.1-sdk",
-  "main": "./index.js",
-  "type": "commonjs"
+  "version": "3.1.0-sdk",
+  "main": "./index.cjs",
+  "type": "commonjs",
+  "bin": "./bin/prettier.cjs"
 }

.yarn/sdks/typescript/lib/tsserver.js

@@ -109,6 +109,8 @@ const moduleWrapper = tsserver => {
             str = `zip:${str}`;
           } break;
         }
+      } else {
+        str = str.replace(/^\/?/, process.platform === `win32` ? `` : `/`);
       }
     }
 

.yarn/sdks/typescript/lib/tsserverlibrary.js

@@ -109,6 +109,8 @@ const moduleWrapper = tsserver => {
             str = `zip:${str}`;
           } break;
         }
+      } else {
+        str = str.replace(/^\/?/, process.platform === `win32` ? `` : `/`);
       }
     }
 

.yarn/sdks/typescript/lib/typescript.js

@@ -11,10 +11,10 @@ const absRequire = createRequire(absPnpApiPath);
 
 if (existsSync(absPnpApiPath)) {
   if (!process.versions.pnp) {
-    // Setup the environment to be able to require typescript/lib/typescript.js
+    // Setup the environment to be able to require typescript
     require(absPnpApiPath).setup();
   }
 }
 
-// Defer to the real typescript/lib/typescript.js your application uses
-module.exports = absRequire(`typescript/lib/typescript.js`);
+// Defer to the real typescript your application uses
+module.exports = absRequire(`typescript`);

.yarn/sdks/typescript/package.json

 {
   "name": "typescript",
-  "version": "4.9.3-sdk",
+  "version": "5.3.2-sdk",
   "main": "./lib/typescript.js",
-  "type": "commonjs"
+  "type": "commonjs",
+  "bin": {
+    "tsc": "./bin/tsc",
+    "tsserver": "./bin/tsserver"
+  }
 }

.yarnrc.yml

@@ -2,4 +2,4 @@ compressionLevel: mixed
 
 enableGlobalCache: false
 
-yarnPath: .yarn/releases/yarn-4.0.1.cjs
+yarnPath: .yarn/releases/yarn-4.0.2.cjs

LICENSE

 MIT License
 
-Copyright (c) 2021 RWTH Aachen University
+Copyright (c) 2023 RWTH Aachen University
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -4,17 +4,20 @@
 
 ## 📝 Overview
 
-The API Client library for Vue TypeScript contains generated API connection classes based on the Coscine API Swagger definitions, bundling them together for ease of use within Coscine applications. Additionally, the library provides setup functionality to simplify the API connection process and streamline communication with the Coscine API.
+The API Client library for JavaScript clients contains generated API connection classes and their typings based on the Coscine API Swagger definitions, bundling them together for ease of use within Coscine applications. Additionally, the library provides setup functionality to simplify the API connection process and streamline communication with the Coscine API.
 
 ## 📖 Usage
 
 ### Build
 * `yarn install`
 * `yarn build`
+
 ### Testing
 * `yarn test`
+
 ### Linting
 * `yarn lint:fix`
+
 ### Links
 Bundles the output of [CodeGen](https://git.rwth-aachen.de/coscine/backend/scripts/codegen).
 
@@ -24,7 +27,7 @@ Use the `generateConnectors.sh` script when in a Coscine environment.
 
 ## 👥 Contributing
 
-As an open source plattform and project, we welcome contributions from our community in any form. You can do so by submitting bug reports or feature requests, or by directly contributing to Coscine's source code. To submit your contribution please follow our [Contributing Guideline](https://git.rwth-aachen.de/coscine/docs/public/wiki/-/blob/master/Contributing%20To%20Coscine.md).
+As an open source platform and project, we welcome contributions from our community in any form. You can do so by submitting bug reports or feature requests, or by directly contributing to Coscine's source code. To submit your contribution please follow our [Contributing Guideline](https://git.rwth-aachen.de/coscine/docs/public/wiki/-/blob/master/Contributing%20To%20Coscine.md).
 
 ## 📄 License