[Content Management] Maps onboard

packages/kbn-object-versioning/lib/content_management_types.ts

@@ -64,52 +64,52 @@ export interface ServicesDefinition {
 export interface ServiceTransforms {
   get: {
     in: {
-      options: ObjectTransforms;
+      options: ObjectTransforms<any, any, any, any>;
     };
     out: {
-      result: ObjectTransforms;
+      result: ObjectTransforms<any, any, any, any>;
     };
   };
   bulkGet: {
     in: {
-      options: ObjectTransforms;
+      options: ObjectTransforms<any, any, any, any>;
     };
     out: {
-      result: ObjectTransforms;
+      result: ObjectTransforms<any, any, any, any>;
     };
   };
   create: {
     in: {
-      data: ObjectTransforms;
-      options: ObjectTransforms;
+      data: ObjectTransforms<any, any, any, any>;
+      options: ObjectTransforms<any, any, any, any>;
     };
     out: {
-      result: ObjectTransforms;
+      result: ObjectTransforms<any, any, any, any>;
     };
   };
   update: {
     in: {
-      data: ObjectTransforms;
-      options: ObjectTransforms;
+      data: ObjectTransforms<any, any, any, any>;
+      options: ObjectTransforms<any, any, any, any>;
     };
     out: {
-      result: ObjectTransforms;
+      result: ObjectTransforms<any, any, any, any>;
     };
   };
   delete: {
     in: {
-      options: ObjectTransforms;
+      options: ObjectTransforms<any, any, any, any>;
     };
     out: {
-      result: ObjectTransforms;
+      result: ObjectTransforms<any, any, any, any>;
     };
   };
   search: {
     in: {
-      options: ObjectTransforms;
+      options: ObjectTransforms<any, any, any, any>;
     };
     out: {
-      result: ObjectTransforms;
+      result: ObjectTransforms<any, any, any, any>;
     };
   };
 }

packages/kbn-object-versioning/lib/object_transform.test.ts

@@ -9,12 +9,7 @@
 import { schema } from '@kbn/config-schema';
 import { initTransform } from './object_transform';
 
-import type {
-  ObjectMigrationDefinition,
-  ObjectTransforms,
-  Version,
-  VersionableObject,
-} from './types';
+import type { ObjectMigrationDefinition, Version, VersionableObject } from './types';
 
 interface FooV1 {
   fullName: string;
@@ -58,7 +53,7 @@ const fooMigrationDef: ObjectMigrationDefinition = {
 
 const setup = <UpIn = unknown, UpOut = unknown, DownIn = unknown, DownOut = unknown>(
   browserVersion: Version
-): ObjectTransforms<UpIn, UpOut, DownIn, DownOut> => {
+) => {
   const transformsFactory = initTransform<UpIn, UpOut, DownIn, DownOut>(browserVersion);
   return transformsFactory(fooMigrationDef);
 };

packages/kbn-object-versioning/lib/object_transform.ts

@@ -6,7 +6,7 @@
  * Side Public License, v 1.
  */
 
-import { ObjectMigrationDefinition, ObjectTransform, ObjectTransforms, Version } from './types';
+import { ObjectMigrationDefinition, ObjectTransform, Version } from './types';
 import { validateObj, validateVersion } from './utils';
 
 /**
@@ -97,11 +97,8 @@ const getTransformFns = <I = unknown, O = unknown>(
  */
 export const initTransform =
   <UpIn = unknown, UpOut = unknown, DownIn = unknown, DownOut = unknown>(requestVersion: Version) =>
-  (
-    migrationDefinition: ObjectMigrationDefinition
-  ): ObjectTransforms<UpIn, UpOut, DownIn, DownOut> => {
+  (migrationDefinition: ObjectMigrationDefinition) => {
     const { latestVersion } = getVersionsMeta(migrationDefinition);
-
     const getVersion = (v: Version | 'latest'): Version => (v === 'latest' ? latestVersion : v);
 
     const validateFn = (value: unknown, version: number = requestVersion) => {
@@ -120,7 +117,11 @@ export const initTransform =
     };
 
     return {
-      up: (obj, to = 'latest', { validate = true }: { validate?: boolean } = {}) => {
+      up: <I = UpIn, O = UpOut>(
+        obj: I,
+        to: number | 'latest' = 'latest',
+        { validate = true }: { validate?: boolean } = {}
+      ) => {
         try {
           if (!migrationDefinition[requestVersion]) {
             return {
@@ -145,16 +146,12 @@ export const initTransform =
             };
           }
 
-          const fns = getTransformFns<UpIn, UpOut>(
-            requestVersion,
-            targetVersion,
-            migrationDefinition
-          );
+          const fns = getTransformFns<I, O>(requestVersion, targetVersion, migrationDefinition);
 
           const value = fns.reduce((acc, fn) => {
-            const res = fn(acc as unknown as UpIn);
+            const res = fn(acc as unknown as I);
             return res;
-          }, obj as unknown as UpOut);
+          }, obj as unknown as O);
 
           return { value, error: null };
         } catch (e) {
@@ -164,7 +161,11 @@ export const initTransform =
           };
         }
       },
-      down: (obj, from = 'latest', { validate = true }: { validate?: boolean } = {}) => {
+      down: <I = DownIn, O = DownOut>(
+        obj: I,
+        from: number | 'latest' = 'latest',
+        { validate = true }: { validate?: boolean } = {}
+      ) => {
         try {
           if (!migrationDefinition[requestVersion]) {
             return {
@@ -189,16 +190,12 @@ export const initTransform =
             }
           }
 
-          const fns = getTransformFns<DownIn, DownOut>(
-            fromVersion,
-            requestVersion,
-            migrationDefinition
-          );
+          const fns = getTransformFns<I, O>(fromVersion, requestVersion, migrationDefinition);
 
           const value = fns.reduce((acc, fn) => {
-            const res = fn(acc as unknown as DownIn);
+            const res = fn(acc as unknown as I);
             return res;
-          }, obj as unknown as DownOut);
+          }, obj as unknown as O);
 
           return { value: value as any, error: null };
         } catch (e) {

packages/kbn-object-versioning/lib/types.ts

@@ -42,21 +42,21 @@ export interface ObjectTransforms<
   DownIn = unknown,
   DownOut = unknown
 > {
-  up: (
-    obj: UpIn,
+  up: <I = UpIn, O = UpOut>(
+    obj: I,
     version?: Version | 'latest',
     options?: {
       /** Validate the object _before_ up transform */
       validate?: boolean;
     }
-  ) => TransformReturn<UpOut>;
-  down: (
+  ) => TransformReturn<O>;
+  down: <I = DownIn, O = DownOut>(
     obj: DownIn,
     version?: Version | 'latest',
     options?: {
       /** Validate the object _before_ down transform */
       validate?: boolean;
     }
-  ) => TransformReturn<DownOut>;
+  ) => TransformReturn<O>;
   validate: (obj: any, version?: Version) => ValidationError | null;
 }

src/plugins/content_management/public/rpc_client/rpc_client.ts

@@ -34,11 +34,11 @@ export class RpcClient implements CrudClient {
   constructor(private http: { post: HttpSetup['post'] }) {}
 
   public get<I extends GetIn = GetIn, O = unknown, M = unknown>(input: I) {
-    return this.sendMessage<GetResponse<O, M>>('get', input).then((r) => r.item);
+    return this.sendMessage<GetResponse<O, M>>('get', input).then((r) => r.result);
   }
 
   public bulkGet<I extends BulkGetIn = BulkGetIn, O = unknown, M = unknown>(input: I) {
-    return this.sendMessage<BulkGetResponse<O, M>>('bulkGet', input).then((r) => r.items);
+    return this.sendMessage<BulkGetResponse<O, M>>('bulkGet', input).then((r) => r.result);
   }
 
   public create<I extends CreateIn = CreateIn, O = unknown, M = unknown>(input: I) {

src/plugins/content_management/server/core/core.test.ts

@@ -165,7 +165,7 @@ describe('Content Core', () => {
           const { fooContentCrud, ctx, cleanUp } = setup({ registerFooType: true });
 
           const res = await fooContentCrud!.get(ctx, '1');
-          expect(res.item.item).toBeUndefined();
+          expect(res.result.item).toBeUndefined();
 
           cleanUp();
         });
@@ -176,7 +176,7 @@ describe('Content Core', () => {
           const res = await fooContentCrud!.get(ctx, '1', { forwardInResponse: { foo: 'bar' } });
           expect(res).toEqual({
             contentTypeId: FOO_CONTENT_ID,
-            item: {
+            result: {
               item: {
                 // Options forwared in response
                 options: { foo: 'bar' },
@@ -191,7 +191,7 @@ describe('Content Core', () => {
           const { fooContentCrud, ctx, cleanUp } = setup({ registerFooType: true });
 
           const res = await fooContentCrud!.bulkGet(ctx, ['1', '2']);
-          expect(res.items).toEqual({
+          expect(res.result).toEqual({
             hits: [{ item: undefined }, { item: undefined }],
           });
 
@@ -207,7 +207,7 @@ describe('Content Core', () => {
 
           expect(res).toEqual({
             contentTypeId: FOO_CONTENT_ID,
-            items: {
+            result: {
               hits: [
                 {
                   item: {
@@ -230,15 +230,15 @@ describe('Content Core', () => {
           const { fooContentCrud, ctx, cleanUp } = setup({ registerFooType: true });
 
           const res = await fooContentCrud!.get(ctx, '1234');
-          expect(res.item.item).toBeUndefined();
+          expect(res.result.item).toBeUndefined();
           await fooContentCrud!.create(
             ctx,
             { title: 'Hello' },
             { id: '1234' } // We send this "id" option to specify the id of the content created
           );
           expect(fooContentCrud!.get(ctx, '1234')).resolves.toEqual({
             contentTypeId: FOO_CONTENT_ID,
-            item: {
+            result: {
               item: {
                 id: '1234',
                 title: 'Hello',
@@ -256,7 +256,7 @@ describe('Content Core', () => {
           await fooContentCrud!.update(ctx, '1234', { title: 'changed' });
           expect(fooContentCrud!.get(ctx, '1234')).resolves.toEqual({
             contentTypeId: FOO_CONTENT_ID,
-            item: {
+            result: {
               item: {
                 id: '1234',
                 title: 'changed',
@@ -292,7 +292,7 @@ describe('Content Core', () => {
 
           expect(fooContentCrud!.get(ctx, '1234')).resolves.toEqual({
             contentTypeId: FOO_CONTENT_ID,
-            item: {
+            result: {
               item: {
                 id: '1234',
                 title: 'changed',
@@ -309,14 +309,14 @@ describe('Content Core', () => {
           await fooContentCrud!.create(ctx, { title: 'Hello' }, { id: '1234' });
           expect(fooContentCrud!.get(ctx, '1234')).resolves.toEqual({
             contentTypeId: FOO_CONTENT_ID,
-            item: {
+            result: {
               item: expect.any(Object),
             },
           });
           await fooContentCrud!.delete(ctx, '1234');
           expect(fooContentCrud!.get(ctx, '1234')).resolves.toEqual({
             contentTypeId: FOO_CONTENT_ID,
-            item: {
+            result: {
               item: undefined,
             },
           });

src/plugins/content_management/server/core/crud.ts

@@ -19,12 +19,12 @@ import type { ContentStorage, StorageContext } from './types';
 
 export interface GetResponse<T = unknown, M = void> {
   contentTypeId: string;
-  item: GetResult<T, M>;
+  result: GetResult<T, M>;
 }
 
 export interface BulkGetResponse<T = unknown, M = void> {
   contentTypeId: string;
-  items: BulkGetResult<T, M>;
+  result: BulkGetResult<T, M>;
 }
 
 export interface CreateItemResponse<T = unknown, M = void> {
@@ -89,7 +89,7 @@ export class ContentCrud<T = unknown> {
         options,
       });
 
-      return { contentTypeId: this.contentTypeId, item };
+      return { contentTypeId: this.contentTypeId, result: item };
     } catch (e) {
       this.eventBus.emit({
         type: 'getItemError',
@@ -128,7 +128,7 @@ export class ContentCrud<T = unknown> {
 
       return {
         contentTypeId: this.contentTypeId,
-        items,
+        result: items,
       };
     } catch (e) {
       this.eventBus.emit({

src/plugins/content_management/server/rpc/procedures/bulk_get.test.ts

@@ -206,7 +206,7 @@ describe('RPC -> bulkGet()', () => {
 
       expect(result).toEqual({
         contentTypeId: FOO_CONTENT_ID,
-        items: expected,
+        result: expected,
       });
 
       expect(storage.bulkGet).toHaveBeenCalledWith(

src/plugins/content_management/server/rpc/procedures/get.test.ts

@@ -161,7 +161,7 @@ describe('RPC -> get()', () => {
 
       expect(result).toEqual({
         contentTypeId: FOO_CONTENT_ID,
-        item: expected,
+        result: expected,
       });
 
       expect(storage.get).toHaveBeenCalledWith(