chayns-api 2.1.1 → 2.1.3-0

package/.babelrc

@@ -1,30 +1,30 @@
-{
-    "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"
-            ]
-        }
-    }
-}
+{
+    "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"
+            ]
+        }
+    }
+}

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/calls/dialogs/date.js

@@ -10,32 +10,32 @@ var _chaynsDialog = require("./chaynsDialog");
 var _is = require("./utils/is");
 var _open = require("./open");
 var _index = require("../index");
-/**
- * The config object for date dialog
- * @typedef {Object} dateConfig
- * @property {Date} preSelect  - The date object which should be preselected.
- * @property {Date} minDate   - The min date which you could select.
- * @property {Date} maxDate  - The max date which you could select.
- * @property {dateDialogType} dateType  - The type of dialog you want to display.
- * @property {number} minuteIntervall - The interval for special minutes, possible are 2, 3, 4, 5, 6, 12, 15, 20, 30. Default is 1.
- * @property {string} message - The message that is displayed above the date dialog, only in apps supported
- * @property {string} title - The title that is displayed above the message, only in apps supported
+/**
+ * The config object for date dialog
+ * @typedef {Object} dateConfig
+ * @property {Date} preSelect  - The date object which should be preselected.
+ * @property {Date} minDate   - The min date which you could select.
+ * @property {Date} maxDate  - The max date which you could select.
+ * @property {dateDialogType} dateType  - The type of dialog you want to display.
+ * @property {number} minuteIntervall - The interval for special minutes, possible are 2, 3, 4, 5, 6, 12, 15, 20, 30. Default is 1.
+ * @property {string} message - The message that is displayed above the date dialog, only in apps supported
+ * @property {string} title - The title that is displayed above the message, only in apps supported
  */
 
-/**
- * This call will open a date select dialog.
- * <div>Call: 30</div>
- * @param {dateConfig} config - Define the configuration of this call
- * @return {Promise} contains a timestamp as result
- * @example chayns.dialog.date({
- *  'dateType': chayns.dialog.dateType.DATE_TIME,
- *  'preSelect': new Date(2018, 6, 14, 0, 0, 0),
- *  'minDate':  new Date(2018, 6, 1, 15, 0, 0),
- *  'maxDate': new Date(2019, 6, 1, 0, 23, 0),
- *  'minuteInterval': 15
- * ).then(function (data) {
- *  console.log(data);
- * });
+/**
+ * This call will open a date select dialog.
+ * <div>Call: 30</div>
+ * @param {dateConfig} config - Define the configuration of this call
+ * @return {Promise} contains a timestamp as result
+ * @example chayns.dialog.date({
+ *  'dateType': chayns.dialog.dateType.DATE_TIME,
+ *  'preSelect': new Date(2018, 6, 14, 0, 0, 0),
+ *  'minDate':  new Date(2018, 6, 1, 15, 0, 0),
+ *  'maxDate': new Date(2019, 6, 1, 0, 23, 0),
+ *  'minuteInterval': 15
+ * ).then(function (data) {
+ *  console.log(data);
+ * });
  */
 
 function date(config = {}) {
@@ -170,18 +170,18 @@ function advancedDate(config = {}) {
   });
 }
 
-/**
- * @typedef {number} dateDialogType
+/**
+ * @typedef {number} dateDialogType
  */
 
-/**
- * Enum for date dialog
- * <div>DATE will open a dialog where you can select a special day</div>
- * <div>TIME will open a dialog where you can only select a special time</div>
- * <div>DATE_TIME will open a dialog where you can select a special time on a special day</div>
- * @readonly
- * @enum {dateDialogType}
- * @type {{DATE: number, TIME: number, DATE_TIME: number}}
+/**
+ * Enum for date dialog
+ * <div>DATE will open a dialog where you can select a special day</div>
+ * <div>TIME will open a dialog where you can only select a special time</div>
+ * <div>DATE_TIME will open a dialog where you can select a special time on a special day</div>
+ * @readonly
+ * @enum {dateDialogType}
+ * @type {{DATE: number, TIME: number, DATE_TIME: number}}
  */
 const dateType = exports.dateType = {
   'DATE': 1,