feat(client-amplifyuibuilder): Support for generating code that is compatible with future versions of amplify project dependencies.

Author: awstools

clients/client-amplifyuibuilder/src/commands/ExchangeCodeForTokenCommand.ts

@@ -42,7 +42,10 @@ export interface ExchangeCodeForTokenCommandOutput extends ExchangeCodeForTokenR
 
 /**
  * @public
- * <p>Exchanges an access code for a token.</p>
+ * <note>
+ *             <p>This is for internal use.</p>
+ *          </note>
+ *          <p>Amplify uses this action to exchange an access code for a token.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-amplifyuibuilder/src/commands/GetCodegenJobCommand.ts

@@ -74,6 +74,9 @@ export interface GetCodegenJobCommandOutput extends GetCodegenJobResponse, __Met
  * //           dataStoreConfig: {},
  * //           noApiConfig: {},
  * //         },
+ * //         dependencies: { // ReactCodegenDependencies
+ * //           "<keys>": "STRING_VALUE",
+ * //         },
  * //       },
  * //     },
  * //     genericDataSchema: { // CodegenJobGenericDataSchema
@@ -161,6 +164,14 @@ export interface GetCodegenJobCommandOutput extends GetCodegenJobResponse, __Met
  * //     },
  * //     createdAt: new Date("TIMESTAMP"),
  * //     modifiedAt: new Date("TIMESTAMP"),
+ * //     dependencies: [ // CodegenDependencies
+ * //       { // CodegenDependency
+ * //         name: "STRING_VALUE",
+ * //         supportedVersion: "STRING_VALUE",
+ * //         isSemVer: true || false,
+ * //         reason: "STRING_VALUE",
+ * //       },
+ * //     ],
  * //   },
  * // };
  *

clients/client-amplifyuibuilder/src/commands/RefreshTokenCommand.ts

@@ -42,7 +42,10 @@ export interface RefreshTokenCommandOutput extends RefreshTokenResponse, __Metad
 
 /**
  * @public
- * <p>Refreshes a previously issued access token that might have expired.</p>
+ * <note>
+ *             <p>This is for internal use.</p>
+ *          </note>
+ *          <p>Amplify uses this action to refresh a previously issued access token that might have expired.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-amplifyuibuilder/src/commands/StartCodegenJobCommand.ts

@@ -67,6 +67,9 @@ export interface StartCodegenJobCommandOutput extends StartCodegenJobResponse, _
  *           dataStoreConfig: {},
  *           noApiConfig: {},
  *         },
+ *         dependencies: { // ReactCodegenDependencies
+ *           "<keys>": "STRING_VALUE",
+ *         },
  *       },
  *     },
  *     genericDataSchema: { // CodegenJobGenericDataSchema
@@ -174,6 +177,9 @@ export interface StartCodegenJobCommandOutput extends StartCodegenJobResponse, _
  * //           dataStoreConfig: {},
  * //           noApiConfig: {},
  * //         },
+ * //         dependencies: { // ReactCodegenDependencies
+ * //           "<keys>": "STRING_VALUE",
+ * //         },
  * //       },
  * //     },
  * //     genericDataSchema: { // CodegenJobGenericDataSchema
@@ -261,6 +267,14 @@ export interface StartCodegenJobCommandOutput extends StartCodegenJobResponse, _
  * //     },
  * //     createdAt: new Date("TIMESTAMP"),
  * //     modifiedAt: new Date("TIMESTAMP"),
+ * //     dependencies: [ // CodegenDependencies
+ * //       { // CodegenDependency
+ * //         name: "STRING_VALUE",
+ * //         supportedVersion: "STRING_VALUE",
+ * //         isSemVer: true || false,
+ * //         reason: "STRING_VALUE",
+ * //       },
+ * //     ],
  * //   },
  * // };
  *

clients/client-amplifyuibuilder/src/models/models_0.ts

@@ -75,6 +75,36 @@ export interface CodegenJobAsset {
   downloadUrl?: string;
 }
 
+/**
+ * @public
+ * <p>Dependency package that may be required for the project code to run.</p>
+ */
+export interface CodegenDependency {
+  /**
+   * @public
+   * <p>Name of the dependency package.</p>
+   */
+  name?: string;
+
+  /**
+   * @public
+   * <p>Indicates the version of the supported dependency package.</p>
+   */
+  supportedVersion?: string;
+
+  /**
+   * @public
+   * <p>Determines if the dependency package is using Semantic versioning. If set to true, it indicates that the dependency package uses Semantic versioning.</p>
+   */
+  isSemVer?: boolean;
+
+  /**
+   * @public
+   * <p>Indicates the reason to include the dependency package in your project code.</p>
+   */
+  reason?: string;
+}
+
 /**
  * @public
  * <p>Describes the feature flags that you can specify for a code generation job.</p>
@@ -536,6 +566,12 @@ export interface ReactStartCodegenJobData {
    * <p>The API configuration for the code generation job.</p>
    */
   apiConfiguration?: ApiConfiguration;
+
+  /**
+   * @public
+   * <p>Lists the dependency packages that may be required for the project code to run.</p>
+   */
+  dependencies?: Record<string, string>;
 }
 
 /**
@@ -673,6 +709,12 @@ export interface CodegenJob {
    * <p>The time that the code generation job was modified.</p>
    */
   modifiedAt?: Date;
+
+  /**
+   * @public
+   * <p>Lists the dependency packages that may be required for the project code to run.</p>
+   */
+  dependencies?: CodegenDependency[];
 }
 
 /**

clients/client-amplifyuibuilder/src/protocols/Aws_restJson1.ts

@@ -2941,6 +2941,8 @@ const se_PredicateList = (input: Predicate[], context: __SerdeContext): any => {
 
 // se_PutMetadataFlagBody omitted.
 
+// se_ReactCodegenDependencies omitted.
+
 // se_ReactStartCodegenJobData omitted.
 
 // se_RefreshTokenRequestBody omitted.
@@ -3095,6 +3097,10 @@ const de_ActionParameters = (output: any, context: __SerdeContext): ActionParame
 
 // de_AssociatedFieldsList omitted.
 
+// de_CodegenDependencies omitted.
+
+// de_CodegenDependency omitted.
+
 // de_CodegenFeatureFlags omitted.
 
 // de_CodegenGenericDataEnum omitted.
@@ -3128,6 +3134,7 @@ const de_CodegenJob = (output: any, context: __SerdeContext): CodegenJob => {
     asset: _json,
     autoGenerateForms: __expectBoolean,
     createdAt: (_: any) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)),
+    dependencies: _json,
     environmentName: __expectString,
     features: _json,
     genericDataSchema: _json,
@@ -3606,6 +3613,8 @@ const de_PredicateList = (output: any, context: __SerdeContext): Predicate[] =>
   return retVal;
 };
 
+// de_ReactCodegenDependencies omitted.
+
 // de_ReactStartCodegenJobData omitted.
 
 // de_RelatedModelFieldsList omitted.