@aws-amplify/data-schema 0.16.0 → 0.16.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/data-schema",
-  "version": "0.16.0",
+  "version": "0.16.2",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
@@ -34,6 +34,7 @@
     },
     "./runtime": {
       "types": "./dist/esm/runtime/index.d.ts",
+      "types@<5": "./dist/esm/runtime/index.v3.d.ts",
       "import": "./dist/esm/runtime/index.mjs",
       "require": "./dist/cjs/runtime/index.js",
       "node": "./dist/esm/index.mjs"

package/runtime/package.json

@@ -1,8 +1,20 @@
 {
   "name": "@aws-amplify/data-schema/runtime",
   "main": "../dist/cjs/runtime/index.js",
+  "typings": "./defer-to-types-versions",
   "module": "../dist/esm/runtime/index.mjs",
-  "types": "../dist/esm/runtime/index.d.ts",
   "react-native": "../src/runtime/index.ts",
-  "sideEffects": false
+  "sideEffects": false,
+  "typesVersions": {
+    "<5": {
+      "defer-to-types-versions": [
+        "../dist/esm/runtime/index.v3.d.ts"
+      ]
+    },
+    ">=5": {
+      "defer-to-types-versions": [
+        "../dist/esm/runtime/index.d.ts"
+      ]
+    }
+  }
 }

package/src/MappedTypes/CustomOperations.ts

@@ -7,7 +7,7 @@ import type {
 import type { ModelField } from '../ModelField';
 import type { RefType, RefTypeParamShape } from '../RefType';
 import type {
-  ResolveCustomTypeFieldsRequirements,
+  ResolveFieldRequirements,
   ResolveRefsOfCustomType,
   ResolveRefValueArrayTraits,
 } from './ResolveFieldProperties';
@@ -66,7 +66,7 @@ export type CustomOpShapes<Schema extends GenericModelSchema<any>> = {
 export type CustomOpArguments<Shape extends CustomOperationParamShape> =
   Shape['arguments'] extends null
     ? never
-    : {
+    : ResolveFieldRequirements<{
         [FieldName in keyof Shape['arguments']]: Shape['arguments'][FieldName] extends ModelField<
           infer R,
           any,
@@ -74,7 +74,7 @@ export type CustomOpArguments<Shape extends CustomOperationParamShape> =
         >
           ? R
           : never;
-      };
+      }>;
 
 /**
  * Computes the return type from the `returnType` of a custom operation shape.
@@ -106,12 +106,12 @@ export type CustomOpReturnType<
       ? R
       : Shape['returnType'] extends CustomType<infer R>
         ?
-            | ResolveCustomTypeFieldsRequirements<
+            | ResolveFieldRequirements<
                 FieldTypesOfCustomType<{
                   thisCustomType: R['fields'];
                 }>['thisCustomType']
               > // The inline `.customType()` with a custom operation doesn't have
-              // `.required()` modifier, hence it's nullable
+            // `.required()` modifier, hence it's nullable
             | null
         : never;
 
@@ -237,20 +237,21 @@ export type CustomOperationHandlerTypes<
  *
  * (Custom handlers should not return lazy loaded fields -- they're *lazy loaded*.)
  */
-type LambdaReturnType<T> = T extends Record<string, any>
-  ? {
-      // Return type can include `null | undefined`, which we can't meaningfully
-      // map over.
-      [K in keyof Exclude<T, null | undefined> as Exclude<
-        T,
-        null | undefined
-      >[K] extends (...args: any) => any
-        ? never
-        : K]: Exclude<T, null | undefined>[K];
-    }
-  :
-      | T
-      // If the original return type allowed null | undefined, mix them back into
-      // the final return type
-      | (null extends T ? null : never)
-      | (undefined extends T ? undefined : never);
+type LambdaReturnType<T> =
+  T extends Record<string, any>
+    ? {
+        // Return type can include `null | undefined`, which we can't meaningfully
+        // map over.
+        [K in keyof Exclude<T, null | undefined> as Exclude<
+          T,
+          null | undefined
+        >[K] extends (...args: any) => any
+          ? never
+          : K]: Exclude<T, null | undefined>[K];
+      }
+    :
+        | T
+        // If the original return type allowed null | undefined, mix them back into
+        // the final return type
+        | (null extends T ? null : never)
+        | (undefined extends T ? undefined : never);

package/src/MappedTypes/ResolveFieldProperties.ts

@@ -138,10 +138,10 @@ export type ResolveRefsOfCustomType<
     ? ResolveRef<NonModelTypes, R>
     : T[Prop];
 } extends infer Resolved
-  ? ResolveCustomTypeFieldsRequirements<Resolved>
+  ? ResolveFieldRequirements<Resolved>
   : never;
 
-export type ResolveCustomTypeFieldsRequirements<Resolved> = Intersection<
+export type ResolveFieldRequirements<Resolved> = Intersection<
   ExtractNullableFieldsToOptionalFields<Resolved>,
   ExtractNonNullableFieldsToRequiredFields<Resolved>
 >;

package/src/runtime/bridge-types.ts

@@ -355,7 +355,7 @@ export type ClientInternals = {
   headers: CustomHeaders | undefined;
 };
 
-export type ClientInternalsGetter = (client: any) => ClientInternals;
+export type ClientInternalsGetter = (client: BaseClient) => ClientInternals;
 
 export type BaseClient = BaseBrowserClient | BaseSSRClient;
 

package/src/runtime/client/index.v3.ts

@@ -31,6 +31,17 @@ export type CustomHeaders =
   | Record<string, string>
   | (() => Promise<Record<string, string>>);
 
+/**
+ * Request options that are passed to custom header functions.
+ * `method` and `headers` are not included in custom header functions passed to
+ * subscriptions.
+ */
+export type RequestOptions = {
+  url: string;
+  queryString: string;
+  method?: string;
+};
+
 export type CustomQueries<
   Schema extends Record<any, any>,
   _Context extends string = 'CLIENT',
@@ -50,3 +61,38 @@ export type CustomSubscriptions<
 > = any;
 
 export type ModelSortDirection = 'ASC' | 'DESC';
+
+export type ClientExtensions<T extends Record<any, any> = never> = {
+  models: ModelTypes<T>;
+  enums: EnumTypes<T>;
+  queries: CustomQueries<T, 'CLIENT'>;
+  mutations: CustomMutations<T, 'CLIENT'>;
+  subscriptions: CustomSubscriptions<T, 'CLIENT'>;
+};
+
+export type ClientExtensionsSSRRequest<T extends Record<any, any> = never> = {
+  models: ModelTypes<T, 'REQUEST'>;
+  enums: EnumTypes<T>;
+  queries: CustomQueries<T, 'REQUEST'>;
+  mutations: CustomMutations<T, 'REQUEST'>;
+};
+
+export type ClientExtensionsSSRCookies<T extends Record<any, any> = never> = {
+  models: ModelTypes<T, 'COOKIES'>;
+  enums: EnumTypes<T>;
+  queries: CustomQueries<T, 'COOKIES'>;
+  mutations: CustomMutations<T, 'COOKIES'>;
+};
+
+export type ClientInternals = {
+  amplify: any;
+  authMode: any;
+  authToken: string | undefined;
+  headers: CustomHeaders | undefined;
+};
+
+export type BaseClient = {
+  graphql(...args: any): Promise<Record<string, any>>;
+  cancel(promise: Promise<any>, message?: string): boolean;
+  isCancelError(error: any): boolean;
+};

package/src/runtime/index.v3.ts

@@ -2,6 +2,11 @@
 // SPDX-License-Identifier: Apache-2.0
 
 export * from './client/index.v3';
-export { addSchemaToClient } from './addSchemaToClient';
-export { addSchemaToClientWithInstance } from './addSchemaToClientWithInstance';
-export { BaseClient, ClientInternals } from './bridge-types';
+export declare function addSchemaToClient<_T extends Record<any, any> = never>(
+  client: any,
+  apiGraphqlConfig: any,
+  getInternals: any,
+): any;
+export declare function addSchemaToClientWithInstance<
+  _T extends Record<any, any>,
+>(client: any, params: any, getInternals: any): any;