eis-ui-render 0.29.2 → 0.29.4

package/LICENSE

@@ -1 +1,191 @@
-© EIS GROUP, all rights reserved.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        https://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
+
+   Copyright 2023 EIS Group LTD
+
+   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/README.md

@@ -10,107 +10,8 @@ Install the package from public npm to your project:
 yarn add eis-ui-render
 ```
 
-## Integration
-
-There are two ways to integrate UI Render:
-
-### 1. Using `dataUrl` and `metaUrl` strings
-
-- UI Render handles all `data/meta` fetching and updates for you
-
-```tsx
-// Simplified example integration with UI Builder as custom Component Slot
-import React, {useMemo} from 'react'
-import {environment} from '@eisgroup/common'
-import {RatingReportNoData} from './components'
-import {PREFIX} from '../../common/classNames'
-
-// You can name `UIRender` as whatever you like
-import UIRender from 'eis-ui-render'
-
-export namespace RatingReportSlotClasses {
-    const RATING_REPORT = 'rating-report-slot'
-    export const CONTAINER = `${PREFIX}-${RATING_REPORT}`
-}
-
-export enum ProductCodes {
-    STDMaster = 'STDMaster',
-    SMPMaster = 'SMPMaster',
-    LeaveMaster = 'LeaveMaster',
-    ACCMaster = 'ACCMaster',
-    GPLUMaster = 'GPLUMaster',
-    LTDMaster = 'LTDMaster'
-}
-
-export interface RatingReportProps {
-    revisionNo: number
-    policyNumber: string
-    productCode: ProductCodes
-    isRated: boolean
-}
-
-
-const dxpBasePath = (environment && environment.dxp && environment.dxp.basePath) || ''
-const styleUiRender = {width: '100%', marginBottom: 30, minHeight: 320}
-const MAPPED_URL_BY_PRODUCT_CODE = {
-    [ProductCodes.STDMaster]: 'backoffice-rating-std-master'
-}
-const getUrl = (productCode: ProductCodes) => MAPPED_URL_BY_PRODUCT_CODE[productCode]
-
-const RatingReport = ({revisionNo, policyNumber, productCode, isRated = false}: RatingReportProps) => {
-    const url = useMemo(() => getUrl(productCode), [productCode])
-    return (
-        <div className={RatingReportSlotClasses.CONTAINER}>
-            {!isRated ? (
-                <RatingReportNoData/>
-            ) : (
-                <UIRender
-                    style={styleUiRender}
-                    dataUrl={`${dxpBasePath}/${url}/v1/policies/${policyNumber}/${revisionNo}/rating-details`}
-                    metaUrl={`${dxpBasePath}/${url}/v1/ui-config/generate-page-structure`}
-                />
-            )}
-        </div>
-    )
-}
-
-export const RatingReportSlot = RatingReport
-```
-
-### 2. Using UIRender directly with `data` and `meta` JS objects
-
- - With this approach you need to write your own logic to handle `data/meta` fetching and updating UI Render when
-   User submits data back to backend. Check
-   this [wrapper component](https://github.com/eisgroup/ui-render/blob/master/repos/core/src/pages/eis/webstudio.js)
-   for example.
- - You must provide all props like the example code below:
-
-```tsx
-// This is as the same as: import UIRender from 'eis-ui-render'
-import {UIRender} from 'eis-ui-render'
-
-export function CashReports () {
-   //...your code logic
-   // Note: `initialValues` is required initially, and to reset all Form values inside UI Render
-   return <UIRender data={data} meta={meta} initialValues={data} onSubmit={handleSubmit}/>
-}
-
-/**
- * Function called whenever User clicks on submit button inside UI Render
- * @param {Object|Any} formValues - this is `data` object passed to <UIRender/> with User updated values
- * @returns {void}
- */
-function handleSubmit(formValues) {
-    //...your code logic
-    // You can use it to update `data`, `initialValues`, or `meta` sent to <UIRender/>,
-    // or ignore it, in which case User clicking submit button will not change anything in UI Render.
-}
-```
-
 ## Build & Deploy Steps
 
-Due to limitations in Genesis UI (no static asset folder), the build of this package has to be done and deployed manually:
-
 1. Clone this package `git clone https://github.com/eisgroup/ui-render.git`
 2. Inside `/repos/npm/` run `yarn build`
 3. Then navigate to `/repos/policy/` folder and follow `README.md` instructions

package/UIRender.d.ts

@@ -21,20 +21,16 @@ interface Props {
     translate(v: string): string;
 }
 /**
- * Thin wrapper to avoid compiling UI Render inside Genesis UI Build process,
- * because they have limited TypeScript build config that cannot process npm packages using pure JS in ES6.
- *
  * UI Render makes use of many npm packages written in pure JS using ES6 for these reasons:
  *      - Automatic tree shaking to optimize production bundle size by removing unused code imported from npm packages
  *      - IDE instant function/variable suggestions and automatic import
  *      - Easier for developers to read source code of imported npm packages, than reading compiled minified code.
  *
  * @logic:
- *      1. This Component creates an empty <div/> inside Genesis UI HTML DOM (where UI Render wil be)
+ *      1. This Component creates an empty <div/> inside HTML DOM (where UI Render will be)
  *      2. When mounted, it calls global `window._mountUIRender` method defined in `/repos/policy/src/main.js`
  *      3. Above method mounts pre-bundled UI Render to the above created <div/>, initiating UI Render instance.
  *      4. On subsequent prop changes, it passes them to UI Render via <DOMProxy/> container
- *         (this is a workaround hack for Genesis UI).
  */
 export declare class UIRender extends Component<Props, any> {
     private _id;

package/UIRender.js

@@ -58,20 +58,16 @@ exports.UIRender = void 0;
 var react_1 = __importStar(require("react"));
 var UI_RENDER = 'ui-render'; // used by css for class name
 /**
- * Thin wrapper to avoid compiling UI Render inside Genesis UI Build process,
- * because they have limited TypeScript build config that cannot process npm packages using pure JS in ES6.
- *
  * UI Render makes use of many npm packages written in pure JS using ES6 for these reasons:
  *      - Automatic tree shaking to optimize production bundle size by removing unused code imported from npm packages
  *      - IDE instant function/variable suggestions and automatic import
  *      - Easier for developers to read source code of imported npm packages, than reading compiled minified code.
  *
  * @logic:
- *      1. This Component creates an empty <div/> inside Genesis UI HTML DOM (where UI Render wil be)
+ *      1. This Component creates an empty <div/> inside HTML DOM (where UI Render will be)
  *      2. When mounted, it calls global `window._mountUIRender` method defined in `/repos/policy/src/main.js`
  *      3. Above method mounts pre-bundled UI Render to the above created <div/>, initiating UI Render instance.
  *      4. On subsequent prop changes, it passes them to UI Render via <DOMProxy/> container
- *         (this is a workaround hack for Genesis UI).
  */
 var UIRender = /** @class */ (function (_super) {
     __extends(UIRender, _super);
@@ -110,7 +106,7 @@ var UIRender = /** @class */ (function (_super) {
     };
     UIRender.prototype.render = function () {
         var _a = this.props, className = _a.className, style = _a.style;
-        return react_1.default.createElement("div", { id: this.id, "data-version": '0.29.2', className: UI_RENDER + " " + (className || ''), style: style });
+        return react_1.default.createElement("div", { id: this.id, "data-version": '0.29.4', className: UI_RENDER + " " + (className || ''), style: style });
     };
     return UIRender;
 }(react_1.Component));

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "eis-ui-render",
-  "version": "0.29.2",
-  "description": "UI Render for EIS Integration",
-  "homepage": ".",
+  "version": "0.29.4",
+  "description": "UI generation based on JSON schemas",
+  "homepage": "https://eisgroup.github.io/ui-render/",
   "sideEffects": false,
   "license": "Apache 2.0",
   "scripts": {