@aws-amplify/data-schema 1.10.2 → 1.11.0

package/dist/esm/ModelType.d.ts

@@ -51,8 +51,8 @@ export type ModelTypeParamShape = {
  * indicator string, and resolve its corresponding type later in
  * packages/data-schema/src/runtime/client/index.ts
  */
-export type ExtractSecondaryIndexIRFields<T extends ModelTypeParamShape, RequiredOnly extends boolean = false> = {
-    [FieldProp in keyof T['fields'] as T['fields'][FieldProp] extends BaseModelField<infer R> ? NonNullable<R> extends string | number ? RequiredOnly extends false ? FieldProp : null extends R ? never : FieldProp : never : T['fields'][FieldProp] extends EnumType | RefType<RefTypeParamShape, any, any> ? FieldProp : never]: T['fields'][FieldProp] extends BaseModelField<infer R> ? R : T['fields'][FieldProp] extends EnumType<infer values> ? values[number] : T['fields'][FieldProp] extends RefType<infer R, any, any> ? `${deferredRefResolvingPrefix}${R['link']}` : never;
+export type ExtractSecondaryIndexIRFields<T extends ModelTypeParamShape> = {
+    [FieldProp in keyof T['fields'] as T['fields'][FieldProp] extends BaseModelField<infer R> ? NonNullable<R> extends string | number ? FieldProp : never : T['fields'][FieldProp] extends EnumType | RefType<RefTypeParamShape, any, any> ? FieldProp : never]: T['fields'][FieldProp] extends BaseModelField<infer R> ? R : T['fields'][FieldProp] extends EnumType<infer values> ? values[number] : T['fields'][FieldProp] extends RefType<infer R, any, any> ? `${deferredRefResolvingPrefix}${R['link']}` : never;
 };
 export type AddRelationshipFieldsToModelTypeFields<Model, RelationshipFields extends Record<string, ModelRelationshipField<ModelRelationshipFieldParamShape, string, any, any>>> = Model extends ModelType<infer ModelParam extends ModelTypeParamShape, infer HiddenKeys> ? ModelType<SetTypeSubArg<ModelParam, 'fields', ModelParam['fields'] & RelationshipFields>, HiddenKeys> : never;
 export type BaseModelType<T extends ModelTypeParamShape = ModelTypeParamShape> = ModelType<T, UsableModelTypeKey>;
@@ -65,7 +65,7 @@ export type UsableModelTypeKey = methodKeyOf<ModelType>;
  */
 export type ModelType<T extends ModelTypeParamShape = ModelTypeParamShape, UsedMethod extends UsableModelTypeKey = never> = Omit<{
     [brandSymbol]: typeof brandName;
-    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', PrimaryIndexIR>, UsedMethod | 'identifier'>;
+    identifier<PrimaryIndexFields = ExtractSecondaryIndexIRFields<T>, 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', PrimaryIndexIR>, UsedMethod | 'identifier'>;
     secondaryIndexes<const SecondaryIndexFields = ExtractSecondaryIndexIRFields<T>, const SecondaryIndexPKPool extends string = keyof SecondaryIndexFields & string, const Indexes extends readonly ModelIndexType<string, string, unknown, readonly [], any>[] = readonly [], const IndexesIR extends readonly any[] = SecondaryIndexToIR<Indexes, SecondaryIndexFields>>(callback: (index: <PK extends SecondaryIndexPKPool>(pk: PK) => ModelIndexType<SecondaryIndexPKPool, PK, ReadonlyArray<Exclude<SecondaryIndexPKPool, PK>>>) => Indexes): ModelType<SetTypeSubArg<T, 'secondaryIndexes', IndexesIR>, UsedMethod | 'secondaryIndexes'>;
     disableOperations<const Ops extends ReadonlyArray<DisableOperationsOptions>>(ops: Ops): ModelType<SetTypeSubArg<T, 'disabledOperations', Ops>, UsedMethod | 'disableOperations'>;
     authorization<AuthRuleType extends Authorization<any, any, any>>(callback: (allow: Omit<AllowModifier, 'resource'>) => AuthRuleType | AuthRuleType[]): ModelType<SetTypeSubArg<T, 'authorization', AuthRuleType[]>, UsedMethod | 'authorization'>;

package/dist/esm/SchemaProcessor.mjs

@@ -64,6 +64,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;
@@ -81,6 +84,9 @@ function scalarFieldToGql(fieldDef, identifier, secondaryIndexes = []) {
         for (const index of secondaryIndexes) {
             field += ` ${index}`;
         }
+        if (_default === __generated) {
+            field += ` @default`;
+        }
         return field;
     }
     if (required === true) {
@@ -609,12 +615,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 === __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 === __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]}`
@@ -829,7 +863,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';
@@ -872,7 +907,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}`;
@@ -929,7 +964,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
@@ -963,7 +998,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);