Merge branch 'main' into fleet/openapi-tags

.buildkite/scripts/steps/storybooks/build_and_upload.ts

@@ -19,7 +19,7 @@ const STORYBOOKS = [
   'cloud_chat',
   'coloring',
   'chart_icons',
-  'content_management_plugin',
+  'content_management_examples',
   'controls',
   'custom_integrations',
   'dashboard_enhanced',

.github/CODEOWNERS

@@ -83,6 +83,7 @@ packages/kbn-config-mocks @elastic/kibana-core
 packages/kbn-config-schema @elastic/kibana-core
 src/plugins/console @elastic/platform-deployment-management
 packages/content-management/content_editor @elastic/appex-sharedux
+examples/content_management_examples @elastic/appex-sharedux
 src/plugins/content_management @elastic/appex-sharedux
 packages/content-management/table_list @elastic/appex-sharedux
 examples/controls_example @elastic/kibana-presentation

docs/api/cases.asciidoc

@@ -8,6 +8,7 @@ these APIs:
 * <<cases-api-create>>
 * <<cases-api-delete-cases>>
 * <<cases-api-delete-comments>>
+* <<cases-api-find-case-activity>>
 * <<cases-api-find-cases>>
 * <<cases-api-find-connectors>>
 * <<cases-api-get-alerts>>
@@ -33,6 +34,7 @@ include::cases/cases-api-create.asciidoc[leveloffset=+1]
 include::cases/cases-api-delete-cases.asciidoc[leveloffset=+1]
 include::cases/cases-api-delete-comments.asciidoc[leveloffset=+1]
 //FIND
+include::cases/cases-api-find-case-activity.asciidoc[leveloffset=+1]
 include::cases/cases-api-find-cases.asciidoc[leveloffset=+1]
 include::cases/cases-api-find-connectors.asciidoc[leveloffset=+1]
 //GET

docs/api/cases/cases-api-find-case-activity.asciidoc

@@ -0,0 +1,20 @@
+[[cases-api-find-case-activity]]
+== Find case activity API
+++++
+<titleabbrev>Find case activity</titleabbrev>
+++++
+
+Finds user activity for a case.
+
+[NOTE]
+====
+For the most up-to-date API details, refer to the
+{kib-repo}/tree/{branch}/x-pack/plugins/cases/docs/openapi[open API specification]. For a preview, check out <<case-apis>>.
+====
+
+=== {api-request-title}
+
+`GET <kibana host>:<port>/api/cases/<case_id>/user_actions/_find`
+
+`GET <kibana host>:<port>/s/<space_id>/api/cases/<case_id>/user_actions/_find`
+

docs/api/cases/cases-api-get-case-activity.asciidoc

@@ -6,7 +6,7 @@
 
 Returns all user activity for a case.
 
-deprecated::[8.1.0]
+deprecated::[8.1.0,Use <<cases-api-find-case-activity>> instead.]
 
 [NOTE]
 ====

examples/content_management_examples/README.md

@@ -0,0 +1,3 @@
+# Content Management Examples
+
+An example plugin that shows how to integrate with the Kibana "content management" plugin.

examples/content_management_examples/common/examples/todos/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 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+export * from './todos';

examples/content_management_examples/common/examples/todos/todos.ts

@@ -0,0 +1,63 @@
+/*
+ * 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 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import { schema } from '@kbn/config-schema';
+import {
+  CreateIn,
+  DeleteIn,
+  GetIn,
+  SearchIn,
+  UpdateIn,
+} from '@kbn/content-management-plugin/common';
+
+export const TODO_CONTENT_ID = 'todos';
+export interface Todo {
+  id: string;
+  title: string;
+  completed: boolean;
+}
+const todoSchema = schema.object({
+  id: schema.string(),
+  title: schema.string(),
+  completed: schema.boolean(),
+});
+
+export type TodoCreateIn = CreateIn<'todos', { title: string }>;
+export type TodoCreateOut = Todo; // TODO: Is this correct?
+export const createInSchema = schema.object({ title: schema.string() });
+export const createOutSchema = todoSchema;
+
+export type TodoUpdateIn = UpdateIn<'todos', Partial<Omit<Todo, 'id'>>>;
+export type TodoUpdateOut = Todo;
+export const updateInSchema = schema.object({
+  title: schema.maybe(schema.string()),
+  completed: schema.maybe(schema.boolean()),
+});
+export const updateOutSchema = todoSchema;
+
+export type TodoDeleteIn = DeleteIn<'todos', { id: string }>;
+export type TodoDeleteOut = void;
+
+export type TodoGetIn = GetIn<'todos'>;
+export type TodoGetOut = Todo;
+export const getOutSchema = todoSchema;
+
+export type TodoSearchIn = SearchIn<'todos', { filter?: 'todo' | 'completed' }>;
+export interface TodoSearchOut {
+  hits: Todo[];
+}
+export const searchInSchema = schema.object({
+  filter: schema.maybe(
+    schema.oneOf([schema.literal('todo'), schema.literal('completed')], {
+      defaultValue: undefined,
+    })
+  ),
+});
+export const searchOutSchema = schema.object({
+  hits: schema.arrayOf(todoSchema),
+});

examples/content_management_examples/jest.config.js

@@ -0,0 +1,13 @@
+/*
+ * 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 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+module.exports = {
+  preset: '@kbn/test',
+  rootDir: '../..',
+  roots: ['<rootDir>/examples/content_management_examples'],
+};

examples/content_management_examples/kibana.jsonc

@@ -0,0 +1,15 @@
+{
+  "type": "plugin",
+  "id": "@kbn/content-management-examples-plugin",
+  "owner": "@elastic/appex-sharedux",
+  "description": "Example plugin integrating with content management plugin",
+  "plugin": {
+    "id": "contentManagementExamples",
+    "server": true,
+    "browser": true,
+    "requiredPlugins": [
+      "contentManagement",
+      "developerExamples"
+    ]
+  }
+}

examples/content_management_examples/public/examples/index.tsx

@@ -0,0 +1,31 @@
+/*
+ * 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 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import React from 'react';
+import ReactDOM from 'react-dom';
+import { EuiPageTemplate } from '@elastic/eui';
+import { AppMountParameters, CoreStart } from '@kbn/core/public';
+import { StartDeps } from '../types';
+import { TodoApp } from './todos';
+
+export const renderApp = (
+  { notifications }: CoreStart,
+  { contentManagement }: StartDeps,
+  { element }: AppMountParameters
+) => {
+  ReactDOM.render(
+    <EuiPageTemplate offset={0}>
+      <EuiPageTemplate.Section>
+        <TodoApp contentClient={contentManagement.client} />
+      </EuiPageTemplate.Section>
+    </EuiPageTemplate>,
+    element
+  );
+
+  return () => ReactDOM.unmountComponentAtNode(element);
+};

examples/content_management_examples/public/examples/todos/index.tsx

@@ -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 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+export { TodoApp } from './todo_app';

src/plugins/content_management/demo/todo/todo.stories.tsx → examples/content_management_examples/public/examples/todos/stories/todo.stories.tsx

@@ -7,8 +7,9 @@
  */
 
 import * as React from 'react';
-import { Todos } from './todos';
-import { ContentClientProvider, ContentClient } from '../../public/content_client';
+import { ContentClientProvider, ContentClient } from '@kbn/content-management-plugin/public';
+
+import { Todos } from '../todos';
 import { TodosClient } from './todos_client';
 
 export default {

src/plugins/content_management/demo/todo/todos_client.ts → examples/content_management_examples/public/examples/todos/stories/todos_client.ts

@@ -7,28 +7,32 @@
  */
 
 import { v4 as uuidv4 } from 'uuid';
-import type { CrudClient } from '../../public/crud_client';
-import type { CreateIn, DeleteIn, GetIn, SearchIn, UpdateIn } from '../../common';
-
-export interface Todo {
-  id: string;
-  title: string;
-  completed: boolean;
-}
-
-export type TodoCreateIn = CreateIn<'todos', { title: string }>;
-export type TodoUpdateIn = UpdateIn<'todos', Partial<Omit<Todo, 'id'>>>;
-export type TodoDeleteIn = DeleteIn<'todos', { id: string }>;
-export type TodoGetIn = GetIn<'todos'>;
-export type TodoSearchIn = SearchIn<'todos', { filter?: 'todo' | 'completed' }>;
+import type { CrudClient } from '@kbn/content-management-plugin/public';
+import type {
+  TodoCreateIn,
+  TodoUpdateIn,
+  TodoDeleteIn,
+  TodoGetIn,
+  TodoSearchIn,
+  TodoUpdateOut,
+  TodoCreateOut,
+  TodoSearchOut,
+  TodoDeleteOut,
+  Todo,
+  TodoGetOut,
+} from '../../../../common/examples/todos';
 
+/**
+ * This client is used in the storybook examples to simulate a server-side registry client
+ * and to show how a content type can have a custom client-side CRUD client without using the server-side registry
+ */
 export class TodosClient implements CrudClient {
   private todos: Todo[] = [
     { id: uuidv4(), title: 'Learn Elasticsearch', completed: true },
     { id: uuidv4(), title: 'Learn Kibana', completed: false },
   ];
 
-  async create(input: TodoCreateIn): Promise<Todo> {
+  async create(input: TodoCreateIn): Promise<TodoCreateOut> {
     const todo = {
       id: uuidv4(),
       title: input.data.title,
@@ -38,22 +42,22 @@ export class TodosClient implements CrudClient {
     return todo;
   }
 
-  async delete(input: TodoDeleteIn): Promise<void> {
+  async delete(input: TodoDeleteIn): Promise<TodoDeleteOut> {
     this.todos = this.todos.filter((todo) => todo.id !== input.id);
   }
 
-  async get(input: TodoGetIn): Promise<Todo> {
+  async get(input: TodoGetIn): Promise<TodoGetOut> {
     return this.todos.find((todo) => todo.id === input.id)!;
   }
 
-  async search(input: TodoSearchIn): Promise<{ hits: Todo[] }> {
+  async search(input: TodoSearchIn): Promise<TodoSearchOut> {
     const filter = input.query.filter;
     if (filter === 'todo') return { hits: this.todos.filter((t) => !t.completed) };
     if (filter === 'completed') return { hits: this.todos.filter((t) => t.completed) };
     return { hits: [...this.todos] };
   }
 
-  async update(input: TodoUpdateIn): Promise<Todo> {
+  async update(input: TodoUpdateIn): Promise<TodoUpdateOut> {
     const idToUpdate = input.id;
     const todoToUpdate = this.todos.find((todo) => todo.id === idToUpdate)!;
     if (todoToUpdate) {

examples/content_management_examples/public/examples/todos/todo_app.tsx

@@ -0,0 +1,19 @@
+/*
+ * 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 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import React from 'react';
+import { ContentClientProvider, type ContentClient } from '@kbn/content-management-plugin/public';
+import { Todos } from './todos';
+
+export const TodoApp = (props: { contentClient: ContentClient }) => {
+  return (
+    <ContentClientProvider contentClient={props.contentClient}>
+      <Todos />
+    </ContentClientProvider>
+  );
+};