@rest-vir/define-service 1.3.4 → 1.5.0

package/dist/endpoint/endpoint.d.ts

@@ -104,7 +104,7 @@ export declare const endpointInitShape: Shape<{
     }> | import("@sinclair/typebox").TUnsafe<RegExp> | import("@sinclair/typebox").TString | import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TUnsafe<() => void> | import("@sinclair/typebox").TArray<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TUnsafe<{
         anyOrigin: boolean;
     }> | import("@sinclair/typebox").TUnsafe<RegExp> | import("@sinclair/typebox").TString | import("@sinclair/typebox").TUnsafe<() => void>)[]>>)[]>>>;
-    methods: import("@sinclair/typebox").TUnsafe<Partial<Record<HttpMethod, boolean>>>;
+    methods: Shape<import("@sinclair/typebox").TUnsafe<Partial<Record<HttpMethod, boolean>>>>;
     bypassResponseValidation: Shape<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TBoolean | import("@sinclair/typebox").TNull | import("@sinclair/typebox").TUndefined)[]>>>;
     customProps: Shape<import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<(import("@sinclair/typebox").TUndefined | import("@sinclair/typebox").TUnsafe<Record<never, unknown>>)[]>>>;
 }>;

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

@@ -18,6 +18,8 @@ export type GenericFetchEndpointParams = PartialWithUndefined<GenericPathParams>
     bypassResponseValidation?: undefined | boolean;
     method?: HttpMethod | undefined;
     options?: Omit<RequestInit, 'body' | 'method'> | undefined;
+    /** If `true`, Skip automatic request data `'Content-Type'` header assignment. */
+    skipAutomaticContentType?: boolean | undefined;
     /**
      * A custom fetch implementation. Useful for debugging or unit testing. This can safely be
      * omitted to use the default JavaScript built-in global `fetch` function.
@@ -32,6 +34,15 @@ export type GenericFetchEndpointParams = PartialWithUndefined<GenericPathParams>
  * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
  */
 export type FetchMethod<EndpointToFetch extends Pick<EndpointDefinition, 'methods'>> = IsEqual<KeyCount<Record<ExtractKeysWithMatchingValues<EndpointToFetch['methods'], true>, boolean>>, 1> extends true ? never : Extract<HttpMethod, ExtractKeysWithMatchingValues<EndpointToFetch['methods'], true>> | `${Extract<HttpMethod, ExtractKeysWithMatchingValues<EndpointToFetch['methods'], true>>}`;
+/**
+ * Properties from {@link GenericFetchEndpointParams} that are also used in
+ * {@link FetchEndpointParams}.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/define-service
+ * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
+ */
+export type GenericFetchEndpointKeysAllowedInSpecificParams = 'options' | 'bypassResponseValidation' | 'skipAutomaticContentType';
 /**
  * All type safe parameters for sending a request to an endpoint using {@link fetchEndpoint}.
  *
@@ -64,7 +75,7 @@ export type FetchEndpointParams<EndpointToFetch extends SelectFrom<EndpointDefin
     method?: never;
 } : {
     method: FetchMethod<EndpointToFetch>;
-}) & (AllowFetchMock extends true ? Pick<GenericFetchEndpointParams, 'options' | 'fetch' | 'bypassResponseValidation'> : Pick<GenericFetchEndpointParams, 'options' | 'bypassResponseValidation'>)> : GenericFetchEndpointParams;
+}) & (AllowFetchMock extends true ? Pick<GenericFetchEndpointParams, 'fetch' | GenericFetchEndpointKeysAllowedInSpecificParams> : Pick<GenericFetchEndpointParams, GenericFetchEndpointKeysAllowedInSpecificParams>)> : GenericFetchEndpointParams;
 /**
  * Type safe output from sending a request to an endpoint definition. Used by {@link fetchEndpoint}.
  *
@@ -84,7 +95,10 @@ export type FetchEndpointOutput<EndpointToFetch extends Readonly<SelectFrom<Endp
     response: Readonly<Response>;
 }> | Readonly<{
     ok: false;
-    data: string | undefined;
+    data: EndpointToFetch extends SelectFrom<EndpointDefinition, {
+        requestDataShape: true;
+        responseDataShape: true;
+    }> ? EndpointExecutorData<EndpointToFetch>['response'] | string | undefined : any;
     response: Readonly<Response>;
 }>;
 /**
@@ -172,7 +186,7 @@ export declare function buildEndpointRequestInit<const EndpointToFetch extends R
         serviceOrigin: true;
         serviceName: true;
     };
-}>, ...[{ method, options, pathParams, requestData, searchParams, wildcard },]: CollapsedFetchEndpointParams<EndpointToFetch, false>): {
+}>, ...[{ method, options, pathParams, requestData, searchParams, wildcard, skipAutomaticContentType, },]: CollapsedFetchEndpointParams<EndpointToFetch, false>): {
     url: string;
     requestInit: RequestInit;
 };

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

@@ -1,6 +1,6 @@
 import { check } from '@augment-vir/assert';
 import { addPrefix, filterMap, getObjectTypedEntries, HttpMethod, mapObject, } from '@augment-vir/common';
-import { assertValidShape } from 'object-shape-tester';
+import { assertValidShape, checkWrapValidShape } from 'object-shape-tester';
 import { buildUrl } from 'url-vir';
 import { parseJsonWithUndefined } from '../augments/json.js';
 function defaultFetch(...[url, requestInit,]) {
@@ -64,10 +64,11 @@ export async function fetchEndpoint(endpoint, ...params) {
     const { requestInit, url } = buildEndpointRequestInit(endpoint, ...params);
     /* node:coverage ignore next: all tests mock fetch so we're never going to have a fallback here. */
     const response = await (fetch || defaultFetch)(url, requestInit, endpoint);
+    const responseText = await response.clone().text();
+    const responseData = endpoint.responseDataShape
+        ? parseJsonWithUndefined(responseText)
+        : undefined;
     if (response.ok) {
-        const responseData = endpoint.responseDataShape
-            ? parseJsonWithUndefined(await response.text())
-            : undefined;
         if (endpoint.responseDataShape && !bypassResponseValidation) {
             assertValidShape(responseData, endpoint.responseDataShape, { allowExtraKeys: true });
         }
@@ -78,10 +79,16 @@ export async function fetchEndpoint(endpoint, ...params) {
         };
     }
     else {
+        const validResponseData = endpoint.responseDataShape
+            ? bypassResponseValidation
+                ? responseData
+                : checkWrapValidShape(responseData, endpoint.responseDataShape, {
+                    allowExtraKeys: true,
+                })
+            : undefined;
         return {
             ok: false,
-            /** This will be an error message. */
-            data: (await response.text()) || undefined,
+            data: validResponseData || responseText || undefined,
             response,
         };
     }
@@ -93,7 +100,7 @@ export async function fetchEndpoint(endpoint, ...params) {
  * @category Package : @rest-vir/define-service
  * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
  */
-export function buildEndpointRequestInit(endpoint, ...[{ method, options = {}, pathParams, requestData, searchParams, wildcard } = {},]) {
+export function buildEndpointRequestInit(endpoint, ...[{ method, options = {}, pathParams, requestData, searchParams, wildcard, skipAutomaticContentType, } = {},]) {
     const headers = mapObject(options.headers instanceof Headers
         ? Object.fromEntries(options.headers.entries())
         : check.isArray(options.headers)
@@ -105,11 +112,11 @@ export function buildEndpointRequestInit(endpoint, ...[{ method, options = {}, p
         };
     });
     if (!headers['content-type']) {
-        if (requestData instanceof FormData) {
+        if (requestData instanceof FormData || skipAutomaticContentType) {
             /**
-             * Do not set `content-type` manually when submitting form data because the browser will
-             * set it automatically _and_ include a boundary in the content type, which is needed
-             * for reading the form data properly.
+             * Do not set `content-type` manually when submitting form data because `fetch` will set
+             * it automatically _and_ include a boundary in the content type, which is needed for
+             * reading the form data properly.
              */
         }
         else if (requestData) {

package/dist/service/minimal-service.d.ts

@@ -9,7 +9,7 @@ import { type OriginRequirement } from '../util/origin.js';
  * @category Package : @rest-vir/define-service
  * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
  */
-export type MinimalService<ServiceName extends string = string> = {
+export type MinimalService<ServiceName extends string = any> = {
     serviceName: IsEqual<ServiceName, ''> extends true ? never : ServiceName;
     /**
      * The origin at which the service will be hosted. Fetch requests and WebSocket connections will

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rest-vir/define-service",
-    "version": "1.3.4",
+    "version": "1.5.0",
     "description": "Define an connect to a declarative and type safe REST and WebSocket service.",
     "keywords": [
         "rest",
@@ -40,14 +40,14 @@
         "test:update": "npm test update"
     },
     "dependencies": {
-        "@augment-vir/assert": "^31.51.1",
-        "@augment-vir/common": "^31.51.1",
-        "date-vir": "^8.0.0",
-        "type-fest": "^5.2.0",
-        "url-vir": "^2.1.6"
+        "@augment-vir/assert": "^31.59.1",
+        "@augment-vir/common": "^31.59.1",
+        "date-vir": "^8.1.0",
+        "type-fest": "^5.4.3",
+        "url-vir": "^2.1.7"
     },
     "devDependencies": {
-        "@augment-vir/test": "^31.51.1",
+        "@augment-vir/test": "^31.59.1",
         "@web/dev-server-esbuild": "^1.0.4",
         "@web/test-runner": "^0.20.2",
         "@web/test-runner-commands": "^0.9.0",
@@ -55,9 +55,9 @@
         "@web/test-runner-visual-regression": "^0.10.0",
         "istanbul-smart-text-reporter": "^1.1.5",
         "markdown-code-example-inserter": "^3.0.3",
-        "object-shape-tester": "^6.9.3",
-        "typedoc": "^0.28.14",
-        "ws": "^8.18.3"
+        "object-shape-tester": "^6.11.0",
+        "typedoc": "^0.28.16",
+        "ws": "^8.19.0"
     },
     "peerDependencies": {
         "object-shape-tester": ">=5"