@aws-amplify/data-schema 1.10.2 → 1.12.0

package/package.json

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

package/src/ModelType.ts

@@ -97,17 +97,12 @@ export type ModelTypeParamShape = {
  */
 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
+      ? FieldProp
       : never
     : T['fields'][FieldProp] extends
           | EnumType
@@ -230,7 +225,7 @@ export type ModelType<
   {
     [brandSymbol]: typeof brandName;
     identifier<
-      PrimaryIndexFields = ExtractSecondaryIndexIRFields<T, true>,
+      PrimaryIndexFields = ExtractSecondaryIndexIRFields<T>,
       PrimaryIndexPool extends string = keyof PrimaryIndexFields & string,
       const ID extends ReadonlyArray<PrimaryIndexPool> = readonly [],
       const PrimaryIndexIR extends PrimaryIndexIrShape = PrimaryIndexFieldsToIR<

package/src/SchemaProcessor.ts

@@ -27,6 +27,7 @@ import {
   FunctionSchemaAccess,
   LambdaFunctionDefinition,
   CustomSqlDataSourceStrategy,
+  DatasourceEngine,
 } from '@aws-amplify/data-schema-types';
 import type { InternalRef, RefType } from './RefType';
 import type { EnumType } from './EnumType';
@@ -155,6 +156,12 @@ function isRefField(
   return isRefFieldDef((field as any)?.data);
 }
 
+function canGenerateFieldType(
+  fieldType: ModelFieldType
+): boolean {
+  return fieldType === 'Int';
+}
+
 function scalarFieldToGql(
   fieldDef: ScalarFieldDef,
   identifier?: readonly string[],
@@ -169,6 +176,7 @@ function scalarFieldToGql(
   } = fieldDef;
   let field: string = fieldType;
 
+
   if (identifier !== undefined) {
     field += '!';
     if (identifier.length > 1) {
@@ -184,6 +192,10 @@ function scalarFieldToGql(
       field += ` ${index}`;
     }
 
+    if (_default === __generated) {
+      field += ` @default`;
+    }
+
     return field;
   }
 
@@ -918,6 +930,37 @@ function processFieldLevelAuthRules(
   return fieldLevelAuthRules;
 }
 
+function validateDBGeneration(fields: Record<string, any>, databaseEngine: DatasourceEngine) {
+  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: Record<string, any>, identifier?: readonly string[]){
+  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: string,
   fields: Record<string, any>,
@@ -926,6 +969,7 @@ function processFields(
   identifier?: readonly string[],
   partitionKey?: string,
   secondaryIndexes: TransformedSecondaryIndexes = {},
+  databaseEngine: DatasourceEngine = 'dynamodb',
 ) {
   const gqlFields: string[] = [];
   // stores nested, field-level type definitions (custom types and enums)
@@ -933,6 +977,8 @@ function processFields(
   const implicitTypes: [string, any][] = [];
 
   validateImpliedFields(fields, impliedFields);
+  validateDBGeneration(fields, databaseEngine);
+  validateNullableIdentifiers(fields, identifier)
 
   for (const [fieldName, fieldDef] of Object.entries(fields)) {
     const fieldAuth = fieldLevelAuthRules[fieldName]
@@ -1289,8 +1335,9 @@ const schemaPreprocessor = (
   const lambdaFunctions: LambdaFunctionDefinition = {};
   const customSqlDataSourceStrategies: CustomSqlDataSourceStrategy[] = [];
 
+  const databaseEngine = schema.data.configuration.database.engine
   const databaseType =
-    schema.data.configuration.database.engine === 'dynamodb'
+    databaseEngine === 'dynamodb'
       ? 'dynamodb'
       : 'sql';
 
@@ -1373,6 +1420,10 @@ const schemaPreprocessor = (
           fields,
           authFields,
           fieldLevelAuthRules,
+          undefined,
+          undefined,
+          undefined,
+          databaseEngine
         );
 
         topLevelTypes.push(...implicitTypes);
@@ -1484,6 +1535,8 @@ const schemaPreprocessor = (
         fieldLevelAuthRules,
         identifier,
         partitionKey,
+        undefined,
+        databaseEngine,
       );
 
       topLevelTypes.push(...implicitTypes);
@@ -1548,6 +1601,7 @@ const schemaPreprocessor = (
         identifier,
         partitionKey,
         transformedSecondaryIndexes,
+        databaseEngine,
       );
       topLevelTypes.push(...implicitTypes);
 

package/src/ai/ConversationType.ts

@@ -33,6 +33,17 @@ interface ConversationRouteDeleteInput {
   id: string;
 }
 
+interface ConversationRouteCreateInput {
+  metadata?: Record<string, any>;
+  name?: string;
+}
+
+interface ConversationRouteUpdateInput {
+  id: string;
+  metadata?: Record<string, any>;
+  name?: string;
+}
+
 interface ConversationRouteListInput {
   limit?: number;
   nextToken?: string | null;
@@ -44,7 +55,17 @@ export interface ConversationRoute {
    *
    * Creates a {@link Conversation} from the current conversation route.
    */
-  create: () => SingularReturnValue<Conversation>;
+  create: (
+    input?: ConversationRouteCreateInput,
+  ) => SingularReturnValue<Conversation>;
+  /**
+   * @experimental
+   *
+   * Creates a {@link Conversation} from the current conversation route.
+   */
+  update: (
+    input: ConversationRouteUpdateInput,
+  ) => SingularReturnValue<Conversation>;
   /**
    * @experimental
    *
@@ -74,7 +95,9 @@ interface ConversationSendMessageInputObject {
   toolConfiguration?: ToolConfiguration;
 }
 
-export type ConversationSendMessageInput = ConversationSendMessageInputObject | string;
+export type ConversationSendMessageInput =
+  | ConversationSendMessageInputObject
+  | string;
 
 interface ConversationListMessagesInput {
   limit?: number;

package/src/runtime/internals/ai/createUpdateConversationFunction.ts

@@ -0,0 +1,58 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import type { ConversationRoute } from '../../../ai/ConversationType';
+import type { SingularReturnValue } from '../../../runtime/client';
+import {
+  BaseClient,
+  ClientInternalsGetter,
+  ModelIntrospectionSchema,
+  SchemaModel,
+} from '../../bridge-types';
+import { getFactory } from '../operations/get';
+import { convertItemToConversation } from './convertItemToConversation';
+import {
+  AiAction,
+  getCustomUserAgentDetails,
+} from './getCustomUserAgentDetails';
+
+export const createUpdateConversationFunction =
+  (
+    client: BaseClient,
+    modelIntrospection: ModelIntrospectionSchema,
+    conversationRouteName: string,
+    conversationModel: SchemaModel,
+    conversationMessageModel: SchemaModel,
+    getInternals: ClientInternalsGetter,
+  ): ConversationRoute['update'] =>
+  async ({ id, metadata, name }) => {
+    const updateOperation = getFactory(
+      client,
+      modelIntrospection,
+      conversationModel,
+      'UPDATE',
+      getInternals,
+      false,
+      getCustomUserAgentDetails(AiAction.UpdateConversation),
+    ) as (
+      args?: Record<string, any>,
+    ) => SingularReturnValue<Record<string, any>>;
+    const { data, errors } = await updateOperation({ id, metadata, name });
+    return {
+      data: data
+        ? convertItemToConversation(
+            client,
+            modelIntrospection,
+            data?.id,
+            data?.createdAt,
+            data?.updatedAt,
+            conversationRouteName,
+            conversationMessageModel,
+            getInternals,
+            data?.metadata,
+            data?.name,
+          )
+        : data,
+      errors,
+    };
+  };

package/src/runtime/internals/ai/getCustomUserAgentDetails.ts

@@ -26,6 +26,7 @@ export enum AiAction {
   ListMessages = '6',
   OnMessage = '7',
   Generation = '8',
+  UpdateConversation = '9',
 }
 
 export const getCustomUserAgentDetails = (

package/src/runtime/internals/utils/clientProperties/generateConversationsProperty.ts

@@ -12,6 +12,7 @@ import { createCreateConversationFunction } from '../../ai/createCreateConversat
 import { createGetConversationFunction } from '../../ai/createGetConversationFunction';
 import { createListConversationsFunction } from '../../ai/createListConversationsFunction';
 import { createDeleteConversationFunction } from '../../ai/createDeleteConversationFunction';
+import { createUpdateConversationFunction } from '../../ai/createUpdateConversationFunction';
 
 export function generateConversationsProperty(
   client: BaseClient,
@@ -61,6 +62,14 @@ export function generateConversationsProperty(
     };
 
     conversations[name] = {
+      update: createUpdateConversationFunction(
+        client,
+        conversationModelIntrospection,
+        name,
+        conversationModel,
+        conversationMessageModel,
+        getInternals,
+      ),
       create: createCreateConversationFunction(
         client,
         conversationModelIntrospection,