@aws-amplify/data-schema 1.1.3 → 1.1.5

package/dist/esm/runtime/client/index.d.ts

@@ -161,7 +161,7 @@ export type ResolvedModel<Model extends Record<string, unknown>, Depth extends n
     };
 }[Depth extends -1 ? 'done' : 'recur'];
 export type SelectionSet<Model extends Record<string, unknown>, Path extends ReadonlyArray<ModelPath<FlatModel>>, FlatModel extends Record<string, unknown> = ResolvedModel<Model>> = CustomSelectionSetReturnValue<FlatModel, Path[number]>;
-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 : 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;
 type WritableKeys<T> = {
     [P in keyof T]-?: IfEquals<{
@@ -179,7 +179,7 @@ type MutationInput<Fields, WritableFields = Pick<Fields, WritableKeys<Fields>>>
 /**
  * All identifiers and fields used to create a model
  */
-type CreateModelInput<Model extends Record<string, unknown>, ModelMeta extends Record<string, unknown>> = Equal<ModelIdentifier<ModelMeta>, {
+type CreateModelInput<Model extends Record<string, unknown>, ModelMeta extends ModelMetaShape> = Equal<ModelIdentifier<ModelMeta>, {
     id: string;
 }> extends true ? Partial<ModelIdentifier<ModelMeta>> & Omit<MutationInput<Model>, 'id'> : MutationInput<Model>;
 /**
@@ -324,7 +324,7 @@ type ModelFilter<Model extends Record<any, any>> = LogicalFilters<Model> & {
 export type ModelSortDirection = 'ASC' | 'DESC';
 type ModelMetaShape = {
     secondaryIndexes: SecondaryIndexIrShape[];
-    identifier: string;
+    identifier: PrimaryIndexIrShape;
 };
 export type ModelTypesClient<ModelName extends string, Model extends Record<string, unknown>, ModelMeta extends ModelMetaShape, Enums extends Record<string, string>, FlatModel extends Record<string, unknown> = ResolvedModel<Model>> = IndexQueryMethodsFromIR<ModelMeta['secondaryIndexes'], ModelName, Model, Enums> & {
     create: (model: Prettify<CreateModelInput<Model, ModelMeta>>, options?: {
@@ -348,9 +348,8 @@ export type ModelTypesClient<ModelName extends string, Model extends Record<stri
         authToken?: string;
         headers?: CustomHeaders;
     }): SingularReturnValue<Prettify<ReturnValue<Model, FlatModel, SelectionSet>>>;
-    list<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(options?: Partial<ModelIdentifier<ModelMeta>> & {
+    list<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(options?: ListPkOptions<ModelMeta, Enums> & {
         filter?: ModelFilter<Model>;
-        sortDirection?: ModelSortDirection;
         limit?: number;
         nextToken?: string | null;
         selectionSet?: SelectionSet;
@@ -408,7 +407,7 @@ type ModelTypesSSRCookies<ModelName extends string, Model extends Record<string,
         authToken?: string;
         headers?: CustomHeaders;
     }): SingularReturnValue<Prettify<ReturnValue<Model, FlatModel, SelectionSet>>>;
-    list<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(options?: Partial<ModelIdentifier<ModelMeta>> & {
+    list<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(options?: ListPkOptions<ModelMeta, Enums> & {
         filter?: ModelFilter<Model>;
         sortDirection?: ModelSortDirection;
         limit?: number;
@@ -441,7 +440,7 @@ type ModelTypesSSRRequest<ModelName extends string, Model extends Record<string,
         authToken?: string;
         headers?: CustomHeaders;
     }): SingularReturnValue<Prettify<ReturnValue<Model, FlatModel, SelectionSet>>>;
-    list<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(contextSpec: any, options?: Partial<ModelIdentifier<ModelMeta>> & {
+    list<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(contextSpec: any, options?: ListPkOptions<ModelMeta, Enums> & {
         filter?: ModelFilter<Model>;
         sortDirection?: ModelSortDirection;
         limit?: number;
@@ -516,27 +515,39 @@ export type RequestOptions = {
  */
 export type CustomHeaders = Record<string, string> | ((requestOptions?: RequestOptions) => Promise<Record<string, string>>);
 /**
- * SecondaryIndex index types and query methods
+ * PrimaryIndex field types and query methods
  */
-export type SecondaryIndexIrShape = {
-    defaultQueryFieldSuffix: string;
-    queryField: string;
+export interface PrimaryIndexIrShape {
     pk: {
         [key: string]: string | number;
     };
     sk: {
         [key: string]: string | number;
-    };
-};
+    } | never;
+}
+/**
+ * SecondaryIndex field types and query methods
+ */
+export interface SecondaryIndexIrShape extends PrimaryIndexIrShape {
+    defaultQueryFieldSuffix: string;
+    queryField: string;
+}
 type IndexQueryMethodsFromIR<SecondaryIdxTuple extends SecondaryIndexIrShape[], ModelName extends string, Model extends Record<string, unknown>, Enums extends Record<string, string>, Res = unknown> = SecondaryIdxTuple extends [
     infer A extends SecondaryIndexIrShape,
     ...infer B extends SecondaryIndexIrShape[]
 ] ? IndexQueryMethodsFromIR<B, ModelName, Model, Enums, IndexQueryMethodSignature<A, ModelName, Model, Enums> & Res> : Res;
-type IndexQueryMethodSignature<Idx extends SecondaryIndexIrShape, ModelName extends string, Model extends Record<string, unknown>, Enums extends Record<string, 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[]>(input: {
+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>;
-}, options?: {
+};
+type IndexQueryMethodSignature<Idx extends SecondaryIndexIrShape, ModelName extends string, Model extends Record<string, unknown>, Enums extends Record<string, 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[]>(input: IndexQueryInput<Idx, Enums>, options?: {
     filter?: ModelFilter<Model>;
     sortDirection?: ModelSortDirection;
     limit?: number;