Skip to content
This repository was archived by the owner on Jul 9, 2025. It is now read-only.

fix: consume sdk.schema in Flow Action title #4455

Merged
cwhitten merged 4 commits into from
Oct 21, 2020
Merged

fix: consume sdk.schema in Flow Action title #4455

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1fbce0f
consume sdk.schema in ActionHeader to resolve the title
yeze322 Oct 21, 2020
abae21a
involve formConfig overrides
yeze322 Oct 21, 2020
e1b4998
Merge branch 'main' into visual/schema-context
yeze322 Oct 21, 2020
707a04d
Merge branch 'main' into visual/schema-context
cwhitten Oct 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .../packages/adaptive-flow/__tests__/adaptive-flow-renderer/adaptive/AdaptiveDialog.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ describe('<AdaptiveDialog />', () => {
activeTrigger="triggers[0]"
dialogData={dialog}
dialogId="test"
schema={uischema}
uischema={uischema}
widgets={widgets}
onEvent={() => null}
/>
Expand Down
5 changes: 3 additions & 2 deletions Composer/packages/adaptive-flow/src/adaptive-flow-editor/AdaptiveFlowEditor.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import createCache from '@emotion/cache';
import React, { useRef, useMemo, useEffect } from 'react';
import isEqual from 'lodash/isEqual';
import formatMessage from 'format-message';
import { DialogFactory } from '@bfc/shared';
import { DialogFactory, SchemaDefinitions } from '@bfc/shared';
import { useShellApi, JSONSchema7, FlowUISchema, FlowWidget } from '@bfc/extension-client';
import { MarqueeSelection } from 'office-ui-fabric-react/lib/MarqueeSelection';

Expand Down Expand Up @@ -171,7 +171,8 @@ const VisualDesigner: React.FC<VisualDesignerProps> = ({ onFocus, onBlur, schema
NodeWrapper: VisualEditorNodeWrapper,
ElementWrapper: VisualEditorElementWrapper,
}}
schema={{ ...schemaFromPlugins, ...customFlowSchema }}
sdkschema={schema?.definitions as SchemaDefinitions}
uischema={{ ...schemaFromPlugins, ...customFlowSchema }}
widgets={widgetsFromPlugins}
onEvent={(eventName, eventData) => {
divRef.current?.focus({ preventScroll: true });
Expand Down
14 changes: 10 additions & 4 deletions Composer/packages/adaptive-flow/src/adaptive-flow-renderer/adaptive/AdaptiveDialog.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
import { jsx } from '@emotion/core';
import { FC, Fragment } from 'react';
import get from 'lodash/get';
import { FlowEditorWidgetMap, FlowUISchema } from '@bfc/extension-client';
import { FlowEditorWidgetMap, FlowUISchema, SchemaDefinitions } from '@bfc/extension-client';

import { EditorEventHandler } from '../constants/NodeEventTypes';
import { RendererContext, DefaultRenderers, RendererContextData } from '../contexts/RendererContext';
Expand All @@ -30,10 +30,14 @@ export interface AdaptiveDialogProps {
onEvent: EditorEventHandler;

/** UI schema to define how to render a sdk $kind */
schema: FlowUISchema;
uischema: FlowUISchema;

/** All available widgets to render a node */
widgets: FlowEditorWidgetMap;

/** SDK schema to define the data model of a sdk $kind */
sdkschema?: SchemaDefinitions;

renderers?: Partial<RendererContextData>;
}

Expand All @@ -42,7 +46,8 @@ export const AdaptiveDialog: FC<AdaptiveDialogProps> = ({
dialogData,
activeTrigger,
onEvent,
schema = builtinSchema,
sdkschema,
uischema = builtinSchema,
widgets = builtinWidgets,
renderers = {},
}): JSX.Element => {
Expand All @@ -55,7 +60,8 @@ export const AdaptiveDialog: FC<AdaptiveDialogProps> = ({
<SchemaContext.Provider
value={{
widgets: { ...builtinWidgets, ...widgets },
schemaProvider: new WidgetSchemaProvider(builtinSchema, schema),
schemaProvider: new WidgetSchemaProvider(builtinSchema, uischema),
sdkschema,
}}
>
<RendererContext.Provider
Expand Down
4 changes: 3 additions & 1 deletion Composer/packages/adaptive-flow/src/adaptive-flow-renderer/contexts/SchemaContext.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,18 @@
// Licensed under the MIT License.

import React from 'react';
import { FlowEditorWidgetMap } from '@bfc/extension-client';
import { FlowEditorWidgetMap, SchemaDefinitions } from '@bfc/extension-client';

import { WidgetSchemaProvider } from '../utils/visual/WidgetSchemaProvider';

export interface SchemaContextValue {
widgets: FlowEditorWidgetMap;
schemaProvider: WidgetSchemaProvider;
sdkschema?: SchemaDefinitions;
}

export const SchemaContext = React.createContext<SchemaContextValue>({
widgets: {},
schemaProvider: new WidgetSchemaProvider({ default: { widget: () => null } }),
sdkschema: {},
});
14 changes: 2 additions & 12 deletions Composer/packages/adaptive-flow/src/adaptive-flow-renderer/utils/visual/widgetRenderer.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,12 @@
// Licensed under the MIT License.

import React from 'react';
import { BaseSchema } from '@bfc/shared';
import { FlowEditorWidgetMap, FlowWidget, FlowWidgetProp, WidgetEventHandler } from '@bfc/extension-client';
import { FlowEditorWidgetMap, FlowWidget, FlowWidgetProp, WidgetContainerProps } from '@bfc/extension-client';

import { Boundary } from '../../models/Boundary';
import { evaluateWidgetProp, ActionContextKey } from '../expression/widgetExpressionEvaluator';

export interface UIWidgetContext {
/** The uniq id of current schema data. Usually a json path. */
id: string;

/** Declarative json with a $kind field. */
data: BaseSchema;

/** Handle UI events */
onEvent: WidgetEventHandler;

export interface UIWidgetContext extends WidgetContainerProps {
/** Report widget boundary */
onResize: (boundary: Boundary) => void;
}
Expand Down
3 changes: 2 additions & 1 deletion ...r/packages/adaptive-flow/src/adaptive-flow-renderer/widgets/ActionHeader/ActionHeader.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ export interface ActionHeaderProps extends WidgetContainerProps {
export const ActionHeader: WidgetComponent<ActionHeaderProps> = ({
id,
data,
adaptiveSchema,
onEvent,
title = '',
disableSDKTitle,
Expand All @@ -48,7 +49,7 @@ export const ActionHeader: WidgetComponent<ActionHeaderProps> = ({
const textCSS = disabled ? DisabledHeaderTextCSS : HeaderTextCSS(colors.color);
const iconColor = disabled ? DisabledIconColor : colors.icon;

const headerContent = disableSDKTitle ? title : generateSDKTitle(data, title);
const headerContent = disableSDKTitle ? title : generateSDKTitle(adaptiveSchema, data, title);

const { NodeMenu } = useContext(RendererContext);
const menuNode =
Expand Down
5 changes: 3 additions & 2 deletions Composer/packages/adaptive-flow/src/adaptive-flow-renderer/widgets/AdaptiveAction.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,14 @@ import { RendererContext } from '../contexts/RendererContext';
import { ElementMeasurer } from '../components/ElementMeasurer';

export const StepRenderer: FC<NodeProps> = ({ id, data, onEvent, onResize }): JSX.Element => {
const { widgets, schemaProvider } = useContext(SchemaContext);
const { widgets, schemaProvider, sdkschema } = useContext(SchemaContext);
const { NodeWrapper } = useContext(RendererContext);

const $kind = get(data, '$kind', '');
const widgetSchema = schemaProvider.get($kind);
const adaptiveSchema = get(sdkschema, $kind, {});

const content = renderUIWidget(widgetSchema, widgets, { id, data, onEvent, onResize });
const content = renderUIWidget(widgetSchema, widgets, { id, data, adaptiveSchema, onEvent, onResize });
if (widgetSchema.nowrap) {
return content;
}
Expand Down
22 changes: 19 additions & 3 deletions Composer/packages/client/src/pages/design/VisualEditor.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,14 @@

/** @jsx jsx */
import { jsx } from '@emotion/core';
import React, { useCallback, useState, useEffect } from 'react';
import React, { useCallback, useState, useEffect, useMemo } from 'react';
import formatMessage from 'format-message';
import { ActionButton } from 'office-ui-fabric-react/lib/Button';
import get from 'lodash/get';
import VisualDesigner from '@bfc/adaptive-flow';
import { useRecoilValue } from 'recoil';
import { useShellApi } from '@bfc/extension-client';
import { useFormConfig, useShellApi } from '@bfc/extension-client';
import cloneDeep from 'lodash/cloneDeep';

import grayComposerIcon from '../../images/grayComposerIcon.svg';
import {
Expand Down Expand Up @@ -72,6 +73,21 @@ const VisualEditor: React.FC<VisualEditorProps> = (props) => {

const addRef = useCallback((visualEditor) => onboardingAddCoachMarkRef({ visualEditor }), []);

const formConfig = useFormConfig();
const overridedSDKSchema = useMemo(() => {
const sdkSchema = cloneDeep(schemas.sdk?.content ?? {});
const sdkDefinitions = sdkSchema.definitions;

// Override the sdk.schema 'title' field with form ui option 'label' field
// to make sure the title is consistent with Form Editor.
Object.entries(formConfig).forEach(([$kind, formOptions]) => {
if (formOptions && sdkDefinitions[$kind]) {
sdkDefinitions[$kind].title = formOptions?.label;
}
});
return sdkSchema;
}, [formConfig, schemas]);

useEffect(() => {
const dialog = dialogs.find((d) => d.id === dialogId);
const visible = get(dialog, 'triggers', []).length === 0;
Expand All @@ -88,7 +104,7 @@ const VisualEditor: React.FC<VisualEditorProps> = (props) => {
>
<VisualDesigner
data={currentDialog.content ?? {}}
schema={schemas.sdk?.content}
schema={overridedSDKSchema}
onBlur={onBlur}
onFocus={onFocus}
/>
Expand Down
11 changes: 10 additions & 1 deletion Composer/packages/extension-client/src/types/flowSchema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
// Licensed under the MIT License.

import { FC, ComponentClass } from 'react';
import { BaseSchema, SDKKinds } from '@botframework-composer/types';
import { BaseSchema, JSONSchema7, SDKKinds } from '@botframework-composer/types';

export type FlowEditorWidgetMap = { [widgetName: string]: WidgetComponent<any> };
export enum FlowSchemaBuiltinKeys {
Expand All @@ -25,9 +25,18 @@ export type WidgetComponent<T extends WidgetContainerProps> = FC<T> | ComponentC
export type WidgetEventHandler = (eventName: string, eventData?: any) => void;

export interface WidgetContainerProps {
/** The uniq id of current schema data. Usually a json path. */
id: string;

/** Declarative json with a $kind field. */
data: BaseSchema;

/** Declarative json's schema from bot-builder sdk. */
adaptiveSchema: JSONSchema7;

/** UI events handler */
onEvent: WidgetEventHandler;

[propKey: string]: any;
}

Expand Down
9 changes: 4 additions & 5 deletions Composer/packages/lib/shared/src/viewUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,8 @@

import get from 'lodash/get';
import formatMessage from 'format-message';
import { SDKKinds } from '@botframework-composer/types';
import { JSONSchema7, SDKKinds } from '@botframework-composer/types';

import { conceptLabels as conceptLabelsFn } from './labelMap';
import { PromptTab, PromptTabTitles } from './promptTabs';

export const PROMPT_TYPES = [
Expand Down Expand Up @@ -188,13 +187,13 @@ const truncateSDKType = ($kind) => (typeof $kind === 'string' ? $kind.replace('M
* Title priority: $designer.name > title from sdk schema > customize title > $kind suffix
* @param customizedTitile customized title
*/
export function generateSDKTitle(data, customizedTitle?: string, tab?: PromptTab) {
export function generateSDKTitle(sdkschema: JSONSchema7, data, customizedTitle?: string, tab?: PromptTab) {
const $kind = get(data, '$kind');
const titleFromShared = get(conceptLabelsFn(), [$kind, 'title']);
const titleFromSDKSchema = get(sdkschema, 'title');
const titleFrom$designer = get(data, '$designer.name');
const titleFrom$kind = truncateSDKType($kind);

const title = titleFromShared || titleFrom$designer || customizedTitle || titleFrom$kind;
const title = titleFrom$designer || titleFromSDKSchema || customizedTitle || titleFrom$kind;
if (tab) {
return `${PromptTabTitles} (${title})`;
}
Expand Down