@rest-vir/define-service 0.21.0 → 0.22.1

package/dist/endpoint/endpoint.d.ts

@@ -41,6 +41,11 @@ export type EndpointInit<AllowedMethods extends RequireAtLeastOne<Record<HttpMet
      * - Any other set value overrides the service's origin requirement (if it has any).
      */
     requiredClientOrigin?: OriginRequirement;
+    /**
+     * Set this to `true` to bypass shape validation. You might want to use this, for example, for
+     * large data sets that are being slow.
+     */
+    bypassResponseValidation?: boolean | undefined;
     /**
      * A shape used to verify search params. This should match the entire search params object.
      *
@@ -102,6 +107,7 @@ export declare const endpointInitShape: ShapeDefinition<{
         values: boolean;
         required: false;
     }]>;
+    bypassResponseValidation: import("object-shape-tester").ShapeOptional<import("object-shape-tester").ShapeOr<[undefined, null, boolean]>>;
     customProps: import("object-shape-tester").ShapeOptional<import("object-shape-tester").ShapeOr<[undefined, import("object-shape-tester").ShapeIndexedKeys<[{
         keys: import("object-shape-tester").ShapeUnknown<[unknown]>;
         values: import("object-shape-tester").ShapeUnknown<[unknown]>;

package/dist/endpoint/endpoint.js

@@ -28,6 +28,7 @@ export const endpointInitShape = defineShape({
         values: false,
         required: false,
     }),
+    bypassResponseValidation: optional(or(undefined, null, false)),
     customProps: optional(or(undefined, indexedKeys({
         keys: unknownShape(),
         values: unknownShape(),

package/dist/frontend-connect/fetch-endpoint.d.ts

@@ -16,6 +16,7 @@ export type GenericFetchEndpointParams = {
     pathParams?: Record<string, string> | undefined;
     requestData?: any;
     searchParams?: BaseSearchParams | undefined;
+    bypassResponseValidation?: undefined | boolean;
     method?: HttpMethod | undefined;
     options?: Omit<RequestInit, 'body' | 'method'> | undefined;
     /**
@@ -72,7 +73,7 @@ export type FetchEndpointParams<EndpointToFetch extends SelectFrom<EndpointDefin
     method?: never;
 } : {
     method: FetchMethod<EndpointToFetch>;
-}) & (AllowFetchMock extends true ? Pick<GenericFetchEndpointParams, 'options' | 'fetch'> : Pick<GenericFetchEndpointParams, 'options'>)> : GenericFetchEndpointParams;
+}) & (AllowFetchMock extends true ? Pick<GenericFetchEndpointParams, 'options' | 'fetch' | 'bypassResponseValidation'> : Pick<GenericFetchEndpointParams, 'options' | 'bypassResponseValidation'>)> : GenericFetchEndpointParams;
 /**
  * Type safe output from sending a request to an endpoint definition. Used by {@link fetchEndpoint}.
  *

package/dist/frontend-connect/fetch-endpoint.js

@@ -52,7 +52,7 @@ function filterToValidMethod(endpoint, chosenMethod) {
  * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
  */
 export async function fetchEndpoint(endpoint, ...params) {
-    const { requestData, fetch } = params[0] || {};
+    const { requestData, fetch, bypassResponseValidation } = params[0] || {};
     if (requestData) {
         if (endpoint.requestDataShape) {
             assertValidShape(requestData, endpoint.requestDataShape, { allowExtraKeys: true });
@@ -68,7 +68,7 @@ export async function fetchEndpoint(endpoint, ...params) {
         const responseData = endpoint.responseDataShape
             ? parseJsonWithUndefined(await response.text())
             : undefined;
-        if (endpoint.responseDataShape) {
+        if (endpoint.responseDataShape && !bypassResponseValidation) {
             assertValidShape(responseData, endpoint.responseDataShape, { allowExtraKeys: true });
         }
         return {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rest-vir/define-service",
-    "version": "0.21.0",
+    "version": "0.22.1",
     "description": "Define an connect to a declarative and type safe REST and WebSocket service.",
     "keywords": [
         "rest",