Add a new augment-vis saved object type

src/plugins/saved_objects_management/opensearch_dashboards.json

@@ -4,7 +4,14 @@
   "server": true,
   "ui": true,
   "requiredPlugins": ["management", "data"],
-  "optionalPlugins": ["dashboard", "visualizations", "discover", "home", "visBuilder"],
+  "optionalPlugins": [
+    "dashboard",
+    "visualizations",
+    "discover",
+    "home",
+    "visBuilder",
+    "visAugmenter"
+  ],
   "extraPublicDirs": ["public/lib"],
   "requiredBundles": ["opensearchDashboardsReact", "home"]
 }

src/plugins/saved_objects_management/public/lib/in_app_url.ts

@@ -38,6 +38,8 @@ export function canViewInApp(uiCapabilities: Capabilities, type: string): boolea
     case 'visualization':
     case 'visualizations':
       return uiCapabilities.visualize.show as boolean;
+    case 'augment-vis':
+      return uiCapabilities.visAugmenter.show as boolean;
     case 'index-pattern':
     case 'index-patterns':
     case 'indexPatterns':

src/plugins/saved_objects_management/public/management_section/object_view/saved_object_view.tsx

@@ -169,7 +169,7 @@ export class SavedObjectEdition extends Component<
     );
     if (confirmed) {
       await savedObjectsClient.delete(type, id);
-      notifications.toasts.addSuccess(`Deleted '${object!.attributes.title}' ${type} object`);
+      notifications.toasts.addSuccess(`Deleted ${this.formatTitle(object)} ${type} object`);
       this.redirectToListing();
     }
   }
@@ -179,10 +179,14 @@ export class SavedObjectEdition extends Component<
     const { object, type } = this.state;
 
     await savedObjectsClient.update(object!.type, object!.id, attributes, { references });
-    notifications.toasts.addSuccess(`Updated '${attributes.title}' ${type} object`);
+    notifications.toasts.addSuccess(`Updated ${this.formatTitle(object)} ${type} object`);
     this.redirectToListing();
   };
 
+  formatTitle = (object: SimpleSavedObject<any> | undefined) => {
+    return object?.attributes?.title ? `'${object.attributes.title}'` : '';
+  };
+
   redirectToListing() {
     this.props.history.push('/');
   }

src/plugins/saved_objects_management/public/plugin.ts

@@ -38,6 +38,7 @@ import { DashboardStart } from '../../dashboard/public';
 import { DiscoverStart } from '../../discover/public';
 import { HomePublicPluginSetup, FeatureCatalogueCategory } from '../../home/public';
 import { VisualizationsStart } from '../../visualizations/public';
+import { VisAugmenterStart } from '../../vis_augmenter/public';
 import {
   SavedObjectsManagementActionService,
   SavedObjectsManagementActionServiceSetup,
@@ -75,6 +76,7 @@ export interface StartDependencies {
   data: DataPublicPluginStart;
   dashboard?: DashboardStart;
   visualizations?: VisualizationsStart;
+  visAugmenter?: VisAugmenterStart;
   discover?: DiscoverStart;
   visBuilder?: VisBuilderStart;
 }

src/plugins/saved_objects_management/public/register_services.ts

@@ -36,7 +36,10 @@ export const registerServices = async (
   registry: ISavedObjectsManagementServiceRegistry,
   getStartServices: StartServicesAccessor<StartDependencies, SavedObjectsManagementPluginStart>
 ) => {
-  const [, { dashboard, visualizations, discover, visBuilder }] = await getStartServices();
+  const [
+    ,
+    { dashboard, visualizations, visAugmenter, discover, visBuilder },
+  ] = await getStartServices();
 
   if (dashboard) {
     registry.register({
@@ -54,6 +57,14 @@ export const registerServices = async (
     });
   }
 
+  if (visAugmenter) {
+    registry.register({
+      id: 'savedAugmentVis',
+      title: 'augmentVis',
+      service: visAugmenter.savedAugmentVisLoader,
+    });
+  }
+
   if (discover) {
     registry.register({
       id: 'savedSearches',

src/plugins/vis_augmenter/public/index.ts

@@ -10,3 +10,12 @@ export function plugin(initializerContext: PluginInitializerContext) {
   return new VisAugmenterPlugin(initializerContext);
 }
 export { VisAugmenterSetup, VisAugmenterStart };
+
+export {
+  createSavedAugmentVisLoader,
+  createAugmentVisSavedObject,
+  SavedAugmentVisLoader,
+  SavedObjectOpenSearchDashboardsServicesWithAugmentVis,
+} from './saved_augment_vis';
+
+export { ISavedAugmentVis, VisLayerExpressionFn, AugmentVisSavedObject } from './types';

src/plugins/vis_augmenter/public/plugin.ts

@@ -7,12 +7,15 @@ import { ExpressionsSetup } from '../../expressions/public';
 import { PluginInitializerContext, CoreSetup, CoreStart, Plugin } from '../../../core/public';
 import { DataPublicPluginSetup, DataPublicPluginStart } from '../../data/public';
 import { visLayers } from './expressions';
+import { setSavedAugmentVisLoader } from './services';
+import { createSavedAugmentVisLoader, SavedAugmentVisLoader } from './saved_augment_vis';
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
 export interface VisAugmenterSetup {}
 
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface VisAugmenterStart {}
+export interface VisAugmenterStart {
+  savedAugmentVisLoader: SavedAugmentVisLoader;
+}
 
 export interface VisAugmenterSetupDeps {
   data: DataPublicPluginSetup;
@@ -37,7 +40,15 @@ export class VisAugmenterPlugin
   }
 
   public start(core: CoreStart, { data }: VisAugmenterStartDeps): VisAugmenterStart {
-    return {};
+    const savedAugmentVisLoader = createSavedAugmentVisLoader({
+      savedObjectsClient: core.savedObjects.client,
+      indexPatterns: data.indexPatterns,
+      search: data.search,
+      chrome: core.chrome,
+      overlays: core.overlays,
+    });
+    setSavedAugmentVisLoader(savedAugmentVisLoader);
+    return { savedAugmentVisLoader };
   }
 
   public stop() {}

src/plugins/vis_augmenter/public/saved_augment_vis/_saved_augment_vis.ts

@@ -0,0 +1,59 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @name SavedAugmentVis
+ *
+ * @extends SavedObject.
+ */
+import { get } from 'lodash';
+import {
+  createSavedObjectClass,
+  SavedObject,
+  SavedObjectOpenSearchDashboardsServices,
+} from '../../../saved_objects/public';
+import { IIndexPattern } from '../../../data/public';
+import { extractReferences, injectReferences } from './saved_augment_vis_references';
+
+const name = 'augment-vis';
+
+export function createSavedAugmentVisClass(services: SavedObjectOpenSearchDashboardsServices) {
+  const SavedObjectClass = createSavedObjectClass(services);
+
+  class SavedAugmentVis extends SavedObjectClass {
+    public static type: string = name;
+    public static mapping: Record<string, string> = {
+      description: 'text',
+      pluginResourceId: 'text',
+      visId: 'keyword',
+      visLayerExpressionFn: 'text',
+      version: 'integer',
+    };
+
+    constructor(opts: Record<string, unknown> | string = {}) {
+      if (typeof opts !== 'object') {
+        opts = { id: opts };
+      }
+      super({
+        type: SavedAugmentVis.type,
+        mapping: SavedAugmentVis.mapping,
+        extractReferences,
+        injectReferences,
+        id: (opts.id as string) || '',
+        indexPattern: opts.indexPattern as IIndexPattern,
+        defaults: {
+          description: get(opts, 'description', ''),
+          pluginResourceId: get(opts, 'pluginResourceId', ''),
+          visId: get(opts, 'visId', ''),
+          visLayerExpressionFn: get(opts, 'visLayerExpressionFn', {}),
+          version: 1,
+        },
+      });
+      this.showInRecentlyAccessed = false;
+    }
+  }
+
+  return SavedAugmentVis as new (opts: Record<string, unknown> | string) => SavedObject;
+}

src/plugins/vis_augmenter/public/saved_augment_vis/index.ts

@@ -0,0 +1,7 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export * from './saved_augment_vis';
+export * from './utils';

src/plugins/vis_augmenter/public/saved_augment_vis/saved_augment_vis.test.ts

@@ -0,0 +1,41 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { VisLayerExpressionFn } from '../types';
+import { VisLayerTypes } from '../../common';
+import {
+  createSavedAugmentVisLoader,
+  SavedObjectOpenSearchDashboardsServicesWithAugmentVis,
+} from './saved_augment_vis';
+import { generateAugmentVisSavedObject, getMockAugmentVisSavedObjectClient } from './utils';
+
+describe('SavedObjectLoaderAugmentVis', () => {
+  const fn = {
+    type: VisLayerTypes.PointInTimeEvents,
+    name: 'test-fn',
+    args: {
+      testArg: 'test-value',
+    },
+  } as VisLayerExpressionFn;
+  const obj1 = generateAugmentVisSavedObject('test-id-1', fn);
+  const obj2 = generateAugmentVisSavedObject('test-id-2', fn);
+
+  it('findAll returns single saved obj', async () => {
+    const loader = createSavedAugmentVisLoader({
+      savedObjectsClient: getMockAugmentVisSavedObjectClient([obj1]),
+    } as SavedObjectOpenSearchDashboardsServicesWithAugmentVis);
+    const resp = await loader.findAll();
+    expect(resp.hits.length === 1);
+  });
+
+  // TODO: once done rebasing after VisLayer PR, can finish creating test cases here.
+  // right now they are failing since there is missing imports
+
+  // add test for empty response
+  // add test for multi obj response
+  // add test for invalid VisLayerType
+  // add test for missing reference
+  // add test for missing visLayerExpressionFn
+});

src/plugins/vis_augmenter/public/saved_augment_vis/saved_augment_vis.ts

@@ -0,0 +1,62 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { get, isEmpty } from 'lodash';
+import {
+  SavedObjectLoader,
+  SavedObjectOpenSearchDashboardsServices,
+} from '../../../saved_objects/public';
+import { createSavedAugmentVisClass } from './_saved_augment_vis';
+import { VisLayerTypes } from '../../common';
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface SavedObjectOpenSearchDashboardsServicesWithAugmentVis
+  extends SavedObjectOpenSearchDashboardsServices {}
+export type SavedAugmentVisLoader = ReturnType<typeof createSavedAugmentVisLoader>;
+export function createSavedAugmentVisLoader(
+  services: SavedObjectOpenSearchDashboardsServicesWithAugmentVis
+) {
+  const { savedObjectsClient } = services;
+
+  class SavedObjectLoaderAugmentVis extends SavedObjectLoader {
+    mapHitSource = (source: Record<string, any>, id: string) => {
+      source.id = id;
+      source.visId = get(source, 'visReference.id', '');
+
+      if (isEmpty(source.visReference)) {
+        source.error = 'visReference is missing in augment-vis saved object';
+      }
+      if (isEmpty(source.visLayerExpressionFn)) {
+        source.error = 'visLayerExpressionFn is missing in augment-vis saved object';
+      }
+      if (!(get(source, 'visLayerExpressionFn.type', '') in VisLayerTypes)) {
+        source.error = 'Unknown VisLayer expression function type';
+      }
+
+      delete source.visReference;
+      delete source.visName;
+      return source;
+    };
+
+    /**
+     * Updates hit.attributes to contain an id related to the referenced visualization
+     * (visId) and returns the updated attributes object.
+     * @param hit
+     * @returns {hit.attributes} The modified hit.attributes object, with an id and url field.
+     */
+    mapSavedObjectApiHits(hit: {
+      references: any[];
+      attributes: Record<string, unknown>;
+      id: string;
+    }) {
+      // For now we are assuming only one vis reference per saved object.
+      // If we change to multiple, we will need to dynamically handle that
+      const visReference = hit.references[0];
+      return this.mapHitSource({ ...hit.attributes, visReference }, hit.id);
+    }
+  }
+  const SavedAugmentVis = createSavedAugmentVisClass(services);
+  return new SavedObjectLoaderAugmentVis(SavedAugmentVis, savedObjectsClient) as SavedObjectLoader;
+}