@aws-amplify/data-schema 0.17.0 → 0.18.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/data-schema",
-  "version": "0.17.0",
+  "version": "0.18.0",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",

package/src/ClientSchema.ts

@@ -74,14 +74,17 @@ type InternalClientSchema<
     ResolvedFields,
     NonModelTypes
   >['customOperations']
-> &
-  ResolvedFields & {
-    [__modelMeta__]: IdentifierMeta &
-      SecondaryIndexes &
-      RelationalMetadata<ResolvedSchema, ResolvedFields, IdentifierMeta> &
-      NonModelTypes &
-      ResolveCustomOperations<Schema, ResolvedFields, NonModelTypes>;
+> & {
+  [K in keyof ResolvedFields]: {
+    type: ResolvedFields[K];
   };
+} & {
+  [__modelMeta__]: IdentifierMeta &
+    SecondaryIndexes &
+    RelationalMetadata<ResolvedSchema, ResolvedFields, IdentifierMeta> &
+    NonModelTypes &
+    ResolveCustomOperations<Schema, ResolvedFields, NonModelTypes>;
+};
 
 type GetInternalClientSchema<Schema> =
   Schema extends GenericModelSchema<any> ? InternalClientSchema<Schema> : never;

package/src/MappedTypes/CustomOperations.ts

@@ -200,7 +200,7 @@ type IndividualCustomHandlerTypes<Op extends CustomOperationMinimalDef> = {
    * }
    * ```
    */
-  functionHandlerArguments: Op['arguments'];
+  args: Op['arguments'];
 
   /**
    * The return type expected by a lambda function handler.
@@ -217,7 +217,7 @@ type IndividualCustomHandlerTypes<Op extends CustomOperationMinimalDef> = {
    * }
    * ```
    */
-  functionHandlerResult: LambdaReturnType<Op['returnType']>;
+  returnType: LambdaReturnType<Op['returnType']>;
 };
 
 /**

package/src/MappedTypes/MapSecondaryIndexes.ts

@@ -1,4 +1,3 @@
-import { IsEmptyStringOrNever } from '@aws-amplify/data-schema-types';
 import { ModelIndexType } from '../ModelIndex';
 
 type ModelIndexTypeShape = ModelIndexType<any, any, any, any, any>;
@@ -34,31 +33,28 @@ export type SecondaryIndexToIR<
  *
  * @remarks - the IR type alias is defined as SecondaryIndexIrShape in data-schema-types
  */
-type SingleIndexIrFromType<
-  Idx extends ModelIndexTypeShape,
-  ResolvedFields,
-> = Idx extends ModelIndexType<
-  any,
-  infer PK extends string,
-  infer SK,
-  infer QueryField extends string | never,
-  any
->
-  ? {
-      queryField: IsEmptyStringOrNever<QueryField> extends true
-        ? `listBy${QueryFieldLabelFromTuple<SK, Capitalize<PK>>}`
-        : QueryField;
-      pk: PK extends keyof ResolvedFields
-        ? {
-            [Key in PK]: Exclude<ResolvedFields[PK], null>;
-          }
-        : never;
-      // distribute ResolvedFields over SK
-      sk: unknown extends SK
-        ? never
-        : ResolvedSortKeyFields<SK, ResolvedFields>;
-    }
-  : never;
+type SingleIndexIrFromType<Idx extends ModelIndexTypeShape, ResolvedFields> =
+  Idx extends ModelIndexType<
+    any,
+    infer PK extends string,
+    infer SK,
+    infer QueryField extends string | never,
+    any
+  >
+    ? {
+        defaultQueryFieldSuffix: `${QueryFieldLabelFromTuple<SK, Capitalize<PK>>}`;
+        queryField: QueryField;
+        pk: PK extends keyof ResolvedFields
+          ? {
+              [Key in PK]: Exclude<ResolvedFields[PK], null>;
+            }
+          : never;
+        // distribute ResolvedFields over SK
+        sk: unknown extends SK
+          ? never
+          : ResolvedSortKeyFields<SK, ResolvedFields>;
+      }
+    : never;
 
 /**
  * @typeParam SK - tuple of SortKey field names, e.g. ['viewCount', 'createdAt']

package/src/SchemaProcessor.ts

@@ -810,12 +810,13 @@ type TransformedSecondaryIndexes = {
  * @returns default query field name
  */
 const secondaryIndexDefaultQueryField = (
+  modelName: string,
   pk: string,
   sk?: readonly string[],
 ): string => {
   const skName = sk?.length ? 'And' + sk?.map(capitalize).join('And') : '';
 
-  const queryField = `listBy${capitalize(pk)}${skName}`;
+  const queryField = `list${capitalize(modelName)}By${capitalize(pk)}${skName}`;
 
   return queryField;
 };
@@ -825,6 +826,7 @@ const secondaryIndexDefaultQueryField = (
  * and the value is an array of transformed Amplify @index directives with all supplied attributes
  */
 const transformedSecondaryIndexesForModel = (
+  modelName: string,
   secondaryIndexes: readonly InternalModelIndexType[],
 ): TransformedSecondaryIndexes => {
   const indexDirectiveWithAttributes = (
@@ -835,6 +837,7 @@ const transformedSecondaryIndexesForModel = (
   ): string => {
     if (!sortKeys.length && !indexName && !queryField) {
       return `@index(queryField: "${secondaryIndexDefaultQueryField(
+        modelName,
         partitionKey,
       )}")`;
     }
@@ -856,6 +859,7 @@ const transformedSecondaryIndexesForModel = (
     } else {
       attributes.push(
         `queryField: "${secondaryIndexDefaultQueryField(
+          modelName,
           partitionKey,
           sortKeys,
         )}"`,
@@ -1164,6 +1168,7 @@ const schemaPreprocessor = (
       const [partitionKey] = identifier;
 
       const transformedSecondaryIndexes = transformedSecondaryIndexesForModel(
+        typeName,
         typeDef.data.secondaryIndexes,
       );
 

package/src/runtime/client/index.ts

@@ -8,6 +8,7 @@ import {
   Equal,
   __modelMeta__,
   ExtractModelMeta,
+  IsEmptyStringOrNever,
 } from '@aws-amplify/data-schema-types';
 import type { Observable } from 'rxjs';
 
@@ -494,10 +495,11 @@ type ModelMetaShape = {
 
 // TODO: remove export. added for debugging.
 export type ModelTypesClient<
+  ModelName extends string,
   Model extends Record<string, unknown>,
   ModelMeta extends ModelMetaShape,
   FlatModel extends Record<string, unknown> = ResolvedModel<Model>,
-> = IndexQueryMethodsFromIR<ModelMeta['secondaryIndexes'], Model> & {
+> = IndexQueryMethodsFromIR<ModelMeta['secondaryIndexes'], ModelName, Model> & {
   create: (
     model: Prettify<CreateModelInput<Model, ModelMeta>>,
     options?: {
@@ -589,10 +591,11 @@ export type ModelTypesClient<
 };
 
 type ModelTypesSSRCookies<
+  ModelName extends string,
   Model extends Record<string, unknown>,
   ModelMeta extends ModelMetaShape,
   FlatModel extends Record<string, unknown> = ResolvedModel<Model>,
-> = IndexQueryMethodsFromIR<ModelMeta['secondaryIndexes'], Model> & {
+> = IndexQueryMethodsFromIR<ModelMeta['secondaryIndexes'], ModelName, Model> & {
   create: (
     model: Prettify<CreateModelInput<Model, ModelMeta>>,
     options?: {
@@ -641,10 +644,11 @@ type ModelTypesSSRCookies<
 };
 
 type ModelTypesSSRRequest<
+  ModelName extends string,
   Model extends Record<string, unknown>,
   ModelMeta extends ModelMetaShape,
   FlatModel extends Record<string, unknown> = ResolvedModel<Model>,
-> = IndexQueryMethodsFromIR<ModelMeta['secondaryIndexes'], Model> & {
+> = IndexQueryMethodsFromIR<ModelMeta['secondaryIndexes'], ModelName, Model> & {
   create: (
     // TODO: actual type
     contextSpec: any,
@@ -716,11 +720,23 @@ export type ModelTypes<
   >]: ModelName extends string
     ? Schema[ModelName] extends Record<string, unknown>
       ? Context extends 'CLIENT'
-        ? ModelTypesClient<Schema[ModelName], ModelMeta[ModelName]>
+        ? ModelTypesClient<
+            ModelName,
+            Schema[ModelName]['type'],
+            ModelMeta[ModelName]
+          >
         : Context extends 'COOKIES'
-          ? ModelTypesSSRCookies<Schema[ModelName], ModelMeta[ModelName]>
+          ? ModelTypesSSRCookies<
+              ModelName,
+              Schema[ModelName]['type'],
+              ModelMeta[ModelName]
+            >
           : Context extends 'REQUEST'
-            ? ModelTypesSSRRequest<Schema[ModelName], ModelMeta[ModelName]>
+            ? ModelTypesSSRRequest<
+                ModelName,
+                Schema[ModelName]['type'],
+                ModelMeta[ModelName]
+              >
             : never
       : never
     : never;
@@ -847,6 +863,7 @@ export type CustomHeaders =
  * SecondaryIndex index types and query methods
  */
 export type SecondaryIndexIrShape = {
+  defaultQueryFieldSuffix: string;
   queryField: string;
   pk: { [key: string]: string | number };
   sk: { [key: string]: string | number };
@@ -854,20 +871,30 @@ export type SecondaryIndexIrShape = {
 
 type IndexQueryMethodsFromIR<
   SecondaryIdxTuple extends SecondaryIndexIrShape[],
+  ModelName extends string,
   Model extends Record<string, unknown>,
   Res = unknown, // defaulting `unknown` because it gets absorbed in an intersection, e.g. `{a: 1} & unknown` => `{a: 1}`
 > = SecondaryIdxTuple extends [
   infer A extends SecondaryIndexIrShape,
   ...infer B extends SecondaryIndexIrShape[],
 ]
-  ? IndexQueryMethodsFromIR<B, Model, IndexQueryMethodSignature<A, Model> & Res>
+  ? IndexQueryMethodsFromIR<
+      B,
+      ModelName,
+      Model,
+      IndexQueryMethodSignature<A, ModelName, Model> & Res
+    >
   : Res;
 
 type IndexQueryMethodSignature<
   Idx extends SecondaryIndexIrShape,
+  ModelName extends string,
   Model extends Record<string, unknown>,
-> = {
-  [K in Idx['queryField'] & string]: <
+> = Record<
+  IsEmptyStringOrNever<Idx['queryField']> extends false
+    ? Idx['queryField']
+    : `list${ModelName}By${Idx['defaultQueryFieldSuffix']}`,
+  <
     FlatModel extends Record<string, unknown> = ResolvedModel<Model>,
     SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[],
   >(
@@ -886,8 +913,8 @@ type IndexQueryMethodSignature<
       authToken?: string;
       headers?: CustomHeaders;
     },
-  ) => ListReturnValue<Prettify<ReturnValue<Model, FlatModel, SelectionSet>>>;
-};
+  ) => ListReturnValue<Prettify<ReturnValue<Model, FlatModel, SelectionSet>>>
+>;
 
 type FilteredKeys<T> = {
   [P in keyof T]: T[P] extends never ? never : P;