PromucFlow_constructor/app/client/packages/dsl/src/DSL.ts

40 lines
1.2 KiB
TypeScript
Raw Normal View History

feat: Shared Package for DSL based operations (#23894) ## Description Splitting DSL into different files when saving into git #### PR fixes following issue(s) Fixes #23763 #### Media #### Type of change - New feature (non-breaking change which adds functionality) ## Testing Manual 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 - [ ] Jest - [ ] 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 - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] PR is being merged under a feature flag #### QA activity: - [ ] [Speedbreak features](https://github.com/appsmithorg/TestSmith/wiki/Test-plan-implementation#speedbreaker-features-to-consider-for-every-change) have been covered - [ ] Test plan covers all impacted features and [areas of interest](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans/_edit#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 --------- Co-authored-by: Hetu Nandu <hetunandu@gmail.com>
2023-06-26 06:55:55 +00:00
import { ROOT_CONTAINER_WIDGET_ID } from "./constants";
import type { NormalizedSchema } from "normalizr";
import { schema, normalize, denormalize } from "normalizr";
export type NestedDSLWidget<W> = W & { children?: NestedDSLWidget<W>[] };
export type NestedDSL<W> = NestedDSLWidget<W>;
export type FlattenedDSLWidget<W> = W & { children?: string[] };
export type FlattenedDSL<W> = { [widgetId: string]: FlattenedDSLWidget<W> };
export type FlattenedDSLEntities<W> = { canvasWidgets: FlattenedDSL<W> };
// Schema by widgetId
const SCHEMA_BY_ID = new schema.Entity(
"canvasWidgets",
{},
{ idAttribute: "widgetId" },
);
SCHEMA_BY_ID.define({ children: [SCHEMA_BY_ID] });
// Normalising using widgetId
export function flattenDSL<W>(nestedDSL: NestedDSL<W>): FlattenedDSL<W> {
const {
entities,
}: NormalizedSchema<FlattenedDSLEntities<W>, string> = normalize(
nestedDSL,
SCHEMA_BY_ID,
);
return entities.canvasWidgets;
}
// Denormalising using widgetId
export function nestDSL<W>(
flattenedDSL: FlattenedDSL<W>,
widgetId: string = ROOT_CONTAINER_WIDGET_ID,
): NestedDSL<W> {
const entities = { canvasWidgets: flattenedDSL };
return denormalize(widgetId, SCHEMA_BY_ID, entities);
}