[streams][content pack] track installed content packs

x-pack/platform/packages/shared/kbn-content-packs-schema/src/helpers/index.ts

@@ -5,139 +5,4 @@
  * 2.0.
  */
 
-import type {
-  DashboardAttributes,
-  SavedDashboardPanel,
-} from '@kbn/dashboard-plugin/common/content_management/v2';
-import { cloneDeep, mapValues, uniq } from 'lodash';
-import { AggregateQuery, Query } from '@kbn/es-query';
-import { getIndexPatternFromESQLQuery, replaceESQLQueryIndexPattern } from '@kbn/esql-utils';
-import type { LensAttributes } from '@kbn/lens-embeddable-utils';
-import type { IndexPatternRef } from '@kbn/lens-plugin/public/types';
-import type { ContentPackSavedObject } from '../models';
-
-export const INDEX_PLACEHOLDER = '<stream_name_placeholder>';
-
-export const isIndexPlaceholder = (index: string) => index.startsWith(INDEX_PLACEHOLDER);
-
-interface TraverseOptions {
-  esqlQuery(query: string): string;
-  indexPattern<T extends { name?: string; title?: string }>(pattern: T): T;
-}
-
-export function findIndexPatterns(savedObject: ContentPackSavedObject) {
-  const patterns: string[] = [];
-
-  locateIndexPatterns(savedObject, {
-    esqlQuery(query: string) {
-      patterns.push(...getIndexPatternFromESQLQuery(query).split(','));
-      return query;
-    },
-    indexPattern<T extends { title?: string }>(pattern: T) {
-      if (pattern.title) {
-        patterns.push(...pattern.title.split(','));
-      }
-      return pattern;
-    },
-  });
-
-  return uniq(patterns);
-}
-
-export function replaceIndexPatterns(
-  savedObject: ContentPackSavedObject,
-  replacements: Record<string, string>
-) {
-  return locateIndexPatterns(cloneDeep(savedObject), {
-    esqlQuery(query: string) {
-      return replaceESQLQueryIndexPattern(query, replacements);
-    },
-    indexPattern<T extends { name?: string; title?: string }>(pattern: T) {
-      const updatedPattern = pattern.title
-        ?.split(',')
-        .map((index) => replacements[index] ?? index)
-        .join(',');
-
-      return {
-        ...pattern,
-        name: updatedPattern,
-        title: updatedPattern,
-      };
-    },
-  });
-}
-
-function locateIndexPatterns(
-  object: ContentPackSavedObject,
-  options: TraverseOptions
-): ContentPackSavedObject {
-  const content = object;
-
-  if (content.type === 'index-pattern') {
-    content.attributes = options.indexPattern(content.attributes);
-  }
-
-  if (content.type === 'dashboard') {
-    const attributes = content.attributes as DashboardAttributes;
-    const panels = (JSON.parse(attributes.panelsJSON) as SavedDashboardPanel[]).map((panel) =>
-      traversePanel(panel, options)
-    );
-
-    attributes.panelsJSON = JSON.stringify(panels);
-  }
-
-  return object;
-}
-
-function traversePanel(panel: SavedDashboardPanel, options: TraverseOptions) {
-  if (panel.type === 'lens') {
-    const config = panel.embeddableConfig as {
-      query?: Query | AggregateQuery;
-      attributes?: LensAttributes;
-    };
-    if (config.query && 'esql' in config.query) {
-      config.query.esql = options.esqlQuery(config.query.esql);
-    }
-
-    if (config.attributes) {
-      traverseLensPanel(config.attributes as LensAttributes, options);
-    }
-  }
-
-  return panel;
-}
-
-function traverseLensPanel(panel: LensAttributes, options: TraverseOptions) {
-  const state = panel.state;
-
-  if (state.adHocDataViews) {
-    state.adHocDataViews = mapValues(state.adHocDataViews, (dataView) =>
-      options.indexPattern(dataView)
-    );
-  }
-
-  const {
-    query: stateQuery,
-    datasourceStates: { textBased },
-  } = state;
-
-  if (stateQuery && 'esql' in stateQuery) {
-    stateQuery.esql = options.esqlQuery(stateQuery.esql);
-  }
-
-  if (textBased) {
-    Object.values(textBased.layers).forEach((layer) => {
-      if (layer.query?.esql) {
-        layer.query.esql = options.esqlQuery(layer.query.esql);
-      }
-    });
-
-    if ('indexPatternRefs' in textBased) {
-      textBased.indexPatternRefs = (textBased.indexPatternRefs as IndexPatternRef[]).map((ref) =>
-        options.indexPattern(ref)
-      );
-    }
-  }
-
-  return panel;
-}
+export * from './index_pattern';

x-pack/platform/packages/shared/kbn-content-packs-schema/src/helpers/index_pattern.ts

@@ -0,0 +1,182 @@
+/*
+ * 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; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import type {
+  DashboardAttributes,
+  SavedDashboardPanel,
+} from '@kbn/dashboard-plugin/common/content_management/v2';
+import { cloneDeep, mapValues } from 'lodash';
+import { AggregateQuery, Query } from '@kbn/es-query';
+import { getIndexPatternFromESQLQuery, replaceESQLQueryIndexPattern } from '@kbn/esql-utils';
+import type { LensAttributes } from '@kbn/lens-embeddable-utils';
+import type { IndexPatternRef } from '@kbn/lens-plugin/public/types';
+import type {
+  FieldBasedIndexPatternColumn,
+  GenericIndexPatternColumn,
+} from '@kbn/lens-plugin/public';
+import type { TextBasedLayerColumn } from '@kbn/lens-plugin/public/datasources/form_based/esql_layer/types';
+import type { ContentPackSavedObject } from '../models';
+
+export const INDEX_PLACEHOLDER = '<stream_name_placeholder>';
+
+export const isIndexPlaceholder = (index: string) => index.startsWith(INDEX_PLACEHOLDER);
+
+interface TraverseOptions {
+  esqlQuery(query: string): string;
+  indexPattern<T extends { name?: string; title?: string }>(pattern: T): T;
+  field<T extends GenericIndexPatternColumn | TextBasedLayerColumn>(field: T): T;
+}
+
+export function findConfiguration(savedObject: ContentPackSavedObject) {
+  const patterns: Set<string> = new Set();
+  const fields: Record<string, { type: string }> = {};
+
+  locateConfiguration(savedObject, {
+    esqlQuery(query: string) {
+      getIndexPatternFromESQLQuery(query)
+        .split(',')
+        .forEach((p) => patterns.add(p));
+      return query;
+    },
+    indexPattern<T extends { title?: string }>(pattern: T) {
+      if (pattern.title) {
+        pattern.title.split(',').forEach((p) => patterns.add(p));
+      }
+      return pattern;
+    },
+    field<T extends GenericIndexPatternColumn | TextBasedLayerColumn>(field: T): T {
+      if ('fieldName' in field) {
+        const { fieldName, meta } = field as TextBasedLayerColumn;
+        if (meta?.esType) {
+          fields[fieldName] = { type: meta.esType };
+        }
+      } else if ('sourceField' in field) {
+        const { sourceField, dataType } = field as FieldBasedIndexPatternColumn;
+        if (sourceField !== '___records___') {
+          fields[sourceField] = { type: dataType };
+        }
+      }
+
+      return field;
+    },
+  });
+
+  return { patterns: [...patterns], fields };
+}
+
+export function replaceIndexPatterns(
+  savedObject: ContentPackSavedObject,
+  patternReplacements: Record<string, string>
+) {
+  return locateConfiguration(cloneDeep(savedObject), {
+    esqlQuery(query: string) {
+      return replaceESQLQueryIndexPattern(query, patternReplacements);
+    },
+    indexPattern<T extends { name?: string; title?: string }>(pattern: T) {
+      const updatedPattern = pattern.title
+        ?.split(',')
+        .map((index) => patternReplacements[index] ?? index)
+        .join(',');
+
+      return {
+        ...pattern,
+        name: updatedPattern,
+        title: updatedPattern,
+      };
+    },
+    field(field: any) {
+      return field;
+    },
+  });
+}
+
+function locateConfiguration(
+  content: ContentPackSavedObject,
+  options: TraverseOptions
+): ContentPackSavedObject {
+  if (content.type === 'index-pattern') {
+    content.attributes = options.indexPattern(content.attributes);
+  }
+
+  if (content.type === 'dashboard') {
+    const attributes = content.attributes as DashboardAttributes;
+    const panels = (JSON.parse(attributes.panelsJSON) as SavedDashboardPanel[]).map((panel) =>
+      traversePanel(panel, options)
+    );
+
+    attributes.panelsJSON = JSON.stringify(panels);
+  }
+
+  if (content.type === 'lens') {
+    content.attributes = traverseLensPanel(content.attributes, options);
+  }
+
+  return content;
+}
+
+function traversePanel(panel: SavedDashboardPanel, options: TraverseOptions) {
+  if (panel.type === 'lens') {
+    const config = panel.embeddableConfig as {
+      query?: Query | AggregateQuery;
+      attributes?: LensAttributes;
+    };
+    if (config.query && 'esql' in config.query) {
+      config.query.esql = options.esqlQuery(config.query.esql);
+    }
+
+    if (config.attributes) {
+      traverseLensPanel(config.attributes as LensAttributes, options);
+    }
+  }
+
+  return panel;
+}
+
+function traverseLensPanel(panel: LensAttributes, options: TraverseOptions) {
+  const state = panel.state;
+
+  if (state.adHocDataViews) {
+    state.adHocDataViews = mapValues(state.adHocDataViews, (dataView) =>
+      options.indexPattern(dataView)
+    );
+  }
+
+  const {
+    query: stateQuery,
+    datasourceStates: { formBased, textBased },
+  } = state;
+
+  if (stateQuery && 'esql' in stateQuery) {
+    stateQuery.esql = options.esqlQuery(stateQuery.esql);
+  }
+
+  if (formBased) {
+    Object.values(formBased.layers).forEach((layer) => {
+      Object.entries(layer.columns).forEach(([columnId, column]) => {
+        layer.columns[columnId] = options.field(column);
+      });
+    });
+  }
+
+  if (textBased) {
+    Object.values(textBased.layers).forEach((layer) => {
+      if (layer.query?.esql) {
+        layer.query.esql = options.esqlQuery(layer.query.esql);
+      }
+
+      layer.columns = layer.columns.map((column) => options.field(column));
+    });
+
+    if ('indexPatternRefs' in textBased) {
+      textBased.indexPatternRefs = (textBased.indexPatternRefs as IndexPatternRef[]).map((ref) =>
+        options.indexPattern(ref)
+      );
+    }
+  }
+
+  return panel;
+}

x-pack/platform/packages/shared/kbn-content-packs-schema/src/models/api.ts

@@ -0,0 +1,34 @@
+/*
+ * 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; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { z } from '@kbn/zod';
+
+export interface ContentPackIncludeObjects {
+  objects: {
+    dashboards: string[];
+  };
+}
+
+export interface ContentPackIncludeAll {
+  all: {};
+}
+
+export type ContentPackIncludedObjects = ContentPackIncludeObjects | ContentPackIncludeAll;
+
+const contentPackIncludeObjectsSchema = z.object({
+  objects: z.object({ dashboards: z.array(z.string()) }),
+});
+const contentPackIncludeAllSchema = z.object({ all: z.strictObject({}) });
+
+export const isIncludeAll = (value: ContentPackIncludedObjects): value is ContentPackIncludeAll => {
+  return contentPackIncludeAllSchema.safeParse(value).success;
+};
+
+export const contentPackIncludedObjectsSchema: z.Schema<ContentPackIncludedObjects> = z.union([
+  contentPackIncludeObjectsSchema,
+  contentPackIncludeAllSchema,
+]);