@rest-vir/implement-service 0.18.1 → 0.19.1

package/dist/implementation/generic-service-implementation.d.ts

@@ -3,6 +3,7 @@ import { type EndpointDefinition, type EndpointPathBase, type GenericEndpointDef
 import { type ServiceLogger } from '../util/service-logger.js';
 import { type EndpointImplementation } from './implement-endpoint.js';
 import { type WebSocketImplementation } from './implement-web-socket.js';
+import { type PostHook } from './post-hook.js';
 import { type ContextInit } from './service-context-init.js';
 /**
  * A fully implemented endpoint.
@@ -30,6 +31,7 @@ export type GenericServiceImplementation = Omit<ServiceDefinition, 'endpoints' |
     createContext: ContextInit<any, any, any, any> | undefined;
     logger: ServiceLogger;
     customHeaders: string[];
+    postHook: PostHook | undefined;
 };
 /**
  * A fully implemented WebSocket.

package/dist/implementation/implement-endpoint.d.ts

@@ -4,6 +4,7 @@ import { type IncomingHttpHeaders, type OutgoingHttpHeaders } from 'node:http';
 import { type IsEqual, type IsNever } from 'type-fest';
 import { type ServerRequest, type ServerResponse } from '../util/data.js';
 import { type ServiceLogger } from '../util/service-logger.js';
+import { type ReplaceUndefinedWithEmptyObject } from '../util/types.js';
 /**
  * The part of {@link EndpointImplementationOutput} allowed for error responses.
  *
@@ -62,7 +63,7 @@ export type EndpointImplementationParams<Context = any, SpecificEndpoint extends
     request: ServerRequest;
     response: ServerResponse;
     log: Readonly<ServiceLogger>;
-    searchParams: SpecificEndpoint extends NoParam ? BaseSearchParams : Exclude<SpecificEndpoint, NoParam>['SearchParamsType'];
+    searchParams: ReplaceUndefinedWithEmptyObject<SpecificEndpoint extends NoParam ? BaseSearchParams : Exclude<SpecificEndpoint, NoParam>['SearchParamsType']>;
     /** The actual running server info. */
     server: RunningServerInfo;
 };

package/dist/implementation/implement-service.d.ts

@@ -5,6 +5,7 @@ import { type ServiceLogger, type ServiceLoggerOption } from '../util/service-lo
 import { type ImplementedEndpoint, type ImplementedWebSocket } from './generic-service-implementation.js';
 import { type EndpointImplementations } from './implement-endpoint.js';
 import { type WebSocketImplementations } from './implement-web-socket.js';
+import { type PostHook } from './post-hook.js';
 import { type ContextInit } from './service-context-init.js';
 /**
  * A user-defined endpoint error handler for service (and its endpoints) errors.
@@ -51,7 +52,13 @@ export type ServiceImplementationsParams<Context, ServiceName extends string, En
     webSockets?: never;
 } : {
     webSockets: WebSocketImplementations<NoInfer<Context>, NoInfer<ServiceName>, NoInfer<WebSocketsInit>>;
-});
+}) & {
+    /**
+     * Fired after every request resolves, before it is sent. This hooks into Fastify with the
+     * `onSend` hook.
+     */
+    postHook?: PostHook<Context, ServiceName, EndpointsInit, WebSocketsInit> | undefined;
+};
 /**
  * Creates an implemented service that is fully ready to be run as a server by attaching endpoint
  * implementations to the given {@link ServiceDefinition}.
@@ -62,7 +69,7 @@ export type ServiceImplementationsParams<Context, ServiceName extends string, En
  * @category Package : @rest-vir/implement-service
  * @package [`@rest-vir/implement-service`](https://www.npmjs.com/package/@rest-vir/implement-service)
  */
-export declare function implementService<const ServiceName extends string, const EndpointsInit extends BaseServiceEndpointsInit, const WebSocketsInit extends BaseServiceWebSocketsInit, Context = undefined>(
+export declare function implementService<const ServiceName extends string, EndpointsInit extends BaseServiceEndpointsInit, WebSocketsInit extends BaseServiceWebSocketsInit, Context = undefined>(
 /** Init must be first so that TypeScript can infer the type for `Context`. */
 { service, createContext, logger, customHeaders, }: ServiceImplementationInit<Context, ServiceName, EndpointsInit, WebSocketsInit>): (implementations: ServiceImplementationsParams<NoInfer<Context>, NoInfer<ServiceName>, NoInfer<EndpointsInit>, NoInfer<WebSocketsInit>>) => ServiceImplementation<NoInfer<Context>, ServiceName, EndpointsInit, WebSocketsInit>;
 /**
@@ -83,6 +90,7 @@ export type ServiceImplementation<Context = undefined, ServiceName extends strin
     createContext: ContextInit<Context, ServiceName, EndpointsInit, WebSocketsInit> | undefined;
     logger: ServiceLogger;
     customHeaders: string[];
+    postHook: PostHook | undefined;
 };
 /**
  * A type util that converts a {@link ServiceDefinition} instance type into its companion

package/dist/implementation/implement-service.js

@@ -16,7 +16,7 @@ import { assertValidWebSocketImplementations, } from './implement-web-socket.js'
 export function implementService(
 /** Init must be first so that TypeScript can infer the type for `Context`. */
 { service, createContext, logger, customHeaders, }) {
-    return ({ endpoints: endpointImplementations, webSockets: webSocketImplementations }) => {
+    return ({ endpoints: endpointImplementations, webSockets: webSocketImplementations, postHook, }) => {
         assertValidEndpointImplementations(service, endpointImplementations || {});
         assertValidWebSocketImplementations(service, webSocketImplementations || {});
         const endpoints = mapObjectValues(service.endpoints, (endpointPath, endpoint) => {
@@ -55,6 +55,7 @@ export function implementService(
             webSockets,
             createContext,
             logger: createServiceLogger(logger),
+            postHook: postHook || undefined,
         };
         Object.defineProperties(serviceImplementation, {
             ContextType: {

package/dist/implementation/post-hook.d.ts

@@ -0,0 +1,25 @@
+import { type HttpStatus, type MaybePromise, type Values } from '@augment-vir/common';
+import { type BaseServiceEndpointsInit, type BaseServiceWebSocketsInit, type EndpointPathBase, type NoParam, type WithFinalEndpointProps } from '@rest-vir/define-service';
+import { type EndpointImplementationOutput } from './implement-endpoint.js';
+import { type ContextInitParams } from './service-context-init.js';
+/**
+ * Params for {@link PostHook}.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/implement-service
+ * @package [`@rest-vir/implement-service`](https://www.npmjs.com/package/@rest-vir/implement-service)
+ */
+export type PostHookParams<Context = any, ServiceName extends string = any, EndpointsInit extends BaseServiceEndpointsInit | NoParam = NoParam, WebSocketsInit extends BaseServiceWebSocketsInit | NoParam = NoParam> = ContextInitParams<ServiceName, EndpointsInit, WebSocketsInit> & {
+    originalResponseData: EndpointsInit extends NoParam ? unknown : WithFinalEndpointProps<Values<EndpointsInit>, Extract<keyof EndpointsInit, EndpointPathBase>>['ResponseType'];
+    originalStatus: HttpStatus;
+    /** This will be `undefined` if your `createContext` method rejects the request. */
+    context: Context | undefined;
+};
+/**
+ * Type for `ServiceImplementationsParams.postHook`.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/implement-service
+ * @package [`@rest-vir/implement-service`](https://www.npmjs.com/package/@rest-vir/implement-service)
+ */
+export type PostHook<Context = any, ServiceName extends string = any, EndpointsInit extends BaseServiceEndpointsInit | NoParam = NoParam, WebSocketsInit extends BaseServiceWebSocketsInit | NoParam = NoParam> = (params: PostHookParams<Context, ServiceName, EndpointsInit, WebSocketsInit>) => MaybePromise<Partial<EndpointImplementationOutput> | undefined | void>;

package/dist/implementation/post-hook.js

@@ -0,0 +1 @@
+export {};

package/dist/implementation/service-context-init.d.ts

@@ -1,8 +1,9 @@
 import { type HttpMethod, type MaybePromise, type Values } from '@augment-vir/common';
-import { type BaseSearchParams, type BaseServiceEndpointsInit, type BaseServiceWebSocketsInit, type EndpointDefinition, type EndpointPathBase, type MinimalService, type NoParam, type WebSocketDefinition, type WithFinalEndpointProps, type WithFinalWebSocketProps } from '@rest-vir/define-service';
+import { type BaseSearchParams, type BaseServiceEndpointsInit, type BaseServiceWebSocketsInit, type EndpointDefinition, type EndpointPathBase, type MinimalService, type NoParam, type PathParams, type WebSocketDefinition, type WithFinalEndpointProps, type WithFinalWebSocketProps } from '@rest-vir/define-service';
 import { type IncomingHttpHeaders } from 'node:http';
 import { type RequireExactlyOne } from 'type-fest';
 import { type ServerRequest, type ServerResponse } from '../util/data.js';
+import { type ReplaceUndefinedWithEmptyObject } from '../util/types.js';
 import { type EndpointImplementationErrorOutput, type RunningServerInfo } from './implement-endpoint.js';
 /**
  * Output of {@link ContextInit}.
@@ -27,7 +28,7 @@ export type ContextInitOutput<Context> = RequireExactlyOne<{
  * @category Package : @rest-vir/implement-service
  * @package [`@rest-vir/implement-service`](https://www.npmjs.com/package/@rest-vir/implement-service)
  */
-export type ContextInit<Context, ServiceName extends string, EndpointsInit extends BaseServiceEndpointsInit | NoParam, WebSocketsInit extends BaseServiceWebSocketsInit | NoParam> = (params: Readonly<ContextInitParameters<ServiceName, EndpointsInit, WebSocketsInit>>) => MaybePromise<ContextInitOutput<Context>>;
+export type ContextInit<Context, ServiceName extends string, EndpointsInit extends BaseServiceEndpointsInit | NoParam, WebSocketsInit extends BaseServiceWebSocketsInit | NoParam> = (params: Readonly<ContextInitParams<ServiceName, EndpointsInit, WebSocketsInit>>) => MaybePromise<ContextInitOutput<Context>>;
 /**
  * Parameters for {@link ContextInit}.
  *
@@ -35,8 +36,9 @@ export type ContextInit<Context, ServiceName extends string, EndpointsInit exten
  * @category Package : @rest-vir/implement-service
  * @package [`@rest-vir/implement-service`](https://www.npmjs.com/package/@rest-vir/implement-service)
  */
-export type ContextInitParameters<ServiceName extends string = any, EndpointsInit extends BaseServiceEndpointsInit | NoParam = NoParam, WebSocketsInit extends BaseServiceWebSocketsInit | NoParam = NoParam> = {
-    searchParams: (WebSocketsInit extends NoParam ? BaseSearchParams | undefined : WithFinalWebSocketProps<Values<WebSocketsInit>, any>['SearchParamsType']) | (EndpointsInit extends NoParam ? BaseSearchParams | undefined : WithFinalEndpointProps<Values<EndpointsInit>, any>['SearchParamsType']);
+export type ContextInitParams<ServiceName extends string = any, EndpointsInit extends BaseServiceEndpointsInit | NoParam = NoParam, WebSocketsInit extends BaseServiceWebSocketsInit | NoParam = NoParam> = {
+    pathParams: EndpointsInit extends NoParam ? Readonly<Record<string, string>> : PathParams<WithFinalWebSocketProps<Values<WebSocketsInit>, any>['path']> extends string ? Readonly<Record<PathParams<WithFinalWebSocketProps<Values<WebSocketsInit>, any>['path']>, string>> : Readonly<Record<string, string>>;
+    searchParams: ReplaceUndefinedWithEmptyObject<(WebSocketsInit extends NoParam ? BaseSearchParams | undefined : WithFinalWebSocketProps<Values<WebSocketsInit>, any>['SearchParamsType']) | (EndpointsInit extends NoParam ? BaseSearchParams | undefined : WithFinalEndpointProps<Values<EndpointsInit>, any>['SearchParamsType'])>;
     service: MinimalService<ServiceName>;
     requestHeaders: IncomingHttpHeaders;
     method: HttpMethod;

package/dist/index.d.ts

@@ -3,7 +3,9 @@ export * from './implementation/generic-service-implementation.js';
 export * from './implementation/implement-endpoint.js';
 export * from './implementation/implement-service.js';
 export * from './implementation/implement-web-socket.js';
+export * from './implementation/post-hook.js';
 export * from './implementation/service-context-init.js';
 export * from './util/data.js';
 export * from './util/handler.error.js';
 export * from './util/service-logger.js';
+export * from './util/types.js';

package/dist/index.js

@@ -3,7 +3,9 @@ export * from './implementation/generic-service-implementation.js';
 export * from './implementation/implement-endpoint.js';
 export * from './implementation/implement-service.js';
 export * from './implementation/implement-web-socket.js';
+export * from './implementation/post-hook.js';
 export * from './implementation/service-context-init.js';
 export * from './util/data.js';
 export * from './util/handler.error.js';
 export * from './util/service-logger.js';
+export * from './util/types.js';

package/dist/util/types.d.ts

@@ -0,0 +1,10 @@
+import { type EmptyObject } from 'type-fest';
+/**
+ * Removes `undefined` unions from the given type and replaces it with `EmptyObject`. This is used
+ * specifically for SearchParamsType.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/implement-service
+ * @package [`@rest-vir/implement-service`](https://www.npmjs.com/package/@rest-vir/implement-service)
+ */
+export type ReplaceUndefinedWithEmptyObject<T> = T extends undefined ? Exclude<T, undefined> | EmptyObject : T;

package/dist/util/types.js

@@ -0,0 +1,2 @@
+/* node:coverage disable: this whole file is just types */
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rest-vir/implement-service",
-    "version": "0.18.1",
+    "version": "0.19.1",
     "description": "Implement a service defined by @rest-vir/define-service.",
     "keywords": [
         "rest",
@@ -39,17 +39,17 @@
         "test:update": "npm test update"
     },
     "dependencies": {
-        "@augment-vir/assert": "^31.16.0",
-        "@augment-vir/common": "^31.16.0",
-        "@rest-vir/define-service": "^0.18.1",
+        "@augment-vir/assert": "^31.19.1",
+        "@augment-vir/common": "^31.19.1",
+        "@rest-vir/define-service": "^0.19.1",
         "@types/ws": "^8.18.1",
-        "fastify": "^5.3.2",
+        "fastify": "^5.3.3",
         "path-to-regexp": "^8.2.0",
-        "type-fest": "^4.40.1"
+        "type-fest": "^4.41.0"
     },
     "devDependencies": {
-        "@augment-vir/test": "^31.16.0",
-        "@types/node": "^22.15.3",
+        "@augment-vir/test": "^31.19.1",
+        "@types/node": "^22.15.18",
         "c8": "^10.1.3",
         "istanbul-smart-text-reporter": "^1.1.5",
         "markdown-code-example-inserter": "^3.0.3",