Get rid of global types (#81739)

* move global typings to packages/kbn-utility-types

* update all imports

* add tests

* mute error

* update docs

* ok

* rename kbn-utility-types/test --> kbn-utility-types/jest

packages/kbn-utility-types/index.ts

@@ -110,3 +110,10 @@ export type MethodKeysOf<T> = {
  *  Returns an object with public methods only.
  */
 export type PublicMethodsOf<T> = Pick<T, MethodKeysOf<T>>;
+
+/**
+ *  Makes an object with readonly properties mutable.
+ */
+export type Writable<T> = {
+  -readonly [K in keyof T]: T[K];
+};

src/core/typings.ts → packages/kbn-utility-types/jest/index.ts

@@ -16,7 +16,6 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-
 export type DeeplyMockedKeys<T> = {
   [P in keyof T]: T[P] extends (...args: any[]) => any
     ? jest.MockInstance<ReturnType<T[P]>, Parameters<T[P]>>

packages/kbn-utility-types/jest/package.json

@@ -0,0 +1,3 @@
+{
+  "types": "../target/jest/index.d.ts"
+}

packages/kbn-utility-types/test-d/method_keys_of.ts

@@ -0,0 +1,34 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { expectType } from 'tsd';
+import { MethodKeysOf } from '../index';
+
+class Test {
+  public name: string = '';
+  getName() {
+    return this.name;
+  }
+  // @ts-ignore
+  private getDoubleName() {
+    return this.name.repeat(2);
+  }
+}
+
+expectType<MethodKeysOf<Test>>('getName');

packages/kbn-utility-types/test-d/public_methods_of.ts

@@ -0,0 +1,50 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { expectAssignable, expectNotAssignable } from 'tsd';
+import { PublicMethodsOf } from '../index';
+
+class Test {
+  public name: string = '';
+  getName() {
+    return this.name;
+  }
+  // @ts-ignore
+  private getDoubleName() {
+    return this.name.repeat(2);
+  }
+}
+
+expectAssignable<PublicMethodsOf<Test>>({
+  getName() {
+    return '';
+  },
+});
+
+expectNotAssignable<PublicMethodsOf<Test>>({
+  getName() {
+    return 1;
+  },
+});
+
+expectNotAssignable<PublicMethodsOf<Test>>({
+  getDoubleName() {
+    return 1;
+  },
+});

packages/kbn-utility-types/test-d/writable.ts

@@ -0,0 +1,29 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { expectAssignable } from 'tsd';
+import { Writable } from '../index';
+
+type WritableArray = Writable<readonly string[]>;
+expectAssignable<WritableArray>(['1']);
+
+type WritableObject = Writable<{
+  readonly name: string;
+}>;
+expectAssignable<WritableObject>({ name: '1' });

packages/kbn-utility-types/tsconfig.json

@@ -7,10 +7,11 @@
     "stripInternal": true,
     "declarationMap": true,
     "types": [
-      "node"
+      "node",
+      "jest"
     ]
   },
-  "include": ["index.ts", "test-d/**/*"],
+  "include": ["index.ts", "jest/**/*", "test-d/**/*"],
   "exclude": [
     "target"
   ]

src/core/public/apm_system.test.ts

@@ -18,8 +18,8 @@
  */
 
 jest.mock('@elastic/apm-rum');
+import type { DeeplyMockedKeys } from '@kbn/utility-types/jest';
 import { init, apm } from '@elastic/apm-rum';
-import { DeeplyMockedKeys } from '../typings';
 import { ApmSystem } from './apm_system';
 
 const initMock = init as jest.Mocked<typeof init>;

src/core/public/chrome/chrome_service.mock.ts

@@ -18,7 +18,7 @@
  */
 import { BehaviorSubject } from 'rxjs';
 import type { PublicMethodsOf } from '@kbn/utility-types';
-import { DeeplyMockedKeys } from '../../typings';
+import type { DeeplyMockedKeys } from '@kbn/utility-types/jest';
 import { ChromeBadge, ChromeBrand, ChromeBreadcrumb, ChromeService, InternalChromeStart } from './';
 
 const createStartContractMock = () => {

src/core/public/notifications/notifications_service.mock.ts

@@ -17,7 +17,7 @@
  * under the License.
  */
 import type { PublicMethodsOf } from '@kbn/utility-types';
-import { MockedKeys } from '../../typings';
+import type { MockedKeys } from '@kbn/utility-types/jest';
 import {
   NotificationsService,
   NotificationsSetup,

src/core/public/overlays/overlay_service.mock.ts

@@ -17,7 +17,7 @@
  * under the License.
  */
 import type { PublicMethodsOf } from '@kbn/utility-types';
-import { DeeplyMockedKeys } from '../../typings';
+import type { DeeplyMockedKeys } from '@kbn/utility-types/jest';
 import { OverlayService, OverlayStart } from './overlay_service';
 import { overlayBannersServiceMock } from './banners/banners_service.mock';
 import { overlayFlyoutServiceMock } from './flyout/flyout_service.mock';

src/core/server/core_context.mock.ts

@@ -18,7 +18,7 @@
  */
 
 import { REPO_ROOT } from '@kbn/dev-utils';
-import { DeeplyMockedKeys } from '../typings';
+import type { DeeplyMockedKeys } from '@kbn/utility-types/jest';
 import { CoreContext } from './core_context';
 import { Env, IConfigService } from './config';
 import { configServiceMock, getEnvOptions } from './config/mocks';

src/core/server/elasticsearch/client/mocks.ts

@@ -18,7 +18,7 @@
  */
 import { Client, ApiResponse } from '@elastic/elasticsearch';
 import { TransportRequestPromise } from '@elastic/elasticsearch/lib/Transport';
-import { DeeplyMockedKeys } from '../../../typings';
+import type { DeeplyMockedKeys } from '@kbn/utility-types/jest';
 import { ElasticsearchClient } from './types';
 import { ICustomClusterClient } from './cluster_client';
 

src/core/server/mocks.ts

@@ -19,7 +19,7 @@
 import { of } from 'rxjs';
 import { duration } from 'moment';
 import { ByteSizeValue } from '@kbn/config-schema';
-import { MockedKeys } from '../typings';
+import type { MockedKeys } from '@kbn/utility-types/jest';
 import { PluginInitializerContext, CoreSetup, CoreStart, StartServicesAccessor } from '.';
 import { loggingSystemMock } from './logging/logging_system.mock';
 import { loggingServiceMock } from './logging/logging_service.mock';

src/core/tsconfig.json

@@ -13,8 +13,7 @@
     "types/**/*",
     "test_helpers/**/*",
     "utils/**/*",
-    "index.ts",
-    "typings.ts"
+    "index.ts"
   ],
   "references": [
     { "path": "../test_utils/" }

src/plugins/data/common/field_formats/index.ts

@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-
+import { PublicMethodsOf } from '@kbn/utility-types';
 import { FieldFormatsRegistry } from './field_formats_registry';
 type IFieldFormatsRegistry = PublicMethodsOf<FieldFormatsRegistry>;
 

src/plugins/data/common/field_formats/types.ts

@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-
+import { PublicMethodsOf } from '@kbn/utility-types';
 import { GetConfigFn } from '../types';
 import { FieldFormat } from './field_format';
 import { FieldFormatsRegistry } from './field_formats_registry';

src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts

@@ -18,6 +18,7 @@
  */
 
 import { i18n } from '@kbn/i18n';
+import { PublicMethodsOf } from '@kbn/utility-types';
 import { SavedObjectsClientCommon } from '../..';
 
 import { createIndexPatternCache } from '.';

src/plugins/data/common/search/search_source/legacy/default_search_strategy.test.ts

@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-
+import type { MockedKeys } from '@kbn/utility-types/jest';
 import { defaultSearchStrategy } from './default_search_strategy';
 import { LegacyFetchHandlers, SearchStrategySearchParams } from './types';
 import { BehaviorSubject } from 'rxjs';

src/plugins/data/common/search/search_source/mocks.ts

@@ -18,6 +18,7 @@
  */
 
 import { BehaviorSubject } from 'rxjs';
+import type { MockedKeys } from '@kbn/utility-types/jest';
 import { uiSettingsServiceMock } from '../../../../../core/public/mocks';
 
 import { SearchSource } from './search_source';

src/plugins/data/public/field_formats/mocks.ts

@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-
+import type { PublicMethodsOf } from '@kbn/utility-types';
 import { FieldFormatsStart, FieldFormatsSetup, FieldFormatsService } from '.';
 import { fieldFormatsMock } from '../../common/field_formats/mocks';
 

src/plugins/data/public/query/mocks.ts

@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-
+import type { PublicMethodsOf } from '@kbn/utility-types';
 import { Observable } from 'rxjs';
 import { QueryService, QuerySetup, QueryStart } from '.';
 import { timefilterServiceMock } from './timefilter/timefilter_service.mock';

src/plugins/data/public/query/query_string/query_string_manager.ts

@@ -19,6 +19,7 @@
 
 import { BehaviorSubject } from 'rxjs';
 import { skip } from 'rxjs/operators';
+import { PublicMethodsOf } from '@kbn/utility-types';
 import { CoreStart } from 'kibana/public';
 import { IStorageWrapper } from 'src/plugins/kibana_utils/public';
 import { Query, UI_SETTINGS } from '../../../common';

src/plugins/data/public/query/timefilter/time_history.ts

@@ -18,6 +18,7 @@
  */
 
 import moment from 'moment';
+import { PublicMethodsOf } from '@kbn/utility-types';
 import { IStorageWrapper } from 'src/plugins/kibana_utils/public';
 import { PersistedLog } from '../persisted_log';
 import { TimeRange } from '../../../common';

src/plugins/data/public/query/timefilter/timefilter.ts

@@ -20,6 +20,7 @@
 import _ from 'lodash';
 import { Subject, BehaviorSubject } from 'rxjs';
 import moment from 'moment';
+import { PublicMethodsOf } from '@kbn/utility-types';
 import { areRefreshIntervalsDifferent, areTimeRangesDifferent } from './lib/diff_time_picker_vals';
 import { getForceNow } from './lib/get_force_now';
 import { TimefilterConfig, InputTimeRange, TimeRangeBounds } from './types';

src/plugins/data/public/query/timefilter/timefilter_service.mock.ts

@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-
+import type { PublicMethodsOf } from '@kbn/utility-types';
 import { TimefilterService, TimeHistoryContract, TimefilterContract } from '.';
 import { Observable } from 'rxjs';
 

src/plugins/data/public/search/collectors/create_usage_collector.test.ts

@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-
+import type { MockedKeys } from '@kbn/utility-types/jest';
 import { CoreSetup, CoreStart } from '../../../../../core/public';
 import { coreMock } from '../../../../../core/public/mocks';
 import { usageCollectionPluginMock, Setup } from '../../../../usage_collection/public/mocks';

src/plugins/data/public/search/es_search/get_es_preference.test.ts

@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-
+import type { MockedKeys } from '@kbn/utility-types/jest';
 import { getEsPreference } from './get_es_preference';
 import { CoreStart } from '../../../../../core/public';
 import { coreMock } from '../../../../../core/public/mocks';

src/plugins/data/public/search/search_interceptor.test.ts

@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-
+import type { MockedKeys } from '@kbn/utility-types/jest';
 import { CoreSetup, CoreStart } from '../../../../core/public';
 import { coreMock } from '../../../../core/public/mocks';
 import { IEsSearchRequest } from '../../common/search';

src/plugins/data/public/search/search_interceptor.ts

@@ -20,6 +20,7 @@
 import { get, memoize, trimEnd } from 'lodash';
 import { BehaviorSubject, throwError, timer, defer, from, Observable, NEVER } from 'rxjs';
 import { catchError, finalize } from 'rxjs/operators';
+import { PublicMethodsOf } from '@kbn/utility-types';
 import { CoreStart, CoreSetup, ToastsSetup } from 'kibana/public';
 import { i18n } from '@kbn/i18n';
 import {

src/plugins/data/public/search/search_service.test.ts

@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-
+import type { MockedKeys } from '@kbn/utility-types/jest';
 import { coreMock } from '../../../../core/public/mocks';
 import { CoreSetup, CoreStart } from '../../../../core/public';
 

src/plugins/data/server/search/routes/call_msearch.test.ts

@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-
+import type { DeeplyMockedKeys } from '@kbn/utility-types/jest';
 import { Observable } from 'rxjs';
 import { IUiSettingsClient, IScopedClusterClient, SharedGlobalConfig } from 'src/core/server';
 

src/plugins/data/server/search/routes/msearch.test.ts

@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-
+import type { MockedKeys } from '@kbn/utility-types/jest';
 import { Observable } from 'rxjs';
 
 import {

src/plugins/data/server/search/routes/search.test.ts

@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-
+import type { MockedKeys } from '@kbn/utility-types/jest';
 import { Observable, from } from 'rxjs';
 
 import {