handreyrc commented on code in PR #3252: URL: https://github.com/apache/incubator-kie-tools/pull/3252#discussion_r2342836604
########## packages/swf-editor/src/SwfEditor.tsx: ########## @@ -0,0 +1,289 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + */ + +import "@patternfly/react-core/dist/styles/base.css"; +import "reactflow/dist/style.css"; + +import * as React from "react"; +import * as ReactDOM from "react-dom"; +import * as RF from "reactflow"; +import { ErrorBoundary, ErrorBoundaryPropsWithFallback } from "react-error-boundary"; +import { useCallback, useEffect, useImperativeHandle, useMemo, useRef, useState } from "react"; +//import { original } from "immer"; +import { Diagram, DiagramRef } from "./diagram/Diagram"; +import { SwfEditorContextProvider, useSwfEditor } from "./SwfEditorContext"; +import { SwfEditorErrorFallback } from "./SwfEditorErrorFallback"; +import { ComputedStateCache } from "./store/ComputedStateCache"; +import { Computed, createSwfEditorStore, defaultStaticState } from "./store/Store"; +import { SwfEditorStoreApiContext, StoreApiType, useSwfEditorStore, useSwfEditorStoreApi } from "./store/StoreContext"; +import { SwfDiagramSvg } from "./svg/SwfDiagramSvg"; +import { useEffectAfterFirstRender } from "./useEffectAfterFirstRender"; +import { INITIAL_COMPUTED_CACHE } from "./store/computed/initial"; +import "./SwfEditor.css"; // Leave it for last, as this overrides some of the PF and RF styles. +import { Commands, CommandsContextProvider, useCommands } from "./commands/CommandsContextProvider"; +import { SwfEditorSettingsContextProvider } from "./settings/SwfEditorSettingsContext"; +import { Specification } from "@severlessworkflow/sdk-typescript"; + +const ON_MODEL_CHANGE_DEBOUNCE_TIME_IN_MS = 500; + +const SVG_PADDING = 20; + +export type SwfEditorRef = { + reset: (mode: Specification.Workflow) => void; + getDiagramSvg: () => Promise<string | undefined>; + getCommands: () => Commands; +}; + +export type EvaluationResults = Record<string, any>; +export type ValidationMessages = Record<string, any>; +export type OnSwfModelChange = (model: Specification.Workflow) => void; + +export type OnRequestToJumpToPath = (normalizedPosixPathRelativeToTheOpenFile: string) => void; +export type OnRequestToResolvePath = (normalizedPosixPathRelativeToTheOpenFile: string) => string; + +export type SwfEditorProps = { + /** + * The SWF itself. + */ + model: Specification.Workflow; + /** + * Called when a change occurs on `model`, so the controlled flow of the component can be done. + */ + onModelChange?: OnSwfModelChange; + /** + * To show information about execution results directly on the SWF diagram, use this prop. + */ + evaluationResults?: EvaluationResults; + /** + * To show information about validation messages directly on the SWF diagram, use this prop. + */ + validationMessages?: ValidationMessages; + /** + * A link that will take users to an issue tracker so they can report problems they find on the SWF Editor. + * This is shown on the ErrorBoundary fallback component, when an uncaught error happens. + */ + issueTrackerHref?: string; + /** + * A flag to enable read-only mode on the SWF Editor. + * When enabled navigation is still possible, + * but no changes can be made and the model itself is unaltered. + */ + isReadOnly?: boolean; + /** + * When users want to jump to another file, this method is called, allowing the controller of this component decide what to do. + * Links are only rendered if this is provided. Otherwise, paths will be rendered as text. + */ + onRequestToJumpToPath?: OnRequestToJumpToPath; + /** + * All paths inside the SWF Editor are relative. To be able to resolve them and display them as absolute paths, this function is called. + * If undefined, the relative paths will be displayed. + */ + onRequestToResolvePath?: OnRequestToResolvePath; + /** + * Notifies the caller when the SWF Editor performs a new edit after the debounce time. + */ + onModelDebounceStateChanged?: (changed: boolean) => void; Review Comment: @tiagobento We have subflows that would point to other files, however, it is not supported at the moment. I was considering to keep it, but I agree that it is not in use now and it makes sense to remove it. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
