@aws-amplify/data-schema 1.10.2 → 1.12.0

package/dist/cjs/SchemaProcessor.js

@@ -69,6 +69,9 @@ function isScalarField(field) {
 function isRefField(field) {
     return isRefFieldDef(field?.data);
 }
+function canGenerateFieldType(fieldType) {
+    return fieldType === 'Int';
+}
 function scalarFieldToGql(fieldDef, identifier, secondaryIndexes = []) {
     const { fieldType, required, array, arrayRequired, default: _default, } = fieldDef;
     let field = fieldType;
@@ -86,6 +89,9 @@ function scalarFieldToGql(fieldDef, identifier, secondaryIndexes = []) {
         for (const index of secondaryIndexes) {
             field += ` ${index}`;
         }
+        if (_default === ModelField_1.__generated) {
+            field += ` @default`;
+        }
         return field;
     }
     if (required === true) {
@@ -614,12 +620,40 @@ function processFieldLevelAuthRules(fields, authFields) {
     }
     return fieldLevelAuthRules;
 }
-function processFields(typeName, fields, impliedFields, fieldLevelAuthRules, identifier, partitionKey, secondaryIndexes = {}) {
+function validateDBGeneration(fields, databaseEngine) {
+    for (const [fieldName, fieldDef] of Object.entries(fields)) {
+        const _default = fieldDef.data?.default;
+        const fieldType = fieldDef.data?.fieldType;
+        const isGenerated = _default === ModelField_1.__generated;
+        if (isGenerated && databaseEngine !== 'postgresql') {
+            throw new Error(`Invalid field definition for ${fieldName}. DB-generated fields are only supported with PostgreSQL data sources.`);
+        }
+        if (isGenerated && !canGenerateFieldType(fieldType)) {
+            throw new Error(`Incompatible field type. Field type ${fieldType} in field ${fieldName} cannot be configured as a DB-generated field.`);
+        }
+    }
+}
+function validateNullableIdentifiers(fields, identifier) {
+    for (const [fieldName, fieldDef] of Object.entries(fields)) {
+        const fieldType = fieldDef.data?.fieldType;
+        const required = fieldDef.data?.required;
+        const _default = fieldDef.data?.default;
+        const isGenerated = _default === ModelField_1.__generated;
+        if (identifier !== undefined && identifier.includes(fieldName)) {
+            if (!required && fieldType !== 'ID' && !isGenerated) {
+                throw new Error(`Invalid identifier definition. Field ${fieldName} cannot be used in the identifier. Identifiers must reference required or DB-generated fields)`);
+            }
+        }
+    }
+}
+function processFields(typeName, fields, impliedFields, fieldLevelAuthRules, identifier, partitionKey, secondaryIndexes = {}, databaseEngine = 'dynamodb') {
     const gqlFields = [];
     // stores nested, field-level type definitions (custom types and enums)
     // the need to be hoisted to top-level schema types and processed accordingly
     const implicitTypes = [];
     validateImpliedFields(fields, impliedFields);
+    validateDBGeneration(fields, databaseEngine);
+    validateNullableIdentifiers(fields, identifier);
     for (const [fieldName, fieldDef] of Object.entries(fields)) {
         const fieldAuth = fieldLevelAuthRules[fieldName]
             ? ` ${fieldLevelAuthRules[fieldName]}`
@@ -834,7 +868,8 @@ const schemaPreprocessor = (schema) => {
     const jsFunctions = [];
     const lambdaFunctions = {};
     const customSqlDataSourceStrategies = [];
-    const databaseType = schema.data.configuration.database.engine === 'dynamodb'
+    const databaseEngine = schema.data.configuration.database.engine;
+    const databaseType = databaseEngine === 'dynamodb'
         ? 'dynamodb'
         : 'sql';
     const staticSchema = databaseType === 'sql';
@@ -877,7 +912,7 @@ const schemaPreprocessor = (schema) => {
                 }
                 const authFields = {};
                 const fieldLevelAuthRules = processFieldLevelAuthRules(fieldAuthApplicableFields, authFields);
-                const { gqlFields, implicitTypes } = processFields(typeName, fields, authFields, fieldLevelAuthRules);
+                const { gqlFields, implicitTypes } = processFields(typeName, fields, authFields, fieldLevelAuthRules, undefined, undefined, undefined, databaseEngine);
                 topLevelTypes.push(...implicitTypes);
                 const joined = gqlFields.join('\n  ');
                 const model = `type ${typeName} ${customAuth}\n{\n  ${joined}\n}`;
@@ -934,7 +969,7 @@ const schemaPreprocessor = (schema) => {
             const { authString, authFields } = calculateAuth(mostRelevantAuthRules);
             const fieldLevelAuthRules = processFieldLevelAuthRules(fields, authFields);
             validateStaticFields(fields, authFields);
-            const { gqlFields, implicitTypes } = processFields(typeName, fields, authFields, fieldLevelAuthRules, identifier, partitionKey);
+            const { gqlFields, implicitTypes } = processFields(typeName, fields, authFields, fieldLevelAuthRules, identifier, partitionKey, undefined, databaseEngine);
             topLevelTypes.push(...implicitTypes);
             const joined = gqlFields.join('\n  ');
             const refersToString = typeDef.data.originalName
@@ -968,7 +1003,7 @@ const schemaPreprocessor = (schema) => {
             };
             validateRelationships(typeName, fields, getInternalModel);
             const fieldLevelAuthRules = processFieldLevelAuthRules(fields, authFields);
-            const { gqlFields, implicitTypes } = processFields(typeName, fields, authFields, fieldLevelAuthRules, identifier, partitionKey, transformedSecondaryIndexes);
+            const { gqlFields, implicitTypes } = processFields(typeName, fields, authFields, fieldLevelAuthRules, identifier, partitionKey, transformedSecondaryIndexes, databaseEngine);
             topLevelTypes.push(...implicitTypes);
             const joined = gqlFields.join('\n  ');
             const modelAttrs = modelAttributesFromDisabledOps(typeDef.data.disabledOperations);