@cxbox-ui/core 1.34.1

package/CONTRIBUTING.md

@@ -0,0 +1,124 @@
+# Versioning
+
+Cxbox UI follows [semver](https://semver.org/), e.g. MAJOR.MINOR.PATCH.  
+All significant changes are documented in our [changelog file](./CHANGELOG.md).  
+Backwards incompatible changes are denoted with `[BREAKING CHANGE]` mark.
+
+# Branch organization 
+
+Realeses are build from main branch, marked with a corresponding tag.  
+Minor versions and patches are merged into "develop" branch first.  
+Features and bugfixes should be named in `feat/issue-number` and `fix/issue-number` format.  
+
+# Development
+
+All changes by internal team or external contributors should be performed via public pull request.  
+All commits should be reasonably squashed before pull request will be merged (multiple commits for a single feature are not
+encouraged but acceptable when they are helpful)  
+All commits should contain a commit message with a gist of reasoning behind the change. Full description should be provided via pull
+request description.  
+All changes should correlate with our style guide, pass lint and test checks:
+```sh
+yarn check
+```
+When submitting a bugfix, unit test should be provided.
+
+# Proposing a change
+
+If you come up with a feature that looks more attractive as a library component rather than customization layer of your application, please open an issue with your proposal.  
+
+# Style guide
+
+Before commit launch prettier and eslint checks:
+
+```sh
+yarn lint --fix
+```
+
+## Naming, documentation and folder structure
+
+* Test files should be named as <testedModule>.tests.ts or <TestedComponent>.tests.ts
+* Multiple files component should store corresponding tests inside __tests__ folder. Single file component could store their test near them.
+* Reusable UI components without dependencies on Cxbox UI functionality (not connected) should be placed inside `components/ui` folder
+* Widgets should be placed inside `components/widgets` folder
+* All exportable components should be specified inside `components/index.ts` file
+* Use JSDoc comments to describe interfaces and functions when possible
+
+## React
+
+* Use React hooks to manage component state
+* Always use functional form for components. Following templates are recommended:
+
+```tsx
+// Connected component template
+import React, { useCallback } from 'react'
+import { useDispatch, useSelector } from 'react-redux'
+import cn from 'classnames'
+import { $do } from '../../actions/actions'
+import { Store } from '../../interfaces/store'
+import styles from './Component.less'
+
+export interface ComponentProps {
+    className?: string
+    bcName: string
+}
+
+export const Component = ({
+    className,
+    bcName
+}: ComponentProps) => {
+
+    const cursor = useSelector((store: Store) => store.screen.bo.bc[bcName].cursor)
+    const dispatch = useDispatch()
+
+    const handleEmptyAction = useCallback(() => {
+        dispatch($do.emptyAction(null)
+    }, [dispatch])
+    
+    const handleAction = React.useCallback(() => {
+        dispatch($do.someAction({ test: 'Test' }))
+    }, [dispatch])
+
+    return <div className={cn(styles.container, className)}>
+        <h2>Cursor - {cursor}</h2>
+        <button onClick={handleEmptyAction}>
+            Empty action
+        </button>
+        <button onClick={handleAction}>
+            Action with args
+        </button>
+    </div>
+}
+```
+
+```tsx
+// Non-connected component template
+import React from 'react'
+import cn from 'classnames'
+
+export interface ComponentProps {
+    className?: string
+}
+
+export const Component: FunctionComponent<ComponentProps> = ({ className }: ComponentProps) => {
+    return <div className={cn(styles.container, props.className)}>
+        Test
+    </div>
+}
+
+export default React.memo(Component)
+```
+
+* Always use relative paths for import statements
+* Use cn helper for complex or conditional classnames
+* Visual components should accept className as a property and apply it to the root element
+* Always specify `key` property when you render an array of components
+* Helper functions for component should be located below render function
+* Avoid renderComponentPart functions, prefer render on site or extraction into different component
+
+## CSS/LESS
+
+* Avoid nested selectors when possible
+* Avoid `!important` statement
+* Avoid id selectors, tag selectors or universal * selectors - prefer class selectors
+* Put more specific selector on the right side for complex selectors as CSS selectors checked from right to left

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2019 qnt
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/Provider.d.ts

@@ -0,0 +1,63 @@
+import React from 'react';
+import { Action, Store } from 'redux';
+import { Route } from './interfaces/router';
+import { ClientReducersMapObject, Store as CoreStore } from './interfaces/store';
+import { Location } from 'history';
+import { AxiosInstance } from 'axios';
+import { Resource, i18n } from 'i18next';
+import CustomEpics, { AnyEpic } from './interfaces/customEpics';
+import { CustomMiddlewares } from './interfaces/customMiddlewares';
+import { CustomWidgetDescriptor } from './interfaces/widget';
+export interface ProviderProps<ClientState, ClientActions> {
+    children: React.ReactNode;
+    customReducers?: ClientReducersMapObject<ClientState, ClientActions>;
+    customActions?: any;
+    customEpics?: CustomEpics | AnyEpic;
+    customMiddlewares?: CustomMiddlewares;
+    axiosInstance?: AxiosInstance;
+    customWidgets?: Record<string, CustomWidgetDescriptor>;
+    parseLocation?: (loc: Location<any>) => Route;
+    buildLocation?: (route: Route) => string;
+    useEpics?: boolean;
+    lang?: string;
+    langDictionary?: Resource;
+}
+/**
+ * @category Utils
+ */
+export declare let store: Store<CoreStore>;
+export declare let axiosInstance: AxiosInstance;
+export declare let parseLocation: (loc: Location<any>) => Route;
+export declare let buildLocation: (route: Route) => string;
+export declare let localeProviderInstance: i18n;
+/**
+ * TODO
+ *
+ * @category Utils
+ */
+export declare function getStoreInstance(): Store<CoreStore, import("redux").AnyAction>;
+/**
+ * TODO
+ *
+ * @param storeInstance
+ */
+export declare function setStoreInstance(storeInstance: Store<CoreStore>): void;
+/**
+ * TODO
+ */
+export declare function getParseLocationInstance(): (loc: Location<any>) => Route;
+/**
+ * TODO
+ */
+export declare function getBuildLocationInstance(): (route: Route) => string;
+/**
+ * @category Utils
+ */
+export declare function getLocaleProviderInstance(): i18n;
+/**
+ *
+ * @param props
+ * @category Components
+ */
+declare const Provider: <ClientState extends Partial<CoreStore>, ClientActions extends Action<any>>(props: ProviderProps<ClientState, ClientActions>) => JSX.Element;
+export default Provider;

package/README.md

@@ -0,0 +1,82 @@
+
+# Cxbox UI · [![Build status](https://github.com/CX-Box/cxbox-ui/workflows/Build/badge.svg)](https://github.com/CX-Box/cxbox-ui/actions?query=workflow%3ABuild) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=CX-Box_cxbox-ui&metric=alert_status)](https://sonarcloud.io/dashboard?id=CX-Box_cxbox-ui) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=CX-Box_cxbox-ui&metric=coverage)](https://sonarcloud.io/dashboard?id=CX-Box_cxbox-ui)
+
+
+Cxbox UI is an open source library that supplies user interaction support for Cxbox framework in form of React components, Redux reducers and redux-observable epics for handling asynchronous actions.
+More specifically that includes:
+- Major UI abstractions of Cxbox framework such as Screen, View, Widget, Field
+- Standard actions, reducers and epics for handling Cxbox API, routing and build-in controls
+- Custom <Provider> component and `connect` function to work with combined Redux store of Cxbox UI library and your own application
+- Reusable UI controls
+
+# Main concepts
+
+UI side of Cxbox framework is based on a concept of configurable dashboards ("views") with widgets. Visually widgets could be  represented as a card with a table, graph, form or something more exotic inside.
+Internally, every widget has a direct link to an entity that we call "business component" (BC). BC controls what data is displayed on widget and whhich interactions are available to the user. Interactions could be a simple filtration or some complex business process, initiated through Cxbox API.
+Information about loaded views and widgets grouped into "screens" and stored in application Redux store.
+Client applications could reuse, extend and customize that functionality by providing its own reducers and epics, widgets and ui controls.
+
+# Installation
+
+Cxbox UI distributed in form of ES5 compatible npm package:
+```sh
+yarn add @cxbox-ui/core
+```
+
+Several libraries are specified as peer dependencies and should be installed for client application: react, react-dom, redux, react-redux, rxjs, redux-observable, antd, axios. 
+
+# Usage
+
+<Provider> component provides configurable Redux context and should be used on top level of your application:
+
+```tsx
+import {Provider} from '@cxbox-ui/core'
+import {reducers} from 'reducers'
+
+const App = <Provider>
+    <div>Client side application</div>
+</Provider>
+
+render(App, document.getElementById('root'))
+```
+
+After that, components of your own application could access combined Redux store and import library components:
+
+```tsx
+import React from 'react'
+import {connect, View} from '@cxbox-ui/core'
+
+export const ClientComponent: FunctionComponent = (props: { screenName }) => {
+    const Card = (props) => <div>
+        <h1>Client side component</h1>
+        {props.children}
+    </div>
+    return <View card={Card} />
+}
+
+function mapStateToProps(store) {
+    return { screenName: store.router.screenName }
+}
+
+export default connect(mapStateToProps)(ClientComponent)
+```
+
+# Documentation
+
+The documentation is divided into several sections:
+* [Tutorial](http://idocs.cxbox.io/ui/#/screen/tutorial)
+* [Components Overview](http://idocs.cxbox.io/ui/#/screen/components)
+* [Features](http://idocs.cxbox.io/ui/#/screen/features)
+* [API Reference](https://CX-Box.github.io/cxbox-ui)
+
+You could also check our [changelog section](https://github.com/CX-Box/cxbox-ui/blob/main/CHANGELOG.md).
+
+# Reporting an error
+
+In case you've encountered a problem, please open an issue with reproducible example and detailed description.  
+If you are also willing to provide a fix, please check our [contributing guide](https://github.com/CX-Box/cxbox-ui/blob/main/CONTRIBUTING.md)!
+
+# Contributing
+
+All contributions are welcomed, as even a minor pull request with grammar fixes or a single documentation update is of a significant help for us!  
+We promise to handle all PR reviews in a friendly and respectful manner.

package/actions/actions-utils.d.ts

@@ -0,0 +1,48 @@
+/**
+ * TODO: Move to interfaces
+ *
+ * @category Actions
+ */
+export interface Action<K, P> {
+    type: K;
+    payload: P;
+}
+/**
+ * TODO: Move to interfaces
+ *
+ * @category Actions
+ */
+export declare type uActionTypesMap<A> = {
+    [key in keyof A]: key;
+};
+/**
+ * TODO: Move to interfaces
+ *
+ * @category Actions
+ */
+export declare type uActionsMap<A> = {
+    [key in keyof A]: Action<key, A[key]>;
+};
+/**
+ * TODO: Move to interfaces
+ *
+ * @category Actions
+ */
+export declare type AnyOfMap<A> = A[keyof A];
+export declare type uActionCreators<A> = {
+    [key in keyof A]: (payload: A[key]) => Action<key, A[key]>;
+};
+/**
+ * TODO
+ *
+ * @param actionObj
+ * @category Utils
+ */
+export declare function createActionCreators<A>(actionObj: A): uActionCreators<A>;
+/**
+ * TODO
+ *
+ * @param actionObj
+ * @category Utils
+ */
+export declare function createActionTypes<A>(actionObj: A): uActionTypesMap<A>;