Export Type Registry for Reporting [POC/exploration]

.github/CODEOWNERS

@@ -518,6 +518,7 @@ packages/kbn-repo-source-classifier @elastic/kibana-operations
 packages/kbn-repo-source-classifier-cli @elastic/kibana-operations
 packages/kbn-reporting/common @elastic/appex-sharedux
 x-pack/examples/reporting_example @elastic/appex-sharedux
+x-pack/plugins/reporting_export_types @elastic/appex-sharedux
 x-pack/plugins/reporting @elastic/appex-sharedux
 x-pack/test/plugin_functional/plugins/resolver_test @elastic/security-solution
 examples/response_stream @elastic/ml-ui

config/kibana.yml

@@ -163,4 +163,4 @@
 
 # Maximum number of documents loaded by each shard to generate autocomplete suggestions.
 # This value must be a whole number greater than zero. Defaults to 100_000
-#unifiedSearch.autocomplete.valueSuggestions.terminateAfter: 100000
+#unifiedSearch.autocomplete.valueSuggestions.terminateAfter: 100000

docs/developer/plugin-list.asciidoc

@@ -673,6 +673,10 @@ Elastic.
 |An awesome Kibana reporting plugin
 
 
+|{kib-repo}blob/{branch}/x-pack/plugins/reporting_export_types/README.md[reportingExportTypes]
+|There are three constructs that interact: the ReportingPlugin, the ExportTypesPlugin and the ExportTypesRegistry.
+
+
 |{kib-repo}blob/{branch}/x-pack/plugins/rollup/README.md[rollup]
 |Welcome to the Kibana rollup plugin! This plugin provides Kibana support for Elasticsearch's rollup feature. Please refer to the Elasticsearch documentation to understand rollup indices and how to create rollup jobs.
 

package.json

@@ -520,6 +520,7 @@
     "@kbn/repo-packages": "link:packages/kbn-repo-packages",
     "@kbn/reporting-common": "link:packages/kbn-reporting/common",
     "@kbn/reporting-example-plugin": "link:x-pack/examples/reporting_example",
+    "@kbn/reporting-export-types": "link:x-pack/plugins/reporting_export_types",
     "@kbn/reporting-plugin": "link:x-pack/plugins/reporting",
     "@kbn/resolver-test-plugin": "link:x-pack/test/plugin_functional/plugins/resolver_test",
     "@kbn/response-stream-plugin": "link:examples/response_stream",

packages/kbn-config/src/config.ts

@@ -31,6 +31,7 @@ export function isConfigPath(value: unknown): value is ConfigPath {
  * @internal
  */
 export interface Config {
+  kbnConfig: any;
   /**
    * Returns whether or not there is a config value located at the specified path.
    * @param configPath Path to locate value at.

packages/kbn-reporting/common/constants.ts

@@ -5,7 +5,13 @@
  * in compliance with, at your election, the Elastic License 2.0 or the Server
  * Side Public License, v 1.
  */
+export const PLUGIN_ID = 'reporting';
+
+export const REPORTING_TRANSACTION_TYPE = PLUGIN_ID;
+
 export const UI_SETTINGS_SEARCH_INCLUDE_FROZEN = 'search:includeFrozen';
 export const UI_SETTINGS_CUSTOM_PDF_LOGO = 'xpackReporting:customPdfLogo';
 export const UI_SETTINGS_DATEFORMAT_TZ = 'dateFormat:tz';
 export const CSV_REPORTING_ACTION = 'downloadCsvReport';
+
+export const CSV_SEARCHSOURCE_IMMEDIATE_TYPE = 'csv_searchsource_immediate';

tsconfig.base.json

@@ -1030,6 +1030,8 @@
       "@kbn/reporting-common/*": ["packages/kbn-reporting/common/*"],
       "@kbn/reporting-example-plugin": ["x-pack/examples/reporting_example"],
       "@kbn/reporting-example-plugin/*": ["x-pack/examples/reporting_example/*"],
+      "@kbn/reporting-export-types": ["x-pack/plugins/reporting_export_types"],
+      "@kbn/reporting-export-types/*": ["x-pack/plugins/reporting_export_types/*"],
       "@kbn/reporting-plugin": ["x-pack/plugins/reporting"],
       "@kbn/reporting-plugin/*": ["x-pack/plugins/reporting/*"],
       "@kbn/resolver-test-plugin": ["x-pack/test/plugin_functional/plugins/resolver_test"],

x-pack/.i18nrc.json

@@ -61,6 +61,7 @@
     "xpack.profiling": ["plugins/profiling"],
     "xpack.remoteClusters": "plugins/remote_clusters",
     "xpack.reporting": ["plugins/reporting"],
+    "xpack.reportingExportTypes": ["plugins/reporting_export_types"],
     "xpack.rollupJobs": ["plugins/rollup"],
     "xpack.runtimeFields": "plugins/runtime_fields",
     "xpack.screenshotting": "plugins/screenshotting",

x-pack/examples/reporting_example/public/containers/main.tsx

@@ -34,12 +34,12 @@ import { BrowserRouter as Router, useHistory } from 'react-router-dom';
 import * as Rx from 'rxjs';
 import { takeWhile } from 'rxjs/operators';
 import type { ScreenshotModePluginSetup } from '@kbn/screenshot-mode-plugin/public';
+import type { ReportingStart } from '@kbn/reporting-plugin/public';
 import type {
   JobAppParamsPDF,
   JobParamsPDFV2,
   JobParamsPNGV2,
 } from '@kbn/reporting-plugin/common/types';
-import type { ReportingStart } from '@kbn/reporting-plugin/public';
 import { REPORTING_EXAMPLE_LOCATOR_ID } from '../../common';
 import { useApplicationContext } from '../application_context';
 import { ROUTES } from '../constants';

x-pack/plugins/canvas/kibana.jsonc

@@ -31,11 +31,11 @@
       "uiActions",
       "share",
       "savedObjectsManagement",
-      "savedObjectsFinder"
+      "savedObjectsFinder",
+      "reporting"
     ],
     "optionalPlugins": [
       "home",
-      "reporting",
       "spaces",
       "usageCollection",
       "savedObjects",
@@ -47,7 +47,7 @@
       "lens",
       "maps",
       "visualizations",
-      "fieldFormats"
+      "fieldFormats",
     ],
   }
 }

x-pack/plugins/canvas/server/feature.test.ts

@@ -12,6 +12,7 @@ let mockReportingPlugin: ReportingStart;
 beforeEach(() => {
   mockReportingPlugin = {
     usesUiCapabilities: () => false,
+    registerExportType: () => {},
   };
 });
 
@@ -87,6 +88,7 @@ it('Provides a feature declaration ', () => {
 it(`Calls on Reporting whether to include Generate PDF as a sub-feature`, () => {
   mockReportingPlugin = {
     usesUiCapabilities: () => true,
+    registerExportType: () => {},
   };
   expect(getCanvasFeature({ reporting: mockReportingPlugin })).toMatchInlineSnapshot(`
     Object {

x-pack/plugins/reporting/common/test/fixtures.ts

@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import type { ReportApiJSON } from '../types';
+import { ReportApiJSON } from '../types';
 import type { ReportMock } from './types';
 
 const buildMockReport = (baseObj: ReportMock): ReportApiJSON => ({

x-pack/plugins/reporting/common/types/index.ts

@@ -4,19 +4,13 @@
  * 2.0; you may not use this file except in compliance with the Elastic License
  * 2.0.
  */
-
 import { TaskRunMetrics, TaskRunResult } from '@kbn/reporting-common';
+import { LayoutParams } from '@kbn/screenshotting-plugin/common';
 import type { PdfScreenshotResult, PngScreenshotResult } from '@kbn/screenshotting-plugin/server';
+import type { JobParamsPDFDeprecated } from '../../server/routes/lib';
 import type { BaseParams, BaseParamsV2, BasePayload, BasePayloadV2, JobId } from './base';
+import { LocatorParams } from './url';
 
-export type {
-  JobParamsCsvFromSavedObject,
-  TaskPayloadCsvFromSavedObject,
-} from './export_types/csv_v2';
-export type { JobParamsPNGDeprecated } from './export_types/png';
-export type { JobParamsPNGV2 } from './export_types/png_v2';
-export type { JobAppParamsPDF, JobParamsPDFDeprecated } from './export_types/printable_pdf';
-export type { JobAppParamsPDFV2, JobParamsPDFV2 } from './export_types/printable_pdf_v2';
 export type {
   DownloadReportFn,
   IlmPolicyMigrationStatus,
@@ -25,6 +19,7 @@ export type {
   ManagementLinkFn,
   UrlOrUrlLocatorTuple,
 } from './url';
+
 export type { JobId, BaseParams, BaseParamsV2, BasePayload, BasePayloadV2 };
 
 export interface ReportDocumentHead {
@@ -148,3 +143,38 @@ export interface JobSummarySet {
   completed: JobSummary[];
   failed: JobSummary[];
 }
+
+interface BaseParamsPDFV2 {
+  layout: LayoutParams;
+
+  /**
+   * This value is used to re-create the same visual state as when the report was requested as well as navigate to the correct page.
+   */
+  locatorParams: LocatorParams[];
+}
+export type JobParamsPDFV2 = BaseParamsPDFV2 & BaseParams;
+
+export type JobAppParamsPDFV2 = Omit<JobParamsPDFV2, 'browserTimezone' | 'version'>;
+
+// Job payload: structure of stored job data provided by create_job
+export interface TaskPayloadPDFV2 extends BasePayload, BaseParamsPDFV2 {
+  layout: LayoutParams;
+  /**
+   * The value of forceNow is injected server-side every time a given report is generated.
+   */
+  forceNow: string;
+}
+
+// Job params: structure of incoming user request data
+export interface JobParamsPNGV2 extends BaseParams {
+  layout: LayoutParams;
+  /**
+   * This value is used to re-create the same visual state as when the report was requested as well as navigate to the correct page.
+   */
+  locatorParams: LocatorParams;
+}
+
+/**
+ * @deprecated
+ */
+export type JobAppParamsPDF = Omit<JobParamsPDFDeprecated, 'browserTimezone' | 'version'>;

x-pack/plugins/reporting/kibana.jsonc

@@ -25,16 +25,16 @@
       "screenshotting",
       "screenshotMode",
       "share",
-      "features"
+      "features",
     ],
     "optionalPlugins": [
       "security",
       "spaces",
-      "usageCollection"
+      "usageCollection",
     ],
     "requiredBundles": [
       "kibanaReact",
-      "discover"
+      "discover",
     ]
   }
 }

x-pack/plugins/reporting/public/lib/reporting_api_client/hooks.ts

@@ -5,8 +5,8 @@
  * 2.0.
  */
 
-import { useRequest, UseRequestResponse } from '../../shared_imports';
 import { IlmPolicyStatusResponse } from '../../../common/types';
+import { useRequest, UseRequestResponse } from '../../shared_imports';
 
 import { API_GET_ILM_POLICY_STATUS } from '../../../common/constants';
 

x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts

@@ -10,6 +10,13 @@ import { stringify } from 'query-string';
 import rison from '@kbn/rison';
 import type { HttpFetchQuery } from '@kbn/core/public';
 import { HttpSetup, IUiSettingsClient } from '@kbn/core/public';
+import {
+  BaseParams,
+  ManagementLinkFn,
+  DownloadReportFn,
+  ReportApiJSON,
+  JobId,
+} from '../../../common/types';
 import { buildKibanaPath } from '../../../common/build_kibana_path';
 import {
   API_BASE_GENERATE,
@@ -20,13 +27,6 @@ import {
   getRedirectAppPath,
   REPORTING_MANAGEMENT_HOME,
 } from '../../../common/constants';
-import {
-  BaseParams,
-  DownloadReportFn,
-  JobId,
-  ManagementLinkFn,
-  ReportApiJSON,
-} from '../../../common/types';
 import { add } from '../../notifier/job_completion_notifications';
 import { Job } from '../job';
 

x-pack/plugins/reporting/public/plugin.ts

@@ -25,7 +25,6 @@ import type { HomePublicPluginSetup, HomePublicPluginStart } from '@kbn/home-plu
 import { ManagementSetup, ManagementStart } from '@kbn/management-plugin/public';
 import { LicensingPluginStart } from '@kbn/licensing-plugin/public';
 import { durationToNumber } from '../common/schema_utils';
-import { JobId, JobSummarySet } from '../common/types';
 import { ReportingSetup, ReportingStart } from '.';
 import { ReportingAPIClient } from './lib/reporting_api_client';
 import { ReportingNotifierStreamHandler as StreamHandler } from './lib/stream_handler';
@@ -42,6 +41,7 @@ import { AppNavLinkStatus } from './shared_imports';
 import { reportingCsvShareProvider } from './share_context_menu/register_csv_reporting';
 import { reportingScreenshotShareProvider } from './share_context_menu/register_pdf_png_reporting';
 import { JOB_COMPLETION_NOTIFICATIONS_SESSION_KEY } from '../common/constants';
+import { JobId, JobSummarySet } from '../common/types';
 
 export interface ClientConfigType {
   poll: { jobsRefresh: { interval: number; intervalErrorMultiplier: number } };

x-pack/plugins/reporting/public/redirect/redirect_app.tsx

@@ -14,8 +14,8 @@ import { EuiCallOut, EuiCodeBlock } from '@elastic/eui';
 import type { ScopedHistory } from '@kbn/core/public';
 import type { ScreenshotModePluginSetup } from '@kbn/screenshot-mode-plugin/public';
 
-import { REPORTING_REDIRECT_LOCATOR_STORE_KEY } from '../../common/constants';
 import { LocatorParams } from '../../common/types';
+import { REPORTING_REDIRECT_LOCATOR_STORE_KEY } from '../../common/constants';
 
 import { ReportingAPIClient } from '../lib/reporting_api_client';
 import type { SharePluginSetup } from '../shared_imports';

x-pack/plugins/reporting/public/share_context_menu/register_csv_reporting.tsx

@@ -53,7 +53,6 @@ export const reportingCsvShareProvider = ({
     const licenseHasCsvReporting = licenseCheck.showLinks;
     const licenseDisabled = !licenseCheck.enableLinks;
 
-    // TODO: add abstractions in ExportTypeRegistry to use here?
     let capabilityHasCsvReporting = false;
     if (usesUiCapabilities) {
       capabilityHasCsvReporting = application.capabilities.discover?.generateCsv === true;

x-pack/plugins/reporting/public/share_context_menu/reporting_panel_content/reporting_panel_content.tsx

@@ -21,14 +21,14 @@ import React, { Component, ReactElement } from 'react';
 import { IUiSettingsClient, ThemeServiceSetup, ToastsSetup } from '@kbn/core/public';
 import url from 'url';
 import { toMountPoint } from '@kbn/kibana-react-plugin/public';
+import { BaseParams } from '../../../common/types';
 import {
   CSV_REPORT_TYPE,
   PDF_REPORT_TYPE,
   PDF_REPORT_TYPE_V2,
   PNG_REPORT_TYPE,
   PNG_REPORT_TYPE_V2,
 } from '../../../common/constants';
-import { BaseParams } from '../../../common/types';
 import { ReportingAPIClient } from '../../lib/reporting_api_client';
 import { ErrorUnsavedWorkPanel, ErrorUrlTooLongPanel } from './components';
 import { getMaxUrlLength } from './constants';