Client config extension (#978)

* ability to add client config values in backend definition

* this works

* refactor types

* this is better

* api

* revert that

* updates

* fix api

* merge objects

* merging v2

* lint

* some test

* introduce error type

* pretty

* pretty

* fix bug

* tests

* tests

* tests

* tests

* pr feedback

* rename error type

* add unit test

Author: Kamil Sobol

.changeset/mean-spies-listen.md

@@ -0,0 +1,11 @@
+---
+'@aws-amplify/backend-output-schemas': minor
+'@aws-amplify/backend-output-storage': minor
+'@aws-amplify/client-config': minor
+'@aws-amplify/plugin-types': minor
+'@aws-amplify/backend': minor
+'@aws-amplify/backend-storage': patch
+'@aws-amplify/auth-construct-alpha': patch
+---
+
+Add ability to add custom outputs

package-lock.json

@@ -48,6 +48,12 @@ export const backendOutputStackMetadataSchema: z.ZodRecord<z.ZodString, z.ZodObj
     stackOutputs: string[];
 }>>;
 
+// @public (undocumented)
+export type CustomOutput = z.infer<typeof versionedCustomOutputSchema>;
+
+// @public
+export const customOutputKey = "AWS::Amplify::Custom";
+
 // @public (undocumented)
 export type GraphqlOutput = z.infer<typeof versionedGraphqlOutputSchema>;
 
@@ -114,9 +120,7 @@ export const unifiedBackendOutputSchema: z.ZodObject<{
             verificationMechanisms: z.ZodOptional<z.ZodString>;
             socialProviders: z.ZodOptional<z.ZodString>;
             oauthDomain: z.ZodOptional<z.ZodString>;
-            oauthScope: z.ZodOptional<z.ZodString>; /**
-            * re-export the storage output schema
-            */
+            oauthScope: z.ZodOptional<z.ZodString>;
             oauthRedirectSignIn: z.ZodOptional<z.ZodString>;
             oauthRedirectSignOut: z.ZodOptional<z.ZodString>;
             oauthClientId: z.ZodOptional<z.ZodString>;
@@ -305,6 +309,26 @@ export const unifiedBackendOutputSchema: z.ZodObject<{
             storageRegion: string;
         };
     }>]>>;
+    "AWS::Amplify::Custom": z.ZodOptional<z.ZodDiscriminatedUnion<"version", [z.ZodObject<{
+        version: z.ZodLiteral<"1">;
+        payload: z.ZodObject<{
+            customOutputs: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            customOutputs: string;
+        }, {
+            customOutputs: string;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        version: "1";
+        payload: {
+            customOutputs: string;
+        };
+    }, {
+        version: "1";
+        payload: {
+            customOutputs: string;
+        };
+    }>]>>;
 }, "strip", z.ZodTypeAny, {
     "AWS::Amplify::Platform"?: {
         version: "1";
@@ -361,6 +385,12 @@ export const unifiedBackendOutputSchema: z.ZodObject<{
             storageRegion: string;
         };
     } | undefined;
+    "AWS::Amplify::Custom"?: {
+        version: "1";
+        payload: {
+            customOutputs: string;
+        };
+    } | undefined;
 }, {
     "AWS::Amplify::Platform"?: {
         version: "1";
@@ -417,6 +447,12 @@ export const unifiedBackendOutputSchema: z.ZodObject<{
             storageRegion: string;
         };
     } | undefined;
+    "AWS::Amplify::Custom"?: {
+        version: "1";
+        payload: {
+            customOutputs: string;
+        };
+    } | undefined;
 }>;
 
 // @public (undocumented)
@@ -551,6 +587,28 @@ export const versionedAuthOutputSchema: z.ZodDiscriminatedUnion<"version", [z.Zo
     };
 }>]>;
 
+// @public (undocumented)
+export const versionedCustomOutputSchema: z.ZodDiscriminatedUnion<"version", [z.ZodObject<{
+    version: z.ZodLiteral<"1">;
+    payload: z.ZodObject<{
+        customOutputs: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        customOutputs: string;
+    }, {
+        customOutputs: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    version: "1";
+    payload: {
+        customOutputs: string;
+    };
+}, {
+    version: "1";
+    payload: {
+        customOutputs: string;
+    };
+}>]>;
+
 // @public (undocumented)
 export const versionedGraphqlOutputSchema: z.ZodDiscriminatedUnion<"version", [z.ZodObject<{
     version: z.ZodLiteral<"1">;

packages/backend-output-schemas/API.md

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+import { customOutputSchema as customOutputSchemaV1 } from './v1.js';
+
+export const versionedCustomOutputSchema = z.discriminatedUnion('version', [
+  customOutputSchemaV1,
+  // this is where additional custom major version schemas would go
+]);
+
+export type CustomOutput = z.infer<typeof versionedCustomOutputSchema>;

packages/backend-output-schemas/src/custom/index.ts

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+
+export const customOutputSchema = z.object({
+  version: z.literal('1'),
+  payload: z.object({
+    customOutputs: z.string(), // serialized Partial<ClientConfig>
+  }),
+});

packages/backend-output-schemas/src/custom/v1.ts

@@ -3,6 +3,7 @@ import { versionedAuthOutputSchema } from './auth/index.js';
 import { versionedGraphqlOutputSchema } from './graphql/index.js';
 import { versionedStorageOutputSchema } from './storage/index.js';
 import { versionedStackOutputSchema } from './stack/index.js';
+import { versionedCustomOutputSchema } from './custom';
 
 /**
  * The auth, graphql and storage exports here are duplicated from the submodule exports in the package.json file
@@ -11,11 +12,25 @@ import { versionedStackOutputSchema } from './stack/index.js';
  */
 
 /**
- * ---------- Auth exports ----------
+ * ---------- Platform exports ----------
  */
 
 export const platformOutputKey = 'AWS::Amplify::Platform';
 
+export * from './platform/index.js';
+
+/**
+ * ---------- Custom exports ----------
+ */
+
+export const customOutputKey = 'AWS::Amplify::Custom';
+
+export * from './custom/index.js';
+
+/**
+ * ---------- Auth exports ----------
+ */
+
 /**
  * re-export the auth output schema
  */
@@ -67,15 +82,10 @@ export const unifiedBackendOutputSchema = z.object({
   [authOutputKey]: versionedAuthOutputSchema.optional(),
   [graphqlOutputKey]: versionedGraphqlOutputSchema.optional(),
   [storageOutputKey]: versionedStorageOutputSchema.optional(),
+  [customOutputKey]: versionedCustomOutputSchema.optional(),
 });
 /**
  * This type is a subset of the BackendOutput type that is exposed by the platform.
  * It represents BackendOutput that has been validated against the schema of known output values
  */
 export type UnifiedBackendOutput = z.infer<typeof unifiedBackendOutputSchema>;
-
-/**
- * ---------- Platform exports ----------
- */
-
-export * from './platform/index.js';

packages/backend-output-schemas/src/index.ts

@@ -18,9 +18,7 @@ export class StackMetadataBackendOutputStorageStrategy
   constructor(private readonly stack: Stack) {}
 
   /**
-   * Store construct output as stack output and add pending metadata to the metadata object.
-   *
-   * Metadata is not written to the stack until flush() is called
+   * Store construct output as stack output and add metadata to the metadata object.
    */
   addBackendOutputEntry = (
     keyName: string,

packages/backend-output-storage/src/stack_metadata_output_storage_strategy.ts

@@ -6,6 +6,7 @@
 
 import { a } from '@aws-amplify/data-schema';
 import { BackendSecret } from '@aws-amplify/plugin-types';
+import { ClientConfig } from '@aws-amplify/client-config';
 import { ClientSchema } from '@aws-amplify/data-schema';
 import { ConstructFactory } from '@aws-amplify/plugin-types';
 import { defineAuth } from '@aws-amplify/backend-auth';
@@ -25,6 +26,7 @@ export type Backend<T extends DefineBackendProps> = BackendBase & {
 // @public (undocumented)
 export type BackendBase = {
     createStack: (name: string) => Stack;
+    addOutput: (clientConfigPart: Partial<ClientConfig>) => void;
 };
 
 export { ClientSchema }

packages/backend/API.md

@@ -29,6 +29,7 @@
     "@aws-amplify/backend-output-storage": "^0.2.11",
     "@aws-amplify/backend-secret": "^0.4.3",
     "@aws-amplify/backend-storage": "^0.4.4",
+    "@aws-amplify/client-config": "^0.6.0",
     "@aws-amplify/platform-core": "^0.4.3",
     "@aws-amplify/plugin-types": "^0.7.1",
     "@aws-sdk/client-amplify": "^3.465.0"

packages/backend/package.json

@@ -1,8 +1,10 @@
 import { ConstructFactory, ResourceProvider } from '@aws-amplify/plugin-types';
 import { Stack } from 'aws-cdk-lib';
+import { ClientConfig } from '@aws-amplify/client-config';
 
 export type BackendBase = {
   createStack: (name: string) => Stack;
+  addOutput: (clientConfigPart: Partial<ClientConfig>) => void;
 };
 
 // Type that allows construct factories to be defined using any keys except those used in BackendHelpers