feat: lazy loading conditional type (#489)

Author: Dane Pilcher

packages/amplify-codegen/src/commands/models.js

@@ -5,6 +5,7 @@ const glob = require('glob-all');
 const { FeatureFlags, pathManager } = require('amplify-cli-core');
 const gqlCodeGen = require('@graphql-codegen/core');
 const appSyncDataStoreCodeGen = require('@aws-amplify/appsync-modelgen-plugin');
+const { version: packageVersion } = require('../../package.json');
 const { validateDartSDK } = require('../utils/validateDartSDK');
 const { validateAmplifyFlutterCapableZeroThreeFeatures } = require('../utils/validateAmplifyFlutterCapableZeroThreeFeatures');
 const { validateAmplifyFlutterCoreLibraryDependency } = require('../utils/validateAmplifyFlutterCoreLibraryDependency');
@@ -77,13 +78,13 @@ async function generateModels(context, overrideOutputDir = null, isIntrospection
 
   const schemaContent = loadSchema(apiResourcePath);
 
-  const baseOutputDir = path.join(projectRoot, getModelOutputPath(context))
+  const baseOutputDir = path.join(projectRoot, getModelOutputPath(context));
   const schema = parse(schemaContent);
   const projectConfig = context.amplify.getProjectConfig();
 
   const generateIndexRules = readFeatureFlag('codegen.generateIndexRules');
   const emitAuthProvider = readFeatureFlag('codegen.emitAuthProvider');
-  const usePipelinedTransformer = readFeatureFlag('graphQLTransformer.useExperimentalPipelinedTransformer')
+  const usePipelinedTransformer = readFeatureFlag('graphQLTransformer.useExperimentalPipelinedTransformer');
   const transformerVersion = readNumericFeatureFlag('graphQLTransformer.transformerVersion');
   const respectPrimaryKeyAttributesOnConnectionField = readFeatureFlag('graphQLTransformer.respectPrimaryKeyAttributesOnConnectionField');
 
@@ -117,7 +118,7 @@ async function generateModels(context, overrideOutputDir = null, isIntrospection
     baseOutputDir,
     schema,
     config: {
-      target: isIntrospection ? 'introspection' : (platformToLanguageMap[projectConfig.frontend] || projectConfig.frontend),
+      target: isIntrospection ? 'introspection' : platformToLanguageMap[projectConfig.frontend] || projectConfig.frontend,
       directives: directiveDefinitions,
       isTimestampFieldsAdded,
       emitAuthProvider,
@@ -129,6 +130,7 @@ async function generateModels(context, overrideOutputDir = null, isIntrospection
       transformerVersion,
       dartUpdateAmplifyCoreDependency,
       respectPrimaryKeyAttributesOnConnectionField,
+      codegenVersion: packageVersion,
       overrideOutputDir, // This needs to live under `config` in order for the GraphQL types to work out.
     },
   });

packages/appsync-modelgen-plugin/src/__tests__/visitors/__snapshots__/appsync-javascript-visitor.test.ts.snap

@@ -2,12 +2,14 @@
 
 exports[`Javascript visitor with connected models of custom pk hasMany/belongsTo relation should generate correct declaration for hasMany bi-connection model when custom pk support is enabled 1`] = `
 "import { ModelInit, MutableModel, __modelMeta__, CompositeIdentifier } from \\"@aws-amplify/datastore\\";
+// @ts-ignore
+import { LazyLoading, LazyLoadingDisabled, AsyncCollection, AsyncItem } from \\"@aws-amplify/datastore\\";
 
 
 
 
 
-export declare class Post {
+type EagerPost = {
   readonly [__modelMeta__]: {
     identifier: CompositeIdentifier<Post, ['customPostId', 'title']>;
     readOnlyFields: 'createdAt' | 'updatedAt';
@@ -17,11 +19,27 @@ export declare class Post {
   readonly comments?: (Comment | null)[] | null;
   readonly createdAt?: string | null;
   readonly updatedAt?: string | null;
-  constructor(init: ModelInit<Post>);
-  static copyOf(source: Post, mutator: (draft: MutableModel<Post>) => MutableModel<Post> | void): Post;
 }
 
-export declare class Comment {
+type LazyPost = {
+  readonly [__modelMeta__]: {
+    identifier: CompositeIdentifier<Post, ['customPostId', 'title']>;
+    readOnlyFields: 'createdAt' | 'updatedAt';
+  };
+  readonly customPostId: string;
+  readonly title: string;
+  readonly comments: AsyncCollection<Comment>;
+  readonly createdAt?: string | null;
+  readonly updatedAt?: string | null;
+}
+
+export declare type Post = LazyLoading extends LazyLoadingDisabled ? EagerPost : LazyPost
+
+export declare const Post: (new (init: ModelInit<Post>) => Post) & {
+  copyOf(source: Post, mutator: (draft: MutableModel<Post>) => MutableModel<Post> | void): Post;
+}
+
+type EagerComment = {
   readonly [__modelMeta__]: {
     identifier: CompositeIdentifier<Comment, ['customPostId', 'content']>;
     readOnlyFields: 'createdAt' | 'updatedAt';
@@ -33,19 +51,39 @@ export declare class Comment {
   readonly updatedAt?: string | null;
   readonly postCommentsCustomPostId?: string | null;
   readonly postCommentsTitle?: string | null;
-  constructor(init: ModelInit<Comment>);
-  static copyOf(source: Comment, mutator: (draft: MutableModel<Comment>) => MutableModel<Comment> | void): Comment;
+}
+
+type LazyComment = {
+  readonly [__modelMeta__]: {
+    identifier: CompositeIdentifier<Comment, ['customPostId', 'content']>;
+    readOnlyFields: 'createdAt' | 'updatedAt';
+  };
+  readonly customPostId: string;
+  readonly content: string;
+  readonly post: AsyncItem<Post | undefined>;
+  readonly createdAt?: string | null;
+  readonly updatedAt?: string | null;
+  readonly postCommentsCustomPostId?: string | null;
+  readonly postCommentsTitle?: string | null;
+}
+
+export declare type Comment = LazyLoading extends LazyLoadingDisabled ? EagerComment : LazyComment
+
+export declare const Comment: (new (init: ModelInit<Comment>) => Comment) & {
+  copyOf(source: Comment, mutator: (draft: MutableModel<Comment>) => MutableModel<Comment> | void): Comment;
 }"
 `;
 
 exports[`Javascript visitor with connected models of custom pk hasMany/belongsTo relation should generate correct declaration for hasMany uni-connection model when custom pk support is enabled 1`] = `
 "import { ModelInit, MutableModel, __modelMeta__, CompositeIdentifier } from \\"@aws-amplify/datastore\\";
+// @ts-ignore
+import { LazyLoading, LazyLoadingDisabled, AsyncCollection } from \\"@aws-amplify/datastore\\";
 
 
 
 
 
-export declare class Post {
+type EagerPost = {
   readonly [__modelMeta__]: {
     identifier: CompositeIdentifier<Post, ['id', 'title']>;
     readOnlyFields: 'createdAt' | 'updatedAt';
@@ -55,11 +93,40 @@ export declare class Post {
   readonly comments?: (Comment | null)[] | null;
   readonly createdAt?: string | null;
   readonly updatedAt?: string | null;
-  constructor(init: ModelInit<Post>);
-  static copyOf(source: Post, mutator: (draft: MutableModel<Post>) => MutableModel<Post> | void): Post;
 }
 
-export declare class Comment {
+type LazyPost = {
+  readonly [__modelMeta__]: {
+    identifier: CompositeIdentifier<Post, ['id', 'title']>;
+    readOnlyFields: 'createdAt' | 'updatedAt';
+  };
+  readonly id: string;
+  readonly title: string;
+  readonly comments: AsyncCollection<Comment>;
+  readonly createdAt?: string | null;
+  readonly updatedAt?: string | null;
+}
+
+export declare type Post = LazyLoading extends LazyLoadingDisabled ? EagerPost : LazyPost
+
+export declare const Post: (new (init: ModelInit<Post>) => Post) & {
+  copyOf(source: Post, mutator: (draft: MutableModel<Post>) => MutableModel<Post> | void): Post;
+}
+
+type EagerComment = {
+  readonly [__modelMeta__]: {
+    identifier: CompositeIdentifier<Comment, ['id', 'content']>;
+    readOnlyFields: 'createdAt' | 'updatedAt';
+  };
+  readonly id: string;
+  readonly content: string;
+  readonly createdAt?: string | null;
+  readonly updatedAt?: string | null;
+  readonly postCommentsId?: string | null;
+  readonly postCommentsTitle?: string | null;
+}
+
+type LazyComment = {
   readonly [__modelMeta__]: {
     identifier: CompositeIdentifier<Comment, ['id', 'content']>;
     readOnlyFields: 'createdAt' | 'updatedAt';
@@ -70,19 +137,25 @@ export declare class Comment {
   readonly updatedAt?: string | null;
   readonly postCommentsId?: string | null;
   readonly postCommentsTitle?: string | null;
-  constructor(init: ModelInit<Comment>);
-  static copyOf(source: Comment, mutator: (draft: MutableModel<Comment>) => MutableModel<Comment> | void): Comment;
+}
+
+export declare type Comment = LazyLoading extends LazyLoadingDisabled ? EagerComment : LazyComment
+
+export declare const Comment: (new (init: ModelInit<Comment>) => Comment) & {
+  copyOf(source: Comment, mutator: (draft: MutableModel<Comment>) => MutableModel<Comment> | void): Comment;
 }"
 `;
 
 exports[`Javascript visitor with connected models of custom pk hasOne/belongsTo relation should generate correct declaration when custom pk support is enabled 1`] = `
 "import { ModelInit, MutableModel, __modelMeta__, CompositeIdentifier } from \\"@aws-amplify/datastore\\";
+// @ts-ignore
+import { LazyLoading, LazyLoadingDisabled, AsyncItem } from \\"@aws-amplify/datastore\\";
 
 
 
 
 
-export declare class Project {
+type EagerProject = {
   readonly [__modelMeta__]: {
     identifier: CompositeIdentifier<Project, ['id', 'name']>;
     readOnlyFields: 'createdAt' | 'updatedAt';
@@ -94,11 +167,29 @@ export declare class Project {
   readonly updatedAt?: string | null;
   readonly projectTeamId?: string | null;
   readonly projectTeamName?: string | null;
-  constructor(init: ModelInit<Project>);
-  static copyOf(source: Project, mutator: (draft: MutableModel<Project>) => MutableModel<Project> | void): Project;
 }
 
-export declare class Team {
+type LazyProject = {
+  readonly [__modelMeta__]: {
+    identifier: CompositeIdentifier<Project, ['id', 'name']>;
+    readOnlyFields: 'createdAt' | 'updatedAt';
+  };
+  readonly id: string;
+  readonly name: string;
+  readonly team: AsyncItem<Team | undefined>;
+  readonly createdAt?: string | null;
+  readonly updatedAt?: string | null;
+  readonly projectTeamId?: string | null;
+  readonly projectTeamName?: string | null;
+}
+
+export declare type Project = LazyLoading extends LazyLoadingDisabled ? EagerProject : LazyProject
+
+export declare const Project: (new (init: ModelInit<Project>) => Project) & {
+  copyOf(source: Project, mutator: (draft: MutableModel<Project>) => MutableModel<Project> | void): Project;
+}
+
+type EagerTeam = {
   readonly [__modelMeta__]: {
     identifier: CompositeIdentifier<Team, ['id', 'name']>;
     readOnlyFields: 'createdAt' | 'updatedAt';
@@ -110,19 +201,39 @@ export declare class Team {
   readonly updatedAt?: string | null;
   readonly teamProjectId?: string | null;
   readonly teamProjectName?: string | null;
-  constructor(init: ModelInit<Team>);
-  static copyOf(source: Team, mutator: (draft: MutableModel<Team>) => MutableModel<Team> | void): Team;
+}
+
+type LazyTeam = {
+  readonly [__modelMeta__]: {
+    identifier: CompositeIdentifier<Team, ['id', 'name']>;
+    readOnlyFields: 'createdAt' | 'updatedAt';
+  };
+  readonly id: string;
+  readonly name: string;
+  readonly project: AsyncItem<Project | undefined>;
+  readonly createdAt?: string | null;
+  readonly updatedAt?: string | null;
+  readonly teamProjectId?: string | null;
+  readonly teamProjectName?: string | null;
+}
+
+export declare type Team = LazyLoading extends LazyLoadingDisabled ? EagerTeam : LazyTeam
+
+export declare const Team: (new (init: ModelInit<Team>) => Team) & {
+  copyOf(source: Team, mutator: (draft: MutableModel<Team>) => MutableModel<Team> | void): Team;
 }"
 `;
 
 exports[`Javascript visitor with connected models of custom pk manyToMany relation should generate correct declaration for manyToMany model when custom pk is enabled 1`] = `
 "import { ModelInit, MutableModel, __modelMeta__, CompositeIdentifier, ManagedIdentifier } from \\"@aws-amplify/datastore\\";
+// @ts-ignore
+import { LazyLoading, LazyLoadingDisabled, AsyncCollection, AsyncItem } from \\"@aws-amplify/datastore\\";
 
 
 
 
 
-export declare class Post {
+type EagerPost = {
   readonly [__modelMeta__]: {
     identifier: CompositeIdentifier<Post, ['customPostId', 'title']>;
     readOnlyFields: 'createdAt' | 'updatedAt';
@@ -133,11 +244,28 @@ export declare class Post {
   readonly tags?: (PostTags | null)[] | null;
   readonly createdAt?: string | null;
   readonly updatedAt?: string | null;
-  constructor(init: ModelInit<Post>);
-  static copyOf(source: Post, mutator: (draft: MutableModel<Post>) => MutableModel<Post> | void): Post;
 }
 
-export declare class Tag {
+type LazyPost = {
+  readonly [__modelMeta__]: {
+    identifier: CompositeIdentifier<Post, ['customPostId', 'title']>;
+    readOnlyFields: 'createdAt' | 'updatedAt';
+  };
+  readonly customPostId: string;
+  readonly title: string;
+  readonly content?: string | null;
+  readonly tags: AsyncCollection<PostTags>;
+  readonly createdAt?: string | null;
+  readonly updatedAt?: string | null;
+}
+
+export declare type Post = LazyLoading extends LazyLoadingDisabled ? EagerPost : LazyPost
+
+export declare const Post: (new (init: ModelInit<Post>) => Post) & {
+  copyOf(source: Post, mutator: (draft: MutableModel<Post>) => MutableModel<Post> | void): Post;
+}
+
+type EagerTag = {
   readonly [__modelMeta__]: {
     identifier: CompositeIdentifier<Tag, ['customTagId', 'label']>;
     readOnlyFields: 'createdAt' | 'updatedAt';
@@ -147,11 +275,27 @@ export declare class Tag {
   readonly posts?: (PostTags | null)[] | null;
   readonly createdAt?: string | null;
   readonly updatedAt?: string | null;
-  constructor(init: ModelInit<Tag>);
-  static copyOf(source: Tag, mutator: (draft: MutableModel<Tag>) => MutableModel<Tag> | void): Tag;
 }
 
-export declare class PostTags {
+type LazyTag = {
+  readonly [__modelMeta__]: {
+    identifier: CompositeIdentifier<Tag, ['customTagId', 'label']>;
+    readOnlyFields: 'createdAt' | 'updatedAt';
+  };
+  readonly customTagId: string;
+  readonly label: string;
+  readonly posts: AsyncCollection<PostTags>;
+  readonly createdAt?: string | null;
+  readonly updatedAt?: string | null;
+}
+
+export declare type Tag = LazyLoading extends LazyLoadingDisabled ? EagerTag : LazyTag
+
+export declare const Tag: (new (init: ModelInit<Tag>) => Tag) & {
+  copyOf(source: Tag, mutator: (draft: MutableModel<Tag>) => MutableModel<Tag> | void): Tag;
+}
+
+type EagerPostTags = {
   readonly [__modelMeta__]: {
     identifier: ManagedIdentifier<PostTags, 'id'>;
     readOnlyFields: 'createdAt' | 'updatedAt';
@@ -165,7 +309,27 @@ export declare class PostTags {
   readonly tag: Tag;
   readonly createdAt?: string | null;
   readonly updatedAt?: string | null;
-  constructor(init: ModelInit<PostTags>);
-  static copyOf(source: PostTags, mutator: (draft: MutableModel<PostTags>) => MutableModel<PostTags> | void): PostTags;
+}
+
+type LazyPostTags = {
+  readonly [__modelMeta__]: {
+    identifier: ManagedIdentifier<PostTags, 'id'>;
+    readOnlyFields: 'createdAt' | 'updatedAt';
+  };
+  readonly id: string;
+  readonly postCustomPostId?: string | null;
+  readonly posttitle?: string | null;
+  readonly tagCustomTagId?: string | null;
+  readonly taglabel?: string | null;
+  readonly post: AsyncItem<Post>;
+  readonly tag: AsyncItem<Tag>;
+  readonly createdAt?: string | null;
+  readonly updatedAt?: string | null;
+}
+
+export declare type PostTags = LazyLoading extends LazyLoadingDisabled ? EagerPostTags : LazyPostTags
+
+export declare const PostTags: (new (init: ModelInit<PostTags>) => PostTags) & {
+  copyOf(source: PostTags, mutator: (draft: MutableModel<PostTags>) => MutableModel<PostTags> | void): PostTags;
 }"
 `;