@aws-amplify/data-schema 1.24.0 → 1.25.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/data-schema",
-  "version": "1.24.0",
+  "version": "1.25.1",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
@@ -63,7 +63,7 @@
     "jest": "^29.7.0",
     "jest-tsd": "^0.2.2",
     "rimraf": "^5.0.5",
-    "rollup": "^4.22.4",
+    "rollup": "^4.59.0",
     "ts-jest": "^29.1.1",
     "turbo": "^1.10.14",
     "typescript": "^5.1.6"

package/src/ClientSchema/Core/ClientModel.ts

@@ -6,7 +6,11 @@ import type {
 } from '../../ModelType';
 import type { ClientSchemaProperty } from './ClientSchemaProperty';
 import type { Authorization, ImpliedAuthFields } from '../../Authorization';
-import type { SchemaMetadata, ResolveFields } from '../utilities';
+import type {
+  SchemaMetadata,
+  ResolveFields,
+  FlatResolveFields,
+} from '../utilities';
 import type {
   IsEmptyStringOrNever,
   UnionToIntersection,
@@ -50,6 +54,11 @@ export interface ClientModel<
   secondaryIndexes: IndexQueryMethodsFromIR<Bag, T['secondaryIndexes'], K>;
   __meta: {
     listOptionsPkParams: ListOptionsPkParams<Bag, T>;
+    // retaining a reference to the un-resolved schema builder type;
+    // this retains generic arg metadata that can be referenced in transformations downstream
+    rawType: T;
+    // custom selection set-optimized type with limited depth and flattened relationships
+    flatModel: FlatClientFields<Bag, Metadata, false, T, K>;
     disabledOperations: DisabledOpsToMap<T['disabledOperations']>;
   };
 }
@@ -91,6 +100,17 @@ type ClientFields<
   AuthFields<Metadata, T> &
   Omit<SystemFields<IsRDS>, keyof ResolveFields<Bag, T['fields']>>;
 
+type FlatClientFields<
+  Bag extends Record<string, unknown>,
+  Metadata extends SchemaMetadata<any>,
+  IsRDS extends boolean,
+  T extends ModelTypeParamShape,
+  ModelName extends keyof Bag & string,
+> = FlatResolveFields<Bag, T['fields'], ModelName> &
+  If<Not<IsRDS>, ImplicitIdentifier<T>> &
+  AuthFields<Metadata, T> &
+  Omit<SystemFields<IsRDS>, keyof ResolveFields<Bag, T['fields']>>;
+
 type SystemFields<IsRDS extends boolean> = IsRDS extends false
   ? {
       readonly createdAt: string;

package/src/ClientSchema/utilities/ResolveField.ts

@@ -8,6 +8,9 @@ import { CustomType } from '../../CustomType';
 import { RefType, RefTypeParamShape } from '../../RefType';
 import { ResolveRef } from './ResolveRef';
 import { LazyLoader } from '../../runtime';
+import type { ModelTypeParamShape } from '../../ModelType';
+
+type ExtendsNever<T> = [T] extends [never] ? true : false;
 
 /**
  * Takes a `ReturnType<typeof a.model()>` and turns it into a client-consumable type. Fields
@@ -30,6 +33,14 @@ export type ResolveFields<Bag extends Record<string, any>, T> = ShallowPretty<
   }
 >;
 
+export type FlatResolveFields<
+  Bag extends Record<string, any>,
+  T,
+  FlatModelName extends keyof Bag & string = never,
+> = ShallowPretty<{
+  [K in keyof T]: ResolveIndividualField<Bag, T[K], FlatModelName>;
+}>;
+
 // TODO: Remove ShallowPretty from this layer of resolution. Re-incorporate prettification
 // down the line *as-needed*. Performing this *here* is somehow essential to getting 2 unit
 // tests to pass, but hurts performance significantly. E.g., p50/operations/p50-prod-CRUDL.bench.ts
@@ -38,13 +49,17 @@ type ShallowPretty<T> = {
   [K in keyof T]: T[K];
 };
 
-export type ResolveIndividualField<Bag extends Record<string, any>, T> =
+export type ResolveIndividualField<
+  Bag extends Record<string, any>,
+  T,
+  FlatModelName extends keyof Bag & string = never,
+> =
   T extends BaseModelField<infer FieldShape>
     ? FieldShape
     : T extends RefType<infer RefShape, any, any>
       ? ResolveRef<RefShape, Bag>
       : T extends ModelRelationshipField<infer RelationshipShape, any, any, any>
-        ? ResolveRelationship<Bag, RelationshipShape>
+        ? ResolveRelationship<Bag, RelationshipShape, FlatModelName>
         : T extends CustomType<infer CT>
           ? ResolveFields<Bag, CT['fields']> | null
           : T extends EnumType<infer values>
@@ -52,20 +67,79 @@ export type ResolveIndividualField<Bag extends Record<string, any>, T> =
             : never;
 
 /**
- * Resolves to never if the related model has disabled list or get ops for hasOne/hasMany or belongsTo respectively
+ * This mapped type eliminates redundant recursive types when
+ * generating the ['__meta']['flatModel'] type that serves as the
+ * basis for custom selection set path type generation
+ *
+ * It drops belongsTo relational fields that match the source model
+ *
+ * For example, assuming the typical Post->Comment bi-directional hasMany relationship,
+ * The generated structure will be
+ * {
+ *   id: string;
+ *   title: string;
+ *   createdAt: string;
+ *   updatedAt: string;
+ *   comments: {
+ *     id: string;
+ *     createdAt: string;
+ *     updatedAt: string;
+ *     content: string;
+ *     postId: string;
+ *     ~~post~~ is dropped because data would be the same as top level object
+ *   }[]
+ * }
+ *
  */
+type ShortCircuitBiDirectionalRelationship<
+  Model extends Record<string, any>,
+  ParentModelName extends string,
+  Raw extends ModelTypeParamShape['fields'],
+> = {
+  [Field in keyof Model as Field extends keyof Raw
+    ? Raw[Field] extends ModelRelationshipField<
+        infer RelationshipShape,
+        any,
+        any,
+        any
+      >
+      ? RelationshipShape['relationshipType'] extends 'belongsTo'
+        ? RelationshipShape['relatedModel'] extends ParentModelName
+          ? never
+          : Field
+        : Field
+      : Field
+    : Field]: Model[Field];
+};
+
 type ResolveRelationship<
   Bag extends Record<string, any>,
   RelationshipShape extends ModelRelationshipFieldParamShape,
+  ParentModelName extends keyof Bag & string = never,
 > =
-  DependentLazyLoaderOpIsAvailable<Bag, RelationshipShape> extends true
-    ? LazyLoader<
-        RelationshipShape['valueRequired'] extends true
-          ? Bag[RelationshipShape['relatedModel']]['type']
-          : Bag[RelationshipShape['relatedModel']]['type'] | null,
-        RelationshipShape['array']
-      >
-    : never;
+  ExtendsNever<ParentModelName> extends true
+    ? DependentLazyLoaderOpIsAvailable<Bag, RelationshipShape> extends true
+      ? LazyLoader<
+          RelationshipShape['valueRequired'] extends true
+            ? Bag[RelationshipShape['relatedModel']]['type']
+            : Bag[RelationshipShape['relatedModel']]['type'] | null,
+          RelationshipShape['array']
+        >
+      : never
+    : // Array-ing inline here vs. (inside of ShortCircuitBiDirectionalRelationship or in a separate conditional type) is significantly more performant
+      RelationshipShape['array'] extends true
+      ? Array<
+          ShortCircuitBiDirectionalRelationship<
+            Bag[RelationshipShape['relatedModel']]['__meta']['flatModel'],
+            ParentModelName,
+            Bag[RelationshipShape['relatedModel']]['__meta']['rawType']['fields']
+          >
+        >
+      : ShortCircuitBiDirectionalRelationship<
+          Bag[RelationshipShape['relatedModel']]['__meta']['flatModel'],
+          ParentModelName,
+          Bag[RelationshipShape['relatedModel']]['__meta']['rawType']['fields']
+        >;
 
 type DependentLazyLoaderOpIsAvailable<
   Bag extends Record<string, any>,

package/src/runtime/client/index.ts

@@ -252,7 +252,7 @@ type FlattenArrays<T> = {
  * and especially for bi-directional relationships which are infinitely recursable by their nature
  *
  */
-export type ModelPath<
+type ModelPathInner<
   FlatModel extends Record<string, unknown>,
   // actual recursive Depth is 6, since we decrement down to 0
   Depth extends number = 5, // think of this as the initialization expr. in a for loop (e.g. `let depth = 5`)
@@ -263,7 +263,7 @@ export type ModelPath<
   recur: Field extends string
     ? NonNullable<UnwrapArray<FlatModel[Field]>> extends Record<string, unknown>
       ?
-          | `${Field}.${ModelPath<
+          | `${Field}.${ModelPathInner<
               NonNullable<UnwrapArray<FlatModel[Field]>>,
               // this decrements `Depth` by 1 in each recursive call; it's equivalent to the update expr. afterthought in a for loop (e.g. `depth -= 1`)
               RecursionLoop[Depth]
@@ -274,75 +274,26 @@ export type ModelPath<
   // this is equivalent to the condition expr. in a for loop (e.g. `depth !== -1`)
 }[Depth extends -1 ? 'done' : 'recur'];
 
-/**
- * Flattens model instance type and unwraps async functions into resolved GraphQL shape
- * 
- * This type is used for generating the base shape for custom selection set input and its return value
- * Uses same pattern as above to limit recursion depth to maximum usable for selection set. 
- *
- * @example
- * ### Given
- * ```ts
- * Model = {
-    title: string;
-    comments: () => ListReturnValue<({
-        content: string;
-        readonly id: string;
-        readonly createdAt: string;
-        readonly updatedAt: string;
-    } | null | undefined)[]>;
-    readonly id: string;
-    readonly createdAt: string;
-    readonly updatedAt: string;
-    description?: string | ... 1 more ... | undefined;
-  }
- * ```
- * ### Returns
- * ```ts
- * {
-    title: string;
-    comments: {
-        content: string;
-        readonly id: string;
-        readonly createdAt: string;
-        readonly updatedAt: string;
-    }[];
-    readonly id: string;
-    readonly createdAt: string;
-    readonly updatedAt: string;
-    description: string | null | undefined;
-  }
- * 
- * ```
- */
-type ResolvedModel<
-  Model extends Record<string, unknown>,
-  Depth extends number = 7,
-  RecursionLoop extends number[] = [-1, 0, 1, 2, 3, 4, 5, 6],
-> = {
-  done: NonRelationshipFields<Model>;
-  recur: {
-    [Field in keyof Model]: Model[Field] extends (
-      ...args: any
-    ) => ListReturnValue<infer M>
-      ? NonNullable<M> extends Record<string, any>
-        ? ResolvedModel<NonNullable<M>, RecursionLoop[Depth]>[]
-        : never
-      : Model[Field] extends (...args: any) => SingularReturnValue<infer M>
-        ? NonNullable<M> extends Record<string, any>
-          ? ResolvedModel<NonNullable<M>, RecursionLoop[Depth]>
-          : never
-        : Model[Field];
-  };
-}[Depth extends -1 ? 'done' : 'recur'];
+export type ModelPath<FlatModel extends Record<string, unknown>> =
+  ModelPathInner<FlatModel>;
 
 export type SelectionSet<
-  Model extends Record<string, unknown>,
+  Model,
   Path extends ReadonlyArray<ModelPath<FlatModel>>,
-  FlatModel extends Record<string, unknown> = ResolvedModel<Model>,
-> = WithOptionalsAsNullishOnly<
-  CustomSelectionSetReturnValue<FlatModel, Path[number]>
->;
+  FlatModel extends Record<
+    string,
+    unknown
+    // Remove conditional in next major version
+  > = Model extends ClientSchemaByEntityTypeBaseShape['models'][string]
+    ? Model['__meta']['flatModel']
+    : Record<string, any>,
+> =
+  // Remove conditional in next major version
+  Model extends ClientSchemaByEntityTypeBaseShape['models'][string]
+    ? WithOptionalsAsNullishOnly<
+        CustomSelectionSetReturnValue<FlatModel, Path[number]>
+      >
+    : any;
 // #endregion
 
 // #region Interfaces copied from `graphql` package
@@ -520,7 +471,7 @@ type IndexQueryMethod<
   Model extends ClientSchemaByEntityTypeBaseShape['models'][string],
   Method extends ClientSecondaryIndexField,
   Context extends ContextType = 'CLIENT',
-  FlatModel extends Record<string, unknown> = ResolvedModel<Model['type']>,
+  FlatModel extends Record<string, unknown> = Model['__meta']['flatModel'],
 > = Context extends 'CLIENT' | 'COOKIES'
   ? <SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(
       input: Method['input'],
@@ -552,14 +503,12 @@ type IndexQueryMethod<
 
 type ModelTypesClient<
   Model extends ClientSchemaByEntityTypeBaseShape['models'][string],
-  FlatModel extends Record<string, unknown> = ResolvedModel<Model['type']>,
+  FlatModel extends Record<string, unknown> = Model['__meta']['flatModel'],
 > = IndexQueryMethods<Model> &
   // Omit any disabled operations
   Omit<
     {
-      create<
-        SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[],
-      >(
+      create<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(
         model: Model['createType'],
         options?: {
           selectionSet?: SelectionSet;
@@ -570,9 +519,7 @@ type ModelTypesClient<
       ): SingularReturnValue<
         Prettify<ReturnValue<Model, FlatModel, SelectionSet>>
       >;
-      update<
-        SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[],
-      >(
+      update<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(
         model: Model['updateType'],
         options?: {
           selectionSet?: SelectionSet;
@@ -583,9 +530,7 @@ type ModelTypesClient<
       ): SingularReturnValue<
         Prettify<ReturnValue<Model, FlatModel, SelectionSet>>
       >;
-      delete<
-        SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[],
-      >(
+      delete<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(
         identifier: Model['deleteType'],
         options?: {
           selectionSet?: SelectionSet;
@@ -651,9 +596,7 @@ type ModelTypesClient<
       }): ObservedReturnValue<
         Prettify<ReturnValue<Model, FlatModel, SelectionSet>>
       >;
-      observeQuery<
-        SelectionSet extends ModelPath<FlatModel>[] = never[],
-      >(options?: {
+      observeQuery<SelectionSet extends ModelPath<FlatModel>[] = never[]>(options?: {
         filter?: ModelFilter<Model>;
         selectionSet?: SelectionSet;
         authMode?: AuthMode;
@@ -667,14 +610,12 @@ type ModelTypesClient<
 
 type ModelTypesSSRCookies<
   Model extends ClientSchemaByEntityTypeBaseShape['models'][string],
-  FlatModel extends Record<string, unknown> = ResolvedModel<Model['type']>,
+  FlatModel extends Record<string, unknown> = Model['__meta']['flatModel'],
 > = IndexQueryMethods<Model> &
   // Omit any disabled operations
   Omit<
     {
-      create<
-        SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[],
-      >(
+      create<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(
         model: Model['createType'],
         options?: {
           selectionSet?: SelectionSet;
@@ -685,9 +626,7 @@ type ModelTypesSSRCookies<
       ): SingularReturnValue<
         Prettify<ReturnValue<Model, FlatModel, SelectionSet>>
       >;
-      update<
-        SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[],
-      >(
+      update<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(
         model: Model['updateType'],
         options?: {
           selectionSet?: SelectionSet;
@@ -698,9 +637,7 @@ type ModelTypesSSRCookies<
       ): SingularReturnValue<
         Prettify<ReturnValue<Model, FlatModel, SelectionSet>>
       >;
-      delete<
-        SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[],
-      >(
+      delete<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(
         identifier: Model['deleteType'],
         options?: {
           selectionSet?: SelectionSet;
@@ -740,14 +677,12 @@ type ModelTypesSSRCookies<
 
 type ModelTypesSSRRequest<
   Model extends ClientSchemaByEntityTypeBaseShape['models'][string],
-  FlatModel extends Record<string, unknown> = ResolvedModel<Model['type']>,
+  FlatModel extends Record<string, unknown> = Model['__meta']['flatModel'],
 > = IndexQueryMethods<Model, 'REQUEST'> &
   // Omit any disabled operations
   Omit<
     {
-      create<
-        SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[],
-      >(
+      create<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(
         contextSpec: AmplifyServer.ContextSpec,
         model: Model['createType'],
         options?: {
@@ -759,9 +694,7 @@ type ModelTypesSSRRequest<
       ): SingularReturnValue<
         Prettify<ReturnValue<Model, FlatModel, SelectionSet>>
       >;
-      update<
-        SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[],
-      >(
+      update<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(
         contextSpec: AmplifyServer.ContextSpec,
         model: Model['updateType'],
         options?: {
@@ -773,9 +706,7 @@ type ModelTypesSSRRequest<
       ): SingularReturnValue<
         Prettify<ReturnValue<Model, FlatModel, SelectionSet>>
       >;
-      delete<
-        SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[],
-      >(
+      delete<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(
         contextSpec: AmplifyServer.ContextSpec,
         identifier: Model['deleteType'],
         options?: {

package/src/util/Filters.ts

@@ -125,7 +125,7 @@ export type SubscriptionBooleanFilters = {
  *   lt: {sk1: string; sk2: number};
  *   ge: {sk1: string; sk2: number};
  *   gt: {sk1: string; sk2: number};
- *   between: [ {sk1: string; sk2: number} ];
+ *   between: [ {sk1: string; sk2: number}, {sk1: string; sk2: number} ];
  *   beginsWith: {sk1: string; sk2: number};
  * }
  * ```
@@ -141,6 +141,6 @@ export type ModelPrimaryCompositeKeyInput<
   lt?: SkIr;
   ge?: SkIr;
   gt?: SkIr;
-  between?: [SkIr];
+  between?: [SkIr, SkIr];
   beginsWith?: SkIr;
 };