@aws-amplify/data-schema 1.1.3 → 1.1.4

package/src/MappedTypes/ImplicitFieldInjector.ts

@@ -1,38 +1,40 @@
+import type { PrimaryIndexIrShape } from '../runtime/';
+
 type DefaultIdentifierFields = {
   // implicit `id` is readonly because it's managed by the resolver; explicit `id` is writable
   readonly id: string;
 };
 
+type DefaultIdentifierType = { pk: { id: string } };
+
 type DefaultTimestampFields = {
   readonly createdAt: string;
   readonly updatedAt: string;
 };
 
-type InitialImplicitFields<Identifier> = Identifier extends 'id'
-  ? DefaultIdentifierFields & DefaultTimestampFields
-  : DefaultTimestampFields;
+type InitialImplicitFields<Identifier> =
+  Identifier extends DefaultIdentifierType
+    ? DefaultIdentifierFields & DefaultTimestampFields
+    : DefaultTimestampFields;
 
 /**
  * @returns true if a string union `ExplicitFieldNames` contains a given string `FieldName`
  */
-type FieldExists<
-  ExplicitFieldNames extends string,
-  FieldName extends string,
-> = Extract<ExplicitFieldNames, FieldName> extends never ? false : true;
+type FieldExists<ExplicitFieldNames extends string, FieldName extends string> =
+  Extract<ExplicitFieldNames, FieldName> extends never ? false : true;
 
 /**
  * @returns union of explicitly defined field names for a model
  */
-type GetModelFieldNames<FlatModel> = FlatModel extends Record<infer R, any>
-  ? R
-  : never;
+type GetModelFieldNames<FlatModel> =
+  FlatModel extends Record<infer R, any> ? R : never;
 
 /**
  * Generate Record type containing all implicit fields for a given model
  */
 type ImplicitFields<
   FlatModel,
-  Identifier,
+  Identifier extends PrimaryIndexIrShape,
   ModelFieldNames = GetModelFieldNames<FlatModel>,
 > = {
   [ImplicitField in keyof InitialImplicitFields<Identifier> as FieldExists<
@@ -46,7 +48,10 @@ type ImplicitFields<
 /**
  * @returns intersection of explicit and implicit model fields
  */
-type InjectDefaultFieldsForModel<FlatModel, ModelIdentifier> = FlatModel &
+type InjectDefaultFieldsForModel<
+  FlatModel,
+  ModelIdentifier extends { identifier: PrimaryIndexIrShape },
+> = FlatModel &
   ImplicitFields<
     FlatModel,
     'identifier' extends keyof ModelIdentifier
@@ -61,9 +66,12 @@ type InjectDefaultFieldsForModel<FlatModel, ModelIdentifier> = FlatModel &
  *
  * @typeParam FlattenedSchema - resolved schema type (TODO: add detail/example/link to type)
  */
-export type InjectImplicitModelFields<FlattenedSchema, IdentifierMeta> = {
+export type InjectImplicitModelFields<
+  FlattenedSchema,
+  IdentifierMeta extends Record<string, { identifier: PrimaryIndexIrShape }>,
+> = {
   [ModelName in keyof FlattenedSchema]: InjectDefaultFieldsForModel<
     FlattenedSchema[ModelName],
-    ModelName extends keyof IdentifierMeta ? IdentifierMeta[ModelName] : object
+    ModelName extends keyof IdentifierMeta ? IdentifierMeta[ModelName] : never
   >;
 };

package/src/MappedTypes/{MapSecondaryIndexes.ts → MapIndexes.ts}

@@ -2,6 +2,22 @@ import { ModelIndexType } from '../ModelIndex';
 
 type ModelIndexTypeShape = ModelIndexType<any, any, any, any, any>;
 
+export type PrimaryIndexFieldsToIR<
+  IdxFields extends ReadonlyArray<string>,
+  ResolvedFields,
+> = IdxFields extends readonly [infer PK, ...infer SK]
+  ? {
+      pk: PK extends keyof ResolvedFields
+        ? {
+            [Key in PK]: Exclude<ResolvedFields[PK], null> & (string | number);
+          }
+        : never;
+      sk: unknown extends SK
+        ? never
+        : ResolvedSortKeyFields<SK, ResolvedFields>;
+    }
+  : never;
+
 /**
  * Maps array of ModelIndexType to SecondaryIndexIrShape (defined in in data-schema-types)
  * */

package/src/MappedTypes/ModelMetadata.ts

@@ -2,23 +2,21 @@ import {
   type UnionToIntersection,
   type ExcludeEmpty,
 } from '@aws-amplify/data-schema-types';
-import { __modelMeta__ } from '../runtime/client';
+import { __modelMeta__, type PrimaryIndexIrShape } from '../runtime/';
 import type { ModelType } from '../ModelType';
 import type { ModelRelationalFieldParamShape } from '../ModelRelationalField';
 
 export type ModelIdentifier<T> = {
   [Property in keyof T]: T[Property] extends ModelType<infer R, any>
-    ? // reduce back to union
-      R['identifier'] extends any[]
-      ? { identifier: R['identifier'][number] }
+    ? R['identifier'] extends PrimaryIndexIrShape
+      ? { identifier: R['identifier'] }
       : never
     : never;
 };
 
 export type ModelSecondaryIndexes<T> = {
   [Property in keyof T]: T[Property] extends ModelType<infer R, any>
-    ? // reduce back to union
-      R['secondaryIndexes'] extends any[]
+    ? R['secondaryIndexes'] extends any[]
       ? { secondaryIndexes: R['secondaryIndexes'] }
       : never
     : never;
@@ -27,7 +25,7 @@ export type ModelSecondaryIndexes<T> = {
 export type RelationalMetadata<
   ResolvedSchema,
   ResolvedFields extends Record<string, unknown>,
-  IdentifierMeta extends Record<string, any>,
+  IdentifierMeta extends Record<string, { identifier: PrimaryIndexIrShape }>,
 > = UnionToIntersection<
   ExcludeEmpty<
     {
@@ -77,11 +75,18 @@ export type RelationalMetadata<
   >
 >;
 
-type ExtractModelIdentifier<ModelName, IdentifierMeta> =
-  ModelName extends keyof IdentifierMeta ? IdentifierMeta[ModelName] : never;
+type ExtractModelIdentifier<
+  ModelName,
+  IdentifierMeta extends Record<string, { identifier: PrimaryIndexIrShape }>,
+> = ModelName extends keyof IdentifierMeta ? IdentifierMeta[ModelName] : never;
 
 type NormalizeInputFields<
   ModelFields,
-  IdentifierMeta extends Record<string, any>,
-> = Partial<Omit<ModelFields, IdentifierMeta['identifier']>> &
-  Required<Pick<ModelFields, IdentifierMeta['identifier']>>;
+  IdentifierMeta extends { identifier: PrimaryIndexIrShape },
+  IdFields extends keyof ModelFields =
+    | (keyof IdentifierMeta['identifier']['pk'] & keyof ModelFields)
+    | (IdentifierMeta['identifier']['sk'] extends never
+        ? never
+        : keyof IdentifierMeta['identifier']['sk'] & keyof ModelFields),
+> = Partial<Omit<ModelFields, IdFields>> &
+  Required<Pick<ModelFields, IdFields>>;

package/src/MappedTypes/ResolveFieldProperties.ts

@@ -10,6 +10,7 @@ import type {
   ModelRelationalField,
   ModelRelationalFieldParamShape,
 } from '../ModelRelationalField';
+import type { PrimaryIndexIrShape } from '../runtime/';
 
 import type { ResolveSchema, SchemaTypes } from './ResolveSchema';
 import type { InjectImplicitModelFields } from './ImplicitFieldInjector';
@@ -31,7 +32,7 @@ export type ResolveFieldProperties<
   ResolvedSchema = ResolveSchema<Schema>,
   IdentifierMeta extends Record<
     string,
-    { identifier: string }
+    { identifier: PrimaryIndexIrShape }
   > = ModelIdentifier<SchemaTypes<Schema>>,
   FieldsWithInjectedImplicitFields = InjectImplicitModelFields<
     ResolvedSchema,
@@ -56,7 +57,7 @@ export type ResolveStaticFieldProperties<
   ResolvedSchema = ResolveSchema<Schema>,
   FieldsWithInjectedImplicitFields = InjectImplicitModelFields<
     ResolvedSchema & ImplicitModelsSchema,
-    object
+    never
   >,
   FieldsWithRelationships = ResolveModelsRelationalAndRefFields<
     FieldsWithInjectedImplicitFields,

package/src/ModelType.ts

@@ -1,24 +1,25 @@
-import type {
-  SetTypeSubArg,
-  SecondaryIndexIrShape,
-} from '@aws-amplify/data-schema-types';
-import { Brand, brand } from './util';
-import { ModelField, InternalField } from './ModelField';
+import type { SetTypeSubArg } from '@aws-amplify/data-schema-types';
+import type { PrimaryIndexIrShape, SecondaryIndexIrShape } from './runtime';
+import { type Brand, brand } from './util';
+import type { ModelField, InternalField } from './ModelField';
 import type {
   ModelRelationalField,
   InternalRelationalField,
   ModelRelationalFieldParamShape,
 } from './ModelRelationalField';
-import { AllowModifier, Authorization, allow } from './Authorization';
-import { RefType, RefTypeParamShape } from './RefType';
-import { EnumType, EnumTypeParamShape } from './EnumType';
-import { CustomType, CustomTypeParamShape } from './CustomType';
+import { type AllowModifier, type Authorization, allow } from './Authorization';
+import type { RefType, RefTypeParamShape } from './RefType';
+import type { EnumType, EnumTypeParamShape } from './EnumType';
+import type { CustomType, CustomTypeParamShape } from './CustomType';
 import {
-  ModelIndexType,
-  InternalModelIndexType,
+  type ModelIndexType,
+  type InternalModelIndexType,
   modelIndex,
 } from './ModelIndex';
-import { SecondaryIndexToIR } from './MappedTypes/MapSecondaryIndexes';
+import type {
+  PrimaryIndexFieldsToIR,
+  SecondaryIndexToIR,
+} from './MappedTypes/MapIndexes';
 
 const brandName = 'modelType';
 export type deferredRefResolvingPrefix = 'deferredRefResolving:';
@@ -39,14 +40,14 @@ type InternalModelFields = Record<
 
 type ModelData = {
   fields: ModelFields;
-  identifier: string[];
+  identifier: ReadonlyArray<string>;
   secondaryIndexes: ReadonlyArray<ModelIndexType<any, any, any, any, any>>;
   authorization: Authorization<any, any, any>[];
 };
 
 type InternalModelData = ModelData & {
   fields: InternalModelFields;
-  identifier: string[];
+  identifier: ReadonlyArray<string>;
   secondaryIndexes: ReadonlyArray<InternalModelIndexType>;
   authorization: Authorization<any, any, any>[];
   originalName?: string;
@@ -54,7 +55,7 @@ type InternalModelData = ModelData & {
 
 export type ModelTypeParamShape = {
   fields: ModelFields;
-  identifier: string[];
+  identifier: PrimaryIndexIrShape;
   secondaryIndexes: ReadonlyArray<SecondaryIndexIrShape>;
   authorization: Authorization<any, any, any>[];
 };
@@ -73,20 +74,27 @@ export type ModelTypeParamShape = {
  * indicator string, and resolve its corresponding type later in
  * packages/data-schema/src/runtime/client/index.ts
  */
-type ExtractSecondaryIndexIRFields<T extends ModelTypeParamShape> = {
+export type ExtractSecondaryIndexIRFields<
+  T extends ModelTypeParamShape,
+  RequiredOnly extends boolean = false,
+> = {
   [FieldProp in keyof T['fields'] as T['fields'][FieldProp] extends ModelField<
     infer R,
     any,
     any
   >
     ? NonNullable<R> extends string | number
-      ? FieldProp
+      ? RequiredOnly extends false
+        ? FieldProp
+        : null extends R
+          ? never
+          : FieldProp
       : never
-    : T['fields'][FieldProp] extends EnumType<EnumTypeParamShape>
+    : T['fields'][FieldProp] extends
+          | EnumType<EnumTypeParamShape>
+          | RefType<RefTypeParamShape, any, any>
       ? FieldProp
-      : T['fields'][FieldProp] extends RefType<RefTypeParamShape, any, any>
-        ? FieldProp
-        : never]: T['fields'][FieldProp] extends ModelField<infer R, any, any>
+      : never]: T['fields'][FieldProp] extends ModelField<infer R, any, any>
     ? R
     : T['fields'][FieldProp] extends EnumType<infer R>
       ? R['values'][number]
@@ -107,26 +115,6 @@ type ExtractType<T extends ModelTypeParamShape> = {
     : never;
 };
 
-type GetRequiredFields<T> = {
-  [FieldProp in keyof T as T[FieldProp] extends NonNullable<T[FieldProp]>
-    ? FieldProp
-    : never]: T[FieldProp];
-};
-
-type IdentifierMap<T extends ModelTypeParamShape> = GetRequiredFields<
-  ExtractType<T>
->;
-
-// extracts model fields that CAN BE used as identifiers (scalar, non-nullable fields)
-// TODO: make this also filter out all non-scalars e.g., model fields and custom types
-type IdentifierFields<T extends ModelTypeParamShape> = keyof IdentifierMap<T> &
-  string;
-
-type IdentifierType<
-  T extends ModelTypeParamShape,
-  Fields extends string = IdentifierFields<T>,
-> = Array<Fields>;
-
 /**
  * For a given ModelTypeParamShape, produces a map of Authorization rules
  * that would *conflict* with the given type.
@@ -214,9 +202,20 @@ export type ModelType<
   K extends keyof ModelType<T> = never,
 > = Omit<
   {
-    identifier<ID extends IdentifierType<T> = []>(
+    identifier<
+      PrimaryIndexFields = ExtractSecondaryIndexIRFields<T, true>,
+      PrimaryIndexPool extends string = keyof PrimaryIndexFields & string,
+      const ID extends ReadonlyArray<PrimaryIndexPool> = readonly [],
+      const PrimaryIndexIR extends PrimaryIndexIrShape = PrimaryIndexFieldsToIR<
+        ID,
+        PrimaryIndexFields
+      >,
+    >(
       identifier: ID,
-    ): ModelType<SetTypeSubArg<T, 'identifier', ID>, K | 'identifier'>;
+    ): ModelType<
+      SetTypeSubArg<T, 'identifier', PrimaryIndexIR>,
+      K | 'identifier'
+    >;
     secondaryIndexes<
       const SecondaryIndexFields = ExtractSecondaryIndexIRFields<T>,
       const SecondaryIndexPKPool extends string = keyof SecondaryIndexFields &
@@ -272,7 +271,7 @@ export type SchemaModelType<
   IsRDS extends boolean = false,
 > = IsRDS extends true
   ? T & {
-    relationships<
+      relationships<
         Param extends Record<
           string,
           ModelRelationalField<any, string, any, any>
@@ -368,7 +367,7 @@ export function model<T extends ModelFields>(
   fields: T,
 ): ModelType<{
   fields: T;
-  identifier: Array<'id'>;
+  identifier: { pk: { id: string }; sk: never };
   secondaryIndexes: [];
   authorization: [];
 }> {

package/src/SchemaProcessor.ts

@@ -133,7 +133,7 @@ function isRefField(
 
 function scalarFieldToGql(
   fieldDef: ScalarFieldDef,
-  identifier?: string[],
+  identifier?: readonly string[],
   secondaryIndexes: string[] = [],
 ) {
   const {
@@ -825,7 +825,7 @@ function processFields(
   fields: Record<string, any>,
   impliedFields: Record<string, any>,
   fieldLevelAuthRules: Record<string, string | null>,
-  identifier?: string[],
+  identifier?: readonly string[],
   partitionKey?: string,
   secondaryIndexes: TransformedSecondaryIndexes = {},
 ) {
@@ -1329,7 +1329,9 @@ const schemaPreprocessor = (
       topLevelTypes.push(...implicitTypes);
 
       const joined = gqlFields.join('\n  ');
-      const refersToString = typeDef.data.originalName ? ` @refersTo(name: "${typeDef.data.originalName}")` : '';
+      const refersToString = typeDef.data.originalName
+        ? ` @refersTo(name: "${typeDef.data.originalName}")`
+        : '';
       // TODO: update @model(timestamps: null) once a longer term solution gets
       // determined.
       //

package/src/runtime/client/index.ts

@@ -271,9 +271,12 @@ export type SelectionSet<
 // #endregion
 
 // #region Input mapped types
-export type ModelIdentifier<Model extends Record<any, any>> = Prettify<
-  Record<Model['identifier'] & string, string>
->;
+
+export type ModelIdentifier<ModelMeta extends ModelMetaShape> =
+  ModelMeta['identifier']['pk'] &
+    (ModelMeta['identifier']['sk'] extends never
+      ? unknown // unknown collapses in an intersection
+      : ModelMeta['identifier']['sk']);
 
 type IfEquals<X, Y, A = X, B = never> =
   (<T>() => T extends X ? 1 : 2) extends <T>() => T extends Y ? 1 : 2 ? A : B;
@@ -306,7 +309,7 @@ type MutationInput<
  */
 type CreateModelInput<
   Model extends Record<string, unknown>,
-  ModelMeta extends Record<string, unknown>,
+  ModelMeta extends ModelMetaShape,
 > =
   Equal<ModelIdentifier<ModelMeta>, { id: string }> extends true
     ? Partial<ModelIdentifier<ModelMeta>> & Omit<MutationInput<Model>, 'id'>
@@ -492,7 +495,7 @@ export type ModelSortDirection = 'ASC' | 'DESC';
 
 type ModelMetaShape = {
   secondaryIndexes: SecondaryIndexIrShape[];
-  identifier: string;
+  identifier: PrimaryIndexIrShape;
 };
 
 // TODO: remove export. added for debugging.
@@ -542,9 +545,8 @@ export type ModelTypesClient<
     },
   ): SingularReturnValue<Prettify<ReturnValue<Model, FlatModel, SelectionSet>>>;
   list<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(
-    options?: Partial<ModelIdentifier<ModelMeta>> & {
+    options?: ListPkOptions<ModelMeta, Enums> & {
       filter?: ModelFilter<Model>;
-      sortDirection?: ModelSortDirection;
       limit?: number;
       nextToken?: string | null;
       selectionSet?: SelectionSet;
@@ -644,7 +646,7 @@ type ModelTypesSSRCookies<
     },
   ): SingularReturnValue<Prettify<ReturnValue<Model, FlatModel, SelectionSet>>>;
   list<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(
-    options?: Partial<ModelIdentifier<ModelMeta>> & {
+    options?: ListPkOptions<ModelMeta, Enums> & {
       filter?: ModelFilter<Model>;
       sortDirection?: ModelSortDirection;
       limit?: number;
@@ -709,7 +711,7 @@ type ModelTypesSSRRequest<
   ): SingularReturnValue<Prettify<ReturnValue<Model, FlatModel, SelectionSet>>>;
   list<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(
     contextSpec: any,
-    options?: Partial<ModelIdentifier<ModelMeta>> & {
+    options?: ListPkOptions<ModelMeta, Enums> & {
       filter?: ModelFilter<Model>;
       sortDirection?: ModelSortDirection;
       limit?: number;
@@ -883,14 +885,20 @@ export type CustomHeaders =
   | ((requestOptions?: RequestOptions) => Promise<Record<string, string>>);
 
 /**
- * SecondaryIndex index types and query methods
+ * PrimaryIndex field types and query methods
+ */
+export interface PrimaryIndexIrShape {
+  pk: { [key: string]: string | number };
+  sk: { [key: string]: string | number } | never;
+}
+
+/**
+ * SecondaryIndex field types and query methods
  */
-export type SecondaryIndexIrShape = {
+export interface SecondaryIndexIrShape extends PrimaryIndexIrShape {
   defaultQueryFieldSuffix: string;
   queryField: string;
-  pk: { [key: string]: string | number };
-  sk: { [key: string]: string | number };
-};
+}
 
 type IndexQueryMethodsFromIR<
   SecondaryIdxTuple extends SecondaryIndexIrShape[],
@@ -911,6 +919,35 @@ type IndexQueryMethodsFromIR<
     >
   : Res;
 
+type ListPkOptions<
+  ModelMeta extends ModelMetaShape,
+  Enums extends Record<string, string>,
+> = ModelMeta['identifier']['sk'] extends never
+  ? unknown
+  : Prettify<
+      Partial<IndexQueryInput<ModelMeta['identifier'], Enums>> & {
+        sortDirection?: ModelSortDirection;
+      }
+    >;
+
+/**
+ * Accepts a PrimaryIndexIr or SecondaryIndexIr and returns resolved parameters
+ */
+type IndexQueryInput<
+  Idx extends PrimaryIndexIrShape,
+  Enums extends Record<string, string>,
+> = {
+  [PKField in keyof Idx['pk']]: Idx['pk'][PKField] extends `${deferredRefResolvingPrefix}${infer R}`
+    ? Enums[R]
+    : Idx['pk'][PKField];
+} & {
+  [SKField in keyof Idx['sk']]+?: number extends Idx['sk'][SKField]
+    ? NumericFilter
+    : Idx['sk'][SKField] extends `${deferredRefResolvingPrefix}${infer R}`
+      ? StringFilter<Enums[R]>
+      : StringFilter<Idx['sk'][SKField] & string>;
+};
+
 type IndexQueryMethodSignature<
   Idx extends SecondaryIndexIrShape,
   ModelName extends string,
@@ -924,17 +961,7 @@ type IndexQueryMethodSignature<
     FlatModel extends Record<string, unknown> = ResolvedModel<Model>,
     SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[],
   >(
-    input: {
-      [PKField in keyof Idx['pk']]: Idx['pk'][PKField] extends `${deferredRefResolvingPrefix}${infer R}`
-        ? Enums[R]
-        : Idx['pk'][PKField];
-    } & {
-      [SKField in keyof Idx['sk']]+?: number extends Idx['sk'][SKField]
-        ? NumericFilter
-        : Idx['sk'][SKField] extends `${deferredRefResolvingPrefix}${infer R}`
-          ? StringFilter<Enums[R]>
-          : StringFilter<Idx['sk'][SKField] & string>;
-    },
+    input: IndexQueryInput<Idx, Enums>,
     options?: {
       filter?: ModelFilter<Model>;
       sortDirection?: ModelSortDirection;

package/dist/cjs/MappedTypes/MapSecondaryIndexes.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"MapSecondaryIndexes.js","sources":["../../../src/MappedTypes/MapSecondaryIndexes.ts"],"sourcesContent":["\"use strict\";\nObject.defineProperty(exports, \"__esModule\", { value: true });\n"],"names":[],"mappings":";;AACA,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;;"}

package/dist/esm/MappedTypes/MapSecondaryIndexes.mjs

@@ -1,2 +0,0 @@
-
-//# sourceMappingURL=MapSecondaryIndexes.mjs.map

package/dist/esm/MappedTypes/MapSecondaryIndexes.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"MapSecondaryIndexes.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":""}