sequential-workflow-designer-react 0.13.3 → 0.13.5

package/README.md

@@ -63,7 +63,7 @@ Create the global editor component:
 
 ```tsx
 function GlobalEditor() {
-  const { properties, setProperty } = useGlobalEditor();
+  const { properties, setProperty, definition } = useGlobalEditor();
 
   function onSpeedChanged(e) {
     setProperty('speed', e.target.value);
@@ -82,7 +82,7 @@ Create the step editor component:
 
 ```tsx
 function StepEditor() {
-  const { type, componentType, name, setName, properties, setProperty } = useStepEditor();
+  const { type, componentType, name, setName, properties, setProperty, definition } = useStepEditor();
 
   function onNameChanged(e) {
     setName(e.target.value);

package/lib/cjs/index.cjs

@@ -68,6 +68,7 @@ function GlobalEditorWrapperContext(props) {
     function createWrapper() {
         return {
             properties: props.definition.properties,
+            definition: props.definition,
             setProperty: setProperty
         };
     }
@@ -103,6 +104,7 @@ function StepEditorWrapperContext(props) {
             name: props.step.name,
             properties: props.step.properties,
             step: props.step,
+            definition: props.definition,
             setName: setName,
             setProperty: setProperty,
             notifyPropertiesChanged: notifyPropertiesChanged,
@@ -185,14 +187,14 @@ function SequentialWorkflowDesigner(props) {
         }
         return globalEditorRef.current(def, context);
     }
-    function stepEditorProvider(step, context) {
+    function stepEditorProvider(step, context, def) {
         if (!stepEditorRef.current) {
             throw new Error('Step editor is not provided');
         }
         if (react.isValidElement(stepEditorRef.current)) {
-            return Presenter.render(externalEditorClassName, editorRootRef, jsxRuntime.jsx(StepEditorWrapperContext, __assign({ step: step, context: context }, { children: stepEditorRef.current })));
+            return Presenter.render(externalEditorClassName, editorRootRef, jsxRuntime.jsx(StepEditorWrapperContext, __assign({ step: step, definition: def, context: context }, { children: stepEditorRef.current })));
         }
-        return stepEditorRef.current(step, context);
+        return stepEditorRef.current(step, context, def);
     }
     function customActionHandler(action, step, sequence, context) {
         if (customActionHandlerRef.current) {

package/lib/esm/index.js

@@ -66,6 +66,7 @@ function GlobalEditorWrapperContext(props) {
     function createWrapper() {
         return {
             properties: props.definition.properties,
+            definition: props.definition,
             setProperty: setProperty
         };
     }
@@ -101,6 +102,7 @@ function StepEditorWrapperContext(props) {
             name: props.step.name,
             properties: props.step.properties,
             step: props.step,
+            definition: props.definition,
             setName: setName,
             setProperty: setProperty,
             notifyPropertiesChanged: notifyPropertiesChanged,
@@ -183,14 +185,14 @@ function SequentialWorkflowDesigner(props) {
         }
         return globalEditorRef.current(def, context);
     }
-    function stepEditorProvider(step, context) {
+    function stepEditorProvider(step, context, def) {
         if (!stepEditorRef.current) {
             throw new Error('Step editor is not provided');
         }
         if (isValidElement(stepEditorRef.current)) {
-            return Presenter.render(externalEditorClassName, editorRootRef, jsx(StepEditorWrapperContext, __assign({ step: step, context: context }, { children: stepEditorRef.current })));
+            return Presenter.render(externalEditorClassName, editorRootRef, jsx(StepEditorWrapperContext, __assign({ step: step, definition: def, context: context }, { children: stepEditorRef.current })));
         }
-        return stepEditorRef.current(step, context);
+        return stepEditorRef.current(step, context, def);
     }
     function customActionHandler(action, step, sequence, context) {
         if (customActionHandlerRef.current) {

package/lib/index.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import { MutableRefObject, Context, DependencyList } from 'react';
+import { MutableRefObject, Context, ReactNode, DependencyList } from 'react';
 import ReactDOM from 'react-dom/client';
 import { Definition, GlobalEditorContext, Designer, ToolboxConfiguration, GlobalEditorProvider, StepEditorProvider, StepsConfiguration, ValidatorConfiguration, CustomActionHandler, DesignerExtension, Step, StepEditorContext } from 'sequential-workflow-designer';
 
@@ -15,14 +15,16 @@ declare global {
 }
 interface GlobalEditorWrapper<TDefinition extends Definition> {
     readonly properties: TDefinition['properties'];
+    readonly definition: TDefinition;
     setProperty(name: keyof TDefinition['properties'], value: TDefinition['properties'][typeof name]): void;
 }
 declare function useGlobalEditor<TDefinition extends Definition = Definition>(): GlobalEditorWrapper<TDefinition>;
-declare function GlobalEditorWrapperContext(props: {
-    children: JSX.Element;
+interface GlobalEditorWrapperContextProps {
+    children: ReactNode;
     definition: Definition;
     context: GlobalEditorContext;
-}): JSX.Element;
+}
+declare function GlobalEditorWrapperContext(props: GlobalEditorWrapperContextProps): JSX.Element;
 
 interface WrappedDefinition<TDefinition extends Definition = Definition> {
     readonly value: TDefinition;
@@ -85,26 +87,29 @@ declare function SequentialWorkflowDesigner<TDefinition extends Definition>(prop
 
 declare global {
     interface Window {
-        sqdStepEditorContext?: Context<StepEditorWrapper<Step> | null>;
+        sqdStepEditorContext?: Context<StepEditorWrapper | null>;
     }
 }
-interface StepEditorWrapper<TStep extends Step> {
+interface StepEditorWrapper<TStep extends Step = Step, TDefinition extends Definition = Definition> {
     readonly id: string;
     readonly type: TStep['type'];
     readonly componentType: TStep['componentType'];
     readonly name: string;
     readonly properties: TStep['properties'];
     readonly step: TStep;
+    readonly definition: TDefinition;
     setName(name: string): void;
     setProperty(name: keyof TStep['properties'], value: TStep['properties'][typeof name]): void;
     notifyPropertiesChanged(): void;
     notifyChildrenChanged(): void;
 }
-declare function useStepEditor<TStep extends Step = Step>(): StepEditorWrapper<TStep>;
-declare function StepEditorWrapperContext(props: {
-    children: JSX.Element;
+declare function useStepEditor<TStep extends Step = Step, TDefinition extends Definition = Definition>(): StepEditorWrapper<TStep, TDefinition>;
+interface StepEditorWrapperContextProps {
+    children: ReactNode;
     step: Step;
+    definition: Definition;
     context: StepEditorContext;
-}): JSX.Element;
+}
+declare function StepEditorWrapperContext(props: StepEditorWrapperContextProps): JSX.Element;
 
-export { GlobalEditorWrapper, GlobalEditorWrapperContext, Presenter, ReactToolboxConfiguration, SequentialWorkflowDesigner, SequentialWorkflowDesignerController, SequentialWorkflowDesignerProps, StepEditorWrapper, StepEditorWrapperContext, WrappedDefinition, useGlobalEditor, useSequentialWorkflowDesignerController, useStepEditor, wrapDefinition };
+export { GlobalEditorWrapper, GlobalEditorWrapperContext, GlobalEditorWrapperContextProps, Presenter, ReactToolboxConfiguration, SequentialWorkflowDesigner, SequentialWorkflowDesignerController, SequentialWorkflowDesignerProps, StepEditorWrapper, StepEditorWrapperContext, StepEditorWrapperContextProps, WrappedDefinition, useGlobalEditor, useSequentialWorkflowDesignerController, useStepEditor, wrapDefinition };

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "sequential-workflow-designer-react",
 	"description": "React wrapper for Sequential Workflow Designer component.",
-	"version": "0.13.3",
+	"version": "0.13.5",
 	"type": "module",
 	"main": "./lib/esm/index.js",
 	"types": "./lib/index.d.ts",
@@ -47,7 +47,7 @@
 	"peerDependencies": {
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0",
-		"sequential-workflow-designer": "^0.13.3"
+		"sequential-workflow-designer": "^0.13.5"
 	},
 	"devDependencies": {
 		"@rollup/plugin-node-resolve": "^15.0.1",
@@ -63,7 +63,7 @@
 		"prettier": "^2.8.2",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0",
-		"sequential-workflow-designer": "^0.13.3",
+		"sequential-workflow-designer": "^0.13.5",
 		"rollup": "^3.18.0",
 		"rollup-plugin-dts": "^5.2.0",
 		"rollup-plugin-typescript2": "^0.34.1",