@epam/ai-dial-modulify-ui 0.19.0-rc.0

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 2023 EPAM Systems, Inc.
+
+   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

@@ -0,0 +1,346 @@
+# Modulify Toolkit (UI)
+
+## Modulify-UI: Enhancing React Component Flexibility and Customization
+
+Modulify-UI is a React library comprised of two powerful tools, **Inversify** and **ComponentBuilder**, designed to enhance component's flexibility and simplify complex customization processes.
+
+**In short:**
+
+- **Inversify:** decouples the implementation of components to facilitate easy swapping and ensure conflict-free customization of forked code.
+- **ComponentBuilder:** structures component building with fine-grained control over state, styles, HTML, and more.
+
+If you aim to manage multiple implementations of a component, streamline customizations, or structure your component logic for enhanced maintainability, Modulify-UI's toolkit provides efficient solutions to simplify your React development workflow.
+
+### Inversify: Dynamic Component Swapping
+
+**Key Features:**
+
+- Register original components to facilitate future customization.
+- Resolve registered components and bind new implementations at runtime.
+- Seamlessly swap component implementations without modifying original source code.
+
+**Inversify** facilitates the decoupling of component implementations from their usage. By registering the original component and subsequently binding a new implementation to it during runtime, developers gain precise control over component rendering while avoiding tight coupling and code entanglement. This is particularly useful for:
+
+- A/B testing of different component variations.
+- Feature toggling to enable or disable specific implementations.
+- Adapting component's behavior based on a context (e.g., user roles, device type).
+- Customizing components in forked codebases without creating merge conflicts.
+
+#### Example
+
+Imagine you have a core component `Button` in your application that is used across different features. You foresee the need to alter its behavior or appearance in the future but want to avoid directly changing the original file of the component to keep the core codebase clean.
+
+```tsx
+import Inversify from './path/to/Inversify';
+
+import { FC } from 'react';
+
+interface ButtonProps {
+  onClick: () => void;
+  variant?: 'primary' | 'secondary';
+  children: React.ReactNode;
+}
+
+// Wrap the Button component with Inversify.register
+// This allows for future customizations without modifying this file
+const Button: FC<ButtonProps> = Inversify.register('Button', ({ onClick, variant, children }) => (
+  <button onClick={onClick} className={`button ${variant}`}>
+    {children}
+  </button>
+));
+
+// ...later in your application code...
+
+const resolvedButton = Inversify.resolve(Button.original);
+
+// Conditionally bind a different implementation, e.g., for A/B testing
+if (Math.random() > 0.5) {
+  resolvedButton.bind((originalButton) => (props) => {
+    const { variant, ...restProps } = props;
+    return <originalButton {...restProps} variant={variant === 'primary' ? 'secondary' : 'primary'} />;
+  });
+}
+
+// Render the button with the bound implementation
+const renderedButton = resolvedButton.render();
+
+const App = () => {
+  return (
+    <div>
+      <renderedButton onClick={() => console.log('Clicked!')} variant="primary">
+        Click me
+      </renderedButton>
+    </div>
+  );
+};
+
+export default App;
+```
+
+In this example, the `bind` method provides the original `Button` component as an argument to the factory function, allowing you to render it with modified props. This illustrates how you can effortlessly modify the behavior or appearance of a component without impacting its core implementation.
+
+#### `Inversify.register(name: string, component: OC)`
+
+Registers a React component, associating it with a provided name. The name is primarily used for debugging and does not affect the registration itself. Importantly, registration is done using the component's function reference, and only one original component can be registered for a given function.
+
+```tsx
+// Registering the original component with Inversify
+const MyComponent = Inversify.register('MyComponent', OriginalComponent);
+```
+
+#### `Inversify.resolve(component: OC)`
+
+Provides an interface to interact with a registered component. It returns an object with methods to:
+
+- Access the original registered component via the `original` property.
+- Retrieve the currently active implementation (original or bound) using `instance()`.
+- Bind a new implementation using `bind(factory)`. This method accepts a factory function that receives the original component as an argument and should return a new component implementation. Each call to `bind` replaces the previous factory, ensuring that only one active implementation is in effect at a time.
+- Unbind the current implementation, reverting to the original component, with `unbind()`.
+- Render the component, potentially with the bound implementation, using `render()`.
+
+```tsx
+// Accessing the original component and binding a new implementation
+const RenderedComponent = Inversify.resolve(MyComponent.original)
+  .bind((originalComponent) => (props) => (
+    // Accessing and using the original component within the factory
+    <div style={{ border: '2px solid red' }}>
+      <originalComponent {...props} />
+    </div>
+  ))
+  .render();
+
+// If you need to revert to the original component, unbind to the original
+Inversify.resolve(MyComponent.original).unbind();
+```
+
+### ComponentBuilder: Structured Component Customization
+
+**Key Features:**
+
+- Manage state, styles, HTML structure, event handlers, and side effects in a structured manner.
+- Chain customization methods for a fluent coding style.
+- Target styles and classes to both the component itself and a wrapping "host" element.
+
+**ComponentBuilder** introduces a structured pattern for building React components, promoting maintainability and simplifying complex customizations.
+
+#### Example
+
+```tsx
+import ComponentBuilder from './path/to/ComponentBuilder';
+
+import React, { FC } from 'react';
+
+const MyComponent: FC = () => (
+  <div>
+    <span data-customize-id="my-text">Hello, world!</span>
+  </div>
+);
+
+const CustomizedComponent = ComponentBuilder.use(MyComponent)
+  .updateClassNames((classNames) => ({
+    // These classes will be applied to a wrapping <div>
+    host: ['custom-class', classNames.host].flat(),
+    // These classes will be applied to the <MyComponent> element
+    component: ['another-class'],
+  }))
+  .updateStyles((styles) => ({
+    host: {
+      backgroundColor: 'lightblue',
+      ...styles.host,
+      '&:hover': {
+        // CSS selector targeting the host element
+        backgroundColor: 'blue',
+      },
+    },
+    component: {
+      fontSize: '2em', // Styles applied directly to the component
+    },
+  }))
+  .updateHTML({
+    'my-text': (children) => <a href="#">{children}</a>,
+  })
+  .build();
+```
+
+#### `ComponentBuilder.use(component: Component)`
+
+Initializes a new `ComponentBuilder` instance for a given React component, enabling subsequent customization methods to be chained.
+
+```tsx
+const builder = ComponentBuilder.use(MyComponent);
+```
+
+**ComponentBuilder** provides fine-grained control over styling and class names. You can target both the component itself and a wrapping `div` element (referred to as the "host"). This is achieved using the `component` and `host` properties within the styling and class name functions.
+
+- **Styling and Classes for the Component:** When you define styles or class names under the `component` property, they are applied directly to the root element of your component. This ensures style isolation as generated CSS class names are unique to the component.
+
+- **Styling and Classes for the Host (Wrapper):** If you need to apply styles or classes to a wrapping `div` element, use the `host` property. This is useful for controlling the layout or appearance of the component within its parent container. In most scenarios, there's no need to add a wrapping `div` element to your component, so using the `host` property should generally be unnecessary.
+
+#### `updateClassNames(updateFn)`
+
+Provides a mechanism to dynamically update the CSS classes applied to a component based on its state or other factors.
+
+```tsx
+builder.updateClassNames((classNames, state) => ({
+  host: state.isActive ? 'active' : 'inactive', // Applied to a wrapping <div>
+  component: 'my-component', // Applied to the component itself
+}));
+```
+
+#### `updateStyles(updateFn)`
+
+Enables the dynamic application and modification of inline styles based on changes in component state or props. This method leverages `react-jss` under the hood, providing the flexibility to define styles for specific CSS selectors as well.
+
+```tsx
+builder.updateStyles((styles, state) => ({
+  host: {
+    backgroundColor: state.isActive ? 'blue' : 'gray',
+    '&:hover': {
+      // CSS selector targeting the host element
+      opacity: 0.8,
+    },
+  },
+  component: {
+    // Styles applied directly to the component
+    fontSize: '1.2em',
+  },
+}));
+```
+
+#### `updateHTML(htmlContentFnOrBlocks)`
+
+Facilitates the modification of a component's internal HTML structure, enabling the addition, removal, or alteration of elements depending on specific conditions. You can provide either a single function to modify the entire HTML structure or a map of functions to target specific elements identified by the `data-customize-id` attribute.
+
+```tsx
+// Modifying the entire HTML structure
+builder.updateHTML((children, state) => (
+  <>
+    {state.showHeader && <h1>Header</h1>}
+    {children}
+  </>
+));
+
+// Targeting specific elements by data-customize-id
+builder.updateHTML({
+  'my-element-id': (children) => <div className="custom-style">{children}</div>,
+});
+```
+
+#### `updateHandlers(updateFn)`
+
+Provides a way to manage event handlers associated with a component, enabling dynamic behavior in response to state changes or external events.
+
+```tsx
+builder.updateHandlers((handlers, state, setState) => ({
+  host: {
+    onClick: () => setState({ isActive: !state.isActive }),
+  },
+}));
+```
+
+#### `addState(stateFn)`
+
+Introduces state management capabilities to a component, allowing it to maintain and update its internal data.
+
+```tsx
+builder.addState((state, setState) => {
+  // Initialize state
+  if (!state.count) {
+    setState({ count: 0 });
+  }
+
+  // Expose a method to update the state
+  return {
+    increment: () => setState((prevState) => ({ count: prevState.count + 1 })),
+  };
+});
+```
+
+#### `addEffects(effectsFn)`
+
+Facilitates the integration of side effects into a component's lifecycle, such as data fetching, API interactions, or direct DOM manipulations.
+
+```tsx
+builder.addEffects((state) => [
+  {
+    effect: () => {
+      console.log('Component mounted!');
+    },
+    dependencies: [],
+  },
+]);
+```
+
+#### `build(options)`
+
+Finalizes the component building process, consolidating all applied customizations and returning a new, enhanced React component ready for use.
+
+```tsx
+const CustomizedComponent = builder.build();
+```
+
+### Combining Inversify and ComponentBuilder for Advanced Customization
+
+This example demonstrates how to combine the power of Inversify and ComponentBuilder to achieve advanced component customization in a clean and maintainable way.
+
+```tsx
+import ComponentBuilder from './path/to/ComponentBuilder';
+import Inversify from './path/to/Inversify';
+
+import React, { FC } from 'react';
+
+interface MyComponentProps {
+  title: string;
+}
+
+const MyComponent: FC<MyComponentProps> = Inversify.register('MyComponent', ({ title }) => (
+  <div>
+    <h1>{title}</h1>
+    <p data-customize-id="content">Default content</p>
+  </div>
+));
+
+Inversify.resolve(MyComponent.original).bind((originalComponent) =>
+  ComponentBuilder.use(originalComponent)
+    .updateStyles(() => ({
+      component: {
+        border: '1px solid blue',
+        padding: '10px',
+      },
+    }))
+    .updateHTML({
+      content: () => <span>Customized content!</span>,
+    })
+    .build(),
+);
+
+// IMPORTANT: From this point onwards, any usage of MyComponent will
+// actually render the customized version created by ComponentBuilder.
+```
+
+**Explanation:**
+
+1. **Registration:** We start by wrapping our `MyComponent` with `Inversify.register`, making it customizable.
+2. **Resolution and Binding:** We use `Inversify.resolve` to access the registered component and then chain the `bind` method.
+3. **ComponentBuilder Customization:** Inside the `bind` method's factory function, we use `ComponentBuilder` to:
+   - Add a blue border and padding to the component's root element using `updateStyles`.
+   - Replace the content of the `p` tag marked with `data-customize-id="content"` using `updateHTML`.
+4. **Implicit Replacement:** The crucial point here is that we don't explicitly call `render()` after the `bind` operation. This means that Inversify will seamlessly replace all future instances of the original `MyComponent` with our customized version.
+
+This combined approach not only allows you to leverage Inversify's implementation swapping capabilities while harnessing the structured customization features of ComponentBuilder but also highlights how Inversify can be used for implicit, application-wide component modifications.
+
+This combined approach enables you to use Inversify's implementation swapping features along with the structured customization options provided by ComponentBuilder. Additionally, it emphasizes how Inversify can be employed for implicit, application-wide modifications of components.
+
+### Conclusion
+
+In conclusion, **Inversify** and **ComponentBuilder** offer powerful mechanisms to enhance the flexibility, maintainability, and customization potential of your React components. By providing tools to manage implementations, structure component logic, and simplify complex customizations, these libraries streamline the development process and promote code clarity, ultimately leading to more robust and adaptable React applications.
+
+## Contributing
+
+We invite contributions from the community to further enhance Modulify-UI! Whether you've discovered a bug, have a suggestion for improvement, or wish to contribute code, we encourage your involvement.
+
+- **Bug Reports:** Should you come across any issues or unexpected behavior, we encourage you to open an issue on our GitHub repository. Please provide a clear description of the problem and detailed steps to reproduce it.
+- **Feature Requests:** Have a great idea for a new feature or improvement? Feel free to open an issue to discuss it with the community.
+- **Code Contributions:** We welcome pull requests for bug fixes, new features, or documentation improvements. Please ensure your code follows the existing style guidelines and includes appropriate tests.
+
+We appreciate your contributions and look forward to building a robust and versatile UI toolkit together!

package/index.esm.d.ts

@@ -0,0 +1 @@
+export * from "./src/index";