@aws-amplify/data-schema 1.3.10 → 1.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/data-schema",
-  "version": "1.3.10",
+  "version": "1.4.0",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
@@ -16,7 +16,7 @@
     "clean": "rimraf dist",
     "docs": "api-extractor run && api-documenter markdown --input-folder temp --output-folder docs",
     "docs:temp": "api-extractor run && api-documenter markdown --input-folder temp --output-folder temp/docs",
-    "check:api": "rimraf temp && npm run docs:temp && node ../../scripts/shallow-dir-diff.js docs temp/docs",
+    "check:api": "rimraf temp && npm run docs:temp && tsx ../../scripts/shallow-dir-diff.ts docs temp/docs",
     "lint": "eslint .",
     "test": "jest"
   },

package/src/ClientSchema/Core/ClientModel.ts

@@ -2,6 +2,7 @@ import type {
   deferredRefResolvingPrefix,
   ModelTypeParamShape,
   ModelDefaultIdentifier,
+  DisableOperationsOptions,
 } from '../../ModelType';
 import type { ClientSchemaProperty } from './ClientSchemaProperty';
 import type { Authorization, ImpliedAuthFields } from '../../Authorization';
@@ -49,9 +50,37 @@ export interface ClientModel<
   secondaryIndexes: IndexQueryMethodsFromIR<Bag, T['secondaryIndexes'], K>;
   __meta: {
     listOptionsPkParams: ListOptionsPkParams<Bag, T>;
+    disabledOperations: DisabledOpsToMap<T['disabledOperations']>;
   };
 }
 
+/**
+ * Creates a map of disabled operations, expanding coarse-grained ops into fine-grained ones
+ * The map is used in runtime/client/index.ts to Omit any disabled ops from the data-client types
+ *
+ * @example
+ * a.model({...}).disableOperations(['update', 'subscriptions'])
+ * Returns
+ * {
+ *   update: true;
+ *   onCreate: true;
+ *   onUpdate: true;
+ *   onDelete: true;
+ *   observeQuery: true;
+ * }
+ */
+type DisabledOpsToMap<Ops extends ReadonlyArray<DisableOperationsOptions>> = {
+  [Op in Ops[number] as Op extends 'queries'
+    ? 'list' | 'get' | 'observeQuery'
+    : Op extends 'mutations'
+      ? 'create' | 'update' | 'delete'
+      : Op extends 'subscriptions'
+        ? 'onCreate' | 'onUpdate' | 'onDelete' | 'observeQuery'
+        : Op extends 'list'
+          ? 'list' | 'observeQuery'
+          : Op]: true;
+};
+
 type ClientFields<
   Bag extends Record<string, unknown>,
   Metadata extends SchemaMetadata<any>,

package/src/ClientSchema/utilities/ResolveField.ts

@@ -51,15 +51,35 @@ export type ResolveIndividualField<Bag extends Record<string, any>, T> =
             ? values[number] | null
             : never;
 
+/**
+ * Resolves to never if the related model has disabled list or get ops for hasOne/hasMany or belongsTo respectively
+ */
 type ResolveRelationship<
   Bag extends Record<string, any>,
   RelationshipShape extends ModelRelationalFieldParamShape,
-> = LazyLoader<
-  RelationshipShape['valueRequired'] extends true
-    ? Bag[RelationshipShape['relatedModel']]['type']
-    : Bag[RelationshipShape['relatedModel']]['type'] | null,
-  RelationshipShape['array']
->;
+> = DependentLazyLoaderOpIsAvailable<Bag, RelationshipShape> extends true
+    ? LazyLoader<
+        RelationshipShape['valueRequired'] extends true
+          ? Bag[RelationshipShape['relatedModel']]['type']
+          : Bag[RelationshipShape['relatedModel']]['type'] | null,
+        RelationshipShape['array']
+      >
+    : never
+;
+
+type DependentLazyLoaderOpIsAvailable<
+  Bag extends Record<string, any>,
+  RelationshipShape extends ModelRelationalFieldParamShape,
+> = RelationshipShape['relationshipType'] extends 'hasOne' | 'hasMany'
+  ? // hasOne and hasMany depend on `list`
+    'list' extends keyof Bag[RelationshipShape['relatedModel']]['__meta']['disabledOperations']
+    ? false
+    : true
+  : // the relationship is a belongsTo, which depends on `get`
+    'get' extends keyof Bag[RelationshipShape['relatedModel']]['__meta']['disabledOperations']
+    ? false
+    : true
+;
 
 type IsRequired<T> =
   T extends BaseModelField<infer FieldShape>

package/src/ModelType.ts

@@ -43,11 +43,25 @@ type InternalModelFields = Record<
   InternalField | InternalRelationalField
 >;
 
+export type DisableOperationsOptions =
+  | 'queries'
+  | 'mutations'
+  | 'subscriptions'
+  | 'list'
+  | 'get'
+  | 'create'
+  | 'update'
+  | 'delete'
+  | 'onCreate'
+  | 'onUpdate'
+  | 'onDelete';
+
 type ModelData = {
   fields: ModelFields;
   identifier: ReadonlyArray<string>;
   secondaryIndexes: ReadonlyArray<ModelIndexType<any, any, any, any, any>>;
   authorization: Authorization<any, any, any>[];
+  disabledOperations: ReadonlyArray<DisableOperationsOptions>;
 };
 
 type InternalModelData = ModelData & {
@@ -55,6 +69,7 @@ type InternalModelData = ModelData & {
   identifier: ReadonlyArray<string>;
   secondaryIndexes: ReadonlyArray<InternalModelIndexType>;
   authorization: Authorization<any, any, any>[];
+  disabledOperations: ReadonlyArray<DisableOperationsOptions>;
   originalName?: string;
 };
 
@@ -63,6 +78,7 @@ export type ModelTypeParamShape = {
   identifier: PrimaryIndexIrShape;
   secondaryIndexes: ReadonlyArray<SecondaryIndexIrShape>;
   authorization: Authorization<any, any, any>[];
+  disabledOperations: ReadonlyArray<DisableOperationsOptions>;
 };
 
 /**
@@ -250,6 +266,14 @@ export type 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'>,
@@ -302,6 +326,7 @@ function _model<T extends ModelTypeParamShape>(fields: T['fields']) {
     identifier: ['id'],
     secondaryIndexes: [],
     authorization: [],
+    disabledOperations: [],
   };
 
   const builder = {
@@ -315,6 +340,11 @@ function _model<T extends ModelTypeParamShape>(fields: T['fields']) {
 
       return this;
     },
+    disableOperations(ops) {
+      data.disabledOperations = ops;
+
+      return this;
+    },
     authorization(callback) {
       const { resource: _, ...rest } = allow;
       const rules = callback(rest);
@@ -375,6 +405,7 @@ export function model<T extends ModelFields>(
   identifier: ModelDefaultIdentifier;
   secondaryIndexes: [];
   authorization: [];
+  disabledOperations: [];
 }> {
   return _model(fields);
 }

package/src/SchemaProcessor.ts

@@ -10,7 +10,7 @@ import {
   ModelRelationshipTypes,
   type InternalRelationalField,
 } from './ModelRelationalField';
-import type { InternalModel } from './ModelType';
+import type { InternalModel, DisableOperationsOptions } from './ModelType';
 import type { InternalModelIndexType } from './ModelIndex';
 import {
   type Authorization,
@@ -1455,7 +1455,13 @@ const schemaPreprocessor = (
 
       const joined = gqlFields.join('\n  ');
 
-      const model = `type ${typeName} @model ${authString}\n{\n  ${joined}\n}`;
+      const modelAttrs = modelAttributesFromDisabledOps(
+        typeDef.data.disabledOperations,
+      );
+
+      const modelDirective = modelAttrs ? `@model(${modelAttrs})` : '@model';
+
+      const model = `type ${typeName} ${modelDirective} ${authString}\n{\n  ${joined}\n}`;
       gqlModels.push(model);
     }
   }
@@ -2180,6 +2186,75 @@ function getModelRelationship(
   }
 }
 
+/**
+ *
+ * @param disabledOps
+ * @returns sanitized string @model directive attribute; can be passed in as-is
+ *
+ * @example
+ * ```ts
+ * const disabledOps = ["subscriptions", "create"];
+ * ```
+ * returns
+ * ```
+ * subscriptions:null,mutations:{create:null}
+ * ```
+ */
+function modelAttributesFromDisabledOps(
+  disabledOps: ReadonlyArray<DisableOperationsOptions>,
+) {
+  const fineCoarseMap: Record<string, string> = {
+    onCreate: 'subscriptions',
+    onUpdate: 'subscriptions',
+    onDelete: 'subscriptions',
+    create: 'mutations',
+    update: 'mutations',
+    delete: 'mutations',
+    list: 'queries',
+    get: 'queries',
+  };
+
+  const coarseGrainedOps = ['queries', 'mutations', 'subscriptions'];
+
+  const coarseFirstSorted = disabledOps
+    // disabledOps is readOnly; create a copy w/ slice
+    .slice()
+    .sort((a: DisableOperationsOptions, b: DisableOperationsOptions) => {
+      if (coarseGrainedOps.includes(a) && !coarseGrainedOps.includes(b)) {
+        return -1;
+      }
+
+      if (!coarseGrainedOps.includes(a) && coarseGrainedOps.includes(b)) {
+        return 1;
+      }
+
+      return 0;
+    });
+
+  const modelAttrs: Record<string, null | Record<string, null>> = {};
+
+  for (const op of coarseFirstSorted) {
+    if (coarseGrainedOps.includes(op)) {
+      modelAttrs[op] = null;
+      continue;
+    }
+
+    const coarseOp = fineCoarseMap[op];
+
+    if (modelAttrs[coarseOp] !== null) {
+      modelAttrs[coarseOp] = modelAttrs[coarseOp] || {};
+
+      modelAttrs[coarseOp]![op] = null;
+    }
+  }
+
+  const modelAttrsStr = JSON.stringify(modelAttrs)
+    .replace(/"/g, '') // remove quotes
+    .slice(1, -1); // drop outer curlies {}
+
+  return modelAttrsStr;
+}
+
 /**
  * Returns API definition from ModelSchema or string schema
  * @param arg - { schema }

package/src/runtime/addSchemaToClient.ts

@@ -8,6 +8,7 @@ import {
   generateCustomSubscriptionsProperty,
   generateEnumsProperty,
   generateModelsProperty,
+  upgradeClientCancellation,
 } from './internals';
 import {
   BaseClient,
@@ -20,6 +21,7 @@ export function addSchemaToClient<T extends Record<any, any> = never>(
   apiGraphqlConfig: GraphQLProviderConfig['GraphQL'],
   getInternals: ClientInternalsGetter,
 ): BaseClient & ClientExtensions<T> {
+  upgradeClientCancellation(client);
   (client as any).models = generateModelsProperty<T>(
     client as any,
     apiGraphqlConfig,

package/src/runtime/addSchemaToClientWithInstance.ts

@@ -10,6 +10,7 @@ import {
   generateCustomQueriesProperty,
   generateCustomMutationsProperty,
   generateEnumsProperty,
+  upgradeClientCancellation,
 } from './internals';
 import { generateModelsProperty as generateModelsPropertyServer } from './internals/server';
 import { BaseClient, ClientInternalsGetter } from './bridge-types';
@@ -24,6 +25,7 @@ export function addSchemaToClientWithInstance<T extends Record<any, any>>(
   const apiGraphqlConfig = params.config?.API?.GraphQL;
 
   if (isApiGraphQLConfig(apiGraphqlConfig)) {
+    upgradeClientCancellation(client);
     (client as any).models = generateModelsPropertyServer<T>(
       client as any,
       params,

package/src/runtime/bridge-types.ts

@@ -374,10 +374,10 @@ export type BaseSSRClient = {
 export type GraphQLMethod = (
   options: GraphQLOptions,
   additionalHeaders?: CustomHeaders | undefined,
-) => GraphQLResult | GraphqlSubscriptionResult;
+) => Promise<GraphQLResult> | GraphqlSubscriptionResult;
 
 export type GraphQLMethodSSR = (
   contextSpec: AmplifyServer.ContextSpec,
   options: GraphQLOptions,
   additionalHeaders?: CustomHeaders | undefined,
-) => GraphQLResult | GraphqlSubscriptionResult;
+) => Promise<GraphQLResult> | GraphqlSubscriptionResult;