Add support for generics on type aliases (elastic#151)

Author: Mpdreamz

Diff for: output/schema/schema.json

@@ -485,7 +485,7 @@ export interface AsyncSearch<TDocument = unknown> {
   profile: Profile
   _scroll_id: string
   _shards: ShardStatistics
-  suggest: SuggestDictionary<TDocument>
+  suggest?: Record<SuggestionName, Array<Suggest<TDocument>>>
   terminated_early: boolean
   timed_out: boolean
   took: long
@@ -2208,6 +2208,19 @@ export interface CompletionStats {
   fields?: Record<Field, CompletionStats>
 }
 
+export interface CompletionSuggestOption<TDocument = unknown> {
+  collate_match?: boolean
+  contexts: Record<string, Array<Context>>
+  fields: Record<string, any>
+  _id: string
+  _index: IndexName
+  _type?: Type
+  _routing: Routing
+  _score: double
+  _source: TDocument
+  text: string
+}
+
 export interface CompletionSuggester {
   contexts: Record<string, Array<SuggestContextQuery>>
   fuzzy: SuggestFuzziness
@@ -5025,7 +5038,7 @@ export interface Hit<TDocument = unknown> {
   _seq_no?: long
   _primary_term?: long
   _version?: long
-  sort?: Array<long | double | string>
+  sort?: Array<long | double | string | null>
 }
 
 export interface HitMetadata<TDocument = unknown> {
@@ -7112,6 +7125,12 @@ export interface PhraseSuggestHighlight {
   pre_tag: string
 }
 
+export interface PhraseSuggestOption {
+  text: string
+  highlighted: string
+  score: double
+}
+
 export interface PhraseSuggester {
   collate: PhraseSuggestCollate
   confidence: double
@@ -8793,7 +8812,7 @@ export interface SearchResponse<TDocument = unknown> {
   profile?: Profile
   pit_id?: string
   _scroll_id?: ScrollId
-  suggest?: SuggestDictionary<TDocument>
+  suggest?: Record<SuggestionName, Array<Suggest<TDocument>>>
   terminated_early?: boolean
 }
 
@@ -10078,12 +10097,6 @@ export interface SuggestContextQuery {
   prefix: boolean
 }
 
-export interface SuggestDictionary<T = unknown> {
-  item: Array<Suggest<T>>
-  keys: Array<string>
-  values: Array<Array<Suggest<T>>>
-}
-
 export interface SuggestFuzziness {
   fuzziness: Fuzziness
   min_length: integer
@@ -10094,19 +10107,7 @@ export interface SuggestFuzziness {
 
 export type SuggestMode = 'missing' | 'popular' | 'always'
 
-export interface SuggestOption<TDocument = unknown> {
-  collate_match: boolean
-  contexts: Record<string, Array<Context>>
-  fields: Record<string, any>
-  freq: long
-  highlighted: string
-  _id: string
-  _index: IndexName
-  _score: double
-  score: double
-  _source: TDocument
-  text: string
-}
+export type SuggestOption<TDocument> = CompletionSuggestOption<TDocument> | PhraseSuggestOption | TermSuggestOption
 
 export type SuggestSort = 'score' | 'frequency'
 
@@ -10116,6 +10117,8 @@ export interface Suggester {
   size: integer
 }
 
+export type SuggestionName = string
+
 export interface SumAggregation {
 }
 
@@ -10236,6 +10239,12 @@ export interface TermQuery extends QueryBase {
   value?: string | float | boolean
 }
 
+export interface TermSuggestOption {
+  text: string
+  freq: long
+  score: double
+}
+
 export interface TermSuggester {
   lowercase_terms: boolean
   max_edits: integer

Diff for: output/typescript/types.ts

@@ -242,6 +242,8 @@ export class Enum extends BaseType {
 export class TypeAlias extends BaseType {
   kind: 'type_alias'
   type: ValueOf
+  /** generic parameters: either concrete types or open parameters from the enclosing type */
+  generics?: ValueOf[]
 }
 
 // ------------------------------------------------------------------------------------------------

Diff for: specification/compiler/model/metamodel.ts

@@ -169,6 +169,18 @@ export function modelType (node: Node): model.ValueOf {
       return modelType(node.getLiteral())
     }
 
+    case ts.SyntaxKind.TypeParameter: {
+      assert(Node.isTypeParameterDeclaration(node), `The node is not of type ${ts.SyntaxKind.TypeReference} but ${node.getKind()} instead`)
+      const name = node.compilerNode.getText()
+      const type: model.InstanceOf = {
+        kind: 'instance_of',
+        type: {
+          name,
+          namespace: getNameSpace(node)
+        }
+      }
+      return type
+    }
     case ts.SyntaxKind.TypeReference: {
       // TypeReferences are fun types, it's basically how TypeScript defines
       // everything that is not a basic type, an interface or a class will
@@ -384,6 +396,7 @@ export function modelTypeAlias (declaration: TypeAliasDeclaration): model.TypeAl
       acc[val.name] = val.value
       return acc
     }, {})
+  const generics = declaration.getTypeParameters().map(node => modelType(node))
 
   return {
     name: {
@@ -392,7 +405,8 @@ export function modelTypeAlias (declaration: TypeAliasDeclaration): model.TypeAl
     },
     kind: 'type_alias',
     type: modelType(type),
-    ...(Object.keys(annotations).length > 0 && { annotations })
+    ...(Object.keys(annotations).length > 0 && { annotations }),
+    ...(generics.length > 0 && { generics })
   }
 }
 

Diff for: specification/compiler/model/utils.ts

@@ -141,6 +141,12 @@ type WaitForActiveShards = byte | WaitForActiveShardOptions
  */
 type AggregateName = string
 
+/**
+ * The suggestion name as returned from the server. Depending whether typed_keys is specified this could come back
+ * in the form of `name#type` instead of simply `name`
+ */
+type SuggestionName = string
+
 /** A reference to a date field with formatting instructions on how to return the date */
 class DateField {
   field: Field

Diff for: specification/specs/common.ts

@@ -32,6 +32,6 @@ class SearchResponse<TDocument> extends ResponseBase {
   profile?: Profile
   pit_id?: string
   _scroll_id?: ScrollId
-  suggest?: SuggestDictionary<TDocument>
+  suggest?: Dictionary<SuggestionName, Suggest<TDocument>[]>
   terminated_early?: boolean
 }

Diff for: specification/specs/search/search/SearchResponse.ts

@@ -40,5 +40,5 @@ class Hit<TDocument> {
   _seq_no?: long
   _primary_term?: long
   _version?: long
-  sort?: Array<long | double | string>
+  sort?: Array<long | double | string | null>
 }

Diff for: specification/specs/search/search/hits/Hit.ts

@@ -17,22 +17,32 @@
  * under the License.
  */
 
-class SuggestOption<TDocument> {
-  collate_match: boolean
+type SuggestOption<TDocument> =
+  | CompletionSuggestOption<TDocument>
+  | PhraseSuggestOption
+  | TermSuggestOption
+
+class CompletionSuggestOption<TDocument> {
+  collate_match?: boolean
   contexts: Dictionary<string, Context[]>
   fields: Dictionary<string, UserDefinedValue>
-  freq: long
-  highlighted: string
   _id: string
   _index: IndexName
-  /** This is a comment that will be exposed
-   * @alternate_name SuggestScore
-   * @prop_x he
-   * **/
+  _type?: Type
+  _routing: Routing
   _score: double
-  /** @alternate_name DocumentScore **/
-  score: double
-  /** @prop_serializer SourceFormatter`1 */
   _source: TDocument
   text: string
 }
+
+class PhraseSuggestOption {
+  text: string
+  highlighted: string
+  score: double
+}
+
+class TermSuggestOption {
+  text: string
+  freq: long
+  score: double
+}

Diff for: specification/specs/search/suggesters/SuggestDictionary.ts

@@ -28,7 +28,7 @@ class AsyncSearch<TDocument> {
   profile: Profile
   _scroll_id: string
   _shards: ShardStatistics
-  suggest: SuggestDictionary<TDocument>
+  suggest?: Dictionary<SuggestionName, Suggest<TDocument>[]>
   terminated_early: boolean
   timed_out: boolean
   took: long

Diff for: specification/specs/search/suggesters/SuggestOption.ts

@@ -203,7 +203,7 @@ function createEnum (type) {
 }
 
 function createAlias (type) {
-  return `export type ${type.name.name} = ${buildType(type.type)}\n`
+  return `export type ${type.name.name}${buildGenerics(type)} = ${buildType(type.type)}\n`
 }
 
 function buildInherits (type) {