feat(jsii): support aliasing type unions

RFC: aws/aws-cdk-rfcs#193, aws/aws-cdk-rfcs#194
aws · Jul 21, 2020 · 38ebb91 · 38ebb91
1 parent 6f2a181
commit 38ebb91
Show file tree

Hide file tree

Showing 11 changed files with 518 additions and 26 deletions.
diff --git a/packages/@jsii/spec/lib/assembly.ts b/packages/@jsii/spec/lib/assembly.ts
@@ -506,6 +506,7 @@ export interface NamedTypeReference {
    */
   fqn: FQN;
 }
+
 export function isNamedTypeReference(
   ref: TypeReference | undefined,
 ): ref is NamedTypeReference {
@@ -746,7 +747,8 @@ export function isMethod(callable: Callable): callable is Method {
 /**
  * Represents a type definition (not a type reference).
  */
-export type Type = TypeBase & (ClassType | EnumType | InterfaceType);
+export type Type = TypeBase &
+  (ClassType | EnumType | InterfaceType | NamedUnionType);
 
 /**
  * Common attributes of a type definition.
@@ -795,6 +797,7 @@ export enum TypeKind {
   Class = 'class',
   Enum = 'enum',
   Interface = 'interface',
+  NamedUnion = 'union',
 }
 
 /**
@@ -918,6 +921,24 @@ export function isEnumType(type: Type | undefined): type is EnumType {
   return type?.kind === TypeKind.Enum;
 }
 
+/**
+ * Represents a named type union.
+ */
+export interface NamedUnionType extends TypeBase {
+  kind: TypeKind.NamedUnion;
+
+  /**
+   * Candidate types for the union.
+   */
+  types: TypeReference[];
+}
+
+export function isNamedUnionType(
+  type: Type | undefined,
+): type is NamedUnionType {
+  return type?.kind === TypeKind.NamedUnion;
+}
+
 /**
  * Return whether this type is a class or interface type
  */

diff --git a/packages/@scope/jsii-calc-lib/test/assembly.jsii b/packages/@scope/jsii-calc-lib/test/assembly.jsii
@@ -322,6 +322,10 @@
           "stability": "deprecated",
           "summary": "Creates a Number object."
         },
+        "locationInModule": {
+          "filename": "lib/index.ts",
+          "line": 35
+        },
         "parameters": [
           {
             "docs": {
@@ -626,6 +630,10 @@
       "initializer": {
         "docs": {
           "stability": "deprecated"
+        },
+        "locationInModule": {
+          "filename": "lib/submodule/index.ts",
+          "line": 11
         }
       },
       "kind": "class",
@@ -668,5 +676,5 @@
     }
   },
   "version": "0.0.0",
-  "fingerprint": "w6/8Kda6/JitSbpMK3LGPK5JGRxJ50gflR5S4sUEHKk="
+  "fingerprint": "fVfpIK7xUajlT1zkHIJ8uYJPvy0gLgEe5BM8afu1mVg="
 }
diff --git a/packages/jsii-calc/lib/compliance.ts b/packages/jsii-calc/lib/compliance.ts
@@ -1020,7 +1020,7 @@ export class NodeStandardLibrary {
     /**
      * Returns the current os.platform() from the "os" node module.
      */
-    public get osPlatform() {
+    public get osPlatform(): string {
         return os.platform();
     }