@aws-amplify/data-schema 1.3.9 → 1.4.0

package/dist/esm/runtime/client/index.d.ts

@@ -2,7 +2,7 @@ import { type DeepReadOnlyObject, type UnwrapArray, type UnionToIntersection, ty
 import type { Observable } from 'rxjs';
 import type { ClientSchemaByEntityType, ClientSchemaByEntityTypeBaseShape } from '../../ClientSchema';
 import type { ExtractNestedTypes } from '../../ClientSchema/utilities/';
-import type { Select, StringFilter, NumericFilter, BooleanFilters } from '../../util';
+import type { Select, StringFilter, NumericFilter, BooleanFilters, SubscriptionStringFilter, SubscriptionNumericFilter, SubscriptionBooleanFilters } from '../../util';
 import { AmplifyServer } from '../bridge-types';
 export { __modelMeta__, ExtractModelMeta, } from '@aws-amplify/data-schema-types';
 type Model = Record<string, any>;
@@ -258,6 +258,14 @@ type LogicalFilters<Model extends ClientSchemaByEntityTypeBaseShape['models'][st
 type ModelFilter<Model extends ClientSchemaByEntityTypeBaseShape['models'][string]> = LogicalFilters<Model> & {
     [K in keyof Model['type'] as Model['type'][K] extends LazyLoader<any, any> ? never : K]?: boolean extends Model['type'][K] ? BooleanFilters : number extends Model['type'][K] ? NumericFilter : StringFilter;
 };
+type LogicalSubscriptionFilters<Model extends ClientSchemaByEntityTypeBaseShape['models'][string]> = {
+    and?: ModelSubscriptionFilter<Model> | ModelSubscriptionFilter<Model>[];
+    or?: ModelSubscriptionFilter<Model> | ModelSubscriptionFilter<Model>[];
+    not?: ModelSubscriptionFilter<Model>;
+};
+type ModelSubscriptionFilter<Model extends ClientSchemaByEntityTypeBaseShape['models'][string]> = LogicalSubscriptionFilters<Model> & {
+    [K in keyof Model['type'] as Model['type'][K] extends LazyLoader<any, any> ? never : K]?: boolean extends Model['type'][K] ? SubscriptionBooleanFilters : number extends Model['type'][K] ? SubscriptionNumericFilter : SubscriptionStringFilter;
+};
 export type ModelSortDirection = 'ASC' | 'DESC';
 type ListCpkOptions<Model extends ClientSchemaByEntityTypeBaseShape['models'][string]> = unknown extends Model['__meta']['listOptionsPkParams'] ? unknown : Model['__meta']['listOptionsPkParams'] & {
     sortDirection?: ModelSortDirection;
@@ -287,7 +295,7 @@ type IndexQueryMethod<Model extends ClientSchemaByEntityTypeBaseShape['models'][
     authToken?: string;
     headers?: CustomHeaders;
 }) => ListReturnValue<Prettify<ReturnValue<Model, FlatModel, SelectionSet>>>;
-type ModelTypesClient<Model extends ClientSchemaByEntityTypeBaseShape['models'][string], FlatModel extends Record<string, unknown> = ResolvedModel<Model['type']>> = IndexQueryMethods<Model> & {
+type ModelTypesClient<Model extends ClientSchemaByEntityTypeBaseShape['models'][string], FlatModel extends Record<string, unknown> = ResolvedModel<Model['type']>> = IndexQueryMethods<Model> & Omit<{
     create: (model: Model['createType'], options?: {
         authMode?: AuthMode;
         authToken?: string;
@@ -319,21 +327,21 @@ type ModelTypesClient<Model extends ClientSchemaByEntityTypeBaseShape['models'][
         headers?: CustomHeaders;
     }): ListReturnValue<Prettify<ReturnValue<Model, FlatModel, SelectionSet>>>;
     onCreate<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(options?: {
-        filter?: ModelFilter<Model>;
+        filter?: ModelSubscriptionFilter<Model>;
         selectionSet?: SelectionSet;
         authMode?: AuthMode;
         authToken?: string;
         headers?: CustomHeaders;
     }): ObservedReturnValue<Prettify<ReturnValue<Model, FlatModel, SelectionSet>>>;
     onUpdate<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(options?: {
-        filter?: ModelFilter<Model>;
+        filter?: ModelSubscriptionFilter<Model>;
         selectionSet?: SelectionSet;
         authMode?: AuthMode;
         authToken?: string;
         headers?: CustomHeaders;
     }): ObservedReturnValue<Prettify<ReturnValue<Model, FlatModel, SelectionSet>>>;
     onDelete<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(options?: {
-        filter?: ModelFilter<Model>;
+        filter?: ModelSubscriptionFilter<Model>;
         selectionSet?: SelectionSet;
         authMode?: AuthMode;
         authToken?: string;
@@ -345,8 +353,8 @@ type ModelTypesClient<Model extends ClientSchemaByEntityTypeBaseShape['models'][
         authMode?: AuthMode;
         authToken?: string;
     }): ObserveQueryReturnValue<Prettify<ReturnValue<Model, FlatModel, SelectionSet>>>;
-};
-type ModelTypesSSRCookies<Model extends ClientSchemaByEntityTypeBaseShape['models'][string], FlatModel extends Record<string, unknown> = ResolvedModel<Model['type']>> = IndexQueryMethods<Model> & {
+}, keyof Model['__meta']['disabledOperations']>;
+type ModelTypesSSRCookies<Model extends ClientSchemaByEntityTypeBaseShape['models'][string], FlatModel extends Record<string, unknown> = ResolvedModel<Model['type']>> = IndexQueryMethods<Model> & Omit<{
     create: (model: Model['createType'], options?: {
         authMode?: AuthMode;
         authToken?: string;
@@ -378,8 +386,8 @@ type ModelTypesSSRCookies<Model extends ClientSchemaByEntityTypeBaseShape['model
         authToken?: string;
         headers?: CustomHeaders;
     }): ListReturnValue<Prettify<ReturnValue<Model, FlatModel, SelectionSet>>>;
-};
-type ModelTypesSSRRequest<Model extends ClientSchemaByEntityTypeBaseShape['models'][string], FlatModel extends Record<string, unknown> = ResolvedModel<Model['type']>> = IndexQueryMethods<Model, 'REQUEST'> & {
+}, keyof Model['__meta']['disabledOperations']>;
+type ModelTypesSSRRequest<Model extends ClientSchemaByEntityTypeBaseShape['models'][string], FlatModel extends Record<string, unknown> = ResolvedModel<Model['type']>> = IndexQueryMethods<Model, 'REQUEST'> & Omit<{
     create: (contextSpec: AmplifyServer.ContextSpec, model: Model['createType'], options?: {
         authMode?: AuthMode;
         authToken?: string;
@@ -411,7 +419,7 @@ type ModelTypesSSRRequest<Model extends ClientSchemaByEntityTypeBaseShape['model
         authToken?: string;
         headers?: CustomHeaders;
     }): ListReturnValue<Prettify<ReturnValue<Model, FlatModel, SelectionSet>>>;
-};
+}, keyof Model['__meta']['disabledOperations']>;
 type ContextType = 'CLIENT' | 'COOKIES' | 'REQUEST';
 export type ModelTypes<T extends Record<any, any>, Context extends ContextType = 'CLIENT', Schema extends ClientSchemaByEntityType<T> = ClientSchemaByEntityType<T>> = {
     [ModelName in keyof Schema['models']]: Context extends 'CLIENT' ? ModelTypesClient<Schema['models'][ModelName]> : Context extends 'COOKIES' ? ModelTypesSSRCookies<Schema['models'][ModelName]> : Context extends 'REQUEST' ? ModelTypesSSRRequest<Schema['models'][ModelName]> : never;

package/dist/esm/runtime/internals/APIClient.d.ts

@@ -51,7 +51,7 @@ export declare const graphQLOperationsInfo: {
         readonly operationPrefix: "create";
         readonly usePlural: false;
     };
-    readonly READ: {
+    readonly GET: {
         readonly operationPrefix: "get";
         readonly usePlural: false;
     };
@@ -83,7 +83,7 @@ export declare const graphQLOperationsInfo: {
         readonly operationPrefix: "onDelete";
         readonly usePlural: false;
     };
-    readonly OBSERVE_QUERY: {
+    readonly OBSERVEQUERY: {
         readonly operationPrefix: "observeQuery";
         readonly usePlural: false;
     };

package/dist/esm/runtime/internals/APIClient.mjs

@@ -1,5 +1,7 @@
 import { resolveOwnerFields } from '../utils/resolveOwnerFields.mjs';
 import { capitalize } from '../utils/stringTransformation.mjs';
+import { selfAwareAsync } from '../utils/selfAwareAsync.mjs';
+import { extendCancellability } from './cancellation.mjs';
 
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 const connectionType = {
@@ -166,6 +168,10 @@ function initializeModel(client, modelName, result, modelIntrospection, authMode
                             return (acc[curVal] = record[curVal]);
                         }
                     }, {});
+                    // if get is disabled on the related model
+                    if (client.models[relatedModelName].get === undefined) {
+                        break;
+                    }
                     if (context) {
                         initializedRelationalFields[fieldName] = (contextSpec, options) => {
                             if (record[targetNames[0]]) {
@@ -228,18 +234,24 @@ function initializeModel(client, modelName, result, modelIntrospection, authMode
                             }
                             return { [field]: { eq: record[parentSK[idx - 1]] } };
                         });
+                        // if list is disabled on the related model
+                        if (client.models[relatedModelName].list === undefined) {
+                            break;
+                        }
                         if (context) {
                             initializedRelationalFields[fieldName] = (contextSpec, options) => {
                                 if (record[parentPk]) {
-                                    return client.models[relatedModelName]
-                                        .list(contextSpec, {
-                                        filter: { and: hasManyFilter },
-                                        limit: options?.limit,
-                                        nextToken: options?.nextToken,
-                                        authMode: options?.authMode || authMode,
-                                        authToken: options?.authToken || authToken,
-                                    })
-                                        .then(mapResult);
+                                    return selfAwareAsync(async (resultPromise) => {
+                                        const basePromise = client.models[relatedModelName].list(contextSpec, {
+                                            filter: { and: hasManyFilter },
+                                            limit: options?.limit,
+                                            nextToken: options?.nextToken,
+                                            authMode: options?.authMode || authMode,
+                                            authToken: options?.authToken || authToken,
+                                        });
+                                        const extendedBase = extendCancellability(basePromise, resultPromise);
+                                        return mapResult((await extendedBase));
+                                    });
                                 }
                                 return [];
                             };
@@ -247,15 +259,17 @@ function initializeModel(client, modelName, result, modelIntrospection, authMode
                         else {
                             initializedRelationalFields[fieldName] = (options) => {
                                 if (record[parentPk]) {
-                                    return client.models[relatedModelName]
-                                        .list({
-                                        filter: { and: hasManyFilter },
-                                        limit: options?.limit,
-                                        nextToken: options?.nextToken,
-                                        authMode: options?.authMode || authMode,
-                                        authToken: options?.authToken || authToken,
-                                    })
-                                        .then(mapResult);
+                                    return selfAwareAsync(async (resultPromise) => {
+                                        const basePromise = client.models[relatedModelName].list({
+                                            filter: { and: hasManyFilter },
+                                            limit: options?.limit,
+                                            nextToken: options?.nextToken,
+                                            authMode: options?.authMode || authMode,
+                                            authToken: options?.authToken || authToken,
+                                        });
+                                        const extendedBase = extendCancellability(basePromise, resultPromise);
+                                        return mapResult((await extendedBase));
+                                    });
                                 }
                                 return [];
                             };
@@ -268,18 +282,24 @@ function initializeModel(client, modelName, result, modelIntrospection, authMode
                         }
                         return { [field]: { eq: record[parentSK[idx - 1]] } };
                     });
+                    // if list is disabled on the related model
+                    if (client.models[relatedModelName].list === undefined) {
+                        break;
+                    }
                     if (context) {
                         initializedRelationalFields[fieldName] = (contextSpec, options) => {
                             if (record[parentPk]) {
-                                return client.models[relatedModelName]
-                                    .list(contextSpec, {
-                                    filter: { and: hasManyFilter },
-                                    limit: options?.limit,
-                                    nextToken: options?.nextToken,
-                                    authMode: options?.authMode || authMode,
-                                    authToken: options?.authToken || authToken,
-                                })
-                                    .then(mapResult);
+                                return selfAwareAsync(async (resultPromise) => {
+                                    const basePromise = client.models[relatedModelName].list(contextSpec, {
+                                        filter: { and: hasManyFilter },
+                                        limit: options?.limit,
+                                        nextToken: options?.nextToken,
+                                        authMode: options?.authMode || authMode,
+                                        authToken: options?.authToken || authToken,
+                                    });
+                                    const extendedBase = extendCancellability(basePromise, resultPromise);
+                                    return mapResult((await extendedBase));
+                                });
                             }
                             return [];
                         };
@@ -287,15 +307,17 @@ function initializeModel(client, modelName, result, modelIntrospection, authMode
                     else {
                         initializedRelationalFields[fieldName] = (options) => {
                             if (record[parentPk]) {
-                                return client.models[relatedModelName]
-                                    .list({
-                                    filter: { and: hasManyFilter },
-                                    limit: options?.limit,
-                                    nextToken: options?.nextToken,
-                                    authMode: options?.authMode || authMode,
-                                    authToken: options?.authToken || authToken,
-                                })
-                                    .then(mapResult);
+                                return selfAwareAsync(async (resultPromise) => {
+                                    const basePromise = client.models[relatedModelName].list({
+                                        filter: { and: hasManyFilter },
+                                        limit: options?.limit,
+                                        nextToken: options?.nextToken,
+                                        authMode: options?.authMode || authMode,
+                                        authToken: options?.authToken || authToken,
+                                    });
+                                    const extendedBase = extendCancellability(basePromise, resultPromise);
+                                    return mapResult((await extendedBase));
+                                });
                             }
                             return [];
                         };
@@ -309,7 +331,7 @@ function initializeModel(client, modelName, result, modelIntrospection, authMode
 }
 const graphQLOperationsInfo = {
     CREATE: { operationPrefix: 'create', usePlural: false },
-    READ: { operationPrefix: 'get', usePlural: false },
+    GET: { operationPrefix: 'get', usePlural: false },
     UPDATE: { operationPrefix: 'update', usePlural: false },
     DELETE: { operationPrefix: 'delete', usePlural: false },
     LIST: { operationPrefix: 'list', usePlural: true },
@@ -317,7 +339,7 @@ const graphQLOperationsInfo = {
     ONCREATE: { operationPrefix: 'onCreate', usePlural: false },
     ONUPDATE: { operationPrefix: 'onUpdate', usePlural: false },
     ONDELETE: { operationPrefix: 'onDelete', usePlural: false },
-    OBSERVE_QUERY: { operationPrefix: 'observeQuery', usePlural: false },
+    OBSERVEQUERY: { operationPrefix: 'observeQuery', usePlural: false },
 };
 const SELECTION_SET_WILDCARD = '*';
 const getDefaultSelectionSetForNonModelWithIR = (nonModelDefinition, modelIntrospection) => {
@@ -696,7 +718,7 @@ function generateGraphQLDocument(modelIntrospection, modelName, modelOperation,
             graphQLOperationType ?? (graphQLOperationType = 'mutation');
         // TODO(Eslint): this this case clause correct without the break statement?
         // eslint-disable-next-line no-fallthrough
-        case 'READ':
+        case 'GET':
             graphQLArguments ?? (graphQLArguments = getPkArgs);
             graphQLSelectionSet ?? (graphQLSelectionSet = selectionSetFields);
         // TODO(Eslint): this this case clause correct without the break statement?
@@ -744,7 +766,7 @@ function generateGraphQLDocument(modelIntrospection, modelName, modelOperation,
             graphQLOperationType ?? (graphQLOperationType = 'subscription');
             graphQLSelectionSet ?? (graphQLSelectionSet = selectionSetFields);
             break;
-        case 'OBSERVE_QUERY':
+        case 'OBSERVEQUERY':
         default:
             throw new Error('Internal error: Attempted to generate graphql document for observeQuery. Please report this error.');
     }
@@ -779,7 +801,7 @@ function buildGraphQLVariables(modelDefinition, operation, arg, modelIntrospecti
                     : {},
             };
             break;
-        case 'READ':
+        case 'GET':
         case 'DELETE':
             // only identifiers are sent
             if (arg) {
@@ -842,7 +864,7 @@ function buildGraphQLVariables(modelDefinition, operation, arg, modelIntrospecti
                 variables = { filter: arg.filter };
             }
             break;
-        case 'OBSERVE_QUERY':
+        case 'OBSERVEQUERY':
             throw new Error('Internal error: Attempted to build variables for observeQuery. Please report this error.');
         default: {
             const exhaustiveCheck = operation;