[WC-3291] Signature 1.0.8 release preparation

packages/customWidgets/signature-web/CHANGELOG.md

@@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased]
 
+### Added
+
+- We added a license file and a readme documenting all open source dependencies used in this package.
+
 ## [1.0.7] - 2025-01-15
 
 ### Changed

packages/customWidgets/signature-web/dependencies.json

@@ -0,0 +1 @@
+[{ "classnames": { "version": "2.5.1", "url": null } }, { "signature_pad": { "version": "4.0.0", "url": null } }]

packages/customWidgets/signature-web/dependencies.txt

@@ -0,0 +1,67 @@
+Name: classnames
+Version: 2.5.1
+License: MIT
+Private: false
+Description: A simple utility for conditionally joining classNames together
+Repository: git+https://github.com/JedWatson/classnames.git
+Author: Jed Watson
+Homepage: https://github.com/JedWatson/classnames#readme
+License Copyright:
+===
+
+The MIT License (MIT)
+
+Copyright (c) 2018 Jed Watson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+Name: signature_pad
+Version: 4.0.0
+License: MIT
+Private: false
+Description: Library for drawing smooth signatures.
+Repository: git+https://github.com/szimek/signature_pad.git
+Author: Szymon Nowak <szimek@gmail.com> (https://github.com/szimek)
+Homepage: https://github.com/szimek/signature_pad
+License Copyright:
+===
+
+MIT License
+
+Copyright (c) 2018 Szymon Nowak
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/customWidgets/signature-web/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@mendix/signature-web",
     "widgetName": "Signature",
-    "version": "1.0.7",
+    "version": "1.0.8",
     "description": "A signature pad for capturing signatures",
     "copyright": "© Mendix Technology BV 2025. All rights reserved.",
     "license": "Apache-2.0",
@@ -37,8 +37,7 @@
     },
     "dependencies": {
         "classnames": "^2.5.1",
-        "react-resize-detector": "^9.1.1",
-        "signature_pad": "4.0.0"
+        "signature_pad": "5.1.3"
     },
     "devDependencies": {
         "@mendix/automation-utils": "workspace:*",

packages/customWidgets/signature-web/scripts/generate-dependencies.js

@@ -0,0 +1,268 @@
+#!/usr/bin/env node
+
+const { execSync } = require("child_process");
+const fs = require("fs");
+const path = require("path");
+
+/**
+ * Generate dependencies.json and dependencies.txt from package.json using pnpm to get actual installed versions
+ *
+ * Usage: node generate-dependencies.js [path-to-package.json]
+ */
+
+function getPackageJsonPath() {
+    const arg = process.argv[2];
+    if (arg) {
+        return path.resolve(arg);
+    }
+    // Default to package.json in current directory
+    return path.resolve(process.cwd(), "package.json");
+}
+
+function readPackageJson(packageJsonPath) {
+    if (!fs.existsSync(packageJsonPath)) {
+        console.error(`Error: package.json not found at ${packageJsonPath}`);
+        process.exit(1);
+    }
+
+    try {
+        const content = fs.readFileSync(packageJsonPath, "utf8");
+        return JSON.parse(content);
+    } catch (error) {
+        console.error(`Error reading or parsing package.json: ${error.message}`);
+        process.exit(1);
+    }
+}
+
+function getInstalledVersion(packageName, packageDir) {
+    try {
+        // Use pnpm list to get the actual installed version
+        // --depth 0 to only show direct dependencies
+        // --json for parseable output
+        const output = execSync(`pnpm list "${packageName}" --depth 0 --json`, {
+            cwd: packageDir,
+            encoding: "utf8",
+            stdio: ["pipe", "pipe", "pipe"]
+        });
+
+        const result = JSON.parse(output);
+
+        // pnpm list returns an array of project results
+        if (Array.isArray(result) && result.length > 0) {
+            const dependencies = result[0].dependencies || {};
+            if (dependencies[packageName]) {
+                const version = dependencies[packageName].version;
+                // Remove any leading 'v' if present
+                return version.replace(/^v/, "");
+            }
+        }
+
+        return null;
+    } catch (error) {
+        // If pnpm list fails, try reading from node_modules
+        try {
+            const nodeModulesPath = path.join(packageDir, "node_modules", packageName, "package.json");
+            if (fs.existsSync(nodeModulesPath)) {
+                const pkgContent = JSON.parse(fs.readFileSync(nodeModulesPath, "utf8"));
+                return pkgContent.version;
+            }
+        } catch (innerError) {
+            // Ignore
+        }
+
+        console.warn(`Warning: Could not determine installed version for ${packageName}`);
+        return null;
+    }
+}
+
+function getPackageMetadata(packageName, version) {
+    try {
+        // Use pnpm view to get package metadata from npm registry
+        const output = execSync(`pnpm view "${packageName}@${version}" --json`, {
+            encoding: "utf8",
+            stdio: ["pipe", "pipe", "pipe"]
+        });
+
+        const metadata = JSON.parse(output);
+
+        return {
+            name: metadata.name || packageName,
+            version: metadata.version || version,
+            license: metadata.license || "UNKNOWN",
+            private: metadata.private || false,
+            description: metadata.description || "",
+            repository: formatRepository(metadata.repository),
+            author: metadata.author || "",
+            homepage: metadata.homepage || ""
+        };
+    } catch (error) {
+        console.warn(`Warning: Could not fetch metadata for ${packageName}@${version}`);
+        return {
+            name: packageName,
+            version: version,
+            license: "UNKNOWN",
+            private: false,
+            description: "",
+            repository: "",
+            author: "",
+            homepage: ""
+        };
+    }
+}
+
+function formatRepository(repo) {
+    if (!repo) return "undefined";
+    if (typeof repo === "string") return repo;
+    if (repo.url) return repo.url;
+    return "undefined";
+}
+
+function getLicenseText(packageName, version, packageDir) {
+    // Try to find LICENSE file in node_modules
+    const possiblePaths = [
+        path.join(packageDir, "node_modules", packageName, "LICENSE"),
+        path.join(packageDir, "node_modules", packageName, "LICENSE.md"),
+        path.join(packageDir, "node_modules", packageName, "LICENSE.txt"),
+        path.join(packageDir, "node_modules", packageName, "license"),
+        path.join(packageDir, "node_modules", packageName, "license.md"),
+        path.join(packageDir, "node_modules", packageName, "license.txt")
+    ];
+
+    for (const licensePath of possiblePaths) {
+        if (fs.existsSync(licensePath)) {
+            try {
+                return fs.readFileSync(licensePath, "utf8").trim();
+            } catch (error) {
+                // Continue to next path
+            }
+        }
+    }
+
+    // If not found in node_modules, try pnpm's virtual store
+    const pnpmStorePath = path.join(
+        packageDir,
+        "..",
+        "..",
+        "node_modules",
+        ".pnpm",
+        `${packageName}@${version}`,
+        "node_modules",
+        packageName
+    );
+
+    for (const filename of ["LICENSE", "LICENSE.md", "LICENSE.txt", "license", "license.md", "license.txt"]) {
+        const licensePath = path.join(pnpmStorePath, filename);
+        if (fs.existsSync(licensePath)) {
+            try {
+                return fs.readFileSync(licensePath, "utf8").trim();
+            } catch (error) {
+                // Continue
+            }
+        }
+    }
+
+    return null;
+}
+
+function generateDependenciesJson(packageJsonPath) {
+    const packageJson = readPackageJson(packageJsonPath);
+    const packageDir = path.dirname(packageJsonPath);
+
+    const dependencies = packageJson.dependencies || {};
+    const dependencyNames = Object.keys(dependencies);
+
+    if (dependencyNames.length === 0) {
+        console.log("No dependencies found in package.json");
+        return { jsonData: [], detailedData: [] };
+    }
+
+    console.log(`Found ${dependencyNames.length} dependencies, resolving versions...`);
+
+    const jsonData = [];
+    const detailedData = [];
+
+    for (const depName of dependencyNames) {
+        const version = getInstalledVersion(depName, packageDir);
+
+        if (version) {
+            // Add to JSON format
+            jsonData.push({
+                [depName]: {
+                    version: version,
+                    url: null
+                }
+            });
+
+            // Fetch metadata for TXT format
+            const metadata = getPackageMetadata(depName, version);
+            const licenseText = getLicenseText(depName, version, packageDir);
+
+            detailedData.push({
+                ...metadata,
+                licenseText
+            });
+
+            console.log(`  ✓ ${depName}@${version}`);
+        } else {
+            console.warn(`  ✗ ${depName} - version not found`);
+        }
+    }
+
+    return { jsonData, detailedData };
+}
+
+function generateDependenciesTxt(detailedData) {
+    const sections = [];
+
+    for (const dep of detailedData) {
+        const lines = [];
+
+        lines.push(`Name: ${dep.name}`);
+        lines.push(`Version: ${dep.version}`);
+        lines.push(`License: ${dep.license}`);
+        lines.push(`Private: ${dep.private}`);
+        lines.push(`Description: ${dep.description}`);
+        lines.push(`Repository: ${dep.repository}`);
+
+        if (dep.author) {
+            lines.push(`Author: ${dep.author}`);
+        }
+
+        if (dep.homepage) {
+            lines.push(`Homepage: ${dep.homepage}`);
+        }
+
+        if (dep.licenseText) {
+            lines.push("License Copyright:");
+            lines.push("===");
+            lines.push("");
+            lines.push(dep.licenseText);
+        }
+
+        sections.push(lines.join("\n"));
+    }
+
+    return sections.join("\n\n---\n\n");
+}
+
+function main() {
+    const packageJsonPath = getPackageJsonPath();
+    const jsonOutputPath = path.join(process.cwd(), "dependencies.json");
+    const txtOutputPath = path.join(process.cwd(), "dependencies.txt");
+
+    console.log(`Reading package.json from: ${packageJsonPath}`);
+
+    const { jsonData, detailedData } = generateDependenciesJson(packageJsonPath);
+
+    // Write dependencies.json
+    fs.writeFileSync(jsonOutputPath, JSON.stringify(jsonData));
+    console.log(`\n✓ Generated dependencies.json at: ${jsonOutputPath}`);
+    console.log(`  Total dependencies: ${jsonData.length}`);
+
+    // Write dependencies.txt
+    const txtContent = generateDependenciesTxt(detailedData);
+    fs.writeFileSync(txtOutputPath, txtContent + "\n");
+    console.log(`✓ Generated dependencies.txt at: ${txtOutputPath}`);
+}
+
+main();