[Canvas] Expression shape

.eslintrc.js

@@ -446,6 +446,7 @@ module.exports = {
                   '!(src|x-pack)/plugins/**/(public|server)/mocks/index.{js,mjs,ts}',
                   '!(src|x-pack)/plugins/**/(public|server)/(index|mocks).{js,mjs,ts,tsx}',
                   '!(src|x-pack)/plugins/**/__stories__/index.{js,mjs,ts,tsx}',
+                  '!(src|x-pack)/plugins/**/__fixtures__/index.{js,mjs,ts,tsx}',
                 ],
                 allowSameFolder: true,
                 errorMessage: 'Plugins may only import from top-level public and server modules.',

.i18nrc.json

@@ -18,6 +18,7 @@
     "expressions": "src/plugins/expressions",
     "expressionError": "src/plugins/expression_error",
     "expressionRevealImage": "src/plugins/expression_reveal_image",
+    "expressionShape": "src/plugins/expression_shape",
     "inputControl": "src/plugins/input_control_vis",
     "inspector": "src/plugins/inspector",
     "inspectorViews": "src/legacy/core_plugins/inspector_views",

docs/developer/plugin-list.asciidoc

@@ -99,6 +99,10 @@ want to incorporate their own functions, types, and renderers into the service
 for use in their own application.
 
 
+|{kib-repo}blob/{branch}/src/plugins/expression_shape/README.md[expressionShape]
+|Expression Shape plugin adds a shape function to the expression plugin and an associated renderer. The renderer will display the given shape with selected decorations.
+
+
 |{kib-repo}blob/{branch}/src/plugins/home/README.md[home]
 |Moves the legacy ui/registry/feature_catalogue module for registering "features" that should be shown in the home page's feature catalogue to a service within a "home" plugin. The feature catalogue refered to here should not be confused with the "feature" plugin for registering features used to derive UI capabilities for feature controls.
 

packages/kbn-optimizer/limits.yml

@@ -114,3 +114,4 @@ pageLoadAssetSize:
   cases: 144442
   expressionError: 22127
   userSetup: 18532
+  expressionShape: 30033

src/dev/storybook/aliases.ts

@@ -19,6 +19,7 @@ export const storybookAliases = {
   embeddable: 'src/plugins/embeddable/.storybook',
   expression_error: 'src/plugins/expression_error/.storybook',
   expression_reveal_image: 'src/plugins/expression_reveal_image/.storybook',
+  expression_shape: 'src/plugins/expression_shape/.storybook',
   infra: 'x-pack/plugins/infra/.storybook',
   security_solution: 'x-pack/plugins/security_solution/.storybook',
   ui_actions_enhanced: 'x-pack/plugins/ui_actions_enhanced/.storybook',

src/plugins/expression_shape/.storybook/main.js

@@ -0,0 +1,10 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+// eslint-disable-next-line import/no-commonjs
+module.exports = require('@kbn/storybook').defaultConfig;

src/plugins/expression_shape/README.md

@@ -0,0 +1,9 @@
+# expressionShape
+
+Expression Shape plugin adds a `shape` function to the expression plugin and an associated renderer. The renderer will display the given shape with selected decorations.
+
+---
+
+## Development
+
+See the [kibana contributing guide](https://github.com/elastic/kibana/blob/master/CONTRIBUTING.md) for instructions setting up your development environment.

src/plugins/expression_shape/__fixtures__/function_specs.ts

@@ -0,0 +1,12 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import { shapeFunction } from '../common/expression_functions';
+import { ExpressionFunction } from '../../../../src/plugins/expressions';
+
+export const functionSpecs = [shapeFunction].map((fn) => new ExpressionFunction(fn()));

src/plugins/expression_shape/__fixtures__/index.ts

@@ -0,0 +1,9 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+export * from './function_specs';

src/plugins/expression_shape/common/constants.ts

@@ -0,0 +1,11 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+export const PLUGIN_ID = 'expressionShape';
+export const PLUGIN_NAME = 'expressionShape';
+export const SVG = 'SVG';

src/plugins/expression_shape/common/expression_functions/index.ts

@@ -0,0 +1,9 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+export { shapeFunction } from './shape_function';

src/plugins/expression_shape/common/expression_functions/shape_function.ts

@@ -0,0 +1,106 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import { i18n } from '@kbn/i18n';
+import { ExpressionShapeFunction, Shape } from '../types';
+import { SVG } from '../constants';
+import { getAvailableShapes } from '../lib';
+
+export const strings = {
+  help: i18n.translate('expressionShape.functions.shapeHelpText', {
+    defaultMessage: 'Creates a shape.',
+  }),
+  args: {
+    shape: i18n.translate('expressionShape.functions.shape.args.shapeHelpText', {
+      defaultMessage: 'Pick a shape.',
+    }),
+    border: i18n.translate('expressionShape.functions.shape.args.borderHelpText', {
+      defaultMessage: 'An {SVG} color for the border outlining the shape.',
+      values: {
+        SVG,
+      },
+    }),
+    borderWidth: i18n.translate('expressionShape.functions.shape.args.borderWidthHelpText', {
+      defaultMessage: 'The thickness of the border.',
+    }),
+    fill: i18n.translate('expressionShape.functions.shape.args.fillHelpText', {
+      defaultMessage: 'An {SVG} color to fill the shape.',
+      values: {
+        SVG,
+      },
+    }),
+    maintainAspect: i18n.translate('expressionShape.functions.shape.args.maintainAspectHelpText', {
+      defaultMessage: `Maintain the shape's original aspect ratio?`,
+    }),
+  },
+};
+
+export const errors = {
+  invalidShape: (shape: string) =>
+    new Error(
+      i18n.translate('expressionShape.functions.shape.invalidShapeErrorMessage', {
+        defaultMessage: "Invalid value: '{shape}'. Such a shape doesn't exist.",
+        values: {
+          shape,
+        },
+      })
+    ),
+};
+
+export const shapeFunction: ExpressionShapeFunction = () => {
+  const { help, args: argHelp } = strings;
+
+  return {
+    name: 'shape',
+    aliases: [],
+    inputTypes: ['null'],
+    help,
+    args: {
+      shape: {
+        types: ['string'],
+        help: argHelp.shape,
+        aliases: ['_'],
+        default: 'square',
+        options: Object.values(Shape),
+      },
+      border: {
+        types: ['string'],
+        aliases: ['stroke'],
+        help: argHelp.border,
+      },
+      borderWidth: {
+        types: ['number'],
+        aliases: ['strokeWidth'],
+        help: argHelp.borderWidth,
+        default: 0,
+      },
+      fill: {
+        types: ['string'],
+        help: argHelp.fill,
+        default: 'black',
+      },
+      maintainAspect: {
+        types: ['boolean'],
+        help: argHelp.maintainAspect,
+        default: false,
+        options: [true, false],
+      },
+    },
+    fn: (input, args) => {
+      const avaliableShapes = getAvailableShapes();
+      if (!avaliableShapes.includes(args.shape)) {
+        throw errors.invalidShape(args.shape);
+      }
+
+      return {
+        type: 'shape',
+        ...args,
+      };
+    },
+  };
+};

src/plugins/expression_shape/common/index.ts

@@ -0,0 +1,12 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+export * from './constants';
+export * from './types';
+
+export { getAvailableShapes } from './lib/available_shapes';

src/plugins/expression_shape/common/lib/available_shapes.ts

@@ -0,0 +1,11 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import { Shape } from '../types';
+
+export const getAvailableShapes = () => Object.values(Shape);

src/plugins/expression_shape/common/lib/index.ts

@@ -0,0 +1,10 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+export * from './view_box';
+export * from './available_shapes';

src/plugins/expression_shape/common/lib/view_box.ts

@@ -0,0 +1,52 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import { ParentNodeParams, ViewBoxParams } from '../types';
+
+export function viewBoxToString(viewBox?: ViewBoxParams): undefined | string {
+  if (!viewBox) return;
+  return `${viewBox?.minX} ${viewBox?.minY} ${viewBox?.width} ${viewBox?.height}`;
+}
+
+function getMinxAndWidth(viewBoxParams: ViewBoxParams, { borderOffset, width }: ParentNodeParams) {
+  let { minX, width: shapeWidth } = viewBoxParams;
+  if (width) {
+    const xOffset = (shapeWidth / width) * borderOffset;
+    minX -= xOffset;
+    shapeWidth += xOffset * 2;
+  } else {
+    shapeWidth = 0;
+  }
+
+  return [minX, shapeWidth];
+}
+
+function getMinyAndHeight(
+  viewBoxParams: ViewBoxParams,
+  { borderOffset, height }: ParentNodeParams
+) {
+  let { minY, height: shapeHeight } = viewBoxParams;
+  if (height) {
+    const yOffset = (shapeHeight / height) * borderOffset;
+    minY -= yOffset;
+    shapeHeight += yOffset * 2;
+  } else {
+    shapeHeight = 0;
+  }
+
+  return [minY, shapeHeight];
+}
+
+export function getViewBox(
+  viewBoxParams: ViewBoxParams,
+  parentNodeParams: ParentNodeParams
+): ViewBoxParams {
+  const [minX, width] = getMinxAndWidth(viewBoxParams, parentNodeParams);
+  const [minY, height] = getMinyAndHeight(viewBoxParams, parentNodeParams);
+  return { minX, minY, width, height };
+}

src/plugins/expression_shape/common/types/expression_functions.ts

@@ -0,0 +1,46 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+import { ExpressionFunctionDefinition } from 'src/plugins/expressions';
+
+export enum Shape {
+  ARROW = 'arrow',
+  ARROW_MULTI = 'arrowMulti',
+  BOOKMARK = 'bookmark',
+  CIRCLE = 'circle',
+  CROSS = 'cross',
+  HEXAGON = 'hexagon',
+  KITE = 'kite',
+  PENTAGON = 'pentagon',
+  RHOMBUS = 'rhombus',
+  SEMICIRCLE = 'semicircle',
+  SPEECH_BUBBLE = 'speechBubble',
+  SQUARE = 'square',
+  STAR = 'star',
+  TAG = 'tag',
+  TRIANGLE = 'triangle',
+  TRIANGLE_RIGHT = 'triangleRight',
+}
+
+interface Arguments {
+  border: string;
+  borderWidth: number;
+  shape: Shape;
+  fill: string;
+  maintainAspect: boolean;
+}
+
+export interface Output extends Arguments {
+  type: 'shape';
+}
+
+export type ExpressionShapeFunction = () => ExpressionFunctionDefinition<
+  'shape',
+  number | null,
+  Arguments,
+  Output
+>;

src/plugins/expression_shape/common/types/expression_renderers.ts

@@ -0,0 +1,35 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+import { Shape } from './expression_functions';
+
+export type OriginString = 'bottom' | 'left' | 'top' | 'right';
+export interface ShapeRendererConfig {
+  border: string;
+  borderWidth: number;
+  shape: Shape;
+  fill: string;
+  maintainAspect: boolean;
+}
+
+export interface NodeDimensions {
+  width: number;
+  height: number;
+}
+
+export interface ParentNodeParams {
+  borderOffset: number;
+  width: number;
+  height: number;
+}
+
+export interface ViewBoxParams {
+  minX: number;
+  minY: number;
+  width: number;
+  height: number;
+}

src/plugins/expression_shape/common/types/index.ts

@@ -0,0 +1,9 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+export * from './expression_functions';
+export * from './expression_renderers';