@aws-amplify/data-schema 1.3.6 → 1.3.8

package/package.json

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

package/src/ClientSchema/Core/ClientCustomOperations.ts

@@ -6,6 +6,7 @@ import type { AppSyncResolverHandler } from 'aws-lambda';
 import type { CustomType } from '../../CustomType';
 import type { FieldTypesOfCustomType } from '../../MappedTypes/ResolveSchema';
 import type { ResolveRef } from '../utilities/ResolveRef';
+import type { EnumType } from '../../EnumType';
 import { ClientSchemaProperty } from './ClientSchemaProperty';
 
 type CustomOperationSubType<Op extends CustomOperationParamShape> =
@@ -83,7 +84,9 @@ type CustomOpArguments<Shape extends CustomOperationParamShape> =
           infer R
         >
           ? R
-          : never;
+          : Shape['arguments'][FieldName] extends EnumType<infer Values>
+            ? Values[number] | null
+            : never;
       }>;
 
 /**

package/src/SchemaProcessor.ts

@@ -398,14 +398,14 @@ function customOperationToGql(
   }
 
   if (Object.keys(fieldArgs).length > 0) {
-    const { gqlFields, implicitTypes } = processFields(
+    const { gqlFields, implicitTypes: implied } = processFields(
       typeName,
       fieldArgs,
       {},
       {},
     );
     callSignature += `(${gqlFields.join(', ')})`;
-    implicitTypes.push(...implicitTypes);
+    implicitTypes.push(...implied);
   }
 
   const handler = handlers && handlers[0];

package/src/runtime/client/index.ts

@@ -19,6 +19,7 @@ import type {
   NumericFilter,
   BooleanFilters,
 } from '../../util';
+import { AmplifyServer } from '../bridge-types';
 
 // temporarily export symbols from `data-schema-types` because in case part of the
 // problem with the runtime -> data-schema migration comes down to a mismatch
@@ -434,33 +435,51 @@ interface ClientSecondaryIndexField {
 
 type IndexQueryMethods<
   Model extends ClientSchemaByEntityTypeBaseShape['models'][string],
+  Context extends ContextType = 'CLIENT',
 > = {
   [K in keyof Select<
     Model['secondaryIndexes'],
     ClientSecondaryIndexField
   >]: IndexQueryMethod<
     Model,
-    Select<Model['secondaryIndexes'], ClientSecondaryIndexField>[K]
+    Select<Model['secondaryIndexes'], ClientSecondaryIndexField>[K],
+    Context
   >;
 };
 
 type IndexQueryMethod<
   Model extends ClientSchemaByEntityTypeBaseShape['models'][string],
   Method extends ClientSecondaryIndexField,
+  Context extends ContextType = 'CLIENT',
   FlatModel extends Record<string, unknown> = ResolvedModel<Model['type']>,
-> = <SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(
-  input: Method['input'],
-  options?: {
-    filter?: ModelFilter<Model>;
-    sortDirection?: ModelSortDirection;
-    limit?: number;
-    nextToken?: string | null;
-    selectionSet?: SelectionSet;
-    authMode?: AuthMode;
-    authToken?: string;
-    headers?: CustomHeaders;
-  },
-) => ListReturnValue<Prettify<ReturnValue<Model, FlatModel, SelectionSet>>>;
+> = Context extends 'CLIENT' | 'COOKIES'
+  ? <SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(
+      input: Method['input'],
+      options?: {
+        filter?: ModelFilter<Model>;
+        sortDirection?: ModelSortDirection;
+        limit?: number;
+        nextToken?: string | null;
+        selectionSet?: SelectionSet;
+        authMode?: AuthMode;
+        authToken?: string;
+        headers?: CustomHeaders;
+      },
+    ) => ListReturnValue<Prettify<ReturnValue<Model, FlatModel, SelectionSet>>>
+  : <SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(
+      contextSpec: AmplifyServer.ContextSpec,
+      input: Method['input'],
+      options?: {
+        filter?: ModelFilter<Model>;
+        sortDirection?: ModelSortDirection;
+        limit?: number;
+        nextToken?: string | null;
+        selectionSet?: SelectionSet;
+        authMode?: AuthMode;
+        authToken?: string;
+        headers?: CustomHeaders;
+      },
+    ) => ListReturnValue<Prettify<ReturnValue<Model, FlatModel, SelectionSet>>>;
 
 type ModelTypesClient<
   Model extends ClientSchemaByEntityTypeBaseShape['models'][string],
@@ -609,10 +628,9 @@ type ModelTypesSSRCookies<
 type ModelTypesSSRRequest<
   Model extends ClientSchemaByEntityTypeBaseShape['models'][string],
   FlatModel extends Record<string, unknown> = ResolvedModel<Model['type']>,
-> = IndexQueryMethods<Model> & {
+> = IndexQueryMethods<Model, 'REQUEST'> & {
   create: (
-    // TODO: actual type
-    contextSpec: any,
+    contextSpec: AmplifyServer.ContextSpec,
     model: Model['createType'],
     options?: {
       authMode?: AuthMode;
@@ -621,7 +639,7 @@ type ModelTypesSSRRequest<
     },
   ) => SingularReturnValue<Model['type']>;
   update: (
-    contextSpec: any,
+    contextSpec: AmplifyServer.ContextSpec,
     model: Model['updateType'],
     options?: {
       authMode?: AuthMode;
@@ -630,7 +648,7 @@ type ModelTypesSSRRequest<
     },
   ) => SingularReturnValue<Model['type']>;
   delete: (
-    contextSpec: any,
+    contextSpec: AmplifyServer.ContextSpec,
     identifier: Model['deleteType'],
     options?: {
       authMode?: AuthMode;
@@ -639,7 +657,7 @@ type ModelTypesSSRRequest<
     },
   ) => SingularReturnValue<Model['type']>;
   get<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(
-    contextSpec: any,
+    contextSpec: AmplifyServer.ContextSpec,
     identifier: Model['identifier'],
     options?: {
       selectionSet?: SelectionSet;
@@ -649,7 +667,7 @@ type ModelTypesSSRRequest<
     },
   ): SingularReturnValue<Prettify<ReturnValue<Model, FlatModel, SelectionSet>>>;
   list<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(
-    contextSpec: any,
+    contextSpec: AmplifyServer.ContextSpec,
     options?: ListCpkOptions<Model> & {
       filter?: ModelFilter<Model>;
       sortDirection?: ModelSortDirection;
@@ -731,7 +749,7 @@ export type CustomOperations<
       ...params: CustomOperationFnParams<OperationDefs[OpName]['args']>
     ) => SingularReturnValue<OperationDefs[OpName]['type']>;
     REQUEST: (
-      contextSpec: any,
+      contextSpec: AmplifyServer.ContextSpec,
       ...params: CustomOperationFnParams<OperationDefs[OpName]['args']>
     ) => SingularReturnValue<OperationDefs[OpName]['type']>;
   }[Context];

package/src/runtime/internals/operations/custom.ts

@@ -191,6 +191,21 @@ function hasStringField<Field extends string>(
   return typeof o[field] === 'string';
 }
 
+/**
+ * @param argDef A single argument definition from a custom operation
+ * @returns A string naming the base type including the `!` if the arg is required.
+ */
+function argumentBaseTypeString(
+  argDef: Exclude<CustomOperation['arguments'], undefined>[number],
+) {
+  const requiredFlag = argDef.isRequired ? '!' : '';
+  if (argDef.type instanceof Object && 'enum' in argDef.type) {
+    return argDef.type.enum + requiredFlag;
+  } else {
+    return argDef.type + requiredFlag;
+  }
+}
+
 /**
  * Generates "outer" arguments string for a custom operation. For example,
  * in this operation:
@@ -216,7 +231,7 @@ function outerArguments(operation: CustomOperation): string {
   }
   const args = Object.entries(operation.arguments)
     .map(([k, v]) => {
-      const baseType = v.type + (v.isRequired ? '!' : '');
+      const baseType = argumentBaseTypeString(v);
       const finalType = v.isArray
         ? `[${baseType}]${v.isArrayNullable ? '' : '!'}`
         : baseType;
@@ -261,7 +276,7 @@ function innerArguments(operation: CustomOperation): string {
 /**
  * Generates the selection set string for a custom operation. This is slightly
  * different than the selection set generation for models. If the custom op returns
- * a primitive or enum types, it doen't require a selection set at all.
+ * a primitive or enum types, it doesn't require a selection set at all.
  *
  * E.g., the graphql might look like this:
  *

package/src/runtime/internals/server/generateModelsProperty.ts

@@ -86,6 +86,7 @@ export function generateModelsProperty<T extends Record<any, any> = never>(
         model,
         idx,
         getInternals,
+        useContext,
       );
     }
   }