Create common and api types packages for the savedObjects domain

package.json

@@ -215,6 +215,9 @@
     "@kbn/core-preboot-server": "link:bazel-bin/packages/core/preboot/core-preboot-server",
     "@kbn/core-preboot-server-internal": "link:bazel-bin/packages/core/preboot/core-preboot-server-internal",
     "@kbn/core-preboot-server-mocks": "link:bazel-bin/packages/core/preboot/core-preboot-server-mocks",
+    "@kbn/core-saved-objects-api-browser": "link:bazel-bin/packages/core/saved-objects/core-saved-objects-api-browser",
+    "@kbn/core-saved-objects-api-server": "link:bazel-bin/packages/core/saved-objects/core-saved-objects-api-server",
+    "@kbn/core-saved-objects-common": "link:bazel-bin/packages/core/saved-objects/core-saved-objects-common",
     "@kbn/core-test-helpers-http-setup-browser": "link:bazel-bin/packages/core/test-helpers/core-test-helpers-http-setup-browser",
     "@kbn/core-theme-browser": "link:bazel-bin/packages/core/theme/core-theme-browser",
     "@kbn/core-theme-browser-internal": "link:bazel-bin/packages/core/theme/core-theme-browser-internal",
@@ -807,6 +810,9 @@
     "@types/kbn__core-preboot-server-internal": "link:bazel-bin/packages/core/preboot/core-preboot-server-internal/npm_module_types",
     "@types/kbn__core-preboot-server-mocks": "link:bazel-bin/packages/core/preboot/core-preboot-server-mocks/npm_module_types",
     "@types/kbn__core-public-internal-base": "link:bazel-bin/packages/core/public/internal-base/npm_module_types",
+    "@types/kbn__core-saved-objects-api-browser": "link:bazel-bin/packages/core/saved-objects/core-saved-objects-api-browser/npm_module_types",
+    "@types/kbn__core-saved-objects-api-server": "link:bazel-bin/packages/core/saved-objects/core-saved-objects-api-server/npm_module_types",
+    "@types/kbn__core-saved-objects-common": "link:bazel-bin/packages/core/saved-objects/core-saved-objects-common/npm_module_types",
     "@types/kbn__core-server-internal-base": "link:bazel-bin/packages/core/server/internal-base/npm_module_types",
     "@types/kbn__core-test-helpers-http-setup-browser": "link:bazel-bin/packages/core/test-helpers/core-test-helpers-http-setup-browser/npm_module_types",
     "@types/kbn__core-theme-browser": "link:bazel-bin/packages/core/theme/core-theme-browser/npm_module_types",

packages/BUILD.bazel

@@ -83,6 +83,9 @@ filegroup(
     "//packages/core/preboot/core-preboot-server-internal:build",
     "//packages/core/preboot/core-preboot-server-mocks:build",
     "//packages/core/preboot/core-preboot-server:build",
+    "//packages/core/saved-objects/core-saved-objects-api-browser:build",
+    "//packages/core/saved-objects/core-saved-objects-api-server:build",
+    "//packages/core/saved-objects/core-saved-objects-common:build",
     "//packages/core/test-helpers/core-test-helpers-http-setup-browser:build",
     "//packages/core/theme/core-theme-browser-internal:build",
     "//packages/core/theme/core-theme-browser-mocks:build",
@@ -299,6 +302,9 @@ filegroup(
     "//packages/core/preboot/core-preboot-server-internal:build_types",
     "//packages/core/preboot/core-preboot-server-mocks:build_types",
     "//packages/core/preboot/core-preboot-server:build_types",
+    "//packages/core/saved-objects/core-saved-objects-api-browser:build_types",
+    "//packages/core/saved-objects/core-saved-objects-api-server:build_types",
+    "//packages/core/saved-objects/core-saved-objects-common:build_types",
     "//packages/core/test-helpers/core-test-helpers-http-setup-browser:build_types",
     "//packages/core/theme/core-theme-browser-internal:build_types",
     "//packages/core/theme/core-theme-browser-mocks:build_types",

packages/core/saved-objects/core-saved-objects-api-browser/BUILD.bazel

@@ -0,0 +1,108 @@
+load("@npm//@bazel/typescript:index.bzl", "ts_config")
+load("@build_bazel_rules_nodejs//:index.bzl", "js_library")
+load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project")
+
+PKG_DIRNAME = "core-saved-objects-api-browser"
+PKG_REQUIRE_NAME = "@kbn/core-saved-objects-api-browser"
+
+SOURCE_FILES = glob(
+  [
+    "src/**/*.ts",
+    "src/**/*.tsx",
+  ],
+  exclude = [
+    "**/*.test.*",
+    "**/*.stories.*",
+  ],
+)
+
+SRCS = SOURCE_FILES
+
+filegroup(
+  name = "srcs",
+  srcs = SRCS,
+)
+
+NPM_MODULE_EXTRA_FILES = [
+  "package.json",
+]
+
+RUNTIME_DEPS = [
+  "@npm//react"
+]
+
+TYPES_DEPS = [
+  "@npm//@types/node",
+  "@npm//@types/jest",
+  "//packages/core/saved-objects/core-saved-objects-common:npm_module_types",
+  "//packages/core/saved-objects/core-saved-objects-api-server:npm_module_types",
+]
+
+jsts_transpiler(
+  name = "target_node",
+  srcs = SRCS,
+  build_pkg_name = package_name(),
+)
+
+jsts_transpiler(
+  name = "target_web",
+  srcs = SRCS,
+  build_pkg_name = package_name(),
+  web = True,
+)
+
+ts_config(
+  name = "tsconfig",
+  src = "tsconfig.json",
+  deps = [
+    "//:tsconfig.base.json",
+    "//:tsconfig.bazel.json",
+  ],
+)
+
+ts_project(
+  name = "tsc_types",
+  args = ['--pretty'],
+  srcs = SRCS,
+  deps = TYPES_DEPS,
+  declaration = True,
+  declaration_map = True,
+  emit_declaration_only = True,
+  out_dir = "target_types",
+  root_dir = "src",
+  tsconfig = ":tsconfig",
+)
+
+js_library(
+  name = PKG_DIRNAME,
+  srcs = NPM_MODULE_EXTRA_FILES,
+  deps = RUNTIME_DEPS + [":target_node", ":target_web"],
+  package_name = PKG_REQUIRE_NAME,
+  visibility = ["//visibility:public"],
+)
+
+pkg_npm(
+  name = "npm_module",
+  deps = [":" + PKG_DIRNAME],
+)
+
+filegroup(
+  name = "build",
+  srcs = [":npm_module"],
+  visibility = ["//visibility:public"],
+)
+
+pkg_npm_types(
+  name = "npm_module_types",
+  srcs = SRCS,
+  deps = [":tsc_types"],
+  package_name = PKG_REQUIRE_NAME,
+  tsconfig = ":tsconfig",
+  visibility = ["//visibility:public"],
+)
+
+filegroup(
+  name = "build_types",
+  srcs = [":npm_module_types"],
+  visibility = ["//visibility:public"],
+)

packages/core/saved-objects/core-saved-objects-api-browser/README.md

@@ -0,0 +1,3 @@
+# @kbn/core-saved-objects-api-browser
+
+This package contains the public types for core's browser-side savedObjects client APIs. 

packages/core/saved-objects/core-saved-objects-api-browser/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>/packages/core/saved-objects/core-saved-objects-api-browser'],
+};

packages/core/saved-objects/core-saved-objects-api-browser/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@kbn/core-saved-objects-api-browser",
+  "private": true,
+  "version": "1.0.0",
+  "main": "./target_node/index.js",
+  "browser": "./target_web/index.js",
+  "license": "SSPL-1.0 OR Elastic License 2.0"
+}

packages/core/saved-objects/core-saved-objects-api-browser/src/apis/base.ts

@@ -0,0 +1,14 @@
+/*
+ * 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 { SimpleSavedObject } from '../simple_saved_object';
+
+/** @public */
+export interface SavedObjectsBatchResponse<T = unknown> {
+  savedObjects: Array<SimpleSavedObject<T>>;
+}

packages/core/saved-objects/core-saved-objects-api-browser/src/apis/bulk_create.ts

@@ -0,0 +1,26 @@
+/*
+ * 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 type { SavedObjectsCreateOptions } from './create';
+
+/**
+ * @param type - Create a SavedObject of the given type
+ * @param attributes - Create a SavedObject with the given attributes
+ *
+ * @public
+ */
+export interface SavedObjectsBulkCreateObject<T = unknown> extends SavedObjectsCreateOptions {
+  type: string;
+  attributes: T;
+}
+
+/** @public */
+export interface SavedObjectsBulkCreateOptions {
+  /** If a document with the given `id` already exists, overwrite it's contents (default=false). */
+  overwrite?: boolean;
+}

packages/core/saved-objects/core-saved-objects-api-browser/src/apis/bulk_resolve.ts

@@ -0,0 +1,14 @@
+/*
+ * 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 type { ResolvedSimpleSavedObject } from './resolve';
+
+/** @public */
+export interface SavedObjectsBulkResolveResponse<T = unknown> {
+  resolved_objects: Array<ResolvedSimpleSavedObject<T>>;
+}

packages/core/saved-objects/core-saved-objects-api-browser/src/apis/bulk_update.ts

@@ -0,0 +1,23 @@
+/*
+ * 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 type { SavedObjectReference } from '@kbn/core-saved-objects-common';
+
+/** @public */
+export interface SavedObjectsBulkUpdateObject<T = unknown> {
+  type: string;
+  id: string;
+  attributes: T;
+  version?: string;
+  references?: SavedObjectReference[];
+}
+
+/** @public */
+export interface SavedObjectsBulkUpdateOptions {
+  namespace?: string;
+}

packages/core/saved-objects/core-saved-objects-api-browser/src/apis/create.ts

@@ -0,0 +1,27 @@
+/*
+ * 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 type {
+  SavedObjectReference,
+  SavedObjectsMigrationVersion,
+} from '@kbn/core-saved-objects-common';
+
+/** @public */
+export interface SavedObjectsCreateOptions {
+  /**
+   * (Not recommended) Specify an id instead of having the saved objects service generate one for you.
+   */
+  id?: string;
+  /** If a document with the given `id` already exists, overwrite it's contents (default=false). */
+  overwrite?: boolean;
+  /** {@inheritDoc SavedObjectsMigrationVersion} */
+  migrationVersion?: SavedObjectsMigrationVersion;
+  /** A semver value that is used when upgrading objects between Kibana versions. */
+  coreMigrationVersion?: string;
+  references?: SavedObjectReference[];
+}

packages/core/saved-objects/core-saved-objects-api-browser/src/apis/delete.ts

@@ -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.
+ */
+
+/** @public */
+export interface SavedObjectsDeleteOptions {
+  /** Force deletion of an object that exists in multiple namespaces */
+  force?: boolean;
+}

packages/core/saved-objects/core-saved-objects-api-browser/src/apis/find.ts

@@ -0,0 +1,39 @@
+/*
+ * 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 type { SavedObjectsFindOptions as SavedObjectFindOptionsServer } from '@kbn/core-saved-objects-api-server';
+import type { SavedObjectsBatchResponse } from './base';
+
+/**
+ * @public
+ */
+export type SavedObjectsFindOptions = Omit<
+  SavedObjectFindOptionsServer,
+  'pit' | 'rootSearchFields' | 'searchAfter' | 'sortOrder' | 'typeToNamespacesMap'
+>;
+
+/**
+ * Return type of the Saved Objects `find()` method.
+ *
+ * @public
+ */
+export interface SavedObjectsFindResponse<T = unknown, A = unknown>
+  extends SavedObjectsBatchResponse<T> {
+  aggregations?: A;
+  total: number;
+  perPage: number;
+  page: number;
+}
+
+/**
+ * @public
+ */
+export interface SavedObjectsFindOptionsReference {
+  type: string;
+  id: string;
+}

packages/core/saved-objects/core-saved-objects-api-browser/src/apis/index.ts

@@ -0,0 +1,21 @@
+/*
+ * 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 type { SavedObjectsBatchResponse } from './base';
+export type { SavedObjectsBulkCreateObject, SavedObjectsBulkCreateOptions } from './bulk_create';
+export type { SavedObjectsBulkResolveResponse } from './bulk_resolve';
+export type { SavedObjectsBulkUpdateObject, SavedObjectsBulkUpdateOptions } from './bulk_update';
+export type { SavedObjectsCreateOptions } from './create';
+export type { SavedObjectsDeleteOptions } from './delete';
+export type {
+  SavedObjectsFindResponse,
+  SavedObjectsFindOptions,
+  SavedObjectsFindOptionsReference,
+} from './find';
+export type { ResolvedSimpleSavedObject } from './resolve';
+export type { SavedObjectsUpdateOptions } from './update';

src/core/public/saved_objects/types.ts → packages/core/saved-objects/core-saved-objects-api-browser/src/apis/resolve.ts

@@ -6,8 +6,8 @@
  * Side Public License, v 1.
  */
 
-import type { SavedObjectsResolveResponse } from '../../server';
-import { SimpleSavedObject } from './simple_saved_object';
+import type { SavedObjectsResolveResponse } from '@kbn/core-saved-objects-api-server';
+import { SimpleSavedObject } from '../simple_saved_object';
 
 /**
  * This interface is a very simple wrapper for SavedObjects resolved from the server

packages/core/saved-objects/core-saved-objects-api-browser/src/apis/update.ts

@@ -0,0 +1,16 @@
+/*
+ * 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 type { SavedObjectReference } from '@kbn/core-saved-objects-common';
+
+/** @public */
+export interface SavedObjectsUpdateOptions<Attributes = unknown> {
+  version?: string;
+  upsert?: Attributes;
+  references?: SavedObjectReference[];
+}