@merkur/preact 0.35.0

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2020 Miroslav Jancarik jancarikmiroslav@gmail.com
+
+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,47 @@
+<p align="center">
+  <a href="https://merkur.js.org/docs/getting-started" title="Getting started">
+    <img src="https://raw.githubusercontent.com/mjancarik/merkur/master/images/merkur-illustration.png" width="100px" height="100px" alt="Merkur illustration"/>
+  </a>
+</p>
+
+# Merkur
+
+[![Build Status](https://github.com/mjancarik/merkur/workflows/CI/badge.svg)](https://github.com/mjancarik/merkur/actions/workflows/ci.yml)
+[![NPM package version](https://img.shields.io/npm/v/@merkur/core/latest.svg)](https://www.npmjs.com/package/@merkur/core)
+![npm bundle size (scoped version)](https://img.shields.io/bundlephobia/minzip/@merkur/core/latest)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+
+The [Merkur](https://merkur.js.org/) is tiny extensible javascript library for front-end microservices(micro frontends). It allows by default server side rendering for loading performance boost. You can connect it with other frameworks or languages because merkur defines easy API. You can use one of six predefined template's library [Preact](https://preactjs.com/), [µhtml](https://github.com/WebReflection/uhtml#readme), [Svelte](https://svelte.dev/) and [vanilla](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals) but you can easily extend for others.
+
+## Features
+ - Flexible templating engine
+ - Usable with all tech stacks
+ - SSR-ready by default
+ - Easy extensible with plugins
+ - Tiny - 1 KB minified + gzipped 
+
+## Getting started
+
+```bash
+npx @merkur/create-widget <name>
+
+cd name
+
+npm run dev // Point your browser at http://localhost:4444/
+```
+![alt text](https://raw.githubusercontent.com/mjancarik/merkur/master/images/hello-widget.png "Merkur example, hello widget")
+## Documentation
+
+To check out [live demo](https://merkur.js.org/demo) and [docs](https://merkur.js.org/docs), visit [https://merkur.js.org](https://merkur.js.org).
+
+## Contribution
+
+Contribute to this project via [Pull-Requests](https://github.com/mjancarik/merkur/pulls).
+
+We are following [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/#summary). To simplify the commit process, you can use `npm run commit` command. It opens an interactive interface, which should help you with commit message composition.
+
+Thank you to all the people who already contributed to Merkur!
+
+<a href="https://github.com/mjancarik/merkur/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=mjancarik/merkur" />
+</a>

package/cli/index.mjs

@@ -0,0 +1,35 @@
+import { fileURLToPath } from 'node:url';
+
+export default function ({ emitter, EMITTER_EVENTS }) {
+  emitter.on(
+    EMITTER_EVENTS.MERKUR_CONFIG,
+    function defaultEntries({ merkurConfig }) {
+      merkurConfig.defaultEntries = {
+        client: [
+          //`${cliConfig.projectFolder}/node_modules/@merkur/preact/entries/client.js`,
+          fileURLToPath(
+            import.meta.resolve('@merkur/preact/entries/client.js'),
+          ),
+        ],
+        server: [
+          //`${cliConfig.projectFolder}/node_modules/@merkur/preact/entries/server.js`,
+          fileURLToPath(
+            import.meta.resolve('@merkur/preact/entries/server.js'),
+          ),
+        ],
+      };
+
+      return merkurConfig;
+    },
+  );
+
+  emitter.on(EMITTER_EVENTS.TASK_BUILD, function defaultBuild({ build }) {
+    build = {
+      ...build,
+      jsxImportSource: 'preact',
+      jsx: 'automatic',
+    };
+
+    return build;
+  });
+}

package/entries/client.js

@@ -0,0 +1,7 @@
+import { createPreactWidget } from '@merkur/preact/client';
+
+import widgetProperties from '@widget';
+
+createPreactWidget({
+  ...widgetProperties,
+});

package/entries/server.js

@@ -0,0 +1,7 @@
+import { createPreactWidget } from '@merkur/preact/server';
+
+import widgetProperties from '@widget';
+
+export const createWidget = createPreactWidget({
+  ...widgetProperties,
+});

package/lib/client/client.cjs

@@ -0,0 +1,65 @@
+'use strict';
+
+var preact = require('preact');
+var core = require('@merkur/core');
+var helpers = require('@merkur/plugin-component/helpers');
+
+/**
+ * Client Factory for creating merkur widgets with preact renderer.
+ */
+function createPreactWidget({ name, version, $dependencies, viewFactory, ...restProps }) {
+    const widgetFactory = async (widgetParams) => core.createMerkurWidget({
+        ...restProps,
+        ...widgetParams,
+        $dependencies: {
+            ...$dependencies,
+            render: preact.render,
+            hydrate: preact.hydrate,
+        },
+        shouldHydrate(widget, { container, isSlot }) {
+            return Boolean(container?.children?.length && !isSlot);
+        },
+        async mount(widget) {
+            await helpers.mapViews(widget, viewFactory, ({ View, ErrorView, container, ...rest }) => {
+                if (!container) {
+                    return;
+                }
+                const { render, hydrate } = widget.$dependencies;
+                const renderView = widget.shouldHydrate({
+                    View,
+                    ErrorView,
+                    container,
+                    ...rest,
+                })
+                    ? hydrate
+                    : render;
+                // @ts-expect-error the @merkur/plugin-error is optional
+                if (widget?.error?.status) {
+                    return ErrorView
+                        ? renderView(ErrorView(widget), container)
+                        : render(null, container);
+                }
+                return renderView(View(widget), container);
+            });
+        },
+        async update(widget) {
+            await helpers.mapViews(widget, viewFactory, ({ View, container }) => container && widget.$dependencies.render(View(widget), container));
+        },
+        async unmount(widget) {
+            await helpers.mapViews(widget, viewFactory, ({ container }) => {
+                if (container) {
+                    widget.$dependencies.render(null, container);
+                }
+            });
+        },
+    });
+    // Register widget factory on client
+    core.createMerkur().register({
+        name,
+        version,
+        createWidget: widgetFactory,
+    });
+    return widgetFactory;
+}
+
+exports.createPreactWidget = createPreactWidget;

package/lib/client/client.d.ts

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

package/lib/client/client.js

@@ -0,0 +1,65 @@
+'use strict';
+
+var preact = require('preact');
+var core = require('@merkur/core');
+var helpers = require('@merkur/plugin-component/helpers');
+
+/**
+ * Client Factory for creating merkur widgets with preact renderer.
+ */
+function createPreactWidget({ name, version, $dependencies, viewFactory, ...restProps }) {
+    const widgetFactory = async (widgetParams) => core.createMerkurWidget({
+        ...restProps,
+        ...widgetParams,
+        $dependencies: {
+            ...$dependencies,
+            render: preact.render,
+            hydrate: preact.hydrate,
+        },
+        shouldHydrate(widget, { container, isSlot }) {
+            return Boolean(container?.children?.length && !isSlot);
+        },
+        async mount(widget) {
+            await helpers.mapViews(widget, viewFactory, ({ View, ErrorView, container, ...rest }) => {
+                if (!container) {
+                    return;
+                }
+                const { render, hydrate } = widget.$dependencies;
+                const renderView = widget.shouldHydrate({
+                    View,
+                    ErrorView,
+                    container,
+                    ...rest,
+                })
+                    ? hydrate
+                    : render;
+                // @ts-expect-error the @merkur/plugin-error is optional
+                if (widget?.error?.status) {
+                    return ErrorView
+                        ? renderView(ErrorView(widget), container)
+                        : render(null, container);
+                }
+                return renderView(View(widget), container);
+            });
+        },
+        async update(widget) {
+            await helpers.mapViews(widget, viewFactory, ({ View, container }) => container && widget.$dependencies.render(View(widget), container));
+        },
+        async unmount(widget) {
+            await helpers.mapViews(widget, viewFactory, ({ container }) => {
+                if (container) {
+                    widget.$dependencies.render(null, container);
+                }
+            });
+        },
+    });
+    // Register widget factory on client
+    core.createMerkur().register({
+        name,
+        version,
+        createWidget: widgetFactory,
+    });
+    return widgetFactory;
+}
+
+exports.createPreactWidget = createPreactWidget;

package/lib/client/client.mjs

@@ -0,0 +1,63 @@
+import { render, hydrate } from 'preact';
+import { createMerkur, createMerkurWidget } from '@merkur/core';
+import { mapViews } from '@merkur/plugin-component/helpers';
+
+/**
+ * Client Factory for creating merkur widgets with preact renderer.
+ */
+function createPreactWidget({ name, version, $dependencies, viewFactory, ...restProps }) {
+    const widgetFactory = async (widgetParams) => createMerkurWidget({
+        ...restProps,
+        ...widgetParams,
+        $dependencies: {
+            ...$dependencies,
+            render,
+            hydrate,
+        },
+        shouldHydrate(widget, { container, isSlot }) {
+            return Boolean(container?.children?.length && !isSlot);
+        },
+        async mount(widget) {
+            await mapViews(widget, viewFactory, ({ View, ErrorView, container, ...rest }) => {
+                if (!container) {
+                    return;
+                }
+                const { render, hydrate } = widget.$dependencies;
+                const renderView = widget.shouldHydrate({
+                    View,
+                    ErrorView,
+                    container,
+                    ...rest,
+                })
+                    ? hydrate
+                    : render;
+                // @ts-expect-error the @merkur/plugin-error is optional
+                if (widget?.error?.status) {
+                    return ErrorView
+                        ? renderView(ErrorView(widget), container)
+                        : render(null, container);
+                }
+                return renderView(View(widget), container);
+            });
+        },
+        async update(widget) {
+            await mapViews(widget, viewFactory, ({ View, container }) => container && widget.$dependencies.render(View(widget), container));
+        },
+        async unmount(widget) {
+            await mapViews(widget, viewFactory, ({ container }) => {
+                if (container) {
+                    widget.$dependencies.render(null, container);
+                }
+            });
+        },
+    });
+    // Register widget factory on client
+    createMerkur().register({
+        name,
+        version,
+        createWidget: widgetFactory,
+    });
+    return widgetFactory;
+}
+
+export { createPreactWidget };

package/lib/client/factory/client.d.ts

@@ -0,0 +1,12 @@
+import { render, hydrate } from 'preact';
+import { WidgetParams, defineWidget } from '@merkur/core';
+declare module '@merkur/core' {
+    interface WidgetDependencies {
+        render: typeof render;
+        hydrate: typeof hydrate;
+    }
+}
+/**
+ * Client Factory for creating merkur widgets with preact renderer.
+ */
+export declare function createPreactWidget({ name, version, $dependencies, viewFactory, ...restProps }: Parameters<typeof defineWidget>[0]): (widgetParams: WidgetParams) => Promise<import("@merkur/core").Widget>;

package/lib/client/factory/server.d.ts

@@ -0,0 +1,5 @@
+import { WidgetParams, defineWidget } from '@merkur/core';
+/**
+ * Server Factory for creating merkur widgets with preact renderer.
+ */
+export declare function createPreactWidget({ viewFactory, $dependencies, ...restProps }: Parameters<typeof defineWidget>[0]): (widgetParams: WidgetParams) => import("@merkur/core").Widget;

package/lib/client/server.d.ts

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

package/lib/server/client.d.ts

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

package/lib/server/factory/client.d.ts

@@ -0,0 +1,12 @@
+import { render, hydrate } from 'preact';
+import { WidgetParams, defineWidget } from '@merkur/core';
+declare module '@merkur/core' {
+    interface WidgetDependencies {
+        render: typeof render;
+        hydrate: typeof hydrate;
+    }
+}
+/**
+ * Client Factory for creating merkur widgets with preact renderer.
+ */
+export declare function createPreactWidget({ name, version, $dependencies, viewFactory, ...restProps }: Parameters<typeof defineWidget>[0]): (widgetParams: WidgetParams) => Promise<import("@merkur/core").Widget>;

package/lib/server/factory/server.d.ts

@@ -0,0 +1,5 @@
+import { WidgetParams, defineWidget } from '@merkur/core';
+/**
+ * Server Factory for creating merkur widgets with preact renderer.
+ */
+export declare function createPreactWidget({ viewFactory, $dependencies, ...restProps }: Parameters<typeof defineWidget>[0]): (widgetParams: WidgetParams) => import("@merkur/core").Widget;

package/lib/server/server.cjs

@@ -0,0 +1,53 @@
+'use strict';
+
+var render = require('preact-render-to-string');
+var core = require('@merkur/core');
+
+/**
+ * Server Factory for creating merkur widgets with preact renderer.
+ */
+function createPreactWidget({ viewFactory, $dependencies, ...restProps }) {
+    return (widgetParams) => core.createMerkurWidget({
+        ...restProps,
+        ...widgetParams,
+        $dependencies: {
+            ...$dependencies,
+            // @ts-expect-error conflict with client types
+            render,
+        },
+        async mount(widget) {
+            const { render } = widget.$dependencies;
+            const { View: MainView, ErrorView, slot = {}, } = await viewFactory(widget);
+            /**
+             * Wrapper around $dependencies.render function which
+             * handles connection to ErrorView and error plugin when defined.
+             */
+            const renderView = (View) => {
+                // @ts-expect-error the @merkur/plugin-error is optional
+                if (widget?.error?.status && ErrorView) {
+                    // @ts-expect-error conflict with client types
+                    return render(ErrorView(widget));
+                }
+                // @ts-expect-error the @merkur/plugin-error is optional
+                if (widget?.error?.status) {
+                    // @ts-expect-error conflict with client types
+                    return render(null);
+                }
+                // @ts-expect-error conflict with client types
+                return render(View(widget));
+            };
+            return {
+                html: renderView(MainView),
+                slot: Object.keys(slot).reduce((acc, cur) => {
+                    acc[cur] = {
+                        name: slot[cur].name,
+                        html: renderView(slot[cur].View),
+                    };
+                    return acc;
+                }, {}),
+            };
+        },
+    });
+}
+
+exports.createPreactWidget = createPreactWidget;

package/lib/server/server.d.ts

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

package/lib/server/server.js

@@ -0,0 +1,53 @@
+'use strict';
+
+var render = require('preact-render-to-string');
+var core = require('@merkur/core');
+
+/**
+ * Server Factory for creating merkur widgets with preact renderer.
+ */
+function createPreactWidget({ viewFactory, $dependencies, ...restProps }) {
+    return (widgetParams) => core.createMerkurWidget({
+        ...restProps,
+        ...widgetParams,
+        $dependencies: {
+            ...$dependencies,
+            // @ts-expect-error conflict with client types
+            render,
+        },
+        async mount(widget) {
+            const { render } = widget.$dependencies;
+            const { View: MainView, ErrorView, slot = {}, } = await viewFactory(widget);
+            /**
+             * Wrapper around $dependencies.render function which
+             * handles connection to ErrorView and error plugin when defined.
+             */
+            const renderView = (View) => {
+                // @ts-expect-error the @merkur/plugin-error is optional
+                if (widget?.error?.status && ErrorView) {
+                    // @ts-expect-error conflict with client types
+                    return render(ErrorView(widget));
+                }
+                // @ts-expect-error the @merkur/plugin-error is optional
+                if (widget?.error?.status) {
+                    // @ts-expect-error conflict with client types
+                    return render(null);
+                }
+                // @ts-expect-error conflict with client types
+                return render(View(widget));
+            };
+            return {
+                html: renderView(MainView),
+                slot: Object.keys(slot).reduce((acc, cur) => {
+                    acc[cur] = {
+                        name: slot[cur].name,
+                        html: renderView(slot[cur].View),
+                    };
+                    return acc;
+                }, {}),
+            };
+        },
+    });
+}
+
+exports.createPreactWidget = createPreactWidget;

package/lib/server/server.mjs

@@ -0,0 +1,51 @@
+import render from 'preact-render-to-string';
+import { createMerkurWidget } from '@merkur/core';
+
+/**
+ * Server Factory for creating merkur widgets with preact renderer.
+ */
+function createPreactWidget({ viewFactory, $dependencies, ...restProps }) {
+    return (widgetParams) => createMerkurWidget({
+        ...restProps,
+        ...widgetParams,
+        $dependencies: {
+            ...$dependencies,
+            // @ts-expect-error conflict with client types
+            render,
+        },
+        async mount(widget) {
+            const { render } = widget.$dependencies;
+            const { View: MainView, ErrorView, slot = {}, } = await viewFactory(widget);
+            /**
+             * Wrapper around $dependencies.render function which
+             * handles connection to ErrorView and error plugin when defined.
+             */
+            const renderView = (View) => {
+                // @ts-expect-error the @merkur/plugin-error is optional
+                if (widget?.error?.status && ErrorView) {
+                    // @ts-expect-error conflict with client types
+                    return render(ErrorView(widget));
+                }
+                // @ts-expect-error the @merkur/plugin-error is optional
+                if (widget?.error?.status) {
+                    // @ts-expect-error conflict with client types
+                    return render(null);
+                }
+                // @ts-expect-error conflict with client types
+                return render(View(widget));
+            };
+            return {
+                html: renderView(MainView),
+                slot: Object.keys(slot).reduce((acc, cur) => {
+                    acc[cur] = {
+                        name: slot[cur].name,
+                        html: renderView(slot[cur].View),
+                    };
+                    return acc;
+                }, {}),
+            };
+        },
+    });
+}
+
+export { createPreactWidget };

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@merkur/preact",
+  "version": "0.35.0",
+  "description": "Collection of helpers to aid with Preact integration to @merkur",
+  "scripts": {
+    "test": "echo 'Tests pass.'",
+    "test:es:version": "echo 'Tests pass.'",
+    "build": "rollup -c rollup.config.mjs",
+    "prepare": "npm run build",
+    "dev": "rollup -c rollup.config.mjs -w"
+  },
+  "exports": {
+    "./entries/client.js": "./entries/client.js",
+    "./entries/server.js": "./entries/server.js",
+    "./webpack": "./webpack/index.js",
+    "./cli": "./cli/index.mjs",
+    "./client": {
+      "types": "./lib/client/client.d.ts",
+      "import": "./lib/client/client.mjs",
+      "require": "./lib/client/client.cjs"
+    },
+    "./server": {
+      "types": "./lib/server/server.d.ts",
+      "import": "./lib/server/server.mjs",
+      "require": "./lib/server/server.cjs"
+    }
+  },
+  "keywords": [
+    "merkur",
+    "preact",
+    "micro",
+    "frontend"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mjancarik/merkur.git"
+  },
+  "author": "Jan Šimeček",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/mjancarik/merkur/issues"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "dependencies": {
+    "@babel/preset-react": "^7.24.1",
+    "preact": "^10.20.1",
+    "preact-render-to-string": "^6.4.1"
+  },
+  "peerDependencies": {
+    "@merkur/core": ">=0.34",
+    "@merkur/plugin-component": ">=0.34",
+    "@merkur/tool-webpack": ">=0.28",
+    "babel-loader": ">=9"
+  },
+  "gitHead": "383f29bdf67a7f4252876867687371a8d26f53f2"
+}

package/webpack/index.js

@@ -0,0 +1,71 @@
+const { createCacheKey } = require('@merkur/tool-webpack');
+const path = require('path');
+const fs = require('fs');
+
+function applyBabelLoader(config, { isProduction, environment, cache }) {
+  config.module.rules.push({
+    test: /\.(js|ts|tsx|mjs|jsx)$/,
+    exclude: (modulePath) =>
+      /node_modules/.test(modulePath) &&
+      !/node_modules\/(abort-controller|event-target-shim)/.test(modulePath),
+    use: {
+      loader: 'babel-loader',
+      options: {
+        presets: [
+          [
+            '@babel/preset-react',
+            {
+              runtime: 'automatic',
+              importSource: 'preact',
+              development: !isProduction,
+            },
+          ],
+        ],
+        cacheIdentifier: createCacheKey(
+          environment,
+          config?.name,
+          ...(cache?.versionDependencies ?? []),
+        ),
+        cacheDirectory: true,
+        cacheCompression: false,
+        compact: isProduction,
+        sourceMaps: !isProduction,
+        inputSourceMap: !isProduction,
+      },
+    },
+  });
+
+  return config;
+}
+
+function applyPreactConfig(config, { cwd, isServer }) {
+  // Check for existence of widget entry points
+  if (
+    config.entry.widget &&
+    fs.existsSync(path.join(cwd, config.entry.widget))
+  ) {
+    return config;
+  }
+
+  // TODO should probably be moved to root config, when all frameworks are supported
+  // Set custom aliases to widget entry point
+  config.resolve = {
+    ...config.resolve,
+    alias: {
+      '@widget': path.join(cwd, './src/widget.js'),
+      ...config.resolve.alias,
+    },
+  };
+
+  // Add default client/server entries if there are no custom ones
+  config.entry.widget = require.resolve(
+    `@merkur/preact/entries/${isServer ? 'server' : 'client'}.js`,
+  );
+
+  return config;
+}
+
+module.exports = {
+  applyBabelLoader,
+  applyPreactConfig,
+};