0.11.0

epam · Aug 26, 2024 · a9e89e8 · a9e89e8
1 parent 86b4e98
commit a9e89e8
Show file tree

Hide file tree

Showing 41 changed files with 68,438 additions and 77,192 deletions.
diff --git a/.yarn/plugins/@yarnpkg/plugin-version.cjs b/.yarn/plugins/@yarnpkg/plugin-version.cjs
diff --git a/.yarnrc.yml b/.yarnrc.yml
@@ -7,5 +7,7 @@ plugins:
     spec: "@yarnpkg/plugin-interactive-tools"
   - path: .yarn/plugins/@yarnpkg/plugin-engines.cjs
     spec: "https://raw.githubusercontent.com/devoto13/yarn-plugin-engines/main/bundles/%40yarnpkg/plugin-engines.js"
+  - path: .yarn/plugins/@yarnpkg/plugin-version.cjs
+    spec: "@yarnpkg/plugin-version"
 
 yarnPath: .yarn/releases/yarn-3.6.3.cjs
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,7 @@
+# Changelog
+
+Please refer to the individual packages:
+
+- [miew](packages/miew/CHANGELOG.md)
+- [miew-react](packages/miew-react/CHANGELOG.md)
+- [miew-app](packages/miew-app/CHANGELOG.md)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -177,7 +177,7 @@ git fetch upstream
 git rebase upstream/main
 
 # lint, test and build
-npm run ci
+yarn run ci
 
 # run automated and manual tests, etc.
 ...
@@ -190,7 +190,7 @@ Unfortunately, it is still a semi-manual process.
 1.  Ensure that you have a clean repo. Check the build pipeline etc.
 
         git status
-        npm run ci
+        yarn run ci
         ...
 
 2.  Use npm to automatically increment version (patch, minor or major).
@@ -201,9 +201,15 @@ Unfortunately, it is still a semi-manual process.
 
     -   Increment product version in the `sonar-project.properties` file.
 
+    -   Examine the changes since the last version. Check the commit log and follow the external
+        links (PRs, issues) to refresh the knowledge.
+
+            git log v0.0.1..HEAD --reverse \
+                --first-parent --pretty=format:"%as - %s (%an)"
+
     -   Update `CHANGELOG.md` file. Don't copy the git log blindly, summarize, reword and reorder. Use the following groups order:
 
-            ## [0.0.1] - 2000-01-01
+            ## [0.0.2] - 2000-01-01
             ### Added
             ### Changed
             ### Deprecated
@@ -214,13 +220,13 @@ Unfortunately, it is still a semi-manual process.
             
     -   Update unreleased link in `CHANGELOG.md` file.
 
-            [Unreleased]: https://github.com/epam/miew/compare/v0.0.1...HEAD
+            [Unreleased]: https://github.com/epam/miew/compare/v0.0.2...HEAD
 
     -   Replace the automatic commit and move the tag.
 
             git add sonar-project.properties CHANGELOG.md 
             git commit --amend
-            git tag -fa v0.0.1 -m "0.0.1"
+            git tag -fa v0.0.2 -m "0.0.2"
 
 4.  Merge `main` into `latest` branch.
 
@@ -239,4 +245,4 @@ Unfortunately, it is still a semi-manual process.
     *  Select the new version tag among existing and fill in a description text box with new release link and list of changes (see `CHANGELOG.md`)
     *  Press `Publish`.
 
-Upon push, GitHub Actions build `main`, `latest` branches and `v0.0.1` tag. The tag automatically initiates NPM publish process if the build is successful.
+Upon push, GitHub Actions build `main`, `latest` branches and `v0.0.2` tag. The tag automatically initiates NPM publish process if the build is successful.
diff --git a/README.md b/README.md
@@ -39,10 +39,10 @@ is to reference a CDN version:
 <html lang="en">
   <head>
     <meta charset="UTF-8" />
-    <script src="https://unpkg.com/[email protected].15/lodash.js"></script>
-    <script src="https://unpkg.com/three@0.112.1/build/three.min.js"></script>
-    <script src="https://unpkg.com/miew@0.9.0/dist/Miew.min.js"></script>
-    <link rel="stylesheet" href="https://unpkg.com/miew@0.9.0/dist/Miew.min.css" />
+    <script src="https://unpkg.com/lodash@^4.17.21/lodash.js"></script>
+    <script src="https://unpkg.com/three@0.153.0/build/three.min.js"></script>
+    <script src="https://unpkg.com/miew@0.11.0/dist/Miew.min.js"></script>
+    <link rel="stylesheet" href="https://unpkg.com/miew@0.11.0/dist/Miew.min.css" />
   </head>
   <body>
     <div class="miew-container" style="width:640px; height:480px"></div>

diff --git a/package.json b/package.json
@@ -1,7 +1,6 @@
 {
-  "name": "monorepo",
-  "version": "1.0.0",
-  "main": "packages/miew/dist/Miew.js",
+  "name": "miew-monorepo",
+  "version": "0.11.0-0",
   "license": "MIT",
   "private": true,
   "workspaces": [

diff --git a/packages/miew-app/CHANGELOG.md b/packages/miew-app/CHANGELOG.md
@@ -0,0 +1,22 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.1.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+TBD
+
+## [0.11.0] - 2024-08-26
+
+### Added
+
+- Add a [`miew-app`][] package with a new demo application code. The goal is to rewrite the old
+  monolith plain JavaScript demo in modular React.js
+
+[`miew-app`]: https://github.com/epam/miew/tree/main/packages/miew-app
+
+[Unreleased]: https://github.com/epam/miew/compare/v0.11.0...HEAD
+[0.11.0]: https://github.com/epam/miew/compare/v0.9.0...v0.11.0
diff --git a/packages/miew-app/package.json b/packages/miew-app/package.json
@@ -1,6 +1,6 @@
 {
   "name": "miew-app",
-  "version": "0.0.1",
+  "version": "0.11.0-0",
   "description": "React application demonstrating capabilities of Miew library",
   "author": "EPAM Systems, Inc.",
   "private": true,

diff --git a/packages/miew-react/CHANGELOG.md b/packages/miew-react/CHANGELOG.md
@@ -0,0 +1,21 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.1.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+TBD
+
+## [0.11.0] - 2024-08-26
+
+### Added
+
+- Add a [`miew-react`][] package that contains a React.js wrapper component. It is published
+  as a separate [miew-react](https://www.npmjs.com/package/miew-react) package on npm.
+
+[`miew-react`]: https://github.com/epam/miew/tree/main/packages/miew-react
+[Unreleased]: https://github.com/epam/miew/compare/v0.11.0...HEAD
+[0.11.0]: https://github.com/epam/miew/compare/v0.9.0...v0.11.0
diff --git a/packages/miew-react/package.json b/packages/miew-react/package.json
@@ -1,6 +1,6 @@
 {
   "name": "miew-react",
-  "version": "1.1.0-dev",
+  "version": "0.11.0-0",
   "description": "Miew - 3D Molecular Viewer (React component)",
   "author": "EPAM Systems, Inc.",
   "homepage": "https://github.com/epam/miew#readme",

diff --git a/packages/miew/CHANGELOG.md b/packages/miew/CHANGELOG.md
@@ -1,11 +1,71 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.1.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+TBD
+
+## [0.11.0] - 2024-08-26
+
+### Added
+
+- Add a [`miew-react`][] package that contains a React.js wrapper component. It is published
+  as a separate [miew-react](https://www.npmjs.com/package/miew-react) package on npm.
+- Add a [`miew-app`][] package with a new demo application code. The goal is to rewrite the old
+  monolith plain JavaScript demo in modular React.js
+
+[`miew-react`]: https://github.com/epam/miew/tree/main/packages/miew-react
+[`miew-app`]: https://github.com/epam/miew/tree/main/packages/miew-app
+
+### Changed
+
+- Support shadows in sprite-based modes (Licorice, Balls and Sticks, VDW, and Trace).
+- Clip sprites with near plane instead of culling them.
+- Color residue names in the "sequence" example according to the secondary structure.
+- Use CIF format in the demo and examples instead of discontinued MMTF.
+- **BREAKING CHANGE:** Bump tree.js to r153. Can break your code only if you rely on specific
+  three.js API yourself.
+
+### Removed
+
+- **BREAKING CHANGE:** Remove support for `mmtf:` prefix during loading because the format
+  is discontinued and files are not served anymore. Parsing local files or specific URLs
+  is still supported.
+- **BREAKING CHANGE:** The `miew` library no longer intercepts the `S` key. Numpad plus and minus
+  are still processed but require the `Alt` key pressed to avoid conflicts. The keys will likely
+  be removed in the future versions in favor of event handlers and API calls.
+
+### Fixed
+
+- Don't crash on `addEventListener` call if embedded in a cross-origin IFRAME.
+- Create empty molecules correctly.
+- Fix `HydrophobicityColorer` behavior.
+- Rebuild the geometry after enabling or disabling `zSprite` setting.
+- Change event name in the docs: `rebuildingDone` to `buildingDone`.
+- Fix "sequence" example to use the proper event.
+
+### Internal
+
+- Use the `main` branch as the main instead of the abandoned `master`.
+- Reorganize the project as a monorepo.
+- Migrate to Yarn 3.
+- Migrate to GitHub Actions for CI builds instead if TravisCI.
+- Migrate to Webpack instead of Rollup for building the library.
+- Remove IDE files from the repository.
+- Support the current Node LTS 18 and 20 for development.
+- Create a Dockerfile for building an image.
+- Convert several remaining old-style JS files to ES2015 classes.
+- Update babel and eslint configurations and fix issues.
+- Add more tests.
+- Regenerate golden images.
+- Translate help document for beginners into English.
+
+## [0.10.0] - 2022-01-25 \[YANKED]
+
 ## [0.9.0] - 2020-03-23
 ### Added
 - Add unittests for Atom and Molecule
@@ -584,7 +644,9 @@ in [0.7.7+hotfix] and later releases.
 - Update dependencies to the latest supported versions.
 - Move the project to GitHub.
 
-[Unreleased]: https://github.com/epam/miew/compare/v0.9.0...HEAD
+[Unreleased]: https://github.com/epam/miew/compare/v0.11.0...HEAD
+[0.11.0]: https://github.com/epam/miew/compare/v0.9.0...v0.11.0
+[0.10.0]: https://github.com/epam/miew/compare/v0.9.0...v0.10.0
 [0.9.0]: https://github.com/epam/miew/compare/v0.8.7...v0.9.0
 [0.8.7]: https://github.com/epam/miew/compare/v0.8.6...v0.8.7
 [0.8.6]: https://github.com/epam/miew/compare/v0.8.5...v0.8.6

diff --git a/packages/miew/README.md b/packages/miew/README.md
@@ -30,10 +30,10 @@ or built with a bundler of your choice. For more details refer to:
 <html lang="en">
   <head>
     <meta charset="UTF-8" />
-    <script src="https://unpkg.com/[email protected].15/lodash.js"></script>
-    <script src="https://unpkg.com/three@0.112.1/build/three.min.js"></script>
-    <script src="https://unpkg.com/miew@0.9.0/dist/Miew.min.js"></script>
-    <link rel="stylesheet" href="https://unpkg.com/miew@0.9.0/dist/Miew.min.css" />
+    <script src="https://unpkg.com/lodash@^4.17.21/lodash.js"></script>
+    <script src="https://unpkg.com/three@0.153.0/build/three.min.js"></script>
+    <script src="https://unpkg.com/miew@0.11.0/dist/Miew.min.js"></script>
+    <link rel="stylesheet" href="https://unpkg.com/miew@0.11.0/dist/Miew.min.css" />
   </head>
   <body>
     <div class="miew-container" style="width:640px; height:480px"></div>