@aws-amplify/data-schema 1.23.0 → 1.25.0

package/dist/esm/ClientSchema/Core/ClientModel.d.ts

@@ -1,7 +1,7 @@
 import type { deferredRefResolvingPrefix, ModelTypeParamShape, ModelDefaultIdentifier, DisableOperationsOptions } 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, Equal, Prettify } from '@aws-amplify/data-schema-types';
 import type { ModelField } from '../../ModelField';
 import type { ModelRelationshipField } from '../../ModelRelationshipField';
@@ -20,6 +20,8 @@ export interface ClientModel<Bag extends Record<string, unknown>, Metadata exten
     secondaryIndexes: IndexQueryMethodsFromIR<Bag, T['secondaryIndexes'], K>;
     __meta: {
         listOptionsPkParams: ListOptionsPkParams<Bag, T>;
+        rawType: T;
+        flatModel: FlatClientFields<Bag, Metadata, false, T, K>;
         disabledOperations: DisabledOpsToMap<T['disabledOperations']>;
     };
 }
@@ -42,6 +44,7 @@ type DisabledOpsToMap<Ops extends ReadonlyArray<DisableOperationsOptions>> = {
     [Op in Ops[number] as Op extends 'queries' ? 'list' | 'get' | 'observeQuery' : Op extends 'mutations' ? 'create' | 'update' | 'delete' : Op extends 'subscriptions' ? 'onCreate' | 'onUpdate' | 'onDelete' | 'observeQuery' : Op extends 'list' ? 'list' | 'observeQuery' : Op]: true;
 };
 type ClientFields<Bag extends Record<string, unknown>, Metadata extends SchemaMetadata<any>, IsRDS extends boolean, T extends ModelTypeParamShape> = ResolveFields<Bag, T['fields']> & If<Not<IsRDS>, ImplicitIdentifier<T>> & 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;
     readonly updatedAt: string;

package/dist/esm/ClientSchema/utilities/ResolveField.d.ts

@@ -5,6 +5,8 @@ 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
  * definitions (e.g., `a.string()`) are turned into the client facing types (e.g., `string`),
@@ -19,14 +21,42 @@ export type ResolveFields<Bag extends Record<string, any>, T> = ShallowPretty<{
 } & {
     [K in keyof T as IsRequired<T[K]> extends true ? never : K]+?: ResolveIndividualField<Bag, T[K]>;
 }>;
+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>;
+}>;
 type ShallowPretty<T> = {
     [K in keyof T]: T[K];
 };
-export type ResolveIndividualField<Bag extends Record<string, any>, T> = 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> : T extends CustomType<infer CT> ? ResolveFields<Bag, CT['fields']> | null : T extends EnumType<infer values> ? values[number] | null : never;
+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, FlatModelName> : T extends CustomType<infer CT> ? ResolveFields<Bag, CT['fields']> | null : T extends EnumType<infer values> ? values[number] | null : 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 ResolveRelationship<Bag extends Record<string, any>, RelationshipShape extends ModelRelationshipFieldParamShape> = DependentLazyLoaderOpIsAvailable<Bag, RelationshipShape> extends true ? LazyLoader<RelationshipShape['valueRequired'] extends true ? Bag[RelationshipShape['relatedModel']]['type'] : Bag[RelationshipShape['relatedModel']]['type'] | null, RelationshipShape['array']> : never;
+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> = 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 : 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>, RelationshipShape extends ModelRelationshipFieldParamShape> = RelationshipShape['relationshipType'] extends 'hasOne' | 'hasMany' ? 'list' extends keyof Bag[RelationshipShape['relatedModel']]['__meta']['disabledOperations'] ? false : true : 'get' extends keyof Bag[RelationshipShape['relatedModel']]['__meta']['disabledOperations'] ? false : true;
 type IsRequired<T> = T extends BaseModelField<infer FieldShape> ? null extends FieldShape ? false : true : T extends RefType<infer RefShape, any, any> ? IsRefRequired<RefShape> : T extends ModelRelationshipField<any, any, any, any> ? true : T extends CustomType<any> | EnumType<any> ? false : never;
 type IsRefRequired<T extends RefTypeParamShape> = T['array'] extends true ? T['arrayRequired'] : T['valueRequired'];

package/dist/esm/ModelIndex.d.ts

@@ -1,10 +1,24 @@
 import { Brand } from './util';
 declare const brandName = "modelIndexType";
+/**
+ * DynamoDB Global Secondary Index (GSI) projection types.
+ * - `KEYS_ONLY`: Only the index and primary keys are projected into the index.
+ * - `INCLUDE`: In addition to the attributes in KEYS_ONLY, includes specified non-key attributes.
+ * - `ALL`: All attributes from the base table are projected into the index.
+ */
+export type GSIProjectionType = 'KEYS_ONLY' | 'INCLUDE' | 'ALL';
+/**
+ * Configuration data for a model's secondary index.
+ */
 export type ModelIndexData = {
     partitionKey: string;
     sortKeys: readonly unknown[];
     indexName: string;
     queryField: string | null;
+    /** The projection type for the GSI. Defaults to 'ALL' if not specified. */
+    projectionType?: GSIProjectionType;
+    /** Non-key attributes to include when projectionType is 'INCLUDE'. */
+    nonKeyAttributes?: readonly string[];
 };
 export type InternalModelIndexType = ModelIndexType<any, any, any, any> & {
     data: ModelIndexData;
@@ -13,6 +27,7 @@ export type ModelIndexType<ModelFieldKeys extends string, PK, SK = readonly [],
     sortKeys<FieldKeys extends ModelFieldKeys = ModelFieldKeys, const SK extends ReadonlyArray<Exclude<FieldKeys, PK>> = readonly []>(sortKeys: SK): ModelIndexType<FieldKeys, PK, SK, QueryField, K | 'sortKeys'>;
     name(name: string): ModelIndexType<ModelFieldKeys, PK, SK, QueryField, K | 'name'>;
     queryField<QF extends string | null = never, MF extends ModelFieldKeys = ModelFieldKeys>(field: QF): ModelIndexType<MF, PK, SK, QF, K | 'queryField'>;
+    projection<PT extends GSIProjectionType, NKA extends PT extends 'INCLUDE' ? readonly string[] : never = never>(type: PT, ...args: PT extends 'INCLUDE' ? [nonKeyAttributes: NKA] : []): ModelIndexType<ModelFieldKeys, PK, SK, QueryField, K | 'projection'>;
 }, K> & Brand<typeof brandName>;
 export declare function modelIndex<ModelFieldKeys extends string, PK extends ModelFieldKeys, SK = readonly [], QueryField = never>(partitionKeyFieldName: PK): ModelIndexType<ModelFieldKeys, PK, SK, QueryField, never>;
 export {};

package/dist/esm/ModelIndex.mjs

@@ -7,6 +7,8 @@ function _modelIndex(partitionKeyFieldName) {
         sortKeys: [],
         indexName: '',
         queryField: '',
+        projectionType: 'ALL',
+        nonKeyAttributes: undefined,
     };
     const builder = {
         sortKeys(sortKeys) {
@@ -21,6 +23,13 @@ function _modelIndex(partitionKeyFieldName) {
             data.queryField = field;
             return this;
         },
+        projection(type, ...args) {
+            data.projectionType = type;
+            if (type === 'INCLUDE') {
+                data.nonKeyAttributes = args[0];
+            }
+            return this;
+        },
         ...brand(brandName),
     };
     return { ...builder, data };

package/dist/esm/ModelIndex.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"ModelIndex.mjs","sources":["../../src/ModelIndex.ts"],"sourcesContent":["import { brand } from './util';\nconst brandName = 'modelIndexType';\nfunction _modelIndex(partitionKeyFieldName) {\n    const data = {\n        partitionKey: partitionKeyFieldName,\n        sortKeys: [],\n        indexName: '',\n        queryField: '',\n    };\n    const builder = {\n        sortKeys(sortKeys) {\n            data.sortKeys = sortKeys;\n            return this;\n        },\n        name(name) {\n            data.indexName = name;\n            return this;\n        },\n        queryField(field) {\n            data.queryField = field;\n            return this;\n        },\n        ...brand(brandName),\n    };\n    return { ...builder, data };\n}\nexport function modelIndex(partitionKeyFieldName) {\n    return _modelIndex(partitionKeyFieldName);\n}\n"],"names":[],"mappings":";;AACA,MAAM,SAAS,GAAG,gBAAgB;AAClC,SAAS,WAAW,CAAC,qBAAqB,EAAE;AAC5C,IAAI,MAAM,IAAI,GAAG;AACjB,QAAQ,YAAY,EAAE,qBAAqB;AAC3C,QAAQ,QAAQ,EAAE,EAAE;AACpB,QAAQ,SAAS,EAAE,EAAE;AACrB,QAAQ,UAAU,EAAE,EAAE;AACtB,KAAK;AACL,IAAI,MAAM,OAAO,GAAG;AACpB,QAAQ,QAAQ,CAAC,QAAQ,EAAE;AAC3B,YAAY,IAAI,CAAC,QAAQ,GAAG,QAAQ;AACpC,YAAY,OAAO,IAAI;AACvB,SAAS;AACT,QAAQ,IAAI,CAAC,IAAI,EAAE;AACnB,YAAY,IAAI,CAAC,SAAS,GAAG,IAAI;AACjC,YAAY,OAAO,IAAI;AACvB,SAAS;AACT,QAAQ,UAAU,CAAC,KAAK,EAAE;AAC1B,YAAY,IAAI,CAAC,UAAU,GAAG,KAAK;AACnC,YAAY,OAAO,IAAI;AACvB,SAAS;AACT,QAAQ,GAAG,KAAK,CAAC,SAAS,CAAC;AAC3B,KAAK;AACL,IAAI,OAAO,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE;AAC/B;AACO,SAAS,UAAU,CAAC,qBAAqB,EAAE;AAClD,IAAI,OAAO,WAAW,CAAC,qBAAqB,CAAC;AAC7C;;;;"}
+{"version":3,"file":"ModelIndex.mjs","sources":["../../src/ModelIndex.ts"],"sourcesContent":["import { brand } from './util';\nconst brandName = 'modelIndexType';\nfunction _modelIndex(partitionKeyFieldName) {\n    const data = {\n        partitionKey: partitionKeyFieldName,\n        sortKeys: [],\n        indexName: '',\n        queryField: '',\n        projectionType: 'ALL',\n        nonKeyAttributes: undefined,\n    };\n    const builder = {\n        sortKeys(sortKeys) {\n            data.sortKeys = sortKeys;\n            return this;\n        },\n        name(name) {\n            data.indexName = name;\n            return this;\n        },\n        queryField(field) {\n            data.queryField = field;\n            return this;\n        },\n        projection(type, ...args) {\n            data.projectionType = type;\n            if (type === 'INCLUDE') {\n                data.nonKeyAttributes = args[0];\n            }\n            return this;\n        },\n        ...brand(brandName),\n    };\n    return { ...builder, data };\n}\nexport function modelIndex(partitionKeyFieldName) {\n    return _modelIndex(partitionKeyFieldName);\n}\n"],"names":[],"mappings":";;AACA,MAAM,SAAS,GAAG,gBAAgB;AAClC,SAAS,WAAW,CAAC,qBAAqB,EAAE;AAC5C,IAAI,MAAM,IAAI,GAAG;AACjB,QAAQ,YAAY,EAAE,qBAAqB;AAC3C,QAAQ,QAAQ,EAAE,EAAE;AACpB,QAAQ,SAAS,EAAE,EAAE;AACrB,QAAQ,UAAU,EAAE,EAAE;AACtB,QAAQ,cAAc,EAAE,KAAK;AAC7B,QAAQ,gBAAgB,EAAE,SAAS;AACnC,KAAK;AACL,IAAI,MAAM,OAAO,GAAG;AACpB,QAAQ,QAAQ,CAAC,QAAQ,EAAE;AAC3B,YAAY,IAAI,CAAC,QAAQ,GAAG,QAAQ;AACpC,YAAY,OAAO,IAAI;AACvB,SAAS;AACT,QAAQ,IAAI,CAAC,IAAI,EAAE;AACnB,YAAY,IAAI,CAAC,SAAS,GAAG,IAAI;AACjC,YAAY,OAAO,IAAI;AACvB,SAAS;AACT,QAAQ,UAAU,CAAC,KAAK,EAAE;AAC1B,YAAY,IAAI,CAAC,UAAU,GAAG,KAAK;AACnC,YAAY,OAAO,IAAI;AACvB,SAAS;AACT,QAAQ,UAAU,CAAC,IAAI,EAAE,GAAG,IAAI,EAAE;AAClC,YAAY,IAAI,CAAC,cAAc,GAAG,IAAI;AACtC,YAAY,IAAI,IAAI,KAAK,SAAS,EAAE;AACpC,gBAAgB,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAAC,CAAC;AAC/C;AACA,YAAY,OAAO,IAAI;AACvB,SAAS;AACT,QAAQ,GAAG,KAAK,CAAC,SAAS,CAAC;AAC3B,KAAK;AACL,IAAI,OAAO,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE;AAC/B;AACO,SAAS,UAAU,CAAC,qBAAqB,EAAE;AAClD,IAAI,OAAO,WAAW,CAAC,qBAAqB,CAAC;AAC7C;;;;"}

package/dist/esm/SchemaProcessor.mjs

@@ -730,7 +730,7 @@ const secondaryIndexDefaultQueryField = (modelName, pk, sk) => {
  * and the value is an array of transformed Amplify @index directives with all supplied attributes
  */
 const transformedSecondaryIndexesForModel = (modelName, secondaryIndexes, modelFields, getRefType) => {
-    const indexDirectiveWithAttributes = (partitionKey, sortKeys, indexName, queryField) => {
+    const indexDirectiveWithAttributes = (partitionKey, sortKeys, indexName, queryField, projectionType, nonKeyAttributes) => {
         for (const keyName of [partitionKey, ...sortKeys]) {
             const field = modelFields[keyName];
             if (isRefField(field)) {
@@ -740,7 +740,7 @@ const transformedSecondaryIndexesForModel = (modelName, secondaryIndexes, modelF
                 }
             }
         }
-        if (!sortKeys.length && !indexName && !queryField && queryField !== null) {
+        if (!sortKeys.length && !indexName && !queryField && queryField !== null && !projectionType) {
             return `@index(queryField: "${secondaryIndexDefaultQueryField(modelName, partitionKey)}")`;
         }
         const attributes = [];
@@ -759,11 +759,21 @@ const transformedSecondaryIndexesForModel = (modelName, secondaryIndexes, modelF
         else {
             attributes.push(`queryField: "${secondaryIndexDefaultQueryField(modelName, partitionKey, sortKeys)}"`);
         }
+        // Add projection attributes if specified
+        if (projectionType && projectionType !== 'ALL') {
+            if (projectionType === 'KEYS_ONLY') {
+                attributes.push(`projection: { type: KEYS_ONLY }`);
+            }
+            else if (projectionType === 'INCLUDE' && nonKeyAttributes?.length) {
+                const nonKeyAttrsStr = nonKeyAttributes.map(attr => `"${attr}"`).join(', ');
+                attributes.push(`projection: { type: INCLUDE, nonKeyAttributes: [${nonKeyAttrsStr}] }`);
+            }
+        }
         return `@index(${attributes.join(', ')})`;
     };
-    return secondaryIndexes.reduce((acc, { data: { partitionKey, sortKeys, indexName, queryField } }) => {
+    return secondaryIndexes.reduce((acc, { data: { partitionKey, sortKeys, indexName, queryField, projectionType, nonKeyAttributes } }) => {
         acc[partitionKey] = acc[partitionKey] || [];
-        acc[partitionKey].push(indexDirectiveWithAttributes(partitionKey, sortKeys, indexName, queryField));
+        acc[partitionKey].push(indexDirectiveWithAttributes(partitionKey, sortKeys, indexName, queryField, projectionType, nonKeyAttributes));
         return acc;
     }, {});
 };