@rest-vir/define-service 0.7.0 → 0.8.0

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

@@ -97,19 +97,28 @@ export function buildEndpointRequestInit(endpoint, ...[{ method, options = {}, p
             ? Object.fromEntries(options.headers)
             : options.headers || {};
     const hasContentTypeHeader = Object.keys(headers).some((headerKey) => headerKey.toLowerCase() === 'content-type');
-    if (!hasContentTypeHeader && check.isObject(requestData)) {
-        headers['content-type'] = 'application/json';
+    if (!hasContentTypeHeader) {
+        if (requestData instanceof FormData) {
+            headers['content-type'] = 'multipart/form-data';
+        }
+        else if (check.isObject(requestData)) {
+            headers['content-type'] = 'application/json';
+        }
     }
     const url = buildEndpointUrl(endpoint, { pathParams });
     const requestInit = {
         ...options,
         headers,
         method: filterToValidMethod(endpoint, method),
-        ...(requestData
+        ...(requestData instanceof FormData
             ? {
-                body: JSON.stringify(requestData),
+                body: requestData,
             }
-            : {}),
+            : requestData
+                ? {
+                    body: JSON.stringify(requestData),
+                }
+                : {}),
     };
     return {
         url,

package/dist/index.d.ts

@@ -13,6 +13,7 @@ export * from './service/match-url.js';
 export * from './service/minimal-service.js';
 export * from './service/service-definition.error.js';
 export * from './service/service-definition.js';
+export * from './util/custom-shapes.js';
 export * from './util/mock-fetch.js';
 export * from './util/no-param.js';
 export * from './util/origin.js';

package/dist/index.js

@@ -13,6 +13,7 @@ export * from './service/match-url.js';
 export * from './service/minimal-service.js';
 export * from './service/service-definition.error.js';
 export * from './service/service-definition.js';
+export * from './util/custom-shapes.js';
 export * from './util/mock-fetch.js';
 export * from './util/no-param.js';
 export * from './util/origin.js';

package/dist/util/custom-shapes.d.ts

@@ -0,0 +1,37 @@
+/**
+ * A custom shape definition for requests that require `FormData` as the body.
+ *
+ * @category Define Service
+ * @category Package : @rest-vir/define-service
+ * @example
+ *
+ * ```ts
+ * import {defineService, formDataShape, AnyOrigin, HttpMethod} from '@rest-vir/define-shape';
+ *
+ * export const myService = defineService({
+ *     serviceName: 'my-service',
+ *     serviceOrigin: 'https://example.com',
+ *     requiredClientOrigin: AnyOrigin,
+ *     endpoints: {
+ *         '/my-endpoint': {
+ *             methods: {
+ *                 [HttpMethod.Post]: true,
+ *             },
+ *             requestDataShape: formDataShape,
+ *             responseDataShape: undefined,
+ *         },
+ *     },
+ * });
+ * ```
+ *
+ * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
+ */
+export declare const formDataShape: import("object-shape-tester").CustomSpecifier<FormData>;
+/**
+ * Check if the input is a shape definition for {@link formDataShape}.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/define-service
+ * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
+ */
+export declare function isFormDataShape(shape: unknown): boolean;

package/dist/util/custom-shapes.js

@@ -0,0 +1,54 @@
+import { customShape, isCustomSpecifier, isShapeDefinition } from 'object-shape-tester';
+/**
+ * A custom shape definition for requests that require `FormData` as the body.
+ *
+ * @category Define Service
+ * @category Package : @rest-vir/define-service
+ * @example
+ *
+ * ```ts
+ * import {defineService, formDataShape, AnyOrigin, HttpMethod} from '@rest-vir/define-shape';
+ *
+ * export const myService = defineService({
+ *     serviceName: 'my-service',
+ *     serviceOrigin: 'https://example.com',
+ *     requiredClientOrigin: AnyOrigin,
+ *     endpoints: {
+ *         '/my-endpoint': {
+ *             methods: {
+ *                 [HttpMethod.Post]: true,
+ *             },
+ *             requestDataShape: formDataShape,
+ *             responseDataShape: undefined,
+ *         },
+ *     },
+ * });
+ * ```
+ *
+ * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
+ */
+export const formDataShape = customShape({
+    customName: 'FormData',
+    checker(value) {
+        return value instanceof FormData;
+    },
+    defaultValue: new FormData(),
+});
+/**
+ * Check if the input is a shape definition for {@link formDataShape}.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/define-service
+ * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
+ */
+export function isFormDataShape(shape) {
+    if (isShapeDefinition(shape)) {
+        return isFormDataShape(shape.shape);
+    }
+    else if (isCustomSpecifier(shape)) {
+        return shape.customName === formDataShape.customName;
+    }
+    else {
+        return false;
+    }
+}

package/package.json

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