@plone/volto 18.0.0-alpha.2 → 18.0.0-alpha.4

package/packages/scripts/changelogupdater.cjs

@@ -1,94 +0,0 @@
-#!/usr/bin/env node
-/* eslint no-console: 0 */
-const fs = require('fs');
-const semver = require('semver');
-
-if (process.argv.length < 3) {
-  console.log(
-    'Not enough arguments. You should supply one of: bump || excerpt || back',
-  );
-  return;
-}
-
-const command = process.argv[2];
-const version = process.argv[3];
-
-// Get the right location of the CHANGELOG.md file
-// Covers use case that the file is in the parent folder and the
-// frontend code in `frontend` folder (recommended structure)
-let changelogFile;
-if (fs.existsSync('CHANGELOG.md')) {
-  changelogFile = 'CHANGELOG.md';
-} else if (fs.existsSync('../CHANGELOG.md')) {
-  changelogFile = '../CHANGELOG.md';
-}
-
-try {
-  if (command === 'excerpt') {
-    const data = fs.readFileSync(changelogFile, 'utf8');
-    const allReleases = data.match(/##\s(.+)\s\((.+)\)/g);
-    // const re = new RegExp(escapeRegExp(allReleases[1]), 'g');
-    const index = data.indexOf(allReleases[1]);
-    let versionExcerpt = data.slice(0, index);
-    versionExcerpt = versionExcerpt.replace('# Change Log\n\n', '');
-    versionExcerpt = versionExcerpt.slice(
-      versionExcerpt.match('\n\n')['index'] + 2,
-    );
-    process.stdout.write(versionExcerpt);
-    return;
-  }
-
-  if (command === 'bump') {
-    const data = fs.readFileSync(changelogFile, 'utf8');
-    const [original, origVersion, orig] = data.match(/##\s(.+)\s\((.+)\)/);
-    if (orig !== 'unreleased') {
-      return console.log('Error, the CHANGELOG file is malformed.');
-    }
-    const currentDate = new Date();
-    const date = `${currentDate.getFullYear()}-${`0${
-      currentDate.getMonth() + 1
-    }`.slice(-2)}-${`0${currentDate.getDate()}`.slice(-2)}`;
-
-    if (version !== origVersion) {
-      console.log(`Updating to the given version ${version}`);
-    }
-    const newLine = original
-      .replace('unreleased', date)
-      .replace(origVersion, version);
-
-    const newChangelog = data.replace(original, newLine);
-
-    // Save data to disk if command is bump
-    fs.writeFile(changelogFile, newChangelog, (err) => {
-      // throws an error, you could also catch it here
-      if (err) throw err;
-
-      // success case, the file was saved
-      console.log('Updated version on CHANGELOG.md');
-    });
-  }
-
-  if (command === 'back') {
-    const data = fs.readFileSync(changelogFile, 'utf8');
-    const nextversion = semver.inc(process.argv[3], 'patch');
-    const backToDevelTemplate = `\n\n## ${nextversion} (unreleased)\n\n### Breaking\n\n### Feature\n\n### Bugfix\n\n### Internal`;
-
-    const insertIndex = data.indexOf('\n\n');
-    const back = `${data.slice(
-      0,
-      insertIndex,
-    )}${backToDevelTemplate}${data.slice(insertIndex)}`;
-    console.log(back);
-    fs.writeFile(changelogFile, back, (err) => {
-      // throws an error, you could also catch it here
-      if (err) throw err;
-
-      // success case, the file was saved
-      console.log('Back to development on CHANGELOG.md');
-    });
-  }
-
-  return;
-} catch (e) {
-  console.log('Error:', e.stack);
-}

package/packages/scripts/corepackagebump.js

@@ -1,20 +0,0 @@
-#!/usr/bin/env node
-/* eslint no-console: 0 */
-import fs from 'fs';
-
-if (process.argv.length < 3) {
-  console.log(process.argv.length);
-  process.exit(1);
-}
-
-const pkg = process.argv[2];
-const version = process.argv[3];
-
-const packageJSON = JSON.parse(fs.readFileSync(`${pkg}/package.json`, 'utf8'));
-
-packageJSON.version = version;
-
-fs.writeFileSync(
-  `${pkg}/package.json`,
-  `${JSON.stringify(packageJSON, null, 2)}`,
-);

package/packages/scripts/i18n.cjs

@@ -1,310 +0,0 @@
-#!/usr/bin/env node
-/* eslint no-console: 0 */
-/**
- * i18n script.
- * @module scripts/i18n
- */
-
-const { find, keys, map, concat, reduce } = require('lodash');
-const glob = require('glob').sync;
-const fs = require('fs');
-const Pofile = require('pofile');
-const babel = require('@babel/core');
-
-const path = require('path');
-const projectRootPath = path.resolve('.');
-const packageJson = require(path.join(projectRootPath, 'package.json'));
-
-const { program } = require('commander');
-const chalk = require('chalk');
-
-/**
- * Extract messages into separate JSON files
- * @function extractMessages
- * @return {undefined}
- */
-function extractMessages() {
-  map(
-    // We ignore the existing customized shadowed components ones, since most
-    // probably we won't be overriding them
-    // If so, we should do it in the config object or somewhere else
-    // We also ignore the addons folder since they are populated using
-    // their own locales files and taken care separatedly in this script
-    glob('src/**/*.js?(x)', {
-      ignore: ['src/customizations/**', 'src/addons/**'],
-    }),
-    (filename) => {
-      babel.transformFileSync(filename, {}, (err) => {
-        if (err) {
-          console.log(err);
-        }
-      });
-    },
-  );
-}
-
-/**
- * Get messages from separate JSON files
- * @function getMessages
- * @return {Object} Object with messages
- */
-function getMessages() {
-  return reduce(
-    concat(
-      {},
-      ...map(
-        // We ignore the existing customized shadowed components ones, since most
-        // probably we won't be overriding them
-        // If so, we should do it in the config object or somewhere else
-        // We also ignore the addons folder since they are populated using
-        // their own locales files and taken care separatedly in this script
-        glob('build/messages/src/**/*.json', {
-          ignore: [
-            'build/messages/src/customizations/**',
-            'build/messages/src/addons/**',
-          ],
-        }),
-        (filename) =>
-          map(JSON.parse(fs.readFileSync(filename, 'utf8')), (message) => ({
-            ...message,
-            filename: filename.match(/build\/messages\/src\/(.*).json$/)[1],
-          })),
-      ),
-    ),
-    (current, value) => {
-      let result = current;
-      if (current.id) {
-        result = {
-          [current.id]: {
-            defaultMessage: current.defaultMessage,
-            filenames: [current.filename],
-          },
-        };
-      }
-
-      if (result[value.id]) {
-        result[value.id].filenames.push(value.filename);
-      } else {
-        result[value.id] = {
-          defaultMessage: value.defaultMessage,
-          filenames: [value.filename],
-        };
-      }
-      return result;
-    },
-  );
-}
-
-/**
- * Convert messages to pot format
- * @function messagesToPot
- * @param {Object} messages Messages
- * @return {string} Formatted pot string
- */
-function messagesToPot(messages) {
-  return map(keys(messages).sort(), (key) =>
-    [
-      ...map(messages[key].filenames, (filename) => `#: ${filename}`),
-      `# defaultMessage: ${messages[key].defaultMessage}`,
-      `msgid "${key}"`,
-      'msgstr ""',
-    ].join('\n'),
-  ).join('\n\n');
-}
-
-/**
- * Pot header
- * @function potHeader
- * @return {string} Formatted pot header
- */
-function potHeader() {
-  return `msgid ""
-msgstr ""
-"Project-Id-Version: Plone\\n"
-"POT-Creation-Date: ${new Date().toISOString()}\\n"
-"Last-Translator: Plone i18n <plone-i18n@lists.sourceforge.net>\\n"
-"Language-Team: Plone i18n <plone-i18n@lists.sourceforge.net>\\n"
-"MIME-Version: 1.0\\n"
-"Content-Type: text/plain; charset=utf-8\\n"
-"Content-Transfer-Encoding: 8bit\\n"
-"Plural-Forms: nplurals=1; plural=0;\\n"
-"Language-Code: en\\n"
-"Language-Name: English\\n"
-"Preferred-Encodings: utf-8\\n"
-"Domain: volto\\n"
-
-`;
-}
-
-/**
- * Convert po files into json
- * @function poToJson
- * @return {undefined}
- */
-function poToJson({ registry, addonMode }) {
-  const mergeMessages = (result, items, language) => {
-    items.forEach((item) => {
-      if (item.msgid in result) {
-        if (item.msgstr[0] !== '') {
-          result[item.msgid] = item.msgstr[0];
-        }
-      } else {
-        result[item.msgid] =
-          language === 'en'
-            ? item.msgstr[0] ||
-              (item.comments[0]
-                ? item.comments[0].replace('defaultMessage: ', '')
-                : '')
-            : item.msgstr[0];
-      }
-    });
-
-    return result;
-  };
-
-  map(glob('locales/**/*.po'), (filename) => {
-    let { items } = Pofile.parse(fs.readFileSync(filename, 'utf8'));
-    const projectLocalesItems = Pofile.parse(fs.readFileSync(filename, 'utf8'))
-      .items;
-    const lang = filename.match(/locales\/(.*)\/LC_MESSAGES\//)[1];
-    const result = {};
-
-    // Merge volto core locales
-    const lib = `node_modules/@plone/volto/${filename}`;
-    if (fs.existsSync(lib)) {
-      const libItems = Pofile.parse(fs.readFileSync(lib, 'utf8')).items;
-      items = [...libItems, ...items];
-      mergeMessages(result, items, lang);
-    }
-
-    if (!addonMode) {
-      // Merge addons locales
-      if (packageJson.addons) {
-        registry.getAddonDependencies().forEach((addon) => {
-          const addonlocale = `${registry.packages[addon].modulePath}/../${filename}`;
-          if (fs.existsSync(addonlocale)) {
-            const addonItems = Pofile.parse(
-              fs.readFileSync(addonlocale, 'utf8'),
-            ).items;
-
-            mergeMessages(result, addonItems, lang);
-            if (require.main === module) {
-              // We only log it if called as script
-              console.log(`Merging ${addon} locales for ${lang}`);
-            }
-          }
-        });
-      }
-    }
-    // Merge project locales, the project customization wins
-    mergeMessages(result, projectLocalesItems, lang);
-    fs.writeFileSync(`locales/${lang}.json`, JSON.stringify(result));
-  });
-}
-
-/**
- * Format header
- * @function formatHeader
- * @param {Array} comments Array of comments
- * @param {Object} headers Object of header items
- * @return {string} Formatted header
- */
-function formatHeader(comments, headers) {
-  return [
-    ...map(comments, (comment) => `# ${comment}`),
-    'msgid ""',
-    'msgstr ""',
-    ...map(keys(headers), (key) => `"${key}: ${headers[key]}\\n"`),
-    '',
-  ].join('\n');
-}
-
-/**
- * Sync po by the pot file
- * @function syncPoByPot
- * @return {undefined}
- */
-function syncPoByPot() {
-  const pot = Pofile.parse(fs.readFileSync('locales/volto.pot', 'utf8'));
-
-  map(glob('locales/**/*.po'), (filename) => {
-    const po = Pofile.parse(fs.readFileSync(filename, 'utf8'));
-
-    fs.writeFileSync(
-      filename,
-      `${formatHeader(po.comments, po.headers)}
-${map(pot.items, (item) => {
-  const poItem = find(po.items, { msgid: item.msgid });
-  return [
-    `${map(item.references, (ref) => `#: ${ref}`).join('\n')}`,
-    `# ${item.comments[0]}`,
-    `msgid "${item.msgid}"`,
-    `msgstr "${poItem ? poItem.msgstr : ''}"`,
-  ].join('\n');
-}).join('\n\n')}\n`,
-    );
-  });
-}
-
-function main({ addonMode }) {
-  console.log('Extracting messages from source files...');
-  extractMessages();
-  console.log('Synchronizing messages to pot file...');
-  // We only write the pot file if it's really different
-  const newPot = `${potHeader()}${messagesToPot(getMessages())}\n`.replace(
-    /"POT-Creation-Date:(.*)\\n"/,
-    '',
-  );
-  const oldPot = fs
-    .readFileSync('locales/volto.pot', 'utf8')
-    .replace(/"POT-Creation-Date:(.*)\\n"/, '');
-
-  if (newPot !== oldPot) {
-    fs.writeFileSync(
-      'locales/volto.pot',
-      `${potHeader()}${messagesToPot(getMessages())}\n`,
-    );
-  }
-  console.log('Synchronizing messages to po files...');
-  syncPoByPot();
-  if (!addonMode) {
-    // Detect if I'm in a project or in Volto itself
-    let AddonConfigurationRegistry;
-    try {
-      if (fs.existsSync(`${projectRootPath}/node_modules/@plone/volto`)) {
-        // We are in a project
-        AddonConfigurationRegistry = require(path.join(
-          projectRootPath,
-          '/node_modules/@plone/volto/packages/registry/addon-registry',
-        ));
-      } else {
-        // We are in Volto itself
-        AddonConfigurationRegistry = require(path.join(
-          projectRootPath,
-          '/packages/registry/addon-registry',
-        ));
-      }
-    } catch {
-      console.log(
-        chalk.red(
-          'Getting the addon registry failed. Are you executing i18n from inside an addon? Try the -a flag.',
-        ),
-      );
-      process.exit();
-    }
-    console.log('Generating the language JSON files...');
-    const registry = new AddonConfigurationRegistry(projectRootPath);
-    poToJson({ registry, addonMode });
-  }
-  console.log('done!');
-}
-
-// This is the equivalent of `if __name__ == '__main__'` in Python :)
-if (require.main === module) {
-  program.option('-a, --addon', 'run i18n script for addons');
-  program.parse(process.argv);
-  const options = program.opts();
-  main({ addonMode: options.addon });
-}
-
-module.exports = { poToJson };

package/packages/scripts/package.json

@@ -1,76 +0,0 @@
-{
-  "name": "@plone/scripts",
-  "description": "Volto Core scripts package - Contains scripts and dependencies for these scripts for tooling when developing Plone 6 / Volto",
-  "maintainers": [
-    {
-      "name": "Plone Foundation",
-      "email": "plone-developers@lists.sourceforge.net",
-      "url": "http://plone.org"
-    }
-  ],
-  "license": "MIT",
-  "version": "3.0.1",
-  "repository": {
-    "type": "git",
-    "url": "git@github.com:plone/volto.git"
-  },
-  "bugs": {
-    "url": "https://github.com/plone/volto/issues",
-    "email": "plone-developers@lists.sourceforge.net"
-  },
-  "type": "module",
-  "homepage": "https://plone.org",
-  "keywords": [
-    "volto",
-    "plone",
-    "plone6",
-    "react",
-    "cms"
-  ],
-  "scripts": {
-    "dry-release": "release-it --dry-run",
-    "release": "release-it",
-    "release-major-alpha": "release-it major --preRelease=alpha",
-    "release-alpha": "release-it --preRelease=alpha"
-  },
-  "bin": {
-    "addon": "./addon/index.js",
-    "changelogupdater": "./changelogupdater.cjs",
-    "i18n": "./i18n.cjs"
-  },
-  "release-it": {
-    "hooks": {
-      "after:bump": "pipx run towncrier build --draft --yes --version ${version} > .changelog.draft && pipx run towncrier build --yes --version ${version}",
-      "after:release": "rm .changelog.draft"
-    },
-    "git": {
-      "changelog": "pipx run towncrier build --draft --yes --version 0.0.0",
-      "requireUpstream": false,
-      "requireCleanWorkingDir": false,
-      "commitMessage": "Release @plone/scripts ${version}",
-      "tagName": "plone-scripts-${version}",
-      "tagAnnotation": "Release @plone/scripts ${version}"
-    },
-    "github": {
-      "release": true,
-      "releaseName": "@plone/scripts ${version}",
-      "releaseNotes": "cat .changelog.draft"
-    }
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "dependencies": {
-    "babel-plugin-react-intl": "5.1.17",
-    "babel-preset-razzle": "4.2.17",
-    "chalk": "4",
-    "commander": "8.2.0",
-    "fs-extra": "10.1.0",
-    "git-url-parse": "^13.1.0",
-    "mrs-developer": "*",
-    "pofile": "1.0.10"
-  },
-  "devDependencies": {
-    "release-it": "^16.1.3"
-  }
-}

package/packages/scripts/templates/towncrier_template.jinja

@@ -1,10 +0,0 @@
-{% if sections[""] %}
-{% for category, val in definitions.items() if category in sections[""] %}
-### {{ definitions[category]['name'] }}
-
-{% for text, values in sections[""][category].items() %}
-- {{ text }} {{ values|join(', ') }}
-{% endfor %}
-
-{% endfor %}
-{% endif %}

package/packages/types/Blocks/View.ts

@@ -1,11 +0,0 @@
-import { GetContentResponse } from '../content/get';
-import { BlocksConfig } from '../config/Blocks';
-
-export interface BlockViewProps {
-  id: string;
-  metadata?: GetContentResponse;
-  properties: GetContentResponse;
-  data: any;
-  path: string;
-  blocksConfig: BlocksConfig;
-}

package/packages/types/actions.ts

@@ -1,15 +0,0 @@
-interface Object {
-  icon: string;
-  id: string;
-  title: string;
-  url: string;
-}
-
-export interface ActionsResponse {
-  document_actions: Object[];
-  object: Object[];
-  object_buttons: Object[];
-  portal_tabs: Object[];
-  site_actions: Object[];
-  user: Object[];
-}

package/packages/types/breadcrumbs.ts

@@ -1,10 +0,0 @@
-interface Item {
-  '@id': string;
-  title: string;
-}
-
-export interface BreadcrumbsResponse {
-  '@id': string;
-  items: Item[];
-  root: string;
-}

package/packages/types/config/Blocks.ts

@@ -1,153 +0,0 @@
-import { GetContentResponse } from '../content/get';
-import type { BlockViewProps } from '@plone/types/Blocks/View';
-
-export interface BlocksConfig {
-  [key: string]: BlockConfigBase | undefined;
-  title?: BlockConfigBase;
-  description?: BlockConfigBase;
-  slate?: SlateBlock;
-}
-
-interface BlockConfigBase {
-  /**
-   * The programmatic id of the block
-   */
-  id: string;
-  /**
-   * // The display name of the block (translatable)
-   */
-  title: string;
-  /**
-   * The icon used in the block chooser
-   */
-  icon: string;
-  /**
-   * The group of the block
-   */
-  group: string;
-  /**
-   * The view mode component
-   */
-  view: React.ComponentType<BlockViewProps>;
-  /**
-   * The edit mode component
-   */
-  edit: React.ComponentType;
-  /**
-   * The group (blocks can be grouped, displayed in the chooser)
-   */
-  schema?: object;
-  /**
-   * The group of the block
-   */
-  blockSchema?: (args: {
-    props: unknown;
-    intl: unknown;
-  }) => Record<string, unknown>;
-  /**
-   * If the block is restricted, it won't show in the chooser.
-   * The function signature is `({properties, block})` where `properties` is
-   * the current object data and `block` is the block being evaluated in `BlockChooser`.
-   */
-  restricted: (args: {
-    properties: GetContentResponse;
-    block: BlockConfigBase; // TODO: This has to be extendable
-  }) => boolean;
-  /**
-   * A meta group `most used`, appearing at the top of the chooser
-   */
-  mostUsed: false;
-  /**
-   * Set this to true if the block manages its own focus
-   */
-  blockHasOwnFocusManagement: true;
-  /**
-   * The sidebar tab you want to be selected when selecting the block
-   */
-  sidebarTab: 0;
-  /**
-   * A block can have an schema enhancer function with the signature: (schema) => schema
-   * It can be either be at block level (it's applied always), at a variation level
-   * or both. It's up to the developer to make them work nicely (not conflict) between them
-   */
-  schemaEnhancer: (args: {
-    schema: JSONSchema;
-    formData: BlockConfigBase; // Not sure, if so, has to be extendable
-    intl: unknown;
-  }) => JSONSchema;
-}
-
-interface SlateBlock extends BlockConfigBase {
-  /**
-   * Returns true if the provided block data represents a value for the current block.
-   * Required for alternate default block types implementations.
-   */
-  blockHasValue: (data: BlockConfigBase) => boolean;
-  /**
-   *
-   */
-  tocEntry: (block: BlockConfigBase) => object;
-}
-
-export interface ContainerBlock extends BlockConfigBase {
-  /**
-   * A custom `EditBlockWrapper` component to use by the container
-   */
-  EditBlockWrapper: React.ComponentType;
-  /**
-   * A custom `TemplateChooser` component to use by the container
-   */
-  TemplateChooser: React.ComponentType;
-  /**
-   * The available templates for the TemplateChooser generator
-   */
-  templates: (type: string) => (intl: unknown) => TemplateDefaultBlocksData;
-  /**
-   * Maximum number of blocks in the container
-   */
-  maxLength: number;
-  /**
-   * List of the `id`s of the allowed blocks in the container
-   */
-  allowedBlocks: string[];
-}
-
-// interface ExtendedObject extends ArbitraryObject {
-//   baz: { someProp: string };
-// }
-
-// const myObject: ExtendedObject = {};
-
-// // Add properties one by one
-// myObject.foo = 'hello';
-// myObject.bar = 42;
-// myObject.baz = { someProp: 'someValue' };
-
-type JSONSchemaFieldsets = {
-  id: string;
-  title: string;
-  fields: string[];
-};
-
-type JSONSchema = {
-  title: string;
-  fieldsets: JSONSchemaFieldsets[];
-  properties: object;
-  required: string[];
-};
-
-type BlocksData = {
-  blocks: {
-    [key: string]: object;
-  };
-  blocks_layout: {
-    items: string[];
-  };
-};
-
-interface TemplateDefaultBlocksData {
-  image: string;
-  id: string;
-  title: string;
-  blocksData: BlocksData;
-}