🐛 Make update overwrite an optional prop owned by each plugin

elastic · Sep 8, 2023 · 6c1c096 · 6c1c096
1 parent d9b0427
commit 6c1c096
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 1 deletion.
diff --git a/src/plugins/visualizations/public/utils/saved_objects_utils/update_basic_attributes.ts b/src/plugins/visualizations/public/utils/saved_objects_utils/update_basic_attributes.ts
@@ -34,6 +34,19 @@ function getClientForType(
   );
 }
 
+function getAdditionalOptionsForUpdate(
+  type: string,
+  typesService: TypesStart,
+  method: 'update' | 'create'
+) {
+  const visAliases = typesService.getAliases();
+  const aliasType = visAliases.find((v) => v.appExtensions?.visualizations.docTypes.includes(type));
+  if (!aliasType) {
+    return { overwrite: true };
+  }
+  return aliasType?.appExtensions?.visualizations?.clientOptions?.[method];
+}
+
 export const updateBasicSoAttributes = async (
   soId: string,
   type: string,
@@ -73,8 +86,8 @@ export const updateBasicSoAttributes = async (
       ...attributes,
     },
     options: {
-      overwrite: true,
       references,
+      ...getAdditionalOptionsForUpdate(type, dependencies.typesService, 'update'),
     },
   });
 };
diff --git a/src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts b/src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts
@@ -76,6 +76,11 @@ export interface VisualizationClient<
 export interface VisualizationsAppExtension {
   docTypes: string[];
   searchFields?: string[];
+  /** let each visualization client pass its own custom options if required */
+  clientOptions?: {
+    update?: { overwrite?: boolean; [otherOption: string]: unknown };
+    create?: { [otherOption: string]: unknown };
+  };
   client: (contentManagement: ContentManagementPublicStart) => VisualizationClient;
   toListItem: (savedObject: SimpleSavedObject<any>) => VisualizationListItem;
 }

diff --git a/x-pack/plugins/lens/public/vis_type_alias.ts b/x-pack/plugins/lens/public/vis_type_alias.ts
@@ -31,6 +31,7 @@ export const getLensAliasConfig = (): VisTypeAlias => ({
     visualizations: {
       docTypes: ['lens'],
       searchFields: ['title^3'],
+      clientOptions: { update: { overwrite: true } },
       client: getLensClient,
       toListItem(savedObject) {
         const { id, type, updatedAt, attributes } = savedObject;