adapted sdk generation to unix environment

[nitrosx]

Description

This PR introduces bash script to generate locally the SDK on linux/unix environments.

Motivation

The javascript script to generate locally the SDK was failing due to permission issues as the docker container generate the sdk as the root user, while the script is mostly run as non privileged user

Fixes:

Please provide a list of the fixes implemented in this PR

• scripts/generate-nestjs-sdk.js

Changes:

Please provide a list of the changes implemented by this PR

• scripts/generate-nestjs-sdk.bash

Tests included

• Included for each change/fix?
• Passing? (Merge will not be approved unless this is checked)

Documentation

• swagger documentation updated [required]
• official documentation updated [nice-to-have]

Summary by Sourcery

Adapt SDK generation process to support Unix environments by adding a bash script and updating the existing JavaScript script to handle OS-specific execution.

New Features:

• Introduce a bash script for generating the SDK on Linux/Unix environments.

Enhancements:

• Modify the existing JavaScript SDK generation script to detect the operating system and guide users to use the appropriate script.

[sourcery-ai]

Hey @nitrosx - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider using Docker volume user mapping (--user flag) instead of requiring sudo privileges. This would be a more secure approach than running the entire script with root permissions.
• Please update the test status in the PR description to indicate whether the changes have been tested on Unix environments.

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟡 Complexity: 1 issue found
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[sourcery-ai]

issue: Add error handling for Docker operations

Add checks to verify Docker is running and host.docker.internal is accessible before attempting operations. Handle potential errors explicitly.

[sourcery-ai]

issue (complexity): Consider using direct binary path variables instead of creating symlinks in system directories

The current approach of creating/removing symlinks in /usr/local/bin adds unnecessary complexity and risk. Instead, detect and use the correct binary paths directly:

# At the start of the script
if ! command -v npm >/dev/null 2>&1; then
    if [[ -n "${NVM_BIN}" ]]; then
        NPM_CMD="${NVM_BIN}/npm"
        NODE_CMD="${NVM_BIN}/node"
        if [[ ! -x "$NPM_CMD" ]] || [[ ! -x "$NODE_CMD" ]]; then
            echo "Required binaries not found or not executable in NVM_BIN" >&2
            exit 1
        fi
    else
        echo "No npm found and NVM_BIN not set" >&2
        exit 1
    fi
else
    NPM_CMD="npm"
    NODE_CMD="node"
fi

# Then use these variables instead of global npm/node commands
"$NPM_CMD" install
"$NPM_CMD" run build

This approach:

• Removes the need for symlink creation/cleanup
• Fails fast if requirements aren't met
• Uses full paths directly when needed
• Maintains the same functionality more safely

[martin-trajanovski]

@nitrosx I am thinking instead of asking people to run the command, can't we just run the command from here directly. Something like:
execSync( "sudo -E ./scripts/generate-nestjs-sdk.bash", { encoding: "utf-8" }, );

[nitrosx]

Unfortunately it does not work in the current form of the bash script.
It does not pass the correct user and environment in the shell.
If we can find a way to do it from the javascript script, I fine with it