chayns-api 1.0.0

package/.babelrc

@@ -0,0 +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"
+            ]
+        }
+    }
+}

package/.eslintrc

@@ -0,0 +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"
+    }
+}

package/.github/workflows/deploy_docs.yml

@@ -0,0 +1,28 @@
+name: Deploy Docs to GitHub Pages
+
+on:
+  push:
+    paths:
+      - "website/**"
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v2
+
+      - name: Use Node 16
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16
+
+      - 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/LICENSE

@@ -0,0 +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.

package/README.md

@@ -0,0 +1,47 @@
+# [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>
+    );
+}
+```
+
+## Getting started
+
+More information to setup chayns-api can be found in the [documentation](https://tobitsoftware.github.io/chayns-api/docs).
+
+
+## License

package/dist/cjs/calls/dialogs/alert.js

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.alert = alert;
+var _chaynsDialog = require("./chaynsDialog");
+function alert(title = '', message = '') {
+  return (0, _chaynsDialog.chaynsDialog)({
+    'dialog': {
+      title,
+      message,
+      'buttons': [{
+        'text': _chaynsDialog.buttonText.OK,
+        'buttonType': _chaynsDialog.buttonType.POSITIVE
+      }]
+    }
+  });
+}

package/dist/cjs/calls/dialogs/chaynsDialog.js

@@ -0,0 +1,59 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.buttonType = exports.buttonText = void 0;
+exports.chaynsDialog = chaynsDialog;
+exports.dialogAction = void 0;
+var _open = require("./open");
+var _callback = require("./utils/callback");
+const buttonText = {
+  'YES': {
+    'de': 'Ja',
+    'en': 'Yes',
+    'nl': 'Ja'
+  }['de'] || 'Yes',
+  // TODO: Language
+  'NO': {
+    'de': 'Nein',
+    'en': 'No',
+    'nl': 'Nee'
+  }['de'] || 'No',
+  'OK': 'OK',
+  'CANCEL': {
+    'de': 'Abbrechen',
+    'en': 'Cancel',
+    'nl': 'Annuleren'
+  }['de'] || 'Cancel'
+};
+exports.buttonText = buttonText;
+const buttonType = {
+  'CANCEL': -1,
+  'NEGATIVE': 0,
+  'POSITIVE': 1
+};
+exports.buttonType = buttonType;
+const dialogAction = {
+  'ALERT_CONFIRM': 178,
+  'INPUT': 173,
+  'SELECT': 174,
+  'DATE': 175,
+  'ADVANCED_DATE': 176,
+  'DROP_UP_ALERT': 177,
+  'MEDIA_SELECT': 179,
+  'FILE_SELECT': 180,
+  'SIGNATURE': 181,
+  'IFRAME': 191
+};
+exports.dialogAction = dialogAction;
+function chaynsDialog(config) {
+  const callbackName = 'chaynsDialog';
+  config.callback = (0, _callback.getCallbackName)(callbackName);
+  if (config.dialog) {
+    config.dialog.callType = dialogAction.ALERT_CONFIRM;
+    // @ts-ignore
+    return (0, _open.open)(config.dialog).then(data => Promise.resolve(data.selection ? data : data.buttonType));
+  }
+  return "unsupported";
+}

package/dist/cjs/calls/dialogs/close.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.close = close;
+var _index = require("../index");
+function close() {
+  return (0, _index.invokeDialogCall)({
+    action: 113,
+    value: {}
+  });
+}

package/dist/cjs/calls/dialogs/communication.js

@@ -0,0 +1,71 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.addDialogDataListener = addDialogDataListener;
+exports.removeDialogDataListener = removeDialogDataListener;
+exports.sendData = sendData;
+var _index = require("../index");
+// @ts-nocheck
+
+function sendData(data, isApiEvent) {
+  return (0, _index.invokeDialogCall)({
+    action: 218,
+    value: {
+      data,
+      isApiEvent
+    }
+  });
+}
+const listeners = [];
+const apiListeners = [];
+function _dialogDataListener(e = {}) {
+  if (!e.data || !e.data.action && typeof e.data !== 'string') {
+    return;
+  }
+  const messageObj = e.data.action ? e.data : JSON.parse(e.data.match(/(\{(?:.*)\})/)[0]);
+  if (messageObj.action === 218) {
+    const {
+      data
+    } = messageObj.value;
+    if (messageObj.value.isApiEvent) {
+      apiListeners.forEach(listener => {
+        listener(data);
+      });
+    } else {
+      listeners.forEach(listener => {
+        listener(data);
+      });
+    }
+  }
+}
+function addDialogDataListener(callback, getApiEvents = false) {
+  if (listeners.length === 0 || apiListeners.length === 0) {
+    window.addEventListener('message', _dialogDataListener);
+  }
+  if (getApiEvents) {
+    apiListeners.push(callback);
+  } else {
+    listeners.push(callback);
+  }
+  return true;
+}
+function removeDialogDataListener(callback, getApiEvents = false) {
+  let index;
+  if (getApiEvents) {
+    index = apiListeners.indexOf(callback);
+    if (index !== -1) {
+      apiListeners.splice(index, 1);
+    }
+  } else {
+    index = listeners.indexOf(callback);
+    if (index !== -1) {
+      listeners.splice(index, 1);
+    }
+  }
+  if (listeners.length === 0 && apiListeners.length === 0) {
+    window.removeEventListener('message', _dialogDataListener);
+  }
+  return index !== -1;
+}

package/dist/cjs/calls/dialogs/confirm.js

@@ -0,0 +1,33 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.confirm = confirm;
+var _chaynsDialog = require("./chaynsDialog");
+function confirm(title = '', message = '', config = {}) {
+  // backward compatibility
+  if (Array.isArray(config)) {
+    config = {
+      'buttons': config
+    };
+  }
+  if (!config.buttons || !Array.isArray(config.buttons)) {
+    config.buttons = [{
+      'text': _chaynsDialog.buttonText.YES,
+      'buttonType': _chaynsDialog.buttonType.POSITIVE
+    }, {
+      'text': _chaynsDialog.buttonText.NO,
+      'buttonType': _chaynsDialog.buttonType.NEGATIVE
+    }];
+  }
+  return (0, _chaynsDialog.chaynsDialog)({
+    'dialog': {
+      title,
+      message,
+      'buttons': config.buttons,
+      'links': config.links,
+      'select': config.select
+    }
+  });
+}

package/dist/cjs/calls/dialogs/date.js

@@ -0,0 +1,187 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.advancedDate = advancedDate;
+exports.date = date;
+exports.dateType = void 0;
+var _chaynsDialog = require("./chaynsDialog");
+var _is = require("./utils/is");
+var _open = require("./open");
+var _index = require("../index");
+function date(config = {}) {
+  let {
+      preSelect,
+      minDate,
+      maxDate,
+      title,
+      message,
+      minuteInterval,
+      autoSelectDate
+    } = config,
+    type = config.dateType || dateType.DATE;
+
+  // This will fix the iOS problem with not preselectedDate without user interaction. That it return the wrog time.
+  const {
+    os,
+    app
+  } = (0, _index.getDevice)();
+  if (minuteInterval && minuteInterval > 1 && os === 'iOS' && app) {
+    preSelect = roundInterval(preSelect, minuteInterval);
+  } else {
+    preSelect = validateValue(preSelect);
+  }
+  minDate = validateValue(minDate);
+  maxDate = validateValue(maxDate);
+  let buttons = [];
+  buttons = [{
+    'text': _chaynsDialog.buttonText.OK,
+    'buttonType': _chaynsDialog.buttonType.POSITIVE
+  }];
+  return (0, _open.open)({
+    'callType': _chaynsDialog.dialogAction.DATE,
+    type,
+    'selectedDate': preSelect,
+    minDate,
+    maxDate,
+    title,
+    message,
+    buttons,
+    minuteInterval,
+    autoSelectDate
+  }).then(data => {
+    // @ts-ignore
+    return Promise.resolve(data.selectedDate);
+  });
+}
+function advancedDate(config = {}) {
+  let {
+      preSelect,
+      minDate,
+      maxDate,
+      title,
+      message,
+      minuteInterval,
+      buttons,
+      multiselect,
+      disabledDates,
+      textBlocks,
+      monthSelect,
+      yearSelect,
+      interval,
+      maxInterval,
+      minInterval,
+      disabledIntervals,
+      disabledWeekDayIntervals,
+      getLocalTime,
+      autoSelectDate
+    } = config,
+    // minInterval and maxInterval in minutes
+    type = config.dateType || dateType.DATE;
+  minDate = validateValue(minDate);
+  maxDate = validateValue(maxDate);
+  const {
+    os,
+    app
+  } = (0, _index.getDevice)();
+  if (!preSelect) preSelect = {};
+  if (Array.isArray(preSelect)) {
+    preSelect = preSelect.map(p => validateValue(p));
+  } else if ((0, _is.isObject)(preSelect)) {
+    if (preSelect.start && preSelect.end) {
+      if (minuteInterval && minuteInterval > 1 && os === 'iOS' && app) {
+        preSelect = [roundInterval(preSelect.start, minuteInterval), roundInterval(preSelect.end, minuteInterval)];
+      } else {
+        preSelect = [validateValue(preSelect.start), validateValue(preSelect.end)];
+      }
+    }
+  } else {
+    // This will fix the iOS problem with not preselectedDate without user interaction. That it return the wrong time.
+    // eslint-disable-next-line no-lonely-if
+    if (minuteInterval && minuteInterval > 1 && os === 'iOS' && app) {
+      preSelect = roundInterval(preSelect, minuteInterval);
+    } else {
+      preSelect = validateValue(preSelect);
+    }
+  }
+  if (Array.isArray(disabledDates)) {
+    disabledDates = disabledDates.map(d => validateValue(d));
+  }
+  if (!buttons || !Array.isArray(buttons)) {
+    buttons = [{
+      'text': _chaynsDialog.buttonText.OK,
+      'buttonType': _chaynsDialog.buttonType.POSITIVE
+    }];
+  }
+  return (0, _open.open)({
+    'callType': _chaynsDialog.dialogAction.ADVANCED_DATE,
+    type,
+    'selectedDate': Array.isArray(preSelect) ? undefined : preSelect,
+    minDate,
+    maxDate,
+    title,
+    message,
+    minuteInterval,
+    buttons,
+    multiselect,
+    'selectedDates': Array.isArray(preSelect) ? preSelect : undefined,
+    disabledDates,
+    textBlocks,
+    monthSelect,
+    yearSelect,
+    interval,
+    minInterval,
+    maxInterval,
+    disabledIntervals,
+    disabledWeekDayIntervals,
+    getLocalTime,
+    autoSelectDate
+  }).then(data => {
+    return Promise.resolve(data);
+  });
+}
+
+/**
+ * @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}}
+ */
+const dateType = {
+  'DATE': 1,
+  'TIME': 2,
+  'DATE_TIME': 3
+};
+exports.dateType = dateType;
+function validateValue(value) {
+  if (!(0, _is.isNumber)(value)) {
+    if ((0, _is.isDate)(value)) {
+      // TODO: Find out whats the purpose of parsing to int
+      return parseInt(value.getTime() / 1000 + "", 10);
+    }
+    return undefined;
+  }
+  return value;
+}
+function roundInterval(preDate = new Date(), interval) {
+  if (!(0, _is.isDate)(preDate)) {
+    if ((0, _is.isNumber)(preDate)) {
+      preDate = new Date(preDate);
+    } else {
+      return -1;
+    }
+  }
+  let minutes = preDate.getMinutes();
+  preDate.setMinutes(minutes - minutes % interval);
+  preDate.setSeconds(0);
+  // TODO: Why?
+  return parseInt(preDate.getTime() / 1000 + "", 10);
+}

package/dist/cjs/calls/dialogs/dropUpAlert.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.dropUpAlert = dropUpAlert;
+var _open = require("./open");
+var _chaynsDialog = require("./chaynsDialog");
+function dropUpAlert(dialog = {}) {
+  dialog.callType = _chaynsDialog.dialogAction.DROP_UP_ALERT;
+  return (0, _open.open)(dialog);
+}

package/dist/cjs/calls/dialogs/fileSelect.js

@@ -0,0 +1,39 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.fileSelect = fileSelect;
+exports.fileType = void 0;
+var _chaynsDialog = require("./chaynsDialog");
+var _open = require("./open");
+var _index = require("../index");
+const fileType = {
+  'IMAGE': 'image',
+  'VIDEO': 'video',
+  'AUDIO': 'audio',
+  'DOCUMENT': ['application/x-latex', 'application/x-tex', 'text/', 'application/json', 'application/pdf', 'application/msword', 'application/msexcel', 'application/mspowerpoint', 'application/vnd.ms-word', 'application/vnd.ms-excel', 'application/vnd.ms-powerpoint', 'application/vnd.openxmlformats-officedocument', 'application/vnd.oasis.opendocument']
+};
+exports.fileType = fileType;
+async function fileSelect(dialog = {}) {
+  if (!dialog.buttons || !Array.isArray(dialog.buttons)) {
+    dialog.buttons = [];
+    if (dialog.multiselect || dialog.directory) {
+      dialog.buttons.push({
+        'text': _chaynsDialog.buttonText.OK,
+        'buttonType': _chaynsDialog.buttonType.POSITIVE
+      });
+    }
+    dialog.buttons.push({
+      'text': _chaynsDialog.buttonText.CANCEL,
+      'buttonType': _chaynsDialog.buttonType.NEGATIVE
+    });
+  }
+  dialog.callType = _chaynsDialog.dialogAction.FILE_SELECT;
+  const user = (0, _index.getUser)();
+  if (!user) {
+    return (0, _index.login)();
+  }
+  dialog.chaynsToken = (await (0, _index.getAccessToken)()).accessToken;
+  return (0, _open.open)(dialog);
+}

package/dist/cjs/calls/dialogs/iFrame.js

@@ -0,0 +1,43 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports._chaynsCallResponder = _chaynsCallResponder;
+exports.iFrame = iFrame;
+var _chaynsDialog = require("./chaynsDialog");
+var _open = require("./open");
+var _communication = require("./communication");
+var _index = require("../index");
+function iFrame(dialog = {
+  url: ""
+}) {
+  if (!dialog.buttons || !Array.isArray(dialog.buttons)) {
+    dialog.buttons = [{
+      'text': _chaynsDialog.buttonText.YES,
+      'buttonType': _chaynsDialog.buttonType.POSITIVE
+    }, {
+      'text': _chaynsDialog.buttonText.NO,
+      'buttonType': _chaynsDialog.buttonType.NEGATIVE
+    }];
+  }
+  dialog.tappIframeName = window.name;
+  dialog.callType = _chaynsDialog.dialogAction.IFRAME;
+  const site = (0, _index.getSite)();
+  dialog.url = `${dialog.url}${dialog.url.indexOf('?') >= 0 ? '&' : '?'}siteId=${site.id}`;
+  (0, _communication.addDialogDataListener)(_chaynsCallResponder, true);
+  return (0, _open.open)(dialog);
+}
+function _chaynsCallResponder(obj) {
+  if (obj.call.value.callback) {
+    const call = JSON.parse(JSON.stringify(obj)); // deep copy
+    (0, _index.invokeDialogCall)(obj).then(result => {
+      (0, _communication.sendData)({
+        result,
+        call
+      }, true);
+    });
+  } else {
+    (0, _index.invokeDialogCall)(obj);
+  }
+}