@aws-amplify/data-schema 0.18.4 → 1.0.1

package/package.json

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

package/src/CustomOperation.ts

@@ -34,8 +34,6 @@ type SubscriptionSource = RefType<any, any>;
 type InternalSubscriptionSource = InternalRef;
 
 type CustomReturnType = RefType<any> | CustomType<any>;
-type CustomFunctionRefType = string; // extend to include reference
-
 type InternalCustomArguments = Record<string, InternalField>;
 type InternalCustomReturnType = InternalRef;
 type HandlerInputType = FunctionHandler[] | CustomHandler[] | Handler;
@@ -50,7 +48,6 @@ type CustomOperationName = (typeof CustomOperationNames)[number];
 type CustomData = {
   arguments: CustomArguments;
   returnType: CustomReturnType | null;
-  functionRef: string | null; // extend to include reference
   authorization: Authorization<any, any, any>[];
   typeName: CustomOperationName;
   handlers: Handler[] | null;
@@ -60,7 +57,6 @@ type CustomData = {
 type InternalCustomData = CustomData & {
   arguments: InternalCustomArguments;
   returnType: InternalCustomReturnType;
-  functionRef: string | null;
   subscriptionSource: InternalSubscriptionSource[];
   authorization: Authorization<any, any, any>[];
 };
@@ -68,7 +64,6 @@ type InternalCustomData = CustomData & {
 export type CustomOperationParamShape = {
   arguments: CustomArguments | null;
   returnType: CustomReturnType | null;
-  functionRef: string | null;
   authorization: Authorization<any, any, any>[];
   typeName: CustomOperationName;
   handlers: Handler | null;
@@ -94,21 +89,6 @@ export type CustomOperation<
       K | 'returns',
       B
     >;
-    /**
-     *
-     * @deprecated
-     * `.function` should no longer be used and will be removed
-     * in the next minor version of this package.
-     *
-     * Use `.handler(a.handler.function())` instead
-     */
-    function<FunctionRef extends CustomFunctionRefType>(
-      functionRefOrName: FunctionRef,
-    ): CustomOperation<
-      SetTypeSubArg<T, 'functionRef', FunctionRef>,
-      K | 'function',
-      B
-    >;
     authorization<AuthRuleType extends Authorization<any, any, any>>(
       callback: (
         allow: AllowModifierForCustomOperation,
@@ -165,7 +145,6 @@ function _custom<
   const data: CustomData = {
     arguments: {},
     returnType: null,
-    functionRef: null,
     authorization: [],
     typeName: typeName,
     handlers: null,
@@ -184,11 +163,6 @@ function _custom<
 
         return this;
       },
-      function(functionRefOrName: CustomFunctionRefType) {
-        data.functionRef = functionRefOrName;
-
-        return this;
-      },
       authorization<AuthRuleType extends Authorization<any, any, any>>(
         callback: (
           allow: AllowModifierForCustomOperation,
@@ -232,7 +206,6 @@ export function query(): CustomOperation<
   {
     arguments: null;
     returnType: null;
-    functionRef: null;
     authorization: [];
     typeName: 'Query';
     handlers: null;
@@ -253,7 +226,6 @@ export function mutation(): CustomOperation<
   {
     arguments: null;
     returnType: null;
-    functionRef: null;
     authorization: [];
     typeName: 'Mutation';
     handlers: null;
@@ -274,7 +246,6 @@ export function subscription(): CustomOperation<
   {
     arguments: null;
     returnType: null;
-    functionRef: null;
     authorization: [];
     typeName: 'Subscription';
     handlers: null;

package/src/MappedTypes/CustomOperations.ts

@@ -36,7 +36,6 @@ export type ResolveCustomOperations<
         NonModelTypes,
         CustomOperations
       >;
-      functionRef: CustomOperations[OpName]['functionRef'];
       typeName: CustomOperations[OpName]['typeName'];
       authorization: CustomOperations[OpName]['authorization'];
     };

package/src/ModelRelationalField.ts

@@ -59,15 +59,6 @@ type ModelRelationalFieldFunctions<
     SetTypeSubArg<T, 'arrayRequired', true>,
     K | 'required'
   >;
-  /**
-   * When set, it requires the relationship to always return an array value
-   * @deprecated this modifier should not be used and will be removed
-   * in the next minor version of this package.
-   */
-  arrayRequired(): ModelRelationalField<
-    SetTypeSubArg<T, 'arrayRequired', true>,
-    K | 'arrayRequired'
-  >;
   /**
    * Configures field-level authorization rules. Pass in an array of authorizations `(a.allow.____)` to mix and match
    * multiple authorization rules for this field.
@@ -102,7 +93,6 @@ export type InternalRelationalField = ModelRelationalField<
 
 const relationalModifiers = [
   'required',
-  'arrayRequired',
   'valueRequired',
   'authorization',
 ] as const;
@@ -112,18 +102,18 @@ const relationModifierMap: Record<
   (typeof relationalModifiers)[number][]
 > = {
   belongsTo: ['authorization'],
-  hasMany: ['arrayRequired', 'valueRequired', 'authorization'],
+  hasMany: ['valueRequired', 'authorization'],
   hasOne: ['required', 'authorization'],
 };
 
 export type RelationTypeFunctionOmitMapping<
   Type extends ModelRelationshipTypes,
 > = Type extends ModelRelationshipTypes.belongsTo
-  ? 'required' | 'arrayRequired' | 'valueRequired'
+  ? 'required' | 'valueRequired'
   : Type extends ModelRelationshipTypes.hasMany
     ? 'required'
     : Type extends ModelRelationshipTypes.hasOne
-      ? 'arrayRequired' | 'valueRequired'
+      ? 'valueRequired'
       : never;
 
 function _modelRelationalField<
@@ -149,11 +139,6 @@ function _modelRelationalField<
 
       return this;
     },
-    arrayRequired() {
-      data.arrayRequired = true;
-
-      return this;
-    },
     valueRequired() {
       data.valueRequired = true;
 

package/src/ModelSchema.ts

@@ -46,6 +46,8 @@ type SchemaContent =
   | EnumType<EnumTypeParamShape>
   | CustomOperation<CustomOperationParamShape, any>;
 
+type NonEmpty<T> = keyof T extends never ? never : T;
+
 type ModelSchemaContents = Record<string, SchemaContent>;
 type InternalSchemaModels = Record<
   string,
@@ -383,7 +385,7 @@ type SchemaReturnType<
 function bindConfigToSchema<DE extends DatasourceEngine>(
   config: SchemaConfiguration<DE, DataSourceConfiguration<DE>>,
 ): <Types extends ModelSchemaContents>(
-  types: Types,
+  types: NonEmpty<Types>,
 ) => SchemaReturnType<DE, Types> {
   return (types) => {
     return (
@@ -414,7 +416,7 @@ export function configure<DE extends DatasourceEngine>(
   config: SchemaConfiguration<DE, DataSourceConfiguration<DE>>,
 ): {
   schema: <Types extends ModelSchemaContents>(
-    types: Types,
+    types: NonEmpty<Types>,
   ) => SchemaReturnType<DE, Types>;
 } {
   return {

package/src/SchemaProcessor.ts

@@ -304,7 +304,6 @@ function customOperationToGql(
     arguments: fieldArgs,
     typeName: opType,
     returnType,
-    functionRef,
     handlers,
     subscriptionSource,
   } = typeDef.data;
@@ -390,8 +389,6 @@ function customOperationToGql(
       handlers,
       typeName,
     ));
-  } else if (functionRef) {
-    gqlHandlerContent = `@function(name: "${functionRef}") `;
   } else if (databaseType === 'sql' && handler && brand === 'inlineSql') {
     gqlHandlerContent = `@sql(statement: ${escapeGraphQlString(
       String(getHandlerData(handler)),
@@ -555,6 +552,32 @@ function validateImpliedFields(
   }
 }
 
+function validateRefUseCases(
+  referrerName: string,
+  referrerType: 'customType' | 'model',
+  fields: Record<string, any>,
+  getRefType: ReturnType<typeof getRefTypeForSchema>,
+) {
+  const check = (fieldName: string, refLink: string, targetType: string) => {
+    const { def } = getRefType(refLink, referrerName);
+    if (isInternalModel(def)) {
+      throw new Error(
+        `Cannot use \`.ref()\` to refer a model from a \`${targetType}\`. Field \`${fieldName}\` of \`${referrerName}\` refers to model \`${refLink}\``,
+      );
+    }
+  };
+
+  for (const [fieldName, field] of Object.entries(fields)) {
+    if (isRefField(field)) {
+      check(
+        fieldName,
+        field.data.link,
+        referrerType === 'customType' ? 'custom type' : 'model',
+      );
+    }
+  }
+}
+
 /**
  * Given a list of authorization rules, produces a set of the implied owner and/or
  * group fields, along with the associated graphql `@auth` string directive.
@@ -1075,6 +1098,9 @@ const schemaPreprocessor = (
         gqlModels.push(enumType);
       } else if (isCustomType(typeDef)) {
         const fields = typeDef.data.fields;
+
+        validateRefUseCases(typeName, 'customType', fields, getRefType);
+
         const fieldAuthApplicableFields = Object.fromEntries(
           Object.entries(fields).filter(
             (
@@ -1159,6 +1185,9 @@ const schemaPreprocessor = (
         string,
         ModelField<any, any>
       >;
+
+      validateRefUseCases(typeName, 'model', fields, getRefType);
+
       const identifier = typeDef.data.identifier;
       const [partitionKey] = identifier;
 
@@ -1200,6 +1229,9 @@ const schemaPreprocessor = (
         string,
         ModelField<any, any>
       >;
+
+      validateRefUseCases(typeName, 'model', fields, getRefType);
+
       const identifier = typeDef.data.identifier;
       const [partitionKey] = identifier;
 
@@ -1266,15 +1298,9 @@ function validateCustomOperations(
   authRules: Authorization<any, any, any>[],
   getRefType: ReturnType<typeof getRefTypeForSchema>,
 ) {
-  const {
-    functionRef,
-    handlers,
-    typeName: opType,
-    subscriptionSource,
-  } = typeDef.data;
+  const { handlers, typeName: opType, subscriptionSource } = typeDef.data;
 
-  // TODO: remove `functionRef` after deprecating
-  const handlerConfigured = functionRef !== null || handlers?.length;
+  const handlerConfigured = handlers?.length;
   const authConfigured = authRules.length > 0;
 
   if (