[Observability] Page attachment type

.github/CODEOWNERS

@@ -873,6 +873,7 @@ x-pack/platform/packages/shared/kbn-inference-tracing-config @elastic/appex-ai-i
 x-pack/platform/packages/shared/kbn-key-value-metadata-table @elastic/obs-ux-infra_services-team @elastic/obs-ux-logs-team
 x-pack/platform/packages/shared/kbn-kibana-api-cli @elastic/appex-ai-infra
 x-pack/platform/packages/shared/kbn-langchain @elastic/security-generative-ai
+x-pack/platform/packages/shared/kbn-page-attachment-schema @elastic/obs-ux-management-team
 x-pack/platform/packages/shared/kbn-profiler-cli @elastic/obs-knowledge-team
 x-pack/platform/packages/shared/kbn-sample-parser @elastic/streams-program-team
 x-pack/platform/packages/shared/kbn-search-index-documents @elastic/search-kibana

package.json

@@ -759,6 +759,7 @@
     "@kbn/osquery-io-ts-types": "link:src/platform/packages/shared/kbn-osquery-io-ts-types",
     "@kbn/osquery-plugin": "link:x-pack/platform/plugins/shared/osquery",
     "@kbn/paertial-results-example-plugin": "link:examples/partial_results_example",
+    "@kbn/page-attachment-schema": "link:x-pack/platform/packages/shared/kbn-page-attachment-schema",
     "@kbn/painless-lab-plugin": "link:x-pack/platform/plugins/private/painless_lab",
     "@kbn/palettes": "link:src/platform/packages/shared/kbn-palettes",
     "@kbn/panel-loader": "link:src/platform/packages/private/kbn-panel-loader",

packages/kbn-optimizer/limits.yml

@@ -105,7 +105,7 @@ pageLoadAssetSize:
   navigation: 13598
   newsfeed: 12371
   noDataPage: 1749
-  observability: 107869
+  observability: 160191
   observabilityAIAssistant: 46941
   observabilityAIAssistantApp: 18553
   observabilityAiAssistantManagement: 6438

src/platform/test/plugin_functional/test_suites/core_plugins/rendering.ts

@@ -384,6 +384,7 @@ export default function ({ getService }: PluginFunctionalProviderContext) {
         'xpack.observabilityAiAssistantManagement.logSourcesEnabled (boolean?)',
         'xpack.observabilityAiAssistantManagement.spacesEnabled (boolean?)',
         'xpack.observabilityAiAssistantManagement.visibilityEnabled (boolean?)',
+        'xpack.observabilityShared.unsafe.investigativeExperienceEnabled (boolean?)',
         'share.new_version.enabled (boolean?)',
         'aiAssistantManagementSelection.preferredAIAssistantType (default?|never?|observability?|security?)',
         /**

tsconfig.base.json

@@ -1462,6 +1462,8 @@
       "@kbn/osquery-plugin/*": ["x-pack/platform/plugins/shared/osquery/*"],
       "@kbn/paertial-results-example-plugin": ["examples/partial_results_example"],
       "@kbn/paertial-results-example-plugin/*": ["examples/partial_results_example/*"],
+      "@kbn/page-attachment-schema": ["x-pack/platform/packages/shared/kbn-page-attachment-schema"],
+      "@kbn/page-attachment-schema/*": ["x-pack/platform/packages/shared/kbn-page-attachment-schema/*"],
       "@kbn/painless-lab-plugin": ["x-pack/platform/plugins/private/painless_lab"],
       "@kbn/painless-lab-plugin/*": ["x-pack/platform/plugins/private/painless_lab/*"],
       "@kbn/palettes": ["src/platform/packages/shared/kbn-palettes"],

x-pack/platform/packages/shared/kbn-page-attachment-schema/README.md

@@ -0,0 +1,3 @@
+# @kbn/page-attachment-schema
+
+This shared package contains the zod schema definition for persisted state of the page attachment type used in cases.

x-pack/platform/packages/shared/kbn-page-attachment-schema/index.ts

@@ -0,0 +1,9 @@
+/*
+ * 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.
+ */
+
+export * from './src/latest';
+export * from './src/constants';

x-pack/platform/packages/shared/kbn-page-attachment-schema/jest.config.js

@@ -0,0 +1,12 @@
+/*
+ * 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.
+ */
+
+module.exports = {
+  preset: '@kbn/test',
+  rootDir: '../../../../..',
+  roots: ['<rootDir>/x-pack/platform/packages/shared/kbn-page-attachment-schema'],
+};

x-pack/platform/packages/shared/kbn-page-attachment-schema/kibana.jsonc

@@ -0,0 +1,9 @@
+{
+  "type": "shared-common",
+  "id": "@kbn/page-attachment-schema",
+  "owner": [
+    "@elastic/obs-ux-management-team"
+  ],
+  "group": "platform",
+  "visibility": "shared"
+}

x-pack/platform/packages/shared/kbn-page-attachment-schema/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "@kbn/page-attachment-schema",
+  "description": "Page attachment zod schema definition and constants.",
+  "private": true,
+  "version": "1.0.0",
+  "license": "Elastic License 2.0"
+}

x-pack/platform/packages/shared/kbn-page-attachment-schema/src/constants.ts

@@ -0,0 +1,8 @@
+/*
+ * 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.
+ */
+
+export const PAGE_ATTACHMENT_TYPE = '.page';

x-pack/platform/packages/shared/kbn-page-attachment-schema/src/latest.ts

@@ -0,0 +1,11 @@
+/*
+ * 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.
+ */
+
+export {
+  type PageAttachmentPersistedState,
+  pageAttachmentPersistedStateSchema,
+} from './schema/latest';

x-pack/platform/packages/shared/kbn-page-attachment-schema/src/schema/latest.ts

@@ -0,0 +1,8 @@
+/*
+ * 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.
+ */
+
+export { type PageAttachmentPersistedState, pageAttachmentPersistedStateSchema } from './v1';

x-pack/platform/packages/shared/kbn-page-attachment-schema/src/schema/v1.ts

@@ -0,0 +1,40 @@
+/*
+ * 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 const pageAttachmentPersistedStateSchema = z.object({
+  /**
+   * The type of page or page asset, e.g., 'dashboard', 'synthetics-test-run', 'slo-history', etc
+   */
+  type: z.string(),
+  url: z.object({
+    /**
+     * The URL to the page or page asset, excluding the base path.
+     */
+    pathAndQuery: z.string(),
+    /**
+     * The label to render in the "Go to" action, example "View in Dashboard" for the asset
+     */
+    actionLabel: z.string(),
+    /**
+     * The label to render in the attachment comment for the page or page asset
+     */
+    label: z.string(),
+    /**
+     * The icon, rendered via {@link EuiIcon}, representing the page type, displayed in the comment and action.
+     */
+    iconType: z.string().optional(),
+  }),
+  /**
+   * Optional screen context for the page. A plain text description that
+   * can be provided to an LLM to generate a summary or perform analysis
+   */
+  screenContext: z.array(z.object({ screenDescription: z.string() })).optional(),
+});
+
+export type PageAttachmentPersistedState = z.infer<typeof pageAttachmentPersistedStateSchema>;

x-pack/platform/packages/shared/kbn-page-attachment-schema/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "extends": "../../../../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "target/types",
+    "types": [
+      "jest",
+      "node"
+    ]
+  },
+  "include": [
+    "**/*.ts"
+  ],
+  "kbn_references": [
+    "@kbn/zod",
+  ],
+  "exclude": [
+    "target/**/*",
+  ]
+}

x-pack/platform/plugins/shared/cases/common/types/domain/attachment/v1.ts

@@ -262,12 +262,13 @@ export type ExternalReferenceAttachment = rt.TypeOf<typeof ExternalReferenceAtta
 /**
  * Persistable state
  */
+export const PersistableStateAttachmentStateRt = rt.record(rt.string, jsonValueRt);
 
 export const PersistableStateAttachmentPayloadRt = rt.strict({
   type: rt.literal(AttachmentType.persistableState),
   owner: rt.string,
   persistableStateAttachmentTypeId: rt.string,
-  persistableStateAttachmentState: rt.record(rt.string, jsonValueRt),
+  persistableStateAttachmentState: PersistableStateAttachmentStateRt,
 });
 
 const PersistableStateAttachmentAttributesRt = rt.intersection([
@@ -286,6 +287,7 @@ export const PersistableStateAttachmentRt = rt.intersection([
 export type PersistableStateAttachmentPayload = rt.TypeOf<
   typeof PersistableStateAttachmentPayloadRt
 >;
+export type PersistableStateAttachmentState = rt.TypeOf<typeof PersistableStateAttachmentStateRt>;
 export type PersistableStateAttachment = rt.TypeOf<typeof PersistableStateAttachmentRt>;
 export type PersistableStateAttachmentAttributes = rt.TypeOf<
   typeof PersistableStateAttachmentAttributesRt

x-pack/platform/plugins/shared/cases/kibana.jsonc

@@ -48,7 +48,8 @@
       "savedObjectsFinder"
     ],
     "extraPublicDirs": [
-      "common"
+      "common",
+      "public/client/attachment_framework/types"
     ]
   }
 }

x-pack/platform/plugins/shared/cases/public/index.tsx

@@ -23,3 +23,5 @@ export type { CaseAttachments, CaseAttachmentsWithoutOwner } from './types';
 
 export type { ICasesDeepLinkId } from './common/navigation';
 export { getCasesDeepLinks, CasesDeepLinkId, generateCaseViewPath } from './common/navigation';
+
+export { AttachmentActionType } from './client/attachment_framework/types';

x-pack/platform/plugins/shared/cases/server/internal_attachments/index.ts

@@ -7,8 +7,7 @@
 
 import { badRequest } from '@hapi/boom';
 import { FileAttachmentMetadataRt } from '../../common/types/domain';
-import { LENS_ATTACHMENT_TYPE } from '../../common/constants/visualizations';
-import { FILE_ATTACHMENT_TYPE } from '../../common/constants';
+import { FILE_ATTACHMENT_TYPE, LENS_ATTACHMENT_TYPE } from '../../common/constants';
 
 import { decodeWithExcessOrThrow } from '../common/runtime_types';
 import type { ExternalReferenceAttachmentTypeRegistry } from '../attachment_framework/external_reference_registry';

x-pack/platform/plugins/shared/cases/server/routes/api/internal/bulk_create_attachments.ts

@@ -9,7 +9,7 @@ import { schema } from '@kbn/config-schema';
 import { INTERNAL_BULK_CREATE_ATTACHMENTS_URL } from '../../../../common/constants';
 import { createCaseError } from '../../../common/error';
 import { createCasesRoute } from '../create_cases_route';
-import { escapeHatch } from '../utils';
+import { validAttachment } from '../utils';
 import type { attachmentApiV1 } from '../../../../common/types/api';
 import type { caseDomainV1 } from '../../../../common/types/domain';
 import { DEFAULT_CASES_ROUTE_SECURITY } from '../constants';
@@ -22,7 +22,7 @@ export const bulkCreateAttachmentsRoute = createCasesRoute({
     params: schema.object({
       case_id: schema.string(),
     }),
-    body: schema.arrayOf(escapeHatch),
+    body: schema.arrayOf(validAttachment),
   },
   routerOptions: {
     access: 'internal',

x-pack/platform/plugins/shared/cases/server/routes/api/utils.test.ts

@@ -7,8 +7,15 @@
 
 import { isBoom, boomify } from '@hapi/boom';
 import { loggingSystemMock } from '@kbn/core/server/mocks';
+import { PAGE_ATTACHMENT_TYPE } from '@kbn/page-attachment-schema';
 import type { HTTPError } from '../../common/error';
-import { extractWarningValueFromWarningHeader, logDeprecatedEndpoint, wrapError } from './utils';
+import {
+  extractWarningValueFromWarningHeader,
+  logDeprecatedEndpoint,
+  wrapError,
+  validAttachment,
+  isPersistableStatePageAttachment,
+} from './utils';
 
 describe('Utils', () => {
   describe('wrapError', () => {
@@ -83,4 +90,57 @@ describe('Utils', () => {
       );
     });
   });
+
+  describe('validAttachment', () => {
+    it('validates a valid attachment', () => {
+      const attachment = {
+        persistableStateAttachmentTypeId: PAGE_ATTACHMENT_TYPE,
+        persistableStateAttachmentState: {
+          url: { pathAndQuery: '/internal/safe-url' },
+        },
+      };
+
+      expect(validAttachment.validate(attachment)).toEqual(attachment);
+    });
+
+    it('throws an error for an external URL', () => {
+      const invalidAttachment = {
+        persistableStateAttachmentTypeId: PAGE_ATTACHMENT_TYPE,
+        persistableStateAttachmentState: {
+          url: { pathAndQuery: 'http://external-url.com' },
+        },
+      };
+
+      expect(() => validAttachment.validate(invalidAttachment)).toThrow(
+        'External urls are not supported for page attachments. The provided url is: http://external-url.com'
+      );
+    });
+  });
+
+  describe('isPersistableStatePageAttachment', () => {
+    it('returns true for a valid persistable state page attachment', () => {
+      const attachment = {
+        persistableStateAttachmentTypeId: PAGE_ATTACHMENT_TYPE,
+        persistableStateAttachmentState: {},
+      };
+
+      expect(isPersistableStatePageAttachment(attachment)).toBe(true);
+    });
+
+    it('returns false for an invalid attachment', () => {
+      const invalidAttachment = {
+        someOtherProperty: 'value',
+      };
+
+      expect(isPersistableStatePageAttachment(invalidAttachment)).toBe(false);
+    });
+
+    it('returns false for a null value', () => {
+      expect(isPersistableStatePageAttachment(null)).toBe(false);
+    });
+
+    it('returns false for a non-object value', () => {
+      expect(isPersistableStatePageAttachment('string')).toBe(false);
+    });
+  });
 });

x-pack/platform/plugins/shared/cases/server/routes/api/utils.ts

@@ -9,6 +9,12 @@ import type { Boom } from '@hapi/boom';
 import { boomify, isBoom } from '@hapi/boom';
 import { schema } from '@kbn/config-schema';
 import type { CustomHttpResponseOptions, ResponseError, Headers, Logger } from '@kbn/core/server';
+import { isInternalURL } from '@kbn/std';
+import {
+  type PageAttachmentPersistedState,
+  PAGE_ATTACHMENT_TYPE,
+} from '@kbn/page-attachment-schema';
+import type { AttachmentRequestAttributes } from '../../common/types/attachments';
 import type { CaseError, HTTPError } from '../../common/error';
 import { isCaseError, isHTTPError } from '../../common/error';
 
@@ -35,7 +41,45 @@ export function wrapError(
   };
 }
 
-export const escapeHatch = schema.object({}, { unknowns: 'allow' });
+export const escapeHatch = schema.object(
+  {},
+  {
+    unknowns: 'allow',
+  }
+);
+
+export const validAttachment = schema.object(
+  {},
+  {
+    unknowns: 'allow',
+    validate: (value) => {
+      if (
+        isPersistableStatePageAttachment(value) &&
+        value.persistableStateAttachmentTypeId === PAGE_ATTACHMENT_TYPE
+      ) {
+        const persistedState =
+          value.persistableStateAttachmentState as PageAttachmentPersistedState;
+        const url = persistedState?.url?.pathAndQuery;
+        if (url && !isInternalURL(url)) {
+          return `External urls are not supported for page attachments. The provided url is: ${url}`;
+        }
+      }
+    },
+  }
+);
+
+/**
+ * Checks if the given value is a persistable state page attachment type.
+ */
+export const isPersistableStatePageAttachment = (
+  value: unknown
+): value is AttachmentRequestAttributes => {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    Boolean((value as AttachmentRequestAttributes).persistableStateAttachmentTypeId)
+  );
+};
 
 /**
  * Creates a warning header with a message formatted according to RFC7234.

x-pack/platform/plugins/shared/cases/tsconfig.json

@@ -93,7 +93,8 @@
     "@kbn/elastic-assistant-common",
     "@kbn/test",
     "@kbn/dev-utils",
-    "@kbn/tooling-log"
+    "@kbn/tooling-log",
+    "@kbn/page-attachment-schema"
   ],
   "exclude": ["target/**/*"]
 }

x-pack/platform/plugins/shared/triggers_actions_ui/kibana.jsonc

@@ -26,7 +26,6 @@
       "dataViewEditor",
       "alerting",
       "actions",
-      "dashboard",
       "licensing",
       "expressions",
       "lens",