Index pattern - refactor constructor (#77791)

* index pattern - refactor constructor # Conflicts: # docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern._constructor_.md # docs/development/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.md # docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpattern._constructor_.md # docs/development/plugins/data/server/kibana-plugin-plugins-data-server.indexpattern.md # src/plugins/data/common/index_patterns/index_patterns/_fields_fetcher.ts # src/plugins/data/common/index_patterns/index_patterns/index_pattern.test.ts # src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts # src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts # src/plugins/data/public/public.api.md # src/plugins/data/server/server.api.md # x-pack/plugins/translations/translations/ja-JP.json # x-pack/plugins/translations/translations/zh-CN.json
elastic · Sep 23, 2020 · 24671b8 · 24671b8
1 parent 99bc56d
commit 24671b8
Show file tree

Hide file tree

Showing 137 changed files with 2,056 additions and 1,622 deletions.
diff --git a/...c/kibana-plugin-plugins-data-public.duplicateindexpatternerror._constructor_.md b/...c/kibana-plugin-plugins-data-public.duplicateindexpatternerror._constructor_.md
@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [DuplicateIndexPatternError](./kibana-plugin-plugins-data-public.duplicateindexpatternerror.md) &gt; [(constructor)](./kibana-plugin-plugins-data-public.duplicateindexpatternerror._constructor_.md)
+
+## DuplicateIndexPatternError.(constructor)
+
+Constructs a new instance of the `DuplicateIndexPatternError` class
+
+<b>Signature:</b>
+
+```typescript
+constructor(message: string);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  message | <code>string</code> |  |
+
diff --git a/...ins/data/public/kibana-plugin-plugins-data-public.duplicateindexpatternerror.md b/...ins/data/public/kibana-plugin-plugins-data-public.duplicateindexpatternerror.md
@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [DuplicateIndexPatternError](./kibana-plugin-plugins-data-public.duplicateindexpatternerror.md)
+
+## DuplicateIndexPatternError class
+
+<b>Signature:</b>
+
+```typescript
+export declare class DuplicateIndexPatternError extends Error 
+```
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(message)](./kibana-plugin-plugins-data-public.duplicateindexpatternerror._constructor_.md) |  | Constructs a new instance of the <code>DuplicateIndexPatternError</code> class |
+
diff --git a/...s/data/public/kibana-plugin-plugins-data-public.iindexpattern.fieldformatmap.md b/...s/data/public/kibana-plugin-plugins-data-public.iindexpattern.fieldformatmap.md
@@ -7,8 +7,5 @@
 <b>Signature:</b>
 
 ```typescript
-fieldFormatMap?: Record<string, {
-        id: string;
-        params: unknown;
-    }>;
+fieldFormatMap?: Record<string, SerializedFieldFormat<unknown> | undefined>;
 ```
diff --git a/...elopment/plugins/data/public/kibana-plugin-plugins-data-public.iindexpattern.md b/...elopment/plugins/data/public/kibana-plugin-plugins-data-public.iindexpattern.md
@@ -14,7 +14,7 @@ export interface IIndexPattern
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [fieldFormatMap](./kibana-plugin-plugins-data-public.iindexpattern.fieldformatmap.md) | <code>Record&lt;string, {</code><br/><code>        id: string;</code><br/><code>        params: unknown;</code><br/><code>    }&gt;</code> |  |
+|  [fieldFormatMap](./kibana-plugin-plugins-data-public.iindexpattern.fieldformatmap.md) | <code>Record&lt;string, SerializedFieldFormat&lt;unknown&gt; &#124; undefined&gt;</code> |  |
 |  [fields](./kibana-plugin-plugins-data-public.iindexpattern.fields.md) | <code>IFieldType[]</code> |  |
 |  [getFormatterForField](./kibana-plugin-plugins-data-public.iindexpattern.getformatterforfield.md) | <code>(field: IndexPatternField &#124; IndexPatternField['spec'] &#124; IFieldType) =&gt; FieldFormat</code> |  |
 |  [id](./kibana-plugin-plugins-data-public.iindexpattern.id.md) | <code>string</code> |  |

diff --git a/.../data/public/kibana-plugin-plugins-data-public.iindexpatternfieldlist.tospec.md b/.../data/public/kibana-plugin-plugins-data-public.iindexpatternfieldlist.tospec.md
@@ -9,7 +9,7 @@
 ```typescript
 toSpec(options?: {
         getFormatterForField?: IndexPattern['getFormatterForField'];
-    }): FieldSpec[];
+    }): IndexPatternFieldMap;
 ```
 
 ## Parameters
@@ -20,5 +20,5 @@ toSpec(options?: {
 
 <b>Returns:</b>
 
-`FieldSpec[]`
+`IndexPatternFieldMap`
 
diff --git a/...ins/data/public/kibana-plugin-plugins-data-public.indexpattern._constructor_.md b/...ins/data/public/kibana-plugin-plugins-data-public.indexpattern._constructor_.md
@@ -9,13 +9,12 @@ Constructs a new instance of the `IndexPattern` class
 <b>Signature:</b>
 
 ```typescript
-constructor(id: string | undefined, { savedObjectsClient, apiClient, patternCache, fieldFormats, indexPatternsService, onNotification, onError, onUnsupportedTimePattern, shortDotsEnable, metaFields, }: IndexPatternDeps);
+constructor({ spec, savedObjectsClient, fieldFormats, shortDotsEnable, metaFields, }: IndexPatternDeps);
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  id | <code>string &#124; undefined</code> |  |
-|  { savedObjectsClient, apiClient, patternCache, fieldFormats, indexPatternsService, onNotification, onError, onUnsupportedTimePattern, shortDotsEnable, metaFields, } | <code>IndexPatternDeps</code> |  |
+|  { spec, savedObjectsClient, fieldFormats, shortDotsEnable, metaFields, } | <code>IndexPatternDeps</code> |  |
 
diff --git a/...gins/data/public/kibana-plugin-plugins-data-public.indexpattern._fetchfields.md b/...gins/data/public/kibana-plugin-plugins-data-public.indexpattern._fetchfields.md
diff --git a/.../data/public/kibana-plugin-plugins-data-public.indexpattern.addscriptedfield.md b/.../data/public/kibana-plugin-plugins-data-public.indexpattern.addscriptedfield.md
@@ -4,10 +4,12 @@
 
 ## IndexPattern.addScriptedField() method
 
+Add scripted field to field list
+
 <b>Signature:</b>
 
 ```typescript
-addScriptedField(name: string, script: string, fieldType: string | undefined, lang: string): Promise<void>;
+addScriptedField(name: string, script: string, fieldType?: string, lang?: string): Promise<void>;
 ```
 
 ## Parameters
@@ -16,7 +18,7 @@ addScriptedField(name: string, script: string, fieldType: string | undefined, la
 |  --- | --- | --- |
 |  name | <code>string</code> |  |
 |  script | <code>string</code> |  |
-|  fieldType | <code>string &#124; undefined</code> |  |
+|  fieldType | <code>string</code> |  |
 |  lang | <code>string</code> |  |
 
 <b>Returns:</b>

diff --git a/...nt/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.create.md b/...nt/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.create.md
diff --git a/...ns/data/public/kibana-plugin-plugins-data-public.indexpattern.fieldformatmap.md b/...ns/data/public/kibana-plugin-plugins-data-public.indexpattern.fieldformatmap.md
@@ -7,5 +7,5 @@
 <b>Signature:</b>
 
 ```typescript
-fieldFormatMap: any;
+fieldFormatMap: Record<string, any>;
 ```
diff --git a/...nt/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.fields.md b/...nt/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.fields.md
@@ -8,6 +8,6 @@
 
 ```typescript
 fields: IIndexPatternFieldList & {
-        toSpec: () => FieldSpec[];
+        toSpec: () => IndexPatternFieldMap;
     };
 ```
diff --git a/...ins/data/public/kibana-plugin-plugins-data-public.indexpattern.fieldsfetcher.md b/...ins/data/public/kibana-plugin-plugins-data-public.indexpattern.fieldsfetcher.md
diff --git a/...lugins/data/public/kibana-plugin-plugins-data-public.indexpattern.flattenhit.md b/...lugins/data/public/kibana-plugin-plugins-data-public.indexpattern.flattenhit.md
@@ -7,5 +7,5 @@
 <b>Signature:</b>
 
 ```typescript
-flattenHit: any;
+flattenHit: (hit: Record<string, any>, deep?: boolean) => Record<string, any>;
 ```
diff --git a/...ugins/data/public/kibana-plugin-plugins-data-public.indexpattern.formatfield.md b/...ugins/data/public/kibana-plugin-plugins-data-public.indexpattern.formatfield.md
@@ -7,5 +7,5 @@
 <b>Signature:</b>
 
 ```typescript
-formatField: any;
+formatField: FormatFieldFn;
 ```
diff --git a/...plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.formathit.md b/...plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.formathit.md
@@ -7,5 +7,8 @@
 <b>Signature:</b>
 
 ```typescript
-formatHit: any;
+formatHit: {
+        (hit: Record<string, any>, type?: string): any;
+        formatField: FormatFieldFn;
+    };
 ```
diff --git a/...gins-data-public.indexpattern.prepbody.md → ...blic.indexpattern.getassavedobjectbody.md b/...gins-data-public.indexpattern.prepbody.md → ...blic.indexpattern.getassavedobjectbody.md
@@ -1,16 +1,18 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [IndexPattern](./kibana-plugin-plugins-data-public.indexpattern.md) &gt; [prepBody](./kibana-plugin-plugins-data-public.indexpattern.prepbody.md)
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [IndexPattern](./kibana-plugin-plugins-data-public.indexpattern.md) &gt; [getAsSavedObjectBody](./kibana-plugin-plugins-data-public.indexpattern.getassavedobjectbody.md)
 
-## IndexPattern.prepBody() method
+## IndexPattern.getAsSavedObjectBody() method
+
+Returns index pattern as saved object body for saving
 
 <b>Signature:</b>
 
 ```typescript
-prepBody(): {
+getAsSavedObjectBody(): {
         title: string;
         timeFieldName: string | undefined;
-        intervalName: string | null | undefined;
+        intervalName: string | undefined;
         sourceFilters: string | undefined;
         fields: string | undefined;
         fieldFormatMap: string | undefined;
@@ -23,7 +25,7 @@ prepBody(): {
 `{
         title: string;
         timeFieldName: string | undefined;
-        intervalName: string | null | undefined;
+        intervalName: string | undefined;
         sourceFilters: string | undefined;
         fields: string | undefined;
         fieldFormatMap: string | undefined;

diff --git a/...a/public/kibana-plugin-plugins-data-public.indexpattern.getformatterforfield.md b/...a/public/kibana-plugin-plugins-data-public.indexpattern.getformatterforfield.md
@@ -4,6 +4,8 @@
 
 ## IndexPattern.getFormatterForField() method
 
+Provide a field, get its formatter
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/...ic/kibana-plugin-plugins-data-public.indexpattern.getoriginalsavedobjectbody.md b/...ic/kibana-plugin-plugins-data-public.indexpattern.getoriginalsavedobjectbody.md
@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [IndexPattern](./kibana-plugin-plugins-data-public.indexpattern.md) &gt; [getOriginalSavedObjectBody](./kibana-plugin-plugins-data-public.indexpattern.getoriginalsavedobjectbody.md)
+
+## IndexPattern.getOriginalSavedObjectBody property
+
+Get last saved saved object fields
+
+<b>Signature:</b>
+
+```typescript
+getOriginalSavedObjectBody: () => {
+        title?: string | undefined;
+        timeFieldName?: string | undefined;
+        intervalName?: string | undefined;
+        fields?: string | undefined;
+        sourceFilters?: string | undefined;
+        fieldFormatMap?: string | undefined;
+        typeMeta?: string | undefined;
+        type?: string | undefined;
+    };
+```
diff --git a/...ata/public/kibana-plugin-plugins-data-public.indexpattern.getsourcefiltering.md b/...ata/public/kibana-plugin-plugins-data-public.indexpattern.getsourcefiltering.md
@@ -4,6 +4,8 @@
 
 ## IndexPattern.getSourceFiltering() method
 
+Get the source filtering configuration for that index.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/...ment/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.init.md b/...ment/plugins/data/public/kibana-plugin-plugins-data-public.indexpattern.init.md
diff --git a/...gins/data/public/kibana-plugin-plugins-data-public.indexpattern.initfromspec.md b/...gins/data/public/kibana-plugin-plugins-data-public.indexpattern.initfromspec.md
diff --git a/...gins/data/public/kibana-plugin-plugins-data-public.indexpattern.intervalname.md b/...gins/data/public/kibana-plugin-plugins-data-public.indexpattern.intervalname.md
@@ -7,5 +7,5 @@
 <b>Signature:</b>
 
 ```typescript
-intervalName: string | undefined | null;
+intervalName: string | undefined;
 ```
diff --git a/...lugins/data/public/kibana-plugin-plugins-data-public.indexpattern.iswildcard.md b/...lugins/data/public/kibana-plugin-plugins-data-public.indexpattern.iswildcard.md