fix: Add exports to build customer declaration files for combine sche…

…ma (#386)

Co-authored-by: Aaron S. <[email protected]>

.changeset/swift-bees-rescue.md

@@ -0,0 +1,6 @@
+---
+"integration-tests": patch
+"@aws-amplify/data-schema": patch
+---
+
+fix: Add exports for combine schema

packages/data-schema/docs/data-schema.a.combine.md

@@ -49,7 +49,7 @@ The schemas to combine into a single API
 </tbody></table>
 **Returns:**
 
-CombinedModelSchema&lt;Schema&gt;
+[CombinedModelSchema](./data-schema.combinedmodelschema.md)<!-- -->&lt;Schema&gt;
 
 An API and data model definition to be deployed with Amplify (Gen 2) experience (`processSchema(...)`<!-- -->) or with the Amplify Data CDK construct (`@aws-amplify/data-construct`<!-- -->)
 

packages/data-schema/docs/data-schema.clientschema.md

@@ -9,3 +9,5 @@
 ```typescript
 export type ClientSchema<Schema extends GenericModelSchema<any> | CombinedModelSchema<any>> = Schema extends GenericModelSchema<any> ? InternalClientSchema<Schema> : Schema extends CombinedModelSchema<any> ? InternalCombinedSchema<Schema> : never;
 ```
+**References:** [CombinedModelSchema](./data-schema.combinedmodelschema.md)
+

packages/data-schema/docs/data-schema.combinedmodelschema.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@aws-amplify/data-schema](./data-schema.md) &gt; [CombinedModelSchema](./data-schema.combinedmodelschema.md)
+
+## CombinedModelSchema type
+
+CombinedModel schema definition interface
+
+**Signature:**
+
+```typescript
+export type CombinedModelSchema<Schemas extends GenericModelSchema<any>[]> = CombinedSchemaBrand & {
+    schemas: [...Schemas];
+};
+```

packages/data-schema/docs/data-schema.md

@@ -112,6 +112,17 @@ Container for authorization schema definition content.
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+[CombinedModelSchema](./data-schema.combinedmodelschema.md)
+
+
+</td><td>
+
+CombinedModel schema definition interface
+
+
 </td></tr>
 <tr><td>
 
@@ -222,6 +233,17 @@ Model type definition interface
 Field type arg mutators
 
 
+</td></tr>
+<tr><td>
+
+[RDSModelSchema](./data-schema.rdsmodelschema.md)
+
+
+</td><td>
+
+RDSModel schema definition interface
+
+
 </td></tr>
 <tr><td>
 

packages/data-schema/docs/data-schema.rdsmodelschema.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@aws-amplify/data-schema](./data-schema.md) &gt; [RDSModelSchema](./data-schema.rdsmodelschema.md)
+
+## RDSModelSchema type
+
+RDSModel schema definition interface
+
+**Signature:**
+
+```typescript
+export type RDSModelSchema<T extends RDSModelSchemaParamShape, UsedMethods extends RDSModelSchemaFunctions = never> = Omit<{
+    addToSchema: <AddedTypes extends AddToSchemaContents>(types: AddedTypes) => RDSModelSchema<SetTypeSubArg<T, 'types', T['types'] & AddedTypes>, UsedMethods | 'addToSchema'>;
+    addQueries: <Queries extends Record<string, QueryCustomOperation>>(types: Queries) => RDSModelSchema<SetTypeSubArg<T, 'types', T['types'] & Queries>, UsedMethods | 'addQueries'>;
+    addMutations: <Mutations extends Record<string, MutationCustomOperation>>(types: Mutations) => RDSModelSchema<SetTypeSubArg<T, 'types', T['types'] & Mutations>, UsedMethods | 'addMutations'>;
+    addSubscriptions: <Subscriptions extends Record<string, SubscriptionCustomOperation>>(types: Subscriptions) => RDSModelSchema<SetTypeSubArg<T, 'types', T['types'] & Subscriptions>, UsedMethods | 'addSubscriptions'>;
+    authorization: <AuthRules extends SchemaAuthorization<any, any, any>>(callback: (allow: AllowModifier) => AuthRules | AuthRules[]) => RDSModelSchema<SetTypeSubArg<T, 'authorization', AuthRules[]>, UsedMethods | 'authorization'>;
+    setAuthorization: (callback: (models: OmitFromEach<BaseSchema<T, true>['models'], 'secondaryIndexes'>, schema: RDSModelSchema<T, UsedMethods | 'setAuthorization'>) => void) => RDSModelSchema<T>;
+    setRelationships: <Relationships extends ReadonlyArray<Partial<Record<keyof T['types'], RelationshipTemplate>>>>(callback: (models: OmitFromEach<BaseSchema<T, true>['models'], 'authorization' | 'fields' | 'secondaryIndexes'>) => Relationships) => RDSModelSchema<SetTypeSubArg<T, 'types', {
+        [ModelName in keyof T['types']]: ModelWithRelationships<T['types'], Relationships, ModelName>;
+    }>, UsedMethods | 'setRelationships'>;
+    renameModels: <NewName extends string, CurName extends string = keyof BaseSchema<T>['models'] & string, const ChangeLog extends readonly [CurName, NewName][] = []>(callback: () => ChangeLog) => RDSModelSchema<SetTypeSubArg<T, 'types', RenameUsingTuples<T['types'], ChangeLog>>, UsedMethods | 'renameModels'>;
+}, UsedMethods> & BaseSchema<T, true> & RDSSchemaBrand;
+```
+**References:** [RDSModelSchema](./data-schema.rdsmodelschema.md)
+

packages/data-schema/src/CombineSchema.ts

@@ -11,6 +11,11 @@ const CombinedSchemaBrandName = 'CombinedSchema';
 export const combinedSchemaBrand = brand(CombinedSchemaBrandName);
 export type CombinedSchemaBrand = Brand<typeof CombinedSchemaBrandName>;
 
+/**
+ * CombinedModel schema definition interface
+ *
+ * @param Schemas - The schemas to combine into a single API
+ */
 export type CombinedModelSchema<Schemas extends GenericModelSchema<any>[]> =
   CombinedSchemaBrand & { schemas: [...Schemas] };
 

packages/data-schema/src/ModelSchema.ts

@@ -147,6 +147,12 @@ type RelationshipTemplate = Record<
   ModelRelationshipField<ModelRelationshipFieldParamShape, string, any, any>
 >;
 
+/**
+ * RDSModel schema definition interface
+ *
+ * @param T - The shape of the RDS model schema
+ * @param UsedMethods - The method keys already defined
+ */
 export type RDSModelSchema<
   T extends RDSModelSchemaParamShape,
   UsedMethods extends RDSModelSchemaFunctions = never,

packages/data-schema/src/index.ts

@@ -4,11 +4,11 @@ import { ClientSchema } from './ClientSchema';
 export { a };
 
 export type { ClientSchema };
-
+export type {CombinedModelSchema} from './CombineSchema';
 export type { Authorization } from './Authorization';
 export type { CustomOperation } from './CustomOperation';
 export type { ModelField, Nullable, Json } from './ModelField';
-export type { ModelSchema } from './ModelSchema';
+export type { ModelSchema, RDSModelSchema} from './ModelSchema';
 export type { ModelType, ModelDefaultIdentifier } from './ModelType';
 export type { RefType } from './RefType';
 export type { CustomType } from './CustomType';

packages/e2e-tests/exports-test/src/index.ts

@@ -1,4 +1,5 @@
 import { a, defineFunction } from '@aws-amplify/backend';
+import { configure } from '@aws-amplify/data-schema/internals';
 
 const defFunc = defineFunction({
   entry: './handlers/test-handler.ts',
@@ -35,6 +36,32 @@ export function buildDefaultSchema() {
   });
 }
 
+const fakeSecret = () => ({}) as any;
+const datasourceConfigMySQL = {
+  engine: 'mysql',
+  connectionUri: fakeSecret(),
+} as const;
+
+export function buildCombineSchema() {
+  const schemaA = a.schema({
+    Todo: a
+      .model({
+        content: a.string(),
+      })
+      .authorization((allow) => [allow.guest()]),
+  });
+  const sqlSchema = configure({ database: datasourceConfigMySQL }).schema({
+    post: a
+      .model({
+        id: a.string().required(),
+        title: a.string(),
+        author: a.string(),
+      })
+      .identifier(['id']),
+  });
+  return a.combine([schemaA, sqlSchema])
+}
+
 export function buildComplicatedSchema() {
   return a
     .schema({