Relocating module @kbn/presentation-publishing

elastic · Dec 5, 2024 · 36203b0 · 36203b0
1 parent 25ae8cc
commit 36203b0
Show file tree

Hide file tree

Showing 52 changed files with 12 additions and 12 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -549,7 +549,6 @@ packages/kbn-xstate-utils @elastic/obs-ux-logs-team
 packages/kbn-yarn-lock-validator @elastic/kibana-operations
 packages/kbn-zod @elastic/kibana-core
 packages/kbn-zod-helpers @elastic/security-detection-rule-management
-packages/presentation/presentation_publishing @elastic/kibana-presentation
 packages/react/kibana_context/common @elastic/appex-sharedux
 packages/react/kibana_context/render @elastic/appex-sharedux
 packages/react/kibana_context/root @elastic/appex-sharedux
@@ -623,6 +622,7 @@ src/platform/packages/private/kbn-panel-loader @elastic/kibana-presentation
 src/platform/packages/shared/kbn-doc-links @elastic/docs
 src/platform/packages/shared/kbn-flot-charts @elastic/kibana-presentation @elastic/stack-monitoring
 src/platform/packages/shared/presentation/presentation_containers @elastic/kibana-presentation
+src/platform/packages/shared/presentation/presentation_publishing @elastic/kibana-presentation
 src/platform/plugins/private/input_control_vis @elastic/kibana-presentation
 src/platform/plugins/private/links @elastic/kibana-presentation
 src/platform/plugins/private/maps_ems @elastic/kibana-presentation

diff --git a/package.json b/package.json
@@ -722,7 +722,7 @@
     "@kbn/preboot-example-plugin": "link:examples/preboot_example",
     "@kbn/presentation-containers": "link:src/platform/packages/shared/presentation/presentation_containers",
     "@kbn/presentation-panel-plugin": "link:src/platform/plugins/private/presentation_panel",
-    "@kbn/presentation-publishing": "link:packages/presentation/presentation_publishing",
+    "@kbn/presentation-publishing": "link:src/platform/packages/shared/presentation/presentation_publishing",
     "@kbn/presentation-util-plugin": "link:src/plugins/presentation_util",
     "@kbn/product-doc-base-plugin": "link:x-pack/plugins/ai_infra/product_doc_base",
     "@kbn/product-doc-common": "link:x-pack/packages/ai-infra/product-doc-common",

diff --git a/...ntation/presentation_publishing/README.md → ...ntation/presentation_publishing/README.md b/...ntation/presentation_publishing/README.md → ...ntation/presentation_publishing/README.md
diff --git a/...ishing/comparators/fallback_comparator.ts → ...ishing/comparators/fallback_comparator.ts b/...ishing/comparators/fallback_comparator.ts → ...ishing/comparators/fallback_comparator.ts
diff --git a/...sentation_publishing/comparators/index.ts → ...sentation_publishing/comparators/index.ts b/...sentation_publishing/comparators/index.ts → ...sentation_publishing/comparators/index.ts
diff --git a/...blishing/comparators/state_comparators.ts → ...blishing/comparators/state_comparators.ts b/...blishing/comparators/state_comparators.ts → ...blishing/comparators/state_comparators.ts
diff --git a/...sentation_publishing/comparators/types.ts → ...sentation_publishing/comparators/types.ts b/...sentation_publishing/comparators/types.ts → ...sentation_publishing/comparators/types.ts
diff --git a/...entation/presentation_publishing/index.ts → ...entation/presentation_publishing/index.ts b/...entation/presentation_publishing/index.ts → ...entation/presentation_publishing/index.ts
diff --git a/...ishing/interfaces/can_access_view_mode.ts → ...ishing/interfaces/can_access_view_mode.ts b/...ishing/interfaces/can_access_view_mode.ts → ...ishing/interfaces/can_access_view_mode.ts
diff --git a/...hing/interfaces/can_lock_hover_actions.ts → ...hing/interfaces/can_lock_hover_actions.ts b/...hing/interfaces/can_lock_hover_actions.ts → ...hing/interfaces/can_lock_hover_actions.ts
diff --git a/...publishing/interfaces/fetch/fetch.test.ts → ...publishing/interfaces/fetch/fetch.test.ts b/...publishing/interfaces/fetch/fetch.test.ts → ...publishing/interfaces/fetch/fetch.test.ts
diff --git a/...tion_publishing/interfaces/fetch/fetch.ts → ...tion_publishing/interfaces/fetch/fetch.ts b/...tion_publishing/interfaces/fetch/fetch.ts → ...tion_publishing/interfaces/fetch/fetch.ts
diff --git a/...interfaces/fetch/initialize_time_range.ts → ...interfaces/fetch/initialize_time_range.ts b/...interfaces/fetch/initialize_time_range.ts → ...interfaces/fetch/initialize_time_range.ts
diff --git a/...hing/interfaces/fetch/publishes_reload.ts → ...hing/interfaces/fetch/publishes_reload.ts b/...hing/interfaces/fetch/publishes_reload.ts → ...hing/interfaces/fetch/publishes_reload.ts
diff --git a/...erfaces/fetch/publishes_search_session.ts → ...erfaces/fetch/publishes_search_session.ts b/...erfaces/fetch/publishes_search_session.ts → ...erfaces/fetch/publishes_search_session.ts
diff --git a/...erfaces/fetch/publishes_unified_search.ts → ...erfaces/fetch/publishes_unified_search.ts b/...erfaces/fetch/publishes_unified_search.ts → ...erfaces/fetch/publishes_unified_search.ts
diff --git a/..._publishing/interfaces/has_app_context.ts → ..._publishing/interfaces/has_app_context.ts b/..._publishing/interfaces/has_app_context.ts → ..._publishing/interfaces/has_app_context.ts
diff --git a/...ishing/interfaces/has_disable_triggers.ts → ...ishing/interfaces/has_disable_triggers.ts b/...ishing/interfaces/has_disable_triggers.ts → ...ishing/interfaces/has_disable_triggers.ts
diff --git a/...shing/interfaces/has_edit_capabilities.ts → ...shing/interfaces/has_edit_capabilities.ts b/...shing/interfaces/has_edit_capabilities.ts → ...shing/interfaces/has_edit_capabilities.ts
diff --git a/...shing/interfaces/has_execution_context.ts → ...shing/interfaces/has_execution_context.ts b/...shing/interfaces/has_execution_context.ts → ...shing/interfaces/has_execution_context.ts
diff --git a/...hing/interfaces/has_library_transforms.ts → ...hing/interfaces/has_library_transforms.ts b/...hing/interfaces/has_library_transforms.ts → ...hing/interfaces/has_library_transforms.ts
diff --git a/...n_publishing/interfaces/has_parent_api.ts → ...n_publishing/interfaces/has_parent_api.ts b/...n_publishing/interfaces/has_parent_api.ts → ...n_publishing/interfaces/has_parent_api.ts
diff --git a/...hing/interfaces/has_supported_triggers.ts → ...hing/interfaces/has_supported_triggers.ts b/...hing/interfaces/has_supported_triggers.ts → ...hing/interfaces/has_supported_triggers.ts
diff --git a/...ntation_publishing/interfaces/has_type.ts → ...ntation_publishing/interfaces/has_type.ts b/...ntation_publishing/interfaces/has_type.ts → ...ntation_publishing/interfaces/has_type.ts
diff --git a/...ntation_publishing/interfaces/has_uuid.ts → ...ntation_publishing/interfaces/has_uuid.ts b/...ntation_publishing/interfaces/has_uuid.ts → ...ntation_publishing/interfaces/has_uuid.ts
diff --git a/...ng/interfaces/publishes_blocking_error.ts → ...ng/interfaces/publishes_blocking_error.ts b/...ng/interfaces/publishes_blocking_error.ts → ...ng/interfaces/publishes_blocking_error.ts
diff --git a/...hing/interfaces/publishes_data_loading.ts → ...hing/interfaces/publishes_data_loading.ts b/...hing/interfaces/publishes_data_loading.ts → ...hing/interfaces/publishes_data_loading.ts
diff --git a/...ishing/interfaces/publishes_data_views.ts → ...ishing/interfaces/publishes_data_views.ts b/...ishing/interfaces/publishes_data_views.ts → ...ishing/interfaces/publishes_data_views.ts
diff --git a/...terfaces/publishes_disabled_action_ids.ts → ...terfaces/publishes_disabled_action_ids.ts b/...terfaces/publishes_disabled_action_ids.ts → ...terfaces/publishes_disabled_action_ids.ts
diff --git a/...hing/interfaces/publishes_phase_events.ts → ...hing/interfaces/publishes_phase_events.ts b/...hing/interfaces/publishes_phase_events.ts → ...hing/interfaces/publishes_phase_events.ts
diff --git a/...blishing/interfaces/publishes_rendered.ts → ...blishing/interfaces/publishes_rendered.ts b/...blishing/interfaces/publishes_rendered.ts → ...blishing/interfaces/publishes_rendered.ts
diff --git a/...g/interfaces/publishes_saved_object_id.ts → ...g/interfaces/publishes_saved_object_id.ts b/...g/interfaces/publishes_saved_object_id.ts → ...g/interfaces/publishes_saved_object_id.ts
diff --git a/...g/interfaces/publishes_unsaved_changes.ts → ...g/interfaces/publishes_unsaved_changes.ts b/...g/interfaces/publishes_unsaved_changes.ts → ...g/interfaces/publishes_unsaved_changes.ts
diff --git a/...lishing/interfaces/publishes_view_mode.ts → ...lishing/interfaces/publishes_view_mode.ts b/...lishing/interfaces/publishes_view_mode.ts → ...lishing/interfaces/publishes_view_mode.ts
diff --git a/...itles/publishes_panel_description.test.ts → ...itles/publishes_panel_description.test.ts b/...itles/publishes_panel_description.test.ts → ...itles/publishes_panel_description.test.ts
diff --git a/...ces/titles/publishes_panel_description.ts → ...ces/titles/publishes_panel_description.ts b/...ces/titles/publishes_panel_description.ts → ...ces/titles/publishes_panel_description.ts
diff --git a/...aces/titles/publishes_panel_title.test.ts → ...aces/titles/publishes_panel_title.test.ts b/...aces/titles/publishes_panel_title.test.ts → ...aces/titles/publishes_panel_title.test.ts
diff --git a/...nterfaces/titles/publishes_panel_title.ts → ...nterfaces/titles/publishes_panel_title.ts b/...nterfaces/titles/publishes_panel_title.ts → ...nterfaces/titles/publishes_panel_title.ts
diff --git a/...hing/interfaces/titles/titles_api.test.ts → ...hing/interfaces/titles/titles_api.test.ts b/...hing/interfaces/titles/titles_api.test.ts → ...hing/interfaces/titles/titles_api.test.ts
diff --git a/...ublishing/interfaces/titles/titles_api.ts → ...ublishing/interfaces/titles/titles_api.ts b/...ublishing/interfaces/titles/titles_api.ts → ...ublishing/interfaces/titles/titles_api.ts
diff --git a/...on/presentation_publishing/jest.config.js → ...on/presentation_publishing/jest.config.js b/...on/presentation_publishing/jest.config.js → ...on/presentation_publishing/jest.config.js
@@ -9,6 +9,6 @@
 
 module.exports = {
   preset: '@kbn/test',
-  rootDir: '../../..',
-  roots: ['<rootDir>/packages/presentation/presentation_publishing'],
+  rootDir: '../../../../../..',
+  roots: ['<rootDir>/src/platform/packages/shared/presentation/presentation_publishing'],
 };
diff --git a/...tion/presentation_publishing/kibana.jsonc → ...tion/presentation_publishing/kibana.jsonc b/...tion/presentation_publishing/kibana.jsonc → ...tion/presentation_publishing/kibana.jsonc
diff --git a/...tion/presentation_publishing/package.json → ...tion/presentation_publishing/package.json b/...tion/presentation_publishing/package.json → ...tion/presentation_publishing/package.json
diff --git a/...on_publishing/publishing_subject/index.ts → ...on_publishing/publishing_subject/index.ts b/...on_publishing/publishing_subject/index.ts → ...on_publishing/publishing_subject/index.ts
diff --git a/.../publishing_subject/publishing_batcher.ts → .../publishing_subject/publishing_batcher.ts b/.../publishing_subject/publishing_batcher.ts → .../publishing_subject/publishing_batcher.ts
diff --git a/...shing_subject/publishing_subject.test.tsx → ...shing_subject/publishing_subject.test.tsx b/...shing_subject/publishing_subject.test.tsx → ...shing_subject/publishing_subject.test.tsx
diff --git a/.../publishing_subject/publishing_subject.ts → .../publishing_subject/publishing_subject.ts b/.../publishing_subject/publishing_subject.ts → .../publishing_subject/publishing_subject.ts
diff --git a/...on_publishing/publishing_subject/types.ts → ...on_publishing/publishing_subject/types.ts b/...on_publishing/publishing_subject/types.ts → ...on_publishing/publishing_subject/types.ts
diff --git a/...ion/presentation_publishing/tsconfig.json → ...ion/presentation_publishing/tsconfig.json b/...ion/presentation_publishing/tsconfig.json → ...ion/presentation_publishing/tsconfig.json
@@ -1,5 +1,5 @@
 {
-  "extends": "../../../tsconfig.base.json",
+  "extends": "../../../../../../tsconfig.base.json",
   "compilerOptions": {
     "outDir": "target/types",
     "types": ["jest", "node", "react"]

diff --git a/src/platform/plugins/shared/embeddable/README.md b/src/platform/plugins/shared/embeddable/README.md
@@ -16,19 +16,19 @@ Each embeddable manages its own state. This is because the embeddable system all
 #### Publishing package
 An embeddable API is a plain old typescript object that implements any number of shared interfaces. A shared interface is defined by a publishing package. A publishing package also provides a type guard that is used to check if a given object fulfills the interface.
 
-For example, the [has_edit_capabilites](https://github.com/elastic/kibana/tree/main/packages/presentation/presentation_publishing/interfaces/has_edit_capabilities.ts) publishing package defines the `HasEditCapabilities` interface and the `apiHasEditCapabilities` type guard. The [edit panal action](https://github.com/elastic/kibana/tree/main/src/platform/plugins/private/presentation_panel/public/panel_actions/edit_panel_action/edit_panel_action.ts) defines the "Edit" panel context menu action. The action's `isCompatible` check uses the `apiHasEditCapabilities` type guard to check that an embeddable API implements the `HasEditCapabilities` interface. When an embeddable API implements the interface and all other conditions of `isCompatible` check are true, the "Edit" action is availabe in the panel context menu. When an embeddable API does not implement the interface, the "Edit" action is not available in the panel context menu.
+For example, the [has_edit_capabilites](https://github.com/elastic/kibana/tree/main/src/platform/packages/shared/presentation/presentation_publishing/interfaces/has_edit_capabilities.ts) publishing package defines the `HasEditCapabilities` interface and the `apiHasEditCapabilities` type guard. The [edit panal action](https://github.com/elastic/kibana/tree/main/src/platform/plugins/private/presentation_panel/public/panel_actions/edit_panel_action/edit_panel_action.ts) defines the "Edit" panel context menu action. The action's `isCompatible` check uses the `apiHasEditCapabilities` type guard to check that an embeddable API implements the `HasEditCapabilities` interface. When an embeddable API implements the interface and all other conditions of `isCompatible` check are true, the "Edit" action is availabe in the panel context menu. When an embeddable API does not implement the interface, the "Edit" action is not available in the panel context menu.
 
 #### Publishing subject
 An embeddable API shares state via a publishing subject, a read only RxJS Observable.
 
-For example, [publishes_panel_title](https://github.com/elastic/kibana/tree/main/packages/presentation/presentation_publishing/interfaces/titles/publishes_panel_title.ts) publishing package defines interfaces and type guards for title state. [initializeTitles](https://github.com/elastic/kibana/tree/main/packages/presentation/presentation_publishing/interfaces/titles/titles_api.ts) provides an implemenation for the titles publishing package. `panelTitle` is provided as a publishing subject. [PresentationPanelInternal React component](https://github.com/elastic/kibana/tree/main/src/platform/plugins/private/presentation_panel/public/panel_component/presentation_panel_internal.tsx) uses a hook to consume `panelTitle` as React state. Changes to `panelTitle` publishing subject updates React state, which in turn, causes the UI to re-render with the current value. [CustomizePanelEditor React component](https://github.com/elastic/kibana/tree/main/src/platform/plugins/private/presentation_panel/public/panel_actions/customize_panel_action/customize_panel_editor.tsx) uses `api.setPanelTitle` to set the title on save.
+For example, [publishes_panel_title](https://github.com/elastic/kibana/tree/main/src/platform/packages/shared/presentation/presentation_publishing/interfaces/titles/publishes_panel_title.ts) publishing package defines interfaces and type guards for title state. [initializeTitles](https://github.com/elastic/kibana/tree/main/src/platform/packages/shared/presentation/presentation_publishing/interfaces/titles/titles_api.ts) provides an implemenation for the titles publishing package. `panelTitle` is provided as a publishing subject. [PresentationPanelInternal React component](https://github.com/elastic/kibana/tree/main/src/platform/plugins/private/presentation_panel/public/panel_component/presentation_panel_internal.tsx) uses a hook to consume `panelTitle` as React state. Changes to `panelTitle` publishing subject updates React state, which in turn, causes the UI to re-render with the current value. [CustomizePanelEditor React component](https://github.com/elastic/kibana/tree/main/src/platform/plugins/private/presentation_panel/public/panel_actions/customize_panel_action/customize_panel_editor.tsx) uses `api.setPanelTitle` to set the title on save.
 
 #### Comparators
 Comparators allow a page to track changes to an embeddable's state. For example, Dashboard uses comparators to display a UI notification for unsaved changes, to reset changes, and persist unsaved changes to session storage.
 
 A comparator must be provided for each property in an embeddable's RuntimeState. A comparator is a 3 element tuple: where the first element is a publishing subject providing the current value. The second element is a setter allowing the page to reset the value. The third element is an optional comparator function which provides logic to diff this property.
 
-For example, [initializeTitles](https://github.com/elastic/kibana/tree/main/packages/presentation/presentation_publishing/interfaces/titles/titles_api.ts) provides an implemenation for the titles publishing package. Comparitors are provided for each property from `SerializedTitles`.
+For example, [initializeTitles](https://github.com/elastic/kibana/tree/main/src/platform/packages/shared/presentation/presentation_publishing/interfaces/titles/titles_api.ts) provides an implemenation for the titles publishing package. Comparitors are provided for each property from `SerializedTitles`.
 
 ### Best practices
 
@@ -42,7 +42,7 @@ Break your Component into a Package or another plugin to avoid circular plugin d
 Embeddable APIs are accessable to all Kibana systems and all embeddable siblings and parents. Functions and state that are internal to an embeddable including any child components should not be added to the API. Consider passing internal state to child as props or react context.
 
 #### Error handling
-Embeddables should never throw. Instead, use [PublishesBlockingError](https://github.com/elastic/kibana/blob/main/packages/presentation/presentation_publishing/interfaces/publishes_blocking_error.ts) interface to surface unrecoverable errors. When an embeddable publishes a blocking error, the parent component will display an error component instead of the embeddable Component. Be thoughtful about which errors are surfaced with the PublishesBlockingError interface. If the embeddable can still render, use less invasive error handling such as a warning toast or notifications in the embeddable Component UI.
+Embeddables should never throw. Instead, use [PublishesBlockingError](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/presentation/presentation_publishing/interfaces/publishes_blocking_error.ts) interface to surface unrecoverable errors. When an embeddable publishes a blocking error, the parent component will display an error component instead of the embeddable Component. Be thoughtful about which errors are surfaced with the PublishesBlockingError interface. If the embeddable can still render, use less invasive error handling such as a warning toast or notifications in the embeddable Component UI.
 
 ### Examples 
 Examples available at [/examples/embeddable_examples](https://github.com/elastic/kibana/tree/main/examples/embeddable_examples)

diff --git a/tsconfig.base.json b/tsconfig.base.json
@@ -1398,8 +1398,8 @@
       "@kbn/presentation-containers/*": ["src/platform/packages/shared/presentation/presentation_containers/*"],
       "@kbn/presentation-panel-plugin": ["src/platform/plugins/private/presentation_panel"],
       "@kbn/presentation-panel-plugin/*": ["src/platform/plugins/private/presentation_panel/*"],
-      "@kbn/presentation-publishing": ["packages/presentation/presentation_publishing"],
-      "@kbn/presentation-publishing/*": ["packages/presentation/presentation_publishing/*"],
+      "@kbn/presentation-publishing": ["src/platform/packages/shared/presentation/presentation_publishing"],
+      "@kbn/presentation-publishing/*": ["src/platform/packages/shared/presentation/presentation_publishing/*"],
       "@kbn/presentation-util-plugin": ["src/plugins/presentation_util"],
       "@kbn/presentation-util-plugin/*": ["src/plugins/presentation_util/*"],
       "@kbn/product-doc-artifact-builder": ["x-pack/packages/ai-infra/product-doc-artifact-builder"],

diff --git a/yarn.lock b/yarn.lock
@@ -6612,7 +6612,7 @@
   version "0.0.0"
   uid ""
 
-"@kbn/presentation-publishing@link:packages/presentation/presentation_publishing":
+"@kbn/presentation-publishing@link:src/platform/packages/shared/presentation/presentation_publishing":
   version "0.0.0"
   uid ""