feat(cloud-assembly-schema): add feature flag report as a possible ar…

…tifact

packages/@aws-cdk/cloud-assembly-schema/lib/cloud-assembly/artifact-schema.ts

@@ -223,11 +223,62 @@ export interface NestedCloudAssemblyProperties {
   readonly displayName?: string;
 }
 
+/**
+ * Artifact properties for a feature flag report
+ *
+ * A feature flag report is small enough that all the properties can be inlined
+ * here, and doesn't need an additional file.
+ */
+export interface FeatureFlagReportProperties {
+  /**
+   * The library that this feature flag report applies to.
+   */
+  readonly libraryName: string;
+
+  /**
+   * Information about every feature flag supported by this library.
+   */
+  readonly flags: Record<string, FeatureFlag>;
+}
+
+/**
+ * A single feature flag
+ */
+export interface FeatureFlag {
+  /**
+   * The library-recommended value for this flag, if any
+   *
+   * It is possible that there is no recommended value.
+   *
+   * @default - No recommended value.
+   */
+  readonly recommendedValue?: any;
+
+  /**
+   * The value configured by the user
+   *
+   * This is the value configured at the root of the tree. Users may also have
+   * configured values at specific locations in the tree; we don't report on
+   * those.
+   *
+   * @default - Not configured by the user
+   */
+  readonly userValue?: any;
+
+  /**
+   * Explanation about the purpose of this flag that can be shown to the user.
+   *
+   * @default - No description
+   */
+  readonly explanation?: string;
+}
+
 /**
  * Properties for manifest artifacts
  */
 export type ArtifactProperties =
   | AwsCloudFormationStackProperties
   | AssetManifestProperties
   | TreeArtifactProperties
-  | NestedCloudAssemblyProperties;
+  | NestedCloudAssemblyProperties
+  | FeatureFlagReportProperties;

packages/@aws-cdk/cloud-assembly-schema/lib/cloud-assembly/schema.ts

@@ -30,6 +30,11 @@ export enum ArtifactType {
    * Nested Cloud Assembly
    */
   NESTED_CLOUD_ASSEMBLY = 'cdk:cloud-assembly',
+
+  /**
+   * Feature flag report
+   */
+  FEATURE_FLAG_REPORT = 'cdk:feature-flag-report',
 }
 
 /**

packages/@aws-cdk/cloud-assembly-schema/schema/cloud-assembly.schema.json

@@ -79,6 +79,9 @@
                         },
                         {
                             "$ref": "#/definitions/NestedCloudAssemblyProperties"
+                        },
+                        {
+                            "$ref": "#/definitions/FeatureFlagReportProperties"
                         }
                     ]
                 },
@@ -99,7 +102,8 @@
                 "aws:cloudformation:stack",
                 "cdk:tree",
                 "cdk:asset-manifest",
-                "cdk:cloud-assembly"
+                "cdk:cloud-assembly",
+                "cdk:feature-flag-report"
             ]
         },
         "MetadataEntry": {
@@ -492,6 +496,27 @@
                 "directoryName"
             ]
         },
+        "FeatureFlagReportProperties": {
+            "description": "Artifact properties for a feature flag report\n\nA feature flag report is small enough that all the properties can be inlined\nhere, and doesn't need an additional file.",
+            "type": "object",
+            "properties": {
+                "libraryName": {
+                    "description": "The library that this feature flag report applies to.",
+                    "type": "string"
+                },
+                "flags": {
+                    "$ref": "#/definitions/Record<string,FeatureFlag>",
+                    "description": "Information about every feature flag supported by this library."
+                }
+            },
+            "required": [
+                "flags",
+                "libraryName"
+            ]
+        },
+        "Record<string,FeatureFlag>": {
+            "type": "object"
+        },
         "MissingContext": {
             "description": "Represents a missing piece of context.",
             "type": "object",

packages/@aws-cdk/cloud-assembly-schema/schema/version.json

@@ -1,4 +1,4 @@
 {
-  "schemaHash": "5dcc6511e8b96c378ad35c391cdc2dcbaa52d08a8015760692eaad73efc9a949",
+  "schemaHash": "2d1072dd1745d5fe5fd41ea719ba135791783f186390c14eb8ff23c7e88a945d",
   "revision": 44
-}
+}