@proteinjs/service 1.1.1 → 1.2.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [1.2.0](https://github.com/proteinjs/service/compare/@proteinjs/service@1.1.1...@proteinjs/service@1.2.0) (2025-02-06)
+
+
+### Bug Fixes
+
+* fix typing for the debounce config ([62bb2d6](https://github.com/proteinjs/service/commit/62bb2d646e2c71f2bf5300364cd92bbd95911f21))
+
+
+### Features
+
+* method specific debouncers. allows one service to use multiple debouncers for each method in the service. ([00fa7b2](https://github.com/proteinjs/service/commit/00fa7b23c4960ad9a006d4791e9f5a12f9ab6c89))
+
+
+
+
+
 ## [1.1.1](https://github.com/proteinjs/service/compare/@proteinjs/service@1.1.0...@proteinjs/service@1.1.1) (2024-09-10)
 
 

package/dist/src/Service.d.ts

@@ -10,6 +10,12 @@ type KeysWithoutService<T extends Service> = Diff<KeysWithoutIndexSignature<T>,
 type RetryConfig<T extends Service> = {
     [K in KeysWithoutService<T>]?: number;
 };
+interface DebounceConfig {
+    waitTime: number;
+}
+type MethodDebounceConfig<T extends Service> = {
+    [K in KeysWithoutService<T>]?: DebounceConfig;
+};
 export interface Service extends Loadable {
     serviceMetadata?: {
         auth?: {
@@ -36,9 +42,9 @@ export interface Service extends Loadable {
  * Create a factory that creates an instance of the Service. The Service instance is a
  * ServiceClient wrapped in the interface's api.
  * @param serviceInterfaceQualifiedName the package-qualified name of the service interface (ie. service-package-name/MyService)
- * @param debouncer optionally pass in an instance of debouncer if you want to limit service client calls
+ * @param debouncer pass in either a single debouncer instance or method-specific debounce configurations
  * @returns a function that creates a Service
  */
-export declare const serviceFactory: <T extends Service>(serviceInterfaceQualifiedName: string, debouncer?: Debouncer, retryConfig?: RetryConfig<T> | undefined) => () => T;
+export declare const serviceFactory: <T extends Service>(serviceInterfaceQualifiedName: string, debouncer?: Debouncer | MethodDebounceConfig<T> | undefined, retryConfig?: RetryConfig<T> | undefined) => () => T;
 export {};
 //# sourceMappingURL=Service.d.ts.map

package/dist/src/Service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Service.d.ts","sourceRoot":"","sources":["../../src/Service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAC1E,OAAO,EAAE,QAAQ,EAAoB,MAAM,uBAAuB,CAAC;AAEnE,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,KAAK,WAAW,CAAC,CAAC,IAAI;KACnB,CAAC,IAAI,MAAM,CAAC,IAAI,MAAM,SAAS,CAAC,GAAG,KAAK,GAAG,MAAM,SAAS,CAAC,GAAG,KAAK,GAAG,MAAM,SAAS,CAAC,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAC3G,CAAC;AACF,KAAK,yBAAyB,CAAC,CAAC,IAAI,MAAM,WAAW,CAAC,CAAC,CAAC,CAAC;AAGzD,KAAK,IAAI,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;AAG1C,KAAK,kBAAkB,CAAC,CAAC,SAAS,OAAO,IAAI,IAAI,CAAC,yBAAyB,CAAC,CAAC,CAAC,EAAE,yBAAyB,CAAC,OAAO,CAAC,CAAC,CAAC;AAEpH,KAAK,WAAW,CAAC,CAAC,SAAS,OAAO,IAAI;KACnC,CAAC,IAAI,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM;CACtC,CAAC;AAEF,MAAM,WAAW,OAAQ,SAAQ,QAAQ;IACvC,eAAe,CAAC,EAAE;QAChB,IAAI,CAAC,EAAE;YACL,2HAA2H;YAC3H,MAAM,CAAC,EAAE,OAAO,CAAC;YACjB,kIAAkI;YAClI,QAAQ,CAAC,EAAE,OAAO,CAAC;YACnB,8HAA8H;YAC9H,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;YACjB;;;;;eAKG;YACH,SAAS,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC;SAC1D,CAAC;QACF,uFAAuF;QACvF,UAAU,CAAC,EAAE,OAAO,CAAC;KACtB,CAAC;IACF,CAAC,IAAI,EAAE,MAAM,GAAG,oBAAoB,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;CACzD;AAED;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,qDACM,MAAM,cACzB,SAAS,sDAqBtB,CAAC"}
+{"version":3,"file":"Service.d.ts","sourceRoot":"","sources":["../../src/Service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAC1E,OAAO,EAAE,QAAQ,EAAoB,MAAM,uBAAuB,CAAC;AAEnE,OAAO,EAAE,SAAS,EAAgB,MAAM,iBAAiB,CAAC;AAE1D,KAAK,WAAW,CAAC,CAAC,IAAI;KACnB,CAAC,IAAI,MAAM,CAAC,IAAI,MAAM,SAAS,CAAC,GAAG,KAAK,GAAG,MAAM,SAAS,CAAC,GAAG,KAAK,GAAG,MAAM,SAAS,CAAC,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAC3G,CAAC;AACF,KAAK,yBAAyB,CAAC,CAAC,IAAI,MAAM,WAAW,CAAC,CAAC,CAAC,CAAC;AAGzD,KAAK,IAAI,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;AAG1C,KAAK,kBAAkB,CAAC,CAAC,SAAS,OAAO,IAAI,IAAI,CAAC,yBAAyB,CAAC,CAAC,CAAC,EAAE,yBAAyB,CAAC,OAAO,CAAC,CAAC,CAAC;AAEpH,KAAK,WAAW,CAAC,CAAC,SAAS,OAAO,IAAI;KACnC,CAAC,IAAI,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM;CACtC,CAAC;AAEF,UAAU,cAAc;IACtB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,KAAK,oBAAoB,CAAC,CAAC,SAAS,OAAO,IAAI;KAC5C,CAAC,IAAI,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,cAAc;CAC9C,CAAC;AAEF,MAAM,WAAW,OAAQ,SAAQ,QAAQ;IACvC,eAAe,CAAC,EAAE;QAChB,IAAI,CAAC,EAAE;YACL,2HAA2H;YAC3H,MAAM,CAAC,EAAE,OAAO,CAAC;YACjB,kIAAkI;YAClI,QAAQ,CAAC,EAAE,OAAO,CAAC;YACnB,8HAA8H;YAC9H,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;YACjB;;;;;eAKG;YACH,SAAS,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC;SAC1D,CAAC;QACF,uFAAuF;QACvF,UAAU,CAAC,EAAE,OAAO,CAAC;KACtB,CAAC;IACF,CAAC,IAAI,EAAE,MAAM,GAAG,oBAAoB,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;CACzD;AAaD;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,qDACM,MAAM,mHAkCtC,CAAC"}

package/dist/src/Service.js

@@ -3,11 +3,22 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.serviceFactory = void 0;
 var reflection_1 = require("@proteinjs/reflection");
 var ServiceClient_1 = require("./ServiceClient");
+var util_1 = require("@proteinjs/util");
+var debouncerMap = {};
+/** Retrieve an existing debouncer from the map or make a new one.
+ * This allows the debouncer instance per method to remain the same across multiple service calls.
+ */
+function getOrCreateDebouncer(methodName, waitTime) {
+    if (!debouncerMap[methodName]) {
+        debouncerMap[methodName] = new util_1.Debouncer(waitTime);
+    }
+    return debouncerMap[methodName];
+}
 /**
  * Create a factory that creates an instance of the Service. The Service instance is a
  * ServiceClient wrapped in the interface's api.
  * @param serviceInterfaceQualifiedName the package-qualified name of the service interface (ie. service-package-name/MyService)
- * @param debouncer optionally pass in an instance of debouncer if you want to limit service client calls
+ * @param debouncer pass in either a single debouncer instance or method-specific debounce configurations
  * @returns a function that creates a Service
  */
 var serviceFactory = function (serviceInterfaceQualifiedName, debouncer, retryConfig) {
@@ -17,13 +28,25 @@ var serviceFactory = function (serviceInterfaceQualifiedName, debouncer, retryCo
         for (var _i = 0, _a = serviceInterface.methods; _i < _a.length; _i++) {
             var method = _a[_i];
             var servicePath = "/service/".concat(serviceInterface.qualifiedName, "/").concat(method.name);
+            var methodName = method.name;
             var retryCount = 0;
-            if (retryConfig && method.name in retryConfig) {
-                var methodName = method.name;
+            if (retryConfig && methodName in retryConfig) {
                 retryCount = retryConfig[methodName];
             }
-            var serviceClient = new ServiceClient_1.ServiceClient(servicePath, method, debouncer, retryCount);
-            service[method.name] = serviceClient.send.bind(serviceClient);
+            var methodDebouncer = void 0;
+            if (debouncer) {
+                if ((0, util_1.isInstanceOf)(debouncer, util_1.Debouncer)) {
+                    methodDebouncer = debouncer;
+                }
+                else if (methodName in debouncer) {
+                    var methodConfig = debouncer[methodName];
+                    if (methodConfig) {
+                        methodDebouncer = getOrCreateDebouncer(methodName, methodConfig.waitTime);
+                    }
+                }
+            }
+            var serviceClient = new ServiceClient_1.ServiceClient(servicePath, method, methodDebouncer, retryCount);
+            service[methodName] = serviceClient.send.bind(serviceClient);
         }
         return service;
     };

package/dist/src/Service.js.map

@@ -1 +1 @@
-{"version":3,"file":"Service.js","sourceRoot":"","sources":["../../src/Service.ts"],"names":[],"mappings":";;;AACA,oDAAmE;AACnE,iDAAgD;AAyChD;;;;;;GAMG;AACI,IAAM,cAAc,GAAG,UAC5B,6BAAqC,EACrC,SAAqB,EACrB,WAA4B;IAE5B,OAAO;QACL,IAAM,OAAO,GAAQ,EAAE,CAAC;QACxB,IAAM,gBAAgB,GAAG,6BAAgB,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,6BAA6B,CAAC,CAAC;QACzF,KAAqB,UAAwB,EAAxB,KAAA,gBAAgB,CAAC,OAAO,EAAxB,cAAwB,EAAxB,IAAwB,EAAE;YAA1C,IAAM,MAAM,SAAA;YACf,IAAM,WAAW,GAAG,mBAAY,gBAAgB,CAAC,aAAa,cAAI,MAAM,CAAC,IAAI,CAAE,CAAC;YAEhF,IAAI,UAAU,GAAG,CAAC,CAAC;YACnB,IAAI,WAAW,IAAI,MAAM,CAAC,IAAI,IAAI,WAAW,EAAE;gBAC7C,IAAM,UAAU,GAAG,MAAM,CAAC,IAA6B,CAAC;gBACxD,UAAU,GAAG,WAAW,CAAC,UAAU,CAAE,CAAC;aACvC;YAED,IAAM,aAAa,GAAG,IAAI,6BAAa,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;YACpF,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;SAC/D;QAED,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC;AACJ,CAAC,CAAC;AAvBW,QAAA,cAAc,kBAuBzB"}
+{"version":3,"file":"Service.js","sourceRoot":"","sources":["../../src/Service.ts"],"names":[],"mappings":";;;AACA,oDAAmE;AACnE,iDAAgD;AAChD,wCAA0D;AAgD1D,IAAM,YAAY,GAAiC,EAAE,CAAC;AACtD;;GAEG;AACH,SAAS,oBAAoB,CAAC,UAAkB,EAAE,QAAgB;IAChE,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE;QAC7B,YAAY,CAAC,UAAU,CAAC,GAAG,IAAI,gBAAS,CAAC,QAAQ,CAAC,CAAC;KACpD;IACD,OAAO,YAAY,CAAC,UAAU,CAAC,CAAC;AAClC,CAAC;AAED;;;;;;GAMG;AACI,IAAM,cAAc,GAAG,UAC5B,6BAAqC,EACrC,SAA+C,EAC/C,WAA4B;IAE5B,OAAO;QACL,IAAM,OAAO,GAAQ,EAAE,CAAC;QACxB,IAAM,gBAAgB,GAAG,6BAAgB,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,6BAA6B,CAAC,CAAC;QACzF,KAAqB,UAAwB,EAAxB,KAAA,gBAAgB,CAAC,OAAO,EAAxB,cAAwB,EAAxB,IAAwB,EAAE;YAA1C,IAAM,MAAM,SAAA;YACf,IAAM,WAAW,GAAG,mBAAY,gBAAgB,CAAC,aAAa,cAAI,MAAM,CAAC,IAAI,CAAE,CAAC;YAChF,IAAM,UAAU,GAAG,MAAM,CAAC,IAA6B,CAAC;YAExD,IAAI,UAAU,GAAG,CAAC,CAAC;YACnB,IAAI,WAAW,IAAI,UAAU,IAAI,WAAW,EAAE;gBAC5C,UAAU,GAAG,WAAW,CAAC,UAAU,CAAE,CAAC;aACvC;YAED,IAAI,eAAe,SAAuB,CAAC;YAC3C,IAAI,SAAS,EAAE;gBACb,IAAI,IAAA,mBAAY,EAAC,SAAS,EAAE,gBAAS,CAAC,EAAE;oBACtC,eAAe,GAAG,SAAsB,CAAC;iBAC1C;qBAAM,IAAI,UAAU,IAAI,SAAS,EAAE;oBAClC,IAAM,YAAY,GAAI,SAAqC,CAAC,UAAU,CAAC,CAAC;oBACxE,IAAI,YAAY,EAAE;wBAChB,eAAe,GAAG,oBAAoB,CAAC,UAAoB,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAC;qBACrF;iBACF;aACF;YAED,IAAM,aAAa,GAAG,IAAI,6BAAa,CAAC,WAAW,EAAE,MAAM,EAAE,eAAe,EAAE,UAAU,CAAC,CAAC;YAC1F,OAAO,CAAC,UAAU,CAAC,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;SAC9D;QAED,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC;AACJ,CAAC,CAAC;AAnCW,QAAA,cAAc,kBAmCzB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@proteinjs/service",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "Service api",
   "publishConfig": {
     "access": "public"
@@ -43,5 +43,5 @@
   },
   "main": "./dist/generated/index.js",
   "types": "./dist/generated/index.d.ts",
-  "gitHead": "9e03cddf33d8d7d2becba67275e19adb67adaaf4"
+  "gitHead": "3de027b69d80594ca40d10c2069b6ec1ef119f89"
 }

package/src/Service.ts

@@ -1,7 +1,7 @@
 import { SerializableFunction, NotFunction } from '@proteinjs/serializer';
 import { Loadable, SourceRepository } from '@proteinjs/reflection';
 import { ServiceClient } from './ServiceClient';
-import { Debouncer } from '@proteinjs/util';
+import { Debouncer, isInstanceOf } from '@proteinjs/util';
 
 type RemoveIndex<T> = {
   [K in keyof T as string extends K ? never : number extends K ? never : symbol extends K ? never : K]: T[K];
@@ -18,6 +18,14 @@ type RetryConfig<T extends Service> = {
   [K in KeysWithoutService<T>]?: number;
 };
 
+interface DebounceConfig {
+  waitTime: number;
+}
+
+type MethodDebounceConfig<T extends Service> = {
+  [K in KeysWithoutService<T>]?: DebounceConfig;
+};
+
 export interface Service extends Loadable {
   serviceMetadata?: {
     auth?: {
@@ -41,16 +49,27 @@ export interface Service extends Loadable {
   [prop: string]: SerializableFunction | NotFunction<any>;
 }
 
+const debouncerMap: { [key: string]: Debouncer } = {};
+/** Retrieve an existing debouncer from the map or make a new one.
+ * This allows the debouncer instance per method to remain the same across multiple service calls.
+ */
+function getOrCreateDebouncer(methodName: string, waitTime: number): Debouncer {
+  if (!debouncerMap[methodName]) {
+    debouncerMap[methodName] = new Debouncer(waitTime);
+  }
+  return debouncerMap[methodName];
+}
+
 /**
  * Create a factory that creates an instance of the Service. The Service instance is a
  * ServiceClient wrapped in the interface's api.
  * @param serviceInterfaceQualifiedName the package-qualified name of the service interface (ie. service-package-name/MyService)
- * @param debouncer optionally pass in an instance of debouncer if you want to limit service client calls
+ * @param debouncer pass in either a single debouncer instance or method-specific debounce configurations
  * @returns a function that creates a Service
  */
 export const serviceFactory = <T extends Service>(
   serviceInterfaceQualifiedName: string,
-  debouncer?: Debouncer,
+  debouncer?: MethodDebounceConfig<T> | Debouncer,
   retryConfig?: RetryConfig<T>
 ): (() => T) => {
   return () => {
@@ -58,15 +77,27 @@ export const serviceFactory = <T extends Service>(
     const serviceInterface = SourceRepository.get().interface(serviceInterfaceQualifiedName);
     for (const method of serviceInterface.methods) {
       const servicePath = `/service/${serviceInterface.qualifiedName}/${method.name}`;
+      const methodName = method.name as KeysWithoutService<T>;
 
       let retryCount = 0;
-      if (retryConfig && method.name in retryConfig) {
-        const methodName = method.name as KeysWithoutService<T>;
+      if (retryConfig && methodName in retryConfig) {
         retryCount = retryConfig[methodName]!;
       }
 
-      const serviceClient = new ServiceClient(servicePath, method, debouncer, retryCount);
-      service[method.name] = serviceClient.send.bind(serviceClient);
+      let methodDebouncer: Debouncer | undefined;
+      if (debouncer) {
+        if (isInstanceOf(debouncer, Debouncer)) {
+          methodDebouncer = debouncer as Debouncer;
+        } else if (methodName in debouncer) {
+          const methodConfig = (debouncer as MethodDebounceConfig<T>)[methodName];
+          if (methodConfig) {
+            methodDebouncer = getOrCreateDebouncer(methodName as string, methodConfig.waitTime);
+          }
+        }
+      }
+
+      const serviceClient = new ServiceClient(servicePath, method, methodDebouncer, retryCount);
+      service[methodName] = serviceClient.send.bind(serviceClient);
     }
 
     return service;