[Content management] POC for the core (server)

docs/developer/plugin-list.asciidoc

@@ -40,6 +40,10 @@ as uiSettings within the code.
 |Console provides the user with tools for storing and executing requests against Elasticsearch.
 
 
+|{kib-repo}blob/{branch}/src/plugins/content_management[contentManagement]
+|WARNING: Missing README.
+
+
 |{kib-repo}blob/{branch}/src/plugins/controls/README.mdx[controls]
 |The Controls plugin contains Embeddables which can be used to add user-friendly interactivity to apps.
 

src/plugins/content_management/common/constants.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 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 const PLUGIN_ID = 'contentManagement';
+
+export const API_ENDPOINT = '/api/content_management/rpc';

src/plugins/content_management/common/index.ts

@@ -0,0 +1,17 @@
+/*
+ * 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 { PLUGIN_ID, API_ENDPOINT } from './constants';
+
+export { schemas as rpcSchemas, procedureNames } from './rpc';
+
+export { contentSchema } from './schemas';
+
+export type { GetIn, CreateIn, ProcedureName, ProcedureSchemas } from './rpc';
+
+export type { Ref, Content, InternalFields, CommonFields } from './schemas';

src/plugins/content_management/common/rpc.ts

@@ -0,0 +1,72 @@
+/*
+ * 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, Type } from '@kbn/config-schema';
+
+export interface ProcedureSchemas {
+  in?: Type<any> | false;
+  out?: Type<any> | false;
+}
+
+export const procedureNames = ['get', 'create'] as const;
+
+export type ProcedureName = typeof procedureNames[number];
+
+// ---------------------------------
+// API
+// ---------------------------------
+
+// ------- GET --------
+const getSchemas: ProcedureSchemas = {
+  in: schema.object(
+    {
+      contentType: schema.string(),
+      id: schema.string(),
+      options: schema.maybe(schema.object({}, { unknowns: 'allow' })),
+    },
+    { unknowns: 'forbid' }
+  ),
+  // --> "out" will be specified by each storage layer
+  out: schema.maybe(schema.object({}, { unknowns: 'allow' })),
+};
+
+export interface GetIn<T extends string = string, Options extends object = any> {
+  id: string;
+  contentType: T;
+  options?: Options;
+}
+
+// -- Create content
+const createSchemas: ProcedureSchemas = {
+  in: schema.object(
+    {
+      contentType: schema.string(),
+      data: schema.object({}, { unknowns: 'allow' }),
+      options: schema.maybe(schema.object({}, { unknowns: 'allow' })),
+    },
+    { unknowns: 'forbid' }
+  ),
+  // Here we could enforce that an "id" field is returned
+  out: schema.maybe(schema.object({}, { unknowns: 'allow' })),
+};
+
+export interface CreateIn<
+  T extends string = string,
+  Data extends object = Record<string, unknown>,
+  Options extends object = any
+> {
+  contentType: T;
+  data: Data;
+  options?: Options;
+}
+
+export const schemas: {
+  [key in ProcedureName]: ProcedureSchemas;
+} = {
+  get: getSchemas,
+  create: createSchemas,
+};

src/plugins/content_management/common/schemas.ts

@@ -0,0 +1,69 @@
+/*
+ * 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, TypeOf } from '@kbn/config-schema';
+
+/**
+ * Interface to represent a reference field (allows to populate() content)
+ */
+export const refSchema = schema.object(
+  {
+    $id: schema.string(),
+  },
+  { unknowns: 'forbid' }
+);
+
+export type Ref = TypeOf<typeof refSchema>;
+
+/**
+ * Fields that _all_ content must have (fields editable by the user)
+ */
+export const commonFieldsProps = {
+  title: schema.string(),
+  description: schema.maybe(schema.string()),
+};
+
+const commonFieldsSchema = schema.object({ ...commonFieldsProps }, { unknowns: 'forbid' });
+
+export type CommonFields = TypeOf<typeof commonFieldsSchema>;
+
+/**
+ * Fields that all content must have (fields *not* editable by the user)
+ */
+const internalFieldsProps = {
+  id: schema.string(),
+  type: schema.string(),
+  meta: schema.object(
+    {
+      updatedAt: schema.string(),
+      createdAt: schema.string(),
+      updatedBy: refSchema,
+      createdBy: refSchema,
+    },
+    { unknowns: 'forbid' }
+  ),
+};
+
+export const internalFieldsSchema = schema.object(
+  { ...internalFieldsProps },
+  { unknowns: 'forbid' }
+);
+
+export type InternalFields = TypeOf<typeof internalFieldsSchema>;
+
+/**
+ * Base type for all content (in the search index)
+ */
+export const contentSchema = schema.object(
+  {
+    ...internalFieldsProps,
+    ...commonFieldsProps,
+  },
+  { unknowns: 'forbid' }
+);
+
+export type Content = TypeOf<typeof contentSchema>;

src/plugins/content_management/kibana.json

@@ -0,0 +1,14 @@
+{
+  "id": "contentManagement",
+  "version": "kibana",
+  "server": true,
+  "ui": true,
+  "requiredPlugins": ["management", "esUiShared"],
+  "requiredBundles": [],
+  "optionalPlugins": [],
+  "owner": {
+    "name": "@elastic/kibana-global-experience",
+    "githubTeam": "@elastic/kibana-global-experience"
+  },
+  "description": "Content management app"
+}

src/plugins/content_management/public/demo-app/app.tsx

@@ -0,0 +1,41 @@
+/*
+ * 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 type { FC } from 'react';
+import { KibanaPageTemplate } from '@kbn/shared-ux-page-kibana-template';
+
+import { EuiSpacer } from '@elastic/eui';
+import { CreateContentSection, ContentDetailsSection } from './components';
+
+export const App: FC = () => {
+  return (
+    <KibanaPageTemplate panelled>
+      <KibanaPageTemplate.Header
+        pageTitle="Content management POC"
+        description=""
+        rightSideItems={[<button>Todo</button>]}
+      />
+      <KibanaPageTemplate.Section>
+        {/* Search */}
+        {/* <SearchContentSection />
+        <EuiSpacer size="xl" /> */}
+
+        {/* Content details */}
+        <ContentDetailsSection />
+        <EuiSpacer size="xl" />
+
+        {/* Content preview */}
+        {/* <ContentPreviewSection />
+        <EuiSpacer size="xl" /> */}
+
+        {/* Create memory content */}
+        <CreateContentSection />
+      </KibanaPageTemplate.Section>
+    </KibanaPageTemplate>
+  );
+};

src/plugins/content_management/public/demo-app/components/content_details_section.tsx

@@ -0,0 +1,94 @@
+/*
+ * 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, { FC, useState } from 'react';
+import useDebounce from 'react-use/lib/useDebounce';
+import {
+  EuiFieldText,
+  EuiFlexGroup,
+  EuiFlexItem,
+  EuiFormRow,
+  EuiSpacer,
+  EuiTitle,
+} from '@elastic/eui';
+import { EuiCodeEditor } from '@kbn/es-ui-shared-plugin/public';
+
+import { useApp } from '../context';
+
+export const ContentDetailsSection: FC = () => {
+  const { rpc } = useApp();
+
+  const [contentType, setContentType] = useState('foo');
+  const [contentId, setContentId] = useState('');
+  const [content, setContent] = useState<Record<string, unknown>>({});
+
+  const isIdEmpty = contentId.trim() === '';
+
+  useDebounce(
+    () => {
+      const load = async () => {
+        const res = await rpc.get({ contentType, id: contentId });
+        setContent(res as Record<string, unknown>);
+      };
+
+      if (!isIdEmpty) {
+        load();
+      }
+    },
+    500,
+    [rpc, contentType, contentId, isIdEmpty]
+  );
+
+  return (
+    <>
+      <EuiTitle>
+        <h2>Content details</h2>
+      </EuiTitle>
+      <EuiSpacer />
+      <EuiFlexGroup>
+        <EuiFlexItem>
+          <EuiFormRow label="Type" helpText="The content type" fullWidth>
+            <EuiFieldText
+              value={contentType}
+              onChange={(e) => {
+                setContentType(e.currentTarget.value);
+              }}
+              fullWidth
+            />
+          </EuiFormRow>
+
+          <EuiFormRow label="Id" helpText="The content id" fullWidth>
+            <EuiFieldText
+              value={contentId}
+              onChange={(e) => {
+                setContentId(e.currentTarget.value);
+              }}
+              fullWidth
+            />
+          </EuiFormRow>
+        </EuiFlexItem>
+        <EuiFlexItem>
+          <EuiCodeEditor
+            value={JSON.stringify(content, null, 4)}
+            width="100%"
+            height="500px"
+            mode="json"
+            readOnly
+            wrapEnabled
+            showPrintMargin={false}
+            theme="textmate"
+            editorProps={{ $blockScrolling: true }}
+            setOptions={{
+              tabSize: 2,
+              useSoftTabs: true,
+            }}
+          />
+        </EuiFlexItem>
+      </EuiFlexGroup>
+    </>
+  );
+};