chayns-api 2.0.0 → 2.0.1

package/README.md

@@ -39,6 +39,19 @@ const FirstName = () => {
 }
 ```
 
+## Migrate v1 to v2
+
+When updating to chayns-api@2 you should also update chayns-toolkit to 3.0.1 or higher (check migration guide [here](https://github.com/TobitSoftware/chayns-toolkit/tree/main?tab=readme-ov-file#-migration-v2-to-v3)).
+
+Check urls referencing **remoteEntry.js**. The filename has been changed to **v2.remoteEntry.js**.
+
+When your application uses ChaynsHost with module-type you might have to add a call of **initModuleFederationSharing** as early as possible in your application (e.g. index/bootstrap). Unless your application is already embedded as module somewhere else (e.g. in a dialog).
+
+```
+initModuleFederationSharing({ name: 'project_name' });
+```
+
+
 ## Getting started
 
 More information to setup chayns-api can be found in the [documentation](https://tobitsoftware.github.io/chayns-api/docs).

package/dist/cjs/components/withHydrationBoundary.js

@@ -8,16 +8,19 @@ var _react = _interopRequireWildcard(require("react"));
 var _constants = require("../constants");
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
-const withHydrationBoundary = (Component, initializer, useHydrationId) => {
+function _extends() { return _extends = Object.assign ? Object.assign.bind() : function (n) { for (var e = 1; e < arguments.length; e++) { var t = arguments[e]; for (var r in t) ({}).hasOwnProperty.call(t, r) && (n[r] = t[r]); } return n; }, _extends.apply(null, arguments); }
+function withHydrationBoundary(Component, initializer, useHydrationId, useProps) {
   return ({
     id: idProp,
-    children
+    children,
+    ...rest
   }) => {
     let value;
     if (!globalThis.window) {
       value = (0, _react.useContext)(_constants.HydrationContext);
     }
     const id = useHydrationId ? useHydrationId() : idProp;
+    const props = useProps ? useProps(rest) : undefined;
     if (!id) {
       throw new Error('hydration boundary was not given a id which is required');
     }
@@ -33,7 +36,7 @@ const withHydrationBoundary = (Component, initializer, useHydrationId) => {
           initialValue = JSON.parse($elem.innerHTML);
         }
       }
-      const s = initializer(initialValue, id);
+      const s = initializer(initialValue, id, props);
       if (!globalThis.window) {
         value[id] = s;
       }
@@ -46,9 +49,9 @@ const withHydrationBoundary = (Component, initializer, useHydrationId) => {
         $elem.remove();
       }
     }, []);
-    return /*#__PURE__*/_react.default.createElement(Component, {
+    return /*#__PURE__*/_react.default.createElement(Component, _extends({}, rest, {
       value: store
-    }, children);
+    }), children);
   };
-};
+}
 var _default = exports.default = withHydrationBoundary;

package/dist/esm/components/withHydrationBoundary.js

@@ -1,16 +1,19 @@
+function _extends() { return _extends = Object.assign ? Object.assign.bind() : function (n) { for (var e = 1; e < arguments.length; e++) { var t = arguments[e]; for (var r in t) ({}).hasOwnProperty.call(t, r) && (n[r] = t[r]); } return n; }, _extends.apply(null, arguments); }
 import React, { useContext, useEffect, useState } from 'react';
 import { HydrationContext } from '../constants';
-const withHydrationBoundary = (Component, initializer, useHydrationId) => {
+function withHydrationBoundary(Component, initializer, useHydrationId, useProps) {
   return _ref => {
     let {
       id: idProp,
-      children
+      children,
+      ...rest
     } = _ref;
     let value;
     if (!globalThis.window) {
       value = useContext(HydrationContext);
     }
     const id = useHydrationId ? useHydrationId() : idProp;
+    const props = useProps ? useProps(rest) : undefined;
     if (!id) {
       throw new Error('hydration boundary was not given a id which is required');
     }
@@ -26,7 +29,7 @@ const withHydrationBoundary = (Component, initializer, useHydrationId) => {
           initialValue = JSON.parse($elem.innerHTML);
         }
       }
-      const s = initializer(initialValue, id);
+      const s = initializer(initialValue, id, props);
       if (!globalThis.window) {
         value[id] = s;
       }
@@ -39,9 +42,9 @@ const withHydrationBoundary = (Component, initializer, useHydrationId) => {
         $elem.remove();
       }
     }, []);
-    return /*#__PURE__*/React.createElement(Component, {
+    return /*#__PURE__*/React.createElement(Component, _extends({}, rest, {
       value: store
-    }, children);
+    }), children);
   };
-};
+}
 export default withHydrationBoundary;

package/dist/types/components/withHydrationBoundary.d.ts

@@ -1,17 +1,24 @@
 import React from 'react';
-type StoreLikeValue = object & {
-    getState: () => object;
+export interface StoreLikeValue<T> {
+    getState: () => T;
     abort?: () => Promise<void>;
     type?: 'raw' | 'json';
-};
-type HydrationComponent = React.FC<{
-    value: StoreLikeValue;
+}
+type HydrationComponent<T, S, U> = React.FC<T & {
+    value: U & StoreLikeValue<S>;
     children?: React.ReactNode;
 }>;
-type Initializer = (initialValue: object | undefined, id: string) => StoreLikeValue;
-type HydrationBoundary = React.FC<{
+type Initializer<T, S, U> = (initialValue: S | undefined, id: string, props: T) => U & StoreLikeValue<S>;
+type HydrationBoundary<T> = React.FC<T & {
     id?: string;
     children?: React.ReactNode;
 }>;
-declare const withHydrationBoundary: (Component: HydrationComponent, initializer: Initializer, useHydrationId: undefined | (() => string)) => HydrationBoundary;
+declare function withHydrationBoundary<P extends object, T, S>(Component: HydrationComponent<P, T, S>, initializer: Initializer<undefined, T, S>): HydrationBoundary<P & {
+    id: string;
+}>;
+declare function withHydrationBoundary<P extends object, T, S>(Component: HydrationComponent<P, T, S>, initializer: Initializer<undefined, T, S>, useHydrationId: () => string): HydrationBoundary<P>;
+declare function withHydrationBoundary<P extends object, T, S, U>(Component: HydrationComponent<P, T, S>, initializer: Initializer<U, T, S>, useHydrationId: undefined, useProps: (props: P) => U): HydrationBoundary<P & {
+    id: any;
+}>;
+declare function withHydrationBoundary<P extends object, T, S, U>(Component: HydrationComponent<P, T, S>, initializer: Initializer<U, T, S>, useHydrationId: (() => string), useProps: (props: P) => U): HydrationBoundary<P>;
 export default withHydrationBoundary;

package/dist/types/constants/hydrationContext.d.ts

@@ -1,9 +1,6 @@
 import React from 'react';
-export type HydrationContextValueType = {
-    [key: string]: {
-        getState: () => object;
-        abort?: () => Promise<void>;
-        type?: 'raw' | 'json';
-    };
+import { type StoreLikeValue } from '../components/withHydrationBoundary';
+export type HydrationContextValueType<T> = {
+    [key: string]: StoreLikeValue<T>;
 };
-export declare let HydrationContext: React.Context<HydrationContextValueType>;
+export declare let HydrationContext: React.Context<HydrationContextValueType<object>>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "chayns-api",
-    "version": "2.0.0",
+    "version": "2.0.1",
     "description": "new chayns api",
     "main": "dist/cjs/index.js",
     "module": "dist/esm/index.js",
@@ -63,7 +63,7 @@
         "@babel/preset-react": "^7.24.1",
         "@babel/preset-typescript": "^7.24.1",
         "@chayns-toolkit/eslint-config": "^2.0.0",
-        "@testing-library/react": "^12.1.2",
+        "@testing-library/react": "^16.0.1",
         "@types/htmlescape": "^1.1.3",
         "@types/lodash.throttle": "^4.1.9",
         "@types/prop-types": "^15.7.12",