skapi-js 2.0.0-rc.2 → 2.0.0-rc.4

package/dist/skapi.d.mts

@@ -1248,6 +1248,35 @@ declare class Skapi {
         statusCode: number;
         url: string;
     }>(params: Params[] | Form<Params>, url?: string): Promise<Response | Response[]>;
+    /**
+     * Relays a request to a destination of your choosing from the server side,
+     * with the service api key added where the browser cannot read it, and
+     * streams the destination's response back as it arrives.
+     *
+     * The body is relayed verbatim, so an html form reaches the destination as
+     * multipart/form-data, files included; the form's own enctype and method
+     * attributes are not used. Supply options.onStream to receive the response
+     * chunk by chunk. An error response throws a SkapiError either way; reading
+     * the status code or a response header needs options.responseType
+     * 'response'. options.signal stops the client receiving the response, it
+     * does not cancel the request already sent to the destination.
+     *
+     * @param form Form element, submit event, FormData, or a plain object. Sent to the destination verbatim.
+     * @param options Destination url, method, headers, and an optional onStream callback.
+     * @returns A promise that resolves to the destination's response.
+     */
+    forwardRequest(form: any, options: {
+        url: string;
+        method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD';
+        headers?: {
+            [key: string]: string;
+        };
+        apiKeyHeader?: string;
+        apiKeyScheme?: string;
+        onStream?: (chunk: string) => void;
+        signal?: AbortSignal;
+        responseType?: 'json' | 'text' | 'response';
+    }): Promise<any>;
     /**
      * Returns a normalized response object for form-based handler flows.
      * @returns A promise that resolves to Promise<any>.

package/dist/skapi.d.ts

@@ -1248,6 +1248,35 @@ declare class Skapi {
         statusCode: number;
         url: string;
     }>(params: Params[] | Form<Params>, url?: string): Promise<Response | Response[]>;
+    /**
+     * Relays a request to a destination of your choosing from the server side,
+     * with the service api key added where the browser cannot read it, and
+     * streams the destination's response back as it arrives.
+     *
+     * The body is relayed verbatim, so an html form reaches the destination as
+     * multipart/form-data, files included; the form's own enctype and method
+     * attributes are not used. Supply options.onStream to receive the response
+     * chunk by chunk. An error response throws a SkapiError either way; reading
+     * the status code or a response header needs options.responseType
+     * 'response'. options.signal stops the client receiving the response, it
+     * does not cancel the request already sent to the destination.
+     *
+     * @param form Form element, submit event, FormData, or a plain object. Sent to the destination verbatim.
+     * @param options Destination url, method, headers, and an optional onStream callback.
+     * @returns A promise that resolves to the destination's response.
+     */
+    forwardRequest(form: any, options: {
+        url: string;
+        method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD';
+        headers?: {
+            [key: string]: string;
+        };
+        apiKeyHeader?: string;
+        apiKeyScheme?: string;
+        onStream?: (chunk: string) => void;
+        signal?: AbortSignal;
+        responseType?: 'json' | 'text' | 'response';
+    }): Promise<any>;
     /**
      * Returns a normalized response object for form-based handler flows.
      * @returns A promise that resolves to Promise<any>.