@procedures/client 0.19.0 → 0.20.0

package/src/index.ts

@@ -4,37 +4,23 @@
  * Protocol-agnostic RPC client with middleware composition
  * and transport adapters.
  *
- * This entry point is for Node. It exports the browser-safe entry point
- * ("@procedures/client/browser"). It also exports the server transports, which use `http` and
- * `ws`, but these exports are deprecated (CLI-6 step 1). Their entry is "@procedures/client/node".
- * The next MINOR removes them from this entry, so the root imports no `http` and no `ws`.
+ * This entry point exports the browser-safe entry point ("@procedures/client/browser"), the URL
+ * strategies of the server and the browser checks of the server. It imports no Node built-in, no
+ * `ws` and no `express`, and its declarations name none of them (CLI-6, CLI-61). Thus a browser
+ * bundle can import it too. The server transports and the procedure faces of Node have the entry
+ * "@procedures/client/node".
  *
- * The `WebSocketTransport` of this entry uses the global `WebSocket`, because some applications
- * bundle this entry for a browser. The Node entry "@procedures/client/node" has a
- * `WebSocketTransport` whose sockets are of the `ws` package: a drop ends them at once.
+ * The `WebSocketTransport` of this entry uses the global `WebSocket`. The Node entry
+ * "@procedures/client/node" has a `WebSocketTransport` whose sockets are of the `ws` package: a
+ * drop ends them at once.
  */
 
 export * from "./browser.js";
 
 // ============================================================================
-// Server Transports (Node only)
+// The URL strategies and the browser checks of the server (browser-safe)
 // ============================================================================
 export { defaultServerUrlStrategy, rpcServerUrlStrategy } from "./adapters/http/server/strategies.js";
-// Deprecated (CLI-6 step 1): import these from "@procedures/client/node". The next MINOR removes
-// them from the root. ./server/index.ts holds the deprecated aliases, so an editor marks each old
-// import, and each alias is the same class or type as the export of ./node.
-export { HttpServerTransport } from "./server/index.js";
-export type {
-  HttpServerTransportOptions,
-  HttpUrlStrategy,
-} from "./server/index.js";
-export { WebSocketServerTransport } from "./server/index.js";
+export type { RoutedRequest } from "./adapters/http/server/strategies.js";
 export { checkBrowserRequest, hasAmbientCredentials, isLoopbackHost, isLoopbackAddress, hostNameOf } from "./server/browser-guard.js";
-export type { BrowserGuardOptions, GuardedRequest, GuardResult } from "./server/browser-guard.js";
-// Deprecated (CLI-6 step 1): import these from "@procedures/client/node"
-export type {
-  WebSocketServerTransportOptions,
-  WebSocketAuthHandler,
-  WebSocketConnectionHandler,
-  WebSocketMessage,
-} from "./server/index.js";
+export type { BrowserGuardOptions, GuardedHeaders, GuardedRequest, GuardResult } from "./server/browser-guard.js";

package/src/node.ts

@@ -19,10 +19,9 @@
  * (CLI-31). `urlAddressing()` is the default, and `bodyPathAddressing()` reads the path from the
  * body of a single endpoint.
  *
- * The server transports are in this entry too (CLI-6): `HttpServerTransport`, the Express shim
- * over `procedureHandler`, and `WebSocketServerTransport`. The root and `./server` also export
- * them, but these exports are deprecated. The next MINOR removes them, so the root imports no
- * `http` and no `ws`.
+ * The server transports are in this entry only (CLI-6): `HttpServerTransport`, the Express shim
+ * over `procedureHandler`, and `WebSocketServerTransport`. Thus the root and `./server` import no
+ * `http`, no `ws` and no `express`.
  */
 
 export { WebSocketTransport } from "./adapters/websocket/client/node.js";
@@ -36,12 +35,12 @@ export type { ProcedureHandlerOptions, NodeProcedureHandler, NodeUrlStrategy, Ur
 export type { CorsOptions, CredentialedCorsOptions } from "./adapters/http/server/cors.js";
 // The credentialed CORS of the trusted origins of a host, for a route of the app (CLI-49)
 export { credentialedCors } from "./adapters/http/server/cors.js";
-export type { RoutedRequest } from "./adapters/http/server/strategies.js";
+export type { RoutedRequest, UrlStrategyRequest } from "./adapters/http/server/strategies.js";
 export { defaultServerUrlStrategy, rpcServerUrlStrategy } from "./adapters/http/server/strategies.js";
 // The addressing of a request: the URL (the default), or the path in the body of a single endpoint (CLI-31)
 export { urlAddressing, bodyPathAddressing } from "./adapters/http/server/addressing.js";
 export type { Addressing, CallAddress, UrlAddressingOptions, BodyPathAddressingOptions } from "./adapters/http/server/addressing.js";
-// The server transports (CLI-6): the root and ./server export them only until the next MINOR
+// The server transports (CLI-6): only this entry exports them
 export { HttpServerTransport } from "./adapters/http/server/transport.js";
 export type { HttpServerTransportOptions, HttpUrlStrategy } from "./adapters/http/server/types.js";
 export { upgradeHandler } from "./adapters/websocket/server/upgrade.js";

package/src/server/browser-guard.ts

@@ -22,8 +22,6 @@
  * Each refusal is the error `FORBIDDEN` of wire v1, with the status 403 and a reason (CLI-4).
  */
 
-import type { IncomingHttpHeaders } from "node:http";
-
 const LOOPBACK_NAMES = new Set(["localhost", "127.0.0.1", "::1", "[::1]"]);
 
 /** The options of the browser checks of a server transport. */
@@ -48,10 +46,24 @@ export interface BrowserGuardOptions {
   allowGet?: boolean | undefined;
 }
 
-/** The parts of an incoming request that the checks read. */
+/**
+ * The headers of a request, by lower-case name. The type is structural, so the root names no Node
+ * module (CLI-61). `IncomingHttpHeaders` of `node:http` agrees with it.
+ */
+export interface GuardedHeaders {
+  readonly [name: string]: string | string[] | undefined;
+  readonly host?: string | undefined;
+  readonly origin?: string | undefined;
+  readonly cookie?: string | undefined;
+  readonly "content-type"?: string | undefined;
+  readonly "content-length"?: string | undefined;
+  readonly "transfer-encoding"?: string | undefined;
+}
+
+/** The parts of an incoming request that the checks read. An `IncomingMessage` of `node:http` agrees with it. */
 export interface GuardedRequest {
   method?: string | undefined;
-  headers: IncomingHttpHeaders;
+  headers: GuardedHeaders;
   socket?: { localAddress?: string | undefined } | undefined;
 }
 
@@ -121,7 +133,7 @@ function isJsonType(contentType: string | undefined): boolean {
 }
 
 /** True when the request has a body: a `Content-Length` above 0, or a chunked body. */
-function hasBody(headers: IncomingHttpHeaders): boolean {
+function hasBody(headers: GuardedHeaders): boolean {
   const length = Number(headers["content-length"] ?? 0);
   return length > 0 || headers["transfer-encoding"] !== undefined;
 }
@@ -130,7 +142,7 @@ function hasBody(headers: IncomingHttpHeaders): boolean {
  * True when a request carries ambient credentials: a `Cookie` header, which a browser sends by
  * itself, also for a request that another site starts.
  */
-export function hasAmbientCredentials(headers: IncomingHttpHeaders): boolean {
+export function hasAmbientCredentials(headers: GuardedHeaders): boolean {
   const cookie = headers.cookie;
   return typeof cookie === "string" && cookie.trim() !== "";
 }
@@ -143,7 +155,7 @@ export function hasAmbientCredentials(headers: IncomingHttpHeaders): boolean {
  *
  * @internal
  */
-export function needsNamedOrigin(mode: "always" | "cookies" | undefined, headers: IncomingHttpHeaders, cookiesNamed: boolean): boolean {
+export function needsNamedOrigin(mode: "always" | "cookies" | undefined, headers: GuardedHeaders, cookiesNamed: boolean): boolean {
   return mode === "always" || (hasAmbientCredentials(headers) && (cookiesNamed || mode !== undefined));
 }
 

package/src/server/index.ts

@@ -11,8 +11,8 @@
  * - Handler registry with pattern matching
  * - Graceful shutdown
  *
- * The server transports have the entry `@procedures/client/node` (CLI-6). This entry still
- * exports them as deprecated aliases. The next MINOR removes the aliases.
+ * The server transports have the entry `@procedures/client/node` (CLI-6). This entry imports no
+ * Node built-in, no `ws` and no `express`, and its declarations name none of them (CLI-61).
  *
  * @example
  * ```typescript
@@ -38,19 +38,6 @@
  * ```
  */
 
-import { HttpServerTransport as NodeHttpServerTransport } from "../adapters/http/server/transport.js";
-import type {
-  HttpServerTransportOptions as NodeHttpServerTransportOptions,
-  HttpUrlStrategy as NodeHttpUrlStrategy,
-} from "../adapters/http/server/types.js";
-import { WebSocketServerTransport as NodeWebSocketServerTransport } from "../adapters/websocket/server/transport.js";
-import type {
-  WebSocketServerTransportOptions as NodeWebSocketServerTransportOptions,
-  WebSocketAuthHandler as NodeWebSocketAuthHandler,
-  WebSocketConnectionHandler as NodeWebSocketConnectionHandler,
-  WebSocketMessage as NodeWebSocketMessage,
-} from "../adapters/websocket/server/types.js";
-
 export { Server } from "./server.js";
 export type { ServerOptions } from "./server.js";
 
@@ -77,78 +64,4 @@ export {
 } from "./types.js";
 
 export { defaultServerUrlStrategy, rpcServerUrlStrategy } from "../adapters/http/server/strategies.js";
-
-// ============================================================================
-// The server transports: deprecated here (CLI-6 step 1)
-// ============================================================================
-// Their entry is `@procedures/client/node`. This entry and the root (which re-exports these
-// names from this module) give them through deprecated aliases until the next MINOR, so an
-// editor marks each old import. Each alias is the same class or type as the export of ./node.
-
-/**
- * The HTTP server transport of Express, a shim over `procedureHandler`.
- *
- * @deprecated Import it from `@procedures/client/node`. The root and `@procedures/client/server` stop exporting it in the next MINOR (CLI-6).
- */
-export const HttpServerTransport: typeof NodeHttpServerTransport = NodeHttpServerTransport;
-/**
- * The HTTP server transport of Express, a shim over `procedureHandler`.
- *
- * @deprecated Import it from `@procedures/client/node`. The root and `@procedures/client/server` stop exporting it in the next MINOR (CLI-6).
- */
-export type HttpServerTransport = NodeHttpServerTransport;
-
-/**
- * The options of `HttpServerTransport`.
- *
- * @deprecated Import it from `@procedures/client/node`. The root and `@procedures/client/server` stop exporting it in the next MINOR (CLI-6).
- */
-export type HttpServerTransportOptions = NodeHttpServerTransportOptions;
-
-/**
- * The URL strategy of `HttpServerTransport`: it gives the method of an Express request.
- *
- * @deprecated Import it from `@procedures/client/node`. The root and `@procedures/client/server` stop exporting it in the next MINOR (CLI-6).
- */
-export type HttpUrlStrategy = NodeHttpUrlStrategy;
-
-/**
- * The WebSocket server transport, on the `ws` package.
- *
- * @deprecated Import it from `@procedures/client/node`. The root and `@procedures/client/server` stop exporting it in the next MINOR (CLI-6).
- */
-export const WebSocketServerTransport: typeof NodeWebSocketServerTransport = NodeWebSocketServerTransport;
-/**
- * The WebSocket server transport, on the `ws` package.
- *
- * @deprecated Import it from `@procedures/client/node`. The root and `@procedures/client/server` stop exporting it in the next MINOR (CLI-6).
- */
-export type WebSocketServerTransport = NodeWebSocketServerTransport;
-
-/**
- * The options of `WebSocketServerTransport`.
- *
- * @deprecated Import it from `@procedures/client/node`. The root and `@procedures/client/server` stop exporting it in the next MINOR (CLI-6).
- */
-export type WebSocketServerTransportOptions = NodeWebSocketServerTransportOptions;
-
-/**
- * The authentication handler of `WebSocketServerTransport`, for each upgrade request.
- *
- * @deprecated Import it from `@procedures/client/node`. The root and `@procedures/client/server` stop exporting it in the next MINOR (CLI-6).
- */
-export type WebSocketAuthHandler = NodeWebSocketAuthHandler;
-
-/**
- * The connection handler of `WebSocketServerTransport`, for each new connection.
- *
- * @deprecated Import it from `@procedures/client/node`. The root and `@procedures/client/server` stop exporting it in the next MINOR (CLI-6).
- */
-export type WebSocketConnectionHandler = NodeWebSocketConnectionHandler;
-
-/**
- * The RPC message of `WebSocketServerTransport`.
- *
- * @deprecated Import it from `@procedures/client/node`. The root and `@procedures/client/server` stop exporting it in the next MINOR (CLI-6).
- */
-export type WebSocketMessage<TReq = unknown> = NodeWebSocketMessage<TReq>;
+export type { RoutedRequest } from "../adapters/http/server/strategies.js";