@zuplo/graphql 5.1602.0 → 5.1603.0

package/index.d.ts

@@ -538,7 +538,14 @@ declare type Modify<T, R> = Omit<T, keyof R> & R;
  * @beta
  */
 declare interface OnResponseSendingFinalHook {
-    (response: Response, latestRequest: ZuploRequest, context: ZuploContext): Promise<void> | void;
+    (response: Response, request: ZuploRequest, context: ZuploContext): Promise<void> | void;
+}
+
+/**
+ * @beta
+ */
+declare interface OnResponseSendingHook {
+    (response: Response, request: ZuploRequest, context: ZuploContext): Promise<Response> | Response;
 }
 
 /**
@@ -557,13 +564,41 @@ declare interface ParameterDefinition extends ParameterBaseObject {
 }
 
 /**
- * @beta
+ * The types of the properties in a request
+ * @public
+ */
+declare interface RequestGeneric extends RequestInitGeneric {
+    Query?: RequestQueryDefault;
+}
+
+/**
+ * The types of the properties in a request init object
+ * @public
  */
-declare interface RequestUser<TUserData = any> {
+declare interface RequestInitGeneric {
+    UserData?: UserDataDefault;
+    Params?: RequestParamsDefault;
+}
+
+declare type RequestParamsDefault = Record<string, string>;
+
+declare type RequestQueryDefault = Record<string, string>;
+
+/**
+ * The authorized identity on the incoming request
+ * @public
+ */
+declare interface RequestUser<TUserData> {
     sub: string;
     data: TUserData;
 }
 
+declare type ResolveRequestParams<TParams extends RequestParamsDefault | undefined> = TParams extends RequestParamsDefault ? TParams : RequestParamsDefault;
+
+declare type ResolveRequestQuery<TQuery extends RequestQueryDefault | undefined> = TQuery extends RequestQueryDefault ? TQuery : RequestQueryDefault;
+
+declare type ResolveUserData<TUserData extends UserDataDefault | undefined> = TUserData extends UserDataDefault ? TUserData : UserDataDefault;
+
 /**
  * @beta
  */
@@ -597,6 +632,8 @@ declare interface RouteConfiguration extends Omit<BuildRouteConfiguration, "raw"
     raw<T>(): T;
 }
 
+declare type UserDataDefault = any;
+
 /**
  * @beta
  */
@@ -617,6 +654,10 @@ declare interface ZuploContext extends EventTarget {
     readonly incomingRequestProperties: IncomingRequestProperties;
     readonly invokeInboundPolicy: (policyName: string, request: ZuploRequest) => Promise<Response | ZuploRequest>;
     readonly waitUntil: (promise: Promise<any>) => void;
+    /**
+     * Fires just before the response is sent. Response can be modified.
+     */
+    readonly addResponseSendingHook: (hook: OnResponseSendingHook) => void;
     /**
      * Fires immediately after the response is sent. Response cannot be modified.
      */
@@ -648,12 +689,11 @@ declare interface ZuploContext extends EventTarget {
  * ZuploRequest includes various parsed objects from the
  * incoming Request. This object inherits from the web
  * standard {@link https://developer.mozilla.org/en-US/docs/Web/API/Request | Request}.
- *
- * @beta
+ * @public
  */
-declare class ZuploRequest<TUserData = any, TParams extends Record<string, string> = Record<string, string>, TQuery extends Record<string, string> = Record<string, string>> extends Request {
+declare class ZuploRequest<TOptions extends RequestGeneric = RequestGeneric> extends Request {
     #private;
-    constructor(input: string | Request, init?: ZuploRequestInit<TUserData, TParams>);
+    constructor(input: string | Request, init?: ZuploRequestInit<TOptions>);
     /**
      * A dictionary of query-string values
      *
@@ -667,7 +707,7 @@ declare class ZuploRequest<TUserData = any, TParams extends Record<string, strin
      *
      * @readonly
      */
-    get query(): Readonly<TQuery>;
+    get query(): Readonly<ResolveRequestQuery<TOptions["Query"]>>;
     /**
      * If you use tokens in your route’s URL, they are
      * automatically parsed into properties on the params
@@ -683,7 +723,7 @@ declare class ZuploRequest<TUserData = any, TParams extends Record<string, strin
      * ```
      * @readonly
      */
-    get params(): Readonly<TParams>;
+    get params(): Readonly<ResolveRequestParams<TOptions["Params"]>>;
     /**
      * An optional object identifying a ‘user’.
      *
@@ -698,12 +738,16 @@ declare class ZuploRequest<TUserData = any, TParams extends Record<string, strin
      *
      * @readonly
      */
-    user?: RequestUser<TUserData>;
+    user?: RequestUser<ResolveUserData<TOptions["UserData"]>>;
 }
 
-declare interface ZuploRequestInit<TUserData = any, TParams extends Record<string, string> = Record<string, string>> extends RequestInit {
-    params?: TParams;
-    user?: RequestUser<TUserData>;
+/**
+ * The initialization values of a request
+ * @public
+ */
+declare interface ZuploRequestInit<TOptions extends RequestInitGeneric = RequestInitGeneric> extends RequestInit {
+    params?: ResolveRequestParams<TOptions["Params"]>;
+    user?: ResolveUserData<TOptions["UserData"]>;
 }
 
 export { }