@aws-amplify/data-schema 1.6.2 → 1.7.0

package/package.json

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

package/src/ai/ConversationType.ts

@@ -29,6 +29,10 @@ interface ConversationRouteGetInput {
   id: string;
 }
 
+interface ConversationRouteDeleteInput {
+  id: string;
+}
+
 interface ConversationRouteListInput {
   limit?: number;
   nextToken?: string | null;
@@ -47,6 +51,12 @@ export interface ConversationRoute {
    * Gets an existing {@link Conversation} based on ID.
    */
   get: (input: ConversationRouteGetInput) => SingularReturnValue<Conversation>;
+  /**
+   * @experimental
+   *
+   * Deletes an existing {@link Conversation} based on ID.
+   */
+    delete: (input: ConversationRouteDeleteInput) => SingularReturnValue<Conversation>;
   /**
    * @experimental
    *

package/src/runtime/bridge-types.ts

@@ -15,6 +15,8 @@ import { Observable } from 'rxjs';
 
 import { CustomHeaders, ModelSortDirection } from './client';
 
+import { AiAction, AiCategory } from './internals/ai/getCustomUserAgentDetails';
+
 export declare namespace AmplifyServer {
   export interface ContextToken {
     readonly value: symbol;
@@ -408,9 +410,15 @@ export type BaseSSRClient = {
   isCancelError(error: any): boolean;
 };
 
+export interface CustomUserAgentDetails {
+  category: AiCategory;
+  action: AiAction;
+}
+
 export type GraphQLMethod = (
   options: GraphQLOptions,
   additionalHeaders?: CustomHeaders | undefined,
+  customUserAgentDetails?: CustomUserAgentDetails,
 ) => Promise<GraphQLResult> | GraphqlSubscriptionResult;
 
 export type GraphQLMethodSSR = (

package/src/runtime/index.ts

@@ -5,3 +5,4 @@ export * from './client';
 export { addSchemaToClient } from './addSchemaToClient';
 export { addSchemaToClientWithInstance } from './addSchemaToClientWithInstance';
 export { BaseClient, ClientInternals } from './bridge-types';
+export { INTERNAL_USER_AGENT_OVERRIDE } from './internals/ai/getCustomUserAgentDetails';

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

@@ -3,7 +3,7 @@
 
 import type { ConversationRoute } from '../../../ai/ConversationType';
 import type { SingularReturnValue } from '../../../runtime/client';
-import type {
+import {
   BaseClient,
   ClientInternalsGetter,
   ModelIntrospectionSchema,
@@ -11,6 +11,10 @@ import type {
 } from '../../bridge-types';
 import { getFactory } from '../operations/get';
 import { convertItemToConversation } from './convertItemToConversation';
+import {
+  AiAction,
+  getCustomUserAgentDetails,
+} from './getCustomUserAgentDetails';
 
 export const createCreateConversationFunction =
   (
@@ -28,6 +32,8 @@ export const createCreateConversationFunction =
       conversationModel,
       'CREATE',
       getInternals,
+      false,
+      getCustomUserAgentDetails(AiAction.CreateConversation),
     ) as () => SingularReturnValue<Record<string, any>>;
     const { data, errors } = await get();
     return {

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

@@ -0,0 +1,54 @@
+// 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 createDeleteConversationFunction =
+  (
+    client: BaseClient,
+    modelIntrospection: ModelIntrospectionSchema,
+    conversationRouteName: string,
+    conversationModel: SchemaModel,
+    conversationMessageModel: SchemaModel,
+    getInternals: ClientInternalsGetter,
+  ): ConversationRoute['delete'] =>
+  async ({ id }) => {
+    const deleteOperation = getFactory(
+      client,
+      modelIntrospection,
+      conversationModel,
+      'DELETE',
+      getInternals,
+      false,
+      getCustomUserAgentDetails(AiAction.DeleteConversation),
+    ) as (
+      args?: Record<string, any>,
+    ) => SingularReturnValue<Record<string, any>>;
+    const { data, errors } = await deleteOperation({ id });
+    return {
+      data: data
+        ? convertItemToConversation(
+            client,
+            modelIntrospection,
+            data?.id,
+            conversationRouteName,
+            conversationMessageModel,
+            getInternals,
+          )
+        : data,
+      errors,
+    };
+  };

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

@@ -3,7 +3,7 @@
 
 import type { ConversationRoute } from '../../../ai/ConversationType';
 import type { SingularReturnValue } from '../../../runtime/client';
-import type {
+import {
   BaseClient,
   ClientInternalsGetter,
   ModelIntrospectionSchema,
@@ -11,6 +11,10 @@ import type {
 } from '../../bridge-types';
 import { getFactory } from '../operations/get';
 import { convertItemToConversation } from './convertItemToConversation';
+import {
+  AiAction,
+  getCustomUserAgentDetails,
+} from './getCustomUserAgentDetails';
 
 export const createGetConversationFunction =
   (
@@ -28,6 +32,8 @@ export const createGetConversationFunction =
       conversationModel,
       'GET',
       getInternals,
+      false,
+      getCustomUserAgentDetails(AiAction.GetConversation),
     ) as (
       args?: Record<string, any>,
     ) => SingularReturnValue<Record<string, any>>;

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

@@ -3,7 +3,7 @@
 
 import type { ConversationRoute } from '../../../ai/ConversationType';
 import type { ListReturnValue } from '../../../runtime/client';
-import type {
+import {
   BaseClient,
   ClientInternalsGetter,
   ModelIntrospectionSchema,
@@ -11,6 +11,10 @@ import type {
 } from '../../bridge-types';
 import { listFactory } from '../operations/list';
 import { convertItemToConversation } from './convertItemToConversation';
+import {
+  AiAction,
+  getCustomUserAgentDetails,
+} from './getCustomUserAgentDetails';
 
 export const createListConversationsFunction =
   (
@@ -27,6 +31,8 @@ export const createListConversationsFunction =
       modelIntrospection,
       conversationModel,
       getInternals,
+      false,
+      getCustomUserAgentDetails(AiAction.ListConversations),
     ) as (args?: Record<string, any>) => ListReturnValue<Record<string, any>>;
     const { data, nextToken, errors } = await list(input);
     return {

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

@@ -6,7 +6,7 @@ import type {
   ConversationMessage,
 } from '../../../ai/ConversationType';
 import type { ListReturnValue } from '../../../runtime/client';
-import type {
+import {
   BaseClient,
   ClientInternalsGetter,
   ModelIntrospectionSchema,
@@ -14,6 +14,10 @@ import type {
 } from '../../bridge-types';
 import { listFactory } from '../operations/list';
 import { convertItemToConversationMessage } from './convertItemToConversationMessage';
+import {
+  AiAction,
+  getCustomUserAgentDetails,
+} from './getCustomUserAgentDetails';
 
 export const createListMessagesFunction =
   (
@@ -29,6 +33,8 @@ export const createListMessagesFunction =
       modelIntrospection,
       conversationMessageModel,
       getInternals,
+      false,
+      getCustomUserAgentDetails(AiAction.ListMessages),
     ) as (args?: Record<string, any>) => ListReturnValue<ConversationMessage>;
     const { data, nextToken, errors } = await list({
       ...input,

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

@@ -3,13 +3,14 @@
 
 import type { Observable, Subscription } from 'rxjs';
 import type { Conversation } from '../../../ai/ConversationType';
-import type {
+import {
   BaseClient,
   ClientInternalsGetter,
   ModelIntrospectionSchema,
 } from '../../bridge-types';
 import { customOpFactory } from '../operations/custom';
 import { convertItemToConversationMessage } from './convertItemToConversationMessage';
+import { AiAction, getCustomUserAgentDetails } from './getCustomUserAgentDetails';
 
 export const createOnMessageFunction =
   (
@@ -34,6 +35,7 @@ export const createOnMessageFunction =
       subscribeSchema,
       false,
       getInternals,
+      getCustomUserAgentDetails(AiAction.OnMessage),
     ) as (args?: Record<string, any>) => Observable<any>;
     return subscribeOperation({ conversationId }).subscribe((data) => {
       handler(convertItemToConversationMessage(data));

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

@@ -6,7 +6,7 @@ import type {
   Conversation,
   ConversationMessage,
 } from '../../../ai/ConversationType';
-import type {
+import {
   BaseClient,
   ClientInternalsGetter,
   ModelIntrospectionSchema,
@@ -18,6 +18,10 @@ import {
   serializeContent,
   serializeToolConfiguration,
 } from './conversationMessageSerializers';
+import {
+  AiAction,
+  getCustomUserAgentDetails,
+} from './getCustomUserAgentDetails';
 
 export const createSendMessageFunction =
   (
@@ -42,6 +46,7 @@ export const createSendMessageFunction =
       sendSchema,
       false,
       getInternals,
+      getCustomUserAgentDetails(AiAction.SendMessage),
     ) as (
       args?: Record<string, any>,
     ) => SingularReturnValue<ConversationMessage>;

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

@@ -0,0 +1,54 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { CustomUserAgentDetails } from '../../bridge-types';
+
+/**
+ * Symbol used for internal user agent overrides.
+ *
+ * @internal
+ * This symbol is intended for internal use within the Amplify library.
+ * It may change or be removed in future versions without notice.
+ * External usage of this symbol is discouraged and may lead to unexpected behavior.
+ */
+export const INTERNAL_USER_AGENT_OVERRIDE = Symbol(
+  'INTERNAL_USER_AGENT_OVERRIDE',
+);
+
+export type AiCategory = 'ai';
+
+export enum AiAction {
+  CreateConversation = '1',
+  GetConversation = '2',
+  ListConversations = '3',
+  DeleteConversation = '4',
+  SendMessage = '5',
+  ListMessages = '6',
+  OnMessage = '7',
+  Generation = '8',
+}
+
+export const getCustomUserAgentDetails = (
+  action: AiAction,
+): CustomUserAgentDetails => ({
+  category: 'ai',
+  action,
+});
+
+/**
+ * Creates a user agent override object based on custom details.
+ *
+ * @internal
+ * This function is intended for internal use within the Amplify library.
+ * It may change or be removed in future versions without notice.
+ *
+ * @param customUserAgentDetails - Optional custom user agent details
+ * @returns An object with INTERNAL_USER_AGENT_OVERRIDE symbol as key and customUserAgentDetails as value, or undefined if no details provided
+ */
+export function createUserAgentOverride(
+  customUserAgentDetails?: CustomUserAgentDetails,
+): { [INTERNAL_USER_AGENT_OVERRIDE]?: CustomUserAgentDetails } | undefined {
+  return customUserAgentDetails
+    ? { [INTERNAL_USER_AGENT_OVERRIDE]: customUserAgentDetails }
+    : undefined;
+}

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

@@ -17,6 +17,7 @@ import {
   InputFieldType,
   EnumType,
   InputType,
+  CustomUserAgentDetails,
 } from '../../bridge-types';
 
 import { map } from 'rxjs';
@@ -34,6 +35,7 @@ import { handleSingularGraphQlError } from './utils';
 import { selfAwareAsync } from '../../utils';
 
 import { extendCancellability } from '../cancellation';
+import { createUserAgentOverride } from '../ai/getCustomUserAgentDetails';
 
 type CustomOperationOptions = AuthModeParams & ListArgs;
 
@@ -120,6 +122,7 @@ export function customOpFactory(
   operation: CustomOperation,
   useContext: boolean,
   getInternals: ClientInternalsGetter,
+  customUserAgentDetails?: CustomUserAgentDetails,
 ) {
   // .arguments() are defined for the custom operation in the schema builder
   // and are present in the model introspection schema
@@ -159,6 +162,7 @@ export function customOpFactory(
         getInternals,
         arg,
         options,
+        customUserAgentDetails,
       );
     }
 
@@ -171,6 +175,7 @@ export function customOpFactory(
       arg,
       options,
       contextSpec,
+      customUserAgentDetails,
     );
   };
 
@@ -384,6 +389,7 @@ function _op(
   args?: QueryArgs,
   options?: AuthModeParams & ListArgs,
   context?: AmplifyServer.ContextSpec,
+  customUserAgentDetails?: CustomUserAgentDetails,
 ) {
   return selfAwareAsync(async (resultPromise) => {
     const { name: operationName } = operation;
@@ -405,6 +411,8 @@ function _op(
 
     const variables = operationVariables(operation, args);
 
+    const userAgentOverride = createUserAgentOverride(customUserAgentDetails);
+
     try {
       const basePromise = context
         ? ((client as BaseSSRClient).graphql(
@@ -421,6 +429,7 @@ function _op(
               ...auth,
               query,
               variables,
+              ...userAgentOverride,
             },
             headers,
           ) as Promise<GraphQLResult>);
@@ -548,6 +557,7 @@ function _opSubscription(
   getInternals: ClientInternalsGetter,
   args?: QueryArgs,
   options?: AuthModeParams & ListArgs,
+  customUserAgentDetails?: CustomUserAgentDetails,
 ) {
   const operationType = 'subscription';
   const { name: operationName } = operation;
@@ -569,11 +579,14 @@ function _opSubscription(
 
   const variables = operationVariables(operation, args);
 
+  const userAgentOverride = createUserAgentOverride(customUserAgentDetails);
+
   const observable = client.graphql(
     {
       ...auth,
       query,
       variables,
+      ...userAgentOverride,
     },
     headers,
   ) as GraphqlSubscriptionResult;

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

@@ -13,6 +13,7 @@ import {
   ModelIntrospectionSchema,
   SchemaModel,
   QueryArgs,
+  CustomUserAgentDetails,
 } from '../../bridge-types';
 
 import {
@@ -29,6 +30,7 @@ import { handleSingularGraphQlError } from './utils';
 import { selfAwareAsync } from '../../utils';
 
 import { extendCancellability } from '../cancellation';
+import { createUserAgentOverride } from '../ai/getCustomUserAgentDetails';
 
 export function getFactory(
   client: BaseClient,
@@ -37,6 +39,7 @@ export function getFactory(
   operation: ModelOperation,
   getInternals: ClientInternalsGetter,
   useContext = false,
+  customUserAgentDetails?: CustomUserAgentDetails,
 ) {
   const getWithContext = (
     contextSpec: AmplifyServer.ContextSpec & GraphQLOptions,
@@ -52,6 +55,7 @@ export function getFactory(
       operation,
       getInternals,
       contextSpec,
+      customUserAgentDetails,
     );
   };
 
@@ -64,6 +68,8 @@ export function getFactory(
       options,
       operation,
       getInternals,
+      undefined,
+      customUserAgentDetails,
     );
   };
 
@@ -79,6 +85,7 @@ function _get(
   operation: ModelOperation,
   getInternals: ClientInternalsGetter,
   context?: AmplifyServer.ContextSpec,
+  customUserAgentDetails?: CustomUserAgentDetails,
 ) {
   return selfAwareAsync(async (resultPromise) => {
     const { name } = model;
@@ -97,10 +104,11 @@ function _get(
     );
 
     const auth = authModeParams(client, getInternals, options);
+    const headers = getCustomHeaders(client, getInternals, options?.headers);
 
-    try {
-      const headers = getCustomHeaders(client, getInternals, options?.headers);
+    const userAgentOverride = createUserAgentOverride(customUserAgentDetails);
 
+    try {
       const basePromise = context
         ? ((client as BaseSSRClient).graphql(
             context,
@@ -116,6 +124,7 @@ function _get(
               ...auth,
               query,
               variables,
+              ...userAgentOverride,
             },
             headers,
           ) as Promise<GraphQLResult>);

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

@@ -11,6 +11,7 @@ import {
   ListArgs,
   ModelIntrospectionSchema,
   SchemaModel,
+  CustomUserAgentDetails,
 } from '../../bridge-types';
 
 import {
@@ -26,6 +27,7 @@ import { handleListGraphQlError } from './utils';
 import { selfAwareAsync } from '../../utils';
 
 import { extendCancellability } from '../cancellation';
+import { createUserAgentOverride } from '../ai/getCustomUserAgentDetails';
 
 export function listFactory(
   client: BaseClient,
@@ -33,6 +35,7 @@ export function listFactory(
   model: SchemaModel,
   getInternals: ClientInternalsGetter,
   context = false,
+  customUserAgentDetails?: CustomUserAgentDetails,
 ) {
   const listWithContext = (
     contextSpec: AmplifyServer.ContextSpec,
@@ -45,11 +48,20 @@ export function listFactory(
       getInternals,
       args,
       contextSpec,
+      customUserAgentDetails,
     );
   };
 
   const list = (args?: Record<string, any>) => {
-    return _list(client, modelIntrospection, model, getInternals, args);
+    return _list(
+      client,
+      modelIntrospection,
+      model,
+      getInternals,
+      args,
+      undefined,
+      customUserAgentDetails
+    );
   };
 
   return context ? listWithContext : list;
@@ -62,6 +74,7 @@ function _list(
   getInternals: ClientInternalsGetter,
   args?: ListArgs & AuthModeParams,
   contextSpec?: AmplifyServer.ContextSpec,
+  customUserAgentDetails?: CustomUserAgentDetails,
 ) {
   return selfAwareAsync(async (resultPromise) => {
     const { name } = model;
@@ -80,10 +93,11 @@ function _list(
     );
 
     const auth = authModeParams(client, getInternals, args);
+    const headers = getCustomHeaders(client, getInternals, args?.headers);
 
-    try {
-      const headers = getCustomHeaders(client, getInternals, args?.headers);
+    const userAgentOverride = createUserAgentOverride(customUserAgentDetails);
 
+    try {
       const basePromise = contextSpec
         ? ((client as BaseSSRClient).graphql(
             contextSpec,
@@ -99,6 +113,7 @@ function _list(
               ...auth,
               query,
               variables,
+              ...userAgentOverride,
             },
             headers,
           ) as Promise<GraphQLResult>);

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

@@ -11,6 +11,7 @@ import {
 import { createCreateConversationFunction } from '../../ai/createCreateConversationFunction';
 import { createGetConversationFunction } from '../../ai/createGetConversationFunction';
 import { createListConversationsFunction } from '../../ai/createListConversationsFunction';
+import { createDeleteConversationFunction } from '../../ai/createDeleteConversationFunction';
 
 export function generateConversationsProperty(
   client: BaseClient,
@@ -76,6 +77,14 @@ export function generateConversationsProperty(
         conversationMessageModel,
         getInternals,
       ),
+      delete: createDeleteConversationFunction(
+        client,
+        conversationModelIntrospection,
+        name,
+        conversationModel,
+        conversationMessageModel,
+        getInternals,
+      ),
       list: createListConversationsFunction(
         client,
         conversationModelIntrospection,

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

@@ -9,6 +9,10 @@ import {
 } from '../../../bridge-types';
 import { CustomQueries } from '../../../client';
 import { customOpFactory } from '../../operations/custom';
+import {
+  AiAction,
+  getCustomUserAgentDetails,
+} from '../../ai/getCustomUserAgentDetails';
 
 export function generateGenerationsProperty<T extends Record<any, any>>(
   client: BaseClient,
@@ -34,6 +38,7 @@ export function generateGenerationsProperty<T extends Record<any, any>>(
       generation,
       false,
       getInternals,
+      getCustomUserAgentDetails(AiAction.Generation),
     );
   }