Improve and fix volto-update-deps (#5889)

packages/generator-volto/generators/app/index.js

@@ -153,13 +153,16 @@ Run "npm install -g @plone/generator-volto" to update.`,
 
     // dependencies
     let VoltoPackageJSON;
+    let PloneTypesVersion;
     if (voltoVersion === '*') {
       VoltoPackageJSON = JSON.parse(
         fs.readFileSync(`packages/volto/package.json`, 'utf8'),
       );
       voltoVersion = VoltoPackageJSON.version;
+      PloneTypesVersion = await utils.getPloneTypesVersion('main');
     } else {
       VoltoPackageJSON = await utils.getVoltoPackageJSON(voltoVersion);
+      PloneTypesVersion = await utils.getPloneTypesVersion(voltoVersion);
     }
 
     const VoltoDependencies = VoltoPackageJSON.dependencies;
@@ -180,7 +183,7 @@ Run "npm install -g @plone/generator-volto" to update.`,
     const devDependencies = {
       // TODO: find a better way to specify the version of the core devDependencies
       // Since they grab "workspace: *" from the volto package.json
-      '@plone/types': '^1.0.0-alpha.7',
+      '@plone/types': PloneTypesVersion,
       ...Object.fromEntries(
         Object.entries(VoltoDevDependencies).filter(
           ([key]) => !key.startsWith('@plone'),

packages/generator-volto/generators/app/utils.js

@@ -108,6 +108,26 @@ async function getVoltoPackageJSON(tag) {
   return JSON.parse(requestContent);
 }
 
+async function getPloneTypesVersion(tag) {
+  const url = `https://raw.githubusercontent.com/plone/volto/${tag}/packages/types/package.json`;
+  const requestContent = await new Promise((resolve, reject) => {
+    https
+      .get(url, {}, (resp) => {
+        let data = '';
+        resp.on('data', (chunk) => {
+          data += chunk;
+        });
+        resp.on('end', () => {
+          resolve(data);
+        });
+      })
+      .on('error', (err) => {
+        reject(err);
+      });
+  });
+  return JSON.parse(requestContent).version;
+}
+
 function orderedDependencies(dependencies) {
   return Object.keys(dependencies)
     .sort()
@@ -122,5 +142,6 @@ module.exports = {
   getLatestCanaryVoltoVersion,
   getVoltoYarnLock,
   getVoltoPackageJSON,
+  getPloneTypesVersion,
   orderedDependencies,
 };

packages/generator-volto/news/5889.bugfix

@@ -0,0 +1 @@
+Improve the generator by getting the `@plone/types` version from GH @sneridagh

packages/scripts/news/5889.bugfix

@@ -0,0 +1 @@
+Fix volto-update-deps script, remove `@plone` packages from the sync @sneridagh

packages/scripts/volto-update-deps.js

@@ -27,6 +27,26 @@ async function getVoltoPackageJSON(tag) {
   return JSON.parse(requestContent);
 }
 
+async function getPloneTypesVersion(tag) {
+  const url = `https://raw.githubusercontent.com/plone/volto/${tag}/packages/types/package.json`;
+  const requestContent = await new Promise((resolve, reject) => {
+    https
+      .get(url, {}, (resp) => {
+        let data = '';
+        resp.on('data', (chunk) => {
+          data += chunk;
+        });
+        resp.on('end', () => {
+          resolve(data);
+        });
+      })
+      .on('error', (err) => {
+        reject(err);
+      });
+  });
+  return JSON.parse(requestContent).version;
+}
+
 function orderedDependencies(dependencies) {
   return Object.keys(dependencies)
     .sort()
@@ -55,32 +75,42 @@ async function main() {
   const packageJSON = loadPackageJSON(path);
   const currentVoltoVersion = packageJSON.dependencies['@plone/volto'];
   let voltoPackageJSON;
+  let ploneTypesVersion;
   if (currentVoltoVersion === 'workspace:*') {
     voltoPackageJSON = loadPackageJSON('packages/volto');
+    ploneTypesVersion = await getPloneTypesVersion('main');
   } else {
     voltoPackageJSON = await getVoltoPackageJSON(currentVoltoVersion);
+    ploneTypesVersion = await getPloneTypesVersion(currentVoltoVersion);
   }
 
   const VoltoDependencies = voltoPackageJSON.dependencies;
   const VoltoDevDependencies = voltoPackageJSON.devDependencies;
 
+  // Manually add devDependency on @plone/types
+  packageJSON.devDependencies['@plone/types'] = ploneTypesVersion;
+
   Object.entries(VoltoDevDependencies).forEach(([pkg, version]) => {
-    if (packageJSON.devDependencies[pkg]) {
-      packageJSON.devDependencies[pkg] = version;
-      console.log(`Updated devDependency on ${pkg} to version ${version}`);
-    } else {
-      packageJSON.devDependencies[pkg] = version;
-      console.log(`Added devDependency on ${pkg} to version ${version}`);
+    if (!pkg.startsWith('@plone')) {
+      if (packageJSON.devDependencies[pkg]) {
+        packageJSON.devDependencies[pkg] = version;
+        console.log(`Updated devDependency on ${pkg} to version ${version}`);
+      } else {
+        packageJSON.devDependencies[pkg] = version;
+        console.log(`Added devDependency on ${pkg} to version ${version}`);
+      }
     }
   });
 
   Object.entries(VoltoDependencies).forEach(([pkg, version]) => {
-    if (packageJSON.dependencies[pkg]) {
-      packageJSON.dependencies[pkg] = version;
-      console.log(`Updated dependency on ${pkg} to version ${version}`);
-    } else {
-      packageJSON.dependencies[pkg] = version;
-      console.log(`Added dependency on ${pkg} to version ${version}`);
+    if (!pkg.startsWith('@plone')) {
+      if (packageJSON.dependencies[pkg]) {
+        packageJSON.dependencies[pkg] = version;
+        console.log(`Updated dependency on ${pkg} to version ${version}`);
+      } else {
+        packageJSON.dependencies[pkg] = version;
+        console.log(`Added dependency on ${pkg} to version ${version}`);
+      }
     }
   });
 

packages/volto/package.json

@@ -372,7 +372,7 @@
     "tmp": "0.2.1",
     "ts-jest": "^26.4.2",
     "ts-loader": "9.4.4",
-    "typescript": "5.2.2",
+    "typescript": "^5.4.2",
     "use-trace-update": "1.3.2",
     "wait-on": "6.0.0",
     "webpack": "5.76.1",