@aws-amplify/data-schema 1.3.10 → 1.4.0

package/src/runtime/client/index.ts

@@ -507,202 +507,225 @@ type IndexQueryMethod<
 type ModelTypesClient<
   Model extends ClientSchemaByEntityTypeBaseShape['models'][string],
   FlatModel extends Record<string, unknown> = ResolvedModel<Model['type']>,
-> = IndexQueryMethods<Model> & {
-  create: (
-    model: Model['createType'],
-    options?: {
-      authMode?: AuthMode;
-      authToken?: string;
-      headers?: CustomHeaders;
-    },
-  ) => SingularReturnValue<Model['type']>;
-  update: (
-    model: Model['updateType'],
-    options?: {
-      authMode?: AuthMode;
-      authToken?: string;
-      headers?: CustomHeaders;
-    },
-  ) => SingularReturnValue<Model['type']>;
-  delete: (
-    identifier: Model['deleteType'],
-    options?: {
-      authMode?: AuthMode;
-      authToken?: string;
-      headers?: CustomHeaders;
-    },
-  ) => SingularReturnValue<Model['type']>;
-  get<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(
-    identifier: Model['identifier'],
-    options?: {
-      selectionSet?: SelectionSet;
-      authMode?: AuthMode;
-      authToken?: string;
-      headers?: CustomHeaders;
-    },
-  ): SingularReturnValue<Prettify<ReturnValue<Model, FlatModel, SelectionSet>>>;
-  list<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(
-    options?: ListCpkOptions<Model> & {
-      filter?: ModelFilter<Model>;
-      limit?: number;
-      nextToken?: string | null;
-      selectionSet?: SelectionSet;
-      authMode?: AuthMode;
-      authToken?: string;
-      headers?: CustomHeaders;
+> = IndexQueryMethods<Model> &
+  // Omit any disabled operations
+  Omit<
+    {
+      create: (
+        model: Model['createType'],
+        options?: {
+          authMode?: AuthMode;
+          authToken?: string;
+          headers?: CustomHeaders;
+        },
+      ) => SingularReturnValue<Model['type']>;
+      update: (
+        model: Model['updateType'],
+        options?: {
+          authMode?: AuthMode;
+          authToken?: string;
+          headers?: CustomHeaders;
+        },
+      ) => SingularReturnValue<Model['type']>;
+      delete: (
+        identifier: Model['deleteType'],
+        options?: {
+          authMode?: AuthMode;
+          authToken?: string;
+          headers?: CustomHeaders;
+        },
+      ) => SingularReturnValue<Model['type']>;
+
+      get<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(
+        identifier: Model['identifier'],
+        options?: {
+          selectionSet?: SelectionSet;
+          authMode?: AuthMode;
+          authToken?: string;
+          headers?: CustomHeaders;
+        },
+      ): SingularReturnValue<
+        Prettify<ReturnValue<Model, FlatModel, SelectionSet>>
+      >;
+      list<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(
+        options?: ListCpkOptions<Model> & {
+          filter?: ModelFilter<Model>;
+          limit?: number;
+          nextToken?: string | null;
+          selectionSet?: SelectionSet;
+          authMode?: AuthMode;
+          authToken?: string;
+          headers?: CustomHeaders;
+        },
+      ): ListReturnValue<Prettify<ReturnValue<Model, FlatModel, SelectionSet>>>;
+
+      onCreate<
+        SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[],
+      >(options?: {
+        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?: 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?: ModelSubscriptionFilter<Model>;
+        selectionSet?: SelectionSet;
+        authMode?: AuthMode;
+        authToken?: string;
+        headers?: CustomHeaders;
+      }): ObservedReturnValue<
+        Prettify<ReturnValue<Model, FlatModel, SelectionSet>>
+      >;
+      observeQuery<
+        SelectionSet extends ModelPath<FlatModel>[] = never[],
+      >(options?: {
+        filter?: ModelFilter<Model>;
+        selectionSet?: SelectionSet;
+        authMode?: AuthMode;
+        authToken?: string;
+      }): ObserveQueryReturnValue<
+        Prettify<ReturnValue<Model, FlatModel, SelectionSet>>
+      >;
     },
-  ): ListReturnValue<Prettify<ReturnValue<Model, FlatModel, SelectionSet>>>;
-  onCreate<
-    SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[],
-  >(options?: {
-    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?: 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?: ModelSubscriptionFilter<Model>;
-    selectionSet?: SelectionSet;
-    authMode?: AuthMode;
-    authToken?: string;
-    headers?: CustomHeaders;
-  }): ObservedReturnValue<
-    Prettify<ReturnValue<Model, FlatModel, SelectionSet>>
+    keyof Model['__meta']['disabledOperations']
   >;
-  observeQuery<
-    SelectionSet extends ModelPath<FlatModel>[] = never[],
-  >(options?: {
-    filter?: ModelFilter<Model>;
-    selectionSet?: SelectionSet;
-    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> & {
-  create: (
-    model: Model['createType'],
-    options?: {
-      authMode?: AuthMode;
-      authToken?: string;
-      headers?: CustomHeaders;
-    },
-  ) => SingularReturnValue<Model['type']>;
-  update: (
-    model: Model['updateType'],
-    options?: {
-      authMode?: AuthMode;
-      authToken?: string;
-      headers?: CustomHeaders;
-    },
-  ) => SingularReturnValue<Model['type']>;
-  delete: (
-    identifier: Model['deleteType'],
-    options?: {
-      authMode?: AuthMode;
-      authToken?: string;
-      headers?: CustomHeaders;
-    },
-  ) => SingularReturnValue<Model['type']>;
-  get<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(
-    identifier: Model['identifier'],
-    options?: {
-      selectionSet?: SelectionSet;
-      authMode?: AuthMode;
-      authToken?: string;
-      headers?: CustomHeaders;
-    },
-  ): SingularReturnValue<Prettify<ReturnValue<Model, FlatModel, SelectionSet>>>;
-  list<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(
-    options?: ListCpkOptions<Model> & {
-      filter?: ModelFilter<Model>;
-      sortDirection?: ModelSortDirection;
-      limit?: number;
-      nextToken?: string | null;
-      selectionSet?: SelectionSet;
-      authMode?: AuthMode;
-      authToken?: string;
-      headers?: CustomHeaders;
+> = IndexQueryMethods<Model> &
+  Omit<
+    {
+      create: (
+        model: Model['createType'],
+        options?: {
+          authMode?: AuthMode;
+          authToken?: string;
+          headers?: CustomHeaders;
+        },
+      ) => SingularReturnValue<Model['type']>;
+      update: (
+        model: Model['updateType'],
+        options?: {
+          authMode?: AuthMode;
+          authToken?: string;
+          headers?: CustomHeaders;
+        },
+      ) => SingularReturnValue<Model['type']>;
+      delete: (
+        identifier: Model['deleteType'],
+        options?: {
+          authMode?: AuthMode;
+          authToken?: string;
+          headers?: CustomHeaders;
+        },
+      ) => SingularReturnValue<Model['type']>;
+
+      get<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(
+        identifier: Model['identifier'],
+        options?: {
+          selectionSet?: SelectionSet;
+          authMode?: AuthMode;
+          authToken?: string;
+          headers?: CustomHeaders;
+        },
+      ): SingularReturnValue<
+        Prettify<ReturnValue<Model, FlatModel, SelectionSet>>
+      >;
+      list<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(
+        options?: ListCpkOptions<Model> & {
+          filter?: ModelFilter<Model>;
+          sortDirection?: ModelSortDirection;
+          limit?: number;
+          nextToken?: string | null;
+          selectionSet?: SelectionSet;
+          authMode?: AuthMode;
+          authToken?: string;
+          headers?: CustomHeaders;
+        },
+      ): ListReturnValue<Prettify<ReturnValue<Model, FlatModel, SelectionSet>>>;
     },
-  ): ListReturnValue<Prettify<ReturnValue<Model, FlatModel, SelectionSet>>>;
-};
+    keyof Model['__meta']['disabledOperations']
+  >;
 
 type ModelTypesSSRRequest<
   Model extends ClientSchemaByEntityTypeBaseShape['models'][string],
   FlatModel extends Record<string, unknown> = ResolvedModel<Model['type']>,
-> = IndexQueryMethods<Model, 'REQUEST'> & {
-  create: (
-    contextSpec: AmplifyServer.ContextSpec,
-    model: Model['createType'],
-    options?: {
-      authMode?: AuthMode;
-      authToken?: string;
-      headers?: CustomHeaders;
-    },
-  ) => SingularReturnValue<Model['type']>;
-  update: (
-    contextSpec: AmplifyServer.ContextSpec,
-    model: Model['updateType'],
-    options?: {
-      authMode?: AuthMode;
-      authToken?: string;
-      headers?: CustomHeaders;
-    },
-  ) => SingularReturnValue<Model['type']>;
-  delete: (
-    contextSpec: AmplifyServer.ContextSpec,
-    identifier: Model['deleteType'],
-    options?: {
-      authMode?: AuthMode;
-      authToken?: string;
-      headers?: CustomHeaders;
-    },
-  ) => SingularReturnValue<Model['type']>;
-  get<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(
-    contextSpec: AmplifyServer.ContextSpec,
-    identifier: Model['identifier'],
-    options?: {
-      selectionSet?: SelectionSet;
-      authMode?: AuthMode;
-      authToken?: string;
-      headers?: CustomHeaders;
+> = IndexQueryMethods<Model, 'REQUEST'> &
+  Omit<
+    {
+      create: (
+        contextSpec: AmplifyServer.ContextSpec,
+        model: Model['createType'],
+        options?: {
+          authMode?: AuthMode;
+          authToken?: string;
+          headers?: CustomHeaders;
+        },
+      ) => SingularReturnValue<Model['type']>;
+      update: (
+        contextSpec: AmplifyServer.ContextSpec,
+        model: Model['updateType'],
+        options?: {
+          authMode?: AuthMode;
+          authToken?: string;
+          headers?: CustomHeaders;
+        },
+      ) => SingularReturnValue<Model['type']>;
+      delete: (
+        contextSpec: AmplifyServer.ContextSpec,
+        identifier: Model['deleteType'],
+        options?: {
+          authMode?: AuthMode;
+          authToken?: string;
+          headers?: CustomHeaders;
+        },
+      ) => SingularReturnValue<Model['type']>;
+
+      get<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(
+        contextSpec: AmplifyServer.ContextSpec,
+        identifier: Model['identifier'],
+        options?: {
+          selectionSet?: SelectionSet;
+          authMode?: AuthMode;
+          authToken?: string;
+          headers?: CustomHeaders;
+        },
+      ): SingularReturnValue<
+        Prettify<ReturnValue<Model, FlatModel, SelectionSet>>
+      >;
+      list<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(
+        contextSpec: AmplifyServer.ContextSpec,
+        options?: ListCpkOptions<Model> & {
+          filter?: ModelFilter<Model>;
+          sortDirection?: ModelSortDirection;
+          limit?: number;
+          nextToken?: string | null;
+          selectionSet?: SelectionSet;
+          authMode?: AuthMode;
+          authToken?: string;
+          headers?: CustomHeaders;
+        },
+      ): ListReturnValue<Prettify<ReturnValue<Model, FlatModel, SelectionSet>>>;
     },
-  ): SingularReturnValue<Prettify<ReturnValue<Model, FlatModel, SelectionSet>>>;
-  list<SelectionSet extends ReadonlyArray<ModelPath<FlatModel>> = never[]>(
-    contextSpec: AmplifyServer.ContextSpec,
-    options?: ListCpkOptions<Model> & {
-      filter?: ModelFilter<Model>;
-      sortDirection?: ModelSortDirection;
-      limit?: number;
-      nextToken?: string | null;
-      selectionSet?: SelectionSet;
-      authMode?: AuthMode;
-      authToken?: string;
-      headers?: CustomHeaders;
-    },
-  ): ListReturnValue<Prettify<ReturnValue<Model, FlatModel, SelectionSet>>>;
-};
+    keyof Model['__meta']['disabledOperations']
+  >;
 
 type ContextType = 'CLIENT' | 'COOKIES' | 'REQUEST';
 

package/src/runtime/internals/APIClient.ts

@@ -21,7 +21,8 @@ import {
 } from '../bridge-types';
 
 import { CustomHeaders } from '../client';
-import { resolveOwnerFields, capitalize } from '../utils';
+import { resolveOwnerFields, capitalize, selfAwareAsync } from '../utils';
+import { extendCancellability } from './cancellation';
 
 import type { IndexMeta } from './operations/indexQuery';
 
@@ -246,6 +247,11 @@ export function initializeModel(
             {},
           );
 
+          // if get is disabled on the related model
+          if ((client as any).models[relatedModelName].get === undefined) {
+            break;
+          }
+
           if (context) {
             initializedRelationalFields[fieldName] = (
               contextSpec: AmplifyServer.ContextSpec,
@@ -333,21 +339,33 @@ export function initializeModel(
               },
             );
 
+            // if list is disabled on the related model
+            if ((client as any).models[relatedModelName].list === undefined) {
+              break;
+            }
+
             if (context) {
               initializedRelationalFields[fieldName] = (
                 contextSpec: AmplifyServer.ContextSpec,
                 options?: LazyLoadOptions,
               ) => {
                 if (record[parentPk]) {
-                  return (client as any).models[relatedModelName]
-                    .list(contextSpec, {
+                  return selfAwareAsync(async (resultPromise) => {
+                    const basePromise = (client as any).models[
+                      relatedModelName
+                    ].list(contextSpec, {
                       filter: { and: hasManyFilter },
                       limit: options?.limit,
                       nextToken: options?.nextToken,
                       authMode: options?.authMode || authMode,
                       authToken: options?.authToken || authToken,
-                    })
-                    .then(mapResult);
+                    });
+                    const extendedBase = extendCancellability(
+                      basePromise,
+                      resultPromise,
+                    );
+                    return mapResult((await extendedBase) as any);
+                  });
                 }
 
                 return [];
@@ -357,15 +375,22 @@ export function initializeModel(
                 options?: LazyLoadOptions,
               ) => {
                 if (record[parentPk]) {
-                  return (client as any).models[relatedModelName]
-                    .list({
+                  return selfAwareAsync(async (resultPromise) => {
+                    const basePromise = (client as any).models[
+                      relatedModelName
+                    ].list({
                       filter: { and: hasManyFilter },
                       limit: options?.limit,
                       nextToken: options?.nextToken,
                       authMode: options?.authMode || authMode,
                       authToken: options?.authToken || authToken,
-                    })
-                    .then(mapResult);
+                    });
+                    const extendedBase = extendCancellability(
+                      basePromise,
+                      resultPromise,
+                    );
+                    return mapResult((await extendedBase) as any);
+                  });
                 }
 
                 return [];
@@ -385,21 +410,33 @@ export function initializeModel(
             },
           );
 
+          // if list is disabled on the related model
+          if ((client as any).models[relatedModelName].list === undefined) {
+            break;
+          }
+
           if (context) {
             initializedRelationalFields[fieldName] = (
               contextSpec: AmplifyServer.ContextSpec,
               options?: LazyLoadOptions,
             ) => {
               if (record[parentPk]) {
-                return (client as any).models[relatedModelName]
-                  .list(contextSpec, {
+                return selfAwareAsync(async (resultPromise) => {
+                  const basePromise = (client as any).models[
+                    relatedModelName
+                  ].list(contextSpec, {
                     filter: { and: hasManyFilter },
                     limit: options?.limit,
                     nextToken: options?.nextToken,
                     authMode: options?.authMode || authMode,
                     authToken: options?.authToken || authToken,
-                  })
-                  .then(mapResult);
+                  });
+                  const extendedBase = extendCancellability(
+                    basePromise,
+                    resultPromise,
+                  );
+                  return mapResult((await extendedBase) as any);
+                });
               }
 
               return [];
@@ -409,15 +446,22 @@ export function initializeModel(
               options?: LazyLoadOptions,
             ) => {
               if (record[parentPk]) {
-                return (client as any).models[relatedModelName]
-                  .list({
+                return selfAwareAsync(async (resultPromise) => {
+                  const basePromise = (client as any).models[
+                    relatedModelName
+                  ].list({
                     filter: { and: hasManyFilter },
                     limit: options?.limit,
                     nextToken: options?.nextToken,
                     authMode: options?.authMode || authMode,
                     authToken: options?.authToken || authToken,
-                  })
-                  .then(mapResult);
+                  });
+                  const extendedBase = extendCancellability(
+                    basePromise,
+                    resultPromise,
+                  );
+                  return mapResult((await extendedBase) as any);
+                });
               }
 
               return [];
@@ -437,7 +481,7 @@ export function initializeModel(
 
 export 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 },
@@ -445,7 +489,7 @@ export 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 },
 } as const;
 export type ModelOperation = keyof typeof graphQLOperationsInfo;
 
@@ -999,7 +1043,7 @@ export function generateGraphQLDocument(
       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?
@@ -1047,7 +1091,7 @@ export function generateGraphQLDocument(
       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.',
@@ -1120,7 +1164,7 @@ export function buildGraphQLVariables(
           : {},
       };
       break;
-    case 'READ':
+    case 'GET':
     case 'DELETE':
       // only identifiers are sent
       if (arg) {
@@ -1194,7 +1238,7 @@ export function buildGraphQLVariables(
         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.',
       );

package/src/runtime/internals/cancellation.ts

@@ -0,0 +1,57 @@
+import { BaseClient } from '../bridge-types';
+
+/**
+ * A map of cancellable promise "extensions".
+ *
+ * Each entry value must either be a directly `cancel()`-able promise, or must
+ * refer to another entry.
+ *
+ * When cancellation of a promise is requested, cancel
+ * will check to see if the promise exists in the map. If it does, it pulls
+ * the value and repeats the check. If not, it will perform the underlying
+ * cancel operation.
+ */
+const promiseMap = new WeakMap<Promise<any>, Promise<any>>();
+
+export function extendCancellability<T>(
+  existingCancellablePromise: Promise<T>,
+  newPromiseToRegister: Promise<any>,
+): Promise<T> {
+  promiseMap.set(newPromiseToRegister, existingCancellablePromise);
+
+  return existingCancellablePromise.finally(() => {
+    promiseMap.delete(newPromiseToRegister);
+  });
+}
+
+/**
+ * Wraps the existing `cancel()` method with logic to iteratively search for
+ * the corresponding base level promise, if needed, that the core graphql client
+ * knows how to cancel.
+ *
+ * @param client
+ */
+export function upgradeClientCancellation(client: BaseClient) {
+  const innerCancel = client.cancel.bind(client);
+
+  client.cancel = function (
+    promise: Promise<any>,
+    message?: string | undefined,
+  ): boolean {
+    const visited = new Set<Promise<any>>();
+    let targetPromise: Promise<any> | undefined = promise;
+
+    while (targetPromise && promiseMap.has(targetPromise)) {
+      if (visited.has(targetPromise))
+        throw new Error(
+          'A cycle was detected in the modeled graphql cancellation chain. This is a bug. Please report it!',
+        );
+      visited.add(targetPromise);
+      targetPromise = promiseMap.get(targetPromise);
+    }
+
+    // call `innerCancel` with `targetPromise!` to defer to existing implementation
+    // on how to handle `null | undefined` or otherwise "non-cancellable" objects.
+    return innerCancel(targetPromise!, message);
+  };
+}