@rest-vir/define-service 1.3.3 → 1.4.0

package/dist/frontend-connect/connect-web-socket.d.ts

@@ -1,4 +1,5 @@
 import { type RequiredKeysOf, type SelectFrom } from '@augment-vir/common';
+import { type BaseSearchParams } from '@rest-vir/define-service';
 import { type ConstructPathParams } from '../endpoint/endpoint-path.js';
 import { type NoParam } from '../util/no-param.js';
 import { type CommonWebSocket } from '../web-socket/common-web-socket.js';
@@ -55,9 +56,9 @@ export type ConnectWebSocketParams<WebSocketToConnect extends Readonly<SelectFro
 } : {
     protocols: WebSocketToConnect['ProtocolsType'];
 }) & (WebSocketToConnect['searchParamsShape'] extends undefined ? {
-    searchParams?: Record<string, string[]>;
+    searchParams?: BaseSearchParams | undefined;
 } : {
-    searchParams: WebSocketToConnect['SearchParamsType'] & Record<string, string[]>;
+    searchParams: WebSocketToConnect['SearchParamsType'] & BaseSearchParams;
 });
 /**
  * Collapsed version of {@link ConnectWebSocketParams} for {@link connectWebSocket} that only

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}.
  *
@@ -45,9 +56,9 @@ export type FetchEndpointParams<EndpointToFetch extends SelectFrom<EndpointDefin
     responseDataShape: true;
     methods: true;
 }>, AllowFetchMock extends boolean = true> = EndpointToFetch extends EndpointDefinition ? Readonly<ConstructPathParams<EndpointToFetch['path']> & (EndpointToFetch['SearchParamsType'] extends undefined ? {
-    searchParams?: Record<string, string[]> | undefined;
+    searchParams?: BaseSearchParams | undefined;
 } : {
-    searchParams: EndpointToFetch['SearchParamsType'] & Record<string, string[]>;
+    searchParams: EndpointToFetch['SearchParamsType'] & BaseSearchParams;
 }) & (EndpointExecutorData<EndpointToFetch>['request'] extends undefined ? {
     /**
      * This endpoint does not accept any request data, so there is none to be
@@ -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}.
  *
@@ -172,7 +183,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

@@ -93,7 +93,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 +105,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.3",
+    "version": "1.4.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.55.0",
+        "@augment-vir/common": "^31.55.0",
+        "date-vir": "^8.1.0",
+        "type-fest": "^5.3.1",
+        "url-vir": "^2.1.7"
     },
     "devDependencies": {
-        "@augment-vir/test": "^31.51.1",
+        "@augment-vir/test": "^31.55.0",
         "@web/dev-server-esbuild": "^1.0.4",
         "@web/test-runner": "^0.20.2",
         "@web/test-runner-commands": "^0.9.0",
@@ -55,8 +55,8 @@
         "@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",
+        "object-shape-tester": "^6.10.1",
+        "typedoc": "^0.28.15",
         "ws": "^8.18.3"
     },
     "peerDependencies": {