@arrirpc/codegen-ts 0.77.1 → 0.78.0

package/README.md

@@ -50,19 +50,35 @@ pnpm i --save @arrirpc/client
 import { MyClient } from './myClient.g';
 
 const client = new MyClient({
+    // only required field
     baseUrl: 'https://example.com',
+
+    // everything below is optional
     headers: () => {
         return {
             Authorization: '<some-token>',
         };
     },
-    // optional
-    onError: (err) => {
-        // do something
+    onError: (err) => {},
+    options: {
+        retry: 4,
+        retryDelay: 200,
+        retryStatusCodes: [400, 403, 500, 501],
+        onRequest: (ctx) => {},
+        onRequestError: (ctx) => {},
+        onResponse: (ctx) => {},
+        onResponseError: (ctx) => {},
+        signal: undefined, // abortcontroller signal
+        timeout: 200,
     },
 });
 
-await client.myProcedure();
+await client.myProcedure({ foo: 'foo' });
+
+// individual procedures can also override the global request options
+await client.myProcedure({ foo: 'foo' }, { timeout: 400 });
+// be aware that these options are not merged with the global request options so you will have to
+// re-specify every hook if you only want to change one thing
 ```
 
 The root client will be a class containing all of the services and procedures in a single class. If you only need a particular service. You can also import just that service.

package/dist/index.cjs

@@ -944,7 +944,7 @@ function httpRpcFromDefinition(def, context) {
   return `${getJsDocComment({
     description: def.description,
     isDeprecated: def.isDeprecated
-  })}    async ${key}(${params ? `params: ${params}` : ""}): Promise<${response ?? "undefined"}> {
+  })}    async ${key}(${params ? `params: ${params}, ` : ""}options?: ArriRequestOptions): Promise<${response ?? "undefined"}> {
         return arriRequest<${response ?? "undefined"}, ${params ?? "undefined"}>({
             url: \`\${this._baseUrl}${def.path}\`,
             method: "${def.method.toLowerCase()}",
@@ -956,6 +956,7 @@ function httpRpcFromDefinition(def, context) {
             responseFromString: ${response ? `$$${response}.fromJsonString` : "() => {}"},
             serializer: ${params ? `$$${params}.${serializerMethod}` : "() => {}"},
             clientVersion: "${context.versionNumber}",
+            options: options ?? this._options,
         });
     }`;
 }
@@ -1048,23 +1049,26 @@ function tsServiceFromDefinition(def, context) {
     private readonly _baseUrl: string;
     private readonly _fetch?: $Fetch;
     private readonly _headers: HeaderMap | (() => HeaderMap | Promise<HeaderMap>);
-    private readonly _onError?: (err: unknown) => void; 
+    private readonly _onError?: (err: unknown) => void;
+    private readonly _options?: ArriRequestOptions;
 ${subServices.map((service) => `    ${service.key}: ${service.name};`).join("\n")}
     constructor(
-        options: {
+        config: {
             baseUrl?: string;
             fetch?: Fetch;
             headers?: HeaderMap | (() => HeaderMap | Promise<HeaderMap>);
             onError?: (err: unknown) => void;
+            options?: ArriRequestOptions;
         } = {},
     ) {
-        this._baseUrl = options.baseUrl ?? "";
-        if (options.fetch) {
-            this._fetch = createFetch({ fetch: options.fetch });
+        this._baseUrl = config.baseUrl ?? "";
+        if (config.fetch) {
+            this._fetch = createFetch({ fetch: config.fetch });
         }
-        this._headers = options.headers ?? {};
-        this._onError = options.onError;
-${subServices.map((service) => `        this.${service.key} = new ${service.name}(options);`).join("\n")}
+        this._headers = config.headers ?? {};
+        this._onError = config.onError;
+        this._options = config.options;
+${subServices.map((service) => `        this.${service.key} = new ${service.name}(config);`).join("\n")}
     }
 ${rpcParts.map((rpc) => `    ${rpc}`).join("\n")}
 }
@@ -1153,6 +1157,7 @@ async function createTypescriptClient(def, options) {
 import {
     ArriEnumValidator,
     ArriModelValidator,
+    type ArriRequestOptions,
     arriRequest,
     ${context.usedFeatures.sse ? "arriSseRequest," : ""}
     ${context.usedFeatures.ws ? "arriWsRequest," : ""}

package/dist/index.mjs

@@ -938,7 +938,7 @@ function httpRpcFromDefinition(def, context) {
   return `${getJsDocComment({
     description: def.description,
     isDeprecated: def.isDeprecated
-  })}    async ${key}(${params ? `params: ${params}` : ""}): Promise<${response ?? "undefined"}> {
+  })}    async ${key}(${params ? `params: ${params}, ` : ""}options?: ArriRequestOptions): Promise<${response ?? "undefined"}> {
         return arriRequest<${response ?? "undefined"}, ${params ?? "undefined"}>({
             url: \`\${this._baseUrl}${def.path}\`,
             method: "${def.method.toLowerCase()}",
@@ -950,6 +950,7 @@ function httpRpcFromDefinition(def, context) {
             responseFromString: ${response ? `$$${response}.fromJsonString` : "() => {}"},
             serializer: ${params ? `$$${params}.${serializerMethod}` : "() => {}"},
             clientVersion: "${context.versionNumber}",
+            options: options ?? this._options,
         });
     }`;
 }
@@ -1042,23 +1043,26 @@ function tsServiceFromDefinition(def, context) {
     private readonly _baseUrl: string;
     private readonly _fetch?: $Fetch;
     private readonly _headers: HeaderMap | (() => HeaderMap | Promise<HeaderMap>);
-    private readonly _onError?: (err: unknown) => void; 
+    private readonly _onError?: (err: unknown) => void;
+    private readonly _options?: ArriRequestOptions;
 ${subServices.map((service) => `    ${service.key}: ${service.name};`).join("\n")}
     constructor(
-        options: {
+        config: {
             baseUrl?: string;
             fetch?: Fetch;
             headers?: HeaderMap | (() => HeaderMap | Promise<HeaderMap>);
             onError?: (err: unknown) => void;
+            options?: ArriRequestOptions;
         } = {},
     ) {
-        this._baseUrl = options.baseUrl ?? "";
-        if (options.fetch) {
-            this._fetch = createFetch({ fetch: options.fetch });
+        this._baseUrl = config.baseUrl ?? "";
+        if (config.fetch) {
+            this._fetch = createFetch({ fetch: config.fetch });
         }
-        this._headers = options.headers ?? {};
-        this._onError = options.onError;
-${subServices.map((service) => `        this.${service.key} = new ${service.name}(options);`).join("\n")}
+        this._headers = config.headers ?? {};
+        this._onError = config.onError;
+        this._options = config.options;
+${subServices.map((service) => `        this.${service.key} = new ${service.name}(config);`).join("\n")}
     }
 ${rpcParts.map((rpc) => `    ${rpc}`).join("\n")}
 }
@@ -1147,6 +1151,7 @@ async function createTypescriptClient(def, options) {
 import {
     ArriEnumValidator,
     ArriModelValidator,
+    type ArriRequestOptions,
     arriRequest,
     ${context.usedFeatures.sse ? "arriSseRequest," : ""}
     ${context.usedFeatures.ws ? "arriWsRequest," : ""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arrirpc/codegen-ts",
-  "version": "0.77.1",
+  "version": "0.78.0",
   "type": "module",
   "license": "MIT",
   "author": {
@@ -23,6 +23,6 @@
   ],
   "dependencies": {
     "prettier": "^3.5.3",
-    "@arrirpc/codegen-utils": "0.77.1"
+    "@arrirpc/codegen-utils": "0.78.0"
   }
 }