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

package/packages/registry/create-theme-addons-loader.js

@@ -1,78 +0,0 @@
-const fs = require('fs');
-const tmp = require('tmp');
-const cryptoRandomString = require('crypto-random-string');
-
-const titleCase = (w) => w.slice(0, 1).toUpperCase() + w.slice(1, w.length);
-
-/*
- * Transforms a package name to javascript variable name
- */
-function nameFromPackage(name) {
-  name =
-    name.replace(/[@~./\\:\s]/gi, '') ||
-    cryptoRandomString({ length: 10, characters: 'abcdefghijk' });
-  return name
-    .split('-')
-    .map((w, i) => (i > 0 ? titleCase(w) : w))
-    .join('');
-}
-
-/*
- * Creates a static file with code necessary to load the addons configuration
- *
- */
-function getAddonsLoaderCode(name, customThemeAddons = []) {
-  let buf = `/*
-This file is autogenerated. Don't change it directly.
-Add a ./theme/_${name}.scss in your add-on to load your theme customizations in the current theme.
-*/
-
-`;
-  customThemeAddons.forEach((addon) => {
-    const customization = `${addon}/theme/${name}`;
-    const line = `@import '${customization}';\n`;
-    buf += line;
-  });
-
-  return buf;
-}
-
-module.exports = ({ main, variables }) => {
-  // const addonsThemeLoaderVariablesPath = path.join(
-  //   process.cwd(),
-  //   'src',
-  //   '_variables.scss',
-  // );
-  // const addonsThemeLoaderMainPath = path.join(
-  //   process.cwd(),
-  //   'src',
-  //   '_main.scss',
-  // );
-
-  // const addonsThemeLoaderVariablesPath = path.join(
-  //   process.cwd(),
-  //   'src',
-  //   '_variables.scss',
-  // );
-  // const addonsThemeLoaderMainPath = path.join(
-  //   process.cwd(),
-  //   'src',
-  //   '_main.scss',
-  // );
-
-  const addonsThemeLoaderVariablesPath = tmp.tmpNameSync({ postfix: '.scss' });
-  const addonsThemeLoaderMainPath = tmp.tmpNameSync({ postfix: '.scss' });
-  fs.writeFileSync(
-    addonsThemeLoaderVariablesPath,
-    new Buffer.from(getAddonsLoaderCode('variables', variables)),
-  );
-  fs.writeFileSync(
-    addonsThemeLoaderMainPath,
-    new Buffer.from(getAddonsLoaderCode('main', main)),
-  );
-
-  return [addonsThemeLoaderVariablesPath, addonsThemeLoaderMainPath];
-};
-
-module.exports.getAddonsLoaderCode = getAddonsLoaderCode;
-module.exports.nameFromPackage = nameFromPackage;

package/packages/registry/package.json

@@ -1,76 +0,0 @@
-{
-  "name": "@plone/registry",
-  "description": "Add-on and configuration registry for Plone and for JavaScript and TypeScript-based apps.",
-  "maintainers": [
-    {
-      "name": "Plone Foundation",
-      "url": "https://plone.org"
-    }
-  ],
-  "funding": "https://github.com/sponsors/plone",
-  "license": "MIT",
-  "version": "1.0.0",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/plone/volto.git"
-  },
-  "bugs": {
-    "url": "https://github.com/plone/volto/issues"
-  },
-  "homepage": "https://plone.org",
-  "keywords": [
-    "volto",
-    "plone",
-    "plone6",
-    "react",
-    "add-ons",
-    "registry",
-    "configuration",
-    "config"
-  ],
-  "publishConfig": {
-    "access": "public"
-  },
-  "source": "src/index.ts",
-  "main": "dist/main.js",
-  "module": "dist/module.js",
-  "types": "dist/types.d.ts",
-  "targets": {
-    "main": {
-      "includeNodeModules": false
-    }
-  },
-  "scripts": {
-    "watch": "parcel watch",
-    "build": "parcel build",
-    "dry-release": "release-it --dry-run",
-    "release": "release-it",
-    "release-major-alpha": "release-it major --preRelease=alpha",
-    "release-alpha": "release-it --preRelease=alpha"
-  },
-  "peerDependencies": {
-    "react": "^16.8.0 || ^17.0.0 || ^18.0.0",
-    "react-dom": "^16.8.0 || ^17.0.0 || ^18.0.0"
-  },
-  "peerDependenciesMeta": {
-    "react-dom": {
-      "optional": true
-    }
-  },
-  "dependencies": {
-    "crypto-random-string": "3.2.0",
-    "debug": "4.3.2",
-    "dependency-graph": "0.10.0",
-    "glob": "7.1.6",
-    "lodash": "4.17.21"
-  },
-  "devDependencies": {
-    "@parcel/packager-ts": "2.10.2",
-    "@parcel/transformer-typescript-types": "2.10.2",
-    "@types/react": "^17.0.52",
-    "@types/react-dom": "^17",
-    "parcel": "2.10.2",
-    "release-it": "16.2.1",
-    "typescript": "5.2.2"
-  }
-}

package/packages/registry/src/index.ts

@@ -1,174 +0,0 @@
-import { isArray } from 'lodash';
-import * as configTypes from '@plone/types/config';
-
-type ConfigData = {
-  settings: configTypes.SettingsConfig;
-  blocks: configTypes.BlocksConfig;
-  views: configTypes.ViewsConfig;
-  widgets: configTypes.WidgetsConfig;
-  addonReducers: configTypes.AddonReducersConfig;
-  addonRoutes: configTypes.AddonRoutesConfig;
-  slots: configTypes.SlotsConfig;
-  components: configTypes.ComponentsConfig;
-  experimental: configTypes.ExperimentalConfig;
-};
-
-class Config {
-  public _data: ConfigData | Record<string, never>;
-  static instance: InstanceType<typeof Config>;
-
-  constructor() {
-    if (!Config.instance) {
-      this._data = {};
-      Config.instance = this;
-    }
-
-    return Config.instance;
-  }
-
-  set<RegistryKey extends keyof ConfigData>(
-    registry: RegistryKey,
-    item: ConfigData[RegistryKey],
-  ) {
-    this._data[registry] = item;
-  }
-
-  get(registry: keyof ConfigData) {
-    return this._data[registry];
-  }
-
-  get settings() {
-    return this._data.settings;
-  }
-
-  set settings(settings) {
-    this._data.settings = settings;
-  }
-
-  get experimental() {
-    return this._data.experimental;
-  }
-
-  set experimental(experimental) {
-    this._data.experimental = experimental;
-  }
-
-  get blocks() {
-    return this._data.blocks;
-  }
-
-  set blocks(blocks) {
-    this._data.blocks = blocks;
-  }
-
-  get views() {
-    return this._data.views;
-  }
-
-  set views(views) {
-    this._data.views = views;
-  }
-
-  get widgets() {
-    return this._data.widgets;
-  }
-
-  set widgets(widgets) {
-    this._data.widgets = widgets;
-  }
-
-  get addonReducers() {
-    return this._data.addonReducers;
-  }
-
-  set addonReducers(addonReducers) {
-    this._data.addonReducers = addonReducers;
-  }
-
-  get addonRoutes() {
-    return this._data.addonRoutes;
-  }
-
-  set addonRoutes(addonRoutes) {
-    this._data.addonRoutes = addonRoutes;
-  }
-
-  get slots() {
-    return this._data.slots;
-  }
-
-  set slots(slots) {
-    this._data.slots = slots;
-  }
-
-  get components() {
-    return this._data.components;
-  }
-
-  set components(components) {
-    this._data.components = components;
-  }
-
-  getComponent(
-    options: { name: string; dependencies: string[] | string } | string,
-  ) {
-    if (typeof options === 'object') {
-      const { name, dependencies = '' } = options;
-      let depsString: string = '';
-      if (dependencies && isArray(dependencies)) {
-        depsString = dependencies.join('+');
-      } else if (typeof dependencies === 'string') {
-        depsString = dependencies;
-      }
-      const componentName = `${name}${depsString ? `|${depsString}` : ''}`;
-
-      return this._data.components[componentName] || {};
-    } else {
-      // Shortcut notation, accepting a lonely string as argument
-      const componentName = options;
-      return this._data.components[componentName] || {};
-    }
-  }
-
-  registerComponent(options: {
-    name: string;
-    dependencies: string[] | string;
-    component: React.ComponentType;
-  }) {
-    const { name, component, dependencies = '' } = options;
-    let depsString: string = '';
-    if (!component) {
-      throw new Error('No component provided');
-    } else {
-      if (dependencies && isArray(dependencies)) {
-        depsString = dependencies.join('+');
-      } else if (typeof dependencies === 'string') {
-        depsString = dependencies;
-      }
-      const componentName = `${name}${depsString ? `|${depsString}` : ''}`;
-
-      this._data.components[componentName] = { component };
-      // Try to set a displayName (useful for React dev tools) for the registered component
-      // Only if it's a function and it's not set previously
-      try {
-        const displayName =
-          this._data.components[componentName].component.displayName;
-
-        if (
-          !displayName &&
-          typeof this._data.components[componentName].component === 'function'
-        ) {
-          this._data.components[componentName].component.displayName = name;
-        }
-      } catch (error) {
-        // eslint-disable-next-line no-console
-        console.warn(`Not setting the component displayName because ${error}`);
-      }
-    }
-  }
-}
-
-const instance = new Config();
-Object.freeze(instance);
-
-export default instance;

package/packages/registry/src/registry.test.js

@@ -1,111 +0,0 @@
-import config from './index';
-
-config.set('components', {
-  Toolbar: { component: 'this is the Toolbar component' },
-  'Toolbar.Types': { component: 'this is the Types component' },
-  'Teaser|News Item': { component: 'This is the News Item Teaser component' },
-});
-
-describe('registry', () => {
-  it('get components', () => {
-    expect(config.getComponent('Toolbar').component).toEqual(
-      'this is the Toolbar component',
-    );
-  });
-  it('get components with context', () => {
-    expect(
-      config.getComponent({ name: 'Teaser', dependencies: 'News Item' })
-        .component,
-    ).toEqual('This is the News Item Teaser component');
-  });
-  it('get components with dots (as an object)', () => {
-    expect(config.getComponent({ name: 'Toolbar.Types' }).component).toEqual(
-      'this is the Types component',
-    );
-  });
-  it('get components with | and spaces (as a string)', () => {
-    expect(config.getComponent('Teaser|News Item').component).toEqual(
-      'This is the News Item Teaser component',
-    );
-  });
-  it('resolves unexistent component (as a string)', () => {
-    expect(config.getComponent('Toolbar.Doh').component).toEqual(undefined);
-    expect(config.getComponent('Toolbar.Doh')).toEqual({});
-  });
-  it('registers and gets a component by name (as string)', () => {
-    config.registerComponent({
-      name: 'Toolbar.Bar',
-      component: 'this is a Bar component',
-    });
-    expect(config.getComponent('Toolbar.Bar').component).toEqual(
-      'this is a Bar component',
-    );
-  });
-  it('registers and gets a component by name (as an object)', () => {
-    config.registerComponent({
-      name: 'Toolbar.Bar',
-      component: 'this is a Bar component',
-    });
-    expect(config.getComponent({ name: 'Toolbar.Bar' }).component).toEqual(
-      'this is a Bar component',
-    );
-  });
-  it('registers and gets a component by name (as an object) - check displayName', () => {
-    config.registerComponent({
-      name: 'Toolbar.Bar',
-      component: (props) => <div>Hello</div>,
-    });
-    expect(config.getComponent('Toolbar.Bar').component.displayName).toEqual(
-      'Toolbar.Bar',
-    );
-  });
-  it('registers and gets a component by name (as an object) - check displayName if it has already one, it does not overwrite it', () => {
-    const TestComponent = (props) => <div>Hello</div>;
-    TestComponent.displayName = 'DisplayNameAlreadySet';
-    config.registerComponent({
-      name: 'Toolbar.Bar',
-      component: TestComponent,
-    });
-
-    expect(config.getComponent('Toolbar.Bar').component.displayName).toEqual(
-      'DisplayNameAlreadySet',
-    );
-  });
-  it('registers and gets a component by name (as an object) - check displayName - do not break if it is a normal function', () => {
-    function myFunction() {
-      return 'true';
-    }
-
-    config.registerComponent({
-      name: 'Toolbar.Bar',
-      component: myFunction,
-    });
-    expect(config.getComponent('Toolbar.Bar').component.displayName).toEqual(
-      'Toolbar.Bar',
-    );
-  });
-  it('registers a component by name with dependencies', () => {
-    config.registerComponent({
-      name: 'Toolbar.Bar',
-      component: 'this is a Bar component',
-      dependencies: 'News Item',
-    });
-    expect(
-      config.getComponent({ name: 'Toolbar.Bar', dependencies: 'News Item' })
-        .component,
-    ).toEqual('this is a Bar component');
-  });
-  it('registers a component by name with dependencies array', () => {
-    config.registerComponent({
-      name: 'Toolbar.Bar',
-      component: 'this is a Bar component',
-      dependencies: ['News Item', 'StringFieldWidget'],
-    });
-    expect(
-      config.getComponent({
-        name: 'Toolbar.Bar',
-        dependencies: ['News Item', 'StringFieldWidget'],
-      }).component,
-    ).toEqual('this is a Bar component');
-  });
-});

package/packages/registry/tsconfig.json

@@ -1,32 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ESNext",
-    "lib": ["DOM", "DOM.Iterable", "ESNext"],
-    "module": "commonjs",
-    "allowJs": true,
-    "skipLibCheck": true,
-    "esModuleInterop": true,
-    "allowSyntheticDefaultImports": true,
-    "strict": true,
-    "forceConsistentCasingInFileNames": true,
-    "strictPropertyInitialization": false,
-    "moduleResolution": "Node",
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "noEmit": true,
-    "jsx": "react-jsx",
-    "paths": {
-      "@plone/types/*": ["../types/*"],
-    }
-  },
-  "include": ["src"],
-  "exclude": [
-    "node_modules",
-    "build",
-    "public",
-    "coverage",
-    "src/**/*.test.{js,jsx,ts,tsx}",
-    "src/**/*.spec.{js,jsx,ts,tsx}",
-    "src/**/*.stories.{js,jsx,ts,tsx}"
-  ]
-}

package/packages/scripts/CHANGELOG.md

@@ -1,173 +0,0 @@
-# Volto Scripts Release Notes
-
-<!-- You should *NOT* be adding new change log entries to this file.
-     You should create a file in the news directory instead.
-     For helpful instructions, please see:
-     https://6.docs.plone.org/volto/developer-guidelines/contributing.html#create-a-pull-request
--->
-
-<!-- towncrier release notes start -->
-
-## 3.0.1 (2023-10-06)
-
-### Bugfix
-
-- Update `git-url-parse` dependency. @davisagli [#5098](https://github.com/plone/volto/issues/5098)
-- Fix error ``no such file or directory, open 'addon-testing-project/jsconfig.json'`` in addon clone command. @wesleybl [#5239](https://github.com/plone/volto/issues/5239)
-
-
-## 3.0.0 (2023-04-07)
-
-### Breaking
-
-- Remove dependency on `simple-git`. It is used by `mrs-developer` but not directly. @davisagli [#4546](https://github.com/plone/volto/issues/4546)
-
-### Bugfix
-
-- Fixed i18n script to avoid overwriting translations with an empty msgstr @danalvrz [#4316](https://github.com/plone/volto/issues/4316)
-
-
-## 2.3.0 (2023-01-13)
-
-### Feature
-
-- The `consolidate` command includes Cypress folder @sneridagh [#4192](https://github.com/plone/volto/issues/4192)
-- Add backport PR helper script @sneridagh [#4222](https://github.com/plone/volto/issues/4222)
-- Improve consolidate and local clone copy files @sneridagh [#4253](https://github.com/plone/volto/issues/4253)
-
-
-## 2.2.2 (2022-12-23)
-
-### Internal
-
-- Adjust npmignores, reissue package @sneridagh [#0](https://github.com/plone/volto/issues/0)
-
-
-## 2.2.1 (2022-11-24)
-
-### Bugfix
-
-- Include `cypress` folder and `cypress.config.js` in the local clone command @sneridagh
-- Fix the local clone command `execSync` @sneridagh
-
-## 2.2.0 (2022-11-24)
-
-### Feature
-
-- Match the new layout for the Volto project generator for Cypress tests @sneridagh
-
-## 2.1.5 (2022-11-24)
-
-### Bugfix
-
-- Remove `isCanary` amendment to differentiate 15/16 way of calling the test script @sneridagh
-
-## 2.1.4 (2022-11-24)
-
-### Bugfix
-
-- Disable immutable installs in local package once created, so CI does not complain. We REALLY want to install something! @sneridagh
-
-## 2.1.3 (2022-11-24)
-
-### Bugfix
-
-- Improve `execSync` call in addon script @sneridagh
-
-## 2.1.2 (2022-10-26)
-
-### Internal
-
-- Add missing dependency @tiberiuichim
-
-## 2.1.1 (2022-09-28)
-
-### Bugfix
-
-- Fix if `canary` selected, the tests should not include `--env=jest-environment-jsdom-sixteen` @sneridagh
-
-## 2.1.0 (2022-09-28)
-
-### Feature
-
-- New `clone` to local command @sneridagh
-- New `consolidate` command @sneridagh
-
-## 2.0.0 (2022-09-27)
-
-### Breaking
-
-- Removed `Razzle` as dependency, leave only the `babel-preset-razzle` one which is enough.
-
-  See https://6.docs.plone.org/volto/upgrade-guide/index.html for more information.
-
-## 1.6.0 (2022-08-05)
-
-### Feature
-
-- Add support for recommended structure `frontend` folder using `CHANGELOG.md` in the parent folder. @sneridagh
-
-## 1.5.0 (2022-07-28)
-
-### Feature
-
-- Add `--canary` option to use latest alpha in generator @sneridagh
-
-## 1.4.1 (2022-02-24)
-
-### Bugfix
-
-- Fix `branch` option not getting into the `getAddonInfo` function @sneridagh
-
-## 1.4.0 (2021-12-29)
-
-### Feature
-
-- Add custom `cypress:run` script for starting the right Cypress suite (in addon test environment) @sneridagh
-
-## 1.3.0 (2021-12-28)
-
-### Feature
-
-- Add custom `test` script for getting the right `RAZZLE_JEST_CONFIG` (in addon test environment) @sneridagh
-
-## 1.2.0 (2021-12-28)
-
-### Feature
-
-- Improved CLI for creating addon testing environments @sneridagh
-
-## 1.1.0 (2021-12-24)
-
-### Feature
-
-- Initial version of the CLI for addon testing @sneridagh
-
-## 1.0.3 (2021-10-01)
-
-### Bugfix
-
-- Fix defaults not getting in properly in i18n script @sneridagh
-
-## 1.0.2 (2021-09-27)
-
-### Bugfix
-
-- Missing default interpreter for `chagelogupdater` script @sneridagh
-
-## 1.0.1 (2021-09-27)
-
-### Bugfix
-
-- Missing `pofile` as dependency @sneridagh
-
-## 1.0.0 (2021-09-25)
-
-### Feature
-
-- Volto i18n messages extractor and `react-intl` language .json generator script @sneridagh
-- Changelog script @sneridagh
-
-### Internal
-
-- Initial release