Refactor component types and component inheritance (#110)

Signed-off-by: Tyler Ohlsen <[email protected]>
(cherry picked from commit 616b1cb)

opensearch_dashboards.json

@@ -6,7 +6,8 @@
   "ui": true,
   "requiredBundles": [],
   "requiredPlugins": [
-    "navigation"
+    "navigation",
+    "opensearchDashboardsUtils"
   ],
   "optionalPlugins": []
 }

public/component_types/base_component.tsx

@@ -3,10 +3,32 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { COMPONENT_CATEGORY, COMPONENT_CLASS } from '../utils';
+import {
+  IComponent,
+  IComponentField,
+  IComponentInput,
+  IComponentOutput,
+} from './interfaces';
+
 /**
- * A base component class.
+ * A base UI drag-and-drop component class.
  */
-export abstract class BaseComponent {
+export abstract class BaseComponent implements IComponent {
+  type: COMPONENT_CLASS;
+  label: string;
+  description: string;
+  categories: COMPONENT_CATEGORY[];
+  allowsCreation: boolean;
+  baseClasses: COMPONENT_CLASS[];
+  inputs?: IComponentInput[];
+  fields?: IComponentField[];
+  createFields?: IComponentField[];
+  outputs?: IComponentOutput[];
+
+  // No-op constructor. If there are general / defaults for field values, add in here.
+  constructor() {}
+
   // Persist a standard toObj() fn that all component classes can use. This is necessary
   // so we have standard JS Object when serializing comoponent state in redux.
   toObj() {

public/component_types/index.ts

@@ -4,5 +4,5 @@
  */
 
 export * from './interfaces';
-export * from './processors';
-export * from './indices';
+export * from './transformer';
+export * from './indexer';

public/component_types/indices/index.ts → public/component_types/indexer/index.ts

@@ -3,4 +3,5 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-export * from './knn_index';
+export * from './indexer';
+export * from './knn_indexer';

public/component_types/indexer/indexer.ts

@@ -0,0 +1,65 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { COMPONENT_CATEGORY, COMPONENT_CLASS } from '../../utils';
+import { BaseComponent } from '../base_component';
+
+/**
+ * A base indexer UI component
+ */
+export class Indexer extends BaseComponent {
+  constructor() {
+    super();
+    this.type = COMPONENT_CLASS.INDEXER;
+    this.label = 'Indexer';
+    this.description = 'A general indexer';
+    this.categories = [COMPONENT_CATEGORY.INGEST, COMPONENT_CATEGORY.SEARCH];
+    this.allowsCreation = true;
+    this.baseClasses = [this.type];
+    this.inputs = [
+      {
+        id: 'transformer',
+        label: 'Transformer',
+        // TODO: may need to change to be looser. it should be able to take
+        // in other component types
+        baseClass: COMPONENT_CLASS.TRANSFORMER,
+        optional: false,
+        acceptMultiple: false,
+      },
+    ];
+    this.fields = [
+      {
+        label: 'Index Name',
+        name: 'indexName',
+        type: 'select',
+        optional: false,
+        advanced: false,
+      },
+    ];
+    this.createFields = [
+      {
+        label: 'Index Name',
+        name: 'indexName',
+        type: 'string',
+        optional: false,
+        advanced: false,
+      },
+      {
+        label: 'Mappings',
+        name: 'indexMappings',
+        type: 'json',
+        placeholder: 'Enter an index mappings JSON blob...',
+        optional: false,
+        advanced: false,
+      },
+    ];
+    this.outputs = [
+      {
+        label: this.label,
+        baseClasses: this.baseClasses,
+      },
+    ];
+  }
+}

public/component_types/indexer/knn_indexer.ts

@@ -0,0 +1,30 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { Indexer } from './indexer';
+
+/**
+ * A specialized indexer component for vector/K-NN indices
+ */
+export class KnnIndexer extends Indexer {
+  constructor() {
+    super();
+    this.label = 'K-NN Indexer';
+    this.description = 'A specialized indexer for K-NN indices';
+    this.createFields = [
+      // @ts-ignore
+      ...this.createFields,
+      // TODO: finalize what to expose / what to have for defaults here
+      {
+        label: 'K-NN Settings',
+        name: 'knnSettings',
+        type: 'json',
+        placeholder: 'Enter K-NN settings JSON blob...',
+        optional: false,
+        advanced: false,
+      },
+    ];
+  }
+}

public/component_types/interfaces.ts

@@ -10,7 +10,6 @@ import { COMPONENT_CATEGORY, COMPONENT_CLASS } from '../utils';
 /**
  * ************ Types *************************
  */
-export type UIFlow = string;
 export type FieldType = 'string' | 'json' | 'select';
 // TODO: this may expand to more types in the future. Formik supports 'any' so we can too.
 // For now, limiting scope to expected types.
@@ -68,17 +67,12 @@ export interface IComponent {
   label: string;
   description: string;
   // will be used for grouping together in the drag-and-drop component library
-  category: COMPONENT_CATEGORY;
+  // and determining which flows the component can be drug into the workspace flows
+  categories: COMPONENT_CATEGORY[];
   // determines if this component allows for new creation. this means to
   // allow a "create" option on the UI component, as well as potentially
   // include in the use case template construction ('provisioning' flow)
   allowsCreation: boolean;
-  // determines if this is something that will be included in the use
-  // case template construction (query or ingest flows). provisioning flow
-  // is handled by the allowsCreation flag above.
-  isApplicationStep: boolean;
-  // the set of allowed flows this component can be drug into the workspace
-  allowedFlows: UIFlow[];
   // the list of base classes that will be used in the component output
   baseClasses?: COMPONENT_CLASS[];
   inputs?: IComponentInput[];

public/component_types/transformer/base_transformer.ts

@@ -0,0 +1,21 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { COMPONENT_CATEGORY, COMPONENT_CLASS } from '../../utils';
+import { BaseComponent } from '../base_component';
+
+/**
+ * A base transformer UI component
+ */
+export abstract class BaseTransformer extends BaseComponent {
+  constructor() {
+    super();
+    this.type = COMPONENT_CLASS.TRANSFORMER;
+    this.label = 'Transformer';
+    this.categories = [COMPONENT_CATEGORY.INGEST, COMPONENT_CATEGORY.SEARCH];
+    this.allowsCreation = false;
+    this.baseClasses = [this.type];
+  }
+}

public/component_types/processors/index.ts → public/component_types/transformer/index.ts

@@ -3,4 +3,5 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-export * from './text_embedding_processor';
+export * from './ml_transformer';
+export * from './text_embedding_transformer';