Add savedObjects mappings API to core

[pgayvallet]

Summary

Fix #50309

PR does the following:

• add new registerMappings API to savedObjects setup contract
• cleanup, rename, and document the savedObjects mappings types

Checklist

Use strikethroughs to remove checklist items you don't feel are applicable to this PR.

• [ ] This was checked for cross-browser compatibility, including a check against IE11
• [ ] Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
• Documentation was added for features that require explanation or tutorials
• Unit or functional tests were updated or added to match the most common scenarios
• [ ] This was checked for keyboard-only and screenreader accessibility

For maintainers

• This was checked for breaking API changes and was labeled appropriately
• This includes a feature addition or change that requires a release note and was labeled appropriately

Dev Docs

Added API to register savedObjects mapping from the new platform

// my-plugin/server/mappings.ts
import { SavedObjectsTypeMappingDefinitions } from 'src/core/server';

export const mappings: SavedObjectsTypeMappingDefinitions = {
  'my-type': {
    properties: {
      afield: {
        type: "text"
      }
    }
  }
}

 // my-plugin/server/plugin.ts
 import { mappings } from './mappings';

 export class MyPlugin implements Plugin {
   setup({ savedObjects }) {
     savedObjects.registerMappings(mappings);
   }
 }

[elasticmachine]

Pinging @elastic/kibana-platform (Team:Platform)

[pgayvallet]

This is a missed blocker regarding saved object migration to new platform: ATM the es-archiver has no way to be informed about mappings defined from NP (and it will be the same when we migrate schemas, migrations and validations).However I don't want to handle it in this PR (and I don't have a solution ATM) Created #55860 to discuss the issue.

[pgayvallet]

I'm using a string instead of the OpaquePluginId here because the only usage of this field is to add details about the plugin name when two plugins are registering the same type, and using the String(pluginOpaqueId) outputs Symbol(myId)...

[pgayvallet]

Even if it should never be undefined, there were some integration tests starting the kibana server where the mappings were undefined. As the uiExport gathering/reducing code is an unreadable thing, doing this || [] here was the pragmatic solution (and will be deleted post 8.0 anyway)

[pgayvallet]

Internal structure changed, had to adapt the test data to the new structure

[kibanamachine]

💚 Build Succeeded

• continuous-integration/kibana-ci/pull-request
• Commit: 03dbd0d

History

• 💚 Build #22389 succeeded 914c5b4
• 💔 Build #22347 failed 18ddeed
• 💔 Build #22334 failed c3b4d3f

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

[pgayvallet]

Closing, obsolete due to #55857