@arrirpc/codegen-ts 0.76.3 → 0.77.0

package/README.md

@@ -6,13 +6,13 @@
 
 ```ts
 // arri.config.ts
-import { defineConfig, generators } from "arri";
+import { defineConfig, generators } from 'arri';
 
 export default defineConfig({
     generators: [
         generators.typescriptClient({
-            clientName: "MyClient",
-            outputFile: "./client/src/myClient.g.ts",
+            clientName: 'MyClient',
+            outputFile: './client/src/myClient.g.ts',
         }),
     ],
 });
@@ -20,11 +20,14 @@ export default defineConfig({
 
 **Options:**
 
-| Name                  | Description                                          |
-| --------------------- | ---------------------------------------------------- |
-| clientName (required) | The name of the generated client                     |
-| outputFile (required) | Path to a file that will be created by the generator |
-| prettierOptions       | Formatting options for the generated code            |
+| Name                  | Description                                                |
+| --------------------- | ---------------------------------------------------------- |
+| outputFile (required) | Path to a file that will be created by the generator       |
+| clientName            | The name of the generated client                           |
+| typePrefix            | Add a prefix to the generated type names                   |
+| rootService           | Set the root service of the generated client               |
+| prettierOptions       | Formatting options for the generated code                  |
+| rpcGenerators         | Override the default function used for creating procedures |
 
 ### 2) Install the TS client library
 
@@ -44,13 +47,13 @@ pnpm i --save @arrirpc/client
 
 ```ts
 // This will match whatever you put in the arri config
-import { MyClient } from "./myClient.g";
+import { MyClient } from './myClient.g';
 
 const client = new MyClient({
-    baseUrl: "https://example.com",
+    baseUrl: 'https://example.com',
     headers: () => {
         return {
-            Authorization: "<some-token>",
+            Authorization: '<some-token>',
         };
     },
     // optional
@@ -67,13 +70,13 @@ The root client will be a class containing all of the services and procedures in
 For example if we have a some procedures grouped under `"users"` we can import just that service like so.
 
 ```ts
-import { MyClientUsersService } from "./myClient.g";
+import { MyClientUsersService } from './myClient.g';
 
 const usersService = new MyClientUsersService({
-    baseUrl: "https://example.com",
+    baseUrl: 'https://example.com',
     headers: () => {
         return {
-            Authorization: "<some-token>",
+            Authorization: '<some-token>',
         };
     },
 });
@@ -87,14 +90,14 @@ All generated types and serializers/parsers can be imported from the generated c
 
 ```ts
 // import the user type and the user helper
-import { type User, $$User } from "./myClient.g";
+import { type User, $$User } from './myClient.g';
 
 const bob: User = {
     // field
 };
 
 $$User.serialize(bob); // outputs valid JSON
-$$User.parse("<some-json-string>"); // outputs a User
+$$User.parse('<some-json-string>'); // outputs a User
 ```
 
 # Development

package/dist/index.cjs

@@ -1109,7 +1109,7 @@ const typescriptClientGenerator = codegenUtils.defineGeneratorPlugin(
 async function createTypescriptClient(def, options) {
   const types = [];
   const context = {
-    clientName: options.clientName,
+    clientName: options.clientName ?? "Client",
     typePrefix: options.typePrefix ?? "",
     generatedTypes: [],
     instancePath: "",
@@ -1121,7 +1121,10 @@ async function createTypescriptClient(def, options) {
     },
     rpcGenerators: options.rpcGenerators ?? {}
   };
-  const serviceDefinitions = codegenUtils.unflattenProcedures(def.procedures);
+  const serviceDefinitions = codegenUtils.unflattenProcedures(
+    def.procedures,
+    options.rootService
+  );
   const mainService = tsServiceFromDefinition(serviceDefinitions, context);
   for (const key of Object.keys(def.definitions)) {
     const typeDef = def.definitions[key];

package/dist/index.d.cts

@@ -32,24 +32,50 @@ interface CodegenContext {
         sse: boolean;
         ws: boolean;
     };
-    rpcGenerators: Record<string, RpcGenerator>;
+    rpcGenerators: Partial<Record<string, RpcGenerator>>;
 }
 declare function getJsDocComment(metadata: Schema['metadata']): string;
 declare function validVarName(name: string): string;
 declare function getTsTypeName(schema: Schema, context: CodegenContext): string;
 
 interface TypescriptGeneratorOptions {
-    clientName: string;
+    /**
+     * Defaults to 'Client'
+     */
+    clientName?: string;
     outputFile: string;
+    /**
+     * Add a prefix to the generated types
+     */
     typePrefix?: string;
+    /**
+     * Set the root service of the generated client
+     *
+     * __Example:__
+     *
+     * Given the following procedures:
+     * - users.getUser
+     * - users.updateUser
+     * - posts.getPost
+     * - posts.updatePosts
+     *
+     * Setting the rootService to `posts` means the generated client will only have the following procedures:
+     * - getPost
+     * - updatePosts
+     */
+    rootService?: string;
+    /**
+     * Options for how to format the outputted typescript code
+     */
     prettierOptions?: Omit<prettier.Config, 'parser'>;
     /**
      * Override the default functions used for creating procedures
      */
-    rpcGenerators?: Record<RpcDefinition['transport'], RpcGenerator>;
+    rpcGenerators?: Partial<Record<RpcDefinition['transport'], RpcGenerator>>;
 }
 declare const typescriptClientGenerator: _arrirpc_codegen_utils.GeneratorPlugin<TypescriptGeneratorOptions>;
 declare function createTypescriptClient(def: AppDefinition, options: TypescriptGeneratorOptions): Promise<string>;
 declare function tsTypeFromSchema(schema: Schema, context: CodegenContext): TsProperty;
 
-export { type CodegenContext, type RpcGenerator, type TsProperty, type TypescriptGeneratorOptions, createTypescriptClient, defineRpcGenerator, getJsDocComment, getRpcKey, getTsTypeName, httpRpcFromDefinition, tsRpcFromDefinition, tsTypeFromSchema, typescriptClientGenerator, validVarName, wsRpcFromDefinition };
+export { createTypescriptClient, defineRpcGenerator, getJsDocComment, getRpcKey, getTsTypeName, httpRpcFromDefinition, tsRpcFromDefinition, tsTypeFromSchema, typescriptClientGenerator, validVarName, wsRpcFromDefinition };
+export type { CodegenContext, RpcGenerator, TsProperty, TypescriptGeneratorOptions };

package/dist/index.d.mts

@@ -32,24 +32,50 @@ interface CodegenContext {
         sse: boolean;
         ws: boolean;
     };
-    rpcGenerators: Record<string, RpcGenerator>;
+    rpcGenerators: Partial<Record<string, RpcGenerator>>;
 }
 declare function getJsDocComment(metadata: Schema['metadata']): string;
 declare function validVarName(name: string): string;
 declare function getTsTypeName(schema: Schema, context: CodegenContext): string;
 
 interface TypescriptGeneratorOptions {
-    clientName: string;
+    /**
+     * Defaults to 'Client'
+     */
+    clientName?: string;
     outputFile: string;
+    /**
+     * Add a prefix to the generated types
+     */
     typePrefix?: string;
+    /**
+     * Set the root service of the generated client
+     *
+     * __Example:__
+     *
+     * Given the following procedures:
+     * - users.getUser
+     * - users.updateUser
+     * - posts.getPost
+     * - posts.updatePosts
+     *
+     * Setting the rootService to `posts` means the generated client will only have the following procedures:
+     * - getPost
+     * - updatePosts
+     */
+    rootService?: string;
+    /**
+     * Options for how to format the outputted typescript code
+     */
     prettierOptions?: Omit<prettier.Config, 'parser'>;
     /**
      * Override the default functions used for creating procedures
      */
-    rpcGenerators?: Record<RpcDefinition['transport'], RpcGenerator>;
+    rpcGenerators?: Partial<Record<RpcDefinition['transport'], RpcGenerator>>;
 }
 declare const typescriptClientGenerator: _arrirpc_codegen_utils.GeneratorPlugin<TypescriptGeneratorOptions>;
 declare function createTypescriptClient(def: AppDefinition, options: TypescriptGeneratorOptions): Promise<string>;
 declare function tsTypeFromSchema(schema: Schema, context: CodegenContext): TsProperty;
 
-export { type CodegenContext, type RpcGenerator, type TsProperty, type TypescriptGeneratorOptions, createTypescriptClient, defineRpcGenerator, getJsDocComment, getRpcKey, getTsTypeName, httpRpcFromDefinition, tsRpcFromDefinition, tsTypeFromSchema, typescriptClientGenerator, validVarName, wsRpcFromDefinition };
+export { createTypescriptClient, defineRpcGenerator, getJsDocComment, getRpcKey, getTsTypeName, httpRpcFromDefinition, tsRpcFromDefinition, tsTypeFromSchema, typescriptClientGenerator, validVarName, wsRpcFromDefinition };
+export type { CodegenContext, RpcGenerator, TsProperty, TypescriptGeneratorOptions };

package/dist/index.d.ts

@@ -32,24 +32,50 @@ interface CodegenContext {
         sse: boolean;
         ws: boolean;
     };
-    rpcGenerators: Record<string, RpcGenerator>;
+    rpcGenerators: Partial<Record<string, RpcGenerator>>;
 }
 declare function getJsDocComment(metadata: Schema['metadata']): string;
 declare function validVarName(name: string): string;
 declare function getTsTypeName(schema: Schema, context: CodegenContext): string;
 
 interface TypescriptGeneratorOptions {
-    clientName: string;
+    /**
+     * Defaults to 'Client'
+     */
+    clientName?: string;
     outputFile: string;
+    /**
+     * Add a prefix to the generated types
+     */
     typePrefix?: string;
+    /**
+     * Set the root service of the generated client
+     *
+     * __Example:__
+     *
+     * Given the following procedures:
+     * - users.getUser
+     * - users.updateUser
+     * - posts.getPost
+     * - posts.updatePosts
+     *
+     * Setting the rootService to `posts` means the generated client will only have the following procedures:
+     * - getPost
+     * - updatePosts
+     */
+    rootService?: string;
+    /**
+     * Options for how to format the outputted typescript code
+     */
     prettierOptions?: Omit<prettier.Config, 'parser'>;
     /**
      * Override the default functions used for creating procedures
      */
-    rpcGenerators?: Record<RpcDefinition['transport'], RpcGenerator>;
+    rpcGenerators?: Partial<Record<RpcDefinition['transport'], RpcGenerator>>;
 }
 declare const typescriptClientGenerator: _arrirpc_codegen_utils.GeneratorPlugin<TypescriptGeneratorOptions>;
 declare function createTypescriptClient(def: AppDefinition, options: TypescriptGeneratorOptions): Promise<string>;
 declare function tsTypeFromSchema(schema: Schema, context: CodegenContext): TsProperty;
 
-export { type CodegenContext, type RpcGenerator, type TsProperty, type TypescriptGeneratorOptions, createTypescriptClient, defineRpcGenerator, getJsDocComment, getRpcKey, getTsTypeName, httpRpcFromDefinition, tsRpcFromDefinition, tsTypeFromSchema, typescriptClientGenerator, validVarName, wsRpcFromDefinition };
+export { createTypescriptClient, defineRpcGenerator, getJsDocComment, getRpcKey, getTsTypeName, httpRpcFromDefinition, tsRpcFromDefinition, tsTypeFromSchema, typescriptClientGenerator, validVarName, wsRpcFromDefinition };
+export type { CodegenContext, RpcGenerator, TsProperty, TypescriptGeneratorOptions };

package/dist/index.mjs

@@ -1103,7 +1103,7 @@ const typescriptClientGenerator = defineGeneratorPlugin(
 async function createTypescriptClient(def, options) {
   const types = [];
   const context = {
-    clientName: options.clientName,
+    clientName: options.clientName ?? "Client",
     typePrefix: options.typePrefix ?? "",
     generatedTypes: [],
     instancePath: "",
@@ -1115,7 +1115,10 @@ async function createTypescriptClient(def, options) {
     },
     rpcGenerators: options.rpcGenerators ?? {}
   };
-  const serviceDefinitions = unflattenProcedures(def.procedures);
+  const serviceDefinitions = unflattenProcedures(
+    def.procedures,
+    options.rootService
+  );
   const mainService = tsServiceFromDefinition(serviceDefinitions, context);
   for (const key of Object.keys(def.definitions)) {
     const typeDef = def.definitions[key];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arrirpc/codegen-ts",
-  "version": "0.76.3",
+  "version": "0.77.0",
   "type": "module",
   "license": "MIT",
   "author": {
@@ -22,7 +22,7 @@
     "dist"
   ],
   "dependencies": {
-    "prettier": "^3.5.1",
-    "@arrirpc/codegen-utils": "0.76.3"
+    "prettier": "^3.5.3",
+    "@arrirpc/codegen-utils": "0.77.0"
   }
 }