chayns-api 2.1.8 → 2.1.9-0

package/.babelrc

@@ -1,31 +1,31 @@
-{
-    "env": {
-        "esm": {
-            "presets": [
-                [
-                    "@babel/preset-env",
-                    {
-                        "targets": ">0.5%, not dead, not op_mini all, chrome 71",
-                        "modules": false
-                    }
-                ],
-                "@babel/preset-react",
-                "@babel/preset-typescript"
-            ]
-        },
-        "cjs": {
-            "presets": [
-                [
-                    "@babel/preset-env",
-                    {
-                        "targets": { "node": 12 },
-                        "modules": "commonjs"
-                    }
-                ],
-                "@babel/preset-react",
-                "@babel/preset-typescript"
-            ]
-        }
-    },
-    "comments": false
-}
+{
+    "env": {
+        "esm": {
+            "presets": [
+                [
+                    "@babel/preset-env",
+                    {
+                        "targets": ">0.5%, not dead, not op_mini all, chrome 71",
+                        "modules": false
+                    }
+                ],
+                "@babel/preset-react",
+                "@babel/preset-typescript"
+            ]
+        },
+        "cjs": {
+            "presets": [
+                [
+                    "@babel/preset-env",
+                    {
+                        "targets": { "node": 12 },
+                        "modules": "commonjs"
+                    }
+                ],
+                "@babel/preset-react",
+                "@babel/preset-typescript"
+            ]
+        }
+    },
+    "comments": false
+}

package/.eslintrc

@@ -1,17 +1,17 @@
-{
-    "extends": "@chayns-toolkit",
-    "rules": {
-        "no-void": "off",
-        "react/function-component-definition": [
-            "error",
-            {
-                "namedComponents": "arrow-function",
-                "unnamedComponents": "arrow-function"
-            }
-        ],
-        "@typescript-eslint/require-await": "off",
-        "@typescript-eslint/no-explicit-any": "off",
-        "class-methods-use-this": "off",
-        "react/jsx-props-no-spreading": "off"
-    }
-}
+{
+    "extends": "@chayns-toolkit",
+    "rules": {
+        "no-void": "off",
+        "react/function-component-definition": [
+            "error",
+            {
+                "namedComponents": "arrow-function",
+                "unnamedComponents": "arrow-function"
+            }
+        ],
+        "@typescript-eslint/require-await": "off",
+        "@typescript-eslint/no-explicit-any": "off",
+        "class-methods-use-this": "off",
+        "react/jsx-props-no-spreading": "off"
+    }
+}

package/.github/workflows/deploy_docs.yml

@@ -1,28 +1,28 @@
-name: Deploy Docs to GitHub Pages
-
-on:
-  push:
-    paths:
-      - "website/**"
-  workflow_dispatch:
-
-jobs:
-  deploy:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repo
-        uses: actions/checkout@v2
-
-      - name: Use Node 20
-        uses: actions/setup-node@v1
-        with:
-          node-version: 20
-
-      - name: Build
-        run: npm run build-docs
-
-      - name: Deploy to GitHub Pages
-        uses: peaceiris/actions-gh-pages@v3
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./website/build
+name: Deploy Docs to GitHub Pages
+
+on:
+  push:
+    paths:
+      - "website/**"
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v2
+
+      - name: Use Node 20
+        uses: actions/setup-node@v1
+        with:
+          node-version: 20
+
+      - name: Build
+        run: npm run build-docs
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./website/build

package/.github/workflows/publish.yml

@@ -1,21 +1,21 @@
-name: Publish to NPM
-
-on:
-  workflow_dispatch:
-  push:
-    tags:
-      - 'v*'
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
-        with:
-          node-version: '14.21.1'
-          registry-url: https://registry.npmjs.org/
-      - run: npm install
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+name: Publish to NPM
+
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '14.21.1'
+          registry-url: https://registry.npmjs.org/
+      - run: npm install
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 Tobit.Software
-
-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.
+MIT License
+
+Copyright (c) 2022 Tobit.Software
+
+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

@@ -1,67 +1,67 @@
-# [chayns react api](https://github.com/TobitSoftware/chayns-api) · [![license](https://img.shields.io/github/license/TobitSoftware/chayns-api.svg)]() [![GitHub pull requests](https://img.shields.io/github/issues-pr/TobitSoftware/chayns-api.svg)]() [![](https://img.shields.io/github/issues-pr-closed-raw/TobitSoftware/chayns-api.svg)]()
-
-The chayns-api provides information and useful functions to your page. The information and functions are provided by react hooks and normal functions.
-A list of all functions and hooks can be found [here](https://tobitsoftware.github.io/chayns-api/docs).
-
-## Installation
-
-It is recommended to setup your new chayns page with the [create-chayns-app](https://github.com/TobitSoftware/create-chayns-app).
-
-
-### Migrate old project
-1. Install chayns-api package
-```sh
-# NPM
-$ npm install chayns-api
-
-# Yarn
-$ yarn add chayns-api
-```
-
-2. Wrap your App component with the "ChaynsProvider" component. In all components which are under the ChaynsProvider you can use hooks and chayns functions. 
-```jsx
-<ChaynsProvider>
-   <App/>
-</ChaynsProvider>
-```
-
-## Example
-
-```jsx
-import { useUser } from 'chayns-api';
-
-const FirstName = () => {
-    const user = useUser();
-
-    return (
-        <div>{user?.firstName}</div>
-    );
-}
-```
-
-## 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).
-
-## Troubleshooting
-
-```
-Can't resolve 'react-dom/client'
-```
-A warning like above can be shown when you are still using react 17.
-This can be ignored because the react 17 api is used as fallback instead.
-
-## License
+# [chayns react api](https://github.com/TobitSoftware/chayns-api) &middot; [![license](https://img.shields.io/github/license/TobitSoftware/chayns-api.svg)]() [![GitHub pull requests](https://img.shields.io/github/issues-pr/TobitSoftware/chayns-api.svg)]() [![](https://img.shields.io/github/issues-pr-closed-raw/TobitSoftware/chayns-api.svg)]()
+
+The chayns-api provides information and useful functions to your page. The information and functions are provided by react hooks and normal functions.
+A list of all functions and hooks can be found [here](https://tobitsoftware.github.io/chayns-api/docs).
+
+## Installation
+
+It is recommended to setup your new chayns page with the [create-chayns-app](https://github.com/TobitSoftware/create-chayns-app).
+
+
+### Migrate old project
+1. Install chayns-api package
+```sh
+# NPM
+$ npm install chayns-api
+
+# Yarn
+$ yarn add chayns-api
+```
+
+2. Wrap your App component with the "ChaynsProvider" component. In all components which are under the ChaynsProvider you can use hooks and chayns functions. 
+```jsx
+<ChaynsProvider>
+   <App/>
+</ChaynsProvider>
+```
+
+## Example
+
+```jsx
+import { useUser } from 'chayns-api';
+
+const FirstName = () => {
+    const user = useUser();
+
+    return (
+        <div>{user?.firstName}</div>
+    );
+}
+```
+
+## 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).
+
+## Troubleshooting
+
+```
+Can't resolve 'react-dom/client'
+```
+A warning like above can be shown when you are still using react 17.
+This can be ignored because the react 17 api is used as fallback instead.
+
+## License

package/dist/cjs/wrapper/AppWrapper.js

@@ -24,7 +24,7 @@ class AppWrapper {
   listeners = [];
   customFunctions = {};
   mapOldApiToNew(retVal) {
-    var _window, _colorMode, _window2, _AppInfo$TappSelected;
+    var _window, _window2, _AppInfo$TappSelected;
     const {
       AppInfo,
       AppUser,
@@ -90,7 +90,7 @@ class AppWrapper {
           docked: false
         },
         title: AppInfo.Title,
-        colorMode: (_colorMode = colorMode) !== null && _colorMode !== void 0 ? _colorMode : AppInfo.colorMode,
+        colorMode: colorMode !== null && colorMode !== void 0 ? colorMode : AppInfo.colorMode,
         color,
         domain: AppInfo.domain,
         font: {

package/dist/esm/wrapper/AppWrapper.js

@@ -14,7 +14,7 @@ import { isAppCallSupported } from '../util/is';
 let appWrapperDialogId = 0;
 export class AppWrapper {
   mapOldApiToNew(retVal) {
-    var _window, _colorMode, _window2, _AppInfo$TappSelected;
+    var _window, _window2, _AppInfo$TappSelected;
     const {
       AppInfo,
       AppUser,
@@ -80,7 +80,7 @@ export class AppWrapper {
           docked: false
         },
         title: AppInfo.Title,
-        colorMode: (_colorMode = colorMode) !== null && _colorMode !== void 0 ? _colorMode : AppInfo.colorMode,
+        colorMode: colorMode !== null && colorMode !== void 0 ? colorMode : AppInfo.colorMode,
         color,
         domain: AppInfo.domain,
         font: {

package/dist/types/calls/index.d.ts

@@ -4,15 +4,15 @@ import { ChaynsApiDevice, ChaynsApiSite, ChaynsReactFunctions, UserInfo } from '
  * @category Event listener
  */
 export declare const addGeoLocationListener: (value: {
-    timeout?: number | undefined;
-    silent?: boolean | undefined;
+    timeout?: number;
+    silent?: boolean;
 }, callback: (geoLocation: import("../types/IChaynsReact").GeoLocation) => void) => Promise<number>;
 /**
  * Adds a listener for scroll event by user.
  * @category Event listener
  */
 export declare const addScrollListener: (value: {
-    throttle?: number | undefined;
+    throttle?: number;
 }, callback: (result: import("../types/IChaynsReact").ScrollListenerResult) => void) => Promise<number>;
 /**
  * This method will be executed when the page gets displayed or hidden.
@@ -45,8 +45,8 @@ export declare const getAvailableSharingServices: () => Promise<import("../types
  * This method determines your location. If you want to track a route, use addGeoLocationListener.
  */
 export declare const getGeoLocation: (value: {
-    timeout?: number | undefined;
-    silent?: boolean | undefined;
+    timeout?: number;
+    silent?: boolean;
 }) => Promise<import("../types/IChaynsReact").GeoLocation>;
 /**
  * This method returns user information for a specific user.
@@ -185,7 +185,7 @@ export declare const setWaitCursor: (value: import("../types/IChaynsReact").Wait
 /**
  * Retrieves the value that is assigned to the key from a storage outside the frame
  */
-export declare const storageGetItem: <T extends string | number | object>(key: string, accessMode?: import("../types/IChaynsReact").AccessMode | undefined) => Promise<T | undefined>;
+export declare const storageGetItem: <T extends object | number | string>(key: string, accessMode?: import("../types/IChaynsReact").AccessMode | undefined) => Promise<T | undefined>;
 /**
  * Removes the value that is assigned to the key from a storage outside the frame
  */
@@ -234,13 +234,13 @@ export declare const getParameters: () => {
 export declare const getPages: () => import("../types/IChaynsReact").Page[];
 export declare const getEnvironment: () => {
     buildEnvironment: import("../types/IChaynsReact").Environment;
-    runtimeEnvironment: string | import("../types/IChaynsReact").RuntimeEnviroment;
+    runtimeEnvironment: import("../types/IChaynsReact").RuntimeEnviroment | string;
 };
 /**
  * Returns the customFunction. Prefer usage via useCustomFunction when possible
  * @param key functionName
  */
-export declare const getCustomFunction: <A extends any[], T>(key: string) => (...args: A) => Promise<T>;
+export declare const getCustomFunction: <A extends Array<any>, T>(key: string) => (...args: A) => Promise<T>;
 export declare const user: UserInfo;
 export declare const site: ChaynsApiSite;
 export declare const device: ChaynsApiDevice;
@@ -257,5 +257,5 @@ export declare const parameters: {
 export declare const pages: import("../types/IChaynsReact").Page[];
 export declare const environment: {
     buildEnvironment: import("../types/IChaynsReact").Environment;
-    runtimeEnvironment: string | import("../types/IChaynsReact").RuntimeEnviroment;
+    runtimeEnvironment: import("../types/IChaynsReact").RuntimeEnviroment | string;
 };

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

@@ -1,3 +1,2 @@
-/// <reference types="react" />
 import { IChaynsReact } from '../types/IChaynsReact';
 export declare const ChaynsContext: import("react").Context<IChaynsReact | null>;

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

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import React, { RefObject } from 'react';
 type Props = {
     innerRef?: RefObject<unknown>;
@@ -9,7 +8,7 @@ export declare const withCompatMode: <P extends Props>(Component: React.Componen
         new (props: P): {
             ref: RefObject<HTMLDivElement>;
             root: any;
-            timeout?: NodeJS.Timeout | undefined;
+            timeout?: ReturnType<typeof setTimeout>;
             componentDidMount(): void;
             componentDidUpdate(): void;
             componentWillUnmount(): void;

package/dist/types/hooks/useCustomFunction.d.ts

@@ -3,4 +3,4 @@
  * @category Hooks
  * @param key functionName
  */
-export declare const useCustomFunction: <A extends any[], T>(key: string) => (...args: A) => Promise<T>;
+export declare const useCustomFunction: <A extends Array<any>, T>(key: string) => (...args: A) => Promise<T>;

package/dist/types/hooks/useParameters.d.ts

@@ -2,4 +2,4 @@ import { ChaynsReactValues } from '../types/IChaynsReact';
 /**
  * @category Hooks
  */
-export declare const useParameters: () => ChaynsReactValues['parameters'];
+export declare const useParameters: () => ChaynsReactValues["parameters"];

package/dist/types/types/IChaynsReact.d.ts

@@ -778,7 +778,7 @@ export declare enum Language {
 export declare enum RuntimeEnviroment {
     Unknown = 0,
     ChaynsDe = 1,
-    ChaynsWeb = 2,
+    ChaynsWeb = 2,// ?
     ChaynsRuntime = 3,
     IntercomPlugin = 4,
     PagemakerPlugin = 5,

package/dist/types/util/deviceHelper.d.ts

@@ -1,6 +1,6 @@
 import { ChaynsApiDevice, ScreenSize } from '../types/IChaynsReact';
 declare const getDeviceInfo: (userAgent: string, acceptHeader: string, { imei }?: {
-    imei?: string | undefined;
+    imei?: string;
 }) => ChaynsApiDevice;
 export declare const getClientDeviceInfo: () => {
     isTouch: boolean;

package/dist/types/wrapper/AppWrapper.d.ts

@@ -9,7 +9,6 @@ export declare class AppWrapper implements IChaynsReact {
     notImplemented(call: string): void;
     counter: number;
     appCall(action: any, value?: unknown, { callback, awaitResult }?: {
-        callback: any;
         awaitResult?: boolean | undefined;
     }): Promise<unknown> | undefined;
     functions: ChaynsReactFunctions;

package/package.json

@@ -1,88 +1,81 @@
-{
-    "name": "chayns-api",
-    "version": "2.1.8",
-    "description": "new chayns api",
-    "main": "dist/cjs/index.js",
-    "module": "dist/esm/index.js",
-    "types": "dist/types/index.d.ts",
-    "exports": {
-        ".": {
-            "require": "./dist/cjs/index.js",
-            "import": "./dist/esm/index.js",
-            "types": "./dist/types/index.d.ts"
-        }
-    },
-    "keywords": [
-        "chayns",
-        "chayns-toolkit",
-        "react"
-    ],
-    "scripts": {
-        "start": "npm run dev",
-        "build:umd": "chayns-toolkit build",
-        "build:cjs": "cross-env NODE_ENV=cjs babel src --out-dir dist/cjs --extensions=.ts,.tsx",
-        "build:esm": "cross-env NODE_ENV=esm babel src --out-dir dist/esm --extensions=.ts,.tsx",
-        "build-docs": "npm i && cd website && npm i && npm run build",
-        "build:typescript": "tsc",
-        "watch:cjs": "npm run build:cjs -- --watch",
-        "watch:esm": "npm run build:esm -- --watch",
-        "watch:typescript": "tsc -w",
-        "watch": "concurrently \"npm run watch:cjs\" \"npm run watch:esm\" \"npm run watch:typescript\"",
-        "dev": "npm link && npm run watch",
-        "format": "prettier . --write",
-        "lint": "eslint src",
-        "prepublishOnly": "npm run build:cjs && npm run build:esm && npm run build:typescript",
-        "preversion": "npm run build:typescript -- --noEmit --emitDeclarationOnly false"
-    },
-    "prettier": {
-        "proseWrap": "always",
-        "singleQuote": true,
-        "tabWidth": 4
-    },
-    "eslintConfig": {
-        "extends": "@chayns-toolkit"
-    },
-    "dependencies": {
-        "@module-federation/enhanced": "^0.6.10",
-        "@module-federation/runtime": "^0.6.9",
-        "@types/semver": "^7.5.8",
-        "comlink": "4.3.1",
-        "htmlescape": "^1.1.1",
-        "lodash.throttle": "^4.1.1",
-        "prop-types": "^15.7.2",
-        "scheduler": "^0.23.0",
-        "semaphore-async-await": "^1.5.1",
-        "ua-parser-js": "^1.0.38",
-        "use-sync-external-store": "^1.4.0",
-        "util": "^0.12.5"
-    },
-    "devDependencies": {
-        "@babel/cli": "^7.24.1",
-        "@babel/core": "^7.24.4",
-        "@babel/preset-env": "^7.24.4",
-        "@babel/preset-react": "^7.24.1",
-        "@babel/preset-typescript": "^7.24.1",
-        "@chayns-toolkit/eslint-config": "^2.0.0",
-        "@testing-library/react": "^16.0.1",
-        "@types/htmlescape": "^1.1.3",
-        "@types/lodash.throttle": "^4.1.9",
-        "@types/prop-types": "^15.7.12",
-        "@types/react": "^18.2.78",
-        "@types/react-dom": "^18.2.25",
-        "@types/ua-parser-js": "^0.7.39",
-        "@typescript-eslint/parser": "^7.6.0",
-        "chayns-toolkit": "^2.0.9",
-        "concurrently": "^8.2.2",
-        "cross-env": "^7.0.3",
-        "postcss-prefix-selector": "^1.13.0",
-        "prettier": "^3.2.5",
-        "prettier-plugin-packagejson": "^2.5.0",
-        "react": "^18.3.1",
-        "react-dom": "^18.3.1",
-        "typescript": "^4.9.5"
-    },
-    "peerDependencies": {
-        "react": "^16.8 || ^17.0.1 || ^18.0.0 || ^19.0.0",
-        "react-dom": "^16.8 || ^17.0.1 || ^18.0.0 || ^19.0.0"
-    }
-}
+{
+    "name": "chayns-api",
+    "version": "2.1.9-0",
+    "description": "new chayns api",
+    "main": "dist/cjs/index.js",
+    "module": "dist/esm/index.js",
+    "types": "dist/types/index.d.ts",
+    "exports": {
+        ".": {
+            "require": "./dist/cjs/index.js",
+            "import": "./dist/esm/index.js",
+            "types": "./dist/types/index.d.ts"
+        }
+    },
+    "keywords": [
+        "chayns",
+        "chayns-toolkit",
+        "react"
+    ],
+    "scripts": {
+        "start": "npm run dev",
+        "build:umd": "chayns-toolkit build",
+        "build:cjs": "cross-env NODE_ENV=cjs babel src --out-dir dist/cjs --extensions=.ts,.tsx",
+        "build:esm": "cross-env NODE_ENV=esm babel src --out-dir dist/esm --extensions=.ts,.tsx",
+        "build-docs": "npm i && cd website && npm i && npm run build",
+        "build:typescript": "tsc",
+        "watch:cjs": "npm run build:cjs -- --watch",
+        "watch:esm": "npm run build:esm -- --watch",
+        "watch:typescript": "tsc -w",
+        "watch": "concurrently \"npm run watch:cjs\" \"npm run watch:esm\" \"npm run watch:typescript\"",
+        "dev": "npm link && npm run watch",
+        "format": "prettier . --write",
+        "lint": "eslint src",
+        "prepublishOnly": "npm run build:cjs && npm run build:esm && npm run build:typescript",
+        "preversion": "npm run build:typescript -- --noEmit"
+    },
+    "prettier": {
+        "proseWrap": "always",
+        "singleQuote": true,
+        "tabWidth": 4
+    },
+    "eslintConfig": {
+        "extends": "@chayns-toolkit"
+    },
+    "dependencies": {
+        "@module-federation/enhanced": "^0.8.9",
+        "comlink": "4.3.1",
+        "htmlescape": "^1.1.1",
+        "lodash.throttle": "^4.1.1",
+        "ua-parser-js": "^1.0.40",
+        "use-sync-external-store": "^1.4.0"
+    },
+    "devDependencies": {
+        "@babel/cli": "^7.26.4",
+        "@babel/core": "^7.26.0",
+        "@babel/preset-env": "^7.26.0",
+        "@babel/preset-react": "^7.26.3",
+        "@babel/preset-typescript": "^7.26.0",
+        "@chayns-toolkit/eslint-config": "^2.0.0",
+        "@types/htmlescape": "^1.1.3",
+        "@types/lodash.throttle": "^4.1.9",
+        "@types/prop-types": "^15.7.12",
+        "@types/react": "^18.2.78",
+        "@types/react-dom": "^18.2.25",
+        "@types/ua-parser-js": "^0.7.39",
+        "@types/use-sync-external-store": "^0.0.6",
+        "@typescript-eslint/parser": "^7.6.0",
+        "chayns-toolkit": "^2.0.13",
+        "concurrently": "^9.1.2",
+        "cross-env": "^7.0.3",
+        "prettier": "^3.4.2",
+        "prettier-plugin-packagejson": "^2.5.8",
+        "react": "^18.3.1",
+        "react-dom": "^18.3.1",
+        "typescript": "^5.7.3"
+    },
+    "peerDependencies": {
+        "react": "^16.8 || ^17.0.1 || ^18.0.0 || ^19.0.0",
+        "react-dom": "^16.8 || ^17.0.1 || ^18.0.0 || ^19.0.0"
+    }
+}

package/toolkit.config.js

@@ -1,20 +1,20 @@
-const path = require('path');
-
-module.exports = {
-    development: {
-        host: "0.0.0.0",
-        port: 8081,
-    },
-    output: {
-        singleBundle: true,
-        filename: 'chayns-api.js',
-        path: path.resolve(__dirname, 'dist'),
-    },
-    webpack(config) {
-        config.output.library = {
-            name: 'ChaynsApi',
-            type: 'umd',
-        }
-        return config;
-    }
-};
+const path = require('path');
+
+module.exports = {
+    development: {
+        host: "0.0.0.0",
+        port: 8081,
+    },
+    output: {
+        singleBundle: true,
+        filename: 'chayns-api.js',
+        path: path.resolve(__dirname, 'dist'),
+    },
+    webpack(config) {
+        config.output.library = {
+            name: 'ChaynsApi',
+            type: 'umd',
+        }
+        return config;
+    }
+};

package/tsconfig.json

@@ -1,56 +1,56 @@
-{
-  "compilerOptions": {
-    /* Basic Options */
-    "target": "ES2020",                     /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', or 'ESNEXT'. */
-    "module": "commonjs",                   /* Specify module code generation: 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
-    // "lib": [],                           /* Specify library files to be included in the compilation:  */
-    // "allowJs": true,                     /* Allow javascript files to be compiled. */
-    // "checkJs": true,                     /* Report errors in .js files. */
-    "jsx": "preserve",                   /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
-    "declaration": true,                    /* Generates corresponding '.d.ts' file. */
-    // "sourceMap": true,                   /* Generates corresponding '.map' file. */
-    // "outFile": "./",                     /* Concatenate and emit output to single file. */
-    "outDir": "dist/types",                        /* Redirect output structure to the directory. */
-    // "rootDir": "./",                     /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
-    // "removeComments": true,              /* Do not emit comments to output. */
-    "noEmit": false,                      /* Do not emit outputs. */
-    "emitDeclarationOnly": true,
-    // "importHelpers": true,               /* Import emit helpers from 'tslib'. */
-    // "downlevelIteration": true,          /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
-    // "isolatedModules": true,             /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
-    "skipLibCheck": true,
-
-    /* Strict Type-Checking Options */
-    "strict": true,                         /* Enable all strict type-checking options. */
-    "noImplicitAny": false,               /* Raise error on expressions and declarations with an implied 'any' type. */
-    // "strictNullChecks": true,            /* Enable strict null checks. */
-    // "noImplicitThis": true,              /* Raise error on 'this' expressions with an implied 'any' type. */
-    // "alwaysStrict": true,                /* Parse in strict mode and emit "use strict" for each source file. */
-
-    /* Additional Checks */
-    // "noUnusedLocals": true,              /* Report errors on unused locals. */
-    // "noUnusedParameters": true,          /* Report errors on unused parameters. */
-    // "noImplicitReturns": true,           /* Report error when not all code paths in function return a value. */
-    // "noFallthroughCasesInSwitch": true,  /* Report errors for fallthrough cases in switch statement. */
-
-    /* Module Resolution Options */
-     "moduleResolution": "node",          /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
-     "baseUrl": "./",                     /* Base directory to resolve non-absolute module names. */
-    // "paths": {},                         /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
-     "rootDirs": ["./src"],                      /* List of root folders whose combined content represents the structure of the project at runtime. */
-    // "typeRoots": [],                     /* List of folders to include type definitions from. */
-    // "types": [],                         /* Type declaration files to be included in compilation. */
-    "allowSyntheticDefaultImports": true    /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
-
-    /* Source Map Options */
-    // "sourceRoot": "./",                  /* Specify the location where debugger should locate TypeScript files instead of source locations. */
-    // "mapRoot": "./",                     /* Specify the location where debugger should locate map files instead of generated locations. */
-    // "inlineSourceMap": true,             /* Emit a single file with source maps instead of having a separate file. */
-    // "inlineSources": true,               /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
-
-    /* Experimental Options */
-    // "experimentalDecorators": true,      /* Enables experimental support for ES7 decorators. */
-    // "emitDecoratorMetadata": true,       /* Enables experimental support for emitting type metadata for decorators. */
-  },
-  "exclude": ["node_modules", "**/*.spec.ts", "**/*.spec.tsx", "dist"]
-}
+{
+  "compilerOptions": {
+    /* Basic Options */
+    "target": "ES2020",                     /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', or 'ESNEXT'. */
+    "module": "commonjs",                   /* Specify module code generation: 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
+    // "lib": [],                           /* Specify library files to be included in the compilation:  */
+    // "allowJs": true,                     /* Allow javascript files to be compiled. */
+    // "checkJs": true,                     /* Report errors in .js files. */
+    "jsx": "preserve",                   /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+    "declaration": true,                    /* Generates corresponding '.d.ts' file. */
+    // "sourceMap": true,                   /* Generates corresponding '.map' file. */
+    // "outFile": "./",                     /* Concatenate and emit output to single file. */
+    "outDir": "dist/types",                        /* Redirect output structure to the directory. */
+    // "rootDir": "./",                     /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "removeComments": true,              /* Do not emit comments to output. */
+    "noEmit": false,                      /* Do not emit outputs. */
+    "emitDeclarationOnly": true,
+    // "importHelpers": true,               /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,          /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,             /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+    "skipLibCheck": true,
+
+    /* Strict Type-Checking Options */
+    "strict": true,                         /* Enable all strict type-checking options. */
+    "noImplicitAny": false,               /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,            /* Enable strict null checks. */
+    // "noImplicitThis": true,              /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                /* Parse in strict mode and emit "use strict" for each source file. */
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,              /* Report errors on unused locals. */
+    // "noUnusedParameters": true,          /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,           /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,  /* Report errors for fallthrough cases in switch statement. */
+
+    /* Module Resolution Options */
+     "moduleResolution": "node",          /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+     "baseUrl": "./",                     /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                         /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+     "rootDirs": ["./src"],                      /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                     /* List of folders to include type definitions from. */
+    // "types": [],                         /* Type declaration files to be included in compilation. */
+    "allowSyntheticDefaultImports": true    /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+
+    /* Source Map Options */
+    // "sourceRoot": "./",                  /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "./",                     /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,             /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,               /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,      /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,       /* Enables experimental support for emitting type metadata for decorators. */
+  },
+  "exclude": ["node_modules", "**/*.spec.ts", "**/*.spec.tsx", "dist"]
+}