@jahia/create-module 0.0.1

package/.eslintrc.cjs

@@ -0,0 +1,28 @@
+module.exports = {
+    env: {
+        browser: true,
+        es2021: true
+    },
+    extends: '@jahia',
+    overrides: [
+        {
+            env: {
+                node: true
+            },
+            files: [
+                '.eslintrc.{js,cjs}'
+            ],
+            parserOptions: {
+                sourceType: 'script'
+            }
+        }
+    ],
+    parserOptions: {
+        requireConfigFile: false,
+        ecmaVersion: 'latest',
+        sourceType: 'module'
+    },
+    ignorePatterns: ['dist'],
+    rules: {
+    }
+};

package/.github/dependabot.yml

@@ -0,0 +1,15 @@
+# See: https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    allow:
+      - dependency-type: "production"
+  - package-ecosystem: "maven"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    allow:
+      - dependency-type: "production"

package/.github/workflows/lint.yml

@@ -0,0 +1,35 @@
+name: Lint
+# This workflow is triggered on pushes to the repository.
+on:
+  push:
+    branches:
+      - '**'
+
+jobs:
+  lint:
+    name: Linting
+    runs-on: ubuntu-latest
+
+    container:
+      image: node:lts-alpine
+
+    steps:
+      - uses: actions/checkout@v2
+      - run: yarn set version stable
+      - run: yarn
+      - run: yarn run lint
+
+  build:
+    needs: [lint]
+    name: Build
+    runs-on: ubuntu-latest
+    # if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+
+    container:
+      image: node:lts-alpine
+
+    steps:
+      - uses: actions/checkout@v2
+      - run: yarn set version stable
+      - run: yarn
+      - run: yarn jahia-pack

package/.github/workflows/publish-release.yml

@@ -0,0 +1,22 @@
+name: Publish Release to Registry
+on:
+  release:
+    types: [published]
+
+jobs:
+  npm_publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@master
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 'lts/*'
+      - run: corepack enable
+      - run: yarn set version stable
+      - run: yarn
+      - run: whoami && node -v && ls -lah 
+      - run: echo "//registry.npmjs.org/:_authToken=${{ secrets.NPMJS_PUBLISH_TOKEN }}" > .npmrc
+      - run: npm --no-git-tag-version version ${{ github.event.release.tag_name }}
+      - run: ls -lah ./
+      - run: npm publish --access public

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Jahia Forge - Code Repository
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,10 @@
+# NPM Module template create-module project
+
+This project provides an NPM/NPX starter project template to quickly get up and running to create Jahia NPM modules
+
+## Usage
+
+    npx @jahia/create-module@latest my-module-name my-module-type
+
+where `my-module-name` can be anything you want to call your project
+and `my-module-type`is jsx or handlebars

package/babel.config.cjs.disabled

@@ -0,0 +1,3 @@
+module.exports = {
+    presets: ['@babel/preset-env', '@babel/preset-react']
+};

package/handlebars/README.md

@@ -0,0 +1,11 @@
+# $$MODULE_NAME$$
+
+A simple Jahia NPM module created using the NPM module starter project template
+
+## Configuration
+
+If you don't use default configuration for the Docker container name or for Jahia deployments, please modify the provided `.env` file
+
+## Documentation
+
+You can find the documentation on how to use this module on the [Jahia Academy](https://academy.jahia.com/get-started/developers/templating) templating tutorial.

package/handlebars/components/MODULE_NAMESPACE/hello/hello.cnd

@@ -0,0 +1,6 @@
+<jnt = 'http://www.jahia.org/jahia/nt/1.0'>
+<jmix = 'http://www.jahia.org/jahia/mix/1.0'>
+<$$MODULE_NAMESPACE$$ = 'http://www.acme.org/$$MODULE_NAME$$/nt/1.0'>
+
+[$$MODULE_NAMESPACE$$:hello] > jnt:content, jmix:droppableContent
+ - textHello (string) = 'Hello world !' i18n

package/handlebars/components/MODULE_NAMESPACE/hello/hello.default.hbs

@@ -0,0 +1 @@
+<h1>{{currentContent.properties.textHello}}</h1>

package/handlebars/components/jnt/page/page.home.hbs

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html lang="en" class="no-js">
+
+<head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>Home Template</title>
+</head>
+
+<body>
+    <h1>Home Template</h1>
+    <main>
+        {{jArea name="pagecontent"}}
+    </main>
+</body>
+
+</html>

package/handlebars/components/jnt/page/page.home.properties

@@ -0,0 +1,2 @@
+name=Home page
+componentType=template

package/handlebars/definitions.cnd

@@ -0,0 +1,8 @@
+<jnt = 'http://www.jahia.org/jahia/nt/1.0'>
+<jmix = 'http://www.jahia.org/jahia/mix/1.0'>
+<$$MODULE_NAMESPACE$$ = 'http://www.acme.org/$$MODULE_NAME$$/nt/1.0'>
+<$$MODULE_NAMESPACE$$mix = 'http://www.acme.org/$$MODULE_NAME$$/mix/1.0'>
+
+// This mixin creates a category to regroup types in the content type selector UI. Apply it to any definition you want
+// to see in this category.
+[$$MODULE_NAMESPACE$$mix:$$MODULE_NAMESPACE$$Components] > jmix:droppableContent, jmix:accessControllableContent mixin

package/handlebars/dotenv

@@ -0,0 +1,4 @@
+JAHIA_USER=root:root1234
+JAHIA_HOST=http://localhost:8080
+JAHIA_DOCKER_NAME=jahia-ee-dev
+JAHIA_DEPLOY_METHOD=curl

package/handlebars/doteslintrc.cjs

@@ -0,0 +1,29 @@
+module.exports = {
+    root: true,
+    env: {
+        browser: true,
+        es2021: true
+    },
+    extends: '@jahia',
+    overrides: [
+        {
+            env: {
+                node: true
+            },
+            files: [
+                '.eslintrc.{js,cjs}'
+            ],
+            parserOptions: {
+                sourceType: 'script'
+            }
+        }
+    ],
+    parserOptions: {
+        requireConfigFile: false,
+        ecmaVersion: 'latest',
+        sourceType: 'module'
+    },
+    ignorePatterns: ['dist'],
+    rules: {
+    }
+};

package/handlebars/dotgitignore

@@ -0,0 +1,15 @@
+# Intellij
+.idea
+*.iml
+*.ipr
+
+# Node
+dist
+node_modules
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

package/handlebars/dotnpmignore

@@ -0,0 +1,4 @@
+.env
+.eslintrc.cjs
+.idea
+*.tgz

package/handlebars/import.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<content xmlns:j="http://www.jahia.org/jahia/1.0" xmlns:jcr="http://www.jcp.org/jcr/1.0">
+    <modules jcr:primaryType="jnt:modules">
+        <$$MODULE_NAME$$>
+            <home j:isHomePage="true" j:templateName="home" jcr:primaryType="jnt:page" />
+        </$$MODULE_NAME$$>
+    </modules>
+</content>

package/handlebars/locales/de.json

@@ -0,0 +1,3 @@
+{
+  "greeting": "Hallo !"
+}

package/handlebars/locales/en.json

@@ -0,0 +1,3 @@
+{
+  "greeting": "Hello !"
+}

package/handlebars/locales/fr.json

@@ -0,0 +1,3 @@
+{
+  "greeting": "Salut !"
+}

package/handlebars/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "$$MODULE_NAME$$",
+  "version": "1.0.0",
+  "license": "MIT",
+  "scripts": {
+    "build": "webpack --mode=development",
+    "deploy": "jahia-deploy",
+    "watch": "yarn build --env deploy=true --watch",
+    "lint": "eslint .",
+    "test": "yarn lint", 
+    "postinstall": "yarn dlx @yarnpkg/sdks vscode"    
+  },
+  "jahia": {
+    "module-dependencies" : "default",
+    "module-type": "templatesSet",
+    "server": "dist/main.js", 
+    "static-resources" : "/css,/images,/javascript"
+  },
+  "devDependencies": {
+    "@jahia/eslint-config": "^2.1.2",
+    "@jahia/scripts": "^1.3.3",
+    "eslint": "^8.43.0",
+    "eslint-plugin-jest": "latest",
+    "eslint-plugin-react": "latest",
+    "eslint-plugin-react-hooks": "latest",
+    "extra-watch-webpack-plugin": "latest",
+    "handlebars-loader": "^1.7.3",
+    "typescript": "^5.3.3",
+    "webpack": "^5.88.1",
+    "webpack-cli": "^5.1.4",
+    "webpack-shell-plugin-next": "^2.3.1"
+  },
+  "dependencies": {
+    "handlebars": "^4.7.7",
+    "@jahia/js-server-core" : "^0.0.4"
+  },
+  "engines": {
+    "node": ">=16.0.0",
+    "yarn": ">=3.0.0"
+  }
+}

package/handlebars/resources/MODULE_NAME.properties

@@ -0,0 +1,2 @@
+$$MODULE_NAMESPACE$$_hello=Hello
+$$MODULE_NAMESPACE$$_hello.textHello=Hello world !

package/handlebars/resources/MODULE_NAME_fr.properties

@@ -0,0 +1,2 @@
+$$MODULE_NAMESPACE$$_hello=Bonjour
+$$MODULE_NAMESPACE$$_hello.textHello=Bonjour le monde !

package/handlebars/settings/README.txt

@@ -0,0 +1,9 @@
+In this directory you can put directly : 
+- Rule files (*.drl, *.dsl)
+- URL rewrite XML files
+
+In the configurations directory you can put : 
+- OSGi configuration files (*.cfg, *.yml)
+
+In the jahia-content-editor-forms you can put content editor form and field set overrides, 
+see examples here : https://academy.jahia.com/documentation/jahia/jahia-8/developer/extending-and-customizing-jahia-ui/customizing-content-editor-forms/examples-of-content-definition-json-overrides 

package/handlebars/webpack.config.js

@@ -0,0 +1,49 @@
+const path = require('path');
+const WebpackShellPluginNext = require('webpack-shell-plugin-next');
+const ExtraWatchWebpackPlugin = require('extra-watch-webpack-plugin');
+
+module.exports = env => {
+    const config = {
+        entry: {
+            main: path.resolve(__dirname, 'src/index')
+        },
+        output: {
+            path: path.resolve(__dirname, 'dist')
+        },
+        externals: {
+            '@jahia/js-server-core': 'jsServerCoreLibraryBuilder.getLibrary()',
+            handlebars: 'jsServerCoreLibraryBuilder.getSharedLibrary(\'handlebars\')'
+        },
+        plugins: [
+            new ExtraWatchWebpackPlugin({
+                files: [
+                    'src/**/*',
+                    'components/**/*',
+                    'views/**/*',
+                    'images/**/*',
+                    'css/**/*',
+                    'javascript/**/*',
+                    'locales/**/*.json',
+                    'resources/**/*.properties',
+                    'settings/**/*',
+                    'definitions.cnd',
+                    'import.xml',
+                    'package.json'
+                ]
+            })
+        ],
+        devtool: 'inline-source-map'
+    };
+
+    if (env.deploy) {
+        config.plugins.push(
+            new WebpackShellPluginNext({
+                onAfterDone: {
+                    scripts: ['yarn jahia-deploy pack']
+                }
+            })
+        );
+    }
+
+    return config;
+};

package/index.js

@@ -0,0 +1,164 @@
+#!/usr/bin/env node
+
+// Usage: npx @jahia/create-module@latest module-name [namespace]
+
+import fs from 'fs';
+import path from 'path';
+import {fileURLToPath} from 'url';
+import replace from 'replace-in-file';
+import camelCase from 'camelcase';
+import {execSync} from 'child_process';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+// The first argument will be the project name.
+// The second argument will be the project type (handlebars or jsx)
+// The third argument is optional, it will be the namespace of the module.
+if (process.argv.length < 3) {
+    console.error('Missing module-name parameter. Ex: npx @jahia/create-module@latest module-name module-type [namespace]');
+    process.exit(9);
+}
+
+const projectName = process.argv[2];
+const camelProjectName = camelCase(projectName);
+
+// First let's do some version checks
+console.log('Node version detected:', process.versions.node);
+const yarnVersion = execSync('yarn --version', {encoding: 'utf8'});
+console.log('Yarn version:', yarnVersion);
+
+let projectType;
+if (process.argv[3] === 'handlebars' || process.argv[3] === 'jsx') {
+    projectType = process.argv[3];
+} else {
+    console.error(`Invalid module-type parameter, should be handlebars or jsx, got:${process.argv[3]}. Ex: npx @jahia/create-module@latest module-name module-type [namespace]`);
+    process.exit(9);
+}
+
+let namespace;
+if (process.argv.length > 4) {
+    namespace = process.argv[4];
+} else {
+    namespace = camelProjectName;
+}
+
+// Create a project directory with the project name.
+const currentDir = process.cwd();
+const projectDir = path.resolve(currentDir, projectName);
+fs.mkdirSync(projectDir, {recursive: true});
+
+// A common approach to building a starter template is to
+// create a `template` folder which will house the template
+// and the files we want to create.
+const templateDir = path.resolve(__dirname, projectType);
+fs.cpSync(templateDir, projectDir, {recursive: true});
+
+// It is good practice to have dotfiles stored in the
+// template without the dot (so they do not get picked
+// up by the starter template repository). We can rename
+// the dotfiles after we have copied them over to the
+// new project directory.
+fs.renameSync(
+    path.join(projectDir, 'dotgitignore'),
+    path.join(projectDir, '.gitignore')
+);
+fs.renameSync(
+    path.join(projectDir, 'dotnpmignore'),
+    path.join(projectDir, '.npmignore')
+);
+fs.renameSync(
+    path.join(projectDir, 'dotenv'),
+    path.join(projectDir, '.env')
+);
+fs.renameSync(
+    path.join(projectDir, 'doteslintrc.cjs'),
+    path.join(projectDir, '.eslintrc.cjs')
+);
+
+// Rename the resource file to use the project name
+fs.renameSync(
+    path.join(projectDir, 'resources/MODULE_NAME.properties'),
+    path.join(projectDir, 'resources/' + projectName + '.properties')
+);
+
+fs.renameSync(
+    path.join(projectDir, 'resources/MODULE_NAME_fr.properties'),
+    path.join(projectDir, 'resources/' + projectName + '_fr.properties')
+);
+
+// Rename the resource file to use the project name
+if (process.argv[3] === 'handlebars') {
+    fs.renameSync(
+        path.join(projectDir, 'components/MODULE_NAMESPACE'),
+        path.join(projectDir, 'components/' + namespace)
+    );
+}
+
+// Create empty directories for static resources and configurations
+fs.mkdirSync(path.join(projectDir, 'css'), {recursive: true});
+fs.mkdirSync(path.join(projectDir, 'images'), {recursive: true});
+fs.mkdirSync(path.join(projectDir, 'javascript'), {recursive: true});
+fs.mkdirSync(path.join(projectDir, 'settings/configurations'), {recursive: true});
+fs.mkdirSync(path.join(projectDir, 'settings/jahia-content-editor-forms'), {recursive: true});
+fs.mkdirSync(path.join(projectDir, 'settings/jahia-content-editor-forms/forms'), {recursive: true});
+fs.mkdirSync(path.join(projectDir, 'settings/jahia-content-editor-forms/fieldsets'), {recursive: true});
+
+// Find and replace all markers with the appropriate substitution values
+const targetFiles = [
+    path.join(projectDir, 'README.md'),
+    path.join(projectDir, 'import.xml'),
+    path.join(projectDir, 'package.json'),
+    path.join(projectDir, 'definitions.cnd'),
+    path.join(projectDir, 'resources/' + projectName + '.properties'),
+    path.join(projectDir, 'resources/' + projectName + '_fr.properties')
+];
+
+if (projectType === 'jsx') {
+    targetFiles.push(path.join(projectDir, 'src/server/templates/page/PageHome.jsx'));
+    targetFiles.push(path.join(projectDir, 'src/server/views/hello/HelloDefault.jsx'));
+    targetFiles.push(path.join(projectDir, 'src/client/index.jsx'));
+    targetFiles.push(path.join(projectDir, 'webpack.config.js'));
+}
+
+if (projectType === 'handlebars') {
+    targetFiles.push(path.join(projectDir, 'components/' + namespace + '/hello/hello.cnd'));
+}
+
+try {
+    replace.sync({
+        files: targetFiles,
+        from: /\$\$CAMEL_MODULE_NAME\$\$/g,
+        to: camelProjectName,
+        disableGlobs: true // This is required otherwise the replaces fail under Windows (see https://jira.jahia.org/browse/BACKLOG-21353)
+    });
+
+    replace.sync({
+        files: targetFiles,
+        from: /\$\$MODULE_NAME\$\$/g,
+        to: projectName,
+        disableGlobs: true // This is required otherwise the replaces fail under Windows (see https://jira.jahia.org/browse/BACKLOG-21353)
+    });
+
+    replace.sync({
+        files: targetFiles,
+        from: /\$\$MODULE_NAMESPACE\$\$/g,
+        to: namespace,
+        disableGlobs: true // This is required otherwise the replaces fail under Windows (see https://jira.jahia.org/browse/BACKLOG-21353)
+    });
+} catch (error) {
+    console.error('Error occurred:', error);
+}
+
+console.log(`Created ${projectName} at ${projectDir}`);
+console.log('Success! Your new project is ready.');
+console.log('You can now change into your project and launch "yarn" to install everything to get started.');
+console.log('---');
+console.log('Available project scripts will then be :');
+console.log('  - yarn build : build the project');
+console.log('  - yarn deploy : deploy the project. Make sure you have updated the .env file to match your setup if needed.');
+console.log('  - yarn watch : will build and watch for file modifications, and deploy automatically when changes are detected. Use CTRL+C to stop watching.');
+console.log('  - yarn lint : use to check that your code follows the recommended syntax guidelines. Append --fix to automatically fix most problems.');
+console.log('  - yarn test : to test your project. By default only performs yarn lint but you are encouraged to add your own testing system here.');
+console.log('---');
+console.log('You can also check the documentation available here for more details: https://academy.jahia.com/get-started/developers/templating');

package/jsx/README.md

@@ -0,0 +1,11 @@
+# $$MODULE_NAME$$
+
+A simple Jahia NPM module created using the NPM module starter project template
+
+## Configuration
+
+If you don't use default configuration for the Docker container name or for Jahia deployments, please modify the provided `.env` file
+
+## Documentation
+
+You can find the documentation on how to use this module on the [Jahia Academy](https://academy.jahia.com/get-started/developers/templating) templating tutorial.

package/jsx/css/styles.css

@@ -0,0 +1,8 @@
+body {
+    font-family: 'Helvetica Neue', Arial, sans-serif;
+    margin: 0;
+    padding: 40px;
+    background-color: #f5f5f5;
+    color: #333;
+    line-height: 1.6;
+}

package/jsx/definitions.cnd

@@ -0,0 +1,11 @@
+<jnt = 'http://www.jahia.org/jahia/nt/1.0'>
+<jmix = 'http://www.jahia.org/jahia/mix/1.0'>
+<$$MODULE_NAMESPACE$$ = 'http://www.acme.org/$$MODULE_NAME$$/nt/1.0'>
+<$$MODULE_NAMESPACE$$mix = 'http://www.acme.org/$$MODULE_NAME$$/mix/1.0'>
+
+// This mixin creates a category to regroup types in the content type selector UI. Apply it to any definition you want
+// to see in this category.
+[$$MODULE_NAMESPACE$$mix:$$MODULE_NAMESPACE$$Components] > jmix:droppableContent, jmix:accessControllableContent mixin
+
+[$$MODULE_NAMESPACE$$:hello] > jnt:content, $$MODULE_NAMESPACE$$mix:$$MODULE_NAMESPACE$$Components
+ - textHello (string) = 'Hello world !' i18n

package/jsx/dotenv

@@ -0,0 +1,4 @@
+JAHIA_USER=root:root1234
+JAHIA_HOST=http://localhost:8080
+JAHIA_DOCKER_NAME=jahia-ee-dev
+JAHIA_DEPLOY_METHOD=curl

package/jsx/doteslintrc.cjs

@@ -0,0 +1,29 @@
+module.exports = {
+    root: true,
+    env: {
+        browser: true,
+        es2021: true
+    },
+    extends: '@jahia',
+    overrides: [
+        {
+            env: {
+                node: true
+            },
+            files: [
+                '.eslintrc.{js,cjs}'
+            ],
+            parserOptions: {
+                sourceType: 'script'
+            }
+        }
+    ],
+    parserOptions: {
+        requireConfigFile: false,
+        ecmaVersion: 'latest',
+        sourceType: 'module'
+    },
+    ignorePatterns: ['dist', 'css', 'javascript'],
+    rules: {
+    }
+};

package/jsx/dotgitignore

@@ -0,0 +1,15 @@
+# Intellij
+.idea
+*.iml
+*.ipr
+
+# Node
+dist
+node_modules
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

package/jsx/dotnpmignore

@@ -0,0 +1,10 @@
+.env
+.eslintrc.cjs
+.idea
+*.tgz
+.yarn
+.vscode
+webpack.config.js
+README.md
+settings/README.txt
+src

package/jsx/import.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<content xmlns:j="http://www.jahia.org/jahia/1.0" xmlns:jcr="http://www.jcp.org/jcr/1.0">
+    <modules jcr:primaryType="jnt:modules">
+        <$$MODULE_NAME$$>
+            <home j:isHomePage="true" j:templateName="home" jcr:primaryType="jnt:page">
+            </home>
+        </$$MODULE_NAME$$>
+    </modules>
+</content>

package/jsx/locales/de.json

@@ -0,0 +1,4 @@
+{
+  "greeting": "Hallo !",
+  "welcomeTitle" : "Willkommen bei Jahia!"
+}

package/jsx/locales/en.json

@@ -0,0 +1,4 @@
+{
+  "greeting": "Hello !", 
+  "welcomeTitle" : "Welcome to Jahia !"
+}

package/jsx/locales/fr.json

@@ -0,0 +1,4 @@
+{
+  "greeting": "Salut !",
+  "welcomeTitle" : "Bienvenue chez Jahia !"
+}

package/jsx/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "$$MODULE_NAME$$",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "scripts": {
+    "build": "webpack --mode=development",
+    "build:production": "webpack --mode=production",
+    "deploy": "jahia-deploy pack",
+    "watch": "yarn build --env deploy=true --watch",
+    "lint": "eslint .",
+    "test": "yarn lint", 
+    "postinstall": "yarn dlx @yarnpkg/sdks vscode"    
+  },
+  "jahia": {
+    "module-dependencies": "default",
+    "module-type": "templatesSet",
+    "server": "dist/main.js",
+    "static-resources": "/css,/images,/javascript,/locales"
+  },
+  "dependencies": {
+    "@apollo/client": "3.5.5",
+    "@jahia/data-helper": "1.0.4",
+    "@jahia/js-server-core": "^0.0.4",
+    "graphql": "^16.7.1",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.16.0",
+    "@babel/core": "^7.16.0",
+    "@babel/preset-env": "^7.16.4",
+    "@babel/preset-react": "^7.16.0",
+    "@jahia/eslint-config": "^2.1.2",
+    "@jahia/scripts": "^1.3.3",
+    "babel-loader": "^8.2.3",
+    "clean-webpack-plugin": "^4.0.0",
+    "copy-webpack-plugin": "^10.0.0",
+    "dotenv-cli": "^4.0.0",
+    "eslint": "^8.43.0",
+    "eslint-plugin-jest": "latest",
+    "eslint-plugin-react": "latest",
+    "eslint-plugin-react-hooks": "latest",
+    "extra-watch-webpack-plugin": "^1.0.3",
+    "styled-jsx": "^5.1.2",
+    "typescript": "^5.3.3",
+    "webpack": "^5.64.4",
+    "webpack-cli": "^4.9.1",
+    "webpack-shell-plugin-next": "^2.3.1"
+  },
+  "engines": {
+    "node": ">=16.0.0",
+    "yarn": ">=3.0.0"
+  },
+  "packageManager": "yarn@4.1.0"
+}

package/jsx/resources/MODULE_NAME.properties

@@ -0,0 +1,3 @@
+$$MODULE_NAMESPACE$$mix_$$MODULE_NAMESPACE$$Components = $$MODULE_NAMESPACE$$ Components
+$$MODULE_NAMESPACE$$_hello=Hello
+$$MODULE_NAMESPACE$$_hello.textHello=Hello world !

package/jsx/resources/MODULE_NAME_fr.properties

@@ -0,0 +1,3 @@
+$$MODULE_NAMESPACE$$mix_$$MODULE_NAMESPACE$$Components = Composants $$MODULE_NAMESPACE$$ 
+$$MODULE_NAMESPACE$$_hello=Bonjour
+$$MODULE_NAMESPACE$$_hello.textHello=Bonjour le monde !

package/jsx/settings/README.txt

@@ -0,0 +1,9 @@
+In this directory you can put directly : 
+- Rule files (*.drl, *.dsl)
+- URL rewrite XML files
+
+In the configurations directory you can put : 
+- OSGi configuration files (*.cfg, *.yml)
+
+In the jahia-content-editor-forms you can put content editor form and field set overrides, 
+see examples here : https://academy.jahia.com/documentation/jahia/jahia-8/developer/extending-and-customizing-jahia-ui/customizing-content-editor-forms/examples-of-content-definition-json-overrides 

package/jsx/src/client/index.jsx

@@ -0,0 +1,5 @@
+// PublicPath is used to make webpack able to download the chunks and assets from the correct location
+// Since JS can be aggregated by Jahia on live, the path of the original file is lost
+// Also the context of the server should be handled properly
+// eslint-disable-next-line camelcase, no-undef
+__webpack_public_path__ = `${window.__APPSHELL_INIT_DATA__.moduleBaseUrl}/$$MODULE_NAME$$/javascript/client/`;

package/jsx/src/server/components/index.js

@@ -0,0 +1 @@
+// Export here any components that were added to this directory

package/jsx/src/server/index.js

@@ -0,0 +1,6 @@
+import * as jahiaTemplates from './templates';
+import * as jahiaViews from './views';
+import {registerJahiaComponents} from '@jahia/js-server-core';
+
+registerJahiaComponents(jahiaTemplates);
+registerJahiaComponents(jahiaViews);

package/jsx/src/server/templates/index.js

@@ -0,0 +1 @@
+export * from './page';

package/jsx/src/server/templates/page/PageHome.jsx

@@ -0,0 +1,24 @@
+import React from 'react';
+import {Area, AddResources} from '@jahia/js-server-core';
+
+export const PageHome = () => {
+    return (<>
+        <head>
+            <AddResources type='css' resources='styles.css' />
+            <title>Home</title>
+        </head>
+        <body>
+            <h1>Home Template</h1>
+            <main>
+                <Area name="pagecontent" />
+            </main>
+        </body>
+    </>);
+}
+
+PageHome.jahiaComponent = { // This object is used to register the template in Jahia
+    nodeType: 'jnt:page', // The content node type the template applies to
+    name: 'home', // The name of the template
+    displayName: 'Home page', // The display name of the page template
+    componentType: 'template' // the component type is set to template (as opposed to view component types)
+}

package/jsx/src/server/templates/page/index.js

@@ -0,0 +1 @@
+export * from './PageHome';

package/jsx/src/server/views/hello/HelloDefault.jsx

@@ -0,0 +1,18 @@
+import React from 'react'
+import { useServerContext, getNodeProps } from '@jahia/js-server-core'
+
+export const HelloDefault = () => {
+    const { currentNode } = useServerContext();
+    const props = getNodeProps(currentNode, ['textHello']);
+    return (
+        <div>
+            <h2>{props.textHello}</h2>
+        </div>
+    )
+}
+
+HelloDefault.jahiaComponent = { // this object is used to register the view in Jahia
+    nodeType: '$$MODULE_NAMESPACE$$:hello', // The content node type the template applies to
+    displayName: 'Hello (default)', // The display name of the view
+    componentType: 'view' // the component type is set to view (as opposed to template component types)
+}

package/jsx/src/server/views/hello/index.js

@@ -0,0 +1 @@
+export * from './HelloDefault';

package/jsx/src/server/views/index.js

@@ -0,0 +1 @@
+export * from './hello';

package/jsx/webpack.config.js

@@ -0,0 +1,162 @@
+const fs = require('fs');
+const path = require('path');
+const ModuleFederationPlugin = require('webpack/lib/container/ModuleFederationPlugin');
+const WebpackShellPluginNext = require('webpack-shell-plugin-next');
+const ExtraWatchWebpackPlugin = require('extra-watch-webpack-plugin');
+
+const deps = require('./package.json').dependencies;
+
+// Read all files in the client components directory in order to expose them with webpack module federation more easily
+// Those components are exposed in order to be hydrate/rendered client side
+const componentsDir = './src/client';
+const exposes = {};
+fs.readdirSync(componentsDir).forEach(file => {
+    if (file !== 'index.js') {
+        const componentName = path.basename(file, path.extname(file));
+        exposes[componentName] = path.resolve(componentsDir, file);
+    }
+});
+const moduleName = '$$MODULE_NAME$$';
+
+module.exports = env => {
+    let configs = [
+        {
+            entry: {
+                [moduleName]: path.resolve(__dirname, './src/client/index')
+            },
+            output: {
+                path: path.resolve(__dirname, 'javascript/client')
+            },
+            resolve: {
+                mainFields: ['module', 'main'],
+                extensions: ['.mjs', '.js', '.jsx']
+            },
+            module: {
+                rules: [
+                    {
+                        test: /\.jsx$/,
+                        include: [path.join(__dirname, 'src/client')],
+                        use: {
+                            loader: 'babel-loader',
+                            options: {
+                                presets: [
+                                    ['@babel/preset-env', {modules: false, targets: {safari: '7', ie: '10'}}],
+                                    '@babel/preset-react'
+                                ],
+                                plugins: [
+                                    'styled-jsx/babel'
+                                ]
+                            }
+                        }
+                    }
+                ]
+            },
+            plugins: [
+                new ModuleFederationPlugin({
+                    name: moduleName,
+                    library: {type: 'assign', name: `window.appShell = (typeof appShell === "undefined" ? {} : appShell); window.appShell['${moduleName}']`},
+                    filename: '../client/remote.js',
+                    exposes: exposes,
+                    shared: {
+                        react: {
+                            requiredVersion: deps.react,
+                            singleton: true
+                        },
+                        'react-i18next': {},
+                        i18next: {}
+                    }
+                })
+            ],
+            devtool: 'inline-source-map',
+            mode: 'development'
+        },
+        {
+            entry: {
+                main: path.resolve(__dirname, 'src/server')
+            },
+            output: {
+                path: path.resolve(__dirname, 'dist')
+            },
+            externals: {
+                '@jahia/js-server-core': 'jsServerCoreLibraryBuilder.getLibrary()',
+                react: 'jsServerCoreLibraryBuilder.getSharedLibrary(\'react\')',
+                'styled-jsx/style': 'jsServerCoreLibraryBuilder.getSharedLibrary(\'styled-jsx\')'
+            },
+            resolve: {
+                mainFields: ['module', 'main'],
+                extensions: ['.mjs', '.js', '.jsx']
+            },
+            module: {
+                rules: [
+                    {
+                        test: /\.jsx$/,
+                        include: [
+                            path.join(__dirname, 'src/server'),
+                            path.join(__dirname, 'src/client')
+                        ],
+                        use: {
+                            loader: 'babel-loader',
+                            options: {
+                                presets: [
+                                    ['@babel/preset-env', {modules: false, targets: {safari: '7', ie: '10'}}],
+                                    '@babel/preset-react'
+                                ],
+                                plugins: [
+                                    'styled-jsx/babel'
+                                ]
+                            }
+                        }
+                    },
+                    {
+                        test: /\.s[ac]ss$/i,
+                        use: [
+                            'style-loader',
+                            {
+                                loader: 'css-loader',
+                                options: {
+                                    modules: true
+                                }
+                            },
+                            'sass-loader'
+                        ]
+                    }
+                ]
+            },
+            plugins: [
+                new ExtraWatchWebpackPlugin({
+                    files: [
+                        'src/server/**/*',
+                        'images/**/*',
+                        'css/**/*',
+                        'javascript/**/*',
+                        'locales/**/*.json',
+                        'resources/**/*.properties',
+                        'settings/**/*',
+                        'definitions.cnd',
+                        'import.xml',
+                        'package.json'
+                    ]
+                })
+            ],
+            devtool: 'inline-source-map',
+            mode: 'development'
+        }
+    ];
+
+    const webpackShellPlugin = new WebpackShellPluginNext({
+        onAfterDone: {
+            scripts: ['yarn jahia-deploy pack']
+        }
+    });
+
+    if (env.deploy) {
+        let config = configs[configs.length - 1];
+        if (!config.plugins) {
+            config.plugins = [];
+        }
+
+        config.plugins.push(webpackShellPlugin);
+    }
+
+    return configs;
+};

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@jahia/create-module",
+  "version": "0.0.1",
+  "license": "MIT",
+  "type": "module",
+  "bin": "./index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Jahia/npm-create-module.git"
+  },
+  "keywords": [
+    "template"
+  ],
+  "author": "Jahia <support@jahia.com>",
+  "bugs": {
+    "url": "https://github.com/Jahia/npm-create-module/issues"
+  },
+  "homepage": "https://github.com/Jahia/npm-create-module#readme",
+  "dependencies": {
+    "camelcase": "^8.0.0",
+    "path": "^0.12.7",
+    "replace-in-file": "^7.0.1",
+    "semver": "^7.5.4",
+    "url": "^0.11.1"
+  },
+  "devDependencies": {
+    "@jahia/eslint-config": "^2.1.2",
+    "@jahia/scripts": "^1.3.3",
+    "eslint": "^8.43.0",
+    "eslint-plugin-jest": "latest",
+    "eslint-plugin-react": "latest",
+    "eslint-plugin-react-hooks": "latest"
+  },
+  "scripts": {
+    "lint": "eslint .",
+    "posttest": "yarn lint",
+    "test-hbs": "rm -rf test-project-hbs && node index.js test-project-hbs handlebars && cd test-project-hbs && yarn && yarn build && yarn lint && yarn test && cd ..",
+    "test-jsx": "rm -rf test-project-jsx && node index.js test-project-jsx jsx && cd test-project-jsx && yarn && yarn build && yarn lint && yarn test && cd ..",
+    "test": "yarn test-hbs && yarn test-jsx",
+    "version": "git add README.md"
+  },
+  "engines": {
+    "node": ">=16.0.0",
+    "yarn": ">=3.0.0"
+  },
+  "packageManager": "yarn@4.1.1"
+}