@travetto/web-rpc 6.0.2 → 7.0.0-rc.0

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.2",
+  "version": "7.0.0-rc.0",
   "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.2"
+    "@travetto/config": "^7.0.0-rc.0",
+    "@travetto/schema": "^7.0.0-rc.0",
+    "@travetto/web": "^7.0.0-rc.0"
   },
   "travetto": {
     "displayName": "Web RPC Support"

package/src/controller.ts

@@ -1,7 +1,8 @@
 import { Inject } from '@travetto/di';
 import { Any, AppError, Util } from '@travetto/runtime';
+import { IsPrivate } from '@travetto/schema';
 import {
-  HeaderParam, Controller, Undocumented, ExcludeInterceptors, ControllerRegistry,
+  HeaderParam, Controller, ExcludeInterceptors, ControllerRegistryIndex,
   WebAsyncContext, Body, EndpointUtil, BodyInterceptor, Post, WebCommonUtil,
   RespondInterceptor, DecompressInterceptor, Get
 } from '@travetto/web';
@@ -13,7 +14,7 @@ import {
   val instanceof RespondInterceptor ||
   val.category === 'global'
 ))
-@Undocumented()
+@IsPrivate()
 export class WebRpcController {
 
   @Inject()
@@ -32,7 +33,7 @@ export class WebRpcController {
    */
   @Post('/:target')
   async onRequest(target: string, @HeaderParam('X-TRV-RPC-INPUTS') paramInput?: string, @Body() body?: Any): Promise<unknown> {
-    const endpoint = ControllerRegistry.getEndpointById(target);
+    const endpoint = ControllerRegistryIndex.getEndpointConfigById(target);
 
     if (!endpoint || !endpoint.filter) {
       throw new AppError('Unknown endpoint', { category: 'notfound' });
@@ -48,7 +49,7 @@ export class WebRpcController {
     } else if (Array.isArray(body)) { // Params passed via body
       params = body;
 
-      const bodyParamIdx = endpoint.params.findIndex((x) => x.location === 'body');
+      const bodyParamIdx = endpoint.parameters.findIndex((x) => x.location === 'body');
       if (bodyParamIdx >= 0) { // Re-assign body
         request.body = params[bodyParamIdx];
       }
@@ -58,7 +59,7 @@ export class WebRpcController {
       params = [];
     }
 
-    const final = endpoint.params.map((x, i) => (x.location === 'body' && paramInput) ? EndpointUtil.MissingParamSymbol : params[i]);
+    const final = endpoint.parameters.map((x, i) => (x.location === 'body' && paramInput) ? EndpointUtil.MissingParamSymbol : params[i]);
     WebCommonUtil.setRequestParams(request, final);
 
     // Dispatch

package/src/service.ts

@@ -2,14 +2,16 @@ import path from 'node:path';
 import fs from 'node:fs/promises';
 
 import { Inject, Injectable } from '@travetto/di';
-import { ControllerRegistry } from '@travetto/web';
+import { ControllerRegistryIndex } from '@travetto/web';
 import { Runtime, RuntimeIndex } from '@travetto/runtime';
 import { ManifestModuleUtil } from '@travetto/manifest';
+import { Registry } from '@travetto/registry';
+import { SchemaRegistryIndex } from '@travetto/schema';
 
 import { clientFactory } from '../support/client/rpc.ts';
 import { WebRpcClient, WebRpcConfig } from './config.ts';
 
-@Injectable({ autoCreate: !Runtime.production })
+@Injectable({ autoInject: !Runtime.production })
 export class WebRpcClientGeneratorService {
 
   @Inject()
@@ -21,16 +23,16 @@ export class WebRpcClientGeneratorService {
     if (!this.config.clients.length || !Runtime.dynamic) {
       return;
     }
-    ControllerRegistry.on(() => this.render());
+    Registry.onClassChange(() => this.render(), ControllerRegistryIndex);
   }
 
   async #getClasses(relativeTo: string): Promise<{ name: string, import: string }[]> {
-    return ControllerRegistry.getClasses()
+    return ControllerRegistryIndex.getClasses()
       .filter(x => {
         const entry = RuntimeIndex.getEntry(Runtime.getSourceFile(x));
         return entry && entry.role === 'std';
       })
-      .filter(x => ControllerRegistry.get(x).documented !== false)
+      .filter(x => SchemaRegistryIndex.getConfig(x).private !== true)
       .map(x => {
         const imp = ManifestModuleUtil.withOutputExtension(Runtime.getImport(x));
         const base = Runtime.workspaceRelative(RuntimeIndex.manifest.build.typesFolder);

package/support/cli.web_rpc-client.ts

@@ -2,8 +2,8 @@ import path from 'node:path';
 
 import { Env } from '@travetto/runtime';
 import { CliCommand, CliCommandShape, CliValidationResultError } from '@travetto/cli';
-import { DependencyRegistry } from '@travetto/di';
-import { RootRegistry } from '@travetto/registry';
+import { DependencyRegistryIndex } from '@travetto/di';
+import { Registry } from '@travetto/registry';
 import { Ignore } from '@travetto/schema';
 
 import type { WebRpcClient } from '../src/config.ts';
@@ -24,7 +24,7 @@ export class CliWebRpcCommand implements CliCommandShape {
   }
 
   get #service(): Promise<WebRpcClientGeneratorService> {
-    return RootRegistry.init().then(() => DependencyRegistry.getInstance(WebRpcClientGeneratorService));
+    return Registry.init().then(() => DependencyRegistryIndex.getInstance(WebRpcClientGeneratorService));
   }
 
   async main(type: WebRpcClient['type'] | 'config', output?: string): Promise<void> {

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,7 +74,9 @@ function buildRequest<T extends RequestInit>(base: T, controller: string, endpoi
   return {
     ...base,
     method: 'POST',
-    path: `${controller}:${endpoint}`
+    path: `${controller}:${endpoint}`,
+    controller,
+    endpoint
   };
 }