Index pattern public api => common

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.getindexpatternfieldlistcreator.md

@@ -7,5 +7,5 @@
 <b>Signature:</b>
 
 ```typescript
-getIndexPatternFieldListCreator: ({ fieldFormats, toastNotifications, }: FieldListDependencies) => CreateIndexPatternFieldList
+getIndexPatternFieldListCreator: ({ fieldFormats, onNotification, }: FieldListDependencies) => CreateIndexPatternFieldList
 ```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern._constructor_.md

@@ -9,7 +9,7 @@ Constructs a new instance of the `IndexPattern` class
 <b>Signature:</b>
 
 ```typescript
-constructor(id: string | undefined, getConfig: any, savedObjectsClient: SavedObjectsClientContract, apiClient: IIndexPatternsApiClient, patternCache: PatternCache);
+constructor(id: string | undefined, getConfig: any, savedObjectsClient: SavedObjectsClientContract, apiClient: IIndexPatternsApiClient, patternCache: PatternCache, fieldFormats: FieldFormatsStartCommon, onNotification: OnNotification, onError: OnError);
 ```
 
 ## Parameters
@@ -21,4 +21,7 @@ constructor(id: string | undefined, getConfig: any, savedObjectsClient: SavedObj
 |  savedObjectsClient | <code>SavedObjectsClientContract</code> |  |
 |  apiClient | <code>IIndexPatternsApiClient</code> |  |
 |  patternCache | <code>PatternCache</code> |  |
+|  fieldFormats | <code>FieldFormatsStartCommon</code> |  |
+|  onNotification | <code>OnNotification</code> |  |
+|  onError | <code>OnError</code> |  |
 

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.md

@@ -14,7 +14,7 @@ export declare class IndexPattern implements IIndexPattern
 
 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(id, getConfig, savedObjectsClient, apiClient, patternCache)](./kibana-plugin-plugins-data-public.indexpattern._constructor_.md) |  | Constructs a new instance of the <code>IndexPattern</code> class |
+|  [(constructor)(id, getConfig, savedObjectsClient, apiClient, patternCache, fieldFormats, onNotification, onError)](./kibana-plugin-plugins-data-public.indexpattern._constructor_.md) |  | Constructs a new instance of the <code>IndexPattern</code> class |
 
 ## Properties
 

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternfield._constructor_.md

@@ -9,15 +9,15 @@ Constructs a new instance of the `Field` class
 <b>Signature:</b>
 
 ```typescript
-constructor(indexPattern: IndexPattern, spec: FieldSpec | Field, shortDotsEnable: boolean, { fieldFormats, toastNotifications }: FieldDependencies);
+constructor(indexPattern: IIndexPattern, spec: FieldSpec | Field, shortDotsEnable: boolean, { fieldFormats, onNotification }: FieldDependencies);
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  indexPattern | <code>IndexPattern</code> |  |
+|  indexPattern | <code>IIndexPattern</code> |  |
 |  spec | <code>FieldSpec &#124; Field</code> |  |
 |  shortDotsEnable | <code>boolean</code> |  |
-|  { fieldFormats, toastNotifications } | <code>FieldDependencies</code> |  |
+|  { fieldFormats, onNotification } | <code>FieldDependencies</code> |  |
 

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternfield.indexpattern.md

@@ -7,5 +7,5 @@
 <b>Signature:</b>
 
 ```typescript
-indexPattern?: IndexPattern;
+indexPattern?: IIndexPattern;
 ```

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpatternfield.md

@@ -14,7 +14,7 @@ export declare class Field implements IFieldType
 
 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(indexPattern, spec, shortDotsEnable, { fieldFormats, toastNotifications })](./kibana-plugin-plugins-data-public.indexpatternfield._constructor_.md) |  | Constructs a new instance of the <code>Field</code> class |
+|  [(constructor)(indexPattern, spec, shortDotsEnable, { fieldFormats, onNotification })](./kibana-plugin-plugins-data-public.indexpatternfield._constructor_.md) |  | Constructs a new instance of the <code>Field</code> class |
 
 ## Properties
 
@@ -28,7 +28,7 @@ export declare class Field implements IFieldType
 |  [esTypes](./kibana-plugin-plugins-data-public.indexpatternfield.estypes.md) |  | <code>string[]</code> |  |
 |  [filterable](./kibana-plugin-plugins-data-public.indexpatternfield.filterable.md) |  | <code>boolean</code> |  |
 |  [format](./kibana-plugin-plugins-data-public.indexpatternfield.format.md) |  | <code>any</code> |  |
-|  [indexPattern](./kibana-plugin-plugins-data-public.indexpatternfield.indexpattern.md) |  | <code>IndexPattern</code> |  |
+|  [indexPattern](./kibana-plugin-plugins-data-public.indexpatternfield.indexpattern.md) |  | <code>IIndexPattern</code> |  |
 |  [lang](./kibana-plugin-plugins-data-public.indexpatternfield.lang.md) |  | <code>string</code> |  |
 |  [name](./kibana-plugin-plugins-data-public.indexpatternfield.name.md) |  | <code>string</code> |  |
 |  [readFromDocValues](./kibana-plugin-plugins-data-public.indexpatternfield.readfromdocvalues.md) |  | <code>boolean</code> |  |

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

@@ -54,4 +54,5 @@ export {
   // Used in data plugin only
   FieldFormatInstanceType,
   IFieldFormat,
+  FieldFormatsStartCommon,
 } from './types';

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

@@ -17,6 +17,7 @@
  * under the License.
  */
 import { FieldFormat } from './field_format';
+import { FieldFormatsRegistry } from './field_formats_registry';
 
 /** @public **/
 export type FieldFormatsContentType = 'html' | 'text';
@@ -99,3 +100,5 @@ export interface IFieldFormatMetaParams {
     basePath?: string;
   };
 }
+
+export type FieldFormatsStartCommon = Omit<FieldFormatsRegistry, 'init' & 'register'>;

src/plugins/data/public/index_patterns/fields/field.test.ts → src/plugins/data/common/index_patterns/fields/field.test.ts

@@ -18,9 +18,8 @@
  */
 
 import { Field } from './field';
-import { IndexPattern } from '..';
-import { notificationServiceMock } from '../../../../../core/public/mocks';
-import { FieldFormatsStart } from '../../field_formats';
+import { IndexPattern } from '../index_patterns';
+import { FieldFormatsStartCommon } from '../..';
 import { KBN_FIELD_TYPES } from '../../../common';
 
 describe('Field', function () {
@@ -34,8 +33,8 @@ describe('Field', function () {
       { ...fieldValues, ...values },
       false,
       {
-        fieldFormats: {} as FieldFormatsStart,
-        toastNotifications: notificationServiceMock.createStartContract().toasts,
+        fieldFormats: {} as FieldFormatsStartCommon,
+        onNotification: () => {},
       }
     );
   }
@@ -215,8 +214,8 @@ describe('Field', function () {
 
   it('exports the property to JSON', () => {
     const field = new Field({ fieldFormatMap: { name: {} } } as IndexPattern, fieldValues, false, {
-      fieldFormats: {} as FieldFormatsStart,
-      toastNotifications: notificationServiceMock.createStartContract().toasts,
+      fieldFormats: {} as FieldFormatsStartCommon,
+      onNotification: () => {},
     });
     expect(flatten(field)).toMatchSnapshot();
   });

src/plugins/data/public/index_patterns/fields/field.ts → src/plugins/data/common/index_patterns/fields/field.ts

@@ -18,24 +18,24 @@
  */
 
 import { i18n } from '@kbn/i18n';
-import { ToastsStart } from 'kibana/public';
 // @ts-ignore
 import { ObjDefine } from './obj_define';
-import { IndexPattern } from '../index_patterns';
+import { IIndexPattern } from '../../types';
 import {
   IFieldType,
   getKbnFieldType,
   IFieldSubType,
   FieldFormat,
   shortenDottedString,
 } from '../../../common';
-import { FieldFormatsStart } from '../../field_formats';
+import { OnNotification } from '../types';
+import { FieldFormatsStartCommon } from '../../field_formats';
 
 export type FieldSpec = Record<string, any>;
 
 interface FieldDependencies {
-  fieldFormats: FieldFormatsStart;
-  toastNotifications: ToastsStart;
+  fieldFormats: FieldFormatsStartCommon;
+  onNotification: OnNotification;
 }
 
 export class Field implements IFieldType {
@@ -55,17 +55,17 @@ export class Field implements IFieldType {
   scripted?: boolean;
   subType?: IFieldSubType;
   displayName?: string;
-  indexPattern?: IndexPattern;
+  indexPattern?: IIndexPattern;
   readFromDocValues?: boolean;
   format: any;
   $$spec: FieldSpec;
   conflictDescriptions?: Record<string, string[]>;
 
   constructor(
-    indexPattern: IndexPattern,
+    indexPattern: IIndexPattern,
     spec: FieldSpec | Field,
     shortDotsEnable: boolean,
-    { fieldFormats, toastNotifications }: FieldDependencies
+    { fieldFormats, onNotification }: FieldDependencies
   ) {
     // unwrap old instances of Field
     if (spec instanceof Field) spec = spec.$$spec;
@@ -90,11 +90,7 @@ export class Field implements IFieldType {
         values: { name: spec.name, title: indexPattern.title },
         defaultMessage: 'Field {name} in indexPattern {title} is using an unknown field type.',
       });
-
-      toastNotifications.addDanger({
-        title,
-        text,
-      });
+      onNotification({ title, text, color: 'danger', iconType: 'alert' });
     }
 
     if (!type) type = getKbnFieldType('unknown');
@@ -103,7 +99,7 @@ export class Field implements IFieldType {
 
     if (!FieldFormat.isInstanceOfFieldFormat(format)) {
       format =
-        indexPattern.fieldFormatMap[spec.name] ||
+        (indexPattern.fieldFormatMap && indexPattern.fieldFormatMap[spec.name]) ||
         fieldFormats.getDefaultInstance(spec.type, spec.esTypes);
     }
 

src/plugins/data/public/index_patterns/fields/field_list.ts → src/plugins/data/common/index_patterns/fields/field_list.ts

@@ -18,17 +18,17 @@
  */
 
 import { findIndex } from 'lodash';
-import { ToastsStart } from 'kibana/public';
-import { IndexPattern } from '../index_patterns';
+import { IIndexPattern } from '../../types';
 import { IFieldType } from '../../../common';
 import { Field, FieldSpec } from './field';
-import { FieldFormatsStart } from '../../field_formats';
+import { OnNotification } from '../types';
+import { FieldFormatsStartCommon } from '../../field_formats';
 
 type FieldMap = Map<Field['name'], Field>;
 
 interface FieldListDependencies {
-  fieldFormats: FieldFormatsStart;
-  toastNotifications: ToastsStart;
+  fieldFormats: FieldFormatsStartCommon;
+  onNotification: OnNotification;
 }
 
 export interface IIndexPatternFieldList extends Array<Field> {
@@ -40,19 +40,19 @@ export interface IIndexPatternFieldList extends Array<Field> {
 }
 
 export type CreateIndexPatternFieldList = (
-  indexPattern: IndexPattern,
+  indexPattern: IIndexPattern,
   specs?: FieldSpec[],
   shortDotsEnable?: boolean
 ) => IIndexPatternFieldList;
 
 export const getIndexPatternFieldListCreator = ({
   fieldFormats,
-  toastNotifications,
+  onNotification,
 }: FieldListDependencies): CreateIndexPatternFieldList => (...fieldListParams) => {
   class FieldList extends Array<Field> implements IIndexPatternFieldList {
     private byName: FieldMap = new Map();
     private groups: Map<Field['type'], FieldMap> = new Map();
-    private indexPattern: IndexPattern;
+    private indexPattern: IIndexPattern;
     private shortDotsEnable: boolean;
     private setByName = (field: Field) => this.byName.set(field.name, field);
     private setByGroup = (field: Field) => {
@@ -63,7 +63,7 @@ export const getIndexPatternFieldListCreator = ({
     };
     private removeByGroup = (field: IFieldType) => this.groups.get(field.type)!.delete(field.name);
 
-    constructor(indexPattern: IndexPattern, specs: FieldSpec[] = [], shortDotsEnable = false) {
+    constructor(indexPattern: IIndexPattern, specs: FieldSpec[] = [], shortDotsEnable = false) {
       super();
       this.indexPattern = indexPattern;
       this.shortDotsEnable = shortDotsEnable;
@@ -76,7 +76,7 @@ export const getIndexPatternFieldListCreator = ({
     add = (field: FieldSpec) => {
       const newField = new Field(this.indexPattern, field, this.shortDotsEnable, {
         fieldFormats,
-        toastNotifications,
+        onNotification,
       });
       this.push(newField);
       this.setByName(newField);
@@ -94,7 +94,7 @@ export const getIndexPatternFieldListCreator = ({
     update = (field: FieldSpec) => {
       const newField = new Field(this.indexPattern, field, this.shortDotsEnable, {
         fieldFormats,
-        toastNotifications,
+        onNotification,
       });
       const index = this.findIndex((f) => f.name === newField.name);
       this.splice(index, 1, newField);

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

@@ -19,3 +19,5 @@
 
 export * from './types';
 export { isFilterable, isNestedField } from './utils';
+export * from './field_list';
+export * from './field';

src/plugins/data/public/index_patterns/index_patterns/_fields_fetcher.ts → src/plugins/data/common/index_patterns/index_patterns/_fields_fetcher.ts

@@ -17,8 +17,7 @@
  * under the License.
  */
 
-import { IndexPattern } from './index_pattern';
-import { GetFieldsOptions, IIndexPatternsApiClient } from './index_patterns_api_client';
+import { GetFieldsOptions, IIndexPatternsApiClient, IndexPattern } from '.';
 
 /** @internal */
 export const createFieldsFetcher = (

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

@@ -0,0 +1,57 @@
+/*
+ * 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 { contains } from 'lodash';
+import { CoreStart } from 'kibana/public';
+import { IndexPatternsContract } from './index_patterns';
+
+export type EnsureDefaultIndexPattern = () => Promise<unknown> | undefined;
+
+export const createEnsureDefaultIndexPattern = (
+  uiSettings: CoreStart['uiSettings'],
+  onRedirectNoIndexPattern: () => Promise<unknown> | void
+) => {
+  /**
+   * Checks whether a default index pattern is set and exists and defines
+   * one otherwise.
+   */
+  return async function ensureDefaultIndexPattern(this: IndexPatternsContract) {
+    const patterns = await this.getIds();
+    let defaultId = uiSettings.get('defaultIndex');
+    let defined = !!defaultId;
+    const exists = contains(patterns, defaultId);
+
+    if (defined && !exists) {
+      uiSettings.remove('defaultIndex');
+      defaultId = defined = false;
+    }
+
+    if (defined) {
+      return;
+    }
+
+    // If there is any index pattern created, set the first as default
+    if (patterns.length >= 1) {
+      defaultId = patterns[0];
+      uiSettings.set('defaultIndex', defaultId);
+    } else {
+      return onRedirectNoIndexPattern();
+    }
+  };
+};

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

@@ -0,0 +1,26 @@
+/*
+ * 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.
+ */
+
+export * from './index_patterns_api_client';
+export * from './types';
+export * from './_pattern_cache';
+export * from './flatten_hit';
+export * from './format_hit';
+export * from './index_pattern';
+export * from './index_patterns';