Merge pull request #53 from aws-amplify/tb-headers

aws-amplify · Nov 11, 2023 · 8c653be · 8c653be
2 parents 19391ae + 7d9ec1c
commit 8c653be
Show file tree

Hide file tree

Showing 4 changed files with 74 additions and 12 deletions.
diff --git a/.changeset/cool-clocks-sell.md b/.changeset/cool-clocks-sell.md
@@ -0,0 +1,5 @@
+---
+'@aws-amplify/data-schema-types': minor
+---
+
+add types for custom headers
diff --git a/packages/data-schema-types/src/client/index.ts b/packages/data-schema-types/src/client/index.ts
@@ -360,10 +360,12 @@ export type LazyLoader<Model, IsArray extends boolean> = (
         authToken?: string;
         limit?: number;
         nextToken?: string | null;
+        headers?: CustomHeaders;
       }
     : {
         authMode?: AuthMode;
         authToken?: string;
+        headers?: CustomHeaders;
       },
 ) => IsArray extends true
   ? ListReturnValue<Prettify<Model>>
@@ -454,17 +456,29 @@ type ModelTypesClient<
 > = {
   create: (
     model: Prettify<MutationInput<Model, ModelMeta>>,
-    options?: { authMode?: AuthMode; authToken?: string },
+    options?: {
+      authMode?: AuthMode;
+      authToken?: string;
+      headers?: CustomHeaders;
+    },
   ) => SingularReturnValue<Model>;
   update: (
     model: Prettify<
       ModelIdentifier<ModelMeta> & Partial<MutationInput<Model, ModelMeta>>
     >,
-    options?: { authMode?: AuthMode; authToken?: string },
+    options?: {
+      authMode?: AuthMode;
+      authToken?: string;
+      headers?: CustomHeaders;
+    },
   ) => SingularReturnValue<Model>;
   delete: (
     identifier: ModelIdentifier<ModelMeta>,
-    options?: { authMode?: AuthMode; authToken?: string },
+    options?: {
+      authMode?: AuthMode;
+      authToken?: string;
+      headers?: CustomHeaders;
+    },
   ) => SingularReturnValue<Model>;
   get<
     FlatModel extends Record<string, unknown> = ResolvedModel<Model>,
@@ -475,6 +489,7 @@ type ModelTypesClient<
       selectionSet?: SelectionSet;
       authMode?: AuthMode;
       authToken?: string;
+      headers?: CustomHeaders;
     },
   ): SingularReturnValue<ReturnValue<Model, FlatModel, SelectionSet>>;
   list<
@@ -487,6 +502,7 @@ type ModelTypesClient<
     selectionSet?: SelectionSet;
     authMode?: AuthMode;
     authToken?: string;
+    headers?: CustomHeaders;
   }): ListReturnValue<ReturnValue<Model, FlatModel, SelectionSet>>;
   onCreate<
     FlatModel extends Record<string, unknown> = ResolvedModel<Model>,
@@ -530,17 +546,29 @@ type ModelTypesSSRCookies<
 > = {
   create: (
     model: Prettify<MutationInput<Model, ModelMeta>>,
-    options?: { authMode?: AuthMode; authToken?: string },
+    options?: {
+      authMode?: AuthMode;
+      authToken?: string;
+      headers?: CustomHeaders;
+    },
   ) => SingularReturnValue<Model>;
   update: (
     model: Prettify<
       ModelIdentifier<ModelMeta> & Partial<MutationInput<Model, ModelMeta>>
     >,
-    options?: { authMode?: AuthMode; authToken?: string },
+    options?: {
+      authMode?: AuthMode;
+      authToken?: string;
+      headers?: CustomHeaders;
+    },
   ) => SingularReturnValue<Model>;
   delete: (
     identifier: ModelIdentifier<ModelMeta>,
-    options?: { authMode?: AuthMode; authToken?: string },
+    options?: {
+      authMode?: AuthMode;
+      authToken?: string;
+      headers?: CustomHeaders;
+    },
   ) => SingularReturnValue<Model>;
   get<
     FlatModel extends Record<string, unknown> = ResolvedModel<Model>,
@@ -551,6 +579,7 @@ type ModelTypesSSRCookies<
       selectionSet?: SelectionSet;
       authMode?: AuthMode;
       authToken?: string;
+      headers?: CustomHeaders;
     },
   ): SingularReturnValue<ReturnValue<Model, FlatModel, SelectionSet>>;
   list<
@@ -563,6 +592,7 @@ type ModelTypesSSRCookies<
     selectionSet?: SelectionSet;
     authMode?: AuthMode;
     authToken?: string;
+    headers?: CustomHeaders;
   }): ListReturnValue<ReturnValue<Model, FlatModel, SelectionSet>>;
 };
 
@@ -574,19 +604,31 @@ type ModelTypesSSRRequest<
     // TODO: actual type
     contextSpec: any,
     model: Prettify<MutationInput<Model, ModelMeta>>,
-    options?: { authMode?: AuthMode; authToken?: string },
+    options?: {
+      authMode?: AuthMode;
+      authToken?: string;
+      headers?: CustomHeaders;
+    },
   ) => SingularReturnValue<Model>;
   update: (
     contextSpec: any,
     model: Prettify<
       ModelIdentifier<ModelMeta> & Partial<MutationInput<Model, ModelMeta>>
     >,
-    options?: { authMode?: AuthMode; authToken?: string },
+    options?: {
+      authMode?: AuthMode;
+      authToken?: string;
+      headers?: CustomHeaders;
+    },
   ) => SingularReturnValue<Model>;
   delete: (
     contextSpec: any,
     identifier: ModelIdentifier<ModelMeta>,
-    options?: { authMode?: AuthMode; authToken?: string },
+    options?: {
+      authMode?: AuthMode;
+      authToken?: string;
+      headers?: CustomHeaders;
+    },
   ) => SingularReturnValue<Model>;
   get<
     FlatModel extends Record<string, unknown> = ResolvedModel<Model>,
@@ -598,6 +640,7 @@ type ModelTypesSSRRequest<
       selectionSet?: SelectionSet;
       authMode?: AuthMode;
       authToken?: string;
+      headers?: CustomHeaders;
     },
   ): SingularReturnValue<ReturnValue<Model, FlatModel, SelectionSet>>;
   list<
@@ -612,6 +655,7 @@ type ModelTypesSSRRequest<
       selectionSet?: SelectionSet;
       authMode?: AuthMode;
       authToken?: string;
+      headers?: CustomHeaders;
     },
   ): ListReturnValue<ReturnValue<Model, FlatModel, SelectionSet>>;
 };
@@ -635,3 +679,9 @@ export type ModelTypes<
       : never
     : never;
 };
+
+/**
+ * Custom headers that can be passed either to the client or to individual
+ * calls, either as a static object or a function that returns a promise.
+ */
+export type CustomHeaders = Record<string, string> | (() => Promise<Headers>);
diff --git a/packages/data-schema-types/src/client/index.v3.ts b/packages/data-schema-types/src/client/index.v3.ts
@@ -13,3 +13,9 @@ export type ModelTypes<
 > = any;
 
 export type SelectionSet<_Model, _Path> = any;
+
+/**
+ * Custom headers that can be passed either to the client or to individual
+ * calls, either as a static object or a function that returns a promise.
+ */
+export type CustomHeaders = Record<string, string> | (() => Promise<Headers>);
diff --git a/packages/data-schema-types/tsconfig.json b/packages/data-schema-types/tsconfig.json
@@ -1,9 +1,10 @@
 {
   "extends": "../../tsconfig.base.json",
   "compilerOptions": {
-    "rootDir": "src", 
-    "outDir": "lib-esm", 
+    "rootDir": "src",
+    "outDir": "lib-esm",
     "declaration": true,
     "emitDeclarationOnly": true,
-  },
+    "lib": ["DOM"]
+  }
 }