@travetto/web-rpc 6.0.1 → 6.0.3

package/README.md

@@ -13,7 +13,7 @@ npm install @travetto/web-rpc
 yarn add @travetto/web-rpc
 ```
 
-This module allows for a highly focused scenario, of supporting RPC operations within a [Web API](https://github.com/travetto/travetto/tree/main/module/web#readme "Declarative api for Web Applications with support for the dependency injection.") application.  The module takes care of producing the appropriate handler for the RPC commands along with the ability to generate the appropriate client to be used to interact with the RPC functionality.  The generated client uses Proxy-based objects, along with [Typescript](https://typescriptlang.org) magic to create a dynamic client that does not rely on generating a lot of code.
+This module allows for a highly focused scenario, of supporting RPC operations within a [Web API](https://github.com/travetto/travetto/tree/main/module/web#readme "Declarative support for creating Web Applications") application.  The module takes care of producing the appropriate handler for the RPC commands along with the ability to generate the appropriate client to be used to interact with the RPC functionality.  The generated client uses Proxy-based objects, along with [Typescript](https://typescriptlang.org) magic to create a dynamic client that does not rely on generating a lot of code.
 
 ## CLI - web:rpc-client
 The library will create the RPC client in one of three flavors: fetch, fetch + node, angular.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/web-rpc",
-  "version": "6.0.1",
+  "version": "6.0.3",
   "description": "RPC support for a Web Application",
   "keywords": [
     "web",
@@ -26,9 +26,9 @@
     "directory": "module/web-rpc"
   },
   "dependencies": {
-    "@travetto/config": "^6.0.0",
-    "@travetto/schema": "^6.0.0",
-    "@travetto/web": "^6.0.1"
+    "@travetto/config": "^6.0.1",
+    "@travetto/schema": "^6.0.1",
+    "@travetto/web": "^6.0.3"
   },
   "travetto": {
     "displayName": "Web RPC Support"

package/src/controller.ts

@@ -3,7 +3,7 @@ import { Any, AppError, Util } from '@travetto/runtime';
 import {
   HeaderParam, Controller, Undocumented, ExcludeInterceptors, ControllerRegistry,
   WebAsyncContext, Body, EndpointUtil, BodyInterceptor, Post, WebCommonUtil,
-  RespondInterceptor, DecompressInterceptor
+  RespondInterceptor, DecompressInterceptor, Get
 } from '@travetto/web';
 
 @Controller('/rpc')
@@ -19,6 +19,14 @@ export class WebRpcController {
   @Inject()
   ctx: WebAsyncContext;
 
+  /**
+   * Allow for get-based requests
+   */
+  @Get('/:target')
+  async onGetRequest(target: string, @HeaderParam('X-TRV-RPC-INPUTS') paramInput?: string): Promise<unknown> {
+    return this.onRequest(target, paramInput);
+  }
+
   /**
    * RPC main entrypoint
    */

package/support/client/rpc.ts

@@ -25,6 +25,8 @@ export type RpcRequest = {
     timeout?: number;
     retriesOnConnectFailure?: number;
     path?: string;
+    controller?: string;
+    endpoint?: string;
   };
   url: URL | string;
   consumeJSON?: <T>(text?: unknown) => (T | Promise<T>);
@@ -72,11 +74,21 @@ function buildRequest<T extends RequestInit>(base: T, controller: string, endpoi
   return {
     ...base,
     method: 'POST',
-    path: `${controller}:${endpoint}`
+    path: `${controller}:${endpoint}`,
+    controller,
+    endpoint
   };
 }
 
-export function getBody(inputs: unknown[]): { body: FormData | string, headers: Record<string, string> } {
+export function getBody(inputs: unknown[], isBodyRequest: boolean): { body: FormData | string | undefined, headers: Record<string, string> } {
+  if (!isBodyRequest) {
+    return {
+      body: undefined,
+      headers: {
+        'X-TRV-RPC-INPUTS': btoa(encodeURIComponent(JSON.stringify(inputs)))
+      }
+    };
+  }
   // If we do not have a blob, simple output
   if (!inputs.some(isBlobLike)) {
     return {
@@ -147,8 +159,10 @@ export async function invokeFetch<T>(request: RpcRequest, ...params: unknown[]):
   let core = request.core!;
 
   try {
-    const { body, headers } = getBody(params);
-    core.body = body;
+    const { body, headers } = getBody(params, /^(post|put|patch)$/i.test(request.core?.method ?? 'POST'));
+    if (body) {
+      core.body = body;
+    }
     core.headers = extendHeaders(core.headers, headers);
 
     for (const fn of request.preRequestHandlers ?? []) {