PromucFlow_constructor/app/client/src/utils/CustomWidgetBuilderService.ts
balajisoundar 837d0cc76a
chore: custom widget (#28926)
## Description
This PR's adds the custom widget.

#### PR fixes following issue(s)
Fixes #28607
Fixes #28610
Fixes #28615
Fixes #28608
Fixes #28612
> if no issue exists, please create an issue and ask the maintainers
about this first
>
>
#### Media
> A video or a GIF is preferred. when using Loom, don’t embed because it
looks like it’s a GIF. instead, just link to the video
>
>
#### Type of change
- New feature (non-breaking change which adds functionality)
>
>
>
## Testing
>
#### How Has This Been Tested?
> Please describe the tests that you ran to verify your changes. Also
list any relevant details for your test configuration.
> Delete anything that is not relevant
- [ ] Manual
- [ ] JUnit
- [x] Jest
- [x] Cypress
>
>
#### Test Plan
> Add Testsmith test cases links that relate to this PR
>
>
#### Issues raised during DP testing
> Link issues raised during DP testing for better visiblity and tracking
(copy link from comments dropped on this PR)
>
>
>
## Checklist:
#### Dev activity
- [x] My code follows the style guidelines of this project
- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [x] I have added tests that prove my fix is effective or that my
feature works
- [x] New and existing unit tests pass locally with my changes
- [x] PR is being merged under a feature flag


#### QA activity:
- [ ] [Speedbreak
features](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#speedbreakers-)
have been covered
- [ ] Test plan covers all impacted features and [areas of
interest](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#areas-of-interest-)
- [ ] Test plan has been peer reviewed by project stakeholders and other
QA members
- [ ] Manually tested functionality on DP
- [ ] We had an implementation alignment call with stakeholders post QA
Round 2
- [ ] Cypress test cases have been added and approved by SDET/manual QA
- [ ] Added `Test Plan Approved` label after Cypress tests were reviewed
- [ ] Added `Test Plan Approved` label after JUnit tests were reviewed


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **New Features**
- Introduced search functionality with a wildcard option for unmatched
widget searches.
  - Added new routes for custom widget editing.
  - Implemented additional editor modes for HTML and CSS.
- Created new code templates and help components for custom widget
builders.
- Enhanced property controls with new button controls for custom widget
editing.
  - Updated theming interfaces and constants for better theming support.
- Added the CustomWidget component for embedding custom widgets in
iframes.
  - Expanded widgets library to include the CustomWidget.

- **Enhancements**
- Improved `CodeEditor` with additional modes, props, and resize
behavior.
- Enhanced `PropertyPaneControlConfig` interface with dynamic
dependencies and additional properties.
- Refined custom widget scripts with communication channel and event
handling.

- **Bug Fixes**
  - Fixed visibility logic for the `ExternalWidget` card.
  
- **Documentation**
- Added new messages and documentation links for custom widget features.

- **Tests**
- Implemented new Cypress tests for custom widget default components and
property pane interactions.
  - Updated workspace commands in Cypress tests.

- **Refactor**
- Streamlined `PropertyControl` state management and editing functions.
  - Refactored code editor hint helper logic.
  
- **Style**
  - Added `borderLess` prop to style components without borders.

- **Chores**
  - Updated constants and messages related to custom widget features.
  - Adjusted webpack configuration to ignore specific module warnings.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2023-12-28 12:16:28 +05:30

107 lines
2.6 KiB
TypeScript

interface Connection {
onMessage: (type: string, fn: (data: unknown) => void) => () => void;
postMessage: (message: unknown) => void;
window: Window | null;
}
const createChannel = (): Connection => {
const builderWindow = window.open(
`${window.location.pathname}/builder`,
"_blank",
);
const onMessageMap = new Map<string, ((data: unknown) => void)[]>();
function onMessage(type: string, fn: (data: unknown) => void) {
let eventHandlerList = onMessageMap.get(type);
if (eventHandlerList && eventHandlerList instanceof Array) {
eventHandlerList.push(fn);
} else {
eventHandlerList = [fn];
onMessageMap.set(type, eventHandlerList);
}
return () => {
if (eventHandlerList) {
const index = eventHandlerList.indexOf(fn);
if (index > -1) {
eventHandlerList.splice(index, 1);
}
}
};
}
window?.addEventListener("message", (event) => {
if (event.source === builderWindow) {
const handlerList = onMessageMap.get(event.data.type);
if (handlerList) {
handlerList.forEach((fn) => fn(event.data));
}
}
});
const postMessage = (message: unknown) => {
builderWindow?.postMessage(message, "*");
};
return {
window: builderWindow,
postMessage,
onMessage,
};
};
export default class CustomWidgetBuilderService {
private static builderWindowConnections: Map<string, Connection> = new Map();
static createConnection(widgetId: string) {
const channel = createChannel();
this.builderWindowConnections.set(widgetId, channel);
return channel;
}
static isConnected(widgetId: string) {
const connection = this.builderWindowConnections.get(widgetId);
return connection && connection.window && !connection.window.closed;
}
static focus(widgetId: string) {
if (this.isConnected(widgetId)) {
this.builderWindowConnections.get(widgetId)?.window?.focus();
}
}
static getConnection(widgetId: string) {
if (this.isConnected(widgetId)) {
const { onMessage, postMessage } = this.builderWindowConnections.get(
widgetId,
) as Connection;
return {
onMessage,
postMessage,
};
}
}
static closeConnection(widgetId: string) {
if (this.builderWindowConnections.has(widgetId)) {
const connection = this.builderWindowConnections.get(widgetId);
connection?.window?.close();
this.builderWindowConnections.delete(widgetId);
}
}
static closeAllConnections() {
this.builderWindowConnections.forEach((connection) => {
connection?.window?.close();
});
this.builderWindowConnections.clear();
}
}