@adobe/helix-md2jcr 1.0.13 → 1.0.15

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [1.0.15](https://github.com/adobe/helix-md2jcr/compare/v1.0.14...v1.0.15) (2025-02-24)
+
+
+### Bug Fixes
+
+* **deps:** update dependency hast-util-to-html to v9.0.5 ([#58](https://github.com/adobe/helix-md2jcr/issues/58)) ([9089f60](https://github.com/adobe/helix-md2jcr/commit/9089f609c6704c5c2853895b879e6b56e66b716d))
+
+## [1.0.14](https://github.com/adobe/helix-md2jcr/compare/v1.0.13...v1.0.14) (2025-02-21)
+
+
+### Bug Fixes
+
+* **sites-24827:** parse and map page properties ([#57](https://github.com/adobe/helix-md2jcr/issues/57)) ([93448a0](https://github.com/adobe/helix-md2jcr/commit/93448a0fb3da7694fc01513d598a16ae0f10eefb))
+
 ## [1.0.13](https://github.com/adobe/helix-md2jcr/compare/v1.0.12...v1.0.13) (2025-02-18)
 
 

package/docs/development.md

@@ -0,0 +1,21 @@
+# Local Development Setup
+When you make changes to the helix-md2jcr, you can test them locally in the Helix Importer UI, before submitting a pull request. 
+This is a great way to ensure that your changes work as expected and don't introduce any new issues.
+
+## Prerequisites
+Clone [helix-importer](https://github.com/adobe/helix-importer), and [helix-importer-ui](https://github.com/adobe/helix-importer-ui) repositories.
+
+
+## Development Setup
+1. Have a sample crosswalk project setup with import scripts etc.
+2. In helix-md2jcr run `npm link` in the helix-md2jcr project directory.
+3. In helix-importer run `npm link && npm link @adobe/helix-md2jcr` in the helix-importer project directory to create a symbolic link to the helix-md2jcr project.
+4. In helix-importer-ui run `npm link @adobe/helix-importer` in the helix-importer-ui project directory to create a symbolic link to the helix-importer project.
+5. In helix-importer-ui run `npm run build:local` in the helix-importer-ui project directory to generate the dist folder and files.
+6. In the sample crosswalk project make sure a ./tools/importer folder exists.  From within this folder run `ln -s /path/to/helix-importer-ui`. 
+A symbolic link will be created to the helix-importer-ui project.
+7. From your sample crosswalk project root folder, run `aem import --skip-ui`, this will launch the helix-importer-ui and not try to sync the remote repository,
+and use the local projects as the source for the UI.
+
+Any changes make to the helix-md2jcr project, you must run `npm run build:local` in the helix-importer-ui project directory, and refresh the browser to see the changes.
+You can open the browser console and set breakpoints to debug the UI and helix-md2jcr changes.

package/docs/releasing.md

@@ -0,0 +1,43 @@
+# Releasing
+
+After merging a PR into `main`, a build will run and perform a release automatically. For example, the 1.0.14 build was done
+[here](https://github.com/adobe/helix-md2jcr/commit/36604f967d4c694daa5a05f020b87f387ac46040) for PR [57](https://github.com/adobe/helix-md2jcr/pull/57). 
+Once the `main` build is successful, the PR is updated with the release information.
+
+![1014-release.png](images/1014-release.png)
+
+### Updating Project Dependencies
+
+#### Helix-Importer
+
+To move the release to the next stage, update the projects that require the new version. For example, the
+[helix-importer](https://github.com/adobe/helix-importer). Navigate to the [Dependency Dashboard](https://github.com/adobe/helix-importer/issues/6) 
+and click the checkbox to get Renovate to run again.
+
+Once the Renovate bot has completed its execution, a new PR will be opened with the updated version. For example, the 
+PR [here](https://github.com/adobe/helix-importer/pull/492) updates the helix-importer to use the new version of helix-md2jcr. Squash and 
+merge the PR to complete the release process into the helix-importer project.
+
+Wait until the `main` branch has been updated with the new version before moving on to the next project and note the release version. 
+For example, the helix-importer project was updated to version [1.0.14](https://github.com/adobe/helix-importer/commit/9a1ba65bc5a4507f214027e6ce076af86cb04567) 
+and released with version 3.4.58.
+
+The next step is to update the [helix-importer-ui](https://github.com/adobe/helix-importer-ui) project to use the new version of helix-importer.
+
+#### Helix Importer UI Update
+
+Navigate to the [Dependency Dashboard](https://github.com/adobe/helix-importer-ui/issues/19) and click the checkbox to get Renovate to run again. 
+Review the PRs and select the PR for the helix-importer version update.
+
+You may see the following dialog which requires your attention to select the checkbox with the updated version.
+![renovate-pr.png](images/renovate-pr.png) 
+
+Once selected, a new PR will be opened.
+
+For example, the PR [here](https://github.com/adobe/helix-importer-ui/pull/470) updates the helix-importer-ui to use the new version of 
+helix-importer. Wait for the build to complete and merge the PR to complete the release process into the helix-importer-ui project.
+
+If you wish to test the changes locally, you can follow the development setup [document](development.md). Once you are satisfied with the changes, 
+merge the PR.
+
+Once the changes have been merged to `main`, they are now available for use in the Helix Importer UI for the world to use.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-md2jcr",
-  "version": "1.0.13",
+  "version": "1.0.15",
   "description": "Helix Service that converts markdown to JCR content structure",
   "main": "src/index.js",
   "type": "module",

package/src/mdast2jcr/hb/helpers/page-helper.js

@@ -39,7 +39,14 @@ function buildPageMetadata(table, models) {
     const key = toString(cells[0]);
 
     // if the model has the field, then add it to the metadata
-    const field = getField(model, key);
+    let field;
+    if (Object.keys(aemMapping).includes(key.toLowerCase())) {
+      const aemValue = aemMapping[key.toLowerCase()];
+      field = getField(model, aemValue);
+    } else {
+      field = getField(model, key);
+    }
+
     if (field) {
       // if the field is an image then we need to dig into the row to find the image
       if (find(row.children[1], { type: 'image' })) {
@@ -59,13 +66,9 @@ function buildPageMetadata(table, models) {
     }
   });
 
-  // now go through the metadata and map the fields to aem fields
-  const mappedMetadata = {};
-  Object.entries(metadata).forEach(([key, value]) => {
-    const mappedKey = aemMapping[key] || key;
-    mappedMetadata[mappedKey] = value;
-  });
-
+  const mappedMetadata = { ...metadata };
+  // we need to add a property called modelFields for the Universal Editor
+  // that has all the fields for the model
   if (model) {
     const fields = getModelFields(model);
     mappedMetadata.modelFields = `[${fields}]`;